{ "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/beta/common/wix-core-services-dev.d.ts", "content": "declare module \"wix-core-services-dev\" {\n interface LongMessage {\n int64Field?: string;\n uint64Field?: string;\n int64ValueField?: string | null;\n uint64ValueField?: string | null;\n sint64Field?: string;\n sfixed64Field?: string;\n fixed64Field?: string;\n durationField?: GoogleProtoDuration;\n _id?: string | null;\n }\n type GoogleProtoDuration = any;\n /**\n * echo given arg1 and arg2\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function longEcho(options?: LongEchoOptions): Promise;\n interface LongEchoOptions {\n int64Field?: string;\n uint64Field?: string;\n int64ValueField?: string | null;\n uint64ValueField?: string | null;\n sint64Field?: string;\n sfixed64Field?: string;\n fixed64Field?: string;\n durationField?: GoogleProtoDuration;\n _id?: string | null;\n }\n /**\n * echo given arg1 and arg2\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function publicLongEcho(options?: PublicLongEchoOptions): Promise;\n interface PublicLongEchoOptions {\n int64Field?: string;\n uint64Field?: string;\n int64ValueField?: string | null;\n uint64ValueField?: string | null;\n sint64Field?: string;\n sfixed64Field?: string;\n fixed64Field?: string;\n durationField?: GoogleProtoDuration;\n _id?: string | null;\n }\n \n type metroinspectorV1Long_universal_d_LongMessage = LongMessage;\n const metroinspectorV1Long_universal_d_longEcho: typeof longEcho;\n type metroinspectorV1Long_universal_d_LongEchoOptions = LongEchoOptions;\n const metroinspectorV1Long_universal_d_publicLongEcho: typeof publicLongEcho;\n type metroinspectorV1Long_universal_d_PublicLongEchoOptions = PublicLongEchoOptions;\n namespace metroinspectorV1Long_universal_d {\n export {\n metroinspectorV1Long_universal_d_LongMessage as LongMessage,\n metroinspectorV1Long_universal_d_longEcho as longEcho,\n metroinspectorV1Long_universal_d_LongEchoOptions as LongEchoOptions,\n metroinspectorV1Long_universal_d_publicLongEcho as publicLongEcho,\n metroinspectorV1Long_universal_d_PublicLongEchoOptions as PublicLongEchoOptions,\n };\n }\n \n export { metroinspectorV1Long_universal_d as echo };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-loyalty-backend.d.ts", "content": "declare module \"wix-loyalty-backend\" {\n const __debug$4: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 /** Information about the account totals. */\n points?: Points;\n /** Details of the account's latest transaction. */\n latestTransaction?: LatestTransaction;\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;\n /**\n * Date and time the account was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Account's last activity date and time.\n * @readonly\n */\n lastActivityDate?: Date;\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 tier?: Tier$1;\n }\n interface Points {\n /**\n * Current point balance.\n *\n * Equal to the sum of `earned` and `adjusted` points, minus `redeemed` points.\n */\n balance?: number;\n /** Total earned points. */\n earned?: number;\n /** Total adjusted points. */\n adjusted?: number;\n /** Total redeemed points. */\n redeemed?: number;\n }\n interface LatestTransaction {\n /** Transaction ID. */\n _id?: string;\n /** Amount of earned, adjusted, or redeemed points in the latest transaction. */\n amount?: number;\n /** Transaction type. */\n type?: TransactionType;\n /** Description of the latest transaction. */\n description?: string;\n /**\n * Date and time the transaction was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * __Deprecated.__ For `latestTransaction.rewardId`, use `latestTransaction.redeemInfo.rewardId` instead. This property\n * will be removed on September 30, 2022.\n * @readonly\n */\n rewardId?: string | null;\n /**\n * ID of the app that initiated the transaction.\n *\n * Only present if `type` is `EARN` or `ADJUST`. The `appId` can be set to any string when points are manually earned or adjusted. When points are earned or adjusted in an automatic event, the `appId` is from that automation's `sourceAppId`.\n * @readonly\n */\n appId?: string | null;\n /**\n * Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request.\n *\n * Only present if points were added manually using the [`earnPoints()`](/wix-loyalty-backend/account/earnpoints) function.\n * @readonly\n */\n idempotencyKey?: string | null;\n /**\n * Additional information for redeemed points.\n *\n * Only present if `type` is `REDEEM`.\n * @readonly\n */\n redeemInfo?: RedeemInfo;\n }\n enum TransactionType {\n UNKNOWN = \"UNKNOWN\",\n EARN = \"EARN\",\n REDEEM = \"REDEEM\",\n ADJUST = \"ADJUST\",\n GIVE = \"GIVE\"\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;\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;\n }\n interface Tier$1 {\n /**\n * If None, Account belongs to base Tier\n * @readonly\n */\n _id?: string | null;\n /**\n * Date when the last time Tier was recalculated\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Next recalculation date, used for periodic recalculation\n * @internal\n * @readonly\n */\n recalculationDate?: Date;\n /** Points for Tier period (eg. Rolling period for x months). This is equal to the sum of earned and adjusted points for the last x months. */\n points?: number;\n }\n interface RewardAvailabilitiesChanged {\n changeReason?: RewardAvailabilityChangeReason;\n /**\n * Loyalty Account ID -> Reward Available map\n * @readonly\n */\n accountAvailabilities?: Record;\n }\n enum RewardAvailabilityChangeReason {\n UNDEFINED = \"UNDEFINED\",\n REWARD_UPDATED = \"REWARD_UPDATED\",\n BALANCE_UPDATED = \"BALANCE_UPDATED\",\n TIERS_RECALCULATED = \"TIERS_RECALCULATED\"\n }\n interface RewardAvailabilityUpdated {\n rewardAvailable?: boolean;\n updateTrigger?: UpdateTrigger;\n }\n enum UpdateTrigger {\n UNDEFINED = \"UNDEFINED\",\n REWARD_UPDATED = \"REWARD_UPDATED\",\n BALANCE_UPDATED = \"BALANCE_UPDATED\",\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 {\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: `9,999,999`\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 `sourceUniqueId`.\n */\n appId: string;\n /** Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request. */\n idempotencyKey: string;\n }\n interface EarnPointsResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n }\n interface PointsUpdated {\n /** Updated account. */\n account?: LoyaltyAccount;\n }\n interface AdjustPointsRequest extends AdjustPointsRequestTypeOneOf {\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 * 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: `999,999,999`\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: `-9,999,999`\n *\n * Max: `9,999,999`\n */\n amount?: number;\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: `999,999,999`\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: `-9,999,999`\n *\n * Max: `9,999,999`\n */\n amount?: number;\n }\n interface AdjustPointsResponse {\n /** Adjusted loyalty account. */\n account?: LoyaltyAccount;\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 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 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 /**\n * Tier total for the entire program\n * @internal\n */\n tierTotals?: TierTotal[];\n }\n interface TierTotal {\n /**\n * If None, Account belongs to base Tier\n * @readonly\n */\n _id?: string | null;\n /** Total number of loyalty accounts, that belongs to particular Tier */\n numberOfAccounts?: number;\n }\n interface GetCurrentMemberAccountRequest {\n }\n interface GetCurrentMemberAccountResponse {\n /** Loyalty account. */\n account?: LoyaltyAccount;\n }\n interface GetAccountBySecondaryIdRequest extends GetAccountBySecondaryIdRequestIdOneOf {\n /** Account owner's contact ID. See the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) to learn more. */\n contactId?: string;\n /** Account owner's member ID. See the [Members API](https://dev.wix.com/api/rest/members/members/member-object) to learn more. */\n memberId?: string;\n }\n /** @oneof */\n interface GetAccountBySecondaryIdRequestIdOneOf {\n /**\n * Account owner's contact ID or special \"me\" identifier to get current identity's data.\n * See the Contacts API to [learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).\n */\n contactId?: string;\n /**\n * Account owner's member ID or special \"me\" identifier to get current identity's data.\n * See the Members API to [learn more about a site's members](https://dev.wix.com/api/rest/members/members/member-object).\n */\n memberId?: string;\n }\n interface GetAccountBySecondaryIdResponse {\n /** Retrieved loyalty account. */\n account?: LoyaltyAccount;\n }\n interface ListAccountsRequest {\n /** List of contact IDs. See the Contacts API to [learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object). */\n contactIds?: string[];\n cursorPaging?: CursorPaging$2;\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 ListAccountsResponse {\n /** Retrieved loyalty accounts. */\n accounts?: LoyaltyAccount[];\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 * 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 * @internal\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 /** Retrieves a transaction. */\n interface GetTransactionRequest {\n /** Transaction ID. */\n _id: string | null;\n }\n interface GetTransactionResponse {\n /** Retrieved transaction. */\n transaction?: Transaction;\n }\n /** Loyalty transaction. */\n interface Transaction {\n /**\n * Transaction ID.\n * @readonly\n */\n _id?: string;\n /**\n * Loyalty account ID.\n * @readonly\n */\n accountId?: string;\n /**\n * Account owner's contact ID. See the Contacts API to [learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).\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 /** Points earned, adjusted, or redeemed in the latest transaction. */\n amount?: number;\n type?: TransactionType;\n /** Transaction description. Only present for automated transactions of `type` `EARN` or `REDEEM`, when set by the site owner in the Business Manager. */\n description?: string;\n /**\n * Date and time of the transaction.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * __Deprecated.__ For `transaction.rewardId`, use `transaction.redeemInfo.rewardId` instead. This property\n * will be removed on June 30, 2022.\n * @readonly\n */\n rewardId?: string | null;\n /**\n * ID of the app that initiated the transaction.\n *\n * Only present if `type` is `EARN` or `ADJUST`.\n *\n * If points were earned or adjusted manually, then the `appId` is the Loyalty app's\n * `wixAppId` of `553c79f3-5625-4f38-b14b-ef7c0d1e87df`. If points were earned or adjusted in an automatic event,\n * then the `appId` is from that automation's `sourceUniqueId`.\n * @readonly\n */\n appId?: string | null;\n /**\n * Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request.\n *\n * Only present if points were added manually using the [`earnPoints()`](/wix-loyalty-backend/account/earnpoints) function.\n * @readonly\n */\n idempotencyKey?: string | null;\n /**\n * Additional redeem information. Only present if `type` is `REDEEM`.\n * @readonly\n */\n redeemInfo?: RedeemInfo;\n }\n interface ListTransactionsRequest {\n /** Loyalty account ID. */\n accountId: string | null;\n /** Pagination options, such as how many results are listed at a time. */\n cursorPaging?: CursorPaging$2;\n }\n interface ListTransactionsResponse {\n /** Retrieved transactions. */\n transactions?: Transaction[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2$2;\n }\n interface DomainEvent$2 extends DomainEventBodyOneOf$2 {\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent$2;\n }\n /** @oneof */\n interface DomainEventBodyOneOf$2 {\n createdEvent?: EntityCreatedEvent$2;\n updatedEvent?: EntityUpdatedEvent$2;\n deletedEvent?: EntityDeletedEvent$2;\n actionEvent?: ActionEvent$2;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent$2;\n }\n interface EntityCreatedEvent$2 {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent$2 {\n currentEntityAsJson?: string;\n }\n interface Empty$3 {\n }\n interface AccountsMerged {\n /**\n * Source accounts.\n * @readonly\n */\n sourceAccounts?: LoyaltyAccount[];\n /**\n * Merged account.\n * @readonly\n */\n updatedAccount?: LoyaltyAccount;\n }\n interface TiersRollingUpdate$1 {\n }\n interface TiersProgramSettingsChanged$1 {\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 status?: Status$2;\n revision?: string | null;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n /** Used to represent base tier */\n baseTierDefinition?: TierDefinition$1;\n /** More periods will be supported in future */\n rollingWindow?: RollingWindow$1;\n }\n /** @oneof */\n interface TiersProgramSettingsPeriodOneOf$1 {\n /** More periods will be supported in future */\n rollingWindow?: RollingWindow$1;\n }\n enum Status$2 {\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 interface TierDefinition$1 {\n icon?: string;\n name?: string | null;\n description?: string | null;\n }\n interface RollingWindow$1 {\n durationInMonths?: number;\n }\n interface SubscriptionEvent extends SubscriptionEventEventOneOf {\n /** internal */\n eventId?: string | null;\n /** is this required in the api ?? or is it implicit */\n eventDate?: Date;\n /** subscription created */\n created?: SubscriptionCreated;\n /** subscription assigned to context */\n assigned?: SubscriptionAssigned;\n /** subscription cancelled */\n cancelled?: SubscriptionCancelled;\n /** subscription \"AUTON RENEW\" turned on */\n autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;\n /** subscription \"AUTON RENEW\" turned off */\n autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;\n /** subscription unassigned from context */\n unassigned?: SubscriptionUnassigned;\n /** subscription transferred between accounts */\n transferred?: SubscriptionTransferred;\n /** subscription renewed after recurring charge */\n recurringChargeSucceeded?: RecurringChargeSucceeded;\n /** subscription contract switched / upgraded */\n contractSwitched?: ContractSwitched;\n /** subscription is near renewal */\n nearEndOfPeriod?: SubscriptionNearEndOfPeriod;\n /** subscription has a pending change set */\n pendingChange?: SubscriptionPendingChange;\n }\n /** @oneof */\n interface SubscriptionEventEventOneOf {\n /** subscription created */\n created?: SubscriptionCreated;\n /** subscription assigned to context */\n assigned?: SubscriptionAssigned;\n /** subscription cancelled */\n cancelled?: SubscriptionCancelled;\n /** subscription \"AUTON RENEW\" turned on */\n autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;\n /** subscription \"AUTON RENEW\" turned off */\n autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;\n /** subscription unassigned from context */\n unassigned?: SubscriptionUnassigned;\n /** subscription transferred between accounts */\n transferred?: SubscriptionTransferred;\n /** subscription renewed after recurring charge */\n recurringChargeSucceeded?: RecurringChargeSucceeded;\n /** subscription contract switched / upgraded */\n contractSwitched?: ContractSwitched;\n /** subscription is near renewal */\n nearEndOfPeriod?: SubscriptionNearEndOfPeriod;\n /** subscription has a pending change set */\n pendingChange?: SubscriptionPendingChange;\n }\n /** Will be published when a new subscription is created */\n interface SubscriptionCreated {\n /** The subscription */\n subscription?: Subscription;\n /** Meta data about the subscription */\n metadata?: Record;\n }\n interface Subscription {\n /** subscription identity */\n _id?: string;\n /** always a Wix user */\n userId?: string;\n /** product ID from product catalog */\n productId?: string;\n /** date subscription was created */\n createdAt?: Date;\n /** date subscription was updated */\n updatedAt?: Date;\n /** id of the meta site that the subscription is assigned to, can be empty, meaning the subscription is either account level or is currently unassigned */\n metaSiteId?: string | null;\n /** reference to billing system entity */\n billingReference?: BillingReference;\n /** payment cycle */\n cycle?: Cycle;\n /** status */\n status?: SubscriptionStatus;\n /** date subscription was transferred between accounts */\n transferredAt?: Date;\n /** product type ID of the product */\n productTypeId?: string;\n /** version */\n version?: number;\n /** flag indicating whether the subscription is currently active or not */\n active?: boolean;\n /** date the original subscription was created in cases where the subscription has been transferred between accounts */\n originalCreationDate?: Date;\n /** custom metadata associated with the subscription */\n metadata?: Record;\n /** the country code to which the subscription was provisioned */\n countryCode?: string | null;\n }\n interface BillingReference {\n /** billing provider name */\n providerName?: ProviderName;\n /** current provider reference id */\n providerReferenceId?: string | null;\n /** used to support extend (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 }\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 /** Subscription will be renewed automatically at the end of the current payment cycle */\n AUTO_RENEW_ON = \"AUTO_RENEW_ON\",\n /** Subscription will not be renewed at the end of the current payment cycle */\n AUTO_RENEW_OFF = \"AUTO_RENEW_OFF\",\n /** Subscription will require user to manually renew */\n MANUAL_RECURRING = \"MANUAL_RECURRING\",\n /** Subscription has been cancelled */\n CANCELLED = \"CANCELLED\",\n /** Subscription has been transferred to a different account */\n TRANSFERRED = \"TRANSFERRED\"\n }\n /** Will be published when a subscription is assigned to a meta site */\n interface SubscriptionAssigned {\n /** The subscription */\n subscription?: Subscription;\n /** meta site identity that the subscription was previously assigned to */\n previousMetaSiteId?: string | null;\n }\n /** Will be published when a subscription is cancelled */\n interface SubscriptionCancelled {\n /** The subscription */\n subscription?: Subscription;\n /** Cancellation reason information */\n cancellationDetails?: CancellationDetails;\n /** indicates whether the subscription was cancelled immediately or at end of period */\n immediateCancel?: boolean;\n }\n interface CancellationDetails {\n /** cancellation reason code */\n cancellationCode?: number | null;\n /** cancellation reason description */\n cancellationReason?: string | null;\n /** the initiator of the cancellation */\n initiator?: Initiator;\n }\n enum Initiator {\n UNKNOWN = \"UNKNOWN\",\n /** cancellation was initiated by request from the user */\n USER_REQUESTED = \"USER_REQUESTED\",\n /** cancellation was initiated by the managing application */\n APP_MANAGED = \"APP_MANAGED\",\n /** cancellation was initiated passively for example payment failure or fraud */\n PASSIVE = \"PASSIVE\"\n }\n /** Will be published when a subscription \"AUTO RENEW\" is turned on\" */\n interface SubscriptionAutoRenewTurnedOn {\n /** The subscription */\n subscription?: Subscription;\n /** Initiator of request to turn AutoRenew On - Will be \"USER\" or the Application Id of the requesting Service */\n initiator?: string | null;\n }\n /** Will be published when a subscription \"AUTO RENEW\" is turned off\" */\n interface SubscriptionAutoRenewTurnedOff {\n /** The subscription */\n subscription?: Subscription;\n /** Cancellation reason information */\n cancellationDetails?: CancellationDetails;\n /** indicates whether the subscription will be cancelled immediately or not */\n immediateCancel?: boolean;\n }\n /** Will be published when a subscription is unassigned from a meta site */\n interface SubscriptionUnassigned {\n /** The subscription */\n subscription?: Subscription;\n /** meta site identity that the subscription was previously assigned to */\n previousMetaSiteId?: string;\n unassignReason?: UnassignReason;\n }\n enum UnassignReason {\n UNKNOWN = \"UNKNOWN\",\n /** initiated by the user */\n USER_REQUESTED = \"USER_REQUESTED\",\n /** Another subscription was assigned to the site this subscription was assigned to */\n REPLACED_BY_ANOTHER_SUBSCRIPTION = \"REPLACED_BY_ANOTHER_SUBSCRIPTION\"\n }\n /**\n * Will be published when a subscription is transferred between accounts\n * Holds the state of the same subscription before and after the transfer\n * subscription ID is the same in both states\n */\n interface SubscriptionTransferred {\n /** The subscription state before the transfer */\n originSubscription?: Subscription;\n /** The subscription state after the transfer */\n targetSubscription?: Subscription;\n }\n /** Will be published when a subscription is successfully renewed */\n interface RecurringChargeSucceeded {\n /** The subscription */\n subscription?: Subscription;\n }\n /** Will be published when a subscription is has changed, either upgrade or downgrade */\n interface ContractSwitched {\n /** The subscription */\n subscription?: Subscription;\n /** previous payment cycle */\n previousCycle?: Cycle;\n /** previous product ID from product catalog */\n previousProductId?: string;\n /** previous product type ID of the product */\n previousProductTypeId?: string;\n /** Type of contract switch */\n contractSwitchType?: ContractSwitchType;\n /**\n * meta site identity that the subscription was previously assigned to\n * in the case where a subscription is assigned to a different site during the contract switch\n */\n previousMetaSiteId?: string | null;\n /** Reason of contract switch */\n contractSwitchReason?: ContractSwitchReason;\n /** contains essential data for price increase case */\n productPriceIncreaseData?: ProductPriceIncreaseData;\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 /** Indicates external provider triggered flow, as described in ContractSwitchType */\n EXTERNAL_PROVIDER_TRIGGER = \"EXTERNAL_PROVIDER_TRIGGER\",\n /** indicates contract was switched due to price increase */\n PRICE_INCREASE = \"PRICE_INCREASE\"\n }\n interface ProductPriceIncreaseData {\n previousPrice?: string | null;\n }\n /** Will be published when a subscription is near to the end of period - the number days before renewal is defined in the Billing System */\n interface SubscriptionNearEndOfPeriod {\n /** The subscription */\n subscription?: Subscription;\n }\n /** Will be published when a subscription has a pending change */\n interface SubscriptionPendingChange {\n /** The subscription */\n subscription?: Subscription;\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. See [contacts](wix-crm-backend/contacts) to learn more about a site's contacts. The site must also have an active loyalty program before loyalty accounts can be created. See the [`activateLoyaltyProgram()`](wix-loyalty-backend/program/activateloyaltyprogram) function to activate a site's loyalty program.\n * @public\n * @documentationMaturity preview\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 */\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-backend/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 * @param accountId - Loyalty account ID.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @requiredField options.appId\n * @requiredField options.idempotencyKey\n */\n function earnPoints(accountId: string, options?: EarnPointsOptions): Promise;\n interface EarnPointsOptions {\n /**\n * Amount of points to earn. Must be a positive, whole number.\n *\n * Min: `1`\n *\n * Max: `9,999,999`\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 `sourceUniqueId`.\n */\n appId: string;\n /** Unique string identifier generated by the app. Wix uses this identifier to recognize subsequent retries of the same request. */\n idempotencyKey: string;\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 * @param accountId - Loyalty account ID.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @param options - Options to use when adjusting points.\n */\n function adjustPoints(accountId: string, options?: AdjustPointsOptions): Promise;\n interface AdjustPointsOptions {\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: `999,999,999`\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: `-9,999,999`\n *\n * Max: `9,999,999`\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 /**\n * Redeems points from a loyalty account, given the provided reward.\n * @param accountId - Loyalty account ID.\n * @param rewardId - Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details.\n * @documentationMaturity preview\n * @requiredField accountId\n * @requiredField rewardId\n */\n function redeemPoints(accountId: string, rewardId: string, options?: RedeemPointsOptions): Promise;\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 /**\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-backend/account/getaccountbysecondaryid) function.\n * @param _id - ID of the account to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function getAccount(_id: string): Promise;\n /** @documentationMaturity preview */\n function listUserAccounts(options?: ListUserAccountsOptions): Promise;\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 * @public\n * @documentationMaturity preview\n */\n function getProgramTotals(): Promise;\n /** @documentationMaturity preview */\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 a customer's contact ID or member ID. You can also get an account using the loyalty account ID with the [`getAccount()`](wix-loyalty-backend/account/getaccount) function.\n * @public\n * @documentationMaturity preview\n * @requiredField GetAccountBySecondaryIdRequest\n */\n function getAccountBySecondaryId(options?: GetAccountBySecondaryIdOptions): Promise;\n interface GetAccountBySecondaryIdOptions {\n /** Account owner's contact ID. See the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) to learn more. */\n contactId?: string;\n /** Account owner's member ID. See the [Members API](https://dev.wix.com/api/rest/members/members/member-object) to learn more. */\n memberId?: string;\n }\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 when the filtered accounts are retrieved.\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 * @public\n * @documentationMaturity preview\n */\n function listAccounts(options?: ListAccountsOptions): Promise;\n interface ListAccountsOptions {\n /** List of contact IDs. See the Contacts API to [learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object). */\n contactIds?: string[];\n cursorPaging?: CursorPaging$2;\n }\n /**\n * Retrieves a transaction using the transaction ID.\n *\n * The `getTransaction()` function returns a Promise that resolves to a loyalty transaction when the specified transaction is retrieved.\n *\n * A loyalty transaction includes any activity that changes a loyalty account point balance, such as adjusting, earning, or redeeming loyalty points. If you want to retrieve many, or all, of the transactions for a specific loyalty account, use the [`listTransactions()`](wix-loyalty-backend/account/listtransactions) function.\n * @param _id - Transaction ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function getTransaction(_id: string | null): Promise;\n /**\n * Retrieves a list of transactions for a specified loyalty account.\n *\n * The `listTransactions()` function returns a Promise that resolves to a list of loyalty transactions for the loyalty account specified by the account ID.\n *\n * Loyalty transactions include activities that change a loyalty account point balance, such as adjusting, earning, or redeeming loyalty points. If you want to get a specific transaction use that transaction's ID and the [`getTransaction()`](wix-loyalty-backend/account/gettransaction) function.\n * @param accountId - Loyalty account ID.\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n */\n function listTransactions(accountId: string | null, options?: ListTransactionsOptions): Promise;\n interface ListTransactionsOptions {\n /** Pagination options, such as how many results are listed at a time. */\n cursorPaging?: CursorPaging$2;\n }\n \n type loyaltyV1Account_universal_d_LoyaltyAccount = LoyaltyAccount;\n type loyaltyV1Account_universal_d_Points = Points;\n type loyaltyV1Account_universal_d_LatestTransaction = LatestTransaction;\n type loyaltyV1Account_universal_d_TransactionType = TransactionType;\n const loyaltyV1Account_universal_d_TransactionType: typeof TransactionType;\n type loyaltyV1Account_universal_d_RedeemInfo = RedeemInfo;\n type loyaltyV1Account_universal_d_RewardAvailabilitiesChanged = RewardAvailabilitiesChanged;\n type loyaltyV1Account_universal_d_RewardAvailabilityChangeReason = RewardAvailabilityChangeReason;\n const loyaltyV1Account_universal_d_RewardAvailabilityChangeReason: typeof RewardAvailabilityChangeReason;\n type loyaltyV1Account_universal_d_RewardAvailabilityUpdated = RewardAvailabilityUpdated;\n type loyaltyV1Account_universal_d_UpdateTrigger = UpdateTrigger;\n const loyaltyV1Account_universal_d_UpdateTrigger: typeof UpdateTrigger;\n type loyaltyV1Account_universal_d_CreateAccountRequest = CreateAccountRequest;\n type loyaltyV1Account_universal_d_CreateAccountResponse = CreateAccountResponse;\n type loyaltyV1Account_universal_d_EarnPointsRequest = EarnPointsRequest;\n type loyaltyV1Account_universal_d_EarnPointsResponse = EarnPointsResponse;\n type loyaltyV1Account_universal_d_PointsUpdated = PointsUpdated;\n type loyaltyV1Account_universal_d_AdjustPointsRequest = AdjustPointsRequest;\n type loyaltyV1Account_universal_d_AdjustPointsRequestTypeOneOf = AdjustPointsRequestTypeOneOf;\n type loyaltyV1Account_universal_d_AdjustPointsResponse = AdjustPointsResponse;\n type loyaltyV1Account_universal_d_RedeemPointsRequest = RedeemPointsRequest;\n type loyaltyV1Account_universal_d_RedeemPointsResponse = RedeemPointsResponse;\n type loyaltyV1Account_universal_d_GetAccountRequest = GetAccountRequest;\n type loyaltyV1Account_universal_d_GetAccountResponse = GetAccountResponse;\n type loyaltyV1Account_universal_d_ListUserAccountsRequest = ListUserAccountsRequest;\n type loyaltyV1Account_universal_d_ListUserAccountsResponse = ListUserAccountsResponse;\n type loyaltyV1Account_universal_d_LoyaltyAccountForMetaSite = LoyaltyAccountForMetaSite;\n type loyaltyV1Account_universal_d_GetProgramTotalsRequest = GetProgramTotalsRequest;\n type loyaltyV1Account_universal_d_GetProgramTotalsResponse = GetProgramTotalsResponse;\n type loyaltyV1Account_universal_d_TierTotal = TierTotal;\n type loyaltyV1Account_universal_d_GetCurrentMemberAccountRequest = GetCurrentMemberAccountRequest;\n type loyaltyV1Account_universal_d_GetCurrentMemberAccountResponse = GetCurrentMemberAccountResponse;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequest = GetAccountBySecondaryIdRequest;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequestIdOneOf = GetAccountBySecondaryIdRequestIdOneOf;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdResponse = GetAccountBySecondaryIdResponse;\n type loyaltyV1Account_universal_d_ListAccountsRequest = ListAccountsRequest;\n type loyaltyV1Account_universal_d_ListAccountsResponse = ListAccountsResponse;\n type loyaltyV1Account_universal_d_GetTransactionRequest = GetTransactionRequest;\n type loyaltyV1Account_universal_d_GetTransactionResponse = GetTransactionResponse;\n type loyaltyV1Account_universal_d_Transaction = Transaction;\n type loyaltyV1Account_universal_d_ListTransactionsRequest = ListTransactionsRequest;\n type loyaltyV1Account_universal_d_ListTransactionsResponse = ListTransactionsResponse;\n type loyaltyV1Account_universal_d_AccountsMerged = AccountsMerged;\n type loyaltyV1Account_universal_d_SubscriptionEvent = SubscriptionEvent;\n type loyaltyV1Account_universal_d_SubscriptionEventEventOneOf = SubscriptionEventEventOneOf;\n type loyaltyV1Account_universal_d_SubscriptionCreated = SubscriptionCreated;\n type loyaltyV1Account_universal_d_Subscription = Subscription;\n type loyaltyV1Account_universal_d_BillingReference = BillingReference;\n type loyaltyV1Account_universal_d_ProviderName = ProviderName;\n const loyaltyV1Account_universal_d_ProviderName: typeof ProviderName;\n type loyaltyV1Account_universal_d_Cycle = Cycle;\n type loyaltyV1Account_universal_d_CycleCycleSelectorOneOf = CycleCycleSelectorOneOf;\n type loyaltyV1Account_universal_d_Interval = Interval;\n type loyaltyV1Account_universal_d_IntervalUnit = IntervalUnit;\n const loyaltyV1Account_universal_d_IntervalUnit: typeof IntervalUnit;\n type loyaltyV1Account_universal_d_OneTime = OneTime;\n type loyaltyV1Account_universal_d_SubscriptionStatus = SubscriptionStatus;\n const loyaltyV1Account_universal_d_SubscriptionStatus: typeof SubscriptionStatus;\n type loyaltyV1Account_universal_d_SubscriptionAssigned = SubscriptionAssigned;\n type loyaltyV1Account_universal_d_SubscriptionCancelled = SubscriptionCancelled;\n type loyaltyV1Account_universal_d_CancellationDetails = CancellationDetails;\n type loyaltyV1Account_universal_d_Initiator = Initiator;\n const loyaltyV1Account_universal_d_Initiator: typeof Initiator;\n type loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOn = SubscriptionAutoRenewTurnedOn;\n type loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOff = SubscriptionAutoRenewTurnedOff;\n type loyaltyV1Account_universal_d_SubscriptionUnassigned = SubscriptionUnassigned;\n type loyaltyV1Account_universal_d_UnassignReason = UnassignReason;\n const loyaltyV1Account_universal_d_UnassignReason: typeof UnassignReason;\n type loyaltyV1Account_universal_d_SubscriptionTransferred = SubscriptionTransferred;\n type loyaltyV1Account_universal_d_RecurringChargeSucceeded = RecurringChargeSucceeded;\n type loyaltyV1Account_universal_d_ContractSwitched = ContractSwitched;\n type loyaltyV1Account_universal_d_ContractSwitchType = ContractSwitchType;\n const loyaltyV1Account_universal_d_ContractSwitchType: typeof ContractSwitchType;\n type loyaltyV1Account_universal_d_ContractSwitchReason = ContractSwitchReason;\n const loyaltyV1Account_universal_d_ContractSwitchReason: typeof ContractSwitchReason;\n type loyaltyV1Account_universal_d_ProductPriceIncreaseData = ProductPriceIncreaseData;\n type loyaltyV1Account_universal_d_SubscriptionNearEndOfPeriod = SubscriptionNearEndOfPeriod;\n type loyaltyV1Account_universal_d_SubscriptionPendingChange = SubscriptionPendingChange;\n const loyaltyV1Account_universal_d_createAccount: typeof createAccount;\n const loyaltyV1Account_universal_d_earnPoints: typeof earnPoints;\n type loyaltyV1Account_universal_d_EarnPointsOptions = EarnPointsOptions;\n const loyaltyV1Account_universal_d_adjustPoints: typeof adjustPoints;\n type loyaltyV1Account_universal_d_AdjustPointsOptions = AdjustPointsOptions;\n const loyaltyV1Account_universal_d_redeemPoints: typeof redeemPoints;\n type loyaltyV1Account_universal_d_RedeemPointsOptions = RedeemPointsOptions;\n const loyaltyV1Account_universal_d_getAccount: typeof getAccount;\n const loyaltyV1Account_universal_d_listUserAccounts: typeof listUserAccounts;\n type loyaltyV1Account_universal_d_ListUserAccountsOptions = ListUserAccountsOptions;\n const loyaltyV1Account_universal_d_getProgramTotals: typeof getProgramTotals;\n const loyaltyV1Account_universal_d_getCurrentMemberAccount: typeof getCurrentMemberAccount;\n const loyaltyV1Account_universal_d_getAccountBySecondaryId: typeof getAccountBySecondaryId;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdOptions = GetAccountBySecondaryIdOptions;\n const loyaltyV1Account_universal_d_listAccounts: typeof listAccounts;\n type loyaltyV1Account_universal_d_ListAccountsOptions = ListAccountsOptions;\n const loyaltyV1Account_universal_d_getTransaction: typeof getTransaction;\n const loyaltyV1Account_universal_d_listTransactions: typeof listTransactions;\n type loyaltyV1Account_universal_d_ListTransactionsOptions = ListTransactionsOptions;\n namespace loyaltyV1Account_universal_d {\n export {\n __debug$4 as __debug,\n loyaltyV1Account_universal_d_LoyaltyAccount as LoyaltyAccount,\n loyaltyV1Account_universal_d_Points as Points,\n loyaltyV1Account_universal_d_LatestTransaction as LatestTransaction,\n loyaltyV1Account_universal_d_TransactionType as TransactionType,\n loyaltyV1Account_universal_d_RedeemInfo as RedeemInfo,\n Tier$1 as Tier,\n loyaltyV1Account_universal_d_RewardAvailabilitiesChanged as RewardAvailabilitiesChanged,\n loyaltyV1Account_universal_d_RewardAvailabilityChangeReason as RewardAvailabilityChangeReason,\n loyaltyV1Account_universal_d_RewardAvailabilityUpdated as RewardAvailabilityUpdated,\n loyaltyV1Account_universal_d_UpdateTrigger as UpdateTrigger,\n loyaltyV1Account_universal_d_CreateAccountRequest as CreateAccountRequest,\n loyaltyV1Account_universal_d_CreateAccountResponse as CreateAccountResponse,\n loyaltyV1Account_universal_d_EarnPointsRequest as EarnPointsRequest,\n loyaltyV1Account_universal_d_EarnPointsResponse as EarnPointsResponse,\n loyaltyV1Account_universal_d_PointsUpdated as PointsUpdated,\n loyaltyV1Account_universal_d_AdjustPointsRequest as AdjustPointsRequest,\n loyaltyV1Account_universal_d_AdjustPointsRequestTypeOneOf as AdjustPointsRequestTypeOneOf,\n loyaltyV1Account_universal_d_AdjustPointsResponse as AdjustPointsResponse,\n loyaltyV1Account_universal_d_RedeemPointsRequest as RedeemPointsRequest,\n loyaltyV1Account_universal_d_RedeemPointsResponse as RedeemPointsResponse,\n loyaltyV1Account_universal_d_GetAccountRequest as GetAccountRequest,\n loyaltyV1Account_universal_d_GetAccountResponse as GetAccountResponse,\n loyaltyV1Account_universal_d_ListUserAccountsRequest as ListUserAccountsRequest,\n loyaltyV1Account_universal_d_ListUserAccountsResponse as ListUserAccountsResponse,\n loyaltyV1Account_universal_d_LoyaltyAccountForMetaSite as LoyaltyAccountForMetaSite,\n loyaltyV1Account_universal_d_GetProgramTotalsRequest as GetProgramTotalsRequest,\n loyaltyV1Account_universal_d_GetProgramTotalsResponse as GetProgramTotalsResponse,\n loyaltyV1Account_universal_d_TierTotal as TierTotal,\n loyaltyV1Account_universal_d_GetCurrentMemberAccountRequest as GetCurrentMemberAccountRequest,\n loyaltyV1Account_universal_d_GetCurrentMemberAccountResponse as GetCurrentMemberAccountResponse,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequest as GetAccountBySecondaryIdRequest,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequestIdOneOf as GetAccountBySecondaryIdRequestIdOneOf,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdResponse as GetAccountBySecondaryIdResponse,\n loyaltyV1Account_universal_d_ListAccountsRequest as ListAccountsRequest,\n CursorPaging$2 as CursorPaging,\n loyaltyV1Account_universal_d_ListAccountsResponse as ListAccountsResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n Cursors$2 as Cursors,\n loyaltyV1Account_universal_d_GetTransactionRequest as GetTransactionRequest,\n loyaltyV1Account_universal_d_GetTransactionResponse as GetTransactionResponse,\n loyaltyV1Account_universal_d_Transaction as Transaction,\n loyaltyV1Account_universal_d_ListTransactionsRequest as ListTransactionsRequest,\n loyaltyV1Account_universal_d_ListTransactionsResponse as ListTransactionsResponse,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n ExtendedFieldsUpdatedEvent$2 as ExtendedFieldsUpdatedEvent,\n Empty$3 as Empty,\n loyaltyV1Account_universal_d_AccountsMerged as AccountsMerged,\n TiersRollingUpdate$1 as TiersRollingUpdate,\n TiersProgramSettingsChanged$1 as TiersProgramSettingsChanged,\n TiersProgramSettings$1 as TiersProgramSettings,\n TiersProgramSettingsPeriodOneOf$1 as TiersProgramSettingsPeriodOneOf,\n Status$2 as Status,\n TierDefinition$1 as TierDefinition,\n RollingWindow$1 as RollingWindow,\n loyaltyV1Account_universal_d_SubscriptionEvent as SubscriptionEvent,\n loyaltyV1Account_universal_d_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf,\n loyaltyV1Account_universal_d_SubscriptionCreated as SubscriptionCreated,\n loyaltyV1Account_universal_d_Subscription as Subscription,\n loyaltyV1Account_universal_d_BillingReference as BillingReference,\n loyaltyV1Account_universal_d_ProviderName as ProviderName,\n loyaltyV1Account_universal_d_Cycle as Cycle,\n loyaltyV1Account_universal_d_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf,\n loyaltyV1Account_universal_d_Interval as Interval,\n loyaltyV1Account_universal_d_IntervalUnit as IntervalUnit,\n loyaltyV1Account_universal_d_OneTime as OneTime,\n loyaltyV1Account_universal_d_SubscriptionStatus as SubscriptionStatus,\n loyaltyV1Account_universal_d_SubscriptionAssigned as SubscriptionAssigned,\n loyaltyV1Account_universal_d_SubscriptionCancelled as SubscriptionCancelled,\n loyaltyV1Account_universal_d_CancellationDetails as CancellationDetails,\n loyaltyV1Account_universal_d_Initiator as Initiator,\n loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn,\n loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff,\n loyaltyV1Account_universal_d_SubscriptionUnassigned as SubscriptionUnassigned,\n loyaltyV1Account_universal_d_UnassignReason as UnassignReason,\n loyaltyV1Account_universal_d_SubscriptionTransferred as SubscriptionTransferred,\n loyaltyV1Account_universal_d_RecurringChargeSucceeded as RecurringChargeSucceeded,\n loyaltyV1Account_universal_d_ContractSwitched as ContractSwitched,\n loyaltyV1Account_universal_d_ContractSwitchType as ContractSwitchType,\n loyaltyV1Account_universal_d_ContractSwitchReason as ContractSwitchReason,\n loyaltyV1Account_universal_d_ProductPriceIncreaseData as ProductPriceIncreaseData,\n loyaltyV1Account_universal_d_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod,\n loyaltyV1Account_universal_d_SubscriptionPendingChange as SubscriptionPendingChange,\n loyaltyV1Account_universal_d_createAccount as createAccount,\n loyaltyV1Account_universal_d_earnPoints as earnPoints,\n loyaltyV1Account_universal_d_EarnPointsOptions as EarnPointsOptions,\n loyaltyV1Account_universal_d_adjustPoints as adjustPoints,\n loyaltyV1Account_universal_d_AdjustPointsOptions as AdjustPointsOptions,\n loyaltyV1Account_universal_d_redeemPoints as redeemPoints,\n loyaltyV1Account_universal_d_RedeemPointsOptions as RedeemPointsOptions,\n loyaltyV1Account_universal_d_getAccount as getAccount,\n loyaltyV1Account_universal_d_listUserAccounts as listUserAccounts,\n loyaltyV1Account_universal_d_ListUserAccountsOptions as ListUserAccountsOptions,\n loyaltyV1Account_universal_d_getProgramTotals as getProgramTotals,\n loyaltyV1Account_universal_d_getCurrentMemberAccount as getCurrentMemberAccount,\n loyaltyV1Account_universal_d_getAccountBySecondaryId as getAccountBySecondaryId,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdOptions as GetAccountBySecondaryIdOptions,\n loyaltyV1Account_universal_d_listAccounts as listAccounts,\n loyaltyV1Account_universal_d_ListAccountsOptions as ListAccountsOptions,\n loyaltyV1Account_universal_d_getTransaction as getTransaction,\n loyaltyV1Account_universal_d_listTransactions as listTransactions,\n loyaltyV1Account_universal_d_ListTransactionsOptions as ListTransactionsOptions,\n };\n }\n \n const __debug$3: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 }\n interface PointDefinition {\n /**\n * Display name for the program's collectible unit. It's recommended to use the plural, for example\n * `\"Stars\"`. In contrast to a custom name, the default `\"Points\"` name is translated and adjusted to singular based\n * on circumstances.\n *\n * Default: `\"Points\"`\n *\n * Max: 20 characters\n */\n customName?: string | null;\n /** Details about the points icon. */\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 GetLoyaltyProgramRequest {\n }\n interface GetLoyaltyProgramResponse {\n /** Retrieved loyalty program. */\n loyaltyProgram?: LoyaltyProgram;\n }\n interface BulkGetLoyaltyProgramRequest {\n /** Metasite IDs. */\n metaSiteIds?: string[];\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 ActivateLoyaltyProgramRequest {\n }\n interface ActivateLoyaltyProgramResponse {\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 MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {\n metaSiteId?: string;\n version?: string;\n timestamp?: string;\n assets?: Asset[];\n siteCreated?: SiteCreated;\n siteTransferred?: SiteTransferred;\n siteDeleted?: SiteDeleted;\n siteUndeleted?: SiteUndeleted;\n sitePublished?: SitePublished;\n siteUnpublished?: SiteUnpublished;\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n serviceProvisioned?: ServiceProvisioned;\n serviceRemoved?: ServiceRemoved;\n siteRenamedPayload?: SiteRenamed;\n hardDeleted?: SiteHardDeleted;\n namespaceChanged?: NamespaceChanged;\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf {\n siteCreated?: SiteCreated;\n siteTransferred?: SiteTransferred;\n siteDeleted?: SiteDeleted;\n siteUndeleted?: SiteUndeleted;\n sitePublished?: SitePublished;\n siteUnpublished?: SiteUnpublished;\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n serviceProvisioned?: ServiceProvisioned;\n serviceRemoved?: ServiceRemoved;\n siteRenamedPayload?: SiteRenamed;\n hardDeleted?: SiteHardDeleted;\n namespaceChanged?: NamespaceChanged;\n }\n interface Asset {\n appDefId?: string;\n instanceId?: string;\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 originTemplateId?: string;\n ownerId?: string;\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 siteName?: string;\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 }\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 deleteContext?: DeleteContext;\n }\n interface DeleteContext {\n dateDeleted?: Date;\n deleteStatus?: DeleteStatus;\n deleteOrigin?: string;\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 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 originInstanceId?: string;\n version?: string | null;\n }\n interface ServiceRemoved {\n appDefId?: string;\n instanceId?: string;\n version?: string | null;\n }\n /** Rename of the site. Meaning, free public url has been changed as well. */\n interface SiteRenamed {\n newSiteName?: string;\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 deleteContext?: DeleteContext;\n }\n interface NamespaceChanged {\n oldNamespace?: Namespace;\n newNamespace?: Namespace;\n }\n interface Empty$2 {\n }\n /**\n * Retrieves the loyalty program.\n *\n * The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.\n *\n * This function requires no additional parameters as there is only a single loyalty program available for any site.\n * @public\n * @documentationMaturity preview\n */\n function getLoyaltyProgram(): Promise;\n /**\n * Retrieves loyalty programs for multiple metasites.\n * @documentationMaturity preview */\n function bulkGetLoyaltyProgram(options?: BulkGetLoyaltyProgramOptions): Promise;\n interface BulkGetLoyaltyProgramOptions {\n /** Metasite IDs. */\n metaSiteIds?: string[];\n }\n /**\n * Updates the 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-backend/program/activateloyaltyprogram) function.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [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%2Froles-and-permissions) can update a loyalty program.\n *\n *\n * @param loyaltyProgram - Loyalty program fields to update.\n * @public\n * @documentationMaturity preview\n * @requiredField loyaltyProgram\n */\n function updateLoyaltyProgram(loyaltyProgram: LoyaltyProgram): Promise;\n /**\n * Changes the program status to `ACTIVE`.\n *\n * The `activateLoyaltyProgram()` function returns a Promise that resolves when the status of the loyalty program is successfully changed to `ACTIVE`.\n *\n * Initially when a loyalty program is installed, the status is set to `DRAFT`. This function changes the status to `ACTIVE`. 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-backend/program/updateloyaltyprogram) function.\n *\n * >**Note:** Only visitors with **Manage Loyalty** [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%2Froles-and-permissions) can activate a loyalty program.\n * @public\n * @documentationMaturity preview\n */\n function activateLoyaltyProgram(): Promise;\n /**\n * Changes the program status to `PAUSED`.\n * @documentationMaturity preview */\n function pauseLoyaltyProgram(): Promise;\n /**\n * Retrieves the program description.\n * @documentationMaturity preview\n * @returns The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.\n */\n function getLoyaltyProgramDescription(options?: GetLoyaltyProgramDescriptionOptions): Promise;\n interface GetLoyaltyProgramDescriptionOptions {\n /** List of description fields to retrieve. Supported values: `description`, `updatedDate`. */\n fields?: string[];\n }\n /**\n * Updates the program description.\n * @documentationMaturity preview */\n function updateLoyaltyProgramDescription(options?: UpdateLoyaltyProgramDescriptionOptions): Promise;\n interface UpdateLoyaltyProgramDescriptionOptions {\n /** Loyalty program description to update. */\n description?: string;\n }\n \n type loyaltyV1Program_universal_d_LoyaltyProgram = LoyaltyProgram;\n type loyaltyV1Program_universal_d_PointDefinition = PointDefinition;\n type loyaltyV1Program_universal_d_ProgramStatus = ProgramStatus;\n const loyaltyV1Program_universal_d_ProgramStatus: typeof ProgramStatus;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramRequest = GetLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramResponse = GetLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_BulkGetLoyaltyProgramRequest = BulkGetLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_BulkGetLoyaltyProgramResponse = BulkGetLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_ProgramInSite = ProgramInSite;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramRequest = UpdateLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramResponse = UpdateLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_ActivateLoyaltyProgramRequest = ActivateLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_ActivateLoyaltyProgramResponse = ActivateLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_PauseLoyaltyProgramRequest = PauseLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_PauseLoyaltyProgramResponse = PauseLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionRequest = GetLoyaltyProgramDescriptionRequest;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionResponse = GetLoyaltyProgramDescriptionResponse;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionRequest = UpdateLoyaltyProgramDescriptionRequest;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionResponse = UpdateLoyaltyProgramDescriptionResponse;\n type loyaltyV1Program_universal_d_LoyaltyProgramDescriptionUpdated = LoyaltyProgramDescriptionUpdated;\n type loyaltyV1Program_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type loyaltyV1Program_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type loyaltyV1Program_universal_d_Asset = Asset;\n type loyaltyV1Program_universal_d_State = State;\n const loyaltyV1Program_universal_d_State: typeof State;\n type loyaltyV1Program_universal_d_SiteCreated = SiteCreated;\n type loyaltyV1Program_universal_d_SiteCreatedContext = SiteCreatedContext;\n const loyaltyV1Program_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type loyaltyV1Program_universal_d_Namespace = Namespace;\n const loyaltyV1Program_universal_d_Namespace: typeof Namespace;\n type loyaltyV1Program_universal_d_SiteTransferred = SiteTransferred;\n type loyaltyV1Program_universal_d_SiteDeleted = SiteDeleted;\n type loyaltyV1Program_universal_d_DeleteContext = DeleteContext;\n type loyaltyV1Program_universal_d_DeleteStatus = DeleteStatus;\n const loyaltyV1Program_universal_d_DeleteStatus: typeof DeleteStatus;\n type loyaltyV1Program_universal_d_SiteUndeleted = SiteUndeleted;\n type loyaltyV1Program_universal_d_SitePublished = SitePublished;\n type loyaltyV1Program_universal_d_SiteUnpublished = SiteUnpublished;\n type loyaltyV1Program_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type loyaltyV1Program_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type loyaltyV1Program_universal_d_ServiceProvisioned = ServiceProvisioned;\n type loyaltyV1Program_universal_d_ServiceRemoved = ServiceRemoved;\n type loyaltyV1Program_universal_d_SiteRenamed = SiteRenamed;\n type loyaltyV1Program_universal_d_SiteHardDeleted = SiteHardDeleted;\n type loyaltyV1Program_universal_d_NamespaceChanged = NamespaceChanged;\n const loyaltyV1Program_universal_d_getLoyaltyProgram: typeof getLoyaltyProgram;\n const loyaltyV1Program_universal_d_bulkGetLoyaltyProgram: typeof bulkGetLoyaltyProgram;\n type loyaltyV1Program_universal_d_BulkGetLoyaltyProgramOptions = BulkGetLoyaltyProgramOptions;\n const loyaltyV1Program_universal_d_updateLoyaltyProgram: typeof updateLoyaltyProgram;\n const loyaltyV1Program_universal_d_activateLoyaltyProgram: typeof activateLoyaltyProgram;\n const loyaltyV1Program_universal_d_pauseLoyaltyProgram: typeof pauseLoyaltyProgram;\n const loyaltyV1Program_universal_d_getLoyaltyProgramDescription: typeof getLoyaltyProgramDescription;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionOptions = GetLoyaltyProgramDescriptionOptions;\n const loyaltyV1Program_universal_d_updateLoyaltyProgramDescription: typeof updateLoyaltyProgramDescription;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionOptions = UpdateLoyaltyProgramDescriptionOptions;\n namespace loyaltyV1Program_universal_d {\n export {\n __debug$3 as __debug,\n loyaltyV1Program_universal_d_LoyaltyProgram as LoyaltyProgram,\n loyaltyV1Program_universal_d_PointDefinition as PointDefinition,\n loyaltyV1Program_universal_d_ProgramStatus as ProgramStatus,\n loyaltyV1Program_universal_d_GetLoyaltyProgramRequest as GetLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_GetLoyaltyProgramResponse as GetLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_BulkGetLoyaltyProgramRequest as BulkGetLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_BulkGetLoyaltyProgramResponse as BulkGetLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_ProgramInSite as ProgramInSite,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramRequest as UpdateLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramResponse as UpdateLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_ActivateLoyaltyProgramRequest as ActivateLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_ActivateLoyaltyProgramResponse as ActivateLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_PauseLoyaltyProgramRequest as PauseLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_PauseLoyaltyProgramResponse as PauseLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionRequest as GetLoyaltyProgramDescriptionRequest,\n loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionResponse as GetLoyaltyProgramDescriptionResponse,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionRequest as UpdateLoyaltyProgramDescriptionRequest,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionResponse as UpdateLoyaltyProgramDescriptionResponse,\n loyaltyV1Program_universal_d_LoyaltyProgramDescriptionUpdated as LoyaltyProgramDescriptionUpdated,\n loyaltyV1Program_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n loyaltyV1Program_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n loyaltyV1Program_universal_d_Asset as Asset,\n loyaltyV1Program_universal_d_State as State,\n loyaltyV1Program_universal_d_SiteCreated as SiteCreated,\n loyaltyV1Program_universal_d_SiteCreatedContext as SiteCreatedContext,\n loyaltyV1Program_universal_d_Namespace as Namespace,\n loyaltyV1Program_universal_d_SiteTransferred as SiteTransferred,\n loyaltyV1Program_universal_d_SiteDeleted as SiteDeleted,\n loyaltyV1Program_universal_d_DeleteContext as DeleteContext,\n loyaltyV1Program_universal_d_DeleteStatus as DeleteStatus,\n loyaltyV1Program_universal_d_SiteUndeleted as SiteUndeleted,\n loyaltyV1Program_universal_d_SitePublished as SitePublished,\n loyaltyV1Program_universal_d_SiteUnpublished as SiteUnpublished,\n loyaltyV1Program_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n loyaltyV1Program_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n loyaltyV1Program_universal_d_ServiceProvisioned as ServiceProvisioned,\n loyaltyV1Program_universal_d_ServiceRemoved as ServiceRemoved,\n loyaltyV1Program_universal_d_SiteRenamed as SiteRenamed,\n loyaltyV1Program_universal_d_SiteHardDeleted as SiteHardDeleted,\n loyaltyV1Program_universal_d_NamespaceChanged as NamespaceChanged,\n Empty$2 as Empty,\n loyaltyV1Program_universal_d_getLoyaltyProgram as getLoyaltyProgram,\n loyaltyV1Program_universal_d_bulkGetLoyaltyProgram as bulkGetLoyaltyProgram,\n loyaltyV1Program_universal_d_BulkGetLoyaltyProgramOptions as BulkGetLoyaltyProgramOptions,\n loyaltyV1Program_universal_d_updateLoyaltyProgram as updateLoyaltyProgram,\n loyaltyV1Program_universal_d_activateLoyaltyProgram as activateLoyaltyProgram,\n loyaltyV1Program_universal_d_pauseLoyaltyProgram as pauseLoyaltyProgram,\n loyaltyV1Program_universal_d_getLoyaltyProgramDescription as getLoyaltyProgramDescription,\n loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionOptions as GetLoyaltyProgramDescriptionOptions,\n loyaltyV1Program_universal_d_updateLoyaltyProgramDescription as updateLoyaltyProgramDescription,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionOptions as UpdateLoyaltyProgramDescriptionOptions,\n };\n }\n \n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 {\n /**\n * Tier ID.\n * @readonly\n */\n _id?: string | null;\n /** Information about the tier. */\n tierDefinition?: TierDefinition;\n /**\n * The amount of points required to be in this tier.\n *\n * Min: `\"0\"`\n * Max: `\"9999999\"`\n */\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;\n /**\n * Date and time the tier was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n /** Information about the tier. */\n interface TierDefinition {\n /** Details about the tier icon. */\n icon?: string;\n /**\n * Tier name.\n *\n * Min: 2 characters\n * Max: 50 characters\n */\n name?: string | null;\n /**\n * Tier desciption.\n *\n * Max: 70 characters\n */\n description?: string | null;\n }\n interface TiersProgramSettingsChanged {\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.** 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$1;\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;\n /**\n * Date and time the loyalty tiers program was last updated.\n * @readonly\n */\n _updatedDate?: Date;\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.** 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$1 {\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 {\n /**\n * Number of months to use for the rolling window period.\n *\n * Min: `\"12\"`\n * Max: `\"36\"`\n */\n durationInMonths?: number;\n }\n interface TiersRollingUpdate {\n }\n interface CreateTierRequest {\n /** Tier to create. */\n tier: Tier;\n }\n interface CreateTierResponse {\n /** Created loyalty tier. */\n tier?: Tier;\n }\n interface BulkCreateTiersRequest {\n /** Tiers to create. */\n tiers?: Tier[];\n }\n interface BulkCreateTiersResponse {\n /** Created tiers. */\n results?: BulkTierResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n /** Retrieved tiers. */\n interface BulkTierResult {\n /** Individual tier metadata. */\n itemMetadata?: ItemMetadata$1;\n /** Individual tier information. */\n item?: Tier;\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 GetTierRequest {\n /** ID of the tier to retrieve. */\n tierId: string;\n }\n interface GetTierResponse {\n /** Retrieved loyalty tier. */\n tier?: Tier;\n }\n interface UpdateTierRequest {\n /** Tier details to update. */\n tier: Tier;\n }\n interface UpdateTierResponse {\n /** Updated loyalty tier. */\n tier?: Tier;\n }\n interface TierRequiredPointsChanged {\n tier?: Tier;\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[];\n }\n interface CreateTiersProgramSettingsRequest {\n programSettings: TiersProgramSettings;\n }\n interface CreateTiersProgramSettingsResponse {\n programSettings?: TiersProgramSettings;\n }\n interface GetTiersProgramRequest {\n }\n interface GetTiersProgramResponse {\n tiers?: Tier[];\n programSettings?: TiersProgramSettings;\n vipPlan?: boolean;\n }\n interface GetTiersProgramSettingsRequest {\n }\n interface GetTiersProgramSettingsResponse {\n /** Tiers program settings. */\n programSettings?: TiersProgramSettings;\n /** For internal use. */\n vipPlan?: boolean;\n }\n interface UpdateTiersProgramSettingsRequest {\n /** Settings for the tiers program. */\n programSettings: TiersProgramSettings;\n }\n interface UpdateTiersProgramSettingsResponse {\n /** Updated program settings. */\n programSettings?: TiersProgramSettings;\n }\n interface RecalculateAllTiersRequest {\n }\n interface RecalculateAllTiersResponse {\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 [Bulk Create Tiers](https://dev.wix.com/api/rest/wix-loyalty-program/tiers/bulk-create-tiers).\n *\n * >**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview)\n * >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 * @documentationMaturity preview\n * @requiredField tier\n */\n function createTier(tier: Tier): 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 [Create Tier](https://dev.wix.com/api/rest/wix-loyalty-program/tiers/create-tier).\n *\n * >**Note:** You must have a [Business VIP Premium plan](https://support.wix.com/en/article/business-vip-premium-plan-overview)\n * >or a [Scale Premium plan](https://support.wix.com/en/article/editor-x-scale-premium-plan-overview) to add tiers.\n * @public\n * @documentationMaturity preview\n */\n function bulkCreateTiers(options?: BulkCreateTiersOptions): Promise;\n interface BulkCreateTiersOptions {\n /** Tiers to create. */\n tiers?: Tier[];\n }\n /**\n * Retrieves a loyalty tier.\n *\n * To retrieve a list of all of a site's tiers, use [List Tiers](https://dev.wix.com/api/rest/wix-loyalty-program/tiers/list-tiers).\n * @param tierId - ID of the tier to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField tierId\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 [Update Tiers Program Settings](https://dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tiers-program-settings).\n * @param _id - Tier ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField tier\n * @requiredField tier.revision\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;\n /**\n * The amount of points required to be in this tier.\n *\n * Min: `\"0\"`\n * Max: `\"9999999\"`\n */\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;\n /**\n * Date and time the tier was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n /**\n * Deletes a loyalty tier.\n * @param tierId - ID of the tier to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField tierId\n */\n function deleteTier(tierId: string, options?: DeleteTierOptions): Promise;\n interface DeleteTierOptions {\n /** Current `revision` of the tier to delete. */\n revision?: string;\n }\n /**\n * Retrieves a list of a site's tiers.\n *\n * To retrieve a specific tier, use [Get Tier](https://dev.wix.com/api/rest/wix-loyalty-program/tiers/get-tier).\n * @public\n * @documentationMaturity preview\n */\n function listTiers(): Promise;\n /**\n * Create TiersProgramSettings\n * @internal\n * @documentationMaturity preview\n * @requiredField programSettings\n */\n function createTiersProgramSettings(programSettings: TiersProgramSettings): Promise;\n /**\n * GetTiersProgram returns Tiers and ProgramSettings in single response\n * If TiersProgramSettings don't exist, default TiersProgramSettings are created\n * @internal\n * @documentationMaturity preview\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 * @documentationMaturity preview\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 * [Update Tier](https://dev.wix.com/api/rest/wix-loyalty-program/tiers/update-tier).\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.\n * >The `baseTierDefinition` fields are not required, however, if you don't pass them they will reset to\n * >their default values of empty fields.\n * @param programSettings - Settings for the tiers program.\n * @public\n * @documentationMaturity preview\n * @requiredField programSettings\n * @requiredField programSettings.revision\n * @requiredField programSettings.status\n */\n function updateTiersProgramSettings(programSettings: TiersProgramSettings): Promise;\n \n type loyaltyV1Tier_universal_d_Tier = Tier;\n type loyaltyV1Tier_universal_d_TierDefinition = TierDefinition;\n type loyaltyV1Tier_universal_d_TiersProgramSettingsChanged = TiersProgramSettingsChanged;\n type loyaltyV1Tier_universal_d_TiersProgramSettings = TiersProgramSettings;\n type loyaltyV1Tier_universal_d_TiersProgramSettingsPeriodOneOf = TiersProgramSettingsPeriodOneOf;\n type loyaltyV1Tier_universal_d_RollingWindow = RollingWindow;\n type loyaltyV1Tier_universal_d_TiersRollingUpdate = TiersRollingUpdate;\n type loyaltyV1Tier_universal_d_CreateTierRequest = CreateTierRequest;\n type loyaltyV1Tier_universal_d_CreateTierResponse = CreateTierResponse;\n type loyaltyV1Tier_universal_d_BulkCreateTiersRequest = BulkCreateTiersRequest;\n type loyaltyV1Tier_universal_d_BulkCreateTiersResponse = BulkCreateTiersResponse;\n type loyaltyV1Tier_universal_d_BulkTierResult = BulkTierResult;\n type loyaltyV1Tier_universal_d_GetTierRequest = GetTierRequest;\n type loyaltyV1Tier_universal_d_GetTierResponse = GetTierResponse;\n type loyaltyV1Tier_universal_d_UpdateTierRequest = UpdateTierRequest;\n type loyaltyV1Tier_universal_d_UpdateTierResponse = UpdateTierResponse;\n type loyaltyV1Tier_universal_d_TierRequiredPointsChanged = TierRequiredPointsChanged;\n type loyaltyV1Tier_universal_d_DeleteTierRequest = DeleteTierRequest;\n type loyaltyV1Tier_universal_d_DeleteTierResponse = DeleteTierResponse;\n type loyaltyV1Tier_universal_d_ListTiersRequest = ListTiersRequest;\n type loyaltyV1Tier_universal_d_ListTiersResponse = ListTiersResponse;\n type loyaltyV1Tier_universal_d_CreateTiersProgramSettingsRequest = CreateTiersProgramSettingsRequest;\n type loyaltyV1Tier_universal_d_CreateTiersProgramSettingsResponse = CreateTiersProgramSettingsResponse;\n type loyaltyV1Tier_universal_d_GetTiersProgramRequest = GetTiersProgramRequest;\n type loyaltyV1Tier_universal_d_GetTiersProgramResponse = GetTiersProgramResponse;\n type loyaltyV1Tier_universal_d_GetTiersProgramSettingsRequest = GetTiersProgramSettingsRequest;\n type loyaltyV1Tier_universal_d_GetTiersProgramSettingsResponse = GetTiersProgramSettingsResponse;\n type loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsRequest = UpdateTiersProgramSettingsRequest;\n type loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsResponse = UpdateTiersProgramSettingsResponse;\n type loyaltyV1Tier_universal_d_RecalculateAllTiersRequest = RecalculateAllTiersRequest;\n type loyaltyV1Tier_universal_d_RecalculateAllTiersResponse = RecalculateAllTiersResponse;\n const loyaltyV1Tier_universal_d_createTier: typeof createTier;\n const loyaltyV1Tier_universal_d_bulkCreateTiers: typeof bulkCreateTiers;\n type loyaltyV1Tier_universal_d_BulkCreateTiersOptions = BulkCreateTiersOptions;\n const loyaltyV1Tier_universal_d_getTier: typeof getTier;\n const loyaltyV1Tier_universal_d_updateTier: typeof updateTier;\n type loyaltyV1Tier_universal_d_UpdateTier = UpdateTier;\n const loyaltyV1Tier_universal_d_deleteTier: typeof deleteTier;\n type loyaltyV1Tier_universal_d_DeleteTierOptions = DeleteTierOptions;\n const loyaltyV1Tier_universal_d_listTiers: typeof listTiers;\n const loyaltyV1Tier_universal_d_createTiersProgramSettings: typeof createTiersProgramSettings;\n const loyaltyV1Tier_universal_d_getTiersProgram: typeof getTiersProgram;\n const loyaltyV1Tier_universal_d_getTiersProgramSettings: typeof getTiersProgramSettings;\n const loyaltyV1Tier_universal_d_updateTiersProgramSettings: typeof updateTiersProgramSettings;\n namespace loyaltyV1Tier_universal_d {\n export {\n __debug$2 as __debug,\n loyaltyV1Tier_universal_d_Tier as Tier,\n loyaltyV1Tier_universal_d_TierDefinition as TierDefinition,\n loyaltyV1Tier_universal_d_TiersProgramSettingsChanged as TiersProgramSettingsChanged,\n loyaltyV1Tier_universal_d_TiersProgramSettings as TiersProgramSettings,\n loyaltyV1Tier_universal_d_TiersProgramSettingsPeriodOneOf as TiersProgramSettingsPeriodOneOf,\n Status$1 as Status,\n loyaltyV1Tier_universal_d_RollingWindow as RollingWindow,\n loyaltyV1Tier_universal_d_TiersRollingUpdate as TiersRollingUpdate,\n loyaltyV1Tier_universal_d_CreateTierRequest as CreateTierRequest,\n loyaltyV1Tier_universal_d_CreateTierResponse as CreateTierResponse,\n loyaltyV1Tier_universal_d_BulkCreateTiersRequest as BulkCreateTiersRequest,\n loyaltyV1Tier_universal_d_BulkCreateTiersResponse as BulkCreateTiersResponse,\n loyaltyV1Tier_universal_d_BulkTierResult as BulkTierResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n loyaltyV1Tier_universal_d_GetTierRequest as GetTierRequest,\n loyaltyV1Tier_universal_d_GetTierResponse as GetTierResponse,\n loyaltyV1Tier_universal_d_UpdateTierRequest as UpdateTierRequest,\n loyaltyV1Tier_universal_d_UpdateTierResponse as UpdateTierResponse,\n loyaltyV1Tier_universal_d_TierRequiredPointsChanged as TierRequiredPointsChanged,\n loyaltyV1Tier_universal_d_DeleteTierRequest as DeleteTierRequest,\n loyaltyV1Tier_universal_d_DeleteTierResponse as DeleteTierResponse,\n loyaltyV1Tier_universal_d_ListTiersRequest as ListTiersRequest,\n loyaltyV1Tier_universal_d_ListTiersResponse as ListTiersResponse,\n loyaltyV1Tier_universal_d_CreateTiersProgramSettingsRequest as CreateTiersProgramSettingsRequest,\n loyaltyV1Tier_universal_d_CreateTiersProgramSettingsResponse as CreateTiersProgramSettingsResponse,\n loyaltyV1Tier_universal_d_GetTiersProgramRequest as GetTiersProgramRequest,\n loyaltyV1Tier_universal_d_GetTiersProgramResponse as GetTiersProgramResponse,\n loyaltyV1Tier_universal_d_GetTiersProgramSettingsRequest as GetTiersProgramSettingsRequest,\n loyaltyV1Tier_universal_d_GetTiersProgramSettingsResponse as GetTiersProgramSettingsResponse,\n loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsRequest as UpdateTiersProgramSettingsRequest,\n loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsResponse as UpdateTiersProgramSettingsResponse,\n loyaltyV1Tier_universal_d_RecalculateAllTiersRequest as RecalculateAllTiersRequest,\n loyaltyV1Tier_universal_d_RecalculateAllTiersResponse as RecalculateAllTiersResponse,\n loyaltyV1Tier_universal_d_createTier as createTier,\n loyaltyV1Tier_universal_d_bulkCreateTiers as bulkCreateTiers,\n loyaltyV1Tier_universal_d_BulkCreateTiersOptions as BulkCreateTiersOptions,\n loyaltyV1Tier_universal_d_getTier as getTier,\n loyaltyV1Tier_universal_d_updateTier as updateTier,\n loyaltyV1Tier_universal_d_UpdateTier as UpdateTier,\n loyaltyV1Tier_universal_d_deleteTier as deleteTier,\n loyaltyV1Tier_universal_d_DeleteTierOptions as DeleteTierOptions,\n loyaltyV1Tier_universal_d_listTiers as listTiers,\n loyaltyV1Tier_universal_d_createTiersProgramSettings as createTiersProgramSettings,\n loyaltyV1Tier_universal_d_getTiersProgram as getTiersProgram,\n loyaltyV1Tier_universal_d_getTiersProgramSettings as getTiersProgramSettings,\n loyaltyV1Tier_universal_d_updateTiersProgramSettings as updateTiersProgramSettings,\n };\n }\n \n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\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 /** @internal */\n coupon?: Coupon;\n /**\n * Reward ID.\n * @readonly\n */\n _id?: string | null;\n /** Reward name. */\n name?: string;\n /**\n * Amount of points required to receive the reward.\n * @internal\n */\n requiredPoints?: number;\n /**\n * Whether the reward is active.\n *\n * Default: `\"false\"`\n */\n active?: boolean;\n /**\n * Reward type.\n *\n * + `\"DISCOUNT_AMOUNT\"`: Discount reward. Only available for Wix Restaurants. [Learn more about discounts.](https://support.wix.com/en/article/wix-restaurants-creating-discounts-for-your-customers)\n * + `\"COUPON_REWARD\"`: Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards)\n * + `\"COUPON\"`: **Deprecated.** Use `\"COUPON_REWARD\"` instead.\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 /** @internal */\n coupon?: Coupon;\n }\n /** Available reward types. */\n enum RewardType {\n UNDEFINED = \"UNDEFINED\",\n DISCOUNT_AMOUNT = \"DISCOUNT_AMOUNT\",\n COUPON = \"COUPON\",\n COUPON_REWARD = \"COUPON_REWARD\"\n }\n /** TODO add [(wix.api.minSize) = 1, (wix.api.maxSize) = 20] to DiscountAmount; */\n interface DiscountAmount {\n /**\n * Discount amount. Must be a positive value.\n * @internal\n */\n amount?: string;\n /** Discount details for each tier. */\n configsByTier?: DiscountAmountConfig[];\n }\n /** TODO after migration for cost_in_points use [(wix.api.min) = 1, (wix.api.max) = 9999999]; */\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 * For more information, see [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).\n */\n scope?: CouponScope;\n /** Whether the coupon is limited to one item. */\n limitedToOneItem?: boolean | null;\n /** Whether the coupon also applies to subscriptions. */\n appliesToSubscriptions?: boolean | null;\n /**\n * Specifies the amount of discounted cycles for a subscription item.\n *\n * Can only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`.\n * If `discountedCycleCount` is empty, the coupon applies to all available cycles.\n *\n * Min: `1`\n * Max: `999`\n */\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 * For more information, see [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).\n */\n scope?: CouponScope;\n }\n /** TODO add [(wix.api.minSize) = 1, (wix.api.maxSize) = 20] */\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 /** TODO add [(wix.api.minSize) = 1, (wix.api.maxSize) = 20] */\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 /** TODO add [(wix.api.minSize) = 1, (wix.api.maxSize) = 20] */\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 [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid namespaces.\n */\n namespace?: string;\n /**\n * Coupon scope's applied group.\n *\n * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.\n */\n group?: Group;\n }\n interface Group {\n /**\n * Name of coupon scope's group.\n *\n * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) 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 Coupon {\n templateId?: string;\n /** @readonly */\n deleted?: boolean | null;\n configs?: CouponConfig[];\n }\n interface CouponConfig {\n /** Amount of points required to receive the reward. */\n requiredPoints?: number;\n /**\n * Tier ID, or empty if config applies to the base tier.\n * @readonly\n */\n tierId?: string | null;\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;\n }\n interface BulkRewardResult {\n itemMetadata?: ItemMetadata;\n item?: Reward;\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 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 metaSiteIds?: string[];\n }\n interface BulkGetRewardsResponse {\n rewardsInSite?: RewardsInSite[];\n }\n interface RewardsInSite {\n metaSiteId?: string;\n rewards?: Reward[];\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$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 ListRewardsResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\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 * 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 * @internal\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 DomainEvent$1 extends DomainEventBodyOneOf$1 {\n createdEvent?: EntityCreatedEvent$1;\n updatedEvent?: EntityUpdatedEvent$1;\n deletedEvent?: EntityDeletedEvent$1;\n actionEvent?: ActionEvent$1;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent$1;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent$1 {\n currentEntityAsJson?: string;\n }\n interface Empty$1 {\n }\n interface QueryRewardsRequest {\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$1[];\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$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 QueryRewardsResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\n /** Details on the paged set of results returned. */\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$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 /**\n * Creates a reward that can be redeemed with loyalty points.\n *\n * When a customer [redeems a reward](/coupons/redeem-points-for-coupon), 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](/coupons/redeem-points-for-coupon) with points.\n * See the [Coupons API](https://dev.wix.com/api/rest/coupons) for more information about coupons. The `type` of reward\n * cannot be updated.\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 [Update Reward](/update-reward)\n * to change the status.\n *\n * To customize a reward for each [loyalty tier](/tiers), 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 [Tiers API](/tiers) for more information on tiers.\n * @param reward - Reward to create.\n * @public\n * @documentationMaturity preview\n * @requiredField reward\n * @requiredField reward.name\n */\n function createReward(reward: Reward): Promise;\n /**\n * Creates multiple rewards.\n * This API will return Reward with deprecated fields for backward compatibility\n * Base tier is taken either from deprecated fields, or config (if deprecated fields are not passed)\n * @param rewards - Rewards to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField rewards\n * @requiredField rewards.name\n */\n function bulkCreateRewards(rewards: Reward[]): Promise;\n /**\n * Retrieves a reward.\n * @param _id - ID of the reward to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function getReward(_id: string): Promise;\n /**\n * Retrieves rewards for multiple metasites.\n * This API will return Reward with deprecated fields for backward compatibility\n * @internal\n * @documentationMaturity preview\n */\n function bulkGetRewards(options?: BulkGetRewardsOptions): Promise;\n interface BulkGetRewardsOptions {\n metaSiteIds?: string[];\n }\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 * @documentationMaturity preview\n * @requiredField _id\n * @requiredField reward\n * @requiredField reward.name\n * @requiredField reward.revision\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 /** @internal */\n coupon?: Coupon;\n /**\n * Reward ID.\n * @readonly\n */\n _id?: string | null;\n /** Reward name. */\n name?: string;\n /**\n * Amount of points required to receive the reward.\n * @internal\n */\n requiredPoints?: number;\n /**\n * Whether the reward is active.\n *\n * Default: `\"false\"`\n */\n active?: boolean;\n /**\n * Reward type.\n *\n * + `\"DISCOUNT_AMOUNT\"`: Discount reward. Only available for Wix Restaurants. [Learn more about discounts.](https://support.wix.com/en/article/wix-restaurants-creating-discounts-for-your-customers)\n * + `\"COUPON_REWARD\"`: Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards)\n * + `\"COUPON\"`: **Deprecated.** Use `\"COUPON_REWARD\"` instead.\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 * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function deleteReward(_id: string, options?: DeleteRewardOptions): Promise;\n interface DeleteRewardOptions {\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 /**\n * Retrieves a list of rewards.\n *\n * Only rewards with `\"active\"` set to `\"true\"` will be retrieved. The list includes rewards that are currently\n * unredeemable due to insufficient points held by any customers.\n * @public\n * @documentationMaturity preview\n */\n function listRewards(options?: ListRewardsOptions): Promise;\n interface ListRewardsOptions {\n /** Pagination options. */\n cursorPaging?: CursorPaging$1;\n }\n /**\n * Query Rewards using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n */\n function queryRewards(query: CursorQuery): Promise;\n \n type loyaltyV1Reward_universal_d_Reward = Reward;\n type loyaltyV1Reward_universal_d_RewardTypeDetailsOneOf = RewardTypeDetailsOneOf;\n type loyaltyV1Reward_universal_d_RewardType = RewardType;\n const loyaltyV1Reward_universal_d_RewardType: typeof RewardType;\n type loyaltyV1Reward_universal_d_DiscountAmount = DiscountAmount;\n type loyaltyV1Reward_universal_d_DiscountAmountConfig = DiscountAmountConfig;\n type loyaltyV1Reward_universal_d_CouponReward = CouponReward;\n type loyaltyV1Reward_universal_d_CouponRewardDiscountTypeOneOf = CouponRewardDiscountTypeOneOf;\n type loyaltyV1Reward_universal_d_CouponRewardScopeOrMinSubtotalOneOf = CouponRewardScopeOrMinSubtotalOneOf;\n type loyaltyV1Reward_universal_d_FixedAmountDiscount = FixedAmountDiscount;\n type loyaltyV1Reward_universal_d_FixedAmountDiscountConfig = FixedAmountDiscountConfig;\n type loyaltyV1Reward_universal_d_PercentageDiscount = PercentageDiscount;\n type loyaltyV1Reward_universal_d_PercentageDiscountConfig = PercentageDiscountConfig;\n type loyaltyV1Reward_universal_d_FreeShippingDiscount = FreeShippingDiscount;\n type loyaltyV1Reward_universal_d_FreeShippingDiscountConfig = FreeShippingDiscountConfig;\n type loyaltyV1Reward_universal_d_CouponScope = CouponScope;\n type loyaltyV1Reward_universal_d_Group = Group;\n type loyaltyV1Reward_universal_d_Coupon = Coupon;\n type loyaltyV1Reward_universal_d_CouponConfig = CouponConfig;\n type loyaltyV1Reward_universal_d_RewardDisabled = RewardDisabled;\n type loyaltyV1Reward_universal_d_CreateRewardRequest = CreateRewardRequest;\n type loyaltyV1Reward_universal_d_CreateRewardResponse = CreateRewardResponse;\n type loyaltyV1Reward_universal_d_BulkCreateRewardsRequest = BulkCreateRewardsRequest;\n type loyaltyV1Reward_universal_d_BulkCreateRewardsResponse = BulkCreateRewardsResponse;\n type loyaltyV1Reward_universal_d_BulkRewardResult = BulkRewardResult;\n type loyaltyV1Reward_universal_d_ItemMetadata = ItemMetadata;\n type loyaltyV1Reward_universal_d_ApplicationError = ApplicationError;\n type loyaltyV1Reward_universal_d_BulkActionMetadata = BulkActionMetadata;\n type loyaltyV1Reward_universal_d_GetRewardRequest = GetRewardRequest;\n type loyaltyV1Reward_universal_d_GetRewardResponse = GetRewardResponse;\n type loyaltyV1Reward_universal_d_BulkGetRewardsRequest = BulkGetRewardsRequest;\n type loyaltyV1Reward_universal_d_BulkGetRewardsResponse = BulkGetRewardsResponse;\n type loyaltyV1Reward_universal_d_RewardsInSite = RewardsInSite;\n type loyaltyV1Reward_universal_d_UpdateRewardRequest = UpdateRewardRequest;\n type loyaltyV1Reward_universal_d_UpdateRewardResponse = UpdateRewardResponse;\n type loyaltyV1Reward_universal_d_DeleteRewardRequest = DeleteRewardRequest;\n type loyaltyV1Reward_universal_d_DeleteRewardResponse = DeleteRewardResponse;\n type loyaltyV1Reward_universal_d_ListRewardsRequest = ListRewardsRequest;\n type loyaltyV1Reward_universal_d_ListRewardsResponse = ListRewardsResponse;\n type loyaltyV1Reward_universal_d_QueryRewardsRequest = QueryRewardsRequest;\n type loyaltyV1Reward_universal_d_CursorQuery = CursorQuery;\n type loyaltyV1Reward_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type loyaltyV1Reward_universal_d_QueryRewardsResponse = QueryRewardsResponse;\n type loyaltyV1Reward_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n const loyaltyV1Reward_universal_d_createReward: typeof createReward;\n const loyaltyV1Reward_universal_d_bulkCreateRewards: typeof bulkCreateRewards;\n const loyaltyV1Reward_universal_d_getReward: typeof getReward;\n const loyaltyV1Reward_universal_d_bulkGetRewards: typeof bulkGetRewards;\n type loyaltyV1Reward_universal_d_BulkGetRewardsOptions = BulkGetRewardsOptions;\n const loyaltyV1Reward_universal_d_updateReward: typeof updateReward;\n type loyaltyV1Reward_universal_d_UpdateReward = UpdateReward;\n const loyaltyV1Reward_universal_d_deleteReward: typeof deleteReward;\n type loyaltyV1Reward_universal_d_DeleteRewardOptions = DeleteRewardOptions;\n const loyaltyV1Reward_universal_d_listRewards: typeof listRewards;\n type loyaltyV1Reward_universal_d_ListRewardsOptions = ListRewardsOptions;\n const loyaltyV1Reward_universal_d_queryRewards: typeof queryRewards;\n namespace loyaltyV1Reward_universal_d {\n export {\n __debug$1 as __debug,\n loyaltyV1Reward_universal_d_Reward as Reward,\n loyaltyV1Reward_universal_d_RewardTypeDetailsOneOf as RewardTypeDetailsOneOf,\n loyaltyV1Reward_universal_d_RewardType as RewardType,\n loyaltyV1Reward_universal_d_DiscountAmount as DiscountAmount,\n loyaltyV1Reward_universal_d_DiscountAmountConfig as DiscountAmountConfig,\n loyaltyV1Reward_universal_d_CouponReward as CouponReward,\n loyaltyV1Reward_universal_d_CouponRewardDiscountTypeOneOf as CouponRewardDiscountTypeOneOf,\n loyaltyV1Reward_universal_d_CouponRewardScopeOrMinSubtotalOneOf as CouponRewardScopeOrMinSubtotalOneOf,\n loyaltyV1Reward_universal_d_FixedAmountDiscount as FixedAmountDiscount,\n loyaltyV1Reward_universal_d_FixedAmountDiscountConfig as FixedAmountDiscountConfig,\n loyaltyV1Reward_universal_d_PercentageDiscount as PercentageDiscount,\n loyaltyV1Reward_universal_d_PercentageDiscountConfig as PercentageDiscountConfig,\n loyaltyV1Reward_universal_d_FreeShippingDiscount as FreeShippingDiscount,\n loyaltyV1Reward_universal_d_FreeShippingDiscountConfig as FreeShippingDiscountConfig,\n loyaltyV1Reward_universal_d_CouponScope as CouponScope,\n loyaltyV1Reward_universal_d_Group as Group,\n loyaltyV1Reward_universal_d_Coupon as Coupon,\n loyaltyV1Reward_universal_d_CouponConfig as CouponConfig,\n loyaltyV1Reward_universal_d_RewardDisabled as RewardDisabled,\n loyaltyV1Reward_universal_d_CreateRewardRequest as CreateRewardRequest,\n loyaltyV1Reward_universal_d_CreateRewardResponse as CreateRewardResponse,\n loyaltyV1Reward_universal_d_BulkCreateRewardsRequest as BulkCreateRewardsRequest,\n loyaltyV1Reward_universal_d_BulkCreateRewardsResponse as BulkCreateRewardsResponse,\n loyaltyV1Reward_universal_d_BulkRewardResult as BulkRewardResult,\n loyaltyV1Reward_universal_d_ItemMetadata as ItemMetadata,\n loyaltyV1Reward_universal_d_ApplicationError as ApplicationError,\n loyaltyV1Reward_universal_d_BulkActionMetadata as BulkActionMetadata,\n loyaltyV1Reward_universal_d_GetRewardRequest as GetRewardRequest,\n loyaltyV1Reward_universal_d_GetRewardResponse as GetRewardResponse,\n loyaltyV1Reward_universal_d_BulkGetRewardsRequest as BulkGetRewardsRequest,\n loyaltyV1Reward_universal_d_BulkGetRewardsResponse as BulkGetRewardsResponse,\n loyaltyV1Reward_universal_d_RewardsInSite as RewardsInSite,\n loyaltyV1Reward_universal_d_UpdateRewardRequest as UpdateRewardRequest,\n loyaltyV1Reward_universal_d_UpdateRewardResponse as UpdateRewardResponse,\n loyaltyV1Reward_universal_d_DeleteRewardRequest as DeleteRewardRequest,\n loyaltyV1Reward_universal_d_DeleteRewardResponse as DeleteRewardResponse,\n loyaltyV1Reward_universal_d_ListRewardsRequest as ListRewardsRequest,\n CursorPaging$1 as CursorPaging,\n loyaltyV1Reward_universal_d_ListRewardsResponse as ListRewardsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n ExtendedFieldsUpdatedEvent$1 as ExtendedFieldsUpdatedEvent,\n Empty$1 as Empty,\n loyaltyV1Reward_universal_d_QueryRewardsRequest as QueryRewardsRequest,\n loyaltyV1Reward_universal_d_CursorQuery as CursorQuery,\n loyaltyV1Reward_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n loyaltyV1Reward_universal_d_QueryRewardsResponse as QueryRewardsResponse,\n loyaltyV1Reward_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n loyaltyV1Reward_universal_d_createReward as createReward,\n loyaltyV1Reward_universal_d_bulkCreateRewards as bulkCreateRewards,\n loyaltyV1Reward_universal_d_getReward as getReward,\n loyaltyV1Reward_universal_d_bulkGetRewards as bulkGetRewards,\n loyaltyV1Reward_universal_d_BulkGetRewardsOptions as BulkGetRewardsOptions,\n loyaltyV1Reward_universal_d_updateReward as updateReward,\n loyaltyV1Reward_universal_d_UpdateReward as UpdateReward,\n loyaltyV1Reward_universal_d_deleteReward as deleteReward,\n loyaltyV1Reward_universal_d_DeleteRewardOptions as DeleteRewardOptions,\n loyaltyV1Reward_universal_d_listRewards as listRewards,\n loyaltyV1Reward_universal_d_ListRewardsOptions as ListRewardsOptions,\n loyaltyV1Reward_universal_d_queryRewards as queryRewards,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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/api/rest/wix-loyalty-program/accounts) 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 */\n memberIdDeprecated?: 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 */\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;\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 *\n * Max: 20 characters\n * @readonly\n */\n code?: string;\n /**\n * Name of coupon.\n *\n * Max: 80 characters\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 loyalty coupon is 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 (item or collection), if null Coupon is used for all items */\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 * 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 {\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/api/rest/wix-loyalty-program/rewards) to redeem. */\n rewardId: string;\n /** ID of the [loyalty account](https://dev.wix.com/api/rest/wix-loyalty-program/accounts) 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/api/rest/wix-loyalty-program/rewards) to redeem. */\n rewardId: string;\n }\n interface RedeemCurrentMemberPointsForCouponResponse {\n /** Created loyalty coupon. */\n coupon?: LoyaltyCoupon;\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 /** 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;\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 /** 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 /** 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 QueryLoyaltyCouponResponse {\n /** Retrieved loyalty coupons. */\n loyaltyCoupons?: LoyaltyCoupon[];\n /** Metadata. */\n metadata?: 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 * 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 * @internal\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 QueryCouponTemplateRequest {\n /** WQL expression */\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 extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\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/api/rest/wix-loyalty-program/rewards/list-rewards).\n * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/api/rest/wix-loyalty-program/rewards) to redeem.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.loyaltyAccountId\n * @requiredField rewardId\n */\n function redeemPointsForCoupon(rewardId: string, options: RedeemPointsForCouponOptions): Promise;\n interface RedeemPointsForCouponOptions {\n /** ID of the [loyalty account](https://dev.wix.com/api/rest/wix-loyalty-program/accounts) 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/api/rest/wix-loyalty-program/rewards/list-rewards).\n * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/api/rest/wix-loyalty-program/rewards) to redeem.\n * @public\n * @documentationMaturity preview\n * @requiredField rewardId\n */\n function redeemCurrentMemberPointsForCoupon(rewardId: string): Promise;\n /**\n * Retrieves a loyalty coupon.\n * @param loyaltyCouponId - ID of the loyalty coupon to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField loyaltyCouponId\n */\n function getLoyaltyCoupon(loyaltyCouponId: string): Promise;\n /**\n * Retrieves the loyalty coupons for the currently logged-in member.\n * @public\n * @documentationMaturity preview\n */\n function getCurrentMemberCoupons(): Promise;\n /**\n * Query LoyaltyCoupons using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @param query - WQL expression\n * @public\n * @documentationMaturity preview\n * @requiredField query\n */\n function queryLoyaltyCoupon(query: QueryV2): Promise;\n /** @param query - WQL expression\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n */\n function queryCouponTemplate(query: Query): Promise;\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 * @documentationMaturity preview\n * @requiredField _id\n * @requiredField revision\n */\n function deleteLoyaltyCoupon(_id: string, revision: string): Promise;\n \n const loyaltyV1Coupon_universal_d___debug: typeof __debug;\n type loyaltyV1Coupon_universal_d_LoyaltyCoupon = LoyaltyCoupon;\n type loyaltyV1Coupon_universal_d_CouponReference = CouponReference;\n type loyaltyV1Coupon_universal_d_Specification = Specification;\n type loyaltyV1Coupon_universal_d_SpecificationTypeDetailsOneOf = SpecificationTypeDetailsOneOf;\n type loyaltyV1Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf = SpecificationScopeOrMinSubtotalOneOf;\n type loyaltyV1Coupon_universal_d_Type = Type;\n const loyaltyV1Coupon_universal_d_Type: typeof Type;\n type loyaltyV1Coupon_universal_d_BuyXGetY = BuyXGetY;\n type loyaltyV1Coupon_universal_d_Scope = Scope;\n type loyaltyV1Coupon_universal_d_Status = Status;\n const loyaltyV1Coupon_universal_d_Status: typeof Status;\n type loyaltyV1Coupon_universal_d_RedeemPointsForCouponRequest = RedeemPointsForCouponRequest;\n type loyaltyV1Coupon_universal_d_RedeemPointsForCouponResponse = RedeemPointsForCouponResponse;\n type loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponRequest = RedeemCurrentMemberPointsForCouponRequest;\n type loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponResponse = RedeemCurrentMemberPointsForCouponResponse;\n type loyaltyV1Coupon_universal_d_GetLoyaltyCouponRequest = GetLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_GetLoyaltyCouponResponse = GetLoyaltyCouponResponse;\n type loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsRequest = GetCurrentMemberCouponsRequest;\n type loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsResponse = GetCurrentMemberCouponsResponse;\n type loyaltyV1Coupon_universal_d_QueryLoyaltyCouponRequest = QueryLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_QueryV2 = QueryV2;\n type loyaltyV1Coupon_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type loyaltyV1Coupon_universal_d_Sorting = Sorting;\n type loyaltyV1Coupon_universal_d_SortOrder = SortOrder;\n const loyaltyV1Coupon_universal_d_SortOrder: typeof SortOrder;\n type loyaltyV1Coupon_universal_d_Paging = Paging;\n type loyaltyV1Coupon_universal_d_CursorPaging = CursorPaging;\n type loyaltyV1Coupon_universal_d_QueryLoyaltyCouponResponse = QueryLoyaltyCouponResponse;\n type loyaltyV1Coupon_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type loyaltyV1Coupon_universal_d_Cursors = Cursors;\n type loyaltyV1Coupon_universal_d_QueryCouponTemplateRequest = QueryCouponTemplateRequest;\n type loyaltyV1Coupon_universal_d_Query = Query;\n type loyaltyV1Coupon_universal_d_V2Paging = V2Paging;\n type loyaltyV1Coupon_universal_d_QueryCouponTemplateResponse = QueryCouponTemplateResponse;\n type loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponRequest = DeleteLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponResponse = DeleteLoyaltyCouponResponse;\n type loyaltyV1Coupon_universal_d_DomainEvent = DomainEvent;\n type loyaltyV1Coupon_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type loyaltyV1Coupon_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type loyaltyV1Coupon_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type loyaltyV1Coupon_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type loyaltyV1Coupon_universal_d_ActionEvent = ActionEvent;\n type loyaltyV1Coupon_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type loyaltyV1Coupon_universal_d_Empty = Empty;\n const loyaltyV1Coupon_universal_d_redeemPointsForCoupon: typeof redeemPointsForCoupon;\n type loyaltyV1Coupon_universal_d_RedeemPointsForCouponOptions = RedeemPointsForCouponOptions;\n const loyaltyV1Coupon_universal_d_redeemCurrentMemberPointsForCoupon: typeof redeemCurrentMemberPointsForCoupon;\n const loyaltyV1Coupon_universal_d_getLoyaltyCoupon: typeof getLoyaltyCoupon;\n const loyaltyV1Coupon_universal_d_getCurrentMemberCoupons: typeof getCurrentMemberCoupons;\n const loyaltyV1Coupon_universal_d_queryLoyaltyCoupon: typeof queryLoyaltyCoupon;\n const loyaltyV1Coupon_universal_d_queryCouponTemplate: typeof queryCouponTemplate;\n const loyaltyV1Coupon_universal_d_deleteLoyaltyCoupon: typeof deleteLoyaltyCoupon;\n namespace loyaltyV1Coupon_universal_d {\n export {\n loyaltyV1Coupon_universal_d___debug as __debug,\n loyaltyV1Coupon_universal_d_LoyaltyCoupon as LoyaltyCoupon,\n loyaltyV1Coupon_universal_d_CouponReference as CouponReference,\n loyaltyV1Coupon_universal_d_Specification as Specification,\n loyaltyV1Coupon_universal_d_SpecificationTypeDetailsOneOf as SpecificationTypeDetailsOneOf,\n loyaltyV1Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf as SpecificationScopeOrMinSubtotalOneOf,\n loyaltyV1Coupon_universal_d_Type as Type,\n loyaltyV1Coupon_universal_d_BuyXGetY as BuyXGetY,\n loyaltyV1Coupon_universal_d_Scope as Scope,\n loyaltyV1Coupon_universal_d_Status as Status,\n loyaltyV1Coupon_universal_d_RedeemPointsForCouponRequest as RedeemPointsForCouponRequest,\n loyaltyV1Coupon_universal_d_RedeemPointsForCouponResponse as RedeemPointsForCouponResponse,\n loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponRequest as RedeemCurrentMemberPointsForCouponRequest,\n loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponResponse as RedeemCurrentMemberPointsForCouponResponse,\n loyaltyV1Coupon_universal_d_GetLoyaltyCouponRequest as GetLoyaltyCouponRequest,\n loyaltyV1Coupon_universal_d_GetLoyaltyCouponResponse as GetLoyaltyCouponResponse,\n loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsRequest as GetCurrentMemberCouponsRequest,\n loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsResponse as GetCurrentMemberCouponsResponse,\n loyaltyV1Coupon_universal_d_QueryLoyaltyCouponRequest as QueryLoyaltyCouponRequest,\n loyaltyV1Coupon_universal_d_QueryV2 as QueryV2,\n loyaltyV1Coupon_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n loyaltyV1Coupon_universal_d_Sorting as Sorting,\n loyaltyV1Coupon_universal_d_SortOrder as SortOrder,\n loyaltyV1Coupon_universal_d_Paging as Paging,\n loyaltyV1Coupon_universal_d_CursorPaging as CursorPaging,\n loyaltyV1Coupon_universal_d_QueryLoyaltyCouponResponse as QueryLoyaltyCouponResponse,\n loyaltyV1Coupon_universal_d_PagingMetadataV2 as PagingMetadataV2,\n loyaltyV1Coupon_universal_d_Cursors as Cursors,\n loyaltyV1Coupon_universal_d_QueryCouponTemplateRequest as QueryCouponTemplateRequest,\n loyaltyV1Coupon_universal_d_Query as Query,\n loyaltyV1Coupon_universal_d_V2Paging as V2Paging,\n loyaltyV1Coupon_universal_d_QueryCouponTemplateResponse as QueryCouponTemplateResponse,\n loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponRequest as DeleteLoyaltyCouponRequest,\n loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponResponse as DeleteLoyaltyCouponResponse,\n loyaltyV1Coupon_universal_d_DomainEvent as DomainEvent,\n loyaltyV1Coupon_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n loyaltyV1Coupon_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n loyaltyV1Coupon_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n loyaltyV1Coupon_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n loyaltyV1Coupon_universal_d_ActionEvent as ActionEvent,\n loyaltyV1Coupon_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n loyaltyV1Coupon_universal_d_Empty as Empty,\n loyaltyV1Coupon_universal_d_redeemPointsForCoupon as redeemPointsForCoupon,\n loyaltyV1Coupon_universal_d_RedeemPointsForCouponOptions as RedeemPointsForCouponOptions,\n loyaltyV1Coupon_universal_d_redeemCurrentMemberPointsForCoupon as redeemCurrentMemberPointsForCoupon,\n loyaltyV1Coupon_universal_d_getLoyaltyCoupon as getLoyaltyCoupon,\n loyaltyV1Coupon_universal_d_getCurrentMemberCoupons as getCurrentMemberCoupons,\n loyaltyV1Coupon_universal_d_queryLoyaltyCoupon as queryLoyaltyCoupon,\n loyaltyV1Coupon_universal_d_queryCouponTemplate as queryCouponTemplate,\n loyaltyV1Coupon_universal_d_deleteLoyaltyCoupon as deleteLoyaltyCoupon,\n };\n }\n \n export { loyaltyV1Account_universal_d as account, loyaltyV1Coupon_universal_d as coupon, loyaltyV1Program_universal_d as program, loyaltyV1Reward_universal_d as reward, loyaltyV1Tier_universal_d as tier };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-metro-backend.d.ts", "content": "declare module \"wix-metro-backend\" {\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 /** Physical address */\n interface Address extends AddressStreetOneOf {\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: 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 Variant {\n name?: string;\n value?: string;\n image?: string;\n }\n interface MyAddress {\n country?: string | null;\n subdivision?: string | null;\n city?: string | null;\n postalCode?: string | null;\n streetAddress?: StreetAddress;\n /** @internal */\n formatted?: string | null;\n }\n interface CreateProductRequest {\n product?: Product;\n }\n interface CreateProductResponse {\n product?: Product;\n }\n interface DeleteProductRequest {\n productId: string;\n }\n interface DeleteProductResponse {\n }\n interface UpdateProductRequest {\n productId: string;\n product?: Product;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateProductResponse {\n product?: Product;\n }\n interface GetProductRequest {\n productId: string;\n }\n interface GetProductResponse {\n product?: Product;\n }\n interface GetProductsStartWithRequest {\n title: string;\n addressLine2?: string | null;\n }\n interface GetProductsStartWithResponse {\n products?: Product[];\n }\n interface QueryProductsRequest {\n query?: QueryV2;\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 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryProductsResponse {\n products?: Product[];\n metadata?: 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 * 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 * @internal\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 BulkCreateProductsRequest {\n products: Product[];\n /** set to `true` if you wish to receive back the created products in the response */\n returnEntity?: boolean;\n }\n interface BulkCreateProductsResponse {\n results?: BulkProductResult[];\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 BulkProductResult {\n /** Defined in wix.commons */\n itemMetadata?: ItemMetadata;\n /** Only exists if `returnEntity` was set to true in the request */\n item?: Product;\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 BulkUpdateProductsRequest {\n products: MaskedProduct[];\n /** set to `true` if you wish to receive back the updated products in the response */\n returnEntity?: boolean;\n }\n interface MaskedProduct {\n /** Product to be updated, may be partial */\n product?: Product;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateProductsResponse {\n results?: BulkUpdateProductsResponseBulkProductResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkUpdateProductsResponseBulkProductResult {\n itemMetadata?: ItemMetadata;\n /** Only exists if `returnEntity` was set to true in the request */\n item?: Product;\n }\n interface BulkDeleteProductsRequest {\n productIds: string[];\n }\n interface BulkDeleteProductsResponse {\n results?: BulkDeleteProductsResponseBulkProductResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkDeleteProductsResponseBulkProductResult {\n itemMetadata?: ItemMetadata;\n }\n interface ResetProductsDbRequest {\n }\n interface ResetProductsDbResponse {\n }\n interface Product {\n _id: string;\n name: string | null;\n collectionId: string;\n _createdDate: Date | null;\n modifiedDate: Date | null;\n image: string;\n address: Address;\n document: string;\n video: string;\n pageLink: PageLink;\n audio: string;\n color: string | null;\n localDate: string | null;\n localTime: string | null;\n localDateTime: string | null;\n variants: Variant[];\n mainVariant: Variant;\n customAddress: MyAddress;\n guid: string;\n }\n /**\n * Creating a product\n * @public\n * @documentationMaturity preview\n * @requiredField options.product.title\n * @adminMethod\n */\n function createProduct(options?: CreateProductOptions): Promise;\n interface CreateProductOptions {\n product?: Product;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField productId\n * @adminMethod\n */\n function deleteProduct(productId: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField options.product._id\n * @requiredField productId\n * @adminMethod\n */\n function updateProduct(productId: string, options?: UpdateProductOptions): Promise;\n interface UpdateProductOptions {\n product?: Product;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * override description\n * @public\n * @documentationMaturity preview\n * @requiredField productId\n * @param arg1 - ## new override param 1\n * @adminMethod\n * @returns ## override return\n */\n function getProduct(productId: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField title\n * @adminMethod\n */\n function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise;\n interface GetProductsStartWithOptions {\n addressLine2?: string | null;\n }\n /** @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryProducts(options?: QueryProductsOptions): ProductsQueryBuilder;\n interface QueryProductsOptions {\n /** Whether variants should be included in the response. */\n includeVariants?: boolean | undefined;\n /** Whether hidden products should be included in the response. Requires permissions to manage products. */\n includeHiddenProducts?: boolean | undefined;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProductsQueryResult extends QueryCursorResult {\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 * @documentationMaturity preview\n */\n eq: (propertyName: 'title' | 'collectionId' | 'guid', value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;\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' | 'guid', value: string) => ProductsQueryBuilder;\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: 'title' | 'guid', value: any[]) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'title' | 'guid', value: boolean) => ProductsQueryBuilder;\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<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;\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<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;\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) => ProductsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * create multiple products in a single request. Works synchronously\n * @public\n * @documentationMaturity preview\n * @requiredField products\n * @adminMethod\n */\n function bulkCreateProducts(products: Product[], options?: BulkCreateProductsOptions): Promise;\n interface BulkCreateProductsOptions {\n /** set to `true` if you wish to receive back the created products in the response */\n returnEntity?: boolean;\n }\n /**\n * update multiple products in a single request. Works synchronously.\n * @public\n * @documentationMaturity preview\n * @requiredField products\n * @adminMethod\n */\n function bulkUpdateProducts(products: MaskedProduct[], options?: BulkUpdateProductsOptions): Promise;\n interface BulkUpdateProductsOptions {\n /** set to `true` if you wish to receive back the updated products in the response */\n returnEntity?: boolean;\n }\n /**\n * deletes multiple products in a single request. Works synchronously.\n * @public\n * @documentationMaturity preview\n * @requiredField productIds\n * @adminMethod\n */\n function bulkDeleteProducts(productIds: string[]): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function resetProductsDb(): Promise;\n \n type metroinspectorV1Product_universal_d_FocalPoint = FocalPoint;\n type metroinspectorV1Product_universal_d_Address = Address;\n type metroinspectorV1Product_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type metroinspectorV1Product_universal_d_StreetAddress = StreetAddress;\n type metroinspectorV1Product_universal_d_AddressLocation = AddressLocation;\n type metroinspectorV1Product_universal_d_Subdivision = Subdivision;\n type metroinspectorV1Product_universal_d_SubdivisionType = SubdivisionType;\n const metroinspectorV1Product_universal_d_SubdivisionType: typeof SubdivisionType;\n type metroinspectorV1Product_universal_d_StandardDetails = StandardDetails;\n type metroinspectorV1Product_universal_d_VideoResolution = VideoResolution;\n type metroinspectorV1Product_universal_d_PageLink = PageLink;\n type metroinspectorV1Product_universal_d_LinkRel = LinkRel;\n const metroinspectorV1Product_universal_d_LinkRel: typeof LinkRel;\n type metroinspectorV1Product_universal_d_Variant = Variant;\n type metroinspectorV1Product_universal_d_MyAddress = MyAddress;\n type metroinspectorV1Product_universal_d_CreateProductRequest = CreateProductRequest;\n type metroinspectorV1Product_universal_d_CreateProductResponse = CreateProductResponse;\n type metroinspectorV1Product_universal_d_DeleteProductRequest = DeleteProductRequest;\n type metroinspectorV1Product_universal_d_DeleteProductResponse = DeleteProductResponse;\n type metroinspectorV1Product_universal_d_UpdateProductRequest = UpdateProductRequest;\n type metroinspectorV1Product_universal_d_UpdateProductResponse = UpdateProductResponse;\n type metroinspectorV1Product_universal_d_GetProductRequest = GetProductRequest;\n type metroinspectorV1Product_universal_d_GetProductResponse = GetProductResponse;\n type metroinspectorV1Product_universal_d_GetProductsStartWithRequest = GetProductsStartWithRequest;\n type metroinspectorV1Product_universal_d_GetProductsStartWithResponse = GetProductsStartWithResponse;\n type metroinspectorV1Product_universal_d_QueryProductsRequest = QueryProductsRequest;\n type metroinspectorV1Product_universal_d_QueryV2 = QueryV2;\n type metroinspectorV1Product_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type metroinspectorV1Product_universal_d_Sorting = Sorting;\n type metroinspectorV1Product_universal_d_SortOrder = SortOrder;\n const metroinspectorV1Product_universal_d_SortOrder: typeof SortOrder;\n type metroinspectorV1Product_universal_d_Paging = Paging;\n type metroinspectorV1Product_universal_d_CursorPaging = CursorPaging;\n type metroinspectorV1Product_universal_d_QueryProductsResponse = QueryProductsResponse;\n type metroinspectorV1Product_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type metroinspectorV1Product_universal_d_Cursors = Cursors;\n type metroinspectorV1Product_universal_d_BulkCreateProductsRequest = BulkCreateProductsRequest;\n type metroinspectorV1Product_universal_d_BulkCreateProductsResponse = BulkCreateProductsResponse;\n type metroinspectorV1Product_universal_d_ItemMetadata = ItemMetadata;\n type metroinspectorV1Product_universal_d_ApplicationError = ApplicationError;\n type metroinspectorV1Product_universal_d_BulkProductResult = BulkProductResult;\n type metroinspectorV1Product_universal_d_BulkActionMetadata = BulkActionMetadata;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsRequest = BulkUpdateProductsRequest;\n type metroinspectorV1Product_universal_d_MaskedProduct = MaskedProduct;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsResponse = BulkUpdateProductsResponse;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsResponseBulkProductResult = BulkUpdateProductsResponseBulkProductResult;\n type metroinspectorV1Product_universal_d_BulkDeleteProductsRequest = BulkDeleteProductsRequest;\n type metroinspectorV1Product_universal_d_BulkDeleteProductsResponse = BulkDeleteProductsResponse;\n type metroinspectorV1Product_universal_d_BulkDeleteProductsResponseBulkProductResult = BulkDeleteProductsResponseBulkProductResult;\n type metroinspectorV1Product_universal_d_ResetProductsDbRequest = ResetProductsDbRequest;\n type metroinspectorV1Product_universal_d_ResetProductsDbResponse = ResetProductsDbResponse;\n type metroinspectorV1Product_universal_d_Product = Product;\n const metroinspectorV1Product_universal_d_createProduct: typeof createProduct;\n type metroinspectorV1Product_universal_d_CreateProductOptions = CreateProductOptions;\n const metroinspectorV1Product_universal_d_deleteProduct: typeof deleteProduct;\n const metroinspectorV1Product_universal_d_updateProduct: typeof updateProduct;\n type metroinspectorV1Product_universal_d_UpdateProductOptions = UpdateProductOptions;\n const metroinspectorV1Product_universal_d_getProduct: typeof getProduct;\n const metroinspectorV1Product_universal_d_getProductsStartWith: typeof getProductsStartWith;\n type metroinspectorV1Product_universal_d_GetProductsStartWithOptions = GetProductsStartWithOptions;\n const metroinspectorV1Product_universal_d_queryProducts: typeof queryProducts;\n type metroinspectorV1Product_universal_d_QueryProductsOptions = QueryProductsOptions;\n type metroinspectorV1Product_universal_d_ProductsQueryResult = ProductsQueryResult;\n type metroinspectorV1Product_universal_d_ProductsQueryBuilder = ProductsQueryBuilder;\n const metroinspectorV1Product_universal_d_bulkCreateProducts: typeof bulkCreateProducts;\n type metroinspectorV1Product_universal_d_BulkCreateProductsOptions = BulkCreateProductsOptions;\n const metroinspectorV1Product_universal_d_bulkUpdateProducts: typeof bulkUpdateProducts;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsOptions = BulkUpdateProductsOptions;\n const metroinspectorV1Product_universal_d_bulkDeleteProducts: typeof bulkDeleteProducts;\n const metroinspectorV1Product_universal_d_resetProductsDb: typeof resetProductsDb;\n namespace metroinspectorV1Product_universal_d {\n export {\n metroinspectorV1Product_universal_d_FocalPoint as FocalPoint,\n metroinspectorV1Product_universal_d_Address as Address,\n metroinspectorV1Product_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n metroinspectorV1Product_universal_d_StreetAddress as StreetAddress,\n metroinspectorV1Product_universal_d_AddressLocation as AddressLocation,\n metroinspectorV1Product_universal_d_Subdivision as Subdivision,\n metroinspectorV1Product_universal_d_SubdivisionType as SubdivisionType,\n metroinspectorV1Product_universal_d_StandardDetails as StandardDetails,\n metroinspectorV1Product_universal_d_VideoResolution as VideoResolution,\n metroinspectorV1Product_universal_d_PageLink as PageLink,\n metroinspectorV1Product_universal_d_LinkRel as LinkRel,\n metroinspectorV1Product_universal_d_Variant as Variant,\n metroinspectorV1Product_universal_d_MyAddress as MyAddress,\n metroinspectorV1Product_universal_d_CreateProductRequest as CreateProductRequest,\n metroinspectorV1Product_universal_d_CreateProductResponse as CreateProductResponse,\n metroinspectorV1Product_universal_d_DeleteProductRequest as DeleteProductRequest,\n metroinspectorV1Product_universal_d_DeleteProductResponse as DeleteProductResponse,\n metroinspectorV1Product_universal_d_UpdateProductRequest as UpdateProductRequest,\n metroinspectorV1Product_universal_d_UpdateProductResponse as UpdateProductResponse,\n metroinspectorV1Product_universal_d_GetProductRequest as GetProductRequest,\n metroinspectorV1Product_universal_d_GetProductResponse as GetProductResponse,\n metroinspectorV1Product_universal_d_GetProductsStartWithRequest as GetProductsStartWithRequest,\n metroinspectorV1Product_universal_d_GetProductsStartWithResponse as GetProductsStartWithResponse,\n metroinspectorV1Product_universal_d_QueryProductsRequest as QueryProductsRequest,\n metroinspectorV1Product_universal_d_QueryV2 as QueryV2,\n metroinspectorV1Product_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n metroinspectorV1Product_universal_d_Sorting as Sorting,\n metroinspectorV1Product_universal_d_SortOrder as SortOrder,\n metroinspectorV1Product_universal_d_Paging as Paging,\n metroinspectorV1Product_universal_d_CursorPaging as CursorPaging,\n metroinspectorV1Product_universal_d_QueryProductsResponse as QueryProductsResponse,\n metroinspectorV1Product_universal_d_PagingMetadataV2 as PagingMetadataV2,\n metroinspectorV1Product_universal_d_Cursors as Cursors,\n metroinspectorV1Product_universal_d_BulkCreateProductsRequest as BulkCreateProductsRequest,\n metroinspectorV1Product_universal_d_BulkCreateProductsResponse as BulkCreateProductsResponse,\n metroinspectorV1Product_universal_d_ItemMetadata as ItemMetadata,\n metroinspectorV1Product_universal_d_ApplicationError as ApplicationError,\n metroinspectorV1Product_universal_d_BulkProductResult as BulkProductResult,\n metroinspectorV1Product_universal_d_BulkActionMetadata as BulkActionMetadata,\n metroinspectorV1Product_universal_d_BulkUpdateProductsRequest as BulkUpdateProductsRequest,\n metroinspectorV1Product_universal_d_MaskedProduct as MaskedProduct,\n metroinspectorV1Product_universal_d_BulkUpdateProductsResponse as BulkUpdateProductsResponse,\n metroinspectorV1Product_universal_d_BulkUpdateProductsResponseBulkProductResult as BulkUpdateProductsResponseBulkProductResult,\n metroinspectorV1Product_universal_d_BulkDeleteProductsRequest as BulkDeleteProductsRequest,\n metroinspectorV1Product_universal_d_BulkDeleteProductsResponse as BulkDeleteProductsResponse,\n metroinspectorV1Product_universal_d_BulkDeleteProductsResponseBulkProductResult as BulkDeleteProductsResponseBulkProductResult,\n metroinspectorV1Product_universal_d_ResetProductsDbRequest as ResetProductsDbRequest,\n metroinspectorV1Product_universal_d_ResetProductsDbResponse as ResetProductsDbResponse,\n metroinspectorV1Product_universal_d_Product as Product,\n metroinspectorV1Product_universal_d_createProduct as createProduct,\n metroinspectorV1Product_universal_d_CreateProductOptions as CreateProductOptions,\n metroinspectorV1Product_universal_d_deleteProduct as deleteProduct,\n metroinspectorV1Product_universal_d_updateProduct as updateProduct,\n metroinspectorV1Product_universal_d_UpdateProductOptions as UpdateProductOptions,\n metroinspectorV1Product_universal_d_getProduct as getProduct,\n metroinspectorV1Product_universal_d_getProductsStartWith as getProductsStartWith,\n metroinspectorV1Product_universal_d_GetProductsStartWithOptions as GetProductsStartWithOptions,\n metroinspectorV1Product_universal_d_queryProducts as queryProducts,\n metroinspectorV1Product_universal_d_QueryProductsOptions as QueryProductsOptions,\n metroinspectorV1Product_universal_d_ProductsQueryResult as ProductsQueryResult,\n metroinspectorV1Product_universal_d_ProductsQueryBuilder as ProductsQueryBuilder,\n metroinspectorV1Product_universal_d_bulkCreateProducts as bulkCreateProducts,\n metroinspectorV1Product_universal_d_BulkCreateProductsOptions as BulkCreateProductsOptions,\n metroinspectorV1Product_universal_d_bulkUpdateProducts as bulkUpdateProducts,\n metroinspectorV1Product_universal_d_BulkUpdateProductsOptions as BulkUpdateProductsOptions,\n metroinspectorV1Product_universal_d_bulkDeleteProducts as bulkDeleteProducts,\n metroinspectorV1Product_universal_d_resetProductsDb as resetProductsDb,\n };\n }\n \n export { metroinspectorV1Product_universal_d as products };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-online-programs-backend.d.ts", "content": "declare module \"wix-online-programs-backend\" {\n interface Program {\n /** @readonly */\n _id?: string | null;\n /** program settings that can be updated by */\n settings?: ProgramsSettings;\n /**\n * current program state\n * @readonly\n */\n state?: StateTransition$1;\n /**\n * sections/steps general info\n * @readonly\n */\n contentSummary?: ContentSummary;\n /**\n * participant stats\n * @readonly\n */\n participationStats?: ParticipationStats;\n /**\n * msid where the program was created\n * @readonly\n */\n msid?: string;\n /** @readonly */\n categoryIds?: string[];\n /**\n * identity of the program creator\n * @readonly\n */\n createdBy?: PersonIdentity$1;\n /**\n * part of the EXTENDED fieldset -> info about the current person participation in the program.\n * @readonly\n */\n participation?: Participation;\n }\n interface ProgramsSettings {\n /** timeline type -> Self-paced, time-restricted. */\n timeline?: Timeline;\n /** general program info */\n description?: ObjectDescription$1;\n /** participant limitation, step-completion pace and etc. */\n restrictions?: ProgramRestrictions;\n /** single-payment price. */\n pricing?: Money;\n /** seo settings */\n seo?: Seo;\n rewards?: Reward[];\n /** connected social group. */\n socialGroupId?: string | null;\n }\n interface Timeline extends TimelineTimelineOptionsOneOf {\n /** an endless program, owner adds steps \"on the fly\" */\n ongoing?: Ongoing;\n /** program duration is fixed, every participant has its own start-date. */\n flexible?: Flexible;\n /** program duration is fixed, all participants share the same time range. */\n specific?: Specific;\n /** endless or fixed program where steps are not limited by time. */\n selfPaced?: SelfPaced;\n }\n /** @oneof */\n interface TimelineTimelineOptionsOneOf {\n /** an endless program, owner adds steps \"on the fly\" */\n ongoing?: Ongoing;\n /** program duration is fixed, every participant has its own start-date. */\n flexible?: Flexible;\n /** program duration is fixed, all participants share the same time range. */\n specific?: Specific;\n /** endless or fixed program where steps are not limited by time. */\n selfPaced?: SelfPaced;\n }\n /** Time duration */\n interface TimeDuration$1 {\n /** DAYS or WEEKS */\n unit?: DurationUnit$1;\n /** number of unit */\n value?: number;\n }\n enum DurationUnit$1 {\n DAYS = \"DAYS\",\n WEEKS = \"WEEKS\"\n }\n interface Ongoing {\n /** specific date chosen by owner to start the program */\n startDate?: string;\n }\n interface Flexible {\n /** duration of the program */\n duration?: TimeDuration$1;\n }\n interface Specific {\n /** everyone starts on this day */\n startDate?: string;\n /** program duration */\n duration?: TimeDuration$1;\n }\n interface SelfPaced {\n /** give participants time duration to finish. */\n duration?: TimeDuration$1;\n }\n interface ObjectDescription$1 {\n /** object title */\n title?: string | null;\n /** object details */\n details?: string | null;\n /** media */\n media?: MediaItem$1;\n }\n interface MediaItem$1 extends MediaItemMediaOneOf$1 {\n /** WixMedia image */\n image?: string;\n /** WixMedia video */\n video?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf$1 {\n /** WixMedia image */\n image?: string;\n /** WixMedia video */\n video?: string;\n }\n interface VideoResolution$1 {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface ProgramRestrictions {\n /** limit of active participants in the program. */\n maxParticipants?: number | null;\n /** hide steps in the Pending state. */\n hideFutureSteps?: boolean;\n /** allow participants complete steps in the certain order. */\n resolveStepsInOrder?: boolean;\n /** visibility and join access */\n accessType?: AccessType;\n /** allow program participants to share their progress in group */\n shareProgress?: boolean;\n }\n enum AccessType {\n PUBLIC = \"PUBLIC\",\n PRIVATE = \"PRIVATE\",\n SECRET = \"SECRET\"\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 Seo {\n /** challenge slug expression. */\n slug?: string;\n /** schema used by Seo team */\n seoData?: SeoSchema;\n /** program url */\n url?: string;\n /** image url from description media */\n imageUrl?: 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 tag information. */\n tags?: Tag[];\n /** SEO general settings. */\n settings?: Settings$1;\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$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[];\n }\n interface Reward {\n /** on which action rewards must be assigned. */\n trigger?: Trigger;\n /** badges participant will get on program complete */\n badgeIds?: string[];\n /** certificate for program. Currently is program GUID */\n certificate?: Certificate$2;\n }\n enum Trigger {\n /** member joins the program */\n JOINED_TO_PROGRAM = \"JOINED_TO_PROGRAM\",\n /** at least one step completed */\n STEP_COMPLETED = \"STEP_COMPLETED\",\n /** all steps are completed. */\n ALL_STEPS_COMPLETED = \"ALL_STEPS_COMPLETED\"\n }\n interface Certificate$2 {\n /** Certificate for program completion. Currently is program GUID */\n _id?: string | null;\n /** date it was connected to program */\n connectedDate?: Date;\n }\n interface StateTransition$1 {\n /** program state */\n state?: StateTransitionState;\n /** time when program changed state */\n occurredAt?: Date;\n }\n enum StateTransitionState {\n /** not published program, visible only to site owner */\n DRAFT = \"DRAFT\",\n /** program visible regarding to restrictions */\n PUBLISHED = \"PUBLISHED\",\n FINISHED = \"FINISHED\",\n ARCHIVED = \"ARCHIVED\"\n }\n interface ContentSummary {\n /** number of steps in the program */\n totalSteps?: number;\n /** number of sections in the program */\n totalSections?: number;\n }\n interface ParticipationStats {\n /** number of active and finished participants. */\n activeCount?: number;\n /** number of pending join requests */\n joinRequestCount?: number;\n /** number of invited members. */\n invitationCount?: number;\n /** number of participants waiting for the owner payment confirmation. */\n paymentWaitingCount?: number;\n /** number of participants who joined, but not started the program */\n notStartedCount?: number;\n /** number of participants who started and not finished the program */\n inProgressCount?: number;\n /** number of participants who finished the program */\n finishedCount?: number;\n }\n interface PersonIdentity$1 {\n /**\n * Wix member\n * @readonly\n */\n memberId?: string;\n /**\n * Wix contact\n * @readonly\n */\n contactId?: string;\n /**\n * Wix user\n * @readonly\n */\n wixUserId?: string | null;\n }\n interface Participation {\n participantId?: string;\n /** current participants state */\n state?: State$2;\n /** number of successfully completed program steps */\n totalCompletedSteps?: number;\n }\n interface State$2 extends StateStateOptionsOneOf$1 {\n /** participant invited to program by owner */\n invited?: Invited$1;\n /** participant requested to join to private program */\n joinRequested?: JoinRequested$1;\n /** owner rejected participant join request */\n joinRejected?: JoinRejected$1;\n /** owner requested member to pay for participation */\n paymentRequested?: PaymentRequested$1;\n /** member started payment */\n paymentStarted?: PaymentStarted$1;\n /** owner waits for manual offline payment */\n paymentStartedOffline?: PaymentStartedOffline$1;\n /** member became participant */\n joined?: Joined$1;\n /** participant left program */\n left?: Left$1;\n /** owner removed participant from program */\n removed?: Removed$1;\n /** participant completed program */\n completed?: Completed$2;\n /** participant did not finished program in timeline */\n failed?: Failed$1;\n /** program was suspended, so is participant */\n suspended?: Suspended$1;\n }\n /** @oneof */\n interface StateStateOptionsOneOf$1 {\n /** participant invited to program by owner */\n invited?: Invited$1;\n /** participant requested to join to private program */\n joinRequested?: JoinRequested$1;\n /** owner rejected participant join request */\n joinRejected?: JoinRejected$1;\n /** owner requested member to pay for participation */\n paymentRequested?: PaymentRequested$1;\n /** member started payment */\n paymentStarted?: PaymentStarted$1;\n /** owner waits for manual offline payment */\n paymentStartedOffline?: PaymentStartedOffline$1;\n /** member became participant */\n joined?: Joined$1;\n /** participant left program */\n left?: Left$1;\n /** owner removed participant from program */\n removed?: Removed$1;\n /** participant completed program */\n completed?: Completed$2;\n /** participant did not finished program in timeline */\n failed?: Failed$1;\n /** program was suspended, so is participant */\n suspended?: Suspended$1;\n }\n interface DateInterval$2 {\n /** local date start */\n start?: string;\n /** local date finish, inclusive */\n finish?: string | null;\n }\n interface Invited$1 {\n }\n interface JoinRequested$1 {\n /** Approval request regarding to V1 */\n approvalRequestId?: string;\n }\n interface JoinRejected$1 {\n }\n interface PaymentRequested$1 {\n }\n interface PaymentStarted$1 {\n }\n interface PaymentStartedOffline$1 {\n /** Offline transaction id in payments wix.payment.api.pay.v3.Transaction */\n transactionId?: string;\n }\n interface Joined$1 {\n /** TODO: change to start/end pair? */\n dateFrame?: DateInterval$2;\n }\n interface Left$1 {\n }\n interface Removed$1 {\n }\n interface Completed$2 {\n }\n interface Failed$1 {\n }\n interface Suspended$1 {\n }\n interface ListProgramsRequest {\n /** return only programs where current identity is participating. */\n participatingOnly?: boolean;\n /** sort criterion */\n sorting?: SortingCriterion$1;\n /** page (offset-based only at the moment) */\n paging?: Paging$2;\n /** at the moment EXTENDED contains Participation + Stats objects on top of STANDARD. */\n fieldSet?: FieldSet;\n }\n enum SortingCriterion$1 {\n DEFAULT = \"DEFAULT\",\n ACTIVE_FIRST = \"ACTIVE_FIRST\",\n LAST_TRANSITION = \"LAST_TRANSITION\",\n CREATION_TIME = \"CREATION_TIME\"\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 enum FieldSet {\n STANDARD = \"STANDARD\",\n EXTENDED = \"EXTENDED\"\n }\n interface ListProgramsResponse {\n /** paging metadata */\n metadata?: PagingMetadataV2$1;\n /** programs */\n programs?: Program[];\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 * 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 * @internal\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 GetProgramRequest {\n /** program to get */\n programId: string;\n /** STANDARD or EXTENDED field set */\n fieldSet?: FieldSet;\n }\n interface GetProgramResponse {\n /** found program */\n program?: Program;\n }\n interface QueryProgramsRequest {\n /** query to get programs */\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$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$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryProgramsResponse {\n /** paging metadata */\n metadata?: PagingMetadataV2$1;\n /** programs */\n programs?: Program[];\n }\n interface CreateProgramRequest extends CreateProgramRequestStrategyOneOf {\n /** to create new program from scratch */\n startFresh?: StartFresh;\n /** to clone existing program */\n duplicate?: Duplicate;\n /** to crate from existing template */\n fromTemplate?: FromTemplate;\n }\n /** @oneof */\n interface CreateProgramRequestStrategyOneOf {\n /** to create new program from scratch */\n startFresh?: StartFresh;\n /** to clone existing program */\n duplicate?: Duplicate;\n /** to crate from existing template */\n fromTemplate?: FromTemplate;\n }\n enum ValidationStrategy {\n FAIL_ON_ERRORS = \"FAIL_ON_ERRORS\",\n FIX_ERRORS = \"FIX_ERRORS\"\n }\n /** Creates new draft program by providing new settings */\n interface StartFresh {\n /** settings for new program */\n settings?: ProgramsSettings;\n }\n /** Creates new draft program by cloning existing one */\n interface Duplicate {\n /** existing owners program to duplicate */\n cloneFromId?: string;\n /** fix or fail on errors */\n validation?: ValidationStrategy;\n }\n /** Creates new draft program from existing templates */\n interface FromTemplate {\n /** existing program template */\n cloneFromId?: string;\n /** new settings to override */\n settings?: ProgramsSettings;\n }\n interface CreateProgramResponse {\n /** new program */\n program?: Program;\n }\n interface UpdateProgramSettingsRequest {\n /** program to update */\n programId: string;\n /** fields to change in program settings */\n programSettings?: ProgramsSettings;\n /** fix or fail on errors */\n validation?: ValidationStrategy;\n /**\n * inferred mask on program_settings fields\n * @internal\n */\n mask?: string[];\n }\n interface UpdateProgramSettingsResponse {\n /** updated program */\n program?: Program;\n }\n interface ProgramSettingsUpdated {\n /** updated program */\n program?: Program;\n /** settings before update */\n previousSettings?: ProgramsSettings;\n }\n interface BulkUpdateProgramSettingsRequest {\n programs?: MaskedProgramSettings[];\n /** If true - full entity will be returned. Otherwise - only id. */\n returnFullEntity?: boolean;\n }\n interface MaskedProgramSettings {\n /** program to update */\n programId?: string;\n /** program settings to update */\n programSettings?: ProgramsSettings;\n /**\n * inferred mask on program_settings fields\n * @internal\n */\n mask?: string[];\n }\n interface BulkUpdateProgramSettingsResponse {\n results?: BulkProgramSettingsResult[];\n /** 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 BulkProgramSettingsResult {\n /** A metadata. */\n itemMetadata?: ItemMetadata$1;\n /** updated program */\n program?: Program;\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 ChangeProgramStateRequest {\n /** program to change state */\n programId: string;\n /** state to which change */\n state?: StateTransitionState;\n }\n interface ChangeProgramStateResponse {\n /** program with new state */\n program?: Program;\n }\n interface ProgramStateChanged {\n /** updated program */\n program?: Program;\n }\n interface AssignCategoriesRequest {\n /** program to */\n programId: string;\n categoryIds?: string[];\n }\n interface AssignCategoriesResponse {\n /** Updated program */\n program?: Program;\n idsAdded?: string[];\n idsRemoved?: string[];\n }\n interface DeleteProgramRequest {\n /** program Id to delete */\n programId: string;\n }\n interface DeleteProgramResponse {\n /** deleted program, without PageUrl info */\n program?: Program;\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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 * List programs with paging\n * @internal\n * @documentationMaturity preview\n */\n function listPrograms(options?: ListProgramsOptions): Promise;\n interface ListProgramsOptions {\n /** return only programs where current identity is participating. */\n participatingOnly?: boolean;\n /** sort criterion */\n sorting?: SortingCriterion$1;\n /** page (offset-based only at the moment) */\n paging?: Paging$2;\n /** at the moment EXTENDED contains Participation + Stats objects on top of STANDARD. */\n fieldSet?: FieldSet;\n }\n /**\n * Find one program\n * @param programId - program to get\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @returns found program\n */\n function getProgram(programId: string, options?: GetProgramOptions): Promise;\n interface GetProgramOptions {\n /** STANDARD or EXTENDED field set */\n fieldSet?: FieldSet;\n }\n /**\n * Find programs by platformized query\n * @internal\n * @documentationMaturity preview\n * @permissionId ONLINE_PROGRAMS.PROGRAM_READ\n */\n function queryPrograms(): ProgramsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProgramsQueryResult extends QueryCursorResult {\n items: Program[];\n query: ProgramsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ProgramsQueryBuilder {\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' | 'state' | 'categoryIds', value: any) => ProgramsQueryBuilder;\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' | 'state' | 'categoryIds', value: any) => ProgramsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'state' | 'categoryIds', value: any) => ProgramsQueryBuilder;\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'>) => ProgramsQueryBuilder;\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'>) => ProgramsQueryBuilder;\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) => ProgramsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ProgramsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Creates new program in draft state by provided fresh settings, duplicate existing prog, or from template\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function createProgram(options?: CreateProgramOptions): Promise;\n interface CreateProgramOptions extends CreateProgramRequestStrategyOneOf {\n /** to create new program from scratch */\n startFresh?: StartFresh;\n /** to clone existing program */\n duplicate?: Duplicate;\n /** to crate from existing template */\n fromTemplate?: FromTemplate;\n }\n /**\n * Partial program settings update\n * @param programId - program to update\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @adminMethod\n */\n function updateProgramSettings(programId: string, options?: UpdateProgramSettingsOptions): Promise;\n interface UpdateProgramSettingsOptions {\n /** fields to change in program settings */\n programSettings?: ProgramsSettings;\n /** fix or fail on errors */\n validation?: ValidationStrategy;\n /**\n * inferred mask on program_settings fields\n * @internal\n */\n mask?: string[];\n }\n /**\n * Bulk partial settings update. Bulk version of UpdateProgramSettings\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function bulkUpdateProgramSettings(options?: BulkUpdateProgramSettingsOptions): Promise;\n interface BulkUpdateProgramSettingsOptions {\n programs?: MaskedProgramSettings[];\n /** If true - full entity will be returned. Otherwise - only id. */\n returnFullEntity?: boolean;\n }\n /**\n * Changes program state. New program has state DRAFT.\n * It could be PUBLISHED, FINISHED or ARCHIVED.\n * PUBLISHED program could be FINISHED or ARCHIVED. FINISHED -> ARCHIVED.\n * ARCHIVED program could be only deleted or duplicated (to draft state).\n * In case of any other transition, WrongTransition error will be raised.\n * @param programId - program to change state\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @adminMethod\n */\n function changeProgramState(programId: string, options?: ChangeProgramStateOptions): Promise;\n interface ChangeProgramStateOptions {\n /** state to which change */\n state?: StateTransitionState;\n }\n /**\n * Assign list of categories to the program. Provided list will replace existing one.\n * @param programId - program to\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @adminMethod\n */\n function assignCategories(programId: string, options?: AssignCategoriesOptions): Promise;\n interface AssignCategoriesOptions {\n categoryIds?: string[];\n }\n /**\n * Hard delete of existing program\n * @param programId - program Id to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @adminMethod\n */\n function deleteProgram(programId: string): Promise;\n \n type achievementsProgramsV2Program_universal_d_Program = Program;\n type achievementsProgramsV2Program_universal_d_ProgramsSettings = ProgramsSettings;\n type achievementsProgramsV2Program_universal_d_Timeline = Timeline;\n type achievementsProgramsV2Program_universal_d_TimelineTimelineOptionsOneOf = TimelineTimelineOptionsOneOf;\n type achievementsProgramsV2Program_universal_d_Ongoing = Ongoing;\n type achievementsProgramsV2Program_universal_d_Flexible = Flexible;\n type achievementsProgramsV2Program_universal_d_Specific = Specific;\n type achievementsProgramsV2Program_universal_d_SelfPaced = SelfPaced;\n type achievementsProgramsV2Program_universal_d_ProgramRestrictions = ProgramRestrictions;\n type achievementsProgramsV2Program_universal_d_AccessType = AccessType;\n const achievementsProgramsV2Program_universal_d_AccessType: typeof AccessType;\n type achievementsProgramsV2Program_universal_d_Money = Money;\n type achievementsProgramsV2Program_universal_d_Seo = Seo;\n type achievementsProgramsV2Program_universal_d_SeoSchema = SeoSchema;\n type achievementsProgramsV2Program_universal_d_Keyword = Keyword;\n type achievementsProgramsV2Program_universal_d_Tag = Tag;\n type achievementsProgramsV2Program_universal_d_Reward = Reward;\n type achievementsProgramsV2Program_universal_d_Trigger = Trigger;\n const achievementsProgramsV2Program_universal_d_Trigger: typeof Trigger;\n type achievementsProgramsV2Program_universal_d_StateTransitionState = StateTransitionState;\n const achievementsProgramsV2Program_universal_d_StateTransitionState: typeof StateTransitionState;\n type achievementsProgramsV2Program_universal_d_ContentSummary = ContentSummary;\n type achievementsProgramsV2Program_universal_d_ParticipationStats = ParticipationStats;\n type achievementsProgramsV2Program_universal_d_Participation = Participation;\n type achievementsProgramsV2Program_universal_d_ListProgramsRequest = ListProgramsRequest;\n type achievementsProgramsV2Program_universal_d_FieldSet = FieldSet;\n const achievementsProgramsV2Program_universal_d_FieldSet: typeof FieldSet;\n type achievementsProgramsV2Program_universal_d_ListProgramsResponse = ListProgramsResponse;\n type achievementsProgramsV2Program_universal_d_GetProgramRequest = GetProgramRequest;\n type achievementsProgramsV2Program_universal_d_GetProgramResponse = GetProgramResponse;\n type achievementsProgramsV2Program_universal_d_QueryProgramsRequest = QueryProgramsRequest;\n type achievementsProgramsV2Program_universal_d_Query = Query;\n type achievementsProgramsV2Program_universal_d_QueryProgramsResponse = QueryProgramsResponse;\n type achievementsProgramsV2Program_universal_d_CreateProgramRequest = CreateProgramRequest;\n type achievementsProgramsV2Program_universal_d_CreateProgramRequestStrategyOneOf = CreateProgramRequestStrategyOneOf;\n type achievementsProgramsV2Program_universal_d_ValidationStrategy = ValidationStrategy;\n const achievementsProgramsV2Program_universal_d_ValidationStrategy: typeof ValidationStrategy;\n type achievementsProgramsV2Program_universal_d_StartFresh = StartFresh;\n type achievementsProgramsV2Program_universal_d_Duplicate = Duplicate;\n type achievementsProgramsV2Program_universal_d_FromTemplate = FromTemplate;\n type achievementsProgramsV2Program_universal_d_CreateProgramResponse = CreateProgramResponse;\n type achievementsProgramsV2Program_universal_d_UpdateProgramSettingsRequest = UpdateProgramSettingsRequest;\n type achievementsProgramsV2Program_universal_d_UpdateProgramSettingsResponse = UpdateProgramSettingsResponse;\n type achievementsProgramsV2Program_universal_d_ProgramSettingsUpdated = ProgramSettingsUpdated;\n type achievementsProgramsV2Program_universal_d_BulkUpdateProgramSettingsRequest = BulkUpdateProgramSettingsRequest;\n type achievementsProgramsV2Program_universal_d_MaskedProgramSettings = MaskedProgramSettings;\n type achievementsProgramsV2Program_universal_d_BulkUpdateProgramSettingsResponse = BulkUpdateProgramSettingsResponse;\n type achievementsProgramsV2Program_universal_d_BulkProgramSettingsResult = BulkProgramSettingsResult;\n type achievementsProgramsV2Program_universal_d_ChangeProgramStateRequest = ChangeProgramStateRequest;\n type achievementsProgramsV2Program_universal_d_ChangeProgramStateResponse = ChangeProgramStateResponse;\n type achievementsProgramsV2Program_universal_d_ProgramStateChanged = ProgramStateChanged;\n type achievementsProgramsV2Program_universal_d_AssignCategoriesRequest = AssignCategoriesRequest;\n type achievementsProgramsV2Program_universal_d_AssignCategoriesResponse = AssignCategoriesResponse;\n type achievementsProgramsV2Program_universal_d_DeleteProgramRequest = DeleteProgramRequest;\n type achievementsProgramsV2Program_universal_d_DeleteProgramResponse = DeleteProgramResponse;\n const achievementsProgramsV2Program_universal_d_listPrograms: typeof listPrograms;\n type achievementsProgramsV2Program_universal_d_ListProgramsOptions = ListProgramsOptions;\n const achievementsProgramsV2Program_universal_d_getProgram: typeof getProgram;\n type achievementsProgramsV2Program_universal_d_GetProgramOptions = GetProgramOptions;\n const achievementsProgramsV2Program_universal_d_queryPrograms: typeof queryPrograms;\n type achievementsProgramsV2Program_universal_d_ProgramsQueryResult = ProgramsQueryResult;\n type achievementsProgramsV2Program_universal_d_ProgramsQueryBuilder = ProgramsQueryBuilder;\n const achievementsProgramsV2Program_universal_d_createProgram: typeof createProgram;\n type achievementsProgramsV2Program_universal_d_CreateProgramOptions = CreateProgramOptions;\n const achievementsProgramsV2Program_universal_d_updateProgramSettings: typeof updateProgramSettings;\n type achievementsProgramsV2Program_universal_d_UpdateProgramSettingsOptions = UpdateProgramSettingsOptions;\n const achievementsProgramsV2Program_universal_d_bulkUpdateProgramSettings: typeof bulkUpdateProgramSettings;\n type achievementsProgramsV2Program_universal_d_BulkUpdateProgramSettingsOptions = BulkUpdateProgramSettingsOptions;\n const achievementsProgramsV2Program_universal_d_changeProgramState: typeof changeProgramState;\n type achievementsProgramsV2Program_universal_d_ChangeProgramStateOptions = ChangeProgramStateOptions;\n const achievementsProgramsV2Program_universal_d_assignCategories: typeof assignCategories;\n type achievementsProgramsV2Program_universal_d_AssignCategoriesOptions = AssignCategoriesOptions;\n const achievementsProgramsV2Program_universal_d_deleteProgram: typeof deleteProgram;\n namespace achievementsProgramsV2Program_universal_d {\n export {\n achievementsProgramsV2Program_universal_d_Program as Program,\n achievementsProgramsV2Program_universal_d_ProgramsSettings as ProgramsSettings,\n achievementsProgramsV2Program_universal_d_Timeline as Timeline,\n achievementsProgramsV2Program_universal_d_TimelineTimelineOptionsOneOf as TimelineTimelineOptionsOneOf,\n TimeDuration$1 as TimeDuration,\n DurationUnit$1 as DurationUnit,\n achievementsProgramsV2Program_universal_d_Ongoing as Ongoing,\n achievementsProgramsV2Program_universal_d_Flexible as Flexible,\n achievementsProgramsV2Program_universal_d_Specific as Specific,\n achievementsProgramsV2Program_universal_d_SelfPaced as SelfPaced,\n ObjectDescription$1 as ObjectDescription,\n MediaItem$1 as MediaItem,\n MediaItemMediaOneOf$1 as MediaItemMediaOneOf,\n VideoResolution$1 as VideoResolution,\n achievementsProgramsV2Program_universal_d_ProgramRestrictions as ProgramRestrictions,\n achievementsProgramsV2Program_universal_d_AccessType as AccessType,\n achievementsProgramsV2Program_universal_d_Money as Money,\n achievementsProgramsV2Program_universal_d_Seo as Seo,\n achievementsProgramsV2Program_universal_d_SeoSchema as SeoSchema,\n achievementsProgramsV2Program_universal_d_Keyword as Keyword,\n achievementsProgramsV2Program_universal_d_Tag as Tag,\n Settings$1 as Settings,\n achievementsProgramsV2Program_universal_d_Reward as Reward,\n achievementsProgramsV2Program_universal_d_Trigger as Trigger,\n Certificate$2 as Certificate,\n StateTransition$1 as StateTransition,\n achievementsProgramsV2Program_universal_d_StateTransitionState as StateTransitionState,\n achievementsProgramsV2Program_universal_d_ContentSummary as ContentSummary,\n achievementsProgramsV2Program_universal_d_ParticipationStats as ParticipationStats,\n PersonIdentity$1 as PersonIdentity,\n achievementsProgramsV2Program_universal_d_Participation as Participation,\n State$2 as State,\n StateStateOptionsOneOf$1 as StateStateOptionsOneOf,\n DateInterval$2 as DateInterval,\n Invited$1 as Invited,\n JoinRequested$1 as JoinRequested,\n JoinRejected$1 as JoinRejected,\n PaymentRequested$1 as PaymentRequested,\n PaymentStarted$1 as PaymentStarted,\n PaymentStartedOffline$1 as PaymentStartedOffline,\n Joined$1 as Joined,\n Left$1 as Left,\n Removed$1 as Removed,\n Completed$2 as Completed,\n Failed$1 as Failed,\n Suspended$1 as Suspended,\n achievementsProgramsV2Program_universal_d_ListProgramsRequest as ListProgramsRequest,\n SortingCriterion$1 as SortingCriterion,\n Paging$2 as Paging,\n achievementsProgramsV2Program_universal_d_FieldSet as FieldSet,\n achievementsProgramsV2Program_universal_d_ListProgramsResponse as ListProgramsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n achievementsProgramsV2Program_universal_d_GetProgramRequest as GetProgramRequest,\n achievementsProgramsV2Program_universal_d_GetProgramResponse as GetProgramResponse,\n achievementsProgramsV2Program_universal_d_QueryProgramsRequest as QueryProgramsRequest,\n achievementsProgramsV2Program_universal_d_Query as Query,\n Sorting$2 as Sorting,\n SortOrder$1 as SortOrder,\n achievementsProgramsV2Program_universal_d_QueryProgramsResponse as QueryProgramsResponse,\n achievementsProgramsV2Program_universal_d_CreateProgramRequest as CreateProgramRequest,\n achievementsProgramsV2Program_universal_d_CreateProgramRequestStrategyOneOf as CreateProgramRequestStrategyOneOf,\n achievementsProgramsV2Program_universal_d_ValidationStrategy as ValidationStrategy,\n achievementsProgramsV2Program_universal_d_StartFresh as StartFresh,\n achievementsProgramsV2Program_universal_d_Duplicate as Duplicate,\n achievementsProgramsV2Program_universal_d_FromTemplate as FromTemplate,\n achievementsProgramsV2Program_universal_d_CreateProgramResponse as CreateProgramResponse,\n achievementsProgramsV2Program_universal_d_UpdateProgramSettingsRequest as UpdateProgramSettingsRequest,\n achievementsProgramsV2Program_universal_d_UpdateProgramSettingsResponse as UpdateProgramSettingsResponse,\n achievementsProgramsV2Program_universal_d_ProgramSettingsUpdated as ProgramSettingsUpdated,\n achievementsProgramsV2Program_universal_d_BulkUpdateProgramSettingsRequest as BulkUpdateProgramSettingsRequest,\n achievementsProgramsV2Program_universal_d_MaskedProgramSettings as MaskedProgramSettings,\n achievementsProgramsV2Program_universal_d_BulkUpdateProgramSettingsResponse as BulkUpdateProgramSettingsResponse,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n achievementsProgramsV2Program_universal_d_BulkProgramSettingsResult as BulkProgramSettingsResult,\n BulkActionMetadata$1 as BulkActionMetadata,\n achievementsProgramsV2Program_universal_d_ChangeProgramStateRequest as ChangeProgramStateRequest,\n achievementsProgramsV2Program_universal_d_ChangeProgramStateResponse as ChangeProgramStateResponse,\n achievementsProgramsV2Program_universal_d_ProgramStateChanged as ProgramStateChanged,\n achievementsProgramsV2Program_universal_d_AssignCategoriesRequest as AssignCategoriesRequest,\n achievementsProgramsV2Program_universal_d_AssignCategoriesResponse as AssignCategoriesResponse,\n achievementsProgramsV2Program_universal_d_DeleteProgramRequest as DeleteProgramRequest,\n achievementsProgramsV2Program_universal_d_DeleteProgramResponse as DeleteProgramResponse,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n achievementsProgramsV2Program_universal_d_listPrograms as listPrograms,\n achievementsProgramsV2Program_universal_d_ListProgramsOptions as ListProgramsOptions,\n achievementsProgramsV2Program_universal_d_getProgram as getProgram,\n achievementsProgramsV2Program_universal_d_GetProgramOptions as GetProgramOptions,\n achievementsProgramsV2Program_universal_d_queryPrograms as queryPrograms,\n achievementsProgramsV2Program_universal_d_ProgramsQueryResult as ProgramsQueryResult,\n achievementsProgramsV2Program_universal_d_ProgramsQueryBuilder as ProgramsQueryBuilder,\n achievementsProgramsV2Program_universal_d_createProgram as createProgram,\n achievementsProgramsV2Program_universal_d_CreateProgramOptions as CreateProgramOptions,\n achievementsProgramsV2Program_universal_d_updateProgramSettings as updateProgramSettings,\n achievementsProgramsV2Program_universal_d_UpdateProgramSettingsOptions as UpdateProgramSettingsOptions,\n achievementsProgramsV2Program_universal_d_bulkUpdateProgramSettings as bulkUpdateProgramSettings,\n achievementsProgramsV2Program_universal_d_BulkUpdateProgramSettingsOptions as BulkUpdateProgramSettingsOptions,\n achievementsProgramsV2Program_universal_d_changeProgramState as changeProgramState,\n achievementsProgramsV2Program_universal_d_ChangeProgramStateOptions as ChangeProgramStateOptions,\n achievementsProgramsV2Program_universal_d_assignCategories as assignCategories,\n achievementsProgramsV2Program_universal_d_AssignCategoriesOptions as AssignCategoriesOptions,\n achievementsProgramsV2Program_universal_d_deleteProgram as deleteProgram,\n };\n }\n \n interface Participant$1 {\n _id?: string;\n member?: Member;\n challenge?: EntitySummary;\n timeFrame?: TimeInterval;\n stepsSummary?: StepsSummary$1;\n orderIds?: string[];\n transitions?: StateTransition[];\n timezone?: string;\n dateFrame?: DateInterval$1;\n socialGroupId?: string | null;\n performance?: number;\n joinPath?: JoinPath$1;\n /** Certificate issued to participant on successful program complete */\n certificate?: Certificate$1;\n }\n interface StepEvent$1 {\n stepId?: string;\n transition?: ParticipantStepStateTransition;\n }\n interface ParticipantStepStateTransition {\n state?: ParticipantStepState;\n occurredAt?: Date;\n }\n enum ParticipantStepState {\n PENDING = \"PENDING\",\n RUNNING = \"RUNNING\",\n COMPLETED = \"COMPLETED\",\n SKIPPED = \"SKIPPED\",\n CONFIRMED = \"CONFIRMED\",\n REJECTED = \"REJECTED\",\n OVERDUE = \"OVERDUE\",\n FAILED = \"FAILED\"\n }\n enum State$1 {\n JOIN_REQUESTED = \"JOIN_REQUESTED\",\n INVITED = \"INVITED\",\n JOIN_REJECTED = \"JOIN_REJECTED\",\n PAYMENT_REQUESTED = \"PAYMENT_REQUESTED\",\n PAYMENT_STARTED = \"PAYMENT_STARTED\",\n JOINED = \"JOINED\",\n LEFT = \"LEFT\",\n REMOVED = \"REMOVED\",\n RUNNING = \"RUNNING\",\n COMPLETED = \"COMPLETED\",\n FAILED = \"FAILED\",\n PAYMENT_STARTED_OFFLINE = \"PAYMENT_STARTED_OFFLINE\",\n SUSPENDED = \"SUSPENDED\"\n }\n interface Free {\n }\n interface Added {\n }\n interface SinglePayment {\n orderId?: string;\n }\n interface PaidPlan {\n planIds?: string[];\n }\n interface FreeCoupon {\n couponId?: string;\n }\n interface Member {\n _id?: string;\n fullName?: string;\n imageUrl?: string | null;\n contactId?: string | null;\n userId?: string | null;\n }\n interface EntitySummary {\n _id?: string;\n title?: string | null;\n media?: MediaItem;\n }\n /** Deprecated - Copy this message into your service, do not reference it */\n interface MediaItem extends MediaItemMediaOneOf {\n /** WixMedia image */\n image?: string;\n /** WixMedia video */\n video?: string;\n /** WixMedia document */\n document?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /** WixMedia image */\n image?: string;\n /** WixMedia video */\n video?: string;\n /** WixMedia document */\n document?: string;\n }\n interface TimeInterval {\n start?: Date;\n finish?: Date;\n }\n interface StepsSummary$1 {\n stepsNumber?: number;\n completedStepsNumber?: number;\n failedStepsNumber?: number;\n postedFeedbacksNumber?: number;\n lastEvent?: StepEvent$1;\n }\n interface StateTransition {\n state?: State$1;\n occurredAt?: Date;\n offlineTrxId?: string | null;\n }\n interface DateInterval$1 {\n start?: string;\n finish?: string | null;\n }\n interface JoinPath$1 extends JoinPathPathOneOf {\n free?: Free;\n added?: Added;\n singlePayment?: SinglePayment;\n paidPlan?: PaidPlan;\n freeCoupon?: FreeCoupon;\n }\n /** @oneof */\n interface JoinPathPathOneOf {\n free?: Free;\n added?: Added;\n singlePayment?: SinglePayment;\n paidPlan?: PaidPlan;\n freeCoupon?: FreeCoupon;\n }\n interface Certificate$1 {\n /**\n * when certificate was issued, UTC\n * @readonly\n */\n issuedDate?: Date;\n }\n interface QueryParticipantsRequest$1 {\n paging?: Paging$1;\n challengeId: string;\n sorting?: QueryParticipantsRequestSorting;\n filter?: ParticipantsFilter;\n }\n interface ParticipantJoinDate {\n start?: string | null;\n end?: string | null;\n }\n enum ParticipationState {\n NotStarted = \"NotStarted\",\n InProgress = \"InProgress\",\n Finished = \"Finished\",\n Suspended = \"Suspended\"\n }\n interface ParticipantPerformance {\n start?: number | null;\n end?: number | null;\n }\n enum QueryParticipantsRequestJoinPath {\n UNKNOWN_JOIN_PATH = \"UNKNOWN_JOIN_PATH\",\n FREE = \"FREE\",\n ADDED = \"ADDED\",\n SINGLE_PAYMENT = \"SINGLE_PAYMENT\",\n PAID_PLAN = \"PAID_PLAN\"\n }\n enum QueryParticipantsRequestSortingCriterion {\n DEFAULT = \"DEFAULT\",\n JOIN_DATE = \"JOIN_DATE\",\n NAME = \"NAME\",\n LAST_EVENT = \"LAST_EVENT\",\n PERFORMANCE = \"PERFORMANCE\"\n }\n enum QueryParticipantsRequestSortingOrder {\n ORDER_DEFAULT = \"ORDER_DEFAULT\",\n ORDER_ASC = \"ORDER_ASC\",\n ORDER_DESC = \"ORDER_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 QueryParticipantsRequestSorting {\n criterion?: QueryParticipantsRequestSortingCriterion;\n order?: QueryParticipantsRequestSortingOrder;\n }\n interface ParticipantsFilter {\n memberIds?: string[] | null;\n memberName?: string | null;\n states?: State$1[];\n joinedAt?: ParticipantJoinDate;\n participationStates?: ParticipationState[];\n performance?: ParticipantPerformance[];\n joinPath?: QueryParticipantsRequestJoinPath;\n }\n interface QueryParticipantsResponse$1 {\n totalCount?: number;\n participants?: Participant$1[];\n }\n interface ListParticipantsRequest {\n paging?: Paging$1;\n challengeId: string;\n /** @deprecated */\n memberId?: string | null;\n states?: State$1[];\n memberIds?: string[] | null;\n /** @deprecated */\n sortingCriterion?: SortingCriterion;\n memberName?: string | null;\n sorting?: Sorting$1;\n }\n enum SortingCriterion {\n DEFAULT = \"DEFAULT\",\n JOIN_DATE = \"JOIN_DATE\",\n NAME = \"NAME\",\n LAST_EVENT = \"LAST_EVENT\",\n PERFORMANCE = \"PERFORMANCE\"\n }\n enum SortingOrder {\n ORDER_DEFAULT = \"ORDER_DEFAULT\",\n ORDER_ASC = \"ORDER_ASC\",\n ORDER_DESC = \"ORDER_DESC\"\n }\n interface Sorting$1 {\n criterion?: SortingCriterion;\n order?: SortingOrder;\n }\n interface ListParticipantsResponse {\n totalCount?: number;\n participants?: Participant$1[];\n }\n interface JoinParticipantRequest {\n challengeId: string;\n /**\n * ignored, taken from callScope instead\n * @deprecated ignored, taken from callScope instead\n * @targetRemovalDate 2024-09-01\n */\n memberId?: string;\n timeZone?: string;\n actionId?: string;\n startDate?: string | null;\n }\n interface JoinParticipantResponse {\n participantId?: string;\n actionId?: string;\n participant?: Participant$1;\n }\n interface ParticipantJoined {\n participant?: Participant$1;\n /** user id for program owner */\n ownerId?: string;\n /** owner's contact id */\n ownerContactId?: string;\n }\n /** Add participant */\n interface AddParticipantRequest$1 {\n challengeId: string;\n memberId?: string;\n actionId?: string;\n }\n interface AddParticipantResponse$1 {\n participant?: Participant$1;\n actionId?: string;\n }\n /** Add participants */\n interface AddParticipantsRequest {\n challengeId: string;\n memberIds?: string[];\n actionId?: string;\n }\n interface AddParticipantsResponse {\n participants?: Participant$1[];\n actionId?: string;\n }\n interface AddAllParticipantRequest {\n challengeId: string;\n excludeIds?: string[];\n }\n interface AddAllParticipantResponse {\n }\n interface CreateJoinRequestRequest {\n challengeId: string;\n memberId?: string;\n timeZone?: string;\n actionId?: string;\n startDate?: string | null;\n }\n interface CreateJoinRequestResponse {\n participantId?: string;\n approvalRequestId?: string;\n actionId?: string;\n participant?: Participant$1;\n }\n interface InviteParticipantsRequest {\n challengeId: string;\n memberIds?: string[];\n actionId?: string;\n }\n interface InviteParticipantsResponse {\n invitations?: InvitationDetails[];\n actionId?: string;\n }\n interface InvitationDetails {\n participantId?: string;\n approvalRequestId?: string;\n }\n interface InviteAllParticipantsRequest {\n challengeId: string;\n excludeIds?: string[];\n }\n interface InviteAllParticipantsResponse {\n }\n interface GetParticipantRequest$1 {\n challengeId: string;\n participantId: string;\n }\n interface GetParticipantResponse$1 {\n participant?: Participant$1;\n }\n interface UpdateParticipantRequest extends UpdateParticipantRequestUpdateOneOf {\n startDate?: string;\n challengeId: string;\n participantId: string;\n actionId?: string;\n }\n /** @oneof */\n interface UpdateParticipantRequestUpdateOneOf {\n startDate?: string;\n }\n interface UpdateParticipantResponse {\n participant?: Participant$1;\n actionId?: string;\n }\n interface DeleteParticipantRequest {\n challengeId: string;\n participantId: string;\n actionId?: string;\n }\n interface DeleteParticipantResponse {\n actionId?: string;\n }\n interface ReviveParticipantRequest {\n challengeId: string;\n participantId: string;\n actionId?: string;\n }\n interface ReviveParticipantResponse {\n participant?: Participant$1;\n actionId?: string;\n }\n interface ResetParticipantProgressRequest {\n challengeId: string;\n participantId: string;\n timeZone?: string;\n startDate?: string | null;\n actionId?: string;\n }\n interface ResetParticipantProgressResponse {\n participant?: Participant$1;\n actionId?: string;\n }\n interface IssueParticipantCertificateRequest$1 {\n /** Participant to issue manually certificate */\n participantId: string;\n /** Program id. TODO: really bad to have it here, needed for url */\n challengeId: string;\n }\n interface IssueParticipantCertificateResponse$1 {\n /** Updated participant */\n participant?: Participant$1;\n }\n interface IssueCertificateRequest {\n /** Participant to get certificate */\n participantId: string;\n /** Program id. TODO: really bad to have it here, needed for url */\n challengeId: string;\n }\n interface IssueCertificateResponse {\n /** Updated participant */\n participant?: Participant$1;\n }\n interface GetCertificateRequest$1 {\n /** Participant to get certificate */\n participantId: string;\n /** Program id. TODO: really bad to have it here, needed for url */\n challengeId: string;\n }\n interface GetCertificateResponse$1 {\n /** URL on media to get certificate */\n certificateUrl?: string;\n }\n interface CreatePaymentOrderRequest {\n challengeId: string;\n participantId: string;\n actionId?: string;\n timeZone?: string | null;\n startDate?: string | null;\n paymentType?: PaymentType;\n }\n enum PaymentType {\n SINGLE_PAYMENT = \"SINGLE_PAYMENT\",\n PAID_PLANS = \"PAID_PLANS\"\n }\n interface CreatePaymentOrderResponse {\n orderId?: string;\n actionId?: string;\n participant?: Participant$1;\n }\n interface ApplyCouponToOrderRequest {\n challengeId: string;\n participantId: string;\n orderId: string;\n couponCode: string;\n actionId?: string;\n }\n interface ApplyCouponToOrderResponse {\n couponId?: string;\n subTotal?: string;\n discount?: string;\n total?: string;\n }\n interface RemoveCouponFromOrderRequest {\n challengeId: string;\n participantId: string;\n orderId: string;\n couponId: string;\n actionId?: string;\n }\n interface RemoveCouponFromOrderResponse {\n total?: string;\n }\n interface ListParticipantStepsRequest {\n challengeId: string;\n participantId: string;\n parentId?: string;\n timeInterval?: TimeInterval;\n dateInterval?: DateInterval$1;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n enum DescriptionFieldSet {\n /** title and detailed description. */\n EXTENDED = \"EXTENDED\",\n /** title only. */\n STANDARD = \"STANDARD\"\n }\n interface ListParticipantStepsResponse {\n steps?: ParticipantStep[];\n }\n interface ParticipantStep {\n _id?: string;\n source?: ChallengeStep;\n timeFrame?: TimeInterval;\n feedback?: Feedback;\n transitions?: ParticipantStepStateTransition[];\n dateFrame?: DateInterval$1;\n quizSubmission?: QuizSubmission;\n }\n interface FeedbackItem extends FeedbackItemValueOneOf {\n number?: number | null;\n text?: string | null;\n media?: MediaItems;\n choice?: FeedbackItemChoice;\n quantity?: Quantity;\n multiSelect?: Choices;\n feedbackItemSettingsId?: string;\n }\n /** @oneof */\n interface FeedbackItemValueOneOf {\n number?: number | null;\n text?: string | null;\n media?: MediaItems;\n choice?: FeedbackItemChoice;\n quantity?: Quantity;\n multiSelect?: Choices;\n }\n interface MediaItems {\n mediaItems?: MediaItem[];\n }\n interface FeedbackItemChoice {\n choiceId?: string;\n }\n interface Quantity {\n unitName?: string;\n amount?: number;\n }\n interface Choices {\n choiceIds?: string[];\n }\n interface ChallengeStep {\n _id?: string;\n settings?: ChallengeStepSettings;\n /** @deprecated */\n recurrenceSourceId?: string | null;\n createdAt?: Date;\n updatedAt?: Date;\n /** @readonly */\n sectionId?: string | null;\n }\n interface GeneralSettings extends GeneralSettingsStepTypeOneOf {\n individual?: IndividualSettings;\n /** @deprecated */\n group?: GroupSettings;\n quiz?: QuizSettings;\n video?: VideoStepSettings;\n /** steps description: title, details, image and etc. */\n description?: ObjectDescription;\n duration?: TimeDuration;\n /** @deprecated */\n recurrenceSettings?: RecurrenceSettings;\n }\n /** @oneof */\n interface GeneralSettingsStepTypeOneOf {\n individual?: IndividualSettings;\n /** @deprecated */\n group?: GroupSettings;\n quiz?: QuizSettings;\n video?: VideoStepSettings;\n }\n interface ObjectDescription {\n title?: string | null;\n details?: string | null;\n media?: MediaItem;\n }\n interface IndividualSettings {\n /** should be renamed, it's a flag whether the questionnaire section is enabled. */\n confirmationRequired?: boolean;\n /** feedback list settings. */\n feedbackSettings?: FeedbackItemSettings[];\n /** whether the quiz section in enabled. */\n showQuiz?: boolean;\n /** quiz list settings. */\n quizSettings?: FeedbackItemSettings[];\n }\n interface FeedbackItemSettings {\n _id?: string;\n type?: FeedbackItemType;\n question?: string;\n isRequired?: boolean;\n correctAnswerMessage?: string | null;\n wrongAnswerMessage?: string | null;\n }\n interface NumericFeedbackItem {\n maxValue?: number;\n }\n interface TextFeedbackItem {\n }\n interface MediaFeedbackItem {\n }\n interface MultipleChoiceFeedbackItem {\n choices?: Choice[];\n }\n enum ChoiceRightness {\n NEUTRAL = \"NEUTRAL\",\n RIGHT = \"RIGHT\",\n WRONG = \"WRONG\"\n }\n interface Choice {\n _id?: string;\n description?: ObjectDescription;\n rightness?: ChoiceRightness;\n }\n interface QuantityFeedbackItem {\n unitName?: string | null;\n amount?: number;\n }\n interface FeedbackItemType extends FeedbackItemTypeTypeOneOf {\n numeric?: NumericFeedbackItem;\n text?: TextFeedbackItem;\n media?: MediaFeedbackItem;\n multipleChoice?: MultipleChoiceFeedbackItem;\n quantity?: QuantityFeedbackItem;\n multiSelect?: MultipleChoiceFeedbackItem;\n }\n /** @oneof */\n interface FeedbackItemTypeTypeOneOf {\n numeric?: NumericFeedbackItem;\n text?: TextFeedbackItem;\n media?: MediaFeedbackItem;\n multipleChoice?: MultipleChoiceFeedbackItem;\n quantity?: QuantityFeedbackItem;\n multiSelect?: MultipleChoiceFeedbackItem;\n }\n interface GroupSettings {\n completionCriteria?: CompletionCriteria;\n }\n interface CompletionCriteria {\n completedSteps?: QuantityCriterion;\n completedMilestones?: QuantityCriterion;\n scoredPoints?: MinThreshold;\n }\n interface QuantityCriterion extends QuantityCriterionCriterionOneOf {\n all?: All;\n minThreshold?: MinThreshold;\n }\n /** @oneof */\n interface QuantityCriterionCriterionOneOf {\n all?: All;\n minThreshold?: MinThreshold;\n }\n interface All {\n }\n interface MinThreshold {\n value?: number;\n }\n interface QuizSettings {\n quizId?: string;\n questionCount?: number;\n passingGrade?: number | null;\n migrationDetails?: QuizMigrationDetails;\n }\n enum QuizType {\n QUIZ = \"QUIZ\",\n QUESTIONNAIRE = \"QUESTIONNAIRE\"\n }\n interface QuizMigrationDetails {\n sourceStepId?: string;\n show?: boolean;\n quizType?: QuizType;\n }\n interface VideoStepSettings extends VideoStepSettingsVideoSourceOneOf {\n wixVideo?: WixVideo;\n video?: string;\n requiredCompletionPercentage?: number;\n coverImage?: string;\n durationInMilliseconds?: number | null;\n deleted?: boolean;\n }\n /** @oneof */\n interface VideoStepSettingsVideoSourceOneOf {\n wixVideo?: WixVideo;\n video?: string;\n }\n interface WixVideo {\n _id?: string;\n paid?: boolean;\n }\n interface VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface TimeDuration {\n unit?: DurationUnit;\n value?: number;\n }\n enum DurationUnit {\n WEEKS = \"WEEKS\",\n DAYS = \"DAYS\",\n HOURS = \"HOURS\",\n MINUTES = \"MINUTES\"\n }\n interface RecurrenceSettings {\n schedules?: RecurrenceSchedule[];\n recurrencesCount?: number | null;\n }\n interface RecurrenceSchedule {\n startDelay?: TimeDuration;\n interval?: TimeDuration;\n }\n interface EmbeddingSettings {\n /** step start delay. */\n startConditions?: StartCondition[];\n /** @deprecated */\n isMilestone?: boolean;\n /** @deprecated */\n points?: number | null;\n }\n interface StartCondition {\n /** whether the step should start on join. */\n dependency?: StepDependency;\n /** step delay regarding the challenge start. */\n delay?: TimeDuration;\n }\n interface StepDependency extends StepDependencyDependencyTypeOneOf {\n container?: Container;\n /** @deprecated */\n step?: Step;\n }\n /** @oneof */\n interface StepDependencyDependencyTypeOneOf {\n container?: Container;\n /** @deprecated */\n step?: Step;\n }\n interface Container {\n }\n interface Step {\n stepId?: string;\n }\n interface ChallengeStepSettings {\n general?: GeneralSettings;\n embedding?: EmbeddingSettings;\n }\n interface Feedback {\n items?: FeedbackItem[];\n createdAt?: Date;\n updatedAt?: Date;\n quiz?: FeedbackItem[];\n }\n interface QuizSubmission {\n quizSubmissionId?: string;\n score?: number | null;\n grade?: number | null;\n rightAnswers?: number | null;\n passingGrade?: number | null;\n }\n interface GetParticipantStepRequest {\n challengeId: string;\n participantId: string;\n stepId: string;\n timeInterval?: TimeInterval;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n interface GetParticipantStepResponse {\n step?: ParticipantStep;\n subSteps?: ParticipantStep[];\n }\n interface ResolveParticipantStepRequest {\n challengeId: string;\n participantId: string;\n stepId: string;\n status?: ResolutionStatus;\n feedback?: Feedback;\n actionId?: string;\n quizSubmissionId?: string | null;\n }\n enum ResolutionStatus {\n COMPLETED = \"COMPLETED\",\n SKIPPED = \"SKIPPED\",\n UNDO = \"UNDO\",\n QUIZ_SUBMIT = \"QUIZ_SUBMIT\"\n }\n interface ResolveParticipantStepResponse {\n step?: ParticipantStep;\n actionId?: string;\n }\n interface StepResolved {\n challengeId?: string;\n participantId?: string;\n memberId?: string;\n stepTitle?: string;\n participantStepId?: string;\n challengeStepId?: string;\n /** TODO why it is repeated? */\n feedback?: Feedback[];\n /** Title of the program. Used in Notifications */\n programName?: string;\n /** user id for program owner */\n ownerId?: string;\n /** owner's contact id */\n ownerContactId?: string;\n /** participants contact */\n participantContactId?: string;\n /** info about quiz submission in that step */\n quizSubmissionData?: QuizSubmissionData;\n /** info about if participant completed step successfully or not */\n status?: Status;\n }\n interface QuizSubmissionData {\n submissionId?: string | null;\n earnedScore?: number | null;\n passingGrade?: number | null;\n }\n enum Status {\n /** step completed */\n COMPLETED = \"COMPLETED\",\n /** participant failed to resolve step */\n FAILED = \"FAILED\"\n }\n interface UpdateStepFeedbackRequest {\n challengeId: string;\n participantId: string;\n stepId: string;\n feedback?: Feedback;\n actionId?: string;\n }\n interface UpdateStepFeedbackResponse {\n step?: ParticipantStep;\n actionId?: string;\n }\n interface GetMediaUploadInfoRequest {\n challengeId: string;\n participantId: string;\n fileName?: string;\n }\n interface GetMediaUploadInfoResponse {\n uploadUrl?: string;\n uploadToken?: string;\n }\n interface ListParticipantSectionsRequest {\n challengeId: string;\n participantId: string;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n interface ListParticipantSectionsResponse {\n sections?: ParticipantSection[];\n }\n interface ParticipantSection {\n _id?: string;\n source?: ChallengeSection;\n steps?: ParticipantStep[];\n transitions?: ParticipantSectionStateTransition[];\n progress?: Progress;\n }\n interface WaitingDate {\n startDate?: string;\n }\n interface WaitingDependency {\n sectionId?: string;\n }\n interface Running {\n dateInterval?: DateInterval$1;\n }\n interface Completed$1 {\n }\n interface Overdue {\n }\n interface ChallengeSection {\n /** challenge section id. */\n _id?: string;\n /** challenge section settings. */\n settings?: Settings;\n createdAt?: Date;\n updatedAt?: Date;\n /** list of challenge steps laying inside the section. */\n steps?: ChallengeStep[];\n }\n interface Settings {\n /** section description(title, details, image...) */\n description?: ObjectDescription;\n /** condition for the section start. */\n startCondition?: StartCondition;\n }\n interface ParticipantSectionStateTransition extends ParticipantSectionStateTransitionStateOneOf {\n waitingDate?: WaitingDate;\n waitingDependency?: WaitingDependency;\n running?: Running;\n completed?: Completed$1;\n overdue?: Overdue;\n occurredAt?: Date;\n }\n /** @oneof */\n interface ParticipantSectionStateTransitionStateOneOf {\n waitingDate?: WaitingDate;\n waitingDependency?: WaitingDependency;\n running?: Running;\n completed?: Completed$1;\n overdue?: Overdue;\n }\n interface Progress {\n nTotalSteps?: string;\n nCompletedSteps?: string;\n }\n interface GetParticipantSectionRequest {\n challengeId: string;\n participantId: string;\n sectionId: string;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n interface GetParticipantSectionResponse {\n section?: ParticipantSection;\n }\n interface MyProgramRequest {\n programId: string;\n }\n interface MyProgramResponse {\n participant?: Participant$1;\n }\n interface MyProgramStepRequest {\n programId: string;\n programStepId: string;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n interface MyProgramStepResponse {\n participantStep?: ParticipantStep;\n }\n interface MyProgramSectionRequest {\n programId: string;\n programSectionId: string;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n interface MyProgramSectionResponse {\n participantSection?: ParticipantSection;\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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 /** @internal\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function queryParticipants$1(challengeId: string, options?: QueryParticipantsOptions): Promise;\n interface QueryParticipantsOptions {\n paging?: Paging$1;\n sorting?: QueryParticipantsRequestSorting;\n filter?: ParticipantsFilter;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n * @deprecated\n */\n function listParticipants(challengeId: string, options?: ListParticipantsOptions): Promise;\n interface ListParticipantsOptions {\n paging?: Paging$1;\n /** @deprecated */\n memberId?: string | null;\n states?: State$1[];\n memberIds?: string[] | null;\n /** @deprecated */\n sortingCriterion?: SortingCriterion;\n memberName?: string | null;\n sorting?: Sorting$1;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function joinParticipant(challengeId: string, options?: JoinParticipantOptions): Promise;\n interface JoinParticipantOptions {\n /**\n * ignored, taken from callScope instead\n * @deprecated ignored, taken from callScope instead\n * @targetRemovalDate 2024-09-01\n */\n memberId?: string;\n timeZone?: string;\n actionId?: string;\n startDate?: string | null;\n }\n /**\n * owner adds participant to the challenge\n * @public\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function addParticipant$1(challengeId: string, options?: AddParticipantOptions$1): Promise;\n interface AddParticipantOptions$1 {\n memberId?: string;\n actionId?: string;\n }\n /**\n * owner adds participants to the challenge\n * @public\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function addParticipants(challengeId: string, options?: AddParticipantsOptions): Promise;\n interface AddParticipantsOptions {\n memberIds?: string[];\n actionId?: string;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function addAllParticipant(challengeId: string, options?: AddAllParticipantOptions): Promise;\n interface AddAllParticipantOptions {\n excludeIds?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function createJoinRequest(challengeId: string, options?: CreateJoinRequestOptions): Promise;\n interface CreateJoinRequestOptions {\n memberId?: string;\n timeZone?: string;\n actionId?: string;\n startDate?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function inviteParticipants(challengeId: string, options?: InviteParticipantsOptions): Promise;\n interface InviteParticipantsOptions {\n memberIds?: string[];\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField challengeId\n * @adminMethod\n */\n function inviteAllParticipants(challengeId: string, options?: InviteAllParticipantsOptions): Promise;\n interface InviteAllParticipantsOptions {\n excludeIds?: string[];\n }\n /**\n * returns participant by id\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function getParticipant$1(identifiers: GetParticipantIdentifiers): Promise;\n interface GetParticipantIdentifiers {\n challengeId: string;\n participantId: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function updateParticipant(identifiers: UpdateParticipantIdentifiers, options?: UpdateParticipantOptions): Promise;\n interface UpdateParticipantIdentifiers extends UpdateParticipantRequestUpdateOneOf {\n challengeId: string;\n participantId: string;\n }\n interface UpdateParticipantOptions extends UpdateParticipantRequestUpdateOneOf {\n startDate?: string;\n actionId?: string;\n }\n /**\n * by owner - makes participant REMOVED. By participant himself - LEFT.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function deleteParticipant(identifiers: DeleteParticipantIdentifiers, options?: DeleteParticipantOptions): Promise;\n interface DeleteParticipantIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface DeleteParticipantOptions {\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function reviveParticipant(identifiers: ReviveParticipantIdentifiers, options?: ReviveParticipantOptions): Promise;\n interface ReviveParticipantIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface ReviveParticipantOptions {\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function resetParticipantProgress(identifiers: ResetParticipantProgressIdentifiers, options?: ResetParticipantProgressOptions): Promise;\n interface ResetParticipantProgressIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface ResetParticipantProgressOptions {\n timeZone?: string;\n startDate?: string | null;\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function issueParticipantCertificate$1(identifiers: IssueParticipantCertificateIdentifiers): Promise;\n interface IssueParticipantCertificateIdentifiers {\n /** Program id. TODO: really bad to have it here, needed for url */\n challengeId: string;\n /** Participant to issue manually certificate */\n participantId: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function issueCertificate(identifiers: IssueCertificateIdentifiers): Promise;\n interface IssueCertificateIdentifiers {\n /** Program id. TODO: really bad to have it here, needed for url */\n challengeId: string;\n /** Participant to get certificate */\n participantId: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function getCertificate$1(identifiers: GetCertificateIdentifiers): Promise;\n interface GetCertificateIdentifiers {\n /** Program id. TODO: really bad to have it here, needed for url */\n challengeId: string;\n /** Participant to get certificate */\n participantId: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function createPaymentOrder(identifiers: CreatePaymentOrderIdentifiers, options?: CreatePaymentOrderOptions): Promise;\n interface CreatePaymentOrderIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface CreatePaymentOrderOptions {\n actionId?: string;\n timeZone?: string | null;\n startDate?: string | null;\n paymentType?: PaymentType;\n }\n /**\n * ---------------------------------------------------- Coupons -----------------------------------------------------\n * @internal\n * @documentationMaturity preview\n * @requiredField couponCode\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.orderId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function applyCouponToOrder(identifiers: ApplyCouponToOrderIdentifiers, couponCode: string, options?: ApplyCouponToOrderOptions): Promise;\n interface ApplyCouponToOrderIdentifiers {\n challengeId: string;\n participantId: string;\n orderId: string;\n }\n interface ApplyCouponToOrderOptions {\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.couponId\n * @requiredField identifiers.orderId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function removeCouponFromOrder(identifiers: RemoveCouponFromOrderIdentifiers, options?: RemoveCouponFromOrderOptions): Promise;\n interface RemoveCouponFromOrderIdentifiers {\n challengeId: string;\n participantId: string;\n orderId: string;\n couponId: string;\n }\n interface RemoveCouponFromOrderOptions {\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function listSteps(identifiers: ListStepsIdentifiers, options?: ListStepsOptions): Promise;\n interface ListStepsIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface ListStepsOptions {\n parentId?: string;\n timeInterval?: TimeInterval;\n dateInterval?: DateInterval$1;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @requiredField identifiers.stepId\n * @adminMethod\n */\n function getStep(identifiers: GetStepIdentifiers, options?: GetStepOptions): Promise;\n interface GetStepIdentifiers {\n challengeId: string;\n participantId: string;\n stepId: string;\n }\n interface GetStepOptions {\n timeInterval?: TimeInterval;\n descriptionFieldSet?: DescriptionFieldSet;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @requiredField identifiers.stepId\n * @adminMethod\n */\n function resolveStep(identifiers: ResolveStepIdentifiers, options?: ResolveStepOptions): Promise;\n interface ResolveStepIdentifiers {\n challengeId: string;\n participantId: string;\n stepId: string;\n }\n interface ResolveStepOptions {\n status?: ResolutionStatus;\n feedback?: Feedback;\n actionId?: string;\n quizSubmissionId?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @requiredField identifiers.stepId\n * @adminMethod\n */\n function updateStepFeedback(identifiers: UpdateStepFeedbackIdentifiers, options?: UpdateStepFeedbackOptions): Promise;\n interface UpdateStepFeedbackIdentifiers {\n challengeId: string;\n participantId: string;\n stepId: string;\n }\n interface UpdateStepFeedbackOptions {\n feedback?: Feedback;\n actionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function getMediaUploadInfo(identifiers: GetMediaUploadInfoIdentifiers, options?: GetMediaUploadInfoOptions): Promise;\n interface GetMediaUploadInfoIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface GetMediaUploadInfoOptions {\n fileName?: string;\n }\n /**\n * ---------------------------------------------------- Sections --------------------------------------------------------\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @adminMethod\n */\n function listSections(identifiers: ListSectionsIdentifiers, options?: ListSectionsOptions): Promise;\n interface ListSectionsIdentifiers {\n challengeId: string;\n participantId: string;\n }\n interface ListSectionsOptions {\n descriptionFieldSet?: DescriptionFieldSet;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.challengeId\n * @requiredField identifiers.participantId\n * @requiredField identifiers.sectionId\n * @adminMethod\n */\n function getSection(identifiers: GetSectionIdentifiers, options?: GetSectionOptions): Promise;\n interface GetSectionIdentifiers {\n challengeId: string;\n participantId: string;\n sectionId: string;\n }\n interface GetSectionOptions {\n descriptionFieldSet?: DescriptionFieldSet;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @adminMethod\n */\n function myProgram(programId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.programId\n * @requiredField identifiers.programStepId\n * @adminMethod\n */\n function myProgramStep(identifiers: MyProgramStepIdentifiers, options?: MyProgramStepOptions): Promise;\n interface MyProgramStepIdentifiers {\n programId: string;\n programStepId: string;\n }\n interface MyProgramStepOptions {\n descriptionFieldSet?: DescriptionFieldSet;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.programId\n * @requiredField identifiers.programSectionId\n * @adminMethod\n */\n function myProgramSection(identifiers: MyProgramSectionIdentifiers, options?: MyProgramSectionOptions): Promise;\n interface MyProgramSectionIdentifiers {\n programId: string;\n programSectionId: string;\n }\n interface MyProgramSectionOptions {\n descriptionFieldSet?: DescriptionFieldSet;\n }\n \n interface Participant {\n /** @readonly */\n _id?: string | null;\n /** @readonly */\n programId?: string;\n /**\n * current participant state\n * @readonly\n */\n state?: State;\n /** time zone in which to participate */\n timeZone?: string;\n /** person */\n person?: PersonIdentity;\n /**\n * participant joined time UTC\n * @readonly\n */\n joinedDate?: Date;\n /**\n * the way participant joined\n * @readonly\n */\n joinPath?: JoinPath;\n /** current participant status */\n status?: ParticipantStatus;\n /** @readonly */\n performance?: number;\n /** participants progress summary */\n stepsSummary?: StepsSummary;\n /** Certificate issued to participant on successful program complete */\n certificate?: Certificate;\n }\n interface DateInterval {\n /** local date start */\n start?: string;\n /** local date finish, inclusive */\n finish?: string | null;\n }\n interface Invited {\n }\n interface JoinRequested {\n /** Approval request regarding to V1 */\n approvalRequestId?: string;\n }\n interface JoinRejected {\n }\n interface PaymentRequested {\n }\n interface PaymentStarted {\n }\n interface PaymentStartedOffline {\n /** Offline transaction id in payments wix.payment.api.pay.v3.Transaction */\n transactionId?: string;\n }\n interface Joined {\n /** TODO: change to start/end pair? */\n dateFrame?: DateInterval;\n }\n interface Left {\n }\n interface Removed {\n }\n interface Completed {\n }\n interface Failed {\n }\n interface Suspended {\n }\n interface StepEvent {\n /** @readonly */\n stepId?: string;\n /** step's current state */\n state?: StepEventState;\n /** when it occurred at, UTC */\n occurredAt?: Date;\n }\n enum StepEventState {\n /** step is pending to be completed */\n PENDING = \"PENDING\",\n /** step is active to be completed */\n RUNNING = \"RUNNING\",\n /** step was completed */\n COMPLETED = \"COMPLETED\",\n /** step was skipped */\n SKIPPED = \"SKIPPED\",\n /** step was confirmed */\n CONFIRMED = \"CONFIRMED\",\n /** step was rejected */\n REJECTED = \"REJECTED\",\n /** step was overdue */\n OVERDUE = \"OVERDUE\",\n /** step was failed */\n FAILED = \"FAILED\"\n }\n interface State extends StateStateOptionsOneOf {\n /** participant invited to program by owner */\n invited?: Invited;\n /** participant requested to join to private program */\n joinRequested?: JoinRequested;\n /** owner rejected participant join request */\n joinRejected?: JoinRejected;\n /** owner requested member to pay for participation */\n paymentRequested?: PaymentRequested;\n /** member started payment */\n paymentStarted?: PaymentStarted;\n /** owner waits for manual offline payment */\n paymentStartedOffline?: PaymentStartedOffline;\n /** member became participant */\n joined?: Joined;\n /** participant left program */\n left?: Left;\n /** owner removed participant from program */\n removed?: Removed;\n /** participant completed program */\n completed?: Completed;\n /** participant did not finished program in timeline */\n failed?: Failed;\n /** program was suspended, so is participant */\n suspended?: Suspended;\n }\n /** @oneof */\n interface StateStateOptionsOneOf {\n /** participant invited to program by owner */\n invited?: Invited;\n /** participant requested to join to private program */\n joinRequested?: JoinRequested;\n /** owner rejected participant join request */\n joinRejected?: JoinRejected;\n /** owner requested member to pay for participation */\n paymentRequested?: PaymentRequested;\n /** member started payment */\n paymentStarted?: PaymentStarted;\n /** owner waits for manual offline payment */\n paymentStartedOffline?: PaymentStartedOffline;\n /** member became participant */\n joined?: Joined;\n /** participant left program */\n left?: Left;\n /** owner removed participant from program */\n removed?: Removed;\n /** participant completed program */\n completed?: Completed;\n /** participant did not finished program in timeline */\n failed?: Failed;\n /** program was suspended, so is participant */\n suspended?: Suspended;\n }\n interface PersonIdentity {\n /**\n * Wix member\n * @readonly\n */\n memberId?: string;\n /**\n * Wix contact\n * @readonly\n */\n contactId?: string;\n /**\n * Wix user\n * @readonly\n */\n wixUserId?: string | null;\n }\n enum JoinPath {\n UNKNOWN_JOIN_PATH = \"UNKNOWN_JOIN_PATH\",\n FREE = \"FREE\",\n ADDED = \"ADDED\",\n PAID_PLAN = \"PAID_PLAN\",\n SINGLE_PAYMENT = \"SINGLE_PAYMENT\"\n }\n enum ParticipantStatus {\n UNKNOWN_PARTICIPANT_STATUS = \"UNKNOWN_PARTICIPANT_STATUS\",\n NOT_STARTED = \"NOT_STARTED\",\n IN_PROGRESS = \"IN_PROGRESS\",\n FINISHED = \"FINISHED\",\n SUSPENDED = \"SUSPENDED\"\n }\n interface StepsSummary {\n /** total number of steps to complete */\n stepsNumber?: number;\n /** number of completed steps */\n completedStepsNumber?: number;\n /** number of failed steps */\n failedStepsNumber?: number;\n /** number of feedbacks */\n postedFeedbacksNumber?: number;\n /** last event happened with step */\n lastEvent?: StepEvent;\n }\n interface Certificate {\n /**\n * when certificate was issued, UTC\n * @readonly\n */\n issuedDate?: Date;\n }\n interface GetParticipantRequest {\n participantId: string;\n }\n interface GetParticipantResponse {\n /** requested participant */\n participant?: Participant;\n }\n interface QueryParticipantsRequest {\n programId: string;\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;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryParticipantsResponse {\n /** Details on the paged set of results returned. */\n metadata?: PagingMetadataV2;\n /** participants matching query */\n participants?: Participant[];\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 * 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 * @internal\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 AddParticipantRequest {\n programId: string;\n /** member to become participant */\n memberId: string;\n }\n interface AddParticipantResponse {\n /** new participant */\n participant?: Participant;\n }\n interface BulkAddParticipantsRequest {\n programId: string;\n memberIds: string[];\n }\n interface BulkAddParticipantsResponse {\n /** bulk add results */\n results?: BulkAddParticipantsResult[];\n /** 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 BulkAddParticipantsResult {\n /** item metadata */\n itemMetadata?: ItemMetadata;\n /** added participant */\n item?: Participant;\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 InviteParticipantRequest {\n programId: string;\n /** member to become participant */\n memberId: string;\n }\n interface InviteParticipantResponse {\n /** invited participant */\n participant?: Participant;\n }\n interface BulkInviteParticipantsRequest {\n programId: string;\n memberIds: string[];\n }\n interface BulkInviteParticipantsResponse {\n /** bulk invite results */\n results?: BulkInviteParticipantsResult[];\n /** metadata */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkInviteParticipantsResult {\n /** item metadata */\n itemMetadata?: ItemMetadata;\n /** invited participant */\n item?: Participant;\n }\n interface JoinProgramRequest {\n programId: string;\n /** time zone in which to participate. UTC if not specified */\n timeZone?: string | null;\n /** chosen date to start the program */\n startDate?: string | null;\n }\n interface JoinProgramResponse {\n /** created participant */\n participant?: Participant;\n }\n interface LeaveProgramRequest {\n programId: string;\n }\n interface LeaveProgramResponse {\n /** left participant */\n participant?: Participant;\n }\n interface ParticipantLeft {\n /** participant left */\n participantId?: string;\n programId?: string;\n }\n interface RemoveParticipantRequest {\n /** participant to delete */\n participantId: string;\n }\n interface RemoveParticipantResponse {\n /** removed participant */\n participant?: Participant;\n }\n interface ParticipantRemoved {\n /** participant removed */\n participantId?: string;\n programId?: string;\n }\n interface IssueParticipantCertificateRequest {\n /** Participant to issue manually certificate */\n participantId: string;\n }\n interface IssueParticipantCertificateResponse {\n /** Updated participant */\n participant?: Participant;\n }\n interface GetCertificateRequest {\n /** Participant to get certificate */\n participantId: string;\n }\n interface GetCertificateResponse {\n /** Updated participant */\n participant?: Participant;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 participant by id\n * @internal\n * @documentationMaturity preview\n * @requiredField participantId\n * @returns requested participant\n */\n function getParticipant(participantId: string): Promise;\n /**\n * query participants\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ\n */\n function queryParticipants(programId: string): ParticipantsQueryBuilder;\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 ParticipantsQueryResult extends QueryOffsetResult {\n items: Participant[];\n query: ParticipantsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ParticipantsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'person.memberId' | 'joinPath' | 'status', value: any) => ParticipantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'joinedDate' | 'performance', value: any) => ParticipantsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'joinedDate' | 'performance', value: any) => ParticipantsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'person.memberId' | 'joinPath' | 'status', value: any) => ParticipantsQueryBuilder;\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<'joinedDate' | 'performance'>) => ParticipantsQueryBuilder;\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<'joinedDate' | 'performance'>) => ParticipantsQueryBuilder;\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) => ParticipantsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => ParticipantsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * owner adds participant to the program by his memberId.\n * Used as backdoor operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.memberId\n * @requiredField programId\n * @adminMethod\n */\n function addParticipant(programId: string, options: AddParticipantOptions): Promise;\n interface AddParticipantOptions {\n /** member to become participant */\n memberId: string;\n }\n /**\n * owner adds participants to the program in bulk by their memberIds.\n * Bulk version of AddParticipant, used as backdoor operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.memberIds\n * @requiredField programId\n * @adminMethod\n */\n function bulkAddParticipants(programId: string, options: BulkAddParticipantsOptions): Promise;\n interface BulkAddParticipantsOptions {\n memberIds: string[];\n }\n /**\n * owner invites member to become program participant\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.memberId\n * @requiredField programId\n * @adminMethod\n */\n function inviteParticipant(programId: string, options: InviteParticipantOptions): Promise;\n interface InviteParticipantOptions {\n /** member to become participant */\n memberId: string;\n }\n /**\n * owner bulk invites members to become program participants\n * Bulk version of InviteParticipant\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.memberIds\n * @requiredField programId\n * @adminMethod\n */\n function bulkInviteParticipants(programId: string, options: BulkInviteParticipantsOptions): Promise;\n interface BulkInviteParticipantsOptions {\n memberIds: string[];\n }\n /**\n * member joins the program, becoming participant in Joined state.\n * If program was private, user will be in JoinRequested state.\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n */\n function joinProgram(programId: string, options?: JoinProgramOptions): Promise;\n interface JoinProgramOptions {\n /** time zone in which to participate. UTC if not specified */\n timeZone?: string | null;\n /** chosen date to start the program */\n startDate?: string | null;\n }\n /**\n * member leaves the program. Participant's new status - LEFT\n * @internal\n * @documentationMaturity preview\n * @requiredField programId\n */\n function leaveProgram(programId: string): Promise;\n /**\n * owner removes participant from the program. Participant's new status - REMOVED\n * @param participantId - participant to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField participantId\n */\n function removeParticipant(participantId: string): Promise;\n /**\n * manual certificate issuing by program owner\n * @param participantId - Participant to issue manually certificate\n * @internal\n * @documentationMaturity preview\n * @requiredField participantId\n * @adminMethod\n */\n function issueParticipantCertificate(participantId: string): Promise;\n /**\n * participant get certificate by himself\n * @param participantId - Participant to get certificate\n * @internal\n * @documentationMaturity preview\n * @requiredField participantId\n * @adminMethod\n */\n function getCertificate(participantId: string): Promise;\n \n type achievementsProgramsV2Participant_universal_d_Participant = Participant;\n type achievementsProgramsV2Participant_universal_d_DateInterval = DateInterval;\n type achievementsProgramsV2Participant_universal_d_Invited = Invited;\n type achievementsProgramsV2Participant_universal_d_JoinRequested = JoinRequested;\n type achievementsProgramsV2Participant_universal_d_JoinRejected = JoinRejected;\n type achievementsProgramsV2Participant_universal_d_PaymentRequested = PaymentRequested;\n type achievementsProgramsV2Participant_universal_d_PaymentStarted = PaymentStarted;\n type achievementsProgramsV2Participant_universal_d_PaymentStartedOffline = PaymentStartedOffline;\n type achievementsProgramsV2Participant_universal_d_Joined = Joined;\n type achievementsProgramsV2Participant_universal_d_Left = Left;\n type achievementsProgramsV2Participant_universal_d_Removed = Removed;\n type achievementsProgramsV2Participant_universal_d_Completed = Completed;\n type achievementsProgramsV2Participant_universal_d_Failed = Failed;\n type achievementsProgramsV2Participant_universal_d_Suspended = Suspended;\n type achievementsProgramsV2Participant_universal_d_StepEvent = StepEvent;\n type achievementsProgramsV2Participant_universal_d_StepEventState = StepEventState;\n const achievementsProgramsV2Participant_universal_d_StepEventState: typeof StepEventState;\n type achievementsProgramsV2Participant_universal_d_State = State;\n type achievementsProgramsV2Participant_universal_d_StateStateOptionsOneOf = StateStateOptionsOneOf;\n type achievementsProgramsV2Participant_universal_d_PersonIdentity = PersonIdentity;\n type achievementsProgramsV2Participant_universal_d_JoinPath = JoinPath;\n const achievementsProgramsV2Participant_universal_d_JoinPath: typeof JoinPath;\n type achievementsProgramsV2Participant_universal_d_ParticipantStatus = ParticipantStatus;\n const achievementsProgramsV2Participant_universal_d_ParticipantStatus: typeof ParticipantStatus;\n type achievementsProgramsV2Participant_universal_d_StepsSummary = StepsSummary;\n type achievementsProgramsV2Participant_universal_d_Certificate = Certificate;\n type achievementsProgramsV2Participant_universal_d_GetParticipantRequest = GetParticipantRequest;\n type achievementsProgramsV2Participant_universal_d_GetParticipantResponse = GetParticipantResponse;\n type achievementsProgramsV2Participant_universal_d_QueryParticipantsRequest = QueryParticipantsRequest;\n type achievementsProgramsV2Participant_universal_d_QueryV2 = QueryV2;\n type achievementsProgramsV2Participant_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type achievementsProgramsV2Participant_universal_d_Sorting = Sorting;\n type achievementsProgramsV2Participant_universal_d_SortOrder = SortOrder;\n const achievementsProgramsV2Participant_universal_d_SortOrder: typeof SortOrder;\n type achievementsProgramsV2Participant_universal_d_Paging = Paging;\n type achievementsProgramsV2Participant_universal_d_CursorPaging = CursorPaging;\n type achievementsProgramsV2Participant_universal_d_QueryParticipantsResponse = QueryParticipantsResponse;\n type achievementsProgramsV2Participant_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type achievementsProgramsV2Participant_universal_d_Cursors = Cursors;\n type achievementsProgramsV2Participant_universal_d_AddParticipantRequest = AddParticipantRequest;\n type achievementsProgramsV2Participant_universal_d_AddParticipantResponse = AddParticipantResponse;\n type achievementsProgramsV2Participant_universal_d_BulkAddParticipantsRequest = BulkAddParticipantsRequest;\n type achievementsProgramsV2Participant_universal_d_BulkAddParticipantsResponse = BulkAddParticipantsResponse;\n type achievementsProgramsV2Participant_universal_d_ItemMetadata = ItemMetadata;\n type achievementsProgramsV2Participant_universal_d_ApplicationError = ApplicationError;\n type achievementsProgramsV2Participant_universal_d_BulkAddParticipantsResult = BulkAddParticipantsResult;\n type achievementsProgramsV2Participant_universal_d_BulkActionMetadata = BulkActionMetadata;\n type achievementsProgramsV2Participant_universal_d_InviteParticipantRequest = InviteParticipantRequest;\n type achievementsProgramsV2Participant_universal_d_InviteParticipantResponse = InviteParticipantResponse;\n type achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsRequest = BulkInviteParticipantsRequest;\n type achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsResponse = BulkInviteParticipantsResponse;\n type achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsResult = BulkInviteParticipantsResult;\n type achievementsProgramsV2Participant_universal_d_JoinProgramRequest = JoinProgramRequest;\n type achievementsProgramsV2Participant_universal_d_JoinProgramResponse = JoinProgramResponse;\n type achievementsProgramsV2Participant_universal_d_LeaveProgramRequest = LeaveProgramRequest;\n type achievementsProgramsV2Participant_universal_d_LeaveProgramResponse = LeaveProgramResponse;\n type achievementsProgramsV2Participant_universal_d_ParticipantLeft = ParticipantLeft;\n type achievementsProgramsV2Participant_universal_d_RemoveParticipantRequest = RemoveParticipantRequest;\n type achievementsProgramsV2Participant_universal_d_RemoveParticipantResponse = RemoveParticipantResponse;\n type achievementsProgramsV2Participant_universal_d_ParticipantRemoved = ParticipantRemoved;\n type achievementsProgramsV2Participant_universal_d_IssueParticipantCertificateRequest = IssueParticipantCertificateRequest;\n type achievementsProgramsV2Participant_universal_d_IssueParticipantCertificateResponse = IssueParticipantCertificateResponse;\n type achievementsProgramsV2Participant_universal_d_GetCertificateRequest = GetCertificateRequest;\n type achievementsProgramsV2Participant_universal_d_GetCertificateResponse = GetCertificateResponse;\n type achievementsProgramsV2Participant_universal_d_DomainEvent = DomainEvent;\n type achievementsProgramsV2Participant_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type achievementsProgramsV2Participant_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type achievementsProgramsV2Participant_universal_d_RestoreInfo = RestoreInfo;\n type achievementsProgramsV2Participant_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type achievementsProgramsV2Participant_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type achievementsProgramsV2Participant_universal_d_ActionEvent = ActionEvent;\n type achievementsProgramsV2Participant_universal_d_MessageEnvelope = MessageEnvelope;\n type achievementsProgramsV2Participant_universal_d_IdentificationData = IdentificationData;\n type achievementsProgramsV2Participant_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type achievementsProgramsV2Participant_universal_d_WebhookIdentityType = WebhookIdentityType;\n const achievementsProgramsV2Participant_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const achievementsProgramsV2Participant_universal_d_getParticipant: typeof getParticipant;\n const achievementsProgramsV2Participant_universal_d_queryParticipants: typeof queryParticipants;\n type achievementsProgramsV2Participant_universal_d_ParticipantsQueryResult = ParticipantsQueryResult;\n type achievementsProgramsV2Participant_universal_d_ParticipantsQueryBuilder = ParticipantsQueryBuilder;\n const achievementsProgramsV2Participant_universal_d_addParticipant: typeof addParticipant;\n type achievementsProgramsV2Participant_universal_d_AddParticipantOptions = AddParticipantOptions;\n const achievementsProgramsV2Participant_universal_d_bulkAddParticipants: typeof bulkAddParticipants;\n type achievementsProgramsV2Participant_universal_d_BulkAddParticipantsOptions = BulkAddParticipantsOptions;\n const achievementsProgramsV2Participant_universal_d_inviteParticipant: typeof inviteParticipant;\n type achievementsProgramsV2Participant_universal_d_InviteParticipantOptions = InviteParticipantOptions;\n const achievementsProgramsV2Participant_universal_d_bulkInviteParticipants: typeof bulkInviteParticipants;\n type achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsOptions = BulkInviteParticipantsOptions;\n const achievementsProgramsV2Participant_universal_d_joinProgram: typeof joinProgram;\n type achievementsProgramsV2Participant_universal_d_JoinProgramOptions = JoinProgramOptions;\n const achievementsProgramsV2Participant_universal_d_leaveProgram: typeof leaveProgram;\n const achievementsProgramsV2Participant_universal_d_removeParticipant: typeof removeParticipant;\n const achievementsProgramsV2Participant_universal_d_issueParticipantCertificate: typeof issueParticipantCertificate;\n const achievementsProgramsV2Participant_universal_d_getCertificate: typeof getCertificate;\n namespace achievementsProgramsV2Participant_universal_d {\n export {\n achievementsProgramsV2Participant_universal_d_Participant as Participant,\n achievementsProgramsV2Participant_universal_d_DateInterval as DateInterval,\n achievementsProgramsV2Participant_universal_d_Invited as Invited,\n achievementsProgramsV2Participant_universal_d_JoinRequested as JoinRequested,\n achievementsProgramsV2Participant_universal_d_JoinRejected as JoinRejected,\n achievementsProgramsV2Participant_universal_d_PaymentRequested as PaymentRequested,\n achievementsProgramsV2Participant_universal_d_PaymentStarted as PaymentStarted,\n achievementsProgramsV2Participant_universal_d_PaymentStartedOffline as PaymentStartedOffline,\n achievementsProgramsV2Participant_universal_d_Joined as Joined,\n achievementsProgramsV2Participant_universal_d_Left as Left,\n achievementsProgramsV2Participant_universal_d_Removed as Removed,\n achievementsProgramsV2Participant_universal_d_Completed as Completed,\n achievementsProgramsV2Participant_universal_d_Failed as Failed,\n achievementsProgramsV2Participant_universal_d_Suspended as Suspended,\n achievementsProgramsV2Participant_universal_d_StepEvent as StepEvent,\n achievementsProgramsV2Participant_universal_d_StepEventState as StepEventState,\n achievementsProgramsV2Participant_universal_d_State as State,\n achievementsProgramsV2Participant_universal_d_StateStateOptionsOneOf as StateStateOptionsOneOf,\n achievementsProgramsV2Participant_universal_d_PersonIdentity as PersonIdentity,\n achievementsProgramsV2Participant_universal_d_JoinPath as JoinPath,\n achievementsProgramsV2Participant_universal_d_ParticipantStatus as ParticipantStatus,\n achievementsProgramsV2Participant_universal_d_StepsSummary as StepsSummary,\n achievementsProgramsV2Participant_universal_d_Certificate as Certificate,\n achievementsProgramsV2Participant_universal_d_GetParticipantRequest as GetParticipantRequest,\n achievementsProgramsV2Participant_universal_d_GetParticipantResponse as GetParticipantResponse,\n achievementsProgramsV2Participant_universal_d_QueryParticipantsRequest as QueryParticipantsRequest,\n achievementsProgramsV2Participant_universal_d_QueryV2 as QueryV2,\n achievementsProgramsV2Participant_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n achievementsProgramsV2Participant_universal_d_Sorting as Sorting,\n achievementsProgramsV2Participant_universal_d_SortOrder as SortOrder,\n achievementsProgramsV2Participant_universal_d_Paging as Paging,\n achievementsProgramsV2Participant_universal_d_CursorPaging as CursorPaging,\n achievementsProgramsV2Participant_universal_d_QueryParticipantsResponse as QueryParticipantsResponse,\n achievementsProgramsV2Participant_universal_d_PagingMetadataV2 as PagingMetadataV2,\n achievementsProgramsV2Participant_universal_d_Cursors as Cursors,\n achievementsProgramsV2Participant_universal_d_AddParticipantRequest as AddParticipantRequest,\n achievementsProgramsV2Participant_universal_d_AddParticipantResponse as AddParticipantResponse,\n achievementsProgramsV2Participant_universal_d_BulkAddParticipantsRequest as BulkAddParticipantsRequest,\n achievementsProgramsV2Participant_universal_d_BulkAddParticipantsResponse as BulkAddParticipantsResponse,\n achievementsProgramsV2Participant_universal_d_ItemMetadata as ItemMetadata,\n achievementsProgramsV2Participant_universal_d_ApplicationError as ApplicationError,\n achievementsProgramsV2Participant_universal_d_BulkAddParticipantsResult as BulkAddParticipantsResult,\n achievementsProgramsV2Participant_universal_d_BulkActionMetadata as BulkActionMetadata,\n achievementsProgramsV2Participant_universal_d_InviteParticipantRequest as InviteParticipantRequest,\n achievementsProgramsV2Participant_universal_d_InviteParticipantResponse as InviteParticipantResponse,\n achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsRequest as BulkInviteParticipantsRequest,\n achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsResponse as BulkInviteParticipantsResponse,\n achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsResult as BulkInviteParticipantsResult,\n achievementsProgramsV2Participant_universal_d_JoinProgramRequest as JoinProgramRequest,\n achievementsProgramsV2Participant_universal_d_JoinProgramResponse as JoinProgramResponse,\n achievementsProgramsV2Participant_universal_d_LeaveProgramRequest as LeaveProgramRequest,\n achievementsProgramsV2Participant_universal_d_LeaveProgramResponse as LeaveProgramResponse,\n achievementsProgramsV2Participant_universal_d_ParticipantLeft as ParticipantLeft,\n achievementsProgramsV2Participant_universal_d_RemoveParticipantRequest as RemoveParticipantRequest,\n achievementsProgramsV2Participant_universal_d_RemoveParticipantResponse as RemoveParticipantResponse,\n achievementsProgramsV2Participant_universal_d_ParticipantRemoved as ParticipantRemoved,\n achievementsProgramsV2Participant_universal_d_IssueParticipantCertificateRequest as IssueParticipantCertificateRequest,\n achievementsProgramsV2Participant_universal_d_IssueParticipantCertificateResponse as IssueParticipantCertificateResponse,\n achievementsProgramsV2Participant_universal_d_GetCertificateRequest as GetCertificateRequest,\n achievementsProgramsV2Participant_universal_d_GetCertificateResponse as GetCertificateResponse,\n achievementsProgramsV2Participant_universal_d_DomainEvent as DomainEvent,\n achievementsProgramsV2Participant_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n achievementsProgramsV2Participant_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n achievementsProgramsV2Participant_universal_d_RestoreInfo as RestoreInfo,\n achievementsProgramsV2Participant_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n achievementsProgramsV2Participant_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n achievementsProgramsV2Participant_universal_d_ActionEvent as ActionEvent,\n achievementsProgramsV2Participant_universal_d_MessageEnvelope as MessageEnvelope,\n achievementsProgramsV2Participant_universal_d_IdentificationData as IdentificationData,\n achievementsProgramsV2Participant_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n achievementsProgramsV2Participant_universal_d_WebhookIdentityType as WebhookIdentityType,\n achievementsProgramsV2Participant_universal_d_getParticipant as getParticipant,\n achievementsProgramsV2Participant_universal_d_queryParticipants as queryParticipants,\n achievementsProgramsV2Participant_universal_d_ParticipantsQueryResult as ParticipantsQueryResult,\n achievementsProgramsV2Participant_universal_d_ParticipantsQueryBuilder as ParticipantsQueryBuilder,\n achievementsProgramsV2Participant_universal_d_addParticipant as addParticipant,\n achievementsProgramsV2Participant_universal_d_AddParticipantOptions as AddParticipantOptions,\n achievementsProgramsV2Participant_universal_d_bulkAddParticipants as bulkAddParticipants,\n achievementsProgramsV2Participant_universal_d_BulkAddParticipantsOptions as BulkAddParticipantsOptions,\n achievementsProgramsV2Participant_universal_d_inviteParticipant as inviteParticipant,\n achievementsProgramsV2Participant_universal_d_InviteParticipantOptions as InviteParticipantOptions,\n achievementsProgramsV2Participant_universal_d_bulkInviteParticipants as bulkInviteParticipants,\n achievementsProgramsV2Participant_universal_d_BulkInviteParticipantsOptions as BulkInviteParticipantsOptions,\n achievementsProgramsV2Participant_universal_d_joinProgram as joinProgram,\n achievementsProgramsV2Participant_universal_d_JoinProgramOptions as JoinProgramOptions,\n achievementsProgramsV2Participant_universal_d_leaveProgram as leaveProgram,\n achievementsProgramsV2Participant_universal_d_removeParticipant as removeParticipant,\n achievementsProgramsV2Participant_universal_d_issueParticipantCertificate as issueParticipantCertificate,\n achievementsProgramsV2Participant_universal_d_getCertificate as getCertificate,\n };\n }\n \n export { ActionEvent$1 as ActionEvent, AddAllParticipantOptions, AddAllParticipantRequest, AddAllParticipantResponse, AddParticipantOptions$1 as AddParticipantOptions, AddParticipantRequest$1 as AddParticipantRequest, AddParticipantResponse$1 as AddParticipantResponse, AddParticipantsOptions, AddParticipantsRequest, AddParticipantsResponse, Added, All, ApplyCouponToOrderIdentifiers, ApplyCouponToOrderOptions, ApplyCouponToOrderRequest, ApplyCouponToOrderResponse, Certificate$1 as Certificate, ChallengeSection, ChallengeStep, ChallengeStepSettings, Choice, ChoiceRightness, Choices, Completed$1 as Completed, CompletionCriteria, Container, CreateJoinRequestOptions, CreateJoinRequestRequest, CreateJoinRequestResponse, CreatePaymentOrderIdentifiers, CreatePaymentOrderOptions, CreatePaymentOrderRequest, CreatePaymentOrderResponse, DateInterval$1 as DateInterval, DeleteParticipantIdentifiers, DeleteParticipantOptions, DeleteParticipantRequest, DeleteParticipantResponse, DescriptionFieldSet, DomainEvent$1 as DomainEvent, DomainEventBodyOneOf$1 as DomainEventBodyOneOf, DurationUnit, EmbeddingSettings, EntityCreatedEvent$1 as EntityCreatedEvent, EntityDeletedEvent$1 as EntityDeletedEvent, EntitySummary, EntityUpdatedEvent$1 as EntityUpdatedEvent, Feedback, FeedbackItem, FeedbackItemChoice, FeedbackItemSettings, FeedbackItemType, FeedbackItemTypeTypeOneOf, FeedbackItemValueOneOf, Free, FreeCoupon, GeneralSettings, GeneralSettingsStepTypeOneOf, GetCertificateIdentifiers, GetCertificateRequest$1 as GetCertificateRequest, GetCertificateResponse$1 as GetCertificateResponse, GetMediaUploadInfoIdentifiers, GetMediaUploadInfoOptions, GetMediaUploadInfoRequest, GetMediaUploadInfoResponse, GetParticipantIdentifiers, GetParticipantRequest$1 as GetParticipantRequest, GetParticipantResponse$1 as GetParticipantResponse, GetParticipantSectionRequest, GetParticipantSectionResponse, GetParticipantStepRequest, GetParticipantStepResponse, GetSectionIdentifiers, GetSectionOptions, GetStepIdentifiers, GetStepOptions, GroupSettings, IdentificationData$1 as IdentificationData, IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, IndividualSettings, InvitationDetails, InviteAllParticipantsOptions, InviteAllParticipantsRequest, InviteAllParticipantsResponse, InviteParticipantsOptions, InviteParticipantsRequest, InviteParticipantsResponse, IssueCertificateIdentifiers, IssueCertificateRequest, IssueCertificateResponse, IssueParticipantCertificateIdentifiers, IssueParticipantCertificateRequest$1 as IssueParticipantCertificateRequest, IssueParticipantCertificateResponse$1 as IssueParticipantCertificateResponse, JoinParticipantOptions, JoinParticipantRequest, JoinParticipantResponse, JoinPath$1 as JoinPath, JoinPathPathOneOf, ListParticipantSectionsRequest, ListParticipantSectionsResponse, ListParticipantStepsRequest, ListParticipantStepsResponse, ListParticipantsOptions, ListParticipantsRequest, ListParticipantsResponse, ListSectionsIdentifiers, ListSectionsOptions, ListStepsIdentifiers, ListStepsOptions, MediaFeedbackItem, MediaItem, MediaItemMediaOneOf, MediaItems, Member, MessageEnvelope$1 as MessageEnvelope, MinThreshold, MultipleChoiceFeedbackItem, MyProgramRequest, MyProgramResponse, MyProgramSectionIdentifiers, MyProgramSectionOptions, MyProgramSectionRequest, MyProgramSectionResponse, MyProgramStepIdentifiers, MyProgramStepOptions, MyProgramStepRequest, MyProgramStepResponse, NumericFeedbackItem, ObjectDescription, Overdue, Paging$1 as Paging, PaidPlan, Participant$1 as Participant, ParticipantJoinDate, ParticipantJoined, ParticipantPerformance, ParticipantSection, ParticipantSectionStateTransition, ParticipantSectionStateTransitionStateOneOf, ParticipantStep, ParticipantStepState, ParticipantStepStateTransition, ParticipantsFilter, ParticipationState, PaymentType, Progress, Quantity, QuantityCriterion, QuantityCriterionCriterionOneOf, QuantityFeedbackItem, QueryParticipantsOptions, QueryParticipantsRequest$1 as QueryParticipantsRequest, QueryParticipantsRequestJoinPath, QueryParticipantsRequestSorting, QueryParticipantsRequestSortingCriterion, QueryParticipantsRequestSortingOrder, QueryParticipantsResponse$1 as QueryParticipantsResponse, QuizMigrationDetails, QuizSettings, QuizSubmission, QuizSubmissionData, QuizType, RecurrenceSchedule, RecurrenceSettings, RemoveCouponFromOrderIdentifiers, RemoveCouponFromOrderOptions, RemoveCouponFromOrderRequest, RemoveCouponFromOrderResponse, ResetParticipantProgressIdentifiers, ResetParticipantProgressOptions, ResetParticipantProgressRequest, ResetParticipantProgressResponse, ResolutionStatus, ResolveParticipantStepRequest, ResolveParticipantStepResponse, ResolveStepIdentifiers, ResolveStepOptions, RestoreInfo$1 as RestoreInfo, ReviveParticipantIdentifiers, ReviveParticipantOptions, ReviveParticipantRequest, ReviveParticipantResponse, Running, Settings, SinglePayment, Sorting$1 as Sorting, SortingCriterion, SortingOrder, StartCondition, State$1 as State, StateTransition, Status, Step, StepDependency, StepDependencyDependencyTypeOneOf, StepEvent$1 as StepEvent, StepResolved, StepsSummary$1 as StepsSummary, TextFeedbackItem, TimeDuration, TimeInterval, UpdateParticipantIdentifiers, UpdateParticipantOptions, UpdateParticipantRequest, UpdateParticipantRequestUpdateOneOf, UpdateParticipantResponse, UpdateStepFeedbackIdentifiers, UpdateStepFeedbackOptions, UpdateStepFeedbackRequest, UpdateStepFeedbackResponse, VideoResolution, VideoStepSettings, VideoStepSettingsVideoSourceOneOf, WaitingDate, WaitingDependency, WebhookIdentityType$1 as WebhookIdentityType, WixVideo, addAllParticipant, addParticipant$1 as addParticipant, addParticipants, applyCouponToOrder, createJoinRequest, createPaymentOrder, deleteParticipant, getCertificate$1 as getCertificate, getMediaUploadInfo, getParticipant$1 as getParticipant, getSection, getStep, inviteAllParticipants, inviteParticipants, issueCertificate, issueParticipantCertificate$1 as issueParticipantCertificate, joinParticipant, listParticipants, listSections, listSteps, myProgram, myProgramSection, myProgramStep, achievementsProgramsV2Participant_universal_d as onlineProgramParticipants, achievementsProgramsV2Program_universal_d as onlinePrograms, queryParticipants$1 as queryParticipants, removeCouponFromOrder, resetParticipantProgress, resolveStep, reviveParticipant, updateParticipant, updateStepFeedback };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-alarm-backend.d.ts", "content": "declare module \"wix-alarm-backend\" {\n interface AlarmResponse {\n time?: Date;\n }\n \n function alarm(seconds: number): Promise;\n \n export { alarm };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-blog-backend.d.ts", "content": "declare module \"wix-blog-backend\" {\n /** BlogCache is the main entity of BlogCacheService */\n interface BlogCache {\n /**\n * MetaSite ID.\n * @readonly\n */\n _id?: string | null;\n /** Site supported languages. */\n siteSupportedLanguages?: SiteSupportedLanguage[];\n /** Pages data. */\n pagesData?: PagesData;\n /** Site properties. */\n siteProperties?: SiteProperties;\n /**\n * Date the blog cache was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface SiteSupportedLanguage {\n /** Language code */\n languageCode?: string;\n /** Locale status. */\n status?: LocaleStatus;\n /** Flag code. */\n flag?: Flag;\n /** Resolution method. */\n resolutionMethod?: ResolutionMethod;\n }\n enum LocaleStatus {\n /** Value not specified */\n UNDEFINED_STATUS = \"UNDEFINED_STATUS\",\n /** Locale was added to site but was not activated */\n INACTIVE = \"INACTIVE\",\n /** Locale was added to site and activated */\n ACTIVE = \"ACTIVE\",\n /** Default locale (always active) */\n DEFAULT = \"DEFAULT\"\n }\n enum Flag {\n UNDEFINED_FLAG_CODE = \"UNDEFINED_FLAG_CODE\",\n AFG = \"AFG\",\n AGO = \"AGO\",\n AIA = \"AIA\",\n ALA = \"ALA\",\n ALB = \"ALB\",\n AND = \"AND\",\n ARE = \"ARE\",\n ARG = \"ARG\",\n ARM = \"ARM\",\n ASM = \"ASM\",\n ATF = \"ATF\",\n ATG = \"ATG\",\n AUS = \"AUS\",\n AUT = \"AUT\",\n AZE = \"AZE\",\n BDI = \"BDI\",\n BEL = \"BEL\",\n BEN = \"BEN\",\n BES = \"BES\",\n BFA = \"BFA\",\n BGD = \"BGD\",\n BGR = \"BGR\",\n BHR = \"BHR\",\n BHS = \"BHS\",\n BIH = \"BIH\",\n BLM = \"BLM\",\n BLR = \"BLR\",\n BLZ = \"BLZ\",\n BMU = \"BMU\",\n BOL = \"BOL\",\n BRA = \"BRA\",\n BRB = \"BRB\",\n BRN = \"BRN\",\n BRT = \"BRT\",\n BTN = \"BTN\",\n BWA = \"BWA\",\n CAF = \"CAF\",\n CAN = \"CAN\",\n CAT = \"CAT\",\n CHE = \"CHE\",\n CHL = \"CHL\",\n CHN = \"CHN\",\n CIV = \"CIV\",\n CMR = \"CMR\",\n COD = \"COD\",\n COG = \"COG\",\n COL = \"COL\",\n COM = \"COM\",\n COR = \"COR\",\n CPV = \"CPV\",\n CRI = \"CRI\",\n CUB = \"CUB\",\n CUW = \"CUW\",\n CYM = \"CYM\",\n CZE = \"CZE\",\n DEU = \"DEU\",\n DJI = \"DJI\",\n DMA = \"DMA\",\n DNK = \"DNK\",\n DOM = \"DOM\",\n DZA = \"DZA\",\n ECU = \"ECU\",\n EGY = \"EGY\",\n ERI = \"ERI\",\n ESP = \"ESP\",\n EST = \"EST\",\n ETH = \"ETH\",\n EUR = \"EUR\",\n EUS = \"EUS\",\n FIN = \"FIN\",\n FJI = \"FJI\",\n FLK = \"FLK\",\n FRA = \"FRA\",\n FRO = \"FRO\",\n FSM = \"FSM\",\n GAB = \"GAB\",\n GBR = \"GBR\",\n GEO = \"GEO\",\n GGY = \"GGY\",\n GHA = \"GHA\",\n GIB = \"GIB\",\n GIN = \"GIN\",\n GLG = \"GLG\",\n GLO = \"GLO\",\n GLP = \"GLP\",\n GMB = \"GMB\",\n GNB = \"GNB\",\n GNQ = \"GNQ\",\n GRC = \"GRC\",\n GRD = \"GRD\",\n GRL = \"GRL\",\n GTM = \"GTM\",\n GUM = \"GUM\",\n GUY = \"GUY\",\n HKG = \"HKG\",\n HND = \"HND\",\n HRV = \"HRV\",\n HTI = \"HTI\",\n HUN = \"HUN\",\n IDN = \"IDN\",\n IMN = \"IMN\",\n IND = \"IND\",\n IOT = \"IOT\",\n IRL = \"IRL\",\n IRN = \"IRN\",\n IRQ = \"IRQ\",\n ISL = \"ISL\",\n ISR = \"ISR\",\n ITA = \"ITA\",\n JAM = \"JAM\",\n JEY = \"JEY\",\n JOR = \"JOR\",\n JPN = \"JPN\",\n KAZ = \"KAZ\",\n KEN = \"KEN\",\n KGZ = \"KGZ\",\n KHM = \"KHM\",\n KIR = \"KIR\",\n KNA = \"KNA\",\n KOR = \"KOR\",\n KUR = \"KUR\",\n KWT = \"KWT\",\n LAO = \"LAO\",\n LBN = \"LBN\",\n LBR = \"LBR\",\n LBY = \"LBY\",\n LCA = \"LCA\",\n LIE = \"LIE\",\n LKA = \"LKA\",\n LSO = \"LSO\",\n LTU = \"LTU\",\n LUX = \"LUX\",\n LVA = \"LVA\",\n MAC = \"MAC\",\n MAF = \"MAF\",\n MAR = \"MAR\",\n MCO = \"MCO\",\n MDA = \"MDA\",\n MDG = \"MDG\",\n MDV = \"MDV\",\n MEX = \"MEX\",\n MHL = \"MHL\",\n MKD = \"MKD\",\n MLI = \"MLI\",\n MLT = \"MLT\",\n MMR = \"MMR\",\n MNE = \"MNE\",\n MNG = \"MNG\",\n MNP = \"MNP\",\n MOZ = \"MOZ\",\n MRT = \"MRT\",\n MSR = \"MSR\",\n MTQ = \"MTQ\",\n MWI = \"MWI\",\n MYS = \"MYS\",\n MYT = \"MYT\",\n NAM = \"NAM\",\n NCL = \"NCL\",\n NER = \"NER\",\n NFK = \"NFK\",\n NGA = \"NGA\",\n NIC = \"NIC\",\n NIU = \"NIU\",\n NLD = \"NLD\",\n NOR = \"NOR\",\n NPL = \"NPL\",\n NRU = \"NRU\",\n NZL = \"NZL\",\n OMN = \"OMN\",\n PAK = \"PAK\",\n PAN = \"PAN\",\n PCN = \"PCN\",\n PER = \"PER\",\n PHL = \"PHL\",\n PLW = \"PLW\",\n PNG = \"PNG\",\n POL = \"POL\",\n PRI = \"PRI\",\n PRK = \"PRK\",\n PRT = \"PRT\",\n PRY = \"PRY\",\n PSE = \"PSE\",\n PYF = \"PYF\",\n QAT = \"QAT\",\n REU = \"REU\",\n ROU = \"ROU\",\n RUS = \"RUS\",\n RWA = \"RWA\",\n SAU = \"SAU\",\n SDN = \"SDN\",\n SEN = \"SEN\",\n SGP = \"SGP\",\n SGS = \"SGS\",\n SHN = \"SHN\",\n SJM = \"SJM\",\n SLB = \"SLB\",\n SLE = \"SLE\",\n SLV = \"SLV\",\n SMR = \"SMR\",\n SOM = \"SOM\",\n SPM = \"SPM\",\n SRB = \"SRB\",\n SSD = \"SSD\",\n STP = \"STP\",\n SUR = \"SUR\",\n SVK = \"SVK\",\n SVN = \"SVN\",\n SWE = \"SWE\",\n SWZ = \"SWZ\",\n SXM = \"SXM\",\n SYC = \"SYC\",\n SYR = \"SYR\",\n TCA = \"TCA\",\n TCD = \"TCD\",\n TGO = \"TGO\",\n THA = \"THA\",\n TJK = \"TJK\",\n TKL = \"TKL\",\n TKM = \"TKM\",\n TLS = \"TLS\",\n TON = \"TON\",\n TTO = \"TTO\",\n TUN = \"TUN\",\n TUR = \"TUR\",\n TUV = \"TUV\",\n TWN = \"TWN\",\n TZA = \"TZA\",\n UGA = \"UGA\",\n UKR = \"UKR\",\n URY = \"URY\",\n USA = \"USA\",\n UZB = \"UZB\",\n VAT = \"VAT\",\n VCT = \"VCT\",\n VEN = \"VEN\",\n VGB = \"VGB\",\n VIR = \"VIR\",\n VLC = \"VLC\",\n VNM = \"VNM\",\n VUT = \"VUT\",\n WLF = \"WLF\",\n WLS = \"WLS\",\n YEM = \"YEM\",\n ZAF = \"ZAF\",\n ZMB = \"ZMB\",\n ZWE = \"ZWE\"\n }\n enum ResolutionMethod {\n QUERY_PARAM = \"QUERY_PARAM\",\n SUBDOMAIN = \"SUBDOMAIN\",\n SUBDIRECTORY = \"SUBDIRECTORY\"\n }\n interface PagesData {\n /** Blog page. */\n blogPage?: PageInfo;\n /** Post page. */\n postPage?: PageInfo;\n /**\n * Site primary url.\n * @readonly\n */\n sitePrimaryUrl?: string | null;\n }\n interface PageInfo {\n /** Title. */\n title?: string;\n /** Page ID. */\n pageId?: string;\n /** Is hidden. */\n hidden?: boolean;\n /** Path. */\n path?: string;\n /** TPA page ID. */\n tpaPageId?: string | null;\n /** TPA embedded service ID. */\n tpaEmbeddedServiceId?: number | null;\n /** TPA app ID. */\n tpaAppId?: string | null;\n /** Page URL. */\n url?: string;\n /** Hidden path. */\n hiddenPath?: string | null;\n /** Is SM protected. */\n isSmProtected?: boolean;\n /** Is dynamic. */\n isDynamic?: boolean;\n /** Platform apps. */\n platformApps?: string[];\n }\n interface SiteProperties {\n /** Business name. */\n businessName?: string | null;\n /** Business logo. */\n logo?: string | null;\n /** Site display name. */\n siteDisplayName?: string | null;\n /** Description. */\n description?: string | null;\n }\n interface GetBlogCacheRequest {\n }\n interface GetBlogCacheResponse {\n /** Blog cache. */\n blogCache?: BlogCache;\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 /**\n * Set of properties that were updated - corresponds to the fields in \"properties\".\n * @internal\n */\n fields?: string[];\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?: 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 Wix user defined for their site (before the site visitor 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 to display the additional description - before, after, or instead of 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 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 Empty {\n }\n interface UrlInvalidationNotification {\n /** Blog instance id. */\n blogInstanceId?: string | null;\n /** Meta site id. */\n metaSiteId?: 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 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n /**\n * Gets blog cache.\n * @public\n * @documentationMaturity preview\n * @permissionId BLOG.READ_SETTINGS\n */\n function getBlogCache(): Promise;\n \n type blogV1BlogCache_universal_d_BlogCache = BlogCache;\n type blogV1BlogCache_universal_d_SiteSupportedLanguage = SiteSupportedLanguage;\n type blogV1BlogCache_universal_d_LocaleStatus = LocaleStatus;\n const blogV1BlogCache_universal_d_LocaleStatus: typeof LocaleStatus;\n type blogV1BlogCache_universal_d_Flag = Flag;\n const blogV1BlogCache_universal_d_Flag: typeof Flag;\n type blogV1BlogCache_universal_d_ResolutionMethod = ResolutionMethod;\n const blogV1BlogCache_universal_d_ResolutionMethod: typeof ResolutionMethod;\n type blogV1BlogCache_universal_d_PagesData = PagesData;\n type blogV1BlogCache_universal_d_PageInfo = PageInfo;\n type blogV1BlogCache_universal_d_SiteProperties = SiteProperties;\n type blogV1BlogCache_universal_d_GetBlogCacheRequest = GetBlogCacheRequest;\n type blogV1BlogCache_universal_d_GetBlogCacheResponse = GetBlogCacheResponse;\n type blogV1BlogCache_universal_d_SitePropertiesNotification = SitePropertiesNotification;\n type blogV1BlogCache_universal_d_SitePropertiesEvent = SitePropertiesEvent;\n type blogV1BlogCache_universal_d_Properties = Properties;\n type blogV1BlogCache_universal_d_Categories = Categories;\n type blogV1BlogCache_universal_d_Locale = Locale;\n type blogV1BlogCache_universal_d_Address = Address;\n type blogV1BlogCache_universal_d_AddressHint = AddressHint;\n type blogV1BlogCache_universal_d_PlacementType = PlacementType;\n const blogV1BlogCache_universal_d_PlacementType: typeof PlacementType;\n type blogV1BlogCache_universal_d_GeoCoordinates = GeoCoordinates;\n type blogV1BlogCache_universal_d_BusinessSchedule = BusinessSchedule;\n type blogV1BlogCache_universal_d_TimePeriod = TimePeriod;\n type blogV1BlogCache_universal_d_DayOfWeek = DayOfWeek;\n const blogV1BlogCache_universal_d_DayOfWeek: typeof DayOfWeek;\n type blogV1BlogCache_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type blogV1BlogCache_universal_d_Multilingual = Multilingual;\n type blogV1BlogCache_universal_d_SupportedLanguage = SupportedLanguage;\n type blogV1BlogCache_universal_d_ConsentPolicy = ConsentPolicy;\n type blogV1BlogCache_universal_d_Translation = Translation;\n type blogV1BlogCache_universal_d_ChangeContext = ChangeContext;\n type blogV1BlogCache_universal_d_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;\n type blogV1BlogCache_universal_d_PropertiesChange = PropertiesChange;\n type blogV1BlogCache_universal_d_SiteCreated = SiteCreated;\n type blogV1BlogCache_universal_d_SiteCloned = SiteCloned;\n type blogV1BlogCache_universal_d_Empty = Empty;\n type blogV1BlogCache_universal_d_UrlInvalidationNotification = UrlInvalidationNotification;\n const blogV1BlogCache_universal_d_getBlogCache: typeof getBlogCache;\n namespace blogV1BlogCache_universal_d {\n export {\n blogV1BlogCache_universal_d_BlogCache as BlogCache,\n blogV1BlogCache_universal_d_SiteSupportedLanguage as SiteSupportedLanguage,\n blogV1BlogCache_universal_d_LocaleStatus as LocaleStatus,\n blogV1BlogCache_universal_d_Flag as Flag,\n blogV1BlogCache_universal_d_ResolutionMethod as ResolutionMethod,\n blogV1BlogCache_universal_d_PagesData as PagesData,\n blogV1BlogCache_universal_d_PageInfo as PageInfo,\n blogV1BlogCache_universal_d_SiteProperties as SiteProperties,\n blogV1BlogCache_universal_d_GetBlogCacheRequest as GetBlogCacheRequest,\n blogV1BlogCache_universal_d_GetBlogCacheResponse as GetBlogCacheResponse,\n blogV1BlogCache_universal_d_SitePropertiesNotification as SitePropertiesNotification,\n blogV1BlogCache_universal_d_SitePropertiesEvent as SitePropertiesEvent,\n blogV1BlogCache_universal_d_Properties as Properties,\n blogV1BlogCache_universal_d_Categories as Categories,\n blogV1BlogCache_universal_d_Locale as Locale,\n blogV1BlogCache_universal_d_Address as Address,\n blogV1BlogCache_universal_d_AddressHint as AddressHint,\n blogV1BlogCache_universal_d_PlacementType as PlacementType,\n blogV1BlogCache_universal_d_GeoCoordinates as GeoCoordinates,\n blogV1BlogCache_universal_d_BusinessSchedule as BusinessSchedule,\n blogV1BlogCache_universal_d_TimePeriod as TimePeriod,\n blogV1BlogCache_universal_d_DayOfWeek as DayOfWeek,\n blogV1BlogCache_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n blogV1BlogCache_universal_d_Multilingual as Multilingual,\n blogV1BlogCache_universal_d_SupportedLanguage as SupportedLanguage,\n blogV1BlogCache_universal_d_ConsentPolicy as ConsentPolicy,\n blogV1BlogCache_universal_d_Translation as Translation,\n blogV1BlogCache_universal_d_ChangeContext as ChangeContext,\n blogV1BlogCache_universal_d_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf,\n blogV1BlogCache_universal_d_PropertiesChange as PropertiesChange,\n blogV1BlogCache_universal_d_SiteCreated as SiteCreated,\n blogV1BlogCache_universal_d_SiteCloned as SiteCloned,\n blogV1BlogCache_universal_d_Empty as Empty,\n blogV1BlogCache_universal_d_UrlInvalidationNotification as UrlInvalidationNotification,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n blogV1BlogCache_universal_d_getBlogCache as getBlogCache,\n };\n }\n \n interface ImportStatus {\n /** Import Id. */\n _id?: string;\n /** File name of wordpress xml file that is being imported. */\n fileName?: string;\n /** Status of the latest import. */\n status?: Status$2;\n /** Total amount of entities to be imported. */\n importAmount?: number;\n /** Amount of entities imported successfully. */\n alreadyImportedAmount?: number;\n /** Amount of entities processed. */\n processedAmount?: number;\n /** Url for the page that is being imported. */\n url?: string | null;\n }\n enum Status$2 {\n UNKNOWN = \"UNKNOWN\",\n READY_TO_IMPORT = \"READY_TO_IMPORT\",\n STARTED = \"STARTED\",\n FAILED = \"FAILED\",\n DONE = \"DONE\",\n PARSING_URL = \"PARSING_URL\"\n }\n interface StartImportRequest {\n /** Should publish the posts after import. */\n shouldPublish?: boolean | null;\n }\n interface StartImportResponse {\n }\n interface SubmitUrlForImportRequest {\n /** Url to wordpress xml file. */\n url: string;\n /** Domain of the site without www or https://. */\n siteDomain?: string | null;\n }\n interface SubmitUrlForImportResponse {\n }\n interface ValidateUrlForImportRequest {\n /** Url for wordpress site. */\n url: string | null;\n }\n interface ValidateUrlForImportResponse {\n /** Number of posts. */\n totalPosts?: number | null;\n /** Blog title. */\n blogTitle?: string | null;\n }\n interface GetImportStatusRequest {\n }\n interface GetImportStatusResponse {\n /** Details of import progress. */\n importStatus?: ImportStatus;\n }\n interface GetNotImportedPostsRequest {\n }\n interface GetNotImportedPostsResponse {\n /** Failed entities. */\n notImportedPosts?: Post$1[];\n }\n interface Post$1 {\n /** The id of the post. */\n _id?: string;\n /** Title of the post. */\n title?: string;\n /** Url to posts in wordpress. */\n url?: string;\n }\n /**\n * Starts wordpress import process.\n * @public\n * @documentationMaturity preview\n * @permissionId BLOG.IMPORT_FROM_EXTERNAL_SITES\n * @adminMethod\n */\n function startImport(options?: StartImportOptions): Promise;\n interface StartImportOptions {\n /** Should publish the posts after import. */\n shouldPublish?: boolean | null;\n }\n /**\n * Submits wordpress import process from URL.\n * It will prepare wordpress data for import from the given URL.\n * Use \"GetImportStatus\" to get the status of the import process.\n * Once the import status becomes READY_TO_IMPORT, the import process can be started by invoking \"StartImport\".\n * @param url - Url to wordpress xml file.\n * @public\n * @documentationMaturity preview\n * @requiredField url\n * @permissionId BLOG.IMPORT_FROM_EXTERNAL_SITES\n * @adminMethod\n */\n function submitUrlForImport(url: string, options?: SubmitUrlForImportOptions): Promise;\n interface SubmitUrlForImportOptions {\n /** Domain of the site without www or https://. */\n siteDomain?: string | null;\n }\n /** @param url - Url for wordpress site.\n * @public\n * @documentationMaturity preview\n * @requiredField url\n * @permissionId BLOG.IMPORT_FROM_EXTERNAL_SITES\n * @adminMethod\n */\n function validateUrlForImport(url: string | null): Promise;\n /**\n * Gets the status of the import process.\n * @public\n * @documentationMaturity preview\n * @permissionId BLOG.IMPORT_FROM_EXTERNAL_SITES\n * @adminMethod\n */\n function getImportStatus(): Promise;\n /**\n * Gets the posts that were not yet imported either because of an error or because import is still in progress.\n * @public\n * @documentationMaturity preview\n * @permissionId BLOG.IMPORT_FROM_EXTERNAL_SITES\n * @adminMethod\n */\n function getNotImportedPosts(): Promise;\n \n type blogV1WordpressImport_universal_d_ImportStatus = ImportStatus;\n type blogV1WordpressImport_universal_d_StartImportRequest = StartImportRequest;\n type blogV1WordpressImport_universal_d_StartImportResponse = StartImportResponse;\n type blogV1WordpressImport_universal_d_SubmitUrlForImportRequest = SubmitUrlForImportRequest;\n type blogV1WordpressImport_universal_d_SubmitUrlForImportResponse = SubmitUrlForImportResponse;\n type blogV1WordpressImport_universal_d_ValidateUrlForImportRequest = ValidateUrlForImportRequest;\n type blogV1WordpressImport_universal_d_ValidateUrlForImportResponse = ValidateUrlForImportResponse;\n type blogV1WordpressImport_universal_d_GetImportStatusRequest = GetImportStatusRequest;\n type blogV1WordpressImport_universal_d_GetImportStatusResponse = GetImportStatusResponse;\n type blogV1WordpressImport_universal_d_GetNotImportedPostsRequest = GetNotImportedPostsRequest;\n type blogV1WordpressImport_universal_d_GetNotImportedPostsResponse = GetNotImportedPostsResponse;\n const blogV1WordpressImport_universal_d_startImport: typeof startImport;\n type blogV1WordpressImport_universal_d_StartImportOptions = StartImportOptions;\n const blogV1WordpressImport_universal_d_submitUrlForImport: typeof submitUrlForImport;\n type blogV1WordpressImport_universal_d_SubmitUrlForImportOptions = SubmitUrlForImportOptions;\n const blogV1WordpressImport_universal_d_validateUrlForImport: typeof validateUrlForImport;\n const blogV1WordpressImport_universal_d_getImportStatus: typeof getImportStatus;\n const blogV1WordpressImport_universal_d_getNotImportedPosts: typeof getNotImportedPosts;\n namespace blogV1WordpressImport_universal_d {\n export {\n blogV1WordpressImport_universal_d_ImportStatus as ImportStatus,\n Status$2 as Status,\n blogV1WordpressImport_universal_d_StartImportRequest as StartImportRequest,\n blogV1WordpressImport_universal_d_StartImportResponse as StartImportResponse,\n blogV1WordpressImport_universal_d_SubmitUrlForImportRequest as SubmitUrlForImportRequest,\n blogV1WordpressImport_universal_d_SubmitUrlForImportResponse as SubmitUrlForImportResponse,\n blogV1WordpressImport_universal_d_ValidateUrlForImportRequest as ValidateUrlForImportRequest,\n blogV1WordpressImport_universal_d_ValidateUrlForImportResponse as ValidateUrlForImportResponse,\n blogV1WordpressImport_universal_d_GetImportStatusRequest as GetImportStatusRequest,\n blogV1WordpressImport_universal_d_GetImportStatusResponse as GetImportStatusResponse,\n blogV1WordpressImport_universal_d_GetNotImportedPostsRequest as GetNotImportedPostsRequest,\n blogV1WordpressImport_universal_d_GetNotImportedPostsResponse as GetNotImportedPostsResponse,\n Post$1 as Post,\n blogV1WordpressImport_universal_d_startImport as startImport,\n blogV1WordpressImport_universal_d_StartImportOptions as StartImportOptions,\n blogV1WordpressImport_universal_d_submitUrlForImport as submitUrlForImport,\n blogV1WordpressImport_universal_d_SubmitUrlForImportOptions as SubmitUrlForImportOptions,\n blogV1WordpressImport_universal_d_validateUrlForImport as validateUrlForImport,\n blogV1WordpressImport_universal_d_getImportStatus as getImportStatus,\n blogV1WordpressImport_universal_d_getNotImportedPosts as getNotImportedPosts,\n };\n }\n \n interface Category$2 {\n /** Category ID. */\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 * The `url` of the page that lists every post with the specified category.\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /**\n * Category title.\n * @deprecated Category title.\n * @targetRemovalDate 2025-07-16\n */\n title?: string;\n /**\n * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).\n * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.\n *\n * Default: `-1`\n */\n displayPosition?: number | null;\n /** ID of the category's translations. All translations of a single category share the same `translationId`. */\n translationId?: string | null;\n /**\n * Category language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */\n slug?: string;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$3;\n /** Category cover image. */\n coverImage?: string;\n /**\n * Category translations.\n * @internal\n * @readonly\n */\n translations?: CategoryTranslation$2[];\n /**\n * Date and time the Category was last updated.\n * @readonly\n */\n _updatedDate?: Date | 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$3 {\n /** SEO tag information. */\n tags?: Tag$3[];\n /** SEO general settings. */\n settings?: Settings$3;\n }\n interface Keyword$3 {\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$3 {\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$3 {\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$3[];\n }\n interface FocalPoint$2 {\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 CategoryTranslation$2 {\n /** Category ID. */\n _id?: string;\n /** Label displayed in the categories menu on the site. */\n label?: string | null;\n /** Language of the category. */\n language?: string | null;\n /** URL of this category page. */\n url?: string;\n }\n interface InitialCategoriesCopied {\n /** Number of categories copied. */\n count?: number;\n }\n interface CreateCategoryRequest {\n /** Category info. */\n category: Category$2;\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n enum Field$3 {\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 /** Includes translations. */\n TRANSLATIONS = \"TRANSLATIONS\"\n }\n interface CreateCategoryResponse {\n /** Category info. */\n category?: Category$2;\n }\n interface BulkCreateCategoriesRequest {\n /** Categories to create. */\n categories: Category$2[];\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. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n interface BulkCreateCategoriesResponse {\n /** Categories created by bulk action. */\n results?: BulkCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkCategoryResult {\n /** Bulk actions metadata for category. */\n itemMetadata?: ItemMetadata$2;\n /** Optional created category. */\n item?: Category$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 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 additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n interface MaskedCategory {\n /** Category */\n category?: Category$2;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateCategoriesResponse {\n /** Categories updated by bulk action. */\n results?: BulkCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface UpdateCategoryRequest {\n /** Category info. */\n category: Category$2;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n interface UpdateCategoryResponse {\n /** Category info. */\n category?: Category$2;\n }\n interface GetCategoriesCountByLanguageRequest {\n }\n interface GetCategoriesCountByLanguageResponse {\n /** The language and it's count. */\n categoriesLanguageCount?: CategoryLanguageCount[];\n }\n interface CategoryLanguageCount {\n /** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */\n languageCode?: string | null;\n /** The count of Categories for the language. */\n categoryCount?: number | null;\n }\n interface GetCategoryRequest {\n /** Category ID. */\n categoryId: string;\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n interface GetCategoryResponse {\n /** Category info. */\n category?: Category$2;\n }\n interface GetCategoryBySlugRequest {\n /** Slug of the category to retrieve. */\n slug: string;\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n /**\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Language of the category to retrieve.\n */\n language?: string | null;\n }\n interface GetCategoryBySlugResponse {\n /** Category info. */\n category?: Category$2;\n }\n interface ListCategoriesRequest {\n /** Pagination options. */\n paging?: BlogPaging$2;\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Pass a language to only receive categories that are in that language.\n * If omitted, categories in all languages are returned.\n */\n language?: string | null;\n }\n interface BlogPaging$2 {\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 * 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$2[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData$3;\n }\n interface MetaData$3 {\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 QueryCategoriesRequest {\n /** Query options. */\n query?: PlatformQuery$3;\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n interface PlatformQuery$3 extends PlatformQueryPagingMethodOneOf$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$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 PlatformQueryPagingMethodOneOf$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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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$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 QueryCategoriesResponse {\n /** List of categories. */\n categories?: Category$2[];\n /** Details on the paged set of results returned. */\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$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 * @internal\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 BulkDeleteCategoryRequest {\n /** Category IDs. */\n categoryIds: string[];\n /** Should delete bypassing the trash-bin. */\n permanent?: boolean;\n }\n interface BulkDeleteCategoryResponse {\n }\n interface DeleteCategoryRequest {\n /** Category ID. */\n categoryId: string;\n }\n interface DeleteCategoryResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 category.\n * @param category - Category info.\n * @internal\n * @documentationMaturity preview\n * @requiredField category\n * @requiredField category.label\n * @permissionId BLOG.CREATE-CATEGORY\n * @adminMethod\n * @returns Category info.\n */\n function createCategory(category: Category$2, options?: CreateCategoryOptions): Promise;\n interface CreateCategoryOptions {\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n /**\n * Creates multiple categories.\n * @param categories - Categories to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField categories\n * @requiredField categories.label\n * @permissionId BLOG.CREATE-CATEGORY\n * @adminMethod\n */\n function bulkCreateCategories(categories: Category$2[], options?: BulkCreateCategoriesOptions): Promise;\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. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n /**\n * Updates multiple categories.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.categories.category\n * @requiredField options.categories.category._id\n * @permissionId BLOG.EDIT-CATEGORY\n * @adminMethod\n */\n function bulkUpdateCategories(options?: BulkUpdateCategoriesOptions): Promise;\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 additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n /**\n * Updates a category.\n * @param _id - Category ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField category\n * @permissionId BLOG.EDIT-CATEGORY\n * @adminMethod\n * @returns Category info.\n */\n function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise;\n interface UpdateCategory {\n /** Category ID. */\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 * The `url` of the page that lists every post with the specified category.\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /**\n * Category title.\n * @deprecated Category title.\n * @targetRemovalDate 2025-07-16\n */\n title?: string;\n /**\n * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).\n * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.\n *\n * Default: `-1`\n */\n displayPosition?: number | null;\n /** ID of the category's translations. All translations of a single category share the same `translationId`. */\n translationId?: string | null;\n /**\n * Category language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */\n slug?: string;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n /** SEO data. */\n seoData?: SeoSchema$3;\n /** Category cover image. */\n coverImage?: string;\n /**\n * Category translations.\n * @internal\n * @readonly\n */\n translations?: CategoryTranslation$2[];\n /**\n * Date and time the Category was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface UpdateCategoryOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n /**\n * Retrieves a count of categories for every site language.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ-CATEGORY\n */\n function getCategoriesCountByLanguage(): Promise;\n /**\n * Gets a category with the specified ID.\n * @param categoryId - Category ID.\n * @public\n * @requiredField categoryId\n * @param options - Options specifying which fields to return.\n * @permissionId BLOG.READ-CATEGORY\n */\n function getCategory(categoryId: string, options?: GetCategoryOptions): Promise;\n interface GetCategoryOptions {\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n }\n /**\n * Gets a category with the specified slug.\n *\n * The slug is at the end of the URL of a specific category.\n * For example, if a category's URL is `https://example.com/blog/categories/famous-cats`, the slug is `famous-cats`.\n * The slug is a case-sensitive string that is derived from the category's label, unless specified otherwise.\n * @public\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 * @permissionId BLOG.READ-CATEGORY\n */\n function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise;\n interface GetCategoryBySlugOptions {\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n /**\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Language of the category to retrieve.\n */\n language?: string | null;\n }\n /**\n * Retrieves a list of up to 100 categories per request.\n *\n * If you pass a language filter to the method, it returns a list of up to 100 categories in the requested language.\n *\n * The categoies are displayed in order of their `displayPosition`, starting with `0`. The `displayPosition` is the position in which the categories\n * are displayed in the Category Menu page. By default, categories get added to the bottom of the Category Menu page with a `displayPosition` of `-1`.\n *\n * List Categories runs with these defaults, which you can override:\n * - `paging.limit` is `50`.\n * - `paging.offset` is `0`.\n *\n * List Categories is sorted by `displayPosition` in descending order. This cannot be overridden.\n * @public\n * @param options - Filter and paging options.\n * @permissionId BLOG.READ-CATEGORY\n */\n function listCategories(options?: ListCategoriesOptions): Promise;\n interface ListCategoriesOptions {\n /** Pagination options. */\n paging?: BlogPaging$2;\n /**\n * List of additional category fields to include in the response. By default\n * only the category’s base fields are returned. Base fields are all category fields that don't appear in the fieldset enum.\n *\n * To retrieve a field, pass the relevant fieldset in the enum in the `fieldsets` array. For example, add the `URL` fieldset to `fieldsets` to\n * retrieve the url field in the response in addition to the category’s base fields.\n */\n fieldsets?: Field$3[];\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Pass a language to only receive categories that are in that language.\n * If omitted, categories in all languages are returned.\n */\n language?: string | null;\n }\n /**\n * Creates a query to retrieve a list of categories.\n *\n *\n * The Query Categories method builds a query to retrieve a list of up to 100 categories per language, and returns a [`CategoriesQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending) object.\n *\n * The response contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/find) method.\n *\n * You can refine the query by chaining `CategoriesQueryBuilder` methods to the query. `CategoriesQueryBuilder` methods enable you to sort, filter, and control the results that Query Categories returns. Any methods chained to the Query Categories method are applied in the order that they are called.\n *\n * Query Categories runs with these `CategoriesQueryBuilder` defaults, which you can override.\n * - [`limit(100)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/limit)\n * - [`ascending(displayPosition)`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-builder/ascending)\n *\n * The following `CategoriesQueryBuilder` methods are supported for Query Categories. For a full description of the `Categories` object, see the response for the [`items`](https://dev.wix.com/docs/sdk/backend-modules/blog/categories/categories-query-result/items) property in [`CategoriesQueryResult`](https://www.wix.com/velo/reference/wix-blog-backend/categories/categoriesqueryresult).\n * @public\n * @param options - Options specifying which fields to return.\n * @permissionId BLOG.READ-CATEGORY\n */\n function queryCategories(options?: QueryCategoriesOptions): CategoriesQueryBuilder;\n interface QueryCategoriesOptions {\n /** */\n fieldsets?: Field$3[] | 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$2[];\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' | 'label' | 'postCount' | 'title' | 'displayPosition' | 'translationId' | 'language' | 'slug', value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: '_id' | 'label' | 'postCount' | 'title' | 'displayPosition' | 'translationId' | 'language' | 'slug', value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: 'postCount' | 'displayPosition', value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: 'label' | 'title', value: string) => CategoriesQueryBuilder;\n in: (propertyName: '_id' | 'label' | 'postCount' | 'title' | 'displayPosition' | 'translationId' | 'language' | 'slug', value: any) => CategoriesQueryBuilder;\n exists: (propertyName: 'label' | 'title' | 'translationId' | 'language' | 'slug', value: boolean) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<'label' | 'postCount' | 'title' | 'displayPosition' | 'language' | 'slug'>) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'label' | 'postCount' | 'title' | 'displayPosition' | 'language' | 'slug'>) => 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 * Bulk delete for categories\n * @param categoryIds - Category IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryIds\n * @permissionId BLOG.DELETE-CATEGORY\n * @adminMethod\n */\n function bulkDeleteCategory(categoryIds: string[], options?: BulkDeleteCategoryOptions): Promise;\n interface BulkDeleteCategoryOptions {\n /** Should delete bypassing the trash-bin. */\n permanent?: boolean;\n }\n /**\n * Deletes a category.\n * @param categoryId - Category ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId BLOG.DELETE-CATEGORY\n * @adminMethod\n */\n function deleteCategory(categoryId: string): 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_GetCategoriesCountByLanguageRequest = GetCategoriesCountByLanguageRequest;\n type blogV3Category_universal_d_GetCategoriesCountByLanguageResponse = GetCategoriesCountByLanguageResponse;\n type blogV3Category_universal_d_CategoryLanguageCount = CategoryLanguageCount;\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_BulkDeleteCategoryRequest = BulkDeleteCategoryRequest;\n type blogV3Category_universal_d_BulkDeleteCategoryResponse = BulkDeleteCategoryResponse;\n type blogV3Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type blogV3Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n const blogV3Category_universal_d_createCategory: typeof createCategory;\n type blogV3Category_universal_d_CreateCategoryOptions = CreateCategoryOptions;\n const blogV3Category_universal_d_bulkCreateCategories: typeof bulkCreateCategories;\n type blogV3Category_universal_d_BulkCreateCategoriesOptions = BulkCreateCategoriesOptions;\n const blogV3Category_universal_d_bulkUpdateCategories: typeof bulkUpdateCategories;\n type blogV3Category_universal_d_BulkUpdateCategoriesOptions = BulkUpdateCategoriesOptions;\n const blogV3Category_universal_d_updateCategory: typeof updateCategory;\n type blogV3Category_universal_d_UpdateCategory = UpdateCategory;\n type blogV3Category_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const blogV3Category_universal_d_getCategoriesCountByLanguage: typeof getCategoriesCountByLanguage;\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 const blogV3Category_universal_d_bulkDeleteCategory: typeof bulkDeleteCategory;\n type blogV3Category_universal_d_BulkDeleteCategoryOptions = BulkDeleteCategoryOptions;\n const blogV3Category_universal_d_deleteCategory: typeof deleteCategory;\n namespace blogV3Category_universal_d {\n export {\n Category$2 as Category,\n SeoSchema$3 as SeoSchema,\n Keyword$3 as Keyword,\n Tag$3 as Tag,\n Settings$3 as Settings,\n FocalPoint$2 as FocalPoint,\n CategoryTranslation$2 as CategoryTranslation,\n blogV3Category_universal_d_InitialCategoriesCopied as InitialCategoriesCopied,\n blogV3Category_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n Field$3 as Field,\n blogV3Category_universal_d_CreateCategoryResponse as CreateCategoryResponse,\n blogV3Category_universal_d_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest,\n blogV3Category_universal_d_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse,\n blogV3Category_universal_d_BulkCategoryResult as BulkCategoryResult,\n ItemMetadata$2 as ItemMetadata,\n ApplicationError$2 as ApplicationError,\n BulkActionMetadata$2 as BulkActionMetadata,\n blogV3Category_universal_d_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest,\n blogV3Category_universal_d_MaskedCategory as MaskedCategory,\n blogV3Category_universal_d_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse,\n blogV3Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n blogV3Category_universal_d_UpdateCategoryResponse as UpdateCategoryResponse,\n blogV3Category_universal_d_GetCategoriesCountByLanguageRequest as GetCategoriesCountByLanguageRequest,\n blogV3Category_universal_d_GetCategoriesCountByLanguageResponse as GetCategoriesCountByLanguageResponse,\n blogV3Category_universal_d_CategoryLanguageCount as CategoryLanguageCount,\n blogV3Category_universal_d_GetCategoryRequest as GetCategoryRequest,\n blogV3Category_universal_d_GetCategoryResponse as GetCategoryResponse,\n blogV3Category_universal_d_GetCategoryBySlugRequest as GetCategoryBySlugRequest,\n blogV3Category_universal_d_GetCategoryBySlugResponse as GetCategoryBySlugResponse,\n blogV3Category_universal_d_ListCategoriesRequest as ListCategoriesRequest,\n BlogPaging$2 as BlogPaging,\n blogV3Category_universal_d_ListCategoriesResponse as ListCategoriesResponse,\n MetaData$3 as MetaData,\n blogV3Category_universal_d_QueryCategoriesRequest as QueryCategoriesRequest,\n PlatformQuery$3 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$3 as PlatformQueryPagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n Paging$3 as Paging,\n CursorPaging$3 as CursorPaging,\n blogV3Category_universal_d_QueryCategoriesResponse as QueryCategoriesResponse,\n PagingMetadataV2$3 as PagingMetadataV2,\n Cursors$3 as Cursors,\n blogV3Category_universal_d_BulkDeleteCategoryRequest as BulkDeleteCategoryRequest,\n blogV3Category_universal_d_BulkDeleteCategoryResponse as BulkDeleteCategoryResponse,\n blogV3Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n blogV3Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n blogV3Category_universal_d_createCategory as createCategory,\n blogV3Category_universal_d_CreateCategoryOptions as CreateCategoryOptions,\n blogV3Category_universal_d_bulkCreateCategories as bulkCreateCategories,\n blogV3Category_universal_d_BulkCreateCategoriesOptions as BulkCreateCategoriesOptions,\n blogV3Category_universal_d_bulkUpdateCategories as bulkUpdateCategories,\n blogV3Category_universal_d_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions,\n blogV3Category_universal_d_updateCategory as updateCategory,\n blogV3Category_universal_d_UpdateCategory as UpdateCategory,\n blogV3Category_universal_d_UpdateCategoryOptions as UpdateCategoryOptions,\n blogV3Category_universal_d_getCategoriesCountByLanguage as getCategoriesCountByLanguage,\n blogV3Category_universal_d_getCategory as getCategory,\n blogV3Category_universal_d_GetCategoryOptions as GetCategoryOptions,\n blogV3Category_universal_d_getCategoryBySlug as getCategoryBySlug,\n blogV3Category_universal_d_GetCategoryBySlugOptions as GetCategoryBySlugOptions,\n blogV3Category_universal_d_listCategories as listCategories,\n blogV3Category_universal_d_ListCategoriesOptions as ListCategoriesOptions,\n blogV3Category_universal_d_queryCategories as queryCategories,\n blogV3Category_universal_d_QueryCategoriesOptions as QueryCategoriesOptions,\n blogV3Category_universal_d_CategoriesQueryResult as CategoriesQueryResult,\n blogV3Category_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder,\n blogV3Category_universal_d_bulkDeleteCategory as bulkDeleteCategory,\n blogV3Category_universal_d_BulkDeleteCategoryOptions as BulkDeleteCategoryOptions,\n blogV3Category_universal_d_deleteCategory as deleteCategory,\n };\n }\n \n interface DraftPost$1 {\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 /**\n * __Deprecated.__ Use `media` instead.\n * This property will be removed on June 6, 2023.\n *\n * Draft post cover media.\n * @internal\n * @deprecated\n * @replacedBy media\n * @targetRemovalDate 2024-06-30\n */\n coverMedia?: CoverMedia$1;\n /** Draft post owner's member ID. */\n memberId?: string | null;\n /** Hashtags in the draft 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. 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 * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.\n */\n translationId?: string | null;\n /**\n * Language the draft post is written in.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n changeOrigin?: Origin$1;\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$1;\n /**\n * Status of the draft post.\n * @readonly\n */\n status?: Status$1;\n /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */\n moderationDetails?: ModerationDetails$1;\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 | null;\n /**\n * Date the draft post is scheduled to be published.\n * @readonly\n */\n scheduledPublishDate?: Date | null;\n /** Reserved for internal use. */\n content?: Record | null;\n /** Date the post was first published. */\n firstPublishedDate?: Date | null;\n /** SEO data. */\n seoData?: SeoSchema$2;\n /**\n * @internal Deprecated.\n * @internal Deprecated.\n * @deprecated\n * @replacedBy preview_text_paragraph\n * @targetRemovalDate 2024-06-30\n */\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 | null;\n /** SEO slug. */\n seoSlug?: string | null;\n /** Post cover media. */\n media?: Media$1;\n /** Number of paragraphs to display in a paid content preview for non-paying users. */\n previewTextParagraph?: number | null;\n /**\n * List of the post's translated posts.\n * @internal\n * @readonly\n */\n translations?: DraftPostTranslation$1[];\n /**\n * Reserved for internal use, not included in base response.\n * @internal\n */\n originPostId?: string | null;\n /**\n * Reserved for internal use, not included in base response.\n * @internal\n */\n originPostInstanceId?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n }\n interface CoverMedia$1 extends CoverMediaMediaOneOf$1 {\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\n /**\n * Is cover media enabled.\n * Selected by user whether to display cover media on the feed\n * @deprecated Is cover media enabled.\n * Selected by user whether to display cover media on the feed\n * @replacedBy displayed\n * @targetRemovalDate 2024-06-30\n */\n enabled?: boolean;\n /** Whether cover media is displayed. */\n displayed?: boolean;\n /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */\n custom?: boolean;\n }\n /** @oneof */\n interface CoverMediaMediaOneOf$1 {\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\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 enum Origin$1 {\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 /** Post was pinned */\n PIN = \"PIN\",\n /** Post was unpinned */\n UNPIN = \"UNPIN\",\n /** Saved automatically by AI tool. */\n AI_AUTO_SAVE = \"AI_AUTO_SAVE\"\n }\n interface RichContent$1 {\n /** Node objects representing a rich content document. */\n nodes?: Node$1[];\n /** Object metadata. */\n metadata?: Metadata$1;\n /** Global styling for header, paragraph, block quote, and code block nodes in the object. */\n documentStyle?: DocumentStyle$1;\n }\n interface Node$1 extends NodeDataOneOf$1 {\n /** Data for a button node. */\n buttonData?: ButtonData$1;\n /** Data for a code block node. */\n codeBlockData?: CodeBlockData$1;\n /** Data for a divider node. */\n dividerData?: DividerData$1;\n /** Data for a file node. */\n fileData?: FileData$1;\n /** Data for a gallery node. */\n galleryData?: GalleryData$1;\n /** Data for a GIF node. */\n gifData?: GIFData$1;\n /** Data for a heading node. */\n headingData?: HeadingData$1;\n /** Data for an embedded HTML node. */\n htmlData?: HTMLData$1;\n /** Data for an image node. */\n imageData?: ImageData$1;\n /** Data for a link preview node. */\n linkPreviewData?: LinkPreviewData$1;\n /** Data for a map node. */\n mapData?: MapData$1;\n /** Data for a paragraph node. */\n paragraphData?: ParagraphData$1;\n /** Data for a poll node. */\n pollData?: PollData$1;\n /** Data for a text node. Used to apply decorations to text. */\n textData?: TextData$1;\n /** Data for an app embed node. */\n appEmbedData?: AppEmbedData$1;\n /** Data for a video node. */\n videoData?: VideoData$1;\n /** Data for an oEmbed node. */\n embedData?: EmbedData$1;\n /** Data for a collapsible list node. */\n collapsibleListData?: CollapsibleListData$1;\n /** Data for a table node. */\n tableData?: TableData$1;\n /** Data for a table cell node. */\n tableCellData?: TableCellData$1;\n /** Data for a custom external node. */\n externalData?: Record | null;\n /** Data for an audio node. */\n audioData?: AudioData$1;\n /** Data for an ordered list node. */\n orderedListData?: OrderedListData$1;\n /** Data for a bulleted list node. */\n bulletedListData?: BulletedListData$1;\n /** Data for a block quote node. */\n blockquoteData?: BlockquoteData$1;\n /** Data for a caption node. */\n captionData?: CaptionData$1;\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$1;\n /** Node ID. */\n _id?: string;\n /** A list of child nodes. */\n nodes?: Node$1[];\n /** Padding and background color styling for the node. */\n style?: NodeStyle$1;\n }\n /** @oneof */\n interface NodeDataOneOf$1 {\n /** Data for a button node. */\n buttonData?: ButtonData$1;\n /** Data for a code block node. */\n codeBlockData?: CodeBlockData$1;\n /** Data for a divider node. */\n dividerData?: DividerData$1;\n /** Data for a file node. */\n fileData?: FileData$1;\n /** Data for a gallery node. */\n galleryData?: GalleryData$1;\n /** Data for a GIF node. */\n gifData?: GIFData$1;\n /** Data for a heading node. */\n headingData?: HeadingData$1;\n /** Data for an embedded HTML node. */\n htmlData?: HTMLData$1;\n /** Data for an image node. */\n imageData?: ImageData$1;\n /** Data for a link preview node. */\n linkPreviewData?: LinkPreviewData$1;\n /** Data for a map node. */\n mapData?: MapData$1;\n /** Data for a paragraph node. */\n paragraphData?: ParagraphData$1;\n /** Data for a poll node. */\n pollData?: PollData$1;\n /** Data for a text node. Used to apply decorations to text. */\n textData?: TextData$1;\n /** Data for an app embed node. */\n appEmbedData?: AppEmbedData$1;\n /** Data for a video node. */\n videoData?: VideoData$1;\n /** Data for an oEmbed node. */\n embedData?: EmbedData$1;\n /** Data for a collapsible list node. */\n collapsibleListData?: CollapsibleListData$1;\n /** Data for a table node. */\n tableData?: TableData$1;\n /** Data for a table cell node. */\n tableCellData?: TableCellData$1;\n /** Data for a custom external node. */\n externalData?: Record | null;\n /** Data for an audio node. */\n audioData?: AudioData$1;\n /** Data for an ordered list node. */\n orderedListData?: OrderedListData$1;\n /** Data for a bulleted list node. */\n bulletedListData?: BulletedListData$1;\n /** Data for a block quote node. */\n blockquoteData?: BlockquoteData$1;\n /** Data for a caption node. */\n captionData?: CaptionData$1;\n }\n enum NodeType$1 {\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 CAPTION = \"CAPTION\"\n }\n interface NodeStyle$1 {\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$1 {\n /** Styling for the button's container. */\n containerData?: PluginContainerData$1;\n /** The button type. */\n type?: ButtonDataType;\n /** Styling for the button. */\n styles?: Styles$1;\n /** The text to display on the button. */\n text?: string | null;\n /** Button link details. */\n link?: Link$1;\n }\n interface Border$1 {\n /** Border width in pixels. */\n width?: number | null;\n /** Border radius in pixels. */\n radius?: number | null;\n }\n interface Colors$1 {\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$1 {\n /** The width of the node when it's displayed. */\n width?: PluginContainerDataWidth$1;\n /** The node's alignment within its container. */\n alignment?: PluginContainerDataAlignment$1;\n /** Spoiler cover settings for the node. */\n spoiler?: Spoiler$1;\n /** The height of the node when it's displayed. */\n height?: Height$1;\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. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */\n textWrap?: boolean | null;\n }\n enum WidthType$1 {\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$1 extends PluginContainerDataWidthDataOneOf$1 {\n /**\n * One of the following predefined width options:\n * `CONTENT`: The width of the container matches the content width.\n * `SMALL`: A small width.\n * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.\n */\n size?: WidthType$1;\n /** A custom width value in pixels. */\n custom?: string | null;\n }\n /** @oneof */\n interface PluginContainerDataWidthDataOneOf$1 {\n /**\n * One of the following predefined width options:\n * `CONTENT`: The width of the container matches the content width.\n * `SMALL`: A small width.\n * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.\n */\n size?: WidthType$1;\n /** A custom width value in pixels. */\n custom?: string | null;\n }\n enum PluginContainerDataAlignment$1 {\n /** Center Alignment */\n CENTER = \"CENTER\",\n /** Left Alignment */\n LEFT = \"LEFT\",\n /** Right Alignment */\n RIGHT = \"RIGHT\"\n }\n interface Spoiler$1 {\n /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */\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$1 {\n /** A custom height value in pixels. */\n custom?: string | null;\n }\n enum ButtonDataType {\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$1 {\n /** Border attributes. */\n border?: Border$1;\n /** Color attributes. */\n colors?: Colors$1;\n }\n interface Link$1 extends LinkDataOneOf$1 {\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 * The 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$1;\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$1;\n /** A serialized object used for a custom or external link panel. */\n customData?: string | null;\n }\n /** @oneof */\n interface LinkDataOneOf$1 {\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$1 {\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$1 {\n /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */\n nofollow?: boolean | null;\n /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */\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. Defaults to `false`. */\n ugc?: boolean | null;\n /** Indicates that this link protects referral information from being passed to the target website. */\n noreferrer?: boolean | null;\n }\n interface CodeBlockData$1 {\n /** Styling for the code block's text. */\n textStyle?: TextStyle$1;\n }\n interface TextStyle$1 {\n /** Text alignment. Defaults to `AUTO`. */\n textAlignment?: TextAlignment$1;\n /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */\n lineHeight?: string | null;\n }\n enum TextAlignment$1 {\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$1 {\n /** Styling for the divider's container. */\n containerData?: PluginContainerData$1;\n /** Divider line style. */\n lineStyle?: LineStyle$1;\n /** Divider width. */\n width?: Width$1;\n /** Divider alignment. */\n alignment?: Alignment$1;\n }\n enum LineStyle$1 {\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$1 {\n /** Large line */\n LARGE = \"LARGE\",\n /** Medium line */\n MEDIUM = \"MEDIUM\",\n /** Small line */\n SMALL = \"SMALL\"\n }\n enum Alignment$1 {\n /** Center alignment */\n CENTER = \"CENTER\",\n /** Left alignment */\n LEFT = \"LEFT\",\n /** Right alignment */\n RIGHT = \"RIGHT\"\n }\n interface FileData$1 {\n /** Styling for the file's container. */\n containerData?: PluginContainerData$1;\n /** The source for the file's data. */\n src?: FileSource$1;\n /** File name. */\n name?: string | null;\n /** File type. */\n type?: string | null;\n /**\n * Use `sizeInKb` instead.\n * @deprecated\n */\n size?: number | null;\n /** Settings for PDF files. */\n pdfSettings?: PDFSettings$1;\n /** File MIME type. */\n mimeType?: string | null;\n /** File path. */\n path?: string | null;\n /** File size in KB. */\n sizeInKb?: string | null;\n }\n enum ViewMode$1 {\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$1 extends FileSourceDataOneOf$1 {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n private?: boolean | null;\n }\n /** @oneof */\n interface FileSourceDataOneOf$1 {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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$1 {\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$1;\n /** Sets whether the PDF download button is disabled. Defaults to `false`. */\n disableDownload?: boolean | null;\n /** Sets whether the PDF print button is disabled. Defaults to `false`. */\n disablePrint?: boolean | null;\n }\n interface GalleryData$1 {\n /** Styling for the gallery's container. */\n containerData?: PluginContainerData$1;\n /** The items in the gallery. */\n items?: Item$1[];\n /** Options for defining the gallery's appearance. */\n options?: GalleryOptions$1;\n /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */\n disableExpand?: boolean | null;\n /** Sets whether the gallery's download button is disabled. Defaults to `false`. */\n disableDownload?: boolean | null;\n }\n interface V1Media {\n /** The source for the media's data. */\n src?: FileSource$1;\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$1 {\n /** Image file details. */\n media?: V1Media;\n /** Link details for images that are links. */\n link?: Link$1;\n }\n interface Video$1 {\n /** Video file details. */\n media?: V1Media;\n /** Video thumbnail file details. */\n thumbnail?: V1Media;\n }\n interface Item$1 extends ItemDataOneOf$1 {\n /** An image item. */\n image?: Image$1;\n /** A video item. */\n video?: Video$1;\n /** Item title. */\n title?: string | null;\n /** Item's alternative text. */\n altText?: string | null;\n }\n /** @oneof */\n interface ItemDataOneOf$1 {\n /** An image item. */\n image?: Image$1;\n /** A video item. */\n video?: Video$1;\n }\n interface GalleryOptions$1 {\n /** Gallery layout. */\n layout?: Layout$1;\n /** Styling for gallery items. */\n item?: ItemStyle$1;\n /** Styling for gallery thumbnail images. */\n thumbnails?: Thumbnails$1;\n }\n enum LayoutType$1 {\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$1 {\n /** Rows Orientation */\n ROWS = \"ROWS\",\n /** Columns Orientation */\n COLUMNS = \"COLUMNS\"\n }\n enum Crop$1 {\n /** Crop to fill */\n FILL = \"FILL\",\n /** Crop to fit */\n FIT = \"FIT\"\n }\n enum ThumbnailsAlignment$1 {\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$1 {\n /** Gallery layout type. */\n type?: LayoutType$1;\n /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */\n horizontalScroll?: boolean | null;\n /** Gallery orientation. */\n orientation?: Orientation$1;\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$1 {\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$1;\n /** The spacing between items in pixels. */\n spacing?: number | null;\n }\n interface Thumbnails$1 {\n /** Thumbnail alignment. */\n placement?: ThumbnailsAlignment$1;\n /** Spacing between thumbnails in pixels. */\n spacing?: number | null;\n }\n interface GIFData$1 {\n /** Styling for the GIF's container. */\n containerData?: PluginContainerData$1;\n /** The source of the full size GIF. */\n original?: GIF$1;\n /** The source of the downsized GIF. */\n downsized?: GIF$1;\n /** Height in pixels. */\n height?: number;\n /** Width in pixels. */\n width?: number;\n }\n interface GIF$1 {\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$1 {\n /** Heading level from 1-6. */\n level?: number;\n /** Styling for the heading text. */\n textStyle?: TextStyle$1;\n /** Indentation level from 1-4. */\n indentation?: number | null;\n }\n interface HTMLData$1 extends HTMLDataDataOneOf$1 {\n /** The URL for the HTML code for the node. */\n url?: string;\n /** The HTML code for the node. */\n html?: string;\n /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\n isAdsense?: boolean | null;\n /** Styling for the HTML node's container. */\n containerData?: PluginContainerData$1;\n /** The type of HTML code. */\n source?: Source$1;\n }\n /** @oneof */\n interface HTMLDataDataOneOf$1 {\n /** The URL for the HTML code for the node. */\n url?: string;\n /** The HTML code for the node. */\n html?: string;\n /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\n isAdsense?: boolean | null;\n }\n enum Source$1 {\n HTML = \"HTML\",\n ADSENSE = \"ADSENSE\"\n }\n interface ImageData$1 {\n /** Styling for the image's container. */\n containerData?: PluginContainerData$1;\n /** Image file details. */\n image?: V1Media;\n /** Link details for images that are links. */\n link?: Link$1;\n /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */\n disableExpand?: boolean | null;\n /** Image's alternative text. */\n altText?: string | null;\n /**\n * Deprecated: use Caption node instead.\n * @deprecated\n */\n caption?: string | null;\n /** Sets whether the image's download button is disabled. Defaults to `false`. */\n disableDownload?: boolean | null;\n }\n interface LinkPreviewData$1 {\n /** Styling for the link preview's container. */\n containerData?: PluginContainerData$1;\n /** Link details. */\n link?: Link$1;\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$1 {\n /** Styling for the map's container. */\n containerData?: PluginContainerData$1;\n /** Map settings. */\n mapSettings?: MapSettings$1;\n }\n interface MapSettings$1 {\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$1;\n }\n enum MapType$1 {\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$1 {\n /** Styling for the paragraph text. */\n textStyle?: TextStyle$1;\n /** Indentation level from 1-4. */\n indentation?: number | null;\n /** Paragraph level */\n level?: number | null;\n }\n interface PollData$1 {\n /** Styling for the poll's container. */\n containerData?: PluginContainerData$1;\n /** Poll data. */\n poll?: Poll$1;\n /** Layout settings for the poll and voting options. */\n layout?: PollDataLayout$1;\n /** Styling for the poll and voting options. */\n design?: Design$1;\n }\n enum ViewRole$1 {\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$1 {\n /** Logged in member */\n SITE_MEMBERS = \"SITE_MEMBERS\",\n /** Anyone */\n ALL = \"ALL\"\n }\n interface Permissions$1 {\n /** Sets who can view the poll results. */\n view?: ViewRole$1;\n /** Sets who can vote. */\n vote?: VoteRole$1;\n /** Sets whether one voter can vote multiple times. Defaults to `false`. */\n allowMultipleVotes?: boolean | null;\n }\n interface Option$1 {\n /** Option ID. */\n _id?: string | null;\n /** Option title. */\n title?: string | null;\n /** The image displayed with the option. */\n image?: V1Media;\n }\n interface PollSettings$1 {\n /** Permissions settings for voting. */\n permissions?: Permissions$1;\n /** Sets whether voters are displayed in the vote results. Defaults to `true`. */\n showVoters?: boolean | null;\n /** Sets whether the vote count is displayed. Defaults to `true`. */\n showVotesCount?: boolean | null;\n }\n enum PollLayoutType$1 {\n /** List */\n LIST = \"LIST\",\n /** Grid */\n GRID = \"GRID\"\n }\n enum PollLayoutDirection$1 {\n /** Left-to-right */\n LTR = \"LTR\",\n /** Right-to-left */\n RTL = \"RTL\"\n }\n interface PollLayout$1 {\n /** The layout for displaying the voting options. */\n type?: PollLayoutType$1;\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$1;\n /** Sets whether to display the main poll image. Defaults to `false`. */\n enableImage?: boolean | null;\n }\n interface OptionLayout$1 {\n /** Sets whether to display option images. Defaults to `false`. */\n enableImage?: boolean | null;\n }\n enum BackgroundType$1 {\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$1 {\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$1 extends BackgroundBackgroundOneOf$1 {\n /** The background color as a hexademical value. */\n color?: string | null;\n /** An image to use for the background. */\n image?: V1Media;\n /** Details for a gradient background. */\n gradient?: Gradient$1;\n /** Background type. For each option, include the relevant details. */\n type?: BackgroundType$1;\n }\n /** @oneof */\n interface BackgroundBackgroundOneOf$1 {\n /** The background color as a hexademical value. */\n color?: string | null;\n /** An image to use for the background. */\n image?: V1Media;\n /** Details for a gradient background. */\n gradient?: Gradient$1;\n }\n interface PollDesign$1 {\n /** Background styling. */\n background?: Background$1;\n /** Border radius in pixels. */\n borderRadius?: number | null;\n }\n interface OptionDesign$1 {\n /** Border radius in pixels. */\n borderRadius?: number | null;\n }\n interface Poll$1 {\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?: V1Media;\n /** Voting options. */\n options?: Option$1[];\n /** The poll's permissions and display settings. */\n settings?: PollSettings$1;\n }\n interface PollDataLayout$1 {\n /** Poll layout settings. */\n poll?: PollLayout$1;\n /** Voting otpions layout settings. */\n options?: OptionLayout$1;\n }\n interface Design$1 {\n /** Styling for the poll. */\n poll?: PollDesign$1;\n /** Styling for voting options. */\n options?: OptionDesign$1;\n }\n interface TextData$1 {\n /** The text to apply decorations to. */\n text?: string;\n /** The decorations to apply. */\n decorations?: Decoration$1[];\n }\n /** Adds appearence changes to text */\n interface Decoration$1 extends DecorationDataOneOf$1 {\n /** Data for an anchor link decoration. */\n anchorData?: AnchorData$1;\n /** Data for a color decoration. */\n colorData?: ColorData$1;\n /** Data for an external link decoration. */\n linkData?: LinkData$1;\n /** Data for a mention decoration. */\n mentionData?: MentionData$1;\n /** Data for a font size decoration. */\n fontSizeData?: FontSizeData$1;\n /** Font weight for a bold decoration. */\n fontWeightValue?: number | null;\n /** Data for an italic decoration. Defaults to `true`. */\n italicData?: boolean | null;\n /** Data for an underline decoration. Defaults to `true`. */\n underlineData?: boolean | null;\n /** Data for a spoiler decoration. */\n spoilerData?: SpoilerData$1;\n /** The type of decoration to apply. */\n type?: DecorationType$1;\n }\n /** @oneof */\n interface DecorationDataOneOf$1 {\n /** Data for an anchor link decoration. */\n anchorData?: AnchorData$1;\n /** Data for a color decoration. */\n colorData?: ColorData$1;\n /** Data for an external link decoration. */\n linkData?: LinkData$1;\n /** Data for a mention decoration. */\n mentionData?: MentionData$1;\n /** Data for a font size decoration. */\n fontSizeData?: FontSizeData$1;\n /** Font weight for a bold decoration. */\n fontWeightValue?: number | null;\n /** Data for an italic decoration. Defaults to `true`. */\n italicData?: boolean | null;\n /** Data for an underline decoration. Defaults to `true`. */\n underlineData?: boolean | null;\n /** Data for a spoiler decoration. */\n spoilerData?: SpoilerData$1;\n }\n enum DecorationType$1 {\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$1 {\n /** The target node's ID. */\n anchor?: string;\n }\n interface ColorData$1 {\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$1 {\n /** Link details. */\n link?: Link$1;\n }\n interface MentionData$1 {\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$1 {\n /** The units used for the font size. */\n unit?: FontType$1;\n /** Font size value. */\n value?: number | null;\n }\n enum FontType$1 {\n PX = \"PX\",\n EM = \"EM\"\n }\n interface SpoilerData$1 {\n /** Spoiler ID. */\n _id?: string | null;\n }\n interface AppEmbedData$1 extends AppEmbedDataAppDataOneOf$1 {\n /** Data for embedded Wix Bookings content. */\n bookingData?: BookingData$1;\n /** Data for embedded Wix Events content. */\n eventData?: EventData$1;\n /** The type of Wix App content being embedded. */\n type?: AppType$1;\n /** The ID of the embedded content. */\n itemId?: string | null;\n /** The name of the embedded content. */\n name?: string | null;\n /**\n * Deprecated: Use `image` instead.\n * @deprecated\n */\n imageSrc?: string | null;\n /** The URL for the embedded content. */\n url?: string | null;\n /** An image for the embedded content. */\n image?: V1Media;\n }\n /** @oneof */\n interface AppEmbedDataAppDataOneOf$1 {\n /** Data for embedded Wix Bookings content. */\n bookingData?: BookingData$1;\n /** Data for embedded Wix Events content. */\n eventData?: EventData$1;\n }\n enum AppType$1 {\n PRODUCT = \"PRODUCT\",\n EVENT = \"EVENT\",\n BOOKING = \"BOOKING\"\n }\n interface BookingData$1 {\n /** Booking duration in minutes. */\n durations?: string | null;\n }\n interface EventData$1 {\n /** Event schedule. */\n scheduling?: string | null;\n /** Event location. */\n location?: string | null;\n }\n interface VideoData$1 {\n /** Styling for the video's container. */\n containerData?: PluginContainerData$1;\n /** Video details. */\n video?: V1Media;\n /** Video thumbnail details. */\n thumbnail?: V1Media;\n /** Sets whether the video's download button is disabled. Defaults to `false`. */\n disableDownload?: boolean | null;\n /** Video title. */\n title?: string | null;\n /** Video options. */\n options?: PlaybackOptions$1;\n }\n interface PlaybackOptions$1 {\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$1 {\n /** Styling for the oEmbed node's container. */\n containerData?: PluginContainerData$1;\n /** An [oEmbed](https://www.oembed.com) object. */\n oembed?: Oembed$1;\n /** Origin asset source. */\n src?: string | null;\n }\n interface Oembed$1 {\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$1 {\n /** Styling for the collapsible list's container. */\n containerData?: PluginContainerData$1;\n /** If `true`, only one item can be expanded at a time. Defaults to `false`. */\n expandOnlyOne?: boolean | null;\n /** Sets which items are expanded when the page loads. */\n initialExpandedItems?: InitialExpandedItems$1;\n /** The direction of the text in the list. Either left-to-right or right-to-left. */\n direction?: Direction$1;\n /** If `true`, The collapsible item will appear in search results as an FAQ. */\n isQapageData?: boolean | null;\n }\n enum InitialExpandedItems$1 {\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$1 {\n /** Left-to-right */\n LTR = \"LTR\",\n /** Right-to-left */\n RTL = \"RTL\"\n }\n interface TableData$1 {\n /** Styling for the table's container. */\n containerData?: PluginContainerData$1;\n /** The table's dimensions. */\n dimensions?: Dimensions$1;\n /**\n * Deprecated: Use `rowHeader` and `columnHeader` instead.\n * @deprecated\n */\n header?: boolean | null;\n /** Sets whether the table's first row is a header. Defaults to `false`. */\n rowHeader?: boolean | null;\n /** Sets whether the table's first column is a header. Defaults to `false`. */\n columnHeader?: boolean | null;\n }\n interface Dimensions$1 {\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$1 {\n /** Styling for the cell's background color and text alignment. */\n cellStyle?: CellStyle$1;\n /** The cell's border colors. */\n borderColors?: BorderColors$1;\n }\n enum VerticalAlignment$1 {\n /** Top alignment */\n TOP = \"TOP\",\n /** Middle alignment */\n MIDDLE = \"MIDDLE\",\n /** Bottom alignment */\n BOTTOM = \"BOTTOM\"\n }\n interface CellStyle$1 {\n /** Vertical alignment for the cell's text. */\n verticalAlignment?: VerticalAlignment$1;\n /** Cell background color as a hexadecimal value. */\n backgroundColor?: string | null;\n }\n interface BorderColors$1 {\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$1 {\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$1 {\n /** Repeated field of dynamically typed values. */\n values?: any[];\n }\n interface AudioData$1 {\n /** Styling for the audio node's container. */\n containerData?: PluginContainerData$1;\n /** Audio file details. */\n audio?: V1Media;\n /** Sets whether the audio node's download button is disabled. Defaults to `false`. */\n disableDownload?: boolean | null;\n /** Cover image. */\n coverImage?: V1Media;\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$1 {\n /** Indentation level from 0-4. */\n indentation?: number;\n /** Offset level from 0-4. */\n offset?: number | null;\n /** List start number. */\n start?: number | null;\n }\n interface BulletedListData$1 {\n /** Indentation level from 0-4. */\n indentation?: number;\n /** Offset level from 0-4. */\n offset?: number | null;\n }\n interface BlockquoteData$1 {\n /** Indentation level from 1-4. */\n indentation?: number;\n }\n interface CaptionData$1 {\n textStyle?: TextStyle$1;\n }\n interface Metadata$1 {\n /** Schema version. */\n version?: number;\n /**\n * When the object was created.\n * @readonly\n * @deprecated\n */\n createdTimestamp?: Date | null;\n /**\n * When the object was most recently updated.\n * @deprecated\n */\n updatedTimestamp?: Date | null;\n /** Object ID. */\n _id?: string | null;\n }\n interface DocumentStyle$1 {\n /** Styling for H1 nodes. */\n headerOne?: TextNodeStyle$1;\n /** Styling for H2 nodes. */\n headerTwo?: TextNodeStyle$1;\n /** Styling for H3 nodes. */\n headerThree?: TextNodeStyle$1;\n /** Styling for H4 nodes. */\n headerFour?: TextNodeStyle$1;\n /** Styling for H5 nodes. */\n headerFive?: TextNodeStyle$1;\n /** Styling for H6 nodes. */\n headerSix?: TextNodeStyle$1;\n /** Styling for paragraph nodes. */\n paragraph?: TextNodeStyle$1;\n /** Styling for block quote nodes. */\n blockquote?: TextNodeStyle$1;\n /** Styling for code block nodes. */\n codeBlock?: TextNodeStyle$1;\n }\n interface TextNodeStyle$1 {\n /** The decorations to apply to the node. */\n decorations?: Decoration$1[];\n /** Padding and background color for the node. */\n nodeStyle?: NodeStyle$1;\n /** Line height for text in the node. */\n lineHeight?: string | null;\n }\n enum Status$1 {\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 2024-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 ModerationDetails$1 {\n /** Member ID of the person submitting the draft post for review. */\n submittedBy?: string;\n /** Date the post was submitted for review. */\n submittedDate?: Date | null;\n /** Status indicating whether the submission was approved or rejected by the moderator. */\n status?: ModerationStatusStatus$1;\n /** Member ID of the person who approved or rejected the post. */\n moderatedBy?: string | null;\n /** Date the post was approved or rejected. */\n moderationDate?: Date | null;\n }\n enum ModerationStatusStatus$1 {\n UNKNOWN = \"UNKNOWN\",\n APPROVED = \"APPROVED\",\n REJECTED = \"REJECTED\"\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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 Media$1 extends MediaMediaOneOf {\n /** Wix Media details. */\n wixMedia?: WixMedia$1;\n /** Embed media details. */\n embedMedia?: EmbedMedia$1;\n /** Whether cover media is displayed. */\n displayed?: boolean;\n /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */\n custom?: boolean;\n }\n /** @oneof */\n interface MediaMediaOneOf {\n /** Wix Media details. */\n wixMedia?: WixMedia$1;\n /** Embed media details. */\n embedMedia?: EmbedMedia$1;\n }\n interface WixMedia$1 {\n /** Image details. */\n image?: string;\n /** Video details. */\n videoV2?: string;\n }\n interface VideoResolution$1 {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface EmbedMedia$1 {\n /** Thumbnail details. */\n thumbnail?: EmbedThumbnail$1;\n /** Video details. */\n video?: EmbedVideo$1;\n }\n interface EmbedThumbnail$1 {\n /** Thumbnail url. */\n url?: string;\n /** Thumbnail width. */\n width?: number;\n /** Thumbnail height. */\n height?: number;\n }\n interface EmbedVideo$1 {\n /** Video url. */\n url?: string;\n /** Video width. */\n width?: number;\n /** Video height. */\n height?: number;\n }\n interface DraftPostTranslation$1 {\n /** Post ID. */\n _id?: string;\n /** Post status. */\n status?: Status$1;\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$2;\n /** Post URL. */\n url?: string;\n }\n interface InitialDraftPostsCopied {\n /** Number of draft posts copied. */\n count?: number;\n }\n interface CreateDraftPostRequest {\n /** Draft post to create. */\n draftPost: DraftPost$1;\n /**\n * Should publish after creation.\n * @internal\n * @deprecated\n * @replacedBy publish\n * @targetRemovalDate 2024-06-30\n */\n shouldPublish?: boolean;\n /**\n * Whether the draft post should be published on creation.\n *\n * Default: `false`\n */\n publish?: boolean;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /**\n * Field mask of fields to be used for draft post creation.\n * @internal\n * @deprecated Field mask of fields to be used for draft post creation.\n * @targetRemovalDate 2024-06-30\n */\n fieldMask?: string[];\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n enum Type$1 {\n UNKNOWN = \"UNKNOWN\",\n /** Manually saved. */\n MANUAL = \"MANUAL\",\n /** Triggered by autosave. */\n AUTO_SAVE = \"AUTO_SAVE\",\n /** Copied from template during provisioning flow. */\n PROVISIONING = \"PROVISIONING\",\n /** Imported from another blog. */\n IMPORT = \"IMPORT\",\n /** Triggered by autosave when post created by AI tool. */\n AI_AUTO_SAVE = \"AI_AUTO_SAVE\"\n }\n enum Field$2 {\n /** Unknown field. */\n UNKNOWN = \"UNKNOWN\",\n /** Includes draft post preview URL. */\n URL = \"URL\",\n /**\n * Includes internal id field.\n * Reserved for internal use.\n */\n INTERNAL_ID = \"INTERNAL_ID\",\n /** Includes content field. */\n CONTENT = \"CONTENT\",\n /** Includes rich content field. */\n RICH_CONTENT = \"RICH_CONTENT\",\n /** Includes draft post translations when present. */\n TRANSLATIONS = \"TRANSLATIONS\",\n /** If the user has not set excerpt, returns the one autogenerated from content. */\n GENERATED_EXCERPT = \"GENERATED_EXCERPT\"\n }\n interface CreateDraftPostResponse {\n /** Created draft post info. */\n draftPost?: DraftPost$1;\n }\n interface BulkCreateDraftPostsRequest {\n /** Draft posts to create. */\n draftPosts: DraftPost$1[];\n /**\n * Should publish after creation.\n * @internal\n * @deprecated Should publish after creation.\n * @replacedBy publish\n * @targetRemovalDate 2024-06-30\n */\n shouldPublish?: boolean;\n /** Whether the draft post should be published after creation. */\n publish?: boolean;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /**\n * Field mask of fields to be used for draft post creation.\n * @internal\n * @deprecated Field mask of fields to be used for draft post creation.\n * @targetRemovalDate 2024-06-30\n */\n fieldMask?: string[];\n /** Whether to return the full created draft post entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * @internal\n * @deprecated List of draft post fields to be included if entities are present in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included in the response if the entities are present.\n * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).\n * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.\n */\n fieldsets?: Field$2[];\n }\n interface BulkCreateDraftPostsResponse {\n /** Draft posts created by bulk action. */\n results?: BulkDraftPostResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkDraftPostResult {\n /** Bulk actions metadata for draft post. */\n itemMetadata?: ItemMetadata$1;\n /** Optional full draft post. */\n item?: DraftPost$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 BulkUpdateDraftPostsRequest {\n /** Draft posts to update. */\n draftPosts?: MaskedDraftPosts[];\n /**\n * Action to perform on the posts.\n *\n * - `UPDATE`: Update the draft post.\n * - `UPDATE_PUBLISH`: Update and publish the draft post.\n * - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.\n * - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.\n * - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.\n * - `UPDATE_REJECT`: Update and reject the draft post.\n * - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.\n *\n * Default: `UPDATE`\n */\n action?: Action;\n /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */\n scheduledPublishDate?: Date | null;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /** Whether to return the full updated draft post entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface MaskedDraftPosts {\n /** Draft post info. */\n draftPost?: DraftPost$1;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n enum Action {\n /** Update the draft post. */\n UPDATE = \"UPDATE\",\n /** Update and publish a draft post. */\n UPDATE_PUBLISH = \"UPDATE_PUBLISH\",\n /** Update the draft post and schedule a publish date. */\n UPDATE_SCHEDULE = \"UPDATE_SCHEDULE\",\n /** Update the post and revert it to draft. */\n UPDATE_REVERT_TO_DRAFT = \"UPDATE_REVERT_TO_DRAFT\",\n /** Update the draft post and cancel the scheduled publish date. */\n UPDATE_CANCEL_SCHEDULE = \"UPDATE_CANCEL_SCHEDULE\",\n /** Update and reject draft post. */\n UPDATE_REJECT = \"UPDATE_REJECT\",\n /** Update a post that's already been published. This creates and updates a draft version of the post. The original post is still published. */\n UPDATE_PUBLICATION = \"UPDATE_PUBLICATION\"\n }\n interface BulkUpdateDraftPostsResponse {\n /** Draft posts updated by bulk action. */\n results?: BulkDraftPostResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface DraftPostOwnerChanged {\n /**\n * Member ID of the draft post's owner before the change.\n * @internal\n */\n oldMemberId?: string;\n /**\n * Member ID of the draft post's owner after the change.\n * @internal\n */\n newMemberId?: string;\n }\n interface ListDeletedDraftPostsRequest {\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If omitted, deleted draft posts in all languages are returned.\n */\n language?: string | null;\n /**\n * Sorting options.\n *\n * Default: `EDITING_DATE_DESCENDING`\n */\n sort?: GetDraftPostsSort;\n /** Pagination options. */\n paging?: BlogPaging$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n /** Draft post ids. */\n draftPostIds?: string[];\n }\n enum GetDraftPostsSort {\n /** Sort by `editedDate` in descending order. */\n EDITING_DATE_DESC = \"EDITING_DATE_DESC\",\n /** Sort by `editedDate` in ascending order. */\n EDITING_DATE_ASC = \"EDITING_DATE_ASC\"\n }\n interface BlogPaging$1 {\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 ListDeletedDraftPostsResponse {\n /** List of draft posts. */\n draftPosts?: DraftPost$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 /** 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 GetDraftPostRequest {\n /** Draft post ID. */\n draftPostId: string;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * @internal\n * @deprecated List of draft post fields to be included if entities are present in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface GetDraftPostResponse {\n /** Draft post info. */\n draftPost?: DraftPost$1;\n }\n interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {\n /** DraftJs content to update. */\n content?: string;\n /** Draft post rich content. */\n richContent?: RichContent$1;\n /** Draft post ID. */\n draftPostId: string;\n /** Change origin. */\n changeOrigin?: Origin$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /** @oneof */\n interface UpdateDraftPostContentRequestDraftContentOneOf {\n /** DraftJs content to update. */\n content?: string;\n /** Draft post rich content. */\n richContent?: RichContent$1;\n }\n interface UpdateDraftPostContentResponse {\n /** Updated draft post info. */\n draftPost?: DraftPost$1;\n }\n interface UpdateDraftPostRequest {\n /** Draft post to update. */\n draftPost: DraftPost$1;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /**\n * Should publish after update.\n * @internal\n * @deprecated Should publish after update.\n * @replacedBy action\n * @targetRemovalDate 2024-06-30\n */\n shouldPublish?: boolean;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * Action to perform on the post.\n *\n * Default: `UPDATE`\n */\n action?: Action;\n /** Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`. */\n scheduledPublishDate?: Date | null;\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface UpdateDraftPostResponse {\n /** Updated draft post info. */\n draftPost?: DraftPost$1;\n }\n interface DeleteDraftPostRequest {\n /** Draft post ID. */\n draftPostId: string;\n /**\n * Whether to bypass the trash bin and delete the post permanently.\n *\n * Default: `false`\n */\n permanent?: boolean;\n }\n interface DeleteDraftPostResponse {\n }\n interface RemoveFromTrashBinRequest {\n /** Draft post ID. */\n draftPostId: string;\n }\n interface RemoveFromTrashBinResponse {\n }\n interface BulkDeleteDraftPostsRequest {\n /** Post IDs. */\n postIds: string[];\n /** Should delete bypassing the trash-bin. */\n permanent?: boolean;\n }\n interface BulkDeleteDraftPostsResponse {\n /** Bulk action results. */\n results?: BulkDraftPostResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface ListDraftPostsRequest {\n /**\n * Draft post status filter.\n *\n * If omitted, draft posts with all statuses are returned.\n * `IN_MODERATION` is deprecated, use `IN_REVIEW` instead.\n */\n status?: Status$1;\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If omitted, draft posts in all languages are returned.\n */\n language?: string | null;\n /**\n * Sort options.\n *\n * Default: `EDITING_DATE_DESCENDING`\n */\n sort?: GetDraftPostsSort;\n /** Pagination options. */\n paging?: BlogPaging$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-03-31\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n interface ListDraftPostsResponse {\n /** List of draft posts. */\n draftPosts?: DraftPost$1[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData$2;\n }\n interface GetDeletedDraftPostRequest {\n /** Draft post ID. */\n draftPostId: string;\n }\n interface GetDeletedDraftPostResponse {\n /** Draft post info. */\n draftPost?: DraftPost$1;\n }\n interface RestoreFromTrashBinRequest {\n /** Draft post ID. */\n draftPostId: string;\n }\n interface RestoreFromTrashBinResponse {\n /** Restored draft post info. */\n draftPost?: DraftPost$1;\n }\n interface QueryDraftPostsRequest {\n /**\n * Pagination options.\n * @internal\n * @deprecated Pagination options.\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n paging?: BlogPaging$1;\n /**\n * Filter object.\n * For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @internal\n * @deprecated Filter object.\n * For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n filter?: Record | null;\n /**\n * Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @internal\n * @deprecated Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n sort?: Sorting$2[];\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n /** Query options. */\n query?: PlatformQuery$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformQuery$2 extends 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 * 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 }\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 QueryDraftPostsResponse {\n /** List of posts. */\n draftPosts?: DraftPost$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 * @deprecated __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 * @replacedBy pagingMetadata\n * @targetRemovalDate 2024-06-30\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 * 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 * @internal\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 PublishDraftPostRequest {\n /** Draft post ID. */\n draftPostId: string;\n }\n interface PublishDraftPostResponse {\n /** Published post ID. */\n postId?: string;\n }\n interface UnpublishPostRequest {\n /** Draft post ID. */\n draftPostId: string;\n }\n interface UnpublishPostResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 GetDraftPostTotalsRequest {\n /**\n * Group results by fields (defaults to grouping by status).\n * If, for example, grouping by language is passed, language values in response will be filled.\n * If, for example, grouping by language is not passed, null values will be filled in language field in response.\n */\n groupBy?: TotalDraftPostsGroupingField[];\n /** Optional language filter by provided language code. Useful in multilingual context. */\n language?: string | null;\n }\n enum TotalDraftPostsGroupingField {\n /** Groups results by status. */\n STATUS = \"STATUS\",\n /** Groups results by language. */\n LANGUAGE = \"LANGUAGE\"\n }\n interface GetDraftPostTotalsResponse {\n /** Draft post totals. */\n totalDraftPosts?: TotalDraftPosts[];\n }\n interface TotalDraftPosts {\n /** Draft post totals in that group. */\n total?: number;\n /** Draft post status (only has value when grouping by status, otherwise null). */\n status?: Status$1;\n /** Draft post language code (only has value when grouping by language, otherwise null). */\n language?: string | null;\n }\n interface TranslateCategoryRequest {\n /** Source category ID */\n categoryId: string;\n /** Translation language */\n language: string;\n }\n interface TranslateCategoryResponse {\n /** Translated category */\n category?: Category$1;\n /** Other translations of returned category */\n translations?: CategoryTranslation$1[];\n }\n interface Category$1 {\n /** Category ID. */\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 * The `url` of the page that lists every post with the specified category.\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /**\n * Category title.\n * @deprecated Category title.\n * @targetRemovalDate 2025-07-16\n */\n title?: string;\n /**\n * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).\n * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.\n *\n * Default: `-1`\n */\n displayPosition?: number | null;\n /** ID of the category's translations. All translations of a single category share the same `translationId`. */\n translationId?: string | null;\n /**\n * Category language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */\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 * Category translations.\n * @internal\n * @readonly\n */\n translations?: CategoryTranslation$1[];\n /**\n * Date and time the Category was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface CategoryTranslation$1 {\n /** Category ID. */\n _id?: string;\n /** Label displayed in the categories menu on the site. */\n label?: string | null;\n /** Language of the category. */\n language?: string | null;\n /** URL of this category page. */\n url?: string;\n }\n interface TranslateDraftRequest {\n /** Source post or draft ID */\n postId: string;\n /** Translation language */\n language: string;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n /**\n * Performs automatic translation of the title and the content of the draft post to the target language.\n * @internal\n */\n useAutoTranslation?: boolean;\n }\n interface TranslateDraftResponse {\n /** Draft post. */\n draftPost?: DraftPost$1;\n }\n interface IsDraftPostAutoTranslatableRequest {\n /** Source post or draft ID. */\n draftPostId: string;\n }\n interface IsDraftPostAutoTranslatableResponse {\n /** Source draft post ID. */\n draftPostId?: string;\n /** Indicates if enough machine translation credits are available for the draft post translation. */\n translatable?: boolean;\n /** Draft post title word count. */\n titleWordCount?: number;\n /** Draft post content word count. */\n contentWordCount?: number;\n /** Word credits available for auto translation. */\n availableAutoTranslateWords?: number;\n /** Word credits available after auto translation would be done. */\n availableAutoTranslateWordsAfter?: number;\n }\n interface UpdateDraftPostLanguageRequest {\n /** Source draft post ID */\n postId: string;\n /** New language to replace to */\n language: string;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n interface UpdateDraftPostLanguageResponse {\n /** Draft post */\n draftPost?: DraftPost$1;\n }\n interface BulkUpdateDraftPostLanguageRequest {\n /** Source post or draft IDs */\n ids?: string[];\n /** New language to replace to */\n language: string;\n /** Should full draft post be returned */\n returnFullEntity?: boolean;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n interface BulkUpdateDraftPostLanguageResponse {\n /** Bulk action results */\n results?: BulkDraftPostResult[];\n /** Bulk action metadata */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface GetPostAmountsByLanguageRequest {\n /** Post status to filter by */\n status: string;\n }\n interface GetPostAmountsByLanguageResponse {\n /** Post amounts by language */\n postAmountsByLanguage?: PostAmountByLanguage[];\n }\n interface PostAmountByLanguage {\n /** Post language code */\n languageCode?: string;\n /** Language flag */\n flag?: string;\n /** Post amount in that language */\n postAmount?: number;\n }\n interface BulkRevertToUnpublishedRequest {\n /** Source post IDs. */\n postIds: string[];\n /** Should full draft post be returned. */\n returnFullEntity?: boolean;\n }\n interface BulkRevertToUnpublishedResponse {\n /** Bulk action results. */\n results?: BulkDraftPostResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkRejectDraftPostRequest {\n /** Source post IDs. */\n postIds: string[];\n /** Should full draft post be returned. */\n returnFullEntity?: boolean;\n }\n interface BulkRejectDraftPostResponse {\n /** Bulk action results. */\n results?: BulkDraftPostResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface RevertToUnpublishedRequest {\n /** Source post ID. */\n postId: string;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n interface RevertToUnpublishedResponse {\n /** Updated post draft. */\n draftPost?: DraftPost$1;\n }\n interface RejectDraftPostRequest {\n /** Source post ID. */\n postId: string;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n interface RejectDraftPostResponse {\n /** Draft post. */\n draftPost?: DraftPost$1;\n }\n interface ApproveDraftPostRequest {\n /** Source post ID. */\n postId: string;\n /** Scheduled publish date if should be not immediately published. */\n scheduledPublishDate?: string | null;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n interface ApproveDraftPostResponse {\n /** Updated post draft. */\n draftPost?: DraftPost$1;\n }\n interface MarkPostAsInModerationRequest {\n /** Source post ID. */\n postId: string;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n interface MarkPostAsInModerationResponse {\n /** Updated post draft. */\n draftPost?: DraftPost$1;\n }\n /**\n * Creates a draft post.\n *\n * The draft post's `memberId` is required for third-party apps.\n * @param draftPost - Draft post to create.\n * @public\n * @requiredField draftPost\n * @requiredField draftPost.title\n * @param options - Options for creating a draft post.\n * @permissionId BLOG.CREATE-DRAFT\n * @adminMethod\n */\n function createDraftPost(draftPost: DraftPost$1, options?: CreateDraftPostOptions): Promise;\n interface CreateDraftPostOptions {\n /**\n * Should publish after creation.\n * @internal\n * @deprecated\n * @replacedBy publish\n * @targetRemovalDate 2024-06-30\n */\n shouldPublish?: boolean;\n /**\n * Whether the draft post should be published on creation.\n *\n * Default: `false`\n */\n publish?: boolean;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /**\n * Field mask of fields to be used for draft post creation.\n * @internal\n * @deprecated Field mask of fields to be used for draft post creation.\n * @targetRemovalDate 2024-06-30\n */\n fieldMask?: string[];\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Creates multiple draft posts.\n * @param draftPosts - Draft posts to create.\n * @public\n * @requiredField draftPosts\n * @requiredField draftPosts.title\n * @param options - Options for creating multiple draft posts.\n * @permissionId BLOG.CREATE-DRAFT\n * @adminMethod\n */\n function bulkCreateDraftPosts(draftPosts: DraftPost$1[], options?: BulkCreateDraftPostsOptions): Promise;\n interface BulkCreateDraftPostsOptions {\n /**\n * Should publish after creation.\n * @internal\n * @deprecated Should publish after creation.\n * @replacedBy publish\n * @targetRemovalDate 2024-06-30\n */\n shouldPublish?: boolean;\n /** Whether the draft post should be published after creation. */\n publish?: boolean;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /**\n * Field mask of fields to be used for draft post creation.\n * @internal\n * @deprecated Field mask of fields to be used for draft post creation.\n * @targetRemovalDate 2024-06-30\n */\n fieldMask?: string[];\n /** Whether to return the full created draft post entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * @internal\n * @deprecated List of draft post fields to be included if entities are present in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included in the response if the entities are present.\n * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).\n * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Updates multiple draft posts.\n * @public\n * @requiredField options.draftPosts.draftPost\n * @requiredField options.draftPosts.draftPost._id\n * @param options - Options for updating multiple draft posts.\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function bulkUpdateDraftPosts(options?: BulkUpdateDraftPostsOptions): Promise;\n interface BulkUpdateDraftPostsOptions {\n /** Draft posts to update. */\n draftPosts?: MaskedDraftPosts[];\n /**\n * Action to perform on the posts.\n *\n * - `UPDATE`: Update the draft post.\n * - `UPDATE_PUBLISH`: Update and publish the draft post.\n * - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.\n * - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.\n * - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.\n * - `UPDATE_REJECT`: Update and reject the draft post.\n * - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.\n *\n * Default: `UPDATE`\n */\n action?: Action;\n /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */\n scheduledPublishDate?: Date | null;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /** Whether to return the full updated draft post entities in the response. */\n returnFullEntity?: boolean;\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Retrieves a list of up to 100 deleted draft posts.\n *\n * List Deleted Draft Posts runs with these defaults, which you can override:\n * - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.\n * - `paging.limit` is `50`.\n * - `paging.offset` is `0`.\n * @public\n * @param options - Options for listing deleted draft posts.\n * @permissionId BLOG.READ_DRAFT\n * @adminMethod\n */\n function listDeletedDraftPosts(options?: ListDeletedDraftPostsOptions): Promise;\n interface ListDeletedDraftPostsOptions {\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If omitted, deleted draft posts in all languages are returned.\n */\n language?: string | null;\n /**\n * Sorting options.\n *\n * Default: `EDITING_DATE_DESCENDING`\n */\n sort?: GetDraftPostsSort;\n /** Pagination options. */\n paging?: BlogPaging$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n /** Draft post ids. */\n draftPostIds?: string[];\n }\n /**\n * Gets a draft post by the provided ID.\n *\n * Uses the provided `draftPostId` to retrieve a draft post.\n * @param draftPostId - Draft post ID.\n * @public\n * @requiredField draftPostId\n * @param options - Options for getting a draft post.\n * @permissionId BLOG.READ_DRAFT\n * @adminMethod\n */\n function getDraftPost(draftPostId: string, options?: GetDraftPostOptions): Promise;\n interface GetDraftPostOptions {\n /**\n * List of draft post fields to be included if entities are present in the response.\n * @internal\n * @deprecated List of draft post fields to be included if entities are present in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Updates content of a specified draft post.\n * @param draftPostId - Draft post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField draftPostId\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function updateDraftPostContent(draftPostId: string, options?: UpdateDraftPostContentOptions): Promise;\n interface UpdateDraftPostContentOptions extends UpdateDraftPostContentRequestDraftContentOneOf {\n /** DraftJs content to update. */\n content?: string;\n /** Draft post rich content. */\n richContent?: RichContent$1;\n /** Change origin. */\n changeOrigin?: Origin$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Updates a draft post.\n * @param _id - Draft post ID.\n * @public\n * @requiredField _id\n * @requiredField draftPost\n * @param options - Options for updating a draft post.\n * @param draftPost - Draft Post info.\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function updateDraftPost(_id: string, draftPost: UpdateDraftPost, options?: UpdateDraftPostOptions): Promise;\n interface UpdateDraftPost {\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 /**\n * __Deprecated.__ Use `media` instead.\n * This property will be removed on June 6, 2023.\n *\n * Draft post cover media.\n * @internal\n * @deprecated\n * @replacedBy media\n * @targetRemovalDate 2024-06-30\n */\n coverMedia?: CoverMedia$1;\n /** Draft post owner's member ID. */\n memberId?: string | null;\n /** Hashtags in the draft 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. 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 * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.\n */\n translationId?: string | null;\n /**\n * Language the draft post is written in.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n changeOrigin?: Origin$1;\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$1;\n /**\n * Status of the draft post.\n * @readonly\n */\n status?: Status$1;\n /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */\n moderationDetails?: ModerationDetails$1;\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 | null;\n /**\n * Date the draft post is scheduled to be published.\n * @readonly\n */\n scheduledPublishDate?: Date | null;\n /** Reserved for internal use. */\n content?: Record | null;\n /** Date the post was first published. */\n firstPublishedDate?: Date | null;\n /** SEO data. */\n seoData?: SeoSchema$2;\n /**\n * @internal Deprecated.\n * @internal Deprecated.\n * @deprecated\n * @replacedBy preview_text_paragraph\n * @targetRemovalDate 2024-06-30\n */\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 | null;\n /** SEO slug. */\n seoSlug?: string | null;\n /** Post cover media. */\n media?: Media$1;\n /** Number of paragraphs to display in a paid content preview for non-paying users. */\n previewTextParagraph?: number | null;\n /**\n * List of the post's translated posts.\n * @internal\n * @readonly\n */\n translations?: DraftPostTranslation$1[];\n /**\n * Reserved for internal use, not included in base response.\n * @internal\n */\n originPostId?: string | null;\n /**\n * Reserved for internal use, not included in base response.\n * @internal\n */\n originPostInstanceId?: string | null;\n /**\n * Reserved for internal use.\n * @readonly\n */\n internalId?: string | null;\n }\n interface UpdateDraftPostOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /**\n * Should publish after update.\n * @internal\n * @deprecated Should publish after update.\n * @replacedBy action\n * @targetRemovalDate 2024-06-30\n */\n shouldPublish?: boolean;\n /**\n * Save type.\n * @internal\n */\n saveType?: Type$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * Action to perform on the post.\n *\n * Default: `UPDATE`\n */\n action?: Action;\n /** Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`. */\n scheduledPublishDate?: Date | null;\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Moves a draft post with the provided ID to the trash bin.\n * A published post can also be deleted by its provided `draftPostId`.\n *\n * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.\n * @param draftPostId - Draft post ID.\n * @public\n * @requiredField draftPostId\n * @param options - Options for deleting a draft post.\n * @permissionId BLOG.DELETE-DRAFT\n * @adminMethod\n */\n function deleteDraftPost(draftPostId: string, options?: DeleteDraftPostOptions): Promise;\n interface DeleteDraftPostOptions {\n /**\n * Whether to bypass the trash bin and delete the post permanently.\n *\n * Default: `false`\n */\n permanent?: boolean;\n }\n /**\n * Permanently deletes a draft post by the provided ID from the trash bin.\n *\n * Uses the provided `draftPostId` to permanently delete a draft post from the trash bin. This action is permanent and cannot be reversed.\n * @param draftPostId - Draft post ID.\n * @public\n * @requiredField draftPostId\n * @permissionId BLOG.DELETE-DRAFT\n * @adminMethod\n */\n function removeFromTrashBin(draftPostId: string): Promise;\n /**\n * Deletes multiple draft posts.\n * @param postIds - Post IDs.\n * @public\n * @requiredField postIds\n * @param options - Options for deleting multiple draft posts.\n * @permissionId BLOG.DELETE-DRAFT\n * @adminMethod\n */\n function bulkDeleteDraftPosts(postIds: string[], options?: BulkDeleteDraftPostsOptions): Promise;\n interface BulkDeleteDraftPostsOptions {\n /** Should delete bypassing the trash-bin. */\n permanent?: boolean;\n }\n /**\n * Retrieves a list of up to 100 draft posts per request.\n *\n * List Draft Posts runs with these defaults, which you can override:\n * - `editedDate` is sorted in descending order.\n * - `paging.limit` is `50`.\n * - `paging.offset` is `0`.\n * @public\n * @param options - Options for listing multiple draft posts.\n * @permissionId BLOG.READ_DRAFT\n * @adminMethod\n */\n function listDraftPosts(options?: ListDraftPostsOptions): Promise;\n interface ListDraftPostsOptions {\n /**\n * Draft post status filter.\n *\n * If omitted, draft posts with all statuses are returned.\n * `IN_MODERATION` is deprecated, use `IN_REVIEW` instead.\n */\n status?: Status$1;\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If omitted, draft posts in all languages are returned.\n */\n language?: string | null;\n /**\n * Sort options.\n *\n * Default: `EDITING_DATE_DESCENDING`\n */\n sort?: GetDraftPostsSort;\n /** Pagination options. */\n paging?: BlogPaging$1;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-03-31\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Gets a deleted draft post from the trash bin by the provided ID.\n *\n * Uses the provided `draftPostId` to retrieve a previously deleted draft post from the trash bin.\n * @param draftPostId - Draft post ID.\n * @public\n * @requiredField draftPostId\n * @permissionId BLOG.READ_DRAFT\n * @adminMethod\n */\n function getDeletedDraftPost(draftPostId: string): Promise;\n /**\n * Restores a deleted draft post from the trash bin by the provided ID.\n *\n * Uses the `draftPostId` to restore a deleted draft post from the trash bin.\n * @param draftPostId - Draft post ID.\n * @public\n * @requiredField draftPostId\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function restoreFromTrashBin(draftPostId: string): Promise;\n /**\n * Retrieves a list of up to 100 draft posts, given the provided paging, filtering, and sorting.\n *\n * Query Draft Posts runs with these defaults, which you can override:\n * - `editedDate` is sorted in `DESC` order.\n * - `paging.limit` is `50`.\n * - `paging.offset` is `0`.\n * @public\n * @param options - Options for querying draft posts.\n * @permissionId BLOG.READ_DRAFT\n * @adminMethod\n */\n function queryDraftPosts(options?: QueryDraftPostsOptions): DraftPostsQueryBuilder;\n interface QueryDraftPostsOptions {\n /**\n * Pagination options.\n * @internal\n * @deprecated Pagination options.\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n paging?: BlogPaging$1 | undefined;\n /**\n * Filter object.\n * For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @internal\n * @deprecated Filter object.\n * For a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n filter?: Record | null | undefined;\n /**\n * Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @internal\n * @deprecated Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n sort?: Sorting$2[] | undefined;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[] | undefined;\n /**\n * List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the draft post's base fields are returned.\n */\n fieldsets?: Field$2[] | undefined;\n }\n interface QueryCursorResult$1 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DraftPostsQueryResult extends QueryCursorResult$1 {\n items: DraftPost$1[];\n query: DraftPostsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface DraftPostsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: '_id' | 'title' | 'excerpt' | 'featured' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'status' | 'hasUnpublishedChanges' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: '_id' | 'title' | 'excerpt' | 'featured' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'status' | 'hasUnpublishedChanges' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: 'minutesToRead' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: 'title' | 'excerpt', value: string) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: '_id' | 'title' | 'excerpt' | 'categoryIds' | 'memberId' | 'hashtags' | 'tagIds' | 'pricingPlanIds' | 'language' | 'status', value: any[]) => DraftPostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasAll: (propertyName: 'categoryIds' | 'hashtags' | 'tagIds' | 'pricingPlanIds', value: any[]) => DraftPostsQueryBuilder;\n in: (propertyName: 'title' | 'excerpt' | 'minutesToRead' | 'translationId' | 'language' | 'status' | 'editedDate' | 'scheduledPublishDate', value: any) => DraftPostsQueryBuilder;\n exists: (propertyName: 'title' | 'excerpt' | 'translationId' | 'language' | 'status', value: boolean) => DraftPostsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<'_id' | 'title' | 'excerpt' | 'featured' | 'commentingEnabled' | 'status' | 'hasUnpublishedChanges' | 'editedDate' | 'scheduledPublishDate'>) => DraftPostsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'_id' | 'title' | 'excerpt' | 'featured' | 'commentingEnabled' | 'status' | 'hasUnpublishedChanges' | 'editedDate' | 'scheduledPublishDate'>) => DraftPostsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => DraftPostsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => DraftPostsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.\n *\n * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.\n * @param draftPostId - Draft post ID.\n * @public\n * @requiredField draftPostId\n * @permissionId BLOG.PUBLISH-POST\n * @adminMethod\n */\n function publishDraftPost(draftPostId: string): Promise;\n /**\n * Reverts published post back to draft post making it invisible for the users.\n * @param draftPostId - Draft post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField draftPostId\n * @permissionId BLOG.PUBLISH-POST\n * @adminMethod\n */\n function unpublishPost(draftPostId: string): Promise;\n /**\n * Gets draft post totals grouped by fields.\n * An example usage would be to group by status so one would know how many posts there are that are in PUBLISHED, UNPUBLISHED, DELETED, etc. statuses.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.SEARCH-OWN-DRAFTS\n * @adminMethod\n */\n function getDraftPostTotals(options?: GetDraftPostTotalsOptions): Promise;\n interface GetDraftPostTotalsOptions {\n /**\n * Group results by fields (defaults to grouping by status).\n * If, for example, grouping by language is passed, language values in response will be filled.\n * If, for example, grouping by language is not passed, null values will be filled in language field in response.\n */\n groupBy?: TotalDraftPostsGroupingField[];\n /** Optional language filter by provided language code. Useful in multilingual context. */\n language?: string | null;\n }\n /**\n * Translates and returns translation of category for specified language.\n * @param categoryId - Source category ID\n * @param language - Translation language\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField language\n * @permissionId BLOG.CREATE-CATEGORY\n * @adminMethod\n */\n function translateCategory(categoryId: string, language: string): Promise;\n /**\n * Creates and returns translation of a draft in specified language.\n * @param postId - Source post or draft ID\n * @param language - Translation language\n * @internal\n * @documentationMaturity preview\n * @requiredField language\n * @requiredField postId\n * @permissionId BLOG.CREATE-DRAFT\n * @adminMethod\n */\n function translateDraft(postId: string, language: string, options?: TranslateDraftOptions): Promise;\n interface TranslateDraftOptions {\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n /**\n * Performs automatic translation of the title and the content of the draft post to the target language.\n * @internal\n */\n useAutoTranslation?: boolean;\n }\n /**\n * Checks whether enough translation credits are available to auto translate a draft post.\n * @param draftPostId - Source post or draft ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField draftPostId\n * @permissionId BLOG.CREATE-DRAFT\n * @adminMethod\n */\n function isDraftPostAutoTranslatable(draftPostId: string): Promise;\n /**\n * Updates draft post language and replaces its categories to the ones existing in specified language.\n * @param postId - Source draft post ID\n * @param language - New language to replace to\n * @internal\n * @documentationMaturity preview\n * @requiredField language\n * @requiredField postId\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function updateDraftPostLanguage(postId: string, language: string, options?: UpdateDraftPostLanguageOptions): Promise;\n interface UpdateDraftPostLanguageOptions {\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Bulk updates draft post language and replaces its categories to the ones existing in specified language.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.language\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function bulkUpdateDraftPostLanguage(options?: BulkUpdateDraftPostLanguageOptions): Promise;\n interface BulkUpdateDraftPostLanguageOptions {\n /** Source post or draft IDs */\n ids?: string[];\n /** New language to replace to */\n language: string;\n /** Should full draft post be returned */\n returnFullEntity?: boolean;\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Gets post amounts by each language in posts.\n * @param status - Post status to filter by\n * @internal\n * @documentationMaturity preview\n * @requiredField status\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function getPostAmountsByLanguage(status: string): Promise;\n /**\n * Reverts post status back from moderation to unpublished.\n * @param postIds - Source post IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField postIds\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function bulkRevertToUnpublished(postIds: string[], options?: BulkRevertToUnpublishedOptions): Promise;\n interface BulkRevertToUnpublishedOptions {\n /** Should full draft post be returned. */\n returnFullEntity?: boolean;\n }\n /**\n * Rejects draft post into unpublished status.\n * @param postIds - Source post IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField postIds\n * @permissionId BLOG.PUBLISH-POST\n * @adminMethod\n */\n function bulkRejectDraftPost(postIds: string[], options?: BulkRejectDraftPostOptions): Promise;\n interface BulkRejectDraftPostOptions {\n /** Should full draft post be returned. */\n returnFullEntity?: boolean;\n }\n /**\n * Reverts post status back from moderation to unpublished.\n * @param postId - Source post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function revertToUnpublished(postId: string, options?: RevertToUnpublishedOptions): Promise;\n interface RevertToUnpublishedOptions {\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Deprecated on '2022-09-01'. Use DraftPostService.UpdateDraftPost.\n * Rejects draft post into unpublished status.\n * @param postId - Source post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.PUBLISH-POST\n * @adminMethod\n */\n function rejectDraftPost(postId: string, options?: RejectDraftPostOptions): Promise;\n interface RejectDraftPostOptions {\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Deprecated on '2022-09-01'. Use DraftPostService.UpdateDraftPost.\n * Approves draft post by either publishing it or scheduling it for publish.\n * @param postId - Source post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.PUBLISH-POST\n * @adminMethod\n */\n function approveDraftPost(postId: string, options?: ApproveDraftPostOptions): Promise;\n interface ApproveDraftPostOptions {\n /** Scheduled publish date if should be not immediately published. */\n scheduledPublishDate?: string | null;\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n /**\n * Updates post statuses to mark post as being in moderation.\n * @param postId - Source post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.EDIT-DRAFT\n * @adminMethod\n */\n function markPostAsInModeration(postId: string, options?: MarkPostAsInModerationOptions): Promise;\n interface MarkPostAsInModerationOptions {\n /**\n * List of draft post fields to be included in the response.\n * @internal\n * @deprecated List of draft post fields to be included in the response.\n * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: Field$2[];\n /**\n * List of draft post fields to be included if entities are present in the response.\n * Base fieldset, which is default, will return all core draft post properties.\n * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.\n */\n fieldsets?: Field$2[];\n }\n \n type blogV3Draft_universal_d_ButtonDataType = ButtonDataType;\n const blogV3Draft_universal_d_ButtonDataType: typeof ButtonDataType;\n type blogV3Draft_universal_d_V1Media = V1Media;\n type blogV3Draft_universal_d_MediaMediaOneOf = MediaMediaOneOf;\n type blogV3Draft_universal_d_InitialDraftPostsCopied = InitialDraftPostsCopied;\n type blogV3Draft_universal_d_CreateDraftPostRequest = CreateDraftPostRequest;\n type blogV3Draft_universal_d_CreateDraftPostResponse = CreateDraftPostResponse;\n type blogV3Draft_universal_d_BulkCreateDraftPostsRequest = BulkCreateDraftPostsRequest;\n type blogV3Draft_universal_d_BulkCreateDraftPostsResponse = BulkCreateDraftPostsResponse;\n type blogV3Draft_universal_d_BulkDraftPostResult = BulkDraftPostResult;\n type blogV3Draft_universal_d_BulkUpdateDraftPostsRequest = BulkUpdateDraftPostsRequest;\n type blogV3Draft_universal_d_MaskedDraftPosts = MaskedDraftPosts;\n type blogV3Draft_universal_d_Action = Action;\n const blogV3Draft_universal_d_Action: typeof Action;\n type blogV3Draft_universal_d_BulkUpdateDraftPostsResponse = BulkUpdateDraftPostsResponse;\n type blogV3Draft_universal_d_DraftPostOwnerChanged = DraftPostOwnerChanged;\n type blogV3Draft_universal_d_ListDeletedDraftPostsRequest = ListDeletedDraftPostsRequest;\n type blogV3Draft_universal_d_GetDraftPostsSort = GetDraftPostsSort;\n const blogV3Draft_universal_d_GetDraftPostsSort: typeof GetDraftPostsSort;\n type blogV3Draft_universal_d_ListDeletedDraftPostsResponse = ListDeletedDraftPostsResponse;\n type blogV3Draft_universal_d_GetDraftPostRequest = GetDraftPostRequest;\n type blogV3Draft_universal_d_GetDraftPostResponse = GetDraftPostResponse;\n type blogV3Draft_universal_d_UpdateDraftPostContentRequest = UpdateDraftPostContentRequest;\n type blogV3Draft_universal_d_UpdateDraftPostContentRequestDraftContentOneOf = UpdateDraftPostContentRequestDraftContentOneOf;\n type blogV3Draft_universal_d_UpdateDraftPostContentResponse = UpdateDraftPostContentResponse;\n type blogV3Draft_universal_d_UpdateDraftPostRequest = UpdateDraftPostRequest;\n type blogV3Draft_universal_d_UpdateDraftPostResponse = UpdateDraftPostResponse;\n type blogV3Draft_universal_d_DeleteDraftPostRequest = DeleteDraftPostRequest;\n type blogV3Draft_universal_d_DeleteDraftPostResponse = DeleteDraftPostResponse;\n type blogV3Draft_universal_d_RemoveFromTrashBinRequest = RemoveFromTrashBinRequest;\n type blogV3Draft_universal_d_RemoveFromTrashBinResponse = RemoveFromTrashBinResponse;\n type blogV3Draft_universal_d_BulkDeleteDraftPostsRequest = BulkDeleteDraftPostsRequest;\n type blogV3Draft_universal_d_BulkDeleteDraftPostsResponse = BulkDeleteDraftPostsResponse;\n type blogV3Draft_universal_d_ListDraftPostsRequest = ListDraftPostsRequest;\n type blogV3Draft_universal_d_ListDraftPostsResponse = ListDraftPostsResponse;\n type blogV3Draft_universal_d_GetDeletedDraftPostRequest = GetDeletedDraftPostRequest;\n type blogV3Draft_universal_d_GetDeletedDraftPostResponse = GetDeletedDraftPostResponse;\n type blogV3Draft_universal_d_RestoreFromTrashBinRequest = RestoreFromTrashBinRequest;\n type blogV3Draft_universal_d_RestoreFromTrashBinResponse = RestoreFromTrashBinResponse;\n type blogV3Draft_universal_d_QueryDraftPostsRequest = QueryDraftPostsRequest;\n type blogV3Draft_universal_d_QueryDraftPostsResponse = QueryDraftPostsResponse;\n type blogV3Draft_universal_d_PublishDraftPostRequest = PublishDraftPostRequest;\n type blogV3Draft_universal_d_PublishDraftPostResponse = PublishDraftPostResponse;\n type blogV3Draft_universal_d_UnpublishPostRequest = UnpublishPostRequest;\n type blogV3Draft_universal_d_UnpublishPostResponse = UnpublishPostResponse;\n type blogV3Draft_universal_d_GetDraftPostTotalsRequest = GetDraftPostTotalsRequest;\n type blogV3Draft_universal_d_TotalDraftPostsGroupingField = TotalDraftPostsGroupingField;\n const blogV3Draft_universal_d_TotalDraftPostsGroupingField: typeof TotalDraftPostsGroupingField;\n type blogV3Draft_universal_d_GetDraftPostTotalsResponse = GetDraftPostTotalsResponse;\n type blogV3Draft_universal_d_TotalDraftPosts = TotalDraftPosts;\n type blogV3Draft_universal_d_TranslateCategoryRequest = TranslateCategoryRequest;\n type blogV3Draft_universal_d_TranslateCategoryResponse = TranslateCategoryResponse;\n type blogV3Draft_universal_d_TranslateDraftRequest = TranslateDraftRequest;\n type blogV3Draft_universal_d_TranslateDraftResponse = TranslateDraftResponse;\n type blogV3Draft_universal_d_IsDraftPostAutoTranslatableRequest = IsDraftPostAutoTranslatableRequest;\n type blogV3Draft_universal_d_IsDraftPostAutoTranslatableResponse = IsDraftPostAutoTranslatableResponse;\n type blogV3Draft_universal_d_UpdateDraftPostLanguageRequest = UpdateDraftPostLanguageRequest;\n type blogV3Draft_universal_d_UpdateDraftPostLanguageResponse = UpdateDraftPostLanguageResponse;\n type blogV3Draft_universal_d_BulkUpdateDraftPostLanguageRequest = BulkUpdateDraftPostLanguageRequest;\n type blogV3Draft_universal_d_BulkUpdateDraftPostLanguageResponse = BulkUpdateDraftPostLanguageResponse;\n type blogV3Draft_universal_d_GetPostAmountsByLanguageRequest = GetPostAmountsByLanguageRequest;\n type blogV3Draft_universal_d_GetPostAmountsByLanguageResponse = GetPostAmountsByLanguageResponse;\n type blogV3Draft_universal_d_PostAmountByLanguage = PostAmountByLanguage;\n type blogV3Draft_universal_d_BulkRevertToUnpublishedRequest = BulkRevertToUnpublishedRequest;\n type blogV3Draft_universal_d_BulkRevertToUnpublishedResponse = BulkRevertToUnpublishedResponse;\n type blogV3Draft_universal_d_BulkRejectDraftPostRequest = BulkRejectDraftPostRequest;\n type blogV3Draft_universal_d_BulkRejectDraftPostResponse = BulkRejectDraftPostResponse;\n type blogV3Draft_universal_d_RevertToUnpublishedRequest = RevertToUnpublishedRequest;\n type blogV3Draft_universal_d_RevertToUnpublishedResponse = RevertToUnpublishedResponse;\n type blogV3Draft_universal_d_RejectDraftPostRequest = RejectDraftPostRequest;\n type blogV3Draft_universal_d_RejectDraftPostResponse = RejectDraftPostResponse;\n type blogV3Draft_universal_d_ApproveDraftPostRequest = ApproveDraftPostRequest;\n type blogV3Draft_universal_d_ApproveDraftPostResponse = ApproveDraftPostResponse;\n type blogV3Draft_universal_d_MarkPostAsInModerationRequest = MarkPostAsInModerationRequest;\n type blogV3Draft_universal_d_MarkPostAsInModerationResponse = MarkPostAsInModerationResponse;\n const blogV3Draft_universal_d_createDraftPost: typeof createDraftPost;\n type blogV3Draft_universal_d_CreateDraftPostOptions = CreateDraftPostOptions;\n const blogV3Draft_universal_d_bulkCreateDraftPosts: typeof bulkCreateDraftPosts;\n type blogV3Draft_universal_d_BulkCreateDraftPostsOptions = BulkCreateDraftPostsOptions;\n const blogV3Draft_universal_d_bulkUpdateDraftPosts: typeof bulkUpdateDraftPosts;\n type blogV3Draft_universal_d_BulkUpdateDraftPostsOptions = BulkUpdateDraftPostsOptions;\n const blogV3Draft_universal_d_listDeletedDraftPosts: typeof listDeletedDraftPosts;\n type blogV3Draft_universal_d_ListDeletedDraftPostsOptions = ListDeletedDraftPostsOptions;\n const blogV3Draft_universal_d_getDraftPost: typeof getDraftPost;\n type blogV3Draft_universal_d_GetDraftPostOptions = GetDraftPostOptions;\n const blogV3Draft_universal_d_updateDraftPostContent: typeof updateDraftPostContent;\n type blogV3Draft_universal_d_UpdateDraftPostContentOptions = UpdateDraftPostContentOptions;\n const blogV3Draft_universal_d_updateDraftPost: typeof updateDraftPost;\n type blogV3Draft_universal_d_UpdateDraftPost = UpdateDraftPost;\n type blogV3Draft_universal_d_UpdateDraftPostOptions = UpdateDraftPostOptions;\n const blogV3Draft_universal_d_deleteDraftPost: typeof deleteDraftPost;\n type blogV3Draft_universal_d_DeleteDraftPostOptions = DeleteDraftPostOptions;\n const blogV3Draft_universal_d_removeFromTrashBin: typeof removeFromTrashBin;\n const blogV3Draft_universal_d_bulkDeleteDraftPosts: typeof bulkDeleteDraftPosts;\n type blogV3Draft_universal_d_BulkDeleteDraftPostsOptions = BulkDeleteDraftPostsOptions;\n const blogV3Draft_universal_d_listDraftPosts: typeof listDraftPosts;\n type blogV3Draft_universal_d_ListDraftPostsOptions = ListDraftPostsOptions;\n const blogV3Draft_universal_d_getDeletedDraftPost: typeof getDeletedDraftPost;\n const blogV3Draft_universal_d_restoreFromTrashBin: typeof restoreFromTrashBin;\n const blogV3Draft_universal_d_queryDraftPosts: typeof queryDraftPosts;\n type blogV3Draft_universal_d_QueryDraftPostsOptions = QueryDraftPostsOptions;\n type blogV3Draft_universal_d_DraftPostsQueryResult = DraftPostsQueryResult;\n type blogV3Draft_universal_d_DraftPostsQueryBuilder = DraftPostsQueryBuilder;\n const blogV3Draft_universal_d_publishDraftPost: typeof publishDraftPost;\n const blogV3Draft_universal_d_unpublishPost: typeof unpublishPost;\n const blogV3Draft_universal_d_getDraftPostTotals: typeof getDraftPostTotals;\n type blogV3Draft_universal_d_GetDraftPostTotalsOptions = GetDraftPostTotalsOptions;\n const blogV3Draft_universal_d_translateCategory: typeof translateCategory;\n const blogV3Draft_universal_d_translateDraft: typeof translateDraft;\n type blogV3Draft_universal_d_TranslateDraftOptions = TranslateDraftOptions;\n const blogV3Draft_universal_d_isDraftPostAutoTranslatable: typeof isDraftPostAutoTranslatable;\n const blogV3Draft_universal_d_updateDraftPostLanguage: typeof updateDraftPostLanguage;\n type blogV3Draft_universal_d_UpdateDraftPostLanguageOptions = UpdateDraftPostLanguageOptions;\n const blogV3Draft_universal_d_bulkUpdateDraftPostLanguage: typeof bulkUpdateDraftPostLanguage;\n type blogV3Draft_universal_d_BulkUpdateDraftPostLanguageOptions = BulkUpdateDraftPostLanguageOptions;\n const blogV3Draft_universal_d_getPostAmountsByLanguage: typeof getPostAmountsByLanguage;\n const blogV3Draft_universal_d_bulkRevertToUnpublished: typeof bulkRevertToUnpublished;\n type blogV3Draft_universal_d_BulkRevertToUnpublishedOptions = BulkRevertToUnpublishedOptions;\n const blogV3Draft_universal_d_bulkRejectDraftPost: typeof bulkRejectDraftPost;\n type blogV3Draft_universal_d_BulkRejectDraftPostOptions = BulkRejectDraftPostOptions;\n const blogV3Draft_universal_d_revertToUnpublished: typeof revertToUnpublished;\n type blogV3Draft_universal_d_RevertToUnpublishedOptions = RevertToUnpublishedOptions;\n const blogV3Draft_universal_d_rejectDraftPost: typeof rejectDraftPost;\n type blogV3Draft_universal_d_RejectDraftPostOptions = RejectDraftPostOptions;\n const blogV3Draft_universal_d_approveDraftPost: typeof approveDraftPost;\n type blogV3Draft_universal_d_ApproveDraftPostOptions = ApproveDraftPostOptions;\n const blogV3Draft_universal_d_markPostAsInModeration: typeof markPostAsInModeration;\n type blogV3Draft_universal_d_MarkPostAsInModerationOptions = MarkPostAsInModerationOptions;\n namespace blogV3Draft_universal_d {\n export {\n DraftPost$1 as DraftPost,\n CoverMedia$1 as CoverMedia,\n CoverMediaMediaOneOf$1 as CoverMediaMediaOneOf,\n FocalPoint$1 as FocalPoint,\n Origin$1 as Origin,\n RichContent$1 as RichContent,\n Node$1 as Node,\n NodeDataOneOf$1 as NodeDataOneOf,\n NodeType$1 as NodeType,\n NodeStyle$1 as NodeStyle,\n ButtonData$1 as ButtonData,\n Border$1 as Border,\n Colors$1 as Colors,\n PluginContainerData$1 as PluginContainerData,\n WidthType$1 as WidthType,\n PluginContainerDataWidth$1 as PluginContainerDataWidth,\n PluginContainerDataWidthDataOneOf$1 as PluginContainerDataWidthDataOneOf,\n PluginContainerDataAlignment$1 as PluginContainerDataAlignment,\n Spoiler$1 as Spoiler,\n Height$1 as Height,\n blogV3Draft_universal_d_ButtonDataType as ButtonDataType,\n Styles$1 as Styles,\n Link$1 as Link,\n LinkDataOneOf$1 as LinkDataOneOf,\n Target$1 as Target,\n Rel$1 as Rel,\n CodeBlockData$1 as CodeBlockData,\n TextStyle$1 as TextStyle,\n TextAlignment$1 as TextAlignment,\n DividerData$1 as DividerData,\n LineStyle$1 as LineStyle,\n Width$1 as Width,\n Alignment$1 as Alignment,\n FileData$1 as FileData,\n ViewMode$1 as ViewMode,\n FileSource$1 as FileSource,\n FileSourceDataOneOf$1 as FileSourceDataOneOf,\n PDFSettings$1 as PDFSettings,\n GalleryData$1 as GalleryData,\n blogV3Draft_universal_d_V1Media as V1Media,\n Image$1 as Image,\n Video$1 as Video,\n Item$1 as Item,\n ItemDataOneOf$1 as ItemDataOneOf,\n GalleryOptions$1 as GalleryOptions,\n LayoutType$1 as LayoutType,\n Orientation$1 as Orientation,\n Crop$1 as Crop,\n ThumbnailsAlignment$1 as ThumbnailsAlignment,\n Layout$1 as Layout,\n ItemStyle$1 as ItemStyle,\n Thumbnails$1 as Thumbnails,\n GIFData$1 as GIFData,\n GIF$1 as GIF,\n HeadingData$1 as HeadingData,\n HTMLData$1 as HTMLData,\n HTMLDataDataOneOf$1 as HTMLDataDataOneOf,\n Source$1 as Source,\n ImageData$1 as ImageData,\n LinkPreviewData$1 as LinkPreviewData,\n MapData$1 as MapData,\n MapSettings$1 as MapSettings,\n MapType$1 as MapType,\n ParagraphData$1 as ParagraphData,\n PollData$1 as PollData,\n ViewRole$1 as ViewRole,\n VoteRole$1 as VoteRole,\n Permissions$1 as Permissions,\n Option$1 as Option,\n PollSettings$1 as PollSettings,\n PollLayoutType$1 as PollLayoutType,\n PollLayoutDirection$1 as PollLayoutDirection,\n PollLayout$1 as PollLayout,\n OptionLayout$1 as OptionLayout,\n BackgroundType$1 as BackgroundType,\n Gradient$1 as Gradient,\n Background$1 as Background,\n BackgroundBackgroundOneOf$1 as BackgroundBackgroundOneOf,\n PollDesign$1 as PollDesign,\n OptionDesign$1 as OptionDesign,\n Poll$1 as Poll,\n PollDataLayout$1 as PollDataLayout,\n Design$1 as Design,\n TextData$1 as TextData,\n Decoration$1 as Decoration,\n DecorationDataOneOf$1 as DecorationDataOneOf,\n DecorationType$1 as DecorationType,\n AnchorData$1 as AnchorData,\n ColorData$1 as ColorData,\n LinkData$1 as LinkData,\n MentionData$1 as MentionData,\n FontSizeData$1 as FontSizeData,\n FontType$1 as FontType,\n SpoilerData$1 as SpoilerData,\n AppEmbedData$1 as AppEmbedData,\n AppEmbedDataAppDataOneOf$1 as AppEmbedDataAppDataOneOf,\n AppType$1 as AppType,\n BookingData$1 as BookingData,\n EventData$1 as EventData,\n VideoData$1 as VideoData,\n PlaybackOptions$1 as PlaybackOptions,\n EmbedData$1 as EmbedData,\n Oembed$1 as Oembed,\n CollapsibleListData$1 as CollapsibleListData,\n InitialExpandedItems$1 as InitialExpandedItems,\n Direction$1 as Direction,\n TableData$1 as TableData,\n Dimensions$1 as Dimensions,\n TableCellData$1 as TableCellData,\n VerticalAlignment$1 as VerticalAlignment,\n CellStyle$1 as CellStyle,\n BorderColors$1 as BorderColors,\n NullValue$1 as NullValue,\n ListValue$1 as ListValue,\n AudioData$1 as AudioData,\n OrderedListData$1 as OrderedListData,\n BulletedListData$1 as BulletedListData,\n BlockquoteData$1 as BlockquoteData,\n CaptionData$1 as CaptionData,\n Metadata$1 as Metadata,\n DocumentStyle$1 as DocumentStyle,\n TextNodeStyle$1 as TextNodeStyle,\n Status$1 as Status,\n ModerationDetails$1 as ModerationDetails,\n ModerationStatusStatus$1 as ModerationStatusStatus,\n SeoSchema$2 as SeoSchema,\n Keyword$2 as Keyword,\n Tag$2 as Tag,\n Settings$2 as Settings,\n Media$1 as Media,\n blogV3Draft_universal_d_MediaMediaOneOf as MediaMediaOneOf,\n WixMedia$1 as WixMedia,\n VideoResolution$1 as VideoResolution,\n EmbedMedia$1 as EmbedMedia,\n EmbedThumbnail$1 as EmbedThumbnail,\n EmbedVideo$1 as EmbedVideo,\n DraftPostTranslation$1 as DraftPostTranslation,\n blogV3Draft_universal_d_InitialDraftPostsCopied as InitialDraftPostsCopied,\n blogV3Draft_universal_d_CreateDraftPostRequest as CreateDraftPostRequest,\n Type$1 as Type,\n Field$2 as Field,\n blogV3Draft_universal_d_CreateDraftPostResponse as CreateDraftPostResponse,\n blogV3Draft_universal_d_BulkCreateDraftPostsRequest as BulkCreateDraftPostsRequest,\n blogV3Draft_universal_d_BulkCreateDraftPostsResponse as BulkCreateDraftPostsResponse,\n blogV3Draft_universal_d_BulkDraftPostResult as BulkDraftPostResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n blogV3Draft_universal_d_BulkUpdateDraftPostsRequest as BulkUpdateDraftPostsRequest,\n blogV3Draft_universal_d_MaskedDraftPosts as MaskedDraftPosts,\n blogV3Draft_universal_d_Action as Action,\n blogV3Draft_universal_d_BulkUpdateDraftPostsResponse as BulkUpdateDraftPostsResponse,\n blogV3Draft_universal_d_DraftPostOwnerChanged as DraftPostOwnerChanged,\n blogV3Draft_universal_d_ListDeletedDraftPostsRequest as ListDeletedDraftPostsRequest,\n blogV3Draft_universal_d_GetDraftPostsSort as GetDraftPostsSort,\n BlogPaging$1 as BlogPaging,\n blogV3Draft_universal_d_ListDeletedDraftPostsResponse as ListDeletedDraftPostsResponse,\n MetaData$2 as MetaData,\n blogV3Draft_universal_d_GetDraftPostRequest as GetDraftPostRequest,\n blogV3Draft_universal_d_GetDraftPostResponse as GetDraftPostResponse,\n blogV3Draft_universal_d_UpdateDraftPostContentRequest as UpdateDraftPostContentRequest,\n blogV3Draft_universal_d_UpdateDraftPostContentRequestDraftContentOneOf as UpdateDraftPostContentRequestDraftContentOneOf,\n blogV3Draft_universal_d_UpdateDraftPostContentResponse as UpdateDraftPostContentResponse,\n blogV3Draft_universal_d_UpdateDraftPostRequest as UpdateDraftPostRequest,\n blogV3Draft_universal_d_UpdateDraftPostResponse as UpdateDraftPostResponse,\n blogV3Draft_universal_d_DeleteDraftPostRequest as DeleteDraftPostRequest,\n blogV3Draft_universal_d_DeleteDraftPostResponse as DeleteDraftPostResponse,\n blogV3Draft_universal_d_RemoveFromTrashBinRequest as RemoveFromTrashBinRequest,\n blogV3Draft_universal_d_RemoveFromTrashBinResponse as RemoveFromTrashBinResponse,\n blogV3Draft_universal_d_BulkDeleteDraftPostsRequest as BulkDeleteDraftPostsRequest,\n blogV3Draft_universal_d_BulkDeleteDraftPostsResponse as BulkDeleteDraftPostsResponse,\n blogV3Draft_universal_d_ListDraftPostsRequest as ListDraftPostsRequest,\n blogV3Draft_universal_d_ListDraftPostsResponse as ListDraftPostsResponse,\n blogV3Draft_universal_d_GetDeletedDraftPostRequest as GetDeletedDraftPostRequest,\n blogV3Draft_universal_d_GetDeletedDraftPostResponse as GetDeletedDraftPostResponse,\n blogV3Draft_universal_d_RestoreFromTrashBinRequest as RestoreFromTrashBinRequest,\n blogV3Draft_universal_d_RestoreFromTrashBinResponse as RestoreFromTrashBinResponse,\n blogV3Draft_universal_d_QueryDraftPostsRequest as QueryDraftPostsRequest,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n PlatformQuery$2 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf,\n Paging$2 as Paging,\n CursorPaging$2 as CursorPaging,\n blogV3Draft_universal_d_QueryDraftPostsResponse as QueryDraftPostsResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n Cursors$2 as Cursors,\n blogV3Draft_universal_d_PublishDraftPostRequest as PublishDraftPostRequest,\n blogV3Draft_universal_d_PublishDraftPostResponse as PublishDraftPostResponse,\n blogV3Draft_universal_d_UnpublishPostRequest as UnpublishPostRequest,\n blogV3Draft_universal_d_UnpublishPostResponse as UnpublishPostResponse,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n blogV3Draft_universal_d_GetDraftPostTotalsRequest as GetDraftPostTotalsRequest,\n blogV3Draft_universal_d_TotalDraftPostsGroupingField as TotalDraftPostsGroupingField,\n blogV3Draft_universal_d_GetDraftPostTotalsResponse as GetDraftPostTotalsResponse,\n blogV3Draft_universal_d_TotalDraftPosts as TotalDraftPosts,\n blogV3Draft_universal_d_TranslateCategoryRequest as TranslateCategoryRequest,\n blogV3Draft_universal_d_TranslateCategoryResponse as TranslateCategoryResponse,\n Category$1 as Category,\n CategoryTranslation$1 as CategoryTranslation,\n blogV3Draft_universal_d_TranslateDraftRequest as TranslateDraftRequest,\n blogV3Draft_universal_d_TranslateDraftResponse as TranslateDraftResponse,\n blogV3Draft_universal_d_IsDraftPostAutoTranslatableRequest as IsDraftPostAutoTranslatableRequest,\n blogV3Draft_universal_d_IsDraftPostAutoTranslatableResponse as IsDraftPostAutoTranslatableResponse,\n blogV3Draft_universal_d_UpdateDraftPostLanguageRequest as UpdateDraftPostLanguageRequest,\n blogV3Draft_universal_d_UpdateDraftPostLanguageResponse as UpdateDraftPostLanguageResponse,\n blogV3Draft_universal_d_BulkUpdateDraftPostLanguageRequest as BulkUpdateDraftPostLanguageRequest,\n blogV3Draft_universal_d_BulkUpdateDraftPostLanguageResponse as BulkUpdateDraftPostLanguageResponse,\n blogV3Draft_universal_d_GetPostAmountsByLanguageRequest as GetPostAmountsByLanguageRequest,\n blogV3Draft_universal_d_GetPostAmountsByLanguageResponse as GetPostAmountsByLanguageResponse,\n blogV3Draft_universal_d_PostAmountByLanguage as PostAmountByLanguage,\n blogV3Draft_universal_d_BulkRevertToUnpublishedRequest as BulkRevertToUnpublishedRequest,\n blogV3Draft_universal_d_BulkRevertToUnpublishedResponse as BulkRevertToUnpublishedResponse,\n blogV3Draft_universal_d_BulkRejectDraftPostRequest as BulkRejectDraftPostRequest,\n blogV3Draft_universal_d_BulkRejectDraftPostResponse as BulkRejectDraftPostResponse,\n blogV3Draft_universal_d_RevertToUnpublishedRequest as RevertToUnpublishedRequest,\n blogV3Draft_universal_d_RevertToUnpublishedResponse as RevertToUnpublishedResponse,\n blogV3Draft_universal_d_RejectDraftPostRequest as RejectDraftPostRequest,\n blogV3Draft_universal_d_RejectDraftPostResponse as RejectDraftPostResponse,\n blogV3Draft_universal_d_ApproveDraftPostRequest as ApproveDraftPostRequest,\n blogV3Draft_universal_d_ApproveDraftPostResponse as ApproveDraftPostResponse,\n blogV3Draft_universal_d_MarkPostAsInModerationRequest as MarkPostAsInModerationRequest,\n blogV3Draft_universal_d_MarkPostAsInModerationResponse as MarkPostAsInModerationResponse,\n blogV3Draft_universal_d_createDraftPost as createDraftPost,\n blogV3Draft_universal_d_CreateDraftPostOptions as CreateDraftPostOptions,\n blogV3Draft_universal_d_bulkCreateDraftPosts as bulkCreateDraftPosts,\n blogV3Draft_universal_d_BulkCreateDraftPostsOptions as BulkCreateDraftPostsOptions,\n blogV3Draft_universal_d_bulkUpdateDraftPosts as bulkUpdateDraftPosts,\n blogV3Draft_universal_d_BulkUpdateDraftPostsOptions as BulkUpdateDraftPostsOptions,\n blogV3Draft_universal_d_listDeletedDraftPosts as listDeletedDraftPosts,\n blogV3Draft_universal_d_ListDeletedDraftPostsOptions as ListDeletedDraftPostsOptions,\n blogV3Draft_universal_d_getDraftPost as getDraftPost,\n blogV3Draft_universal_d_GetDraftPostOptions as GetDraftPostOptions,\n blogV3Draft_universal_d_updateDraftPostContent as updateDraftPostContent,\n blogV3Draft_universal_d_UpdateDraftPostContentOptions as UpdateDraftPostContentOptions,\n blogV3Draft_universal_d_updateDraftPost as updateDraftPost,\n blogV3Draft_universal_d_UpdateDraftPost as UpdateDraftPost,\n blogV3Draft_universal_d_UpdateDraftPostOptions as UpdateDraftPostOptions,\n blogV3Draft_universal_d_deleteDraftPost as deleteDraftPost,\n blogV3Draft_universal_d_DeleteDraftPostOptions as DeleteDraftPostOptions,\n blogV3Draft_universal_d_removeFromTrashBin as removeFromTrashBin,\n blogV3Draft_universal_d_bulkDeleteDraftPosts as bulkDeleteDraftPosts,\n blogV3Draft_universal_d_BulkDeleteDraftPostsOptions as BulkDeleteDraftPostsOptions,\n blogV3Draft_universal_d_listDraftPosts as listDraftPosts,\n blogV3Draft_universal_d_ListDraftPostsOptions as ListDraftPostsOptions,\n blogV3Draft_universal_d_getDeletedDraftPost as getDeletedDraftPost,\n blogV3Draft_universal_d_restoreFromTrashBin as restoreFromTrashBin,\n blogV3Draft_universal_d_queryDraftPosts as queryDraftPosts,\n blogV3Draft_universal_d_QueryDraftPostsOptions as QueryDraftPostsOptions,\n blogV3Draft_universal_d_DraftPostsQueryResult as DraftPostsQueryResult,\n blogV3Draft_universal_d_DraftPostsQueryBuilder as DraftPostsQueryBuilder,\n blogV3Draft_universal_d_publishDraftPost as publishDraftPost,\n blogV3Draft_universal_d_unpublishPost as unpublishPost,\n blogV3Draft_universal_d_getDraftPostTotals as getDraftPostTotals,\n blogV3Draft_universal_d_GetDraftPostTotalsOptions as GetDraftPostTotalsOptions,\n blogV3Draft_universal_d_translateCategory as translateCategory,\n blogV3Draft_universal_d_translateDraft as translateDraft,\n blogV3Draft_universal_d_TranslateDraftOptions as TranslateDraftOptions,\n blogV3Draft_universal_d_isDraftPostAutoTranslatable as isDraftPostAutoTranslatable,\n blogV3Draft_universal_d_updateDraftPostLanguage as updateDraftPostLanguage,\n blogV3Draft_universal_d_UpdateDraftPostLanguageOptions as UpdateDraftPostLanguageOptions,\n blogV3Draft_universal_d_bulkUpdateDraftPostLanguage as bulkUpdateDraftPostLanguage,\n blogV3Draft_universal_d_BulkUpdateDraftPostLanguageOptions as BulkUpdateDraftPostLanguageOptions,\n blogV3Draft_universal_d_getPostAmountsByLanguage as getPostAmountsByLanguage,\n blogV3Draft_universal_d_bulkRevertToUnpublished as bulkRevertToUnpublished,\n blogV3Draft_universal_d_BulkRevertToUnpublishedOptions as BulkRevertToUnpublishedOptions,\n blogV3Draft_universal_d_bulkRejectDraftPost as bulkRejectDraftPost,\n blogV3Draft_universal_d_BulkRejectDraftPostOptions as BulkRejectDraftPostOptions,\n blogV3Draft_universal_d_revertToUnpublished as revertToUnpublished,\n blogV3Draft_universal_d_RevertToUnpublishedOptions as RevertToUnpublishedOptions,\n blogV3Draft_universal_d_rejectDraftPost as rejectDraftPost,\n blogV3Draft_universal_d_RejectDraftPostOptions as RejectDraftPostOptions,\n blogV3Draft_universal_d_approveDraftPost as approveDraftPost,\n blogV3Draft_universal_d_ApproveDraftPostOptions as ApproveDraftPostOptions,\n blogV3Draft_universal_d_markPostAsInModeration as markPostAsInModeration,\n blogV3Draft_universal_d_MarkPostAsInModerationOptions as MarkPostAsInModerationOptions,\n };\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: 500 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 | null;\n /**\n * Date the post was last published.\n * @readonly\n */\n lastPublishedDate?: Date | null;\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 /**\n * Reserved for internal use.\n * @deprecated\n * @replacedBy media\n * @targetRemovalDate 2024-06-30\n */\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 /**\n * Dynamic post count info Comment Count, Like Count, View Count.\n * @internal\n * @deprecated Dynamic post count info Comment Count, Like Count, View Count.\n * @replacedBy metrics\n * @targetRemovalDate 2024-06-30\n */\n postCountInfo?: PostCountInfo;\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 /**\n * Reserved for internal use.\n * @internal\n * @deprecated\n */\n metrics?: Metrics;\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 /**\n * Whether the returned content is a preview of premium content. Defaults to `false`.\n * A preview displays a limited number of paragraphs of paid content to non-subscribed users.\n * @readonly\n */\n preview?: boolean;\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 * Post rich content as a string\n * @internal\n * @readonly\n */\n richContentString?: string | null;\n /**\n * Post rich content as compressed binary data\n * @internal\n * @readonly\n */\n richContentCompressed?: Uint8Array | null;\n /**\n * Indicates if there is a draft post with changes that have not yet been published.\n * @readonly\n */\n hasUnpublishedChanges?: boolean;\n /**\n * List of the post's translated posts.\n * @internal\n * @readonly\n */\n translations?: PostTranslation[];\n /**\n * Identifies whether excerpt was set by contributor.\n * True - excerpt was set by contributor.\n * False - excerpt was generated from content.\n * @internal\n * @readonly\n */\n customExcerpt?: boolean;\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 * Identifies if post is created from template\n * Reserved for internal use.\n * @internal\n * @readonly\n */\n isDemo?: boolean | null;\n }\n interface CoverMedia extends CoverMediaMediaOneOf {\n /** Image url. */\n image?: string;\n /** Video url. */\n video?: string;\n /**\n * Is cover media enabled.\n * Selected by user whether to display cover media on the feed\n * @deprecated Is cover media enabled.\n * Selected by user whether to display cover media on the feed\n * @replacedBy displayed\n * @targetRemovalDate 2024-06-30\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 }\n /** @oneof */\n interface CoverMediaMediaOneOf {\n /** Image url. */\n image?: string;\n /** Video url. */\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 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 * Total number of post ratings.\n * @internal\n * @readonly\n */\n totalRatings?: number;\n /**\n * Average rating of post from 1 to 5.\n * @internal\n * @readonly\n */\n averageRating?: 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 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 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 /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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 /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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 /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\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 /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\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 /** 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?: 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 /** 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 SpoilerData {\n /** Spoiler ID. */\n _id?: string | null;\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 /**\n * Deprecated: Use `image` instead.\n * @deprecated\n */\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 /**\n * Deprecated: Use `rowHeader` and `columnHeader` instead.\n * @deprecated\n */\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 CaptionData {\n textStyle?: TextStyle;\n }\n interface Metadata {\n /** Schema version. */\n version?: number;\n /**\n * When the object was created.\n * @readonly\n */\n createdTimestamp?: Date | null;\n /** When the object was most recently updated. */\n updatedTimestamp?: Date | null;\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 | null;\n /** Status indicating whether the submission was approved or rejected by the moderator. */\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 | null;\n }\n enum ModerationStatusStatus {\n UNKNOWN = \"UNKNOWN\",\n APPROVED = \"APPROVED\",\n REJECTED = \"REJECTED\"\n }\n interface BlogMedia extends BlogMediaMediaOneOf {\n /** Wix Media details. */\n wixMedia?: WixMedia;\n /** Embed media details. */\n embedMedia?: EmbedMedia;\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 }\n /** @oneof */\n interface BlogMediaMediaOneOf {\n /** Wix Media details. */\n wixMedia?: WixMedia;\n /** Embed media details. */\n embedMedia?: EmbedMedia;\n }\n interface WixMedia {\n /** Image details. */\n image?: string;\n /** Video details. */\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 /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\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 PostTranslation {\n /** Post ID. */\n _id?: string;\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 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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 ConvertDraftJsToRichContentRequest {\n /** DraftJs content to convert to Rich content. */\n content?: Record | null;\n }\n interface ConvertDraftJsToRichContentResponse {\n /** Rich content converted from DraftJs content. */\n richContent?: string;\n }\n interface ConvertRichContentToDraftJsRequest {\n /** Rich content to convert to DraftJs content. */\n richContent?: string;\n }\n interface ConvertRichContentToDraftJsResponse {\n /** DraftJs content converted from Rich content. */\n content?: Record | null;\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 * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 enum GetPostsSort {\n /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */\n FEED = \"FEED\",\n /** Ordered by `firstPublishedDate` in ascending order. */\n PUBLISHED_DATE_ASC = \"PUBLISHED_DATE_ASC\",\n /** Ordered by `firstPublishedDate` in descending order. */\n PUBLISHED_DATE_DESC = \"PUBLISHED_DATE_DESC\",\n /** Ordered by total number of views in descending order. */\n VIEW_COUNT = \"VIEW_COUNT\",\n /** Ordered by total number of likes in descending order. */\n LIKE_COUNT = \"LIKE_COUNT\",\n /** Ordered by `title` in ascening order. */\n TITLE_ASC = \"TITLE_ASC\",\n /** Ordered by `title` in descending order. */\n TITLE_DESC = \"TITLE_DESC\",\n /** Sorting by post rating descending. */\n RATING = \"RATING\"\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 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 /** Includes post rich content string. */\n RICH_CONTENT_STRING = \"RICH_CONTENT_STRING\",\n /** Includes compressed post rich content string. */\n RICH_CONTENT_COMPRESSED = \"RICH_CONTENT_COMPRESSED\",\n /** Includes post translations. */\n TRANSLATIONS = \"TRANSLATIONS\"\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 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 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 /** Sort by ascending publishing date. */\n PUBLISHED_DATE_ASC = \"PUBLISHED_DATE_ASC\",\n /** Sort by descending publishing date. */\n PUBLISHED_DATE_DESC = \"PUBLISHED_DATE_DESC\"\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 Category {\n /** Category ID. */\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 * The `url` of the page that lists every post with the specified category.\n * @readonly\n */\n url?: string;\n /** Category description. */\n description?: string | null;\n /**\n * Category title.\n * @deprecated Category title.\n * @targetRemovalDate 2025-07-16\n */\n title?: string;\n /**\n * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).\n * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.\n *\n * Default: `-1`\n */\n displayPosition?: number | null;\n /** ID of the category's translations. All translations of a single category share the same `translationId`. */\n translationId?: string | null;\n /**\n * Category language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /** Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`. */\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 * Category translations.\n * @internal\n * @readonly\n */\n translations?: CategoryTranslation[];\n /**\n * Date and time the Category was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface CategoryTranslation {\n /** Category ID. */\n _id?: string;\n /** Label displayed in the categories menu on the site. */\n label?: string | null;\n /** Language of the category. */\n language?: string | null;\n /** URL of this category page. */\n url?: 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 /**\n * __Deprecated.__ Use `media` instead.\n * This property will be removed on June 6, 2023.\n *\n * Draft post cover media.\n * @internal\n * @deprecated\n * @replacedBy media\n * @targetRemovalDate 2024-06-30\n */\n coverMedia?: CoverMedia;\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 * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.\n */\n translationId?: string | null;\n /**\n * Language the draft post is written in.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 /**\n * Draft Post rich content.\n *\n * \n * See Ricos document reference\n * \n */\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 | null;\n /**\n * Date the draft post is scheduled to be published.\n * @readonly\n */\n scheduledPublishDate?: Date | null;\n /** Reserved for internal use. */\n content?: Record | null;\n /** Date the post was first published. */\n firstPublishedDate?: Date | null;\n /** SEO data. */\n seoData?: SeoSchema$1;\n /**\n * Reserved for internal use.\n * @deprecated\n * @replacedBy preview_text_paragraph\n * @targetRemovalDate 2024-06-30\n */\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 | null;\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 * List of the post's translated posts.\n * @internal\n * @readonly\n */\n translations?: DraftPostTranslation[];\n /**\n * Reserved for internal use, not included in base response.\n * @internal\n */\n originPostId?: string | null;\n /**\n * Reserved for internal use, not included in base response.\n * @internal\n */\n originPostInstanceId?: string | 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 /** Post was pinned */\n PIN = \"PIN\",\n /** Post was unpinned */\n UNPIN = \"UNPIN\",\n /** Saved automatically by AI tool. */\n AI_AUTO_SAVE = \"AI_AUTO_SAVE\"\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 2024-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 /** 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 /** ID of the liked post. */\n postId?: string;\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 /** 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 /** ID of the unliked post. */\n postId?: string;\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 /** 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 /** ID of the post which counters were updated. */\n postId?: string;\n /**\n * Internal ID of the post which counters were updated.\n * @internal\n */\n postInternalId?: string;\n /** Field of the updated counter. */\n updatedCounterField?: Field$1;\n /** New counter value. */\n counter?: number;\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 * Member ID of the post's owner before the change.\n * @internal\n */\n oldMemberId?: string;\n /**\n * Member ID of the post's owner after the change.\n * @internal\n */\n newMemberId?: string;\n }\n interface InitialPostsCopied {\n /** Number of posts copied. */\n count?: number;\n }\n interface GetPostRequest {\n /** Post ID. */\n postId: string;\n /**\n * Reserved for internal use.\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\n fieldsets?: PostFieldField[];\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 /**\n * Reserved for internal use.\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\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 /**\n * Reserved for internal use.\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\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 /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\n fieldsets?: PostFieldField[];\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 * @deprecated __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Pagination options.\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\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 * @deprecated __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Filter object.\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\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/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @deprecated __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/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n sort?: Sorting$1[];\n /**\n * Reserved for internal use.\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /** Query options. */\n query?: PlatformQuery$1;\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface PlatformQuery$1 extends 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 * 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 }\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 * @deprecated __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 * @replacedBy pagingMetadata\n * @targetRemovalDate 2024-06-30\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 * 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 * @internal\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 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 ViewPostRequest {\n /** Post ID. */\n postId: string;\n }\n interface ViewPostResponse {\n /** Total number of post views */\n views?: number;\n }\n interface LikePostRequest {\n /** Post ID. */\n postId: string;\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 LikePostResponse {\n /** Post info. */\n post?: Post;\n }\n interface UnlikePostRequest {\n /** Post ID. */\n postId: string;\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 UnlikePostResponse {\n /** Post info. */\n post?: Post;\n }\n interface PinPostRequest {\n /** Post ID. */\n postId: string;\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 PinPostResponse {\n /** Post info. */\n post?: Post;\n }\n interface UnpinPostRequest {\n /** Post ID. */\n postId: string;\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 UnpinPostResponse {\n /** Post info. */\n post?: Post;\n }\n interface ListPostsArchiveRequest {\n /** Month */\n month: number | null;\n /** Year */\n year: number;\n /** Time zone */\n timeZone?: string | null;\n /** Pagination options. */\n paging?: BlogPaging;\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 /**\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 ListPostsArchiveResponse {\n /** List of posts. */\n posts?: Post[];\n /** Details on the paged set of results returned. */\n metaData?: MetaData$1;\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2$1;\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 /** 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 | null;\n /** Non-inclusive end of time range to return, in ISO 8601 date and time format. */\n rangeEnd?: Date | null;\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-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 | null;\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 | null;\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 * @deprecated __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 * @replacedBy months\n * @targetRemovalDate 2024-06-30\n */\n rangeEnd?: Date | null;\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 | null;\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 postLikedAction?: PostLiked;\n postCountersUpdated?: PostCountersUpdated;\n entityId?: string;\n }\n /** @oneof */\n interface SendActionEventRequestActionOneOf {\n postLikedAction?: PostLiked;\n postCountersUpdated?: PostCountersUpdated;\n }\n interface SendActionEventResponse {\n }\n /**\n * Retrieves a list of published demo posts.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ-PUBLICATION\n */\n function listDemoPosts(options?: ListDemoPostsOptions): 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 * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 /**\n * Retrieves available post templates and template categories if asked\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ-PUBLICATION\n */\n function listTemplates(options?: ListTemplatesOptions): Promise;\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 post template by given id\n * @param postTemplateId - Post template id\n * @internal\n * @documentationMaturity preview\n * @requiredField postTemplateId\n * @permissionId BLOG.READ-PUBLICATION\n */\n function getTemplate(postTemplateId: string): Promise;\n /**\n * Creates draft post from specified post template\n * @param postTemplateId - Post template id\n * @internal\n * @documentationMaturity preview\n * @requiredField postTemplateId\n * @permissionId BLOG.CREATE-DRAFT\n * @adminMethod\n */\n function createDraftPostFromTemplate(postTemplateId: string): Promise;\n /**\n * Retrieves total likes of a member.\n * @param memberId - Member ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId BLOG.READ_LIKE\n */\n function getTotalLikesPerMember(memberId: string): Promise;\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 * @requiredField postId\n * @param options - Options specifying which fields to return.\n * @permissionId BLOG.READ-PUBLICATION\n * @returns Fulfilled - The requested post.\n */\n function getPost(postId: string, options?: GetPostOptions): Promise;\n interface GetPostOptions {\n /**\n * @internal\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\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 * @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 * @permissionId BLOG.READ-PUBLICATION\n * @returns Fulfilled - The requested post.\n */\n function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise;\n interface GetPostBySlugOptions {\n /**\n * @internal\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[];\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\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 * @param options - Sort, filter, and paging options.\n * @permissionId BLOG.READ-PUBLICATION\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 * @internal\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\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 /**\n * Member ID to filter for.\n *\n *\n * Default: All members\n */\n memberId?: string | null;\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\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 * @param options - Options specifying which fields to return.\n * @permissionId BLOG.READ-PUBLICATION\n */\n function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;\n interface QueryPostsOptions {\n /**\n * @internal\n * @deprecated __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Pagination options.\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n paging?: BlogPaging | undefined;\n /**\n * @internal\n * @deprecated __Deprecated.__ Use `query` instead.\n * This parameter will be removed on June 30, 2023.\n *\n * Filter object.\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n filter?: Record | null | undefined;\n /**\n * @internal\n * @deprecated __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/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).\n * @replacedBy query\n * @targetRemovalDate 2024-06-30\n */\n sort?: Sorting$1[] | undefined;\n /**\n * @internal\n * @deprecated __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 * @replacedBy fieldsets\n * @targetRemovalDate 2024-06-30\n */\n fieldsToInclude?: PostFieldField[] | undefined;\n /** List of post fields to be included in the response. By default, any fields not passed are not returned. */\n fieldsets?: PostFieldField[] | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PostsQueryResult extends QueryCursorResult {\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 */\n eq: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'coverMedia.enabled' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: 'title', value: string) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: '_id' | 'title' | 'slug' | 'categoryIds' | 'memberId' | 'hashtags' | 'tagIds' | 'pricingPlanIds' | 'language', value: any[]) => PostsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasAll: (propertyName: 'categoryIds' | 'hashtags' | 'tagIds' | 'pricingPlanIds', value: any[]) => PostsQueryBuilder;\n in: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;\n exists: (propertyName: 'title' | 'translationId' | 'language', value: boolean) => PostsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => PostsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => PostsQueryBuilder;\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 * @requiredField postId\n * @permissionId BLOG.READ-PUBLICATION\n * @returns Fulfilled - Post metrics.\n */\n function getPostMetrics(postId: string): Promise;\n /**\n * Retrieves a specified posts metrics.\n * @param postIds - Post IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField postIds\n * @permissionId BLOG.READ-PUBLICATION\n */\n function bulkGetPostMetrics(postIds: string[]): Promise;\n /**\n * Increment view counter of a post.\n * @param postId - Post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.READ-PUBLICATION\n */\n function viewPost(postId: string): Promise;\n /**\n * Like post\n * @param postId - Post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.LIKE-POST\n */\n function likePost(postId: string, options?: LikePostOptions): Promise;\n interface LikePostOptions {\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 /**\n * Unlike post\n * @param postId - Post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.LIKE-POST\n */\n function unlikePost(postId: string, options?: UnlikePostOptions): Promise;\n interface UnlikePostOptions {\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 /**\n * Pin post in the feed\n * @param postId - Post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.PIN-POST\n * @adminMethod\n */\n function pinPost(postId: string, options?: PinPostOptions): Promise;\n interface PinPostOptions {\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 /**\n * Unpin post in the feed\n * @param postId - Post ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId BLOG.PIN-POST\n * @adminMethod\n */\n function unpinPost(postId: string, options?: UnpinPostOptions): Promise;\n interface UnpinPostOptions {\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 /**\n * Retrieves a posts archive.\n * @param month - Month\n * @internal\n * @documentationMaturity preview\n * @requiredField month\n * @requiredField options.year\n * @permissionId BLOG.READ-PUBLICATION\n */\n function listPostsArchive(month: number | null, options?: ListPostsArchiveOptions): Promise;\n interface ListPostsArchiveOptions {\n /** Year */\n year: number;\n /** Time zone */\n timeZone?: string | null;\n /** Pagination options. */\n paging?: BlogPaging;\n /**\n * Language filter.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 /**\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 /**\n * Retrieves reactions of the current user for specified posts.\n * @param postIds - Post IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField postIds\n * @permissionId BLOG.READ-PUBLICATION\n */\n function bulkGetPostReactions(postIds: string[]): Promise;\n /**\n * Retrieves the number of posts per month published within a specified time span, from first day of a month - ignoring days value in period start field.\n * If `periodStart` value is set to `2018-11-10` and `months` value is set to `1`, the day value is ignored and statistic are returned for one month from\n * `2018-11-01` until `2018-11-30` and not between `2018-11-10` and `2018-12-10`.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ-PUBLICATION\n * @returns Get Blog Publications Count Stats response\n */\n function queryPublicationsCountStats(options?: QueryPublicationsCountStatsOptions): Promise;\n interface QueryPublicationsCountStatsOptions {\n /** Start of time range to return, in ISO 8601 date and time format. */\n rangeStart?: Date | null;\n /** Non-inclusive end of time range to return, in ISO 8601 date and time format. */\n rangeEnd?: Date | null;\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-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) 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 * @param options - Options specifying time frame, sort, and filter.\n * @permissionId BLOG.READ-PUBLICATION\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 | null;\n /**\n * Reserved for internal use.\n * @deprecated __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 * @replacedBy months\n * @targetRemovalDate 2024-06-30\n */\n rangeEnd?: Date | null;\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 /**\n * Retrieves the amount of published posts for the current blog.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ-PUBLICATION\n */\n function getTotalPublications(options?: GetTotalPublicationsOptions): Promise;\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 * @param options - Language Options.\n * @permissionId BLOG.READ-PUBLICATION\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 /** @internal\n * @documentationMaturity preview\n * @permissionId PostKafkaProducer.DelegateEcho\n * @adminMethod\n */\n function sendActionEvent(options?: SendActionEventOptions): Promise;\n interface SendActionEventOptions extends SendActionEventRequestActionOneOf {\n entityId?: string;\n postLikedAction?: PostLiked;\n postCountersUpdated?: PostCountersUpdated;\n }\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_FocalPoint = FocalPoint;\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_SpoilerData = SpoilerData;\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_CaptionData = CaptionData;\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_PostTranslation = PostTranslation;\n type blogV3Post_universal_d_OldBlogMigratedEvent = OldBlogMigratedEvent;\n type blogV3Post_universal_d_ConvertDraftJsToRichContentRequest = ConvertDraftJsToRichContentRequest;\n type blogV3Post_universal_d_ConvertDraftJsToRichContentResponse = ConvertDraftJsToRichContentResponse;\n type blogV3Post_universal_d_ConvertRichContentToDraftJsRequest = ConvertRichContentToDraftJsRequest;\n type blogV3Post_universal_d_ConvertRichContentToDraftJsResponse = ConvertRichContentToDraftJsResponse;\n type blogV3Post_universal_d_ListDemoPostsRequest = ListDemoPostsRequest;\n type blogV3Post_universal_d_GetPostsSort = GetPostsSort;\n const blogV3Post_universal_d_GetPostsSort: typeof GetPostsSort;\n type blogV3Post_universal_d_BlogPaging = BlogPaging;\n type blogV3Post_universal_d_PostFieldField = PostFieldField;\n const blogV3Post_universal_d_PostFieldField: typeof PostFieldField;\n type blogV3Post_universal_d_ListDemoPostsResponse = ListDemoPostsResponse;\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_ListTemplatesResponse = ListTemplatesResponse;\n type blogV3Post_universal_d_Category = Category;\n type blogV3Post_universal_d_CategoryTranslation = CategoryTranslation;\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_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_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_ViewPostRequest = ViewPostRequest;\n type blogV3Post_universal_d_ViewPostResponse = ViewPostResponse;\n type blogV3Post_universal_d_LikePostRequest = LikePostRequest;\n type blogV3Post_universal_d_LikePostResponse = LikePostResponse;\n type blogV3Post_universal_d_UnlikePostRequest = UnlikePostRequest;\n type blogV3Post_universal_d_UnlikePostResponse = UnlikePostResponse;\n type blogV3Post_universal_d_PinPostRequest = PinPostRequest;\n type blogV3Post_universal_d_PinPostResponse = PinPostResponse;\n type blogV3Post_universal_d_UnpinPostRequest = UnpinPostRequest;\n type blogV3Post_universal_d_UnpinPostResponse = UnpinPostResponse;\n type blogV3Post_universal_d_ListPostsArchiveRequest = ListPostsArchiveRequest;\n type blogV3Post_universal_d_ListPostsArchiveResponse = ListPostsArchiveResponse;\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_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 const blogV3Post_universal_d_listDemoPosts: typeof listDemoPosts;\n type blogV3Post_universal_d_ListDemoPostsOptions = ListDemoPostsOptions;\n const blogV3Post_universal_d_listTemplates: typeof listTemplates;\n type blogV3Post_universal_d_ListTemplatesOptions = ListTemplatesOptions;\n const blogV3Post_universal_d_getTemplate: typeof getTemplate;\n const blogV3Post_universal_d_createDraftPostFromTemplate: typeof createDraftPostFromTemplate;\n const blogV3Post_universal_d_getTotalLikesPerMember: typeof getTotalLikesPerMember;\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 const blogV3Post_universal_d_bulkGetPostMetrics: typeof bulkGetPostMetrics;\n const blogV3Post_universal_d_viewPost: typeof viewPost;\n const blogV3Post_universal_d_likePost: typeof likePost;\n type blogV3Post_universal_d_LikePostOptions = LikePostOptions;\n const blogV3Post_universal_d_unlikePost: typeof unlikePost;\n type blogV3Post_universal_d_UnlikePostOptions = UnlikePostOptions;\n const blogV3Post_universal_d_pinPost: typeof pinPost;\n type blogV3Post_universal_d_PinPostOptions = PinPostOptions;\n const blogV3Post_universal_d_unpinPost: typeof unpinPost;\n type blogV3Post_universal_d_UnpinPostOptions = UnpinPostOptions;\n const blogV3Post_universal_d_listPostsArchive: typeof listPostsArchive;\n type blogV3Post_universal_d_ListPostsArchiveOptions = ListPostsArchiveOptions;\n const blogV3Post_universal_d_bulkGetPostReactions: typeof bulkGetPostReactions;\n const blogV3Post_universal_d_queryPublicationsCountStats: typeof queryPublicationsCountStats;\n type blogV3Post_universal_d_QueryPublicationsCountStatsOptions = QueryPublicationsCountStatsOptions;\n const blogV3Post_universal_d_queryPostCountStats: typeof queryPostCountStats;\n type blogV3Post_universal_d_QueryPostCountStatsOptions = QueryPostCountStatsOptions;\n const blogV3Post_universal_d_getTotalPublications: typeof getTotalPublications;\n type blogV3Post_universal_d_GetTotalPublicationsOptions = GetTotalPublicationsOptions;\n const blogV3Post_universal_d_getTotalPosts: typeof getTotalPosts;\n type blogV3Post_universal_d_GetTotalPostsOptions = GetTotalPostsOptions;\n const blogV3Post_universal_d_sendActionEvent: typeof sendActionEvent;\n type blogV3Post_universal_d_SendActionEventOptions = SendActionEventOptions;\n namespace blogV3Post_universal_d {\n export {\n blogV3Post_universal_d_Post as Post,\n blogV3Post_universal_d_CoverMedia as CoverMedia,\n blogV3Post_universal_d_CoverMediaMediaOneOf as CoverMediaMediaOneOf,\n blogV3Post_universal_d_FocalPoint as FocalPoint,\n blogV3Post_universal_d_PostCountInfo as PostCountInfo,\n blogV3Post_universal_d_Metrics as Metrics,\n SeoSchema$1 as SeoSchema,\n Keyword$1 as Keyword,\n Tag$1 as Tag,\n Settings$1 as Settings,\n blogV3Post_universal_d_RichContent as RichContent,\n blogV3Post_universal_d_Node as Node,\n blogV3Post_universal_d_NodeDataOneOf as NodeDataOneOf,\n blogV3Post_universal_d_NodeType as NodeType,\n blogV3Post_universal_d_NodeStyle as NodeStyle,\n blogV3Post_universal_d_ButtonData as ButtonData,\n blogV3Post_universal_d_Border as Border,\n blogV3Post_universal_d_Colors as Colors,\n blogV3Post_universal_d_PluginContainerData as PluginContainerData,\n blogV3Post_universal_d_WidthType as WidthType,\n blogV3Post_universal_d_PluginContainerDataWidth as PluginContainerDataWidth,\n blogV3Post_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf,\n blogV3Post_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment,\n blogV3Post_universal_d_Spoiler as Spoiler,\n blogV3Post_universal_d_Height as Height,\n blogV3Post_universal_d_Type as Type,\n blogV3Post_universal_d_Styles as Styles,\n blogV3Post_universal_d_Link as Link,\n blogV3Post_universal_d_LinkDataOneOf as LinkDataOneOf,\n blogV3Post_universal_d_Target as Target,\n blogV3Post_universal_d_Rel as Rel,\n blogV3Post_universal_d_CodeBlockData as CodeBlockData,\n blogV3Post_universal_d_TextStyle as TextStyle,\n blogV3Post_universal_d_TextAlignment as TextAlignment,\n blogV3Post_universal_d_DividerData as DividerData,\n blogV3Post_universal_d_LineStyle as LineStyle,\n blogV3Post_universal_d_Width as Width,\n blogV3Post_universal_d_Alignment as Alignment,\n blogV3Post_universal_d_FileData as FileData,\n blogV3Post_universal_d_ViewMode as ViewMode,\n blogV3Post_universal_d_FileSource as FileSource,\n blogV3Post_universal_d_FileSourceDataOneOf as FileSourceDataOneOf,\n blogV3Post_universal_d_PDFSettings as PDFSettings,\n blogV3Post_universal_d_GalleryData as GalleryData,\n blogV3Post_universal_d_Media as Media,\n blogV3Post_universal_d_Image as Image,\n blogV3Post_universal_d_Video as Video,\n blogV3Post_universal_d_Item as Item,\n blogV3Post_universal_d_ItemDataOneOf as ItemDataOneOf,\n blogV3Post_universal_d_GalleryOptions as GalleryOptions,\n blogV3Post_universal_d_LayoutType as LayoutType,\n blogV3Post_universal_d_Orientation as Orientation,\n blogV3Post_universal_d_Crop as Crop,\n blogV3Post_universal_d_ThumbnailsAlignment as ThumbnailsAlignment,\n blogV3Post_universal_d_Layout as Layout,\n blogV3Post_universal_d_ItemStyle as ItemStyle,\n blogV3Post_universal_d_Thumbnails as Thumbnails,\n blogV3Post_universal_d_GIFData as GIFData,\n blogV3Post_universal_d_GIF as GIF,\n blogV3Post_universal_d_HeadingData as HeadingData,\n blogV3Post_universal_d_HTMLData as HTMLData,\n blogV3Post_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf,\n blogV3Post_universal_d_Source as Source,\n blogV3Post_universal_d_ImageData as ImageData,\n blogV3Post_universal_d_LinkPreviewData as LinkPreviewData,\n blogV3Post_universal_d_MapData as MapData,\n blogV3Post_universal_d_MapSettings as MapSettings,\n blogV3Post_universal_d_MapType as MapType,\n blogV3Post_universal_d_ParagraphData as ParagraphData,\n blogV3Post_universal_d_PollData as PollData,\n blogV3Post_universal_d_ViewRole as ViewRole,\n blogV3Post_universal_d_VoteRole as VoteRole,\n blogV3Post_universal_d_Permissions as Permissions,\n blogV3Post_universal_d_Option as Option,\n blogV3Post_universal_d_PollSettings as PollSettings,\n blogV3Post_universal_d_PollLayoutType as PollLayoutType,\n blogV3Post_universal_d_PollLayoutDirection as PollLayoutDirection,\n blogV3Post_universal_d_PollLayout as PollLayout,\n blogV3Post_universal_d_OptionLayout as OptionLayout,\n blogV3Post_universal_d_BackgroundType as BackgroundType,\n blogV3Post_universal_d_Gradient as Gradient,\n blogV3Post_universal_d_Background as Background,\n blogV3Post_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf,\n blogV3Post_universal_d_PollDesign as PollDesign,\n blogV3Post_universal_d_OptionDesign as OptionDesign,\n blogV3Post_universal_d_Poll as Poll,\n blogV3Post_universal_d_PollDataLayout as PollDataLayout,\n blogV3Post_universal_d_Design as Design,\n blogV3Post_universal_d_TextData as TextData,\n blogV3Post_universal_d_Decoration as Decoration,\n blogV3Post_universal_d_DecorationDataOneOf as DecorationDataOneOf,\n blogV3Post_universal_d_DecorationType as DecorationType,\n blogV3Post_universal_d_AnchorData as AnchorData,\n blogV3Post_universal_d_ColorData as ColorData,\n blogV3Post_universal_d_LinkData as LinkData,\n blogV3Post_universal_d_MentionData as MentionData,\n blogV3Post_universal_d_FontSizeData as FontSizeData,\n blogV3Post_universal_d_FontType as FontType,\n blogV3Post_universal_d_SpoilerData as SpoilerData,\n blogV3Post_universal_d_AppEmbedData as AppEmbedData,\n blogV3Post_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf,\n blogV3Post_universal_d_AppType as AppType,\n blogV3Post_universal_d_BookingData as BookingData,\n blogV3Post_universal_d_EventData as EventData,\n blogV3Post_universal_d_VideoData as VideoData,\n blogV3Post_universal_d_PlaybackOptions as PlaybackOptions,\n blogV3Post_universal_d_EmbedData as EmbedData,\n blogV3Post_universal_d_Oembed as Oembed,\n blogV3Post_universal_d_CollapsibleListData as CollapsibleListData,\n blogV3Post_universal_d_InitialExpandedItems as InitialExpandedItems,\n blogV3Post_universal_d_Direction as Direction,\n blogV3Post_universal_d_TableData as TableData,\n blogV3Post_universal_d_Dimensions as Dimensions,\n blogV3Post_universal_d_TableCellData as TableCellData,\n blogV3Post_universal_d_VerticalAlignment as VerticalAlignment,\n blogV3Post_universal_d_CellStyle as CellStyle,\n blogV3Post_universal_d_BorderColors as BorderColors,\n blogV3Post_universal_d_NullValue as NullValue,\n blogV3Post_universal_d_ListValue as ListValue,\n blogV3Post_universal_d_AudioData as AudioData,\n blogV3Post_universal_d_OrderedListData as OrderedListData,\n blogV3Post_universal_d_BulletedListData as BulletedListData,\n blogV3Post_universal_d_BlockquoteData as BlockquoteData,\n blogV3Post_universal_d_CaptionData as CaptionData,\n blogV3Post_universal_d_Metadata as Metadata,\n blogV3Post_universal_d_DocumentStyle as DocumentStyle,\n blogV3Post_universal_d_TextNodeStyle as TextNodeStyle,\n blogV3Post_universal_d_ModerationDetails as ModerationDetails,\n blogV3Post_universal_d_ModerationStatusStatus as ModerationStatusStatus,\n blogV3Post_universal_d_BlogMedia as BlogMedia,\n blogV3Post_universal_d_BlogMediaMediaOneOf as BlogMediaMediaOneOf,\n blogV3Post_universal_d_WixMedia as WixMedia,\n blogV3Post_universal_d_VideoResolution as VideoResolution,\n blogV3Post_universal_d_EmbedMedia as EmbedMedia,\n blogV3Post_universal_d_EmbedThumbnail as EmbedThumbnail,\n blogV3Post_universal_d_EmbedVideo as EmbedVideo,\n blogV3Post_universal_d_PostTranslation as PostTranslation,\n blogV3Post_universal_d_OldBlogMigratedEvent as OldBlogMigratedEvent,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n blogV3Post_universal_d_ConvertDraftJsToRichContentRequest as ConvertDraftJsToRichContentRequest,\n blogV3Post_universal_d_ConvertDraftJsToRichContentResponse as ConvertDraftJsToRichContentResponse,\n blogV3Post_universal_d_ConvertRichContentToDraftJsRequest as ConvertRichContentToDraftJsRequest,\n blogV3Post_universal_d_ConvertRichContentToDraftJsResponse as ConvertRichContentToDraftJsResponse,\n blogV3Post_universal_d_ListDemoPostsRequest as ListDemoPostsRequest,\n blogV3Post_universal_d_GetPostsSort as GetPostsSort,\n blogV3Post_universal_d_BlogPaging as BlogPaging,\n blogV3Post_universal_d_PostFieldField as PostFieldField,\n blogV3Post_universal_d_ListDemoPostsResponse as ListDemoPostsResponse,\n MetaData$1 as MetaData,\n blogV3Post_universal_d_ListTemplatesRequest as ListTemplatesRequest,\n blogV3Post_universal_d_GetPostTemplatesSort as GetPostTemplatesSort,\n blogV3Post_universal_d_ListTemplatesResponse as ListTemplatesResponse,\n blogV3Post_universal_d_Category as Category,\n blogV3Post_universal_d_CategoryTranslation as CategoryTranslation,\n blogV3Post_universal_d_GetTemplateRequest as GetTemplateRequest,\n blogV3Post_universal_d_GetTemplateResponse as GetTemplateResponse,\n blogV3Post_universal_d_CreateDraftPostFromTemplateRequest as CreateDraftPostFromTemplateRequest,\n blogV3Post_universal_d_CreateDraftPostFromTemplateResponse as CreateDraftPostFromTemplateResponse,\n blogV3Post_universal_d_DraftPost as DraftPost,\n blogV3Post_universal_d_Origin as Origin,\n blogV3Post_universal_d_Status as Status,\n blogV3Post_universal_d_DraftPostTranslation as DraftPostTranslation,\n blogV3Post_universal_d_GetTotalLikesPerMemberRequest as GetTotalLikesPerMemberRequest,\n blogV3Post_universal_d_GetTotalLikesPerMemberResponse as GetTotalLikesPerMemberResponse,\n blogV3Post_universal_d_PostLiked as PostLiked,\n blogV3Post_universal_d_PostLikedInitiatorOneOf as PostLikedInitiatorOneOf,\n blogV3Post_universal_d_PostUnliked as PostUnliked,\n blogV3Post_universal_d_PostUnlikedInitiatorOneOf as PostUnlikedInitiatorOneOf,\n blogV3Post_universal_d_PostCountersUpdated as PostCountersUpdated,\n blogV3Post_universal_d_PostCountersUpdatedInitiatorOneOf as PostCountersUpdatedInitiatorOneOf,\n Field$1 as Field,\n blogV3Post_universal_d_PostOwnerChanged as PostOwnerChanged,\n blogV3Post_universal_d_InitialPostsCopied as InitialPostsCopied,\n blogV3Post_universal_d_GetPostRequest as GetPostRequest,\n blogV3Post_universal_d_GetPostResponse as GetPostResponse,\n blogV3Post_universal_d_GetPostBySlugRequest as GetPostBySlugRequest,\n blogV3Post_universal_d_GetPostBySlugResponse as GetPostBySlugResponse,\n blogV3Post_universal_d_ListPostsRequest as ListPostsRequest,\n blogV3Post_universal_d_ListPostsResponse as ListPostsResponse,\n blogV3Post_universal_d_QueryPostsRequest as QueryPostsRequest,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n PlatformQuery$1 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf,\n Paging$1 as Paging,\n CursorPaging$1 as CursorPaging,\n blogV3Post_universal_d_QueryPostsResponse as QueryPostsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n blogV3Post_universal_d_GetPostMetricsRequest as GetPostMetricsRequest,\n blogV3Post_universal_d_GetPostMetricsResponse as GetPostMetricsResponse,\n blogV3Post_universal_d_BulkGetPostMetricsRequest as BulkGetPostMetricsRequest,\n blogV3Post_universal_d_BulkGetPostMetricsResponse as BulkGetPostMetricsResponse,\n blogV3Post_universal_d_ViewPostRequest as ViewPostRequest,\n blogV3Post_universal_d_ViewPostResponse as ViewPostResponse,\n blogV3Post_universal_d_LikePostRequest as LikePostRequest,\n blogV3Post_universal_d_LikePostResponse as LikePostResponse,\n blogV3Post_universal_d_UnlikePostRequest as UnlikePostRequest,\n blogV3Post_universal_d_UnlikePostResponse as UnlikePostResponse,\n blogV3Post_universal_d_PinPostRequest as PinPostRequest,\n blogV3Post_universal_d_PinPostResponse as PinPostResponse,\n blogV3Post_universal_d_UnpinPostRequest as UnpinPostRequest,\n blogV3Post_universal_d_UnpinPostResponse as UnpinPostResponse,\n blogV3Post_universal_d_ListPostsArchiveRequest as ListPostsArchiveRequest,\n blogV3Post_universal_d_ListPostsArchiveResponse as ListPostsArchiveResponse,\n blogV3Post_universal_d_BulkGetPostReactionsRequest as BulkGetPostReactionsRequest,\n blogV3Post_universal_d_BulkGetPostReactionsResponse as BulkGetPostReactionsResponse,\n blogV3Post_universal_d_Reactions as Reactions,\n blogV3Post_universal_d_QueryPublicationsCountStatsRequest as QueryPublicationsCountStatsRequest,\n blogV3Post_universal_d_QueryPublicationsCountStatsRequestOrder as QueryPublicationsCountStatsRequestOrder,\n blogV3Post_universal_d_QueryPublicationsCountStatsResponse as QueryPublicationsCountStatsResponse,\n blogV3Post_universal_d_PeriodPublicationsCount as PeriodPublicationsCount,\n blogV3Post_universal_d_QueryPostCountStatsRequest as QueryPostCountStatsRequest,\n blogV3Post_universal_d_Order as Order,\n blogV3Post_universal_d_QueryPostCountStatsResponse as QueryPostCountStatsResponse,\n blogV3Post_universal_d_PeriodPostCount as PeriodPostCount,\n blogV3Post_universal_d_GetTotalPublicationsRequest as GetTotalPublicationsRequest,\n blogV3Post_universal_d_GetTotalPublicationsResponse as GetTotalPublicationsResponse,\n blogV3Post_universal_d_GetTotalPostsRequest as GetTotalPostsRequest,\n blogV3Post_universal_d_GetTotalPostsResponse as GetTotalPostsResponse,\n blogV3Post_universal_d_SendActionEventRequest as SendActionEventRequest,\n blogV3Post_universal_d_SendActionEventRequestActionOneOf as SendActionEventRequestActionOneOf,\n blogV3Post_universal_d_SendActionEventResponse as SendActionEventResponse,\n blogV3Post_universal_d_listDemoPosts as listDemoPosts,\n blogV3Post_universal_d_ListDemoPostsOptions as ListDemoPostsOptions,\n blogV3Post_universal_d_listTemplates as listTemplates,\n blogV3Post_universal_d_ListTemplatesOptions as ListTemplatesOptions,\n blogV3Post_universal_d_getTemplate as getTemplate,\n blogV3Post_universal_d_createDraftPostFromTemplate as createDraftPostFromTemplate,\n blogV3Post_universal_d_getTotalLikesPerMember as getTotalLikesPerMember,\n blogV3Post_universal_d_getPost as getPost,\n blogV3Post_universal_d_GetPostOptions as GetPostOptions,\n blogV3Post_universal_d_getPostBySlug as getPostBySlug,\n blogV3Post_universal_d_GetPostBySlugOptions as GetPostBySlugOptions,\n blogV3Post_universal_d_listPosts as listPosts,\n blogV3Post_universal_d_ListPostsOptions as ListPostsOptions,\n blogV3Post_universal_d_queryPosts as queryPosts,\n blogV3Post_universal_d_QueryPostsOptions as QueryPostsOptions,\n blogV3Post_universal_d_PostsQueryResult as PostsQueryResult,\n blogV3Post_universal_d_PostsQueryBuilder as PostsQueryBuilder,\n blogV3Post_universal_d_getPostMetrics as getPostMetrics,\n blogV3Post_universal_d_bulkGetPostMetrics as bulkGetPostMetrics,\n blogV3Post_universal_d_viewPost as viewPost,\n blogV3Post_universal_d_likePost as likePost,\n blogV3Post_universal_d_LikePostOptions as LikePostOptions,\n blogV3Post_universal_d_unlikePost as unlikePost,\n blogV3Post_universal_d_UnlikePostOptions as UnlikePostOptions,\n blogV3Post_universal_d_pinPost as pinPost,\n blogV3Post_universal_d_PinPostOptions as PinPostOptions,\n blogV3Post_universal_d_unpinPost as unpinPost,\n blogV3Post_universal_d_UnpinPostOptions as UnpinPostOptions,\n blogV3Post_universal_d_listPostsArchive as listPostsArchive,\n blogV3Post_universal_d_ListPostsArchiveOptions as ListPostsArchiveOptions,\n blogV3Post_universal_d_bulkGetPostReactions as bulkGetPostReactions,\n blogV3Post_universal_d_queryPublicationsCountStats as queryPublicationsCountStats,\n blogV3Post_universal_d_QueryPublicationsCountStatsOptions as QueryPublicationsCountStatsOptions,\n blogV3Post_universal_d_queryPostCountStats as queryPostCountStats,\n blogV3Post_universal_d_QueryPostCountStatsOptions as QueryPostCountStatsOptions,\n blogV3Post_universal_d_getTotalPublications as getTotalPublications,\n blogV3Post_universal_d_GetTotalPublicationsOptions as GetTotalPublicationsOptions,\n blogV3Post_universal_d_getTotalPosts as getTotalPosts,\n blogV3Post_universal_d_GetTotalPostsOptions as GetTotalPostsOptions,\n blogV3Post_universal_d_sendActionEvent as sendActionEvent,\n blogV3Post_universal_d_SendActionEventOptions as SendActionEventOptions,\n };\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 | null;\n /**\n * Date the tag was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /**\n * SEO data.\n * @internal\n */\n seoData?: SeoSchema;\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?: 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 focus keyword. */\n isMain?: boolean;\n /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 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 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 | null;\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 * SEO data.\n * @internal\n */\n seoData?: SeoSchema;\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-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\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 * SEO data.\n * @internal\n */\n seoData?: SeoSchema;\n }\n interface CreateTagResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface UpdateTagRequest {\n /** Tag info. */\n tag?: Tag;\n /**\n * Field mask of fields to update.\n * @internal\n */\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 GetTagsCountByLanguageRequest {\n }\n interface GetTagsCountByLanguageResponse {\n /** The language and it's count. */\n tagsLanguageCount?: TagLanguageCount[];\n }\n interface TagLanguageCount {\n /** 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. */\n languageCode?: string | null;\n /** The count of tags for the language. */\n tagCount?: number | null;\n }\n interface GetTagByLabelRequest {\n /** Tag label. */\n label: string;\n /**\n * Tag language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If omitted, tags in all languages are returned.\n */\n language?: 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 GetTagByLabelResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface GetTagRequest {\n /** Tag ID. */\n tagId: string;\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 * 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 * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Language of the tag to retrieve.\n */\n language?: string | null;\n }\n interface GetTagBySlugResponse {\n /** Tag info. */\n tag?: Tag;\n }\n interface QueryTagsRequest {\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 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`, `$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 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryTagsResponse {\n /** List of tags. */\n tags?: Tag[];\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 * 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 * @internal\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 ListTagsRequest extends 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 /** 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 }\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 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 BulkDeleteTagRequest {\n /** Tag IDs. */\n tagIds: string[];\n /** Should delete bypassing the trash-bin. */\n permanent?: boolean;\n }\n interface BulkDeleteTagResponse {\n }\n interface DeleteTagRequest {\n /** Tag ID. */\n tagId: string;\n }\n interface DeleteTagResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * If a tag already exists with the provided label, returns this tag. Otherwise, the request creates a new tag with the provided label.\n * @param label - Tag name. Unique per blog.\n * @internal\n * @documentationMaturity preview\n * @requiredField label\n * @permissionId BLOG.READ_TAG\n */\n function getOrCreateTag(label: string, options?: GetOrCreateTagOptions): Promise;\n interface GetOrCreateTagOptions {\n /** Tag language. */\n language?: string | null;\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 * SEO data.\n * @internal\n */\n seoData?: SeoSchema;\n }\n /**\n * Creates a new tag with the provided label if a tag with the same label doesn't already exist.\n * @param label - Tag label. The label for each tag in a blog must be unique.\n * @public\n * @documentationMaturity preview\n * @requiredField label\n * @permissionId BLOG.CREATE-TAG\n * @adminMethod\n */\n function createTag(label: string, options?: CreateTagOptions): Promise;\n interface CreateTagOptions {\n /**\n * Tag language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\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 * SEO data.\n * @internal\n */\n seoData?: SeoSchema;\n }\n /**\n * Updates a tag.\n * @param _id - Tag ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId BLOG.EDIT-TAG\n * @adminMethod\n * @returns Tag info.\n */\n function updateTag(_id: string, options?: UpdateTagOptions): Promise;\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 | null;\n /**\n * Date the tag was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n */\n language?: string | null;\n /**\n * SEO data.\n * @internal\n */\n seoData?: SeoSchema;\n };\n /**\n * Field mask of fields to update.\n * @internal\n */\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 /**\n * Creates multiple tags.\n * @param tags - Tags to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField tags\n * @requiredField tags.label\n * @permissionId BLOG.CREATE-TAG\n * @adminMethod\n */\n function bulkCreateTags(tags: Tag[], options?: BulkCreateTagsOptions): Promise;\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 * Retrieves a count of tags for every site language.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ_TAG\n */\n function getTagsCountByLanguage(): Promise;\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 label\n * @param options - Options specifying which additional fields to return.\n * @permissionId BLOG.READ_TAG\n */\n function getTagByLabel(label: string, options?: GetTagByLabelOptions): Promise;\n interface GetTagByLabelOptions {\n /**\n * Tag language.\n *\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * If omitted, tags in all languages are returned.\n */\n language?: string | null;\n /** List of additional tag fields to be included in the response. By default, any fields not passed are not returned. */\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 * @permissionId BLOG.READ_TAG\n * @returns Tag info.\n */\n function getTag(tagId: string, options?: GetTagOptions): Promise;\n interface GetTagOptions {\n /** List of additional tag fields to be included in the response. By default, any fields not passed are not returned. */\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 * @permissionId BLOG.READ_TAG\n */\n function getTagBySlug(slug: string, options?: GetTagBySlugOptions): Promise;\n interface GetTagBySlugOptions {\n /** List of additional tag fields to be included in the response. By default, any fields not passed are not returned. */\n fieldsets?: Field[];\n /**\n * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * Language of the tag to retrieve.\n */\n language?: string | null;\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 * @permissionId BLOG.READ_TAG\n */\n function queryTags(options?: QueryTagsOptions): TagsQueryBuilder;\n interface QueryTagsOptions {\n /** List of additional tag fields to be included in the response. By default, any fields not passed are not returned. */\n fieldsets?: Field[] | 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 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: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: 'postCount' | 'publishedPostCount', value: any) => TagsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: 'postCount' | 'publishedPostCount', 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: 'label' | 'slug', 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: 'label' | 'slug', value: any[]) => TagsQueryBuilder;\n in: (propertyName: '_id' | 'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'translationId' | 'language', value: any) => TagsQueryBuilder;\n exists: (propertyName: 'label' | 'slug' | 'translationId' | 'language', value: boolean) => TagsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'language'>) => TagsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'label' | 'slug' | 'postCount' | 'publishedPostCount' | 'language'>) => 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 /**\n * Lists tags. Default sort is descending by post count and default tag size is 50.\n * @internal\n * @documentationMaturity preview\n * @permissionId BLOG.READ_TAG\n */\n function listTags(options?: ListTagsOptions): Promise;\n interface ListTagsOptions 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 /** 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 /**\n * Bulk delete for tags\n * @param tagIds - Tag IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField tagIds\n * @permissionId BLOG.DELETE_TAG\n * @adminMethod\n */\n function bulkDeleteTag(tagIds: string[], options?: BulkDeleteTagOptions): Promise;\n interface BulkDeleteTagOptions {\n /** Should delete bypassing the trash-bin. */\n permanent?: boolean;\n }\n /**\n * Deletes a tag. Deleting a tag removes that tag from all blog posts that contain it.\n * @param tagId - Tag ID.\n * @public\n * @documentationMaturity preview\n * @requiredField tagId\n * @permissionId BLOG.DELETE_TAG\n * @adminMethod\n */\n function deleteTag(tagId: string): Promise;\n \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_GetTagsCountByLanguageRequest = GetTagsCountByLanguageRequest;\n type blogV3Tag_universal_d_GetTagsCountByLanguageResponse = GetTagsCountByLanguageResponse;\n type blogV3Tag_universal_d_TagLanguageCount = TagLanguageCount;\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_PlatformQuery = PlatformQuery;\n type blogV3Tag_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\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_CursorPaging = CursorPaging;\n type blogV3Tag_universal_d_QueryTagsResponse = QueryTagsResponse;\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_MetaData = MetaData;\n type blogV3Tag_universal_d_BulkDeleteTagRequest = BulkDeleteTagRequest;\n type blogV3Tag_universal_d_BulkDeleteTagResponse = BulkDeleteTagResponse;\n type blogV3Tag_universal_d_DeleteTagRequest = DeleteTagRequest;\n type blogV3Tag_universal_d_DeleteTagResponse = DeleteTagResponse;\n type blogV3Tag_universal_d_DomainEvent = DomainEvent;\n type blogV3Tag_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type blogV3Tag_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type blogV3Tag_universal_d_RestoreInfo = RestoreInfo;\n type blogV3Tag_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type blogV3Tag_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type blogV3Tag_universal_d_ActionEvent = ActionEvent;\n type blogV3Tag_universal_d_MessageEnvelope = MessageEnvelope;\n type blogV3Tag_universal_d_IdentificationData = IdentificationData;\n type blogV3Tag_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type blogV3Tag_universal_d_WebhookIdentityType = WebhookIdentityType;\n const blogV3Tag_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const blogV3Tag_universal_d_getOrCreateTag: typeof getOrCreateTag;\n type blogV3Tag_universal_d_GetOrCreateTagOptions = GetOrCreateTagOptions;\n const blogV3Tag_universal_d_createTag: typeof createTag;\n type blogV3Tag_universal_d_CreateTagOptions = CreateTagOptions;\n const blogV3Tag_universal_d_updateTag: typeof updateTag;\n type blogV3Tag_universal_d_UpdateTagOptions = UpdateTagOptions;\n const blogV3Tag_universal_d_bulkCreateTags: typeof bulkCreateTags;\n type blogV3Tag_universal_d_BulkCreateTagsOptions = BulkCreateTagsOptions;\n const blogV3Tag_universal_d_getTagsCountByLanguage: typeof getTagsCountByLanguage;\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 const blogV3Tag_universal_d_listTags: typeof listTags;\n type blogV3Tag_universal_d_ListTagsOptions = ListTagsOptions;\n const blogV3Tag_universal_d_bulkDeleteTag: typeof bulkDeleteTag;\n type blogV3Tag_universal_d_BulkDeleteTagOptions = BulkDeleteTagOptions;\n const blogV3Tag_universal_d_deleteTag: typeof deleteTag;\n namespace blogV3Tag_universal_d {\n export {\n blogV3Tag_universal_d_Tag as Tag,\n blogV3Tag_universal_d_SeoSchema as SeoSchema,\n blogV3Tag_universal_d_Keyword as Keyword,\n blogV3Tag_universal_d_SeoSchemaTag as SeoSchemaTag,\n blogV3Tag_universal_d_Settings as Settings,\n blogV3Tag_universal_d_InitialTagsCopied as InitialTagsCopied,\n blogV3Tag_universal_d_GetOrCreateTagRequest as GetOrCreateTagRequest,\n blogV3Tag_universal_d_Field as Field,\n blogV3Tag_universal_d_GetOrCreateTagResponse as GetOrCreateTagResponse,\n blogV3Tag_universal_d_CreateTagRequest as CreateTagRequest,\n blogV3Tag_universal_d_CreateTagResponse as CreateTagResponse,\n blogV3Tag_universal_d_UpdateTagRequest as UpdateTagRequest,\n blogV3Tag_universal_d_UpdateTagResponse as UpdateTagResponse,\n blogV3Tag_universal_d_BulkCreateTagsRequest as BulkCreateTagsRequest,\n blogV3Tag_universal_d_BulkCreateTagsResponse as BulkCreateTagsResponse,\n blogV3Tag_universal_d_BulkTagResult as BulkTagResult,\n blogV3Tag_universal_d_ItemMetadata as ItemMetadata,\n blogV3Tag_universal_d_ApplicationError as ApplicationError,\n blogV3Tag_universal_d_BulkActionMetadata as BulkActionMetadata,\n blogV3Tag_universal_d_GetTagsCountByLanguageRequest as GetTagsCountByLanguageRequest,\n blogV3Tag_universal_d_GetTagsCountByLanguageResponse as GetTagsCountByLanguageResponse,\n blogV3Tag_universal_d_TagLanguageCount as TagLanguageCount,\n blogV3Tag_universal_d_GetTagByLabelRequest as GetTagByLabelRequest,\n blogV3Tag_universal_d_GetTagByLabelResponse as GetTagByLabelResponse,\n blogV3Tag_universal_d_GetTagRequest as GetTagRequest,\n blogV3Tag_universal_d_GetTagResponse as GetTagResponse,\n blogV3Tag_universal_d_GetTagBySlugRequest as GetTagBySlugRequest,\n blogV3Tag_universal_d_GetTagBySlugResponse as GetTagBySlugResponse,\n blogV3Tag_universal_d_QueryTagsRequest as QueryTagsRequest,\n blogV3Tag_universal_d_PlatformQuery as PlatformQuery,\n blogV3Tag_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf,\n blogV3Tag_universal_d_Sorting as Sorting,\n blogV3Tag_universal_d_SortOrder as SortOrder,\n blogV3Tag_universal_d_Paging as Paging,\n blogV3Tag_universal_d_CursorPaging as CursorPaging,\n blogV3Tag_universal_d_QueryTagsResponse as QueryTagsResponse,\n blogV3Tag_universal_d_PagingMetadataV2 as PagingMetadataV2,\n blogV3Tag_universal_d_Cursors as Cursors,\n blogV3Tag_universal_d_ListTagsRequest as ListTagsRequest,\n blogV3Tag_universal_d_ListTagsRequestPagingMethodOneOf as ListTagsRequestPagingMethodOneOf,\n blogV3Tag_universal_d_ListTagsResponse as ListTagsResponse,\n blogV3Tag_universal_d_MetaData as MetaData,\n blogV3Tag_universal_d_BulkDeleteTagRequest as BulkDeleteTagRequest,\n blogV3Tag_universal_d_BulkDeleteTagResponse as BulkDeleteTagResponse,\n blogV3Tag_universal_d_DeleteTagRequest as DeleteTagRequest,\n blogV3Tag_universal_d_DeleteTagResponse as DeleteTagResponse,\n blogV3Tag_universal_d_DomainEvent as DomainEvent,\n blogV3Tag_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n blogV3Tag_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n blogV3Tag_universal_d_RestoreInfo as RestoreInfo,\n blogV3Tag_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n blogV3Tag_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n blogV3Tag_universal_d_ActionEvent as ActionEvent,\n blogV3Tag_universal_d_MessageEnvelope as MessageEnvelope,\n blogV3Tag_universal_d_IdentificationData as IdentificationData,\n blogV3Tag_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n blogV3Tag_universal_d_WebhookIdentityType as WebhookIdentityType,\n blogV3Tag_universal_d_getOrCreateTag as getOrCreateTag,\n blogV3Tag_universal_d_GetOrCreateTagOptions as GetOrCreateTagOptions,\n blogV3Tag_universal_d_createTag as createTag,\n blogV3Tag_universal_d_CreateTagOptions as CreateTagOptions,\n blogV3Tag_universal_d_updateTag as updateTag,\n blogV3Tag_universal_d_UpdateTagOptions as UpdateTagOptions,\n blogV3Tag_universal_d_bulkCreateTags as bulkCreateTags,\n blogV3Tag_universal_d_BulkCreateTagsOptions as BulkCreateTagsOptions,\n blogV3Tag_universal_d_getTagsCountByLanguage as getTagsCountByLanguage,\n blogV3Tag_universal_d_getTagByLabel as getTagByLabel,\n blogV3Tag_universal_d_GetTagByLabelOptions as GetTagByLabelOptions,\n blogV3Tag_universal_d_getTag as getTag,\n blogV3Tag_universal_d_GetTagOptions as GetTagOptions,\n blogV3Tag_universal_d_getTagBySlug as getTagBySlug,\n blogV3Tag_universal_d_GetTagBySlugOptions as GetTagBySlugOptions,\n blogV3Tag_universal_d_queryTags as queryTags,\n blogV3Tag_universal_d_QueryTagsOptions as QueryTagsOptions,\n blogV3Tag_universal_d_TagsQueryResult as TagsQueryResult,\n blogV3Tag_universal_d_TagsQueryBuilder as TagsQueryBuilder,\n blogV3Tag_universal_d_listTags as listTags,\n blogV3Tag_universal_d_ListTagsOptions as ListTagsOptions,\n blogV3Tag_universal_d_bulkDeleteTag as bulkDeleteTag,\n blogV3Tag_universal_d_BulkDeleteTagOptions as BulkDeleteTagOptions,\n blogV3Tag_universal_d_deleteTag as deleteTag,\n };\n }\n \n export { blogV1BlogCache_universal_d as blogCache, blogV1WordpressImport_universal_d as blogImporter, blogV3Category_universal_d as categories, blogV3Draft_universal_d as draftPosts, blogV3Post_universal_d as posts, blogV3Tag_universal_d as tags };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-ecom-backend.d.ts", "content": "declare module \"wix-ecom-backend\" {\n interface GiftCard$7 {\n /**\n * Gift Card unique id\n * @deprecated Gift Card unique id\n */\n _id?: string;\n /** Gift Card obfuscated code */\n obfuscatedCode?: string;\n /** The currency code of the Gift Card */\n currencyCode?: string;\n /** The gift card currency balance */\n balance?: Balance$2;\n /** Gift card status */\n status?: Status$6;\n /** App def id of the GiftCard provider */\n appDefId?: string;\n /** Used for integration and tracking across different platforms. */\n externalId?: string | null;\n }\n interface Balance$2 {\n value?: number;\n }\n enum Status$6 {\n UNDEFINED = \"UNDEFINED\",\n VALID = \"VALID\",\n EXPIRED = \"EXPIRED\",\n DISABLED = \"DISABLED\"\n }\n interface GetRequest {\n _id: string;\n }\n interface GetResponse {\n giftCard?: DBGiftCard;\n }\n interface DBGiftCard {\n _id?: string;\n code?: string;\n providerAppDefId?: string;\n balance?: number;\n currencyCode?: string;\n orderId?: string;\n _createdDate?: string;\n }\n interface ListGiftCardsRequest {\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$g[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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 interface Sorting$g {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$g;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$g {\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 ListGiftCardsResponse {\n giftCards?: DBGiftCard[];\n }\n interface ListTransactionsRequest {\n query?: Query;\n }\n interface ListTransactionsResponse {\n transactions?: DBTransaction[];\n }\n interface DBTransaction {\n _id?: string;\n giftCardId?: string;\n amount?: number;\n currencyCode?: string;\n providerAppDefId?: string;\n providerTransactionId?: string;\n _createdDate?: string;\n orderId?: string;\n buyerMemberId?: string | null;\n buyerVisitorId?: string | null;\n }\n interface GiftCardProviderWasProvisioned$1 {\n /** The gift card provider which was installed */\n providerAppDefId?: string;\n providerInstanceId?: string;\n }\n interface CreateGiftCardRequest {\n giftCardData: GiftCardData;\n }\n interface GiftCardData {\n /** Gift Card unique code */\n code?: string | null;\n /** Gift Card initial balance */\n balance?: number;\n /** The currency code of the Gift Card */\n currencyCode?: string;\n /** External orderId by the Gift Card provider */\n orderId?: string;\n }\n interface CreateGiftCardResponse {\n giftCard?: GiftCard$7;\n }\n interface GetGiftCardRequest$1 {\n /** Gift Card id */\n _id: string;\n }\n interface GetGiftCardResponse$1 {\n giftCard?: GiftCard$7;\n }\n interface GetGiftCardByCodeRequest {\n /** Gift Card code */\n code?: string;\n }\n interface GetGiftCardByCodeResponse {\n giftCard?: GiftCard$7;\n }\n interface GetGiftCardByCodeRequestV2 {\n /** Gift Card code */\n code: string;\n /**\n * Physical location indicator\n * This field is required for Square integration as a gift card provider, and should not be used with other providers\n */\n locationId?: string | null;\n }\n interface GetGiftCardByCodeResponseV2 {\n giftCard?: GiftCard$7;\n }\n interface RedeemGiftCardRequest$1 {\n /** Gift Card unique id */\n _id?: string;\n /** Amount to redeem from the gift card */\n amount?: number;\n /** The currency code to redeem */\n currencyCode?: string;\n /** Idempotency key for the current transaction */\n orderId?: string;\n }\n interface RedeemGiftCardResponse$1 {\n /** Unique id of the redemption transaction */\n transactionId?: string;\n }\n interface RedeemGiftCardRequestV2 {\n /** Gift Card code */\n code: string;\n /** Amount to redeem from the gift card */\n amount: Money$1;\n /** Idempotency key for the current transaction */\n orderId?: string;\n /** App def id of the GiftCard provider */\n providerAppDefId: string;\n /**\n * Physical location indicator\n * This field is required for Square integration as a gift card provider, and should not be used with other providers\n */\n locationId?: 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$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 RedeemGiftCardResponseV2 {\n /** Unique id of the gift card transaction */\n transactionId?: string;\n }\n interface VoidTransactionRequest$1 {\n /** Unique id of the redemption transaction */\n transactionId?: string;\n }\n interface VoidTransactionResponse$1 {\n }\n /** Triggered when a gift card transaction is voided */\n interface TransactionVoided {\n /** The gift card which the transaction applies to */\n giftCard?: GiftCard$7;\n /** The transaction that was voided */\n transaction?: Transaction$1;\n }\n interface Transaction$1 {\n /** Transaction unique id */\n _id?: string;\n /** Gift Card obfuscated code */\n obfuscatedCode?: string;\n /** The currency code of the Gift Card */\n providerUrl?: string;\n /** App def id of the GiftCard provider */\n providerAppDefId?: string;\n /** Order id of the transaction */\n orderId?: string;\n /** Amount redeemed by the transaction */\n amount?: number;\n /** The currency code of the transaction */\n currencyCode?: string;\n }\n interface VoidTransactionRequestV2 {\n /** Unique id of the gift card transaction */\n transactionId: string;\n /** App def id of the GiftCard provider */\n providerAppDefId: string;\n /**\n * Physical location indicator\n * This field is required for Square integration as a gift card provider, and should not be used with other providers\n */\n locationId?: string | null;\n }\n interface VoidTransactionResponseV2 {\n }\n interface GetTransactionRequest {\n /** Transaction id */\n _id: string;\n }\n interface GetTransactionResponse {\n /** Transaction */\n transaction?: Transaction$1;\n }\n interface GetProviderUrlRequest {\n /** App def id of the GiftCard provider */\n providerAppDefId: string;\n }\n interface GetProviderUrlResponse {\n /** The Dashboard URL of the gift card provider */\n providerUrl?: string;\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$2;\n }\n enum State$2 {\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$2;\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$2 {\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$2;\n /** A new namespace. */\n newNamespace?: Namespace$2;\n }\n /** Assigned Studio editor */\n interface StudioAssigned$1 {\n }\n /** Unassigned Studio editor */\n interface StudioUnassigned$1 {\n }\n interface Empty$h {\n }\n interface DomainEvent$o extends DomainEventBodyOneOf$o {\n createdEvent?: EntityCreatedEvent$o;\n updatedEvent?: EntityUpdatedEvent$o;\n deletedEvent?: EntityDeletedEvent$o;\n actionEvent?: ActionEvent$o;\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$o {\n createdEvent?: EntityCreatedEvent$o;\n updatedEvent?: EntityUpdatedEvent$o;\n deletedEvent?: EntityDeletedEvent$o;\n actionEvent?: ActionEvent$o;\n }\n interface EntityCreatedEvent$o {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$o;\n }\n interface RestoreInfo$o {\n deletedDate?: Date;\n }\n interface EntityUpdatedEvent$o {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$o {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$o {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$n {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$o;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$o extends IdentificationDataIdOneOf$o {\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 }\n /** @oneof */\n interface IdentificationDataIdOneOf$o {\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 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function get(_id: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listGiftCards(options?: ListGiftCardsOptions): Promise;\n interface ListGiftCardsOptions {\n query?: Query;\n }\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listTransactions(options?: ListTransactionsOptions): Promise;\n interface ListTransactionsOptions {\n query?: Query;\n }\n /**\n * Create a gift card\n * @internal\n * @documentationMaturity preview\n * @requiredField giftCardData\n * @requiredField giftCardData.code\n * @permissionId GIFT_CARDS_PROXY.CREATE\n * @deprecated\n * @targetRemovalDate 2025-08-01\n */\n function createGiftCard(giftCardData: GiftCardData): Promise;\n /**\n * Get gift card by id\n * @param _id - Gift Card id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId GIFT_CARDS_PROXY.READ\n */\n function getGiftCard$1(_id: string): Promise;\n /**\n * Get gift card by code\n * @internal\n * @documentationMaturity preview\n * @permissionId GIFT_CARDS_PROXY.READ\n */\n function getGiftCardByCode(options?: GetGiftCardByCodeOptions): Promise;\n interface GetGiftCardByCodeOptions {\n /** Gift Card code */\n code?: string;\n }\n /**\n * Get gift card by code\n * @param code - Gift Card code\n * @internal\n * @documentationMaturity preview\n * @requiredField code\n * @permissionId GIFT_CARDS_PROXY.READ\n */\n function getGiftCardByCodeV2(code: string, options?: GetGiftCardByCodeV2Options): Promise;\n interface GetGiftCardByCodeV2Options {\n /**\n * Physical location indicator\n * This field is required for Square integration as a gift card provider, and should not be used with other providers\n */\n locationId?: string | null;\n }\n /**\n * Redeem a gift card\n * @internal\n * @documentationMaturity preview\n * @permissionId GIFT_CARDS_PROXY.MODIFY\n */\n function redeemGiftCard$1(options?: RedeemGiftCardOptions$1): Promise;\n interface RedeemGiftCardOptions$1 {\n /** Gift Card unique id */\n _id?: string;\n /** Amount to redeem from the gift card */\n amount?: number;\n /** The currency code to redeem */\n currencyCode?: string;\n /** Idempotency key for the current transaction */\n orderId?: string;\n }\n /**\n * Redeem a gift card\n * @param code - Gift Card code\n * @internal\n * @documentationMaturity preview\n * @requiredField code\n * @requiredField options.amount\n * @requiredField options.providerAppDefId\n * @permissionId GIFT_CARDS_PROXY.MODIFY\n */\n function redeemGiftCardV2(code: string, options?: RedeemGiftCardV2Options): Promise;\n interface RedeemGiftCardV2Options {\n /** Amount to redeem from the gift card */\n amount: Money$1;\n /** Idempotency key for the current transaction */\n orderId?: string;\n /** App def id of the GiftCard provider */\n providerAppDefId: string;\n /**\n * Physical location indicator\n * This field is required for Square integration as a gift card provider, and should not be used with other providers\n */\n locationId?: string | null;\n }\n /**\n * Void a gift card transaction\n * @internal\n * @documentationMaturity preview\n * @permissionId GIFT_CARDS_PROXY.MODIFY\n */\n function voidTransaction$1(options?: VoidTransactionOptions$1): Promise;\n interface VoidTransactionOptions$1 {\n /** Unique id of the redemption transaction */\n transactionId?: string;\n }\n /**\n * Void a gift card transaction\n * @param transactionId - Unique id of the gift card transaction\n * @internal\n * @documentationMaturity preview\n * @requiredField options.providerAppDefId\n * @requiredField transactionId\n * @permissionId GIFT_CARDS_PROXY.MODIFY\n */\n function voidTransactionV2(transactionId: string, options?: VoidTransactionV2Options): Promise;\n interface VoidTransactionV2Options {\n /** App def id of the GiftCard provider */\n providerAppDefId: string;\n /**\n * Physical location indicator\n * This field is required for Square integration as a gift card provider, and should not be used with other providers\n */\n locationId?: string | null;\n }\n /**\n * Get gift card transactions\n * @param _id - Transaction id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId GIFT_CARDS_PROXY.READ\n */\n function getTransaction(_id: string): Promise;\n /**\n * Get gift card provider URL\n * @param providerAppDefId - App def id of the GiftCard provider\n * @internal\n * @documentationMaturity preview\n * @requiredField providerAppDefId\n * @permissionId GIFT_CARDS_PROXY.READ\n */\n function getProviderUrl(providerAppDefId: string): Promise;\n \n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetRequest = GetRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetResponse = GetResponse;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_DBGiftCard = DBGiftCard;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_ListGiftCardsRequest = ListGiftCardsRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_Query = Query;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_ListGiftCardsResponse = ListGiftCardsResponse;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_ListTransactionsRequest = ListTransactionsRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_ListTransactionsResponse = ListTransactionsResponse;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_DBTransaction = DBTransaction;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_CreateGiftCardRequest = CreateGiftCardRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GiftCardData = GiftCardData;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_CreateGiftCardResponse = CreateGiftCardResponse;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeRequest = GetGiftCardByCodeRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeResponse = GetGiftCardByCodeResponse;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeRequestV2 = GetGiftCardByCodeRequestV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeResponseV2 = GetGiftCardByCodeResponseV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_RedeemGiftCardRequestV2 = RedeemGiftCardRequestV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_RedeemGiftCardResponseV2 = RedeemGiftCardResponseV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_TransactionVoided = TransactionVoided;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_VoidTransactionRequestV2 = VoidTransactionRequestV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_VoidTransactionResponseV2 = VoidTransactionResponseV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetTransactionRequest = GetTransactionRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetTransactionResponse = GetTransactionResponse;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetProviderUrlRequest = GetProviderUrlRequest;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetProviderUrlResponse = GetProviderUrlResponse;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_get: typeof get;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_listGiftCards: typeof listGiftCards;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_ListGiftCardsOptions = ListGiftCardsOptions;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_listTransactions: typeof listTransactions;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_ListTransactionsOptions = ListTransactionsOptions;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_createGiftCard: typeof createGiftCard;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_getGiftCardByCode: typeof getGiftCardByCode;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeOptions = GetGiftCardByCodeOptions;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_getGiftCardByCodeV2: typeof getGiftCardByCodeV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeV2Options = GetGiftCardByCodeV2Options;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_redeemGiftCardV2: typeof redeemGiftCardV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_RedeemGiftCardV2Options = RedeemGiftCardV2Options;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_voidTransactionV2: typeof voidTransactionV2;\n type ecommerceGiftCardsProxyV1GiftCard_universal_d_VoidTransactionV2Options = VoidTransactionV2Options;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_getTransaction: typeof getTransaction;\n const ecommerceGiftCardsProxyV1GiftCard_universal_d_getProviderUrl: typeof getProviderUrl;\n namespace ecommerceGiftCardsProxyV1GiftCard_universal_d {\n export {\n GiftCard$7 as GiftCard,\n Balance$2 as Balance,\n Status$6 as Status,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetRequest as GetRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetResponse as GetResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_DBGiftCard as DBGiftCard,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_ListGiftCardsRequest as ListGiftCardsRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_Query as Query,\n Sorting$g as Sorting,\n SortOrder$g as SortOrder,\n Paging$4 as Paging,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_ListGiftCardsResponse as ListGiftCardsResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_ListTransactionsRequest as ListTransactionsRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_ListTransactionsResponse as ListTransactionsResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_DBTransaction as DBTransaction,\n GiftCardProviderWasProvisioned$1 as GiftCardProviderWasProvisioned,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_CreateGiftCardRequest as CreateGiftCardRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GiftCardData as GiftCardData,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_CreateGiftCardResponse as CreateGiftCardResponse,\n GetGiftCardRequest$1 as GetGiftCardRequest,\n GetGiftCardResponse$1 as GetGiftCardResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeRequest as GetGiftCardByCodeRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeResponse as GetGiftCardByCodeResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeRequestV2 as GetGiftCardByCodeRequestV2,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeResponseV2 as GetGiftCardByCodeResponseV2,\n RedeemGiftCardRequest$1 as RedeemGiftCardRequest,\n RedeemGiftCardResponse$1 as RedeemGiftCardResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_RedeemGiftCardRequestV2 as RedeemGiftCardRequestV2,\n Money$1 as Money,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_RedeemGiftCardResponseV2 as RedeemGiftCardResponseV2,\n VoidTransactionRequest$1 as VoidTransactionRequest,\n VoidTransactionResponse$1 as VoidTransactionResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_TransactionVoided as TransactionVoided,\n Transaction$1 as Transaction,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_VoidTransactionRequestV2 as VoidTransactionRequestV2,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_VoidTransactionResponseV2 as VoidTransactionResponseV2,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetTransactionRequest as GetTransactionRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetTransactionResponse as GetTransactionResponse,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetProviderUrlRequest as GetProviderUrlRequest,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetProviderUrlResponse as GetProviderUrlResponse,\n MetaSiteSpecialEvent$1 as MetaSiteSpecialEvent,\n MetaSiteSpecialEventPayloadOneOf$1 as MetaSiteSpecialEventPayloadOneOf,\n Asset$1 as Asset,\n State$2 as State,\n SiteCreated$1 as SiteCreated,\n SiteCreatedContext$1 as SiteCreatedContext,\n Namespace$2 as Namespace,\n SiteTransferred$1 as SiteTransferred,\n SiteDeleted$1 as SiteDeleted,\n DeleteContext$1 as DeleteContext,\n DeleteStatus$1 as DeleteStatus,\n SiteUndeleted$1 as SiteUndeleted,\n SitePublished$1 as SitePublished,\n SiteUnpublished$1 as SiteUnpublished,\n SiteMarkedAsTemplate$1 as SiteMarkedAsTemplate,\n SiteMarkedAsWixSite$1 as SiteMarkedAsWixSite,\n ServiceProvisioned$1 as ServiceProvisioned,\n ServiceRemoved$1 as ServiceRemoved,\n SiteRenamed$1 as SiteRenamed,\n SiteHardDeleted$1 as SiteHardDeleted,\n NamespaceChanged$1 as NamespaceChanged,\n StudioAssigned$1 as StudioAssigned,\n StudioUnassigned$1 as StudioUnassigned,\n Empty$h as Empty,\n DomainEvent$o as DomainEvent,\n DomainEventBodyOneOf$o as DomainEventBodyOneOf,\n EntityCreatedEvent$o as EntityCreatedEvent,\n RestoreInfo$o as RestoreInfo,\n EntityUpdatedEvent$o as EntityUpdatedEvent,\n EntityDeletedEvent$o as EntityDeletedEvent,\n ActionEvent$o as ActionEvent,\n MessageEnvelope$n as MessageEnvelope,\n IdentificationData$o as IdentificationData,\n IdentificationDataIdOneOf$o as IdentificationDataIdOneOf,\n WebhookIdentityType$n as WebhookIdentityType,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_get as get,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_listGiftCards as listGiftCards,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_ListGiftCardsOptions as ListGiftCardsOptions,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_listTransactions as listTransactions,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_ListTransactionsOptions as ListTransactionsOptions,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_createGiftCard as createGiftCard,\n getGiftCard$1 as getGiftCard,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_getGiftCardByCode as getGiftCardByCode,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeOptions as GetGiftCardByCodeOptions,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_getGiftCardByCodeV2 as getGiftCardByCodeV2,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_GetGiftCardByCodeV2Options as GetGiftCardByCodeV2Options,\n redeemGiftCard$1 as redeemGiftCard,\n RedeemGiftCardOptions$1 as RedeemGiftCardOptions,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_redeemGiftCardV2 as redeemGiftCardV2,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_RedeemGiftCardV2Options as RedeemGiftCardV2Options,\n voidTransaction$1 as voidTransaction,\n VoidTransactionOptions$1 as VoidTransactionOptions,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_voidTransactionV2 as voidTransactionV2,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_VoidTransactionV2Options as VoidTransactionV2Options,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_getTransaction as getTransaction,\n ecommerceGiftCardsProxyV1GiftCard_universal_d_getProviderUrl as getProviderUrl,\n };\n }\n \n interface CheckoutContentProvider {\n _id?: string | null;\n }\n interface GetCheckoutContentRequest {\n /** ID of the app that provides the content. */\n appId: string;\n /** ID of the specific component content. */\n componentId: string;\n /** When a language is specified, it will be retrieved the content in that language. */\n languageCode?: string | null;\n }\n interface GetCheckoutContentResponse {\n /** The requested CheckoutContent. */\n checkoutContent?: CheckoutContent;\n }\n interface CheckoutContent {\n /**\n * Text to display in place of the \"Continue shopping\" link.\n * @readonly\n */\n continueShoppingLink?: string | null;\n /**\n * Text to display in place of the \"Order summary\" title.\n * @readonly\n */\n orderSummary?: string | null;\n /**\n * Text to display in place of the \"Customer details\" title.\n * @readonly\n */\n customerDetails?: string | null;\n /**\n * Text to display in place of the \"Review and place order\" title.\n * @readonly\n */\n reviewAndPlaceOrder?: string | null;\n /**\n * Text to display in place of the \"Place order\" button.\n * @readonly\n */\n placeOrderButton?: string | null;\n /**\n * Text to display in place of the \"Place order & pay\" button.\n * @readonly\n */\n placeOrderPayButton?: string | null;\n }\n /**\n * Retrieves a CheckoutContent.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.appId\n * @requiredField identifiers.componentId\n * @permissionId ECOM.CHECKOUT_CONTENT_READ\n */\n function getCheckoutContent(identifiers: GetCheckoutContentIdentifiers, options?: GetCheckoutContentOptions): Promise;\n interface GetCheckoutContentIdentifiers {\n /** ID of the app that provides the content. */\n appId: string;\n /** ID of the specific component content. */\n componentId: string;\n }\n interface GetCheckoutContentOptions {\n /** When a language is specified, it will be retrieved the content in that language. */\n languageCode?: string | null;\n }\n \n type ecomApiV1CheckoutContentProvider_universal_d_CheckoutContentProvider = CheckoutContentProvider;\n type ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentRequest = GetCheckoutContentRequest;\n type ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentResponse = GetCheckoutContentResponse;\n type ecomApiV1CheckoutContentProvider_universal_d_CheckoutContent = CheckoutContent;\n const ecomApiV1CheckoutContentProvider_universal_d_getCheckoutContent: typeof getCheckoutContent;\n type ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentIdentifiers = GetCheckoutContentIdentifiers;\n type ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentOptions = GetCheckoutContentOptions;\n namespace ecomApiV1CheckoutContentProvider_universal_d {\n export {\n ecomApiV1CheckoutContentProvider_universal_d_CheckoutContentProvider as CheckoutContentProvider,\n ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentRequest as GetCheckoutContentRequest,\n ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentResponse as GetCheckoutContentResponse,\n ecomApiV1CheckoutContentProvider_universal_d_CheckoutContent as CheckoutContent,\n ecomApiV1CheckoutContentProvider_universal_d_getCheckoutContent as getCheckoutContent,\n ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentIdentifiers as GetCheckoutContentIdentifiers,\n ecomApiV1CheckoutContentProvider_universal_d_GetCheckoutContentOptions as GetCheckoutContentOptions,\n };\n }\n \n interface CustomTrigger {\n /** Unique ID of the trigger */\n _id?: string;\n /** App ID of the trigger provider */\n appId?: string;\n /**\n * Optional - additional data in key:value form\n * This data will be passed to `GetEligibleTriggers` SPI\n * i.e weather trigger - be eligible if temp is above 30 degrees, params will have { \"minTemp\": 30 }\n * @internal\n */\n params?: Record | null;\n }\n interface GetEligibleTriggersRequest {\n /** List of line items to check the custom triggers on */\n lineItems?: LineItem$8[];\n /** List of custom triggers to check 'is eligible' on */\n triggers?: TriggerToFilterBy[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n interface LineItem$8 {\n /** Line item ID. */\n _id?: string;\n /** Item quantity in this line item. */\n quantity?: number | null;\n /**\n * Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info.\n * This field may be empty in the case of a custom line item.\n */\n catalogReference?: CatalogReference$d;\n /** Price of a single item. */\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$d {\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 [app dashboard](https://dev.wix.com/dc3/my-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 TriggerToFilterBy {\n /** Custom trigger */\n customTrigger?: CustomTrigger;\n /** Unique identifier that will return in `EligibleTrigger.identifier` to distinguish between scopes */\n identifier?: string | null;\n }\n interface GetEligibleTriggersResponse {\n /** A List of eligible custom triggers */\n eligibleTriggers?: EligibleTrigger[];\n }\n interface EligibleTrigger {\n /** The ID of the custom trigger */\n customTriggerId?: string;\n /** The id of the application implements this custom trigger */\n appId?: string;\n /** Unique identifier that was assigned in `TriggerToFilterBy.identifier` to distinguish between custom triggers */\n identifier?: string | null;\n }\n interface ListTriggersRequest {\n }\n interface ListTriggersResponse {\n /** A list of all custom triggers */\n triggers?: ListTriggersResponseCustomTrigger[];\n }\n interface ListTriggersResponseCustomTrigger {\n /** Unique ID of the custom trigger */\n _id?: string;\n /** App ID of the custom trigger provider */\n appId?: string;\n /** Custom Trigger display name */\n name?: string;\n }\n /**\n * Get the items that are included in some given custom triggers\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.GET_ELIGIBLE_TRIGGERS\n */\n function getEligibleTriggers(options?: GetEligibleTriggersOptions): Promise;\n interface GetEligibleTriggersOptions {\n /** List of line items to check the custom triggers on */\n lineItems?: LineItem$8[];\n /** List of custom triggers to check 'is eligible' on */\n triggers?: TriggerToFilterBy[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n /**\n * List all custom triggers that are available on a given site\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.CUSTOM_TRIGGERS_READ\n * @adminMethod\n */\n function listTriggers(): Promise;\n \n type ecomCustomTriggerV1CustomTrigger_universal_d_CustomTrigger = CustomTrigger;\n type ecomCustomTriggerV1CustomTrigger_universal_d_GetEligibleTriggersRequest = GetEligibleTriggersRequest;\n type ecomCustomTriggerV1CustomTrigger_universal_d_TriggerToFilterBy = TriggerToFilterBy;\n type ecomCustomTriggerV1CustomTrigger_universal_d_GetEligibleTriggersResponse = GetEligibleTriggersResponse;\n type ecomCustomTriggerV1CustomTrigger_universal_d_EligibleTrigger = EligibleTrigger;\n type ecomCustomTriggerV1CustomTrigger_universal_d_ListTriggersRequest = ListTriggersRequest;\n type ecomCustomTriggerV1CustomTrigger_universal_d_ListTriggersResponse = ListTriggersResponse;\n type ecomCustomTriggerV1CustomTrigger_universal_d_ListTriggersResponseCustomTrigger = ListTriggersResponseCustomTrigger;\n const ecomCustomTriggerV1CustomTrigger_universal_d_getEligibleTriggers: typeof getEligibleTriggers;\n type ecomCustomTriggerV1CustomTrigger_universal_d_GetEligibleTriggersOptions = GetEligibleTriggersOptions;\n const ecomCustomTriggerV1CustomTrigger_universal_d_listTriggers: typeof listTriggers;\n namespace ecomCustomTriggerV1CustomTrigger_universal_d {\n export {\n ecomCustomTriggerV1CustomTrigger_universal_d_CustomTrigger as CustomTrigger,\n ecomCustomTriggerV1CustomTrigger_universal_d_GetEligibleTriggersRequest as GetEligibleTriggersRequest,\n LineItem$8 as LineItem,\n CatalogReference$d as CatalogReference,\n ecomCustomTriggerV1CustomTrigger_universal_d_TriggerToFilterBy as TriggerToFilterBy,\n ecomCustomTriggerV1CustomTrigger_universal_d_GetEligibleTriggersResponse as GetEligibleTriggersResponse,\n ecomCustomTriggerV1CustomTrigger_universal_d_EligibleTrigger as EligibleTrigger,\n ecomCustomTriggerV1CustomTrigger_universal_d_ListTriggersRequest as ListTriggersRequest,\n ecomCustomTriggerV1CustomTrigger_universal_d_ListTriggersResponse as ListTriggersResponse,\n ecomCustomTriggerV1CustomTrigger_universal_d_ListTriggersResponseCustomTrigger as ListTriggersResponseCustomTrigger,\n ecomCustomTriggerV1CustomTrigger_universal_d_getEligibleTriggers as getEligibleTriggers,\n ecomCustomTriggerV1CustomTrigger_universal_d_GetEligibleTriggersOptions as GetEligibleTriggersOptions,\n ecomCustomTriggerV1CustomTrigger_universal_d_listTriggers as listTriggers,\n };\n }\n \n interface DiscountRule$8 {\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 | null;\n /**\n * Date and time the discount rule was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * > **Notes:**\n * >\n * > + Currently, only 1 discount can be defined per discount rule.\n * > + A discount rule can be applied on multiple items per cart.\n * > + A discount rule can only be applied once per item.\n */\n discounts?: Discounts;\n /**\n * Discount rule status.\n * Default: `UNDEFINED`\n * @readonly\n */\n status?: Status$5;\n /**\n * Number of times the discount rule was used.\n * @readonly\n */\n usageCount?: number;\n /**\n * calculated string which describe the discount rule\n * @internal\n * @readonly\n */\n offer?: string | null;\n /**\n * Discount advance settings.\n * @internal\n */\n settings?: DiscountSettings;\n /**\n * Data Extensions.\n * @internal\n */\n extendedFields?: ExtendedFields$c;\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$5 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 /** List of triggers to have an \"AND\" operator between their results. */\n triggers?: DiscountTrigger[];\n }\n interface Or {\n /** List of triggers to have an \"OR\" operator between their results. */\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 * Additional data in { \"key\": value } form.\n * + This data will be passed to the Custom Triggers Service SPI.\n * + For example, for a trigger that would activate if temperature is above 30 degrees, `params` field would be: `{ \"minTemp\": 30 }`.\n * @internal\n */\n params?: Record | null;\n }\n interface SubtotalRange {\n /** Relevant scopes for `\"SPECIFIC_ITEMS\"` target type. */\n scopes?: Scope$5[];\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$5[];\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 /** Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported. */\n AND = \"AND\",\n /** Subtotal must be within the specified `subtotalRange` values. */\n SUBTOTAL_RANGE = \"SUBTOTAL_RANGE\",\n /** Quantity of items in scope must be within specified `itemQuantityRange` values. */\n ITEM_QUANTITY_RANGE = \"ITEM_QUANTITY_RANGE\",\n /** Custom trigger type defined in `customTrigger` object. */\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 | null;\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 | null;\n }\n interface Discounts {\n /** Discounts. */\n values?: Discount$3[];\n }\n interface Discount$3 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$8;\n /**\n * Data related to `BUY_X_GET_Y` target type.\n * @internal\n */\n buyXGetYInfo?: BuyXGetYInfo;\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$5[];\n /**\n * limit number of items the discount can be applied to\n * if no limit specified, the discount will be applied to all items in the request that match 'scopes' field\n * @internal\n */\n limit?: number | null;\n }\n enum DiscountType$8 {\n UNDEFINED = \"UNDEFINED\",\n /** Price is reduced by percentage value. */\n PERCENTAGE = \"PERCENTAGE\",\n /** Price is reduced by fixed amount. */\n FIXED_AMOUNT = \"FIXED_AMOUNT\",\n /** Price will be set to fixed amount. */\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$5[];\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$5[];\n }\n enum Status$5 {\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 * Opt in to indexing this discount rule by an offline pipeline.\n * Default value is false (rules are not indexed by default).\n * The purpose of indexing discount rules is to allow fast reads of potential discounts on given catalog items,\n * without having to do heavy calculations like in `GetAppliedDiscounts` API.\n * One can read this data from [Discounts Cache Reader Service](https://todo-add-working-link)\n * This can be used for example, to display potential discounts on the storefront.\n * @internal\n */\n indexOptIn?: boolean | 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$c {\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$8;\n }\n interface CreateDiscountRuleResponse {\n /** Discount rule. */\n discountRule?: DiscountRule$8;\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$8;\n }\n interface UpdateDiscountRuleRequest {\n /** Discount rule info. */\n discountRule: DiscountRule$8;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateDiscountRuleResponse {\n /** Updated discount rule. */\n discountRule?: DiscountRule$8;\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$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$f;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting$f[];\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$f;\n }\n interface Sorting$f {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$f;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$f {\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$f {\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$8[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: 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$f;\n }\n interface Cursors$f {\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$7[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n interface LineItem$7 {\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$c;\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$c {\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 [app dashboard](https://dev.wix.com/dc3/my-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$8[];\n }\n interface AppliedDiscount$8 {\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$8;\n /** Total amount reduced from all discounted line items. */\n amount?: MultiCurrencyPrice$6;\n /** Discount rule type. */\n discountRuleType?: DiscountType$8;\n }\n interface DiscountRuleName$8 {\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$6 {\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$n extends DomainEventBodyOneOf$n {\n createdEvent?: EntityCreatedEvent$n;\n updatedEvent?: EntityUpdatedEvent$n;\n deletedEvent?: EntityDeletedEvent$n;\n actionEvent?: ActionEvent$n;\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 {\n createdEvent?: EntityCreatedEvent$n;\n updatedEvent?: EntityUpdatedEvent$n;\n deletedEvent?: EntityDeletedEvent$n;\n actionEvent?: ActionEvent$n;\n }\n interface EntityCreatedEvent$n {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$n;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$n {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$n {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$n {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$n {\n bodyAsJson?: string;\n }\n interface Empty$g {\n }\n interface DiscountRuleUsageLimitReached {\n /** Discount Rule */\n rule?: DiscountRule$8;\n }\n interface MessageEnvelope$m {\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;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$n extends IdentificationDataIdOneOf$n {\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$m;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$n {\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$m {\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 * @permissionId ECOM.DISCOUNT_RULES_CREATE\n * @adminMethod\n * @returns Discount rule.\n */\n function createDiscountRule(discountRule: DiscountRule$8): 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 * @permissionId ECOM.DISCOUNT_RULES_READ\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 * @permissionId ECOM.DISCOUNT_RULES_UPDATE\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 | null;\n /**\n * Date and time the discount rule was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * > **Notes:**\n * >\n * > + Currently, only 1 discount can be defined per discount rule.\n * > + A discount rule can be applied on multiple items per cart.\n * > + A discount rule can only be applied once per item.\n */\n discounts?: Discounts;\n /**\n * Discount rule status.\n * Default: `UNDEFINED`\n * @readonly\n */\n status?: Status$5;\n /**\n * Number of times the discount rule was used.\n * @readonly\n */\n usageCount?: number;\n /**\n * calculated string which describe the discount rule\n * @internal\n * @readonly\n */\n offer?: string | null;\n /**\n * Discount advance settings.\n * @internal\n */\n settings?: DiscountSettings;\n /**\n * Data Extensions.\n * @internal\n */\n extendedFields?: ExtendedFields$c;\n }\n interface UpdateDiscountRuleOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\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 * @permissionId ECOM.DISCOUNT_RULES_DELETE\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 * @permissionId ECOM.DISCOUNT_RULES_READ\n * @adminMethod\n */\n function queryDiscountRules(): DiscountRulesQueryBuilder;\n interface QueryCursorResult$f {\n cursors: Cursors$f;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DiscountRulesQueryResult extends QueryCursorResult$f {\n items: DiscountRule$8[];\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 /**\n * Retrieve all discounts that can be applied to the given line items.\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.GET_APPLIED_DISCOUNTS\n */\n function getAppliedDiscounts(options?: GetAppliedDiscountsOptions): Promise;\n interface GetAppliedDiscountsOptions {\n /** Line items for which to check for discount rules. */\n lineItems?: LineItem$7[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n \n type ecomDiscountsV1DiscountRule_universal_d_DiscountTrigger = DiscountTrigger;\n type ecomDiscountsV1DiscountRule_universal_d_DiscountTriggerTriggerOneOf = DiscountTriggerTriggerOneOf;\n type ecomDiscountsV1DiscountRule_universal_d_ScopeScopeItemsOneOf = ScopeScopeItemsOneOf;\n type ecomDiscountsV1DiscountRule_universal_d_ScopeType = ScopeType;\n const ecomDiscountsV1DiscountRule_universal_d_ScopeType: typeof ScopeType;\n type ecomDiscountsV1DiscountRule_universal_d_CatalogItemFilter = CatalogItemFilter;\n type ecomDiscountsV1DiscountRule_universal_d_CustomFilter = CustomFilter;\n type ecomDiscountsV1DiscountRule_universal_d_And = And;\n type ecomDiscountsV1DiscountRule_universal_d_Or = Or;\n type ecomDiscountsV1DiscountRule_universal_d_Custom = Custom;\n type ecomDiscountsV1DiscountRule_universal_d_SubtotalRange = SubtotalRange;\n type ecomDiscountsV1DiscountRule_universal_d_ItemQuantityRange = ItemQuantityRange;\n type ecomDiscountsV1DiscountRule_universal_d_TriggerType = TriggerType;\n const ecomDiscountsV1DiscountRule_universal_d_TriggerType: typeof TriggerType;\n type ecomDiscountsV1DiscountRule_universal_d_ActiveTimeInfo = ActiveTimeInfo;\n type ecomDiscountsV1DiscountRule_universal_d_Discounts = Discounts;\n type ecomDiscountsV1DiscountRule_universal_d_DiscountDiscountOneOf = DiscountDiscountOneOf;\n type ecomDiscountsV1DiscountRule_universal_d_Type = Type;\n const ecomDiscountsV1DiscountRule_universal_d_Type: typeof Type;\n type ecomDiscountsV1DiscountRule_universal_d_SpecificItemsInfo = SpecificItemsInfo;\n type ecomDiscountsV1DiscountRule_universal_d_BuyXGetYInfo = BuyXGetYInfo;\n type ecomDiscountsV1DiscountRule_universal_d_CustomerBuy = CustomerBuy;\n type ecomDiscountsV1DiscountRule_universal_d_CustomerBuyConditionOneOf = CustomerBuyConditionOneOf;\n type ecomDiscountsV1DiscountRule_universal_d_CustomerGet = CustomerGet;\n type ecomDiscountsV1DiscountRule_universal_d_DiscountSettings = DiscountSettings;\n type ecomDiscountsV1DiscountRule_universal_d_AppliedSubjectType = AppliedSubjectType;\n const ecomDiscountsV1DiscountRule_universal_d_AppliedSubjectType: typeof AppliedSubjectType;\n type ecomDiscountsV1DiscountRule_universal_d_CreateDiscountRuleRequest = CreateDiscountRuleRequest;\n type ecomDiscountsV1DiscountRule_universal_d_CreateDiscountRuleResponse = CreateDiscountRuleResponse;\n type ecomDiscountsV1DiscountRule_universal_d_GetDiscountRuleRequest = GetDiscountRuleRequest;\n type ecomDiscountsV1DiscountRule_universal_d_GetDiscountRuleResponse = GetDiscountRuleResponse;\n type ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRuleRequest = UpdateDiscountRuleRequest;\n type ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRuleResponse = UpdateDiscountRuleResponse;\n type ecomDiscountsV1DiscountRule_universal_d_DeleteDiscountRuleRequest = DeleteDiscountRuleRequest;\n type ecomDiscountsV1DiscountRule_universal_d_DeleteDiscountRuleResponse = DeleteDiscountRuleResponse;\n type ecomDiscountsV1DiscountRule_universal_d_QueryDiscountRulesRequest = QueryDiscountRulesRequest;\n type ecomDiscountsV1DiscountRule_universal_d_QueryDiscountRulesResponse = QueryDiscountRulesResponse;\n type ecomDiscountsV1DiscountRule_universal_d_GetAppliedDiscountsRequest = GetAppliedDiscountsRequest;\n type ecomDiscountsV1DiscountRule_universal_d_GetAppliedDiscountsResponse = GetAppliedDiscountsResponse;\n type ecomDiscountsV1DiscountRule_universal_d_AppliedDiscountRule = AppliedDiscountRule;\n type ecomDiscountsV1DiscountRule_universal_d_DiscountRuleUsageLimitReached = DiscountRuleUsageLimitReached;\n const ecomDiscountsV1DiscountRule_universal_d_createDiscountRule: typeof createDiscountRule;\n const ecomDiscountsV1DiscountRule_universal_d_getDiscountRule: typeof getDiscountRule;\n const ecomDiscountsV1DiscountRule_universal_d_updateDiscountRule: typeof updateDiscountRule;\n type ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRule = UpdateDiscountRule;\n type ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRuleOptions = UpdateDiscountRuleOptions;\n const ecomDiscountsV1DiscountRule_universal_d_deleteDiscountRule: typeof deleteDiscountRule;\n const ecomDiscountsV1DiscountRule_universal_d_queryDiscountRules: typeof queryDiscountRules;\n type ecomDiscountsV1DiscountRule_universal_d_DiscountRulesQueryResult = DiscountRulesQueryResult;\n type ecomDiscountsV1DiscountRule_universal_d_DiscountRulesQueryBuilder = DiscountRulesQueryBuilder;\n const ecomDiscountsV1DiscountRule_universal_d_getAppliedDiscounts: typeof getAppliedDiscounts;\n type ecomDiscountsV1DiscountRule_universal_d_GetAppliedDiscountsOptions = GetAppliedDiscountsOptions;\n namespace ecomDiscountsV1DiscountRule_universal_d {\n export {\n DiscountRule$8 as DiscountRule,\n ecomDiscountsV1DiscountRule_universal_d_DiscountTrigger as DiscountTrigger,\n ecomDiscountsV1DiscountRule_universal_d_DiscountTriggerTriggerOneOf as DiscountTriggerTriggerOneOf,\n Scope$5 as Scope,\n ecomDiscountsV1DiscountRule_universal_d_ScopeScopeItemsOneOf as ScopeScopeItemsOneOf,\n ecomDiscountsV1DiscountRule_universal_d_ScopeType as ScopeType,\n ecomDiscountsV1DiscountRule_universal_d_CatalogItemFilter as CatalogItemFilter,\n ecomDiscountsV1DiscountRule_universal_d_CustomFilter as CustomFilter,\n ecomDiscountsV1DiscountRule_universal_d_And as And,\n ecomDiscountsV1DiscountRule_universal_d_Or as Or,\n ecomDiscountsV1DiscountRule_universal_d_Custom as Custom,\n ecomDiscountsV1DiscountRule_universal_d_SubtotalRange as SubtotalRange,\n ecomDiscountsV1DiscountRule_universal_d_ItemQuantityRange as ItemQuantityRange,\n ecomDiscountsV1DiscountRule_universal_d_TriggerType as TriggerType,\n ecomDiscountsV1DiscountRule_universal_d_ActiveTimeInfo as ActiveTimeInfo,\n ecomDiscountsV1DiscountRule_universal_d_Discounts as Discounts,\n Discount$3 as Discount,\n ecomDiscountsV1DiscountRule_universal_d_DiscountDiscountOneOf as DiscountDiscountOneOf,\n ecomDiscountsV1DiscountRule_universal_d_Type as Type,\n ecomDiscountsV1DiscountRule_universal_d_SpecificItemsInfo as SpecificItemsInfo,\n DiscountType$8 as DiscountType,\n ecomDiscountsV1DiscountRule_universal_d_BuyXGetYInfo as BuyXGetYInfo,\n ecomDiscountsV1DiscountRule_universal_d_CustomerBuy as CustomerBuy,\n ecomDiscountsV1DiscountRule_universal_d_CustomerBuyConditionOneOf as CustomerBuyConditionOneOf,\n ecomDiscountsV1DiscountRule_universal_d_CustomerGet as CustomerGet,\n Status$5 as Status,\n ecomDiscountsV1DiscountRule_universal_d_DiscountSettings as DiscountSettings,\n ecomDiscountsV1DiscountRule_universal_d_AppliedSubjectType as AppliedSubjectType,\n ExtendedFields$c as ExtendedFields,\n ecomDiscountsV1DiscountRule_universal_d_CreateDiscountRuleRequest as CreateDiscountRuleRequest,\n ecomDiscountsV1DiscountRule_universal_d_CreateDiscountRuleResponse as CreateDiscountRuleResponse,\n ecomDiscountsV1DiscountRule_universal_d_GetDiscountRuleRequest as GetDiscountRuleRequest,\n ecomDiscountsV1DiscountRule_universal_d_GetDiscountRuleResponse as GetDiscountRuleResponse,\n ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRuleRequest as UpdateDiscountRuleRequest,\n ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRuleResponse as UpdateDiscountRuleResponse,\n ecomDiscountsV1DiscountRule_universal_d_DeleteDiscountRuleRequest as DeleteDiscountRuleRequest,\n ecomDiscountsV1DiscountRule_universal_d_DeleteDiscountRuleResponse as DeleteDiscountRuleResponse,\n ecomDiscountsV1DiscountRule_universal_d_QueryDiscountRulesRequest as QueryDiscountRulesRequest,\n PlatformQuery$2 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf,\n Sorting$f as Sorting,\n SortOrder$f as SortOrder,\n PlatformPaging$2 as PlatformPaging,\n CursorPaging$f as CursorPaging,\n ecomDiscountsV1DiscountRule_universal_d_QueryDiscountRulesResponse as QueryDiscountRulesResponse,\n PlatformPagingMetadata$2 as PlatformPagingMetadata,\n Cursors$f as Cursors,\n ecomDiscountsV1DiscountRule_universal_d_GetAppliedDiscountsRequest as GetAppliedDiscountsRequest,\n LineItem$7 as LineItem,\n CatalogReference$c as CatalogReference,\n ecomDiscountsV1DiscountRule_universal_d_GetAppliedDiscountsResponse as GetAppliedDiscountsResponse,\n AppliedDiscount$8 as AppliedDiscount,\n ecomDiscountsV1DiscountRule_universal_d_AppliedDiscountRule as AppliedDiscountRule,\n DiscountRuleName$8 as DiscountRuleName,\n MultiCurrencyPrice$6 as MultiCurrencyPrice,\n DomainEvent$n as DomainEvent,\n DomainEventBodyOneOf$n as DomainEventBodyOneOf,\n EntityCreatedEvent$n as EntityCreatedEvent,\n RestoreInfo$n as RestoreInfo,\n EntityUpdatedEvent$n as EntityUpdatedEvent,\n EntityDeletedEvent$n as EntityDeletedEvent,\n ActionEvent$n as ActionEvent,\n Empty$g as Empty,\n ecomDiscountsV1DiscountRule_universal_d_DiscountRuleUsageLimitReached as DiscountRuleUsageLimitReached,\n MessageEnvelope$m as MessageEnvelope,\n IdentificationData$n as IdentificationData,\n IdentificationDataIdOneOf$n as IdentificationDataIdOneOf,\n WebhookIdentityType$m as WebhookIdentityType,\n ecomDiscountsV1DiscountRule_universal_d_createDiscountRule as createDiscountRule,\n ecomDiscountsV1DiscountRule_universal_d_getDiscountRule as getDiscountRule,\n ecomDiscountsV1DiscountRule_universal_d_updateDiscountRule as updateDiscountRule,\n ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRule as UpdateDiscountRule,\n ecomDiscountsV1DiscountRule_universal_d_UpdateDiscountRuleOptions as UpdateDiscountRuleOptions,\n ecomDiscountsV1DiscountRule_universal_d_deleteDiscountRule as deleteDiscountRule,\n ecomDiscountsV1DiscountRule_universal_d_queryDiscountRules as queryDiscountRules,\n ecomDiscountsV1DiscountRule_universal_d_DiscountRulesQueryResult as DiscountRulesQueryResult,\n ecomDiscountsV1DiscountRule_universal_d_DiscountRulesQueryBuilder as DiscountRulesQueryBuilder,\n ecomDiscountsV1DiscountRule_universal_d_getAppliedDiscounts as getAppliedDiscounts,\n ecomDiscountsV1DiscountRule_universal_d_GetAppliedDiscountsOptions as GetAppliedDiscountsOptions,\n };\n }\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 /**\n * Invoices info. Deprecated: use `invoices_info` instead\n * @internal\n * @deprecated\n */\n invoices?: Invoice[];\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$4;\n }\n interface BulkInvoiceResult$1 {\n itemMetadata?: ItemMetadata$4;\n item?: InvoiceForOrder$1;\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$c;\n }\n interface ApplicationError$c {\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$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 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$m extends DomainEventBodyOneOf$m {\n createdEvent?: EntityCreatedEvent$m;\n updatedEvent?: EntityUpdatedEvent$m;\n deletedEvent?: EntityDeletedEvent$m;\n actionEvent?: ActionEvent$m;\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$m {\n createdEvent?: EntityCreatedEvent$m;\n updatedEvent?: EntityUpdatedEvent$m;\n deletedEvent?: EntityDeletedEvent$m;\n actionEvent?: ActionEvent$m;\n }\n interface EntityCreatedEvent$m {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$m;\n }\n interface RestoreInfo$m {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$m {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$m {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$m {\n bodyAsJson?: string;\n }\n interface Empty$f {\n }\n interface GetOrderInvoiceRequest {\n /** Invoice ID. */\n invoiceId: string;\n }\n interface GetOrderInvoiceResponse {\n /** Order ID. */\n orderId?: string;\n /** Invoice info. */\n invoiceInfo?: Invoice;\n }\n interface GenerateInvoiceWithNumberRequest {\n /** Order ID. */\n orderId: string;\n invoiceNumber: string;\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 issueDate?: Date | null;\n }\n interface GenerateInvoiceWithNumberResponse {\n /** Invoice ID. */\n invoiceId?: string;\n }\n interface MessageEnvelope$l {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$m;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$m extends IdentificationDataIdOneOf$m {\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$l;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$m {\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$l {\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 a specified order.\n *\n *\n * The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.READ_INVOICES\n */\n function listInvoicesForSingleOrder$1(orderId: string): Promise;\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 * @permissionId ECOM.READ_INVOICES\n */\n function listInvoicesForMultipleOrders$1(orderIds: string[]): Promise;\n /**\n * Retrieves invoices associated with all specified orders.\n * !!! Deprecated !!!\n * @param orderIds - Order IDs for which to retrieve invoices.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionId ECOM.READ_INVOICES\n * @deprecated\n * @targetRemovalDate 2025-03-02\n */\n function listInvoicesForMultipleOrdersOld$1(orderIds: string[]): Promise;\n /**\n * Generates and adds an invoice to a specified order.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.MODIFY_INVOICES\n * @adminMethod\n */\n function generateInvoice$1(orderId: string): Promise;\n /**\n * Generates and adds invoices to all specified orders.\n * @param orderIds - Order IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionId ECOM.MODIFY_INVOICES\n * @adminMethod\n */\n function bulkGenerateInvoices$1(orderIds: string[]): Promise;\n /**\n * Adds an invoice to a specified order.\n * @param orderId - Order ID.\n * @param invoiceInfo - Invoice info.\n * @internal\n * @documentationMaturity preview\n * @requiredField invoiceInfo\n * @requiredField invoiceInfo._id\n * @requiredField invoiceInfo.appId\n * @requiredField orderId\n * @permissionId ECOM.ADD_INVOICE\n * @adminMethod\n */\n function addInvoiceToOrder$1(orderId: string, invoiceInfo: Invoice): Promise;\n /** @param invoiceId - Invoice ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField invoiceId\n * @permissionId ECOM.READ_INVOICES\n */\n function getOrderInvoice(invoiceId: string): Promise;\n /**\n * Generates and adds an invoice to a specified order.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField invoiceNumber\n * @requiredField orderId\n * @permissionId ECOM.MODIFY_INVOICES\n * @adminMethod\n */\n function generateInvoiceWithNumber(orderId: string, invoiceNumber: string, options?: GenerateInvoiceWithNumberOptions): Promise;\n interface GenerateInvoiceWithNumberOptions {\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 issueDate?: Date | null;\n }\n \n type ecomOrdersV1Invoice_universal_d_Invoice = Invoice;\n type ecomOrdersV1Invoice_universal_d_GetOrderInvoiceRequest = GetOrderInvoiceRequest;\n type ecomOrdersV1Invoice_universal_d_GetOrderInvoiceResponse = GetOrderInvoiceResponse;\n type ecomOrdersV1Invoice_universal_d_GenerateInvoiceWithNumberRequest = GenerateInvoiceWithNumberRequest;\n type ecomOrdersV1Invoice_universal_d_GenerateInvoiceWithNumberResponse = GenerateInvoiceWithNumberResponse;\n const ecomOrdersV1Invoice_universal_d_getOrderInvoice: typeof getOrderInvoice;\n const ecomOrdersV1Invoice_universal_d_generateInvoiceWithNumber: typeof generateInvoiceWithNumber;\n type ecomOrdersV1Invoice_universal_d_GenerateInvoiceWithNumberOptions = GenerateInvoiceWithNumberOptions;\n namespace ecomOrdersV1Invoice_universal_d {\n export {\n ecomOrdersV1Invoice_universal_d_Invoice as Invoice,\n ListInvoicesForSingleOrderRequest$1 as ListInvoicesForSingleOrderRequest,\n ListInvoicesForSingleOrderResponse$1 as ListInvoicesForSingleOrderResponse,\n ListInvoicesForMultipleOrdersRequest$1 as ListInvoicesForMultipleOrdersRequest,\n ListInvoicesForMultipleOrdersResponse$1 as ListInvoicesForMultipleOrdersResponse,\n InvoicesForOrder$1 as InvoicesForOrder,\n GenerateInvoiceRequest$1 as GenerateInvoiceRequest,\n GenerateInvoiceResponse$1 as GenerateInvoiceResponse,\n BulkGenerateInvoicesRequest$1 as BulkGenerateInvoicesRequest,\n BulkGenerateInvoicesResponse$1 as BulkGenerateInvoicesResponse,\n BulkInvoiceResult$1 as BulkInvoiceResult,\n ItemMetadata$4 as ItemMetadata,\n ApplicationError$c as ApplicationError,\n InvoiceForOrder$1 as InvoiceForOrder,\n BulkActionMetadata$4 as BulkActionMetadata,\n AddInvoiceToOrderRequest$1 as AddInvoiceToOrderRequest,\n AddInvoiceToOrderResponse$1 as AddInvoiceToOrderResponse,\n DomainEvent$m as DomainEvent,\n DomainEventBodyOneOf$m as DomainEventBodyOneOf,\n EntityCreatedEvent$m as EntityCreatedEvent,\n RestoreInfo$m as RestoreInfo,\n EntityUpdatedEvent$m as EntityUpdatedEvent,\n EntityDeletedEvent$m as EntityDeletedEvent,\n ActionEvent$m as ActionEvent,\n Empty$f as Empty,\n ecomOrdersV1Invoice_universal_d_GetOrderInvoiceRequest as GetOrderInvoiceRequest,\n ecomOrdersV1Invoice_universal_d_GetOrderInvoiceResponse as GetOrderInvoiceResponse,\n ecomOrdersV1Invoice_universal_d_GenerateInvoiceWithNumberRequest as GenerateInvoiceWithNumberRequest,\n ecomOrdersV1Invoice_universal_d_GenerateInvoiceWithNumberResponse as GenerateInvoiceWithNumberResponse,\n MessageEnvelope$l as MessageEnvelope,\n IdentificationData$m as IdentificationData,\n IdentificationDataIdOneOf$m as IdentificationDataIdOneOf,\n WebhookIdentityType$l as WebhookIdentityType,\n listInvoicesForSingleOrder$1 as listInvoicesForSingleOrder,\n listInvoicesForMultipleOrders$1 as listInvoicesForMultipleOrders,\n listInvoicesForMultipleOrdersOld$1 as listInvoicesForMultipleOrdersOld,\n generateInvoice$1 as generateInvoice,\n bulkGenerateInvoices$1 as bulkGenerateInvoices,\n addInvoiceToOrder$1 as addInvoiceToOrder,\n ecomOrdersV1Invoice_universal_d_getOrderInvoice as getOrderInvoice,\n ecomOrdersV1Invoice_universal_d_generateInvoiceWithNumber as generateInvoiceWithNumber,\n ecomOrdersV1Invoice_universal_d_GenerateInvoiceWithNumberOptions as GenerateInvoiceWithNumberOptions,\n };\n }\n \n interface Recommendation {\n /** Recommended items. */\n items?: CatalogReference$b[];\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$b {\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 [app dashboard](https://dev.wix.com/dc3/my-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 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 /** 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 algorithmId?: string;\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$b[];\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$b[];\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 * @permissionId RECOMMENDATIONS.READ\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 * @permissionId RECOMMENDATIONS.READ\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$b[];\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 \n type ecomRecommendationsV1Recommendation_universal_d_Recommendation = Recommendation;\n type ecomRecommendationsV1Recommendation_universal_d_Algorithm = Algorithm;\n type ecomRecommendationsV1Recommendation_universal_d_ListAvailableAlgorithmsRequest = ListAvailableAlgorithmsRequest;\n type ecomRecommendationsV1Recommendation_universal_d_ListAvailableAlgorithmsResponse = ListAvailableAlgorithmsResponse;\n type ecomRecommendationsV1Recommendation_universal_d_AlgorithmInfo = AlgorithmInfo;\n type ecomRecommendationsV1Recommendation_universal_d_AlgorithmConfig = AlgorithmConfig;\n type ecomRecommendationsV1Recommendation_universal_d_AlgorithmType = AlgorithmType;\n const ecomRecommendationsV1Recommendation_universal_d_AlgorithmType: typeof AlgorithmType;\n type ecomRecommendationsV1Recommendation_universal_d_GetRecommendationRequest = GetRecommendationRequest;\n type ecomRecommendationsV1Recommendation_universal_d_GetRecommendationResponse = GetRecommendationResponse;\n type ecomRecommendationsV1Recommendation_universal_d_ItemAppIdNotSupportedByProvider = ItemAppIdNotSupportedByProvider;\n type ecomRecommendationsV1Recommendation_universal_d_RecommendationAlgorithmNotSupported = RecommendationAlgorithmNotSupported;\n const ecomRecommendationsV1Recommendation_universal_d_listAvailableAlgorithms: typeof listAvailableAlgorithms;\n const ecomRecommendationsV1Recommendation_universal_d_getRecommendation: typeof getRecommendation;\n type ecomRecommendationsV1Recommendation_universal_d_GetRecommendationOptions = GetRecommendationOptions;\n namespace ecomRecommendationsV1Recommendation_universal_d {\n export {\n ecomRecommendationsV1Recommendation_universal_d_Recommendation as Recommendation,\n CatalogReference$b as CatalogReference,\n ecomRecommendationsV1Recommendation_universal_d_Algorithm as Algorithm,\n ecomRecommendationsV1Recommendation_universal_d_ListAvailableAlgorithmsRequest as ListAvailableAlgorithmsRequest,\n ecomRecommendationsV1Recommendation_universal_d_ListAvailableAlgorithmsResponse as ListAvailableAlgorithmsResponse,\n ecomRecommendationsV1Recommendation_universal_d_AlgorithmInfo as AlgorithmInfo,\n ecomRecommendationsV1Recommendation_universal_d_AlgorithmConfig as AlgorithmConfig,\n ecomRecommendationsV1Recommendation_universal_d_AlgorithmType as AlgorithmType,\n ecomRecommendationsV1Recommendation_universal_d_GetRecommendationRequest as GetRecommendationRequest,\n ecomRecommendationsV1Recommendation_universal_d_GetRecommendationResponse as GetRecommendationResponse,\n ecomRecommendationsV1Recommendation_universal_d_ItemAppIdNotSupportedByProvider as ItemAppIdNotSupportedByProvider,\n ecomRecommendationsV1Recommendation_universal_d_RecommendationAlgorithmNotSupported as RecommendationAlgorithmNotSupported,\n ecomRecommendationsV1Recommendation_universal_d_listAvailableAlgorithms as listAvailableAlgorithms,\n ecomRecommendationsV1Recommendation_universal_d_getRecommendation as getRecommendation,\n ecomRecommendationsV1Recommendation_universal_d_GetRecommendationOptions as GetRecommendationOptions,\n };\n }\n \n /**\n * A SubscriptionContract is a ...\n * You can ...\n * Read more about SubscriptionContracts\n * in this [article]().\n */\n interface SubscriptionContract {\n /**\n * SubscriptionContract ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the SubscriptionContract is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.\n *\n * Ignored when creating a SubscriptionOrderContract.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the subscription contract 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 subscription contract 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 /**\n * Corresponding billing subscription id\n * @internal\n */\n billingSubscriptionId?: string | null;\n /** Subscription option description. For example, `\"1kg of selected coffee, once a month\"`. */\n description?: string | null;\n /** Subscription detailed information. */\n subscriptionSettings?: V1SubscriptionSettings$1;\n /**\n * Order line items.\n * @readonly\n */\n lineItems?: OrderLineItem$2[];\n /** Buyer information. */\n buyerInfo?: BuyerInfo$9;\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$9;\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 /**\n * Whether tax is included in line item prices.\n *\n * Default: `false`\n */\n taxIncludedInPrices?: boolean;\n /**\n * Order price summary.\n * @readonly\n */\n priceSummary?: PriceSummary$7;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact$6;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: ShippingInformation$5;\n /**\n * Tax information.\n * @internal\n */\n taxInfo?: OrderTaxInfo$2;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$7[];\n /** Information about the sales channel that submitted this order. */\n channelInfo?: ChannelInfo$4;\n /** Custom fields. */\n customFields?: CustomField$5[];\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$6;\n /**\n * Custom field data for the subscription contract object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$b;\n /** Subscription option title. For example, `\"Monthly coffee Subscription\"`. */\n title?: string | null;\n }\n interface V1SubscriptionSettings$1 {\n /** Frequency of recurring payment. */\n frequency?: V1SubscriptionFrequency;\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 /** Whether to allow the customer to cancel the subscription. */\n enableCustomerCancellation?: boolean;\n }\n enum V1SubscriptionFrequency {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface OrderLineItem$2 {\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$6;\n /**\n * References to the line item's origin catalog.\n * This field may be empty in the case of a custom line item.\n */\n catalogReference?: CatalogReference$a;\n /** Line item quantity. */\n quantity?: number;\n /**\n * Total discount for this line item's entire quantity.\n * @readonly\n */\n totalDiscount?: Price$5;\n /** Line item description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine$6[];\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$8;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$7;\n /**\n * Fulfiller ID. Field is empty when the line item is self-fulfilled.\n * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).\n */\n fulfillerId?: string | null;\n /** Number of items that were refunded. */\n refundQuantity?: number | null;\n /** Number of items restocked. */\n restockQuantity?: number | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$5;\n /**\n * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: Price$5;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$5;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$5;\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$4;\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$7;\n /** Represents all the relevant tax details for a specific line item. */\n taxInfo?: LineItemTaxInfo$2;\n /** Digital file identifier, relevant only for items with type DIGITAL. */\n digitalFile?: DigitalFile$3;\n /** Subscription info. */\n subscriptionInfo?: SubscriptionInfo$3;\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$6;\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$5;\n /**\n * The Item's Delivery Profile Id\n * @internal\n */\n deliveryProfileId?: string | null;\n /** @internal */\n shippingGroupId?: string | null;\n /**\n * Source locations for this line item. The location's total quantity must not exceed the line item quantity.\n * @internal\n */\n locations?: LocationAndQuantity$2[];\n /**\n * Total price **after** catalog discounts and line item discounts.\n * @internal\n */\n lineItemPrice?: Price$5;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @internal\n * @readonly\n */\n customLineItem?: boolean | null;\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 * @internal\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Address used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$7;\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: boolean;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$b;\n }\n interface ProductName$6 {\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$a {\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 [app dashboard](https://dev.wix.com/dc3/my-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 Price$5 {\n /** Amount. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n }\n interface DescriptionLine$6 extends DescriptionLineValueOneOf$6, DescriptionLineDescriptionLineValueOneOf$6 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$6;\n /** Description line color value. */\n colorInfo?: Color$6;\n /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$6;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName$6;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType$6;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf$6 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$6;\n /** Description line color value. */\n colorInfo?: Color$6;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf$6 {\n /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$6;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n }\n interface DescriptionLineName$6 {\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$6 {\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$6 {\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$6 {\n /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\n }\n interface FocalPoint$7 {\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 PhysicalProperties$8 {\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$7 extends ItemTypeItemTypeDataOneOf$7 {\n /** Preset item type. */\n preset?: ItemTypeItemType$7;\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$7 {\n /** Preset item type. */\n preset?: ItemTypeItemType$7;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$7 {\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$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 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 checkout. The 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$7 {\n /** Taxable amount of this line item. */\n taxableAmount?: Price$5;\n /**\n * ID of the item's tax group, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$5;\n }\n interface LineItemTaxInfo$2 {\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n taxAmount?: Price$5;\n /** Amount for which tax is calculated. */\n taxableAmount?: Price$5;\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$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 LineItemTaxBreakdown$2 {\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$5;\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$7;\n /** Non-taxable amount of the line item price. */\n nonTaxableAmount?: Price$5;\n /** Taxable amount of the line item price. */\n taxableAmount?: Price$5;\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$7 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface DigitalFile$3 {\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 | null;\n }\n interface SubscriptionInfo$3 {\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$8;\n }\n interface SubscriptionSettings$8 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$8;\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 * Whether to allow the customer to cancel the subscription.\n * @internal\n */\n enableCustomerCancellation?: boolean;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$8 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface PriceDescription$6 {\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$2 {\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 interface TaxableAddress$7 extends TaxableAddressTaxableAddressDataOneOf$7 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$7;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$7 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$7;\n }\n enum TaxableAddressType$7 {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n interface ExtendedFields$b {\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 /** Buyer Info */\n interface BuyerInfo$9 extends BuyerInfoIdOneOf$6 {\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://dev.wix.com/api/rest/contacts/contacts/introduction). */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf$6 {\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 WeightUnit$9 {\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$7 {\n /** Subtotal of all the line items, before discounts and before tax. */\n subtotal?: Price$5;\n /** Total shipping price, before discounts and before tax. */\n shipping?: Price$5;\n /** Total tax on this order. */\n tax?: Price$5;\n /** Total calculated discount value. */\n discount?: Price$5;\n /**\n * Deprecated - use `total` instead.\n * @internal\n * @deprecated\n */\n totalPrice?: Price$5;\n /** Order’s total price after discounts and tax. */\n total?: Price$5;\n /**\n * Order's total price including gift card.\n * @internal\n * @deprecated\n */\n totalWithGiftCard?: Price$5;\n /**\n * Order's total price after without gift card.\n * @internal\n * @deprecated\n */\n totalWithoutGiftCard?: Price$5;\n /** Total price of additional fees before tax. */\n totalAdditionalFees?: Price$5;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$6 {\n /** Address. */\n address?: Address$b;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$8;\n }\n /** Physical address */\n interface Address$b {\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$a;\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 /** @internal */\n location?: AddressLocation$a;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$a {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$a {\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$8 {\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$9;\n }\n interface VatId$9 {\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$9;\n }\n /** tax info types */\n enum VatType$9 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface ShippingInformation$5 {\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$8;\n /** Shipping costs. */\n cost?: ShippingPrice$7;\n /** Shipping region. */\n region?: ShippingRegion$7;\n }\n interface DeliveryLogistics$8 extends DeliveryLogisticsAddressOneOf$1 {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact$6;\n /** Pickup details. */\n pickupDetails?: PickupDetails$9;\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 | null;\n /** Expected delivery time. */\n deliveryTimeSlot?: DeliveryTimeSlot$8;\n }\n /** @oneof */\n interface DeliveryLogisticsAddressOneOf$1 {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact$6;\n /** Pickup details. */\n pickupDetails?: PickupDetails$9;\n }\n interface PickupDetails$9 {\n /** Pickup address. */\n address?: PickupAddress$4;\n /** Pickup method */\n pickupMethod?: PickupMethod$8;\n }\n /** Physical address */\n interface PickupAddress$4 {\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$a;\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 * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n /** @internal */\n location?: AddressLocation$a;\n }\n enum PickupMethod$8 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$8 {\n /** Delivery slot starting time. */\n from?: Date | null;\n /** Delivery slot ending time. */\n to?: Date | null;\n }\n interface ShippingPrice$7 {\n /** Shipping price for display purposes. */\n price?: Price$5;\n /**\n * Total price of shipping after discounts (when relevant), and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$5;\n /**\n * Shipping price after all discounts (if any exist), and after tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$5;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$7;\n /**\n * Shipping discount before tax.\n * @readonly\n */\n discount?: Price$5;\n }\n interface ShippingRegion$7 {\n /** Name of shipping region. For example, `\"Metropolitan London\"`, or `\"Outer Melbourne suburbs\"`. */\n name?: string | null;\n }\n interface OrderTaxInfo$2 {\n /** Calculated tax, added from line items. */\n totalTax?: Price$5;\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$2[];\n /**\n * Manual tax rate\n * @internal\n * @readonly\n */\n manualTaxRate?: string | null;\n /**\n * Whether the draft order is exempt from tax calculations.\n *\n * Default: `false`\n * @readonly\n */\n taxExempt?: boolean | 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 OrderTaxBreakdown$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 jurisdictionType?: JurisdictionType$7;\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$5;\n /**\n * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: Price$5;\n }\n interface AppliedDiscount$7 extends AppliedDiscountDiscountSourceOneOf$7 {\n /** Applied coupon info. */\n coupon?: Coupon$7;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$7;\n /** Automatic Discount */\n discountRule?: DiscountRule$7;\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$7;\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 * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$7[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$7 {\n /** Applied coupon info. */\n coupon?: Coupon$7;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$7;\n /** Automatic Discount */\n discountRule?: DiscountRule$7;\n }\n enum DiscountType$7 {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface Coupon$7 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon name. */\n name?: string;\n /** Coupon value. */\n amount?: Price$5;\n }\n interface MerchantDiscount$7 extends MerchantDiscountMerchantDiscountReasonOneOf$2 {\n /**\n * Pre-defined discount reason (optional).\n * * `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange.\n */\n discountReason?: DiscountReason$2;\n /** Discount description as free text (optional). */\n description?: string | null;\n /** Discount amount. */\n amount?: Price$5;\n /**\n * Discount percentage.\n * @internal\n */\n percentage?: string | null;\n }\n /** @oneof */\n interface MerchantDiscountMerchantDiscountReasonOneOf$2 {\n /**\n * Pre-defined discount reason (optional).\n * * `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange.\n */\n discountReason?: DiscountReason$2;\n /** Discount description as free text (optional). */\n description?: string | null;\n }\n enum DiscountReason$2 {\n UNSPECIFIED = \"UNSPECIFIED\",\n EXCHANGED_ITEMS = \"EXCHANGED_ITEMS\"\n }\n interface DiscountRule$7 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$7;\n /** Discount value. */\n amount?: Price$5;\n }\n interface DiscountRuleName$7 {\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$7 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Total discount for this line item. */\n totalDiscount?: Price$5;\n }\n interface ChannelInfo$4 {\n /** Sales channel that submitted the order. */\n type?: ChannelType$7;\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$7 {\n /** Unspecified sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CustomField$5 {\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 CreateSubscriptionContractRequest {\n /** SubscriptionContract to be created. */\n subscriptionContract: SubscriptionContract;\n }\n interface CreateSubscriptionContractResponse {\n /** The created SubscriptionContract. */\n subscriptionContract?: SubscriptionContract;\n }\n interface GetSubscriptionContractRequest {\n /** ID of the SubscriptionContract to retrieve. */\n subscriptionContractId: string;\n }\n interface GetSubscriptionContractResponse {\n /** The requested SubscriptionContract. */\n subscriptionContract?: SubscriptionContract;\n }\n interface UpdateSubscriptionContractRequest {\n /** SubscriptionContract to be updated, may be partial. */\n subscriptionContract: SubscriptionContract;\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateSubscriptionContractResponse {\n /** Updated SubscriptionContract. */\n subscriptionContract?: SubscriptionContract;\n }\n interface QuerySubscriptionContractsRequest {\n /** WQL expression. */\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$e;\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 * 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 * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\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$e[];\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$e;\n }\n interface Sorting$e {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$e;\n }\n enum SortOrder$e {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$e {\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 QuerySubscriptionContractsResponse {\n /** List of SubscriptionContracts. */\n subscriptionContracts?: SubscriptionContract[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$b;\n }\n interface CursorPagingMetadata$b {\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$e;\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$e {\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$l extends DomainEventBodyOneOf$l {\n createdEvent?: EntityCreatedEvent$l;\n updatedEvent?: EntityUpdatedEvent$l;\n deletedEvent?: EntityDeletedEvent$l;\n actionEvent?: ActionEvent$l;\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$l {\n createdEvent?: EntityCreatedEvent$l;\n updatedEvent?: EntityUpdatedEvent$l;\n deletedEvent?: EntityDeletedEvent$l;\n actionEvent?: ActionEvent$l;\n }\n interface EntityCreatedEvent$l {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$l;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$l {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$l {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$l {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$l {\n bodyAsJson?: string;\n }\n interface Empty$e {\n }\n interface MessageEnvelope$k {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$l;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$l extends IdentificationDataIdOneOf$l {\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$k;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$l {\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$k {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a SubscriptionContract.\n * @param subscriptionContract - SubscriptionContract to be created.\n * @internal\n * @documentationMaturity preview\n * @requiredField subscriptionContract\n * @requiredField subscriptionContract.billingInfo.contactDetails\n * @requiredField subscriptionContract.billingInfo.contactDetails.firstName\n * @requiredField subscriptionContract.channelInfo\n * @requiredField subscriptionContract.lineItems\n * @requiredField subscriptionContract.lineItems.catalogReference.appId\n * @requiredField subscriptionContract.lineItems.catalogReference.catalogItemId\n * @requiredField subscriptionContract.lineItems.itemType\n * @requiredField subscriptionContract.lineItems.price\n * @requiredField subscriptionContract.lineItems.productName\n * @requiredField subscriptionContract.lineItems.productName.original\n * @requiredField subscriptionContract.lineItems.quantity\n * @requiredField subscriptionContract.priceSummary\n * @requiredField subscriptionContract.subscriptionSettings\n * @requiredField subscriptionContract.subscriptionSettings.interval\n * @permissionId ECOM.SUBSCRIPTION_CONTRACT_CREATE\n * @adminMethod\n * @returns The created SubscriptionContract.\n */\n function createSubscriptionContract(subscriptionContract: SubscriptionContract): Promise;\n /**\n * Retrieves a SubscriptionContract.\n * @param subscriptionContractId - ID of the SubscriptionContract to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField subscriptionContractId\n * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ\n * @adminMethod\n * @returns The requested SubscriptionContract.\n */\n function getSubscriptionContract(subscriptionContractId: string): Promise;\n /**\n * Updates a SubscriptionContract.\n *\n * Each time the SubscriptionContract is updated, `revision` increments by 1.\n * The current `revision` must be passed when updating the SubscriptionContract.\n * This ensures you're working with the latest SubscriptionContract and prevents unintended overwrites.\n *\n * Currently, the following fields can be updated:\n * + `subscriptionContract.billingSubscriptionId`\n * @param _id - SubscriptionContract ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField subscriptionContract\n * @permissionId ECOM.SUBSCRIPTION_CONTRACT_UPDATE\n * @adminMethod\n * @returns Updated SubscriptionContract.\n */\n function updateSubscriptionContract(_id: string | null, subscriptionContract: UpdateSubscriptionContract, options?: UpdateSubscriptionContractOptions): Promise;\n interface UpdateSubscriptionContract {\n /**\n * SubscriptionContract ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the SubscriptionContract is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.\n *\n * Ignored when creating a SubscriptionOrderContract.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the subscription contract 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 subscription contract 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 /**\n * Corresponding billing subscription id\n * @internal\n */\n billingSubscriptionId?: string | null;\n /** Subscription option description. For example, `\"1kg of selected coffee, once a month\"`. */\n description?: string | null;\n /** Subscription detailed information. */\n subscriptionSettings?: V1SubscriptionSettings$1;\n /**\n * Order line items.\n * @readonly\n */\n lineItems?: OrderLineItem$2[];\n /** Buyer information. */\n buyerInfo?: BuyerInfo$9;\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$9;\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 /**\n * Whether tax is included in line item prices.\n *\n * Default: `false`\n */\n taxIncludedInPrices?: boolean;\n /**\n * Order price summary.\n * @readonly\n */\n priceSummary?: PriceSummary$7;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact$6;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: ShippingInformation$5;\n /**\n * Tax information.\n * @internal\n */\n taxInfo?: OrderTaxInfo$2;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$7[];\n /** Information about the sales channel that submitted this order. */\n channelInfo?: ChannelInfo$4;\n /** Custom fields. */\n customFields?: CustomField$5[];\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$6;\n /**\n * Custom field data for the subscription contract object.\n *\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$b;\n /** Subscription option title. For example, `\"Monthly coffee Subscription\"`. */\n title?: string | null;\n }\n interface UpdateSubscriptionContractOptions {\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].\n *\n * Up to 300 SubscriptionContracts can be returned per request.\n *\n * To learn how to query SubscriptionContracts, 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 * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ\n * @adminMethod\n */\n function querySubscriptionContracts(): SubscriptionContractsQueryBuilder;\n interface QueryCursorResult$e {\n cursors: Cursors$e;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface SubscriptionContractsQueryResult extends QueryCursorResult$e {\n items: SubscriptionContract[];\n query: SubscriptionContractsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface SubscriptionContractsQueryBuilder {\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' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;\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' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;\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' | 'buyerInfo.contactId', value: string) => SubscriptionContractsQueryBuilder;\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' | 'buyerInfo.contactId', value: any[]) => SubscriptionContractsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'buyerInfo.contactId', value: any) => SubscriptionContractsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'buyerInfo.contactId', value: boolean) => SubscriptionContractsQueryBuilder;\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' | 'buyerInfo.contactId'>) => SubscriptionContractsQueryBuilder;\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' | 'buyerInfo.contactId'>) => SubscriptionContractsQueryBuilder;\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) => SubscriptionContractsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => SubscriptionContractsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_SubscriptionContract = SubscriptionContract;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_V1SubscriptionFrequency = V1SubscriptionFrequency;\n const ecomSubscriptionContractsV1SubscriptionContract_universal_d_V1SubscriptionFrequency: typeof V1SubscriptionFrequency;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_CreateSubscriptionContractRequest = CreateSubscriptionContractRequest;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_CreateSubscriptionContractResponse = CreateSubscriptionContractResponse;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_GetSubscriptionContractRequest = GetSubscriptionContractRequest;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_GetSubscriptionContractResponse = GetSubscriptionContractResponse;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContractRequest = UpdateSubscriptionContractRequest;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContractResponse = UpdateSubscriptionContractResponse;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_QuerySubscriptionContractsRequest = QuerySubscriptionContractsRequest;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_QuerySubscriptionContractsResponse = QuerySubscriptionContractsResponse;\n const ecomSubscriptionContractsV1SubscriptionContract_universal_d_createSubscriptionContract: typeof createSubscriptionContract;\n const ecomSubscriptionContractsV1SubscriptionContract_universal_d_getSubscriptionContract: typeof getSubscriptionContract;\n const ecomSubscriptionContractsV1SubscriptionContract_universal_d_updateSubscriptionContract: typeof updateSubscriptionContract;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContract = UpdateSubscriptionContract;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContractOptions = UpdateSubscriptionContractOptions;\n const ecomSubscriptionContractsV1SubscriptionContract_universal_d_querySubscriptionContracts: typeof querySubscriptionContracts;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_SubscriptionContractsQueryResult = SubscriptionContractsQueryResult;\n type ecomSubscriptionContractsV1SubscriptionContract_universal_d_SubscriptionContractsQueryBuilder = SubscriptionContractsQueryBuilder;\n namespace ecomSubscriptionContractsV1SubscriptionContract_universal_d {\n export {\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_SubscriptionContract as SubscriptionContract,\n V1SubscriptionSettings$1 as V1SubscriptionSettings,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_V1SubscriptionFrequency as V1SubscriptionFrequency,\n OrderLineItem$2 as OrderLineItem,\n ProductName$6 as ProductName,\n CatalogReference$a as CatalogReference,\n Price$5 as Price,\n DescriptionLine$6 as DescriptionLine,\n DescriptionLineValueOneOf$6 as DescriptionLineValueOneOf,\n DescriptionLineDescriptionLineValueOneOf$6 as DescriptionLineDescriptionLineValueOneOf,\n DescriptionLineName$6 as DescriptionLineName,\n PlainTextValue$6 as PlainTextValue,\n Color$6 as Color,\n DescriptionLineType$6 as DescriptionLineType,\n FocalPoint$7 as FocalPoint,\n PhysicalProperties$8 as PhysicalProperties,\n ItemType$7 as ItemType,\n ItemTypeItemTypeDataOneOf$7 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$7 as ItemTypeItemType,\n PaymentOptionType$4 as PaymentOptionType,\n ItemTaxFullDetails$7 as ItemTaxFullDetails,\n LineItemTaxInfo$2 as LineItemTaxInfo,\n LineItemTaxBreakdown$2 as LineItemTaxBreakdown,\n JurisdictionType$7 as JurisdictionType,\n DigitalFile$3 as DigitalFile,\n SubscriptionInfo$3 as SubscriptionInfo,\n SubscriptionSettings$8 as SubscriptionSettings,\n SubscriptionFrequency$8 as SubscriptionFrequency,\n PriceDescription$6 as PriceDescription,\n LocationAndQuantity$2 as LocationAndQuantity,\n TaxableAddress$7 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$7 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$7 as TaxableAddressType,\n ExtendedFields$b as ExtendedFields,\n BuyerInfo$9 as BuyerInfo,\n BuyerInfoIdOneOf$6 as BuyerInfoIdOneOf,\n WeightUnit$9 as WeightUnit,\n PriceSummary$7 as PriceSummary,\n AddressWithContact$6 as AddressWithContact,\n Address$b as Address,\n StreetAddress$a as StreetAddress,\n AddressLocation$a as AddressLocation,\n FullAddressContactDetails$8 as FullAddressContactDetails,\n VatId$9 as VatId,\n VatType$9 as VatType,\n ShippingInformation$5 as ShippingInformation,\n DeliveryLogistics$8 as DeliveryLogistics,\n DeliveryLogisticsAddressOneOf$1 as DeliveryLogisticsAddressOneOf,\n PickupDetails$9 as PickupDetails,\n PickupAddress$4 as PickupAddress,\n PickupMethod$8 as PickupMethod,\n DeliveryTimeSlot$8 as DeliveryTimeSlot,\n ShippingPrice$7 as ShippingPrice,\n ShippingRegion$7 as ShippingRegion,\n OrderTaxInfo$2 as OrderTaxInfo,\n OrderTaxBreakdown$2 as OrderTaxBreakdown,\n AppliedDiscount$7 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$7 as AppliedDiscountDiscountSourceOneOf,\n DiscountType$7 as DiscountType,\n Coupon$7 as Coupon,\n MerchantDiscount$7 as MerchantDiscount,\n MerchantDiscountMerchantDiscountReasonOneOf$2 as MerchantDiscountMerchantDiscountReasonOneOf,\n DiscountReason$2 as DiscountReason,\n DiscountRule$7 as DiscountRule,\n DiscountRuleName$7 as DiscountRuleName,\n LineItemDiscount$7 as LineItemDiscount,\n ChannelInfo$4 as ChannelInfo,\n ChannelType$7 as ChannelType,\n CustomField$5 as CustomField,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_CreateSubscriptionContractRequest as CreateSubscriptionContractRequest,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_CreateSubscriptionContractResponse as CreateSubscriptionContractResponse,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_GetSubscriptionContractRequest as GetSubscriptionContractRequest,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_GetSubscriptionContractResponse as GetSubscriptionContractResponse,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContractRequest as UpdateSubscriptionContractRequest,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContractResponse as UpdateSubscriptionContractResponse,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_QuerySubscriptionContractsRequest as QuerySubscriptionContractsRequest,\n CursorQuery$8 as CursorQuery,\n CursorQueryPagingMethodOneOf$8 as CursorQueryPagingMethodOneOf,\n Sorting$e as Sorting,\n SortOrder$e as SortOrder,\n CursorPaging$e as CursorPaging,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_QuerySubscriptionContractsResponse as QuerySubscriptionContractsResponse,\n CursorPagingMetadata$b as CursorPagingMetadata,\n Cursors$e as Cursors,\n DomainEvent$l as DomainEvent,\n DomainEventBodyOneOf$l as DomainEventBodyOneOf,\n EntityCreatedEvent$l as EntityCreatedEvent,\n RestoreInfo$l as RestoreInfo,\n EntityUpdatedEvent$l as EntityUpdatedEvent,\n EntityDeletedEvent$l as EntityDeletedEvent,\n ActionEvent$l as ActionEvent,\n Empty$e as Empty,\n MessageEnvelope$k as MessageEnvelope,\n IdentificationData$l as IdentificationData,\n IdentificationDataIdOneOf$l as IdentificationDataIdOneOf,\n WebhookIdentityType$k as WebhookIdentityType,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_createSubscriptionContract as createSubscriptionContract,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_getSubscriptionContract as getSubscriptionContract,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_updateSubscriptionContract as updateSubscriptionContract,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContract as UpdateSubscriptionContract,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_UpdateSubscriptionContractOptions as UpdateSubscriptionContractOptions,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_querySubscriptionContracts as querySubscriptionContracts,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_SubscriptionContractsQueryResult as SubscriptionContractsQueryResult,\n ecomSubscriptionContractsV1SubscriptionContract_universal_d_SubscriptionContractsQueryBuilder as SubscriptionContractsQueryBuilder,\n };\n }\n \n interface AbandonedCheckout {\n /** Abandoned checkout ID. */\n _id?: string;\n /** Date and time the abandoned checkout was created. */\n _createdDate?: Date | null;\n /** Date and time the abandoned checkout was updated. */\n _updatedDate?: Date | null;\n /** The associated checkout ID. */\n checkoutId?: string | null;\n /** The associated cart ID. */\n cartId?: string | null;\n /** Status of the abandoned checkout. */\n status?: Status$4;\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 /** Buyer information. */\n buyerInfo?: V1BuyerInfo$1;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$7;\n /** The store's currency. */\n currency?: string;\n /** Currency the buyer used in checkout. */\n conversionCurrency?: string | null;\n /** Total price after discounts, gift cards, and tax. */\n totalPrice?: MultiCurrencyPrice$5;\n /**\n * List of all automation activities performed by [Wix Automations](https://support.wix.com/en/article/wix-automations-getting-started) regarding the abandoned checkout.\n * Wix Automations updates the `activities` field for each actvity in the automation flow. Only relevant if you've set up [automations in the Dashboard](https://support.wix.com/en/article/wix-automations-creating-a-new-automation). Read more about `activities` in the [introduction](https://www.wix.com/velo/reference/wix-ecom-backend/abandonedcheckout/introduction).\n */\n activities?: Activity$3[];\n /** Date and time the abandoned checkout was recovered. */\n checkoutRecoveredDate?: Date | null;\n /** Checkout URL. */\n checkoutUrl?: string;\n /** Subtotal price of all line items, before discounts and before tax. */\n subtotalPrice?: MultiCurrencyPrice$5;\n }\n enum ActivityType$3 {\n /** Not implemented. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /** Scheduled. */\n SCHEDULED = \"SCHEDULED\",\n /** Email sent. */\n EMAIL_SENT = \"EMAIL_SENT\",\n /** Email not sent. */\n EMAIL_NOT_SENT = \"EMAIL_NOT_SENT\",\n /** Notification sent. */\n NOTIFICATION_SENT = \"NOTIFICATION_SENT\",\n /** Task created. */\n TASK_CREATED = \"TASK_CREATED\"\n }\n /** Status of the abandoned checkout. */\n enum Status$4 {\n /** Abandoned. */\n ABANDONED = \"ABANDONED\",\n /** Recovered. */\n RECOVERED = \"RECOVERED\"\n }\n /** Buyer information. */\n interface V1BuyerInfo$1 extends V1BuyerInfoIdOneOf {\n /** Visitor ID (if the site visitor is **not** a site member). */\n visitorId?: string;\n /** Member ID (if the site visitor is a site member). */\n memberId?: string;\n /** User ID (if the site visitor is a site owner or collaborator). */\n userId?: string;\n /**\n * Contact ID. For more information, see the [Contacts API](https://www.wix.com/velo/reference/wix-crm-v2/contacts).\n * @readonly\n */\n contactId?: string | null;\n /**\n * Buyer email address.\n * Max: `50`\n */\n email?: string | null;\n }\n /** @oneof */\n interface V1BuyerInfoIdOneOf {\n /** Visitor ID (if the site visitor is **not** a site member). */\n visitorId?: string;\n /** Member ID (if the site visitor is a site member). */\n memberId?: string;\n /** User ID (if the site visitor is a site owner or collaborator). */\n userId?: string;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails$7 {\n /**\n * First name.\n * Max length: `100`\n */\n firstName?: string | null;\n /**\n * Last name.\n * Max length: `100`\n */\n lastName?: string | null;\n /** Phone number. */\n phone?: string | null;\n /**\n * Company name.\n * Max length: `50`\n */\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$8;\n }\n interface VatId$8 {\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$8;\n }\n /** tax info types */\n enum VatType$8 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface MultiCurrencyPrice$5 {\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 Activity$3 {\n /** Date and time the automation activity was created. */\n _createdDate?: Date | null;\n /**\n * Automation activity type.\n *\n * Supported properties: `UNKNOWN_TYPE`, `SCHEDULED`, `EMAIL_SENT`, `EMAIL_NOT_SENT`, `NOTIFICATION_SENT`, `TASK_CREATED`\n */\n type?: ActivityType$3;\n }\n interface CartAbandonedEvent {\n cartId?: string;\n /**\n * Time the cart was created\n * @readonly\n */\n creationTime?: Date | null;\n /**\n * Time the cart was abandoned\n * @readonly\n */\n abandonTime?: Date | null;\n /** Buyer information */\n buyerInfo?: BuyerInfo$8;\n /** Amount of items in cart */\n itemsCount?: number;\n /** Coupon ID (if relevant) */\n couponId?: string;\n /** Subtotal of all line items in cart, not before shipping and taxes */\n totals?: Totals$2;\n /** Checkout URL - checkout with the abandoned cart details */\n checkoutUrl?: string;\n /**\n * checkout id for buy now flow\n * @internal\n * @readonly\n */\n checkoutId?: string | null;\n }\n interface BuyerInfo$8 {\n /** Wix customer ID */\n _id?: string;\n /** Customer information */\n identityType?: Identity;\n /** Customer's email address */\n email?: string | null;\n /** Customer's phone number */\n phone?: string | null;\n /** Customer's first name */\n firstName?: string | null;\n /** Customer's last name */\n lastName?: string | null;\n }\n enum Identity {\n /** Customer is the site owner */\n ADMIN = \"ADMIN\",\n /** Customer is logged in */\n MEMBER = \"MEMBER\",\n /** Customer is not logged in */\n VISITOR = \"VISITOR\",\n /** Contact was created for the customer */\n CONTACT = \"CONTACT\"\n }\n interface Totals$2 {\n /** Subtotal of all line items in cart, without shipping and taxes */\n subtotal?: number | null;\n /** Total cart price */\n total?: number | null;\n /** Formatted total cart price includes currency symbol */\n formattedTotal?: string;\n }\n interface CartRecoveredEvent {\n cartId?: string;\n /**\n * Time the cart was recovered\n * @readonly\n */\n recoveredTime?: Date | null;\n /**\n * Time the cart was created\n * @readonly\n */\n creationTime?: Date | null;\n /**\n * Time the cart was abandoned\n * @readonly\n */\n abandonedTime?: Date | null;\n /**\n * Checkout id\n * @internal\n * @readonly\n */\n checkoutId?: string | null;\n }\n interface GetAbandonedCheckoutRequest {\n /** Abandoned checkout ID. */\n abandonedCheckoutId: string;\n }\n interface GetAbandonedCheckoutResponse {\n /** The requested abandoned checkout. */\n abandonedCheckout?: AbandonedCheckout;\n }\n interface DeleteAbandonedCheckoutRequest {\n /** Id of the abandoned checkout to delete */\n abandonedCheckoutId: string;\n }\n interface DeleteAbandonedCheckoutResponse {\n }\n interface QueryAbandonedCheckoutsRequest {\n /** Query options. */\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$d;\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$d[];\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$d;\n }\n interface Sorting$d {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$d;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$d {\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$d {\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 QueryAbandonedCheckoutsResponse {\n /**\n * __Deprecated.__ Use `abandonedCheckouts` instead.\n * @deprecated\n */\n results?: AbandonedCheckout[];\n /** List of abandoned checkouts. */\n abandonedCheckouts?: AbandonedCheckout[];\n /** Details on the paged set of results returned. */\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$d;\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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$d {\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 SearchAbandonedCheckoutsRequest {\n /** WQL query expression. */\n search?: Search;\n }\n interface Search extends SearchPagingMethodOneOf {\n /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */\n paging?: CommonPaging;\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?: CommonCursorPaging;\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?: CommonSorting[];\n /** free text to match in searchable fields */\n search?: SearchDetails;\n }\n /** @oneof */\n interface SearchPagingMethodOneOf {\n /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */\n paging?: CommonPaging;\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?: CommonCursorPaging;\n }\n interface CommonSorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: CommonSortOrder;\n }\n enum CommonSortOrder {\n /** Ascending order. */\n ASC = \"ASC\",\n /** Descending order. */\n DESC = \"DESC\"\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 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 CommonCursorPaging {\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 SearchAbandonedCheckoutsResponse {\n /** List of abandoned checkouts. */\n abandonedCheckouts?: AbandonedCheckout[];\n /** Paging metadata. Contains cursor which can be used in next query. */\n pagingMetadata?: CommonPagingMetadataV2;\n }\n interface CommonPagingMetadataV2 {\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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 AddAbandonedCheckoutActivityRequest {\n /** Id of the abandoned checkout to update */\n abandonedCheckoutId: string | null;\n /** The type of the activity to add */\n activityType?: ActivityType$3;\n }\n interface AddAbandonedCheckoutActivityResponse {\n /** The updated abandoned checkout with the added activity */\n abandonedCheckout?: AbandonedCheckout;\n }\n interface Task$1 {\n key?: TaskKey$1;\n executeAt?: Date | null;\n payload?: string | null;\n }\n interface TaskKey$1 {\n appId?: string;\n instanceId?: string;\n subjectId?: string | null;\n }\n interface TaskAction$1 extends TaskActionActionOneOf$1 {\n complete?: Complete$1;\n cancel?: Cancel$1;\n reschedule?: Reschedule$1;\n }\n /** @oneof */\n interface TaskActionActionOneOf$1 {\n complete?: Complete$1;\n cancel?: Cancel$1;\n reschedule?: Reschedule$1;\n }\n interface Complete$1 {\n }\n interface Cancel$1 {\n }\n interface Reschedule$1 {\n executeAt?: Date | null;\n payload?: string | null;\n }\n interface RedirectToCheckoutRequest {\n /** abandoned checkout id */\n abandonedCheckoutId: string;\n /** Identifier of the metaSite this checkout uses */\n metasiteId: string;\n }\n interface RawHttpResponse$1 {\n body?: Uint8Array;\n statusCode?: number | null;\n headers?: HeadersEntry$1[];\n }\n interface HeadersEntry$1 {\n key?: string;\n value?: string;\n }\n interface DomainEvent$k extends DomainEventBodyOneOf$k {\n createdEvent?: EntityCreatedEvent$k;\n updatedEvent?: EntityUpdatedEvent$k;\n deletedEvent?: EntityDeletedEvent$k;\n actionEvent?: ActionEvent$k;\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$k {\n createdEvent?: EntityCreatedEvent$k;\n updatedEvent?: EntityUpdatedEvent$k;\n deletedEvent?: EntityDeletedEvent$k;\n actionEvent?: ActionEvent$k;\n }\n interface EntityCreatedEvent$k {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$k;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$k {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$k {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$k {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$k {\n bodyAsJson?: string;\n }\n interface Empty$d {\n }\n /** Triggered when an abandoned checkout is recovered (the customer completes the checkout). */\n interface AbandonedCheckoutRecovered {\n abandonedCheckout?: AbandonedCheckout;\n }\n interface MessageEnvelope$j {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$k;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$k extends IdentificationDataIdOneOf$k {\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$j;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$k {\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$j {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves an abandoned checkout.\n * @param abandonedCheckoutId - Abandoned checkout ID.\n * @public\n * @documentationMaturity preview\n * @requiredField abandonedCheckoutId\n * @permissionId ECOM.ABANDONED_CHECKOUT_READ\n * @adminMethod\n * @returns The requested abandoned checkout.\n */\n function getAbandonedCheckout(abandonedCheckoutId: string): Promise;\n /**\n * Delete an AbandonedCheckout\n * @param abandonedCheckoutId - Id of the abandoned checkout to delete\n * @public\n * @documentationMaturity preview\n * @requiredField abandonedCheckoutId\n * @permissionId ECOM.ABANDONED_CHECKOUT_DELETE\n * @adminMethod\n */\n function deleteAbandonedCheckout(abandonedCheckoutId: string): Promise;\n /**\n * Creates a query to retrieve a list of abandoned checkouts.\n *\n * The `queryAbandonedCheckouts()` function builds a query to retrieve a list of abandoned checkouts and returns a `ResultsQueryBuilder` 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 `ResultsQueryBuilder` functions onto the query. `ResultsQueryBuilder` functions enable you to sort, filter, and control the results `queryAbandonedCheckouts()` returns.\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.ABANDONED_CHECKOUT_READ\n * @adminMethod\n */\n function queryAbandonedCheckouts(): AbandonedCheckoutsQueryBuilder;\n interface QueryCursorResult$d {\n cursors: CommonCursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface AbandonedCheckoutsQueryResult extends QueryCursorResult$d {\n items: AbandonedCheckout[];\n query: AbandonedCheckoutsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface AbandonedCheckoutsQueryBuilder {\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' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any) => AbandonedCheckoutsQueryBuilder;\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' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any) => AbandonedCheckoutsQueryBuilder;\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) => AbandonedCheckoutsQueryBuilder;\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) => AbandonedCheckoutsQueryBuilder;\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) => AbandonedCheckoutsQueryBuilder;\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) => AbandonedCheckoutsQueryBuilder;\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' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: string) => AbandonedCheckoutsQueryBuilder;\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' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any[]) => AbandonedCheckoutsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: any) => AbandonedCheckoutsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email', value: boolean) => AbandonedCheckoutsQueryBuilder;\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' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email'>) => AbandonedCheckoutsQueryBuilder;\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' | 'status' | 'buyerInfo.visitorId' | 'buyerInfo.memberId' | 'buyerInfo.userId' | 'buyerInfo.contactId' | 'buyerInfo.email'>) => AbandonedCheckoutsQueryBuilder;\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) => AbandonedCheckoutsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => AbandonedCheckoutsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves a list of abandoned checkouts, given the provided paging, filtering, searchDetails and sorting. Up to 100 abandoned checkouts can be returned per request.\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.ABANDONED_CHECKOUT_READ\n * @adminMethod\n */\n function searchAbandonedCheckouts(options?: SearchAbandonedCheckoutsOptions): Promise;\n interface SearchAbandonedCheckoutsOptions {\n /** WQL query expression. */\n search?: Search;\n }\n /**\n * Adds a new AbandonedCheckout activity\n * @param abandonedCheckoutId - Id of the abandoned checkout to update\n * @internal\n * @documentationMaturity preview\n * @requiredField abandonedCheckoutId\n * @permissionId ECOM.ABANDONED_CHECKOUT_UPDATE\n * @adminMethod\n */\n function addAbandonedCheckoutActivity(abandonedCheckoutId: string | null, options?: AddAbandonedCheckoutActivityOptions): Promise;\n interface AddAbandonedCheckoutActivityOptions {\n /** The type of the activity to add */\n activityType?: ActivityType$3;\n }\n /**\n * Redirects the abandoned checkout to the checkout page.\n * @param abandonedCheckoutId - abandoned checkout id\n * @param metasiteId - Identifier of the metaSite this checkout uses\n * @public\n * @documentationMaturity preview\n * @requiredField abandonedCheckoutId\n * @requiredField metasiteId\n * @adminMethod\n */\n function redirectToCheckout(abandonedCheckoutId: string, metasiteId: string): Promise;\n \n type ecomV1AbandonedCheckout_universal_d_AbandonedCheckout = AbandonedCheckout;\n type ecomV1AbandonedCheckout_universal_d_V1BuyerInfoIdOneOf = V1BuyerInfoIdOneOf;\n type ecomV1AbandonedCheckout_universal_d_CartAbandonedEvent = CartAbandonedEvent;\n type ecomV1AbandonedCheckout_universal_d_Identity = Identity;\n const ecomV1AbandonedCheckout_universal_d_Identity: typeof Identity;\n type ecomV1AbandonedCheckout_universal_d_CartRecoveredEvent = CartRecoveredEvent;\n type ecomV1AbandonedCheckout_universal_d_GetAbandonedCheckoutRequest = GetAbandonedCheckoutRequest;\n type ecomV1AbandonedCheckout_universal_d_GetAbandonedCheckoutResponse = GetAbandonedCheckoutResponse;\n type ecomV1AbandonedCheckout_universal_d_DeleteAbandonedCheckoutRequest = DeleteAbandonedCheckoutRequest;\n type ecomV1AbandonedCheckout_universal_d_DeleteAbandonedCheckoutResponse = DeleteAbandonedCheckoutResponse;\n type ecomV1AbandonedCheckout_universal_d_QueryAbandonedCheckoutsRequest = QueryAbandonedCheckoutsRequest;\n type ecomV1AbandonedCheckout_universal_d_QueryAbandonedCheckoutsResponse = QueryAbandonedCheckoutsResponse;\n type ecomV1AbandonedCheckout_universal_d_SearchAbandonedCheckoutsRequest = SearchAbandonedCheckoutsRequest;\n type ecomV1AbandonedCheckout_universal_d_Search = Search;\n type ecomV1AbandonedCheckout_universal_d_SearchPagingMethodOneOf = SearchPagingMethodOneOf;\n type ecomV1AbandonedCheckout_universal_d_CommonSorting = CommonSorting;\n type ecomV1AbandonedCheckout_universal_d_CommonSortOrder = CommonSortOrder;\n const ecomV1AbandonedCheckout_universal_d_CommonSortOrder: typeof CommonSortOrder;\n type ecomV1AbandonedCheckout_universal_d_SearchDetails = SearchDetails;\n type ecomV1AbandonedCheckout_universal_d_Mode = Mode;\n const ecomV1AbandonedCheckout_universal_d_Mode: typeof Mode;\n type ecomV1AbandonedCheckout_universal_d_CommonPaging = CommonPaging;\n type ecomV1AbandonedCheckout_universal_d_CommonCursorPaging = CommonCursorPaging;\n type ecomV1AbandonedCheckout_universal_d_SearchAbandonedCheckoutsResponse = SearchAbandonedCheckoutsResponse;\n type ecomV1AbandonedCheckout_universal_d_CommonPagingMetadataV2 = CommonPagingMetadataV2;\n type ecomV1AbandonedCheckout_universal_d_CommonCursors = CommonCursors;\n type ecomV1AbandonedCheckout_universal_d_AddAbandonedCheckoutActivityRequest = AddAbandonedCheckoutActivityRequest;\n type ecomV1AbandonedCheckout_universal_d_AddAbandonedCheckoutActivityResponse = AddAbandonedCheckoutActivityResponse;\n type ecomV1AbandonedCheckout_universal_d_RedirectToCheckoutRequest = RedirectToCheckoutRequest;\n type ecomV1AbandonedCheckout_universal_d_AbandonedCheckoutRecovered = AbandonedCheckoutRecovered;\n const ecomV1AbandonedCheckout_universal_d_getAbandonedCheckout: typeof getAbandonedCheckout;\n const ecomV1AbandonedCheckout_universal_d_deleteAbandonedCheckout: typeof deleteAbandonedCheckout;\n const ecomV1AbandonedCheckout_universal_d_queryAbandonedCheckouts: typeof queryAbandonedCheckouts;\n type ecomV1AbandonedCheckout_universal_d_AbandonedCheckoutsQueryResult = AbandonedCheckoutsQueryResult;\n type ecomV1AbandonedCheckout_universal_d_AbandonedCheckoutsQueryBuilder = AbandonedCheckoutsQueryBuilder;\n const ecomV1AbandonedCheckout_universal_d_searchAbandonedCheckouts: typeof searchAbandonedCheckouts;\n type ecomV1AbandonedCheckout_universal_d_SearchAbandonedCheckoutsOptions = SearchAbandonedCheckoutsOptions;\n const ecomV1AbandonedCheckout_universal_d_addAbandonedCheckoutActivity: typeof addAbandonedCheckoutActivity;\n type ecomV1AbandonedCheckout_universal_d_AddAbandonedCheckoutActivityOptions = AddAbandonedCheckoutActivityOptions;\n const ecomV1AbandonedCheckout_universal_d_redirectToCheckout: typeof redirectToCheckout;\n namespace ecomV1AbandonedCheckout_universal_d {\n export {\n ecomV1AbandonedCheckout_universal_d_AbandonedCheckout as AbandonedCheckout,\n ActivityType$3 as ActivityType,\n Status$4 as Status,\n V1BuyerInfo$1 as V1BuyerInfo,\n ecomV1AbandonedCheckout_universal_d_V1BuyerInfoIdOneOf as V1BuyerInfoIdOneOf,\n FullAddressContactDetails$7 as FullAddressContactDetails,\n VatId$8 as VatId,\n VatType$8 as VatType,\n MultiCurrencyPrice$5 as MultiCurrencyPrice,\n Activity$3 as Activity,\n ecomV1AbandonedCheckout_universal_d_CartAbandonedEvent as CartAbandonedEvent,\n BuyerInfo$8 as BuyerInfo,\n ecomV1AbandonedCheckout_universal_d_Identity as Identity,\n Totals$2 as Totals,\n ecomV1AbandonedCheckout_universal_d_CartRecoveredEvent as CartRecoveredEvent,\n ecomV1AbandonedCheckout_universal_d_GetAbandonedCheckoutRequest as GetAbandonedCheckoutRequest,\n ecomV1AbandonedCheckout_universal_d_GetAbandonedCheckoutResponse as GetAbandonedCheckoutResponse,\n ecomV1AbandonedCheckout_universal_d_DeleteAbandonedCheckoutRequest as DeleteAbandonedCheckoutRequest,\n ecomV1AbandonedCheckout_universal_d_DeleteAbandonedCheckoutResponse as DeleteAbandonedCheckoutResponse,\n ecomV1AbandonedCheckout_universal_d_QueryAbandonedCheckoutsRequest as QueryAbandonedCheckoutsRequest,\n QueryV2$3 as QueryV2,\n QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf,\n Sorting$d as Sorting,\n SortOrder$d as SortOrder,\n Paging$3 as Paging,\n CursorPaging$d as CursorPaging,\n ecomV1AbandonedCheckout_universal_d_QueryAbandonedCheckoutsResponse as QueryAbandonedCheckoutsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$d as Cursors,\n ecomV1AbandonedCheckout_universal_d_SearchAbandonedCheckoutsRequest as SearchAbandonedCheckoutsRequest,\n ecomV1AbandonedCheckout_universal_d_Search as Search,\n ecomV1AbandonedCheckout_universal_d_SearchPagingMethodOneOf as SearchPagingMethodOneOf,\n ecomV1AbandonedCheckout_universal_d_CommonSorting as CommonSorting,\n ecomV1AbandonedCheckout_universal_d_CommonSortOrder as CommonSortOrder,\n ecomV1AbandonedCheckout_universal_d_SearchDetails as SearchDetails,\n ecomV1AbandonedCheckout_universal_d_Mode as Mode,\n ecomV1AbandonedCheckout_universal_d_CommonPaging as CommonPaging,\n ecomV1AbandonedCheckout_universal_d_CommonCursorPaging as CommonCursorPaging,\n ecomV1AbandonedCheckout_universal_d_SearchAbandonedCheckoutsResponse as SearchAbandonedCheckoutsResponse,\n ecomV1AbandonedCheckout_universal_d_CommonPagingMetadataV2 as CommonPagingMetadataV2,\n ecomV1AbandonedCheckout_universal_d_CommonCursors as CommonCursors,\n ecomV1AbandonedCheckout_universal_d_AddAbandonedCheckoutActivityRequest as AddAbandonedCheckoutActivityRequest,\n ecomV1AbandonedCheckout_universal_d_AddAbandonedCheckoutActivityResponse as AddAbandonedCheckoutActivityResponse,\n Task$1 as Task,\n TaskKey$1 as TaskKey,\n TaskAction$1 as TaskAction,\n TaskActionActionOneOf$1 as TaskActionActionOneOf,\n Complete$1 as Complete,\n Cancel$1 as Cancel,\n Reschedule$1 as Reschedule,\n ecomV1AbandonedCheckout_universal_d_RedirectToCheckoutRequest as RedirectToCheckoutRequest,\n RawHttpResponse$1 as RawHttpResponse,\n HeadersEntry$1 as HeadersEntry,\n DomainEvent$k as DomainEvent,\n DomainEventBodyOneOf$k as DomainEventBodyOneOf,\n EntityCreatedEvent$k as EntityCreatedEvent,\n RestoreInfo$k as RestoreInfo,\n EntityUpdatedEvent$k as EntityUpdatedEvent,\n EntityDeletedEvent$k as EntityDeletedEvent,\n ActionEvent$k as ActionEvent,\n Empty$d as Empty,\n ecomV1AbandonedCheckout_universal_d_AbandonedCheckoutRecovered as AbandonedCheckoutRecovered,\n MessageEnvelope$j as MessageEnvelope,\n IdentificationData$k as IdentificationData,\n IdentificationDataIdOneOf$k as IdentificationDataIdOneOf,\n WebhookIdentityType$j as WebhookIdentityType,\n ecomV1AbandonedCheckout_universal_d_getAbandonedCheckout as getAbandonedCheckout,\n ecomV1AbandonedCheckout_universal_d_deleteAbandonedCheckout as deleteAbandonedCheckout,\n ecomV1AbandonedCheckout_universal_d_queryAbandonedCheckouts as queryAbandonedCheckouts,\n ecomV1AbandonedCheckout_universal_d_AbandonedCheckoutsQueryResult as AbandonedCheckoutsQueryResult,\n ecomV1AbandonedCheckout_universal_d_AbandonedCheckoutsQueryBuilder as AbandonedCheckoutsQueryBuilder,\n ecomV1AbandonedCheckout_universal_d_searchAbandonedCheckouts as searchAbandonedCheckouts,\n ecomV1AbandonedCheckout_universal_d_SearchAbandonedCheckoutsOptions as SearchAbandonedCheckoutsOptions,\n ecomV1AbandonedCheckout_universal_d_addAbandonedCheckoutActivity as addAbandonedCheckoutActivity,\n ecomV1AbandonedCheckout_universal_d_AddAbandonedCheckoutActivityOptions as AddAbandonedCheckoutActivityOptions,\n ecomV1AbandonedCheckout_universal_d_redirectToCheckout as redirectToCheckout,\n };\n }\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$9;\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$3;\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 | null;\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$9 {\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 [app dashboard](https://dev.wix.com/dc3/my-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$3 {\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 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$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$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$c;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting$c[];\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$c;\n }\n interface Sorting$c {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$c;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$c {\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$c {\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$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$c;\n }\n interface Cursors$c {\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$9[];\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$9;\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$9;\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$j extends DomainEventBodyOneOf$j {\n createdEvent?: EntityCreatedEvent$j;\n updatedEvent?: EntityUpdatedEvent$j;\n deletedEvent?: EntityDeletedEvent$j;\n actionEvent?: ActionEvent$j;\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$j {\n createdEvent?: EntityCreatedEvent$j;\n updatedEvent?: EntityUpdatedEvent$j;\n deletedEvent?: EntityDeletedEvent$j;\n actionEvent?: ActionEvent$j;\n }\n interface EntityCreatedEvent$j {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$j;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$j {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$j {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$j {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$j {\n bodyAsJson?: string;\n }\n interface Empty$c {\n }\n interface MessageEnvelope$i {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$j;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$j extends IdentificationDataIdOneOf$j {\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$i;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$j {\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$i {\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 * @permissionId ECOM.CREATE_BACK_IN_STOCK_NOTIFICATION_REQUESTS\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 * @permissionId ECOM.READ_BACK_IN_STOCK_NOTIFICATION_REQUESTS\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 * @permissionId ECOM.MODIFY_BACK_IN_STOCK_NOTIFICATION_REQUESTS\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 * @permissionId ECOM.MODIFY_BACK_IN_STOCK_NOTIFICATION_REQUESTS\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 * @permissionId ECOM.READ_BACK_IN_STOCK_NOTIFICATION_REQUESTS\n * @adminMethod\n */\n function queryBackInStockNotificationRequests(): RequestsQueryBuilder;\n interface QueryCursorResult$c {\n cursors: Cursors$c;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface RequestsQueryResult extends QueryCursorResult$c {\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 * @permissionId ECOM.READ_BACK_IN_STOCK_NOTIFICATION_REQUESTS\n * @adminMethod\n */\n function getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences: CatalogReference$9[]): 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 * @permissionId ECOM.MODIFY_BACK_IN_STOCK_NOTIFICATION_REQUESTS\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$9;\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 \n type ecomV1BackInStockNotificationRequest_universal_d_BackInStockNotificationRequest = BackInStockNotificationRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_InvalidateCache = InvalidateCache;\n type ecomV1BackInStockNotificationRequest_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type ecomV1BackInStockNotificationRequest_universal_d_Page = Page;\n type ecomV1BackInStockNotificationRequest_universal_d_URI = URI;\n type ecomV1BackInStockNotificationRequest_universal_d_File = File;\n type ecomV1BackInStockNotificationRequest_universal_d_CreateBackInStockNotificationRequestRequest = CreateBackInStockNotificationRequestRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_BackInStockItemDetails = BackInStockItemDetails;\n type ecomV1BackInStockNotificationRequest_universal_d_CreateBackInStockNotificationRequestResponse = CreateBackInStockNotificationRequestResponse;\n type ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestRequest = GetBackInStockNotificationRequestRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestResponse = GetBackInStockNotificationRequestResponse;\n type ecomV1BackInStockNotificationRequest_universal_d_DeleteBackInStockNotificationRequestRequest = DeleteBackInStockNotificationRequestRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_DeleteBackInStockNotificationRequestResponse = DeleteBackInStockNotificationRequestResponse;\n type ecomV1BackInStockNotificationRequest_universal_d_MarkAsNotificationSentRequest = MarkAsNotificationSentRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_MarkAsNotificationSentResponse = MarkAsNotificationSentResponse;\n type ecomV1BackInStockNotificationRequest_universal_d_QueryBackInStockNotificationRequestsRequest = QueryBackInStockNotificationRequestsRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_QueryBackInStockNotificationRequestsResponse = QueryBackInStockNotificationRequestsResponse;\n type ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesRequest = GetBackInStockNotificationRequestsCountByCatalogReferencesRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesResponse = GetBackInStockNotificationRequestsCountByCatalogReferencesResponse;\n type ecomV1BackInStockNotificationRequest_universal_d_BackInStockNotificationRequestsCount = BackInStockNotificationRequestsCount;\n type ecomV1BackInStockNotificationRequest_universal_d_ReportItemsBackInStockRequest = ReportItemsBackInStockRequest;\n type ecomV1BackInStockNotificationRequest_universal_d_ReportItemsBackInStockResponse = ReportItemsBackInStockResponse;\n const ecomV1BackInStockNotificationRequest_universal_d_createBackInStockNotificationRequest: typeof createBackInStockNotificationRequest;\n const ecomV1BackInStockNotificationRequest_universal_d_getBackInStockNotificationRequest: typeof getBackInStockNotificationRequest;\n const ecomV1BackInStockNotificationRequest_universal_d_deleteBackInStockNotificationRequest: typeof deleteBackInStockNotificationRequest;\n const ecomV1BackInStockNotificationRequest_universal_d_markAsNotificationSent: typeof markAsNotificationSent;\n const ecomV1BackInStockNotificationRequest_universal_d_queryBackInStockNotificationRequests: typeof queryBackInStockNotificationRequests;\n type ecomV1BackInStockNotificationRequest_universal_d_RequestsQueryResult = RequestsQueryResult;\n type ecomV1BackInStockNotificationRequest_universal_d_RequestsQueryBuilder = RequestsQueryBuilder;\n const ecomV1BackInStockNotificationRequest_universal_d_getBackInStockNotificationRequestsCountByCatalogReferences: typeof getBackInStockNotificationRequestsCountByCatalogReferences;\n const ecomV1BackInStockNotificationRequest_universal_d_reportItemsBackInStock: typeof reportItemsBackInStock;\n type ecomV1BackInStockNotificationRequest_universal_d_ReportItemsBackInStockOptions = ReportItemsBackInStockOptions;\n namespace ecomV1BackInStockNotificationRequest_universal_d {\n export {\n ecomV1BackInStockNotificationRequest_universal_d_BackInStockNotificationRequest as BackInStockNotificationRequest,\n CatalogReference$9 as CatalogReference,\n Status$3 as Status,\n ecomV1BackInStockNotificationRequest_universal_d_InvalidateCache as InvalidateCache,\n ecomV1BackInStockNotificationRequest_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n App$1 as App,\n ecomV1BackInStockNotificationRequest_universal_d_Page as Page,\n ecomV1BackInStockNotificationRequest_universal_d_URI as URI,\n ecomV1BackInStockNotificationRequest_universal_d_File as File,\n ecomV1BackInStockNotificationRequest_universal_d_CreateBackInStockNotificationRequestRequest as CreateBackInStockNotificationRequestRequest,\n ecomV1BackInStockNotificationRequest_universal_d_BackInStockItemDetails as BackInStockItemDetails,\n ecomV1BackInStockNotificationRequest_universal_d_CreateBackInStockNotificationRequestResponse as CreateBackInStockNotificationRequestResponse,\n ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestRequest as GetBackInStockNotificationRequestRequest,\n ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestResponse as GetBackInStockNotificationRequestResponse,\n ecomV1BackInStockNotificationRequest_universal_d_DeleteBackInStockNotificationRequestRequest as DeleteBackInStockNotificationRequestRequest,\n ecomV1BackInStockNotificationRequest_universal_d_DeleteBackInStockNotificationRequestResponse as DeleteBackInStockNotificationRequestResponse,\n ecomV1BackInStockNotificationRequest_universal_d_MarkAsNotificationSentRequest as MarkAsNotificationSentRequest,\n ecomV1BackInStockNotificationRequest_universal_d_MarkAsNotificationSentResponse as MarkAsNotificationSentResponse,\n ecomV1BackInStockNotificationRequest_universal_d_QueryBackInStockNotificationRequestsRequest as QueryBackInStockNotificationRequestsRequest,\n PlatformQuery$1 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf,\n Sorting$c as Sorting,\n SortOrder$c as SortOrder,\n PlatformPaging$1 as PlatformPaging,\n CursorPaging$c as CursorPaging,\n ecomV1BackInStockNotificationRequest_universal_d_QueryBackInStockNotificationRequestsResponse as QueryBackInStockNotificationRequestsResponse,\n PlatformPagingMetadata$1 as PlatformPagingMetadata,\n Cursors$c as Cursors,\n ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesRequest as GetBackInStockNotificationRequestsCountByCatalogReferencesRequest,\n ecomV1BackInStockNotificationRequest_universal_d_GetBackInStockNotificationRequestsCountByCatalogReferencesResponse as GetBackInStockNotificationRequestsCountByCatalogReferencesResponse,\n ecomV1BackInStockNotificationRequest_universal_d_BackInStockNotificationRequestsCount as BackInStockNotificationRequestsCount,\n ecomV1BackInStockNotificationRequest_universal_d_ReportItemsBackInStockRequest as ReportItemsBackInStockRequest,\n ecomV1BackInStockNotificationRequest_universal_d_ReportItemsBackInStockResponse as ReportItemsBackInStockResponse,\n DomainEvent$j as DomainEvent,\n DomainEventBodyOneOf$j as DomainEventBodyOneOf,\n EntityCreatedEvent$j as EntityCreatedEvent,\n RestoreInfo$j as RestoreInfo,\n EntityUpdatedEvent$j as EntityUpdatedEvent,\n EntityDeletedEvent$j as EntityDeletedEvent,\n ActionEvent$j as ActionEvent,\n Empty$c as Empty,\n MessageEnvelope$i as MessageEnvelope,\n IdentificationData$j as IdentificationData,\n IdentificationDataIdOneOf$j as IdentificationDataIdOneOf,\n WebhookIdentityType$i as WebhookIdentityType,\n ecomV1BackInStockNotificationRequest_universal_d_createBackInStockNotificationRequest as createBackInStockNotificationRequest,\n ecomV1BackInStockNotificationRequest_universal_d_getBackInStockNotificationRequest as getBackInStockNotificationRequest,\n ecomV1BackInStockNotificationRequest_universal_d_deleteBackInStockNotificationRequest as deleteBackInStockNotificationRequest,\n ecomV1BackInStockNotificationRequest_universal_d_markAsNotificationSent as markAsNotificationSent,\n ecomV1BackInStockNotificationRequest_universal_d_queryBackInStockNotificationRequests as queryBackInStockNotificationRequests,\n ecomV1BackInStockNotificationRequest_universal_d_RequestsQueryResult as RequestsQueryResult,\n ecomV1BackInStockNotificationRequest_universal_d_RequestsQueryBuilder as RequestsQueryBuilder,\n ecomV1BackInStockNotificationRequest_universal_d_getBackInStockNotificationRequestsCountByCatalogReferences as getBackInStockNotificationRequestsCountByCatalogReferences,\n ecomV1BackInStockNotificationRequest_universal_d_reportItemsBackInStock as reportItemsBackInStock,\n ecomV1BackInStockNotificationRequest_universal_d_ReportItemsBackInStockOptions as ReportItemsBackInStockOptions,\n };\n }\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 * @permissionId ECOM.MODIFY_BACK_IN_STOCK_NOTIFICATION_SETTINGS\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 * @permissionId ECOM.MODIFY_BACK_IN_STOCK_NOTIFICATION_SETTINGS\n * @adminMethod\n */\n function stopCollectingRequests(appId: string): Promise;\n /**\n * Retrieves back in stock request settings.\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.READ_BACK_IN_STOCK_NOTIFICATION_SETTINGS\n */\n function getSettings(): Promise;\n \n type ecomV1BackInStockSettings_universal_d_BackInStockSettings = BackInStockSettings;\n type ecomV1BackInStockSettings_universal_d_BackInStockCollectionState = BackInStockCollectionState;\n type ecomV1BackInStockSettings_universal_d_StartCollectingRequestsRequest = StartCollectingRequestsRequest;\n type ecomV1BackInStockSettings_universal_d_StartCollectingRequestsResponse = StartCollectingRequestsResponse;\n type ecomV1BackInStockSettings_universal_d_StopCollectingRequestsRequest = StopCollectingRequestsRequest;\n type ecomV1BackInStockSettings_universal_d_StopCollectingRequestsResponse = StopCollectingRequestsResponse;\n type ecomV1BackInStockSettings_universal_d_GetSettingsRequest = GetSettingsRequest;\n type ecomV1BackInStockSettings_universal_d_GetSettingsResponse = GetSettingsResponse;\n const ecomV1BackInStockSettings_universal_d_startCollectingRequests: typeof startCollectingRequests;\n const ecomV1BackInStockSettings_universal_d_stopCollectingRequests: typeof stopCollectingRequests;\n const ecomV1BackInStockSettings_universal_d_getSettings: typeof getSettings;\n namespace ecomV1BackInStockSettings_universal_d {\n export {\n ecomV1BackInStockSettings_universal_d_BackInStockSettings as BackInStockSettings,\n ecomV1BackInStockSettings_universal_d_BackInStockCollectionState as BackInStockCollectionState,\n ecomV1BackInStockSettings_universal_d_StartCollectingRequestsRequest as StartCollectingRequestsRequest,\n ecomV1BackInStockSettings_universal_d_StartCollectingRequestsResponse as StartCollectingRequestsResponse,\n ecomV1BackInStockSettings_universal_d_StopCollectingRequestsRequest as StopCollectingRequestsRequest,\n ecomV1BackInStockSettings_universal_d_StopCollectingRequestsResponse as StopCollectingRequestsResponse,\n ecomV1BackInStockSettings_universal_d_GetSettingsRequest as GetSettingsRequest,\n ecomV1BackInStockSettings_universal_d_GetSettingsResponse as GetSettingsResponse,\n ecomV1BackInStockSettings_universal_d_startCollectingRequests as startCollectingRequests,\n ecomV1BackInStockSettings_universal_d_stopCollectingRequests as stopCollectingRequests,\n ecomV1BackInStockSettings_universal_d_getSettings as getSettings,\n };\n }\n \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$7;\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$8;\n /**\n * Combined price of all line items before discounts. Subtotal includes tax if `cart.tax_included_in_prices` is set to `true`.\n * @internal\n * @readonly\n */\n subtotal?: MultiCurrencyPrice$4;\n /**\n * Combined price of all line items after discounts.\n * @internal\n * @readonly\n */\n subtotalAfterDiscounts?: MultiCurrencyPrice$4;\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 | null;\n /**\n * Date and time the cart was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Contact info. */\n contactInfo?: AddressWithContact$5;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: 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 * 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$2;\n /**\n * Fields extended by data extensions\n * @internal\n */\n extendedFields?: ExtendedFields$a;\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$8;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n * @readonly\n */\n productName?: ProductName$5;\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 * Total price **after** catalog-defined discount and line item discounts.\n * @internal\n * @readonly\n */\n lineItemPrice?: MultiCurrencyPrice$4;\n /**\n * Line item description lines. Used for displaying the cart, checkout and order.\n * @readonly\n */\n descriptionLines?: DescriptionLine$5[];\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$7;\n /**\n * Coupon scopes - which app and items a coupon applies to.\n * This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current [Coupons API](https://bo.wix.com/wix-docs/rest/stores/coupons/valid-scope-values).\n * @internal\n * @readonly\n */\n couponScopes?: Scope$4[];\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$6;\n /**\n * Subscription option information.\n * @internal\n * @readonly\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$4;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia$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?: V1PaymentOptionType$2;\n /**\n * Service properties. When relevant, this contains information such as date and number of participants.\n * @readonly\n */\n serviceProperties?: ServiceProperties$5;\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$5;\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$4;\n /**\n * The Item's Delivery Profile Id\n * @internal\n * @readonly\n */\n deliveryProfileId?: string | null;\n /**\n * Tax group ID for this line item.\n * @readonly\n */\n taxGroupId?: string | null;\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 * Shipping group ID.\n * @internal\n * @readonly\n */\n shippingGroupId?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n * @internal\n * @readonly\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n * @internal\n * @readonly\n */\n fixedQuantity?: boolean;\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 * Address to be used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$6;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$a;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n * @readonly\n */\n policies?: Policy$3[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n }\n /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */\n interface CatalogReference$8 {\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 [app dashboard](https://dev.wix.com/dc3/my-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$5 {\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$5 extends DescriptionLineValueOneOf$5, DescriptionLineDescriptionLineValueOneOf$5 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$5;\n /** Description line color value. */\n colorInfo?: Color$5;\n /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$5;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName$5;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType$5;\n }\n /** @oneof */\n interface DescriptionLineValueOneOf$5 {\n /** Description line plain text value. */\n plainText?: PlainTextValue$5;\n /** Description line color value. */\n colorInfo?: Color$5;\n }\n /** @oneof */\n interface DescriptionLineDescriptionLineValueOneOf$5 {\n /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$5;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n }\n interface DescriptionLineName$5 {\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$5 {\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$5 {\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$5 {\n /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\n }\n interface FocalPoint$6 {\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 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 /** Item does not exist */\n NOT_FOUND = \"NOT_FOUND\",\n /** Item not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface PhysicalProperties$7 {\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$4;\n }\n interface Group$4 {\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$6 extends ItemTypeItemTypeDataOneOf$6 {\n /** Preset item type. */\n preset?: ItemTypeItemType$6;\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$6 {\n /** Preset item type. */\n preset?: ItemTypeItemType$6;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$6 {\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$7;\n /** Subscription option title. */\n title?: Title$3;\n /** Subscription option description. */\n description?: Description$3;\n }\n interface SubscriptionSettings$7 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$7;\n /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n * If SubscriptionFrequency is Day the minimum interval is 7\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 * Whether to allow the customer to cancel the subscription..\n * @internal\n */\n enableCustomerCancellation?: boolean;\n /**\n * Period until first cycle starts. If applied payNow will be 0\n * If None => no free trial\n * @internal\n */\n freeTrialPeriod?: FreeTrialPeriod$3;\n /**\n * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.\n * @internal\n */\n startDate?: Date | null;\n /**\n * Whether to generate an order each billing cycle. An order will always be generated for the first billing cycle.\n * Default None => will behave like true\n * @internal\n */\n generateOrderEachBillingCycle?: boolean | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$7 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface FreeTrialPeriod$3 {\n /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */\n frequency?: SubscriptionFrequency$7;\n /** interval of period */\n interval?: number;\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$4 {\n /** Media ID in Wix Media Manager. */\n _id?: string;\n /** Original filename. */\n fileName?: string;\n /** File type. */\n fileType?: FileType$4;\n }\n enum FileType$4 {\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 V1PaymentOptionType$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 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 checkout. The 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$5 {\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$5 {\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$4 {\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$5;\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$5[];\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties$7;\n /** Item image. */\n image?: string;\n /** Payment method selected for the item. */\n paymentOption?: PaymentOption$3;\n /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */\n depositAmount?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface PaymentOption$3 {\n /**\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 selected, `price` is `0`.\n * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.\n * + `MEMBERSHIP_OFFLINE`: 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 */\n value?: V1PaymentOptionType$2;\n }\n interface TaxableAddress$6 extends TaxableAddressTaxableAddressDataOneOf$6 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$6;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$6 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$6;\n }\n enum TaxableAddressType$6 {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n interface ExtendedFields$a {\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 Policy$3 {\n /** Policy title - should be translated */\n title?: string | null;\n /** Policy content - should be translated */\n content?: string;\n }\n /** Buyer Info */\n interface BuyerInfo$7 extends BuyerInfoIdOneOf$5 {\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$5 {\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$8 {\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$6;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$6;\n /**\n * Discount rule\n * @internal\n */\n discountRule?: V1DiscountRule$1;\n /** @internal */\n lineItemIds?: string[];\n }\n /** @oneof */\n interface CartDiscountDiscountSourceOneOf$1 {\n /** Coupon details. */\n coupon?: Coupon$6;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$6;\n /**\n * Discount rule\n * @internal\n */\n discountRule?: V1DiscountRule$1;\n }\n interface Coupon$6 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /**\n * Coupon value.\n * @internal\n */\n amount?: MultiCurrencyPrice$4;\n }\n interface MerchantDiscount$6 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$4;\n }\n interface V1DiscountRule$1 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: V1DiscountRuleName$1;\n /** Discount value. */\n amount?: MultiCurrencyPrice$4;\n }\n interface V1DiscountRuleName$1 {\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 /** Billing Info and shipping details */\n interface AddressWithContact$5 {\n /** Address. */\n address?: Address$a;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$6;\n }\n /** Physical address */\n interface Address$a {\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$9;\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 /** @internal */\n location?: AddressLocation$9;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$9 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$9 {\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$6 {\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$7;\n }\n interface VatId$7 {\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$7;\n }\n /** tax info types */\n enum VatType$7 {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** CPF - for individual tax payers. */\n CPF = \"CPF\",\n /** CNPJ - for corporations */\n CNPJ = \"CNPJ\"\n }\n interface SelectedShippingOption$2 {\n /** Carrier ID. */\n carrierId?: string | null;\n /** Selected shipping option code. For example, \"usps_std_overnight\". */\n code?: string;\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$3[];\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$4[];\n /**\n * List of field names to determine which of cartInfo's fields will be updated\n * @internal\n */\n cartFieldmask?: string[];\n }\n interface MerchantDiscountInput$3 {\n /** Discount amount. */\n amount?: string;\n /** IDs of the line items the discount applies to. */\n lineItemIds?: string[];\n }\n interface CustomLineItem$4 {\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$5;\n /** Custom line item description lines. Used for displaying the cart, checkout and order. */\n descriptionLines?: DescriptionLine$5[];\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$5;\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$6;\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$7;\n /**\n * Subscription option info. This field is internal and only used by Stores.\n * @internal\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$4;\n /**\n * Digital file ID and name. Required if `itemType: DIGITAL`.\n * @internal\n */\n digitalFile?: SecuredMedia$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?: V1PaymentOptionType$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$5;\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 /**\n * Delivery Profile ID.\n * @internal\n */\n deliveryProfileId?: 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$8;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: 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 * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n */\n policies?: Policy$3[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\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$4[];\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$4[];\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$2;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$4;\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$4 {\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$2[];\n /** Price summary. */\n priceSummary?: PriceSummary$6;\n /** Applied gift card. */\n giftCard?: GiftCard$6;\n /** Tax summary. */\n taxSummary?: TaxSummary$6;\n /** Shipping information. */\n shippingInfo?: ShippingInformation$4;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$6[];\n /** Calculation errors. */\n calculationErrors?: CalculationErrors$5;\n /** Weight measurement unit - defaults to site's weight unit. */\n weightUnit?: WeightUnit$8;\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$6;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$6;\n /** Information about valid and invalid memberships, and which ones are selected for usage. */\n membershipOptions?: MembershipOptions$4;\n /** Additional fees */\n additionalFees?: AdditionalFee$6[];\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$2 {\n /** Line item ID. */\n lineItemId?: string;\n /** Price breakdown for this line item. */\n pricesBreakdown?: LineItemPricesData$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 */\n paymentOption?: V1PaymentOptionType$2;\n /**\n * tax calculation address.\n * @internal\n */\n taxableAddress?: TaxableAddress$6;\n }\n interface LineItemPricesData$2 {\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$6;\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$6 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$4;\n /**\n * Tax group ID, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$4[];\n /**\n * The amount of this line item that was exempt.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$4;\n /**\n * True for items we have a tax applied on them\n * @internal\n */\n isItemTaxable?: boolean | null;\n /**\n * True if the lineAmount include tax in it.\n * @internal\n */\n isTaxIncluded?: boolean | null;\n /**\n * The calculator that calculated this line tax\n * @internal\n */\n calculatorName?: string | null;\n /**\n * tax information for a line item.\n * @internal\n * @readonly\n */\n taxBreakdown?: TaxBreakdown$4[];\n }\n interface TaxRateBreakdown$4 {\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 * The type of tax that was calculated\n * @internal\n */\n taxType?: string | null;\n /**\n * The name of the jurisdiction in which this tax detail applies\n * @internal\n */\n jurisdiction?: string | null;\n /**\n * The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).\n * @internal\n */\n jurisdictionType?: string | null;\n /**\n * The amount of this line item that was exempt from this authority.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$4;\n /**\n * ids of the used exemptions from the TaxEstimate exemptions array.\n * @internal\n */\n exemptionIds?: number[];\n /**\n * The taxable amount of this tax detail\n * @internal\n */\n taxableAmount?: MultiCurrencyPrice$4;\n /**\n * The Taxes/Fee component. True if the fee is applied.\n * @internal\n */\n isFee?: boolean | null;\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$4 {\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$6;\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$6 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface PriceSummary$6 {\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$6 {\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$6 {\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 * Manual tax rate\n * @internal\n * @readonly\n * @deprecated\n */\n manualTaxRate?: string;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$4;\n /**\n * Tax estimation id in tax service\n * @internal\n * @readonly\n */\n taxEstimationId?: string | null;\n /**\n * Average Tax Rate\n * @internal\n * @readonly\n */\n averageTaxRate?: string | null;\n /**\n * The amount of this estimate that was exempt (for all line items).\n * @internal\n * @readonly\n */\n totalExempt?: MultiCurrencyPrice$4;\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 * @internal\n * @readonly\n */\n aggregatedTaxBreakdown?: AggregatedTaxBreakdown$4[];\n }\n interface TaxCalculationDetails$4 extends TaxCalculationDetailsCalculationDetailsOneOf$4 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$4;\n /** Error details and reason for tax rate fallback. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$4;\n /**\n * Rate calculation type. Supported values:\n * + `\"AUTO_RATE\"`\n * + `\"FALLBACK_RATE\"`\n * + `\"MANUAL_RATE\"`\n * + `\"NO_TAX_COLLECTED\"`\n */\n rateType?: RateType$4;\n }\n /** @oneof */\n interface TaxCalculationDetailsCalculationDetailsOneOf$4 {\n /** Reason the manual calculation was used. */\n manualRateReason?: ManualCalculationReason$4;\n /** Details of the fallback rate calculation. */\n autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails$4;\n }\n enum RateType$4 {\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$4 {\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$4 {\n /**\n * Reason for fallback. Supported values:\n * + `\"AUTO_TAX_FAILED\"`\n * + `\"AUTO_TAX_DEACTIVATED\"`\n */\n fallbackReason?: FallbackReason$4;\n /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */\n error?: ApplicationError$b;\n }\n enum FallbackReason$4 {\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$b {\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$4 {\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$6;\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 * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: MultiCurrencyPrice$4;\n }\n interface ShippingInformation$4 {\n /** Shipping region. */\n region?: ShippingRegion$6;\n /** Selected shipping option. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption$4;\n /** All shipping options. */\n carrierServiceOptions?: CarrierServiceOption$4[];\n }\n interface ShippingRegion$6 {\n /**\n * Shipping region ID.\n * @readonly\n */\n _id?: string;\n /** Shipping region name. */\n name?: string;\n }\n interface SelectedCarrierServiceOption$4 {\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$7;\n /**\n * Shipping costs.\n * @readonly\n */\n cost?: SelectedCarrierServiceOptionPrices$4;\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$4[];\n /** This carrier's unique ID */\n carrierId?: string | null;\n /**\n * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$5[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface DeliveryLogistics$7 {\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$8;\n /**\n * Expected delivery time slot (from and to time stamps representation)\n * @internal\n */\n deliveryTimeSlot?: DeliveryTimeSlot$7;\n }\n interface PickupDetails$8 {\n /** Pickup address. */\n address?: Address$a;\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$7;\n }\n enum PickupMethod$7 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$7 {\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$4 {\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$6;\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$4 {\n /** Type of additional cost. */\n type?: ChargeType$6;\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$4;\n }\n enum ChargeType$6 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface DeliveryAllocation$5 {\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n deliveryCarrier?: Carrier$5;\n /** The delivery region that are relevant for this delivery solution. */\n deliveryRegion?: Region$5;\n /** Populated if the delivery solution is a partially supplied by this carrier. */\n applicableLineItems?: ApplicableLineItems$5;\n }\n interface Carrier$5 {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface Region$5 {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface ApplicableLineItems$5 {\n /** Line items that the delivery solution is for. */\n lineItemIds?: string[];\n }\n interface CarrierServiceOption$4 {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption$6[];\n }\n interface ShippingOption$6 {\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$7;\n /** Sipping price information. */\n cost?: ShippingPrice$6;\n /**\n * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$5[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface ShippingPrice$6 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$4;\n /** Other costs such as insurance, handling & packaging for fragile items, etc. */\n otherCharges?: OtherCharge$4[];\n }\n interface OtherCharge$4 {\n /** Type of additional cost. */\n type?: ChargeType$6;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$4;\n }\n interface AppliedDiscount$6 extends AppliedDiscountDiscountSourceOneOf$6 {\n /** Coupon details. */\n coupon?: V1Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount$1;\n /** Discount rule */\n discountRule?: DiscountRule$6;\n /** Discount type. */\n discountType?: DiscountType$6;\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 * Discount ID.\n * @internal\n */\n _id?: string | null;\n /**\n * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$6[];\n /**\n * Number of subscription cycle this discount applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$6 {\n /** Coupon details. */\n coupon?: V1Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount$1;\n /** Discount rule */\n discountRule?: DiscountRule$6;\n }\n enum DiscountType$6 {\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 * Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.\n * @internal\n * @deprecated\n */\n couponType?: 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$6 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$6;\n /** Discount value. */\n amount?: MultiCurrencyPrice$4;\n }\n interface DiscountRuleName$6 {\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$6 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$4;\n }\n interface CalculationErrors$5 extends CalculationErrorsShippingCalculationErrorOneOf$5 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$6;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$5;\n /** Tax calculation error. */\n taxCalculationError?: Details$6;\n /** Coupon calculation error. */\n couponCalculationError?: Details$6;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details$6;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$b[];\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$6;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details$6;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$5 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$6;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$5;\n }\n interface Details$6 extends DetailsKindOneOf$6 {\n applicationError?: ApplicationError$b;\n validationError?: ValidationError$6;\n systemError?: SystemError$6;\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$6 {\n applicationError?: ApplicationError$b;\n validationError?: ValidationError$6;\n systemError?: SystemError$6;\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$6 {\n fieldViolations?: FieldViolation$6[];\n }\n enum RuleType$6 {\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\n }\n interface FieldViolation$6 {\n field?: string;\n description?: string;\n violatedRule?: RuleType$6;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError$6 {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors$5 {\n /** Carrier errors. */\n errors?: CarrierError$6[];\n }\n interface CarrierError$6 {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details$6;\n }\n interface MembershipOptions$4 {\n /** List of payment options that can be used. */\n eligibleMemberships?: Membership$4[];\n /** List of payment options that are owned by the member, but cannot be used due to reason provided. */\n invalidMemberships?: InvalidMembership$4[];\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: HostSelectedMembership$1[];\n }\n interface Membership$4 {\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$6;\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$4;\n /** Optional - TMembership expiry date. */\n expirationDate?: Date | null;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$6 {\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$4 {\n /** Membership's total amount of credits. */\n total?: number;\n /** Membership's remaining amount of credits. */\n remaining?: number;\n }\n interface InvalidMembership$4 {\n /** Membership details. */\n membership?: Membership$4;\n /** Reason why this membership is invalid and cannot be used. */\n reason?: string;\n }\n interface AdditionalFee$6 {\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$6;\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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\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 /** Delivery section. */\n DELIVERY = \"DELIVERY\"\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 enum SuggestedFix$3 {\n /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */\n UNKNOWN_SUGGESTED_FIX = \"UNKNOWN_SUGGESTED_FIX\",\n /** The line item should be removed from the cart or checkout to resolve the violation. */\n REMOVE_LINE_ITEM = \"REMOVE_LINE_ITEM\"\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 * Suggested fix for resolving the line item violation.\n * @internal\n */\n suggestedFix?: SuggestedFix$3;\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$6;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$2;\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$6 {\n /** Unspecified sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\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$2;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$4;\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$i extends DomainEventBodyOneOf$i {\n createdEvent?: EntityCreatedEvent$i;\n updatedEvent?: EntityUpdatedEvent$i;\n deletedEvent?: EntityDeletedEvent$i;\n actionEvent?: ActionEvent$i;\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$i {\n createdEvent?: EntityCreatedEvent$i;\n updatedEvent?: EntityUpdatedEvent$i;\n deletedEvent?: EntityDeletedEvent$i;\n actionEvent?: ActionEvent$i;\n }\n interface EntityCreatedEvent$i {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$i;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$i {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$i {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$i {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$i {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$h {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$i;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$i extends IdentificationDataIdOneOf$i {\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$h;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$i {\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$h {\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$3[];\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$4[];\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$4[];\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$6;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$2;\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$2;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$4;\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$b {\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.price\n * @requiredField options.customLineItems.productName\n * @requiredField options.customLineItems.quantity\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 * @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$3[];\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$4[];\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 * @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$7;\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$8;\n /**\n * Combined price of all line items before discounts. Subtotal includes tax if `cart.tax_included_in_prices` is set to `true`.\n * @internal\n * @readonly\n */\n subtotal?: MultiCurrencyPrice$4;\n /**\n * Combined price of all line items after discounts.\n * @internal\n * @readonly\n */\n subtotalAfterDiscounts?: MultiCurrencyPrice$4;\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 | null;\n /**\n * Date and time the cart was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Contact info. */\n contactInfo?: AddressWithContact$5;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: 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 * 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$2;\n /**\n * Fields extended by data extensions\n * @internal\n */\n extendedFields?: ExtendedFields$a;\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$3[];\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$4[];\n /**\n * List of field names to determine which of cartInfo's fields will be updated\n * @internal\n */\n cartFieldmask?: string[];\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 * @returns Fulfilled - The specified cart.\n */\n function getCart(_id: string): Promise;\n /**\n * Retrieves the cart associated with a specified checkout.\n * @param _id - Checkout ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_CARTS\n */\n function getCartByCheckoutId(_id: string): Promise;\n /**\n * Deprecated. Use CurrentCartService.GetCurrentCart instead.\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.READ_CARTS\n * @deprecated\n * @replacedBy com.wix.ecom.cart.api.v1.CurrentCartService.GetCurrentCart\n * @targetRemovalDate 2024-10-31\n */\n function internalGetCurrentCart(): 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.price\n * @requiredField options.customLineItems.productName\n * @requiredField options.customLineItems.quantity\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 * @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$4[];\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 * @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 * @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$6;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$2;\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 * @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 * @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 * @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$2;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$a;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$a;\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMemberships$4;\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 * @returns Fulfilled - When the cart is deleted. Rejected - Error message.\n */\n function deleteCart(_id: string): Promise;\n \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_getCartByCheckoutId: typeof getCartByCheckoutId;\n const ecomV1CartCart_universal_d_internalGetCurrentCart: typeof internalGetCurrentCart;\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 {\n Cart$1 as Cart,\n LineItem$6 as LineItem,\n CatalogReference$8 as CatalogReference,\n ProductName$5 as ProductName,\n MultiCurrencyPrice$4 as MultiCurrencyPrice,\n DescriptionLine$5 as DescriptionLine,\n DescriptionLineValueOneOf$5 as DescriptionLineValueOneOf,\n DescriptionLineDescriptionLineValueOneOf$5 as DescriptionLineDescriptionLineValueOneOf,\n DescriptionLineName$5 as DescriptionLineName,\n PlainTextValue$5 as PlainTextValue,\n Color$5 as Color,\n DescriptionLineType$5 as DescriptionLineType,\n FocalPoint$6 as FocalPoint,\n ItemAvailabilityInfo$3 as ItemAvailabilityInfo,\n ItemAvailabilityStatus$3 as ItemAvailabilityStatus,\n PhysicalProperties$7 as PhysicalProperties,\n Scope$4 as Scope,\n Group$4 as Group,\n ItemType$6 as ItemType,\n ItemTypeItemTypeDataOneOf$6 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$6 as ItemTypeItemType,\n SubscriptionOptionInfo$4 as SubscriptionOptionInfo,\n SubscriptionSettings$7 as SubscriptionSettings,\n SubscriptionFrequency$7 as SubscriptionFrequency,\n FreeTrialPeriod$3 as FreeTrialPeriod,\n Title$3 as Title,\n Description$3 as Description,\n SecuredMedia$4 as SecuredMedia,\n FileType$4 as FileType,\n V1PaymentOptionType$2 as V1PaymentOptionType,\n ServiceProperties$5 as ServiceProperties,\n PriceDescription$5 as PriceDescription,\n SelectedMembership$4 as SelectedMembership,\n CatalogOverrideFields$3 as CatalogOverrideFields,\n PaymentOption$3 as PaymentOption,\n TaxableAddress$6 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$6 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$6 as TaxableAddressType,\n ExtendedFields$a as ExtendedFields,\n Policy$3 as Policy,\n BuyerInfo$7 as BuyerInfo,\n BuyerInfoIdOneOf$5 as BuyerInfoIdOneOf,\n WeightUnit$8 as WeightUnit,\n CartDiscount$1 as CartDiscount,\n CartDiscountDiscountSourceOneOf$1 as CartDiscountDiscountSourceOneOf,\n Coupon$6 as Coupon,\n MerchantDiscount$6 as MerchantDiscount,\n V1DiscountRule$1 as V1DiscountRule,\n V1DiscountRuleName$1 as V1DiscountRuleName,\n AddressWithContact$5 as AddressWithContact,\n Address$a as Address,\n StreetAddress$9 as StreetAddress,\n AddressLocation$9 as AddressLocation,\n FullAddressContactDetails$6 as FullAddressContactDetails,\n VatId$7 as VatId,\n VatType$7 as VatType,\n SelectedShippingOption$2 as SelectedShippingOption,\n GetCurrentCartRequest$1 as GetCurrentCartRequest,\n GetCurrentCartResponse$1 as GetCurrentCartResponse,\n UpdateCartRequest$1 as UpdateCartRequest,\n MerchantDiscountInput$3 as MerchantDiscountInput,\n CustomLineItem$4 as CustomLineItem,\n UpdateCartResponse$1 as UpdateCartResponse,\n AddToCurrentCartRequest$1 as AddToCurrentCartRequest,\n AddToCartResponse$1 as AddToCartResponse,\n AddToCurrentCartAndEstimateTotalsRequest$1 as AddToCurrentCartAndEstimateTotalsRequest,\n SelectedMemberships$4 as SelectedMemberships,\n HostSelectedMembership$1 as HostSelectedMembership,\n EstimateTotalsResponse$1 as EstimateTotalsResponse,\n CalculatedLineItem$2 as CalculatedLineItem,\n LineItemPricesData$2 as LineItemPricesData,\n ItemTaxFullDetails$6 as ItemTaxFullDetails,\n TaxRateBreakdown$4 as TaxRateBreakdown,\n TaxBreakdown$4 as TaxBreakdown,\n JurisdictionType$6 as JurisdictionType,\n PriceSummary$6 as PriceSummary,\n GiftCard$6 as GiftCard,\n TaxSummary$6 as TaxSummary,\n TaxCalculationDetails$4 as TaxCalculationDetails,\n TaxCalculationDetailsCalculationDetailsOneOf$4 as TaxCalculationDetailsCalculationDetailsOneOf,\n RateType$4 as RateType,\n ManualCalculationReason$4 as ManualCalculationReason,\n AutoTaxFallbackCalculationDetails$4 as AutoTaxFallbackCalculationDetails,\n FallbackReason$4 as FallbackReason,\n ApplicationError$b as ApplicationError,\n AggregatedTaxBreakdown$4 as AggregatedTaxBreakdown,\n ShippingInformation$4 as ShippingInformation,\n ShippingRegion$6 as ShippingRegion,\n SelectedCarrierServiceOption$4 as SelectedCarrierServiceOption,\n DeliveryLogistics$7 as DeliveryLogistics,\n PickupDetails$8 as PickupDetails,\n PickupMethod$7 as PickupMethod,\n DeliveryTimeSlot$7 as DeliveryTimeSlot,\n SelectedCarrierServiceOptionPrices$4 as SelectedCarrierServiceOptionPrices,\n SelectedCarrierServiceOptionOtherCharge$4 as SelectedCarrierServiceOptionOtherCharge,\n ChargeType$6 as ChargeType,\n DeliveryAllocation$5 as DeliveryAllocation,\n Carrier$5 as Carrier,\n Region$5 as Region,\n ApplicableLineItems$5 as ApplicableLineItems,\n CarrierServiceOption$4 as CarrierServiceOption,\n ShippingOption$6 as ShippingOption,\n ShippingPrice$6 as ShippingPrice,\n OtherCharge$4 as OtherCharge,\n AppliedDiscount$6 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$6 as AppliedDiscountDiscountSourceOneOf,\n DiscountType$6 as DiscountType,\n V1Coupon$1 as V1Coupon,\n V1MerchantDiscount$1 as V1MerchantDiscount,\n DiscountRule$6 as DiscountRule,\n DiscountRuleName$6 as DiscountRuleName,\n LineItemDiscount$6 as LineItemDiscount,\n CalculationErrors$5 as CalculationErrors,\n CalculationErrorsShippingCalculationErrorOneOf$5 as CalculationErrorsShippingCalculationErrorOneOf,\n Details$6 as Details,\n DetailsKindOneOf$6 as DetailsKindOneOf,\n ValidationError$6 as ValidationError,\n RuleType$6 as RuleType,\n FieldViolation$6 as FieldViolation,\n SystemError$6 as SystemError,\n CarrierErrors$5 as CarrierErrors,\n CarrierError$6 as CarrierError,\n MembershipOptions$4 as MembershipOptions,\n Membership$4 as Membership,\n MembershipName$6 as MembershipName,\n MembershipPaymentCredits$4 as MembershipPaymentCredits,\n InvalidMembership$4 as InvalidMembership,\n AdditionalFee$6 as AdditionalFee,\n Violation$3 as Violation,\n Severity$3 as Severity,\n Target$3 as Target,\n TargetTargetTypeOneOf$3 as TargetTargetTypeOneOf,\n NameInOther$3 as NameInOther,\n NameInLineItem$3 as NameInLineItem,\n SuggestedFix$3 as SuggestedFix,\n Other$3 as Other,\n TargetLineItem$3 as TargetLineItem,\n RemoveLineItemsFromCurrentCartRequest$1 as RemoveLineItemsFromCurrentCartRequest,\n RemoveLineItemsResponse$2 as RemoveLineItemsResponse,\n CreateCheckoutFromCurrentCartRequest$1 as CreateCheckoutFromCurrentCartRequest,\n ChannelType$6 as ChannelType,\n CreateCheckoutResponse$2 as CreateCheckoutResponse,\n RemoveCouponFromCurrentCartRequest$1 as RemoveCouponFromCurrentCartRequest,\n RemoveCouponResponse$2 as RemoveCouponResponse,\n UpdateCurrentCartLineItemQuantityRequest$1 as UpdateCurrentCartLineItemQuantityRequest,\n LineItemQuantityUpdate$2 as LineItemQuantityUpdate,\n UpdateLineItemsQuantityResponse$2 as UpdateLineItemsQuantityResponse,\n EstimateCurrentCartTotalsRequest$1 as EstimateCurrentCartTotalsRequest,\n DeleteCurrentCartRequest$1 as DeleteCurrentCartRequest,\n DeleteCartResponse$1 as DeleteCartResponse,\n DomainEvent$i as DomainEvent,\n DomainEventBodyOneOf$i as DomainEventBodyOneOf,\n EntityCreatedEvent$i as EntityCreatedEvent,\n RestoreInfo$i as RestoreInfo,\n EntityUpdatedEvent$i as EntityUpdatedEvent,\n EntityDeletedEvent$i as EntityDeletedEvent,\n ActionEvent$i as ActionEvent,\n MessageEnvelope$h as MessageEnvelope,\n IdentificationData$i as IdentificationData,\n IdentificationDataIdOneOf$i as IdentificationDataIdOneOf,\n WebhookIdentityType$h as WebhookIdentityType,\n CreateCartRequest$1 as CreateCartRequest,\n CreateCartResponse$1 as CreateCartResponse,\n GetCartRequest$1 as GetCartRequest,\n GetCartResponse$1 as GetCartResponse,\n GetCartByCheckoutIdRequest$1 as GetCartByCheckoutIdRequest,\n GetCartByCheckoutIdResponse$1 as GetCartByCheckoutIdResponse,\n AddToCartRequest$1 as AddToCartRequest,\n RemoveLineItemsRequest$2 as RemoveLineItemsRequest,\n CreateCheckoutRequest$2 as CreateCheckoutRequest,\n RemoveCouponRequest$2 as RemoveCouponRequest,\n UpdateLineItemsQuantityRequest$2 as UpdateLineItemsQuantityRequest,\n EstimateTotalsRequest$1 as EstimateTotalsRequest,\n DeleteCartRequest$1 as DeleteCartRequest,\n Empty$b as Empty,\n ecomV1CartCart_universal_d_createCart as createCart,\n ecomV1CartCart_universal_d_CreateCartOptions as CreateCartOptions,\n ecomV1CartCart_universal_d_updateCart as updateCart,\n ecomV1CartCart_universal_d_UpdateCartOptions as UpdateCartOptions,\n ecomV1CartCart_universal_d_getCart as getCart,\n ecomV1CartCart_universal_d_getCartByCheckoutId as getCartByCheckoutId,\n ecomV1CartCart_universal_d_internalGetCurrentCart as internalGetCurrentCart,\n ecomV1CartCart_universal_d_addToCart as addToCart,\n ecomV1CartCart_universal_d_AddToCartOptions as AddToCartOptions,\n removeLineItems$1 as removeLineItems,\n createCheckout$1 as createCheckout,\n CreateCheckoutOptions$1 as CreateCheckoutOptions,\n removeCoupon$1 as removeCoupon,\n updateLineItemsQuantity$1 as updateLineItemsQuantity,\n ecomV1CartCart_universal_d_estimateTotals as estimateTotals,\n ecomV1CartCart_universal_d_EstimateTotalsOptions as EstimateTotalsOptions,\n ecomV1CartCart_universal_d_deleteCart as deleteCart,\n };\n }\n \n interface Cart {\n /** Cart ID. */\n _id?: string | null;\n /**\n * Line items.\n * @readonly\n */\n lineItems?: LineItem$5[];\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$7;\n /**\n * Combined price of all line items before discounts. Subtotal includes tax if `cart.tax_included_in_prices` is set to `true`.\n * @internal\n * @readonly\n */\n subtotal?: MultiCurrencyPrice$3;\n /**\n * Combined price of all line items after discounts.\n * @internal\n * @readonly\n */\n subtotalAfterDiscounts?: MultiCurrencyPrice$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$4;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: 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 * 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 * Fields extended by data extensions\n * @internal\n */\n extendedFields?: ExtendedFields$9;\n }\n interface LineItem$5 {\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$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** catalog-defined discount and line item discounts.\n * @internal\n * @readonly\n */\n lineItemPrice?: MultiCurrencyPrice$3;\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$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$6;\n /**\n * Coupon scopes - which app and items a coupon applies to.\n * This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current [Coupons API](https://bo.wix.com/wix-docs/rest/stores/coupons/valid-scope-values).\n * @internal\n * @readonly\n */\n couponScopes?: Scope$3[];\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$5;\n /**\n * Subscription option information.\n * @internal\n * @readonly\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$3;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia$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` will be 0.\n * @readonly\n */\n paymentOption?: V1PaymentOptionType$1;\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$3;\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 * The Item's Delivery Profile Id\n * @internal\n * @readonly\n */\n deliveryProfileId?: string | null;\n /**\n * Tax group ID for this line item.\n * @readonly\n */\n taxGroupId?: string | null;\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 * Shipping group ID.\n * @internal\n * @readonly\n */\n shippingGroupId?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n * @internal\n * @readonly\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n * @internal\n * @readonly\n */\n fixedQuantity?: boolean;\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 * Address to be used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$5;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$9;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n * @readonly\n */\n policies?: Policy$2[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\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 [app dashboard](https://dev.wix.com/dc3/my-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$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 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 /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$4;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName$4;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType$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 * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$4;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\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 /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\n }\n interface FocalPoint$5 {\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 ItemAvailabilityInfo$2 {\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$2;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus$2 {\n AVAILABLE = \"AVAILABLE\",\n /** Item does not exist */\n NOT_FOUND = \"NOT_FOUND\",\n /** Item not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface PhysicalProperties$6 {\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$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$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$5 extends ItemTypeItemTypeDataOneOf$5 {\n /** Preset item type. */\n preset?: ItemTypeItemType$5;\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$5 {\n /** Preset item type. */\n preset?: ItemTypeItemType$5;\n /** Custom item type. When none of the preset types are suitable, specifies the custom type. */\n custom?: string;\n }\n enum ItemTypeItemType$5 {\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$6;\n /** Subscription option title. */\n title?: Title$2;\n /** Subscription option description. */\n description?: Description$2;\n }\n interface SubscriptionSettings$6 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$6;\n /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n * If SubscriptionFrequency is Day the minimum interval is 7\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 * Whether to allow the customer to cancel the subscription..\n * @internal\n */\n enableCustomerCancellation?: boolean;\n /**\n * Period until first cycle starts. If applied payNow will be 0\n * If None => no free trial\n * @internal\n */\n freeTrialPeriod?: FreeTrialPeriod$2;\n /**\n * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.\n * @internal\n */\n startDate?: Date | null;\n /**\n * Whether to generate an order each billing cycle. An order will always be generated for the first billing cycle.\n * Default None => will behave like true\n * @internal\n */\n generateOrderEachBillingCycle?: boolean | null;\n }\n /** Frequency unit of recurring payment */\n enum SubscriptionFrequency$6 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\n YEAR = \"YEAR\"\n }\n interface FreeTrialPeriod$2 {\n /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */\n frequency?: SubscriptionFrequency$6;\n /** interval of period */\n interval?: number;\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$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 V1PaymentOptionType$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 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 checkout. The 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 | 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$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$2 {\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$6;\n /** Item image. */\n image?: string;\n /** Payment method selected for the item. */\n paymentOption?: PaymentOption$2;\n /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */\n depositAmount?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface PaymentOption$2 {\n /**\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 selected, `price` is `0`.\n * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.\n * + `MEMBERSHIP_OFFLINE`: 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 */\n value?: V1PaymentOptionType$1;\n }\n interface TaxableAddress$5 extends TaxableAddressTaxableAddressDataOneOf$5 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$5;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$5 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$5;\n }\n enum TaxableAddressType$5 {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n interface ExtendedFields$9 {\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 Policy$2 {\n /** Policy title - should be translated */\n title?: string | null;\n /** Policy content - should be translated */\n content?: string;\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$7 {\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$5;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$5;\n /**\n * Discount rule\n * @internal\n */\n discountRule?: V1DiscountRule;\n /** @internal */\n lineItemIds?: string[];\n }\n /** @oneof */\n interface CartDiscountDiscountSourceOneOf {\n /** Coupon details. */\n coupon?: Coupon$5;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$5;\n /**\n * Discount rule\n * @internal\n */\n discountRule?: V1DiscountRule;\n }\n interface Coupon$5 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /**\n * Coupon value.\n * @internal\n */\n amount?: MultiCurrencyPrice$3;\n }\n interface MerchantDiscount$5 {\n /** Discount value. */\n amount?: MultiCurrencyPrice$3;\n }\n interface V1DiscountRule {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: V1DiscountRuleName;\n /** Discount value. */\n amount?: MultiCurrencyPrice$3;\n }\n interface V1DiscountRuleName {\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 /** Billing Info and shipping details */\n interface AddressWithContact$4 {\n /** Address. */\n address?: Address$9;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$5;\n }\n /** Physical address */\n interface Address$9 {\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$8;\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 /** @internal */\n location?: AddressLocation$8;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$8 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$8 {\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$5 {\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$6;\n }\n interface VatId$6 {\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$6;\n }\n /** tax info types */\n enum VatType$6 {\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 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$2[];\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$3[];\n /**\n * List of field names to determine which of cartInfo's fields will be updated\n * @internal\n */\n cartFieldmask?: string[];\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$5;\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$6;\n /**\n * Subscription option info. This field is internal and only used by Stores.\n * @internal\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$3;\n /**\n * Digital file ID and name. Required if `itemType: DIGITAL`.\n * @internal\n */\n digitalFile?: SecuredMedia$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?: V1PaymentOptionType$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$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 /**\n * Delivery Profile ID.\n * @internal\n */\n deliveryProfileId?: 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 * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: 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 * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n */\n policies?: Policy$2[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n }\n interface UpdateCartResponse {\n /** Updated Cart. */\n cart?: Cart;\n }\n interface AddToCurrentCartRequest {\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$3[];\n }\n interface AddToCartResponse {\n /** Updated cart. */\n cart?: Cart;\n }\n interface AddToCurrentCartAndEstimateTotalsRequest {\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$3[];\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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[];\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$1[];\n /** Price summary. */\n priceSummary?: PriceSummary$5;\n /** Applied gift card. */\n giftCard?: GiftCard$5;\n /** Tax summary. */\n taxSummary?: TaxSummary$5;\n /** Shipping information. */\n shippingInfo?: ShippingInformation$3;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$5[];\n /** Calculation errors. */\n calculationErrors?: CalculationErrors$4;\n /** Weight measurement unit - defaults to site's weight unit. */\n weightUnit?: WeightUnit$7;\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$5;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary$5;\n /** Information about valid and invalid memberships, and which ones are selected for usage. */\n membershipOptions?: MembershipOptions$3;\n /** Additional fees */\n additionalFees?: AdditionalFee$5[];\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 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?: V1PaymentOptionType$1;\n /**\n * tax calculation address.\n * @internal\n */\n taxableAddress?: TaxableAddress$5;\n }\n interface LineItemPricesData$1 {\n /** Total price after discounts and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice$3;\n /** Total price after discounts, and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$3;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$5;\n /** Total discount for all line items. */\n totalDiscount?: MultiCurrencyPrice$3;\n /** Catalog price after catalog discount and automatic discounts. */\n price?: MultiCurrencyPrice$3;\n /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: MultiCurrencyPrice$3;\n /** Total price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: MultiCurrencyPrice$3;\n /** Item price **before** line item discounts and **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: MultiCurrencyPrice$3;\n }\n interface ItemTaxFullDetails$5 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$3;\n /**\n * Tax group ID, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$3[];\n /**\n * The amount of this line item that was exempt.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$3;\n /**\n * True for items we have a tax applied on them\n * @internal\n */\n isItemTaxable?: boolean | null;\n /**\n * True if the lineAmount include tax in it.\n * @internal\n */\n isTaxIncluded?: boolean | null;\n /**\n * The calculator that calculated this line tax\n * @internal\n */\n calculatorName?: string | null;\n /**\n * tax information for a line item.\n * @internal\n * @readonly\n */\n taxBreakdown?: TaxBreakdown$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$3;\n /**\n * The type of tax that was calculated\n * @internal\n */\n taxType?: string | null;\n /**\n * The name of the jurisdiction in which this tax detail applies\n * @internal\n */\n jurisdiction?: string | null;\n /**\n * The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).\n * @internal\n */\n jurisdictionType?: string | null;\n /**\n * The amount of this line item that was exempt from this authority.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$3;\n /**\n * ids of the used exemptions from the TaxEstimate exemptions array.\n * @internal\n */\n exemptionIds?: number[];\n /**\n * The taxable amount of this tax detail\n * @internal\n */\n taxableAmount?: MultiCurrencyPrice$3;\n /**\n * The Taxes/Fee component. True if the fee is applied.\n * @internal\n */\n isFee?: boolean | null;\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$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$5;\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$5 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface PriceSummary$5 {\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 GiftCard$5 {\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 TaxSummary$5 {\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 * Manual tax rate\n * @internal\n * @readonly\n * @deprecated\n */\n manualTaxRate?: string;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$3;\n /**\n * Tax estimation id in tax service\n * @internal\n * @readonly\n */\n taxEstimationId?: string | null;\n /**\n * Average Tax Rate\n * @internal\n * @readonly\n */\n averageTaxRate?: string | null;\n /**\n * The amount of this estimate that was exempt (for all line items).\n * @internal\n * @readonly\n */\n totalExempt?: MultiCurrencyPrice$3;\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 * @internal\n * @readonly\n */\n aggregatedTaxBreakdown?: AggregatedTaxBreakdown$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$a;\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$a {\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$5;\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 * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: MultiCurrencyPrice$3;\n }\n interface ShippingInformation$3 {\n /** Shipping region. */\n region?: ShippingRegion$5;\n /** Selected shipping option. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption$3;\n /** All shipping options. */\n carrierServiceOptions?: CarrierServiceOption$3[];\n }\n interface ShippingRegion$5 {\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$6;\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 * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$4[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface DeliveryLogistics$6 {\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$7;\n /**\n * Expected delivery time slot (from and to time stamps representation)\n * @internal\n */\n deliveryTimeSlot?: DeliveryTimeSlot$6;\n }\n interface PickupDetails$7 {\n /** Pickup address. */\n address?: Address$9;\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$6;\n }\n enum PickupMethod$6 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$6 {\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$3 {\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$5;\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$3 {\n /** Type of additional cost. */\n type?: ChargeType$5;\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$5 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface DeliveryAllocation$4 {\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n deliveryCarrier?: Carrier$4;\n /** The delivery region that are relevant for this delivery solution. */\n deliveryRegion?: Region$4;\n /** Populated if the delivery solution is a partially supplied by this carrier. */\n applicableLineItems?: ApplicableLineItems$4;\n }\n interface Carrier$4 {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface Region$4 {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface ApplicableLineItems$4 {\n /** Line items that the delivery solution is for. */\n lineItemIds?: string[];\n }\n interface CarrierServiceOption$3 {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption$5[];\n }\n interface ShippingOption$5 {\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$6;\n /** Sipping price information. */\n cost?: ShippingPrice$5;\n /**\n * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$4[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface ShippingPrice$5 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$3;\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$5;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$3;\n }\n interface AppliedDiscount$5 extends AppliedDiscountDiscountSourceOneOf$5 {\n /** Coupon details. */\n coupon?: V1Coupon;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount;\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 * Discount ID.\n * @internal\n */\n _id?: string | null;\n /**\n * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$5[];\n /**\n * Number of subscription cycle this discount applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$5 {\n /** Coupon details. */\n coupon?: V1Coupon;\n /** Merchant discount. */\n merchantDiscount?: V1MerchantDiscount;\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 {\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 * Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.\n * @internal\n * @deprecated\n */\n couponType?: string;\n }\n interface V1MerchantDiscount {\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$5 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$5;\n /** Discount value. */\n amount?: MultiCurrencyPrice$3;\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$5 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$3;\n }\n interface CalculationErrors$4 extends CalculationErrorsShippingCalculationErrorOneOf$4 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$5;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$4;\n /** Tax calculation error. */\n taxCalculationError?: Details$5;\n /** Coupon calculation error. */\n couponCalculationError?: Details$5;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details$5;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$a[];\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$5;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details$5;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$4 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$5;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$4;\n }\n interface Details$5 extends DetailsKindOneOf$5 {\n applicationError?: ApplicationError$a;\n validationError?: ValidationError$5;\n systemError?: SystemError$5;\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$5 {\n applicationError?: ApplicationError$a;\n validationError?: ValidationError$5;\n systemError?: SystemError$5;\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$5 {\n fieldViolations?: FieldViolation$5[];\n }\n enum RuleType$5 {\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\n }\n interface FieldViolation$5 {\n field?: string;\n description?: string;\n violatedRule?: RuleType$5;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError$5 {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors$4 {\n /** Carrier errors. */\n errors?: CarrierError$5[];\n }\n interface CarrierError$5 {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details$5;\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[];\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 | null;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$5 {\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$3 {\n /** Membership's total amount of credits. */\n total?: number;\n /** Membership's remaining amount of credits. */\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$5 {\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$5;\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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\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 /** Delivery section. */\n DELIVERY = \"DELIVERY\"\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 enum SuggestedFix$2 {\n /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */\n UNKNOWN_SUGGESTED_FIX = \"UNKNOWN_SUGGESTED_FIX\",\n /** The line item should be removed from the cart or checkout to resolve the violation. */\n REMOVE_LINE_ITEM = \"REMOVE_LINE_ITEM\"\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 * Suggested fix for resolving the line item violation.\n * @internal\n */\n suggestedFix?: SuggestedFix$2;\n }\n interface RemoveLineItemsFromCurrentCartRequest {\n /** IDs of the line items to remove from the cart. */\n lineItemIds: string[];\n }\n interface RemoveLineItemsResponse$1 {\n /** Updated cart. */\n cart?: Cart;\n }\n interface CreateCheckoutFromCurrentCartRequest {\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$5;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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 sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreateCheckoutResponse$1 {\n /** The newly created checkout's ID. */\n checkoutId?: string;\n }\n interface RemoveCouponFromCurrentCartRequest {\n }\n interface RemoveCouponResponse$1 {\n /** Updated cart. */\n cart?: Cart;\n }\n interface UpdateCurrentCartLineItemQuantityRequest {\n /** Line item IDs and their new quantity. */\n lineItems: LineItemQuantityUpdate$1[];\n }\n interface LineItemQuantityUpdate$1 {\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$1 {\n /** Updated cart. */\n cart?: Cart;\n }\n interface EstimateCurrentCartTotalsRequest {\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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 {\n }\n interface DeleteCartResponse {\n }\n interface DomainEvent$h extends DomainEventBodyOneOf$h {\n createdEvent?: EntityCreatedEvent$h;\n updatedEvent?: EntityUpdatedEvent$h;\n deletedEvent?: EntityDeletedEvent$h;\n actionEvent?: ActionEvent$h;\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$h {\n createdEvent?: EntityCreatedEvent$h;\n updatedEvent?: EntityUpdatedEvent$h;\n deletedEvent?: EntityDeletedEvent$h;\n actionEvent?: ActionEvent$h;\n }\n interface EntityCreatedEvent$h {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$h;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$h {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$h {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$h {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$h {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$g {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$h;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$h extends IdentificationDataIdOneOf$h {\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$g;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$h {\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$g {\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$2[];\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$3[];\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$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$3[];\n }\n interface RemoveLineItemsRequest$1 {\n /** Cart ID. */\n _id: string;\n /** IDs of the line items to remove from the cart. */\n lineItemIds: string[];\n }\n interface CreateCheckoutRequest$1 {\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$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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$1 {\n /** Cart ID. */\n _id: string;\n }\n interface UpdateLineItemsQuantityRequest$1 {\n /** Cart ID. */\n _id: string;\n /** Line item IDs and their new quantity. */\n lineItems: LineItemQuantityUpdate$1[];\n }\n interface EstimateTotalsRequest {\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$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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 {\n /** ID of the cart to delete. */\n _id: string;\n }\n interface Empty$a {\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 * @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 * @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$2[];\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$3[];\n /**\n * List of field names to determine which of cartInfo's fields will be updated\n * @internal\n */\n cartFieldmask?: string[];\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.customLineItems.descriptionLines\n * @requiredField options.customLineItems.descriptionLines.name\n * @requiredField options.customLineItems.itemType\n * @requiredField options.customLineItems.price\n * @requiredField options.customLineItems.productName\n * @requiredField options.customLineItems.quantity\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 */\n function addToCurrentCart(options?: AddToCurrentCartOptions): Promise;\n interface AddToCurrentCartOptions {\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$3[];\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 */\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 */\n function createCheckoutFromCurrentCart(options?: CreateCheckoutFromCurrentCartOptions): Promise;\n interface CreateCheckoutFromCurrentCartOptions {\n /** **Required**. Sales channel type. */\n channelType?: ChannelType$5;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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 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 * @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 * @returns Fulfilled - The updated current cart.\n */\n function updateCurrentCartLineItemQuantity(lineItems: LineItemQuantityUpdate$1[]): 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 */\n function estimateCurrentCartTotals(options?: EstimateCurrentCartTotalsOptions): Promise;\n interface EstimateCurrentCartTotalsOptions {\n /** Selected shipping option. */\n selectedShippingOption?: SelectedShippingOption$1;\n /** Shipping address. Used for calculating tax and shipping (when applicable). */\n shippingAddress?: Address$9;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$9;\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 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 * @returns Fulfilled - When the current cart is deleted. Rejected - Error message.\n */\n function deleteCurrentCart(): Promise;\n \n type ecomV1CartCurrentCart_universal_d_Cart = Cart;\n type ecomV1CartCurrentCart_universal_d_CartDiscount = CartDiscount;\n type ecomV1CartCurrentCart_universal_d_CartDiscountDiscountSourceOneOf = CartDiscountDiscountSourceOneOf;\n type ecomV1CartCurrentCart_universal_d_V1DiscountRule = V1DiscountRule;\n type ecomV1CartCurrentCart_universal_d_V1DiscountRuleName = V1DiscountRuleName;\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_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_V1Coupon = V1Coupon;\n type ecomV1CartCurrentCart_universal_d_V1MerchantDiscount = V1MerchantDiscount;\n type ecomV1CartCurrentCart_universal_d_RemoveLineItemsFromCurrentCartRequest = RemoveLineItemsFromCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartRequest = CreateCheckoutFromCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_RemoveCouponFromCurrentCartRequest = RemoveCouponFromCurrentCartRequest;\n type ecomV1CartCurrentCart_universal_d_UpdateCurrentCartLineItemQuantityRequest = UpdateCurrentCartLineItemQuantityRequest;\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_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 {\n ecomV1CartCurrentCart_universal_d_Cart as Cart,\n LineItem$5 as LineItem,\n CatalogReference$7 as CatalogReference,\n ProductName$4 as ProductName,\n MultiCurrencyPrice$3 as MultiCurrencyPrice,\n DescriptionLine$4 as DescriptionLine,\n DescriptionLineValueOneOf$4 as DescriptionLineValueOneOf,\n DescriptionLineDescriptionLineValueOneOf$4 as DescriptionLineDescriptionLineValueOneOf,\n DescriptionLineName$4 as DescriptionLineName,\n PlainTextValue$4 as PlainTextValue,\n Color$4 as Color,\n DescriptionLineType$4 as DescriptionLineType,\n FocalPoint$5 as FocalPoint,\n ItemAvailabilityInfo$2 as ItemAvailabilityInfo,\n ItemAvailabilityStatus$2 as ItemAvailabilityStatus,\n PhysicalProperties$6 as PhysicalProperties,\n Scope$3 as Scope,\n Group$3 as Group,\n ItemType$5 as ItemType,\n ItemTypeItemTypeDataOneOf$5 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$5 as ItemTypeItemType,\n SubscriptionOptionInfo$3 as SubscriptionOptionInfo,\n SubscriptionSettings$6 as SubscriptionSettings,\n SubscriptionFrequency$6 as SubscriptionFrequency,\n FreeTrialPeriod$2 as FreeTrialPeriod,\n Title$2 as Title,\n Description$2 as Description,\n SecuredMedia$3 as SecuredMedia,\n FileType$3 as FileType,\n V1PaymentOptionType$1 as V1PaymentOptionType,\n ServiceProperties$4 as ServiceProperties,\n PriceDescription$4 as PriceDescription,\n SelectedMembership$3 as SelectedMembership,\n CatalogOverrideFields$2 as CatalogOverrideFields,\n PaymentOption$2 as PaymentOption,\n TaxableAddress$5 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$5 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$5 as TaxableAddressType,\n ExtendedFields$9 as ExtendedFields,\n Policy$2 as Policy,\n BuyerInfo$6 as BuyerInfo,\n BuyerInfoIdOneOf$4 as BuyerInfoIdOneOf,\n WeightUnit$7 as WeightUnit,\n ecomV1CartCurrentCart_universal_d_CartDiscount as CartDiscount,\n ecomV1CartCurrentCart_universal_d_CartDiscountDiscountSourceOneOf as CartDiscountDiscountSourceOneOf,\n Coupon$5 as Coupon,\n MerchantDiscount$5 as MerchantDiscount,\n ecomV1CartCurrentCart_universal_d_V1DiscountRule as V1DiscountRule,\n ecomV1CartCurrentCart_universal_d_V1DiscountRuleName as V1DiscountRuleName,\n AddressWithContact$4 as AddressWithContact,\n Address$9 as Address,\n StreetAddress$8 as StreetAddress,\n AddressLocation$8 as AddressLocation,\n FullAddressContactDetails$5 as FullAddressContactDetails,\n VatId$6 as VatId,\n VatType$6 as VatType,\n SelectedShippingOption$1 as SelectedShippingOption,\n ecomV1CartCurrentCart_universal_d_GetCurrentCartRequest as GetCurrentCartRequest,\n ecomV1CartCurrentCart_universal_d_GetCurrentCartResponse as GetCurrentCartResponse,\n ecomV1CartCurrentCart_universal_d_UpdateCartRequest as UpdateCartRequest,\n MerchantDiscountInput$2 as MerchantDiscountInput,\n CustomLineItem$3 as CustomLineItem,\n ecomV1CartCurrentCart_universal_d_UpdateCartResponse as UpdateCartResponse,\n ecomV1CartCurrentCart_universal_d_AddToCurrentCartRequest as AddToCurrentCartRequest,\n ecomV1CartCurrentCart_universal_d_AddToCartResponse as AddToCartResponse,\n ecomV1CartCurrentCart_universal_d_AddToCurrentCartAndEstimateTotalsRequest as AddToCurrentCartAndEstimateTotalsRequest,\n SelectedMemberships$3 as SelectedMemberships,\n ecomV1CartCurrentCart_universal_d_HostSelectedMembership as HostSelectedMembership,\n ecomV1CartCurrentCart_universal_d_EstimateTotalsResponse as EstimateTotalsResponse,\n CalculatedLineItem$1 as CalculatedLineItem,\n LineItemPricesData$1 as LineItemPricesData,\n ItemTaxFullDetails$5 as ItemTaxFullDetails,\n TaxRateBreakdown$3 as TaxRateBreakdown,\n TaxBreakdown$3 as TaxBreakdown,\n JurisdictionType$5 as JurisdictionType,\n PriceSummary$5 as PriceSummary,\n GiftCard$5 as GiftCard,\n TaxSummary$5 as TaxSummary,\n TaxCalculationDetails$3 as TaxCalculationDetails,\n TaxCalculationDetailsCalculationDetailsOneOf$3 as TaxCalculationDetailsCalculationDetailsOneOf,\n RateType$3 as RateType,\n ManualCalculationReason$3 as ManualCalculationReason,\n AutoTaxFallbackCalculationDetails$3 as AutoTaxFallbackCalculationDetails,\n FallbackReason$3 as FallbackReason,\n ApplicationError$a as ApplicationError,\n AggregatedTaxBreakdown$3 as AggregatedTaxBreakdown,\n ShippingInformation$3 as ShippingInformation,\n ShippingRegion$5 as ShippingRegion,\n SelectedCarrierServiceOption$3 as SelectedCarrierServiceOption,\n DeliveryLogistics$6 as DeliveryLogistics,\n PickupDetails$7 as PickupDetails,\n PickupMethod$6 as PickupMethod,\n DeliveryTimeSlot$6 as DeliveryTimeSlot,\n SelectedCarrierServiceOptionPrices$3 as SelectedCarrierServiceOptionPrices,\n SelectedCarrierServiceOptionOtherCharge$3 as SelectedCarrierServiceOptionOtherCharge,\n ChargeType$5 as ChargeType,\n DeliveryAllocation$4 as DeliveryAllocation,\n Carrier$4 as Carrier,\n Region$4 as Region,\n ApplicableLineItems$4 as ApplicableLineItems,\n CarrierServiceOption$3 as CarrierServiceOption,\n ShippingOption$5 as ShippingOption,\n ShippingPrice$5 as ShippingPrice,\n OtherCharge$3 as OtherCharge,\n AppliedDiscount$5 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$5 as AppliedDiscountDiscountSourceOneOf,\n DiscountType$5 as DiscountType,\n ecomV1CartCurrentCart_universal_d_V1Coupon as V1Coupon,\n ecomV1CartCurrentCart_universal_d_V1MerchantDiscount as V1MerchantDiscount,\n DiscountRule$5 as DiscountRule,\n DiscountRuleName$5 as DiscountRuleName,\n LineItemDiscount$5 as LineItemDiscount,\n CalculationErrors$4 as CalculationErrors,\n CalculationErrorsShippingCalculationErrorOneOf$4 as CalculationErrorsShippingCalculationErrorOneOf,\n Details$5 as Details,\n DetailsKindOneOf$5 as DetailsKindOneOf,\n ValidationError$5 as ValidationError,\n RuleType$5 as RuleType,\n FieldViolation$5 as FieldViolation,\n SystemError$5 as SystemError,\n CarrierErrors$4 as CarrierErrors,\n CarrierError$5 as CarrierError,\n MembershipOptions$3 as MembershipOptions,\n Membership$3 as Membership,\n MembershipName$5 as MembershipName,\n MembershipPaymentCredits$3 as MembershipPaymentCredits,\n InvalidMembership$3 as InvalidMembership,\n AdditionalFee$5 as AdditionalFee,\n Violation$2 as Violation,\n Severity$2 as Severity,\n Target$2 as Target,\n TargetTargetTypeOneOf$2 as TargetTargetTypeOneOf,\n NameInOther$2 as NameInOther,\n NameInLineItem$2 as NameInLineItem,\n SuggestedFix$2 as SuggestedFix,\n Other$2 as Other,\n TargetLineItem$2 as TargetLineItem,\n ecomV1CartCurrentCart_universal_d_RemoveLineItemsFromCurrentCartRequest as RemoveLineItemsFromCurrentCartRequest,\n RemoveLineItemsResponse$1 as RemoveLineItemsResponse,\n ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartRequest as CreateCheckoutFromCurrentCartRequest,\n ChannelType$5 as ChannelType,\n CreateCheckoutResponse$1 as CreateCheckoutResponse,\n ecomV1CartCurrentCart_universal_d_RemoveCouponFromCurrentCartRequest as RemoveCouponFromCurrentCartRequest,\n RemoveCouponResponse$1 as RemoveCouponResponse,\n ecomV1CartCurrentCart_universal_d_UpdateCurrentCartLineItemQuantityRequest as UpdateCurrentCartLineItemQuantityRequest,\n LineItemQuantityUpdate$1 as LineItemQuantityUpdate,\n UpdateLineItemsQuantityResponse$1 as UpdateLineItemsQuantityResponse,\n ecomV1CartCurrentCart_universal_d_EstimateCurrentCartTotalsRequest as EstimateCurrentCartTotalsRequest,\n ecomV1CartCurrentCart_universal_d_DeleteCurrentCartRequest as DeleteCurrentCartRequest,\n ecomV1CartCurrentCart_universal_d_DeleteCartResponse as DeleteCartResponse,\n DomainEvent$h as DomainEvent,\n DomainEventBodyOneOf$h as DomainEventBodyOneOf,\n EntityCreatedEvent$h as EntityCreatedEvent,\n RestoreInfo$h as RestoreInfo,\n EntityUpdatedEvent$h as EntityUpdatedEvent,\n EntityDeletedEvent$h as EntityDeletedEvent,\n ActionEvent$h as ActionEvent,\n MessageEnvelope$g as MessageEnvelope,\n IdentificationData$h as IdentificationData,\n IdentificationDataIdOneOf$h as IdentificationDataIdOneOf,\n WebhookIdentityType$g as WebhookIdentityType,\n ecomV1CartCurrentCart_universal_d_CreateCartRequest as CreateCartRequest,\n ecomV1CartCurrentCart_universal_d_CreateCartResponse as CreateCartResponse,\n ecomV1CartCurrentCart_universal_d_GetCartRequest as GetCartRequest,\n ecomV1CartCurrentCart_universal_d_GetCartResponse as GetCartResponse,\n ecomV1CartCurrentCart_universal_d_GetCartByCheckoutIdRequest as GetCartByCheckoutIdRequest,\n ecomV1CartCurrentCart_universal_d_GetCartByCheckoutIdResponse as GetCartByCheckoutIdResponse,\n ecomV1CartCurrentCart_universal_d_AddToCartRequest as AddToCartRequest,\n RemoveLineItemsRequest$1 as RemoveLineItemsRequest,\n CreateCheckoutRequest$1 as CreateCheckoutRequest,\n RemoveCouponRequest$1 as RemoveCouponRequest,\n UpdateLineItemsQuantityRequest$1 as UpdateLineItemsQuantityRequest,\n ecomV1CartCurrentCart_universal_d_EstimateTotalsRequest as EstimateTotalsRequest,\n ecomV1CartCurrentCart_universal_d_DeleteCartRequest as DeleteCartRequest,\n Empty$a as Empty,\n ecomV1CartCurrentCart_universal_d_getCurrentCart as getCurrentCart,\n ecomV1CartCurrentCart_universal_d_updateCurrentCart as updateCurrentCart,\n ecomV1CartCurrentCart_universal_d_UpdateCurrentCartOptions as UpdateCurrentCartOptions,\n ecomV1CartCurrentCart_universal_d_addToCurrentCart as addToCurrentCart,\n ecomV1CartCurrentCart_universal_d_AddToCurrentCartOptions as AddToCurrentCartOptions,\n ecomV1CartCurrentCart_universal_d_removeLineItemsFromCurrentCart as removeLineItemsFromCurrentCart,\n ecomV1CartCurrentCart_universal_d_createCheckoutFromCurrentCart as createCheckoutFromCurrentCart,\n ecomV1CartCurrentCart_universal_d_CreateCheckoutFromCurrentCartOptions as CreateCheckoutFromCurrentCartOptions,\n ecomV1CartCurrentCart_universal_d_removeCouponFromCurrentCart as removeCouponFromCurrentCart,\n ecomV1CartCurrentCart_universal_d_updateCurrentCartLineItemQuantity as updateCurrentCartLineItemQuantity,\n ecomV1CartCurrentCart_universal_d_estimateCurrentCartTotals as estimateCurrentCartTotals,\n ecomV1CartCurrentCart_universal_d_EstimateCurrentCartTotalsOptions as EstimateCurrentCartTotalsOptions,\n ecomV1CartCurrentCart_universal_d_deleteCurrentCart as deleteCurrentCart,\n };\n }\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$4[];\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$4;\n /**\n * Errors when calculating totals.\n * @readonly\n */\n calculationErrors?: CalculationErrors$3;\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$4;\n /**\n * Applied discounts.\n * @readonly\n */\n appliedDiscounts?: AppliedDiscount$4[];\n /** Custom fields. */\n customFields?: CustomField$4[];\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$6;\n /**\n * Tax summary.\n * @readonly\n */\n taxSummary?: TaxSummary$4;\n /**\n * The currency used when submitting the order.\n * @readonly\n */\n currency?: string;\n /**\n * Sales channel that submitted the order.\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$4;\n /**\n * Date and time the checkout was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the checkout was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 /** Memberships to apply when creating the order. */\n membershipOptions?: MembershipOptions$2;\n /** Additional Fees. */\n additionalFees?: AdditionalFee$4[];\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 * Information about the currency conversion that took place if at all. Empty if no conversion took place.\n * @internal\n */\n conversionInfo?: ConversionInfo$1;\n /**\n * The pay now total amount after gift card reduction\n * @internal\n * @readonly\n */\n payNowTotalAfterGiftCard?: MultiCurrencyPrice$2;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: 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$1[];\n /**\n * The total payment amount after gift card reduction\n * @internal\n * @readonly\n */\n totalAfterGiftCard?: MultiCurrencyPrice$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$8;\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 * References to an external app and resource associated with this checkout.\n * Used for integration and tracking across different platforms.\n * @internal\n */\n externalReference?: ExternalReference$2;\n /**\n * Order ID.\n *\n * This field is empty until the checkout completes and becomes an order.\n * @internal\n * @readonly\n */\n orderId?: string | null;\n /**\n * Payment for subscriptions after free trial period.\n * @internal\n * @readonly\n */\n payAfterFreeTrial?: PriceSummary$4;\n }\n interface LineItem$4 {\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$2;\n /**\n * Total line item price **after** catalog-defined discount and line item discounts.\n * @readonly\n */\n lineItemPrice?: 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 * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: MultiCurrencyPrice$2;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: MultiCurrencyPrice$2;\n /**\n * Tax details for this line item.\n * @readonly\n */\n taxDetails?: ItemTaxFullDetails$4;\n /**\n * Discount for this line item's entire quantity.\n * @readonly\n */\n discount?: MultiCurrencyPrice$2;\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$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$5;\n /**\n * Coupon scopes - which app and items a coupon applies to.\n * This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current [Coupons API](https://bo.wix.com/wix-docs/rest/stores/coupons/valid-scope-values).\n * @internal\n * @readonly\n */\n couponScopes?: Scope$2[];\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$4;\n /**\n * Subscription option information.\n * @readonly\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$2;\n /**\n * Fulfiller ID for this item. Field is empty when the item is self-fulfilled.\n * @internal\n * @readonly\n */\n fulfillerId?: string | null;\n /**\n * Shipping group ID.\n * @internal\n * @readonly\n */\n shippingGroupId?: string | null;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia$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` 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?: V1PaymentOptionType;\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$2;\n /**\n * Delivery Profile Id for the product\n * @internal\n * @readonly\n */\n deliveryProfileId?: string | null;\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$1;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n * @internal\n * @readonly\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n * @internal\n * @readonly\n */\n fixedQuantity?: boolean;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n /**\n * Address to be used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$4;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$8;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n * @readonly\n */\n policies?: Policy$1[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\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 [app dashboard](https://dev.wix.com/dc3/my-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$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 ItemTaxFullDetails$4 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$2;\n /**\n * Tax group ID, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$2[];\n /**\n * The amount of this line item that was exempt.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$2;\n /**\n * True for items we have a tax applied on them\n * @internal\n */\n isItemTaxable?: boolean | null;\n /**\n * True if the lineAmount include tax in it.\n * @internal\n */\n isTaxIncluded?: boolean | null;\n /**\n * The calculator that calculated this line tax\n * @internal\n */\n calculatorName?: string | null;\n /**\n * tax information for a line item.\n * @internal\n * @readonly\n */\n taxBreakdown?: TaxBreakdown$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$2;\n /**\n * The type of tax that was calculated\n * @internal\n */\n taxType?: string | null;\n /**\n * The name of the jurisdiction in which this tax detail applies\n * @internal\n */\n jurisdiction?: string | null;\n /**\n * The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).\n * @internal\n */\n jurisdictionType?: string | null;\n /**\n * The amount of this line item that was exempt from this authority.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$2;\n /**\n * ids of the used exemptions from the TaxEstimate exemptions array.\n * @internal\n */\n exemptionIds?: number[];\n /**\n * The taxable amount of this tax detail\n * @internal\n */\n taxableAmount?: MultiCurrencyPrice$2;\n /**\n * The Taxes/Fee component. True if the fee is applied.\n * @internal\n */\n isFee?: boolean | null;\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$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$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 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 /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$3;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName$3;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType$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 * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$3;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\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 /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\n }\n interface FocalPoint$4 {\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 ItemAvailabilityInfo$1 {\n /** Item availability status. */\n status?: ItemAvailabilityStatus$1;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus$1 {\n AVAILABLE = \"AVAILABLE\",\n /** Item does not exist */\n NOT_FOUND = \"NOT_FOUND\",\n /** Item not in stock */\n NOT_AVAILABLE = \"NOT_AVAILABLE\",\n /** Available quantity is less than requested */\n PARTIALLY_AVAILABLE = \"PARTIALLY_AVAILABLE\"\n }\n interface PhysicalProperties$5 {\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$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$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$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$2 {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings$5;\n /** Subscription option title. */\n title?: Title$1;\n /** Subscription option description. */\n description?: Description$1;\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 * If SubscriptionFrequency is Day the minimum interval is 7\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 * Whether to allow the customer to cancel the subscription..\n * @internal\n */\n enableCustomerCancellation?: boolean;\n /**\n * Period until first cycle starts. If applied payNow will be 0\n * If None => no free trial\n * @internal\n */\n freeTrialPeriod?: FreeTrialPeriod$1;\n /**\n * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.\n * @internal\n */\n startDate?: Date | null;\n /**\n * Whether to generate an order each billing cycle. An order will always be generated for the first billing cycle.\n * Default None => will behave like true\n * @internal\n */\n generateOrderEachBillingCycle?: boolean | 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 FreeTrialPeriod$1 {\n /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */\n frequency?: SubscriptionFrequency$5;\n /** interval of period */\n interval?: number;\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$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 V1PaymentOptionType {\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 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 checkout. The 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 | null;\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$1 {\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$5;\n /** Item image. */\n image?: string;\n /** Payment method selected for the item. */\n paymentOption?: V1PaymentOption;\n /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */\n depositAmount?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface V1PaymentOption {\n /**\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 selected, `price` is `0`.\n * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.\n * + `MEMBERSHIP_OFFLINE`: 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 */\n value?: V1PaymentOptionType;\n }\n interface TaxableAddress$4 extends TaxableAddressTaxableAddressDataOneOf$4 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$4;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$4 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$4;\n }\n enum TaxableAddressType$4 {\n UNKNOWN_TAXABLE_ADDRESS = \"UNKNOWN_TAXABLE_ADDRESS\",\n BUSINESS = \"BUSINESS\",\n BILLING = \"BILLING\",\n SHIPPING = \"SHIPPING\"\n }\n interface ExtendedFields$8 {\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 Policy$1 {\n /** Policy title - should be translated */\n title?: string | null;\n /** Policy content - should be translated */\n content?: string;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$3 {\n /** Address. */\n address?: ApiAddress;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$4;\n /**\n * Reference to address service.\n * @internal\n */\n addressesServiceId?: string | null;\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$7;\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 /** @internal */\n location?: AddressLocation$7;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$7 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$7 {\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?: 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$4;\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$5;\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 * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$3[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface DeliveryLogistics$5 {\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$6;\n /**\n * Expected delivery time slot (from and to time stamps representation)\n * @internal\n */\n deliveryTimeSlot?: DeliveryTimeSlot$5;\n }\n interface PickupDetails$6 {\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$5;\n }\n enum PickupMethod$5 {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface DeliveryTimeSlot$5 {\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$2 {\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$4;\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$2 {\n /** Type of additional cost. */\n type?: ChargeType$4;\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$4 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface DeliveryAllocation$3 {\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n deliveryCarrier?: Carrier$3;\n /** The delivery region that are relevant for this delivery solution. */\n deliveryRegion?: Region$3;\n /** Populated if the delivery solution is a partially supplied by this carrier. */\n applicableLineItems?: ApplicableLineItems$3;\n }\n interface Carrier$3 {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface Region$3 {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface ApplicableLineItems$3 {\n /** Line items that the delivery solution is for. */\n lineItemIds?: string[];\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 CarrierServiceOption$2 {\n /** Carrier ID. */\n carrierId?: string;\n /** Shipping options offered by this carrier for this request. */\n shippingOptions?: ShippingOption$4[];\n }\n interface ShippingOption$4 {\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$5;\n /** Sipping price information. */\n cost?: ShippingPrice$4;\n /**\n * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$3[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface ShippingPrice$4 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$2;\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$4;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$2;\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 * + If `true`, the checkout doesn't have an owner yet and anyone can access it. The first to access it will be the new owner.\n * + If `false`, the value in `checkout.createdBy` is the owner.\n * @internal\n */\n openAccess?: boolean;\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 * + If `true`, the checkout doesn't have an owner yet and anyone can access it. The first to access it will be the new owner.\n * + If `false`, the value in `checkout.createdBy` is the owner.\n * @internal\n */\n openAccess?: boolean;\n }\n interface PriceSummary$4 {\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 CalculationErrors$3 extends CalculationErrorsShippingCalculationErrorOneOf$3 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$4;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$3;\n /** Tax calculation error. */\n taxCalculationError?: Details$4;\n /** Coupon calculation error. */\n couponCalculationError?: Details$4;\n /** Gift card calculation error. */\n giftCardCalculationError?: Details$4;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$9[];\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$4;\n /** Discount Rule calculation error. */\n discountsCalculationError?: Details$4;\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$3 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$4;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$3;\n }\n interface Details$4 extends DetailsKindOneOf$4 {\n applicationError?: ApplicationError$9;\n validationError?: ValidationError$4;\n systemError?: SystemError$4;\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$4 {\n applicationError?: ApplicationError$9;\n validationError?: ValidationError$4;\n systemError?: SystemError$4;\n }\n interface ApplicationError$9 {\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$4 {\n fieldViolations?: FieldViolation$4[];\n }\n enum RuleType$4 {\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\n }\n interface FieldViolation$4 {\n field?: string;\n description?: string;\n violatedRule?: RuleType$4;\n /** applicable when violated_rule=OTHER */\n ruleName?: string | null;\n data?: Record | null;\n }\n interface SystemError$4 {\n /** Error code. */\n errorCode?: string | null;\n }\n interface CarrierErrors$3 {\n /** Carrier errors. */\n errors?: CarrierError$4[];\n }\n interface CarrierError$4 {\n /** Carrier ID. */\n carrierId?: string;\n /** Error details. */\n error?: Details$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$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 AppliedDiscount$4 extends AppliedDiscountDiscountSourceOneOf$4 {\n /** Coupon details. */\n coupon?: Coupon$4;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$4;\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 * Discount ID.\n * @internal\n */\n _id?: string | null;\n /**\n * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$4[];\n /**\n * Number of subscription cycle this discount applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$4 {\n /** Coupon details. */\n coupon?: Coupon$4;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$4;\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$4 {\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 * Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.\n * @internal\n * @deprecated\n */\n couponType?: string;\n }\n interface MerchantDiscount$4 {\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$4 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$4;\n /** Discount value. */\n amount?: MultiCurrencyPrice$2;\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$4 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice$2;\n }\n interface CustomField$4 {\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$6 {\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$4 {\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 * Manual tax rate\n * @internal\n * @readonly\n * @deprecated\n */\n manualTaxRate?: string;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$2;\n /**\n * Tax estimation id in tax service\n * @internal\n * @readonly\n */\n taxEstimationId?: string | null;\n /**\n * Average Tax Rate\n * @internal\n * @readonly\n */\n averageTaxRate?: string | null;\n /**\n * The amount of this estimate that was exempt (for all line items).\n * @internal\n * @readonly\n */\n totalExempt?: MultiCurrencyPrice$2;\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 * @internal\n * @readonly\n */\n aggregatedTaxBreakdown?: AggregatedTaxBreakdown$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$9;\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$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$2;\n /**\n * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: MultiCurrencyPrice$2;\n }\n enum ChannelType$4 {\n /** Unspecified sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreatedBy$4 extends CreatedByIdOneOf$2 {\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$2 {\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 | null;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName$4 {\n /** Membership name. */\n original?: string;\n /** Translated membership name. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface MembershipPaymentCredits$2 {\n /** Membership's total amount of credits. */\n total?: number;\n /** Membership's remaining amount of credits. */\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$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$2;\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$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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\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$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 /** Delivery section. */\n DELIVERY = \"DELIVERY\"\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 enum SuggestedFix$1 {\n /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */\n UNKNOWN_SUGGESTED_FIX = \"UNKNOWN_SUGGESTED_FIX\",\n /** The line item should be removed from the cart or checkout to resolve the violation. */\n REMOVE_LINE_ITEM = \"REMOVE_LINE_ITEM\"\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 * Suggested fix for resolving the line item violation.\n * @internal\n */\n suggestedFix?: SuggestedFix$1;\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 [app dashboard](https://dev.wix.com/dc3/my-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 [app dashboard](https://dev.wix.com/dc3/my-apps/).\n */\n componentId?: string;\n }\n interface ExternalReference$2 {\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 {\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$4[];\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 * 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 */\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 * Merchant discounts to apply to specific line items.\n * If no `lineItemIds` are passed, the discount will be applied to the whole checkout.\n *\n * >**Note:** Merchant discounts are restricted and can only be applied if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @internal\n */\n merchantDiscounts?: MerchantDiscountInput$1[];\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$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$5;\n /**\n * Subscription option info. This field is internal and only used by Stores.\n * @internal\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$2;\n /**\n * Digital file ID and name. Required if `itemType: DIGITAL`.\n * @internal\n */\n digitalFile?: SecuredMedia$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?: V1PaymentOptionType;\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 /**\n * Delivery Profile ID.\n * @internal\n */\n deliveryProfileId?: 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 * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: 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 * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n */\n policies?: Policy$1[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\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 {\n /** Newly created checkout. */\n checkout?: Checkout$1;\n }\n interface ShippingCalculationErrorData extends ShippingCalculationErrorDataShippingCalculationErrorOneOf {\n generalShippingCalculationError?: Details$4;\n carrierErrors?: CarrierErrors$3;\n }\n /** @oneof */\n interface ShippingCalculationErrorDataShippingCalculationErrorOneOf {\n generalShippingCalculationError?: Details$4;\n carrierErrors?: CarrierErrors$3;\n }\n interface GetCheckoutRequest {\n /** Checkout ID. */\n _id: string;\n /**\n * Whether to refresh the checkout from external sources. Defaults to true.\n * @internal\n */\n refresh?: boolean | null;\n }\n interface GetCheckoutResponse {\n /** The requested checkout. */\n checkout?: Checkout$1;\n }\n interface GetCheckoutWithAllExtendedFieldsRequest {\n /** Checkout ID. */\n _id?: string;\n /**\n * Whether to refresh the checkout from external sources. Defaults to true.\n * @internal\n */\n refresh?: boolean | null;\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 * cart id to compare with for migration period\n * @internal\n */\n cartId?: string | null;\n /**\n * checkout currency parameter to append\n * @internal\n */\n currencyCode?: string | null;\n }\n interface GetWixCheckoutURLResponse {\n /** Checkout URL. */\n checkoutUrl?: string;\n }\n interface GetCheckoutURLRequest {\n /** Checkout ID. */\n _id: string;\n /**\n * Checkout currency parameter to append as a query param\n * @internal\n */\n currencyCode?: string | null;\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 * Set of fields to update. Fields are inferred.\n * @internal\n */\n fieldMask?: string[];\n /**\n * Merchant discounts to apply to specific line items.\n * If no `lineItemIds` are passed, the discount will be applied to the whole checkout.\n *\n * >**Note:** Merchant discounts are restricted and can only be applied if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @internal\n */\n merchantDiscounts?: MerchantDiscountInput$1[];\n /**\n * When true, calculation errors won't fail the update request. When empty or false, the update won't happen and relevant error will return\n * @internal\n */\n ignoreCalculationErrors?: boolean | 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$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$2[];\n }\n interface UpdateCheckoutResponse {\n /** Updated checkout. */\n checkout?: Checkout$1;\n }\n interface RemoveCouponRequest {\n /** ID of the checkout to remove the coupon from. */\n _id: string;\n }\n interface RemoveCouponResponse {\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$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$2[];\n }\n interface AddToCheckoutResponse {\n /** Updated checkout. */\n checkout?: Checkout$1;\n }\n interface RemoveLineItemsRequest {\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 {\n /** Updated checkout after removal of line items. */\n checkout?: Checkout$1;\n }\n interface CreateOrderRequest$1 {\n /** Checkout ID. */\n _id: string;\n /**\n * Custom URL params to be added to redirect URLs.\n * @internal\n */\n urlParams?: Record;\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$1[];\n }\n interface CreateOrderAndChargeRequest {\n /** Checkout ID. */\n _id: string;\n /** Payment token. */\n paymentToken?: string | null;\n /**\n * Custom URL params to be added to redirect URLs.\n * @internal\n */\n urlParams?: Record;\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 * Order ID.\n * @internal\n */\n orderId?: string | null;\n }\n interface MarkCheckoutAsCompletedResponse {\n }\n /** Triggered when buyer successfully completed checkout flow */\n interface CheckoutMarkedAsCompleted {\n checkout?: Checkout$1;\n }\n interface UpdateLineItemsQuantityRequest {\n /** Checkout ID. */\n _id: string;\n /** Line item info to update. */\n lineItems: LineItemQuantityUpdate[];\n }\n interface LineItemQuantityUpdate {\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 {\n /** Updated checkout. */\n checkout?: Checkout$1;\n }\n interface GetCheckoutPaymentSettingsRequest {\n /** Checkout ID. */\n _id: string;\n }\n interface GetCheckoutPaymentSettingsResponse {\n blockedPaymentOptions?: PaymentOption$1[];\n }\n enum PaymentOption$1 {\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 | null;\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$8;\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$3;\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$4;\n /** @internal */\n visitorId?: string | null;\n }\n enum IdentityType$4 {\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 /**\n * Total shipping price, after tax (identical to shipping)\n * @internal\n */\n shippingAfterTax?: number;\n /**\n * Total shipping price, before tax\n * @internal\n */\n shippingBeforeTax?: 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$6;\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$8 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$5;\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$5 {\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$5;\n }\n /** Brazilian tax info types */\n enum VatType$5 {\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$1;\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$1;\n }\n interface ShipmentDetails$1 {\n /** Shipping destination address */\n address?: Address$8;\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$1 {\n /** Pickup address */\n address?: PickupAddress$3;\n /** Store owner's pickup instructions */\n pickupInstructions?: string | null;\n }\n interface PickupAddress$3 {\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$2;\n }\n interface Discount$2 {\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$3 {\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$5;\n /**\n * Interval of recurring payment (optional: default value 1 will be used if not provided)\n * @internal\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: 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$9 {\n }\n interface DomainEvent$g extends DomainEventBodyOneOf$g {\n createdEvent?: EntityCreatedEvent$g;\n updatedEvent?: EntityUpdatedEvent$g;\n deletedEvent?: EntityDeletedEvent$g;\n actionEvent?: ActionEvent$g;\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$g {\n createdEvent?: EntityCreatedEvent$g;\n updatedEvent?: EntityUpdatedEvent$g;\n deletedEvent?: EntityDeletedEvent$g;\n actionEvent?: ActionEvent$g;\n }\n interface EntityCreatedEvent$g {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$g;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$g {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$g {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$g {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$g {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$f {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$g;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$g extends IdentificationDataIdOneOf$g {\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$f;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$g {\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$f {\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.price\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 * @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$4[];\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 * 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 */\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 * Merchant discounts to apply to specific line items.\n * If no `lineItemIds` are passed, the discount will be applied to the whole checkout.\n *\n * >**Note:** Merchant discounts are restricted and can only be applied if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @internal\n */\n merchantDiscounts?: MerchantDiscountInput$1[];\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 * @returns Fulfilled - the requested checkout.\n */\n function getCheckout(_id: string, options?: GetCheckoutOptions): Promise;\n interface GetCheckoutOptions {\n /**\n * Whether to refresh the checkout from external sources. Defaults to true.\n * @internal\n */\n refresh?: boolean | null;\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 */\n function getCheckoutByCartId(_id: string): Promise;\n /**\n * Deprecated and will be removed soon, use GetCheckoutURL\n * @param _id - Checkout ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_CHECKOUTS\n */\n function getWixCheckoutUrl(_id: string, options?: GetWixCheckoutUrlOptions): Promise;\n interface GetWixCheckoutUrlOptions {\n /**\n * cart id to compare with for migration period\n * @internal\n */\n cartId?: string | null;\n /**\n * checkout currency parameter to append\n * @internal\n */\n currencyCode?: string | null;\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 */\n function getCheckoutUrl(_id: string, options?: GetCheckoutUrlOptions): Promise;\n interface GetCheckoutUrlOptions {\n /**\n * Checkout currency parameter to append as a query param\n * @internal\n */\n currencyCode?: string | null;\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 * @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$4[];\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$4;\n /**\n * Errors when calculating totals.\n * @readonly\n */\n calculationErrors?: CalculationErrors$3;\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$4;\n /**\n * Applied discounts.\n * @readonly\n */\n appliedDiscounts?: AppliedDiscount$4[];\n /** Custom fields. */\n customFields?: CustomField$4[];\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$6;\n /**\n * Tax summary.\n * @readonly\n */\n taxSummary?: TaxSummary$4;\n /**\n * The currency used when submitting the order.\n * @readonly\n */\n currency?: string;\n /**\n * Sales channel that submitted the order.\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$4;\n /**\n * Date and time the checkout was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the checkout was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 /** Memberships to apply when creating the order. */\n membershipOptions?: MembershipOptions$2;\n /** Additional Fees. */\n additionalFees?: AdditionalFee$4[];\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 * Information about the currency conversion that took place if at all. Empty if no conversion took place.\n * @internal\n */\n conversionInfo?: ConversionInfo$1;\n /**\n * The pay now total amount after gift card reduction\n * @internal\n * @readonly\n */\n payNowTotalAfterGiftCard?: MultiCurrencyPrice$2;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: 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$1[];\n /**\n * The total payment amount after gift card reduction\n * @internal\n * @readonly\n */\n totalAfterGiftCard?: MultiCurrencyPrice$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$8;\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 * References to an external app and resource associated with this checkout.\n * Used for integration and tracking across different platforms.\n * @internal\n */\n externalReference?: ExternalReference$2;\n /**\n * Order ID.\n *\n * This field is empty until the checkout completes and becomes an order.\n * @internal\n * @readonly\n */\n orderId?: string | null;\n /**\n * Payment for subscriptions after free trial period.\n * @internal\n * @readonly\n */\n payAfterFreeTrial?: PriceSummary$4;\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 * Set of fields to update. Fields are inferred.\n * @internal\n */\n fieldMask?: string[];\n /**\n * Merchant discounts to apply to specific line items.\n * If no `lineItemIds` are passed, the discount will be applied to the whole checkout.\n *\n * >**Note:** Merchant discounts are restricted and can only be applied if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.\n * @internal\n */\n merchantDiscounts?: MerchantDiscountInput$1[];\n /**\n * When true, calculation errors won't fail the update request. When empty or false, the update won't happen and relevant error will return\n * @internal\n */\n ignoreCalculationErrors?: boolean | 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$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$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 */\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 */\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 */\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 */\n function addToCheckout(_id: string, options?: AddToCheckoutOptions): Promise;\n interface AddToCheckoutOptions {\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$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 */\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 */\n function createOrder$1(_id: string, options?: CreateOrderOptions$1): Promise;\n interface CreateOrderOptions$1 {\n /**\n * Custom URL params to be added to redirect URLs.\n * @internal\n */\n urlParams?: Record;\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 * Deprecated (use createOrder instead)\n * @param _id - Checkout ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT\n */\n function createOrderAndCharge(_id: string, options?: CreateOrderAndChargeOptions): Promise;\n interface CreateOrderAndChargeOptions {\n /** Payment token. */\n paymentToken?: string | null;\n /**\n * Custom URL params to be added to redirect URLs.\n * @internal\n */\n urlParams?: Record;\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 */\n function markCheckoutAsCompleted(_id: string, options?: MarkCheckoutAsCompletedOptions): Promise;\n interface MarkCheckoutAsCompletedOptions {\n /**\n * Order ID.\n * @internal\n */\n orderId?: string | null;\n }\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 */\n function updateLineItemsQuantity(_id: string, lineItems: LineItemQuantityUpdate[]): Promise;\n /** @param _id - Checkout ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_PAYMENT_SETTINGS\n * @adminMethod\n */\n function getCheckoutPaymentSettings(_id: string): Promise;\n \n type ecomV1CheckoutCheckout_universal_d_V1PaymentOptionType = V1PaymentOptionType;\n const ecomV1CheckoutCheckout_universal_d_V1PaymentOptionType: typeof V1PaymentOptionType;\n type ecomV1CheckoutCheckout_universal_d_V1PaymentOption = V1PaymentOption;\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_CreateCheckoutRequest = CreateCheckoutRequest;\n type ecomV1CheckoutCheckout_universal_d_CreateCheckoutResponse = CreateCheckoutResponse;\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_RemoveCouponRequest = RemoveCouponRequest;\n type ecomV1CheckoutCheckout_universal_d_RemoveCouponResponse = RemoveCouponResponse;\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_RemoveLineItemsRequest = RemoveLineItemsRequest;\n type ecomV1CheckoutCheckout_universal_d_RemoveLineItemsResponse = RemoveLineItemsResponse;\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_UpdateLineItemsQuantityRequest = UpdateLineItemsQuantityRequest;\n type ecomV1CheckoutCheckout_universal_d_LineItemQuantityUpdate = LineItemQuantityUpdate;\n type ecomV1CheckoutCheckout_universal_d_UpdateLineItemsQuantityResponse = UpdateLineItemsQuantityResponse;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsRequest = GetCheckoutPaymentSettingsRequest;\n type ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsResponse = GetCheckoutPaymentSettingsResponse;\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_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 const ecomV1CheckoutCheckout_universal_d_getWixCheckoutUrl: typeof getWixCheckoutUrl;\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 const ecomV1CheckoutCheckout_universal_d_createOrderAndCharge: typeof createOrderAndCharge;\n type ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeOptions = CreateOrderAndChargeOptions;\n const ecomV1CheckoutCheckout_universal_d_markCheckoutAsCompleted: typeof markCheckoutAsCompleted;\n type ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedOptions = MarkCheckoutAsCompletedOptions;\n const ecomV1CheckoutCheckout_universal_d_updateLineItemsQuantity: typeof updateLineItemsQuantity;\n const ecomV1CheckoutCheckout_universal_d_getCheckoutPaymentSettings: typeof getCheckoutPaymentSettings;\n namespace ecomV1CheckoutCheckout_universal_d {\n export {\n Checkout$1 as Checkout,\n LineItem$4 as LineItem,\n CatalogReference$6 as CatalogReference,\n ProductName$3 as ProductName,\n MultiCurrencyPrice$2 as MultiCurrencyPrice,\n ItemTaxFullDetails$4 as ItemTaxFullDetails,\n TaxRateBreakdown$2 as TaxRateBreakdown,\n TaxBreakdown$2 as TaxBreakdown,\n JurisdictionType$4 as JurisdictionType,\n DescriptionLine$3 as DescriptionLine,\n DescriptionLineValueOneOf$3 as DescriptionLineValueOneOf,\n DescriptionLineDescriptionLineValueOneOf$3 as DescriptionLineDescriptionLineValueOneOf,\n DescriptionLineName$3 as DescriptionLineName,\n PlainTextValue$3 as PlainTextValue,\n Color$3 as Color,\n DescriptionLineType$3 as DescriptionLineType,\n FocalPoint$4 as FocalPoint,\n ItemAvailabilityInfo$1 as ItemAvailabilityInfo,\n ItemAvailabilityStatus$1 as ItemAvailabilityStatus,\n PhysicalProperties$5 as PhysicalProperties,\n Scope$2 as Scope,\n Group$2 as Group,\n ItemType$4 as ItemType,\n ItemTypeItemTypeDataOneOf$4 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$4 as ItemTypeItemType,\n SubscriptionOptionInfo$2 as SubscriptionOptionInfo,\n SubscriptionSettings$5 as SubscriptionSettings,\n SubscriptionFrequency$5 as SubscriptionFrequency,\n FreeTrialPeriod$1 as FreeTrialPeriod,\n Title$1 as Title,\n Description$1 as Description,\n SecuredMedia$2 as SecuredMedia,\n FileType$2 as FileType,\n ecomV1CheckoutCheckout_universal_d_V1PaymentOptionType as V1PaymentOptionType,\n ServiceProperties$3 as ServiceProperties,\n PriceDescription$3 as PriceDescription,\n CatalogOverrideFields$1 as CatalogOverrideFields,\n ecomV1CheckoutCheckout_universal_d_V1PaymentOption as V1PaymentOption,\n TaxableAddress$4 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$4 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$4 as TaxableAddressType,\n ExtendedFields$8 as ExtendedFields,\n Policy$1 as Policy,\n AddressWithContact$3 as AddressWithContact,\n ecomV1CheckoutCheckout_universal_d_ApiAddress as ApiAddress,\n StreetAddress$7 as StreetAddress,\n AddressLocation$7 as AddressLocation,\n FullAddressContactDetails$4 as FullAddressContactDetails,\n ecomV1CheckoutCheckout_universal_d_CommonVatId as CommonVatId,\n ecomV1CheckoutCheckout_universal_d_CommonVatType as CommonVatType,\n ShippingInfo$2 as ShippingInfo,\n SelectedCarrierServiceOption$2 as SelectedCarrierServiceOption,\n DeliveryLogistics$5 as DeliveryLogistics,\n PickupDetails$6 as PickupDetails,\n PickupMethod$5 as PickupMethod,\n DeliveryTimeSlot$5 as DeliveryTimeSlot,\n SelectedCarrierServiceOptionPrices$2 as SelectedCarrierServiceOptionPrices,\n SelectedCarrierServiceOptionOtherCharge$2 as SelectedCarrierServiceOptionOtherCharge,\n ChargeType$4 as ChargeType,\n DeliveryAllocation$3 as DeliveryAllocation,\n Carrier$3 as Carrier,\n Region$3 as Region,\n ApplicableLineItems$3 as ApplicableLineItems,\n ShippingRegion$4 as ShippingRegion,\n CarrierServiceOption$2 as CarrierServiceOption,\n ShippingOption$4 as ShippingOption,\n ShippingPrice$4 as ShippingPrice,\n OtherCharge$2 as OtherCharge,\n BuyerInfo$5 as BuyerInfo,\n BuyerInfoIdOneOf$3 as BuyerInfoIdOneOf,\n PriceSummary$4 as PriceSummary,\n CalculationErrors$3 as CalculationErrors,\n CalculationErrorsShippingCalculationErrorOneOf$3 as CalculationErrorsShippingCalculationErrorOneOf,\n Details$4 as Details,\n DetailsKindOneOf$4 as DetailsKindOneOf,\n ApplicationError$9 as ApplicationError,\n ValidationError$4 as ValidationError,\n RuleType$4 as RuleType,\n FieldViolation$4 as FieldViolation,\n SystemError$4 as SystemError,\n CarrierErrors$3 as CarrierErrors,\n CarrierError$4 as CarrierError,\n GiftCard$4 as GiftCard,\n AppliedDiscount$4 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$4 as AppliedDiscountDiscountSourceOneOf,\n DiscountType$4 as DiscountType,\n Coupon$4 as Coupon,\n MerchantDiscount$4 as MerchantDiscount,\n DiscountRule$4 as DiscountRule,\n DiscountRuleName$4 as DiscountRuleName,\n LineItemDiscount$4 as LineItemDiscount,\n CustomField$4 as CustomField,\n WeightUnit$6 as WeightUnit,\n TaxSummary$4 as TaxSummary,\n TaxCalculationDetails$2 as TaxCalculationDetails,\n TaxCalculationDetailsCalculationDetailsOneOf$2 as TaxCalculationDetailsCalculationDetailsOneOf,\n RateType$2 as RateType,\n ManualCalculationReason$2 as ManualCalculationReason,\n AutoTaxFallbackCalculationDetails$2 as AutoTaxFallbackCalculationDetails,\n FallbackReason$2 as FallbackReason,\n AggregatedTaxBreakdown$2 as AggregatedTaxBreakdown,\n ChannelType$4 as ChannelType,\n CreatedBy$4 as CreatedBy,\n CreatedByIdOneOf$2 as CreatedByIdOneOf,\n MembershipOptions$2 as MembershipOptions,\n Membership$2 as Membership,\n MembershipName$4 as MembershipName,\n MembershipPaymentCredits$2 as MembershipPaymentCredits,\n InvalidMembership$2 as InvalidMembership,\n SelectedMemberships$2 as SelectedMemberships,\n SelectedMembership$2 as SelectedMembership,\n AdditionalFee$4 as AdditionalFee,\n ConversionInfo$1 as ConversionInfo,\n Violation$1 as Violation,\n Severity$1 as Severity,\n Target$1 as Target,\n TargetTargetTypeOneOf$1 as TargetTargetTypeOneOf,\n NameInOther$1 as NameInOther,\n NameInLineItem$1 as NameInLineItem,\n SuggestedFix$1 as SuggestedFix,\n Other$1 as Other,\n TargetLineItem$1 as TargetLineItem,\n CustomSettings$1 as CustomSettings,\n CustomContentReference$1 as CustomContentReference,\n ExternalReference$2 as ExternalReference,\n ecomV1CheckoutCheckout_universal_d_UpdatedCheckoutMessage as UpdatedCheckoutMessage,\n ecomV1CheckoutCheckout_universal_d_CreateCheckoutRequest as CreateCheckoutRequest,\n CustomLineItem$2 as CustomLineItem,\n MerchantDiscountInput$1 as MerchantDiscountInput,\n ecomV1CheckoutCheckout_universal_d_CreateCheckoutResponse as CreateCheckoutResponse,\n ecomV1CheckoutCheckout_universal_d_ShippingCalculationErrorData as ShippingCalculationErrorData,\n ecomV1CheckoutCheckout_universal_d_ShippingCalculationErrorDataShippingCalculationErrorOneOf as ShippingCalculationErrorDataShippingCalculationErrorOneOf,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutRequest as GetCheckoutRequest,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutResponse as GetCheckoutResponse,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutWithAllExtendedFieldsRequest as GetCheckoutWithAllExtendedFieldsRequest,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutWithAllExtendedFieldsResponse as GetCheckoutWithAllExtendedFieldsResponse,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutByCartIdRequest as GetCheckoutByCartIdRequest,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutByCartIdResponse as GetCheckoutByCartIdResponse,\n ecomV1CheckoutCheckout_universal_d_GetWixCheckoutURLRequest as GetWixCheckoutURLRequest,\n ecomV1CheckoutCheckout_universal_d_GetWixCheckoutURLResponse as GetWixCheckoutURLResponse,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutURLRequest as GetCheckoutURLRequest,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutURLResponse as GetCheckoutURLResponse,\n ecomV1CheckoutCheckout_universal_d_UpdateCheckoutRequest as UpdateCheckoutRequest,\n ecomV1CheckoutCheckout_universal_d_UpdateCheckoutResponse as UpdateCheckoutResponse,\n ecomV1CheckoutCheckout_universal_d_RemoveCouponRequest as RemoveCouponRequest,\n ecomV1CheckoutCheckout_universal_d_RemoveCouponResponse as RemoveCouponResponse,\n ecomV1CheckoutCheckout_universal_d_RemoveGiftCardRequest as RemoveGiftCardRequest,\n ecomV1CheckoutCheckout_universal_d_RemoveGiftCardResponse as RemoveGiftCardResponse,\n ecomV1CheckoutCheckout_universal_d_RemoveOverrideCheckoutUrlRequest as RemoveOverrideCheckoutUrlRequest,\n ecomV1CheckoutCheckout_universal_d_RemoveOverrideCheckoutUrlResponse as RemoveOverrideCheckoutUrlResponse,\n ecomV1CheckoutCheckout_universal_d_AddToCheckoutRequest as AddToCheckoutRequest,\n ecomV1CheckoutCheckout_universal_d_AddToCheckoutResponse as AddToCheckoutResponse,\n ecomV1CheckoutCheckout_universal_d_RemoveLineItemsRequest as RemoveLineItemsRequest,\n ecomV1CheckoutCheckout_universal_d_RemoveLineItemsResponse as RemoveLineItemsResponse,\n CreateOrderRequest$1 as CreateOrderRequest,\n CreateOrderResponse$1 as CreateOrderResponse,\n ecomV1CheckoutCheckout_universal_d_CreateOrderResponseIdOneOf as CreateOrderResponseIdOneOf,\n ecomV1CheckoutCheckout_universal_d_PaymentErrorResponseData as PaymentErrorResponseData,\n ecomV1CheckoutCheckout_universal_d_DoublePaymentErrorData as DoublePaymentErrorData,\n ecomV1CheckoutCheckout_universal_d_DoublePaymentErrorDataIdOneOf as DoublePaymentErrorDataIdOneOf,\n ecomV1CheckoutCheckout_universal_d_RedeemErrorData as RedeemErrorData,\n ecomV1CheckoutCheckout_universal_d_ViolationsList as ViolationsList,\n ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeRequest as CreateOrderAndChargeRequest,\n ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeResponse as CreateOrderAndChargeResponse,\n ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeResponseIdOneOf as CreateOrderAndChargeResponseIdOneOf,\n ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedRequest as MarkCheckoutAsCompletedRequest,\n ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedResponse as MarkCheckoutAsCompletedResponse,\n ecomV1CheckoutCheckout_universal_d_CheckoutMarkedAsCompleted as CheckoutMarkedAsCompleted,\n ecomV1CheckoutCheckout_universal_d_UpdateLineItemsQuantityRequest as UpdateLineItemsQuantityRequest,\n ecomV1CheckoutCheckout_universal_d_LineItemQuantityUpdate as LineItemQuantityUpdate,\n ecomV1CheckoutCheckout_universal_d_UpdateLineItemsQuantityResponse as UpdateLineItemsQuantityResponse,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsRequest as GetCheckoutPaymentSettingsRequest,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutPaymentSettingsResponse as GetCheckoutPaymentSettingsResponse,\n PaymentOption$1 as PaymentOption,\n ecomV1CheckoutCheckout_universal_d_SubscriptionCreated as SubscriptionCreated,\n ecomV1CheckoutCheckout_universal_d_Subscription as Subscription,\n ecomV1CheckoutCheckout_universal_d_V1BuyerInfo as V1BuyerInfo,\n IdentityType$4 as IdentityType,\n V1LineItem$1 as V1LineItem,\n OptionSelection$1 as OptionSelection,\n CustomTextFieldSelection$1 as CustomTextFieldSelection,\n ecomV1CheckoutCheckout_universal_d_ChargeDetails as ChargeDetails,\n ecomV1CheckoutCheckout_universal_d_ProductDetails as ProductDetails,\n LineItemType$1 as LineItemType,\n MediaItem$1 as MediaItem,\n MediaItemType$1 as MediaItemType,\n Totals$1 as Totals,\n ecomV1CheckoutCheckout_universal_d_StoreSettings as StoreSettings,\n Address$8 as Address,\n AddressAddressLine1OptionsOneOf$1 as AddressAddressLine1OptionsOneOf,\n FullName$1 as FullName,\n Street$1 as Street,\n VatId$5 as VatId,\n VatType$5 as VatType,\n ecomV1CheckoutCheckout_universal_d_V1ShippingInfo as V1ShippingInfo,\n ecomV1CheckoutCheckout_universal_d_V1ShippingInfoDetailsOneOf as V1ShippingInfoDetailsOneOf,\n ShipmentDetails$1 as ShipmentDetails,\n V1PickupDetails$1 as V1PickupDetails,\n PickupAddress$3 as PickupAddress,\n AppliedCoupon$1 as AppliedCoupon,\n ecomV1CheckoutCheckout_universal_d_V1CustomField as V1CustomField,\n ecomV1CheckoutCheckout_universal_d_V1SubscriptionOptionInfo as V1SubscriptionOptionInfo,\n Discount$2 as Discount,\n ecomV1CheckoutCheckout_universal_d_DiscountDiscountType as DiscountDiscountType,\n ChannelInfo$3 as ChannelInfo,\n ecomV1CheckoutCheckout_universal_d_ChannelInfoChannelType as ChannelInfoChannelType,\n ecomV1CheckoutCheckout_universal_d_V1SubscriptionSettings as V1SubscriptionSettings,\n BillingInfo$1 as BillingInfo,\n Empty$9 as Empty,\n DomainEvent$g as DomainEvent,\n DomainEventBodyOneOf$g as DomainEventBodyOneOf,\n EntityCreatedEvent$g as EntityCreatedEvent,\n RestoreInfo$g as RestoreInfo,\n EntityUpdatedEvent$g as EntityUpdatedEvent,\n EntityDeletedEvent$g as EntityDeletedEvent,\n ActionEvent$g as ActionEvent,\n MessageEnvelope$f as MessageEnvelope,\n IdentificationData$g as IdentificationData,\n IdentificationDataIdOneOf$g as IdentificationDataIdOneOf,\n WebhookIdentityType$f as WebhookIdentityType,\n ecomV1CheckoutCheckout_universal_d_createCheckout as createCheckout,\n ecomV1CheckoutCheckout_universal_d_CreateCheckoutOptions as CreateCheckoutOptions,\n ecomV1CheckoutCheckout_universal_d_getCheckout as getCheckout,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutOptions as GetCheckoutOptions,\n ecomV1CheckoutCheckout_universal_d_getCheckoutByCartId as getCheckoutByCartId,\n ecomV1CheckoutCheckout_universal_d_getWixCheckoutUrl as getWixCheckoutUrl,\n ecomV1CheckoutCheckout_universal_d_GetWixCheckoutUrlOptions as GetWixCheckoutUrlOptions,\n ecomV1CheckoutCheckout_universal_d_getCheckoutUrl as getCheckoutUrl,\n ecomV1CheckoutCheckout_universal_d_GetCheckoutUrlOptions as GetCheckoutUrlOptions,\n ecomV1CheckoutCheckout_universal_d_updateCheckout as updateCheckout,\n ecomV1CheckoutCheckout_universal_d_UpdateCheckout as UpdateCheckout,\n ecomV1CheckoutCheckout_universal_d_UpdateCheckoutOptions as UpdateCheckoutOptions,\n ecomV1CheckoutCheckout_universal_d_removeCoupon as removeCoupon,\n ecomV1CheckoutCheckout_universal_d_removeGiftCard as removeGiftCard,\n ecomV1CheckoutCheckout_universal_d_removeOverrideCheckoutUrl as removeOverrideCheckoutUrl,\n ecomV1CheckoutCheckout_universal_d_addToCheckout as addToCheckout,\n ecomV1CheckoutCheckout_universal_d_AddToCheckoutOptions as AddToCheckoutOptions,\n ecomV1CheckoutCheckout_universal_d_removeLineItems as removeLineItems,\n createOrder$1 as createOrder,\n CreateOrderOptions$1 as CreateOrderOptions,\n ecomV1CheckoutCheckout_universal_d_createOrderAndCharge as createOrderAndCharge,\n ecomV1CheckoutCheckout_universal_d_CreateOrderAndChargeOptions as CreateOrderAndChargeOptions,\n ecomV1CheckoutCheckout_universal_d_markCheckoutAsCompleted as markCheckoutAsCompleted,\n ecomV1CheckoutCheckout_universal_d_MarkCheckoutAsCompletedOptions as MarkCheckoutAsCompletedOptions,\n ecomV1CheckoutCheckout_universal_d_updateLineItemsQuantity as updateLineItemsQuantity,\n ecomV1CheckoutCheckout_universal_d_getCheckoutPaymentSettings as getCheckoutPaymentSettings,\n };\n }\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 /** Checkout brand settings. */\n checkoutBrand?: CheckoutBrand;\n /**\n * Date and time the checkout settings were created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the checkout settings were updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * Whether to allow for Auth & Capture transactions.

\n *\n * Default: `false`\n */\n delayCaptureEnabled?: boolean | null;\n /**\n * Whether to automatically capture the transaction before the authorization expires.\n *\n * Default: `true`\n * >**Note:** this setting is only relevant when `delay_capture_enabled: true`.\n */\n captureBeforeExpiryEnabled?: 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 /**\n * Logo image.\n * @internal\n */\n image?: string;\n /** Size of the logo. */\n size?: LogoSize;\n }\n interface FocalPoint$3 {\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 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 * List of exact fields to update. For example, if you define only `giftCardRedeemEnabled`, all other fields are ignored.\n * @internal\n */\n fieldMask?: string[];\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$8 {\n }\n interface DeleteCheckoutSettingsRequest {\n }\n interface DeleteCheckoutSettingsResponse {\n }\n interface DomainEvent$f extends DomainEventBodyOneOf$f {\n createdEvent?: EntityCreatedEvent$f;\n updatedEvent?: EntityUpdatedEvent$f;\n deletedEvent?: EntityDeletedEvent$f;\n actionEvent?: ActionEvent$f;\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$f {\n createdEvent?: EntityCreatedEvent$f;\n updatedEvent?: EntityUpdatedEvent$f;\n deletedEvent?: EntityDeletedEvent$f;\n actionEvent?: ActionEvent$f;\n }\n interface EntityCreatedEvent$f {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$f;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$f {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$f {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$f {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$f {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$e {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$f;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$f extends IdentificationDataIdOneOf$f {\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$e;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$f {\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$e {\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 * @permissionId ECOM.READ_CHECKOUT_SETTINGS\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 * @permissionId ECOM.UPDATE_CHECKOUT_SETTINGS\n * @adminMethod\n * @returns The updated checkout settings.\n */\n function updateCheckoutSettings(checkoutSettings: CheckoutSettings, options?: UpdateCheckoutSettingsOptions): Promise;\n interface UpdateCheckoutSettingsOptions {\n /**\n * List of exact fields to update. For example, if you define only `giftCardRedeemEnabled`, all other fields are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n \n type ecomV1CheckoutSettings_universal_d_CheckoutSettings = CheckoutSettings;\n type ecomV1CheckoutSettings_universal_d_CheckoutPolicies = CheckoutPolicies;\n type ecomV1CheckoutSettings_universal_d_TermsAndConditionsPolicy = TermsAndConditionsPolicy;\n type ecomV1CheckoutSettings_universal_d_PrivacyPolicy = PrivacyPolicy;\n type ecomV1CheckoutSettings_universal_d_ReturnPolicy = ReturnPolicy;\n type ecomV1CheckoutSettings_universal_d_DigitalItemPolicy = DigitalItemPolicy;\n type ecomV1CheckoutSettings_universal_d_ContactUsPolicy = ContactUsPolicy;\n type ecomV1CheckoutSettings_universal_d_CustomCheckoutPolicy = CustomCheckoutPolicy;\n type ecomV1CheckoutSettings_universal_d_CheckoutFields = CheckoutFields;\n type ecomV1CheckoutSettings_universal_d_CheckboxField = CheckboxField;\n type ecomV1CheckoutSettings_universal_d_CheckoutBrand = CheckoutBrand;\n type ecomV1CheckoutSettings_universal_d_CheckoutHeader = CheckoutHeader;\n type ecomV1CheckoutSettings_universal_d_Logo = Logo;\n type ecomV1CheckoutSettings_universal_d_LogoSize = LogoSize;\n const ecomV1CheckoutSettings_universal_d_LogoSize: typeof LogoSize;\n type ecomV1CheckoutSettings_universal_d_Alignment = Alignment;\n const ecomV1CheckoutSettings_universal_d_Alignment: typeof Alignment;\n type ecomV1CheckoutSettings_universal_d_GetCheckoutSettingsRequest = GetCheckoutSettingsRequest;\n type ecomV1CheckoutSettings_universal_d_GetCheckoutSettingsResponse = GetCheckoutSettingsResponse;\n type ecomV1CheckoutSettings_universal_d_UpdateCheckoutSettingsRequest = UpdateCheckoutSettingsRequest;\n type ecomV1CheckoutSettings_universal_d_UpdateCheckoutSettingsResponse = UpdateCheckoutSettingsResponse;\n type ecomV1CheckoutSettings_universal_d_ListCheckoutSettingsRequest = ListCheckoutSettingsRequest;\n type ecomV1CheckoutSettings_universal_d_ListCheckoutSettingsResponse = ListCheckoutSettingsResponse;\n type ecomV1CheckoutSettings_universal_d_GiftCardProviderWasProvisioned = GiftCardProviderWasProvisioned;\n type ecomV1CheckoutSettings_universal_d_DeleteCheckoutSettingsRequest = DeleteCheckoutSettingsRequest;\n type ecomV1CheckoutSettings_universal_d_DeleteCheckoutSettingsResponse = DeleteCheckoutSettingsResponse;\n const ecomV1CheckoutSettings_universal_d_getCheckoutSettings: typeof getCheckoutSettings;\n const ecomV1CheckoutSettings_universal_d_updateCheckoutSettings: typeof updateCheckoutSettings;\n type ecomV1CheckoutSettings_universal_d_UpdateCheckoutSettingsOptions = UpdateCheckoutSettingsOptions;\n namespace ecomV1CheckoutSettings_universal_d {\n export {\n ecomV1CheckoutSettings_universal_d_CheckoutSettings as CheckoutSettings,\n ecomV1CheckoutSettings_universal_d_CheckoutPolicies as CheckoutPolicies,\n ecomV1CheckoutSettings_universal_d_TermsAndConditionsPolicy as TermsAndConditionsPolicy,\n ecomV1CheckoutSettings_universal_d_PrivacyPolicy as PrivacyPolicy,\n ecomV1CheckoutSettings_universal_d_ReturnPolicy as ReturnPolicy,\n ecomV1CheckoutSettings_universal_d_DigitalItemPolicy as DigitalItemPolicy,\n ecomV1CheckoutSettings_universal_d_ContactUsPolicy as ContactUsPolicy,\n ecomV1CheckoutSettings_universal_d_CustomCheckoutPolicy as CustomCheckoutPolicy,\n ecomV1CheckoutSettings_universal_d_CheckoutFields as CheckoutFields,\n ecomV1CheckoutSettings_universal_d_CheckboxField as CheckboxField,\n ecomV1CheckoutSettings_universal_d_CheckoutBrand as CheckoutBrand,\n ecomV1CheckoutSettings_universal_d_CheckoutHeader as CheckoutHeader,\n ecomV1CheckoutSettings_universal_d_Logo as Logo,\n FocalPoint$3 as FocalPoint,\n ecomV1CheckoutSettings_universal_d_LogoSize as LogoSize,\n ecomV1CheckoutSettings_universal_d_Alignment as Alignment,\n ecomV1CheckoutSettings_universal_d_GetCheckoutSettingsRequest as GetCheckoutSettingsRequest,\n ecomV1CheckoutSettings_universal_d_GetCheckoutSettingsResponse as GetCheckoutSettingsResponse,\n ecomV1CheckoutSettings_universal_d_UpdateCheckoutSettingsRequest as UpdateCheckoutSettingsRequest,\n ecomV1CheckoutSettings_universal_d_UpdateCheckoutSettingsResponse as UpdateCheckoutSettingsResponse,\n ecomV1CheckoutSettings_universal_d_ListCheckoutSettingsRequest as ListCheckoutSettingsRequest,\n ecomV1CheckoutSettings_universal_d_ListCheckoutSettingsResponse as ListCheckoutSettingsResponse,\n ecomV1CheckoutSettings_universal_d_GiftCardProviderWasProvisioned as GiftCardProviderWasProvisioned,\n Empty$8 as Empty,\n ecomV1CheckoutSettings_universal_d_DeleteCheckoutSettingsRequest as DeleteCheckoutSettingsRequest,\n ecomV1CheckoutSettings_universal_d_DeleteCheckoutSettingsResponse as DeleteCheckoutSettingsResponse,\n DomainEvent$f as DomainEvent,\n DomainEventBodyOneOf$f as DomainEventBodyOneOf,\n EntityCreatedEvent$f as EntityCreatedEvent,\n RestoreInfo$f as RestoreInfo,\n EntityUpdatedEvent$f as EntityUpdatedEvent,\n EntityDeletedEvent$f as EntityDeletedEvent,\n ActionEvent$f as ActionEvent,\n MessageEnvelope$e as MessageEnvelope,\n IdentificationData$f as IdentificationData,\n IdentificationDataIdOneOf$f as IdentificationDataIdOneOf,\n WebhookIdentityType$e as WebhookIdentityType,\n ecomV1CheckoutSettings_universal_d_getCheckoutSettings as getCheckoutSettings,\n ecomV1CheckoutSettings_universal_d_updateCheckoutSettings as updateCheckoutSettings,\n ecomV1CheckoutSettings_universal_d_UpdateCheckoutSettingsOptions as UpdateCheckoutSettingsOptions,\n };\n }\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$2;\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?: LineItem$3[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * Max: 300 items\n */\n customLineItems?: CustomLineItem$1[];\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 * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.\n * @internal\n */\n extendedFields?: ExtendedFields$7;\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 * References to an external app and resource associated with the checkout.\n * Used for integration and tracking across different platforms.\n * @internal\n */\n externalReference?: ExternalReference$1;\n }\n enum Status$2 {\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 LineItem$3 {\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$5;\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$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 [app dashboard](https://dev.wix.com/dc3/my-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$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$4;\n /** Item image. */\n image?: string;\n /** Payment method selected for the item. */\n paymentOption?: PaymentOption;\n /** Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`. */\n depositAmount?: string | null;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean | null;\n }\n interface ProductName$2 {\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$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 /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$2;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName$2;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType$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 * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$2;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n }\n interface DescriptionLineName$2 {\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$2 {\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$2 {\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$2 {\n /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\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 PaymentOption {\n /**\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 selected, `price` is `0`.\n * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.\n * + `MEMBERSHIP_OFFLINE`: 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 */\n value?: PaymentOptionType$3;\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 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 checkout. The 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 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 display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine$2[];\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$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$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$4;\n /**\n * Subscription option info. This field is internal and only used by Stores.\n * @internal\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$1;\n /**\n * Digital file ID and name. Required if `itemType: DIGITAL`.\n * @internal\n */\n digitalFile?: SecuredMedia$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$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$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 /**\n * Delivery Profile ID.\n * @internal\n */\n deliveryProfileId?: 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$5;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: 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 * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n */\n policies?: Policy[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n }\n interface PriceDescription$2 {\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$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$1 {\n /** Subscription option settings. */\n subscriptionSettings?: SubscriptionSettings$4;\n /** Subscription option title. */\n title?: Title;\n /** Subscription option description. */\n description?: Description;\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 * If SubscriptionFrequency is Day the minimum interval is 7\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 * Whether to allow the customer to cancel the subscription..\n * @internal\n */\n enableCustomerCancellation?: boolean;\n /**\n * Period until first cycle starts. If applied payNow will be 0\n * If None => no free trial\n * @internal\n */\n freeTrialPeriod?: FreeTrialPeriod;\n /**\n * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.\n * @internal\n */\n startDate?: Date | null;\n /**\n * Whether to generate an order each billing cycle. An order will always be generated for the first billing cycle.\n * Default None => will behave like true\n * @internal\n */\n generateOrderEachBillingCycle?: boolean | 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 FreeTrialPeriod {\n /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */\n frequency?: SubscriptionFrequency$4;\n /** interval of period */\n interval?: number;\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$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 interface ServiceProperties$2 {\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 | null;\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 Policy {\n /** Policy title - should be translated */\n title?: string | null;\n /** Policy content - should be translated */\n content?: string;\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 CustomContentReference {\n /**\n * ID of the app providing the content.\n *\n * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-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 [app dashboard](https://dev.wix.com/dc3/my-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 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 * Set of fields to update.\n * @internal\n */\n fieldMask?: string[];\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$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$b;\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$b[];\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$b;\n }\n interface Sorting$b {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$b;\n }\n enum SortOrder$b {\n /** Ascending order. */\n ASC = \"ASC\",\n /** Descending order. */\n DESC = \"DESC\"\n }\n interface CursorPaging$b {\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$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$b;\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$b {\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?: V1LineItem[];\n /** Billing information. */\n billingInfo?: AddressWithContact$2;\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$4;\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$3[];\n /** Custom fields. */\n customFields?: CustomField$3[];\n /**\n * Weight measurement unit - defaults to site's weight unit.\n * @readonly\n */\n weightUnit?: WeightUnit$5;\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 * @readonly\n */\n channelType?: ChannelType$3;\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$3;\n /**\n * Date and time the checkout was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the checkout was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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$1;\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 * Information about the currency conversion that took place if at all. Empty if no conversion took place.\n * @internal\n */\n conversionInfo?: ConversionInfo;\n /**\n * The pay now total amount after gift card reduction\n * @internal\n * @readonly\n */\n payNowTotalAfterGiftCard?: MultiCurrencyPrice$1;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: 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 * The total payment amount after gift card reduction\n * @internal\n * @readonly\n */\n totalAfterGiftCard?: MultiCurrencyPrice$1;\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$7;\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 * References to an external app and resource associated with this checkout.\n * Used for integration and tracking across different platforms.\n * @internal\n */\n externalReference?: ExternalReference$1;\n /**\n * Order ID.\n *\n * This field is empty until the checkout completes and becomes an order.\n * @internal\n * @readonly\n */\n orderId?: string | null;\n /**\n * Payment for subscriptions after free trial period.\n * @internal\n * @readonly\n */\n payAfterFreeTrial?: PriceSummary$3;\n }\n interface V1LineItem {\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$5;\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$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$3;\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$2[];\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$4;\n /**\n * Coupon scopes - which app and items a coupon applies to.\n * This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current [Coupons API](https://bo.wix.com/wix-docs/rest/stores/coupons/valid-scope-values).\n * @internal\n * @readonly\n */\n couponScopes?: Scope$1[];\n /**\n * Item type. Either a preset type or custom.\n * @readonly\n */\n itemType?: ItemType$3;\n /**\n * Subscription option information.\n * @readonly\n */\n subscriptionOptionInfo?: SubscriptionOptionInfo$1;\n /**\n * Fulfiller ID for this item. Field is empty when the item is self-fulfilled.\n * @internal\n * @readonly\n */\n fulfillerId?: string | null;\n /**\n * Shipping group ID.\n * @internal\n * @readonly\n */\n shippingGroupId?: string | null;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia$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$3;\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 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$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$1;\n /**\n * Delivery Profile Id for the product\n * @internal\n * @readonly\n */\n deliveryProfileId?: string | null;\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 the price is not yet defined, and will be updated after the order is created.\n * @internal\n * @readonly\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n * @internal\n * @readonly\n */\n fixedQuantity?: boolean;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n * @readonly\n */\n savePaymentMethod?: boolean;\n /**\n * Address to be used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$3;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$7;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n * @readonly\n */\n policies?: Policy[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\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$3 {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice$1;\n /**\n * Tax group ID, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$1[];\n /**\n * The amount of this line item that was exempt.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$1;\n /**\n * True for items we have a tax applied on them\n * @internal\n */\n isItemTaxable?: boolean | null;\n /**\n * True if the lineAmount include tax in it.\n * @internal\n */\n isTaxIncluded?: boolean | null;\n /**\n * The calculator that calculated this line tax\n * @internal\n */\n calculatorName?: string | null;\n /**\n * tax information for a line item.\n * @internal\n * @readonly\n */\n taxBreakdown?: TaxBreakdown$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$1;\n /**\n * The type of tax that was calculated\n * @internal\n */\n taxType?: string | null;\n /**\n * The name of the jurisdiction in which this tax detail applies\n * @internal\n */\n jurisdiction?: string | null;\n /**\n * The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).\n * @internal\n */\n jurisdictionType?: string | null;\n /**\n * The amount of this line item that was exempt from this authority.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice$1;\n /**\n * ids of the used exemptions from the TaxEstimate exemptions array.\n * @internal\n */\n exemptionIds?: number[];\n /**\n * The taxable amount of this tax detail\n * @internal\n */\n taxableAmount?: MultiCurrencyPrice$1;\n /**\n * The Taxes/Fee component. True if the fee is applied.\n * @internal\n */\n isFee?: boolean | null;\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$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$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 FocalPoint$2 {\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 ItemAvailabilityInfo {\n /** Item availability status. */\n status?: ItemAvailabilityStatus;\n /** Quantity available. */\n quantityAvailable?: number | null;\n }\n enum ItemAvailabilityStatus {\n AVAILABLE = \"AVAILABLE\",\n /** Item does not exist */\n NOT_FOUND = \"NOT_FOUND\",\n /** Item 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$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 TaxableAddress$3 extends TaxableAddressTaxableAddressDataOneOf$3 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$3;\n }\n /** @oneof */\n interface TaxableAddressTaxableAddressDataOneOf$3 {\n /** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */\n addressType?: TaxableAddressType$3;\n }\n enum TaxableAddressType$3 {\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$2 {\n /** Address. */\n address?: Address$7;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$3;\n /**\n * Reference to address service.\n * @internal\n */\n addressesServiceId?: string | null;\n }\n /** Physical address */\n interface Address$7 {\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$6;\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 /** @internal */\n location?: AddressLocation$6;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$6 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$6 {\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?: VatId$4;\n }\n interface VatId$4 {\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$4;\n }\n /** tax info types */\n enum VatType$4 {\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$2;\n /** Selected option out of the options allowed for the `region`. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption$1;\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$1[];\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$4;\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 * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$2[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | 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 * Expected delivery time slot (from and to time stamps representation)\n * @internal\n */\n deliveryTimeSlot?: DeliveryTimeSlot$4;\n }\n interface PickupDetails$5 {\n /** Pickup address. */\n address?: Address$7;\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 | 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$1;\n /** Total price of shipping after discounts (when relevant), and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice$1;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$3;\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$1 {\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$1;\n }\n enum ChargeType$3 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface DeliveryAllocation$2 {\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n deliveryCarrier?: Carrier$2;\n /** The delivery region that are relevant for this delivery solution. */\n deliveryRegion?: Region$2;\n /** Populated if the delivery solution is a partially supplied by this carrier. */\n applicableLineItems?: ApplicableLineItems$2;\n }\n interface Carrier$2 {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface Region$2 {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface ApplicableLineItems$2 {\n /** Line items that the delivery solution is for. */\n lineItemIds?: string[];\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$1 {\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$3;\n /**\n * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$2[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface ShippingPrice$3 {\n /** Shipping price. */\n price?: MultiCurrencyPrice$1;\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$3;\n /** Price of added cost. */\n price?: MultiCurrencyPrice$1;\n }\n interface BuyerInfo$4 extends BuyerInfoIdOneOf$2 {\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 * + If `true`, the checkout doesn't have an owner yet and anyone can access it. The first to access it will be the new owner.\n * + If `false`, the value in `checkout.createdBy` is the owner.\n * @internal\n */\n openAccess?: boolean;\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$2 {\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 * + If `true`, the checkout doesn't have an owner yet and anyone can access it. The first to access it will be the new owner.\n * + If `false`, the value in `checkout.createdBy` is the owner.\n * @internal\n */\n openAccess?: boolean;\n }\n interface PriceSummary$3 {\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$2 extends CalculationErrorsShippingCalculationErrorOneOf$2 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$3;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$2;\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$8[];\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$2 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$3;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$2;\n }\n interface Details$3 extends DetailsKindOneOf$3 {\n applicationError?: ApplicationError$8;\n validationError?: ValidationError$3;\n systemError?: SystemError$3;\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$3 {\n applicationError?: ApplicationError$8;\n validationError?: ValidationError$3;\n systemError?: SystemError$3;\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 /**\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\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$2 {\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 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$1;\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$3 extends AppliedDiscountDiscountSourceOneOf$3 {\n /** Coupon details. */\n coupon?: Coupon$3;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$3;\n /** Discount rule */\n discountRule?: DiscountRule$3;\n /** Discount type. */\n discountType?: DiscountType$3;\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 * Discount ID.\n * @internal\n */\n _id?: string | null;\n /**\n * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$3[];\n /**\n * Number of subscription cycle this discount applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\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$3;\n }\n enum DiscountType$3 {\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$1;\n /** Coupon name. */\n name?: string;\n /**\n * Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.\n * @internal\n * @deprecated\n */\n couponType?: string;\n }\n interface MerchantDiscount$3 {\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$3 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$3;\n /** Discount value. */\n amount?: MultiCurrencyPrice$1;\n }\n interface DiscountRuleName$3 {\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$1;\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$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 TaxSummary$3 {\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 * Manual tax rate\n * @internal\n * @readonly\n * @deprecated\n */\n manualTaxRate?: string;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails$1;\n /**\n * Tax estimation id in tax service\n * @internal\n * @readonly\n */\n taxEstimationId?: string | null;\n /**\n * Average Tax Rate\n * @internal\n * @readonly\n */\n averageTaxRate?: string | null;\n /**\n * The amount of this estimate that was exempt (for all line items).\n * @internal\n * @readonly\n */\n totalExempt?: MultiCurrencyPrice$1;\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 * @internal\n * @readonly\n */\n aggregatedTaxBreakdown?: AggregatedTaxBreakdown$1[];\n }\n interface TaxCalculationDetails$1 extends 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 /** Rate calculation type. */\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 /** reason for fallback */\n fallbackReason?: FallbackReason$1;\n /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */\n error?: ApplicationError$8;\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 /**\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$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$1;\n /**\n * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: MultiCurrencyPrice$1;\n }\n enum ChannelType$3 {\n /** Unspecified sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\n FAIRE_COM = \"FAIRE_COM\"\n }\n interface CreatedBy$3 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$1 {\n /**\n * Reserved for internal use.\n * @readonly\n */\n eligibleMemberships?: Membership$1[];\n /**\n * Reserved for internal use.\n * @readonly\n */\n invalidMemberships?: InvalidMembership$1[];\n /** Selected membership to apply to this checkout. */\n selectedMemberships?: SelectedMemberships$1;\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 /** Translated membership name. Defaults to `original` when not provided. */\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 SelectedMemberships$1 {\n /** Selected memberships. */\n memberships?: SelectedMembership$1[];\n }\n interface SelectedMembership$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 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$1;\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$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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\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 /** Delivery section. */\n DELIVERY = \"DELIVERY\"\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 enum SuggestedFix {\n /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */\n UNKNOWN_SUGGESTED_FIX = \"UNKNOWN_SUGGESTED_FIX\",\n /** The line item should be removed from the cart or checkout to resolve the violation. */\n REMOVE_LINE_ITEM = \"REMOVE_LINE_ITEM\"\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 * Suggested fix for resolving the line item violation.\n * @internal\n */\n suggestedFix?: SuggestedFix;\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$e extends DomainEventBodyOneOf$e {\n createdEvent?: EntityCreatedEvent$e;\n updatedEvent?: EntityUpdatedEvent$e;\n deletedEvent?: EntityDeletedEvent$e;\n actionEvent?: ActionEvent$e;\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$e {\n createdEvent?: EntityCreatedEvent$e;\n updatedEvent?: EntityUpdatedEvent$e;\n deletedEvent?: EntityDeletedEvent$e;\n actionEvent?: ActionEvent$e;\n }\n interface EntityCreatedEvent$e {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$e;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$e {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$e {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$e {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$e {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$d {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$e;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$e extends IdentificationDataIdOneOf$e {\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$d;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$e {\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$d {\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 * @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 * @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 * @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$2;\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?: LineItem$3[];\n /**\n * Custom line items. Custom line items don't trigger the Catalog service plugin.\n *\n * Max: 300 items\n */\n customLineItems?: CustomLineItem$1[];\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 * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.\n * @internal\n */\n extendedFields?: ExtendedFields$7;\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 * References to an external app and resource associated with the checkout.\n * Used for integration and tracking across different platforms.\n * @internal\n */\n externalReference?: ExternalReference$1;\n }\n interface UpdateCheckoutTemplateOptions {\n /**\n * Set of fields to update.\n * @internal\n */\n fieldMask?: string[];\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 * @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 * @permissionId ECOM.CHECKOUT_TEMPLATE_READ\n * @adminMethod\n */\n function queryCheckoutTemplates(): CheckoutTemplatesQueryBuilder;\n interface QueryCursorResult$b {\n cursors: Cursors$b;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CheckoutTemplatesQueryResult extends QueryCursorResult$b {\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 */\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 \n type ecomV1CheckoutTemplate_universal_d_CheckoutTemplate = CheckoutTemplate;\n type ecomV1CheckoutTemplate_universal_d_CheckoutCustomization = CheckoutCustomization;\n type ecomV1CheckoutTemplate_universal_d_WebClientCustomization = WebClientCustomization;\n type ecomV1CheckoutTemplate_universal_d_CatalogOverrideFields = CatalogOverrideFields;\n type ecomV1CheckoutTemplate_universal_d_PaymentOption = PaymentOption;\n type ecomV1CheckoutTemplate_universal_d_FreeTrialPeriod = FreeTrialPeriod;\n type ecomV1CheckoutTemplate_universal_d_Title = Title;\n type ecomV1CheckoutTemplate_universal_d_Description = Description;\n type ecomV1CheckoutTemplate_universal_d_Policy = Policy;\n type ecomV1CheckoutTemplate_universal_d_CustomContentReference = CustomContentReference;\n type ecomV1CheckoutTemplate_universal_d_CreateCheckoutTemplateRequest = CreateCheckoutTemplateRequest;\n type ecomV1CheckoutTemplate_universal_d_CreateCheckoutTemplateResponse = CreateCheckoutTemplateResponse;\n type ecomV1CheckoutTemplate_universal_d_GetCheckoutTemplateRequest = GetCheckoutTemplateRequest;\n type ecomV1CheckoutTemplate_universal_d_GetCheckoutTemplateResponse = GetCheckoutTemplateResponse;\n type ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplateRequest = UpdateCheckoutTemplateRequest;\n type ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplateResponse = UpdateCheckoutTemplateResponse;\n type ecomV1CheckoutTemplate_universal_d_DeleteCheckoutTemplateRequest = DeleteCheckoutTemplateRequest;\n type ecomV1CheckoutTemplate_universal_d_DeleteCheckoutTemplateResponse = DeleteCheckoutTemplateResponse;\n type ecomV1CheckoutTemplate_universal_d_QueryCheckoutTemplatesRequest = QueryCheckoutTemplatesRequest;\n type ecomV1CheckoutTemplate_universal_d_QueryCheckoutTemplatesResponse = QueryCheckoutTemplatesResponse;\n type ecomV1CheckoutTemplate_universal_d_CreateCheckoutFromTemplateRequest = CreateCheckoutFromTemplateRequest;\n type ecomV1CheckoutTemplate_universal_d_CreateCheckoutFromTemplateResponse = CreateCheckoutFromTemplateResponse;\n type ecomV1CheckoutTemplate_universal_d_CheckoutTemplateUsed = CheckoutTemplateUsed;\n type ecomV1CheckoutTemplate_universal_d_Checkout = Checkout;\n type ecomV1CheckoutTemplate_universal_d_V1LineItem = V1LineItem;\n type ecomV1CheckoutTemplate_universal_d_ItemAvailabilityInfo = ItemAvailabilityInfo;\n type ecomV1CheckoutTemplate_universal_d_ItemAvailabilityStatus = ItemAvailabilityStatus;\n const ecomV1CheckoutTemplate_universal_d_ItemAvailabilityStatus: typeof ItemAvailabilityStatus;\n type ecomV1CheckoutTemplate_universal_d_ConversionInfo = ConversionInfo;\n type ecomV1CheckoutTemplate_universal_d_Violation = Violation;\n type ecomV1CheckoutTemplate_universal_d_Severity = Severity;\n const ecomV1CheckoutTemplate_universal_d_Severity: typeof Severity;\n type ecomV1CheckoutTemplate_universal_d_Target = Target;\n type ecomV1CheckoutTemplate_universal_d_TargetTargetTypeOneOf = TargetTargetTypeOneOf;\n type ecomV1CheckoutTemplate_universal_d_NameInOther = NameInOther;\n const ecomV1CheckoutTemplate_universal_d_NameInOther: typeof NameInOther;\n type ecomV1CheckoutTemplate_universal_d_NameInLineItem = NameInLineItem;\n const ecomV1CheckoutTemplate_universal_d_NameInLineItem: typeof NameInLineItem;\n type ecomV1CheckoutTemplate_universal_d_SuggestedFix = SuggestedFix;\n const ecomV1CheckoutTemplate_universal_d_SuggestedFix: typeof SuggestedFix;\n type ecomV1CheckoutTemplate_universal_d_Other = Other;\n type ecomV1CheckoutTemplate_universal_d_TargetLineItem = TargetLineItem;\n type ecomV1CheckoutTemplate_universal_d_CustomSettings = CustomSettings;\n type ecomV1CheckoutTemplate_universal_d_CreateAndRedirectToCheckoutRequest = CreateAndRedirectToCheckoutRequest;\n type ecomV1CheckoutTemplate_universal_d_RawHttpResponse = RawHttpResponse;\n type ecomV1CheckoutTemplate_universal_d_HeadersEntry = HeadersEntry;\n const ecomV1CheckoutTemplate_universal_d_createCheckoutTemplate: typeof createCheckoutTemplate;\n const ecomV1CheckoutTemplate_universal_d_getCheckoutTemplate: typeof getCheckoutTemplate;\n const ecomV1CheckoutTemplate_universal_d_updateCheckoutTemplate: typeof updateCheckoutTemplate;\n type ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplate = UpdateCheckoutTemplate;\n type ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplateOptions = UpdateCheckoutTemplateOptions;\n const ecomV1CheckoutTemplate_universal_d_deleteCheckoutTemplate: typeof deleteCheckoutTemplate;\n const ecomV1CheckoutTemplate_universal_d_queryCheckoutTemplates: typeof queryCheckoutTemplates;\n type ecomV1CheckoutTemplate_universal_d_CheckoutTemplatesQueryResult = CheckoutTemplatesQueryResult;\n type ecomV1CheckoutTemplate_universal_d_CheckoutTemplatesQueryBuilder = CheckoutTemplatesQueryBuilder;\n const ecomV1CheckoutTemplate_universal_d_createCheckoutFromTemplate: typeof createCheckoutFromTemplate;\n const ecomV1CheckoutTemplate_universal_d_createAndRedirectToCheckout: typeof createAndRedirectToCheckout;\n namespace ecomV1CheckoutTemplate_universal_d {\n export {\n ecomV1CheckoutTemplate_universal_d_CheckoutTemplate as CheckoutTemplate,\n Status$2 as Status,\n ecomV1CheckoutTemplate_universal_d_CheckoutCustomization as CheckoutCustomization,\n ecomV1CheckoutTemplate_universal_d_WebClientCustomization as WebClientCustomization,\n LineItem$3 as LineItem,\n CatalogReference$5 as CatalogReference,\n ecomV1CheckoutTemplate_universal_d_CatalogOverrideFields as CatalogOverrideFields,\n ProductName$2 as ProductName,\n DescriptionLine$2 as DescriptionLine,\n DescriptionLineValueOneOf$2 as DescriptionLineValueOneOf,\n DescriptionLineDescriptionLineValueOneOf$2 as DescriptionLineDescriptionLineValueOneOf,\n DescriptionLineName$2 as DescriptionLineName,\n PlainTextValue$2 as PlainTextValue,\n Color$2 as Color,\n DescriptionLineType$2 as DescriptionLineType,\n PhysicalProperties$4 as PhysicalProperties,\n ecomV1CheckoutTemplate_universal_d_PaymentOption as PaymentOption,\n PaymentOptionType$3 as PaymentOptionType,\n CustomLineItem$1 as CustomLineItem,\n PriceDescription$2 as PriceDescription,\n ItemType$3 as ItemType,\n ItemTypeItemTypeDataOneOf$3 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$3 as ItemTypeItemType,\n SubscriptionOptionInfo$1 as SubscriptionOptionInfo,\n SubscriptionSettings$4 as SubscriptionSettings,\n SubscriptionFrequency$4 as SubscriptionFrequency,\n ecomV1CheckoutTemplate_universal_d_FreeTrialPeriod as FreeTrialPeriod,\n ecomV1CheckoutTemplate_universal_d_Title as Title,\n ecomV1CheckoutTemplate_universal_d_Description as Description,\n SecuredMedia$1 as SecuredMedia,\n FileType$1 as FileType,\n ServiceProperties$2 as ServiceProperties,\n ecomV1CheckoutTemplate_universal_d_Policy as Policy,\n ExtendedFields$7 as ExtendedFields,\n ecomV1CheckoutTemplate_universal_d_CustomContentReference as CustomContentReference,\n ExternalReference$1 as ExternalReference,\n ecomV1CheckoutTemplate_universal_d_CreateCheckoutTemplateRequest as CreateCheckoutTemplateRequest,\n ecomV1CheckoutTemplate_universal_d_CreateCheckoutTemplateResponse as CreateCheckoutTemplateResponse,\n ecomV1CheckoutTemplate_universal_d_GetCheckoutTemplateRequest as GetCheckoutTemplateRequest,\n ecomV1CheckoutTemplate_universal_d_GetCheckoutTemplateResponse as GetCheckoutTemplateResponse,\n ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplateRequest as UpdateCheckoutTemplateRequest,\n ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplateResponse as UpdateCheckoutTemplateResponse,\n ecomV1CheckoutTemplate_universal_d_DeleteCheckoutTemplateRequest as DeleteCheckoutTemplateRequest,\n ecomV1CheckoutTemplate_universal_d_DeleteCheckoutTemplateResponse as DeleteCheckoutTemplateResponse,\n ecomV1CheckoutTemplate_universal_d_QueryCheckoutTemplatesRequest as QueryCheckoutTemplatesRequest,\n CursorQuery$7 as CursorQuery,\n CursorQueryPagingMethodOneOf$7 as CursorQueryPagingMethodOneOf,\n Sorting$b as Sorting,\n SortOrder$b as SortOrder,\n CursorPaging$b as CursorPaging,\n ecomV1CheckoutTemplate_universal_d_QueryCheckoutTemplatesResponse as QueryCheckoutTemplatesResponse,\n CursorPagingMetadata$a as CursorPagingMetadata,\n Cursors$b as Cursors,\n ecomV1CheckoutTemplate_universal_d_CreateCheckoutFromTemplateRequest as CreateCheckoutFromTemplateRequest,\n ecomV1CheckoutTemplate_universal_d_CreateCheckoutFromTemplateResponse as CreateCheckoutFromTemplateResponse,\n ecomV1CheckoutTemplate_universal_d_CheckoutTemplateUsed as CheckoutTemplateUsed,\n ecomV1CheckoutTemplate_universal_d_Checkout as Checkout,\n ecomV1CheckoutTemplate_universal_d_V1LineItem as V1LineItem,\n MultiCurrencyPrice$1 as MultiCurrencyPrice,\n ItemTaxFullDetails$3 as ItemTaxFullDetails,\n TaxRateBreakdown$1 as TaxRateBreakdown,\n TaxBreakdown$1 as TaxBreakdown,\n JurisdictionType$3 as JurisdictionType,\n FocalPoint$2 as FocalPoint,\n ecomV1CheckoutTemplate_universal_d_ItemAvailabilityInfo as ItemAvailabilityInfo,\n ecomV1CheckoutTemplate_universal_d_ItemAvailabilityStatus as ItemAvailabilityStatus,\n Scope$1 as Scope,\n Group$1 as Group,\n TaxableAddress$3 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$3 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$3 as TaxableAddressType,\n AddressWithContact$2 as AddressWithContact,\n Address$7 as Address,\n StreetAddress$6 as StreetAddress,\n AddressLocation$6 as AddressLocation,\n FullAddressContactDetails$3 as FullAddressContactDetails,\n VatId$4 as VatId,\n VatType$4 as VatType,\n ShippingInfo$1 as ShippingInfo,\n SelectedCarrierServiceOption$1 as SelectedCarrierServiceOption,\n DeliveryLogistics$4 as DeliveryLogistics,\n PickupDetails$5 as PickupDetails,\n PickupMethod$4 as PickupMethod,\n DeliveryTimeSlot$4 as DeliveryTimeSlot,\n SelectedCarrierServiceOptionPrices$1 as SelectedCarrierServiceOptionPrices,\n SelectedCarrierServiceOptionOtherCharge$1 as SelectedCarrierServiceOptionOtherCharge,\n ChargeType$3 as ChargeType,\n DeliveryAllocation$2 as DeliveryAllocation,\n Carrier$2 as Carrier,\n Region$2 as Region,\n ApplicableLineItems$2 as ApplicableLineItems,\n ShippingRegion$3 as ShippingRegion,\n CarrierServiceOption$1 as CarrierServiceOption,\n ShippingOption$3 as ShippingOption,\n ShippingPrice$3 as ShippingPrice,\n OtherCharge$1 as OtherCharge,\n BuyerInfo$4 as BuyerInfo,\n BuyerInfoIdOneOf$2 as BuyerInfoIdOneOf,\n PriceSummary$3 as PriceSummary,\n CalculationErrors$2 as CalculationErrors,\n CalculationErrorsShippingCalculationErrorOneOf$2 as CalculationErrorsShippingCalculationErrorOneOf,\n Details$3 as Details,\n DetailsKindOneOf$3 as DetailsKindOneOf,\n ApplicationError$8 as ApplicationError,\n ValidationError$3 as ValidationError,\n RuleType$3 as RuleType,\n FieldViolation$3 as FieldViolation,\n SystemError$3 as SystemError,\n CarrierErrors$2 as CarrierErrors,\n CarrierError$3 as CarrierError,\n GiftCard$3 as GiftCard,\n AppliedDiscount$3 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$3 as AppliedDiscountDiscountSourceOneOf,\n DiscountType$3 as DiscountType,\n Coupon$3 as Coupon,\n MerchantDiscount$3 as MerchantDiscount,\n DiscountRule$3 as DiscountRule,\n DiscountRuleName$3 as DiscountRuleName,\n LineItemDiscount$3 as LineItemDiscount,\n CustomField$3 as CustomField,\n WeightUnit$5 as WeightUnit,\n TaxSummary$3 as TaxSummary,\n TaxCalculationDetails$1 as TaxCalculationDetails,\n TaxCalculationDetailsCalculationDetailsOneOf$1 as TaxCalculationDetailsCalculationDetailsOneOf,\n RateType$1 as RateType,\n ManualCalculationReason$1 as ManualCalculationReason,\n AutoTaxFallbackCalculationDetails$1 as AutoTaxFallbackCalculationDetails,\n FallbackReason$1 as FallbackReason,\n AggregatedTaxBreakdown$1 as AggregatedTaxBreakdown,\n ChannelType$3 as ChannelType,\n CreatedBy$3 as CreatedBy,\n CreatedByIdOneOf$1 as CreatedByIdOneOf,\n MembershipOptions$1 as MembershipOptions,\n Membership$1 as Membership,\n MembershipName$3 as MembershipName,\n MembershipPaymentCredits$1 as MembershipPaymentCredits,\n InvalidMembership$1 as InvalidMembership,\n SelectedMemberships$1 as SelectedMemberships,\n SelectedMembership$1 as SelectedMembership,\n AdditionalFee$3 as AdditionalFee,\n ecomV1CheckoutTemplate_universal_d_ConversionInfo as ConversionInfo,\n ecomV1CheckoutTemplate_universal_d_Violation as Violation,\n ecomV1CheckoutTemplate_universal_d_Severity as Severity,\n ecomV1CheckoutTemplate_universal_d_Target as Target,\n ecomV1CheckoutTemplate_universal_d_TargetTargetTypeOneOf as TargetTargetTypeOneOf,\n ecomV1CheckoutTemplate_universal_d_NameInOther as NameInOther,\n ecomV1CheckoutTemplate_universal_d_NameInLineItem as NameInLineItem,\n ecomV1CheckoutTemplate_universal_d_SuggestedFix as SuggestedFix,\n ecomV1CheckoutTemplate_universal_d_Other as Other,\n ecomV1CheckoutTemplate_universal_d_TargetLineItem as TargetLineItem,\n ecomV1CheckoutTemplate_universal_d_CustomSettings as CustomSettings,\n ecomV1CheckoutTemplate_universal_d_CreateAndRedirectToCheckoutRequest as CreateAndRedirectToCheckoutRequest,\n ecomV1CheckoutTemplate_universal_d_RawHttpResponse as RawHttpResponse,\n ecomV1CheckoutTemplate_universal_d_HeadersEntry as HeadersEntry,\n DomainEvent$e as DomainEvent,\n DomainEventBodyOneOf$e as DomainEventBodyOneOf,\n EntityCreatedEvent$e as EntityCreatedEvent,\n RestoreInfo$e as RestoreInfo,\n EntityUpdatedEvent$e as EntityUpdatedEvent,\n EntityDeletedEvent$e as EntityDeletedEvent,\n ActionEvent$e as ActionEvent,\n MessageEnvelope$d as MessageEnvelope,\n IdentificationData$e as IdentificationData,\n IdentificationDataIdOneOf$e as IdentificationDataIdOneOf,\n WebhookIdentityType$d as WebhookIdentityType,\n ecomV1CheckoutTemplate_universal_d_createCheckoutTemplate as createCheckoutTemplate,\n ecomV1CheckoutTemplate_universal_d_getCheckoutTemplate as getCheckoutTemplate,\n ecomV1CheckoutTemplate_universal_d_updateCheckoutTemplate as updateCheckoutTemplate,\n ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplate as UpdateCheckoutTemplate,\n ecomV1CheckoutTemplate_universal_d_UpdateCheckoutTemplateOptions as UpdateCheckoutTemplateOptions,\n ecomV1CheckoutTemplate_universal_d_deleteCheckoutTemplate as deleteCheckoutTemplate,\n ecomV1CheckoutTemplate_universal_d_queryCheckoutTemplates as queryCheckoutTemplates,\n ecomV1CheckoutTemplate_universal_d_CheckoutTemplatesQueryResult as CheckoutTemplatesQueryResult,\n ecomV1CheckoutTemplate_universal_d_CheckoutTemplatesQueryBuilder as CheckoutTemplatesQueryBuilder,\n ecomV1CheckoutTemplate_universal_d_createCheckoutFromTemplate as createCheckoutFromTemplate,\n ecomV1CheckoutTemplate_universal_d_createAndRedirectToCheckout as createAndRedirectToCheckout,\n };\n }\n \n /**\n * A DeliveryProfile is a ...\n * You can ...\n * Read more about DeliveryProfiles\n * in this [article]().\n */\n interface DeliveryProfile {\n /**\n * DeliveryProfile ID.\n * @readonly\n */\n _id?: string | null;\n /** DeliveryProfile name. */\n name?: string | null;\n /**\n * Indicates that this DeliveryProfile is the default DeliveryProfile.\n * @readonly\n */\n default?: boolean | null;\n /** A list of DeliveryProfile regions. */\n deliveryRegions?: DeliveryRegion[];\n /** ID of the delivery profile's creator. */\n createdBy?: CreatedBy$2;\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the DeliveryProfile was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the DeliveryProfile was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Extended fields. */\n extendedFields?: ExtendedFields$6;\n }\n /** DeliveryRegion can be used to config a Delivery Destinations with its providers */\n interface DeliveryRegion {\n /**\n * The delivery region id.\n * @readonly\n */\n _id?: string | null;\n /** Optional name of the rule, for example: \"Domestic\". */\n name?: string | null;\n /** Indicates that this rule is active, default value is true. */\n active?: boolean | null;\n /**\n * The spi implementers id of shipping-rates spi, assigned to this rule.\n * @readonly\n */\n deliveryCarriers?: DeliveryCarrier[];\n /** The operation region of this rule, if empty than it is global. */\n destinations?: Destination$1[];\n /**\n * Represents the time this Profile was created\n * @readonly\n */\n _createdDate?: Date | null;\n }\n interface DeliveryCarrier {\n /** AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api. */\n appId?: string;\n /** Backup rate to be used in case the cost returned by the provider is empty. */\n backupRate?: BackupRate;\n /** Additional charges to add to the delivery rate for this carrier */\n additionalCharges?: AdditionalCharge$1[];\n }\n interface BackupRate {\n /** Default rate prefix that will concatenate to the delivery options the provider will offer. */\n prefix?: string | null;\n /** Default rate price for all delivery options that the provider will offer. */\n rate?: string | null;\n /** Should the default rate be used. Default value is false. */\n enabled?: boolean | null;\n }\n interface AdditionalCharge$1 {\n /** Additional charge type. */\n type?: ChargeType$2;\n /** Description of the additional charge. For example, `\"Handling fee of $5 applied for gift wrapping\"`. */\n description?: string | null;\n /** Cost of additional charge. For example, `12.5`. */\n price?: string;\n }\n enum ChargeType$2 {\n HANDLING_FEE = \"HANDLING_FEE\"\n }\n /** Defines the area inside one country that is relevant for this rule. */\n interface Destination$1 {\n /** 2-letters code represents the country of the delivery destinations */\n countryCode?: string;\n /**\n * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\n * If empty, the rule applies to the entire country.\n */\n subdivisions?: string[];\n }\n interface CreatedBy$2 extends CreatedByIdOneOf {\n /** App ID - when the delivery profile was created by an external application or Wix service. */\n appId?: string | null;\n /** User ID - when the delivery profile was created by a Wix user. */\n userId?: string | null;\n }\n /** @oneof */\n interface CreatedByIdOneOf {\n /** App ID - when the delivery profile was created by an external application or Wix service. */\n appId?: string | null;\n /** User ID - when the delivery profile was created by a Wix user. */\n userId?: string | null;\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 DeliveryRegionAdded {\n /** The DeliveryProfile owns this region. */\n deliveryProfileId?: string;\n /**\n * The delivery region id.\n * @readonly\n */\n deliveryRegionId?: string | null;\n /** Optional name of the rule, for example: \"Domestic\". */\n name?: string | null;\n /** Indicates that this rule is active, default value is true. */\n active?: boolean | null;\n /**\n * The spi implementers id of shipping-rates spi, assigned to this rule.\n * @readonly\n */\n deliveryCarriers?: DeliveryCarrier[];\n /** The operation region of this rule, if empty than it is global. */\n destinations?: Destination$1[];\n /**\n * Represents the time this Profile was created\n * @readonly\n */\n _createdDate?: Date | null;\n }\n interface DeliveryRegionRemoved {\n /** The DeliveryProfile owns this region. */\n deliveryProfileId?: string;\n /** The removed DeliveryRegion id. */\n deliveryRegionId?: string;\n }\n interface DeliveryRegionUpdated {\n /** The DeliveryProfile owns this DeliveryRegion. */\n deliveryProfileId?: string;\n /**\n * The delivery region id.\n * @readonly\n */\n deliveryRegionId?: string | null;\n /** Optional name of the rule, for example: \"Domestic\". */\n name?: string | null;\n /** Indicates that this rule is active, default value is true. */\n active?: boolean | null;\n /**\n * The spi implementers id of shipping-rates spi, assigned to this rule.\n * @readonly\n */\n deliveryCarriers?: DeliveryCarrier[];\n /** The operation region of this rule, if empty than it is global. */\n destinations?: Destination$1[];\n /**\n * Represents the time this Profile was created\n * @readonly\n */\n _createdDate?: Date | null;\n }\n interface CreateDeliveryProfileRequest {\n /** DeliveryProfile to be created. */\n deliveryProfile: DeliveryProfile;\n }\n interface CreateDeliveryProfileResponse {\n /** The created DeliveryProfile. */\n deliveryProfile?: DeliveryProfile;\n }\n interface GetDeliveryProfileRequest {\n /** ID of the DeliveryProfile to retrieve. */\n deliveryProfileId: string;\n }\n interface GetDeliveryProfileResponse {\n /** The requested DeliveryProfile. */\n deliveryProfile?: DeliveryProfile;\n }\n interface UpdateDeliveryProfileRequest {\n /** DeliveryProfile to be updated, may be partial. */\n deliveryProfile: DeliveryProfile;\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateDeliveryProfileResponse {\n /** Updated DeliveryProfile. */\n deliveryProfile?: DeliveryProfile;\n }\n interface DeleteDeliveryProfileRequest {\n /** Id of the DeliveryProfile to delete. */\n deliveryProfileId: string;\n }\n interface DeleteDeliveryProfileResponse {\n }\n interface QueryDeliveryProfilesRequest {\n /** WQL expression. */\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$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$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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$a {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$a {\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 QueryDeliveryProfilesResponse {\n /** List of DeliveryProfiles. */\n deliveryProfiles?: DeliveryProfile[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$9;\n }\n interface CursorPagingMetadata$9 {\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$a;\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$a {\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 AddDeliveryRegionRequest$2 {\n /** delivery profile id to associated with the DeliveryRegion */\n deliveryProfileId: string;\n /** DeliveryRegion to be created */\n deliveryRegion: DeliveryRegion;\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n }\n interface AddDeliveryRegionResponse$2 {\n /** The updated DeliveryProfile with the new DeliveryRegion */\n deliveryProfile?: DeliveryProfile;\n }\n interface UpdateDeliveryRegionRequest {\n /** DeliveryProfile id that owns the DeliveryRegion */\n deliveryProfileId: string;\n /** DeliveryRegion to be updated, may be partial */\n deliveryRegion: DeliveryRegion;\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n }\n interface UpdateDeliveryRegionResponse {\n /** The updated DeliveryProfile with the updated DeliveryRegion */\n deliveryProfile?: DeliveryProfile;\n }\n interface RemoveDeliveryRegionRequest$2 {\n /** DeliveryProfile id that owns the DeliveryRegion */\n deliveryProfileId: string;\n /** Id of the DeliveryRegion to delete */\n deliveryRegionId: string;\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n }\n interface RemoveDeliveryRegionResponse$2 {\n /** The updated DeliveryProfile without DeliveryRegion */\n deliveryProfile?: DeliveryProfile;\n }\n interface AddDeliveryCarrierRequest {\n /** delivery_region id to associated with the delivery_carrier. */\n deliveryRegionId: string;\n /** delivery_carrier to be added. */\n deliveryCarrier: DeliveryCarrier;\n }\n interface AddDeliveryCarrierResponse {\n /** The updated DeliveryProfile */\n deliveryProfile?: DeliveryProfile;\n }\n interface RemoveDeliveryCarrierRequest {\n /** Id of the DeliveryRegion */\n deliveryRegionId: string;\n /** DeliveryCarrier app id to be removed. */\n appId: string;\n }\n interface RemoveDeliveryCarrierResponse {\n /** The updated DeliveryProfile */\n deliveryProfile?: DeliveryProfile;\n }\n interface UpdateDeliveryCarrierRequest {\n /** DeliveryRegion id */\n deliveryRegionId: string;\n /** Updated delivery_carrier */\n deliveryCarrier?: DeliveryCarrier;\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateDeliveryCarrierResponse {\n /** The updated DeliveryProfile with the updated DeliveryCarrier */\n deliveryProfile?: DeliveryProfile;\n }\n interface ListDeliveryCarrierDetailsRequest {\n }\n interface ListDeliveryCarrierDetailsResponse {\n /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */\n deliveryCarrierDetails?: DeliveryCarrierDetails[];\n }\n interface DeliveryCarrierDetails {\n /** The id of the provider. */\n _id?: string;\n /** The name of the Provider. */\n displayName?: string;\n /** Provider's description. */\n description?: string | null;\n /** A link to learn more about the provider. */\n learnMoreUrl?: string | null;\n /** Dashboard URL for the provider. */\n dashboardUrl?: string | null;\n /** If the provider fallback definition is mandatory. */\n fallbackDefinitionMandatory?: boolean | null;\n /** Thumbnail image for provider. */\n thumbnailUrl?: string | null;\n /** feature toggle initialized with default value = false. should be true if implemented by spi provider */\n toggleGetCarrierSettingsEnabled?: boolean;\n }\n interface ListDeliveryCarriersRequest {\n /** Delivery profile id. */\n deliveryProfileId: string;\n /** Delivery app ids to get settings for. */\n appIds?: string[];\n }\n interface ListDeliveryCarriersResponse {\n /** The list of delivery settings for the given requests */\n results?: ListDeliveryCarriersResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface ListDeliveryCarriersResult {\n /** Information about successful action or error for failure. */\n deliveryCarrierMetadata?: ItemMetadata$3;\n /** The delivery carrier details */\n deliveryCarrierDetails?: DeliveryCarrierDetails;\n /** The delivery settings for the delivery profile and delivery region. */\n deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];\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 /** 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 DeliveryCarrierRegionalSettings {\n /** The delivery rule id. */\n deliveryRegionId?: string;\n /** The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers. */\n dashboardTables?: DashboardTable[];\n }\n interface DashboardTable {\n /** The title of the delivery settings that will be displayed in the UI. */\n title?: string;\n /** The columns of the delivery settings that will be displayed in the UI. */\n columns?: Column[];\n /** The content of the delivery settings. Each row is a map of column name to value. */\n rows?: Row[];\n }\n interface Column {\n /** The name of the column. This is used to get the data from the row. */\n key?: string;\n /** The title of the column that will be displayed in the UI. */\n name?: string;\n }\n interface Row {\n /** The external key of the data presented in a row. This is used to identify the row in the UI for editing. */\n key?: string;\n /**\n * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.\n * Data will be in JSON format.\n */\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 UpdateExtendedFieldsRequest$4 {\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$4 {\n /** Updated DeliveryProfile. */\n deliveryProfile?: DeliveryProfile;\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$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 {\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$1;\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$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 * 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 /** 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$1;\n /** A new namespace. */\n newNamespace?: Namespace$1;\n }\n /** Assigned Studio editor */\n interface StudioAssigned {\n }\n /** Unassigned Studio editor */\n interface StudioUnassigned {\n }\n interface Empty$7 {\n }\n interface DomainEvent$d extends DomainEventBodyOneOf$d {\n createdEvent?: EntityCreatedEvent$d;\n updatedEvent?: EntityUpdatedEvent$d;\n deletedEvent?: EntityDeletedEvent$d;\n actionEvent?: ActionEvent$d;\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$d {\n createdEvent?: EntityCreatedEvent$d;\n updatedEvent?: EntityUpdatedEvent$d;\n deletedEvent?: EntityDeletedEvent$d;\n actionEvent?: ActionEvent$d;\n }\n interface EntityCreatedEvent$d {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$d;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$d {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$d {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$d {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$d {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$c {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$d;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$d extends IdentificationDataIdOneOf$d {\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$c;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$d {\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$c {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a DeliveryProfile.\n *\n * The request body must include the DeliveryProfiles name. DeliveryRegions are optional.\n * @param deliveryProfile - DeliveryProfile to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryProfile\n * @requiredField deliveryProfile.deliveryRegions.deliveryCarriers.backupRate.rate\n * @requiredField deliveryProfile.deliveryRegions.destinations\n * @requiredField deliveryProfile.deliveryRegions.destinations.countryCode\n * @requiredField deliveryProfile.deliveryRegions.name\n * @requiredField deliveryProfile.name\n * @permissionId ECOM.DELIVERY_PROFILE_CREATE\n * @adminMethod\n * @returns The created DeliveryProfile.\n */\n function createDeliveryProfile(deliveryProfile: DeliveryProfile): Promise;\n /**\n * Retrieves a DeliveryProfile.\n * @param deliveryProfileId - ID of the DeliveryProfile to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryProfileId\n * @permissionId ECOM.DELIVERY_PROFILE_READ\n * @returns The requested DeliveryProfile.\n */\n function getDeliveryProfile(deliveryProfileId: string): Promise;\n /**\n * Updates a DeliveryProfile.\n *\n *\n * Each time the DeliveryProfile is updated,\n * `revision` increments by 1.\n * The current `revision` must be passed when updating the DeliveryProfile.\n * This ensures you're working with the latest DeliveryProfile\n * and prevents unintended overwrites.\n *\n * This method does not allow updating the DeliveryRegions in this DeliveryProfile.\n * Use AddDeliveryRegion, UpdateDeliveryRegion and RemoveDeliveryRegion for these functionalities.\n * @param _id - DeliveryProfile ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField deliveryProfile\n * @requiredField deliveryProfile.revision\n * @permissionId ECOM.DELIVERY_PROFILE_UPDATE\n * @adminMethod\n * @returns Updated DeliveryProfile.\n */\n function updateDeliveryProfile(_id: string | null, deliveryProfile: UpdateDeliveryProfile, options?: UpdateDeliveryProfileOptions): Promise;\n interface UpdateDeliveryProfile {\n /**\n * DeliveryProfile ID.\n * @readonly\n */\n _id?: string | null;\n /** DeliveryProfile name. */\n name?: string | null;\n /**\n * Indicates that this DeliveryProfile is the default DeliveryProfile.\n * @readonly\n */\n default?: boolean | null;\n /** A list of DeliveryProfile regions. */\n deliveryRegions?: DeliveryRegion[];\n /** ID of the delivery profile's creator. */\n createdBy?: CreatedBy$2;\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the DeliveryProfile was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the DeliveryProfile was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Extended fields. */\n extendedFields?: ExtendedFields$6;\n }\n interface UpdateDeliveryProfileOptions {\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes a DeliveryProfile.\n *\n * Deleting a DeliveryProfile permanently removes them from the DeliveryProfile List.\n * @param deliveryProfileId - Id of the DeliveryProfile to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryProfileId\n * @permissionId ECOM.DELIVERY_PROFILE_DELETE\n * @adminMethod\n */\n function deleteDeliveryProfile(deliveryProfileId: string): Promise;\n /**\n * Retrieves a list of DeliveryProfiles, given the provided [paging, filtering, and sorting][1].\n *\n * Up to 1,000 DeliveryProfiles can be returned per request.\n *\n * To learn how to query DeliveryProfiles, 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 * @permissionId ECOM.DELIVERY_PROFILE_READ\n */\n function queryDeliveryProfiles(): DeliveryProfilesQueryBuilder;\n interface QueryCursorResult$a {\n cursors: Cursors$a;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DeliveryProfilesQueryResult extends QueryCursorResult$a {\n items: DeliveryProfile[];\n query: DeliveryProfilesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface DeliveryProfilesQueryBuilder {\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' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\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' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\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' | 'deliveryRegions.id', value: string) => DeliveryProfilesQueryBuilder;\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' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any[]) => DeliveryProfilesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.createdDate' | '_createdDate', value: boolean) => DeliveryProfilesQueryBuilder;\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' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.destinations' | 'deliveryRegions.createdDate' | '_createdDate'>) => DeliveryProfilesQueryBuilder;\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' | 'name' | 'default' | 'deliveryRegions.id' | 'deliveryRegions.active' | 'deliveryRegions.destinations' | 'deliveryRegions.createdDate' | '_createdDate'>) => DeliveryProfilesQueryBuilder;\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) => DeliveryProfilesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => DeliveryProfilesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Creates a new DeliveryRegion in an existing DeliveryProfile.\n * @param deliveryProfileId - delivery profile id to associated with the DeliveryRegion\n * @param deliveryRegion - DeliveryRegion to be created\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryProfileId\n * @requiredField deliveryRegion\n * @requiredField deliveryRegion.deliveryCarriers.backupRate.rate\n * @requiredField deliveryRegion.destinations.countryCode\n * @requiredField deliveryRegion.name\n * @permissionId ECOM.DELIVERY_REGION_CREATE\n * @adminMethod\n */\n function addDeliveryRegion$2(deliveryProfileId: string, deliveryRegion: DeliveryRegion, options?: AddDeliveryRegionOptions$2): Promise;\n interface AddDeliveryRegionOptions$2 {\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n }\n /**\n * Update a DeliveryRegion, supports partial update\n * Pass the latest `revision` for a successful update\n *\n * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.\n * Use AddDeliveryCarrier, UpdateDeliveryCarrier and RemoveDeliveryCarrier for these functionalities.\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryRegion\n * @requiredField identifiers\n * @requiredField identifiers.deliveryProfileId\n * @requiredField identifiers.deliveryRegionId\n * @permissionId ECOM.DELIVERY_REGION_UPDATE\n * @adminMethod\n */\n function updateDeliveryRegion(identifiers: UpdateDeliveryRegionIdentifiers, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise;\n interface UpdateDeliveryRegionIdentifiers {\n /** DeliveryProfile id that owns the DeliveryRegion */\n deliveryProfileId: string;\n /**\n * The delivery region id.\n * @readonly\n */\n deliveryRegionId?: string | null;\n }\n interface UpdateDeliveryRegion {\n /**\n * The delivery region id.\n * @readonly\n */\n _id?: string | null;\n /** Optional name of the rule, for example: \"Domestic\". */\n name?: string | null;\n /** Indicates that this rule is active, default value is true. */\n active?: boolean | null;\n /**\n * The spi implementers id of shipping-rates spi, assigned to this rule.\n * @readonly\n */\n deliveryCarriers?: DeliveryCarrier[];\n /** The operation region of this rule, if empty than it is global. */\n destinations?: Destination$1[];\n /**\n * Represents the time this Profile was created\n * @readonly\n */\n _createdDate?: Date | null;\n }\n interface UpdateDeliveryRegionOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n }\n /**\n * Delete a DeliveryRegion\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.deliveryProfileId\n * @requiredField identifiers.deliveryRegionId\n * @permissionId ECOM.DELIVERY_REGION_DELETE\n * @adminMethod\n */\n function removeDeliveryRegion$2(identifiers: RemoveDeliveryRegionIdentifiers, options?: RemoveDeliveryRegionOptions$2): Promise;\n interface RemoveDeliveryRegionIdentifiers {\n /** DeliveryProfile id that owns the DeliveryRegion */\n deliveryProfileId: string;\n /** Id of the DeliveryRegion to delete */\n deliveryRegionId: string;\n }\n interface RemoveDeliveryRegionOptions$2 {\n /**\n * DeliveryProfile revision.\n * @readonly\n */\n revision?: string | null;\n }\n /**\n * Add a delivery_carrier to a delivery region\n * @param deliveryRegionId - delivery_region id to associated with the delivery_carrier.\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options\n * @requiredField options.deliveryCarrier\n * @requiredField options.deliveryCarrier.backupRate.rate\n * @permissionId ECOM.DELIVERY_CARRIER_ADD\n * @adminMethod\n */\n function addDeliveryCarrier(deliveryRegionId: string, options: AddDeliveryCarrierOptions): Promise;\n interface AddDeliveryCarrierOptions {\n /** delivery_carrier to be added. */\n deliveryCarrier: DeliveryCarrier;\n }\n /**\n * Remove a delivery_carrier from a delivery region\n * @param deliveryRegionId - Id of the DeliveryRegion\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options\n * @requiredField options.appId\n * @permissionId ECOM.DELIVERY_CARRIER_REMOVE\n * @adminMethod\n */\n function removeDeliveryCarrier(deliveryRegionId: string, options: RemoveDeliveryCarrierOptions): Promise;\n interface RemoveDeliveryCarrierOptions {\n /** DeliveryCarrier app id to be removed. */\n appId: string;\n }\n /**\n * Update a delivery carrier in a delivery region\n * @param deliveryRegionId - DeliveryRegion id\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options.deliveryCarrier.appId\n * @permissionId ECOM.DELIVERY_CARRIER_UPDATE\n * @adminMethod\n */\n function updateDeliveryCarrier(deliveryRegionId: string, options?: UpdateDeliveryCarrierOptions): Promise;\n interface UpdateDeliveryCarrierOptions {\n /** Updated delivery_carrier */\n deliveryCarrier?: DeliveryCarrier;\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * List all installed delivery carriers in order to set their ids in delivery rules\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.DELIVERY_CARRIER_DETAILS_READ\n * @adminMethod\n */\n function listDeliveryCarrierDetails(): Promise;\n /**\n * Get delivery carrier settings for a delivery profile and delivery region.\n * These are returned in a table format for the dashboard.\n * @param deliveryProfileId - Delivery profile id.\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryProfileId\n * @permissionId ECOM.DELIVERY_CARRIER_READ\n * @adminMethod\n */\n function listDeliveryCarriers(deliveryProfileId: string, options?: ListDeliveryCarriersOptions): Promise;\n interface ListDeliveryCarriersOptions {\n /** Delivery app ids to get settings for. */\n appIds?: string[];\n }\n /**\n * Updates extended fields of a DeliveryProfile without incrementing 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 ECOM.DELIVERY_PROFILE_UPDATE\n * @adminMethod\n */\n function updateExtendedFields$4(_id: string, namespace: string, options: UpdateExtendedFieldsOptions$4): Promise;\n interface UpdateExtendedFieldsOptions$4 {\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 type ecomV1DeliveryProfile_universal_d_DeliveryProfile = DeliveryProfile;\n type ecomV1DeliveryProfile_universal_d_DeliveryRegion = DeliveryRegion;\n type ecomV1DeliveryProfile_universal_d_DeliveryCarrier = DeliveryCarrier;\n type ecomV1DeliveryProfile_universal_d_BackupRate = BackupRate;\n type ecomV1DeliveryProfile_universal_d_CreatedByIdOneOf = CreatedByIdOneOf;\n type ecomV1DeliveryProfile_universal_d_DeliveryRegionAdded = DeliveryRegionAdded;\n type ecomV1DeliveryProfile_universal_d_DeliveryRegionRemoved = DeliveryRegionRemoved;\n type ecomV1DeliveryProfile_universal_d_DeliveryRegionUpdated = DeliveryRegionUpdated;\n type ecomV1DeliveryProfile_universal_d_CreateDeliveryProfileRequest = CreateDeliveryProfileRequest;\n type ecomV1DeliveryProfile_universal_d_CreateDeliveryProfileResponse = CreateDeliveryProfileResponse;\n type ecomV1DeliveryProfile_universal_d_GetDeliveryProfileRequest = GetDeliveryProfileRequest;\n type ecomV1DeliveryProfile_universal_d_GetDeliveryProfileResponse = GetDeliveryProfileResponse;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfileRequest = UpdateDeliveryProfileRequest;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfileResponse = UpdateDeliveryProfileResponse;\n type ecomV1DeliveryProfile_universal_d_DeleteDeliveryProfileRequest = DeleteDeliveryProfileRequest;\n type ecomV1DeliveryProfile_universal_d_DeleteDeliveryProfileResponse = DeleteDeliveryProfileResponse;\n type ecomV1DeliveryProfile_universal_d_QueryDeliveryProfilesRequest = QueryDeliveryProfilesRequest;\n type ecomV1DeliveryProfile_universal_d_QueryDeliveryProfilesResponse = QueryDeliveryProfilesResponse;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionRequest = UpdateDeliveryRegionRequest;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionResponse = UpdateDeliveryRegionResponse;\n type ecomV1DeliveryProfile_universal_d_AddDeliveryCarrierRequest = AddDeliveryCarrierRequest;\n type ecomV1DeliveryProfile_universal_d_AddDeliveryCarrierResponse = AddDeliveryCarrierResponse;\n type ecomV1DeliveryProfile_universal_d_RemoveDeliveryCarrierRequest = RemoveDeliveryCarrierRequest;\n type ecomV1DeliveryProfile_universal_d_RemoveDeliveryCarrierResponse = RemoveDeliveryCarrierResponse;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryCarrierRequest = UpdateDeliveryCarrierRequest;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryCarrierResponse = UpdateDeliveryCarrierResponse;\n type ecomV1DeliveryProfile_universal_d_ListDeliveryCarrierDetailsRequest = ListDeliveryCarrierDetailsRequest;\n type ecomV1DeliveryProfile_universal_d_ListDeliveryCarrierDetailsResponse = ListDeliveryCarrierDetailsResponse;\n type ecomV1DeliveryProfile_universal_d_DeliveryCarrierDetails = DeliveryCarrierDetails;\n type ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersRequest = ListDeliveryCarriersRequest;\n type ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersResponse = ListDeliveryCarriersResponse;\n type ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersResult = ListDeliveryCarriersResult;\n type ecomV1DeliveryProfile_universal_d_DeliveryCarrierRegionalSettings = DeliveryCarrierRegionalSettings;\n type ecomV1DeliveryProfile_universal_d_DashboardTable = DashboardTable;\n type ecomV1DeliveryProfile_universal_d_Column = Column;\n type ecomV1DeliveryProfile_universal_d_Row = Row;\n type ecomV1DeliveryProfile_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type ecomV1DeliveryProfile_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type ecomV1DeliveryProfile_universal_d_Asset = Asset;\n type ecomV1DeliveryProfile_universal_d_SiteCreated = SiteCreated;\n type ecomV1DeliveryProfile_universal_d_SiteCreatedContext = SiteCreatedContext;\n const ecomV1DeliveryProfile_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type ecomV1DeliveryProfile_universal_d_SiteTransferred = SiteTransferred;\n type ecomV1DeliveryProfile_universal_d_SiteDeleted = SiteDeleted;\n type ecomV1DeliveryProfile_universal_d_DeleteContext = DeleteContext;\n type ecomV1DeliveryProfile_universal_d_DeleteStatus = DeleteStatus;\n const ecomV1DeliveryProfile_universal_d_DeleteStatus: typeof DeleteStatus;\n type ecomV1DeliveryProfile_universal_d_SiteUndeleted = SiteUndeleted;\n type ecomV1DeliveryProfile_universal_d_SitePublished = SitePublished;\n type ecomV1DeliveryProfile_universal_d_SiteUnpublished = SiteUnpublished;\n type ecomV1DeliveryProfile_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type ecomV1DeliveryProfile_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type ecomV1DeliveryProfile_universal_d_ServiceProvisioned = ServiceProvisioned;\n type ecomV1DeliveryProfile_universal_d_ServiceRemoved = ServiceRemoved;\n type ecomV1DeliveryProfile_universal_d_SiteRenamed = SiteRenamed;\n type ecomV1DeliveryProfile_universal_d_SiteHardDeleted = SiteHardDeleted;\n type ecomV1DeliveryProfile_universal_d_NamespaceChanged = NamespaceChanged;\n type ecomV1DeliveryProfile_universal_d_StudioAssigned = StudioAssigned;\n type ecomV1DeliveryProfile_universal_d_StudioUnassigned = StudioUnassigned;\n const ecomV1DeliveryProfile_universal_d_createDeliveryProfile: typeof createDeliveryProfile;\n const ecomV1DeliveryProfile_universal_d_getDeliveryProfile: typeof getDeliveryProfile;\n const ecomV1DeliveryProfile_universal_d_updateDeliveryProfile: typeof updateDeliveryProfile;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfile = UpdateDeliveryProfile;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfileOptions = UpdateDeliveryProfileOptions;\n const ecomV1DeliveryProfile_universal_d_deleteDeliveryProfile: typeof deleteDeliveryProfile;\n const ecomV1DeliveryProfile_universal_d_queryDeliveryProfiles: typeof queryDeliveryProfiles;\n type ecomV1DeliveryProfile_universal_d_DeliveryProfilesQueryResult = DeliveryProfilesQueryResult;\n type ecomV1DeliveryProfile_universal_d_DeliveryProfilesQueryBuilder = DeliveryProfilesQueryBuilder;\n const ecomV1DeliveryProfile_universal_d_updateDeliveryRegion: typeof updateDeliveryRegion;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionIdentifiers = UpdateDeliveryRegionIdentifiers;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegion = UpdateDeliveryRegion;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionOptions = UpdateDeliveryRegionOptions;\n type ecomV1DeliveryProfile_universal_d_RemoveDeliveryRegionIdentifiers = RemoveDeliveryRegionIdentifiers;\n const ecomV1DeliveryProfile_universal_d_addDeliveryCarrier: typeof addDeliveryCarrier;\n type ecomV1DeliveryProfile_universal_d_AddDeliveryCarrierOptions = AddDeliveryCarrierOptions;\n const ecomV1DeliveryProfile_universal_d_removeDeliveryCarrier: typeof removeDeliveryCarrier;\n type ecomV1DeliveryProfile_universal_d_RemoveDeliveryCarrierOptions = RemoveDeliveryCarrierOptions;\n const ecomV1DeliveryProfile_universal_d_updateDeliveryCarrier: typeof updateDeliveryCarrier;\n type ecomV1DeliveryProfile_universal_d_UpdateDeliveryCarrierOptions = UpdateDeliveryCarrierOptions;\n const ecomV1DeliveryProfile_universal_d_listDeliveryCarrierDetails: typeof listDeliveryCarrierDetails;\n const ecomV1DeliveryProfile_universal_d_listDeliveryCarriers: typeof listDeliveryCarriers;\n type ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersOptions = ListDeliveryCarriersOptions;\n namespace ecomV1DeliveryProfile_universal_d {\n export {\n ecomV1DeliveryProfile_universal_d_DeliveryProfile as DeliveryProfile,\n ecomV1DeliveryProfile_universal_d_DeliveryRegion as DeliveryRegion,\n ecomV1DeliveryProfile_universal_d_DeliveryCarrier as DeliveryCarrier,\n ecomV1DeliveryProfile_universal_d_BackupRate as BackupRate,\n AdditionalCharge$1 as AdditionalCharge,\n ChargeType$2 as ChargeType,\n Destination$1 as Destination,\n CreatedBy$2 as CreatedBy,\n ecomV1DeliveryProfile_universal_d_CreatedByIdOneOf as CreatedByIdOneOf,\n ExtendedFields$6 as ExtendedFields,\n ecomV1DeliveryProfile_universal_d_DeliveryRegionAdded as DeliveryRegionAdded,\n ecomV1DeliveryProfile_universal_d_DeliveryRegionRemoved as DeliveryRegionRemoved,\n ecomV1DeliveryProfile_universal_d_DeliveryRegionUpdated as DeliveryRegionUpdated,\n ecomV1DeliveryProfile_universal_d_CreateDeliveryProfileRequest as CreateDeliveryProfileRequest,\n ecomV1DeliveryProfile_universal_d_CreateDeliveryProfileResponse as CreateDeliveryProfileResponse,\n ecomV1DeliveryProfile_universal_d_GetDeliveryProfileRequest as GetDeliveryProfileRequest,\n ecomV1DeliveryProfile_universal_d_GetDeliveryProfileResponse as GetDeliveryProfileResponse,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfileRequest as UpdateDeliveryProfileRequest,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfileResponse as UpdateDeliveryProfileResponse,\n ecomV1DeliveryProfile_universal_d_DeleteDeliveryProfileRequest as DeleteDeliveryProfileRequest,\n ecomV1DeliveryProfile_universal_d_DeleteDeliveryProfileResponse as DeleteDeliveryProfileResponse,\n ecomV1DeliveryProfile_universal_d_QueryDeliveryProfilesRequest as QueryDeliveryProfilesRequest,\n CursorQuery$6 as CursorQuery,\n CursorQueryPagingMethodOneOf$6 as CursorQueryPagingMethodOneOf,\n Sorting$a as Sorting,\n SortOrder$a as SortOrder,\n CursorPaging$a as CursorPaging,\n ecomV1DeliveryProfile_universal_d_QueryDeliveryProfilesResponse as QueryDeliveryProfilesResponse,\n CursorPagingMetadata$9 as CursorPagingMetadata,\n Cursors$a as Cursors,\n AddDeliveryRegionRequest$2 as AddDeliveryRegionRequest,\n AddDeliveryRegionResponse$2 as AddDeliveryRegionResponse,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionRequest as UpdateDeliveryRegionRequest,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionResponse as UpdateDeliveryRegionResponse,\n RemoveDeliveryRegionRequest$2 as RemoveDeliveryRegionRequest,\n RemoveDeliveryRegionResponse$2 as RemoveDeliveryRegionResponse,\n ecomV1DeliveryProfile_universal_d_AddDeliveryCarrierRequest as AddDeliveryCarrierRequest,\n ecomV1DeliveryProfile_universal_d_AddDeliveryCarrierResponse as AddDeliveryCarrierResponse,\n ecomV1DeliveryProfile_universal_d_RemoveDeliveryCarrierRequest as RemoveDeliveryCarrierRequest,\n ecomV1DeliveryProfile_universal_d_RemoveDeliveryCarrierResponse as RemoveDeliveryCarrierResponse,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryCarrierRequest as UpdateDeliveryCarrierRequest,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryCarrierResponse as UpdateDeliveryCarrierResponse,\n ecomV1DeliveryProfile_universal_d_ListDeliveryCarrierDetailsRequest as ListDeliveryCarrierDetailsRequest,\n ecomV1DeliveryProfile_universal_d_ListDeliveryCarrierDetailsResponse as ListDeliveryCarrierDetailsResponse,\n ecomV1DeliveryProfile_universal_d_DeliveryCarrierDetails as DeliveryCarrierDetails,\n ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersRequest as ListDeliveryCarriersRequest,\n ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersResponse as ListDeliveryCarriersResponse,\n ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersResult as ListDeliveryCarriersResult,\n ItemMetadata$3 as ItemMetadata,\n ApplicationError$7 as ApplicationError,\n ecomV1DeliveryProfile_universal_d_DeliveryCarrierRegionalSettings as DeliveryCarrierRegionalSettings,\n ecomV1DeliveryProfile_universal_d_DashboardTable as DashboardTable,\n ecomV1DeliveryProfile_universal_d_Column as Column,\n ecomV1DeliveryProfile_universal_d_Row as Row,\n BulkActionMetadata$3 as BulkActionMetadata,\n UpdateExtendedFieldsRequest$4 as UpdateExtendedFieldsRequest,\n UpdateExtendedFieldsResponse$4 as UpdateExtendedFieldsResponse,\n ecomV1DeliveryProfile_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n ecomV1DeliveryProfile_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n ecomV1DeliveryProfile_universal_d_Asset as Asset,\n State$1 as State,\n ecomV1DeliveryProfile_universal_d_SiteCreated as SiteCreated,\n ecomV1DeliveryProfile_universal_d_SiteCreatedContext as SiteCreatedContext,\n Namespace$1 as Namespace,\n ecomV1DeliveryProfile_universal_d_SiteTransferred as SiteTransferred,\n ecomV1DeliveryProfile_universal_d_SiteDeleted as SiteDeleted,\n ecomV1DeliveryProfile_universal_d_DeleteContext as DeleteContext,\n ecomV1DeliveryProfile_universal_d_DeleteStatus as DeleteStatus,\n ecomV1DeliveryProfile_universal_d_SiteUndeleted as SiteUndeleted,\n ecomV1DeliveryProfile_universal_d_SitePublished as SitePublished,\n ecomV1DeliveryProfile_universal_d_SiteUnpublished as SiteUnpublished,\n ecomV1DeliveryProfile_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n ecomV1DeliveryProfile_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n ecomV1DeliveryProfile_universal_d_ServiceProvisioned as ServiceProvisioned,\n ecomV1DeliveryProfile_universal_d_ServiceRemoved as ServiceRemoved,\n ecomV1DeliveryProfile_universal_d_SiteRenamed as SiteRenamed,\n ecomV1DeliveryProfile_universal_d_SiteHardDeleted as SiteHardDeleted,\n ecomV1DeliveryProfile_universal_d_NamespaceChanged as NamespaceChanged,\n ecomV1DeliveryProfile_universal_d_StudioAssigned as StudioAssigned,\n ecomV1DeliveryProfile_universal_d_StudioUnassigned as StudioUnassigned,\n Empty$7 as Empty,\n DomainEvent$d as DomainEvent,\n DomainEventBodyOneOf$d as DomainEventBodyOneOf,\n EntityCreatedEvent$d as EntityCreatedEvent,\n RestoreInfo$d as RestoreInfo,\n EntityUpdatedEvent$d as EntityUpdatedEvent,\n EntityDeletedEvent$d as EntityDeletedEvent,\n ActionEvent$d as ActionEvent,\n MessageEnvelope$c as MessageEnvelope,\n IdentificationData$d as IdentificationData,\n IdentificationDataIdOneOf$d as IdentificationDataIdOneOf,\n WebhookIdentityType$c as WebhookIdentityType,\n ecomV1DeliveryProfile_universal_d_createDeliveryProfile as createDeliveryProfile,\n ecomV1DeliveryProfile_universal_d_getDeliveryProfile as getDeliveryProfile,\n ecomV1DeliveryProfile_universal_d_updateDeliveryProfile as updateDeliveryProfile,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfile as UpdateDeliveryProfile,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryProfileOptions as UpdateDeliveryProfileOptions,\n ecomV1DeliveryProfile_universal_d_deleteDeliveryProfile as deleteDeliveryProfile,\n ecomV1DeliveryProfile_universal_d_queryDeliveryProfiles as queryDeliveryProfiles,\n ecomV1DeliveryProfile_universal_d_DeliveryProfilesQueryResult as DeliveryProfilesQueryResult,\n ecomV1DeliveryProfile_universal_d_DeliveryProfilesQueryBuilder as DeliveryProfilesQueryBuilder,\n addDeliveryRegion$2 as addDeliveryRegion,\n AddDeliveryRegionOptions$2 as AddDeliveryRegionOptions,\n ecomV1DeliveryProfile_universal_d_updateDeliveryRegion as updateDeliveryRegion,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionIdentifiers as UpdateDeliveryRegionIdentifiers,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegion as UpdateDeliveryRegion,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryRegionOptions as UpdateDeliveryRegionOptions,\n removeDeliveryRegion$2 as removeDeliveryRegion,\n ecomV1DeliveryProfile_universal_d_RemoveDeliveryRegionIdentifiers as RemoveDeliveryRegionIdentifiers,\n RemoveDeliveryRegionOptions$2 as RemoveDeliveryRegionOptions,\n ecomV1DeliveryProfile_universal_d_addDeliveryCarrier as addDeliveryCarrier,\n ecomV1DeliveryProfile_universal_d_AddDeliveryCarrierOptions as AddDeliveryCarrierOptions,\n ecomV1DeliveryProfile_universal_d_removeDeliveryCarrier as removeDeliveryCarrier,\n ecomV1DeliveryProfile_universal_d_RemoveDeliveryCarrierOptions as RemoveDeliveryCarrierOptions,\n ecomV1DeliveryProfile_universal_d_updateDeliveryCarrier as updateDeliveryCarrier,\n ecomV1DeliveryProfile_universal_d_UpdateDeliveryCarrierOptions as UpdateDeliveryCarrierOptions,\n ecomV1DeliveryProfile_universal_d_listDeliveryCarrierDetails as listDeliveryCarrierDetails,\n ecomV1DeliveryProfile_universal_d_listDeliveryCarriers as listDeliveryCarriers,\n ecomV1DeliveryProfile_universal_d_ListDeliveryCarriersOptions as ListDeliveryCarriersOptions,\n updateExtendedFields$4 as updateExtendedFields,\n UpdateExtendedFieldsOptions$4 as UpdateExtendedFieldsOptions,\n };\n }\n \n /** DraftOrder is the main entity of DraftOrders service. It represents a single edit order. */\n interface DraftOrder {\n /**\n * Draft order ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the order this draft commits to. */\n orderId?: string | null;\n /**\n * Line items.\n * Includes details about changes when relevant.\n */\n lineItems?: ItemDetails[];\n /**\n * Shipping info.\n * Includes details about changes when relevant.\n */\n shippingInfo?: ShippingDetails;\n /**\n * Buyer information.\n * @deprecated Buyer information.\n * @replacedBy buyer_info_details\n * @targetRemovalDate 2024-08-30\n */\n buyerInfo?: BuyerInfo$3;\n /**\n * Billing address and contact details.\n * @deprecated Billing address and contact details.\n * @replacedBy billing_info_details\n * @targetRemovalDate 2024-08-30\n */\n billingInfo?: AddressWithContact$1;\n /**\n * Additional fees.\n * Includes details about the source, and whether the additional fee is applied to the order.\n */\n additionalFees?: AdditionalFeeDetails[];\n /**\n * Discounts.\n * Includes details about the source, and whether the discount is applied to the order.\n */\n discounts?: DiscountDetails[];\n /**\n * Date and time the draft order was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the draft order was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Identity of the draft order's initiator.\n * @readonly\n */\n createdBy?: CreatedBy$1;\n /**\n * Draft order status.\n * @readonly\n */\n status?: EditingStatus;\n /** Weight measurement unit. Defaults to the site's weight unit. */\n weightUnit?: WeightUnit$4;\n /** Currency used for pricing. */\n currency?: string | null;\n /**\n * Price summary.\n * @readonly\n */\n priceSummary?: PriceSummary$2;\n /**\n * Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax summary.\n * @readonly\n * @deprecated Deprecated. Use `taxInfo` instead.\n * This field will be removed on September 30, 2024.\n * Tax summary.\n * @replacedBy tax_info\n * @targetRemovalDate 2024-09-30\n */\n taxSummary?: TaxSummary$2;\n /**\n * Balance summary.\n * @readonly\n */\n balanceSummary?: BalanceSummary$1;\n /** Side effects to perform on commit. */\n commitSettings?: DraftOrderCommitSettings$1;\n /** Member ID (if order created by a member). */\n memberId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n recipientInfo?: RecipientInfoDetails;\n /**\n * Tax information.\n * @internal\n */\n taxInfo?: OrderTaxInfo$1;\n /**\n * Custom field data for the draft order object.\n * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$5;\n /**\n * Buyer information.\n * Includes details about changes when relevant.\n * @internal\n */\n buyerDetails?: BuyerDetails$1;\n /**\n * Billing address and contact details.\n * Includes details about changes when relevant.\n * @internal\n */\n billingDetails?: BillingDetails;\n /**\n * Order business location\n * Includes details about changes when relevant.\n * @internal\n */\n businessLocationDetails?: BusinessLocationDetails;\n }\n interface ItemDetails extends ItemDetailsChangeTypeOneOf {\n /** Whether the line item was added as part of the draft. */\n added?: boolean;\n /** Line item fields before the change. */\n changedDetails?: ItemChangedDetails$1;\n /** Whether the line item was removed as part of the draft. */\n removed?: boolean;\n /** Line item details after applied changes. */\n lineItem?: OrderLineItem$1;\n }\n /** @oneof */\n interface ItemDetailsChangeTypeOneOf {\n /** Whether the line item was added as part of the draft. */\n added?: boolean;\n /** Line item fields before the change. */\n changedDetails?: ItemChangedDetails$1;\n /** Whether the line item was removed as part of the draft. */\n removed?: boolean;\n }\n interface Price$4 {\n /** Amount. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\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 OrderLineItem$1 {\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$1;\n /**\n * References to the line item's origin catalog.\n * This field may be empty in the case of a custom line item.\n */\n catalogReference?: CatalogReference$4;\n /** Line item quantity. */\n quantity?: number;\n /**\n * Total discount for this line item's entire quantity.\n * @readonly\n */\n totalDiscount?: Price$4;\n /** Line item description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: DescriptionLine$1[];\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$3;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$2;\n /**\n * Fulfiller ID. Field is empty when the line item is self-fulfilled.\n * To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).\n */\n fulfillerId?: string | null;\n /** Number of items that were refunded. */\n refundQuantity?: number | null;\n /** Number of items restocked. */\n restockQuantity?: number | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$4;\n /**\n * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: Price$4;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$4;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$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` 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$2;\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$2;\n /** Represents all the relevant tax details for a specific line item. */\n taxInfo?: LineItemTaxInfo$1;\n /** Digital file identifier, relevant only for items with type DIGITAL. */\n digitalFile?: DigitalFile$2;\n /** Subscription info. */\n subscriptionInfo?: SubscriptionInfo$2;\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 /**\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$4;\n /**\n * The Item's Delivery Profile Id\n * @internal\n */\n deliveryProfileId?: string | null;\n /** @internal */\n shippingGroupId?: string | null;\n /**\n * Source locations for this line item. The location's total quantity must not exceed the line item quantity.\n * @internal\n */\n locations?: LocationAndQuantity$1[];\n /**\n * Total price **after** catalog discounts and line item discounts.\n * @internal\n */\n lineItemPrice?: Price$4;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @internal\n * @readonly\n */\n customLineItem?: boolean | null;\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 * @internal\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Address used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$2;\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: boolean;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$5;\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 /** 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 [app dashboard](https://dev.wix.com/dc3/my-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 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 /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$1;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName$1;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType$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 * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue$1;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\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 /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\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 PhysicalProperties$3 {\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$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 /** 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 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 checkout. The 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$2 {\n /** Taxable amount of this line item. */\n taxableAmount?: Price$4;\n /**\n * ID of the item's tax group, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$4;\n }\n interface LineItemTaxInfo$1 {\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n taxAmount?: Price$4;\n /** Amount for which tax is calculated. */\n taxableAmount?: Price$4;\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$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 LineItemTaxBreakdown$1 {\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$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 /** Type of jurisdiction that taxes were calculated for. */\n jurisdictionType?: JurisdictionType$2;\n /** Non-taxable amount of the line item price. */\n nonTaxableAmount?: Price$4;\n /** Taxable amount of the line item price. */\n taxableAmount?: Price$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$2 {\n UNDEFINED = \"UNDEFINED\",\n COUNTRY = \"COUNTRY\",\n STATE = \"STATE\",\n COUNTY = \"COUNTY\",\n CITY = \"CITY\",\n SPECIAL = \"SPECIAL\"\n }\n interface DigitalFile$2 {\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 | null;\n }\n interface SubscriptionInfo$2 {\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$3;\n }\n interface SubscriptionSettings$3 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$3;\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 * Whether to allow the customer to cancel the subscription.\n * @internal\n */\n enableCustomerCancellation?: boolean;\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 LocationAndQuantity$1 {\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 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 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 ItemChangedDetails$1 {\n /** Line item quantity before change. */\n quantityBeforeChange?: number | null;\n /** Line item price before change. */\n priceBeforeChange?: Price$4;\n /** Line item price description before change. */\n priceDescriptionBeforeChange?: PriceDescription$1;\n }\n interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {\n /** Whether shipping info was added as part of the draft. */\n added?: boolean;\n /** Shipping info before the change. */\n changedDetails?: ShippingChangedDetails;\n /** Whether shipping info was removed as part of the draft. */\n removed?: boolean;\n /** Selected Shipping details. */\n shippingInfo?: ShippingInformation$2;\n }\n /** @oneof */\n interface ShippingDetailsChangeTypeOneOf {\n /** Whether shipping info was added as part of the draft. */\n added?: boolean;\n /** Shipping info before the change. */\n changedDetails?: ShippingChangedDetails;\n /** Whether shipping info was removed as part of the draft. */\n removed?: boolean;\n }\n interface ShippingInformation$2 {\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?: V1DeliveryLogistics;\n /** Shipping costs. */\n cost?: V1ShippingPrice;\n /** Shipping region. */\n region?: ShippingRegion$2;\n }\n interface V1DeliveryLogistics extends V1DeliveryLogisticsAddressOneOf {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact$1;\n /** Pickup details. */\n pickupDetails?: V1PickupDetails;\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 | null;\n /** Expected delivery time. */\n deliveryTimeSlot?: V1DeliveryTimeSlot;\n }\n /** @oneof */\n interface V1DeliveryLogisticsAddressOneOf {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact$1;\n /** Pickup details. */\n pickupDetails?: V1PickupDetails;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact$1 {\n /** Address. */\n address?: Address$6;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$2;\n }\n /** Physical address */\n interface Address$6 {\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$5;\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 /** @internal */\n location?: AddressLocation$5;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$5 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$5 {\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 V1PickupDetails {\n /** Pickup address. */\n address?: PickupAddress$2;\n /** Pickup method */\n pickupMethod?: PickupDetailsPickupMethod;\n }\n /** Physical address */\n interface PickupAddress$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 object, with number, name, and apartment number in separate fields. */\n streetAddress?: StreetAddress$5;\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 * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n /** @internal */\n location?: AddressLocation$5;\n }\n enum PickupDetailsPickupMethod {\n UNKNOWN_METHOD = \"UNKNOWN_METHOD\",\n STORE_PICKUP = \"STORE_PICKUP\",\n PICKUP_POINT = \"PICKUP_POINT\"\n }\n interface V1DeliveryTimeSlot {\n /** Delivery slot starting time. */\n from?: Date | null;\n /** Delivery slot ending time. */\n to?: Date | null;\n }\n interface V1ShippingPrice {\n /** Shipping price for display purposes. */\n price?: Price$4;\n /**\n * Total price of shipping after discounts (when relevant), and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$4;\n /**\n * Shipping price after all discounts (if any exist), and after tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$4;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$2;\n /**\n * Shipping discount before tax.\n * @readonly\n */\n discount?: Price$4;\n }\n interface ShippingRegion$2 {\n /** Name of shipping region. For example, `\"Metropolitan London\"`, or `\"Outer Melbourne suburbs\"`. */\n name?: string | null;\n }\n interface ShippingChangedDetails {\n /** Shipping info before the change. */\n shippingInfoBeforeChange?: ShippingInformation$2;\n }\n /** Buyer Info */\n interface BuyerInfo$3 extends BuyerInfoIdOneOf$1 {\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://dev.wix.com/api/rest/contacts/contacts/introduction). */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf$1 {\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 interface AdditionalFeeDetails {\n /** Additional fee. */\n additionalFee?: AdditionalFee$2;\n /** Tax details related to the additional fee. */\n taxDetails?: TaxDetails$1;\n /**\n * Source of the additional fee.\n *\n * Supported values:\n * + `ORIGINAL_ORDER`: This additional fee is part of the original order.\n * + `CUSTOM`: This additional fee was created by the [Create Custom Additional Fees](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-additional-fees) API.\n */\n source?: SourceType$1;\n /** Whether this additional fee is applied to the order. */\n applied?: boolean;\n }\n interface AdditionalFee$2 {\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$4;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$2;\n /** SPI implementer's `appId`. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: Price$4;\n /** Additional fee's price after tax. */\n priceAfterTax?: Price$4;\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 TaxDetails$1 {\n /** Indication if additional fee is taxable or not */\n taxable?: boolean;\n /** Optional tax group ID to use when calculating tax for this additional fee */\n taxGroupId?: string | null;\n }\n enum SourceType$1 {\n /** Part of the original order */\n ORIGINAL_ORDER = \"ORIGINAL_ORDER\",\n /** Added by estimate * */\n AUTOMATIC = \"AUTOMATIC\",\n /** Added manually to current draft order */\n CUSTOM = \"CUSTOM\"\n }\n interface DiscountDetails {\n /** Discount details. */\n discount?: AppliedDiscount$2;\n /**\n * Source of the discount.\n *\n * Supported values:\n * + `ORIGINAL_ORDER`: This discount is part of the original order.\n * + `CUSTOM`: This discount was created by the [Create Custom Discounts](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-discounts) API.\n */\n source?: SourceType$1;\n /** Whether this discount is applied to the order. */\n applied?: boolean;\n }\n interface AppliedDiscount$2 extends AppliedDiscountDiscountSourceOneOf$2 {\n /** Applied coupon info. */\n coupon?: Coupon$2;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$2;\n /** Automatic Discount */\n discountRule?: DiscountRule$2;\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?: AppliedDiscountDiscountType;\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 * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$2[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$2 {\n /** Applied coupon info. */\n coupon?: Coupon$2;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$2;\n /** Automatic Discount */\n discountRule?: DiscountRule$2;\n }\n enum AppliedDiscountDiscountType {\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n /** Coupon */\n interface Coupon$2 {\n /** Coupon ID. */\n _id?: string;\n /** Coupon code. */\n code?: string;\n /** Coupon name. */\n name?: string;\n /** Coupon value. */\n amount?: Price$4;\n }\n interface MerchantDiscount$2 extends MerchantDiscountMerchantDiscountReasonOneOf$1 {\n /**\n * Pre-defined discount reason (optional).\n * * `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange.\n */\n discountReason?: DiscountReason$1;\n /** Discount description as free text (optional). */\n description?: string | null;\n /** Discount amount. */\n amount?: Price$4;\n /**\n * Discount percentage.\n * @internal\n */\n percentage?: string | null;\n }\n /** @oneof */\n interface MerchantDiscountMerchantDiscountReasonOneOf$1 {\n /**\n * Pre-defined discount reason (optional).\n * * `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange.\n */\n discountReason?: DiscountReason$1;\n /** Discount description as free text (optional). */\n description?: string | null;\n }\n enum DiscountReason$1 {\n UNSPECIFIED = \"UNSPECIFIED\",\n EXCHANGED_ITEMS = \"EXCHANGED_ITEMS\"\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?: Price$4;\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$2 {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Total discount for this line item. */\n totalDiscount?: Price$4;\n }\n interface CreatedBy$1 extends CreatedByStringOneOf$1 {\n /** User ID. When the draft order was created by a Wix user. */\n userId?: string;\n /** App ID. When the draft order was created by an app. */\n appId?: string;\n }\n /** @oneof */\n interface CreatedByStringOneOf$1 {\n /** User ID. When the draft order was created by a Wix user. */\n userId?: string;\n /** App ID. When the draft order was created by an app. */\n appId?: string;\n }\n enum EditingStatus {\n /** DraftOrder is in draft state. */\n DRAFT = \"DRAFT\",\n /** DraftOrder is in committed state. */\n COMMITTED = \"COMMITTED\"\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 PriceSummary$2 {\n /** Subtotal of all the line items, before discounts and before tax. */\n subtotal?: Price$4;\n /** Total shipping price, before discounts and before tax. */\n shipping?: Price$4;\n /** Total tax on this order. */\n tax?: Price$4;\n /** Total calculated discount value. */\n discount?: Price$4;\n /**\n * Deprecated - use `total` instead.\n * @internal\n * @deprecated\n */\n totalPrice?: Price$4;\n /** Order’s total price after discounts and tax. */\n total?: Price$4;\n /**\n * Order's total price including gift card.\n * @internal\n * @deprecated\n */\n totalWithGiftCard?: Price$4;\n /**\n * Order's total price after without gift card.\n * @internal\n * @deprecated\n */\n totalWithoutGiftCard?: Price$4;\n /** Total price of additional fees before tax. */\n totalAdditionalFees?: Price$4;\n }\n interface TaxSummary$2 {\n /**\n * Total tax.\n * @readonly\n */\n totalTax?: Price$4;\n /**\n * manual tax rate\n * @internal\n * @readonly\n */\n manualTaxRate?: string | null;\n }\n interface BalanceSummary$1 {\n /**\n * Amount left to pay for order to be considered paid.\n * @readonly\n */\n balance?: Balance$1;\n /**\n * Sum of all approved and successful payments.\n *\n * The value includes payments that have subsequently been fully or partially refunded.\n * @internal\n * @readonly\n */\n paid?: Price$4;\n /**\n * Sum of all successfully refunded payments.\n * @internal\n * @readonly\n */\n refunded?: Price$4;\n /**\n * Sum of all authorized payments.\n * @readonly\n */\n authorized?: Price$4;\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$1 {\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 /** Side-effects upon committing a draft order. */\n interface DraftOrderCommitSettings$1 {\n /**\n * Whether to send notifications to the buyer.\n *\n * Default: `true`\n */\n sendNotificationsToBuyer?: boolean | null;\n /**\n * Whether to send notifications to the business.\n *\n * Default: `true`\n */\n sendNotificationsToBusiness?: boolean | null;\n /**\n * Whether to add activities to the order.\n *\n * Default: `true`\n */\n addActivitiesToOrder?: boolean | null;\n /**\n * Whether to send email notifications to custom fulfillers when there is a change in the shippable items they fulfill.\n *\n * Default: `true`\n */\n sendNotificationsToCustomFulfillers?: boolean | null;\n /**\n * Line item IDs for which to perform an inventory change.\n * When not provided, inventory will not change.\n */\n updateInventory?: InventoryUpdate[];\n }\n interface InventoryUpdate {\n /** Line item ID. */\n lineItemId?: string;\n }\n interface RecipientInfoDetails extends RecipientInfoDetailsChangeTypeOneOf {\n /** Indicates that recipient information was added during draft. */\n added?: boolean;\n /** Indicates that recipient information was changed. Contains recipient information before draft. */\n changedDetails?: RecipientInfoChangedDetails;\n /** Indicates that recipient information was removed during draft. */\n removed?: boolean;\n /** Order recipient address and contact details. */\n recipientInfo?: AddressWithContact$1;\n }\n /** @oneof */\n interface RecipientInfoDetailsChangeTypeOneOf {\n /** Indicates that recipient information was added during draft. */\n added?: boolean;\n /** Indicates that recipient information was changed. Contains recipient information before draft. */\n changedDetails?: RecipientInfoChangedDetails;\n /** Indicates that recipient information was removed during draft. */\n removed?: boolean;\n }\n interface RecipientInfoChangedDetails {\n /** Order recipient address and contact details before draft. */\n recipientInfoBeforeChange?: AddressWithContact$1;\n }\n interface OrderTaxInfo$1 {\n /** Calculated tax, added from line items. */\n totalTax?: Price$4;\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$1[];\n /**\n * Manual tax rate\n * @internal\n * @readonly\n */\n manualTaxRate?: string | null;\n /**\n * Whether the draft order is exempt from tax calculations.\n *\n * Default: `false`\n * @readonly\n */\n taxExempt?: boolean | 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 OrderTaxBreakdown$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 jurisdictionType?: JurisdictionType$2;\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$4;\n /**\n * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: Price$4;\n }\n interface BuyerDetails$1 extends BuyerDetailsChangeTypeOneOf {\n /**\n * Indicates that buyer information was added during draft.\n * @internal\n */\n added?: boolean;\n /**\n * Indicates that buyer information was changed. Contains billing information before draft.\n * @internal\n */\n changedDetails?: BuyerChangedDetails;\n /**\n * Indicates that buyer information was removed during draft.\n * @internal\n */\n removed?: boolean;\n /**\n * Buyer information.\n * @internal\n */\n buyerInfo?: BuyerInfo$3;\n }\n /** @oneof */\n interface BuyerDetailsChangeTypeOneOf {\n /**\n * Indicates that buyer information was added during draft.\n * @internal\n */\n added?: boolean;\n /**\n * Indicates that buyer information was changed. Contains billing information before draft.\n * @internal\n */\n changedDetails?: BuyerChangedDetails;\n /**\n * Indicates that buyer information was removed during draft.\n * @internal\n */\n removed?: boolean;\n }\n interface BuyerChangedDetails {\n /**\n * Buyer information before draft.\n * @internal\n */\n buyerInfoBeforeChange?: BuyerInfo$3;\n }\n interface BillingDetails extends BillingDetailsChangeTypeOneOf {\n /**\n * Indicates that billing information was added during draft.\n * @internal\n */\n added?: boolean;\n /**\n * Indicates that billing information was changed. Contains billing information before draft.\n * @internal\n */\n changedDetails?: BillingChangedDetails;\n /**\n * Indicates that billing information was removed during draft.\n * @internal\n */\n removed?: boolean;\n /**\n * Billing address and contact details.\n * @internal\n */\n billingInfo?: AddressWithContact$1;\n }\n /** @oneof */\n interface BillingDetailsChangeTypeOneOf {\n /**\n * Indicates that billing information was added during draft.\n * @internal\n */\n added?: boolean;\n /**\n * Indicates that billing information was changed. Contains billing information before draft.\n * @internal\n */\n changedDetails?: BillingChangedDetails;\n /**\n * Indicates that billing information was removed during draft.\n * @internal\n */\n removed?: boolean;\n }\n interface BillingChangedDetails {\n /**\n * Billing address and contact details before draft.\n * @internal\n */\n billingInfoBeforeChange?: AddressWithContact$1;\n }\n interface BusinessLocationDetails extends BusinessLocationDetailsChangeTypeOneOf {\n /**\n * Indicates that business location was added during draft.\n * @internal\n */\n added?: boolean;\n /**\n * Indicates that business location was changed. Contains business location before draft.\n * @internal\n */\n changedDetails?: BusinessLocationChangedDetails;\n /**\n * Indicates that business location was removed during draft.\n * @internal\n */\n removed?: boolean;\n /**\n * Business location.\n * @internal\n */\n businessLocation?: Location$1;\n }\n /** @oneof */\n interface BusinessLocationDetailsChangeTypeOneOf {\n /**\n * Indicates that business location was added during draft.\n * @internal\n */\n added?: boolean;\n /**\n * Indicates that business location was changed. Contains business location before draft.\n * @internal\n */\n changedDetails?: BusinessLocationChangedDetails;\n /**\n * Indicates that business location was removed during draft.\n * @internal\n */\n removed?: boolean;\n }\n interface Location$1 {\n /**\n * Location ID.\n * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n */\n _id?: string;\n /**\n * Location name.\n * @readonly\n */\n name?: string;\n }\n interface BusinessLocationChangedDetails {\n /**\n * Business location before draft.\n * @internal\n */\n businessLocationBeforeChange?: Location$1;\n }\n interface CreateDraftOrderRequest {\n /** To create a draft from existing order, provide its id. Otherwise, an empty draft will be created. */\n orderId: string | null;\n /**\n * If true and draft order already exists, it will be reset to the baseline order.\n * should this be a bool? will it always be private?\n * @internal\n */\n resetIfExists?: string | null;\n }\n interface CreateDraftOrderResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n /**\n * Whether the draft order already exists.\n * @internal\n */\n preexistingDraftOrder?: boolean | null;\n }\n interface CalculatedDraftOrder {\n /**\n * The draft order full details with calculations based on it's content.\n * Discount and additional fee options are also included.\n */\n draftOrder?: DraftOrder;\n /** Shipping options for the order. */\n shippingOptions?: ShippingOption$2[];\n /** Errors that occurred during calculation. */\n calculationErrors?: CalculationErrors$1;\n }\n interface ShippingOption$2 {\n /** This carrier's unique ID */\n carrierId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n /** Shipping rate title. For example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"`, or `\"First-Class Package International\"`. */\n title?: string;\n /** Shipping logistics. */\n logistics?: DeliveryLogistics$3;\n /** Shipping cost. */\n cost?: ShippingPrice$2;\n }\n interface DeliveryLogistics$3 {\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$4;\n /** Expected delivery time slot (from and to time stamps representation) */\n deliveryTimeSlot?: DeliveryTimeSlot$3;\n }\n interface PickupDetails$4 {\n /** Pickup address */\n address?: Address$6;\n /**\n * Pickup method.\n *\n * Supported values:\n * + `\"STORE_PICKUP\"`\n * + `\"PICKUP_POINT\"`\n */\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 | null;\n /** ending time of the delivery time slot */\n to?: Date | null;\n }\n interface ShippingPrice$2 {\n /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */\n price?: Price$4;\n /** Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function. */\n currency?: string;\n }\n interface CalculationErrors$1 extends CalculationErrorsShippingCalculationErrorOneOf$1 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$2;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$1;\n /** Tax calculation error. */\n taxCalculationError?: Details$2;\n /** Order validation errors. */\n orderValidationErrors?: ApplicationError$6[];\n }\n /** @oneof */\n interface CalculationErrorsShippingCalculationErrorOneOf$1 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$2;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors$1;\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\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$1 {\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 CreateEmptyDraftOrderRequest {\n }\n interface CreateEmptyDraftOrderResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface AddLineItemsToDraftOrderRequest {\n /** The draft order id */\n draftOrderId: string;\n /** Catalog line items to add to draft order. */\n catalogLineItems?: CatalogReferenceLineItem[];\n /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */\n customLineItems?: CustomLineItem[];\n }\n interface CatalogReferenceLineItem {\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 /** Item quantity. */\n quantity?: number;\n /** Item price override. */\n price?: Price$4;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n }\n interface CustomLineItem {\n /** Line item ID. */\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$4;\n /**\n * Item name.\n * + Stores - `product.name`\n * + Bookings - `service.info.name`\n * + Events - `ticket.name`\n */\n productName?: ProductName$1;\n /** URL to the item's page on the site. */\n url?: string;\n /** Item price **after** catalog-defined discount and line item discounts. */\n price?: Price$4;\n /** Total line item price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: Price$4;\n /** Item price **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: Price$4;\n /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: Price$4;\n /** Line item description lines. Used for display purposes for order. */\n descriptionLines?: DescriptionLine$1[];\n /** Line item image details. */\n media?: string;\n /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */\n physicalProperties?: PhysicalProperties$3;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$2;\n /**\n * Fulfiller ID for this item. Field is empty when the item is self-fulfilled.\n * @internal\n */\n fulfillerId?: string | null;\n /**\n * Shipping group ID.\n * @internal\n */\n shippingGroupId?: string | null;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL.\n * @internal\n */\n digitalFile?: SecuredMedia;\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 /** Delivery Profile Id for the product */\n deliveryProfileId?: 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 interface AddLineItemsToDraftOrderResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface UpdateLineItemsRequest {\n /** The draft order id */\n draftOrderId: string;\n /** Details of changes to apply per line item */\n lineItemChanges?: LineItemChangeDetails[];\n }\n interface LineItemChangeDetails {\n /** The line item id to change */\n lineItemId?: string;\n /** The new quantity for the line item. quantity zero means to remove the line item. */\n newQuantity?: number | null;\n /** The new price for 1 unit of the line item */\n newPrice?: string | null;\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 newPriceDescription?: PriceDescription$1;\n }\n interface UpdateLineItemsResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface SetDiscountsRequest {\n /** The draft order id */\n draftOrderId: string;\n /** The discount ids to opt-in. all existing discounts not listed are to be opted-out. */\n discounts: IdAndApplied[];\n }\n interface IdAndApplied {\n /** Discount ID. */\n _id?: string;\n /** Whether to apply the discount to the draft order. */\n applied?: boolean;\n }\n interface SetDiscountsResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface CreateCustomDiscountsRequest {\n /** The draft order id */\n draftOrderId: string;\n /** The discounts to add. */\n discounts?: DiscountOption[];\n }\n interface DiscountOption extends DiscountOptionDiscountAmountOneOf {\n /**\n * Discount price amount.\n * @internal\n */\n priceAmount?: Price$4;\n /**\n * Discount percentage amount.\n * @internal\n */\n percentage?: string | null;\n /**\n * Discount type.\n * * `\"GLOBAL\"` - discount applies to entire order.\n * * `\"SPECIFIC-ITEMS\"` - discount applies to a specific item.\n * * `\"SHIPPING\"` - discount applies to shipping. For example, free shipping.\n */\n discountType?: DiscountType$2;\n /**\n * ID of line item discount applies to.\n * @deprecated ID of line item discount applies to.\n * @replacedBy line_item_discounts\n * @targetRemovalDate 2024-10-30\n */\n lineItemId?: string | null;\n /**\n * Discount amount.\n * @deprecated Discount amount.\n * @replacedBy price_amount and percentage\n * @targetRemovalDate 2024-08-30\n */\n amount?: Price$4;\n /** Discount description as free text (optional). */\n description?: string | null;\n /**\n * Should opt-in the added discount. default = false.\n * if not set or false, then to opt-in them, please call SetDiscounts with the added discounts ids\n */\n applyToDraftOrder?: boolean | null;\n /**\n * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$2[];\n }\n /** @oneof */\n interface DiscountOptionDiscountAmountOneOf {\n /**\n * Discount price amount.\n * @internal\n */\n priceAmount?: Price$4;\n /**\n * Discount percentage amount.\n * @internal\n */\n percentage?: string | null;\n }\n enum DiscountType$2 {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n GLOBAL = \"GLOBAL\",\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n SHIPPING = \"SHIPPING\"\n }\n interface CreateCustomDiscountsResponse {\n /** The draft order details with the added discounts */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface DeleteCustomDiscountsRequest {\n /** The draft order id */\n draftOrderId: string;\n /** The discounts to remove */\n discountIds: string[];\n }\n interface DeleteCustomDiscountsResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface SetAdditionalFeesRequest {\n /** The draft order id */\n draftOrderId: string;\n /** The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out */\n additionalFees: IdAndApplied[];\n }\n interface SetAdditionalFeesResponse {\n /** The draft order details calculated with modified additional fees */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface CreateCustomAdditionalFeesRequest {\n /** The draft order id */\n draftOrderId: string;\n /** The additional fees to add. added with opted-out setting */\n customAdditionalFees?: AdditionalFeeOption[];\n }\n interface AdditionalFeeOption {\n /** Translated additional fee's name */\n name?: string;\n /** Additional fee's price */\n price?: Price$4;\n /** Tax calculation details */\n taxDetails?: TaxDetails$1;\n /**\n * Should apply the additional fee. default = false.\n * if not set or false, then to apply them, please call ApplyAdditionalFees with the added additional fee ids\n */\n applyToDraftOrder?: boolean | null;\n /** Additional fee's unique code (or ID) for future processing */\n code?: string | null;\n /**\n * Optional - Line items associated with this additional fee.\n * If no `lineItemIds` are provided, the fee will be associated with the whole order.\n * @internal\n */\n lineItemIds?: string[];\n }\n interface CreateCustomAdditionalFeesResponse {\n /** The draft order details with added custom additional fees */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface DeleteCustomAdditionalFeesRequest {\n /** The draft order id */\n draftOrderId: string;\n /** The additional fees to remove */\n customAdditionalFees: string[];\n }\n interface DeleteCustomAdditionalFeesResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface SetShippingInfoRequest {\n /**\n * The draft order id\n * @internal\n */\n draftOrderId: string;\n /**\n * The shipping info to be set. If passed empty value - value will be reset\n * @internal\n */\n shippingInfo?: ShippingInformation$2;\n }\n interface SetShippingInfoResponse {\n /**\n * The draft order details calculated with updated shipping info\n * @internal\n */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface SetBuyerInfoRequest {\n /**\n * The draft order id\n * @internal\n */\n draftOrderId: string;\n /**\n * Buyer information. If passed empty value - value will be reset\n * @internal\n */\n buyerInfo?: BuyerInfo$3;\n }\n interface SetBuyerInfoResponse {\n /**\n * The draft order details calculated with updated buyer info\n * @internal\n */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface SetRecipientInfoRequest {\n /**\n * The draft order id\n * @internal\n */\n draftOrderId: string;\n /**\n * Order recipient address and contact details. If passed empty value - value will be reset\n * @internal\n */\n recipientInfo?: AddressWithContact$1;\n }\n interface SetRecipientInfoResponse {\n /**\n * The draft order details calculated with updated recipient info\n * @internal\n */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface SetBillingInfoRequest {\n /**\n * The draft order id\n * @internal\n */\n draftOrderId: string;\n /**\n * Billing address and contact details. If passed empty value - value will be reset\n * @internal\n */\n billingInfo?: AddressWithContact$1;\n }\n interface SetBillingInfoResponse {\n /**\n * The draft order details calculated with updated billing info\n * @internal\n */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface UpdateShippingInfoRequest {\n /** The draft order id */\n draftOrderId: string;\n /** update the shipping option on the order. if not set then the selected shipping is removed */\n shippingOption?: ShippingOption$2;\n }\n interface UpdateShippingInfoResponse {\n /** The draft order details calculated with de/selected shipping info */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface GetDraftOrderRequest {\n /** The draft order id */\n draftOrderId: string;\n }\n interface GetDraftOrderResponse {\n /** The draft order details calculated with latest content */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface GetOrderDraftabilityStatusRequest {\n /** Order ID. */\n orderId: string;\n }\n interface GetOrderDraftabilityStatusResponse {\n /** Order ID. */\n orderId?: string;\n /** Whether a draft can be created from this order */\n orderDraftable?: boolean;\n /** Reasons why the order is not draftable */\n nonDraftableReasons?: NonDraftableReason[];\n }\n enum NonDraftableReason {\n UNSPECIFIED = \"UNSPECIFIED\",\n PARTIALLY_OR_FULLY_REFUNDED = \"PARTIALLY_OR_FULLY_REFUNDED\",\n UNSUPPORTED_CHANNEL_TYPE = \"UNSUPPORTED_CHANNEL_TYPE\",\n ORDER_STATUS_IS_NOT_SUPPORTED = \"ORDER_STATUS_IS_NOT_SUPPORTED\",\n ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT = \"ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT\",\n ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT = \"ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT\",\n AMOUNTS_DO_NOT_ADD_UP = \"AMOUNTS_DO_NOT_ADD_UP\",\n /** remove - this is not a reason, it's an error */\n ORDER_NOT_FOUND = \"ORDER_NOT_FOUND\",\n SUBSCRIPTION_LINE_ITEM_EXISTS = \"SUBSCRIPTION_LINE_ITEM_EXISTS\",\n UNSUPPORTED_CATALOG_ITEM = \"UNSUPPORTED_CATALOG_ITEM\",\n TAXABLE_EXISTING_ADDITIONAL_FEE = \"TAXABLE_EXISTING_ADDITIONAL_FEE\"\n }\n interface CommitDraftOrderRequest {\n /** The draft order id */\n draftOrderId: string;\n /** Optional side effects to trigger */\n commitSettings?: DraftOrderCommitSettings$1;\n /** Reason for edit, given by user (optional). */\n reason?: string | null;\n }\n interface CommitDraftOrderResponse {\n /** The draft order after commit. */\n committedDraftOrder?: DraftOrder;\n /** The updated order after commit. */\n orderAfterCommit?: Order$2;\n }\n interface Order$2 {\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 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 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 | null;\n /**\n * Order line items.\n * @readonly\n */\n lineItems?: OrderLineItem$1[];\n /** Buyer information. */\n buyerInfo?: BuyerInfo$3;\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$2;\n /**\n * Order fulfillment status.\n * @readonly\n */\n fulfillmentStatus?: FulfillmentStatus$3;\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$4;\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$2;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact$1;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: ShippingInformation$2;\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$1;\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$2;\n /** Tax information. */\n taxInfo?: OrderTaxInfo$1;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$2[];\n /**\n * Order activities.\n * @readonly\n */\n activities?: Activity$2[];\n /** Order attribution source. */\n attributionSource?: AttributionSource$1;\n /**\n * ID of the order's initiator.\n * @readonly\n */\n createdBy?: V1CreatedBy;\n /** Information about the sales channel that submitted this order. */\n channelInfo?: ChannelInfo$2;\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$2[];\n /**\n * Cart ID - required by TYP OOI for legacy orders.\n * @internal\n */\n cartId?: string | null;\n /**\n * Private API flag that allows using read-only \"id\" during order creation.\n * @internal\n */\n isInternalOrderCreate?: boolean;\n /**\n * Pay now price summary. Part of price_summary that must be payed at checkout\n * @internal\n * @readonly\n */\n payNow?: PriceSummary$2;\n /**\n * Balance summary.\n * @readonly\n */\n balanceSummary?: V1BalanceSummary;\n /** Additional fees applied to the order. */\n additionalFees?: AdditionalFee$2[];\n /**\n * Custom string status values aggregated from every fulfillment entity associated with current order\n * @internal\n * @readonly\n */\n fulfillmentStatusesAggregate?: FulfillmentStatusesAggregate$1;\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 app dashboard before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$5;\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$1;\n /**\n * Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable.\n * @internal\n */\n tags?: Tags$1;\n /**\n * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * Used for migration from external systems.\n */\n purchasedDate?: Date | null;\n /**\n * Order Location\n * @internal\n */\n businessLocation?: Location$1;\n }\n enum PaymentStatus$2 {\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 * Payment received but not yet confirmed by the payment provider and waits for some user action\n * @documentationMaturity preview\n */\n PENDING_MERCHANT = \"PENDING_MERCHANT\",\n /**\n * Payment was canceled by user on payment provider side\n * @documentationMaturity preview\n */\n CANCELED = \"CANCELED\",\n /**\n * Payment was declined by payment provider\n * @documentationMaturity preview\n */\n DECLINED = \"DECLINED\"\n }\n enum FulfillmentStatus$3 {\n /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */\n NOT_FULFILLED = \"NOT_FULFILLED\",\n /**\n * All of the order items are fulfilled or the 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 OrderStatus$1 {\n INITIALIZED = \"INITIALIZED\",\n APPROVED = \"APPROVED\",\n CANCELED = \"CANCELED\",\n /** @documentationMaturity preview */\n PENDING = \"PENDING\",\n /** @documentationMaturity preview */\n REJECTED = \"REJECTED\"\n }\n interface Activity$2 extends ActivityContentOneOf$1 {\n /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */\n customActivity?: CustomActivity$1;\n /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */\n merchantComment?: MerchantComment$1;\n /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */\n orderRefunded?: OrderRefunded$2;\n /**\n * Details of the original order for this exchange order. `activity.type` must be `ORDER_CREATED_FROM_EXCHANGE`.\n * @internal\n */\n orderCreatedFromExchange?: OrderCreatedFromExchange$1;\n /**\n * Details of an order that was created as a result of an exchange of items in this order. `activity.type` must be `NEW_EXCHANGE_ORDER_CREATED`.\n * @internal\n */\n newExchangeOrderCreated?: NewExchangeOrderCreated$1;\n /**\n * Details of changes made by the Draft Orders API.\n * @internal\n */\n draftOrderChangesApplied?: DraftOrderChangesApplied$1;\n /**\n * Details of the payment method saved for order\n * @internal\n */\n savedPaymentMethod?: SavedPaymentMethod$1;\n /**\n * Details of an authorized payment created.\n * @internal\n */\n authorizedPaymentCreated?: AuthorizedPaymentCreated$1;\n /**\n * Details of an authorized payment captured.\n * @internal\n */\n authorizedPaymentCaptured?: AuthorizedPaymentCaptured$1;\n /**\n * Details of an authorized payment voided.\n * @internal\n */\n authorizedPaymentVoided?: AuthorizedPaymentVoided$1;\n /**\n * Details of an initiated refund process.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n refundInitiated?: RefundInitiated$1;\n /**\n * Details of a refunded payment.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefunded?: PaymentRefunded$1;\n /**\n * Details of a failed payment refund.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefundFailed?: PaymentRefundFailed$1;\n /**\n * Details of refund to store credit.\n * @internal\n */\n refundedAsStoreCredit?: RefundedAsStoreCredit$1;\n /**\n * Details of a pending payment\n * @internal\n */\n paymentPending?: PaymentPending$1;\n /**\n * Details of a canceled payment\n * @internal\n */\n paymentCanceled?: PaymentCanceled$1;\n /**\n * Details of a declined payment\n * @internal\n */\n paymentDeclined?: PaymentDeclined$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 | null;\n /** Activity type. */\n type?: ActivityType$2;\n }\n /** @oneof */\n interface ActivityContentOneOf$1 {\n /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */\n customActivity?: CustomActivity$1;\n /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */\n merchantComment?: MerchantComment$1;\n /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */\n orderRefunded?: OrderRefunded$2;\n /**\n * Details of the original order for this exchange order. `activity.type` must be `ORDER_CREATED_FROM_EXCHANGE`.\n * @internal\n */\n orderCreatedFromExchange?: OrderCreatedFromExchange$1;\n /**\n * Details of an order that was created as a result of an exchange of items in this order. `activity.type` must be `NEW_EXCHANGE_ORDER_CREATED`.\n * @internal\n */\n newExchangeOrderCreated?: NewExchangeOrderCreated$1;\n /**\n * Details of changes made by the Draft Orders API.\n * @internal\n */\n draftOrderChangesApplied?: DraftOrderChangesApplied$1;\n /**\n * Details of the payment method saved for order\n * @internal\n */\n savedPaymentMethod?: SavedPaymentMethod$1;\n /**\n * Details of an authorized payment created.\n * @internal\n */\n authorizedPaymentCreated?: AuthorizedPaymentCreated$1;\n /**\n * Details of an authorized payment captured.\n * @internal\n */\n authorizedPaymentCaptured?: AuthorizedPaymentCaptured$1;\n /**\n * Details of an authorized payment voided.\n * @internal\n */\n authorizedPaymentVoided?: AuthorizedPaymentVoided$1;\n /**\n * Details of an initiated refund process.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n refundInitiated?: RefundInitiated$1;\n /**\n * Details of a refunded payment.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefunded?: PaymentRefunded$1;\n /**\n * Details of a failed payment refund.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefundFailed?: PaymentRefundFailed$1;\n /**\n * Details of refund to store credit.\n * @internal\n */\n refundedAsStoreCredit?: RefundedAsStoreCredit$1;\n /**\n * Details of a pending payment\n * @internal\n */\n paymentPending?: PaymentPending$1;\n /**\n * Details of a canceled payment\n * @internal\n */\n paymentCanceled?: PaymentCanceled$1;\n /**\n * Details of a declined payment\n * @internal\n */\n paymentDeclined?: PaymentDeclined$1;\n }\n interface CustomActivity$1 {\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$1 {\n /** Merchant comment message. */\n message?: string;\n }\n interface OrderRefunded$2 {\n /** Whether order was refunded manually. For example, via payment provider or using cash. */\n manual?: boolean;\n /** Refund amount. */\n amount?: Price$4;\n /** Reason for refund. */\n reason?: string;\n }\n interface OrderCreatedFromExchange$1 {\n /** ID of the original order for which the exchange happened. */\n originalOrderId?: string;\n }\n interface NewExchangeOrderCreated$1 {\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$1[];\n }\n interface LineItemExchangeData$1 {\n /** ID of the exchanged line item. */\n lineItemId?: string;\n /** Line item quantity being exchanged. */\n quantity?: number;\n }\n interface DraftOrderChangesApplied$1 {\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$1[];\n }\n interface OrderChange$1 extends OrderChangeValueOneOf$1 {\n lineItemChanged?: LineItemChanges$1;\n lineItemAdded?: ManagedLineItem$1;\n lineItemRemoved?: ManagedLineItem$1;\n discountAdded?: ManagedDiscount$1;\n discountRemoved?: ManagedDiscount$1;\n additionalFeeAdded?: ManagedAdditionalFee$1;\n additionalFeeRemoved?: ManagedAdditionalFee$1;\n totalPriceChanged?: TotalPriceChange$1;\n shippingInformationChanged?: ShippingInformationChange$1;\n }\n /** @oneof */\n interface OrderChangeValueOneOf$1 {\n lineItemChanged?: LineItemChanges$1;\n lineItemAdded?: ManagedLineItem$1;\n lineItemRemoved?: ManagedLineItem$1;\n discountAdded?: ManagedDiscount$1;\n discountRemoved?: ManagedDiscount$1;\n additionalFeeAdded?: ManagedAdditionalFee$1;\n additionalFeeRemoved?: ManagedAdditionalFee$1;\n totalPriceChanged?: TotalPriceChange$1;\n shippingInformationChanged?: ShippingInformationChange$1;\n }\n interface LineItemChanges$1 {\n /** Line item ID. */\n _id?: string;\n /** Item name. */\n name?: ProductName$1;\n /** Item quantity change. */\n quantity?: LineItemQuantityChange$1;\n /** Item price change. */\n price?: LineItemPriceChange$1;\n }\n interface LineItemQuantityChange$1 {\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$1;\n }\n enum LineItemQuantityChangeType$1 {\n /** Quantity increased. */\n QUANTITY_INCREASED = \"QUANTITY_INCREASED\",\n /** Quantity decreased. */\n QUANTITY_DECREASED = \"QUANTITY_DECREASED\"\n }\n interface LineItemPriceChange$1 {\n /** Item price before update. */\n originalPrice?: Price$4;\n /** Item price after update. */\n newPrice?: Price$4;\n }\n interface ManagedLineItem$1 {\n /** Line item ID. */\n _id?: string;\n /** Item name. */\n name?: ProductName$1;\n /** Added or removed item quantity. */\n quantity?: number;\n }\n interface ManagedDiscount$1 {\n /** Discount id. */\n _id?: string;\n /** Discount name: coupon name / discount rule name / merchant discount description. */\n name?: TranslatedValue$1;\n /** Line items discount applies to. */\n affectedLineItems?: LineItemAmount$1[];\n /** Discount amount. */\n totalAmount?: Price$4;\n }\n interface TranslatedValue$1 {\n /** Value in site default language. */\n original?: string;\n /** Translated value. */\n translated?: string | null;\n }\n interface LineItemAmount$1 {\n /** Order line item id */\n _id?: string;\n /** Item name. */\n name?: ProductName$1;\n /** Amount associated with this item. (Discount amount for item / additional fee amount for item) */\n amount?: Price$4;\n }\n interface ManagedAdditionalFee$1 {\n /** Additional fee id. */\n _id?: string;\n /** Additional fee name. */\n name?: TranslatedValue$1;\n /** Line items additional fee applies to. */\n affectedLineItems?: LineItemAmount$1[];\n /** Additional fee amount. */\n totalAmount?: Price$4;\n }\n interface TotalPriceChange$1 {\n /** Order’s total price after discounts and tax. Before update */\n originalTotal?: Price$4;\n /** Order’s total price after discounts and tax. After update */\n newTotal?: Price$4;\n }\n interface ShippingInformationChange$1 {\n /** Order’s Shipping Information. Before update */\n originalShippingInfo?: ShippingInformationChangeShippingInformation$1;\n /** Order’s Shipping Information. After update */\n newShippingInfo?: ShippingInformationChangeShippingInformation$1;\n }\n interface ShippingInformationChangeShippingInformation$1 {\n /** Order’s shipping price. */\n total?: Price$4;\n /** Order’s shipping title. */\n shippingTitle?: string;\n }\n /** Payment method is saved for order */\n interface SavedPaymentMethod$1 {\n /** Payment method name */\n name?: string;\n /** Payment method description */\n description?: string | null;\n }\n interface AuthorizedPaymentCreated$1 {\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n /** Payment amount */\n amount?: Price$4;\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$1 {\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n /** Payment amount */\n amount?: Price$4;\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$1 {\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n /** Payment amount */\n amount?: Price$4;\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 RefundInitiated$1 {\n /** Refund ID. */\n refundId?: string;\n /** Refund amount. */\n amount?: Price$4;\n /** Details about the payments being refunded. */\n payments?: RefundedPayment$1[];\n /** Reason for refund. */\n reason?: string | null;\n }\n interface RefundedPayment$1 extends RefundedPaymentKindOneOf$1 {\n /** Regular payment refund. */\n regular?: RegularPaymentRefund$1;\n /** Gift card payment refund. */\n giftCard?: GiftCardPaymentRefund$1;\n /** Membership payment refund. */\n membership?: MembershipPaymentRefund$1;\n /** Payment ID. */\n paymentId?: string;\n /** Whether refund was made externally and manually on the payment provider's side. */\n externalRefund?: boolean;\n }\n /** @oneof */\n interface RefundedPaymentKindOneOf$1 {\n /** Regular payment refund. */\n regular?: RegularPaymentRefund$1;\n /** Gift card payment refund. */\n giftCard?: GiftCardPaymentRefund$1;\n /** Membership payment refund. */\n membership?: MembershipPaymentRefund$1;\n }\n interface RegularPaymentRefund$1 {\n /** Refund amount */\n amount?: Price$4;\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 GiftCardPaymentRefund$1 {\n /** Gift card payment ID */\n giftCardPaymentId?: string | null;\n /** Refund amount */\n amount?: Price$4;\n }\n interface MembershipPaymentRefund$1 {\n /** Membership ID */\n membershipId?: string | null;\n }\n interface PaymentRefunded$1 {\n /** Refund ID. */\n refundId?: string;\n /** Details about the refunded payment. */\n payment?: RefundedPayment$1;\n }\n interface PaymentRefundFailed$1 {\n /** Refund ID. */\n refundId?: string;\n /** Details about the failed payment refund. */\n payment?: RefundedPayment$1;\n }\n interface RefundedAsStoreCredit$1 {\n /** Refund amount */\n amount?: Price$4;\n /** Reason for refund */\n reason?: string | null;\n }\n interface PaymentPending$1 extends PaymentPendingPaymentDetailsOneOf$1 {\n /** Regular payment. */\n regular?: RegularPayment$1;\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n }\n /** @oneof */\n interface PaymentPendingPaymentDetailsOneOf$1 {\n /** Regular payment. */\n regular?: RegularPayment$1;\n }\n interface RegularPayment$1 extends RegularPaymentPaymentMethodDetailsOneOf$1 {\n /** Whether regular card used */\n creditCardDetails?: CreditCardDetails$1;\n /** Payment amount */\n amount?: Price$4;\n }\n /** @oneof */\n interface RegularPaymentPaymentMethodDetailsOneOf$1 {\n /** Whether regular card used */\n creditCardDetails?: CreditCardDetails$1;\n }\n interface CreditCardDetails$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 PaymentCanceled$1 extends PaymentCanceledPaymentDetailsOneOf$1 {\n /** Regular payment. */\n regular?: RegularPayment$1;\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n }\n /** @oneof */\n interface PaymentCanceledPaymentDetailsOneOf$1 {\n /** Regular payment. */\n regular?: RegularPayment$1;\n }\n interface PaymentDeclined$1 extends PaymentDeclinedPaymentDetailsOneOf$1 {\n /** Regular payment. */\n regular?: RegularPayment$1;\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n }\n /** @oneof */\n interface PaymentDeclinedPaymentDetailsOneOf$1 {\n /** Regular payment. */\n regular?: RegularPayment$1;\n }\n enum ActivityType$2 {\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 REFUND_INITIATED = \"REFUND_INITIATED\",\n PAYMENT_REFUNDED = \"PAYMENT_REFUNDED\",\n PAYMENT_REFUND_FAILED = \"PAYMENT_REFUND_FAILED\",\n REFUNDED_AS_STORE_CREDIT = \"REFUNDED_AS_STORE_CREDIT\",\n /** @documentationMaturity preview */\n PAYMENT_PENDING = \"PAYMENT_PENDING\",\n /** @documentationMaturity preview */\n PAYMENT_CANCELED = \"PAYMENT_CANCELED\",\n /** @documentationMaturity preview */\n PAYMENT_DECLINED = \"PAYMENT_DECLINED\",\n /** @documentationMaturity preview */\n ORDER_PENDING = \"ORDER_PENDING\",\n /** @documentationMaturity preview */\n ORDER_REJECTED = \"ORDER_REJECTED\"\n }\n enum AttributionSource$1 {\n UNSPECIFIED = \"UNSPECIFIED\",\n FACEBOOK_ADS = \"FACEBOOK_ADS\"\n }\n interface V1CreatedBy extends V1CreatedByStringOneOf {\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 V1CreatedByStringOneOf {\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$2 {\n /** Sales channel that submitted the order. */\n type?: ChannelType$2;\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$2 {\n /** Unspecified sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\n FAIRE_COM = \"FAIRE_COM\"\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 interface V1BalanceSummary {\n /**\n * Current amount left to pay.\n * @readonly\n */\n balance?: Balance$1;\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$4;\n /**\n * Sum of all successfully refunded payments.\n * @readonly\n */\n refunded?: Price$4;\n /**\n * Sum of all authorized payments.\n * @readonly\n */\n authorized?: Price$4;\n /**\n * Sum of all pending refund transactions.\n * @internal\n * @readonly\n */\n pendingRefund?: Price$4;\n /**\n * Sum of all pending transactions.\n * @readonly\n */\n pending?: Price$4;\n }\n interface FulfillmentStatusesAggregate$1 {\n /** Unique string values based on Fulfillment entities statuses */\n statuses?: string[] | null;\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$1 {\n /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */\n privateTags?: TagList$1;\n /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */\n tags?: TagList$1;\n }\n interface TagList$1 {\n /** List of tag IDs */\n tagIds?: string[];\n }\n interface CreateOrderFromDraftRequest {\n /**\n * The draft order id\n * @internal\n */\n draftOrderId: string;\n /**\n * Optional side effects to trigger\n * @internal\n */\n createSettings?: OrderCreateSettings;\n /**\n * Reason for order creation, given by user (optional).\n * @internal\n */\n reason?: string | null;\n /**\n * Information about the sales channel that submitted this order\n * @internal\n */\n channelInfo?: ChannelInfo$2;\n }\n interface OrderCreateSettings {\n /**\n * Notification settings to be applied on order creation\n * @internal\n */\n notifications?: OrderCreateNotifications$1;\n }\n interface OrderCreateNotifications$1 {\n /**\n * Whether to send notification to the buyer.\n *\n * Default: `true`\n * @internal\n */\n sendNotificationToBuyer?: boolean | null;\n /**\n * Whether to send notifications to the business.\n *\n * Default: `true`\n * @internal\n */\n sendNotificationsToBusiness?: boolean | null;\n }\n interface CreateOrderFromDraftResponse {\n /**\n * The draft order after commit.\n * @internal\n */\n committedDraftOrder?: DraftOrder;\n /**\n * Created order\n * @internal\n */\n createdOrder?: Order$2;\n }\n interface DeleteDraftOrderRequest {\n /** The draft order id */\n draftOrderId: string;\n }\n interface DeleteDraftOrderResponse {\n }\n interface QueryDraftOrdersRequest {\n /** WQL expression */\n query?: CursorQuery$5;\n }\n interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {\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$9;\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$9[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$5 {\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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$9 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$9 {\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 QueryDraftOrdersResponse {\n /** list of edits per order */\n draftOrders?: DraftOrder[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$8;\n }\n interface CursorPagingMetadata$8 {\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$9;\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | null;\n }\n interface Cursors$9 {\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 UpdateExtendedFieldsRequest$3 {\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$3 {\n /** Updated DraftOrder */\n draftOrder?: DraftOrder;\n }\n interface SetTaxExemptionRequest {\n /**\n * Draft order ID.\n * @internal\n */\n draftOrderId: string;\n /**\n * Whether the draft order is exempt from tax calculations.\n *\n * Default: `false`\n * @internal\n */\n taxExempt: boolean | null;\n }\n interface SetTaxExemptionResponse {\n /**\n * The draft order details calculated with updated tax exemption.\n * @internal\n */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface GetDraftEditabilityStatusRequest {\n /** Draft order ID. */\n draftOrderId?: string | null;\n }\n interface GetDraftEditabilityStatusResponse {\n /** Draft order ID. */\n draftOrderId?: string | null;\n /**\n * Draft order status.\n * @readonly\n */\n status?: EditingStatus;\n }\n interface SetBusinessLocationRequest {\n /**\n * Draft order ID.\n * @internal\n */\n draftOrderId: string;\n /**\n * Business location.\n * @internal\n */\n businessLocation?: Location$1;\n }\n interface SetBusinessLocationResponse {\n /**\n * The draft order details calculated with updated business location.\n * @internal\n */\n calculatedDraftOrder?: CalculatedDraftOrder;\n }\n interface DomainEvent$c extends DomainEventBodyOneOf$c {\n createdEvent?: EntityCreatedEvent$c;\n updatedEvent?: EntityUpdatedEvent$c;\n deletedEvent?: EntityDeletedEvent$c;\n actionEvent?: ActionEvent$c;\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$c {\n createdEvent?: EntityCreatedEvent$c;\n updatedEvent?: EntityUpdatedEvent$c;\n deletedEvent?: EntityDeletedEvent$c;\n actionEvent?: ActionEvent$c;\n }\n interface EntityCreatedEvent$c {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$c;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$c {\n deletedDate?: Date | null;\n }\n interface EntityUpdatedEvent$c {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$c {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$c {\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$c;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$c extends IdentificationDataIdOneOf$c {\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$c {\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 /**\n * Creates or gets a draft order.\n *\n * When passing the ID of an order that is already in draft, the existing draft order will be returned.\n * To complete a draft and update the order, call [Commit Draft Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/commit-draft-order).\n * @param orderId - To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.\n * @public\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.DRAFT_ORDERS_CREATE\n * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS\n * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function createDraftOrder(orderId: string | null, options?: CreateDraftOrderOptions): Promise;\n interface CreateDraftOrderOptions {\n /**\n * If true and draft order already exists, it will be reset to the baseline order.\n * should this be a bool? will it always be private?\n * @internal\n */\n resetIfExists?: string | null;\n }\n /**\n * Creates an empty draft order.\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.DRAFT_ORDERS_CREATE\n * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS\n * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function createEmptyDraftOrder(): Promise;\n /**\n * Adds line items to a draft order.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @requiredField options.catalogLineItems.catalogReference\n * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS\n * @adminMethod\n */\n function addLineItemsToDraftOrder(draftOrderId: string, options?: AddLineItemsToDraftOrderOptions): Promise;\n interface AddLineItemsToDraftOrderOptions {\n /** Catalog line items to add to draft order. */\n catalogLineItems?: CatalogReferenceLineItem[];\n /** Custom line items to add to draft order. Custom line items don't trigger the Catalog service plugin. */\n customLineItems?: CustomLineItem[];\n }\n /**\n * Updates a draft order's line items.\n *\n * Using this API, you can update a line item's quantity, price, and description.\n * > **Notes:**\n * > + Passing a quantity of `0` will remove the line item.\n * > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.\n * > + Quantity cannot be decreased fulfilled line items. To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS\n * @adminMethod\n */\n function updateLineItems(draftOrderId: string, options?: UpdateLineItemsOptions): Promise;\n interface UpdateLineItemsOptions {\n /** Details of changes to apply per line item */\n lineItemChanges?: LineItemChangeDetails[];\n }\n /**\n * Sets and enables or disables discounts on a draft order.\n *\n * Any discounts not passed will not change.\n * @param draftOrderId - The draft order id\n * @param discounts - The discount ids to opt-in. all existing discounts not listed are to be opted-out.\n * @public\n * @documentationMaturity preview\n * @requiredField discounts\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS\n * @adminMethod\n */\n function setDiscounts(draftOrderId: string, discounts: IdAndApplied[]): Promise;\n /**\n * Adds merchant discounts to the order.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @requiredField options.discounts.amount\n * @requiredField options.discounts.amount.amount\n * @requiredField options.discounts.discountType\n * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS\n * @adminMethod\n */\n function createCustomDiscounts(draftOrderId: string, options?: CreateCustomDiscountsOptions): Promise;\n interface CreateCustomDiscountsOptions {\n /** The discounts to add. */\n discounts?: DiscountOption[];\n }\n /**\n * Remove custom discounts from the order.\n * @param draftOrderId - The draft order id\n * @param discountIds - The discounts to remove\n * @public\n * @documentationMaturity preview\n * @requiredField discountIds\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS\n * @adminMethod\n */\n function deleteCustomDiscounts(draftOrderId: string, discountIds: string[]): Promise;\n /**\n * Set which additional fees existing on the draft order are to be opt-in.\n * All existing additional fees not provided on the call are opted-out.\n * @param draftOrderId - The draft order id\n * @param additionalFees - The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out\n * @public\n * @documentationMaturity preview\n * @requiredField additionalFees\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES\n * @adminMethod\n */\n function setAdditionalFees(draftOrderId: string, additionalFees: IdAndApplied[]): Promise;\n /**\n * Create custom additional fees to the order.\n * added additional fees are by default opted-out.\n * To opt-in them, please call SetAdditionalFees with the added additional fee ids.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @requiredField options.customAdditionalFees.name\n * @requiredField options.customAdditionalFees.price\n * @requiredField options.customAdditionalFees.price.amount\n * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES\n * @adminMethod\n */\n function createCustomAdditionalFees(draftOrderId: string, options?: CreateCustomAdditionalFeesOptions): Promise;\n interface CreateCustomAdditionalFeesOptions {\n /** The additional fees to add. added with opted-out setting */\n customAdditionalFees?: AdditionalFeeOption[];\n }\n /**\n * Remove custom additional fees from the order.\n * @param draftOrderId - The draft order id\n * @param customAdditionalFees - The additional fees to remove\n * @public\n * @documentationMaturity preview\n * @requiredField customAdditionalFees\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES\n * @adminMethod\n */\n function deleteCustomAdditionalFees(draftOrderId: string, customAdditionalFees: string[]): Promise;\n /**\n * Sets shipping info to a draft order.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO\n * @adminMethod\n */\n function setShippingInfo(draftOrderId: string, options?: SetShippingInfoOptions): Promise;\n interface SetShippingInfoOptions {\n /**\n * The shipping info to be set. If passed empty value - value will be reset\n * @internal\n */\n shippingInfo?: ShippingInformation$2;\n }\n /**\n * Sets buyer info to a draft order.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO\n * @adminMethod\n */\n function setBuyerInfo(draftOrderId: string, options?: SetBuyerInfoOptions): Promise;\n interface SetBuyerInfoOptions {\n /**\n * Buyer information. If passed empty value - value will be reset\n * @internal\n */\n buyerInfo?: BuyerInfo$3;\n }\n /**\n * Sets recipient info to a draft order.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO\n * @adminMethod\n */\n function setRecipientInfo(draftOrderId: string, options?: SetRecipientInfoOptions): Promise;\n interface SetRecipientInfoOptions {\n /**\n * Order recipient address and contact details. If passed empty value - value will be reset\n * @internal\n */\n recipientInfo?: AddressWithContact$1;\n }\n /**\n * Sets billing info to a draft order.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO\n * @adminMethod\n */\n function setBillingInfo(draftOrderId: string, options?: SetBillingInfoOptions): Promise;\n interface SetBillingInfoOptions {\n /**\n * Billing address and contact details. If passed empty value - value will be reset\n * @internal\n */\n billingInfo?: AddressWithContact$1;\n }\n /**\n * Update shipping information on the order.\n * Allows also to remove the order shipping info.\n * @param draftOrderId - The draft order id\n * @internal\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @requiredField options.shippingOption.cost\n * @requiredField options.shippingOption.cost.price\n * @requiredField options.shippingOption.logistics\n * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING\n * @adminMethod\n * @deprecated\n * @replacedBy set-shipping-info\n * @targetRemovalDate 2024-08-30\n */\n function updateShippingInfo(draftOrderId: string, options?: UpdateShippingInfoOptions): Promise;\n interface UpdateShippingInfoOptions {\n /** update the shipping option on the order. if not set then the selected shipping is removed */\n shippingOption?: ShippingOption$2;\n }\n /**\n * Get an order.\n * When order is in draft status, it's re-estimated and return with latest tax and totals\n * Automatic discounts and automatic additional fees will reflect the latest prices and eligibility.\n * Calculation will be based on current draft order content - items, shipping info and eligible discounts and additional fees.\n * When order is in committed status, it's returned with it's calculation at the moment it was committed.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_READ\n * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function getDraftOrder(draftOrderId: string): Promise;\n /**\n * Checks whether a draft can be created for this order\n * @param orderId - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.DRAFT_ORDERS_READ\n * @adminMethod\n */\n function getOrderDraftabilityStatus(orderId: string): Promise;\n /**\n * Commit latest changes to the baseline order and control what side-effects will be applied.\n * Commit cannot be undone or reverted.\n * Order-edit become closed for editing, however it's kept for reference and can be retrieved.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_COMMIT\n * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function commitDraftOrder(draftOrderId: string, options?: CommitDraftOrderOptions): Promise;\n interface CommitDraftOrderOptions {\n /** Optional side effects to trigger */\n commitSettings?: DraftOrderCommitSettings$1;\n /** Reason for edit, given by user (optional). */\n reason?: string | null;\n }\n /**\n * Create new order and control what side-effects will be applied\n * Commit cannot be undone or reverted.\n * Order-edit become closed for editing, however it's kept for reference and can be retrieved.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT\n * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function createOrderFromDraft(draftOrderId: string, options?: CreateOrderFromDraftOptions): Promise;\n interface CreateOrderFromDraftOptions {\n /**\n * Optional side effects to trigger\n * @internal\n */\n createSettings?: OrderCreateSettings;\n /**\n * Reason for order creation, given by user (optional).\n * @internal\n */\n reason?: string | null;\n /**\n * Information about the sales channel that submitted this order\n * @internal\n */\n channelInfo?: ChannelInfo$2;\n }\n /**\n * Delete order-edit entity with all pending changes.\n * Order-edit in status 'COMMITTED' cannot be deleted.\n * @param draftOrderId - The draft order id\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_DELETE\n * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE\n * @adminMethod\n */\n function deleteDraftOrder(draftOrderId: string): Promise;\n /**\n * Query draft orders by order id or by date range or status.\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.DRAFT_ORDERS_READ\n * @adminMethod\n */\n function queryDraftOrders(): DraftOrdersQueryBuilder;\n interface QueryCursorResult$9 {\n cursors: Cursors$9;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DraftOrdersQueryResult extends QueryCursorResult$9 {\n items: DraftOrder[];\n query: DraftOrdersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface DraftOrdersQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;\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) => DraftOrdersQueryBuilder;\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) => DraftOrdersQueryBuilder;\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) => DraftOrdersQueryBuilder;\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) => DraftOrdersQueryBuilder;\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: 'orderId', value: string) => DraftOrdersQueryBuilder;\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: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => DraftOrdersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: any) => DraftOrdersQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'orderId' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => DraftOrdersQueryBuilder;\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' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;\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' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;\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) => DraftOrdersQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => DraftOrdersQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates extended fields of a DraftOrder\n * @param _id - ID of the entity to update.\n * @param namespace - Identifier for the app whose extended fields are being updated.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField namespace\n * @requiredField options\n * @requiredField options.namespaceData\n * @permissionId ECOM.DRAFT_ORDER_UPDATE_EXTENDED_FIELDS\n * @permissionId ECOM.DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function updateExtendedFields$3(_id: string, namespace: string, options: UpdateExtendedFieldsOptions$3): Promise;\n interface UpdateExtendedFieldsOptions$3 {\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 * Sets tax exemption to a draft order.\n * @param draftOrderId - Draft order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION\n * @adminMethod\n */\n function setTaxExemption(draftOrderId: string, options?: SetTaxExemptionOptions): Promise;\n interface SetTaxExemptionOptions {\n /**\n * Whether the draft order is exempt from tax calculations.\n *\n * Default: `false`\n * @internal\n */\n taxExempt: boolean | null;\n }\n /**\n * This is a test endpoint to test additional_bindings\n * @param draftOrderId - Draft order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDERS_READ\n * @adminMethod\n */\n function getDraftEditabilityStatus(draftOrderId: string | null): Promise;\n /**\n * Sets business location to a draft order.\n * @param draftOrderId - Draft order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION\n * @adminMethod\n */\n function setBusinessLocation(draftOrderId: string, options?: SetBusinessLocationOptions): Promise;\n interface SetBusinessLocationOptions {\n /**\n * Business location.\n * @internal\n */\n businessLocation?: Location$1;\n }\n \n type ecomV1DraftOrder_universal_d_DraftOrder = DraftOrder;\n type ecomV1DraftOrder_universal_d_ItemDetails = ItemDetails;\n type ecomV1DraftOrder_universal_d_ItemDetailsChangeTypeOneOf = ItemDetailsChangeTypeOneOf;\n type ecomV1DraftOrder_universal_d_ShippingDetails = ShippingDetails;\n type ecomV1DraftOrder_universal_d_ShippingDetailsChangeTypeOneOf = ShippingDetailsChangeTypeOneOf;\n type ecomV1DraftOrder_universal_d_V1DeliveryLogistics = V1DeliveryLogistics;\n type ecomV1DraftOrder_universal_d_V1DeliveryLogisticsAddressOneOf = V1DeliveryLogisticsAddressOneOf;\n type ecomV1DraftOrder_universal_d_V1PickupDetails = V1PickupDetails;\n type ecomV1DraftOrder_universal_d_PickupDetailsPickupMethod = PickupDetailsPickupMethod;\n const ecomV1DraftOrder_universal_d_PickupDetailsPickupMethod: typeof PickupDetailsPickupMethod;\n type ecomV1DraftOrder_universal_d_V1DeliveryTimeSlot = V1DeliveryTimeSlot;\n type ecomV1DraftOrder_universal_d_V1ShippingPrice = V1ShippingPrice;\n type ecomV1DraftOrder_universal_d_ShippingChangedDetails = ShippingChangedDetails;\n type ecomV1DraftOrder_universal_d_AdditionalFeeDetails = AdditionalFeeDetails;\n type ecomV1DraftOrder_universal_d_DiscountDetails = DiscountDetails;\n type ecomV1DraftOrder_universal_d_AppliedDiscountDiscountType = AppliedDiscountDiscountType;\n const ecomV1DraftOrder_universal_d_AppliedDiscountDiscountType: typeof AppliedDiscountDiscountType;\n type ecomV1DraftOrder_universal_d_EditingStatus = EditingStatus;\n const ecomV1DraftOrder_universal_d_EditingStatus: typeof EditingStatus;\n type ecomV1DraftOrder_universal_d_InventoryUpdate = InventoryUpdate;\n type ecomV1DraftOrder_universal_d_RecipientInfoDetails = RecipientInfoDetails;\n type ecomV1DraftOrder_universal_d_RecipientInfoDetailsChangeTypeOneOf = RecipientInfoDetailsChangeTypeOneOf;\n type ecomV1DraftOrder_universal_d_RecipientInfoChangedDetails = RecipientInfoChangedDetails;\n type ecomV1DraftOrder_universal_d_BuyerDetailsChangeTypeOneOf = BuyerDetailsChangeTypeOneOf;\n type ecomV1DraftOrder_universal_d_BuyerChangedDetails = BuyerChangedDetails;\n type ecomV1DraftOrder_universal_d_BillingDetails = BillingDetails;\n type ecomV1DraftOrder_universal_d_BillingDetailsChangeTypeOneOf = BillingDetailsChangeTypeOneOf;\n type ecomV1DraftOrder_universal_d_BillingChangedDetails = BillingChangedDetails;\n type ecomV1DraftOrder_universal_d_BusinessLocationDetails = BusinessLocationDetails;\n type ecomV1DraftOrder_universal_d_BusinessLocationDetailsChangeTypeOneOf = BusinessLocationDetailsChangeTypeOneOf;\n type ecomV1DraftOrder_universal_d_BusinessLocationChangedDetails = BusinessLocationChangedDetails;\n type ecomV1DraftOrder_universal_d_CreateDraftOrderRequest = CreateDraftOrderRequest;\n type ecomV1DraftOrder_universal_d_CreateDraftOrderResponse = CreateDraftOrderResponse;\n type ecomV1DraftOrder_universal_d_CalculatedDraftOrder = CalculatedDraftOrder;\n type ecomV1DraftOrder_universal_d_CreateEmptyDraftOrderRequest = CreateEmptyDraftOrderRequest;\n type ecomV1DraftOrder_universal_d_CreateEmptyDraftOrderResponse = CreateEmptyDraftOrderResponse;\n type ecomV1DraftOrder_universal_d_AddLineItemsToDraftOrderRequest = AddLineItemsToDraftOrderRequest;\n type ecomV1DraftOrder_universal_d_CatalogReferenceLineItem = CatalogReferenceLineItem;\n type ecomV1DraftOrder_universal_d_CustomLineItem = CustomLineItem;\n type ecomV1DraftOrder_universal_d_SecuredMedia = SecuredMedia;\n type ecomV1DraftOrder_universal_d_FileType = FileType;\n const ecomV1DraftOrder_universal_d_FileType: typeof FileType;\n type ecomV1DraftOrder_universal_d_AddLineItemsToDraftOrderResponse = AddLineItemsToDraftOrderResponse;\n type ecomV1DraftOrder_universal_d_UpdateLineItemsRequest = UpdateLineItemsRequest;\n type ecomV1DraftOrder_universal_d_LineItemChangeDetails = LineItemChangeDetails;\n type ecomV1DraftOrder_universal_d_UpdateLineItemsResponse = UpdateLineItemsResponse;\n type ecomV1DraftOrder_universal_d_SetDiscountsRequest = SetDiscountsRequest;\n type ecomV1DraftOrder_universal_d_IdAndApplied = IdAndApplied;\n type ecomV1DraftOrder_universal_d_SetDiscountsResponse = SetDiscountsResponse;\n type ecomV1DraftOrder_universal_d_CreateCustomDiscountsRequest = CreateCustomDiscountsRequest;\n type ecomV1DraftOrder_universal_d_DiscountOption = DiscountOption;\n type ecomV1DraftOrder_universal_d_DiscountOptionDiscountAmountOneOf = DiscountOptionDiscountAmountOneOf;\n type ecomV1DraftOrder_universal_d_CreateCustomDiscountsResponse = CreateCustomDiscountsResponse;\n type ecomV1DraftOrder_universal_d_DeleteCustomDiscountsRequest = DeleteCustomDiscountsRequest;\n type ecomV1DraftOrder_universal_d_DeleteCustomDiscountsResponse = DeleteCustomDiscountsResponse;\n type ecomV1DraftOrder_universal_d_SetAdditionalFeesRequest = SetAdditionalFeesRequest;\n type ecomV1DraftOrder_universal_d_SetAdditionalFeesResponse = SetAdditionalFeesResponse;\n type ecomV1DraftOrder_universal_d_CreateCustomAdditionalFeesRequest = CreateCustomAdditionalFeesRequest;\n type ecomV1DraftOrder_universal_d_AdditionalFeeOption = AdditionalFeeOption;\n type ecomV1DraftOrder_universal_d_CreateCustomAdditionalFeesResponse = CreateCustomAdditionalFeesResponse;\n type ecomV1DraftOrder_universal_d_DeleteCustomAdditionalFeesRequest = DeleteCustomAdditionalFeesRequest;\n type ecomV1DraftOrder_universal_d_DeleteCustomAdditionalFeesResponse = DeleteCustomAdditionalFeesResponse;\n type ecomV1DraftOrder_universal_d_SetShippingInfoRequest = SetShippingInfoRequest;\n type ecomV1DraftOrder_universal_d_SetShippingInfoResponse = SetShippingInfoResponse;\n type ecomV1DraftOrder_universal_d_SetBuyerInfoRequest = SetBuyerInfoRequest;\n type ecomV1DraftOrder_universal_d_SetBuyerInfoResponse = SetBuyerInfoResponse;\n type ecomV1DraftOrder_universal_d_SetRecipientInfoRequest = SetRecipientInfoRequest;\n type ecomV1DraftOrder_universal_d_SetRecipientInfoResponse = SetRecipientInfoResponse;\n type ecomV1DraftOrder_universal_d_SetBillingInfoRequest = SetBillingInfoRequest;\n type ecomV1DraftOrder_universal_d_SetBillingInfoResponse = SetBillingInfoResponse;\n type ecomV1DraftOrder_universal_d_UpdateShippingInfoRequest = UpdateShippingInfoRequest;\n type ecomV1DraftOrder_universal_d_UpdateShippingInfoResponse = UpdateShippingInfoResponse;\n type ecomV1DraftOrder_universal_d_GetDraftOrderRequest = GetDraftOrderRequest;\n type ecomV1DraftOrder_universal_d_GetDraftOrderResponse = GetDraftOrderResponse;\n type ecomV1DraftOrder_universal_d_GetOrderDraftabilityStatusRequest = GetOrderDraftabilityStatusRequest;\n type ecomV1DraftOrder_universal_d_GetOrderDraftabilityStatusResponse = GetOrderDraftabilityStatusResponse;\n type ecomV1DraftOrder_universal_d_NonDraftableReason = NonDraftableReason;\n const ecomV1DraftOrder_universal_d_NonDraftableReason: typeof NonDraftableReason;\n type ecomV1DraftOrder_universal_d_CommitDraftOrderRequest = CommitDraftOrderRequest;\n type ecomV1DraftOrder_universal_d_CommitDraftOrderResponse = CommitDraftOrderResponse;\n type ecomV1DraftOrder_universal_d_V1CreatedBy = V1CreatedBy;\n type ecomV1DraftOrder_universal_d_V1CreatedByStringOneOf = V1CreatedByStringOneOf;\n type ecomV1DraftOrder_universal_d_V1BalanceSummary = V1BalanceSummary;\n type ecomV1DraftOrder_universal_d_CreateOrderFromDraftRequest = CreateOrderFromDraftRequest;\n type ecomV1DraftOrder_universal_d_OrderCreateSettings = OrderCreateSettings;\n type ecomV1DraftOrder_universal_d_CreateOrderFromDraftResponse = CreateOrderFromDraftResponse;\n type ecomV1DraftOrder_universal_d_DeleteDraftOrderRequest = DeleteDraftOrderRequest;\n type ecomV1DraftOrder_universal_d_DeleteDraftOrderResponse = DeleteDraftOrderResponse;\n type ecomV1DraftOrder_universal_d_QueryDraftOrdersRequest = QueryDraftOrdersRequest;\n type ecomV1DraftOrder_universal_d_QueryDraftOrdersResponse = QueryDraftOrdersResponse;\n type ecomV1DraftOrder_universal_d_SetTaxExemptionRequest = SetTaxExemptionRequest;\n type ecomV1DraftOrder_universal_d_SetTaxExemptionResponse = SetTaxExemptionResponse;\n type ecomV1DraftOrder_universal_d_GetDraftEditabilityStatusRequest = GetDraftEditabilityStatusRequest;\n type ecomV1DraftOrder_universal_d_GetDraftEditabilityStatusResponse = GetDraftEditabilityStatusResponse;\n type ecomV1DraftOrder_universal_d_SetBusinessLocationRequest = SetBusinessLocationRequest;\n type ecomV1DraftOrder_universal_d_SetBusinessLocationResponse = SetBusinessLocationResponse;\n const ecomV1DraftOrder_universal_d_createDraftOrder: typeof createDraftOrder;\n type ecomV1DraftOrder_universal_d_CreateDraftOrderOptions = CreateDraftOrderOptions;\n const ecomV1DraftOrder_universal_d_createEmptyDraftOrder: typeof createEmptyDraftOrder;\n const ecomV1DraftOrder_universal_d_addLineItemsToDraftOrder: typeof addLineItemsToDraftOrder;\n type ecomV1DraftOrder_universal_d_AddLineItemsToDraftOrderOptions = AddLineItemsToDraftOrderOptions;\n const ecomV1DraftOrder_universal_d_updateLineItems: typeof updateLineItems;\n type ecomV1DraftOrder_universal_d_UpdateLineItemsOptions = UpdateLineItemsOptions;\n const ecomV1DraftOrder_universal_d_setDiscounts: typeof setDiscounts;\n const ecomV1DraftOrder_universal_d_createCustomDiscounts: typeof createCustomDiscounts;\n type ecomV1DraftOrder_universal_d_CreateCustomDiscountsOptions = CreateCustomDiscountsOptions;\n const ecomV1DraftOrder_universal_d_deleteCustomDiscounts: typeof deleteCustomDiscounts;\n const ecomV1DraftOrder_universal_d_setAdditionalFees: typeof setAdditionalFees;\n const ecomV1DraftOrder_universal_d_createCustomAdditionalFees: typeof createCustomAdditionalFees;\n type ecomV1DraftOrder_universal_d_CreateCustomAdditionalFeesOptions = CreateCustomAdditionalFeesOptions;\n const ecomV1DraftOrder_universal_d_deleteCustomAdditionalFees: typeof deleteCustomAdditionalFees;\n const ecomV1DraftOrder_universal_d_setShippingInfo: typeof setShippingInfo;\n type ecomV1DraftOrder_universal_d_SetShippingInfoOptions = SetShippingInfoOptions;\n const ecomV1DraftOrder_universal_d_setBuyerInfo: typeof setBuyerInfo;\n type ecomV1DraftOrder_universal_d_SetBuyerInfoOptions = SetBuyerInfoOptions;\n const ecomV1DraftOrder_universal_d_setRecipientInfo: typeof setRecipientInfo;\n type ecomV1DraftOrder_universal_d_SetRecipientInfoOptions = SetRecipientInfoOptions;\n const ecomV1DraftOrder_universal_d_setBillingInfo: typeof setBillingInfo;\n type ecomV1DraftOrder_universal_d_SetBillingInfoOptions = SetBillingInfoOptions;\n const ecomV1DraftOrder_universal_d_updateShippingInfo: typeof updateShippingInfo;\n type ecomV1DraftOrder_universal_d_UpdateShippingInfoOptions = UpdateShippingInfoOptions;\n const ecomV1DraftOrder_universal_d_getDraftOrder: typeof getDraftOrder;\n const ecomV1DraftOrder_universal_d_getOrderDraftabilityStatus: typeof getOrderDraftabilityStatus;\n const ecomV1DraftOrder_universal_d_commitDraftOrder: typeof commitDraftOrder;\n type ecomV1DraftOrder_universal_d_CommitDraftOrderOptions = CommitDraftOrderOptions;\n const ecomV1DraftOrder_universal_d_createOrderFromDraft: typeof createOrderFromDraft;\n type ecomV1DraftOrder_universal_d_CreateOrderFromDraftOptions = CreateOrderFromDraftOptions;\n const ecomV1DraftOrder_universal_d_deleteDraftOrder: typeof deleteDraftOrder;\n const ecomV1DraftOrder_universal_d_queryDraftOrders: typeof queryDraftOrders;\n type ecomV1DraftOrder_universal_d_DraftOrdersQueryResult = DraftOrdersQueryResult;\n type ecomV1DraftOrder_universal_d_DraftOrdersQueryBuilder = DraftOrdersQueryBuilder;\n const ecomV1DraftOrder_universal_d_setTaxExemption: typeof setTaxExemption;\n type ecomV1DraftOrder_universal_d_SetTaxExemptionOptions = SetTaxExemptionOptions;\n const ecomV1DraftOrder_universal_d_getDraftEditabilityStatus: typeof getDraftEditabilityStatus;\n const ecomV1DraftOrder_universal_d_setBusinessLocation: typeof setBusinessLocation;\n type ecomV1DraftOrder_universal_d_SetBusinessLocationOptions = SetBusinessLocationOptions;\n namespace ecomV1DraftOrder_universal_d {\n export {\n ecomV1DraftOrder_universal_d_DraftOrder as DraftOrder,\n ecomV1DraftOrder_universal_d_ItemDetails as ItemDetails,\n ecomV1DraftOrder_universal_d_ItemDetailsChangeTypeOneOf as ItemDetailsChangeTypeOneOf,\n Price$4 as Price,\n PriceDescription$1 as PriceDescription,\n OrderLineItem$1 as OrderLineItem,\n ProductName$1 as ProductName,\n CatalogReference$4 as CatalogReference,\n DescriptionLine$1 as DescriptionLine,\n DescriptionLineValueOneOf$1 as DescriptionLineValueOneOf,\n DescriptionLineDescriptionLineValueOneOf$1 as DescriptionLineDescriptionLineValueOneOf,\n DescriptionLineName$1 as DescriptionLineName,\n PlainTextValue$1 as PlainTextValue,\n Color$1 as Color,\n DescriptionLineType$1 as DescriptionLineType,\n FocalPoint$1 as FocalPoint,\n PhysicalProperties$3 as PhysicalProperties,\n ItemType$2 as ItemType,\n ItemTypeItemTypeDataOneOf$2 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$2 as ItemTypeItemType,\n PaymentOptionType$2 as PaymentOptionType,\n ItemTaxFullDetails$2 as ItemTaxFullDetails,\n LineItemTaxInfo$1 as LineItemTaxInfo,\n LineItemTaxBreakdown$1 as LineItemTaxBreakdown,\n JurisdictionType$2 as JurisdictionType,\n DigitalFile$2 as DigitalFile,\n SubscriptionInfo$2 as SubscriptionInfo,\n SubscriptionSettings$3 as SubscriptionSettings,\n SubscriptionFrequency$3 as SubscriptionFrequency,\n LocationAndQuantity$1 as LocationAndQuantity,\n TaxableAddress$2 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$2 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$2 as TaxableAddressType,\n ExtendedFields$5 as ExtendedFields,\n ItemChangedDetails$1 as ItemChangedDetails,\n ecomV1DraftOrder_universal_d_ShippingDetails as ShippingDetails,\n ecomV1DraftOrder_universal_d_ShippingDetailsChangeTypeOneOf as ShippingDetailsChangeTypeOneOf,\n ShippingInformation$2 as ShippingInformation,\n ecomV1DraftOrder_universal_d_V1DeliveryLogistics as V1DeliveryLogistics,\n ecomV1DraftOrder_universal_d_V1DeliveryLogisticsAddressOneOf as V1DeliveryLogisticsAddressOneOf,\n AddressWithContact$1 as AddressWithContact,\n Address$6 as Address,\n StreetAddress$5 as StreetAddress,\n AddressLocation$5 as AddressLocation,\n FullAddressContactDetails$2 as FullAddressContactDetails,\n VatId$3 as VatId,\n VatType$3 as VatType,\n ecomV1DraftOrder_universal_d_V1PickupDetails as V1PickupDetails,\n PickupAddress$2 as PickupAddress,\n ecomV1DraftOrder_universal_d_PickupDetailsPickupMethod as PickupDetailsPickupMethod,\n ecomV1DraftOrder_universal_d_V1DeliveryTimeSlot as V1DeliveryTimeSlot,\n ecomV1DraftOrder_universal_d_V1ShippingPrice as V1ShippingPrice,\n ShippingRegion$2 as ShippingRegion,\n ecomV1DraftOrder_universal_d_ShippingChangedDetails as ShippingChangedDetails,\n BuyerInfo$3 as BuyerInfo,\n BuyerInfoIdOneOf$1 as BuyerInfoIdOneOf,\n ecomV1DraftOrder_universal_d_AdditionalFeeDetails as AdditionalFeeDetails,\n AdditionalFee$2 as AdditionalFee,\n TaxDetails$1 as TaxDetails,\n SourceType$1 as SourceType,\n ecomV1DraftOrder_universal_d_DiscountDetails as DiscountDetails,\n AppliedDiscount$2 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$2 as AppliedDiscountDiscountSourceOneOf,\n ecomV1DraftOrder_universal_d_AppliedDiscountDiscountType as AppliedDiscountDiscountType,\n Coupon$2 as Coupon,\n MerchantDiscount$2 as MerchantDiscount,\n MerchantDiscountMerchantDiscountReasonOneOf$1 as MerchantDiscountMerchantDiscountReasonOneOf,\n DiscountReason$1 as DiscountReason,\n DiscountRule$2 as DiscountRule,\n DiscountRuleName$2 as DiscountRuleName,\n LineItemDiscount$2 as LineItemDiscount,\n CreatedBy$1 as CreatedBy,\n CreatedByStringOneOf$1 as CreatedByStringOneOf,\n ecomV1DraftOrder_universal_d_EditingStatus as EditingStatus,\n WeightUnit$4 as WeightUnit,\n PriceSummary$2 as PriceSummary,\n TaxSummary$2 as TaxSummary,\n BalanceSummary$1 as BalanceSummary,\n Balance$1 as Balance,\n DraftOrderCommitSettings$1 as DraftOrderCommitSettings,\n ecomV1DraftOrder_universal_d_InventoryUpdate as InventoryUpdate,\n ecomV1DraftOrder_universal_d_RecipientInfoDetails as RecipientInfoDetails,\n ecomV1DraftOrder_universal_d_RecipientInfoDetailsChangeTypeOneOf as RecipientInfoDetailsChangeTypeOneOf,\n ecomV1DraftOrder_universal_d_RecipientInfoChangedDetails as RecipientInfoChangedDetails,\n OrderTaxInfo$1 as OrderTaxInfo,\n OrderTaxBreakdown$1 as OrderTaxBreakdown,\n BuyerDetails$1 as BuyerDetails,\n ecomV1DraftOrder_universal_d_BuyerDetailsChangeTypeOneOf as BuyerDetailsChangeTypeOneOf,\n ecomV1DraftOrder_universal_d_BuyerChangedDetails as BuyerChangedDetails,\n ecomV1DraftOrder_universal_d_BillingDetails as BillingDetails,\n ecomV1DraftOrder_universal_d_BillingDetailsChangeTypeOneOf as BillingDetailsChangeTypeOneOf,\n ecomV1DraftOrder_universal_d_BillingChangedDetails as BillingChangedDetails,\n ecomV1DraftOrder_universal_d_BusinessLocationDetails as BusinessLocationDetails,\n ecomV1DraftOrder_universal_d_BusinessLocationDetailsChangeTypeOneOf as BusinessLocationDetailsChangeTypeOneOf,\n Location$1 as Location,\n ecomV1DraftOrder_universal_d_BusinessLocationChangedDetails as BusinessLocationChangedDetails,\n ecomV1DraftOrder_universal_d_CreateDraftOrderRequest as CreateDraftOrderRequest,\n ecomV1DraftOrder_universal_d_CreateDraftOrderResponse as CreateDraftOrderResponse,\n ecomV1DraftOrder_universal_d_CalculatedDraftOrder as CalculatedDraftOrder,\n ShippingOption$2 as ShippingOption,\n DeliveryLogistics$3 as DeliveryLogistics,\n PickupDetails$4 as PickupDetails,\n PickupMethod$3 as PickupMethod,\n DeliveryTimeSlot$3 as DeliveryTimeSlot,\n ShippingPrice$2 as ShippingPrice,\n CalculationErrors$1 as CalculationErrors,\n CalculationErrorsShippingCalculationErrorOneOf$1 as CalculationErrorsShippingCalculationErrorOneOf,\n Details$2 as Details,\n DetailsKindOneOf$2 as DetailsKindOneOf,\n ApplicationError$6 as ApplicationError,\n ValidationError$2 as ValidationError,\n RuleType$2 as RuleType,\n FieldViolation$2 as FieldViolation,\n SystemError$2 as SystemError,\n CarrierErrors$1 as CarrierErrors,\n CarrierError$2 as CarrierError,\n ecomV1DraftOrder_universal_d_CreateEmptyDraftOrderRequest as CreateEmptyDraftOrderRequest,\n ecomV1DraftOrder_universal_d_CreateEmptyDraftOrderResponse as CreateEmptyDraftOrderResponse,\n ecomV1DraftOrder_universal_d_AddLineItemsToDraftOrderRequest as AddLineItemsToDraftOrderRequest,\n ecomV1DraftOrder_universal_d_CatalogReferenceLineItem as CatalogReferenceLineItem,\n ecomV1DraftOrder_universal_d_CustomLineItem as CustomLineItem,\n ecomV1DraftOrder_universal_d_SecuredMedia as SecuredMedia,\n ecomV1DraftOrder_universal_d_FileType as FileType,\n ecomV1DraftOrder_universal_d_AddLineItemsToDraftOrderResponse as AddLineItemsToDraftOrderResponse,\n ecomV1DraftOrder_universal_d_UpdateLineItemsRequest as UpdateLineItemsRequest,\n ecomV1DraftOrder_universal_d_LineItemChangeDetails as LineItemChangeDetails,\n ecomV1DraftOrder_universal_d_UpdateLineItemsResponse as UpdateLineItemsResponse,\n ecomV1DraftOrder_universal_d_SetDiscountsRequest as SetDiscountsRequest,\n ecomV1DraftOrder_universal_d_IdAndApplied as IdAndApplied,\n ecomV1DraftOrder_universal_d_SetDiscountsResponse as SetDiscountsResponse,\n ecomV1DraftOrder_universal_d_CreateCustomDiscountsRequest as CreateCustomDiscountsRequest,\n ecomV1DraftOrder_universal_d_DiscountOption as DiscountOption,\n ecomV1DraftOrder_universal_d_DiscountOptionDiscountAmountOneOf as DiscountOptionDiscountAmountOneOf,\n DiscountType$2 as DiscountType,\n ecomV1DraftOrder_universal_d_CreateCustomDiscountsResponse as CreateCustomDiscountsResponse,\n ecomV1DraftOrder_universal_d_DeleteCustomDiscountsRequest as DeleteCustomDiscountsRequest,\n ecomV1DraftOrder_universal_d_DeleteCustomDiscountsResponse as DeleteCustomDiscountsResponse,\n ecomV1DraftOrder_universal_d_SetAdditionalFeesRequest as SetAdditionalFeesRequest,\n ecomV1DraftOrder_universal_d_SetAdditionalFeesResponse as SetAdditionalFeesResponse,\n ecomV1DraftOrder_universal_d_CreateCustomAdditionalFeesRequest as CreateCustomAdditionalFeesRequest,\n ecomV1DraftOrder_universal_d_AdditionalFeeOption as AdditionalFeeOption,\n ecomV1DraftOrder_universal_d_CreateCustomAdditionalFeesResponse as CreateCustomAdditionalFeesResponse,\n ecomV1DraftOrder_universal_d_DeleteCustomAdditionalFeesRequest as DeleteCustomAdditionalFeesRequest,\n ecomV1DraftOrder_universal_d_DeleteCustomAdditionalFeesResponse as DeleteCustomAdditionalFeesResponse,\n ecomV1DraftOrder_universal_d_SetShippingInfoRequest as SetShippingInfoRequest,\n ecomV1DraftOrder_universal_d_SetShippingInfoResponse as SetShippingInfoResponse,\n ecomV1DraftOrder_universal_d_SetBuyerInfoRequest as SetBuyerInfoRequest,\n ecomV1DraftOrder_universal_d_SetBuyerInfoResponse as SetBuyerInfoResponse,\n ecomV1DraftOrder_universal_d_SetRecipientInfoRequest as SetRecipientInfoRequest,\n ecomV1DraftOrder_universal_d_SetRecipientInfoResponse as SetRecipientInfoResponse,\n ecomV1DraftOrder_universal_d_SetBillingInfoRequest as SetBillingInfoRequest,\n ecomV1DraftOrder_universal_d_SetBillingInfoResponse as SetBillingInfoResponse,\n ecomV1DraftOrder_universal_d_UpdateShippingInfoRequest as UpdateShippingInfoRequest,\n ecomV1DraftOrder_universal_d_UpdateShippingInfoResponse as UpdateShippingInfoResponse,\n ecomV1DraftOrder_universal_d_GetDraftOrderRequest as GetDraftOrderRequest,\n ecomV1DraftOrder_universal_d_GetDraftOrderResponse as GetDraftOrderResponse,\n ecomV1DraftOrder_universal_d_GetOrderDraftabilityStatusRequest as GetOrderDraftabilityStatusRequest,\n ecomV1DraftOrder_universal_d_GetOrderDraftabilityStatusResponse as GetOrderDraftabilityStatusResponse,\n ecomV1DraftOrder_universal_d_NonDraftableReason as NonDraftableReason,\n ecomV1DraftOrder_universal_d_CommitDraftOrderRequest as CommitDraftOrderRequest,\n ecomV1DraftOrder_universal_d_CommitDraftOrderResponse as CommitDraftOrderResponse,\n Order$2 as Order,\n PaymentStatus$2 as PaymentStatus,\n FulfillmentStatus$3 as FulfillmentStatus,\n OrderStatus$1 as OrderStatus,\n Activity$2 as Activity,\n ActivityContentOneOf$1 as ActivityContentOneOf,\n CustomActivity$1 as CustomActivity,\n MerchantComment$1 as MerchantComment,\n OrderRefunded$2 as OrderRefunded,\n OrderCreatedFromExchange$1 as OrderCreatedFromExchange,\n NewExchangeOrderCreated$1 as NewExchangeOrderCreated,\n LineItemExchangeData$1 as LineItemExchangeData,\n DraftOrderChangesApplied$1 as DraftOrderChangesApplied,\n OrderChange$1 as OrderChange,\n OrderChangeValueOneOf$1 as OrderChangeValueOneOf,\n LineItemChanges$1 as LineItemChanges,\n LineItemQuantityChange$1 as LineItemQuantityChange,\n LineItemQuantityChangeType$1 as LineItemQuantityChangeType,\n LineItemPriceChange$1 as LineItemPriceChange,\n ManagedLineItem$1 as ManagedLineItem,\n ManagedDiscount$1 as ManagedDiscount,\n TranslatedValue$1 as TranslatedValue,\n LineItemAmount$1 as LineItemAmount,\n ManagedAdditionalFee$1 as ManagedAdditionalFee,\n TotalPriceChange$1 as TotalPriceChange,\n ShippingInformationChange$1 as ShippingInformationChange,\n ShippingInformationChangeShippingInformation$1 as ShippingInformationChangeShippingInformation,\n SavedPaymentMethod$1 as SavedPaymentMethod,\n AuthorizedPaymentCreated$1 as AuthorizedPaymentCreated,\n AuthorizedPaymentCaptured$1 as AuthorizedPaymentCaptured,\n AuthorizedPaymentVoided$1 as AuthorizedPaymentVoided,\n RefundInitiated$1 as RefundInitiated,\n RefundedPayment$1 as RefundedPayment,\n RefundedPaymentKindOneOf$1 as RefundedPaymentKindOneOf,\n RegularPaymentRefund$1 as RegularPaymentRefund,\n GiftCardPaymentRefund$1 as GiftCardPaymentRefund,\n MembershipPaymentRefund$1 as MembershipPaymentRefund,\n PaymentRefunded$1 as PaymentRefunded,\n PaymentRefundFailed$1 as PaymentRefundFailed,\n RefundedAsStoreCredit$1 as RefundedAsStoreCredit,\n PaymentPending$1 as PaymentPending,\n PaymentPendingPaymentDetailsOneOf$1 as PaymentPendingPaymentDetailsOneOf,\n RegularPayment$1 as RegularPayment,\n RegularPaymentPaymentMethodDetailsOneOf$1 as RegularPaymentPaymentMethodDetailsOneOf,\n CreditCardDetails$1 as CreditCardDetails,\n PaymentCanceled$1 as PaymentCanceled,\n PaymentCanceledPaymentDetailsOneOf$1 as PaymentCanceledPaymentDetailsOneOf,\n PaymentDeclined$1 as PaymentDeclined,\n PaymentDeclinedPaymentDetailsOneOf$1 as PaymentDeclinedPaymentDetailsOneOf,\n ActivityType$2 as ActivityType,\n AttributionSource$1 as AttributionSource,\n ecomV1DraftOrder_universal_d_V1CreatedBy as V1CreatedBy,\n ecomV1DraftOrder_universal_d_V1CreatedByStringOneOf as V1CreatedByStringOneOf,\n ChannelInfo$2 as ChannelInfo,\n ChannelType$2 as ChannelType,\n CustomField$2 as CustomField,\n ecomV1DraftOrder_universal_d_V1BalanceSummary as V1BalanceSummary,\n FulfillmentStatusesAggregate$1 as FulfillmentStatusesAggregate,\n Tags$1 as Tags,\n TagList$1 as TagList,\n ecomV1DraftOrder_universal_d_CreateOrderFromDraftRequest as CreateOrderFromDraftRequest,\n ecomV1DraftOrder_universal_d_OrderCreateSettings as OrderCreateSettings,\n OrderCreateNotifications$1 as OrderCreateNotifications,\n ecomV1DraftOrder_universal_d_CreateOrderFromDraftResponse as CreateOrderFromDraftResponse,\n ecomV1DraftOrder_universal_d_DeleteDraftOrderRequest as DeleteDraftOrderRequest,\n ecomV1DraftOrder_universal_d_DeleteDraftOrderResponse as DeleteDraftOrderResponse,\n ecomV1DraftOrder_universal_d_QueryDraftOrdersRequest as QueryDraftOrdersRequest,\n CursorQuery$5 as CursorQuery,\n CursorQueryPagingMethodOneOf$5 as CursorQueryPagingMethodOneOf,\n Sorting$9 as Sorting,\n SortOrder$9 as SortOrder,\n CursorPaging$9 as CursorPaging,\n ecomV1DraftOrder_universal_d_QueryDraftOrdersResponse as QueryDraftOrdersResponse,\n CursorPagingMetadata$8 as CursorPagingMetadata,\n Cursors$9 as Cursors,\n UpdateExtendedFieldsRequest$3 as UpdateExtendedFieldsRequest,\n UpdateExtendedFieldsResponse$3 as UpdateExtendedFieldsResponse,\n ecomV1DraftOrder_universal_d_SetTaxExemptionRequest as SetTaxExemptionRequest,\n ecomV1DraftOrder_universal_d_SetTaxExemptionResponse as SetTaxExemptionResponse,\n ecomV1DraftOrder_universal_d_GetDraftEditabilityStatusRequest as GetDraftEditabilityStatusRequest,\n ecomV1DraftOrder_universal_d_GetDraftEditabilityStatusResponse as GetDraftEditabilityStatusResponse,\n ecomV1DraftOrder_universal_d_SetBusinessLocationRequest as SetBusinessLocationRequest,\n ecomV1DraftOrder_universal_d_SetBusinessLocationResponse as SetBusinessLocationResponse,\n DomainEvent$c as DomainEvent,\n DomainEventBodyOneOf$c as DomainEventBodyOneOf,\n EntityCreatedEvent$c as EntityCreatedEvent,\n RestoreInfo$c as RestoreInfo,\n EntityUpdatedEvent$c as EntityUpdatedEvent,\n EntityDeletedEvent$c as EntityDeletedEvent,\n ActionEvent$c as ActionEvent,\n MessageEnvelope$b as MessageEnvelope,\n IdentificationData$c as IdentificationData,\n IdentificationDataIdOneOf$c as IdentificationDataIdOneOf,\n WebhookIdentityType$b as WebhookIdentityType,\n ecomV1DraftOrder_universal_d_createDraftOrder as createDraftOrder,\n ecomV1DraftOrder_universal_d_CreateDraftOrderOptions as CreateDraftOrderOptions,\n ecomV1DraftOrder_universal_d_createEmptyDraftOrder as createEmptyDraftOrder,\n ecomV1DraftOrder_universal_d_addLineItemsToDraftOrder as addLineItemsToDraftOrder,\n ecomV1DraftOrder_universal_d_AddLineItemsToDraftOrderOptions as AddLineItemsToDraftOrderOptions,\n ecomV1DraftOrder_universal_d_updateLineItems as updateLineItems,\n ecomV1DraftOrder_universal_d_UpdateLineItemsOptions as UpdateLineItemsOptions,\n ecomV1DraftOrder_universal_d_setDiscounts as setDiscounts,\n ecomV1DraftOrder_universal_d_createCustomDiscounts as createCustomDiscounts,\n ecomV1DraftOrder_universal_d_CreateCustomDiscountsOptions as CreateCustomDiscountsOptions,\n ecomV1DraftOrder_universal_d_deleteCustomDiscounts as deleteCustomDiscounts,\n ecomV1DraftOrder_universal_d_setAdditionalFees as setAdditionalFees,\n ecomV1DraftOrder_universal_d_createCustomAdditionalFees as createCustomAdditionalFees,\n ecomV1DraftOrder_universal_d_CreateCustomAdditionalFeesOptions as CreateCustomAdditionalFeesOptions,\n ecomV1DraftOrder_universal_d_deleteCustomAdditionalFees as deleteCustomAdditionalFees,\n ecomV1DraftOrder_universal_d_setShippingInfo as setShippingInfo,\n ecomV1DraftOrder_universal_d_SetShippingInfoOptions as SetShippingInfoOptions,\n ecomV1DraftOrder_universal_d_setBuyerInfo as setBuyerInfo,\n ecomV1DraftOrder_universal_d_SetBuyerInfoOptions as SetBuyerInfoOptions,\n ecomV1DraftOrder_universal_d_setRecipientInfo as setRecipientInfo,\n ecomV1DraftOrder_universal_d_SetRecipientInfoOptions as SetRecipientInfoOptions,\n ecomV1DraftOrder_universal_d_setBillingInfo as setBillingInfo,\n ecomV1DraftOrder_universal_d_SetBillingInfoOptions as SetBillingInfoOptions,\n ecomV1DraftOrder_universal_d_updateShippingInfo as updateShippingInfo,\n ecomV1DraftOrder_universal_d_UpdateShippingInfoOptions as UpdateShippingInfoOptions,\n ecomV1DraftOrder_universal_d_getDraftOrder as getDraftOrder,\n ecomV1DraftOrder_universal_d_getOrderDraftabilityStatus as getOrderDraftabilityStatus,\n ecomV1DraftOrder_universal_d_commitDraftOrder as commitDraftOrder,\n ecomV1DraftOrder_universal_d_CommitDraftOrderOptions as CommitDraftOrderOptions,\n ecomV1DraftOrder_universal_d_createOrderFromDraft as createOrderFromDraft,\n ecomV1DraftOrder_universal_d_CreateOrderFromDraftOptions as CreateOrderFromDraftOptions,\n ecomV1DraftOrder_universal_d_deleteDraftOrder as deleteDraftOrder,\n ecomV1DraftOrder_universal_d_queryDraftOrders as queryDraftOrders,\n ecomV1DraftOrder_universal_d_DraftOrdersQueryResult as DraftOrdersQueryResult,\n ecomV1DraftOrder_universal_d_DraftOrdersQueryBuilder as DraftOrdersQueryBuilder,\n updateExtendedFields$3 as updateExtendedFields,\n UpdateExtendedFieldsOptions$3 as UpdateExtendedFieldsOptions,\n ecomV1DraftOrder_universal_d_setTaxExemption as setTaxExemption,\n ecomV1DraftOrder_universal_d_SetTaxExemptionOptions as SetTaxExemptionOptions,\n ecomV1DraftOrder_universal_d_getDraftEditabilityStatus as getDraftEditabilityStatus,\n ecomV1DraftOrder_universal_d_setBusinessLocation as setBusinessLocation,\n ecomV1DraftOrder_universal_d_SetBusinessLocationOptions as SetBusinessLocationOptions,\n };\n }\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 | null;\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 | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$2;\n /** Order fulfillment status. */\n fulfillmentStatus?: FulfillmentStatus$2;\n /** Fulfillment tracking information. */\n trackingInfo?: V2FulfillmentTrackingInfo;\n }\n /** Buyer Info */\n interface BuyerInfo$2 {\n /** Wix customer ID */\n _id?: string | null;\n /**\n * Deprecated (use identityType instead)\n * @readonly\n * @deprecated\n */\n type?: IdentityType$3;\n /** Customer type */\n identityType?: IdentityType$3;\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 * Contact Id. needed for cases where the user is the buyer and so it doesn't exist on the buyer info\n * @internal\n * @readonly\n */\n contactId?: string | null;\n }\n enum IdentityType$3 {\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 * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\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$2;\n }\n interface BulkOrderFulfillmentsResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata$2;\n /** List of order IDs and their associated fulfillments. */\n ordersWithFulfillments?: OrderWithFulfillments;\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$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$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 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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$b;\n }\n interface RestoreInfo$b {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$b {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$b {\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$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$a;\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$a {\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 * @permissionId ECOM.READ_FULFILLMENTS\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 * @permissionId ECOM.READ_FULFILLMENTS\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 * @permissionId ECOM.MODIFY_FULFILLMENTS\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 * @permissionId ECOM.MODIFY_FULFILLMENTS\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 | null;\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 * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\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 * @permissionId ECOM.MODIFY_FULFILLMENTS\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 * @permissionId ECOM.MODIFY_FULFILLMENTS\n * @adminMethod\n */\n function bulkCreateFulfillments(ordersWithFulfillments: BulkCreateOrderWithFulfillments[]): Promise;\n \n type ecomV1Fulfillments_universal_d_OrderWithFulfillments = OrderWithFulfillments;\n type ecomV1Fulfillments_universal_d_FulfillmentFulfillmentInfoOneOf = FulfillmentFulfillmentInfoOneOf;\n type ecomV1Fulfillments_universal_d_CustomFulfillmentInfo = CustomFulfillmentInfo;\n type ecomV1Fulfillments_universal_d_FulfillmentCreated = FulfillmentCreated;\n type ecomV1Fulfillments_universal_d_V2FulfillmentTrackingInfo = V2FulfillmentTrackingInfo;\n type ecomV1Fulfillments_universal_d_FulfillmentUpdated = FulfillmentUpdated;\n type ecomV1Fulfillments_universal_d_FulfillmentDeleted = FulfillmentDeleted;\n type ecomV1Fulfillments_universal_d_ListFulfillmentsForSingleOrderRequest = ListFulfillmentsForSingleOrderRequest;\n type ecomV1Fulfillments_universal_d_ListFulfillmentsForSingleOrderResponse = ListFulfillmentsForSingleOrderResponse;\n type ecomV1Fulfillments_universal_d_ListFulfillmentsForMultipleOrdersRequest = ListFulfillmentsForMultipleOrdersRequest;\n type ecomV1Fulfillments_universal_d_ListFulfillmentsForMultipleOrdersResponse = ListFulfillmentsForMultipleOrdersResponse;\n type ecomV1Fulfillments_universal_d_CreateFulfillmentRequest = CreateFulfillmentRequest;\n type ecomV1Fulfillments_universal_d_CreateFulfillmentResponse = CreateFulfillmentResponse;\n type ecomV1Fulfillments_universal_d_UpdateFulfillmentRequest = UpdateFulfillmentRequest;\n type ecomV1Fulfillments_universal_d_UpdateFulfillmentResponse = UpdateFulfillmentResponse;\n type ecomV1Fulfillments_universal_d_DeleteFulfillmentRequest = DeleteFulfillmentRequest;\n type ecomV1Fulfillments_universal_d_DeleteFulfillmentResponse = DeleteFulfillmentResponse;\n type ecomV1Fulfillments_universal_d_BulkCreateFulfillmentRequest = BulkCreateFulfillmentRequest;\n type ecomV1Fulfillments_universal_d_BulkCreateOrderWithFulfillments = BulkCreateOrderWithFulfillments;\n type ecomV1Fulfillments_universal_d_BulkCreateFulfillmentResponse = BulkCreateFulfillmentResponse;\n type ecomV1Fulfillments_universal_d_BulkOrderFulfillmentsResult = BulkOrderFulfillmentsResult;\n const ecomV1Fulfillments_universal_d_listFulfillmentsForSingleOrder: typeof listFulfillmentsForSingleOrder;\n const ecomV1Fulfillments_universal_d_listFulfillmentsForMultipleOrders: typeof listFulfillmentsForMultipleOrders;\n const ecomV1Fulfillments_universal_d_createFulfillment: typeof createFulfillment;\n const ecomV1Fulfillments_universal_d_updateFulfillment: typeof updateFulfillment;\n type ecomV1Fulfillments_universal_d_UpdateFulfillmentOptions = UpdateFulfillmentOptions;\n type ecomV1Fulfillments_universal_d_UpdateFulfillmentIdentifiers = UpdateFulfillmentIdentifiers;\n const ecomV1Fulfillments_universal_d_deleteFulfillment: typeof deleteFulfillment;\n type ecomV1Fulfillments_universal_d_DeleteFulfillmentIdentifiers = DeleteFulfillmentIdentifiers;\n const ecomV1Fulfillments_universal_d_bulkCreateFulfillments: typeof bulkCreateFulfillments;\n namespace ecomV1Fulfillments_universal_d {\n export {\n ecomV1Fulfillments_universal_d_OrderWithFulfillments as OrderWithFulfillments,\n Fulfillment$1 as Fulfillment,\n ecomV1Fulfillments_universal_d_FulfillmentFulfillmentInfoOneOf as FulfillmentFulfillmentInfoOneOf,\n FulfillmentLineItem$1 as FulfillmentLineItem,\n FulfillmentTrackingInfo$1 as FulfillmentTrackingInfo,\n ecomV1Fulfillments_universal_d_CustomFulfillmentInfo as CustomFulfillmentInfo,\n ecomV1Fulfillments_universal_d_FulfillmentCreated as FulfillmentCreated,\n BuyerInfo$2 as BuyerInfo,\n IdentityType$3 as IdentityType,\n FulfillmentStatus$2 as FulfillmentStatus,\n ecomV1Fulfillments_universal_d_V2FulfillmentTrackingInfo as V2FulfillmentTrackingInfo,\n ecomV1Fulfillments_universal_d_FulfillmentUpdated as FulfillmentUpdated,\n ecomV1Fulfillments_universal_d_FulfillmentDeleted as FulfillmentDeleted,\n ecomV1Fulfillments_universal_d_ListFulfillmentsForSingleOrderRequest as ListFulfillmentsForSingleOrderRequest,\n ecomV1Fulfillments_universal_d_ListFulfillmentsForSingleOrderResponse as ListFulfillmentsForSingleOrderResponse,\n ecomV1Fulfillments_universal_d_ListFulfillmentsForMultipleOrdersRequest as ListFulfillmentsForMultipleOrdersRequest,\n ecomV1Fulfillments_universal_d_ListFulfillmentsForMultipleOrdersResponse as ListFulfillmentsForMultipleOrdersResponse,\n ecomV1Fulfillments_universal_d_CreateFulfillmentRequest as CreateFulfillmentRequest,\n ecomV1Fulfillments_universal_d_CreateFulfillmentResponse as CreateFulfillmentResponse,\n ecomV1Fulfillments_universal_d_UpdateFulfillmentRequest as UpdateFulfillmentRequest,\n ecomV1Fulfillments_universal_d_UpdateFulfillmentResponse as UpdateFulfillmentResponse,\n ecomV1Fulfillments_universal_d_DeleteFulfillmentRequest as DeleteFulfillmentRequest,\n ecomV1Fulfillments_universal_d_DeleteFulfillmentResponse as DeleteFulfillmentResponse,\n ecomV1Fulfillments_universal_d_BulkCreateFulfillmentRequest as BulkCreateFulfillmentRequest,\n ecomV1Fulfillments_universal_d_BulkCreateOrderWithFulfillments as BulkCreateOrderWithFulfillments,\n ecomV1Fulfillments_universal_d_BulkCreateFulfillmentResponse as BulkCreateFulfillmentResponse,\n ecomV1Fulfillments_universal_d_BulkOrderFulfillmentsResult as BulkOrderFulfillmentsResult,\n ItemMetadata$2 as ItemMetadata,\n ApplicationError$5 as ApplicationError,\n BulkActionMetadata$2 as BulkActionMetadata,\n DomainEvent$b as DomainEvent,\n DomainEventBodyOneOf$b as DomainEventBodyOneOf,\n EntityCreatedEvent$b as EntityCreatedEvent,\n RestoreInfo$b as RestoreInfo,\n EntityUpdatedEvent$b as EntityUpdatedEvent,\n EntityDeletedEvent$b as EntityDeletedEvent,\n ActionEvent$b as ActionEvent,\n MessageEnvelope$a as MessageEnvelope,\n IdentificationData$b as IdentificationData,\n IdentificationDataIdOneOf$b as IdentificationDataIdOneOf,\n WebhookIdentityType$a as WebhookIdentityType,\n ecomV1Fulfillments_universal_d_listFulfillmentsForSingleOrder as listFulfillmentsForSingleOrder,\n ecomV1Fulfillments_universal_d_listFulfillmentsForMultipleOrders as listFulfillmentsForMultipleOrders,\n ecomV1Fulfillments_universal_d_createFulfillment as createFulfillment,\n ecomV1Fulfillments_universal_d_updateFulfillment as updateFulfillment,\n ecomV1Fulfillments_universal_d_UpdateFulfillmentOptions as UpdateFulfillmentOptions,\n ecomV1Fulfillments_universal_d_UpdateFulfillmentIdentifiers as UpdateFulfillmentIdentifiers,\n ecomV1Fulfillments_universal_d_deleteFulfillment as deleteFulfillment,\n ecomV1Fulfillments_universal_d_DeleteFulfillmentIdentifiers as DeleteFulfillmentIdentifiers,\n ecomV1Fulfillments_universal_d_bulkCreateFulfillments as bulkCreateFulfillments,\n };\n }\n \n interface GiftCard$2 {\n /**\n * Gift card obfuscated code.\n *\n * For example: \"****-****-****-1234\".\n */\n obfuscatedCode?: string;\n /** Gift card balance. */\n balance?: Money;\n /** Current gift card status. */\n status?: Status$1;\n /** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */\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 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 }\n enum Status$1 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Gift card is active and can be used for purchases. */\n VALID = \"VALID\",\n /** Gift card expiration date has passed and can no longer be used. */\n EXPIRED = \"EXPIRED\",\n /** Gift card has been disabled by the merchant and can no longer be used. */\n DISABLED = \"DISABLED\"\n }\n interface GetGiftCardRequest {\n /** Gift card code. */\n code: string;\n /** Contextual information for the request, including the physical location ID if applicable. */\n context?: Context;\n }\n interface Context {\n /** Physical location ID. Can be based on the Locations API or an external provider. */\n locationId?: string | null;\n }\n interface GetGiftCardResponse {\n /** Retrieved gift card. */\n giftCard?: GiftCard$2;\n }\n interface RedeemGiftCardRequest {\n /** Gift card code. */\n code: string;\n /** Amount to redeem from the gift card. */\n amount: Money;\n /** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */\n orderId?: string;\n /** App ID of the gift card provider. */\n appId: string;\n /** Contextual information for the request, including the physical location ID if applicable. */\n context?: Context;\n }\n interface RedeemGiftCardResponse {\n /** Gift card transaction ID. */\n transactionId?: string;\n }\n interface VoidTransactionRequest {\n /** Gift card transaction ID, as returned from Redeem Gift Card. */\n transactionId: string;\n /** App ID of the gift card provider. */\n appId: string;\n /** Contextual information for the request, including the physical location ID if applicable. */\n context?: Context;\n }\n interface VoidTransactionResponse {\n }\n /**\n * Retrieves a gift card.\n * @param code - Gift card code.\n * @public\n * @documentationMaturity preview\n * @requiredField code\n * @param options - Field options.\n * @permissionId ECOM.GIFT_CARD_READ\n * @adminMethod\n */\n function getGiftCard(code: string, options?: GetGiftCardOptions): Promise;\n interface GetGiftCardOptions {\n /** Contextual information for the request, including the physical location ID if applicable. */\n context?: Context;\n }\n /**\n * Redeems a gift card.\n * Creates a transaction and lowers the card balance by the transaction amount.\n * @param code - Gift card code.\n * @public\n * @documentationMaturity preview\n * @requiredField code\n * @requiredField options.amount\n * @requiredField options.amount.value\n * @requiredField options.appId\n * @param options - Field options. `amount` and `appId` **must** be passed.\n * @permissionId ECOM.GIFT_CARD_REDEEM\n * @adminMethod\n */\n function redeemGiftCard(code: string, options?: RedeemGiftCardOptions): Promise;\n interface RedeemGiftCardOptions {\n /** Amount to redeem from the gift card. */\n amount: Money;\n /** Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the eCommerce Order Created webhook or by calling eCommerce Search Orders. */\n orderId?: string;\n /** App ID of the gift card provider. */\n appId: string;\n /** Contextual information for the request, including the physical location ID if applicable. */\n context?: Context;\n }\n /**\n * Voids a gift card transaction.\n * Transaction IDs are returned in Redeem Gift Card.\n * @param transactionId - Gift card transaction ID, as returned from Redeem Gift Card.\n * @public\n * @documentationMaturity preview\n * @requiredField options.appId\n * @requiredField transactionId\n * @param options - Field options. `appId` **must** be passed.\n * @permissionId ECOM.GIFT_CARD_TRANSACTION_VOID\n * @adminMethod\n */\n function voidTransaction(transactionId: string, options?: VoidTransactionOptions): Promise;\n interface VoidTransactionOptions {\n /** App ID of the gift card provider. */\n appId: string;\n /** Contextual information for the request, including the physical location ID if applicable. */\n context?: Context;\n }\n \n type ecomV1GiftCard_universal_d_Money = Money;\n type ecomV1GiftCard_universal_d_GetGiftCardRequest = GetGiftCardRequest;\n type ecomV1GiftCard_universal_d_Context = Context;\n type ecomV1GiftCard_universal_d_GetGiftCardResponse = GetGiftCardResponse;\n type ecomV1GiftCard_universal_d_RedeemGiftCardRequest = RedeemGiftCardRequest;\n type ecomV1GiftCard_universal_d_RedeemGiftCardResponse = RedeemGiftCardResponse;\n type ecomV1GiftCard_universal_d_VoidTransactionRequest = VoidTransactionRequest;\n type ecomV1GiftCard_universal_d_VoidTransactionResponse = VoidTransactionResponse;\n const ecomV1GiftCard_universal_d_getGiftCard: typeof getGiftCard;\n type ecomV1GiftCard_universal_d_GetGiftCardOptions = GetGiftCardOptions;\n const ecomV1GiftCard_universal_d_redeemGiftCard: typeof redeemGiftCard;\n type ecomV1GiftCard_universal_d_RedeemGiftCardOptions = RedeemGiftCardOptions;\n const ecomV1GiftCard_universal_d_voidTransaction: typeof voidTransaction;\n type ecomV1GiftCard_universal_d_VoidTransactionOptions = VoidTransactionOptions;\n namespace ecomV1GiftCard_universal_d {\n export {\n GiftCard$2 as GiftCard,\n ecomV1GiftCard_universal_d_Money as Money,\n Status$1 as Status,\n ecomV1GiftCard_universal_d_GetGiftCardRequest as GetGiftCardRequest,\n ecomV1GiftCard_universal_d_Context as Context,\n ecomV1GiftCard_universal_d_GetGiftCardResponse as GetGiftCardResponse,\n ecomV1GiftCard_universal_d_RedeemGiftCardRequest as RedeemGiftCardRequest,\n ecomV1GiftCard_universal_d_RedeemGiftCardResponse as RedeemGiftCardResponse,\n ecomV1GiftCard_universal_d_VoidTransactionRequest as VoidTransactionRequest,\n ecomV1GiftCard_universal_d_VoidTransactionResponse as VoidTransactionResponse,\n ecomV1GiftCard_universal_d_getGiftCard as getGiftCard,\n ecomV1GiftCard_universal_d_GetGiftCardOptions as GetGiftCardOptions,\n ecomV1GiftCard_universal_d_redeemGiftCard as redeemGiftCard,\n ecomV1GiftCard_universal_d_RedeemGiftCardOptions as RedeemGiftCardOptions,\n ecomV1GiftCard_universal_d_voidTransaction as voidTransaction,\n ecomV1GiftCard_universal_d_VoidTransactionOptions as VoidTransactionOptions,\n };\n }\n \n interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {\n zipConfig?: ZipCodeConfig;\n radiusConfig?: RadiusConfig;\n customAreaConfig?: CustomAreaConfig;\n /**\n * LocalDeliveryOptionId - unique identifier of local delivery option\n * @readonly\n */\n _id?: string | null;\n /**\n * External id of shipping rule which LocalDeliveryOption is linked to. Most commonly it would be shippingRuleId from WixStores\n * @internal\n * @deprecated External id of shipping rule which LocalDeliveryOption is linked to. Most commonly it would be shippingRuleId from WixStores\n * @targetRemovalDate 2025-01-12\n */\n externalId?: string | null;\n /** Area name of Local Delivery Option */\n areaName?: string | null;\n /**\n * Flat price of local delivery\n * @deprecated Flat price of local delivery\n * @targetRemovalDate 2025-01-12\n */\n rate?: string | null;\n /** Estimated delivery time description text */\n estimatedDeliveryTime?: string | null;\n /**\n * Minimum order total to be eligible for free delivery\n * @deprecated Minimum order total to be eligible for free delivery\n * @targetRemovalDate 2025-01-12\n */\n minimumFreeDeliveryOrderAmount?: number | null;\n /** List of countries with subdivisions */\n destinations?: Destination[];\n /**\n * Database revision of LocalDeliveryOption entity. Incremented on each modification\n * @readonly\n */\n revision?: string | null;\n scheduledDeliveryConfig?: ScheduledDelivery;\n /** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */\n rates?: ConditionalRates$2[];\n /**\n * Date and time the LocalDeliveryOption was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the LocalDeliveryOption was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** This local delivery is active for the following delivery regions. */\n deliveryRegionIds?: string[];\n }\n /** @oneof */\n interface LocalDeliveryOptionConfigOneOf {\n zipConfig?: ZipCodeConfig;\n radiusConfig?: RadiusConfig;\n customAreaConfig?: CustomAreaConfig;\n }\n interface Destination {\n /** Country ISO code */\n code?: string;\n /** List of subdivisions, empty means all */\n subdivisions?: string[];\n }\n interface ZipCodeConfig {\n /** List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000* */\n zipCodes?: string[];\n }\n interface RadiusConfig {\n /** Delivery-from address */\n address?: LocalDeliveryAddress;\n /** Delivery circle's radius */\n radius?: number;\n /**\n * Radius' unit, taken from site properties\n * @readonly\n */\n lengthUnit?: LengthUnit;\n }\n interface LocalDeliveryAddress {\n /** A string containing the human-readable address of this location */\n formatted?: string | null;\n /** coordinates of the physical address */\n location?: AddressLocation$4;\n }\n interface AddressLocation$4 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n enum LengthUnit {\n /** Length unit can't be classified, due to an error */\n UNSPECIFIED_LENGTH_UNIT = \"UNSPECIFIED_LENGTH_UNIT\",\n /** Kilometers */\n KM = \"KM\",\n /** Miles */\n MI = \"MI\"\n }\n interface CustomAreaConfig {\n /** Geocodes of the polygon defining the delivery area. */\n geocodes?: AddressLocation$4[];\n }\n interface ScheduledDelivery {\n /**\n * Days config which contain days when delivery is enabled with it's time slots\n * @deprecated Days config which contain days when delivery is enabled with it's time slots\n * @replacedBy time_windows\n * @targetRemovalDate 2025-01-01\n */\n days?: Days;\n /** Amount of days before first delivery option date */\n handlingDays?: number | null;\n /** Cut off time after which first delivery option would be for next day */\n cutOffTime?: TimePoint;\n /** availability times configuration. */\n timeWindows?: TimeWindow[];\n }\n interface Days {\n monday?: DaySlot;\n tuesday?: DaySlot;\n wednesday?: DaySlot;\n thursday?: DaySlot;\n friday?: DaySlot;\n saturday?: DaySlot;\n sunday?: DaySlot;\n }\n interface DaySlot {\n /** Shows whether this day slot is enabled for delivery */\n enabledForDelivery?: boolean | null;\n /** Time slots for scheduled delivery during day */\n timeSlots?: TimeSlot[];\n }\n interface TimeSlot {\n /** Starting time point of time slot */\n from?: TimePoint;\n /** End time point of time slot */\n to?: TimePoint;\n }\n interface TimePoint {\n /** Hours in format 0-23 */\n hours?: number | null;\n /** Minutes 0-59 */\n minutes?: number | null;\n }\n interface TimeWindow {\n /** The day of week this availability relates to. */\n day?: DayOfWeek;\n /** The start time in time of day representation. */\n start?: TimeOfDay;\n /** The end time in time of day representation. */\n end?: TimeOfDay;\n /** Whether this timeWindow availability is enabled. */\n enabled?: boolean | null;\n }\n enum DayOfWeek {\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 {\n /** Hours */\n hours?: number;\n /** Minutes */\n minutes?: number;\n }\n interface ConditionalRates$2 {\n /**\n * there is an AND logic between all the conditions. Empty conditions means true.\n * For example: weight > 0 and weight <= 10\n */\n conditions?: Condition$2[];\n amount?: string;\n }\n interface Condition$2 {\n type?: ConditionType$2;\n /**\n * The value in respective to the condition type\n * Weight values should be in the same weight units of the store: KG / LB\n * Total price is according to the store currency\n * Quantity of items should be integers\n */\n value?: string;\n operator?: LogicalOperator$2;\n }\n enum ConditionType$2 {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n BY_TOTAL_WEIGHT = \"BY_TOTAL_WEIGHT\",\n BY_TOTAL_PRICE = \"BY_TOTAL_PRICE\",\n BY_TOTAL_QUANTITY = \"BY_TOTAL_QUANTITY\"\n }\n enum LogicalOperator$2 {\n UNKNOWN_LOGICAL_OPERATOR_TYPE = \"UNKNOWN_LOGICAL_OPERATOR_TYPE\",\n EQ = \"EQ\",\n GT = \"GT\",\n GTE = \"GTE\",\n LT = \"LT\",\n LTE = \"LTE\"\n }\n interface CreateLocalDeliveryOptionRequest {\n localDeliveryOption: LocalDeliveryOption;\n }\n interface CreateLocalDeliveryOptionResponse {\n localDeliveryOption?: LocalDeliveryOption;\n }\n interface GetLocalDeliveryOptionRequest {\n /**\n * @deprecated\n * @targetRemovalDate 2025-01-12\n */\n _id?: string;\n localDeliveryOptionId: string;\n }\n interface GetLocalDeliveryOptionResponse {\n localDeliveryOption?: LocalDeliveryOption;\n }\n interface ListLocalDeliveryOptionsRequest {\n externalId: string;\n }\n interface ListLocalDeliveryOptionsResponse {\n localDeliveryOptions?: LocalDeliveryOption[];\n }\n interface QueryLocalDeliveryOptionsRequest {\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$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$8;\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$8[];\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$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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$8 {\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$8 {\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 QueryLocalDeliveryOptionsResponse {\n /** Retrieved local delivery options. */\n localDeliveryOptions?: LocalDeliveryOption[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$7;\n }\n interface CursorPagingMetadata$7 {\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$8;\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | null;\n }\n interface Cursors$8 {\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 UpdateLocalDeliveryOptionRequest {\n /** LocalDeliveryOption to be updated, may be partial. */\n localDeliveryOption: LocalDeliveryOption;\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateLocalDeliveryOptionResponse {\n localDeliveryOption?: LocalDeliveryOption;\n }\n interface DeleteLocalDeliveryOptionRequest {\n /**\n * @deprecated\n * @targetRemovalDate 2025-01-12\n */\n _id?: string;\n localDeliveryOptionId: string;\n }\n interface DeleteLocalDeliveryOptionResponse {\n }\n interface BulkCreateLocalDeliveryOptionRequest {\n localDeliveryOptions: LocalDeliveryOption[];\n }\n interface BulkCreateLocalDeliveryOptionResponse {\n localDeliveryOptions?: LocalDeliveryOption[];\n errors?: LocalDeliveryOptionError[];\n }\n interface LocalDeliveryOptionError {\n _id?: string;\n error?: string;\n }\n interface BulkUpdateLocalDeliveryOptionRequest {\n localDeliveryOptions: LocalDeliveryOption[];\n }\n interface BulkUpdateLocalDeliveryOptionResponse {\n localDeliveryOptions?: LocalDeliveryOption[];\n errors?: LocalDeliveryOptionError[];\n }\n interface BulkDeleteLocalDeliveryOptionRequest {\n ids: string[];\n }\n interface BulkDeleteLocalDeliveryOptionResponse {\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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$a;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$a {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$a {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$a {\n bodyAsJson?: string;\n }\n interface AddDeliveryRegionRequest$1 {\n deliveryRegionId: string;\n localDeliveryOptionId: string;\n /** Revision of the PickupLocation */\n revision?: string | null;\n }\n interface AddDeliveryRegionResponse$1 {\n localDeliveryOption?: LocalDeliveryOption;\n }\n interface RemoveDeliveryRegionRequest$1 {\n deliveryRegionId: string;\n localDeliveryOptionId: string;\n /** Revision of the PickupLocation */\n revision?: string | null;\n }\n interface RemoveDeliveryRegionResponse$1 {\n localDeliveryOption?: LocalDeliveryOption;\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$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$9;\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$9 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField localDeliveryOption\n * @requiredField localDeliveryOption.areaName\n * @requiredField localDeliveryOption.radiusConfig.address\n * @requiredField localDeliveryOption.radiusConfig.address.formatted\n * @requiredField localDeliveryOption.radiusConfig.address.location\n * @requiredField localDeliveryOption.rate\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.handlingDays\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_CREATE\n * @adminMethod\n */\n function createLocalDeliveryOption(localDeliveryOption: LocalDeliveryOption): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField localDeliveryOptionId\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ\n * @adminMethod\n */\n function getLocalDeliveryOption(localDeliveryOptionId: string, options?: GetLocalDeliveryOptionOptions): Promise;\n interface GetLocalDeliveryOptionOptions {\n /**\n * @deprecated\n * @targetRemovalDate 2025-01-12\n */\n _id?: string;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField externalId\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ\n * @adminMethod\n * @deprecated method is deprecated due to the fact that external_id is deprecated\n * @replacedBy ListLocalDeliveryOptionsByDeliveryRegion\n * @targetRemovalDate 2024-11-01\n */\n function listLocalDeliveryOptions(externalId: string): Promise;\n /**\n * Retrieves a list of local delivery options, given the provided paging, filtering, and sorting.\n *\n * For field support for filters and sorting, see [Local Delivery: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-regions/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/api/rest/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 * @permissionId ECOM.LOCAL_DELIVERY_OPTION_READ\n * @adminMethod\n */\n function queryLocalDeliveryOptions(): LocalDeliveryOptionsQueryBuilder;\n interface QueryCursorResult$8 {\n cursors: Cursors$8;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LocalDeliveryOptionsQueryResult extends QueryCursorResult$8 {\n items: LocalDeliveryOption[];\n query: LocalDeliveryOptionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LocalDeliveryOptionsQueryBuilder {\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' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;\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' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;\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' | 'areaName' | 'estimatedDeliveryTime', value: string) => LocalDeliveryOptionsQueryBuilder;\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' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;\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: 'deliveryRegionIds', value: any[]) => LocalDeliveryOptionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: any) => LocalDeliveryOptionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'areaName' | 'estimatedDeliveryTime' | 'deliveryRegionIds', value: boolean) => LocalDeliveryOptionsQueryBuilder;\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) => LocalDeliveryOptionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => LocalDeliveryOptionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /** @param _id - LocalDeliveryOptionId - unique identifier of local delivery option\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField localDeliveryOption\n * @requiredField localDeliveryOption.radiusConfig.address\n * @requiredField localDeliveryOption.radiusConfig.address.formatted\n * @requiredField localDeliveryOption.radiusConfig.address.location\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.enabledForDelivery\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes\n * @requiredField localDeliveryOption.scheduledDeliveryConfig.handlingDays\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE\n * @adminMethod\n */\n function updateLocalDeliveryOption(_id: string | null, localDeliveryOption: UpdateLocalDeliveryOption, options?: UpdateLocalDeliveryOptionOptions): Promise;\n interface UpdateLocalDeliveryOption {\n zipConfig?: ZipCodeConfig;\n radiusConfig?: RadiusConfig;\n customAreaConfig?: CustomAreaConfig;\n /**\n * LocalDeliveryOptionId - unique identifier of local delivery option\n * @readonly\n */\n _id?: string | null;\n /**\n * External id of shipping rule which LocalDeliveryOption is linked to. Most commonly it would be shippingRuleId from WixStores\n * @internal\n * @deprecated External id of shipping rule which LocalDeliveryOption is linked to. Most commonly it would be shippingRuleId from WixStores\n * @targetRemovalDate 2025-01-12\n */\n externalId?: string | null;\n /** Area name of Local Delivery Option */\n areaName?: string | null;\n /**\n * Flat price of local delivery\n * @deprecated Flat price of local delivery\n * @targetRemovalDate 2025-01-12\n */\n rate?: string | null;\n /** Estimated delivery time description text */\n estimatedDeliveryTime?: string | null;\n /**\n * Minimum order total to be eligible for free delivery\n * @deprecated Minimum order total to be eligible for free delivery\n * @targetRemovalDate 2025-01-12\n */\n minimumFreeDeliveryOrderAmount?: number | null;\n /** List of countries with subdivisions */\n destinations?: Destination[];\n /**\n * Database revision of LocalDeliveryOption entity. Incremented on each modification\n * @readonly\n */\n revision?: string | null;\n scheduledDeliveryConfig?: ScheduledDelivery;\n /** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */\n rates?: ConditionalRates$2[];\n /**\n * Date and time the LocalDeliveryOption was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the LocalDeliveryOption was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** This local delivery is active for the following delivery regions. */\n deliveryRegionIds?: string[];\n }\n interface UpdateLocalDeliveryOptionOptions {\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField localDeliveryOptionId\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_DELETE\n * @adminMethod\n */\n function deleteLocalDeliveryOption(localDeliveryOptionId: string, options?: DeleteLocalDeliveryOptionOptions): Promise;\n interface DeleteLocalDeliveryOptionOptions {\n /**\n * @deprecated\n * @targetRemovalDate 2025-01-12\n */\n _id?: string;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField localDeliveryOptions\n * @requiredField localDeliveryOptions.radiusConfig.address\n * @requiredField localDeliveryOptions.radiusConfig.address.formatted\n * @requiredField localDeliveryOptions.radiusConfig.address.location\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.handlingDays\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_CREATE\n * @adminMethod\n */\n function bulkCreateLocalDeliveryOption(localDeliveryOptions: LocalDeliveryOption[]): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField localDeliveryOptions\n * @requiredField localDeliveryOptions.radiusConfig.address\n * @requiredField localDeliveryOptions.radiusConfig.address.formatted\n * @requiredField localDeliveryOptions.radiusConfig.address.location\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.friday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.monday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.saturday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.sunday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.thursday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.tuesday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.enabledForDelivery\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.from.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.hours\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.days.wednesday.timeSlots.to.minutes\n * @requiredField localDeliveryOptions.scheduledDeliveryConfig.handlingDays\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE\n * @adminMethod\n */\n function bulkUpdateLocalDeliveryOption(localDeliveryOptions: LocalDeliveryOption[]): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_DELETE\n * @adminMethod\n */\n function bulkDeleteLocalDeliveryOption(ids: string[]): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options.localDeliveryOptionId\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE\n * @adminMethod\n */\n function addDeliveryRegion$1(deliveryRegionId: string, options?: AddDeliveryRegionOptions$1): Promise;\n interface AddDeliveryRegionOptions$1 {\n localDeliveryOptionId: string;\n /** Revision of the PickupLocation */\n revision?: string | null;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options.localDeliveryOptionId\n * @permissionId ECOM.LOCAL_DELIVERY_OPTION_UPDATE\n * @adminMethod\n */\n function removeDeliveryRegion$1(deliveryRegionId: string, options?: RemoveDeliveryRegionOptions$1): Promise;\n interface RemoveDeliveryRegionOptions$1 {\n localDeliveryOptionId: string;\n /** Revision of the PickupLocation */\n revision?: string | null;\n }\n \n type ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOption = LocalDeliveryOption;\n type ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionConfigOneOf = LocalDeliveryOptionConfigOneOf;\n type ecomV1LocalDeliveryOption_universal_d_Destination = Destination;\n type ecomV1LocalDeliveryOption_universal_d_ZipCodeConfig = ZipCodeConfig;\n type ecomV1LocalDeliveryOption_universal_d_RadiusConfig = RadiusConfig;\n type ecomV1LocalDeliveryOption_universal_d_LocalDeliveryAddress = LocalDeliveryAddress;\n type ecomV1LocalDeliveryOption_universal_d_LengthUnit = LengthUnit;\n const ecomV1LocalDeliveryOption_universal_d_LengthUnit: typeof LengthUnit;\n type ecomV1LocalDeliveryOption_universal_d_CustomAreaConfig = CustomAreaConfig;\n type ecomV1LocalDeliveryOption_universal_d_ScheduledDelivery = ScheduledDelivery;\n type ecomV1LocalDeliveryOption_universal_d_Days = Days;\n type ecomV1LocalDeliveryOption_universal_d_DaySlot = DaySlot;\n type ecomV1LocalDeliveryOption_universal_d_TimeSlot = TimeSlot;\n type ecomV1LocalDeliveryOption_universal_d_TimePoint = TimePoint;\n type ecomV1LocalDeliveryOption_universal_d_TimeWindow = TimeWindow;\n type ecomV1LocalDeliveryOption_universal_d_DayOfWeek = DayOfWeek;\n const ecomV1LocalDeliveryOption_universal_d_DayOfWeek: typeof DayOfWeek;\n type ecomV1LocalDeliveryOption_universal_d_TimeOfDay = TimeOfDay;\n type ecomV1LocalDeliveryOption_universal_d_CreateLocalDeliveryOptionRequest = CreateLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_CreateLocalDeliveryOptionResponse = CreateLocalDeliveryOptionResponse;\n type ecomV1LocalDeliveryOption_universal_d_GetLocalDeliveryOptionRequest = GetLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_GetLocalDeliveryOptionResponse = GetLocalDeliveryOptionResponse;\n type ecomV1LocalDeliveryOption_universal_d_ListLocalDeliveryOptionsRequest = ListLocalDeliveryOptionsRequest;\n type ecomV1LocalDeliveryOption_universal_d_ListLocalDeliveryOptionsResponse = ListLocalDeliveryOptionsResponse;\n type ecomV1LocalDeliveryOption_universal_d_QueryLocalDeliveryOptionsRequest = QueryLocalDeliveryOptionsRequest;\n type ecomV1LocalDeliveryOption_universal_d_QueryLocalDeliveryOptionsResponse = QueryLocalDeliveryOptionsResponse;\n type ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOptionRequest = UpdateLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOptionResponse = UpdateLocalDeliveryOptionResponse;\n type ecomV1LocalDeliveryOption_universal_d_DeleteLocalDeliveryOptionRequest = DeleteLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_DeleteLocalDeliveryOptionResponse = DeleteLocalDeliveryOptionResponse;\n type ecomV1LocalDeliveryOption_universal_d_BulkCreateLocalDeliveryOptionRequest = BulkCreateLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_BulkCreateLocalDeliveryOptionResponse = BulkCreateLocalDeliveryOptionResponse;\n type ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionError = LocalDeliveryOptionError;\n type ecomV1LocalDeliveryOption_universal_d_BulkUpdateLocalDeliveryOptionRequest = BulkUpdateLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_BulkUpdateLocalDeliveryOptionResponse = BulkUpdateLocalDeliveryOptionResponse;\n type ecomV1LocalDeliveryOption_universal_d_BulkDeleteLocalDeliveryOptionRequest = BulkDeleteLocalDeliveryOptionRequest;\n type ecomV1LocalDeliveryOption_universal_d_BulkDeleteLocalDeliveryOptionResponse = BulkDeleteLocalDeliveryOptionResponse;\n const ecomV1LocalDeliveryOption_universal_d_createLocalDeliveryOption: typeof createLocalDeliveryOption;\n const ecomV1LocalDeliveryOption_universal_d_getLocalDeliveryOption: typeof getLocalDeliveryOption;\n type ecomV1LocalDeliveryOption_universal_d_GetLocalDeliveryOptionOptions = GetLocalDeliveryOptionOptions;\n const ecomV1LocalDeliveryOption_universal_d_listLocalDeliveryOptions: typeof listLocalDeliveryOptions;\n const ecomV1LocalDeliveryOption_universal_d_queryLocalDeliveryOptions: typeof queryLocalDeliveryOptions;\n type ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionsQueryResult = LocalDeliveryOptionsQueryResult;\n type ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionsQueryBuilder = LocalDeliveryOptionsQueryBuilder;\n const ecomV1LocalDeliveryOption_universal_d_updateLocalDeliveryOption: typeof updateLocalDeliveryOption;\n type ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOption = UpdateLocalDeliveryOption;\n type ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOptionOptions = UpdateLocalDeliveryOptionOptions;\n const ecomV1LocalDeliveryOption_universal_d_deleteLocalDeliveryOption: typeof deleteLocalDeliveryOption;\n type ecomV1LocalDeliveryOption_universal_d_DeleteLocalDeliveryOptionOptions = DeleteLocalDeliveryOptionOptions;\n const ecomV1LocalDeliveryOption_universal_d_bulkCreateLocalDeliveryOption: typeof bulkCreateLocalDeliveryOption;\n const ecomV1LocalDeliveryOption_universal_d_bulkUpdateLocalDeliveryOption: typeof bulkUpdateLocalDeliveryOption;\n const ecomV1LocalDeliveryOption_universal_d_bulkDeleteLocalDeliveryOption: typeof bulkDeleteLocalDeliveryOption;\n namespace ecomV1LocalDeliveryOption_universal_d {\n export {\n ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOption as LocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionConfigOneOf as LocalDeliveryOptionConfigOneOf,\n ecomV1LocalDeliveryOption_universal_d_Destination as Destination,\n ecomV1LocalDeliveryOption_universal_d_ZipCodeConfig as ZipCodeConfig,\n ecomV1LocalDeliveryOption_universal_d_RadiusConfig as RadiusConfig,\n ecomV1LocalDeliveryOption_universal_d_LocalDeliveryAddress as LocalDeliveryAddress,\n AddressLocation$4 as AddressLocation,\n ecomV1LocalDeliveryOption_universal_d_LengthUnit as LengthUnit,\n ecomV1LocalDeliveryOption_universal_d_CustomAreaConfig as CustomAreaConfig,\n ecomV1LocalDeliveryOption_universal_d_ScheduledDelivery as ScheduledDelivery,\n ecomV1LocalDeliveryOption_universal_d_Days as Days,\n ecomV1LocalDeliveryOption_universal_d_DaySlot as DaySlot,\n ecomV1LocalDeliveryOption_universal_d_TimeSlot as TimeSlot,\n ecomV1LocalDeliveryOption_universal_d_TimePoint as TimePoint,\n ecomV1LocalDeliveryOption_universal_d_TimeWindow as TimeWindow,\n ecomV1LocalDeliveryOption_universal_d_DayOfWeek as DayOfWeek,\n ecomV1LocalDeliveryOption_universal_d_TimeOfDay as TimeOfDay,\n ConditionalRates$2 as ConditionalRates,\n Condition$2 as Condition,\n ConditionType$2 as ConditionType,\n LogicalOperator$2 as LogicalOperator,\n ecomV1LocalDeliveryOption_universal_d_CreateLocalDeliveryOptionRequest as CreateLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_CreateLocalDeliveryOptionResponse as CreateLocalDeliveryOptionResponse,\n ecomV1LocalDeliveryOption_universal_d_GetLocalDeliveryOptionRequest as GetLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_GetLocalDeliveryOptionResponse as GetLocalDeliveryOptionResponse,\n ecomV1LocalDeliveryOption_universal_d_ListLocalDeliveryOptionsRequest as ListLocalDeliveryOptionsRequest,\n ecomV1LocalDeliveryOption_universal_d_ListLocalDeliveryOptionsResponse as ListLocalDeliveryOptionsResponse,\n ecomV1LocalDeliveryOption_universal_d_QueryLocalDeliveryOptionsRequest as QueryLocalDeliveryOptionsRequest,\n QueryV2$2 as QueryV2,\n QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf,\n Sorting$8 as Sorting,\n SortOrder$8 as SortOrder,\n Paging$2 as Paging,\n CursorPaging$8 as CursorPaging,\n ecomV1LocalDeliveryOption_universal_d_QueryLocalDeliveryOptionsResponse as QueryLocalDeliveryOptionsResponse,\n CursorPagingMetadata$7 as CursorPagingMetadata,\n Cursors$8 as Cursors,\n ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOptionRequest as UpdateLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOptionResponse as UpdateLocalDeliveryOptionResponse,\n ecomV1LocalDeliveryOption_universal_d_DeleteLocalDeliveryOptionRequest as DeleteLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_DeleteLocalDeliveryOptionResponse as DeleteLocalDeliveryOptionResponse,\n ecomV1LocalDeliveryOption_universal_d_BulkCreateLocalDeliveryOptionRequest as BulkCreateLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_BulkCreateLocalDeliveryOptionResponse as BulkCreateLocalDeliveryOptionResponse,\n ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionError as LocalDeliveryOptionError,\n ecomV1LocalDeliveryOption_universal_d_BulkUpdateLocalDeliveryOptionRequest as BulkUpdateLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_BulkUpdateLocalDeliveryOptionResponse as BulkUpdateLocalDeliveryOptionResponse,\n ecomV1LocalDeliveryOption_universal_d_BulkDeleteLocalDeliveryOptionRequest as BulkDeleteLocalDeliveryOptionRequest,\n ecomV1LocalDeliveryOption_universal_d_BulkDeleteLocalDeliveryOptionResponse as BulkDeleteLocalDeliveryOptionResponse,\n Empty$6 as Empty,\n DomainEvent$a as DomainEvent,\n DomainEventBodyOneOf$a as DomainEventBodyOneOf,\n EntityCreatedEvent$a as EntityCreatedEvent,\n RestoreInfo$a as RestoreInfo,\n EntityUpdatedEvent$a as EntityUpdatedEvent,\n EntityDeletedEvent$a as EntityDeletedEvent,\n ActionEvent$a as ActionEvent,\n AddDeliveryRegionRequest$1 as AddDeliveryRegionRequest,\n AddDeliveryRegionResponse$1 as AddDeliveryRegionResponse,\n RemoveDeliveryRegionRequest$1 as RemoveDeliveryRegionRequest,\n RemoveDeliveryRegionResponse$1 as RemoveDeliveryRegionResponse,\n MessageEnvelope$9 as MessageEnvelope,\n IdentificationData$a as IdentificationData,\n IdentificationDataIdOneOf$a as IdentificationDataIdOneOf,\n WebhookIdentityType$9 as WebhookIdentityType,\n ecomV1LocalDeliveryOption_universal_d_createLocalDeliveryOption as createLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_getLocalDeliveryOption as getLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_GetLocalDeliveryOptionOptions as GetLocalDeliveryOptionOptions,\n ecomV1LocalDeliveryOption_universal_d_listLocalDeliveryOptions as listLocalDeliveryOptions,\n ecomV1LocalDeliveryOption_universal_d_queryLocalDeliveryOptions as queryLocalDeliveryOptions,\n ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionsQueryResult as LocalDeliveryOptionsQueryResult,\n ecomV1LocalDeliveryOption_universal_d_LocalDeliveryOptionsQueryBuilder as LocalDeliveryOptionsQueryBuilder,\n ecomV1LocalDeliveryOption_universal_d_updateLocalDeliveryOption as updateLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOption as UpdateLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_UpdateLocalDeliveryOptionOptions as UpdateLocalDeliveryOptionOptions,\n ecomV1LocalDeliveryOption_universal_d_deleteLocalDeliveryOption as deleteLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_DeleteLocalDeliveryOptionOptions as DeleteLocalDeliveryOptionOptions,\n ecomV1LocalDeliveryOption_universal_d_bulkCreateLocalDeliveryOption as bulkCreateLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_bulkUpdateLocalDeliveryOption as bulkUpdateLocalDeliveryOption,\n ecomV1LocalDeliveryOption_universal_d_bulkDeleteLocalDeliveryOption as bulkDeleteLocalDeliveryOption,\n addDeliveryRegion$1 as addDeliveryRegion,\n AddDeliveryRegionOptions$1 as AddDeliveryRegionOptions,\n removeDeliveryRegion$1 as removeDeliveryRegion,\n RemoveDeliveryRegionOptions$1 as RemoveDeliveryRegionOptions,\n };\n }\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 | null;\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 | null;\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$3;\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$1;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: ShippingInformation$1;\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$1;\n /** Tax information. */\n taxInfo?: OrderTaxInfo;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$1[];\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 * Cart ID - required by TYP OOI for legacy orders.\n * @internal\n */\n cartId?: string | null;\n /**\n * Private API flag that allows using read-only \"id\" during order creation.\n * @internal\n */\n isInternalOrderCreate?: boolean;\n /**\n * Pay now price summary. Part of price_summary that must be payed at checkout\n * @internal\n * @readonly\n */\n payNow?: PriceSummary$1;\n /**\n * Balance summary.\n * @readonly\n */\n balanceSummary?: BalanceSummary;\n /** Additional fees applied to the order. */\n additionalFees?: AdditionalFee$1[];\n /**\n * Custom string status values aggregated from every fulfillment entity associated with current order\n * @internal\n * @readonly\n */\n fulfillmentStatusesAggregate?: FulfillmentStatusesAggregate;\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 app dashboard before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$4;\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 * Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable.\n * @internal\n */\n tags?: Tags;\n /**\n * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * Used for migration from external systems.\n */\n purchasedDate?: Date | null;\n /**\n * Order Location\n * @internal\n */\n businessLocation?: Location;\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. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$3;\n /** Line item quantity. */\n quantity?: number;\n /**\n * Total discount for this line item's entire quantity.\n * @readonly\n */\n totalDiscount?: Price$3;\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$2;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$1;\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 /** Number of items that were refunded. */\n refundQuantity?: number | null;\n /** Number of items restocked. */\n restockQuantity?: number | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$3;\n /**\n * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: Price$3;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$3;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$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. Eligible for catalog items with type `DEPOSIT_ONLINE` only.\n */\n paymentOption?: PaymentOptionType$1;\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$1;\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$3;\n /**\n * The Item's Delivery Profile Id\n * @internal\n */\n deliveryProfileId?: string | null;\n /** @internal */\n shippingGroupId?: string | null;\n /**\n * Source locations for this line item. The location's total quantity must not exceed the line item quantity.\n * @internal\n */\n locations?: LocationAndQuantity[];\n /**\n * Total price **after** catalog discounts and line item discounts.\n * @internal\n */\n lineItemPrice?: Price$3;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @internal\n * @readonly\n */\n customLineItem?: boolean | null;\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 * @internal\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Address used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$1;\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: boolean;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$4;\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$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 [app dashboard](https://dev.wix.com/dc3/my-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$3 {\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 /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType;\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 * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\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 /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\n COLOR = \"COLOR\"\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 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 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 /** 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 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 checkout. The 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$1 {\n /** Taxable amount of this line item. */\n taxableAmount?: Price$3;\n /**\n * ID of the item's tax group, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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$3;\n }\n interface LineItemTaxInfo {\n /** Calculated tax, based on `taxable_amount` and `tax_rate`. */\n taxAmount?: Price$3;\n /** Amount for which tax is calculated. */\n taxableAmount?: Price$3;\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$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 /** Type of jurisdiction that taxes were calculated for. */\n jurisdictionType?: JurisdictionType$1;\n /** Non-taxable amount of the line item price. */\n nonTaxableAmount?: Price$3;\n /** Taxable amount of the line item price. */\n taxableAmount?: Price$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$1 {\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 | null;\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$2;\n }\n interface SubscriptionSettings$2 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$2;\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 * Whether to allow the customer to cancel the subscription.\n * @internal\n */\n enableCustomerCancellation?: boolean;\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 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 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 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 /** 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 * Payment received but not yet confirmed by the payment provider and waits for some user action\n * @documentationMaturity preview\n */\n PENDING_MERCHANT = \"PENDING_MERCHANT\",\n /**\n * Payment was canceled by user on payment provider side\n * @documentationMaturity preview\n */\n CANCELED = \"CANCELED\",\n /**\n * Payment was declined by payment provider\n * @documentationMaturity preview\n */\n DECLINED = \"DECLINED\"\n }\n enum FulfillmentStatus$1 {\n /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */\n NOT_FULFILLED = \"NOT_FULFILLED\",\n /**\n * All of the order items are fulfilled or the 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$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 PriceSummary$1 {\n /** Subtotal of all the line items, before discounts and before tax. */\n subtotal?: Price$3;\n /** Total shipping price, before discounts and before tax. */\n shipping?: Price$3;\n /** Total tax on this order. */\n tax?: Price$3;\n /** Total calculated discount value. */\n discount?: Price$3;\n /**\n * Deprecated - use `total` instead.\n * @internal\n * @deprecated\n */\n totalPrice?: Price$3;\n /** Order’s total price after discounts and tax. */\n total?: Price$3;\n /**\n * Order's total price including gift card.\n * @internal\n * @deprecated\n */\n totalWithGiftCard?: Price$3;\n /**\n * Order's total price after without gift card.\n * @internal\n * @deprecated\n */\n totalWithoutGiftCard?: Price$3;\n /** Total price of additional fees before tax. */\n totalAdditionalFees?: Price$3;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact {\n /** Address. */\n address?: Address$5;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails$1;\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 /** @internal */\n location?: AddressLocation$3;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$4 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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$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 ShippingInformation$1 {\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$2;\n /** Shipping costs. */\n cost?: ShippingPrice$1;\n /** Shipping region. */\n region?: ShippingRegion$1;\n }\n interface DeliveryLogistics$2 extends DeliveryLogisticsAddressOneOf {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact;\n /** Pickup details. */\n pickupDetails?: PickupDetails$3;\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 | null;\n /** Expected delivery time. */\n deliveryTimeSlot?: DeliveryTimeSlot$2;\n }\n /** @oneof */\n interface DeliveryLogisticsAddressOneOf {\n /** Shipping address and contact details. */\n shippingDestination?: AddressWithContact;\n /** Pickup details. */\n pickupDetails?: PickupDetails$3;\n }\n interface PickupDetails$3 {\n /** Pickup address. */\n address?: PickupAddress$1;\n /** Pickup method */\n pickupMethod?: PickupMethod$2;\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$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 * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n /** @internal */\n location?: AddressLocation$3;\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 /** Delivery slot starting time. */\n from?: Date | null;\n /** Delivery slot ending time. */\n to?: Date | null;\n }\n interface ShippingPrice$1 {\n /** Shipping price for display purposes. */\n price?: Price$3;\n /**\n * Total price of shipping after discounts (when relevant), and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$3;\n /**\n * Shipping price after all discounts (if any exist), and after tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$3;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$1;\n /**\n * Shipping discount before tax.\n * @readonly\n */\n discount?: Price$3;\n }\n interface ShippingRegion$1 {\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 /** @documentationMaturity preview */\n PENDING = \"PENDING\",\n /** @documentationMaturity preview */\n REJECTED = \"REJECTED\"\n }\n interface TaxSummary$1 {\n /**\n * Total tax.\n * @readonly\n */\n totalTax?: Price$3;\n /**\n * manual tax rate\n * @internal\n * @readonly\n */\n manualTaxRate?: string | null;\n }\n interface OrderTaxInfo {\n /** Calculated tax, added from line items. */\n totalTax?: Price$3;\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 * Manual tax rate\n * @internal\n * @readonly\n */\n manualTaxRate?: string | null;\n /**\n * Whether the draft order is exempt from tax calculations.\n *\n * Default: `false`\n * @readonly\n */\n taxExempt?: boolean | 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 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$1;\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$3;\n /**\n * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: Price$3;\n }\n interface AppliedDiscount$1 extends AppliedDiscountDiscountSourceOneOf$1 {\n /** Applied coupon info. */\n coupon?: Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$1;\n /** Automatic Discount */\n discountRule?: DiscountRule$1;\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$1;\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 * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount$1[];\n }\n /** @oneof */\n interface AppliedDiscountDiscountSourceOneOf$1 {\n /** Applied coupon info. */\n coupon?: Coupon$1;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount$1;\n /** Automatic Discount */\n discountRule?: DiscountRule$1;\n }\n enum DiscountType$1 {\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 name. */\n name?: string;\n /** Coupon value. */\n amount?: Price$3;\n }\n interface MerchantDiscount$1 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$3;\n /**\n * Discount percentage.\n * @internal\n */\n percentage?: string | null;\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$1 {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName$1;\n /** Discount value. */\n amount?: Price$3;\n }\n interface DiscountRuleName$1 {\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 /** Total discount for this line item. */\n totalDiscount?: Price$3;\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 * Details of the original order for this exchange order. `activity.type` must be `ORDER_CREATED_FROM_EXCHANGE`.\n * @internal\n */\n orderCreatedFromExchange?: OrderCreatedFromExchange;\n /**\n * Details of an order that was created as a result of an exchange of items in this order. `activity.type` must be `NEW_EXCHANGE_ORDER_CREATED`.\n * @internal\n */\n newExchangeOrderCreated?: NewExchangeOrderCreated;\n /**\n * Details of changes made by the Draft Orders API.\n * @internal\n */\n draftOrderChangesApplied?: DraftOrderChangesApplied;\n /**\n * Details of the payment method saved for order\n * @internal\n */\n savedPaymentMethod?: SavedPaymentMethod;\n /**\n * Details of an authorized payment created.\n * @internal\n */\n authorizedPaymentCreated?: AuthorizedPaymentCreated;\n /**\n * Details of an authorized payment captured.\n * @internal\n */\n authorizedPaymentCaptured?: AuthorizedPaymentCaptured;\n /**\n * Details of an authorized payment voided.\n * @internal\n */\n authorizedPaymentVoided?: AuthorizedPaymentVoided;\n /**\n * Details of an initiated refund process.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n refundInitiated?: RefundInitiated;\n /**\n * Details of a refunded payment.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefunded?: PaymentRefunded;\n /**\n * Details of a failed payment refund.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefundFailed?: PaymentRefundFailed;\n /**\n * Details of refund to store credit.\n * @internal\n */\n refundedAsStoreCredit?: RefundedAsStoreCredit;\n /**\n * Details of a pending payment\n * @internal\n */\n paymentPending?: PaymentPending;\n /**\n * Details of a canceled payment\n * @internal\n */\n paymentCanceled?: PaymentCanceled;\n /**\n * Details of a declined payment\n * @internal\n */\n paymentDeclined?: PaymentDeclined;\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 | null;\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 * Details of the original order for this exchange order. `activity.type` must be `ORDER_CREATED_FROM_EXCHANGE`.\n * @internal\n */\n orderCreatedFromExchange?: OrderCreatedFromExchange;\n /**\n * Details of an order that was created as a result of an exchange of items in this order. `activity.type` must be `NEW_EXCHANGE_ORDER_CREATED`.\n * @internal\n */\n newExchangeOrderCreated?: NewExchangeOrderCreated;\n /**\n * Details of changes made by the Draft Orders API.\n * @internal\n */\n draftOrderChangesApplied?: DraftOrderChangesApplied;\n /**\n * Details of the payment method saved for order\n * @internal\n */\n savedPaymentMethod?: SavedPaymentMethod;\n /**\n * Details of an authorized payment created.\n * @internal\n */\n authorizedPaymentCreated?: AuthorizedPaymentCreated;\n /**\n * Details of an authorized payment captured.\n * @internal\n */\n authorizedPaymentCaptured?: AuthorizedPaymentCaptured;\n /**\n * Details of an authorized payment voided.\n * @internal\n */\n authorizedPaymentVoided?: AuthorizedPaymentVoided;\n /**\n * Details of an initiated refund process.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n refundInitiated?: RefundInitiated;\n /**\n * Details of a refunded payment.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefunded?: PaymentRefunded;\n /**\n * Details of a failed payment refund.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefundFailed?: PaymentRefundFailed;\n /**\n * Details of refund to store credit.\n * @internal\n */\n refundedAsStoreCredit?: RefundedAsStoreCredit;\n /**\n * Details of a pending payment\n * @internal\n */\n paymentPending?: PaymentPending;\n /**\n * Details of a canceled payment\n * @internal\n */\n paymentCanceled?: PaymentCanceled;\n /**\n * Details of a declined payment\n * @internal\n */\n paymentDeclined?: PaymentDeclined;\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$3;\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. */\n QUANTITY_INCREASED = \"QUANTITY_INCREASED\",\n /** Quantity decreased. */\n QUANTITY_DECREASED = \"QUANTITY_DECREASED\"\n }\n interface LineItemPriceChange {\n /** Item price before update. */\n originalPrice?: Price$3;\n /** Item price after update. */\n newPrice?: Price$3;\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$3;\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$3;\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$3;\n }\n interface TotalPriceChange {\n /** Order’s total price after discounts and tax. Before update */\n originalTotal?: Price$3;\n /** Order’s total price after discounts and tax. After update */\n newTotal?: Price$3;\n }\n interface ShippingInformationChange {\n /** Order’s Shipping Information. Before update */\n originalShippingInfo?: ShippingInformationChangeShippingInformation;\n /** Order’s Shipping Information. After update */\n newShippingInfo?: ShippingInformationChangeShippingInformation;\n }\n interface ShippingInformationChangeShippingInformation {\n /** Order’s shipping price. */\n total?: Price$3;\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$3;\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$3;\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$3;\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 RefundInitiated {\n /** Refund ID. */\n refundId?: string;\n /** Refund amount. */\n amount?: Price$3;\n /** Details about the payments being refunded. */\n payments?: RefundedPayment[];\n /** Reason for refund. */\n reason?: string | null;\n }\n interface RefundedPayment extends RefundedPaymentKindOneOf {\n /** Regular payment refund. */\n regular?: RegularPaymentRefund;\n /** Gift card payment refund. */\n giftCard?: GiftCardPaymentRefund;\n /** Membership payment refund. */\n membership?: MembershipPaymentRefund;\n /** Payment ID. */\n paymentId?: string;\n /** Whether refund was made externally and manually on the payment provider's side. */\n externalRefund?: boolean;\n }\n /** @oneof */\n interface RefundedPaymentKindOneOf {\n /** Regular payment refund. */\n regular?: RegularPaymentRefund;\n /** Gift card payment refund. */\n giftCard?: GiftCardPaymentRefund;\n /** Membership payment refund. */\n membership?: MembershipPaymentRefund;\n }\n interface RegularPaymentRefund {\n /** Refund amount */\n amount?: Price$3;\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 GiftCardPaymentRefund {\n /** Gift card payment ID */\n giftCardPaymentId?: string | null;\n /** Refund amount */\n amount?: Price$3;\n }\n interface MembershipPaymentRefund {\n /** Membership ID */\n membershipId?: string | null;\n }\n interface PaymentRefunded {\n /** Refund ID. */\n refundId?: string;\n /** Details about the refunded payment. */\n payment?: RefundedPayment;\n }\n interface PaymentRefundFailed {\n /** Refund ID. */\n refundId?: string;\n /** Details about the failed payment refund. */\n payment?: RefundedPayment;\n }\n interface RefundedAsStoreCredit {\n /** Refund amount */\n amount?: Price$3;\n /** Reason for refund */\n reason?: string | null;\n }\n interface PaymentPending extends PaymentPendingPaymentDetailsOneOf {\n /** Regular payment. */\n regular?: RegularPayment;\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n }\n /** @oneof */\n interface PaymentPendingPaymentDetailsOneOf {\n /** Regular payment. */\n regular?: RegularPayment;\n }\n interface RegularPayment extends RegularPaymentPaymentMethodDetailsOneOf {\n /** Whether regular card used */\n creditCardDetails?: CreditCardDetails;\n /** Payment amount */\n amount?: Price$3;\n }\n /** @oneof */\n interface RegularPaymentPaymentMethodDetailsOneOf {\n /** Whether regular card used */\n creditCardDetails?: CreditCardDetails;\n }\n interface CreditCardDetails {\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 PaymentCanceled extends PaymentCanceledPaymentDetailsOneOf {\n /** Regular payment. */\n regular?: RegularPayment;\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n }\n /** @oneof */\n interface PaymentCanceledPaymentDetailsOneOf {\n /** Regular payment. */\n regular?: RegularPayment;\n }\n interface PaymentDeclined extends PaymentDeclinedPaymentDetailsOneOf {\n /** Regular payment. */\n regular?: RegularPayment;\n /** Payment ID of payment associated with this activity */\n paymentId?: string;\n }\n /** @oneof */\n interface PaymentDeclinedPaymentDetailsOneOf {\n /** Regular payment. */\n regular?: RegularPayment;\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 REFUND_INITIATED = \"REFUND_INITIATED\",\n PAYMENT_REFUNDED = \"PAYMENT_REFUNDED\",\n PAYMENT_REFUND_FAILED = \"PAYMENT_REFUND_FAILED\",\n REFUNDED_AS_STORE_CREDIT = \"REFUNDED_AS_STORE_CREDIT\",\n /** @documentationMaturity preview */\n PAYMENT_PENDING = \"PAYMENT_PENDING\",\n /** @documentationMaturity preview */\n PAYMENT_CANCELED = \"PAYMENT_CANCELED\",\n /** @documentationMaturity preview */\n PAYMENT_DECLINED = \"PAYMENT_DECLINED\",\n /** @documentationMaturity preview */\n ORDER_PENDING = \"ORDER_PENDING\",\n /** @documentationMaturity preview */\n ORDER_REJECTED = \"ORDER_REJECTED\"\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 sales channel. This value is not supported. */\n UNSPECIFIED = \"UNSPECIFIED\",\n /** A web client. */\n WEB = \"WEB\",\n /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */\n POS = \"POS\",\n /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */\n EBAY = \"EBAY\",\n /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */\n AMAZON = \"AMAZON\",\n /** Other sales platform. */\n OTHER_PLATFORM = \"OTHER_PLATFORM\",\n /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */\n WIX_APP_STORE = \"WIX_APP_STORE\",\n /** 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_INVOICES = \"WIX_INVOICES\",\n /** Wix merchant backoffice. */\n BACKOFFICE_MERCHANT = \"BACKOFFICE_MERCHANT\",\n /** Wish sales channel. */\n WISH = \"WISH\",\n /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */\n CLASS_PASS = \"CLASS_PASS\",\n /** Global-E sales channel. */\n GLOBAL_E = \"GLOBAL_E\",\n /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */\n FACEBOOK = \"FACEBOOK\",\n /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */\n ETSY = \"ETSY\",\n /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */\n TIKTOK = \"TIKTOK\",\n /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */\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$3;\n /**\n * Sum of all successfully refunded payments.\n * @readonly\n */\n refunded?: Price$3;\n /**\n * Sum of all authorized payments.\n * @readonly\n */\n authorized?: Price$3;\n /**\n * Sum of all pending refund transactions.\n * @internal\n * @readonly\n */\n pendingRefund?: Price$3;\n /**\n * Sum of all pending transactions.\n * @readonly\n */\n pending?: Price$3;\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$1 {\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$3;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails$1;\n /** SPI implementer's `appId`. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: Price$3;\n /** Additional fee's price after tax. */\n priceAfterTax?: Price$3;\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 /**\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 Location {\n /**\n * Location ID.\n * Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n */\n _id?: string;\n /**\n * Location name.\n * @readonly\n */\n name?: 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 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 OrderRejectedEventOrderRejected {\n /** The order that was rejected */\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 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 | null;\n /**\n * Date and time when meta site was updated for the last time.\n * @readonly\n */\n dateUpdated?: Date | null;\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 * 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 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$7;\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting$7[];\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$7;\n }\n interface Sorting$7 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$7;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$7 {\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$7 {\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$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 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 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 * Membership payment details.\n * @internal\n */\n membershipPaymentDetails?: MembershipPaymentDetails$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 | null;\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 | null;\n /** Payment amount. */\n amount?: Price$3;\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 * Membership payment details.\n * @internal\n */\n membershipPaymentDetails?: MembershipPaymentDetails$1;\n }\n interface RegularPaymentDetails$1 extends RegularPaymentDetailsPaymentMethodDetailsOneOf$1 {\n /** Whether regular card used */\n creditCardDetails?: CreditCardPaymentMethodDetails$1;\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 /** Authorization details. */\n authorizationDetails?: AuthorizationDetails$1;\n }\n /** @oneof */\n interface RegularPaymentDetailsPaymentMethodDetailsOneOf$1 {\n /** Whether regular card used */\n creditCardDetails?: CreditCardPaymentMethodDetails$1;\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$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 AuthorizationDetails$1 {\n /**\n * Whether the authorized payment is of a delayed capture.\n * @readonly\n */\n delayedCapture?: boolean;\n /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n authorizedDate?: Date | null;\n /**\n * List of captures associated with payment\n * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses\n */\n captures?: AuthorizationCapture$1[];\n /** Void associated with payment */\n void?: AuthorizationVoid$1;\n /** Scheduled action for this transaction */\n scheduledAction?: ScheduledAction$1;\n }\n interface AuthorizationCapture$1 {\n /**\n * Capture ID.\n * @readonly\n */\n _id?: string | null;\n /** Status of this capture action */\n status?: AuthorizationCaptureStatus$1;\n /** Amount of this capture */\n amount?: Price$3;\n /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n _createdDate?: Date | null;\n /** In case of status is FAILED may contain failure details */\n failureDetails?: AuthorizationActionFailureDetails$1;\n }\n enum AuthorizationCaptureStatus$1 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Capture operation still in progress. */\n PENDING = \"PENDING\",\n /** Capture operation succeeded. */\n SUCCEEDED = \"SUCCEEDED\",\n /** Capture operation failed. */\n FAILED = \"FAILED\"\n }\n interface AuthorizationActionFailureDetails$1 {\n failureCode?: string;\n }\n interface AuthorizationVoid$1 {\n /** Status of this void action */\n status?: AuthorizationVoidStatus$1;\n /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n voidedDate?: Date | null;\n /** In case of status is FAILED may contain failure details */\n failureDetails?: AuthorizationActionFailureDetails$1;\n /** Reason of void action */\n reason?: Reason$1;\n }\n enum AuthorizationVoidStatus$1 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Void operation still in progress. */\n PENDING = \"PENDING\",\n /** Void operation succeeded. */\n SUCCEEDED = \"SUCCEEDED\",\n /** Void operation failed. */\n FAILED = \"FAILED\"\n }\n /** Reason the authorization was voided. */\n enum Reason$1 {\n UNKNOWN_REASON = \"UNKNOWN_REASON\",\n /** Authorization was voided by user. */\n MANUAL = \"MANUAL\",\n /** Authorization passed execution date. */\n SCHEDULED = \"SCHEDULED\"\n }\n interface ScheduledAction$1 {\n /** Type of the action. */\n actionType?: ActionType$1;\n /** The date and time of the action. */\n executionDate?: Date | null;\n }\n enum ActionType$1 {\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 /**\n * Gift card ID.\n * @internal\n * @deprecated\n */\n giftCardId?: 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 * Gift card obfuscated code.\n * @internal\n */\n obfuscatedCode?: string | null;\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$2;\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 /** Payment was charged. */\n CHARGED = \"CHARGED\",\n /** The attempt to charge the payment failed, for example, due to lack of credits. */\n CHARGE_FAILED = \"CHARGE_FAILED\"\n }\n interface MembershipName$2 {\n /** Membership name. */\n original?: string;\n /** Translated membership name. 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 /**\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 * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Aggregated refund status\n * @internal\n * @readonly\n */\n summary?: AggregatedRefundSummary$1;\n }\n interface RefundTransaction$1 {\n /** ID of the payment associated with this refund. */\n paymentId?: string;\n /** Refund amount. */\n amount?: Price$3;\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 /** Refund transaction status. */\n enum RefundStatus$1 {\n /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */\n PENDING = \"PENDING\",\n /** Refund transaction succeeded. */\n SUCCEEDED = \"SUCCEEDED\",\n /** Refund transaction failed. */\n FAILED = \"FAILED\",\n /** Refund request acknowledged, and will be executed soon. */\n SCHEDULED = \"SCHEDULED\",\n /** Refund was initiated on payment provider side. */\n STARTED = \"STARTED\"\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 * Line items that were refunded.\n * @internal\n */\n lineItems?: V1LineItemRefund[];\n /**\n * Additional fees that were refunded.\n * @internal\n */\n additionalFees?: V1AdditionalFeeRefund[];\n /**\n * Shipping amount that was refunded.\n * @internal\n */\n shipping?: V1ShippingRefund;\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 V1LineItemRefund {\n /**\n * Line item ID.\n * @internal\n */\n lineItemId?: string;\n /**\n * Refund quantity.\n * @internal\n */\n quantity?: number;\n }\n interface V1AdditionalFeeRefund {\n /**\n * Additional fee ID.\n * @internal\n */\n additionalFeeId?: string;\n /**\n * Refund amount.\n * @internal\n */\n amount?: Price$3;\n }\n interface V1ShippingRefund {\n /**\n * Refund amount.\n * @internal\n */\n amount?: Price$3;\n }\n interface AggregatedRefundSummary$1 {\n /**\n * Total refund amount requested\n * @internal\n */\n requestedRefund?: Price$3;\n /**\n * Pending refund amount\n * @internal\n */\n pendingRefund?: Price$3;\n /**\n * Refunded amount: portion of requested_refund_amount that succeeded\n * @internal\n */\n refunded?: Price$3;\n /**\n * Failed refund amount: portion of requested_refund_amount that failed\n * @internal\n */\n failedRefundAmount?: Price$3;\n /**\n * `true`: at least one refund transaction is still in PENDING status\n * @internal\n */\n pending?: boolean;\n }\n interface UpsertRefundRequest {\n /** Meta site ID. */\n metasiteId?: string;\n /** Order ID associated with refund. */\n orderId?: string;\n /** Refund to upsert. */\n refund?: Refund$1;\n }\n interface UpsertRefundResponse {\n /** Updated order transactions. */\n orderTransactions?: OrderTransactions$1;\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$9;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$9 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$9 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$9 {\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$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$8;\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$8 {\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 /** when event was created / issued */\n issuedAt?: Date | 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$5 {\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$3;\n /** Refund ID. (Optional) */\n refundId?: string | null;\n }\n interface SendCancelRefundEmailResponse {\n }\n interface SendRefundEmailRequest {\n /** The ID of order that is refunded */\n orderId?: string;\n /** Refund ID */\n refundId?: string;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n }\n interface SendRefundEmailResponse {\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$3;\n /** Refund business details */\n details?: RefundDetails$1;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund ID. (Optional) */\n refundId?: 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$3;\n /** Refund ID. (Optional) */\n refundId?: string | null;\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$3;\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 * Whether to delay capture of the payment.\n * Default: false\n * @deprecated Whether to delay capture of the payment.\n * Default: false\n * @replacedBy delayed_capture_settings.scheduled_action\n * @targetRemovalDate 2024-09-30\n */\n delayedCapture?: boolean;\n /**\n * Specifies whether payment collection is initiated by Merchant or User of User\n * Default: `true`\n * @internal\n */\n merchantInitiated?: boolean | null;\n /**\n * Redirect urls which are used to return buyer to third party system.\n * @internal\n */\n redirectUrls?: RedirectUrls;\n /** Delayed capture payment settings */\n delayedCaptureSettings?: DelayedCaptureSettings;\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 DelayedCaptureSettings {\n /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */\n scheduledAction?: DelayedCaptureSettingsScheduledAction;\n /** Delay duration before execution. Optional - if not set, providers default period will be used */\n delayDuration?: Duration;\n }\n enum DelayedCaptureSettingsScheduledAction {\n UNSPECIFIED = \"UNSPECIFIED\",\n /** Whether payment will be auto-voided when duration passes */\n VOID = \"VOID\",\n /** Whether payment will be auto-captured when duration passes */\n CAPTURE = \"CAPTURE\"\n }\n interface Duration {\n /** Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc */\n count?: number;\n /** Duration unit: MINUTES, HOURS and DAYS */\n unit?: DurationUnit;\n }\n enum DurationUnit {\n UNKNOWN_DURATION_UNIT = \"UNKNOWN_DURATION_UNIT\",\n MINUTES = \"MINUTES\",\n HOURS = \"HOURS\",\n DAYS = \"DAYS\"\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$3;\n /**\n * Whether authorization supported\n * @internal\n */\n authorizationSupported?: boolean;\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 NONCOLLECTABLE_ORDER_IS_PENDING = \"NONCOLLECTABLE_ORDER_IS_PENDING\",\n NONCOLLECTABLE_ORDER_IS_REJECTED = \"NONCOLLECTABLE_ORDER_IS_REJECTED\"\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$3;\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 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$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$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 ORDER_IS_PENDING = \"ORDER_IS_PENDING\",\n ORDER_IS_REJECTED = \"ORDER_IS_REJECTED\"\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 * Whether to delay capture of the payment.\n *\n * Default: false\n * @internal\n */\n delayedCapture?: boolean;\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$2;\n /** Additional data about this membership */\n membershipAdditionalData?: Record | null;\n /** Catalog and item reference info. */\n catalogReference?: CatalogReference$3;\n /** Properties of the service. When relevant, contains information such as date and number of participants. */\n serviceProperties?: ServiceProperties$1;\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$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 | null;\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$3;\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 * Gateway refund id. When param is present, new refund is not created.\n * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,\n * and all side effects from request will be executed.\n * @internal\n */\n gatewayRefundId?: string | null;\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 /**\n * Deprecated, use items instead\n * @internal\n * @deprecated\n */\n lineItemIds?: string[];\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 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$3;\n /** Tax cost of the order */\n tax?: Price$3;\n /** Discount given for this order */\n discount?: Price$3;\n /** Total cost of the order (without tax) */\n subtotal?: Price$3;\n /** Total shipping cost for order */\n shipping?: Price$3;\n /** Previous refund given on that order */\n previouslyRefundedAmount?: Price$3;\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$3;\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$3;\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$3;\n }\n interface ChargeSavedPaymentMethodResponse {\n /** Payment gateway's order ID (e.g Wix Payments) */\n paymentGatewayOrderId?: string;\n }\n interface DiffmatokyPayload$2 {\n left?: string;\n right?: string;\n compareChannel?: string;\n entityId?: string;\n errorInformation?: ErrorInformation$2;\n tags?: string[];\n }\n interface ErrorInformation$2 {\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$7;\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$7[];\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$7;\n }\n interface SearchOrdersResponse {\n /** List of orders. */\n orders?: Order$1[];\n /** Details on the paged set of results returned. */\n metadata?: CursorPagingMetadata$6;\n }\n interface CursorPagingMetadata$6 {\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$7;\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | null;\n }\n interface CreateOrderRequest {\n /** Order info. */\n order: Order$1;\n /**\n * Determine order lifecycle\n * @internal\n */\n settings?: OrderCreationSettings;\n }\n interface OrderCreationSettings {\n /**\n * Condition for the order to be approved.\n * Default: `DEFAULT`\n * @internal\n */\n orderApprovalStrategy?: OrderApprovalStrategy;\n /**\n * Notification settings to be applied on order creation\n * @internal\n */\n notifications?: OrderCreateNotifications;\n }\n enum OrderApprovalStrategy {\n /** When `order.priceSummary.total = 0`, **or** after receiving payment. */\n DEFAULT = \"DEFAULT\",\n /** Order is approved **only** after receiving payment. */\n PAYMENT_RECEIVED = \"PAYMENT_RECEIVED\",\n PAYMENT_METHOD_SAVED = \"PAYMENT_METHOD_SAVED\"\n }\n interface OrderCreateNotifications {\n /**\n * Whether to send notification to the buyer.\n *\n * Default: `true`\n * @internal\n */\n sendNotificationToBuyer?: boolean | null;\n /**\n * Whether to send notifications to the business.\n *\n * Default: `true`\n * @internal\n */\n sendNotificationsToBusiness?: boolean | null;\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 * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\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 * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\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?: ShippingInformation$1;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n /**\n * Buyer info and selected buyer option details.\n * @internal\n */\n changedBuyerInfo?: BuyerInfo$1;\n /**\n * Remove existing buyer info.\n * @internal\n */\n buyerInfoRemoved?: boolean;\n /**\n * Updated billing info.\n * @internal\n */\n changedBillingInfo?: AddressWithContact;\n /**\n * Remove existing billing info.\n * @internal\n */\n billingInfoRemoved?: boolean;\n /**\n * Updated recipient info.\n * @internal\n */\n changedRecipientInfo?: AddressWithContact;\n /**\n * Remove existing recipient info.\n * @internal\n */\n recipientInfoRemoved?: boolean;\n /** Added/updated/removed order line items. */\n lineItems?: V1LineItemDelta[];\n /** Added/updated/removed discounts. */\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$1;\n /**\n * Updated order price summary. overwrites existing price summary.\n * balance will be updated automatically.\n */\n priceSummary?: PriceSummary$1;\n /**\n * Tax information.\n * @internal\n */\n taxInfo?: OrderTaxInfo;\n /**\n * Updated order extended fields. Overrides existing extended fields. todo fully? partially?\n * @internal\n */\n extendedFields?: ExtendedFields$4;\n }\n /** @oneof */\n interface DraftOrderDiffsShippingUpdateInfoOneOf {\n /** Shipping info and selected shipping option details. */\n changedShippingInfo?: ShippingInformation$1;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n }\n /** @oneof */\n interface DraftOrderDiffsBuyerUpdateInfoOneOf {\n /**\n * Buyer info and selected buyer option details.\n * @internal\n */\n changedBuyerInfo?: BuyerInfo$1;\n /**\n * Remove existing buyer info.\n * @internal\n */\n buyerInfoRemoved?: boolean;\n }\n /** @oneof */\n interface DraftOrderDiffsBillingUpdateInfoOneOf {\n /**\n * Updated billing info.\n * @internal\n */\n changedBillingInfo?: AddressWithContact;\n /**\n * Remove existing billing info.\n * @internal\n */\n billingInfoRemoved?: boolean;\n }\n /** @oneof */\n interface DraftOrderDiffsRecipientUpdateInfoOneOf {\n /**\n * Updated recipient info.\n * @internal\n */\n changedRecipientInfo?: AddressWithContact;\n /**\n * Remove existing recipient info.\n * @internal\n */\n recipientInfoRemoved?: boolean;\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 may be empty in the case of a custom line item.\n */\n catalogReference?: CatalogReference$3;\n /** Line item quantity. */\n quantity?: number;\n /** Total discount for this line item's entire quantity. */\n totalDiscount?: Price$3;\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$2;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$1;\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$3;\n /** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: Price$3;\n /** Total price after all discounts and tax. */\n totalPriceAfterTax?: Price$3;\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$1;\n /**\n * Represents all the relevant tax details for a specific line item.\n * @internal\n */\n taxInfo?: LineItemTaxInfo;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL.\n * @internal\n */\n digitalFile?: DigitalFile$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 /** Total price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: Price$3;\n /** Total price after all discounts excluding tax. */\n totalPriceBeforeTax?: Price$3;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @internal\n */\n customLineItem?: boolean | null;\n /**\n * Source locations for this line item. The location's total quantity must not exceed the line item quantity.\n * @internal\n */\n locations?: LocationAndQuantity[];\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n /** Subscription info. */\n subscriptionInfo?: SubscriptionInfo$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 the given item will happen after 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, the 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$3;\n /** The price description before the change */\n priceDescriptionBeforeChange?: PriceDescription;\n }\n interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {\n editedDiscount?: AppliedDiscount$1;\n discountRemoved?: boolean;\n /** Discount id. */\n discountId?: string;\n }\n /** @oneof */\n interface AppliedDiscountDeltaDeltaOneOf {\n editedDiscount?: AppliedDiscount$1;\n discountRemoved?: boolean;\n }\n interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {\n editedAdditionalFee?: AdditionalFee$1;\n additionalFeeRemoved?: boolean;\n /** Additional fee id. */\n additionalFeeId?: string;\n }\n /** @oneof */\n interface AdditionalFeeDeltaDeltaOneOf {\n editedAdditionalFee?: AdditionalFee$1;\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 | null;\n }\n interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {\n /** Shipping info and selected shipping option details. */\n changedShippingInfo?: ShippingInformation$1;\n /** Remove existing shipping info. */\n shippingInfoRemoved?: boolean;\n /** Added/updated/removed order line items. */\n lineItems?: LineItemDelta[];\n /** Added/updated/removed discounts. */\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?: ShippingInformation$1;\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 /**\n * Field mask of buyerInfo fields to update.\n * @internal\n */\n fieldMask?: 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 /**\n * mask of shipping address fields to update\n * @internal\n */\n fieldMask?: 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 /**\n * mask of contact details fields to update\n * @internal\n */\n fieldMask?: string[];\n /** Contact details. */\n addressContactDetails?: FullAddressContactDetails$1;\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 * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\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 * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\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 * Details of an authorized payment created.\n * @internal\n */\n authorizedPaymentCreated?: AuthorizedPaymentCreated;\n /**\n * Details of an authorized payment captured.\n * @internal\n */\n authorizedPaymentCaptured?: AuthorizedPaymentCaptured;\n /**\n * Details of an authorized payment voided.\n * @internal\n */\n authorizedPaymentVoided?: AuthorizedPaymentVoided;\n /**\n * Details of an initiated refund process.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n refundInitiated?: RefundInitiated;\n /**\n * Details of a refunded payment.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefunded?: PaymentRefunded;\n /**\n * Details of a failed payment refund.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefundFailed?: PaymentRefundFailed;\n /**\n * Details of refund to store credit.\n * @internal\n */\n refundedAsStoreCredit?: RefundedAsStoreCredit;\n /** Details of a pending payment */\n paymentPending?: PaymentPending;\n /** Details of a canceled payment */\n paymentCanceled?: PaymentCanceled;\n /** Details of a declined payment */\n paymentDeclined?: PaymentDeclined;\n /** Order pending */\n orderPending?: OrderPending;\n /** Order rejected */\n orderRejected?: OrderRejected;\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 | null;\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 * Details of an authorized payment created.\n * @internal\n */\n authorizedPaymentCreated?: AuthorizedPaymentCreated;\n /**\n * Details of an authorized payment captured.\n * @internal\n */\n authorizedPaymentCaptured?: AuthorizedPaymentCaptured;\n /**\n * Details of an authorized payment voided.\n * @internal\n */\n authorizedPaymentVoided?: AuthorizedPaymentVoided;\n /**\n * Details of an initiated refund process.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n refundInitiated?: RefundInitiated;\n /**\n * Details of a refunded payment.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefunded?: PaymentRefunded;\n /**\n * Details of a failed payment refund.\n *\n * > **Note:** A single `refund_initiated` activity can result in multiple `payment_refunded` or `payment_refund_failed` activities.\n * > In these cases, the `refund_id` will be identical across the activities.\n * @internal\n */\n paymentRefundFailed?: PaymentRefundFailed;\n /**\n * Details of refund to store credit.\n * @internal\n */\n refundedAsStoreCredit?: RefundedAsStoreCredit;\n /** Details of a pending payment */\n paymentPending?: PaymentPending;\n /** Details of a canceled payment */\n paymentCanceled?: PaymentCanceled;\n /** Details of a declined payment */\n paymentDeclined?: PaymentDeclined;\n /** Order pending */\n orderPending?: OrderPending;\n /** Order rejected */\n orderRejected?: OrderRejected;\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 /** Order reject */\n interface OrderPending {\n }\n /** Order reject */\n interface OrderRejected {\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 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 /** @internal */\n ordersExperiments?: OrdersExperiments;\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 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 | null;\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 * Deduct taxes from line items.\n * Used in cases where line items already include taxes.\n * @internal\n */\n deductTaxes?: boolean | 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$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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$3;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision$1[];\n }\n /** @oneof */\n interface CommonAddressStreetOneOf {\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 Subdivision$1 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$1;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 /** 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 | null;\n /** use UTC midnight date to set the due date according to the site time zone */\n dueDate?: Date | null;\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 | null;\n }\n interface LineItems {\n lineItems?: LineItem$2[];\n }\n interface LineItem$2 {\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$2;\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$2 {\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 /**\n * Discount as fixed value. Currently only for internal use.\n * @internal\n */\n fixed?: BigDecimalWrapper;\n /** Discount as percentage value. */\n percentage?: BigDecimalWrapper;\n }\n /** @oneof */\n interface DiscountOneDiscountTypeOneOf {\n /**\n * Discount as fixed value. Currently only for internal use.\n * @internal\n */\n fixed?: BigDecimalWrapper;\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 | null;\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 /**\n * Retrieves metadata for given metasiteID using metasiteReadApi get RPC call\n * Target msid must be provided\n * @param metasiteId - meta site Id for data to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField metasiteId\n * @adminMethod\n */\n function getMetasiteData(metasiteId: string): Promise;\n /**\n * Retrieves orders for given metasiteID using ep-orders internalQueryOrders RPC call\n * Target msid must be provided\n * @param metasiteId - meta site Id for EP orders to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField metasiteId\n * @adminMethod\n */\n function queryOrdersForMetasite(metasiteId: string, options?: QueryOrdersForMetasiteOptions): Promise;\n interface QueryOrdersForMetasiteOptions {\n /** paginated internal orders query request */\n internalQueryOrdersRequest?: InternalQueryOrdersRequest;\n }\n /**\n * Retrieves order for given metasiteId and orderId using ep-orders getOrder RPC call\n * Target msid and orderId must be provided\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.metasiteId\n * @requiredField identifiers.orderId\n * @adminMethod\n */\n function getOrderForMetasite(identifiers: GetOrderForMetasiteIdentifiers): Promise;\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 /**\n * Retrieves order transactions for given metasiteId and orderId using ep-payments listTransactionsForSingleOrder RPC call\n * Target msid and orderId must be provided\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.metasiteId\n * @requiredField identifiers.orderId\n * @adminMethod\n */\n function listOrderTransactionsForMetasite(identifiers: ListOrderTransactionsForMetasiteIdentifiers): Promise;\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 /** @internal\n * @documentationMaturity preview\n * @requiredField metasiteId\n * @permissionId ECOM.REINDEX_ORDERS\n * @adminMethod\n */\n function triggerReindex(metasiteId: string, options?: TriggerReindexOptions): Promise;\n interface TriggerReindexOptions {\n orderIds?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendBuyerConfirmationEmail(orderId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendBuyerPaymentsReceivedEmail(orderId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendBuyerPickupConfirmationEmail(orderId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId ECOM.SEND_ORDER_MAIL\n * @deprecated\n * @targetRemovalDate 2025-03-02\n */\n function bulkSendBuyerPickupConfirmationEmails(options?: BulkSendBuyerPickupConfirmationEmailsOptions): Promise;\n interface BulkSendBuyerPickupConfirmationEmailsOptions {\n /** IDs of orders to send pickup emails for. */\n orderIds?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendBuyerShippingConfirmationEmail(orderId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId ECOM.SEND_ORDER_MAIL\n * @deprecated\n * @targetRemovalDate 2025-03-02\n */\n function bulkSendBuyerShippingConfirmationEmails(options?: BulkSendBuyerShippingConfirmationEmailsOptions): Promise;\n interface BulkSendBuyerShippingConfirmationEmailsOptions {\n /** IDs of orders to send pickup emails for. */\n orderIds?: string[];\n }\n /**\n * this will send notification to merchant via both email and via Notification Hub\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendMerchantOrderReceivedNotification(orderId: string): Promise;\n /** @param orderId - The ID of order that is canceled/refunded\n * @internal\n * @documentationMaturity preview\n * @requiredField options.refundAmount\n * @requiredField options.refundAmount.amount\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendCancelRefundEmail(orderId: string, options?: SendCancelRefundEmailOptions): Promise;\n interface SendCancelRefundEmailOptions {\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund amount */\n refundAmount: Price$3;\n /** Refund ID. (Optional) */\n refundId?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.SEND_ORDER_MAIL\n */\n function sendMerchantOrderReceivedPush(orderId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField emailType\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n * @deprecated\n * @targetRemovalDate 2025-03-02\n */\n function previewEmailByType(emailType: PreviewEmailType): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField options.refundAmount\n * @requiredField options.refundAmount.amount\n * @requiredField orderId\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n */\n function previewRefundEmail(orderId: string, options?: PreviewRefundEmailOptions): Promise;\n interface PreviewRefundEmailOptions {\n /** Refund amount */\n refundAmount: Price$3;\n /** Refund business details */\n details?: RefundDetails$1;\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund ID. (Optional) */\n refundId?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n */\n function previewCancelEmail(orderId: string, options?: PreviewCancelEmailOptions): Promise;\n interface PreviewCancelEmailOptions {\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n */\n function previewCancelRefundEmail(orderId: string, options?: PreviewCancelRefundEmailOptions): Promise;\n interface PreviewCancelRefundEmailOptions {\n /** Personal note added to the email (optional) */\n customMessage?: string | null;\n /** Refund amount */\n refundAmount?: Price$3;\n /** Refund ID. (Optional) */\n refundId?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n */\n function previewBuyerPaymentsReceivedEmail(): Promise;\n /**\n * Deprecated, use PreviewEmailByType with ORDER_PLACED type instead\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n * @deprecated\n */\n function previewBuyerConfirmationEmail(): Promise;\n /**\n * Deprecated, use PreviewEmailByType with ORDER_READY_FOR_PICKUP type instead\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n * @deprecated\n */\n function previewBuyerPickupConfirmationEmail(): Promise;\n /**\n * Deprecated, use PreviewEmailByType with ORDER_SHIPPED type instead\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n * @deprecated\n */\n function previewShippingConfirmationEmail(): Promise;\n /**\n * Deprecated, use PreviewEmailByType with DOWNLOAD_LINKS type instead\n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.VIEW_ORDER_EMAIL_TEMPLATES\n * @adminMethod\n * @deprecated\n */\n function previewResendDownloadLinksEmail(): Promise;\n /**\n * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.\n * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.\n * 2nd step is an actual charge of prepared payment gateway order. This could be done either\n * via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)\n * or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)\n * @param ecomOrderId - Ecom order ID.\n * @param amount - Amount to collect\n * @public\n * @documentationMaturity preview\n * @requiredField amount\n * @requiredField ecomOrderId\n * @permissionId ECOM.COLLECT_PAYMENTS\n * @adminMethod\n */\n function preparePaymentCollection(ecomOrderId: string, amount: Price$3, options?: PreparePaymentCollectionOptions): Promise;\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 * Whether to delay capture of the payment.\n * Default: false\n * @deprecated Whether to delay capture of the payment.\n * Default: false\n * @replacedBy delayed_capture_settings.scheduled_action\n * @targetRemovalDate 2024-09-30\n */\n delayedCapture?: boolean;\n /**\n * Specifies whether payment collection is initiated by Merchant or User of User\n * Default: `true`\n * @internal\n */\n merchantInitiated?: boolean | null;\n /**\n * Redirect urls which are used to return buyer to third party system.\n * @internal\n */\n redirectUrls?: RedirectUrls;\n /** Delayed capture payment settings */\n delayedCaptureSettings?: DelayedCaptureSettings;\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 * @permissionId ECOM.COLLECT_PAYMENTS\n * @adminMethod\n */\n function getPaymentCollectabilityStatus(ecomOrderId: string): Promise;\n /**\n * Records and approves new manual payment with provided custom amount on given order.\n * Existing pending payments are ignored.\n * Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)\n * @param orderId - Order ID.\n * @param amount - Amount to be recorded as approved manual payment for given order\n * @internal\n * @documentationMaturity preview\n * @requiredField amount\n * @requiredField orderId\n * @permissionId ECOM.COLLECT_PAYMENTS\n * @adminMethod\n */\n function recordManuallyCollectedPayment(orderId: string, amount: Price$3): Promise;\n /**\n * Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.\n * In case the order already has an offline payment transaction associated with it\n * (usually when manual payment method is chosen at checkout) - This transaction will become approved.\n * In case the order has no payment transactions associated with it\n * (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction\n * will be created and approved.\n * @param ecomOrderId - Ecom order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function paymentCollectionMarkOrderAsPaid(ecomOrderId: string): Promise;\n /**\n * Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.\n * @param ecomOrderIds - IDs of orders to mark as paid.\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderIds\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds: string[]): Promise;\n /**\n * Checks whether this order can be refunded.\n * @param ecomOrderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @permissionId ECOM.READ_TRANSACTIONS\n * @adminMethod\n */\n function getRefundabilityStatus$1(ecomOrderId: string): Promise;\n /**\n * Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:\n * 1. An explicit amount provided in the request, or;\n * 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.\n * As a result, an ID of the created payment gateway order would be returned.\n * You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).\n * @param ecomOrderId - Ecom order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise;\n interface PaymentCollectionCreatePaymentGatewayOrderOptions {\n /** Information about the user who initiated the payment. */\n chargedBy?: ChargedBy;\n /**\n * Whether to delay capture of the payment.\n *\n * Default: false\n * @internal\n */\n delayedCapture?: boolean;\n }\n /** @param ecomOrderId - Order ID.\n * @param memberId - 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 * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @requiredField memberId\n * @requiredField options.membershipCharges.appId\n * @requiredField options.membershipCharges.catalogReference\n * @requiredField options.membershipCharges.catalogReference.appId\n * @requiredField options.membershipCharges.catalogReference.catalogItemId\n * @requiredField options.membershipCharges.membershipId\n * @requiredField options.membershipCharges.membershipName\n * @requiredField options.membershipCharges.membershipName.original\n * @requiredField options.membershipCharges.rootCatalogItemId\n * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function chargeMemberships(ecomOrderId: string, memberId: string, options?: ChargeMembershipsOptions): Promise;\n interface ChargeMembershipsOptions {\n /** List of items to be paid by memberships */\n membershipCharges?: MembershipChargeItem[];\n }\n /**\n * Calls corresponding payment providers and creates refund transactions for requested payments.\n * Updates order transactions based on refund results.\n * For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and\n * will only update order transactions.\n * @param ecomOrderId - The order this refund related to\n * @param payments - Refund operations information\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @requiredField payments\n * @requiredField payments.paymentId\n * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function triggerRefund$1(ecomOrderId: string, payments: PaymentRefund$1[], options?: TriggerRefundOptions$1): Promise;\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 /**\n * Calculates refundable amount for order items specified in request.\n * @param ecomOrderId - Order ID\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @permissionId ECOM.READ_TRANSACTIONS\n * @adminMethod\n */\n function calculateRefund$1(ecomOrderId: string, options?: CalculateRefundOptions$1): Promise;\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 * Void authorized payments\n * Transaction statuses for related payments will be updated in async way\n * @param ecomOrderId - Wix eCommerce order ID\n * @param paymentIds - Payment IDs\n * @public\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @requiredField paymentIds\n * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT\n * @adminMethod\n */\n function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise;\n /**\n * Capture authorized payments\n * Transaction statuses for related payments will be updated in async way\n * @param ecomOrderId - Wix eCommerce order ID\n * @param payments - Capture payments information\n * @public\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @requiredField payments\n * @requiredField payments.paymentId\n * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT\n * @adminMethod\n */\n function captureAuthorizedPayments(ecomOrderId: string, payments: PaymentCapture[]): Promise;\n /** @param ecomOrderId - Ecom Order ID.\n * @param amount - Amount to be charged\n * @internal\n * @documentationMaturity preview\n * @requiredField amount\n * @requiredField ecomOrderId\n * @permissionId ECOM.ORDER_CHARGE_SAVED_PAYMENT_METHOD\n * @adminMethod\n */\n function chargeSavedPaymentMethod(ecomOrderId: string, amount: Price$3): Promise;\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 * @permissionId ECOM.READ_ORDERS\n * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS\n * @adminMethod\n * @returns Fulfilled - The requested order.\n */\n function getOrder(_id: string): Promise;\n /**\n * \n * Internal query orders endpoint without additional logic to hide INIT orders.\n * Returns a list of up to 100 orders, given the provided paging, filtering and sorting.\n *\n * To learn how to query orders, see\n * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * \n * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.READ_ALL_ORDERS\n * @adminMethod\n */\n function internalQueryOrders(options?: InternalQueryOrdersOptions): Promise;\n interface InternalQueryOrdersOptions {\n /** Query options. */\n query?: PlatformQuery;\n }\n /**\n * > **Note:** Use SearchOrders instead\n * Retrieves a list of orders, given the provided paging, filtering, and sorting.\n *\n *\n * Query Orders runs with these defaults, which you can override:\n *\n * - `createdDate` is sorted in `DESC` order\n * - `paging.limit` is `100`\n * - `paging.offset` is `0`\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/filter-and-sort).\n *\n * To learn about working with _Query_ 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 * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.READ_ORDERS\n * @adminMethod\n * @deprecated\n * @replacedBy com.wix.ecom.orders.v1.Orders.SearchOrders\n * @targetRemovalDate 2025-03-02\n */\n function queryOrders(): OrdersQueryBuilder;\n interface QueryCursorResult$7 {\n cursors: Cursors$7;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OrdersQueryResult extends QueryCursorResult$7 {\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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name', 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name', 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' | 'purchasedDate', 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' | 'purchasedDate', 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' | 'purchasedDate', 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' | 'purchasedDate', 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'businessLocation.id' | 'businessLocation.name', 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name', 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name', 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name', 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name'>) => 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' | 'balanceSummary.authorized.amount' | 'balanceSummary.pendingRefund.amount' | 'balanceSummary.pending.amount' | 'purchasedDate' | 'businessLocation.id' | 'businessLocation.name'>) => 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 * @permissionId ECOM.READ_ORDERS\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 * @permissionId ECOM.CREATE_ORDERS\n * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS\n * @adminMethod\n * @returns Newly created order.\n */\n function createOrder(order: Order$1, options?: CreateOrderOptions): Promise;\n interface CreateOrderOptions {\n /**\n * Determine order lifecycle\n * @internal\n */\n settings?: OrderCreationSettings;\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 * @permissionId ECOM.MODIFY_ORDERS\n * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS\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 | null;\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 | null;\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$3;\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$1;\n /** Billing address and contact details. */\n billingInfo?: AddressWithContact;\n /** Shipping info and selected shipping option details. */\n shippingInfo?: ShippingInformation$1;\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$1;\n /** Tax information. */\n taxInfo?: OrderTaxInfo;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount$1[];\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 * Cart ID - required by TYP OOI for legacy orders.\n * @internal\n */\n cartId?: string | null;\n /**\n * Private API flag that allows using read-only \"id\" during order creation.\n * @internal\n */\n isInternalOrderCreate?: boolean;\n /**\n * Pay now price summary. Part of price_summary that must be payed at checkout\n * @internal\n * @readonly\n */\n payNow?: PriceSummary$1;\n /**\n * Balance summary.\n * @readonly\n */\n balanceSummary?: BalanceSummary;\n /** Additional fees applied to the order. */\n additionalFees?: AdditionalFee$1[];\n /**\n * Custom string status values aggregated from every fulfillment entity associated with current order\n * @internal\n * @readonly\n */\n fulfillmentStatusesAggregate?: FulfillmentStatusesAggregate;\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 app dashboard before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields$4;\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 * Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable.\n * @internal\n */\n tags?: Tags;\n /**\n * Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\n * Used for migration from external systems.\n */\n purchasedDate?: Date | null;\n /**\n * Order Location\n * @internal\n */\n businessLocation?: Location;\n }\n interface UpdateOrderOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\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 * @permissionId ECOM.MODIFY_ORDERS\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 /** @param _id - Order id to be updated\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.changes\n * @requiredField options.changes.priceSummary.subtotal\n * @requiredField options.changes.priceSummary.total\n * @permissionId ECOM.ORDERS_DELTAS_COMMIT\n * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS\n * @adminMethod\n */\n function commitDeltas(_id: string, options?: CommitDeltasOptions): Promise;\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 /**\n * Archives an order. `order.archived` field changes to `true`.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function archiveOrder(_id: string): Promise;\n /**\n * Archives multiple orders. `order.archived` field changes to `true`.\n * @param ids - IDs of orders to archive.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkArchiveOrders(ids: string[], options?: BulkArchiveOrdersOptions): Promise;\n interface BulkArchiveOrdersOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Archives multiple orders, selected by filter. `order.archived` field changes to `true`.\n * @param filter - Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkArchiveOrdersByFilter(filter: Record | null): Promise;\n /**\n * Unarchives an order. `order.archived` field changes to `false`.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function unArchiveOrder(_id: string): Promise;\n /**\n * Unarchives multiple orders. `order.archived` field changes to `false`.\n * @param ids - IDs or orders to unarchive.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkUnArchiveOrders(ids: string[], options?: BulkUnArchiveOrdersOptions): Promise;\n interface BulkUnArchiveOrdersOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Unarchives multiple orders, selected by filter. `order.archived` field changes to `false`.\n * @param filter - Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkUnArchiveOrdersByFilter(filter: Record | null): Promise;\n /**\n * Updates an order's contact ID and/or email.\n * > **Note:** Neither `email`, nor `contactId` can be removed, only updated.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function updateBuyerInfo(_id: string, options?: UpdateBuyerInfoOptions): Promise;\n interface UpdateBuyerInfoOptions {\n /**\n * Field mask of buyerInfo fields to update.\n * @internal\n */\n fieldMask?: string[];\n /** Buyer info. */\n buyerInfo?: BuyerInfoUpdate;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n * @deprecated\n * @targetRemovalDate 2023-09-25\n */\n function updateBuyerEmail(_id: string, options?: UpdateBuyerEmailOptions): Promise;\n interface UpdateBuyerEmailOptions {\n email?: string | null;\n }\n /**\n * Updates an order's shipping address and/or contact details.\n * > **Notes:**\n * > + Original order must have existing address to update - `order.shippingInfo.logistics.shippingDestination.address` must have existing value.\n * > + Neither `address`, nor `contactDetails` can be removed, only updated.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.shippingAddress\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function updateOrderShippingAddress(_id: string, options?: UpdateOrderShippingAddressOptions): Promise;\n interface UpdateOrderShippingAddressOptions {\n /**\n * mask of shipping address fields to update\n * @internal\n */\n fieldMask?: string[];\n /** Shipping address and contact details to be updated. */\n shippingAddress: AddressWithContact;\n }\n /**\n * Updates an order's billing contact details.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function updateBillingContactDetails(_id: string, options?: UpdateBillingContactDetailsOptions): Promise;\n interface UpdateBillingContactDetailsOptions {\n /**\n * mask of contact details fields to update\n * @internal\n */\n fieldMask?: string[];\n /** Contact details. */\n addressContactDetails?: FullAddressContactDetails$1;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.id\n * @requiredField identifiers.lineItemId\n * @requiredField lineItem\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n * @deprecated\n * @targetRemovalDate 2024-02-15\n */\n function updateOrderLineItem(identifiers: UpdateOrderLineItemIdentifiers, lineItem: UpdateOrderLineItem, options?: UpdateOrderLineItemOptions): Promise;\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. Optional for custom line items, which don't trigger the Catalog service plugin. */\n catalogReference?: CatalogReference$3;\n /** Line item quantity. */\n quantity?: number;\n /**\n * Total discount for this line item's entire quantity.\n * @readonly\n */\n totalDiscount?: Price$3;\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$2;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType$1;\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 /** Number of items that were refunded. */\n refundQuantity?: number | null;\n /** Number of items restocked. */\n restockQuantity?: number | null;\n /** Line item price after line item discounts for display purposes. */\n price?: Price$3;\n /**\n * Line item price before line item discounts for display purposes. Defaults to `price` when not provided.\n * @readonly\n */\n priceBeforeDiscounts?: Price$3;\n /**\n * Total price after discounts, and before tax.\n * @readonly\n */\n totalPriceBeforeTax?: Price$3;\n /**\n * Total price after all discounts and tax.\n * @readonly\n */\n totalPriceAfterTax?: Price$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. Eligible for catalog items with type `DEPOSIT_ONLINE` only.\n */\n paymentOption?: PaymentOptionType$1;\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$1;\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$3;\n /**\n * The Item's Delivery Profile Id\n * @internal\n */\n deliveryProfileId?: string | null;\n /** @internal */\n shippingGroupId?: string | null;\n /**\n * Source locations for this line item. The location's total quantity must not exceed the line item quantity.\n * @internal\n */\n locations?: LocationAndQuantity[];\n /**\n * Total price **after** catalog discounts and line item discounts.\n * @internal\n */\n lineItemPrice?: Price$3;\n /**\n * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.\n * @internal\n * @readonly\n */\n customLineItem?: boolean | null;\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 * @internal\n * @readonly\n */\n rootCatalogItemId?: string | null;\n /**\n * Address used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress$1;\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: boolean;\n /**\n * Custom extended fields for the line item 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 * @internal\n */\n extendedFields?: ExtendedFields$4;\n }\n interface UpdateOrderLineItemOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Updates multiple items of an order.\n * Currently, the following fields can be updated:\n * + `lineItem.productName`\n * + `lineItem.descriptionLines` (full replacement)\n * + `lineItem.digitalFile`\n * + `lineItem.priceDescription`\n * @param orderId - Order ID\n * @param lineItems - Order line items to update\n * @internal\n * @documentationMaturity preview\n * @requiredField lineItems\n * @requiredField lineItems.lineItem\n * @requiredField lineItems.lineItem._id\n * @requiredField orderId\n * @permissionId ECOM.MODIFY_ORDERS\n * @permissionId ECOM.ORDER_MODIFY_DIGITAL_FILE\n * @adminMethod\n */\n function updateOrderLineItems(orderId: string, lineItems: MaskedOrderLineItem[]): Promise;\n /** @param _id - Order ID.\n * @param activity - Activity info.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField activity\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function addInternalActivity(_id: string, activity: InternalActivity): Promise;\n /**\n * Adds a merchant comment to an order.\n * > **Note:** Activities with type CustomActivity not supported\n * @param _id - Order ID.\n * @param activity - Activity info.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField activity\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n * @deprecated\n * @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities\n * @targetRemovalDate 2024-11-01\n */\n function addActivity(_id: string, activity: PublicActivity): Promise;\n /**\n * Adds merchant comments to an order.\n * > **Note:** Activities with type CustomActivity not supported\n * @param orderId - Order ID.\n * @param activities - Activities to add.\n * @internal\n * @documentationMaturity preview\n * @requiredField activities\n * @requiredField orderId\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function addActivities(orderId: string, activities: PublicActivity[]): Promise;\n /**\n * Updates an order's activity.\n * @param activity - Activity info.\n * @internal\n * @documentationMaturity preview\n * @requiredField activity\n * @requiredField identifiers\n * @requiredField identifiers.activityId\n * @requiredField identifiers.id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function updateActivity(identifiers: UpdateActivityIdentifiers, activity: PublicActivity): Promise;\n interface UpdateActivityIdentifiers {\n /** Order ID. */\n _id: string;\n /** ID of the activity to update. */\n activityId: string;\n }\n /**\n * Delete's an order's activity.\n *\n * Only custom activities and merchant comments can be deleted.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.activityId\n * @requiredField identifiers.id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function deleteActivity(identifiers: DeleteActivityIdentifiers): Promise;\n interface DeleteActivityIdentifiers {\n /** Order ID. */\n _id: string;\n /** ID of the activity to delete. */\n activityId: string;\n }\n /**\n * Updates an order's line item descriptions.\n * @param _id - Order ID.\n * @param lineItems - Line items.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField lineItems\n * @requiredField lineItems.descriptionLines.name\n * @requiredField lineItems.lineItemId\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function updateLineItemsDescriptionLines(_id: string, lineItems: LineItemUpdate[]): Promise;\n /**\n * Marks an order as read in the dashboard. `order.seenByAHuman` field changes to `true`.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function markOrderAsSeenByHuman(_id: string): Promise;\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 * @permissionId ECOM.MODIFY_ORDERS\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 /**\n * Marks an order as fulfilled. `order.fulfillmentStatus` field changes to `FULFILLED`.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function markAsFulfilled(_id: string): Promise;\n /**\n * Marks multiple orders as fulfilled. `order.fulfillmentStatus` field changes to `FULFILLED`.\n * @param ids - IDs of orders to be marked as fulfilled.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkMarkAsFulfilled(ids: string[], options?: BulkMarkAsFulfilledOptions): Promise;\n interface BulkMarkAsFulfilledOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Marks multiple orders as fulfilled, selected by filter. `order.fulfillmentStatus` field changes to `FULFILLED`.\n * @param filter - Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkMarkAsFulfilledByFilter(filter: Record | null): Promise;\n /**\n * Marks an order as not fulfilled. `order.fulfillmentStatus` field changes to `NOT_FULFILLED`.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function markAsUnfulfilled(_id: string): Promise;\n /**\n * Marks multiple orders as not fulfilled. `order.fulfillmentStatus` field changes to `NOT_FULFILLED`.\n * @param ids - IDs of orders to be marked as not fulfilled.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkMarkAsUnfulfilled(ids: string[], options?: BulkMarkAsUnfulfilledOptions): Promise;\n interface BulkMarkAsUnfulfilledOptions {\n /** Whether to return the full updated order entities in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Marks multiple orders as not fulfilled, selected by filter. `order.fulfillmentStatus` field changes to `NOT_FULFILLED`.\n * @param filter - Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/ecommerce/orders/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId ECOM.MODIFY_FULFILLMENTS\n * @adminMethod\n */\n function bulkMarkAsUnfulfilledByFilter(filter: Record | null): Promise;\n /**\n * Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.\n * In case the order already has an offline payment transaction associated with it (usually when manual payment method is chosen at checkout) - This transaction will become approved.\n * In case the order has no payment transactions associated with it (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction will be created and approved.\n * @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function markOrderAsPaid(_id: string): Promise;\n /**\n * Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.\n * @param ids - IDs of orders to mark as paid.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkMarkOrdersAsPaid(ids: string[]): Promise;\n /**\n * Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:\n * 1. An explicit amount provided in the request, or;\n * 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.\n * As a result, an ID of the created payment gateway order would be returned.\n * You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).\n * @param ecomOrderId - eCom Order ID\n * @internal\n * @documentationMaturity preview\n * @requiredField ecomOrderId\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function createPaymentGatewayOrder(ecomOrderId: string): Promise;\n /**\n * returns shipping label ids - temporarily until fully modeled in fulfillments service\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ECOM.READ_ORDERS\n * @adminMethod\n * @deprecated\n * @targetRemovalDate 2023-05-15\n */\n function getShipments(_id: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField options.aggregation\n * @permissionId ECOM.READ_ORDERS\n * @adminMethod\n */\n function aggregateOrders(options?: AggregateOrdersOptions): Promise;\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 /**\n * Restock items on order - temporary solution for POS\n * @param _id - Order ID\n * @param decrementData - Which items to decrement, and how much to decrement from each one\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField decrementData\n * @permissionId ECOM.MODIFY_ORDERS\n * @adminMethod\n */\n function decrementItemsQuantity(_id: string, decrementData: DecrementData[]): Promise;\n /**\n * Synchronously update tags on multiple orders, by list of order ids\n * A tag that appears both in the list of assign and unassign tags, will be assigned\n * @param orderIds - IDs of orders to update tags for.\n * @public\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionId ECOM.MODIFY_ORDERS\n * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS\n * @adminMethod\n */\n function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise;\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 \n type ecomV1Order_universal_d_OrderLineItem = OrderLineItem;\n type ecomV1Order_universal_d_ProductName = ProductName;\n type ecomV1Order_universal_d_DescriptionLine = DescriptionLine;\n type ecomV1Order_universal_d_DescriptionLineValueOneOf = DescriptionLineValueOneOf;\n type ecomV1Order_universal_d_DescriptionLineDescriptionLineValueOneOf = DescriptionLineDescriptionLineValueOneOf;\n type ecomV1Order_universal_d_DescriptionLineName = DescriptionLineName;\n type ecomV1Order_universal_d_PlainTextValue = PlainTextValue;\n type ecomV1Order_universal_d_Color = Color;\n type ecomV1Order_universal_d_DescriptionLineType = DescriptionLineType;\n const ecomV1Order_universal_d_DescriptionLineType: typeof DescriptionLineType;\n type ecomV1Order_universal_d_FocalPoint = FocalPoint;\n type ecomV1Order_universal_d_LineItemTaxInfo = LineItemTaxInfo;\n type ecomV1Order_universal_d_LineItemTaxBreakdown = LineItemTaxBreakdown;\n type ecomV1Order_universal_d_PriceDescription = PriceDescription;\n type ecomV1Order_universal_d_LocationAndQuantity = LocationAndQuantity;\n type ecomV1Order_universal_d_BuyerInfoIdOneOf = BuyerInfoIdOneOf;\n type ecomV1Order_universal_d_AddressWithContact = AddressWithContact;\n type ecomV1Order_universal_d_DeliveryLogisticsAddressOneOf = DeliveryLogisticsAddressOneOf;\n type ecomV1Order_universal_d_OrderStatus = OrderStatus;\n const ecomV1Order_universal_d_OrderStatus: typeof OrderStatus;\n type ecomV1Order_universal_d_OrderTaxInfo = OrderTaxInfo;\n type ecomV1Order_universal_d_OrderTaxBreakdown = OrderTaxBreakdown;\n type ecomV1Order_universal_d_MerchantDiscountMerchantDiscountReasonOneOf = MerchantDiscountMerchantDiscountReasonOneOf;\n type ecomV1Order_universal_d_DiscountReason = DiscountReason;\n const ecomV1Order_universal_d_DiscountReason: typeof DiscountReason;\n type ecomV1Order_universal_d_ActivityContentOneOf = ActivityContentOneOf;\n type ecomV1Order_universal_d_CustomActivity = CustomActivity;\n type ecomV1Order_universal_d_MerchantComment = MerchantComment;\n type ecomV1Order_universal_d_OrderCreatedFromExchange = OrderCreatedFromExchange;\n type ecomV1Order_universal_d_NewExchangeOrderCreated = NewExchangeOrderCreated;\n type ecomV1Order_universal_d_LineItemExchangeData = LineItemExchangeData;\n type ecomV1Order_universal_d_DraftOrderChangesApplied = DraftOrderChangesApplied;\n type ecomV1Order_universal_d_OrderChange = OrderChange;\n type ecomV1Order_universal_d_OrderChangeValueOneOf = OrderChangeValueOneOf;\n type ecomV1Order_universal_d_LineItemChanges = LineItemChanges;\n type ecomV1Order_universal_d_LineItemQuantityChange = LineItemQuantityChange;\n type ecomV1Order_universal_d_LineItemQuantityChangeType = LineItemQuantityChangeType;\n const ecomV1Order_universal_d_LineItemQuantityChangeType: typeof LineItemQuantityChangeType;\n type ecomV1Order_universal_d_LineItemPriceChange = LineItemPriceChange;\n type ecomV1Order_universal_d_ManagedLineItem = ManagedLineItem;\n type ecomV1Order_universal_d_ManagedDiscount = ManagedDiscount;\n type ecomV1Order_universal_d_TranslatedValue = TranslatedValue;\n type ecomV1Order_universal_d_LineItemAmount = LineItemAmount;\n type ecomV1Order_universal_d_ManagedAdditionalFee = ManagedAdditionalFee;\n type ecomV1Order_universal_d_TotalPriceChange = TotalPriceChange;\n type ecomV1Order_universal_d_ShippingInformationChange = ShippingInformationChange;\n type ecomV1Order_universal_d_ShippingInformationChangeShippingInformation = ShippingInformationChangeShippingInformation;\n type ecomV1Order_universal_d_SavedPaymentMethod = SavedPaymentMethod;\n type ecomV1Order_universal_d_AuthorizedPaymentCreated = AuthorizedPaymentCreated;\n type ecomV1Order_universal_d_AuthorizedPaymentCaptured = AuthorizedPaymentCaptured;\n type ecomV1Order_universal_d_AuthorizedPaymentVoided = AuthorizedPaymentVoided;\n type ecomV1Order_universal_d_RefundInitiated = RefundInitiated;\n type ecomV1Order_universal_d_RefundedPayment = RefundedPayment;\n type ecomV1Order_universal_d_RefundedPaymentKindOneOf = RefundedPaymentKindOneOf;\n type ecomV1Order_universal_d_RegularPaymentRefund = RegularPaymentRefund;\n type ecomV1Order_universal_d_GiftCardPaymentRefund = GiftCardPaymentRefund;\n type ecomV1Order_universal_d_MembershipPaymentRefund = MembershipPaymentRefund;\n type ecomV1Order_universal_d_PaymentRefunded = PaymentRefunded;\n type ecomV1Order_universal_d_PaymentRefundFailed = PaymentRefundFailed;\n type ecomV1Order_universal_d_RefundedAsStoreCredit = RefundedAsStoreCredit;\n type ecomV1Order_universal_d_PaymentPending = PaymentPending;\n type ecomV1Order_universal_d_PaymentPendingPaymentDetailsOneOf = PaymentPendingPaymentDetailsOneOf;\n type ecomV1Order_universal_d_RegularPayment = RegularPayment;\n type ecomV1Order_universal_d_RegularPaymentPaymentMethodDetailsOneOf = RegularPaymentPaymentMethodDetailsOneOf;\n type ecomV1Order_universal_d_CreditCardDetails = CreditCardDetails;\n type ecomV1Order_universal_d_PaymentCanceled = PaymentCanceled;\n type ecomV1Order_universal_d_PaymentCanceledPaymentDetailsOneOf = PaymentCanceledPaymentDetailsOneOf;\n type ecomV1Order_universal_d_PaymentDeclined = PaymentDeclined;\n type ecomV1Order_universal_d_PaymentDeclinedPaymentDetailsOneOf = PaymentDeclinedPaymentDetailsOneOf;\n type ecomV1Order_universal_d_AttributionSource = AttributionSource;\n const ecomV1Order_universal_d_AttributionSource: typeof AttributionSource;\n type ecomV1Order_universal_d_CreatedBy = CreatedBy;\n type ecomV1Order_universal_d_CreatedByStringOneOf = CreatedByStringOneOf;\n type ecomV1Order_universal_d_BalanceSummary = BalanceSummary;\n type ecomV1Order_universal_d_Balance = Balance;\n type ecomV1Order_universal_d_FulfillmentStatusesAggregate = FulfillmentStatusesAggregate;\n type ecomV1Order_universal_d_Tags = Tags;\n type ecomV1Order_universal_d_TagList = TagList;\n type ecomV1Order_universal_d_Location = Location;\n type ecomV1Order_universal_d_TriggerReindexOrderRequest = TriggerReindexOrderRequest;\n type ecomV1Order_universal_d_PaymentStatusUpdated = PaymentStatusUpdated;\n type ecomV1Order_universal_d_OrderRejectedEventOrderRejected = OrderRejectedEventOrderRejected;\n type ecomV1Order_universal_d_OrderItemsRestocked = OrderItemsRestocked;\n type ecomV1Order_universal_d_V1RestockItem = V1RestockItem;\n type ecomV1Order_universal_d_GetMetasiteDataRequest = GetMetasiteDataRequest;\n type ecomV1Order_universal_d_GetMetasiteDataResponse = GetMetasiteDataResponse;\n type ecomV1Order_universal_d_MetaSite = MetaSite;\n type ecomV1Order_universal_d_App = App;\n type ecomV1Order_universal_d_State = State;\n const ecomV1Order_universal_d_State: typeof State;\n type ecomV1Order_universal_d_Namespace = Namespace;\n const ecomV1Order_universal_d_Namespace: typeof Namespace;\n type ecomV1Order_universal_d_SeoData = SeoData;\n type ecomV1Order_universal_d_MetaTag = MetaTag;\n type ecomV1Order_universal_d_HtmlApplication = HtmlApplication;\n type ecomV1Order_universal_d_ExternalUriMapping = ExternalUriMapping;\n type ecomV1Order_universal_d_UserDataResponse = UserDataResponse;\n type ecomV1Order_universal_d_QueryOrdersForMetasiteRequest = QueryOrdersForMetasiteRequest;\n type ecomV1Order_universal_d_InternalQueryOrdersRequest = InternalQueryOrdersRequest;\n type ecomV1Order_universal_d_PlatformQuery = PlatformQuery;\n type ecomV1Order_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type ecomV1Order_universal_d_PlatformPaging = PlatformPaging;\n type ecomV1Order_universal_d_QueryOrdersForMetasiteResponse = QueryOrdersForMetasiteResponse;\n type ecomV1Order_universal_d_PlatformPagingMetadata = PlatformPagingMetadata;\n type ecomV1Order_universal_d_GetOrderForMetasiteRequest = GetOrderForMetasiteRequest;\n type ecomV1Order_universal_d_GetOrderForMetasiteResponse = GetOrderForMetasiteResponse;\n type ecomV1Order_universal_d_ListOrderTransactionsForMetasiteRequest = ListOrderTransactionsForMetasiteRequest;\n type ecomV1Order_universal_d_ListOrderTransactionsForMetasiteResponse = ListOrderTransactionsForMetasiteResponse;\n type ecomV1Order_universal_d_V1LineItemRefund = V1LineItemRefund;\n type ecomV1Order_universal_d_V1AdditionalFeeRefund = V1AdditionalFeeRefund;\n type ecomV1Order_universal_d_V1ShippingRefund = V1ShippingRefund;\n type ecomV1Order_universal_d_UpsertRefundRequest = UpsertRefundRequest;\n type ecomV1Order_universal_d_UpsertRefundResponse = UpsertRefundResponse;\n type ecomV1Order_universal_d_UpdateInternalDocumentsEvent = UpdateInternalDocumentsEvent;\n type ecomV1Order_universal_d_UpdateInternalDocumentsEventOperationOneOf = UpdateInternalDocumentsEventOperationOneOf;\n type ecomV1Order_universal_d_InternalDocument = InternalDocument;\n type ecomV1Order_universal_d_InternalDocumentUpdateOperation = InternalDocumentUpdateOperation;\n type ecomV1Order_universal_d_DeleteByIdsOperation = DeleteByIdsOperation;\n type ecomV1Order_universal_d_DeleteByFilterOperation = DeleteByFilterOperation;\n type ecomV1Order_universal_d_InternalDocumentUpdateByFilterOperation = InternalDocumentUpdateByFilterOperation;\n type ecomV1Order_universal_d_InternalUpdateExistingOperation = InternalUpdateExistingOperation;\n type ecomV1Order_universal_d_VersionedDocumentUpdateOperation = VersionedDocumentUpdateOperation;\n type ecomV1Order_universal_d_VersioningMode = VersioningMode;\n const ecomV1Order_universal_d_VersioningMode: typeof VersioningMode;\n type ecomV1Order_universal_d_VersionedDeleteByIdsOperation = VersionedDeleteByIdsOperation;\n type ecomV1Order_universal_d_VersionedDocumentId = VersionedDocumentId;\n type ecomV1Order_universal_d_TriggerReindexRequest = TriggerReindexRequest;\n type ecomV1Order_universal_d_TriggerReindexResponse = TriggerReindexResponse;\n type ecomV1Order_universal_d_BatchOfTriggerReindexOrderRequest = BatchOfTriggerReindexOrderRequest;\n type ecomV1Order_universal_d_SendBuyerConfirmationEmailRequest = SendBuyerConfirmationEmailRequest;\n type ecomV1Order_universal_d_SendBuyerConfirmationEmailResponse = SendBuyerConfirmationEmailResponse;\n type ecomV1Order_universal_d_SendBuyerPaymentsReceivedEmailRequest = SendBuyerPaymentsReceivedEmailRequest;\n type ecomV1Order_universal_d_SendBuyerPaymentsReceivedEmailResponse = SendBuyerPaymentsReceivedEmailResponse;\n type ecomV1Order_universal_d_SendBuyerPickupConfirmationEmailRequest = SendBuyerPickupConfirmationEmailRequest;\n type ecomV1Order_universal_d_SendBuyerPickupConfirmationEmailResponse = SendBuyerPickupConfirmationEmailResponse;\n type ecomV1Order_universal_d_BulkSendBuyerPickupConfirmationEmailsRequest = BulkSendBuyerPickupConfirmationEmailsRequest;\n type ecomV1Order_universal_d_BulkSendBuyerPickupConfirmationEmailsResponse = BulkSendBuyerPickupConfirmationEmailsResponse;\n type ecomV1Order_universal_d_SendBuyerShippingConfirmationEmailRequest = SendBuyerShippingConfirmationEmailRequest;\n type ecomV1Order_universal_d_SendBuyerShippingConfirmationEmailResponse = SendBuyerShippingConfirmationEmailResponse;\n type ecomV1Order_universal_d_BulkSendBuyerShippingConfirmationEmailsRequest = BulkSendBuyerShippingConfirmationEmailsRequest;\n type ecomV1Order_universal_d_BulkSendBuyerShippingConfirmationEmailsResponse = BulkSendBuyerShippingConfirmationEmailsResponse;\n type ecomV1Order_universal_d_SendMerchantOrderReceivedNotificationRequest = SendMerchantOrderReceivedNotificationRequest;\n type ecomV1Order_universal_d_SendMerchantOrderReceivedNotificationResponse = SendMerchantOrderReceivedNotificationResponse;\n type ecomV1Order_universal_d_SendCancelRefundEmailRequest = SendCancelRefundEmailRequest;\n type ecomV1Order_universal_d_SendCancelRefundEmailResponse = SendCancelRefundEmailResponse;\n type ecomV1Order_universal_d_SendRefundEmailRequest = SendRefundEmailRequest;\n type ecomV1Order_universal_d_SendRefundEmailResponse = SendRefundEmailResponse;\n type ecomV1Order_universal_d_SendMerchantOrderReceivedPushRequest = SendMerchantOrderReceivedPushRequest;\n type ecomV1Order_universal_d_SendMerchantOrderReceivedPushResponse = SendMerchantOrderReceivedPushResponse;\n type ecomV1Order_universal_d_PreviewEmailByTypeRequest = PreviewEmailByTypeRequest;\n type ecomV1Order_universal_d_PreviewEmailType = PreviewEmailType;\n const ecomV1Order_universal_d_PreviewEmailType: typeof PreviewEmailType;\n type ecomV1Order_universal_d_PreviewEmailByTypeResponse = PreviewEmailByTypeResponse;\n type ecomV1Order_universal_d_PreviewRefundEmailRequest = PreviewRefundEmailRequest;\n type ecomV1Order_universal_d_PreviewRefundEmailResponse = PreviewRefundEmailResponse;\n type ecomV1Order_universal_d_PreviewCancelEmailRequest = PreviewCancelEmailRequest;\n type ecomV1Order_universal_d_PreviewCancelEmailResponse = PreviewCancelEmailResponse;\n type ecomV1Order_universal_d_PreviewCancelRefundEmailRequest = PreviewCancelRefundEmailRequest;\n type ecomV1Order_universal_d_PreviewCancelRefundEmailResponse = PreviewCancelRefundEmailResponse;\n type ecomV1Order_universal_d_PreviewBuyerPaymentsReceivedEmailRequest = PreviewBuyerPaymentsReceivedEmailRequest;\n type ecomV1Order_universal_d_PreviewBuyerPaymentsReceivedEmailResponse = PreviewBuyerPaymentsReceivedEmailResponse;\n type ecomV1Order_universal_d_PreviewBuyerConfirmationEmailRequest = PreviewBuyerConfirmationEmailRequest;\n type ecomV1Order_universal_d_PreviewBuyerConfirmationEmailResponse = PreviewBuyerConfirmationEmailResponse;\n type ecomV1Order_universal_d_PreviewBuyerPickupConfirmationEmailRequest = PreviewBuyerPickupConfirmationEmailRequest;\n type ecomV1Order_universal_d_PreviewBuyerPickupConfirmationEmailResponse = PreviewBuyerPickupConfirmationEmailResponse;\n type ecomV1Order_universal_d_PreviewShippingConfirmationEmailRequest = PreviewShippingConfirmationEmailRequest;\n type ecomV1Order_universal_d_PreviewShippingConfirmationEmailResponse = PreviewShippingConfirmationEmailResponse;\n type ecomV1Order_universal_d_PreviewResendDownloadLinksEmailRequest = PreviewResendDownloadLinksEmailRequest;\n type ecomV1Order_universal_d_PreviewResendDownloadLinksEmailResponse = PreviewResendDownloadLinksEmailResponse;\n type ecomV1Order_universal_d_PreparePaymentCollectionRequest = PreparePaymentCollectionRequest;\n type ecomV1Order_universal_d_RedirectUrls = RedirectUrls;\n type ecomV1Order_universal_d_DelayedCaptureSettings = DelayedCaptureSettings;\n type ecomV1Order_universal_d_DelayedCaptureSettingsScheduledAction = DelayedCaptureSettingsScheduledAction;\n const ecomV1Order_universal_d_DelayedCaptureSettingsScheduledAction: typeof DelayedCaptureSettingsScheduledAction;\n type ecomV1Order_universal_d_Duration = Duration;\n type ecomV1Order_universal_d_DurationUnit = DurationUnit;\n const ecomV1Order_universal_d_DurationUnit: typeof DurationUnit;\n type ecomV1Order_universal_d_PreparePaymentCollectionResponse = PreparePaymentCollectionResponse;\n type ecomV1Order_universal_d_GetPaymentCollectabilityStatusRequest = GetPaymentCollectabilityStatusRequest;\n type ecomV1Order_universal_d_GetPaymentCollectabilityStatusResponse = GetPaymentCollectabilityStatusResponse;\n type ecomV1Order_universal_d_PaymentCollectabilityStatus = PaymentCollectabilityStatus;\n const ecomV1Order_universal_d_PaymentCollectabilityStatus: typeof PaymentCollectabilityStatus;\n type ecomV1Order_universal_d_RecordManuallyCollectedPaymentRequest = RecordManuallyCollectedPaymentRequest;\n type ecomV1Order_universal_d_RecordManuallyCollectedPaymentResponse = RecordManuallyCollectedPaymentResponse;\n type ecomV1Order_universal_d_MarkOrderAsPaidRequest = MarkOrderAsPaidRequest;\n type ecomV1Order_universal_d_MarkOrderAsPaidResponse = MarkOrderAsPaidResponse;\n type ecomV1Order_universal_d_BulkMarkOrdersAsPaidRequest = BulkMarkOrdersAsPaidRequest;\n type ecomV1Order_universal_d_BulkMarkOrdersAsPaidResponse = BulkMarkOrdersAsPaidResponse;\n type ecomV1Order_universal_d_BulkOrderResult = BulkOrderResult;\n type ecomV1Order_universal_d_CreatePaymentGatewayOrderRequest = CreatePaymentGatewayOrderRequest;\n type ecomV1Order_universal_d_ChargedBy = ChargedBy;\n type ecomV1Order_universal_d_CreatePaymentGatewayOrderResponse = CreatePaymentGatewayOrderResponse;\n type ecomV1Order_universal_d_ChargeMembershipsRequest = ChargeMembershipsRequest;\n type ecomV1Order_universal_d_MembershipChargeItem = MembershipChargeItem;\n type ecomV1Order_universal_d_ChargeMembershipsResponse = ChargeMembershipsResponse;\n type ecomV1Order_universal_d_VoidAuthorizedPaymentsRequest = VoidAuthorizedPaymentsRequest;\n type ecomV1Order_universal_d_VoidAuthorizedPaymentsResponse = VoidAuthorizedPaymentsResponse;\n type ecomV1Order_universal_d_CaptureAuthorizedPaymentsRequest = CaptureAuthorizedPaymentsRequest;\n type ecomV1Order_universal_d_PaymentCapture = PaymentCapture;\n type ecomV1Order_universal_d_CaptureAuthorizedPaymentsResponse = CaptureAuthorizedPaymentsResponse;\n type ecomV1Order_universal_d_ChargeSavedPaymentMethodRequest = ChargeSavedPaymentMethodRequest;\n type ecomV1Order_universal_d_ChargeSavedPaymentMethodResponse = ChargeSavedPaymentMethodResponse;\n type ecomV1Order_universal_d_ContinueSideEffectsFlowInLegacyData = ContinueSideEffectsFlowInLegacyData;\n type ecomV1Order_universal_d_OrdersExperiments = OrdersExperiments;\n type ecomV1Order_universal_d_GetOrderRequest = GetOrderRequest;\n type ecomV1Order_universal_d_GetOrderResponse = GetOrderResponse;\n type ecomV1Order_universal_d_InternalQueryOrdersResponse = InternalQueryOrdersResponse;\n type ecomV1Order_universal_d_QueryOrderRequest = QueryOrderRequest;\n type ecomV1Order_universal_d_QueryOrderResponse = QueryOrderResponse;\n type ecomV1Order_universal_d_SearchOrdersRequest = SearchOrdersRequest;\n type ecomV1Order_universal_d_CursorSearch = CursorSearch;\n type ecomV1Order_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type ecomV1Order_universal_d_SearchOrdersResponse = SearchOrdersResponse;\n type ecomV1Order_universal_d_CreateOrderRequest = CreateOrderRequest;\n type ecomV1Order_universal_d_OrderCreationSettings = OrderCreationSettings;\n type ecomV1Order_universal_d_OrderApprovalStrategy = OrderApprovalStrategy;\n const ecomV1Order_universal_d_OrderApprovalStrategy: typeof OrderApprovalStrategy;\n type ecomV1Order_universal_d_OrderCreateNotifications = OrderCreateNotifications;\n type ecomV1Order_universal_d_CreateOrderResponse = CreateOrderResponse;\n type ecomV1Order_universal_d_UpdateOrderRequest = UpdateOrderRequest;\n type ecomV1Order_universal_d_UpdateOrderResponse = UpdateOrderResponse;\n type ecomV1Order_universal_d_BulkUpdateOrdersRequest = BulkUpdateOrdersRequest;\n type ecomV1Order_universal_d_MaskedOrder = MaskedOrder;\n type ecomV1Order_universal_d_BulkUpdateOrdersResponse = BulkUpdateOrdersResponse;\n type ecomV1Order_universal_d_CommitDeltasRequest = CommitDeltasRequest;\n type ecomV1Order_universal_d_DraftOrderDiffs = DraftOrderDiffs;\n type ecomV1Order_universal_d_DraftOrderDiffsShippingUpdateInfoOneOf = DraftOrderDiffsShippingUpdateInfoOneOf;\n type ecomV1Order_universal_d_DraftOrderDiffsBuyerUpdateInfoOneOf = DraftOrderDiffsBuyerUpdateInfoOneOf;\n type ecomV1Order_universal_d_DraftOrderDiffsBillingUpdateInfoOneOf = DraftOrderDiffsBillingUpdateInfoOneOf;\n type ecomV1Order_universal_d_DraftOrderDiffsRecipientUpdateInfoOneOf = DraftOrderDiffsRecipientUpdateInfoOneOf;\n type ecomV1Order_universal_d_V1LineItemDelta = V1LineItemDelta;\n type ecomV1Order_universal_d_V1LineItemDeltaDeltaOneOf = V1LineItemDeltaDeltaOneOf;\n type ecomV1Order_universal_d_OrderLineItemChangedDetails = OrderLineItemChangedDetails;\n type ecomV1Order_universal_d_DeltaPaymentOptionType = DeltaPaymentOptionType;\n const ecomV1Order_universal_d_DeltaPaymentOptionType: typeof DeltaPaymentOptionType;\n type ecomV1Order_universal_d_ItemChangedDetails = ItemChangedDetails;\n type ecomV1Order_universal_d_AppliedDiscountDelta = AppliedDiscountDelta;\n type ecomV1Order_universal_d_AppliedDiscountDeltaDeltaOneOf = AppliedDiscountDeltaDeltaOneOf;\n type ecomV1Order_universal_d_AdditionalFeeDelta = AdditionalFeeDelta;\n type ecomV1Order_universal_d_AdditionalFeeDeltaDeltaOneOf = AdditionalFeeDeltaDeltaOneOf;\n type ecomV1Order_universal_d_DraftOrderCommitSettings = DraftOrderCommitSettings;\n type ecomV1Order_universal_d_InventoryUpdateDetails = InventoryUpdateDetails;\n type ecomV1Order_universal_d_InventoryAction = InventoryAction;\n const ecomV1Order_universal_d_InventoryAction: typeof InventoryAction;\n type ecomV1Order_universal_d_CommitDeltasResponse = CommitDeltasResponse;\n type ecomV1Order_universal_d_OrderDeltasCommitted = OrderDeltasCommitted;\n type ecomV1Order_universal_d_CommittedDiffs = CommittedDiffs;\n type ecomV1Order_universal_d_CommittedDiffsShippingUpdateInfoOneOf = CommittedDiffsShippingUpdateInfoOneOf;\n type ecomV1Order_universal_d_LineItemDelta = LineItemDelta;\n type ecomV1Order_universal_d_LineItemDeltaDeltaOneOf = LineItemDeltaDeltaOneOf;\n type ecomV1Order_universal_d_ArchiveOrderRequest = ArchiveOrderRequest;\n type ecomV1Order_universal_d_ArchiveOrderResponse = ArchiveOrderResponse;\n type ecomV1Order_universal_d_BulkArchiveOrdersRequest = BulkArchiveOrdersRequest;\n type ecomV1Order_universal_d_BulkArchiveOrdersResponse = BulkArchiveOrdersResponse;\n type ecomV1Order_universal_d_BulkArchiveOrdersByFilterRequest = BulkArchiveOrdersByFilterRequest;\n type ecomV1Order_universal_d_BulkArchiveOrdersByFilterResponse = BulkArchiveOrdersByFilterResponse;\n type ecomV1Order_universal_d_UnArchiveOrderRequest = UnArchiveOrderRequest;\n type ecomV1Order_universal_d_UnArchiveOrderResponse = UnArchiveOrderResponse;\n type ecomV1Order_universal_d_BulkUnArchiveOrdersRequest = BulkUnArchiveOrdersRequest;\n type ecomV1Order_universal_d_BulkUnArchiveOrdersResponse = BulkUnArchiveOrdersResponse;\n type ecomV1Order_universal_d_BulkUnArchiveOrdersByFilterRequest = BulkUnArchiveOrdersByFilterRequest;\n type ecomV1Order_universal_d_BulkUnArchiveOrdersByFilterResponse = BulkUnArchiveOrdersByFilterResponse;\n type ecomV1Order_universal_d_UpdateBuyerInfoRequest = UpdateBuyerInfoRequest;\n type ecomV1Order_universal_d_BuyerInfoUpdate = BuyerInfoUpdate;\n type ecomV1Order_universal_d_UpdateBuyerInfoResponse = UpdateBuyerInfoResponse;\n type ecomV1Order_universal_d_UpdateBuyerEmailRequest = UpdateBuyerEmailRequest;\n type ecomV1Order_universal_d_UpdateBuyerEmailResponse = UpdateBuyerEmailResponse;\n type ecomV1Order_universal_d_UpdateOrderShippingAddressRequest = UpdateOrderShippingAddressRequest;\n type ecomV1Order_universal_d_UpdateOrderShippingAddressResponse = UpdateOrderShippingAddressResponse;\n type ecomV1Order_universal_d_UpdateBillingContactDetailsRequest = UpdateBillingContactDetailsRequest;\n type ecomV1Order_universal_d_UpdateBillingContactDetailsResponse = UpdateBillingContactDetailsResponse;\n type ecomV1Order_universal_d_UpdateOrderLineItemRequest = UpdateOrderLineItemRequest;\n type ecomV1Order_universal_d_UpdateOrderLineItemResponse = UpdateOrderLineItemResponse;\n type ecomV1Order_universal_d_UpdateOrderLineItemsRequest = UpdateOrderLineItemsRequest;\n type ecomV1Order_universal_d_MaskedOrderLineItem = MaskedOrderLineItem;\n type ecomV1Order_universal_d_UpdateOrderLineItemsResponse = UpdateOrderLineItemsResponse;\n type ecomV1Order_universal_d_AddInternalActivityRequest = AddInternalActivityRequest;\n type ecomV1Order_universal_d_InternalActivity = InternalActivity;\n type ecomV1Order_universal_d_InternalActivityContentOneOf = InternalActivityContentOneOf;\n type ecomV1Order_universal_d_OrderPlaced = OrderPlaced;\n type ecomV1Order_universal_d_OrderPaid = OrderPaid;\n type ecomV1Order_universal_d_OrderFulfilled = OrderFulfilled;\n type ecomV1Order_universal_d_OrderNotFulfilled = OrderNotFulfilled;\n type ecomV1Order_universal_d_OrderCanceled = OrderCanceled;\n type ecomV1Order_universal_d_DownloadLinkSent = DownloadLinkSent;\n type ecomV1Order_universal_d_TrackingNumberAdded = TrackingNumberAdded;\n type ecomV1Order_universal_d_TrackingNumberEdited = TrackingNumberEdited;\n type ecomV1Order_universal_d_TrackingLinkAdded = TrackingLinkAdded;\n type ecomV1Order_universal_d_ShippingConfirmationEmailSent = ShippingConfirmationEmailSent;\n type ecomV1Order_universal_d_InvoiceAdded = InvoiceAdded;\n type ecomV1Order_universal_d_InvoiceSent = InvoiceSent;\n type ecomV1Order_universal_d_FulfillerEmailSent = FulfillerEmailSent;\n type ecomV1Order_universal_d_ShippingAddressEdited = ShippingAddressEdited;\n type ecomV1Order_universal_d_EmailEdited = EmailEdited;\n type ecomV1Order_universal_d_PickupReadyEmailSent = PickupReadyEmailSent;\n type ecomV1Order_universal_d_OrderPartiallyPaid = OrderPartiallyPaid;\n type ecomV1Order_universal_d_OrderPending = OrderPending;\n type ecomV1Order_universal_d_OrderRejected = OrderRejected;\n type ecomV1Order_universal_d_AddInternalActivityResponse = AddInternalActivityResponse;\n type ecomV1Order_universal_d_AddActivityRequest = AddActivityRequest;\n type ecomV1Order_universal_d_PublicActivity = PublicActivity;\n type ecomV1Order_universal_d_PublicActivityContentOneOf = PublicActivityContentOneOf;\n type ecomV1Order_universal_d_AddActivityResponse = AddActivityResponse;\n type ecomV1Order_universal_d_AddActivitiesRequest = AddActivitiesRequest;\n type ecomV1Order_universal_d_AddActivitiesResponse = AddActivitiesResponse;\n type ecomV1Order_universal_d_UpdateActivityRequest = UpdateActivityRequest;\n type ecomV1Order_universal_d_UpdateActivityResponse = UpdateActivityResponse;\n type ecomV1Order_universal_d_DeleteActivityRequest = DeleteActivityRequest;\n type ecomV1Order_universal_d_DeleteActivityResponse = DeleteActivityResponse;\n type ecomV1Order_universal_d_UpdateLineItemsDescriptionLinesRequest = UpdateLineItemsDescriptionLinesRequest;\n type ecomV1Order_universal_d_LineItemUpdate = LineItemUpdate;\n type ecomV1Order_universal_d_UpdateLineItemsDescriptionLinesResponse = UpdateLineItemsDescriptionLinesResponse;\n type ecomV1Order_universal_d_MarkOrderAsSeenByHumanRequest = MarkOrderAsSeenByHumanRequest;\n type ecomV1Order_universal_d_MarkOrderAsSeenByHumanResponse = MarkOrderAsSeenByHumanResponse;\n type ecomV1Order_universal_d_CancelOrderRequest = CancelOrderRequest;\n type ecomV1Order_universal_d_CancelOrderResponse = CancelOrderResponse;\n type ecomV1Order_universal_d_OrderCanceledEventOrderCanceled = OrderCanceledEventOrderCanceled;\n type ecomV1Order_universal_d_MarkAsFulfilledRequest = MarkAsFulfilledRequest;\n type ecomV1Order_universal_d_MarkAsFulfilledResponse = MarkAsFulfilledResponse;\n type ecomV1Order_universal_d_FulfillmentStatusUpdated = FulfillmentStatusUpdated;\n type ecomV1Order_universal_d_BulkMarkAsFulfilledRequest = BulkMarkAsFulfilledRequest;\n type ecomV1Order_universal_d_BulkMarkAsFulfilledResponse = BulkMarkAsFulfilledResponse;\n type ecomV1Order_universal_d_BulkMarkAsFulfilledByFilterRequest = BulkMarkAsFulfilledByFilterRequest;\n type ecomV1Order_universal_d_BulkMarkAsFulfilledByFilterResponse = BulkMarkAsFulfilledByFilterResponse;\n type ecomV1Order_universal_d_MarkAsUnfulfilledRequest = MarkAsUnfulfilledRequest;\n type ecomV1Order_universal_d_MarkAsUnfulfilledResponse = MarkAsUnfulfilledResponse;\n type ecomV1Order_universal_d_BulkMarkAsUnfulfilledRequest = BulkMarkAsUnfulfilledRequest;\n type ecomV1Order_universal_d_BulkMarkAsUnfulfilledResponse = BulkMarkAsUnfulfilledResponse;\n type ecomV1Order_universal_d_BulkMarkAsUnfulfilledByFilterRequest = BulkMarkAsUnfulfilledByFilterRequest;\n type ecomV1Order_universal_d_BulkMarkAsUnfulfilledByFilterResponse = BulkMarkAsUnfulfilledByFilterResponse;\n type ecomV1Order_universal_d_V1MarkOrderAsPaidRequest = V1MarkOrderAsPaidRequest;\n type ecomV1Order_universal_d_V1MarkOrderAsPaidResponse = V1MarkOrderAsPaidResponse;\n type ecomV1Order_universal_d_V1BulkMarkOrdersAsPaidRequest = V1BulkMarkOrdersAsPaidRequest;\n type ecomV1Order_universal_d_V1BulkMarkOrdersAsPaidResponse = V1BulkMarkOrdersAsPaidResponse;\n type ecomV1Order_universal_d_V1CreatePaymentGatewayOrderRequest = V1CreatePaymentGatewayOrderRequest;\n type ecomV1Order_universal_d_V1CreatePaymentGatewayOrderResponse = V1CreatePaymentGatewayOrderResponse;\n type ecomV1Order_universal_d_GetShipmentsRequest = GetShipmentsRequest;\n type ecomV1Order_universal_d_GetShipmentsResponse = GetShipmentsResponse;\n type ecomV1Order_universal_d_AggregateOrdersRequest = AggregateOrdersRequest;\n type ecomV1Order_universal_d_AggregateOrdersResponse = AggregateOrdersResponse;\n type ecomV1Order_universal_d_DecrementItemsQuantityRequest = DecrementItemsQuantityRequest;\n type ecomV1Order_universal_d_DecrementData = DecrementData;\n type ecomV1Order_universal_d_DecrementItemsQuantityResponse = DecrementItemsQuantityResponse;\n type ecomV1Order_universal_d_BulkUpdateOrderTagsRequest = BulkUpdateOrderTagsRequest;\n type ecomV1Order_universal_d_BulkUpdateOrderTagsResponse = BulkUpdateOrderTagsResponse;\n type ecomV1Order_universal_d_BulkUpdateOrderTagsResult = BulkUpdateOrderTagsResult;\n type ecomV1Order_universal_d_OrderApproved = OrderApproved;\n type ecomV1Order_universal_d_Task = Task;\n type ecomV1Order_universal_d_TaskKey = TaskKey;\n type ecomV1Order_universal_d_TaskAction = TaskAction;\n type ecomV1Order_universal_d_TaskActionActionOneOf = TaskActionActionOneOf;\n type ecomV1Order_universal_d_Complete = Complete;\n type ecomV1Order_universal_d_Cancel = Cancel;\n type ecomV1Order_universal_d_Reschedule = Reschedule;\n type ecomV1Order_universal_d_InvoiceSentEvent = InvoiceSentEvent;\n type ecomV1Order_universal_d_IdAndVersion = IdAndVersion;\n type ecomV1Order_universal_d_InvoiceFields = InvoiceFields;\n type ecomV1Order_universal_d_Customer = Customer;\n type ecomV1Order_universal_d_Email = Email;\n type ecomV1Order_universal_d_QuotesAddress = QuotesAddress;\n type ecomV1Order_universal_d_AddressDescription = AddressDescription;\n type ecomV1Order_universal_d_Placement = Placement;\n const ecomV1Order_universal_d_Placement: typeof Placement;\n type ecomV1Order_universal_d_Phone = Phone;\n type ecomV1Order_universal_d_Company = Company;\n type ecomV1Order_universal_d_CommonAddress = CommonAddress;\n type ecomV1Order_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type ecomV1Order_universal_d_StandardDetails = StandardDetails;\n type ecomV1Order_universal_d_InvoiceDates = InvoiceDates;\n type ecomV1Order_universal_d_LineItems = LineItems;\n type ecomV1Order_universal_d_BigDecimalWrapper = BigDecimalWrapper;\n type ecomV1Order_universal_d_LineItemTax = LineItemTax;\n type ecomV1Order_universal_d_SourceType = SourceType;\n const ecomV1Order_universal_d_SourceType: typeof SourceType;\n type ecomV1Order_universal_d_LineItemMetaData = LineItemMetaData;\n type ecomV1Order_universal_d_Locale = Locale;\n type ecomV1Order_universal_d_TotalPrice = TotalPrice;\n type ecomV1Order_universal_d_ItemizedFee = ItemizedFee;\n type ecomV1Order_universal_d_DiscountOneDiscountTypeOneOf = DiscountOneDiscountTypeOneOf;\n type ecomV1Order_universal_d_CalculatedTaxes = CalculatedTaxes;\n type ecomV1Order_universal_d_CalculatedTax = CalculatedTax;\n type ecomV1Order_universal_d_Payments = Payments;\n type ecomV1Order_universal_d_InvoicesPayment = InvoicesPayment;\n type ecomV1Order_universal_d_MetaData = MetaData;\n type ecomV1Order_universal_d_InvoiceDynamicPriceTotals = InvoiceDynamicPriceTotals;\n type ecomV1Order_universal_d_CustomFieldValue = CustomFieldValue;\n type ecomV1Order_universal_d_CustomFieldGroup = CustomFieldGroup;\n const ecomV1Order_universal_d_CustomFieldGroup: typeof CustomFieldGroup;\n type ecomV1Order_universal_d_Value = Value;\n type ecomV1Order_universal_d_ValueType = ValueType;\n const ecomV1Order_universal_d_ValueType: typeof ValueType;\n type ecomV1Order_universal_d_Deposit = Deposit;\n type ecomV1Order_universal_d_DepositType = DepositType;\n const ecomV1Order_universal_d_DepositType: typeof DepositType;\n type ecomV1Order_universal_d_InvoiceStatus = InvoiceStatus;\n const ecomV1Order_universal_d_InvoiceStatus: typeof InvoiceStatus;\n type ecomV1Order_universal_d_TriggerSideEffectsFromLegacyData = TriggerSideEffectsFromLegacyData;\n const ecomV1Order_universal_d_getMetasiteData: typeof getMetasiteData;\n const ecomV1Order_universal_d_queryOrdersForMetasite: typeof queryOrdersForMetasite;\n type ecomV1Order_universal_d_QueryOrdersForMetasiteOptions = QueryOrdersForMetasiteOptions;\n const ecomV1Order_universal_d_getOrderForMetasite: typeof getOrderForMetasite;\n type ecomV1Order_universal_d_GetOrderForMetasiteIdentifiers = GetOrderForMetasiteIdentifiers;\n const ecomV1Order_universal_d_listOrderTransactionsForMetasite: typeof listOrderTransactionsForMetasite;\n type ecomV1Order_universal_d_ListOrderTransactionsForMetasiteIdentifiers = ListOrderTransactionsForMetasiteIdentifiers;\n const ecomV1Order_universal_d_triggerReindex: typeof triggerReindex;\n type ecomV1Order_universal_d_TriggerReindexOptions = TriggerReindexOptions;\n const ecomV1Order_universal_d_sendBuyerConfirmationEmail: typeof sendBuyerConfirmationEmail;\n const ecomV1Order_universal_d_sendBuyerPaymentsReceivedEmail: typeof sendBuyerPaymentsReceivedEmail;\n const ecomV1Order_universal_d_sendBuyerPickupConfirmationEmail: typeof sendBuyerPickupConfirmationEmail;\n const ecomV1Order_universal_d_bulkSendBuyerPickupConfirmationEmails: typeof bulkSendBuyerPickupConfirmationEmails;\n type ecomV1Order_universal_d_BulkSendBuyerPickupConfirmationEmailsOptions = BulkSendBuyerPickupConfirmationEmailsOptions;\n const ecomV1Order_universal_d_sendBuyerShippingConfirmationEmail: typeof sendBuyerShippingConfirmationEmail;\n const ecomV1Order_universal_d_bulkSendBuyerShippingConfirmationEmails: typeof bulkSendBuyerShippingConfirmationEmails;\n type ecomV1Order_universal_d_BulkSendBuyerShippingConfirmationEmailsOptions = BulkSendBuyerShippingConfirmationEmailsOptions;\n const ecomV1Order_universal_d_sendMerchantOrderReceivedNotification: typeof sendMerchantOrderReceivedNotification;\n const ecomV1Order_universal_d_sendCancelRefundEmail: typeof sendCancelRefundEmail;\n type ecomV1Order_universal_d_SendCancelRefundEmailOptions = SendCancelRefundEmailOptions;\n const ecomV1Order_universal_d_sendMerchantOrderReceivedPush: typeof sendMerchantOrderReceivedPush;\n const ecomV1Order_universal_d_previewEmailByType: typeof previewEmailByType;\n const ecomV1Order_universal_d_previewRefundEmail: typeof previewRefundEmail;\n type ecomV1Order_universal_d_PreviewRefundEmailOptions = PreviewRefundEmailOptions;\n const ecomV1Order_universal_d_previewCancelEmail: typeof previewCancelEmail;\n type ecomV1Order_universal_d_PreviewCancelEmailOptions = PreviewCancelEmailOptions;\n const ecomV1Order_universal_d_previewCancelRefundEmail: typeof previewCancelRefundEmail;\n type ecomV1Order_universal_d_PreviewCancelRefundEmailOptions = PreviewCancelRefundEmailOptions;\n const ecomV1Order_universal_d_previewBuyerPaymentsReceivedEmail: typeof previewBuyerPaymentsReceivedEmail;\n const ecomV1Order_universal_d_previewBuyerConfirmationEmail: typeof previewBuyerConfirmationEmail;\n const ecomV1Order_universal_d_previewBuyerPickupConfirmationEmail: typeof previewBuyerPickupConfirmationEmail;\n const ecomV1Order_universal_d_previewShippingConfirmationEmail: typeof previewShippingConfirmationEmail;\n const ecomV1Order_universal_d_previewResendDownloadLinksEmail: typeof previewResendDownloadLinksEmail;\n const ecomV1Order_universal_d_preparePaymentCollection: typeof preparePaymentCollection;\n type ecomV1Order_universal_d_PreparePaymentCollectionOptions = PreparePaymentCollectionOptions;\n const ecomV1Order_universal_d_getPaymentCollectabilityStatus: typeof getPaymentCollectabilityStatus;\n const ecomV1Order_universal_d_recordManuallyCollectedPayment: typeof recordManuallyCollectedPayment;\n const ecomV1Order_universal_d_paymentCollectionMarkOrderAsPaid: typeof paymentCollectionMarkOrderAsPaid;\n const ecomV1Order_universal_d_paymentCollectionBulkMarkOrdersAsPaid: typeof paymentCollectionBulkMarkOrdersAsPaid;\n const ecomV1Order_universal_d_paymentCollectionCreatePaymentGatewayOrder: typeof paymentCollectionCreatePaymentGatewayOrder;\n type ecomV1Order_universal_d_PaymentCollectionCreatePaymentGatewayOrderOptions = PaymentCollectionCreatePaymentGatewayOrderOptions;\n const ecomV1Order_universal_d_chargeMemberships: typeof chargeMemberships;\n type ecomV1Order_universal_d_ChargeMembershipsOptions = ChargeMembershipsOptions;\n const ecomV1Order_universal_d_voidAuthorizedPayments: typeof voidAuthorizedPayments;\n const ecomV1Order_universal_d_captureAuthorizedPayments: typeof captureAuthorizedPayments;\n const ecomV1Order_universal_d_chargeSavedPaymentMethod: typeof chargeSavedPaymentMethod;\n const ecomV1Order_universal_d_getOrder: typeof getOrder;\n const ecomV1Order_universal_d_internalQueryOrders: typeof internalQueryOrders;\n type ecomV1Order_universal_d_InternalQueryOrdersOptions = InternalQueryOrdersOptions;\n const ecomV1Order_universal_d_queryOrders: typeof queryOrders;\n type ecomV1Order_universal_d_OrdersQueryResult = OrdersQueryResult;\n type ecomV1Order_universal_d_OrdersQueryBuilder = OrdersQueryBuilder;\n const ecomV1Order_universal_d_searchOrders: typeof searchOrders;\n type ecomV1Order_universal_d_SearchOrdersOptions = SearchOrdersOptions;\n const ecomV1Order_universal_d_createOrder: typeof createOrder;\n type ecomV1Order_universal_d_CreateOrderOptions = CreateOrderOptions;\n const ecomV1Order_universal_d_updateOrder: typeof updateOrder;\n type ecomV1Order_universal_d_UpdateOrder = UpdateOrder;\n type ecomV1Order_universal_d_UpdateOrderOptions = UpdateOrderOptions;\n const ecomV1Order_universal_d_bulkUpdateOrders: typeof bulkUpdateOrders;\n type ecomV1Order_universal_d_BulkUpdateOrdersOptions = BulkUpdateOrdersOptions;\n const ecomV1Order_universal_d_commitDeltas: typeof commitDeltas;\n type ecomV1Order_universal_d_CommitDeltasOptions = CommitDeltasOptions;\n const ecomV1Order_universal_d_archiveOrder: typeof archiveOrder;\n const ecomV1Order_universal_d_bulkArchiveOrders: typeof bulkArchiveOrders;\n type ecomV1Order_universal_d_BulkArchiveOrdersOptions = BulkArchiveOrdersOptions;\n const ecomV1Order_universal_d_bulkArchiveOrdersByFilter: typeof bulkArchiveOrdersByFilter;\n const ecomV1Order_universal_d_unArchiveOrder: typeof unArchiveOrder;\n const ecomV1Order_universal_d_bulkUnArchiveOrders: typeof bulkUnArchiveOrders;\n type ecomV1Order_universal_d_BulkUnArchiveOrdersOptions = BulkUnArchiveOrdersOptions;\n const ecomV1Order_universal_d_bulkUnArchiveOrdersByFilter: typeof bulkUnArchiveOrdersByFilter;\n const ecomV1Order_universal_d_updateBuyerInfo: typeof updateBuyerInfo;\n type ecomV1Order_universal_d_UpdateBuyerInfoOptions = UpdateBuyerInfoOptions;\n const ecomV1Order_universal_d_updateBuyerEmail: typeof updateBuyerEmail;\n type ecomV1Order_universal_d_UpdateBuyerEmailOptions = UpdateBuyerEmailOptions;\n const ecomV1Order_universal_d_updateOrderShippingAddress: typeof updateOrderShippingAddress;\n type ecomV1Order_universal_d_UpdateOrderShippingAddressOptions = UpdateOrderShippingAddressOptions;\n const ecomV1Order_universal_d_updateBillingContactDetails: typeof updateBillingContactDetails;\n type ecomV1Order_universal_d_UpdateBillingContactDetailsOptions = UpdateBillingContactDetailsOptions;\n const ecomV1Order_universal_d_updateOrderLineItem: typeof updateOrderLineItem;\n type ecomV1Order_universal_d_UpdateOrderLineItemIdentifiers = UpdateOrderLineItemIdentifiers;\n type ecomV1Order_universal_d_UpdateOrderLineItem = UpdateOrderLineItem;\n type ecomV1Order_universal_d_UpdateOrderLineItemOptions = UpdateOrderLineItemOptions;\n const ecomV1Order_universal_d_updateOrderLineItems: typeof updateOrderLineItems;\n const ecomV1Order_universal_d_addInternalActivity: typeof addInternalActivity;\n const ecomV1Order_universal_d_addActivity: typeof addActivity;\n const ecomV1Order_universal_d_addActivities: typeof addActivities;\n const ecomV1Order_universal_d_updateActivity: typeof updateActivity;\n type ecomV1Order_universal_d_UpdateActivityIdentifiers = UpdateActivityIdentifiers;\n const ecomV1Order_universal_d_deleteActivity: typeof deleteActivity;\n type ecomV1Order_universal_d_DeleteActivityIdentifiers = DeleteActivityIdentifiers;\n const ecomV1Order_universal_d_updateLineItemsDescriptionLines: typeof updateLineItemsDescriptionLines;\n const ecomV1Order_universal_d_markOrderAsSeenByHuman: typeof markOrderAsSeenByHuman;\n const ecomV1Order_universal_d_cancelOrder: typeof cancelOrder;\n type ecomV1Order_universal_d_CancelOrderOptions = CancelOrderOptions;\n const ecomV1Order_universal_d_markAsFulfilled: typeof markAsFulfilled;\n const ecomV1Order_universal_d_bulkMarkAsFulfilled: typeof bulkMarkAsFulfilled;\n type ecomV1Order_universal_d_BulkMarkAsFulfilledOptions = BulkMarkAsFulfilledOptions;\n const ecomV1Order_universal_d_bulkMarkAsFulfilledByFilter: typeof bulkMarkAsFulfilledByFilter;\n const ecomV1Order_universal_d_markAsUnfulfilled: typeof markAsUnfulfilled;\n const ecomV1Order_universal_d_bulkMarkAsUnfulfilled: typeof bulkMarkAsUnfulfilled;\n type ecomV1Order_universal_d_BulkMarkAsUnfulfilledOptions = BulkMarkAsUnfulfilledOptions;\n const ecomV1Order_universal_d_bulkMarkAsUnfulfilledByFilter: typeof bulkMarkAsUnfulfilledByFilter;\n const ecomV1Order_universal_d_markOrderAsPaid: typeof markOrderAsPaid;\n const ecomV1Order_universal_d_bulkMarkOrdersAsPaid: typeof bulkMarkOrdersAsPaid;\n const ecomV1Order_universal_d_createPaymentGatewayOrder: typeof createPaymentGatewayOrder;\n const ecomV1Order_universal_d_getShipments: typeof getShipments;\n const ecomV1Order_universal_d_aggregateOrders: typeof aggregateOrders;\n type ecomV1Order_universal_d_AggregateOrdersOptions = AggregateOrdersOptions;\n const ecomV1Order_universal_d_decrementItemsQuantity: typeof decrementItemsQuantity;\n const ecomV1Order_universal_d_bulkUpdateOrderTags: typeof bulkUpdateOrderTags;\n type ecomV1Order_universal_d_BulkUpdateOrderTagsOptions = BulkUpdateOrderTagsOptions;\n namespace ecomV1Order_universal_d {\n export {\n Order$1 as Order,\n ecomV1Order_universal_d_OrderLineItem as OrderLineItem,\n ecomV1Order_universal_d_ProductName as ProductName,\n CatalogReference$3 as CatalogReference,\n Price$3 as Price,\n ecomV1Order_universal_d_DescriptionLine as DescriptionLine,\n ecomV1Order_universal_d_DescriptionLineValueOneOf as DescriptionLineValueOneOf,\n ecomV1Order_universal_d_DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOf,\n ecomV1Order_universal_d_DescriptionLineName as DescriptionLineName,\n ecomV1Order_universal_d_PlainTextValue as PlainTextValue,\n ecomV1Order_universal_d_Color as Color,\n ecomV1Order_universal_d_DescriptionLineType as DescriptionLineType,\n ecomV1Order_universal_d_FocalPoint as FocalPoint,\n PhysicalProperties$2 as PhysicalProperties,\n ItemType$1 as ItemType,\n ItemTypeItemTypeDataOneOf$1 as ItemTypeItemTypeDataOneOf,\n ItemTypeItemType$1 as ItemTypeItemType,\n PaymentOptionType$1 as PaymentOptionType,\n ItemTaxFullDetails$1 as ItemTaxFullDetails,\n ecomV1Order_universal_d_LineItemTaxInfo as LineItemTaxInfo,\n ecomV1Order_universal_d_LineItemTaxBreakdown as LineItemTaxBreakdown,\n JurisdictionType$1 as JurisdictionType,\n DigitalFile$1 as DigitalFile,\n SubscriptionInfo$1 as SubscriptionInfo,\n SubscriptionSettings$2 as SubscriptionSettings,\n SubscriptionFrequency$2 as SubscriptionFrequency,\n ecomV1Order_universal_d_PriceDescription as PriceDescription,\n ecomV1Order_universal_d_LocationAndQuantity as LocationAndQuantity,\n TaxableAddress$1 as TaxableAddress,\n TaxableAddressTaxableAddressDataOneOf$1 as TaxableAddressTaxableAddressDataOneOf,\n TaxableAddressType$1 as TaxableAddressType,\n ExtendedFields$4 as ExtendedFields,\n BuyerInfo$1 as BuyerInfo,\n ecomV1Order_universal_d_BuyerInfoIdOneOf as BuyerInfoIdOneOf,\n PaymentStatus$1 as PaymentStatus,\n FulfillmentStatus$1 as FulfillmentStatus,\n WeightUnit$3 as WeightUnit,\n PriceSummary$1 as PriceSummary,\n ecomV1Order_universal_d_AddressWithContact as AddressWithContact,\n Address$5 as Address,\n StreetAddress$4 as StreetAddress,\n AddressLocation$3 as AddressLocation,\n FullAddressContactDetails$1 as FullAddressContactDetails,\n VatId$2 as VatId,\n VatType$2 as VatType,\n ShippingInformation$1 as ShippingInformation,\n DeliveryLogistics$2 as DeliveryLogistics,\n ecomV1Order_universal_d_DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOf,\n PickupDetails$3 as PickupDetails,\n PickupAddress$1 as PickupAddress,\n PickupMethod$2 as PickupMethod,\n DeliveryTimeSlot$2 as DeliveryTimeSlot,\n ShippingPrice$1 as ShippingPrice,\n ShippingRegion$1 as ShippingRegion,\n ecomV1Order_universal_d_OrderStatus as OrderStatus,\n TaxSummary$1 as TaxSummary,\n ecomV1Order_universal_d_OrderTaxInfo as OrderTaxInfo,\n ecomV1Order_universal_d_OrderTaxBreakdown as OrderTaxBreakdown,\n AppliedDiscount$1 as AppliedDiscount,\n AppliedDiscountDiscountSourceOneOf$1 as AppliedDiscountDiscountSourceOneOf,\n DiscountType$1 as DiscountType,\n Coupon$1 as Coupon,\n MerchantDiscount$1 as MerchantDiscount,\n ecomV1Order_universal_d_MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOf,\n ecomV1Order_universal_d_DiscountReason as DiscountReason,\n DiscountRule$1 as DiscountRule,\n DiscountRuleName$1 as DiscountRuleName,\n LineItemDiscount$1 as LineItemDiscount,\n Activity$1 as Activity,\n ecomV1Order_universal_d_ActivityContentOneOf as ActivityContentOneOf,\n ecomV1Order_universal_d_CustomActivity as CustomActivity,\n ecomV1Order_universal_d_MerchantComment as MerchantComment,\n OrderRefunded$1 as OrderRefunded,\n ecomV1Order_universal_d_OrderCreatedFromExchange as OrderCreatedFromExchange,\n ecomV1Order_universal_d_NewExchangeOrderCreated as NewExchangeOrderCreated,\n ecomV1Order_universal_d_LineItemExchangeData as LineItemExchangeData,\n ecomV1Order_universal_d_DraftOrderChangesApplied as DraftOrderChangesApplied,\n ecomV1Order_universal_d_OrderChange as OrderChange,\n ecomV1Order_universal_d_OrderChangeValueOneOf as OrderChangeValueOneOf,\n ecomV1Order_universal_d_LineItemChanges as LineItemChanges,\n ecomV1Order_universal_d_LineItemQuantityChange as LineItemQuantityChange,\n ecomV1Order_universal_d_LineItemQuantityChangeType as LineItemQuantityChangeType,\n ecomV1Order_universal_d_LineItemPriceChange as LineItemPriceChange,\n ecomV1Order_universal_d_ManagedLineItem as ManagedLineItem,\n ecomV1Order_universal_d_ManagedDiscount as ManagedDiscount,\n ecomV1Order_universal_d_TranslatedValue as TranslatedValue,\n ecomV1Order_universal_d_LineItemAmount as LineItemAmount,\n ecomV1Order_universal_d_ManagedAdditionalFee as ManagedAdditionalFee,\n ecomV1Order_universal_d_TotalPriceChange as TotalPriceChange,\n ecomV1Order_universal_d_ShippingInformationChange as ShippingInformationChange,\n ecomV1Order_universal_d_ShippingInformationChangeShippingInformation as ShippingInformationChangeShippingInformation,\n ecomV1Order_universal_d_SavedPaymentMethod as SavedPaymentMethod,\n ecomV1Order_universal_d_AuthorizedPaymentCreated as AuthorizedPaymentCreated,\n ecomV1Order_universal_d_AuthorizedPaymentCaptured as AuthorizedPaymentCaptured,\n ecomV1Order_universal_d_AuthorizedPaymentVoided as AuthorizedPaymentVoided,\n ecomV1Order_universal_d_RefundInitiated as RefundInitiated,\n ecomV1Order_universal_d_RefundedPayment as RefundedPayment,\n ecomV1Order_universal_d_RefundedPaymentKindOneOf as RefundedPaymentKindOneOf,\n ecomV1Order_universal_d_RegularPaymentRefund as RegularPaymentRefund,\n ecomV1Order_universal_d_GiftCardPaymentRefund as GiftCardPaymentRefund,\n ecomV1Order_universal_d_MembershipPaymentRefund as MembershipPaymentRefund,\n ecomV1Order_universal_d_PaymentRefunded as PaymentRefunded,\n ecomV1Order_universal_d_PaymentRefundFailed as PaymentRefundFailed,\n ecomV1Order_universal_d_RefundedAsStoreCredit as RefundedAsStoreCredit,\n ecomV1Order_universal_d_PaymentPending as PaymentPending,\n ecomV1Order_universal_d_PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOf,\n ecomV1Order_universal_d_RegularPayment as RegularPayment,\n ecomV1Order_universal_d_RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOf,\n ecomV1Order_universal_d_CreditCardDetails as CreditCardDetails,\n ecomV1Order_universal_d_PaymentCanceled as PaymentCanceled,\n ecomV1Order_universal_d_PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOf,\n ecomV1Order_universal_d_PaymentDeclined as PaymentDeclined,\n ecomV1Order_universal_d_PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOf,\n ActivityType$1 as ActivityType,\n ecomV1Order_universal_d_AttributionSource as AttributionSource,\n ecomV1Order_universal_d_CreatedBy as CreatedBy,\n ecomV1Order_universal_d_CreatedByStringOneOf as CreatedByStringOneOf,\n ChannelInfo$1 as ChannelInfo,\n ChannelType$1 as ChannelType,\n CustomField$1 as CustomField,\n ecomV1Order_universal_d_BalanceSummary as BalanceSummary,\n ecomV1Order_universal_d_Balance as Balance,\n AdditionalFee$1 as AdditionalFee,\n ecomV1Order_universal_d_FulfillmentStatusesAggregate as FulfillmentStatusesAggregate,\n ecomV1Order_universal_d_Tags as Tags,\n ecomV1Order_universal_d_TagList as TagList,\n ecomV1Order_universal_d_Location as Location,\n ecomV1Order_universal_d_TriggerReindexOrderRequest as TriggerReindexOrderRequest,\n SnapshotMessage$1 as SnapshotMessage,\n ecomV1Order_universal_d_PaymentStatusUpdated as PaymentStatusUpdated,\n ecomV1Order_universal_d_OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejected,\n ecomV1Order_universal_d_OrderItemsRestocked as OrderItemsRestocked,\n ecomV1Order_universal_d_V1RestockItem as V1RestockItem,\n ecomV1Order_universal_d_GetMetasiteDataRequest as GetMetasiteDataRequest,\n ecomV1Order_universal_d_GetMetasiteDataResponse as GetMetasiteDataResponse,\n ecomV1Order_universal_d_MetaSite as MetaSite,\n ecomV1Order_universal_d_App as App,\n ecomV1Order_universal_d_State as State,\n ecomV1Order_universal_d_Namespace as Namespace,\n ecomV1Order_universal_d_SeoData as SeoData,\n ecomV1Order_universal_d_MetaTag as MetaTag,\n ecomV1Order_universal_d_HtmlApplication as HtmlApplication,\n ecomV1Order_universal_d_ExternalUriMapping as ExternalUriMapping,\n ecomV1Order_universal_d_UserDataResponse as UserDataResponse,\n ecomV1Order_universal_d_QueryOrdersForMetasiteRequest as QueryOrdersForMetasiteRequest,\n ecomV1Order_universal_d_InternalQueryOrdersRequest as InternalQueryOrdersRequest,\n ecomV1Order_universal_d_PlatformQuery as PlatformQuery,\n ecomV1Order_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf,\n Sorting$7 as Sorting,\n SortOrder$7 as SortOrder,\n ecomV1Order_universal_d_PlatformPaging as PlatformPaging,\n CursorPaging$7 as CursorPaging,\n ecomV1Order_universal_d_QueryOrdersForMetasiteResponse as QueryOrdersForMetasiteResponse,\n ecomV1Order_universal_d_PlatformPagingMetadata as PlatformPagingMetadata,\n Cursors$7 as Cursors,\n ecomV1Order_universal_d_GetOrderForMetasiteRequest as GetOrderForMetasiteRequest,\n ecomV1Order_universal_d_GetOrderForMetasiteResponse as GetOrderForMetasiteResponse,\n ecomV1Order_universal_d_ListOrderTransactionsForMetasiteRequest as ListOrderTransactionsForMetasiteRequest,\n ecomV1Order_universal_d_ListOrderTransactionsForMetasiteResponse as ListOrderTransactionsForMetasiteResponse,\n OrderTransactions$1 as OrderTransactions,\n Payment$1 as Payment,\n PaymentPaymentDetailsOneOf$1 as PaymentPaymentDetailsOneOf,\n RegularPaymentDetails$1 as RegularPaymentDetails,\n RegularPaymentDetailsPaymentMethodDetailsOneOf$1 as RegularPaymentDetailsPaymentMethodDetailsOneOf,\n TransactionStatus$1 as TransactionStatus,\n CreditCardPaymentMethodDetails$1 as CreditCardPaymentMethodDetails,\n AuthorizationDetails$1 as AuthorizationDetails,\n AuthorizationCapture$1 as AuthorizationCapture,\n AuthorizationCaptureStatus$1 as AuthorizationCaptureStatus,\n AuthorizationActionFailureDetails$1 as AuthorizationActionFailureDetails,\n AuthorizationVoid$1 as AuthorizationVoid,\n AuthorizationVoidStatus$1 as AuthorizationVoidStatus,\n Reason$1 as Reason,\n ScheduledAction$1 as ScheduledAction,\n ActionType$1 as ActionType,\n GiftCardPaymentDetails$1 as GiftCardPaymentDetails,\n MembershipPaymentDetails$1 as MembershipPaymentDetails,\n MembershipPaymentStatus$1 as MembershipPaymentStatus,\n MembershipName$2 as MembershipName,\n Refund$1 as Refund,\n RefundTransaction$1 as RefundTransaction,\n RefundStatus$1 as RefundStatus,\n RefundDetails$1 as RefundDetails,\n RefundItem$1 as RefundItem,\n ecomV1Order_universal_d_V1LineItemRefund as V1LineItemRefund,\n ecomV1Order_universal_d_V1AdditionalFeeRefund as V1AdditionalFeeRefund,\n ecomV1Order_universal_d_V1ShippingRefund as V1ShippingRefund,\n AggregatedRefundSummary$1 as AggregatedRefundSummary,\n ecomV1Order_universal_d_UpsertRefundRequest as UpsertRefundRequest,\n ecomV1Order_universal_d_UpsertRefundResponse as UpsertRefundResponse,\n DomainEvent$9 as DomainEvent,\n DomainEventBodyOneOf$9 as DomainEventBodyOneOf,\n EntityCreatedEvent$9 as EntityCreatedEvent,\n RestoreInfo$9 as RestoreInfo,\n EntityUpdatedEvent$9 as EntityUpdatedEvent,\n EntityDeletedEvent$9 as EntityDeletedEvent,\n ActionEvent$9 as ActionEvent,\n MessageEnvelope$8 as MessageEnvelope,\n IdentificationData$9 as IdentificationData,\n IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf,\n WebhookIdentityType$8 as WebhookIdentityType,\n ecomV1Order_universal_d_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent,\n ecomV1Order_universal_d_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf,\n ecomV1Order_universal_d_InternalDocument as InternalDocument,\n ecomV1Order_universal_d_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation,\n ecomV1Order_universal_d_DeleteByIdsOperation as DeleteByIdsOperation,\n ecomV1Order_universal_d_DeleteByFilterOperation as DeleteByFilterOperation,\n ecomV1Order_universal_d_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation,\n ecomV1Order_universal_d_InternalUpdateExistingOperation as InternalUpdateExistingOperation,\n ecomV1Order_universal_d_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation,\n ecomV1Order_universal_d_VersioningMode as VersioningMode,\n ecomV1Order_universal_d_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation,\n ecomV1Order_universal_d_VersionedDocumentId as VersionedDocumentId,\n ecomV1Order_universal_d_TriggerReindexRequest as TriggerReindexRequest,\n ecomV1Order_universal_d_TriggerReindexResponse as TriggerReindexResponse,\n Empty$5 as Empty,\n ecomV1Order_universal_d_BatchOfTriggerReindexOrderRequest as BatchOfTriggerReindexOrderRequest,\n ecomV1Order_universal_d_SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequest,\n ecomV1Order_universal_d_SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponse,\n ecomV1Order_universal_d_SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequest,\n ecomV1Order_universal_d_SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponse,\n ecomV1Order_universal_d_SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequest,\n ecomV1Order_universal_d_SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponse,\n ecomV1Order_universal_d_BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequest,\n ecomV1Order_universal_d_BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponse,\n ecomV1Order_universal_d_SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequest,\n ecomV1Order_universal_d_SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponse,\n ecomV1Order_universal_d_BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequest,\n ecomV1Order_universal_d_BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponse,\n ecomV1Order_universal_d_SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequest,\n ecomV1Order_universal_d_SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponse,\n ecomV1Order_universal_d_SendCancelRefundEmailRequest as SendCancelRefundEmailRequest,\n ecomV1Order_universal_d_SendCancelRefundEmailResponse as SendCancelRefundEmailResponse,\n ecomV1Order_universal_d_SendRefundEmailRequest as SendRefundEmailRequest,\n ecomV1Order_universal_d_SendRefundEmailResponse as SendRefundEmailResponse,\n ecomV1Order_universal_d_SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequest,\n ecomV1Order_universal_d_SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponse,\n ecomV1Order_universal_d_PreviewEmailByTypeRequest as PreviewEmailByTypeRequest,\n ecomV1Order_universal_d_PreviewEmailType as PreviewEmailType,\n ecomV1Order_universal_d_PreviewEmailByTypeResponse as PreviewEmailByTypeResponse,\n ecomV1Order_universal_d_PreviewRefundEmailRequest as PreviewRefundEmailRequest,\n ecomV1Order_universal_d_PreviewRefundEmailResponse as PreviewRefundEmailResponse,\n ecomV1Order_universal_d_PreviewCancelEmailRequest as PreviewCancelEmailRequest,\n ecomV1Order_universal_d_PreviewCancelEmailResponse as PreviewCancelEmailResponse,\n ecomV1Order_universal_d_PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequest,\n ecomV1Order_universal_d_PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponse,\n ecomV1Order_universal_d_PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequest,\n ecomV1Order_universal_d_PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponse,\n ecomV1Order_universal_d_PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequest,\n ecomV1Order_universal_d_PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponse,\n ecomV1Order_universal_d_PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequest,\n ecomV1Order_universal_d_PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponse,\n ecomV1Order_universal_d_PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequest,\n ecomV1Order_universal_d_PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponse,\n ecomV1Order_universal_d_PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequest,\n ecomV1Order_universal_d_PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponse,\n ecomV1Order_universal_d_PreparePaymentCollectionRequest as PreparePaymentCollectionRequest,\n ecomV1Order_universal_d_RedirectUrls as RedirectUrls,\n ecomV1Order_universal_d_DelayedCaptureSettings as DelayedCaptureSettings,\n ecomV1Order_universal_d_DelayedCaptureSettingsScheduledAction as DelayedCaptureSettingsScheduledAction,\n ecomV1Order_universal_d_Duration as Duration,\n ecomV1Order_universal_d_DurationUnit as DurationUnit,\n ecomV1Order_universal_d_PreparePaymentCollectionResponse as PreparePaymentCollectionResponse,\n ecomV1Order_universal_d_GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequest,\n ecomV1Order_universal_d_GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponse,\n ecomV1Order_universal_d_PaymentCollectabilityStatus as PaymentCollectabilityStatus,\n ecomV1Order_universal_d_RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequest,\n ecomV1Order_universal_d_RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponse,\n ecomV1Order_universal_d_MarkOrderAsPaidRequest as MarkOrderAsPaidRequest,\n ecomV1Order_universal_d_MarkOrderAsPaidResponse as MarkOrderAsPaidResponse,\n ecomV1Order_universal_d_BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequest,\n ecomV1Order_universal_d_BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponse,\n ecomV1Order_universal_d_BulkOrderResult as BulkOrderResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$4 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n GetRefundabilityStatusRequest$1 as GetRefundabilityStatusRequest,\n GetRefundabilityStatusResponse$1 as GetRefundabilityStatusResponse,\n Refundability$1 as Refundability,\n RefundabilityAdditionalRefundabilityInfoOneOf$1 as RefundabilityAdditionalRefundabilityInfoOneOf,\n RefundableStatus$1 as RefundableStatus,\n NonRefundableReason$1 as NonRefundableReason,\n ManuallyRefundableReason$1 as ManuallyRefundableReason,\n ecomV1Order_universal_d_CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequest,\n ecomV1Order_universal_d_ChargedBy as ChargedBy,\n ecomV1Order_universal_d_CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponse,\n ecomV1Order_universal_d_ChargeMembershipsRequest as ChargeMembershipsRequest,\n ecomV1Order_universal_d_MembershipChargeItem as MembershipChargeItem,\n ServiceProperties$1 as ServiceProperties,\n ecomV1Order_universal_d_ChargeMembershipsResponse as ChargeMembershipsResponse,\n TriggerRefundRequest$1 as TriggerRefundRequest,\n PaymentRefund$1 as PaymentRefund,\n RefundSideEffects$1 as RefundSideEffects,\n RestockInfo$1 as RestockInfo,\n RestockType$1 as RestockType,\n RestockItem$1 as RestockItem,\n TriggerRefundResponse$1 as TriggerRefundResponse,\n CalculateRefundRequest$1 as CalculateRefundRequest,\n CalculateRefundItemRequest$1 as CalculateRefundItemRequest,\n CalculateRefundResponse$1 as CalculateRefundResponse,\n CalculateRefundItemResponse$1 as CalculateRefundItemResponse,\n ecomV1Order_universal_d_VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequest,\n ecomV1Order_universal_d_VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponse,\n ecomV1Order_universal_d_CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequest,\n ecomV1Order_universal_d_PaymentCapture as PaymentCapture,\n ecomV1Order_universal_d_CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponse,\n ecomV1Order_universal_d_ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequest,\n ecomV1Order_universal_d_ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponse,\n DiffmatokyPayload$2 as DiffmatokyPayload,\n ErrorInformation$2 as ErrorInformation,\n ecomV1Order_universal_d_ContinueSideEffectsFlowInLegacyData as ContinueSideEffectsFlowInLegacyData,\n ecomV1Order_universal_d_OrdersExperiments as OrdersExperiments,\n IndexingMessage$1 as IndexingMessage,\n ecomV1Order_universal_d_GetOrderRequest as GetOrderRequest,\n ecomV1Order_universal_d_GetOrderResponse as GetOrderResponse,\n ecomV1Order_universal_d_InternalQueryOrdersResponse as InternalQueryOrdersResponse,\n ecomV1Order_universal_d_QueryOrderRequest as QueryOrderRequest,\n ecomV1Order_universal_d_QueryOrderResponse as QueryOrderResponse,\n ecomV1Order_universal_d_SearchOrdersRequest as SearchOrdersRequest,\n ecomV1Order_universal_d_CursorSearch as CursorSearch,\n ecomV1Order_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf,\n ecomV1Order_universal_d_SearchOrdersResponse as SearchOrdersResponse,\n CursorPagingMetadata$6 as CursorPagingMetadata,\n ecomV1Order_universal_d_CreateOrderRequest as CreateOrderRequest,\n ecomV1Order_universal_d_OrderCreationSettings as OrderCreationSettings,\n ecomV1Order_universal_d_OrderApprovalStrategy as OrderApprovalStrategy,\n ecomV1Order_universal_d_OrderCreateNotifications as OrderCreateNotifications,\n ecomV1Order_universal_d_CreateOrderResponse as CreateOrderResponse,\n ecomV1Order_universal_d_UpdateOrderRequest as UpdateOrderRequest,\n ecomV1Order_universal_d_UpdateOrderResponse as UpdateOrderResponse,\n ecomV1Order_universal_d_BulkUpdateOrdersRequest as BulkUpdateOrdersRequest,\n ecomV1Order_universal_d_MaskedOrder as MaskedOrder,\n ecomV1Order_universal_d_BulkUpdateOrdersResponse as BulkUpdateOrdersResponse,\n ecomV1Order_universal_d_CommitDeltasRequest as CommitDeltasRequest,\n ecomV1Order_universal_d_DraftOrderDiffs as DraftOrderDiffs,\n ecomV1Order_universal_d_DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOf,\n ecomV1Order_universal_d_DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOf,\n ecomV1Order_universal_d_DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOf,\n ecomV1Order_universal_d_DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOf,\n ecomV1Order_universal_d_V1LineItemDelta as V1LineItemDelta,\n ecomV1Order_universal_d_V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOf,\n ecomV1Order_universal_d_OrderLineItemChangedDetails as OrderLineItemChangedDetails,\n ecomV1Order_universal_d_DeltaPaymentOptionType as DeltaPaymentOptionType,\n ecomV1Order_universal_d_ItemChangedDetails as ItemChangedDetails,\n ecomV1Order_universal_d_AppliedDiscountDelta as AppliedDiscountDelta,\n ecomV1Order_universal_d_AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOf,\n ecomV1Order_universal_d_AdditionalFeeDelta as AdditionalFeeDelta,\n ecomV1Order_universal_d_AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOf,\n ecomV1Order_universal_d_DraftOrderCommitSettings as DraftOrderCommitSettings,\n ecomV1Order_universal_d_InventoryUpdateDetails as InventoryUpdateDetails,\n ecomV1Order_universal_d_InventoryAction as InventoryAction,\n ecomV1Order_universal_d_CommitDeltasResponse as CommitDeltasResponse,\n ecomV1Order_universal_d_OrderDeltasCommitted as OrderDeltasCommitted,\n ecomV1Order_universal_d_CommittedDiffs as CommittedDiffs,\n ecomV1Order_universal_d_CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOf,\n ecomV1Order_universal_d_LineItemDelta as LineItemDelta,\n ecomV1Order_universal_d_LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOf,\n ecomV1Order_universal_d_ArchiveOrderRequest as ArchiveOrderRequest,\n ecomV1Order_universal_d_ArchiveOrderResponse as ArchiveOrderResponse,\n ecomV1Order_universal_d_BulkArchiveOrdersRequest as BulkArchiveOrdersRequest,\n ecomV1Order_universal_d_BulkArchiveOrdersResponse as BulkArchiveOrdersResponse,\n ecomV1Order_universal_d_BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequest,\n ecomV1Order_universal_d_BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponse,\n ecomV1Order_universal_d_UnArchiveOrderRequest as UnArchiveOrderRequest,\n ecomV1Order_universal_d_UnArchiveOrderResponse as UnArchiveOrderResponse,\n ecomV1Order_universal_d_BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequest,\n ecomV1Order_universal_d_BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponse,\n ecomV1Order_universal_d_BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequest,\n ecomV1Order_universal_d_BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponse,\n ecomV1Order_universal_d_UpdateBuyerInfoRequest as UpdateBuyerInfoRequest,\n ecomV1Order_universal_d_BuyerInfoUpdate as BuyerInfoUpdate,\n ecomV1Order_universal_d_UpdateBuyerInfoResponse as UpdateBuyerInfoResponse,\n ecomV1Order_universal_d_UpdateBuyerEmailRequest as UpdateBuyerEmailRequest,\n ecomV1Order_universal_d_UpdateBuyerEmailResponse as UpdateBuyerEmailResponse,\n ecomV1Order_universal_d_UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequest,\n ecomV1Order_universal_d_UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponse,\n ecomV1Order_universal_d_UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequest,\n ecomV1Order_universal_d_UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponse,\n ecomV1Order_universal_d_UpdateOrderLineItemRequest as UpdateOrderLineItemRequest,\n ecomV1Order_universal_d_UpdateOrderLineItemResponse as UpdateOrderLineItemResponse,\n ecomV1Order_universal_d_UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequest,\n ecomV1Order_universal_d_MaskedOrderLineItem as MaskedOrderLineItem,\n ecomV1Order_universal_d_UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponse,\n ecomV1Order_universal_d_AddInternalActivityRequest as AddInternalActivityRequest,\n ecomV1Order_universal_d_InternalActivity as InternalActivity,\n ecomV1Order_universal_d_InternalActivityContentOneOf as InternalActivityContentOneOf,\n ecomV1Order_universal_d_OrderPlaced as OrderPlaced,\n ecomV1Order_universal_d_OrderPaid as OrderPaid,\n ecomV1Order_universal_d_OrderFulfilled as OrderFulfilled,\n ecomV1Order_universal_d_OrderNotFulfilled as OrderNotFulfilled,\n ecomV1Order_universal_d_OrderCanceled as OrderCanceled,\n ecomV1Order_universal_d_DownloadLinkSent as DownloadLinkSent,\n ecomV1Order_universal_d_TrackingNumberAdded as TrackingNumberAdded,\n ecomV1Order_universal_d_TrackingNumberEdited as TrackingNumberEdited,\n ecomV1Order_universal_d_TrackingLinkAdded as TrackingLinkAdded,\n ecomV1Order_universal_d_ShippingConfirmationEmailSent as ShippingConfirmationEmailSent,\n ecomV1Order_universal_d_InvoiceAdded as InvoiceAdded,\n ecomV1Order_universal_d_InvoiceSent as InvoiceSent,\n ecomV1Order_universal_d_FulfillerEmailSent as FulfillerEmailSent,\n ecomV1Order_universal_d_ShippingAddressEdited as ShippingAddressEdited,\n ecomV1Order_universal_d_EmailEdited as EmailEdited,\n ecomV1Order_universal_d_PickupReadyEmailSent as PickupReadyEmailSent,\n ecomV1Order_universal_d_OrderPartiallyPaid as OrderPartiallyPaid,\n ecomV1Order_universal_d_OrderPending as OrderPending,\n ecomV1Order_universal_d_OrderRejected as OrderRejected,\n ecomV1Order_universal_d_AddInternalActivityResponse as AddInternalActivityResponse,\n ecomV1Order_universal_d_AddActivityRequest as AddActivityRequest,\n ecomV1Order_universal_d_PublicActivity as PublicActivity,\n ecomV1Order_universal_d_PublicActivityContentOneOf as PublicActivityContentOneOf,\n ecomV1Order_universal_d_AddActivityResponse as AddActivityResponse,\n ecomV1Order_universal_d_AddActivitiesRequest as AddActivitiesRequest,\n ecomV1Order_universal_d_AddActivitiesResponse as AddActivitiesResponse,\n ecomV1Order_universal_d_UpdateActivityRequest as UpdateActivityRequest,\n ecomV1Order_universal_d_UpdateActivityResponse as UpdateActivityResponse,\n ecomV1Order_universal_d_DeleteActivityRequest as DeleteActivityRequest,\n ecomV1Order_universal_d_DeleteActivityResponse as DeleteActivityResponse,\n ecomV1Order_universal_d_UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequest,\n ecomV1Order_universal_d_LineItemUpdate as LineItemUpdate,\n ecomV1Order_universal_d_UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponse,\n ecomV1Order_universal_d_MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequest,\n ecomV1Order_universal_d_MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponse,\n ecomV1Order_universal_d_CancelOrderRequest as CancelOrderRequest,\n ecomV1Order_universal_d_CancelOrderResponse as CancelOrderResponse,\n ecomV1Order_universal_d_OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceled,\n ecomV1Order_universal_d_MarkAsFulfilledRequest as MarkAsFulfilledRequest,\n ecomV1Order_universal_d_MarkAsFulfilledResponse as MarkAsFulfilledResponse,\n ecomV1Order_universal_d_FulfillmentStatusUpdated as FulfillmentStatusUpdated,\n ecomV1Order_universal_d_BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequest,\n ecomV1Order_universal_d_BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponse,\n ecomV1Order_universal_d_BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequest,\n ecomV1Order_universal_d_BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponse,\n ecomV1Order_universal_d_MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequest,\n ecomV1Order_universal_d_MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponse,\n ecomV1Order_universal_d_BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequest,\n ecomV1Order_universal_d_BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponse,\n ecomV1Order_universal_d_BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequest,\n ecomV1Order_universal_d_BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponse,\n ecomV1Order_universal_d_V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequest,\n ecomV1Order_universal_d_V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponse,\n ecomV1Order_universal_d_V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequest,\n ecomV1Order_universal_d_V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponse,\n ecomV1Order_universal_d_V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequest,\n ecomV1Order_universal_d_V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponse,\n ecomV1Order_universal_d_GetShipmentsRequest as GetShipmentsRequest,\n ecomV1Order_universal_d_GetShipmentsResponse as GetShipmentsResponse,\n ecomV1Order_universal_d_AggregateOrdersRequest as AggregateOrdersRequest,\n ecomV1Order_universal_d_AggregateOrdersResponse as AggregateOrdersResponse,\n ecomV1Order_universal_d_DecrementItemsQuantityRequest as DecrementItemsQuantityRequest,\n ecomV1Order_universal_d_DecrementData as DecrementData,\n ecomV1Order_universal_d_DecrementItemsQuantityResponse as DecrementItemsQuantityResponse,\n ecomV1Order_universal_d_BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequest,\n ecomV1Order_universal_d_BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponse,\n ecomV1Order_universal_d_BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResult,\n ecomV1Order_universal_d_OrderApproved as OrderApproved,\n ecomV1Order_universal_d_Task as Task,\n ecomV1Order_universal_d_TaskKey as TaskKey,\n ecomV1Order_universal_d_TaskAction as TaskAction,\n ecomV1Order_universal_d_TaskActionActionOneOf as TaskActionActionOneOf,\n ecomV1Order_universal_d_Complete as Complete,\n ecomV1Order_universal_d_Cancel as Cancel,\n ecomV1Order_universal_d_Reschedule as Reschedule,\n ecomV1Order_universal_d_InvoiceSentEvent as InvoiceSentEvent,\n ecomV1Order_universal_d_IdAndVersion as IdAndVersion,\n ecomV1Order_universal_d_InvoiceFields as InvoiceFields,\n ecomV1Order_universal_d_Customer as Customer,\n ecomV1Order_universal_d_Email as Email,\n ecomV1Order_universal_d_QuotesAddress as QuotesAddress,\n ecomV1Order_universal_d_AddressDescription as AddressDescription,\n ecomV1Order_universal_d_Placement as Placement,\n ecomV1Order_universal_d_Phone as Phone,\n ecomV1Order_universal_d_Company as Company,\n ecomV1Order_universal_d_CommonAddress as CommonAddress,\n ecomV1Order_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf,\n Subdivision$1 as Subdivision,\n SubdivisionType$1 as SubdivisionType,\n ecomV1Order_universal_d_StandardDetails as StandardDetails,\n ecomV1Order_universal_d_InvoiceDates as InvoiceDates,\n ecomV1Order_universal_d_LineItems as LineItems,\n LineItem$2 as LineItem,\n ecomV1Order_universal_d_BigDecimalWrapper as BigDecimalWrapper,\n ecomV1Order_universal_d_LineItemTax as LineItemTax,\n Source$2 as Source,\n ecomV1Order_universal_d_SourceType as SourceType,\n ecomV1Order_universal_d_LineItemMetaData as LineItemMetaData,\n ecomV1Order_universal_d_Locale as Locale,\n ecomV1Order_universal_d_TotalPrice as TotalPrice,\n ecomV1Order_universal_d_ItemizedFee as ItemizedFee,\n Discount$1 as Discount,\n ecomV1Order_universal_d_DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOf,\n ecomV1Order_universal_d_CalculatedTaxes as CalculatedTaxes,\n ecomV1Order_universal_d_CalculatedTax as CalculatedTax,\n ecomV1Order_universal_d_Payments as Payments,\n ecomV1Order_universal_d_InvoicesPayment as InvoicesPayment,\n ecomV1Order_universal_d_MetaData as MetaData,\n ecomV1Order_universal_d_InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotals,\n ecomV1Order_universal_d_CustomFieldValue as CustomFieldValue,\n ecomV1Order_universal_d_CustomFieldGroup as CustomFieldGroup,\n ecomV1Order_universal_d_Value as Value,\n ecomV1Order_universal_d_ValueType as ValueType,\n ecomV1Order_universal_d_Deposit as Deposit,\n ecomV1Order_universal_d_DepositType as DepositType,\n ecomV1Order_universal_d_InvoiceStatus as InvoiceStatus,\n ecomV1Order_universal_d_TriggerSideEffectsFromLegacyData as TriggerSideEffectsFromLegacyData,\n ecomV1Order_universal_d_getMetasiteData as getMetasiteData,\n ecomV1Order_universal_d_queryOrdersForMetasite as queryOrdersForMetasite,\n ecomV1Order_universal_d_QueryOrdersForMetasiteOptions as QueryOrdersForMetasiteOptions,\n ecomV1Order_universal_d_getOrderForMetasite as getOrderForMetasite,\n ecomV1Order_universal_d_GetOrderForMetasiteIdentifiers as GetOrderForMetasiteIdentifiers,\n ecomV1Order_universal_d_listOrderTransactionsForMetasite as listOrderTransactionsForMetasite,\n ecomV1Order_universal_d_ListOrderTransactionsForMetasiteIdentifiers as ListOrderTransactionsForMetasiteIdentifiers,\n ecomV1Order_universal_d_triggerReindex as triggerReindex,\n ecomV1Order_universal_d_TriggerReindexOptions as TriggerReindexOptions,\n ecomV1Order_universal_d_sendBuyerConfirmationEmail as sendBuyerConfirmationEmail,\n ecomV1Order_universal_d_sendBuyerPaymentsReceivedEmail as sendBuyerPaymentsReceivedEmail,\n ecomV1Order_universal_d_sendBuyerPickupConfirmationEmail as sendBuyerPickupConfirmationEmail,\n ecomV1Order_universal_d_bulkSendBuyerPickupConfirmationEmails as bulkSendBuyerPickupConfirmationEmails,\n ecomV1Order_universal_d_BulkSendBuyerPickupConfirmationEmailsOptions as BulkSendBuyerPickupConfirmationEmailsOptions,\n ecomV1Order_universal_d_sendBuyerShippingConfirmationEmail as sendBuyerShippingConfirmationEmail,\n ecomV1Order_universal_d_bulkSendBuyerShippingConfirmationEmails as bulkSendBuyerShippingConfirmationEmails,\n ecomV1Order_universal_d_BulkSendBuyerShippingConfirmationEmailsOptions as BulkSendBuyerShippingConfirmationEmailsOptions,\n ecomV1Order_universal_d_sendMerchantOrderReceivedNotification as sendMerchantOrderReceivedNotification,\n ecomV1Order_universal_d_sendCancelRefundEmail as sendCancelRefundEmail,\n ecomV1Order_universal_d_SendCancelRefundEmailOptions as SendCancelRefundEmailOptions,\n ecomV1Order_universal_d_sendMerchantOrderReceivedPush as sendMerchantOrderReceivedPush,\n ecomV1Order_universal_d_previewEmailByType as previewEmailByType,\n ecomV1Order_universal_d_previewRefundEmail as previewRefundEmail,\n ecomV1Order_universal_d_PreviewRefundEmailOptions as PreviewRefundEmailOptions,\n ecomV1Order_universal_d_previewCancelEmail as previewCancelEmail,\n ecomV1Order_universal_d_PreviewCancelEmailOptions as PreviewCancelEmailOptions,\n ecomV1Order_universal_d_previewCancelRefundEmail as previewCancelRefundEmail,\n ecomV1Order_universal_d_PreviewCancelRefundEmailOptions as PreviewCancelRefundEmailOptions,\n ecomV1Order_universal_d_previewBuyerPaymentsReceivedEmail as previewBuyerPaymentsReceivedEmail,\n ecomV1Order_universal_d_previewBuyerConfirmationEmail as previewBuyerConfirmationEmail,\n ecomV1Order_universal_d_previewBuyerPickupConfirmationEmail as previewBuyerPickupConfirmationEmail,\n ecomV1Order_universal_d_previewShippingConfirmationEmail as previewShippingConfirmationEmail,\n ecomV1Order_universal_d_previewResendDownloadLinksEmail as previewResendDownloadLinksEmail,\n ecomV1Order_universal_d_preparePaymentCollection as preparePaymentCollection,\n ecomV1Order_universal_d_PreparePaymentCollectionOptions as PreparePaymentCollectionOptions,\n ecomV1Order_universal_d_getPaymentCollectabilityStatus as getPaymentCollectabilityStatus,\n ecomV1Order_universal_d_recordManuallyCollectedPayment as recordManuallyCollectedPayment,\n ecomV1Order_universal_d_paymentCollectionMarkOrderAsPaid as paymentCollectionMarkOrderAsPaid,\n ecomV1Order_universal_d_paymentCollectionBulkMarkOrdersAsPaid as paymentCollectionBulkMarkOrdersAsPaid,\n getRefundabilityStatus$1 as getRefundabilityStatus,\n ecomV1Order_universal_d_paymentCollectionCreatePaymentGatewayOrder as paymentCollectionCreatePaymentGatewayOrder,\n ecomV1Order_universal_d_PaymentCollectionCreatePaymentGatewayOrderOptions as PaymentCollectionCreatePaymentGatewayOrderOptions,\n ecomV1Order_universal_d_chargeMemberships as chargeMemberships,\n ecomV1Order_universal_d_ChargeMembershipsOptions as ChargeMembershipsOptions,\n triggerRefund$1 as triggerRefund,\n TriggerRefundOptions$1 as TriggerRefundOptions,\n calculateRefund$1 as calculateRefund,\n CalculateRefundOptions$1 as CalculateRefundOptions,\n ecomV1Order_universal_d_voidAuthorizedPayments as voidAuthorizedPayments,\n ecomV1Order_universal_d_captureAuthorizedPayments as captureAuthorizedPayments,\n ecomV1Order_universal_d_chargeSavedPaymentMethod as chargeSavedPaymentMethod,\n ecomV1Order_universal_d_getOrder as getOrder,\n ecomV1Order_universal_d_internalQueryOrders as internalQueryOrders,\n ecomV1Order_universal_d_InternalQueryOrdersOptions as InternalQueryOrdersOptions,\n ecomV1Order_universal_d_queryOrders as queryOrders,\n ecomV1Order_universal_d_OrdersQueryResult as OrdersQueryResult,\n ecomV1Order_universal_d_OrdersQueryBuilder as OrdersQueryBuilder,\n ecomV1Order_universal_d_searchOrders as searchOrders,\n ecomV1Order_universal_d_SearchOrdersOptions as SearchOrdersOptions,\n ecomV1Order_universal_d_createOrder as createOrder,\n ecomV1Order_universal_d_CreateOrderOptions as CreateOrderOptions,\n ecomV1Order_universal_d_updateOrder as updateOrder,\n ecomV1Order_universal_d_UpdateOrder as UpdateOrder,\n ecomV1Order_universal_d_UpdateOrderOptions as UpdateOrderOptions,\n ecomV1Order_universal_d_bulkUpdateOrders as bulkUpdateOrders,\n ecomV1Order_universal_d_BulkUpdateOrdersOptions as BulkUpdateOrdersOptions,\n ecomV1Order_universal_d_commitDeltas as commitDeltas,\n ecomV1Order_universal_d_CommitDeltasOptions as CommitDeltasOptions,\n ecomV1Order_universal_d_archiveOrder as archiveOrder,\n ecomV1Order_universal_d_bulkArchiveOrders as bulkArchiveOrders,\n ecomV1Order_universal_d_BulkArchiveOrdersOptions as BulkArchiveOrdersOptions,\n ecomV1Order_universal_d_bulkArchiveOrdersByFilter as bulkArchiveOrdersByFilter,\n ecomV1Order_universal_d_unArchiveOrder as unArchiveOrder,\n ecomV1Order_universal_d_bulkUnArchiveOrders as bulkUnArchiveOrders,\n ecomV1Order_universal_d_BulkUnArchiveOrdersOptions as BulkUnArchiveOrdersOptions,\n ecomV1Order_universal_d_bulkUnArchiveOrdersByFilter as bulkUnArchiveOrdersByFilter,\n ecomV1Order_universal_d_updateBuyerInfo as updateBuyerInfo,\n ecomV1Order_universal_d_UpdateBuyerInfoOptions as UpdateBuyerInfoOptions,\n ecomV1Order_universal_d_updateBuyerEmail as updateBuyerEmail,\n ecomV1Order_universal_d_UpdateBuyerEmailOptions as UpdateBuyerEmailOptions,\n ecomV1Order_universal_d_updateOrderShippingAddress as updateOrderShippingAddress,\n ecomV1Order_universal_d_UpdateOrderShippingAddressOptions as UpdateOrderShippingAddressOptions,\n ecomV1Order_universal_d_updateBillingContactDetails as updateBillingContactDetails,\n ecomV1Order_universal_d_UpdateBillingContactDetailsOptions as UpdateBillingContactDetailsOptions,\n ecomV1Order_universal_d_updateOrderLineItem as updateOrderLineItem,\n ecomV1Order_universal_d_UpdateOrderLineItemIdentifiers as UpdateOrderLineItemIdentifiers,\n ecomV1Order_universal_d_UpdateOrderLineItem as UpdateOrderLineItem,\n ecomV1Order_universal_d_UpdateOrderLineItemOptions as UpdateOrderLineItemOptions,\n ecomV1Order_universal_d_updateOrderLineItems as updateOrderLineItems,\n ecomV1Order_universal_d_addInternalActivity as addInternalActivity,\n ecomV1Order_universal_d_addActivity as addActivity,\n ecomV1Order_universal_d_addActivities as addActivities,\n ecomV1Order_universal_d_updateActivity as updateActivity,\n ecomV1Order_universal_d_UpdateActivityIdentifiers as UpdateActivityIdentifiers,\n ecomV1Order_universal_d_deleteActivity as deleteActivity,\n ecomV1Order_universal_d_DeleteActivityIdentifiers as DeleteActivityIdentifiers,\n ecomV1Order_universal_d_updateLineItemsDescriptionLines as updateLineItemsDescriptionLines,\n ecomV1Order_universal_d_markOrderAsSeenByHuman as markOrderAsSeenByHuman,\n ecomV1Order_universal_d_cancelOrder as cancelOrder,\n ecomV1Order_universal_d_CancelOrderOptions as CancelOrderOptions,\n ecomV1Order_universal_d_markAsFulfilled as markAsFulfilled,\n ecomV1Order_universal_d_bulkMarkAsFulfilled as bulkMarkAsFulfilled,\n ecomV1Order_universal_d_BulkMarkAsFulfilledOptions as BulkMarkAsFulfilledOptions,\n ecomV1Order_universal_d_bulkMarkAsFulfilledByFilter as bulkMarkAsFulfilledByFilter,\n ecomV1Order_universal_d_markAsUnfulfilled as markAsUnfulfilled,\n ecomV1Order_universal_d_bulkMarkAsUnfulfilled as bulkMarkAsUnfulfilled,\n ecomV1Order_universal_d_BulkMarkAsUnfulfilledOptions as BulkMarkAsUnfulfilledOptions,\n ecomV1Order_universal_d_bulkMarkAsUnfulfilledByFilter as bulkMarkAsUnfulfilledByFilter,\n ecomV1Order_universal_d_markOrderAsPaid as markOrderAsPaid,\n ecomV1Order_universal_d_bulkMarkOrdersAsPaid as bulkMarkOrdersAsPaid,\n ecomV1Order_universal_d_createPaymentGatewayOrder as createPaymentGatewayOrder,\n ecomV1Order_universal_d_getShipments as getShipments,\n ecomV1Order_universal_d_aggregateOrders as aggregateOrders,\n ecomV1Order_universal_d_AggregateOrdersOptions as AggregateOrdersOptions,\n ecomV1Order_universal_d_decrementItemsQuantity as decrementItemsQuantity,\n ecomV1Order_universal_d_bulkUpdateOrderTags as bulkUpdateOrderTags,\n ecomV1Order_universal_d_BulkUpdateOrderTagsOptions as BulkUpdateOrderTagsOptions,\n };\n }\n \n interface OrderPaymentRequest {\n /**\n * Order payment request ID.\n * @readonly\n */\n _id?: string | null;\n /** Additional parameters to identify the source of the order payment request. */\n source?: Source$1;\n /**\n * status.\n * @readonly\n */\n status?: Status;\n /** Order ID. */\n orderId?: string;\n /**\n * Order number.\n * @readonly\n */\n orderNumber?: string | null;\n /**\n * Amount to collect.\n * > **Note:** The amount can only be set once.\n */\n amount?: Price$2;\n /**\n * Currency code. The value will always match the currency used in the order.\n * @readonly\n */\n currency?: string;\n /**\n * Payment gateway order id which is associated with this payment request\n * @readonly\n */\n paymentGatewayOrderId?: string | null;\n /** Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for. */\n title?: string;\n /** Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for. */\n description?: string | null;\n /** Image to be displayed to the customer on the payment page. */\n image?: string;\n /** Time and date the order payment request expires. */\n expirationDate?: Date | null;\n /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */\n extendedFields?: ExtendedFields$3;\n /**\n * Date and time the OrderPaymentRequest was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the OrderPaymentRequest was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface Source$1 {\n /** App Def ID that created the order payment request. */\n appId?: string | null;\n /** Reference to an ID from an external system, indicating the original source of the order payment request. */\n externalId?: string;\n }\n enum Status {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n UNPAID = \"UNPAID\",\n PAID = \"PAID\",\n EXPIRED = \"EXPIRED\"\n }\n interface Price$2 {\n /** Amount. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: 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 /** Triggered when the the order payment request status changes to paid */\n interface OrderPaymentRequestPaid {\n /** The order that was updated */\n orderPaymentRequest?: OrderPaymentRequest;\n }\n /** Triggered when the the order payment request status changes to expired */\n interface OrderPaymentRequestExpired {\n /** The order that was updated */\n orderPaymentRequest?: OrderPaymentRequest;\n }\n interface CreateOrderPaymentRequestRequest {\n /** OrderPaymentRequest to be created. */\n orderPaymentRequest?: OrderPaymentRequest;\n }\n interface CreateOrderPaymentRequestResponse {\n /** The created OrderPaymentRequest. */\n orderPaymentRequest?: OrderPaymentRequest;\n /** Order payment request URL. */\n orderPaymentRequestUrl?: string;\n }\n interface GetOrderPaymentRequestRequest {\n /** ID of the OrderPaymentRequest to retrieve. */\n orderPaymentRequestId: string;\n }\n interface GetOrderPaymentRequestResponse {\n /** The requested OrderPaymentRequest. */\n orderPaymentRequest?: OrderPaymentRequest;\n }\n interface UpdateOrderPaymentRequestRequest {\n /** OrderPaymentRequest to be updated, may be partial. */\n orderPaymentRequest: OrderPaymentRequest;\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateOrderPaymentRequestResponse {\n /** Updated OrderPaymentRequest. */\n orderPaymentRequest?: OrderPaymentRequest;\n }\n interface DeleteOrderPaymentRequestRequest {\n /** Id of the OrderPaymentRequest to delete. */\n orderPaymentRequestId: string;\n }\n interface DeleteOrderPaymentRequestResponse {\n }\n interface QueryOrderPaymentRequestsRequest {\n /** WQL expression. */\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$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$6[];\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$6;\n }\n interface Sorting$6 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$6;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryOrderPaymentRequestsResponse {\n /** List of payment requests. */\n orderPaymentRequests?: OrderPaymentRequest[];\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$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 GetOrderPaymentRequestURLRequest {\n /** Order Payment Request ID. */\n orderPaymentRequestId: string;\n }\n interface GetOrderPaymentRequestURLResponse {\n /** Order Payment Request URL. */\n orderPaymentRequestUrl?: string;\n }\n interface UpdateExtendedFieldsRequest$2 {\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$2 {\n /** Updated OrderPaymentRequest. */\n orderPaymentRequest?: OrderPaymentRequest;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$8;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$8 {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$8 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$8 {\n bodyAsJson?: string;\n }\n interface Empty$4 {\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$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$7;\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$7 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Creates a order payment request.\n * @public\n * @documentationMaturity preview\n * @requiredField options.orderPaymentRequest.amount\n * @requiredField options.orderPaymentRequest.orderId\n * @requiredField options.orderPaymentRequest.title\n * @permissionId ECOM.ORDER_PAYMENT_REQUEST_CREATE\n * @adminMethod\n * @returns The created OrderPaymentRequest.\n */\n function createOrderPaymentRequest(options?: CreateOrderPaymentRequestOptions): Promise;\n interface CreateOrderPaymentRequestOptions {\n /** OrderPaymentRequest to be created. */\n orderPaymentRequest?: OrderPaymentRequest;\n }\n /**\n * Retrieves a order payment request.\n * @param orderPaymentRequestId - ID of the OrderPaymentRequest to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField orderPaymentRequestId\n * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ\n * @returns The requested OrderPaymentRequest.\n */\n function getOrderPaymentRequest(orderPaymentRequestId: string): Promise;\n /**\n * Updates a order payment request.\n *\n * Please note that only `UNPAID` payment requests can be updated.\n * @param _id - Order payment request ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField orderPaymentRequest\n * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE\n * @adminMethod\n * @returns Updated OrderPaymentRequest.\n */\n function updateOrderPaymentRequest(_id: string | null, orderPaymentRequest: UpdateOrderPaymentRequest, options?: UpdateOrderPaymentRequestOptions): Promise;\n interface UpdateOrderPaymentRequest {\n /**\n * Order payment request ID.\n * @readonly\n */\n _id?: string | null;\n /** Additional parameters to identify the source of the order payment request. */\n source?: Source$1;\n /**\n * status.\n * @readonly\n */\n status?: Status;\n /** Order ID. */\n orderId?: string;\n /**\n * Order number.\n * @readonly\n */\n orderNumber?: string | null;\n /**\n * Amount to collect.\n * > **Note:** The amount can only be set once.\n */\n amount?: Price$2;\n /**\n * Currency code. The value will always match the currency used in the order.\n * @readonly\n */\n currency?: string;\n /**\n * Payment gateway order id which is associated with this payment request\n * @readonly\n */\n paymentGatewayOrderId?: string | null;\n /** Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for. */\n title?: string;\n /** Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for. */\n description?: string | null;\n /** Image to be displayed to the customer on the payment page. */\n image?: string;\n /** Time and date the order payment request expires. */\n expirationDate?: Date | null;\n /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */\n extendedFields?: ExtendedFields$3;\n /**\n * Date and time the OrderPaymentRequest was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the OrderPaymentRequest was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface UpdateOrderPaymentRequestOptions {\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes a order payment request.\n *\n * Please note that only `UNPAID` payment requests can be deleted.\n * @param orderPaymentRequestId - Id of the OrderPaymentRequest to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField orderPaymentRequestId\n * @permissionId ECOM.ORDER_PAYMENT_REQUEST_DELETE\n * @adminMethod\n */\n function deleteOrderPaymentRequest(orderPaymentRequestId: string): Promise;\n /**\n * Retrieves a list of Payment Requests, given the provided [paging, filtering, and sorting][1].\n *\n * Query Payment Requests runs with these defaults, which you can override:\n * - `createdDate` is sorted in DESC order\n * - `cursorPaging.limit` is 100\n *\n * To learn about working with _Query_ 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 * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ\n */\n function queryOrderPaymentRequests(): OrderPaymentRequestsQueryBuilder;\n interface QueryCursorResult$6 {\n cursors: Cursors$6;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OrderPaymentRequestsQueryResult extends QueryCursorResult$6 {\n items: OrderPaymentRequest[];\n query: OrderPaymentRequestsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface OrderPaymentRequestsQueryBuilder {\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' | 'source.appId' | 'source.externalId' | 'status' | 'orderId' | 'orderNumber' | 'amount.amount' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\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' | 'source.appId' | 'source.externalId' | 'status' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\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' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description', value: string) => OrderPaymentRequestsQueryBuilder;\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' | 'source.appId' | 'source.externalId' | 'status' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any[]) => OrderPaymentRequestsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'status' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'status' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: boolean) => OrderPaymentRequestsQueryBuilder;\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<'status' | 'orderNumber' | 'amount.amount' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate'>) => OrderPaymentRequestsQueryBuilder;\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<'status' | 'orderNumber' | 'amount.amount' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate'>) => OrderPaymentRequestsQueryBuilder;\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) => OrderPaymentRequestsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => OrderPaymentRequestsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves the order payment request page URL of a specified order payment request.\n * @param orderPaymentRequestId - Order Payment Request ID.\n * @public\n * @documentationMaturity preview\n * @requiredField orderPaymentRequestId\n * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ\n */\n function getOrderPaymentRequestUrl(orderPaymentRequestId: string): Promise;\n /**\n * Updates extended fields of a order payment request\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 ECOM.ORDER_PAYMENT_REQUEST_UPDATE\n * @adminMethod\n */\n function updateExtendedFields$2(_id: string, namespace: string, options: UpdateExtendedFieldsOptions$2): Promise;\n interface UpdateExtendedFieldsOptions$2 {\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 type ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequest = OrderPaymentRequest;\n type ecomV1OrderPaymentRequest_universal_d_Status = Status;\n const ecomV1OrderPaymentRequest_universal_d_Status: typeof Status;\n type ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestPaid = OrderPaymentRequestPaid;\n type ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestExpired = OrderPaymentRequestExpired;\n type ecomV1OrderPaymentRequest_universal_d_CreateOrderPaymentRequestRequest = CreateOrderPaymentRequestRequest;\n type ecomV1OrderPaymentRequest_universal_d_CreateOrderPaymentRequestResponse = CreateOrderPaymentRequestResponse;\n type ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestRequest = GetOrderPaymentRequestRequest;\n type ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestResponse = GetOrderPaymentRequestResponse;\n type ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequestRequest = UpdateOrderPaymentRequestRequest;\n type ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequestResponse = UpdateOrderPaymentRequestResponse;\n type ecomV1OrderPaymentRequest_universal_d_DeleteOrderPaymentRequestRequest = DeleteOrderPaymentRequestRequest;\n type ecomV1OrderPaymentRequest_universal_d_DeleteOrderPaymentRequestResponse = DeleteOrderPaymentRequestResponse;\n type ecomV1OrderPaymentRequest_universal_d_QueryOrderPaymentRequestsRequest = QueryOrderPaymentRequestsRequest;\n type ecomV1OrderPaymentRequest_universal_d_QueryOrderPaymentRequestsResponse = QueryOrderPaymentRequestsResponse;\n type ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestURLRequest = GetOrderPaymentRequestURLRequest;\n type ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestURLResponse = GetOrderPaymentRequestURLResponse;\n const ecomV1OrderPaymentRequest_universal_d_createOrderPaymentRequest: typeof createOrderPaymentRequest;\n type ecomV1OrderPaymentRequest_universal_d_CreateOrderPaymentRequestOptions = CreateOrderPaymentRequestOptions;\n const ecomV1OrderPaymentRequest_universal_d_getOrderPaymentRequest: typeof getOrderPaymentRequest;\n const ecomV1OrderPaymentRequest_universal_d_updateOrderPaymentRequest: typeof updateOrderPaymentRequest;\n type ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequest = UpdateOrderPaymentRequest;\n type ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequestOptions = UpdateOrderPaymentRequestOptions;\n const ecomV1OrderPaymentRequest_universal_d_deleteOrderPaymentRequest: typeof deleteOrderPaymentRequest;\n const ecomV1OrderPaymentRequest_universal_d_queryOrderPaymentRequests: typeof queryOrderPaymentRequests;\n type ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestsQueryResult = OrderPaymentRequestsQueryResult;\n type ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestsQueryBuilder = OrderPaymentRequestsQueryBuilder;\n const ecomV1OrderPaymentRequest_universal_d_getOrderPaymentRequestUrl: typeof getOrderPaymentRequestUrl;\n namespace ecomV1OrderPaymentRequest_universal_d {\n export {\n ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequest as OrderPaymentRequest,\n Source$1 as Source,\n ecomV1OrderPaymentRequest_universal_d_Status as Status,\n Price$2 as Price,\n ExtendedFields$3 as ExtendedFields,\n ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestPaid as OrderPaymentRequestPaid,\n ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestExpired as OrderPaymentRequestExpired,\n ecomV1OrderPaymentRequest_universal_d_CreateOrderPaymentRequestRequest as CreateOrderPaymentRequestRequest,\n ecomV1OrderPaymentRequest_universal_d_CreateOrderPaymentRequestResponse as CreateOrderPaymentRequestResponse,\n ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestRequest as GetOrderPaymentRequestRequest,\n ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestResponse as GetOrderPaymentRequestResponse,\n ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequestRequest as UpdateOrderPaymentRequestRequest,\n ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequestResponse as UpdateOrderPaymentRequestResponse,\n ecomV1OrderPaymentRequest_universal_d_DeleteOrderPaymentRequestRequest as DeleteOrderPaymentRequestRequest,\n ecomV1OrderPaymentRequest_universal_d_DeleteOrderPaymentRequestResponse as DeleteOrderPaymentRequestResponse,\n ecomV1OrderPaymentRequest_universal_d_QueryOrderPaymentRequestsRequest as QueryOrderPaymentRequestsRequest,\n CursorQuery$4 as CursorQuery,\n CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf,\n Sorting$6 as Sorting,\n SortOrder$6 as SortOrder,\n CursorPaging$6 as CursorPaging,\n ecomV1OrderPaymentRequest_universal_d_QueryOrderPaymentRequestsResponse as QueryOrderPaymentRequestsResponse,\n CursorPagingMetadata$5 as CursorPagingMetadata,\n Cursors$6 as Cursors,\n ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestURLRequest as GetOrderPaymentRequestURLRequest,\n ecomV1OrderPaymentRequest_universal_d_GetOrderPaymentRequestURLResponse as GetOrderPaymentRequestURLResponse,\n UpdateExtendedFieldsRequest$2 as UpdateExtendedFieldsRequest,\n UpdateExtendedFieldsResponse$2 as UpdateExtendedFieldsResponse,\n DomainEvent$8 as DomainEvent,\n DomainEventBodyOneOf$8 as DomainEventBodyOneOf,\n EntityCreatedEvent$8 as EntityCreatedEvent,\n RestoreInfo$8 as RestoreInfo,\n EntityUpdatedEvent$8 as EntityUpdatedEvent,\n EntityDeletedEvent$8 as EntityDeletedEvent,\n ActionEvent$8 as ActionEvent,\n Empty$4 as Empty,\n MessageEnvelope$7 as MessageEnvelope,\n IdentificationData$8 as IdentificationData,\n IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf,\n WebhookIdentityType$7 as WebhookIdentityType,\n ecomV1OrderPaymentRequest_universal_d_createOrderPaymentRequest as createOrderPaymentRequest,\n ecomV1OrderPaymentRequest_universal_d_CreateOrderPaymentRequestOptions as CreateOrderPaymentRequestOptions,\n ecomV1OrderPaymentRequest_universal_d_getOrderPaymentRequest as getOrderPaymentRequest,\n ecomV1OrderPaymentRequest_universal_d_updateOrderPaymentRequest as updateOrderPaymentRequest,\n ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequest as UpdateOrderPaymentRequest,\n ecomV1OrderPaymentRequest_universal_d_UpdateOrderPaymentRequestOptions as UpdateOrderPaymentRequestOptions,\n ecomV1OrderPaymentRequest_universal_d_deleteOrderPaymentRequest as deleteOrderPaymentRequest,\n ecomV1OrderPaymentRequest_universal_d_queryOrderPaymentRequests as queryOrderPaymentRequests,\n ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestsQueryResult as OrderPaymentRequestsQueryResult,\n ecomV1OrderPaymentRequest_universal_d_OrderPaymentRequestsQueryBuilder as OrderPaymentRequestsQueryBuilder,\n ecomV1OrderPaymentRequest_universal_d_getOrderPaymentRequestUrl as getOrderPaymentRequestUrl,\n updateExtendedFields$2 as updateExtendedFields,\n UpdateExtendedFieldsOptions$2 as UpdateExtendedFieldsOptions,\n };\n }\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 * Membership payment details.\n * @internal\n */\n membershipPaymentDetails?: MembershipPaymentDetails;\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 | null;\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 | null;\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 {\n /** Regular payment details. */\n regularPaymentDetails?: RegularPaymentDetails;\n /** Gift card payment details. */\n giftcardPaymentDetails?: GiftCardPaymentDetails;\n /**\n * Membership payment details.\n * @internal\n */\n membershipPaymentDetails?: MembershipPaymentDetails;\n }\n interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {\n /** Whether regular card used */\n creditCardDetails?: CreditCardPaymentMethodDetails;\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 /** Authorization details. */\n authorizationDetails?: AuthorizationDetails;\n }\n /** @oneof */\n interface RegularPaymentDetailsPaymentMethodDetailsOneOf {\n /** Whether regular card used */\n creditCardDetails?: CreditCardPaymentMethodDetails;\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 CreditCardPaymentMethodDetails {\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 AuthorizationDetails {\n /**\n * Whether the authorized payment is of a delayed capture.\n * @readonly\n */\n delayedCapture?: boolean;\n /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n authorizedDate?: Date | null;\n /**\n * List of captures associated with payment\n * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses\n */\n captures?: AuthorizationCapture[];\n /** Void associated with payment */\n void?: AuthorizationVoid;\n /** Scheduled action for this transaction */\n scheduledAction?: ScheduledAction;\n }\n interface AuthorizationCapture {\n /**\n * Capture ID.\n * @readonly\n */\n _id?: string | null;\n /** Status of this capture action */\n status?: AuthorizationCaptureStatus;\n /** Amount of this capture */\n amount?: Price$1;\n /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n _createdDate?: Date | null;\n /** In case of status is FAILED may contain failure details */\n failureDetails?: AuthorizationActionFailureDetails;\n }\n enum AuthorizationCaptureStatus {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Capture operation still in progress. */\n PENDING = \"PENDING\",\n /** Capture operation succeeded. */\n SUCCEEDED = \"SUCCEEDED\",\n /** Capture operation failed. */\n FAILED = \"FAILED\"\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 AuthorizationActionFailureDetails {\n failureCode?: string;\n }\n interface AuthorizationVoid {\n /** Status of this void action */\n status?: AuthorizationVoidStatus;\n /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */\n voidedDate?: Date | null;\n /** In case of status is FAILED may contain failure details */\n failureDetails?: AuthorizationActionFailureDetails;\n /** Reason of void action */\n reason?: Reason;\n }\n enum AuthorizationVoidStatus {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Void operation still in progress. */\n PENDING = \"PENDING\",\n /** Void operation succeeded. */\n SUCCEEDED = \"SUCCEEDED\",\n /** Void operation failed. */\n FAILED = \"FAILED\"\n }\n /** Reason the authorization was voided. */\n enum Reason {\n UNKNOWN_REASON = \"UNKNOWN_REASON\",\n /** Authorization was voided by user. */\n MANUAL = \"MANUAL\",\n /** Authorization passed execution date. */\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 | null;\n }\n enum ActionType {\n UNKNOWN_ACTION_TYPE = \"UNKNOWN_ACTION_TYPE\",\n VOID = \"VOID\",\n CAPTURE = \"CAPTURE\"\n }\n interface GiftCardPaymentDetails {\n /** Gift card payment ID. */\n giftCardPaymentId?: string;\n /**\n * Gift card ID.\n * @internal\n * @deprecated\n */\n giftCardId?: 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 * Gift card obfuscated code.\n * @internal\n */\n obfuscatedCode?: string | null;\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$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 {\n /** Payment was charged. */\n CHARGED = \"CHARGED\",\n /** The attempt to charge the payment failed, for example, due to lack of credits. */\n CHARGE_FAILED = \"CHARGE_FAILED\"\n }\n interface MembershipName$1 {\n /** Membership name. */\n original?: string;\n /** Translated membership name. Defaults to `original` when not provided. */\n translated?: string | null;\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 /**\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 * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Aggregated refund status\n * @internal\n * @readonly\n */\n summary?: AggregatedRefundSummary;\n }\n interface RefundTransaction {\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;\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 /** Refund transaction status. */\n enum RefundStatus {\n /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */\n PENDING = \"PENDING\",\n /** Refund transaction succeeded. */\n SUCCEEDED = \"SUCCEEDED\",\n /** Refund transaction failed. */\n FAILED = \"FAILED\",\n /** Refund request acknowledged, and will be executed soon. */\n SCHEDULED = \"SCHEDULED\",\n /** Refund was initiated on payment provider side. */\n STARTED = \"STARTED\"\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 * Line items that were refunded.\n * @internal\n */\n lineItems?: LineItemRefund[];\n /**\n * Additional fees that were refunded.\n * @internal\n */\n additionalFees?: AdditionalFeeRefund[];\n /**\n * Shipping amount that was refunded.\n * @internal\n */\n shipping?: ShippingRefund;\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 LineItemRefund {\n /**\n * Line item ID.\n * @internal\n */\n lineItemId?: string;\n /**\n * Refund quantity.\n * @internal\n */\n quantity?: number;\n }\n interface AdditionalFeeRefund {\n /**\n * Additional fee ID.\n * @internal\n */\n additionalFeeId?: string;\n /**\n * Refund amount.\n * @internal\n */\n amount?: Price$1;\n }\n interface ShippingRefund {\n /**\n * Refund amount.\n * @internal\n */\n amount?: Price$1;\n }\n interface AggregatedRefundSummary {\n /**\n * Total refund amount requested\n * @internal\n */\n requestedRefund?: Price$1;\n /**\n * Pending refund amount\n * @internal\n */\n pendingRefund?: Price$1;\n /**\n * Refunded amount: portion of requested_refund_amount that succeeded\n * @internal\n */\n refunded?: Price$1;\n /**\n * Failed refund amount: portion of requested_refund_amount that failed\n * @internal\n */\n failedRefundAmount?: Price$1;\n /**\n * `true`: at least one refund transaction is still in PENDING status\n * @internal\n */\n pending?: boolean;\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$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 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 | null;\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$2;\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 * @deprecated\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$1[];\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 | null;\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 * Gift card information.\n * @internal\n */\n giftCard?: GiftCard$1;\n /**\n * ID of the checkout associated with this order.\n * @internal\n */\n checkoutId?: string | null;\n /**\n * Private API flag that allows using read-only \"id\" during order creation\n * @internal\n */\n isInternalOrderCreate?: boolean;\n }\n /** Buyer Info */\n interface BuyerInfo {\n /** Wix customer ID */\n _id?: string | null;\n /**\n * Deprecated (use identityType instead)\n * @readonly\n * @deprecated\n */\n type?: IdentityType$2;\n /** Customer type */\n identityType?: IdentityType$2;\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 * Contact Id. needed for cases where the user is the buyer and so it doesn't exist on the buyer info\n * @internal\n * @readonly\n */\n contactId?: string | null;\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 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 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 * @deprecated\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$4;\n /**\n * Payment date\n * @readonly\n */\n paidDate?: Date | null;\n /** Whether order can be refunded by payment provider (manually or automatic) */\n refundableByPaymentProvider?: boolean | null;\n }\n interface Address$4 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$1;\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$1 {\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$1;\n }\n /** Brazilian tax info types */\n enum VatType$1 {\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$2;\n /** Shipping option name. */\n deliveryOption?: string;\n /** Shipping option delivery time. */\n estimatedDeliveryTime?: string | null;\n /**\n * Deprecated - Latest expected delivery date.\n * @deprecated\n */\n deliverByDate?: Date | null;\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$2;\n }\n interface ShipmentDetails {\n /** Shipping destination address. */\n address?: Address$4;\n /**\n * Deprecated (use fulfillments instead).\n * @readonly\n * @deprecated\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$2 {\n /** Pickup address. */\n pickupAddress?: PickupAddress;\n /**\n * Deprecated (use billingInfo instead).\n * @readonly\n * @deprecated\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$1 {\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 * @deprecated\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 * @deprecated\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 * @deprecated\n */\n taxIncludedInPrice?: boolean;\n /** Tax group ID */\n taxGroupId?: string | null;\n /** Price data */\n priceData?: LineItemPriceData;\n /**\n * Line item refundedQuantity (from refund). No value means not refunded. Shows the number of line items that were refunded\n * @internal\n * @readonly\n */\n refundedQuantity?: number | null;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL\n * @internal\n */\n digitalFile?: DigitalFile;\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 /**\n * Deprecated\n * @deprecated\n */\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 | null;\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 | null;\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 * @deprecated\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$1;\n /** Subscription options info. */\n subscriptionOptionInfo?: SubscriptionOptionInfo;\n }\n interface SubscriptionSettings$1 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$1;\n /**\n * Interval of recurring payment (optional: default value 1 will be used if not provided)\n * @internal\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: 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 SubscriptionOptionInfo {\n /**\n * Subscription option ID.\n * @internal\n */\n _id?: string | null;\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 | null;\n /** Refund amount. */\n amount?: string;\n /** Reason for refund, given by user (optional). */\n reason?: string | null;\n /**\n * Deprecated. Use externalRefund.\n * @internal\n * @deprecated\n */\n isManual?: boolean;\n /**\n * Deprecated. Use payment_provider_transaction_id.\n * @internal\n * @deprecated\n */\n providerTransactionId?: string | null;\n /**\n * Deprecated. Use id.\n * @internal\n * @deprecated\n */\n refundId?: string;\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$1 {\n transactionId?: string;\n /**\n * giftcard internal ID\n * @deprecated giftcard internal ID\n * @targetRemovalDate 2024-12-31\n */\n _id?: string;\n /** giftcard provider appid */\n providerId?: string;\n /** giftcard amount */\n amount?: 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 /** 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 RestockInfo {\n /** Restock type. */\n type?: RestockType;\n /**\n * Deprecated, use items instead\n * @internal\n * @deprecated\n */\n lineItemIds?: string[];\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 RefundCompleted {\n /** Order ID. */\n orderId?: string;\n /** Completed refund. */\n refund?: Refund;\n /** Refund side effects. */\n sideEffects?: RefundSideEffects;\n /** Order transactions after refund is completed. */\n orderTransactions?: OrderTransactions;\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 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 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 AddRefundResponse {\n /** Order ID and its associated transactions. */\n orderTransactions?: OrderTransactions;\n /** Created refund ID */\n refundId?: string;\n }\n interface UpdatePaymentStatusRequest {\n /** Order ID. */\n orderId: string;\n /** Payment ID. */\n paymentId: string;\n /** Payment status. */\n status?: TransactionStatus;\n /**\n * *TBD** NOT IMPLEMENTED\n * Status update date\n * When defined -> the update will be applied only if it's newer than existing one, otherwise will throw 409\n * Not defined -> apply the update without any verification.\n * @internal\n */\n statusUpdatedDate?: Date | null;\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 * *TBD** NOT IMPLEMENTED\n * Status update date\n * When defined -> the update will be applied only if it's newer than existing one, otherwise will throw 409\n * Not defined -> apply the update without any verification.\n * @internal\n */\n statusUpdatedDate?: Date | null;\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$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 {\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 UpdateRefundRequest {\n /** Order ID. */\n orderId: string;\n /** Refund with updated field values. */\n refund: Refund;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateRefundResponse {\n /** Refund after update. */\n refund?: Refund;\n /** Order transactions after update. */\n orderTransactions?: OrderTransactions;\n }\n interface UpdateRefundTransactionRequest {\n /**\n * Order ID.\n * @internal\n */\n orderId: string;\n /**\n * Payment ID.\n * @internal\n */\n refundId: string;\n /**\n * Updated refund transaction\n * @internal\n */\n transaction: RefundTransaction;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateRefundTransactionResponse {\n /**\n * OrderTransactions with updated refund transaction\n * @internal\n */\n orderTransactions?: OrderTransactions;\n }\n interface UpdatePaymentsRequest {\n /**\n * Order ID.\n * @internal\n */\n orderId: string;\n /**\n * Payments to be updated\n * @internal\n */\n payments: MaskedPayment[];\n }\n interface MaskedPayment {\n /**\n * Updated payment\n * @internal\n */\n payment?: Payment;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /**\n * Status update date\n * When defined -> the update will be applied only if it's newer than existing one, otherwise will throw error\n * Not defined -> apply the update without any verification.\n * @internal\n */\n statusUpdatedDate?: Date | null;\n }\n interface UpdatePaymentsResponse {\n /**\n * OrderTransactions with updated payments\n * @internal\n */\n orderTransactions?: OrderTransactions;\n }\n interface QueryOrderTransactionsRequest {\n /**\n * Query options.\n * @internal\n */\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$5;\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 /**\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$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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$5 {\n /** Ascending order. */\n ASC = \"ASC\",\n /** Descending order. */\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 QueryOrderTransactionsResponse {\n /**\n * Order transactions.\n * @internal\n */\n orderTransactions?: OrderTransactions[];\n /**\n * Details on the paged set of results returned.\n * @internal\n */\n metadata?: CursorPagingMetadata$4;\n }\n interface CursorPagingMetadata$4 {\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 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 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 * Gateway refund id. When param is present, new refund is not created.\n * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,\n * and all side effects from request will be executed.\n * @internal\n */\n gatewayRefundId?: string | null;\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 * Payment ID's that the refund execution had failed for\n * @internal\n * @deprecated\n */\n failedPaymentIds?: 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. */\n NOT_REFUNDABLE = \"NOT_REFUNDABLE\",\n /** Refundable manually. */\n MANUAL = \"MANUAL\",\n /** Refundable. */\n REFUNDABLE = \"REFUNDABLE\"\n }\n enum NonRefundableReason {\n /** No reason. */\n NONE = \"NONE\",\n /** Payment already refunded. */\n ALREADY_REFUNDED = \"ALREADY_REFUNDED\",\n /** Payment provider is down. */\n PROVIDER_IS_DOWN = \"PROVIDER_IS_DOWN\",\n /** Internal error occurred. */\n INTERNAL_ERROR = \"INTERNAL_ERROR\",\n /** Payment not made. */\n NOT_PAID = \"NOT_PAID\",\n /** Access denied. */\n ACCESS_DENIED = \"ACCESS_DENIED\",\n /** Payment amount is zero. */\n ZERO_PRICE = \"ZERO_PRICE\",\n /** Disabled by provider. */\n DISABLED_BY_PROVIDER = \"DISABLED_BY_PROVIDER\",\n /** Payment partially paid. */\n PARTIALLY_PAID = \"PARTIALLY_PAID\",\n /** Deposit for online item. */\n DEPOSIT_ONLINE_ITEM = \"DEPOSIT_ONLINE_ITEM\",\n /** Refund is pending. */\n PENDING_REFUND = \"PENDING_REFUND\",\n /** Action forbidden. */\n FORBIDDEN = \"FORBIDDEN\"\n }\n enum ManuallyRefundableReason {\n /** Payment expired. */\n EXPIRED = \"EXPIRED\",\n /** Payment method not supported. */\n NOT_SUPPORTED = \"NOT_SUPPORTED\",\n /** Payment not found. */\n NOT_FOUND = \"NOT_FOUND\",\n /** Payment made offline. */\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 /**\n * Invoice URL.\n * @deprecated\n */\n url?: string | null;\n /**\n * Invoice creation date and time.\n * @deprecated\n */\n _createdDate?: Date | null;\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$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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$7;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$7 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$7 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$7 {\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$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$6;\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$6 {\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 * @permissionId ECOM.READ_TRANSACTIONS\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 * @permissionId ECOM.READ_TRANSACTIONS\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 * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function addPayments(orderId: string, payments: Payment[]): Promise;\n /**\n * Add refunds for payments for an order and changes payments statuses accordingly\n * @param orderId - Order ID this refunds related to\n * @param refund - Refund with refund transactions to be added to order.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField refund\n * @requiredField refund.transactions\n * @requiredField refund.transactions.paymentId\n * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function addRefund(orderId: string, refund: Refund, options?: AddRefundOptions): 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 * @permissionId ECOM.MODIFY_TRANSACTIONS\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 * *TBD** NOT IMPLEMENTED\n * Status update date\n * When defined -> the update will be applied only if it's newer than existing one, otherwise will throw 409\n * Not defined -> apply the update without any verification.\n * @internal\n */\n statusUpdatedDate?: Date | null;\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 * @permissionId ECOM.MODIFY_TRANSACTIONS\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 * *TBD** NOT IMPLEMENTED\n * Status update date\n * When defined -> the update will be applied only if it's newer than existing one, otherwise will throw 409\n * Not defined -> apply the update without any verification.\n * @internal\n */\n statusUpdatedDate?: Date | null;\n }\n /**\n * Updates OrderTransactions.refunds properties, except OrderTransactions.refunds.transactions, which are updated\n * via UpdateRefundTransaction endpoint\n * @param orderId - Order ID.\n * @param refund - Refund with updated field values.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField refund\n * @requiredField refund._id\n * @requiredField refund.details.items.lineItemId\n * @requiredField refund.details.items.quantity\n * @permissionId ECOM.ORDER_TRANSACTIONS_UPDATE_REFUND\n * @adminMethod\n */\n function updateRefund(orderId: string, refund: Refund, options?: UpdateRefundOptions): Promise;\n interface UpdateRefundOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Updates OrderTransactions.refunds.transactions properties\n * @param orderId - Order ID.\n * @param refundId - Payment ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField refundId\n * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function updateRefundTransaction(orderId: string, refundId: string, options?: UpdateRefundTransactionOptions): Promise;\n interface UpdateRefundTransactionOptions {\n /**\n * Updated refund transaction\n * @internal\n */\n transaction: RefundTransaction;\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Updates properties of payments associated to order.\n *\n * Currently, the following fields can be updated:\n * + `payment.payment_details.regular_payment_details.provider_transaction_id`\n * + `payment.payment_details.regular_payment_details.status`\n * + `payment.payment_details.regular_payment_details.payment_method_details.credit_card_details`\n * + `payment.payment_details.regular_payment_details.authorization_details`\n * + `payment.payment_details.regular_payment_details.authorization_details.scheduled_action`\n * + `payment.payment_details.regular_payment_details.authorization_details.authorized_date`\n * + `payment.payment_details.regular_payment_details.authorization_details.captures`\n * + `payment.payment_details.regular_payment_details.authorization_details.captures.status`\n * + `payment.payment_details.regular_payment_details.authorization_details.captures.created_date`\n * + `payment.payment_details.regular_payment_details.authorization_details.captures.failure_details`\n * + `payment.payment_details.regular_payment_details.authorization_details.void`\n * + `payment.payment_details.regular_payment_details.authorization_details.void.status`\n * + `payment.payment_details.regular_payment_details.authorization_details.void.voided_date`\n * + `payment.payment_details.regular_payment_details.authorization_details.void.reason`\n * + `payment.payment_details.regular_payment_details.authorization_details.void.failure_details`\n *\n * To update a field's value, include the new value in the `payment` object in the body params.\n *\n * > **Note:** Removing fields value results in an error.\n * @param orderId - Order ID.\n * @param payments - Payments to be updated\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField payments\n * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function updatePayments(orderId: string, payments: MaskedPayment[]): Promise;\n /**\n * Retrieves a list of order transactions, given the provided paging, filtering, and sorting.\n *\n * To learn about working with _Query_ 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 * @internal\n * @documentationMaturity preview\n * @permissionId ECOM.READ_TRANSACTIONS\n * @adminMethod\n */\n function queryOrderTransactions(): OrderTransactionsQueryBuilder;\n interface QueryCursorResult$5 {\n cursors: Cursors$5;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OrderTransactionsQueryResult extends QueryCursorResult$5 {\n items: OrderTransactions[];\n query: OrderTransactionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface OrderTransactionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'orderId', value: any) => OrderTransactionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'orderId', value: any) => OrderTransactionsQueryBuilder;\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: 'orderId', value: string) => OrderTransactionsQueryBuilder;\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: 'orderId', value: any[]) => OrderTransactionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'orderId', value: any) => OrderTransactionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'orderId', value: boolean) => OrderTransactionsQueryBuilder;\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<'orderId'>) => OrderTransactionsQueryBuilder;\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<'orderId'>) => OrderTransactionsQueryBuilder;\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) => OrderTransactionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => OrderTransactionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Triggers one or more refunds on an order and updates the order's transactions record.\n * @param orderId - The order this refund related to\n * @param payments - Refund operations information\n * Currently, only *one* payment refund is supported per request\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField payments\n * @requiredField payments.paymentId\n * @permissionId ECOM.MODIFY_TRANSACTIONS\n * @adminMethod\n */\n function triggerRefund(orderId: string, payments: PaymentRefund[], options?: TriggerRefundOptions): Promise;\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 /**\n * Calculates what amount can still be refunded on this order.\n * @param orderId - Order ID\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.READ_TRANSACTIONS\n * @adminMethod\n */\n function calculateRefund(orderId: string, options?: CalculateRefundOptions): Promise;\n interface CalculateRefundOptions {\n /** Refunded line items and quantity */\n refundItems?: CalculateRefundItemRequest[];\n /** Should include shipping in refund calculation */\n refundShipping?: boolean;\n }\n /**\n * Checks whether this order can be refunded.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.READ_TRANSACTIONS\n * @adminMethod\n */\n function getRefundabilityStatus(orderId: string): Promise;\n /**\n * Retrieves invoices associated with a specified order.\n * !!! Deprecated !!!\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.READ_INVOICES\n */\n function listInvoicesForSingleOrder(orderId: string): Promise;\n /**\n * Retrieves invoices associated with all specified orders.\n * !!! Deprecated !!!\n * @param orderIds - Order IDs for which to retrieve invoices.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionId ECOM.READ_INVOICES\n */\n function listInvoicesForMultipleOrders(orderIds: string[]): Promise;\n /**\n * Retrieves invoices associated with all specified orders.\n * !!! Deprecated !!!\n * @param orderIds - Order IDs for which to retrieve invoices.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionId ECOM.READ_INVOICES\n */\n function listInvoicesForMultipleOrdersOld(orderIds: string[]): Promise;\n /**\n * Generates and adds an invoice to a specified order.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId ECOM.MODIFY_INVOICES\n * @adminMethod\n */\n function generateInvoice(orderId: string): Promise;\n /**\n * Generates and adds invoices to all specified orders.\n * @param orderIds - Order IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderIds\n * @permissionId ECOM.MODIFY_INVOICES\n * @adminMethod\n */\n function bulkGenerateInvoices(orderIds: string[]): Promise;\n /**\n * Adds an invoice to a specified order.\n * @param orderId - Order ID.\n * @param invoiceInfo - Invoice info.\n * @internal\n * @documentationMaturity preview\n * @requiredField invoiceInfo\n * @requiredField invoiceInfo._id\n * @requiredField invoiceInfo.appId\n * @requiredField orderId\n * @permissionId ECOM.ADD_INVOICE\n * @adminMethod\n */\n function addInvoiceToOrder(orderId: string, invoiceInfo: InvoiceInfo): Promise;\n \n type ecomV1OrderTransactions_universal_d_OrderTransactions = OrderTransactions;\n type ecomV1OrderTransactions_universal_d_Payment = Payment;\n type ecomV1OrderTransactions_universal_d_PaymentPaymentDetailsOneOf = PaymentPaymentDetailsOneOf;\n type ecomV1OrderTransactions_universal_d_RegularPaymentDetails = RegularPaymentDetails;\n type ecomV1OrderTransactions_universal_d_RegularPaymentDetailsPaymentMethodDetailsOneOf = RegularPaymentDetailsPaymentMethodDetailsOneOf;\n type ecomV1OrderTransactions_universal_d_TransactionStatus = TransactionStatus;\n const ecomV1OrderTransactions_universal_d_TransactionStatus: typeof TransactionStatus;\n type ecomV1OrderTransactions_universal_d_CreditCardPaymentMethodDetails = CreditCardPaymentMethodDetails;\n type ecomV1OrderTransactions_universal_d_AuthorizationDetails = AuthorizationDetails;\n type ecomV1OrderTransactions_universal_d_AuthorizationCapture = AuthorizationCapture;\n type ecomV1OrderTransactions_universal_d_AuthorizationCaptureStatus = AuthorizationCaptureStatus;\n const ecomV1OrderTransactions_universal_d_AuthorizationCaptureStatus: typeof AuthorizationCaptureStatus;\n type ecomV1OrderTransactions_universal_d_AuthorizationActionFailureDetails = AuthorizationActionFailureDetails;\n type ecomV1OrderTransactions_universal_d_AuthorizationVoid = AuthorizationVoid;\n type ecomV1OrderTransactions_universal_d_AuthorizationVoidStatus = AuthorizationVoidStatus;\n const ecomV1OrderTransactions_universal_d_AuthorizationVoidStatus: typeof AuthorizationVoidStatus;\n type ecomV1OrderTransactions_universal_d_Reason = Reason;\n const ecomV1OrderTransactions_universal_d_Reason: typeof Reason;\n type ecomV1OrderTransactions_universal_d_ScheduledAction = ScheduledAction;\n type ecomV1OrderTransactions_universal_d_ActionType = ActionType;\n const ecomV1OrderTransactions_universal_d_ActionType: typeof ActionType;\n type ecomV1OrderTransactions_universal_d_GiftCardPaymentDetails = GiftCardPaymentDetails;\n type ecomV1OrderTransactions_universal_d_MembershipPaymentDetails = MembershipPaymentDetails;\n type ecomV1OrderTransactions_universal_d_MembershipPaymentStatus = MembershipPaymentStatus;\n const ecomV1OrderTransactions_universal_d_MembershipPaymentStatus: typeof MembershipPaymentStatus;\n type ecomV1OrderTransactions_universal_d_Refund = Refund;\n type ecomV1OrderTransactions_universal_d_RefundTransaction = RefundTransaction;\n type ecomV1OrderTransactions_universal_d_RefundStatus = RefundStatus;\n const ecomV1OrderTransactions_universal_d_RefundStatus: typeof RefundStatus;\n type ecomV1OrderTransactions_universal_d_RefundDetails = RefundDetails;\n type ecomV1OrderTransactions_universal_d_RefundItem = RefundItem;\n type ecomV1OrderTransactions_universal_d_LineItemRefund = LineItemRefund;\n type ecomV1OrderTransactions_universal_d_AdditionalFeeRefund = AdditionalFeeRefund;\n type ecomV1OrderTransactions_universal_d_ShippingRefund = ShippingRefund;\n type ecomV1OrderTransactions_universal_d_AggregatedRefundSummary = AggregatedRefundSummary;\n type ecomV1OrderTransactions_universal_d_SnapshotMessage = SnapshotMessage;\n type ecomV1OrderTransactions_universal_d_IndexingMessage = IndexingMessage;\n type ecomV1OrderTransactions_universal_d_OrderRefunded = OrderRefunded;\n type ecomV1OrderTransactions_universal_d_Order = Order;\n type ecomV1OrderTransactions_universal_d_BuyerInfo = BuyerInfo;\n type ecomV1OrderTransactions_universal_d_Totals = Totals;\n type ecomV1OrderTransactions_universal_d_BillingInfo = BillingInfo;\n type ecomV1OrderTransactions_universal_d_AddressAddressLine1OptionsOneOf = AddressAddressLine1OptionsOneOf;\n type ecomV1OrderTransactions_universal_d_FullName = FullName;\n type ecomV1OrderTransactions_universal_d_Street = Street;\n type ecomV1OrderTransactions_universal_d_ShippingInfo = ShippingInfo;\n type ecomV1OrderTransactions_universal_d_ShippingInfoDetailsOneOf = ShippingInfoDetailsOneOf;\n type ecomV1OrderTransactions_universal_d_ShipmentDetails = ShipmentDetails;\n type ecomV1OrderTransactions_universal_d_TrackingInfo = TrackingInfo;\n type ecomV1OrderTransactions_universal_d_ShippingPriceData = ShippingPriceData;\n type ecomV1OrderTransactions_universal_d_PickupAddress = PickupAddress;\n type ecomV1OrderTransactions_universal_d_BuyerDetails = BuyerDetails;\n type ecomV1OrderTransactions_universal_d_PaymentStatus = PaymentStatus;\n const ecomV1OrderTransactions_universal_d_PaymentStatus: typeof PaymentStatus;\n type ecomV1OrderTransactions_universal_d_FulfillmentStatus = FulfillmentStatus;\n const ecomV1OrderTransactions_universal_d_FulfillmentStatus: typeof FulfillmentStatus;\n type ecomV1OrderTransactions_universal_d_LineItemType = LineItemType;\n const ecomV1OrderTransactions_universal_d_LineItemType: typeof LineItemType;\n type ecomV1OrderTransactions_universal_d_OptionSelection = OptionSelection;\n type ecomV1OrderTransactions_universal_d_CustomTextFieldSelection = CustomTextFieldSelection;\n type ecomV1OrderTransactions_universal_d_MediaItem = MediaItem;\n type ecomV1OrderTransactions_universal_d_MediaItemType = MediaItemType;\n const ecomV1OrderTransactions_universal_d_MediaItemType: typeof MediaItemType;\n type ecomV1OrderTransactions_universal_d_LineItemPriceData = LineItemPriceData;\n type ecomV1OrderTransactions_universal_d_DigitalFile = DigitalFile;\n type ecomV1OrderTransactions_universal_d_Activity = Activity;\n type ecomV1OrderTransactions_universal_d_ActivityType = ActivityType;\n const ecomV1OrderTransactions_universal_d_ActivityType: typeof ActivityType;\n type ecomV1OrderTransactions_universal_d_V2InvoiceInfo = V2InvoiceInfo;\n type ecomV1OrderTransactions_universal_d_InvoiceSource = InvoiceSource;\n const ecomV1OrderTransactions_universal_d_InvoiceSource: typeof InvoiceSource;\n type ecomV1OrderTransactions_universal_d_Fulfillment = Fulfillment;\n type ecomV1OrderTransactions_universal_d_FulfillmentLineItem = FulfillmentLineItem;\n type ecomV1OrderTransactions_universal_d_FulfillmentTrackingInfo = FulfillmentTrackingInfo;\n type ecomV1OrderTransactions_universal_d_Discount = Discount;\n type ecomV1OrderTransactions_universal_d_AppliedCoupon = AppliedCoupon;\n type ecomV1OrderTransactions_universal_d_CustomField = CustomField;\n type ecomV1OrderTransactions_universal_d_ChannelInfo = ChannelInfo;\n type ecomV1OrderTransactions_universal_d_ChannelType = ChannelType;\n const ecomV1OrderTransactions_universal_d_ChannelType: typeof ChannelType;\n type ecomV1OrderTransactions_universal_d_EnteredBy = EnteredBy;\n type ecomV1OrderTransactions_universal_d_EnteredByIdentityType = EnteredByIdentityType;\n const ecomV1OrderTransactions_universal_d_EnteredByIdentityType: typeof EnteredByIdentityType;\n type ecomV1OrderTransactions_universal_d_SubscriptionInfo = SubscriptionInfo;\n type ecomV1OrderTransactions_universal_d_SubscriptionOptionInfo = SubscriptionOptionInfo;\n type ecomV1OrderTransactions_universal_d_V2Refund = V2Refund;\n type ecomV1OrderTransactions_universal_d_PaymentsUpdated = PaymentsUpdated;\n type ecomV1OrderTransactions_universal_d_RefundCreated = RefundCreated;\n type ecomV1OrderTransactions_universal_d_RestockInfo = RestockInfo;\n type ecomV1OrderTransactions_universal_d_RestockType = RestockType;\n const ecomV1OrderTransactions_universal_d_RestockType: typeof RestockType;\n type ecomV1OrderTransactions_universal_d_RestockItem = RestockItem;\n type ecomV1OrderTransactions_universal_d_RefundCompleted = RefundCompleted;\n type ecomV1OrderTransactions_universal_d_RefundSideEffects = RefundSideEffects;\n type ecomV1OrderTransactions_universal_d_ListTransactionsForSingleOrderRequest = ListTransactionsForSingleOrderRequest;\n type ecomV1OrderTransactions_universal_d_ListTransactionsForSingleOrderResponse = ListTransactionsForSingleOrderResponse;\n type ecomV1OrderTransactions_universal_d_ListTransactionsForMultipleOrdersRequest = ListTransactionsForMultipleOrdersRequest;\n type ecomV1OrderTransactions_universal_d_ListTransactionsForMultipleOrdersResponse = ListTransactionsForMultipleOrdersResponse;\n type ecomV1OrderTransactions_universal_d_AddPaymentsRequest = AddPaymentsRequest;\n type ecomV1OrderTransactions_universal_d_AddPaymentsResponse = AddPaymentsResponse;\n type ecomV1OrderTransactions_universal_d_AddRefundRequest = AddRefundRequest;\n type ecomV1OrderTransactions_universal_d_AddRefundResponse = AddRefundResponse;\n type ecomV1OrderTransactions_universal_d_UpdatePaymentStatusRequest = UpdatePaymentStatusRequest;\n type ecomV1OrderTransactions_universal_d_UpdatePaymentStatusResponse = UpdatePaymentStatusResponse;\n type ecomV1OrderTransactions_universal_d_BulkUpdatePaymentStatusesRequest = BulkUpdatePaymentStatusesRequest;\n type ecomV1OrderTransactions_universal_d_PaymentAndOrderId = PaymentAndOrderId;\n type ecomV1OrderTransactions_universal_d_BulkUpdatePaymentStatusesResponse = BulkUpdatePaymentStatusesResponse;\n type ecomV1OrderTransactions_universal_d_BulkPaymentResult = BulkPaymentResult;\n type ecomV1OrderTransactions_universal_d_ItemMetadata = ItemMetadata;\n type ecomV1OrderTransactions_universal_d_BulkActionMetadata = BulkActionMetadata;\n type ecomV1OrderTransactions_universal_d_UpdateRefundRequest = UpdateRefundRequest;\n type ecomV1OrderTransactions_universal_d_UpdateRefundResponse = UpdateRefundResponse;\n type ecomV1OrderTransactions_universal_d_UpdateRefundTransactionRequest = UpdateRefundTransactionRequest;\n type ecomV1OrderTransactions_universal_d_UpdateRefundTransactionResponse = UpdateRefundTransactionResponse;\n type ecomV1OrderTransactions_universal_d_UpdatePaymentsRequest = UpdatePaymentsRequest;\n type ecomV1OrderTransactions_universal_d_MaskedPayment = MaskedPayment;\n type ecomV1OrderTransactions_universal_d_UpdatePaymentsResponse = UpdatePaymentsResponse;\n type ecomV1OrderTransactions_universal_d_QueryOrderTransactionsRequest = QueryOrderTransactionsRequest;\n type ecomV1OrderTransactions_universal_d_QueryOrderTransactionsResponse = QueryOrderTransactionsResponse;\n type ecomV1OrderTransactions_universal_d_TriggerRefundRequest = TriggerRefundRequest;\n type ecomV1OrderTransactions_universal_d_PaymentRefund = PaymentRefund;\n type ecomV1OrderTransactions_universal_d_TriggerRefundResponse = TriggerRefundResponse;\n type ecomV1OrderTransactions_universal_d_CalculateRefundRequest = CalculateRefundRequest;\n type ecomV1OrderTransactions_universal_d_CalculateRefundItemRequest = CalculateRefundItemRequest;\n type ecomV1OrderTransactions_universal_d_CalculateRefundResponse = CalculateRefundResponse;\n type ecomV1OrderTransactions_universal_d_CalculateRefundItemResponse = CalculateRefundItemResponse;\n type ecomV1OrderTransactions_universal_d_GetRefundabilityStatusRequest = GetRefundabilityStatusRequest;\n type ecomV1OrderTransactions_universal_d_GetRefundabilityStatusResponse = GetRefundabilityStatusResponse;\n type ecomV1OrderTransactions_universal_d_Refundability = Refundability;\n type ecomV1OrderTransactions_universal_d_RefundabilityAdditionalRefundabilityInfoOneOf = RefundabilityAdditionalRefundabilityInfoOneOf;\n type ecomV1OrderTransactions_universal_d_RefundableStatus = RefundableStatus;\n const ecomV1OrderTransactions_universal_d_RefundableStatus: typeof RefundableStatus;\n type ecomV1OrderTransactions_universal_d_NonRefundableReason = NonRefundableReason;\n const ecomV1OrderTransactions_universal_d_NonRefundableReason: typeof NonRefundableReason;\n type ecomV1OrderTransactions_universal_d_ManuallyRefundableReason = ManuallyRefundableReason;\n const ecomV1OrderTransactions_universal_d_ManuallyRefundableReason: typeof ManuallyRefundableReason;\n type ecomV1OrderTransactions_universal_d_ListInvoicesForSingleOrderRequest = ListInvoicesForSingleOrderRequest;\n type ecomV1OrderTransactions_universal_d_ListInvoicesForSingleOrderResponse = ListInvoicesForSingleOrderResponse;\n type ecomV1OrderTransactions_universal_d_InvoiceInfo = InvoiceInfo;\n type ecomV1OrderTransactions_universal_d_ListInvoicesForMultipleOrdersRequest = ListInvoicesForMultipleOrdersRequest;\n type ecomV1OrderTransactions_universal_d_ListInvoicesForMultipleOrdersResponse = ListInvoicesForMultipleOrdersResponse;\n type ecomV1OrderTransactions_universal_d_InvoicesForOrder = InvoicesForOrder;\n type ecomV1OrderTransactions_universal_d_GenerateInvoiceRequest = GenerateInvoiceRequest;\n type ecomV1OrderTransactions_universal_d_GenerateInvoiceResponse = GenerateInvoiceResponse;\n type ecomV1OrderTransactions_universal_d_BulkGenerateInvoicesRequest = BulkGenerateInvoicesRequest;\n type ecomV1OrderTransactions_universal_d_BulkGenerateInvoicesResponse = BulkGenerateInvoicesResponse;\n type ecomV1OrderTransactions_universal_d_BulkInvoiceResult = BulkInvoiceResult;\n type ecomV1OrderTransactions_universal_d_InvoiceForOrder = InvoiceForOrder;\n type ecomV1OrderTransactions_universal_d_AddInvoiceToOrderRequest = AddInvoiceToOrderRequest;\n type ecomV1OrderTransactions_universal_d_AddInvoiceToOrderResponse = AddInvoiceToOrderResponse;\n const ecomV1OrderTransactions_universal_d_listTransactionsForSingleOrder: typeof listTransactionsForSingleOrder;\n const ecomV1OrderTransactions_universal_d_listTransactionsForMultipleOrders: typeof listTransactionsForMultipleOrders;\n const ecomV1OrderTransactions_universal_d_addPayments: typeof addPayments;\n const ecomV1OrderTransactions_universal_d_addRefund: typeof addRefund;\n type ecomV1OrderTransactions_universal_d_AddRefundOptions = AddRefundOptions;\n const ecomV1OrderTransactions_universal_d_updatePaymentStatus: typeof updatePaymentStatus;\n type ecomV1OrderTransactions_universal_d_UpdatePaymentStatusIdentifiers = UpdatePaymentStatusIdentifiers;\n type ecomV1OrderTransactions_universal_d_UpdatePaymentStatusOptions = UpdatePaymentStatusOptions;\n const ecomV1OrderTransactions_universal_d_bulkUpdatePaymentStatuses: typeof bulkUpdatePaymentStatuses;\n type ecomV1OrderTransactions_universal_d_BulkUpdatePaymentStatusesOptions = BulkUpdatePaymentStatusesOptions;\n const ecomV1OrderTransactions_universal_d_updateRefund: typeof updateRefund;\n type ecomV1OrderTransactions_universal_d_UpdateRefundOptions = UpdateRefundOptions;\n const ecomV1OrderTransactions_universal_d_updateRefundTransaction: typeof updateRefundTransaction;\n type ecomV1OrderTransactions_universal_d_UpdateRefundTransactionOptions = UpdateRefundTransactionOptions;\n const ecomV1OrderTransactions_universal_d_updatePayments: typeof updatePayments;\n const ecomV1OrderTransactions_universal_d_queryOrderTransactions: typeof queryOrderTransactions;\n type ecomV1OrderTransactions_universal_d_OrderTransactionsQueryResult = OrderTransactionsQueryResult;\n type ecomV1OrderTransactions_universal_d_OrderTransactionsQueryBuilder = OrderTransactionsQueryBuilder;\n const ecomV1OrderTransactions_universal_d_triggerRefund: typeof triggerRefund;\n type ecomV1OrderTransactions_universal_d_TriggerRefundOptions = TriggerRefundOptions;\n const ecomV1OrderTransactions_universal_d_calculateRefund: typeof calculateRefund;\n type ecomV1OrderTransactions_universal_d_CalculateRefundOptions = CalculateRefundOptions;\n const ecomV1OrderTransactions_universal_d_getRefundabilityStatus: typeof getRefundabilityStatus;\n const ecomV1OrderTransactions_universal_d_listInvoicesForSingleOrder: typeof listInvoicesForSingleOrder;\n const ecomV1OrderTransactions_universal_d_listInvoicesForMultipleOrders: typeof listInvoicesForMultipleOrders;\n const ecomV1OrderTransactions_universal_d_listInvoicesForMultipleOrdersOld: typeof listInvoicesForMultipleOrdersOld;\n const ecomV1OrderTransactions_universal_d_generateInvoice: typeof generateInvoice;\n const ecomV1OrderTransactions_universal_d_bulkGenerateInvoices: typeof bulkGenerateInvoices;\n const ecomV1OrderTransactions_universal_d_addInvoiceToOrder: typeof addInvoiceToOrder;\n namespace ecomV1OrderTransactions_universal_d {\n export {\n ecomV1OrderTransactions_universal_d_OrderTransactions as OrderTransactions,\n ecomV1OrderTransactions_universal_d_Payment as Payment,\n ecomV1OrderTransactions_universal_d_PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOf,\n ecomV1OrderTransactions_universal_d_RegularPaymentDetails as RegularPaymentDetails,\n ecomV1OrderTransactions_universal_d_RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOf,\n ecomV1OrderTransactions_universal_d_TransactionStatus as TransactionStatus,\n ecomV1OrderTransactions_universal_d_CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetails,\n ecomV1OrderTransactions_universal_d_AuthorizationDetails as AuthorizationDetails,\n ecomV1OrderTransactions_universal_d_AuthorizationCapture as AuthorizationCapture,\n ecomV1OrderTransactions_universal_d_AuthorizationCaptureStatus as AuthorizationCaptureStatus,\n Price$1 as Price,\n ecomV1OrderTransactions_universal_d_AuthorizationActionFailureDetails as AuthorizationActionFailureDetails,\n ecomV1OrderTransactions_universal_d_AuthorizationVoid as AuthorizationVoid,\n ecomV1OrderTransactions_universal_d_AuthorizationVoidStatus as AuthorizationVoidStatus,\n ecomV1OrderTransactions_universal_d_Reason as Reason,\n ecomV1OrderTransactions_universal_d_ScheduledAction as ScheduledAction,\n ecomV1OrderTransactions_universal_d_ActionType as ActionType,\n ecomV1OrderTransactions_universal_d_GiftCardPaymentDetails as GiftCardPaymentDetails,\n ecomV1OrderTransactions_universal_d_MembershipPaymentDetails as MembershipPaymentDetails,\n ecomV1OrderTransactions_universal_d_MembershipPaymentStatus as MembershipPaymentStatus,\n MembershipName$1 as MembershipName,\n ecomV1OrderTransactions_universal_d_Refund as Refund,\n ecomV1OrderTransactions_universal_d_RefundTransaction as RefundTransaction,\n ecomV1OrderTransactions_universal_d_RefundStatus as RefundStatus,\n ecomV1OrderTransactions_universal_d_RefundDetails as RefundDetails,\n ecomV1OrderTransactions_universal_d_RefundItem as RefundItem,\n ecomV1OrderTransactions_universal_d_LineItemRefund as LineItemRefund,\n ecomV1OrderTransactions_universal_d_AdditionalFeeRefund as AdditionalFeeRefund,\n ecomV1OrderTransactions_universal_d_ShippingRefund as ShippingRefund,\n ecomV1OrderTransactions_universal_d_AggregatedRefundSummary as AggregatedRefundSummary,\n ecomV1OrderTransactions_universal_d_SnapshotMessage as SnapshotMessage,\n ecomV1OrderTransactions_universal_d_IndexingMessage as IndexingMessage,\n DiffmatokyPayload$1 as DiffmatokyPayload,\n ErrorInformation$1 as ErrorInformation,\n ecomV1OrderTransactions_universal_d_OrderRefunded as OrderRefunded,\n ecomV1OrderTransactions_universal_d_Order as Order,\n ecomV1OrderTransactions_universal_d_BuyerInfo as BuyerInfo,\n IdentityType$2 as IdentityType,\n WeightUnit$2 as WeightUnit,\n ecomV1OrderTransactions_universal_d_Totals as Totals,\n ecomV1OrderTransactions_universal_d_BillingInfo as BillingInfo,\n Address$4 as Address,\n ecomV1OrderTransactions_universal_d_AddressAddressLine1OptionsOneOf as AddressAddressLine1OptionsOneOf,\n ecomV1OrderTransactions_universal_d_FullName as FullName,\n ecomV1OrderTransactions_universal_d_Street as Street,\n VatId$1 as VatId,\n VatType$1 as VatType,\n ecomV1OrderTransactions_universal_d_ShippingInfo as ShippingInfo,\n ecomV1OrderTransactions_universal_d_ShippingInfoDetailsOneOf as ShippingInfoDetailsOneOf,\n ecomV1OrderTransactions_universal_d_ShipmentDetails as ShipmentDetails,\n ecomV1OrderTransactions_universal_d_TrackingInfo as TrackingInfo,\n ecomV1OrderTransactions_universal_d_ShippingPriceData as ShippingPriceData,\n PickupDetails$2 as PickupDetails,\n ecomV1OrderTransactions_universal_d_PickupAddress as PickupAddress,\n ecomV1OrderTransactions_universal_d_BuyerDetails as BuyerDetails,\n ecomV1OrderTransactions_universal_d_PaymentStatus as PaymentStatus,\n ecomV1OrderTransactions_universal_d_FulfillmentStatus as FulfillmentStatus,\n LineItem$1 as LineItem,\n ecomV1OrderTransactions_universal_d_LineItemType as LineItemType,\n ecomV1OrderTransactions_universal_d_OptionSelection as OptionSelection,\n ecomV1OrderTransactions_universal_d_CustomTextFieldSelection as CustomTextFieldSelection,\n ecomV1OrderTransactions_universal_d_MediaItem as MediaItem,\n ecomV1OrderTransactions_universal_d_MediaItemType as MediaItemType,\n ecomV1OrderTransactions_universal_d_LineItemPriceData as LineItemPriceData,\n ecomV1OrderTransactions_universal_d_DigitalFile as DigitalFile,\n ecomV1OrderTransactions_universal_d_Activity as Activity,\n ecomV1OrderTransactions_universal_d_ActivityType as ActivityType,\n ecomV1OrderTransactions_universal_d_V2InvoiceInfo as V2InvoiceInfo,\n ecomV1OrderTransactions_universal_d_InvoiceSource as InvoiceSource,\n ecomV1OrderTransactions_universal_d_Fulfillment as Fulfillment,\n ecomV1OrderTransactions_universal_d_FulfillmentLineItem as FulfillmentLineItem,\n ecomV1OrderTransactions_universal_d_FulfillmentTrackingInfo as FulfillmentTrackingInfo,\n ecomV1OrderTransactions_universal_d_Discount as Discount,\n ecomV1OrderTransactions_universal_d_AppliedCoupon as AppliedCoupon,\n ecomV1OrderTransactions_universal_d_CustomField as CustomField,\n ecomV1OrderTransactions_universal_d_ChannelInfo as ChannelInfo,\n ecomV1OrderTransactions_universal_d_ChannelType as ChannelType,\n ecomV1OrderTransactions_universal_d_EnteredBy as EnteredBy,\n ecomV1OrderTransactions_universal_d_EnteredByIdentityType as EnteredByIdentityType,\n ecomV1OrderTransactions_universal_d_SubscriptionInfo as SubscriptionInfo,\n SubscriptionSettings$1 as SubscriptionSettings,\n SubscriptionFrequency$1 as SubscriptionFrequency,\n ecomV1OrderTransactions_universal_d_SubscriptionOptionInfo as SubscriptionOptionInfo,\n ecomV1OrderTransactions_universal_d_V2Refund as V2Refund,\n GiftCard$1 as GiftCard,\n ecomV1OrderTransactions_universal_d_PaymentsUpdated as PaymentsUpdated,\n ecomV1OrderTransactions_universal_d_RefundCreated as RefundCreated,\n ecomV1OrderTransactions_universal_d_RestockInfo as RestockInfo,\n ecomV1OrderTransactions_universal_d_RestockType as RestockType,\n ecomV1OrderTransactions_universal_d_RestockItem as RestockItem,\n ecomV1OrderTransactions_universal_d_RefundCompleted as RefundCompleted,\n ecomV1OrderTransactions_universal_d_RefundSideEffects as RefundSideEffects,\n ecomV1OrderTransactions_universal_d_ListTransactionsForSingleOrderRequest as ListTransactionsForSingleOrderRequest,\n ecomV1OrderTransactions_universal_d_ListTransactionsForSingleOrderResponse as ListTransactionsForSingleOrderResponse,\n ecomV1OrderTransactions_universal_d_ListTransactionsForMultipleOrdersRequest as ListTransactionsForMultipleOrdersRequest,\n ecomV1OrderTransactions_universal_d_ListTransactionsForMultipleOrdersResponse as ListTransactionsForMultipleOrdersResponse,\n ecomV1OrderTransactions_universal_d_AddPaymentsRequest as AddPaymentsRequest,\n ecomV1OrderTransactions_universal_d_AddPaymentsResponse as AddPaymentsResponse,\n ecomV1OrderTransactions_universal_d_AddRefundRequest as AddRefundRequest,\n ecomV1OrderTransactions_universal_d_AddRefundResponse as AddRefundResponse,\n ecomV1OrderTransactions_universal_d_UpdatePaymentStatusRequest as UpdatePaymentStatusRequest,\n ecomV1OrderTransactions_universal_d_UpdatePaymentStatusResponse as UpdatePaymentStatusResponse,\n ecomV1OrderTransactions_universal_d_BulkUpdatePaymentStatusesRequest as BulkUpdatePaymentStatusesRequest,\n ecomV1OrderTransactions_universal_d_PaymentAndOrderId as PaymentAndOrderId,\n ecomV1OrderTransactions_universal_d_BulkUpdatePaymentStatusesResponse as BulkUpdatePaymentStatusesResponse,\n ecomV1OrderTransactions_universal_d_BulkPaymentResult as BulkPaymentResult,\n ecomV1OrderTransactions_universal_d_ItemMetadata as ItemMetadata,\n ApplicationError$3 as ApplicationError,\n ecomV1OrderTransactions_universal_d_BulkActionMetadata as BulkActionMetadata,\n ecomV1OrderTransactions_universal_d_UpdateRefundRequest as UpdateRefundRequest,\n ecomV1OrderTransactions_universal_d_UpdateRefundResponse as UpdateRefundResponse,\n ecomV1OrderTransactions_universal_d_UpdateRefundTransactionRequest as UpdateRefundTransactionRequest,\n ecomV1OrderTransactions_universal_d_UpdateRefundTransactionResponse as UpdateRefundTransactionResponse,\n ecomV1OrderTransactions_universal_d_UpdatePaymentsRequest as UpdatePaymentsRequest,\n ecomV1OrderTransactions_universal_d_MaskedPayment as MaskedPayment,\n ecomV1OrderTransactions_universal_d_UpdatePaymentsResponse as UpdatePaymentsResponse,\n ecomV1OrderTransactions_universal_d_QueryOrderTransactionsRequest as QueryOrderTransactionsRequest,\n CursorQuery$3 as CursorQuery,\n CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf,\n Sorting$5 as Sorting,\n SortOrder$5 as SortOrder,\n CursorPaging$5 as CursorPaging,\n ecomV1OrderTransactions_universal_d_QueryOrderTransactionsResponse as QueryOrderTransactionsResponse,\n CursorPagingMetadata$4 as CursorPagingMetadata,\n Cursors$5 as Cursors,\n ecomV1OrderTransactions_universal_d_TriggerRefundRequest as TriggerRefundRequest,\n ecomV1OrderTransactions_universal_d_PaymentRefund as PaymentRefund,\n ecomV1OrderTransactions_universal_d_TriggerRefundResponse as TriggerRefundResponse,\n ecomV1OrderTransactions_universal_d_CalculateRefundRequest as CalculateRefundRequest,\n ecomV1OrderTransactions_universal_d_CalculateRefundItemRequest as CalculateRefundItemRequest,\n ecomV1OrderTransactions_universal_d_CalculateRefundResponse as CalculateRefundResponse,\n ecomV1OrderTransactions_universal_d_CalculateRefundItemResponse as CalculateRefundItemResponse,\n ecomV1OrderTransactions_universal_d_GetRefundabilityStatusRequest as GetRefundabilityStatusRequest,\n ecomV1OrderTransactions_universal_d_GetRefundabilityStatusResponse as GetRefundabilityStatusResponse,\n ecomV1OrderTransactions_universal_d_Refundability as Refundability,\n ecomV1OrderTransactions_universal_d_RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOf,\n ecomV1OrderTransactions_universal_d_RefundableStatus as RefundableStatus,\n ecomV1OrderTransactions_universal_d_NonRefundableReason as NonRefundableReason,\n ecomV1OrderTransactions_universal_d_ManuallyRefundableReason as ManuallyRefundableReason,\n ecomV1OrderTransactions_universal_d_ListInvoicesForSingleOrderRequest as ListInvoicesForSingleOrderRequest,\n ecomV1OrderTransactions_universal_d_ListInvoicesForSingleOrderResponse as ListInvoicesForSingleOrderResponse,\n ecomV1OrderTransactions_universal_d_InvoiceInfo as InvoiceInfo,\n ecomV1OrderTransactions_universal_d_ListInvoicesForMultipleOrdersRequest as ListInvoicesForMultipleOrdersRequest,\n ecomV1OrderTransactions_universal_d_ListInvoicesForMultipleOrdersResponse as ListInvoicesForMultipleOrdersResponse,\n ecomV1OrderTransactions_universal_d_InvoicesForOrder as InvoicesForOrder,\n ecomV1OrderTransactions_universal_d_GenerateInvoiceRequest as GenerateInvoiceRequest,\n ecomV1OrderTransactions_universal_d_GenerateInvoiceResponse as GenerateInvoiceResponse,\n ecomV1OrderTransactions_universal_d_BulkGenerateInvoicesRequest as BulkGenerateInvoicesRequest,\n ecomV1OrderTransactions_universal_d_BulkGenerateInvoicesResponse as BulkGenerateInvoicesResponse,\n ecomV1OrderTransactions_universal_d_BulkInvoiceResult as BulkInvoiceResult,\n ecomV1OrderTransactions_universal_d_InvoiceForOrder as InvoiceForOrder,\n ecomV1OrderTransactions_universal_d_AddInvoiceToOrderRequest as AddInvoiceToOrderRequest,\n ecomV1OrderTransactions_universal_d_AddInvoiceToOrderResponse as AddInvoiceToOrderResponse,\n DomainEvent$7 as DomainEvent,\n DomainEventBodyOneOf$7 as DomainEventBodyOneOf,\n EntityCreatedEvent$7 as EntityCreatedEvent,\n RestoreInfo$7 as RestoreInfo,\n EntityUpdatedEvent$7 as EntityUpdatedEvent,\n EntityDeletedEvent$7 as EntityDeletedEvent,\n ActionEvent$7 as ActionEvent,\n MessageEnvelope$6 as MessageEnvelope,\n IdentificationData$7 as IdentificationData,\n IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf,\n WebhookIdentityType$6 as WebhookIdentityType,\n ecomV1OrderTransactions_universal_d_listTransactionsForSingleOrder as listTransactionsForSingleOrder,\n ecomV1OrderTransactions_universal_d_listTransactionsForMultipleOrders as listTransactionsForMultipleOrders,\n ecomV1OrderTransactions_universal_d_addPayments as addPayments,\n ecomV1OrderTransactions_universal_d_addRefund as addRefund,\n ecomV1OrderTransactions_universal_d_AddRefundOptions as AddRefundOptions,\n ecomV1OrderTransactions_universal_d_updatePaymentStatus as updatePaymentStatus,\n ecomV1OrderTransactions_universal_d_UpdatePaymentStatusIdentifiers as UpdatePaymentStatusIdentifiers,\n ecomV1OrderTransactions_universal_d_UpdatePaymentStatusOptions as UpdatePaymentStatusOptions,\n ecomV1OrderTransactions_universal_d_bulkUpdatePaymentStatuses as bulkUpdatePaymentStatuses,\n ecomV1OrderTransactions_universal_d_BulkUpdatePaymentStatusesOptions as BulkUpdatePaymentStatusesOptions,\n ecomV1OrderTransactions_universal_d_updateRefund as updateRefund,\n ecomV1OrderTransactions_universal_d_UpdateRefundOptions as UpdateRefundOptions,\n ecomV1OrderTransactions_universal_d_updateRefundTransaction as updateRefundTransaction,\n ecomV1OrderTransactions_universal_d_UpdateRefundTransactionOptions as UpdateRefundTransactionOptions,\n ecomV1OrderTransactions_universal_d_updatePayments as updatePayments,\n ecomV1OrderTransactions_universal_d_queryOrderTransactions as queryOrderTransactions,\n ecomV1OrderTransactions_universal_d_OrderTransactionsQueryResult as OrderTransactionsQueryResult,\n ecomV1OrderTransactions_universal_d_OrderTransactionsQueryBuilder as OrderTransactionsQueryBuilder,\n ecomV1OrderTransactions_universal_d_triggerRefund as triggerRefund,\n ecomV1OrderTransactions_universal_d_TriggerRefundOptions as TriggerRefundOptions,\n ecomV1OrderTransactions_universal_d_calculateRefund as calculateRefund,\n ecomV1OrderTransactions_universal_d_CalculateRefundOptions as CalculateRefundOptions,\n ecomV1OrderTransactions_universal_d_getRefundabilityStatus as getRefundabilityStatus,\n ecomV1OrderTransactions_universal_d_listInvoicesForSingleOrder as listInvoicesForSingleOrder,\n ecomV1OrderTransactions_universal_d_listInvoicesForMultipleOrders as listInvoicesForMultipleOrders,\n ecomV1OrderTransactions_universal_d_listInvoicesForMultipleOrdersOld as listInvoicesForMultipleOrdersOld,\n ecomV1OrderTransactions_universal_d_generateInvoice as generateInvoice,\n ecomV1OrderTransactions_universal_d_bulkGenerateInvoices as bulkGenerateInvoices,\n ecomV1OrderTransactions_universal_d_addInvoiceToOrder as addInvoiceToOrder,\n };\n }\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 | null;\n /**\n * Date and time the orders settings were updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n enum InventoryUpdateTrigger {\n UNKNOWN_INVENTORY_UPDATE_TRIGGER = \"UNKNOWN_INVENTORY_UPDATE_TRIGGER\",\n /** Stock quantities will update only after the payment is approved. */\n ON_ORDER_PAID = \"ON_ORDER_PAID\",\n /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */\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 * The list of fields to update.\n * @internal\n */\n fieldMask?: string[];\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$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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$6;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$6 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$6 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$6 {\n bodyAsJson?: string;\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$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$5;\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$5 {\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 * @permissionId ECOM.READ_ORDERS_SETTINGS\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 * @permissionId ECOM.UPDATE_ORDERS_SETTINGS\n * @adminMethod\n * @returns The updated orders settings.\n */\n function updateOrdersSettings(ordersSettings: OrdersSettings, options?: UpdateOrdersSettingsOptions): Promise;\n interface UpdateOrdersSettingsOptions {\n /**\n * The list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n \n type ecomV1OrdersSettings_universal_d_OrdersSettings = OrdersSettings;\n type ecomV1OrdersSettings_universal_d_InventoryUpdateTrigger = InventoryUpdateTrigger;\n const ecomV1OrdersSettings_universal_d_InventoryUpdateTrigger: typeof InventoryUpdateTrigger;\n type ecomV1OrdersSettings_universal_d_GetOrdersSettingsRequest = GetOrdersSettingsRequest;\n type ecomV1OrdersSettings_universal_d_GetOrdersSettingsResponse = GetOrdersSettingsResponse;\n type ecomV1OrdersSettings_universal_d_UpdateOrdersSettingsRequest = UpdateOrdersSettingsRequest;\n type ecomV1OrdersSettings_universal_d_UpdateOrdersSettingsResponse = UpdateOrdersSettingsResponse;\n type ecomV1OrdersSettings_universal_d_DeleteOrdersSettingsRequest = DeleteOrdersSettingsRequest;\n type ecomV1OrdersSettings_universal_d_DeleteOrdersSettingsResponse = DeleteOrdersSettingsResponse;\n type ecomV1OrdersSettings_universal_d_ListOrdersSettingsRequest = ListOrdersSettingsRequest;\n type ecomV1OrdersSettings_universal_d_ListOrdersSettingsResponse = ListOrdersSettingsResponse;\n const ecomV1OrdersSettings_universal_d_getOrdersSettings: typeof getOrdersSettings;\n const ecomV1OrdersSettings_universal_d_updateOrdersSettings: typeof updateOrdersSettings;\n type ecomV1OrdersSettings_universal_d_UpdateOrdersSettingsOptions = UpdateOrdersSettingsOptions;\n namespace ecomV1OrdersSettings_universal_d {\n export {\n ecomV1OrdersSettings_universal_d_OrdersSettings as OrdersSettings,\n ecomV1OrdersSettings_universal_d_InventoryUpdateTrigger as InventoryUpdateTrigger,\n ecomV1OrdersSettings_universal_d_GetOrdersSettingsRequest as GetOrdersSettingsRequest,\n ecomV1OrdersSettings_universal_d_GetOrdersSettingsResponse as GetOrdersSettingsResponse,\n ecomV1OrdersSettings_universal_d_UpdateOrdersSettingsRequest as UpdateOrdersSettingsRequest,\n ecomV1OrdersSettings_universal_d_UpdateOrdersSettingsResponse as UpdateOrdersSettingsResponse,\n ecomV1OrdersSettings_universal_d_DeleteOrdersSettingsRequest as DeleteOrdersSettingsRequest,\n ecomV1OrdersSettings_universal_d_DeleteOrdersSettingsResponse as DeleteOrdersSettingsResponse,\n ecomV1OrdersSettings_universal_d_ListOrdersSettingsRequest as ListOrdersSettingsRequest,\n ecomV1OrdersSettings_universal_d_ListOrdersSettingsResponse as ListOrdersSettingsResponse,\n DomainEvent$6 as DomainEvent,\n DomainEventBodyOneOf$6 as DomainEventBodyOneOf,\n EntityCreatedEvent$6 as EntityCreatedEvent,\n RestoreInfo$6 as RestoreInfo,\n EntityUpdatedEvent$6 as EntityUpdatedEvent,\n EntityDeletedEvent$6 as EntityDeletedEvent,\n ActionEvent$6 as ActionEvent,\n MessageEnvelope$5 as MessageEnvelope,\n IdentificationData$6 as IdentificationData,\n IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf,\n WebhookIdentityType$5 as WebhookIdentityType,\n ecomV1OrdersSettings_universal_d_getOrdersSettings as getOrdersSettings,\n ecomV1OrdersSettings_universal_d_updateOrdersSettings as updateOrdersSettings,\n ecomV1OrdersSettings_universal_d_UpdateOrdersSettingsOptions as UpdateOrdersSettingsOptions,\n };\n }\n \n /** PickupLocation is the main entity of PickupLocations that can be used for lorem ipsum dolor */\n interface PickupLocation {\n /**\n * PickupLocation ID\n * @readonly\n */\n _id?: string | null;\n /**\n * ShippingRuleId from ecom\n * @internal\n * @deprecated ShippingRuleId from ecom\n * @replacedBy delivery_region_ids\n * @targetRemovalDate 2024-11-01\n */\n shippingRuleId?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this PickupLocation was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this PickupLocation was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Pickup Location Name */\n name?: string | null;\n /** Pickup Location Address */\n address?: Address$3;\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 /** inactive pickup locations should not be shown in checkout */\n active?: boolean | null;\n /** at runtime for a given pickup input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */\n rates?: ConditionalRates$1[];\n /** This pickup location is active for the following delivery regions. */\n deliveryRegionIds?: string[];\n }\n /** Physical address */\n interface Address$3 extends AddressStreetOneOf$1 {\n /** Street name and number. */\n streetAddress?: StreetAddress$3;\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?: string | null;\n /** Zip/postal code. */\n postalCode?: string | null;\n addressLine2?: string | null;\n /**\n * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n }\n /** @oneof */\n interface AddressStreetOneOf$1 {\n /** Street name and number. */\n streetAddress?: StreetAddress$3;\n addressLine?: string | null;\n }\n interface StreetAddress$3 {\n number?: string;\n name?: string;\n /** @internal */\n apt?: string;\n }\n interface ConditionalRates$1 {\n /**\n * there is an AND logic between all the conditions. Empty conditions means true.\n * For example: weight > 0 and weight <= 10\n */\n conditions?: Condition$1[];\n amount?: string;\n }\n interface Condition$1 {\n type?: ConditionType$1;\n /**\n * The value in respective to the condition type\n * Weight values should be in the same weight units of the store: KG / LB\n * Total price is according to the store currency\n * Quantity of items should be integers\n */\n value?: string;\n operator?: LogicalOperator$1;\n }\n enum ConditionType$1 {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n BY_TOTAL_WEIGHT = \"BY_TOTAL_WEIGHT\",\n BY_TOTAL_PRICE = \"BY_TOTAL_PRICE\",\n BY_TOTAL_QUANTITY = \"BY_TOTAL_QUANTITY\"\n }\n enum LogicalOperator$1 {\n UNKNOWN_LOGICAL_OPERATOR_TYPE = \"UNKNOWN_LOGICAL_OPERATOR_TYPE\",\n EQ = \"EQ\",\n GT = \"GT\",\n GTE = \"GTE\",\n LT = \"LT\",\n LTE = \"LTE\"\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 CreatePickupLocationRequest {\n /** PickupLocation to be created */\n pickupLocation: PickupLocation;\n }\n interface CreatePickupLocationResponse {\n /** The created PickupLocation */\n pickupLocation?: PickupLocation;\n }\n interface GetPickupLocationRequest {\n /** Id of the PickupLocation to retrieve */\n pickupLocationId: string;\n }\n interface GetPickupLocationResponse {\n /** The retrieved PickupLocation */\n pickupLocation?: PickupLocation;\n }\n interface UpdatePickupLocationRequest {\n /** PickupLocation to be updated, may be partial */\n pickupLocation: PickupLocation;\n /**\n * FieldMask for partial update\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdatePickupLocationResponse {\n /** The updated PickupLocation */\n pickupLocation?: PickupLocation;\n }\n interface DeletePickupLocationRequest {\n /** Id of the PickupLocation to delete */\n pickupLocationId: string;\n }\n interface DeletePickupLocationResponse {\n }\n interface QueryPickupLocationRequest {\n /** WQL expression */\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$4;\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$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$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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$4 {\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$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 QueryPickupLocationResponse {\n /** The retrieved PickupLocations */\n pickupLocations?: PickupLocation[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$3;\n }\n interface CursorPagingMetadata$3 {\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$4;\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | null;\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 AddDeliveryRegionRequest {\n /** Id of the PickupLocation to add to the delivery region */\n pickupLocationId: string;\n /** Id of the DeliveryRegion to add the PickupLocation to */\n deliveryRegionId: string;\n /** Revision of the PickupLocation */\n revision: string | null;\n }\n interface AddDeliveryRegionResponse {\n /** The updated PickupLocation */\n pickupLocation?: PickupLocation;\n }\n interface RemoveDeliveryRegionRequest {\n /** Id of the PickupLocation to add to the delivery region */\n pickupLocationId: string;\n /** Id of the DeliveryRegion to add the PickupLocation to */\n deliveryRegionId: string;\n /** Revision of the PickupLocation */\n revision: string | null;\n }\n interface RemoveDeliveryRegionResponse {\n /** The updated PickupLocation */\n pickupLocation?: PickupLocation;\n }\n interface BulkCreatePickupLocationRequest {\n pickupLocations: PickupLocation[];\n }\n interface BulkCreatePickupLocationResponse {\n pickupLocations?: PickupLocation[];\n errors?: PickupLocationError[];\n }\n interface PickupLocationError {\n _id?: string;\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 BulkUpdatePickupLocationRequest {\n pickupLocations: PickupLocation[];\n }\n interface BulkUpdatePickupLocationResponse {\n pickupLocations?: PickupLocation[];\n errors?: PickupLocationError[];\n }\n interface BulkDeletePickupLocationRequest {\n pickupLocationIds: string[];\n }\n interface BulkDeletePickupLocationResponse {\n errors?: PickupLocationError[];\n }\n interface Empty$3 {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$5 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$5 {\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$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$4;\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$4 {\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 PickupLocation\n * @param pickupLocation - PickupLocation to be created\n * @public\n * @documentationMaturity preview\n * @requiredField pickupLocation\n * @requiredField pickupLocation.address\n * @permissionId ECOM.PICKUP_LOCATION_CREATE\n * @adminMethod\n * @returns The created PickupLocation\n */\n function createPickupLocation(pickupLocation: PickupLocation): Promise;\n /**\n * Get a PickupLocation by id\n * @param pickupLocationId - Id of the PickupLocation to retrieve\n * @public\n * @documentationMaturity preview\n * @requiredField pickupLocationId\n * @permissionId ECOM.PICKUP_LOCATION_READ\n * @adminMethod\n * @returns The retrieved PickupLocation\n */\n function getPickupLocation(pickupLocationId: string): Promise;\n /**\n * Update a PickupLocation\n * Delivery regions cannot be updated using this method, use AddDeliveryRegion and RemoveDeliveryRegion instead.\n * @param _id - PickupLocation ID\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField pickupLocation\n * @requiredField pickupLocation.revision\n * @permissionId ECOM.PICKUP_LOCATION_UPDATE\n * @adminMethod\n * @returns The updated PickupLocation\n */\n function updatePickupLocation(_id: string | null, pickupLocation: UpdatePickupLocation, options?: UpdatePickupLocationOptions): Promise;\n interface UpdatePickupLocation {\n /**\n * PickupLocation ID\n * @readonly\n */\n _id?: string | null;\n /**\n * ShippingRuleId from ecom\n * @internal\n * @deprecated ShippingRuleId from ecom\n * @replacedBy delivery_region_ids\n * @targetRemovalDate 2024-11-01\n */\n shippingRuleId?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this PickupLocation was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this PickupLocation was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Pickup Location Name */\n name?: string | null;\n /** Pickup Location Address */\n address?: Address$3;\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 /** inactive pickup locations should not be shown in checkout */\n active?: boolean | null;\n /** at runtime for a given pickup input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */\n rates?: ConditionalRates$1[];\n /** This pickup location is active for the following delivery regions. */\n deliveryRegionIds?: string[];\n }\n interface UpdatePickupLocationOptions {\n /**\n * FieldMask for partial update\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Delete a PickupLocation\n * @param pickupLocationId - Id of the PickupLocation to delete\n * @public\n * @documentationMaturity preview\n * @requiredField pickupLocationId\n * @permissionId ECOM.PICKUP_LOCATION_DELETE\n * @adminMethod\n */\n function deletePickupLocation(pickupLocationId: string): Promise;\n /**\n * Query PickupLocations using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @public\n * @documentationMaturity preview\n * @permissionId ECOM.PICKUP_LOCATION_READ\n * @adminMethod\n */\n function queryPickupLocation(): PickupLocationsQueryBuilder;\n interface QueryCursorResult$4 {\n cursors: Cursors$4;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PickupLocationsQueryResult extends QueryCursorResult$4 {\n items: PickupLocation[];\n query: PickupLocationsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface PickupLocationsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: '_createdDate' | '_updatedDate' | 'name' | 'address.country' | 'address.subdivision' | 'address.city' | 'deliveryRegionIds', value: any) => PickupLocationsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: '_createdDate' | '_updatedDate' | 'name' | 'address.country' | 'address.subdivision' | 'address.city' | 'deliveryRegionIds', value: any) => PickupLocationsQueryBuilder;\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) => PickupLocationsQueryBuilder;\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) => PickupLocationsQueryBuilder;\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) => PickupLocationsQueryBuilder;\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) => PickupLocationsQueryBuilder;\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' | 'address.country' | 'address.subdivision' | 'address.city', value: string) => PickupLocationsQueryBuilder;\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: '_createdDate' | '_updatedDate' | 'name' | 'address.country' | 'address.subdivision' | 'address.city' | 'deliveryRegionIds', value: any[]) => PickupLocationsQueryBuilder;\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: 'deliveryRegionIds', value: any[]) => PickupLocationsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_createdDate' | '_updatedDate' | 'name' | 'address.country' | 'address.subdivision' | 'address.city' | 'deliveryRegionIds', value: any) => PickupLocationsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_createdDate' | '_updatedDate' | 'name' | 'address.country' | 'address.subdivision' | 'address.city' | 'deliveryRegionIds', value: boolean) => PickupLocationsQueryBuilder;\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) => PickupLocationsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => PickupLocationsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Add a DeliveryRegion to a PickupLocation\n * @param pickupLocationId - Id of the PickupLocation to add to the delivery region\n * @param deliveryRegionId - Id of the DeliveryRegion to add the PickupLocation to\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options\n * @requiredField options.revision\n * @requiredField pickupLocationId\n * @permissionId ECOM.PICKUP_LOCATION_UPDATE\n * @adminMethod\n */\n function addDeliveryRegion(pickupLocationId: string, deliveryRegionId: string, options: AddDeliveryRegionOptions): Promise;\n interface AddDeliveryRegionOptions {\n /** Revision of the PickupLocation */\n revision: string | null;\n }\n /**\n * Remove a DeliveryRegion from a PickupLocation\n * @param pickupLocationId - Id of the PickupLocation to add to the delivery region\n * @param deliveryRegionId - Id of the DeliveryRegion to add the PickupLocation to\n * @public\n * @documentationMaturity preview\n * @requiredField deliveryRegionId\n * @requiredField options\n * @requiredField options.revision\n * @requiredField pickupLocationId\n * @permissionId ECOM.PICKUP_LOCATION_UPDATE\n * @adminMethod\n */\n function removeDeliveryRegion(pickupLocationId: string, deliveryRegionId: string, options: RemoveDeliveryRegionOptions): Promise;\n interface RemoveDeliveryRegionOptions {\n /** Revision of the PickupLocation */\n revision: string | null;\n }\n /**\n * Bulk Create for new PickupLocation\n * @public\n * @documentationMaturity preview\n * @requiredField pickupLocations\n * @requiredField pickupLocations.address\n * @permissionId ECOM.PICKUP_LOCATION_CREATE\n * @adminMethod\n */\n function bulkCreatePickupLocation(pickupLocations: PickupLocation[]): Promise;\n /**\n * Update a PickupLocation\n * @public\n * @documentationMaturity preview\n * @requiredField pickupLocations\n * @requiredField pickupLocations._id\n * @requiredField pickupLocations.revision\n * @permissionId ECOM.PICKUP_LOCATION_UPDATE\n * @adminMethod\n */\n function bulkUpdatePickupLocation(pickupLocations: PickupLocation[]): Promise;\n /**\n * Delete a PickupLocation\n * @public\n * @documentationMaturity preview\n * @requiredField pickupLocationIds\n * @permissionId ECOM.PICKUP_LOCATION_DELETE\n * @adminMethod\n */\n function bulkDeletePickupLocation(pickupLocationIds: string[]): Promise;\n \n type ecomV1PickupLocation_universal_d_PickupLocation = PickupLocation;\n type ecomV1PickupLocation_universal_d_DiffmatokyPayload = DiffmatokyPayload;\n type ecomV1PickupLocation_universal_d_ErrorInformation = ErrorInformation;\n type ecomV1PickupLocation_universal_d_CreatePickupLocationRequest = CreatePickupLocationRequest;\n type ecomV1PickupLocation_universal_d_CreatePickupLocationResponse = CreatePickupLocationResponse;\n type ecomV1PickupLocation_universal_d_GetPickupLocationRequest = GetPickupLocationRequest;\n type ecomV1PickupLocation_universal_d_GetPickupLocationResponse = GetPickupLocationResponse;\n type ecomV1PickupLocation_universal_d_UpdatePickupLocationRequest = UpdatePickupLocationRequest;\n type ecomV1PickupLocation_universal_d_UpdatePickupLocationResponse = UpdatePickupLocationResponse;\n type ecomV1PickupLocation_universal_d_DeletePickupLocationRequest = DeletePickupLocationRequest;\n type ecomV1PickupLocation_universal_d_DeletePickupLocationResponse = DeletePickupLocationResponse;\n type ecomV1PickupLocation_universal_d_QueryPickupLocationRequest = QueryPickupLocationRequest;\n type ecomV1PickupLocation_universal_d_QueryPickupLocationResponse = QueryPickupLocationResponse;\n type ecomV1PickupLocation_universal_d_AddDeliveryRegionRequest = AddDeliveryRegionRequest;\n type ecomV1PickupLocation_universal_d_AddDeliveryRegionResponse = AddDeliveryRegionResponse;\n type ecomV1PickupLocation_universal_d_RemoveDeliveryRegionRequest = RemoveDeliveryRegionRequest;\n type ecomV1PickupLocation_universal_d_RemoveDeliveryRegionResponse = RemoveDeliveryRegionResponse;\n type ecomV1PickupLocation_universal_d_BulkCreatePickupLocationRequest = BulkCreatePickupLocationRequest;\n type ecomV1PickupLocation_universal_d_BulkCreatePickupLocationResponse = BulkCreatePickupLocationResponse;\n type ecomV1PickupLocation_universal_d_PickupLocationError = PickupLocationError;\n type ecomV1PickupLocation_universal_d_BulkUpdatePickupLocationRequest = BulkUpdatePickupLocationRequest;\n type ecomV1PickupLocation_universal_d_BulkUpdatePickupLocationResponse = BulkUpdatePickupLocationResponse;\n type ecomV1PickupLocation_universal_d_BulkDeletePickupLocationRequest = BulkDeletePickupLocationRequest;\n type ecomV1PickupLocation_universal_d_BulkDeletePickupLocationResponse = BulkDeletePickupLocationResponse;\n const ecomV1PickupLocation_universal_d_createPickupLocation: typeof createPickupLocation;\n const ecomV1PickupLocation_universal_d_getPickupLocation: typeof getPickupLocation;\n const ecomV1PickupLocation_universal_d_updatePickupLocation: typeof updatePickupLocation;\n type ecomV1PickupLocation_universal_d_UpdatePickupLocation = UpdatePickupLocation;\n type ecomV1PickupLocation_universal_d_UpdatePickupLocationOptions = UpdatePickupLocationOptions;\n const ecomV1PickupLocation_universal_d_deletePickupLocation: typeof deletePickupLocation;\n const ecomV1PickupLocation_universal_d_queryPickupLocation: typeof queryPickupLocation;\n type ecomV1PickupLocation_universal_d_PickupLocationsQueryResult = PickupLocationsQueryResult;\n type ecomV1PickupLocation_universal_d_PickupLocationsQueryBuilder = PickupLocationsQueryBuilder;\n const ecomV1PickupLocation_universal_d_addDeliveryRegion: typeof addDeliveryRegion;\n type ecomV1PickupLocation_universal_d_AddDeliveryRegionOptions = AddDeliveryRegionOptions;\n const ecomV1PickupLocation_universal_d_removeDeliveryRegion: typeof removeDeliveryRegion;\n type ecomV1PickupLocation_universal_d_RemoveDeliveryRegionOptions = RemoveDeliveryRegionOptions;\n const ecomV1PickupLocation_universal_d_bulkCreatePickupLocation: typeof bulkCreatePickupLocation;\n const ecomV1PickupLocation_universal_d_bulkUpdatePickupLocation: typeof bulkUpdatePickupLocation;\n const ecomV1PickupLocation_universal_d_bulkDeletePickupLocation: typeof bulkDeletePickupLocation;\n namespace ecomV1PickupLocation_universal_d {\n export {\n ecomV1PickupLocation_universal_d_PickupLocation as PickupLocation,\n Address$3 as Address,\n AddressStreetOneOf$1 as AddressStreetOneOf,\n StreetAddress$3 as StreetAddress,\n ConditionalRates$1 as ConditionalRates,\n Condition$1 as Condition,\n ConditionType$1 as ConditionType,\n LogicalOperator$1 as LogicalOperator,\n ecomV1PickupLocation_universal_d_DiffmatokyPayload as DiffmatokyPayload,\n ecomV1PickupLocation_universal_d_ErrorInformation as ErrorInformation,\n ecomV1PickupLocation_universal_d_CreatePickupLocationRequest as CreatePickupLocationRequest,\n ecomV1PickupLocation_universal_d_CreatePickupLocationResponse as CreatePickupLocationResponse,\n ecomV1PickupLocation_universal_d_GetPickupLocationRequest as GetPickupLocationRequest,\n ecomV1PickupLocation_universal_d_GetPickupLocationResponse as GetPickupLocationResponse,\n ecomV1PickupLocation_universal_d_UpdatePickupLocationRequest as UpdatePickupLocationRequest,\n ecomV1PickupLocation_universal_d_UpdatePickupLocationResponse as UpdatePickupLocationResponse,\n ecomV1PickupLocation_universal_d_DeletePickupLocationRequest as DeletePickupLocationRequest,\n ecomV1PickupLocation_universal_d_DeletePickupLocationResponse as DeletePickupLocationResponse,\n ecomV1PickupLocation_universal_d_QueryPickupLocationRequest as QueryPickupLocationRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Sorting$4 as Sorting,\n SortOrder$4 as SortOrder,\n Paging$1 as Paging,\n CursorPaging$4 as CursorPaging,\n ecomV1PickupLocation_universal_d_QueryPickupLocationResponse as QueryPickupLocationResponse,\n CursorPagingMetadata$3 as CursorPagingMetadata,\n Cursors$4 as Cursors,\n ecomV1PickupLocation_universal_d_AddDeliveryRegionRequest as AddDeliveryRegionRequest,\n ecomV1PickupLocation_universal_d_AddDeliveryRegionResponse as AddDeliveryRegionResponse,\n ecomV1PickupLocation_universal_d_RemoveDeliveryRegionRequest as RemoveDeliveryRegionRequest,\n ecomV1PickupLocation_universal_d_RemoveDeliveryRegionResponse as RemoveDeliveryRegionResponse,\n ecomV1PickupLocation_universal_d_BulkCreatePickupLocationRequest as BulkCreatePickupLocationRequest,\n ecomV1PickupLocation_universal_d_BulkCreatePickupLocationResponse as BulkCreatePickupLocationResponse,\n ecomV1PickupLocation_universal_d_PickupLocationError as PickupLocationError,\n ApplicationError$2 as ApplicationError,\n ecomV1PickupLocation_universal_d_BulkUpdatePickupLocationRequest as BulkUpdatePickupLocationRequest,\n ecomV1PickupLocation_universal_d_BulkUpdatePickupLocationResponse as BulkUpdatePickupLocationResponse,\n ecomV1PickupLocation_universal_d_BulkDeletePickupLocationRequest as BulkDeletePickupLocationRequest,\n ecomV1PickupLocation_universal_d_BulkDeletePickupLocationResponse as BulkDeletePickupLocationResponse,\n Empty$3 as Empty,\n DomainEvent$5 as DomainEvent,\n DomainEventBodyOneOf$5 as DomainEventBodyOneOf,\n EntityCreatedEvent$5 as EntityCreatedEvent,\n RestoreInfo$5 as RestoreInfo,\n EntityUpdatedEvent$5 as EntityUpdatedEvent,\n EntityDeletedEvent$5 as EntityDeletedEvent,\n ActionEvent$5 as ActionEvent,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$5 as IdentificationData,\n IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n ecomV1PickupLocation_universal_d_createPickupLocation as createPickupLocation,\n ecomV1PickupLocation_universal_d_getPickupLocation as getPickupLocation,\n ecomV1PickupLocation_universal_d_updatePickupLocation as updatePickupLocation,\n ecomV1PickupLocation_universal_d_UpdatePickupLocation as UpdatePickupLocation,\n ecomV1PickupLocation_universal_d_UpdatePickupLocationOptions as UpdatePickupLocationOptions,\n ecomV1PickupLocation_universal_d_deletePickupLocation as deletePickupLocation,\n ecomV1PickupLocation_universal_d_queryPickupLocation as queryPickupLocation,\n ecomV1PickupLocation_universal_d_PickupLocationsQueryResult as PickupLocationsQueryResult,\n ecomV1PickupLocation_universal_d_PickupLocationsQueryBuilder as PickupLocationsQueryBuilder,\n ecomV1PickupLocation_universal_d_addDeliveryRegion as addDeliveryRegion,\n ecomV1PickupLocation_universal_d_AddDeliveryRegionOptions as AddDeliveryRegionOptions,\n ecomV1PickupLocation_universal_d_removeDeliveryRegion as removeDeliveryRegion,\n ecomV1PickupLocation_universal_d_RemoveDeliveryRegionOptions as RemoveDeliveryRegionOptions,\n ecomV1PickupLocation_universal_d_bulkCreatePickupLocation as bulkCreatePickupLocation,\n ecomV1PickupLocation_universal_d_bulkUpdatePickupLocation as bulkUpdatePickupLocation,\n ecomV1PickupLocation_universal_d_bulkDeletePickupLocation as bulkDeletePickupLocation,\n };\n }\n \n interface ShippingOption$1 {\n /**\n * ShippingOption ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the ShippingOption is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the ShippingOption.\n *\n * Ignored when creating a ShippingOption.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the ShippingOption was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the ShippingOption was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Associated delivery region id. */\n deliveryRegionId?: string;\n /** Delivery option configured for the ShippingOption */\n title?: string | null;\n estimateDeliveryTime?: string | null;\n /** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */\n rates?: ConditionalRates[];\n /** Data Extensions */\n extendedFields?: ExtendedFields$2;\n }\n interface ConditionalRates {\n /**\n * there is an AND logic between all the conditions. Empty conditions means true.\n * For example: weight > 0 and weight <= 10\n */\n conditions?: Condition[];\n amount?: string;\n }\n interface Condition {\n type?: ConditionType;\n /**\n * The value in respective to the condition type\n * Weight values should be in the same weight units of the store: KG / LB\n * Total price is according to the store currency\n * Quantity of items should be integers\n */\n value?: string;\n operator?: LogicalOperator;\n }\n enum ConditionType {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n BY_TOTAL_WEIGHT = \"BY_TOTAL_WEIGHT\",\n BY_TOTAL_PRICE = \"BY_TOTAL_PRICE\",\n BY_TOTAL_QUANTITY = \"BY_TOTAL_QUANTITY\"\n }\n enum LogicalOperator {\n UNKNOWN_LOGICAL_OPERATOR_TYPE = \"UNKNOWN_LOGICAL_OPERATOR_TYPE\",\n EQ = \"EQ\",\n GT = \"GT\",\n GTE = \"GTE\",\n LT = \"LT\",\n LTE = \"LTE\"\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 CreateShippingOptionRequest {\n /** ShippingOption to be created. */\n shippingOption: ShippingOption$1;\n }\n interface CreateShippingOptionResponse {\n /** The created ShippingOption. */\n shippingOption?: ShippingOption$1;\n }\n interface GetShippingOptionRequest {\n /** ID of the ShippingOption to retrieve. */\n shippingOptionId: string;\n }\n interface GetShippingOptionResponse {\n /** The requested ShippingOption. */\n shippingOption?: ShippingOption$1;\n }\n interface UpdateShippingOptionRequest {\n /** ShippingOption to be updated, may be partial. */\n shippingOption: ShippingOption$1;\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateShippingOptionResponse {\n /** Updated ShippingOption. */\n shippingOption?: ShippingOption$1;\n }\n interface DeleteShippingOptionRequest {\n /** Id of the ShippingOption to delete. */\n shippingOptionId: string;\n }\n interface DeleteShippingOptionResponse {\n }\n interface QueryShippingOptionsRequest {\n /** WQL expression. */\n query?: CursorQuery$2;\n }\n interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$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$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$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$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 QueryShippingOptionsResponse {\n /** List of ShippingOptions. */\n shippingOptions?: ShippingOption$1[];\n /** Paging metadata */\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 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 /** Updated ShippingOption. */\n shippingOption?: ShippingOption$1;\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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$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$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$3;\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$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 ShippingOption.\n *\n * The request body must include shipping option and delivery region associated to.\n * @param shippingOption - ShippingOption to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField shippingOption\n * @permissionId ECOM.SHIPPING_OPTION_CREATE\n * @adminMethod\n * @returns The created ShippingOption.\n */\n function createShippingOption(shippingOption: ShippingOption$1): Promise;\n /**\n * Retrieves a ShippingOption.\n * @param shippingOptionId - ID of the ShippingOption to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField shippingOptionId\n * @permissionId ECOM.SHIPPING_OPTION_READ\n * @adminMethod\n * @returns The requested ShippingOption.\n */\n function getShippingOption(shippingOptionId: string): Promise;\n /**\n * Updates a ShippingOption.\n *\n *\n * Each time the ShippingOption is updated,\n * `revision` increments by 1.\n * The current `revision` must be passed when updating the ShippingOption.\n * This ensures you're working with the latest ShippingOption\n * and prevents unintended overwrites.\n * @param _id - ShippingOption ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField shippingOption\n * @requiredField shippingOption.revision\n * @permissionId ECOM.SHIPPING_OPTION_UPDATE\n * @adminMethod\n * @returns Updated ShippingOption.\n */\n function updateShippingOption(_id: string | null, shippingOption: UpdateShippingOption, options?: UpdateShippingOptionOptions): Promise;\n interface UpdateShippingOption {\n /**\n * ShippingOption ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the ShippingOption is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the ShippingOption.\n *\n * Ignored when creating a ShippingOption.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the ShippingOption was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the ShippingOption was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Associated delivery region id. */\n deliveryRegionId?: string;\n /** Delivery option configured for the ShippingOption */\n title?: string | null;\n estimateDeliveryTime?: string | null;\n /** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */\n rates?: ConditionalRates[];\n /** Data Extensions */\n extendedFields?: ExtendedFields$2;\n }\n interface UpdateShippingOptionOptions {\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes a ShippingOption.\n * Deleting a ShippingOption permanently removes them from the ShippingOption List.\n * @param shippingOptionId - Id of the ShippingOption to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField shippingOptionId\n * @permissionId ECOM.SHIPPING_OPTION_DELETE\n * @adminMethod\n */\n function deleteShippingOption(shippingOptionId: string): Promise;\n /**\n * Retrieves a list of ShippingOptions, given the provided [paging, filtering, and sorting][1].\n *\n * Up to 1,000 ShippingOptions can be returned per request.\n *\n * To learn how to query ShippingOptions, 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 * @permissionId ECOM.SHIPPING_OPTION_READ\n * @adminMethod\n */\n function queryShippingOptions(): ShippingOptionsQueryBuilder;\n interface QueryCursorResult$3 {\n cursors: Cursors$3;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ShippingOptionsQueryResult extends QueryCursorResult$3 {\n items: ShippingOption$1[];\n query: ShippingOptionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ShippingOptionsQueryBuilder {\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' | 'deliveryRegionId', value: any) => ShippingOptionsQueryBuilder;\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' | 'deliveryRegionId', value: any) => ShippingOptionsQueryBuilder;\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' | 'deliveryRegionId', value: string) => ShippingOptionsQueryBuilder;\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' | 'deliveryRegionId', value: any[]) => ShippingOptionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'deliveryRegionId', value: any) => ShippingOptionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'deliveryRegionId', value: boolean) => ShippingOptionsQueryBuilder;\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' | 'deliveryRegionId'>) => ShippingOptionsQueryBuilder;\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' | 'deliveryRegionId'>) => ShippingOptionsQueryBuilder;\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) => ShippingOptionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ShippingOptionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates extended fields of a ShippingOption without incrementing 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 ECOM.SHIPPING_OPTION_UPDATE\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 type ecomV1ShippingOption_universal_d_ConditionalRates = ConditionalRates;\n type ecomV1ShippingOption_universal_d_Condition = Condition;\n type ecomV1ShippingOption_universal_d_ConditionType = ConditionType;\n const ecomV1ShippingOption_universal_d_ConditionType: typeof ConditionType;\n type ecomV1ShippingOption_universal_d_LogicalOperator = LogicalOperator;\n const ecomV1ShippingOption_universal_d_LogicalOperator: typeof LogicalOperator;\n type ecomV1ShippingOption_universal_d_CreateShippingOptionRequest = CreateShippingOptionRequest;\n type ecomV1ShippingOption_universal_d_CreateShippingOptionResponse = CreateShippingOptionResponse;\n type ecomV1ShippingOption_universal_d_GetShippingOptionRequest = GetShippingOptionRequest;\n type ecomV1ShippingOption_universal_d_GetShippingOptionResponse = GetShippingOptionResponse;\n type ecomV1ShippingOption_universal_d_UpdateShippingOptionRequest = UpdateShippingOptionRequest;\n type ecomV1ShippingOption_universal_d_UpdateShippingOptionResponse = UpdateShippingOptionResponse;\n type ecomV1ShippingOption_universal_d_DeleteShippingOptionRequest = DeleteShippingOptionRequest;\n type ecomV1ShippingOption_universal_d_DeleteShippingOptionResponse = DeleteShippingOptionResponse;\n type ecomV1ShippingOption_universal_d_QueryShippingOptionsRequest = QueryShippingOptionsRequest;\n type ecomV1ShippingOption_universal_d_QueryShippingOptionsResponse = QueryShippingOptionsResponse;\n const ecomV1ShippingOption_universal_d_createShippingOption: typeof createShippingOption;\n const ecomV1ShippingOption_universal_d_getShippingOption: typeof getShippingOption;\n const ecomV1ShippingOption_universal_d_updateShippingOption: typeof updateShippingOption;\n type ecomV1ShippingOption_universal_d_UpdateShippingOption = UpdateShippingOption;\n type ecomV1ShippingOption_universal_d_UpdateShippingOptionOptions = UpdateShippingOptionOptions;\n const ecomV1ShippingOption_universal_d_deleteShippingOption: typeof deleteShippingOption;\n const ecomV1ShippingOption_universal_d_queryShippingOptions: typeof queryShippingOptions;\n type ecomV1ShippingOption_universal_d_ShippingOptionsQueryResult = ShippingOptionsQueryResult;\n type ecomV1ShippingOption_universal_d_ShippingOptionsQueryBuilder = ShippingOptionsQueryBuilder;\n namespace ecomV1ShippingOption_universal_d {\n export {\n ShippingOption$1 as ShippingOption,\n ecomV1ShippingOption_universal_d_ConditionalRates as ConditionalRates,\n ecomV1ShippingOption_universal_d_Condition as Condition,\n ecomV1ShippingOption_universal_d_ConditionType as ConditionType,\n ecomV1ShippingOption_universal_d_LogicalOperator as LogicalOperator,\n ExtendedFields$2 as ExtendedFields,\n ecomV1ShippingOption_universal_d_CreateShippingOptionRequest as CreateShippingOptionRequest,\n ecomV1ShippingOption_universal_d_CreateShippingOptionResponse as CreateShippingOptionResponse,\n ecomV1ShippingOption_universal_d_GetShippingOptionRequest as GetShippingOptionRequest,\n ecomV1ShippingOption_universal_d_GetShippingOptionResponse as GetShippingOptionResponse,\n ecomV1ShippingOption_universal_d_UpdateShippingOptionRequest as UpdateShippingOptionRequest,\n ecomV1ShippingOption_universal_d_UpdateShippingOptionResponse as UpdateShippingOptionResponse,\n ecomV1ShippingOption_universal_d_DeleteShippingOptionRequest as DeleteShippingOptionRequest,\n ecomV1ShippingOption_universal_d_DeleteShippingOptionResponse as DeleteShippingOptionResponse,\n ecomV1ShippingOption_universal_d_QueryShippingOptionsRequest as QueryShippingOptionsRequest,\n CursorQuery$2 as CursorQuery,\n CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n CursorPaging$3 as CursorPaging,\n ecomV1ShippingOption_universal_d_QueryShippingOptionsResponse as QueryShippingOptionsResponse,\n CursorPagingMetadata$2 as CursorPagingMetadata,\n Cursors$3 as Cursors,\n UpdateExtendedFieldsRequest$1 as UpdateExtendedFieldsRequest,\n UpdateExtendedFieldsResponse$1 as UpdateExtendedFieldsResponse,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n Empty$2 as Empty,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n ecomV1ShippingOption_universal_d_createShippingOption as createShippingOption,\n ecomV1ShippingOption_universal_d_getShippingOption as getShippingOption,\n ecomV1ShippingOption_universal_d_updateShippingOption as updateShippingOption,\n ecomV1ShippingOption_universal_d_UpdateShippingOption as UpdateShippingOption,\n ecomV1ShippingOption_universal_d_UpdateShippingOptionOptions as UpdateShippingOptionOptions,\n ecomV1ShippingOption_universal_d_deleteShippingOption as deleteShippingOption,\n ecomV1ShippingOption_universal_d_queryShippingOptions as queryShippingOptions,\n ecomV1ShippingOption_universal_d_ShippingOptionsQueryResult as ShippingOptionsQueryResult,\n ecomV1ShippingOption_universal_d_ShippingOptionsQueryBuilder as ShippingOptionsQueryBuilder,\n updateExtendedFields$1 as updateExtendedFields,\n UpdateExtendedFieldsOptions$1 as UpdateExtendedFieldsOptions,\n };\n }\n \n interface ShippoConfiguration {\n /**\n * ShippoConfiguration ID.\n * @readonly\n */\n _id?: string | null;\n /** @readonly */\n revision?: string | null;\n /**\n * Date and time the ShippoConfiguration was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the ShippoConfiguration was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Associated delivery region ID. */\n deliveryRegionId?: string | null;\n /** Settings of USPS domestic services. */\n domesticServices?: DomesticServiceSettings[];\n /** Settings of USPS international services. */\n internationalServices?: InternationalServiceSettings[];\n /** Package type. */\n packageType?: PackageType;\n /** Package details. */\n packageDetails?: PackageDetails;\n /** Location ID from OS location service. */\n osLocationId?: string | null;\n /**\n * Ship from address materialized from OS location.\n * @readonly\n */\n shipFromAddress?: Address$2;\n /** Backup weight. */\n backupWeight?: string | null;\n /** Data extensions. */\n extendedFields?: ExtendedFields$1;\n }\n interface DomesticServiceSettings {\n /** USPS domestic service. */\n service?: DomesticService;\n /** Service settings. */\n serviceSettings?: ServiceSettings;\n }\n enum DomesticService {\n UNKNOWN_DOMESTIC_SERVICE = \"UNKNOWN_DOMESTIC_SERVICE\",\n GROUND_ADVANTAGE = \"GROUND_ADVANTAGE\",\n PRIORITY_MAIL = \"PRIORITY_MAIL\",\n PRIORITY_MAIL_EXPRESS = \"PRIORITY_MAIL_EXPRESS\"\n }\n interface ServiceSettings {\n /** Estimated delivery time. */\n estimatedDeliveryTime?: string | null;\n /** Handling fee. */\n handlingFee?: HandlingFee;\n /** Amount above which free delivery is offered. */\n freeDeliveryMinimumAmount?: string | null;\n }\n interface HandlingFee {\n /** Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee. */\n value?: string;\n /** How to calculate the fee: fixed amount or by percentage. */\n calculationType?: CalculationType;\n }\n enum CalculationType {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n FIXED = \"FIXED\",\n PERCENTAGE = \"PERCENTAGE\"\n }\n interface InternationalServiceSettings {\n /** USPS international service. */\n service?: InternationalService;\n /** Service settings. */\n serviceSettings?: ServiceSettings;\n }\n enum InternationalService {\n UNKNOWN_INTERNATIONAL_SERVICE = \"UNKNOWN_INTERNATIONAL_SERVICE\",\n FIRST_CLASS_PACKAGE_INTERNATIONAL = \"FIRST_CLASS_PACKAGE_INTERNATIONAL\",\n PRIORITY_MAIL_INTERNATIONAL = \"PRIORITY_MAIL_INTERNATIONAL\",\n PRIORITY_MAIL_EXPRESS_INTERNATIONAL = \"PRIORITY_MAIL_EXPRESS_INTERNATIONAL\"\n }\n enum PackageType {\n UNKNOWN_PACKAGE_TYPE = \"UNKNOWN_PACKAGE_TYPE\",\n CUSTOM = \"CUSTOM\",\n FLAT_RATE_ENVELOPE = \"FLAT_RATE_ENVELOPE\",\n PADDED_FLAT_RATE_ENVELOPE = \"PADDED_FLAT_RATE_ENVELOPE\",\n SMALL_FLAT_RATE_BOX = \"SMALL_FLAT_RATE_BOX\",\n MEDIUM_FLAT_RATE_BOX_1 = \"MEDIUM_FLAT_RATE_BOX_1\",\n MEDIUM_FLAT_RATE_BOX_2 = \"MEDIUM_FLAT_RATE_BOX_2\",\n LARGE_FLAT_RATE_BOX = \"LARGE_FLAT_RATE_BOX\"\n }\n interface PackageDetails {\n /**\n * Package name. Must be set when package type is CUSTOM.\n * For other package types, it is read-only, and an exception will be thrown\n * if it set when creating a ShippoConfiguration.\n */\n name?: string | null;\n /**\n * Package dimensions. Can only be set when package type is CUSTOM.\n * For other package types, it is read-only, and an exception will be thrown\n * if it set when creating a ShippoConfiguration.\n */\n dimensions?: PackageDimensions;\n /**\n * Maximum number of products. Must be set when package type is NOT CUSTOM.\n * Otherwise, if the package type is CUSTOM, this field cannot be set and an\n * exception will be thrown if it is set when creating a ShippoConfiguration.\n */\n maxNumberOfProducts?: string | null;\n }\n interface PackageDimensions {\n /** Package length. */\n length?: string;\n /** Package width. */\n width?: string;\n /** Package height. */\n height?: string;\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$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 /** @internal */\n location?: AddressLocation$2;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$2 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$2 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | 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 CreateShippoConfigurationRequest {\n /** ShippoConfiguration to be created. */\n shippoConfiguration: ShippoConfiguration;\n backupRate?: string | null;\n }\n interface CreateShippoConfigurationResponse {\n /** The created ShippoConfiguration. */\n shippoConfiguration?: ShippoConfiguration;\n }\n interface GetShippoConfigurationRequest {\n /** ID of the ShippoConfiguration to retrieve. */\n shippoConfigurationId: string;\n }\n interface GetShippoConfigurationResponse {\n /** The requested ShippoConfiguration. */\n shippoConfiguration?: ShippoConfiguration;\n }\n interface UpdateShippoConfigurationRequest {\n /** ShippoConfiguration to be updated, may be partial. */\n shippoConfiguration: ShippoConfiguration;\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateShippoConfigurationResponse {\n /** Updated ShippoConfiguration. */\n shippoConfiguration?: ShippoConfiguration;\n }\n interface DeleteShippoConfigurationRequest {\n /** ID of the ShippoConfiguration to delete. */\n shippoConfigurationId: string;\n }\n interface DeleteShippoConfigurationResponse {\n }\n interface QueryShippoConfigurationsRequest {\n /** WQL expression. */\n query?: CursorQuery$1;\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$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 }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$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 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 QueryShippoConfigurationsResponse {\n /** List of ShippoConfigurations. */\n shippoConfigurations?: ShippoConfiguration[];\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 /** Cursor strings that point to the next page, previous page, or both. */\n cursors?: Cursors$2;\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$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 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 /** Updated ShippoConfiguration. */\n shippoConfiguration?: ShippoConfiguration;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n interface Empty$1 {\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$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$2;\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$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 ShippoConfiguration.\n * @param shippoConfiguration - ShippoConfiguration to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField shippoConfiguration\n * @requiredField shippoConfiguration.deliveryRegionId\n * @requiredField shippoConfiguration.osLocationId\n * @requiredField shippoConfiguration.packageDetails\n * @requiredField shippoConfiguration.packageDetails.dimensions.height\n * @requiredField shippoConfiguration.packageDetails.dimensions.length\n * @requiredField shippoConfiguration.packageDetails.dimensions.width\n * @requiredField shippoConfiguration.packageType\n * @permissionId ECOM.SHIPPO_CONFIGURATION_CREATE\n * @adminMethod\n * @returns The created ShippoConfiguration.\n */\n function createShippoConfiguration(shippoConfiguration: ShippoConfiguration, options?: CreateShippoConfigurationOptions): Promise;\n interface CreateShippoConfigurationOptions {\n backupRate?: string | null;\n }\n /**\n * Retrieves a ShippoConfiguration.\n * @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField shippoConfigurationId\n * @permissionId ECOM.SHIPPO_CONFIGURATION_READ\n * @adminMethod\n * @returns The requested ShippoConfiguration.\n */\n function getShippoConfiguration(shippoConfigurationId: string): Promise;\n /**\n * Updates a ShippoConfiguration.\n * @param _id - ShippoConfiguration ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField shippoConfiguration\n * @requiredField shippoConfiguration.revision\n * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE\n * @adminMethod\n * @returns Updated ShippoConfiguration.\n */\n function updateShippoConfiguration(_id: string | null, shippoConfiguration: UpdateShippoConfiguration, options?: UpdateShippoConfigurationOptions): Promise;\n interface UpdateShippoConfiguration {\n /**\n * ShippoConfiguration ID.\n * @readonly\n */\n _id?: string | null;\n /** @readonly */\n revision?: string | null;\n /**\n * Date and time the ShippoConfiguration was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the ShippoConfiguration was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Associated delivery region ID. */\n deliveryRegionId?: string | null;\n /** Settings of USPS domestic services. */\n domesticServices?: DomesticServiceSettings[];\n /** Settings of USPS international services. */\n internationalServices?: InternationalServiceSettings[];\n /** Package type. */\n packageType?: PackageType;\n /** Package details. */\n packageDetails?: PackageDetails;\n /** Location ID from OS location service. */\n osLocationId?: string | null;\n /**\n * Ship from address materialized from OS location.\n * @readonly\n */\n shipFromAddress?: Address$2;\n /** Backup weight. */\n backupWeight?: string | null;\n /** Data extensions. */\n extendedFields?: ExtendedFields$1;\n }\n interface UpdateShippoConfigurationOptions {\n /**\n * Set of fields to update.\n *\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes a ShippoConfiguration.\n * @param shippoConfigurationId - ID of the ShippoConfiguration to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField shippoConfigurationId\n * @permissionId ECOM.SHIPPO_CONFIGURATION_DELETE\n * @adminMethod\n */\n function deleteShippoConfiguration(shippoConfigurationId: string): Promise;\n /**\n * Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].\n *\n * Up to 1,000 ShippoConfigurations can be returned per request.\n *\n * To learn how to query ShippoConfigurations, 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 * @permissionId ECOM.SHIPPO_CONFIGURATION_READ\n * @adminMethod\n */\n function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;\n interface QueryCursorResult$2 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ShippoConfigurationsQueryResult extends QueryCursorResult$2 {\n items: ShippoConfiguration[];\n query: ShippoConfigurationsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ShippoConfigurationsQueryBuilder {\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' | 'deliveryRegionId', value: any) => ShippoConfigurationsQueryBuilder;\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' | 'deliveryRegionId', value: any) => ShippoConfigurationsQueryBuilder;\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' | 'deliveryRegionId', value: string) => ShippoConfigurationsQueryBuilder;\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' | 'deliveryRegionId', value: any[]) => ShippoConfigurationsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'deliveryRegionId', value: any) => ShippoConfigurationsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'deliveryRegionId', value: boolean) => ShippoConfigurationsQueryBuilder;\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' | 'deliveryRegionId'>) => ShippoConfigurationsQueryBuilder;\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' | 'deliveryRegionId'>) => ShippoConfigurationsQueryBuilder;\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) => ShippoConfigurationsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ShippoConfigurationsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates extended fields of a ShippoConfiguration without incrementing 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 ECOM.SHIPPO_CONFIGURATION_UPDATE\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 \n type ecomV1ShippoConfiguration_universal_d_ShippoConfiguration = ShippoConfiguration;\n type ecomV1ShippoConfiguration_universal_d_DomesticServiceSettings = DomesticServiceSettings;\n type ecomV1ShippoConfiguration_universal_d_DomesticService = DomesticService;\n const ecomV1ShippoConfiguration_universal_d_DomesticService: typeof DomesticService;\n type ecomV1ShippoConfiguration_universal_d_ServiceSettings = ServiceSettings;\n type ecomV1ShippoConfiguration_universal_d_HandlingFee = HandlingFee;\n type ecomV1ShippoConfiguration_universal_d_CalculationType = CalculationType;\n const ecomV1ShippoConfiguration_universal_d_CalculationType: typeof CalculationType;\n type ecomV1ShippoConfiguration_universal_d_InternationalServiceSettings = InternationalServiceSettings;\n type ecomV1ShippoConfiguration_universal_d_InternationalService = InternationalService;\n const ecomV1ShippoConfiguration_universal_d_InternationalService: typeof InternationalService;\n type ecomV1ShippoConfiguration_universal_d_PackageType = PackageType;\n const ecomV1ShippoConfiguration_universal_d_PackageType: typeof PackageType;\n type ecomV1ShippoConfiguration_universal_d_PackageDetails = PackageDetails;\n type ecomV1ShippoConfiguration_universal_d_PackageDimensions = PackageDimensions;\n type ecomV1ShippoConfiguration_universal_d_CreateShippoConfigurationRequest = CreateShippoConfigurationRequest;\n type ecomV1ShippoConfiguration_universal_d_CreateShippoConfigurationResponse = CreateShippoConfigurationResponse;\n type ecomV1ShippoConfiguration_universal_d_GetShippoConfigurationRequest = GetShippoConfigurationRequest;\n type ecomV1ShippoConfiguration_universal_d_GetShippoConfigurationResponse = GetShippoConfigurationResponse;\n type ecomV1ShippoConfiguration_universal_d_UpdateShippoConfigurationRequest = UpdateShippoConfigurationRequest;\n type ecomV1ShippoConfiguration_universal_d_UpdateShippoConfigurationResponse = UpdateShippoConfigurationResponse;\n type ecomV1ShippoConfiguration_universal_d_DeleteShippoConfigurationRequest = DeleteShippoConfigurationRequest;\n type ecomV1ShippoConfiguration_universal_d_DeleteShippoConfigurationResponse = DeleteShippoConfigurationResponse;\n type ecomV1ShippoConfiguration_universal_d_QueryShippoConfigurationsRequest = QueryShippoConfigurationsRequest;\n type ecomV1ShippoConfiguration_universal_d_QueryShippoConfigurationsResponse = QueryShippoConfigurationsResponse;\n type ecomV1ShippoConfiguration_universal_d_UpdateExtendedFieldsRequest = UpdateExtendedFieldsRequest;\n type ecomV1ShippoConfiguration_universal_d_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;\n const ecomV1ShippoConfiguration_universal_d_createShippoConfiguration: typeof createShippoConfiguration;\n type ecomV1ShippoConfiguration_universal_d_CreateShippoConfigurationOptions = CreateShippoConfigurationOptions;\n const ecomV1ShippoConfiguration_universal_d_getShippoConfiguration: typeof getShippoConfiguration;\n const ecomV1ShippoConfiguration_universal_d_updateShippoConfiguration: typeof updateShippoConfiguration;\n type ecomV1ShippoConfiguration_universal_d_UpdateShippoConfiguration = UpdateShippoConfiguration;\n type ecomV1ShippoConfiguration_universal_d_UpdateShippoConfigurationOptions = UpdateShippoConfigurationOptions;\n const ecomV1ShippoConfiguration_universal_d_deleteShippoConfiguration: typeof deleteShippoConfiguration;\n const ecomV1ShippoConfiguration_universal_d_queryShippoConfigurations: typeof queryShippoConfigurations;\n type ecomV1ShippoConfiguration_universal_d_ShippoConfigurationsQueryResult = ShippoConfigurationsQueryResult;\n type ecomV1ShippoConfiguration_universal_d_ShippoConfigurationsQueryBuilder = ShippoConfigurationsQueryBuilder;\n const ecomV1ShippoConfiguration_universal_d_updateExtendedFields: typeof updateExtendedFields;\n type ecomV1ShippoConfiguration_universal_d_UpdateExtendedFieldsOptions = UpdateExtendedFieldsOptions;\n namespace ecomV1ShippoConfiguration_universal_d {\n export {\n ecomV1ShippoConfiguration_universal_d_ShippoConfiguration as ShippoConfiguration,\n ecomV1ShippoConfiguration_universal_d_DomesticServiceSettings as DomesticServiceSettings,\n ecomV1ShippoConfiguration_universal_d_DomesticService as DomesticService,\n ecomV1ShippoConfiguration_universal_d_ServiceSettings as ServiceSettings,\n ecomV1ShippoConfiguration_universal_d_HandlingFee as HandlingFee,\n ecomV1ShippoConfiguration_universal_d_CalculationType as CalculationType,\n ecomV1ShippoConfiguration_universal_d_InternationalServiceSettings as InternationalServiceSettings,\n ecomV1ShippoConfiguration_universal_d_InternationalService as InternationalService,\n ecomV1ShippoConfiguration_universal_d_PackageType as PackageType,\n ecomV1ShippoConfiguration_universal_d_PackageDetails as PackageDetails,\n ecomV1ShippoConfiguration_universal_d_PackageDimensions as PackageDimensions,\n Address$2 as Address,\n StreetAddress$2 as StreetAddress,\n AddressLocation$2 as AddressLocation,\n ExtendedFields$1 as ExtendedFields,\n ecomV1ShippoConfiguration_universal_d_CreateShippoConfigurationRequest as CreateShippoConfigurationRequest,\n ecomV1ShippoConfiguration_universal_d_CreateShippoConfigurationResponse as CreateShippoConfigurationResponse,\n ecomV1ShippoConfiguration_universal_d_GetShippoConfigurationRequest as GetShippoConfigurationRequest,\n ecomV1ShippoConfiguration_universal_d_GetShippoConfigurationResponse as GetShippoConfigurationResponse,\n ecomV1ShippoConfiguration_universal_d_UpdateShippoConfigurationRequest as UpdateShippoConfigurationRequest,\n ecomV1ShippoConfiguration_universal_d_UpdateShippoConfigurationResponse as UpdateShippoConfigurationResponse,\n ecomV1ShippoConfiguration_universal_d_DeleteShippoConfigurationRequest as DeleteShippoConfigurationRequest,\n ecomV1ShippoConfiguration_universal_d_DeleteShippoConfigurationResponse as DeleteShippoConfigurationResponse,\n ecomV1ShippoConfiguration_universal_d_QueryShippoConfigurationsRequest as QueryShippoConfigurationsRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$2 as CursorPaging,\n ecomV1ShippoConfiguration_universal_d_QueryShippoConfigurationsResponse as QueryShippoConfigurationsResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$2 as Cursors,\n ecomV1ShippoConfiguration_universal_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest,\n ecomV1ShippoConfiguration_universal_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n Empty$1 as Empty,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n ecomV1ShippoConfiguration_universal_d_createShippoConfiguration as createShippoConfiguration,\n ecomV1ShippoConfiguration_universal_d_CreateShippoConfigurationOptions as CreateShippoConfigurationOptions,\n ecomV1ShippoConfiguration_universal_d_getShippoConfiguration as getShippoConfiguration,\n ecomV1ShippoConfiguration_universal_d_updateShippoConfiguration as updateShippoConfiguration,\n ecomV1ShippoConfiguration_universal_d_UpdateShippoConfiguration as UpdateShippoConfiguration,\n ecomV1ShippoConfiguration_universal_d_UpdateShippoConfigurationOptions as UpdateShippoConfigurationOptions,\n ecomV1ShippoConfiguration_universal_d_deleteShippoConfiguration as deleteShippoConfiguration,\n ecomV1ShippoConfiguration_universal_d_queryShippoConfigurations as queryShippoConfigurations,\n ecomV1ShippoConfiguration_universal_d_ShippoConfigurationsQueryResult as ShippoConfigurationsQueryResult,\n ecomV1ShippoConfiguration_universal_d_ShippoConfigurationsQueryBuilder as ShippoConfigurationsQueryBuilder,\n ecomV1ShippoConfiguration_universal_d_updateExtendedFields as updateExtendedFields,\n ecomV1ShippoConfiguration_universal_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions,\n };\n }\n \n interface TotalsCalculationEntity {\n }\n interface CalculateTotalsRequest extends CalculateTotalsRequestCouponOneOf, CalculateTotalsRequestGiftCardOneOf {\n /** Coupon ID. */\n couponId?: string | null;\n /** Coupon code. */\n couponCode?: string | null;\n /** Gift card ID. */\n giftCardId?: string | null;\n /** Gift card code. */\n giftCardCode?: string | null;\n /**\n * Calculation ID. An identifier of the entity that you are calculating totals for, for example, cart ID or checkout ID.\n * This value will be used in order to optimise calculations by caching.\n * If not passed, calculation might be slower in some cases.\n */\n calculationId?: string | null;\n /** Line items for calculation. */\n lineItems?: LineItem[];\n /** Shipping address for tax and shipping calculation (if applicable). */\n shippingAddress?: Address$1;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$1;\n /** Details about selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /**\n * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart/checkout.\n * @deprecated\n */\n merchantDiscounts?: MerchantDiscountInput[];\n /** Buyer email. Used to enforce coupon [single-use per customer](https://support.wix.com/en/article/wix-stores-limiting-coupon-usage). If not passed, single coupon usage per customer will not be enforced. */\n buyerEmail?: string | null;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n * @internal\n */\n calculateTax?: boolean | null;\n /**\n * Member id to use for this calculation\n * When not provided, given that the caller is a member, its member id will be used\n * Providing this require elevated permissions - ECOM.ADMIN_CALCULATE_TOTALS\n */\n memberId?: string | null;\n /**\n * The selected memberships and which line items they apply to\n * When not provided, default selection will be returned\n * You can also set it to empty selection\n */\n selectedMemberships?: SelectedMemberships;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n * @internal\n */\n calculateShipping?: boolean | null;\n /** Buyer phone number. Used to get shipping rates. */\n buyerPhone?: string | null;\n /**\n * Whether to calculate discount rules in the calculation request. If not passed, discount rules are being calculated.\n * @internal\n */\n calculateDiscountRules?: boolean | null;\n /**\n * Shipping information that will be used instead of calculated shipping info.\n * @internal\n */\n shippingOptions?: CarrierShippingOption[];\n /**\n * Applied discounts that will be used instead of calculated discounts.\n * @internal\n */\n appliedDiscounts?: AppliedDiscount[];\n /**\n * Additional Fees that will be used instead of calculated additional fees\n * @internal\n */\n additionalFees?: AdditionalFee[];\n /**\n * List of data that should not be fetched by Totals calculator\n * @internal\n */\n skipDataFetch?: DataFetchType[];\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\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 * @internal\n */\n externalReferences?: ExternalReference[];\n /**\n * The business location ID to be used as the basis for some calculations.\n * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n * @internal\n */\n businessLocationId?: string | null;\n }\n /** @oneof */\n interface CalculateTotalsRequestCouponOneOf {\n /** Coupon ID. */\n couponId?: string | null;\n /** Coupon code. */\n couponCode?: string | null;\n }\n /** @oneof */\n interface CalculateTotalsRequestGiftCardOneOf {\n /** Gift card ID. */\n giftCardId?: string | null;\n /** Gift card code. */\n giftCardCode?: string | null;\n }\n interface LineItem {\n /** Line item ID. */\n _id?: string;\n /** Quantity. */\n quantity?: number | null;\n /**\n * Optional references to the line item's origin catalog.\n * See [Catalog SPI](https://bo.wix.com/wix-docs/rest/ecommerce/catalog-spi/introduction) for more details.\n * This field may be empty in the case of a custom line item.\n * currently we only use the catalog app id to set tax=0 for specific apps.\n */\n catalogReference?: CatalogReference$2;\n /** Product/booking/event name. */\n productName?: string | null;\n /** Price. */\n price?: string;\n /** Physical properties (if applicable). */\n physicalProperties?: PhysicalProperties$1;\n /**\n * Coupon scopes - which app and items a coupon applies to.\n * This field is internal to Wix, and should be used by Bookings, Stores and Events as used by the current [Coupons API](https://bo.wix.com/wix-docs/rest/stores/coupons/valid-scope-values).\n * @internal\n */\n couponScopes?: Scope[];\n /**\n * Tax group ID.\n * @internal\n */\n taxGroupId?: string | null;\n /**\n * Shipping group ID.\n * @internal\n */\n shippingGroupId?: string | null;\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 /** full price of the item before all the discounts */\n fullPrice?: string | null;\n /** The Item's Delivery Profile Id */\n deliveryProfileId?: string | null;\n /** Item type. Either a preset type or custom. */\n itemType?: ItemType;\n /**\n * Address to be used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress;\n /**\n * Additional Fees to be added to used for calculation.\n * @internal\n * @readonly\n */\n additionalFees?: ApiV1AdditionalFee[];\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 [app dashboard](https://dev.wix.com/dc3/my-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 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 Scope {\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 interface SubscriptionSettings {\n /** Frequency of recurring payment. Every day/week/month/year. */\n frequency?: SubscriptionFrequency;\n /**\n * *Optional** - Interval of recurring payment. Defaults to 1 if not provided.\n * @internal\n */\n interval?: number | null;\n /**\n * Whether this subscription offers a free trial period.\n * @internal\n */\n freeTrial?: boolean;\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 this item happens as part of the checkout. */\n FULL_PAYMENT_ONLINE = \"FULL_PAYMENT_ONLINE\",\n /** The entire payment for this item happens after 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 checkout. The 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 {\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 | null;\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 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 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 interface ApiV1AdditionalFee {\n /** Additional fee's unique code or ID. */\n code?: string | null;\n /**\n * Additional fee's name.\n *\n * Max: 50 characters\n */\n name?: string;\n /** Total additional fees. This `price` does not include any taxes that may apply to these additional fees. */\n price?: string;\n /**\n * Tax details.\n *\n * > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.\n */\n taxDetails?: V1TaxDetails;\n /**\n * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** Tax details. */\n interface V1TaxDetails {\n /** Whether additional fee is taxable. */\n taxable?: boolean;\n /** Reserved for internal use. */\n taxGroupId?: string | null;\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$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 /** @internal */\n location?: AddressLocation$1;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$1 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\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 MerchantDiscountInput {\n /** Discount amount. */\n amount?: string;\n /** IDs of line items the discount applies to. */\n lineItemIds?: 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 CarrierShippingOption {\n /** This carrier's unique ID */\n carrierId?: string | null;\n /** Shipping service 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;\n /**\n * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$1[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | 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$1;\n /**\n * Expected delivery time slot (from and to time stamps representation)\n * @internal\n */\n deliveryTimeSlot?: DeliveryTimeSlot$1;\n }\n interface PickupDetails$1 {\n /** Pickup address. */\n address?: Address$1;\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 | null;\n /** ending time of the delivery time slot */\n to?: Date | null;\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 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 OtherCharge {\n /** Type of additional cost. */\n type?: ChargeType$1;\n /** Price of added cost. */\n price?: MultiCurrencyPrice;\n }\n enum ChargeType$1 {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface DeliveryAllocation$1 {\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n deliveryCarrier?: Carrier$1;\n /** The delivery region that are relevant for this delivery solution. */\n deliveryRegion?: Region$1;\n /** Populated if the delivery solution is a partially supplied by this carrier. */\n applicableLineItems?: ApplicableLineItems$1;\n }\n interface Carrier$1 {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface Region$1 {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface ApplicableLineItems$1 {\n /** Line items that the delivery solution is for. */\n lineItemIds?: string[];\n }\n interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {\n /** Coupon details. */\n coupon?: Coupon;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount;\n /** Discount rule */\n discountRule?: DiscountRule;\n /** Discount type. */\n discountType?: DiscountType;\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 * Discount ID.\n * @internal\n */\n _id?: string | null;\n /**\n * Line items the discount applies to.\n * @internal\n */\n lineItemDiscounts?: LineItemDiscount[];\n /**\n * Number of subscription cycle this discount applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\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 * Coupon type: We want it to be an enum and not a string but currently we have no time to do it so we leave it as is to be aligned with cart summary.\n * @internal\n * @deprecated\n */\n couponType?: string;\n }\n interface MerchantDiscount {\n /** Discount value. */\n amount?: MultiCurrencyPrice;\n /** Discount Percentage. Will be calculated from items price before other discounts. */\n percentage?: number | null;\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 LineItemDiscount {\n /** ID of line item the discount applies to. */\n _id?: string;\n /** Discount value. */\n totalDiscountAmount?: MultiCurrencyPrice;\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 /** Currency */\n currency?: string;\n /** Tax details */\n taxDetails?: TaxDetails;\n /** Provider's app id */\n providerAppId?: string | null;\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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** Tax Details. */\n interface TaxDetails {\n /** Indication if additional fee is taxable or not */\n taxable?: boolean;\n /** Optional tax group ID to use when calculating tax for this additional fee */\n taxGroupId?: string | null;\n }\n enum DataFetchType {\n SHIPPING = \"SHIPPING\",\n DISCOUNT = \"DISCOUNT\",\n ADDITIONAL_FEES = \"ADDITIONAL_FEES\",\n ORDER_VALIDATION = \"ORDER_VALIDATION\"\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 CalculateTotalsResponse {\n /** Calculate line items. */\n calculatedLineItems?: CalculatedLineItem[];\n /** Price summary. */\n priceSummary?: PriceSummary;\n /** Details of applied gift card. */\n giftCard?: GiftCard;\n /** Tax summary. */\n taxSummary?: TaxSummary;\n /** Shipping information. */\n shippingInfo?: ShippingInformation;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount[];\n /** Calculation errors. */\n calculationErrors?: CalculationErrors;\n /** Weight unit. */\n weightUnit?: WeightUnit$1;\n /** Currency. */\n currency?: string;\n /**\n * This is the display currency. Converted prices are presented in this currency.\n * @readonly\n */\n conversionCurrency?: string;\n /** Whether tax is included in price. */\n taxIncludedInPrice?: boolean;\n /**\n * Minimal amount to pay in order to place the order.\n * @readonly\n */\n payNow?: PriceSummary;\n /**\n * Remaining amount for the order to be fully paid.\n * @readonly\n */\n payLater?: PriceSummary;\n /** Information about valid and invalid memberships, and which ones are selected for usage. */\n membershipOptions?: MembershipOptions;\n /** Additional Fees */\n additionalFees?: V1AdditionalFee[];\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 checkoutConversionRate?: string | null;\n /**\n * The pay now total amount after the gift card is applied.\n * @readonly\n */\n payNowTotalAfterGiftCard?: MultiCurrencyPrice;\n /**\n * The total amount after gift card is applied.\n * @readonly\n */\n totalAfterGiftCard?: MultiCurrencyPrice;\n /**\n * Payment for subscriptions after free trial period.\n * @internal\n * @readonly\n */\n payAfterFreeTrial?: PriceSummary;\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. Supported values:\n * + `\"FULL_PAYMENT_ONLINE\"` - The entire payment for this item will happen as part of the checkout\n * + `\"FULL_PAYMENT_OFFLINE\"` - The entire payment for this item will happen after the checkout\n * + `\"MEMBERSHIP\"` - This item cannot be paid via monetary payment options, only via non monetary option such membership. When this option is used, price must be set to 0\n * + `\"DEPOSIT_ONLINE\"` - Partial payment of the given item will happen as part of the checkout. Amount to be paid is defined by deposit_amount field.\n */\n paymentOption?: PaymentOptionType;\n /**\n * tax calculation address.\n * @internal\n */\n taxableAddress?: TaxableAddress;\n }\n interface LineItemPricesData {\n /** Total price after discounts and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice;\n /** Total price after discounts, and before tax. */\n totalPriceBeforeTax?: MultiCurrencyPrice;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails;\n /** Total discount for all line items. */\n totalDiscount?: MultiCurrencyPrice;\n /** Catalog price after catalog discount and automatic discounts. */\n price?: MultiCurrencyPrice;\n /** Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided. */\n priceBeforeDiscounts?: MultiCurrencyPrice;\n /** Total price **after** catalog-defined discount and line item discounts. */\n lineItemPrice?: MultiCurrencyPrice;\n /** Item price **before** line item discounts and **before** catalog-defined discount. Defaults to `price` when not provided. */\n fullPrice?: MultiCurrencyPrice;\n }\n interface ItemTaxFullDetails {\n /** Amount for which tax is calculated. */\n taxableAmount?: MultiCurrencyPrice;\n /**\n * Tax group ID, if specified.\n * @internal\n */\n taxGroupId?: string | null;\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`. Deprecated - use 'tax_breakdown' instead.\n * @readonly\n * @deprecated\n */\n rateBreakdown?: TaxRateBreakdown[];\n /**\n * The amount of this line item that was exempt.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice;\n /**\n * True for items we have a tax applied on them\n * @internal\n */\n isItemTaxable?: boolean | null;\n /**\n * True if the lineAmount include tax in it.\n * @internal\n */\n isTaxIncluded?: boolean | null;\n /**\n * The calculator that calculated this line tax\n * @internal\n */\n calculatorName?: string | null;\n /**\n * tax information for a line item.\n * @internal\n * @readonly\n */\n taxBreakdown?: TaxBreakdown[];\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;\n /**\n * The type of tax that was calculated\n * @internal\n */\n taxType?: string | null;\n /**\n * The name of the jurisdiction in which this tax detail applies\n * @internal\n */\n jurisdiction?: string | null;\n /**\n * The type of the jurisdiction in which this tax detail applies(Country,State,County,City,Special).\n * @internal\n */\n jurisdictionType?: string | null;\n /**\n * The amount of this line item that was exempt from this authority.\n * @internal\n */\n exemptAmount?: MultiCurrencyPrice;\n /**\n * ids of the used exemptions from the TaxEstimate exemptions array.\n * @internal\n */\n exemptionIds?: number[];\n /**\n * The taxable amount of this tax detail\n * @internal\n */\n taxableAmount?: MultiCurrencyPrice;\n /**\n * The Taxes/Fee component. True if the fee is applied.\n * @internal\n */\n isFee?: boolean | null;\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;\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;\n /** The taxable amount of this line item. */\n taxableAmount?: MultiCurrencyPrice;\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;\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 PriceSummary {\n /** Subtotal of all line items, before discounts and before tax. */\n subtotal?: MultiCurrencyPrice;\n /** Total shipping price, before discounts and before tax. */\n shipping?: MultiCurrencyPrice;\n /** Total tax. */\n tax?: MultiCurrencyPrice;\n /** Total calculated discount value. */\n discount?: MultiCurrencyPrice;\n /** Total price after discounts, gift cards, and tax. */\n total?: MultiCurrencyPrice;\n /** Total additional fees price before tax. */\n additionalFees?: MultiCurrencyPrice;\n }\n interface GiftCard {\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;\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 {\n /**\n * Amount for which tax is calculated, added from line items.\n * @readonly\n */\n taxableAmount?: MultiCurrencyPrice;\n /**\n * Calculated tax, added from line items.\n * @readonly\n */\n totalTax?: MultiCurrencyPrice;\n /**\n * Manual tax rate\n * @internal\n * @readonly\n * @deprecated\n */\n manualTaxRate?: string;\n /**\n * Tax calculator that was active when the order was created.\n * @deprecated\n */\n calculationDetails?: TaxCalculationDetails;\n /**\n * Tax estimation id in tax service\n * @internal\n * @readonly\n */\n taxEstimationId?: string | null;\n /**\n * Average Tax Rate\n * @internal\n * @readonly\n */\n averageTaxRate?: string | null;\n /**\n * The amount of this estimate that was exempt (for all line items).\n * @internal\n * @readonly\n */\n totalExempt?: MultiCurrencyPrice;\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 * @internal\n * @readonly\n */\n aggregatedTaxBreakdown?: AggregatedTaxBreakdown[];\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$1;\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 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 /**\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;\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;\n /**\n * The sum of all the taxable amount from line items for tax identifiers.\n * @internal\n */\n aggregatedTaxableAmount?: MultiCurrencyPrice;\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$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 * Delivery solution allocations to different delivery carriers and delivery regions\n * @internal\n */\n deliveryAllocations?: DeliveryAllocation$1[];\n /**\n * If the delivery solution is a partial and doesn't apply to all items.\n * @internal\n */\n partial?: boolean | null;\n }\n interface SelectedCarrierServiceOptionPrices {\n /** Total shipping price, after discount and after tax. */\n totalPriceAfterTax?: MultiCurrencyPrice;\n /** Total price of shipping after discounts (when relevant), and before tax. */\n totalPriceBeforeTax?: 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 SelectedCarrierServiceOptionOtherCharge {\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;\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 CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$1;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors;\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$1[];\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 {\n /** General shipping calculation error. */\n generalShippingCalculationError?: Details$1;\n /** Carrier errors. */\n carrierErrors?: CarrierErrors;\n }\n interface Details$1 extends DetailsKindOneOf$1 {\n applicationError?: ApplicationError$1;\n validationError?: ValidationError$1;\n systemError?: SystemError$1;\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$1 {\n applicationError?: ApplicationError$1;\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\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 {\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 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 MembershipOptions {\n /** List of payment options that can be used. */\n eligibleMemberships?: Membership[];\n /** List of payment options that are owned by the member, but cannot be used due to reason provided. */\n invalidMemberships?: InvalidMembership[];\n /** The selected membership payment options and which line items they apply to. */\n selectedMemberships?: SelectedMembership[];\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;\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 | null;\n /** Additional data about this membership. */\n additionalData?: Record | null;\n }\n interface MembershipName {\n /** Membership name. */\n original?: string;\n /** Translated membership name. Defaults to `original` when not provided. */\n translated?: string | null;\n }\n interface MembershipPaymentCredits {\n /** Membership's total amount of credits. */\n total?: number;\n /** Membership's remaining amount of credits. */\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 V1AdditionalFee {\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;\n /** Tax details. */\n taxDetails?: ItemTaxFullDetails;\n /** Provider's app id. */\n providerAppId?: string | null;\n /** Additional fee's price before tax. */\n priceBeforeTax?: MultiCurrencyPrice;\n /** Additional fee's price after tax. */\n priceAfterTax?: MultiCurrencyPrice;\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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /**\n * Returns a totals calculation for specified line items.\n * @public\n * @documentationMaturity preview\n * @requiredField options.lineItems._id\n * @requiredField options.lineItems.price\n * @requiredField options.lineItems.quantity\n * @requiredField options.merchantDiscounts.amount\n * @requiredField options.selectedMemberships.memberships._id\n * @requiredField options.selectedMemberships.memberships.appId\n * @requiredField options.selectedMemberships.memberships.lineItemIds\n * @requiredField options.selectedShippingOption.code\n * @permissionId ECOM.CALCULATE_TOTALS\n * @adminMethod\n */\n function calculateTotals(options?: CalculateTotalsOptions): Promise;\n interface CalculateTotalsOptions extends CalculateTotalsRequestCouponOneOf, CalculateTotalsRequestGiftCardOneOf {\n /**\n * Calculation ID. An identifier of the entity that you are calculating totals for, for example, cart ID or checkout ID.\n * This value will be used in order to optimise calculations by caching.\n * If not passed, calculation might be slower in some cases.\n */\n calculationId?: string | null;\n /** Line items for calculation. */\n lineItems?: LineItem[];\n /** Shipping address for tax and shipping calculation (if applicable). */\n shippingAddress?: Address$1;\n /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */\n billingAddress?: Address$1;\n /** Details about selected shipping option. */\n selectedShippingOption?: SelectedShippingOption;\n /** Coupon ID. */\n couponId?: string | null;\n /** Coupon code. */\n couponCode?: string | null;\n /** Gift card ID. */\n giftCardId?: string | null;\n /** Gift card code. */\n giftCardCode?: string | null;\n /**\n * Merchant discounts to apply to specific line items. If no `lineItemIds` are passed, the discount will be applied to the whole cart/checkout.\n * @deprecated\n */\n merchantDiscounts?: MerchantDiscountInput[];\n /** Buyer email. Used to enforce coupon [single-use per customer](https://support.wix.com/en/article/wix-stores-limiting-coupon-usage). If not passed, single coupon usage per customer will not be enforced. */\n buyerEmail?: string | null;\n /**\n * Whether to calculate tax in the calculation request.\n *\n * Default: `true`\n * @internal\n */\n calculateTax?: boolean | null;\n /**\n * Member id to use for this calculation\n * When not provided, given that the caller is a member, its member id will be used\n * Providing this require elevated permissions - ECOM.ADMIN_CALCULATE_TOTALS\n */\n memberId?: string | null;\n /**\n * The selected memberships and which line items they apply to\n * When not provided, default selection will be returned\n * You can also set it to empty selection\n */\n selectedMemberships?: SelectedMemberships;\n /**\n * Whether to calculate shipping in the calculation request.\n *\n * Default: `true`\n * @internal\n */\n calculateShipping?: boolean | null;\n /** Buyer phone number. Used to get shipping rates. */\n buyerPhone?: string | null;\n /**\n * Whether to calculate discount rules in the calculation request. If not passed, discount rules are being calculated.\n * @internal\n */\n calculateDiscountRules?: boolean | null;\n /**\n * Shipping information that will be used instead of calculated shipping info.\n * @internal\n */\n shippingOptions?: CarrierShippingOption[];\n /**\n * Applied discounts that will be used instead of calculated discounts.\n * @internal\n */\n appliedDiscounts?: AppliedDiscount[];\n /**\n * Additional Fees that will be used instead of calculated additional fees\n * @internal\n */\n additionalFees?: AdditionalFee[];\n /**\n * List of data that should not be fetched by Totals calculator\n * @internal\n */\n skipDataFetch?: DataFetchType[];\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\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 * @internal\n */\n externalReferences?: ExternalReference[];\n /**\n * The business location ID to be used as the basis for some calculations.\n * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n * @internal\n */\n businessLocationId?: string | null;\n }\n \n type ecomV1TotalsCalculation_universal_d_TotalsCalculationEntity = TotalsCalculationEntity;\n type ecomV1TotalsCalculation_universal_d_CalculateTotalsRequest = CalculateTotalsRequest;\n type ecomV1TotalsCalculation_universal_d_CalculateTotalsRequestCouponOneOf = CalculateTotalsRequestCouponOneOf;\n type ecomV1TotalsCalculation_universal_d_CalculateTotalsRequestGiftCardOneOf = CalculateTotalsRequestGiftCardOneOf;\n type ecomV1TotalsCalculation_universal_d_LineItem = LineItem;\n type ecomV1TotalsCalculation_universal_d_Scope = Scope;\n type ecomV1TotalsCalculation_universal_d_Group = Group;\n type ecomV1TotalsCalculation_universal_d_SubscriptionSettings = SubscriptionSettings;\n type ecomV1TotalsCalculation_universal_d_SubscriptionFrequency = SubscriptionFrequency;\n const ecomV1TotalsCalculation_universal_d_SubscriptionFrequency: typeof SubscriptionFrequency;\n type ecomV1TotalsCalculation_universal_d_PaymentOptionType = PaymentOptionType;\n const ecomV1TotalsCalculation_universal_d_PaymentOptionType: typeof PaymentOptionType;\n type ecomV1TotalsCalculation_universal_d_ServiceProperties = ServiceProperties;\n type ecomV1TotalsCalculation_universal_d_ItemType = ItemType;\n type ecomV1TotalsCalculation_universal_d_ItemTypeItemTypeDataOneOf = ItemTypeItemTypeDataOneOf;\n type ecomV1TotalsCalculation_universal_d_ItemTypeItemType = ItemTypeItemType;\n const ecomV1TotalsCalculation_universal_d_ItemTypeItemType: typeof ItemTypeItemType;\n type ecomV1TotalsCalculation_universal_d_TaxableAddress = TaxableAddress;\n type ecomV1TotalsCalculation_universal_d_TaxableAddressTaxableAddressDataOneOf = TaxableAddressTaxableAddressDataOneOf;\n type ecomV1TotalsCalculation_universal_d_TaxableAddressType = TaxableAddressType;\n const ecomV1TotalsCalculation_universal_d_TaxableAddressType: typeof TaxableAddressType;\n type ecomV1TotalsCalculation_universal_d_ApiV1AdditionalFee = ApiV1AdditionalFee;\n type ecomV1TotalsCalculation_universal_d_V1TaxDetails = V1TaxDetails;\n type ecomV1TotalsCalculation_universal_d_SelectedShippingOption = SelectedShippingOption;\n type ecomV1TotalsCalculation_universal_d_MerchantDiscountInput = MerchantDiscountInput;\n type ecomV1TotalsCalculation_universal_d_SelectedMemberships = SelectedMemberships;\n type ecomV1TotalsCalculation_universal_d_SelectedMembership = SelectedMembership;\n type ecomV1TotalsCalculation_universal_d_CarrierShippingOption = CarrierShippingOption;\n type ecomV1TotalsCalculation_universal_d_ShippingOption = ShippingOption;\n type ecomV1TotalsCalculation_universal_d_ShippingPrice = ShippingPrice;\n type ecomV1TotalsCalculation_universal_d_MultiCurrencyPrice = MultiCurrencyPrice;\n type ecomV1TotalsCalculation_universal_d_OtherCharge = OtherCharge;\n type ecomV1TotalsCalculation_universal_d_AppliedDiscount = AppliedDiscount;\n type ecomV1TotalsCalculation_universal_d_AppliedDiscountDiscountSourceOneOf = AppliedDiscountDiscountSourceOneOf;\n type ecomV1TotalsCalculation_universal_d_DiscountType = DiscountType;\n const ecomV1TotalsCalculation_universal_d_DiscountType: typeof DiscountType;\n type ecomV1TotalsCalculation_universal_d_Coupon = Coupon;\n type ecomV1TotalsCalculation_universal_d_MerchantDiscount = MerchantDiscount;\n type ecomV1TotalsCalculation_universal_d_DiscountRule = DiscountRule;\n type ecomV1TotalsCalculation_universal_d_DiscountRuleName = DiscountRuleName;\n type ecomV1TotalsCalculation_universal_d_LineItemDiscount = LineItemDiscount;\n type ecomV1TotalsCalculation_universal_d_AdditionalFee = AdditionalFee;\n type ecomV1TotalsCalculation_universal_d_TaxDetails = TaxDetails;\n type ecomV1TotalsCalculation_universal_d_DataFetchType = DataFetchType;\n const ecomV1TotalsCalculation_universal_d_DataFetchType: typeof DataFetchType;\n type ecomV1TotalsCalculation_universal_d_ExternalReference = ExternalReference;\n type ecomV1TotalsCalculation_universal_d_CalculateTotalsResponse = CalculateTotalsResponse;\n type ecomV1TotalsCalculation_universal_d_CalculatedLineItem = CalculatedLineItem;\n type ecomV1TotalsCalculation_universal_d_LineItemPricesData = LineItemPricesData;\n type ecomV1TotalsCalculation_universal_d_ItemTaxFullDetails = ItemTaxFullDetails;\n type ecomV1TotalsCalculation_universal_d_TaxRateBreakdown = TaxRateBreakdown;\n type ecomV1TotalsCalculation_universal_d_TaxBreakdown = TaxBreakdown;\n type ecomV1TotalsCalculation_universal_d_JurisdictionType = JurisdictionType;\n const ecomV1TotalsCalculation_universal_d_JurisdictionType: typeof JurisdictionType;\n type ecomV1TotalsCalculation_universal_d_PriceSummary = PriceSummary;\n type ecomV1TotalsCalculation_universal_d_GiftCard = GiftCard;\n type ecomV1TotalsCalculation_universal_d_TaxSummary = TaxSummary;\n type ecomV1TotalsCalculation_universal_d_TaxCalculationDetails = TaxCalculationDetails;\n type ecomV1TotalsCalculation_universal_d_TaxCalculationDetailsCalculationDetailsOneOf = TaxCalculationDetailsCalculationDetailsOneOf;\n type ecomV1TotalsCalculation_universal_d_RateType = RateType;\n const ecomV1TotalsCalculation_universal_d_RateType: typeof RateType;\n type ecomV1TotalsCalculation_universal_d_ManualCalculationReason = ManualCalculationReason;\n const ecomV1TotalsCalculation_universal_d_ManualCalculationReason: typeof ManualCalculationReason;\n type ecomV1TotalsCalculation_universal_d_AutoTaxFallbackCalculationDetails = AutoTaxFallbackCalculationDetails;\n type ecomV1TotalsCalculation_universal_d_FallbackReason = FallbackReason;\n const ecomV1TotalsCalculation_universal_d_FallbackReason: typeof FallbackReason;\n type ecomV1TotalsCalculation_universal_d_AggregatedTaxBreakdown = AggregatedTaxBreakdown;\n type ecomV1TotalsCalculation_universal_d_ShippingInformation = ShippingInformation;\n type ecomV1TotalsCalculation_universal_d_ShippingRegion = ShippingRegion;\n type ecomV1TotalsCalculation_universal_d_SelectedCarrierServiceOption = SelectedCarrierServiceOption;\n type ecomV1TotalsCalculation_universal_d_SelectedCarrierServiceOptionPrices = SelectedCarrierServiceOptionPrices;\n type ecomV1TotalsCalculation_universal_d_SelectedCarrierServiceOptionOtherCharge = SelectedCarrierServiceOptionOtherCharge;\n type ecomV1TotalsCalculation_universal_d_CarrierServiceOption = CarrierServiceOption;\n type ecomV1TotalsCalculation_universal_d_CalculationErrors = CalculationErrors;\n type ecomV1TotalsCalculation_universal_d_CalculationErrorsShippingCalculationErrorOneOf = CalculationErrorsShippingCalculationErrorOneOf;\n type ecomV1TotalsCalculation_universal_d_CarrierErrors = CarrierErrors;\n type ecomV1TotalsCalculation_universal_d_MembershipOptions = MembershipOptions;\n type ecomV1TotalsCalculation_universal_d_Membership = Membership;\n type ecomV1TotalsCalculation_universal_d_MembershipName = MembershipName;\n type ecomV1TotalsCalculation_universal_d_MembershipPaymentCredits = MembershipPaymentCredits;\n type ecomV1TotalsCalculation_universal_d_InvalidMembership = InvalidMembership;\n type ecomV1TotalsCalculation_universal_d_V1AdditionalFee = V1AdditionalFee;\n const ecomV1TotalsCalculation_universal_d_calculateTotals: typeof calculateTotals;\n type ecomV1TotalsCalculation_universal_d_CalculateTotalsOptions = CalculateTotalsOptions;\n namespace ecomV1TotalsCalculation_universal_d {\n export {\n ecomV1TotalsCalculation_universal_d_TotalsCalculationEntity as TotalsCalculationEntity,\n ecomV1TotalsCalculation_universal_d_CalculateTotalsRequest as CalculateTotalsRequest,\n ecomV1TotalsCalculation_universal_d_CalculateTotalsRequestCouponOneOf as CalculateTotalsRequestCouponOneOf,\n ecomV1TotalsCalculation_universal_d_CalculateTotalsRequestGiftCardOneOf as CalculateTotalsRequestGiftCardOneOf,\n ecomV1TotalsCalculation_universal_d_LineItem as LineItem,\n CatalogReference$2 as CatalogReference,\n PhysicalProperties$1 as PhysicalProperties,\n ecomV1TotalsCalculation_universal_d_Scope as Scope,\n ecomV1TotalsCalculation_universal_d_Group as Group,\n ecomV1TotalsCalculation_universal_d_SubscriptionSettings as SubscriptionSettings,\n ecomV1TotalsCalculation_universal_d_SubscriptionFrequency as SubscriptionFrequency,\n ecomV1TotalsCalculation_universal_d_PaymentOptionType as PaymentOptionType,\n ecomV1TotalsCalculation_universal_d_ServiceProperties as ServiceProperties,\n ecomV1TotalsCalculation_universal_d_ItemType as ItemType,\n ecomV1TotalsCalculation_universal_d_ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOf,\n ecomV1TotalsCalculation_universal_d_ItemTypeItemType as ItemTypeItemType,\n ecomV1TotalsCalculation_universal_d_TaxableAddress as TaxableAddress,\n ecomV1TotalsCalculation_universal_d_TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOf,\n ecomV1TotalsCalculation_universal_d_TaxableAddressType as TaxableAddressType,\n ecomV1TotalsCalculation_universal_d_ApiV1AdditionalFee as ApiV1AdditionalFee,\n ecomV1TotalsCalculation_universal_d_V1TaxDetails as V1TaxDetails,\n Address$1 as Address,\n StreetAddress$1 as StreetAddress,\n AddressLocation$1 as AddressLocation,\n ecomV1TotalsCalculation_universal_d_SelectedShippingOption as SelectedShippingOption,\n ecomV1TotalsCalculation_universal_d_MerchantDiscountInput as MerchantDiscountInput,\n ecomV1TotalsCalculation_universal_d_SelectedMemberships as SelectedMemberships,\n ecomV1TotalsCalculation_universal_d_SelectedMembership as SelectedMembership,\n ecomV1TotalsCalculation_universal_d_CarrierShippingOption as CarrierShippingOption,\n ecomV1TotalsCalculation_universal_d_ShippingOption as ShippingOption,\n DeliveryLogistics$1 as DeliveryLogistics,\n PickupDetails$1 as PickupDetails,\n PickupMethod$1 as PickupMethod,\n DeliveryTimeSlot$1 as DeliveryTimeSlot,\n ecomV1TotalsCalculation_universal_d_ShippingPrice as ShippingPrice,\n ecomV1TotalsCalculation_universal_d_MultiCurrencyPrice as MultiCurrencyPrice,\n ecomV1TotalsCalculation_universal_d_OtherCharge as OtherCharge,\n ChargeType$1 as ChargeType,\n DeliveryAllocation$1 as DeliveryAllocation,\n Carrier$1 as Carrier,\n Region$1 as Region,\n ApplicableLineItems$1 as ApplicableLineItems,\n ecomV1TotalsCalculation_universal_d_AppliedDiscount as AppliedDiscount,\n ecomV1TotalsCalculation_universal_d_AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOf,\n ecomV1TotalsCalculation_universal_d_DiscountType as DiscountType,\n ecomV1TotalsCalculation_universal_d_Coupon as Coupon,\n ecomV1TotalsCalculation_universal_d_MerchantDiscount as MerchantDiscount,\n ecomV1TotalsCalculation_universal_d_DiscountRule as DiscountRule,\n ecomV1TotalsCalculation_universal_d_DiscountRuleName as DiscountRuleName,\n ecomV1TotalsCalculation_universal_d_LineItemDiscount as LineItemDiscount,\n ecomV1TotalsCalculation_universal_d_AdditionalFee as AdditionalFee,\n ecomV1TotalsCalculation_universal_d_TaxDetails as TaxDetails,\n ecomV1TotalsCalculation_universal_d_DataFetchType as DataFetchType,\n ecomV1TotalsCalculation_universal_d_ExternalReference as ExternalReference,\n ecomV1TotalsCalculation_universal_d_CalculateTotalsResponse as CalculateTotalsResponse,\n ecomV1TotalsCalculation_universal_d_CalculatedLineItem as CalculatedLineItem,\n ecomV1TotalsCalculation_universal_d_LineItemPricesData as LineItemPricesData,\n ecomV1TotalsCalculation_universal_d_ItemTaxFullDetails as ItemTaxFullDetails,\n ecomV1TotalsCalculation_universal_d_TaxRateBreakdown as TaxRateBreakdown,\n ecomV1TotalsCalculation_universal_d_TaxBreakdown as TaxBreakdown,\n ecomV1TotalsCalculation_universal_d_JurisdictionType as JurisdictionType,\n ecomV1TotalsCalculation_universal_d_PriceSummary as PriceSummary,\n ecomV1TotalsCalculation_universal_d_GiftCard as GiftCard,\n ecomV1TotalsCalculation_universal_d_TaxSummary as TaxSummary,\n ecomV1TotalsCalculation_universal_d_TaxCalculationDetails as TaxCalculationDetails,\n ecomV1TotalsCalculation_universal_d_TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOf,\n ecomV1TotalsCalculation_universal_d_RateType as RateType,\n ecomV1TotalsCalculation_universal_d_ManualCalculationReason as ManualCalculationReason,\n ecomV1TotalsCalculation_universal_d_AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetails,\n ecomV1TotalsCalculation_universal_d_FallbackReason as FallbackReason,\n ApplicationError$1 as ApplicationError,\n ecomV1TotalsCalculation_universal_d_AggregatedTaxBreakdown as AggregatedTaxBreakdown,\n ecomV1TotalsCalculation_universal_d_ShippingInformation as ShippingInformation,\n ecomV1TotalsCalculation_universal_d_ShippingRegion as ShippingRegion,\n ecomV1TotalsCalculation_universal_d_SelectedCarrierServiceOption as SelectedCarrierServiceOption,\n ecomV1TotalsCalculation_universal_d_SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPrices,\n ecomV1TotalsCalculation_universal_d_SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherCharge,\n ecomV1TotalsCalculation_universal_d_CarrierServiceOption as CarrierServiceOption,\n ecomV1TotalsCalculation_universal_d_CalculationErrors as CalculationErrors,\n ecomV1TotalsCalculation_universal_d_CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOf,\n Details$1 as Details,\n DetailsKindOneOf$1 as DetailsKindOneOf,\n ValidationError$1 as ValidationError,\n RuleType$1 as RuleType,\n FieldViolation$1 as FieldViolation,\n SystemError$1 as SystemError,\n ecomV1TotalsCalculation_universal_d_CarrierErrors as CarrierErrors,\n CarrierError$1 as CarrierError,\n WeightUnit$1 as WeightUnit,\n ecomV1TotalsCalculation_universal_d_MembershipOptions as MembershipOptions,\n ecomV1TotalsCalculation_universal_d_Membership as Membership,\n ecomV1TotalsCalculation_universal_d_MembershipName as MembershipName,\n ecomV1TotalsCalculation_universal_d_MembershipPaymentCredits as MembershipPaymentCredits,\n ecomV1TotalsCalculation_universal_d_InvalidMembership as InvalidMembership,\n ecomV1TotalsCalculation_universal_d_V1AdditionalFee as V1AdditionalFee,\n ecomV1TotalsCalculation_universal_d_calculateTotals as calculateTotals,\n ecomV1TotalsCalculation_universal_d_CalculateTotalsOptions as CalculateTotalsOptions,\n };\n }\n \n interface DeliveryRatesGateway {\n /** @readonly */\n _id?: string | null;\n }\n interface GetDeliveryOptionsRequest {\n /** list of items to delivery that each of them points to delivery profile and delivery rule. */\n items: DeliverableItem[];\n /** Destination the items should deliver to */\n destination: Address;\n /** Origin the items should deliver from */\n origin?: Address;\n /** Currency - Defaults to site's currency */\n currency: string | null;\n /** Contact details */\n buyerDetails?: FullAddressContactDetails;\n /** Measure unit - defaults to site's weight unit */\n weightUnit?: WeightUnit;\n /** list of delivery preferences which are delivery options codes combined with provider app id */\n userIntent?: UserIntent[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /** Whether tax is included in the items' prices. */\n taxIncludedInPrices?: boolean | null;\n }\n interface DeliverableItem {\n /** The ID of the line item. */\n _id?: string;\n /** Item name. */\n name?: string;\n /** The number of items ordered. */\n quantity?: number;\n /** Reference to the item's origin catalog. */\n catalogReference?: CatalogReference$1;\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties;\n /** Price of a single item after discounts. */\n price?: string;\n /** Total line item price before discounts. */\n totalPriceBeforeDiscount?: string | null;\n /** Price of a single item before discounts. */\n priceBeforeDiscount?: string | null;\n /** Total line item price after discounts. This is equal to `price` multiplied by `quantity`. */\n totalPrice?: string | null;\n /** For delivery rates by delivery profile id */\n deliveryProfileId?: string | null;\n /** whether tax is included in line item price */\n taxIncludedInPrice?: boolean | null;\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 [app dashboard](https://dev.wix.com/dc3/my-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 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 /** Physical address */\n interface Address extends AddressStreetOneOf {\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. 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision[];\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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's first name. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /**\n * Contact's full name.\n * @internal\n */\n fullName?: string | null;\n /** Contact's phone number. */\n phone?: string | null;\n /** Contact's company name. */\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 /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\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 UserIntent {\n /** The provider app id */\n appId?: string | null;\n /** Delivery option code to be used by the TPA as a hint to what delivery option to use */\n code?: string;\n }\n /**\n * Each delivery option has a list of items that can be delivered by it - the chosen one\n * on Errors throw a business error from TC to catch and trigger destination completion\n */\n interface GetDeliveryOptionsResponse {\n /** Delivery Options with their associated items */\n deliveryOptions?: DeliveryOption[];\n /** If a carrier could not calculate shipping rates, the error will be detailed here */\n errors?: CarrierError[];\n }\n interface DeliveryOption {\n /** If the delivery option is a partial and doesn't apply to all items, this field will be populated. */\n partial?: PartialDeliveryOption;\n /** The delivery option details */\n details?: DeliveryDetails;\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n carrierDetails?: CarrierDetails[];\n /** The delivery option's region details, could be multiple if the delivery option is a combination of multiple profiles */\n regionDetails?: RegionDetails[];\n }\n interface PartialDeliveryOption {\n /** Items that the delivery option is for. If empty, the delivery option is for all items. */\n itemIds?: string[];\n }\n interface DeliveryDetails {\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n /** Delivery rate title. For example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"`, or `\"First-Class Package International\"`. */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics;\n /** Delivery cost. */\n cost?: DeliveryCost;\n }\n interface DeliveryLogistics {\n /** When the item is expected to be delivered in free text. For example, `\"3-5 business days\"`. */\n deliveryTime?: string | null;\n /** Instructions for delivery. For example, for pickup: `\"Ensure to come during business hours, and please don't park in the disabled spot\"`. */\n instructions?: string | null;\n /** Pickup details. Should be returned only if order is for pickup. */\n pickupDetails?: PickupDetails;\n /** Date and Time of the delivery option */\n deliveryTimeSlot?: DeliveryTimeSlot;\n }\n interface PickupDetails {\n /** Pickup address. */\n address?: Address;\n /**\n * Pickup method.\n *\n * Supported values:\n * + `\"STORE_PICKUP\"`: When pickup is from the merchant's brick and mortar store.\n * + `\"PICKUP_POINT\"`: When item is shipped to a specified pickup point.\n */\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 DeliveryTimeSlot {\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 DeliveryCost {\n /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */\n price?: string;\n /** Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function under the `metadata` field. */\n currency?: string;\n /** Additional costs. For example, a handling fee for packaging fragile items. */\n additionalCharges?: AdditionalCharge[];\n }\n interface AdditionalCharge {\n /** Additional charge type. */\n type?: ChargeType;\n /** Description of the additional charge. For example, `\"Handling fee of $5 applied for gift wrapping\"`. */\n description?: string | null;\n /** Cost of additional charge. For example, `12.5`. */\n price?: string;\n }\n enum ChargeType {\n HANDLING_FEE = \"HANDLING_FEE\"\n }\n interface CarrierDetails {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface RegionDetails {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface CarrierError {\n /** The carrier app id */\n appId?: string | null;\n /** The error details */\n errorDetails?: Details;\n }\n interface Details extends DetailsKindOneOf {\n applicationError?: ApplicationError;\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;\n validationError?: ValidationError;\n systemError?: SystemError;\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 /**\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 EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\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 ProviderErrors {\n /** The list of errors the providers returned. */\n errors?: CarrierError[];\n }\n interface GetDeliverySolutionsRequest {\n /** list of items to delivery that each of them points to delivery profile and delivery rule. */\n lineItems: DeliverableItem[];\n /** Destination the items should deliver to */\n destination: Address;\n /** Origin the items should deliver from */\n origin?: Address;\n /** Currency - Defaults to site's currency */\n currency: string | null;\n /** Contact details */\n contactDetails?: FullAddressContactDetails;\n /** Measure unit - defaults to site's weight unit */\n weightUnit?: WeightUnit;\n /** list of user preferences which are delivery options codes combined with delivery carrier app id */\n userPreferences?: UserPreference[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n interface UserPreference {\n /** The delivery carrier app id */\n appId?: string | null;\n /** The delivery option code */\n code?: string;\n }\n /**\n * Each delivery option has a list of items that can be delivered by it - the chosen one\n * on Errors throw a business error from TC to catch and trigger destination completion\n */\n interface GetDeliverySolutionsResponse {\n /** Delivery Options with their associated items */\n deliverySolutions?: DeliverySolution[];\n /** If a delivery carrier could not calculate rates, the error will be detailed here */\n errors?: DeliveryCarrierError[];\n }\n interface DeliverySolution {\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n /** Delivery rate title. For example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"`, or `\"First-Class Package International\"`. */\n title?: string;\n /** Delivery logistics. */\n logistics?: DeliveryLogistics;\n /** Delivery cost. */\n cost?: DeliveryCost;\n /** Delivery solution allocations to different delivery carriers and delivery regions */\n deliveryAllocations?: DeliveryAllocation[];\n /** If the delivery solution is a partial and doesn't apply to all items. */\n partial?: boolean | null;\n }\n interface DeliveryAllocation {\n /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */\n deliveryCarrier?: Carrier;\n /** The delivery region that are relevant for this delivery solution. */\n deliveryRegion?: Region;\n /** Populated if the delivery solution is a partially supplied by this carrier. */\n applicableLineItems?: ApplicableLineItems;\n }\n interface Carrier {\n /** The carrier app id */\n appId?: string | null;\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n }\n interface Region {\n /** The delivery region id. */\n _id?: string | null;\n /** The delivery region name. */\n name?: string | null;\n }\n interface ApplicableLineItems {\n /** Line items that the delivery solution is for. */\n lineItemIds?: string[];\n }\n interface DeliveryCarrierError {\n /** The carrier app id */\n appId?: string | null;\n /** The error details */\n errorDetails?: Details;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n /**\n * Get Delivery Options for the given items from all relevant providers, by destination\n * @param items - list of items to delivery that each of them points to delivery profile and delivery rule.\n * @internal\n * @documentationMaturity preview\n * @requiredField items\n * @requiredField options.currency\n * @requiredField options.destination\n * @requiredField options.destination.country\n * @permissionId ECOM.CALCULATE_DELIVERY\n * @adminMethod\n * @returns Each delivery option has a list of items that can be delivered by it - the chosen one\n * on Errors throw a business error from TC to catch and trigger destination completion\n * @deprecated\n * @targetRemovalDate 2024-11-01\n */\n function getDeliveryOptions(items: DeliverableItem[], options?: GetDeliveryOptions): Promise;\n interface GetDeliveryOptions {\n /** Destination the items should deliver to */\n destination: Address;\n /** Origin the items should deliver from */\n origin?: Address;\n /** Currency - Defaults to site's currency */\n currency: string | null;\n /** Contact details */\n buyerDetails?: FullAddressContactDetails;\n /** Measure unit - defaults to site's weight unit */\n weightUnit?: WeightUnit;\n /** list of delivery preferences which are delivery options codes combined with provider app id */\n userIntent?: UserIntent[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /** Whether tax is included in the items' prices. */\n taxIncludedInPrices?: boolean | null;\n }\n /**\n * Get Delivery Solutions for the given line items from all relevant delivery carriers\n * @param lineItems - list of items to delivery that each of them points to delivery profile and delivery rule.\n * @public\n * @documentationMaturity preview\n * @requiredField lineItems\n * @requiredField options.currency\n * @requiredField options.destination\n * @requiredField options.destination.country\n * @permissionId ECOM.DELIVERY_SOLUTION_READ\n * @returns Each delivery option has a list of items that can be delivered by it - the chosen one\n * on Errors throw a business error from TC to catch and trigger destination completion\n */\n function getDeliverySolutions(lineItems: DeliverableItem[], options?: GetDeliverySolutionsOptions): Promise;\n interface GetDeliverySolutionsOptions {\n /** Destination the items should deliver to */\n destination: Address;\n /** Origin the items should deliver from */\n origin?: Address;\n /** Currency - Defaults to site's currency */\n currency: string | null;\n /** Contact details */\n contactDetails?: FullAddressContactDetails;\n /** Measure unit - defaults to site's weight unit */\n weightUnit?: WeightUnit;\n /** list of user preferences which are delivery options codes combined with delivery carrier app id */\n userPreferences?: UserPreference[];\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n }\n \n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryRatesGateway = DeliveryRatesGateway;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliveryOptionsRequest = GetDeliveryOptionsRequest;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliverableItem = DeliverableItem;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_PhysicalProperties = PhysicalProperties;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_Address = Address;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_StreetAddress = StreetAddress;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_AddressLocation = AddressLocation;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_Subdivision = Subdivision;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_SubdivisionType = SubdivisionType;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_SubdivisionType: typeof SubdivisionType;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_FullAddressContactDetails = FullAddressContactDetails;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_VatId = VatId;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_VatType = VatType;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_VatType: typeof VatType;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_WeightUnit = WeightUnit;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_WeightUnit: typeof WeightUnit;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_UserIntent = UserIntent;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliveryOptionsResponse = GetDeliveryOptionsResponse;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryOption = DeliveryOption;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_PartialDeliveryOption = PartialDeliveryOption;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryDetails = DeliveryDetails;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryLogistics = DeliveryLogistics;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_PickupDetails = PickupDetails;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_PickupMethod = PickupMethod;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_PickupMethod: typeof PickupMethod;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryTimeSlot = DeliveryTimeSlot;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryCost = DeliveryCost;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_AdditionalCharge = AdditionalCharge;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_ChargeType = ChargeType;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_ChargeType: typeof ChargeType;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_CarrierDetails = CarrierDetails;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_RegionDetails = RegionDetails;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_CarrierError = CarrierError;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_Details = Details;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DetailsKindOneOf = DetailsKindOneOf;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_ApplicationError = ApplicationError;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_ValidationError = ValidationError;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_RuleType = RuleType;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_RuleType: typeof RuleType;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_FieldViolation = FieldViolation;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_SystemError = SystemError;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_ProviderErrors = ProviderErrors;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliverySolutionsRequest = GetDeliverySolutionsRequest;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_UserPreference = UserPreference;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliverySolutionsResponse = GetDeliverySolutionsResponse;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliverySolution = DeliverySolution;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryAllocation = DeliveryAllocation;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_Carrier = Carrier;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_Region = Region;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_ApplicableLineItems = ApplicableLineItems;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryCarrierError = DeliveryCarrierError;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_Empty = Empty;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_getDeliveryOptions: typeof getDeliveryOptions;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliveryOptions = GetDeliveryOptions;\n const gatewaysEcomV1DeliveryRatesGateway_universal_d_getDeliverySolutions: typeof getDeliverySolutions;\n type gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliverySolutionsOptions = GetDeliverySolutionsOptions;\n namespace gatewaysEcomV1DeliveryRatesGateway_universal_d {\n export {\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryRatesGateway as DeliveryRatesGateway,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliveryOptionsRequest as GetDeliveryOptionsRequest,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliverableItem as DeliverableItem,\n CatalogReference$1 as CatalogReference,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_PhysicalProperties as PhysicalProperties,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_Address as Address,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_StreetAddress as StreetAddress,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_AddressLocation as AddressLocation,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_Subdivision as Subdivision,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_SubdivisionType as SubdivisionType,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_FullAddressContactDetails as FullAddressContactDetails,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_VatId as VatId,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_VatType as VatType,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_WeightUnit as WeightUnit,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_UserIntent as UserIntent,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliveryOptionsResponse as GetDeliveryOptionsResponse,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryOption as DeliveryOption,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_PartialDeliveryOption as PartialDeliveryOption,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryDetails as DeliveryDetails,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryLogistics as DeliveryLogistics,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_PickupDetails as PickupDetails,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_PickupMethod as PickupMethod,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryTimeSlot as DeliveryTimeSlot,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryCost as DeliveryCost,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_AdditionalCharge as AdditionalCharge,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_ChargeType as ChargeType,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_CarrierDetails as CarrierDetails,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_RegionDetails as RegionDetails,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_CarrierError as CarrierError,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_Details as Details,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DetailsKindOneOf as DetailsKindOneOf,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_ApplicationError as ApplicationError,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_ValidationError as ValidationError,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_RuleType as RuleType,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_FieldViolation as FieldViolation,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_SystemError as SystemError,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_ProviderErrors as ProviderErrors,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliverySolutionsRequest as GetDeliverySolutionsRequest,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_UserPreference as UserPreference,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliverySolutionsResponse as GetDeliverySolutionsResponse,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliverySolution as DeliverySolution,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryAllocation as DeliveryAllocation,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_Carrier as Carrier,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_Region as Region,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_ApplicableLineItems as ApplicableLineItems,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_DeliveryCarrierError as DeliveryCarrierError,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_Empty as Empty,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_getDeliveryOptions as getDeliveryOptions,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliveryOptions as GetDeliveryOptions,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_getDeliverySolutions as getDeliverySolutions,\n gatewaysEcomV1DeliveryRatesGateway_universal_d_GetDeliverySolutionsOptions as GetDeliverySolutionsOptions,\n };\n }\n \n /**\n * Tip settings define how tips are calculated and distributed among staff. When\n * Wix Tips is installed, default settings are automatically created. You can't\n * delete these default settings but you can update them. Creating additional\n * settings allows business owners to customize tip screens for different payment\n * terminals or set specific presets for various products or services.\n */\n interface TipSettings extends TipSettingsIdentifierOneOf {\n /**\n * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)\n * for which the tip settings apply.\n */\n locationId?: string | null;\n /**\n * ID of the payment terminal for which the tip settings apply. Wix Tips doesn't\n * validate the ID you provide.\n *\n * Max: 30 characters\n */\n paymentTerminalId?: string | null;\n /**\n * ID of the Wix user for whom the tip settings apply. For example, the site owner or a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\n userId?: string | null;\n /**\n * ID of the tip settings.\n * @readonly\n */\n _id?: string | null;\n /**\n * Tip type.\n *\n * Supported values:\n * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.\n * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal for all related line items.\n * + `AMOUNT`: The tip is a fixed amount.\n */\n tipType?: TipType$1;\n /**\n * Information about the tip choices that Wix Tips displays to customers during the\n * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n *\n * Min: `1` preset\n * Max: `3` presets\n */\n presets?: Preset[];\n /**\n * Whether customer are allowed to tip during the\n * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n */\n allowCustomerTip?: boolean | null;\n /**\n * Whether the business owners are given the option to add a tip during the\n * payment collection flow in their dashboard.\n *\n * Default: `true`\n */\n allowBusinessTipAtPayment?: boolean | null;\n /**\n * Whether customers can enter a custom tip amount. If set to `false`, customers\n * can only select a tip value from the available `presets` and can't enter a\n * custom amount.\n *\n * Default: `true`\n */\n allowCustomAmount?: boolean | null;\n /**\n * Whether business owners are allowed to edit tip distributions. If set to\n * `false`, owners can't edit distributions after they were created.\n *\n * Default: `true`\n */\n allowEditDistribution?: boolean | null;\n /**\n * How the tip is distributed among staff.\n *\n * Supported values:\n * `UNKNOWN_SPLIT_METHOD`: There is no information about the staff distribution method.\n * `EQUAL`: The tip is distributed equally among all staff.\n * `PROPORTIONAL`: The tip is distributed proportionally among staff.\n */\n staffDistributionMethod?: StaffDistributionMethod;\n /**\n * Revision number, which increments by 1 each time `tipSettings` object is\n * updated. To prevent conflicting changes, the current revision must be passed\n * when updating `tipSettings`. Ignored when creating a `tipSettings` object.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the tip settings were created in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the tip settings were last updated\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Whether these are the default tip settings. Wix Tips automatically creates\n * the default settings during the app's installation. You can't delete these\n * default settings but you can update them. Wix Tips uses the default settings\n * to calculate tips, unless you specify other settings.\n * @readonly\n */\n default?: boolean | null;\n /**\n * ID of the app that has created the settings. See the list of app IDs for\n * [Wix business solutions](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions).\n */\n appId?: string | null;\n /**\n * Custom field data for the `tipSettings` object. Extended fields must be\n * configured in the app dashboard before they can be accessed with API calls.\n */\n extendedFields?: ExtendedFields;\n }\n /** @oneof */\n interface TipSettingsIdentifierOneOf {\n /**\n * ID of the [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)\n * for which the tip settings apply.\n */\n locationId?: string | null;\n /**\n * ID of the payment terminal for which the tip settings apply. Wix Tips doesn't\n * validate the ID you provide.\n *\n * Max: 30 characters\n */\n paymentTerminalId?: string | null;\n /**\n * ID of the Wix user for whom the tip settings apply. For example, the site owner or a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\n userId?: string | null;\n }\n enum TipType$1 {\n /** There is no information about the tip type. */\n UNKNOWN_TIP_TYPE = \"UNKNOWN_TIP_TYPE\",\n /** The tip is calculated as a percentage of the subtotal of all related line items. */\n PERCENTAGE = \"PERCENTAGE\",\n /** The tip is a fixed amount. */\n AMOUNT = \"AMOUNT\"\n }\n interface Preset {\n /**\n * Value of the preset tip choice that's displayed to customers in the\n * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n * For example, `5`, `10`, and `15` percent or `1`, `3`, and `5` USD.\n *\n * Min: `0`\n */\n value?: number | null;\n /**\n * Whether this tip choice value is the dafault preset that's highlighted automatically in the\n * [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n *\n * Default: `false`\n */\n default?: boolean | null;\n }\n enum StaffDistributionMethod {\n /** There is no information about the staff distribution method. */\n UNKNOWN_SPLIT_METHOD = \"UNKNOWN_SPLIT_METHOD\",\n /** All staff receive an equal amount of the tip. */\n EQUAL = \"EQUAL\",\n /** Staff receive a proportional amount of the tip. */\n PROPORTIONAL = \"PROPORTIONAL\"\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 QueryTipSettingsRequest {\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;\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 {\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryTipSettingsResponse {\n /** Retrieved `tipSettings` objects. */\n tipSettings?: TipSettings[];\n /** Metadate for the paged set of retrieved `tipSettings` objects. */\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 * 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 * @internal\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 UpdateTipSettingsRequest {\n /** Tip settings to update. */\n tipSettings: TipSettings;\n /**\n * Field mask.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateTipSettingsResponse {\n /** Updated tip settings. */\n tipSettings?: TipSettings;\n }\n interface CreateTipSettingsRequest {\n /** Tip settings to create. */\n tipSettings: TipSettings;\n }\n interface CreateTipSettingsResponse {\n /** Created tip settings. */\n tipSettings?: TipSettings;\n }\n interface CreateDefaultTipSettingsRequest {\n /** Dafault tip settings to create. */\n tipSettings: TipSettings;\n }\n interface CreateDefaultTipSettingsResponse {\n /** Created default tip settings. */\n tipSettings?: TipSettings;\n }\n interface DeleteTipSettingsRequest {\n /** ID of the `tipSettings` object to delete. */\n tipSettingsId: string | null;\n }\n interface DeleteTipSettingsResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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$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$1;\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$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 query to retrieve a list of tip settings.\n *\n * The `queryTipSettings()` function builds a query to retrieve a list of tip settings and returns a `TipSettingsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/ecom/tip-settings/tip-settings-query-builder/find) function.\n *\n * You can refine the query by chaining `TipSettingsQueryBuilder` functions onto the query. `TipSettingsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTipSettings()` returns.\n *\n * `queryTipSettings()` runs with the following `TipSettingsQueryBuilder` default that you can override:\n *\n * + `limit` is `50`.\n * + Sorted by `id` in ascending order.\n *\n * The functions that are chained to `queryTipSettings()` are applied in the order they are called. For example, if you apply `ascending(\"tipType\")` and then `ascending(\"locationId\")`, the results are sorted first by the `\"tipType\"`, and then, if there are multiple results with the same `\"tipType\"`, the items are sorted by `\"locationId\"`.\n *\n * The following `TipSettingsQueryBuilder` functions are supported for the `queryTipSettings()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/ecom/tip-settings/tip-settings-query-result/items) property in `TipSettingsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_TIPS.TIP_SETTINGS_READ\n */\n function queryTipSettings(): TipSettingsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TipSettingsQueryResult extends QueryCursorResult$1 {\n items: TipSettings[];\n query: TipSettingsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface TipSettingsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default', value: any) => TipSettingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default', value: any) => TipSettingsQueryBuilder;\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: 'locationId' | 'paymentTerminalId' | '_id', value: string) => TipSettingsQueryBuilder;\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: 'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default', value: any[]) => TipSettingsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default', value: any) => TipSettingsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default', value: boolean) => TipSettingsQueryBuilder;\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<'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default'>) => TipSettingsQueryBuilder;\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<'locationId' | 'paymentTerminalId' | '_id' | 'tipType' | 'allowCustomerTip' | 'allowBusinessTipAtPayment' | 'allowCustomAmount' | 'allowEditDistribution' | 'default'>) => TipSettingsQueryBuilder;\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) => TipSettingsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => TipSettingsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates a `tipSettings` object.\n *\n *\n * You can't update the `default` field.\n * @param tipSettings - Tip settings to update.\n * @public\n * @documentationMaturity preview\n * @requiredField tipSettings\n * @param options - Options to use when updating tip settings.\n * @permissionId WIX_TIPS.TIP_SETTINGS_UPDATE\n * @adminMethod\n * @returns Updated tip settings.\n */\n function updateTipSettings(tipSettings: TipSettings, options?: UpdateTipSettingsOptions): Promise;\n interface UpdateTipSettingsOptions {\n /**\n * Field mask.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Creates a `tipSettings` object.\n *\n *\n * You can't create a `tipSettings` object with `{\"default\": true}`.\n * @param tipSettings - Tip settings to create.\n * @public\n * @documentationMaturity preview\n * @requiredField tipSettings\n * @permissionId WIX_TIPS.TIP_SETTINGS_CREATE\n * @adminMethod\n * @returns Created tip settings.\n */\n function createTipSettings(tipSettings: TipSettings): Promise;\n /**\n * Creates a default `tipSettings` object.\n *\n *\n * The call fails if there is already an existing default `tipSettings` object.\n * @param tipSettings - Dafault tip settings to create.\n * @public\n * @documentationMaturity preview\n * @requiredField tipSettings\n * @permissionId WIX_TIPS.TIP_SETTINGS_CREATE\n * @adminMethod\n */\n function createDefaultTipSettings(tipSettings: TipSettings): Promise;\n /**\n * Deletes a `tipSettings` object.\n *\n *\n * You can't delete the default `tipSettings` object.\n * @param tipSettingsId - ID of the `tipSettings` object to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField tipSettingsId\n * @permissionId WIX_TIPS.TIP_SETTINGS_DELETE\n * @adminMethod\n */\n function deleteTipSettings(tipSettingsId: string | null): Promise;\n \n type tipsSettingsV1TipSettings_universal_d_TipSettings = TipSettings;\n type tipsSettingsV1TipSettings_universal_d_TipSettingsIdentifierOneOf = TipSettingsIdentifierOneOf;\n type tipsSettingsV1TipSettings_universal_d_Preset = Preset;\n type tipsSettingsV1TipSettings_universal_d_StaffDistributionMethod = StaffDistributionMethod;\n const tipsSettingsV1TipSettings_universal_d_StaffDistributionMethod: typeof StaffDistributionMethod;\n type tipsSettingsV1TipSettings_universal_d_ExtendedFields = ExtendedFields;\n type tipsSettingsV1TipSettings_universal_d_QueryTipSettingsRequest = QueryTipSettingsRequest;\n type tipsSettingsV1TipSettings_universal_d_QueryV2 = QueryV2;\n type tipsSettingsV1TipSettings_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type tipsSettingsV1TipSettings_universal_d_Paging = Paging;\n type tipsSettingsV1TipSettings_universal_d_QueryTipSettingsResponse = QueryTipSettingsResponse;\n type tipsSettingsV1TipSettings_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type tipsSettingsV1TipSettings_universal_d_UpdateTipSettingsRequest = UpdateTipSettingsRequest;\n type tipsSettingsV1TipSettings_universal_d_UpdateTipSettingsResponse = UpdateTipSettingsResponse;\n type tipsSettingsV1TipSettings_universal_d_CreateTipSettingsRequest = CreateTipSettingsRequest;\n type tipsSettingsV1TipSettings_universal_d_CreateTipSettingsResponse = CreateTipSettingsResponse;\n type tipsSettingsV1TipSettings_universal_d_CreateDefaultTipSettingsRequest = CreateDefaultTipSettingsRequest;\n type tipsSettingsV1TipSettings_universal_d_CreateDefaultTipSettingsResponse = CreateDefaultTipSettingsResponse;\n type tipsSettingsV1TipSettings_universal_d_DeleteTipSettingsRequest = DeleteTipSettingsRequest;\n type tipsSettingsV1TipSettings_universal_d_DeleteTipSettingsResponse = DeleteTipSettingsResponse;\n const tipsSettingsV1TipSettings_universal_d_queryTipSettings: typeof queryTipSettings;\n type tipsSettingsV1TipSettings_universal_d_TipSettingsQueryResult = TipSettingsQueryResult;\n type tipsSettingsV1TipSettings_universal_d_TipSettingsQueryBuilder = TipSettingsQueryBuilder;\n const tipsSettingsV1TipSettings_universal_d_updateTipSettings: typeof updateTipSettings;\n type tipsSettingsV1TipSettings_universal_d_UpdateTipSettingsOptions = UpdateTipSettingsOptions;\n const tipsSettingsV1TipSettings_universal_d_createTipSettings: typeof createTipSettings;\n const tipsSettingsV1TipSettings_universal_d_createDefaultTipSettings: typeof createDefaultTipSettings;\n const tipsSettingsV1TipSettings_universal_d_deleteTipSettings: typeof deleteTipSettings;\n namespace tipsSettingsV1TipSettings_universal_d {\n export {\n tipsSettingsV1TipSettings_universal_d_TipSettings as TipSettings,\n tipsSettingsV1TipSettings_universal_d_TipSettingsIdentifierOneOf as TipSettingsIdentifierOneOf,\n TipType$1 as TipType,\n tipsSettingsV1TipSettings_universal_d_Preset as Preset,\n tipsSettingsV1TipSettings_universal_d_StaffDistributionMethod as StaffDistributionMethod,\n tipsSettingsV1TipSettings_universal_d_ExtendedFields as ExtendedFields,\n tipsSettingsV1TipSettings_universal_d_QueryTipSettingsRequest as QueryTipSettingsRequest,\n tipsSettingsV1TipSettings_universal_d_QueryV2 as QueryV2,\n tipsSettingsV1TipSettings_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n tipsSettingsV1TipSettings_universal_d_Paging as Paging,\n CursorPaging$1 as CursorPaging,\n tipsSettingsV1TipSettings_universal_d_QueryTipSettingsResponse as QueryTipSettingsResponse,\n tipsSettingsV1TipSettings_universal_d_PagingMetadataV2 as PagingMetadataV2,\n Cursors$1 as Cursors,\n tipsSettingsV1TipSettings_universal_d_UpdateTipSettingsRequest as UpdateTipSettingsRequest,\n tipsSettingsV1TipSettings_universal_d_UpdateTipSettingsResponse as UpdateTipSettingsResponse,\n tipsSettingsV1TipSettings_universal_d_CreateTipSettingsRequest as CreateTipSettingsRequest,\n tipsSettingsV1TipSettings_universal_d_CreateTipSettingsResponse as CreateTipSettingsResponse,\n tipsSettingsV1TipSettings_universal_d_CreateDefaultTipSettingsRequest as CreateDefaultTipSettingsRequest,\n tipsSettingsV1TipSettings_universal_d_CreateDefaultTipSettingsResponse as CreateDefaultTipSettingsResponse,\n tipsSettingsV1TipSettings_universal_d_DeleteTipSettingsRequest as DeleteTipSettingsRequest,\n tipsSettingsV1TipSettings_universal_d_DeleteTipSettingsResponse as DeleteTipSettingsResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n tipsSettingsV1TipSettings_universal_d_queryTipSettings as queryTipSettings,\n tipsSettingsV1TipSettings_universal_d_TipSettingsQueryResult as TipSettingsQueryResult,\n tipsSettingsV1TipSettings_universal_d_TipSettingsQueryBuilder as TipSettingsQueryBuilder,\n tipsSettingsV1TipSettings_universal_d_updateTipSettings as updateTipSettings,\n tipsSettingsV1TipSettings_universal_d_UpdateTipSettingsOptions as UpdateTipSettingsOptions,\n tipsSettingsV1TipSettings_universal_d_createTipSettings as createTipSettings,\n tipsSettingsV1TipSettings_universal_d_createDefaultTipSettings as createDefaultTipSettings,\n tipsSettingsV1TipSettings_universal_d_deleteTipSettings as deleteTipSettings,\n };\n }\n \n /**\n * Information about a team member who's eligible to receive a portion of the tip.\n * Currently, only [Bookings staff members](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction)\n * and [site collaborators](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site)\n * are eligible for tip distributions.\n */\n interface Staff$1 {\n /**\n * Staff ID. Matches `staffMemberId` if available, or\n * `identificationData.wixUserId` if not.\n * @readonly\n */\n _id?: string | null;\n /** Staff name. Matches the name of the Bookings staff member if available. */\n name?: string | null;\n /**\n * Staff member ID. Available only if the staff is connected to a\n * Bookings staff member.\n */\n staffMemberId?: string | null;\n /**\n * Identification data of the staff. Available only if the staff is a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\n identificationData?: IdentificationData$1;\n }\n interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {\n /** ID of a site visitor who hasn't logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor who has logged in to the site. */\n memberId?: string;\n /**\n * ID of a Wix user. For example, the site owner or a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /**\n * ID of the [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)\n * in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.\n */\n contactId?: string | null;\n /**\n * @internal\n * @readonly\n */\n identityType?: IdentityType$1;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$1 {\n /** ID of a site visitor who hasn't logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor who has logged in to the site. */\n memberId?: string;\n /**\n * ID of a Wix user. For example, the site owner or a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\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 ListTippableStaffRequest {\n /**\n * Whether to include staff who are only Wix users and not\n * Bookings staff members in the response. Setting `{\"includeWixUsers\": true}` returns all tippable\n * staff, including Bookings staff, site collaborators, or those who are both.\n * By default, or if you provide `{\"includeWixUsers\": false}`, only Bookings\n * staff members or those who are both are returned.\n *\n * Default: `false`.\n */\n includeWixUsers?: boolean;\n /**\n * Filters the returned staff by name. If you provide a name as filter, only\n * staff whose names start with the given input are returned. The filter isn't\n * case sensitive.\n *\n * Max: 500 characters\n */\n filterByName?: string | null;\n /**\n * Filters the returned staff by ID. If you provide a list of IDs as filter,\n * only staff members with exact matching IDs are returned.\n *\n * Max: 100 IDs\n */\n filterByIds?: string[] | null;\n }\n interface ListTippableStaffResponse {\n /** Retrieved staff. */\n staff?: Staff$1[];\n }\n /**\n * Retrieves a list of up to 100 staff who are eligible to receive tips, given\n * the provided filtering.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when listing tippable staff.\n * @permissionId WIX_TIPS.STAFF_READ\n * @adminMethod\n */\n function listTippableStaff(options?: ListTippableStaffOptions): Promise;\n interface ListTippableStaffOptions {\n /**\n * Whether to include staff who are only Wix users and not Bookings staff members in the response. Setting `{\"includeWixUsers\": true}` returns all tippable\n * staff, including Bookings staff, site collaborators, or those who are both.\n * By default, or if you provide `{\"includeWixUsers\": false}`, only Bookings\n * staff members or those who are both are returned.\n *\n * Default: `false`.\n */\n includeWixUsers?: boolean;\n /**\n * Filters the returned staff by name. If you provide a name as filter, only\n * staff whose names start with the given input are returned. The filter isn't\n * case sensitive.\n *\n * Max: 500 characters\n */\n filterByName?: string | null;\n /**\n * Filters the returned staff by ID. If you provide a list of IDs as filter,\n * only staff members with exact matching IDs are returned.\n *\n * Max: 100 IDs\n */\n filterByIds?: string[] | null;\n }\n \n type tipsStaffV1Staff_universal_d_ListTippableStaffRequest = ListTippableStaffRequest;\n type tipsStaffV1Staff_universal_d_ListTippableStaffResponse = ListTippableStaffResponse;\n const tipsStaffV1Staff_universal_d_listTippableStaff: typeof listTippableStaff;\n type tipsStaffV1Staff_universal_d_ListTippableStaffOptions = ListTippableStaffOptions;\n namespace tipsStaffV1Staff_universal_d {\n export {\n Staff$1 as Staff,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n IdentityType$1 as IdentityType,\n tipsStaffV1Staff_universal_d_ListTippableStaffRequest as ListTippableStaffRequest,\n tipsStaffV1Staff_universal_d_ListTippableStaffResponse as ListTippableStaffResponse,\n tipsStaffV1Staff_universal_d_listTippableStaff as listTippableStaff,\n tipsStaffV1Staff_universal_d_ListTippableStaffOptions as ListTippableStaffOptions,\n };\n }\n \n /**\n * A tip holds information about how much a customer has tipped, how the tip is\n * distributed among staff, and the associated order’s line item subtotal.\n */\n interface Tip {\n /**\n * ID of the tip. Identical to the `code` of the related `order.additionalFee`.\n * @readonly\n */\n _id?: string | null;\n /**\n * Subtotal of all line items from the [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)\n * that's related to the tip. In the response of\n * [previewTip()](https://dev.wix.com/docs/sdk/backend-modules/ecom/tips/preview-tip),\n * there is no related eCommerce order. Then, value of this field corresponds to\n * the sum of all line item prices passed in the request.\n * @readonly\n */\n lineItemSubtotal?: string | null;\n /**\n * Total amount of the tip.\n *\n * Min: `0.00`\n */\n amount?: string | null;\n /**\n * Details about how the tip is shared among staff. Available only if at least\n * one staff member receives part of the tip, and it's not entirely allocated to\n * the business.\n *\n * Max: 50 distributions\n */\n distributions?: TipDistribution[];\n /**\n * Undistributed tip amount. Calculated as the difference between `tip.amount`\n * and the sum of all `tip.tipDistributions.amount` values.\n *\n * Min: `0.01`\n * @readonly\n */\n undistributedAmount?: string | null;\n }\n interface TipDistribution {\n /**\n * ID of the tip distribution.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the tip associated with the distribution. Matches the corresponding\n * `order.additionalFee.code`.\n * @readonly\n */\n tipId?: string | null;\n /** Information about the business staff receiving the tip distribution. */\n staff?: Staff;\n /**\n * Amount of the tip distribution.\n *\n * Min: `0.00`\n */\n amount?: string | null;\n /**\n * Details about the related line items from the\n * [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup).\n *\n */\n lineItemInfo?: LineItemInfo[];\n /**\n * Details of how the customer is charged for the tip. Available only if the\n * [transcation](https://dev.wix.com/docs/sdk/backend-modules/ecom/order-transactions/setup)\n * has been created.\n */\n transaction?: Transaction;\n /**\n * ID of the [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup)\n * associated with the tip distribution. Identical for all distributions that\n * belong to the same tip.\n * @readonly\n */\n orderId?: string | null;\n /**\n * Date and time the distribution was created in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Information about who created the tip distributions.\n *\n * Supported values:\n * + `UNKNOWN_SOURCE`: There is no information about who created the tip distributions.\n * + `POS`: The customer added the tip distributions via an external payment terminal.\n * + `WEB`: The customer added the tip distributions during an online [ecommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).\n * + `DASHBOARD`: The business added the tip distributions on behalf of the customer in the site's dashboard.\n * @internal\n */\n source?: Source;\n }\n interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {\n /** ID of a site visitor who hasn't logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor who has logged in to the site. */\n memberId?: string;\n /**\n * ID of a Wix user. For example, the site owner or a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\n wixUserId?: string;\n /** ID of an app. */\n appId?: string;\n /**\n * ID of the [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)\n * in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.\n */\n contactId?: string | null;\n /**\n * @internal\n * @readonly\n */\n identityType?: IdentityType;\n }\n /** @oneof */\n interface CommonIdentificationDataIdOneOf {\n /** ID of a site visitor who hasn't logged in to the site. */\n anonymousVisitorId?: string;\n /** ID of a site visitor who has logged in to the site. */\n memberId?: string;\n /**\n * ID of a Wix user. For example, the site owner or a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\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 Staff {\n /**\n * ID of the staff receiving the tip. Matches `staffMemberId` if available, or\n * `identificationData.wixUserId` if not.\n * @readonly\n */\n _id?: string | null;\n /**\n * Staff name. Matches `staffMember.name` if the staff is a\n * Bookings staff member,\n * or the [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)'s\n * `info.name` if not.\n *\n * Max: 500 characters\n * @readonly\n */\n name?: string | null;\n /**\n * ID of the Bookings staff member.\n * Available only if the staff is a staff member and not a\n * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).\n */\n staffMemberId?: string | null;\n /**\n * Identification data. Available only if the staff is a\n * [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)\n * on the Wix site. Note that not all site collaborators are also\n * [staff members](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction).\n */\n identificationData?: CommonIdentificationData;\n }\n interface LineItemInfo {\n /**\n * IDs of the line items associated with the tip.\n *\n * Min: 1 character\n * Max: 100 characters\n */\n lineItemId?: string | null;\n /**\n * Information about the line item and the corresponding catalog. Catalogs\n * include Wix Bookings and Wix Stores.\n */\n catalogReference?: CatalogReference;\n /**\n * Price of the line item.\n *\n * Min: `0.00`\n */\n price?: string | null;\n /**\n * Name of the line item, which is identical to:\n * + `product.name` for [Stores](https://dev.wix.com/docs/sdk/backend-modules/stores/products/introduction).\n * + `service.name` for [Bookings](https://dev.wix.com/docs/sdk/backend-modules/bookings/introduction).\n *\n * Min: 1 character\n * Max: 200 characters\n */\n name?: string | null;\n /**\n * Quantity of the line item.\n *\n * Min: `1`\n * Max: `100000` (one hundred thousand)\n */\n quantity?: number | null;\n }\n interface CatalogReference {\n /**\n * ID of the line item within its catalog, corresponding to:\n * + `product.id` for [Stores](https://dev.wix.com/docs/rest/business-solutions/stores/about-wix-stores).\n * + `service.id` for [Bookings](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).\n */\n catalogItemId?: string | null;\n /**\n * ID of the [app](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)\n * to which the catalog belongs.\n *\n * Supported app IDs:\n * + [Wix Tips](https://www.wix.com/app-market/wix-tips): `\"869a50c8-dd38-4324-b201-e33dc0747a5f\"`\n * + [Wix Stores](https://www.wix.com/app-market/wix-stores): `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n * + [Wix Bookings](https://www.wix.com/app-market/bookings): `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n * + [Wix Restaurants Orders](https://www.wix.com/app-market/web-solution/wix-restaurants-orders-new): `\"13e8d036-5516-6104-b456-c8466db39542\"`\n */\n appId?: string | null;\n }\n interface Transaction {\n /** ID of the transaction that's associated with the tip distribution. */\n _id?: string | null;\n /**\n * Date and time the transaction was created in `YYYY-MM-DDThh:mm:ss.sssZ`\n * format. Isn't identical to the time the customer was actually charged.\n */\n date?: Date | null;\n }\n enum Source {\n /** There is no information about who created the tip distributions. */\n UNKNOWN_SOURCE = \"UNKNOWN_SOURCE\",\n /** The customer added the tip distributions via an external payment terminal. */\n POS = \"POS\",\n /** The customer added the tip distributions during an online [ecommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction). */\n WEB = \"WEB\",\n /** The business added the tip distributions on behalf of the customer in the site's dashboard. */\n DASHBOARD = \"DASHBOARD\"\n }\n interface PreviewTipRequest {\n /**\n * Information about the line items to preview the tip for.\n *\n * Min: 1 line item\n * Max: 50 line items\n */\n lineItemInfo: LineItemInfo[];\n /**\n * Information about how to calculate the total tip amount and the distribution\n * amounts.\n */\n tipChoice: TipChoice;\n /**\n * ID of the tip settings used to preview the tip. If you don't provide a\n * `tipSettingsId`, the `staffDistributionMethod` is based on the site's\n * default tip settings.\n */\n tipSettingsId?: string | null;\n }\n interface TipChoice {\n /** Value of the tip choice. */\n value?: string | null;\n /**\n * Type of the tip choice.\n *\n * Supported values:\n * + `UNKNOWN_TIP_TYPE`: There is no information about the tip type.\n * + `PERCENTAGE`: The tip is calculated as a percentage of the subtotal of associated line items.\n * + `AMOUNT`: The tip is a fixed value, pre-configured from the relevant settings presets.\n * + `CUSTOM`: The customer, or the business on behalf of the customer, manually set a tip amount, which may not match any preset values.\n */\n tipType?: TipType;\n }\n enum TipType {\n /** There is no information about the tip type. */\n UNKNOWN_TIP_TYPE = \"UNKNOWN_TIP_TYPE\",\n /** The tip is calculated as a percentage of the subtotal of associated line items. */\n PERCENTAGE = \"PERCENTAGE\",\n /** The tip is a fixed value, pre-configured from the relevant settings presets. */\n AMOUNT = \"AMOUNT\",\n /** The customer, or the business on behalf of the customer, manually set a tip amount, which may not match any preset values. */\n CUSTOM = \"CUSTOM\"\n }\n interface PreviewTipResponse {\n /** Tip. */\n tip?: Tip;\n }\n interface GetTipByOrderIdRequest {\n /** ID of the order to retrieve the tip for. */\n orderId: string | null;\n }\n interface GetTipByOrderIdResponse {\n /** Retrieved tip. */\n tip?: Tip;\n }\n interface GetTipByDraftOrderIdRequest {\n /** ID of the draft order to retrieve the tip for. */\n draftOrderId: string | null;\n }\n interface GetTipByDraftOrderIdResponse {\n /** Retrieved tip. */\n tip?: Tip;\n }\n interface GetTipChoiceRequest {\n /**\n * ID of the [eCommerce purchase flow](https://dev.wix.com/docs/rest/business-solutions/e-commerce/wix-e-commerce-platform-handbook/overview/architecture-data-flow)\n * to retrieve the tip choice for.\n */\n purchaseFlowId: string | null;\n }\n interface GetTipChoiceResponse {\n /** Tip choice that's currently selected for the given purchase flow. */\n tipChoice?: TipChoice;\n }\n interface UpdateTipChoiceRequest {\n /**\n * Tip choice to select for the purchase flow. The call fails if you provide a\n * value for `tipChoice.tipType` that doesn't match the relevant tip settings\n * configuration. For example:\n * + `AMOUNT` when `tipSettings.tipType` isn't `AMOUNT`.\n * + `PERCENTAGE` when `tipSettings.tipType` isn't `PERCENTAGE`.\n * + `CUSTOM` when `tipSettings.allowCustomTip` is `false`.\n */\n tipChoice: TipChoice;\n /**\n * ID of the purchase flow that's associated with the\n * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/order/introduction)\n */\n purchaseFlowId: string | null;\n }\n interface UpdateTipChoiceResponse {\n /**\n * Tip choice currently selected in the\n * [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)\n * for the given purchase flow.\n */\n tipChoice?: TipChoice;\n }\n interface SetTipOnOrderRequest extends SetTipOnOrderRequestIdentifierOneOf {\n /** ID of the order for which to set the tip. */\n orderId?: string | null;\n /**\n * ID of the draft order for which to set the tip.\n * @internal\n */\n draftOrderId?: string | null;\n /** Tip to set on the order. */\n tip: Tip;\n }\n /** @oneof */\n interface SetTipOnOrderRequestIdentifierOneOf {\n /** ID of the order for which to set the tip. */\n orderId?: string | null;\n /**\n * ID of the draft order for which to set the tip.\n * @internal\n */\n draftOrderId?: string | null;\n }\n interface SetTipOnOrderResponse {\n /** Set tip. */\n tip?: Tip;\n /** Information about the order on which the tip was set. */\n orderInfo?: OrderInfo;\n }\n interface OrderInfo extends OrderInfoIdentifierOneOf {\n /** Order ID. */\n orderId?: string | null;\n /**\n * Draft order ID.\n * @internal\n */\n draftOrderId?: string | null;\n /** ID of the order's additional fee that's associated with the tip. */\n additionalFeeId?: string | null;\n /** Price of the order's additional fee that's associated with the tip. */\n additionalFeePrice?: Price;\n }\n /** @oneof */\n interface OrderInfoIdentifierOneOf {\n /** Order ID. */\n orderId?: string | null;\n /**\n * Draft order ID.\n * @internal\n */\n draftOrderId?: string | null;\n }\n interface Price {\n /** Amount of the additional fee that's associated with the tip. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n *\n * Max: 100 characters\n * @readonly\n */\n formattedAmount?: string;\n }\n interface RemoveTipFromOrderRequest extends RemoveTipFromOrderRequestIdentifierOneOf {\n /** ID of the order from which to remove the tip. */\n orderId?: string | null;\n /**\n * ID of the draft order from which to remove the tip.\n * @internal\n */\n draftOrderId?: string | null;\n }\n /** @oneof */\n interface RemoveTipFromOrderRequestIdentifierOneOf {\n /** ID of the order from which to remove the tip. */\n orderId?: string | null;\n /**\n * ID of the draft order from which to remove the tip.\n * @internal\n */\n draftOrderId?: string | null;\n }\n interface RemoveTipFromOrderResponse {\n /** Information about the order from which the tip was removed. */\n orderInfo?: OrderInfo;\n }\n interface CreateTipDistributionsRequest {\n /**\n * Tip distributions to create.\n *\n * Min: 1 distribution\n * Max: 50 distributions\n */\n tipDistributions: TipDistribution[];\n /**\n * ID of the order for which to create tip distributions.\n * @internal\n */\n orderId?: string | null;\n /** ID of the tip for which to create distributions. */\n tipId: string | null;\n }\n interface CreateTipDistributionsResponse {\n /**\n * ID of the tip for which the distributions were created.\n * @readonly\n */\n tipId?: string | null;\n /** Created tip distributions. */\n tipDistributions?: TipDistribution[];\n }\n interface DeleteTipDistributionsRequest extends DeleteTipDistributionsRequestDeleteByOneOf {\n /** ID of the tip for which to delete all associated tip distributions. */\n tipId: string | null;\n /** ID of the order for which to delete all associated tip distributions. */\n orderId?: string | null;\n }\n /** @oneof */\n interface DeleteTipDistributionsRequestDeleteByOneOf {\n /** ID of the tip for which to delete all associated tip distributions. */\n tipId?: string | null;\n /** ID of the order for which to delete all associated tip distributions. */\n orderId?: string | null;\n }\n interface DeleteTipDistributionsResponse {\n }\n interface AddTipDistributionsToOrderRequest extends AddTipDistributionsToOrderRequestIdentifierOneOf {\n /** ID of the order for which to add tip distributions. */\n orderId?: string | null;\n /**\n * ID of the draft order for which to add tip distributions.\n * @internal\n */\n draftOrderId?: string | null;\n /** Tip distributions to add to the order. */\n tipDistributions: TipDistribution[];\n }\n /** @oneof */\n interface AddTipDistributionsToOrderRequestIdentifierOneOf {\n /** ID of the order for which to add tip distributions. */\n orderId?: string | null;\n /**\n * ID of the draft order for which to add tip distributions.\n * @internal\n */\n draftOrderId?: string | null;\n }\n interface AddTipDistributionsToOrderResponse {\n /** Tip distributions that were added to the order. */\n tipDistributions?: TipDistribution[];\n /** Information about the order to which the tip distributions were added. */\n orderInfo?: OrderInfo;\n }\n interface QueryTipDistributionsRequest {\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;\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 QueryTipDistributionsResponse {\n /** Retrieved tip distributions. */\n tipDistributions?: TipDistribution[];\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 SumTipDistributionAmountsRequest {\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 interface SumTipDistributionAmountsResponse {\n /** Total amount of tip distributions matching the filter. */\n totalAmount?: string | null;\n }\n interface ApplyTipDistributionsRequest {\n /** ID of the tip for which all tip distributions are applied to the order. */\n tipId: string | null;\n /** ID of the order for which to apply all tip distributions. */\n orderId: string | null;\n /** Whether to query by order ID or tip ID. */\n queryBy?: QueryBy;\n }\n enum QueryBy {\n UNKNOWN_QUERY_BY = \"UNKNOWN_QUERY_BY\",\n ORDER = \"ORDER\",\n TIP = \"TIP\"\n }\n interface ApplyTipDistributionsResponse {\n /** Applied tip distributions. */\n tipDistributions?: TipDistribution[];\n }\n interface PublishTipDistributionsCreatedEventRequest {\n /** The tip distributions that will be published on the event. */\n tipDistributions?: TipDistribution[];\n /** The tip ID of the distributions */\n tipId: string | null;\n /** The order ID that the tip is connected to */\n orderId: string | null;\n }\n interface PublishTipDistributionsCreatedEventResponse {\n }\n interface TipDistributionsCreated {\n /** ID of the tip to which the distribution belongs. */\n tipId?: string | null;\n /**\n * Created tip distributions.\n *\n * Min: 1 tip distribution\n * Max: 100 tip distributions\n */\n tipDistributions?: TipDistribution[];\n /** The order ID that the tip is connected to */\n orderId?: string | null;\n /** The undistributed tip amount */\n undistributedAmount?: 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Previews a tip for a list of line items.\n *\n *\n * If you provide the Wix Bookings app ID `13d21c63-b5ec-5912-8397-c3a5ddb27a97` as `lineItemInfo.catalogReference.appId`, the response includes tip\n * distributions for each associated Bookings staff member.\n *\n * If you don't provide a `tipSettingsId`, the `staffDistributionMethod` is\n * based on the site's default tip settings.\n * @param lineItemInfo - Information about the line items to preview the tip for.\n *\n * Min: 1 line item\n * Max: 50 line items\n * @public\n * @documentationMaturity preview\n * @requiredField lineItemInfo\n * @requiredField lineItemInfo.catalogReference.appId\n * @requiredField lineItemInfo.catalogReference.catalogItemId\n * @requiredField lineItemInfo.price\n * @requiredField options.tipChoice\n * @requiredField options.tipChoice.tipType\n * @requiredField options.tipChoice.value\n * @param options - Options to use when previewing a tip.\n * @permissionId WIX_TIPS.TIP_PREVIEW\n * @adminMethod\n */\n function previewTip(lineItemInfo: LineItemInfo[], options?: PreviewTipOptions): Promise;\n interface PreviewTipOptions {\n /**\n * Information about how to calculate the total tip amount and the distribution\n * amounts.\n */\n tipChoice: TipChoice;\n /**\n * ID of the tip settings used to preview the tip. If you don't provide a\n * `tipSettingsId`, the `staffDistributionMethod` is based on the site's\n * default tip settings.\n */\n tipSettingsId?: string | null;\n }\n /**\n * Retrieves the tip that's associated with an\n * [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup).\n * @param orderId - ID of the order to retrieve the tip for.\n * @public\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId WIX_TIPS.TIP_READ\n * @adminMethod\n */\n function getTipByOrderId(orderId: string | null): Promise;\n /**\n * Retrieves the tip that's associated with an eCommerce draft order.\n *\n *\n *
\n *\n * __Important:__\n * The eCommerce Draft Orders API is currently under development and not yet available to users.\n *\n *
\n * @param draftOrderId - ID of the draft order to retrieve the tip for.\n * @public\n * @documentationMaturity preview\n * @requiredField draftOrderId\n * @permissionId WIX_TIPS.TIP_READ\n * @adminMethod\n */\n function getTipByDraftOrderId(draftOrderId: string | null): Promise;\n /**\n * Retrieves the tip choice that's currently selected by the customer for a specific [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n * If the customer hasn't yet selected a tip choice, the response is empty.\n * @param purchaseFlowId - ID of the [eCommerce purchase flow](https://dev.wix.com/docs/rest/business-solutions/e-commerce/wix-e-commerce-platform-handbook/overview/architecture-data-flow)\n * to retrieve the tip choice for.\n * @public\n * @documentationMaturity preview\n * @requiredField purchaseFlowId\n * @permissionId WIX_TIPS.TIP_GET_CHOICE\n */\n function getTipChoice(purchaseFlowId: string | null): Promise;\n /**\n * Updates the tip choice that's currently selected by the customer for a specific [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n * @param tipChoice - Tip choice to select for the purchase flow. The call fails if you provide a\n * value for `tipChoice.tipType` that doesn't match the relevant tip settings\n * configuration. For example:\n * + `AMOUNT` when `tipSettings.tipType` isn't `AMOUNT`.\n * + `PERCENTAGE` when `tipSettings.tipType` isn't `PERCENTAGE`.\n * + `CUSTOM` when `tipSettings.allowCustomTip` is `false`.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.purchaseFlowId\n * @requiredField tipChoice\n * @param options - Options to use when updating a tip choice.\n * @permissionId WIX_TIPS.TIP_UPDATE_CHOICE\n */\n function updateTipChoice(tipChoice: TipChoice, options: UpdateTipChoiceOptions): Promise;\n interface UpdateTipChoiceOptions {\n /**\n * ID of the purchase flow that's associated with the\n * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/order/introduction)\n */\n purchaseFlowId: string | null;\n }\n /**\n * Updates the tip choice that's currently selected by the customer for a specific [eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n * @public\n * @documentationMaturity preview\n * @requiredField options.tip\n * @requiredField options.tip.distributions.transaction._id\n * @requiredField options.tip.distributions.transaction.date\n * @param options - Options to use when setting a tip on an order.\n * @permissionId WIX_TIPS.TIP_SET\n * @adminMethod\n */\n function setTipOnOrder(options?: SetTipOnOrderOptions): Promise;\n interface SetTipOnOrderOptions extends SetTipOnOrderRequestIdentifierOneOf {\n /** ID of the order for which to set the tip. */\n orderId?: string | null;\n /**\n * ID of the draft order for which to set the tip.\n * @internal\n */\n draftOrderId?: string | null;\n /** Tip to set on the order. */\n tip: Tip;\n }\n /**\n * Removes a tip from an\n * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).\n *\n *\n * If no tip exists on the order, the call succeeds and the response contains an\n * empty `OrderInfo` object.\n *\n * The call fails if the customer has already been charged for at least one of\n * the associated tip distributions.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when removing a tip from an order.\n * @permissionId WIX_TIPS.TIP_REMOVE\n * @adminMethod\n */\n function removeTipFromOrder(options?: RemoveTipFromOrderOptions): Promise;\n interface RemoveTipFromOrderOptions extends RemoveTipFromOrderRequestIdentifierOneOf {\n /** ID of the order from which to remove the tip. */\n orderId?: string | null;\n /**\n * ID of the draft order from which to remove the tip.\n * @internal\n */\n draftOrderId?: string | null;\n }\n /**\n * Adds new distributions to a tip.\n *\n *\n * The total tip amount and `undistributedAmount` remain unchanged.\n *\n * All tip distributions must belong to the same tip.\n *\n * You must provide either a `staffMemberId` or `identificationData.wixUserId`\n * for every distribution to create.\n * @param tipDistributions - Tip distributions to create.\n *\n * Min: 1 distribution\n * Max: 50 distributions\n * @internal\n * @documentationMaturity preview\n * @requiredField options.tipId\n * @requiredField tipDistributions\n * @requiredField tipDistributions.transaction._id\n * @requiredField tipDistributions.transaction.date\n * @param options - Options to use when creating tip distributions.\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_CREATE\n * @adminMethod\n */\n function createTipDistributions(tipDistributions: TipDistribution[], options?: CreateTipDistributionsOptions): Promise;\n interface CreateTipDistributionsOptions {\n /**\n * ID of the order for which to create tip distributions.\n * @internal\n */\n orderId?: string | null;\n /** ID of the tip for which to create distributions. */\n tipId: string | null;\n }\n /**\n * Deletes a tip distribution.\n *\n *\n * The total tip amount and `undistributedAmount` remain unchanged.\n * @param tipId - ID of the tip for which to delete all associated tip distributions.\n * @internal\n * @documentationMaturity preview\n * @requiredField tipId\n * @param options - Options to use when deleting tip distributions.\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_DELETE\n * @adminMethod\n */\n function deleteTipDistributions(tipId: string | null, options?: DeleteTipDistributionsOptions): Promise;\n interface DeleteTipDistributionsOptions extends DeleteTipDistributionsRequestDeleteByOneOf {\n /** ID of the order for which to delete all associated tip distributions. */\n orderId?: string | null;\n }\n /**\n * Adds tip distributions to an\n * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).\n *\n *\n * If no tip exists on the order, an `additionalFee` is added and the total tip\n * amount is equal to the sum of all distribution amounts. If a tip is already\n * present, the existing `additionalFee` is replaced and the total tip amount is\n * increased by the sum of the new tip distributions.\n *\n * The call fails if:\n * + The order's `paymentStatus` is either `FULLY_REFUNDED` or `PARTIALLY_REFUNDED`.\n * + Any of the tip distribution amounts is zero or negative.\n * @public\n * @documentationMaturity preview\n * @requiredField options.tipDistributions\n * @requiredField options.tipDistributions.transaction._id\n * @requiredField options.tipDistributions.transaction.date\n * @param options - Options to use when adding tip distributions to an order.\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_ADD\n * @adminMethod\n */\n function addTipDistributionsToOrder(options?: AddTipDistributionsToOrderOptions): Promise;\n interface AddTipDistributionsToOrderOptions extends AddTipDistributionsToOrderRequestIdentifierOneOf {\n /** ID of the order for which to add tip distributions. */\n orderId?: string | null;\n /**\n * ID of the draft order for which to add tip distributions.\n * @internal\n */\n draftOrderId?: string | null;\n /** Tip distributions to add to the order. */\n tipDistributions: TipDistribution[];\n }\n /**\n * Creates a query to retrieve a list of tip distributions.\n *\n * The `queryTipDistributions()` function builds a query to retrieve a list of tip distributions and returns a `TipDistributionsQueryBuilder` object.\n *\n * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/ecom/tips/tip-distributions-query-builder/find) function.\n *\n * You can refine the query by chaining `TipDistributionsQueryBuilder` functions onto the query. `TipDistributionsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTipDistributions()` returns.\n *\n * `queryTipDistributions()` runs with the following `TipDistributionsQueryBuilder` default that you can override:\n *\n * + `limit` is `50`\n *\n * The functions that are chained to `queryTipDistributions()` are applied in the order they are called. For example, if you apply `ascending(\"transaction.transactionDate\")` and then `ascending(\"staff.id\")`, the results are sorted first by the `\"transaction.transactionDate\"`, and then, if there are multiple results with the same `\"transaction.transactionDate\"`, the items are sorted by `\"staff.id\"`.\n *\n * When setting a date filter remember to use\n * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n *\n * The following `TipDistributionsQueryBuilder` functions are supported for the `queryTipDistributions()` function. For a full description of the tip distributions object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/ecom/tips/tip-distributions-query-result/items) property in `TipDistributionsQueryResult`.\n *\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_READ\n * @adminMethod\n */\n function queryTipDistributions(): TipDistributionsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TipDistributionsQueryResult extends QueryCursorResult {\n items: TipDistribution[];\n query: TipDistributionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface TipDistributionsQueryBuilder {\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) => TipDistributionsQueryBuilder;\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) => TipDistributionsQueryBuilder;\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) => TipDistributionsQueryBuilder;\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[]) => TipDistributionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id', value: any) => TipDistributionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id', value: boolean) => TipDistributionsQueryBuilder;\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'>) => TipDistributionsQueryBuilder;\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'>) => TipDistributionsQueryBuilder;\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) => TipDistributionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => TipDistributionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Sums tip distribution amounts, given the provided filtering.\n * @param filter - 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 * @public\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_READ\n * @adminMethod\n */\n function sumTipDistributionAmounts(filter: Record | null): Promise;\n /**\n * Applies all tip distributions associated with the given tip as a single\n * `additionalFee` to an\n * [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).\n *\n *\n * You don't need to provide an order ID, it's automatically determined from the tip\n * distributions.\n *\n * Any existing tip distributions linked to the same order, but associated with\n * a different tip, are deleted.\n * @param tipId - ID of the tip for which all tip distributions are applied to the order.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.orderId\n * @requiredField tipId\n * @param options - Options to use when applying tip distributions.\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_SET\n * @adminMethod\n */\n function applyTipDistributions(tipId: string | null, options?: ApplyTipDistributionsOptions): Promise;\n interface ApplyTipDistributionsOptions {\n /** ID of the order for which to apply all tip distributions. */\n orderId: string | null;\n /** Whether to query by order ID or tip ID. */\n queryBy?: QueryBy;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField options.orderId\n * @requiredField options.tipId\n * @permissionId WIX_TIPS.TIP_DISTRIBUTION_PUBLISH\n * @adminMethod\n */\n function publishTipDistributionsCreatedEvent(options?: PublishTipDistributionsCreatedEventOptions): Promise;\n interface PublishTipDistributionsCreatedEventOptions {\n /** The tip distributions that will be published on the event. */\n tipDistributions?: TipDistribution[];\n /** The tip ID of the distributions */\n tipId: string | null;\n /** The order ID that the tip is connected to */\n orderId: string | null;\n }\n \n type tipsV1Tip_universal_d_Tip = Tip;\n type tipsV1Tip_universal_d_TipDistribution = TipDistribution;\n type tipsV1Tip_universal_d_CommonIdentificationData = CommonIdentificationData;\n type tipsV1Tip_universal_d_CommonIdentificationDataIdOneOf = CommonIdentificationDataIdOneOf;\n type tipsV1Tip_universal_d_IdentityType = IdentityType;\n const tipsV1Tip_universal_d_IdentityType: typeof IdentityType;\n type tipsV1Tip_universal_d_Staff = Staff;\n type tipsV1Tip_universal_d_LineItemInfo = LineItemInfo;\n type tipsV1Tip_universal_d_CatalogReference = CatalogReference;\n type tipsV1Tip_universal_d_Transaction = Transaction;\n type tipsV1Tip_universal_d_Source = Source;\n const tipsV1Tip_universal_d_Source: typeof Source;\n type tipsV1Tip_universal_d_PreviewTipRequest = PreviewTipRequest;\n type tipsV1Tip_universal_d_TipChoice = TipChoice;\n type tipsV1Tip_universal_d_TipType = TipType;\n const tipsV1Tip_universal_d_TipType: typeof TipType;\n type tipsV1Tip_universal_d_PreviewTipResponse = PreviewTipResponse;\n type tipsV1Tip_universal_d_GetTipByOrderIdRequest = GetTipByOrderIdRequest;\n type tipsV1Tip_universal_d_GetTipByOrderIdResponse = GetTipByOrderIdResponse;\n type tipsV1Tip_universal_d_GetTipByDraftOrderIdRequest = GetTipByDraftOrderIdRequest;\n type tipsV1Tip_universal_d_GetTipByDraftOrderIdResponse = GetTipByDraftOrderIdResponse;\n type tipsV1Tip_universal_d_GetTipChoiceRequest = GetTipChoiceRequest;\n type tipsV1Tip_universal_d_GetTipChoiceResponse = GetTipChoiceResponse;\n type tipsV1Tip_universal_d_UpdateTipChoiceRequest = UpdateTipChoiceRequest;\n type tipsV1Tip_universal_d_UpdateTipChoiceResponse = UpdateTipChoiceResponse;\n type tipsV1Tip_universal_d_SetTipOnOrderRequest = SetTipOnOrderRequest;\n type tipsV1Tip_universal_d_SetTipOnOrderRequestIdentifierOneOf = SetTipOnOrderRequestIdentifierOneOf;\n type tipsV1Tip_universal_d_SetTipOnOrderResponse = SetTipOnOrderResponse;\n type tipsV1Tip_universal_d_OrderInfo = OrderInfo;\n type tipsV1Tip_universal_d_OrderInfoIdentifierOneOf = OrderInfoIdentifierOneOf;\n type tipsV1Tip_universal_d_Price = Price;\n type tipsV1Tip_universal_d_RemoveTipFromOrderRequest = RemoveTipFromOrderRequest;\n type tipsV1Tip_universal_d_RemoveTipFromOrderRequestIdentifierOneOf = RemoveTipFromOrderRequestIdentifierOneOf;\n type tipsV1Tip_universal_d_RemoveTipFromOrderResponse = RemoveTipFromOrderResponse;\n type tipsV1Tip_universal_d_CreateTipDistributionsRequest = CreateTipDistributionsRequest;\n type tipsV1Tip_universal_d_CreateTipDistributionsResponse = CreateTipDistributionsResponse;\n type tipsV1Tip_universal_d_DeleteTipDistributionsRequest = DeleteTipDistributionsRequest;\n type tipsV1Tip_universal_d_DeleteTipDistributionsRequestDeleteByOneOf = DeleteTipDistributionsRequestDeleteByOneOf;\n type tipsV1Tip_universal_d_DeleteTipDistributionsResponse = DeleteTipDistributionsResponse;\n type tipsV1Tip_universal_d_AddTipDistributionsToOrderRequest = AddTipDistributionsToOrderRequest;\n type tipsV1Tip_universal_d_AddTipDistributionsToOrderRequestIdentifierOneOf = AddTipDistributionsToOrderRequestIdentifierOneOf;\n type tipsV1Tip_universal_d_AddTipDistributionsToOrderResponse = AddTipDistributionsToOrderResponse;\n type tipsV1Tip_universal_d_QueryTipDistributionsRequest = QueryTipDistributionsRequest;\n type tipsV1Tip_universal_d_CursorQuery = CursorQuery;\n type tipsV1Tip_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type tipsV1Tip_universal_d_Sorting = Sorting;\n type tipsV1Tip_universal_d_SortOrder = SortOrder;\n const tipsV1Tip_universal_d_SortOrder: typeof SortOrder;\n type tipsV1Tip_universal_d_CursorPaging = CursorPaging;\n type tipsV1Tip_universal_d_QueryTipDistributionsResponse = QueryTipDistributionsResponse;\n type tipsV1Tip_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type tipsV1Tip_universal_d_Cursors = Cursors;\n type tipsV1Tip_universal_d_SumTipDistributionAmountsRequest = SumTipDistributionAmountsRequest;\n type tipsV1Tip_universal_d_SumTipDistributionAmountsResponse = SumTipDistributionAmountsResponse;\n type tipsV1Tip_universal_d_ApplyTipDistributionsRequest = ApplyTipDistributionsRequest;\n type tipsV1Tip_universal_d_QueryBy = QueryBy;\n const tipsV1Tip_universal_d_QueryBy: typeof QueryBy;\n type tipsV1Tip_universal_d_ApplyTipDistributionsResponse = ApplyTipDistributionsResponse;\n type tipsV1Tip_universal_d_PublishTipDistributionsCreatedEventRequest = PublishTipDistributionsCreatedEventRequest;\n type tipsV1Tip_universal_d_PublishTipDistributionsCreatedEventResponse = PublishTipDistributionsCreatedEventResponse;\n type tipsV1Tip_universal_d_TipDistributionsCreated = TipDistributionsCreated;\n type tipsV1Tip_universal_d_DomainEvent = DomainEvent;\n type tipsV1Tip_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type tipsV1Tip_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type tipsV1Tip_universal_d_RestoreInfo = RestoreInfo;\n type tipsV1Tip_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type tipsV1Tip_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type tipsV1Tip_universal_d_ActionEvent = ActionEvent;\n type tipsV1Tip_universal_d_MessageEnvelope = MessageEnvelope;\n type tipsV1Tip_universal_d_IdentificationData = IdentificationData;\n type tipsV1Tip_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type tipsV1Tip_universal_d_WebhookIdentityType = WebhookIdentityType;\n const tipsV1Tip_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const tipsV1Tip_universal_d_previewTip: typeof previewTip;\n type tipsV1Tip_universal_d_PreviewTipOptions = PreviewTipOptions;\n const tipsV1Tip_universal_d_getTipByOrderId: typeof getTipByOrderId;\n const tipsV1Tip_universal_d_getTipByDraftOrderId: typeof getTipByDraftOrderId;\n const tipsV1Tip_universal_d_getTipChoice: typeof getTipChoice;\n const tipsV1Tip_universal_d_updateTipChoice: typeof updateTipChoice;\n type tipsV1Tip_universal_d_UpdateTipChoiceOptions = UpdateTipChoiceOptions;\n const tipsV1Tip_universal_d_setTipOnOrder: typeof setTipOnOrder;\n type tipsV1Tip_universal_d_SetTipOnOrderOptions = SetTipOnOrderOptions;\n const tipsV1Tip_universal_d_removeTipFromOrder: typeof removeTipFromOrder;\n type tipsV1Tip_universal_d_RemoveTipFromOrderOptions = RemoveTipFromOrderOptions;\n const tipsV1Tip_universal_d_createTipDistributions: typeof createTipDistributions;\n type tipsV1Tip_universal_d_CreateTipDistributionsOptions = CreateTipDistributionsOptions;\n const tipsV1Tip_universal_d_deleteTipDistributions: typeof deleteTipDistributions;\n type tipsV1Tip_universal_d_DeleteTipDistributionsOptions = DeleteTipDistributionsOptions;\n const tipsV1Tip_universal_d_addTipDistributionsToOrder: typeof addTipDistributionsToOrder;\n type tipsV1Tip_universal_d_AddTipDistributionsToOrderOptions = AddTipDistributionsToOrderOptions;\n const tipsV1Tip_universal_d_queryTipDistributions: typeof queryTipDistributions;\n type tipsV1Tip_universal_d_TipDistributionsQueryResult = TipDistributionsQueryResult;\n type tipsV1Tip_universal_d_TipDistributionsQueryBuilder = TipDistributionsQueryBuilder;\n const tipsV1Tip_universal_d_sumTipDistributionAmounts: typeof sumTipDistributionAmounts;\n const tipsV1Tip_universal_d_applyTipDistributions: typeof applyTipDistributions;\n type tipsV1Tip_universal_d_ApplyTipDistributionsOptions = ApplyTipDistributionsOptions;\n const tipsV1Tip_universal_d_publishTipDistributionsCreatedEvent: typeof publishTipDistributionsCreatedEvent;\n type tipsV1Tip_universal_d_PublishTipDistributionsCreatedEventOptions = PublishTipDistributionsCreatedEventOptions;\n namespace tipsV1Tip_universal_d {\n export {\n tipsV1Tip_universal_d_Tip as Tip,\n tipsV1Tip_universal_d_TipDistribution as TipDistribution,\n tipsV1Tip_universal_d_CommonIdentificationData as CommonIdentificationData,\n tipsV1Tip_universal_d_CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOf,\n tipsV1Tip_universal_d_IdentityType as IdentityType,\n tipsV1Tip_universal_d_Staff as Staff,\n tipsV1Tip_universal_d_LineItemInfo as LineItemInfo,\n tipsV1Tip_universal_d_CatalogReference as CatalogReference,\n tipsV1Tip_universal_d_Transaction as Transaction,\n tipsV1Tip_universal_d_Source as Source,\n tipsV1Tip_universal_d_PreviewTipRequest as PreviewTipRequest,\n tipsV1Tip_universal_d_TipChoice as TipChoice,\n tipsV1Tip_universal_d_TipType as TipType,\n tipsV1Tip_universal_d_PreviewTipResponse as PreviewTipResponse,\n tipsV1Tip_universal_d_GetTipByOrderIdRequest as GetTipByOrderIdRequest,\n tipsV1Tip_universal_d_GetTipByOrderIdResponse as GetTipByOrderIdResponse,\n tipsV1Tip_universal_d_GetTipByDraftOrderIdRequest as GetTipByDraftOrderIdRequest,\n tipsV1Tip_universal_d_GetTipByDraftOrderIdResponse as GetTipByDraftOrderIdResponse,\n tipsV1Tip_universal_d_GetTipChoiceRequest as GetTipChoiceRequest,\n tipsV1Tip_universal_d_GetTipChoiceResponse as GetTipChoiceResponse,\n tipsV1Tip_universal_d_UpdateTipChoiceRequest as UpdateTipChoiceRequest,\n tipsV1Tip_universal_d_UpdateTipChoiceResponse as UpdateTipChoiceResponse,\n tipsV1Tip_universal_d_SetTipOnOrderRequest as SetTipOnOrderRequest,\n tipsV1Tip_universal_d_SetTipOnOrderRequestIdentifierOneOf as SetTipOnOrderRequestIdentifierOneOf,\n tipsV1Tip_universal_d_SetTipOnOrderResponse as SetTipOnOrderResponse,\n tipsV1Tip_universal_d_OrderInfo as OrderInfo,\n tipsV1Tip_universal_d_OrderInfoIdentifierOneOf as OrderInfoIdentifierOneOf,\n tipsV1Tip_universal_d_Price as Price,\n tipsV1Tip_universal_d_RemoveTipFromOrderRequest as RemoveTipFromOrderRequest,\n tipsV1Tip_universal_d_RemoveTipFromOrderRequestIdentifierOneOf as RemoveTipFromOrderRequestIdentifierOneOf,\n tipsV1Tip_universal_d_RemoveTipFromOrderResponse as RemoveTipFromOrderResponse,\n tipsV1Tip_universal_d_CreateTipDistributionsRequest as CreateTipDistributionsRequest,\n tipsV1Tip_universal_d_CreateTipDistributionsResponse as CreateTipDistributionsResponse,\n tipsV1Tip_universal_d_DeleteTipDistributionsRequest as DeleteTipDistributionsRequest,\n tipsV1Tip_universal_d_DeleteTipDistributionsRequestDeleteByOneOf as DeleteTipDistributionsRequestDeleteByOneOf,\n tipsV1Tip_universal_d_DeleteTipDistributionsResponse as DeleteTipDistributionsResponse,\n tipsV1Tip_universal_d_AddTipDistributionsToOrderRequest as AddTipDistributionsToOrderRequest,\n tipsV1Tip_universal_d_AddTipDistributionsToOrderRequestIdentifierOneOf as AddTipDistributionsToOrderRequestIdentifierOneOf,\n tipsV1Tip_universal_d_AddTipDistributionsToOrderResponse as AddTipDistributionsToOrderResponse,\n tipsV1Tip_universal_d_QueryTipDistributionsRequest as QueryTipDistributionsRequest,\n tipsV1Tip_universal_d_CursorQuery as CursorQuery,\n tipsV1Tip_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n tipsV1Tip_universal_d_Sorting as Sorting,\n tipsV1Tip_universal_d_SortOrder as SortOrder,\n tipsV1Tip_universal_d_CursorPaging as CursorPaging,\n tipsV1Tip_universal_d_QueryTipDistributionsResponse as QueryTipDistributionsResponse,\n tipsV1Tip_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n tipsV1Tip_universal_d_Cursors as Cursors,\n tipsV1Tip_universal_d_SumTipDistributionAmountsRequest as SumTipDistributionAmountsRequest,\n tipsV1Tip_universal_d_SumTipDistributionAmountsResponse as SumTipDistributionAmountsResponse,\n tipsV1Tip_universal_d_ApplyTipDistributionsRequest as ApplyTipDistributionsRequest,\n tipsV1Tip_universal_d_QueryBy as QueryBy,\n tipsV1Tip_universal_d_ApplyTipDistributionsResponse as ApplyTipDistributionsResponse,\n tipsV1Tip_universal_d_PublishTipDistributionsCreatedEventRequest as PublishTipDistributionsCreatedEventRequest,\n tipsV1Tip_universal_d_PublishTipDistributionsCreatedEventResponse as PublishTipDistributionsCreatedEventResponse,\n tipsV1Tip_universal_d_TipDistributionsCreated as TipDistributionsCreated,\n tipsV1Tip_universal_d_DomainEvent as DomainEvent,\n tipsV1Tip_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n tipsV1Tip_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n tipsV1Tip_universal_d_RestoreInfo as RestoreInfo,\n tipsV1Tip_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n tipsV1Tip_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n tipsV1Tip_universal_d_ActionEvent as ActionEvent,\n tipsV1Tip_universal_d_MessageEnvelope as MessageEnvelope,\n tipsV1Tip_universal_d_IdentificationData as IdentificationData,\n tipsV1Tip_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n tipsV1Tip_universal_d_WebhookIdentityType as WebhookIdentityType,\n tipsV1Tip_universal_d_previewTip as previewTip,\n tipsV1Tip_universal_d_PreviewTipOptions as PreviewTipOptions,\n tipsV1Tip_universal_d_getTipByOrderId as getTipByOrderId,\n tipsV1Tip_universal_d_getTipByDraftOrderId as getTipByDraftOrderId,\n tipsV1Tip_universal_d_getTipChoice as getTipChoice,\n tipsV1Tip_universal_d_updateTipChoice as updateTipChoice,\n tipsV1Tip_universal_d_UpdateTipChoiceOptions as UpdateTipChoiceOptions,\n tipsV1Tip_universal_d_setTipOnOrder as setTipOnOrder,\n tipsV1Tip_universal_d_SetTipOnOrderOptions as SetTipOnOrderOptions,\n tipsV1Tip_universal_d_removeTipFromOrder as removeTipFromOrder,\n tipsV1Tip_universal_d_RemoveTipFromOrderOptions as RemoveTipFromOrderOptions,\n tipsV1Tip_universal_d_createTipDistributions as createTipDistributions,\n tipsV1Tip_universal_d_CreateTipDistributionsOptions as CreateTipDistributionsOptions,\n tipsV1Tip_universal_d_deleteTipDistributions as deleteTipDistributions,\n tipsV1Tip_universal_d_DeleteTipDistributionsOptions as DeleteTipDistributionsOptions,\n tipsV1Tip_universal_d_addTipDistributionsToOrder as addTipDistributionsToOrder,\n tipsV1Tip_universal_d_AddTipDistributionsToOrderOptions as AddTipDistributionsToOrderOptions,\n tipsV1Tip_universal_d_queryTipDistributions as queryTipDistributions,\n tipsV1Tip_universal_d_TipDistributionsQueryResult as TipDistributionsQueryResult,\n tipsV1Tip_universal_d_TipDistributionsQueryBuilder as TipDistributionsQueryBuilder,\n tipsV1Tip_universal_d_sumTipDistributionAmounts as sumTipDistributionAmounts,\n tipsV1Tip_universal_d_applyTipDistributions as applyTipDistributions,\n tipsV1Tip_universal_d_ApplyTipDistributionsOptions as ApplyTipDistributionsOptions,\n tipsV1Tip_universal_d_publishTipDistributionsCreatedEvent as publishTipDistributionsCreatedEvent,\n tipsV1Tip_universal_d_PublishTipDistributionsCreatedEventOptions as PublishTipDistributionsCreatedEventOptions,\n };\n }\n \n export { ecomV1AbandonedCheckout_universal_d as abandonedCheckouts, ecomV1BackInStockNotificationRequest_universal_d as backInStockNotifications, ecomV1BackInStockSettings_universal_d as backInStockSettings, ecomV1CartCart_universal_d as cart, ecomV1CheckoutCheckout_universal_d as checkout, ecomApiV1CheckoutContentProvider_universal_d as checkoutContent, ecomV1CheckoutSettings_universal_d as checkoutSettings, ecomV1CheckoutTemplate_universal_d as checkoutTemplates, ecomV1CartCurrentCart_universal_d as currentCart, ecomV1DeliveryProfile_universal_d as deliveryProfile, gatewaysEcomV1DeliveryRatesGateway_universal_d as deliverySolutions, ecomDiscountsV1DiscountRule_universal_d as discountRules, ecomCustomTriggerV1CustomTrigger_universal_d as discountsCustomTrigger, ecomV1DraftOrder_universal_d as draftOrders, ecommerceGiftCardsProxyV1GiftCard_universal_d as giftCards, ecomV1GiftCard_universal_d as giftVouchers, ecomV1LocalDeliveryOption_universal_d as localDeliveryOptions, ecomV1Fulfillments_universal_d as orderFulfillments, ecomOrdersV1Invoice_universal_d as orderInvoices, ecomV1OrderPaymentRequest_universal_d as orderPaymentRequests, ecomV1OrderTransactions_universal_d as orderTransactions, ecomV1Order_universal_d as orders, ecomV1OrdersSettings_universal_d as ordersSettings, ecomV1PickupLocation_universal_d as pickupLocations, ecomRecommendationsV1Recommendation_universal_d as recommendations, ecomV1ShippingOption_universal_d as shippingOptions, ecomV1ShippoConfiguration_universal_d as shippoConfigurations, ecomSubscriptionContractsV1SubscriptionContract_universal_d as subscriptionContracts, tipsSettingsV1TipSettings_universal_d as tipSettings, tipsStaffV1Staff_universal_d as tippableStaff, tipsV1Tip_universal_d as tips, ecomV1TotalsCalculation_universal_d as totalsCalculator };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-atlas-location-backend.d.ts", "content": "declare module \"wix-atlas-location-backend\" {\n interface SearchResult {\n address?: Address;\n /** stores additional data about the proximity to the specified location */\n proximity?: Proximity;\n }\n /** Physical address */\n interface Address {\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 formattedAddress?: string | null;\n /** Free text for human-to-human textual orientation aid purposes */\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 /** 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 /** apartment number */\n apt?: string;\n }\n interface AddressLocation {\n latitude?: number | null;\n longitude?: number | null;\n }\n interface Subdivision {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n type?: SubdivisionType;\n /** a free-text description of subdivision type */\n typeInfo?: string | null;\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 /** cities/towns */\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 enum Proximity {\n UNKNOWN_PROXIMITY = \"UNKNOWN_PROXIMITY\",\n /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */\n PINPOINT = \"PINPOINT\",\n /** indicates that the returned result is the geometric center of a result */\n APPROXIMATE = \"APPROXIMATE\",\n /** indicates that the returned result is around an area */\n GENERAL_AREA = \"GENERAL_AREA\"\n }\n interface FilterBy {\n /** One of the filter types enum */\n filterType?: FilterType;\n /** Free text like \"us\" */\n filterValue?: string;\n }\n enum FilterType {\n /** Filter by zip code */\n zip_code = \"zip_code\",\n /** Filter by 2-letters or 3-letters country code */\n country_code = \"country_code\"\n }\n interface SearchResponse {\n /** List of 'Address' objects */\n searchResults?: SearchResult[];\n }\n interface ReverseGeocodingResponse {\n searchResults?: SearchResult[];\n }\n interface SearchOptions {\n query?: string | null;\n filterBy?: FilterBy[];\n zipCode?: string | null;\n countryCodes?: string[];\n }\n \n function search(options: SearchOptions): Promise;\n function reverseGeocoding(addressLocation: AddressLocation): Promise;\n \n export { reverseGeocoding, search };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 | null;\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 | null;\n /**\n * Date and time the item was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Item tags. */\n tags?: Tags;\n /**\n * item's secondary media (image or text media revealed on hover)\n * @internal\n */\n secondaryMedia?: SecondaryMedia;\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 /**\n * Link type.\n * @internal\n */\n type?: LinkType;\n /** Display text of the link. */\n text?: string | null;\n /** Target URL of the link. */\n url?: string | null;\n /**\n * Whether the link opens in a new tab or window. One of:\n * * `'_blank'`: The link opens in a new tab or window.\n * * `'_self'`: The link opens in the same tab or window.\n * @internal\n */\n target?: string | null;\n /**\n * Information about the link. Reserved for internal use.\n * @internal\n */\n wixLinkData?: WixLink;\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 /**\n * @internal\n * @deprecated\n */\n type?: ImageType;\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 * Whether the image is saved in secure media.\n * @internal\n */\n secure?: boolean | null;\n /**\n * When image is saved in secure media, token is generated.\n * @internal\n * @readonly\n */\n token?: string | null;\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 /**\n * Video duration in milliseconds - deprecated.\n * @internal\n * @deprecated\n */\n duration?: string | null;\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 /**\n * Video poster. Deprecated - please use the `posters` property in the parent entity.\n * @internal\n * @deprecated\n */\n poster?: string;\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?: InvalidateCachePage;\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?: InvalidateCachePage;\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 InvalidateCachePage {\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 | null;\n /** @readonly */\n oldRevision?: Date | null;\n }\n interface CleanDeletedGalleriesEvent {\n /** @readonly */\n instanceId?: string;\n /** @readonly */\n metaSiteId?: string;\n /** @readonly */\n htmlSiteRevision?: string;\n /** @readonly */\n timeSitePublished?: Date | null;\n }\n interface ProgallerypublisherPublishGalleryRequest {\n /** id of the gallery that will be published */\n galleryId?: string;\n }\n interface ProgallerypublisherPublishGalleryResponse {\n }\n interface GetActiveGalleryRevisionRequest {\n galleryId?: string;\n }\n interface GetActiveGalleryRevisionResponse {\n galleryActiveRevision?: Date | null;\n htmlSiteRevision?: string | null;\n }\n interface GetGalleryRevisionRequest {\n galleryId?: string;\n revision?: Date | null;\n }\n interface GetGalleryRevisionResponse {\n htmlSiteRevision?: string | null;\n instanceId?: string | null;\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?: Page[];\n /** Site's publish date */\n publishDate?: string;\n }\n interface Page {\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 /** Site's publish date */\n publishDate?: string;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 * The set of field mask paths of gallery.\n * @internal\n */\n fields?: string[];\n /**\n * State of the galleries.\n * @internal\n */\n state?: State;\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 /** @internal */\n htmlSiteRevision?: string | null;\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 * State of the retrieved galleries.\n * @internal\n */\n state?: State;\n /**\n * This allows us to fallback to legacy galleries until they are fully migrated. If this is not provided and a fallback is necessary, the process will fail\n * External reference. **Note:** This property is not validated by Wix.\n * @internal\n * @deprecated\n */\n externalId?: string | null;\n }\n /** @oneof */\n interface GetGalleryRequestVersionOneOf {\n /** @internal */\n htmlSiteRevision?: string | null;\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 * State of the retrieved gallery.\n * @internal\n */\n state?: State;\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 * State of the gallery.\n * @internal\n */\n state?: State;\n }\n interface GetGalleryItemResponse {\n /** Returned media item. */\n item?: Item;\n }\n interface CreateGalleryRequest {\n /** Gallery to create. */\n gallery?: Gallery;\n /**\n * State of the gallery to create.\n * @internal\n */\n state?: State;\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 * State of the gallery to update.\n * @internal\n */\n state?: State;\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 * State of the gallery to delete.\n * @internal\n */\n state?: State;\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 * State of the gallery.\n * @internal\n */\n state?: State;\n }\n interface DeleteGalleryItemsResponse {\n /** Gallery that previously included the deleted media item. */\n gallery?: Gallery;\n }\n interface BulkDeleteGalleryItemsRequest {\n /** Gallery ID. */\n galleryId: string;\n /** IDs of the media items to delete. */\n itemIds: string[];\n /**\n * State of the gallery.\n * @internal\n */\n state?: State;\n }\n interface BulkDeleteGalleryItemsResponse {\n /**\n * IDs of the deleted media items.\n * @readonly\n */\n itemIds?: string[];\n }\n interface CreateGalleryItemRequest {\n /** Gallery ID. */\n galleryId: string;\n /** Media item to create. */\n item: Item;\n /**\n * Gallery state.\n * @internal\n */\n state?: State;\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 * Gallery state.\n * @internal\n */\n state?: State;\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 * Gallery state.\n * @internal\n */\n state?: State;\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 * Gallery state.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.READ\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 * Fields to include in the response object. Setting the `fields` option filters the response object so that it only contains the specified fields.\n * @internal\n */\n fields?: string[];\n /**\n * State of the galleries.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.READ\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 * State of the retrieved galleries.\n * @internal\n */\n state?: State;\n /**\n * This allows us to fallback to legacy galleries until they are fully migrated. If this is not provided and a fallback is necessary, the process will fail\n * External reference. **Note:** This property is not validated by Wix.\n * @internal\n * @deprecated\n */\n externalId?: string | null;\n /** @internal */\n htmlSiteRevision?: string | 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 * @permissionId PRO_GALLERY.READ\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 * State of the retrieved gallery.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.READ\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 * State of the gallery.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.MANAGE\n * @adminMethod\n * @returns Created gallery.\n */\n function createGallery(options?: CreateGalleryOptions): Promise;\n interface CreateGalleryOptions {\n /** Gallery to create. */\n gallery?: Gallery;\n /**\n * State of the gallery to create.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.MANAGE\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 | null;\n }\n interface UpdateGalleryOptions {\n /**\n * State of the gallery to update.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.MANAGE\n * @adminMethod\n */\n function deleteGallery(galleryId: string, options?: DeleteGalleryOptions): Promise;\n interface DeleteGalleryOptions {\n /**\n * State of the gallery to delete.\n * @internal\n */\n state?: State;\n }\n /**\n * Deletes multiple media items from a gallery.\n * @param galleryId - Gallery ID.\n * @public\n * @documentationMaturity preview\n * @requiredField galleryId\n * @permissionId PRO_GALLERY.MANAGE\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.exposure.progallery.BulkDeleteGalleryItems\n * @targetRemovalDate 2024-08-15\n */\n function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise;\n interface DeleteGalleryItemsOptions {\n /** ID of the media item to delete. */\n itemsIds?: string[];\n /**\n * State of the gallery.\n * @internal\n */\n state?: State;\n }\n /**\n * Deletes multiple media items from a gallery.\n * @param galleryId - Gallery ID.\n * @param itemIds - IDs of the media items to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField galleryId\n * @requiredField itemIds\n * @permissionId PRO_GALLERY.MANAGE\n * @adminMethod\n */\n function bulkDeleteGalleryItems(galleryId: string, itemIds: string[], options?: BulkDeleteGalleryItemsOptions): Promise;\n interface BulkDeleteGalleryItemsOptions {\n /**\n * State of the gallery.\n * @internal\n */\n state?: State;\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 * @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 * @permissionId PRO_GALLERY.MANAGE\n * @adminMethod\n * @returns Created media item.\n */\n function createGalleryItem(galleryId: string, item: Item, options?: CreateGalleryItemOptions): Promise;\n interface CreateGalleryItemOptions {\n /**\n * Gallery state.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.MANAGE\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 | null;\n /**\n * Date and time the item was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Item tags. */\n tags?: Tags;\n /**\n * item's secondary media (image or text media revealed on hover)\n * @internal\n */\n secondaryMedia?: SecondaryMedia;\n }\n interface UpdateGalleryItemOptions {\n /**\n * Gallery state.\n * @internal\n */\n state?: State;\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 * @permissionId PRO_GALLERY.MANAGE\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 * Gallery state.\n * @internal\n */\n state?: State;\n }\n /**\n * Publish gallery\n * The changes that been done in SAVED state will be applied in the PUBLISHED gallery\n * @param galleryId - ID of the gallery to publish.\n * @internal\n * @documentationMaturity preview\n * @requiredField galleryId\n * @permissionId PRO_GALLERY.MANAGE\n * @adminMethod\n */\n function publishGallery(galleryId: string): Promise;\n \n type proGalleryV2Gallery_universal_d_Gallery = Gallery;\n type proGalleryV2Gallery_universal_d_Item = Item;\n type proGalleryV2Gallery_universal_d_ItemMetadataOneOf = ItemMetadataOneOf;\n type proGalleryV2Gallery_universal_d_Link = Link;\n type proGalleryV2Gallery_universal_d_LinkType = LinkType;\n const proGalleryV2Gallery_universal_d_LinkType: typeof LinkType;\n type proGalleryV2Gallery_universal_d_WixLink = WixLink;\n type proGalleryV2Gallery_universal_d_WixLinkLinkOneOf = WixLinkLinkOneOf;\n type proGalleryV2Gallery_universal_d_ExternalLink = ExternalLink;\n type proGalleryV2Gallery_universal_d_PageLink = PageLink;\n type proGalleryV2Gallery_universal_d_LinkRel = LinkRel;\n const proGalleryV2Gallery_universal_d_LinkRel: typeof LinkRel;\n type proGalleryV2Gallery_universal_d_AnchorLink = AnchorLink;\n type proGalleryV2Gallery_universal_d_DynamicPageLink = DynamicPageLink;\n type proGalleryV2Gallery_universal_d_DocumentLink = DocumentLink;\n type proGalleryV2Gallery_universal_d_EmailLink = EmailLink;\n type proGalleryV2Gallery_universal_d_PhoneLink = PhoneLink;\n type proGalleryV2Gallery_universal_d_AddressLink = AddressLink;\n type proGalleryV2Gallery_universal_d_WhatsAppLink = WhatsAppLink;\n type proGalleryV2Gallery_universal_d_TpaPageLink = TpaPageLink;\n type proGalleryV2Gallery_universal_d_Type = Type;\n const proGalleryV2Gallery_universal_d_Type: typeof Type;\n type proGalleryV2Gallery_universal_d_Image = Image;\n type proGalleryV2Gallery_universal_d_ImageType = ImageType;\n const proGalleryV2Gallery_universal_d_ImageType: typeof ImageType;\n type proGalleryV2Gallery_universal_d_Point = Point;\n type proGalleryV2Gallery_universal_d_UnsharpMasking = UnsharpMasking;\n type proGalleryV2Gallery_universal_d_Video = Video;\n type proGalleryV2Gallery_universal_d_VideoType = VideoType;\n const proGalleryV2Gallery_universal_d_VideoType: typeof VideoType;\n type proGalleryV2Gallery_universal_d_VideoResolution = VideoResolution;\n type proGalleryV2Gallery_universal_d_Text = Text;\n type proGalleryV2Gallery_universal_d_Tags = Tags;\n type proGalleryV2Gallery_universal_d_SecondaryMedia = SecondaryMedia;\n type proGalleryV2Gallery_universal_d_SecondaryMediaMetadataOneOf = SecondaryMediaMetadataOneOf;\n type proGalleryV2Gallery_universal_d_InvalidateCache = InvalidateCache;\n type proGalleryV2Gallery_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type proGalleryV2Gallery_universal_d_App = App;\n type proGalleryV2Gallery_universal_d_InvalidateCachePage = InvalidateCachePage;\n type proGalleryV2Gallery_universal_d_URI = URI;\n type proGalleryV2Gallery_universal_d_File = File;\n type proGalleryV2Gallery_universal_d_GalleryPublished = GalleryPublished;\n type proGalleryV2Gallery_universal_d_CleanDeletedGalleriesEvent = CleanDeletedGalleriesEvent;\n type proGalleryV2Gallery_universal_d_ProgallerypublisherPublishGalleryRequest = ProgallerypublisherPublishGalleryRequest;\n type proGalleryV2Gallery_universal_d_ProgallerypublisherPublishGalleryResponse = ProgallerypublisherPublishGalleryResponse;\n type proGalleryV2Gallery_universal_d_GetActiveGalleryRevisionRequest = GetActiveGalleryRevisionRequest;\n type proGalleryV2Gallery_universal_d_GetActiveGalleryRevisionResponse = GetActiveGalleryRevisionResponse;\n type proGalleryV2Gallery_universal_d_GetGalleryRevisionRequest = GetGalleryRevisionRequest;\n type proGalleryV2Gallery_universal_d_GetGalleryRevisionResponse = GetGalleryRevisionResponse;\n type proGalleryV2Gallery_universal_d_PublishGalleryItemRequest = PublishGalleryItemRequest;\n type proGalleryV2Gallery_universal_d_PublishGalleryItemResponse = PublishGalleryItemResponse;\n type proGalleryV2Gallery_universal_d_PublishGalleryItemsRequest = PublishGalleryItemsRequest;\n type proGalleryV2Gallery_universal_d_PublishGalleryItemsResponse = PublishGalleryItemsResponse;\n type proGalleryV2Gallery_universal_d_Empty = Empty;\n type proGalleryV2Gallery_universal_d_HtmlSitePublished = HtmlSitePublished;\n type proGalleryV2Gallery_universal_d_Page = Page;\n type proGalleryV2Gallery_universal_d_HtmlSiteRCPublished = HtmlSiteRCPublished;\n type proGalleryV2Gallery_universal_d_DomainEvent = DomainEvent;\n type proGalleryV2Gallery_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type proGalleryV2Gallery_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type proGalleryV2Gallery_universal_d_RestoreInfo = RestoreInfo;\n type proGalleryV2Gallery_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type proGalleryV2Gallery_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type proGalleryV2Gallery_universal_d_ActionEvent = ActionEvent;\n type proGalleryV2Gallery_universal_d_MessageEnvelope = MessageEnvelope;\n type proGalleryV2Gallery_universal_d_IdentificationData = IdentificationData;\n type proGalleryV2Gallery_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type proGalleryV2Gallery_universal_d_WebhookIdentityType = WebhookIdentityType;\n const proGalleryV2Gallery_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type proGalleryV2Gallery_universal_d_UpdateDocumentsEvent = UpdateDocumentsEvent;\n type proGalleryV2Gallery_universal_d_UpdateDocumentsEventOperationOneOf = UpdateDocumentsEventOperationOneOf;\n type proGalleryV2Gallery_universal_d_DocumentUpdateOperation = DocumentUpdateOperation;\n type proGalleryV2Gallery_universal_d_IndexDocument = IndexDocument;\n type proGalleryV2Gallery_universal_d_DocumentPayload = DocumentPayload;\n type proGalleryV2Gallery_universal_d_DocumentImage = DocumentImage;\n type proGalleryV2Gallery_universal_d_Enum = Enum;\n const proGalleryV2Gallery_universal_d_Enum: typeof Enum;\n type proGalleryV2Gallery_universal_d_DeleteByIdsOperation = DeleteByIdsOperation;\n type proGalleryV2Gallery_universal_d_DeleteByFilterOperation = DeleteByFilterOperation;\n type proGalleryV2Gallery_universal_d_UpdateByFilterOperation = UpdateByFilterOperation;\n type proGalleryV2Gallery_universal_d_UpdateExistingOperation = UpdateExistingOperation;\n type proGalleryV2Gallery_universal_d_SearchIndexingNotification = SearchIndexingNotification;\n type proGalleryV2Gallery_universal_d_SearchIndexingNotificationState = SearchIndexingNotificationState;\n const proGalleryV2Gallery_universal_d_SearchIndexingNotificationState: typeof SearchIndexingNotificationState;\n type proGalleryV2Gallery_universal_d_ListGalleriesItemsRequest = ListGalleriesItemsRequest;\n type proGalleryV2Gallery_universal_d_ItemId = ItemId;\n type proGalleryV2Gallery_universal_d_ListGalleriesItemsResponse = ListGalleriesItemsResponse;\n type proGalleryV2Gallery_universal_d_ItemsInGallery = ItemsInGallery;\n type proGalleryV2Gallery_universal_d_GalleryItemCreated = GalleryItemCreated;\n type proGalleryV2Gallery_universal_d_GalleryItemUpdated = GalleryItemUpdated;\n type proGalleryV2Gallery_universal_d_GalleryItemDeleted = GalleryItemDeleted;\n type proGalleryV2Gallery_universal_d_ListGalleriesRequest = ListGalleriesRequest;\n type proGalleryV2Gallery_universal_d_State = State;\n const proGalleryV2Gallery_universal_d_State: typeof State;\n type proGalleryV2Gallery_universal_d_ListGalleriesResponse = ListGalleriesResponse;\n type proGalleryV2Gallery_universal_d_GetGalleryRequest = GetGalleryRequest;\n type proGalleryV2Gallery_universal_d_GetGalleryRequestVersionOneOf = GetGalleryRequestVersionOneOf;\n type proGalleryV2Gallery_universal_d_GetGalleryResponse = GetGalleryResponse;\n type proGalleryV2Gallery_universal_d_ListGalleryItemsRequest = ListGalleryItemsRequest;\n type proGalleryV2Gallery_universal_d_ListGalleryItemsResponse = ListGalleryItemsResponse;\n type proGalleryV2Gallery_universal_d_GetGalleryItemRequest = GetGalleryItemRequest;\n type proGalleryV2Gallery_universal_d_GetGalleryItemResponse = GetGalleryItemResponse;\n type proGalleryV2Gallery_universal_d_CreateGalleryRequest = CreateGalleryRequest;\n type proGalleryV2Gallery_universal_d_CreateGalleryResponse = CreateGalleryResponse;\n type proGalleryV2Gallery_universal_d_UpdateGalleryRequest = UpdateGalleryRequest;\n type proGalleryV2Gallery_universal_d_UpdateGalleryResponse = UpdateGalleryResponse;\n type proGalleryV2Gallery_universal_d_DeleteGalleryRequest = DeleteGalleryRequest;\n type proGalleryV2Gallery_universal_d_DeleteGalleryResponse = DeleteGalleryResponse;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemsRequest = DeleteGalleryItemsRequest;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemsResponse = DeleteGalleryItemsResponse;\n type proGalleryV2Gallery_universal_d_BulkDeleteGalleryItemsRequest = BulkDeleteGalleryItemsRequest;\n type proGalleryV2Gallery_universal_d_BulkDeleteGalleryItemsResponse = BulkDeleteGalleryItemsResponse;\n type proGalleryV2Gallery_universal_d_CreateGalleryItemRequest = CreateGalleryItemRequest;\n type proGalleryV2Gallery_universal_d_CreateGalleryItemResponse = CreateGalleryItemResponse;\n type proGalleryV2Gallery_universal_d_CreateGalleryItemsRequest = CreateGalleryItemsRequest;\n type proGalleryV2Gallery_universal_d_CreateGalleryItemsResponse = CreateGalleryItemsResponse;\n type proGalleryV2Gallery_universal_d_UpdateGalleryItemRequest = UpdateGalleryItemRequest;\n type proGalleryV2Gallery_universal_d_UpdateGalleryItemResponse = UpdateGalleryItemResponse;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemRequest = DeleteGalleryItemRequest;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemResponse = DeleteGalleryItemResponse;\n type proGalleryV2Gallery_universal_d_PublishGalleryRequest = PublishGalleryRequest;\n type proGalleryV2Gallery_universal_d_PublishGalleryResponse = PublishGalleryResponse;\n const proGalleryV2Gallery_universal_d_listGalleries: typeof listGalleries;\n type proGalleryV2Gallery_universal_d_ListGalleriesOptions = ListGalleriesOptions;\n const proGalleryV2Gallery_universal_d_getGallery: typeof getGallery;\n type proGalleryV2Gallery_universal_d_GetGalleryOptions = GetGalleryOptions;\n const proGalleryV2Gallery_universal_d_listGalleryItems: typeof listGalleryItems;\n type proGalleryV2Gallery_universal_d_ListGalleryItemsOptions = ListGalleryItemsOptions;\n const proGalleryV2Gallery_universal_d_getGalleryItem: typeof getGalleryItem;\n type proGalleryV2Gallery_universal_d_GetGalleryItemIdentifiers = GetGalleryItemIdentifiers;\n type proGalleryV2Gallery_universal_d_GetGalleryItemOptions = GetGalleryItemOptions;\n const proGalleryV2Gallery_universal_d_createGallery: typeof createGallery;\n type proGalleryV2Gallery_universal_d_CreateGalleryOptions = CreateGalleryOptions;\n const proGalleryV2Gallery_universal_d_updateGallery: typeof updateGallery;\n type proGalleryV2Gallery_universal_d_UpdateGallery = UpdateGallery;\n type proGalleryV2Gallery_universal_d_UpdateGalleryOptions = UpdateGalleryOptions;\n const proGalleryV2Gallery_universal_d_deleteGallery: typeof deleteGallery;\n type proGalleryV2Gallery_universal_d_DeleteGalleryOptions = DeleteGalleryOptions;\n const proGalleryV2Gallery_universal_d_deleteGalleryItems: typeof deleteGalleryItems;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemsOptions = DeleteGalleryItemsOptions;\n const proGalleryV2Gallery_universal_d_bulkDeleteGalleryItems: typeof bulkDeleteGalleryItems;\n type proGalleryV2Gallery_universal_d_BulkDeleteGalleryItemsOptions = BulkDeleteGalleryItemsOptions;\n const proGalleryV2Gallery_universal_d_createGalleryItem: typeof createGalleryItem;\n type proGalleryV2Gallery_universal_d_CreateGalleryItemOptions = CreateGalleryItemOptions;\n const proGalleryV2Gallery_universal_d_updateGalleryItem: typeof updateGalleryItem;\n type proGalleryV2Gallery_universal_d_UpdateGalleryItemIdentifiers = UpdateGalleryItemIdentifiers;\n type proGalleryV2Gallery_universal_d_UpdateGalleryItem = UpdateGalleryItem;\n type proGalleryV2Gallery_universal_d_UpdateGalleryItemOptions = UpdateGalleryItemOptions;\n const proGalleryV2Gallery_universal_d_deleteGalleryItem: typeof deleteGalleryItem;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemIdentifiers = DeleteGalleryItemIdentifiers;\n type proGalleryV2Gallery_universal_d_DeleteGalleryItemOptions = DeleteGalleryItemOptions;\n const proGalleryV2Gallery_universal_d_publishGallery: typeof publishGallery;\n namespace proGalleryV2Gallery_universal_d {\n export {\n proGalleryV2Gallery_universal_d_Gallery as Gallery,\n proGalleryV2Gallery_universal_d_Item as Item,\n proGalleryV2Gallery_universal_d_ItemMetadataOneOf as ItemMetadataOneOf,\n proGalleryV2Gallery_universal_d_Link as Link,\n proGalleryV2Gallery_universal_d_LinkType as LinkType,\n proGalleryV2Gallery_universal_d_WixLink as WixLink,\n proGalleryV2Gallery_universal_d_WixLinkLinkOneOf as WixLinkLinkOneOf,\n proGalleryV2Gallery_universal_d_ExternalLink as ExternalLink,\n proGalleryV2Gallery_universal_d_PageLink as PageLink,\n proGalleryV2Gallery_universal_d_LinkRel as LinkRel,\n proGalleryV2Gallery_universal_d_AnchorLink as AnchorLink,\n proGalleryV2Gallery_universal_d_DynamicPageLink as DynamicPageLink,\n proGalleryV2Gallery_universal_d_DocumentLink as DocumentLink,\n proGalleryV2Gallery_universal_d_EmailLink as EmailLink,\n proGalleryV2Gallery_universal_d_PhoneLink as PhoneLink,\n proGalleryV2Gallery_universal_d_AddressLink as AddressLink,\n proGalleryV2Gallery_universal_d_WhatsAppLink as WhatsAppLink,\n proGalleryV2Gallery_universal_d_TpaPageLink as TpaPageLink,\n proGalleryV2Gallery_universal_d_Type as Type,\n proGalleryV2Gallery_universal_d_Image as Image,\n proGalleryV2Gallery_universal_d_ImageType as ImageType,\n proGalleryV2Gallery_universal_d_Point as Point,\n proGalleryV2Gallery_universal_d_UnsharpMasking as UnsharpMasking,\n proGalleryV2Gallery_universal_d_Video as Video,\n proGalleryV2Gallery_universal_d_VideoType as VideoType,\n proGalleryV2Gallery_universal_d_VideoResolution as VideoResolution,\n proGalleryV2Gallery_universal_d_Text as Text,\n proGalleryV2Gallery_universal_d_Tags as Tags,\n proGalleryV2Gallery_universal_d_SecondaryMedia as SecondaryMedia,\n proGalleryV2Gallery_universal_d_SecondaryMediaMetadataOneOf as SecondaryMediaMetadataOneOf,\n proGalleryV2Gallery_universal_d_InvalidateCache as InvalidateCache,\n proGalleryV2Gallery_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n proGalleryV2Gallery_universal_d_App as App,\n proGalleryV2Gallery_universal_d_InvalidateCachePage as InvalidateCachePage,\n proGalleryV2Gallery_universal_d_URI as URI,\n proGalleryV2Gallery_universal_d_File as File,\n proGalleryV2Gallery_universal_d_GalleryPublished as GalleryPublished,\n proGalleryV2Gallery_universal_d_CleanDeletedGalleriesEvent as CleanDeletedGalleriesEvent,\n proGalleryV2Gallery_universal_d_ProgallerypublisherPublishGalleryRequest as ProgallerypublisherPublishGalleryRequest,\n proGalleryV2Gallery_universal_d_ProgallerypublisherPublishGalleryResponse as ProgallerypublisherPublishGalleryResponse,\n proGalleryV2Gallery_universal_d_GetActiveGalleryRevisionRequest as GetActiveGalleryRevisionRequest,\n proGalleryV2Gallery_universal_d_GetActiveGalleryRevisionResponse as GetActiveGalleryRevisionResponse,\n proGalleryV2Gallery_universal_d_GetGalleryRevisionRequest as GetGalleryRevisionRequest,\n proGalleryV2Gallery_universal_d_GetGalleryRevisionResponse as GetGalleryRevisionResponse,\n proGalleryV2Gallery_universal_d_PublishGalleryItemRequest as PublishGalleryItemRequest,\n proGalleryV2Gallery_universal_d_PublishGalleryItemResponse as PublishGalleryItemResponse,\n proGalleryV2Gallery_universal_d_PublishGalleryItemsRequest as PublishGalleryItemsRequest,\n proGalleryV2Gallery_universal_d_PublishGalleryItemsResponse as PublishGalleryItemsResponse,\n proGalleryV2Gallery_universal_d_Empty as Empty,\n proGalleryV2Gallery_universal_d_HtmlSitePublished as HtmlSitePublished,\n proGalleryV2Gallery_universal_d_Page as Page,\n proGalleryV2Gallery_universal_d_HtmlSiteRCPublished as HtmlSiteRCPublished,\n proGalleryV2Gallery_universal_d_DomainEvent as DomainEvent,\n proGalleryV2Gallery_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n proGalleryV2Gallery_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n proGalleryV2Gallery_universal_d_RestoreInfo as RestoreInfo,\n proGalleryV2Gallery_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n proGalleryV2Gallery_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n proGalleryV2Gallery_universal_d_ActionEvent as ActionEvent,\n proGalleryV2Gallery_universal_d_MessageEnvelope as MessageEnvelope,\n proGalleryV2Gallery_universal_d_IdentificationData as IdentificationData,\n proGalleryV2Gallery_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n proGalleryV2Gallery_universal_d_WebhookIdentityType as WebhookIdentityType,\n proGalleryV2Gallery_universal_d_UpdateDocumentsEvent as UpdateDocumentsEvent,\n proGalleryV2Gallery_universal_d_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf,\n proGalleryV2Gallery_universal_d_DocumentUpdateOperation as DocumentUpdateOperation,\n proGalleryV2Gallery_universal_d_IndexDocument as IndexDocument,\n proGalleryV2Gallery_universal_d_DocumentPayload as DocumentPayload,\n proGalleryV2Gallery_universal_d_DocumentImage as DocumentImage,\n proGalleryV2Gallery_universal_d_Enum as Enum,\n proGalleryV2Gallery_universal_d_DeleteByIdsOperation as DeleteByIdsOperation,\n proGalleryV2Gallery_universal_d_DeleteByFilterOperation as DeleteByFilterOperation,\n proGalleryV2Gallery_universal_d_UpdateByFilterOperation as UpdateByFilterOperation,\n proGalleryV2Gallery_universal_d_UpdateExistingOperation as UpdateExistingOperation,\n proGalleryV2Gallery_universal_d_SearchIndexingNotification as SearchIndexingNotification,\n proGalleryV2Gallery_universal_d_SearchIndexingNotificationState as SearchIndexingNotificationState,\n proGalleryV2Gallery_universal_d_ListGalleriesItemsRequest as ListGalleriesItemsRequest,\n proGalleryV2Gallery_universal_d_ItemId as ItemId,\n proGalleryV2Gallery_universal_d_ListGalleriesItemsResponse as ListGalleriesItemsResponse,\n proGalleryV2Gallery_universal_d_ItemsInGallery as ItemsInGallery,\n proGalleryV2Gallery_universal_d_GalleryItemCreated as GalleryItemCreated,\n proGalleryV2Gallery_universal_d_GalleryItemUpdated as GalleryItemUpdated,\n proGalleryV2Gallery_universal_d_GalleryItemDeleted as GalleryItemDeleted,\n proGalleryV2Gallery_universal_d_ListGalleriesRequest as ListGalleriesRequest,\n proGalleryV2Gallery_universal_d_State as State,\n proGalleryV2Gallery_universal_d_ListGalleriesResponse as ListGalleriesResponse,\n proGalleryV2Gallery_universal_d_GetGalleryRequest as GetGalleryRequest,\n proGalleryV2Gallery_universal_d_GetGalleryRequestVersionOneOf as GetGalleryRequestVersionOneOf,\n proGalleryV2Gallery_universal_d_GetGalleryResponse as GetGalleryResponse,\n proGalleryV2Gallery_universal_d_ListGalleryItemsRequest as ListGalleryItemsRequest,\n proGalleryV2Gallery_universal_d_ListGalleryItemsResponse as ListGalleryItemsResponse,\n proGalleryV2Gallery_universal_d_GetGalleryItemRequest as GetGalleryItemRequest,\n proGalleryV2Gallery_universal_d_GetGalleryItemResponse as GetGalleryItemResponse,\n proGalleryV2Gallery_universal_d_CreateGalleryRequest as CreateGalleryRequest,\n proGalleryV2Gallery_universal_d_CreateGalleryResponse as CreateGalleryResponse,\n proGalleryV2Gallery_universal_d_UpdateGalleryRequest as UpdateGalleryRequest,\n proGalleryV2Gallery_universal_d_UpdateGalleryResponse as UpdateGalleryResponse,\n proGalleryV2Gallery_universal_d_DeleteGalleryRequest as DeleteGalleryRequest,\n proGalleryV2Gallery_universal_d_DeleteGalleryResponse as DeleteGalleryResponse,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemsRequest as DeleteGalleryItemsRequest,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemsResponse as DeleteGalleryItemsResponse,\n proGalleryV2Gallery_universal_d_BulkDeleteGalleryItemsRequest as BulkDeleteGalleryItemsRequest,\n proGalleryV2Gallery_universal_d_BulkDeleteGalleryItemsResponse as BulkDeleteGalleryItemsResponse,\n proGalleryV2Gallery_universal_d_CreateGalleryItemRequest as CreateGalleryItemRequest,\n proGalleryV2Gallery_universal_d_CreateGalleryItemResponse as CreateGalleryItemResponse,\n proGalleryV2Gallery_universal_d_CreateGalleryItemsRequest as CreateGalleryItemsRequest,\n proGalleryV2Gallery_universal_d_CreateGalleryItemsResponse as CreateGalleryItemsResponse,\n proGalleryV2Gallery_universal_d_UpdateGalleryItemRequest as UpdateGalleryItemRequest,\n proGalleryV2Gallery_universal_d_UpdateGalleryItemResponse as UpdateGalleryItemResponse,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemRequest as DeleteGalleryItemRequest,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemResponse as DeleteGalleryItemResponse,\n proGalleryV2Gallery_universal_d_PublishGalleryRequest as PublishGalleryRequest,\n proGalleryV2Gallery_universal_d_PublishGalleryResponse as PublishGalleryResponse,\n proGalleryV2Gallery_universal_d_listGalleries as listGalleries,\n proGalleryV2Gallery_universal_d_ListGalleriesOptions as ListGalleriesOptions,\n proGalleryV2Gallery_universal_d_getGallery as getGallery,\n proGalleryV2Gallery_universal_d_GetGalleryOptions as GetGalleryOptions,\n proGalleryV2Gallery_universal_d_listGalleryItems as listGalleryItems,\n proGalleryV2Gallery_universal_d_ListGalleryItemsOptions as ListGalleryItemsOptions,\n proGalleryV2Gallery_universal_d_getGalleryItem as getGalleryItem,\n proGalleryV2Gallery_universal_d_GetGalleryItemIdentifiers as GetGalleryItemIdentifiers,\n proGalleryV2Gallery_universal_d_GetGalleryItemOptions as GetGalleryItemOptions,\n proGalleryV2Gallery_universal_d_createGallery as createGallery,\n proGalleryV2Gallery_universal_d_CreateGalleryOptions as CreateGalleryOptions,\n proGalleryV2Gallery_universal_d_updateGallery as updateGallery,\n proGalleryV2Gallery_universal_d_UpdateGallery as UpdateGallery,\n proGalleryV2Gallery_universal_d_UpdateGalleryOptions as UpdateGalleryOptions,\n proGalleryV2Gallery_universal_d_deleteGallery as deleteGallery,\n proGalleryV2Gallery_universal_d_DeleteGalleryOptions as DeleteGalleryOptions,\n proGalleryV2Gallery_universal_d_deleteGalleryItems as deleteGalleryItems,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemsOptions as DeleteGalleryItemsOptions,\n proGalleryV2Gallery_universal_d_bulkDeleteGalleryItems as bulkDeleteGalleryItems,\n proGalleryV2Gallery_universal_d_BulkDeleteGalleryItemsOptions as BulkDeleteGalleryItemsOptions,\n proGalleryV2Gallery_universal_d_createGalleryItem as createGalleryItem,\n proGalleryV2Gallery_universal_d_CreateGalleryItemOptions as CreateGalleryItemOptions,\n proGalleryV2Gallery_universal_d_updateGalleryItem as updateGalleryItem,\n proGalleryV2Gallery_universal_d_UpdateGalleryItemIdentifiers as UpdateGalleryItemIdentifiers,\n proGalleryV2Gallery_universal_d_UpdateGalleryItem as UpdateGalleryItem,\n proGalleryV2Gallery_universal_d_UpdateGalleryItemOptions as UpdateGalleryItemOptions,\n proGalleryV2Gallery_universal_d_deleteGalleryItem as deleteGalleryItem,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemIdentifiers as DeleteGalleryItemIdentifiers,\n proGalleryV2Gallery_universal_d_DeleteGalleryItemOptions as DeleteGalleryItemOptions,\n proGalleryV2Gallery_universal_d_publishGallery as publishGallery,\n };\n }\n \n export { proGalleryV2Gallery_universal_d as proGallery };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-alert-enricher-backend.d.ts", "content": "declare module \"wix-alert-enricher-backend\" {\n /** EnrichmentConfig is the main entity of EnrichmentBo */\n interface EnrichmentConfig {\n /** EnrichmentConfig ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this EnrichmentConfig was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this EnrichmentConfig was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n show?: boolean | null;\n /** implemented bu core / plugin */\n enrichmentSource?: EnrichmentSource;\n /**\n * one of : base definition/ override /merge. merge may only be set by server\n * @readonly\n */\n configurationType?: EnrichmentConfigType;\n /** reserved 9; */\n artifactId?: string | null;\n /** slack channel */\n channel?: string | null;\n /** core: Last-ga-time/ sled-traffic/ top-exceptions plugin: free-text */\n enrichmentType?: EnrichmentType;\n /** app def id defined in dev-center */\n implementorId?: string | null;\n /** user properties for overrides exp: last GA in X days */\n enrichmentConfigProperties?: Record;\n /** free text */\n description?: string | null;\n /** implementer owner buildup or other */\n owner?: string;\n /** owner-ship tag */\n createdBy?: string;\n /** free -text */\n overrideName?: string;\n /** alert type: Error percentage / Unknown */\n alertTypes?: AlertType[];\n }\n enum EnrichmentSource {\n CORE = \"CORE\",\n PLUGIN = \"PLUGIN\"\n }\n enum EnrichmentConfigType {\n OVERRIDE = \"OVERRIDE\",\n BASE_DEFINITION = \"BASE_DEFINITION\",\n MERGED = \"MERGED\"\n }\n enum EnrichmentType {\n UNKNOWN = \"UNKNOWN\",\n LAST_GA_TIME = \"LAST_GA_TIME\",\n GRAFANA_LINK_TIMESTAMP = \"GRAFANA_LINK_TIMESTAMP\",\n TOP_EXCEPTIONS = \"TOP_EXCEPTIONS\",\n SLED_INFO = \"SLED_INFO\",\n ERROR_BY_METASITE = \"ERROR_BY_METASITE\",\n DEBUG_PROD = \"DEBUG_PROD\",\n LAST_EXPERIMENTS_CHANGES = \"LAST_EXPERIMENTS_CHANGES\",\n LAST_KUBE_CHANGES = \"LAST_KUBE_CHANGES\",\n APP_HEALTH_CHECK = \"APP_HEALTH_CHECK\",\n IMMIGRATOR_ACTIVE_MIGRATION = \"IMMIGRATOR_ACTIVE_MIGRATION\",\n OUTGOING_CALLS_ERROR_RATES = \"OUTGOING_CALLS_ERROR_RATES\",\n SERVICE_INCOMING_CALLS_ERROR_RATES = \"SERVICE_INCOMING_CALLS_ERROR_RATES\",\n ACTIVE_RESOURCE_TUNING = \"ACTIVE_RESOURCE_TUNING\",\n ENDPOINT_CALLERS_ERROR_RATES = \"ENDPOINT_CALLERS_ERROR_RATES\",\n SINGLE_EXCEPTION_DATA = \"SINGLE_EXCEPTION_DATA\",\n ACTIVITY_IN_WAR_ROOM = \"ACTIVITY_IN_WAR_ROOM\",\n PODS_DOMINANT_ERROR_RATES = \"PODS_DOMINANT_ERROR_RATES\",\n PANORAMA_INFO = \"PANORAMA_INFO\",\n TRAFFIC_SWITCH = \"TRAFFIC_SWITCH\",\n PAYMENT_TRANSACTIONS = \"PAYMENT_TRANSACTIONS\",\n ZIONA = \"ZIONA\",\n DEAD_LETTER_QUEUE = \"DEAD_LETTER_QUEUE\"\n }\n enum AlertType {\n UNKNOWN = \"UNKNOWN\",\n ERROR_PERCENTAGE = \"ERROR_PERCENTAGE\",\n APP_HEALTH_CHECK = \"APP_HEALTH_CHECK\",\n KAFKA_LAG_GROWTH = \"KAFKA_LAG_GROWTH\",\n CPU_THROTTLED = \"CPU_THROTTLED\",\n POD_OUT_OF_MEMORY = \"POD_OUT_OF_MEMORY\",\n ENDPOINT_ERROR_RATE = \"ENDPOINT_ERROR_RATE\",\n SERVICE_ERROR_RATE = \"SERVICE_ERROR_RATE\",\n ZERO_ERROR_POLICY = \"ZERO_ERROR_POLICY\",\n PANORAMA = \"PANORAMA\",\n PAYMENT_PROVIDER = \"PAYMENT_PROVIDER\",\n JVM_OUT_OF_MEMORY = \"JVM_OUT_OF_MEMORY\",\n JVM_GC_COLLECTION_TIME = \"JVM_GC_COLLECTION_TIME\",\n ENDPOINT_WEIGHTED_RESPONSE_TIME = \"ENDPOINT_WEIGHTED_RESPONSE_TIME\",\n CUSTOM = \"CUSTOM\",\n DEAD_LETTER_QUEUE = \"DEAD_LETTER_QUEUE\"\n }\n interface CreateEnrichmentConfigRequest extends CreateEnrichmentConfigRequestCreateWithPropertiesOneOf {\n enrichmentConfigBase?: EnrichmentConfigBase;\n enrichmentConfigOverride?: EnrichmentConfigOverride;\n }\n /** @oneof */\n interface CreateEnrichmentConfigRequestCreateWithPropertiesOneOf {\n enrichmentConfigBase?: EnrichmentConfigBase;\n enrichmentConfigOverride?: EnrichmentConfigOverride;\n }\n interface EnrichmentConfigBase {\n /** implemented by core / plugin */\n enrichmentSource?: EnrichmentSource;\n /** reserve 2 */\n enrichmentType?: EnrichmentType;\n /** app def id defined in dev-center */\n implementorId?: string;\n /** user properties for overrides exp: last GA in X days */\n enrichmentConfigProperties?: Record;\n /** free text */\n description?: string | null;\n /** implementer owner buildup or other */\n owner?: string;\n /** owner tag */\n createdBy?: string;\n /** show enrichment */\n show?: boolean | null;\n /** alert type: Error percentage / Unknown */\n alertTypes?: AlertType[];\n }\n interface EnrichmentConfigOverride {\n /** reserved 9; */\n artifactId?: string | null;\n /** slack channel */\n channel?: string | null;\n enrichmentType?: EnrichmentType;\n /** user properties for overrides exp: last GA in X days */\n enrichmentConfigProperties?: Record;\n /** owner-ship tag */\n createdBy?: string;\n /** free -text */\n overrideName?: string | null;\n show?: boolean | null;\n /** alert type: Error percentage / Unknown */\n alertTypes?: AlertType[];\n }\n interface CreateEnrichmentConfigResponse {\n /** The created EnrichmentConfig */\n enrichmentConfig?: EnrichmentConfig;\n }\n interface GetEnrichmentConfigRequest {\n /** Id of the EnrichmentConfig to retrieve */\n enrichmentConfigId: string;\n }\n interface GetEnrichmentConfigResponse {\n /** The retrieved EnrichmentConfig */\n enrichmentConfig?: EnrichmentConfig;\n }\n interface ListEnrichmentConfigRequest {\n configurationType?: EnrichmentConfigType;\n alertType?: string | null;\n channel?: string | null;\n artifactId?: string | null;\n enrichmentType?: EnrichmentType;\n }\n interface ListEnrichmentConfigResponse {\n enrichmentConfigs?: EnrichmentConfig[];\n }\n interface ListAllEnrichmentConfigRequest {\n }\n interface UpdateEnrichmentConfigRequest extends UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf {\n enrichmentConfigOvr?: EnrichmentConfigOverrideUpdate;\n enrichmentConfigBase?: EnrichmentConfigBaseUpdate;\n /** Id of the EnrichmentConfig to retrieve */\n _id: string;\n /** The revision of the EnrichmentConfig */\n revision?: string;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /** @oneof */\n interface UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf {\n enrichmentConfigOvr?: EnrichmentConfigOverrideUpdate;\n enrichmentConfigBase?: EnrichmentConfigBaseUpdate;\n }\n interface EnrichmentConfigOverrideUpdate {\n /** reserve 9; */\n artifactId?: string | null;\n /** slack channel */\n channel?: string | null;\n /** user properties for overrides exp: last GA in X days */\n enrichmentConfigProperties?: Record;\n /** owner-ship tag */\n createdBy?: string;\n /** free -text */\n overrideName?: string;\n show?: boolean;\n /** alert type: Error percentage / Unknown */\n alertTypes?: AlertType[];\n }\n interface EnrichmentConfigBaseUpdate {\n /** implemented by core / plugin */\n enrichmentSource?: EnrichmentSource;\n /** reserve 2; */\n enrichmentType?: EnrichmentType;\n /** app def id defined in dev-center */\n implementorId?: string | null;\n /** user properties for overrides exp: last GA in X days */\n enrichmentConfigProperties?: Record;\n /** free text */\n description?: string | null;\n /** implementer owner buildup or other */\n owner?: string;\n /** owner-ship tag */\n createdBy?: string;\n /** show enrichment */\n show?: boolean;\n /** alert type: Error percentage / Unknown */\n alertTypes?: AlertType[];\n }\n interface UpdateEnrichmentConfigResponse {\n /** The updated EnrichmentConfig */\n enrichmentConfig?: EnrichmentConfig;\n }\n interface UpdateEnrichmentConfigShowRequest {\n /** Id of the EnrichmentConfig to retrieve */\n enrichmentConfigId: string;\n /** show property */\n show: boolean;\n }\n interface UpdateEnrichmentConfigShowResponse {\n /** The updated EnrichmentConfig */\n enrichmentConfig?: EnrichmentConfig;\n }\n interface DeleteEnrichmentConfigRequest {\n /** Id of the EnrichmentConfig to delete */\n enrichmentConfigId: string;\n /** The revision of the EnrichmentConfig */\n revision?: string;\n }\n interface DeleteEnrichmentConfigResponse {\n }\n interface QueryEnrichmentConfigRequest {\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;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryEnrichmentConfigResponse {\n /** The retrieved EnrichmentConfigs */\n enrichmentConfigs?: EnrichmentConfig[];\n }\n interface GetEnrichmentConfigForRequest {\n channel?: string;\n alertType?: AlertType;\n artifactId?: string | null;\n }\n interface GetEnrichmentConfigForResponse {\n enrichmentConfigs?: EnrichmentConfig[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 /** @internal\n * @documentationMaturity preview\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_CREATE\n */\n function createEnrichmentConfig(options?: CreateEnrichmentConfigOptions): Promise;\n interface CreateEnrichmentConfigOptions extends CreateEnrichmentConfigRequestCreateWithPropertiesOneOf {\n enrichmentConfigBase?: EnrichmentConfigBase;\n enrichmentConfigOverride?: EnrichmentConfigOverride;\n }\n /**\n * Get a EnrichmentConfig by id\n * @param enrichmentConfigId - Id of the EnrichmentConfig to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField enrichmentConfigId\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_READ\n */\n function getEnrichmentConfig(enrichmentConfigId: string): Promise;\n /**\n * Get a EnrichmentConfig by ListEnrichmentConfigRequest\n * @internal\n * @documentationMaturity preview\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_READ\n */\n function listEnrichmentConfig(options?: ListEnrichmentConfigOptions): Promise;\n interface ListEnrichmentConfigOptions {\n configurationType?: EnrichmentConfigType;\n alertType?: string | null;\n channel?: string | null;\n artifactId?: string | null;\n enrichmentType?: EnrichmentType;\n }\n /**\n * Get a EnrichmentConfig by ListEnrichmentConfigRequest\n * @internal\n * @documentationMaturity preview\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_READ\n */\n function listAllEnrichmentConfig(): Promise;\n /** @param _id - Id of the EnrichmentConfig to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_UPDATE\n */\n function updateEnrichmentConfig(_id: string, options?: UpdateEnrichmentConfigOptions): Promise;\n interface UpdateEnrichmentConfigOptions extends UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf {\n /** The revision of the EnrichmentConfig */\n revision?: string;\n enrichmentConfigOvr?: EnrichmentConfigOverrideUpdate;\n enrichmentConfigBase?: EnrichmentConfigBaseUpdate;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.enrichmentConfigId\n * @requiredField identifiers.show\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_UPDATE\n */\n function updateEnrichmentConfigShow(identifiers: UpdateEnrichmentConfigShowIdentifiers): Promise;\n interface UpdateEnrichmentConfigShowIdentifiers {\n /** Id of the EnrichmentConfig to retrieve */\n enrichmentConfigId: string;\n /** show property */\n show: boolean;\n }\n /**\n * Delete a EnrichmentConfig\n * @param enrichmentConfigId - Id of the EnrichmentConfig to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField enrichmentConfigId\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_DELETE\n */\n function deleteEnrichmentConfig(enrichmentConfigId: string, options?: DeleteEnrichmentConfigOptions): Promise;\n interface DeleteEnrichmentConfigOptions {\n /** The revision of the EnrichmentConfig */\n revision?: string;\n }\n /**\n * Query EnrichmentConfigs using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @param query - WQL expression\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_READ\n */\n function queryEnrichmentConfig(query: QueryV2): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId ALERT_ENRICHER.ENRICHMENT_CONFIG_API_READ\n */\n function getEnrichmentConfigFor(options?: GetEnrichmentConfigForOptions): Promise;\n interface GetEnrichmentConfigForOptions {\n channel?: string;\n alertType?: AlertType;\n artifactId?: string | null;\n }\n \n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfig = EnrichmentConfig;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentSource = EnrichmentSource;\n const primeAutoV1EnrichmentConfig_universal_d_EnrichmentSource: typeof EnrichmentSource;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigType = EnrichmentConfigType;\n const primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigType: typeof EnrichmentConfigType;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentType = EnrichmentType;\n const primeAutoV1EnrichmentConfig_universal_d_EnrichmentType: typeof EnrichmentType;\n type primeAutoV1EnrichmentConfig_universal_d_AlertType = AlertType;\n const primeAutoV1EnrichmentConfig_universal_d_AlertType: typeof AlertType;\n type primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigRequest = CreateEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigRequestCreateWithPropertiesOneOf = CreateEnrichmentConfigRequestCreateWithPropertiesOneOf;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigBase = EnrichmentConfigBase;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigOverride = EnrichmentConfigOverride;\n type primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigResponse = CreateEnrichmentConfigResponse;\n type primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigRequest = GetEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigResponse = GetEnrichmentConfigResponse;\n type primeAutoV1EnrichmentConfig_universal_d_ListEnrichmentConfigRequest = ListEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_ListEnrichmentConfigResponse = ListEnrichmentConfigResponse;\n type primeAutoV1EnrichmentConfig_universal_d_ListAllEnrichmentConfigRequest = ListAllEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigRequest = UpdateEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf = UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigOverrideUpdate = EnrichmentConfigOverrideUpdate;\n type primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigBaseUpdate = EnrichmentConfigBaseUpdate;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigResponse = UpdateEnrichmentConfigResponse;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigShowRequest = UpdateEnrichmentConfigShowRequest;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigShowResponse = UpdateEnrichmentConfigShowResponse;\n type primeAutoV1EnrichmentConfig_universal_d_DeleteEnrichmentConfigRequest = DeleteEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_DeleteEnrichmentConfigResponse = DeleteEnrichmentConfigResponse;\n type primeAutoV1EnrichmentConfig_universal_d_QueryEnrichmentConfigRequest = QueryEnrichmentConfigRequest;\n type primeAutoV1EnrichmentConfig_universal_d_QueryV2 = QueryV2;\n type primeAutoV1EnrichmentConfig_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type primeAutoV1EnrichmentConfig_universal_d_Sorting = Sorting;\n type primeAutoV1EnrichmentConfig_universal_d_SortOrder = SortOrder;\n const primeAutoV1EnrichmentConfig_universal_d_SortOrder: typeof SortOrder;\n type primeAutoV1EnrichmentConfig_universal_d_Paging = Paging;\n type primeAutoV1EnrichmentConfig_universal_d_CursorPaging = CursorPaging;\n type primeAutoV1EnrichmentConfig_universal_d_QueryEnrichmentConfigResponse = QueryEnrichmentConfigResponse;\n type primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigForRequest = GetEnrichmentConfigForRequest;\n type primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigForResponse = GetEnrichmentConfigForResponse;\n type primeAutoV1EnrichmentConfig_universal_d_DomainEvent = DomainEvent;\n type primeAutoV1EnrichmentConfig_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type primeAutoV1EnrichmentConfig_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type primeAutoV1EnrichmentConfig_universal_d_RestoreInfo = RestoreInfo;\n type primeAutoV1EnrichmentConfig_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type primeAutoV1EnrichmentConfig_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type primeAutoV1EnrichmentConfig_universal_d_ActionEvent = ActionEvent;\n type primeAutoV1EnrichmentConfig_universal_d_MessageEnvelope = MessageEnvelope;\n type primeAutoV1EnrichmentConfig_universal_d_IdentificationData = IdentificationData;\n type primeAutoV1EnrichmentConfig_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type primeAutoV1EnrichmentConfig_universal_d_WebhookIdentityType = WebhookIdentityType;\n const primeAutoV1EnrichmentConfig_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const primeAutoV1EnrichmentConfig_universal_d_createEnrichmentConfig: typeof createEnrichmentConfig;\n type primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigOptions = CreateEnrichmentConfigOptions;\n const primeAutoV1EnrichmentConfig_universal_d_getEnrichmentConfig: typeof getEnrichmentConfig;\n const primeAutoV1EnrichmentConfig_universal_d_listEnrichmentConfig: typeof listEnrichmentConfig;\n type primeAutoV1EnrichmentConfig_universal_d_ListEnrichmentConfigOptions = ListEnrichmentConfigOptions;\n const primeAutoV1EnrichmentConfig_universal_d_listAllEnrichmentConfig: typeof listAllEnrichmentConfig;\n const primeAutoV1EnrichmentConfig_universal_d_updateEnrichmentConfig: typeof updateEnrichmentConfig;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigOptions = UpdateEnrichmentConfigOptions;\n const primeAutoV1EnrichmentConfig_universal_d_updateEnrichmentConfigShow: typeof updateEnrichmentConfigShow;\n type primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigShowIdentifiers = UpdateEnrichmentConfigShowIdentifiers;\n const primeAutoV1EnrichmentConfig_universal_d_deleteEnrichmentConfig: typeof deleteEnrichmentConfig;\n type primeAutoV1EnrichmentConfig_universal_d_DeleteEnrichmentConfigOptions = DeleteEnrichmentConfigOptions;\n const primeAutoV1EnrichmentConfig_universal_d_queryEnrichmentConfig: typeof queryEnrichmentConfig;\n const primeAutoV1EnrichmentConfig_universal_d_getEnrichmentConfigFor: typeof getEnrichmentConfigFor;\n type primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigForOptions = GetEnrichmentConfigForOptions;\n namespace primeAutoV1EnrichmentConfig_universal_d {\n export {\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfig as EnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentSource as EnrichmentSource,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigType as EnrichmentConfigType,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentType as EnrichmentType,\n primeAutoV1EnrichmentConfig_universal_d_AlertType as AlertType,\n primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigRequest as CreateEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigRequestCreateWithPropertiesOneOf as CreateEnrichmentConfigRequestCreateWithPropertiesOneOf,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigBase as EnrichmentConfigBase,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigOverride as EnrichmentConfigOverride,\n primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigResponse as CreateEnrichmentConfigResponse,\n primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigRequest as GetEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigResponse as GetEnrichmentConfigResponse,\n primeAutoV1EnrichmentConfig_universal_d_ListEnrichmentConfigRequest as ListEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_ListEnrichmentConfigResponse as ListEnrichmentConfigResponse,\n primeAutoV1EnrichmentConfig_universal_d_ListAllEnrichmentConfigRequest as ListAllEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigRequest as UpdateEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf as UpdateEnrichmentConfigRequestEnrichmentConfigUpdateOneOf,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigOverrideUpdate as EnrichmentConfigOverrideUpdate,\n primeAutoV1EnrichmentConfig_universal_d_EnrichmentConfigBaseUpdate as EnrichmentConfigBaseUpdate,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigResponse as UpdateEnrichmentConfigResponse,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigShowRequest as UpdateEnrichmentConfigShowRequest,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigShowResponse as UpdateEnrichmentConfigShowResponse,\n primeAutoV1EnrichmentConfig_universal_d_DeleteEnrichmentConfigRequest as DeleteEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_DeleteEnrichmentConfigResponse as DeleteEnrichmentConfigResponse,\n primeAutoV1EnrichmentConfig_universal_d_QueryEnrichmentConfigRequest as QueryEnrichmentConfigRequest,\n primeAutoV1EnrichmentConfig_universal_d_QueryV2 as QueryV2,\n primeAutoV1EnrichmentConfig_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n primeAutoV1EnrichmentConfig_universal_d_Sorting as Sorting,\n primeAutoV1EnrichmentConfig_universal_d_SortOrder as SortOrder,\n primeAutoV1EnrichmentConfig_universal_d_Paging as Paging,\n primeAutoV1EnrichmentConfig_universal_d_CursorPaging as CursorPaging,\n primeAutoV1EnrichmentConfig_universal_d_QueryEnrichmentConfigResponse as QueryEnrichmentConfigResponse,\n primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigForRequest as GetEnrichmentConfigForRequest,\n primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigForResponse as GetEnrichmentConfigForResponse,\n primeAutoV1EnrichmentConfig_universal_d_DomainEvent as DomainEvent,\n primeAutoV1EnrichmentConfig_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n primeAutoV1EnrichmentConfig_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n primeAutoV1EnrichmentConfig_universal_d_RestoreInfo as RestoreInfo,\n primeAutoV1EnrichmentConfig_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n primeAutoV1EnrichmentConfig_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n primeAutoV1EnrichmentConfig_universal_d_ActionEvent as ActionEvent,\n primeAutoV1EnrichmentConfig_universal_d_MessageEnvelope as MessageEnvelope,\n primeAutoV1EnrichmentConfig_universal_d_IdentificationData as IdentificationData,\n primeAutoV1EnrichmentConfig_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n primeAutoV1EnrichmentConfig_universal_d_WebhookIdentityType as WebhookIdentityType,\n primeAutoV1EnrichmentConfig_universal_d_createEnrichmentConfig as createEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_CreateEnrichmentConfigOptions as CreateEnrichmentConfigOptions,\n primeAutoV1EnrichmentConfig_universal_d_getEnrichmentConfig as getEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_listEnrichmentConfig as listEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_ListEnrichmentConfigOptions as ListEnrichmentConfigOptions,\n primeAutoV1EnrichmentConfig_universal_d_listAllEnrichmentConfig as listAllEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_updateEnrichmentConfig as updateEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigOptions as UpdateEnrichmentConfigOptions,\n primeAutoV1EnrichmentConfig_universal_d_updateEnrichmentConfigShow as updateEnrichmentConfigShow,\n primeAutoV1EnrichmentConfig_universal_d_UpdateEnrichmentConfigShowIdentifiers as UpdateEnrichmentConfigShowIdentifiers,\n primeAutoV1EnrichmentConfig_universal_d_deleteEnrichmentConfig as deleteEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_DeleteEnrichmentConfigOptions as DeleteEnrichmentConfigOptions,\n primeAutoV1EnrichmentConfig_universal_d_queryEnrichmentConfig as queryEnrichmentConfig,\n primeAutoV1EnrichmentConfig_universal_d_getEnrichmentConfigFor as getEnrichmentConfigFor,\n primeAutoV1EnrichmentConfig_universal_d_GetEnrichmentConfigForOptions as GetEnrichmentConfigForOptions,\n };\n }\n \n export { primeAutoV1EnrichmentConfig_universal_d as config };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-question-backend.d.ts", "content": "declare module \"wix-question-backend\" {\n interface Question {\n _id?: string | null;\n author?: string | null;\n content?: string;\n status?: Status;\n /** @readonly */\n upvotes?: string;\n spicyWords?: string[];\n revision?: string | null;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n }\n enum Status {\n SUBMITTED = \"SUBMITTED\",\n ACCEPTED = \"ACCEPTED\",\n REJECTED = \"REJECTED\",\n ANSWERED = \"ANSWERED\"\n }\n interface CreateQuestionResponse {\n question?: Question;\n }\n interface GetQuestionResponse {\n question?: Question;\n }\n interface UpdateQuestionResponse {\n question?: Question;\n }\n interface DeleteQuestionResponse {\n }\n interface QueryV2 {\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 /** 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 /** 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 /**\n * Sort order.\n *\n * Defaults to `ASC`.\n */\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 /**\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 QueryQuestionResponse {\n questions?: Question[];\n }\n interface QuestionsFeedResponse {\n questions?: FeedQuestion[];\n }\n interface FeedQuestion {\n _id?: string | null;\n /** @readonly */\n author?: string | null;\n /** @readonly */\n content?: string;\n /** @readonly */\n upvotes?: string;\n upvotedByMe?: boolean;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n }\n interface UpvoteResponse {\n }\n interface UpdateQuestionQuestion {\n author?: string | null;\n content?: string;\n status?: Status;\n /** @readonly */\n upvotes?: string;\n spicyWords?: string[];\n revision?: string | null;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n }\n interface UpdateQuestionOptions {\n mask?: string[];\n }\n interface UpvoteOptions {\n redeemVote?: boolean;\n }\n \n function createQuestion(question: Question): Promise;\n function getQuestion(questionId: string): Promise;\n function updateQuestion(_id: string | null, question: UpdateQuestionQuestion, options: UpdateQuestionOptions): Promise;\n function deleteQuestion(questionId: string, revision: string): Promise;\n function queryQuestion(query: QueryV2): Promise;\n function questionsFeed(): Promise;\n function upvote(questionId: string, options: UpvoteOptions): Promise;\n \n const keynoteQuestionsV1Question_backend_d_createQuestion: typeof createQuestion;\n const keynoteQuestionsV1Question_backend_d_getQuestion: typeof getQuestion;\n const keynoteQuestionsV1Question_backend_d_updateQuestion: typeof updateQuestion;\n const keynoteQuestionsV1Question_backend_d_deleteQuestion: typeof deleteQuestion;\n const keynoteQuestionsV1Question_backend_d_queryQuestion: typeof queryQuestion;\n const keynoteQuestionsV1Question_backend_d_questionsFeed: typeof questionsFeed;\n const keynoteQuestionsV1Question_backend_d_upvote: typeof upvote;\n namespace keynoteQuestionsV1Question_backend_d {\n export {\n keynoteQuestionsV1Question_backend_d_createQuestion as createQuestion,\n keynoteQuestionsV1Question_backend_d_getQuestion as getQuestion,\n keynoteQuestionsV1Question_backend_d_updateQuestion as updateQuestion,\n keynoteQuestionsV1Question_backend_d_deleteQuestion as deleteQuestion,\n keynoteQuestionsV1Question_backend_d_queryQuestion as queryQuestion,\n keynoteQuestionsV1Question_backend_d_questionsFeed as questionsFeed,\n keynoteQuestionsV1Question_backend_d_upvote as upvote,\n };\n }\n \n export { keynoteQuestionsV1Question_backend_d as wixKeynoteQuestionsV1Question };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-bobs-backend.d.ts", "content": "declare module \"wix-bobs-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** Wishlist is the main entity of WishlistService that can be used for lorem ipsum dolor */\n interface Wishlist {\n /** Wishlist ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this Wishlist was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Wishlist was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /** An uppercase lorem ipsum dolor for your convenience */\n loremUppercase?: string;\n /** Just an ipsum, may be null */\n ipsum?: string | null;\n /** Business address */\n businessAddress?: string;\n }\n interface CreateWishlistRequest {\n /** Wishlist to be created */\n wishlist: Wishlist;\n }\n interface CreateWishlistResponse {\n /** The created Wishlist */\n wishlist?: Wishlist;\n }\n interface GetWishlistRequest {\n /** Id of the Wishlist to retrieve */\n wishlistId: string;\n }\n interface GetWishlistResponse {\n /** The retrieved Wishlist */\n wishlist?: Wishlist;\n }\n interface UpdateWishlistRequest {\n /** Wishlist to be updated, may be partial */\n wishlist: Wishlist;\n /** Explicit list of fields to update */\n mask?: string[];\n }\n interface UpdateWishlistResponse {\n /** The updated Wishlist */\n wishlist?: Wishlist;\n }\n interface DeleteWishlistRequest {\n /** Id of the Wishlist to delete */\n wishlistId: string;\n /** The revision of the Wishlist */\n revision?: string;\n }\n interface DeleteWishlistResponse {\n }\n interface QueryWishlistRequest {\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;\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 /** 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 /** 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 QueryWishlistResponse {\n /** The retrieved Wishlists */\n wishlists?: Wishlist[];\n }\n /**\n * Creates a new Wishlist\n *\n * This function is not a universal function and runs only on the backend.\n * @param wishlist - Wishlist to be created\n * @public\n * @documentationMaturity preview\n * @requiredField wishlist\n * @adminMethod\n */\n function createWishlist(wishlist: Wishlist): Promise;\n /**\n * Get a Wishlist by id\n *\n * This function is not a universal function and runs only on the backend.\n * @param wishlistId - Id of the Wishlist to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField wishlistId\n * @adminMethod\n */\n function getWishlist(wishlistId: string): Promise;\n /**\n * Update a Wishlist, supports partial update\n * Pass the latest `revision` for a successful update\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - Wishlist ID\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField wishlist\n * @requiredField wishlist.revision\n * @adminMethod\n */\n function updateWishlist(_id: string | null, wishlist: UpdateWishlist, options?: UpdateWishlistOptions): Promise;\n interface UpdateWishlist {\n /** Wishlist ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this Wishlist was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Wishlist was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /** An uppercase lorem ipsum dolor for your convenience */\n loremUppercase?: string;\n /** Just an ipsum, may be null */\n ipsum?: string | null;\n /** Business address */\n businessAddress?: string;\n }\n interface UpdateWishlistOptions {\n /** Explicit list of fields to update */\n mask?: string[];\n }\n /**\n * Delete a Wishlist\n *\n * This function is not a universal function and runs only on the backend.\n * @param wishlistId - Id of the Wishlist to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField wishlistId\n * @adminMethod\n */\n function deleteWishlist(wishlistId: string, options?: DeleteWishlistOptions): Promise;\n interface DeleteWishlistOptions {\n /** The revision of the Wishlist */\n revision?: string;\n }\n /**\n * Query Wishlists using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n *\n * This function is not a universal function and runs only on the backend.\n * @param query - WQL expression\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n * @adminMethod\n */\n function queryWishlist(query: QueryV2): Promise;\n \n export { CreateWishlistRequest, CreateWishlistResponse, CursorPaging, DeleteWishlistOptions, DeleteWishlistRequest, DeleteWishlistResponse, GetWishlistRequest, GetWishlistResponse, Paging, QueryV2, QueryV2PagingMethodOneOf, QueryWishlistRequest, QueryWishlistResponse, SortOrder, Sorting, UpdateWishlist, UpdateWishlistOptions, UpdateWishlistRequest, UpdateWishlistResponse, Wishlist, __debug, createWishlist, deleteWishlist, getWishlist, queryWishlist, updateWishlist };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-freds-backend.d.ts", "content": "declare module \"wix-freds-backend\" {\n /** Wishlist is the main entity of WishlistService that can be used for lorem ipsum dolor */\n interface Wishlist {\n /** Wishlist ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this Wishlist was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Wishlist was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /** An uppercase lorem ipsum dolor for your convenience */\n loremUppercase?: string;\n /** Just an ipsum, may be null */\n ipsum?: string | null;\n /** Business address */\n businessAddress?: string;\n }\n interface CreateWishlistResponse {\n /** The created Wishlist */\n wishlist?: Wishlist;\n }\n interface GetWishlistResponse {\n /** The retrieved Wishlist */\n wishlist?: Wishlist;\n }\n interface UpdateWishlistResponse {\n /** The updated Wishlist */\n wishlist?: Wishlist;\n }\n interface DeleteWishlistResponse {\n }\n interface QueryV2 {\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 /** 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 /** 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 QueryWishlistResponse {\n /** The retrieved Wishlists */\n wishlists?: Wishlist[];\n }\n interface UpdateWishlistWishlist {\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this Wishlist was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Wishlist was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /** An uppercase lorem ipsum dolor for your convenience */\n loremUppercase?: string;\n /** Just an ipsum, may be null */\n ipsum?: string | null;\n /** Business address */\n businessAddress?: string;\n }\n interface UpdateWishlistOptions {\n mask?: string[];\n }\n interface DeleteWishlistOptions {\n revision?: string;\n }\n \n function createWishlist(wishlist: Wishlist): Promise;\n function getWishlist(wishlistId: string): Promise;\n function updateWishlist(_id: string | null, wishlist: UpdateWishlistWishlist, options: UpdateWishlistOptions): Promise;\n function deleteWishlist(wishlistId: string, options: DeleteWishlistOptions): Promise;\n function queryWishlist(query: QueryV2): Promise;\n \n export { createWishlist, deleteWishlist, getWishlist, queryWishlist, updateWishlist };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-ratings-definition-backend.d.ts", "content": "declare module \"wix-ratings-definition-backend\" {\n /** Definitions provide settings for ratings. */\n interface Definition {\n /**\n * Definition ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /** Definition's namespace (the context of rated entities e.g. store). */\n namespace?: string;\n /** Definition's entity ID (the specific category of rated entities within their context, e.g. sports shoes). */\n entityId?: string;\n /** Attribute settings. */\n attributeSettings?: AttributeSetting[];\n /**\n * Represents the time this definition was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this definition was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface AttributeSetting {\n /** Attribute ID. Must be unique across all attributes in definition. */\n _id?: string | null;\n /** Range settings. */\n rangeSetting?: RangeSetting;\n }\n interface RangeSetting {\n /** Minimum (inclusive) value for this attribute. */\n from?: number;\n /** Maximum (inclusive) value for this attribute. */\n to?: number;\n }\n interface CreateDefinitionResponse {\n /** The created definition. */\n definition?: Definition;\n }\n interface GetDefinitionResponse {\n /** The retrieved definition. */\n definition?: Definition;\n }\n interface GetEntityDefinitionResponse {\n /** The retrieved definition. */\n definition?: Definition;\n }\n interface UpdateDefinitionResponse {\n /** The updated definition. */\n definition?: Definition;\n }\n interface DeleteDefinitionResponse {\n }\n interface GetEntityDefinitionIdentifiers {\n namespace: string;\n entityId: string;\n }\n interface UpdateDefinitionDefinition {\n /**\n * Definition ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /** Definition's namespace (the context of rated entities e.g. store). */\n namespace?: string;\n /** Definition's entity ID (the specific category of rated entities within their context, e.g. sports shoes). */\n entityId?: string;\n /** Attribute settings. */\n attributeSettings?: AttributeSetting[];\n /**\n * Represents the time this definition was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this definition was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n interface UpdateDefinitionOptions {\n mask?: string[];\n }\n \n function createDefinition(definition: Definition): Promise;\n function getDefinition(definitionId: string): Promise;\n function getEntityDefinition(identifiers: GetEntityDefinitionIdentifiers): Promise;\n function updateDefinition(_id: string | null, definition: UpdateDefinitionDefinition, options: UpdateDefinitionOptions): Promise;\n function deleteDefinition(definitionId: string, revision: string): Promise;\n \n export { createDefinition, deleteDefinition, getDefinition, getEntityDefinition, updateDefinition };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-echo-backend.d.ts", "content": "declare module \"wix-echo-backend\" {\n interface CalculateMessage {\n /** result of the calculation */\n number?: number;\n /** message comment from the operation */\n message?: string;\n /** fake entity id */\n _id?: string;\n }\n interface CalculateRequest {\n /** 1st number to calculate */\n arg1: number;\n /** 2nd number to calculate */\n arg2: number;\n /** operation to perform */\n operation: CalculateOperation;\n }\n enum CalculateOperation {\n UNDEFINED = \"UNDEFINED\",\n ADD = \"ADD\",\n SUBTRACT = \"SUBTRACT\"\n }\n interface CalculateResponse {\n result?: CalculateMessage;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.arg1\n * @requiredField identifiers.arg2\n * @requiredField identifiers.operation\n * @adminMethod\n */\n function calculate(identifiers: CalculateIdentifiers): Promise;\n interface CalculateIdentifiers {\n /** 1st number to calculate */\n arg1: number;\n /** 2nd number to calculate */\n arg2: number;\n /** operation to perform */\n operation: CalculateOperation;\n }\n \n type metroinspectorV1Calculator_universal_d_CalculateMessage = CalculateMessage;\n type metroinspectorV1Calculator_universal_d_CalculateRequest = CalculateRequest;\n type metroinspectorV1Calculator_universal_d_CalculateOperation = CalculateOperation;\n const metroinspectorV1Calculator_universal_d_CalculateOperation: typeof CalculateOperation;\n type metroinspectorV1Calculator_universal_d_CalculateResponse = CalculateResponse;\n const metroinspectorV1Calculator_universal_d_calculate: typeof calculate;\n type metroinspectorV1Calculator_universal_d_CalculateIdentifiers = CalculateIdentifiers;\n namespace metroinspectorV1Calculator_universal_d {\n export {\n metroinspectorV1Calculator_universal_d_CalculateMessage as CalculateMessage,\n metroinspectorV1Calculator_universal_d_CalculateRequest as CalculateRequest,\n metroinspectorV1Calculator_universal_d_CalculateOperation as CalculateOperation,\n metroinspectorV1Calculator_universal_d_CalculateResponse as CalculateResponse,\n metroinspectorV1Calculator_universal_d_calculate as calculate,\n metroinspectorV1Calculator_universal_d_CalculateIdentifiers as CalculateIdentifiers,\n };\n }\n \n interface MessageItem {\n /** inner_message comment from EchoMessage proto def */\n innerMessage?: string;\n }\n interface EchoRequest {\n /** 1st part of the message */\n arg1: string;\n /** 2nd part of the message */\n arg2?: string;\n /** this field test translatable annotation */\n titleField?: string;\n someInt32?: number;\n someDate?: Date | null;\n }\n interface EchoResponse {\n /**\n * override EchoResponse.echoMessage\n *\n */\n echoMessage?: EchoMessage;\n /** messge reseult as string */\n message?: string;\n }\n interface Dispatched {\n /** the message someone says */\n echo?: EchoMessage;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 EchoMessage {\n veloMessage: string;\n id: string;\n }\n /**\n * Another override description function 4\n * @param arg1 - 1st part of the message\n * @public\n * @documentationMaturity preview\n * @requiredField arg1\n * @param arg2 - modified comment for arg2 el hovav\n * @adminMethod\n * @returns ## override return 4\n */\n function echo(arg1: string, options?: EchoOptions): Promise;\n interface EchoOptions {\n /** 2nd part of the message */\n arg2?: string;\n /** this field test translatable annotation */\n titleField?: string;\n someInt32?: number;\n someDate?: Date | null;\n }\n \n type metroinspectorV1Echo_universal_d_MessageItem = MessageItem;\n type metroinspectorV1Echo_universal_d_EchoRequest = EchoRequest;\n type metroinspectorV1Echo_universal_d_EchoResponse = EchoResponse;\n type metroinspectorV1Echo_universal_d_Dispatched = Dispatched;\n type metroinspectorV1Echo_universal_d_DomainEvent = DomainEvent;\n type metroinspectorV1Echo_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type metroinspectorV1Echo_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type metroinspectorV1Echo_universal_d_RestoreInfo = RestoreInfo;\n type metroinspectorV1Echo_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type metroinspectorV1Echo_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type metroinspectorV1Echo_universal_d_ActionEvent = ActionEvent;\n type metroinspectorV1Echo_universal_d_MessageEnvelope = MessageEnvelope;\n type metroinspectorV1Echo_universal_d_IdentificationData = IdentificationData;\n type metroinspectorV1Echo_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type metroinspectorV1Echo_universal_d_WebhookIdentityType = WebhookIdentityType;\n const metroinspectorV1Echo_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type metroinspectorV1Echo_universal_d_EchoMessage = EchoMessage;\n const metroinspectorV1Echo_universal_d_echo: typeof echo;\n type metroinspectorV1Echo_universal_d_EchoOptions = EchoOptions;\n namespace metroinspectorV1Echo_universal_d {\n export {\n metroinspectorV1Echo_universal_d_MessageItem as MessageItem,\n metroinspectorV1Echo_universal_d_EchoRequest as EchoRequest,\n metroinspectorV1Echo_universal_d_EchoResponse as EchoResponse,\n metroinspectorV1Echo_universal_d_Dispatched as Dispatched,\n metroinspectorV1Echo_universal_d_DomainEvent as DomainEvent,\n metroinspectorV1Echo_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n metroinspectorV1Echo_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n metroinspectorV1Echo_universal_d_RestoreInfo as RestoreInfo,\n metroinspectorV1Echo_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n metroinspectorV1Echo_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n metroinspectorV1Echo_universal_d_ActionEvent as ActionEvent,\n metroinspectorV1Echo_universal_d_MessageEnvelope as MessageEnvelope,\n metroinspectorV1Echo_universal_d_IdentificationData as IdentificationData,\n metroinspectorV1Echo_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n metroinspectorV1Echo_universal_d_WebhookIdentityType as WebhookIdentityType,\n metroinspectorV1Echo_universal_d_EchoMessage as EchoMessage,\n metroinspectorV1Echo_universal_d_echo as echo,\n metroinspectorV1Echo_universal_d_EchoOptions as EchoOptions,\n };\n }\n \n export { metroinspectorV1Calculator_universal_d as calculator, metroinspectorV1Echo_universal_d as metroinspector };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-restaurants-backend.d.ts", "content": "declare module \"wix-restaurants-backend\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * `Operation` is the main entity of `OperationsService`.\n * It represents a restaurant operation and encompasses various aspects of its online ordering.\n */\n interface Operation extends OperationOnlineOrderingStatusOptionsOneOf {\n /** Data related to the `PAUSED_UNTIL` status. */\n pausedUntilOptions?: OnlineOrderingPausedUntilOptions;\n /**\n * The ID of the operation.\n * @readonly\n */\n _id?: string | null;\n /**\n * The current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Timestamp at which the operation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Timestamp at which the operation was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** The operation name. */\n name?: string | null;\n /** An indication of whether the operation is enabled or not. */\n enabled?: boolean | null;\n /**\n * The scheduling data for this operation.\n * Scheduling specifies the time-related aspects of order placement.\n */\n scheduling?: Scheduling;\n /**\n * The profile ID associated with this operation.\n * TODO: talk with the tech writer to understand how best to document this field..\n */\n profileId?: string | null;\n /** An indication of whether this operation is the default one. */\n default?: boolean | null;\n /** The ids of the fulfillment methods associated with this operation. */\n fulfillmentIds?: string[] | null;\n /** The ids of the service fee rules associated with this operation. */\n serviceFeeRulesIds?: string[] | null;\n /** The online ordering status of this operation. */\n onlineOrderingStatus?: OnlineOrderingStatusType;\n }\n /** @oneof */\n interface OperationOnlineOrderingStatusOptionsOneOf {\n /** Data related to the `PAUSED_UNTIL` status. */\n pausedUntilOptions?: OnlineOrderingPausedUntilOptions;\n }\n /** Represents the time-related aspects of order placement. */\n interface Scheduling extends SchedulingSchedulingOptionsOneOf {\n /** Data related to the `ASAP` scheduling type. */\n asapOptions?: AsapScheduling;\n /** Data related to the `PREORDER` scheduling type. */\n preorderOptions?: PreorderScheduling;\n /** The scheduling type. */\n type?: SchedulingType;\n }\n /** @oneof */\n interface SchedulingSchedulingOptionsOneOf {\n /** Data related to the `ASAP` scheduling type. */\n asapOptions?: AsapScheduling;\n /** Data related to the `PREORDER` scheduling type. */\n preorderOptions?: PreorderScheduling;\n }\n /** Scheduling type enum. */\n enum SchedulingType {\n /** Unknown scheduling type. */\n UNKNOWN_SCHEDULING = \"UNKNOWN_SCHEDULING\",\n /**\n * Asap scheduling type.\n * Refers to scheduling orders for as soon as possible handling or for a future time.\n */\n ASAP = \"ASAP\",\n /**\n * Preorder scheduling type.\n * Refers to scheduling orders for a future time only.\n */\n PREORDER = \"PREORDER\"\n }\n /** Data related to `ASAP` scheduling type. */\n interface AsapScheduling extends AsapSchedulingPreparationTimeOneOf, AsapSchedulingAsapPreorderOneOf {\n /**\n * Data related to the `MAX` preparation time type.\n * The preparation time is bounded by a maximum time duration.\n */\n maxOptions?: TimeDuration;\n /**\n * Data related to the `RANGE` preparation time type.\n * The preparation time is bounded by a range of time durations.\n */\n rangeOptions?: TimeDurationRange;\n /** Data related to the `BUSINESS_DAYS_PREORDER` asap preorder type. */\n businessDaysPreorderOptions?: BusinessDaysPreorder;\n /** The type of the preparation time. */\n type?: PreparationTimeType;\n /** An indication of whether it is possible to place an order for a later time on the same day. */\n allowSameDayPreorder?: boolean | null;\n /** The type of preorder allowed for the ASAP scheduling. */\n asapPreorderType?: AsapPreorderType;\n }\n /** @oneof */\n interface AsapSchedulingPreparationTimeOneOf {\n /**\n * Data related to the `MAX` preparation time type.\n * The preparation time is bounded by a maximum time duration.\n */\n maxOptions?: TimeDuration;\n /**\n * Data related to the `RANGE` preparation time type.\n * The preparation time is bounded by a range of time durations.\n */\n rangeOptions?: TimeDurationRange;\n }\n /** @oneof */\n interface AsapSchedulingAsapPreorderOneOf {\n /** Data related to the `BUSINESS_DAYS_PREORDER` asap preorder type. */\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 /**\n * Max preparation time type.\n * Refers to a preparation time that is bounded by a maximum time.\n */\n MAX = \"MAX\",\n /**\n * Range preparation time type.\n * Refers to a preparation time that is bounded by a range of times.\n */\n RANGE = \"RANGE\"\n }\n /** Represents a time duration. */\n interface TimeDuration {\n /** The time unit for the duration. */\n timeUnit?: TimeUnit;\n /**\n * The duration value.\n * Specified in the unit given in the `time_unit` field.\n */\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 /** Represents a time duration range. */\n interface TimeDurationRange {\n /** The time unit for the duration range. */\n timeUnit?: TimeUnit;\n /** Starting time value for the scheduling option. */\n rangeMinimumDuration?: number | null;\n /** Ending time value for the scheduling option. */\n rangeMaximumDuration?: number | null;\n /**\n * The minimum duration value for the duration range.\n * Specified in the unit given in the `time_unit` field.\n */\n minDuration?: number | null;\n /**\n * The maximum duration value for the duration range.\n * Specified in the unit given in the `time_unit` field.\n */\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 /**\n * No preorder type.\n * Refers to not allowing to preorder.\n */\n NO_PREORDER = \"NO_PREORDER\",\n /**\n * Business days preorder type.\n * Refers to allowing to preorder for a maximum number of business days in advance.\n */\n BUSINESS_DAYS_PREORDER = \"BUSINESS_DAYS_PREORDER\"\n }\n /** Represents data related to the `BUSINESS_DAYS_PREORDER` asap preorder type. */\n interface BusinessDaysPreorder {\n /**\n * The maximum number of business days in advance an order can be scheduled.\n * When the given value is 0, it means that an order can be scheduled until the end of the current business day.\n * for any other value, the order can be scheduled until the end of the given number of business days.\n */\n businessDays?: number | null;\n }\n /** Data related to `PREORDER` scheduling type. */\n interface PreorderScheduling {\n /** The preorder method is the way by which preorders can be made. */\n method?: PreorderMethod;\n /** Configuration of how the fulfillment times should be displayed. */\n fulfillmentTimesDisplayConfig?: FulfillmentTimesDisplayConfig;\n /** Configuration of how the fulfillment times should be displayed. */\n fulfillmentTimesDisplay?: FulfillmentTimesDisplayConfig;\n }\n /** Represents the preorder method for `PREORDER` scheduling type. */\n interface PreorderMethod extends PreorderMethodMethodOptionsOneOf {\n /** Data related to the `TIME_BOUNDED` method type. */\n timeBoundedOptions?: TimeBounded;\n /** Data related to the `WEEKLY_SCHEDULE` method type. */\n weeklyScheduleOptions?: WeeklySchedule;\n /**\n * The type of preorder method.\n * Represents the way by which the preorders can be made.\n */\n type?: MethodType;\n }\n /** @oneof */\n interface PreorderMethodMethodOptionsOneOf {\n /** Data related to the `TIME_BOUNDED` method type. */\n timeBoundedOptions?: TimeBounded;\n /** Data related to the `WEEKLY_SCHEDULE` method type. */\n weeklyScheduleOptions?: WeeklySchedule;\n }\n /** Represents a day of week and a time of day. */\n interface DayAndTime {\n /** The day of week. */\n dayOfWeek?: DayOfWeek$6;\n /** The time of day. */\n timeOfDay?: TimeOfDay$1;\n }\n enum DayOfWeek$6 {\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$1 {\n /** Hours (0-23) */\n hours?: number;\n /** Minutes (0-59) */\n minutes?: number;\n }\n /** The preorder method type enum. */\n enum MethodType {\n /** Unknown preorder method type. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /**\n * Time bounded preorder method type.\n * Refers to allowing to preorder for a time bounded by a minimum and maximum time in advance.\n */\n TIME_BOUNDED = \"TIME_BOUNDED\",\n /**\n * Weekly schedule preorder method type.\n * Refers to allowing to preorder by a weekly schedule given a cutoff time.\n */\n WEEKLY_SCHEDULE = \"WEEKLY_SCHEDULE\"\n }\n /** Represents data related to `TIME_BOUNDED` preorder method type. */\n interface TimeBounded {\n /** The minimum advance time required for scheduling the order. */\n minimumInAdvanceTime?: TimeDuration;\n /** The maximum advance time allowed for scheduling the order. */\n maximumInAdvanceTime?: TimeDuration;\n /** The minimum advance time required for scheduling the order. */\n minTimeInAdvance?: TimeDuration;\n /** The maximum advance time allowed for scheduling the order. */\n maxTimeInAdvance?: TimeDuration;\n }\n /** Represents data related to `WEEKLY_SCHEDULE` preorder method type. */\n interface WeeklySchedule {\n /**\n * The weekly schedule cutoff time.\n * Orders placed before the cutoff time will be scheduled for the current week.\n * Orders placed after the cutoff time will be scheduled for the next week.\n */\n cutOffTime?: DayAndTime;\n }\n /** Represents the way by which the fulfillment times should be displayed. */\n interface FulfillmentTimesDisplayConfig extends FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {\n /** Data related to the `TIME_WINDOWS` fulfillment times type. */\n timeWindowsOptions?: TimeDuration;\n /** The type of the fulfillment times. */\n fulfillmentTimesType?: FulfillmentTimesType;\n /** The type of the fulfillment times. */\n type?: FulfillmentTimesType;\n }\n /** @oneof */\n interface FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf {\n /** Data related to the `TIME_WINDOWS` fulfillment times type. */\n timeWindowsOptions?: TimeDuration;\n }\n /** The fulfillment times type enum. */\n enum FulfillmentTimesType {\n /** Unknown fulfillment times type. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /**\n * Time windows fulfillment times type.\n * Refers to displaying fulfillment times as time windows.\n */\n TIME_WINDOWS = \"TIME_WINDOWS\"\n }\n /** Online ordering status enum. */\n enum OnlineOrderingStatusType {\n /** Online ordering status is undefined. */\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 some timestamp. */\n PAUSED_UNTIL = \"PAUSED_UNTIL\"\n }\n /** Data related to the `PAUSED_UNTIL` status in the `online_ordering_status` field. */\n interface OnlineOrderingPausedUntilOptions {\n /** Timestamp until which online ordering is paused. */\n onlineOrderingPausedUntil?: Date;\n }\n interface InvalidateCache$2 extends InvalidateCacheGetByOneOf$2 {\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$2;\n /** Invalidate by page id */\n page?: Page$2;\n /** Invalidate by URI path */\n uri?: URI$2;\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$2 {\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$2;\n /** Invalidate by page id */\n page?: Page$2;\n /** Invalidate by URI path */\n uri?: URI$2;\n }\n interface App$2 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$2 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$2 {\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 CreateOperationRequest {\n /** Operation to create. */\n operation: Operation;\n }\n interface CreateOperationResponse {\n /** The created operation. */\n operation?: Operation;\n }\n interface GetOperationRequest {\n /** The ID of the operation to retrieve. */\n operationId: string;\n }\n interface GetOperationResponse {\n /** The retrieved operation. */\n operation?: Operation;\n }\n interface UpdateOperationRequest {\n /**\n * Operation to update.\n * The operation update may be partial with the use of `field_mask`.\n */\n operation: Operation;\n /**\n * Field mask of the fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateOperationResponse {\n /** The updated operation. */\n operation?: Operation;\n }\n interface DeleteOperationRequest {\n /** The ID of the operation to delete. */\n operationId: string;\n }\n interface DeleteOperationResponse {\n }\n interface QueryOperationRequest {\n /** The query by which to select operations. */\n query: CursorQuery$1;\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$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 }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$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$3;\n }\n enum SortOrder$3 {\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 QueryOperationResponse {\n /** The retrieved operations. */\n operations?: Operation[];\n /** The metadata of the paginated results. */\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 ListOperationsRequest {\n }\n interface ListOperationsResponse {\n /** The retrieved operations. */\n operations?: Operation[];\n }\n interface ListAvailableFulfillmentOptionsRequest {\n /**\n * The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n }\n /** Physical address */\n interface Address$4 extends AddressStreetOneOf$1 {\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. 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$5;\n }\n /** @oneof */\n interface AddressStreetOneOf$1 {\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$5 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$2 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$2;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 ListAvailableFulfillmentOptionsResponse {\n /** An indication of whether pickup fulfillment method is configured for the requested operation. */\n pickupConfigured?: boolean;\n /** An indication of whether delivery fulfillment method is configured for the requested operation. */\n deliveryConfigured?: boolean;\n /** A list of the available fulfillment options. */\n fulfillmentOptions?: FulfillmentOption[];\n }\n /** Represents a fulfillment method that given its availability and the operation's scheduling configurations, is currently available for fulfilling orders. */\n interface FulfillmentOption extends FulfillmentOptionFulfillmentTimeOptionsOneOf, FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf, FulfillmentOptionFulfillmentTypeOptionsOneOf {\n /** The fulfillment time is bounded by a maximum time. */\n maxTimeOptions?: number;\n /** The fulfillment time is bounded by a duration range. */\n durationRangeOptions?: DurationRange;\n /** Data related to the `TIME_WINDOWS` fulfillment times display type. */\n timeWindowsOptions?: TimeWindowDisplayConfig;\n /** Data related to the `PICKUP` fulfillment type. */\n pickupOptions?: PickupDetails$1;\n /**\n * The ID of the fulfillment option.\n * This is the ID of the fulfillment method.\n */\n _id?: string | null;\n /** The fulfillment option type. */\n type?: FulfillmentType$3;\n /** The minimum order price to qualify for using this fulfillment option. */\n minOrderPrice?: string | null;\n /** The fee for using this fulfillment option. */\n fee?: string | null;\n /** The availability of this fulfillment option. */\n availability?: FulfillmentOptionAvailability;\n /**\n * The fulfillment time type.\n * This field will only be relevant to ASAP operations\n */\n fulfillmentTimeType?: FulfillmentTimeType;\n /**\n * The fulfillment times display type.\n * This field will only be relevant to Preorder operations.\n */\n fulfillmentTimesDisplayType?: FulfillmentTimesDisplayType;\n /**\n * Threshold for offering free fulfillment.\n * If order price exceeds this threshold, the given `fee` is waived.\n */\n freeFulfillmentPriceThreshold?: string | null;\n /** The instructions for the fulfillment. */\n instructions?: string | null;\n }\n /** @oneof */\n interface FulfillmentOptionFulfillmentTimeOptionsOneOf {\n /** The fulfillment time is bounded by a maximum time. */\n maxTimeOptions?: number;\n /** The fulfillment time is bounded by a duration range. */\n durationRangeOptions?: DurationRange;\n }\n /** @oneof */\n interface FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf {\n /** Data related to the `TIME_WINDOWS` fulfillment times display type. */\n timeWindowsOptions?: TimeWindowDisplayConfig;\n }\n /** @oneof */\n interface FulfillmentOptionFulfillmentTypeOptionsOneOf {\n /** Data related to the `PICKUP` fulfillment type. */\n pickupOptions?: PickupDetails$1;\n }\n /** The fulfillment type enum. */\n enum FulfillmentType$3 {\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 /** Represents the availability of the fulfillment option. */\n interface FulfillmentOptionAvailability {\n /** An indication of whether it is possible to submit an order for as soon as possible handling. */\n canSubmitOrderForNow?: boolean;\n /** Timestamp at which the fulfillment option's availability starts. */\n startTime?: Date;\n /** Timestamp at which the fulfillment option's availability ends. */\n endTime?: Date;\n /**\n * A list of availability times for the days of the week.\n * All the given times will be within the range defined by [`start_time`, `end_time`].\n */\n availableTimes?: DayOfWeekAvailability$1[];\n /**\n * A list of availability exception.\n * An availability exception is some availability for a specific time, that is different from the usual availability defined in `available_times`.\n * The availability exception overrides the availability defined in `available_times`.\n * All the given times will be within the range defined by [`start_time`, `end_time`].\n */\n exceptions?: AvailabilityException$1[];\n /** The timezone in which the availability times are given. */\n timeZone?: string | null;\n /** An indication of whether it is possible to submit an order for as soon as possible handling. */\n asapHandlingAvailable?: boolean;\n }\n interface DayOfWeekAvailability$1 {\n /** The day of week this availability relates to. */\n dayOfWeek?: DayOfWeek$6;\n /** A list of time ranges during which the fulfillment should be available. */\n timeRanges?: TimeOfDayRange$1[];\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 AvailabilityException$1 {\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 /** The fulfillment time type enum. */\n enum FulfillmentTimeType {\n /** Undefined fulfillment time type. */\n UNDEFINED_FULFILLMENT_TIME = \"UNDEFINED_FULFILLMENT_TIME\",\n /** The fulfillment time is bounded by a maximum time. */\n MAX_TIME = \"MAX_TIME\",\n /** The fulfillment time is bounded by a range of times. */\n DURATION_RANGE = \"DURATION_RANGE\"\n }\n /** Represents a duration range. */\n interface DurationRange {\n /** Minimum duration in minutes. */\n minDuration?: number;\n /** Maximum duration in minutes. */\n maxDuration?: number;\n }\n /** The fulfillment times display type enum. */\n enum FulfillmentTimesDisplayType {\n /** Undefined fulfillment times display type. */\n UNDEFINED_FULFILLMENT_TIMES_DISPLAY = \"UNDEFINED_FULFILLMENT_TIMES_DISPLAY\",\n /** The fulfillment times will be displayed as a list of time windows. */\n TIME_WINDOWS = \"TIME_WINDOWS\"\n }\n /** Represents a time window. */\n interface TimeWindowDisplayConfig {\n /** The time window duration in minutes. */\n durationInMinutes?: number;\n }\n /** Represents data related to the `PICKUP` fulfillment type. */\n interface PickupDetails$1 {\n /**\n * The pickup address.\n * The address of the restaurant will be used.\n */\n address?: Address$4;\n }\n interface ListFirstAvailableTimeSlotForFulfillmentTypesRequest {\n /**\n * The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n }\n interface ListFirstAvailableTimeSlotForFulfillmentTypesResponse {\n /**\n * A list of available time slots for each fulfillment type.\n * Each time slot will be the first available time slot for the given fulfillment type.\n * A fulfillment type of Delivery will only be returned if the delivery address is provided\n */\n timeSlots?: TimeSlot[];\n }\n interface TimeSlot extends TimeSlotFeeOptionsOneOf, TimeSlotFulfillmentTimeOptionsOneOf, TimeSlotMinOrderPriceOptionsOneOf {\n /** A single fee value. */\n valueOptions?: string | null;\n /** A range of fees. */\n rangeOptions?: PriceRange;\n /** The maximum time in minutes it will take to fulfill the order, e.g., 20 minutes. */\n maxTimeOptions?: number;\n /** The duration range in minutes it will take to fulfill the order, e.g., 20 - 30 minutes. */\n durationRangeOptions?: DurationRange;\n /** A single min order price value. */\n priceValueOptions?: string | null;\n /** A range of min order prices. */\n priceRangeOptions?: MinOrderPriceRange;\n /** The start time of the time slot. */\n startTime?: Date;\n /** The end time of the time slot. */\n endTime?: Date;\n /** The type of the fulfillment. */\n fulfilmentType?: FulfillmentType$3;\n /** Indication of whether the time slot starts now. */\n startsNow?: boolean;\n /** The fee type of the time slot. */\n feeType?: FeeType;\n /** The fulfillment time type. */\n fulfillmentTimeType?: FulfillmentTimeType;\n /** The min order price type. */\n minOrderPriceType?: MinOrderPriceType;\n }\n /** @oneof */\n interface TimeSlotFeeOptionsOneOf {\n /** A single fee value. */\n valueOptions?: string | null;\n /** A range of fees. */\n rangeOptions?: PriceRange;\n }\n /** @oneof */\n interface TimeSlotFulfillmentTimeOptionsOneOf {\n /** The maximum time in minutes it will take to fulfill the order, e.g., 20 minutes. */\n maxTimeOptions?: number;\n /** The duration range in minutes it will take to fulfill the order, e.g., 20 - 30 minutes. */\n durationRangeOptions?: DurationRange;\n }\n /** @oneof */\n interface TimeSlotMinOrderPriceOptionsOneOf {\n /** A single min order price value. */\n priceValueOptions?: string | null;\n /** A range of min order prices. */\n priceRangeOptions?: MinOrderPriceRange;\n }\n enum FeeType {\n /** Undefined fee type. */\n UNDEFINED_FEE_TYPE = \"UNDEFINED_FEE_TYPE\",\n /** Single price value. */\n VALUE = \"VALUE\",\n /** Range of prices value. */\n RANGE = \"RANGE\"\n }\n interface PriceRange {\n /** The minimum price of the range. */\n minPrice?: string | null;\n /** The maximum price of the range. */\n maxPrice?: string | null;\n }\n /** Min order price enum. */\n enum MinOrderPriceType {\n /** Undefined min order price type. */\n UNDEFINED_MIN_ORDER_PRICE_TYPE = \"UNDEFINED_MIN_ORDER_PRICE_TYPE\",\n /** Single min order price value. */\n PRICE_VALUE = \"PRICE_VALUE\",\n /** Range of min order price values. */\n PRICE_RANGE = \"PRICE_RANGE\"\n }\n /** Min order price range. */\n interface MinOrderPriceRange {\n /** The lower bound of the min order prices range. */\n lowerBound?: string | null;\n /** The upper bound of the min order prices range. */\n upperBound?: string | null;\n }\n interface ListAvailableTimeSlotsForDateRequest {\n /**\n * The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n /** The date 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 /** A list of the available time slots in the requested date. */\n timeSlots?: TimeSlot[];\n }\n interface ListAvailableDatesInRangeRequest {\n /**\n * The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n */\n operationId: string;\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n /** The start date of the range. */\n from: _Date;\n /** The end date of the range. */\n until: _Date;\n }\n interface ListAvailableDatesInRangeResponse {\n /** A list of the available dates in descending order. */\n availableDates?: _Date[];\n }\n interface GetExpectedFulfillmentSelectionRequest {\n /** The id of the operation. The returned fulfillment will belong to this operation. */\n operationId: string;\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n /** The start time of the time slot. */\n timeslotStartTime?: Date;\n /** The end time of the time slot. */\n timeslotEndTime?: Date;\n /** The type of the fulfillment. */\n fulfilmentType: FulfillmentType$3;\n /** An indication whether it is possible to submit an order for now. */\n canSubmitOrderForNow?: boolean | null;\n }\n interface GetExpectedFulfillmentSelectionResponse {\n /** The expected fulfilment option to be selected. */\n expectedFulfillmentSelections?: FulfillmentOption[];\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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface Empty$4 {\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 /** Set of properties that were updated - corresponds to the fields in \"properties\". */\n fields?: string[];\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$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?: 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$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$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 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$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$6[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$6[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$6 {\n /** Day of the week the period starts on. */\n openDay?: V4DayOfWeek;\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?: V4DayOfWeek;\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 V4DayOfWeek {\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$6 {\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$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$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 /**\n * Creates a new operation.\n * @param operation - Operation to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField operation\n * @adminMethod\n * @returns The created operation.\n */\n function createOperation(operation: Operation): Promise;\n /**\n * Retrieves an operation.\n * @param operationId - The ID of the operation to retrieve.\n * @internal\n * @documentationMaturity preview\n * @requiredField operationId\n * @returns The retrieved operation.\n */\n function getOperation(operationId: string): Promise;\n /**\n * Updates an operation.\n * Partial updates are supported, except for the scheduling field.\n * Each time the operation is updated, the `revision` increments by 1.\n * The existing `revision` must be included in the request when updating the operation.\n * This ensures you're updating the latest version of the operation and it prevents unintended overwrites.\n * @param _id - The ID of the operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField operation\n * @requiredField operation.revision\n * @adminMethod\n * @returns The updated operation.\n */\n function updateOperation(_id: string | null, operation: UpdateOperation, options?: UpdateOperationOptions): Promise;\n interface UpdateOperation {\n /** Data related to the `PAUSED_UNTIL` status. */\n pausedUntilOptions?: OnlineOrderingPausedUntilOptions;\n /**\n * The ID of the operation.\n * @readonly\n */\n _id?: string | null;\n /**\n * The current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Timestamp at which the operation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Timestamp at which the operation was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** The operation name. */\n name?: string | null;\n /** An indication of whether the operation is enabled or not. */\n enabled?: boolean | null;\n /**\n * The scheduling data for this operation.\n * Scheduling specifies the time-related aspects of order placement.\n */\n scheduling?: Scheduling;\n /**\n * The profile ID associated with this operation.\n * TODO: talk with the tech writer to understand how best to document this field..\n */\n profileId?: string | null;\n /** An indication of whether this operation is the default one. */\n default?: boolean | null;\n /** The ids of the fulfillment methods associated with this operation. */\n fulfillmentIds?: string[] | null;\n /** The ids of the service fee rules associated with this operation. */\n serviceFeeRulesIds?: string[] | null;\n /** The online ordering status of this operation. */\n onlineOrderingStatus?: OnlineOrderingStatusType;\n }\n interface UpdateOperationOptions {\n /**\n * Field mask of the fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes an operation.\n * @param operationId - The ID of the operation to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField operationId\n * @adminMethod\n */\n function deleteOperation(operationId: string): Promise;\n /**\n * Retrieves a list of operations by a given query.\n * To learn how to query operations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * Up to 100 operations can be returned per request.\n * @internal\n * @documentationMaturity preview\n */\n function queryOperation(): OperationsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface OperationsQueryResult extends QueryCursorResult$1 {\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', 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', 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', 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', value: any[]) => OperationsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id', value: any) => OperationsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id', 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'>) => 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'>) => 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 * Up to 100 operations can be returned per request.\n * TODO: support pagination\n * @internal\n * @documentationMaturity preview\n */\n function listOperations(): Promise;\n /**\n * Retrieves a list of available fulfillment options.\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 - The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField operationId\n */\n function listAvailableFulfillmentOptions(operationId: string, options?: ListAvailableFulfillmentOptions): Promise;\n interface ListAvailableFulfillmentOptions {\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n }\n /**\n * Retrieves a list of available time slots for each fulfillment type.\n * Each time slot will be the first available time slot for the given fulfillment type.\n * @param operationId - The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField operationId\n */\n function listFirstAvailableTimeSlotForFulfillmentTypes(operationId: string, options?: ListFirstAvailableTimeSlotForFulfillmentTypesOptions): Promise;\n interface ListFirstAvailableTimeSlotForFulfillmentTypesOptions {\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n }\n /**\n * Retrieves a list of the available time slots for a given date.\n * @param operationId - The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n * @internal\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 */\n function listAvailableTimeSlotsForDate(operationId: string, options?: ListAvailableTimeSlotsForDateOptions): Promise;\n interface ListAvailableTimeSlotsForDateOptions {\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n /** The date 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 * A date is considered available if it has at least one available time slot.\n * @param operationId - The ID of the operation.\n * The returned fulfillment options will belong to this operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField operationId\n * @requiredField options.from\n * @requiredField options.until\n */\n function listAvailableDatesInRange(operationId: string, options?: ListAvailableDatesInRangeOptions): Promise;\n interface ListAvailableDatesInRangeOptions {\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment options will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n /** The start date of the range. */\n from: _Date;\n /** The end date of the range. */\n until: _Date;\n }\n /**\n * Retrieves a list of the fulfillment options that will be available given the provided filters.\n * TODO: probably rename, the implementation took a different direction than the name suggests\n * @param operationId - The id of the operation. The returned fulfillment will belong to this operation.\n * @internal\n * @documentationMaturity preview\n * @requiredField operationId\n * @requiredField options.fulfilmentType\n */\n function getExpectedFulfillmentSelection(operationId: string, options?: GetExpectedFulfillmentSelectionOptions): Promise;\n interface GetExpectedFulfillmentSelectionOptions {\n /**\n * A delivery address. This parameter is optional.\n * If provided, the returned delivery fulfillment will be able to deliver to this address.\n */\n deliveryAddress?: Address$4;\n /** The start time of the time slot. */\n timeslotStartTime?: Date;\n /** The end time of the time slot. */\n timeslotEndTime?: Date;\n /** The type of the fulfillment. */\n fulfilmentType: FulfillmentType$3;\n /** An indication whether it is possible to submit an order for now. */\n canSubmitOrderForNow?: boolean | null;\n }\n \n type restaurantsOperationsV1Operation_universal_d_Operation = Operation;\n type restaurantsOperationsV1Operation_universal_d_OperationOnlineOrderingStatusOptionsOneOf = OperationOnlineOrderingStatusOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_Scheduling = Scheduling;\n type restaurantsOperationsV1Operation_universal_d_SchedulingSchedulingOptionsOneOf = SchedulingSchedulingOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_SchedulingType = SchedulingType;\n const restaurantsOperationsV1Operation_universal_d_SchedulingType: typeof SchedulingType;\n type restaurantsOperationsV1Operation_universal_d_AsapScheduling = AsapScheduling;\n type restaurantsOperationsV1Operation_universal_d_AsapSchedulingPreparationTimeOneOf = AsapSchedulingPreparationTimeOneOf;\n type restaurantsOperationsV1Operation_universal_d_AsapSchedulingAsapPreorderOneOf = AsapSchedulingAsapPreorderOneOf;\n type restaurantsOperationsV1Operation_universal_d_PreparationTimeType = PreparationTimeType;\n const restaurantsOperationsV1Operation_universal_d_PreparationTimeType: typeof PreparationTimeType;\n type restaurantsOperationsV1Operation_universal_d_TimeDuration = TimeDuration;\n type restaurantsOperationsV1Operation_universal_d_TimeUnit = TimeUnit;\n const restaurantsOperationsV1Operation_universal_d_TimeUnit: typeof TimeUnit;\n type restaurantsOperationsV1Operation_universal_d_TimeDurationRange = TimeDurationRange;\n type restaurantsOperationsV1Operation_universal_d_AsapPreorderType = AsapPreorderType;\n const restaurantsOperationsV1Operation_universal_d_AsapPreorderType: typeof AsapPreorderType;\n type restaurantsOperationsV1Operation_universal_d_BusinessDaysPreorder = BusinessDaysPreorder;\n type restaurantsOperationsV1Operation_universal_d_PreorderScheduling = PreorderScheduling;\n type restaurantsOperationsV1Operation_universal_d_PreorderMethod = PreorderMethod;\n type restaurantsOperationsV1Operation_universal_d_PreorderMethodMethodOptionsOneOf = PreorderMethodMethodOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_DayAndTime = DayAndTime;\n type restaurantsOperationsV1Operation_universal_d_MethodType = MethodType;\n const restaurantsOperationsV1Operation_universal_d_MethodType: typeof MethodType;\n type restaurantsOperationsV1Operation_universal_d_TimeBounded = TimeBounded;\n type restaurantsOperationsV1Operation_universal_d_WeeklySchedule = WeeklySchedule;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayConfig = FulfillmentTimesDisplayConfig;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf = FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentTimesType = FulfillmentTimesType;\n const restaurantsOperationsV1Operation_universal_d_FulfillmentTimesType: typeof FulfillmentTimesType;\n type restaurantsOperationsV1Operation_universal_d_OnlineOrderingStatusType = OnlineOrderingStatusType;\n const restaurantsOperationsV1Operation_universal_d_OnlineOrderingStatusType: typeof OnlineOrderingStatusType;\n type restaurantsOperationsV1Operation_universal_d_OnlineOrderingPausedUntilOptions = OnlineOrderingPausedUntilOptions;\n type restaurantsOperationsV1Operation_universal_d_CreateOperationRequest = CreateOperationRequest;\n type restaurantsOperationsV1Operation_universal_d_CreateOperationResponse = CreateOperationResponse;\n type restaurantsOperationsV1Operation_universal_d_GetOperationRequest = GetOperationRequest;\n type restaurantsOperationsV1Operation_universal_d_GetOperationResponse = GetOperationResponse;\n type restaurantsOperationsV1Operation_universal_d_UpdateOperationRequest = UpdateOperationRequest;\n type restaurantsOperationsV1Operation_universal_d_UpdateOperationResponse = UpdateOperationResponse;\n type restaurantsOperationsV1Operation_universal_d_DeleteOperationRequest = DeleteOperationRequest;\n type restaurantsOperationsV1Operation_universal_d_DeleteOperationResponse = DeleteOperationResponse;\n type restaurantsOperationsV1Operation_universal_d_QueryOperationRequest = QueryOperationRequest;\n type restaurantsOperationsV1Operation_universal_d_QueryOperationResponse = QueryOperationResponse;\n type restaurantsOperationsV1Operation_universal_d_ListOperationsRequest = ListOperationsRequest;\n type restaurantsOperationsV1Operation_universal_d_ListOperationsResponse = ListOperationsResponse;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableFulfillmentOptionsRequest = ListAvailableFulfillmentOptionsRequest;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableFulfillmentOptionsResponse = ListAvailableFulfillmentOptionsResponse;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentOption = FulfillmentOption;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentOptionFulfillmentTimeOptionsOneOf = FulfillmentOptionFulfillmentTimeOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf = FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentOptionFulfillmentTypeOptionsOneOf = FulfillmentOptionFulfillmentTypeOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentOptionAvailability = FulfillmentOptionAvailability;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentTimeType = FulfillmentTimeType;\n const restaurantsOperationsV1Operation_universal_d_FulfillmentTimeType: typeof FulfillmentTimeType;\n type restaurantsOperationsV1Operation_universal_d_DurationRange = DurationRange;\n type restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayType = FulfillmentTimesDisplayType;\n const restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayType: typeof FulfillmentTimesDisplayType;\n type restaurantsOperationsV1Operation_universal_d_TimeWindowDisplayConfig = TimeWindowDisplayConfig;\n type restaurantsOperationsV1Operation_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesRequest = ListFirstAvailableTimeSlotForFulfillmentTypesRequest;\n type restaurantsOperationsV1Operation_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesResponse = ListFirstAvailableTimeSlotForFulfillmentTypesResponse;\n type restaurantsOperationsV1Operation_universal_d_TimeSlot = TimeSlot;\n type restaurantsOperationsV1Operation_universal_d_TimeSlotFeeOptionsOneOf = TimeSlotFeeOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_TimeSlotFulfillmentTimeOptionsOneOf = TimeSlotFulfillmentTimeOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_TimeSlotMinOrderPriceOptionsOneOf = TimeSlotMinOrderPriceOptionsOneOf;\n type restaurantsOperationsV1Operation_universal_d_FeeType = FeeType;\n const restaurantsOperationsV1Operation_universal_d_FeeType: typeof FeeType;\n type restaurantsOperationsV1Operation_universal_d_PriceRange = PriceRange;\n type restaurantsOperationsV1Operation_universal_d_MinOrderPriceType = MinOrderPriceType;\n const restaurantsOperationsV1Operation_universal_d_MinOrderPriceType: typeof MinOrderPriceType;\n type restaurantsOperationsV1Operation_universal_d_MinOrderPriceRange = MinOrderPriceRange;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableTimeSlotsForDateRequest = ListAvailableTimeSlotsForDateRequest;\n type restaurantsOperationsV1Operation_universal_d__Date = _Date;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableTimeSlotsForDateResponse = ListAvailableTimeSlotsForDateResponse;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableDatesInRangeRequest = ListAvailableDatesInRangeRequest;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableDatesInRangeResponse = ListAvailableDatesInRangeResponse;\n type restaurantsOperationsV1Operation_universal_d_GetExpectedFulfillmentSelectionRequest = GetExpectedFulfillmentSelectionRequest;\n type restaurantsOperationsV1Operation_universal_d_GetExpectedFulfillmentSelectionResponse = GetExpectedFulfillmentSelectionResponse;\n type restaurantsOperationsV1Operation_universal_d_V4Address = V4Address;\n type restaurantsOperationsV1Operation_universal_d_V4DayOfWeek = V4DayOfWeek;\n const restaurantsOperationsV1Operation_universal_d_V4DayOfWeek: typeof V4DayOfWeek;\n const restaurantsOperationsV1Operation_universal_d_createOperation: typeof createOperation;\n const restaurantsOperationsV1Operation_universal_d_getOperation: typeof getOperation;\n const restaurantsOperationsV1Operation_universal_d_updateOperation: typeof updateOperation;\n type restaurantsOperationsV1Operation_universal_d_UpdateOperation = UpdateOperation;\n type restaurantsOperationsV1Operation_universal_d_UpdateOperationOptions = UpdateOperationOptions;\n const restaurantsOperationsV1Operation_universal_d_deleteOperation: typeof deleteOperation;\n const restaurantsOperationsV1Operation_universal_d_queryOperation: typeof queryOperation;\n type restaurantsOperationsV1Operation_universal_d_OperationsQueryResult = OperationsQueryResult;\n type restaurantsOperationsV1Operation_universal_d_OperationsQueryBuilder = OperationsQueryBuilder;\n const restaurantsOperationsV1Operation_universal_d_listOperations: typeof listOperations;\n const restaurantsOperationsV1Operation_universal_d_listAvailableFulfillmentOptions: typeof listAvailableFulfillmentOptions;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableFulfillmentOptions = ListAvailableFulfillmentOptions;\n const restaurantsOperationsV1Operation_universal_d_listFirstAvailableTimeSlotForFulfillmentTypes: typeof listFirstAvailableTimeSlotForFulfillmentTypes;\n type restaurantsOperationsV1Operation_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesOptions = ListFirstAvailableTimeSlotForFulfillmentTypesOptions;\n const restaurantsOperationsV1Operation_universal_d_listAvailableTimeSlotsForDate: typeof listAvailableTimeSlotsForDate;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableTimeSlotsForDateOptions = ListAvailableTimeSlotsForDateOptions;\n const restaurantsOperationsV1Operation_universal_d_listAvailableDatesInRange: typeof listAvailableDatesInRange;\n type restaurantsOperationsV1Operation_universal_d_ListAvailableDatesInRangeOptions = ListAvailableDatesInRangeOptions;\n const restaurantsOperationsV1Operation_universal_d_getExpectedFulfillmentSelection: typeof getExpectedFulfillmentSelection;\n type restaurantsOperationsV1Operation_universal_d_GetExpectedFulfillmentSelectionOptions = GetExpectedFulfillmentSelectionOptions;\n namespace restaurantsOperationsV1Operation_universal_d {\n export {\n __debug$1 as __debug,\n restaurantsOperationsV1Operation_universal_d_Operation as Operation,\n restaurantsOperationsV1Operation_universal_d_OperationOnlineOrderingStatusOptionsOneOf as OperationOnlineOrderingStatusOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_Scheduling as Scheduling,\n restaurantsOperationsV1Operation_universal_d_SchedulingSchedulingOptionsOneOf as SchedulingSchedulingOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_SchedulingType as SchedulingType,\n restaurantsOperationsV1Operation_universal_d_AsapScheduling as AsapScheduling,\n restaurantsOperationsV1Operation_universal_d_AsapSchedulingPreparationTimeOneOf as AsapSchedulingPreparationTimeOneOf,\n restaurantsOperationsV1Operation_universal_d_AsapSchedulingAsapPreorderOneOf as AsapSchedulingAsapPreorderOneOf,\n restaurantsOperationsV1Operation_universal_d_PreparationTimeType as PreparationTimeType,\n restaurantsOperationsV1Operation_universal_d_TimeDuration as TimeDuration,\n restaurantsOperationsV1Operation_universal_d_TimeUnit as TimeUnit,\n restaurantsOperationsV1Operation_universal_d_TimeDurationRange as TimeDurationRange,\n restaurantsOperationsV1Operation_universal_d_AsapPreorderType as AsapPreorderType,\n restaurantsOperationsV1Operation_universal_d_BusinessDaysPreorder as BusinessDaysPreorder,\n restaurantsOperationsV1Operation_universal_d_PreorderScheduling as PreorderScheduling,\n restaurantsOperationsV1Operation_universal_d_PreorderMethod as PreorderMethod,\n restaurantsOperationsV1Operation_universal_d_PreorderMethodMethodOptionsOneOf as PreorderMethodMethodOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_DayAndTime as DayAndTime,\n DayOfWeek$6 as DayOfWeek,\n TimeOfDay$1 as TimeOfDay,\n restaurantsOperationsV1Operation_universal_d_MethodType as MethodType,\n restaurantsOperationsV1Operation_universal_d_TimeBounded as TimeBounded,\n restaurantsOperationsV1Operation_universal_d_WeeklySchedule as WeeklySchedule,\n restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayConfig as FulfillmentTimesDisplayConfig,\n restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf as FulfillmentTimesDisplayConfigFulfillmentTimesDisplayOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_FulfillmentTimesType as FulfillmentTimesType,\n restaurantsOperationsV1Operation_universal_d_OnlineOrderingStatusType as OnlineOrderingStatusType,\n restaurantsOperationsV1Operation_universal_d_OnlineOrderingPausedUntilOptions as OnlineOrderingPausedUntilOptions,\n InvalidateCache$2 as InvalidateCache,\n InvalidateCacheGetByOneOf$2 as InvalidateCacheGetByOneOf,\n App$2 as App,\n Page$2 as Page,\n URI$2 as URI,\n restaurantsOperationsV1Operation_universal_d_CreateOperationRequest as CreateOperationRequest,\n restaurantsOperationsV1Operation_universal_d_CreateOperationResponse as CreateOperationResponse,\n restaurantsOperationsV1Operation_universal_d_GetOperationRequest as GetOperationRequest,\n restaurantsOperationsV1Operation_universal_d_GetOperationResponse as GetOperationResponse,\n restaurantsOperationsV1Operation_universal_d_UpdateOperationRequest as UpdateOperationRequest,\n restaurantsOperationsV1Operation_universal_d_UpdateOperationResponse as UpdateOperationResponse,\n restaurantsOperationsV1Operation_universal_d_DeleteOperationRequest as DeleteOperationRequest,\n restaurantsOperationsV1Operation_universal_d_DeleteOperationResponse as DeleteOperationResponse,\n restaurantsOperationsV1Operation_universal_d_QueryOperationRequest as QueryOperationRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$3 as SortOrder,\n CursorPaging$2 as CursorPaging,\n restaurantsOperationsV1Operation_universal_d_QueryOperationResponse as QueryOperationResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$2 as Cursors,\n restaurantsOperationsV1Operation_universal_d_ListOperationsRequest as ListOperationsRequest,\n restaurantsOperationsV1Operation_universal_d_ListOperationsResponse as ListOperationsResponse,\n restaurantsOperationsV1Operation_universal_d_ListAvailableFulfillmentOptionsRequest as ListAvailableFulfillmentOptionsRequest,\n Address$4 as Address,\n AddressStreetOneOf$1 as AddressStreetOneOf,\n StreetAddress$4 as StreetAddress,\n AddressLocation$5 as AddressLocation,\n Subdivision$2 as Subdivision,\n SubdivisionType$2 as SubdivisionType,\n restaurantsOperationsV1Operation_universal_d_ListAvailableFulfillmentOptionsResponse as ListAvailableFulfillmentOptionsResponse,\n restaurantsOperationsV1Operation_universal_d_FulfillmentOption as FulfillmentOption,\n restaurantsOperationsV1Operation_universal_d_FulfillmentOptionFulfillmentTimeOptionsOneOf as FulfillmentOptionFulfillmentTimeOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf as FulfillmentOptionFulfillmentTimesDisplayOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_FulfillmentOptionFulfillmentTypeOptionsOneOf as FulfillmentOptionFulfillmentTypeOptionsOneOf,\n FulfillmentType$3 as FulfillmentType,\n restaurantsOperationsV1Operation_universal_d_FulfillmentOptionAvailability as FulfillmentOptionAvailability,\n DayOfWeekAvailability$1 as DayOfWeekAvailability,\n TimeOfDayRange$1 as TimeOfDayRange,\n AvailabilityException$1 as AvailabilityException,\n restaurantsOperationsV1Operation_universal_d_FulfillmentTimeType as FulfillmentTimeType,\n restaurantsOperationsV1Operation_universal_d_DurationRange as DurationRange,\n restaurantsOperationsV1Operation_universal_d_FulfillmentTimesDisplayType as FulfillmentTimesDisplayType,\n restaurantsOperationsV1Operation_universal_d_TimeWindowDisplayConfig as TimeWindowDisplayConfig,\n PickupDetails$1 as PickupDetails,\n restaurantsOperationsV1Operation_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesRequest as ListFirstAvailableTimeSlotForFulfillmentTypesRequest,\n restaurantsOperationsV1Operation_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesResponse as ListFirstAvailableTimeSlotForFulfillmentTypesResponse,\n restaurantsOperationsV1Operation_universal_d_TimeSlot as TimeSlot,\n restaurantsOperationsV1Operation_universal_d_TimeSlotFeeOptionsOneOf as TimeSlotFeeOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_TimeSlotFulfillmentTimeOptionsOneOf as TimeSlotFulfillmentTimeOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_TimeSlotMinOrderPriceOptionsOneOf as TimeSlotMinOrderPriceOptionsOneOf,\n restaurantsOperationsV1Operation_universal_d_FeeType as FeeType,\n restaurantsOperationsV1Operation_universal_d_PriceRange as PriceRange,\n restaurantsOperationsV1Operation_universal_d_MinOrderPriceType as MinOrderPriceType,\n restaurantsOperationsV1Operation_universal_d_MinOrderPriceRange as MinOrderPriceRange,\n restaurantsOperationsV1Operation_universal_d_ListAvailableTimeSlotsForDateRequest as ListAvailableTimeSlotsForDateRequest,\n restaurantsOperationsV1Operation_universal_d__Date as _Date,\n restaurantsOperationsV1Operation_universal_d_ListAvailableTimeSlotsForDateResponse as ListAvailableTimeSlotsForDateResponse,\n restaurantsOperationsV1Operation_universal_d_ListAvailableDatesInRangeRequest as ListAvailableDatesInRangeRequest,\n restaurantsOperationsV1Operation_universal_d_ListAvailableDatesInRangeResponse as ListAvailableDatesInRangeResponse,\n restaurantsOperationsV1Operation_universal_d_GetExpectedFulfillmentSelectionRequest as GetExpectedFulfillmentSelectionRequest,\n restaurantsOperationsV1Operation_universal_d_GetExpectedFulfillmentSelectionResponse as GetExpectedFulfillmentSelectionResponse,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n Empty$4 as Empty,\n SitePropertiesNotification$1 as SitePropertiesNotification,\n SitePropertiesEvent$1 as SitePropertiesEvent,\n Properties$1 as Properties,\n Categories$1 as Categories,\n Locale$2 as Locale,\n restaurantsOperationsV1Operation_universal_d_V4Address as V4Address,\n AddressHint$1 as AddressHint,\n PlacementType$1 as PlacementType,\n GeoCoordinates$1 as GeoCoordinates,\n BusinessSchedule$1 as BusinessSchedule,\n TimePeriod$6 as TimePeriod,\n restaurantsOperationsV1Operation_universal_d_V4DayOfWeek as V4DayOfWeek,\n SpecialHourPeriod$6 as SpecialHourPeriod,\n Multilingual$1 as Multilingual,\n SupportedLanguage$1 as SupportedLanguage,\n ResolutionMethod$1 as ResolutionMethod,\n ConsentPolicy$1 as ConsentPolicy,\n Translation$1 as Translation,\n ChangeContext$1 as ChangeContext,\n ChangeContextPayloadOneOf$1 as ChangeContextPayloadOneOf,\n PropertiesChange$1 as PropertiesChange,\n SiteCreated$1 as SiteCreated,\n SiteCloned$1 as SiteCloned,\n restaurantsOperationsV1Operation_universal_d_createOperation as createOperation,\n restaurantsOperationsV1Operation_universal_d_getOperation as getOperation,\n restaurantsOperationsV1Operation_universal_d_updateOperation as updateOperation,\n restaurantsOperationsV1Operation_universal_d_UpdateOperation as UpdateOperation,\n restaurantsOperationsV1Operation_universal_d_UpdateOperationOptions as UpdateOperationOptions,\n restaurantsOperationsV1Operation_universal_d_deleteOperation as deleteOperation,\n restaurantsOperationsV1Operation_universal_d_queryOperation as queryOperation,\n restaurantsOperationsV1Operation_universal_d_OperationsQueryResult as OperationsQueryResult,\n restaurantsOperationsV1Operation_universal_d_OperationsQueryBuilder as OperationsQueryBuilder,\n restaurantsOperationsV1Operation_universal_d_listOperations as listOperations,\n restaurantsOperationsV1Operation_universal_d_listAvailableFulfillmentOptions as listAvailableFulfillmentOptions,\n restaurantsOperationsV1Operation_universal_d_ListAvailableFulfillmentOptions as ListAvailableFulfillmentOptions,\n restaurantsOperationsV1Operation_universal_d_listFirstAvailableTimeSlotForFulfillmentTypes as listFirstAvailableTimeSlotForFulfillmentTypes,\n restaurantsOperationsV1Operation_universal_d_ListFirstAvailableTimeSlotForFulfillmentTypesOptions as ListFirstAvailableTimeSlotForFulfillmentTypesOptions,\n restaurantsOperationsV1Operation_universal_d_listAvailableTimeSlotsForDate as listAvailableTimeSlotsForDate,\n restaurantsOperationsV1Operation_universal_d_ListAvailableTimeSlotsForDateOptions as ListAvailableTimeSlotsForDateOptions,\n restaurantsOperationsV1Operation_universal_d_listAvailableDatesInRange as listAvailableDatesInRange,\n restaurantsOperationsV1Operation_universal_d_ListAvailableDatesInRangeOptions as ListAvailableDatesInRangeOptions,\n restaurantsOperationsV1Operation_universal_d_getExpectedFulfillmentSelection as getExpectedFulfillmentSelection,\n restaurantsOperationsV1Operation_universal_d_GetExpectedFulfillmentSelectionOptions as GetExpectedFulfillmentSelectionOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** `FulfillmentMethod` is the main entity of `FulfillmentMethodsService' and represents the way of a restaurant to provide orders to its customers. */\n interface FulfillmentMethod$1 extends FulfillmentMethodMethodOptionsOneOf {\n /** Data specific for pickup fulfillment method. */\n pickupOptions?: PickupInfo$2;\n /** Data specific for delivery fulfillment method. */\n deliveryOptions?: DeliveryInfo$1;\n /**\n * The ID of the fulfillment method.\n * @readonly\n */\n _id?: string | null;\n /**\n * The current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Timestamp at which the fulfillment method was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Timestamp at which the fulfillment method was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** The fulfillment method type. */\n type?: FulfillmentMethodType$1;\n /** The minimum order price to qualify for using this fulfillment method. */\n minimumOrderAmount?: string | null;\n /** The fulfillment method name. */\n name?: string | null;\n /** An indication of whether the fulfillment method is enabled or not. */\n enabled?: boolean | null;\n /** The fee for using this fulfillment method. */\n fee?: string | null;\n /** The availability of this fulfillment method. */\n availability?: Availability$5;\n }\n /** @oneof */\n interface FulfillmentMethodMethodOptionsOneOf {\n /** Data specific for pickup fulfillment method. */\n pickupOptions?: PickupInfo$2;\n /** Data specific for delivery fulfillment method. */\n deliveryOptions?: DeliveryInfo$1;\n }\n enum FulfillmentMethodType$1 {\n /** Missing type due to an error. */\n UNKNOWN_FULFILLMENT_TYPE = \"UNKNOWN_FULFILLMENT_TYPE\",\n /** Pickup fulfillment method - refers to the customer picking up the order from the restaurant. */\n PICKUP = \"PICKUP\",\n /** Delivery fulfillment method - refers to the restaurant or someone on behalf of the restaurant delivering the order to the customer. */\n DELIVERY = \"DELIVERY\"\n }\n interface PickupInfo$2 {\n /** Instructions for the pickup. */\n instructions?: string | null;\n /**\n * Pickup address.\n * The address of the restaurant will be used.\n * @readonly\n */\n address?: CommonAddress;\n }\n /** Physical address */\n interface CommonAddress extends CommonAddressStreetOneOf {\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. 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$4;\n }\n /** @oneof */\n interface CommonAddressStreetOneOf {\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$4 {\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType$1;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 DeliveryInfo$1 {\n /** The estimated delivery time in minutes. */\n deliveryTimeInMinutes?: number | null;\n /**\n * Threshold for offering free delivery.\n * If order price exceeds this threshold, the delivery fee is waived.\n */\n freeDeliveryThreshold?: string | null;\n /** The delivery area that is supported by this delivery fulfillment method. */\n deliveryArea?: DeliveryArea;\n }\n interface DeliveryArea extends DeliveryAreaAreaOptionsOneOf {\n /** Data specific for radius delivery area. */\n radiusOptions?: Radius;\n /** Data specific for postal code delivery area. */\n postalCodeOptions?: PostalCode;\n /** Data specific for custom delivery area. */\n customOptions?: CustomArea;\n /** The type of the delivery area. */\n type?: Type$4;\n }\n /** @oneof */\n interface DeliveryAreaAreaOptionsOneOf {\n /** Data specific for radius delivery area. */\n radiusOptions?: Radius;\n /** Data specific for postal code delivery area. */\n postalCodeOptions?: PostalCode;\n /** Data specific for custom delivery area. */\n customOptions?: CustomArea;\n }\n enum Type$4 {\n /** Unknown delivery area type. */\n UNKNOWN_DELIVERY_AREA = \"UNKNOWN_DELIVERY_AREA\",\n /**\n * Delivery area that is defined by a radius around an address.\n * The address of the restaurant will be used.\n */\n RADIUS = \"RADIUS\",\n /** Delivery area that is defined by a list of postal codes. */\n POSTAL_CODE = \"POSTAL_CODE\",\n /** Delivery area that is defined by a custom polygon. */\n CUSTOM = \"CUSTOM\"\n }\n interface Radius {\n /**\n * The radius value.\n * The unit of the radius will be given in the `unit` field.\n */\n value?: string | null;\n /**\n * The address of the center of the circle.\n * @readonly\n */\n centerPointAddress?: CommonAddress;\n /** The distance unit of the radius. */\n unit?: Unit;\n }\n enum Unit {\n /** Unknown unit. */\n UNKNOWN_UNIT = \"UNKNOWN_UNIT\",\n /** Miles. */\n MILES = \"MILES\",\n /** Kilometers. */\n KILOMETERS = \"KILOMETERS\"\n }\n interface PostalCode {\n /** The postal code of the delivery area. */\n postalCode?: string | null;\n /**\n * The country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n * @readonly\n */\n countryCode?: string | null;\n /**\n * A list of postal codes and postal code regexes. List of postal codes and postal code regexes. Examples: 10001, 10002 or 1000*\n * A postal code regex will enable you to define a range of postal codes using an asterisk (*).\n * For example, in order to include the postal codes in the range of 10001-10009, 1000* can be used.\n */\n postalCodes?: string[] | null;\n }\n interface CustomArea {\n /** Geocodes of the polygon that defines the delivery area. */\n geocodes?: AddressLocation$4[];\n }\n interface Availability$5 {\n /** A list of availability times for the days of the week. */\n availableTimes?: DayOfWeekAvailability[];\n /**\n * A list of availability exception.\n * An availability exception is some availability for a specific time, that is different from the usual availability defined in `available_times`. The availability exception overrides the availability defined in `available_times`.\n * For example, a restaurants may decide to disable the availability for a specific time range, or to enable the availability for a specific time range that is not available in the usual availability.\n */\n exceptions?: AvailabilityException[];\n /**\n * The timezone in which the availability times are given.\n * @readonly\n */\n timeZone?: string | null;\n }\n interface DayOfWeekAvailability {\n /** The day of week this availability relates to. */\n dayOfWeek?: EntitiesDayOfWeek;\n /** A list of time ranges during which the fulfillment should be available. */\n timeRanges?: TimeOfDayRange[];\n }\n enum EntitiesDayOfWeek {\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 {\n /** The start time in time of day representation. */\n startTime?: TimeOfDay;\n /** The end time in time of day representation. */\n endTime?: TimeOfDay;\n }\n interface TimeOfDay {\n /** Hours (0-23) */\n hours?: number;\n /** Minutes (0-59) */\n minutes?: number;\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 interface InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {\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$1;\n /** Invalidate by URI path */\n uri?: URI$1;\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$1 {\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$1;\n /** Invalidate by URI path */\n uri?: URI$1;\n }\n interface App$1 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$1 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$1 {\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 CreateFulfillmentMethodRequest$1 {\n /** Fulfillment method to create. */\n fulfillmentMethod: FulfillmentMethod$1;\n }\n interface CreateFulfillmentMethodResponse$1 {\n /** The created fulfillment method. */\n fulfillmentMethod?: FulfillmentMethod$1;\n }\n interface GetFulfillmentMethodRequest$1 {\n /** The ID of the fulfillment method to retrieve. */\n fulfillmentMethodId: string;\n }\n interface GetFulfillmentMethodResponse$1 {\n /** The retrieved fulfillment method. */\n fulfillmentMethod?: FulfillmentMethod$1;\n }\n interface UpdateFulfillmentMethodRequest$1 {\n /**\n * Fulfillment method to update.\n * The fulfillment method update may be partial with the use of `field_mask`.\n */\n fulfillmentMethod: FulfillmentMethod$1;\n /**\n * Field mask of the fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateFulfillmentMethodResponse$1 {\n /** The updated fulfillment method. */\n fulfillmentMethod?: FulfillmentMethod$1;\n }\n interface DeleteFulfillmentMethodRequest$1 {\n /** The ID of the fulfillment method to delete. */\n fulfillmentMethodId: string;\n }\n interface DeleteFulfillmentMethodResponse$1 {\n }\n interface QueryFulfillmentMethodsRequest {\n /** The query by which to select fulfillment methods. */\n query?: CursorQuery;\n /** Projection mask of the fields to return. */\n projectionMask?: string[];\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$1[];\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$1 {\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$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 QueryFulfillmentMethodsResponse {\n /** The retrieved fulfillment methods. */\n fulfillmentMethods?: FulfillmentMethod$1[];\n /** The metadata of the paginated results. */\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$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 ListFulfillmentMethodsRequest$1 {\n /** The address by which to filter delivery fulfillment methods. */\n address?: CommonAddress;\n }\n interface ListFulfillmentMethodsResponse$1 {\n /** The retrieved fulfillment methods. */\n fulfillmentMethods?: FulfillmentMethod$1[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata;\n }\n interface ListAvailableFulfillmentMethodsForAddressRequest {\n /** The address by which to filter delivery fulfillment methods. */\n address?: CommonAddress;\n /** Cursor paging */\n cursorPaging?: CursorPaging$1;\n /** If provided, only fulfillment methods with the given IDs will be returned. */\n fulfillmentMethodIds?: string[];\n }\n interface ListAvailableFulfillmentMethodsForAddressResponse {\n /** The retrieved fulfillment methods. */\n fulfillmentMethods?: FulfillmentMethod$1[];\n /** The metadata of the paginated results. */\n pagingMetadata?: CursorPagingMetadata;\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 /** Set of properties that were updated - corresponds to the fields in \"properties\". */\n fields?: string[];\n /** Updated properties. */\n properties?: Properties;\n }\n interface Properties {\n /** Site categories. */\n categories?: Categories;\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$3;\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$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$3 {\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$5[];\n /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */\n specialHourPeriod?: SpecialHourPeriod$5[];\n }\n /** Weekly recurring time periods when the business is regularly open or the service is available. */\n interface TimePeriod$5 {\n /** Day of the week the period starts on. */\n openDay?: DayOfWeek$5;\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$5;\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$5 {\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$5 {\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$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;\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 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. */\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\n }\n /**\n * Creates a new fulfillment method.\n *\n * Regardless of the value specified in `fulfillment_method.availability.time_zone`, the timezone will be derived from the site properties.\n * @param fulfillmentMethod - Fulfillment method to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillmentMethod\n * @requiredField fulfillmentMethod.availability.timeZone\n * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea\n * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea.postalCodeOptions.countryCode\n * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea.radiusOptions.centerPointAddress\n * @requiredField fulfillmentMethod.deliveryOptions.deliveryArea.radiusOptions.value\n * @requiredField fulfillmentMethod.pickupOptions.address\n * @adminMethod\n * @returns The created fulfillment method.\n */\n function createFulfillmentMethod$1(fulfillmentMethod: FulfillmentMethod$1): Promise;\n /**\n * Retrieves a fulfillment method.\n * @param fulfillmentMethodId - The ID of the fulfillment method to retrieve.\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillmentMethodId\n * @returns The retrieved fulfillment method.\n */\n function getFulfillmentMethod$1(fulfillmentMethodId: string): Promise;\n /**\n * Updates a fulfillment method.\n *\n * Each time the fulfillment method is updated, revision increments by 1. The existing revision must be included when updating the fulfillment method. This ensures you're working with the latest fulfillment method information, and it prevents unintended overwrites.\n * @param _id - The ID of the fulfillment method.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField fulfillmentMethod\n * @requiredField fulfillmentMethod.revision\n * @adminMethod\n * @returns The updated fulfillment method.\n */\n function updateFulfillmentMethod$1(_id: string | null, fulfillmentMethod: UpdateFulfillmentMethod$1, options?: UpdateFulfillmentMethodOptions$1): Promise;\n interface UpdateFulfillmentMethod$1 {\n /** Data specific for pickup fulfillment method. */\n pickupOptions?: PickupInfo$2;\n /** Data specific for delivery fulfillment method. */\n deliveryOptions?: DeliveryInfo$1;\n /**\n * The ID of the fulfillment method.\n * @readonly\n */\n _id?: string | null;\n /**\n * The current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Timestamp at which the fulfillment method was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Timestamp at which the fulfillment method was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** The fulfillment method type. */\n type?: FulfillmentMethodType$1;\n /** The minimum order price to qualify for using this fulfillment method. */\n minimumOrderAmount?: string | null;\n /** The fulfillment method name. */\n name?: string | null;\n /** An indication of whether the fulfillment method is enabled or not. */\n enabled?: boolean | null;\n /** The fee for using this fulfillment method. */\n fee?: string | null;\n /** The availability of this fulfillment method. */\n availability?: Availability$5;\n }\n interface UpdateFulfillmentMethodOptions$1 {\n /**\n * Field mask of the fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes a fulfillment method.\n * @param fulfillmentMethodId - The ID of the fulfillment method to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillmentMethodId\n * @adminMethod\n */\n function deleteFulfillmentMethod$1(fulfillmentMethodId: string): Promise;\n /**\n * Retrieves a list of fulfillment methods by a given query.\n *\n * To learn how to query fulfillment methods, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n *\n * Up to 100 fulfillment methods can be returned per request.\n * @internal\n * @documentationMaturity preview\n */\n function queryFulfillmentMethods(options?: QueryFulfillmentMethodsOptions): FulfillmentMethodsQueryBuilder;\n interface QueryFulfillmentMethodsOptions {\n /** Projection mask of the fields to return. */\n projectionMask?: string[] | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface FulfillmentMethodsQueryResult extends QueryCursorResult {\n items: FulfillmentMethod$1[];\n query: FulfillmentMethodsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface FulfillmentMethodsQueryBuilder {\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) => FulfillmentMethodsQueryBuilder;\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) => FulfillmentMethodsQueryBuilder;\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) => FulfillmentMethodsQueryBuilder;\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[]) => FulfillmentMethodsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id', value: any) => FulfillmentMethodsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id', value: boolean) => FulfillmentMethodsQueryBuilder;\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'>) => FulfillmentMethodsQueryBuilder;\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'>) => FulfillmentMethodsQueryBuilder;\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) => FulfillmentMethodsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => FulfillmentMethodsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves a list of fulfillment methods.\n *\n * When an address is not provided in the input, our system retrieves a list encompassing all types of fulfillment methods.\n *\n * Conversely, if an address is given, the response includes non-delivery fulfillment methods 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 *\n * Up to 100 fulfillment methods can be returned.\n *\n * TODO: add support for pagination in the request since it's given in the response, and add docs reference regarding how to do the pagination\n * @internal\n * @documentationMaturity preview\n */\n function listFulfillmentMethods$1(options?: ListFulfillmentMethodsOptions$1): Promise;\n interface ListFulfillmentMethodsOptions$1 {\n /** The address by which to filter delivery fulfillment methods. */\n address?: CommonAddress;\n }\n /**\n * Retrieves a list of fulfillment methods available for a given address.\n *\n * The response includes non-delivery fulfillment methods 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 *\n * Up to 100 fulfillment methods can be returned per request.\n * @internal\n * @documentationMaturity preview\n */\n function listAvailableFulfillmentMethodsForAddress(options?: ListAvailableFulfillmentMethodsForAddressOptions): Promise;\n interface ListAvailableFulfillmentMethodsForAddressOptions {\n /** The address by which to filter delivery fulfillment methods. */\n address?: CommonAddress;\n /** Cursor paging */\n cursorPaging?: CursorPaging$1;\n /** If provided, only fulfillment methods with the given IDs will be returned. */\n fulfillmentMethodIds?: string[];\n }\n \n const restaurantsV1FulfillmentMethod_universal_d___debug: typeof __debug;\n type restaurantsV1FulfillmentMethod_universal_d_FulfillmentMethodMethodOptionsOneOf = FulfillmentMethodMethodOptionsOneOf;\n type restaurantsV1FulfillmentMethod_universal_d_CommonAddress = CommonAddress;\n type restaurantsV1FulfillmentMethod_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type restaurantsV1FulfillmentMethod_universal_d_DeliveryArea = DeliveryArea;\n type restaurantsV1FulfillmentMethod_universal_d_DeliveryAreaAreaOptionsOneOf = DeliveryAreaAreaOptionsOneOf;\n type restaurantsV1FulfillmentMethod_universal_d_Radius = Radius;\n type restaurantsV1FulfillmentMethod_universal_d_Unit = Unit;\n const restaurantsV1FulfillmentMethod_universal_d_Unit: typeof Unit;\n type restaurantsV1FulfillmentMethod_universal_d_PostalCode = PostalCode;\n type restaurantsV1FulfillmentMethod_universal_d_CustomArea = CustomArea;\n type restaurantsV1FulfillmentMethod_universal_d_DayOfWeekAvailability = DayOfWeekAvailability;\n type restaurantsV1FulfillmentMethod_universal_d_EntitiesDayOfWeek = EntitiesDayOfWeek;\n const restaurantsV1FulfillmentMethod_universal_d_EntitiesDayOfWeek: typeof EntitiesDayOfWeek;\n type restaurantsV1FulfillmentMethod_universal_d_TimeOfDayRange = TimeOfDayRange;\n type restaurantsV1FulfillmentMethod_universal_d_TimeOfDay = TimeOfDay;\n type restaurantsV1FulfillmentMethod_universal_d_AvailabilityException = AvailabilityException;\n type restaurantsV1FulfillmentMethod_universal_d_QueryFulfillmentMethodsRequest = QueryFulfillmentMethodsRequest;\n type restaurantsV1FulfillmentMethod_universal_d_CursorQuery = CursorQuery;\n type restaurantsV1FulfillmentMethod_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type restaurantsV1FulfillmentMethod_universal_d_QueryFulfillmentMethodsResponse = QueryFulfillmentMethodsResponse;\n type restaurantsV1FulfillmentMethod_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type restaurantsV1FulfillmentMethod_universal_d_ListAvailableFulfillmentMethodsForAddressRequest = ListAvailableFulfillmentMethodsForAddressRequest;\n type restaurantsV1FulfillmentMethod_universal_d_ListAvailableFulfillmentMethodsForAddressResponse = ListAvailableFulfillmentMethodsForAddressResponse;\n type restaurantsV1FulfillmentMethod_universal_d_SitePropertiesNotification = SitePropertiesNotification;\n type restaurantsV1FulfillmentMethod_universal_d_SitePropertiesEvent = SitePropertiesEvent;\n type restaurantsV1FulfillmentMethod_universal_d_Properties = Properties;\n type restaurantsV1FulfillmentMethod_universal_d_Categories = Categories;\n type restaurantsV1FulfillmentMethod_universal_d_AddressHint = AddressHint;\n type restaurantsV1FulfillmentMethod_universal_d_PlacementType = PlacementType;\n const restaurantsV1FulfillmentMethod_universal_d_PlacementType: typeof PlacementType;\n type restaurantsV1FulfillmentMethod_universal_d_GeoCoordinates = GeoCoordinates;\n type restaurantsV1FulfillmentMethod_universal_d_BusinessSchedule = BusinessSchedule;\n type restaurantsV1FulfillmentMethod_universal_d_Multilingual = Multilingual;\n type restaurantsV1FulfillmentMethod_universal_d_SupportedLanguage = SupportedLanguage;\n type restaurantsV1FulfillmentMethod_universal_d_ResolutionMethod = ResolutionMethod;\n const restaurantsV1FulfillmentMethod_universal_d_ResolutionMethod: typeof ResolutionMethod;\n type restaurantsV1FulfillmentMethod_universal_d_ConsentPolicy = ConsentPolicy;\n type restaurantsV1FulfillmentMethod_universal_d_Translation = Translation;\n type restaurantsV1FulfillmentMethod_universal_d_ChangeContext = ChangeContext;\n type restaurantsV1FulfillmentMethod_universal_d_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;\n type restaurantsV1FulfillmentMethod_universal_d_PropertiesChange = PropertiesChange;\n type restaurantsV1FulfillmentMethod_universal_d_SiteCreated = SiteCreated;\n type restaurantsV1FulfillmentMethod_universal_d_SiteCloned = SiteCloned;\n const restaurantsV1FulfillmentMethod_universal_d_queryFulfillmentMethods: typeof queryFulfillmentMethods;\n type restaurantsV1FulfillmentMethod_universal_d_QueryFulfillmentMethodsOptions = QueryFulfillmentMethodsOptions;\n type restaurantsV1FulfillmentMethod_universal_d_FulfillmentMethodsQueryResult = FulfillmentMethodsQueryResult;\n type restaurantsV1FulfillmentMethod_universal_d_FulfillmentMethodsQueryBuilder = FulfillmentMethodsQueryBuilder;\n const restaurantsV1FulfillmentMethod_universal_d_listAvailableFulfillmentMethodsForAddress: typeof listAvailableFulfillmentMethodsForAddress;\n type restaurantsV1FulfillmentMethod_universal_d_ListAvailableFulfillmentMethodsForAddressOptions = ListAvailableFulfillmentMethodsForAddressOptions;\n namespace restaurantsV1FulfillmentMethod_universal_d {\n export {\n restaurantsV1FulfillmentMethod_universal_d___debug as __debug,\n FulfillmentMethod$1 as FulfillmentMethod,\n restaurantsV1FulfillmentMethod_universal_d_FulfillmentMethodMethodOptionsOneOf as FulfillmentMethodMethodOptionsOneOf,\n FulfillmentMethodType$1 as FulfillmentMethodType,\n PickupInfo$2 as PickupInfo,\n restaurantsV1FulfillmentMethod_universal_d_CommonAddress as CommonAddress,\n restaurantsV1FulfillmentMethod_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf,\n StreetAddress$3 as StreetAddress,\n AddressLocation$4 as AddressLocation,\n Subdivision$1 as Subdivision,\n SubdivisionType$1 as SubdivisionType,\n DeliveryInfo$1 as DeliveryInfo,\n restaurantsV1FulfillmentMethod_universal_d_DeliveryArea as DeliveryArea,\n restaurantsV1FulfillmentMethod_universal_d_DeliveryAreaAreaOptionsOneOf as DeliveryAreaAreaOptionsOneOf,\n Type$4 as Type,\n restaurantsV1FulfillmentMethod_universal_d_Radius as Radius,\n restaurantsV1FulfillmentMethod_universal_d_Unit as Unit,\n restaurantsV1FulfillmentMethod_universal_d_PostalCode as PostalCode,\n restaurantsV1FulfillmentMethod_universal_d_CustomArea as CustomArea,\n Availability$5 as Availability,\n restaurantsV1FulfillmentMethod_universal_d_DayOfWeekAvailability as DayOfWeekAvailability,\n restaurantsV1FulfillmentMethod_universal_d_EntitiesDayOfWeek as EntitiesDayOfWeek,\n restaurantsV1FulfillmentMethod_universal_d_TimeOfDayRange as TimeOfDayRange,\n restaurantsV1FulfillmentMethod_universal_d_TimeOfDay as TimeOfDay,\n restaurantsV1FulfillmentMethod_universal_d_AvailabilityException as AvailabilityException,\n InvalidateCache$1 as InvalidateCache,\n InvalidateCacheGetByOneOf$1 as InvalidateCacheGetByOneOf,\n App$1 as App,\n Page$1 as Page,\n URI$1 as URI,\n CreateFulfillmentMethodRequest$1 as CreateFulfillmentMethodRequest,\n CreateFulfillmentMethodResponse$1 as CreateFulfillmentMethodResponse,\n GetFulfillmentMethodRequest$1 as GetFulfillmentMethodRequest,\n GetFulfillmentMethodResponse$1 as GetFulfillmentMethodResponse,\n UpdateFulfillmentMethodRequest$1 as UpdateFulfillmentMethodRequest,\n UpdateFulfillmentMethodResponse$1 as UpdateFulfillmentMethodResponse,\n DeleteFulfillmentMethodRequest$1 as DeleteFulfillmentMethodRequest,\n DeleteFulfillmentMethodResponse$1 as DeleteFulfillmentMethodResponse,\n restaurantsV1FulfillmentMethod_universal_d_QueryFulfillmentMethodsRequest as QueryFulfillmentMethodsRequest,\n restaurantsV1FulfillmentMethod_universal_d_CursorQuery as CursorQuery,\n restaurantsV1FulfillmentMethod_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$1 as CursorPaging,\n restaurantsV1FulfillmentMethod_universal_d_QueryFulfillmentMethodsResponse as QueryFulfillmentMethodsResponse,\n restaurantsV1FulfillmentMethod_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n Cursors$1 as Cursors,\n ListFulfillmentMethodsRequest$1 as ListFulfillmentMethodsRequest,\n ListFulfillmentMethodsResponse$1 as ListFulfillmentMethodsResponse,\n restaurantsV1FulfillmentMethod_universal_d_ListAvailableFulfillmentMethodsForAddressRequest as ListAvailableFulfillmentMethodsForAddressRequest,\n restaurantsV1FulfillmentMethod_universal_d_ListAvailableFulfillmentMethodsForAddressResponse as ListAvailableFulfillmentMethodsForAddressResponse,\n restaurantsV1FulfillmentMethod_universal_d_SitePropertiesNotification as SitePropertiesNotification,\n restaurantsV1FulfillmentMethod_universal_d_SitePropertiesEvent as SitePropertiesEvent,\n restaurantsV1FulfillmentMethod_universal_d_Properties as Properties,\n restaurantsV1FulfillmentMethod_universal_d_Categories as Categories,\n Locale$1 as Locale,\n Address$3 as Address,\n restaurantsV1FulfillmentMethod_universal_d_AddressHint as AddressHint,\n restaurantsV1FulfillmentMethod_universal_d_PlacementType as PlacementType,\n restaurantsV1FulfillmentMethod_universal_d_GeoCoordinates as GeoCoordinates,\n restaurantsV1FulfillmentMethod_universal_d_BusinessSchedule as BusinessSchedule,\n TimePeriod$5 as TimePeriod,\n DayOfWeek$5 as DayOfWeek,\n SpecialHourPeriod$5 as SpecialHourPeriod,\n restaurantsV1FulfillmentMethod_universal_d_Multilingual as Multilingual,\n restaurantsV1FulfillmentMethod_universal_d_SupportedLanguage as SupportedLanguage,\n restaurantsV1FulfillmentMethod_universal_d_ResolutionMethod as ResolutionMethod,\n restaurantsV1FulfillmentMethod_universal_d_ConsentPolicy as ConsentPolicy,\n restaurantsV1FulfillmentMethod_universal_d_Translation as Translation,\n restaurantsV1FulfillmentMethod_universal_d_ChangeContext as ChangeContext,\n restaurantsV1FulfillmentMethod_universal_d_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf,\n restaurantsV1FulfillmentMethod_universal_d_PropertiesChange as PropertiesChange,\n restaurantsV1FulfillmentMethod_universal_d_SiteCreated as SiteCreated,\n restaurantsV1FulfillmentMethod_universal_d_SiteCloned as SiteCloned,\n Empty$3 as Empty,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n createFulfillmentMethod$1 as createFulfillmentMethod,\n getFulfillmentMethod$1 as getFulfillmentMethod,\n updateFulfillmentMethod$1 as updateFulfillmentMethod,\n UpdateFulfillmentMethod$1 as UpdateFulfillmentMethod,\n UpdateFulfillmentMethodOptions$1 as UpdateFulfillmentMethodOptions,\n deleteFulfillmentMethod$1 as deleteFulfillmentMethod,\n restaurantsV1FulfillmentMethod_universal_d_queryFulfillmentMethods as queryFulfillmentMethods,\n restaurantsV1FulfillmentMethod_universal_d_QueryFulfillmentMethodsOptions as QueryFulfillmentMethodsOptions,\n restaurantsV1FulfillmentMethod_universal_d_FulfillmentMethodsQueryResult as FulfillmentMethodsQueryResult,\n restaurantsV1FulfillmentMethod_universal_d_FulfillmentMethodsQueryBuilder as FulfillmentMethodsQueryBuilder,\n listFulfillmentMethods$1 as listFulfillmentMethods,\n ListFulfillmentMethodsOptions$1 as ListFulfillmentMethodsOptions,\n restaurantsV1FulfillmentMethod_universal_d_listAvailableFulfillmentMethodsForAddress as listAvailableFulfillmentMethodsForAddress,\n restaurantsV1FulfillmentMethod_universal_d_ListAvailableFulfillmentMethodsForAddressOptions as ListAvailableFulfillmentMethodsForAddressOptions,\n };\n }\n \n interface Tpa$1 {\n }\n interface ListAccountIdsRequest$1 {\n /** Instance ID. */\n instanceId: string;\n }\n interface ListAccountIdsResponse$1 {\n /** Account IDs. */\n accountIds?: string[];\n }\n interface BusinessStatusRequest {\n /** Instance ID. */\n instanceId: string;\n /** Account ID. */\n accountId: string;\n }\n interface BusinessStatusResponse {\n /** List of statue. */\n status?: BusinessStatus$1;\n /** The reason for the error in free text. */\n failureReasonMessage?: string | null;\n }\n /** Business Status. */\n enum BusinessStatus$1 {\n NONE = \"NONE\",\n READY = \"READY\",\n PENDING = \"PENDING\",\n ERROR = \"ERROR\",\n NOT_STARTED = \"NOT_STARTED\"\n }\n interface EstimateDeliveryRequest$1 extends EstimateDeliveryRequestDispatchTimeOneOf$1 {\n /** Estimated pickup time. */\n pickupTime?: Date | null;\n /** Estimated dropoff time. */\n dropoffTime?: Date | null;\n /** Instance ID. */\n instanceId: string;\n /** Account ID. */\n accountId: string;\n /** Delivery pickup address. */\n pickupAddress?: Address$2;\n /** Delivery dropoff address. */\n dropoffAddress?: Address$2;\n /** Unique identifier of the specific store that the delivery is for. */\n storeLocationId: string;\n /** The subtotal for all items in the order, excluding tax/tip. */\n orderTotal: Money$4;\n }\n /** @oneof */\n interface EstimateDeliveryRequestDispatchTimeOneOf$1 {\n /** Estimated pickup time. */\n pickupTime?: Date | null;\n /** Estimated dropoff time. */\n dropoffTime?: Date | null;\n }\n /** Physical address */\n interface Address$2 {\n /** Country code. */\n country?: string;\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;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Street name and number. */\n streetAddress?: StreetAddress$2;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** Coordinates of the physical address. */\n location?: AddressLocation$3;\n }\n interface StreetAddress$2 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation$3 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | 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$4 {\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 EstimateDeliveryResponse$1 {\n /** Optional. Used as reference to the estimate when creating a new order. */\n _id?: string | null;\n /** Amount that is charged for this delivery. */\n fee?: Money$4;\n /** Estimated pickup time. */\n promisedPickupTime?: Date | null;\n /** Estimated dropoff time. */\n promisedDropoffTime?: Date | null;\n }\n interface CreateDeliveryRequest$1 extends CreateDeliveryRequestDispatchTimeOneOf$1 {\n /** The requested time at which the order should be picked up. */\n pickupTime?: Date | null;\n /** The requested time at which the order should be delivered. */\n dropoffTime?: Date | null;\n /** Instance ID. */\n instanceId: string;\n /** Account ID. */\n accountId: string;\n /** Unique identifier of the specific store that the delivery is for. */\n storeLocationId: string;\n /** The name of the business where the order should be picked up from. */\n pickupBusinessName: string;\n /** Estimate ID. */\n estimateId?: string | null;\n /** Delivery pickup address. */\n pickupAddress: Address$2;\n /** Delivery dropoff address. */\n dropoffAddress: Address$2;\n /** Phone number of the store where the order should be picked up from. */\n pickupPhoneNumber: string;\n /** Customer details. */\n customer: Customer$2;\n /** Instructions for the courier at the pickup location. */\n pickupInstructions?: string | null;\n /** Instructions for the courier at the dropoff location. */\n dropoffInstructions?: string | null;\n /** Is contactless delivery. */\n contactlessDelivery?: boolean | null;\n /** Order ID. */\n orderId: string;\n /** The subtotal for all items in the order, excluding tax/tip. */\n orderTotal: Money$4;\n /** Amount that will be paid to the courier. */\n orderTip: Money$4;\n }\n /** @oneof */\n interface CreateDeliveryRequestDispatchTimeOneOf$1 {\n /** The requested time at which the order should be picked up. */\n pickupTime?: Date | null;\n /** The requested time at which the order should be delivered. */\n dropoffTime?: Date | null;\n }\n interface Customer$2 {\n /** First name. */\n firstName?: string;\n /** Last name. */\n lastName?: string;\n /** Phone number. */\n phoneNumber?: string;\n /** Email address. */\n email?: string;\n }\n interface CreateDeliveryResponse$1 {\n /** The vendor new order id */\n _id?: string;\n /** When a delivery is ready to be picked up. This is the start of the pickup window. */\n pickupWindowStartTime?: Date | null;\n /** When a delivery must be picked up by. This is the end of the pickup window. */\n pickupWindowEndTime?: Date | null;\n /** When a delivery is ready to be dropped off. This is the start of the dropoff window. */\n dropoffWindowStartTime?: Date | null;\n /** When a delivery must be dropped off by. This is the end of the dropoff window. */\n dropoffWindowEndTime?: Date | null;\n /** Amount that is charged for this delivery. */\n fee?: Money$4;\n }\n /**\n * Retrieves list of account belongs to given instance\n * @param instanceId - Instance ID.\n * @public\n * @documentationMaturity preview\n * @requiredField instanceId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function listAccountIds$1(instanceId: string): Promise;\n /**\n * Retrieves the delivery vendor business status\n * @param instanceId - Instance ID.\n * @public\n * @documentationMaturity preview\n * @requiredField instanceId\n * @requiredField options\n * @requiredField options.accountId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function businessStatus(instanceId: string, options: BusinessStatusOptions): Promise;\n interface BusinessStatusOptions {\n /** Account ID. */\n accountId: string;\n }\n /**\n * Retrieves an estimate of the delivery\n * @param instanceId - Instance ID.\n * @public\n * @documentationMaturity preview\n * @requiredField instanceId\n * @requiredField options.accountId\n * @requiredField options.orderTotal\n * @requiredField options.storeLocationId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function estimateDelivery$1(instanceId: string, options?: EstimateDeliveryOptions$1): Promise;\n interface EstimateDeliveryOptions$1 extends EstimateDeliveryRequestDispatchTimeOneOf$1 {\n /** Account ID. */\n accountId: string;\n /** Delivery pickup address. */\n pickupAddress?: Address$2;\n /** Delivery dropoff address. */\n dropoffAddress?: Address$2;\n /** Estimated pickup time. */\n pickupTime?: Date | null;\n /** Estimated dropoff time. */\n dropoffTime?: Date | null;\n /** Unique identifier of the specific store that the delivery is for. */\n storeLocationId: string;\n /** The subtotal for all items in the order, excluding tax/tip. */\n orderTotal: Money$4;\n }\n /**\n * Creates a new delivery order\n * @param instanceId - Instance ID.\n * @public\n * @documentationMaturity preview\n * @requiredField instanceId\n * @requiredField options.accountId\n * @requiredField options.customer\n * @requiredField options.customer.email\n * @requiredField options.customer.firstName\n * @requiredField options.customer.lastName\n * @requiredField options.customer.phoneNumber\n * @requiredField options.dropoffAddress\n * @requiredField options.orderId\n * @requiredField options.orderTip\n * @requiredField options.orderTotal\n * @requiredField options.pickupAddress\n * @requiredField options.pickupBusinessName\n * @requiredField options.pickupPhoneNumber\n * @requiredField options.storeLocationId\n * @permissionId WIX_RESTAURANTS.WRITE_LOCAL_DELIVERY\n * @adminMethod\n */\n function createDelivery$1(instanceId: string, options?: CreateDeliveryOptions$1): Promise;\n interface CreateDeliveryOptions$1 extends CreateDeliveryRequestDispatchTimeOneOf$1 {\n /** Account ID. */\n accountId: string;\n /** Unique identifier of the specific store that the delivery is for. */\n storeLocationId: string;\n /** The name of the business where the order should be picked up from. */\n pickupBusinessName: string;\n /** Estimate ID. */\n estimateId?: string | null;\n /** The requested time at which the order should be picked up. */\n pickupTime?: Date | null;\n /** The requested time at which the order should be delivered. */\n dropoffTime?: Date | null;\n /** Delivery pickup address. */\n pickupAddress: Address$2;\n /** Delivery dropoff address. */\n dropoffAddress: Address$2;\n /** Phone number of the store where the order should be picked up from. */\n pickupPhoneNumber: string;\n /** Customer details. */\n customer: Customer$2;\n /** Instructions for the courier at the pickup location. */\n pickupInstructions?: string | null;\n /** Instructions for the courier at the dropoff location. */\n dropoffInstructions?: string | null;\n /** Is contactless delivery. */\n contactlessDelivery?: boolean | null;\n /** Order ID. */\n orderId: string;\n /** The subtotal for all items in the order, excluding tax/tip. */\n orderTotal: Money$4;\n /** Amount that will be paid to the courier. */\n orderTip: Money$4;\n }\n \n type localdeliverySpiV1Tpa_universal_d_BusinessStatusRequest = BusinessStatusRequest;\n type localdeliverySpiV1Tpa_universal_d_BusinessStatusResponse = BusinessStatusResponse;\n const localdeliverySpiV1Tpa_universal_d_businessStatus: typeof businessStatus;\n type localdeliverySpiV1Tpa_universal_d_BusinessStatusOptions = BusinessStatusOptions;\n namespace localdeliverySpiV1Tpa_universal_d {\n export {\n Tpa$1 as Tpa,\n ListAccountIdsRequest$1 as ListAccountIdsRequest,\n ListAccountIdsResponse$1 as ListAccountIdsResponse,\n localdeliverySpiV1Tpa_universal_d_BusinessStatusRequest as BusinessStatusRequest,\n localdeliverySpiV1Tpa_universal_d_BusinessStatusResponse as BusinessStatusResponse,\n BusinessStatus$1 as BusinessStatus,\n EstimateDeliveryRequest$1 as EstimateDeliveryRequest,\n EstimateDeliveryRequestDispatchTimeOneOf$1 as EstimateDeliveryRequestDispatchTimeOneOf,\n Address$2 as Address,\n StreetAddress$2 as StreetAddress,\n AddressLocation$3 as AddressLocation,\n Money$4 as Money,\n EstimateDeliveryResponse$1 as EstimateDeliveryResponse,\n CreateDeliveryRequest$1 as CreateDeliveryRequest,\n CreateDeliveryRequestDispatchTimeOneOf$1 as CreateDeliveryRequestDispatchTimeOneOf,\n Customer$2 as Customer,\n CreateDeliveryResponse$1 as CreateDeliveryResponse,\n listAccountIds$1 as listAccountIds,\n localdeliverySpiV1Tpa_universal_d_businessStatus as businessStatus,\n localdeliverySpiV1Tpa_universal_d_BusinessStatusOptions as BusinessStatusOptions,\n estimateDelivery$1 as estimateDelivery,\n EstimateDeliveryOptions$1 as EstimateDeliveryOptions,\n createDelivery$1 as createDelivery,\n CreateDeliveryOptions$1 as CreateDeliveryOptions,\n };\n }\n \n interface Tpa {\n appDefId?: string;\n name?: string;\n businessStatus?: BusinessStatus;\n errorReason?: string;\n }\n enum BusinessStatus {\n NONE = \"NONE\",\n READY = \"READY\",\n PENDING = \"PENDING\",\n ERROR = \"ERROR\",\n NOT_STARTED = \"NOT_STARTED\"\n }\n interface ListAccountIdsRequest {\n appDefId: string;\n }\n interface ListAccountIdsResponse {\n accountIds?: string[];\n }\n interface ListAppDefIdsRequest {\n }\n interface ListAppDefIdsResponse {\n appDefIds?: string[];\n }\n interface GetBusinessStatusRequest {\n appDefId: string;\n accountId: string;\n }\n interface GetBusinessStatusResponse {\n status?: BusinessStatus;\n failureReasonMessage?: string | null;\n }\n interface GetRegistrationUrlRequest {\n appDefId: string;\n }\n interface GetRegistrationUrlResponse {\n url?: string;\n }\n interface EstimateDeliveryRequest extends EstimateDeliveryRequestDispatchTimeOneOf {\n pickupTime?: Date | null;\n dropoffTime?: Date | null;\n appDefId: string;\n accountId: string;\n pickupAddress?: Address$1;\n dropoffAddress?: Address$1;\n storeLocationId: string;\n orderTotal: Money$3;\n }\n /** @oneof */\n interface EstimateDeliveryRequestDispatchTimeOneOf {\n pickupTime?: Date | null;\n dropoffTime?: Date | null;\n }\n /** Physical address */\n interface Address$1 {\n /** Country code. */\n country?: string;\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;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Street name and number. */\n streetAddress?: StreetAddress$1;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** Coordinates of the physical address. */\n location?: AddressLocation$2;\n }\n interface StreetAddress$1 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation$2 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | 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$3 {\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 EstimateDeliveryResponse {\n /** Optional. Used as reference to the estimate when creating a new order */\n _id?: string | null;\n /** Delivery fee */\n fee?: Money$3;\n promisedPickupTime?: Date | null;\n promisedDropoffTime?: Date | null;\n }\n interface CreateDeliveryRequest extends CreateDeliveryRequestDispatchTimeOneOf {\n pickupTime?: Date | null;\n dropoffTime?: Date | null;\n appDefId: string;\n accountId: string;\n storeLocationId: string;\n pickupBusinessName: string;\n pickupAddress: Address$1;\n dropoffAddress: Address$1;\n estimateId?: string | null;\n pickupPhoneNumber: string;\n customer: Customer$1;\n pickupInstructions?: string | null;\n dropoffInstructions?: string | null;\n contactlessDelivery?: boolean | null;\n orderId: string;\n orderTotal: Money$3;\n orderTip: Money$3;\n }\n /** @oneof */\n interface CreateDeliveryRequestDispatchTimeOneOf {\n pickupTime?: Date | null;\n dropoffTime?: Date | null;\n }\n interface Customer$1 {\n firstName?: string;\n lastName?: string;\n phoneNumber?: string;\n email?: string;\n }\n interface CreateDeliveryResponse {\n /** The vendor new order id */\n _id?: string;\n /** Status of the order creation call */\n pickupWindowStartTime?: Date | null;\n pickupWindowEndTime?: Date | null;\n dropoffWindowStartTime?: Date | null;\n dropoffWindowEndTime?: Date | null;\n fee?: Money$3;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField appDefId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function listAccountIds(appDefId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function listAppDefIds(): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField appDefId\n * @requiredField options\n * @requiredField options.accountId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function getBusinessStatus(appDefId: string, options: GetBusinessStatusOptions): Promise;\n interface GetBusinessStatusOptions {\n accountId: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField appDefId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function getRegistrationUrl(appDefId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField appDefId\n * @requiredField options.accountId\n * @requiredField options.orderTotal\n * @requiredField options.storeLocationId\n * @permissionId WIX_RESTAURANTS.READ_LOCAL_DELIVERY\n */\n function estimateDelivery(appDefId: string, options?: EstimateDeliveryOptions): Promise;\n interface EstimateDeliveryOptions extends EstimateDeliveryRequestDispatchTimeOneOf {\n accountId: string;\n pickupAddress?: Address$1;\n dropoffAddress?: Address$1;\n pickupTime?: Date | null;\n dropoffTime?: Date | null;\n storeLocationId: string;\n orderTotal: Money$3;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField appDefId\n * @requiredField options.accountId\n * @requiredField options.customer\n * @requiredField options.customer.email\n * @requiredField options.customer.firstName\n * @requiredField options.customer.lastName\n * @requiredField options.customer.phoneNumber\n * @requiredField options.dropoffAddress\n * @requiredField options.orderId\n * @requiredField options.orderTip\n * @requiredField options.orderTotal\n * @requiredField options.pickupAddress\n * @requiredField options.pickupBusinessName\n * @requiredField options.pickupPhoneNumber\n * @requiredField options.storeLocationId\n * @permissionId WIX_RESTAURANTS.WRITE_LOCAL_DELIVERY\n * @adminMethod\n */\n function createDelivery(appDefId: string, options?: CreateDeliveryOptions): Promise;\n interface CreateDeliveryOptions extends CreateDeliveryRequestDispatchTimeOneOf {\n accountId: string;\n storeLocationId: string;\n pickupBusinessName: string;\n pickupAddress: Address$1;\n dropoffAddress: Address$1;\n pickupTime?: Date | null;\n dropoffTime?: Date | null;\n estimateId?: string | null;\n pickupPhoneNumber: string;\n customer: Customer$1;\n pickupInstructions?: string | null;\n dropoffInstructions?: string | null;\n contactlessDelivery?: boolean | null;\n orderId: string;\n orderTotal: Money$3;\n orderTip: Money$3;\n }\n \n type localdeliveryV1Tpa_universal_d_Tpa = Tpa;\n type localdeliveryV1Tpa_universal_d_BusinessStatus = BusinessStatus;\n const localdeliveryV1Tpa_universal_d_BusinessStatus: typeof BusinessStatus;\n type localdeliveryV1Tpa_universal_d_ListAccountIdsRequest = ListAccountIdsRequest;\n type localdeliveryV1Tpa_universal_d_ListAccountIdsResponse = ListAccountIdsResponse;\n type localdeliveryV1Tpa_universal_d_ListAppDefIdsRequest = ListAppDefIdsRequest;\n type localdeliveryV1Tpa_universal_d_ListAppDefIdsResponse = ListAppDefIdsResponse;\n type localdeliveryV1Tpa_universal_d_GetBusinessStatusRequest = GetBusinessStatusRequest;\n type localdeliveryV1Tpa_universal_d_GetBusinessStatusResponse = GetBusinessStatusResponse;\n type localdeliveryV1Tpa_universal_d_GetRegistrationUrlRequest = GetRegistrationUrlRequest;\n type localdeliveryV1Tpa_universal_d_GetRegistrationUrlResponse = GetRegistrationUrlResponse;\n type localdeliveryV1Tpa_universal_d_EstimateDeliveryRequest = EstimateDeliveryRequest;\n type localdeliveryV1Tpa_universal_d_EstimateDeliveryRequestDispatchTimeOneOf = EstimateDeliveryRequestDispatchTimeOneOf;\n type localdeliveryV1Tpa_universal_d_EstimateDeliveryResponse = EstimateDeliveryResponse;\n type localdeliveryV1Tpa_universal_d_CreateDeliveryRequest = CreateDeliveryRequest;\n type localdeliveryV1Tpa_universal_d_CreateDeliveryRequestDispatchTimeOneOf = CreateDeliveryRequestDispatchTimeOneOf;\n type localdeliveryV1Tpa_universal_d_CreateDeliveryResponse = CreateDeliveryResponse;\n const localdeliveryV1Tpa_universal_d_listAccountIds: typeof listAccountIds;\n const localdeliveryV1Tpa_universal_d_listAppDefIds: typeof listAppDefIds;\n const localdeliveryV1Tpa_universal_d_getBusinessStatus: typeof getBusinessStatus;\n type localdeliveryV1Tpa_universal_d_GetBusinessStatusOptions = GetBusinessStatusOptions;\n const localdeliveryV1Tpa_universal_d_getRegistrationUrl: typeof getRegistrationUrl;\n const localdeliveryV1Tpa_universal_d_estimateDelivery: typeof estimateDelivery;\n type localdeliveryV1Tpa_universal_d_EstimateDeliveryOptions = EstimateDeliveryOptions;\n const localdeliveryV1Tpa_universal_d_createDelivery: typeof createDelivery;\n type localdeliveryV1Tpa_universal_d_CreateDeliveryOptions = CreateDeliveryOptions;\n namespace localdeliveryV1Tpa_universal_d {\n export {\n localdeliveryV1Tpa_universal_d_Tpa as Tpa,\n localdeliveryV1Tpa_universal_d_BusinessStatus as BusinessStatus,\n localdeliveryV1Tpa_universal_d_ListAccountIdsRequest as ListAccountIdsRequest,\n localdeliveryV1Tpa_universal_d_ListAccountIdsResponse as ListAccountIdsResponse,\n localdeliveryV1Tpa_universal_d_ListAppDefIdsRequest as ListAppDefIdsRequest,\n localdeliveryV1Tpa_universal_d_ListAppDefIdsResponse as ListAppDefIdsResponse,\n localdeliveryV1Tpa_universal_d_GetBusinessStatusRequest as GetBusinessStatusRequest,\n localdeliveryV1Tpa_universal_d_GetBusinessStatusResponse as GetBusinessStatusResponse,\n localdeliveryV1Tpa_universal_d_GetRegistrationUrlRequest as GetRegistrationUrlRequest,\n localdeliveryV1Tpa_universal_d_GetRegistrationUrlResponse as GetRegistrationUrlResponse,\n localdeliveryV1Tpa_universal_d_EstimateDeliveryRequest as EstimateDeliveryRequest,\n localdeliveryV1Tpa_universal_d_EstimateDeliveryRequestDispatchTimeOneOf as EstimateDeliveryRequestDispatchTimeOneOf,\n Address$1 as Address,\n StreetAddress$1 as StreetAddress,\n AddressLocation$2 as AddressLocation,\n Money$3 as Money,\n localdeliveryV1Tpa_universal_d_EstimateDeliveryResponse as EstimateDeliveryResponse,\n localdeliveryV1Tpa_universal_d_CreateDeliveryRequest as CreateDeliveryRequest,\n localdeliveryV1Tpa_universal_d_CreateDeliveryRequestDispatchTimeOneOf as CreateDeliveryRequestDispatchTimeOneOf,\n Customer$1 as Customer,\n localdeliveryV1Tpa_universal_d_CreateDeliveryResponse as CreateDeliveryResponse,\n localdeliveryV1Tpa_universal_d_listAccountIds as listAccountIds,\n localdeliveryV1Tpa_universal_d_listAppDefIds as listAppDefIds,\n localdeliveryV1Tpa_universal_d_getBusinessStatus as getBusinessStatus,\n localdeliveryV1Tpa_universal_d_GetBusinessStatusOptions as GetBusinessStatusOptions,\n localdeliveryV1Tpa_universal_d_getRegistrationUrl as getRegistrationUrl,\n localdeliveryV1Tpa_universal_d_estimateDelivery as estimateDelivery,\n localdeliveryV1Tpa_universal_d_EstimateDeliveryOptions as EstimateDeliveryOptions,\n localdeliveryV1Tpa_universal_d_createDelivery as createDelivery,\n localdeliveryV1Tpa_universal_d_CreateDeliveryOptions as CreateDeliveryOptions,\n };\n }\n \n /**\n * Collection of menus and discounts available in a specific location.\n * Use a [draft catalog](https://dev.wix.com/api/rest/wix-restaurants/catalogs/draft-catalogs) to publish multiple changes to a catalog at the same time.\n * You can read more about catalogs in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Catalog {\n /**\n * Catalog ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the location the catalog belongs to. See the [Locations API](https://dev.wix.com/api/rest/business-info/locations/introduction) for more details.\n * @readonly\n */\n locationId?: string | null;\n /**\n * Whether the catalog is archived.\n * __Note:__ Archived catalogs can't be updated.\n * @readonly\n */\n archived?: boolean;\n /**\n * Date and time the last time a draft catalog has been published in `yyyy-mm-ddThh:mm:sssZ` format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n * @readonly\n */\n draftPublishedDate?: Date | null;\n /**\n * Revision number. Increments by 1 each time the catalog is updated.\n * To prevent conflicting changes, the existing `revision` must be used when updating a catalog.\n * @internal\n * @readonly\n */\n revision?: string | null;\n }\n interface CreateDraftCatalogRequest {\n /** ID of the catalog to create a draft version for. */\n catalogId: string;\n }\n interface CreateDraftCatalogResponse {\n /** Created draft catalog. */\n catalog?: Catalog;\n }\n interface PublishDraftCatalogRequest {\n /** ID of the draft catalog to publish. */\n catalogId: string;\n }\n interface PublishDraftCatalogResponse {\n /** Published catalog. */\n catalog?: Catalog;\n }\n interface DiscardDraftCatalogRequest {\n /** ID of the draft catalog to discard. */\n catalogId: string;\n }\n interface DiscardDraftCatalogResponse {\n }\n interface BulkCreateVariationsRequest {\n /** ID of the catalog the variations will belong to. */\n catalogId: string;\n /** Variations to create. Limited to 20 variations. */\n variations?: NewVariation[];\n /** Whether the full variation entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface NewVariation {\n /** Variation name. */\n name?: string;\n }\n interface BulkCreateVariationsResponse {\n /** Information about the created variations. */\n results?: BulkItemResult[];\n /** Bulk Create Variations metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkItemResult {\n /** Metadata of the item. */\n entityMetadata?: ItemMetadata;\n /** Item. */\n entity?: Item;\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 /**\n * Anything that customers can buy in the restaurant. Items can be of type `DISH` or `VARIATION`.\n * You can read more about items in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Item {\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /** Item name. */\n name?: string | null;\n /** Item description. */\n description?: string | null;\n /** Item price. */\n price?: Money$2;\n /** URL of the item's image file. */\n imageUrl?: string | null;\n /** Item labels. For example spicy, hot, vegan, gluten-free, or organic. */\n labels?: Labels;\n /** Whether the item is in stock. */\n inStock?: boolean | null;\n /** Tax rate of the item in percent. */\n taxRate?: string | null;\n /**\n * Whether the item is archived. Defaults to `false`. **Note:** Archived items can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n /**\n * Visibility criteria that must be met for the item to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /** Items customers can choose to modify a dish. Can be an extra, selection, or deselection. */\n dishOptions?: DishOptions;\n /** Whether a customer can add a special request when ordering this item. Defaults to `true`. */\n acceptSpecialRequest?: boolean | null;\n /**\n * Item type.\n * @readonly\n */\n type?: ItemType;\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 in decimal string format. For example, `3.99`, `6`, and `10.5` are all accepted values. */\n value?: string;\n /**\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * @readonly\n */\n currency?: string;\n /**\n * Monetary amount. This is the number that will be displayed.\n * @internal\n * @readonly\n */\n formattedValue?: string | null;\n }\n interface Labels {\n values?: string[];\n }\n interface VisibilityCriteria {\n /**\n * Whether the entity appears in the live site. Defaults to `true`.\n * If `false`, the entity isn't rendered in the live site, even if each visibility criterion is fulfilled.\n */\n visible?: boolean | null;\n /** Fulfillment types. */\n fulfillmentTypes?: FulfillmentType$2[];\n /** Ordering platforms. */\n platforms?: Platform[];\n /** Time periods when the entity is available. */\n availability?: Availability$4;\n }\n enum FulfillmentType$2 {\n UNSPECIFIED_FULFILLMENT_TYPE = \"UNSPECIFIED_FULFILLMENT_TYPE\",\n DELIVERY = \"DELIVERY\",\n PICKUP_OR_DINE_IN = \"PICKUP_OR_DINE_IN\"\n }\n enum Platform {\n UNSPECIFIED_PLATFORM = \"UNSPECIFIED_PLATFORM\",\n SITE = \"SITE\",\n MOBILE_SITE = \"MOBILE_SITE\",\n WIX_APP = \"WIX_APP\",\n CALL_CENTER = \"CALL_CENTER\",\n CHAT_BOT = \"CHAT_BOT\"\n }\n interface Availability$4 {\n /**\n * Weekly recurring time periods when the entity is available.\n * Limited to 100 time periods.\n */\n periods?: TimePeriod$4[];\n /** Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period. */\n specialHourPeriods?: SpecialHourPeriod$4[];\n }\n /** Weekly recurring time periods when the entity 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-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-24:00, where 24:00 represents\n * midnight at the end of the specified day.\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 enum DayOfWeek$4 {\n UNDEFINED = \"UNDEFINED\",\n SUN = \"SUN\",\n MON = \"MON\",\n TUE = \"TUE\",\n WED = \"WED\",\n THU = \"THU\",\n FRI = \"FRI\",\n SAT = \"SAT\"\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 /** Whether the item is available during the exception. Defaults to `true`. */\n available?: boolean;\n /** Name of the special hour period. In the dashboard, the special hour period is called event. */\n eventName?: string | null;\n }\n interface DishOptions {\n values?: DishOption[];\n }\n interface DishOption extends DishOptionMethodOneOf {\n /** Item of type `DISH` or `VARIATION` that customers can select. For example a dish size. Customers can choose only a single selection per dish. */\n selection?: Selection;\n /** Item of type `DISH` or `VARIATION` that customers can add to a dish. For example a topping. Customers can add multiple extras per dish. */\n extras?: Extras;\n /** Item of type `DISH` or `VARIATION` that customers can remove from a dish. For example a specific ingredient. Customers can remove multiple deselections per dish. */\n deselection?: Deselection;\n /** Dish option name. */\n name?: string;\n /** @readonly */\n type?: Type$3;\n }\n /** @oneof */\n interface DishOptionMethodOneOf {\n /** Item of type `DISH` or `VARIATION` that customers can select. For example a dish size. Customers can choose only a single selection per dish. */\n selection?: Selection;\n /** Item of type `DISH` or `VARIATION` that customers can add to a dish. For example a topping. Customers can add multiple extras per dish. */\n extras?: Extras;\n /** Item of type `DISH` or `VARIATION` that customers can remove from a dish. For example a specific ingredient. Customers can remove multiple deselections per dish. */\n deselection?: Deselection;\n }\n interface DishOptionItem {\n /** Item ID of the dish option. */\n itemId?: string;\n /** Dish option price. `0` for free choices that are included in the dish's price. */\n price?: Money$2;\n }\n interface Selection {\n /** Item ID of the default choice. */\n defaultChoice?: string | null;\n /** Item IDs of the available choices. */\n availableChoices?: DishOptionItem[];\n }\n interface Extras {\n /** Item IDs of the default choices. */\n defaultChoices?: string[];\n /** Minimum number of extras a customer must choose. Defaults to `0`. Must be lower than or equal to the value of `availableChoices`. */\n minChoices?: number | null;\n /** Maximum number of extras a customer can choose. Defaults to the value of `availableChoices`. Must be greater than or equal to the value of `minChoices`. */\n maxChoices?: number | null;\n /** Item IDs of the available choices. */\n availableChoices?: DishOptionItem[];\n }\n interface Deselection {\n /** Item IDs of the available choices. */\n availableChoices?: DishOptionItem[];\n }\n enum Type$3 {\n UNSPECIFIED_DISH_OPTION_TYPE = \"UNSPECIFIED_DISH_OPTION_TYPE\",\n SELECTION = \"SELECTION\",\n EXTRAS = \"EXTRAS\",\n DESELECTION = \"DESELECTION\"\n }\n enum ItemType {\n UNSPECIFIED_ITEM_TYPE = \"UNSPECIFIED_ITEM_TYPE\",\n DISH = \"DISH\",\n VARIATION = \"VARIATION\"\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 BulkUpdateItemsRequest {\n /** ID of the catalog the items belong to. */\n catalogId: string;\n /** Items to update. Limited to 20 items. */\n items?: Item[];\n /** Whether the full item entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface BulkUpdateItemsResponse {\n /** Information about the updated items. */\n results?: BulkItemResult[];\n /** Bulk Update Items metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCreateDishesRequest {\n /** ID of the catalog the dishes will belong to. */\n catalogId: string;\n /** Information about the dishes to create. Limited to 20 dishes. */\n createDishRequests?: CreateDishRequest[];\n /** Whether the full item entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface CreateDishRequest {\n /** ID of the menu the dish will belong to. */\n menuId?: string;\n /** ID of the section the dish will belong to. */\n sectionId?: string;\n /** Dish to create. */\n dish?: Item;\n }\n interface BulkCreateDishesResponse {\n /** Information about the created dishes. */\n results?: BulkItemResult[];\n /** Bulk Create Dishes metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCreateMenusRequest {\n /** ID of the catalog the menus will belong to. */\n catalogId: string;\n /** Information about the menus to create. Limited to 20 menus. */\n menus?: Menu[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Collection of sections that show what customers can buy in the restaurant.\n * You can read more about menus in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Menu {\n /**\n * Menu ID.\n * @readonly\n */\n _id?: string | null;\n /** Menu name. */\n name?: string | null;\n /** Menu description. */\n description?: string | null;\n /** URL of the menu's image file. */\n imageUrl?: string | null;\n /**\n * Visibility criteria that must be met for the menu to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /** IDs of the sections that are included in the menu. */\n sectionIds?: MenuSectionIds;\n /**\n * Whether the menu is archived. Defaults to `false`. **Note:** Archived menus can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n }\n interface MenuSectionIds {\n values?: string[];\n }\n interface BulkCreateMenusResponse {\n /** Information about the created menus. */\n results?: BulkMenuResult[];\n /** Bulk Create Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkMenuResult {\n /** Menu metadata. */\n entityMetadata?: ItemMetadata;\n /** Menu. */\n entity?: Menu;\n }\n interface BulkUpdateMenusRequest {\n /** ID of the catalog the menus belong to. */\n catalogId: string;\n /** Menus to update. */\n menus?: Menu[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface BulkUpdateMenusResponse {\n /** Information about the updated menus. */\n results?: BulkMenuResult[];\n /** Bulk Update Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCreateSectionsRequest {\n /** ID of the catalog the sections will belong to. */\n catalogId: string;\n /** Information about the sections to create. Limited to 20 sections. */\n createSectionRequests?: CreateSectionRequest[];\n /** Whether the full section entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Collection of dishes that customers can buy in the restaurant.\n * You can read more about sections in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Section {\n /**\n * Section ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the menu the section belongs to.\n * @readonly\n */\n menuId?: string | null;\n /** Section name. */\n name?: string | null;\n /** Section description. */\n description?: string | null;\n /** URL of the section's image file. */\n imageUrl?: string | null;\n /** IDs of the items that belong to the section. */\n itemIds?: SectionItemIds;\n /**\n * Visibility criteria that must be met for the section to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /**\n * Whether the section is archived. Defaults to `false`. **Note:** Archived sections can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n }\n /** Item IDs of the dishes that belong to this section. */\n interface SectionItemIds {\n values?: string[];\n }\n interface CreateSectionRequest {\n /** ID of the menu the section will belong to. */\n menuId?: string;\n /** Section to create. */\n section?: Section;\n }\n interface BulkCreateSectionsResponse {\n /** Information about the created sections. */\n results?: BulkSectionResult[];\n /** Bulk Create Sections metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkSectionResult {\n /** Section metadata. */\n entityMetadata?: ItemMetadata;\n /** Section. */\n entity?: Section;\n }\n interface BulkUpdateSectionsRequest {\n /** ID of the catalog the sections belong to. */\n catalogId: string;\n /** Information about the sections to update. Limited to 20 sections. */\n updateSectionsRequests?: UpdateSectionRequest[];\n /** Whether the full section entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface UpdateSectionRequest {\n /** ID of the menu the section will belong to. */\n menuId?: string;\n /** Section to update. */\n section?: Section;\n }\n interface BulkUpdateSectionsResponse {\n /** Information about the updated sections. */\n results?: BulkSectionResult[];\n /** Bulk Update Sections metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkArchiveMenusRequest {\n /** ID of the catalog the menus belong to. */\n catalogId: string;\n /** IDs of the menus to archive. */\n ids?: string[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface BulkArchiveMenusResponse {\n /** Information about the archived menus. */\n results?: BulkMenuResult[];\n /** Bulk Archive Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkUnarchiveMenusRequest {\n /** ID of the catalog the menus belong to. */\n catalogId: string;\n /** IDs of the menus to unarchive. */\n ids?: string[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n interface BulkUnarchiveMenusResponse {\n /** Information about the unarchived menus. */\n results?: BulkMenuResult[];\n /** Bulk Unarchive Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\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 CatalogUpdated {\n metaSiteId?: string;\n locationId?: string | null;\n catalogId?: string | null;\n archived?: boolean;\n catalogItems?: Item[];\n catalogSections?: Section[];\n catalogMenus?: Menu[];\n catalogDiscounts?: Discount$2[];\n }\n /**\n * Customers can use a discount to pay less. Can be an amount or a percentage.\n * You can read more about discounts in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Discount$2 extends DiscountValueOneOf$1, DiscountApplyToFilterOneOf$1 {\n /** Discount amount. */\n amount?: Money$2;\n /** Discount percentage. */\n percentage?: string | null;\n /** IDs of the sections the discount applies to. */\n sectionIds?: SectionIds$1;\n /** IDs of the items the discount applies to. **Note:** The items must be of type `dish`. */\n itemIds?: ItemIds$1;\n /**\n * Discount ID.\n * @readonly\n */\n _id?: string | null;\n /** Discount name. */\n name?: string | null;\n /** Discount description. */\n description?: string | null;\n /** Whether the discount is active. Defaults to `true`. */\n active?: boolean | null;\n /** Discount type. */\n type?: DiscountType$2;\n /**\n * Discount condition.\n * All conditions must be met so that a customer can apply the discount.\n */\n condition?: DiscountCondition$1;\n }\n /** @oneof */\n interface DiscountValueOneOf$1 {\n /** Discount amount. */\n amount?: Money$2;\n /** Discount percentage. */\n percentage?: string | null;\n }\n /** @oneof */\n interface DiscountApplyToFilterOneOf$1 {\n /** IDs of the sections the discount applies to. */\n sectionIds?: SectionIds$1;\n /** IDs of the items the discount applies to. **Note:** The items must be of type `dish`. */\n itemIds?: ItemIds$1;\n }\n enum DiscountType$2 {\n UNSPECIFIED_TYPE = \"UNSPECIFIED_TYPE\",\n OFF_ITEM = \"OFF_ITEM\",\n OFF_ORDER = \"OFF_ORDER\"\n }\n interface SectionIds$1 {\n values?: string[];\n }\n interface ItemIds$1 {\n values?: string[];\n }\n interface DiscountCondition$1 {\n /** Which fulfillment types the discount applies to. */\n fulfillmentTypes?: FulfillmentType$2[];\n /** Which ordering platforms the discount applies to. */\n platforms?: DiscountPlatform$1[];\n /** List of times when the discount is available. */\n availability?: Availability$4;\n /** Minimum order price for the discount. */\n minOrderPrice?: Money$2;\n /**\n * Coupon associated with the discount.\n * @readonly\n */\n coupon?: Coupon$2;\n }\n enum DiscountPlatform$1 {\n UNSPECIFIED_PLATFORM = \"UNSPECIFIED_PLATFORM\",\n SITE = \"SITE\",\n MOBILE_SITE = \"MOBILE_SITE\",\n CALL_CENTER = \"CALL_CENTER\"\n }\n interface Coupon$2 {\n /**\n * Whether the customer needs to enter the coupon code to receive the discount. Defaults to `true`.\n * @readonly\n */\n applied?: boolean | null;\n /**\n * Coupon code.\n * @readonly\n */\n code?: string | null;\n }\n interface PublishCatalogUpdated {\n metaSiteId?: string;\n locationId?: string | null;\n catalogId?: string | null;\n archived?: boolean;\n }\n interface IndexCacheCmd {\n catalogId?: string;\n orgId?: string;\n orgLocale?: string;\n metaSiteId?: string | null;\n }\n interface CatalogChanged {\n /** Changed Catalog. */\n catalog?: Catalog;\n }\n interface ListCatalogsRequest {\n /** Sort order. Defaults to `ASC`. */\n sort?: Sorting;\n /** Paging information. `offset` defaults to `0` and `limit` defaults to `50`. The maximum for limit is `1,000`. */\n paging?: Paging;\n /** Whether archived catalogs are returned. Defaults to `false`. */\n archived?: boolean;\n /** IDs of the locations for which the catalog will be returned. See the [Locations API](https://dev.wix.com/api/rest/business-info/locations/introduction) for more details. */\n locationIds?: string[];\n /**\n * IDs of the restaurant-locations for which the catalog will be returned.\n * @internal\n */\n restaurantLocationIds?: string[];\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 ListCatalogsResponse {\n /** Retrieved catalogs. */\n catalogs?: Catalog[];\n }\n interface GetMenuRequest {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n }\n interface GetMenuResponse {\n /** Retrieved menu. */\n menu?: Menu;\n }\n interface GetSectionRequest {\n /** ID of the catalog the section belongs to. */\n catalogId: string;\n /** ID of the menu the catalog belongs to. */\n menuId: string;\n /** Section ID. */\n sectionId: string;\n }\n interface GetSectionResponse {\n /** Retrieved section. */\n section?: Section;\n }\n interface UpdateMenuRequest {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu to update. */\n menu?: Menu;\n }\n interface UpdateMenuResponse {\n /** Updated Menu. */\n menu?: Menu;\n }\n interface V3UpdateSectionRequest {\n /** ID of the catalog the section belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n /** Section to update. */\n section?: Section;\n }\n interface UpdateSectionResponse {\n /** Updated section. */\n section?: Section;\n }\n interface ListMenusRequest {\n /** ID of the catalog the menus belong to. */\n catalogId: string;\n /**\n * Field mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether archived menus are returned. Defaults to `false`. */\n archived?: boolean;\n /**\n * Fulfillment types filter\n * @internal\n */\n fulfillmentTypes?: FulfillmentType$2[];\n /**\n * Ordering platforms filter\n * @internal\n */\n platforms?: Platform[];\n }\n interface ListMenusResponse {\n /** Retrieved menus. */\n menus?: Menu[];\n }\n interface ListSectionsRequest {\n /** ID of the catalog the sections belong to. */\n catalogId: string;\n /**\n * Field mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether archived sections are returned. Defaults to `false`. */\n archived?: boolean;\n /**\n * Fulfillment types filter\n * @internal\n */\n fulfillmentTypes?: FulfillmentType$2[];\n /**\n * Ordering platforms filter\n * @internal\n */\n platforms?: Platform[];\n }\n interface ListSectionsResponse {\n /** Sections list. */\n sections?: Section[];\n }\n interface CreateMenuRequest {\n /** ID of the catalog the menu will belong to. */\n catalogId: string;\n /** Menu to create. */\n menu: Menu;\n }\n interface CreateMenuResponse {\n /** Created Menu. */\n menu?: Menu;\n }\n interface ArchiveMenuRequest {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n }\n interface ArchiveMenuResponse {\n /** Archived menu. */\n menu?: Menu;\n }\n interface UnarchiveMenuRequest {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n }\n interface UnarchiveMenuResponse {\n /** Unarchived menu. */\n menu?: Menu;\n }\n interface ArchiveSectionRequest {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n /** Section ID. */\n sectionId: string;\n }\n interface ArchiveSectionResponse {\n /** Archived section. */\n section?: Section;\n }\n interface RemoveDishFromSectionRequest {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n /** Section ID. */\n sectionId: string;\n /** Item ID. */\n itemId: string;\n }\n interface RemoveDishFromSectionResponse {\n }\n interface V3CreateSectionRequest {\n /** ID of the catalog the section will belong to. */\n catalogId: string;\n /** ID of the menu the section will belong to. */\n menuId: string;\n /** Section to create. */\n section: Section;\n }\n interface CreateSectionResponse {\n /** Created section. */\n section?: Section;\n }\n interface GetItemRequest {\n /** ID of the catalog the item belongs to. */\n catalogId: string;\n /** Item ID. */\n itemId: string;\n /** Whether `visibilityCriteria` is returned. Defaults to `false`. */\n includeVisibilityCriteria?: boolean;\n }\n interface GetItemResponse {\n /** Retrieved item. */\n item?: Item;\n }\n interface ListItemsRequest {\n /**\n * Field mask path.\n * @internal\n */\n fieldMask?: string[];\n /** ID of the catalog the items belong to. */\n catalogId: string;\n /** Whether archived items are returned. Defaults to `false`. */\n archived?: boolean;\n /**\n * Fulfillment types filter\n * @internal\n */\n fulfillmentTypes?: FulfillmentType$2[];\n /**\n * Ordering platforms filter\n * @internal\n */\n platforms?: Platform[];\n }\n interface ListItemsResponse {\n /** Retrieved items. */\n items?: Item[];\n }\n interface UpdateItemRequest {\n /** ID of the catalog the item belongs to. */\n catalogId: string;\n /** Item to update. */\n item?: Item;\n }\n interface UpdateItemResponse {\n /** Updated Item. */\n item?: Item;\n }\n interface V3CreateDishRequest {\n /** ID of the catalog the dish will belong to. */\n catalogId: string;\n /** ID of the menu the dish will belong to. */\n menuId: string;\n /** ID of the section the dish will belong to. */\n sectionId: string;\n /** Item of type `dish` to create. */\n dish: Item;\n }\n interface CreateDishResponse {\n /** Created Dish. */\n dish?: Item;\n }\n interface CreateVariationRequest {\n /** ID of the catalog the variation will belong to. */\n catalogId: string;\n /** Variation name. */\n name: string;\n }\n interface CreateVariationResponse {\n /** Created Variation. */\n variation?: Item;\n }\n interface MenuUpdated {\n metaSiteId?: string;\n organizationId?: string;\n locationId?: string | null;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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$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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 draft version of the specified catalog.\n * Then you can update and publish the draft catalog by using the endpoints in the [Draft Catalogs category](https://dev.wix.com/api/rest/wix-restaurants/catalogs/draft-catalogs).\n *\n * > **Note:** You can't create more than one draft catalog per location.\n * @param catalogId - ID of the catalog to create a draft version for.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function createDraftCatalog(catalogId: string): Promise;\n /**\n * Publishes a draft catalog to the live site by replacing the existing catalog.\n * @param catalogId - ID of the draft catalog to publish.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function publishDraftCatalog(catalogId: string): Promise;\n /**\n * Discards a draft catalog. If you want to continue using [Bulk endpoints](https://dev.wix.com/api/rest/wix-restaurants/catalogs/draft-catalogs) for this catalog, you must first call the [Create Draft Catalog](https://dev.wix.com/api/rest/wix-restaurants/catalogs/draft-catalogs/create-draft-catalog) endpoint again.\n * @param catalogId - ID of the draft catalog to discard.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function discardDraftCatalog(catalogId: string): Promise;\n /**\n * Adds multiple variations to a draft catalog.\n * @param catalogId - ID of the catalog the variations will belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkCreateVariations(catalogId: string, options?: BulkCreateVariationsOptions): Promise;\n interface BulkCreateVariationsOptions {\n /** Variations to create. Limited to 20 variations. */\n variations?: NewVariation[];\n /** Whether the full variation entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Updates multiple items in a draft catalog.\n * You can't update archived items.\n * @param catalogId - ID of the catalog the items belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkUpdateItems(catalogId: string, options?: BulkUpdateItemsOptions): Promise;\n interface BulkUpdateItemsOptions {\n /** Items to update. Limited to 20 items. */\n items?: Item[];\n /** Whether the full item entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Adds multiple dishes to a draft catalog.\n * @param catalogId - ID of the catalog the dishes will belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkCreateDishes(catalogId: string, options?: BulkCreateDishesOptions): Promise;\n interface BulkCreateDishesOptions {\n /** Information about the dishes to create. Limited to 20 dishes. */\n createDishRequests?: CreateDishRequest[];\n /** Whether the full item entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Adds multiple menus to a draft catalog.\n * @param catalogId - ID of the catalog the menus will belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkCreateMenus(catalogId: string, options?: BulkCreateMenusOptions): Promise;\n interface BulkCreateMenusOptions {\n /** Information about the menus to create. Limited to 20 menus. */\n menus?: Menu[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Updates multiple menus in a draft catalog.\n * You can't update archived menus.\n * @param catalogId - ID of the catalog the menus belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkUpdateMenus(catalogId: string, options?: BulkUpdateMenusOptions): Promise;\n interface BulkUpdateMenusOptions {\n /** Menus to update. */\n menus?: Menu[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Adds multiple sections to a draft catalog.\n * @param catalogId - ID of the catalog the sections will belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkCreateSections(catalogId: string, options?: BulkCreateSectionsOptions): Promise;\n interface BulkCreateSectionsOptions {\n /** Information about the sections to create. Limited to 20 sections. */\n createSectionRequests?: CreateSectionRequest[];\n /** Whether the full section entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Updates multiple sections in a draft catalog.\n * You can't update archived sections.\n * @param catalogId - ID of the catalog the sections belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkUpdateSections(catalogId: string, options?: BulkUpdateSectionsOptions): Promise;\n interface BulkUpdateSectionsOptions {\n /** Information about the sections to update. Limited to 20 sections. */\n updateSectionsRequests?: UpdateSectionRequest[];\n /** Whether the full section entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Changes the `archived` boolean to `true` for multiple menus in a draft catalog.\n * @param catalogId - ID of the catalog the menus belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkArchiveMenus(catalogId: string, options?: BulkArchiveMenusOptions): Promise;\n interface BulkArchiveMenusOptions {\n /** IDs of the menus to archive. */\n ids?: string[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Changes the `archived` boolean to `false` for multiple menus in a draft catalog.\n * @param catalogId - ID of the catalog the menus belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function bulkUnarchiveMenus(catalogId: string, options?: BulkUnarchiveMenusOptions): Promise;\n interface BulkUnarchiveMenusOptions {\n /** IDs of the menus to unarchive. */\n ids?: string[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Retrieves catalogs, given the provided filtering, sorting and paging.\n * Note that there is a single catalog per location.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function listCatalogs(options?: ListCatalogsOptions): Promise;\n interface ListCatalogsOptions {\n /** Sort order. Defaults to `ASC`. */\n sort?: Sorting;\n /** Paging information. `offset` defaults to `0` and `limit` defaults to `50`. The maximum for limit is `1,000`. */\n paging?: Paging;\n /** Whether archived catalogs are returned. Defaults to `false`. */\n archived?: boolean;\n /** IDs of the locations for which the catalog will be returned. See the [Locations API](https://dev.wix.com/api/rest/business-info/locations/introduction) for more details. */\n locationIds?: string[];\n /**\n * IDs of the restaurant-locations for which the catalog will be returned.\n * @internal\n */\n restaurantLocationIds?: string[];\n }\n /**\n * Retrieves a menu.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function getMenu(identifiers: GetMenuIdentifiers): Promise;\n interface GetMenuIdentifiers {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n }\n /**\n * Retrieves a section.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @requiredField identifiers.sectionId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function getSection(identifiers: GetSectionIdentifiers): Promise;\n interface GetSectionIdentifiers {\n /** ID of the catalog the section belongs to. */\n catalogId: string;\n /** ID of the menu the catalog belongs to. */\n menuId: string;\n /** Section ID. */\n sectionId: string;\n }\n /**\n * Updates a menu.\n * You can't update archived menus.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function updateMenu(identifiers: UpdateMenuIdentifiers, options?: UpdateMenuOptions): Promise;\n interface UpdateMenuIdentifiers {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /**\n * Menu ID.\n * @readonly\n */\n menuId?: string | null;\n }\n interface UpdateMenuOptions {\n menu: {\n /**\n * Menu ID.\n * @readonly\n */\n _id?: string | null;\n /** Menu name. */\n name?: string | null;\n /** Menu description. */\n description?: string | null;\n /** URL of the menu's image file. */\n imageUrl?: string | null;\n /**\n * Visibility criteria that must be met for the menu to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /** IDs of the sections that are included in the menu. */\n sectionIds?: MenuSectionIds;\n /**\n * Whether the menu is archived. Defaults to `false`. **Note:** Archived menus can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n };\n }\n /**\n * Updates a section.\n * You can't update archived sections. Note that every section belongs to a single menu, you can't add it to another menu.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @requiredField identifiers.sectionId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function updateSection(identifiers: UpdateSectionIdentifiers, options?: UpdateSectionOptions): Promise;\n interface UpdateSectionIdentifiers {\n /** ID of the catalog the section belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n /**\n * Section ID.\n * @readonly\n */\n sectionId?: string | null;\n }\n interface UpdateSectionOptions {\n section: {\n /**\n * Section ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the menu the section belongs to.\n * @readonly\n */\n menuId?: string | null;\n /** Section name. */\n name?: string | null;\n /** Section description. */\n description?: string | null;\n /** URL of the section's image file. */\n imageUrl?: string | null;\n /** IDs of the items that belong to the section. */\n itemIds?: SectionItemIds;\n /**\n * Visibility criteria that must be met for the section to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /**\n * Whether the section is archived. Defaults to `false`. **Note:** Archived sections can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n };\n }\n /**\n * Retrieves menus, given the provided filtering, sorting and paging.\n * @param catalogId - ID of the catalog the menus belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function listMenus(catalogId: string, options?: ListMenusOptions): Promise;\n interface ListMenusOptions {\n /**\n * Field mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether archived menus are returned. Defaults to `false`. */\n archived?: boolean;\n /**\n * Fulfillment types filter\n * @internal\n */\n fulfillmentTypes?: FulfillmentType$2[];\n /**\n * Ordering platforms filter\n * @internal\n */\n platforms?: Platform[];\n }\n /**\n * Retrieves sections, given the provided filtering, sorting and paging.\n * @param catalogId - ID of the catalog the sections belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function listSections(catalogId: string, options?: ListSectionsOptions): Promise;\n interface ListSectionsOptions {\n /**\n * Field mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether archived sections are returned. Defaults to `false`. */\n archived?: boolean;\n /**\n * Fulfillment types filter\n * @internal\n */\n fulfillmentTypes?: FulfillmentType$2[];\n /**\n * Ordering platforms filter\n * @internal\n */\n platforms?: Platform[];\n }\n /**\n * Creates a menu.\n * @param catalogId - ID of the catalog the menu will belong to.\n * @param menu - Menu to create.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @requiredField menu\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function createMenu(catalogId: string, menu: Menu): Promise;\n /**\n * Archives a menu. You can't update archived menus.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function archiveMenu(identifiers: ArchiveMenuIdentifiers): Promise;\n interface ArchiveMenuIdentifiers {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n }\n /**\n * Unarchives a menu.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function unarchiveMenu(identifiers: UnarchiveMenuIdentifiers): Promise;\n interface UnarchiveMenuIdentifiers {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n }\n /**\n * Archives a section. You can't update archived sections.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @requiredField identifiers.sectionId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function archiveSection(identifiers: ArchiveSectionIdentifiers): Promise;\n interface ArchiveSectionIdentifiers {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n /** Section ID. */\n sectionId: string;\n }\n /**\n * Remove an item from a section\n * @param itemId - Item ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @requiredField identifiers.sectionId\n * @requiredField itemId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function removeDishFromSection(identifiers: RemoveDishFromSectionIdentifiers, itemId: string): Promise;\n interface RemoveDishFromSectionIdentifiers {\n /** ID of the catalog the menu belongs to. */\n catalogId: string;\n /** Menu ID. */\n menuId: string;\n /** Section ID. */\n sectionId: string;\n }\n /**\n * Creates a section.\n * You can't add the section to multiple menus, since every section belongs to a single menu.\n * @param section - Section to create.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @requiredField section\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function createSection(identifiers: CreateSectionIdentifiers, section: Section): Promise;\n interface CreateSectionIdentifiers {\n /** ID of the catalog the section will belong to. */\n catalogId: string;\n /** ID of the menu the section will belong to. */\n menuId: string;\n }\n /**\n * Retrieves an item.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.itemId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function getItem(identifiers: GetItemIdentifiers, options?: GetItemOptions): Promise;\n interface GetItemIdentifiers {\n /** ID of the catalog the item belongs to. */\n catalogId: string;\n /** Item ID. */\n itemId: string;\n }\n interface GetItemOptions {\n /** Whether `visibilityCriteria` is returned. Defaults to `false`. */\n includeVisibilityCriteria?: boolean;\n }\n /**\n * Retrieves items, given the provided filtering, sorting and paging.\n * @param catalogId - ID of the catalog the items belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function listItems(catalogId: string, options?: ListItemsOptions): Promise;\n interface ListItemsOptions {\n /**\n * Field mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether archived items are returned. Defaults to `false`. */\n archived?: boolean;\n /**\n * Fulfillment types filter\n * @internal\n */\n fulfillmentTypes?: FulfillmentType$2[];\n /**\n * Ordering platforms filter\n * @internal\n */\n platforms?: Platform[];\n }\n /**\n * Updates an item.\n * You can't update archived items.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.itemId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function updateItem(identifiers: UpdateItemIdentifiers, options?: UpdateItemOptions): Promise;\n interface UpdateItemIdentifiers {\n /** ID of the catalog the item belongs to. */\n catalogId: string;\n /**\n * Item ID.\n * @readonly\n */\n itemId?: string | null;\n }\n interface UpdateItemOptions {\n item: {\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /** Item name. */\n name?: string | null;\n /** Item description. */\n description?: string | null;\n /** Item price. */\n price?: Money$2;\n /** URL of the item's image file. */\n imageUrl?: string | null;\n /** Item labels. For example spicy, hot, vegan, gluten-free, or organic. */\n labels?: Labels;\n /** Whether the item is in stock. */\n inStock?: boolean | null;\n /** Tax rate of the item in percent. */\n taxRate?: string | null;\n /**\n * Whether the item is archived. Defaults to `false`. **Note:** Archived items can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n /**\n * Visibility criteria that must be met for the item to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /** Items customers can choose to modify a dish. Can be an extra, selection, or deselection. */\n dishOptions?: DishOptions;\n /** Whether a customer can add a special request when ordering this item. Defaults to `true`. */\n acceptSpecialRequest?: boolean | null;\n /**\n * Item type.\n * @readonly\n */\n type?: ItemType;\n };\n }\n /**\n * Creates a dish.\n * @param dish - Item of type `dish` to create.\n * @public\n * @documentationMaturity preview\n * @requiredField dish\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.menuId\n * @requiredField identifiers.sectionId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function createDish(identifiers: CreateDishIdentifiers, dish: Item): Promise;\n interface CreateDishIdentifiers {\n /** ID of the catalog the dish will belong to. */\n catalogId: string;\n /** ID of the menu the dish will belong to. */\n menuId: string;\n /** ID of the section the dish will belong to. */\n sectionId: string;\n }\n /**\n * Creates a variation.\n * @param catalogId - ID of the catalog the variation will belong to.\n * @param name - Variation name.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @requiredField name\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function createVariation(catalogId: string, name: string): Promise;\n /**\n * Adds multiple variations to a catalog.\n * @param catalogId - ID of the catalog the variations will belong to.\n * @internal\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function catalogsBulkCreateVariations(catalogId: string, options?: CatalogsBulkCreateVariationsOptions): Promise;\n interface CatalogsBulkCreateVariationsOptions {\n /** Variations to create. Limited to 20 variations. */\n variations?: NewVariation[];\n /** Whether the full variation entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Changes the `archived` boolean to `true` for multiple menus.\n * @param catalogId - ID of the catalog the menus belong to.\n * @internal\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function catalogsBulkArchiveMenus(catalogId: string, options?: CatalogsBulkArchiveMenusOptions): Promise;\n interface CatalogsBulkArchiveMenusOptions {\n /** IDs of the menus to archive. */\n ids?: string[];\n /** Whether the full menu entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Adds multiple dishes to a catalog.\n * @param catalogId - ID of the catalog the dishes will belong to.\n * @internal\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function catalogsBulkCreateDishes(catalogId: string, options?: CatalogsBulkCreateDishesOptions): Promise;\n interface CatalogsBulkCreateDishesOptions {\n /** Information about the dishes to create. Limited to 20 dishes. */\n createDishRequests?: CreateDishRequest[];\n /** Whether the full item entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n /**\n * Adds multiple sections to a catalog.\n * @param catalogId - ID of the catalog the sections will belong to.\n * @internal\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n */\n function catalogsBulkCreateSections(catalogId: string, options?: CatalogsBulkCreateSectionsOptions): Promise;\n interface CatalogsBulkCreateSectionsOptions {\n /** Information about the sections to create. Limited to 20 sections. */\n createSectionRequests?: CreateSectionRequest[];\n /** Whether the full section entity is returned. Defaults to `true`. */\n returnFullEntity?: boolean;\n }\n \n type restaurantsCatalogsV3Catalog_universal_d_Catalog = Catalog;\n type restaurantsCatalogsV3Catalog_universal_d_CreateDraftCatalogRequest = CreateDraftCatalogRequest;\n type restaurantsCatalogsV3Catalog_universal_d_CreateDraftCatalogResponse = CreateDraftCatalogResponse;\n type restaurantsCatalogsV3Catalog_universal_d_PublishDraftCatalogRequest = PublishDraftCatalogRequest;\n type restaurantsCatalogsV3Catalog_universal_d_PublishDraftCatalogResponse = PublishDraftCatalogResponse;\n type restaurantsCatalogsV3Catalog_universal_d_DiscardDraftCatalogRequest = DiscardDraftCatalogRequest;\n type restaurantsCatalogsV3Catalog_universal_d_DiscardDraftCatalogResponse = DiscardDraftCatalogResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateVariationsRequest = BulkCreateVariationsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_NewVariation = NewVariation;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateVariationsResponse = BulkCreateVariationsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkItemResult = BulkItemResult;\n type restaurantsCatalogsV3Catalog_universal_d_ItemMetadata = ItemMetadata;\n type restaurantsCatalogsV3Catalog_universal_d_ApplicationError = ApplicationError;\n type restaurantsCatalogsV3Catalog_universal_d_Item = Item;\n type restaurantsCatalogsV3Catalog_universal_d_Labels = Labels;\n type restaurantsCatalogsV3Catalog_universal_d_VisibilityCriteria = VisibilityCriteria;\n type restaurantsCatalogsV3Catalog_universal_d_Platform = Platform;\n const restaurantsCatalogsV3Catalog_universal_d_Platform: typeof Platform;\n type restaurantsCatalogsV3Catalog_universal_d_DishOptions = DishOptions;\n type restaurantsCatalogsV3Catalog_universal_d_DishOption = DishOption;\n type restaurantsCatalogsV3Catalog_universal_d_DishOptionMethodOneOf = DishOptionMethodOneOf;\n type restaurantsCatalogsV3Catalog_universal_d_DishOptionItem = DishOptionItem;\n type restaurantsCatalogsV3Catalog_universal_d_Selection = Selection;\n type restaurantsCatalogsV3Catalog_universal_d_Extras = Extras;\n type restaurantsCatalogsV3Catalog_universal_d_Deselection = Deselection;\n type restaurantsCatalogsV3Catalog_universal_d_ItemType = ItemType;\n const restaurantsCatalogsV3Catalog_universal_d_ItemType: typeof ItemType;\n type restaurantsCatalogsV3Catalog_universal_d_BulkActionMetadata = BulkActionMetadata;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateItemsRequest = BulkUpdateItemsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateItemsResponse = BulkUpdateItemsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateDishesRequest = BulkCreateDishesRequest;\n type restaurantsCatalogsV3Catalog_universal_d_CreateDishRequest = CreateDishRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateDishesResponse = BulkCreateDishesResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateMenusRequest = BulkCreateMenusRequest;\n type restaurantsCatalogsV3Catalog_universal_d_Menu = Menu;\n type restaurantsCatalogsV3Catalog_universal_d_MenuSectionIds = MenuSectionIds;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateMenusResponse = BulkCreateMenusResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkMenuResult = BulkMenuResult;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateMenusRequest = BulkUpdateMenusRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateMenusResponse = BulkUpdateMenusResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateSectionsRequest = BulkCreateSectionsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_Section = Section;\n type restaurantsCatalogsV3Catalog_universal_d_SectionItemIds = SectionItemIds;\n type restaurantsCatalogsV3Catalog_universal_d_CreateSectionRequest = CreateSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateSectionsResponse = BulkCreateSectionsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkSectionResult = BulkSectionResult;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateSectionsRequest = BulkUpdateSectionsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateSectionRequest = UpdateSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateSectionsResponse = BulkUpdateSectionsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkArchiveMenusRequest = BulkArchiveMenusRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkArchiveMenusResponse = BulkArchiveMenusResponse;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUnarchiveMenusRequest = BulkUnarchiveMenusRequest;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUnarchiveMenusResponse = BulkUnarchiveMenusResponse;\n type restaurantsCatalogsV3Catalog_universal_d_InvalidateCache = InvalidateCache;\n type restaurantsCatalogsV3Catalog_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type restaurantsCatalogsV3Catalog_universal_d_App = App;\n type restaurantsCatalogsV3Catalog_universal_d_Page = Page;\n type restaurantsCatalogsV3Catalog_universal_d_URI = URI;\n type restaurantsCatalogsV3Catalog_universal_d_File = File;\n type restaurantsCatalogsV3Catalog_universal_d_CatalogUpdated = CatalogUpdated;\n type restaurantsCatalogsV3Catalog_universal_d_PublishCatalogUpdated = PublishCatalogUpdated;\n type restaurantsCatalogsV3Catalog_universal_d_IndexCacheCmd = IndexCacheCmd;\n type restaurantsCatalogsV3Catalog_universal_d_CatalogChanged = CatalogChanged;\n type restaurantsCatalogsV3Catalog_universal_d_ListCatalogsRequest = ListCatalogsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_Sorting = Sorting;\n type restaurantsCatalogsV3Catalog_universal_d_Paging = Paging;\n type restaurantsCatalogsV3Catalog_universal_d_ListCatalogsResponse = ListCatalogsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_GetMenuRequest = GetMenuRequest;\n type restaurantsCatalogsV3Catalog_universal_d_GetMenuResponse = GetMenuResponse;\n type restaurantsCatalogsV3Catalog_universal_d_GetSectionRequest = GetSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_GetSectionResponse = GetSectionResponse;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateMenuRequest = UpdateMenuRequest;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateMenuResponse = UpdateMenuResponse;\n type restaurantsCatalogsV3Catalog_universal_d_V3UpdateSectionRequest = V3UpdateSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateSectionResponse = UpdateSectionResponse;\n type restaurantsCatalogsV3Catalog_universal_d_ListMenusRequest = ListMenusRequest;\n type restaurantsCatalogsV3Catalog_universal_d_ListMenusResponse = ListMenusResponse;\n type restaurantsCatalogsV3Catalog_universal_d_ListSectionsRequest = ListSectionsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_ListSectionsResponse = ListSectionsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_CreateMenuRequest = CreateMenuRequest;\n type restaurantsCatalogsV3Catalog_universal_d_CreateMenuResponse = CreateMenuResponse;\n type restaurantsCatalogsV3Catalog_universal_d_ArchiveMenuRequest = ArchiveMenuRequest;\n type restaurantsCatalogsV3Catalog_universal_d_ArchiveMenuResponse = ArchiveMenuResponse;\n type restaurantsCatalogsV3Catalog_universal_d_UnarchiveMenuRequest = UnarchiveMenuRequest;\n type restaurantsCatalogsV3Catalog_universal_d_UnarchiveMenuResponse = UnarchiveMenuResponse;\n type restaurantsCatalogsV3Catalog_universal_d_ArchiveSectionRequest = ArchiveSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_ArchiveSectionResponse = ArchiveSectionResponse;\n type restaurantsCatalogsV3Catalog_universal_d_RemoveDishFromSectionRequest = RemoveDishFromSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_RemoveDishFromSectionResponse = RemoveDishFromSectionResponse;\n type restaurantsCatalogsV3Catalog_universal_d_V3CreateSectionRequest = V3CreateSectionRequest;\n type restaurantsCatalogsV3Catalog_universal_d_CreateSectionResponse = CreateSectionResponse;\n type restaurantsCatalogsV3Catalog_universal_d_GetItemRequest = GetItemRequest;\n type restaurantsCatalogsV3Catalog_universal_d_GetItemResponse = GetItemResponse;\n type restaurantsCatalogsV3Catalog_universal_d_ListItemsRequest = ListItemsRequest;\n type restaurantsCatalogsV3Catalog_universal_d_ListItemsResponse = ListItemsResponse;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateItemRequest = UpdateItemRequest;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateItemResponse = UpdateItemResponse;\n type restaurantsCatalogsV3Catalog_universal_d_V3CreateDishRequest = V3CreateDishRequest;\n type restaurantsCatalogsV3Catalog_universal_d_CreateDishResponse = CreateDishResponse;\n type restaurantsCatalogsV3Catalog_universal_d_CreateVariationRequest = CreateVariationRequest;\n type restaurantsCatalogsV3Catalog_universal_d_CreateVariationResponse = CreateVariationResponse;\n type restaurantsCatalogsV3Catalog_universal_d_MenuUpdated = MenuUpdated;\n const restaurantsCatalogsV3Catalog_universal_d_createDraftCatalog: typeof createDraftCatalog;\n const restaurantsCatalogsV3Catalog_universal_d_publishDraftCatalog: typeof publishDraftCatalog;\n const restaurantsCatalogsV3Catalog_universal_d_discardDraftCatalog: typeof discardDraftCatalog;\n const restaurantsCatalogsV3Catalog_universal_d_bulkCreateVariations: typeof bulkCreateVariations;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateVariationsOptions = BulkCreateVariationsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkUpdateItems: typeof bulkUpdateItems;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateItemsOptions = BulkUpdateItemsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkCreateDishes: typeof bulkCreateDishes;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateDishesOptions = BulkCreateDishesOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkCreateMenus: typeof bulkCreateMenus;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateMenusOptions = BulkCreateMenusOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkUpdateMenus: typeof bulkUpdateMenus;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateMenusOptions = BulkUpdateMenusOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkCreateSections: typeof bulkCreateSections;\n type restaurantsCatalogsV3Catalog_universal_d_BulkCreateSectionsOptions = BulkCreateSectionsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkUpdateSections: typeof bulkUpdateSections;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUpdateSectionsOptions = BulkUpdateSectionsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkArchiveMenus: typeof bulkArchiveMenus;\n type restaurantsCatalogsV3Catalog_universal_d_BulkArchiveMenusOptions = BulkArchiveMenusOptions;\n const restaurantsCatalogsV3Catalog_universal_d_bulkUnarchiveMenus: typeof bulkUnarchiveMenus;\n type restaurantsCatalogsV3Catalog_universal_d_BulkUnarchiveMenusOptions = BulkUnarchiveMenusOptions;\n const restaurantsCatalogsV3Catalog_universal_d_listCatalogs: typeof listCatalogs;\n type restaurantsCatalogsV3Catalog_universal_d_ListCatalogsOptions = ListCatalogsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_getMenu: typeof getMenu;\n type restaurantsCatalogsV3Catalog_universal_d_GetMenuIdentifiers = GetMenuIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_getSection: typeof getSection;\n type restaurantsCatalogsV3Catalog_universal_d_GetSectionIdentifiers = GetSectionIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_updateMenu: typeof updateMenu;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateMenuIdentifiers = UpdateMenuIdentifiers;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateMenuOptions = UpdateMenuOptions;\n const restaurantsCatalogsV3Catalog_universal_d_updateSection: typeof updateSection;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateSectionIdentifiers = UpdateSectionIdentifiers;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateSectionOptions = UpdateSectionOptions;\n const restaurantsCatalogsV3Catalog_universal_d_listMenus: typeof listMenus;\n type restaurantsCatalogsV3Catalog_universal_d_ListMenusOptions = ListMenusOptions;\n const restaurantsCatalogsV3Catalog_universal_d_listSections: typeof listSections;\n type restaurantsCatalogsV3Catalog_universal_d_ListSectionsOptions = ListSectionsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_createMenu: typeof createMenu;\n const restaurantsCatalogsV3Catalog_universal_d_archiveMenu: typeof archiveMenu;\n type restaurantsCatalogsV3Catalog_universal_d_ArchiveMenuIdentifiers = ArchiveMenuIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_unarchiveMenu: typeof unarchiveMenu;\n type restaurantsCatalogsV3Catalog_universal_d_UnarchiveMenuIdentifiers = UnarchiveMenuIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_archiveSection: typeof archiveSection;\n type restaurantsCatalogsV3Catalog_universal_d_ArchiveSectionIdentifiers = ArchiveSectionIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_removeDishFromSection: typeof removeDishFromSection;\n type restaurantsCatalogsV3Catalog_universal_d_RemoveDishFromSectionIdentifiers = RemoveDishFromSectionIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_createSection: typeof createSection;\n type restaurantsCatalogsV3Catalog_universal_d_CreateSectionIdentifiers = CreateSectionIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_getItem: typeof getItem;\n type restaurantsCatalogsV3Catalog_universal_d_GetItemIdentifiers = GetItemIdentifiers;\n type restaurantsCatalogsV3Catalog_universal_d_GetItemOptions = GetItemOptions;\n const restaurantsCatalogsV3Catalog_universal_d_listItems: typeof listItems;\n type restaurantsCatalogsV3Catalog_universal_d_ListItemsOptions = ListItemsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_updateItem: typeof updateItem;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateItemIdentifiers = UpdateItemIdentifiers;\n type restaurantsCatalogsV3Catalog_universal_d_UpdateItemOptions = UpdateItemOptions;\n const restaurantsCatalogsV3Catalog_universal_d_createDish: typeof createDish;\n type restaurantsCatalogsV3Catalog_universal_d_CreateDishIdentifiers = CreateDishIdentifiers;\n const restaurantsCatalogsV3Catalog_universal_d_createVariation: typeof createVariation;\n const restaurantsCatalogsV3Catalog_universal_d_catalogsBulkCreateVariations: typeof catalogsBulkCreateVariations;\n type restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkCreateVariationsOptions = CatalogsBulkCreateVariationsOptions;\n const restaurantsCatalogsV3Catalog_universal_d_catalogsBulkArchiveMenus: typeof catalogsBulkArchiveMenus;\n type restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkArchiveMenusOptions = CatalogsBulkArchiveMenusOptions;\n const restaurantsCatalogsV3Catalog_universal_d_catalogsBulkCreateDishes: typeof catalogsBulkCreateDishes;\n type restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkCreateDishesOptions = CatalogsBulkCreateDishesOptions;\n const restaurantsCatalogsV3Catalog_universal_d_catalogsBulkCreateSections: typeof catalogsBulkCreateSections;\n type restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkCreateSectionsOptions = CatalogsBulkCreateSectionsOptions;\n namespace restaurantsCatalogsV3Catalog_universal_d {\n export {\n restaurantsCatalogsV3Catalog_universal_d_Catalog as Catalog,\n restaurantsCatalogsV3Catalog_universal_d_CreateDraftCatalogRequest as CreateDraftCatalogRequest,\n restaurantsCatalogsV3Catalog_universal_d_CreateDraftCatalogResponse as CreateDraftCatalogResponse,\n restaurantsCatalogsV3Catalog_universal_d_PublishDraftCatalogRequest as PublishDraftCatalogRequest,\n restaurantsCatalogsV3Catalog_universal_d_PublishDraftCatalogResponse as PublishDraftCatalogResponse,\n restaurantsCatalogsV3Catalog_universal_d_DiscardDraftCatalogRequest as DiscardDraftCatalogRequest,\n restaurantsCatalogsV3Catalog_universal_d_DiscardDraftCatalogResponse as DiscardDraftCatalogResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateVariationsRequest as BulkCreateVariationsRequest,\n restaurantsCatalogsV3Catalog_universal_d_NewVariation as NewVariation,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateVariationsResponse as BulkCreateVariationsResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkItemResult as BulkItemResult,\n restaurantsCatalogsV3Catalog_universal_d_ItemMetadata as ItemMetadata,\n restaurantsCatalogsV3Catalog_universal_d_ApplicationError as ApplicationError,\n restaurantsCatalogsV3Catalog_universal_d_Item as Item,\n Money$2 as Money,\n restaurantsCatalogsV3Catalog_universal_d_Labels as Labels,\n restaurantsCatalogsV3Catalog_universal_d_VisibilityCriteria as VisibilityCriteria,\n FulfillmentType$2 as FulfillmentType,\n restaurantsCatalogsV3Catalog_universal_d_Platform as Platform,\n Availability$4 as Availability,\n TimePeriod$4 as TimePeriod,\n DayOfWeek$4 as DayOfWeek,\n SpecialHourPeriod$4 as SpecialHourPeriod,\n restaurantsCatalogsV3Catalog_universal_d_DishOptions as DishOptions,\n restaurantsCatalogsV3Catalog_universal_d_DishOption as DishOption,\n restaurantsCatalogsV3Catalog_universal_d_DishOptionMethodOneOf as DishOptionMethodOneOf,\n restaurantsCatalogsV3Catalog_universal_d_DishOptionItem as DishOptionItem,\n restaurantsCatalogsV3Catalog_universal_d_Selection as Selection,\n restaurantsCatalogsV3Catalog_universal_d_Extras as Extras,\n restaurantsCatalogsV3Catalog_universal_d_Deselection as Deselection,\n Type$3 as Type,\n restaurantsCatalogsV3Catalog_universal_d_ItemType as ItemType,\n restaurantsCatalogsV3Catalog_universal_d_BulkActionMetadata as BulkActionMetadata,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateItemsRequest as BulkUpdateItemsRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateItemsResponse as BulkUpdateItemsResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateDishesRequest as BulkCreateDishesRequest,\n restaurantsCatalogsV3Catalog_universal_d_CreateDishRequest as CreateDishRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateDishesResponse as BulkCreateDishesResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateMenusRequest as BulkCreateMenusRequest,\n restaurantsCatalogsV3Catalog_universal_d_Menu as Menu,\n restaurantsCatalogsV3Catalog_universal_d_MenuSectionIds as MenuSectionIds,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateMenusResponse as BulkCreateMenusResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkMenuResult as BulkMenuResult,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateMenusRequest as BulkUpdateMenusRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateMenusResponse as BulkUpdateMenusResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateSectionsRequest as BulkCreateSectionsRequest,\n restaurantsCatalogsV3Catalog_universal_d_Section as Section,\n restaurantsCatalogsV3Catalog_universal_d_SectionItemIds as SectionItemIds,\n restaurantsCatalogsV3Catalog_universal_d_CreateSectionRequest as CreateSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateSectionsResponse as BulkCreateSectionsResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkSectionResult as BulkSectionResult,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateSectionsRequest as BulkUpdateSectionsRequest,\n restaurantsCatalogsV3Catalog_universal_d_UpdateSectionRequest as UpdateSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateSectionsResponse as BulkUpdateSectionsResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkArchiveMenusRequest as BulkArchiveMenusRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkArchiveMenusResponse as BulkArchiveMenusResponse,\n restaurantsCatalogsV3Catalog_universal_d_BulkUnarchiveMenusRequest as BulkUnarchiveMenusRequest,\n restaurantsCatalogsV3Catalog_universal_d_BulkUnarchiveMenusResponse as BulkUnarchiveMenusResponse,\n restaurantsCatalogsV3Catalog_universal_d_InvalidateCache as InvalidateCache,\n restaurantsCatalogsV3Catalog_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n restaurantsCatalogsV3Catalog_universal_d_App as App,\n restaurantsCatalogsV3Catalog_universal_d_Page as Page,\n restaurantsCatalogsV3Catalog_universal_d_URI as URI,\n restaurantsCatalogsV3Catalog_universal_d_File as File,\n restaurantsCatalogsV3Catalog_universal_d_CatalogUpdated as CatalogUpdated,\n Discount$2 as Discount,\n DiscountValueOneOf$1 as DiscountValueOneOf,\n DiscountApplyToFilterOneOf$1 as DiscountApplyToFilterOneOf,\n DiscountType$2 as DiscountType,\n SectionIds$1 as SectionIds,\n ItemIds$1 as ItemIds,\n DiscountCondition$1 as DiscountCondition,\n DiscountPlatform$1 as DiscountPlatform,\n Coupon$2 as Coupon,\n restaurantsCatalogsV3Catalog_universal_d_PublishCatalogUpdated as PublishCatalogUpdated,\n restaurantsCatalogsV3Catalog_universal_d_IndexCacheCmd as IndexCacheCmd,\n restaurantsCatalogsV3Catalog_universal_d_CatalogChanged as CatalogChanged,\n restaurantsCatalogsV3Catalog_universal_d_ListCatalogsRequest as ListCatalogsRequest,\n restaurantsCatalogsV3Catalog_universal_d_Sorting as Sorting,\n SortOrder$1 as SortOrder,\n restaurantsCatalogsV3Catalog_universal_d_Paging as Paging,\n restaurantsCatalogsV3Catalog_universal_d_ListCatalogsResponse as ListCatalogsResponse,\n restaurantsCatalogsV3Catalog_universal_d_GetMenuRequest as GetMenuRequest,\n restaurantsCatalogsV3Catalog_universal_d_GetMenuResponse as GetMenuResponse,\n restaurantsCatalogsV3Catalog_universal_d_GetSectionRequest as GetSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_GetSectionResponse as GetSectionResponse,\n restaurantsCatalogsV3Catalog_universal_d_UpdateMenuRequest as UpdateMenuRequest,\n restaurantsCatalogsV3Catalog_universal_d_UpdateMenuResponse as UpdateMenuResponse,\n restaurantsCatalogsV3Catalog_universal_d_V3UpdateSectionRequest as V3UpdateSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_UpdateSectionResponse as UpdateSectionResponse,\n restaurantsCatalogsV3Catalog_universal_d_ListMenusRequest as ListMenusRequest,\n restaurantsCatalogsV3Catalog_universal_d_ListMenusResponse as ListMenusResponse,\n restaurantsCatalogsV3Catalog_universal_d_ListSectionsRequest as ListSectionsRequest,\n restaurantsCatalogsV3Catalog_universal_d_ListSectionsResponse as ListSectionsResponse,\n restaurantsCatalogsV3Catalog_universal_d_CreateMenuRequest as CreateMenuRequest,\n restaurantsCatalogsV3Catalog_universal_d_CreateMenuResponse as CreateMenuResponse,\n restaurantsCatalogsV3Catalog_universal_d_ArchiveMenuRequest as ArchiveMenuRequest,\n restaurantsCatalogsV3Catalog_universal_d_ArchiveMenuResponse as ArchiveMenuResponse,\n restaurantsCatalogsV3Catalog_universal_d_UnarchiveMenuRequest as UnarchiveMenuRequest,\n restaurantsCatalogsV3Catalog_universal_d_UnarchiveMenuResponse as UnarchiveMenuResponse,\n restaurantsCatalogsV3Catalog_universal_d_ArchiveSectionRequest as ArchiveSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_ArchiveSectionResponse as ArchiveSectionResponse,\n restaurantsCatalogsV3Catalog_universal_d_RemoveDishFromSectionRequest as RemoveDishFromSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_RemoveDishFromSectionResponse as RemoveDishFromSectionResponse,\n restaurantsCatalogsV3Catalog_universal_d_V3CreateSectionRequest as V3CreateSectionRequest,\n restaurantsCatalogsV3Catalog_universal_d_CreateSectionResponse as CreateSectionResponse,\n restaurantsCatalogsV3Catalog_universal_d_GetItemRequest as GetItemRequest,\n restaurantsCatalogsV3Catalog_universal_d_GetItemResponse as GetItemResponse,\n restaurantsCatalogsV3Catalog_universal_d_ListItemsRequest as ListItemsRequest,\n restaurantsCatalogsV3Catalog_universal_d_ListItemsResponse as ListItemsResponse,\n restaurantsCatalogsV3Catalog_universal_d_UpdateItemRequest as UpdateItemRequest,\n restaurantsCatalogsV3Catalog_universal_d_UpdateItemResponse as UpdateItemResponse,\n restaurantsCatalogsV3Catalog_universal_d_V3CreateDishRequest as V3CreateDishRequest,\n restaurantsCatalogsV3Catalog_universal_d_CreateDishResponse as CreateDishResponse,\n restaurantsCatalogsV3Catalog_universal_d_CreateVariationRequest as CreateVariationRequest,\n restaurantsCatalogsV3Catalog_universal_d_CreateVariationResponse as CreateVariationResponse,\n restaurantsCatalogsV3Catalog_universal_d_MenuUpdated as MenuUpdated,\n Empty$2 as Empty,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n restaurantsCatalogsV3Catalog_universal_d_createDraftCatalog as createDraftCatalog,\n restaurantsCatalogsV3Catalog_universal_d_publishDraftCatalog as publishDraftCatalog,\n restaurantsCatalogsV3Catalog_universal_d_discardDraftCatalog as discardDraftCatalog,\n restaurantsCatalogsV3Catalog_universal_d_bulkCreateVariations as bulkCreateVariations,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateVariationsOptions as BulkCreateVariationsOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkUpdateItems as bulkUpdateItems,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateItemsOptions as BulkUpdateItemsOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkCreateDishes as bulkCreateDishes,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateDishesOptions as BulkCreateDishesOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkCreateMenus as bulkCreateMenus,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateMenusOptions as BulkCreateMenusOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkUpdateMenus as bulkUpdateMenus,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateMenusOptions as BulkUpdateMenusOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkCreateSections as bulkCreateSections,\n restaurantsCatalogsV3Catalog_universal_d_BulkCreateSectionsOptions as BulkCreateSectionsOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkUpdateSections as bulkUpdateSections,\n restaurantsCatalogsV3Catalog_universal_d_BulkUpdateSectionsOptions as BulkUpdateSectionsOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkArchiveMenus as bulkArchiveMenus,\n restaurantsCatalogsV3Catalog_universal_d_BulkArchiveMenusOptions as BulkArchiveMenusOptions,\n restaurantsCatalogsV3Catalog_universal_d_bulkUnarchiveMenus as bulkUnarchiveMenus,\n restaurantsCatalogsV3Catalog_universal_d_BulkUnarchiveMenusOptions as BulkUnarchiveMenusOptions,\n restaurantsCatalogsV3Catalog_universal_d_listCatalogs as listCatalogs,\n restaurantsCatalogsV3Catalog_universal_d_ListCatalogsOptions as ListCatalogsOptions,\n restaurantsCatalogsV3Catalog_universal_d_getMenu as getMenu,\n restaurantsCatalogsV3Catalog_universal_d_GetMenuIdentifiers as GetMenuIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_getSection as getSection,\n restaurantsCatalogsV3Catalog_universal_d_GetSectionIdentifiers as GetSectionIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_updateMenu as updateMenu,\n restaurantsCatalogsV3Catalog_universal_d_UpdateMenuIdentifiers as UpdateMenuIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_UpdateMenuOptions as UpdateMenuOptions,\n restaurantsCatalogsV3Catalog_universal_d_updateSection as updateSection,\n restaurantsCatalogsV3Catalog_universal_d_UpdateSectionIdentifiers as UpdateSectionIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_UpdateSectionOptions as UpdateSectionOptions,\n restaurantsCatalogsV3Catalog_universal_d_listMenus as listMenus,\n restaurantsCatalogsV3Catalog_universal_d_ListMenusOptions as ListMenusOptions,\n restaurantsCatalogsV3Catalog_universal_d_listSections as listSections,\n restaurantsCatalogsV3Catalog_universal_d_ListSectionsOptions as ListSectionsOptions,\n restaurantsCatalogsV3Catalog_universal_d_createMenu as createMenu,\n restaurantsCatalogsV3Catalog_universal_d_archiveMenu as archiveMenu,\n restaurantsCatalogsV3Catalog_universal_d_ArchiveMenuIdentifiers as ArchiveMenuIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_unarchiveMenu as unarchiveMenu,\n restaurantsCatalogsV3Catalog_universal_d_UnarchiveMenuIdentifiers as UnarchiveMenuIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_archiveSection as archiveSection,\n restaurantsCatalogsV3Catalog_universal_d_ArchiveSectionIdentifiers as ArchiveSectionIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_removeDishFromSection as removeDishFromSection,\n restaurantsCatalogsV3Catalog_universal_d_RemoveDishFromSectionIdentifiers as RemoveDishFromSectionIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_createSection as createSection,\n restaurantsCatalogsV3Catalog_universal_d_CreateSectionIdentifiers as CreateSectionIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_getItem as getItem,\n restaurantsCatalogsV3Catalog_universal_d_GetItemIdentifiers as GetItemIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_GetItemOptions as GetItemOptions,\n restaurantsCatalogsV3Catalog_universal_d_listItems as listItems,\n restaurantsCatalogsV3Catalog_universal_d_ListItemsOptions as ListItemsOptions,\n restaurantsCatalogsV3Catalog_universal_d_updateItem as updateItem,\n restaurantsCatalogsV3Catalog_universal_d_UpdateItemIdentifiers as UpdateItemIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_UpdateItemOptions as UpdateItemOptions,\n restaurantsCatalogsV3Catalog_universal_d_createDish as createDish,\n restaurantsCatalogsV3Catalog_universal_d_CreateDishIdentifiers as CreateDishIdentifiers,\n restaurantsCatalogsV3Catalog_universal_d_createVariation as createVariation,\n restaurantsCatalogsV3Catalog_universal_d_catalogsBulkCreateVariations as catalogsBulkCreateVariations,\n restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkCreateVariationsOptions as CatalogsBulkCreateVariationsOptions,\n restaurantsCatalogsV3Catalog_universal_d_catalogsBulkArchiveMenus as catalogsBulkArchiveMenus,\n restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkArchiveMenusOptions as CatalogsBulkArchiveMenusOptions,\n restaurantsCatalogsV3Catalog_universal_d_catalogsBulkCreateDishes as catalogsBulkCreateDishes,\n restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkCreateDishesOptions as CatalogsBulkCreateDishesOptions,\n restaurantsCatalogsV3Catalog_universal_d_catalogsBulkCreateSections as catalogsBulkCreateSections,\n restaurantsCatalogsV3Catalog_universal_d_CatalogsBulkCreateSectionsOptions as CatalogsBulkCreateSectionsOptions,\n };\n }\n \n /**\n * Customers can use a discount to pay less. Can be an amount or a percentage.\n * You can read more about discounts in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Discount$1 extends DiscountValueOneOf, DiscountApplyToFilterOneOf {\n /** Discount amount. */\n amount?: Money$1;\n /** Discount percentage. */\n percentage?: string | null;\n /** IDs of the sections the discount applies to. */\n sectionIds?: SectionIds;\n /** IDs of the items the discount applies to. **Note:** The items must be of type `dish`. */\n itemIds?: ItemIds;\n /**\n * Discount ID.\n * @readonly\n */\n _id?: string | null;\n /** Discount name. */\n name?: string | null;\n /** Discount description. */\n description?: string | null;\n /** Whether the discount is active. Defaults to `true`. */\n active?: boolean | null;\n /** Discount type. */\n type?: DiscountType$1;\n /**\n * Discount condition.\n * All conditions must be met so that a customer can apply the discount.\n */\n condition?: DiscountCondition;\n }\n /** @oneof */\n interface DiscountValueOneOf {\n /** Discount amount. */\n amount?: Money$1;\n /** Discount percentage. */\n percentage?: string | null;\n }\n /** @oneof */\n interface DiscountApplyToFilterOneOf {\n /** IDs of the sections the discount applies to. */\n sectionIds?: SectionIds;\n /** IDs of the items the discount applies to. **Note:** The items must be of type `dish`. */\n itemIds?: ItemIds;\n }\n enum DiscountType$1 {\n UNSPECIFIED_TYPE = \"UNSPECIFIED_TYPE\",\n OFF_ITEM = \"OFF_ITEM\",\n OFF_ORDER = \"OFF_ORDER\"\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 in decimal string format. For example, `3.99`, `6`, and `10.5` are all accepted values. */\n value?: string;\n /**\n * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * @readonly\n */\n currency?: string;\n /**\n * Monetary amount. This is the number that will be displayed.\n * @internal\n * @readonly\n */\n formattedValue?: string | null;\n }\n interface SectionIds {\n values?: string[];\n }\n interface ItemIds {\n values?: string[];\n }\n interface DiscountCondition {\n /** Which fulfillment types the discount applies to. */\n fulfillmentTypes?: FulfillmentType$1[];\n /** Which ordering platforms the discount applies to. */\n platforms?: DiscountPlatform[];\n /** List of times when the discount is available. */\n availability?: Availability$3;\n /** Minimum order price for the discount. */\n minOrderPrice?: Money$1;\n /**\n * Coupon associated with the discount.\n * @readonly\n */\n coupon?: Coupon$1;\n }\n enum FulfillmentType$1 {\n UNSPECIFIED_FULFILLMENT_TYPE = \"UNSPECIFIED_FULFILLMENT_TYPE\",\n DELIVERY = \"DELIVERY\",\n PICKUP_OR_DINE_IN = \"PICKUP_OR_DINE_IN\"\n }\n enum DiscountPlatform {\n UNSPECIFIED_PLATFORM = \"UNSPECIFIED_PLATFORM\",\n SITE = \"SITE\",\n MOBILE_SITE = \"MOBILE_SITE\",\n CALL_CENTER = \"CALL_CENTER\"\n }\n interface Availability$3 {\n /**\n * Weekly recurring time periods when the entity is available.\n * Limited to 100 time periods.\n */\n periods?: TimePeriod$3[];\n /** Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period. */\n specialHourPeriods?: SpecialHourPeriod$3[];\n }\n /** Weekly recurring time periods when the entity 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-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-24:00, where 24:00 represents\n * midnight at the end of the specified day.\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 enum DayOfWeek$3 {\n UNDEFINED = \"UNDEFINED\",\n SUN = \"SUN\",\n MON = \"MON\",\n TUE = \"TUE\",\n WED = \"WED\",\n THU = \"THU\",\n FRI = \"FRI\",\n SAT = \"SAT\"\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 /** Whether the item is available during the exception. Defaults to `true`. */\n available?: boolean;\n /** Name of the special hour period. In the dashboard, the special hour period is called event. */\n eventName?: string | null;\n }\n interface Coupon$1 {\n /**\n * Whether the customer needs to enter the coupon code to receive the discount. Defaults to `true`.\n * @readonly\n */\n applied?: boolean | null;\n /**\n * Coupon code.\n * @readonly\n */\n code?: string | null;\n }\n interface GetDiscountRequest {\n /** ID of the discount to retrieve. */\n discountId: string;\n /** ID of the catalog the discount belongs to. */\n catalogId: string;\n }\n interface GetDiscountResponse {\n /** Retrieved discount. */\n discount?: Discount$1;\n }\n interface UpdateDiscountRequest {\n /** Discount to update. */\n discount?: Discount$1;\n /** ID of the catalog the discount belongs to. */\n catalogId: string;\n }\n interface UpdateDiscountResponse {\n /** Updated discount. */\n discount?: Discount$1;\n }\n interface CreateDiscountRequest {\n /** Discount to create. */\n discount?: Discount$1;\n /** ID of the catalog the discount belongs to. */\n catalogId: string;\n }\n interface CreateDiscountResponse {\n /** Created discount. */\n discount?: Discount$1;\n }\n interface ListDiscountsRequest {\n /**\n * Filed mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether only active discounts are returned. Defaults to `true`. */\n active?: boolean | null;\n /** ID of the catalog the discounts belong to. */\n catalogId: string;\n }\n interface ListDiscountsResponse {\n /** Retrieved discounts. */\n discounts?: Discount$1[];\n }\n interface AddLoyaltyDiscount {\n locationId?: string | null;\n }\n interface Empty$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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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$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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 discount.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.discountId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n * @returns Retrieved discount.\n */\n function getDiscount(identifiers: GetDiscountIdentifiers): Promise;\n interface GetDiscountIdentifiers {\n /** ID of the catalog the discount belongs to. */\n catalogId: string;\n /** ID of the discount to retrieve. */\n discountId: string;\n }\n /**\n * Updates a discount.\n * A discount can belong to a catalog, section, or dish. You can't create a discount that applies to a menu.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.catalogId\n * @requiredField identifiers.discountId\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n * @returns Updated discount.\n */\n function updateDiscount(identifiers: UpdateDiscountIdentifiers, options?: UpdateDiscountOptions): Promise;\n interface UpdateDiscountIdentifiers {\n /** ID of the catalog the discount belongs to. */\n catalogId: string;\n /**\n * Discount ID.\n * @readonly\n */\n discountId?: string | null;\n }\n interface UpdateDiscountOptions {\n discount: {\n /** Discount amount. */\n amount?: Money$1;\n /** Discount percentage. */\n percentage?: string | null;\n /** IDs of the sections the discount applies to. */\n sectionIds?: SectionIds;\n /** IDs of the items the discount applies to. **Note:** The items must be of type `dish`. */\n itemIds?: ItemIds;\n /**\n * Discount ID.\n * @readonly\n */\n _id?: string | null;\n /** Discount name. */\n name?: string | null;\n /** Discount description. */\n description?: string | null;\n /** Whether the discount is active. Defaults to `true`. */\n active?: boolean | null;\n /** Discount type. */\n type?: DiscountType$1;\n /**\n * Discount condition.\n * All conditions must be met so that a customer can apply the discount.\n */\n condition?: DiscountCondition;\n };\n }\n /**\n * Creates a discount.\n * You can create discounts for catalogs, sections, or dishes. You can't create a discount that applies to a menu.\n * @param catalogId - ID of the catalog the discount belongs to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @requiredField options\n * @requiredField options.discount\n * @requiredField options.discount.active\n * @requiredField options.discount.condition.fulfillmentTypes\n * @requiredField options.discount.condition.minOrderPrice\n * @requiredField options.discount.condition.platforms\n * @requiredField options.discount.name\n * @permissionId WIX_RESTAURANTS.MANAGE_CATALOGS\n * @adminMethod\n * @returns Created discount.\n */\n function createDiscount(catalogId: string, options: CreateDiscountOptions): Promise;\n interface CreateDiscountOptions {\n /** Discount to create. */\n discount?: Discount$1;\n }\n /**\n * Retrieves up to 1000 discounts.\n * @param catalogId - ID of the catalog the discounts belong to.\n * @public\n * @documentationMaturity preview\n * @requiredField catalogId\n * @permissionId WIX_RESTAURANTS.READ_CATALOGS\n */\n function listDiscounts(catalogId: string, options?: ListDiscountsOptions): Promise;\n interface ListDiscountsOptions {\n /**\n * Filed mask path.\n * @internal\n */\n fieldMask?: string[];\n /** Whether only active discounts are returned. Defaults to `true`. */\n active?: boolean | null;\n }\n \n type restaurantsCatalogsV3Discount_universal_d_DiscountValueOneOf = DiscountValueOneOf;\n type restaurantsCatalogsV3Discount_universal_d_DiscountApplyToFilterOneOf = DiscountApplyToFilterOneOf;\n type restaurantsCatalogsV3Discount_universal_d_SectionIds = SectionIds;\n type restaurantsCatalogsV3Discount_universal_d_ItemIds = ItemIds;\n type restaurantsCatalogsV3Discount_universal_d_DiscountCondition = DiscountCondition;\n type restaurantsCatalogsV3Discount_universal_d_DiscountPlatform = DiscountPlatform;\n const restaurantsCatalogsV3Discount_universal_d_DiscountPlatform: typeof DiscountPlatform;\n type restaurantsCatalogsV3Discount_universal_d_GetDiscountRequest = GetDiscountRequest;\n type restaurantsCatalogsV3Discount_universal_d_GetDiscountResponse = GetDiscountResponse;\n type restaurantsCatalogsV3Discount_universal_d_UpdateDiscountRequest = UpdateDiscountRequest;\n type restaurantsCatalogsV3Discount_universal_d_UpdateDiscountResponse = UpdateDiscountResponse;\n type restaurantsCatalogsV3Discount_universal_d_CreateDiscountRequest = CreateDiscountRequest;\n type restaurantsCatalogsV3Discount_universal_d_CreateDiscountResponse = CreateDiscountResponse;\n type restaurantsCatalogsV3Discount_universal_d_ListDiscountsRequest = ListDiscountsRequest;\n type restaurantsCatalogsV3Discount_universal_d_ListDiscountsResponse = ListDiscountsResponse;\n type restaurantsCatalogsV3Discount_universal_d_AddLoyaltyDiscount = AddLoyaltyDiscount;\n type restaurantsCatalogsV3Discount_universal_d_RestoreInfo = RestoreInfo;\n const restaurantsCatalogsV3Discount_universal_d_getDiscount: typeof getDiscount;\n type restaurantsCatalogsV3Discount_universal_d_GetDiscountIdentifiers = GetDiscountIdentifiers;\n const restaurantsCatalogsV3Discount_universal_d_updateDiscount: typeof updateDiscount;\n type restaurantsCatalogsV3Discount_universal_d_UpdateDiscountIdentifiers = UpdateDiscountIdentifiers;\n type restaurantsCatalogsV3Discount_universal_d_UpdateDiscountOptions = UpdateDiscountOptions;\n const restaurantsCatalogsV3Discount_universal_d_createDiscount: typeof createDiscount;\n type restaurantsCatalogsV3Discount_universal_d_CreateDiscountOptions = CreateDiscountOptions;\n const restaurantsCatalogsV3Discount_universal_d_listDiscounts: typeof listDiscounts;\n type restaurantsCatalogsV3Discount_universal_d_ListDiscountsOptions = ListDiscountsOptions;\n namespace restaurantsCatalogsV3Discount_universal_d {\n export {\n Discount$1 as Discount,\n restaurantsCatalogsV3Discount_universal_d_DiscountValueOneOf as DiscountValueOneOf,\n restaurantsCatalogsV3Discount_universal_d_DiscountApplyToFilterOneOf as DiscountApplyToFilterOneOf,\n DiscountType$1 as DiscountType,\n Money$1 as Money,\n restaurantsCatalogsV3Discount_universal_d_SectionIds as SectionIds,\n restaurantsCatalogsV3Discount_universal_d_ItemIds as ItemIds,\n restaurantsCatalogsV3Discount_universal_d_DiscountCondition as DiscountCondition,\n FulfillmentType$1 as FulfillmentType,\n restaurantsCatalogsV3Discount_universal_d_DiscountPlatform as DiscountPlatform,\n Availability$3 as Availability,\n TimePeriod$3 as TimePeriod,\n DayOfWeek$3 as DayOfWeek,\n SpecialHourPeriod$3 as SpecialHourPeriod,\n Coupon$1 as Coupon,\n restaurantsCatalogsV3Discount_universal_d_GetDiscountRequest as GetDiscountRequest,\n restaurantsCatalogsV3Discount_universal_d_GetDiscountResponse as GetDiscountResponse,\n restaurantsCatalogsV3Discount_universal_d_UpdateDiscountRequest as UpdateDiscountRequest,\n restaurantsCatalogsV3Discount_universal_d_UpdateDiscountResponse as UpdateDiscountResponse,\n restaurantsCatalogsV3Discount_universal_d_CreateDiscountRequest as CreateDiscountRequest,\n restaurantsCatalogsV3Discount_universal_d_CreateDiscountResponse as CreateDiscountResponse,\n restaurantsCatalogsV3Discount_universal_d_ListDiscountsRequest as ListDiscountsRequest,\n restaurantsCatalogsV3Discount_universal_d_ListDiscountsResponse as ListDiscountsResponse,\n restaurantsCatalogsV3Discount_universal_d_AddLoyaltyDiscount as AddLoyaltyDiscount,\n Empty$1 as Empty,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n restaurantsCatalogsV3Discount_universal_d_RestoreInfo as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n restaurantsCatalogsV3Discount_universal_d_getDiscount as getDiscount,\n restaurantsCatalogsV3Discount_universal_d_GetDiscountIdentifiers as GetDiscountIdentifiers,\n restaurantsCatalogsV3Discount_universal_d_updateDiscount as updateDiscount,\n restaurantsCatalogsV3Discount_universal_d_UpdateDiscountIdentifiers as UpdateDiscountIdentifiers,\n restaurantsCatalogsV3Discount_universal_d_UpdateDiscountOptions as UpdateDiscountOptions,\n restaurantsCatalogsV3Discount_universal_d_createDiscount as createDiscount,\n restaurantsCatalogsV3Discount_universal_d_CreateDiscountOptions as CreateDiscountOptions,\n restaurantsCatalogsV3Discount_universal_d_listDiscounts as listDiscounts,\n restaurantsCatalogsV3Discount_universal_d_ListDiscountsOptions as ListDiscountsOptions,\n };\n }\n \n /**\n * FulfillmentMethod is the main entity of FulfillmentMethods that can be used to enable restaurant\n * to configure the supported fulfillment methods.\n */\n interface FulfillmentMethod extends FulfillmentMethodMethodInfoOneOf {\n /** Delivery info */\n deliveryInfo?: DeliveryInfo;\n /** Pickup info */\n pickupInfo?: PickupInfo$1;\n /** DineIn info */\n dineInInfo?: DineInInfo;\n /** Fulfillment Id */\n _id?: string | null;\n /** Fulfillment type. */\n type?: FulfillmentMethodType;\n /** The restaurantLocation id this fulfillment method is related to */\n restaurantLocationId?: string | null;\n /** Whether the fulfillment method is active or not - Defaults to `false` */\n enabled?: boolean;\n /** Time periods when the entity is available. */\n availability?: Availability$2;\n /**\n * Current state of this fulfillment method.\n * Each time the fulfillment method is modified, its `revision` changes.\n */\n revision?: string | null;\n }\n /** @oneof */\n interface FulfillmentMethodMethodInfoOneOf {\n /** Delivery info */\n deliveryInfo?: DeliveryInfo;\n /** Pickup info */\n pickupInfo?: PickupInfo$1;\n /** DineIn info */\n dineInInfo?: DineInInfo;\n }\n enum FulfillmentMethodType {\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 /** DineIn */\n DINE_IN = \"DINE_IN\"\n }\n interface Availability$2 {\n /** Weekly recurring time periods when the entity is available. Limited to 100 time periods. */\n periods?: TimePeriod$2[];\n /** Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period. */\n specialHourPeriods?: SpecialHourPeriod$2[];\n }\n /** Weekly recurring time periods when the entity 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.orgwikiISO_8601) extended format. Valid values are 00:00-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.orgwikiISO_8601) extended format. Valid values are 00:00-24:00, where 24:00 represents\n * midnight at the end of the specified day.\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 enum DayOfWeek$2 {\n MON = \"MON\",\n TUE = \"TUE\",\n WED = \"WED\",\n THU = \"THU\",\n FRI = \"FRI\",\n SAT = \"SAT\",\n SUN = \"SUN\"\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.orgwikiISO_8601) format and [Coordinated Universal Time (UTC)](https:en.wikipedia.orgwikiCoordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https:en.wikipedia.orgwikiISO_8601) format and [Coordinated Universal Time (UTC)](https:en.wikipedia.orgwikiCoordinated_Universal_Time). */\n endDate?: string;\n /** Whether the item is available during the exception. Defaults to `false`. */\n available?: boolean;\n /** Name of the special hour period. In the Business Manager the special hour period is called event. */\n eventName?: string | null;\n }\n interface DeliveryInfo extends DeliveryInfoProviderOneOf {\n /** Delivery through the restaurant. */\n restaurant?: Restaurant$1;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider$1;\n /** Delivery name */\n name?: string | null;\n /** Estimated delivery time */\n deliveryTime?: number | null;\n /** fulfillment method fee */\n fee?: string | null;\n /** Delivery time display unit */\n deliveryTimeDisplayUnit?: TimeDisplayUnit;\n /** The minimum amount of the order for using this fulfillment method. */\n minimumOrderAmount?: string | null;\n }\n /** @oneof */\n interface DeliveryInfoProviderOneOf {\n /** Delivery through the restaurant. */\n restaurant?: Restaurant$1;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider$1;\n }\n interface Restaurant$1 {\n /** Delivery range details */\n deliveryRange?: DeliveryRange;\n }\n interface DeliveryRange extends DeliveryRangeValueOneOf {\n /** radius of the delivery area from the location of the branch. */\n radiusDetails?: RadiusDetails;\n /** radius of the delivery area */\n postalCodeDetails?: PostalCodeDetails;\n /** Custom delivery range */\n customDetails?: CustomDetails;\n /** Area shape type */\n type?: Type$2;\n }\n /** @oneof */\n interface DeliveryRangeValueOneOf {\n /** radius of the delivery area from the location of the branch. */\n radiusDetails?: RadiusDetails;\n /** radius of the delivery area */\n postalCodeDetails?: PostalCodeDetails;\n /** Custom delivery range */\n customDetails?: CustomDetails;\n }\n enum Type$2 {\n UNDEFINED = \"UNDEFINED\",\n RADIUS = \"RADIUS\",\n POSTAL_CODE = \"POSTAL_CODE\",\n CUSTOM = \"CUSTOM\"\n }\n interface RadiusDetails {\n /** radius of the delivery area from the location of the branch. */\n radius?: string | null;\n /** Geocodes of the delivery area */\n geocode?: AddressLocation$1;\n }\n interface AddressLocation$1 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface PostalCodeDetails {\n /** address of the delivery area */\n postalCode?: string | null;\n /**\n * Country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n * @readonly\n */\n countryCode?: string | null;\n }\n interface CustomDetails {\n /** Geocodes of the delivery area */\n geocodes?: AddressLocation$1[];\n }\n interface ExternalProvider$1 {\n /** Restaurant configuration id */\n configurationId?: string;\n /** Fee paid by the restaurant to the external delivery provider. */\n commission?: string | null;\n /** Pickup instructions of the order from the restaurant for the delivery provider */\n pickupInstructions?: string | null;\n }\n enum TimeDisplayUnit {\n UNDEFINED = \"UNDEFINED\",\n MINUTES = \"MINUTES\",\n HOURS = \"HOURS\",\n DAYS = \"DAYS\"\n }\n interface PickupInfo$1 {\n /** Curbside info */\n curbsideInfo?: CurbsideInfo;\n /** Estimated preparation time */\n prepTime?: number | null;\n /** The minimum amount of the order for using this fulfillment method. */\n minimumOrderAmount?: string | null;\n }\n interface CurbsideInfo {\n /** Whether curbside method is active or not - Defaults to `false` */\n enabled?: boolean;\n /** Curbside pickup instructions. Customers will see these instructions when placing their order. */\n instructions?: string | null;\n /** Additional informational field label. Customers will be required to fill in this field during checkout. */\n additionalInfoLabel?: string | null;\n /** Is the additional information field required */\n additionalInfoLabelRequired?: boolean | null;\n }\n interface DineInInfo {\n /**\n * Estimated preparation time\n * @readonly\n */\n prepTime?: number | null;\n /**\n * DineIn instructions. Customers will see these instructions during checkout.\n * Example: Add your table number to place your order. We'll bring the order to you once ready.\n */\n instructions?: string | null;\n /**\n * Informational field label. Customers will be asked to fill this out while placing their order.\n * Example: Table Number\n */\n additionalInfoLabel?: string | null;\n /**\n * The minimum amount of the order for using this fulfillment method.\n * @readonly\n */\n minimumOrderAmount?: string | null;\n }\n interface CreateFulfillmentMethodRequest {\n /** FulfillmentMethod to be created */\n fulfillmentMethod: FulfillmentMethod;\n }\n interface CreateFulfillmentMethodResponse {\n /** The created FulfillmentMethod */\n fulfillmentMethod?: FulfillmentMethod;\n }\n interface GetFulfillmentMethodRequest {\n /** Id of the FulfillmentMethod to retrieve */\n fulfillmentMethodId: string;\n }\n interface GetFulfillmentMethodResponse {\n /** The retrieved FulfillmentMethod */\n fulfillmentMethod?: FulfillmentMethod;\n }\n interface UpdateFulfillmentMethodRequest {\n /** FulfillmentMethod to be updated, may be partial */\n fulfillmentMethod: FulfillmentMethod;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateFulfillmentMethodResponse {\n /** The updated FulfillmentMethod */\n fulfillmentMethod?: FulfillmentMethod;\n }\n interface DeleteFulfillmentMethodRequest {\n /** Id of the FulfillmentMethod to delete */\n fulfillmentMethodId: string;\n }\n interface DeleteFulfillmentMethodResponse {\n }\n interface ListFulfillmentMethodsRequest {\n /** restaurant location ids */\n restaurantLocationIds?: string[] | null;\n }\n interface ListFulfillmentMethodsResponse {\n /** The retrieved fulfillment methods */\n fulfillmentMethods?: FulfillmentMethod[];\n }\n interface FindBestDeliveryAreaRequest {\n /** restaurant location id */\n restaurantLocationId?: string | null;\n /** order geocodes of the delivery area */\n geocode?: AddressLocation$1;\n /** order amount */\n orderAmount?: string | null;\n /** order delivery time */\n deliveryTime?: Date | null;\n /** category by which best delivery area is selected */\n bestDeliveryByCategory?: BestDeliveryByCategory;\n }\n enum BestDeliveryByCategory {\n /** minimum delivery fee */\n DELIVERY_FEE = \"DELIVERY_FEE\"\n }\n interface FindBestDeliveryAreaResponse {\n /** delivery info */\n deliveryInfo?: DeliveryInfo;\n }\n /**\n * Creates a new FulfillmentMethod\n * @param fulfillmentMethod - FulfillmentMethod to be created\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillmentMethod\n * @requiredField fulfillmentMethod.restaurantLocationId\n * @permissionId WIX_RESTAURANTS.FULFILLMENT_METHODS_WRITE\n * @adminMethod\n * @returns The created FulfillmentMethod\n */\n function createFulfillmentMethod(fulfillmentMethod: FulfillmentMethod): Promise;\n /**\n * Get a FulfillmentMethod by id\n * @param fulfillmentMethodId - Id of the FulfillmentMethod to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillmentMethodId\n * @permissionId WIX_RESTAURANTS.FULFILLMENT_METHODS_READ\n * @returns The retrieved FulfillmentMethod\n */\n function getFulfillmentMethod(fulfillmentMethodId: string): Promise;\n /**\n * Update a FulfillmentMethod, supports partial update\n * @param _id - Fulfillment Id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField fulfillmentMethod\n * @permissionId WIX_RESTAURANTS.FULFILLMENT_METHODS_WRITE\n * @adminMethod\n * @returns The updated FulfillmentMethod\n */\n function updateFulfillmentMethod(_id: string | null, fulfillmentMethod: UpdateFulfillmentMethod, options?: UpdateFulfillmentMethodOptions): Promise;\n interface UpdateFulfillmentMethod {\n /** Delivery info */\n deliveryInfo?: DeliveryInfo;\n /** Pickup info */\n pickupInfo?: PickupInfo$1;\n /** DineIn info */\n dineInInfo?: DineInInfo;\n /** Fulfillment Id */\n _id?: string | null;\n /** Fulfillment type. */\n type?: FulfillmentMethodType;\n /** The restaurantLocation id this fulfillment method is related to */\n restaurantLocationId?: string | null;\n /** Whether the fulfillment method is active or not - Defaults to `false` */\n enabled?: boolean;\n /** Time periods when the entity is available. */\n availability?: Availability$2;\n /**\n * Current state of this fulfillment method.\n * Each time the fulfillment method is modified, its `revision` changes.\n */\n revision?: string | null;\n }\n interface UpdateFulfillmentMethodOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Delete a FulfillmentMethod\n * @param fulfillmentMethodId - Id of the FulfillmentMethod to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillmentMethodId\n * @permissionId WIX_RESTAURANTS.FULFILLMENT_METHODS_WRITE\n * @adminMethod\n */\n function deleteFulfillmentMethod(fulfillmentMethodId: string): Promise;\n /**\n * List Fulfillment Methods\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.FULFILLMENT_METHODS_READ\n */\n function listFulfillmentMethods(options?: ListFulfillmentMethodsOptions): Promise;\n interface ListFulfillmentMethodsOptions {\n /** restaurant location ids */\n restaurantLocationIds?: string[] | null;\n }\n /**\n * Find the best delivery area for a geocoded order address\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.FULFILLMENT_METHODS_READ\n */\n function findBestDeliveryArea(options?: FindBestDeliveryAreaOptions): Promise;\n interface FindBestDeliveryAreaOptions {\n /** restaurant location id */\n restaurantLocationId?: string | null;\n /** order geocodes of the delivery area */\n geocode?: AddressLocation$1;\n /** order amount */\n orderAmount?: string | null;\n /** order delivery time */\n deliveryTime?: Date | null;\n /** category by which best delivery area is selected */\n bestDeliveryByCategory?: BestDeliveryByCategory;\n }\n \n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethod = FulfillmentMethod;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethodMethodInfoOneOf = FulfillmentMethodMethodInfoOneOf;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethodType = FulfillmentMethodType;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethodType: typeof FulfillmentMethodType;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryInfo = DeliveryInfo;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryInfoProviderOneOf = DeliveryInfoProviderOneOf;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryRange = DeliveryRange;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryRangeValueOneOf = DeliveryRangeValueOneOf;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_RadiusDetails = RadiusDetails;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_PostalCodeDetails = PostalCodeDetails;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CustomDetails = CustomDetails;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_TimeDisplayUnit = TimeDisplayUnit;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_TimeDisplayUnit: typeof TimeDisplayUnit;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CurbsideInfo = CurbsideInfo;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DineInInfo = DineInInfo;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CreateFulfillmentMethodRequest = CreateFulfillmentMethodRequest;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CreateFulfillmentMethodResponse = CreateFulfillmentMethodResponse;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_GetFulfillmentMethodRequest = GetFulfillmentMethodRequest;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_GetFulfillmentMethodResponse = GetFulfillmentMethodResponse;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethodRequest = UpdateFulfillmentMethodRequest;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethodResponse = UpdateFulfillmentMethodResponse;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeleteFulfillmentMethodRequest = DeleteFulfillmentMethodRequest;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeleteFulfillmentMethodResponse = DeleteFulfillmentMethodResponse;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_ListFulfillmentMethodsRequest = ListFulfillmentMethodsRequest;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_ListFulfillmentMethodsResponse = ListFulfillmentMethodsResponse;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FindBestDeliveryAreaRequest = FindBestDeliveryAreaRequest;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_BestDeliveryByCategory = BestDeliveryByCategory;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_BestDeliveryByCategory: typeof BestDeliveryByCategory;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FindBestDeliveryAreaResponse = FindBestDeliveryAreaResponse;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_createFulfillmentMethod: typeof createFulfillmentMethod;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_getFulfillmentMethod: typeof getFulfillmentMethod;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_updateFulfillmentMethod: typeof updateFulfillmentMethod;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethod = UpdateFulfillmentMethod;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethodOptions = UpdateFulfillmentMethodOptions;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_deleteFulfillmentMethod: typeof deleteFulfillmentMethod;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_listFulfillmentMethods: typeof listFulfillmentMethods;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_ListFulfillmentMethodsOptions = ListFulfillmentMethodsOptions;\n const restaurantsFulfillmentsV3FulfillmentMethod_universal_d_findBestDeliveryArea: typeof findBestDeliveryArea;\n type restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FindBestDeliveryAreaOptions = FindBestDeliveryAreaOptions;\n namespace restaurantsFulfillmentsV3FulfillmentMethod_universal_d {\n export {\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethod as FulfillmentMethod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethodMethodInfoOneOf as FulfillmentMethodMethodInfoOneOf,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FulfillmentMethodType as FulfillmentMethodType,\n Availability$2 as Availability,\n TimePeriod$2 as TimePeriod,\n DayOfWeek$2 as DayOfWeek,\n SpecialHourPeriod$2 as SpecialHourPeriod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryInfo as DeliveryInfo,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryInfoProviderOneOf as DeliveryInfoProviderOneOf,\n Restaurant$1 as Restaurant,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryRange as DeliveryRange,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeliveryRangeValueOneOf as DeliveryRangeValueOneOf,\n Type$2 as Type,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_RadiusDetails as RadiusDetails,\n AddressLocation$1 as AddressLocation,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_PostalCodeDetails as PostalCodeDetails,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CustomDetails as CustomDetails,\n ExternalProvider$1 as ExternalProvider,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_TimeDisplayUnit as TimeDisplayUnit,\n PickupInfo$1 as PickupInfo,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CurbsideInfo as CurbsideInfo,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DineInInfo as DineInInfo,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CreateFulfillmentMethodRequest as CreateFulfillmentMethodRequest,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_CreateFulfillmentMethodResponse as CreateFulfillmentMethodResponse,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_GetFulfillmentMethodRequest as GetFulfillmentMethodRequest,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_GetFulfillmentMethodResponse as GetFulfillmentMethodResponse,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethodRequest as UpdateFulfillmentMethodRequest,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethodResponse as UpdateFulfillmentMethodResponse,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeleteFulfillmentMethodRequest as DeleteFulfillmentMethodRequest,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_DeleteFulfillmentMethodResponse as DeleteFulfillmentMethodResponse,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_ListFulfillmentMethodsRequest as ListFulfillmentMethodsRequest,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_ListFulfillmentMethodsResponse as ListFulfillmentMethodsResponse,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FindBestDeliveryAreaRequest as FindBestDeliveryAreaRequest,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_BestDeliveryByCategory as BestDeliveryByCategory,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FindBestDeliveryAreaResponse as FindBestDeliveryAreaResponse,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_createFulfillmentMethod as createFulfillmentMethod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_getFulfillmentMethod as getFulfillmentMethod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_updateFulfillmentMethod as updateFulfillmentMethod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethod as UpdateFulfillmentMethod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_UpdateFulfillmentMethodOptions as UpdateFulfillmentMethodOptions,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_deleteFulfillmentMethod as deleteFulfillmentMethod,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_listFulfillmentMethods as listFulfillmentMethods,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_ListFulfillmentMethodsOptions as ListFulfillmentMethodsOptions,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_findBestDeliveryArea as findBestDeliveryArea,\n restaurantsFulfillmentsV3FulfillmentMethod_universal_d_FindBestDeliveryAreaOptions as FindBestDeliveryAreaOptions,\n };\n }\n \n /** OrderSettings is the main entity of OrderSettings service */\n interface OrderSettings {\n /** Order Settings id */\n _id?: string | null;\n /** Restaurant location id */\n restaurantLocationId?: string | null;\n /** Is Order settings enabled - customers can order through the system */\n enabled?: boolean | null;\n /**\n * should we send a confirmation email to the UOU on new order. default true\n * @internal\n */\n sendOrderConfirmationEmail?: boolean | null;\n /** if UOU need to provide a valid google maps address */\n approximateAddresses?: ApproximateAddresses;\n /** Local regulations may require you to add a policy document to your site. */\n policies?: Policies;\n tips?: Tips;\n futureOrders?: FutureOrdersSettings;\n /** Represents only exceptions of when the user wants to turn off the online ordering for a period of time */\n availability?: Availability$1;\n revision?: string | null;\n /** Restaurant charge rounding strategy */\n chargeRoundingStrategy?: ChargeRoundingStrategy;\n }\n enum ApproximateAddresses {\n EMPTY = \"EMPTY\",\n BLOCK = \"BLOCK\",\n ALLOW = \"ALLOW\"\n }\n /** Local regulations may require you to add a policy document to your site. */\n interface Policies {\n /** Privacy policy */\n privacyPolicy?: Policy;\n /** Terms and Conditions */\n termsAndConditions?: Policy;\n /** Is the Policies feature enabled, default value false */\n enabled?: boolean;\n /** Is the checkbox of the policy agreement marked by default */\n checkedByDefault?: boolean | null;\n }\n interface Policy {\n /** Default Policy type */\n defaultType?: Type$1;\n text?: string | null;\n url?: string | null;\n }\n enum Type$1 {\n /** Add a page to your site and put your policy document there. You can link to it from here. */\n URL = \"URL\",\n /** The policy will be displayed as plain text in a popup. */\n TEXT = \"TEXT\"\n }\n /** Customers can leave a tip when placing an order. */\n interface Tips {\n /** Allow customers to leave a custom tips, default `false` */\n allowCustom?: boolean | null;\n /** tip type to display */\n displayType?: TipsType;\n /** Set different tipping suggestion options with exact amounts, for your customers to choose from */\n suggestedAmounts?: TippingRate[];\n /** Set different tipping rate options with percentage values, for your customers to choose from */\n suggestedPercentages?: TippingRate[];\n /** Is the Tips feature enabled, default value false */\n enabled?: boolean;\n }\n enum TipsType {\n /** Tip with exact amount ($) */\n AMOUNT = \"AMOUNT\",\n /** Tip in percentage */\n PERCENTAGE = \"PERCENTAGE\"\n }\n interface TippingRate {\n /** Can be exact amount or percentage */\n value?: string;\n /** Is default option */\n default?: boolean;\n }\n interface FutureOrdersSettings {\n /** Is Future Orders enabled */\n enabled?: boolean | null;\n /** latest time in advance in minutes that customers can place an order */\n latestOrderBy?: number | null;\n /** earliest time in advance in minutes that customers can place an order */\n earliestOrderBy?: number | null;\n /**\n * How much time before order delivery to show it in the list, controlled from the advanced options\n * @internal\n */\n displayOrderInAdvanceTime?: number | null;\n /** Allow asap orders or not. If false, only future orders are allowed */\n enableAsapOrders?: boolean | null;\n }\n interface Availability$1 {\n /** Weekly recurring time periods when the entity is available. Limited to 100 time periods. */\n periods?: TimePeriod$1[];\n /** Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period. */\n specialHourPeriods?: SpecialHourPeriod$1[];\n }\n /** Weekly recurring time periods when the entity 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.orgwikiISO_8601) extended format. Valid values are 00:00-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.orgwikiISO_8601) extended format. Valid values are 00:00-24:00, where 24:00 represents\n * midnight at the end of the specified day.\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 enum DayOfWeek$1 {\n MON = \"MON\",\n TUE = \"TUE\",\n WED = \"WED\",\n THU = \"THU\",\n FRI = \"FRI\",\n SAT = \"SAT\",\n SUN = \"SUN\"\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.orgwikiISO_8601) format and [Coordinated Universal Time (UTC)](https:en.wikipedia.orgwikiCoordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https:en.wikipedia.orgwikiISO_8601) format and [Coordinated Universal Time (UTC)](https:en.wikipedia.orgwikiCoordinated_Universal_Time). */\n endDate?: string;\n /** Whether the item is available during the exception. Defaults to `false`. */\n available?: boolean;\n /** Name of the special hour period. In the Business Manager the special hour period is called event. */\n eventName?: string | null;\n }\n enum ChargeRoundingStrategy {\n UNDEFINED = \"UNDEFINED\",\n /** https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero */\n HALF_AWAY_FROM_ZERO = \"HALF_AWAY_FROM_ZERO\",\n /** https://en.wikipedia.org/wiki/Rounding#Round_half_to_even */\n HALF_EVEN = \"HALF_EVEN\"\n }\n interface GetOrderSettingsRequest {\n /** Id of the OrderSettings to retrieve */\n orderSettingsId: string;\n }\n interface GetOrderSettingsResponse {\n /** The retrieved OrderSettings */\n orderSettings?: OrderSettings;\n }\n interface UpdateOrderSettingsRequest {\n /** OrderSettings to be updated, may be partial */\n orderSettings: OrderSettings;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateOrderSettingsResponse {\n /** The updated OrderSettings */\n orderSettings?: OrderSettings;\n }\n interface ListOrderSettingsRequest {\n /** Ids of the restaurant locations for the OrderSettings to retrieve */\n restaurantLocationIds?: string[];\n }\n interface ListOrderSettingsResponse {\n /** The retrieved order settings */\n orderSettings?: OrderSettings[];\n }\n /**\n * Get a OrderSettings by id\n * @param orderSettingsId - Id of the OrderSettings to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField orderSettingsId\n * @permissionId WIX_RESTAURANTS.READ_ORDER_SETTINGS\n * @returns The retrieved OrderSettings\n */\n function getOrderSettings(orderSettingsId: string): Promise;\n /**\n * Update a OrderSettings, supports partial update\n * @param _id - Order Settings id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField orderSettings\n * @requiredField orderSettings.revision\n * @permissionId WIX_RESTAURANTS.MANAGE_ORDER_SETTINGS\n * @adminMethod\n * @returns The updated OrderSettings\n */\n function updateOrderSettings(_id: string | null, orderSettings: UpdateOrderSettings, options?: UpdateOrderSettingsOptions): Promise;\n interface UpdateOrderSettings {\n /** Order Settings id */\n _id?: string | null;\n /** Restaurant location id */\n restaurantLocationId?: string | null;\n /** Is Order settings enabled - customers can order through the system */\n enabled?: boolean | null;\n /**\n * should we send a confirmation email to the UOU on new order. default true\n * @internal\n */\n sendOrderConfirmationEmail?: boolean | null;\n /** if UOU need to provide a valid google maps address */\n approximateAddresses?: ApproximateAddresses;\n /** Local regulations may require you to add a policy document to your site. */\n policies?: Policies;\n tips?: Tips;\n futureOrders?: FutureOrdersSettings;\n /** Represents only exceptions of when the user wants to turn off the online ordering for a period of time */\n availability?: Availability$1;\n revision?: string | null;\n /** Restaurant charge rounding strategy */\n chargeRoundingStrategy?: ChargeRoundingStrategy;\n }\n interface UpdateOrderSettingsOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * List Order settings\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_ORDER_SETTINGS\n */\n function listOrderSettings(options?: ListOrderSettingsOptions): Promise;\n interface ListOrderSettingsOptions {\n /** Ids of the restaurant locations for the OrderSettings to retrieve */\n restaurantLocationIds?: string[];\n }\n \n type restaurantsOrdersettingsV3OrderSettings_universal_d_OrderSettings = OrderSettings;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_ApproximateAddresses = ApproximateAddresses;\n const restaurantsOrdersettingsV3OrderSettings_universal_d_ApproximateAddresses: typeof ApproximateAddresses;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_Policies = Policies;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_Policy = Policy;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_Tips = Tips;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_TipsType = TipsType;\n const restaurantsOrdersettingsV3OrderSettings_universal_d_TipsType: typeof TipsType;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_TippingRate = TippingRate;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_FutureOrdersSettings = FutureOrdersSettings;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_ChargeRoundingStrategy = ChargeRoundingStrategy;\n const restaurantsOrdersettingsV3OrderSettings_universal_d_ChargeRoundingStrategy: typeof ChargeRoundingStrategy;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_GetOrderSettingsRequest = GetOrderSettingsRequest;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_GetOrderSettingsResponse = GetOrderSettingsResponse;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettingsRequest = UpdateOrderSettingsRequest;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettingsResponse = UpdateOrderSettingsResponse;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_ListOrderSettingsRequest = ListOrderSettingsRequest;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_ListOrderSettingsResponse = ListOrderSettingsResponse;\n const restaurantsOrdersettingsV3OrderSettings_universal_d_getOrderSettings: typeof getOrderSettings;\n const restaurantsOrdersettingsV3OrderSettings_universal_d_updateOrderSettings: typeof updateOrderSettings;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettings = UpdateOrderSettings;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettingsOptions = UpdateOrderSettingsOptions;\n const restaurantsOrdersettingsV3OrderSettings_universal_d_listOrderSettings: typeof listOrderSettings;\n type restaurantsOrdersettingsV3OrderSettings_universal_d_ListOrderSettingsOptions = ListOrderSettingsOptions;\n namespace restaurantsOrdersettingsV3OrderSettings_universal_d {\n export {\n restaurantsOrdersettingsV3OrderSettings_universal_d_OrderSettings as OrderSettings,\n restaurantsOrdersettingsV3OrderSettings_universal_d_ApproximateAddresses as ApproximateAddresses,\n restaurantsOrdersettingsV3OrderSettings_universal_d_Policies as Policies,\n restaurantsOrdersettingsV3OrderSettings_universal_d_Policy as Policy,\n Type$1 as Type,\n restaurantsOrdersettingsV3OrderSettings_universal_d_Tips as Tips,\n restaurantsOrdersettingsV3OrderSettings_universal_d_TipsType as TipsType,\n restaurantsOrdersettingsV3OrderSettings_universal_d_TippingRate as TippingRate,\n restaurantsOrdersettingsV3OrderSettings_universal_d_FutureOrdersSettings as FutureOrdersSettings,\n Availability$1 as Availability,\n TimePeriod$1 as TimePeriod,\n DayOfWeek$1 as DayOfWeek,\n SpecialHourPeriod$1 as SpecialHourPeriod,\n restaurantsOrdersettingsV3OrderSettings_universal_d_ChargeRoundingStrategy as ChargeRoundingStrategy,\n restaurantsOrdersettingsV3OrderSettings_universal_d_GetOrderSettingsRequest as GetOrderSettingsRequest,\n restaurantsOrdersettingsV3OrderSettings_universal_d_GetOrderSettingsResponse as GetOrderSettingsResponse,\n restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettingsRequest as UpdateOrderSettingsRequest,\n restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettingsResponse as UpdateOrderSettingsResponse,\n restaurantsOrdersettingsV3OrderSettings_universal_d_ListOrderSettingsRequest as ListOrderSettingsRequest,\n restaurantsOrdersettingsV3OrderSettings_universal_d_ListOrderSettingsResponse as ListOrderSettingsResponse,\n restaurantsOrdersettingsV3OrderSettings_universal_d_getOrderSettings as getOrderSettings,\n restaurantsOrdersettingsV3OrderSettings_universal_d_updateOrderSettings as updateOrderSettings,\n restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettings as UpdateOrderSettings,\n restaurantsOrdersettingsV3OrderSettings_universal_d_UpdateOrderSettingsOptions as UpdateOrderSettingsOptions,\n restaurantsOrdersettingsV3OrderSettings_universal_d_listOrderSettings as listOrderSettings,\n restaurantsOrdersettingsV3OrderSettings_universal_d_ListOrderSettingsOptions as ListOrderSettingsOptions,\n };\n }\n \n interface Configuration {\n /** Configuration ID for the location on the Wix site. */\n _id?: string | null;\n /**\n * The corresponding Wix location for the configuration, as defined for the Wix site using the Business Info's [Locations](https://dev.wix.com/api/rest/business-info/locations) and/or [Site Properties](https://dev.wix.com/api/rest/business-info/site-properties) APIs,\n * or using [Dashboard Settings](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).\n */\n location?: Location$1;\n /** Restaurant catalog ID. */\n catalogId?: string;\n /** Whether a configuration is archived. */\n archived?: boolean;\n /** Whether a configuration is enabled. */\n enabled?: boolean;\n /**\n * URL linking to the POS integration settings in the Dashboard\n * if an online POS ordering app is installed.\n */\n integrationSettingsUrl?: string | null;\n }\n interface Location$1 {\n /** The Wix location [name](https://dev.wix.com/api/rest/business-info/locations/location-object). */\n name?: string;\n }\n interface GetConfigurationRequest {\n /** Configuration ID. */\n _id: string;\n }\n interface GetConfigurationResponse {\n /** The merchant's location configuration on Wix. */\n configuration?: Configuration;\n }\n interface ListConfigurationsRequest {\n }\n interface ListConfigurationsResponse {\n /** The merchant's configurations (locations) on Wix. */\n configurations?: Configuration[];\n }\n interface DisconnectAccountRequest {\n /** The app's definition ID. */\n appDefId?: string;\n /** The ID for the account between the merchant and the POS service provider. */\n accountId: string;\n }\n interface DisconnectAccountResponse {\n }\n interface DisconnectConfigurationRequest {\n /** The ID of the merchant's location configuration on Wix. */\n configurationId: string;\n }\n interface DisconnectConfigurationResponse {\n }\n /**\n * This endpoint gets a location configuration by ID on the Wix site.\n * @param _id - Configuration ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_RESTAURANTS.READ_POS\n * @returns The merchant's location configuration on Wix.\n */\n function getConfiguration(_id: string): Promise;\n /**\n * This endpoint retrieves a list of location configurations on the Wix site.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_POS\n */\n function listConfigurations(): Promise;\n /**\n * This endpoint disconnects the account between the merchant and the POS service provider.\n *\n * The account is not deleted. You can reconnect to the account using the POS integration settings in the Dashboard.\n *\n * Call the [List Account IDs](https://dev.wix.com/api/rest/wix-restaurants/point-of-sale-integration/pos-connectivity-spi/list-account-ids) SPI endpoint to retrieve a list of existing account IDs.\n * @param accountId - The ID for the account between the merchant and the POS service provider.\n * @internal\n * @documentationMaturity preview\n * @requiredField accountId\n * @permissionId WIX_RESTAURANTS.WRITE_POS\n * @adminMethod\n */\n function disconnectAccount(accountId: string, options?: DisconnectAccountOptions): Promise;\n interface DisconnectAccountOptions {\n /** The app's definition ID. */\n appDefId?: string;\n }\n /**\n * This endpoint disconnects the Wix location configuration from a POS service provider's location.\n *\n * The configuration is not deleted. You can reconnect to the configuration using the POS integration settings in the Dashboard.\n *\n * Call the [List Configurations](https://dev.wix.com/api/rest/wix-restaurants/point-of-sale-integration/pos-connectivity-api/list-configurations) SPI endpoint to retrieve a list of existing configuration IDs.\n * @param configurationId - The ID of the merchant's location configuration on Wix.\n * @internal\n * @documentationMaturity preview\n * @requiredField configurationId\n * @permissionId WIX_RESTAURANTS.WRITE_POS\n * @adminMethod\n */\n function disconnectConfiguration(configurationId: string): Promise;\n \n type restaurantsPostpaapiV1Configuration_universal_d_Configuration = Configuration;\n type restaurantsPostpaapiV1Configuration_universal_d_GetConfigurationRequest = GetConfigurationRequest;\n type restaurantsPostpaapiV1Configuration_universal_d_GetConfigurationResponse = GetConfigurationResponse;\n type restaurantsPostpaapiV1Configuration_universal_d_ListConfigurationsRequest = ListConfigurationsRequest;\n type restaurantsPostpaapiV1Configuration_universal_d_ListConfigurationsResponse = ListConfigurationsResponse;\n type restaurantsPostpaapiV1Configuration_universal_d_DisconnectAccountRequest = DisconnectAccountRequest;\n type restaurantsPostpaapiV1Configuration_universal_d_DisconnectAccountResponse = DisconnectAccountResponse;\n type restaurantsPostpaapiV1Configuration_universal_d_DisconnectConfigurationRequest = DisconnectConfigurationRequest;\n type restaurantsPostpaapiV1Configuration_universal_d_DisconnectConfigurationResponse = DisconnectConfigurationResponse;\n const restaurantsPostpaapiV1Configuration_universal_d_getConfiguration: typeof getConfiguration;\n const restaurantsPostpaapiV1Configuration_universal_d_listConfigurations: typeof listConfigurations;\n const restaurantsPostpaapiV1Configuration_universal_d_disconnectAccount: typeof disconnectAccount;\n type restaurantsPostpaapiV1Configuration_universal_d_DisconnectAccountOptions = DisconnectAccountOptions;\n const restaurantsPostpaapiV1Configuration_universal_d_disconnectConfiguration: typeof disconnectConfiguration;\n namespace restaurantsPostpaapiV1Configuration_universal_d {\n export {\n restaurantsPostpaapiV1Configuration_universal_d_Configuration as Configuration,\n Location$1 as Location,\n restaurantsPostpaapiV1Configuration_universal_d_GetConfigurationRequest as GetConfigurationRequest,\n restaurantsPostpaapiV1Configuration_universal_d_GetConfigurationResponse as GetConfigurationResponse,\n restaurantsPostpaapiV1Configuration_universal_d_ListConfigurationsRequest as ListConfigurationsRequest,\n restaurantsPostpaapiV1Configuration_universal_d_ListConfigurationsResponse as ListConfigurationsResponse,\n restaurantsPostpaapiV1Configuration_universal_d_DisconnectAccountRequest as DisconnectAccountRequest,\n restaurantsPostpaapiV1Configuration_universal_d_DisconnectAccountResponse as DisconnectAccountResponse,\n restaurantsPostpaapiV1Configuration_universal_d_DisconnectConfigurationRequest as DisconnectConfigurationRequest,\n restaurantsPostpaapiV1Configuration_universal_d_DisconnectConfigurationResponse as DisconnectConfigurationResponse,\n restaurantsPostpaapiV1Configuration_universal_d_getConfiguration as getConfiguration,\n restaurantsPostpaapiV1Configuration_universal_d_listConfigurations as listConfigurations,\n restaurantsPostpaapiV1Configuration_universal_d_disconnectAccount as disconnectAccount,\n restaurantsPostpaapiV1Configuration_universal_d_DisconnectAccountOptions as DisconnectAccountOptions,\n restaurantsPostpaapiV1Configuration_universal_d_disconnectConfiguration as disconnectConfiguration,\n };\n }\n \n /** RestaurantLocation is the main entity of RestaurantLocations that can be used for lorem ipsum dolor */\n interface RestaurantLocation {\n /** Restaurant Location ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Whether this restaurant location is active.\n * @readonly\n */\n active?: boolean;\n /**\n * Restaurant location - location\n * @readonly\n */\n location?: Location;\n }\n interface Location {\n /** The associated location id */\n locationId?: string | null;\n /**\n * Whether this is the default restaurant location. There can only be one default restaurant location per site.\n * @readonly\n */\n default?: boolean;\n /**\n * Restaurant location address\n * @readonly\n */\n address?: Address;\n /**\n * Restaurant location contact details\n * @readonly\n */\n contactDetails?: ContactDetails;\n /**\n * Restaurant location timeZone\n * @readonly\n */\n timeZone?: string;\n /**\n * Restaurant location locale\n * @readonly\n */\n locale?: Locale;\n /**\n * Restaurant location name\n * @readonly\n */\n name?: string | null;\n /**\n * Restaurant location currency\n * @readonly\n */\n currency?: string | null;\n /**\n * Restaurant location schedule. Array of weekly recurring time periods when the location is open for restaurant location. Limited to 100 time periods.\n * @readonly\n */\n availability?: Availability;\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 ContactDetails {\n /** Restaurant location email */\n email?: string | null;\n /** Restaurant location phone */\n phone?: string | null;\n /** Restaurant location fax */\n fax?: string | null;\n }\n interface Locale {\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 Availability {\n /** Weekly recurring time periods when the entity is available. Limited to 100 time periods. */\n periods?: TimePeriod[];\n /** Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period. */\n specialHourPeriods?: SpecialHourPeriod[];\n }\n /** Weekly recurring time periods when the entity 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.orgwikiISO_8601) extended format. Valid values are 00:00-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.orgwikiISO_8601) extended format. Valid values are 00:00-24:00, where 24:00 represents\n * midnight at the end of the specified day.\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 enum DayOfWeek {\n MON = \"MON\",\n TUE = \"TUE\",\n WED = \"WED\",\n THU = \"THU\",\n FRI = \"FRI\",\n SAT = \"SAT\",\n SUN = \"SUN\"\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.orgwikiISO_8601) format and [Coordinated Universal Time (UTC)](https:en.wikipedia.orgwikiCoordinated_Universal_Time). */\n startDate?: string;\n /** End date and time of the exception in [ISO 8601](https:en.wikipedia.orgwikiISO_8601) format and [Coordinated Universal Time (UTC)](https:en.wikipedia.orgwikiCoordinated_Universal_Time). */\n endDate?: string;\n /** Whether the item is available during the exception. Defaults to `false`. */\n available?: boolean;\n /** Name of the special hour period. In the Business Manager the special hour period is called event. */\n eventName?: string | null;\n }\n interface GetRestaurantLocationRequest {\n /** Id of the Restaurant location to retrieve */\n restaurantLocationId: string;\n }\n interface GetRestaurantLocationResponse {\n /** The retrieved RestaurantLocation */\n restaurantLocation?: RestaurantLocation;\n }\n interface ListRestaurantLocationsRequest {\n /** location ids */\n locationIds?: string[] | null;\n /** Includes archived restaurant locations. Default is false */\n includeArchived?: boolean;\n /** default restaurant location. Default is false */\n default?: boolean;\n }\n interface ListRestaurantLocationsResponse {\n /** The retrieved RestaurantLocation */\n restaurantLocations?: RestaurantLocation[];\n }\n /**\n * Get a RestaurantLocation by id\n * @param restaurantLocationId - Id of the Restaurant location to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField restaurantLocationId\n * @permissionId WIX_RESTAURANTS.RESTAURANT_LOCATIONS_READ\n * @returns The retrieved RestaurantLocation\n */\n function getRestaurantLocation(restaurantLocationId: string): Promise;\n /**\n * Get Restaurant locations\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.RESTAURANT_LOCATIONS_READ\n */\n function listRestaurantLocations(options?: ListRestaurantLocationsOptions): Promise;\n interface ListRestaurantLocationsOptions {\n /** location ids */\n locationIds?: string[] | null;\n /** Includes archived restaurant locations. Default is false */\n includeArchived?: boolean;\n /** default restaurant location. Default is false */\n default?: boolean;\n }\n \n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_RestaurantLocation = RestaurantLocation;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Location = Location;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Address = Address;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_StreetAddress = StreetAddress;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_AddressLocation = AddressLocation;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Subdivision = Subdivision;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_SubdivisionType = SubdivisionType;\n const restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_SubdivisionType: typeof SubdivisionType;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_StandardDetails = StandardDetails;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ContactDetails = ContactDetails;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Locale = Locale;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Availability = Availability;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_TimePeriod = TimePeriod;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_DayOfWeek = DayOfWeek;\n const restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_DayOfWeek: typeof DayOfWeek;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_GetRestaurantLocationRequest = GetRestaurantLocationRequest;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_GetRestaurantLocationResponse = GetRestaurantLocationResponse;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ListRestaurantLocationsRequest = ListRestaurantLocationsRequest;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ListRestaurantLocationsResponse = ListRestaurantLocationsResponse;\n const restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_getRestaurantLocation: typeof getRestaurantLocation;\n const restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_listRestaurantLocations: typeof listRestaurantLocations;\n type restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ListRestaurantLocationsOptions = ListRestaurantLocationsOptions;\n namespace restaurantsRestaurantlocationsV3RestaurantLocation_universal_d {\n export {\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_RestaurantLocation as RestaurantLocation,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Location as Location,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Address as Address,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_StreetAddress as StreetAddress,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_AddressLocation as AddressLocation,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Subdivision as Subdivision,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_SubdivisionType as SubdivisionType,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_StandardDetails as StandardDetails,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ContactDetails as ContactDetails,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Locale as Locale,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_Availability as Availability,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_TimePeriod as TimePeriod,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_DayOfWeek as DayOfWeek,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_GetRestaurantLocationRequest as GetRestaurantLocationRequest,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_GetRestaurantLocationResponse as GetRestaurantLocationResponse,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ListRestaurantLocationsRequest as ListRestaurantLocationsRequest,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ListRestaurantLocationsResponse as ListRestaurantLocationsResponse,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_getRestaurantLocation as getRestaurantLocation,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_listRestaurantLocations as listRestaurantLocations,\n restaurantsRestaurantlocationsV3RestaurantLocation_universal_d_ListRestaurantLocationsOptions as ListRestaurantLocationsOptions,\n };\n }\n \n interface Order {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string;\n /**\n * Legacy restaurant ID, use only for legacy API\n * @internal\n * @readonly\n */\n restaurantId?: string;\n /**\n * ID of the restaurant’s location.\n * @readonly\n */\n locationId?: string | null;\n /**\n * ID of the restaurant's location\n * @internal\n */\n restaurantLocationId?: string | null;\n /**\n * Order creation date and time in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time of order's latest update in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Additional note to the order added by the customer. */\n comment?: string | null;\n /** Currency of the order. */\n currency?: string | null;\n /** Current order status. */\n status?: Status;\n /**\n * TEST This is a line item for the order of the property\n *\n */\n lineItems?: LineItem[];\n /** Discounts associated with the order. */\n discounts?: Discount[];\n /** Coupon applied to the order. */\n coupon?: Coupon;\n /** Order payment information. */\n payments?: Payment[];\n /** Order fulfillment information. */\n fulfillment?: Fulfillment;\n /** Customer information. */\n customer?: Customer;\n /** Order totals. */\n totals?: Totals;\n /**\n * Log of order updates.\n * @readonly\n */\n activities?: Activity[];\n /** Information about the sales channel that submitted the order. */\n channelInfo?: ChannelInfo;\n /**\n * Information about the order’s loyalty points.\n * Learn more about the [Wix Loyalty Program](https://dev.wix.com/api/rest/wix-loyalty-program/introduction).\n */\n loyaltyInfo?: LoyaltyInfo;\n /**\n * Information about the POS.\n * @internal\n */\n posInfo?: PosInfo;\n }\n /** This might be extended in the future with pending orders statuses */\n enum Status {\n /** Order status can't be classified, due to an error */\n UNSPECIFIED_ORDER_STATUS = \"UNSPECIFIED_ORDER_STATUS\",\n /** Order is pending response from the payment provider - IF THIS WILL REMAIN PAYMENT PROVIDER SPECIFIC, THIS SHOULD BE CLEAR FROM THE NAME - E.G. PENDING_PAYMENT_PROVIDER. */\n PENDING = \"PENDING\",\n /** The order is marked as new - wait for state machine */\n NEW = \"NEW\",\n /** Order was accepted */\n ACCEPTED = \"ACCEPTED\",\n /** Order is canceled */\n CANCELED = \"CANCELED\",\n /** Order is fulfilled */\n FULFILLED = \"FULFILLED\"\n }\n /** TEST This is a line item for the order. */\n interface LineItem {\n /** Line item quantity. */\n quantity?: number;\n /** Line item price. */\n price?: string;\n /** Comment about the line item added by the customer. */\n comment?: string | null;\n /** List of all dish options available for the line item. */\n dishOptions?: LineItemOption[];\n /** References to the line item’s origin catalog. */\n catalogReference?: CatalogReference;\n }\n interface LineItemOption {\n /** Line item option name. */\n name?: string | null;\n /** List of all dish options selected by the customer. */\n selectedChoices?: LineItem[];\n /** Minimum number of dish options the customer is required to choose. */\n minChoices?: number | null;\n /** Maximum number of dish options the customer is allowed to choose. */\n maxChoices?: number | null;\n /** Dish option type. */\n type?: DisplayType;\n /** List of all available choices for the dish option. */\n availableChoices?: LineItemOptionItem[];\n /** List of dish option IDs selected by default. */\n defaultChoices?: string[] | null;\n }\n enum DisplayType {\n /** DisplayType, due to an error */\n UNSPECIFIED_DISPLAY_TYPE = \"UNSPECIFIED_DISPLAY_TYPE\",\n /** Single choice selection */\n SELECTION = \"SELECTION\",\n /** Multiple choices selection */\n EXTRAS = \"EXTRAS\",\n /** Allow choices removal */\n DESELECTION = \"DESELECTION\"\n }\n interface LineItemOptionItem {\n /** Line item ID as defined in the catalog. */\n itemId?: string | null;\n /** Line item price. */\n price?: string | null;\n /** Line item name. */\n name?: string | null;\n }\n interface CatalogReference {\n /** Line item ID as defined in the catalog. */\n catalogItemId?: string;\n /**\n * Line item name as defined in the catalog.\n * @readonly\n */\n catalogItemName?: string | null;\n /**\n * Item description as defined in the catalog.\n * @readonly\n */\n catalogItemDescription?: string | null;\n /**\n * Item media url as defined in the catalog.\n * @readonly\n */\n catalogItemMedia?: string | null;\n }\n interface Discount {\n /** Discount ID as defined in the catalog. */\n catalogDiscountId?: string;\n /** Amount saved. */\n appliedAmount?: string;\n /** Discount type. */\n catalogDiscountType?: DiscountType;\n /** Discount name as defined in the catalog. */\n catalogDiscountName?: string;\n /**\n * Discount description as defined in the catalog.\n *\n * Max: 1,000 characters\n * @readonly\n */\n catalogDiscountDescription?: string;\n }\n enum DiscountType {\n UNSPECIFIED_TYPE = \"UNSPECIFIED_TYPE\",\n OFF_ITEM = \"OFF_ITEM\",\n OFF_ORDER = \"OFF_ORDER\",\n OFF_ORDER_MANAGER_DISCOUNT = \"OFF_ORDER_MANAGER_DISCOUNT\"\n }\n interface Coupon {\n /** Coupon code. */\n code?: string;\n /** Coupon ID. */\n _id?: string;\n }\n interface Payment {\n /** Payment type. */\n type?: PaymentType;\n /** Amount paid using this payment type. Only differs from total amount paid in case of split payments. */\n amount?: string | null;\n /** Payment method. */\n method?: string | null;\n /**\n * Transaction ID.\n * See [Cashier API](https://dev.wix.com/api/rest/wix-cashier/payments/transaction) for more details.\n */\n providerTransactionId?: string | null;\n }\n enum PaymentType {\n /** PaymentType, due to an error */\n UNSPECIFIED_PAYMENT_TYPE = \"UNSPECIFIED_PAYMENT_TYPE\",\n /** Cash */\n CASH = \"CASH\",\n /** credit */\n CREDIT = \"CREDIT\",\n /** Delivery club */\n DELIVERY_CLUB = \"DELIVERY_CLUB\",\n /** Delivery com */\n DELIVERY_COM = \"DELIVERY_COM\",\n /** Bitpay */\n BITPAY = \"BITPAY\",\n /** Cellarix */\n CELLARIX = \"CELLARIX\",\n /** Bits of gold */\n BITSOFGOLD = \"BITSOFGOLD\",\n /** Multi pass */\n MULTIPASS = \"MULTIPASS\",\n /** Tenbis */\n TENBIS = \"TENBIS\",\n /** Paypal */\n PAYPAL = \"PAYPAL\",\n /** Mysodexo */\n MYSODEXO = \"MYSODEXO\",\n /** Wix Payments */\n WIX_PAYMENTS = \"WIX_PAYMENTS\"\n }\n interface Fulfillment extends FulfillmentDetailsOneOf {\n /** Delivery details. */\n deliveryDetails?: DeliveryDetails;\n /** Pickup details. */\n pickupDetails?: PickupDetails;\n /** Dine-in details */\n dineInDetails?: DineInDetails;\n /** Fulfillment type. */\n type?: FulfillmentType;\n /** Latest delivery time promised by the restaurant. */\n promisedTime?: Date | null;\n /** Whether the order should be fulfilled as soon as possible. Defaults to `true`. */\n asap?: boolean | null;\n /**\n * The time it takes to prepare and deliver the order in minutes\n * @internal\n */\n preparationTime?: number | null;\n }\n /** @oneof */\n interface FulfillmentDetailsOneOf {\n /** Delivery details. */\n deliveryDetails?: DeliveryDetails;\n /** Pickup details. */\n pickupDetails?: PickupDetails;\n /** Dine-in details */\n dineInDetails?: DineInDetails;\n }\n enum FulfillmentType {\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 }\n interface DeliveryDetails extends DeliveryDetailsProviderOneOf {\n /** Delivery through the restaurant. */\n restaurant?: Restaurant;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider;\n /** Delivery address. */\n address?: DeliveryAddress;\n /** Information about the delivery pickup. */\n pickupInfo?: PickupInfo;\n /**\n * Information about the delivery drop-off.\n * @internal\n */\n dropOffInfo?: DropOffInfo;\n }\n /** @oneof */\n interface DeliveryDetailsProviderOneOf {\n /** Delivery through the restaurant. */\n restaurant?: Restaurant;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider;\n }\n interface DeliveryAddress {\n /** Formatted delivery address. */\n formatted?: string | null;\n /** Country. */\n country?: string | null;\n /** City name. */\n city?: string | null;\n /** Street name. */\n street?: string | null;\n /** Street number. */\n streetNumber?: string | null;\n /** Apartment number. */\n apt?: string | null;\n /** Floor. */\n floor?: string | null;\n /** Entrance. */\n entrance?: string | null;\n /** ZIP/postal code. */\n zipCode?: string | null;\n /** Country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n countryCode?: string | null;\n /** Special delivery instructions upon arrival to the address. */\n onArrival?: OnArrival;\n /** Whether an approximate address is used. Defaults to `false`. In case of `false` a house number is required. */\n approximate?: boolean | null;\n /** Delivery Instructions added by the customer. */\n comment?: string | null;\n /** Geo coordinates of the address. */\n location?: DeliveryAddressLocation;\n /** Address Line 2. */\n addressLine2?: 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 }\n enum OnArrival {\n /** Missing type due to an error */\n UNSPECIFIED_ON_ARRIVAL_TYPE = \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n /** Buzz the door */\n BUZZ_DOOR = \"BUZZ_DOOR\",\n /** Phone me */\n CALL_ME = \"CALL_ME\"\n }\n interface DeliveryAddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Restaurant {\n /** Delivery fee. */\n fee?: string | null;\n }\n interface ExternalProvider {\n /** ID of the external delivery provider. */\n _id?: string;\n /**\n * Name of the external delivery provider.\n * @readonly\n */\n name?: string;\n /**\n * Delivery ID.\n * @internal\n */\n deliveryId?: string | null;\n /**\n * Estimate ID.\n * @internal\n */\n estimateId?: string | null;\n /** Delivery fee charged to the customer. */\n customerFee?: string | null;\n /**\n * Fee paid by the restaurant to the external delivery provider.\n * @readonly\n */\n commission?: string | null;\n /** Order pickup time. */\n pickupTime?: Date | null;\n /** Order drop off time. */\n dropOffTime?: Date | null;\n /**\n * Icon of the external delivery provider.\n * @internal\n */\n iconUrl?: string | null;\n }\n interface PickupInfo {\n /** When a delivery is ready to be picked up. This is the start time of the pickup window. */\n windowStartTime?: Date | null;\n /** When a delivery must be picked up by. This is the end time of the pickup window. */\n windowEndTime?: Date | null;\n }\n interface DropOffInfo {\n /** Whether the order is delivered contactless. */\n contactless?: boolean;\n /**\n * When a delivery will be drop off. This is the start time of the drop off window.\n * @internal\n */\n windowStartTime?: Date | null;\n /**\n * When a delivery will be drop off. This is the end time of the drop off window.\n * @internal\n */\n windowEndTime?: Date | null;\n }\n interface PickupDetails {\n /** Pickup fee charged to the customer. */\n fee?: string | null;\n /** Curbside pickup method */\n curbside?: Curbside;\n }\n interface Curbside {\n /** Additional information for curbside pickup. */\n info?: string;\n }\n interface DineInDetails {\n /** Label of dine-in information added by the restaurant, e.g. `table` or `booth`. */\n label?: string;\n /** Value of dine-in information added by the restaurant, e.g. `#6`. */\n value?: string;\n }\n /** Customer information. */\n interface Customer extends CustomerIdOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** First name. */\n firstName?: string;\n /** Last name. */\n lastName?: string;\n /** Phone number. */\n phone?: string | null;\n /** Email address. */\n email?: string;\n /**\n * Customer's contact ID.\n * See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.\n */\n contactId?: string | null;\n }\n /** @oneof */\n interface CustomerIdOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n }\n interface Totals {\n /** Order subtotal. Calculated by substracting delivery fee, tax and discount from order total. */\n subtotal?: string;\n /** Total order price. */\n total?: string;\n /** Total delivery fees charged to the customer. */\n delivery?: string | null;\n /** Total tax. */\n tax?: string | null;\n /** Total discount amount. */\n discount?: string | null;\n /** Total amount saved through the Wix Loyalty program. */\n loyaltySavings?: string | null;\n /**\n * Total number of line items.\n * @readonly\n */\n quantity?: number;\n /** Total tip. */\n tip?: string | null;\n /**\n * Information about the order's service fees.\n * @internal\n */\n serviceFees?: ServiceFee[];\n }\n interface ServiceFee {\n /** The service fee's unique id. */\n ruleId?: string;\n /**\n * The service fee's name.\n * @readonly\n */\n name?: string;\n /** The service fee's fee as Money. */\n fee?: Money;\n /** The service fee's tax as Money. */\n tax?: Money;\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 Activity {\n /**\n * Activity timestamp.\n * @readonly\n */\n timestamp?: Date | null;\n /**\n * Optional message added during order activity.\n * @readonly\n */\n message?: string | null;\n }\n interface ChannelInfo {\n type?: Type;\n }\n enum Type {\n UNSPECIFIED_CHANNEL_TYPE = \"UNSPECIFIED_CHANNEL_TYPE\",\n /** Web */\n WEB = \"WEB\",\n /** mobileWeb */\n MOBILE_WEB = \"MOBILE_WEB\",\n /** mobile */\n MOBILE = \"MOBILE\",\n /** callCenter */\n CALL_CENTER = \"CALL_CENTER\",\n /** facebook */\n FACEBOOK = \"FACEBOOK\",\n /** TPA */\n TPA = \"TPA\"\n }\n interface LoyaltyInfo {\n /** Associated Wix Loyalty reward ID. */\n rewardId?: string | null;\n /** Amount saved redeeming Wix Loyalty reward. */\n appliedAmount?: string | null;\n /**\n * Wix Loyalty points redeemed.\n * @readonly\n */\n redeemedPoints?: number | null;\n /**\n * Associated Wix Loyalty transaction ID.\n * @readonly\n */\n transactionId?: string | null;\n /**\n * Wix Loyalty estimated account point balance.\n * Equal to the sum of earned and adjusted points minus redeemed points.\n * The estimated point balance is the value before the order is completed. Following the purchase, the point balance is updated.\n * @readonly\n */\n estimatedAccountBalance?: number | null;\n /**\n * Wix Loyalty estimated total earned points.\n * The estimated total earned points is the value before the order is completed. Following the purchase, the total is updated.\n * @readonly\n */\n estimatedPointsEarned?: number | null;\n /**\n * Associated Wix Loyalty reward 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 * Ignored when creating an account.\n * @readonly\n */\n rewardRevision?: string | null;\n }\n interface PosInfo {\n externalProvider?: PosInfoExternalProvider;\n }\n interface Error {\n /** Error code */\n code?: string;\n /** Error message */\n message?: string;\n /** Error params */\n params?: Record;\n }\n interface PosInfoExternalProvider {\n /** ID of the external provider. */\n _id?: string;\n /** ID of the order in the external provider. */\n orderId?: string;\n /** Order creation success */\n success?: boolean;\n /** Order creation errors */\n errors?: Error[];\n }\n interface GetTotalActiveOrdersRequest {\n /** filter response to a specific location, otherwise return totals for all locations. */\n locationId?: string | null;\n organizationId?: string | null;\n /** Order delivery date and time for filtering new orders count, Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`. */\n promisedTimeNew?: string | null;\n /** Order delivery date and time for filtering new orders count, Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`. */\n promisedTimeInProgress?: string | null;\n /**\n * filter response to a specific Restaurant Location, otherwise return totals for all restaurant locations\n * if the restaurant_location_id is provided, the location_id will be ignored\n * @internal\n */\n restaurantLocationId?: string | null;\n }\n interface GetTotalActiveOrdersResponse {\n /** list of locationId's mapped to the total number of orders. */\n totals?: LocationToAmount[];\n }\n interface LocationToAmount {\n locationId?: string;\n locationName?: string | null;\n totalNew?: number;\n totalInProgress?: number;\n }\n interface NewOrder {\n /** New order. */\n order?: Order;\n }\n interface GetOrderRequest {\n /** ID of the order to retrieve. */\n _id: string;\n /**\n * Set of fields to retrieve.\n * Fields that aren't included in `fieldmaks.paths` are ignored.\n * See [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\n * for more details.\n * @internal\n */\n fieldMask?: string[];\n }\n interface GetOrderResponse {\n /** Retrieved order. */\n order?: Order;\n }\n interface ListOrdersRequest {\n /**\n * Set of fields to retrieve.\n * Fields that aren't included in `fieldmaks.paths` are ignored.\n * See [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\n * for more details.\n * @internal\n */\n fieldMask?: string[];\n /** Order status. Currently, it is not possible to filter by status `FULFILLED`. */\n status?: Status;\n /** Order creation date and time. Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`. */\n _createdDate?: string | null;\n /** Whether the order has been delivered. */\n delivered?: boolean | null;\n /** Location filter. Pass an array of location IDs to return orders with any of the provided locations. */\n locationIds?: string[];\n /** Sorting options. */\n sort?: Sort;\n /** Number of orders to return. The minimum limit is 1, the maximum 1000. */\n limit?: number | null;\n /**\n * paging options (limit and cursor).\n * @internal\n */\n cursorPaging?: CursorPaging;\n /**\n * Order phone number filter. for filtering orders by phone.\n * @internal\n */\n phone?: string | null;\n /**\n * Whether the order should be delivered asap.\n * @internal\n */\n asap?: boolean | null;\n /**\n * Order promised_time. Must include a prefix (`gt`,`gte`,`lte`,`lt`), for example: `gte:2021-10-26T12:48:15Z`.\n * @internal\n */\n promisedTime?: string | null;\n /**\n * Location filter. Pass an array of location IDs to return orders with any of the provided locations.\n * @internal\n */\n restaurantLocationIds?: string[];\n }\n interface Sort {\n /** Field to sort by. */\n fieldName?: FieldName;\n /** Sort order. */\n order?: SortOrder;\n }\n enum FieldName {\n CREATED_DATE = \"CREATED_DATE\",\n UPDATED_DATE = \"UPDATED_DATE\",\n PROMISED_TIME = \"PROMISED_TIME\"\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 ListOrdersResponse {\n /** List of retrieved orders. */\n orders?: Order[];\n /**\n * Details on the paged set of results returned.\n * @internal\n */\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 * 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 * @internal\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 AcceptOrderRequest extends AcceptOrderRequestDeliveryTimeOneOf {\n /**\n * Order pickup time.\n * @internal\n */\n pickupTime?: Date | null;\n /**\n * Order drop off time.\n * @internal\n */\n dropOffTime?: Date | null;\n /** ID of the order to mark as `ACCEPTED`. */\n _id: string;\n /** Message when accepting the order. */\n message?: string | null;\n }\n /** @oneof */\n interface AcceptOrderRequestDeliveryTimeOneOf {\n /**\n * Order pickup time.\n * @internal\n */\n pickupTime?: Date | null;\n /**\n * Order drop off time.\n * @internal\n */\n dropOffTime?: Date | null;\n }\n interface AcceptOrderResponse {\n /** Accepted order. */\n order?: Order;\n }\n interface OrderAccepted {\n /** Accepted order. */\n order?: Order;\n }\n interface CancelOrderRequest {\n /** ID of the order to mark as `CANCELED`. */\n _id: string;\n /** Message when canceling the order. */\n message?: string | null;\n }\n interface CancelOrderResponse {\n /** Canceled order. */\n order?: Order;\n }\n interface OrderCanceled {\n /** Canceled order. */\n order?: Order;\n }\n interface FulfillOrderRequest {\n /** ID of the order to mark as `FULFILLED`. */\n _id: string;\n }\n interface FulfillOrderResponse {\n /** Fulfilled order. */\n order?: Order;\n }\n interface OrderFulfilled {\n /** Fulfilled order. */\n order?: Order;\n }\n interface CountOrdersRequest {\n /** Count orders only for a specific restaurant location */\n restaurantLocationId?: string | null;\n /** Limit the count only for orders that match the query */\n query?: CountOrdersQuery;\n /** Count orders only for a specific OS location ID */\n locationId?: string | null;\n }\n interface CountOrdersQuery {\n /** Required - filter orders count by status. Supported values: NEW, ACCEPTED */\n status?: Status;\n /**\n * Required - filter orders count by fulfillment promised time. (Latest delivery time promised by the restaurant)\n * Maximum supported range is up to 30 days.\n * NOTE: Count is a slow operation, for better performance request smaller time ranges.\n */\n promisedTime?: DateRangeFilter;\n }\n interface DateRangeFilter {\n /** Filter by date range, starting from given timestamp */\n startTime?: Date | null;\n /** Filter by date range, ending by a given timestamp */\n endTime?: Date | null;\n }\n interface CountOrdersResponse {\n /** Number of orders count that match the query */\n count?: number;\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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 NotifyOrderEventRequest {\n /** Order ID. */\n _id: string;\n /** Metasite id */\n msid?: string;\n /** Notification event type */\n eventType?: EventType;\n }\n enum EventType {\n /** Order event can't be classified, due to an error/unhandled event */\n UNKNOWN = \"UNKNOWN\",\n /** Order Created. */\n CREATED = \"CREATED\",\n /** Order accepted */\n ACCEPTED = \"ACCEPTED\",\n /** Order Canceled */\n CANCELED = \"CANCELED\",\n /** Order Fulfilled */\n FULFILLED = \"FULFILLED\"\n }\n interface Empty {\n }\n interface GetOrderByMsidRequest {\n /** Order ID. */\n _id: string;\n /** Metasite id */\n msid: string;\n /**\n * Controls what data is returned in the response\n * @internal\n */\n fieldMask?: string[];\n }\n interface GetOrderByMsidResponse {\n /** Order data. */\n order?: Order;\n }\n interface ListOrdersByMsidRequest {\n /**\n * Controls what data is returned in the response.\n * @internal\n */\n fieldMask?: string[];\n /** Order status to filter by. Currently Status Fulfilled is not supported */\n status?: Status;\n /** Created date of the order epoch time. */\n _createdDate?: string | null;\n delivered?: boolean | null;\n /** Sorting of Orders in response. Default \"CREATED_DATE:ASC\" */\n sort?: Sort;\n /** limit of records - min: 1 max: 2000 */\n limit?: number | null;\n /** Metasite id */\n msid: string;\n }\n interface ListOrdersByMsidResponse {\n /** Order data. */\n orders?: Order[];\n }\n interface NotifyOrderEventResponse {\n }\n /**\n * return list of orders total amount mapped to each location based on given status.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_ORDERS\n * @adminMethod\n */\n function getTotalActiveOrders(options?: GetTotalActiveOrdersOptions): Promise;\n interface GetTotalActiveOrdersOptions {\n /** filter response to a specific location, otherwise return totals for all locations. */\n locationId?: string | null;\n organizationId?: string | null;\n /** Order delivery date and time for filtering new orders count, Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`. */\n promisedTimeNew?: string | null;\n /** Order delivery date and time for filtering new orders count, Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`. */\n promisedTimeInProgress?: string | null;\n /**\n * filter response to a specific Restaurant Location, otherwise return totals for all restaurant locations\n * if the restaurant_location_id is provided, the location_id will be ignored\n * @internal\n */\n restaurantLocationId?: string | null;\n }\n /**\n * TEST The `getOrder()` function returns a Promise that is returned when an order is retrieved.\n *\n * 1. First do this.\n * 1. The do that\n * + This is a bullet\n * + So is this.\n *\n * > **Note**: This indentation is not how our notes generally look but I will waiit to see the branch preview. I am just trying out some markdown here.\n *\n * @param _id - ID of the order to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_RESTAURANTS.READ_ORDERS\n * @adminMethod\n * @returns TEST Curious where this shows up.\n */\n function getOrder(_id: string, options?: GetOrderOptions): Promise;\n /** TEST The options for the order. */\n interface GetOrderOptions {\n /**\n * Set of fields to retrieve.\n * Fields that aren't included in `fieldmaks.paths` are ignored.\n * See [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\n * for more details.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Retrieves a list of up to 1000 orders, given the provided filters.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_ORDERS\n * @adminMethod\n */\n function listOrders(options?: ListOrdersOptions): Promise;\n interface ListOrdersOptions {\n /**\n * Set of fields to retrieve.\n * Fields that aren't included in `fieldmaks.paths` are ignored.\n * See [the article about field masks](https://dev.wix.com/api/rest/restaurants/orders/supported-field-masks)\n * for more details.\n * @internal\n */\n fieldMask?: string[];\n /** Order status. Currently, it is not possible to filter by status `FULFILLED`. */\n status?: Status;\n /** Order creation date and time. Must include a `gte:` or `lte:` prefix, for example: `gte:2021-10-26T12:48:15Z`. */\n _createdDate?: string | null;\n /** Whether the order has been delivered. */\n delivered?: boolean | null;\n /** Location filter. Pass an array of location IDs to return orders with any of the provided locations. */\n locationIds?: string[];\n /** Sorting options. */\n sort?: Sort;\n /** Number of orders to return. The minimum limit is 1, the maximum 1000. */\n limit?: number | null;\n /**\n * paging options (limit and cursor).\n * @internal\n */\n cursorPaging?: CursorPaging;\n /**\n * Order phone number filter. for filtering orders by phone.\n * @internal\n */\n phone?: string | null;\n /**\n * Whether the order should be delivered asap.\n * @internal\n */\n asap?: boolean | null;\n /**\n * Order promised_time. Must include a prefix (`gt`,`gte`,`lte`,`lt`), for example: `gte:2021-10-26T12:48:15Z`.\n * @internal\n */\n promisedTime?: string | null;\n /**\n * Location filter. Pass an array of location IDs to return orders with any of the provided locations.\n * @internal\n */\n restaurantLocationIds?: string[];\n }\n /**\n * Changes the order status to `ACCEPTED`.\n *\n * > **Note:** It is not possible to change the order status from `FULFILLED` to `ACCEPTED`.\n * @param _id - ID of the order to mark as `ACCEPTED`.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_RESTAURANTS.MANAGE_ORDERS\n * @adminMethod\n */\n function acceptOrder(_id: string, options?: AcceptOrderOptions): Promise;\n interface AcceptOrderOptions extends AcceptOrderRequestDeliveryTimeOneOf {\n /** Message when accepting the order. */\n message?: string | null;\n /**\n * Order pickup time.\n * @internal\n */\n pickupTime?: Date | null;\n /**\n * Order drop off time.\n * @internal\n */\n dropOffTime?: Date | null;\n }\n /**\n * Changes the order status to `CANCELED`.\n * @param _id - ID of the order to mark as `CANCELED`.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_RESTAURANTS.MANAGE_ORDERS\n * @adminMethod\n */\n function cancelOrder(_id: string, options?: CancelOrderOptions): Promise;\n interface CancelOrderOptions {\n /** Message when canceling the order. */\n message?: string | null;\n }\n /**\n * Changes the order status to `FULFILLED`.\n * @param _id - ID of the order to mark as `FULFILLED`.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_RESTAURANTS.MANAGE_ORDERS\n * @adminMethod\n */\n function fulfillOrder(_id: string): Promise;\n /**\n * Returns the number of orders that match the query.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_RESTAURANTS.READ_ORDERS\n * @adminMethod\n */\n function countOrders(options?: CountOrdersOptions): Promise;\n interface CountOrdersOptions {\n /** Count orders only for a specific restaurant location */\n restaurantLocationId?: string | null;\n /** Limit the count only for orders that match the query */\n query?: CountOrdersQuery;\n /** Count orders only for a specific OS location ID */\n locationId?: string | null;\n }\n /**\n * Retrieves an order.\n * @param _id - Order ID.\n * @param msid - Metasite id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField msid\n * @permissionId WIX_RESTAURANTS.BACK_OFFICE\n * @adminMethod\n */\n function getOrderByMsid(_id: string, msid: string, options?: GetOrderByMsidOptions): Promise;\n interface GetOrderByMsidOptions {\n /**\n * Controls what data is returned in the response\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Retrieves a list of up to 2000 orders, given the provided filters.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.msid\n * @permissionId WIX_RESTAURANTS.BACK_OFFICE\n * @adminMethod\n */\n function listOrdersByMsid(options?: ListOrdersByMsidOptions): Promise;\n interface ListOrdersByMsidOptions {\n /**\n * Controls what data is returned in the response.\n * @internal\n */\n fieldMask?: string[];\n /** Order status to filter by. Currently Status Fulfilled is not supported */\n status?: Status;\n /** Created date of the order epoch time. */\n _createdDate?: string | null;\n delivered?: boolean | null;\n /** Sorting of Orders in response. Default \"CREATED_DATE:ASC\" */\n sort?: Sort;\n /** limit of records - min: 1 max: 2000 */\n limit?: number | null;\n /** Metasite id */\n msid: string;\n }\n /** @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_RESTAURANTS.BACK_OFFICE\n * @adminMethod\n */\n function notifyOrderEvent(_id: string, options?: NotifyOrderEventOptions): Promise;\n interface NotifyOrderEventOptions {\n /** Metasite id */\n msid?: string;\n /** Notification event type */\n eventType?: EventType;\n }\n \n type restaurantsV3Order_universal_d_Order = Order;\n type restaurantsV3Order_universal_d_Status = Status;\n const restaurantsV3Order_universal_d_Status: typeof Status;\n type restaurantsV3Order_universal_d_LineItem = LineItem;\n type restaurantsV3Order_universal_d_LineItemOption = LineItemOption;\n type restaurantsV3Order_universal_d_DisplayType = DisplayType;\n const restaurantsV3Order_universal_d_DisplayType: typeof DisplayType;\n type restaurantsV3Order_universal_d_LineItemOptionItem = LineItemOptionItem;\n type restaurantsV3Order_universal_d_CatalogReference = CatalogReference;\n type restaurantsV3Order_universal_d_Discount = Discount;\n type restaurantsV3Order_universal_d_DiscountType = DiscountType;\n const restaurantsV3Order_universal_d_DiscountType: typeof DiscountType;\n type restaurantsV3Order_universal_d_Coupon = Coupon;\n type restaurantsV3Order_universal_d_Payment = Payment;\n type restaurantsV3Order_universal_d_PaymentType = PaymentType;\n const restaurantsV3Order_universal_d_PaymentType: typeof PaymentType;\n type restaurantsV3Order_universal_d_Fulfillment = Fulfillment;\n type restaurantsV3Order_universal_d_FulfillmentDetailsOneOf = FulfillmentDetailsOneOf;\n type restaurantsV3Order_universal_d_FulfillmentType = FulfillmentType;\n const restaurantsV3Order_universal_d_FulfillmentType: typeof FulfillmentType;\n type restaurantsV3Order_universal_d_DeliveryDetails = DeliveryDetails;\n type restaurantsV3Order_universal_d_DeliveryDetailsProviderOneOf = DeliveryDetailsProviderOneOf;\n type restaurantsV3Order_universal_d_DeliveryAddress = DeliveryAddress;\n type restaurantsV3Order_universal_d_OnArrival = OnArrival;\n const restaurantsV3Order_universal_d_OnArrival: typeof OnArrival;\n type restaurantsV3Order_universal_d_DeliveryAddressLocation = DeliveryAddressLocation;\n type restaurantsV3Order_universal_d_Restaurant = Restaurant;\n type restaurantsV3Order_universal_d_ExternalProvider = ExternalProvider;\n type restaurantsV3Order_universal_d_PickupInfo = PickupInfo;\n type restaurantsV3Order_universal_d_DropOffInfo = DropOffInfo;\n type restaurantsV3Order_universal_d_PickupDetails = PickupDetails;\n type restaurantsV3Order_universal_d_Curbside = Curbside;\n type restaurantsV3Order_universal_d_DineInDetails = DineInDetails;\n type restaurantsV3Order_universal_d_Customer = Customer;\n type restaurantsV3Order_universal_d_CustomerIdOneOf = CustomerIdOneOf;\n type restaurantsV3Order_universal_d_Totals = Totals;\n type restaurantsV3Order_universal_d_ServiceFee = ServiceFee;\n type restaurantsV3Order_universal_d_Money = Money;\n type restaurantsV3Order_universal_d_Activity = Activity;\n type restaurantsV3Order_universal_d_ChannelInfo = ChannelInfo;\n type restaurantsV3Order_universal_d_Type = Type;\n const restaurantsV3Order_universal_d_Type: typeof Type;\n type restaurantsV3Order_universal_d_LoyaltyInfo = LoyaltyInfo;\n type restaurantsV3Order_universal_d_PosInfo = PosInfo;\n type restaurantsV3Order_universal_d_Error = Error;\n type restaurantsV3Order_universal_d_PosInfoExternalProvider = PosInfoExternalProvider;\n type restaurantsV3Order_universal_d_GetTotalActiveOrdersRequest = GetTotalActiveOrdersRequest;\n type restaurantsV3Order_universal_d_GetTotalActiveOrdersResponse = GetTotalActiveOrdersResponse;\n type restaurantsV3Order_universal_d_LocationToAmount = LocationToAmount;\n type restaurantsV3Order_universal_d_NewOrder = NewOrder;\n type restaurantsV3Order_universal_d_GetOrderRequest = GetOrderRequest;\n type restaurantsV3Order_universal_d_GetOrderResponse = GetOrderResponse;\n type restaurantsV3Order_universal_d_ListOrdersRequest = ListOrdersRequest;\n type restaurantsV3Order_universal_d_Sort = Sort;\n type restaurantsV3Order_universal_d_FieldName = FieldName;\n const restaurantsV3Order_universal_d_FieldName: typeof FieldName;\n type restaurantsV3Order_universal_d_SortOrder = SortOrder;\n const restaurantsV3Order_universal_d_SortOrder: typeof SortOrder;\n type restaurantsV3Order_universal_d_CursorPaging = CursorPaging;\n type restaurantsV3Order_universal_d_ListOrdersResponse = ListOrdersResponse;\n type restaurantsV3Order_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type restaurantsV3Order_universal_d_Cursors = Cursors;\n type restaurantsV3Order_universal_d_AcceptOrderRequest = AcceptOrderRequest;\n type restaurantsV3Order_universal_d_AcceptOrderRequestDeliveryTimeOneOf = AcceptOrderRequestDeliveryTimeOneOf;\n type restaurantsV3Order_universal_d_AcceptOrderResponse = AcceptOrderResponse;\n type restaurantsV3Order_universal_d_OrderAccepted = OrderAccepted;\n type restaurantsV3Order_universal_d_CancelOrderRequest = CancelOrderRequest;\n type restaurantsV3Order_universal_d_CancelOrderResponse = CancelOrderResponse;\n type restaurantsV3Order_universal_d_OrderCanceled = OrderCanceled;\n type restaurantsV3Order_universal_d_FulfillOrderRequest = FulfillOrderRequest;\n type restaurantsV3Order_universal_d_FulfillOrderResponse = FulfillOrderResponse;\n type restaurantsV3Order_universal_d_OrderFulfilled = OrderFulfilled;\n type restaurantsV3Order_universal_d_CountOrdersRequest = CountOrdersRequest;\n type restaurantsV3Order_universal_d_CountOrdersQuery = CountOrdersQuery;\n type restaurantsV3Order_universal_d_DateRangeFilter = DateRangeFilter;\n type restaurantsV3Order_universal_d_CountOrdersResponse = CountOrdersResponse;\n type restaurantsV3Order_universal_d_DomainEvent = DomainEvent;\n type restaurantsV3Order_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type restaurantsV3Order_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type restaurantsV3Order_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type restaurantsV3Order_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type restaurantsV3Order_universal_d_ActionEvent = ActionEvent;\n type restaurantsV3Order_universal_d_MessageEnvelope = MessageEnvelope;\n type restaurantsV3Order_universal_d_IdentificationData = IdentificationData;\n type restaurantsV3Order_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type restaurantsV3Order_universal_d_WebhookIdentityType = WebhookIdentityType;\n const restaurantsV3Order_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type restaurantsV3Order_universal_d_NotifyOrderEventRequest = NotifyOrderEventRequest;\n type restaurantsV3Order_universal_d_EventType = EventType;\n const restaurantsV3Order_universal_d_EventType: typeof EventType;\n type restaurantsV3Order_universal_d_Empty = Empty;\n type restaurantsV3Order_universal_d_GetOrderByMsidRequest = GetOrderByMsidRequest;\n type restaurantsV3Order_universal_d_GetOrderByMsidResponse = GetOrderByMsidResponse;\n type restaurantsV3Order_universal_d_ListOrdersByMsidRequest = ListOrdersByMsidRequest;\n type restaurantsV3Order_universal_d_ListOrdersByMsidResponse = ListOrdersByMsidResponse;\n type restaurantsV3Order_universal_d_NotifyOrderEventResponse = NotifyOrderEventResponse;\n const restaurantsV3Order_universal_d_getTotalActiveOrders: typeof getTotalActiveOrders;\n type restaurantsV3Order_universal_d_GetTotalActiveOrdersOptions = GetTotalActiveOrdersOptions;\n const restaurantsV3Order_universal_d_getOrder: typeof getOrder;\n type restaurantsV3Order_universal_d_GetOrderOptions = GetOrderOptions;\n const restaurantsV3Order_universal_d_listOrders: typeof listOrders;\n type restaurantsV3Order_universal_d_ListOrdersOptions = ListOrdersOptions;\n const restaurantsV3Order_universal_d_acceptOrder: typeof acceptOrder;\n type restaurantsV3Order_universal_d_AcceptOrderOptions = AcceptOrderOptions;\n const restaurantsV3Order_universal_d_cancelOrder: typeof cancelOrder;\n type restaurantsV3Order_universal_d_CancelOrderOptions = CancelOrderOptions;\n const restaurantsV3Order_universal_d_fulfillOrder: typeof fulfillOrder;\n const restaurantsV3Order_universal_d_countOrders: typeof countOrders;\n type restaurantsV3Order_universal_d_CountOrdersOptions = CountOrdersOptions;\n const restaurantsV3Order_universal_d_getOrderByMsid: typeof getOrderByMsid;\n type restaurantsV3Order_universal_d_GetOrderByMsidOptions = GetOrderByMsidOptions;\n const restaurantsV3Order_universal_d_listOrdersByMsid: typeof listOrdersByMsid;\n type restaurantsV3Order_universal_d_ListOrdersByMsidOptions = ListOrdersByMsidOptions;\n const restaurantsV3Order_universal_d_notifyOrderEvent: typeof notifyOrderEvent;\n type restaurantsV3Order_universal_d_NotifyOrderEventOptions = NotifyOrderEventOptions;\n namespace restaurantsV3Order_universal_d {\n export {\n restaurantsV3Order_universal_d_Order as Order,\n restaurantsV3Order_universal_d_Status as Status,\n restaurantsV3Order_universal_d_LineItem as LineItem,\n restaurantsV3Order_universal_d_LineItemOption as LineItemOption,\n restaurantsV3Order_universal_d_DisplayType as DisplayType,\n restaurantsV3Order_universal_d_LineItemOptionItem as LineItemOptionItem,\n restaurantsV3Order_universal_d_CatalogReference as CatalogReference,\n restaurantsV3Order_universal_d_Discount as Discount,\n restaurantsV3Order_universal_d_DiscountType as DiscountType,\n restaurantsV3Order_universal_d_Coupon as Coupon,\n restaurantsV3Order_universal_d_Payment as Payment,\n restaurantsV3Order_universal_d_PaymentType as PaymentType,\n restaurantsV3Order_universal_d_Fulfillment as Fulfillment,\n restaurantsV3Order_universal_d_FulfillmentDetailsOneOf as FulfillmentDetailsOneOf,\n restaurantsV3Order_universal_d_FulfillmentType as FulfillmentType,\n restaurantsV3Order_universal_d_DeliveryDetails as DeliveryDetails,\n restaurantsV3Order_universal_d_DeliveryDetailsProviderOneOf as DeliveryDetailsProviderOneOf,\n restaurantsV3Order_universal_d_DeliveryAddress as DeliveryAddress,\n restaurantsV3Order_universal_d_OnArrival as OnArrival,\n restaurantsV3Order_universal_d_DeliveryAddressLocation as DeliveryAddressLocation,\n restaurantsV3Order_universal_d_Restaurant as Restaurant,\n restaurantsV3Order_universal_d_ExternalProvider as ExternalProvider,\n restaurantsV3Order_universal_d_PickupInfo as PickupInfo,\n restaurantsV3Order_universal_d_DropOffInfo as DropOffInfo,\n restaurantsV3Order_universal_d_PickupDetails as PickupDetails,\n restaurantsV3Order_universal_d_Curbside as Curbside,\n restaurantsV3Order_universal_d_DineInDetails as DineInDetails,\n restaurantsV3Order_universal_d_Customer as Customer,\n restaurantsV3Order_universal_d_CustomerIdOneOf as CustomerIdOneOf,\n restaurantsV3Order_universal_d_Totals as Totals,\n restaurantsV3Order_universal_d_ServiceFee as ServiceFee,\n restaurantsV3Order_universal_d_Money as Money,\n restaurantsV3Order_universal_d_Activity as Activity,\n restaurantsV3Order_universal_d_ChannelInfo as ChannelInfo,\n restaurantsV3Order_universal_d_Type as Type,\n restaurantsV3Order_universal_d_LoyaltyInfo as LoyaltyInfo,\n restaurantsV3Order_universal_d_PosInfo as PosInfo,\n restaurantsV3Order_universal_d_Error as Error,\n restaurantsV3Order_universal_d_PosInfoExternalProvider as PosInfoExternalProvider,\n restaurantsV3Order_universal_d_GetTotalActiveOrdersRequest as GetTotalActiveOrdersRequest,\n restaurantsV3Order_universal_d_GetTotalActiveOrdersResponse as GetTotalActiveOrdersResponse,\n restaurantsV3Order_universal_d_LocationToAmount as LocationToAmount,\n restaurantsV3Order_universal_d_NewOrder as NewOrder,\n restaurantsV3Order_universal_d_GetOrderRequest as GetOrderRequest,\n restaurantsV3Order_universal_d_GetOrderResponse as GetOrderResponse,\n restaurantsV3Order_universal_d_ListOrdersRequest as ListOrdersRequest,\n restaurantsV3Order_universal_d_Sort as Sort,\n restaurantsV3Order_universal_d_FieldName as FieldName,\n restaurantsV3Order_universal_d_SortOrder as SortOrder,\n restaurantsV3Order_universal_d_CursorPaging as CursorPaging,\n restaurantsV3Order_universal_d_ListOrdersResponse as ListOrdersResponse,\n restaurantsV3Order_universal_d_PagingMetadataV2 as PagingMetadataV2,\n restaurantsV3Order_universal_d_Cursors as Cursors,\n restaurantsV3Order_universal_d_AcceptOrderRequest as AcceptOrderRequest,\n restaurantsV3Order_universal_d_AcceptOrderRequestDeliveryTimeOneOf as AcceptOrderRequestDeliveryTimeOneOf,\n restaurantsV3Order_universal_d_AcceptOrderResponse as AcceptOrderResponse,\n restaurantsV3Order_universal_d_OrderAccepted as OrderAccepted,\n restaurantsV3Order_universal_d_CancelOrderRequest as CancelOrderRequest,\n restaurantsV3Order_universal_d_CancelOrderResponse as CancelOrderResponse,\n restaurantsV3Order_universal_d_OrderCanceled as OrderCanceled,\n restaurantsV3Order_universal_d_FulfillOrderRequest as FulfillOrderRequest,\n restaurantsV3Order_universal_d_FulfillOrderResponse as FulfillOrderResponse,\n restaurantsV3Order_universal_d_OrderFulfilled as OrderFulfilled,\n restaurantsV3Order_universal_d_CountOrdersRequest as CountOrdersRequest,\n restaurantsV3Order_universal_d_CountOrdersQuery as CountOrdersQuery,\n restaurantsV3Order_universal_d_DateRangeFilter as DateRangeFilter,\n restaurantsV3Order_universal_d_CountOrdersResponse as CountOrdersResponse,\n restaurantsV3Order_universal_d_DomainEvent as DomainEvent,\n restaurantsV3Order_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n restaurantsV3Order_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n restaurantsV3Order_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n restaurantsV3Order_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n restaurantsV3Order_universal_d_ActionEvent as ActionEvent,\n restaurantsV3Order_universal_d_MessageEnvelope as MessageEnvelope,\n restaurantsV3Order_universal_d_IdentificationData as IdentificationData,\n restaurantsV3Order_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n restaurantsV3Order_universal_d_WebhookIdentityType as WebhookIdentityType,\n restaurantsV3Order_universal_d_NotifyOrderEventRequest as NotifyOrderEventRequest,\n restaurantsV3Order_universal_d_EventType as EventType,\n restaurantsV3Order_universal_d_Empty as Empty,\n restaurantsV3Order_universal_d_GetOrderByMsidRequest as GetOrderByMsidRequest,\n restaurantsV3Order_universal_d_GetOrderByMsidResponse as GetOrderByMsidResponse,\n restaurantsV3Order_universal_d_ListOrdersByMsidRequest as ListOrdersByMsidRequest,\n restaurantsV3Order_universal_d_ListOrdersByMsidResponse as ListOrdersByMsidResponse,\n restaurantsV3Order_universal_d_NotifyOrderEventResponse as NotifyOrderEventResponse,\n restaurantsV3Order_universal_d_getTotalActiveOrders as getTotalActiveOrders,\n restaurantsV3Order_universal_d_GetTotalActiveOrdersOptions as GetTotalActiveOrdersOptions,\n restaurantsV3Order_universal_d_getOrder as getOrder,\n restaurantsV3Order_universal_d_GetOrderOptions as GetOrderOptions,\n restaurantsV3Order_universal_d_listOrders as listOrders,\n restaurantsV3Order_universal_d_ListOrdersOptions as ListOrdersOptions,\n restaurantsV3Order_universal_d_acceptOrder as acceptOrder,\n restaurantsV3Order_universal_d_AcceptOrderOptions as AcceptOrderOptions,\n restaurantsV3Order_universal_d_cancelOrder as cancelOrder,\n restaurantsV3Order_universal_d_CancelOrderOptions as CancelOrderOptions,\n restaurantsV3Order_universal_d_fulfillOrder as fulfillOrder,\n restaurantsV3Order_universal_d_countOrders as countOrders,\n restaurantsV3Order_universal_d_CountOrdersOptions as CountOrdersOptions,\n restaurantsV3Order_universal_d_getOrderByMsid as getOrderByMsid,\n restaurantsV3Order_universal_d_GetOrderByMsidOptions as GetOrderByMsidOptions,\n restaurantsV3Order_universal_d_listOrdersByMsid as listOrdersByMsid,\n restaurantsV3Order_universal_d_ListOrdersByMsidOptions as ListOrdersByMsidOptions,\n restaurantsV3Order_universal_d_notifyOrderEvent as notifyOrderEvent,\n restaurantsV3Order_universal_d_NotifyOrderEventOptions as NotifyOrderEventOptions,\n };\n }\n \n export { restaurantsCatalogsV3Catalog_universal_d as catalogs, restaurantsCatalogsV3Discount_universal_d as discount, restaurantsFulfillmentsV3FulfillmentMethod_universal_d as fulfillemtMethods, restaurantsV1FulfillmentMethod_universal_d as fulfillmentMethods, localdeliveryV1Tpa_universal_d as localDelivery, localdeliverySpiV1Tpa_universal_d as localDeliverySpi, restaurantsOperationsV1Operation_universal_d as operations, restaurantsOrdersettingsV3OrderSettings_universal_d as orderSettings, restaurantsV3Order_universal_d as orders, restaurantsPostpaapiV1Configuration_universal_d as posTpa, restaurantsRestaurantlocationsV3RestaurantLocation_universal_d as restaurantLocations };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-jackal-backend.d.ts", "content": "declare module \"wix-jackal-backend\" {\n /** Wishlist is the main entity of WishlistService that can be used for lorem ipsum dolor */\n interface Wishlist {\n /** Wishlist ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n email?: string | null;\n vip?: boolean;\n items?: WishlistItem[];\n }\n interface WishlistItem {\n _id?: string;\n type?: string;\n }\n interface CreateWishlistResponse {\n /** The created Wishlist */\n wishlist?: Wishlist;\n }\n interface GetWishlistResponse {\n /** The retrieved Wishlist */\n wishlist?: Wishlist;\n }\n interface UpdateWishlistResponse {\n /** The updated Wishlist */\n wishlist?: Wishlist;\n }\n interface DeleteWishlistResponse {\n }\n interface QueryV2 {\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 /** 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 /** 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 QueryWishlistResponse {\n /** The retrieved Wishlists */\n wishlists?: Wishlist[];\n }\n interface UpdateWishlistWishlist {\n /** Wishlist ID */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n email?: string | null;\n vip?: boolean;\n items?: WishlistItem[];\n }\n interface UpdateWishlistOptions {\n mask?: string[];\n }\n \n function createWishlist(wishlist: Wishlist): Promise;\n function getWishlist(wishlistId: string): Promise;\n function updateWishlist(_id: string | null, wishlist: UpdateWishlistWishlist, options: UpdateWishlistOptions): Promise;\n function deleteWishlist(wishlistId: string, revision: string): Promise;\n function queryWishlist(query: QueryV2): Promise;\n \n export { createWishlist, deleteWishlist, getWishlist, queryWishlist, updateWishlist };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-atlas-places-backend.d.ts", "content": "declare module \"wix-atlas-places-backend\" {\n interface Place {\n placeId?: string;\n address?: Address;\n types?: string[];\n }\n /** Physical address */\n interface Address {\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 formattedAddress?: string | null;\n /** Free text for human-to-human textual orientation aid purposes */\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 /** 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 /** apartment number */\n apt?: string;\n }\n interface AddressLocation {\n latitude?: number | null;\n longitude?: number | null;\n }\n interface Subdivision {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n type?: SubdivisionType;\n /** a free-text description of subdivision type */\n typeInfo?: string | null;\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 /** cities/towns */\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 GetPlaceResponse {\n place?: Place;\n }\n \n function getPlace(searchId: string): Promise;\n \n export { getPlace };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-activity-counters-backend.d.ts", "content": "declare module \"wix-activity-counters-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface ActivityCounter {\n /** Member ID. */\n memberId?: string;\n /** App ID. */\n appId?: string;\n /** Counters for this member and this app. */\n counters?: Counter[];\n }\n interface Counter {\n /** Key of the counter. Must be unique within a given app. */\n key?: string;\n /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app 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 be 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 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 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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 per app.\n * @param counter - Site member ID whose counter will be set.\n * @public\n * @documentationMaturity preview\n * @requiredField counter\n * @requiredField memberId\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 per app.\n * @param counter - Site member ID whose counter will be increment.\n * @documentationMaturity preview\n * @requiredField counter\n * @requiredField memberId\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 apps. However, third parties can only read their own private counters, not those from others' apps.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\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 */\n function queryActivityCounters(options?: QueryActivityCountersOptions): Promise;\n interface QueryActivityCountersOptions {\n query?: Query;\n }\n \n export { ActivityCounter, Counter, GetActivityCountersRequest, GetActivityCountersResponse, IncrementActivityCountersRequest, IncrementActivityCountersResponse, Paging, PagingMetadata, Query, QueryActivityCountersOptions, QueryActivityCountersRequest, QueryActivityCountersResponse, SetActivityCountersRequest, SetActivityCountersResponse, __debug, getActivityCounters, incrementActivityCounters, queryActivityCounters, setActivityCounters };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-atlas-autocomplete-backend.d.ts", "content": "declare module \"wix-atlas-autocomplete-backend\" {\n interface Prediction {\n /** The human-readable name of the prediction */\n description?: string;\n /** The id of the prediction that can be use in place api. Available for short time. */\n searchId?: string;\n /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */\n matchedSubstrings?: MatchedSubstrings[];\n /** Provides pre-formatted text that can be shown in your autocomplete results */\n textStructure?: TextStructure;\n /** Contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. */\n distanceInMeters?: number | null;\n }\n interface MatchedSubstrings {\n length?: number;\n offset?: number;\n }\n interface TextStructure {\n /** Contains the main text of a prediction, usually the name of the place */\n mainText?: string;\n /** Contains the secondary text of a prediction, usually the location of the place */\n secondaryText?: string;\n /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */\n mainTextMatchedSubstrings?: MatchedSubstrings[];\n }\n interface AddressLocation {\n latitude?: number | null;\n longitude?: number | null;\n }\n interface FilterBy {\n /** One of the filter types enum */\n filterType?: FilterType;\n /** Free text like \"us\" */\n filterValue?: string;\n }\n enum FilterType {\n /** Filter by zip code */\n zip_code = \"zip_code\",\n /** Filter by 2-letters or 3-letters country code */\n country_code = \"country_code\"\n }\n interface ListPredictionsResponse {\n predictions?: Prediction[];\n }\n interface PredictResponse {\n predictions?: Prediction[];\n }\n interface ListPredictionsOptions {\n origin?: AddressLocation;\n location?: AddressLocation;\n radius?: string | null;\n filterBy?: FilterBy[];\n }\n interface PredictOptions {\n origin?: AddressLocation;\n location?: AddressLocation;\n radius?: string | null;\n countryCodes?: string[];\n }\n \n function listPredictions(input: string, options: ListPredictionsOptions): Promise;\n function predict(input: string, options: PredictOptions): Promise;\n \n export { listPredictions, predict };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-livevideo-backend.d.ts", "content": "declare module \"wix-livevideo-backend\" {\n interface ChatMessage {\n /** Message unique ID. */\n _id?: string | null;\n /** Message body. */\n body?: string | null;\n /** Message timestamp. */\n created?: Date | null;\n /** Creator of this message. */\n participantId?: string | null;\n /** Indicates if message is highlighted. */\n highlighted?: boolean | null;\n }\n interface ManagementListChatMessagesRequest {\n /**\n * Live session unique ID\n * @readonly\n */\n sessionId: string;\n /** Number of messages to load per page. */\n limit?: number;\n /**\n * If defined - messages older than defined message will be returned (exclusive).\n * Otherwise latest messages will be returned.\n */\n messageId?: string | null;\n /** If true - only highlighted messaged will be returned. */\n highlighted?: boolean | null;\n }\n interface ManagementListChatMessagesResponse {\n messages?: ChatMessage[];\n }\n interface DeleteChatMessagesRequest {\n /**\n * Live session unique ID\n * @readonly\n */\n sessionId: string;\n /** Messages to delete. */\n messages: string[];\n }\n interface DeleteChatMessagesResponse {\n }\n interface UpdateChatMessageRequest {\n /**\n * Live session unique ID\n * @readonly\n */\n sessionId: string;\n message: ChatMessage;\n /** @internal */\n fieldMask?: string[];\n }\n interface UpdateChatMessageResponse {\n message?: ChatMessage;\n }\n interface SendChatMessageRequest {\n /** Token for chat API authorization. */\n authorization: string;\n /** Chat message body. */\n body: string | null;\n }\n interface SendChatMessageResponse {\n message?: ChatMessage;\n }\n interface ListChatMessagesRequest {\n /** Token for chat API authorization. */\n authorization: string;\n /** Number of messages to load per page. */\n limit?: number;\n /**\n * If defined - messages older than defined message will be returned (exclusive).\n * Otherwise latest messages will be returned.\n */\n messageId?: string | null;\n /** If true - only highlighted messaged will be returned. */\n highlighted?: boolean | null;\n }\n interface ListChatMessagesResponse {\n messages?: ChatMessage[];\n }\n /**\n * Endpoint for listing chat messages. Latest messages are returned first.\n * @param sessionId - Live session unique ID\n * @internal\n * @documentationMaturity preview\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_CHAT\n * @adminMethod\n */\n function listChatMessages(sessionId: string, options?: ListChatMessagesOptions): Promise;\n interface ListChatMessagesOptions {\n /** Number of messages to load per page. */\n limit?: number;\n /**\n * If defined - messages older than defined message will be returned (exclusive).\n * Otherwise latest messages will be returned.\n */\n messageId?: string | null;\n /** If true - only highlighted messaged will be returned. */\n highlighted?: boolean | null;\n }\n /**\n * Endpoint for deleting chat messages.\n * @param sessionId - Live session unique ID\n * @param messages - Messages to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField messages\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_CHAT\n * @adminMethod\n */\n function deleteChatMessages(sessionId: string, messages: string[]): Promise;\n /**\n * Endpoint for updating chat messages.\n * @param sessionId - Live session unique ID\n * @internal\n * @documentationMaturity preview\n * @requiredField message\n * @requiredField message._id\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_CHAT\n * @adminMethod\n */\n function updateChatMessage(sessionId: string, message: ChatMessage, options?: UpdateChatMessageOptions): Promise;\n interface UpdateChatMessageOptions {\n /** @internal */\n fieldMask?: string[];\n }\n /**\n * Endpoint for creating a chat message.\n * @param authorization - Token for chat API authorization.\n * @internal\n * @documentationMaturity preview\n * @requiredField authorization\n * @requiredField options\n * @requiredField options.body\n * @permissionId LIVE_VIDEO.CHAT\n */\n function sendChatMessage(authorization: string, options: SendChatMessageOptions): Promise;\n interface SendChatMessageOptions {\n /** Chat message body. */\n body: string | null;\n }\n /**\n * Endpoint for listing chat messages. Latest messages are returned first.\n * @param authorization - Token for chat API authorization.\n * @internal\n * @documentationMaturity preview\n * @requiredField authorization\n * @permissionId LIVE_VIDEO.READ_CHAT\n */\n function publicListChatMessages(authorization: string, options?: PublicListChatMessagesOptions): Promise;\n interface PublicListChatMessagesOptions {\n /** Number of messages to load per page. */\n limit?: number;\n /**\n * If defined - messages older than defined message will be returned (exclusive).\n * Otherwise latest messages will be returned.\n */\n messageId?: string | null;\n /** If true - only highlighted messaged will be returned. */\n highlighted?: boolean | null;\n }\n \n type livevideoV1Chat_universal_d_ChatMessage = ChatMessage;\n type livevideoV1Chat_universal_d_ManagementListChatMessagesRequest = ManagementListChatMessagesRequest;\n type livevideoV1Chat_universal_d_ManagementListChatMessagesResponse = ManagementListChatMessagesResponse;\n type livevideoV1Chat_universal_d_DeleteChatMessagesRequest = DeleteChatMessagesRequest;\n type livevideoV1Chat_universal_d_DeleteChatMessagesResponse = DeleteChatMessagesResponse;\n type livevideoV1Chat_universal_d_UpdateChatMessageRequest = UpdateChatMessageRequest;\n type livevideoV1Chat_universal_d_UpdateChatMessageResponse = UpdateChatMessageResponse;\n type livevideoV1Chat_universal_d_SendChatMessageRequest = SendChatMessageRequest;\n type livevideoV1Chat_universal_d_SendChatMessageResponse = SendChatMessageResponse;\n type livevideoV1Chat_universal_d_ListChatMessagesRequest = ListChatMessagesRequest;\n type livevideoV1Chat_universal_d_ListChatMessagesResponse = ListChatMessagesResponse;\n const livevideoV1Chat_universal_d_listChatMessages: typeof listChatMessages;\n type livevideoV1Chat_universal_d_ListChatMessagesOptions = ListChatMessagesOptions;\n const livevideoV1Chat_universal_d_deleteChatMessages: typeof deleteChatMessages;\n const livevideoV1Chat_universal_d_updateChatMessage: typeof updateChatMessage;\n type livevideoV1Chat_universal_d_UpdateChatMessageOptions = UpdateChatMessageOptions;\n const livevideoV1Chat_universal_d_sendChatMessage: typeof sendChatMessage;\n type livevideoV1Chat_universal_d_SendChatMessageOptions = SendChatMessageOptions;\n const livevideoV1Chat_universal_d_publicListChatMessages: typeof publicListChatMessages;\n type livevideoV1Chat_universal_d_PublicListChatMessagesOptions = PublicListChatMessagesOptions;\n namespace livevideoV1Chat_universal_d {\n export {\n livevideoV1Chat_universal_d_ChatMessage as ChatMessage,\n livevideoV1Chat_universal_d_ManagementListChatMessagesRequest as ManagementListChatMessagesRequest,\n livevideoV1Chat_universal_d_ManagementListChatMessagesResponse as ManagementListChatMessagesResponse,\n livevideoV1Chat_universal_d_DeleteChatMessagesRequest as DeleteChatMessagesRequest,\n livevideoV1Chat_universal_d_DeleteChatMessagesResponse as DeleteChatMessagesResponse,\n livevideoV1Chat_universal_d_UpdateChatMessageRequest as UpdateChatMessageRequest,\n livevideoV1Chat_universal_d_UpdateChatMessageResponse as UpdateChatMessageResponse,\n livevideoV1Chat_universal_d_SendChatMessageRequest as SendChatMessageRequest,\n livevideoV1Chat_universal_d_SendChatMessageResponse as SendChatMessageResponse,\n livevideoV1Chat_universal_d_ListChatMessagesRequest as ListChatMessagesRequest,\n livevideoV1Chat_universal_d_ListChatMessagesResponse as ListChatMessagesResponse,\n livevideoV1Chat_universal_d_listChatMessages as listChatMessages,\n livevideoV1Chat_universal_d_ListChatMessagesOptions as ListChatMessagesOptions,\n livevideoV1Chat_universal_d_deleteChatMessages as deleteChatMessages,\n livevideoV1Chat_universal_d_updateChatMessage as updateChatMessage,\n livevideoV1Chat_universal_d_UpdateChatMessageOptions as UpdateChatMessageOptions,\n livevideoV1Chat_universal_d_sendChatMessage as sendChatMessage,\n livevideoV1Chat_universal_d_SendChatMessageOptions as SendChatMessageOptions,\n livevideoV1Chat_universal_d_publicListChatMessages as publicListChatMessages,\n livevideoV1Chat_universal_d_PublicListChatMessagesOptions as PublicListChatMessagesOptions,\n };\n }\n \n interface Participant$1 {\n /** The ID of the session. */\n sessionId?: string;\n participantId?: string;\n /** Participant name */\n name?: string | null;\n /**\n * External id of entrance\n * @readonly\n */\n externalEntranceId?: string | null;\n /** Participant state */\n state?: ParticipantState$1[];\n /** @readonly */\n clientId?: string | null;\n /** @readonly */\n wixUserId?: string | null;\n /** @readonly */\n memberId?: string | null;\n /** @readonly */\n visitorId?: string | null;\n }\n enum ParticipantState$1 {\n /** Participant is a session manager */\n MANAGER = \"MANAGER\",\n /** Participant is banned */\n BANNED = \"BANNED\",\n /** Participant is hidden */\n HIDDEN = \"HIDDEN\",\n /** Participant is video recording bot */\n VIDEO_RECORDER = \"VIDEO_RECORDER\",\n /** Participant is video streaming bot */\n VIDEO_STREAMER = \"VIDEO_STREAMER\"\n }\n interface UpdateParticipantRequest$1 {\n participant: Participant$1;\n /** @internal */\n fieldMask?: string[];\n }\n interface UpdateParticipantResponse$1 {\n /** Updated participant */\n participant?: Participant$1;\n }\n interface RemoveParticipantRequest$1 {\n /** The ID of the session. */\n sessionId: string;\n /** The ID of the participant. */\n participantId: string;\n }\n interface RemoveParticipantResponse$1 {\n participant?: Participant$1;\n }\n interface QueryParticipantsRequest$1 {\n /** Query for listing participants. session_id EQ filter is mandatory. */\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$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$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 Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 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 QueryParticipantsResponse$1 {\n /** Participants */\n participants?: Participant$1[];\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$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 * @internal\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 /** @internal\n * @documentationMaturity preview\n * @requiredField participant\n * @requiredField participant.participantId\n * @requiredField participant.sessionId\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n * @returns Updated participant\n */\n function updateParticipant(participant: Participant$1, options?: UpdateParticipantOptions): Promise;\n interface UpdateParticipantOptions {\n /** @internal */\n fieldMask?: string[];\n }\n /** @param sessionId - The ID of the session.\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.participantId\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function removeParticipant(sessionId: string, options: RemoveParticipantOptions): Promise;\n interface RemoveParticipantOptions {\n /** The ID of the participant. */\n participantId: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function queryParticipants(): ParticipantsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ParticipantsQueryResult extends QueryCursorResult$1 {\n items: Participant$1[];\n query: ParticipantsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ParticipantsQueryBuilder {\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) => ParticipantsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ParticipantsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n const livevideoV1Participant_universal_d_updateParticipant: typeof updateParticipant;\n type livevideoV1Participant_universal_d_UpdateParticipantOptions = UpdateParticipantOptions;\n const livevideoV1Participant_universal_d_removeParticipant: typeof removeParticipant;\n type livevideoV1Participant_universal_d_RemoveParticipantOptions = RemoveParticipantOptions;\n const livevideoV1Participant_universal_d_queryParticipants: typeof queryParticipants;\n type livevideoV1Participant_universal_d_ParticipantsQueryResult = ParticipantsQueryResult;\n type livevideoV1Participant_universal_d_ParticipantsQueryBuilder = ParticipantsQueryBuilder;\n namespace livevideoV1Participant_universal_d {\n export {\n Participant$1 as Participant,\n ParticipantState$1 as ParticipantState,\n UpdateParticipantRequest$1 as UpdateParticipantRequest,\n UpdateParticipantResponse$1 as UpdateParticipantResponse,\n RemoveParticipantRequest$1 as RemoveParticipantRequest,\n RemoveParticipantResponse$1 as RemoveParticipantResponse,\n QueryParticipantsRequest$1 as QueryParticipantsRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$1 as Paging,\n CursorPaging$1 as CursorPaging,\n QueryParticipantsResponse$1 as QueryParticipantsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n livevideoV1Participant_universal_d_updateParticipant as updateParticipant,\n livevideoV1Participant_universal_d_UpdateParticipantOptions as UpdateParticipantOptions,\n livevideoV1Participant_universal_d_removeParticipant as removeParticipant,\n livevideoV1Participant_universal_d_RemoveParticipantOptions as RemoveParticipantOptions,\n livevideoV1Participant_universal_d_queryParticipants as queryParticipants,\n livevideoV1Participant_universal_d_ParticipantsQueryResult as ParticipantsQueryResult,\n livevideoV1Participant_universal_d_ParticipantsQueryBuilder as ParticipantsQueryBuilder,\n };\n }\n \n interface Reaction {\n /** Reaction unique ID. */\n _id?: string | null;\n /** Reaction emoji. */\n emoji?: string;\n /** Reaction timestamp. */\n created?: Date | null;\n /** Creator of this reaction. */\n participantId?: string | null;\n }\n interface ManagementListReactionsRequest {\n /**\n * Live session unique ID\n * @readonly\n */\n sessionId: string;\n /** Number of reactions to load per page. */\n limit?: number;\n /** Number of reactions to skip per page. */\n offset?: number;\n /** Filter facets to include in the response. Supported facets: 'emoji' */\n facet?: string[];\n }\n interface ManagementListReactionsResponse {\n reactions?: Reaction[];\n /** Total number of reactions. */\n total?: number;\n /** Facets. */\n facets?: Record;\n }\n interface ManagementFacetCounts {\n /** Facet counts aggregated per value. */\n counts?: Record;\n }\n interface ReactRequest {\n /** Token for reactions API authorization. */\n authorization: string;\n /**\n * Allowed emojis:\n * :thumbsup:\n * :raisedhand:\n * :heart:\n * :fire:\n * :lolol:\n */\n emoji?: string;\n }\n interface ReactResponse {\n reaction?: Reaction;\n }\n interface ListReactionsRequest {\n /** Token for reactions API authorization. */\n authorization: string;\n /** Number of reactions to load per page. */\n limit?: number;\n /** Number of reactions to skip per page. */\n offset?: number;\n /** Filter facets to include in the response. Supported facets: 'emoji' */\n facet?: string[];\n }\n interface ListReactionsResponse {\n reactions?: Reaction[];\n /** Total number of reactions. */\n total?: number;\n /** Facets. */\n facets?: Record;\n }\n interface FacetCounts {\n /** Facet counts aggregated per value. */\n counts?: Record;\n }\n /**\n * Endpoint for listing reactions.\n * @param sessionId - Live session unique ID\n * @internal\n * @documentationMaturity preview\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_REACTIONS\n * @adminMethod\n */\n function backofficeListReactions(sessionId: string, options?: BackofficeListReactionsOptions): Promise;\n interface BackofficeListReactionsOptions {\n /** Number of reactions to load per page. */\n limit?: number;\n /** Number of reactions to skip per page. */\n offset?: number;\n /** Filter facets to include in the response. Supported facets: 'emoji' */\n facet?: string[];\n }\n /**\n * Endpoint for sending a reaction.\n * @param authorization - Token for reactions API authorization.\n * @internal\n * @documentationMaturity preview\n * @requiredField authorization\n * @permissionId LIVE_VIDEO.REACT\n */\n function react(authorization: string, options?: ReactOptions): Promise;\n interface ReactOptions {\n /**\n * Allowed emojis:\n * :thumbsup:\n * :raisedhand:\n * :heart:\n * :fire:\n * :lolol:\n */\n emoji?: string;\n }\n /**\n * Endpoint for listing reactions.\n * @param authorization - Token for reactions API authorization.\n * @internal\n * @documentationMaturity preview\n * @requiredField authorization\n * @permissionId LIVE_VIDEO.READ_REACTIONS\n */\n function listReactions(authorization: string, options?: ListReactionsOptions): Promise;\n interface ListReactionsOptions {\n /** Number of reactions to load per page. */\n limit?: number;\n /** Number of reactions to skip per page. */\n offset?: number;\n /** Filter facets to include in the response. Supported facets: 'emoji' */\n facet?: string[];\n }\n \n type livevideoV1Reaction_universal_d_Reaction = Reaction;\n type livevideoV1Reaction_universal_d_ManagementListReactionsRequest = ManagementListReactionsRequest;\n type livevideoV1Reaction_universal_d_ManagementListReactionsResponse = ManagementListReactionsResponse;\n type livevideoV1Reaction_universal_d_ManagementFacetCounts = ManagementFacetCounts;\n type livevideoV1Reaction_universal_d_ReactRequest = ReactRequest;\n type livevideoV1Reaction_universal_d_ReactResponse = ReactResponse;\n type livevideoV1Reaction_universal_d_ListReactionsRequest = ListReactionsRequest;\n type livevideoV1Reaction_universal_d_ListReactionsResponse = ListReactionsResponse;\n type livevideoV1Reaction_universal_d_FacetCounts = FacetCounts;\n const livevideoV1Reaction_universal_d_backofficeListReactions: typeof backofficeListReactions;\n type livevideoV1Reaction_universal_d_BackofficeListReactionsOptions = BackofficeListReactionsOptions;\n const livevideoV1Reaction_universal_d_react: typeof react;\n type livevideoV1Reaction_universal_d_ReactOptions = ReactOptions;\n const livevideoV1Reaction_universal_d_listReactions: typeof listReactions;\n type livevideoV1Reaction_universal_d_ListReactionsOptions = ListReactionsOptions;\n namespace livevideoV1Reaction_universal_d {\n export {\n livevideoV1Reaction_universal_d_Reaction as Reaction,\n livevideoV1Reaction_universal_d_ManagementListReactionsRequest as ManagementListReactionsRequest,\n livevideoV1Reaction_universal_d_ManagementListReactionsResponse as ManagementListReactionsResponse,\n livevideoV1Reaction_universal_d_ManagementFacetCounts as ManagementFacetCounts,\n livevideoV1Reaction_universal_d_ReactRequest as ReactRequest,\n livevideoV1Reaction_universal_d_ReactResponse as ReactResponse,\n livevideoV1Reaction_universal_d_ListReactionsRequest as ListReactionsRequest,\n livevideoV1Reaction_universal_d_ListReactionsResponse as ListReactionsResponse,\n livevideoV1Reaction_universal_d_FacetCounts as FacetCounts,\n livevideoV1Reaction_universal_d_backofficeListReactions as backofficeListReactions,\n livevideoV1Reaction_universal_d_BackofficeListReactionsOptions as BackofficeListReactionsOptions,\n livevideoV1Reaction_universal_d_react as react,\n livevideoV1Reaction_universal_d_ReactOptions as ReactOptions,\n livevideoV1Reaction_universal_d_listReactions as listReactions,\n livevideoV1Reaction_universal_d_ListReactionsOptions as ListReactionsOptions,\n };\n }\n \n interface LiveSession extends LiveSessionBroadcastChannelOneOf {\n /** @readonly */\n meeting?: Meeting;\n /**\n * Live session unique ID\n * @readonly\n */\n _id?: string | null;\n /** Live session name */\n name?: string | null;\n /** Session start timestamp. */\n startDate?: Date | null;\n /** Duration in minutes */\n duration?: number | null;\n /**\n * Session time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.\n * @deprecated\n */\n timeZoneId?: string | null;\n /** @deprecated */\n broadcastType?: BroadcastType;\n /**\n * @readonly\n * @deprecated\n */\n broadcastState?: BroadcastState;\n /**\n * Session created timestamp.\n * @readonly\n * @deprecated\n */\n created?: Date | null;\n /**\n * Session modified timestamp.\n * @readonly\n * @deprecated\n */\n modified?: Date | null;\n /**\n * Session entity reference.\n * @internal\n */\n entityReference?: EntityReference;\n /**\n * Session time log.\n * @readonly\n */\n sessionTimeLog?: TimeLog;\n /**\n * Session created timestamp.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Session modified timestamp.\n * @readonly\n */\n modifiedDate?: Date | null;\n sessionType?: SessionType;\n /** @readonly */\n sessionState?: SessionState;\n sessionFlags?: SessionFlag[];\n /** @readonly */\n messagingChannel?: MessagingChannel[];\n /** Client provided Optional External Id related to live session, e.g., Event, BroadcastChannel Meeting */\n externalId?: string | null;\n }\n /** @oneof */\n interface LiveSessionBroadcastChannelOneOf {\n /** @readonly */\n meeting?: Meeting;\n }\n enum BroadcastType {\n /** Every participant is a publisher of video and audio */\n MEETING = \"MEETING\",\n /** Only organizers are publishers of video and audio */\n WEBINAR = \"WEBINAR\"\n }\n enum BroadcastState {\n NOT_STARTED = \"NOT_STARTED\",\n STARTED = \"STARTED\",\n ENDED = \"ENDED\"\n }\n interface Meeting {\n /**\n * External meeting ID\n * @internal\n * @readonly\n */\n externalId?: string | null;\n /**\n * Meeting started\n * @readonly\n */\n created?: Date | null;\n /**\n * AWS Chime media region\n * @readonly\n */\n region?: string | null;\n }\n interface EntityReference {\n /**\n * App def ID.\n * @deprecated\n */\n appDefId?: string;\n /** App instance ID. */\n instanceId?: string;\n /** Entity type. */\n entityType?: string;\n /** Entity ID. Related to entity type. */\n entityId?: string;\n /** Wix App ID. */\n wixAppId?: string | null;\n }\n interface TimeLog {\n /**\n * Time log start timestamp.\n * @readonly\n */\n startDate?: Date | null;\n /**\n * Time log end timestamp.\n * @readonly\n */\n endDate?: Date | null;\n /**\n * Time log seconds duration.\n * @readonly\n * @deprecated\n */\n duration?: number | null;\n /**\n * Time log seconds duration.\n * @readonly\n */\n durationInSeconds?: number | null;\n }\n enum SessionType {\n /** Every participant is a publisher of video and audio */\n MEETING = \"MEETING\",\n /** Only organizers are publishers of video and audio */\n WEBINAR = \"WEBINAR\"\n }\n enum SessionState {\n NOT_STARTED = \"NOT_STARTED\",\n STARTED = \"STARTED\",\n ENDED = \"ENDED\"\n }\n enum SessionFlag {\n /** Can be used for filtering out hidden sessions in the UI */\n HIDDEN = \"HIDDEN\",\n /** Session is created for testing. Participant count and session duration restrictions apply. */\n TEST = \"TEST\"\n }\n interface MessagingChannel {\n /** @readonly */\n channelName?: string | null;\n /** @readonly */\n resourceId?: string | null;\n }\n interface DescribeEntranceRequest {\n /** The ID of the session. */\n sessionId: string;\n /** Token from entrance_link */\n token: string | null;\n }\n interface DescribeEntranceResponse {\n session?: LiveSession;\n /** Participant details */\n participant?: Participant;\n /** Currently joined participant count */\n joinedParticipantCount?: number | null;\n }\n interface Participant {\n /** The ID of the session. */\n sessionId?: string;\n participantId?: string;\n /** Participant name */\n name?: string | null;\n /**\n * External id of entrance\n * @readonly\n */\n externalEntranceId?: string | null;\n /** Participant state */\n state?: ParticipantState[];\n /** @readonly */\n clientId?: string | null;\n /** @readonly */\n wixUserId?: string | null;\n /** @readonly */\n memberId?: string | null;\n /** @readonly */\n visitorId?: string | null;\n }\n enum ParticipantState {\n /** Participant is a session manager */\n MANAGER = \"MANAGER\",\n /** Participant is banned */\n BANNED = \"BANNED\",\n /** Participant is hidden */\n HIDDEN = \"HIDDEN\",\n /** Participant is video recording bot */\n VIDEO_RECORDER = \"VIDEO_RECORDER\",\n /** Participant is video streaming bot */\n VIDEO_STREAMER = \"VIDEO_STREAMER\"\n }\n interface AddParticipantRequest {\n /** The ID of the session. */\n sessionId: string;\n /** Token from entrance_link */\n token?: string | null;\n /** Update participant name */\n name?: string | null;\n }\n interface AddParticipantResponse extends AddParticipantResponseClientPropertiesOneOf {\n props?: PropsV1;\n propsV2?: PropsV2;\n session?: LiveSession;\n /** Participant details */\n participant?: Participant;\n /** Token for participant api authorization */\n authorization?: string;\n }\n /** @oneof */\n interface AddParticipantResponseClientPropertiesOneOf {\n props?: PropsV1;\n propsV2?: PropsV2;\n }\n interface PropsV1 {\n key?: number;\n sid?: string;\n token?: string;\n }\n interface PropsV2 {\n meeting?: Record | null;\n attendee?: Record | null;\n }\n interface ListParticipantsRequest {\n /** Token for participant api authorization */\n authorization?: string;\n /** Optional participant id filter */\n participantId?: string[];\n }\n interface ListParticipantsResponse {\n /** Participants */\n participants?: Participant[];\n }\n interface FallbackJoinRequest {\n /** The ID of the session. */\n sessionId: string;\n /** Meta site id. */\n m: string;\n /** Token. */\n t: string;\n /** Request language. */\n lang?: string | null;\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 DescribeLiveSessionsRequest {\n }\n interface DescribeLiveSessionsResponse {\n /** Limit of sessions to be created and started */\n sessionLimit?: number | null;\n }\n interface GetLiveSessionRequest {\n _id: string;\n }\n interface GetLiveSessionResponse {\n session?: LiveSession;\n }\n interface CreateLiveSessionRequest {\n session: LiveSession;\n }\n interface CreateLiveSessionResponse {\n session?: LiveSession;\n }\n interface UpdateLiveSessionRequest {\n session: LiveSession;\n /** @internal */\n fieldMask?: string[];\n }\n interface UpdateLiveSessionResponse {\n session?: LiveSession;\n }\n interface DeleteLiveSessionRequest {\n _id: string;\n }\n interface DeleteLiveSessionResponse {\n }\n interface QueryLiveSessionsRequest {\n /**\n * Query for listing LiveSessions, with the following indexes: \"LiveSession.id\", \"LiveSession.tag\", \"LiveSession.status\".\n * The query is optional, if no query is provided then the non-deleted LiveSessions will be returned.\n */\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryLiveSessionsResponse {\n entries?: LiveSession[];\n offset?: number;\n totalCount?: number;\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface StartLiveSessionRequest {\n /** The ID of the session. */\n sessionId: string;\n /**\n * AWS Chime media region\n * https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html\n * default: \"us-east-1\"\n */\n region?: string | null;\n }\n interface StartLiveSessionResponse {\n session?: LiveSession;\n }\n interface EndLiveSessionRequest {\n /** The ID of the session. */\n sessionId: string;\n }\n interface EndLiveSessionResponse {\n session?: LiveSession;\n }\n interface CreateEntranceLinkRequest {\n /** Session to create an entrance link for */\n sessionId: string;\n /** Single participant use at the time */\n limited?: boolean;\n /** Optional participant name (can be changed later) */\n name?: string | null;\n }\n interface CreateEntranceLinkResponse {\n /** Link to dashboard */\n managementLink?: string;\n /** Format: https://mysite.com/live-video/{session_id}?t={token} */\n entranceLink?: string;\n /** Resolved entrance token */\n entranceToken?: string;\n /** Predefined for limited link */\n participant?: Participant;\n }\n interface CreateEntranceRequest {\n /** Session to create an entrance link for */\n sessionId: string;\n entrances?: Entrance[];\n }\n interface Entrance extends EntranceEntranceTypeOneOf {\n universal?: UniversalEntrance;\n personal?: PersonalEntrance;\n videoRecorder?: VideoRecorderEntrance;\n videoStreamer?: VideoStreamerEntrance;\n }\n /** @oneof */\n interface EntranceEntranceTypeOneOf {\n universal?: UniversalEntrance;\n personal?: PersonalEntrance;\n videoRecorder?: VideoRecorderEntrance;\n videoStreamer?: VideoStreamerEntrance;\n }\n interface UniversalEntrance {\n /**\n * Entrance link\n * @readonly\n */\n link?: EntranceLink;\n }\n interface EntranceLink {\n /**\n * Format: https://mysite.com/live-video/{session_id}?t={token}\n * @readonly\n */\n url?: string | null;\n /**\n * Entrance token\n * @readonly\n */\n token?: string | null;\n /**\n * Format: https://www.wix.com/_api/livevideo-server/v1/join/{session_id}?m={metasiteID}&t={token}\n * @readonly\n */\n fallbackUrl?: string | null;\n }\n interface PersonalEntrance {\n /** Unique per site external person id guarantees idempotent link generation */\n externalId?: string;\n /** Optional participant name (can be changed later) */\n name?: string | null;\n /**\n * Entrance link\n * @readonly\n */\n link?: EntranceLink;\n /**\n * Predefined participant\n * @readonly\n */\n participant?: Participant;\n }\n interface VideoRecorderEntrance {\n /**\n * Entrance link\n * @readonly\n */\n link?: EntranceLink;\n /**\n * Predefined participant\n * @readonly\n */\n participant?: Participant;\n }\n interface VideoStreamerEntrance {\n /**\n * Entrance link\n * @readonly\n */\n link?: EntranceLink;\n /**\n * Predefined participant\n * @readonly\n */\n participant?: Participant;\n }\n interface CreateEntranceResponse {\n /** Created entrances */\n entrances?: Entrance[];\n }\n interface UpdateParticipantRequest {\n participant?: Participant;\n /** @internal */\n fieldMask?: string[];\n }\n interface UpdateParticipantResponse {\n /** Updated participant */\n participant?: Participant;\n }\n interface RemoveParticipantRequest {\n /** The ID of the session. */\n sessionId?: string;\n /** The ID of the participant. */\n participantId?: string;\n }\n interface RemoveParticipantResponse {\n participant?: Participant;\n }\n interface QueryParticipantsRequest {\n /** Query for listing participants. session_id EQ filter is mandatory. */\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 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 /** 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 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 QueryParticipantsResponse {\n /** Participants */\n participants?: Participant[];\n metaData?: 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 * 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 * @internal\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 /** @param sessionId - The ID of the session.\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.token\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.JOIN_SESSIONS\n */\n function describeEntrance(sessionId: string, options: DescribeEntranceOptions): Promise;\n interface DescribeEntranceOptions {\n /** Token from entrance_link */\n token: string | null;\n }\n /** @param sessionId - The ID of the session.\n * @internal\n * @documentationMaturity preview\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.JOIN_SESSIONS\n */\n function addParticipant(sessionId: string, options?: AddParticipantOptions): Promise;\n interface AddParticipantOptions {\n /** Token from entrance_link */\n token?: string | null;\n /** Update participant name */\n name?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @permissionId LIVE_VIDEO.JOIN_SESSIONS\n */\n function listParticipants(options?: ListParticipantsOptions): Promise;\n interface ListParticipantsOptions {\n /** Token for participant api authorization */\n authorization?: string;\n /** Optional participant id filter */\n participantId?: string[];\n }\n /** @param sessionId - The ID of the session.\n * @param m - Meta site id.\n * @internal\n * @documentationMaturity preview\n * @requiredField m\n * @requiredField options.t\n * @requiredField sessionId\n * @adminMethod\n */\n function fallbackJoin(sessionId: string, m: string, options?: FallbackJoinOptions): Promise;\n interface FallbackJoinOptions {\n /** Token. */\n t: string;\n /** Request language. */\n lang?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function describeLiveSessions(): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId LIVE_VIDEO.READ_SESSIONS\n */\n function getLiveSession(_id: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField session\n * @requiredField session.duration\n * @requiredField session.name\n * @requiredField session.startDate\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function createLiveSession(session: LiveSession): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField session\n * @requiredField session._id\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function updateLiveSession(session: LiveSession, options?: UpdateLiveSessionOptions): Promise;\n interface UpdateLiveSessionOptions {\n /** @internal */\n fieldMask?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function deleteLiveSession(_id: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId LIVE_VIDEO.READ_SESSIONS\n */\n function queryLiveSessions(): EntriesQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface EntriesQueryResult extends QueryCursorResult {\n items: LiveSession[];\n query: EntriesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface EntriesQueryBuilder {\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) => EntriesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => EntriesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /** @param sessionId - The ID of the session.\n * @internal\n * @documentationMaturity preview\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function startLiveSession(sessionId: string, options?: StartLiveSessionOptions): Promise;\n interface StartLiveSessionOptions {\n /**\n * AWS Chime media region\n * https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html\n * default: \"us-east-1\"\n */\n region?: string | null;\n }\n /** @param sessionId - The ID of the session.\n * @internal\n * @documentationMaturity preview\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function endLiveSession(sessionId: string): Promise;\n /** @param sessionId - Session to create an entrance link for\n * @internal\n * @documentationMaturity preview\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function createEntranceLink(sessionId: string, options?: CreateEntranceLinkOptions): Promise;\n interface CreateEntranceLinkOptions {\n /** Single participant use at the time */\n limited?: boolean;\n /** Optional participant name (can be changed later) */\n name?: string | null;\n }\n /** @param sessionId - Session to create an entrance link for\n * @internal\n * @documentationMaturity preview\n * @requiredField options.entrances.personal.externalId\n * @requiredField sessionId\n * @permissionId LIVE_VIDEO.MANAGE_SESSIONS\n * @adminMethod\n */\n function createEntrance(sessionId: string, options?: CreateEntranceOptions): Promise;\n interface CreateEntranceOptions {\n entrances?: Entrance[];\n }\n \n type livevideoV1Session_universal_d_LiveSession = LiveSession;\n type livevideoV1Session_universal_d_LiveSessionBroadcastChannelOneOf = LiveSessionBroadcastChannelOneOf;\n type livevideoV1Session_universal_d_BroadcastType = BroadcastType;\n const livevideoV1Session_universal_d_BroadcastType: typeof BroadcastType;\n type livevideoV1Session_universal_d_BroadcastState = BroadcastState;\n const livevideoV1Session_universal_d_BroadcastState: typeof BroadcastState;\n type livevideoV1Session_universal_d_Meeting = Meeting;\n type livevideoV1Session_universal_d_EntityReference = EntityReference;\n type livevideoV1Session_universal_d_TimeLog = TimeLog;\n type livevideoV1Session_universal_d_SessionType = SessionType;\n const livevideoV1Session_universal_d_SessionType: typeof SessionType;\n type livevideoV1Session_universal_d_SessionState = SessionState;\n const livevideoV1Session_universal_d_SessionState: typeof SessionState;\n type livevideoV1Session_universal_d_SessionFlag = SessionFlag;\n const livevideoV1Session_universal_d_SessionFlag: typeof SessionFlag;\n type livevideoV1Session_universal_d_MessagingChannel = MessagingChannel;\n type livevideoV1Session_universal_d_DescribeEntranceRequest = DescribeEntranceRequest;\n type livevideoV1Session_universal_d_DescribeEntranceResponse = DescribeEntranceResponse;\n type livevideoV1Session_universal_d_Participant = Participant;\n type livevideoV1Session_universal_d_ParticipantState = ParticipantState;\n const livevideoV1Session_universal_d_ParticipantState: typeof ParticipantState;\n type livevideoV1Session_universal_d_AddParticipantRequest = AddParticipantRequest;\n type livevideoV1Session_universal_d_AddParticipantResponse = AddParticipantResponse;\n type livevideoV1Session_universal_d_AddParticipantResponseClientPropertiesOneOf = AddParticipantResponseClientPropertiesOneOf;\n type livevideoV1Session_universal_d_PropsV1 = PropsV1;\n type livevideoV1Session_universal_d_PropsV2 = PropsV2;\n type livevideoV1Session_universal_d_ListParticipantsRequest = ListParticipantsRequest;\n type livevideoV1Session_universal_d_ListParticipantsResponse = ListParticipantsResponse;\n type livevideoV1Session_universal_d_FallbackJoinRequest = FallbackJoinRequest;\n type livevideoV1Session_universal_d_RawHttpResponse = RawHttpResponse;\n type livevideoV1Session_universal_d_HeadersEntry = HeadersEntry;\n type livevideoV1Session_universal_d_DescribeLiveSessionsRequest = DescribeLiveSessionsRequest;\n type livevideoV1Session_universal_d_DescribeLiveSessionsResponse = DescribeLiveSessionsResponse;\n type livevideoV1Session_universal_d_GetLiveSessionRequest = GetLiveSessionRequest;\n type livevideoV1Session_universal_d_GetLiveSessionResponse = GetLiveSessionResponse;\n type livevideoV1Session_universal_d_CreateLiveSessionRequest = CreateLiveSessionRequest;\n type livevideoV1Session_universal_d_CreateLiveSessionResponse = CreateLiveSessionResponse;\n type livevideoV1Session_universal_d_UpdateLiveSessionRequest = UpdateLiveSessionRequest;\n type livevideoV1Session_universal_d_UpdateLiveSessionResponse = UpdateLiveSessionResponse;\n type livevideoV1Session_universal_d_DeleteLiveSessionRequest = DeleteLiveSessionRequest;\n type livevideoV1Session_universal_d_DeleteLiveSessionResponse = DeleteLiveSessionResponse;\n type livevideoV1Session_universal_d_QueryLiveSessionsRequest = QueryLiveSessionsRequest;\n type livevideoV1Session_universal_d_Query = Query;\n type livevideoV1Session_universal_d_Sorting = Sorting;\n type livevideoV1Session_universal_d_SortOrder = SortOrder;\n const livevideoV1Session_universal_d_SortOrder: typeof SortOrder;\n type livevideoV1Session_universal_d_Paging = Paging;\n type livevideoV1Session_universal_d_QueryLiveSessionsResponse = QueryLiveSessionsResponse;\n type livevideoV1Session_universal_d_PagingMetadata = PagingMetadata;\n type livevideoV1Session_universal_d_StartLiveSessionRequest = StartLiveSessionRequest;\n type livevideoV1Session_universal_d_StartLiveSessionResponse = StartLiveSessionResponse;\n type livevideoV1Session_universal_d_EndLiveSessionRequest = EndLiveSessionRequest;\n type livevideoV1Session_universal_d_EndLiveSessionResponse = EndLiveSessionResponse;\n type livevideoV1Session_universal_d_CreateEntranceLinkRequest = CreateEntranceLinkRequest;\n type livevideoV1Session_universal_d_CreateEntranceLinkResponse = CreateEntranceLinkResponse;\n type livevideoV1Session_universal_d_CreateEntranceRequest = CreateEntranceRequest;\n type livevideoV1Session_universal_d_Entrance = Entrance;\n type livevideoV1Session_universal_d_EntranceEntranceTypeOneOf = EntranceEntranceTypeOneOf;\n type livevideoV1Session_universal_d_UniversalEntrance = UniversalEntrance;\n type livevideoV1Session_universal_d_EntranceLink = EntranceLink;\n type livevideoV1Session_universal_d_PersonalEntrance = PersonalEntrance;\n type livevideoV1Session_universal_d_VideoRecorderEntrance = VideoRecorderEntrance;\n type livevideoV1Session_universal_d_VideoStreamerEntrance = VideoStreamerEntrance;\n type livevideoV1Session_universal_d_CreateEntranceResponse = CreateEntranceResponse;\n type livevideoV1Session_universal_d_UpdateParticipantRequest = UpdateParticipantRequest;\n type livevideoV1Session_universal_d_UpdateParticipantResponse = UpdateParticipantResponse;\n type livevideoV1Session_universal_d_RemoveParticipantRequest = RemoveParticipantRequest;\n type livevideoV1Session_universal_d_RemoveParticipantResponse = RemoveParticipantResponse;\n type livevideoV1Session_universal_d_QueryParticipantsRequest = QueryParticipantsRequest;\n type livevideoV1Session_universal_d_QueryV2 = QueryV2;\n type livevideoV1Session_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type livevideoV1Session_universal_d_CursorPaging = CursorPaging;\n type livevideoV1Session_universal_d_QueryParticipantsResponse = QueryParticipantsResponse;\n type livevideoV1Session_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type livevideoV1Session_universal_d_Cursors = Cursors;\n const livevideoV1Session_universal_d_describeEntrance: typeof describeEntrance;\n type livevideoV1Session_universal_d_DescribeEntranceOptions = DescribeEntranceOptions;\n const livevideoV1Session_universal_d_addParticipant: typeof addParticipant;\n type livevideoV1Session_universal_d_AddParticipantOptions = AddParticipantOptions;\n const livevideoV1Session_universal_d_listParticipants: typeof listParticipants;\n type livevideoV1Session_universal_d_ListParticipantsOptions = ListParticipantsOptions;\n const livevideoV1Session_universal_d_fallbackJoin: typeof fallbackJoin;\n type livevideoV1Session_universal_d_FallbackJoinOptions = FallbackJoinOptions;\n const livevideoV1Session_universal_d_describeLiveSessions: typeof describeLiveSessions;\n const livevideoV1Session_universal_d_getLiveSession: typeof getLiveSession;\n const livevideoV1Session_universal_d_createLiveSession: typeof createLiveSession;\n const livevideoV1Session_universal_d_updateLiveSession: typeof updateLiveSession;\n type livevideoV1Session_universal_d_UpdateLiveSessionOptions = UpdateLiveSessionOptions;\n const livevideoV1Session_universal_d_deleteLiveSession: typeof deleteLiveSession;\n const livevideoV1Session_universal_d_queryLiveSessions: typeof queryLiveSessions;\n type livevideoV1Session_universal_d_EntriesQueryResult = EntriesQueryResult;\n type livevideoV1Session_universal_d_EntriesQueryBuilder = EntriesQueryBuilder;\n const livevideoV1Session_universal_d_startLiveSession: typeof startLiveSession;\n type livevideoV1Session_universal_d_StartLiveSessionOptions = StartLiveSessionOptions;\n const livevideoV1Session_universal_d_endLiveSession: typeof endLiveSession;\n const livevideoV1Session_universal_d_createEntranceLink: typeof createEntranceLink;\n type livevideoV1Session_universal_d_CreateEntranceLinkOptions = CreateEntranceLinkOptions;\n const livevideoV1Session_universal_d_createEntrance: typeof createEntrance;\n type livevideoV1Session_universal_d_CreateEntranceOptions = CreateEntranceOptions;\n namespace livevideoV1Session_universal_d {\n export {\n livevideoV1Session_universal_d_LiveSession as LiveSession,\n livevideoV1Session_universal_d_LiveSessionBroadcastChannelOneOf as LiveSessionBroadcastChannelOneOf,\n livevideoV1Session_universal_d_BroadcastType as BroadcastType,\n livevideoV1Session_universal_d_BroadcastState as BroadcastState,\n livevideoV1Session_universal_d_Meeting as Meeting,\n livevideoV1Session_universal_d_EntityReference as EntityReference,\n livevideoV1Session_universal_d_TimeLog as TimeLog,\n livevideoV1Session_universal_d_SessionType as SessionType,\n livevideoV1Session_universal_d_SessionState as SessionState,\n livevideoV1Session_universal_d_SessionFlag as SessionFlag,\n livevideoV1Session_universal_d_MessagingChannel as MessagingChannel,\n livevideoV1Session_universal_d_DescribeEntranceRequest as DescribeEntranceRequest,\n livevideoV1Session_universal_d_DescribeEntranceResponse as DescribeEntranceResponse,\n livevideoV1Session_universal_d_Participant as Participant,\n livevideoV1Session_universal_d_ParticipantState as ParticipantState,\n livevideoV1Session_universal_d_AddParticipantRequest as AddParticipantRequest,\n livevideoV1Session_universal_d_AddParticipantResponse as AddParticipantResponse,\n livevideoV1Session_universal_d_AddParticipantResponseClientPropertiesOneOf as AddParticipantResponseClientPropertiesOneOf,\n livevideoV1Session_universal_d_PropsV1 as PropsV1,\n livevideoV1Session_universal_d_PropsV2 as PropsV2,\n livevideoV1Session_universal_d_ListParticipantsRequest as ListParticipantsRequest,\n livevideoV1Session_universal_d_ListParticipantsResponse as ListParticipantsResponse,\n livevideoV1Session_universal_d_FallbackJoinRequest as FallbackJoinRequest,\n livevideoV1Session_universal_d_RawHttpResponse as RawHttpResponse,\n livevideoV1Session_universal_d_HeadersEntry as HeadersEntry,\n livevideoV1Session_universal_d_DescribeLiveSessionsRequest as DescribeLiveSessionsRequest,\n livevideoV1Session_universal_d_DescribeLiveSessionsResponse as DescribeLiveSessionsResponse,\n livevideoV1Session_universal_d_GetLiveSessionRequest as GetLiveSessionRequest,\n livevideoV1Session_universal_d_GetLiveSessionResponse as GetLiveSessionResponse,\n livevideoV1Session_universal_d_CreateLiveSessionRequest as CreateLiveSessionRequest,\n livevideoV1Session_universal_d_CreateLiveSessionResponse as CreateLiveSessionResponse,\n livevideoV1Session_universal_d_UpdateLiveSessionRequest as UpdateLiveSessionRequest,\n livevideoV1Session_universal_d_UpdateLiveSessionResponse as UpdateLiveSessionResponse,\n livevideoV1Session_universal_d_DeleteLiveSessionRequest as DeleteLiveSessionRequest,\n livevideoV1Session_universal_d_DeleteLiveSessionResponse as DeleteLiveSessionResponse,\n livevideoV1Session_universal_d_QueryLiveSessionsRequest as QueryLiveSessionsRequest,\n livevideoV1Session_universal_d_Query as Query,\n livevideoV1Session_universal_d_Sorting as Sorting,\n livevideoV1Session_universal_d_SortOrder as SortOrder,\n livevideoV1Session_universal_d_Paging as Paging,\n livevideoV1Session_universal_d_QueryLiveSessionsResponse as QueryLiveSessionsResponse,\n livevideoV1Session_universal_d_PagingMetadata as PagingMetadata,\n livevideoV1Session_universal_d_StartLiveSessionRequest as StartLiveSessionRequest,\n livevideoV1Session_universal_d_StartLiveSessionResponse as StartLiveSessionResponse,\n livevideoV1Session_universal_d_EndLiveSessionRequest as EndLiveSessionRequest,\n livevideoV1Session_universal_d_EndLiveSessionResponse as EndLiveSessionResponse,\n livevideoV1Session_universal_d_CreateEntranceLinkRequest as CreateEntranceLinkRequest,\n livevideoV1Session_universal_d_CreateEntranceLinkResponse as CreateEntranceLinkResponse,\n livevideoV1Session_universal_d_CreateEntranceRequest as CreateEntranceRequest,\n livevideoV1Session_universal_d_Entrance as Entrance,\n livevideoV1Session_universal_d_EntranceEntranceTypeOneOf as EntranceEntranceTypeOneOf,\n livevideoV1Session_universal_d_UniversalEntrance as UniversalEntrance,\n livevideoV1Session_universal_d_EntranceLink as EntranceLink,\n livevideoV1Session_universal_d_PersonalEntrance as PersonalEntrance,\n livevideoV1Session_universal_d_VideoRecorderEntrance as VideoRecorderEntrance,\n livevideoV1Session_universal_d_VideoStreamerEntrance as VideoStreamerEntrance,\n livevideoV1Session_universal_d_CreateEntranceResponse as CreateEntranceResponse,\n livevideoV1Session_universal_d_UpdateParticipantRequest as UpdateParticipantRequest,\n livevideoV1Session_universal_d_UpdateParticipantResponse as UpdateParticipantResponse,\n livevideoV1Session_universal_d_RemoveParticipantRequest as RemoveParticipantRequest,\n livevideoV1Session_universal_d_RemoveParticipantResponse as RemoveParticipantResponse,\n livevideoV1Session_universal_d_QueryParticipantsRequest as QueryParticipantsRequest,\n livevideoV1Session_universal_d_QueryV2 as QueryV2,\n livevideoV1Session_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n livevideoV1Session_universal_d_CursorPaging as CursorPaging,\n livevideoV1Session_universal_d_QueryParticipantsResponse as QueryParticipantsResponse,\n livevideoV1Session_universal_d_PagingMetadataV2 as PagingMetadataV2,\n livevideoV1Session_universal_d_Cursors as Cursors,\n livevideoV1Session_universal_d_describeEntrance as describeEntrance,\n livevideoV1Session_universal_d_DescribeEntranceOptions as DescribeEntranceOptions,\n livevideoV1Session_universal_d_addParticipant as addParticipant,\n livevideoV1Session_universal_d_AddParticipantOptions as AddParticipantOptions,\n livevideoV1Session_universal_d_listParticipants as listParticipants,\n livevideoV1Session_universal_d_ListParticipantsOptions as ListParticipantsOptions,\n livevideoV1Session_universal_d_fallbackJoin as fallbackJoin,\n livevideoV1Session_universal_d_FallbackJoinOptions as FallbackJoinOptions,\n livevideoV1Session_universal_d_describeLiveSessions as describeLiveSessions,\n livevideoV1Session_universal_d_getLiveSession as getLiveSession,\n livevideoV1Session_universal_d_createLiveSession as createLiveSession,\n livevideoV1Session_universal_d_updateLiveSession as updateLiveSession,\n livevideoV1Session_universal_d_UpdateLiveSessionOptions as UpdateLiveSessionOptions,\n livevideoV1Session_universal_d_deleteLiveSession as deleteLiveSession,\n livevideoV1Session_universal_d_queryLiveSessions as queryLiveSessions,\n livevideoV1Session_universal_d_EntriesQueryResult as EntriesQueryResult,\n livevideoV1Session_universal_d_EntriesQueryBuilder as EntriesQueryBuilder,\n livevideoV1Session_universal_d_startLiveSession as startLiveSession,\n livevideoV1Session_universal_d_StartLiveSessionOptions as StartLiveSessionOptions,\n livevideoV1Session_universal_d_endLiveSession as endLiveSession,\n livevideoV1Session_universal_d_createEntranceLink as createEntranceLink,\n livevideoV1Session_universal_d_CreateEntranceLinkOptions as CreateEntranceLinkOptions,\n livevideoV1Session_universal_d_createEntrance as createEntrance,\n livevideoV1Session_universal_d_CreateEntranceOptions as CreateEntranceOptions,\n };\n }\n \n export { livevideoV1Chat_universal_d as chat, livevideoV1Participant_universal_d as participant, livevideoV1Reaction_universal_d as reaction, livevideoV1Session_universal_d as session };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-iot-backend.d.ts", "content": "declare module \"wix-iot-backend\" {\n interface State {\n /** @readonly */\n _id?: string;\n /** @readonly */\n entityId?: string;\n state?: string;\n /** @readonly */\n lastChanged?: Date;\n /** @readonly */\n attributes?: Record | null;\n }\n interface ListResponse {\n states?: State[];\n }\n interface GetResponse {\n state?: State;\n }\n interface UpdateResponse {\n state?: State;\n }\n interface UpdateOptions {\n state: {\n /** @readonly */\n _id?: string;\n state?: string;\n /** @readonly */\n lastChanged?: Date;\n /** @readonly */\n attributes?: Record | null;\n };\n }\n \n function list(): Promise;\n function get(entityId: string): Promise;\n function update(entityId: string, options?: UpdateOptions): Promise;\n \n const iotV1State_backend_d_list: typeof list;\n const iotV1State_backend_d_get: typeof get;\n const iotV1State_backend_d_update: typeof update;\n namespace iotV1State_backend_d {\n export {\n iotV1State_backend_d_list as list,\n iotV1State_backend_d_get as get,\n iotV1State_backend_d_update as update,\n };\n }\n \n export { iotV1State_backend_d as state };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-atlas-backend.d.ts", "content": "declare module \"wix-atlas-backend\" {\n interface Place {\n /** The given place id */\n placeId?: string;\n /** The Address object */\n address?: Address$1;\n /** The Place type. For example: airport, library etc... */\n types?: string[];\n }\n /** Physical address */\n interface Address$1 extends AddressStreetOneOf$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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$2;\n }\n /** @oneof */\n interface AddressStreetOneOf$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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$2 {\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType$1;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 GetPlaceRequest {\n searchId: string;\n /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */\n sessionToken?: string | null;\n }\n interface GetPlaceResponse {\n place?: Place;\n }\n /**\n * Once you have a search_id from a autocomplete Search, you can request more details about a particular establishment or point of interest by initiating a get place request.\n * @public\n * @documentationMaturity preview\n * @requiredField searchId\n * @permissionId WIX_ATLAS.GET_PLACE\n */\n function getPlace(searchId: string, options?: GetPlaceOptions): Promise;\n interface GetPlaceOptions {\n /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */\n sessionToken?: string | null;\n }\n \n type atlasV2Place_universal_d_Place = Place;\n type atlasV2Place_universal_d_GetPlaceRequest = GetPlaceRequest;\n type atlasV2Place_universal_d_GetPlaceResponse = GetPlaceResponse;\n const atlasV2Place_universal_d_getPlace: typeof getPlace;\n type atlasV2Place_universal_d_GetPlaceOptions = GetPlaceOptions;\n namespace atlasV2Place_universal_d {\n export {\n atlasV2Place_universal_d_Place as Place,\n Address$1 as Address,\n AddressStreetOneOf$1 as AddressStreetOneOf,\n StreetAddress$1 as StreetAddress,\n AddressLocation$2 as AddressLocation,\n Subdivision$1 as Subdivision,\n SubdivisionType$1 as SubdivisionType,\n atlasV2Place_universal_d_GetPlaceRequest as GetPlaceRequest,\n atlasV2Place_universal_d_GetPlaceResponse as GetPlaceResponse,\n atlasV2Place_universal_d_getPlace as getPlace,\n atlasV2Place_universal_d_GetPlaceOptions as GetPlaceOptions,\n };\n }\n \n interface Prediction {\n /** The human-readable name of the prediction */\n description?: string;\n /** The id of the prediction that can be use in place api. Available for short time. */\n searchId?: string;\n /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */\n matchedSubstrings?: MatchedSubstrings[];\n /** Provides pre-formatted text that can be shown in your autocomplete results */\n textStructure?: TextStructure;\n /** Contains an integer indicating the straight-line distance between the predicted place, and the specified origin point, in meters. */\n distanceInMeters?: number | null;\n }\n interface MatchedSubstrings {\n length?: number;\n offset?: number;\n }\n interface TextStructure {\n /** Contains the main text of a prediction, usually the name of the place */\n mainText?: string;\n /** Contains the secondary text of a prediction, usually the location of the place */\n secondaryText?: string;\n /** Contains an array with offset value and length. These describe the location of the entered term in the prediction result text, so that the term can be highlighted if desired */\n mainTextMatchedSubstrings?: MatchedSubstrings[];\n }\n interface ListPredictionsRequest {\n /** The text the predictions will be based on. */\n input: string;\n /** The origin point from which to calculate straight-line distance to the destination */\n origin?: AddressLocation$1;\n /** The point around which you wish to retrieve place information */\n location?: AddressLocation$1;\n /** The acceptable distance from that location (in meters) */\n radius?: string | null;\n /** Filters the user can add in order to get more accurate results */\n filterBy?: FilterBy$1[];\n }\n interface AddressLocation$1 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface FilterBy$1 {\n /** One of the filter types enum */\n filterType?: FilterType$1;\n /** Free text like \"us\" */\n filterValue?: string;\n }\n enum FilterType$1 {\n /** Filter by zip code */\n zip_code = \"zip_code\",\n /** Filter by 2-letters or 3-letters country code */\n country_code = \"country_code\"\n }\n interface ListPredictionsResponse {\n predictions?: Prediction[];\n }\n interface PredictRequest {\n /** The text the predictions will be based on. */\n input: string;\n /** The origin point from which to calculate straight-line distance to the destination */\n origin?: AddressLocation$1;\n /** The point around which you wish to retrieve place information */\n location?: AddressLocation$1;\n /** The acceptable distance from that location (in meters) */\n radius?: string | null;\n /** alpha-2 or alpha-3 ISO-3166 country codes to filter by */\n countryCodes?: string[];\n /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */\n sessionToken?: string | null;\n }\n interface PredictResponse {\n predictions?: Prediction[];\n }\n /**\n * Deprecated!!!! - Please use /Predict\n * @param input - The text the predictions will be based on.\n * @internal\n * @documentationMaturity preview\n * @requiredField input\n * @permissionId WIX_ATLAS.LIST_PREDICTIONS\n * @deprecated\n */\n function listPredictions(input: string, options?: ListPredictionsOptions): Promise;\n interface ListPredictionsOptions {\n /** The origin point from which to calculate straight-line distance to the destination */\n origin?: AddressLocation$1;\n /** The point around which you wish to retrieve place information */\n location?: AddressLocation$1;\n /** The acceptable distance from that location (in meters) */\n radius?: string | null;\n /** Filters the user can add in order to get more accurate results */\n filterBy?: FilterBy$1[];\n }\n /**\n * A Predict end-point take an input and returns an list of Prediction object.\n * @param input - The text the predictions will be based on.\n * @public\n * @documentationMaturity preview\n * @requiredField input\n * @permissionId WIX_ATLAS.LIST_PREDICTIONS\n */\n function predict(input: string, options?: PredictOptions): Promise;\n interface PredictOptions {\n /** The origin point from which to calculate straight-line distance to the destination */\n origin?: AddressLocation$1;\n /** The point around which you wish to retrieve place information */\n location?: AddressLocation$1;\n /** The acceptable distance from that location (in meters) */\n radius?: string | null;\n /** alpha-2 or alpha-3 ISO-3166 country codes to filter by */\n countryCodes?: string[];\n /** A random string which identifies an autocomplete session for billing purposes. The session begins when the user starts typing a query, and concludes when they select a place and a call to Get Place is made. Once a session has concluded, the token is no longer valid. your app must generate a fresh token for each session. */\n sessionToken?: string | null;\n }\n \n type atlasV2Prediction_universal_d_Prediction = Prediction;\n type atlasV2Prediction_universal_d_MatchedSubstrings = MatchedSubstrings;\n type atlasV2Prediction_universal_d_TextStructure = TextStructure;\n type atlasV2Prediction_universal_d_ListPredictionsRequest = ListPredictionsRequest;\n type atlasV2Prediction_universal_d_ListPredictionsResponse = ListPredictionsResponse;\n type atlasV2Prediction_universal_d_PredictRequest = PredictRequest;\n type atlasV2Prediction_universal_d_PredictResponse = PredictResponse;\n const atlasV2Prediction_universal_d_listPredictions: typeof listPredictions;\n type atlasV2Prediction_universal_d_ListPredictionsOptions = ListPredictionsOptions;\n const atlasV2Prediction_universal_d_predict: typeof predict;\n type atlasV2Prediction_universal_d_PredictOptions = PredictOptions;\n namespace atlasV2Prediction_universal_d {\n export {\n atlasV2Prediction_universal_d_Prediction as Prediction,\n atlasV2Prediction_universal_d_MatchedSubstrings as MatchedSubstrings,\n atlasV2Prediction_universal_d_TextStructure as TextStructure,\n atlasV2Prediction_universal_d_ListPredictionsRequest as ListPredictionsRequest,\n AddressLocation$1 as AddressLocation,\n FilterBy$1 as FilterBy,\n FilterType$1 as FilterType,\n atlasV2Prediction_universal_d_ListPredictionsResponse as ListPredictionsResponse,\n atlasV2Prediction_universal_d_PredictRequest as PredictRequest,\n atlasV2Prediction_universal_d_PredictResponse as PredictResponse,\n atlasV2Prediction_universal_d_listPredictions as listPredictions,\n atlasV2Prediction_universal_d_ListPredictionsOptions as ListPredictionsOptions,\n atlasV2Prediction_universal_d_predict as predict,\n atlasV2Prediction_universal_d_PredictOptions as PredictOptions,\n };\n }\n \n interface SearchResult {\n /** The Address object */\n address?: Address;\n /** stores additional data about the proximity to the specified location */\n proximity?: Proximity;\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\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. 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 enum Proximity {\n UNKNOWN_PROXIMITY = \"UNKNOWN_PROXIMITY\",\n /** indicates that the returned result is a precise geocode for which we have location information accurate down to street address precision */\n PINPOINT = \"PINPOINT\",\n /** indicates that the returned result is the geometric center of a result */\n APPROXIMATE = \"APPROXIMATE\",\n /** indicates that the returned result is around an area */\n GENERAL_AREA = \"GENERAL_AREA\"\n }\n /** User must provide query or filter by parameters */\n interface SearchRequest {\n /** Free text */\n query?: string | null;\n /**\n * Deprecate! - Please use 'zipCode' and 'countryCodes' fields\n * @deprecated\n */\n filterBy?: FilterBy[];\n /** Zip code filter the user can add in order to get more accurate results */\n zipCode?: string | null;\n /** Country codes filter the user can add in order to get more accurate results */\n countryCodes?: string[];\n }\n interface FilterBy {\n /** One of the filter types enum */\n filterType?: FilterType;\n /** Free text like \"us\" */\n filterValue?: string;\n }\n enum FilterType {\n /** Filter by zip code */\n zip_code = \"zip_code\",\n /** Filter by 2-letters or 3-letters country code */\n country_code = \"country_code\"\n }\n interface SearchResponse {\n /** List of 'Address' objects */\n searchResults?: SearchResult[];\n }\n interface ReverseGeocodingRequest {\n /** The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address. */\n addressLocation: AddressLocation;\n }\n interface ReverseGeocodingResponse {\n searchResults?: SearchResult[];\n }\n /**\n * A Search request takes a free text as an input and returns a list of 'Address' objects.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_ATLAS.SEARCH\n */\n function search(options?: SearchOptions): Promise;\n interface SearchOptions {\n /** Free text */\n query?: string | null;\n /**\n * Deprecate! - Please use 'zipCode' and 'countryCodes' fields\n * @deprecated\n */\n filterBy?: FilterBy[];\n /** Zip code filter the user can add in order to get more accurate results */\n zipCode?: string | null;\n /** Country codes filter the user can add in order to get more accurate results */\n countryCodes?: string[];\n }\n /**\n * A Search request takes 'latitude' and 'longitude' values as an input and returns a list of 'Address' objects.\n * @param addressLocation - The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address.\n * @internal\n * @documentationMaturity preview\n * @requiredField addressLocation\n * @requiredField addressLocation.latitude\n * @requiredField addressLocation.longitude\n * @permissionId WIX_ATLAS.REVERSE_GEOCODING\n */\n function reverseGeocoding(addressLocation: AddressLocation): Promise;\n \n type atlasV2SearchResult_universal_d_SearchResult = SearchResult;\n type atlasV2SearchResult_universal_d_Address = Address;\n type atlasV2SearchResult_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type atlasV2SearchResult_universal_d_StreetAddress = StreetAddress;\n type atlasV2SearchResult_universal_d_AddressLocation = AddressLocation;\n type atlasV2SearchResult_universal_d_Subdivision = Subdivision;\n type atlasV2SearchResult_universal_d_SubdivisionType = SubdivisionType;\n const atlasV2SearchResult_universal_d_SubdivisionType: typeof SubdivisionType;\n type atlasV2SearchResult_universal_d_Proximity = Proximity;\n const atlasV2SearchResult_universal_d_Proximity: typeof Proximity;\n type atlasV2SearchResult_universal_d_SearchRequest = SearchRequest;\n type atlasV2SearchResult_universal_d_FilterBy = FilterBy;\n type atlasV2SearchResult_universal_d_FilterType = FilterType;\n const atlasV2SearchResult_universal_d_FilterType: typeof FilterType;\n type atlasV2SearchResult_universal_d_SearchResponse = SearchResponse;\n type atlasV2SearchResult_universal_d_ReverseGeocodingRequest = ReverseGeocodingRequest;\n type atlasV2SearchResult_universal_d_ReverseGeocodingResponse = ReverseGeocodingResponse;\n const atlasV2SearchResult_universal_d_search: typeof search;\n type atlasV2SearchResult_universal_d_SearchOptions = SearchOptions;\n const atlasV2SearchResult_universal_d_reverseGeocoding: typeof reverseGeocoding;\n namespace atlasV2SearchResult_universal_d {\n export {\n atlasV2SearchResult_universal_d_SearchResult as SearchResult,\n atlasV2SearchResult_universal_d_Address as Address,\n atlasV2SearchResult_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n atlasV2SearchResult_universal_d_StreetAddress as StreetAddress,\n atlasV2SearchResult_universal_d_AddressLocation as AddressLocation,\n atlasV2SearchResult_universal_d_Subdivision as Subdivision,\n atlasV2SearchResult_universal_d_SubdivisionType as SubdivisionType,\n atlasV2SearchResult_universal_d_Proximity as Proximity,\n atlasV2SearchResult_universal_d_SearchRequest as SearchRequest,\n atlasV2SearchResult_universal_d_FilterBy as FilterBy,\n atlasV2SearchResult_universal_d_FilterType as FilterType,\n atlasV2SearchResult_universal_d_SearchResponse as SearchResponse,\n atlasV2SearchResult_universal_d_ReverseGeocodingRequest as ReverseGeocodingRequest,\n atlasV2SearchResult_universal_d_ReverseGeocodingResponse as ReverseGeocodingResponse,\n atlasV2SearchResult_universal_d_search as search,\n atlasV2SearchResult_universal_d_SearchOptions as SearchOptions,\n atlasV2SearchResult_universal_d_reverseGeocoding as reverseGeocoding,\n };\n }\n \n export { atlasV2Prediction_universal_d as autocomplete, atlasV2SearchResult_universal_d as location, atlasV2Place_universal_d as places };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-restaurants-orders-backend.d.ts", "content": "declare module \"wix-restaurants-orders-backend\" {\n interface Order {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string;\n /**\n * Legacy restaurant ID, use only for legacy API\n * @internal\n * @readonly\n */\n restaurantId?: string;\n /**\n * ID of the restaurant’s location.\n * @readonly\n */\n locationId?: string | null;\n /**\n * Order creation date and time in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of order's latest update in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _updatedDate?: Date;\n /** Additional note to the order added by the customer. */\n comment?: string | null;\n /** Currency of the order. */\n currency?: string | null;\n /** Current order status. */\n status?: Status;\n /** Dishes and options included in the order. */\n lineItems?: LineItem[];\n /** Discounts associated with the order. */\n discounts?: Discount[];\n /** Coupon applied to the order. */\n coupon?: Coupon;\n /** Order payment information. */\n payments?: Payment[];\n /** Order fulfillment information. */\n fulfillment?: Fulfillment;\n /** Customer information. */\n customer?: Customer;\n /** Order totals. */\n totals?: Totals;\n /**\n * Log of order updates.\n * @readonly\n */\n activities?: Activity[];\n /** Information about the sales channel that submitted the order. */\n channelInfo?: ChannelInfo;\n /** Information about the order’s loyalty points. */\n loyaltyInfo?: LoyaltyInfo;\n /**\n * Information about the POS.\n * @internal\n */\n posInfo?: PosInfo;\n }\n /** This might be extended in the future with pending orders statuses */\n enum Status {\n /** Order status can't be classified, due to an error */\n UNSPECIFIED_ORDER_STATUS = \"UNSPECIFIED_ORDER_STATUS\",\n /** Order is pending response from the payment provider - IF THIS WILL REMAIN PAYMENT PROVIDER SPECIFIC, THIS SHOULD BE CLEAR FROM THE NAME - E.G. PENDING_PAYMENT_PROVIDER. */\n PENDING = \"PENDING\",\n /** The order is marked as new - wait for state machine */\n NEW = \"NEW\",\n /** Order was accepted */\n ACCEPTED = \"ACCEPTED\",\n /** Order is canceled */\n CANCELED = \"CANCELED\",\n /** Order is fulfilled */\n FULFILLED = \"FULFILLED\"\n }\n interface LineItem {\n /** Line item quantity. */\n quantity?: number;\n /** Line item price. */\n price?: string;\n /** Comment about the line item added by the customer. */\n comment?: string | null;\n /** List of all dish options available for the line item. */\n dishOptions?: LineItemOption[];\n /** References to the line item’s origin catalog. */\n catalogReference?: CatalogReference;\n }\n interface LineItemOption {\n /** Line item option name. */\n name?: string | null;\n /** List of all dish options selected by the customer. */\n selectedChoices?: LineItem[];\n /** Minimum number of dish options the customer is required to choose. */\n minChoices?: number | null;\n /** Maximum number of dish options the customer is allowed to choose. */\n maxChoices?: number | null;\n /** Dish option type. */\n type?: DisplayType;\n /** List of all available choices for the dish option. */\n availableChoices?: LineItemOptionItem[];\n /** List of dish option IDs selected by default. */\n defaultChoices?: string[] | null;\n }\n enum DisplayType {\n /** DisplayType, due to an error */\n UNSPECIFIED_DISPLAY_TYPE = \"UNSPECIFIED_DISPLAY_TYPE\",\n /** Single choice selection */\n SELECTION = \"SELECTION\",\n /** Multiple choices selection */\n EXTRAS = \"EXTRAS\",\n /** Allow choices removal */\n DESELECTION = \"DESELECTION\"\n }\n interface LineItemOptionItem {\n /** Line item ID as defined in the catalog. */\n itemId?: string | null;\n /** Line item price. */\n price?: string | null;\n }\n interface CatalogReference {\n /** Line item ID as defined in the catalog. */\n catalogItemId?: string;\n /**\n * Line item name as defined in the catalog.\n * @readonly\n */\n catalogItemName?: string | null;\n /**\n * Item description as defined in the catalog.\n * @readonly\n */\n catalogItemDescription?: string | null;\n /**\n * Item media url as defined in the catalog.\n * @readonly\n */\n catalogItemMedia?: string | null;\n }\n interface Discount {\n /** Discount ID as defined in the catalog. */\n catalogDiscountId?: string;\n /** Amount saved. */\n appliedAmount?: string;\n /** Discount type. */\n catalogDiscountType?: DiscountType;\n /** Discount name as defined in the catalog. */\n catalogDiscountName?: string;\n }\n enum DiscountType {\n UNSPECIFIED_TYPE = \"UNSPECIFIED_TYPE\",\n OFF_ITEM = \"OFF_ITEM\",\n OFF_ORDER = \"OFF_ORDER\",\n OFF_ORDER_MANAGER_DISCOUNT = \"OFF_ORDER_MANAGER_DISCOUNT\"\n }\n interface Coupon {\n /** Coupon code. */\n code?: string;\n /** Coupon ID. */\n _id?: string;\n }\n interface Payment {\n /** Payment type. */\n type?: PaymentType;\n /** Amount paid using this payment type. Only differs from total amount paid in case of split payments. */\n amount?: string | null;\n /** Payment method. */\n method?: string | null;\n /**\n * Transaction ID.\n * See [Cashier API](https://dev.wix.com/api/rest/wix-cashier/payments/transaction) for more details.\n */\n providerTransactionId?: string | null;\n }\n enum PaymentType {\n /** PaymentType, due to an error */\n UNSPECIFIED_PAYMENT_TYPE = \"UNSPECIFIED_PAYMENT_TYPE\",\n /** Cash */\n CASH = \"CASH\",\n /** credit */\n CREDIT = \"CREDIT\",\n /** Delivery club */\n DELIVERY_CLUB = \"DELIVERY_CLUB\",\n /** Delivery com */\n DELIVERY_COM = \"DELIVERY_COM\",\n /** Bitpay */\n BITPAY = \"BITPAY\",\n /** Cellarix */\n CELLARIX = \"CELLARIX\",\n /** Bits of gold */\n BITSOFGOLD = \"BITSOFGOLD\",\n /** Multi pass */\n MULTIPASS = \"MULTIPASS\",\n /** Tenbis */\n TENBIS = \"TENBIS\",\n /** Paypal */\n PAYPAL = \"PAYPAL\",\n /** Mysodexo */\n MYSODEXO = \"MYSODEXO\",\n /** Wix Payments */\n WIX_PAYMENTS = \"WIX_PAYMENTS\"\n }\n interface Fulfillment {\n /** Fulfillment type. */\n type?: FulfillmentType;\n /** Latest delivery time promised by the restaurant. */\n promisedTime?: Date;\n /** Whether the order should be fulfilled as soon as possible. Defaults to `true`. */\n asap?: boolean | null;\n /**\n * The time it takes to prepare and deliver the order in minutes\n * @internal\n */\n preparationTime?: number | null;\n /** Delivery details. */\n deliveryDetails?: DeliveryDetails;\n /** Pickup details. */\n pickupDetails?: PickupDetails;\n /** Dine-in details */\n dineInDetails?: DineInDetails;\n }\n enum FulfillmentType {\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 }\n interface DeliveryDetails {\n /** Delivery address. */\n address?: DeliveryAddress;\n /** Information about the delivery pickup. */\n pickupInfo?: PickupInfo;\n /**\n * Information about the delivery drop-off.\n * @internal\n */\n dropOffInfo?: DropOffInfo;\n /** Delivery through the restaurant. */\n restaurant?: Restaurant;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider;\n }\n interface DeliveryAddress {\n /** Formatted delivery address. */\n formatted?: string | null;\n /** Country. */\n country?: string | null;\n /** City name. */\n city?: string | null;\n /** Street name. */\n street?: string | null;\n /** Street number. */\n streetNumber?: string | null;\n /** Apartment number. */\n apt?: string | null;\n /** Floor. */\n floor?: string | null;\n /** Entrance. */\n entrance?: string | null;\n /** ZIP/postal code. */\n zipCode?: string | null;\n /** Country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n countryCode?: string | null;\n /** Special delivery instructions upon arrival to the address. */\n onArrival?: OnArrival;\n /** Whether an approximate address is used. Defaults to `false`. In case of `false` a house number is required. */\n approximate?: boolean | null;\n /** Delivery Instructions added by the customer. */\n comment?: string | null;\n /** Geo coordinates of the address. */\n location?: DeliveryAddressLocation;\n /** Address Line 2. */\n addressLine2?: 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 }\n enum OnArrival {\n /** Missing type due to an error */\n UNSPECIFIED_ON_ARRIVAL_TYPE = \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n /** Buzz the door */\n BUZZ_DOOR = \"BUZZ_DOOR\",\n /** Phone me */\n CALL_ME = \"CALL_ME\"\n }\n interface DeliveryAddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Restaurant {\n /** Delivery fee. */\n fee?: string | null;\n }\n interface ExternalProvider {\n /** ID of the external delivery provider. */\n _id?: string;\n /**\n * Name of the external delivery provider.\n * @readonly\n */\n name?: string;\n /**\n * Delivery ID.\n * @internal\n */\n deliveryId?: string | null;\n /**\n * Estimate ID.\n * @internal\n */\n estimateId?: string | null;\n /** Delivery fee charged to the customer. */\n customerFee?: string | null;\n /**\n * Fee paid by the restaurant to the external delivery provider.\n * @readonly\n */\n commission?: string | null;\n /** Order pickup time. */\n pickupTime?: Date;\n /** Order drop off time. */\n dropOffTime?: Date;\n /**\n * Icon of the external delivery provider.\n * @internal\n */\n iconUrl?: string | null;\n }\n interface PickupInfo {\n /** When a delivery is ready to be picked up. This is the start time of the pickup window. */\n windowStartTime?: Date;\n /** When a delivery must be picked up by. This is the end time of the pickup window. */\n windowEndTime?: Date;\n }\n interface DropOffInfo {\n /** Whether the order is delivered contactless. */\n contactless?: boolean;\n }\n interface PickupDetails {\n /** Pickup fee charged to the customer. */\n fee?: string | null;\n /** Curbside pickup method */\n curbside?: Curbside;\n }\n interface Curbside {\n /** Additional information for curbside pickup. */\n info?: string;\n }\n interface DineInDetails {\n /** Label of dine-in information added by the restaurant, e.g. `table` or `booth`. */\n label?: string;\n /** Value of dine-in information added by the restaurant, e.g. `#6`. */\n value?: string;\n }\n /** Customer information. */\n interface Customer {\n /** First name. */\n firstName?: string;\n /** Last name. */\n lastName?: string;\n /** Phone number. */\n phone?: string | null;\n /** Email address. */\n email?: string;\n /**\n * Customer's contact ID.\n * See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.\n */\n contactId?: string | null;\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n }\n interface Totals {\n /** Order subtotal. Calculated by substracting delivery fee, tax and discount from order total. */\n subtotal?: string;\n /** Total order price. */\n total?: string;\n /** Total delivery fees charged to the customer. */\n delivery?: string | null;\n /** Total tax. */\n tax?: string | null;\n /** Total discount amount. */\n discount?: string | null;\n /** Total amount saved through the Wix Loyalty program. */\n loyaltySavings?: string | null;\n /**\n * Total number of line items.\n * @readonly\n */\n quantity?: number;\n /** Total tip. */\n tip?: string | null;\n }\n interface Activity {\n /**\n * Activity timestamp.\n * @readonly\n */\n timestamp?: Date;\n /**\n * Optional message added during order activity.\n * @readonly\n */\n message?: string | null;\n }\n interface ChannelInfo {\n type?: Type;\n }\n enum Type {\n UNSPECIFIED_CHANNEL_TYPE = \"UNSPECIFIED_CHANNEL_TYPE\",\n /** Web */\n WEB = \"WEB\",\n /** mobileWeb */\n MOBILE_WEB = \"MOBILE_WEB\",\n /** mobile */\n MOBILE = \"MOBILE\",\n /** callCenter */\n CALL_CENTER = \"CALL_CENTER\",\n /** facebook */\n FACEBOOK = \"FACEBOOK\",\n /** TPA */\n TPA = \"TPA\"\n }\n interface LoyaltyInfo {\n /** Associated Wix Loyalty reward ID. */\n rewardId?: string | null;\n /** Amount saved redeeming Wix Loyalty reward. */\n appliedAmount?: string | null;\n /**\n * Wix Loyalty points redeemed.\n * @readonly\n */\n redeemedPoints?: number | null;\n /**\n * Associated Wix Loyalty transaction ID.\n * @readonly\n */\n transactionId?: string | null;\n }\n interface PosInfo {\n externalProvider?: PosInfoExternalProvider;\n }\n interface PosInfoExternalProvider {\n /** ID of the external provider. */\n _id?: string;\n /** ID of the order in the external provider. */\n orderId?: string;\n }\n interface GetTotalActiveOrdersResponse {\n /** list of locationId's mapped to the total number of orders. */\n totals?: LocationToAmount[];\n }\n interface LocationToAmount {\n locationId?: string;\n locationName?: string | null;\n totalNew?: number;\n totalInProgress?: number;\n }\n interface GetOrderResponse {\n /** Retrieved order. */\n order?: Order;\n }\n interface Sort {\n /** Field to sort by. */\n fieldName?: FieldName;\n /** Sort order. */\n order?: SortOrder;\n }\n enum FieldName {\n CREATED_DATE = \"CREATED_DATE\",\n UPDATED_DATE = \"UPDATED_DATE\",\n PROMISED_TIME = \"PROMISED_TIME\"\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 ListOrdersResponse {\n /** List of retrieved orders. */\n orders?: Order[];\n /**\n * Details on the paged set of results returned.\n * @internal\n */\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 * 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 * @internal\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 AcceptOrderResponse {\n /** Accepted order. */\n order?: Order;\n }\n interface CancelOrderResponse {\n /** Canceled order. */\n order?: Order;\n }\n interface FulfillOrderResponse {\n /** Fulfilled order. */\n order?: Order;\n }\n enum EventType {\n /** Order event can't be classified, due to an error/unhandled event */\n UNKNOWN = \"UNKNOWN\",\n /** Order Created. */\n CREATED = \"CREATED\",\n /** Order accepted */\n ACCEPTED = \"ACCEPTED\",\n /** Order Canceled */\n CANCELED = \"CANCELED\",\n /** Order Fulfilled */\n FULFILLED = \"FULFILLED\"\n }\n interface GetOrderByMsidResponse {\n /** Order data. */\n order?: Order;\n }\n interface ListOrdersByMsidResponse {\n /** Order data. */\n orders?: Order[];\n }\n interface NotifyOrderEventResponse {\n }\n interface GetTotalActiveOrdersOptions {\n locationId?: string | null;\n organizationId?: string | null;\n }\n interface GetOrderOptions {\n fieldMask?: string[];\n }\n interface ListOrdersOptions {\n fieldMask?: string[];\n status?: Status;\n _createdDate?: string | null;\n delivered?: boolean | null;\n locationIds?: string[];\n sort?: Sort;\n limit?: number | null;\n cursorPaging?: CursorPaging;\n phone?: string | null;\n asap?: boolean | null;\n promisedTime?: string | null;\n }\n interface AcceptOrderOptions {\n message?: string | null;\n pickupTime?: Date;\n dropOffTime?: Date;\n }\n interface CancelOrderOptions {\n message?: string | null;\n }\n interface GetOrderByMsidOptions {\n fieldMask?: string[];\n }\n interface ListOrdersByMsidOptions {\n fieldMask?: string[];\n status?: Status;\n _createdDate?: string | null;\n delivered?: boolean | null;\n sort?: Sort;\n limit?: number | null;\n msid: string;\n }\n interface NotifyOrderEventOptions {\n msid?: string;\n eventType?: EventType;\n }\n \n function getTotalActiveOrders(options: GetTotalActiveOrdersOptions): Promise;\n function getOrder(_id: string, options: GetOrderOptions): Promise;\n function listOrders(options: ListOrdersOptions): Promise;\n function acceptOrder(_id: string, options: AcceptOrderOptions): Promise;\n function cancelOrder(_id: string, options: CancelOrderOptions): Promise;\n function fulfillOrder(_id: string): Promise;\n function getOrderByMsid(_id: string, msid: string, options: GetOrderByMsidOptions): Promise;\n function listOrdersByMsid(options: ListOrdersByMsidOptions): Promise;\n function notifyOrderEvent(_id: string, options: NotifyOrderEventOptions): Promise;\n \n export { acceptOrder, cancelOrder, fulfillOrder, getOrder, getOrderByMsid, getTotalActiveOrders, listOrders, listOrdersByMsid, notifyOrderEvent };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-reviews-backend.d.ts", "content": "declare module \"wix-reviews-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** Entity describing Review */\n interface Review {\n /** Namespace of app integrated with reviews */\n namespace?: string;\n /** Entity to what review is written id */\n entityId?: string;\n /**\n * Review Id\n * @readonly\n */\n _id?: string;\n /** Review content */\n content?: ReviewContent;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n /**\n * Author of review data\n * @readonly\n */\n author?: Author;\n /**\n * Reply to review\n * @readonly\n */\n reply?: Reply;\n /**\n * Number of reader found this review helpful\n * @readonly\n */\n foundHelpful?: number;\n /**\n * Number of reader found this review unhelpful\n * @readonly\n */\n foundUnhelpful?: number;\n /**\n * Helpfulness score\n * @readonly\n */\n helpfulness?: number;\n /** Moderation status of review content */\n moderation?: Moderation;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n }\n /** Entity describing review content */\n interface ReviewContent {\n /** Review title */\n title?: string | null;\n /** Review body */\n body?: string | null;\n /** List of media items in review */\n media?: Media[];\n /** Given rating to review */\n rating?: number;\n }\n /** Entity describing media item of review */\n interface Media extends MediaMediaOneOf {\n /** image format media item */\n image?: string;\n /** video format media item */\n video?: string;\n }\n /** @oneof */\n interface MediaMediaOneOf {\n /** image format media item */\n image?: string;\n /** video format 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 /** Entity describing review author */\n interface Author {\n /** Contact id of author */\n contactId?: string | null;\n /** Author identity type */\n authorType?: AuthorType;\n /** Author name */\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 /** Entity describing reply to review */\n interface Reply {\n /** Reply content */\n message?: string;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n }\n /** Entity defining review moderation status */\n interface Moderation {\n moderationStatus?: ModerationModerationStatus;\n /**\n * Indicates whether the moderation status of the review was changed manually by a moderator.\n * i.e., when a moderator reviews the review and explicitly chooses to approve, reject.\n * If the status is changed automatically, for example as a result of\n * passing the moderation rules, this field will be set to false.\n * @readonly\n */\n manuallyChanged?: boolean;\n }\n /** Supported states review can be during moderation */\n enum ModerationModerationStatus {\n UNKNOWN = \"UNKNOWN\",\n APPROVED = \"APPROVED\",\n IN_MODERATION = \"IN_MODERATION\",\n REJECTED = \"REJECTED\",\n SUBMITTED = \"SUBMITTED\"\n }\n interface AsyncSubmitModeratedContentRequest {\n /** meta_site_id */\n metaSiteId?: string | null;\n /** App Def Id of moderated content owner vertical, if not provided, will be taken from CallScope */\n appDefId?: string | null;\n /** Content to moderate */\n content?: Content;\n /** optional content revision supplied and managed by vertical */\n contentRevision?: string | null;\n }\n /** content data */\n interface Content {\n /** content id */\n _id?: string;\n /** fqdn for the content */\n fqdn?: string;\n /** optional content title */\n title?: string | null;\n /** content parts */\n contentParts?: ContentPart[];\n /** classifier values that apply to content (i.e. Blog categories) */\n classifierValues?: ClassifierValues[];\n /** author info */\n authorInfo?: AuthorInfo;\n /** time of content creation */\n _createdDate?: Date;\n /** parent content info, optional */\n parent?: ParentInfo;\n /** optional deep link to content in vertical ui */\n deepLink?: Link;\n /** content visibility (read access) settings */\n visibility?: Visibility;\n }\n interface ContentPart extends ContentPartContentOneOf {\n /** plain text content */\n textContent?: string | null;\n /** draftJs content */\n draftJs?: string | null;\n /** Wix Media item */\n attachment?: MediaItem;\n /** content id stored in the future (rich) content server */\n storedContentId?: string | null;\n jsonData?: any;\n /** content part name */\n name?: string;\n }\n /** @oneof */\n interface ContentPartContentOneOf {\n /** plain text content */\n textContent?: string | null;\n /** draftJs content */\n draftJs?: string | null;\n /** Wix Media item */\n attachment?: MediaItem;\n /** content id stored in the future (rich) content server */\n storedContentId?: string | null;\n jsonData?: any;\n }\n /** Deprecated - Copy this message into your service, do not reference it */\n interface MediaItem extends MediaItemMediaOneOf {\n /** WixMedia image */\n image?: string;\n /** WixMedia video */\n video?: string;\n /** WixMedia document */\n document?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /** WixMedia image */\n image?: string;\n /** WixMedia video */\n video?: string;\n /** WixMedia document */\n document?: string;\n }\n interface ClassifierValues {\n /** classifier type, fqdn if applicable */\n type?: string;\n /** applicable value ids */\n valueIds?: string[];\n }\n interface AuthorInfo extends AuthorInfoIdentityOneOf {\n visitorId?: string;\n siteMemberId?: string;\n userId?: string;\n service?: string;\n externalApp?: string;\n }\n /** @oneof */\n interface AuthorInfoIdentityOneOf {\n visitorId?: string;\n siteMemberId?: string;\n userId?: string;\n service?: string;\n externalApp?: string;\n }\n interface ParentInfo {\n /** fqdn for the parent */\n fqdn?: string;\n /** parent id */\n parentId?: string;\n /** classifier values that apply to parent (i.e. Blog categories) */\n classifierValues?: ClassifierValues[];\n /** classifier values for parent are not known and should be queried from SPI for parent if possible */\n classifiersUnknown?: boolean;\n }\n /** to be replaced by commons wix.common.Link once merged */\n interface Link {\n /** Page url */\n url?: string;\n /** The mobile deeplink - e.g wix://app/1234-1234-1234-1234/memberships/manager */\n mobileLink?: string;\n }\n interface Visibility {\n /** enum stating content visibility type */\n visibilityType?: VisibilityType;\n /** array of permission ids or member groups that can be used with isPermitted to check content visibility */\n permissions?: string[];\n }\n enum VisibilityType {\n UNKNOWN = \"UNKNOWN\",\n PUBLIC = \"PUBLIC\",\n RESTRICTED = \"RESTRICTED\"\n }\n interface GetReviewRequest {\n /** Review id */\n reviewId: string;\n /** Feature flag which enables to return private (not published) review */\n returnPrivateReviews?: boolean;\n }\n interface GetReviewResponse {\n /** Review entity */\n review?: Review;\n }\n interface CreateReviewAndContactRequest {\n /** Namespace where review is created */\n namespace: string;\n /** Entity id of reviewed entity */\n entityId: string;\n /** Review author name */\n name?: string | null;\n /** Review author email. Only required when review author is visitor */\n email?: string | null;\n /** Review content */\n content: ReviewContent;\n }\n interface CreateReviewResponse {\n /** Review entity */\n review?: Review;\n }\n interface CreateReviewRequest {\n /** Review entity to create */\n review?: Review;\n }\n interface UpdateReviewContentRequest {\n /** Review id */\n reviewId: string;\n /** Review content */\n content?: ReviewContent;\n /**\n * Fieldmask with changed fields\n * Supported fields: content.title, content.body, content.media, content.rating\n */\n fieldMask?: string[];\n /** @internal */\n mask?: 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 interface UpdateReviewRequest {\n /** Review to be updated */\n review?: Review;\n /**\n * Fieldmask with changed fields\n * @internal\n */\n fieldMask?: string[];\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 /** Reviews to delete */\n filter?: Record | null;\n }\n interface BulkDeleteReviewsResponse {\n /** Reference to async job */\n jobId?: string;\n }\n interface QueryReviewsRequest {\n /** Review query */\n query?: QueryV2;\n /** Feature flag which enables to query private (not published) reviews */\n returnPrivateReviews?: boolean;\n }\n interface QueryV2 {\n filter?: Record | null;\n sort?: Sorting[];\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /**\n * Sort order.\n *\n * Defaults to `ASC`.\n */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\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 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 /** List of review */\n results?: Review[];\n /** Paging metadata */\n metadata?: 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 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 DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\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 /**\n * Returns requested review\n * @param reviewId - Review id\n * @public\n * @documentationMaturity preview\n * @requiredField reviewId\n * @returns Review entity\n */\n function getReview(reviewId: string, options?: GetReviewOptions): Promise;\n interface GetReviewOptions {\n /** Feature flag which enables to return private (not published) review */\n returnPrivateReviews?: boolean;\n }\n /**\n * Creates review and author contact in contacts system\n * @param namespace - Namespace where review is created\n * @public\n * @documentationMaturity preview\n * @requiredField namespace\n * @requiredField options\n * @requiredField options.content\n * @requiredField options.entityId\n */\n function createReviewAndContact(namespace: string, options: CreateReviewAndContactOptions): Promise;\n interface CreateReviewAndContactOptions {\n /** Entity id of reviewed entity */\n entityId: string;\n /** Review author name */\n name?: string | null;\n /** Review author email. Only required when review author is visitor */\n email?: string | null;\n /** Review content */\n content: ReviewContent;\n }\n /**\n * Creates review\n * @public\n * @documentationMaturity preview\n * @requiredField options.review.author\n * @requiredField options.review.author.contactId\n * @requiredField options.review.content\n * @requiredField options.review.entityId\n * @requiredField options.review.namespace\n * @returns Review entity\n */\n function createReview(options?: CreateReviewOptions): Promise;\n interface CreateReviewOptions {\n /** Review entity to create */\n review?: Review;\n }\n /**\n * Updates review content with provided data\n * @param reviewId - Review id\n * @internal\n * @documentationMaturity preview\n * @requiredField reviewId\n */\n function updateReviewContent(reviewId: string, options?: UpdateReviewContentOptions): Promise;\n interface UpdateReviewContentOptions {\n /** Review content */\n content?: ReviewContent;\n /**\n * Fieldmask with changed fields\n * Supported fields: content.title, content.body, content.media, content.rating\n */\n fieldMask?: string[];\n /** @internal */\n mask?: string[];\n }\n /**\n * Updates review with provided data.\n * Pass the latest `revision` for a successful update.\n *\n * | Supported fields |\n * | ----------- |\n * | content.title |\n * | content.body |\n * | content.media |\n * | content.rating |\n * @param _id - Review Id\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.review.revision\n * @returns Updated review data\n */\n function updateReview(_id: string, options?: UpdateReviewOptions): Promise;\n interface UpdateReviewOptions {\n review: {\n /** Namespace of app integrated with reviews */\n namespace?: string;\n /** Entity to what review is written id */\n entityId?: string;\n /**\n * Review Id\n * @readonly\n */\n _id?: string;\n /** Review content */\n content?: ReviewContent;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n /**\n * Author of review data\n * @readonly\n */\n author?: Author;\n /**\n * Reply to review\n * @readonly\n */\n reply?: Reply;\n /**\n * Number of reader found this review helpful\n * @readonly\n */\n foundHelpful?: number;\n /**\n * Number of reader found this review unhelpful\n * @readonly\n */\n foundUnhelpful?: number;\n /**\n * Helpfulness score\n * @readonly\n */\n helpfulness?: number;\n /** Moderation status of review content */\n moderation?: Moderation;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n };\n /**\n * Fieldmask with changed fields\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes review\n * @param reviewId - Review id\n * @public\n * @documentationMaturity preview\n * @requiredField reviewId\n */\n function deleteReview(reviewId: string): Promise;\n /**\n * Deletes list of reviews by ids\n * @public\n * @documentationMaturity preview\n */\n function bulkDeleteReviews(options?: BulkDeleteReviewsOptions): Promise;\n interface BulkDeleteReviewsOptions {\n /** Reviews to delete */\n filter?: Record | null;\n }\n /**\n * Return Reviews based on provided Query\n *\n *\n * | Filterable fields | Supported operators |\n * | ----------- | ----------- |\n * | id | `$eq`, `$ne`, `$in` |\n * | namespace | `$eq`, `$ne`, `$in` |\n * | entityId | `$eq`, `$ne`, `$in` |\n * | content.rating | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` |\n * | content.media | `$isEmpty` |\n * | helpfulness | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` |\n * | moderation.moderationStatus | `$eq`, `$ne`, `$in` |\n * | createdDate | `$eq`, `$ne`, `$in`, `$lt`, `$lte`, `$gt`, `$gte` |\n *\n * | Sortable fields | Supported directions |\n * | ----------- | ----------- |\n * | content.rating | `ASC`, `DESC` |\n * | helpfulness | `ASC`, `DESC` |\n * | createdDate | `ASC`, `DESC` |\n * @public\n * @documentationMaturity preview\n */\n function queryReviews(options?: QueryReviewsOptions): ResultsQueryBuilder;\n interface QueryReviewsOptions {\n /** Feature flag which enables to query private (not published) reviews */\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 ResultsQueryResult extends QueryCursorResult {\n items: Review[];\n query: ResultsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ResultsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'namespace' | '_id' | 'content.rating' | '_createdDate' | 'helpfulness' | 'moderation.moderationStatus', value: any) => ResultsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'namespace' | '_id' | 'content.rating' | '_createdDate' | 'helpfulness' | 'moderation.moderationStatus', value: any) => ResultsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'content.rating' | 'helpfulness', value: any) => ResultsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'content.rating' | '_createdDate' | 'helpfulness', value: any) => ResultsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'content.rating' | '_createdDate' | 'helpfulness', value: any) => ResultsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'content.rating' | '_createdDate' | 'helpfulness', value: any) => ResultsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'namespace' | '_id' | 'content.rating' | '_createdDate' | 'helpfulness' | 'moderation.moderationStatus', value: any) => ResultsQueryBuilder;\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<'content.rating' | '_createdDate' | 'helpfulness'>) => ResultsQueryBuilder;\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<'content.rating' | '_createdDate' | 'helpfulness'>) => ResultsQueryBuilder;\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) => ResultsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ResultsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Set reply on a review\n * @param reviewId - Review id\n * @param message - Response to review author\n * @internal\n * @documentationMaturity preview\n * @requiredField message\n * @requiredField reviewId\n */\n function setReply(reviewId: string, message: string): Promise;\n /**\n * Removes reply from review\n * @param reviewId - Review id\n * @internal\n * @documentationMaturity preview\n * @requiredField reviewId\n */\n function removeReply(reviewId: string): Promise;\n /**\n * Changes moderation status for multiple reviews\n * @internal\n * @documentationMaturity preview\n */\n function bulkUpdateModerationStatus(options?: BulkUpdateModerationStatusOptions): Promise;\n interface BulkUpdateModerationStatusOptions {\n /** Reviews to moderate */\n filter?: Record | null;\n /** Moderation status to set */\n status?: ModerationStatus;\n }\n \n const reviewsV1Review_universal_d___debug: typeof __debug;\n type reviewsV1Review_universal_d_Review = Review;\n type reviewsV1Review_universal_d_ReviewContent = ReviewContent;\n type reviewsV1Review_universal_d_Media = Media;\n type reviewsV1Review_universal_d_MediaMediaOneOf = MediaMediaOneOf;\n type reviewsV1Review_universal_d_VideoResolution = VideoResolution;\n type reviewsV1Review_universal_d_Author = Author;\n type reviewsV1Review_universal_d_AuthorType = AuthorType;\n const reviewsV1Review_universal_d_AuthorType: typeof AuthorType;\n type reviewsV1Review_universal_d_Reply = Reply;\n type reviewsV1Review_universal_d_Moderation = Moderation;\n type reviewsV1Review_universal_d_ModerationModerationStatus = ModerationModerationStatus;\n const reviewsV1Review_universal_d_ModerationModerationStatus: typeof ModerationModerationStatus;\n type reviewsV1Review_universal_d_AsyncSubmitModeratedContentRequest = AsyncSubmitModeratedContentRequest;\n type reviewsV1Review_universal_d_Content = Content;\n type reviewsV1Review_universal_d_ContentPart = ContentPart;\n type reviewsV1Review_universal_d_ContentPartContentOneOf = ContentPartContentOneOf;\n type reviewsV1Review_universal_d_MediaItem = MediaItem;\n type reviewsV1Review_universal_d_MediaItemMediaOneOf = MediaItemMediaOneOf;\n type reviewsV1Review_universal_d_ClassifierValues = ClassifierValues;\n type reviewsV1Review_universal_d_AuthorInfo = AuthorInfo;\n type reviewsV1Review_universal_d_AuthorInfoIdentityOneOf = AuthorInfoIdentityOneOf;\n type reviewsV1Review_universal_d_ParentInfo = ParentInfo;\n type reviewsV1Review_universal_d_Link = Link;\n type reviewsV1Review_universal_d_Visibility = Visibility;\n type reviewsV1Review_universal_d_VisibilityType = VisibilityType;\n const reviewsV1Review_universal_d_VisibilityType: typeof VisibilityType;\n type reviewsV1Review_universal_d_GetReviewRequest = GetReviewRequest;\n type reviewsV1Review_universal_d_GetReviewResponse = GetReviewResponse;\n type reviewsV1Review_universal_d_CreateReviewAndContactRequest = CreateReviewAndContactRequest;\n type reviewsV1Review_universal_d_CreateReviewResponse = CreateReviewResponse;\n type reviewsV1Review_universal_d_CreateReviewRequest = CreateReviewRequest;\n type reviewsV1Review_universal_d_UpdateReviewContentRequest = UpdateReviewContentRequest;\n type reviewsV1Review_universal_d_UpdateReviewContentResponse = UpdateReviewContentResponse;\n type reviewsV1Review_universal_d_ModerationStatusChanged = ModerationStatusChanged;\n type reviewsV1Review_universal_d_UpdateReviewRequest = UpdateReviewRequest;\n type reviewsV1Review_universal_d_UpdateReviewResponse = UpdateReviewResponse;\n type reviewsV1Review_universal_d_DeleteReviewRequest = DeleteReviewRequest;\n type reviewsV1Review_universal_d_DeleteReviewResponse = DeleteReviewResponse;\n type reviewsV1Review_universal_d_BulkDeleteReviewsRequest = BulkDeleteReviewsRequest;\n type reviewsV1Review_universal_d_BulkDeleteReviewsResponse = BulkDeleteReviewsResponse;\n type reviewsV1Review_universal_d_QueryReviewsRequest = QueryReviewsRequest;\n type reviewsV1Review_universal_d_QueryV2 = QueryV2;\n type reviewsV1Review_universal_d_Sorting = Sorting;\n type reviewsV1Review_universal_d_SortOrder = SortOrder;\n const reviewsV1Review_universal_d_SortOrder: typeof SortOrder;\n type reviewsV1Review_universal_d_CursorPaging = CursorPaging;\n type reviewsV1Review_universal_d_QueryReviewsResponse = QueryReviewsResponse;\n type reviewsV1Review_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type reviewsV1Review_universal_d_Cursors = Cursors;\n type reviewsV1Review_universal_d_SetReplyRequest = SetReplyRequest;\n type reviewsV1Review_universal_d_SetReplyResponse = SetReplyResponse;\n type reviewsV1Review_universal_d_RemoveReplyRequest = RemoveReplyRequest;\n type reviewsV1Review_universal_d_RemoveReplyResponse = RemoveReplyResponse;\n type reviewsV1Review_universal_d_DomainEvent = DomainEvent;\n type reviewsV1Review_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type reviewsV1Review_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type reviewsV1Review_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type reviewsV1Review_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type reviewsV1Review_universal_d_ActionEvent = ActionEvent;\n type reviewsV1Review_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type reviewsV1Review_universal_d_Empty = Empty;\n type reviewsV1Review_universal_d_BulkUpdateModerationStatusRequest = BulkUpdateModerationStatusRequest;\n type reviewsV1Review_universal_d_ModerationStatus = ModerationStatus;\n const reviewsV1Review_universal_d_ModerationStatus: typeof ModerationStatus;\n type reviewsV1Review_universal_d_BulkUpdateModerationStatusResponse = BulkUpdateModerationStatusResponse;\n const reviewsV1Review_universal_d_getReview: typeof getReview;\n type reviewsV1Review_universal_d_GetReviewOptions = GetReviewOptions;\n const reviewsV1Review_universal_d_createReviewAndContact: typeof createReviewAndContact;\n type reviewsV1Review_universal_d_CreateReviewAndContactOptions = CreateReviewAndContactOptions;\n const reviewsV1Review_universal_d_createReview: typeof createReview;\n type reviewsV1Review_universal_d_CreateReviewOptions = CreateReviewOptions;\n const reviewsV1Review_universal_d_updateReviewContent: typeof updateReviewContent;\n type reviewsV1Review_universal_d_UpdateReviewContentOptions = UpdateReviewContentOptions;\n const reviewsV1Review_universal_d_updateReview: typeof updateReview;\n type reviewsV1Review_universal_d_UpdateReviewOptions = UpdateReviewOptions;\n const reviewsV1Review_universal_d_deleteReview: typeof deleteReview;\n const reviewsV1Review_universal_d_bulkDeleteReviews: typeof bulkDeleteReviews;\n type reviewsV1Review_universal_d_BulkDeleteReviewsOptions = BulkDeleteReviewsOptions;\n const reviewsV1Review_universal_d_queryReviews: typeof queryReviews;\n type reviewsV1Review_universal_d_QueryReviewsOptions = QueryReviewsOptions;\n type reviewsV1Review_universal_d_ResultsQueryResult = ResultsQueryResult;\n type reviewsV1Review_universal_d_ResultsQueryBuilder = ResultsQueryBuilder;\n const reviewsV1Review_universal_d_setReply: typeof setReply;\n const reviewsV1Review_universal_d_removeReply: typeof removeReply;\n const reviewsV1Review_universal_d_bulkUpdateModerationStatus: typeof bulkUpdateModerationStatus;\n type reviewsV1Review_universal_d_BulkUpdateModerationStatusOptions = BulkUpdateModerationStatusOptions;\n namespace reviewsV1Review_universal_d {\n export {\n reviewsV1Review_universal_d___debug as __debug,\n reviewsV1Review_universal_d_Review as Review,\n reviewsV1Review_universal_d_ReviewContent as ReviewContent,\n reviewsV1Review_universal_d_Media as Media,\n reviewsV1Review_universal_d_MediaMediaOneOf as MediaMediaOneOf,\n reviewsV1Review_universal_d_VideoResolution as VideoResolution,\n reviewsV1Review_universal_d_Author as Author,\n reviewsV1Review_universal_d_AuthorType as AuthorType,\n reviewsV1Review_universal_d_Reply as Reply,\n reviewsV1Review_universal_d_Moderation as Moderation,\n reviewsV1Review_universal_d_ModerationModerationStatus as ModerationModerationStatus,\n reviewsV1Review_universal_d_AsyncSubmitModeratedContentRequest as AsyncSubmitModeratedContentRequest,\n reviewsV1Review_universal_d_Content as Content,\n reviewsV1Review_universal_d_ContentPart as ContentPart,\n reviewsV1Review_universal_d_ContentPartContentOneOf as ContentPartContentOneOf,\n reviewsV1Review_universal_d_MediaItem as MediaItem,\n reviewsV1Review_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf,\n reviewsV1Review_universal_d_ClassifierValues as ClassifierValues,\n reviewsV1Review_universal_d_AuthorInfo as AuthorInfo,\n reviewsV1Review_universal_d_AuthorInfoIdentityOneOf as AuthorInfoIdentityOneOf,\n reviewsV1Review_universal_d_ParentInfo as ParentInfo,\n reviewsV1Review_universal_d_Link as Link,\n reviewsV1Review_universal_d_Visibility as Visibility,\n reviewsV1Review_universal_d_VisibilityType as VisibilityType,\n reviewsV1Review_universal_d_GetReviewRequest as GetReviewRequest,\n reviewsV1Review_universal_d_GetReviewResponse as GetReviewResponse,\n reviewsV1Review_universal_d_CreateReviewAndContactRequest as CreateReviewAndContactRequest,\n reviewsV1Review_universal_d_CreateReviewResponse as CreateReviewResponse,\n reviewsV1Review_universal_d_CreateReviewRequest as CreateReviewRequest,\n reviewsV1Review_universal_d_UpdateReviewContentRequest as UpdateReviewContentRequest,\n reviewsV1Review_universal_d_UpdateReviewContentResponse as UpdateReviewContentResponse,\n reviewsV1Review_universal_d_ModerationStatusChanged as ModerationStatusChanged,\n reviewsV1Review_universal_d_UpdateReviewRequest as UpdateReviewRequest,\n reviewsV1Review_universal_d_UpdateReviewResponse as UpdateReviewResponse,\n reviewsV1Review_universal_d_DeleteReviewRequest as DeleteReviewRequest,\n reviewsV1Review_universal_d_DeleteReviewResponse as DeleteReviewResponse,\n reviewsV1Review_universal_d_BulkDeleteReviewsRequest as BulkDeleteReviewsRequest,\n reviewsV1Review_universal_d_BulkDeleteReviewsResponse as BulkDeleteReviewsResponse,\n reviewsV1Review_universal_d_QueryReviewsRequest as QueryReviewsRequest,\n reviewsV1Review_universal_d_QueryV2 as QueryV2,\n reviewsV1Review_universal_d_Sorting as Sorting,\n reviewsV1Review_universal_d_SortOrder as SortOrder,\n reviewsV1Review_universal_d_CursorPaging as CursorPaging,\n reviewsV1Review_universal_d_QueryReviewsResponse as QueryReviewsResponse,\n reviewsV1Review_universal_d_PagingMetadataV2 as PagingMetadataV2,\n reviewsV1Review_universal_d_Cursors as Cursors,\n reviewsV1Review_universal_d_SetReplyRequest as SetReplyRequest,\n reviewsV1Review_universal_d_SetReplyResponse as SetReplyResponse,\n reviewsV1Review_universal_d_RemoveReplyRequest as RemoveReplyRequest,\n reviewsV1Review_universal_d_RemoveReplyResponse as RemoveReplyResponse,\n reviewsV1Review_universal_d_DomainEvent as DomainEvent,\n reviewsV1Review_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n reviewsV1Review_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n reviewsV1Review_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n reviewsV1Review_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n reviewsV1Review_universal_d_ActionEvent as ActionEvent,\n reviewsV1Review_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n reviewsV1Review_universal_d_Empty as Empty,\n reviewsV1Review_universal_d_BulkUpdateModerationStatusRequest as BulkUpdateModerationStatusRequest,\n reviewsV1Review_universal_d_ModerationStatus as ModerationStatus,\n reviewsV1Review_universal_d_BulkUpdateModerationStatusResponse as BulkUpdateModerationStatusResponse,\n reviewsV1Review_universal_d_getReview as getReview,\n reviewsV1Review_universal_d_GetReviewOptions as GetReviewOptions,\n reviewsV1Review_universal_d_createReviewAndContact as createReviewAndContact,\n reviewsV1Review_universal_d_CreateReviewAndContactOptions as CreateReviewAndContactOptions,\n reviewsV1Review_universal_d_createReview as createReview,\n reviewsV1Review_universal_d_CreateReviewOptions as CreateReviewOptions,\n reviewsV1Review_universal_d_updateReviewContent as updateReviewContent,\n reviewsV1Review_universal_d_UpdateReviewContentOptions as UpdateReviewContentOptions,\n reviewsV1Review_universal_d_updateReview as updateReview,\n reviewsV1Review_universal_d_UpdateReviewOptions as UpdateReviewOptions,\n reviewsV1Review_universal_d_deleteReview as deleteReview,\n reviewsV1Review_universal_d_bulkDeleteReviews as bulkDeleteReviews,\n reviewsV1Review_universal_d_BulkDeleteReviewsOptions as BulkDeleteReviewsOptions,\n reviewsV1Review_universal_d_queryReviews as queryReviews,\n reviewsV1Review_universal_d_QueryReviewsOptions as QueryReviewsOptions,\n reviewsV1Review_universal_d_ResultsQueryResult as ResultsQueryResult,\n reviewsV1Review_universal_d_ResultsQueryBuilder as ResultsQueryBuilder,\n reviewsV1Review_universal_d_setReply as setReply,\n reviewsV1Review_universal_d_removeReply as removeReply,\n reviewsV1Review_universal_d_bulkUpdateModerationStatus as bulkUpdateModerationStatus,\n reviewsV1Review_universal_d_BulkUpdateModerationStatusOptions as BulkUpdateModerationStatusOptions,\n };\n }\n \n export { reviewsV1Review_universal_d as reviews };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-restaurants-catalogs-backend.d.ts", "content": "declare module \"wix-restaurants-catalogs-backend\" {\n /**\n * Collection of menus and discounts available in a specific location.\n * Use a [draft catalog](https://dev.wix.com/api/rest/wix-restaurants/catalogs/draft-catalogs) to publish multiple changes to a catalog at the same time.\n * You can read more about catalogs in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Catalog {\n /**\n * Catalog ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the location the catalog belongs to. See the [Locations API](https://dev.wix.com/api/rest/business-info/locations/introduction) for more details.\n * @readonly\n */\n locationId?: string | null;\n /**\n * Whether the catalog is archived.\n * __Note:__ Archived catalogs can't be updated.\n * @readonly\n */\n archived?: boolean;\n /**\n * Date and time the last time a draft catalog has been published in `yyyy-mm-ddThh:mm:sssZ` format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n * @readonly\n */\n draftPublishedDate?: Date;\n /**\n * Revision number. Increments by 1 each time the catalog is updated.\n * To prevent conflicting changes, the existing `revision` must be used when updating a catalog.\n * @internal\n * @readonly\n */\n revision?: string | null;\n }\n interface CreateDraftCatalogResponse {\n /** Created draft catalog. */\n catalog?: Catalog;\n }\n interface PublishDraftCatalogResponse {\n /** Published catalog. */\n catalog?: Catalog;\n }\n interface DiscardDraftCatalogResponse {\n }\n interface NewVariation {\n /** Variation name. */\n name?: string;\n }\n interface BulkCreateVariationsResponse {\n /** Information about the created variations. */\n results?: BulkItemResult[];\n /** Bulk Create Variations metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkItemResult {\n /** Metadata of the item. */\n entityMetadata?: ItemMetadata;\n /** Item. */\n entity?: Item;\n }\n interface ItemMetadata {\n /** Item id. Should always be provided, unless it's impossible (e.g when failing to create an item) */\n _id?: string | null;\n /** The index of the item within the request array to allow the caller to correlate the request and response items */\n originalIndex?: number;\n /** Whether the action requested was successful for this item. When this value is false, error should be populated */\n success?: boolean;\n /** In case of failure, details about the error */\n error?: ApplicationError;\n }\n interface ApplicationError {\n code?: string;\n description?: string;\n data?: Record | null;\n }\n /**\n * Anything that customers can buy in the restaurant. Items can be of type `DISH` or `VARIATION`.\n * You can read more about items in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Item {\n /**\n * Item ID.\n * @readonly\n */\n _id?: string | null;\n /** Item name. */\n name?: string | null;\n /** Item description. */\n description?: string | null;\n /** Item price. */\n price?: Money;\n /** URL of the item's image file. */\n imageUrl?: string | null;\n /** Item labels. For example spicy, hot, vegan, gluten-free, or organic. */\n labels?: Labels;\n /** Whether the item is in stock. */\n inStock?: boolean | null;\n /** Tax rate of the item in percent. */\n taxRate?: string | null;\n /**\n * Whether the item is archived. Defaults to `false`. **Note:** Archived items can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n /**\n * Visibility criteria that must be met for the item to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /** Items customers can choose to modify a dish. Can be an extra, selection, or deselection. */\n dishOptions?: DishOptions;\n /** Whether a customer can add a special request when ordering this item. Defaults to `true`. */\n acceptSpecialRequest?: boolean | null;\n /**\n * Item type.\n * @readonly\n */\n type?: ItemType;\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 /**\n * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n * @readonly\n */\n currency?: string;\n /**\n * Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.\n * @internal\n * @readonly\n */\n formattedValue?: string | null;\n }\n interface Labels {\n values?: string[];\n }\n interface VisibilityCriteria {\n /**\n * Whether the entity appears in the live site. Defaults to `true`.\n * If `false`, the entity isn't rendered in the live site, even if each visibility criterion is fulfilled.\n */\n visible?: boolean | null;\n /** Fulfillment types. */\n fulfillmentTypes?: FulfillmentType[];\n /** Ordering platforms. */\n platforms?: Platform[];\n /** Time periods when the entity is available. */\n availability?: Availability;\n }\n enum FulfillmentType {\n UNSPECIFIED_FULFILLMENT_TYPE = \"UNSPECIFIED_FULFILLMENT_TYPE\",\n DELIVERY = \"DELIVERY\",\n PICKUP_OR_DINE_IN = \"PICKUP_OR_DINE_IN\"\n }\n enum Platform {\n UNSPECIFIED_PLATFORM = \"UNSPECIFIED_PLATFORM\",\n SITE = \"SITE\",\n MOBILE_SITE = \"MOBILE_SITE\",\n WIX_APP = \"WIX_APP\",\n CALL_CENTER = \"CALL_CENTER\",\n CHAT_BOT = \"CHAT_BOT\"\n }\n interface Availability {\n /**\n * Weekly recurring time periods when the entity is available.\n * Limited to 100 time periods.\n */\n periods?: TimePeriod[];\n /** Exceptions to the entity's regular availability. The entity can be available or not available during the special hour period. */\n specialHourPeriods?: SpecialHourPeriod[];\n }\n /** Weekly recurring time periods when the entity 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-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-24:00, where 24:00 represents\n * midnight at the end of the specified day.\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 enum DayOfWeek {\n UNDEFINED = \"UNDEFINED\",\n SUN = \"SUN\",\n MON = \"MON\",\n TUE = \"TUE\",\n WED = \"WED\",\n THU = \"THU\",\n FRI = \"FRI\",\n SAT = \"SAT\"\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 /** Whether the item is available during the exception. Defaults to `true`. */\n available?: boolean;\n /** Name of the special hour period. In the Business Manager the special hour period is called event. */\n eventName?: string | null;\n }\n interface DishOptions {\n values?: DishOption[];\n }\n interface DishOption {\n /** Dish option name. */\n name?: string;\n /** @readonly */\n type?: Type;\n /** Item of type `DISH` or `VARIATION` that customers can select. For example a dish size. Customers can choose only a single selection per dish. */\n selection?: Selection;\n /** Item of type `DISH` or `VARIATION` that customers can add to a dish. For example a topping. Customers can add multiple extras per dish. */\n extras?: Extras;\n /** Item of type `DISH` or `VARIATION` that customers can remove from a dish. For example a specific ingredient. Customers can remove multiple deselections per dish. */\n deselection?: Deselection;\n }\n interface DishOptionItem {\n /** Item ID of the dish option. */\n itemId?: string;\n /** Dish option price. `0` for free choices that are included in the dish's price. */\n price?: Money;\n }\n interface Selection {\n /** Item ID of the default choice. */\n defaultChoice?: string | null;\n /** Item IDs of the available choices. */\n availableChoices?: DishOptionItem[];\n }\n interface Extras {\n /** Item IDs of the default choices. */\n defaultChoices?: string[];\n /** Minimum number of extras a customer must choose. Defaults to `0`. Must be lower than or equal to the value of `availableChoices`. */\n minChoices?: number | null;\n /** Maximum number of extras a customer can choose. Defaults to the value of `availableChoices`. Must be greater than or equal to the value of `minChoices`. */\n maxChoices?: number | null;\n /** Item IDs of the available choices. */\n availableChoices?: DishOptionItem[];\n }\n interface Deselection {\n /** Item IDs of the available choices. */\n availableChoices?: DishOptionItem[];\n }\n enum Type {\n UNSPECIFIED_DISH_OPTION_TYPE = \"UNSPECIFIED_DISH_OPTION_TYPE\",\n SELECTION = \"SELECTION\",\n EXTRAS = \"EXTRAS\",\n DESELECTION = \"DESELECTION\"\n }\n enum ItemType {\n UNSPECIFIED_ITEM_TYPE = \"UNSPECIFIED_ITEM_TYPE\",\n DISH = \"DISH\",\n VARIATION = \"VARIATION\"\n }\n interface BulkActionMetadata {\n /** For how many items the requested action was successful */\n totalSuccesses?: number;\n /** For how many items the requested action was not successful */\n totalFailures?: number;\n /** total number of failures without details because detailed-failure-threshold exceeded */\n undetailedFailures?: number;\n }\n interface BulkUpdateItemsResponse {\n /** Information about the updated items. */\n results?: BulkItemResult[];\n /** Bulk Update Items metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface CreateDishRequest {\n /** ID of the menu the dish will belong to. */\n menuId: string;\n /** ID of the section the dish will belong to. */\n sectionId: string;\n /** Dish to create. */\n dish: Item;\n }\n interface BulkCreateDishesResponse {\n /** Information about the created dishes. */\n results?: BulkItemResult[];\n /** Bulk Create Dishes metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n /**\n * Collection of sections that show what customers can buy in the restaurant.\n * You can read more about menus in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Menu {\n /**\n * Menu ID.\n * @readonly\n */\n _id?: string | null;\n /** Menu name. */\n name?: string | null;\n /** Menu description. */\n description?: string | null;\n /** URL of the menu's image file. */\n imageUrl?: string | null;\n /**\n * Visibility criteria that must be met for the menu to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /** IDs of the sections that are included in the menu. */\n sectionIds?: MenuSectionIds;\n /**\n * Whether the menu is archived. Defaults to `false`. **Note:** Archived menus can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n }\n interface MenuSectionIds {\n values?: string[];\n }\n interface BulkCreateMenusResponse {\n /** Information about the created menus. */\n results?: BulkMenuResult[];\n /** Bulk Create Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkMenuResult {\n /** Menu metadata. */\n entityMetadata?: ItemMetadata;\n /** Menu. */\n entity?: Menu;\n }\n interface BulkUpdateMenusResponse {\n /** Information about the updated menus. */\n results?: BulkMenuResult[];\n /** Bulk Update Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n /**\n * Collection of dishes that customers can buy in the restaurant.\n * You can read more about sections in the [introduction](https://dev.wix.com/api/rest/wix-restaurants/catalogs/introduction).\n */\n interface Section {\n /**\n * Section ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the menu the section belongs to.\n * @readonly\n */\n menuId?: string | null;\n /** Section name. */\n name?: string | null;\n /** Section description. */\n description?: string | null;\n /** URL of the section's image file. */\n imageUrl?: string | null;\n /** IDs of the items that belong to the section. */\n itemIds?: SectionItemIds;\n /**\n * Visibility criteria that must be met for the section to appear in the live site.\n * In case of multiple visibility criteria, every criterion must be fulfilled.\n */\n visibilityCriteria?: VisibilityCriteria;\n /**\n * Whether the section is archived. Defaults to `false`. **Note:** Archived sections can't be updated.\n * @readonly\n */\n archived?: boolean | null;\n }\n /** Item IDs of the dishes that belong to this section. */\n interface SectionItemIds {\n values?: string[];\n }\n interface CreateSectionRequest {\n /** ID of the menu the section will belong to. */\n menuId: string;\n /** Section to create. */\n section: Section;\n }\n interface BulkCreateSectionsResponse {\n /** Information about the created sections. */\n results?: BulkSectionResult[];\n /** Bulk Create Sections metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkSectionResult {\n /** Section metadata. */\n entityMetadata?: ItemMetadata;\n /** Section. */\n entity?: Section;\n }\n interface UpdateSectionRequest {\n /** ID of the menu the section will belong to. */\n menuId: string;\n /** Section to update. */\n section: Section;\n }\n interface BulkUpdateSectionsResponse {\n /** Information about the updated sections. */\n results?: BulkSectionResult[];\n /** Bulk Update Sections metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkArchiveMenusResponse {\n /** Information about the archived menus. */\n results?: BulkMenuResult[];\n /** Bulk Archive Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkUnarchiveMenusResponse {\n /** Information about the unarchived menus. */\n results?: BulkMenuResult[];\n /** Bulk Unarchive Menus metadata. */\n bulkActionMetadata?: BulkActionMetadata;\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 ListCatalogsResponse {\n /** Retrieved catalogs. */\n catalogs?: Catalog[];\n }\n interface GetMenuResponse {\n /** Retrieved menu. */\n menu?: Menu;\n }\n interface GetSectionResponse {\n /** Retrieved section. */\n section?: Section;\n }\n interface UpdateMenuResponse {\n /** Updated Menu. */\n menu?: Menu;\n }\n interface UpdateSectionResponse {\n /** Updated section. */\n section?: Section;\n }\n interface ListMenusResponse {\n /** Retrieved menus. */\n menus?: Menu[];\n }\n interface ListSectionsResponse {\n /** Sections list. */\n sections?: Section[];\n }\n interface CreateMenuResponse {\n /** Created Menu. */\n menu?: Menu;\n }\n interface ArchiveMenuResponse {\n /** Archived menu. */\n menu?: Menu;\n }\n interface UnarchiveMenuResponse {\n /** Unarchived menu. */\n menu?: Menu;\n }\n interface CreateSectionResponse {\n /** Created section. */\n section?: Section;\n }\n interface GetItemResponse {\n /** Retrieved item. */\n item?: Item;\n }\n interface ListItemsResponse {\n /** Retrieved items. */\n items?: Item[];\n }\n interface UpdateItemResponse {\n /** Updated Item. */\n item?: Item;\n }\n interface CreateDishResponse {\n /** Created Dish. */\n dish?: Item;\n }\n interface CreateVariationResponse {\n /** Created Variation. */\n variation?: Item;\n }\n interface BulkCreateVariationsOptions {\n returnFullEntity?: boolean;\n }\n interface BulkUpdateItemsOptions {\n returnFullEntity?: boolean;\n }\n interface BulkCreateDishesOptions {\n returnFullEntity?: boolean;\n }\n interface BulkCreateMenusOptions {\n returnFullEntity?: boolean;\n }\n interface BulkUpdateMenusOptions {\n returnFullEntity?: boolean;\n }\n interface BulkCreateSectionsOptions {\n returnFullEntity?: boolean;\n }\n interface BulkUpdateSectionsOptions {\n returnFullEntity?: boolean;\n }\n interface BulkArchiveMenusOptions {\n returnFullEntity?: boolean;\n }\n interface BulkUnarchiveMenusOptions {\n returnFullEntity?: boolean;\n }\n interface ListCatalogsOptions {\n sort?: Sorting;\n paging?: Paging;\n archived?: boolean;\n locationIds?: string[];\n }\n interface GetMenuIdentifiers {\n catalogId: string;\n menuId: string;\n }\n interface GetSectionIdentifiers {\n catalogId: string;\n menuId: string;\n sectionId: string;\n }\n interface UpdateMenuIdentifiers {\n catalogId: string;\n }\n interface UpdateMenuOptions {\n menu: Menu;\n }\n interface UpdateSectionIdentifiers {\n catalogId: string;\n menuId: string;\n }\n interface UpdateSectionOptions {\n section: Section;\n }\n interface ListMenusOptions {\n fieldMask?: string[];\n archived?: boolean;\n }\n interface ListSectionsOptions {\n fieldMask?: string[];\n archived?: boolean;\n }\n interface ArchiveMenuIdentifiers {\n catalogId: string;\n menuId: string;\n }\n interface UnarchiveMenuIdentifiers {\n catalogId: string;\n menuId: string;\n }\n interface CreateSectionIdentifiers {\n catalogId: string;\n menuId: string;\n }\n interface GetItemIdentifiers {\n catalogId: string;\n itemId: string;\n }\n interface GetItemOptions {\n includeVisibilityCriteria?: boolean;\n }\n interface ListItemsOptions {\n fieldMask?: string[];\n archived?: boolean;\n }\n interface UpdateItemIdentifiers {\n catalogId: string;\n }\n interface UpdateItemOptions {\n item: Item;\n }\n interface CreateDishIdentifiers {\n catalogId: string;\n menuId: string;\n sectionId: string;\n }\n \n function createDraftCatalog(catalogId: string): Promise;\n function publishDraftCatalog(catalogId: string): Promise;\n function discardDraftCatalog(catalogId: string): Promise;\n function bulkCreateVariations(catalogId: string, variations: NewVariation[], options: BulkCreateVariationsOptions): Promise;\n function bulkUpdateItems(catalogId: string, items: Item[], options: BulkUpdateItemsOptions): Promise;\n function bulkCreateDishes(catalogId: string, createDishRequests: CreateDishRequest[], options: BulkCreateDishesOptions): Promise;\n function bulkCreateMenus(catalogId: string, menus: Menu[], options: BulkCreateMenusOptions): Promise;\n function bulkUpdateMenus(catalogId: string, menus: Menu[], options: BulkUpdateMenusOptions): Promise;\n function bulkCreateSections(catalogId: string, createSectionRequests: CreateSectionRequest[], options: BulkCreateSectionsOptions): Promise;\n function bulkUpdateSections(catalogId: string, updateSectionsRequests: UpdateSectionRequest[], options: BulkUpdateSectionsOptions): Promise;\n function bulkArchiveMenus(catalogId: string, ids: string[], options: BulkArchiveMenusOptions): Promise;\n function bulkUnarchiveMenus(catalogId: string, ids: string[], options: BulkUnarchiveMenusOptions): Promise;\n function listCatalogs(options: ListCatalogsOptions): Promise;\n function getMenu(identifiers: GetMenuIdentifiers): Promise;\n function getSection(identifiers: GetSectionIdentifiers): Promise;\n function updateMenu(identifiers: UpdateMenuIdentifiers, options: UpdateMenuOptions): Promise;\n function updateSection(identifiers: UpdateSectionIdentifiers, options: UpdateSectionOptions): Promise;\n function listMenus(catalogId: string, options: ListMenusOptions): Promise;\n function listSections(catalogId: string, options: ListSectionsOptions): Promise;\n function createMenu(catalogId: string, menu: Menu): Promise;\n function archiveMenu(identifiers: ArchiveMenuIdentifiers): Promise;\n function unarchiveMenu(identifiers: UnarchiveMenuIdentifiers): Promise;\n function createSection(identifiers: CreateSectionIdentifiers, section: Section): Promise;\n function getItem(identifiers: GetItemIdentifiers, options: GetItemOptions): Promise;\n function listItems(catalogId: string, options: ListItemsOptions): Promise;\n function updateItem(identifiers: UpdateItemIdentifiers, options: UpdateItemOptions): Promise;\n function createDish(identifiers: CreateDishIdentifiers, dish: Item): Promise;\n function createVariation(catalogId: string, name: string): Promise;\n \n export { archiveMenu, bulkArchiveMenus, bulkCreateDishes, bulkCreateMenus, bulkCreateSections, bulkCreateVariations, bulkUnarchiveMenus, bulkUpdateItems, bulkUpdateMenus, bulkUpdateSections, createDish, createDraftCatalog, createMenu, createSection, createVariation, discardDraftCatalog, getItem, getMenu, getSection, listCatalogs, listItems, listMenus, listSections, publishDraftCatalog, unarchiveMenu, updateItem, updateMenu, updateSection };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-iot-devices-backend.d.ts", "content": "declare module \"wix-iot-devices-backend\" {\n interface Device {\n /** @readonly */\n deviceId?: string;\n /** @readonly */\n gatewayId?: string;\n title?: string;\n iconUrl?: string;\n gatewayDeviceId?: string;\n entities?: Entity[];\n }\n interface Entity extends EntityKindOneOf {\n entityId?: string;\n thermometer?: Thermometer;\n switch?: Switch;\n presenceSensor?: PresenceSensor;\n }\n /** @oneof */\n interface EntityKindOneOf {\n thermometer?: Thermometer;\n switch?: Switch;\n presenceSensor?: PresenceSensor;\n }\n interface Thermometer {\n temperature?: number;\n }\n interface Switch {\n on?: boolean;\n }\n interface PresenceSensor {\n present?: boolean;\n }\n interface ListDevicesResponse {\n devices?: Device[];\n }\n interface AddDeviceResponse {\n device?: Device;\n }\n interface RemoveDeviceResponse {\n }\n interface ListDiscoveredDevicesResponse {\n devices?: Device[];\n }\n interface SetDeviceStateResponse {\n device?: Device;\n }\n interface TestResponse {\n }\n interface AddDeviceOptions {\n deviceId?: string | null;\n gatewayDeviceId?: string;\n gatewayId?: string;\n title?: string;\n }\n interface SetDeviceStateOptions {\n deviceId?: string;\n switch?: Switch;\n }\n \n function listDevices(): Promise;\n function addDevice(options?: AddDeviceOptions): Promise;\n function removeDevice(deviceId: string): Promise;\n function listDiscoveredDevices(): Promise;\n function setDeviceState(options?: SetDeviceStateOptions): Promise;\n function test(): Promise;\n \n const iotV1Device_backend_d_listDevices: typeof listDevices;\n const iotV1Device_backend_d_addDevice: typeof addDevice;\n const iotV1Device_backend_d_removeDevice: typeof removeDevice;\n const iotV1Device_backend_d_listDiscoveredDevices: typeof listDiscoveredDevices;\n const iotV1Device_backend_d_setDeviceState: typeof setDeviceState;\n const iotV1Device_backend_d_test: typeof test;\n namespace iotV1Device_backend_d {\n export {\n iotV1Device_backend_d_listDevices as listDevices,\n iotV1Device_backend_d_addDevice as addDevice,\n iotV1Device_backend_d_removeDevice as removeDevice,\n iotV1Device_backend_d_listDiscoveredDevices as listDiscoveredDevices,\n iotV1Device_backend_d_setDeviceState as setDeviceState,\n iotV1Device_backend_d_test as test,\n };\n }\n \n export { iotV1Device_backend_d as state };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-showoff-backend.d.ts", "content": "declare module \"wix-showoff-backend\" {\n /** TopWebsites is the main entity of ShowOff that can be used for lorem ipsum dolor */\n interface TopWebsites {\n websiteLists?: Websites[];\n }\n interface Websites {\n criteria?: Criteria;\n websites?: Website[];\n }\n enum Criteria {\n UNKNOWN_KEY = \"UNKNOWN_KEY\",\n LOCALE = \"LOCALE\",\n TOP_IN_GOOGLE = \"TOP_IN_GOOGLE\",\n GLOBAL = \"GLOBAL\",\n BEST_LOOKING = \"BEST_LOOKING\",\n TRAFFIC = \"TRAFFIC\"\n }\n interface Website {\n metaSiteId?: string | null;\n /** [(.wix.api.format) = URI]; */\n link?: string | null;\n /** [(.wix.api.format) = URI]; */\n preview?: string | null;\n score?: number | null;\n }\n interface GetTopWebsitesResponse {\n /** The retrieved TopWebsites */\n topWebsites?: TopWebsites;\n }\n interface OptOutResponse {\n }\n interface GetTopWebsitesOptions {\n language: string | null;\n }\n \n function getTopWebsites(structureId: string | null, countryCode: string | null, options: GetTopWebsitesOptions): Promise;\n function optOut(metaSiteId: string): Promise;\n \n const showoffV1TopWebsites_backend_d_getTopWebsites: typeof getTopWebsites;\n const showoffV1TopWebsites_backend_d_optOut: typeof optOut;\n namespace showoffV1TopWebsites_backend_d {\n export {\n showoffV1TopWebsites_backend_d_getTopWebsites as getTopWebsites,\n showoffV1TopWebsites_backend_d_optOut as optOut,\n };\n }\n \n export { showoffV1TopWebsites_backend_d as wixShowoff };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-portfolio-backend.d.ts", "content": "declare module \"wix-portfolio-backend\" {\n interface Collection {\n /**\n * Collection ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.\n * @readonly\n */\n revision?: string | null;\n /** Collection title. */\n title?: string | null;\n /** Collection description. */\n description?: string | null;\n /** Collection slug. */\n slug?: string | null;\n /** Collection cover image. */\n coverImage?: CommonImage$2;\n /** Whether the collection is hidden from the portfolio. Default: `false` */\n hidden?: boolean | null;\n /**\n * Index that determines which position a collection is displayed in the portfolio.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n */\n sortOrder?: number | null;\n /**\n * Date and time the collection was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the collection was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Collection page URL and and relative path. Returned when `includePageUrl` is `true` in the request.\n * @readonly\n */\n url?: string;\n /** Collection SEO data. */\n seoData?: SeoSchema$2;\n }\n interface CommonImage$2 {\n /**\n * @internal\n * @deprecated\n */\n type?: ImageImageType$2;\n /** Information about the Wix Media image. */\n imageInfo?: string;\n /** Focal point of the image. */\n focalPoint?: CommonPoint$2;\n /**\n * Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif).\n * @internal\n */\n exif?: Record | null;\n /**\n * Image compression level.
\n *\n * Min: `30`
\n * Max: `100`\n * @internal\n */\n quality?: number | null;\n /**\n * [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image.\n * @internal\n */\n unsharpMasking?: CommonUnsharpMasking$2;\n /**\n * Whether the image is saved in secure media.\n * @internal\n */\n secure?: boolean | null;\n /**\n * When image is saved in secure media, token is generated.\n * @internal\n * @readonly\n */\n token?: string | null;\n }\n enum ImageImageType$2 {\n UNDEFINED = \"UNDEFINED\",\n WIX_MEDIA = \"WIX_MEDIA\",\n EXTERNAL = \"EXTERNAL\"\n }\n interface CommonPoint$2 {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n }\n interface CommonUnsharpMasking$2 {\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 /**\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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$5 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\n }\n interface Empty$3 {\n }\n interface AdminRemoveMenuItemsResponse {\n /** number of items queried for deletion */\n numItems?: number;\n /** number of items sucessfully deleted */\n numItemsSuccessfullyDeleted?: number;\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 InvalidateCache$2 extends InvalidateCacheGetByOneOf$2 {\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$2;\n /** Invalidate by page id */\n page?: Page$2;\n /** Invalidate by URI path */\n uri?: URI$2;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$2;\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$2 {\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$2;\n /** Invalidate by page id */\n page?: Page$2;\n /** Invalidate by URI path */\n uri?: URI$2;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$2;\n }\n interface App$2 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$2 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$2 {\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$2 {\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 CreateCollectionRequest {\n /** Collection to create. */\n collection: Collection;\n }\n interface CreateCollectionResponse {\n /** Created collection. */\n collection?: Collection;\n }\n interface GetCollectionRequest {\n /** ID of the collection to retrieve. */\n collectionId: string;\n /** Whether to include the collection's page URL and relative path in the response. Default: `false` */\n includePageUrl?: boolean | null;\n }\n interface GetCollectionResponse {\n /** The requested collection. */\n collection?: Collection;\n }\n interface ListCollectionsRequest {\n paging?: CursorPaging$4;\n /** Whether to include the collection's page URL and relative path in the response. Default: `false` */\n includePageUrl?: boolean | 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 ListCollectionsResponse {\n /** List of collections. */\n collections?: Collection[];\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n pagingMetadataV2?: PagingMetadataV2$4;\n /** Paging metadata. */\n metadata?: 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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 UpdateCollectionRequest {\n /** Collection to update. */\n collection: Collection;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateCollectionResponse {\n /** Updated collection. */\n collection?: Collection;\n }\n interface DeleteCollectionRequest {\n /** ID of the collection to delete. */\n collectionId: string;\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n revision?: string;\n }\n interface DeleteCollectionResponse {\n /** ID of the deleted collection. */\n collectionId?: string;\n }\n interface QueryCollectionsRequest {\n /** Query options. */\n query: QueryV2$3;\n /** Whether to include the collection's page URL and relative path in the response. Default: `false` */\n includePageUrl?: boolean | null;\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$4;\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 /** 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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryCollectionsResponse {\n /** List of collections. */\n collections?: Collection[];\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n pagingMetadataV2?: PagingMetadataV2$4;\n /** Paging metadata. */\n metadata?: PagingMetadataV2$4;\n }\n /** @internal\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.PROJECT_CREATE\n * @adminMethod\n */\n function adminRemoveMenuItems(): Promise;\n /**\n * Creates a collection.\n * @param collection - Collection to create.\n * @public\n * @documentationMaturity preview\n * @requiredField collection\n * @permissionId PORTFOLIO.COLLECTION_CREATE\n * @adminMethod\n * @returns Created collection.\n */\n function createCollection(collection: Collection): Promise;\n /**\n * Retrieves a collection.\n * @param collectionId - ID of the collection to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField collectionId\n * @permissionId PORTFOLIO.COLLECTION_READ\n * @returns The requested collection.\n */\n function getCollection(collectionId: string, options?: GetCollectionOptions): Promise;\n interface GetCollectionOptions {\n /** Whether to include the collection's page URL and relative path in the response. Default: `false` */\n includePageUrl?: boolean | null;\n }\n /**\n * Retrieves a list all collections in a portfolio.\n * @public\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.COLLECTION_READ\n */\n function listCollections(options?: ListCollectionsOptions): Promise;\n interface ListCollectionsOptions {\n paging?: CursorPaging$4;\n /** Whether to include the collection's page URL and relative path in the response. Default: `false` */\n includePageUrl?: boolean | null;\n }\n /**\n * Updates a collection.\n * @param _id - Collection ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField collection\n * @requiredField collection.revision\n * @permissionId PORTFOLIO.COLLECTION_UPDATE\n * @adminMethod\n * @returns Updated collection.\n */\n function updateCollection(_id: string | null, collection: UpdateCollection, options?: UpdateCollectionOptions): Promise;\n interface UpdateCollection {\n /**\n * Collection ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.\n * @readonly\n */\n revision?: string | null;\n /** Collection title. */\n title?: string | null;\n /** Collection description. */\n description?: string | null;\n /** Collection slug. */\n slug?: string | null;\n /** Collection cover image. */\n coverImage?: CommonImage$2;\n /** Whether the collection is hidden from the portfolio. Default: `false` */\n hidden?: boolean | null;\n /**\n * Index that determines which position a collection is displayed in the portfolio.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n */\n sortOrder?: number | null;\n /**\n * Date and time the collection was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the collection was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Collection page URL and and relative path. Returned when `includePageUrl` is `true` in the request.\n * @readonly\n */\n url?: string;\n /** Collection SEO data. */\n seoData?: SeoSchema$2;\n }\n interface UpdateCollectionOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a collection.\n * @param collectionId - ID of the collection to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField collectionId\n * @permissionId PORTFOLIO.COLLECTION_DELETE\n * @adminMethod\n */\n function deleteCollection(collectionId: string, options?: DeleteCollectionOptions): Promise;\n interface DeleteCollectionOptions {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n revision?: string;\n }\n /**\n * Retrieves a list of collections given the provided paging, filtering, and sorting. Up to 100 collections can be returned per request.\n *\n * The default `sort` is `id` in `ASC`.\n *\n * For a detailed list of supported operations, see [Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/collections/sort-and-filter).\n * To learn how to query collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.COLLECTION_READ\n */\n function queryCollections(options?: QueryCollectionsOptions): CollectionsQueryBuilder;\n interface QueryCollectionsOptions {\n /** Whether to include the collection's page URL and relative path in the response. Default: `false` */\n includePageUrl?: boolean | null | 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 CollectionsQueryResult extends QueryCursorResult$2 {\n items: Collection[];\n query: CollectionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CollectionsQueryBuilder {\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' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\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' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\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' | 'title' | 'description' | 'slug', value: string) => CollectionsQueryBuilder;\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' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any[]) => CollectionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: any) => CollectionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'title' | 'description' | 'slug' | 'hidden' | 'sortOrder' | '_createdDate' | '_updatedDate', value: boolean) => CollectionsQueryBuilder;\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' | 'title' | 'description' | 'slug' | 'sortOrder' | '_createdDate' | '_updatedDate'>) => CollectionsQueryBuilder;\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' | 'title' | 'description' | 'slug' | 'sortOrder' | '_createdDate' | '_updatedDate'>) => CollectionsQueryBuilder;\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) => CollectionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => CollectionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n type portfolioCollectionsV1Collection_universal_d_Collection = Collection;\n type portfolioCollectionsV1Collection_universal_d_AdminRemoveMenuItemsResponse = AdminRemoveMenuItemsResponse;\n type portfolioCollectionsV1Collection_universal_d_CreateCollectionRequest = CreateCollectionRequest;\n type portfolioCollectionsV1Collection_universal_d_CreateCollectionResponse = CreateCollectionResponse;\n type portfolioCollectionsV1Collection_universal_d_GetCollectionRequest = GetCollectionRequest;\n type portfolioCollectionsV1Collection_universal_d_GetCollectionResponse = GetCollectionResponse;\n type portfolioCollectionsV1Collection_universal_d_ListCollectionsRequest = ListCollectionsRequest;\n type portfolioCollectionsV1Collection_universal_d_ListCollectionsResponse = ListCollectionsResponse;\n type portfolioCollectionsV1Collection_universal_d_UpdateCollectionRequest = UpdateCollectionRequest;\n type portfolioCollectionsV1Collection_universal_d_UpdateCollectionResponse = UpdateCollectionResponse;\n type portfolioCollectionsV1Collection_universal_d_DeleteCollectionRequest = DeleteCollectionRequest;\n type portfolioCollectionsV1Collection_universal_d_DeleteCollectionResponse = DeleteCollectionResponse;\n type portfolioCollectionsV1Collection_universal_d_QueryCollectionsRequest = QueryCollectionsRequest;\n type portfolioCollectionsV1Collection_universal_d_QueryCollectionsResponse = QueryCollectionsResponse;\n const portfolioCollectionsV1Collection_universal_d_adminRemoveMenuItems: typeof adminRemoveMenuItems;\n const portfolioCollectionsV1Collection_universal_d_createCollection: typeof createCollection;\n const portfolioCollectionsV1Collection_universal_d_getCollection: typeof getCollection;\n type portfolioCollectionsV1Collection_universal_d_GetCollectionOptions = GetCollectionOptions;\n const portfolioCollectionsV1Collection_universal_d_listCollections: typeof listCollections;\n type portfolioCollectionsV1Collection_universal_d_ListCollectionsOptions = ListCollectionsOptions;\n const portfolioCollectionsV1Collection_universal_d_updateCollection: typeof updateCollection;\n type portfolioCollectionsV1Collection_universal_d_UpdateCollection = UpdateCollection;\n type portfolioCollectionsV1Collection_universal_d_UpdateCollectionOptions = UpdateCollectionOptions;\n const portfolioCollectionsV1Collection_universal_d_deleteCollection: typeof deleteCollection;\n type portfolioCollectionsV1Collection_universal_d_DeleteCollectionOptions = DeleteCollectionOptions;\n const portfolioCollectionsV1Collection_universal_d_queryCollections: typeof queryCollections;\n type portfolioCollectionsV1Collection_universal_d_QueryCollectionsOptions = QueryCollectionsOptions;\n type portfolioCollectionsV1Collection_universal_d_CollectionsQueryResult = CollectionsQueryResult;\n type portfolioCollectionsV1Collection_universal_d_CollectionsQueryBuilder = CollectionsQueryBuilder;\n namespace portfolioCollectionsV1Collection_universal_d {\n export {\n portfolioCollectionsV1Collection_universal_d_Collection as Collection,\n CommonImage$2 as CommonImage,\n ImageImageType$2 as ImageImageType,\n CommonPoint$2 as CommonPoint,\n CommonUnsharpMasking$2 as CommonUnsharpMasking,\n SeoSchema$2 as SeoSchema,\n Keyword$2 as Keyword,\n Tag$2 as Tag,\n Settings$2 as Settings,\n DomainEvent$5 as DomainEvent,\n DomainEventBodyOneOf$5 as DomainEventBodyOneOf,\n EntityCreatedEvent$5 as EntityCreatedEvent,\n RestoreInfo$5 as RestoreInfo,\n EntityUpdatedEvent$5 as EntityUpdatedEvent,\n EntityDeletedEvent$5 as EntityDeletedEvent,\n ActionEvent$5 as ActionEvent,\n Empty$3 as Empty,\n portfolioCollectionsV1Collection_universal_d_AdminRemoveMenuItemsResponse as AdminRemoveMenuItemsResponse,\n MessageEnvelope$5 as MessageEnvelope,\n IdentificationData$5 as IdentificationData,\n IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf,\n WebhookIdentityType$5 as WebhookIdentityType,\n InvalidateCache$2 as InvalidateCache,\n InvalidateCacheGetByOneOf$2 as InvalidateCacheGetByOneOf,\n App$2 as App,\n Page$2 as Page,\n URI$2 as URI,\n File$2 as File,\n portfolioCollectionsV1Collection_universal_d_CreateCollectionRequest as CreateCollectionRequest,\n portfolioCollectionsV1Collection_universal_d_CreateCollectionResponse as CreateCollectionResponse,\n portfolioCollectionsV1Collection_universal_d_GetCollectionRequest as GetCollectionRequest,\n portfolioCollectionsV1Collection_universal_d_GetCollectionResponse as GetCollectionResponse,\n portfolioCollectionsV1Collection_universal_d_ListCollectionsRequest as ListCollectionsRequest,\n CursorPaging$4 as CursorPaging,\n portfolioCollectionsV1Collection_universal_d_ListCollectionsResponse as ListCollectionsResponse,\n PagingMetadataV2$4 as PagingMetadataV2,\n Cursors$4 as Cursors,\n portfolioCollectionsV1Collection_universal_d_UpdateCollectionRequest as UpdateCollectionRequest,\n portfolioCollectionsV1Collection_universal_d_UpdateCollectionResponse as UpdateCollectionResponse,\n portfolioCollectionsV1Collection_universal_d_DeleteCollectionRequest as DeleteCollectionRequest,\n portfolioCollectionsV1Collection_universal_d_DeleteCollectionResponse as DeleteCollectionResponse,\n portfolioCollectionsV1Collection_universal_d_QueryCollectionsRequest as QueryCollectionsRequest,\n QueryV2$3 as QueryV2,\n QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n Paging$3 as Paging,\n portfolioCollectionsV1Collection_universal_d_QueryCollectionsResponse as QueryCollectionsResponse,\n portfolioCollectionsV1Collection_universal_d_adminRemoveMenuItems as adminRemoveMenuItems,\n portfolioCollectionsV1Collection_universal_d_createCollection as createCollection,\n portfolioCollectionsV1Collection_universal_d_getCollection as getCollection,\n portfolioCollectionsV1Collection_universal_d_GetCollectionOptions as GetCollectionOptions,\n portfolioCollectionsV1Collection_universal_d_listCollections as listCollections,\n portfolioCollectionsV1Collection_universal_d_ListCollectionsOptions as ListCollectionsOptions,\n portfolioCollectionsV1Collection_universal_d_updateCollection as updateCollection,\n portfolioCollectionsV1Collection_universal_d_UpdateCollection as UpdateCollection,\n portfolioCollectionsV1Collection_universal_d_UpdateCollectionOptions as UpdateCollectionOptions,\n portfolioCollectionsV1Collection_universal_d_deleteCollection as deleteCollection,\n portfolioCollectionsV1Collection_universal_d_DeleteCollectionOptions as DeleteCollectionOptions,\n portfolioCollectionsV1Collection_universal_d_queryCollections as queryCollections,\n portfolioCollectionsV1Collection_universal_d_QueryCollectionsOptions as QueryCollectionsOptions,\n portfolioCollectionsV1Collection_universal_d_CollectionsQueryResult as CollectionsQueryResult,\n portfolioCollectionsV1Collection_universal_d_CollectionsQueryBuilder as CollectionsQueryBuilder,\n };\n }\n \n interface PortfolioSettings {\n /**\n * Revision number. Increments by 1 each time the portfolio settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the portfolio settings object.\n * @readonly\n */\n revision?: string | null;\n /** Portfolio's project item settings. */\n projectItemSettings?: ProjectItemSettings;\n /** Portfolio's media settings. */\n mediaSettings?: MediaSettings;\n /**\n * The site menu settings\n * @internal\n */\n siteMenuSettings?: SiteMenuSettings;\n /**\n * Date and time the portfolio settings were created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the portfolio settings were updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n interface ProjectItemSettings {\n /** The direction in which to add new project items to a gallery. Default: `GALLERY_START` */\n addItemDirection?: AddItemDirection;\n /** Default title assigned to a project item if no title is provided. Default: `FILE_NAME` */\n defaultItemName?: DefaultItemName;\n }\n enum AddItemDirection {\n /** Add new project items to the beginning of the gallery. */\n GALLERY_START = \"GALLERY_START\",\n /** Add new project items to the end of the gallery. */\n GALLERY_END = \"GALLERY_END\"\n }\n enum DefaultItemName {\n /** File name assigned as the title. */\n FILE_NAME = \"FILE_NAME\",\n /** No title assigned. */\n EMPTY = \"EMPTY\"\n }\n interface MediaSettings {\n /** ID of the folder containing the media. */\n folderId?: string | null;\n }\n interface SiteMenuSettings {\n /** Whether to automatically update the site menu */\n autoUpdateMenu?: boolean | null;\n }\n interface CreatePortfolioSettingsRequest {\n /** The portfolio settings to create. */\n portfolioSettings: PortfolioSettings;\n }\n interface CreatePortfolioSettingsResponse {\n /** Newly created portfolio settings. */\n portfolioSettings?: PortfolioSettings;\n }\n interface GetPortfolioSettingsRequest {\n }\n interface GetPortfolioSettingsResponse {\n /** Portfolio settings. */\n portfolioSettings?: PortfolioSettings;\n }\n interface UpdatePortfolioSettingsRequest {\n /** The portfolio settings to update. */\n portfolioSettings: PortfolioSettings;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdatePortfolioSettingsResponse {\n /** Updated portfolio settings. */\n updatedPortfolioSettings?: PortfolioSettings;\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Creates a site's portfolio settings.\n *\n * > **Note:**\n * >\n * > This method is intended for creating portfolio settings. If settings already exist, the request will return an error. To update existing settings, call [Update Portfolio Settings](https://dev.wix.com/docs/rest/business-solutions/portfolio/portfolio-settings/update-portfolio-settings).\n * @param portfolioSettings - The portfolio settings to create.\n * @public\n * @documentationMaturity preview\n * @requiredField portfolioSettings\n * @requiredField portfolioSettings.projectItemSettings\n * @permissionId PORTFOLIO.SETTINGS_CREATE\n * @adminMethod\n * @returns Newly created portfolio settings.\n */\n function createPortfolioSettings(portfolioSettings: PortfolioSettings): Promise;\n /**\n * Retrieves a site's portfolio settings.\n * @public\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.SETTINGS_READ\n * @adminMethod\n */\n function getPortfolioSettings(): Promise;\n /**\n * Updates a site's portfolio settings.\n * @param portfolioSettings - The portfolio settings to update.\n * @public\n * @documentationMaturity preview\n * @requiredField portfolioSettings\n * @requiredField portfolioSettings.revision\n * @permissionId PORTFOLIO.SETTINGS_UPDATE\n * @adminMethod\n */\n function updatePortfolioSettings(portfolioSettings: PortfolioSettings, options?: UpdatePortfolioSettingsOptions): Promise;\n interface UpdatePortfolioSettingsOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n \n type portfolioPortfolioAppV1PortfolioSettings_universal_d_PortfolioSettings = PortfolioSettings;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_ProjectItemSettings = ProjectItemSettings;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_AddItemDirection = AddItemDirection;\n const portfolioPortfolioAppV1PortfolioSettings_universal_d_AddItemDirection: typeof AddItemDirection;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_DefaultItemName = DefaultItemName;\n const portfolioPortfolioAppV1PortfolioSettings_universal_d_DefaultItemName: typeof DefaultItemName;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_MediaSettings = MediaSettings;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_SiteMenuSettings = SiteMenuSettings;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_CreatePortfolioSettingsRequest = CreatePortfolioSettingsRequest;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_CreatePortfolioSettingsResponse = CreatePortfolioSettingsResponse;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_GetPortfolioSettingsRequest = GetPortfolioSettingsRequest;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_GetPortfolioSettingsResponse = GetPortfolioSettingsResponse;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_UpdatePortfolioSettingsRequest = UpdatePortfolioSettingsRequest;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_UpdatePortfolioSettingsResponse = UpdatePortfolioSettingsResponse;\n const portfolioPortfolioAppV1PortfolioSettings_universal_d_createPortfolioSettings: typeof createPortfolioSettings;\n const portfolioPortfolioAppV1PortfolioSettings_universal_d_getPortfolioSettings: typeof getPortfolioSettings;\n const portfolioPortfolioAppV1PortfolioSettings_universal_d_updatePortfolioSettings: typeof updatePortfolioSettings;\n type portfolioPortfolioAppV1PortfolioSettings_universal_d_UpdatePortfolioSettingsOptions = UpdatePortfolioSettingsOptions;\n namespace portfolioPortfolioAppV1PortfolioSettings_universal_d {\n export {\n portfolioPortfolioAppV1PortfolioSettings_universal_d_PortfolioSettings as PortfolioSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_ProjectItemSettings as ProjectItemSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_AddItemDirection as AddItemDirection,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_DefaultItemName as DefaultItemName,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_MediaSettings as MediaSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_SiteMenuSettings as SiteMenuSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_CreatePortfolioSettingsRequest as CreatePortfolioSettingsRequest,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_CreatePortfolioSettingsResponse as CreatePortfolioSettingsResponse,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_GetPortfolioSettingsRequest as GetPortfolioSettingsRequest,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_GetPortfolioSettingsResponse as GetPortfolioSettingsResponse,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_UpdatePortfolioSettingsRequest as UpdatePortfolioSettingsRequest,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_UpdatePortfolioSettingsResponse as UpdatePortfolioSettingsResponse,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_createPortfolioSettings as createPortfolioSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_getPortfolioSettings as getPortfolioSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_updatePortfolioSettings as updatePortfolioSettings,\n portfolioPortfolioAppV1PortfolioSettings_universal_d_UpdatePortfolioSettingsOptions as UpdatePortfolioSettingsOptions,\n };\n }\n \n interface ProjectitemsItem extends ProjectitemsItemMetadataOneOf {\n /** Information about the Wix Media image. */\n image?: CommonImage$1;\n /** Information about the Wix Media video. */\n video?: CommonVideo;\n /** Project ID. */\n projectId?: string | null;\n /**\n * Project item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Index that determines which position a project is displayed in the project.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n */\n sortOrder?: number | null;\n /** Project item title. */\n title?: string | null;\n /** Project item description. */\n description?: string | null;\n /**\n * Project item data type.\n * @readonly\n */\n type?: ItemType;\n /**\n * Date and time the project item was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the project item was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Project item tags.\n * @internal\n */\n tags?: ProjectitemsTags;\n /** Project item link. */\n link?: Link;\n }\n /** @oneof */\n interface ProjectitemsItemMetadataOneOf {\n /** Information about the Wix Media image. */\n image?: CommonImage$1;\n /** Information about the Wix Media video. */\n video?: CommonVideo;\n }\n enum ItemType {\n /** Undefined item type. */\n UNDEFINED = \"UNDEFINED\",\n /** Image item type. */\n IMAGE = \"IMAGE\",\n /** Video item type. */\n VIDEO = \"VIDEO\"\n }\n interface CommonImage$1 {\n /**\n * @internal\n * @deprecated\n */\n type?: ImageImageType$1;\n /** Information about the Wix Media image. */\n imageInfo?: string;\n /** Focal point of the image. */\n focalPoint?: CommonPoint$1;\n /**\n * Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif).\n * @internal\n */\n exif?: Record | null;\n /**\n * Image compression level.
\n *\n * Min: `30`
\n * Max: `100`\n * @internal\n */\n quality?: number | null;\n /**\n * [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image.\n * @internal\n */\n unsharpMasking?: CommonUnsharpMasking$1;\n /**\n * Whether the image is saved in secure media.\n * @internal\n */\n secure?: boolean | null;\n /**\n * When image is saved in secure media, token is generated.\n * @internal\n * @readonly\n */\n token?: string | null;\n }\n enum ImageImageType$1 {\n UNDEFINED = \"UNDEFINED\",\n WIX_MEDIA = \"WIX_MEDIA\",\n EXTERNAL = \"EXTERNAL\"\n }\n interface CommonPoint$1 {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n }\n interface CommonUnsharpMasking$1 {\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 CommonVideo {\n /** Information about the Wix Media video. */\n videoInfo?: string;\n /** Manually defined Video duration in milliseconds. */\n durationInMillis?: number | null;\n }\n interface CommonVideoResolution {\n /** Video URL. Required. */\n url?: string;\n /** Video height. Required. */\n height?: number;\n /** Video width. Required. */\n width?: number;\n /**\n * Video poster. Deprecated, please use the `posters` property in the parent entity\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. Required. */\n format?: string;\n /** Video quality for example 480p, 720p. */\n quality?: string | null;\n /** Video filename. */\n filename?: string | null;\n }\n interface ProjectitemsTags {\n /** List of tags assigned to the media item. */\n values?: string[];\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 * Whether the link opens in a new tab or window. One of:\n * * `'_blank'`: The link opens in a new tab or window.\n * * `'_self'`: The link opens in the same tab or window.\n */\n target?: string | null;\n }\n interface GenerateTokenForProjectItemsRequest {\n /** Media ids of requested project items */\n mediaIds: string[];\n }\n interface GenerateTokenForProjectItemsResponse {\n /** Generated media tokens for project items */\n mediaTokens?: ProjectItemMediaToken[];\n }\n interface ProjectItemMediaToken {\n /** Media id of project item */\n mediaId?: string;\n /** Generated media token for project item */\n mediaToken?: 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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 InvalidateCache$1 extends InvalidateCacheGetByOneOf$1 {\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$1;\n /** Invalidate by URI path */\n uri?: URI$1;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$1;\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$1 {\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$1;\n /** Invalidate by URI path */\n uri?: URI$1;\n /** Invalidate by file (for media files such as PDFs) */\n file?: File$1;\n }\n interface App$1 {\n /** The AppDefId */\n appDefId?: string;\n /** The instance Id */\n instanceId?: string;\n }\n interface Page$1 {\n /** the msid the page is on */\n metaSiteId?: string;\n /** Invalidate by Page ID */\n pageId?: string;\n }\n interface URI$1 {\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$1 {\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 CreateProjectItemRequest {\n /** Project item to create. */\n item: ProjectitemsItem;\n }\n interface CreateProjectItemResponse {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n /** Newly created project item. */\n item?: ProjectitemsItem;\n }\n interface BulkCreateProjectItemsRequest {\n /**\n * Project ID.\n * @internal\n */\n projectId: string;\n /** Project items to create. */\n items: ProjectitemsItem[];\n /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */\n returnFullEntity?: boolean | null;\n }\n interface BulkCreateProjectItemsResponse {\n /**\n * Project ID.\n * @internal\n */\n projectId?: string;\n /** Project items created by bulk action. */\n results?: BulkCreateProjectItemResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkCreateProjectItemResult {\n /** Information about successful action or error for failure. */\n itemMetadata?: ItemMetadata$1;\n /** Newly created project item. */\n item?: ProjectitemsItem;\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 GetProjectItemRequest {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n /** Project item ID. */\n itemId: string;\n }\n interface GetProjectItemResponse {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n /** Project item. */\n item?: ProjectitemsItem;\n }\n interface ListProjectItemsRequest {\n /** Project ID. */\n projectId: string;\n /** Maximum number of items to return in the results. */\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 ListProjectItemsResponse {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n /** Project items. */\n items?: ProjectitemsItem[];\n /**\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n pagingMetadataV2?: PagingMetadataV2$3;\n /** Paging metadata. */\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 * 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 * @internal\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 QueryProjectItemsRequest {\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$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$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$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$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$3;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$2 {\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 QueryProjectItemsResponse {\n /** Project items. */\n items?: ProjectitemsItem[];\n /** Paging metadata. */\n metadata?: PagingMetadataV2$3;\n }\n interface UpdateProjectItemRequest {\n /** The project item to update. */\n item: ProjectitemsItem;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateProjectItemResponse {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n /** The updated project item. */\n item?: ProjectitemsItem;\n }\n interface BulkUpdateProjectItemsRequest {\n /**\n * Project ID.\n * @internal\n */\n projectId: string;\n /** items to be updated. */\n items?: MaskedItem[];\n /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */\n returnFullEntity?: boolean | null;\n }\n interface MaskedItem {\n /** Item to be updated. */\n item?: ProjectitemsItem;\n /**\n * Fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateProjectItemsResponse {\n /**\n * Project ID.\n * @internal\n */\n projectId?: string;\n /** Project items updated by bulk action. */\n results?: BulkUpdateProjectItemResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkUpdateProjectItemResult {\n /** Information about successful action or error for failure. */\n itemMetadata?: ItemMetadata$1;\n /** Updated project item. */\n item?: ProjectitemsItem;\n }\n interface DeleteProjectItemRequest {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n /** ID of the project item to delete. */\n itemId: string;\n }\n interface DeleteProjectItemResponse {\n /** Project ID. */\n projectId?: string;\n /** ID of the deleted project item. */\n itemId?: string;\n }\n interface BulkDeleteProjectItemsRequest {\n /**\n * Project ID.\n * @internal\n */\n projectId: string;\n /** Project item IDs. */\n itemIds: string[];\n }\n interface BulkDeleteProjectItemsResponse {\n /**\n * Project ID.\n * @internal\n */\n projectId?: string;\n /** Project items deleted by bulk action. */\n results?: BulkDeleteProjectItemResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkDeleteProjectItemResult {\n /** Information about successful action or error for failure. */\n itemMetadata?: ItemMetadata$1;\n /** Project item ID. */\n itemId?: string;\n }\n interface CreateProjectGalleryRequest {\n /** Id of Project to create */\n projectId?: string;\n }\n interface CreateProjectGalleryResponse {\n /** Id of created Project */\n projectId?: string;\n /** Id of created gallery */\n galleryId?: string;\n }\n interface Empty$2 {\n }\n interface DeletedProjectRestored$1 {\n /** the id of the project that was restored */\n projectId?: string;\n /** timestamp for when the project was originally deleted. */\n deletionTimestamp?: Date | null;\n }\n interface DuplicateProjectItemsRequest {\n /** ID of the project containing the items to duplicate. */\n originProjectId: string;\n /** ID of the project where the duplicated items will be added. */\n targetProjectId: string;\n }\n interface DuplicateProjectItemsResponse {\n /** Project ID where the duplicated items have been added. */\n projectId?: string;\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n /**\n * Generate media token for project items\n * @param mediaIds - Media ids of requested project items\n * @internal\n * @documentationMaturity preview\n * @requiredField mediaIds\n * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE\n * @adminMethod\n */\n function generateTokenForProjectItems(mediaIds: string[]): Promise;\n /**\n * Creates a project item.\n * @param item - Project item to create.\n * @public\n * @documentationMaturity preview\n * @requiredField item\n * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE\n * @adminMethod\n * @returns Newly created project item.\n */\n function createProjectItem(item: ProjectitemsItem): Promise;\n /**\n * Creates multiple project items.\n * @param projectId - Project ID.\n * @public\n * @documentationMaturity preview\n * @requiredField options.items\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE\n * @adminMethod\n */\n function bulkCreateProjectItems(projectId: string, options?: BulkCreateProjectItemsOptions): Promise;\n interface BulkCreateProjectItemsOptions {\n /** Project items to create. */\n items: ProjectitemsItem[];\n /** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */\n returnFullEntity?: boolean | null;\n }\n /**\n * Retrieves a project item.\n * @param itemId - Project item ID.\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId PORTFOLIO.PROJECT_ITEM_READ\n * @returns Project item.\n */\n function getProjectItem(itemId: string, options?: GetProjectItemOptions): Promise;\n interface GetProjectItemOptions {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n }\n /**\n * Retrieves a list of all project items in the specified project.\n * @param projectId - Project ID.\n * @public\n * @documentationMaturity preview\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_ITEM_READ\n */\n function listProjectItems(projectId: string, options?: ListProjectItemsOptions): Promise;\n interface ListProjectItemsOptions {\n /** Maximum number of items to return in the results. */\n paging?: Paging$2;\n }\n /**\n * Query Collections using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * supported only by projectId & id\n * internal usage only - should not be used, created for auto-db-driver only\n * @internal\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.PROJECT_ITEM_READ\n */\n function queryProjectItems(): ItemsQueryBuilder;\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 ItemsQueryResult extends QueryOffsetResult {\n items: ProjectitemsItem[];\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: 'projectId' | '_id', 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: '_id', 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: '_id', value: string) => ItemsQueryBuilder;\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[]) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id', value: any) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id', 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 skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates a project item.\n * @param _id - Project item ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField item\n * @permissionId PORTFOLIO.PROJECT_ITEM_UPDATE\n * @adminMethod\n * @returns The updated project item.\n */\n function updateProjectItem(_id: string | null, item: UpdateProjectItem, options?: UpdateProjectItemOptions): Promise;\n interface UpdateProjectItem {\n /** Information about the Wix Media image. */\n image?: CommonImage$1;\n /** Information about the Wix Media video. */\n video?: CommonVideo;\n /** Project ID. */\n projectId?: string | null;\n /**\n * Project item ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Index that determines which position a project is displayed in the project.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n */\n sortOrder?: number | null;\n /** Project item title. */\n title?: string | null;\n /** Project item description. */\n description?: string | null;\n /**\n * Project item data type.\n * @readonly\n */\n type?: ItemType;\n /**\n * Date and time the project item was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the project item was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Project item tags.\n * @internal\n */\n tags?: ProjectitemsTags;\n /** Project item link. */\n link?: Link;\n }\n interface UpdateProjectItemOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Updates multiple project items.\n * @param projectId - Project ID.\n * @public\n * @documentationMaturity preview\n * @requiredField options.items.item\n * @requiredField options.items.item._id\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_ITEM_UPDATE\n * @adminMethod\n */\n function bulkUpdateProjectItems(projectId: string, options?: BulkUpdateProjectItemsOptions): Promise;\n interface BulkUpdateProjectItemsOptions {\n /** items to be updated. */\n items?: MaskedItem[];\n /** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */\n returnFullEntity?: boolean | null;\n }\n /**\n * Deletes a project item.\n * @param itemId - ID of the project item to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId PORTFOLIO.PROJECT_ITEM_DELETE\n * @adminMethod\n */\n function deleteProjectItem(itemId: string, options?: DeleteProjectItemOptions): Promise;\n interface DeleteProjectItemOptions {\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2025-05-25\n */\n projectId?: string;\n }\n /**\n * Deletes multiple project items.\n * @param projectId - Project ID.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.itemIds\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_ITEM_DELETE\n * @adminMethod\n */\n function bulkDeleteProjectItems(projectId: string, options: BulkDeleteProjectItemsOptions): Promise;\n interface BulkDeleteProjectItemsOptions {\n /** Project item IDs. */\n itemIds: string[];\n }\n /**\n * Duplicates project items from one project (the origin) to another project (the target).\n *\n *
\n * Important:\n *\n * Both the origin and target projects must exist before calling this method.\n *
\n * @param originProjectId - ID of the project containing the items to duplicate.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.targetProjectId\n * @requiredField originProjectId\n * @permissionId PORTFOLIO.PROJECT_ITEM_CREATE\n * @adminMethod\n */\n function duplicateProjectItems(originProjectId: string, options: DuplicateProjectItemsOptions): Promise;\n interface DuplicateProjectItemsOptions {\n /** ID of the project where the duplicated items will be added. */\n targetProjectId: string;\n }\n \n type portfolioProjectItemsV1ProjectItem_universal_d_ProjectitemsItem = ProjectitemsItem;\n type portfolioProjectItemsV1ProjectItem_universal_d_ProjectitemsItemMetadataOneOf = ProjectitemsItemMetadataOneOf;\n type portfolioProjectItemsV1ProjectItem_universal_d_ItemType = ItemType;\n const portfolioProjectItemsV1ProjectItem_universal_d_ItemType: typeof ItemType;\n type portfolioProjectItemsV1ProjectItem_universal_d_CommonVideo = CommonVideo;\n type portfolioProjectItemsV1ProjectItem_universal_d_CommonVideoResolution = CommonVideoResolution;\n type portfolioProjectItemsV1ProjectItem_universal_d_ProjectitemsTags = ProjectitemsTags;\n type portfolioProjectItemsV1ProjectItem_universal_d_Link = Link;\n type portfolioProjectItemsV1ProjectItem_universal_d_GenerateTokenForProjectItemsRequest = GenerateTokenForProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_GenerateTokenForProjectItemsResponse = GenerateTokenForProjectItemsResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_ProjectItemMediaToken = ProjectItemMediaToken;\n type portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectItemRequest = CreateProjectItemRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectItemResponse = CreateProjectItemResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemsRequest = BulkCreateProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemsResponse = BulkCreateProjectItemsResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemResult = BulkCreateProjectItemResult;\n type portfolioProjectItemsV1ProjectItem_universal_d_GetProjectItemRequest = GetProjectItemRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_GetProjectItemResponse = GetProjectItemResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_ListProjectItemsRequest = ListProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_ListProjectItemsResponse = ListProjectItemsResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_QueryProjectItemsRequest = QueryProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_QueryProjectItemsResponse = QueryProjectItemsResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItemRequest = UpdateProjectItemRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItemResponse = UpdateProjectItemResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemsRequest = BulkUpdateProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_MaskedItem = MaskedItem;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemsResponse = BulkUpdateProjectItemsResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemResult = BulkUpdateProjectItemResult;\n type portfolioProjectItemsV1ProjectItem_universal_d_DeleteProjectItemRequest = DeleteProjectItemRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_DeleteProjectItemResponse = DeleteProjectItemResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemsRequest = BulkDeleteProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemsResponse = BulkDeleteProjectItemsResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemResult = BulkDeleteProjectItemResult;\n type portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectGalleryRequest = CreateProjectGalleryRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectGalleryResponse = CreateProjectGalleryResponse;\n type portfolioProjectItemsV1ProjectItem_universal_d_DuplicateProjectItemsRequest = DuplicateProjectItemsRequest;\n type portfolioProjectItemsV1ProjectItem_universal_d_DuplicateProjectItemsResponse = DuplicateProjectItemsResponse;\n const portfolioProjectItemsV1ProjectItem_universal_d_generateTokenForProjectItems: typeof generateTokenForProjectItems;\n const portfolioProjectItemsV1ProjectItem_universal_d_createProjectItem: typeof createProjectItem;\n const portfolioProjectItemsV1ProjectItem_universal_d_bulkCreateProjectItems: typeof bulkCreateProjectItems;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemsOptions = BulkCreateProjectItemsOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_getProjectItem: typeof getProjectItem;\n type portfolioProjectItemsV1ProjectItem_universal_d_GetProjectItemOptions = GetProjectItemOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_listProjectItems: typeof listProjectItems;\n type portfolioProjectItemsV1ProjectItem_universal_d_ListProjectItemsOptions = ListProjectItemsOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_queryProjectItems: typeof queryProjectItems;\n type portfolioProjectItemsV1ProjectItem_universal_d_ItemsQueryResult = ItemsQueryResult;\n type portfolioProjectItemsV1ProjectItem_universal_d_ItemsQueryBuilder = ItemsQueryBuilder;\n const portfolioProjectItemsV1ProjectItem_universal_d_updateProjectItem: typeof updateProjectItem;\n type portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItem = UpdateProjectItem;\n type portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItemOptions = UpdateProjectItemOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_bulkUpdateProjectItems: typeof bulkUpdateProjectItems;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemsOptions = BulkUpdateProjectItemsOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_deleteProjectItem: typeof deleteProjectItem;\n type portfolioProjectItemsV1ProjectItem_universal_d_DeleteProjectItemOptions = DeleteProjectItemOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_bulkDeleteProjectItems: typeof bulkDeleteProjectItems;\n type portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemsOptions = BulkDeleteProjectItemsOptions;\n const portfolioProjectItemsV1ProjectItem_universal_d_duplicateProjectItems: typeof duplicateProjectItems;\n type portfolioProjectItemsV1ProjectItem_universal_d_DuplicateProjectItemsOptions = DuplicateProjectItemsOptions;\n namespace portfolioProjectItemsV1ProjectItem_universal_d {\n export {\n portfolioProjectItemsV1ProjectItem_universal_d_ProjectitemsItem as ProjectitemsItem,\n portfolioProjectItemsV1ProjectItem_universal_d_ProjectitemsItemMetadataOneOf as ProjectitemsItemMetadataOneOf,\n portfolioProjectItemsV1ProjectItem_universal_d_ItemType as ItemType,\n CommonImage$1 as CommonImage,\n ImageImageType$1 as ImageImageType,\n CommonPoint$1 as CommonPoint,\n CommonUnsharpMasking$1 as CommonUnsharpMasking,\n portfolioProjectItemsV1ProjectItem_universal_d_CommonVideo as CommonVideo,\n portfolioProjectItemsV1ProjectItem_universal_d_CommonVideoResolution as CommonVideoResolution,\n portfolioProjectItemsV1ProjectItem_universal_d_ProjectitemsTags as ProjectitemsTags,\n portfolioProjectItemsV1ProjectItem_universal_d_Link as Link,\n portfolioProjectItemsV1ProjectItem_universal_d_GenerateTokenForProjectItemsRequest as GenerateTokenForProjectItemsRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_GenerateTokenForProjectItemsResponse as GenerateTokenForProjectItemsResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_ProjectItemMediaToken as ProjectItemMediaToken,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n InvalidateCache$1 as InvalidateCache,\n InvalidateCacheGetByOneOf$1 as InvalidateCacheGetByOneOf,\n App$1 as App,\n Page$1 as Page,\n URI$1 as URI,\n File$1 as File,\n portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectItemRequest as CreateProjectItemRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectItemResponse as CreateProjectItemResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemsRequest as BulkCreateProjectItemsRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemsResponse as BulkCreateProjectItemsResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemResult as BulkCreateProjectItemResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n portfolioProjectItemsV1ProjectItem_universal_d_GetProjectItemRequest as GetProjectItemRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_GetProjectItemResponse as GetProjectItemResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_ListProjectItemsRequest as ListProjectItemsRequest,\n Paging$2 as Paging,\n portfolioProjectItemsV1ProjectItem_universal_d_ListProjectItemsResponse as ListProjectItemsResponse,\n PagingMetadataV2$3 as PagingMetadataV2,\n Cursors$3 as Cursors,\n portfolioProjectItemsV1ProjectItem_universal_d_QueryProjectItemsRequest as QueryProjectItemsRequest,\n QueryV2$2 as QueryV2,\n QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$3 as CursorPaging,\n portfolioProjectItemsV1ProjectItem_universal_d_QueryProjectItemsResponse as QueryProjectItemsResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItemRequest as UpdateProjectItemRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItemResponse as UpdateProjectItemResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemsRequest as BulkUpdateProjectItemsRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_MaskedItem as MaskedItem,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemsResponse as BulkUpdateProjectItemsResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemResult as BulkUpdateProjectItemResult,\n portfolioProjectItemsV1ProjectItem_universal_d_DeleteProjectItemRequest as DeleteProjectItemRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_DeleteProjectItemResponse as DeleteProjectItemResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemsRequest as BulkDeleteProjectItemsRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemsResponse as BulkDeleteProjectItemsResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemResult as BulkDeleteProjectItemResult,\n portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectGalleryRequest as CreateProjectGalleryRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_CreateProjectGalleryResponse as CreateProjectGalleryResponse,\n Empty$2 as Empty,\n DeletedProjectRestored$1 as DeletedProjectRestored,\n portfolioProjectItemsV1ProjectItem_universal_d_DuplicateProjectItemsRequest as DuplicateProjectItemsRequest,\n portfolioProjectItemsV1ProjectItem_universal_d_DuplicateProjectItemsResponse as DuplicateProjectItemsResponse,\n portfolioProjectItemsV1ProjectItem_universal_d_generateTokenForProjectItems as generateTokenForProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_createProjectItem as createProjectItem,\n portfolioProjectItemsV1ProjectItem_universal_d_bulkCreateProjectItems as bulkCreateProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkCreateProjectItemsOptions as BulkCreateProjectItemsOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_getProjectItem as getProjectItem,\n portfolioProjectItemsV1ProjectItem_universal_d_GetProjectItemOptions as GetProjectItemOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_listProjectItems as listProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_ListProjectItemsOptions as ListProjectItemsOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_queryProjectItems as queryProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_ItemsQueryResult as ItemsQueryResult,\n portfolioProjectItemsV1ProjectItem_universal_d_ItemsQueryBuilder as ItemsQueryBuilder,\n portfolioProjectItemsV1ProjectItem_universal_d_updateProjectItem as updateProjectItem,\n portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItem as UpdateProjectItem,\n portfolioProjectItemsV1ProjectItem_universal_d_UpdateProjectItemOptions as UpdateProjectItemOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_bulkUpdateProjectItems as bulkUpdateProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkUpdateProjectItemsOptions as BulkUpdateProjectItemsOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_deleteProjectItem as deleteProjectItem,\n portfolioProjectItemsV1ProjectItem_universal_d_DeleteProjectItemOptions as DeleteProjectItemOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_bulkDeleteProjectItems as bulkDeleteProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_BulkDeleteProjectItemsOptions as BulkDeleteProjectItemsOptions,\n portfolioProjectItemsV1ProjectItem_universal_d_duplicateProjectItems as duplicateProjectItems,\n portfolioProjectItemsV1ProjectItem_universal_d_DuplicateProjectItemsOptions as DuplicateProjectItemsOptions,\n };\n }\n \n interface Project$1 extends ProjectCoverOneOf$1 {\n /** Project cover image. */\n coverImage?: CommonImage;\n /** Project cover video. */\n coverVideo?: Video$1;\n /**\n * Project ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.\n * @readonly\n */\n revision?: string | null;\n /** Project title. */\n title?: string | null;\n /** Project description. */\n description?: string | null;\n /** Whether the project is hidden from the portfolio. Default: `false` */\n hidden?: boolean | null;\n /** IDs of the collections that include the project. */\n collectionIds?: string[];\n /** Project details. */\n details?: ProjectDetail$1[];\n /** Project slug. */\n slug?: string | null;\n /**\n * Date and time the project was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the project was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * project source - When project is synced from external platform, this field will represent the app & source the projects synced from.\n * @internal\n */\n source?: ProjectSource$1;\n /**\n * Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.\n * @readonly\n */\n url?: string;\n /** Project SEO data. */\n seoData?: SeoSchema$1;\n /**\n * Whether the project is synced to an external platform and will receive daily updates.\n * @internal\n * @readonly\n */\n syncedProject?: boolean | null;\n }\n /** @oneof */\n interface ProjectCoverOneOf$1 {\n /** Project cover image. */\n coverImage?: CommonImage;\n /** Project cover video. */\n coverVideo?: Video$1;\n }\n interface CommonImage {\n /**\n * @internal\n * @deprecated\n */\n type?: ImageImageType;\n /** Information about the Wix Media image. */\n imageInfo?: string;\n /** Focal point of the image. */\n focalPoint?: CommonPoint;\n /**\n * Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif).\n * @internal\n */\n exif?: Record | null;\n /**\n * Image compression level.
\n *\n * Min: `30`
\n * Max: `100`\n * @internal\n */\n quality?: number | null;\n /**\n * [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image.\n * @internal\n */\n unsharpMasking?: CommonUnsharpMasking;\n /**\n * Whether the image is saved in secure media.\n * @internal\n */\n secure?: boolean | null;\n /**\n * When image is saved in secure media, token is generated.\n * @internal\n * @readonly\n */\n token?: string | null;\n }\n enum ImageImageType {\n UNDEFINED = \"UNDEFINED\",\n WIX_MEDIA = \"WIX_MEDIA\",\n EXTERNAL = \"EXTERNAL\"\n }\n interface CommonPoint {\n /** X-coordinate of the focal point. */\n x?: number;\n /** Y-coordinate of the focal point. */\n y?: number;\n }\n interface CommonUnsharpMasking {\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$1 {\n /** Information about the Wix Media video. */\n videoInfo?: string;\n /** Manually defined Video duration in milliseconds. */\n durationInMillis?: number | null;\n }\n interface VideoResolution$1 {\n /** Video URL. Required. */\n url?: string;\n /** Video height. Required. */\n height?: number;\n /** Video width. Required. */\n width?: number;\n /**\n * Video poster. Deprecated, please use the `posters` property in the parent entity\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. Required. */\n format?: string;\n /** Video quality for example 480p, 720p. */\n quality?: string | null;\n /** Video filename. */\n filename?: string | null;\n }\n /**\n * Project label.\n * One of:\n * + `text`\n * + `link`\n */\n interface ProjectDetail$1 extends ProjectDetailValueOneOf$1 {\n /** Project label in plain text format. */\n text?: string;\n /** Project label in link format. */\n link?: DetailsLink$1;\n /** Project label. */\n label?: string;\n }\n /** @oneof */\n interface ProjectDetailValueOneOf$1 {\n /** Project label in plain text format. */\n text?: string;\n /** Project label in link format. */\n link?: DetailsLink$1;\n }\n interface DetailsLink$1 {\n /** Display text of the link. */\n text?: string | null;\n /** Target URL of the link. */\n url?: string | null;\n /**\n * Whether the link opens in a new tab or window. One of:\n * * `'_blank'`: The link opens in a new tab or window.\n * * `'_self'`: The link opens in the same tab or window.\n */\n target?: string | null;\n }\n interface ProjectSource$1 {\n /** App definition id */\n appDefId?: string;\n /** External source id */\n externalId?: string;\n /** Source name */\n sourceName?: string;\n /** Source description */\n description?: string | null;\n /** link to external source */\n link?: string | null;\n /** Sync status */\n syncStatus?: SyncStatus$2;\n /** fields that are synced from external source, should be blocked to update in UI */\n notEditableFields?: string[];\n /** last date the project was synced */\n lastSync?: Date | null;\n }\n enum SyncStatus$2 {\n SYNCED = \"SYNCED\",\n SYNCING = \"SYNCING\",\n NOT_SYNCED = \"NOT_SYNCED\"\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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 MenuSettingUpdatedEvent {\n }\n interface GetProjectPageDataRequest {\n /** Slug of the project's current collection */\n collectionSlug: string;\n /** Project's slug */\n projectSlug: string;\n }\n interface GetProjectPageDataResponse {\n /** Project data */\n project?: Project$1;\n /** Previous project slug */\n previousProject?: ProjectSlug;\n /** Next project slug */\n nextProject?: ProjectSlug;\n }\n interface ProjectSlug {\n /** Project id */\n projectId?: string;\n /** Project slug */\n slug?: string;\n }\n interface CreateNewPortfolioAppRequest {\n }\n interface CreateNewPortfolioAppResponse {\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 /**\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$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 * 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 /** 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 | null;\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 /**\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$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 /** The origin meta site id */\n originMetaSiteId?: 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$1 {\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 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 SyncProjectWithCollectionMappings {\n /** Id of recently updated Project */\n projectId?: string;\n /** fields that were updated in the given project */\n fieldMaskPaths?: string[];\n }\n interface DeletedProjectRestored {\n /** the id of the project that was restored */\n projectId?: string;\n /** timestamp for when the project was originally deleted. */\n deletionTimestamp?: Date | null;\n }\n interface CreateProjectRequest {\n /** Project to create. */\n project: Project$1;\n }\n interface CreateProjectResponse {\n /** Created project. */\n project?: Project$1;\n }\n interface GetProjectRequest {\n /** ID of the project to retrieve. */\n projectId: string;\n /** Whether to include the project's relative path and full URL in the response. Default: `false` */\n includePageUrl?: boolean | null;\n }\n interface GetProjectResponse {\n /** The requested project. */\n project?: Project$1;\n }\n interface ListProjectsRequest {\n /** Projects limit per response is maximum 100, In the first request the cursor is None ? */\n paging?: CursorPaging$2;\n /** Whether to include the project's relative path and full URL in the response. Default: `false` */\n includePageUrl?: boolean | 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 ListProjectsResponse {\n /** List of projects. */\n projects?: Project$1[];\n /**\n * Paging metadata.\n * @internal\n * @deprecated\n */\n pagingMetadataV2?: PagingMetadataV2$2;\n /** Paging 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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 UpdateProjectRequest {\n /** Project to update. */\n project: Project$1;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateProjectResponse {\n /** Updated project. */\n project?: Project$1;\n }\n interface BulkUpdateProjectsRequest {\n /** Projects to update. */\n projects?: MaskedProject[];\n /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */\n returnFullEntity?: boolean | null;\n }\n interface MaskedProject {\n /** Project to update. */\n project?: Project$1;\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateProjectsResponse {\n /** Items created by bulk action. */\n results?: BulkUpdateProjectsResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkUpdateProjectsResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n /** Updated project. */\n project?: Project$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 DeleteProjectRequest {\n /** ID of the project to delete. */\n projectId: string;\n /**\n * The revision of the Project\n * @internal\n * @deprecated\n */\n revision?: string;\n }\n interface DeleteProjectResponse {\n /** ID of the deleted project. */\n projectId?: string;\n }\n interface QueryProjectsRequest {\n /** Query options. */\n query: QueryV2$1;\n /** Whether to include the project's relative path and full URL in the response. Default: `false` */\n includePageUrl?: boolean | null;\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.\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$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$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryProjectsResponse {\n /** List of projects. */\n projects?: Project$1[];\n /**\n * Paging metadata.\n * @internal\n * @deprecated\n */\n pagingMetadataV2?: PagingMetadataV2$2;\n /** Paging metadata. */\n metadata?: PagingMetadataV2$2;\n }\n interface UpdateProjectOrderInCollectionRequest$1 {\n /** ID of the project to update. */\n projectId: string;\n /** Collection ID. */\n collectionId: string;\n /** Index that determines the placement of a project within the collection. */\n sortOrder: number | null;\n }\n interface UpdateProjectOrderInCollectionResponse$1 {\n /**\n * @internal\n * @deprecated\n */\n project?: ProjectsInCollections$1;\n /** Updated project placement within the specified collection. */\n projectInCollection?: ProjectsInCollections$1;\n }\n interface ProjectsInCollections$1 {\n /** Collection ID. */\n collectionId?: string;\n /** Project object. */\n project?: Project$1;\n /**\n * Index that determines the placement of a project within the collection.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n */\n sortOrder?: number | null;\n /**\n * Project placement ID.\n * @readonly\n */\n _id?: string | null;\n }\n interface QueryProjectWithCollectionInfoRequest {\n /** WQL expression */\n query: QueryV2$1;\n /** Include page url */\n includePageUrl?: boolean | null;\n }\n interface QueryProjectWithCollectionInfoResponse {\n /** The retrieved Projects in Collection */\n projects?: ProjectsInCollections$1[];\n /**\n * Paging metadata\n * @internal\n * @deprecated\n */\n pagingMetadataV2?: PagingMetadataV2$2;\n /** Paging metadata */\n metadata?: PagingMetadataV2$2;\n }\n interface RestoreProjectFromTrashBinRequest {\n /** id of deleted project to restore from trash bin. */\n projectId: string;\n }\n interface RestoreProjectFromTrashBinResponse {\n /** project that was restored from trash bin */\n project?: Project$1;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n /**\n * Get project data for a specific project\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.collectionSlug\n * @requiredField identifiers.projectSlug\n * @permissionId PORTFOLIO.PROJECT_READ\n */\n function getProjectPageData(identifiers: GetProjectPageDataIdentifiers): Promise;\n interface GetProjectPageDataIdentifiers {\n /** Slug of the project's current collection */\n collectionSlug: string;\n /** Project's slug */\n projectSlug: string;\n }\n /**\n * create default Portfolio data\n * @internal\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.PROJECT_CREATE\n * @adminMethod\n */\n function createNewPortfolioApp(): Promise;\n /**\n * Creates a project.\n * @param project - Project to create.\n * @public\n * @documentationMaturity preview\n * @requiredField project\n * @permissionId PORTFOLIO.PROJECT_CREATE\n * @adminMethod\n * @returns Created project.\n */\n function createProject(project: Project$1): Promise;\n /**\n * Retrieves a project.\n * @param projectId - ID of the project to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_READ\n * @returns The requested project.\n */\n function getProject(projectId: string, options?: GetProjectOptions): Promise;\n interface GetProjectOptions {\n /** Whether to include the project's relative path and full URL in the response. Default: `false` */\n includePageUrl?: boolean | null;\n }\n /**\n * Retrieves a list of all projects in a portfolio.\n * @public\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.PROJECT_READ\n */\n function listProjects(options?: ListProjectsOptions): Promise;\n interface ListProjectsOptions {\n /** Projects limit per response is maximum 100, In the first request the cursor is None ? */\n paging?: CursorPaging$2;\n /** Whether to include the project's relative path and full URL in the response. Default: `false` */\n includePageUrl?: boolean | null;\n }\n /**\n * Updates a project.\n * @param _id - Project ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField project\n * @requiredField project.revision\n * @permissionId PORTFOLIO.PROJECT_UPDATE\n * @adminMethod\n * @returns Updated project.\n */\n function updateProject(_id: string | null, project: UpdateProject, options?: UpdateProjectOptions): Promise;\n interface UpdateProject {\n /** Project cover image. */\n coverImage?: CommonImage;\n /** Project cover video. */\n coverVideo?: Video$1;\n /**\n * Project ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.\n * @readonly\n */\n revision?: string | null;\n /** Project title. */\n title?: string | null;\n /** Project description. */\n description?: string | null;\n /** Whether the project is hidden from the portfolio. Default: `false` */\n hidden?: boolean | null;\n /** IDs of the collections that include the project. */\n collectionIds?: string[];\n /** Project details. */\n details?: ProjectDetail$1[];\n /** Project slug. */\n slug?: string | null;\n /**\n * Date and time the project was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the project was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * project source - When project is synced from external platform, this field will represent the app & source the projects synced from.\n * @internal\n */\n source?: ProjectSource$1;\n /**\n * Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.\n * @readonly\n */\n url?: string;\n /** Project SEO data. */\n seoData?: SeoSchema$1;\n /**\n * Whether the project is synced to an external platform and will receive daily updates.\n * @internal\n * @readonly\n */\n syncedProject?: boolean | null;\n }\n interface UpdateProjectOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Updates multiple projects.\n * @public\n * @documentationMaturity preview\n * @requiredField options.projects.project\n * @requiredField options.projects.project._id\n * @requiredField options.projects.project.revision\n * @permissionId PORTFOLIO.PROJECT_UPDATE\n * @adminMethod\n */\n function bulkUpdateProjects(options?: BulkUpdateProjectsOptions): Promise;\n interface BulkUpdateProjectsOptions {\n /** Projects to update. */\n projects?: MaskedProject[];\n /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */\n returnFullEntity?: boolean | null;\n }\n /**\n * Deletes a project.\n * @param projectId - ID of the project to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_DELETE\n * @adminMethod\n */\n function deleteProject(projectId: string, options?: DeleteProjectOptions): Promise;\n interface DeleteProjectOptions {\n /**\n * The revision of the Project\n * @internal\n * @deprecated\n */\n revision?: string;\n }\n /**\n * Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.\n *\n * The default `sort` is `id` in `ASC`.\n *\n * For a detailed list of supported operations, see [Projects: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/projects/sort-and-filter).\n * To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.PROJECT_READ\n */\n function queryProjects(options?: QueryProjectsOptions): ProjectsQueryBuilder;\n interface QueryProjectsOptions {\n /** Whether to include the project's relative path and full URL in the response. Default: `false` */\n includePageUrl?: boolean | null | undefined;\n }\n interface QueryCursorResult$1 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProjectsQueryResult extends QueryCursorResult$1 {\n items: Project$1[];\n query: ProjectsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ProjectsQueryBuilder {\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' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;\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' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;\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) => ProjectsQueryBuilder;\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) => ProjectsQueryBuilder;\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) => ProjectsQueryBuilder;\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) => ProjectsQueryBuilder;\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' | 'title' | 'description' | 'slug', value: string) => ProjectsQueryBuilder;\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' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any[]) => ProjectsQueryBuilder;\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: 'collectionIds', value: any[]) => ProjectsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: any) => ProjectsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'title' | 'description' | 'hidden' | 'collectionIds' | 'slug' | '_createdDate' | '_updatedDate', value: boolean) => ProjectsQueryBuilder;\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' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate'>) => ProjectsQueryBuilder;\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' | 'title' | 'description' | 'slug' | '_createdDate' | '_updatedDate'>) => ProjectsQueryBuilder;\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) => ProjectsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ProjectsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Deprecated - please use ProjectsInCollectionsService.UpdateProjectOrderInCollection instead\n * our Client still use it\n * @param sortOrder - Index that determines the placement of a project within the collection.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.collectionId\n * @requiredField identifiers.projectId\n * @requiredField sortOrder\n * @permissionId PORTFOLIO.PROJECT_UPDATE\n * @adminMethod\n * @deprecated\n */\n function updateProjectOrderInCollection$1(identifiers: UpdateProjectOrderInCollectionIdentifiers$1, sortOrder: number | null): Promise;\n interface UpdateProjectOrderInCollectionIdentifiers$1 {\n /** ID of the project to update. */\n projectId: string;\n /** Collection ID. */\n collectionId: string;\n }\n /**\n * Deprecated - please use ProjectsInCollectionsService.QueryProjectsInCollections instead\n * our Client still use it\n * @param query - WQL expression\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId PORTFOLIO.PROJECT_READ\n * @deprecated\n */\n function queryProjectsWithCollectionInfo(query: QueryV2$1, options?: QueryProjectsWithCollectionInfoOptions): Promise;\n interface QueryProjectsWithCollectionInfoOptions {\n /** Include page url */\n includePageUrl?: boolean | null;\n }\n /**\n * Restore from trash bin a project that was deleted. Will lead to restoring Project's items as well.\n * @param projectId - id of deleted project to restore from trash bin.\n * @internal\n * @documentationMaturity preview\n * @requiredField projectId\n * @permissionId PORTFOLIO.PROJECT_CREATE\n * @adminMethod\n */\n function restoreProjectFromTrashBin(projectId: string): Promise;\n \n type portfolioProjectsV1Project_universal_d_CommonImage = CommonImage;\n type portfolioProjectsV1Project_universal_d_ImageImageType = ImageImageType;\n const portfolioProjectsV1Project_universal_d_ImageImageType: typeof ImageImageType;\n type portfolioProjectsV1Project_universal_d_CommonPoint = CommonPoint;\n type portfolioProjectsV1Project_universal_d_CommonUnsharpMasking = CommonUnsharpMasking;\n type portfolioProjectsV1Project_universal_d_MenuSettingUpdatedEvent = MenuSettingUpdatedEvent;\n type portfolioProjectsV1Project_universal_d_GetProjectPageDataRequest = GetProjectPageDataRequest;\n type portfolioProjectsV1Project_universal_d_GetProjectPageDataResponse = GetProjectPageDataResponse;\n type portfolioProjectsV1Project_universal_d_ProjectSlug = ProjectSlug;\n type portfolioProjectsV1Project_universal_d_CreateNewPortfolioAppRequest = CreateNewPortfolioAppRequest;\n type portfolioProjectsV1Project_universal_d_CreateNewPortfolioAppResponse = CreateNewPortfolioAppResponse;\n type portfolioProjectsV1Project_universal_d_InvalidateCache = InvalidateCache;\n type portfolioProjectsV1Project_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type portfolioProjectsV1Project_universal_d_App = App;\n type portfolioProjectsV1Project_universal_d_Page = Page;\n type portfolioProjectsV1Project_universal_d_URI = URI;\n type portfolioProjectsV1Project_universal_d_File = File;\n type portfolioProjectsV1Project_universal_d_SyncProjectWithCollectionMappings = SyncProjectWithCollectionMappings;\n type portfolioProjectsV1Project_universal_d_DeletedProjectRestored = DeletedProjectRestored;\n type portfolioProjectsV1Project_universal_d_CreateProjectRequest = CreateProjectRequest;\n type portfolioProjectsV1Project_universal_d_CreateProjectResponse = CreateProjectResponse;\n type portfolioProjectsV1Project_universal_d_GetProjectRequest = GetProjectRequest;\n type portfolioProjectsV1Project_universal_d_GetProjectResponse = GetProjectResponse;\n type portfolioProjectsV1Project_universal_d_ListProjectsRequest = ListProjectsRequest;\n type portfolioProjectsV1Project_universal_d_ListProjectsResponse = ListProjectsResponse;\n type portfolioProjectsV1Project_universal_d_UpdateProjectRequest = UpdateProjectRequest;\n type portfolioProjectsV1Project_universal_d_UpdateProjectResponse = UpdateProjectResponse;\n type portfolioProjectsV1Project_universal_d_BulkUpdateProjectsRequest = BulkUpdateProjectsRequest;\n type portfolioProjectsV1Project_universal_d_MaskedProject = MaskedProject;\n type portfolioProjectsV1Project_universal_d_BulkUpdateProjectsResponse = BulkUpdateProjectsResponse;\n type portfolioProjectsV1Project_universal_d_BulkUpdateProjectsResult = BulkUpdateProjectsResult;\n type portfolioProjectsV1Project_universal_d_ItemMetadata = ItemMetadata;\n type portfolioProjectsV1Project_universal_d_ApplicationError = ApplicationError;\n type portfolioProjectsV1Project_universal_d_BulkActionMetadata = BulkActionMetadata;\n type portfolioProjectsV1Project_universal_d_DeleteProjectRequest = DeleteProjectRequest;\n type portfolioProjectsV1Project_universal_d_DeleteProjectResponse = DeleteProjectResponse;\n type portfolioProjectsV1Project_universal_d_QueryProjectsRequest = QueryProjectsRequest;\n type portfolioProjectsV1Project_universal_d_QueryProjectsResponse = QueryProjectsResponse;\n type portfolioProjectsV1Project_universal_d_QueryProjectWithCollectionInfoRequest = QueryProjectWithCollectionInfoRequest;\n type portfolioProjectsV1Project_universal_d_QueryProjectWithCollectionInfoResponse = QueryProjectWithCollectionInfoResponse;\n type portfolioProjectsV1Project_universal_d_RestoreProjectFromTrashBinRequest = RestoreProjectFromTrashBinRequest;\n type portfolioProjectsV1Project_universal_d_RestoreProjectFromTrashBinResponse = RestoreProjectFromTrashBinResponse;\n const portfolioProjectsV1Project_universal_d_getProjectPageData: typeof getProjectPageData;\n type portfolioProjectsV1Project_universal_d_GetProjectPageDataIdentifiers = GetProjectPageDataIdentifiers;\n const portfolioProjectsV1Project_universal_d_createNewPortfolioApp: typeof createNewPortfolioApp;\n const portfolioProjectsV1Project_universal_d_createProject: typeof createProject;\n const portfolioProjectsV1Project_universal_d_getProject: typeof getProject;\n type portfolioProjectsV1Project_universal_d_GetProjectOptions = GetProjectOptions;\n const portfolioProjectsV1Project_universal_d_listProjects: typeof listProjects;\n type portfolioProjectsV1Project_universal_d_ListProjectsOptions = ListProjectsOptions;\n const portfolioProjectsV1Project_universal_d_updateProject: typeof updateProject;\n type portfolioProjectsV1Project_universal_d_UpdateProject = UpdateProject;\n type portfolioProjectsV1Project_universal_d_UpdateProjectOptions = UpdateProjectOptions;\n const portfolioProjectsV1Project_universal_d_bulkUpdateProjects: typeof bulkUpdateProjects;\n type portfolioProjectsV1Project_universal_d_BulkUpdateProjectsOptions = BulkUpdateProjectsOptions;\n const portfolioProjectsV1Project_universal_d_deleteProject: typeof deleteProject;\n type portfolioProjectsV1Project_universal_d_DeleteProjectOptions = DeleteProjectOptions;\n const portfolioProjectsV1Project_universal_d_queryProjects: typeof queryProjects;\n type portfolioProjectsV1Project_universal_d_QueryProjectsOptions = QueryProjectsOptions;\n type portfolioProjectsV1Project_universal_d_ProjectsQueryResult = ProjectsQueryResult;\n type portfolioProjectsV1Project_universal_d_ProjectsQueryBuilder = ProjectsQueryBuilder;\n const portfolioProjectsV1Project_universal_d_queryProjectsWithCollectionInfo: typeof queryProjectsWithCollectionInfo;\n type portfolioProjectsV1Project_universal_d_QueryProjectsWithCollectionInfoOptions = QueryProjectsWithCollectionInfoOptions;\n const portfolioProjectsV1Project_universal_d_restoreProjectFromTrashBin: typeof restoreProjectFromTrashBin;\n namespace portfolioProjectsV1Project_universal_d {\n export {\n Project$1 as Project,\n ProjectCoverOneOf$1 as ProjectCoverOneOf,\n portfolioProjectsV1Project_universal_d_CommonImage as CommonImage,\n portfolioProjectsV1Project_universal_d_ImageImageType as ImageImageType,\n portfolioProjectsV1Project_universal_d_CommonPoint as CommonPoint,\n portfolioProjectsV1Project_universal_d_CommonUnsharpMasking as CommonUnsharpMasking,\n Video$1 as Video,\n VideoResolution$1 as VideoResolution,\n ProjectDetail$1 as ProjectDetail,\n ProjectDetailValueOneOf$1 as ProjectDetailValueOneOf,\n DetailsLink$1 as DetailsLink,\n ProjectSource$1 as ProjectSource,\n SyncStatus$2 as SyncStatus,\n SeoSchema$1 as SeoSchema,\n Keyword$1 as Keyword,\n Tag$1 as Tag,\n Settings$1 as Settings,\n portfolioProjectsV1Project_universal_d_MenuSettingUpdatedEvent as MenuSettingUpdatedEvent,\n portfolioProjectsV1Project_universal_d_GetProjectPageDataRequest as GetProjectPageDataRequest,\n portfolioProjectsV1Project_universal_d_GetProjectPageDataResponse as GetProjectPageDataResponse,\n portfolioProjectsV1Project_universal_d_ProjectSlug as ProjectSlug,\n portfolioProjectsV1Project_universal_d_CreateNewPortfolioAppRequest as CreateNewPortfolioAppRequest,\n portfolioProjectsV1Project_universal_d_CreateNewPortfolioAppResponse as CreateNewPortfolioAppResponse,\n MetaSiteSpecialEvent$1 as MetaSiteSpecialEvent,\n MetaSiteSpecialEventPayloadOneOf$1 as MetaSiteSpecialEventPayloadOneOf,\n Asset$1 as Asset,\n State$1 as State,\n SiteCreated$1 as SiteCreated,\n SiteCreatedContext$1 as SiteCreatedContext,\n Namespace$1 as Namespace,\n SiteTransferred$1 as SiteTransferred,\n SiteDeleted$1 as SiteDeleted,\n DeleteContext$1 as DeleteContext,\n DeleteStatus$1 as DeleteStatus,\n SiteUndeleted$1 as SiteUndeleted,\n SitePublished$1 as SitePublished,\n SiteUnpublished$1 as SiteUnpublished,\n SiteMarkedAsTemplate$1 as SiteMarkedAsTemplate,\n SiteMarkedAsWixSite$1 as SiteMarkedAsWixSite,\n ServiceProvisioned$1 as ServiceProvisioned,\n ServiceRemoved$1 as ServiceRemoved,\n SiteRenamed$1 as SiteRenamed,\n SiteHardDeleted$1 as SiteHardDeleted,\n NamespaceChanged$1 as NamespaceChanged,\n StudioAssigned$1 as StudioAssigned,\n StudioUnassigned$1 as StudioUnassigned,\n Empty$1 as Empty,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n portfolioProjectsV1Project_universal_d_InvalidateCache as InvalidateCache,\n portfolioProjectsV1Project_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n portfolioProjectsV1Project_universal_d_App as App,\n portfolioProjectsV1Project_universal_d_Page as Page,\n portfolioProjectsV1Project_universal_d_URI as URI,\n portfolioProjectsV1Project_universal_d_File as File,\n portfolioProjectsV1Project_universal_d_SyncProjectWithCollectionMappings as SyncProjectWithCollectionMappings,\n portfolioProjectsV1Project_universal_d_DeletedProjectRestored as DeletedProjectRestored,\n portfolioProjectsV1Project_universal_d_CreateProjectRequest as CreateProjectRequest,\n portfolioProjectsV1Project_universal_d_CreateProjectResponse as CreateProjectResponse,\n portfolioProjectsV1Project_universal_d_GetProjectRequest as GetProjectRequest,\n portfolioProjectsV1Project_universal_d_GetProjectResponse as GetProjectResponse,\n portfolioProjectsV1Project_universal_d_ListProjectsRequest as ListProjectsRequest,\n CursorPaging$2 as CursorPaging,\n portfolioProjectsV1Project_universal_d_ListProjectsResponse as ListProjectsResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n Cursors$2 as Cursors,\n portfolioProjectsV1Project_universal_d_UpdateProjectRequest as UpdateProjectRequest,\n portfolioProjectsV1Project_universal_d_UpdateProjectResponse as UpdateProjectResponse,\n portfolioProjectsV1Project_universal_d_BulkUpdateProjectsRequest as BulkUpdateProjectsRequest,\n portfolioProjectsV1Project_universal_d_MaskedProject as MaskedProject,\n portfolioProjectsV1Project_universal_d_BulkUpdateProjectsResponse as BulkUpdateProjectsResponse,\n portfolioProjectsV1Project_universal_d_BulkUpdateProjectsResult as BulkUpdateProjectsResult,\n portfolioProjectsV1Project_universal_d_ItemMetadata as ItemMetadata,\n portfolioProjectsV1Project_universal_d_ApplicationError as ApplicationError,\n portfolioProjectsV1Project_universal_d_BulkActionMetadata as BulkActionMetadata,\n portfolioProjectsV1Project_universal_d_DeleteProjectRequest as DeleteProjectRequest,\n portfolioProjectsV1Project_universal_d_DeleteProjectResponse as DeleteProjectResponse,\n portfolioProjectsV1Project_universal_d_QueryProjectsRequest as QueryProjectsRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$1 as Paging,\n portfolioProjectsV1Project_universal_d_QueryProjectsResponse as QueryProjectsResponse,\n UpdateProjectOrderInCollectionRequest$1 as UpdateProjectOrderInCollectionRequest,\n UpdateProjectOrderInCollectionResponse$1 as UpdateProjectOrderInCollectionResponse,\n ProjectsInCollections$1 as ProjectsInCollections,\n portfolioProjectsV1Project_universal_d_QueryProjectWithCollectionInfoRequest as QueryProjectWithCollectionInfoRequest,\n portfolioProjectsV1Project_universal_d_QueryProjectWithCollectionInfoResponse as QueryProjectWithCollectionInfoResponse,\n portfolioProjectsV1Project_universal_d_RestoreProjectFromTrashBinRequest as RestoreProjectFromTrashBinRequest,\n portfolioProjectsV1Project_universal_d_RestoreProjectFromTrashBinResponse as RestoreProjectFromTrashBinResponse,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n portfolioProjectsV1Project_universal_d_getProjectPageData as getProjectPageData,\n portfolioProjectsV1Project_universal_d_GetProjectPageDataIdentifiers as GetProjectPageDataIdentifiers,\n portfolioProjectsV1Project_universal_d_createNewPortfolioApp as createNewPortfolioApp,\n portfolioProjectsV1Project_universal_d_createProject as createProject,\n portfolioProjectsV1Project_universal_d_getProject as getProject,\n portfolioProjectsV1Project_universal_d_GetProjectOptions as GetProjectOptions,\n portfolioProjectsV1Project_universal_d_listProjects as listProjects,\n portfolioProjectsV1Project_universal_d_ListProjectsOptions as ListProjectsOptions,\n portfolioProjectsV1Project_universal_d_updateProject as updateProject,\n portfolioProjectsV1Project_universal_d_UpdateProject as UpdateProject,\n portfolioProjectsV1Project_universal_d_UpdateProjectOptions as UpdateProjectOptions,\n portfolioProjectsV1Project_universal_d_bulkUpdateProjects as bulkUpdateProjects,\n portfolioProjectsV1Project_universal_d_BulkUpdateProjectsOptions as BulkUpdateProjectsOptions,\n portfolioProjectsV1Project_universal_d_deleteProject as deleteProject,\n portfolioProjectsV1Project_universal_d_DeleteProjectOptions as DeleteProjectOptions,\n portfolioProjectsV1Project_universal_d_queryProjects as queryProjects,\n portfolioProjectsV1Project_universal_d_QueryProjectsOptions as QueryProjectsOptions,\n portfolioProjectsV1Project_universal_d_ProjectsQueryResult as ProjectsQueryResult,\n portfolioProjectsV1Project_universal_d_ProjectsQueryBuilder as ProjectsQueryBuilder,\n updateProjectOrderInCollection$1 as updateProjectOrderInCollection,\n UpdateProjectOrderInCollectionIdentifiers$1 as UpdateProjectOrderInCollectionIdentifiers,\n portfolioProjectsV1Project_universal_d_queryProjectsWithCollectionInfo as queryProjectsWithCollectionInfo,\n portfolioProjectsV1Project_universal_d_QueryProjectsWithCollectionInfoOptions as QueryProjectsWithCollectionInfoOptions,\n portfolioProjectsV1Project_universal_d_restoreProjectFromTrashBin as restoreProjectFromTrashBin,\n };\n }\n \n interface ProjectsInCollections {\n /** Collection ID. */\n collectionId?: string;\n /** Project object. */\n project?: Project;\n /**\n * Index that determines the placement of a project within the collection.
\n *\n * Default: [Epoch](https://www.epoch101.com/) timestamp.
\n */\n sortOrder?: number | null;\n /**\n * Project placement ID.\n * @readonly\n */\n _id?: string | null;\n }\n interface Project extends ProjectCoverOneOf {\n /** Project cover image. */\n coverImage?: Image;\n /** Project cover video. */\n coverVideo?: Video;\n /**\n * Project ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.\n * @readonly\n */\n revision?: string | null;\n /** Project title. */\n title?: string | null;\n /** Project description. */\n description?: string | null;\n /** Whether the project is hidden from the portfolio. Default: `false` */\n hidden?: boolean | null;\n /** IDs of the collections that include the project. */\n collectionIds?: string[];\n /** Project details. */\n details?: ProjectDetail[];\n /** Project slug. */\n slug?: string | null;\n /**\n * Date and time the project was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the project was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * project source - When project is synced from external platform, this field will represent the app & source the projects synced from.\n * @internal\n */\n source?: ProjectSource;\n /**\n * Project page URL and and relative path. Returned when `includePageUrl` is `true` in the request.\n * @readonly\n */\n url?: string;\n /** Project SEO data. */\n seoData?: SeoSchema;\n /**\n * Whether the project is synced to an external platform and will receive daily updates.\n * @internal\n * @readonly\n */\n syncedProject?: boolean | null;\n }\n /** @oneof */\n interface ProjectCoverOneOf {\n /** Project cover image. */\n coverImage?: Image;\n /** Project cover video. */\n coverVideo?: Video;\n }\n interface Image {\n /**\n * @internal\n * @deprecated\n */\n type?: ImageType;\n /** Information about the Wix Media image. */\n imageInfo?: string;\n /** Focal point of the image. */\n focalPoint?: Point;\n /**\n * Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif).\n * @internal\n */\n exif?: Record | null;\n /**\n * Image compression level.
\n *\n * Min: `30`
\n * Max: `100`\n * @internal\n */\n quality?: number | null;\n /**\n * [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image.\n * @internal\n */\n unsharpMasking?: UnsharpMasking;\n /**\n * Whether the image is saved in secure media.\n * @internal\n */\n secure?: boolean | null;\n /**\n * When image is saved in secure media, token is generated.\n * @internal\n * @readonly\n */\n token?: string | null;\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 /** Information about the Wix Media video. */\n videoInfo?: string;\n /** Manually defined Video duration in milliseconds. */\n durationInMillis?: number | null;\n }\n interface VideoResolution {\n /** Video URL. Required. */\n url?: string;\n /** Video height. Required. */\n height?: number;\n /** Video width. Required. */\n width?: number;\n /**\n * Video poster. Deprecated, please use the `posters` property in the parent entity\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. Required. */\n format?: string;\n /** Video quality for example 480p, 720p. */\n quality?: string | null;\n /** Video filename. */\n filename?: string | null;\n }\n /**\n * Project label.\n * One of:\n * + `text`\n * + `link`\n */\n interface ProjectDetail extends ProjectDetailValueOneOf {\n /** Project label in plain text format. */\n text?: string;\n /** Project label in link format. */\n link?: DetailsLink;\n /** Project label. */\n label?: string;\n }\n /** @oneof */\n interface ProjectDetailValueOneOf {\n /** Project label in plain text format. */\n text?: string;\n /** Project label in link format. */\n link?: DetailsLink;\n }\n interface DetailsLink {\n /** Display text of the link. */\n text?: string | null;\n /** Target URL of the link. */\n url?: string | null;\n /**\n * Whether the link opens in a new tab or window. One of:\n * * `'_blank'`: The link opens in a new tab or window.\n * * `'_self'`: The link opens in the same tab or window.\n */\n target?: string | null;\n }\n interface ProjectSource {\n /** App definition id */\n appDefId?: string;\n /** External source id */\n externalId?: string;\n /** Source name */\n sourceName?: string;\n /** Source description */\n description?: string | null;\n /** link to external source */\n link?: string | null;\n /** Sync status */\n syncStatus?: SyncStatus$1;\n /** fields that are synced from external source, should be blocked to update in UI */\n notEditableFields?: string[];\n /** last date the project was synced */\n lastSync?: Date | null;\n }\n enum SyncStatus$1 {\n SYNCED = \"SYNCED\",\n SYNCING = \"SYNCING\",\n NOT_SYNCED = \"NOT_SYNCED\"\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 QueryProjectInCollectionsRequest {\n /** Query options. */\n query: QueryV2;\n /**\n * Whether to include the project's relative path and full URL in the response.\n * Default: `false`\n */\n includePageUrl?: boolean | null;\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$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[];\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$1;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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$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 QueryProjectInCollectionsResponse {\n /** List of projects and their placement within the specified collections. */\n projectInCollections?: ProjectsInCollections[];\n /** Paging 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$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 * @internal\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 UpdateProjectOrderInCollectionRequest {\n /** ID of the project to update. */\n projectId: string;\n /** Collection ID. */\n collectionId: string;\n /** Index that determines the placement of a project within the collection. */\n sortOrder: number | null;\n }\n interface UpdateProjectOrderInCollectionResponse {\n /**\n * @internal\n * @deprecated\n */\n project?: ProjectsInCollections;\n /** Updated project placement within the specified collection. */\n projectInCollection?: ProjectsInCollections;\n }\n interface ProjectOrderInCollectionUpdatedEvent {\n /** ID of the project to update. */\n projectId?: string;\n /** Collection ID. */\n collectionId?: string;\n /** Index that determines the placement of a project within the collection. */\n sortOrder?: number | 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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 list of projects and their placement in the specified collections given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request.\n *\n * The default `sort` is `project.id` in `ASC`.\n *\n * For additional field support for filters and sorting, see [Projects In Collections: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/portfolio/project-in-collection/sort-and-filter.\n *\n * To learn how to query projects and their placement in collections, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).\n * @internal\n * @documentationMaturity preview\n * @permissionId PORTFOLIO.PROJECT_READ\n */\n function queryProjectInCollections(options?: QueryProjectInCollectionsOptions): ProjectInCollectionsQueryBuilder;\n interface QueryProjectInCollectionsOptions {\n /**\n * Whether to include the project's relative path and full URL in the response.\n * Default: `false`\n */\n includePageUrl?: boolean | null | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProjectInCollectionsQueryResult extends QueryCursorResult {\n items: ProjectsInCollections[];\n query: ProjectInCollectionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ProjectInCollectionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\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: 'collectionId' | 'project.id' | 'project.slug', value: string) => ProjectInCollectionsQueryBuilder;\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: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any[]) => ProjectInCollectionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: any) => ProjectInCollectionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'collectionId' | 'project.id' | 'project.hidden' | 'project.slug' | 'sortOrder', value: boolean) => ProjectInCollectionsQueryBuilder;\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<'collectionId' | 'project.id' | 'project.slug' | 'sortOrder'>) => ProjectInCollectionsQueryBuilder;\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<'collectionId' | 'project.id' | 'project.slug' | 'sortOrder'>) => ProjectInCollectionsQueryBuilder;\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) => ProjectInCollectionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ProjectInCollectionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Updates the placement of a project within a specified collection.\n * @param sortOrder - Index that determines the placement of a project within the collection.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.collectionId\n * @requiredField identifiers.projectId\n * @requiredField sortOrder\n * @permissionId PORTFOLIO.PROJECT_UPDATE\n * @adminMethod\n */\n function updateProjectOrderInCollection(identifiers: UpdateProjectOrderInCollectionIdentifiers, sortOrder: number | null): Promise;\n interface UpdateProjectOrderInCollectionIdentifiers {\n /** ID of the project to update. */\n projectId: string;\n /** Collection ID. */\n collectionId: string;\n }\n \n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectsInCollections = ProjectsInCollections;\n type portfolioProjectsV1ProjectInCollection_universal_d_Project = Project;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectCoverOneOf = ProjectCoverOneOf;\n type portfolioProjectsV1ProjectInCollection_universal_d_Image = Image;\n type portfolioProjectsV1ProjectInCollection_universal_d_ImageType = ImageType;\n const portfolioProjectsV1ProjectInCollection_universal_d_ImageType: typeof ImageType;\n type portfolioProjectsV1ProjectInCollection_universal_d_Point = Point;\n type portfolioProjectsV1ProjectInCollection_universal_d_UnsharpMasking = UnsharpMasking;\n type portfolioProjectsV1ProjectInCollection_universal_d_Video = Video;\n type portfolioProjectsV1ProjectInCollection_universal_d_VideoResolution = VideoResolution;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectDetail = ProjectDetail;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectDetailValueOneOf = ProjectDetailValueOneOf;\n type portfolioProjectsV1ProjectInCollection_universal_d_DetailsLink = DetailsLink;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectSource = ProjectSource;\n type portfolioProjectsV1ProjectInCollection_universal_d_SeoSchema = SeoSchema;\n type portfolioProjectsV1ProjectInCollection_universal_d_Keyword = Keyword;\n type portfolioProjectsV1ProjectInCollection_universal_d_Tag = Tag;\n type portfolioProjectsV1ProjectInCollection_universal_d_Settings = Settings;\n type portfolioProjectsV1ProjectInCollection_universal_d_QueryProjectInCollectionsRequest = QueryProjectInCollectionsRequest;\n type portfolioProjectsV1ProjectInCollection_universal_d_QueryV2 = QueryV2;\n type portfolioProjectsV1ProjectInCollection_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type portfolioProjectsV1ProjectInCollection_universal_d_Sorting = Sorting;\n type portfolioProjectsV1ProjectInCollection_universal_d_SortOrder = SortOrder;\n const portfolioProjectsV1ProjectInCollection_universal_d_SortOrder: typeof SortOrder;\n type portfolioProjectsV1ProjectInCollection_universal_d_Paging = Paging;\n type portfolioProjectsV1ProjectInCollection_universal_d_QueryProjectInCollectionsResponse = QueryProjectInCollectionsResponse;\n type portfolioProjectsV1ProjectInCollection_universal_d_UpdateProjectOrderInCollectionRequest = UpdateProjectOrderInCollectionRequest;\n type portfolioProjectsV1ProjectInCollection_universal_d_UpdateProjectOrderInCollectionResponse = UpdateProjectOrderInCollectionResponse;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectOrderInCollectionUpdatedEvent = ProjectOrderInCollectionUpdatedEvent;\n const portfolioProjectsV1ProjectInCollection_universal_d_queryProjectInCollections: typeof queryProjectInCollections;\n type portfolioProjectsV1ProjectInCollection_universal_d_QueryProjectInCollectionsOptions = QueryProjectInCollectionsOptions;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectInCollectionsQueryResult = ProjectInCollectionsQueryResult;\n type portfolioProjectsV1ProjectInCollection_universal_d_ProjectInCollectionsQueryBuilder = ProjectInCollectionsQueryBuilder;\n const portfolioProjectsV1ProjectInCollection_universal_d_updateProjectOrderInCollection: typeof updateProjectOrderInCollection;\n type portfolioProjectsV1ProjectInCollection_universal_d_UpdateProjectOrderInCollectionIdentifiers = UpdateProjectOrderInCollectionIdentifiers;\n namespace portfolioProjectsV1ProjectInCollection_universal_d {\n export {\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectsInCollections as ProjectsInCollections,\n portfolioProjectsV1ProjectInCollection_universal_d_Project as Project,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectCoverOneOf as ProjectCoverOneOf,\n portfolioProjectsV1ProjectInCollection_universal_d_Image as Image,\n portfolioProjectsV1ProjectInCollection_universal_d_ImageType as ImageType,\n portfolioProjectsV1ProjectInCollection_universal_d_Point as Point,\n portfolioProjectsV1ProjectInCollection_universal_d_UnsharpMasking as UnsharpMasking,\n portfolioProjectsV1ProjectInCollection_universal_d_Video as Video,\n portfolioProjectsV1ProjectInCollection_universal_d_VideoResolution as VideoResolution,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectDetail as ProjectDetail,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectDetailValueOneOf as ProjectDetailValueOneOf,\n portfolioProjectsV1ProjectInCollection_universal_d_DetailsLink as DetailsLink,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectSource as ProjectSource,\n SyncStatus$1 as SyncStatus,\n portfolioProjectsV1ProjectInCollection_universal_d_SeoSchema as SeoSchema,\n portfolioProjectsV1ProjectInCollection_universal_d_Keyword as Keyword,\n portfolioProjectsV1ProjectInCollection_universal_d_Tag as Tag,\n portfolioProjectsV1ProjectInCollection_universal_d_Settings as Settings,\n portfolioProjectsV1ProjectInCollection_universal_d_QueryProjectInCollectionsRequest as QueryProjectInCollectionsRequest,\n portfolioProjectsV1ProjectInCollection_universal_d_QueryV2 as QueryV2,\n portfolioProjectsV1ProjectInCollection_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n portfolioProjectsV1ProjectInCollection_universal_d_Sorting as Sorting,\n portfolioProjectsV1ProjectInCollection_universal_d_SortOrder as SortOrder,\n portfolioProjectsV1ProjectInCollection_universal_d_Paging as Paging,\n CursorPaging$1 as CursorPaging,\n portfolioProjectsV1ProjectInCollection_universal_d_QueryProjectInCollectionsResponse as QueryProjectInCollectionsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n portfolioProjectsV1ProjectInCollection_universal_d_UpdateProjectOrderInCollectionRequest as UpdateProjectOrderInCollectionRequest,\n portfolioProjectsV1ProjectInCollection_universal_d_UpdateProjectOrderInCollectionResponse as UpdateProjectOrderInCollectionResponse,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectOrderInCollectionUpdatedEvent as ProjectOrderInCollectionUpdatedEvent,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n portfolioProjectsV1ProjectInCollection_universal_d_queryProjectInCollections as queryProjectInCollections,\n portfolioProjectsV1ProjectInCollection_universal_d_QueryProjectInCollectionsOptions as QueryProjectInCollectionsOptions,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectInCollectionsQueryResult as ProjectInCollectionsQueryResult,\n portfolioProjectsV1ProjectInCollection_universal_d_ProjectInCollectionsQueryBuilder as ProjectInCollectionsQueryBuilder,\n portfolioProjectsV1ProjectInCollection_universal_d_updateProjectOrderInCollection as updateProjectOrderInCollection,\n portfolioProjectsV1ProjectInCollection_universal_d_UpdateProjectOrderInCollectionIdentifiers as UpdateProjectOrderInCollectionIdentifiers,\n };\n }\n \n interface SyncedProject {\n /** Project ID in Portfolio - if project was yet to be create, will be None */\n portfolioProjectId?: string | null;\n /** External Project ID */\n externalId?: string;\n /** Project name */\n title?: string | null;\n /** Project media count */\n mediaCount?: number;\n /** Project image url */\n coverImage?: string | null;\n /** Project url in external */\n link?: string | null;\n /**\n * Represents the last time project was synced - returned only if external project is synced\n * @readonly\n */\n lastSynced?: Date | null;\n /** External Project synced status */\n status?: SyncStatus;\n }\n enum SyncStatus {\n /** Project was not synced */\n NOT_SYNCED = \"NOT_SYNCED\",\n /** Project is in pending state */\n PENDING = \"PENDING\",\n /** Project is in syncing state */\n SYNCING = \"SYNCING\",\n /** Project was synced */\n SYNCED = \"SYNCED\"\n }\n interface SyncingProjectEvent {\n /** Provider appDefId */\n appDefId?: string;\n /** External Project ID */\n externalProjectId?: string;\n /** Portfolio Project ID */\n portfolioProjectId?: string;\n /** When the first event was produced, and started syncing */\n firstProduceTimestamp?: Date | null;\n /** Project Revision */\n projectSyncRevision?: Date | null;\n }\n interface SyncProjectPagingEvent {\n /** Provider appDefId */\n appDefId?: string;\n /** External Project ID */\n externalProjectId?: string;\n /** Portfolio Project ID */\n portfolioProjectId?: string;\n /** Next page cursor */\n nextPageCursor?: string | null;\n /** Project Revision */\n projectSyncRevision?: Date | null;\n }\n interface SyncSiteEvent {\n /** Portfolio instance id */\n instanceId?: string;\n /** Paging */\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 SyncProjectRequest {\n /** Provider appDefId */\n appDefId: string;\n /** External Project ID */\n externalId: string;\n }\n interface GetProjectsRequest {\n /** Provider appDefId */\n appDefId: string;\n /** Paging */\n paging?: CursorPaging;\n }\n interface GetProjectsResponse {\n /** Provider appDefId */\n projects?: SyncedProject[];\n /** Paging metadata */\n metadata?: 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 * 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 * @internal\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 SyncProjectResponse {\n /** Portfolio project */\n project?: SyncedProject;\n }\n interface GetSyncStatusRequest {\n /** Provider appDefId */\n appDefId: string;\n /** External Project ID */\n externalId: string;\n }\n interface GetSyncStatusResponse {\n /** Provider appDefId */\n appDefId?: string;\n /** External Project ID */\n externalId?: string;\n /** Synced status */\n status?: SyncStatus;\n }\n interface StopSyncRequest {\n /** Provider appDefId */\n appDefId: string;\n /** External Project ID */\n externalId: string;\n }\n interface StopSyncResponse {\n /** Provider appDefId */\n appDefId?: string;\n /** External Project ID */\n externalId?: string;\n }\n interface GetLoginRedirectableUrlRequest {\n /** Provider appDefId */\n appDefId: string;\n }\n interface GetLoginRedirectableUrlResponse {\n /** Provider appDefId */\n appDefId?: string;\n /** Login url */\n url?: 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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface ItemCreatedMediaCallbackRequest {\n appDefId: string;\n /** External Project ID */\n projectExternalId: string;\n /** External Project ID */\n itemExternalId: string;\n fileName?: string | null;\n mediaType?: string | null;\n opStatus?: string | null;\n fileSize?: number | null;\n width?: number | null;\n height?: number | null;\n fileOutput?: MediaFileOutput;\n siteId?: string | null;\n }\n interface MediaFileOutput {\n video?: MediaVideoOutput[];\n image?: MediaImageOutput[];\n }\n interface MediaVideoOutput {\n key?: string | null;\n status?: string | null;\n url?: string | null;\n quality?: string | null;\n duration?: number | null;\n width?: number | null;\n height?: number | null;\n format?: string | null;\n }\n interface MediaImageOutput {\n key?: string | null;\n status?: string | null;\n url?: string | null;\n width?: number | null;\n height?: number | null;\n format?: string | null;\n }\n interface ItemCreatedMediaCallbackResponse {\n }\n interface ProjectCoverImageCreatedMediaCallbackRequest {\n appDefId: string;\n /** External Project ID */\n projectExternalId: string;\n fileName?: string | null;\n mediaType?: string | null;\n opStatus?: string | null;\n fileSize?: number | null;\n width?: number | null;\n height?: number | null;\n fileOutput?: MediaFileOutput;\n siteId?: string | null;\n }\n interface ProjectCoverImageCreatedMediaCallbackResponse {\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 /** 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 SyncAllSitesEvent {\n /** Paging */\n paging?: CursorPaging;\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 * Get projects per app\n * @param appDefId - Provider appDefId\n * @public\n * @documentationMaturity preview\n * @requiredField appDefId\n * @permissionId PORTFOLIO.SYNCED_PROJECTS_READ\n * @adminMethod\n */\n function getProjects(appDefId: string, options?: GetProjectsOptions): Promise;\n interface GetProjectsOptions {\n /** Paging */\n paging?: CursorPaging;\n }\n /**\n * Async Sync project\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.appDefId\n * @requiredField identifiers.externalId\n * @permissionId PORTFOLIO.SYNCED_PROJECTS_SYNC\n * @adminMethod\n */\n function syncProject(identifiers: SyncProjectIdentifiers): Promise;\n interface SyncProjectIdentifiers {\n /** Provider appDefId */\n appDefId: string;\n /** External Project ID */\n externalId: string;\n }\n /**\n * Get sync status (when was last synced and etc..)\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.appDefId\n * @requiredField identifiers.externalId\n * @permissionId PORTFOLIO.SYNCED_PROJECTS_READ\n * @adminMethod\n */\n function getSyncStatus(identifiers: GetSyncStatusIdentifiers): Promise;\n interface GetSyncStatusIdentifiers {\n /** Provider appDefId */\n appDefId: string;\n /** External Project ID */\n externalId: string;\n }\n /**\n * Stop sync project\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.appDefId\n * @requiredField identifiers.externalId\n * @permissionId PORTFOLIO.SYNCED_PROJECTS_STOP_SYNC\n * @adminMethod\n */\n function stopSync(identifiers: StopSyncIdentifiers): Promise;\n interface StopSyncIdentifiers {\n /** Provider appDefId */\n appDefId: string;\n /** External Project ID */\n externalId: string;\n }\n /**\n * Get login redirectable url\n * @param appDefId - Provider appDefId\n * @public\n * @documentationMaturity preview\n * @requiredField appDefId\n * @permissionId PORTFOLIO.SYNCED_PROJECTS_READ\n * @adminMethod\n */\n function getLoginRedirectableUrl(appDefId: string): Promise;\n /**\n * media-callback endpoint for item created\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.appDefId\n * @requiredField identifiers.itemExternalId\n * @requiredField identifiers.projectExternalId\n * @adminMethod\n */\n function itemCreatedMediaCallback(identifiers: ItemCreatedMediaCallbackIdentifiers, options?: ItemCreatedMediaCallbackOptions): Promise;\n interface ItemCreatedMediaCallbackIdentifiers {\n appDefId: string;\n /** External Project ID */\n projectExternalId: string;\n /** External Project ID */\n itemExternalId: string;\n }\n interface ItemCreatedMediaCallbackOptions {\n fileName?: string | null;\n mediaType?: string | null;\n opStatus?: string | null;\n fileSize?: number | null;\n width?: number | null;\n height?: number | null;\n fileOutput?: MediaFileOutput;\n siteId?: string | null;\n }\n /**\n * media-callback endpoint for project cover image created\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.appDefId\n * @requiredField identifiers.projectExternalId\n * @adminMethod\n */\n function projectCoverImageCreatedMediaCallback(identifiers: ProjectCoverImageCreatedMediaCallbackIdentifiers, options?: ProjectCoverImageCreatedMediaCallbackOptions): Promise;\n interface ProjectCoverImageCreatedMediaCallbackIdentifiers {\n appDefId: string;\n /** External Project ID */\n projectExternalId: string;\n }\n interface ProjectCoverImageCreatedMediaCallbackOptions {\n fileName?: string | null;\n mediaType?: string | null;\n opStatus?: string | null;\n fileSize?: number | null;\n width?: number | null;\n height?: number | null;\n fileOutput?: MediaFileOutput;\n siteId?: string | null;\n }\n \n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncedProject = SyncedProject;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncStatus = SyncStatus;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_SyncStatus: typeof SyncStatus;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncingProjectEvent = SyncingProjectEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectPagingEvent = SyncProjectPagingEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncSiteEvent = SyncSiteEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_CursorPaging = CursorPaging;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectRequest = SyncProjectRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetProjectsRequest = GetProjectsRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetProjectsResponse = GetProjectsResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_Cursors = Cursors;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectResponse = SyncProjectResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetSyncStatusRequest = GetSyncStatusRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetSyncStatusResponse = GetSyncStatusResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_StopSyncRequest = StopSyncRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_StopSyncResponse = StopSyncResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetLoginRedirectableUrlRequest = GetLoginRedirectableUrlRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetLoginRedirectableUrlResponse = GetLoginRedirectableUrlResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_DomainEvent = DomainEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_RestoreInfo = RestoreInfo;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ActionEvent = ActionEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_Empty = Empty;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackRequest = ItemCreatedMediaCallbackRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_MediaFileOutput = MediaFileOutput;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_MediaVideoOutput = MediaVideoOutput;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_MediaImageOutput = MediaImageOutput;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackResponse = ItemCreatedMediaCallbackResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackRequest = ProjectCoverImageCreatedMediaCallbackRequest;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackResponse = ProjectCoverImageCreatedMediaCallbackResponse;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_Asset = Asset;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_State = State;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_State: typeof State;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteCreated = SiteCreated;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteCreatedContext = SiteCreatedContext;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_Namespace = Namespace;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_Namespace: typeof Namespace;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteTransferred = SiteTransferred;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteDeleted = SiteDeleted;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_DeleteContext = DeleteContext;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_DeleteStatus = DeleteStatus;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_DeleteStatus: typeof DeleteStatus;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteUndeleted = SiteUndeleted;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SitePublished = SitePublished;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteUnpublished = SiteUnpublished;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ServiceProvisioned = ServiceProvisioned;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ServiceRemoved = ServiceRemoved;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteRenamed = SiteRenamed;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SiteHardDeleted = SiteHardDeleted;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_NamespaceChanged = NamespaceChanged;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_StudioAssigned = StudioAssigned;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_StudioUnassigned = StudioUnassigned;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncAllSitesEvent = SyncAllSitesEvent;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_MessageEnvelope = MessageEnvelope;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_IdentificationData = IdentificationData;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_WebhookIdentityType = WebhookIdentityType;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_getProjects: typeof getProjects;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetProjectsOptions = GetProjectsOptions;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_syncProject: typeof syncProject;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectIdentifiers = SyncProjectIdentifiers;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_getSyncStatus: typeof getSyncStatus;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_GetSyncStatusIdentifiers = GetSyncStatusIdentifiers;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_stopSync: typeof stopSync;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_StopSyncIdentifiers = StopSyncIdentifiers;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_getLoginRedirectableUrl: typeof getLoginRedirectableUrl;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_itemCreatedMediaCallback: typeof itemCreatedMediaCallback;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackIdentifiers = ItemCreatedMediaCallbackIdentifiers;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackOptions = ItemCreatedMediaCallbackOptions;\n const portfolioSyncedprojectsV1SyncedProject_universal_d_projectCoverImageCreatedMediaCallback: typeof projectCoverImageCreatedMediaCallback;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackIdentifiers = ProjectCoverImageCreatedMediaCallbackIdentifiers;\n type portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackOptions = ProjectCoverImageCreatedMediaCallbackOptions;\n namespace portfolioSyncedprojectsV1SyncedProject_universal_d {\n export {\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncedProject as SyncedProject,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncStatus as SyncStatus,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncingProjectEvent as SyncingProjectEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectPagingEvent as SyncProjectPagingEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncSiteEvent as SyncSiteEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_CursorPaging as CursorPaging,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectRequest as SyncProjectRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetProjectsRequest as GetProjectsRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetProjectsResponse as GetProjectsResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_PagingMetadataV2 as PagingMetadataV2,\n portfolioSyncedprojectsV1SyncedProject_universal_d_Cursors as Cursors,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectResponse as SyncProjectResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetSyncStatusRequest as GetSyncStatusRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetSyncStatusResponse as GetSyncStatusResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_StopSyncRequest as StopSyncRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_StopSyncResponse as StopSyncResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetLoginRedirectableUrlRequest as GetLoginRedirectableUrlRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetLoginRedirectableUrlResponse as GetLoginRedirectableUrlResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_DomainEvent as DomainEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n portfolioSyncedprojectsV1SyncedProject_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_RestoreInfo as RestoreInfo,\n portfolioSyncedprojectsV1SyncedProject_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ActionEvent as ActionEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_Empty as Empty,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackRequest as ItemCreatedMediaCallbackRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_MediaFileOutput as MediaFileOutput,\n portfolioSyncedprojectsV1SyncedProject_universal_d_MediaVideoOutput as MediaVideoOutput,\n portfolioSyncedprojectsV1SyncedProject_universal_d_MediaImageOutput as MediaImageOutput,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackResponse as ItemCreatedMediaCallbackResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackRequest as ProjectCoverImageCreatedMediaCallbackRequest,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackResponse as ProjectCoverImageCreatedMediaCallbackResponse,\n portfolioSyncedprojectsV1SyncedProject_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n portfolioSyncedprojectsV1SyncedProject_universal_d_Asset as Asset,\n portfolioSyncedprojectsV1SyncedProject_universal_d_State as State,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteCreated as SiteCreated,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteCreatedContext as SiteCreatedContext,\n portfolioSyncedprojectsV1SyncedProject_universal_d_Namespace as Namespace,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteTransferred as SiteTransferred,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteDeleted as SiteDeleted,\n portfolioSyncedprojectsV1SyncedProject_universal_d_DeleteContext as DeleteContext,\n portfolioSyncedprojectsV1SyncedProject_universal_d_DeleteStatus as DeleteStatus,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteUndeleted as SiteUndeleted,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SitePublished as SitePublished,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteUnpublished as SiteUnpublished,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ServiceProvisioned as ServiceProvisioned,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ServiceRemoved as ServiceRemoved,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteRenamed as SiteRenamed,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SiteHardDeleted as SiteHardDeleted,\n portfolioSyncedprojectsV1SyncedProject_universal_d_NamespaceChanged as NamespaceChanged,\n portfolioSyncedprojectsV1SyncedProject_universal_d_StudioAssigned as StudioAssigned,\n portfolioSyncedprojectsV1SyncedProject_universal_d_StudioUnassigned as StudioUnassigned,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncAllSitesEvent as SyncAllSitesEvent,\n portfolioSyncedprojectsV1SyncedProject_universal_d_MessageEnvelope as MessageEnvelope,\n portfolioSyncedprojectsV1SyncedProject_universal_d_IdentificationData as IdentificationData,\n portfolioSyncedprojectsV1SyncedProject_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n portfolioSyncedprojectsV1SyncedProject_universal_d_WebhookIdentityType as WebhookIdentityType,\n portfolioSyncedprojectsV1SyncedProject_universal_d_getProjects as getProjects,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetProjectsOptions as GetProjectsOptions,\n portfolioSyncedprojectsV1SyncedProject_universal_d_syncProject as syncProject,\n portfolioSyncedprojectsV1SyncedProject_universal_d_SyncProjectIdentifiers as SyncProjectIdentifiers,\n portfolioSyncedprojectsV1SyncedProject_universal_d_getSyncStatus as getSyncStatus,\n portfolioSyncedprojectsV1SyncedProject_universal_d_GetSyncStatusIdentifiers as GetSyncStatusIdentifiers,\n portfolioSyncedprojectsV1SyncedProject_universal_d_stopSync as stopSync,\n portfolioSyncedprojectsV1SyncedProject_universal_d_StopSyncIdentifiers as StopSyncIdentifiers,\n portfolioSyncedprojectsV1SyncedProject_universal_d_getLoginRedirectableUrl as getLoginRedirectableUrl,\n portfolioSyncedprojectsV1SyncedProject_universal_d_itemCreatedMediaCallback as itemCreatedMediaCallback,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackIdentifiers as ItemCreatedMediaCallbackIdentifiers,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ItemCreatedMediaCallbackOptions as ItemCreatedMediaCallbackOptions,\n portfolioSyncedprojectsV1SyncedProject_universal_d_projectCoverImageCreatedMediaCallback as projectCoverImageCreatedMediaCallback,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackIdentifiers as ProjectCoverImageCreatedMediaCallbackIdentifiers,\n portfolioSyncedprojectsV1SyncedProject_universal_d_ProjectCoverImageCreatedMediaCallbackOptions as ProjectCoverImageCreatedMediaCallbackOptions,\n };\n }\n \n export { portfolioCollectionsV1Collection_universal_d as collections, portfolioPortfolioAppV1PortfolioSettings_universal_d as portfolioSettings, portfolioProjectsV1ProjectInCollection_universal_d as projectInCollections, portfolioProjectItemsV1ProjectItem_universal_d as projectItems, portfolioProjectsV1Project_universal_d as projects, portfolioSyncedprojectsV1SyncedProject_universal_d as syncedProject };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecommerce-v1-additional-fees-provider.d.ts", "content": "declare module \"interfaces-ecommerce-v1-additional-fees-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface CalculateAdditionalFeesRequest {\n /**\n * Line items to calculate additional fees for.\n *\n * Max: 300 items\n */\n lineItems?: LineItem[];\n /** Shipping address. */\n shippingAddress?: Address;\n /** Information about the buyer, such as contact details. */\n buyerDetails?: BuyerDetails;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount[];\n /** Shipping information. */\n shippingInfo?: ShippingInformation;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /**\n * The business location ID associated with the items.\n * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n * @internal\n */\n businessLocationId?: string | null;\n }\n interface LineItem {\n /** Line item ID. */\n _id?: string;\n /**\n * Quantity of item.\n *\n * Min: `1`\n * Max: `100000`\n */\n quantity?: number | 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;\n /** Item name. */\n productName?: string | null;\n /** Price for a single item. */\n price?: string;\n /** Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability. */\n physicalProperties?: PhysicalProperties;\n /**\n * Partial payment to be paid upfront during the checkout.\n * Only eligible for catalog items with `lineItem.paymentOption` type of `DEPOSIT_ONLINE`.\n */\n depositAmount?: 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 [app dashboard](https://dev.wix.com/dc3/my-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 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 /** 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. */\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 /** @internal */\n location?: AddressLocation;\n /**\n * Country's full name.\n * @readonly\n */\n countryFullname?: string | null;\n /**\n * Subdivision full-name.\n * @readonly\n */\n subdivisionFullname?: string | null;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface BuyerDetails {\n /** Contact details. */\n contactDetails?: FullAddressContactDetails;\n }\n /** Full contact details for an address */\n interface FullAddressContactDetails {\n /** Contact's first name. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /**\n * Contact's full name.\n * @internal\n */\n fullName?: string | null;\n /** Contact's phone number. */\n phone?: string | null;\n /** Contact's company name. */\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 /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\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 interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {\n /** Coupon details. */\n coupon?: Coupon;\n /** Merchant discount. */\n merchantDiscount?: MerchantDiscount;\n /** Discount rule */\n discountRule?: DiscountRule;\n /** Discount type. */\n discountType?: DiscountType;\n /** IDs of line items the discount applies to. */\n lineItemIds?: string[];\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 discount. */\n GLOBAL = \"GLOBAL\",\n /** Discount on specific items. */\n SPECIFIC_ITEMS = \"SPECIFIC_ITEMS\",\n /** Discount on shipping. */\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 amount?: string;\n }\n interface MerchantDiscount {\n amount?: string;\n }\n interface DiscountRule {\n /** Discount rule ID */\n _id?: string;\n /** Discount rule name */\n name?: DiscountRuleName;\n amount?: string;\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 ShippingInformation {\n /** Selected carrier shipping option. */\n selectedCarrierServiceOption?: SelectedCarrierServiceOption;\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 /** Other charges. */\n otherCharges?: SelectedCarrierServiceOptionOtherCharge[];\n }\n interface DeliveryLogistics {\n /** Expected delivery time. For example, \"3-5 business days\". */\n deliveryTime?: string | null;\n /** Instructions for deliver. For example, \"Please deliver during open 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 /**\n * Whether the pickup address is a business. This may affect tax calculation.\n * @deprecated\n */\n businessLocation?: boolean;\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 SelectedCarrierServiceOptionPrices {\n /** Price. */\n price?: string;\n /** Total shipping discount. */\n totalDiscount?: string | null;\n }\n interface SelectedCarrierServiceOptionOtherCharge {\n /** Type of charge. */\n type?: ChargeType;\n /**\n * Details of the charge.\n *\n * Max: 200 characters\n */\n details?: string | null;\n /**\n * Cost.\n *\n * `cost` is `price` minus `totalDiscount`.\n */\n cost?: SelectedCarrierServiceOptionPrices;\n }\n enum ChargeType {\n HANDLING_FEE = \"HANDLING_FEE\",\n INSURANCE = \"INSURANCE\"\n }\n interface CalculateAdditionalFeesResponse {\n /** Additional fees calculated. */\n additionalFees?: AdditionalFee[];\n /**\n * Currency of additional fees calculated. In three-letter currency code\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n *\n * The currency returned in the response object must match the wix site's currency or those fees will\n * be filtered out and not returned. Extract the `currency` from the\n * [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-with-rest#request-envelope)\n * to ensure the correct currency is used in your calculation.\n */\n currency?: string;\n }\n /** Additional fees calculated. */\n interface AdditionalFee {\n /** Additional fee's unique code or ID. */\n code?: string | null;\n /**\n * Additional fee's name.\n *\n * Max: 50 characters\n */\n name?: string;\n /** Total additional fees. This `price` does not include any taxes that may apply to these additional fees. */\n price?: string;\n /**\n * Tax details.\n *\n * > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.\n */\n taxDetails?: TaxDetails;\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 * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** Tax details. */\n interface TaxDetails {\n /** Whether additional fee is taxable. */\n taxable?: boolean;\n /** Reserved for internal use. */\n taxGroupId?: string | null;\n }\n interface AdditionalFeesSPIConfig {\n /**\n * Whether to allow caching of the response for up to 5 minutes. Passing `false` will prevent caching, but this may affect performance.\n *\n * Default: `false`\n * @internal\n */\n cacheable?: boolean | null;\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, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\n interface Context {\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 requestId?: string | null;\n /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */\n currency?: string | null;\n /** An object that describes the identity that triggered this request. */\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. For example, `\"en-US\"`. */\n languages?: string[];\n /** The service provider app's instance ID. */\n instanceId?: string | null;\n /**\n * Extension ID in Dev Center.\n * @internal\n */\n appExtensionId?: string | null;\n /**\n * Extension type in Dev Center.\n * @internal\n */\n appExtensionType?: string | null;\n /**\n * Invoked function.\n * @internal\n */\n functionName?: 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 CalculateAdditionalFeesOptions {\n /**\n * Line items to calculate additional fees for.\n *\n * Max: 300 items\n */\n lineItems?: LineItem[];\n /** Shipping address. */\n shippingAddress?: Address;\n /** Information about the buyer, such as contact details. */\n buyerDetails?: BuyerDetails;\n /** Applied discounts. */\n appliedDiscounts?: AppliedDiscount[];\n /** Shipping information. */\n shippingInfo?: ShippingInformation;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /**\n * The business location ID associated with the items.\n * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n * @internal\n */\n businessLocationId?: string | null;\n }\n \n export { AdditionalFee, AdditionalFeesSPIConfig, Address, AddressLocation, AppliedDiscount, AppliedDiscountDiscountSourceOneOf, BusinessError, BuyerDetails, CalculateAdditionalFeesOptions, CalculateAdditionalFeesRequest, CalculateAdditionalFeesResponse, CatalogReference, ChargeType, Context, Coupon, DeliveryLogistics, DiscountRule, DiscountRuleName, DiscountType, FullAddressContactDetails, IdentificationData, IdentificationDataIdOneOf, IdentityType, LineItem, MerchantDiscount, PhysicalProperties, PickupDetails, PickupMethod, SelectedCarrierServiceOption, SelectedCarrierServiceOptionOtherCharge, SelectedCarrierServiceOptionPrices, ShippingInformation, StreetAddress, TaxDetails, VatId, VatType };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecommerce-v1-catalog-provider.d.ts", "content": "declare module \"interfaces-ecommerce-v1-catalog-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface GetCatalogItemsRequest {\n /** Catalog reference details for the items to retrieve, including quantity of each item. */\n catalogReferences?: CatalogReferenceAndQuantity[];\n /**\n * Weight measurement unit.\n *\n * By default, Wix sends the weight unit specified in the site's settings.\n */\n weightUnit?: WeightUnit;\n /**\n * Currency to return item prices in, in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, `USD` or `EUR`.\n *\n * By default, Wix sends the currency specified in the site's settings.\n */\n currency?: string;\n /**\n * The business location ID associated with the requested items.\n * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n * @internal\n */\n businessLocationId?: string | null;\n /**\n * Buyer information.\n * @internal\n */\n buyerInfo?: BuyerInfo;\n }\n interface CatalogReferenceAndQuantity {\n /** Catalog and item reference info. Holds IDs for the item and the catalog it belongs to, as well as further optional details. This is identical in the request and response. */\n catalogReference?: CatalogReference;\n /** Item quantity. */\n quantity?: number;\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 [app dashboard](https://dev.wix.com/dc3/my-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 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 /** Buyer Info */\n interface BuyerInfo extends BuyerInfoIdOneOf {\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 buyer (or cart owner) is a Wix user.\n * @readonly\n */\n userId?: string;\n /** Contact ID. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction). */\n contactId?: string | null;\n /** Buyer email address. */\n email?: string | null;\n }\n /** @oneof */\n interface BuyerInfoIdOneOf {\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 buyer (or cart owner) is a Wix user.\n * @readonly\n */\n userId?: string;\n }\n interface GetCatalogItemsResponse {\n /**\n * Details for each item, including catalog reference details and item data. Any items that don't exist in the catalog are excluded.\n * If none of the requested items exist in the catalog, this array must be empty.\n */\n catalogItems?: Item[];\n }\n interface Item {\n /** Catalog and item reference info. Holds IDs for the item and the catalog it belongs to, as well as further optional details. This is identical in the request and response. */\n catalogReference?: CatalogReference;\n /** Item data. Contains full details about the item. */\n data?: ItemData;\n }\n interface ItemData {\n /** __Required.__ Item name. */\n productName?: ProductName;\n /**\n * URL for the item's page on the site.\n *\n * This is used to link back to the relevant item page from the cart page. If not provided, the site URL is used.\n */\n url?: string;\n /** __Required.__ Item type. Either one of the preset types or a custom type. */\n itemType?: ItemType;\n /** __Required.__ Item price with discounts applied. If a catalog-defined discount applies, the discount is reflected in this price. */\n price?: string;\n /**\n * Item price **before** applying any catalog-defined discount.\n *\n * Default: Value of `price` field, if no catalog-defined discount applies.\n */\n fullPrice?: string | null;\n /** The tax group ID associated with this item. Learn more about the [Tax Groups Service Plugin](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups-integration-service-plugin/introduction). */\n taxGroupId?: string | null;\n /**\n * Line item description lines. Used for displaying the item in a cart, checkout or order. 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 * Default: No description line.\n */\n descriptionLines?: DescriptionLine[];\n /**\n * Line item image details. Supports images from the [Wix Media Manager](https://support.wix.com/en/article/wix-media-accessing-the-media-manager) only.\n *\n * To use an image from another source, first upload it to the Media Manager.\n * You can retrieve the ID, width and height of an image from the Wix Media Manager.\n */\n media?: string;\n /**\n * Quantity of the item available for purchase. Only return if the catalog manages inventory.\n * If not returned, a buyer can increase the quantity of this item to add to the cart or checkout without limit.\n */\n quantityAvailable?: number | null;\n /** Physical properties of the item. Only return for physical items. When applicable, contains information such as SKU and item weight. */\n physicalProperties?: PhysicalProperties;\n /**\n * Coupon scopes. These specify which app and items a coupon applies to.\n * Should be used by Bookings, Stores, and Events in line with the current [Coupons API](https://bo.wix.com/wix-docs/rest/stores/coupons/valid-scope-values).\n * @internal\n */\n couponScopes?: Scope[];\n /** Subscription option info. */\n subscriptionOptionInfo?: SubscriptionOptionInfo;\n /**\n * ID of the fulfiller for this item. This field is internal and only used by Stores.\n * @internal\n */\n fulfillerId?: string | null;\n /**\n * Digital file details. Required if `itemType.preset` is `DIGITAL`.\n * @internal\n */\n digitalFile?: SecuredMedia;\n /**\n * Shipping group ID. This field is internal and only used by Stores.\n * @internal\n * @readonly\n */\n shippingGroupId?: string | null;\n /**\n * Payment method selected for the item.\n *\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 selected, `price` is `0`.\n * + `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`.\n * + `MEMBERSHIP_OFFLINE`: 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 *\n * Default: `FULL_PAYMENT_ONLINE`.\n */\n paymentOption?: PaymentOptionType;\n /** Service properties. When applicable, this contains information such as time and number of participants. */\n serviceProperties?: ServiceProperties;\n /**\n * Additional ID for the item in the catalog.\n * This field provides an additional identifier for the item if your flow requires another ID as well as `catalogReference.catalogItemId`.\n * Can be used for membership validation.\n *\n * Default: Same as `catalogReference.catalogItemId`.\n */\n rootCatalogItemId?: string | null;\n /**\n * Additional description for the price. Return when additional information about the price is needed.\n *\n * For example, when `price` is `\"0\"` but additional details about the actual price are needed, such as `\"Starts at $67\"`.\n */\n priceDescription?: PriceDescription;\n /**\n * Partial payment to be paid upfront during the checkout. Return when `paymentOption` is `DEPOSIT_ONLINE`.\n *\n * Default: If `paymentOption` is `DEPOSIT_ONLINE` but `depositAmount` is not provided, the item is treated as if `paymentOption` is `FULL_PAYMENT_ONLINE`.\n */\n depositAmount?: string | null;\n /**\n * Delivery profile ID for the product.\n * @internal\n */\n deliveryProfileId?: string | null;\n /** Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page. */\n consentRequiredPaymentPolicy?: string | null;\n /**\n * Whether the price is not yet defined, and will be updated after the order is created.\n *\n * Default: `false`\n * @internal\n */\n priceUndetermined?: boolean;\n /**\n * Whether the line item quantity is fixed and cannot be changed.\n *\n * Default: `false`\n * @internal\n */\n fixedQuantity?: boolean;\n /**\n * Whether to save the payment method on the order.\n *\n * Default: `false`\n */\n savePaymentMethod?: boolean;\n /**\n * Address to be used for tax calculation.\n * @internal\n */\n taxableAddress?: TaxableAddress;\n /**\n * ID of the app managing the inventory.\n * @internal\n */\n inventoryAppId?: string | null;\n /**\n * Policies to be displayed to the customer on the checkout page.\n * @internal\n */\n policies?: Policy[];\n /**\n * Additional Fees to be added to this item calculation.\n * @internal\n */\n additionalFees?: AdditionalFee[];\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 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 interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n /**\n * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName;\n /**\n * Description line type.\n * @internal\n * @deprecated\n */\n lineType?: DescriptionLineType;\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 * Description line plain text value.\n * @internal\n * @deprecated\n */\n plainTextValue?: PlainTextValue;\n /**\n * Description line color.\n * @internal\n * @deprecated\n */\n color?: string;\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 /** Unrecognized type. */\n UNRECOGNISED = \"UNRECOGNISED\",\n /** Plain text type. */\n PLAIN_TEXT = \"PLAIN_TEXT\",\n /** Color type. */\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 Scope {\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 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 /**\n * Interval of recurring payment.\n *\n * Default: `1`.\n * If SubscriptionFrequency is Day the minimum interval is 7\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 * Whether to allow the customer to cancel the subscription..\n * @internal\n */\n enableCustomerCancellation?: boolean;\n /**\n * Period until first cycle starts. If applied payNow will be 0\n * If None => no free trial\n * @internal\n */\n freeTrialPeriod?: FreeTrialPeriod;\n /**\n * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.\n * @internal\n */\n startDate?: Date | null;\n /**\n * Whether to generate an order each billing cycle. An order will always be generated for the first billing cycle.\n * Default None => will behave like true\n * @internal\n */\n generateOrderEachBillingCycle?: boolean | 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 FreeTrialPeriod {\n /** Frequency of priod. Values: DAY, WEEK, MONTH, YEAR */\n frequency?: SubscriptionFrequency;\n /** interval of period */\n interval?: number;\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 {\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 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 checkout. The 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 {\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 | null;\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 {\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 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 interface Policy {\n /** Policy title - should be translated */\n title?: string | null;\n /** Policy content - should be translated */\n content?: string;\n }\n interface AdditionalFee {\n /** Additional fee's unique code or ID. */\n code?: string | null;\n /**\n * Additional fee's name.\n *\n * Max: 50 characters\n */\n name?: string;\n /** Total additional fees. This `price` does not include any taxes that may apply to these additional fees. */\n price?: string;\n /**\n * Tax details.\n *\n * > **Note:** Tax is not calculated in the returned `price` even when `taxDetails.taxable` is `true`.\n */\n taxDetails?: TaxDetails;\n /**\n * Number of subscription cycle this fee applies to\n * default None - all billing cycle\n * @internal\n */\n subscriptionCycles?: number | null;\n }\n /** Tax details. */\n interface TaxDetails {\n /** Whether additional fee is taxable. */\n taxable?: boolean;\n /** Reserved for internal use. */\n taxGroupId?: 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 * Optional, if exist add filter by numericId gt last_numeric_id\n * https://dev.wix.com/api/rest/wix-stores/pagination#wix-stores_pagination_pagination\n */\n lastNumericId?: string | null;\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 /**\n * Item price range - the minimum and maximum prices of all the item's variants.\n * @internal\n * @readonly\n */\n priceRange?: NumericPropertyRange;\n /** Item Media items. */\n image?: string[];\n /** The current status of the inventory */\n inStock?: boolean;\n /** current version of an item. Each time the item is modified, its `revision` changes */\n revision?: string | null;\n /**\n * True if the item has any subscription plan defined\n * @internal\n */\n isSubscription?: boolean;\n /**\n * Unique numeric ID\n * @readonly\n */\n numericId?: string | null;\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface CatalogSPIConfig {\n /** Configuration details for discounts applied to all items in the catalog. */\n allItemsDiscount?: AllItemsDiscountConfig;\n /** Configuration details for discounts applied to specific items in the catalog. */\n specificItemsDiscount?: SpecificItemsDiscountConfig;\n }\n /** Configuration for all items discount functionality in the catalog. */\n interface AllItemsDiscountConfig {\n /**\n * Whether the discount is enabled.\n *\n * Default: `false`.\n */\n enabled?: boolean;\n /**\n * Translation key for text to display to the site owner.\n * __Deprecated.__ Use `name` instead.\n * @internal\n * @deprecated Translation key for text to display to the site owner.\n * __Deprecated.__ Use `name` instead.\n * @replacedBy name\n * @targetRemovalDate 2024-05-01\n */\n translationKey?: string;\n /**\n * Translatable name for \"all items discount\" in the catalog.\n * For example, for restaurant menus, this could be \"All dishes\".\n */\n name?: string | null;\n }\n /** Configuration for discount functionality in the catalog. */\n interface SpecificItemsDiscountConfig {\n /**\n * Whether the discount is enabled.\n *\n * Default: `false`.\n */\n enabled?: boolean;\n /**\n * Translation key for text to display to the site owner. deprecated use name instead .\n * For example, for restaurant menus, this could be \"Specific dishes\".\n * @internal\n * @deprecated Translation key for text to display to the site owner. deprecated use name instead .\n * For example, for restaurant menus, this could be \"Specific dishes\".\n * @replacedBy name\n * @targetRemovalDate 2024-05-01\n */\n translationKey?: string;\n /** Translatable name for \"all items discount\" in the catalog. */\n name?: string | null;\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, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\n interface Context {\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 requestId?: string | null;\n /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */\n currency?: string | null;\n /** An object that describes the identity that triggered this request. */\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. For example, `\"en-US\"`. */\n languages?: string[];\n /** The service provider app's instance ID. */\n instanceId?: string | null;\n /**\n * Extension ID in Dev Center.\n * @internal\n */\n appExtensionId?: string | null;\n /**\n * Extension type in Dev Center.\n * @internal\n */\n appExtensionType?: string | null;\n /**\n * Invoked function.\n * @internal\n */\n functionName?: 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 GetCatalogItemsOptions {\n /** Catalog reference details for the items to retrieve, including quantity of each item. */\n catalogReferences?: CatalogReferenceAndQuantity[];\n /**\n * Weight measurement unit.\n *\n * By default, Wix sends the weight unit specified in the site's settings.\n */\n weightUnit?: WeightUnit;\n /**\n * Currency to return item prices in, in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. For example, `USD` or `EUR`.\n *\n * By default, Wix sends the currency specified in the site's settings.\n */\n currency?: string;\n /**\n * The business location ID associated with the requested items.\n * Learn more about the [Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n * @internal\n */\n businessLocationId?: string | null;\n /**\n * Buyer information.\n * @internal\n */\n buyerInfo?: BuyerInfo;\n }\n \n export { AdditionalFee, AllItemsDiscountConfig, BasicItem, BusinessError, BuyerInfo, BuyerInfoIdOneOf, CatalogReference, CatalogReferenceAndQuantity, CatalogSPIConfig, Color, Context, Description, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineValueOneOf, FileType, FreeTrialPeriod, GetCatalogItemsOptions, GetCatalogItemsRequest, GetCatalogItemsResponse, Group, IdentificationData, IdentificationDataIdOneOf, IdentityType, Item, ItemData, ItemType, ItemTypeItemType, ItemTypeItemTypeDataOneOf, NumericPropertyRange, Paging, PagingMetadata, PaymentOptionType, PhysicalProperties, PlainTextValue, Policy, PriceDescription, ProductName, QueryCatalogItemsRequest, QueryCatalogItemsResponse, Scope, SecuredMedia, ServiceProperties, SpecificItemsDiscountConfig, SubscriptionFrequency, SubscriptionOptionInfo, SubscriptionSettings, TaxDetails, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, Title, WeightUnit };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecommerce-v1-custom-trigger-provider.d.ts", "content": "declare module \"interfaces-ecommerce-v1-custom-trigger-provider\" {\n interface CustomTriggerProvider {\n }\n interface ListTriggersRequest {\n }\n interface ListTriggersResponse {\n /** List of custom triggers */\n customTriggers?: ListTriggersResponseCustomTrigger[];\n }\n interface ListTriggersResponseCustomTrigger {\n /** Unique ID of the trigger */\n _id?: string;\n /** Trigger display name */\n name?: string;\n }\n interface GetEligibleTriggersRequest {\n /** List of line items to check the triggers on */\n lineItems?: LineItem[];\n /** List of custom triggers to check 'is eligible' on */\n triggers?: TriggerToFilterBy[];\n }\n interface LineItem {\n /** Line item ID. */\n _id?: string;\n /** Quantity. */\n quantity?: number | null;\n /**\n * Optional references to the line item's origin catalog.\n * See [Catalog SPI](https://bo.wix.com/wix-docs/rest/ecommerce/catalog-spi/introduction) for more details.\n * This field is empty in the case of a custom line item.\n * currently we only use the catalog app id to set tax=0 for specific apps.\n */\n catalogReference?: CatalogReference;\n /** Price. */\n price?: string;\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 TriggerToFilterBy {\n /** Custom trigger */\n customTrigger?: CustomTrigger;\n /** Unique identifier that will return in `EligibleTrigger.identifier` to distinguish between scopes */\n identifier?: string | null;\n }\n interface CustomTrigger {\n /** Unique ID of the trigger */\n _id?: string;\n /**\n * Optional - additional data in key:value form\n * This data will be passed to `GetEligibleTriggers` SPI\n * i.e weather trigger - be eligible if temp is above 30 degrees, params will have { \"minTemp\": 30 }\n * @internal\n */\n params?: Record | null;\n }\n interface GetEligibleTriggersResponse {\n /** A List of eligible triggers and the items included in each trigger */\n eligibleTriggers?: EligibleTrigger[];\n }\n interface EligibleTrigger {\n /** The id of the trigger */\n customTriggerId?: string;\n /** Unique identifier that was assigned in `TriggerToFilterBy.identifier` to distinguish between custom triggers */\n identifier?: string | null;\n }\n interface CustomTriggerConfig {\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 GetEligibleTriggersOptions {\n /** List of line items to check the triggers on */\n lineItems?: LineItem[];\n /** List of custom triggers to check 'is eligible' on */\n triggers?: TriggerToFilterBy[];\n }\n \n export { CatalogReference, Context, CustomTrigger, CustomTriggerConfig, CustomTriggerProvider, EligibleTrigger, GetEligibleTriggersOptions, GetEligibleTriggersRequest, GetEligibleTriggersResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, LineItem, ListTriggersRequest, ListTriggersResponse, ListTriggersResponseCustomTrigger, TriggerToFilterBy };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-metro-backend.v2.d.ts", "content": "declare module \"wix-metro-backend.v2\" {\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 /**\n * A string containing the full address of this location.\n * @internal\n */\n formattedAddress?: string | null;\n /**\n * Free text to help find the address.\n * @internal\n */\n hint?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n geocode?: AddressLocation;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision[];\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 /** @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 * Apartment number.\n * @internal\n */\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 /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 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 }\n interface Variant {\n name?: string;\n value?: string;\n image?: string;\n }\n interface MyAddress {\n country?: string | null;\n subdivision?: string | null;\n city?: string | null;\n postalCode?: string | null;\n streetAddress?: StreetAddress;\n /** @internal */\n formattedAddress?: string | null;\n }\n type Product = {\n _id: string;\n name: string;\n collectionId: string;\n _createdDate: Date;\n modifiedDate: Date;\n image: string;\n address: Address;\n document: string;\n video: string;\n pageLink: PageLink;\n audio: string;\n color: string | null;\n localDate: string | null;\n localTime: string | null;\n localDateTime: string | null;\n variants: Variant[];\n mainVariant: Variant;\n customAddress: MyAddress;\n guid: string;\n };\n interface CreateProductOptions {\n product?: Product;\n }\n interface UpdateProductOptions {\n product?: Product;\n }\n interface QueryCursorResult {\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProductsQueryResult extends QueryCursorResult {\n items: Product[];\n query: ProductsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ProductsQueryBuilder {\n eq: (propertyName: string, value: any) => ProductsQueryBuilder;\n ne: (propertyName: string, value: any) => ProductsQueryBuilder;\n startsWith: (propertyName: string, value: any) => ProductsQueryBuilder;\n hasSome: (propertyName: string, value: any[]) => ProductsQueryBuilder;\n in: (propertyName: string, value: any) => ProductsQueryBuilder;\n exists: (propertyName: string, value: boolean) => ProductsQueryBuilder;\n ascending: (...propertyNames: string[]) => ProductsQueryBuilder;\n descending: (...propertyNames: string[]) => ProductsQueryBuilder;\n limit: (limit: number) => ProductsQueryBuilder;\n find: () => Promise;\n }\n \n function createProduct(options?: CreateProductOptions): Promise;\n function deleteProduct(productId: string): Promise;\n function updateProduct(productId: string, options?: UpdateProductOptions): Promise;\n function getProduct(productId: string): Promise;\n function queryProducts(): ProductsQueryBuilder;\n \n const metroinspectorV1Product_backend_d_createProduct: typeof createProduct;\n const metroinspectorV1Product_backend_d_deleteProduct: typeof deleteProduct;\n const metroinspectorV1Product_backend_d_updateProduct: typeof updateProduct;\n const metroinspectorV1Product_backend_d_getProduct: typeof getProduct;\n const metroinspectorV1Product_backend_d_queryProducts: typeof queryProducts;\n namespace metroinspectorV1Product_backend_d {\n export {\n metroinspectorV1Product_backend_d_createProduct as createProduct,\n metroinspectorV1Product_backend_d_deleteProduct as deleteProduct,\n metroinspectorV1Product_backend_d_updateProduct as updateProduct,\n metroinspectorV1Product_backend_d_getProduct as getProduct,\n metroinspectorV1Product_backend_d_queryProducts as queryProducts,\n };\n }\n \n export { metroinspectorV1Product_backend_d as products };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-metro-backend-v2.d.ts", "content": "declare module \"wix-metro-backend-v2\" {\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 /**\n * A string containing the full address of this location.\n * @internal\n */\n formattedAddress?: string | null;\n /**\n * Free text to help find the address.\n * @internal\n */\n hint?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n geocode?: AddressLocation;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision[];\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 /** @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 * Apartment number.\n * @internal\n */\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 /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 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 }\n interface Variant {\n name?: string;\n value?: string;\n image?: string;\n }\n interface MyAddress {\n country?: string | null;\n subdivision?: string | null;\n city?: string | null;\n postalCode?: string | null;\n streetAddress?: StreetAddress;\n /** @internal */\n formattedAddress?: string | null;\n }\n type Product = {\n _id: string;\n name: string;\n collectionId: string;\n _createdDate: Date;\n modifiedDate: Date;\n image: string;\n address: Address;\n document: string;\n video: string;\n pageLink: PageLink;\n audio: string;\n color: string | null;\n localDate: string | null;\n localTime: string | null;\n localDateTime: string | null;\n variants: Variant[];\n mainVariant: Variant;\n customAddress: MyAddress;\n guid: string;\n };\n interface CreateProductOptions {\n product?: Product;\n }\n interface UpdateProductOptions {\n product?: Product;\n }\n interface QueryCursorResult {\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProductsQueryResult extends QueryCursorResult {\n items: Product[];\n query: ProductsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ProductsQueryBuilder {\n eq: (propertyName: string, value: any) => ProductsQueryBuilder;\n ne: (propertyName: string, value: any) => ProductsQueryBuilder;\n startsWith: (propertyName: string, value: any) => ProductsQueryBuilder;\n hasSome: (propertyName: string, value: any[]) => ProductsQueryBuilder;\n in: (propertyName: string, value: any) => ProductsQueryBuilder;\n exists: (propertyName: string, value: boolean) => ProductsQueryBuilder;\n ascending: (...propertyNames: string[]) => ProductsQueryBuilder;\n descending: (...propertyNames: string[]) => ProductsQueryBuilder;\n limit: (limit: number) => ProductsQueryBuilder;\n find: () => Promise;\n }\n \n function createProduct(options?: CreateProductOptions): Promise;\n function deleteProduct(productId: string): Promise;\n function updateProduct(productId: string, options?: UpdateProductOptions): Promise;\n function getProduct(productId: string): Promise;\n function queryProducts(): ProductsQueryBuilder;\n \n const metroinspectorV1Product_backend_d_createProduct: typeof createProduct;\n const metroinspectorV1Product_backend_d_deleteProduct: typeof deleteProduct;\n const metroinspectorV1Product_backend_d_updateProduct: typeof updateProduct;\n const metroinspectorV1Product_backend_d_getProduct: typeof getProduct;\n const metroinspectorV1Product_backend_d_queryProducts: typeof queryProducts;\n namespace metroinspectorV1Product_backend_d {\n export {\n metroinspectorV1Product_backend_d_createProduct as createProduct,\n metroinspectorV1Product_backend_d_deleteProduct as deleteProduct,\n metroinspectorV1Product_backend_d_updateProduct as updateProduct,\n metroinspectorV1Product_backend_d_getProduct as getProduct,\n metroinspectorV1Product_backend_d_queryProducts as queryProducts,\n };\n }\n \n export { metroinspectorV1Product_backend_d as products };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-bookings-v1-pricing-provider.d.ts", "content": "declare module \"interfaces-bookings-v1-pricing-provider\" {\n interface PricingProvider {\n }\n interface CalculatePriceRequest {\n /** Booking to calculate the price for. */\n booking?: Booking;\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 * Number of participants.\n * @internal\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note\n * @internal\n */\n internalBusinessNote?: string | null;\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;\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 * @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 /**\n * An object describing the platform and application that made the booking.\n * @internal\n */\n bookingSource?: BookingSource;\n /**\n * The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.\n * @internal\n */\n participantNotification?: ParticipantNotification;\n /**\n * When value is set to True, an SMS reminder would be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.\n * @internal\n */\n sendSmsReminder?: boolean | 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;\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 * Sets the booking flow behavior. Some behaviors require permissions.\n * @internal\n */\n flowControlSettings?: FlowControlSettings;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Additional custom fields. This includes fields managed by Wix, by 3rd-party apps, and by the site.\n *\n * Empty fields are not returned.\n */\n extendedFields?: ExtendedFields;\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 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 /** Session title at the time of booking. */\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 * 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 /** The resource assigned to the slot. */\n resource?: BookedResource;\n /** Location where the slot's session takes place. */\n location?: Location;\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 {\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 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;\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://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;\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 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 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 /**\n * \n */\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 /**\n * Platform from which a booking was created\n * \n */\n platform?: Platform;\n /**\n * Actor that created this booking.\n * \n */\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 {\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 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 /** 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 * @internal\n * @readonly\n */\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 enum IdentityType {\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 the service defined booking-window in the booking policy.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n * private because it's confusing to external users - collides with skip_availability_validation\n * and yet, clients send it (though always with skip_availability_validation=true) so we're not just removing it\n * When removing, we need to use proto's `reserved` field\n * @internal\n */\n ignoreBookingWindow?: boolean;\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 {\n /**\n * Data Extensions extended fields\n * Key: Namespace\n * Value: extended fields data in Struct format\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[];\n }\n interface ServiceChoice extends ServiceChoiceChoiceOneOf {\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 {\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 CalculatePriceResponse extends CalculatePriceResponseTotalPriceOneOf {\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 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](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)'s\n * price has been set up as text value in the\n * `schedule.rate.priceText` field.\n */\n priceDescription?: string;\n /**\n * List of line items, including information about the number of participants and\n * the price per participant.\n */\n bookingLineItems?: BookingLineItem[];\n /**\n * Total deposit the customer must pay when booking the service. Provide only when\n * the service includes a deposit. Returning a `deposit` is optional. If you\n * return a `deposit` that's greater than the `calculatedPrice`, the deposit's\n * value is ignored. Instead, the customer must pay the total `calculatedPrice`\n * in full upfront as if it was a deposit.\n */\n deposit?: number | null;\n /**\n * 3-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes)\n * format. If you return a `currency`, it must be the one specified in the\n * [Site Properties](https://dev.wix.com/api/rest/business-info/site-properties/properties/get-site-properties).\n * @internal\n */\n currency?: string | null;\n }\n /** @oneof */\n interface CalculatePriceResponseTotalPriceOneOf {\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 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](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)'s\n * price has been set up as text value in the\n * `schedule.rate.priceText` field.\n */\n priceDescription?: string;\n }\n interface BookingLineItem {\n /** Service ID. */\n serviceId?: string | null;\n /** Resource ID. Required for classes and appointments. */\n resourceId?: string | null;\n /** Custom [service choices](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction). */\n choices?: ServiceChoice[];\n /** Number of participants. */\n numberOfParticipants?: number | null;\n /** Price per participant. */\n pricePerParticipant?: number | null;\n }\n interface BookingsPricingProviderConfig {\n /** Human-readable name of the your pricing integration app. */\n pricingProviderName?: 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?: ContextIdentificationData;\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 IdentificationDataIdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface ContextIdentificationData extends ContextIdentificationDataIdOneOf {\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?: IdentificationDataIdentityType;\n }\n /** @oneof */\n interface ContextIdentificationDataIdOneOf {\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 CalculatePriceOptions {\n /** Booking to calculate the price for. */\n booking?: Booking;\n }\n \n export { Actor, Address, AddressLocation, AddressStreetOneOf, BookedEntity, BookedEntityItemOneOf, BookedResource, BookedSchedule, BookedSlot, Booking, BookingLineItem, BookingParticipantsInfoOneOf, BookingSource, BookingStatus, BookingsPricingProviderConfig, CalculatePriceOptions, CalculatePriceRequest, CalculatePriceResponse, CalculatePriceResponseTotalPriceOneOf, ContactDetails, Context, ContextIdentificationData, ContextIdentificationDataIdOneOf, CustomFormField, ExtendedFields, FlowControlSettings, IdentificationData, IdentificationDataIdOneOf, IdentificationDataIdentityType, IdentityType, Location, LocationType, ParticipantChoices, ParticipantNotification, PaymentStatus, Platform, PricingProvider, SelectedPaymentOption, ServiceChoice, ServiceChoiceChoiceOneOf, ServiceChoices, StreetAddress, Subdivision, ValueType };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-motion-backend.v2.d.ts", "content": "declare module \"wix-motion-backend.v2\" {\n interface AlarmMessage {\n _id?: string;\n seconds?: number;\n }\n interface Dispatched$1 {\n /** the message someone says */\n echo?: EchoMessage$1;\n }\n interface EchoMessage$1 {\n /** message comment from EchoMessage proto def, with special comment */\n message?: string;\n /** messages_list comment from EchoMessage proto def */\n messagesList?: MessageItem$1[];\n _id?: string;\n }\n interface MessageItem$1 {\n /** inner_message comment from EchoMessage proto def */\n innerMessage?: string;\n }\n interface AlarmTestRequest {\n }\n interface AlarmTestResponse {\n }\n interface AlarmRequest {\n seconds: number;\n someString?: string;\n someOtherString?: string;\n someOtherField?: string;\n }\n interface AlarmResponse {\n time?: Date | null;\n }\n interface AlarmTriggered {\n }\n interface AlarmSnoozed {\n }\n interface AlarmDeleted {\n }\n interface UpdateAlarmRequest {\n alarm: AlarmMessage;\n /** @internal */\n fieldMask?: string[];\n }\n interface UpdateAlarmResponse {\n alarm?: AlarmMessage;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Some description\n * @public\n * @documentationMaturity preview\n * @permissionId METRO.ALARM_TEST_FAKE\n * @adminMethod\n */\n function alarmTest(): Promise;\n /**\n * sets up an alarm after {seconds}\n * @public\n * @documentationMaturity preview\n * @requiredField seconds\n * @adminMethod\n */\n function alarm(seconds: number, options?: AlarmOptions): Promise;\n interface AlarmOptions {\n someString?: string;\n someOtherString?: string;\n someOtherField?: string;\n }\n /**\n * sets up an existing alarm with id {id}\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField alarm\n * @adminMethod\n */\n function updateAlarm(_id: string, alarm: UpdateAlarm, options?: UpdateAlarmOptions): Promise;\n interface UpdateAlarm {\n _id?: string;\n seconds?: number;\n }\n interface UpdateAlarmOptions {\n /** @internal */\n fieldMask?: string[];\n }\n \n type alarmV1Alarm_universal_d_AlarmMessage = AlarmMessage;\n type alarmV1Alarm_universal_d_AlarmTestRequest = AlarmTestRequest;\n type alarmV1Alarm_universal_d_AlarmTestResponse = AlarmTestResponse;\n type alarmV1Alarm_universal_d_AlarmRequest = AlarmRequest;\n type alarmV1Alarm_universal_d_AlarmResponse = AlarmResponse;\n type alarmV1Alarm_universal_d_AlarmTriggered = AlarmTriggered;\n type alarmV1Alarm_universal_d_AlarmSnoozed = AlarmSnoozed;\n type alarmV1Alarm_universal_d_AlarmDeleted = AlarmDeleted;\n type alarmV1Alarm_universal_d_UpdateAlarmRequest = UpdateAlarmRequest;\n type alarmV1Alarm_universal_d_UpdateAlarmResponse = UpdateAlarmResponse;\n const alarmV1Alarm_universal_d_alarmTest: typeof alarmTest;\n const alarmV1Alarm_universal_d_alarm: typeof alarm;\n type alarmV1Alarm_universal_d_AlarmOptions = AlarmOptions;\n const alarmV1Alarm_universal_d_updateAlarm: typeof updateAlarm;\n type alarmV1Alarm_universal_d_UpdateAlarm = UpdateAlarm;\n type alarmV1Alarm_universal_d_UpdateAlarmOptions = UpdateAlarmOptions;\n namespace alarmV1Alarm_universal_d {\n export {\n alarmV1Alarm_universal_d_AlarmMessage as AlarmMessage,\n Dispatched$1 as Dispatched,\n EchoMessage$1 as EchoMessage,\n MessageItem$1 as MessageItem,\n alarmV1Alarm_universal_d_AlarmTestRequest as AlarmTestRequest,\n alarmV1Alarm_universal_d_AlarmTestResponse as AlarmTestResponse,\n alarmV1Alarm_universal_d_AlarmRequest as AlarmRequest,\n alarmV1Alarm_universal_d_AlarmResponse as AlarmResponse,\n alarmV1Alarm_universal_d_AlarmTriggered as AlarmTriggered,\n alarmV1Alarm_universal_d_AlarmSnoozed as AlarmSnoozed,\n alarmV1Alarm_universal_d_AlarmDeleted as AlarmDeleted,\n alarmV1Alarm_universal_d_UpdateAlarmRequest as UpdateAlarmRequest,\n alarmV1Alarm_universal_d_UpdateAlarmResponse as UpdateAlarmResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n alarmV1Alarm_universal_d_alarmTest as alarmTest,\n alarmV1Alarm_universal_d_alarm as alarm,\n alarmV1Alarm_universal_d_AlarmOptions as AlarmOptions,\n alarmV1Alarm_universal_d_updateAlarm as updateAlarm,\n alarmV1Alarm_universal_d_UpdateAlarm as UpdateAlarm,\n alarmV1Alarm_universal_d_UpdateAlarmOptions as UpdateAlarmOptions,\n };\n }\n \n interface MessageItem {\n /** inner_message comment from EchoMessage proto def */\n innerMessage?: string;\n }\n interface EchoRequest {\n /** 1st part of the message */\n arg1: string;\n /** 2nd part of the message */\n arg2?: string;\n /** this field test translatable annotation */\n titleField?: string;\n someInt32?: number;\n someDate?: Date | null;\n }\n interface EchoResponse {\n /** message result as EchoMessage */\n echoMessage?: EchoMessage;\n /** messge reseult as string */\n message?: string;\n }\n interface Dispatched {\n /** the message someone says */\n echo?: EchoMessage;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 EchoMessage {\n veloMessage: string;\n id: string;\n }\n /**\n * echo given arg1 and arg2\n * @param arg1 - 1st part of the message\n * @public\n * @documentationMaturity preview\n * @requiredField arg1\n * @param arg2 - modified comment for arg2 el hovav\n * @adminMethod\n * @returns messge reseult as string\n */\n function echo(arg1: string, options?: EchoOptions): Promise;\n interface EchoOptions {\n /** 2nd part of the message */\n arg2?: string;\n /** this field test translatable annotation */\n titleField?: string;\n someInt32?: number;\n someDate?: Date | null;\n }\n \n type metroinspectorV1Echo_universal_d_MessageItem = MessageItem;\n type metroinspectorV1Echo_universal_d_EchoRequest = EchoRequest;\n type metroinspectorV1Echo_universal_d_EchoResponse = EchoResponse;\n type metroinspectorV1Echo_universal_d_Dispatched = Dispatched;\n type metroinspectorV1Echo_universal_d_DomainEvent = DomainEvent;\n type metroinspectorV1Echo_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type metroinspectorV1Echo_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type metroinspectorV1Echo_universal_d_RestoreInfo = RestoreInfo;\n type metroinspectorV1Echo_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type metroinspectorV1Echo_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type metroinspectorV1Echo_universal_d_ActionEvent = ActionEvent;\n type metroinspectorV1Echo_universal_d_MessageEnvelope = MessageEnvelope;\n type metroinspectorV1Echo_universal_d_IdentificationData = IdentificationData;\n type metroinspectorV1Echo_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type metroinspectorV1Echo_universal_d_WebhookIdentityType = WebhookIdentityType;\n const metroinspectorV1Echo_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type metroinspectorV1Echo_universal_d_EchoMessage = EchoMessage;\n const metroinspectorV1Echo_universal_d_echo: typeof echo;\n type metroinspectorV1Echo_universal_d_EchoOptions = EchoOptions;\n namespace metroinspectorV1Echo_universal_d {\n export {\n metroinspectorV1Echo_universal_d_MessageItem as MessageItem,\n metroinspectorV1Echo_universal_d_EchoRequest as EchoRequest,\n metroinspectorV1Echo_universal_d_EchoResponse as EchoResponse,\n metroinspectorV1Echo_universal_d_Dispatched as Dispatched,\n metroinspectorV1Echo_universal_d_DomainEvent as DomainEvent,\n metroinspectorV1Echo_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n metroinspectorV1Echo_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n metroinspectorV1Echo_universal_d_RestoreInfo as RestoreInfo,\n metroinspectorV1Echo_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n metroinspectorV1Echo_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n metroinspectorV1Echo_universal_d_ActionEvent as ActionEvent,\n metroinspectorV1Echo_universal_d_MessageEnvelope as MessageEnvelope,\n metroinspectorV1Echo_universal_d_IdentificationData as IdentificationData,\n metroinspectorV1Echo_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n metroinspectorV1Echo_universal_d_WebhookIdentityType as WebhookIdentityType,\n metroinspectorV1Echo_universal_d_EchoMessage as EchoMessage,\n metroinspectorV1Echo_universal_d_echo as echo,\n metroinspectorV1Echo_universal_d_EchoOptions as EchoOptions,\n };\n }\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 /** Physical address */\n interface Address extends AddressStreetOneOf {\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 VideoResolution {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: 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 Variant {\n name?: string;\n value?: string;\n image?: string;\n }\n interface MyAddress {\n country?: string | null;\n subdivision?: string | null;\n city?: string | null;\n postalCode?: string | null;\n streetAddress?: StreetAddress;\n /** @internal */\n formatted?: string | null;\n }\n interface CreateProductRequest {\n product?: Product;\n }\n interface CreateProductResponse {\n product?: Product;\n }\n interface DeleteProductRequest {\n productId: string;\n }\n interface DeleteProductResponse {\n }\n interface UpdateProductRequest {\n productId: string;\n product?: Product;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateProductResponse {\n product?: Product;\n }\n interface GetProductRequest {\n productId: string;\n }\n interface GetProductResponse {\n product?: Product;\n }\n interface GetProductsStartWithRequest {\n title: string;\n addressLine2?: string | null;\n }\n interface GetProductsStartWithResponse {\n products?: Product[];\n }\n interface QueryProductsRequest {\n query?: QueryV2;\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 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryProductsResponse {\n products?: Product[];\n metadata?: 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 * 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 * @internal\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 BulkCreateProductsRequest {\n products: Product[];\n /** set to `true` if you wish to receive back the created products in the response */\n returnEntity?: boolean;\n }\n interface BulkCreateProductsResponse {\n results?: BulkProductResult[];\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 BulkProductResult {\n /** Defined in wix.commons */\n itemMetadata?: ItemMetadata;\n /** Only exists if `returnEntity` was set to true in the request */\n item?: Product;\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 BulkUpdateProductsRequest {\n products: MaskedProduct[];\n /** set to `true` if you wish to receive back the updated products in the response */\n returnEntity?: boolean;\n }\n interface MaskedProduct {\n /** Product to be updated, may be partial */\n product?: Product;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateProductsResponse {\n results?: BulkUpdateProductsResponseBulkProductResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkUpdateProductsResponseBulkProductResult {\n itemMetadata?: ItemMetadata;\n /** Only exists if `returnEntity` was set to true in the request */\n item?: Product;\n }\n interface BulkDeleteProductsRequest {\n productIds: string[];\n }\n interface BulkDeleteProductsResponse {\n results?: BulkDeleteProductsResponseBulkProductResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkDeleteProductsResponseBulkProductResult {\n itemMetadata?: ItemMetadata;\n }\n interface ResetProductsDbRequest {\n }\n interface ResetProductsDbResponse {\n }\n interface Product {\n _id: string;\n name: string | null;\n collectionId: string;\n _createdDate: Date | null;\n modifiedDate: Date | null;\n image: string;\n address: Address;\n document: string;\n video: string;\n pageLink: PageLink;\n audio: string;\n color: string | null;\n localDate: string | null;\n localTime: string | null;\n localDateTime: string | null;\n variants: Variant[];\n mainVariant: Variant;\n customAddress: MyAddress;\n guid: string;\n }\n /**\n * Creating a product\n * @public\n * @documentationMaturity preview\n * @requiredField options.product.title\n * @adminMethod\n */\n function createProduct(options?: CreateProductOptions): Promise;\n interface CreateProductOptions {\n product?: Product;\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField productId\n * @adminMethod\n */\n function deleteProduct(productId: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField options.product._id\n * @requiredField productId\n * @adminMethod\n */\n function updateProduct(productId: string, options?: UpdateProductOptions): Promise;\n interface UpdateProductOptions {\n product?: Product;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField productId\n * @adminMethod\n */\n function getProduct(productId: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField title\n * @adminMethod\n */\n function getProductsStartWith(title: string, options?: GetProductsStartWithOptions): Promise;\n interface GetProductsStartWithOptions {\n addressLine2?: string | null;\n }\n /** @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryProducts(options?: QueryProductsOptions): ProductsQueryBuilder;\n interface QueryProductsOptions {\n /** Whether variants should be included in the response. */\n includeVariants?: boolean | undefined;\n /** Whether hidden products should be included in the response. Requires permissions to manage products. */\n includeHiddenProducts?: boolean | undefined;\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ProductsQueryResult extends QueryCursorResult {\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 * @documentationMaturity preview\n */\n eq: (propertyName: 'title' | 'collectionId' | 'guid', value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;\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' | 'guid', value: string) => ProductsQueryBuilder;\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: 'title' | 'guid', value: any[]) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'title' | 'guid', value: any) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'title' | 'guid', value: boolean) => ProductsQueryBuilder;\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<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;\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<'title' | 'collectionId' | 'guid'>) => ProductsQueryBuilder;\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) => ProductsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * create multiple products in a single request. Works synchronously\n * @public\n * @documentationMaturity preview\n * @requiredField products\n * @adminMethod\n */\n function bulkCreateProducts(products: Product[], options?: BulkCreateProductsOptions): Promise;\n interface BulkCreateProductsOptions {\n /** set to `true` if you wish to receive back the created products in the response */\n returnEntity?: boolean;\n }\n /**\n * update multiple products in a single request. Works synchronously.\n * @public\n * @documentationMaturity preview\n * @requiredField products\n * @adminMethod\n */\n function bulkUpdateProducts(products: MaskedProduct[], options?: BulkUpdateProductsOptions): Promise;\n interface BulkUpdateProductsOptions {\n /** set to `true` if you wish to receive back the updated products in the response */\n returnEntity?: boolean;\n }\n /**\n * deletes multiple products in a single request. Works synchronously.\n * @public\n * @documentationMaturity preview\n * @requiredField productIds\n * @adminMethod\n */\n function bulkDeleteProducts(productIds: string[]): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function resetProductsDb(): Promise;\n \n type metroinspectorV1Product_universal_d_FocalPoint = FocalPoint;\n type metroinspectorV1Product_universal_d_Address = Address;\n type metroinspectorV1Product_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type metroinspectorV1Product_universal_d_StreetAddress = StreetAddress;\n type metroinspectorV1Product_universal_d_AddressLocation = AddressLocation;\n type metroinspectorV1Product_universal_d_Subdivision = Subdivision;\n type metroinspectorV1Product_universal_d_SubdivisionType = SubdivisionType;\n const metroinspectorV1Product_universal_d_SubdivisionType: typeof SubdivisionType;\n type metroinspectorV1Product_universal_d_StandardDetails = StandardDetails;\n type metroinspectorV1Product_universal_d_VideoResolution = VideoResolution;\n type metroinspectorV1Product_universal_d_PageLink = PageLink;\n type metroinspectorV1Product_universal_d_LinkRel = LinkRel;\n const metroinspectorV1Product_universal_d_LinkRel: typeof LinkRel;\n type metroinspectorV1Product_universal_d_Variant = Variant;\n type metroinspectorV1Product_universal_d_MyAddress = MyAddress;\n type metroinspectorV1Product_universal_d_CreateProductRequest = CreateProductRequest;\n type metroinspectorV1Product_universal_d_CreateProductResponse = CreateProductResponse;\n type metroinspectorV1Product_universal_d_DeleteProductRequest = DeleteProductRequest;\n type metroinspectorV1Product_universal_d_DeleteProductResponse = DeleteProductResponse;\n type metroinspectorV1Product_universal_d_UpdateProductRequest = UpdateProductRequest;\n type metroinspectorV1Product_universal_d_UpdateProductResponse = UpdateProductResponse;\n type metroinspectorV1Product_universal_d_GetProductRequest = GetProductRequest;\n type metroinspectorV1Product_universal_d_GetProductResponse = GetProductResponse;\n type metroinspectorV1Product_universal_d_GetProductsStartWithRequest = GetProductsStartWithRequest;\n type metroinspectorV1Product_universal_d_GetProductsStartWithResponse = GetProductsStartWithResponse;\n type metroinspectorV1Product_universal_d_QueryProductsRequest = QueryProductsRequest;\n type metroinspectorV1Product_universal_d_QueryV2 = QueryV2;\n type metroinspectorV1Product_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type metroinspectorV1Product_universal_d_Sorting = Sorting;\n type metroinspectorV1Product_universal_d_SortOrder = SortOrder;\n const metroinspectorV1Product_universal_d_SortOrder: typeof SortOrder;\n type metroinspectorV1Product_universal_d_Paging = Paging;\n type metroinspectorV1Product_universal_d_CursorPaging = CursorPaging;\n type metroinspectorV1Product_universal_d_QueryProductsResponse = QueryProductsResponse;\n type metroinspectorV1Product_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type metroinspectorV1Product_universal_d_Cursors = Cursors;\n type metroinspectorV1Product_universal_d_BulkCreateProductsRequest = BulkCreateProductsRequest;\n type metroinspectorV1Product_universal_d_BulkCreateProductsResponse = BulkCreateProductsResponse;\n type metroinspectorV1Product_universal_d_ItemMetadata = ItemMetadata;\n type metroinspectorV1Product_universal_d_ApplicationError = ApplicationError;\n type metroinspectorV1Product_universal_d_BulkProductResult = BulkProductResult;\n type metroinspectorV1Product_universal_d_BulkActionMetadata = BulkActionMetadata;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsRequest = BulkUpdateProductsRequest;\n type metroinspectorV1Product_universal_d_MaskedProduct = MaskedProduct;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsResponse = BulkUpdateProductsResponse;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsResponseBulkProductResult = BulkUpdateProductsResponseBulkProductResult;\n type metroinspectorV1Product_universal_d_BulkDeleteProductsRequest = BulkDeleteProductsRequest;\n type metroinspectorV1Product_universal_d_BulkDeleteProductsResponse = BulkDeleteProductsResponse;\n type metroinspectorV1Product_universal_d_BulkDeleteProductsResponseBulkProductResult = BulkDeleteProductsResponseBulkProductResult;\n type metroinspectorV1Product_universal_d_ResetProductsDbRequest = ResetProductsDbRequest;\n type metroinspectorV1Product_universal_d_ResetProductsDbResponse = ResetProductsDbResponse;\n type metroinspectorV1Product_universal_d_Product = Product;\n const metroinspectorV1Product_universal_d_createProduct: typeof createProduct;\n type metroinspectorV1Product_universal_d_CreateProductOptions = CreateProductOptions;\n const metroinspectorV1Product_universal_d_deleteProduct: typeof deleteProduct;\n const metroinspectorV1Product_universal_d_updateProduct: typeof updateProduct;\n type metroinspectorV1Product_universal_d_UpdateProductOptions = UpdateProductOptions;\n const metroinspectorV1Product_universal_d_getProduct: typeof getProduct;\n const metroinspectorV1Product_universal_d_getProductsStartWith: typeof getProductsStartWith;\n type metroinspectorV1Product_universal_d_GetProductsStartWithOptions = GetProductsStartWithOptions;\n const metroinspectorV1Product_universal_d_queryProducts: typeof queryProducts;\n type metroinspectorV1Product_universal_d_QueryProductsOptions = QueryProductsOptions;\n type metroinspectorV1Product_universal_d_ProductsQueryResult = ProductsQueryResult;\n type metroinspectorV1Product_universal_d_ProductsQueryBuilder = ProductsQueryBuilder;\n const metroinspectorV1Product_universal_d_bulkCreateProducts: typeof bulkCreateProducts;\n type metroinspectorV1Product_universal_d_BulkCreateProductsOptions = BulkCreateProductsOptions;\n const metroinspectorV1Product_universal_d_bulkUpdateProducts: typeof bulkUpdateProducts;\n type metroinspectorV1Product_universal_d_BulkUpdateProductsOptions = BulkUpdateProductsOptions;\n const metroinspectorV1Product_universal_d_bulkDeleteProducts: typeof bulkDeleteProducts;\n const metroinspectorV1Product_universal_d_resetProductsDb: typeof resetProductsDb;\n namespace metroinspectorV1Product_universal_d {\n export {\n metroinspectorV1Product_universal_d_FocalPoint as FocalPoint,\n metroinspectorV1Product_universal_d_Address as Address,\n metroinspectorV1Product_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n metroinspectorV1Product_universal_d_StreetAddress as StreetAddress,\n metroinspectorV1Product_universal_d_AddressLocation as AddressLocation,\n metroinspectorV1Product_universal_d_Subdivision as Subdivision,\n metroinspectorV1Product_universal_d_SubdivisionType as SubdivisionType,\n metroinspectorV1Product_universal_d_StandardDetails as StandardDetails,\n metroinspectorV1Product_universal_d_VideoResolution as VideoResolution,\n metroinspectorV1Product_universal_d_PageLink as PageLink,\n metroinspectorV1Product_universal_d_LinkRel as LinkRel,\n metroinspectorV1Product_universal_d_Variant as Variant,\n metroinspectorV1Product_universal_d_MyAddress as MyAddress,\n metroinspectorV1Product_universal_d_CreateProductRequest as CreateProductRequest,\n metroinspectorV1Product_universal_d_CreateProductResponse as CreateProductResponse,\n metroinspectorV1Product_universal_d_DeleteProductRequest as DeleteProductRequest,\n metroinspectorV1Product_universal_d_DeleteProductResponse as DeleteProductResponse,\n metroinspectorV1Product_universal_d_UpdateProductRequest as UpdateProductRequest,\n metroinspectorV1Product_universal_d_UpdateProductResponse as UpdateProductResponse,\n metroinspectorV1Product_universal_d_GetProductRequest as GetProductRequest,\n metroinspectorV1Product_universal_d_GetProductResponse as GetProductResponse,\n metroinspectorV1Product_universal_d_GetProductsStartWithRequest as GetProductsStartWithRequest,\n metroinspectorV1Product_universal_d_GetProductsStartWithResponse as GetProductsStartWithResponse,\n metroinspectorV1Product_universal_d_QueryProductsRequest as QueryProductsRequest,\n metroinspectorV1Product_universal_d_QueryV2 as QueryV2,\n metroinspectorV1Product_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n metroinspectorV1Product_universal_d_Sorting as Sorting,\n metroinspectorV1Product_universal_d_SortOrder as SortOrder,\n metroinspectorV1Product_universal_d_Paging as Paging,\n metroinspectorV1Product_universal_d_CursorPaging as CursorPaging,\n metroinspectorV1Product_universal_d_QueryProductsResponse as QueryProductsResponse,\n metroinspectorV1Product_universal_d_PagingMetadataV2 as PagingMetadataV2,\n metroinspectorV1Product_universal_d_Cursors as Cursors,\n metroinspectorV1Product_universal_d_BulkCreateProductsRequest as BulkCreateProductsRequest,\n metroinspectorV1Product_universal_d_BulkCreateProductsResponse as BulkCreateProductsResponse,\n metroinspectorV1Product_universal_d_ItemMetadata as ItemMetadata,\n metroinspectorV1Product_universal_d_ApplicationError as ApplicationError,\n metroinspectorV1Product_universal_d_BulkProductResult as BulkProductResult,\n metroinspectorV1Product_universal_d_BulkActionMetadata as BulkActionMetadata,\n metroinspectorV1Product_universal_d_BulkUpdateProductsRequest as BulkUpdateProductsRequest,\n metroinspectorV1Product_universal_d_MaskedProduct as MaskedProduct,\n metroinspectorV1Product_universal_d_BulkUpdateProductsResponse as BulkUpdateProductsResponse,\n metroinspectorV1Product_universal_d_BulkUpdateProductsResponseBulkProductResult as BulkUpdateProductsResponseBulkProductResult,\n metroinspectorV1Product_universal_d_BulkDeleteProductsRequest as BulkDeleteProductsRequest,\n metroinspectorV1Product_universal_d_BulkDeleteProductsResponse as BulkDeleteProductsResponse,\n metroinspectorV1Product_universal_d_BulkDeleteProductsResponseBulkProductResult as BulkDeleteProductsResponseBulkProductResult,\n metroinspectorV1Product_universal_d_ResetProductsDbRequest as ResetProductsDbRequest,\n metroinspectorV1Product_universal_d_ResetProductsDbResponse as ResetProductsDbResponse,\n metroinspectorV1Product_universal_d_Product as Product,\n metroinspectorV1Product_universal_d_createProduct as createProduct,\n metroinspectorV1Product_universal_d_CreateProductOptions as CreateProductOptions,\n metroinspectorV1Product_universal_d_deleteProduct as deleteProduct,\n metroinspectorV1Product_universal_d_updateProduct as updateProduct,\n metroinspectorV1Product_universal_d_UpdateProductOptions as UpdateProductOptions,\n metroinspectorV1Product_universal_d_getProduct as getProduct,\n metroinspectorV1Product_universal_d_getProductsStartWith as getProductsStartWith,\n metroinspectorV1Product_universal_d_GetProductsStartWithOptions as GetProductsStartWithOptions,\n metroinspectorV1Product_universal_d_queryProducts as queryProducts,\n metroinspectorV1Product_universal_d_QueryProductsOptions as QueryProductsOptions,\n metroinspectorV1Product_universal_d_ProductsQueryResult as ProductsQueryResult,\n metroinspectorV1Product_universal_d_ProductsQueryBuilder as ProductsQueryBuilder,\n metroinspectorV1Product_universal_d_bulkCreateProducts as bulkCreateProducts,\n metroinspectorV1Product_universal_d_BulkCreateProductsOptions as BulkCreateProductsOptions,\n metroinspectorV1Product_universal_d_bulkUpdateProducts as bulkUpdateProducts,\n metroinspectorV1Product_universal_d_BulkUpdateProductsOptions as BulkUpdateProductsOptions,\n metroinspectorV1Product_universal_d_bulkDeleteProducts as bulkDeleteProducts,\n metroinspectorV1Product_universal_d_resetProductsDb as resetProductsDb,\n };\n }\n \n export { alarmV1Alarm_universal_d as alarms, metroinspectorV1Echo_universal_d as metroinspector, metroinspectorV1Product_universal_d as products };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecommerce-v1-custom-scopes-provider.d.ts", "content": "declare module \"interfaces-ecommerce-v1-custom-scopes-provider\" {\n interface CustomScopesProvider {\n }\n interface GetScopesRequest {\n }\n interface GetScopesResponse {\n /** A list of scopes */\n scopes?: CustomScope[];\n }\n interface CustomScope {\n /** The id of this scope. This should be a unique id for the implementer */\n _id?: string;\n /**\n * The name of the scope, for example: \"Specific Collections, \"Specific Sizes\"\n * Wix applications implementing this SPI should return the translation key of the scopes name,\n * and make sure to add translations to this key the scopes SPI host\n * External implementation should return the English name of the scope\n */\n nameTranslationKey?: string;\n /**\n * Optional - the app_id of the catalog this scope is applied on.\n * This should be the app_id of the catalog this filter applies on, if there is one.\n * If this scope applies on more than one catalog, or does not related to a catalog - this field can be empty\n */\n catalogAppId?: string | null;\n /**\n * Optional - additional data used in order to generate and resolve the the discount scope.\n * If this scope represents \"specific\" items (collections, seasons, months, etc) - this should be defined with:\n * title: a title to the selectable items (for example: \"specific collections\"),\n * type: \"multi_select\",\n * custom_filter_params_struct: {\"field_name\" : fieldName},\n * where fieldName is the name of the field that will hold the selected items in the scope\n * For example, \"Specific collections\" filter would have {\"field_name\" : \"collectionIds\"}\n */\n filterAdditionalData?: FilterAdditionalData;\n }\n /** Additional data of the scope - for the scope's query of type CATALOG_ITEM or CUSTOM_FILTER */\n interface FilterAdditionalData {\n /** The translated title of the list of scope items, for example: \"Specific collections\" */\n title?: string;\n /** The type of the additional data, for example: \"multi_select\" */\n type?: string;\n /**\n * Optional - the object structure for customFilter.params (in discount scope).\n * For example, \"Specific collections\" filter would have {\"field_name\" : \"collectionIds\"} under this filed,\n * which will make the UI set scope.customFilter.params to { \"collectionIds\": [...]}\n * Will be returned for scopes of type CUSTOM_FILTER only\n */\n customFilterParamsStruct?: Record | null;\n }\n interface ListScopeItemsRequest {\n /** Id of the Scope to retrieve */\n scopeId: string;\n /** A list of itemIDs to filter by. If exists, the result will only include the items with the IDs passed. */\n itemIds?: string[];\n /** An item name to filter by. If exists, the result will only include items with name that include this string. */\n itemName?: 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 ListScopeItemsResponse {\n /** A list of the Scope Items */\n scopeItems?: ScopeItem[];\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n offset?: number | null;\n }\n interface ScopeItem {\n /** The ID of the the item */\n _id?: string;\n /** The translated name of the item */\n name?: string;\n }\n interface GetAppliedScopesRequest {\n /** A list of scope to filter the line items by */\n scopes?: ScopeToFilterBy[];\n /**\n * References to the line item's origin catalog to check if included in one of the scopes provided.\n * See [Catalog SPI](https://bo.wix.com/wix-docs/rest/ecommerce/catalog-spi/introduction) for more details.\n */\n catalogReference?: CatalogReference[];\n }\n interface ScopeToFilterBy {\n /** The ID of the the scope to filter items by */\n scopeId?: string;\n /** The scope's custom filter values */\n customFilterParams?: Record | null;\n /** Unique identifier that will return in `AppliedItemsByScopes.identifier` to distinguish between scopes in the response */\n identifier?: 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 GetAppliedScopesResponse {\n /** A list of items and the scopes they included in */\n appliedItemsByScopes?: AppliedItemsByScopes[];\n }\n interface AppliedItemsByScopes {\n /** Id of the scope the provided items are valid for */\n scopeId?: string;\n /** A list of items that matches the scope */\n catalogReferences?: CatalogReference[];\n /** Unique identifier that was assigned in `ScopeToFilterBy.identifier` to distinguish between scopes */\n identifier?: string | null;\n }\n interface CustomScopeConfig {\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 ListScopeItemsOptions {\n /** A list of itemIDs to filter by. If exists, the result will only include the items with the IDs passed. */\n itemIds?: string[];\n /** An item name to filter by. If exists, the result will only include items with name that include this string. */\n itemName?: string | null;\n /** Paging options to limit and skip a number of items. */\n paging?: Paging;\n }\n interface GetAppliedScopesOptions {\n /** A list of scope to filter the line items by */\n scopes?: ScopeToFilterBy[];\n /**\n * References to the line item's origin catalog to check if included in one of the scopes provided.\n * See [Catalog SPI](https://bo.wix.com/wix-docs/rest/ecommerce/catalog-spi/introduction) for more details.\n */\n catalogReference?: CatalogReference[];\n }\n \n export { AppliedItemsByScopes, CatalogReference, Context, CustomScope, CustomScopeConfig, CustomScopesProvider, FilterAdditionalData, GetAppliedScopesOptions, GetAppliedScopesRequest, GetAppliedScopesResponse, GetScopesRequest, GetScopesResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, ListScopeItemsOptions, ListScopeItemsRequest, ListScopeItemsResponse, Paging, ScopeItem, ScopeToFilterBy };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-bookings-backend.v2.d.ts", "content": "declare module \"wix-bookings-backend.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 /** 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[];\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;\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 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 * Start time of the first session in the schedule.\n * @internal\n * @readonly\n */\n firstSessionStart?: Date;\n /**\n * End time of the last session in the schedule.\n * @internal\n * @readonly\n */\n lastSessionEnd?: Date;\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 * 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;\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 and will be removed soon. */\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 and will be removed soon. */\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 * The schedule version, updated each time the schedule or the schedule participants are updated.\n * @internal\n * @readonly\n */\n versions?: Version;\n /**\n * Fields which were inherited from the Business Info page under Settings in the Dashboard.\n * @readonly\n */\n inheritedFields?: string[];\n /** Deprecated and will be removed soon. */\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 * The name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * Currently, in Bookings system, it would be present when the schedule is owned by a staff resource and the resource is connected to a user.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 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 * The name of the linked schedule owner. It may be a resource name or a service name. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the linked schedule owner. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 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 interface Location {\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;\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 * The Wix Business location formatted address.\n * Valid when `locationType` is `OWNER_BUSINESS`. Defaults to the business's location.\n * To retrieve the full location data please use the [Locations API](https://dev.wix.com/api/rest/business-info/locations).\n * @internal\n */\n businessLocation?: LocationsLocation;\n }\n enum LocationType {\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 /** Location type. **Note:** Currently not supported. */\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 }\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 }\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 }\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 * Default service price. Always vailable when a service has\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Sometimes also available for services without variants.\n * Ignored in [updates to a service](https://dev.wix.com/api/rest/wix-bookings/services/service/update-service),\n * when either `labeled_price_options` or `price_text` is also specified.\n * @internal\n */\n defaultVariedPrice?: Price;\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 /**\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 * Not supported yet.\n * A list of possible locations for the session when `use_default_location` is set to `false`. Slots are generated for each location. Only one of the possible locations can be chosen by the customer.\n *\n * **NOTE**: When using the `locations` parameter, the default location is not automatically included in the list.\n * @internal\n */\n locations?: Location[];\n /**\n * Not supported yet.\n * Whether the schedule's slots are only available at the schedule's default location, as set in `schedule.location`. If set to `false`, the `locations` array is used to set the possible locations of the schedule's sessions.\n * Default is `true`.\n * @internal\n */\n useDefaultLocation?: boolean | null;\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 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 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 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 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 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 ListResourcesRequest {\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 ListResourcesResponse {\n /** List of resources matching the query object. */\n resources?: Resource[];\n metadata?: QueryMetaData;\n pagingMetadata?: PagingMetadataV2;\n }\n interface QueryMetaData {\n items?: number;\n offset?: number;\n totalCount?: number;\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 * 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 * @internal\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 QueryResourcesRequest {\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 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 /** 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 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 QueryResourcesResponse {\n /** List of resources matching the query object. */\n resources?: Resource[];\n pagingMetadata?: PagingMetadataV2;\n }\n interface CreateResourceRequest {\n /** Resource details. */\n resource: 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?: Schedule[];\n }\n interface CreateResourceResponse {\n /** Resource details. */\n resource?: Resource;\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 enum Event {\n UNDEFINED = \"UNDEFINED\",\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\",\n Schedule_Updated = \"Schedule_Updated\"\n }\n interface BatchCreateResourceRequest {\n /** List of resource entities to create. */\n resources?: Resource[];\n /** Optional. If provided, the resources field is ignored. */\n batchedResources?: CreateResourceRequest[];\n }\n interface BatchCreateResourceResponse {\n /** List of the created resources. */\n resources?: Resource[];\n }\n interface UpdateResourceRequest {\n /** Resource details. */\n resource?: Resource;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /**\n * Actions to perform on the resources schedules. Can contain schedules to create, update, and cancel.\n * Either the 'schedules' or 'schedule_actions' should be specified but not both. If both are provided, the schedules in the resource entity is ignored.\n * @internal\n */\n scheduleActions?: BatchRequest;\n }\n interface BatchRequest {\n /** Create multiple schedules. */\n createRequests?: CreateScheduleRequest[];\n /** Update multiple schedules. Not Supported yet. */\n updateRequests?: UpdateScheduleRequest[];\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?: CancelScheduleRequest[];\n }\n /** schedule */\n interface CreateScheduleRequest {\n /** Schedule. */\n schedule?: Schedule;\n }\n interface UpdateScheduleRequest {\n /** Schedule. */\n schedule?: Schedule;\n /** Field mask of fields to update. */\n fieldMask?: string[];\n /** Optional. Defaults to false. In case of updated intervals' start time, this field indicates whether to align those interval's time exceptions. */\n alignTimeExceptions?: boolean;\n /** Deprecated, use participant_notification. */\n notifyParticipants?: boolean;\n /** Whether to notify participants about the change, and an optional custom message. */\n participantNotification?: ParticipantNotification;\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 CancelScheduleRequest {\n /** Schedule ID. */\n scheduleId?: string;\n /** Time to cancel the sessions from. Optional. If this field is empty, all of this schedule's sessions will be canceled. */\n from?: Date;\n /** Whether to preserve future sessions with reservations. Defaults to false. */\n preserveFutureSessionsWithParticipants?: boolean;\n /** Deprecated, use participant_notification */\n notifyParticipants?: boolean;\n /** Whether to notify participants about the change, and an optional custom message. */\n participantNotification?: ParticipantNotification;\n }\n interface UpdateResourceResponse {\n /** Resource details. */\n resource?: Resource;\n /** Updated Schedules */\n schedules?: BatchResponse;\n }\n interface BatchResponse {\n /** Created schedules. */\n created?: Schedule[];\n /** Updated schedules. */\n updated?: Schedule[];\n /** Cancelled schedules. */\n cancelled?: Schedule[];\n }\n interface ResourceUpdateScheduleRequest {\n /** Resource id to update. */\n resourceId: string | null;\n /** Fieldmask for schedule */\n fieldmask?: string[];\n /** The schedule to update */\n schedule?: Schedule;\n }\n interface UpdateScheduleResponse {\n /** The updated schedule. */\n schedule?: Schedule;\n }\n interface DeleteResourceRequest {\n /** ID of the resource to delete. */\n _id: string;\n }\n interface DeleteResourceResponse {\n /** Deleted resource id */\n _id?: string;\n }\n interface BatchDeleteResourceRequest {\n /** List of resource IDs to delete. */\n ids: string[];\n }\n interface BatchDeleteResourceResponse {\n }\n interface LinkResourceToUserRequest {\n /** The id of the resource to link. */\n resourceId: string | null;\n /** The id of Wix user to link. */\n userId: string | null;\n }\n interface LinkResourceToUserResponse {\n /** The updated resource. */\n resource?: Resource;\n }\n interface UnLinkResourceFromOwnerRequest {\n /** The id of the resource to unlink. */\n resourceId: string | null;\n }\n interface UnLinkResourceFromOwnerResponse {\n /** The updated resource. */\n resource?: Resource;\n }\n /**\n * > **Deprecation Notice**\n * >\n * > **This endpoint has been replaced with [Query Resource](https://dev.wix.com/api/rest/wix-bookings/resources/list-resources/query-resource) and will be removed on March 31, 2022.**\n * > **If your app uses this endpoint, we recommend updating your code as soon as possible.**\n *\n * Retrieves a list of the resources according to the provided filters and paging.\n * \n * This query is optional. If no query is provided than all non-deleted resources are returned.\n *\n * |Property|Is supported|\n * |--|--|\n * |filter | supports `resource.id`, `resource.tag`, `resource.status`|\n * |paging | supported |\n * |fields | supported |\n * |fieldsets | **not supported** |\n * |sort| **not supported** |\n *\n * > **Permissions**\n * > This endpoint requires the Read Bookings Calendar, Read Bookings - Public Data, Read Bookings - Including Participants or Manage Bookings permission scope.\n * \n * @public\n * @documentationMaturity preview\n */\n function list(options?: ListOptions): Promise;\n interface ListOptions {\n query?: Query;\n }\n /**\n * Retrieves a list of the resources according to the specified filters and paging.\n *\n * The query parameter is optional. If no query is provided than all non-deleted resources are returned.\n *\n * |Property|Is supported|\n * |--|--|\n * |filter | supported fields: `resource.id`, `resource.tags`, `resource.status`|\n * |paging | supported |\n * |fields | supported |\n * |fieldsets | **not supported** |\n * |sort | **not supported** |\n *\n *\n * >**Notes:**\n * > + The following objects in the `query` parameter are not supported for this query:\n * > - `sort`\n * > - `fieldsets`\n *\n * > **Permissions**\n * > This endpoint requires the Read Bookings Calendar, Read Bookings - Public Data, Read Bookings - Including Participants or Manage Bookings permission scope.\n * @public\n * @documentationMaturity preview\n */\n function query(options?: QueryOptions): Promise;\n interface QueryOptions {\n query?: QueryV2;\n }\n /**\n * Creates a resource.\n * \n *\n * Bookings resources are created with a schedule. The schedule and its sessions determine the resource's availability. Note that the schedule must contain a start date in the `availability.start` property.\n * For resources that are available during the business's default hours, add the business's schedule as a linked schedule in the resource's schedule. For resources that have their own hours, create sessions with type `\"WORKING_HOURS\"` using the resource's schedule.\n * You can use both individual and recurring sessions to define resource availability. You cannot use availability constraints for resource schedules.\n *\n * \n *\n * \n * Use the following steps to create resources:\n * - Create the resource using including schedule information.\n * - If the resource uses the default business hours, get the business resource's schedule ID and include it in the `scheduleInfo.availability.linkedSchedules` array in the in the schedule parameters.\n * - If the resource has its own custom working hours, create sessions of type `\"WORKING_HOURS\"`. Use the `scheduleId` of the new resource when creating the sessions. These session can be single sessions or recurring sessions. You can have both business hours and custom hours for the same resource schedule.\n *\n * >**Notes:**\n * > + A resource can have one schedule only.\n * > + You can have up to 135 active resources and an additional 135 deleted resources.\n * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.\n *\n *\n *\n * >**Permissions:**\n * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).\n * \n * @param resource - Resource details.\n * @public\n * @documentationMaturity preview\n * @requiredField options.schedules.availability.start\n * @requiredField options.schedules.intervals.start\n * @requiredField resource\n * @requiredField resource.name\n */\n function create(resource: Resource, options?: CreateOptions): Promise;\n interface CreateOptions {\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?: Schedule[];\n }\n /**\n * Creates multiple resources with corresponding schedules.\n * @internal\n * @documentationMaturity preview\n */\n function batchCreate(options?: BatchCreateOptions): Promise;\n interface BatchCreateOptions {\n /** List of resource entities to create. */\n resources?: Resource[];\n /** Optional. If provided, the resources field is ignored. */\n batchedResources?: CreateResourceRequest[];\n }\n /**\n * Updates a resource.\n * \n * \n * Use this endpoint to update all resource information except for the resource's schedule. To update a resource's schedule use\n * the [Update Schedule](https://dev.wix.com/api/rest/wix-bookings/resources/update-schedule) endpoint.\n *\n * >**Notes:**\n * > + When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `\"business\"` and `\"staff\"`.\n * > + When updating a resource's schedule you cannot change the resource tag used by the Wix Bookings app. Tags used by the app have the values `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE”`.\n * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.\n *\n * >**Permissions:**\n * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).\n * \n * @param _id - Resource ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.scheduleActions.cancelRequests.scheduleId\n * @requiredField options.scheduleActions.createRequests.schedule.availability.start\n * @requiredField options.scheduleActions.createRequests.schedule.intervals.start\n * @requiredField options.scheduleActions.createRequests.schedule.scheduleOwnerId\n * @requiredField options.scheduleActions.updateRequests.schedule._id\n */\n function update(_id: string | null, options?: UpdateOptions): Promise;\n interface UpdateOptions {\n 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 /** 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[];\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;\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 /** Field mask of fields to update. */\n fieldMask?: string[];\n /**\n * Actions to perform on the resources schedules. Can contain schedules to create, update, and cancel.\n * Either the 'schedules' or 'schedule_actions' should be specified but not both. If both are provided, the schedules in the resource entity is ignored.\n * @internal\n */\n scheduleActions?: BatchRequest;\n }\n /**\n * Updates a resource's schedule\n * \n *\n * To update a resource's schedule to remove business hours and add custom hours:\n * \n * + Update the resource's schedule to remove the business's `scheduleId` from the `availability.linkedSchedules` array.\n * + Create a set of recurring sessions of type `\"WORKING_HOURS\"` to define the resource's new hours.\n * \n * \n *\n * To update a resource's schedule to add default business hours, and keep or remove custom hours:\n * \n * + Update the resource's schedule to add the business resource's `scheduleId` to the `availability.linkedSchedules` array.\n * + If you want to remove the custom sessions, delete the resource's sessions of type `\"WORKING_HOURS\"`.\n * You do not have to delete exiting custom sessions. Custom session that are not deleted will continue to be included in availability calculations and can still be booked.\n * \n * \n * \n * >**Notes:**\n * > + A resource can have one schedule only.\n * > + A resource can have both default business hours and custom hours in its schedule.\n * > + When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `\"INDIVIDUAL\"`, `\"GROUP\"`, and `\"COURSE”`.\n * > + The `businessLocation.businessSchedule` object in the `schedule.location` object is not supported.\n *\n *\n *\n * >**Permissions:**\n * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).\n * \n * @param resourceId - Resource id to update.\n * @public\n * @documentationMaturity preview\n * @requiredField options.schedule._id\n * @requiredField resourceId\n */\n function updateSchedule(resourceId: string | null, options?: UpdateScheduleOptions): Promise;\n interface UpdateScheduleOptions {\n /** Fieldmask for schedule */\n fieldmask?: string[];\n /** The schedule to update */\n schedule?: Schedule;\n }\n /**\n * Deletes a resource.\n * \n * Deleting a resource updates its `status` to `\"DELETED\"`.\n *\n * You cannot delete a resource if it has booked sessions.\n *\n * \n *\n * \n * >**Notes:**\n * > + The Bookings app creates a resource with `\"business\"` in name and tag values. This resource is used for the business's schedule and working hours and cannot be deleted.\n * > + You can have up to 135 active resources and an additional 135 deleted resources.\n *\n * >**Permissions:**\n * > This endpoint requires the Manage Bookings [permission scope](https://devforum.wix.com/kb/en/article/available-permissions).\n * \n * @param _id - ID of the resource to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function _delete(_id: string): Promise;\n /** @param ids - List of resource IDs to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n */\n function batchDelete(ids: string[]): Promise;\n /**\n * Links a resource to a Wix user.\n * The user will be assigned with the `Bookings Staff Member` role, via the `SitePoliciesManagement.AssignPolicies` API.\n *\n * Preconditions:\n * - The resource must not be linked to a user, or an active invite.\n * - The user must be a site contributor\n * - The user must not be linked to another resource.\n *\n * Note:\n * The site owner may be linked to a resource, but will not be assigned with the 'Bookings Staff Member' role.\n * @param resourceId - The id of the resource to link.\n * @param userId - The id of Wix user to link.\n * @internal\n * @documentationMaturity preview\n * @requiredField resourceId\n * @requiredField userId\n */\n function linkResourceToUser(resourceId: string | null, userId: string | null): Promise;\n /**\n * Unlink a resource from the site owner.\n * @param resourceId - The id of the resource to unlink.\n * @internal\n * @documentationMaturity preview\n * @requiredField resourceId\n */\n function unLinkResourceFromOwner(resourceId: string | null): Promise;\n \n const bookingsCatalogV1Resource_universal_d___debug: typeof __debug;\n type bookingsCatalogV1Resource_universal_d_Resource = Resource;\n type bookingsCatalogV1Resource_universal_d_Schedule = Schedule;\n type bookingsCatalogV1Resource_universal_d_RecurringInterval = RecurringInterval;\n type bookingsCatalogV1Resource_universal_d_Interval = Interval;\n type bookingsCatalogV1Resource_universal_d_Day = Day;\n const bookingsCatalogV1Resource_universal_d_Day: typeof Day;\n type bookingsCatalogV1Resource_universal_d_Frequency = Frequency;\n type bookingsCatalogV1Resource_universal_d_LinkedSchedule = LinkedSchedule;\n type bookingsCatalogV1Resource_universal_d_Transparency = Transparency;\n const bookingsCatalogV1Resource_universal_d_Transparency: typeof Transparency;\n type bookingsCatalogV1Resource_universal_d_RecurringIntervalType = RecurringIntervalType;\n const bookingsCatalogV1Resource_universal_d_RecurringIntervalType: typeof RecurringIntervalType;\n type bookingsCatalogV1Resource_universal_d_Location = Location;\n type bookingsCatalogV1Resource_universal_d_LocationType = LocationType;\n const bookingsCatalogV1Resource_universal_d_LocationType: typeof LocationType;\n type bookingsCatalogV1Resource_universal_d_Address = Address;\n type bookingsCatalogV1Resource_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type bookingsCatalogV1Resource_universal_d_StreetAddress = StreetAddress;\n type bookingsCatalogV1Resource_universal_d_AddressLocation = AddressLocation;\n type bookingsCatalogV1Resource_universal_d_Subdivision = Subdivision;\n type bookingsCatalogV1Resource_universal_d_LocationsLocation = LocationsLocation;\n type bookingsCatalogV1Resource_universal_d_LocationStatus = LocationStatus;\n const bookingsCatalogV1Resource_universal_d_LocationStatus: typeof LocationStatus;\n type bookingsCatalogV1Resource_universal_d_LocationsLocationType = LocationsLocationType;\n const bookingsCatalogV1Resource_universal_d_LocationsLocationType: typeof LocationsLocationType;\n type bookingsCatalogV1Resource_universal_d_LocationsAddress = LocationsAddress;\n type bookingsCatalogV1Resource_universal_d_LocationsStreetAddress = LocationsStreetAddress;\n type bookingsCatalogV1Resource_universal_d_LocationsAddressLocation = LocationsAddressLocation;\n type bookingsCatalogV1Resource_universal_d_BusinessSchedule = BusinessSchedule;\n type bookingsCatalogV1Resource_universal_d_TimePeriod = TimePeriod;\n type bookingsCatalogV1Resource_universal_d_DayOfWeek = DayOfWeek;\n const bookingsCatalogV1Resource_universal_d_DayOfWeek: typeof DayOfWeek;\n type bookingsCatalogV1Resource_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type bookingsCatalogV1Resource_universal_d_Rate = Rate;\n type bookingsCatalogV1Resource_universal_d_Price = Price;\n type bookingsCatalogV1Resource_universal_d_Availability = Availability;\n type bookingsCatalogV1Resource_universal_d_AvailabilityConstraints = AvailabilityConstraints;\n type bookingsCatalogV1Resource_universal_d_SplitInterval = SplitInterval;\n type bookingsCatalogV1Resource_universal_d_Participant = Participant;\n type bookingsCatalogV1Resource_universal_d_ApprovalStatus = ApprovalStatus;\n const bookingsCatalogV1Resource_universal_d_ApprovalStatus: typeof ApprovalStatus;\n type bookingsCatalogV1Resource_universal_d_ExternalCalendarOverrides = ExternalCalendarOverrides;\n type bookingsCatalogV1Resource_universal_d_ScheduleStatus = ScheduleStatus;\n const bookingsCatalogV1Resource_universal_d_ScheduleStatus: typeof ScheduleStatus;\n type bookingsCatalogV1Resource_universal_d_Version = Version;\n type bookingsCatalogV1Resource_universal_d_ConferenceProvider = ConferenceProvider;\n type bookingsCatalogV1Resource_universal_d_CalendarConference = CalendarConference;\n type bookingsCatalogV1Resource_universal_d_ConferenceType = ConferenceType;\n const bookingsCatalogV1Resource_universal_d_ConferenceType: typeof ConferenceType;\n type bookingsCatalogV1Resource_universal_d_ResourceStatus = ResourceStatus;\n const bookingsCatalogV1Resource_universal_d_ResourceStatus: typeof ResourceStatus;\n type bookingsCatalogV1Resource_universal_d_ListResourcesRequest = ListResourcesRequest;\n type bookingsCatalogV1Resource_universal_d_Query = Query;\n type bookingsCatalogV1Resource_universal_d_Sorting = Sorting;\n type bookingsCatalogV1Resource_universal_d_SortOrder = SortOrder;\n const bookingsCatalogV1Resource_universal_d_SortOrder: typeof SortOrder;\n type bookingsCatalogV1Resource_universal_d_Paging = Paging;\n type bookingsCatalogV1Resource_universal_d_ListResourcesResponse = ListResourcesResponse;\n type bookingsCatalogV1Resource_universal_d_QueryMetaData = QueryMetaData;\n type bookingsCatalogV1Resource_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type bookingsCatalogV1Resource_universal_d_Cursors = Cursors;\n type bookingsCatalogV1Resource_universal_d_QueryResourcesRequest = QueryResourcesRequest;\n type bookingsCatalogV1Resource_universal_d_QueryV2 = QueryV2;\n type bookingsCatalogV1Resource_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type bookingsCatalogV1Resource_universal_d_CursorPaging = CursorPaging;\n type bookingsCatalogV1Resource_universal_d_QueryResourcesResponse = QueryResourcesResponse;\n type bookingsCatalogV1Resource_universal_d_CreateResourceRequest = CreateResourceRequest;\n type bookingsCatalogV1Resource_universal_d_CreateResourceResponse = CreateResourceResponse;\n type bookingsCatalogV1Resource_universal_d_ResourceNotification = ResourceNotification;\n type bookingsCatalogV1Resource_universal_d_Event = Event;\n const bookingsCatalogV1Resource_universal_d_Event: typeof Event;\n type bookingsCatalogV1Resource_universal_d_BatchCreateResourceRequest = BatchCreateResourceRequest;\n type bookingsCatalogV1Resource_universal_d_BatchCreateResourceResponse = BatchCreateResourceResponse;\n type bookingsCatalogV1Resource_universal_d_UpdateResourceRequest = UpdateResourceRequest;\n type bookingsCatalogV1Resource_universal_d_BatchRequest = BatchRequest;\n type bookingsCatalogV1Resource_universal_d_CreateScheduleRequest = CreateScheduleRequest;\n type bookingsCatalogV1Resource_universal_d_UpdateScheduleRequest = UpdateScheduleRequest;\n type bookingsCatalogV1Resource_universal_d_ParticipantNotification = ParticipantNotification;\n type bookingsCatalogV1Resource_universal_d_CancelScheduleRequest = CancelScheduleRequest;\n type bookingsCatalogV1Resource_universal_d_UpdateResourceResponse = UpdateResourceResponse;\n type bookingsCatalogV1Resource_universal_d_BatchResponse = BatchResponse;\n type bookingsCatalogV1Resource_universal_d_ResourceUpdateScheduleRequest = ResourceUpdateScheduleRequest;\n type bookingsCatalogV1Resource_universal_d_UpdateScheduleResponse = UpdateScheduleResponse;\n type bookingsCatalogV1Resource_universal_d_DeleteResourceRequest = DeleteResourceRequest;\n type bookingsCatalogV1Resource_universal_d_DeleteResourceResponse = DeleteResourceResponse;\n type bookingsCatalogV1Resource_universal_d_BatchDeleteResourceRequest = BatchDeleteResourceRequest;\n type bookingsCatalogV1Resource_universal_d_BatchDeleteResourceResponse = BatchDeleteResourceResponse;\n type bookingsCatalogV1Resource_universal_d_LinkResourceToUserRequest = LinkResourceToUserRequest;\n type bookingsCatalogV1Resource_universal_d_LinkResourceToUserResponse = LinkResourceToUserResponse;\n type bookingsCatalogV1Resource_universal_d_UnLinkResourceFromOwnerRequest = UnLinkResourceFromOwnerRequest;\n type bookingsCatalogV1Resource_universal_d_UnLinkResourceFromOwnerResponse = UnLinkResourceFromOwnerResponse;\n const bookingsCatalogV1Resource_universal_d_list: typeof list;\n type bookingsCatalogV1Resource_universal_d_ListOptions = ListOptions;\n const bookingsCatalogV1Resource_universal_d_query: typeof query;\n type bookingsCatalogV1Resource_universal_d_QueryOptions = QueryOptions;\n const bookingsCatalogV1Resource_universal_d_create: typeof create;\n type bookingsCatalogV1Resource_universal_d_CreateOptions = CreateOptions;\n const bookingsCatalogV1Resource_universal_d_batchCreate: typeof batchCreate;\n type bookingsCatalogV1Resource_universal_d_BatchCreateOptions = BatchCreateOptions;\n const bookingsCatalogV1Resource_universal_d_update: typeof update;\n type bookingsCatalogV1Resource_universal_d_UpdateOptions = UpdateOptions;\n const bookingsCatalogV1Resource_universal_d_updateSchedule: typeof updateSchedule;\n type bookingsCatalogV1Resource_universal_d_UpdateScheduleOptions = UpdateScheduleOptions;\n const bookingsCatalogV1Resource_universal_d__delete: typeof _delete;\n const bookingsCatalogV1Resource_universal_d_batchDelete: typeof batchDelete;\n const bookingsCatalogV1Resource_universal_d_linkResourceToUser: typeof linkResourceToUser;\n const bookingsCatalogV1Resource_universal_d_unLinkResourceFromOwner: typeof unLinkResourceFromOwner;\n namespace bookingsCatalogV1Resource_universal_d {\n export {\n bookingsCatalogV1Resource_universal_d___debug as __debug,\n bookingsCatalogV1Resource_universal_d_Resource as Resource,\n bookingsCatalogV1Resource_universal_d_Schedule as Schedule,\n bookingsCatalogV1Resource_universal_d_RecurringInterval as RecurringInterval,\n bookingsCatalogV1Resource_universal_d_Interval as Interval,\n bookingsCatalogV1Resource_universal_d_Day as Day,\n bookingsCatalogV1Resource_universal_d_Frequency as Frequency,\n bookingsCatalogV1Resource_universal_d_LinkedSchedule as LinkedSchedule,\n bookingsCatalogV1Resource_universal_d_Transparency as Transparency,\n bookingsCatalogV1Resource_universal_d_RecurringIntervalType as RecurringIntervalType,\n bookingsCatalogV1Resource_universal_d_Location as Location,\n bookingsCatalogV1Resource_universal_d_LocationType as LocationType,\n bookingsCatalogV1Resource_universal_d_Address as Address,\n bookingsCatalogV1Resource_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n bookingsCatalogV1Resource_universal_d_StreetAddress as StreetAddress,\n bookingsCatalogV1Resource_universal_d_AddressLocation as AddressLocation,\n bookingsCatalogV1Resource_universal_d_Subdivision as Subdivision,\n bookingsCatalogV1Resource_universal_d_LocationsLocation as LocationsLocation,\n bookingsCatalogV1Resource_universal_d_LocationStatus as LocationStatus,\n bookingsCatalogV1Resource_universal_d_LocationsLocationType as LocationsLocationType,\n bookingsCatalogV1Resource_universal_d_LocationsAddress as LocationsAddress,\n bookingsCatalogV1Resource_universal_d_LocationsStreetAddress as LocationsStreetAddress,\n bookingsCatalogV1Resource_universal_d_LocationsAddressLocation as LocationsAddressLocation,\n bookingsCatalogV1Resource_universal_d_BusinessSchedule as BusinessSchedule,\n bookingsCatalogV1Resource_universal_d_TimePeriod as TimePeriod,\n bookingsCatalogV1Resource_universal_d_DayOfWeek as DayOfWeek,\n bookingsCatalogV1Resource_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n bookingsCatalogV1Resource_universal_d_Rate as Rate,\n bookingsCatalogV1Resource_universal_d_Price as Price,\n bookingsCatalogV1Resource_universal_d_Availability as Availability,\n bookingsCatalogV1Resource_universal_d_AvailabilityConstraints as AvailabilityConstraints,\n bookingsCatalogV1Resource_universal_d_SplitInterval as SplitInterval,\n bookingsCatalogV1Resource_universal_d_Participant as Participant,\n bookingsCatalogV1Resource_universal_d_ApprovalStatus as ApprovalStatus,\n bookingsCatalogV1Resource_universal_d_ExternalCalendarOverrides as ExternalCalendarOverrides,\n bookingsCatalogV1Resource_universal_d_ScheduleStatus as ScheduleStatus,\n bookingsCatalogV1Resource_universal_d_Version as Version,\n bookingsCatalogV1Resource_universal_d_ConferenceProvider as ConferenceProvider,\n bookingsCatalogV1Resource_universal_d_CalendarConference as CalendarConference,\n bookingsCatalogV1Resource_universal_d_ConferenceType as ConferenceType,\n bookingsCatalogV1Resource_universal_d_ResourceStatus as ResourceStatus,\n bookingsCatalogV1Resource_universal_d_ListResourcesRequest as ListResourcesRequest,\n bookingsCatalogV1Resource_universal_d_Query as Query,\n bookingsCatalogV1Resource_universal_d_Sorting as Sorting,\n bookingsCatalogV1Resource_universal_d_SortOrder as SortOrder,\n bookingsCatalogV1Resource_universal_d_Paging as Paging,\n bookingsCatalogV1Resource_universal_d_ListResourcesResponse as ListResourcesResponse,\n bookingsCatalogV1Resource_universal_d_QueryMetaData as QueryMetaData,\n bookingsCatalogV1Resource_universal_d_PagingMetadataV2 as PagingMetadataV2,\n bookingsCatalogV1Resource_universal_d_Cursors as Cursors,\n bookingsCatalogV1Resource_universal_d_QueryResourcesRequest as QueryResourcesRequest,\n bookingsCatalogV1Resource_universal_d_QueryV2 as QueryV2,\n bookingsCatalogV1Resource_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n bookingsCatalogV1Resource_universal_d_CursorPaging as CursorPaging,\n bookingsCatalogV1Resource_universal_d_QueryResourcesResponse as QueryResourcesResponse,\n bookingsCatalogV1Resource_universal_d_CreateResourceRequest as CreateResourceRequest,\n bookingsCatalogV1Resource_universal_d_CreateResourceResponse as CreateResourceResponse,\n bookingsCatalogV1Resource_universal_d_ResourceNotification as ResourceNotification,\n bookingsCatalogV1Resource_universal_d_Event as Event,\n bookingsCatalogV1Resource_universal_d_BatchCreateResourceRequest as BatchCreateResourceRequest,\n bookingsCatalogV1Resource_universal_d_BatchCreateResourceResponse as BatchCreateResourceResponse,\n bookingsCatalogV1Resource_universal_d_UpdateResourceRequest as UpdateResourceRequest,\n bookingsCatalogV1Resource_universal_d_BatchRequest as BatchRequest,\n bookingsCatalogV1Resource_universal_d_CreateScheduleRequest as CreateScheduleRequest,\n bookingsCatalogV1Resource_universal_d_UpdateScheduleRequest as UpdateScheduleRequest,\n bookingsCatalogV1Resource_universal_d_ParticipantNotification as ParticipantNotification,\n bookingsCatalogV1Resource_universal_d_CancelScheduleRequest as CancelScheduleRequest,\n bookingsCatalogV1Resource_universal_d_UpdateResourceResponse as UpdateResourceResponse,\n bookingsCatalogV1Resource_universal_d_BatchResponse as BatchResponse,\n bookingsCatalogV1Resource_universal_d_ResourceUpdateScheduleRequest as ResourceUpdateScheduleRequest,\n bookingsCatalogV1Resource_universal_d_UpdateScheduleResponse as UpdateScheduleResponse,\n bookingsCatalogV1Resource_universal_d_DeleteResourceRequest as DeleteResourceRequest,\n bookingsCatalogV1Resource_universal_d_DeleteResourceResponse as DeleteResourceResponse,\n bookingsCatalogV1Resource_universal_d_BatchDeleteResourceRequest as BatchDeleteResourceRequest,\n bookingsCatalogV1Resource_universal_d_BatchDeleteResourceResponse as BatchDeleteResourceResponse,\n bookingsCatalogV1Resource_universal_d_LinkResourceToUserRequest as LinkResourceToUserRequest,\n bookingsCatalogV1Resource_universal_d_LinkResourceToUserResponse as LinkResourceToUserResponse,\n bookingsCatalogV1Resource_universal_d_UnLinkResourceFromOwnerRequest as UnLinkResourceFromOwnerRequest,\n bookingsCatalogV1Resource_universal_d_UnLinkResourceFromOwnerResponse as UnLinkResourceFromOwnerResponse,\n bookingsCatalogV1Resource_universal_d_list as list,\n bookingsCatalogV1Resource_universal_d_ListOptions as ListOptions,\n bookingsCatalogV1Resource_universal_d_query as query,\n bookingsCatalogV1Resource_universal_d_QueryOptions as QueryOptions,\n bookingsCatalogV1Resource_universal_d_create as create,\n bookingsCatalogV1Resource_universal_d_CreateOptions as CreateOptions,\n bookingsCatalogV1Resource_universal_d_batchCreate as batchCreate,\n bookingsCatalogV1Resource_universal_d_BatchCreateOptions as BatchCreateOptions,\n bookingsCatalogV1Resource_universal_d_update as update,\n bookingsCatalogV1Resource_universal_d_UpdateOptions as UpdateOptions,\n bookingsCatalogV1Resource_universal_d_updateSchedule as updateSchedule,\n bookingsCatalogV1Resource_universal_d_UpdateScheduleOptions as UpdateScheduleOptions,\n bookingsCatalogV1Resource_universal_d__delete as _delete,\n bookingsCatalogV1Resource_universal_d_batchDelete as batchDelete,\n bookingsCatalogV1Resource_universal_d_linkResourceToUser as linkResourceToUser,\n bookingsCatalogV1Resource_universal_d_unLinkResourceFromOwner as unLinkResourceFromOwner,\n };\n }\n \n export { bookingsCatalogV1Resource_universal_d as resources };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecom-v1-shipping-rates-provider.d.ts", "content": "declare module \"interfaces-ecom-v1-shipping-rates-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface GetShippingRatesRequest {\n /** The line items to be shipped. */\n lineItems?: ProductItem[];\n /** Address to ship to. */\n shippingDestination?: Address;\n /** Address item is shipped from. This is the site owner's business address. */\n shippingOrigin?: Address;\n /** Buyer's contact details. */\n buyerContactDetails?: FullAddressContactDetails;\n /**\n * Weight measurement unit used for all items in the shipment.\n *\n * Supported values:\n * + `\"KG\"`: kilograms\n * + `\"LB\"`: pounds\n */\n weightUnit?: WeightUnit;\n /**\n * Whether tax is included in the items' prices.\n * @deprecated Whether tax is included in the items' prices.\n * @targetRemovalDate 2025-05-01\n */\n taxIncludedInPrices?: boolean;\n /** List of delivery preferences, for example preferred delivery code (`shippingOptionId`). */\n deliveryPreferences?: DeliveryPreferences;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /**\n * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\n * Used for integration and tracking across different platforms.\n */\n externalReferences?: ExternalReference[];\n }\n interface ProductItem {\n /** Item name. */\n name?: string;\n /** The number of items ordered. */\n quantity?: number;\n /** Reference to the item's origin catalog. */\n catalogReference?: CatalogReference;\n /** Physical properties of the item. */\n physicalProperties?: PhysicalProperties;\n /** Price of a single item after discounts. */\n price?: string;\n /**\n * For shipping rates by product group\n * @internal\n */\n shippingGroupId?: string | null;\n /** Total line item price before discounts. */\n totalPriceBeforeDiscount?: string | null;\n /** Price of a single item before discounts. */\n priceBeforeDiscount?: string | null;\n /** Total line item price after discounts. This is equal to `price` multiplied by `quantity`. */\n totalPrice?: string | null;\n /**\n * For delivery rates by delivery profile id\n * @internal\n */\n deliveryProfileId?: string | null;\n /** item delivery destination index in the shipping addresses list */\n deliveryDestinationIndex?: number | null;\n /** where the item is delivered from index in the from addresses list */\n deliveryOriginIndex?: number | null;\n /** whether tax is included in line item price */\n taxIncludedInPrice?: boolean | null;\n /**\n * The ID of the line item.\n * @internal\n */\n lineItemId?: string | null;\n /**\n * For delivery rates by delivery rule id (multiple delivery rules per delivery profile)\n * @internal\n */\n deliveryRuleId?: 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 [app dashboard](https://dev.wix.com/dc3/my-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 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 /** Physical address */\n interface Address extends AddressStreetOneOf {\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 /** Full contact details for an address */\n interface FullAddressContactDetails {\n /** Contact's first name. */\n firstName?: string | null;\n /** Contact's last name. */\n lastName?: string | null;\n /**\n * Contact's full name.\n * @internal\n */\n fullName?: string | null;\n /** Contact's phone number. */\n phone?: string | null;\n /** Contact's company name. */\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 /**\n * Tax type.\n *\n * Supported values:\n * + `CPF`: for individual tax payers\n * + `CNPJ`: for corporations\n */\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 /**\n * delivery preferences, for example preferred delivery \"code\" (shippingOptionId).\n * enrich the delivery providers with more data about the delivery\n */\n interface DeliveryPreferences {\n preferredCode?: string | null;\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 GetShippingRatesResponse {\n /** Available shipping rates. These define the shipping rate options that are displayed to site visitors on the cart and checkout pages. */\n shippingRates?: ShippingOption[];\n }\n interface ShippingOption {\n /** Unique code that acts as an ID for a shipping rate. For example, `\"usps_std_overnight\"`. */\n code?: string;\n /** Shipping rate title. For example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"`, or `\"First-Class Package International\"`. */\n title?: string;\n /** Shipping logistics. */\n logistics?: DeliveryLogistics;\n /** Shipping cost. */\n cost?: ShippingPrice;\n /**\n * If the option is a partial and doesn't apply to all line_items, this field will be populated.\n * @internal\n */\n partial?: PartialOption;\n }\n interface DeliveryLogistics {\n /** When the item is expected to be delivered in free text. For example, `\"3-5 business days\"`. */\n deliveryTime?: string | null;\n /** Instructions for delivery. For example, for pickup: `\"Ensure to come during business hours, and please don't park in the disabled spot\"`. */\n instructions?: string | null;\n /** Pickup details. Should be returned only if order is for pickup. */\n pickupDetails?: PickupDetails;\n /**\n * Date and Time of the delivery option\n * @internal\n */\n deliveryTimeSlot?: DeliveryTimeSlot;\n }\n interface PickupDetails {\n /** Pickup address. */\n address?: Address;\n /**\n * Pickup method.\n *\n * Supported values:\n * + `\"STORE_PICKUP\"`: When pickup is from the merchant's brick and mortar store.\n * + `\"PICKUP_POINT\"`: When item is shipped to a specified pickup point.\n */\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 DeliveryTimeSlot {\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 ShippingPrice {\n /** The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes). */\n price?: string;\n /** Currency of the shipping rate price as a 3-letter [ISO-4217 currency code](https://en.wikipedia.org/wiki/ISO_4217). Must align with the `currency` passed to the function under the `metadata` field. */\n currency?: string;\n /** Additional costs. For example, a handling fee for packaging fragile items. */\n additionalCharges?: AdditionalCharge[];\n }\n interface AdditionalCharge {\n /** Additional charge type. */\n type?: ChargeType;\n /** Details of the additional charge. For example, `\"Handling fee of $5 applied for gift wrapping\"`. */\n details?: string | null;\n /** Cost of additional charge. For example, `12.5`. */\n price?: string;\n }\n enum ChargeType {\n HANDLING_FEE = \"HANDLING_FEE\"\n }\n interface PartialOption {\n /** Items that the delivery option is for. If empty, the delivery option is for all items. */\n lineItemIds?: string[];\n }\n interface MissingPostalCodeError {\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 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 FIELD_NOT_ALLOWED = \"FIELD_NOT_ALLOWED\",\n ONE_OF_ALIGNMENT = \"ONE_OF_ALIGNMENT\",\n EXACT_LENGTH = \"EXACT_LENGTH\",\n EXACT_SIZE = \"EXACT_SIZE\"\n }\n interface GenericShippingRatesError {\n errors?: ApplicationError[];\n }\n interface GetDashboardTablesRequest {\n /** Delivery profile id. */\n deliveryProfileId?: string;\n /** Delivery region ids to get settings for. */\n deliveryRegionId?: string[];\n }\n interface GetDashboardTablesResponse {\n /** The list of settings for the given requests. */\n dashboardTableResults?: RegionDashboardTables[];\n }\n interface RegionDashboardTables {\n /** The delivery rule id. */\n deliveryRegionId?: string;\n /** The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers. */\n dashboardTables?: DashboardTable[];\n }\n interface DashboardTable {\n /** The title of the delivery settings that will be displayed in the UI. */\n title?: string;\n /** The columns of the delivery settings that will be displayed in the UI. */\n columns?: Column[];\n /** The content of the delivery settings. Each row is a map of column name to value. */\n rows?: Row[];\n }\n interface Column {\n /** The name of the column. This is used to get the data from the row. */\n key?: string;\n /** The title of the column that will be displayed in the UI. */\n name?: string;\n }\n interface Row {\n /** The external key of the data presented in a row. This is used to identify the row in the UI for editing. */\n key?: string;\n /**\n * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.\n * Data will be in JSON format.\n */\n data?: Record | null;\n }\n interface ShippingRatesConfig {\n /** Human-readable name of the shipping provider. */\n name?: string;\n /** Description of the shipping provider. */\n description?: string | null;\n /** URL to more info about the shipping provider. */\n learnMoreUrl?: string | null;\n /** URL to reach the shipping provider app's dashboard. */\n dashboardUrl?: string | null;\n /** Whether to require the site owner to define a fallback/default rate. Set to `true` if you do not provide rates as part of the integration. */\n fallbackDefinitionMandatory?: boolean;\n /**\n * Thumbnail image of the shipping rates provider. Displayed in the shipping settings section in the Dashboard.\n * The URL must be of an image uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager).\n */\n thumbnailUrl?: string | null;\n /**\n * feature toggle initialized with default value = false. should be true if implemented by spi provider\n * @internal\n */\n toggleGetDashboardTableEnabled?: 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, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\n interface Context {\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 requestId?: string | null;\n /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */\n currency?: string | null;\n /** An object that describes the identity that triggered this request. */\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. For example, `\"en-US\"`. */\n languages?: string[];\n /** The service provider app's instance ID. */\n instanceId?: string | null;\n /**\n * Extension ID in Dev Center.\n * @internal\n */\n appExtensionId?: string | null;\n /**\n * Extension type in Dev Center.\n * @internal\n */\n appExtensionType?: string | null;\n /**\n * Invoked function.\n * @internal\n */\n functionName?: 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 GetShippingRatesOptions {\n /** The line items to be shipped. */\n lineItems?: ProductItem[];\n /** Address to ship to. */\n shippingDestination?: Address;\n /** Address item is shipped from. This is the site owner's business address. */\n shippingOrigin?: Address;\n /** Buyer's contact details. */\n buyerContactDetails?: FullAddressContactDetails;\n /**\n * Weight measurement unit used for all items in the shipment.\n *\n * Supported values:\n * + `\"KG\"`: kilograms\n * + `\"LB\"`: pounds\n */\n weightUnit?: WeightUnit;\n /**\n * Whether tax is included in the items' prices.\n * @deprecated Whether tax is included in the items' prices.\n * @targetRemovalDate 2025-05-01\n */\n taxIncludedInPrices?: boolean;\n /** List of delivery preferences, for example preferred delivery code (`shippingOptionId`). */\n deliveryPreferences?: DeliveryPreferences;\n /**\n * __Deprecated.__ Use `purchaseFlowId` instead.\n * @internal\n * @deprecated\n */\n ecomId?: string | null;\n /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */\n purchaseFlowId?: string | null;\n /**\n * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\n * Used for integration and tracking across different platforms.\n */\n externalReferences?: ExternalReference[];\n }\n \n function missingPostalCode(data: MissingPostalCodeError): BusinessError;\n function invalidPostalCode(data: InvalidPostalCodeError): BusinessError;\n function invalidAddress(data: InvalidAddressError): BusinessError;\n function genericShippingRatesError(data: GenericShippingRatesError): BusinessError;\n \n const getShippingRatesSpiErrors_d_missingPostalCode: typeof missingPostalCode;\n const getShippingRatesSpiErrors_d_invalidPostalCode: typeof invalidPostalCode;\n const getShippingRatesSpiErrors_d_invalidAddress: typeof invalidAddress;\n const getShippingRatesSpiErrors_d_genericShippingRatesError: typeof genericShippingRatesError;\n namespace getShippingRatesSpiErrors_d {\n export {\n getShippingRatesSpiErrors_d_missingPostalCode as missingPostalCode,\n getShippingRatesSpiErrors_d_invalidPostalCode as invalidPostalCode,\n getShippingRatesSpiErrors_d_invalidAddress as invalidAddress,\n getShippingRatesSpiErrors_d_genericShippingRatesError as genericShippingRatesError,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n getShippingRatesSpiErrors_d as getShippingRates,\n };\n }\n \n export { AdditionalCharge, Address, AddressLocation, AddressStreetOneOf, ApplicationError, BusinessError, CatalogReference, ChargeType, Column, Context, DashboardTable, DeliveryLogistics, DeliveryPreferences, DeliveryTimeSlot, ExternalReference, FieldViolation, FullAddressContactDetails, GenericShippingRatesError, GetDashboardTablesRequest, GetDashboardTablesResponse, GetShippingRatesOptions, GetShippingRatesRequest, GetShippingRatesResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, InvalidAddressError, InvalidPostalCodeError, MissingPostalCodeError, PartialOption, PhysicalProperties, PickupDetails, PickupMethod, ProductItem, RegionDashboardTables, Row, RuleType, ShippingOption, ShippingPrice, ShippingRatesConfig, StandardDetails, StreetAddress, Subdivision, SubdivisionType, VatId, VatType, WeightUnit, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-data-backend-public-sdk-poc.d.ts", "content": "declare module \"wix-data-backend-public-sdk-poc\" {\n interface Item {\n item?: Record | null;\n }\n interface InsertRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item to insert. */\n item?: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert the item. */\n dataCollectionId?: string;\n }\n enum Segment {\n /** Access database used in the Live site. */\n LIVE = \"LIVE\",\n /** Access staging (sandbox) database used in the editor. */\n SANDBOX = \"SANDBOX\",\n /** Access deleted database used in the Live site. */\n TRASH_LIVE = \"TRASH_LIVE\"\n }\n interface Options {\n /**\n * Should hooks execution be suppressed.\n * This option can only be used with Corvid backend\n * code identity.\n * @internal\n */\n suppressHooks?: boolean;\n /** @internal */\n includeReferences?: boolean;\n /** @internal */\n overrideExisting?: boolean;\n /** @internal */\n wrapDataHookErrors?: boolean;\n /** @internal */\n appOptions?: Record | null;\n /** @internal */\n pluginOptions?: Record | null;\n }\n interface InsertResponse {\n /** Inserted item. */\n item?: Record | null;\n }\n interface UpdateRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item to update. The existing item is replaced with this version. */\n item: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment\n * @internal\n */\n appId?: string | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n /**\n * Optional item authorizationConstraint\n * @internal\n */\n authorizationConstraint?: Record | null;\n /**\n * Optional explicit ID of the item to be updated. If the ID is provided here, it doesn't need to be provided in the `item` body parameter.\n * @internal\n */\n itemId: string;\n /** ID of the collection containing the existing item. */\n dataCollectionId?: string;\n }\n interface UpdateResponse {\n /** Updated item */\n item?: Record | null;\n }\n interface SaveRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item to insert or update. */\n item?: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert or update the item. */\n dataCollectionId?: string;\n }\n interface SaveResponse {\n /** Inserted or updated item. */\n item?: Record | null;\n }\n interface PatchRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** item id to patch */\n itemId?: string;\n /** Patch data */\n patch?: Record | null;\n /** Data access options */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment\n * @internal\n */\n appId?: string | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n /**\n * Optional item authorizationConstraint\n * @internal\n */\n authorizationConstraint?: Record | null;\n /** ID of the collection */\n dataCollectionId?: string;\n }\n interface PatchResponse {\n /** Patched item */\n item?: Record | null;\n }\n interface PatchWhereRequest {\n /** Data segment */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** filter items to patch */\n filter?: any;\n /** Patch data */\n patch?: Record | null;\n /** Data access options */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment\n * @internal\n */\n appId?: string | null;\n /** ID of the collection */\n dataCollectionId?: string;\n }\n interface PatchWhereResponse {\n /** Number of patched items */\n totalCount?: number;\n totalAffectedValues?: number;\n }\n interface GetRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** ID of the item to retrieve. */\n itemId: string;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection from which to retrieve the item. */\n dataCollectionId?: string;\n }\n interface ReadOptions {\n /** @internal */\n suppressHooks?: boolean;\n /** @internal */\n includeReferences?: boolean;\n /** @internal */\n wrapDataHookErrors?: boolean;\n /** @internal */\n consistentRead?: boolean;\n /** @internal */\n appOptions?: Record | null;\n /** @internal */\n pluginOptions?: Record | null;\n /** @internal */\n language?: string | null;\n }\n interface GetResponse {\n /** Retrieved item. */\n item?: Record | null;\n }\n interface RemoveRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** ID of the item to remove. */\n itemId: string;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n /**\n * Optional item authorizationConstraint\n * @internal\n */\n authorizationConstraint?: Record | null;\n /** ID of the collection from which to remove the item. */\n dataCollectionId?: string;\n }\n interface RemoveResponse {\n /** Removed item. */\n item?: Record | null;\n }\n interface TruncateRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection to truncate. */\n dataCollectionId?: string;\n }\n interface TruncateResponse {\n }\n interface QueryRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated. Use `dataCollectionId`` instead.\n * Collection name.\n * @internal\n * @deprecated Deprecated. Use `dataCollectionId`` instead.\n * Collection name.\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Deprecated. Use 'data_query' instead. Query https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_api-query-language\n * @internal\n * @deprecated\n */\n query?: Query;\n /**\n * Deprecated. Use `includeReferencedItems` instead. Includes referenced items for the specified properties in a query's results.\n * @internal\n * @deprecated Deprecated. Use `includeReferencedItems` instead. Includes referenced items for the specified properties in a query's results.\n * @replacedBy includeReferencedItems\n */\n include?: string[];\n /**\n * Data access options.\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in live segment.\n * @internal\n */\n appId?: string | null;\n /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */\n dataQuery?: QueryV2;\n /**\n * Optional item authorization constraint.\n * @internal\n */\n authorizationConstraint?: Record | null;\n /**\n * Whether to omit the total count in the response.\n * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n /**\n * Properties for which to include referenced items in the query's results.\n * Up to 50 referenced items can be included for each item that matches the query.\n * If more than 50 items are referenced, `partialIncludes` in the response is `true`.\n */\n includeReferencedItems?: string[];\n /** ID of the collection to query. */\n dataCollectionId?: string;\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. */\n fields?: 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 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 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 /** Array of projected fields. A list of specific field names to return. */\n fields?: 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 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 QueryResponse {\n /** Retrieved items. */\n items?: Record[] | null;\n /**\n * *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query.\n * @deprecated\n */\n totalCount?: number;\n /**\n * *Deprecated.** Refer to 'pagingMetadata' instead. Total number of items satisfying the query.\n * @deprecated\n */\n totalResults?: number;\n /** Whether referenced items are trimmed from the results. This occurs when there are more than 50 referenced items. */\n partialIncludes?: boolean;\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 /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\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 * @internal\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 AggregationRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Sorting preferences.\n * @internal\n * @deprecated\n */\n sorting?: Sorting[];\n /** Paging preferences. */\n paging?: Paging;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'.\n * @internal\n */\n cursorPaging?: CursorPaging;\n /** Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */\n initialFilter?: Record | null;\n /**\n * Object defining the steps of the aggregation to be This is an object defining aggregation itself.\n *\n * * Grouping rule is defined as _id field. It takes a form of:\n * {\n * \"_id\": \"$field\"\n * }\n *\n * If multiple fields are used for grouping, Group takes a form of:\n * {\n * \"_id\": {\n * \"field1\": \"$field1\"\n * \"field2\": \"$field2\"\n * }\n * }\n *\n * * Aggregation functions are defined as special field definitions.\n *\n * Average:\n * {\n * \"_id\": \"$field\"\n * \"my_avg\": {\n * \"$avg\": \"$other_field\"\n * }\n * }\n *\n * Max:\n * {\n * \"_id\": \"$field\"\n * \"my_max\": {\n * \"$max\": \"$other_field\"\n * }\n * }\n *\n * Min:\n * {\n * \"_id\": \"$field\"\n * \"my_min\": {\n * \"$min\": \"$other_field\"\n * }\n * }\n *\n * Sum:\n * {\n * \"_id\": \"$field\"\n * \"my_sum\": {\n * \"$sum\": \"$other_field\"\n * }\n * }\n */\n aggregation?: Record | null;\n /** Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */\n finalFilter?: Record | null;\n /** Sorting preferences. */\n sort?: Sorting[];\n /** ID of the collection on which to run the aggregation. */\n dataCollectionId?: string;\n }\n interface AggregationResponse {\n /** Aggregation results. */\n items?: Record[] | null;\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface CountRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Filter preferences defining the query. For more information on how to structure a filter object, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section). */\n filter?: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection for which to count query results. */\n dataCollectionId?: string;\n }\n interface CountResponse {\n /** Count of items matching the query. */\n totalCount?: number;\n /**\n * *Deprecated.** Refer to `totalCount` instead.\n * @deprecated\n */\n totalResults?: number;\n }\n interface DistinctRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */\n dataQuery?: QueryV2;\n /** Property name for which to return all distinct values. */\n propertyName: string;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection to query. */\n dataCollectionId?: string;\n /**\n * Whether to omit the total count in the response.\n * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n }\n interface DistinctResponse {\n /** List of distinct values contained in the property specified in `propertyName`. */\n items?: any[];\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface BulkInsertRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Items to insert. */\n items: Record[] | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert the items. */\n dataCollectionId?: string;\n }\n interface BulkInsertResponse {\n /** IDs of items inserted. */\n insertedItemIds?: string[];\n /** Error details for items that couldn't be inserted. */\n errors?: BulkError[];\n }\n interface BulkError {\n /** ID of the item that couldn't be inserted. */\n itemId?: string | null;\n /** Error message. */\n message?: string;\n /** Error details. */\n details?: Details;\n /** Index of the failed item in the `items` paramater of the request. */\n originalIndex?: number;\n }\n interface ApplicationError {\n /** Error code. */\n code?: string;\n /** Error description. */\n description?: string;\n /** Error data. */\n data?: Record | null;\n }\n interface Details {\n /** Application error. */\n applicationError?: ApplicationError;\n }\n interface BulkSaveRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Items to insert or update. */\n items: Record[] | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert or update the items. */\n dataCollectionId?: string;\n }\n interface BulkSaveResponse {\n /** IDs of items inserted. */\n insertedItemIds?: string[];\n /** IDs of items updated. */\n updatedItemIds?: string[];\n /** Errors for items that couldn't be inserted or updated. */\n errors?: BulkError[];\n }\n interface BulkUpdateRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Items to update. */\n items: Record[] | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to update items. */\n dataCollectionId?: string;\n }\n interface BulkUpdateResponse {\n /** IDs of items updated. */\n updatedItemIds?: string[];\n /** Errors for items that couldn't be updated. */\n errors?: BulkError[];\n }\n interface BulkPatchRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** List of items and their patches */\n entries?: Entry[];\n /** Data access options */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment\n * @internal\n */\n appId?: string | null;\n /** ID of the collection */\n dataCollectionId?: string;\n }\n interface Entry {\n /** item id to patch */\n itemId?: string;\n /** Patch data */\n patch?: Record | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n }\n interface BulkPatchResponse {\n /** Patched item ids */\n patchedItemIds?: string[];\n /** Errors */\n errors?: BulkError[];\n }\n interface BulkRemoveRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** IDs of items to remove. */\n entries?: BulkRemoveRequestEntry[];\n /** ID of the collection from which to remove the items. */\n dataCollectionId?: string;\n }\n interface BulkRemoveRequestEntry {\n /** ID of item to remove. */\n itemId?: string;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n }\n interface BulkRemoveResponse {\n /** IDs of items removed. */\n removedItemIds?: string[];\n /** Errors for items that couldn't be removed. */\n errors?: BulkError[];\n }\n interface QueryReferencedRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** ID of the referring item. */\n referringItemId: string;\n /** Property containing the references to the referenced items. */\n propertyName: string;\n /**\n * Result order\n * @internal\n */\n order?: Order;\n /** Paging preferences. */\n paging?: Paging;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'.\n * @internal\n */\n cursorPaging?: CursorPaging;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n /**\n * Whether to omit the total count in the response.\n * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n }\n enum Order {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryReferencedResponse {\n /**\n * *Deprecated.** Refer to `entities` instead. List of referenced items.\n * @deprecated\n */\n items?: Record[] | null;\n /**\n * *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query.\n * @deprecated\n */\n totalCount?: number;\n /**\n * *Deprecated**. Refer to 'pagingMetadata' instead. Total number of referenced items satisfying the query.\n * @deprecated\n */\n totalResults?: number;\n /** List of referenced items and/or IDs. For successfully resolved references, the referenced data item appears. For references that can't be resolved, the ID appears. */\n entities?: ReferencedEntity[];\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface ReferencedEntity extends ReferencedEntityEntityOneOf {\n /** Data item referenced. */\n item?: Record | null;\n /** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */\n referenceId?: string;\n }\n /** @oneof */\n interface ReferencedEntityEntityOneOf {\n /** Data item referenced. */\n item?: Record | null;\n /** Unresolved ID. Appears instead of the data item when the reference doesn't resolve. For example, when an ID isn't found or if an item is in draft state. */\n referenceId?: string;\n }\n interface BulkInsertReferencesRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use 'dataCollectionId' instead.\n * Name of the collection that contains the referring item\n * @internal\n * @deprecated Deprecated, use 'dataCollectionId' instead.\n * Name of the collection that contains the referring item\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** References to insert. */\n references: Reference[];\n /**\n * Options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n interface Reference {\n /** Property containing the references to the referenced items. */\n propertyName?: string;\n /** ID of the referring item. */\n referringItemId?: string;\n /** ID of the referenced item. */\n referencedItemId?: string;\n }\n interface BulkInsertReferencesResponse {\n }\n interface BulkReplaceReferencesRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Property containing the references to the referenced items. */\n propertyName: string;\n /** ID of the referring item. */\n referringItemId: string;\n /** List of new referenced item IDs to replace the existing ones. */\n newReferencedItemIds?: string[];\n /**\n * Options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n interface BulkReplaceReferencesResponse {\n }\n interface BulkRemoveReferencesRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** References to be removed. */\n references: Reference[];\n /**\n * Options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n interface BulkRemoveReferencesResponse {\n }\n interface IsReferencedRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Property that may contain a reference to the specified item. */\n propertyName: string;\n /** ID of the referring item. */\n referringItemId: string;\n /** ID of the item that may be referenced. */\n referencedItemId: string;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n interface IsReferencedResponse {\n /** Whether the specified property of the referring item contains a reference to the specified referenced item. */\n isReferenced?: boolean;\n }\n interface RestoreFromTrashBinRequest {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item id */\n itemId?: string;\n /** Data access options */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n /**\n * Optional item authorizationConstraint\n * @internal\n */\n authorizationConstraint?: Record | null;\n /** ID of the collection */\n dataCollectionId?: string;\n }\n interface RestoreFromTrashBinResponse {\n item?: Record | null;\n }\n /**\n * Adds an item to a collection.\n *\n * When an item is inserted into a collection, the following properties and values are added to it:\n * * `_id`: A unique identifier for an item in a collection. You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.\n * * `_createdDate`: The date the item was added to the collection.\n * * `_updatedDate`: The date the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_DATA.INSERT\n * @adminMethod\n */\n function insert(options?: InsertOptions): Promise;\n interface InsertOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item to insert. */\n item?: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert the item. */\n dataCollectionId?: string;\n }\n /**\n * Updates an item in a collection.\n *\n * An item ID must be submitted as part of the request, either as a path parameter or within the `item` body parameter. If an item is found in the specified collection with\n * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the request fails.\n *\n * When an item is updated, its `_updatedDate` property is changed to the current date.\n *\n * **Note:**\n * After an item is updated, it only contains the properties included in the Update Data Item request. If the existing item has properties with values and those properties\n * aren't included in the updated item, their values are lost.\n * @param itemId - Optional explicit ID of the item to be updated. If the ID is provided here, it doesn't need to be provided in the `item` body parameter.\n * @internal\n * @documentationMaturity preview\n * @requiredField itemId\n * @requiredField options.item\n * @permissionId WIX_DATA.UPDATE\n * @adminMethod\n */\n function update(itemId: string, options?: UpdateOptions): Promise;\n interface UpdateOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item to update. The existing item is replaced with this version. */\n item: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment\n * @internal\n */\n appId?: string | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n /**\n * Optional item authorizationConstraint\n * @internal\n */\n authorizationConstraint?: Record | null;\n /** ID of the collection containing the existing item. */\n dataCollectionId?: string;\n }\n /**\n * Inserts or updates an item in a collection.\n *\n * The Save Data Item endpoint inserts or updates the specified item, depending on whether it already exists in the collection.\n *\n * * If you don't provide an ID, a new item is created.\n *\n * * If you provide an ID that doesn't exist in the collection, a new item is created with that ID.\n *\n * * If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `_updatedDate` property is changed to the current date.\n *\n * ***Note:*** When you provide an item with an ID that already exists in the collection, the item you provide completely replaces the existing item with that ID.\n * This means that all of the item's previous properties and values are lost.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_DATA.UPDATE\n * @adminMethod\n */\n function save(options?: SaveOptions): Promise;\n interface SaveOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Item to insert or update. */\n item?: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert or update the item. */\n dataCollectionId?: string;\n }\n /**\n * Retrieves an item from a collection.\n * @param itemId - ID of the item to retrieve.\n * @internal\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId WIX_DATA.FIND\n * @adminMethod\n */\n function get(itemId: string, options?: GetOptions): Promise;\n interface GetOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection from which to retrieve the item. */\n dataCollectionId?: string;\n }\n /**\n * Removes an item from a collection.\n *\n * If any items in other collections reference the removed item in a reference or multi-reference field, the field is cleared.\n *\n * **Note:**\n * Once an item has been removed from a collection, it can't be restored.\n * @param itemId - ID of the item to remove.\n * @internal\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId WIX_DATA.REMOVE\n * @adminMethod\n */\n function remove(itemId: string, options?: RemoveOptions): Promise;\n interface RemoveOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Optional item constraint\n * @internal\n */\n constraint?: Record | null;\n /**\n * Optional item authorizationConstraint\n * @internal\n */\n authorizationConstraint?: Record | null;\n /** ID of the collection from which to remove the item. */\n dataCollectionId?: string;\n }\n /**\n * Removes all items from a collection. Site owner (`ADMIN`) permissions are required in order to invoke this operation.\n *\n * If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.\n *\n * **Note:**\n * Once items have been removed from a collection, they can't be restored.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_DATA.TRUNCATE\n * @adminMethod\n */\n function truncate(options?: TruncateOptions): Promise;\n interface TruncateOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection to truncate. */\n dataCollectionId?: string;\n }\n /**\n * Retrieves a list of items, on the basis of the filtering, sorting, and paging preferences you provide.\n *\n * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_DATA.FIND\n * @adminMethod\n */\n function query(options?: QueryOptions): Promise;\n interface QueryOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated. Use `dataCollectionId`` instead.\n * Collection name.\n * @internal\n * @deprecated Deprecated. Use `dataCollectionId`` instead.\n * Collection name.\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Deprecated. Use 'data_query' instead. Query https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_api-query-language\n * @internal\n * @deprecated\n */\n query?: Query;\n /**\n * Deprecated. Use `includeReferencedItems` instead. Includes referenced items for the specified properties in a query's results.\n * @internal\n * @deprecated Deprecated. Use `includeReferencedItems` instead. Includes referenced items for the specified properties in a query's results.\n * @replacedBy includeReferencedItems\n */\n include?: string[];\n /**\n * Data access options.\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in live segment.\n * @internal\n */\n appId?: string | null;\n /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */\n dataQuery?: QueryV2;\n /**\n * Optional item authorization constraint.\n * @internal\n */\n authorizationConstraint?: Record | null;\n /**\n * Whether to omit the total count in the response.\n * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n /**\n * Properties for which to include referenced items in the query's results.\n * Up to 50 referenced items can be included for each item that matches the query.\n * If more than 50 items are referenced, `partialIncludes` in the response is `true`.\n */\n includeReferencedItems?: string[];\n /** ID of the collection to query. */\n dataCollectionId?: string;\n }\n /** @internal\n * @documentationMaturity preview\n * @permissionId WIX_DATA.AGGREGATE\n * @adminMethod\n */\n function aggregate(options?: AggregateOptions): Promise;\n interface AggregateOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Sorting preferences.\n * @internal\n * @deprecated\n */\n sorting?: Sorting[];\n /** Paging preferences. */\n paging?: Paging;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'.\n * @internal\n */\n cursorPaging?: CursorPaging;\n /** Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */\n initialFilter?: Record | null;\n /**\n * Object defining the steps of the aggregation to be This is an object defining aggregation itself.\n *\n * * Grouping rule is defined as _id field. It takes a form of:\n * {\n * \"_id\": \"$field\"\n * }\n *\n * If multiple fields are used for grouping, Group takes a form of:\n * {\n * \"_id\": {\n * \"field1\": \"$field1\"\n * \"field2\": \"$field2\"\n * }\n * }\n *\n * * Aggregation functions are defined as special field definitions.\n *\n * Average:\n * {\n * \"_id\": \"$field\"\n * \"my_avg\": {\n * \"$avg\": \"$other_field\"\n * }\n * }\n *\n * Max:\n * {\n * \"_id\": \"$field\"\n * \"my_max\": {\n * \"$max\": \"$other_field\"\n * }\n * }\n *\n * Min:\n * {\n * \"_id\": \"$field\"\n * \"my_min\": {\n * \"$min\": \"$other_field\"\n * }\n * }\n *\n * Sum:\n * {\n * \"_id\": \"$field\"\n * \"my_sum\": {\n * \"$sum\": \"$other_field\"\n * }\n * }\n */\n aggregation?: Record | null;\n /** Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object. */\n finalFilter?: Record | null;\n /** Sorting preferences. */\n sort?: Sorting[];\n /** ID of the collection on which to run the aggregation. */\n dataCollectionId?: string;\n }\n /**\n * Returns the number of items in a collection that match a query.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_DATA.FIND\n * @adminMethod\n */\n function count(options?: CountOptions): Promise;\n interface CountOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Filter preferences defining the query. For more information on how to structure a filter object, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section). */\n filter?: Record | null;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection for which to count query results. */\n dataCollectionId?: string;\n }\n /**\n * Retrieves a list of distinct values for a given property in all items that match a query, without duplicates.\n *\n * As with the [Query Data Items]() endpoint, this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.\n * However, the Query Distinct Values endpoint doesn't return all of the full items that match the query.\n * Rather, it returns all unique values of the property you specify in `propertyName` for items that match the query.\n * If more than one item has the same value for that property, that value appears only once.\n *\n * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @internal\n * @documentationMaturity preview\n * @requiredField options.propertyName\n * @permissionId WIX_DATA.FIND\n * @adminMethod\n */\n function distinct(options?: DistinctOptions): Promise;\n interface DistinctOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */\n dataQuery?: QueryV2;\n /** Property name for which to return all distinct values. */\n propertyName: string;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection to query. */\n dataCollectionId?: string;\n /**\n * Whether to omit the total count in the response.\n * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n }\n /**\n * Adds multiple items to a collection.\n *\n * When each item is inserted into a collection, the following properties and values are added to it:\n * * `_id`: A unique identifier for an item in a collection. You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.\n * * `_createdDate`: The date the item was added to the collection.\n * * `_updatedDate`: The date the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.\n *\n * The endpoint returns a list of the IDs of items successfully inserted in `insertedItemIds`.\n * When any items can't be inserted, error details are provided for each failed item in `errors`.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items\n * @permissionId WIX_DATA.INSERT\n * @adminMethod\n */\n function bulkInsert(options?: BulkInsertOptions): Promise;\n interface BulkInsertOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Items to insert. */\n items: Record[] | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert the items. */\n dataCollectionId?: string;\n }\n /**\n * Inserts or updates multiple items in a collection.\n *\n * The Bulk Save Data Items endpoint inserts or updates each item, depending on whether it already exists in the collection. For each item:\n *\n * * If you don't provide an ID, a new item is created.\n *\n * * If you provide an ID that doesn't exist in the collection, a new item is created with that ID.\n *\n * * If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `_updatedDate` property is changed to the current date.\n *\n * The endpoint returns a list of the IDs of items successfully inserted in `insertedItemIds` and a list of the IDs of items successfully updated in `updatedItemIds`.\n * When any items can't be inserted or updated, error details are provided for each failed item in `errors`.\n *\n * ***Note:*** When you provide an item with an ID that already exists in the collection, the item you provide completely replaces the existing item with that ID.\n * This means that all of the item's previous properties and values are lost.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items\n * @permissionId WIX_DATA.UPDATE\n * @adminMethod\n */\n function bulkSave(options?: BulkSaveOptions): Promise;\n interface BulkSaveOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Items to insert or update. */\n items: Record[] | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to insert or update the items. */\n dataCollectionId?: string;\n }\n /**\n * Updates multiple items in a collection.\n *\n * Each item in the request must include an ID. If an item is found in the specified collection with\n * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.\n *\n * When an item is updated, its `_updatedDate` property is changed to the current date.\n *\n * The endpoint returns a list of the IDs of items successfully updated in `updatedItemIds`.\n * When any items can't be inserted, error details are provided for each failed item in `errors`.\n *\n * **Note:**\n * After each item is updated, it only contains the properties included in the Update Data Item request. If the existing item has properties with values and those properties\n * aren't included in the updated item, their values are lost.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items\n * @permissionId WIX_DATA.UPDATE\n * @adminMethod\n */\n function bulkUpdate(options?: BulkUpdateOptions): Promise;\n interface BulkUpdateOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Items to update. */\n items: Record[] | null;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection in which to update items. */\n dataCollectionId?: string;\n }\n /**\n * Removes multiple items from a collection.\n *\n * If any items in other collections reference the removed items in reference or multi-reference fields, the fields are cleared.\n *\n * The endpoint returns a list of the IDs of items successfully removed in `removedItemIds`.\n * When any items can't be removed, error details are provided for each failed item in `errors`.\n *\n * **Note:** Once an item has been removed from a collection, it can't be restored.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_DATA.REMOVE\n * @adminMethod\n */\n function bulkRemove(options?: BulkRemoveOptions): Promise;\n interface BulkRemoveOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /**\n * Data access options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** IDs of items to remove. */\n entries?: BulkRemoveRequestEntry[];\n /** ID of the collection from which to remove the items. */\n dataCollectionId?: string;\n }\n /**\n * Gets the full items referenced in the specified property of an item.\n *\n * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection.\n * Querying the **Movies** collection using the Query Referenced Data Items endpoint returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.\n * This gives you information from the **People** collection about each of the actors in the specified movie.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.propertyName\n * @requiredField options.referringItemId\n * @permissionId WIX_DATA.FIND\n * @adminMethod\n */\n function queryReferenced(options?: QueryReferencedOptions): Promise;\n interface QueryReferencedOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** ID of the referring item. */\n referringItemId: string;\n /** Property containing the references to the referenced items. */\n propertyName: string;\n /**\n * Result order\n * @internal\n */\n order?: Order;\n /** Paging preferences. */\n paging?: Paging;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Cursor pointing to page of results. Can't be used together with 'paging'.\n * @internal\n */\n cursorPaging?: CursorPaging;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n /**\n * Whether to omit the total count in the response.\n * When `true`, the `pagingMetadata` object in the response doesn't contain a `total` field.\n *\n * Default: `false`\n */\n omitTotalCount?: boolean;\n }\n /**\n * Inserts one or more references in the specified properties of items in a collection.\n *\n * The Bulk Insert References endpoint adds one or more references to a collection.\n * Each new reference in the `references` field specifies a referring item's ID, the property in which to insert the reference, and the ID of the referenced item.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.references\n * @requiredField options.references.propertyName\n * @requiredField options.references.referencedItemId\n * @requiredField options.references.referringItemId\n * @permissionId WIX_DATA.INSERT\n * @adminMethod\n */\n function bulkInsertReferences(options?: BulkInsertReferencesOptions): Promise;\n interface BulkInsertReferencesOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use 'dataCollectionId' instead.\n * Name of the collection that contains the referring item\n * @internal\n * @deprecated Deprecated, use 'dataCollectionId' instead.\n * Name of the collection that contains the referring item\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** References to insert. */\n references: Reference[];\n /**\n * Options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n /**\n * Replaces references in a specified property of a specified data item.\n *\n * The Bulk Replace References endpoint replaces the existing reference or references contained in the property specified in `propertyName` within the data item specified in `referringItemId`.\n * The endpoint removes existing references and in their place it adds references to the items specified in `newReferencedItemIds`.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.propertyName\n * @requiredField options.referringItemId\n * @permissionId WIX_DATA.UPDATE\n * @adminMethod\n */\n function bulkReplaceReferences(options?: BulkReplaceReferencesOptions): Promise;\n interface BulkReplaceReferencesOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Property containing the references to the referenced items. */\n propertyName: string;\n /** ID of the referring item. */\n referringItemId: string;\n /** List of new referenced item IDs to replace the existing ones. */\n newReferencedItemIds?: string[];\n /**\n * Options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n /**\n * Removes one or more references.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.references\n * @requiredField options.references.propertyName\n * @permissionId WIX_DATA.REMOVE\n * @adminMethod\n */\n function bulkRemoveReferences(options?: BulkRemoveReferencesOptions): Promise;\n interface BulkRemoveReferencesOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Collection name\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Collection name\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** References to be removed. */\n references: Reference[];\n /**\n * Options\n * @internal\n */\n options?: Options;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n /**\n * Checks if a specific property of a referring item contains a reference to another specific item.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.propertyName\n * @requiredField options.referencedItemId\n * @requiredField options.referringItemId\n * @permissionId WIX_DATA.FIND\n * @adminMethod\n */\n function isReferenced(options?: IsReferencedOptions): Promise;\n interface IsReferencedOptions {\n /**\n * Data segment\n * @internal\n */\n segment?: Segment;\n /**\n * Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @internal\n * @deprecated Deprecated, use dataCollectionId instead.\n * Name of the collection that contains the referring item\n * @replacedBy data_collection_id\n */\n collectionName?: string;\n /** Property that may contain a reference to the specified item. */\n propertyName: string;\n /** ID of the referring item. */\n referringItemId: string;\n /** ID of the item that may be referenced. */\n referencedItemId: string;\n /**\n * Grid app id. Optional in Live segment.\n * @internal\n */\n appId?: string | null;\n /**\n * Data access options\n * @internal\n */\n options?: ReadOptions;\n /** ID of the collection containing the referring item. */\n dataCollectionId?: string;\n }\n \n type dataV1DataService_universal_d_Item = Item;\n type dataV1DataService_universal_d_InsertRequest = InsertRequest;\n type dataV1DataService_universal_d_Segment = Segment;\n const dataV1DataService_universal_d_Segment: typeof Segment;\n type dataV1DataService_universal_d_Options = Options;\n type dataV1DataService_universal_d_InsertResponse = InsertResponse;\n type dataV1DataService_universal_d_UpdateRequest = UpdateRequest;\n type dataV1DataService_universal_d_UpdateResponse = UpdateResponse;\n type dataV1DataService_universal_d_SaveRequest = SaveRequest;\n type dataV1DataService_universal_d_SaveResponse = SaveResponse;\n type dataV1DataService_universal_d_PatchRequest = PatchRequest;\n type dataV1DataService_universal_d_PatchResponse = PatchResponse;\n type dataV1DataService_universal_d_PatchWhereRequest = PatchWhereRequest;\n type dataV1DataService_universal_d_PatchWhereResponse = PatchWhereResponse;\n type dataV1DataService_universal_d_GetRequest = GetRequest;\n type dataV1DataService_universal_d_ReadOptions = ReadOptions;\n type dataV1DataService_universal_d_GetResponse = GetResponse;\n type dataV1DataService_universal_d_RemoveRequest = RemoveRequest;\n type dataV1DataService_universal_d_RemoveResponse = RemoveResponse;\n type dataV1DataService_universal_d_TruncateRequest = TruncateRequest;\n type dataV1DataService_universal_d_TruncateResponse = TruncateResponse;\n type dataV1DataService_universal_d_QueryRequest = QueryRequest;\n type dataV1DataService_universal_d_Query = Query;\n type dataV1DataService_universal_d_Sorting = Sorting;\n type dataV1DataService_universal_d_SortOrder = SortOrder;\n const dataV1DataService_universal_d_SortOrder: typeof SortOrder;\n type dataV1DataService_universal_d_Paging = Paging;\n type dataV1DataService_universal_d_QueryV2 = QueryV2;\n type dataV1DataService_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type dataV1DataService_universal_d_CursorPaging = CursorPaging;\n type dataV1DataService_universal_d_QueryResponse = QueryResponse;\n type dataV1DataService_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type dataV1DataService_universal_d_Cursors = Cursors;\n type dataV1DataService_universal_d_AggregationRequest = AggregationRequest;\n type dataV1DataService_universal_d_AggregationResponse = AggregationResponse;\n type dataV1DataService_universal_d_CountRequest = CountRequest;\n type dataV1DataService_universal_d_CountResponse = CountResponse;\n type dataV1DataService_universal_d_DistinctRequest = DistinctRequest;\n type dataV1DataService_universal_d_DistinctResponse = DistinctResponse;\n type dataV1DataService_universal_d_BulkInsertRequest = BulkInsertRequest;\n type dataV1DataService_universal_d_BulkInsertResponse = BulkInsertResponse;\n type dataV1DataService_universal_d_BulkError = BulkError;\n type dataV1DataService_universal_d_ApplicationError = ApplicationError;\n type dataV1DataService_universal_d_Details = Details;\n type dataV1DataService_universal_d_BulkSaveRequest = BulkSaveRequest;\n type dataV1DataService_universal_d_BulkSaveResponse = BulkSaveResponse;\n type dataV1DataService_universal_d_BulkUpdateRequest = BulkUpdateRequest;\n type dataV1DataService_universal_d_BulkUpdateResponse = BulkUpdateResponse;\n type dataV1DataService_universal_d_BulkPatchRequest = BulkPatchRequest;\n type dataV1DataService_universal_d_Entry = Entry;\n type dataV1DataService_universal_d_BulkPatchResponse = BulkPatchResponse;\n type dataV1DataService_universal_d_BulkRemoveRequest = BulkRemoveRequest;\n type dataV1DataService_universal_d_BulkRemoveRequestEntry = BulkRemoveRequestEntry;\n type dataV1DataService_universal_d_BulkRemoveResponse = BulkRemoveResponse;\n type dataV1DataService_universal_d_QueryReferencedRequest = QueryReferencedRequest;\n type dataV1DataService_universal_d_Order = Order;\n const dataV1DataService_universal_d_Order: typeof Order;\n type dataV1DataService_universal_d_QueryReferencedResponse = QueryReferencedResponse;\n type dataV1DataService_universal_d_ReferencedEntity = ReferencedEntity;\n type dataV1DataService_universal_d_ReferencedEntityEntityOneOf = ReferencedEntityEntityOneOf;\n type dataV1DataService_universal_d_BulkInsertReferencesRequest = BulkInsertReferencesRequest;\n type dataV1DataService_universal_d_Reference = Reference;\n type dataV1DataService_universal_d_BulkInsertReferencesResponse = BulkInsertReferencesResponse;\n type dataV1DataService_universal_d_BulkReplaceReferencesRequest = BulkReplaceReferencesRequest;\n type dataV1DataService_universal_d_BulkReplaceReferencesResponse = BulkReplaceReferencesResponse;\n type dataV1DataService_universal_d_BulkRemoveReferencesRequest = BulkRemoveReferencesRequest;\n type dataV1DataService_universal_d_BulkRemoveReferencesResponse = BulkRemoveReferencesResponse;\n type dataV1DataService_universal_d_IsReferencedRequest = IsReferencedRequest;\n type dataV1DataService_universal_d_IsReferencedResponse = IsReferencedResponse;\n type dataV1DataService_universal_d_RestoreFromTrashBinRequest = RestoreFromTrashBinRequest;\n type dataV1DataService_universal_d_RestoreFromTrashBinResponse = RestoreFromTrashBinResponse;\n const dataV1DataService_universal_d_insert: typeof insert;\n type dataV1DataService_universal_d_InsertOptions = InsertOptions;\n const dataV1DataService_universal_d_update: typeof update;\n type dataV1DataService_universal_d_UpdateOptions = UpdateOptions;\n const dataV1DataService_universal_d_save: typeof save;\n type dataV1DataService_universal_d_SaveOptions = SaveOptions;\n const dataV1DataService_universal_d_get: typeof get;\n type dataV1DataService_universal_d_GetOptions = GetOptions;\n const dataV1DataService_universal_d_remove: typeof remove;\n type dataV1DataService_universal_d_RemoveOptions = RemoveOptions;\n const dataV1DataService_universal_d_truncate: typeof truncate;\n type dataV1DataService_universal_d_TruncateOptions = TruncateOptions;\n const dataV1DataService_universal_d_query: typeof query;\n type dataV1DataService_universal_d_QueryOptions = QueryOptions;\n const dataV1DataService_universal_d_aggregate: typeof aggregate;\n type dataV1DataService_universal_d_AggregateOptions = AggregateOptions;\n const dataV1DataService_universal_d_count: typeof count;\n type dataV1DataService_universal_d_CountOptions = CountOptions;\n const dataV1DataService_universal_d_distinct: typeof distinct;\n type dataV1DataService_universal_d_DistinctOptions = DistinctOptions;\n const dataV1DataService_universal_d_bulkInsert: typeof bulkInsert;\n type dataV1DataService_universal_d_BulkInsertOptions = BulkInsertOptions;\n const dataV1DataService_universal_d_bulkSave: typeof bulkSave;\n type dataV1DataService_universal_d_BulkSaveOptions = BulkSaveOptions;\n const dataV1DataService_universal_d_bulkUpdate: typeof bulkUpdate;\n type dataV1DataService_universal_d_BulkUpdateOptions = BulkUpdateOptions;\n const dataV1DataService_universal_d_bulkRemove: typeof bulkRemove;\n type dataV1DataService_universal_d_BulkRemoveOptions = BulkRemoveOptions;\n const dataV1DataService_universal_d_queryReferenced: typeof queryReferenced;\n type dataV1DataService_universal_d_QueryReferencedOptions = QueryReferencedOptions;\n const dataV1DataService_universal_d_bulkInsertReferences: typeof bulkInsertReferences;\n type dataV1DataService_universal_d_BulkInsertReferencesOptions = BulkInsertReferencesOptions;\n const dataV1DataService_universal_d_bulkReplaceReferences: typeof bulkReplaceReferences;\n type dataV1DataService_universal_d_BulkReplaceReferencesOptions = BulkReplaceReferencesOptions;\n const dataV1DataService_universal_d_bulkRemoveReferences: typeof bulkRemoveReferences;\n type dataV1DataService_universal_d_BulkRemoveReferencesOptions = BulkRemoveReferencesOptions;\n const dataV1DataService_universal_d_isReferenced: typeof isReferenced;\n type dataV1DataService_universal_d_IsReferencedOptions = IsReferencedOptions;\n namespace dataV1DataService_universal_d {\n export {\n dataV1DataService_universal_d_Item as Item,\n dataV1DataService_universal_d_InsertRequest as InsertRequest,\n dataV1DataService_universal_d_Segment as Segment,\n dataV1DataService_universal_d_Options as Options,\n dataV1DataService_universal_d_InsertResponse as InsertResponse,\n dataV1DataService_universal_d_UpdateRequest as UpdateRequest,\n dataV1DataService_universal_d_UpdateResponse as UpdateResponse,\n dataV1DataService_universal_d_SaveRequest as SaveRequest,\n dataV1DataService_universal_d_SaveResponse as SaveResponse,\n dataV1DataService_universal_d_PatchRequest as PatchRequest,\n dataV1DataService_universal_d_PatchResponse as PatchResponse,\n dataV1DataService_universal_d_PatchWhereRequest as PatchWhereRequest,\n dataV1DataService_universal_d_PatchWhereResponse as PatchWhereResponse,\n dataV1DataService_universal_d_GetRequest as GetRequest,\n dataV1DataService_universal_d_ReadOptions as ReadOptions,\n dataV1DataService_universal_d_GetResponse as GetResponse,\n dataV1DataService_universal_d_RemoveRequest as RemoveRequest,\n dataV1DataService_universal_d_RemoveResponse as RemoveResponse,\n dataV1DataService_universal_d_TruncateRequest as TruncateRequest,\n dataV1DataService_universal_d_TruncateResponse as TruncateResponse,\n dataV1DataService_universal_d_QueryRequest as QueryRequest,\n dataV1DataService_universal_d_Query as Query,\n dataV1DataService_universal_d_Sorting as Sorting,\n dataV1DataService_universal_d_SortOrder as SortOrder,\n dataV1DataService_universal_d_Paging as Paging,\n dataV1DataService_universal_d_QueryV2 as QueryV2,\n dataV1DataService_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n dataV1DataService_universal_d_CursorPaging as CursorPaging,\n dataV1DataService_universal_d_QueryResponse as QueryResponse,\n dataV1DataService_universal_d_PagingMetadataV2 as PagingMetadataV2,\n dataV1DataService_universal_d_Cursors as Cursors,\n dataV1DataService_universal_d_AggregationRequest as AggregationRequest,\n dataV1DataService_universal_d_AggregationResponse as AggregationResponse,\n dataV1DataService_universal_d_CountRequest as CountRequest,\n dataV1DataService_universal_d_CountResponse as CountResponse,\n dataV1DataService_universal_d_DistinctRequest as DistinctRequest,\n dataV1DataService_universal_d_DistinctResponse as DistinctResponse,\n dataV1DataService_universal_d_BulkInsertRequest as BulkInsertRequest,\n dataV1DataService_universal_d_BulkInsertResponse as BulkInsertResponse,\n dataV1DataService_universal_d_BulkError as BulkError,\n dataV1DataService_universal_d_ApplicationError as ApplicationError,\n dataV1DataService_universal_d_Details as Details,\n dataV1DataService_universal_d_BulkSaveRequest as BulkSaveRequest,\n dataV1DataService_universal_d_BulkSaveResponse as BulkSaveResponse,\n dataV1DataService_universal_d_BulkUpdateRequest as BulkUpdateRequest,\n dataV1DataService_universal_d_BulkUpdateResponse as BulkUpdateResponse,\n dataV1DataService_universal_d_BulkPatchRequest as BulkPatchRequest,\n dataV1DataService_universal_d_Entry as Entry,\n dataV1DataService_universal_d_BulkPatchResponse as BulkPatchResponse,\n dataV1DataService_universal_d_BulkRemoveRequest as BulkRemoveRequest,\n dataV1DataService_universal_d_BulkRemoveRequestEntry as BulkRemoveRequestEntry,\n dataV1DataService_universal_d_BulkRemoveResponse as BulkRemoveResponse,\n dataV1DataService_universal_d_QueryReferencedRequest as QueryReferencedRequest,\n dataV1DataService_universal_d_Order as Order,\n dataV1DataService_universal_d_QueryReferencedResponse as QueryReferencedResponse,\n dataV1DataService_universal_d_ReferencedEntity as ReferencedEntity,\n dataV1DataService_universal_d_ReferencedEntityEntityOneOf as ReferencedEntityEntityOneOf,\n dataV1DataService_universal_d_BulkInsertReferencesRequest as BulkInsertReferencesRequest,\n dataV1DataService_universal_d_Reference as Reference,\n dataV1DataService_universal_d_BulkInsertReferencesResponse as BulkInsertReferencesResponse,\n dataV1DataService_universal_d_BulkReplaceReferencesRequest as BulkReplaceReferencesRequest,\n dataV1DataService_universal_d_BulkReplaceReferencesResponse as BulkReplaceReferencesResponse,\n dataV1DataService_universal_d_BulkRemoveReferencesRequest as BulkRemoveReferencesRequest,\n dataV1DataService_universal_d_BulkRemoveReferencesResponse as BulkRemoveReferencesResponse,\n dataV1DataService_universal_d_IsReferencedRequest as IsReferencedRequest,\n dataV1DataService_universal_d_IsReferencedResponse as IsReferencedResponse,\n dataV1DataService_universal_d_RestoreFromTrashBinRequest as RestoreFromTrashBinRequest,\n dataV1DataService_universal_d_RestoreFromTrashBinResponse as RestoreFromTrashBinResponse,\n dataV1DataService_universal_d_insert as insert,\n dataV1DataService_universal_d_InsertOptions as InsertOptions,\n dataV1DataService_universal_d_update as update,\n dataV1DataService_universal_d_UpdateOptions as UpdateOptions,\n dataV1DataService_universal_d_save as save,\n dataV1DataService_universal_d_SaveOptions as SaveOptions,\n dataV1DataService_universal_d_get as get,\n dataV1DataService_universal_d_GetOptions as GetOptions,\n dataV1DataService_universal_d_remove as remove,\n dataV1DataService_universal_d_RemoveOptions as RemoveOptions,\n dataV1DataService_universal_d_truncate as truncate,\n dataV1DataService_universal_d_TruncateOptions as TruncateOptions,\n dataV1DataService_universal_d_query as query,\n dataV1DataService_universal_d_QueryOptions as QueryOptions,\n dataV1DataService_universal_d_aggregate as aggregate,\n dataV1DataService_universal_d_AggregateOptions as AggregateOptions,\n dataV1DataService_universal_d_count as count,\n dataV1DataService_universal_d_CountOptions as CountOptions,\n dataV1DataService_universal_d_distinct as distinct,\n dataV1DataService_universal_d_DistinctOptions as DistinctOptions,\n dataV1DataService_universal_d_bulkInsert as bulkInsert,\n dataV1DataService_universal_d_BulkInsertOptions as BulkInsertOptions,\n dataV1DataService_universal_d_bulkSave as bulkSave,\n dataV1DataService_universal_d_BulkSaveOptions as BulkSaveOptions,\n dataV1DataService_universal_d_bulkUpdate as bulkUpdate,\n dataV1DataService_universal_d_BulkUpdateOptions as BulkUpdateOptions,\n dataV1DataService_universal_d_bulkRemove as bulkRemove,\n dataV1DataService_universal_d_BulkRemoveOptions as BulkRemoveOptions,\n dataV1DataService_universal_d_queryReferenced as queryReferenced,\n dataV1DataService_universal_d_QueryReferencedOptions as QueryReferencedOptions,\n dataV1DataService_universal_d_bulkInsertReferences as bulkInsertReferences,\n dataV1DataService_universal_d_BulkInsertReferencesOptions as BulkInsertReferencesOptions,\n dataV1DataService_universal_d_bulkReplaceReferences as bulkReplaceReferences,\n dataV1DataService_universal_d_BulkReplaceReferencesOptions as BulkReplaceReferencesOptions,\n dataV1DataService_universal_d_bulkRemoveReferences as bulkRemoveReferences,\n dataV1DataService_universal_d_BulkRemoveReferencesOptions as BulkRemoveReferencesOptions,\n dataV1DataService_universal_d_isReferenced as isReferenced,\n dataV1DataService_universal_d_IsReferencedOptions as IsReferencedOptions,\n };\n }\n \n export { dataV1DataService_universal_d as data };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecom-v1-line-items-enricher.d.ts", "content": "declare module \"interfaces-ecom-v1-line-items-enricher\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n /** typ */\n interface EnrichLineItemsForThankYouPageRequest {\n lineItems: LineItem[];\n }\n interface LineItem {\n /** Line item ID. */\n _id?: string;\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 description lines. Used for display purposes for the cart, checkout and order. */\n descriptionLines?: V1DescriptionLine[];\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. 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 V1DescriptionLine extends V1DescriptionLineValueOneOf, V1DescriptionLineDescriptionLineValueOneOf {\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n /**\n * Description line plain text value.\n * @internal\n */\n plainTextValue?: PlainTextValue;\n /**\n * Description line color.\n * @internal\n */\n color?: string;\n /** Description line name. */\n name?: DescriptionLineName;\n /**\n * Description line type.\n * @internal\n */\n lineType?: DescriptionLineType;\n }\n /** @oneof */\n interface V1DescriptionLineValueOneOf {\n /** Description line plain text value. */\n plainText?: PlainTextValue;\n /** Description line color value. */\n colorInfo?: Color;\n }\n /** @oneof */\n interface V1DescriptionLineDescriptionLineValueOneOf {\n /**\n * Description line plain text value.\n * @internal\n */\n plainTextValue?: PlainTextValue;\n /**\n * Description line color.\n * @internal\n */\n color?: string;\n }\n interface DescriptionLineName {\n /** Description line name in the site's default language. */\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. */\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. */\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 EnrichLineItemsForThankYouPageResponse {\n enrichedLineItems?: EnrichedLineItemWithActions[];\n }\n interface EnrichedLineItemWithActions {\n /** Line item ID */\n _id?: string;\n /**\n * Description lines to replace the original\n * This is optional - If you do not want to override, do not return this and the original description lines will be used\n * If you do pass it, it overrides the existing description line.\n * If you want to append, copy the original description lines and add your own\n */\n overriddenDescriptionLines?: OverriddenDescriptionLines;\n /** Option to hide specific sections */\n renderingConfig?: LineItemRenderingConfig;\n /**\n * Optional list of actions to be rendered next to the line item\n * Implementation depends on the client (checkout page, mobile)\n */\n actions?: LineItemAction[];\n }\n interface OverriddenDescriptionLines {\n descriptionLines?: V1DescriptionLine[];\n }\n interface LineItemRenderingConfig {\n hidePrice?: boolean;\n hideQuantity?: boolean;\n }\n interface LineItemAction extends LineItemActionTextOneOf {\n /** the key that we use to save the text in the editor settings panel */\n settingsKey?: string;\n /** the translated text to display (i.e. will be shown \"as is\") */\n label?: string;\n /**\n * URL to navigate to in order to perform the action\n * can be relative e.g \"/api/download\" or absolute e.g. \"http://www.google.com\"\n * Note that a specific client may rely on action id and parameters and ignore the URL or the other way around\n */\n url?: string | null;\n /**\n * The unique id of the action\n * for example: DOWNLOAD_LINK, ADD_TO_CALENDAR\n * Note that a specific client may rely on action id and parameters and ignore the URL or the other way around\n */\n actionId?: string;\n /** Parameters for the actions, will be used by the client implementing the action based on actionId */\n actionParameters?: Record | null;\n }\n /** @oneof */\n interface LineItemActionTextOneOf {\n /** the key that we use to save the text in the editor settings panel */\n settingsKey?: string;\n /** the translated text to display (i.e. will be shown \"as is\") */\n label?: string;\n }\n /** typ example lines */\n interface GenerateThankYouPageExampleLineItemsRequest {\n }\n interface GenerateThankYouPageExampleLineItemsResponse {\n lineItems?: TYPEditorExampleLineItem[];\n }\n interface TYPEditorExampleLineItem {\n /** Line item name in the language of the Editor User */\n itemName?: string;\n /** the example lines to present in the editor - in the language of the Editor User */\n descriptionLines?: DescriptionLine[];\n /** name of action in the language of the Editor User // 'Add to calendar'/'Download'... */\n actionLabel?: string | null;\n /** indicate to the Thank You Page if to show quantity */\n hideQuantity?: boolean | null;\n /**\n * The unique id of the action\n * for example: DOWNLOAD_LINK, ADD_TO_CALENDAR\n */\n actionId?: string | null;\n }\n interface DescriptionLine {\n /** an optional name for the line */\n name?: string | null;\n /** the actual description value - in the language of the Editor User */\n value?: string;\n }\n /** invoice */\n interface EnrichLineItemsForInvoiceRequest {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForInvoiceResponse {\n enrichedLineItems?: EnrichedLineItem[];\n }\n interface EnrichedLineItem {\n /** Line item ID. */\n _id?: string;\n /**\n * Description lines to replace the original\n * This is optional - If you do not want to override, do not return this and the original description lines will be used\n * If you do pass it, it overrides the existing description line.\n * If you want to append, copy the original description lines and add your own\n */\n overriddenDescriptionLines?: OverriddenDescriptionLines;\n /** Option to hide specific sections */\n renderingConfig?: LineItemRenderingConfig;\n }\n /** checkout */\n interface EnrichLineItemsForCheckoutRequest {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForCheckoutResponse {\n enrichedLineItems?: EnrichedLineItem[];\n }\n /** cart */\n interface EnrichLineItemsForCartRequest {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForCartResponse {\n enrichedLineItems?: EnrichedLineItem[];\n }\n /** order page */\n interface EnrichLineItemsForOrderPageRequest {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForOrderPageResponse {\n enrichedLineItems?: EnrichedLineItem[];\n }\n interface LineItemsEnricherConfig {\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 EnrichLineItemsForThankYouPageOptions {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForInvoiceOptions {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForCheckoutOptions {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForCartOptions {\n lineItems: LineItem[];\n }\n interface EnrichLineItemsForOrderPageOptions {\n lineItems: LineItem[];\n }\n \n export { BusinessError, CatalogReference, Color, Context, DescriptionLine, DescriptionLineName, DescriptionLineType, EnrichLineItemsForCartOptions, EnrichLineItemsForCartRequest, EnrichLineItemsForCartResponse, EnrichLineItemsForCheckoutOptions, EnrichLineItemsForCheckoutRequest, EnrichLineItemsForCheckoutResponse, EnrichLineItemsForInvoiceOptions, EnrichLineItemsForInvoiceRequest, EnrichLineItemsForInvoiceResponse, EnrichLineItemsForOrderPageOptions, EnrichLineItemsForOrderPageRequest, EnrichLineItemsForOrderPageResponse, EnrichLineItemsForThankYouPageOptions, EnrichLineItemsForThankYouPageRequest, EnrichLineItemsForThankYouPageResponse, EnrichedLineItem, EnrichedLineItemWithActions, GenerateThankYouPageExampleLineItemsRequest, GenerateThankYouPageExampleLineItemsResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, LineItem, LineItemAction, LineItemActionTextOneOf, LineItemRenderingConfig, LineItemsEnricherConfig, OverriddenDescriptionLines, PlainTextValue, TYPEditorExampleLineItem, V1DescriptionLine, V1DescriptionLineDescriptionLineValueOneOf, V1DescriptionLineValueOneOf };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-site-media-backend.d.ts", "content": "declare module \"wix-site-media-backend\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Folder {\n /** ID of the folder. Internal name (unique identifier) which is generated when a folder is created by the Media Manager */\n _id?: string;\n /** The display name that appears in the Media Manager. */\n displayName?: string;\n /** ID of the folder's parent folder */\n parentFolderId?: string;\n /** Date the folder was created */\n _createdDate?: Date;\n /** Date the folder was updated */\n _updatedDate?: Date;\n }\n interface CreateFolderRequest {\n /** Folder name */\n displayName: string;\n /**\n * Optional - A folder id\n * If provided, nest the created folder under this folder\n * If not this folder will be under the media_root system folder\n */\n parentFolderId?: string | null;\n }\n interface CreateFolderResponse {\n /** A folder object containing the newly created folder info */\n folder?: Folder;\n }\n interface GetFolderRequest {\n /** The folder id to get the information of */\n folderId: string;\n }\n interface GetFolderResponse {\n /** The information for the requested folder */\n folder?: Folder;\n }\n interface ListFoldersRequest {\n /** Optional list folders in a specific folder */\n parentFolderId?: string | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting$1;\n /** Optional current cursor of the request if it exist */\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 /** 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 ListFoldersResponse {\n /** The information for the subfolders of the requested folder */\n folders?: Folder[];\n /** The next cursor if one exists */\n nextCursor?: PagingMetadataV2$1;\n }\n interface PagingMetadataV2$1 {\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\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 * @internal\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 }\n interface UpdateFolderRequest {\n /** The id of the folder to update */\n folderId: string;\n /** Optional - Folder name */\n displayName?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the folder under this folder, effectively moving the folder\n */\n parentFolderId?: string | null;\n }\n interface UpdateFolderResponse {\n /** A folder object containing the newly updated folder info */\n folder?: Folder;\n }\n interface GenerateFolderDownloadUrlRequest {\n /** The ID of the folder to download */\n folderId: string;\n }\n interface GenerateFolderDownloadUrlResponse {\n /** The download URL of the folder */\n downloadUrl?: string;\n }\n interface BulkDeleteFoldersRequest {\n /** List of folder ids to move to Media Manager's trash */\n folderIds?: string[];\n }\n interface BulkDeleteFoldersResponse {\n }\n interface BulkRemoveFoldersFromTrashBinRequest {\n /** List of folder ids to remove from Media Manager's trash - permanently delete files */\n folderIds?: string[];\n }\n interface BulkRemoveFoldersFromTrashBinResponse {\n }\n interface BulkRestoreFoldersFromTrashBinRequest {\n /** List of folder ids to restore from Media Manager's trash */\n folderIds?: string[];\n }\n interface BulkRestoreFoldersFromTrashBinResponse {\n }\n interface ListDeletedFoldersRequest {\n /** Optional list folders in a specific folder */\n parentFolderId?: string | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting$1;\n /** Optional current cursor of the request if it exist */\n cursorPaging?: CursorPaging$1;\n }\n interface ListDeletedFoldersResponse {\n /** List of file info that will be restored */\n folders?: Folder[];\n /** The next cursor if one exists */\n nextCursor?: PagingMetadataV2$1;\n }\n /**\n * Create a new folder\n * @param displayName - Folder name\n * @requiredField displayName\n */\n function createFolder(displayName: string, options?: CreateFolderOptions): Promise;\n interface CreateFolderOptions {\n /**\n * Optional - A folder id\n * If provided, nest the created folder under this folder\n * If not this folder will be under the media_root system folder\n */\n parentFolderId?: string | null;\n }\n /**\n * Gets the folder's information\n * @param folderId - The folder id to get the information of\n * @requiredField folderId\n */\n function getFolder(folderId: string): Promise;\n /** Return a list of subfolders of the requested folder */\n function listFolders(options?: ListFoldersOptions): Promise;\n interface ListFoldersOptions {\n /** Optional list folders in a specific folder */\n parentFolderId?: string | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting$1;\n /** Optional current cursor of the request if it exist */\n cursorPaging?: CursorPaging$1;\n }\n /**\n * Update the folder, allowing renaming and moving the folder\n * @param folderId - The id of the folder to update\n * @requiredField folderId\n */\n function updateFolder(folderId: string, options?: UpdateFolderOptions): Promise;\n interface UpdateFolderOptions {\n /** Optional - Folder name */\n displayName?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the folder under this folder, effectively moving the folder\n */\n parentFolderId?: string | null;\n }\n /**\n * Generates a temporary URL that can be used to download a compressed file containing the requested folder\n * The compressed file can contain up to 1000 files. Sub-folders are included\n * The name of the top-level folder requested for download is not included.\n * @param folderId - The ID of the folder to download\n * @requiredField folderId\n */\n function generateFolderDownloadUrl(folderId: string): Promise;\n /**\n * Move folders listed to Media Manager's trash\n * Moving many folders to trash at once is an asynchronous action. It may take some time for the results to be seen in the Media Manager.\n * Attempting to move already-trashed folders to trash again doesn't result in an error.\n */\n function bulkDeleteFolders(options?: BulkDeleteFoldersOptions): Promise;\n interface BulkDeleteFoldersOptions {\n /** List of folder ids to move to Media Manager's trash */\n folderIds?: string[];\n }\n /**\n * Permanently deletes a folder from the site media, this action is not reversible\n * Make sure this folder is not used in a site or in any other way as it will break\n */\n function bulkRemoveFoldersFromTrashBin(options?: BulkRemoveFoldersFromTrashBinOptions): Promise;\n interface BulkRemoveFoldersFromTrashBinOptions {\n /** List of folder ids to remove from Media Manager's trash - permanently delete files */\n folderIds?: string[];\n }\n /** Restore a folder to its original location in the site media. */\n function bulkRestoreFoldersFromTrashBin(options?: BulkRestoreFoldersFromTrashBinOptions): Promise;\n interface BulkRestoreFoldersFromTrashBinOptions {\n /** List of folder ids to restore from Media Manager's trash */\n folderIds?: string[];\n }\n /** Returns a list of the folder infos of all the deleted folders as directed by the filter. */\n function listDeletedFolders(options?: ListDeletedFoldersOptions): Promise;\n interface ListDeletedFoldersOptions {\n /** Optional list folders in a specific folder */\n parentFolderId?: string | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting$1;\n /** Optional current cursor of the request if it exist */\n cursorPaging?: CursorPaging$1;\n }\n \n type mediaSiteMediaV1Folder_universal_d_Folder = Folder;\n type mediaSiteMediaV1Folder_universal_d_CreateFolderRequest = CreateFolderRequest;\n type mediaSiteMediaV1Folder_universal_d_CreateFolderResponse = CreateFolderResponse;\n type mediaSiteMediaV1Folder_universal_d_GetFolderRequest = GetFolderRequest;\n type mediaSiteMediaV1Folder_universal_d_GetFolderResponse = GetFolderResponse;\n type mediaSiteMediaV1Folder_universal_d_ListFoldersRequest = ListFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_ListFoldersResponse = ListFoldersResponse;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolderRequest = UpdateFolderRequest;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolderResponse = UpdateFolderResponse;\n type mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlRequest = GenerateFolderDownloadUrlRequest;\n type mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlResponse = GenerateFolderDownloadUrlResponse;\n type mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersRequest = BulkDeleteFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersResponse = BulkDeleteFoldersResponse;\n type mediaSiteMediaV1Folder_universal_d_BulkRemoveFoldersFromTrashBinRequest = BulkRemoveFoldersFromTrashBinRequest;\n type mediaSiteMediaV1Folder_universal_d_BulkRemoveFoldersFromTrashBinResponse = BulkRemoveFoldersFromTrashBinResponse;\n type mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinRequest = BulkRestoreFoldersFromTrashBinRequest;\n type mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinResponse = BulkRestoreFoldersFromTrashBinResponse;\n type mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersRequest = ListDeletedFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersResponse = ListDeletedFoldersResponse;\n const mediaSiteMediaV1Folder_universal_d_createFolder: typeof createFolder;\n type mediaSiteMediaV1Folder_universal_d_CreateFolderOptions = CreateFolderOptions;\n const mediaSiteMediaV1Folder_universal_d_getFolder: typeof getFolder;\n const mediaSiteMediaV1Folder_universal_d_listFolders: typeof listFolders;\n type mediaSiteMediaV1Folder_universal_d_ListFoldersOptions = ListFoldersOptions;\n const mediaSiteMediaV1Folder_universal_d_updateFolder: typeof updateFolder;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolderOptions = UpdateFolderOptions;\n const mediaSiteMediaV1Folder_universal_d_generateFolderDownloadUrl: typeof generateFolderDownloadUrl;\n const mediaSiteMediaV1Folder_universal_d_bulkDeleteFolders: typeof bulkDeleteFolders;\n type mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersOptions = BulkDeleteFoldersOptions;\n const mediaSiteMediaV1Folder_universal_d_bulkRemoveFoldersFromTrashBin: typeof bulkRemoveFoldersFromTrashBin;\n type mediaSiteMediaV1Folder_universal_d_BulkRemoveFoldersFromTrashBinOptions = BulkRemoveFoldersFromTrashBinOptions;\n const mediaSiteMediaV1Folder_universal_d_bulkRestoreFoldersFromTrashBin: typeof bulkRestoreFoldersFromTrashBin;\n type mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinOptions = BulkRestoreFoldersFromTrashBinOptions;\n const mediaSiteMediaV1Folder_universal_d_listDeletedFolders: typeof listDeletedFolders;\n type mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersOptions = ListDeletedFoldersOptions;\n namespace mediaSiteMediaV1Folder_universal_d {\n export {\n __debug$1 as __debug,\n mediaSiteMediaV1Folder_universal_d_Folder as Folder,\n mediaSiteMediaV1Folder_universal_d_CreateFolderRequest as CreateFolderRequest,\n mediaSiteMediaV1Folder_universal_d_CreateFolderResponse as CreateFolderResponse,\n mediaSiteMediaV1Folder_universal_d_GetFolderRequest as GetFolderRequest,\n mediaSiteMediaV1Folder_universal_d_GetFolderResponse as GetFolderResponse,\n mediaSiteMediaV1Folder_universal_d_ListFoldersRequest as ListFoldersRequest,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n CursorPaging$1 as CursorPaging,\n mediaSiteMediaV1Folder_universal_d_ListFoldersResponse as ListFoldersResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n mediaSiteMediaV1Folder_universal_d_UpdateFolderRequest as UpdateFolderRequest,\n mediaSiteMediaV1Folder_universal_d_UpdateFolderResponse as UpdateFolderResponse,\n mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlRequest as GenerateFolderDownloadUrlRequest,\n mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlResponse as GenerateFolderDownloadUrlResponse,\n mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersRequest as BulkDeleteFoldersRequest,\n mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersResponse as BulkDeleteFoldersResponse,\n mediaSiteMediaV1Folder_universal_d_BulkRemoveFoldersFromTrashBinRequest as BulkRemoveFoldersFromTrashBinRequest,\n mediaSiteMediaV1Folder_universal_d_BulkRemoveFoldersFromTrashBinResponse as BulkRemoveFoldersFromTrashBinResponse,\n mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinRequest as BulkRestoreFoldersFromTrashBinRequest,\n mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinResponse as BulkRestoreFoldersFromTrashBinResponse,\n mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersRequest as ListDeletedFoldersRequest,\n mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersResponse as ListDeletedFoldersResponse,\n mediaSiteMediaV1Folder_universal_d_createFolder as createFolder,\n mediaSiteMediaV1Folder_universal_d_CreateFolderOptions as CreateFolderOptions,\n mediaSiteMediaV1Folder_universal_d_getFolder as getFolder,\n mediaSiteMediaV1Folder_universal_d_listFolders as listFolders,\n mediaSiteMediaV1Folder_universal_d_ListFoldersOptions as ListFoldersOptions,\n mediaSiteMediaV1Folder_universal_d_updateFolder as updateFolder,\n mediaSiteMediaV1Folder_universal_d_UpdateFolderOptions as UpdateFolderOptions,\n mediaSiteMediaV1Folder_universal_d_generateFolderDownloadUrl as generateFolderDownloadUrl,\n mediaSiteMediaV1Folder_universal_d_bulkDeleteFolders as bulkDeleteFolders,\n mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersOptions as BulkDeleteFoldersOptions,\n mediaSiteMediaV1Folder_universal_d_bulkRemoveFoldersFromTrashBin as bulkRemoveFoldersFromTrashBin,\n mediaSiteMediaV1Folder_universal_d_BulkRemoveFoldersFromTrashBinOptions as BulkRemoveFoldersFromTrashBinOptions,\n mediaSiteMediaV1Folder_universal_d_bulkRestoreFoldersFromTrashBin as bulkRestoreFoldersFromTrashBin,\n mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinOptions as BulkRestoreFoldersFromTrashBinOptions,\n mediaSiteMediaV1Folder_universal_d_listDeletedFolders as listDeletedFolders,\n mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersOptions as ListDeletedFoldersOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface FileDescriptor {\n /** Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager */\n _id?: string;\n /** The display name that appears in the Media Manager. (original_file_name in private media api) */\n displayName?: string;\n /** URL of the file. */\n url?: string;\n /** ID of the file's parent folder */\n parentFolderId?: string | null;\n /** File hash. */\n hash?: string;\n /**\n * Size of the uploaded file in bytes\n * @internal\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 to be used\n * @readonly\n */\n private?: boolean;\n /** Type of the file that was uploaded. */\n mediaType?: MediaType;\n /** The content of the file */\n media?: FileMedia;\n /** Status of the file that was uploaded */\n operationStatus?: OperationStatus;\n /** URL where the file was uploaded from */\n sourceUrl?: string | null;\n /** URL of the file's icon */\n thumbnailUrl?: string | null;\n /** A list of terms that describe the media item, generated by an artificial intelligence service or provided by user. */\n labels?: string[];\n /** Date the file was created */\n _createdDate?: Date;\n /** Date the file was updated */\n _updatedDate?: Date;\n /** The site id where the file is stored */\n siteId?: string;\n }\n enum MediaType {\n UNKNOWN = \"UNKNOWN\",\n IMAGE = \"IMAGE\",\n VIDEO = \"VIDEO\",\n AUDIO = \"AUDIO\",\n DOCUMENT = \"DOCUMENT\",\n VECTOR = \"VECTOR\"\n }\n interface FileMedia extends FileMediaMediaOneOf {\n /** Image media information */\n image?: ImageMedia;\n /** video media information */\n video?: string;\n /** Audio media information */\n audio?: AudioV2;\n /** Document media information */\n document?: string;\n /** Vector media information */\n vector?: ImageMedia;\n }\n /** @oneof */\n interface FileMediaMediaOneOf {\n /** Image media information */\n image?: ImageMedia;\n /** video media information */\n video?: string;\n /** Audio media information */\n audio?: AudioV2;\n /** Document media information */\n document?: string;\n /** Vector media information */\n vector?: ImageMedia;\n }\n interface ImageMedia {\n /** Image media information */\n image?: string;\n /** A representation of the colors in the image, Optional */\n colors?: Colors;\n /**\n * An array with information about faces in the image\n * Use to crop images without cutting faces\n * Optional\n */\n faces?: FaceRecognition[];\n /**\n * Image media information for a preview of the original image\n * Use this to display a preview for private images\n * Optional\n */\n previewImage?: string;\n }\n interface Colors {\n /** Main prominent color */\n prominent?: Color;\n /** Color palette */\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 was 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 /** The pixel height of the face */\n height?: number;\n /** The pixel width of the face */\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 * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n */\n urlExpirationDate?: Date;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface AudioV2 {\n /** WixMedia ID. */\n _id?: string;\n /** Audio formats available for this file. */\n assets?: string[];\n /**\n * Audio bitrate. Optional.\n * @internal\n * @readonly\n */\n bitrate?: number | null;\n /**\n * Audio format. Optional.\n * @internal\n * @readonly\n */\n format?: string | null;\n /**\n * Audio duration in seconds. Optional.\n * @internal\n * @readonly\n */\n duration?: number | null;\n /**\n * Audio size in bytes. Optional.\n * @internal\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 interface FileReady {\n }\n interface FileFailed {\n }\n interface GenerateFilesDownloadUrlRequest {\n /** A list of file urls to download */\n fileIds?: string[];\n }\n interface GenerateFilesDownloadUrlResponse {\n /** The download URL for the file(s) */\n downloadUrl?: string;\n }\n interface GenerateFileDownloadUrlRequest {\n /** Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager */\n fileId: string;\n /** The downloaded file's name. Defaults to the file's name displayed in the Media Manager */\n downloadFileName?: string | null;\n /** The time (in minutes) it takes for the download URL to expire. Defaults to 600. Limit is 525600 (1 year). */\n expirationInMinutes?: number | null;\n /** The redirect URL for when the download URL with a token has expired. Defaults to a 403 Forbidden response page. */\n expirationRedirectUrl?: string | null;\n /**\n * Optional Asset key\n * The asset key is used to download a specific asset of the file\n * A special asset key called `src` is used as a default, and describe the original file\n */\n assetKeys?: string[] | null;\n }\n interface GenerateFileDownloadUrlResponse {\n /** A list containing requested download formats of the file */\n downloadUrls?: DownloadUrl[];\n }\n interface DownloadUrl {\n /** The download URL for the file */\n url?: string;\n /** The asset key of the file that this url points to, `src` is the original asset */\n assetKey?: string;\n }\n interface GetFileDescriptorRequest {\n /** Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager */\n fileId: string;\n }\n interface GetFileDescriptorResponse {\n /** The information of the file */\n file?: FileDescriptor;\n }\n interface UpdateFileRequest {\n /** The id of the file to update */\n fileId: string;\n /** Optional - New file name */\n displayName?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder, effectively moving the file\n */\n parentFolderId?: string | null;\n /**\n * Optional - A list of terms that describe the media item.\n * The labels of the item will be replaced with the value provided here\n */\n labels?: string[] | null;\n }\n interface UpdateFileResponse {\n /** A file object containing the newly updated file info */\n file?: FileDescriptor;\n }\n interface GenerateFileUploadUrlRequest {\n /** The mime type of the file that will be uploaded */\n mimeType: string | null;\n /**\n * Optional - The current file name used to identify the file type\n * The actual display name will get taken from the upload request\n */\n fileName?: string | null;\n /** Size of the uploaded file in bytes */\n sizeInBytes?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder\n */\n parentFolderId?: string | null;\n /**\n * Optional - if set to true, make the file private\n * See `Private Files` in terminology\n */\n private?: boolean | null;\n /** Optional - a list of file labels */\n labels?: string[] | null;\n }\n interface GenerateFileUploadUrlResponse {\n /** The single use upload url */\n uploadUrl?: string;\n }\n interface GenerateFileResumableUploadUrlRequest {\n /** The mime type of the file that will be uploaded */\n mimeType: string | null;\n /** Optional -The display name that appears in the Media Manager. */\n fileName?: string | null;\n /** Size of the uploaded file in bytes */\n sizeInBytes?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder\n */\n parentFolderId?: string | null;\n /**\n * Optional - if set to true, make the file private\n * See `Private Files` in terminology\n */\n private?: boolean | null;\n /**\n * Optional - A list of terms that describe the media item.\n * The labels of the item will be replaced with the value provided here\n */\n labels?: string[] | null;\n /**\n * Optional - default to TUS\n * The upload protocol that should be used when interacting with the resumable upload url that will be returned\n */\n uploadProtocol?: UploadProtocol;\n }\n enum UploadProtocol {\n /** Use upload protocol */\n TUS = \"TUS\"\n }\n interface GenerateFileResumableUploadUrlResponse {\n /** The upload protocol that should be used when interacting with the url in the response */\n uploadProtocol?: UploadProtocol;\n /** The single use upload url */\n uploadUrl?: string;\n /** The single use upload token */\n uploadToken?: string;\n }\n interface ImportFileRequest {\n /** A publicly accessible url of the file to be imported */\n url: string;\n /** Optional -The display name that appears in the Media Manager. */\n displayName?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder\n */\n parentFolderId?: string | null;\n /**\n * Optional - if set to true, make the file private\n * See `Private Files` in terminology\n */\n private?: boolean | null;\n /**\n * Optional - A list of terms that describe the media item.\n * The labels of the item will be replaced with the value provided here\n */\n labels?: string[] | null;\n /** The mime type of the file that will be imported */\n mimeType?: string;\n }\n interface ImportFileResponse {\n /**\n * A file object containing initial details on the file that will be imported\n * This object will not contain the \"media\" property of the File object\n */\n file?: FileDescriptor;\n }\n interface BulkImportFilesRequest {\n /** A list of import requests */\n importFileRequests?: ImportFileRequest[];\n }\n interface BulkImportFilesResponse {\n /**\n * A list of file objects containing initial details on the files that will be imported\n * Each object will not contain the \"media\" property of the File object\n */\n files?: FileDescriptor[];\n }\n interface ListFilesRequest {\n /** Optional list files in a specific folder */\n parentFolderId?: string | null;\n /** Optional list of media types */\n mediaTypes?: MediaType[];\n /** Optional list only private or non-private files */\n private?: boolean | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting;\n /** Optional current cursor of the request if it exist */\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 ListFilesResponse {\n /** The information for the files matching the query */\n files?: FileDescriptor[];\n /** The next cursor if one exists */\n nextCursor?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\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 * @internal\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 }\n interface GenerateVideoStreamingUrlRequest {\n /** Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager */\n fileId: string;\n /** The information for the files matching the query */\n format?: StreamFormat;\n }\n enum StreamFormat {\n UNKNOWN = \"UNKNOWN\",\n HLS = \"HLS\",\n DASH = \"DASH\"\n }\n interface GenerateVideoStreamingUrlResponse {\n /** A url for the requested streaming format */\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 /** List of file urls to move to Media Manager's trash */\n fileIds?: string[];\n }\n interface BulkDeleteFilesResponse {\n }\n interface BulkRemoveFilesFromTrashBinRequest {\n /** List of file ids to remove from Media Manager's trash - permanently delete files */\n fileIds?: string[];\n }\n interface BulkRemoveFilesFromTrashBinResponse {\n }\n interface BulkRestoreFilesFromTrashBinRequest {\n /** List of file ids to restore from Media Manager's trash */\n fileIds?: string[];\n }\n interface BulkRestoreFilesFromTrashBinResponse {\n }\n interface ListDeletedFilesRequest {\n /** Optional list files in a specific folder */\n parentFolderId?: string | null;\n /** Optional list of media types */\n mediaTypes?: MediaType[];\n /** Optional list only private or non-private files */\n private?: boolean | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting;\n /** Optional current cursor of the request if it exist */\n cursorPaging?: CursorPaging;\n }\n interface ListDeletedFilesResponse {\n /** List of file info that will be restored */\n files?: FileDescriptor[];\n /** The next cursor if one exists */\n nextCursor?: PagingMetadataV2;\n }\n /**\n * Returns a download URL for downloading a compressed file containing all the requested files.\n * The compressed file can contain up to 1000 files\n */\n function generateFilesDownloadUrl(options?: GenerateFilesDownloadUrlOptions): Promise;\n interface GenerateFilesDownloadUrlOptions {\n /** A list of file urls to download */\n fileIds?: string[];\n }\n /**\n * Gets a download URL that includes a temporary token from the Media Manager for a specified file\n * Use this to grant access to a private file, or to provide a redirect url after the token expiration\n * @param fileId - Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager\n * @requiredField fileId\n */\n function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise;\n interface GenerateFileDownloadUrlOptions {\n /** The downloaded file's name. Defaults to the file's name displayed in the Media Manager */\n downloadFileName?: string | null;\n /** The time (in minutes) it takes for the download URL to expire. Defaults to 600. Limit is 525600 (1 year). */\n expirationInMinutes?: number | null;\n /** The redirect URL for when the download URL with a token has expired. Defaults to a 403 Forbidden response page. */\n expirationRedirectUrl?: string | null;\n /**\n * Optional Asset key\n * The asset key is used to download a specific asset of the file\n * A special asset key called `src` is used as a default, and describe the original file\n */\n assetKeys?: string[] | null;\n }\n /**\n * Gets a file's information from the Media Manager\n * @param fileId - Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager\n * @requiredField fileId\n */\n function getFileDescriptor(fileId: string): Promise;\n /**\n * Update the file, allowing renaming and moving the file\n * @param fileId - The id of the file to update\n * @requiredField fileId\n */\n function updateFile(fileId: string, options?: UpdateFileOptions): Promise;\n interface UpdateFileOptions {\n /** Optional - New file name */\n displayName?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder, effectively moving the file\n */\n parentFolderId?: string | null;\n /**\n * Optional - A list of terms that describe the media item.\n * The labels of the item will be replaced with the value provided here\n */\n labels?: string[] | null;\n }\n /**\n * Returns an upload URL to allow an external client to upload a single file to the site's Media\n * @param mimeType - The mime type of the file that will be uploaded\n * @requiredField mimeType\n */\n function generateFileUploadUrl(mimeType: string | null, options?: GenerateFileUploadUrlOptions): Promise;\n interface GenerateFileUploadUrlOptions {\n /**\n * Optional - The current file name used to identify the file type\n * The actual display name will get taken from the upload request\n */\n fileName?: string | null;\n /** Size of the uploaded file in bytes */\n sizeInBytes?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder\n */\n parentFolderId?: string | null;\n /**\n * Optional - if set to true, make the file private\n * See `Private Files` in terminology\n */\n private?: boolean | null;\n /** Optional - a list of file labels */\n labels?: string[] | null;\n }\n /**\n * Returns an resumable upload URL to allow an external client to upload a single file to the site's Media\n * Resumable upload is recommended for files larger then 10MB or when network connection is poor\n * Wix supports TUS protocol - https://tus.io/\n * This protocol has implementations in multiple languages that can be used to manage the resumable upload processza\n * @param mimeType - The mime type of the file that will be uploaded\n * @requiredField mimeType\n */\n function generateFileResumableUploadUrl(mimeType: string | null, options?: GenerateFileResumableUploadUrlOptions): Promise;\n interface GenerateFileResumableUploadUrlOptions {\n /** Optional -The display name that appears in the Media Manager. */\n fileName?: string | null;\n /** Size of the uploaded file in bytes */\n sizeInBytes?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder\n */\n parentFolderId?: string | null;\n /**\n * Optional - if set to true, make the file private\n * See `Private Files` in terminology\n */\n private?: boolean | null;\n /**\n * Optional - A list of terms that describe the media item.\n * The labels of the item will be replaced with the value provided here\n */\n labels?: string[] | null;\n /**\n * Optional - default to TUS\n * The upload protocol that should be used when interacting with the resumable upload url that will be returned\n */\n uploadProtocol?: UploadProtocol;\n }\n /**\n * Returns partial file info of the file that will be imported\n * @param url - A publicly accessible url of the file to be imported\n * @requiredField url\n */\n function importFile(url: string, options?: ImportFileOptions): Promise;\n interface ImportFileOptions {\n /** Optional -The display name that appears in the Media Manager. */\n displayName?: string | null;\n /**\n * Optional - A folder id\n * If provided, nest the file under this folder\n */\n parentFolderId?: string | null;\n /**\n * Optional - if set to true, make the file private\n * See `Private Files` in terminology\n */\n private?: boolean | null;\n /**\n * Optional - A list of terms that describe the media item.\n * The labels of the item will be replaced with the value provided here\n */\n labels?: string[] | null;\n /** The mime type of the file that will be imported */\n mimeType?: string;\n }\n /** Bulk import files from external URLs, returns partial file info of the file that will be imported */\n function bulkImportFiles(options?: BulkImportFilesOptions): Promise;\n interface BulkImportFilesOptions {\n /** A list of import requests */\n importFileRequests?: ImportFileRequest[];\n }\n /** Return a list of files matching the query */\n function listFiles(options?: ListFilesOptions): Promise;\n interface ListFilesOptions {\n /** Optional list files in a specific folder */\n parentFolderId?: string | null;\n /** Optional list of media types */\n mediaTypes?: MediaType[];\n /** Optional list only private or non-private files */\n private?: boolean | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting;\n /** Optional current cursor of the request if it exist */\n cursorPaging?: CursorPaging;\n }\n /**\n * Return a url info object containing the stream url\n * @param fileId - Internal name (unique identifier) which is generated when a file is uploaded by the Media Manager\n * @requiredField fileId\n */\n function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise;\n interface GenerateVideoStreamingUrlOptions {\n /** The information for the files matching the query */\n format?: StreamFormat;\n }\n /**\n * Return a token for a direct web socket notification channel\n * This API is not platformized (Contact the Media team for use instructions)\n * This API should be internal only\n */\n function generateWebSocketToken(): Promise;\n /**\n * Move files listed to Media Manager's trash\n * Moving many files to trash at once is an asynchronous action. It may take some time for the results to be seen in the Media Manager.\n * Attempting to move already-trashed files to trash again doesn't result in an error.\n */\n function bulkDeleteFiles(options?: BulkDeleteFilesOptions): Promise;\n interface BulkDeleteFilesOptions {\n /** List of file urls to move to Media Manager's trash */\n fileIds?: string[];\n }\n /**\n * Permanently deletes a file from the site media, this action is not reversible\n * Make sure this file is not used in a site or in any other way as it will break\n */\n function bulkRemoveFilesFromTrashBin(options?: BulkRemoveFilesFromTrashBinOptions): Promise;\n interface BulkRemoveFilesFromTrashBinOptions {\n /** List of file ids to remove from Media Manager's trash - permanently delete files */\n fileIds?: string[];\n }\n /** Restore a file to its original location in the site media. */\n function bulkRestoreFilesFromTrashBin(options?: BulkRestoreFilesFromTrashBinOptions): Promise;\n interface BulkRestoreFilesFromTrashBinOptions {\n /** List of file ids to restore from Media Manager's trash */\n fileIds?: string[];\n }\n /** Returns a list of the file infos of all the deleted files as directed by the filter. */\n function listDeletedFiles(options?: ListDeletedFilesOptions): Promise;\n interface ListDeletedFilesOptions {\n /** Optional list files in a specific folder */\n parentFolderId?: string | null;\n /** Optional list of media types */\n mediaTypes?: MediaType[];\n /** Optional list only private or non-private files */\n private?: boolean | null;\n /**\n * Optional one of \"displayName\"/\"updatedDate\"\n * Default updatedDate desc\n */\n sort?: Sorting;\n /** Optional current cursor of the request if it exist */\n cursorPaging?: CursorPaging;\n }\n \n const mediaSiteMediaV1FileDescriptor_universal_d___debug: typeof __debug;\n type mediaSiteMediaV1FileDescriptor_universal_d_FileDescriptor = FileDescriptor;\n type mediaSiteMediaV1FileDescriptor_universal_d_MediaType = MediaType;\n const mediaSiteMediaV1FileDescriptor_universal_d_MediaType: typeof MediaType;\n type mediaSiteMediaV1FileDescriptor_universal_d_FileMedia = FileMedia;\n type mediaSiteMediaV1FileDescriptor_universal_d_FileMediaMediaOneOf = FileMediaMediaOneOf;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImageMedia = ImageMedia;\n type mediaSiteMediaV1FileDescriptor_universal_d_Colors = Colors;\n type mediaSiteMediaV1FileDescriptor_universal_d_Color = Color;\n type mediaSiteMediaV1FileDescriptor_universal_d_ColorRGB = ColorRGB;\n type mediaSiteMediaV1FileDescriptor_universal_d_FaceRecognition = FaceRecognition;\n type mediaSiteMediaV1FileDescriptor_universal_d_VideoResolution = VideoResolution;\n type mediaSiteMediaV1FileDescriptor_universal_d_AudioV2 = AudioV2;\n type mediaSiteMediaV1FileDescriptor_universal_d_OperationStatus = OperationStatus;\n const mediaSiteMediaV1FileDescriptor_universal_d_OperationStatus: typeof OperationStatus;\n type mediaSiteMediaV1FileDescriptor_universal_d_FileReady = FileReady;\n type mediaSiteMediaV1FileDescriptor_universal_d_FileFailed = FileFailed;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlRequest = GenerateFilesDownloadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlResponse = GenerateFilesDownloadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlRequest = GenerateFileDownloadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlResponse = GenerateFileDownloadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_DownloadUrl = DownloadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorRequest = GetFileDescriptorRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorResponse = GetFileDescriptorResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileRequest = UpdateFileRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileResponse = UpdateFileResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlRequest = GenerateFileUploadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlResponse = GenerateFileUploadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlRequest = GenerateFileResumableUploadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_UploadProtocol = UploadProtocol;\n const mediaSiteMediaV1FileDescriptor_universal_d_UploadProtocol: typeof UploadProtocol;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlResponse = GenerateFileResumableUploadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImportFileRequest = ImportFileRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImportFileResponse = ImportFileResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesRequest = BulkImportFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesResponse = BulkImportFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListFilesRequest = ListFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_Sorting = Sorting;\n type mediaSiteMediaV1FileDescriptor_universal_d_SortOrder = SortOrder;\n const mediaSiteMediaV1FileDescriptor_universal_d_SortOrder: typeof SortOrder;\n type mediaSiteMediaV1FileDescriptor_universal_d_CursorPaging = CursorPaging;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListFilesResponse = ListFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type mediaSiteMediaV1FileDescriptor_universal_d_Cursors = Cursors;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlRequest = GenerateVideoStreamingUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_StreamFormat = StreamFormat;\n const mediaSiteMediaV1FileDescriptor_universal_d_StreamFormat: typeof StreamFormat;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlResponse = GenerateVideoStreamingUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenRequest = GenerateWebSocketTokenRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenResponse = GenerateWebSocketTokenResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesRequest = BulkDeleteFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesResponse = BulkDeleteFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRemoveFilesFromTrashBinRequest = BulkRemoveFilesFromTrashBinRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRemoveFilesFromTrashBinResponse = BulkRemoveFilesFromTrashBinResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinRequest = BulkRestoreFilesFromTrashBinRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinResponse = BulkRestoreFilesFromTrashBinResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesRequest = ListDeletedFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesResponse = ListDeletedFilesResponse;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFilesDownloadUrl: typeof generateFilesDownloadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlOptions = GenerateFilesDownloadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFileDownloadUrl: typeof generateFileDownloadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlOptions = GenerateFileDownloadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_getFileDescriptor: typeof getFileDescriptor;\n const mediaSiteMediaV1FileDescriptor_universal_d_updateFile: typeof updateFile;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileOptions = UpdateFileOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFileUploadUrl: typeof generateFileUploadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlOptions = GenerateFileUploadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFileResumableUploadUrl: typeof generateFileResumableUploadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlOptions = GenerateFileResumableUploadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_importFile: typeof importFile;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImportFileOptions = ImportFileOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkImportFiles: typeof bulkImportFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesOptions = BulkImportFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_listFiles: typeof listFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListFilesOptions = ListFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateVideoStreamingUrl: typeof generateVideoStreamingUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlOptions = GenerateVideoStreamingUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateWebSocketToken: typeof generateWebSocketToken;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkDeleteFiles: typeof bulkDeleteFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesOptions = BulkDeleteFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkRemoveFilesFromTrashBin: typeof bulkRemoveFilesFromTrashBin;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRemoveFilesFromTrashBinOptions = BulkRemoveFilesFromTrashBinOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkRestoreFilesFromTrashBin: typeof bulkRestoreFilesFromTrashBin;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinOptions = BulkRestoreFilesFromTrashBinOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_listDeletedFiles: typeof listDeletedFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesOptions = ListDeletedFilesOptions;\n namespace mediaSiteMediaV1FileDescriptor_universal_d {\n export {\n mediaSiteMediaV1FileDescriptor_universal_d___debug as __debug,\n mediaSiteMediaV1FileDescriptor_universal_d_FileDescriptor as FileDescriptor,\n mediaSiteMediaV1FileDescriptor_universal_d_MediaType as MediaType,\n mediaSiteMediaV1FileDescriptor_universal_d_FileMedia as FileMedia,\n mediaSiteMediaV1FileDescriptor_universal_d_FileMediaMediaOneOf as FileMediaMediaOneOf,\n mediaSiteMediaV1FileDescriptor_universal_d_ImageMedia as ImageMedia,\n mediaSiteMediaV1FileDescriptor_universal_d_Colors as Colors,\n mediaSiteMediaV1FileDescriptor_universal_d_Color as Color,\n mediaSiteMediaV1FileDescriptor_universal_d_ColorRGB as ColorRGB,\n mediaSiteMediaV1FileDescriptor_universal_d_FaceRecognition as FaceRecognition,\n mediaSiteMediaV1FileDescriptor_universal_d_VideoResolution as VideoResolution,\n mediaSiteMediaV1FileDescriptor_universal_d_AudioV2 as AudioV2,\n mediaSiteMediaV1FileDescriptor_universal_d_OperationStatus as OperationStatus,\n mediaSiteMediaV1FileDescriptor_universal_d_FileReady as FileReady,\n mediaSiteMediaV1FileDescriptor_universal_d_FileFailed as FileFailed,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlRequest as GenerateFilesDownloadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlResponse as GenerateFilesDownloadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlRequest as GenerateFileDownloadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlResponse as GenerateFileDownloadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_DownloadUrl as DownloadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorRequest as GetFileDescriptorRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorResponse as GetFileDescriptorResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileRequest as UpdateFileRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileResponse as UpdateFileResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlRequest as GenerateFileUploadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlResponse as GenerateFileUploadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlRequest as GenerateFileResumableUploadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_UploadProtocol as UploadProtocol,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlResponse as GenerateFileResumableUploadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_ImportFileRequest as ImportFileRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ImportFileResponse as ImportFileResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesRequest as BulkImportFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesResponse as BulkImportFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_ListFilesRequest as ListFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_Sorting as Sorting,\n mediaSiteMediaV1FileDescriptor_universal_d_SortOrder as SortOrder,\n mediaSiteMediaV1FileDescriptor_universal_d_CursorPaging as CursorPaging,\n mediaSiteMediaV1FileDescriptor_universal_d_ListFilesResponse as ListFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_PagingMetadataV2 as PagingMetadataV2,\n mediaSiteMediaV1FileDescriptor_universal_d_Cursors as Cursors,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlRequest as GenerateVideoStreamingUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_StreamFormat as StreamFormat,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlResponse as GenerateVideoStreamingUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenRequest as GenerateWebSocketTokenRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenResponse as GenerateWebSocketTokenResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesRequest as BulkDeleteFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesResponse as BulkDeleteFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRemoveFilesFromTrashBinRequest as BulkRemoveFilesFromTrashBinRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRemoveFilesFromTrashBinResponse as BulkRemoveFilesFromTrashBinResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinRequest as BulkRestoreFilesFromTrashBinRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinResponse as BulkRestoreFilesFromTrashBinResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesRequest as ListDeletedFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesResponse as ListDeletedFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFilesDownloadUrl as generateFilesDownloadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlOptions as GenerateFilesDownloadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFileDownloadUrl as generateFileDownloadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlOptions as GenerateFileDownloadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_getFileDescriptor as getFileDescriptor,\n mediaSiteMediaV1FileDescriptor_universal_d_updateFile as updateFile,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileOptions as UpdateFileOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFileUploadUrl as generateFileUploadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlOptions as GenerateFileUploadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFileResumableUploadUrl as generateFileResumableUploadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlOptions as GenerateFileResumableUploadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_importFile as importFile,\n mediaSiteMediaV1FileDescriptor_universal_d_ImportFileOptions as ImportFileOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkImportFiles as bulkImportFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesOptions as BulkImportFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_listFiles as listFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_ListFilesOptions as ListFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateVideoStreamingUrl as generateVideoStreamingUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlOptions as GenerateVideoStreamingUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateWebSocketToken as generateWebSocketToken,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkDeleteFiles as bulkDeleteFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesOptions as BulkDeleteFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkRemoveFilesFromTrashBin as bulkRemoveFilesFromTrashBin,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRemoveFilesFromTrashBinOptions as BulkRemoveFilesFromTrashBinOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkRestoreFilesFromTrashBin as bulkRestoreFilesFromTrashBin,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinOptions as BulkRestoreFilesFromTrashBinOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_listDeletedFiles as listDeletedFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesOptions as ListDeletedFilesOptions,\n };\n }\n \n export { mediaSiteMediaV1FileDescriptor_universal_d as files, mediaSiteMediaV1Folder_universal_d as folders };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-coreservices-v1-coupons-provider.d.ts", "content": "declare module \"interfaces-coreservices-v1-coupons-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface CouponsProvider {\n }\n interface CalculateCartRequest {\n /** The id of the cart */\n cardId?: string;\n /** The number of items in th cart */\n numberOfItems?: number;\n /** just a field */\n someonesName?: string;\n /** the time of the cart */\n someTime?: Date | null;\n complexMessage?: ComplexMessage;\n }\n interface ComplexMessage {\n a?: string;\n b?: string;\n anAddress?: Address;\n anImage?: string;\n deepMessage?: DeepMessage;\n }\n /** Physical address */\n interface Address extends AddressStreetOneOf {\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 DeepMessage {\n a?: string;\n }\n interface CalculateCartResponse {\n /** The id of the cart */\n cardId?: string;\n /** The number of items in th cart */\n numberOfItems?: number;\n /** just a field */\n someonesName?: string;\n /** the time of the cart */\n someTime?: Date | null;\n complexMessage?: ComplexMessage;\n }\n interface TypeNotSupportedError {\n /** The received type that is not supported by the service */\n type?: string;\n }\n interface ReserveCouponRequest {\n }\n interface ReserveCouponResponse {\n }\n interface RedeemCouponRequest {\n }\n interface RedeemCouponResponse {\n }\n interface ExtendCouponRequest {\n }\n interface ExtendCouponResponse {\n }\n interface CouponsProviderConfig {\n /** specific field related to this SPI */\n supportedCouponTypes?: string[];\n /** feature toggle initialized with default value = false. should be true if implemented by spi provider */\n toggleExtendCouponEnabled?: 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, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\n interface Context {\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 requestId?: string | null;\n /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */\n currency?: string | null;\n /** An object that describes the identity that triggered this request. */\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. For example, `\"en-US\"`. */\n languages?: string[];\n /** The service provider app's instance ID. */\n instanceId?: string | null;\n /**\n * Extension ID in Dev Center.\n * @internal\n */\n appExtensionId?: string | null;\n /**\n * Extension type in Dev Center.\n * @internal\n */\n appExtensionType?: string | null;\n /**\n * Invoked function.\n * @internal\n */\n functionName?: 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 CalculateCartOptions {\n /** The id of the cart */\n cardId?: string;\n /** The number of items in th cart */\n numberOfItems?: number;\n /** just a field */\n someonesName?: string;\n /** the time of the cart */\n someTime?: Date | null;\n complexMessage?: ComplexMessage;\n }\n \n function couponNotSupportedError(data: TypeNotSupportedError): BusinessError;\n \n const calculateCartSpiErrors_d_couponNotSupportedError: typeof couponNotSupportedError;\n namespace calculateCartSpiErrors_d {\n export {\n calculateCartSpiErrors_d_couponNotSupportedError as couponNotSupportedError,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n calculateCartSpiErrors_d as calculateCart,\n };\n }\n \n export { Address, AddressLocation, AddressStreetOneOf, BusinessError, CalculateCartOptions, CalculateCartRequest, CalculateCartResponse, ComplexMessage, Context, CouponsProvider, CouponsProviderConfig, DeepMessage, ExtendCouponRequest, ExtendCouponResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, RedeemCouponRequest, RedeemCouponResponse, ReserveCouponRequest, ReserveCouponResponse, StandardDetails, StreetAddress, Subdivision, SubdivisionType, TypeNotSupportedError, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-forms-backend.d.ts", "content": "declare module \"wix-forms-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface FormSubmission {\n /**\n * Submission id.\n * @readonly\n */\n _id?: string | null;\n /** Id of a form to which submission belongs. */\n formId?: string;\n /**\n * Form namespace to which submissions belong.\n * @readonly\n */\n namespace?: string;\n /** Status of the submission. */\n status?: SubmissionStatus;\n /** Submission values where key is a target of a form field and value is a submissions for the given field. */\n submissions?: Record;\n /**\n * Date of creation.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date of last update.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Renamed to submitter\n * @internal\n * @readonly\n */\n owner?: Owner;\n /**\n * Identification of submission creator\n * @readonly\n */\n submitter?: Submitter;\n /** Flag identifying if submission was read by user */\n seen?: boolean;\n }\n enum SubmissionStatus {\n UNDEFINED = \"UNDEFINED\",\n PENDING = \"PENDING\",\n CONFIRMED = \"CONFIRMED\"\n }\n interface Owner extends OwnerOwnerOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Service ID. */\n serviceId?: string | null;\n /** User ID. */\n userId?: string | null;\n /** External app id */\n externalAppId?: string | null;\n }\n /** @oneof */\n interface OwnerOwnerOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Service ID. */\n serviceId?: string | null;\n /** User ID. */\n userId?: string | null;\n /** External app id */\n externalAppId?: string | null;\n }\n interface Submitter extends SubmitterSubmitterOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Service ID. */\n serviceId?: string | null;\n /** User ID. */\n userId?: string | null;\n /** External app id */\n externalAppId?: string | null;\n }\n /** @oneof */\n interface SubmitterSubmitterOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** Service ID. */\n serviceId?: string | null;\n /** User ID. */\n userId?: string | null;\n /** External app id */\n externalAppId?: 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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n entityUpdates?: Record;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty$1 {\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 /**\n * Mapped contact emails.\n * @readonly\n */\n emails?: string[];\n /** Identifies the namespace that the submission's form belongs to. */\n namespace?: string;\n }\n interface CreateSubmissionRequest {\n /** Submission to be created. */\n submission: FormSubmission;\n /** Captcha token */\n captchaToken?: string | null;\n }\n interface CreateSubmissionResponse {\n /** The created submission. */\n submission?: FormSubmission;\n }\n interface CreateSubmissionByOwnerRequest {\n /** Submission to be created. */\n submission: FormSubmission;\n }\n interface CreateSubmissionByOwnerResponse {\n /** The created submission. */\n submission?: FormSubmission;\n }\n interface CreateSubmissionBySubmitterRequest {\n /** Submission to be created. */\n submission: FormSubmission;\n }\n interface CreateSubmissionBySubmitterResponse {\n /** The created submission. */\n submission?: FormSubmission;\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 UpdateSubmissionRequest {\n /** Submission to be updated, may be partial. */\n submission: FormSubmission;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateSubmissionResponse {\n /** The updated submission. */\n submission?: FormSubmission;\n }\n interface ConfirmSubmissionRequest {\n /** Submission id. */\n submissionId: string;\n }\n interface ConfirmSubmissionResponse {\n /** Confirmed submission. */\n submission?: FormSubmission;\n }\n interface DeleteSubmissionRequest {\n /** Id of the submission to delete. */\n submissionId: string;\n }\n interface DeleteSubmissionResponse {\n }\n interface QuerySubmissionRequest {\n /** WQL expression. */\n query: CursorQuery$1;\n /**\n * Renamed to only_your_own;\n * @internal\n */\n onlyOwn?: boolean;\n /** Return only own submissions. */\n onlyYourOwn?: boolean;\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$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 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 }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$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 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 {\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 QuerySubmissionResponse {\n /** The retrieved Submissions. */\n submissions?: FormSubmission[];\n /** Paging metadata. */\n metadata?: 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 CountSubmissionsRequest {\n /** Form IDs. */\n formIds: string[];\n /** Identifies the namespace that the forms belong to. */\n namespace: string;\n }\n interface CountSubmissionsResponse {\n /** Forms submissions count. */\n formsSubmissionsCount?: FormSubmissionsCount[];\n }\n interface FormSubmissionsCount {\n /** Form ID. */\n formId?: string;\n /** Total form submissions count. */\n totalCount?: number;\n /** Unseen form submissions count. */\n unseenCount?: number;\n }\n interface GetMediaUploadURLRequest {\n /** Form id. */\n formId: string;\n /** Name of file to upload. */\n filename: string;\n /** Mime type of file to upload. */\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 /** Submissions form id. */\n formId: string;\n }\n interface BulkMarkSubmissionsAsSeenResponse {\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 /**\n * Upserts contact from submission.\n * @param submissionId - Submission from which contact needs to be upserted.\n * @internal\n * @documentationMaturity preview\n * @requiredField submissionId\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 /**\n * Creates a new submission.\n * @param submission - Submission to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField submission\n * @requiredField submission.formId\n */\n function createSubmission(submission: FormSubmission, options?: CreateSubmissionOptions): Promise;\n interface CreateSubmissionOptions {\n /** Captcha token */\n captchaToken?: string | null;\n }\n /**\n * Creates a new submission with specified submitter.\n * Internal, migration only.\n * @param submission - Submission to be created.\n * @internal\n * @documentationMaturity preview\n * @requiredField submission\n * @requiredField submission.formId\n * @requiredField submission.submitter\n * @returns The created submission.\n */\n function createSubmissionBySubmitter(submission: FormSubmission): Promise;\n /**\n * Gets a submission by id.\n * @param submissionId - Id of the submission to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n * @returns The retrieved submission.\n */\n function getSubmission(submissionId: string): Promise;\n /**\n * Updates a submission, supports partial update.\n * You need to pass the latest 'revision' for a successful update.\n * @param _id - Submission id.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField submission\n * @requiredField submission.formId\n * @requiredField submission.revision\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 a form to which submission belongs. */\n formId?: string;\n /**\n * Form namespace to which submissions belong.\n * @readonly\n */\n namespace?: string;\n /** Status of the submission. */\n status?: SubmissionStatus;\n /** Submission values where key is a target of a form field and value is a submissions for the given field. */\n submissions?: Record;\n /**\n * Date of creation.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date of last update.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Renamed to submitter\n * @internal\n * @readonly\n */\n owner?: Owner;\n /**\n * Identification of submission creator\n * @readonly\n */\n submitter?: Submitter;\n /** Flag identifying if submission was read by user */\n seen?: boolean;\n }\n interface UpdateSubmissionOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Change submission status to 'CONFIRMED'\n * @param submissionId - Submission id.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n */\n function confirmSubmission(submissionId: string): Promise;\n /**\n * Deletes a submission.\n * @param submissionId - Id of the submission to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField submissionId\n */\n function deleteSubmission(submissionId: string): Promise;\n /**\n * Query submissions using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n */\n function querySubmission(options?: QuerySubmissionOptions): SubmissionsQueryBuilder;\n interface QuerySubmissionOptions {\n /**\n * Renamed to only_your_own;\n * @internal\n */\n onlyOwn?: boolean | undefined;\n /** Return only own submissions. */\n onlyYourOwn?: boolean | undefined;\n }\n interface QueryCursorResult$1 {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface SubmissionsQueryResult extends QueryCursorResult$1 {\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 * @documentationMaturity preview\n */\n eq: (propertyName: '_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;\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' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate', value: any) => SubmissionsQueryBuilder;\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) => SubmissionsQueryBuilder;\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) => SubmissionsQueryBuilder;\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) => SubmissionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'formId' | 'namespace' | '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 * @documentationMaturity preview\n */\n ascending: (...propertyNames: Array<'_id' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate'>) => SubmissionsQueryBuilder;\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' | 'formId' | 'namespace' | 'status' | '_createdDate' | '_updatedDate'>) => SubmissionsQueryBuilder;\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) => SubmissionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => SubmissionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts forms submissions.\n * @param formIds - Form IDs.\n * @public\n * @documentationMaturity preview\n * @requiredField formIds\n * @requiredField options\n * @requiredField options.namespace\n */\n function countSubmissions(formIds: string[], options: CountSubmissionsOptions): Promise;\n interface CountSubmissionsOptions {\n /** Identifies the namespace that the forms belong to. */\n namespace: string;\n }\n /**\n * Returns url to upload media file.\n * @param formId - Form id.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @requiredField options\n * @requiredField options.filename\n * @requiredField options.mimeType\n */\n function getMediaUploadUrl(formId: string, options: GetMediaUploadUrlOptions): Promise;\n interface GetMediaUploadUrlOptions {\n /** Name of file to upload. */\n filename: string;\n /** Mime type of file to upload. */\n mimeType: string;\n }\n /**\n * Marks submissions as seen.\n * @param ids - Submission ids to mark as seen.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @requiredField options\n * @requiredField options.formId\n */\n function bulkMarkSubmissionsAsSeen(ids: string[], options: BulkMarkSubmissionsAsSeenOptions): Promise;\n interface BulkMarkSubmissionsAsSeenOptions {\n /** Submissions form id. */\n formId: string;\n }\n \n const formsV4Submission_universal_d___debug: typeof __debug;\n type formsV4Submission_universal_d_FormSubmission = FormSubmission;\n type formsV4Submission_universal_d_SubmissionStatus = SubmissionStatus;\n const formsV4Submission_universal_d_SubmissionStatus: typeof SubmissionStatus;\n type formsV4Submission_universal_d_Owner = Owner;\n type formsV4Submission_universal_d_OwnerOwnerOneOf = OwnerOwnerOneOf;\n type formsV4Submission_universal_d_Submitter = Submitter;\n type formsV4Submission_universal_d_SubmitterSubmitterOneOf = SubmitterSubmitterOneOf;\n type formsV4Submission_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type formsV4Submission_universal_d_UpsertContactFromSubmissionRequest = UpsertContactFromSubmissionRequest;\n type formsV4Submission_universal_d_UpsertContactFromSubmissionResponse = UpsertContactFromSubmissionResponse;\n type formsV4Submission_universal_d_SubmitContactResponse = SubmitContactResponse;\n type formsV4Submission_universal_d_IdentityType = IdentityType;\n const formsV4Submission_universal_d_IdentityType: typeof IdentityType;\n type formsV4Submission_universal_d_SubmissionContactMapped = SubmissionContactMapped;\n type formsV4Submission_universal_d_CreateSubmissionRequest = CreateSubmissionRequest;\n type formsV4Submission_universal_d_CreateSubmissionResponse = CreateSubmissionResponse;\n type formsV4Submission_universal_d_CreateSubmissionByOwnerRequest = CreateSubmissionByOwnerRequest;\n type formsV4Submission_universal_d_CreateSubmissionByOwnerResponse = CreateSubmissionByOwnerResponse;\n type formsV4Submission_universal_d_CreateSubmissionBySubmitterRequest = CreateSubmissionBySubmitterRequest;\n type formsV4Submission_universal_d_CreateSubmissionBySubmitterResponse = CreateSubmissionBySubmitterResponse;\n type formsV4Submission_universal_d_GetSubmissionRequest = GetSubmissionRequest;\n type formsV4Submission_universal_d_GetSubmissionResponse = GetSubmissionResponse;\n type formsV4Submission_universal_d_UpdateSubmissionRequest = UpdateSubmissionRequest;\n type formsV4Submission_universal_d_UpdateSubmissionResponse = UpdateSubmissionResponse;\n type formsV4Submission_universal_d_ConfirmSubmissionRequest = ConfirmSubmissionRequest;\n type formsV4Submission_universal_d_ConfirmSubmissionResponse = ConfirmSubmissionResponse;\n type formsV4Submission_universal_d_DeleteSubmissionRequest = DeleteSubmissionRequest;\n type formsV4Submission_universal_d_DeleteSubmissionResponse = DeleteSubmissionResponse;\n type formsV4Submission_universal_d_QuerySubmissionRequest = QuerySubmissionRequest;\n type formsV4Submission_universal_d_CursorPaging = CursorPaging;\n type formsV4Submission_universal_d_QuerySubmissionResponse = QuerySubmissionResponse;\n type formsV4Submission_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type formsV4Submission_universal_d_Cursors = Cursors;\n type formsV4Submission_universal_d_CountSubmissionsRequest = CountSubmissionsRequest;\n type formsV4Submission_universal_d_CountSubmissionsResponse = CountSubmissionsResponse;\n type formsV4Submission_universal_d_FormSubmissionsCount = FormSubmissionsCount;\n type formsV4Submission_universal_d_GetMediaUploadURLRequest = GetMediaUploadURLRequest;\n type formsV4Submission_universal_d_GetMediaUploadURLResponse = GetMediaUploadURLResponse;\n type formsV4Submission_universal_d_BulkMarkSubmissionsAsSeenRequest = BulkMarkSubmissionsAsSeenRequest;\n type formsV4Submission_universal_d_BulkMarkSubmissionsAsSeenResponse = BulkMarkSubmissionsAsSeenResponse;\n type formsV4Submission_universal_d_Task = Task;\n type formsV4Submission_universal_d_TaskKey = TaskKey;\n type formsV4Submission_universal_d_TaskAction = TaskAction;\n type formsV4Submission_universal_d_TaskActionActionOneOf = TaskActionActionOneOf;\n type formsV4Submission_universal_d_Complete = Complete;\n type formsV4Submission_universal_d_Cancel = Cancel;\n type formsV4Submission_universal_d_Reschedule = Reschedule;\n const formsV4Submission_universal_d_upsertContactFromSubmission: typeof upsertContactFromSubmission;\n type formsV4Submission_universal_d_UpsertContactFromSubmissionOptions = UpsertContactFromSubmissionOptions;\n const formsV4Submission_universal_d_createSubmission: typeof createSubmission;\n type formsV4Submission_universal_d_CreateSubmissionOptions = CreateSubmissionOptions;\n const formsV4Submission_universal_d_createSubmissionBySubmitter: typeof createSubmissionBySubmitter;\n const formsV4Submission_universal_d_getSubmission: typeof getSubmission;\n const formsV4Submission_universal_d_updateSubmission: typeof updateSubmission;\n type formsV4Submission_universal_d_UpdateSubmission = UpdateSubmission;\n type formsV4Submission_universal_d_UpdateSubmissionOptions = UpdateSubmissionOptions;\n const formsV4Submission_universal_d_confirmSubmission: typeof confirmSubmission;\n const formsV4Submission_universal_d_deleteSubmission: typeof deleteSubmission;\n const formsV4Submission_universal_d_querySubmission: typeof querySubmission;\n type formsV4Submission_universal_d_QuerySubmissionOptions = QuerySubmissionOptions;\n type formsV4Submission_universal_d_SubmissionsQueryResult = SubmissionsQueryResult;\n type formsV4Submission_universal_d_SubmissionsQueryBuilder = SubmissionsQueryBuilder;\n const formsV4Submission_universal_d_countSubmissions: typeof countSubmissions;\n type formsV4Submission_universal_d_CountSubmissionsOptions = CountSubmissionsOptions;\n const formsV4Submission_universal_d_getMediaUploadUrl: typeof getMediaUploadUrl;\n type formsV4Submission_universal_d_GetMediaUploadUrlOptions = GetMediaUploadUrlOptions;\n const formsV4Submission_universal_d_bulkMarkSubmissionsAsSeen: typeof bulkMarkSubmissionsAsSeen;\n type formsV4Submission_universal_d_BulkMarkSubmissionsAsSeenOptions = BulkMarkSubmissionsAsSeenOptions;\n namespace formsV4Submission_universal_d {\n export {\n formsV4Submission_universal_d___debug as __debug,\n formsV4Submission_universal_d_FormSubmission as FormSubmission,\n formsV4Submission_universal_d_SubmissionStatus as SubmissionStatus,\n formsV4Submission_universal_d_Owner as Owner,\n formsV4Submission_universal_d_OwnerOwnerOneOf as OwnerOwnerOneOf,\n formsV4Submission_universal_d_Submitter as Submitter,\n formsV4Submission_universal_d_SubmitterSubmitterOneOf as SubmitterSubmitterOneOf,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n formsV4Submission_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n Empty$1 as Empty,\n formsV4Submission_universal_d_UpsertContactFromSubmissionRequest as UpsertContactFromSubmissionRequest,\n formsV4Submission_universal_d_UpsertContactFromSubmissionResponse as UpsertContactFromSubmissionResponse,\n formsV4Submission_universal_d_SubmitContactResponse as SubmitContactResponse,\n formsV4Submission_universal_d_IdentityType as IdentityType,\n formsV4Submission_universal_d_SubmissionContactMapped as SubmissionContactMapped,\n formsV4Submission_universal_d_CreateSubmissionRequest as CreateSubmissionRequest,\n formsV4Submission_universal_d_CreateSubmissionResponse as CreateSubmissionResponse,\n formsV4Submission_universal_d_CreateSubmissionByOwnerRequest as CreateSubmissionByOwnerRequest,\n formsV4Submission_universal_d_CreateSubmissionByOwnerResponse as CreateSubmissionByOwnerResponse,\n formsV4Submission_universal_d_CreateSubmissionBySubmitterRequest as CreateSubmissionBySubmitterRequest,\n formsV4Submission_universal_d_CreateSubmissionBySubmitterResponse as CreateSubmissionBySubmitterResponse,\n formsV4Submission_universal_d_GetSubmissionRequest as GetSubmissionRequest,\n formsV4Submission_universal_d_GetSubmissionResponse as GetSubmissionResponse,\n formsV4Submission_universal_d_UpdateSubmissionRequest as UpdateSubmissionRequest,\n formsV4Submission_universal_d_UpdateSubmissionResponse as UpdateSubmissionResponse,\n formsV4Submission_universal_d_ConfirmSubmissionRequest as ConfirmSubmissionRequest,\n formsV4Submission_universal_d_ConfirmSubmissionResponse as ConfirmSubmissionResponse,\n formsV4Submission_universal_d_DeleteSubmissionRequest as DeleteSubmissionRequest,\n formsV4Submission_universal_d_DeleteSubmissionResponse as DeleteSubmissionResponse,\n formsV4Submission_universal_d_QuerySubmissionRequest as QuerySubmissionRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n formsV4Submission_universal_d_CursorPaging as CursorPaging,\n formsV4Submission_universal_d_QuerySubmissionResponse as QuerySubmissionResponse,\n formsV4Submission_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n formsV4Submission_universal_d_Cursors as Cursors,\n formsV4Submission_universal_d_CountSubmissionsRequest as CountSubmissionsRequest,\n formsV4Submission_universal_d_CountSubmissionsResponse as CountSubmissionsResponse,\n formsV4Submission_universal_d_FormSubmissionsCount as FormSubmissionsCount,\n formsV4Submission_universal_d_GetMediaUploadURLRequest as GetMediaUploadURLRequest,\n formsV4Submission_universal_d_GetMediaUploadURLResponse as GetMediaUploadURLResponse,\n formsV4Submission_universal_d_BulkMarkSubmissionsAsSeenRequest as BulkMarkSubmissionsAsSeenRequest,\n formsV4Submission_universal_d_BulkMarkSubmissionsAsSeenResponse as BulkMarkSubmissionsAsSeenResponse,\n formsV4Submission_universal_d_Task as Task,\n formsV4Submission_universal_d_TaskKey as TaskKey,\n formsV4Submission_universal_d_TaskAction as TaskAction,\n formsV4Submission_universal_d_TaskActionActionOneOf as TaskActionActionOneOf,\n formsV4Submission_universal_d_Complete as Complete,\n formsV4Submission_universal_d_Cancel as Cancel,\n formsV4Submission_universal_d_Reschedule as Reschedule,\n formsV4Submission_universal_d_upsertContactFromSubmission as upsertContactFromSubmission,\n formsV4Submission_universal_d_UpsertContactFromSubmissionOptions as UpsertContactFromSubmissionOptions,\n formsV4Submission_universal_d_createSubmission as createSubmission,\n formsV4Submission_universal_d_CreateSubmissionOptions as CreateSubmissionOptions,\n formsV4Submission_universal_d_createSubmissionBySubmitter as createSubmissionBySubmitter,\n formsV4Submission_universal_d_getSubmission as getSubmission,\n formsV4Submission_universal_d_updateSubmission as updateSubmission,\n formsV4Submission_universal_d_UpdateSubmission as UpdateSubmission,\n formsV4Submission_universal_d_UpdateSubmissionOptions as UpdateSubmissionOptions,\n formsV4Submission_universal_d_confirmSubmission as confirmSubmission,\n formsV4Submission_universal_d_deleteSubmission as deleteSubmission,\n formsV4Submission_universal_d_querySubmission as querySubmission,\n formsV4Submission_universal_d_QuerySubmissionOptions as QuerySubmissionOptions,\n formsV4Submission_universal_d_SubmissionsQueryResult as SubmissionsQueryResult,\n formsV4Submission_universal_d_SubmissionsQueryBuilder as SubmissionsQueryBuilder,\n formsV4Submission_universal_d_countSubmissions as countSubmissions,\n formsV4Submission_universal_d_CountSubmissionsOptions as CountSubmissionsOptions,\n formsV4Submission_universal_d_getMediaUploadUrl as getMediaUploadUrl,\n formsV4Submission_universal_d_GetMediaUploadUrlOptions as GetMediaUploadUrlOptions,\n formsV4Submission_universal_d_bulkMarkSubmissionsAsSeen as bulkMarkSubmissionsAsSeen,\n formsV4Submission_universal_d_BulkMarkSubmissionsAsSeenOptions as BulkMarkSubmissionsAsSeenOptions,\n };\n }\n \n interface Form {\n /**\n * Form ID.\n * @readonly\n */\n _id?: string | null;\n /** List of form fields that represent input elements. */\n fields?: FormField[];\n /**\n * List of form fields that represent input elements.\n * @readonly\n */\n fieldsV2?: FormFieldV2[];\n /** Defines the layout for form fields in each submission step. */\n steps?: Step[];\n /** Form rules, can be applied to layout and items properties. */\n rules?: FormRule[];\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date of creation.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date of last update.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Properties of the form. */\n properties?: FormProperties;\n /**\n * Fields which were soft deleted.\n * @readonly\n */\n deletedFields?: FormField[];\n /**\n * List of form fields that represent input elements.\n * @readonly\n */\n deletedFieldsV2?: FormFieldV2[];\n /**\n * Regular forms can be freely modified.\n * Extensions are copied from templates and might have restrictions.\n * @readonly\n */\n kind?: Kind;\n /**\n * Defines triggers that will be executed after the submission, for the submissions based on this schema.\n * Forms provide a set of predefined triggers that allow it to assign specific business cases to created forms.\n */\n postSubmissionTriggers?: PostSubmissionTriggers;\n /** Data extensions ExtendedFields. */\n extendedFields?: ExtendedFields;\n /** Identifies the namespace that the form belongs to. */\n namespace?: string;\n /**\n * Nested forms.\n * @internal\n * @readonly\n */\n nestedForms?: NestedForm[];\n /**\n * Media folder ID.\n * @readonly\n */\n mediaFolderId?: string | null;\n /** Rules that limit submissions on this form. */\n limitationRule?: LimitationRule;\n /**\n * Spam filter protection level.\n * Default: ADVANCED.\n */\n spamFilterProtectionLevel?: SpamFilterProtectionLevel;\n /** Required indicator properties. */\n requiredIndicatorProperties?: RequiredIndicatorProperties;\n /** Settings for actions to be taken after form submission. */\n submitSettings?: SubmitSettings;\n /** Settings for field groups */\n fieldGroups?: FieldGroup[];\n /** Message shown when the form is disabled */\n disabledFormMessage?: RichContent;\n /** Id of the source form. */\n sourceFormId?: string | null;\n }\n enum RequiredIndicator {\n /** Unknown required indicator. */\n UNKNOWN_INDICATOR = \"UNKNOWN_INDICATOR\",\n /** Asterisk (*). */\n ASTERISK = \"ASTERISK\",\n /** Text (default: \"Required\"). */\n TEXT = \"TEXT\",\n /** None. */\n NONE = \"NONE\"\n }\n enum RequiredIndicatorPlacement {\n /** Unknown required indicator placement. */\n UNKNOWN_PLACEMENT = \"UNKNOWN_PLACEMENT\",\n /** After field title. */\n AFTER_FIELD_TITLE = \"AFTER_FIELD_TITLE\",\n /** Before field title. */\n BEFORE_FIELD_TITLE = \"BEFORE_FIELD_TITLE\"\n }\n interface FormField {\n /** Item ID. */\n _id?: string;\n /** Definition of a target where the value of field belongs. */\n target?: string | null;\n /** Validation of field output value. */\n validation?: Validation;\n /** Mark the field as containing personal information. This will encrypt user data when storing it. */\n pii?: boolean;\n /** Whether the field is hidden. */\n hidden?: boolean;\n /** Field view properties. */\n view?: Record | null;\n /** Details identifying field, which is extension of other entity */\n dataExtensionsDetails?: DataExtensionsDetails;\n /**\n * Nested form ID.\n * @internal\n */\n nestedFormId?: string | null;\n /**\n * Nested form overrides.\n * @internal\n */\n nestedFormOverrides?: NestedFormOverrides;\n /**\n * Whether the field is read only.\n * Default: false\n */\n readOnly?: boolean;\n }\n interface StringType extends StringTypeFormatOptionsOneOf {\n /** DATE format options */\n dateOptions?: DateTimeConstraints;\n /** DATE_TIME format options */\n dateTimeOptions?: DateTimeConstraints;\n /** TIME format options */\n timeOptions?: DateTimeConstraints;\n /** DATE_OPTIONAL_TIME format options */\n dateOptionalTimeOptions?: DateTimeConstraints;\n /** PHONE format options */\n phoneOptions?: PhoneConstraints;\n /** Minimum length. */\n minLength?: number | null;\n /** Maximum length. */\n maxLength?: number | null;\n /** Pattern for a regular expression match. */\n pattern?: string | null;\n /** Format of a string. */\n format?: Format;\n /** Custom error messages when validation fails. */\n errorMessages?: StringErrorMessages;\n /** List of allowed values. */\n enum?: string[] | null;\n }\n /** @oneof */\n interface StringTypeFormatOptionsOneOf {\n /** DATE format options */\n dateOptions?: DateTimeConstraints;\n /** DATE_TIME format options */\n dateTimeOptions?: DateTimeConstraints;\n /** TIME format options */\n timeOptions?: DateTimeConstraints;\n /** DATE_OPTIONAL_TIME format options */\n dateOptionalTimeOptions?: DateTimeConstraints;\n /** PHONE format options */\n phoneOptions?: PhoneConstraints;\n }\n enum Format {\n UNDEFINED = \"UNDEFINED\",\n DATE = \"DATE\",\n TIME = \"TIME\",\n DATE_TIME = \"DATE_TIME\",\n EMAIL = \"EMAIL\",\n URL = \"URL\",\n UUID = \"UUID\",\n PHONE = \"PHONE\",\n URI = \"URI\",\n HOSTNAME = \"HOSTNAME\",\n COLOR_HEX = \"COLOR_HEX\",\n CURRENCY = \"CURRENCY\",\n LANGUAGE = \"LANGUAGE\",\n DATE_OPTIONAL_TIME = \"DATE_OPTIONAL_TIME\"\n }\n interface StringErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface DateTimeConstraints {\n /**\n * Support static constrains defined as ISO date/time format, as well as\n * dynamic calculations can be performed using special keywords such as \"$now\" to represent the current date and time.\n * The dynamic calculation supports expressions like \"$now+2d\" (2 days in the future), \"$now-1h\" (1 hour in the past), etc.\n * The regex pattern for dynamic calculations is: \\$now([+-]\\d{1,2})([yMdmh])\n */\n minimum?: string | null;\n /**\n * Support static constrains defined as ISO date/time format, as well as\n * dynamic calculations can be performed using special keywords such as \"$now\" to represent the current date and time.\n * The dynamic calculation supports expressions like \"$now+2d\" (2 days in the future), \"$now-1h\" (1 hour in the past), etc.\n * The regex pattern for dynamic calculations is: \\$now([+-]\\d{1,2})([yMdmh])\n */\n maximum?: string | null;\n }\n interface PhoneConstraints {\n /** Country codes for phone number that are allowed */\n allowedCountryCodes?: string[];\n }\n interface NumberType {\n /** Inclusive maximum value. */\n maximum?: number | null;\n /** Inclusive minimum value. */\n minimum?: number | null;\n /** Multiple of value. */\n multipleOf?: number | null;\n /** Custom error message when validation fails. */\n errorMessages?: NumberErrorMessages;\n /** List of allowed values. */\n enum?: number[] | null;\n }\n interface NumberErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface IntegerType {\n /** Minimum value. */\n maximum?: number | null;\n /** Maximum value. */\n minimum?: number | null;\n /** Multiple of value. */\n multipleOf?: number | null;\n /** Custom error message when validation fails. */\n errorMessages?: NumberErrorMessages;\n /** List of allowed values. */\n enum?: number[] | null;\n }\n interface BooleanType {\n /** Custom error message when validation fails. */\n errorMessages?: BooleanErrorMessages;\n /** List of allowed values. */\n enum?: boolean[];\n }\n interface BooleanErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface ArrayType {\n /** Maximum amount of array elements. */\n maxItems?: number | null;\n /** Minimum amount of array elements. */\n minItems?: number | null;\n /** Type of items allowed in array. */\n items?: ArrayItems;\n /** Custom error message when validation fails. */\n errorMessages?: ArrayErrorMessages;\n }\n interface ObjectType {\n /** Description of object properties. */\n properties?: Record;\n /** Custom error message when validation fails. */\n errorMessages?: ObjectErrorMessages;\n }\n interface PropertiesType extends PropertiesTypePropertiesTypeOneOf {\n /** String type validation for property. */\n string?: StringType;\n /** Number type validation for property. */\n number?: NumberType;\n /** Boolean type validation for property. */\n boolean?: BooleanType;\n /** Integer type validation for property. */\n integer?: IntegerType;\n /** Array type validation for property. */\n array?: ArrayType;\n /** Whether the property is required. */\n required?: boolean;\n }\n /** @oneof */\n interface PropertiesTypePropertiesTypeOneOf {\n /** String type validation for property. */\n string?: StringType;\n /** Number type validation for property. */\n number?: NumberType;\n /** Boolean type validation for property. */\n boolean?: BooleanType;\n /** Integer type validation for property. */\n integer?: IntegerType;\n /** Array type validation for property. */\n array?: ArrayType;\n }\n interface ObjectErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface ArrayItems extends ArrayItemsItemsOneOf {\n /** String type validation for items. */\n string?: StringType;\n /** Number type validation for items. */\n number?: NumberType;\n /** Boolean type validation for items. */\n boolean?: BooleanType;\n /** Integer type validation for items. */\n integer?: IntegerType;\n /** Object type validation for items */\n object?: ObjectType;\n }\n /** @oneof */\n interface ArrayItemsItemsOneOf {\n /** String type validation for items. */\n string?: StringType;\n /** Number type validation for items. */\n number?: NumberType;\n /** Boolean type validation for items. */\n boolean?: BooleanType;\n /** Integer type validation for items. */\n integer?: IntegerType;\n /** Object type validation for items */\n object?: ObjectType;\n }\n interface ArrayErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface PredefinedValidation extends PredefinedValidationFormatOptionsOneOf {\n /** Payment input field. */\n paymentOptions?: PaymentType;\n /** Multiline address validation. */\n multilineAddressOptions?: MultilineAddressValidation;\n /** Format of predefined validation. */\n format?: ValidationFormat;\n }\n /** @oneof */\n interface PredefinedValidationFormatOptionsOneOf {\n /** Payment input field. */\n paymentOptions?: PaymentType;\n /** Multiline address validation. */\n multilineAddressOptions?: MultilineAddressValidation;\n }\n enum ValidationFormat {\n UNDEFINED = \"UNDEFINED\",\n /** File upload validation. */\n WIX_FILE = \"WIX_FILE\",\n /** Payment validation. */\n PAYMENT = \"PAYMENT\",\n /** Multiline address. */\n MULTILINE_ADDRESS = \"MULTILINE_ADDRESS\"\n }\n interface PaymentType {\n /** Field mapped to products. */\n products?: Product[];\n /** Minimum amount of different products. */\n minItems?: number | null;\n /** Maximum amount of different products. */\n maxItems?: number | null;\n }\n enum ProductType {\n /** Unknown product type. */\n UNKNOWN = \"UNKNOWN\",\n /** Shippable (physical) product. */\n SHIPPABLE = \"SHIPPABLE\",\n /** Digital product. */\n DIGITAL = \"DIGITAL\"\n }\n enum PriceType {\n /** Unknown price type. */\n UNKNOWN = \"UNKNOWN\",\n /** Fixed price. */\n FIXED_PRICE = \"FIXED_PRICE\",\n /** Dynamic price from price range. */\n DYNAMIC_PRICE = \"DYNAMIC_PRICE\"\n }\n interface QuantityLimit {\n /** Minimum quantity. */\n minimum?: number | null;\n /** Maximum quantity. */\n maximum?: number | null;\n }\n interface FixedPriceOptions {\n /** Fixed price monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */\n price?: string;\n }\n interface DynamicPriceOptions {\n /** Minimal price monetary amount. */\n minPrice?: string;\n /** Maximal price monetary amount. */\n maxPrice?: string | null;\n }\n interface Product extends ProductPriceOptionsOneOf {\n /** Fixed price options. */\n fixedPriceOptions?: FixedPriceOptions;\n /** Dynamic price options. */\n dynamicPriceOptions?: DynamicPriceOptions;\n /**\n * Product ID.\n * @readonly\n */\n _id?: string;\n /** Product type. */\n productType?: ProductType;\n /** Price type. */\n priceType?: PriceType;\n /** Quantity limit. */\n quantityLimit?: QuantityLimit;\n }\n /** @oneof */\n interface ProductPriceOptionsOneOf {\n /** Fixed price options. */\n fixedPriceOptions?: FixedPriceOptions;\n /** Dynamic price options. */\n dynamicPriceOptions?: DynamicPriceOptions;\n }\n interface MultilineAddressValidation {\n /** Allowed countries. No countries treated as all. */\n allowedCountries?: string[];\n /** Fields overrides. */\n fields?: FieldsOverrides;\n }\n interface FieldOverrides {\n /** Whether the field is required. */\n required?: boolean;\n }\n interface FieldsOverrides {\n /** Subdivision. */\n subdivision?: FieldOverrides;\n /** City. */\n city?: FieldOverrides;\n /** Postal code. */\n postalCode?: FieldOverrides;\n /** Street name. */\n streetName?: FieldOverrides;\n /** Street number. */\n streetNumber?: FieldOverrides;\n /** Address line. */\n addressLine?: FieldOverrides;\n /** Address line 2. */\n addressLine2?: FieldOverrides;\n /** Country. */\n country?: FieldOverrides;\n }\n interface NestedFormFieldOverrides {\n /** Whether the field is required. Leave blank for no override. */\n required?: boolean | null;\n /** Whether the field is hidden. Leave blank for no override. */\n hidden?: boolean | null;\n }\n interface Validation extends ValidationValidationOneOf {\n /** Validation of string type. */\n string?: StringType;\n /** Validation of number type. */\n number?: NumberType;\n /** Validation of integer type. */\n integer?: IntegerType;\n /** Validation of boolean type. */\n boolean?: BooleanType;\n /** Validation of array type. */\n array?: ArrayType;\n /** Validation of object type. */\n object?: ObjectType;\n /** Predefined validation of specific format */\n predefined?: PredefinedValidation;\n /** Whether the field is required. */\n required?: boolean;\n }\n /** @oneof */\n interface ValidationValidationOneOf {\n /** Validation of string type. */\n string?: StringType;\n /** Validation of number type. */\n number?: NumberType;\n /** Validation of integer type. */\n integer?: IntegerType;\n /** Validation of boolean type. */\n boolean?: BooleanType;\n /** Validation of array type. */\n array?: ArrayType;\n /** Validation of object type. */\n object?: ObjectType;\n /** Predefined validation of specific format */\n predefined?: PredefinedValidation;\n }\n interface DataExtensionsDetails {\n /** FQDNS which can be extended with this field */\n fqdns?: string[];\n }\n interface NestedFormOverrides {\n /** Field overrides by field ID */\n fieldOverrides?: Record;\n }\n interface FormFieldV2 extends FormFieldV2FieldTypeOptionsOneOf {\n /** Field accept input of data */\n inputOptions?: InputField;\n /** Field for displaying information such as header or text paragraph */\n displayOptions?: DisplayField;\n /** Submit button of the form */\n submitOptions?: SubmitButton;\n /** Field id. */\n _id?: string;\n /**\n * Whether the field is hidden.\n * Default: false\n */\n hidden?: boolean;\n /** Custom identification of field, can be used to specify exceptional behaviour of client for specific field */\n identifier?: string | null;\n /**\n * Type of the field\n * @readonly\n */\n fieldType?: FieldType;\n }\n /** @oneof */\n interface FormFieldV2FieldTypeOptionsOneOf {\n /** Field accept input of data */\n inputOptions?: InputField;\n /** Field for displaying information such as header or text paragraph */\n displayOptions?: DisplayField;\n /** Submit button of the form */\n submitOptions?: SubmitButton;\n }\n interface InputFieldStringType extends InputFieldStringTypeFormatOptionsOneOf {\n /** DATE format options */\n dateOptions?: StringTypeDateTimeConstraints;\n /** DATE_TIME format options */\n dateTimeOptions?: StringTypeDateTimeConstraints;\n /** TIME format options */\n timeOptions?: StringTypeDateTimeConstraints;\n /** DATE_OPTIONAL_TIME format options */\n dateOptionalTimeOptions?: StringTypeDateTimeConstraints;\n /** PHONE format options */\n phoneOptions?: StringTypePhoneConstraints;\n /** Minimum length. */\n minLength?: number | null;\n /** Maximum length. */\n maxLength?: number | null;\n /** Pattern for a regular expression match. */\n pattern?: string | null;\n /** Format of a string. */\n format?: FormatEnumFormat;\n /** Custom error messages when validation fails. */\n errorMessages?: InputFieldStringErrorMessages;\n /** List of allowed values. */\n enum?: string[] | null;\n }\n /** @oneof */\n interface InputFieldStringTypeFormatOptionsOneOf {\n /** DATE format options */\n dateOptions?: StringTypeDateTimeConstraints;\n /** DATE_TIME format options */\n dateTimeOptions?: StringTypeDateTimeConstraints;\n /** TIME format options */\n timeOptions?: StringTypeDateTimeConstraints;\n /** DATE_OPTIONAL_TIME format options */\n dateOptionalTimeOptions?: StringTypeDateTimeConstraints;\n /** PHONE format options */\n phoneOptions?: StringTypePhoneConstraints;\n }\n enum FormatEnumFormat {\n UNDEFINED = \"UNDEFINED\",\n DATE = \"DATE\",\n TIME = \"TIME\",\n DATE_TIME = \"DATE_TIME\",\n EMAIL = \"EMAIL\",\n URL = \"URL\",\n UUID = \"UUID\",\n PHONE = \"PHONE\",\n URI = \"URI\",\n HOSTNAME = \"HOSTNAME\",\n COLOR_HEX = \"COLOR_HEX\",\n CURRENCY = \"CURRENCY\",\n LANGUAGE = \"LANGUAGE\",\n DATE_OPTIONAL_TIME = \"DATE_OPTIONAL_TIME\"\n }\n interface InputFieldStringErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface StringTypeDateTimeConstraints {\n /**\n * Support static constrains defined as ISO date/time format, as well as\n * dynamic calculations can be performed using special keywords such as \"$now\" to represent the current date and time.\n * The dynamic calculation supports expressions like \"$now+2d\" (2 days in the future), \"$now-1h\" (1 hour in the past), etc.\n * The regex pattern for dynamic calculations is: \\$now([+-]\\d{1,2})([yMdmh])\n */\n minimum?: string | null;\n /**\n * Support static constrains defined as ISO date/time format, as well as\n * dynamic calculations can be performed using special keywords such as \"$now\" to represent the current date and time.\n * The dynamic calculation supports expressions like \"$now+2d\" (2 days in the future), \"$now-1h\" (1 hour in the past), etc.\n * The regex pattern for dynamic calculations is: \\$now([+-]\\d{1,2})([yMdmh])\n */\n maximum?: string | null;\n }\n interface StringTypePhoneConstraints {\n /** Country codes for phone number that are allowed */\n allowedCountryCodes?: string[];\n }\n enum StringComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n TEXT_INPUT = \"TEXT_INPUT\",\n RADIO_GROUP = \"RADIO_GROUP\",\n DROPDOWN = \"DROPDOWN\",\n DATE_TIME = \"DATE_TIME\",\n PHONE_INPUT = \"PHONE_INPUT\",\n DATE_INPUT = \"DATE_INPUT\",\n TIME_INPUT = \"TIME_INPUT\",\n DATE_PICKER = \"DATE_PICKER\"\n }\n interface TextInput {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /** Placeholder for the value input */\n placeholder?: string | null;\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\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 custom 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 /** Data for a caption node. */\n captionData?: CaptionData;\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 custom 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 /** Data for a caption node. */\n captionData?: CaptionData;\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 CAPTION = \"CAPTION\"\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. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */\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`: A small width.\n * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.\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`: A small width.\n * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.\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. Defaults to `false`. */\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?: LinkTarget;\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 LinkTarget {\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. Defaults to `false`. */\n nofollow?: boolean | null;\n /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */\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. Defaults to `false`. */\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 expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */\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 /**\n * Use `sizeInKb` instead.\n * @deprecated\n */\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 /** File size in KB. */\n sizeInKb?: 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 /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n private?: boolean | null;\n }\n /** @oneof */\n interface FileSourceDataOneOf {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n disableDownload?: boolean | null;\n /** Sets whether the PDF print button is disabled. Defaults to `false`. */\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. Defaults to `false`. */\n disableExpand?: boolean | null;\n /** Sets whether the gallery's download button is disabled. Defaults to `false`. */\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. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */\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-4. */\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 /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\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 /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n disableExpand?: boolean | null;\n /** Image's alternative text. */\n altText?: string | null;\n /**\n * Deprecated: use Caption node instead.\n * @deprecated\n */\n caption?: string | null;\n /** Sets whether the image's download button is disabled. Defaults to `false`. */\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-4. */\n indentation?: number | null;\n /** Paragraph level */\n level?: 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. Defaults to `false`. */\n allowMultipleVotes?: boolean | null;\n }\n interface PollOption {\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. Defaults to `true`. */\n showVoters?: boolean | null;\n /** Sets whether the vote count is displayed. Defaults to `true`. */\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. Defaults to `false`. */\n enableImage?: boolean | null;\n }\n interface OptionLayout {\n /** Sets whether to display option images. Defaults to `false`. */\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?: PollOption[];\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. Defaults to `true`. */\n italicData?: boolean | null;\n /** Data for an underline decoration. Defaults to `true`. */\n underlineData?: boolean | null;\n /** Data for a spoiler decoration. */\n spoilerData?: SpoilerData;\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. Defaults to `true`. */\n italicData?: boolean | null;\n /** Data for an underline decoration. Defaults to `true`. */\n underlineData?: boolean | null;\n /** Data for a spoiler decoration. */\n spoilerData?: SpoilerData;\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 SpoilerData {\n /** Spoiler ID. */\n _id?: string | null;\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 /**\n * Deprecated: Use `image` instead.\n * @deprecated\n */\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. Defaults to `false`. */\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. Defaults to `false`. */\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 /**\n * Deprecated: Use `rowHeader` and `columnHeader` instead.\n * @deprecated\n */\n header?: boolean | null;\n /** Sets whether the table's first row is a header. Defaults to `false`. */\n rowHeader?: boolean | null;\n /** Sets whether the table's first column is a header. Defaults to `false`. */\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. Defaults to `false`. */\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 from 0-4. */\n indentation?: number;\n /** Offset level from 0-4. */\n offset?: number | null;\n /** List start number. */\n start?: number | null;\n }\n interface BulletedListData {\n /** Indentation level from 0-4. */\n indentation?: number;\n /** Offset level from 0-4. */\n offset?: number | null;\n }\n interface BlockquoteData {\n /** Indentation level from 1-4. */\n indentation?: number;\n }\n interface CaptionData {\n textStyle?: TextStyle;\n }\n interface Metadata {\n /** Schema version. */\n version?: number;\n /**\n * When the object was created.\n * @readonly\n * @deprecated\n */\n createdTimestamp?: Date | null;\n /**\n * When the object was most recently updated.\n * @deprecated\n */\n updatedTimestamp?: Date | null;\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 RadioGroup {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /**\n * Flag identifying to show option allowing input custom value\n * List of options to select from\n */\n options?: RadioGroupOption[];\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /** Option which can be specified by UoU, enabled when this object is specified. */\n customOption?: RadioGroupCustomOption;\n /**\n * Specifies the number of columns used to display the selections within the component.\n * Default: ONE\n */\n numberOfColumns?: NumberOfColumns;\n }\n interface RadioGroupOption {\n /** Selectable option label */\n label?: string | null;\n /** Selectable option value, which is saved to DB. */\n value?: string | null;\n /** Flag identifying that option should be selected by default */\n default?: boolean;\n /** Option id. Used as binding for translations */\n _id?: string;\n }\n interface RadioGroupCustomOption {\n /** Label of custom option input */\n label?: string | null;\n /** Placeholder of custom option input */\n placeholder?: string | null;\n }\n enum NumberOfColumns {\n /** Undefined number of columns. */\n UNKNOWN = \"UNKNOWN\",\n /** Zero columns. */\n ZERO = \"ZERO\",\n /** One column. */\n ONE = \"ONE\",\n /** Two columns. */\n TWO = \"TWO\",\n /** Three columns. */\n THREE = \"THREE\"\n }\n interface Dropdown {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /** List of options to select from */\n options?: DropdownOption[];\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /** Option which can be specified by UoU, enabled when this object is specified. */\n customOption?: DropdownCustomOption;\n /** Placeholder of dropdown input */\n placeholder?: string | null;\n }\n interface DropdownOption {\n /** Selectable option label */\n label?: string | null;\n /** Selectable option value, which is saved to DB. */\n value?: string | null;\n /** Flag identifying that option should be selected by default */\n default?: boolean;\n /** Option id. Used as binding for translations */\n _id?: string;\n }\n interface DropdownCustomOption {\n /** Label of custom option input */\n label?: string | null;\n /** Placeholder of custom option input */\n placeholder?: string | null;\n }\n interface DateTimeInput {\n /** Label of the field. Displayed text for the date/time input. */\n label?: string | null;\n /** Description of the field. Additional information about the date/time input. */\n description?: RichContent;\n /**\n * Flag identifying whether to show or hide the label.\n * Default: true\n */\n showLabel?: boolean | null;\n /**\n * Flag identifying whether to show or hide the placeholder.\n * Default: true\n */\n showPlaceholder?: boolean | null;\n /**\n * Flag indicating whether to use the 24-hour time format.\n * Default: false.\n */\n use24HourFormat?: boolean;\n }\n interface PhoneInput {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /** Placeholder for the value input */\n placeholder?: string | null;\n /**\n * Flag identifying to show label or not\n * Default: true\n */\n showLabel?: boolean | null;\n /** Default value of the country code */\n defaultCountryCode?: string | null;\n /**\n * Flag identifying to show country flag or not\n * Default: false\n */\n showCountryFlag?: boolean;\n }\n interface DateInput {\n /** Label of the field. Displayed text for the date/time input. */\n label?: string | null;\n /** Description of the field. Additional information about the date/time input. */\n description?: RichContent;\n /**\n * Flag identifying whether to show or hide the label.\n * Default: true\n */\n showLabel?: boolean | null;\n /**\n * Flag identifying whether to show or hide the placeholder.\n * Default: true\n */\n showPlaceholder?: boolean | null;\n }\n interface TimeInput {\n /** Label of the field. Displayed text for the date/time input. */\n label?: string | null;\n /** Description of the field. Additional information about the date/time input. */\n description?: RichContent;\n /**\n * Flag identifying whether to show or hide the label.\n * Default: true\n */\n showLabel?: boolean | null;\n /**\n * Flag identifying whether to show or hide the placeholder.\n * Default: true\n */\n showPlaceholder?: boolean | null;\n /**\n * Flag indicating whether to use the 24-hour time format.\n * Default: false.\n */\n use24HourFormat?: boolean;\n }\n interface DatePicker {\n /** Label of the field. Displayed text for the date/time input. */\n label?: string | null;\n /** Description of the field. Additional information about the date/time input. */\n description?: RichContent;\n /**\n * Flag identifying whether to show or hide the label.\n * Default: true\n */\n showLabel?: boolean | null;\n /** Placeholder of date picker input */\n placeholder?: string | null;\n /** First day of the week displayed on date picker. */\n firstDayOfWeek?: FirstDayOfWeekEnumFirstDayOfWeek;\n }\n enum FirstDayOfWeekEnumFirstDayOfWeek {\n /** First day of the week is Monday. */\n MONDAY = \"MONDAY\",\n /** First day of the week is Sunday. */\n SUNDAY = \"SUNDAY\"\n }\n interface InputFieldNumberType {\n /** Inclusive maximum value. */\n maximum?: number | null;\n /** Inclusive minimum value. */\n minimum?: number | null;\n /** Multiple of value. */\n multipleOf?: number | null;\n /** Custom error message when validation fails. */\n errorMessages?: InputFieldNumberErrorMessages;\n /** List of allowed values. */\n enum?: number[] | null;\n }\n interface InputFieldNumberErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n enum NumberComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n NUMBER_INPUT = \"NUMBER_INPUT\",\n RATING_INPUT = \"RATING_INPUT\"\n }\n interface NumberInput {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /** Placeholder for the value input */\n placeholder?: string | null;\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n }\n interface RatingInput {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /**\n * Flag identifying to hide label or not\n * Default: true\n */\n showLabel?: boolean | null;\n /** Default rating */\n defaultValue?: number | null;\n }\n interface InputFieldBooleanType {\n /** Custom error message when validation fails. */\n errorMessages?: InputFieldBooleanErrorMessages;\n /** List of allowed values. */\n enum?: boolean[];\n }\n interface InputFieldBooleanErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n enum BooleanComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n CHECKBOX = \"CHECKBOX\"\n }\n interface Checkbox {\n /** Label of the field */\n label?: RichContent;\n /**\n * Flag identifying if checked by default\n * Default: false\n */\n checked?: boolean;\n }\n interface InputFieldArrayType {\n /** Maximum amount of array elements. */\n maxItems?: number | null;\n /** Minimum amount of array elements. */\n minItems?: number | null;\n /** Type of items allowed in array. */\n items?: ArrayTypeArrayItems;\n /** Custom error message when validation fails. */\n errorMessages?: InputFieldArrayErrorMessages;\n }\n enum ItemType {\n UNKNOWN_ITEM_TYPE = \"UNKNOWN_ITEM_TYPE\",\n STRING = \"STRING\",\n NUMBER = \"NUMBER\",\n BOOLEAN = \"BOOLEAN\",\n INTEGER = \"INTEGER\",\n OBJECT = \"OBJECT\"\n }\n interface InputFieldIntegerType {\n /** Maximum value. */\n maximum?: number | null;\n /** Minimum value. */\n minimum?: number | null;\n /** Multiple of value. */\n multipleOf?: number | null;\n /** Custom error message when validation fails. */\n errorMessages?: InputFieldNumberErrorMessages;\n /** List of allowed values. */\n enum?: number[] | null;\n }\n interface InputFieldObjectType {\n /** Description of object properties. */\n properties?: Record;\n /** Custom error message when validation fails. */\n errorMessages?: InputFieldObjectErrorMessages;\n }\n enum PropertiesTypeEnum {\n UNKNOWN = \"UNKNOWN\",\n STRING = \"STRING\",\n NUMBER = \"NUMBER\",\n BOOLEAN = \"BOOLEAN\",\n INTEGER = \"INTEGER\",\n ARRAY = \"ARRAY\"\n }\n interface ObjectTypePropertiesType extends ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {\n /** String type validation for property. */\n stringOptions?: InputFieldStringType;\n /** Number type validation for property. */\n numberOptions?: InputFieldNumberType;\n /** Boolean type validation for property. */\n booleanOptions?: InputFieldBooleanType;\n /** Integer type validation for property. */\n integerOptions?: InputFieldIntegerType;\n /** Array type validation for property. */\n arrayOptions?: InputFieldArrayType;\n /**\n * Type of object properties\n * @readonly\n */\n propertiesType?: PropertiesTypeEnum;\n /** Whether the property is required. */\n required?: boolean;\n }\n /** @oneof */\n interface ObjectTypePropertiesTypePropertiesTypeOptionsOneOf {\n /** String type validation for property. */\n stringOptions?: InputFieldStringType;\n /** Number type validation for property. */\n numberOptions?: InputFieldNumberType;\n /** Boolean type validation for property. */\n booleanOptions?: InputFieldBooleanType;\n /** Integer type validation for property. */\n integerOptions?: InputFieldIntegerType;\n /** Array type validation for property. */\n arrayOptions?: InputFieldArrayType;\n }\n interface InputFieldObjectErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n interface ArrayTypeArrayItems extends ArrayTypeArrayItemsItemTypeOptionsOneOf {\n /** String type validation for items. */\n stringOptions?: InputFieldStringType;\n /** Number type validation for items. */\n numberOptions?: InputFieldNumberType;\n /** Boolean type validation for items. */\n booleanOptions?: InputFieldBooleanType;\n /** Integer type validation for items. */\n integerOptions?: InputFieldIntegerType;\n /** Object type validation for items */\n objectOptions?: InputFieldObjectType;\n /**\n * Type of array items\n * @readonly\n */\n itemType?: ItemType;\n }\n /** @oneof */\n interface ArrayTypeArrayItemsItemTypeOptionsOneOf {\n /** String type validation for items. */\n stringOptions?: InputFieldStringType;\n /** Number type validation for items. */\n numberOptions?: InputFieldNumberType;\n /** Boolean type validation for items. */\n booleanOptions?: InputFieldBooleanType;\n /** Integer type validation for items. */\n integerOptions?: InputFieldIntegerType;\n /** Object type validation for items */\n objectOptions?: InputFieldObjectType;\n }\n interface InputFieldArrayErrorMessages {\n /** Default error message on invalid validation. */\n default?: string | null;\n }\n enum ComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n CHECKBOX_GROUP = \"CHECKBOX_GROUP\",\n TAGS = \"TAGS\"\n }\n interface CheckboxGroup {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /** List of options to select from */\n options?: Option[];\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /** Option which can be specified by UoU, enabled when this object is specified. */\n customOption?: CustomOption;\n /**\n * Specifies the number of columns used to display the selections within the component.\n * Default: ONE\n */\n numberOfColumns?: NumberOfColumns;\n }\n interface MediaItem extends MediaItemMediaOneOf {\n /** WixMedia image. */\n image?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /** WixMedia image. */\n image?: string;\n }\n interface Option {\n /** Selectable option label */\n label?: string | null;\n /** Selectable option value, which is saved to DB. */\n value?: any;\n /** Flag identifying that option should be selected by default */\n default?: boolean;\n /** Option id. Used as binding for translations */\n _id?: string;\n /** Media item. Media, associated with option, like image. */\n media?: MediaItem;\n }\n interface CustomOption {\n /** Label of custom option input */\n label?: string | null;\n /** Placeholder of custom option input */\n placeholder?: string | null;\n }\n interface Tags {\n /** Label of the field */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /** List of options to select from */\n options?: TagsOption[];\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /** Option which can be specified by UoU, enabled when this object is specified. */\n customOption?: CommonCustomOption;\n /**\n * Specifies the number of columns used to display the selections within the component.\n * Default: ONE\n */\n numberOfColumns?: NumberOfColumns;\n }\n interface TagsOption {\n /** Selectable option label */\n label?: string | null;\n /** Selectable option value, which is saved to DB. */\n value?: any;\n /** Flag identifying that option should be selected by default */\n default?: boolean;\n /** Option id. Used as binding for translations */\n _id?: string;\n /** Media item. Media, associated with option, like image. */\n media?: MediaItem;\n }\n interface CommonCustomOption {\n /** Label of custom option input */\n label?: string | null;\n /** Placeholder of custom option input */\n placeholder?: string | null;\n }\n enum WixFileComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n FILE_UPLOAD = \"FILE_UPLOAD\",\n SIGNATURE = \"SIGNATURE\"\n }\n interface FileUpload {\n /** Selectable option label */\n label?: string | null;\n /** Description of the field */\n description?: RichContent;\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /** Text on upload button */\n buttonText?: string | null;\n /** Amount of files allowed to upload */\n fileLimit?: number;\n /** Supported file formats for upload */\n uploadFileFormats?: UploadFileFormat[];\n /** Custom text which appears when file is uploaded, if missing file name will be shown */\n explanationText?: string | null;\n }\n enum UploadFileFormat {\n /** Undefined upload file format. */\n UNDEFINED = \"UNDEFINED\",\n /** Video files. */\n VIDEO = \"VIDEO\",\n /** Image files. */\n IMAGE = \"IMAGE\",\n /** Audio files. */\n AUDIO = \"AUDIO\",\n /** Document files. */\n DOCUMENT = \"DOCUMENT\",\n /** Archive files. */\n ARCHIVE = \"ARCHIVE\"\n }\n interface Signature {\n /** Selectable option label */\n label?: string | null;\n /**\n * Flag identifying to hide label or not\n * Default: true\n */\n showLabel?: boolean | null;\n /** Description of the field */\n description?: RichContent;\n /** Is image upload enabled */\n imageUploadEnabled?: boolean;\n }\n enum PaymentComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n CHECKBOX_GROUP = \"CHECKBOX_GROUP\",\n DONATION_INPUT = \"DONATION_INPUT\",\n PAYMENT_INPUT = \"PAYMENT_INPUT\",\n FIXED_PAYMENT = \"FIXED_PAYMENT\"\n }\n interface ProductCheckboxGroup {\n /** Label of the field. */\n label?: string | null;\n /** Description of the field. */\n description?: RichContent;\n /** List of options to select from. */\n options?: ProductCheckboxGroupOption[];\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /**\n * Defines how an image should be resized to fit within its option.\n * Default: COVER\n */\n imageFit?: ImageFit;\n }\n interface ProductCheckboxGroupOption {\n /** Selectable option label. */\n label?: string | null;\n /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */\n value?: any;\n /** Option id. Used as binding for translations. */\n _id?: string;\n /** Media item. Media, associated with option, like image. */\n media?: MediaItem;\n }\n enum ImageFit {\n UNKNOWN_IMAGE_FIT = \"UNKNOWN_IMAGE_FIT\",\n /** Image is scaled to maintain its aspect ratio while filling the element's entire content box. Portions of the image may be clipped if the aspect ratios do not match. */\n COVER = \"COVER\",\n /** Image is resized to fill the element's content box. Aspect ratio may not be preserved. */\n CONTAIN = \"CONTAIN\"\n }\n interface DonationInput {\n /** Label of the field. */\n label?: string | null;\n /** Description of the field. */\n description?: RichContent;\n /** List of options to select from. */\n options?: DonationInputOption[];\n /** Option which can be specified by UoU, enabled when this object is specified. */\n customOption?: CommonCustomOption;\n /**\n * Specifies the number of columns used to display the selections within the component.\n * Default: ONE\n */\n numberOfColumns?: NumberOfColumns;\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n }\n interface DonationInputOption {\n /** Selectable option value, which is saved to DB. Corresponds to product id, found in field's products list. */\n value?: string;\n /** Flag identifying that option should be selected by default */\n default?: boolean;\n }\n interface PaymentInput {\n /** Label of the field. */\n label?: string | null;\n /** Description of the field. */\n description?: RichContent;\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n /** Placeholder of custom option input */\n placeholder?: string | null;\n }\n interface FixedPayment {\n /** Label of the field. */\n label?: string | null;\n /** Description of the field. */\n description?: RichContent;\n /**\n * Flag identifying to hide or not label\n * Default: true\n */\n showLabel?: boolean | null;\n }\n enum MultilineAddressComponentType {\n UNKNOWN_COMPONENT_TYPE = \"UNKNOWN_COMPONENT_TYPE\",\n MULTILINE_ADDRESS = \"MULTILINE_ADDRESS\"\n }\n interface MultilineAddress {\n /** Label of the field. */\n label?: string | null;\n /** Description of the field. */\n description?: RichContent;\n /** Show country flags. */\n showCountryFlags?: boolean;\n /** Default country configuration. */\n defaultCountryConfig?: DefaultCountryConfig;\n /** Fields settings. */\n fieldSettings?: FieldsSettings;\n /** Autocomplete enabled for address line field. */\n autocompleteEnabled?: boolean;\n }\n enum DefaultCountryConfigType {\n /** Unknown default country config type. */\n UNKNOWN_DEFAULT_COUNTRY = \"UNKNOWN_DEFAULT_COUNTRY\",\n /** Country is determined by customer's IP address. */\n BY_IP = \"BY_IP\",\n /** Pre-selected default country. */\n COUNTRY = \"COUNTRY\"\n }\n interface AddressLine2 {\n /** Show address line 2 field. */\n show?: boolean;\n }\n interface DefaultCountryConfig extends DefaultCountryConfigOptionsOneOf {\n /** Country. */\n countryOptions?: string;\n /** Default country type. */\n type?: DefaultCountryConfigType;\n }\n /** @oneof */\n interface DefaultCountryConfigOptionsOneOf {\n /** Country. */\n countryOptions?: string;\n }\n interface FieldsSettings {\n /** Address line 2. */\n addressLine2?: AddressLine2;\n }\n enum InputType {\n UNKNOWN_INPUT_TYPE = \"UNKNOWN_INPUT_TYPE\",\n STRING = \"STRING\",\n NUMBER = \"NUMBER\",\n BOOLEAN = \"BOOLEAN\",\n ARRAY = \"ARRAY\",\n OBJECT = \"OBJECT\",\n WIX_FILE = \"WIX_FILE\",\n PAYMENT = \"PAYMENT\",\n MULTILINE_ADDRESS = \"MULTILINE_ADDRESS\"\n }\n interface FormFieldContactInfo extends FormFieldContactInfoAdditionalInfoOneOf {\n /** Email info. */\n emailInfo?: EmailInfo;\n /** Phone info. */\n phoneInfo?: PhoneInfo;\n /** Address info. */\n addressInfo?: AddressInfo;\n /** Custom field info. */\n customFieldInfo?: CustomFieldInfo;\n /** Subscription info */\n subscriptionInfo?: SubscriptionInfo;\n /** Field mapped to contacts. */\n contactField?: ContactField;\n }\n /** @oneof */\n interface FormFieldContactInfoAdditionalInfoOneOf {\n /** Email info. */\n emailInfo?: EmailInfo;\n /** Phone info. */\n phoneInfo?: PhoneInfo;\n /** Address info. */\n addressInfo?: AddressInfo;\n /** Custom field info. */\n customFieldInfo?: CustomFieldInfo;\n /** Subscription info */\n subscriptionInfo?: SubscriptionInfo;\n }\n enum EmailInfoTag {\n UNTAGGED = \"UNTAGGED\",\n MAIN = \"MAIN\"\n }\n enum PhoneInfoTag {\n UNTAGGED = \"UNTAGGED\",\n MAIN = \"MAIN\"\n }\n enum Tag {\n UNTAGGED = \"UNTAGGED\",\n HOME = \"HOME\"\n }\n enum OptInLevel {\n UNKNOWN = \"UNKNOWN\",\n SINGLE_CONFIRMATION = \"SINGLE_CONFIRMATION\",\n DOUBLE_CONFIRMATION = \"DOUBLE_CONFIRMATION\"\n }\n enum ContactField {\n UNDEFINED = \"UNDEFINED\",\n FIRST_NAME = \"FIRST_NAME\",\n LAST_NAME = \"LAST_NAME\",\n COMPANY = \"COMPANY\",\n POSITION = \"POSITION\",\n EMAIL = \"EMAIL\",\n PHONE = \"PHONE\",\n ADDRESS = \"ADDRESS\",\n BIRTHDATE = \"BIRTHDATE\",\n CUSTOM_FIELD = \"CUSTOM_FIELD\",\n SUBSCRIPTION = \"SUBSCRIPTION\",\n VAT_ID = \"VAT_ID\"\n }\n interface EmailInfo {\n /** Email tag. */\n tag?: EmailInfoTag;\n }\n interface PhoneInfo {\n /** Phone tag. */\n tag?: PhoneInfoTag;\n }\n interface AddressInfo {\n /** Address tag. */\n tag?: Tag;\n }\n interface CustomFieldInfo {\n /** Custom field key. */\n key?: string;\n }\n interface SubscriptionInfo {\n /**\n * Subscription consent opt in level, either single or double confirmation.\n * Default: SINGLE_CONFIRMATION\n */\n optInLevel?: OptInLevel;\n }\n interface _String extends _StringComponentTypeOptionsOneOf {\n /** Text input field */\n textInputOptions?: TextInput;\n /** Selection field as radio group */\n radioGroupOptions?: RadioGroup;\n /** Selection field as drop down */\n dropdownOptions?: Dropdown;\n /** Field for selecting date and/or time */\n dateTimeOptions?: DateTimeInput;\n /** Phone input field */\n phoneInputOptions?: PhoneInput;\n /** Dropdown based component for selecting date */\n dateInputOptions?: DateInput;\n /** Field for selecting time */\n timeInputOptions?: TimeInput;\n /** Calendar type component for selecting date */\n datePickerOptions?: DatePicker;\n /** Validation of field output value. */\n validation?: InputFieldStringType;\n /**\n * Component type of the string input field\n * @readonly\n */\n componentType?: StringComponentType;\n }\n /** @oneof */\n interface _StringComponentTypeOptionsOneOf {\n /** Text input field */\n textInputOptions?: TextInput;\n /** Selection field as radio group */\n radioGroupOptions?: RadioGroup;\n /** Selection field as drop down */\n dropdownOptions?: Dropdown;\n /** Field for selecting date and/or time */\n dateTimeOptions?: DateTimeInput;\n /** Phone input field */\n phoneInputOptions?: PhoneInput;\n /** Dropdown based component for selecting date */\n dateInputOptions?: DateInput;\n /** Field for selecting time */\n timeInputOptions?: TimeInput;\n /** Calendar type component for selecting date */\n datePickerOptions?: DatePicker;\n }\n interface _Number extends _NumberComponentTypeOptionsOneOf {\n /** Number value input field */\n numberInputOptions?: NumberInput;\n /** Rating value input field */\n ratingInputOptions?: RatingInput;\n /** Validation of field output value. */\n validation?: InputFieldNumberType;\n /**\n * Component type of the number input field\n * @readonly\n */\n componentType?: NumberComponentType;\n }\n /** @oneof */\n interface _NumberComponentTypeOptionsOneOf {\n /** Number value input field */\n numberInputOptions?: NumberInput;\n /** Rating value input field */\n ratingInputOptions?: RatingInput;\n }\n interface _Boolean extends _BooleanComponentTypeOptionsOneOf {\n /** Checkbox input field */\n checkboxOptions?: Checkbox;\n /** Validation of field output value. */\n validation?: InputFieldBooleanType;\n /**\n * Component type of the boolean input field\n * @readonly\n */\n componentType?: BooleanComponentType;\n }\n /** @oneof */\n interface _BooleanComponentTypeOptionsOneOf {\n /** Checkbox input field */\n checkboxOptions?: Checkbox;\n }\n interface _Array extends _ArrayComponentTypeOptionsOneOf {\n /** Checkbox group input field */\n checkboxGroupOptions?: CheckboxGroup;\n /** Tags input field */\n tagsOptions?: Tags;\n /** Validation of array type. */\n validation?: InputFieldArrayType;\n /**\n * Component type of the array input field\n * @readonly\n */\n componentType?: ComponentType;\n }\n /** @oneof */\n interface _ArrayComponentTypeOptionsOneOf {\n /** Checkbox group input field */\n checkboxGroupOptions?: CheckboxGroup;\n /** Tags input field */\n tagsOptions?: Tags;\n }\n interface _Object extends _ObjectValidationOneOf {\n /** Validation of object type. */\n object?: InputFieldObjectType;\n /**\n * Nested form ID.\n * @internal\n */\n nestedFormId?: string | null;\n }\n /** @oneof */\n interface _ObjectValidationOneOf {\n /** Validation of object type. */\n object?: InputFieldObjectType;\n /**\n * Nested form ID.\n * @internal\n */\n nestedFormId?: string | null;\n }\n interface WixFile extends WixFileComponentTypeOptionsOneOf {\n /** File upload input field */\n fileUploadOptions?: FileUpload;\n /** Signature input field */\n signatureOptions?: Signature;\n /**\n * Component type of the array input field\n * @readonly\n */\n componentType?: WixFileComponentType;\n }\n /** @oneof */\n interface WixFileComponentTypeOptionsOneOf {\n /** File upload input field */\n fileUploadOptions?: FileUpload;\n /** Signature input field */\n signatureOptions?: Signature;\n }\n interface Payment extends PaymentComponentTypeOptionsOneOf {\n /** Checkbox group input field. */\n checkboxGroupOptions?: ProductCheckboxGroup;\n /** Donation input field. */\n donationInputOptions?: DonationInput;\n /** Payment input field. */\n paymentInputOptions?: PaymentInput;\n /** Fixed payment field. */\n fixedPaymentOptions?: FixedPayment;\n /**\n * Component type of the payment input field.\n * @readonly\n */\n componentType?: PaymentComponentType;\n /** Validation of payment type. */\n validation?: PaymentType;\n }\n /** @oneof */\n interface PaymentComponentTypeOptionsOneOf {\n /** Checkbox group input field. */\n checkboxGroupOptions?: ProductCheckboxGroup;\n /** Donation input field. */\n donationInputOptions?: DonationInput;\n /** Payment input field. */\n paymentInputOptions?: PaymentInput;\n /** Fixed payment field. */\n fixedPaymentOptions?: FixedPayment;\n }\n interface InputFieldMultilineAddress extends InputFieldMultilineAddressComponentTypeOptionsOneOf {\n /** Multiline address input field. */\n multilineAddressOptions?: MultilineAddress;\n /**\n * Component type of the multiline address field.\n * @readonly\n */\n componentType?: MultilineAddressComponentType;\n /** Validation of multiline address field output value. */\n validation?: MultilineAddressValidation;\n }\n /** @oneof */\n interface InputFieldMultilineAddressComponentTypeOptionsOneOf {\n /** Multiline address input field. */\n multilineAddressOptions?: MultilineAddress;\n }\n enum Target {\n /** Undefined target. */\n UNDEFINED = \"UNDEFINED\",\n /** Open in the same browser tab. */\n SELF = \"SELF\",\n /** Open in a new tab. */\n BLANK = \"BLANK\"\n }\n interface ThankYouMessage {\n /** Message show after form submission */\n text?: RichContent;\n /**\n * Duration after how much second it should disappear. If 0, will stay forever.\n * Default: false\n */\n duration?: number | null;\n }\n interface Redirect {\n /** Url to which UoU should be redirected after successful submit of form */\n url?: string | null;\n /** How should url be opened */\n target?: Target;\n }\n enum FieldType {\n UNKNOWN = \"UNKNOWN\",\n INPUT = \"INPUT\",\n DISPLAY = \"DISPLAY\",\n SUBMIT = \"SUBMIT\"\n }\n interface InputField extends InputFieldInputTypeOptionsOneOf {\n /** Input return string as value */\n stringOptions?: _String;\n /** Input return number as value */\n numberOptions?: _Number;\n /** Input return boolean as value */\n booleanOptions?: _Boolean;\n /** Input return array as value */\n arrayOptions?: _Array;\n /** Input return object as value */\n objectOptions?: _Object;\n /** Input return \"Wix file\" as value */\n wixFileOptions?: WixFile;\n /** Input returns selected products as value. */\n paymentOptions?: Payment;\n /** Input returns multiline address as value. */\n multilineAddressOptions?: InputFieldMultilineAddress;\n /** Definition of a target where the value of field belongs. */\n target?: string | null;\n /**\n * Mark the field as containing personal information. This will encrypt user data when storing it.\n * Default: false\n */\n pii?: boolean;\n /**\n * Whether the field is required.\n * Default: false\n */\n required?: boolean;\n /**\n * Type of the input field\n * @readonly\n */\n inputType?: InputType;\n /** Mapping to contacts, telling to what contact property field input value should be saved. */\n contactMapping?: FormFieldContactInfo;\n /**\n * Whether the field is read only.\n * Default: false\n */\n readOnly?: boolean;\n }\n /** @oneof */\n interface InputFieldInputTypeOptionsOneOf {\n /** Input return string as value */\n stringOptions?: _String;\n /** Input return number as value */\n numberOptions?: _Number;\n /** Input return boolean as value */\n booleanOptions?: _Boolean;\n /** Input return array as value */\n arrayOptions?: _Array;\n /** Input return object as value */\n objectOptions?: _Object;\n /** Input return \"Wix file\" as value */\n wixFileOptions?: WixFile;\n /** Input returns selected products as value. */\n paymentOptions?: Payment;\n /** Input returns multiline address as value. */\n multilineAddressOptions?: InputFieldMultilineAddress;\n }\n /** Copy of the entity existing in form template project, needed to hide translations. */\n interface DisplayField extends DisplayFieldDisplayFieldTypeOptionsOneOf, DisplayFieldComponentTypeOneOf {\n /** Component displaying rich content */\n richContentOptions?: RichContentOptions;\n /** Page navigation component resolving as navigation or submit buttons */\n pageNavigationOptions?: PageNavigationOptions;\n /** Header field */\n header?: Header;\n /** Rich text field */\n richText?: RichText;\n /** Type of the display field */\n displayFieldType?: DisplayFieldType;\n }\n /** @oneof */\n interface DisplayFieldDisplayFieldTypeOptionsOneOf {\n /** Component displaying rich content */\n richContentOptions?: RichContentOptions;\n /** Page navigation component resolving as navigation or submit buttons */\n pageNavigationOptions?: PageNavigationOptions;\n }\n /** @oneof */\n interface DisplayFieldComponentTypeOneOf {\n /** Header field */\n header?: Header;\n /** Rich text field */\n richText?: RichText;\n }\n enum DisplayFieldType {\n UNKNOWN_FIELD_TYPE = \"UNKNOWN_FIELD_TYPE\",\n RICH_CONTENT = \"RICH_CONTENT\",\n PAGE_NAVIGATION = \"PAGE_NAVIGATION\"\n }\n interface RichContentOptions {\n /** Content of the header */\n richContent?: RichContent;\n }\n interface PageNavigationOptions {\n /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */\n nextPageText?: string | null;\n /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */\n previousPageText?: string | null;\n /** Text on the button when button is submitting a form */\n submitText?: string | null;\n }\n interface Header {\n /** Content of the header */\n content?: RichContent;\n }\n interface RichText {\n /** Content of the rich text field */\n content?: RichContent;\n }\n interface SubmitButton extends SubmitButtonSubmitActionOneOf {\n /**\n * Submit action effect is to show message\n * @deprecated Submit action effect is to show message\n * @replacedBy wix.forms.v4.SubmitSettings.ThankYouMessageOptions\n * @targetRemovalDate 2025-01-06\n */\n thankYouMessage?: ThankYouMessage;\n /**\n * Submit action effect is to redirect to\n * @deprecated Submit action effect is to redirect to\n * @replacedBy wix.forms.v4.SubmitSettings.RedirectOptions\n * @targetRemovalDate 2025-01-06\n */\n redirect?: Redirect;\n /** When button is not on last page it behaves as switch between pages page, text of label to go to next page. */\n nextText?: string | null;\n /** When button is not on last page it behaves as switch between pages page, text of label to go to previous page. */\n previousText?: string | null;\n /** Text on the button when button is submitting a form */\n submitText?: string | null;\n }\n /** @oneof */\n interface SubmitButtonSubmitActionOneOf {\n /**\n * Submit action effect is to show message\n * @deprecated Submit action effect is to show message\n * @replacedBy wix.forms.v4.SubmitSettings.ThankYouMessageOptions\n * @targetRemovalDate 2025-01-06\n */\n thankYouMessage?: ThankYouMessage;\n /**\n * Submit action effect is to redirect to\n * @deprecated Submit action effect is to redirect to\n * @replacedBy wix.forms.v4.SubmitSettings.RedirectOptions\n * @targetRemovalDate 2025-01-06\n */\n redirect?: Redirect;\n }\n interface Step {\n /** Step ID. */\n _id?: string;\n /** Name of the step. */\n name?: string | null;\n /** Is step hidden */\n hidden?: boolean;\n /** Form step properties */\n layout?: FormLayout;\n }\n interface FormLayout {\n /** Layout for large break point. */\n large?: BreakPoint;\n /** Layout for medium break point. */\n medium?: BreakPoint;\n /** Layout for small break point. */\n small?: BreakPoint;\n }\n interface BreakPoint {\n /** Description of layouts for items. */\n items?: ItemLayout[];\n /** Amount of columns of layout grid. */\n columns?: number | null;\n /** Row height of layout grid. */\n rowHeight?: number | null;\n /** Description of elements margins. */\n margin?: Margin;\n /** Description of elements paddings. */\n padding?: Margin;\n /** Sections of the layout, which allow manage fields */\n sections?: Section[];\n }\n interface ItemLayout extends ItemLayoutItemOneOf {\n /** Form field reference id. */\n fieldId?: string;\n /** Group info, defining that this item is a group of multiple fields */\n group?: Group;\n /** Horizontal coordinate in the grid. */\n row?: number | null;\n /** Vertical coordinate in the grid. */\n column?: number | null;\n /** Height. */\n width?: number | null;\n /** Width. */\n height?: number | null;\n }\n /** @oneof */\n interface ItemLayoutItemOneOf {\n /** Form field reference id. */\n fieldId?: string;\n /** Group info, defining that this item is a group of multiple fields */\n group?: Group;\n }\n interface Group {\n /** Field group reference id. */\n groupId?: string;\n /** Description of layouts for items. */\n items?: ItemLayout[];\n }\n interface Margin {\n /** Horizontal value. */\n horizontal?: number | null;\n /** Vertical value. */\n vertical?: number | null;\n }\n interface Section {\n /** Id of the section */\n _id?: string;\n /** Horizontal coordinate in the grid. */\n row?: number | null;\n /**\n * A list of field identifiers that are permitted to be placed within a section.\n * The section will only accept fields with IDs specified in this list.\n * If the section encounters the $new key within the list,\n * it allows the inclusion of fields not explicitly listed,\n * enabling dynamic addition of new fields.\n */\n allowedFieldIds?: string[];\n }\n interface FormRule {\n /** Id of the rule */\n _id?: string;\n /** Rule on which item properties or layouts will be changed. */\n condition?: Record | null;\n /**\n * Form items with defined properties that will be\n * changed when given condition is resolved to true.\n */\n overrides?: FormOverride[];\n /** Name of the rule */\n name?: string | null;\n }\n enum OverrideEntityType {\n UNKNOWN = \"UNKNOWN\",\n FIELD = \"FIELD\",\n FORM = \"FORM\",\n NESTED_FORM_FIELD = \"NESTED_FORM_FIELD\"\n }\n interface FormOverride {\n /** Override entity type. */\n entityType?: OverrideEntityType;\n /** Overridden entity id. Either fieldId, or \"{fieldIdWithNestedForm}/{nestedFormFieldId}\" */\n entityId?: string | null;\n /** Form entity properties path with new value, that will be changed on condition. */\n valueChanges?: Record;\n }\n interface FormProperties {\n /** Form name. */\n name?: string | null;\n /** Identifies if the form is disabled. */\n disabled?: boolean;\n }\n enum Kind {\n /** Return forms specific to tenant, excluding template based forms. */\n REGULAR = \"REGULAR\",\n /** Return forms based on common templates, with applied user overrides if they exist. */\n EXTENSION = \"EXTENSION\"\n }\n interface PostSubmissionTriggers {\n /** Upserts a contact from the submission data. */\n upsertContact?: UpsertContact;\n }\n interface UpsertContact {\n /** Fields mapping (target field mapped to corresponding contact field). */\n fieldsMapping?: Record;\n /**\n * List of contact label keys.\n * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\n * help categorize contacts.\n */\n labels?: 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 interface NestedForm {\n /** Targets which have this form. */\n targets?: string[];\n /** Nested form. */\n form?: Form;\n }\n interface LimitationRule {\n /** Limitation by submission count, disables form when a set amount of submissions is reached. */\n maxAllowedSubmissions?: number | null;\n /** Limitation by submission date, disables form when a set date and time is reached. */\n dateTimeDeadline?: Date | null;\n }\n enum SpamFilterProtectionLevel {\n /** Unknown spam filter protection level. */\n UNKNOWN = \"UNKNOWN\",\n /** Spam filter is not used. Form is open for spam submissions. */\n NONE = \"NONE\",\n /** Spam filter operates in basic mode. Form is open to high risk of spam submissions. */\n BASIC = \"BASIC\",\n /** Spam filter operates in advanced mode. Form is open to low risk of spam submissions. */\n ADVANCED = \"ADVANCED\"\n }\n interface RequiredIndicatorProperties {\n /** Required indicator. */\n requiredIndicator?: RequiredIndicator;\n /** Required indicator placement. */\n requiredIndicatorPlacement?: RequiredIndicatorPlacement;\n }\n interface SubmitSettings extends SubmitSettingsSubmitSuccessActionOptionsOneOf {\n /** Options for showing a thank you message after submission. */\n thankYouMessageOptions?: ThankYouMessageOptions;\n /** Options for redirecting to a URL after submission. */\n redirectOptions?: RedirectOptions;\n /** Action that is triggered after a successful form submission. */\n submitSuccessAction?: SubmitSuccessAction;\n }\n /** @oneof */\n interface SubmitSettingsSubmitSuccessActionOptionsOneOf {\n /** Options for showing a thank you message after submission. */\n thankYouMessageOptions?: ThankYouMessageOptions;\n /** Options for redirecting to a URL after submission. */\n redirectOptions?: RedirectOptions;\n }\n enum UrlTargetEnumTarget {\n /** Unknown target. */\n UNKNOWN_TARGET = \"UNKNOWN_TARGET\",\n /** Open in the same browser tab. */\n SELF = \"SELF\",\n /** Open in a new browser tab. */\n BLANK = \"BLANK\"\n }\n enum SubmitSuccessAction {\n /** Unknown submit success action. */\n UNKNOWN_SUBMIT_SUCCESS_ACTION = \"UNKNOWN_SUBMIT_SUCCESS_ACTION\",\n /** No action will be taken after submission. */\n NO_ACTION = \"NO_ACTION\",\n /** A thank you message will be shown after submission. */\n THANK_YOU_MESSAGE = \"THANK_YOU_MESSAGE\",\n /** The user will be redirected to a URL after submission. */\n REDIRECT = \"REDIRECT\"\n }\n interface ThankYouMessageOptions {\n /** Duration in seconds after which the message should disappear. If 0, the message will stay forever. */\n durationInSeconds?: number | null;\n /** The message shown after form submission. */\n richContent?: RichContent;\n }\n interface RedirectOptions {\n /** The URL to which the user should be redirected after a successful form submission. */\n redirectUrl?: string | null;\n /** How the URL should be opened. */\n target?: UrlTargetEnumTarget;\n }\n interface FieldGroup {\n /** Id of group, on layout */\n _id?: string;\n /** Label of group */\n label?: string | null;\n }\n interface PiiFieldsUpdated {\n /** Collection of fields which are marked as PII */\n piiFields?: string[];\n /** Collection of fields which are non PII */\n nonPiiFields?: string[];\n }\n interface FormChanged {\n /** Form namespace */\n namespace?: string;\n /** Form after update */\n form?: Form;\n /** Form before update */\n formBeforeUpdate?: Form;\n }\n interface FormDeleted {\n /** Form namespace */\n namespace?: string;\n /** Form state on delete moment */\n form?: Form;\n }\n interface SubmissionKeysPermanentlyDeleted {\n /** Keys which should be deleted */\n keys?: string[] | null;\n }\n interface CreateFormRequest {\n /** Form to be created. */\n form: Form;\n }\n interface CreateFormResponse {\n /** The created form. */\n form?: Form;\n }\n interface TargetBasedErrorDetails {\n /** Targets which are related to the error. */\n targets?: string[];\n }\n interface FieldIdBasedErrorDetails {\n /** Field ids which are related to the error. */\n ids?: string[];\n }\n interface StepIdBasedErrorDetails {\n /** Step ids which are related to the error. */\n ids?: string[];\n }\n interface RuleIdBasedErrorDetails {\n /** Rule ids which are related to the error. */\n ids?: string[];\n }\n interface NonExistingNestedFormsErrorDetails {\n /** Non existing nested form ids by target */\n targetToNestedFormId?: Record;\n }\n interface NestedFormFieldsMissingErrorDetails {\n /** Missing nested template field ids by target. */\n targetToNestedFormFieldIds?: Record;\n }\n interface FormFieldV2ApiValidationErrorDetails {\n /** Field ids which are related to the error. */\n ids?: string[];\n /** Violations which are related to the error. */\n violations?: string[];\n }\n interface ProductIdBasedErrorDetails {\n /** Product ids which are related to the error. */\n ids?: string[];\n }\n interface BulkCreateFormRequest {\n /** Forms to be created. */\n forms?: Form[];\n /** When set, items will be returned on successful create */\n returnEntity?: boolean;\n }\n interface BulkCreateFormResponse {\n /** Created forms with metadata */\n results?: BulkFormResult[];\n /** Metadata of request */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkFormResult {\n /** Created form metadata */\n itemMetadata?: ItemMetadata;\n /** Created form */\n item?: Form;\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 CloneFormRequest {\n /** Id of the form to clone. */\n formId: string;\n }\n interface CloneFormResponse {\n /** The cloned form. */\n form?: Form;\n }\n interface CloneFormFromTemplateRequest {\n /** Namespace of the vertical owning template */\n namespace: string;\n /** Template id which can be copied */\n templateId: string;\n /**\n * When true, will try to create form with same id as template\n * Will fail if entity with such Id already exists\n */\n useTemplateId?: boolean;\n }\n interface CloneFormFromTemplateResponse {\n /** The cloned form. */\n form?: Form;\n }\n interface GetFormRequest {\n /** Id of the form to retrieve. */\n formId: string;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\n }\n enum Fieldset {\n UNKNOWN = \"UNKNOWN\",\n /** Includes nested forms when present. */\n NESTED_FORMS = \"NESTED_FORMS\"\n }\n interface GetFormResponse {\n /** The retrieved form. */\n form?: Form;\n }\n interface UpdateFormRequest {\n /** Form to be updated, may be partial. */\n form: Form;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateFormResponse {\n /** The updated form. */\n form?: Form;\n }\n interface RemoveFormFromTrashBinRequest {\n /** Id of the form to delete. */\n formId: string;\n }\n interface RemoveFormFromTrashBinResponse {\n }\n interface DeleteFormRequest {\n /** Id of the form to delete. */\n formId: string;\n /**\n * Delete form bypassing trash-bin.\n * Default: false\n */\n permanent?: boolean;\n }\n interface DeleteFormResponse {\n }\n interface RestoreFromTrashBinRequest {\n /** Id of the form to restore. */\n formId: string;\n }\n interface RestoreFromTrashBinResponse {\n /** The restored form. */\n form?: Form;\n }\n interface QueryFormsRequest {\n /** WQL expression, namespace equality filter is required. */\n query: CursorQuery;\n /**\n * Kind of queried forms.\n * REGULAR - will return forms specific to tenant, excluding template based forms.\n * EXTENSION - will return forms based on common templates, with applied user overrides if there are such.\n * @internal\n */\n kind?: Kind;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\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?: CommonCursorPaging;\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?: CommonCursorPaging;\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 CommonCursorPaging {\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 QueryFormsResponse {\n /** The retrieved forms */\n forms?: Form[];\n /** Details on the paged set of results returned. */\n metadata?: CommonCursorPagingMetadata;\n }\n interface CommonCursorPagingMetadata {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: CommonCursors;\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 CommonCursors {\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 CountFormsRequest {\n /** Namespace name. */\n namespace: string;\n /** Fieldsets. */\n fieldsets?: CountFormsFieldset[];\n }\n enum CountFormsFieldset {\n UNKNOWN = \"UNKNOWN\",\n /** Include deleted forms count. */\n DELETED = \"DELETED\"\n }\n interface CountFormsResponse {\n /** Total forms count. Includes active and disabled forms. Does not include deleted forms. */\n totalCount?: number;\n /** Active forms count. Only includes non-disabled forms if FT CountFormsActiveCountExcludeDisabled is true, otherwise behaves like total_count. */\n activeCount?: number;\n /** Disabled forms count. */\n disabledCount?: number;\n /** Deleted forms count. Counted only if specifically requested using a fieldset. */\n deletedCount?: number | null;\n }\n interface ListTemplateExtensionsRequest {\n /** Namespace name. */\n namespace: string;\n /** Identifies if the form is disabled. */\n disabled?: boolean | null;\n /**\n * Ordering options.\n *\n * - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.\n * - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.\n * - `CREATED_DATE_ASC`: Ordered by `createdDate` in ascending order.\n * - `CREATED_DATE_DESC`: Ordered by `createdDate` in descending order.\n * - `NAME_ASC`: Ordered by `properties.name` in ascending order.\n * - `NAME_DESC`: Ordered by `properties.name` in descending order.\n *\n * Default: `UPDATED_DATE_DESC`\n */\n order?: ListFormsOrderEnumListFormsOrder;\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?: CommonCursorPaging;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Form ids. */\n formIds?: string[];\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\n /** Filter by name */\n nameFilter?: NameFilter;\n /** List of templates id, which extensions expected */\n templateIds: string[];\n }\n enum ListFormsOrderEnumListFormsOrder {\n /** Sorting by updated date descending. The default value. */\n UPDATED_DATE_DESC = \"UPDATED_DATE_DESC\",\n /** Sorting by updated date ascending. */\n UPDATED_DATE_ASC = \"UPDATED_DATE_ASC\",\n /** Sorting by created date ascending. */\n CREATED_DATE_ASC = \"CREATED_DATE_ASC\",\n /** Sorting by created date descending. */\n CREATED_DATE_DESC = \"CREATED_DATE_DESC\",\n /** Sorting by name ascending. */\n NAME_ASC = \"NAME_ASC\",\n /** Sorting by name descending. */\n NAME_DESC = \"NAME_DESC\"\n }\n interface NameFilter {\n /** Type of filter */\n filterType?: FilterType;\n /** Expected name */\n name?: string;\n }\n enum FilterType {\n EXACT_MATCH = \"EXACT_MATCH\",\n STARTS_WITH = \"STARTS_WITH\"\n }\n interface ListTemplateExtensionsResponse {\n /** The retrieved forms. */\n forms?: Form[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: CommonCursorPagingMetadata;\n }\n interface ListFormsRequest {\n /** Namespace name. */\n namespace: string;\n /** Identifies if the form is disabled. */\n disabled?: boolean | null;\n /**\n * Kind of forms.\n * @internal\n */\n kind?: Kind;\n /**\n * Ordering options.\n *\n * - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.\n * - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.\n * - `CREATED_DATE_ASC`: Ordered by `createdDate` in ascending order.\n * - `CREATED_DATE_DESC`: Ordered by `createdDate` in descending order.\n * - `NAME_ASC`: Ordered by `properties.name` in ascending order.\n * - `NAME_DESC`: Ordered by `properties.name` in descending order.\n *\n * Default: `UPDATED_DATE_DESC`\n */\n order?: ListFormsOrder;\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?: CommonCursorPaging;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Form ids. */\n formIds?: string[];\n /** Identifies if the form is a payment form */\n paymentForm?: boolean | null;\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\n }\n enum ListFormsOrder {\n /** Sorting by updated date descending. The default value. */\n UPDATED_DATE_DESC = \"UPDATED_DATE_DESC\",\n /** Sorting by updated date ascending. */\n UPDATED_DATE_ASC = \"UPDATED_DATE_ASC\",\n /** Sorting by created date ascending. */\n CREATED_DATE_ASC = \"CREATED_DATE_ASC\",\n /** Sorting by created date descending. */\n CREATED_DATE_DESC = \"CREATED_DATE_DESC\",\n /** Sorting by name ascending. */\n NAME_ASC = \"NAME_ASC\",\n /** Sorting by name descending. */\n NAME_DESC = \"NAME_DESC\"\n }\n interface ListFormsResponse {\n /** The retrieved forms. */\n forms?: Form[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: CommonCursorPagingMetadata;\n }\n interface GetDeletedFormRequest {\n /** Id of the Form to retrieve */\n formId: string;\n }\n interface GetDeletedFormResponse {\n /** The retrieved Form */\n form?: Form;\n }\n interface QueryDeletedFormsRequest {\n /** WQL expression, namespace equality filter is required. */\n query: CursorQuery;\n }\n interface QueryDeletedFormsResponse {\n /** The retrieved Forms */\n forms?: Form[];\n /** Details on the paged set of results returned. */\n metadata?: CommonCursorPagingMetadata;\n }\n interface ListDeletedFormsRequest {\n /** Namespace name. */\n namespace: string;\n /** Identifies if the form is disabled. */\n disabled?: boolean | null;\n /** Form ids. */\n formIds?: string[];\n /**\n * Ordering options.\n *\n * - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.\n * - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.\n * - `NAME_ASC`: Ordered by `properties.name` in ascending order.\n * - `NAME_DESC`: Ordered by `properties.name` in descending order.\n *\n * Default: `UPDATED_DATE_DESC`\n */\n order?: ListDeletedFormsOrder;\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?: CommonCursorPaging;\n /** Identifies if the form is a payment form */\n paymentForm?: boolean | null;\n }\n enum ListDeletedFormsOrder {\n /** Sorting by updated date descending. The default value. */\n UPDATED_DATE_DESC = \"UPDATED_DATE_DESC\",\n /** Sorting by updated date ascending. */\n UPDATED_DATE_ASC = \"UPDATED_DATE_ASC\",\n /** Sorting by name descending. */\n NAME_DESC = \"NAME_DESC\",\n /** Sorting by name ascending. */\n NAME_ASC = \"NAME_ASC\"\n }\n interface ListDeletedFormsResponse {\n /** The retrieved forms. */\n forms?: Form[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: CommonCursorPagingMetadata;\n }\n interface BulkRemoveDeletedFieldRequest {\n /** Id of the form to delete. */\n formId: string;\n /** Ids of the deleted fields to remove. */\n fieldsIds?: string[];\n }\n interface BulkRemoveDeletedFieldResponse {\n /** Form with the deleted fields. */\n form?: Form;\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 /** namespace that was updated */\n namespace?: string;\n /** only data from UpdateExtendedFieldsRequest namespace_data */\n namespaceData?: Record | null;\n }\n interface ListFormsProvidersConfigsRequest {\n }\n interface ListFormsProvidersConfigsResponse {\n /** List of configs set by form providers */\n configs?: FormsSchemaProvidersConfig[];\n }\n interface FormsSchemaProvidersConfig {\n /** Namespace which can be used to create form */\n namespace?: string;\n /** Id of app which provides this config. */\n appId?: string;\n /** Restrictions associated with this namespace. */\n restrictions?: FormProviderRestrictions;\n }\n interface FormProviderRestrictions {\n /** Maximum amount of forms allowed per namespace. */\n maxFormsAmount?: number;\n /** Maximum amount of fields allowed per form. */\n maxFieldsAmount?: number;\n /** Maximum amount of deleted forms allowed per namespace. */\n maxDeletedFormsAmount?: number | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n interface GetFormSummaryRequest {\n /** Id of the form to retrieve. */\n formId: string;\n }\n interface GetFormSummaryResponse {\n /** The retrieved form field summary. */\n formSummary?: FormSummary;\n }\n interface FormSummary {\n /** Form ID. */\n _id?: string;\n /** Summarized form fields. */\n fields?: Field[];\n }\n enum FieldInputType {\n UNKNOWN_INPUT_TYPE = \"UNKNOWN_INPUT_TYPE\",\n STRING = \"STRING\",\n NUMBER = \"NUMBER\",\n RATING = \"RATING\",\n BOOLEAN = \"BOOLEAN\",\n ARRAY = \"ARRAY\",\n OBJECT = \"OBJECT\",\n WIX_FILE = \"WIX_FILE\",\n SIGNATURE = \"SIGNATURE\",\n PAYMENT = \"PAYMENT\",\n MULTILINE_ADDRESS = \"MULTILINE_ADDRESS\",\n DATE = \"DATE\",\n TIME = \"TIME\",\n DATE_TIME = \"DATE_TIME\",\n EMAIL = \"EMAIL\",\n URL = \"URL\",\n UUID = \"UUID\",\n PHONE = \"PHONE\",\n URI = \"URI\",\n HOSTNAME = \"HOSTNAME\",\n COLOR_HEX = \"COLOR_HEX\",\n CURRENCY = \"CURRENCY\",\n LANGUAGE = \"LANGUAGE\",\n DATE_OPTIONAL_TIME = \"DATE_OPTIONAL_TIME\"\n }\n interface FieldOption {\n /** Selectable option label */\n label?: string | null;\n /** Selectable option value, which is saved to DB. */\n value?: string | null;\n }\n interface Field {\n /** Definition of a target where the value of field belongs. */\n target?: string | null;\n /** Label of the field */\n label?: string | null;\n /** Input type of the field */\n type?: FieldInputType;\n /** List of options to select from */\n options?: FieldOption[];\n /**\n * Flag indicating whether field is deleted.\n * Default: false.\n */\n deleted?: boolean;\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 form.\n * @param form - Form to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField form\n * @requiredField form.fields._id\n * @requiredField form.namespace\n * @requiredField form.rules._id\n * @requiredField form.steps._id\n * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE\n * @adminMethod\n * @returns The created form.\n */\n function createForm(form: Form): Promise
;\n /**\n * Creates multiple new forms.\n * @public\n * @documentationMaturity preview\n * @requiredField options.forms.fields._id\n * @requiredField options.forms.namespace\n * @requiredField options.forms.rules._id\n * @requiredField options.forms.steps._id\n * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE\n * @adminMethod\n */\n function bulkCreateForm(options?: BulkCreateFormOptions): Promise;\n interface BulkCreateFormOptions {\n /** Forms to be created. */\n forms?: Form[];\n /** When set, items will be returned on successful create */\n returnEntity?: boolean;\n }\n /**\n * Clones an existing form.\n * @param formId - Id of the form to clone.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE\n * @adminMethod\n */\n function cloneForm(formId: string): Promise;\n /**\n * Clones template as a form.\n * @param namespace - Namespace of the vertical owning template\n * @internal\n * @documentationMaturity preview\n * @requiredField namespace\n * @requiredField options.templateId\n * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE\n * @adminMethod\n */\n function cloneFormFromTemplate(namespace: string, options?: CloneFormFromTemplateOptions): Promise;\n interface CloneFormFromTemplateOptions {\n /** Template id which can be copied */\n templateId: string;\n /**\n * When true, will try to create form with same id as template\n * Will fail if entity with such Id already exists\n */\n useTemplateId?: boolean;\n }\n /**\n * Gets a form by id.\n * @param formId - Id of the form to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n * @returns The retrieved form.\n */\n function getForm(formId: string, options?: GetFormOptions): Promise;\n interface GetFormOptions {\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\n }\n /**\n * Updates a form, supports partial update.\n * Pass the latest `revision` for a successful update.\n * @param _id - Form ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField form\n * @requiredField form.fields._id\n * @requiredField form.revision\n * @requiredField form.rules._id\n * @requiredField form.steps._id\n * @permissionId WIX_FORMS.FORM_SCHEMA_UPDATE\n * @adminMethod\n * @returns The updated form.\n */\n function updateForm(_id: string | null, form: UpdateForm, options?: UpdateFormOptions): Promise;\n interface UpdateForm {\n /**\n * Form ID.\n * @readonly\n */\n _id?: string | null;\n /** List of form fields that represent input elements. */\n fields?: FormField[];\n /**\n * List of form fields that represent input elements.\n * @readonly\n */\n fieldsV2?: FormFieldV2[];\n /** Defines the layout for form fields in each submission step. */\n steps?: Step[];\n /** Form rules, can be applied to layout and items properties. */\n rules?: FormRule[];\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date of creation.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date of last update.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Properties of the form. */\n properties?: FormProperties;\n /**\n * Fields which were soft deleted.\n * @readonly\n */\n deletedFields?: FormField[];\n /**\n * List of form fields that represent input elements.\n * @readonly\n */\n deletedFieldsV2?: FormFieldV2[];\n /**\n * Regular forms can be freely modified.\n * Extensions are copied from templates and might have restrictions.\n * @readonly\n */\n kind?: Kind;\n /**\n * Defines triggers that will be executed after the submission, for the submissions based on this schema.\n * Forms provide a set of predefined triggers that allow it to assign specific business cases to created forms.\n */\n postSubmissionTriggers?: PostSubmissionTriggers;\n /** Data extensions ExtendedFields. */\n extendedFields?: ExtendedFields;\n /** Identifies the namespace that the form belongs to. */\n namespace?: string;\n /**\n * Nested forms.\n * @internal\n * @readonly\n */\n nestedForms?: NestedForm[];\n /**\n * Media folder ID.\n * @readonly\n */\n mediaFolderId?: string | null;\n /** Rules that limit submissions on this form. */\n limitationRule?: LimitationRule;\n /**\n * Spam filter protection level.\n * Default: ADVANCED.\n */\n spamFilterProtectionLevel?: SpamFilterProtectionLevel;\n /** Required indicator properties. */\n requiredIndicatorProperties?: RequiredIndicatorProperties;\n /** Settings for actions to be taken after form submission. */\n submitSettings?: SubmitSettings;\n /** Settings for field groups */\n fieldGroups?: FieldGroup[];\n /** Message shown when the form is disabled */\n disabledFormMessage?: RichContent;\n /** Id of the source form. */\n sourceFormId?: string | null;\n }\n interface UpdateFormOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a form. It is stored in trash for 90 days.\n * On form permanent deletion, all submissions are also deleted.\n * @param formId - Id of the form to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_DELETE\n * @adminMethod\n */\n function removeFormFromTrashBin(formId: string): Promise;\n /**\n * Deletes a form. It is stored in trash for 90 days.\n * On form permanent deletion, all submissions are also deleted.\n * @param formId - Id of the form to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_DELETE\n * @adminMethod\n */\n function deleteForm(formId: string, options?: DeleteFormOptions): Promise;\n interface DeleteFormOptions {\n /**\n * Delete form bypassing trash-bin.\n * Default: false\n */\n permanent?: boolean;\n }\n /**\n * Restores a form from trash.\n * @param formId - Id of the form to restore.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE\n * @adminMethod\n */\n function restoreFromTrashBin(formId: string): Promise;\n /**\n * Query forms using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function queryForms(options?: QueryFormsOptions): FormsQueryBuilder;\n interface QueryFormsOptions {\n /**\n * Kind of queried forms.\n * REGULAR - will return forms specific to tenant, excluding template based forms.\n * EXTENSION - will return forms based on common templates, with applied user overrides if there are such.\n * @internal\n */\n kind?: Kind | undefined;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[] | undefined;\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null | undefined;\n }\n interface QueryCursorResult {\n cursors: CommonCursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface FormsQueryResult extends QueryCursorResult {\n items: Form[];\n query: FormsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface FormsQueryBuilder {\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' | 'properties.name' | 'properties.disabled' | 'namespace', value: any) => FormsQueryBuilder;\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' | 'properties.name' | 'properties.disabled', value: any) => FormsQueryBuilder;\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) => FormsQueryBuilder;\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) => FormsQueryBuilder;\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) => FormsQueryBuilder;\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) => FormsQueryBuilder;\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: 'properties.name', value: string) => FormsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'properties.name', value: any) => FormsQueryBuilder;\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' | 'properties.name' | 'properties.disabled' | 'namespace'>) => FormsQueryBuilder;\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' | 'properties.name' | 'properties.disabled' | 'namespace'>) => FormsQueryBuilder;\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) => FormsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => FormsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts forms.\n * @param namespace - Namespace name.\n * @public\n * @documentationMaturity preview\n * @requiredField namespace\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function countForms(namespace: string, options?: CountFormsOptions): Promise;\n interface CountFormsOptions {\n /** Fieldsets. */\n fieldsets?: CountFormsFieldset[];\n }\n /**\n * Lists template extension as forms, filtered by namespace, its disabled status and name.\n * If specified, sorts forms in the desired order.\n * @param namespace - Namespace name.\n * @public\n * @documentationMaturity preview\n * @requiredField namespace\n * @requiredField options.templateIds\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function listTemplateExtensions(namespace: string, options?: ListTemplateExtensionsOptions): Promise;\n interface ListTemplateExtensionsOptions {\n /** Identifies if the form is disabled. */\n disabled?: boolean | null;\n /**\n * Ordering options.\n *\n * - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.\n * - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.\n * - `CREATED_DATE_ASC`: Ordered by `createdDate` in ascending order.\n * - `CREATED_DATE_DESC`: Ordered by `createdDate` in descending order.\n * - `NAME_ASC`: Ordered by `properties.name` in ascending order.\n * - `NAME_DESC`: Ordered by `properties.name` in descending order.\n *\n * Default: `UPDATED_DATE_DESC`\n */\n order?: ListFormsOrderEnumListFormsOrder;\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?: CommonCursorPaging;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Form ids. */\n formIds?: string[];\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\n /** Filter by name */\n nameFilter?: NameFilter;\n /** List of templates id, which extensions expected */\n templateIds: string[];\n }\n /**\n * Lists forms, filtered by namespace and its disabled status. If specified, sorts forms in the desired order.\n * Provides a subset of QueryForms supported capabilities.\n * @param namespace - Namespace name.\n * @public\n * @documentationMaturity preview\n * @requiredField namespace\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function listForms(namespace: string, options?: ListFormsOptions): Promise;\n interface ListFormsOptions {\n /** Identifies if the form is disabled. */\n disabled?: boolean | null;\n /**\n * Kind of forms.\n * @internal\n */\n kind?: Kind;\n /**\n * Ordering options.\n *\n * - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.\n * - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.\n * - `CREATED_DATE_ASC`: Ordered by `createdDate` in ascending order.\n * - `CREATED_DATE_DESC`: Ordered by `createdDate` in descending order.\n * - `NAME_ASC`: Ordered by `properties.name` in ascending order.\n * - `NAME_DESC`: Ordered by `properties.name` in descending order.\n *\n * Default: `UPDATED_DATE_DESC`\n */\n order?: ListFormsOrder;\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?: CommonCursorPaging;\n /**\n * List of additional form fields to include in the response. For example, use the `NESTED_FORMS` fieldset to retrieve the nested forms field in\n * the response in addition to the form’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the form’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n /** Form ids. */\n formIds?: string[];\n /** Identifies if the form is a payment form */\n paymentForm?: boolean | null;\n /** Optional metadata passed to SPI implementer, allowing clients to include additional business-specific data. */\n additionalMetadata?: Record | null;\n }\n /**\n * Get a deleted Form by id\n * @param formId - Id of the Form to retrieve\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function getDeletedForm(formId: string): Promise;\n /**\n * Query deleted Forms using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @param query - WQL expression, namespace equality filter is required.\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function queryDeletedForms(query: CursorQuery): Promise;\n /**\n * List deleted Forms\n * @param namespace - Namespace name.\n * @public\n * @documentationMaturity preview\n * @requiredField namespace\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function listDeletedForms(namespace: string, options?: ListDeletedFormsOptions): Promise;\n interface ListDeletedFormsOptions {\n /** Identifies if the form is disabled. */\n disabled?: boolean | null;\n /** Form ids. */\n formIds?: string[];\n /**\n * Ordering options.\n *\n * - `UPDATED_DATE_ASC`: Ordered by `updatedDate` in ascending order.\n * - `UPDATED_DATE_DESC`: Ordered by `updatedDate` in descending order.\n * - `NAME_ASC`: Ordered by `properties.name` in ascending order.\n * - `NAME_DESC`: Ordered by `properties.name` in descending order.\n *\n * Default: `UPDATED_DATE_DESC`\n */\n order?: ListDeletedFormsOrder;\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?: CommonCursorPaging;\n /** Identifies if the form is a payment form */\n paymentForm?: boolean | null;\n }\n /**\n * Remove delete field by its target\n * @param formId - Id of the form to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.MANAGE\n * @adminMethod\n */\n function bulkRemoveDeletedField(formId: string, options?: BulkRemoveDeletedFieldOptions): Promise;\n interface BulkRemoveDeletedFieldOptions {\n /** Ids of the deleted fields to remove. */\n fieldsIds?: string[];\n }\n /**\n * Update Extended Fields of the Form\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 WIX_FORMS.FORM_SCHEMA_UPDATE\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 /**\n * List configurations set by apps providing ability to create forms under their domain.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_FORMS.FORM_SCHEMA_UPDATE\n * @adminMethod\n */\n function listFormsProvidersConfigs(): Promise;\n /**\n * Gets a summary of a form by id.\n * @param formId - Id of the form to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField formId\n * @permissionId WIX_FORMS.FORM_SCHEMA_READ\n */\n function getFormSummary(formId: string): Promise;\n \n type formsV4Form_universal_d_Form = Form;\n type formsV4Form_universal_d_RequiredIndicator = RequiredIndicator;\n const formsV4Form_universal_d_RequiredIndicator: typeof RequiredIndicator;\n type formsV4Form_universal_d_RequiredIndicatorPlacement = RequiredIndicatorPlacement;\n const formsV4Form_universal_d_RequiredIndicatorPlacement: typeof RequiredIndicatorPlacement;\n type formsV4Form_universal_d_FormField = FormField;\n type formsV4Form_universal_d_StringType = StringType;\n type formsV4Form_universal_d_StringTypeFormatOptionsOneOf = StringTypeFormatOptionsOneOf;\n type formsV4Form_universal_d_Format = Format;\n const formsV4Form_universal_d_Format: typeof Format;\n type formsV4Form_universal_d_StringErrorMessages = StringErrorMessages;\n type formsV4Form_universal_d_DateTimeConstraints = DateTimeConstraints;\n type formsV4Form_universal_d_PhoneConstraints = PhoneConstraints;\n type formsV4Form_universal_d_NumberType = NumberType;\n type formsV4Form_universal_d_NumberErrorMessages = NumberErrorMessages;\n type formsV4Form_universal_d_IntegerType = IntegerType;\n type formsV4Form_universal_d_BooleanType = BooleanType;\n type formsV4Form_universal_d_BooleanErrorMessages = BooleanErrorMessages;\n type formsV4Form_universal_d_ArrayType = ArrayType;\n type formsV4Form_universal_d_ObjectType = ObjectType;\n type formsV4Form_universal_d_PropertiesType = PropertiesType;\n type formsV4Form_universal_d_PropertiesTypePropertiesTypeOneOf = PropertiesTypePropertiesTypeOneOf;\n type formsV4Form_universal_d_ObjectErrorMessages = ObjectErrorMessages;\n type formsV4Form_universal_d_ArrayItems = ArrayItems;\n type formsV4Form_universal_d_ArrayItemsItemsOneOf = ArrayItemsItemsOneOf;\n type formsV4Form_universal_d_ArrayErrorMessages = ArrayErrorMessages;\n type formsV4Form_universal_d_PredefinedValidation = PredefinedValidation;\n type formsV4Form_universal_d_PredefinedValidationFormatOptionsOneOf = PredefinedValidationFormatOptionsOneOf;\n type formsV4Form_universal_d_ValidationFormat = ValidationFormat;\n const formsV4Form_universal_d_ValidationFormat: typeof ValidationFormat;\n type formsV4Form_universal_d_PaymentType = PaymentType;\n type formsV4Form_universal_d_ProductType = ProductType;\n const formsV4Form_universal_d_ProductType: typeof ProductType;\n type formsV4Form_universal_d_PriceType = PriceType;\n const formsV4Form_universal_d_PriceType: typeof PriceType;\n type formsV4Form_universal_d_QuantityLimit = QuantityLimit;\n type formsV4Form_universal_d_FixedPriceOptions = FixedPriceOptions;\n type formsV4Form_universal_d_DynamicPriceOptions = DynamicPriceOptions;\n type formsV4Form_universal_d_Product = Product;\n type formsV4Form_universal_d_ProductPriceOptionsOneOf = ProductPriceOptionsOneOf;\n type formsV4Form_universal_d_MultilineAddressValidation = MultilineAddressValidation;\n type formsV4Form_universal_d_FieldOverrides = FieldOverrides;\n type formsV4Form_universal_d_FieldsOverrides = FieldsOverrides;\n type formsV4Form_universal_d_NestedFormFieldOverrides = NestedFormFieldOverrides;\n type formsV4Form_universal_d_Validation = Validation;\n type formsV4Form_universal_d_ValidationValidationOneOf = ValidationValidationOneOf;\n type formsV4Form_universal_d_DataExtensionsDetails = DataExtensionsDetails;\n type formsV4Form_universal_d_NestedFormOverrides = NestedFormOverrides;\n type formsV4Form_universal_d_FormFieldV2 = FormFieldV2;\n type formsV4Form_universal_d_FormFieldV2FieldTypeOptionsOneOf = FormFieldV2FieldTypeOptionsOneOf;\n type formsV4Form_universal_d_InputFieldStringType = InputFieldStringType;\n type formsV4Form_universal_d_InputFieldStringTypeFormatOptionsOneOf = InputFieldStringTypeFormatOptionsOneOf;\n type formsV4Form_universal_d_FormatEnumFormat = FormatEnumFormat;\n const formsV4Form_universal_d_FormatEnumFormat: typeof FormatEnumFormat;\n type formsV4Form_universal_d_InputFieldStringErrorMessages = InputFieldStringErrorMessages;\n type formsV4Form_universal_d_StringTypeDateTimeConstraints = StringTypeDateTimeConstraints;\n type formsV4Form_universal_d_StringTypePhoneConstraints = StringTypePhoneConstraints;\n type formsV4Form_universal_d_StringComponentType = StringComponentType;\n const formsV4Form_universal_d_StringComponentType: typeof StringComponentType;\n type formsV4Form_universal_d_TextInput = TextInput;\n type formsV4Form_universal_d_RichContent = RichContent;\n type formsV4Form_universal_d_Node = Node;\n type formsV4Form_universal_d_NodeDataOneOf = NodeDataOneOf;\n type formsV4Form_universal_d_NodeType = NodeType;\n const formsV4Form_universal_d_NodeType: typeof NodeType;\n type formsV4Form_universal_d_NodeStyle = NodeStyle;\n type formsV4Form_universal_d_ButtonData = ButtonData;\n type formsV4Form_universal_d_Border = Border;\n type formsV4Form_universal_d_Colors = Colors;\n type formsV4Form_universal_d_PluginContainerData = PluginContainerData;\n type formsV4Form_universal_d_WidthType = WidthType;\n const formsV4Form_universal_d_WidthType: typeof WidthType;\n type formsV4Form_universal_d_PluginContainerDataWidth = PluginContainerDataWidth;\n type formsV4Form_universal_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;\n type formsV4Form_universal_d_PluginContainerDataAlignment = PluginContainerDataAlignment;\n const formsV4Form_universal_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;\n type formsV4Form_universal_d_Spoiler = Spoiler;\n type formsV4Form_universal_d_Height = Height;\n type formsV4Form_universal_d_Type = Type;\n const formsV4Form_universal_d_Type: typeof Type;\n type formsV4Form_universal_d_Styles = Styles;\n type formsV4Form_universal_d_Link = Link;\n type formsV4Form_universal_d_LinkDataOneOf = LinkDataOneOf;\n type formsV4Form_universal_d_LinkTarget = LinkTarget;\n const formsV4Form_universal_d_LinkTarget: typeof LinkTarget;\n type formsV4Form_universal_d_Rel = Rel;\n type formsV4Form_universal_d_CodeBlockData = CodeBlockData;\n type formsV4Form_universal_d_TextStyle = TextStyle;\n type formsV4Form_universal_d_TextAlignment = TextAlignment;\n const formsV4Form_universal_d_TextAlignment: typeof TextAlignment;\n type formsV4Form_universal_d_DividerData = DividerData;\n type formsV4Form_universal_d_LineStyle = LineStyle;\n const formsV4Form_universal_d_LineStyle: typeof LineStyle;\n type formsV4Form_universal_d_Width = Width;\n const formsV4Form_universal_d_Width: typeof Width;\n type formsV4Form_universal_d_Alignment = Alignment;\n const formsV4Form_universal_d_Alignment: typeof Alignment;\n type formsV4Form_universal_d_FileData = FileData;\n type formsV4Form_universal_d_ViewMode = ViewMode;\n const formsV4Form_universal_d_ViewMode: typeof ViewMode;\n type formsV4Form_universal_d_FileSource = FileSource;\n type formsV4Form_universal_d_FileSourceDataOneOf = FileSourceDataOneOf;\n type formsV4Form_universal_d_PDFSettings = PDFSettings;\n type formsV4Form_universal_d_GalleryData = GalleryData;\n type formsV4Form_universal_d_Media = Media;\n type formsV4Form_universal_d_Image = Image;\n type formsV4Form_universal_d_Video = Video;\n type formsV4Form_universal_d_Item = Item;\n type formsV4Form_universal_d_ItemDataOneOf = ItemDataOneOf;\n type formsV4Form_universal_d_GalleryOptions = GalleryOptions;\n type formsV4Form_universal_d_LayoutType = LayoutType;\n const formsV4Form_universal_d_LayoutType: typeof LayoutType;\n type formsV4Form_universal_d_Orientation = Orientation;\n const formsV4Form_universal_d_Orientation: typeof Orientation;\n type formsV4Form_universal_d_Crop = Crop;\n const formsV4Form_universal_d_Crop: typeof Crop;\n type formsV4Form_universal_d_ThumbnailsAlignment = ThumbnailsAlignment;\n const formsV4Form_universal_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;\n type formsV4Form_universal_d_Layout = Layout;\n type formsV4Form_universal_d_ItemStyle = ItemStyle;\n type formsV4Form_universal_d_Thumbnails = Thumbnails;\n type formsV4Form_universal_d_GIFData = GIFData;\n type formsV4Form_universal_d_GIF = GIF;\n type formsV4Form_universal_d_HeadingData = HeadingData;\n type formsV4Form_universal_d_HTMLData = HTMLData;\n type formsV4Form_universal_d_HTMLDataDataOneOf = HTMLDataDataOneOf;\n type formsV4Form_universal_d_Source = Source;\n const formsV4Form_universal_d_Source: typeof Source;\n type formsV4Form_universal_d_ImageData = ImageData;\n type formsV4Form_universal_d_LinkPreviewData = LinkPreviewData;\n type formsV4Form_universal_d_MapData = MapData;\n type formsV4Form_universal_d_MapSettings = MapSettings;\n type formsV4Form_universal_d_MapType = MapType;\n const formsV4Form_universal_d_MapType: typeof MapType;\n type formsV4Form_universal_d_ParagraphData = ParagraphData;\n type formsV4Form_universal_d_PollData = PollData;\n type formsV4Form_universal_d_ViewRole = ViewRole;\n const formsV4Form_universal_d_ViewRole: typeof ViewRole;\n type formsV4Form_universal_d_VoteRole = VoteRole;\n const formsV4Form_universal_d_VoteRole: typeof VoteRole;\n type formsV4Form_universal_d_Permissions = Permissions;\n type formsV4Form_universal_d_PollOption = PollOption;\n type formsV4Form_universal_d_Settings = Settings;\n type formsV4Form_universal_d_PollLayoutType = PollLayoutType;\n const formsV4Form_universal_d_PollLayoutType: typeof PollLayoutType;\n type formsV4Form_universal_d_PollLayoutDirection = PollLayoutDirection;\n const formsV4Form_universal_d_PollLayoutDirection: typeof PollLayoutDirection;\n type formsV4Form_universal_d_PollLayout = PollLayout;\n type formsV4Form_universal_d_OptionLayout = OptionLayout;\n type formsV4Form_universal_d_BackgroundType = BackgroundType;\n const formsV4Form_universal_d_BackgroundType: typeof BackgroundType;\n type formsV4Form_universal_d_Gradient = Gradient;\n type formsV4Form_universal_d_Background = Background;\n type formsV4Form_universal_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;\n type formsV4Form_universal_d_PollDesign = PollDesign;\n type formsV4Form_universal_d_OptionDesign = OptionDesign;\n type formsV4Form_universal_d_Poll = Poll;\n type formsV4Form_universal_d_PollDataLayout = PollDataLayout;\n type formsV4Form_universal_d_Design = Design;\n type formsV4Form_universal_d_TextData = TextData;\n type formsV4Form_universal_d_Decoration = Decoration;\n type formsV4Form_universal_d_DecorationDataOneOf = DecorationDataOneOf;\n type formsV4Form_universal_d_DecorationType = DecorationType;\n const formsV4Form_universal_d_DecorationType: typeof DecorationType;\n type formsV4Form_universal_d_AnchorData = AnchorData;\n type formsV4Form_universal_d_ColorData = ColorData;\n type formsV4Form_universal_d_LinkData = LinkData;\n type formsV4Form_universal_d_MentionData = MentionData;\n type formsV4Form_universal_d_FontSizeData = FontSizeData;\n type formsV4Form_universal_d_FontType = FontType;\n const formsV4Form_universal_d_FontType: typeof FontType;\n type formsV4Form_universal_d_SpoilerData = SpoilerData;\n type formsV4Form_universal_d_AppEmbedData = AppEmbedData;\n type formsV4Form_universal_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;\n type formsV4Form_universal_d_AppType = AppType;\n const formsV4Form_universal_d_AppType: typeof AppType;\n type formsV4Form_universal_d_BookingData = BookingData;\n type formsV4Form_universal_d_EventData = EventData;\n type formsV4Form_universal_d_VideoData = VideoData;\n type formsV4Form_universal_d_PlaybackOptions = PlaybackOptions;\n type formsV4Form_universal_d_EmbedData = EmbedData;\n type formsV4Form_universal_d_Oembed = Oembed;\n type formsV4Form_universal_d_CollapsibleListData = CollapsibleListData;\n type formsV4Form_universal_d_InitialExpandedItems = InitialExpandedItems;\n const formsV4Form_universal_d_InitialExpandedItems: typeof InitialExpandedItems;\n type formsV4Form_universal_d_Direction = Direction;\n const formsV4Form_universal_d_Direction: typeof Direction;\n type formsV4Form_universal_d_TableData = TableData;\n type formsV4Form_universal_d_Dimensions = Dimensions;\n type formsV4Form_universal_d_TableCellData = TableCellData;\n type formsV4Form_universal_d_VerticalAlignment = VerticalAlignment;\n const formsV4Form_universal_d_VerticalAlignment: typeof VerticalAlignment;\n type formsV4Form_universal_d_CellStyle = CellStyle;\n type formsV4Form_universal_d_BorderColors = BorderColors;\n type formsV4Form_universal_d_NullValue = NullValue;\n const formsV4Form_universal_d_NullValue: typeof NullValue;\n type formsV4Form_universal_d_ListValue = ListValue;\n type formsV4Form_universal_d_AudioData = AudioData;\n type formsV4Form_universal_d_OrderedListData = OrderedListData;\n type formsV4Form_universal_d_BulletedListData = BulletedListData;\n type formsV4Form_universal_d_BlockquoteData = BlockquoteData;\n type formsV4Form_universal_d_CaptionData = CaptionData;\n type formsV4Form_universal_d_Metadata = Metadata;\n type formsV4Form_universal_d_DocumentStyle = DocumentStyle;\n type formsV4Form_universal_d_TextNodeStyle = TextNodeStyle;\n type formsV4Form_universal_d_RadioGroup = RadioGroup;\n type formsV4Form_universal_d_RadioGroupOption = RadioGroupOption;\n type formsV4Form_universal_d_RadioGroupCustomOption = RadioGroupCustomOption;\n type formsV4Form_universal_d_NumberOfColumns = NumberOfColumns;\n const formsV4Form_universal_d_NumberOfColumns: typeof NumberOfColumns;\n type formsV4Form_universal_d_Dropdown = Dropdown;\n type formsV4Form_universal_d_DropdownOption = DropdownOption;\n type formsV4Form_universal_d_DropdownCustomOption = DropdownCustomOption;\n type formsV4Form_universal_d_DateTimeInput = DateTimeInput;\n type formsV4Form_universal_d_PhoneInput = PhoneInput;\n type formsV4Form_universal_d_DateInput = DateInput;\n type formsV4Form_universal_d_TimeInput = TimeInput;\n type formsV4Form_universal_d_DatePicker = DatePicker;\n type formsV4Form_universal_d_FirstDayOfWeekEnumFirstDayOfWeek = FirstDayOfWeekEnumFirstDayOfWeek;\n const formsV4Form_universal_d_FirstDayOfWeekEnumFirstDayOfWeek: typeof FirstDayOfWeekEnumFirstDayOfWeek;\n type formsV4Form_universal_d_InputFieldNumberType = InputFieldNumberType;\n type formsV4Form_universal_d_InputFieldNumberErrorMessages = InputFieldNumberErrorMessages;\n type formsV4Form_universal_d_NumberComponentType = NumberComponentType;\n const formsV4Form_universal_d_NumberComponentType: typeof NumberComponentType;\n type formsV4Form_universal_d_NumberInput = NumberInput;\n type formsV4Form_universal_d_RatingInput = RatingInput;\n type formsV4Form_universal_d_InputFieldBooleanType = InputFieldBooleanType;\n type formsV4Form_universal_d_InputFieldBooleanErrorMessages = InputFieldBooleanErrorMessages;\n type formsV4Form_universal_d_BooleanComponentType = BooleanComponentType;\n const formsV4Form_universal_d_BooleanComponentType: typeof BooleanComponentType;\n type formsV4Form_universal_d_Checkbox = Checkbox;\n type formsV4Form_universal_d_InputFieldArrayType = InputFieldArrayType;\n type formsV4Form_universal_d_ItemType = ItemType;\n const formsV4Form_universal_d_ItemType: typeof ItemType;\n type formsV4Form_universal_d_InputFieldIntegerType = InputFieldIntegerType;\n type formsV4Form_universal_d_InputFieldObjectType = InputFieldObjectType;\n type formsV4Form_universal_d_PropertiesTypeEnum = PropertiesTypeEnum;\n const formsV4Form_universal_d_PropertiesTypeEnum: typeof PropertiesTypeEnum;\n type formsV4Form_universal_d_ObjectTypePropertiesType = ObjectTypePropertiesType;\n type formsV4Form_universal_d_ObjectTypePropertiesTypePropertiesTypeOptionsOneOf = ObjectTypePropertiesTypePropertiesTypeOptionsOneOf;\n type formsV4Form_universal_d_InputFieldObjectErrorMessages = InputFieldObjectErrorMessages;\n type formsV4Form_universal_d_ArrayTypeArrayItems = ArrayTypeArrayItems;\n type formsV4Form_universal_d_ArrayTypeArrayItemsItemTypeOptionsOneOf = ArrayTypeArrayItemsItemTypeOptionsOneOf;\n type formsV4Form_universal_d_InputFieldArrayErrorMessages = InputFieldArrayErrorMessages;\n type formsV4Form_universal_d_ComponentType = ComponentType;\n const formsV4Form_universal_d_ComponentType: typeof ComponentType;\n type formsV4Form_universal_d_CheckboxGroup = CheckboxGroup;\n type formsV4Form_universal_d_MediaItem = MediaItem;\n type formsV4Form_universal_d_MediaItemMediaOneOf = MediaItemMediaOneOf;\n type formsV4Form_universal_d_Option = Option;\n type formsV4Form_universal_d_CustomOption = CustomOption;\n type formsV4Form_universal_d_Tags = Tags;\n type formsV4Form_universal_d_TagsOption = TagsOption;\n type formsV4Form_universal_d_CommonCustomOption = CommonCustomOption;\n type formsV4Form_universal_d_WixFileComponentType = WixFileComponentType;\n const formsV4Form_universal_d_WixFileComponentType: typeof WixFileComponentType;\n type formsV4Form_universal_d_FileUpload = FileUpload;\n type formsV4Form_universal_d_UploadFileFormat = UploadFileFormat;\n const formsV4Form_universal_d_UploadFileFormat: typeof UploadFileFormat;\n type formsV4Form_universal_d_Signature = Signature;\n type formsV4Form_universal_d_PaymentComponentType = PaymentComponentType;\n const formsV4Form_universal_d_PaymentComponentType: typeof PaymentComponentType;\n type formsV4Form_universal_d_ProductCheckboxGroup = ProductCheckboxGroup;\n type formsV4Form_universal_d_ProductCheckboxGroupOption = ProductCheckboxGroupOption;\n type formsV4Form_universal_d_ImageFit = ImageFit;\n const formsV4Form_universal_d_ImageFit: typeof ImageFit;\n type formsV4Form_universal_d_DonationInput = DonationInput;\n type formsV4Form_universal_d_DonationInputOption = DonationInputOption;\n type formsV4Form_universal_d_PaymentInput = PaymentInput;\n type formsV4Form_universal_d_FixedPayment = FixedPayment;\n type formsV4Form_universal_d_MultilineAddressComponentType = MultilineAddressComponentType;\n const formsV4Form_universal_d_MultilineAddressComponentType: typeof MultilineAddressComponentType;\n type formsV4Form_universal_d_MultilineAddress = MultilineAddress;\n type formsV4Form_universal_d_DefaultCountryConfigType = DefaultCountryConfigType;\n const formsV4Form_universal_d_DefaultCountryConfigType: typeof DefaultCountryConfigType;\n type formsV4Form_universal_d_AddressLine2 = AddressLine2;\n type formsV4Form_universal_d_DefaultCountryConfig = DefaultCountryConfig;\n type formsV4Form_universal_d_DefaultCountryConfigOptionsOneOf = DefaultCountryConfigOptionsOneOf;\n type formsV4Form_universal_d_FieldsSettings = FieldsSettings;\n type formsV4Form_universal_d_InputType = InputType;\n const formsV4Form_universal_d_InputType: typeof InputType;\n type formsV4Form_universal_d_FormFieldContactInfo = FormFieldContactInfo;\n type formsV4Form_universal_d_FormFieldContactInfoAdditionalInfoOneOf = FormFieldContactInfoAdditionalInfoOneOf;\n type formsV4Form_universal_d_EmailInfoTag = EmailInfoTag;\n const formsV4Form_universal_d_EmailInfoTag: typeof EmailInfoTag;\n type formsV4Form_universal_d_PhoneInfoTag = PhoneInfoTag;\n const formsV4Form_universal_d_PhoneInfoTag: typeof PhoneInfoTag;\n type formsV4Form_universal_d_Tag = Tag;\n const formsV4Form_universal_d_Tag: typeof Tag;\n type formsV4Form_universal_d_OptInLevel = OptInLevel;\n const formsV4Form_universal_d_OptInLevel: typeof OptInLevel;\n type formsV4Form_universal_d_ContactField = ContactField;\n const formsV4Form_universal_d_ContactField: typeof ContactField;\n type formsV4Form_universal_d_EmailInfo = EmailInfo;\n type formsV4Form_universal_d_PhoneInfo = PhoneInfo;\n type formsV4Form_universal_d_AddressInfo = AddressInfo;\n type formsV4Form_universal_d_CustomFieldInfo = CustomFieldInfo;\n type formsV4Form_universal_d_SubscriptionInfo = SubscriptionInfo;\n type formsV4Form_universal_d__String = _String;\n type formsV4Form_universal_d__StringComponentTypeOptionsOneOf = _StringComponentTypeOptionsOneOf;\n type formsV4Form_universal_d__Number = _Number;\n type formsV4Form_universal_d__NumberComponentTypeOptionsOneOf = _NumberComponentTypeOptionsOneOf;\n type formsV4Form_universal_d__Boolean = _Boolean;\n type formsV4Form_universal_d__BooleanComponentTypeOptionsOneOf = _BooleanComponentTypeOptionsOneOf;\n type formsV4Form_universal_d__Array = _Array;\n type formsV4Form_universal_d__ArrayComponentTypeOptionsOneOf = _ArrayComponentTypeOptionsOneOf;\n type formsV4Form_universal_d__Object = _Object;\n type formsV4Form_universal_d__ObjectValidationOneOf = _ObjectValidationOneOf;\n type formsV4Form_universal_d_WixFile = WixFile;\n type formsV4Form_universal_d_WixFileComponentTypeOptionsOneOf = WixFileComponentTypeOptionsOneOf;\n type formsV4Form_universal_d_Payment = Payment;\n type formsV4Form_universal_d_PaymentComponentTypeOptionsOneOf = PaymentComponentTypeOptionsOneOf;\n type formsV4Form_universal_d_InputFieldMultilineAddress = InputFieldMultilineAddress;\n type formsV4Form_universal_d_InputFieldMultilineAddressComponentTypeOptionsOneOf = InputFieldMultilineAddressComponentTypeOptionsOneOf;\n type formsV4Form_universal_d_Target = Target;\n const formsV4Form_universal_d_Target: typeof Target;\n type formsV4Form_universal_d_ThankYouMessage = ThankYouMessage;\n type formsV4Form_universal_d_Redirect = Redirect;\n type formsV4Form_universal_d_FieldType = FieldType;\n const formsV4Form_universal_d_FieldType: typeof FieldType;\n type formsV4Form_universal_d_InputField = InputField;\n type formsV4Form_universal_d_InputFieldInputTypeOptionsOneOf = InputFieldInputTypeOptionsOneOf;\n type formsV4Form_universal_d_DisplayField = DisplayField;\n type formsV4Form_universal_d_DisplayFieldDisplayFieldTypeOptionsOneOf = DisplayFieldDisplayFieldTypeOptionsOneOf;\n type formsV4Form_universal_d_DisplayFieldComponentTypeOneOf = DisplayFieldComponentTypeOneOf;\n type formsV4Form_universal_d_DisplayFieldType = DisplayFieldType;\n const formsV4Form_universal_d_DisplayFieldType: typeof DisplayFieldType;\n type formsV4Form_universal_d_RichContentOptions = RichContentOptions;\n type formsV4Form_universal_d_PageNavigationOptions = PageNavigationOptions;\n type formsV4Form_universal_d_Header = Header;\n type formsV4Form_universal_d_RichText = RichText;\n type formsV4Form_universal_d_SubmitButton = SubmitButton;\n type formsV4Form_universal_d_SubmitButtonSubmitActionOneOf = SubmitButtonSubmitActionOneOf;\n type formsV4Form_universal_d_Step = Step;\n type formsV4Form_universal_d_FormLayout = FormLayout;\n type formsV4Form_universal_d_BreakPoint = BreakPoint;\n type formsV4Form_universal_d_ItemLayout = ItemLayout;\n type formsV4Form_universal_d_ItemLayoutItemOneOf = ItemLayoutItemOneOf;\n type formsV4Form_universal_d_Group = Group;\n type formsV4Form_universal_d_Margin = Margin;\n type formsV4Form_universal_d_Section = Section;\n type formsV4Form_universal_d_FormRule = FormRule;\n type formsV4Form_universal_d_OverrideEntityType = OverrideEntityType;\n const formsV4Form_universal_d_OverrideEntityType: typeof OverrideEntityType;\n type formsV4Form_universal_d_FormOverride = FormOverride;\n type formsV4Form_universal_d_FormProperties = FormProperties;\n type formsV4Form_universal_d_Kind = Kind;\n const formsV4Form_universal_d_Kind: typeof Kind;\n type formsV4Form_universal_d_PostSubmissionTriggers = PostSubmissionTriggers;\n type formsV4Form_universal_d_UpsertContact = UpsertContact;\n type formsV4Form_universal_d_ExtendedFields = ExtendedFields;\n type formsV4Form_universal_d_NestedForm = NestedForm;\n type formsV4Form_universal_d_LimitationRule = LimitationRule;\n type formsV4Form_universal_d_SpamFilterProtectionLevel = SpamFilterProtectionLevel;\n const formsV4Form_universal_d_SpamFilterProtectionLevel: typeof SpamFilterProtectionLevel;\n type formsV4Form_universal_d_RequiredIndicatorProperties = RequiredIndicatorProperties;\n type formsV4Form_universal_d_SubmitSettings = SubmitSettings;\n type formsV4Form_universal_d_SubmitSettingsSubmitSuccessActionOptionsOneOf = SubmitSettingsSubmitSuccessActionOptionsOneOf;\n type formsV4Form_universal_d_UrlTargetEnumTarget = UrlTargetEnumTarget;\n const formsV4Form_universal_d_UrlTargetEnumTarget: typeof UrlTargetEnumTarget;\n type formsV4Form_universal_d_SubmitSuccessAction = SubmitSuccessAction;\n const formsV4Form_universal_d_SubmitSuccessAction: typeof SubmitSuccessAction;\n type formsV4Form_universal_d_ThankYouMessageOptions = ThankYouMessageOptions;\n type formsV4Form_universal_d_RedirectOptions = RedirectOptions;\n type formsV4Form_universal_d_FieldGroup = FieldGroup;\n type formsV4Form_universal_d_PiiFieldsUpdated = PiiFieldsUpdated;\n type formsV4Form_universal_d_FormChanged = FormChanged;\n type formsV4Form_universal_d_FormDeleted = FormDeleted;\n type formsV4Form_universal_d_SubmissionKeysPermanentlyDeleted = SubmissionKeysPermanentlyDeleted;\n type formsV4Form_universal_d_CreateFormRequest = CreateFormRequest;\n type formsV4Form_universal_d_CreateFormResponse = CreateFormResponse;\n type formsV4Form_universal_d_TargetBasedErrorDetails = TargetBasedErrorDetails;\n type formsV4Form_universal_d_FieldIdBasedErrorDetails = FieldIdBasedErrorDetails;\n type formsV4Form_universal_d_StepIdBasedErrorDetails = StepIdBasedErrorDetails;\n type formsV4Form_universal_d_RuleIdBasedErrorDetails = RuleIdBasedErrorDetails;\n type formsV4Form_universal_d_NonExistingNestedFormsErrorDetails = NonExistingNestedFormsErrorDetails;\n type formsV4Form_universal_d_NestedFormFieldsMissingErrorDetails = NestedFormFieldsMissingErrorDetails;\n type formsV4Form_universal_d_FormFieldV2ApiValidationErrorDetails = FormFieldV2ApiValidationErrorDetails;\n type formsV4Form_universal_d_ProductIdBasedErrorDetails = ProductIdBasedErrorDetails;\n type formsV4Form_universal_d_BulkCreateFormRequest = BulkCreateFormRequest;\n type formsV4Form_universal_d_BulkCreateFormResponse = BulkCreateFormResponse;\n type formsV4Form_universal_d_BulkFormResult = BulkFormResult;\n type formsV4Form_universal_d_ItemMetadata = ItemMetadata;\n type formsV4Form_universal_d_ApplicationError = ApplicationError;\n type formsV4Form_universal_d_BulkActionMetadata = BulkActionMetadata;\n type formsV4Form_universal_d_CloneFormRequest = CloneFormRequest;\n type formsV4Form_universal_d_CloneFormResponse = CloneFormResponse;\n type formsV4Form_universal_d_CloneFormFromTemplateRequest = CloneFormFromTemplateRequest;\n type formsV4Form_universal_d_CloneFormFromTemplateResponse = CloneFormFromTemplateResponse;\n type formsV4Form_universal_d_GetFormRequest = GetFormRequest;\n type formsV4Form_universal_d_Fieldset = Fieldset;\n const formsV4Form_universal_d_Fieldset: typeof Fieldset;\n type formsV4Form_universal_d_GetFormResponse = GetFormResponse;\n type formsV4Form_universal_d_UpdateFormRequest = UpdateFormRequest;\n type formsV4Form_universal_d_UpdateFormResponse = UpdateFormResponse;\n type formsV4Form_universal_d_RemoveFormFromTrashBinRequest = RemoveFormFromTrashBinRequest;\n type formsV4Form_universal_d_RemoveFormFromTrashBinResponse = RemoveFormFromTrashBinResponse;\n type formsV4Form_universal_d_DeleteFormRequest = DeleteFormRequest;\n type formsV4Form_universal_d_DeleteFormResponse = DeleteFormResponse;\n type formsV4Form_universal_d_RestoreFromTrashBinRequest = RestoreFromTrashBinRequest;\n type formsV4Form_universal_d_RestoreFromTrashBinResponse = RestoreFromTrashBinResponse;\n type formsV4Form_universal_d_QueryFormsRequest = QueryFormsRequest;\n type formsV4Form_universal_d_CursorQuery = CursorQuery;\n type formsV4Form_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type formsV4Form_universal_d_Sorting = Sorting;\n type formsV4Form_universal_d_SortOrder = SortOrder;\n const formsV4Form_universal_d_SortOrder: typeof SortOrder;\n type formsV4Form_universal_d_CommonCursorPaging = CommonCursorPaging;\n type formsV4Form_universal_d_QueryFormsResponse = QueryFormsResponse;\n type formsV4Form_universal_d_CommonCursorPagingMetadata = CommonCursorPagingMetadata;\n type formsV4Form_universal_d_CommonCursors = CommonCursors;\n type formsV4Form_universal_d_CountFormsRequest = CountFormsRequest;\n type formsV4Form_universal_d_CountFormsFieldset = CountFormsFieldset;\n const formsV4Form_universal_d_CountFormsFieldset: typeof CountFormsFieldset;\n type formsV4Form_universal_d_CountFormsResponse = CountFormsResponse;\n type formsV4Form_universal_d_ListTemplateExtensionsRequest = ListTemplateExtensionsRequest;\n type formsV4Form_universal_d_ListFormsOrderEnumListFormsOrder = ListFormsOrderEnumListFormsOrder;\n const formsV4Form_universal_d_ListFormsOrderEnumListFormsOrder: typeof ListFormsOrderEnumListFormsOrder;\n type formsV4Form_universal_d_NameFilter = NameFilter;\n type formsV4Form_universal_d_FilterType = FilterType;\n const formsV4Form_universal_d_FilterType: typeof FilterType;\n type formsV4Form_universal_d_ListTemplateExtensionsResponse = ListTemplateExtensionsResponse;\n type formsV4Form_universal_d_ListFormsRequest = ListFormsRequest;\n type formsV4Form_universal_d_ListFormsOrder = ListFormsOrder;\n const formsV4Form_universal_d_ListFormsOrder: typeof ListFormsOrder;\n type formsV4Form_universal_d_ListFormsResponse = ListFormsResponse;\n type formsV4Form_universal_d_GetDeletedFormRequest = GetDeletedFormRequest;\n type formsV4Form_universal_d_GetDeletedFormResponse = GetDeletedFormResponse;\n type formsV4Form_universal_d_QueryDeletedFormsRequest = QueryDeletedFormsRequest;\n type formsV4Form_universal_d_QueryDeletedFormsResponse = QueryDeletedFormsResponse;\n type formsV4Form_universal_d_ListDeletedFormsRequest = ListDeletedFormsRequest;\n type formsV4Form_universal_d_ListDeletedFormsOrder = ListDeletedFormsOrder;\n const formsV4Form_universal_d_ListDeletedFormsOrder: typeof ListDeletedFormsOrder;\n type formsV4Form_universal_d_ListDeletedFormsResponse = ListDeletedFormsResponse;\n type formsV4Form_universal_d_BulkRemoveDeletedFieldRequest = BulkRemoveDeletedFieldRequest;\n type formsV4Form_universal_d_BulkRemoveDeletedFieldResponse = BulkRemoveDeletedFieldResponse;\n type formsV4Form_universal_d_UpdateExtendedFieldsRequest = UpdateExtendedFieldsRequest;\n type formsV4Form_universal_d_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;\n type formsV4Form_universal_d_ListFormsProvidersConfigsRequest = ListFormsProvidersConfigsRequest;\n type formsV4Form_universal_d_ListFormsProvidersConfigsResponse = ListFormsProvidersConfigsResponse;\n type formsV4Form_universal_d_FormsSchemaProvidersConfig = FormsSchemaProvidersConfig;\n type formsV4Form_universal_d_FormProviderRestrictions = FormProviderRestrictions;\n type formsV4Form_universal_d_DomainEvent = DomainEvent;\n type formsV4Form_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type formsV4Form_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type formsV4Form_universal_d_RestoreInfo = RestoreInfo;\n type formsV4Form_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type formsV4Form_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type formsV4Form_universal_d_ActionEvent = ActionEvent;\n type formsV4Form_universal_d_Empty = Empty;\n type formsV4Form_universal_d_GetFormSummaryRequest = GetFormSummaryRequest;\n type formsV4Form_universal_d_GetFormSummaryResponse = GetFormSummaryResponse;\n type formsV4Form_universal_d_FormSummary = FormSummary;\n type formsV4Form_universal_d_FieldInputType = FieldInputType;\n const formsV4Form_universal_d_FieldInputType: typeof FieldInputType;\n type formsV4Form_universal_d_FieldOption = FieldOption;\n type formsV4Form_universal_d_Field = Field;\n type formsV4Form_universal_d_MessageEnvelope = MessageEnvelope;\n type formsV4Form_universal_d_IdentificationData = IdentificationData;\n type formsV4Form_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type formsV4Form_universal_d_WebhookIdentityType = WebhookIdentityType;\n const formsV4Form_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const formsV4Form_universal_d_createForm: typeof createForm;\n const formsV4Form_universal_d_bulkCreateForm: typeof bulkCreateForm;\n type formsV4Form_universal_d_BulkCreateFormOptions = BulkCreateFormOptions;\n const formsV4Form_universal_d_cloneForm: typeof cloneForm;\n const formsV4Form_universal_d_cloneFormFromTemplate: typeof cloneFormFromTemplate;\n type formsV4Form_universal_d_CloneFormFromTemplateOptions = CloneFormFromTemplateOptions;\n const formsV4Form_universal_d_getForm: typeof getForm;\n type formsV4Form_universal_d_GetFormOptions = GetFormOptions;\n const formsV4Form_universal_d_updateForm: typeof updateForm;\n type formsV4Form_universal_d_UpdateForm = UpdateForm;\n type formsV4Form_universal_d_UpdateFormOptions = UpdateFormOptions;\n const formsV4Form_universal_d_removeFormFromTrashBin: typeof removeFormFromTrashBin;\n const formsV4Form_universal_d_deleteForm: typeof deleteForm;\n type formsV4Form_universal_d_DeleteFormOptions = DeleteFormOptions;\n const formsV4Form_universal_d_restoreFromTrashBin: typeof restoreFromTrashBin;\n const formsV4Form_universal_d_queryForms: typeof queryForms;\n type formsV4Form_universal_d_QueryFormsOptions = QueryFormsOptions;\n type formsV4Form_universal_d_FormsQueryResult = FormsQueryResult;\n type formsV4Form_universal_d_FormsQueryBuilder = FormsQueryBuilder;\n const formsV4Form_universal_d_countForms: typeof countForms;\n type formsV4Form_universal_d_CountFormsOptions = CountFormsOptions;\n const formsV4Form_universal_d_listTemplateExtensions: typeof listTemplateExtensions;\n type formsV4Form_universal_d_ListTemplateExtensionsOptions = ListTemplateExtensionsOptions;\n const formsV4Form_universal_d_listForms: typeof listForms;\n type formsV4Form_universal_d_ListFormsOptions = ListFormsOptions;\n const formsV4Form_universal_d_getDeletedForm: typeof getDeletedForm;\n const formsV4Form_universal_d_queryDeletedForms: typeof queryDeletedForms;\n const formsV4Form_universal_d_listDeletedForms: typeof listDeletedForms;\n type formsV4Form_universal_d_ListDeletedFormsOptions = ListDeletedFormsOptions;\n const formsV4Form_universal_d_bulkRemoveDeletedField: typeof bulkRemoveDeletedField;\n type formsV4Form_universal_d_BulkRemoveDeletedFieldOptions = BulkRemoveDeletedFieldOptions;\n const formsV4Form_universal_d_updateExtendedFields: typeof updateExtendedFields;\n type formsV4Form_universal_d_UpdateExtendedFieldsOptions = UpdateExtendedFieldsOptions;\n const formsV4Form_universal_d_listFormsProvidersConfigs: typeof listFormsProvidersConfigs;\n const formsV4Form_universal_d_getFormSummary: typeof getFormSummary;\n namespace formsV4Form_universal_d {\n export {\n formsV4Form_universal_d_Form as Form,\n formsV4Form_universal_d_RequiredIndicator as RequiredIndicator,\n formsV4Form_universal_d_RequiredIndicatorPlacement as RequiredIndicatorPlacement,\n formsV4Form_universal_d_FormField as FormField,\n formsV4Form_universal_d_StringType as StringType,\n formsV4Form_universal_d_StringTypeFormatOptionsOneOf as StringTypeFormatOptionsOneOf,\n formsV4Form_universal_d_Format as Format,\n formsV4Form_universal_d_StringErrorMessages as StringErrorMessages,\n formsV4Form_universal_d_DateTimeConstraints as DateTimeConstraints,\n formsV4Form_universal_d_PhoneConstraints as PhoneConstraints,\n formsV4Form_universal_d_NumberType as NumberType,\n formsV4Form_universal_d_NumberErrorMessages as NumberErrorMessages,\n formsV4Form_universal_d_IntegerType as IntegerType,\n formsV4Form_universal_d_BooleanType as BooleanType,\n formsV4Form_universal_d_BooleanErrorMessages as BooleanErrorMessages,\n formsV4Form_universal_d_ArrayType as ArrayType,\n formsV4Form_universal_d_ObjectType as ObjectType,\n formsV4Form_universal_d_PropertiesType as PropertiesType,\n formsV4Form_universal_d_PropertiesTypePropertiesTypeOneOf as PropertiesTypePropertiesTypeOneOf,\n formsV4Form_universal_d_ObjectErrorMessages as ObjectErrorMessages,\n formsV4Form_universal_d_ArrayItems as ArrayItems,\n formsV4Form_universal_d_ArrayItemsItemsOneOf as ArrayItemsItemsOneOf,\n formsV4Form_universal_d_ArrayErrorMessages as ArrayErrorMessages,\n formsV4Form_universal_d_PredefinedValidation as PredefinedValidation,\n formsV4Form_universal_d_PredefinedValidationFormatOptionsOneOf as PredefinedValidationFormatOptionsOneOf,\n formsV4Form_universal_d_ValidationFormat as ValidationFormat,\n formsV4Form_universal_d_PaymentType as PaymentType,\n formsV4Form_universal_d_ProductType as ProductType,\n formsV4Form_universal_d_PriceType as PriceType,\n formsV4Form_universal_d_QuantityLimit as QuantityLimit,\n formsV4Form_universal_d_FixedPriceOptions as FixedPriceOptions,\n formsV4Form_universal_d_DynamicPriceOptions as DynamicPriceOptions,\n formsV4Form_universal_d_Product as Product,\n formsV4Form_universal_d_ProductPriceOptionsOneOf as ProductPriceOptionsOneOf,\n formsV4Form_universal_d_MultilineAddressValidation as MultilineAddressValidation,\n formsV4Form_universal_d_FieldOverrides as FieldOverrides,\n formsV4Form_universal_d_FieldsOverrides as FieldsOverrides,\n formsV4Form_universal_d_NestedFormFieldOverrides as NestedFormFieldOverrides,\n formsV4Form_universal_d_Validation as Validation,\n formsV4Form_universal_d_ValidationValidationOneOf as ValidationValidationOneOf,\n formsV4Form_universal_d_DataExtensionsDetails as DataExtensionsDetails,\n formsV4Form_universal_d_NestedFormOverrides as NestedFormOverrides,\n formsV4Form_universal_d_FormFieldV2 as FormFieldV2,\n formsV4Form_universal_d_FormFieldV2FieldTypeOptionsOneOf as FormFieldV2FieldTypeOptionsOneOf,\n formsV4Form_universal_d_InputFieldStringType as InputFieldStringType,\n formsV4Form_universal_d_InputFieldStringTypeFormatOptionsOneOf as InputFieldStringTypeFormatOptionsOneOf,\n formsV4Form_universal_d_FormatEnumFormat as FormatEnumFormat,\n formsV4Form_universal_d_InputFieldStringErrorMessages as InputFieldStringErrorMessages,\n formsV4Form_universal_d_StringTypeDateTimeConstraints as StringTypeDateTimeConstraints,\n formsV4Form_universal_d_StringTypePhoneConstraints as StringTypePhoneConstraints,\n formsV4Form_universal_d_StringComponentType as StringComponentType,\n formsV4Form_universal_d_TextInput as TextInput,\n formsV4Form_universal_d_RichContent as RichContent,\n formsV4Form_universal_d_Node as Node,\n formsV4Form_universal_d_NodeDataOneOf as NodeDataOneOf,\n formsV4Form_universal_d_NodeType as NodeType,\n formsV4Form_universal_d_NodeStyle as NodeStyle,\n formsV4Form_universal_d_ButtonData as ButtonData,\n formsV4Form_universal_d_Border as Border,\n formsV4Form_universal_d_Colors as Colors,\n formsV4Form_universal_d_PluginContainerData as PluginContainerData,\n formsV4Form_universal_d_WidthType as WidthType,\n formsV4Form_universal_d_PluginContainerDataWidth as PluginContainerDataWidth,\n formsV4Form_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf,\n formsV4Form_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment,\n formsV4Form_universal_d_Spoiler as Spoiler,\n formsV4Form_universal_d_Height as Height,\n formsV4Form_universal_d_Type as Type,\n formsV4Form_universal_d_Styles as Styles,\n formsV4Form_universal_d_Link as Link,\n formsV4Form_universal_d_LinkDataOneOf as LinkDataOneOf,\n formsV4Form_universal_d_LinkTarget as LinkTarget,\n formsV4Form_universal_d_Rel as Rel,\n formsV4Form_universal_d_CodeBlockData as CodeBlockData,\n formsV4Form_universal_d_TextStyle as TextStyle,\n formsV4Form_universal_d_TextAlignment as TextAlignment,\n formsV4Form_universal_d_DividerData as DividerData,\n formsV4Form_universal_d_LineStyle as LineStyle,\n formsV4Form_universal_d_Width as Width,\n formsV4Form_universal_d_Alignment as Alignment,\n formsV4Form_universal_d_FileData as FileData,\n formsV4Form_universal_d_ViewMode as ViewMode,\n formsV4Form_universal_d_FileSource as FileSource,\n formsV4Form_universal_d_FileSourceDataOneOf as FileSourceDataOneOf,\n formsV4Form_universal_d_PDFSettings as PDFSettings,\n formsV4Form_universal_d_GalleryData as GalleryData,\n formsV4Form_universal_d_Media as Media,\n formsV4Form_universal_d_Image as Image,\n formsV4Form_universal_d_Video as Video,\n formsV4Form_universal_d_Item as Item,\n formsV4Form_universal_d_ItemDataOneOf as ItemDataOneOf,\n formsV4Form_universal_d_GalleryOptions as GalleryOptions,\n formsV4Form_universal_d_LayoutType as LayoutType,\n formsV4Form_universal_d_Orientation as Orientation,\n formsV4Form_universal_d_Crop as Crop,\n formsV4Form_universal_d_ThumbnailsAlignment as ThumbnailsAlignment,\n formsV4Form_universal_d_Layout as Layout,\n formsV4Form_universal_d_ItemStyle as ItemStyle,\n formsV4Form_universal_d_Thumbnails as Thumbnails,\n formsV4Form_universal_d_GIFData as GIFData,\n formsV4Form_universal_d_GIF as GIF,\n formsV4Form_universal_d_HeadingData as HeadingData,\n formsV4Form_universal_d_HTMLData as HTMLData,\n formsV4Form_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf,\n formsV4Form_universal_d_Source as Source,\n formsV4Form_universal_d_ImageData as ImageData,\n formsV4Form_universal_d_LinkPreviewData as LinkPreviewData,\n formsV4Form_universal_d_MapData as MapData,\n formsV4Form_universal_d_MapSettings as MapSettings,\n formsV4Form_universal_d_MapType as MapType,\n formsV4Form_universal_d_ParagraphData as ParagraphData,\n formsV4Form_universal_d_PollData as PollData,\n formsV4Form_universal_d_ViewRole as ViewRole,\n formsV4Form_universal_d_VoteRole as VoteRole,\n formsV4Form_universal_d_Permissions as Permissions,\n formsV4Form_universal_d_PollOption as PollOption,\n formsV4Form_universal_d_Settings as Settings,\n formsV4Form_universal_d_PollLayoutType as PollLayoutType,\n formsV4Form_universal_d_PollLayoutDirection as PollLayoutDirection,\n formsV4Form_universal_d_PollLayout as PollLayout,\n formsV4Form_universal_d_OptionLayout as OptionLayout,\n formsV4Form_universal_d_BackgroundType as BackgroundType,\n formsV4Form_universal_d_Gradient as Gradient,\n formsV4Form_universal_d_Background as Background,\n formsV4Form_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf,\n formsV4Form_universal_d_PollDesign as PollDesign,\n formsV4Form_universal_d_OptionDesign as OptionDesign,\n formsV4Form_universal_d_Poll as Poll,\n formsV4Form_universal_d_PollDataLayout as PollDataLayout,\n formsV4Form_universal_d_Design as Design,\n formsV4Form_universal_d_TextData as TextData,\n formsV4Form_universal_d_Decoration as Decoration,\n formsV4Form_universal_d_DecorationDataOneOf as DecorationDataOneOf,\n formsV4Form_universal_d_DecorationType as DecorationType,\n formsV4Form_universal_d_AnchorData as AnchorData,\n formsV4Form_universal_d_ColorData as ColorData,\n formsV4Form_universal_d_LinkData as LinkData,\n formsV4Form_universal_d_MentionData as MentionData,\n formsV4Form_universal_d_FontSizeData as FontSizeData,\n formsV4Form_universal_d_FontType as FontType,\n formsV4Form_universal_d_SpoilerData as SpoilerData,\n formsV4Form_universal_d_AppEmbedData as AppEmbedData,\n formsV4Form_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf,\n formsV4Form_universal_d_AppType as AppType,\n formsV4Form_universal_d_BookingData as BookingData,\n formsV4Form_universal_d_EventData as EventData,\n formsV4Form_universal_d_VideoData as VideoData,\n formsV4Form_universal_d_PlaybackOptions as PlaybackOptions,\n formsV4Form_universal_d_EmbedData as EmbedData,\n formsV4Form_universal_d_Oembed as Oembed,\n formsV4Form_universal_d_CollapsibleListData as CollapsibleListData,\n formsV4Form_universal_d_InitialExpandedItems as InitialExpandedItems,\n formsV4Form_universal_d_Direction as Direction,\n formsV4Form_universal_d_TableData as TableData,\n formsV4Form_universal_d_Dimensions as Dimensions,\n formsV4Form_universal_d_TableCellData as TableCellData,\n formsV4Form_universal_d_VerticalAlignment as VerticalAlignment,\n formsV4Form_universal_d_CellStyle as CellStyle,\n formsV4Form_universal_d_BorderColors as BorderColors,\n formsV4Form_universal_d_NullValue as NullValue,\n formsV4Form_universal_d_ListValue as ListValue,\n formsV4Form_universal_d_AudioData as AudioData,\n formsV4Form_universal_d_OrderedListData as OrderedListData,\n formsV4Form_universal_d_BulletedListData as BulletedListData,\n formsV4Form_universal_d_BlockquoteData as BlockquoteData,\n formsV4Form_universal_d_CaptionData as CaptionData,\n formsV4Form_universal_d_Metadata as Metadata,\n formsV4Form_universal_d_DocumentStyle as DocumentStyle,\n formsV4Form_universal_d_TextNodeStyle as TextNodeStyle,\n formsV4Form_universal_d_RadioGroup as RadioGroup,\n formsV4Form_universal_d_RadioGroupOption as RadioGroupOption,\n formsV4Form_universal_d_RadioGroupCustomOption as RadioGroupCustomOption,\n formsV4Form_universal_d_NumberOfColumns as NumberOfColumns,\n formsV4Form_universal_d_Dropdown as Dropdown,\n formsV4Form_universal_d_DropdownOption as DropdownOption,\n formsV4Form_universal_d_DropdownCustomOption as DropdownCustomOption,\n formsV4Form_universal_d_DateTimeInput as DateTimeInput,\n formsV4Form_universal_d_PhoneInput as PhoneInput,\n formsV4Form_universal_d_DateInput as DateInput,\n formsV4Form_universal_d_TimeInput as TimeInput,\n formsV4Form_universal_d_DatePicker as DatePicker,\n formsV4Form_universal_d_FirstDayOfWeekEnumFirstDayOfWeek as FirstDayOfWeekEnumFirstDayOfWeek,\n formsV4Form_universal_d_InputFieldNumberType as InputFieldNumberType,\n formsV4Form_universal_d_InputFieldNumberErrorMessages as InputFieldNumberErrorMessages,\n formsV4Form_universal_d_NumberComponentType as NumberComponentType,\n formsV4Form_universal_d_NumberInput as NumberInput,\n formsV4Form_universal_d_RatingInput as RatingInput,\n formsV4Form_universal_d_InputFieldBooleanType as InputFieldBooleanType,\n formsV4Form_universal_d_InputFieldBooleanErrorMessages as InputFieldBooleanErrorMessages,\n formsV4Form_universal_d_BooleanComponentType as BooleanComponentType,\n formsV4Form_universal_d_Checkbox as Checkbox,\n formsV4Form_universal_d_InputFieldArrayType as InputFieldArrayType,\n formsV4Form_universal_d_ItemType as ItemType,\n formsV4Form_universal_d_InputFieldIntegerType as InputFieldIntegerType,\n formsV4Form_universal_d_InputFieldObjectType as InputFieldObjectType,\n formsV4Form_universal_d_PropertiesTypeEnum as PropertiesTypeEnum,\n formsV4Form_universal_d_ObjectTypePropertiesType as ObjectTypePropertiesType,\n formsV4Form_universal_d_ObjectTypePropertiesTypePropertiesTypeOptionsOneOf as ObjectTypePropertiesTypePropertiesTypeOptionsOneOf,\n formsV4Form_universal_d_InputFieldObjectErrorMessages as InputFieldObjectErrorMessages,\n formsV4Form_universal_d_ArrayTypeArrayItems as ArrayTypeArrayItems,\n formsV4Form_universal_d_ArrayTypeArrayItemsItemTypeOptionsOneOf as ArrayTypeArrayItemsItemTypeOptionsOneOf,\n formsV4Form_universal_d_InputFieldArrayErrorMessages as InputFieldArrayErrorMessages,\n formsV4Form_universal_d_ComponentType as ComponentType,\n formsV4Form_universal_d_CheckboxGroup as CheckboxGroup,\n formsV4Form_universal_d_MediaItem as MediaItem,\n formsV4Form_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf,\n formsV4Form_universal_d_Option as Option,\n formsV4Form_universal_d_CustomOption as CustomOption,\n formsV4Form_universal_d_Tags as Tags,\n formsV4Form_universal_d_TagsOption as TagsOption,\n formsV4Form_universal_d_CommonCustomOption as CommonCustomOption,\n formsV4Form_universal_d_WixFileComponentType as WixFileComponentType,\n formsV4Form_universal_d_FileUpload as FileUpload,\n formsV4Form_universal_d_UploadFileFormat as UploadFileFormat,\n formsV4Form_universal_d_Signature as Signature,\n formsV4Form_universal_d_PaymentComponentType as PaymentComponentType,\n formsV4Form_universal_d_ProductCheckboxGroup as ProductCheckboxGroup,\n formsV4Form_universal_d_ProductCheckboxGroupOption as ProductCheckboxGroupOption,\n formsV4Form_universal_d_ImageFit as ImageFit,\n formsV4Form_universal_d_DonationInput as DonationInput,\n formsV4Form_universal_d_DonationInputOption as DonationInputOption,\n formsV4Form_universal_d_PaymentInput as PaymentInput,\n formsV4Form_universal_d_FixedPayment as FixedPayment,\n formsV4Form_universal_d_MultilineAddressComponentType as MultilineAddressComponentType,\n formsV4Form_universal_d_MultilineAddress as MultilineAddress,\n formsV4Form_universal_d_DefaultCountryConfigType as DefaultCountryConfigType,\n formsV4Form_universal_d_AddressLine2 as AddressLine2,\n formsV4Form_universal_d_DefaultCountryConfig as DefaultCountryConfig,\n formsV4Form_universal_d_DefaultCountryConfigOptionsOneOf as DefaultCountryConfigOptionsOneOf,\n formsV4Form_universal_d_FieldsSettings as FieldsSettings,\n formsV4Form_universal_d_InputType as InputType,\n formsV4Form_universal_d_FormFieldContactInfo as FormFieldContactInfo,\n formsV4Form_universal_d_FormFieldContactInfoAdditionalInfoOneOf as FormFieldContactInfoAdditionalInfoOneOf,\n formsV4Form_universal_d_EmailInfoTag as EmailInfoTag,\n formsV4Form_universal_d_PhoneInfoTag as PhoneInfoTag,\n formsV4Form_universal_d_Tag as Tag,\n formsV4Form_universal_d_OptInLevel as OptInLevel,\n formsV4Form_universal_d_ContactField as ContactField,\n formsV4Form_universal_d_EmailInfo as EmailInfo,\n formsV4Form_universal_d_PhoneInfo as PhoneInfo,\n formsV4Form_universal_d_AddressInfo as AddressInfo,\n formsV4Form_universal_d_CustomFieldInfo as CustomFieldInfo,\n formsV4Form_universal_d_SubscriptionInfo as SubscriptionInfo,\n formsV4Form_universal_d__String as _String,\n formsV4Form_universal_d__StringComponentTypeOptionsOneOf as _StringComponentTypeOptionsOneOf,\n formsV4Form_universal_d__Number as _Number,\n formsV4Form_universal_d__NumberComponentTypeOptionsOneOf as _NumberComponentTypeOptionsOneOf,\n formsV4Form_universal_d__Boolean as _Boolean,\n formsV4Form_universal_d__BooleanComponentTypeOptionsOneOf as _BooleanComponentTypeOptionsOneOf,\n formsV4Form_universal_d__Array as _Array,\n formsV4Form_universal_d__ArrayComponentTypeOptionsOneOf as _ArrayComponentTypeOptionsOneOf,\n formsV4Form_universal_d__Object as _Object,\n formsV4Form_universal_d__ObjectValidationOneOf as _ObjectValidationOneOf,\n formsV4Form_universal_d_WixFile as WixFile,\n formsV4Form_universal_d_WixFileComponentTypeOptionsOneOf as WixFileComponentTypeOptionsOneOf,\n formsV4Form_universal_d_Payment as Payment,\n formsV4Form_universal_d_PaymentComponentTypeOptionsOneOf as PaymentComponentTypeOptionsOneOf,\n formsV4Form_universal_d_InputFieldMultilineAddress as InputFieldMultilineAddress,\n formsV4Form_universal_d_InputFieldMultilineAddressComponentTypeOptionsOneOf as InputFieldMultilineAddressComponentTypeOptionsOneOf,\n formsV4Form_universal_d_Target as Target,\n formsV4Form_universal_d_ThankYouMessage as ThankYouMessage,\n formsV4Form_universal_d_Redirect as Redirect,\n formsV4Form_universal_d_FieldType as FieldType,\n formsV4Form_universal_d_InputField as InputField,\n formsV4Form_universal_d_InputFieldInputTypeOptionsOneOf as InputFieldInputTypeOptionsOneOf,\n formsV4Form_universal_d_DisplayField as DisplayField,\n formsV4Form_universal_d_DisplayFieldDisplayFieldTypeOptionsOneOf as DisplayFieldDisplayFieldTypeOptionsOneOf,\n formsV4Form_universal_d_DisplayFieldComponentTypeOneOf as DisplayFieldComponentTypeOneOf,\n formsV4Form_universal_d_DisplayFieldType as DisplayFieldType,\n formsV4Form_universal_d_RichContentOptions as RichContentOptions,\n formsV4Form_universal_d_PageNavigationOptions as PageNavigationOptions,\n formsV4Form_universal_d_Header as Header,\n formsV4Form_universal_d_RichText as RichText,\n formsV4Form_universal_d_SubmitButton as SubmitButton,\n formsV4Form_universal_d_SubmitButtonSubmitActionOneOf as SubmitButtonSubmitActionOneOf,\n formsV4Form_universal_d_Step as Step,\n formsV4Form_universal_d_FormLayout as FormLayout,\n formsV4Form_universal_d_BreakPoint as BreakPoint,\n formsV4Form_universal_d_ItemLayout as ItemLayout,\n formsV4Form_universal_d_ItemLayoutItemOneOf as ItemLayoutItemOneOf,\n formsV4Form_universal_d_Group as Group,\n formsV4Form_universal_d_Margin as Margin,\n formsV4Form_universal_d_Section as Section,\n formsV4Form_universal_d_FormRule as FormRule,\n formsV4Form_universal_d_OverrideEntityType as OverrideEntityType,\n formsV4Form_universal_d_FormOverride as FormOverride,\n formsV4Form_universal_d_FormProperties as FormProperties,\n formsV4Form_universal_d_Kind as Kind,\n formsV4Form_universal_d_PostSubmissionTriggers as PostSubmissionTriggers,\n formsV4Form_universal_d_UpsertContact as UpsertContact,\n formsV4Form_universal_d_ExtendedFields as ExtendedFields,\n formsV4Form_universal_d_NestedForm as NestedForm,\n formsV4Form_universal_d_LimitationRule as LimitationRule,\n formsV4Form_universal_d_SpamFilterProtectionLevel as SpamFilterProtectionLevel,\n formsV4Form_universal_d_RequiredIndicatorProperties as RequiredIndicatorProperties,\n formsV4Form_universal_d_SubmitSettings as SubmitSettings,\n formsV4Form_universal_d_SubmitSettingsSubmitSuccessActionOptionsOneOf as SubmitSettingsSubmitSuccessActionOptionsOneOf,\n formsV4Form_universal_d_UrlTargetEnumTarget as UrlTargetEnumTarget,\n formsV4Form_universal_d_SubmitSuccessAction as SubmitSuccessAction,\n formsV4Form_universal_d_ThankYouMessageOptions as ThankYouMessageOptions,\n formsV4Form_universal_d_RedirectOptions as RedirectOptions,\n formsV4Form_universal_d_FieldGroup as FieldGroup,\n formsV4Form_universal_d_PiiFieldsUpdated as PiiFieldsUpdated,\n formsV4Form_universal_d_FormChanged as FormChanged,\n formsV4Form_universal_d_FormDeleted as FormDeleted,\n formsV4Form_universal_d_SubmissionKeysPermanentlyDeleted as SubmissionKeysPermanentlyDeleted,\n formsV4Form_universal_d_CreateFormRequest as CreateFormRequest,\n formsV4Form_universal_d_CreateFormResponse as CreateFormResponse,\n formsV4Form_universal_d_TargetBasedErrorDetails as TargetBasedErrorDetails,\n formsV4Form_universal_d_FieldIdBasedErrorDetails as FieldIdBasedErrorDetails,\n formsV4Form_universal_d_StepIdBasedErrorDetails as StepIdBasedErrorDetails,\n formsV4Form_universal_d_RuleIdBasedErrorDetails as RuleIdBasedErrorDetails,\n formsV4Form_universal_d_NonExistingNestedFormsErrorDetails as NonExistingNestedFormsErrorDetails,\n formsV4Form_universal_d_NestedFormFieldsMissingErrorDetails as NestedFormFieldsMissingErrorDetails,\n formsV4Form_universal_d_FormFieldV2ApiValidationErrorDetails as FormFieldV2ApiValidationErrorDetails,\n formsV4Form_universal_d_ProductIdBasedErrorDetails as ProductIdBasedErrorDetails,\n formsV4Form_universal_d_BulkCreateFormRequest as BulkCreateFormRequest,\n formsV4Form_universal_d_BulkCreateFormResponse as BulkCreateFormResponse,\n formsV4Form_universal_d_BulkFormResult as BulkFormResult,\n formsV4Form_universal_d_ItemMetadata as ItemMetadata,\n formsV4Form_universal_d_ApplicationError as ApplicationError,\n formsV4Form_universal_d_BulkActionMetadata as BulkActionMetadata,\n formsV4Form_universal_d_CloneFormRequest as CloneFormRequest,\n formsV4Form_universal_d_CloneFormResponse as CloneFormResponse,\n formsV4Form_universal_d_CloneFormFromTemplateRequest as CloneFormFromTemplateRequest,\n formsV4Form_universal_d_CloneFormFromTemplateResponse as CloneFormFromTemplateResponse,\n formsV4Form_universal_d_GetFormRequest as GetFormRequest,\n formsV4Form_universal_d_Fieldset as Fieldset,\n formsV4Form_universal_d_GetFormResponse as GetFormResponse,\n formsV4Form_universal_d_UpdateFormRequest as UpdateFormRequest,\n formsV4Form_universal_d_UpdateFormResponse as UpdateFormResponse,\n formsV4Form_universal_d_RemoveFormFromTrashBinRequest as RemoveFormFromTrashBinRequest,\n formsV4Form_universal_d_RemoveFormFromTrashBinResponse as RemoveFormFromTrashBinResponse,\n formsV4Form_universal_d_DeleteFormRequest as DeleteFormRequest,\n formsV4Form_universal_d_DeleteFormResponse as DeleteFormResponse,\n formsV4Form_universal_d_RestoreFromTrashBinRequest as RestoreFromTrashBinRequest,\n formsV4Form_universal_d_RestoreFromTrashBinResponse as RestoreFromTrashBinResponse,\n formsV4Form_universal_d_QueryFormsRequest as QueryFormsRequest,\n formsV4Form_universal_d_CursorQuery as CursorQuery,\n formsV4Form_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n formsV4Form_universal_d_Sorting as Sorting,\n formsV4Form_universal_d_SortOrder as SortOrder,\n formsV4Form_universal_d_CommonCursorPaging as CommonCursorPaging,\n formsV4Form_universal_d_QueryFormsResponse as QueryFormsResponse,\n formsV4Form_universal_d_CommonCursorPagingMetadata as CommonCursorPagingMetadata,\n formsV4Form_universal_d_CommonCursors as CommonCursors,\n formsV4Form_universal_d_CountFormsRequest as CountFormsRequest,\n formsV4Form_universal_d_CountFormsFieldset as CountFormsFieldset,\n formsV4Form_universal_d_CountFormsResponse as CountFormsResponse,\n formsV4Form_universal_d_ListTemplateExtensionsRequest as ListTemplateExtensionsRequest,\n formsV4Form_universal_d_ListFormsOrderEnumListFormsOrder as ListFormsOrderEnumListFormsOrder,\n formsV4Form_universal_d_NameFilter as NameFilter,\n formsV4Form_universal_d_FilterType as FilterType,\n formsV4Form_universal_d_ListTemplateExtensionsResponse as ListTemplateExtensionsResponse,\n formsV4Form_universal_d_ListFormsRequest as ListFormsRequest,\n formsV4Form_universal_d_ListFormsOrder as ListFormsOrder,\n formsV4Form_universal_d_ListFormsResponse as ListFormsResponse,\n formsV4Form_universal_d_GetDeletedFormRequest as GetDeletedFormRequest,\n formsV4Form_universal_d_GetDeletedFormResponse as GetDeletedFormResponse,\n formsV4Form_universal_d_QueryDeletedFormsRequest as QueryDeletedFormsRequest,\n formsV4Form_universal_d_QueryDeletedFormsResponse as QueryDeletedFormsResponse,\n formsV4Form_universal_d_ListDeletedFormsRequest as ListDeletedFormsRequest,\n formsV4Form_universal_d_ListDeletedFormsOrder as ListDeletedFormsOrder,\n formsV4Form_universal_d_ListDeletedFormsResponse as ListDeletedFormsResponse,\n formsV4Form_universal_d_BulkRemoveDeletedFieldRequest as BulkRemoveDeletedFieldRequest,\n formsV4Form_universal_d_BulkRemoveDeletedFieldResponse as BulkRemoveDeletedFieldResponse,\n formsV4Form_universal_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest,\n formsV4Form_universal_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse,\n formsV4Form_universal_d_ListFormsProvidersConfigsRequest as ListFormsProvidersConfigsRequest,\n formsV4Form_universal_d_ListFormsProvidersConfigsResponse as ListFormsProvidersConfigsResponse,\n formsV4Form_universal_d_FormsSchemaProvidersConfig as FormsSchemaProvidersConfig,\n formsV4Form_universal_d_FormProviderRestrictions as FormProviderRestrictions,\n formsV4Form_universal_d_DomainEvent as DomainEvent,\n formsV4Form_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n formsV4Form_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n formsV4Form_universal_d_RestoreInfo as RestoreInfo,\n formsV4Form_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n formsV4Form_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n formsV4Form_universal_d_ActionEvent as ActionEvent,\n formsV4Form_universal_d_Empty as Empty,\n formsV4Form_universal_d_GetFormSummaryRequest as GetFormSummaryRequest,\n formsV4Form_universal_d_GetFormSummaryResponse as GetFormSummaryResponse,\n formsV4Form_universal_d_FormSummary as FormSummary,\n formsV4Form_universal_d_FieldInputType as FieldInputType,\n formsV4Form_universal_d_FieldOption as FieldOption,\n formsV4Form_universal_d_Field as Field,\n formsV4Form_universal_d_MessageEnvelope as MessageEnvelope,\n formsV4Form_universal_d_IdentificationData as IdentificationData,\n formsV4Form_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n formsV4Form_universal_d_WebhookIdentityType as WebhookIdentityType,\n formsV4Form_universal_d_createForm as createForm,\n formsV4Form_universal_d_bulkCreateForm as bulkCreateForm,\n formsV4Form_universal_d_BulkCreateFormOptions as BulkCreateFormOptions,\n formsV4Form_universal_d_cloneForm as cloneForm,\n formsV4Form_universal_d_cloneFormFromTemplate as cloneFormFromTemplate,\n formsV4Form_universal_d_CloneFormFromTemplateOptions as CloneFormFromTemplateOptions,\n formsV4Form_universal_d_getForm as getForm,\n formsV4Form_universal_d_GetFormOptions as GetFormOptions,\n formsV4Form_universal_d_updateForm as updateForm,\n formsV4Form_universal_d_UpdateForm as UpdateForm,\n formsV4Form_universal_d_UpdateFormOptions as UpdateFormOptions,\n formsV4Form_universal_d_removeFormFromTrashBin as removeFormFromTrashBin,\n formsV4Form_universal_d_deleteForm as deleteForm,\n formsV4Form_universal_d_DeleteFormOptions as DeleteFormOptions,\n formsV4Form_universal_d_restoreFromTrashBin as restoreFromTrashBin,\n formsV4Form_universal_d_queryForms as queryForms,\n formsV4Form_universal_d_QueryFormsOptions as QueryFormsOptions,\n formsV4Form_universal_d_FormsQueryResult as FormsQueryResult,\n formsV4Form_universal_d_FormsQueryBuilder as FormsQueryBuilder,\n formsV4Form_universal_d_countForms as countForms,\n formsV4Form_universal_d_CountFormsOptions as CountFormsOptions,\n formsV4Form_universal_d_listTemplateExtensions as listTemplateExtensions,\n formsV4Form_universal_d_ListTemplateExtensionsOptions as ListTemplateExtensionsOptions,\n formsV4Form_universal_d_listForms as listForms,\n formsV4Form_universal_d_ListFormsOptions as ListFormsOptions,\n formsV4Form_universal_d_getDeletedForm as getDeletedForm,\n formsV4Form_universal_d_queryDeletedForms as queryDeletedForms,\n formsV4Form_universal_d_listDeletedForms as listDeletedForms,\n formsV4Form_universal_d_ListDeletedFormsOptions as ListDeletedFormsOptions,\n formsV4Form_universal_d_bulkRemoveDeletedField as bulkRemoveDeletedField,\n formsV4Form_universal_d_BulkRemoveDeletedFieldOptions as BulkRemoveDeletedFieldOptions,\n formsV4Form_universal_d_updateExtendedFields as updateExtendedFields,\n formsV4Form_universal_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions,\n formsV4Form_universal_d_listFormsProvidersConfigs as listFormsProvidersConfigs,\n formsV4Form_universal_d_getFormSummary as getFormSummary,\n };\n }\n \n export { formsV4Form_universal_d as forms, formsV4Submission_universal_d as submissions };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/auto-frontend-module-registry.d.ts", "content": "declare module \"auto-frontend-module-registry\" {\n const ModuleList: string[];\n \n export { ModuleList };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-table-reservations-backend.d.ts", "content": "declare module \"wix-table-reservations-backend\" {\n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** The reservation domain object. */\n interface Reservation {\n /**\n * Reservation ID. Read-Only.\n * @readonly\n */\n _id?: string | null;\n /** Status of the reservation. */\n status?: Status$1;\n /** Reservation source. */\n source?: Source;\n /** Reservation details. */\n details?: Details;\n /** Info about the person the reservation is being made for. */\n reservee?: Reservee;\n /**\n * Info about the person making the reservation.\n * @readonly\n */\n reservedBy?: ReservedBy;\n /** Team message. */\n teamMessage?: string | null;\n /**\n * Date and time when the when reservation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the when reservation was changed.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Revision.\n * @readonly\n */\n revision?: string | null;\n /** Decline reason. */\n declineReason?: string | null;\n }\n enum Status$1 {\n UNKNOWN = \"UNKNOWN\",\n /** The reservation is held for a period of time during which person who makes reservation should fill details. */\n HELD = \"HELD\",\n /** The reservation has been reserved. */\n RESERVED = \"RESERVED\",\n /** The reservation has been canceled. */\n CANCELED = \"CANCELED\",\n /** The reservation has been successfully finished. */\n FINISHED = \"FINISHED\",\n /** The reservee didn't arrive. */\n NO_SHOW = \"NO_SHOW\",\n /** The reservee occupied the table. */\n SEATED = \"SEATED\",\n /** The reservee requested reservation and is waiting for manual approval. */\n REQUESTED = \"REQUESTED\",\n /** The owner declined reservee's request. */\n DECLINED = \"DECLINED\"\n }\n enum Source {\n UNKNOWN = \"UNKNOWN\",\n /** The reservation is created by a User. */\n OFFLINE = \"OFFLINE\",\n /** The reservation is created by UoU. */\n ONLINE = \"ONLINE\",\n /** The reservation is created by a User. It can be created without reservee data. */\n WALK_IN = \"WALK_IN\"\n }\n /** Reservation details. */\n interface Details {\n /** Reservation location ID where reservation is made. */\n reservationLocationId?: string | null;\n /** Table IDs. */\n tableIds?: string[] | null;\n /** Start date of the reservation. */\n startDate?: Date;\n /** End date of the reservation. */\n endDate?: Date;\n /** Party size. */\n partySize?: number | null;\n }\n /** A person the reservation is being made for. */\n interface Reservee {\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n /** Email. */\n email?: string | null;\n /** Phone. */\n phone?: string | null;\n /** Marketing consent. */\n marketingConsent?: boolean | null;\n /**\n * Reservee's custom fields,\n *\n * where each key is the custom field definition id,\n * and each value is the field's value for the contact.\n *\n * Empty fields are not returned.\n */\n customFields?: Record | null;\n /**\n * CRM contact ID, create new one if not exist.\n * @readonly\n */\n contactId?: string | null;\n }\n /** A person making reservation. */\n interface ReservedBy {\n /**\n * CRM contact ID for the person who made the reservation.\n * @readonly\n */\n contactId?: string | null;\n }\n interface CreateReservationRequest {\n /** Reservation. */\n reservation: Reservation;\n /**\n * If creation is forced.\n * @internal\n */\n force?: boolean;\n /** Ignore table combination conflicts. */\n ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];\n /** Ignore reservation location conflicts. */\n ignoreReservationLocationConflicts?: Type$1[];\n }\n enum TableCombinationConflictType$1 {\n UNKNOWN = \"UNKNOWN\",\n RESERVED = \"RESERVED\",\n TOO_BIG = \"TOO_BIG\",\n TOO_SMALL = \"TOO_SMALL\",\n OFFLINE_ONLY = \"OFFLINE_ONLY\"\n }\n enum Type$1 {\n UNKNOWN = \"UNKNOWN\",\n PARTY_PACING = \"PARTY_PACING\",\n SEAT_PACING = \"SEAT_PACING\"\n }\n interface CreateReservationResponse {\n /** Reservation. */\n reservation?: Reservation;\n }\n interface ReservationDetailsConflicts {\n /** Table combinations conflicts. */\n tableCombinationConflicts?: TableCombinationConflict$1[];\n /** Reservation location conflicts. */\n reservationLocationConflicts?: ReservationLocationConflict$1[];\n }\n interface TableCombinationConflict$1 {\n /** Conflict type. */\n type?: TableCombinationConflictType$1;\n }\n interface ReservationLocationConflict$1 {\n /** Reservation location conflict type. */\n type?: Type$1;\n }\n interface GetReservationRequest {\n /** Reservation id. */\n reservationId: string;\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set$1;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set$1[];\n }\n enum Set$1 {\n PUBLIC = \"PUBLIC\",\n FULL = \"FULL\"\n }\n interface GetReservationResponse {\n /** Reservation. */\n reservation?: Reservation;\n }\n interface UpdateReservationRequest {\n /** Reservation. */\n reservation: Reservation;\n /**\n * Field mask.\n * @internal\n */\n mask?: string[];\n /**\n * If update should be forced.\n * @internal\n */\n force?: boolean;\n /** Ignored table combination conflicts. */\n ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];\n /** Ignored reservation location conflicts. */\n ignoreReservationLocationConflicts?: Type$1[];\n }\n interface UpdateReservationResponse {\n /** Reservation. */\n reservation?: Reservation;\n }\n interface ReservationDataUpdated {\n /** Reserved reservation. */\n reservation?: Reservation;\n /** Old reservation. */\n oldReservation?: Reservation;\n }\n interface CreateHeldReservationRequest {\n reservationDetails: HeldReservationDetails;\n }\n /** Reservation details when create reservation in status HELD. */\n interface HeldReservationDetails {\n /** Reservation location ID where reservation is made. */\n reservationLocationId?: string | null;\n /** Start date of the reservation. */\n startDate?: Date;\n /** Party size. */\n partySize?: number | null;\n }\n interface CreateHeldReservationResponse {\n /** Reservation. */\n reservation?: Reservation;\n }\n interface ReserveReservationRequest {\n /** Reservation id. */\n reservationId: string;\n /** Reservee. */\n reservee: Reservee;\n revision: string | null;\n }\n interface ReserveReservationResponse {\n /** Reservation. */\n reservation?: Reservation;\n }\n interface ReservationReserved {\n /** Reserved reservation. */\n reservation?: Reservation;\n }\n interface CancelReservationRequest {\n /** Reservation id. */\n reservationId: string;\n revision: string | null;\n /** Phone number that was used when the reservation was created. */\n phone?: string | null;\n }\n interface CancelReservationResponse {\n /** Reservation. */\n reservation?: Reservation;\n }\n interface ReservationCanceled {\n /** Reserved reservation. */\n reservation?: Reservation;\n }\n interface DeleteReservationRequest {\n /** Reservation id. */\n reservationId: string;\n revision?: string;\n }\n interface DeleteReservationResponse {\n }\n interface ListReservationsRequest {\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 paging?: CursorPaging$1;\n /** The way how reservations in response should be sorted. */\n sort?: Sorting$1;\n /** Start date from. */\n startDateFrom?: Date;\n /** Start date to. */\n startDateTo?: Date;\n /** Only reservations with this status should be returned. */\n status?: Status$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 ListReservationsResponse {\n /** List of the reservations. */\n reservations?: Reservation[];\n /** Metadata for the paginated results. */\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 QueryReservationsRequest {\n /** Query to select reservations. */\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$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$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 QueryReservationsResponse {\n /** List of the reservations. */\n reservations?: Reservation[];\n /** Metadata for the paginated results. */\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 * 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 * @internal\n */\n hasNext?: boolean | 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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent$1;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent$1;\n }\n interface EntityCreatedEvent$1 {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent$1 {\n currentEntityAsJson?: string;\n }\n interface Empty$1 {\n }\n /**\n * Creates a new reservation.\n * @param reservation - Reservation.\n * @internal\n * @documentationMaturity preview\n * @requiredField reservation\n * @requiredField reservation.details\n * @requiredField reservation.details.partySize\n * @requiredField reservation.details.reservationLocationId\n * @requiredField reservation.details.startDate\n */\n function createReservation(reservation: Reservation, options?: CreateReservationOptions): Promise;\n interface CreateReservationOptions {\n /**\n * If creation is forced.\n * @internal\n */\n force?: boolean;\n /** Ignore table combination conflicts. */\n ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];\n /** Ignore reservation location conflicts. */\n ignoreReservationLocationConflicts?: Type$1[];\n }\n /**\n * Get a reservation.\n * @param reservationId - Reservation id.\n * @internal\n * @documentationMaturity preview\n * @requiredField reservationId\n */\n function getReservation(reservationId: string, options?: GetReservationOptions): Promise;\n interface GetReservationOptions {\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set$1;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set$1[];\n }\n /**\n * Update a reservation's specified properties.\n * @param _id - Reservation ID. Read-Only.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField reservation\n * @requiredField reservation.revision\n */\n function updateReservation(_id: string | null, reservation: UpdateReservation, options?: UpdateReservationOptions): Promise;\n interface UpdateReservation {\n /**\n * Reservation ID. Read-Only.\n * @readonly\n */\n _id?: string | null;\n /** Status of the reservation. */\n status?: Status$1;\n /** Reservation source. */\n source?: Source;\n /** Reservation details. */\n details?: Details;\n /** Info about the person the reservation is being made for. */\n reservee?: Reservee;\n /**\n * Info about the person making the reservation.\n * @readonly\n */\n reservedBy?: ReservedBy;\n /** Team message. */\n teamMessage?: string | null;\n /**\n * Date and time when the when reservation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time when the when reservation was changed.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Revision.\n * @readonly\n */\n revision?: string | null;\n /** Decline reason. */\n declineReason?: string | null;\n }\n interface UpdateReservationOptions {\n /**\n * Field mask.\n * @internal\n */\n mask?: string[];\n /**\n * If update should be forced.\n * @internal\n */\n force?: boolean;\n /** Ignored table combination conflicts. */\n ignoreTableCombinationConflicts?: TableCombinationConflictType$1[];\n /** Ignored reservation location conflicts. */\n ignoreReservationLocationConflicts?: Type$1[];\n }\n /**\n * Creates a new reservation in a HELD status.\n * @internal\n * @documentationMaturity preview\n * @requiredField reservationDetails\n * @requiredField reservationDetails.partySize\n * @requiredField reservationDetails.reservationLocationId\n * @requiredField reservationDetails.startDate\n */\n function createHeldReservation(reservationDetails: HeldReservationDetails): Promise;\n /**\n * Reserve reservation. Change HELD status to RESERVED.\n * @param reservationId - Reservation id.\n * @param reservee - Reservee.\n * @internal\n * @documentationMaturity preview\n * @requiredField reservationId\n * @requiredField reservee\n * @requiredField reservee.firstName\n * @requiredField reservee.phone\n * @requiredField revision\n */\n function reserveReservation(reservationId: string, reservee: Reservee, revision: string | null): Promise;\n /**\n * Cancel reservation. Set reservation status to CANCELED.\n * @param reservationId - Reservation id.\n * @internal\n * @documentationMaturity preview\n * @requiredField reservationId\n * @requiredField revision\n */\n function cancelReservation(reservationId: string, revision: string | null, options?: CancelReservationOptions): Promise;\n interface CancelReservationOptions {\n /** Phone number that was used when the reservation was created. */\n phone?: string | null;\n }\n /**\n * Delete reservation. Only reservations in status HELD can be deleted.\n * @param reservationId - Reservation id.\n * @internal\n * @documentationMaturity preview\n * @requiredField reservationId\n * @requiredField revision\n */\n function deleteReservation(reservationId: string, revision: string): Promise;\n /**\n * Lists reservations, given the providing paging and sorting.\n * @internal\n * @documentationMaturity preview\n */\n function listReservations(options?: ListReservationsOptions): Promise;\n interface ListReservationsOptions {\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 paging?: CursorPaging$1;\n /** The way how reservations in response should be sorted. */\n sort?: Sorting$1;\n /** Start date from. */\n startDateFrom?: Date;\n /** Start date to. */\n startDateTo?: Date;\n /** Only reservations with this status should be returned. */\n status?: Status$1;\n }\n /**\n * Retrieves a list of reservations, given the provided filters, sorting and paging.\n * @internal\n * @documentationMaturity preview\n */\n function queryReservations(): ReservationsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ReservationsQueryResult extends QueryCursorResult$1 {\n items: Reservation[];\n query: ReservationsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ReservationsQueryBuilder {\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) => ReservationsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ReservationsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n type tableReservationsV1Reservation_universal_d_Reservation = Reservation;\n type tableReservationsV1Reservation_universal_d_Source = Source;\n const tableReservationsV1Reservation_universal_d_Source: typeof Source;\n type tableReservationsV1Reservation_universal_d_Details = Details;\n type tableReservationsV1Reservation_universal_d_Reservee = Reservee;\n type tableReservationsV1Reservation_universal_d_ReservedBy = ReservedBy;\n type tableReservationsV1Reservation_universal_d_CreateReservationRequest = CreateReservationRequest;\n type tableReservationsV1Reservation_universal_d_CreateReservationResponse = CreateReservationResponse;\n type tableReservationsV1Reservation_universal_d_ReservationDetailsConflicts = ReservationDetailsConflicts;\n type tableReservationsV1Reservation_universal_d_GetReservationRequest = GetReservationRequest;\n type tableReservationsV1Reservation_universal_d_GetReservationResponse = GetReservationResponse;\n type tableReservationsV1Reservation_universal_d_UpdateReservationRequest = UpdateReservationRequest;\n type tableReservationsV1Reservation_universal_d_UpdateReservationResponse = UpdateReservationResponse;\n type tableReservationsV1Reservation_universal_d_ReservationDataUpdated = ReservationDataUpdated;\n type tableReservationsV1Reservation_universal_d_CreateHeldReservationRequest = CreateHeldReservationRequest;\n type tableReservationsV1Reservation_universal_d_HeldReservationDetails = HeldReservationDetails;\n type tableReservationsV1Reservation_universal_d_CreateHeldReservationResponse = CreateHeldReservationResponse;\n type tableReservationsV1Reservation_universal_d_ReserveReservationRequest = ReserveReservationRequest;\n type tableReservationsV1Reservation_universal_d_ReserveReservationResponse = ReserveReservationResponse;\n type tableReservationsV1Reservation_universal_d_ReservationReserved = ReservationReserved;\n type tableReservationsV1Reservation_universal_d_CancelReservationRequest = CancelReservationRequest;\n type tableReservationsV1Reservation_universal_d_CancelReservationResponse = CancelReservationResponse;\n type tableReservationsV1Reservation_universal_d_ReservationCanceled = ReservationCanceled;\n type tableReservationsV1Reservation_universal_d_DeleteReservationRequest = DeleteReservationRequest;\n type tableReservationsV1Reservation_universal_d_DeleteReservationResponse = DeleteReservationResponse;\n type tableReservationsV1Reservation_universal_d_ListReservationsRequest = ListReservationsRequest;\n type tableReservationsV1Reservation_universal_d_ListReservationsResponse = ListReservationsResponse;\n type tableReservationsV1Reservation_universal_d_QueryReservationsRequest = QueryReservationsRequest;\n type tableReservationsV1Reservation_universal_d_QueryReservationsResponse = QueryReservationsResponse;\n const tableReservationsV1Reservation_universal_d_createReservation: typeof createReservation;\n type tableReservationsV1Reservation_universal_d_CreateReservationOptions = CreateReservationOptions;\n const tableReservationsV1Reservation_universal_d_getReservation: typeof getReservation;\n type tableReservationsV1Reservation_universal_d_GetReservationOptions = GetReservationOptions;\n const tableReservationsV1Reservation_universal_d_updateReservation: typeof updateReservation;\n type tableReservationsV1Reservation_universal_d_UpdateReservation = UpdateReservation;\n type tableReservationsV1Reservation_universal_d_UpdateReservationOptions = UpdateReservationOptions;\n const tableReservationsV1Reservation_universal_d_createHeldReservation: typeof createHeldReservation;\n const tableReservationsV1Reservation_universal_d_reserveReservation: typeof reserveReservation;\n const tableReservationsV1Reservation_universal_d_cancelReservation: typeof cancelReservation;\n type tableReservationsV1Reservation_universal_d_CancelReservationOptions = CancelReservationOptions;\n const tableReservationsV1Reservation_universal_d_deleteReservation: typeof deleteReservation;\n const tableReservationsV1Reservation_universal_d_listReservations: typeof listReservations;\n type tableReservationsV1Reservation_universal_d_ListReservationsOptions = ListReservationsOptions;\n const tableReservationsV1Reservation_universal_d_queryReservations: typeof queryReservations;\n type tableReservationsV1Reservation_universal_d_ReservationsQueryResult = ReservationsQueryResult;\n type tableReservationsV1Reservation_universal_d_ReservationsQueryBuilder = ReservationsQueryBuilder;\n namespace tableReservationsV1Reservation_universal_d {\n export {\n __debug$2 as __debug,\n tableReservationsV1Reservation_universal_d_Reservation as Reservation,\n Status$1 as Status,\n tableReservationsV1Reservation_universal_d_Source as Source,\n tableReservationsV1Reservation_universal_d_Details as Details,\n tableReservationsV1Reservation_universal_d_Reservee as Reservee,\n tableReservationsV1Reservation_universal_d_ReservedBy as ReservedBy,\n tableReservationsV1Reservation_universal_d_CreateReservationRequest as CreateReservationRequest,\n TableCombinationConflictType$1 as TableCombinationConflictType,\n Type$1 as Type,\n tableReservationsV1Reservation_universal_d_CreateReservationResponse as CreateReservationResponse,\n tableReservationsV1Reservation_universal_d_ReservationDetailsConflicts as ReservationDetailsConflicts,\n TableCombinationConflict$1 as TableCombinationConflict,\n ReservationLocationConflict$1 as ReservationLocationConflict,\n tableReservationsV1Reservation_universal_d_GetReservationRequest as GetReservationRequest,\n Set$1 as Set,\n tableReservationsV1Reservation_universal_d_GetReservationResponse as GetReservationResponse,\n tableReservationsV1Reservation_universal_d_UpdateReservationRequest as UpdateReservationRequest,\n tableReservationsV1Reservation_universal_d_UpdateReservationResponse as UpdateReservationResponse,\n tableReservationsV1Reservation_universal_d_ReservationDataUpdated as ReservationDataUpdated,\n tableReservationsV1Reservation_universal_d_CreateHeldReservationRequest as CreateHeldReservationRequest,\n tableReservationsV1Reservation_universal_d_HeldReservationDetails as HeldReservationDetails,\n tableReservationsV1Reservation_universal_d_CreateHeldReservationResponse as CreateHeldReservationResponse,\n tableReservationsV1Reservation_universal_d_ReserveReservationRequest as ReserveReservationRequest,\n tableReservationsV1Reservation_universal_d_ReserveReservationResponse as ReserveReservationResponse,\n tableReservationsV1Reservation_universal_d_ReservationReserved as ReservationReserved,\n tableReservationsV1Reservation_universal_d_CancelReservationRequest as CancelReservationRequest,\n tableReservationsV1Reservation_universal_d_CancelReservationResponse as CancelReservationResponse,\n tableReservationsV1Reservation_universal_d_ReservationCanceled as ReservationCanceled,\n tableReservationsV1Reservation_universal_d_DeleteReservationRequest as DeleteReservationRequest,\n tableReservationsV1Reservation_universal_d_DeleteReservationResponse as DeleteReservationResponse,\n tableReservationsV1Reservation_universal_d_ListReservationsRequest as ListReservationsRequest,\n CursorPaging$1 as CursorPaging,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n tableReservationsV1Reservation_universal_d_ListReservationsResponse as ListReservationsResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$1 as Cursors,\n tableReservationsV1Reservation_universal_d_QueryReservationsRequest as QueryReservationsRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Paging$1 as Paging,\n tableReservationsV1Reservation_universal_d_QueryReservationsResponse as QueryReservationsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n ExtendedFieldsUpdatedEvent$1 as ExtendedFieldsUpdatedEvent,\n Empty$1 as Empty,\n tableReservationsV1Reservation_universal_d_createReservation as createReservation,\n tableReservationsV1Reservation_universal_d_CreateReservationOptions as CreateReservationOptions,\n tableReservationsV1Reservation_universal_d_getReservation as getReservation,\n tableReservationsV1Reservation_universal_d_GetReservationOptions as GetReservationOptions,\n tableReservationsV1Reservation_universal_d_updateReservation as updateReservation,\n tableReservationsV1Reservation_universal_d_UpdateReservation as UpdateReservation,\n tableReservationsV1Reservation_universal_d_UpdateReservationOptions as UpdateReservationOptions,\n tableReservationsV1Reservation_universal_d_createHeldReservation as createHeldReservation,\n tableReservationsV1Reservation_universal_d_reserveReservation as reserveReservation,\n tableReservationsV1Reservation_universal_d_cancelReservation as cancelReservation,\n tableReservationsV1Reservation_universal_d_CancelReservationOptions as CancelReservationOptions,\n tableReservationsV1Reservation_universal_d_deleteReservation as deleteReservation,\n tableReservationsV1Reservation_universal_d_listReservations as listReservations,\n tableReservationsV1Reservation_universal_d_ListReservationsOptions as ListReservationsOptions,\n tableReservationsV1Reservation_universal_d_queryReservations as queryReservations,\n tableReservationsV1Reservation_universal_d_ReservationsQueryResult as ReservationsQueryResult,\n tableReservationsV1Reservation_universal_d_ReservationsQueryBuilder as ReservationsQueryBuilder,\n };\n }\n \n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** ReservationLocation is the main entity of ReservationLocationService. */\n interface ReservationLocation {\n /**\n * ReservationLocation ID.\n * @readonly\n */\n _id?: string | null;\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 revision?: string | null;\n /**\n * Represents the time this ReservationLocation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this ReservationLocation was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Location data.\n * @readonly\n */\n location?: Location;\n /** Reservation configuration. */\n configuration?: Configuration;\n /**\n * Whether this is the default location.\n * @readonly\n */\n default?: boolean | null;\n /**\n * Whether the location is archived.\n * @readonly\n */\n archived?: boolean | null;\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 interface Address {\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 }\n /**\n * Time periods that this location is open for business. Includes a collection of TimePeriod instances.\n * Aligned with https://developers.google.com/my-business/reference/rest/v4/accounts.locations#businesshours\n * With a few minor adjustments\n */\n interface BusinessSchedule {\n periods?: TimePeriod[];\n /** Exceptions to the business's regular hours. */\n specialHourPeriod?: SpecialHourPeriod[];\n }\n /**\n * A span of time that the business is open,\n * starting on the specified open day/time and closing on the specified close day/time.\n * Closing time must occur after the opening time, for example later in the same day, or on a subsequent day.\n */\n interface TimePeriod {\n /** Day of the week this period starts on. */\n openDay?: DayOfWeek;\n openTime?: string;\n /** Day of the week this period ends on. */\n closeDay?: DayOfWeek;\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 /** Set of time periods when a location's operational hours differ from its normal business hours. */\n interface SpecialHourPeriod {\n /** Date and Time in 24hr iso-8601 Coordinated universal time (UTC) */\n startDate?: string;\n /** Date and Time in 24hr iso-8601 Coordinated universal time (UTC) */\n endDate?: string;\n isClosed?: boolean;\n comment?: string;\n }\n /** Table definition. Definition of the tables. */\n interface TableDefinition {\n /**\n * Table id.\n * @readonly\n */\n _id?: string | null;\n /** Table name. */\n name?: string;\n /** Min number of seats. */\n seatsMin?: number;\n /** Max number of seats. */\n seatsMax?: number;\n /** Is active. */\n isActive?: boolean | null;\n }\n interface TableCombination$1 {\n /**\n * Table combination id.\n * @readonly\n */\n _id?: string | null;\n /** Ids of tables in the combination. */\n tableIds?: string[] | null;\n /** Min number of seats. */\n seatsMin?: number;\n /** Max number of seats. */\n seatsMax?: number;\n /** Is active. */\n isActive?: boolean | null;\n }\n enum Unit {\n UNKNOWN = \"UNKNOWN\",\n MINUTES = \"MINUTES\",\n HOURS = \"HOURS\",\n DAYS = \"DAYS\"\n }\n /**\n * Seat pacing.\n * The pace is summarized separately for every 15 mins.\n * Settings a new seat pace of X means that for example between 10:00.000-10:14.999 there will be no more than X new seats.\n */\n interface SeatPacing {\n /** Max number of seats pace. */\n number?: number;\n /** Show if this option is enabled. */\n enabled?: boolean;\n }\n /**\n * Party pacing.\n * The pace is summarized separately for every 15 mins.\n * Settings a new parties pace of X means that for example between 10:00.000-10:14.999 there will be no more than X new parties.\n */\n interface PartyPacing {\n /** Max number of parties pace. */\n number?: number;\n /** Show if this option is enabled. */\n enabled?: boolean;\n }\n /** The party size that can be requested in a single reservation. */\n interface PartiesSize {\n /** Min number of seats. */\n min?: number;\n /** Max number of seats. */\n max?: number;\n }\n /** The party size that can be requested in a single reservation. */\n interface PartySize {\n /** Min number of seats. */\n min?: number;\n /** Max number of seats. */\n max?: number;\n }\n /** Reservation notice period. */\n interface NoticePeriod {\n /** The number of the unit. */\n number?: number;\n /** Time unit. */\n unit?: Unit;\n }\n /** Turnover time rule. A turnover time is defined per party size range. */\n interface TurnoverTimeRule {\n /** Min number of seats. */\n seatsMin?: number;\n /** Max number of seats. */\n seatsMax?: number;\n /** Turnover time in minutes. */\n minutes?: number;\n }\n /** Turnover rule. A turnover time is defined per party size range. */\n interface TurnoverRule {\n /** Min number of seats. */\n minSeats?: number;\n /** Max number of seats. */\n maxSeats?: number;\n /** Turnover time in minutes. */\n minutes?: number;\n }\n /** Manual approval settings. */\n interface ManualApproval extends ManualApprovalValueOneOf {\n /** Party size threshold. */\n partySizeThreshold?: number;\n /** Show if it is shown to UoU. */\n enabled?: boolean;\n }\n /** @oneof */\n interface ManualApprovalValueOneOf {\n /** Party size threshold. */\n partySizeThreshold?: number;\n }\n /** Type of the field. */\n enum FieldType {\n UNKNOWN = \"UNKNOWN\",\n TABLE = \"TABLE\",\n START_DATE = \"START_DATE\",\n END_DATE = \"END_DATE\",\n CREATED_DATE = \"CREATED_DATE\",\n UPDATED_DATE = \"UPDATED_DATE\",\n PARTY_SIZE = \"PARTY_SIZE\",\n FIRST_NAME = \"FIRST_NAME\",\n LAST_NAME = \"LAST_NAME\",\n EMAIL = \"EMAIL\",\n PHONE = \"PHONE\",\n ADDITIONAL_INFO = \"ADDITIONAL_INFO\",\n TEAM_MESSAGE = \"TEAM_MESSAGE\",\n CUSTOM_FIELD = \"CUSTOM_FIELD\",\n STATUS = \"STATUS\"\n }\n /** Terms and conditions. */\n interface TermsAndConditions extends TermsAndConditionsValueOneOf {\n /** Url. */\n url?: string;\n /** Text. */\n text?: string | null;\n /** Show if it is shown to UoU. */\n enabled?: boolean;\n }\n /** @oneof */\n interface TermsAndConditionsValueOneOf {\n /** Url. */\n url?: string;\n /** Text. */\n text?: string | null;\n }\n /** Privacy policy. */\n interface PrivacyPolicy extends PrivacyPolicyValueOneOf {\n /** Url. */\n url?: string;\n /** Text. */\n text?: string | null;\n /** Show if it is shown to UoU. */\n enabled?: boolean;\n }\n /** @oneof */\n interface PrivacyPolicyValueOneOf {\n /** Url. */\n url?: string;\n /** Text. */\n text?: string | null;\n }\n /** Custom field definition. Definition of the fields that are added to the reservation form. */\n interface CustomFieldDefinition {\n /**\n * Custom field id.\n * @readonly\n */\n _id?: string | null;\n /** Field name. */\n name?: string;\n /** Show if field is required. */\n required?: boolean;\n }\n /** Email marketing checkbox. */\n interface EmailMarketingCheckbox {\n /** Show if it is shown to UoU. */\n enabled?: boolean;\n /** Show if checkbox is checked by default. */\n checkedByDefault?: boolean;\n }\n interface OnlineReservations {\n /** Seats pace. */\n seatPacing?: SeatPacing;\n /** Parties pace. */\n partyPacing?: PartyPacing;\n /**\n * Parties size.\n * @internal\n */\n partiesSize?: PartiesSize;\n /** Party size. */\n partySize?: PartySize;\n /** Minimum reservation notice period. */\n minimumReservationNotice?: NoticePeriod;\n /** Default time in minutes for parties turnover. */\n defaultTurnoverTime?: number | null;\n /** Custom turnover time rules. */\n turnoverTimeRules?: TurnoverTimeRule[];\n /**\n * Turnover rules.\n * @internal\n */\n turnoverRules?: TurnoverRule[];\n /** Business schedule for the reservation location. */\n businessSchedule?: BusinessSchedule;\n /** Show if phone number is shown in case of larger party. */\n showPhoneNumber?: boolean | null;\n /** Show if online reservations enabled. */\n onlineReservationsEnabled?: boolean | null;\n /** Manual approval settings. */\n manualApproval?: ManualApproval;\n }\n /** Reservation form settings. */\n interface ReservationForm {\n /** Message that will be shown to UoU in registration form. */\n submitMessage?: string | null;\n /** Show if it is needed to show policies to the UoU. */\n policiesEnabled?: boolean | null;\n /** Terms and conditions. */\n termsAndConditions?: TermsAndConditions;\n /** Privacy policy. */\n privacyPolicy?: PrivacyPolicy;\n /** Fields that User add to the registration form for UoU. */\n customFieldDefinitions?: CustomFieldDefinition[];\n /** Show if it is needed to Validate phone number by SMS. */\n validatePhoneNumber?: boolean | null;\n /** Show if last_name is required in reservation form. Default is false. */\n lastNameRequired?: boolean | null;\n /** Show if email is required in reservation form. Default is false. */\n emailRequired?: boolean | null;\n /** Email marketing checkbox. */\n emailMarketingCheckbox?: EmailMarketingCheckbox;\n }\n /** My reservations field definition. */\n interface MyReservationsField {\n /** Field type. */\n fieldType?: FieldType;\n /**\n * Custom field id.\n * @readonly\n */\n customFieldId?: string | null;\n /** Shown. */\n shown?: boolean;\n }\n interface TableManagement {\n /** Table definitions. */\n tableDefinitions?: TableDefinition[];\n /** Deleted table definitions. */\n deletedTableDefinitions?: TableDefinition[];\n /** Table combinations. */\n tableCombinations?: TableCombination$1[];\n }\n interface Location {\n /**\n * Location ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Location name.\n * @internal\n * @readonly\n */\n name?: string | null;\n /**\n * Location description.\n * @internal\n * @readonly\n */\n description?: string | null;\n /**\n * Fax number.\n * @internal\n * @readonly\n */\n fax?: string | null;\n /**\n * Timezone in `America/New_York` format.\n * @internal\n * @readonly\n */\n timeZone?: string | null;\n /**\n * Email address.\n * @internal\n */\n email?: string | null;\n /**\n * Phone number.\n * @internal\n * @readonly\n */\n phone?: string | null;\n /**\n * Address.\n * @internal\n * @readonly\n */\n address?: Address;\n /**\n * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.\n * @internal\n * @readonly\n */\n businessSchedule?: BusinessSchedule;\n }\n interface Configuration {\n /** Location settings based on which reservation availability is calculated. */\n onlineReservations?: OnlineReservations;\n /** Reservation form settings. */\n reservationForm?: ReservationForm;\n /** My reservations fields view. */\n myReservationsFields?: MyReservationsField[];\n /** Table management. */\n tableManagement?: TableManagement;\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 /** 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 }\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 GetReservationLocationRequest {\n /** Id of the ReservationLocation to retrieve */\n reservationLocationId: string;\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set[];\n }\n enum Set {\n PUBLIC = \"PUBLIC\",\n FULL = \"FULL\"\n }\n interface GetReservationLocationResponse {\n /** The retrieved ReservationLocation */\n reservationLocation?: ReservationLocation;\n }\n interface UpdateReservationLocationRequest {\n /** ReservationLocation to be updated, may be partial */\n reservationLocation: ReservationLocation;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateReservationLocationResponse {\n /** The updated ReservationLocation */\n reservationLocation?: ReservationLocation;\n }\n interface TablesDeleted {\n /** Id of the affected reservationLocation. */\n reservationLocationId?: string;\n /** Ids of deleted tables. */\n tableIds?: string[];\n }\n interface QueryReservationLocationsRequest {\n /** Query expression */\n query: QueryV2;\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set[];\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 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 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 /** 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 QueryReservationLocationsResponse {\n /** The retrieved ReservationLocations */\n reservationLocations?: ReservationLocation[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Offset that was requested. */\n offset?: 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 * 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 * @internal\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 ListReservationLocationsRequest {\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 paging?: CursorPaging;\n /** Sorting for the locations list. */\n sort?: Sorting;\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set[];\n }\n interface ListReservationLocationsResponse {\n /** Locations. */\n reservationLocations?: ReservationLocation[];\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 /** 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 DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\n }\n interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {\n siteCreated?: SiteCreated;\n siteTransferred?: SiteTransferred;\n siteDeleted?: SiteDeleted;\n siteUndeleted?: SiteUndeleted;\n sitePublished?: SitePublished;\n siteUnpublished?: SiteUnpublished;\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n serviceProvisioned?: ServiceProvisioned;\n serviceRemoved?: ServiceRemoved;\n siteRenamedPayload?: SiteRenamed;\n hardDeleted?: SiteHardDeleted;\n namespaceChanged?: NamespaceChanged;\n metaSiteId?: string;\n version?: string;\n timestamp?: string;\n assets?: Asset[];\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf {\n siteCreated?: SiteCreated;\n siteTransferred?: SiteTransferred;\n siteDeleted?: SiteDeleted;\n siteUndeleted?: SiteUndeleted;\n sitePublished?: SitePublished;\n siteUnpublished?: SiteUnpublished;\n siteMarkedAsTemplate?: SiteMarkedAsTemplate;\n siteMarkedAsWixSite?: SiteMarkedAsWixSite;\n serviceProvisioned?: ServiceProvisioned;\n serviceRemoved?: ServiceRemoved;\n siteRenamedPayload?: SiteRenamed;\n hardDeleted?: SiteHardDeleted;\n namespaceChanged?: NamespaceChanged;\n }\n interface Asset {\n appDefId?: string;\n instanceId?: string;\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 originTemplateId?: string;\n ownerId?: string;\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 siteName?: string;\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 }\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 deleteContext?: DeleteContext;\n }\n interface DeleteContext {\n dateDeleted?: Date;\n deleteStatus?: DeleteStatus;\n deleteOrigin?: string;\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 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 originInstanceId?: string;\n version?: string | null;\n }\n interface ServiceRemoved {\n appDefId?: string;\n instanceId?: string;\n version?: string | null;\n }\n /** Rename of the site. Meaning, free public url has been changed as well. */\n interface SiteRenamed {\n newSiteName?: string;\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 deleteContext?: DeleteContext;\n }\n interface NamespaceChanged {\n oldNamespace?: Namespace;\n newNamespace?: Namespace;\n }\n /**\n * Get a ReservationLocation by id\n * @param reservationLocationId - Id of the ReservationLocation to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField reservationLocationId\n */\n function getReservationLocation(reservationLocationId: string, options?: GetReservationLocationOptions): Promise;\n interface GetReservationLocationOptions {\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set[];\n }\n /**\n * Update a ReservationLocation, supports partial update\n * Pass the latest `revision` for a successful update\n * @param _id - ReservationLocation ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField reservationLocation\n * @requiredField reservationLocation.revision\n */\n function updateReservationLocation(_id: string | null, reservationLocation: UpdateReservationLocation, options?: UpdateReservationLocationOptions): Promise;\n interface UpdateReservationLocation {\n /**\n * ReservationLocation ID.\n * @readonly\n */\n _id?: string | null;\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 revision?: string | null;\n /**\n * Represents the time this ReservationLocation was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this ReservationLocation was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Location data.\n * @readonly\n */\n location?: Location;\n /** Reservation configuration. */\n configuration?: Configuration;\n /**\n * Whether this is the default location.\n * @readonly\n */\n default?: boolean | null;\n /**\n * Whether the location is archived.\n * @readonly\n */\n archived?: boolean | null;\n }\n interface UpdateReservationLocationOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Query ReservationLocations using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @internal\n * @documentationMaturity preview\n */\n function queryReservationLocations(options?: QueryReservationLocationsOptions): ReservationLocationsQueryBuilder;\n interface QueryReservationLocationsOptions {\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set | undefined;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set[] | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ReservationLocationsQueryResult extends QueryCursorResult {\n items: ReservationLocation[];\n query: ReservationLocationsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ReservationLocationsQueryBuilder {\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) => ReservationLocationsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ReservationLocationsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Lists locations, given the providing paging and sorting.\n * @internal\n * @documentationMaturity preview\n */\n function listReservationLocations(options?: ListReservationLocationsOptions): Promise;\n interface ListReservationLocationsOptions {\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 paging?: CursorPaging;\n /** Sorting for the locations list. */\n sort?: Sorting;\n /**\n * Predefined sets of fields to return.\n * @internal\n */\n fieldSet?: Set;\n /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. */\n fieldsets?: Set[];\n }\n \n type tableReservationsV1ReservationLocation_universal_d_ReservationLocation = ReservationLocation;\n type tableReservationsV1ReservationLocation_universal_d_StreetAddress = StreetAddress;\n type tableReservationsV1ReservationLocation_universal_d_AddressLocation = AddressLocation;\n type tableReservationsV1ReservationLocation_universal_d_Address = Address;\n type tableReservationsV1ReservationLocation_universal_d_BusinessSchedule = BusinessSchedule;\n type tableReservationsV1ReservationLocation_universal_d_TimePeriod = TimePeriod;\n type tableReservationsV1ReservationLocation_universal_d_DayOfWeek = DayOfWeek;\n const tableReservationsV1ReservationLocation_universal_d_DayOfWeek: typeof DayOfWeek;\n type tableReservationsV1ReservationLocation_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type tableReservationsV1ReservationLocation_universal_d_TableDefinition = TableDefinition;\n type tableReservationsV1ReservationLocation_universal_d_Unit = Unit;\n const tableReservationsV1ReservationLocation_universal_d_Unit: typeof Unit;\n type tableReservationsV1ReservationLocation_universal_d_SeatPacing = SeatPacing;\n type tableReservationsV1ReservationLocation_universal_d_PartyPacing = PartyPacing;\n type tableReservationsV1ReservationLocation_universal_d_PartiesSize = PartiesSize;\n type tableReservationsV1ReservationLocation_universal_d_PartySize = PartySize;\n type tableReservationsV1ReservationLocation_universal_d_NoticePeriod = NoticePeriod;\n type tableReservationsV1ReservationLocation_universal_d_TurnoverTimeRule = TurnoverTimeRule;\n type tableReservationsV1ReservationLocation_universal_d_TurnoverRule = TurnoverRule;\n type tableReservationsV1ReservationLocation_universal_d_ManualApproval = ManualApproval;\n type tableReservationsV1ReservationLocation_universal_d_ManualApprovalValueOneOf = ManualApprovalValueOneOf;\n type tableReservationsV1ReservationLocation_universal_d_FieldType = FieldType;\n const tableReservationsV1ReservationLocation_universal_d_FieldType: typeof FieldType;\n type tableReservationsV1ReservationLocation_universal_d_TermsAndConditions = TermsAndConditions;\n type tableReservationsV1ReservationLocation_universal_d_TermsAndConditionsValueOneOf = TermsAndConditionsValueOneOf;\n type tableReservationsV1ReservationLocation_universal_d_PrivacyPolicy = PrivacyPolicy;\n type tableReservationsV1ReservationLocation_universal_d_PrivacyPolicyValueOneOf = PrivacyPolicyValueOneOf;\n type tableReservationsV1ReservationLocation_universal_d_CustomFieldDefinition = CustomFieldDefinition;\n type tableReservationsV1ReservationLocation_universal_d_EmailMarketingCheckbox = EmailMarketingCheckbox;\n type tableReservationsV1ReservationLocation_universal_d_OnlineReservations = OnlineReservations;\n type tableReservationsV1ReservationLocation_universal_d_ReservationForm = ReservationForm;\n type tableReservationsV1ReservationLocation_universal_d_MyReservationsField = MyReservationsField;\n type tableReservationsV1ReservationLocation_universal_d_TableManagement = TableManagement;\n type tableReservationsV1ReservationLocation_universal_d_Location = Location;\n type tableReservationsV1ReservationLocation_universal_d_Configuration = Configuration;\n type tableReservationsV1ReservationLocation_universal_d_InvalidateCache = InvalidateCache;\n type tableReservationsV1ReservationLocation_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type tableReservationsV1ReservationLocation_universal_d_App = App;\n type tableReservationsV1ReservationLocation_universal_d_Page = Page;\n type tableReservationsV1ReservationLocation_universal_d_URI = URI;\n type tableReservationsV1ReservationLocation_universal_d_GetReservationLocationRequest = GetReservationLocationRequest;\n type tableReservationsV1ReservationLocation_universal_d_Set = Set;\n const tableReservationsV1ReservationLocation_universal_d_Set: typeof Set;\n type tableReservationsV1ReservationLocation_universal_d_GetReservationLocationResponse = GetReservationLocationResponse;\n type tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocationRequest = UpdateReservationLocationRequest;\n type tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocationResponse = UpdateReservationLocationResponse;\n type tableReservationsV1ReservationLocation_universal_d_TablesDeleted = TablesDeleted;\n type tableReservationsV1ReservationLocation_universal_d_QueryReservationLocationsRequest = QueryReservationLocationsRequest;\n type tableReservationsV1ReservationLocation_universal_d_QueryV2 = QueryV2;\n type tableReservationsV1ReservationLocation_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type tableReservationsV1ReservationLocation_universal_d_Sorting = Sorting;\n type tableReservationsV1ReservationLocation_universal_d_SortOrder = SortOrder;\n const tableReservationsV1ReservationLocation_universal_d_SortOrder: typeof SortOrder;\n type tableReservationsV1ReservationLocation_universal_d_Paging = Paging;\n type tableReservationsV1ReservationLocation_universal_d_CursorPaging = CursorPaging;\n type tableReservationsV1ReservationLocation_universal_d_QueryReservationLocationsResponse = QueryReservationLocationsResponse;\n type tableReservationsV1ReservationLocation_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type tableReservationsV1ReservationLocation_universal_d_Cursors = Cursors;\n type tableReservationsV1ReservationLocation_universal_d_ListReservationLocationsRequest = ListReservationLocationsRequest;\n type tableReservationsV1ReservationLocation_universal_d_ListReservationLocationsResponse = ListReservationLocationsResponse;\n type tableReservationsV1ReservationLocation_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type tableReservationsV1ReservationLocation_universal_d_DomainEvent = DomainEvent;\n type tableReservationsV1ReservationLocation_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type tableReservationsV1ReservationLocation_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type tableReservationsV1ReservationLocation_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type tableReservationsV1ReservationLocation_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type tableReservationsV1ReservationLocation_universal_d_ActionEvent = ActionEvent;\n type tableReservationsV1ReservationLocation_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type tableReservationsV1ReservationLocation_universal_d_Empty = Empty;\n type tableReservationsV1ReservationLocation_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type tableReservationsV1ReservationLocation_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type tableReservationsV1ReservationLocation_universal_d_Asset = Asset;\n type tableReservationsV1ReservationLocation_universal_d_State = State;\n const tableReservationsV1ReservationLocation_universal_d_State: typeof State;\n type tableReservationsV1ReservationLocation_universal_d_SiteCreated = SiteCreated;\n type tableReservationsV1ReservationLocation_universal_d_SiteCreatedContext = SiteCreatedContext;\n const tableReservationsV1ReservationLocation_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type tableReservationsV1ReservationLocation_universal_d_Namespace = Namespace;\n const tableReservationsV1ReservationLocation_universal_d_Namespace: typeof Namespace;\n type tableReservationsV1ReservationLocation_universal_d_SiteTransferred = SiteTransferred;\n type tableReservationsV1ReservationLocation_universal_d_SiteDeleted = SiteDeleted;\n type tableReservationsV1ReservationLocation_universal_d_DeleteContext = DeleteContext;\n type tableReservationsV1ReservationLocation_universal_d_DeleteStatus = DeleteStatus;\n const tableReservationsV1ReservationLocation_universal_d_DeleteStatus: typeof DeleteStatus;\n type tableReservationsV1ReservationLocation_universal_d_SiteUndeleted = SiteUndeleted;\n type tableReservationsV1ReservationLocation_universal_d_SitePublished = SitePublished;\n type tableReservationsV1ReservationLocation_universal_d_SiteUnpublished = SiteUnpublished;\n type tableReservationsV1ReservationLocation_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type tableReservationsV1ReservationLocation_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type tableReservationsV1ReservationLocation_universal_d_ServiceProvisioned = ServiceProvisioned;\n type tableReservationsV1ReservationLocation_universal_d_ServiceRemoved = ServiceRemoved;\n type tableReservationsV1ReservationLocation_universal_d_SiteRenamed = SiteRenamed;\n type tableReservationsV1ReservationLocation_universal_d_SiteHardDeleted = SiteHardDeleted;\n type tableReservationsV1ReservationLocation_universal_d_NamespaceChanged = NamespaceChanged;\n const tableReservationsV1ReservationLocation_universal_d_getReservationLocation: typeof getReservationLocation;\n type tableReservationsV1ReservationLocation_universal_d_GetReservationLocationOptions = GetReservationLocationOptions;\n const tableReservationsV1ReservationLocation_universal_d_updateReservationLocation: typeof updateReservationLocation;\n type tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocation = UpdateReservationLocation;\n type tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocationOptions = UpdateReservationLocationOptions;\n const tableReservationsV1ReservationLocation_universal_d_queryReservationLocations: typeof queryReservationLocations;\n type tableReservationsV1ReservationLocation_universal_d_QueryReservationLocationsOptions = QueryReservationLocationsOptions;\n type tableReservationsV1ReservationLocation_universal_d_ReservationLocationsQueryResult = ReservationLocationsQueryResult;\n type tableReservationsV1ReservationLocation_universal_d_ReservationLocationsQueryBuilder = ReservationLocationsQueryBuilder;\n const tableReservationsV1ReservationLocation_universal_d_listReservationLocations: typeof listReservationLocations;\n type tableReservationsV1ReservationLocation_universal_d_ListReservationLocationsOptions = ListReservationLocationsOptions;\n namespace tableReservationsV1ReservationLocation_universal_d {\n export {\n __debug$1 as __debug,\n tableReservationsV1ReservationLocation_universal_d_ReservationLocation as ReservationLocation,\n tableReservationsV1ReservationLocation_universal_d_StreetAddress as StreetAddress,\n tableReservationsV1ReservationLocation_universal_d_AddressLocation as AddressLocation,\n tableReservationsV1ReservationLocation_universal_d_Address as Address,\n tableReservationsV1ReservationLocation_universal_d_BusinessSchedule as BusinessSchedule,\n tableReservationsV1ReservationLocation_universal_d_TimePeriod as TimePeriod,\n tableReservationsV1ReservationLocation_universal_d_DayOfWeek as DayOfWeek,\n tableReservationsV1ReservationLocation_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n tableReservationsV1ReservationLocation_universal_d_TableDefinition as TableDefinition,\n TableCombination$1 as TableCombination,\n tableReservationsV1ReservationLocation_universal_d_Unit as Unit,\n tableReservationsV1ReservationLocation_universal_d_SeatPacing as SeatPacing,\n tableReservationsV1ReservationLocation_universal_d_PartyPacing as PartyPacing,\n tableReservationsV1ReservationLocation_universal_d_PartiesSize as PartiesSize,\n tableReservationsV1ReservationLocation_universal_d_PartySize as PartySize,\n tableReservationsV1ReservationLocation_universal_d_NoticePeriod as NoticePeriod,\n tableReservationsV1ReservationLocation_universal_d_TurnoverTimeRule as TurnoverTimeRule,\n tableReservationsV1ReservationLocation_universal_d_TurnoverRule as TurnoverRule,\n tableReservationsV1ReservationLocation_universal_d_ManualApproval as ManualApproval,\n tableReservationsV1ReservationLocation_universal_d_ManualApprovalValueOneOf as ManualApprovalValueOneOf,\n tableReservationsV1ReservationLocation_universal_d_FieldType as FieldType,\n tableReservationsV1ReservationLocation_universal_d_TermsAndConditions as TermsAndConditions,\n tableReservationsV1ReservationLocation_universal_d_TermsAndConditionsValueOneOf as TermsAndConditionsValueOneOf,\n tableReservationsV1ReservationLocation_universal_d_PrivacyPolicy as PrivacyPolicy,\n tableReservationsV1ReservationLocation_universal_d_PrivacyPolicyValueOneOf as PrivacyPolicyValueOneOf,\n tableReservationsV1ReservationLocation_universal_d_CustomFieldDefinition as CustomFieldDefinition,\n tableReservationsV1ReservationLocation_universal_d_EmailMarketingCheckbox as EmailMarketingCheckbox,\n tableReservationsV1ReservationLocation_universal_d_OnlineReservations as OnlineReservations,\n tableReservationsV1ReservationLocation_universal_d_ReservationForm as ReservationForm,\n tableReservationsV1ReservationLocation_universal_d_MyReservationsField as MyReservationsField,\n tableReservationsV1ReservationLocation_universal_d_TableManagement as TableManagement,\n tableReservationsV1ReservationLocation_universal_d_Location as Location,\n tableReservationsV1ReservationLocation_universal_d_Configuration as Configuration,\n tableReservationsV1ReservationLocation_universal_d_InvalidateCache as InvalidateCache,\n tableReservationsV1ReservationLocation_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n tableReservationsV1ReservationLocation_universal_d_App as App,\n tableReservationsV1ReservationLocation_universal_d_Page as Page,\n tableReservationsV1ReservationLocation_universal_d_URI as URI,\n tableReservationsV1ReservationLocation_universal_d_GetReservationLocationRequest as GetReservationLocationRequest,\n tableReservationsV1ReservationLocation_universal_d_Set as Set,\n tableReservationsV1ReservationLocation_universal_d_GetReservationLocationResponse as GetReservationLocationResponse,\n tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocationRequest as UpdateReservationLocationRequest,\n tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocationResponse as UpdateReservationLocationResponse,\n tableReservationsV1ReservationLocation_universal_d_TablesDeleted as TablesDeleted,\n tableReservationsV1ReservationLocation_universal_d_QueryReservationLocationsRequest as QueryReservationLocationsRequest,\n tableReservationsV1ReservationLocation_universal_d_QueryV2 as QueryV2,\n tableReservationsV1ReservationLocation_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n tableReservationsV1ReservationLocation_universal_d_Sorting as Sorting,\n tableReservationsV1ReservationLocation_universal_d_SortOrder as SortOrder,\n tableReservationsV1ReservationLocation_universal_d_Paging as Paging,\n tableReservationsV1ReservationLocation_universal_d_CursorPaging as CursorPaging,\n tableReservationsV1ReservationLocation_universal_d_QueryReservationLocationsResponse as QueryReservationLocationsResponse,\n tableReservationsV1ReservationLocation_universal_d_PagingMetadataV2 as PagingMetadataV2,\n tableReservationsV1ReservationLocation_universal_d_Cursors as Cursors,\n tableReservationsV1ReservationLocation_universal_d_ListReservationLocationsRequest as ListReservationLocationsRequest,\n tableReservationsV1ReservationLocation_universal_d_ListReservationLocationsResponse as ListReservationLocationsResponse,\n tableReservationsV1ReservationLocation_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n tableReservationsV1ReservationLocation_universal_d_DomainEvent as DomainEvent,\n tableReservationsV1ReservationLocation_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n tableReservationsV1ReservationLocation_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n tableReservationsV1ReservationLocation_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n tableReservationsV1ReservationLocation_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n tableReservationsV1ReservationLocation_universal_d_ActionEvent as ActionEvent,\n tableReservationsV1ReservationLocation_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n tableReservationsV1ReservationLocation_universal_d_Empty as Empty,\n tableReservationsV1ReservationLocation_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n tableReservationsV1ReservationLocation_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n tableReservationsV1ReservationLocation_universal_d_Asset as Asset,\n tableReservationsV1ReservationLocation_universal_d_State as State,\n tableReservationsV1ReservationLocation_universal_d_SiteCreated as SiteCreated,\n tableReservationsV1ReservationLocation_universal_d_SiteCreatedContext as SiteCreatedContext,\n tableReservationsV1ReservationLocation_universal_d_Namespace as Namespace,\n tableReservationsV1ReservationLocation_universal_d_SiteTransferred as SiteTransferred,\n tableReservationsV1ReservationLocation_universal_d_SiteDeleted as SiteDeleted,\n tableReservationsV1ReservationLocation_universal_d_DeleteContext as DeleteContext,\n tableReservationsV1ReservationLocation_universal_d_DeleteStatus as DeleteStatus,\n tableReservationsV1ReservationLocation_universal_d_SiteUndeleted as SiteUndeleted,\n tableReservationsV1ReservationLocation_universal_d_SitePublished as SitePublished,\n tableReservationsV1ReservationLocation_universal_d_SiteUnpublished as SiteUnpublished,\n tableReservationsV1ReservationLocation_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n tableReservationsV1ReservationLocation_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n tableReservationsV1ReservationLocation_universal_d_ServiceProvisioned as ServiceProvisioned,\n tableReservationsV1ReservationLocation_universal_d_ServiceRemoved as ServiceRemoved,\n tableReservationsV1ReservationLocation_universal_d_SiteRenamed as SiteRenamed,\n tableReservationsV1ReservationLocation_universal_d_SiteHardDeleted as SiteHardDeleted,\n tableReservationsV1ReservationLocation_universal_d_NamespaceChanged as NamespaceChanged,\n tableReservationsV1ReservationLocation_universal_d_getReservationLocation as getReservationLocation,\n tableReservationsV1ReservationLocation_universal_d_GetReservationLocationOptions as GetReservationLocationOptions,\n tableReservationsV1ReservationLocation_universal_d_updateReservationLocation as updateReservationLocation,\n tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocation as UpdateReservationLocation,\n tableReservationsV1ReservationLocation_universal_d_UpdateReservationLocationOptions as UpdateReservationLocationOptions,\n tableReservationsV1ReservationLocation_universal_d_queryReservationLocations as queryReservationLocations,\n tableReservationsV1ReservationLocation_universal_d_QueryReservationLocationsOptions as QueryReservationLocationsOptions,\n tableReservationsV1ReservationLocation_universal_d_ReservationLocationsQueryResult as ReservationLocationsQueryResult,\n tableReservationsV1ReservationLocation_universal_d_ReservationLocationsQueryBuilder as ReservationLocationsQueryBuilder,\n tableReservationsV1ReservationLocation_universal_d_listReservationLocations as listReservationLocations,\n tableReservationsV1ReservationLocation_universal_d_ListReservationLocationsOptions as ListReservationLocationsOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface TimeSlot {\n /** Start date. */\n startDate?: Date;\n /** Duration. */\n duration?: number;\n /** Status. */\n status?: Status;\n /**\n * Table combinations.\n * @internal\n */\n tableCombinations?: TableCombination[];\n /** Manual approval. */\n manualApproval?: boolean | null;\n }\n enum Status {\n AVAILABLE = \"AVAILABLE\",\n UNAVAILABLE = \"UNAVAILABLE\",\n NON_WORKING_HOURS = \"NON_WORKING_HOURS\"\n }\n /** Table combination. */\n interface TableCombination {\n /** Table ids. */\n tableIds?: string[];\n }\n interface GetTimeSlotsRequest {\n /** Reservation location id. */\n reservationLocationId: string;\n /** Date. */\n date: Date;\n /** Duration. */\n duration?: number | null;\n /** Party size. */\n partySize: number | null;\n /** Slots before. */\n slotsBefore?: number | null;\n /** Slots after. */\n slotsAfter?: number | null;\n }\n interface GetTimeSlotsResponse {\n /** List of the time slots. */\n timeSlots?: TimeSlot[];\n }\n interface CheckReservationDetailsRequest {\n /** Reservation location id. */\n reservationLocationId: string;\n /** Date. */\n date: Date;\n /** Duration. */\n duration: number | null;\n /** Party size. */\n partySize: number | null;\n /** Reservation, that should be ignored during the check. */\n excludeReservationId?: string | null;\n /** Requested table combination. */\n tableIds?: string[];\n }\n interface CheckReservationDetailsResponse {\n /** Tables states. */\n tables?: Table[];\n /** Table combinations states. */\n tableCombinations?: V1TableCombination[];\n /** Reservation location conflicts. */\n reservationLocationConflicts?: ReservationLocationConflict[];\n /** Requested table combination state. */\n requestedTableCombination?: V1TableCombination;\n }\n interface Table {\n _id?: string;\n /** Table conflicts. */\n tableConflicts?: TableConflict[];\n }\n interface TableConflict {\n /** Conflict type. */\n type?: TableConflictType;\n }\n enum TableConflictType {\n UNKNOWN = \"UNKNOWN\",\n TABLE_RESERVED = \"TABLE_RESERVED\",\n TABLE_TOO_BIG = \"TABLE_TOO_BIG\",\n TABLE_TOO_SMALL = \"TABLE_TOO_SMALL\",\n OFFLINE_ONLY = \"OFFLINE_ONLY\"\n }\n interface V1TableCombination {\n tableIds?: string[];\n tableCombinationConflicts?: TableCombinationConflict[];\n }\n interface TableCombinationConflict {\n /** Conflict type. */\n type?: TableCombinationConflictType;\n }\n enum TableCombinationConflictType {\n UNKNOWN = \"UNKNOWN\",\n RESERVED = \"RESERVED\",\n TOO_BIG = \"TOO_BIG\",\n TOO_SMALL = \"TOO_SMALL\",\n OFFLINE_ONLY = \"OFFLINE_ONLY\"\n }\n interface ReservationLocationConflict {\n /** Reservation location conflict type. */\n type?: Type;\n }\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n PARTY_PACING = \"PARTY_PACING\",\n SEAT_PACING = \"SEAT_PACING\"\n }\n /**\n * Returns list of the time slots.\n * @param reservationLocationId - Reservation location id.\n * @param date - Date.\n * @param partySize - Party size.\n * @internal\n * @documentationMaturity preview\n * @requiredField date\n * @requiredField partySize\n * @requiredField reservationLocationId\n */\n function getTimeSlots(reservationLocationId: string, date: Date, partySize: number | null, options?: GetTimeSlotsOptions): Promise;\n interface GetTimeSlotsOptions {\n /** Duration. */\n duration?: number | null;\n /** Slots before. */\n slotsBefore?: number | null;\n /** Slots after. */\n slotsAfter?: number | null;\n }\n /**\n * Check reservation details.\n * @param reservationLocationId - Reservation location id.\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.date\n * @requiredField options.duration\n * @requiredField options.partySize\n * @requiredField reservationLocationId\n */\n function checkReservationDetails(reservationLocationId: string, options: CheckReservationDetailsOptions): Promise;\n interface CheckReservationDetailsOptions {\n /** Date. */\n date: Date;\n /** Duration. */\n duration: number | null;\n /** Party size. */\n partySize: number | null;\n /** Reservation, that should be ignored during the check. */\n excludeReservationId?: string | null;\n /** Requested table combination. */\n tableIds?: string[];\n }\n \n const tableReservationsV1TimeSlot_universal_d___debug: typeof __debug;\n type tableReservationsV1TimeSlot_universal_d_TimeSlot = TimeSlot;\n type tableReservationsV1TimeSlot_universal_d_Status = Status;\n const tableReservationsV1TimeSlot_universal_d_Status: typeof Status;\n type tableReservationsV1TimeSlot_universal_d_TableCombination = TableCombination;\n type tableReservationsV1TimeSlot_universal_d_GetTimeSlotsRequest = GetTimeSlotsRequest;\n type tableReservationsV1TimeSlot_universal_d_GetTimeSlotsResponse = GetTimeSlotsResponse;\n type tableReservationsV1TimeSlot_universal_d_CheckReservationDetailsRequest = CheckReservationDetailsRequest;\n type tableReservationsV1TimeSlot_universal_d_CheckReservationDetailsResponse = CheckReservationDetailsResponse;\n type tableReservationsV1TimeSlot_universal_d_Table = Table;\n type tableReservationsV1TimeSlot_universal_d_TableConflict = TableConflict;\n type tableReservationsV1TimeSlot_universal_d_TableConflictType = TableConflictType;\n const tableReservationsV1TimeSlot_universal_d_TableConflictType: typeof TableConflictType;\n type tableReservationsV1TimeSlot_universal_d_V1TableCombination = V1TableCombination;\n type tableReservationsV1TimeSlot_universal_d_TableCombinationConflict = TableCombinationConflict;\n type tableReservationsV1TimeSlot_universal_d_TableCombinationConflictType = TableCombinationConflictType;\n const tableReservationsV1TimeSlot_universal_d_TableCombinationConflictType: typeof TableCombinationConflictType;\n type tableReservationsV1TimeSlot_universal_d_ReservationLocationConflict = ReservationLocationConflict;\n type tableReservationsV1TimeSlot_universal_d_Type = Type;\n const tableReservationsV1TimeSlot_universal_d_Type: typeof Type;\n const tableReservationsV1TimeSlot_universal_d_getTimeSlots: typeof getTimeSlots;\n type tableReservationsV1TimeSlot_universal_d_GetTimeSlotsOptions = GetTimeSlotsOptions;\n const tableReservationsV1TimeSlot_universal_d_checkReservationDetails: typeof checkReservationDetails;\n type tableReservationsV1TimeSlot_universal_d_CheckReservationDetailsOptions = CheckReservationDetailsOptions;\n namespace tableReservationsV1TimeSlot_universal_d {\n export {\n tableReservationsV1TimeSlot_universal_d___debug as __debug,\n tableReservationsV1TimeSlot_universal_d_TimeSlot as TimeSlot,\n tableReservationsV1TimeSlot_universal_d_Status as Status,\n tableReservationsV1TimeSlot_universal_d_TableCombination as TableCombination,\n tableReservationsV1TimeSlot_universal_d_GetTimeSlotsRequest as GetTimeSlotsRequest,\n tableReservationsV1TimeSlot_universal_d_GetTimeSlotsResponse as GetTimeSlotsResponse,\n tableReservationsV1TimeSlot_universal_d_CheckReservationDetailsRequest as CheckReservationDetailsRequest,\n tableReservationsV1TimeSlot_universal_d_CheckReservationDetailsResponse as CheckReservationDetailsResponse,\n tableReservationsV1TimeSlot_universal_d_Table as Table,\n tableReservationsV1TimeSlot_universal_d_TableConflict as TableConflict,\n tableReservationsV1TimeSlot_universal_d_TableConflictType as TableConflictType,\n tableReservationsV1TimeSlot_universal_d_V1TableCombination as V1TableCombination,\n tableReservationsV1TimeSlot_universal_d_TableCombinationConflict as TableCombinationConflict,\n tableReservationsV1TimeSlot_universal_d_TableCombinationConflictType as TableCombinationConflictType,\n tableReservationsV1TimeSlot_universal_d_ReservationLocationConflict as ReservationLocationConflict,\n tableReservationsV1TimeSlot_universal_d_Type as Type,\n tableReservationsV1TimeSlot_universal_d_getTimeSlots as getTimeSlots,\n tableReservationsV1TimeSlot_universal_d_GetTimeSlotsOptions as GetTimeSlotsOptions,\n tableReservationsV1TimeSlot_universal_d_checkReservationDetails as checkReservationDetails,\n tableReservationsV1TimeSlot_universal_d_CheckReservationDetailsOptions as CheckReservationDetailsOptions,\n };\n }\n \n export { tableReservationsV1ReservationLocation_universal_d as reservationLocations, tableReservationsV1Reservation_universal_d as reservations, tableReservationsV1TimeSlot_universal_d as timeSlots };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-stores-backend.v2.d.ts", "content": "declare module \"wix-stores-backend.v2\" {\n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 * Custom SEO data for the collection.\n * @internal\n */\n seoSchema?: SeoSchema;\n }\n interface Media {\n /** Primary media (image, video etc) associated with this product. */\n mainMedia?: MediaItem$1;\n /** Media (images, videos etc) associated with this product. */\n items?: MediaItem$1[];\n }\n interface MediaItem$1 extends MediaItemItemOneOf {\n /** Media item thumbnail details. */\n thumbnail?: MediaItemUrlAndSize;\n /** Media item type (image, video, etc.). */\n mediaType?: MediaItemType$1;\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 /** Image data (URL, size). */\n image?: MediaItemUrlAndSize;\n /** Video data (URL, size). */\n video?: MediaItemVideo;\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$1 {\n unspecified_media_item_type = \"unspecified_media_item_type\",\n image = \"image\",\n video = \"video\",\n audio = \"audio\",\n document = \"document\",\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 /**\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?: Tag[];\n /** SEO general settings. */\n settings?: Settings;\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 redirects feature creating `301 redirects` on a slug change is enabled.\n *\n *\n * Default: enabled\n */\n preventAutoRedirect?: boolean;\n }\n interface QueryCollectionsRequest {\n query?: PlatformQuery;\n }\n interface PlatformQuery extends PlatformQueryPagingMethodOneOf {\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting[];\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 /** @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 /** 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 QueryCollectionsResponse {\n collections?: Collection[];\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 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 GetCollectionRequest {\n /** Requested collection ID. */\n _id: string;\n }\n interface GetCollectionResponse {\n collection?: Collection;\n }\n /**\n * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @public */\n function queryCollections(): CollectionsQueryBuilder;\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 CollectionsQueryResult extends QueryOffsetResult {\n items: Collection[];\n query: CollectionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CollectionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: string, value: any) => CollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: string, value: any) => CollectionsQueryBuilder;\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) => CollectionsQueryBuilder;\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[]) => CollectionsQueryBuilder;\n in: (propertyName: string, value: any) => CollectionsQueryBuilder;\n exists: (propertyName: string, value: boolean) => CollectionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: string[]) => CollectionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: string[]) => CollectionsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => CollectionsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => CollectionsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Retrieves a collection with the provided ID.\n * @param _id - Requested collection ID.\n * @public\n * @requiredField _id\n */\n function getCollection(_id: string): Promise;\n \n type storesCatalogV1Collection_universal_d_Collection = Collection;\n type storesCatalogV1Collection_universal_d_Media = Media;\n type storesCatalogV1Collection_universal_d_MediaItemItemOneOf = MediaItemItemOneOf;\n type storesCatalogV1Collection_universal_d_MediaItemUrlAndSize = MediaItemUrlAndSize;\n type storesCatalogV1Collection_universal_d_MediaItemVideo = MediaItemVideo;\n type storesCatalogV1Collection_universal_d_SeoSchema = SeoSchema;\n type storesCatalogV1Collection_universal_d_Tag = Tag;\n type storesCatalogV1Collection_universal_d_Settings = Settings;\n type storesCatalogV1Collection_universal_d_QueryCollectionsRequest = QueryCollectionsRequest;\n type storesCatalogV1Collection_universal_d_PlatformQuery = PlatformQuery;\n type storesCatalogV1Collection_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type storesCatalogV1Collection_universal_d_Sorting = Sorting;\n type storesCatalogV1Collection_universal_d_SortOrder = SortOrder;\n const storesCatalogV1Collection_universal_d_SortOrder: typeof SortOrder;\n type storesCatalogV1Collection_universal_d_PlatformPaging = PlatformPaging;\n type storesCatalogV1Collection_universal_d_CursorPaging = CursorPaging;\n type storesCatalogV1Collection_universal_d_QueryCollectionsResponse = QueryCollectionsResponse;\n type storesCatalogV1Collection_universal_d_PlatformPagingMetadata = PlatformPagingMetadata;\n type storesCatalogV1Collection_universal_d_Cursors = Cursors;\n type storesCatalogV1Collection_universal_d_GetCollectionRequest = GetCollectionRequest;\n type storesCatalogV1Collection_universal_d_GetCollectionResponse = GetCollectionResponse;\n const storesCatalogV1Collection_universal_d_queryCollections: typeof queryCollections;\n type storesCatalogV1Collection_universal_d_CollectionsQueryResult = CollectionsQueryResult;\n type storesCatalogV1Collection_universal_d_CollectionsQueryBuilder = CollectionsQueryBuilder;\n const storesCatalogV1Collection_universal_d_getCollection: typeof getCollection;\n namespace storesCatalogV1Collection_universal_d {\n export {\n __debug$2 as __debug,\n storesCatalogV1Collection_universal_d_Collection as Collection,\n storesCatalogV1Collection_universal_d_Media as Media,\n MediaItem$1 as MediaItem,\n storesCatalogV1Collection_universal_d_MediaItemItemOneOf as MediaItemItemOneOf,\n storesCatalogV1Collection_universal_d_MediaItemUrlAndSize as MediaItemUrlAndSize,\n MediaItemType$1 as MediaItemType,\n storesCatalogV1Collection_universal_d_MediaItemVideo as MediaItemVideo,\n storesCatalogV1Collection_universal_d_SeoSchema as SeoSchema,\n storesCatalogV1Collection_universal_d_Tag as Tag,\n storesCatalogV1Collection_universal_d_Settings as Settings,\n storesCatalogV1Collection_universal_d_QueryCollectionsRequest as QueryCollectionsRequest,\n storesCatalogV1Collection_universal_d_PlatformQuery as PlatformQuery,\n storesCatalogV1Collection_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf,\n storesCatalogV1Collection_universal_d_Sorting as Sorting,\n storesCatalogV1Collection_universal_d_SortOrder as SortOrder,\n storesCatalogV1Collection_universal_d_PlatformPaging as PlatformPaging,\n storesCatalogV1Collection_universal_d_CursorPaging as CursorPaging,\n storesCatalogV1Collection_universal_d_QueryCollectionsResponse as QueryCollectionsResponse,\n storesCatalogV1Collection_universal_d_PlatformPagingMetadata as PlatformPagingMetadata,\n storesCatalogV1Collection_universal_d_Cursors as Cursors,\n storesCatalogV1Collection_universal_d_GetCollectionRequest as GetCollectionRequest,\n storesCatalogV1Collection_universal_d_GetCollectionResponse as GetCollectionResponse,\n storesCatalogV1Collection_universal_d_queryCollections as queryCollections,\n storesCatalogV1Collection_universal_d_CollectionsQueryResult as CollectionsQueryResult,\n storesCatalogV1Collection_universal_d_CollectionsQueryBuilder as CollectionsQueryBuilder,\n storesCatalogV1Collection_universal_d_getCollection as getCollection,\n };\n }\n \n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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?: InvoiceInfo;\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?: Refund[];\n /**\n * Gift card information.\n * @internal\n */\n giftCard?: GiftCard;\n /**\n * ID of the checkout associated with this order.\n * @internal\n */\n checkoutId?: string | null;\n /**\n * Private API flag that allows using read-only \"id\" during order creation\n * @internal\n */\n isInternalOrderCreate?: boolean;\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 * Contact Id. needed for cases where the user is the buyer and so it doesn't exist on the buyer info\n * @internal\n * @readonly\n */\n contactId?: string | null;\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 /** 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 /** Address line 1 (free text) */\n addressLine1?: string;\n /** Address line 1 (street) */\n street?: Street;\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 /** tax type */\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 /** Shipping option name. */\n deliveryOption?: string;\n /** Shipping option delivery time. */\n estimatedDeliveryTime?: string | null;\n /** 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 /** Shipment details (when this object describes shipment). */\n shipmentDetails?: ShipmentDetails;\n /** Pickup details (when this object describes pickup). */\n pickupDetails?: PickupDetails;\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 * Line item refundedQuantity (from refund). No value means not refunded. Shows the number of line items that were refunded\n * @internal\n * @readonly\n */\n refundedQuantity?: number | null;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL\n * @internal\n */\n digitalFile?: DigitalFile;\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 InvoiceInfo {\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 }\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 /**\n * Interval of recurring payment (optional: default value 1 will be used if not provided)\n * @internal\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: 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 /**\n * Subscription option ID.\n * @internal\n */\n _id?: string | null;\n /** Subscription option title. */\n title?: string;\n /** Subscription option description. */\n description?: string | null;\n }\n interface Refund {\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 /**\n * Deprecated. Use externalRefund.\n * @internal\n */\n isManual?: boolean;\n /**\n * Deprecated. Use payment_provider_transaction_id.\n * @internal\n */\n providerTransactionId?: string | null;\n /**\n * Deprecated. Use id.\n * @internal\n */\n refundId?: string;\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 OrderAddressUpdated {\n /**\n * Updated order data.\n * @readonly\n */\n order?: Order;\n }\n interface CreateOrderRequest {\n order: Order;\n /**\n * Additional order settings.\n * @internal\n */\n additionalOrderSettings?: AdditionalOrderSettings[];\n }\n interface AdditionalOrderSettings {\n /** ID of the line item this setting applies to */\n lineItemId?: string | null;\n /** Whether this line item purchase was made as part of a purchase that includes preorder items. */\n preorderRequest?: boolean;\n }\n interface CreateOrderResponse {\n order?: Order;\n }\n interface BulkFulfillOrdersRequest {\n filter: Record | null;\n /** when true shipping confirmation email will be sent to the buyer for all orders with shipment delivery */\n sendShippingConfirmationEmail?: boolean;\n /** when true pickup ready email will be sent to the buyer for all orders with pickup delivery */\n sendPickupReadyEmail?: boolean;\n }\n interface BulkFulfillOrdersResponse {\n }\n interface BulkMarkOrdersAsPaidRequest {\n filter: Record | null;\n }\n interface BulkMarkOrdersAsPaidResponse {\n }\n interface BulkArchiveOrdersRequest {\n filter: Record | null;\n }\n interface BulkArchiveOrdersResponse {\n }\n interface BulkUnarchiveOrdersRequest {\n filter: Record | null;\n }\n interface BulkUnarchiveOrdersResponse {\n }\n interface AddFulfillerEmailWasSentActivityRequest {\n orderId: string;\n }\n interface AddFulfillerEmailWasSentActivityResponse {\n }\n interface DeclineOrderRequest {\n orderId: string;\n eventTime?: Date;\n reason?: string | null;\n }\n interface DeclineOrderResponse {\n }\n interface UpdateOrderEmailRequest {\n /**\n * Order ID.\n * @readonly\n */\n orderId: string;\n /** New email address for billing and shipping info. */\n email?: string;\n }\n interface UpdateOrderEmailResponse {\n /** Updated order data. */\n order?: Order;\n }\n interface UpdateOrderShippingAddressRequest {\n /**\n * Order ID.\n * @readonly\n */\n orderId: string;\n /** New order shipping address. */\n shippingAddress?: Address;\n }\n interface UpdateOrderShippingAddressResponse {\n /** Updated order data. */\n order?: Order;\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 OrderCreated {\n /** Order ID (auto generated upon order creation) */\n orderId?: string;\n /** ID displayed in the owner's store (auto generated) */\n number?: string;\n /** Order creation date */\n dateCreated?: Date;\n /** Customer information */\n buyerInfo?: BuyerInfo;\n /** Currency used for pricing in this store */\n currency?: string;\n /** Weight unit used in this store */\n weightUnit?: WeightUnit;\n /** Totals for order's line items */\n totals?: Totals;\n /** Whether the order was read by the store owner */\n read?: boolean;\n /** Order archive status */\n archived?: boolean;\n /** Order payment status */\n paymentStatus?: PaymentStatus;\n /** Order fulfillment status */\n fulfillmentStatus?: FulfillmentStatus;\n /** @internal */\n ordersExperiments?: OrdersExperiments;\n /**\n * Checkout id\n * @internal\n */\n checkoutId?: string | null;\n /**\n * Applied coupon\n * @internal\n */\n appliedCoupon?: AppliedCoupon;\n /**\n * Subscription information\n * @internal\n */\n subscriptionInfo?: SubscriptionInfo;\n /** @internal */\n cartId?: string | null;\n /**\n * Billing information.\n * @internal\n */\n billingInfo?: BillingInfo;\n }\n interface OrdersExperiments {\n epCommitTax?: boolean;\n moveMerchantEmailToEp?: boolean;\n moveBuyerOrderConfirmationEmailToEp?: boolean;\n producedByEpBridge?: boolean;\n }\n interface OrderPaid {\n /** Paid order data. */\n order?: Order;\n /** @internal */\n ordersExperiments?: OrdersExperiments;\n }\n interface OrderCancelRefundEvent {\n /** @readonly */\n isCancel?: boolean;\n /**\n * date when cancel/refund was issued\n * @readonly\n */\n issueDate?: Date;\n /** will be defined if order was refunded */\n refund?: Refund;\n orderData?: OrderData;\n }\n interface OrderData {\n /**\n * Order ID (auto generated upon order creation)\n * @readonly\n */\n orderId?: string;\n /**\n * means that order paid with cash, such orders might be not paid\n * @readonly\n */\n isOffline?: boolean;\n /**\n * Order payment status\n * @readonly\n */\n paymentStatus?: PaymentStatus;\n /** Total price charged when order placed, this value isn't affected by refunds */\n originalTotal?: string;\n /**\n * Order creation date\n * @readonly\n */\n dateCreated?: Date;\n }\n interface OrderCanceled {\n /**\n * Canceled order data.\n * @readonly\n */\n order?: Order;\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 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;\n /** Order fulfillment status. */\n fulfillmentStatus?: FulfillmentStatus;\n /** Fulfillment tracking information. */\n trackingInfo?: FulfillmentTrackingInfo;\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?: FulfillmentTrackingInfo;\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;\n }\n interface OrderDeclined {\n order?: Order;\n }\n interface GetOrderRequestV2 {\n /** Requested order ID */\n _id: string;\n }\n interface GetOrderResponseV2 {\n /** Order data */\n order?: Order;\n }\n interface QueryOrdersRequestV2 {\n /** Query */\n query?: Query;\n }\n interface Query {\n paging?: Paging;\n /** A filter string */\n filter?: string | null;\n /** A sort string */\n sort?: string | null;\n }\n interface Paging {\n /** Number of items to load */\n limit?: number | null;\n /** The offset since the beginning of the collection */\n offset?: number | null;\n }\n interface QueryOrdersResponseV2 {\n /** Order data */\n orders?: Order[];\n /** Paging metadata */\n metadata?: PagingMetadata;\n /** Total results */\n totalResults?: number;\n }\n interface PagingMetadata {\n /** Requested number of items to load */\n items?: number;\n /** Requested offset since the beginning of the collection */\n offset?: number;\n }\n interface CreateFulfillmentRequest {\n /** Order ID (to which the fulfillment will be related). */\n orderId: string;\n /** Fulfillment info. */\n fulfillment: Fulfillment;\n }\n interface CreateFulfillmentResponse {\n /** Fulfillment ID. */\n _id?: string;\n /** Updated order data. */\n order?: Order;\n }\n interface UpdateFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID */\n fulfillmentId: string;\n /** Updated tracking info. */\n fulfillmentTrackingInfo?: FulfillmentTrackingInfo;\n }\n interface UpdateFulfillmentResponse {\n /** Updated order data. */\n order?: Order;\n }\n interface DeleteFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID. */\n fulfillmentId: string;\n }\n interface DeleteFulfillmentResponse {\n /** Updated order data. */\n order?: Order;\n }\n interface MarkAsPaidRequest {\n /** The order id */\n _id: string;\n /** The payment info */\n paymentInfo: RequestPaymentInfo;\n }\n interface RequestPaymentInfo {\n /** Payment method used for this order */\n paymentMethod?: string;\n /** External transaction ID */\n externalTransactionId?: string;\n }\n interface MarkAsPaidResponse {\n }\n interface SetShippingFulfillmentRequest {\n /** The order id */\n _id: string;\n /** Shipment fulfillment status */\n status?: ShipmentFulfillmentStatus;\n }\n /** This may be expanded in the future to include partial fulfillments */\n enum ShipmentFulfillmentStatus {\n /** Shipment fulfillment status can't be classified, due to an error */\n UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS = \"UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS\",\n /** Entire order's shipment is not fulfilled */\n SHIPMENT_NOT_FULFILLED = \"SHIPMENT_NOT_FULFILLED\",\n /** Entire order's shipment is fulfilled */\n SHIPMENT_FULFILLED = \"SHIPMENT_FULFILLED\"\n }\n interface SetShippingFulfillmentResponse {\n }\n interface SendFulfillmentConfirmationRequest {\n /** The order id */\n _id: string;\n }\n interface SendFulfillmentConfirmationResponse {\n }\n interface MarkAsReadRequest {\n /** The order id */\n _id: string;\n }\n interface MarkAsReadResponse {\n }\n interface SetArchiveStatusRequest {\n /** The order id */\n _id: string;\n /** New archive status */\n archived?: boolean;\n }\n interface SetArchiveStatusResponse {\n }\n /**\n * Creates a new order.\n *\n * > **Notes:**\n * > + Only orders with the `paymentStatus` parameter set as `\"PAID\"` or `\"NOT_PAID\"` will show up in the site owner's Stores Orders tab in their dashboard.\n * > + The `billingInfo.paymentProviderTransactionId` and `billingInfo.paymentMethod` parameters can only be passed when paymentStatus is PAID.\n * > + The `billingInfo`.address parameter is required unless `channelInfo.type: \"POS\"`.\n * > + The `shippingInfo.shipmentDetails.address` parameter is required unless one of the following is true:\n * > + The `shippingInfo.pickupDetails` is passed instead\n * > + `channelInfo.type: \"POS\"`\n * > + All order items are of type digital - `lineItems.lineItemType: \"DIGITAL\"`.\n * > + When passing `lineItems.variantId`, `lineItems.options` is required.\n * > + When passing `lineItems.productId`, `lineItem.lineItemType` is limited to `\"PHYSICAL\"`.\n * > + When not passing `lineItems.productId`, `lineItem.lineItemType` is limited to `\"CUSTOM_AMOUNT_ITEM\"`.\n * @public\n * @requiredField order\n * @requiredField order.totals\n */\n function createOrder(order: Order, options?: CreateOrderOptions): Promise;\n interface CreateOrderOptions {\n /**\n * Additional order settings.\n * @internal\n */\n additionalOrderSettings?: AdditionalOrderSettings[];\n }\n /** @requiredField filter */\n function bulkFulfillOrders(filter: Record | null, options?: BulkFulfillOrdersOptions): Promise;\n interface BulkFulfillOrdersOptions {\n /** when true shipping confirmation email will be sent to the buyer for all orders with shipment delivery */\n sendShippingConfirmationEmail?: boolean;\n /** when true pickup ready email will be sent to the buyer for all orders with pickup delivery */\n sendPickupReadyEmail?: boolean;\n }\n /** @requiredField filter */\n function bulkMarkOrdersAsPaid(filter: Record | null): Promise;\n /** @requiredField filter */\n function bulkArchiveOrders(filter: Record | null): Promise;\n /** @requiredField filter */\n function bulkUnarchiveOrders(filter: Record | null): Promise;\n /** @requiredField orderId */\n function addFulfillerEmailWasSentActivity(orderId: string): Promise;\n /** @requiredField orderId */\n function declineOrder(orderId: string, options?: DeclineOrderOptions): Promise;\n interface DeclineOrderOptions {\n eventTime?: Date;\n reason?: string | null;\n }\n /**\n * Updates the email address of a specified order's billing info.\n * If shipping was selected as the delivery method, shipping info email will also be updated.\n * @param orderId - Order ID.\n * @public\n * @requiredField orderId\n */\n function updateOrderEmail(orderId: string, options?: UpdateOrderEmailOptions): Promise;\n interface UpdateOrderEmailOptions {\n /** New email address for billing and shipping info. */\n email?: string;\n }\n /**\n * Updates the shipping address of a specified order.\n * @param orderId - Order ID.\n * @public\n * @requiredField orderId\n */\n function updateOrderShippingAddress(orderId: string, options?: UpdateOrderShippingAddressOptions): Promise;\n interface UpdateOrderShippingAddressOptions {\n /** New order shipping address. */\n shippingAddress?: Address;\n }\n /**\n * Returns an order with the provided ID\n * @param _id - Requested order ID\n * @public\n * @requiredField _id\n */\n function getOrder(_id: string): Promise;\n /**\n * Returns a list of up to 100 orders, given the provided paging, sorting and filters.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * Hidden orders are not returned\n * @public */\n function queryOrders(options?: QueryOrdersOptions): Promise;\n interface QueryOrdersOptions {\n /** Query */\n query?: Query;\n }\n /** Temp method for analytics migration */\n function queryOrdersEventuallyConsistent(options?: QueryOrdersEventuallyConsistentOptions): Promise;\n interface QueryOrdersEventuallyConsistentOptions {\n /** Query */\n query?: Query;\n }\n /**\n * Creates a fulfillment (a subset of an order, with line items that are being shipped together) based on the body parameters passed with the request.\n * If the site owner has requested it, calling this request will trigger an email to the customer (based on the Wix store settings)\n * @param orderId - Order ID (to which the fulfillment will be related).\n * @param fulfillment - Fulfillment info.\n * @public\n * @requiredField fulfillment\n * @requiredField orderId\n */\n function createFulfillment(orderId: string, fulfillment: Fulfillment): Promise;\n /**\n * Updates an existing fulfillment\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.fulfillmentId\n * @requiredField identifiers.orderId\n */\n function updateFulfillment(identifiers: UpdateFulfillmentIdentifiers, options?: UpdateFulfillmentOptions): Promise;\n interface UpdateFulfillmentIdentifiers {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID */\n fulfillmentId: string;\n }\n interface UpdateFulfillmentOptions {\n /** Updated tracking info. */\n fulfillmentTrackingInfo?: FulfillmentTrackingInfo;\n }\n /**\n * Deletes an existing fulfillment\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.fulfillmentId\n * @requiredField identifiers.orderId\n */\n function deleteFulfillment(identifiers: DeleteFulfillmentIdentifiers): Promise;\n interface DeleteFulfillmentIdentifiers {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID. */\n fulfillmentId: string;\n }\n /**\n * Add payment data for an order\n * @param _id - The order id\n * @param paymentInfo - The payment info\n * @requiredField _id\n * @requiredField paymentInfo\n */\n function markAsPaid(_id: string, paymentInfo: RequestPaymentInfo): Promise;\n /**\n * Set order's shipping's fulfillment status\n * @param _id - The order id\n * @requiredField _id\n */\n function setShippingFulfillment(_id: string, options?: SetShippingFulfillmentOptions): Promise;\n interface SetShippingFulfillmentOptions {\n /** Shipment fulfillment status */\n status?: ShipmentFulfillmentStatus;\n }\n /**\n * Send confirmation mail for either pickup/shipment fulfillment\n * @param _id - The order id\n * @requiredField _id\n */\n function sendFulfillmentConfirmation(_id: string): Promise;\n /**\n * Mark order as read\n * @param _id - The order id\n * @requiredField _id\n */\n function markAsRead(_id: string): Promise;\n /**\n * Set order's archive status\n * @param _id - The order id\n * @requiredField _id\n */\n function setArchiveStatus(_id: string, options?: SetArchiveStatusOptions): Promise;\n interface SetArchiveStatusOptions {\n /** New archive status */\n archived?: boolean;\n }\n \n type storesV2Orders_universal_d_Order = Order;\n type storesV2Orders_universal_d_BuyerInfo = BuyerInfo;\n type storesV2Orders_universal_d_IdentityType = IdentityType;\n const storesV2Orders_universal_d_IdentityType: typeof IdentityType;\n type storesV2Orders_universal_d_WeightUnit = WeightUnit;\n const storesV2Orders_universal_d_WeightUnit: typeof WeightUnit;\n type storesV2Orders_universal_d_Totals = Totals;\n type storesV2Orders_universal_d_BillingInfo = BillingInfo;\n type storesV2Orders_universal_d_Address = Address;\n type storesV2Orders_universal_d_AddressAddressLine1OptionsOneOf = AddressAddressLine1OptionsOneOf;\n type storesV2Orders_universal_d_FullName = FullName;\n type storesV2Orders_universal_d_Street = Street;\n type storesV2Orders_universal_d_VatId = VatId;\n type storesV2Orders_universal_d_VatType = VatType;\n const storesV2Orders_universal_d_VatType: typeof VatType;\n type storesV2Orders_universal_d_ShippingInfo = ShippingInfo;\n type storesV2Orders_universal_d_ShippingInfoDetailsOneOf = ShippingInfoDetailsOneOf;\n type storesV2Orders_universal_d_ShipmentDetails = ShipmentDetails;\n type storesV2Orders_universal_d_TrackingInfo = TrackingInfo;\n type storesV2Orders_universal_d_ShippingPriceData = ShippingPriceData;\n type storesV2Orders_universal_d_PickupDetails = PickupDetails;\n type storesV2Orders_universal_d_PickupAddress = PickupAddress;\n type storesV2Orders_universal_d_BuyerDetails = BuyerDetails;\n type storesV2Orders_universal_d_PaymentStatus = PaymentStatus;\n const storesV2Orders_universal_d_PaymentStatus: typeof PaymentStatus;\n type storesV2Orders_universal_d_FulfillmentStatus = FulfillmentStatus;\n const storesV2Orders_universal_d_FulfillmentStatus: typeof FulfillmentStatus;\n type storesV2Orders_universal_d_LineItem = LineItem;\n type storesV2Orders_universal_d_LineItemType = LineItemType;\n const storesV2Orders_universal_d_LineItemType: typeof LineItemType;\n type storesV2Orders_universal_d_OptionSelection = OptionSelection;\n type storesV2Orders_universal_d_CustomTextFieldSelection = CustomTextFieldSelection;\n type storesV2Orders_universal_d_MediaItem = MediaItem;\n type storesV2Orders_universal_d_MediaItemType = MediaItemType;\n const storesV2Orders_universal_d_MediaItemType: typeof MediaItemType;\n type storesV2Orders_universal_d_LineItemPriceData = LineItemPriceData;\n type storesV2Orders_universal_d_DigitalFile = DigitalFile;\n type storesV2Orders_universal_d_Activity = Activity;\n type storesV2Orders_universal_d_ActivityType = ActivityType;\n const storesV2Orders_universal_d_ActivityType: typeof ActivityType;\n type storesV2Orders_universal_d_InvoiceInfo = InvoiceInfo;\n type storesV2Orders_universal_d_InvoiceSource = InvoiceSource;\n const storesV2Orders_universal_d_InvoiceSource: typeof InvoiceSource;\n type storesV2Orders_universal_d_Fulfillment = Fulfillment;\n type storesV2Orders_universal_d_FulfillmentLineItem = FulfillmentLineItem;\n type storesV2Orders_universal_d_FulfillmentTrackingInfo = FulfillmentTrackingInfo;\n type storesV2Orders_universal_d_Discount = Discount;\n type storesV2Orders_universal_d_AppliedCoupon = AppliedCoupon;\n type storesV2Orders_universal_d_CustomField = CustomField;\n type storesV2Orders_universal_d_ChannelInfo = ChannelInfo;\n type storesV2Orders_universal_d_ChannelType = ChannelType;\n const storesV2Orders_universal_d_ChannelType: typeof ChannelType;\n type storesV2Orders_universal_d_EnteredBy = EnteredBy;\n type storesV2Orders_universal_d_EnteredByIdentityType = EnteredByIdentityType;\n const storesV2Orders_universal_d_EnteredByIdentityType: typeof EnteredByIdentityType;\n type storesV2Orders_universal_d_SubscriptionInfo = SubscriptionInfo;\n type storesV2Orders_universal_d_SubscriptionSettings = SubscriptionSettings;\n type storesV2Orders_universal_d_SubscriptionFrequency = SubscriptionFrequency;\n const storesV2Orders_universal_d_SubscriptionFrequency: typeof SubscriptionFrequency;\n type storesV2Orders_universal_d_SubscriptionOptionInfo = SubscriptionOptionInfo;\n type storesV2Orders_universal_d_Refund = Refund;\n type storesV2Orders_universal_d_GiftCard = GiftCard;\n type storesV2Orders_universal_d_OrderAddressUpdated = OrderAddressUpdated;\n type storesV2Orders_universal_d_CreateOrderRequest = CreateOrderRequest;\n type storesV2Orders_universal_d_AdditionalOrderSettings = AdditionalOrderSettings;\n type storesV2Orders_universal_d_CreateOrderResponse = CreateOrderResponse;\n type storesV2Orders_universal_d_BulkFulfillOrdersRequest = BulkFulfillOrdersRequest;\n type storesV2Orders_universal_d_BulkFulfillOrdersResponse = BulkFulfillOrdersResponse;\n type storesV2Orders_universal_d_BulkMarkOrdersAsPaidRequest = BulkMarkOrdersAsPaidRequest;\n type storesV2Orders_universal_d_BulkMarkOrdersAsPaidResponse = BulkMarkOrdersAsPaidResponse;\n type storesV2Orders_universal_d_BulkArchiveOrdersRequest = BulkArchiveOrdersRequest;\n type storesV2Orders_universal_d_BulkArchiveOrdersResponse = BulkArchiveOrdersResponse;\n type storesV2Orders_universal_d_BulkUnarchiveOrdersRequest = BulkUnarchiveOrdersRequest;\n type storesV2Orders_universal_d_BulkUnarchiveOrdersResponse = BulkUnarchiveOrdersResponse;\n type storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityRequest = AddFulfillerEmailWasSentActivityRequest;\n type storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityResponse = AddFulfillerEmailWasSentActivityResponse;\n type storesV2Orders_universal_d_DeclineOrderRequest = DeclineOrderRequest;\n type storesV2Orders_universal_d_DeclineOrderResponse = DeclineOrderResponse;\n type storesV2Orders_universal_d_UpdateOrderEmailRequest = UpdateOrderEmailRequest;\n type storesV2Orders_universal_d_UpdateOrderEmailResponse = UpdateOrderEmailResponse;\n type storesV2Orders_universal_d_UpdateOrderShippingAddressRequest = UpdateOrderShippingAddressRequest;\n type storesV2Orders_universal_d_UpdateOrderShippingAddressResponse = UpdateOrderShippingAddressResponse;\n type storesV2Orders_universal_d_DiffmatokyPayload = DiffmatokyPayload;\n type storesV2Orders_universal_d_ErrorInformation = ErrorInformation;\n type storesV2Orders_universal_d_OrderCreated = OrderCreated;\n type storesV2Orders_universal_d_OrdersExperiments = OrdersExperiments;\n type storesV2Orders_universal_d_OrderPaid = OrderPaid;\n type storesV2Orders_universal_d_OrderCancelRefundEvent = OrderCancelRefundEvent;\n type storesV2Orders_universal_d_OrderData = OrderData;\n type storesV2Orders_universal_d_OrderCanceled = OrderCanceled;\n type storesV2Orders_universal_d_OrderRefunded = OrderRefunded;\n type storesV2Orders_universal_d_FulfillmentCreated = FulfillmentCreated;\n type storesV2Orders_universal_d_FulfillmentUpdated = FulfillmentUpdated;\n type storesV2Orders_universal_d_FulfillmentDeleted = FulfillmentDeleted;\n type storesV2Orders_universal_d_OrderDeclined = OrderDeclined;\n type storesV2Orders_universal_d_GetOrderRequestV2 = GetOrderRequestV2;\n type storesV2Orders_universal_d_GetOrderResponseV2 = GetOrderResponseV2;\n type storesV2Orders_universal_d_QueryOrdersRequestV2 = QueryOrdersRequestV2;\n type storesV2Orders_universal_d_Query = Query;\n type storesV2Orders_universal_d_Paging = Paging;\n type storesV2Orders_universal_d_QueryOrdersResponseV2 = QueryOrdersResponseV2;\n type storesV2Orders_universal_d_PagingMetadata = PagingMetadata;\n type storesV2Orders_universal_d_CreateFulfillmentRequest = CreateFulfillmentRequest;\n type storesV2Orders_universal_d_CreateFulfillmentResponse = CreateFulfillmentResponse;\n type storesV2Orders_universal_d_UpdateFulfillmentRequest = UpdateFulfillmentRequest;\n type storesV2Orders_universal_d_UpdateFulfillmentResponse = UpdateFulfillmentResponse;\n type storesV2Orders_universal_d_DeleteFulfillmentRequest = DeleteFulfillmentRequest;\n type storesV2Orders_universal_d_DeleteFulfillmentResponse = DeleteFulfillmentResponse;\n type storesV2Orders_universal_d_MarkAsPaidRequest = MarkAsPaidRequest;\n type storesV2Orders_universal_d_RequestPaymentInfo = RequestPaymentInfo;\n type storesV2Orders_universal_d_MarkAsPaidResponse = MarkAsPaidResponse;\n type storesV2Orders_universal_d_SetShippingFulfillmentRequest = SetShippingFulfillmentRequest;\n type storesV2Orders_universal_d_ShipmentFulfillmentStatus = ShipmentFulfillmentStatus;\n const storesV2Orders_universal_d_ShipmentFulfillmentStatus: typeof ShipmentFulfillmentStatus;\n type storesV2Orders_universal_d_SetShippingFulfillmentResponse = SetShippingFulfillmentResponse;\n type storesV2Orders_universal_d_SendFulfillmentConfirmationRequest = SendFulfillmentConfirmationRequest;\n type storesV2Orders_universal_d_SendFulfillmentConfirmationResponse = SendFulfillmentConfirmationResponse;\n type storesV2Orders_universal_d_MarkAsReadRequest = MarkAsReadRequest;\n type storesV2Orders_universal_d_MarkAsReadResponse = MarkAsReadResponse;\n type storesV2Orders_universal_d_SetArchiveStatusRequest = SetArchiveStatusRequest;\n type storesV2Orders_universal_d_SetArchiveStatusResponse = SetArchiveStatusResponse;\n const storesV2Orders_universal_d_createOrder: typeof createOrder;\n type storesV2Orders_universal_d_CreateOrderOptions = CreateOrderOptions;\n const storesV2Orders_universal_d_bulkFulfillOrders: typeof bulkFulfillOrders;\n type storesV2Orders_universal_d_BulkFulfillOrdersOptions = BulkFulfillOrdersOptions;\n const storesV2Orders_universal_d_bulkMarkOrdersAsPaid: typeof bulkMarkOrdersAsPaid;\n const storesV2Orders_universal_d_bulkArchiveOrders: typeof bulkArchiveOrders;\n const storesV2Orders_universal_d_bulkUnarchiveOrders: typeof bulkUnarchiveOrders;\n const storesV2Orders_universal_d_addFulfillerEmailWasSentActivity: typeof addFulfillerEmailWasSentActivity;\n const storesV2Orders_universal_d_declineOrder: typeof declineOrder;\n type storesV2Orders_universal_d_DeclineOrderOptions = DeclineOrderOptions;\n const storesV2Orders_universal_d_updateOrderEmail: typeof updateOrderEmail;\n type storesV2Orders_universal_d_UpdateOrderEmailOptions = UpdateOrderEmailOptions;\n const storesV2Orders_universal_d_updateOrderShippingAddress: typeof updateOrderShippingAddress;\n type storesV2Orders_universal_d_UpdateOrderShippingAddressOptions = UpdateOrderShippingAddressOptions;\n const storesV2Orders_universal_d_getOrder: typeof getOrder;\n const storesV2Orders_universal_d_queryOrders: typeof queryOrders;\n type storesV2Orders_universal_d_QueryOrdersOptions = QueryOrdersOptions;\n const storesV2Orders_universal_d_queryOrdersEventuallyConsistent: typeof queryOrdersEventuallyConsistent;\n type storesV2Orders_universal_d_QueryOrdersEventuallyConsistentOptions = QueryOrdersEventuallyConsistentOptions;\n const storesV2Orders_universal_d_createFulfillment: typeof createFulfillment;\n const storesV2Orders_universal_d_updateFulfillment: typeof updateFulfillment;\n type storesV2Orders_universal_d_UpdateFulfillmentIdentifiers = UpdateFulfillmentIdentifiers;\n type storesV2Orders_universal_d_UpdateFulfillmentOptions = UpdateFulfillmentOptions;\n const storesV2Orders_universal_d_deleteFulfillment: typeof deleteFulfillment;\n type storesV2Orders_universal_d_DeleteFulfillmentIdentifiers = DeleteFulfillmentIdentifiers;\n const storesV2Orders_universal_d_markAsPaid: typeof markAsPaid;\n const storesV2Orders_universal_d_setShippingFulfillment: typeof setShippingFulfillment;\n type storesV2Orders_universal_d_SetShippingFulfillmentOptions = SetShippingFulfillmentOptions;\n const storesV2Orders_universal_d_sendFulfillmentConfirmation: typeof sendFulfillmentConfirmation;\n const storesV2Orders_universal_d_markAsRead: typeof markAsRead;\n const storesV2Orders_universal_d_setArchiveStatus: typeof setArchiveStatus;\n type storesV2Orders_universal_d_SetArchiveStatusOptions = SetArchiveStatusOptions;\n namespace storesV2Orders_universal_d {\n export {\n __debug$1 as __debug,\n storesV2Orders_universal_d_Order as Order,\n storesV2Orders_universal_d_BuyerInfo as BuyerInfo,\n storesV2Orders_universal_d_IdentityType as IdentityType,\n storesV2Orders_universal_d_WeightUnit as WeightUnit,\n storesV2Orders_universal_d_Totals as Totals,\n storesV2Orders_universal_d_BillingInfo as BillingInfo,\n storesV2Orders_universal_d_Address as Address,\n storesV2Orders_universal_d_AddressAddressLine1OptionsOneOf as AddressAddressLine1OptionsOneOf,\n storesV2Orders_universal_d_FullName as FullName,\n storesV2Orders_universal_d_Street as Street,\n storesV2Orders_universal_d_VatId as VatId,\n storesV2Orders_universal_d_VatType as VatType,\n storesV2Orders_universal_d_ShippingInfo as ShippingInfo,\n storesV2Orders_universal_d_ShippingInfoDetailsOneOf as ShippingInfoDetailsOneOf,\n storesV2Orders_universal_d_ShipmentDetails as ShipmentDetails,\n storesV2Orders_universal_d_TrackingInfo as TrackingInfo,\n storesV2Orders_universal_d_ShippingPriceData as ShippingPriceData,\n storesV2Orders_universal_d_PickupDetails as PickupDetails,\n storesV2Orders_universal_d_PickupAddress as PickupAddress,\n storesV2Orders_universal_d_BuyerDetails as BuyerDetails,\n storesV2Orders_universal_d_PaymentStatus as PaymentStatus,\n storesV2Orders_universal_d_FulfillmentStatus as FulfillmentStatus,\n storesV2Orders_universal_d_LineItem as LineItem,\n storesV2Orders_universal_d_LineItemType as LineItemType,\n storesV2Orders_universal_d_OptionSelection as OptionSelection,\n storesV2Orders_universal_d_CustomTextFieldSelection as CustomTextFieldSelection,\n storesV2Orders_universal_d_MediaItem as MediaItem,\n storesV2Orders_universal_d_MediaItemType as MediaItemType,\n storesV2Orders_universal_d_LineItemPriceData as LineItemPriceData,\n storesV2Orders_universal_d_DigitalFile as DigitalFile,\n storesV2Orders_universal_d_Activity as Activity,\n storesV2Orders_universal_d_ActivityType as ActivityType,\n storesV2Orders_universal_d_InvoiceInfo as InvoiceInfo,\n storesV2Orders_universal_d_InvoiceSource as InvoiceSource,\n storesV2Orders_universal_d_Fulfillment as Fulfillment,\n storesV2Orders_universal_d_FulfillmentLineItem as FulfillmentLineItem,\n storesV2Orders_universal_d_FulfillmentTrackingInfo as FulfillmentTrackingInfo,\n storesV2Orders_universal_d_Discount as Discount,\n storesV2Orders_universal_d_AppliedCoupon as AppliedCoupon,\n storesV2Orders_universal_d_CustomField as CustomField,\n storesV2Orders_universal_d_ChannelInfo as ChannelInfo,\n storesV2Orders_universal_d_ChannelType as ChannelType,\n storesV2Orders_universal_d_EnteredBy as EnteredBy,\n storesV2Orders_universal_d_EnteredByIdentityType as EnteredByIdentityType,\n storesV2Orders_universal_d_SubscriptionInfo as SubscriptionInfo,\n storesV2Orders_universal_d_SubscriptionSettings as SubscriptionSettings,\n storesV2Orders_universal_d_SubscriptionFrequency as SubscriptionFrequency,\n storesV2Orders_universal_d_SubscriptionOptionInfo as SubscriptionOptionInfo,\n storesV2Orders_universal_d_Refund as Refund,\n storesV2Orders_universal_d_GiftCard as GiftCard,\n storesV2Orders_universal_d_OrderAddressUpdated as OrderAddressUpdated,\n storesV2Orders_universal_d_CreateOrderRequest as CreateOrderRequest,\n storesV2Orders_universal_d_AdditionalOrderSettings as AdditionalOrderSettings,\n storesV2Orders_universal_d_CreateOrderResponse as CreateOrderResponse,\n storesV2Orders_universal_d_BulkFulfillOrdersRequest as BulkFulfillOrdersRequest,\n storesV2Orders_universal_d_BulkFulfillOrdersResponse as BulkFulfillOrdersResponse,\n storesV2Orders_universal_d_BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequest,\n storesV2Orders_universal_d_BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponse,\n storesV2Orders_universal_d_BulkArchiveOrdersRequest as BulkArchiveOrdersRequest,\n storesV2Orders_universal_d_BulkArchiveOrdersResponse as BulkArchiveOrdersResponse,\n storesV2Orders_universal_d_BulkUnarchiveOrdersRequest as BulkUnarchiveOrdersRequest,\n storesV2Orders_universal_d_BulkUnarchiveOrdersResponse as BulkUnarchiveOrdersResponse,\n storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityRequest as AddFulfillerEmailWasSentActivityRequest,\n storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityResponse as AddFulfillerEmailWasSentActivityResponse,\n storesV2Orders_universal_d_DeclineOrderRequest as DeclineOrderRequest,\n storesV2Orders_universal_d_DeclineOrderResponse as DeclineOrderResponse,\n storesV2Orders_universal_d_UpdateOrderEmailRequest as UpdateOrderEmailRequest,\n storesV2Orders_universal_d_UpdateOrderEmailResponse as UpdateOrderEmailResponse,\n storesV2Orders_universal_d_UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequest,\n storesV2Orders_universal_d_UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponse,\n storesV2Orders_universal_d_DiffmatokyPayload as DiffmatokyPayload,\n storesV2Orders_universal_d_ErrorInformation as ErrorInformation,\n storesV2Orders_universal_d_OrderCreated as OrderCreated,\n storesV2Orders_universal_d_OrdersExperiments as OrdersExperiments,\n storesV2Orders_universal_d_OrderPaid as OrderPaid,\n storesV2Orders_universal_d_OrderCancelRefundEvent as OrderCancelRefundEvent,\n storesV2Orders_universal_d_OrderData as OrderData,\n storesV2Orders_universal_d_OrderCanceled as OrderCanceled,\n storesV2Orders_universal_d_OrderRefunded as OrderRefunded,\n storesV2Orders_universal_d_FulfillmentCreated as FulfillmentCreated,\n storesV2Orders_universal_d_FulfillmentUpdated as FulfillmentUpdated,\n storesV2Orders_universal_d_FulfillmentDeleted as FulfillmentDeleted,\n storesV2Orders_universal_d_OrderDeclined as OrderDeclined,\n storesV2Orders_universal_d_GetOrderRequestV2 as GetOrderRequestV2,\n storesV2Orders_universal_d_GetOrderResponseV2 as GetOrderResponseV2,\n storesV2Orders_universal_d_QueryOrdersRequestV2 as QueryOrdersRequestV2,\n storesV2Orders_universal_d_Query as Query,\n storesV2Orders_universal_d_Paging as Paging,\n storesV2Orders_universal_d_QueryOrdersResponseV2 as QueryOrdersResponseV2,\n storesV2Orders_universal_d_PagingMetadata as PagingMetadata,\n storesV2Orders_universal_d_CreateFulfillmentRequest as CreateFulfillmentRequest,\n storesV2Orders_universal_d_CreateFulfillmentResponse as CreateFulfillmentResponse,\n storesV2Orders_universal_d_UpdateFulfillmentRequest as UpdateFulfillmentRequest,\n storesV2Orders_universal_d_UpdateFulfillmentResponse as UpdateFulfillmentResponse,\n storesV2Orders_universal_d_DeleteFulfillmentRequest as DeleteFulfillmentRequest,\n storesV2Orders_universal_d_DeleteFulfillmentResponse as DeleteFulfillmentResponse,\n storesV2Orders_universal_d_MarkAsPaidRequest as MarkAsPaidRequest,\n storesV2Orders_universal_d_RequestPaymentInfo as RequestPaymentInfo,\n storesV2Orders_universal_d_MarkAsPaidResponse as MarkAsPaidResponse,\n storesV2Orders_universal_d_SetShippingFulfillmentRequest as SetShippingFulfillmentRequest,\n storesV2Orders_universal_d_ShipmentFulfillmentStatus as ShipmentFulfillmentStatus,\n storesV2Orders_universal_d_SetShippingFulfillmentResponse as SetShippingFulfillmentResponse,\n storesV2Orders_universal_d_SendFulfillmentConfirmationRequest as SendFulfillmentConfirmationRequest,\n storesV2Orders_universal_d_SendFulfillmentConfirmationResponse as SendFulfillmentConfirmationResponse,\n storesV2Orders_universal_d_MarkAsReadRequest as MarkAsReadRequest,\n storesV2Orders_universal_d_MarkAsReadResponse as MarkAsReadResponse,\n storesV2Orders_universal_d_SetArchiveStatusRequest as SetArchiveStatusRequest,\n storesV2Orders_universal_d_SetArchiveStatusResponse as SetArchiveStatusResponse,\n storesV2Orders_universal_d_createOrder as createOrder,\n storesV2Orders_universal_d_CreateOrderOptions as CreateOrderOptions,\n storesV2Orders_universal_d_bulkFulfillOrders as bulkFulfillOrders,\n storesV2Orders_universal_d_BulkFulfillOrdersOptions as BulkFulfillOrdersOptions,\n storesV2Orders_universal_d_bulkMarkOrdersAsPaid as bulkMarkOrdersAsPaid,\n storesV2Orders_universal_d_bulkArchiveOrders as bulkArchiveOrders,\n storesV2Orders_universal_d_bulkUnarchiveOrders as bulkUnarchiveOrders,\n storesV2Orders_universal_d_addFulfillerEmailWasSentActivity as addFulfillerEmailWasSentActivity,\n storesV2Orders_universal_d_declineOrder as declineOrder,\n storesV2Orders_universal_d_DeclineOrderOptions as DeclineOrderOptions,\n storesV2Orders_universal_d_updateOrderEmail as updateOrderEmail,\n storesV2Orders_universal_d_UpdateOrderEmailOptions as UpdateOrderEmailOptions,\n storesV2Orders_universal_d_updateOrderShippingAddress as updateOrderShippingAddress,\n storesV2Orders_universal_d_UpdateOrderShippingAddressOptions as UpdateOrderShippingAddressOptions,\n storesV2Orders_universal_d_getOrder as getOrder,\n storesV2Orders_universal_d_queryOrders as queryOrders,\n storesV2Orders_universal_d_QueryOrdersOptions as QueryOrdersOptions,\n storesV2Orders_universal_d_queryOrdersEventuallyConsistent as queryOrdersEventuallyConsistent,\n storesV2Orders_universal_d_QueryOrdersEventuallyConsistentOptions as QueryOrdersEventuallyConsistentOptions,\n storesV2Orders_universal_d_createFulfillment as createFulfillment,\n storesV2Orders_universal_d_updateFulfillment as updateFulfillment,\n storesV2Orders_universal_d_UpdateFulfillmentIdentifiers as UpdateFulfillmentIdentifiers,\n storesV2Orders_universal_d_UpdateFulfillmentOptions as UpdateFulfillmentOptions,\n storesV2Orders_universal_d_deleteFulfillment as deleteFulfillment,\n storesV2Orders_universal_d_DeleteFulfillmentIdentifiers as DeleteFulfillmentIdentifiers,\n storesV2Orders_universal_d_markAsPaid as markAsPaid,\n storesV2Orders_universal_d_setShippingFulfillment as setShippingFulfillment,\n storesV2Orders_universal_d_SetShippingFulfillmentOptions as SetShippingFulfillmentOptions,\n storesV2Orders_universal_d_sendFulfillmentConfirmation as sendFulfillmentConfirmation,\n storesV2Orders_universal_d_markAsRead as markAsRead,\n storesV2Orders_universal_d_setArchiveStatus as setArchiveStatus,\n storesV2Orders_universal_d_SetArchiveStatusOptions as SetArchiveStatusOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface WishlistData {\n /** GUID unique to this list for this site */\n _id?: string | null;\n /** Member id the list belongs to */\n ownerId?: string;\n /** List of items in the list. Not necessarily the full list (can depends on request data) */\n items?: WishlistItem[];\n /** Total count of items in the list */\n totalCount?: number;\n }\n interface WishlistItem {\n /** Unique identifier for an item of this type and origin */\n _id?: string;\n /**\n * The data the item was save to the list\n * @readonly\n */\n dateAdded?: Date;\n /** The type of the item. For example \"product\" */\n type?: string;\n /** The origin of the item. Should be the scope the item type is related to. For example \"wixstores\" */\n origin?: string;\n }\n interface ItemsAddedToWishlist {\n /** GUID unique to this list for its site */\n _id?: string | null;\n /** Member id the list belongs to */\n ownerId?: string;\n /** List of items that were added to wishlist */\n items?: WishlistItem[];\n }\n interface ItemsRemovedFromWishlist {\n /** GUID unique to this list for its site */\n _id?: string | null;\n /** Member id the list belongs to */\n ownerId?: string;\n /** List of items that were removed from wishlist */\n items?: WishlistItem[];\n }\n interface GetWishlistRequest {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n interface WishlistItemKind {\n /** The type of the item. For example \"product\" */\n type?: string;\n /** The origin of the item. Should be the scope the item type is related to. For example \"wixstores\" */\n origin?: string;\n }\n interface GetWishlistResponse {\n /** Object containing requested list data */\n wishlist?: WishlistData;\n }\n interface AddToWishlistRequest {\n /** List of items to add to list */\n items?: WishlistItem[];\n }\n interface AddToWishlistResponse {\n }\n interface RemoveFromWishlistRequest {\n /** List of items to remove from list */\n items?: WishlistItem[];\n }\n interface RemoveFromWishlistResponse {\n }\n interface GetWishlistByIdRequest {\n /** Unique identifier representing requested list */\n _id: string;\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n interface GetWishlistByIdResponse {\n /** Object containing requested list data */\n wishlist?: WishlistData;\n }\n interface GetWishlistsRequest {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n }\n interface GetWishlistsResponse {\n /** List result of requested wishlists */\n wishlists?: WishlistData[];\n }\n /**\n * Get default wishlist by context's member and site\n * @internal\n * @documentationMaturity preview\n */\n function getWishlist(options?: GetWishlistOptions): Promise;\n interface GetWishlistOptions {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n /**\n * Add items to default wishlist by context's member and site\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items._id\n * @requiredField options.items.origin\n * @requiredField options.items.type\n */\n function addToWishlist(options?: AddToWishlistOptions): Promise;\n interface AddToWishlistOptions {\n /** List of items to add to list */\n items?: WishlistItem[];\n }\n /**\n * Remove items to default wishlist by context's member and site\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items._id\n * @requiredField options.items.origin\n * @requiredField options.items.type\n */\n function removeFromWishlist(options?: RemoveFromWishlistOptions): Promise;\n interface RemoveFromWishlistOptions {\n /** List of items to remove from list */\n items?: WishlistItem[];\n }\n /**\n * Get wishlist by id\n * @param _id - Unique identifier representing requested list\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @returns Object containing requested list data\n */\n function getWishlistById(_id: string, options?: GetWishlistByIdOptions): Promise;\n interface GetWishlistByIdOptions {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n /**\n * Get wishlists of site\n * @internal\n * @documentationMaturity preview\n */\n function getWishlists(options?: GetWishlistsOptions): Promise;\n interface GetWishlistsOptions {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n }\n \n const platformV1Wishlist_universal_d___debug: typeof __debug;\n type platformV1Wishlist_universal_d_WishlistData = WishlistData;\n type platformV1Wishlist_universal_d_WishlistItem = WishlistItem;\n type platformV1Wishlist_universal_d_ItemsAddedToWishlist = ItemsAddedToWishlist;\n type platformV1Wishlist_universal_d_ItemsRemovedFromWishlist = ItemsRemovedFromWishlist;\n type platformV1Wishlist_universal_d_GetWishlistRequest = GetWishlistRequest;\n type platformV1Wishlist_universal_d_WishlistItemKind = WishlistItemKind;\n type platformV1Wishlist_universal_d_GetWishlistResponse = GetWishlistResponse;\n type platformV1Wishlist_universal_d_AddToWishlistRequest = AddToWishlistRequest;\n type platformV1Wishlist_universal_d_AddToWishlistResponse = AddToWishlistResponse;\n type platformV1Wishlist_universal_d_RemoveFromWishlistRequest = RemoveFromWishlistRequest;\n type platformV1Wishlist_universal_d_RemoveFromWishlistResponse = RemoveFromWishlistResponse;\n type platformV1Wishlist_universal_d_GetWishlistByIdRequest = GetWishlistByIdRequest;\n type platformV1Wishlist_universal_d_GetWishlistByIdResponse = GetWishlistByIdResponse;\n type platformV1Wishlist_universal_d_GetWishlistsRequest = GetWishlistsRequest;\n type platformV1Wishlist_universal_d_GetWishlistsResponse = GetWishlistsResponse;\n const platformV1Wishlist_universal_d_getWishlist: typeof getWishlist;\n type platformV1Wishlist_universal_d_GetWishlistOptions = GetWishlistOptions;\n const platformV1Wishlist_universal_d_addToWishlist: typeof addToWishlist;\n type platformV1Wishlist_universal_d_AddToWishlistOptions = AddToWishlistOptions;\n const platformV1Wishlist_universal_d_removeFromWishlist: typeof removeFromWishlist;\n type platformV1Wishlist_universal_d_RemoveFromWishlistOptions = RemoveFromWishlistOptions;\n const platformV1Wishlist_universal_d_getWishlistById: typeof getWishlistById;\n type platformV1Wishlist_universal_d_GetWishlistByIdOptions = GetWishlistByIdOptions;\n const platformV1Wishlist_universal_d_getWishlists: typeof getWishlists;\n type platformV1Wishlist_universal_d_GetWishlistsOptions = GetWishlistsOptions;\n namespace platformV1Wishlist_universal_d {\n export {\n platformV1Wishlist_universal_d___debug as __debug,\n platformV1Wishlist_universal_d_WishlistData as WishlistData,\n platformV1Wishlist_universal_d_WishlistItem as WishlistItem,\n platformV1Wishlist_universal_d_ItemsAddedToWishlist as ItemsAddedToWishlist,\n platformV1Wishlist_universal_d_ItemsRemovedFromWishlist as ItemsRemovedFromWishlist,\n platformV1Wishlist_universal_d_GetWishlistRequest as GetWishlistRequest,\n platformV1Wishlist_universal_d_WishlistItemKind as WishlistItemKind,\n platformV1Wishlist_universal_d_GetWishlistResponse as GetWishlistResponse,\n platformV1Wishlist_universal_d_AddToWishlistRequest as AddToWishlistRequest,\n platformV1Wishlist_universal_d_AddToWishlistResponse as AddToWishlistResponse,\n platformV1Wishlist_universal_d_RemoveFromWishlistRequest as RemoveFromWishlistRequest,\n platformV1Wishlist_universal_d_RemoveFromWishlistResponse as RemoveFromWishlistResponse,\n platformV1Wishlist_universal_d_GetWishlistByIdRequest as GetWishlistByIdRequest,\n platformV1Wishlist_universal_d_GetWishlistByIdResponse as GetWishlistByIdResponse,\n platformV1Wishlist_universal_d_GetWishlistsRequest as GetWishlistsRequest,\n platformV1Wishlist_universal_d_GetWishlistsResponse as GetWishlistsResponse,\n platformV1Wishlist_universal_d_getWishlist as getWishlist,\n platformV1Wishlist_universal_d_GetWishlistOptions as GetWishlistOptions,\n platformV1Wishlist_universal_d_addToWishlist as addToWishlist,\n platformV1Wishlist_universal_d_AddToWishlistOptions as AddToWishlistOptions,\n platformV1Wishlist_universal_d_removeFromWishlist as removeFromWishlist,\n platformV1Wishlist_universal_d_RemoveFromWishlistOptions as RemoveFromWishlistOptions,\n platformV1Wishlist_universal_d_getWishlistById as getWishlistById,\n platformV1Wishlist_universal_d_GetWishlistByIdOptions as GetWishlistByIdOptions,\n platformV1Wishlist_universal_d_getWishlists as getWishlists,\n platformV1Wishlist_universal_d_GetWishlistsOptions as GetWishlistsOptions,\n };\n }\n \n export { storesCatalogV1Collection_universal_d as collections, storesV2Orders_universal_d as orders, platformV1Wishlist_universal_d as wishlist };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-members-followers-backend.v3.d.ts", "content": "declare module \"wix-members-followers-backend.v3\" {\n interface Follower {\n /** Member ID of the member who performed the action. */\n memberId?: string;\n /** Member ID of the member being followed or unfollowed. */\n affectedMemberId?: string;\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 FollowMemberRequest {\n /** The ID of the member who you want to follow. */\n memberId: string;\n }\n interface FollowMemberResponse {\n }\n interface MemberFollowed {\n /** Member who is following the other member. */\n memberConnection?: Follower;\n }\n interface UnfollowMemberRequest {\n /** The ID of the member who you want to unfollow. */\n memberId: string;\n }\n interface UnfollowMemberResponse {\n }\n interface MemberUnfollowed {\n /** Member who is unfollowing the other member. */\n memberConnection?: Follower;\n }\n interface ListMyMemberFollowingRequest {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface CursorPaging {\n /** Number of items to return. See [Pagination](https://dev.wix.com/docs/rest/business-solutions/events/events/rsvp/introduction) for more information. */\n limit?: number | null;\n /** Cursor returned from last query response. */\n cursor?: string | null;\n }\n interface ListMyMemberFollowingResponse {\n /** List of members followed by the current member. */\n memberIds?: string[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items starting from given cursor. */\n count?: number | null;\n /** Cursors to navigate through the result pages using `next` and `prev`. */\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 * @internal\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 ListMemberFollowingRequest {\n /** The ID of the member whose followers you want to list. */\n memberId: string;\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListMemberFollowingResponse {\n /** List of members who are followed by the given member. */\n memberIds?: string[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface ListMyMemberFollowersRequest {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListMyMemberFollowersResponse {\n /** List of members who are following the current member. */\n memberIds?: string[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface ListMemberFollowersRequest {\n /** The ID of the member whose followed members you want to list. */\n memberId: string;\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListMemberFollowersResponse {\n /** List of members who are following the given member. */\n memberIds?: string[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface QueryMyMemberConnectionsRequest {\n /** List of member IDs whose connections to the current member will be retrieved. */\n connectedMemberIds: string[];\n }\n interface QueryMyMemberConnectionsResponse {\n /** List of members whose connections to the current member were retrieved. */\n connectedMembers?: ConnectedMembers[];\n }\n interface ConnectedMembers {\n /** Site member ID. */\n connectedMemberId?: string;\n /** Indicates if the listed member is followed by the given member. */\n followedByMember?: boolean;\n /** Indicates if the listed member is following the given member. */\n followingMember?: boolean;\n }\n interface QueryMemberConnectionsRequest {\n /** List of member IDs whose connections to the given member will be retrieved. */\n connectedMemberIds: string[];\n /** Member ID. */\n memberId: string;\n }\n interface QueryMemberConnectionsResponse {\n /** List of members whose connections to the given member were retrieved. */\n connectedMembers?: ConnectedMembers[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 the current member to follow another member.\n * @param memberId - The ID of the member who you want to follow.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId MEMBERS.MEMBER_FOLLOW\n */\n function followMember(memberId: string): Promise;\n /**\n * Sets the current member to unfollow another member.\n * @param memberId - The ID of the member who you want to unfollow.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId MEMBERS.MEMBER_FOLLOW\n */\n function unfollowMember(memberId: string): Promise;\n /**\n * Lists members who are followed by the current member.\n * @public\n * @documentationMaturity preview\n * @permissionId MEMBERS.FOLLOW_READ_MY\n */\n function listCurrentMemberFollowing(options?: ListCurrentMemberFollowingOptions): Promise;\n interface ListCurrentMemberFollowingOptions {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListCurrentMemberFollowingResult {\n memberIds: string[];\n metadata: PagingMetadataV2;\n }\n /**\n * Lists members who are followed by the given member.\n * @param memberId - The ID of the member whose followers you want to list.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId MEMBERS.FOLLOW_READ\n */\n function listMemberFollowing(memberId: string, options?: ListMemberFollowingOptions): Promise;\n interface ListMemberFollowingOptions {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListMemberFollowingResult {\n memberIds: string[];\n metadata: PagingMetadataV2;\n }\n /**\n * Lists members who are following the current member.\n * @public\n * @documentationMaturity preview\n * @permissionId MEMBERS.FOLLOW_READ_MY\n */\n function listCurrentMemberFollowers(options?: ListCurrentMemberFollowersOptions): Promise;\n interface ListCurrentMemberFollowersOptions {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListCurrentMemberFollowersResult {\n memberIds: string[];\n metadata: PagingMetadataV2;\n }\n /**\n * Lists members who are following the given member.\n * @param memberId - The ID of the member whose followed members you want to list.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId MEMBERS.FOLLOW_READ\n */\n function listMemberFollowers(memberId: string, options?: ListMemberFollowersOptions): Promise;\n interface ListMemberFollowersOptions {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: CursorPaging;\n }\n interface ListMemberFollowersResult {\n memberIds: string[];\n metadata: PagingMetadataV2;\n }\n /**\n * Retrieves a list of members whose connections to the current member were retrieved.\n * @param connectedMemberIds - List of member IDs whose connections to the current member will be retrieved.\n * @public\n * @documentationMaturity preview\n * @requiredField connectedMemberIds\n * @permissionId MEMBERS.FOLLOW_READ_MY\n */\n function queryCurrentMemberConnections(connectedMemberIds: string[]): Promise;\n /**\n * Retrieves a list of members whose connections to the given member were retrieved.\n * > **Note:** If an empty array is passed as `connectedMemberIds`, the call will succeed, but it will not return any data.\n * @param memberId - Member ID.\n * @param connectedMemberIds - List of member IDs whose connections to the given member will be retrieved.\n * @public\n * @documentationMaturity preview\n * @requiredField connectedMemberIds\n * @requiredField memberId\n * @permissionId MEMBERS.FOLLOW_READ\n */\n function queryMemberConnections(memberId: string, connectedMemberIds: string[]): Promise;\n \n export { ActionEvent, App, ConnectedMembers, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, File, FollowMemberRequest, FollowMemberResponse, Follower, IdentificationData, IdentificationDataIdOneOf, InvalidateCache, InvalidateCacheGetByOneOf, ListCurrentMemberFollowersOptions, ListCurrentMemberFollowersResult, ListCurrentMemberFollowingOptions, ListCurrentMemberFollowingResult, ListMemberFollowersOptions, ListMemberFollowersRequest, ListMemberFollowersResponse, ListMemberFollowersResult, ListMemberFollowingOptions, ListMemberFollowingRequest, ListMemberFollowingResponse, ListMemberFollowingResult, ListMyMemberFollowersRequest, ListMyMemberFollowersResponse, ListMyMemberFollowingRequest, ListMyMemberFollowingResponse, MemberFollowed, MemberUnfollowed, MessageEnvelope, Page, PagingMetadataV2, QueryMemberConnectionsRequest, QueryMemberConnectionsResponse, QueryMyMemberConnectionsRequest, QueryMyMemberConnectionsResponse, RestoreInfo, URI, UnfollowMemberRequest, UnfollowMemberResponse, WebhookIdentityType, followMember, listCurrentMemberFollowers, listCurrentMemberFollowing, listMemberFollowers, listMemberFollowing, queryCurrentMemberConnections, queryMemberConnections, unfollowMember };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-recruitment-agencies-positions-backend.d.ts", "content": "declare module \"wix-recruitment-agencies-positions-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Position {\n /** @readonly */\n _id?: string;\n /**\n * postingId in People system - specific job description published instance\n * @readonly\n */\n postingId?: string;\n /** Posting title in People system - specific job description published instance */\n title?: string;\n /** Posting description in People system */\n description?: string;\n /** Posting requirements in People system */\n requirements?: string;\n /** Posting responsibilities in People system */\n responsibilities?: string;\n }\n interface GetAgencyPositionsRequest {\n }\n interface GetAgencyPositionsResponse {\n /** agency positions */\n positions?: Position[];\n }\n /** GetAgencyPositions return positions for agency */\n function getAgencyPositions(): Promise;\n \n const peopleAgenciesPortalV1Position_universal_d___debug: typeof __debug;\n type peopleAgenciesPortalV1Position_universal_d_Position = Position;\n type peopleAgenciesPortalV1Position_universal_d_GetAgencyPositionsRequest = GetAgencyPositionsRequest;\n type peopleAgenciesPortalV1Position_universal_d_GetAgencyPositionsResponse = GetAgencyPositionsResponse;\n const peopleAgenciesPortalV1Position_universal_d_getAgencyPositions: typeof getAgencyPositions;\n namespace peopleAgenciesPortalV1Position_universal_d {\n export {\n peopleAgenciesPortalV1Position_universal_d___debug as __debug,\n peopleAgenciesPortalV1Position_universal_d_Position as Position,\n peopleAgenciesPortalV1Position_universal_d_GetAgencyPositionsRequest as GetAgencyPositionsRequest,\n peopleAgenciesPortalV1Position_universal_d_GetAgencyPositionsResponse as GetAgencyPositionsResponse,\n peopleAgenciesPortalV1Position_universal_d_getAgencyPositions as getAgencyPositions,\n };\n }\n \n export { peopleAgenciesPortalV1Position_universal_d as recruitmentAgenciesPositions };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-comm-channels-v1-communication-channels-provider.d.ts", "content": "declare module \"interfaces-comm-channels-v1-communication-channels-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface CommunicationChannelsProvider {\n _id?: string | null;\n }\n interface GetChannelConnectionStatusRequest {\n }\n interface GetChannelConnectionStatusResponse {\n connectionStatus?: ChannelConnectionStatus;\n /** Usage information, can have multiple quotas (regular, booster, etc). */\n quotaInfo?: QuotaInfo[];\n }\n interface ChannelConnectionStatus {\n /** The connected channel account identifier (such as email address / phone number / facebook pageId etc) */\n identifier?: string | null;\n /** State of the connected channel, indicates if channel is valid for sending and receiving messages */\n status?: ConnectionStatus;\n }\n enum ConnectionStatus {\n UNKNOWN_CONNECTION_STATE = \"UNKNOWN_CONNECTION_STATE\",\n VALID = \"VALID\",\n DISCONNECTED = \"DISCONNECTED\",\n INVALID = \"INVALID\",\n PENDING = \"PENDING\",\n SUSPENDED = \"SUSPENDED\"\n }\n interface QuotaInfo {\n /** Name of the plan this quote is applied to. */\n planName?: string;\n /** Upcoming renewal date of the plan this quote is applied to. */\n planRenewalDate?: Date;\n /** Quantity usage limitation, for the specific period */\n limit?: string | null;\n /** Period the limitation applies to. */\n period?: FeaturePeriod;\n /** Counted usages until this moment. */\n currentUsage?: string;\n /**\n * Remaining amount that can be used.\n * Will be set to None in case for an unlimited usage feature\n */\n remainingUsage?: string | null;\n }\n /** Determines the 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 GetQuotaInfoRequest {\n }\n interface GetQuotaInfoResponse {\n quotaInfo?: QuotaInfo[];\n }\n interface CanSendMessageRequest {\n to?: string | null;\n }\n interface CanSendMessageResponse {\n canSendMessage?: boolean;\n additionalInfo?: CanSendAdditionalInfo;\n }\n interface CanSendAdditionalInfo {\n type?: CanSendInfoType;\n /** get in the spi, and maybe only for logs and not expose in the API */\n message?: string | null;\n }\n enum CanSendInfoType {\n UNKNOWN_ADDITIONAL_INFO_TYPE = \"UNKNOWN_ADDITIONAL_INFO_TYPE\",\n RECIPIENT_UNSUBSCRIBED = \"RECIPIENT_UNSUBSCRIBED\",\n RECIPIENT_BLOCKED = \"RECIPIENT_BLOCKED\",\n INVALID_RECIPIENT = \"INVALID_RECIPIENT\",\n ADDITIONAL_ACTION_REQUIRED = \"ADDITIONAL_ACTION_REQUIRED\",\n QUOTA_EXCEEDED = \"QUOTA_EXCEEDED\",\n TOO_MANY_REQUESTS = \"TOO_MANY_REQUESTS\",\n ACCOUNT_CONNECTION_NOT_ACTIVE = \"ACCOUNT_CONNECTION_NOT_ACTIVE\"\n }\n interface SendMessageRequest {\n to?: Recipient;\n message?: Message;\n }\n interface Recipient {\n email?: EmailRecipient;\n phone?: string | null;\n recipientId?: string | null;\n }\n interface EmailRecipient {\n address?: string;\n name?: string | null;\n }\n interface Message extends MessageContentOneOf {\n _id?: string | null;\n _createdDate?: Date;\n messageIdReference?: string | null;\n summary?: string | null;\n messageType?: MessageType;\n directMessage?: DirectMessage;\n emailMessage?: EmailMessage;\n smsMessage?: SmsMessage;\n }\n /** @oneof */\n interface MessageContentOneOf {\n directMessage?: DirectMessage;\n emailMessage?: EmailMessage;\n smsMessage?: SmsMessage;\n }\n enum MessageType {\n UNKNOWN_MESSAGE_TYPE = \"UNKNOWN_MESSAGE_TYPE\",\n DIRECT_MESSAGE = \"DIRECT_MESSAGE\",\n EMAIL = \"EMAIL\",\n SMS = \"SMS\"\n }\n interface DirectMessage extends DirectMessagePayloadOneOf {\n payloadType?: PayloadType;\n /** simple messages */\n textMessage?: TextMessage;\n mediaMessage?: MediaMessage;\n locationMessage?: LocationMessage;\n /** templates */\n cardTemplate?: CardTemplate;\n announcementTemplate?: AnnouncementTemplate;\n formTemplate?: FormTemplate;\n }\n /** @oneof */\n interface DirectMessagePayloadOneOf {\n /** simple messages */\n textMessage?: TextMessage;\n mediaMessage?: MediaMessage;\n locationMessage?: LocationMessage;\n /** templates */\n cardTemplate?: CardTemplate;\n announcementTemplate?: AnnouncementTemplate;\n formTemplate?: FormTemplate;\n }\n enum PayloadType {\n UNKNOWN_MESSAGE_TYPE = \"UNKNOWN_MESSAGE_TYPE\",\n SIMPLE_TEXT = \"SIMPLE_TEXT\",\n SIMPLE_MEDIA = \"SIMPLE_MEDIA\",\n SIMPLE_LOCATION = \"SIMPLE_LOCATION\",\n CARD = \"CARD\",\n CONTACT = \"CONTACT\",\n ANNOUNCEMENT = \"ANNOUNCEMENT\",\n FORM = \"FORM\",\n ACTIONABLE_FORM = \"ACTIONABLE_FORM\"\n }\n interface TextMessage {\n mimeType?: TextMimeType;\n content?: string | null;\n }\n enum TextMimeType {\n TEXT_PLAIN = \"TEXT_PLAIN\"\n }\n interface MediaMessage {\n mimeType?: MediaMimeType;\n /** or URI ? */\n url?: string | null;\n altText?: string | null;\n caption?: string | null;\n fileName?: string | null;\n fileSizeInBytes?: string | null;\n lengthInMs?: string | null;\n }\n /** Mime type for relevant media entities in channels */\n enum MediaMimeType {\n UNKNOWN_MIME_TYPE = \"UNKNOWN_MIME_TYPE\",\n IMAGE_JPEG = \"IMAGE_JPEG\",\n IMAGE_PNG = \"IMAGE_PNG\",\n IMAGE_WEBP = \"IMAGE_WEBP\",\n VIDEO_MPEG = \"VIDEO_MPEG\",\n VIDEO_MP4 = \"VIDEO_MP4\",\n VIDEO_3GP = \"VIDEO_3GP\",\n AUDIO_AAC = \"AUDIO_AAC\",\n AUDIO_MP4 = \"AUDIO_MP4\",\n AUDIO_MPEG = \"AUDIO_MPEG\",\n AUDIO_OGG = \"AUDIO_OGG\",\n AUDIO_OPUS = \"AUDIO_OPUS\",\n APPLICATION_PDF = \"APPLICATION_PDF\",\n APPLICATION_OCTET_STREAM = \"APPLICATION_OCTET_STREAM\"\n }\n interface LocationMessage {\n coordinates?: Coordinates;\n label?: string | null;\n title?: string | null;\n address?: string | null;\n }\n interface Coordinates {\n longitude?: string | null;\n latitude?: string | null;\n }\n interface CardTemplate {\n title?: string | null;\n description?: string | null;\n imageUrl?: string | null;\n orientation?: Orientation;\n buttons?: Button[];\n }\n enum Orientation {\n PORTRAIT = \"PORTRAIT\",\n LANDSCAPE = \"LANDSCAPE\"\n }\n interface Button {\n /** todo: explore action types e.g https://docs.smooch.io/guide/channel-capabilities/ */\n type?: ButtonType;\n url?: string | null;\n title?: string | null;\n postbackPayload?: string | null;\n }\n enum ButtonType {\n CTA = \"CTA\",\n POSTBACK = \"POSTBACK\",\n POSTBACK_AND_CTA = \"POSTBACK_AND_CTA\"\n }\n interface AnnouncementTemplate {\n text?: string;\n iconUrl?: string | null;\n }\n interface FormTemplate {\n title?: string | null;\n fields?: FormField[];\n }\n interface FormField {\n label?: string;\n value?: string | null;\n }\n interface EmailMessage {\n /** todo: how do we put here the in_reply_to */\n replyTo?: string | null;\n subject?: string;\n content?: EmailContent[];\n cc?: EmailRecipient[];\n attachments?: EmailAttachment[];\n sentDate?: Date;\n }\n interface EmailContent {\n mimeType?: string;\n content?: string | null;\n }\n interface EmailAttachment {\n _id?: string | null;\n name?: string;\n mimeType?: string | null;\n url?: string;\n fileSizeInBytes?: string | null;\n disposition?: AttachmentDisposition;\n }\n enum AttachmentDisposition {\n ATTACHMENT = \"ATTACHMENT\",\n INLINE = \"INLINE\"\n }\n interface SmsMessage extends SmsMessageBodyOneOf {\n text?: TextSMS;\n mms?: MediaSMS;\n }\n /** @oneof */\n interface SmsMessageBodyOneOf {\n text?: TextSMS;\n mms?: MediaSMS;\n }\n interface TextSMS {\n encoding?: string | null;\n body?: string | null;\n }\n interface MediaSMS {\n mimeType?: string | null;\n urls?: string[] | null;\n }\n interface SendMessageResponse {\n externalMessageId?: string;\n }\n interface InvalidRecipientError {\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 UpdateMessageStatusRequest {\n to?: Recipient;\n status?: MessageStatus;\n }\n interface MessageStatus extends MessageStatusContentOneOf {\n _id?: string | null;\n messageIdReference?: string | null;\n statusContext?: StatusContext;\n statusType?: StatusType;\n messageSentStatus?: MessageSentStatus;\n messageDeliveredStatus?: MessageDeliveredStatus;\n messageSeenStatus?: MessageSeenStatus;\n failedDeliveryStatus?: FailedDeliveryStatus;\n messageDeletedStatus?: MessageDeletedStatus;\n }\n /** @oneof */\n interface MessageStatusContentOneOf {\n messageSentStatus?: MessageSentStatus;\n messageDeliveredStatus?: MessageDeliveredStatus;\n messageSeenStatus?: MessageSeenStatus;\n failedDeliveryStatus?: FailedDeliveryStatus;\n messageDeletedStatus?: MessageDeletedStatus;\n }\n interface StatusContext {\n initiatorId?: string | null;\n statusChangedDate?: Date;\n }\n enum StatusType {\n UNKNOWN_STATUS_TYPE = \"UNKNOWN_STATUS_TYPE\",\n SENT = \"SENT\",\n DELIVERED = \"DELIVERED\",\n SEEN = \"SEEN\",\n FAILED = \"FAILED\",\n DELETED = \"DELETED\"\n }\n interface MessageSentStatus {\n }\n interface MessageDeliveredStatus {\n }\n interface MessageSeenStatus {\n }\n interface FailedDeliveryStatus {\n errorCode?: ErrorCode;\n cause?: string | null;\n }\n enum ErrorCode {\n UNKNOWN_FAILED_CODE = \"UNKNOWN_FAILED_CODE\",\n PERMISSION_DENIED = \"PERMISSION_DENIED\",\n MISSING_PERMISSION = \"MISSING_PERMISSION\",\n /** RATE_LIMIT_EXCEEDED */\n TOO_MANY_REQUESTS = \"TOO_MANY_REQUESTS\",\n QUOTA_EXCEEDED = \"QUOTA_EXCEEDED\",\n INVALID_PARAMETER = \"INVALID_PARAMETER\",\n EXPIRED_ACCESS_TOKEN = \"EXPIRED_ACCESS_TOKEN\",\n POLICY_VIOLATION = \"POLICY_VIOLATION\",\n BLOCKED = \"BLOCKED\",\n MESSAGE_EXPIRED = \"MESSAGE_EXPIRED\",\n GENERIC_ERROR = \"GENERIC_ERROR\",\n UNSUPPORTED_MESSAGE_TYPE = \"UNSUPPORTED_MESSAGE_TYPE\",\n BACKEND_ERROR = \"BACKEND_ERROR\"\n }\n interface MessageDeletedStatus {\n }\n interface UpdateMessageStatusResponse {\n }\n interface GetRecipientProfileRequest {\n recipient?: Recipient;\n }\n interface GetRecipientProfileResponse {\n profile?: RecipientProfile;\n }\n interface RecipientProfile {\n recipient?: Recipient;\n name?: string;\n firstName?: string | null;\n lastName?: string | null;\n /** todo: use standard image object decomposition */\n profilePicture?: string | null;\n }\n interface CommunicationChannelConfiguration {\n config?: ChannelConfiguration;\n }\n interface ChannelConfiguration extends ChannelConfigurationMessagingConfigOneOf {\n /** The type of the communication channel */\n type?: ChannelType;\n /** Specific provider branding parameters for the channel */\n branding?: ChannelBranding;\n /** Conversation initiation definition */\n conversationLimitations?: ConversationLimitations;\n directMessageConfig?: DirectMessageConfig;\n emailMessageConfig?: EmailMessageConfig;\n smsMessageConfig?: SmsMessageConfig;\n }\n /** @oneof */\n interface ChannelConfigurationMessagingConfigOneOf {\n directMessageConfig?: DirectMessageConfig;\n emailMessageConfig?: EmailMessageConfig;\n smsMessageConfig?: SmsMessageConfig;\n }\n /** The type of the communication channel */\n enum ChannelType {\n UNKNOWN_CHANNEL_TYPE = \"UNKNOWN_CHANNEL_TYPE\",\n DIRECT_MESSAGING = \"DIRECT_MESSAGING\",\n EMAIL = \"EMAIL\",\n SMS = \"SMS\"\n }\n interface DirectMessageConfig {\n /** When marked as true, there's no need to list the supported types explicitly */\n acceptAllMessageTypes?: boolean;\n /**\n * Direct message types accepted by the provider. only those types will be sent from Wix\n * If all are excepted this field can be left empty and there's no need to explicitly state types\n */\n acceptedMessageTypes?: AcceptedDirectMessageType[];\n /** Elaborates what media types (mime types) and sizes are supported */\n mediaCapabilities?: MediaCapabilities;\n }\n enum AcceptedDirectMessageType {\n TEXT = \"TEXT\",\n MEDIA = \"MEDIA\",\n CARD = \"CARD\",\n ANNOUNCEMENT = \"ANNOUNCEMENT\",\n FORM = \"FORM\"\n }\n interface MediaCapabilities {\n /** When marked as true, there's no need to list the supported types explicitly */\n allMediaTypes?: boolean;\n /**\n * List for supported media types\n * If all are excepted this field can be left empty and there's no need to explicitly state types\n */\n supportedMediaTypes?: MediaMimeType[];\n /** Maximum file size in bytes of a single file in a message */\n maxFileSizeInBytes?: number | null;\n }\n interface EmailMessageConfig {\n /** Media (Attachment) types accepted by the provider */\n mediaCapabilities?: MediaCapabilities;\n /** Maximum size in bytes of total media items in a message. */\n maxTotalFilesSizeInBytes?: number | null;\n }\n interface SmsMessageConfig {\n /** When marked as true, there's no need to list the supported types explicitly */\n acceptAllMessageTypes?: boolean;\n /** SMS message types accepted by the provider. only those types will be sent from Wix */\n acceptedMessageTypes?: AcceptedSmsMessageType[];\n /** Elaborates what media types (mime types) and sizes are supported */\n mediaCapabilities?: MediaCapabilities;\n }\n enum AcceptedSmsMessageType {\n SMS = \"SMS\",\n MMS = \"MMS\"\n }\n interface ChannelBranding {\n /** The name of the channel, e.g. `Facebook` / `SMS` */\n displayName?: string;\n /** Name of the channel provider (Wix, Meta, Google) */\n providerName?: string | null;\n /** Relevant brand icons, used when the channel is integrated */\n brandIcons?: BrandIcons;\n }\n /**\n * Brand icons required for correct channel integration\n * todo: 1. which ones are required ?\n * todo: 2. we may need to specify Icons specs (i.e. format and sizes)\n */\n interface BrandIcons {\n default?: Icon;\n vector?: Icon;\n bwOutlineVector?: Icon;\n }\n interface Icon {\n /** Specific Icon url */\n url?: string | null;\n }\n interface ConversationLimitations {\n /**\n * Defines who can initiate conversation in this channel.\n * If, `CUSTOMER` is selected, this means that only inbound\n * messages can start a conversation (aka business can only reply and not initiate the first communication).\n */\n initDirection?: InitDirection;\n }\n enum InitDirection {\n UNKNOWN_INIT_DIRECTION = \"UNKNOWN_INIT_DIRECTION\",\n BUSINESS = \"BUSINESS\",\n CUSTOMER = \"CUSTOMER\",\n BOTH = \"BOTH\"\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 CanSendMessageOptions {\n to?: string | null;\n }\n interface SendMessageOptions {\n to?: Recipient;\n message?: Message;\n }\n interface UpdateMessageStatusOptions {\n to?: Recipient;\n status?: MessageStatus;\n }\n interface GetRecipientProfileOptions {\n recipient?: Recipient;\n }\n \n function invalidRecipient$1(data: InvalidRecipientError): BusinessError;\n \n namespace sendMessageSpiErrors_d {\n export {\n invalidRecipient$1 as invalidRecipient,\n };\n }\n \n function invalidRecipient(data: InvalidRecipientError): BusinessError;\n \n const updateMessageStatusSpiErrors_d_invalidRecipient: typeof invalidRecipient;\n namespace updateMessageStatusSpiErrors_d {\n export {\n updateMessageStatusSpiErrors_d_invalidRecipient as invalidRecipient,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n sendMessageSpiErrors_d as sendMessage,\n updateMessageStatusSpiErrors_d as updateMessageStatus,\n };\n }\n \n export { AcceptedDirectMessageType, AcceptedSmsMessageType, AnnouncementTemplate, AttachmentDisposition, BrandIcons, Button, ButtonType, CanSendAdditionalInfo, CanSendInfoType, CanSendMessageOptions, CanSendMessageRequest, CanSendMessageResponse, CardTemplate, ChannelBranding, ChannelConfiguration, ChannelConfigurationMessagingConfigOneOf, ChannelConnectionStatus, ChannelType, CommunicationChannelConfiguration, CommunicationChannelsProvider, ConnectionStatus, Context, ConversationLimitations, Coordinates, DirectMessage, DirectMessageConfig, DirectMessagePayloadOneOf, EmailAttachment, EmailContent, EmailMessage, EmailMessageConfig, EmailRecipient, ErrorCode, FailedDeliveryStatus, FeaturePeriod, FieldViolation, FormField, FormTemplate, GetChannelConnectionStatusRequest, GetChannelConnectionStatusResponse, GetQuotaInfoRequest, GetQuotaInfoResponse, GetRecipientProfileOptions, GetRecipientProfileRequest, GetRecipientProfileResponse, Icon, IdentificationData, IdentificationDataIdOneOf, IdentityType, InitDirection, InvalidRecipientError, LocationMessage, MediaCapabilities, MediaMessage, MediaMimeType, MediaSMS, Message, MessageContentOneOf, MessageDeletedStatus, MessageDeliveredStatus, MessageSeenStatus, MessageSentStatus, MessageStatus, MessageStatusContentOneOf, MessageType, Orientation, PayloadType, QuotaInfo, Recipient, RecipientProfile, RuleType, SendMessageOptions, SendMessageRequest, SendMessageResponse, SmsMessage, SmsMessageBodyOneOf, SmsMessageConfig, StatusContext, StatusType, TextMessage, TextMimeType, TextSMS, UpdateMessageStatusOptions, UpdateMessageStatusRequest, UpdateMessageStatusResponse, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-psp-v1-payment-service-provider.d.ts", "content": "declare module \"interfaces-psp-v1-payment-service-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface PaymentServiceProviderEntity {\n }\n interface ConnectAccountRequest {\n /** Free format of the fields that describes merchant credentials for a PSP account. */\n credentials: Record;\n /** The country in which the merchant will provide their services, in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for the merchant's preferred [currency](https://en.wikipedia.org/wiki/ISO_4217). */\n currency?: string | null;\n /** Wix merchant ID. */\n wixMerchantId: string;\n }\n interface ConnectAccountResponse {\n /**\n * Merchant credentials that will be used by Wix to make a payment on behalf of the merchant.\n * The format must be specified in provider configuration.\n */\n credentials?: Record;\n /** Merchant account ID. This must not be changed over the lifetime of their account. */\n accountId?: string;\n /** Merchant account name. */\n accountName?: string | null;\n /** Reason code predefined by Wix that indicates call result. */\n reasonCode?: number | null;\n /** Error code specific for a Payment Service Provider. */\n errorCode?: string | null;\n /** Error description specific for a Payment Service Provider. */\n errorMessage?: string | null;\n }\n interface CreateTransactionRequest {\n /** Wix transaction ID. */\n wixTransactionId: string;\n /**\n * Payment method supported by the payment service provider.\n * These values will be displayed to the end-user upon checkout and will be passed to the payment service provider\n * to understand what payment method a user selected on the Wix side.\n */\n paymentMethod?: string;\n /** Payment Service Provider own credentials that were connected during the onboarding process. */\n merchantCredentials: Record;\n /** Order information. */\n order: Order;\n /** Wix merchant ID. */\n wixMerchantId?: string | null;\n /** Information in case of fraud. */\n fraudInformation?: FraudInformation;\n }\n interface Order {\n /** Merchant order ID. Can be used by a merchant to correlate payment on Wix and on provider side. */\n _id?: string | null;\n description?: OrderDescription;\n returnUrls?: OrderReturnUrls;\n }\n interface OrderDescription {\n /**\n * Total amount to pay in a currency’s smallest unit. In example it's a $10.00 payment.\n * The amount includes all extra charges that are described in the order object like shipping, taxes, etc.\n */\n totalAmount?: string;\n /** Code for the merchant's preferred [currency](https://en.wikipedia.org/wiki/ISO_4217). */\n currency?: string;\n items?: OrderItem[];\n charges?: AdditionalCharges;\n billingAddress?: Address;\n shippingAddress?: Address;\n buyerInfo?: BuyerInfo;\n }\n interface OrderItem {\n /** Item ID. */\n _id?: string | null;\n /** Item name provided by the merchant. */\n name?: string | null;\n /** Item quantity. */\n quantity?: number | null;\n /** Item price. */\n price?: string | null;\n /** Item description provided by the merchant. */\n description?: string | null;\n /** Item weight in KG provided by the merchant. */\n weightInKg?: number | null;\n category?: OrderItemCategory;\n }\n enum OrderItemCategory {\n undefined = \"undefined\",\n physical = \"physical\",\n digital = \"digital\"\n }\n interface AdditionalCharges {\n /** Calculated taxes applied for the full order. */\n tax?: string | null;\n /** Order shipping cost. */\n shipping?: string | null;\n /** Discount amount applied to order. */\n discount?: string | null;\n }\n interface Address {\n /** Buyer's first name. */\n firstName?: string | null;\n /** Buyer's last name. */\n lastName?: string | null;\n /** Buyer's company name. */\n company?: string | null;\n /**\n * Billing or delivery address line.\n * This field represents a street and house number concatenation.\n */\n address?: string | null;\n /** Street name. */\n street?: string | null;\n /** House number. */\n houseNumber?: string | null;\n /** City. */\n city?: string | null;\n /** State. */\n state?: string | null;\n /** Zip code. */\n zipCode?: string | null;\n /** Country of a buyer. */\n countryCode?: string | null;\n /** Phone of a buyer. */\n phone?: string | null;\n /** Fax of a buyer in free form format. */\n fax?: string | null;\n /** Email of a buyer. */\n email?: string | null;\n taxIdentifier?: TaxIdentifier;\n }\n interface TaxIdentifier {\n /** Specific Tax id for merchant country. */\n _id?: string;\n /** Specific Tax type for merchant country. */\n type?: string | null;\n }\n interface BuyerInfo {\n /** Free format unique buyer identifier assigned by Wix. */\n buyerId?: string | null;\n /** Buyer language in [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)) format. */\n buyerLanguage?: string | null;\n }\n interface OrderReturnUrls {\n /** URL destination to merchants site in case of successful payment. */\n successUrl?: string;\n /** URL destination to merchants site in case of failed payment. */\n errorUrl?: string;\n /** URL destination to merchants site in case of payment cancellation. */\n cancelUrl?: string | null;\n /** URL destination to merchants site in case of pending payment. */\n pendingUrl?: string | null;\n }\n interface FraudInformation {\n /** Customer (buyer) IP address. */\n remoteIp?: string;\n }\n interface CreateTransactionResponse {\n /** Transaction identifier on the side of a Payment Service Provider. */\n pluginTransactionId?: string | null;\n /** Reason code predefined by Wix that indicates call result. */\n reasonCode?: number;\n /** Error code specific for a Payment Service Provider. */\n errorCode?: string | null;\n /** Error description specific for a Payment Service Provider. */\n errorMessage?: string | null;\n /** Web page URL where a buyer can proceed with a payment. */\n redirectUrl?: string | null;\n }\n interface CreateRefundRequest {\n /** Wix transaction ID. */\n wixTransactionId: string;\n /** Refund ID. */\n wixRefundId: string;\n /** Provider transaction ID. */\n pluginTransactionId: string;\n /** Payment Service Provider own credentials that were connected during the onboarding process. */\n merchantCredentials: Record;\n /**\n * Total amount to pay in a currency’s smallest unit. In the example it's a $10.00 payment.\n * The amount includes all extra charges that are described in the order object like shipping, taxes, etc.\n */\n refundAmount?: string;\n /** Reason for refund. Defined by the merchant. */\n reason?: RefundReason;\n }\n enum RefundReason {\n UNKNOWN = \"UNKNOWN\",\n DUPLICATE = \"DUPLICATE\",\n FRAUDULENT = \"FRAUDULENT\",\n REQUESTED_BY_CUSTOMER = \"REQUESTED_BY_CUSTOMER\"\n }\n interface CreateRefundResponse {\n /** Refund identifier on the side of a *Payment Service Provider*. */\n pluginRefundId?: string | null;\n /** Reason code predefined by Wix that indicates call result. */\n reasonCode?: number;\n /** Error code specific for a Payment Service Provider. */\n errorCode?: string | null;\n /** Error description specific for a Payment Service Provider. */\n errorMessage?: string | null;\n }\n /** Configuration for the payment service SPI implementor */\n interface PaymentServiceProviderConfig {\n /** Payment service provider to display on Accept payments tab in Business manager */\n title?: string;\n /** Available payment methods */\n paymentMethods?: PaymentMethod[];\n /** Provider authentication methods */\n credentialsFields?: PaymentServiceProviderCredentialsField[];\n }\n interface PaymentMethod extends PaymentMethodMethodOneOf {\n /** Information about hosted page payment method */\n hostedPage?: HostedPage;\n }\n /** @oneof */\n interface PaymentMethodMethodOneOf {\n /** Information about hosted page payment method */\n hostedPage?: HostedPage;\n }\n interface HostedPage {\n /** The payment method title to be will be displayed on accept payments tab in business manager as well as on the checkout */\n title?: string;\n /** Url to images in different formats and colors */\n logos?: Logos;\n /** Billing address fields that buyer needs to fill in order to process payment with the specified payment method */\n billingAddressMandatoryFields?: MandatoryField[];\n }\n interface Logos {\n /** white theme logos */\n white?: Color;\n /** colored theme logos */\n colored?: Color;\n }\n interface Color {\n /** URL to SVG image */\n svg?: string;\n /** URL to PNG image */\n png?: string;\n }\n enum MandatoryField {\n ZIPCODE = \"ZIPCODE\",\n CITY = \"CITY\",\n STATE = \"STATE\",\n ADDRESS = \"ADDRESS\",\n COUNTRY_CODE = \"COUNTRY_CODE\",\n EMAIL = \"EMAIL\",\n PHONE = \"PHONE\",\n FIRST_NAME = \"FIRST_NAME\",\n LAST_NAME = \"LAST_NAME\",\n STREET = \"STREET\",\n HOUSE_NUMBER = \"HOUSE_NUMBER\",\n TAX_IDENTIFIER = \"TAX_IDENTIFIER\"\n }\n interface PaymentServiceProviderCredentialsField extends PaymentServiceProviderCredentialsFieldFieldOneOf {\n /** text field */\n simpleField?: SimpleField;\n /** checkbox field */\n checkboxField?: CheckboxField;\n /** dropdown field */\n dropdownField?: DropdownField;\n }\n /** @oneof */\n interface PaymentServiceProviderCredentialsFieldFieldOneOf {\n /** text field */\n simpleField?: SimpleField;\n /** checkbox field */\n checkboxField?: CheckboxField;\n /** dropdown field */\n dropdownField?: DropdownField;\n }\n interface SimpleField {\n /** field name */\n name?: string;\n /** field label */\n label?: string;\n }\n interface CheckboxField {\n /** field name */\n name?: string;\n /** field label */\n label?: string;\n /** field tooltip */\n tooltip?: string | null;\n }\n interface DropdownField {\n /** field name */\n name?: string;\n /** field label */\n label?: string;\n /** specific options */\n options?: DropdownFieldOption[];\n }\n interface DropdownFieldOption {\n /** option key */\n key?: string;\n /** option value */\n value?: 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 /** 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 ConnectAccountOptions {\n /** Free format of the fields that describes merchant credentials for a PSP account. */\n credentials: Record;\n /** The country in which the merchant will provide their services, in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n country?: string | null;\n /** Code for the merchant's preferred [currency](https://en.wikipedia.org/wiki/ISO_4217). */\n currency?: string | null;\n /** Wix merchant ID. */\n wixMerchantId: string;\n }\n interface CreateTransactionOptions {\n /** Wix transaction ID. */\n wixTransactionId: string;\n /**\n * Payment method supported by the payment service provider.\n * These values will be displayed to the end-user upon checkout and will be passed to the payment service provider\n * to understand what payment method a user selected on the Wix side.\n */\n paymentMethod?: string;\n /** Payment Service Provider own credentials that were connected during the onboarding process. */\n merchantCredentials: Record;\n /** Order information. */\n order: Order;\n /** Wix merchant ID. */\n wixMerchantId?: string | null;\n /** Information in case of fraud. */\n fraudInformation?: FraudInformation;\n }\n interface RefundTransactionOptions {\n /** Wix transaction ID. */\n wixTransactionId: string;\n /** Refund ID. */\n wixRefundId: string;\n /** Provider transaction ID. */\n pluginTransactionId: string;\n /** Payment Service Provider own credentials that were connected during the onboarding process. */\n merchantCredentials: Record;\n /**\n * Total amount to pay in a currency’s smallest unit. In the example it's a $10.00 payment.\n * The amount includes all extra charges that are described in the order object like shipping, taxes, etc.\n */\n refundAmount?: string;\n /** Reason for refund. Defined by the merchant. */\n reason?: RefundReason;\n }\n \n export { AdditionalCharges, Address, BusinessError, BuyerInfo, CheckboxField, Color, ConnectAccountOptions, ConnectAccountRequest, ConnectAccountResponse, Context, CreateRefundRequest, CreateRefundResponse, CreateTransactionOptions, CreateTransactionRequest, CreateTransactionResponse, DropdownField, DropdownFieldOption, FraudInformation, HostedPage, IdentificationData, IdentificationDataIdOneOf, IdentityType, Logos, MandatoryField, Order, OrderDescription, OrderItem, OrderItemCategory, OrderReturnUrls, PaymentMethod, PaymentMethodMethodOneOf, PaymentServiceProviderConfig, PaymentServiceProviderCredentialsField, PaymentServiceProviderCredentialsFieldFieldOneOf, PaymentServiceProviderEntity, RefundReason, RefundTransactionOptions, SimpleField, TaxIdentifier };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-sitetranslator-v1-translatableitem.d.ts", "content": "declare module \"interfaces-sitetranslator-v1-translatableitem\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface TranslatableItem {\n /** Unique specifier of the item in the implementer */\n _id?: string;\n /** Value of the translatable item */\n value?: string;\n /** Format of the text sent to translation */\n format?: TextFormat;\n }\n enum TextFormat {\n UNKNOWN = \"UNKNOWN\",\n TEXT = \"TEXT\",\n RICH_CONTENT_EDITOR = \"RICH_CONTENT_EDITOR\",\n HTML = \"HTML\"\n }\n interface CountNumberOfWordsRequest {\n /** the locale on which to count number of words */\n sourceLanguage: Locale;\n /** the locale will be translate to (optional) */\n targetLanguage?: Locale;\n }\n interface Locale {\n /** A two-character identifier of the language */\n language?: string;\n /** Flag of the language. Only significant for Chinese dialects */\n flag?: Flag;\n }\n enum Flag {\n UNDEFINED_FLAG_CODE = \"UNDEFINED_FLAG_CODE\",\n AFG = \"AFG\",\n AGO = \"AGO\",\n AIA = \"AIA\",\n ALA = \"ALA\",\n ALB = \"ALB\",\n AND = \"AND\",\n ARE = \"ARE\",\n ARG = \"ARG\",\n ARM = \"ARM\",\n ASM = \"ASM\",\n ATF = \"ATF\",\n ATG = \"ATG\",\n AUS = \"AUS\",\n AUT = \"AUT\",\n AZE = \"AZE\",\n BDI = \"BDI\",\n BEL = \"BEL\",\n BEN = \"BEN\",\n BES = \"BES\",\n BFA = \"BFA\",\n BGD = \"BGD\",\n BGR = \"BGR\",\n BHR = \"BHR\",\n BHS = \"BHS\",\n BIH = \"BIH\",\n BLM = \"BLM\",\n BLR = \"BLR\",\n BLZ = \"BLZ\",\n BMU = \"BMU\",\n BOL = \"BOL\",\n BRA = \"BRA\",\n BRB = \"BRB\",\n BRN = \"BRN\",\n BRT = \"BRT\",\n BTN = \"BTN\",\n BWA = \"BWA\",\n CAF = \"CAF\",\n CAN = \"CAN\",\n CAT = \"CAT\",\n CHE = \"CHE\",\n CHL = \"CHL\",\n CHN = \"CHN\",\n CIV = \"CIV\",\n CMR = \"CMR\",\n COD = \"COD\",\n COG = \"COG\",\n COL = \"COL\",\n COM = \"COM\",\n COR = \"COR\",\n CPV = \"CPV\",\n CRI = \"CRI\",\n CUB = \"CUB\",\n CUW = \"CUW\",\n CYM = \"CYM\",\n CZE = \"CZE\",\n DEU = \"DEU\",\n DJI = \"DJI\",\n DMA = \"DMA\",\n DNK = \"DNK\",\n DOM = \"DOM\",\n DZA = \"DZA\",\n ECU = \"ECU\",\n EGY = \"EGY\",\n ERI = \"ERI\",\n ESP = \"ESP\",\n EST = \"EST\",\n ETH = \"ETH\",\n EUR = \"EUR\",\n EUS = \"EUS\",\n FIN = \"FIN\",\n FJI = \"FJI\",\n FLK = \"FLK\",\n FRA = \"FRA\",\n FRO = \"FRO\",\n FSM = \"FSM\",\n GAB = \"GAB\",\n GBR = \"GBR\",\n GEO = \"GEO\",\n GGY = \"GGY\",\n GHA = \"GHA\",\n GIB = \"GIB\",\n GIN = \"GIN\",\n GLG = \"GLG\",\n GLO = \"GLO\",\n GLP = \"GLP\",\n GMB = \"GMB\",\n GNB = \"GNB\",\n GNQ = \"GNQ\",\n GRC = \"GRC\",\n GRD = \"GRD\",\n GRL = \"GRL\",\n GTM = \"GTM\",\n GUM = \"GUM\",\n GUY = \"GUY\",\n HKG = \"HKG\",\n HND = \"HND\",\n HRV = \"HRV\",\n HTI = \"HTI\",\n HUN = \"HUN\",\n IDN = \"IDN\",\n IMN = \"IMN\",\n IND = \"IND\",\n IOT = \"IOT\",\n IRL = \"IRL\",\n IRN = \"IRN\",\n IRQ = \"IRQ\",\n ISL = \"ISL\",\n ISR = \"ISR\",\n ITA = \"ITA\",\n JAM = \"JAM\",\n JEY = \"JEY\",\n JOR = \"JOR\",\n JPN = \"JPN\",\n KAZ = \"KAZ\",\n KEN = \"KEN\",\n KGZ = \"KGZ\",\n KHM = \"KHM\",\n KIR = \"KIR\",\n KNA = \"KNA\",\n KOR = \"KOR\",\n KUR = \"KUR\",\n KWT = \"KWT\",\n LAO = \"LAO\",\n LBN = \"LBN\",\n LBR = \"LBR\",\n LBY = \"LBY\",\n LCA = \"LCA\",\n LIE = \"LIE\",\n LKA = \"LKA\",\n LSO = \"LSO\",\n LTU = \"LTU\",\n LUX = \"LUX\",\n LVA = \"LVA\",\n MAC = \"MAC\",\n MAF = \"MAF\",\n MAR = \"MAR\",\n MCO = \"MCO\",\n MDA = \"MDA\",\n MDG = \"MDG\",\n MDV = \"MDV\",\n MEX = \"MEX\",\n MHL = \"MHL\",\n MKD = \"MKD\",\n MLI = \"MLI\",\n MLT = \"MLT\",\n MMR = \"MMR\",\n MNE = \"MNE\",\n MNG = \"MNG\",\n MNP = \"MNP\",\n MOZ = \"MOZ\",\n MRT = \"MRT\",\n MSR = \"MSR\",\n MTQ = \"MTQ\",\n MWI = \"MWI\",\n MYS = \"MYS\",\n MYT = \"MYT\",\n NAM = \"NAM\",\n NCL = \"NCL\",\n NER = \"NER\",\n NFK = \"NFK\",\n NGA = \"NGA\",\n NIC = \"NIC\",\n NIU = \"NIU\",\n NLD = \"NLD\",\n NOR = \"NOR\",\n NPL = \"NPL\",\n NRU = \"NRU\",\n NZL = \"NZL\",\n OMN = \"OMN\",\n PAK = \"PAK\",\n PAN = \"PAN\",\n PCN = \"PCN\",\n PER = \"PER\",\n PHL = \"PHL\",\n PLW = \"PLW\",\n PNG = \"PNG\",\n POL = \"POL\",\n PRI = \"PRI\",\n PRK = \"PRK\",\n PRT = \"PRT\",\n PRY = \"PRY\",\n PSE = \"PSE\",\n PYF = \"PYF\",\n QAT = \"QAT\",\n REU = \"REU\",\n ROU = \"ROU\",\n RUS = \"RUS\",\n RWA = \"RWA\",\n SAU = \"SAU\",\n SDN = \"SDN\",\n SEN = \"SEN\",\n SGP = \"SGP\",\n SGS = \"SGS\",\n SHN = \"SHN\",\n SJM = \"SJM\",\n SLB = \"SLB\",\n SLE = \"SLE\",\n SLV = \"SLV\",\n SMR = \"SMR\",\n SOM = \"SOM\",\n SPM = \"SPM\",\n SRB = \"SRB\",\n SSD = \"SSD\",\n STP = \"STP\",\n SUR = \"SUR\",\n SVK = \"SVK\",\n SVN = \"SVN\",\n SWE = \"SWE\",\n SWZ = \"SWZ\",\n SXM = \"SXM\",\n SYC = \"SYC\",\n SYR = \"SYR\",\n TCA = \"TCA\",\n TCD = \"TCD\",\n TGO = \"TGO\",\n THA = \"THA\",\n TJK = \"TJK\",\n TKL = \"TKL\",\n TKM = \"TKM\",\n TLS = \"TLS\",\n TON = \"TON\",\n TTO = \"TTO\",\n TUN = \"TUN\",\n TUR = \"TUR\",\n TUV = \"TUV\",\n TWN = \"TWN\",\n TZA = \"TZA\",\n UGA = \"UGA\",\n UKR = \"UKR\",\n URY = \"URY\",\n USA = \"USA\",\n UZB = \"UZB\",\n VAT = \"VAT\",\n VCT = \"VCT\",\n VEN = \"VEN\",\n VGB = \"VGB\",\n VIR = \"VIR\",\n VLC = \"VLC\",\n VNM = \"VNM\",\n VUT = \"VUT\",\n WLF = \"WLF\",\n WLS = \"WLS\",\n YEM = \"YEM\",\n ZAF = \"ZAF\",\n ZMB = \"ZMB\",\n ZWE = \"ZWE\"\n }\n interface CountNumberOfWordsResponse {\n /** count of all source_language words */\n allNumberOfWords?: number;\n /** count of all source_language items */\n allNumberOfItems?: number;\n /** count of translated to target_language words */\n translatedNumberOfWords?: number;\n /** count of translated to target_language items */\n translatedNumberOfItems?: number;\n /** translatable properties distributed be application */\n properties?: ApplicationProperties[];\n }\n interface ApplicationProperties {\n /** Unique identifier of application ID */\n appId?: string;\n /** count of all source_language words of a specific application */\n allNumberOfWords?: number;\n /** count of all source_language items of a specific application */\n allNumberOfItems?: number;\n /** count of translated to target_language words of a specific application */\n translatedNumberOfWords?: number;\n /** count of translated to target_language items of a specific application */\n translatedNumberOfItems?: number;\n }\n interface ReadContentRequest {\n /** The locale of the requested items */\n sourceLanguage: Locale;\n /** the locale will be translate to (optional) */\n targetLanguage?: Locale;\n /** Paging options. */\n paging?: Paging;\n /** Specific app ids to get their data; */\n include?: IncludedAppIds;\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 IncludedAppIds {\n appIds?: string[];\n }\n interface ReadContentResponse {\n /** items to be translated */\n items?: TranslatableItem[];\n }\n interface UpdateContentRequest {\n /** The locale to update items */\n language: Locale;\n /** items to be updated */\n items?: TranslatableItem[];\n }\n interface UpdateContentResponse {\n }\n interface ContentProviderConfig {\n /** a human readable name of the provider */\n providerName?: string;\n /** the maximum items allowed to read and update in a single request */\n maximumReadingBulkSize?: number | null;\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 CountNumberOfWordsOptions {\n /** the locale on which to count number of words */\n sourceLanguage: Locale;\n /** the locale will be translate to (optional) */\n targetLanguage?: Locale;\n }\n interface ReadContentOptions {\n /** The locale of the requested items */\n sourceLanguage: Locale;\n /** the locale will be translate to (optional) */\n targetLanguage?: Locale;\n /** Paging options. */\n paging?: Paging;\n /** Specific app ids to get their data; */\n include?: IncludedAppIds;\n }\n interface UpdateContentOptions {\n /** The locale to update items */\n language: Locale;\n /** items to be updated */\n items?: TranslatableItem[];\n }\n \n export { ApplicationProperties, BusinessError, ContentProviderConfig, Context, CountNumberOfWordsOptions, CountNumberOfWordsRequest, CountNumberOfWordsResponse, Flag, IdentificationData, IdentificationDataIdOneOf, IdentityType, IncludedAppIds, Locale, Paging, ReadContentOptions, ReadContentRequest, ReadContentResponse, TextFormat, TranslatableItem, UpdateContentOptions, UpdateContentRequest, UpdateContentResponse };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/portfolio-syncedprojects-v1-project.d.ts", "content": "declare module \"portfolio-syncedprojects-v1-project\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface Project {\n /** External Project ID */\n externalId?: string;\n /** Project name */\n title?: string | null;\n /** Project description */\n description?: string | null;\n /** Project addition key-value data */\n additionalPublicInfo?: Record;\n /** Project media count */\n mediaCount?: number;\n /** project image url */\n coverImage?: string | null;\n /** project url in external */\n link?: string | null;\n /** Project source description as appear in Dashboard project page */\n sourceDescription?: string | null;\n /** cover photo's file name in the provider */\n coverImageFileName?: string | null;\n /** project's cover image id */\n externalCoverImageId?: string | null;\n }\n interface GetProjectsRequest {\n /** Filter Designs by pages. Designs are sorted */\n paging?: 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 GetProjectsResponse {\n /** Projects */\n projects?: Project[];\n /** projects paging metadata */\n metadata?: 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 * 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 * @internal\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 UserUnauthorizedError {\n /** provider appDefId */\n appDefId?: string;\n }\n interface DataNotReady {\n /** provider appDefId */\n appDefId?: string;\n }\n interface RateLimitExceeded {\n /** provider appDefId */\n appDefId?: string;\n }\n interface SyncProjectRequest {\n /** External Project ID */\n externalId: string;\n /** if need to get the next items page that just asked for sync */\n itemsPaging?: CursorPaging;\n }\n interface SyncProjectResponse {\n /** project */\n project?: Project;\n items?: Item[];\n /** items paging metadata */\n metadata?: PagingMetadataV2;\n }\n interface Item {\n /** External media ID */\n externalId?: string;\n /** External Project ID */\n externalProjectId?: string;\n /** Item name */\n title?: string | null;\n /** Item description */\n description?: string | null;\n /** image or video */\n type?: MediaType;\n /** Item image url */\n mediaUrl?: string | null;\n /** Item tags */\n tags?: string[];\n /** Media's file name in the provider */\n fileName?: string | null;\n }\n enum MediaType {\n IMAGE = \"IMAGE\",\n VIDEO = \"VIDEO\"\n }\n interface StopSyncRequest {\n /** External Project ID */\n externalId: string;\n }\n interface StopSyncResponse {\n /** External Project ID */\n externalId?: string;\n }\n interface GetLoginRedirectableUrlRequest {\n }\n interface GetLoginRedirectableUrlResponse {\n url?: string;\n }\n interface SyncedProjectsProviderConfig {\n /** The Provider Name */\n providerName?: string;\n /** which project's fields are fully synced by the provider, and therefore will not be editable through Wix Portfolio project page. */\n projectSyncedFields?: 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 /** 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 GetProjectsOptions {\n /** Filter Designs by pages. Designs are sorted */\n paging?: CursorPaging;\n }\n interface SyncProjectOptions {\n /** if need to get the next items page that just asked for sync */\n itemsPaging?: CursorPaging;\n }\n \n function unauthenticated$2(data: UserUnauthorizedError): BusinessError;\n function dataNotReady$1(data: DataNotReady): BusinessError;\n function rateLimitExceeded$2(data: RateLimitExceeded): BusinessError;\n \n namespace getProjectsSpiErrors_d {\n export {\n unauthenticated$2 as unauthenticated,\n dataNotReady$1 as dataNotReady,\n rateLimitExceeded$2 as rateLimitExceeded,\n };\n }\n \n function unauthenticated$1(data: UserUnauthorizedError): BusinessError;\n function dataNotReady(data: DataNotReady): BusinessError;\n function rateLimitExceeded$1(data: RateLimitExceeded): BusinessError;\n \n const syncProjectSpiErrors_d_dataNotReady: typeof dataNotReady;\n namespace syncProjectSpiErrors_d {\n export {\n unauthenticated$1 as unauthenticated,\n syncProjectSpiErrors_d_dataNotReady as dataNotReady,\n rateLimitExceeded$1 as rateLimitExceeded,\n };\n }\n \n function unauthenticated(data: UserUnauthorizedError): BusinessError;\n function rateLimitExceeded(data: RateLimitExceeded): BusinessError;\n \n const stopSyncSpiErrors_d_unauthenticated: typeof unauthenticated;\n const stopSyncSpiErrors_d_rateLimitExceeded: typeof rateLimitExceeded;\n namespace stopSyncSpiErrors_d {\n export {\n stopSyncSpiErrors_d_unauthenticated as unauthenticated,\n stopSyncSpiErrors_d_rateLimitExceeded as rateLimitExceeded,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n getProjectsSpiErrors_d as getProjects,\n syncProjectSpiErrors_d as syncProject,\n stopSyncSpiErrors_d as stopSync,\n };\n }\n \n export { BusinessError, Context, CursorPaging, Cursors, DataNotReady, GetLoginRedirectableUrlRequest, GetLoginRedirectableUrlResponse, GetProjectsOptions, GetProjectsRequest, GetProjectsResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, Item, MediaType, PagingMetadataV2, Project, RateLimitExceeded, StopSyncRequest, StopSyncResponse, SyncProjectOptions, SyncProjectRequest, SyncProjectResponse, SyncedProjectsProviderConfig, UserUnauthorizedError, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-recruitment-agencies-applications-backend.d.ts", "content": "declare module \"wix-recruitment-agencies-applications-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface AgencyApplication {\n /** Candidate's name */\n candidateFirstName?: string;\n /** Candidate's name */\n candidateLastName?: string;\n /** Candidate's email */\n candidateEmail?: string;\n /** Candidate's application short (4 digits) number */\n positionNum?: number;\n /** Candidate's applications title (posting title in People system) */\n positionTitle?: string;\n /** Hiring process short status */\n status?: HiringProcessStatusEnum;\n /** Hiring process long status */\n statusV2?: HiringProcessStatusV2Enum;\n /** Hiring process source - where the process initiated from */\n source?: Source;\n /**\n * PostingId in people system\n * @readonly\n */\n postingId?: string;\n /** is eligible for repeated application */\n isEligibleForRepeatedApplication?: boolean;\n /** @readonly */\n _id?: string;\n }\n interface HiringProcessStatusEnum {\n /** Hiring process status */\n status?: HiringProcessStatus;\n }\n enum HiringProcessStatus {\n ACTIVE = \"ACTIVE\",\n REJECTED = \"REJECTED\",\n HIRED = \"HIRED\"\n }\n interface HiringProcessStatusV2Enum {\n /** Hiring process status */\n status?: HiringProcessStatusV2;\n }\n enum HiringProcessStatusV2 {\n ACTIVE = \"ACTIVE\",\n AWAITING_REJECTION_NOTIFICATION = \"AWAITING_REJECTION_NOTIFICATION\",\n REJECTED = \"REJECTED\",\n KEPT_FOR_LATER = \"KEPT_FOR_LATER\",\n MOVED_FOR_ANOTHER_POSITION = \"MOVED_FOR_ANOTHER_POSITION\",\n HIRED = \"HIRED\",\n HIRED_FOR_ANOTHER_POSITION = \"HIRED_FOR_ANOTHER_POSITION\",\n STARTED_INTERNAL_PROCESS = \"STARTED_INTERNAL_PROCESS\"\n }\n interface Source extends SourceValueOneOf {\n /** source type, available values defined in People system */\n type?: string;\n /** source type is referral */\n referral?: Referral;\n /** source type is value selected from list */\n select?: Select;\n /** source type is unstructured text */\n text?: Text;\n }\n /** @oneof */\n interface SourceValueOneOf {\n /** source type is referral */\n referral?: Referral;\n /** source type is value selected from list */\n select?: Select;\n /** source type is unstructured text */\n text?: Text;\n }\n interface Referral {\n _id?: string;\n }\n interface Select {\n /** available options to select */\n option?: string[];\n }\n interface Text {\n /** select values */\n text?: string;\n }\n interface GetAgencyApplicationsRequest {\n }\n interface GetAgencyApplicationsResponse {\n /** agency applications of applicants */\n application?: AgencyApplication[];\n }\n /** GetAgencyPositions return application for agency */\n function getAgencyApplications(): Promise;\n \n const peopleAgenciesPortalV1AgencyApplication_universal_d___debug: typeof __debug;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_AgencyApplication = AgencyApplication;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusEnum = HiringProcessStatusEnum;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatus = HiringProcessStatus;\n const peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatus: typeof HiringProcessStatus;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusV2Enum = HiringProcessStatusV2Enum;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusV2 = HiringProcessStatusV2;\n const peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusV2: typeof HiringProcessStatusV2;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_Source = Source;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_SourceValueOneOf = SourceValueOneOf;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_Referral = Referral;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_Select = Select;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_Text = Text;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_GetAgencyApplicationsRequest = GetAgencyApplicationsRequest;\n type peopleAgenciesPortalV1AgencyApplication_universal_d_GetAgencyApplicationsResponse = GetAgencyApplicationsResponse;\n const peopleAgenciesPortalV1AgencyApplication_universal_d_getAgencyApplications: typeof getAgencyApplications;\n namespace peopleAgenciesPortalV1AgencyApplication_universal_d {\n export {\n peopleAgenciesPortalV1AgencyApplication_universal_d___debug as __debug,\n peopleAgenciesPortalV1AgencyApplication_universal_d_AgencyApplication as AgencyApplication,\n peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusEnum as HiringProcessStatusEnum,\n peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatus as HiringProcessStatus,\n peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusV2Enum as HiringProcessStatusV2Enum,\n peopleAgenciesPortalV1AgencyApplication_universal_d_HiringProcessStatusV2 as HiringProcessStatusV2,\n peopleAgenciesPortalV1AgencyApplication_universal_d_Source as Source,\n peopleAgenciesPortalV1AgencyApplication_universal_d_SourceValueOneOf as SourceValueOneOf,\n peopleAgenciesPortalV1AgencyApplication_universal_d_Referral as Referral,\n peopleAgenciesPortalV1AgencyApplication_universal_d_Select as Select,\n peopleAgenciesPortalV1AgencyApplication_universal_d_Text as Text,\n peopleAgenciesPortalV1AgencyApplication_universal_d_GetAgencyApplicationsRequest as GetAgencyApplicationsRequest,\n peopleAgenciesPortalV1AgencyApplication_universal_d_GetAgencyApplicationsResponse as GetAgencyApplicationsResponse,\n peopleAgenciesPortalV1AgencyApplication_universal_d_getAgencyApplications as getAgencyApplications,\n };\n }\n \n export { peopleAgenciesPortalV1AgencyApplication_universal_d as recruitmentAgenciesApplications };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-recruitment-agencies-info-backend.d.ts", "content": "declare module \"wix-recruitment-agencies-info-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Agency {\n /** @readonly */\n _id?: string;\n /** agency user */\n agencyUser?: AgencyUser;\n /** is this message for production or for testing? */\n production?: boolean;\n /** tenant id */\n tenantId?: string;\n }\n interface AgencyUser {\n /** agency user's email */\n email?: string;\n /** agency user's name */\n firstName?: string;\n /** agency user's name */\n lastName?: string;\n /** is agency user active? */\n isActive?: boolean;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n entityUpdates?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\n }\n interface GetAgencyInfoRequest {\n }\n interface GetAgencyInfoResponse {\n /** agency info of current user */\n agency?: Agency;\n }\n /**\n * GetAgencyInfo returns current agency info\n * @internal\n * @documentationMaturity preview\n */\n function getAgencyInfo(): Promise;\n \n const peopleAgenciesPortalV1Agency_universal_d___debug: typeof __debug;\n type peopleAgenciesPortalV1Agency_universal_d_Agency = Agency;\n type peopleAgenciesPortalV1Agency_universal_d_AgencyUser = AgencyUser;\n type peopleAgenciesPortalV1Agency_universal_d_DomainEvent = DomainEvent;\n type peopleAgenciesPortalV1Agency_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type peopleAgenciesPortalV1Agency_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type peopleAgenciesPortalV1Agency_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type peopleAgenciesPortalV1Agency_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type peopleAgenciesPortalV1Agency_universal_d_ActionEvent = ActionEvent;\n type peopleAgenciesPortalV1Agency_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type peopleAgenciesPortalV1Agency_universal_d_Empty = Empty;\n type peopleAgenciesPortalV1Agency_universal_d_GetAgencyInfoRequest = GetAgencyInfoRequest;\n type peopleAgenciesPortalV1Agency_universal_d_GetAgencyInfoResponse = GetAgencyInfoResponse;\n const peopleAgenciesPortalV1Agency_universal_d_getAgencyInfo: typeof getAgencyInfo;\n namespace peopleAgenciesPortalV1Agency_universal_d {\n export {\n peopleAgenciesPortalV1Agency_universal_d___debug as __debug,\n peopleAgenciesPortalV1Agency_universal_d_Agency as Agency,\n peopleAgenciesPortalV1Agency_universal_d_AgencyUser as AgencyUser,\n peopleAgenciesPortalV1Agency_universal_d_DomainEvent as DomainEvent,\n peopleAgenciesPortalV1Agency_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n peopleAgenciesPortalV1Agency_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n peopleAgenciesPortalV1Agency_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n peopleAgenciesPortalV1Agency_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n peopleAgenciesPortalV1Agency_universal_d_ActionEvent as ActionEvent,\n peopleAgenciesPortalV1Agency_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n peopleAgenciesPortalV1Agency_universal_d_Empty as Empty,\n peopleAgenciesPortalV1Agency_universal_d_GetAgencyInfoRequest as GetAgencyInfoRequest,\n peopleAgenciesPortalV1Agency_universal_d_GetAgencyInfoResponse as GetAgencyInfoResponse,\n peopleAgenciesPortalV1Agency_universal_d_getAgencyInfo as getAgencyInfo,\n };\n }\n \n export { peopleAgenciesPortalV1Agency_universal_d as recruitmentAgenciesInfo };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-stores-backend-poc.v2.d.ts", "content": "declare module \"wix-stores-backend-poc.v2\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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$1;\n /**\n * Number of products in the collection. Read only.\n * @readonly\n */\n numberOfProducts?: number;\n /** Collection description. The description length without HTML must not exceed 2000 characters (10K includes HTML) */\n description?: string | null;\n /** Collection slug */\n slug?: string | null;\n /** Collection visibility. Only impacts dynamic pages, no impact on static pages */\n visible?: boolean | null;\n }\n interface Media$1 {\n /** Primary media (image, video etc) associated with this product. */\n mainMedia?: MediaItem$1;\n /** Media (images, videos etc) associated with this product. */\n items?: MediaItem$1[];\n }\n interface MediaItem$1 extends MediaItemItemOneOf$1 {\n /** Media item thumbnail details. */\n thumbnail?: MediaItemUrlAndSize$1;\n /** Media item type (image, video, etc.). */\n mediaType?: MediaItemType$1;\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 /** Image data (URL, size). */\n image?: MediaItemUrlAndSize$1;\n /** Video data (URL, size). */\n video?: MediaItemVideo$1;\n }\n /** @oneof */\n interface MediaItemItemOneOf$1 {\n /** Image data (URL, size). */\n image?: MediaItemUrlAndSize$1;\n /** Video data (URL, size). */\n video?: MediaItemVideo$1;\n }\n interface MediaItemUrlAndSize$1 {\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$1 {\n unspecified_media_item_type = \"unspecified_media_item_type\",\n image = \"image\",\n video = \"video\",\n audio = \"audio\",\n document = \"document\",\n zip = \"zip\"\n }\n interface MediaItemVideo$1 {\n /** Data (URL, size) about each resolution for which this video is available. */\n files?: MediaItemUrlAndSize$1[];\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 GetCollectionRequest {\n /** Requested collection ID. */\n collectionId: 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 /** Include description in response. When False, description will be null */\n includeDescription?: boolean;\n }\n interface GetCollectionResponse {\n collection?: Collection;\n }\n interface QueryCollectionsRequest {\n query?: PlatformQuery$1;\n /** Whether number of products should be included in the response. */\n includeNumberOfProducts?: boolean;\n /** Include description in response. When False, description will be null */\n includeDescription?: boolean;\n }\n interface PlatformQuery$1 extends PlatformQueryPagingMethodOneOf$1 {\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting$1[];\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging$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 }\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 QueryCollectionsResponse {\n collections?: Collection[];\n metadata?: 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 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 /** @param collectionId - Requested collection ID.\n * @public\n * @requiredField collectionId\n */\n function getCollection(collectionId: string, options?: GetCollectionOptions): Promise;\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 /** Include description in response. When False, description will be null */\n includeDescription?: boolean;\n }\n /** @public */\n function queryCollections(): CollectionsQueryBuilder;\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 CollectionsQueryResult extends QueryOffsetResult$1 {\n items: Collection[];\n query: CollectionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CollectionsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: string, value: any) => CollectionsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: string, value: any) => CollectionsQueryBuilder;\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) => CollectionsQueryBuilder;\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[]) => CollectionsQueryBuilder;\n in: (propertyName: string, value: any) => CollectionsQueryBuilder;\n exists: (propertyName: string, value: boolean) => CollectionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: string[]) => CollectionsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: string[]) => CollectionsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => CollectionsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results. */\n skip: (skip: number) => CollectionsQueryBuilder;\n find: () => Promise;\n }\n \n type storesPocV1Collection_universal_d_Collection = Collection;\n type storesPocV1Collection_universal_d_GetCollectionRequest = GetCollectionRequest;\n type storesPocV1Collection_universal_d_GetCollectionResponse = GetCollectionResponse;\n type storesPocV1Collection_universal_d_QueryCollectionsRequest = QueryCollectionsRequest;\n type storesPocV1Collection_universal_d_QueryCollectionsResponse = QueryCollectionsResponse;\n const storesPocV1Collection_universal_d_getCollection: typeof getCollection;\n type storesPocV1Collection_universal_d_GetCollectionOptions = GetCollectionOptions;\n const storesPocV1Collection_universal_d_queryCollections: typeof queryCollections;\n type storesPocV1Collection_universal_d_CollectionsQueryResult = CollectionsQueryResult;\n type storesPocV1Collection_universal_d_CollectionsQueryBuilder = CollectionsQueryBuilder;\n namespace storesPocV1Collection_universal_d {\n export {\n __debug$1 as __debug,\n storesPocV1Collection_universal_d_Collection as Collection,\n Media$1 as Media,\n MediaItem$1 as MediaItem,\n MediaItemItemOneOf$1 as MediaItemItemOneOf,\n MediaItemUrlAndSize$1 as MediaItemUrlAndSize,\n MediaItemType$1 as MediaItemType,\n MediaItemVideo$1 as MediaItemVideo,\n storesPocV1Collection_universal_d_GetCollectionRequest as GetCollectionRequest,\n storesPocV1Collection_universal_d_GetCollectionResponse as GetCollectionResponse,\n storesPocV1Collection_universal_d_QueryCollectionsRequest as QueryCollectionsRequest,\n PlatformQuery$1 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n PlatformPaging$1 as PlatformPaging,\n storesPocV1Collection_universal_d_QueryCollectionsResponse as QueryCollectionsResponse,\n PlatformPagingMetadata$1 as PlatformPagingMetadata,\n Cursors$1 as Cursors,\n storesPocV1Collection_universal_d_getCollection as getCollection,\n storesPocV1Collection_universal_d_GetCollectionOptions as GetCollectionOptions,\n storesPocV1Collection_universal_d_queryCollections as queryCollections,\n storesPocV1Collection_universal_d_CollectionsQueryResult as CollectionsQueryResult,\n storesPocV1Collection_universal_d_CollectionsQueryBuilder as CollectionsQueryBuilder,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Product {\n /**\n * Product ID (generated automatically by the catalog).\n * @readonly\n */\n _id?: string;\n /** Product name. */\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. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */\n description?: string | null;\n /** Stock keeping unit (if variant management is enabled, SKUs will be set per variant, and this field will be empty). */\n sku?: string | null;\n /** Product weight (if variant management 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 * com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange weight_range = 32 [(wix.api.readOnly) = true];\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 */\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 * com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange price_range = 31 [(wix.api.readOnly) = true];\n * Cost and profit data.\n */\n costAndProfitData?: CostAndProfitData;\n /**\n * Product cost range. The minimum and maximum costs of all the variants.\n * com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange cost_range = 33 [(wix.api.readOnly) = true];\n * Price per unit data.\n */\n pricePerUnitData?: PricePerUnitData;\n /**\n * Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). Currently writable only from the UI.\n * @readonly\n */\n additionalInfoSections?: AdditionalInfoSection[];\n /**\n * Deprecated (use `ribbon` instead).\n * @readonly\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. */\n manageVariants?: boolean | null;\n /** Options (color, size, etc) 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 flag.\n * @readonly\n */\n variants?: Variant[];\n /**\n * Date and time the product was last updated.\n * google.protobuf.Timestamp last_updated = 24 [(wix.api.readOnly) = true];\n * Date and time the product was created.\n * google.protobuf.Timestamp created_date = 34 [(wix.api.readOnly) = true];\n * Custom SEO data for the product.\n * com.wixpress.advanced.seo.SeoSchema seo_data = 27;\n * Product ribbon. Used to highlight relevant information about a product. For example, \"Sale\", \"New Arrival\", \"Sold Out\".\n */\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 * tax group id\n * @internal\n * @readonly\n */\n taxGroupId?: string | null;\n /**\n * internal field used by import/export to know how to link products in csv file to product ids\n * @internal\n * @readonly\n */\n exportProductId?: string;\n }\n enum ProductType {\n unspecified_product_type = \"unspecified_product_type\",\n physical = \"physical\",\n digital = \"digital\"\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 */\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 = \"IN_STOCK\",\n OUT_OF_STOCK = \"OUT_OF_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 /** 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 /** Image data (URL, size). */\n image?: MediaItemUrlAndSize;\n /** Video data (URL, size). */\n video?: MediaItemVideo;\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 = \"image\",\n video = \"video\",\n audio = \"audio\",\n document = \"document\",\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 - color or other(drop down)\n * @readonly\n */\n optionType?: OptionType;\n /** Option name (e.g., color, size) */\n name?: string;\n /** Choices available for this option */\n choices?: Choice[];\n }\n enum OptionType {\n unspecified_option_type = \"unspecified_option_type\",\n drop_down = \"drop_down\",\n color = \"color\"\n }\n interface Choice {\n /** Color hex value or choice name */\n value?: string;\n /** Choice name */\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 /** Discount type: amount / percent */\n type?: DiscountType;\n /** Discount value */\n value?: number;\n }\n enum DiscountType {\n UNDEFINED = \"UNDEFINED\",\n /** No discount */\n NONE = \"NONE\",\n AMOUNT = \"AMOUNT\",\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 interface GetProductRequest {\n /** Requested product ID. */\n productId: string;\n /** Whether merchant specific 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 QueryProductsRequest {\n query?: PlatformQuery;\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 PlatformQuery extends PlatformQueryPagingMethodOneOf {\n /** Filter object. */\n filter?: Record | null;\n /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n sort?: Sorting[];\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging;\n }\n /** @oneof */\n interface PlatformQueryPagingMethodOneOf {\n /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n paging?: PlatformPaging;\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 QueryProductsResponse {\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 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 /** @param productId - Requested product ID.\n * @public\n * @requiredField productId\n * @returns Requested product data.\n */\n function getProduct(productId: string, options?: GetProductOptions): Promise;\n interface GetProductOptions {\n /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */\n includeMerchantSpecificData?: boolean;\n }\n /** @public */\n function queryProducts(): ProductsQueryBuilder;\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 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: string, value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: string, value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ge: (propertyName: string, value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n gt: (propertyName: string, value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n le: (propertyName: string, value: any) => ProductsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n lt: (propertyName: string, 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: string, 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: string, value: any[]) => ProductsQueryBuilder;\n in: (propertyName: string, value: any) => ProductsQueryBuilder;\n exists: (propertyName: string, value: boolean) => ProductsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: string[]) => ProductsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: string[]) => 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 \n const storesPocV1Product_universal_d___debug: typeof __debug;\n type storesPocV1Product_universal_d_Product = Product;\n type storesPocV1Product_universal_d_ProductType = ProductType;\n const storesPocV1Product_universal_d_ProductType: typeof ProductType;\n type storesPocV1Product_universal_d_Stock = Stock;\n type storesPocV1Product_universal_d_InventoryStatus = InventoryStatus;\n const storesPocV1Product_universal_d_InventoryStatus: typeof InventoryStatus;\n type storesPocV1Product_universal_d_PriceData = PriceData;\n type storesPocV1Product_universal_d_FormattedPrice = FormattedPrice;\n type storesPocV1Product_universal_d_CostAndProfitData = CostAndProfitData;\n type storesPocV1Product_universal_d_PricePerUnitData = PricePerUnitData;\n type storesPocV1Product_universal_d_MeasurementUnit = MeasurementUnit;\n const storesPocV1Product_universal_d_MeasurementUnit: typeof MeasurementUnit;\n type storesPocV1Product_universal_d_AdditionalInfoSection = AdditionalInfoSection;\n type storesPocV1Product_universal_d_Ribbon = Ribbon;\n type storesPocV1Product_universal_d_Media = Media;\n type storesPocV1Product_universal_d_MediaItem = MediaItem;\n type storesPocV1Product_universal_d_MediaItemItemOneOf = MediaItemItemOneOf;\n type storesPocV1Product_universal_d_MediaItemUrlAndSize = MediaItemUrlAndSize;\n type storesPocV1Product_universal_d_MediaItemType = MediaItemType;\n const storesPocV1Product_universal_d_MediaItemType: typeof MediaItemType;\n type storesPocV1Product_universal_d_MediaItemVideo = MediaItemVideo;\n type storesPocV1Product_universal_d_CustomTextField = CustomTextField;\n type storesPocV1Product_universal_d_ProductOption = ProductOption;\n type storesPocV1Product_universal_d_OptionType = OptionType;\n const storesPocV1Product_universal_d_OptionType: typeof OptionType;\n type storesPocV1Product_universal_d_Choice = Choice;\n type storesPocV1Product_universal_d_PageUrl = PageUrl;\n type storesPocV1Product_universal_d_Discount = Discount;\n type storesPocV1Product_universal_d_DiscountType = DiscountType;\n const storesPocV1Product_universal_d_DiscountType: typeof DiscountType;\n type storesPocV1Product_universal_d_Variant = Variant;\n type storesPocV1Product_universal_d_VariantDataWithNoStock = VariantDataWithNoStock;\n type storesPocV1Product_universal_d_VariantStock = VariantStock;\n type storesPocV1Product_universal_d_GetProductRequest = GetProductRequest;\n type storesPocV1Product_universal_d_GetProductResponse = GetProductResponse;\n type storesPocV1Product_universal_d_QueryProductsRequest = QueryProductsRequest;\n type storesPocV1Product_universal_d_PlatformQuery = PlatformQuery;\n type storesPocV1Product_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type storesPocV1Product_universal_d_Sorting = Sorting;\n type storesPocV1Product_universal_d_SortOrder = SortOrder;\n const storesPocV1Product_universal_d_SortOrder: typeof SortOrder;\n type storesPocV1Product_universal_d_PlatformPaging = PlatformPaging;\n type storesPocV1Product_universal_d_QueryProductsResponse = QueryProductsResponse;\n type storesPocV1Product_universal_d_PlatformPagingMetadata = PlatformPagingMetadata;\n type storesPocV1Product_universal_d_Cursors = Cursors;\n const storesPocV1Product_universal_d_getProduct: typeof getProduct;\n type storesPocV1Product_universal_d_GetProductOptions = GetProductOptions;\n const storesPocV1Product_universal_d_queryProducts: typeof queryProducts;\n type storesPocV1Product_universal_d_ProductsQueryResult = ProductsQueryResult;\n type storesPocV1Product_universal_d_ProductsQueryBuilder = ProductsQueryBuilder;\n namespace storesPocV1Product_universal_d {\n export {\n storesPocV1Product_universal_d___debug as __debug,\n storesPocV1Product_universal_d_Product as Product,\n storesPocV1Product_universal_d_ProductType as ProductType,\n storesPocV1Product_universal_d_Stock as Stock,\n storesPocV1Product_universal_d_InventoryStatus as InventoryStatus,\n storesPocV1Product_universal_d_PriceData as PriceData,\n storesPocV1Product_universal_d_FormattedPrice as FormattedPrice,\n storesPocV1Product_universal_d_CostAndProfitData as CostAndProfitData,\n storesPocV1Product_universal_d_PricePerUnitData as PricePerUnitData,\n storesPocV1Product_universal_d_MeasurementUnit as MeasurementUnit,\n storesPocV1Product_universal_d_AdditionalInfoSection as AdditionalInfoSection,\n storesPocV1Product_universal_d_Ribbon as Ribbon,\n storesPocV1Product_universal_d_Media as Media,\n storesPocV1Product_universal_d_MediaItem as MediaItem,\n storesPocV1Product_universal_d_MediaItemItemOneOf as MediaItemItemOneOf,\n storesPocV1Product_universal_d_MediaItemUrlAndSize as MediaItemUrlAndSize,\n storesPocV1Product_universal_d_MediaItemType as MediaItemType,\n storesPocV1Product_universal_d_MediaItemVideo as MediaItemVideo,\n storesPocV1Product_universal_d_CustomTextField as CustomTextField,\n storesPocV1Product_universal_d_ProductOption as ProductOption,\n storesPocV1Product_universal_d_OptionType as OptionType,\n storesPocV1Product_universal_d_Choice as Choice,\n storesPocV1Product_universal_d_PageUrl as PageUrl,\n storesPocV1Product_universal_d_Discount as Discount,\n storesPocV1Product_universal_d_DiscountType as DiscountType,\n storesPocV1Product_universal_d_Variant as Variant,\n storesPocV1Product_universal_d_VariantDataWithNoStock as VariantDataWithNoStock,\n storesPocV1Product_universal_d_VariantStock as VariantStock,\n storesPocV1Product_universal_d_GetProductRequest as GetProductRequest,\n storesPocV1Product_universal_d_GetProductResponse as GetProductResponse,\n storesPocV1Product_universal_d_QueryProductsRequest as QueryProductsRequest,\n storesPocV1Product_universal_d_PlatformQuery as PlatformQuery,\n storesPocV1Product_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf,\n storesPocV1Product_universal_d_Sorting as Sorting,\n storesPocV1Product_universal_d_SortOrder as SortOrder,\n storesPocV1Product_universal_d_PlatformPaging as PlatformPaging,\n storesPocV1Product_universal_d_QueryProductsResponse as QueryProductsResponse,\n storesPocV1Product_universal_d_PlatformPagingMetadata as PlatformPagingMetadata,\n storesPocV1Product_universal_d_Cursors as Cursors,\n storesPocV1Product_universal_d_getProduct as getProduct,\n storesPocV1Product_universal_d_GetProductOptions as GetProductOptions,\n storesPocV1Product_universal_d_queryProducts as queryProducts,\n storesPocV1Product_universal_d_ProductsQueryResult as ProductsQueryResult,\n storesPocV1Product_universal_d_ProductsQueryBuilder as ProductsQueryBuilder,\n };\n }\n \n export { storesPocV1Collection_universal_d as collections, storesPocV1Product_universal_d as products };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-os-backend.d.ts", "content": "declare module \"wix-os-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\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 * __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 /** Location type. **Note:** Currently not supported. */\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;\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 }\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 }\n interface Address {\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 }\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 {\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 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](https://bo.wix.com/wix-docs/rest/crm/contacts/sort-and-filter). */\n sort?: Sorting;\n /** [Pagination](https://bo.wix.com/wix-docs/rest/crm/contacts/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */\n paging?: Paging;\n /** Whether to include `archived` locations in the response. Defaults to `false`. */\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 /** 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 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 default. */\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 /**\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 */\n function createLocation(location: Location): Promise;\n /**\n * Creates locations in bulk.\n * @param locations - Locations to create.\n * @documentationMaturity preview\n * @requiredField locations\n */\n function bulkCreateLocation(locations: 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 */\n function getLocation(_id: string): Promise;\n /**\n * Retrieves locations, given the provided filters, sorting, and paging.\n * @public\n * @documentationMaturity preview\n */\n function listLocations(options?: ListLocationsOptions): Promise;\n interface ListLocationsOptions {\n /** [Sort order](https://bo.wix.com/wix-docs/rest/crm/contacts/sort-and-filter). */\n sort?: Sorting;\n /** [Pagination](https://bo.wix.com/wix-docs/rest/crm/contacts/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000). */\n paging?: Paging;\n /** Whether to include `archived` locations in the response. Defaults to `false`. */\n includeArchived?: boolean;\n }\n /**\n * Replaces a location.\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 */\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 * __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 /** Location type. **Note:** Currently not supported. */\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;\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 }\n /**\n * Replaces locations in bulk.\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 locations - Locations to update.\n * @documentationMaturity preview\n * @requiredField locations\n */\n function bulkUpdateLocation(locations: Location[]): Promise;\n /**\n * Retrieves locations, given the provided filters, sorting, and paging.\n * @public\n * @documentationMaturity preview\n */\n function queryLocations(options?: QueryLocationsOptions): Promise;\n interface QueryLocationsOptions {\n /** Information about the filters, sorting, and paging. */\n query?: Query;\n }\n /**\n * Sets a new default location.\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 default.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function setDefaultLocation(_id: string): Promise;\n /**\n * Archives a location.\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 */\n function archiveLocation(_id: string): Promise;\n \n const locationsV1Location_universal_d___debug: typeof __debug;\n type locationsV1Location_universal_d_Location = Location;\n type locationsV1Location_universal_d_LocationStatus = LocationStatus;\n const locationsV1Location_universal_d_LocationStatus: typeof LocationStatus;\n type locationsV1Location_universal_d_LocationType = LocationType;\n const locationsV1Location_universal_d_LocationType: typeof LocationType;\n type locationsV1Location_universal_d_Address = Address;\n type locationsV1Location_universal_d_StreetAddress = StreetAddress;\n type locationsV1Location_universal_d_AddressLocation = AddressLocation;\n type locationsV1Location_universal_d_BusinessSchedule = BusinessSchedule;\n type locationsV1Location_universal_d_TimePeriod = TimePeriod;\n type locationsV1Location_universal_d_DayOfWeek = DayOfWeek;\n const locationsV1Location_universal_d_DayOfWeek: typeof DayOfWeek;\n type locationsV1Location_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type locationsV1Location_universal_d_CreateLocationRequest = CreateLocationRequest;\n type locationsV1Location_universal_d_CreateLocationResponse = CreateLocationResponse;\n type locationsV1Location_universal_d_BulkCreateLocationRequest = BulkCreateLocationRequest;\n type locationsV1Location_universal_d_BulkCreateLocationResponse = BulkCreateLocationResponse;\n type locationsV1Location_universal_d_FailedCreateLocation = FailedCreateLocation;\n type locationsV1Location_universal_d_GetLocationRequest = GetLocationRequest;\n type locationsV1Location_universal_d_GetLocationResponse = GetLocationResponse;\n type locationsV1Location_universal_d_ListLocationsRequest = ListLocationsRequest;\n type locationsV1Location_universal_d_Sorting = Sorting;\n type locationsV1Location_universal_d_SortOrder = SortOrder;\n const locationsV1Location_universal_d_SortOrder: typeof SortOrder;\n type locationsV1Location_universal_d_Paging = Paging;\n type locationsV1Location_universal_d_ListLocationsResponse = ListLocationsResponse;\n type locationsV1Location_universal_d_PagingMetadata = PagingMetadata;\n type locationsV1Location_universal_d_UpdateLocationRequest = UpdateLocationRequest;\n type locationsV1Location_universal_d_UpdateLocationResponse = UpdateLocationResponse;\n type locationsV1Location_universal_d_BulkUpdateLocationRequest = BulkUpdateLocationRequest;\n type locationsV1Location_universal_d_BulkUpdateLocationResponse = BulkUpdateLocationResponse;\n type locationsV1Location_universal_d_FailedUpdateLocation = FailedUpdateLocation;\n type locationsV1Location_universal_d_QueryLocationsRequest = QueryLocationsRequest;\n type locationsV1Location_universal_d_Query = Query;\n type locationsV1Location_universal_d_QueryLocationsResponse = QueryLocationsResponse;\n type locationsV1Location_universal_d_SetDefaultLocationRequest = SetDefaultLocationRequest;\n type locationsV1Location_universal_d_SetDefaultLocationResponse = SetDefaultLocationResponse;\n type locationsV1Location_universal_d_SetDefaultLocation = SetDefaultLocation;\n type locationsV1Location_universal_d_ArchiveLocationRequest = ArchiveLocationRequest;\n type locationsV1Location_universal_d_ArchiveLocationResponse = ArchiveLocationResponse;\n type locationsV1Location_universal_d_ArchiveLocation = ArchiveLocation;\n const locationsV1Location_universal_d_createLocation: typeof createLocation;\n const locationsV1Location_universal_d_bulkCreateLocation: typeof bulkCreateLocation;\n const locationsV1Location_universal_d_getLocation: typeof getLocation;\n const locationsV1Location_universal_d_listLocations: typeof listLocations;\n type locationsV1Location_universal_d_ListLocationsOptions = ListLocationsOptions;\n const locationsV1Location_universal_d_updateLocation: typeof updateLocation;\n type locationsV1Location_universal_d_UpdateLocation = UpdateLocation;\n const locationsV1Location_universal_d_bulkUpdateLocation: typeof bulkUpdateLocation;\n const locationsV1Location_universal_d_queryLocations: typeof queryLocations;\n type locationsV1Location_universal_d_QueryLocationsOptions = QueryLocationsOptions;\n const locationsV1Location_universal_d_setDefaultLocation: typeof setDefaultLocation;\n const locationsV1Location_universal_d_archiveLocation: typeof archiveLocation;\n namespace locationsV1Location_universal_d {\n export {\n locationsV1Location_universal_d___debug as __debug,\n locationsV1Location_universal_d_Location as Location,\n locationsV1Location_universal_d_LocationStatus as LocationStatus,\n locationsV1Location_universal_d_LocationType as LocationType,\n locationsV1Location_universal_d_Address as Address,\n locationsV1Location_universal_d_StreetAddress as StreetAddress,\n locationsV1Location_universal_d_AddressLocation as AddressLocation,\n locationsV1Location_universal_d_BusinessSchedule as BusinessSchedule,\n locationsV1Location_universal_d_TimePeriod as TimePeriod,\n locationsV1Location_universal_d_DayOfWeek as DayOfWeek,\n locationsV1Location_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n locationsV1Location_universal_d_CreateLocationRequest as CreateLocationRequest,\n locationsV1Location_universal_d_CreateLocationResponse as CreateLocationResponse,\n locationsV1Location_universal_d_BulkCreateLocationRequest as BulkCreateLocationRequest,\n locationsV1Location_universal_d_BulkCreateLocationResponse as BulkCreateLocationResponse,\n locationsV1Location_universal_d_FailedCreateLocation as FailedCreateLocation,\n locationsV1Location_universal_d_GetLocationRequest as GetLocationRequest,\n locationsV1Location_universal_d_GetLocationResponse as GetLocationResponse,\n locationsV1Location_universal_d_ListLocationsRequest as ListLocationsRequest,\n locationsV1Location_universal_d_Sorting as Sorting,\n locationsV1Location_universal_d_SortOrder as SortOrder,\n locationsV1Location_universal_d_Paging as Paging,\n locationsV1Location_universal_d_ListLocationsResponse as ListLocationsResponse,\n locationsV1Location_universal_d_PagingMetadata as PagingMetadata,\n locationsV1Location_universal_d_UpdateLocationRequest as UpdateLocationRequest,\n locationsV1Location_universal_d_UpdateLocationResponse as UpdateLocationResponse,\n locationsV1Location_universal_d_BulkUpdateLocationRequest as BulkUpdateLocationRequest,\n locationsV1Location_universal_d_BulkUpdateLocationResponse as BulkUpdateLocationResponse,\n locationsV1Location_universal_d_FailedUpdateLocation as FailedUpdateLocation,\n locationsV1Location_universal_d_QueryLocationsRequest as QueryLocationsRequest,\n locationsV1Location_universal_d_Query as Query,\n locationsV1Location_universal_d_QueryLocationsResponse as QueryLocationsResponse,\n locationsV1Location_universal_d_SetDefaultLocationRequest as SetDefaultLocationRequest,\n locationsV1Location_universal_d_SetDefaultLocationResponse as SetDefaultLocationResponse,\n locationsV1Location_universal_d_SetDefaultLocation as SetDefaultLocation,\n locationsV1Location_universal_d_ArchiveLocationRequest as ArchiveLocationRequest,\n locationsV1Location_universal_d_ArchiveLocationResponse as ArchiveLocationResponse,\n locationsV1Location_universal_d_ArchiveLocation as ArchiveLocation,\n locationsV1Location_universal_d_createLocation as createLocation,\n locationsV1Location_universal_d_bulkCreateLocation as bulkCreateLocation,\n locationsV1Location_universal_d_getLocation as getLocation,\n locationsV1Location_universal_d_listLocations as listLocations,\n locationsV1Location_universal_d_ListLocationsOptions as ListLocationsOptions,\n locationsV1Location_universal_d_updateLocation as updateLocation,\n locationsV1Location_universal_d_UpdateLocation as UpdateLocation,\n locationsV1Location_universal_d_bulkUpdateLocation as bulkUpdateLocation,\n locationsV1Location_universal_d_queryLocations as queryLocations,\n locationsV1Location_universal_d_QueryLocationsOptions as QueryLocationsOptions,\n locationsV1Location_universal_d_setDefaultLocation as setDefaultLocation,\n locationsV1Location_universal_d_archiveLocation as archiveLocation,\n };\n }\n \n export { locationsV1Location_universal_d as siteManagement };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-email-marketing-backend.d.ts", "content": "declare module \"wix-email-marketing-backend\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\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 Wix business manager and follow the instructions.\n */\n interface AccountDetails {\n /** Account status. */\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 account. */\n WARNED = \"WARNED\",\n /** Must fill out compliance questionnaire, unable to use email marketing. */\n SUSPENDED = \"SUSPENDED\",\n /** Able to open a support ticket, unable to use email marketing. */\n BANNED = \"BANNED\"\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 GetAccountDetailsRequest {\n }\n interface GetAccountDetailsResponse {\n /** Current account details. */\n accountDetails?: AccountDetails;\n }\n /**\n * Retrieves email marketing account details.\n * @public */\n function getAccountDetails(): Promise;\n \n type emailMarketingV1AccountDetails_universal_d_AccountDetails = AccountDetails;\n type emailMarketingV1AccountDetails_universal_d_Package = Package;\n type emailMarketingV1AccountDetails_universal_d_Quota = Quota;\n type emailMarketingV1AccountDetails_universal_d_QuotaPeriod = QuotaPeriod;\n type emailMarketingV1AccountDetails_universal_d_GetAccountDetailsRequest = GetAccountDetailsRequest;\n type emailMarketingV1AccountDetails_universal_d_GetAccountDetailsResponse = GetAccountDetailsResponse;\n const emailMarketingV1AccountDetails_universal_d_getAccountDetails: typeof getAccountDetails;\n namespace emailMarketingV1AccountDetails_universal_d {\n export {\n __debug$1 as __debug,\n emailMarketingV1AccountDetails_universal_d_AccountDetails as AccountDetails,\n Enum$1 as Enum,\n emailMarketingV1AccountDetails_universal_d_Package as Package,\n emailMarketingV1AccountDetails_universal_d_Quota as Quota,\n emailMarketingV1AccountDetails_universal_d_QuotaPeriod as QuotaPeriod,\n emailMarketingV1AccountDetails_universal_d_GetAccountDetailsRequest as GetAccountDetailsRequest,\n emailMarketingV1AccountDetails_universal_d_GetAccountDetailsResponse as GetAccountDetailsResponse,\n emailMarketingV1AccountDetails_universal_d_getAccountDetails as getAccountDetails,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 /** URL of the landing page snapshot. */\n snapshotImageUrl?: string | null;\n /** Editor type. Either web app, or mobile app. */\n editorType?: CampaignEditorTypeEnum;\n /** Campaign status. */\n status?: CampaignStatusEnum;\n /** Campaign visibility status. */\n visibilityStatus?: CampaignVisibilityStatusEnum;\n /** Campaign distribution status. */\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 * Date when the campaign is scheduled, only set if it is a scheduled campaign.\n * @internal\n */\n dateScheduled?: Date;\n /**\n * Rejection data (present only if campaign was rejected).\n * @internal\n */\n rejectionData?: RejectionData;\n /**\n * The sending state of the campaign.\n * @internal\n */\n sendingState?: CampaignSendingStateEnum;\n /**\n * The type of campaign: email marketing, triggered email or automations.\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * \"Parent\" campaign ID.\n * @internal\n */\n resentFromCampaignId?: string | null;\n /**\n * Whether this campaign was resent to recipients who did not open an email.\n * @internal\n */\n wasResentToNonOpeners?: boolean;\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 ListStatisticsRequest {\n /**\n * IDs of the campaigns to retrieve.\n *\n * Max: 100 campaigns\n */\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 /** __Required.__ Email activity to filter for. */\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 }\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 }\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 * 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 * @internal\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 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 (optional). */\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 }\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 /** 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 /** 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 GetCampaignRequest {\n /** Campaign ID. */\n campaignId: string;\n /** If true, campaign should contain statistics (default is 'false'). */\n optionIncludeStatistics?: boolean;\n }\n interface GetCampaignResponse {\n /** Campaign information. */\n campaign?: Campaign;\n }\n interface ListCampaignsRequest {\n /** Paging parameters. */\n paging?: Paging;\n /** Whether a campaign should contain statistics (default is 'false'). */\n optionIncludeStatistics?: boolean;\n /** Include campaigns with the following statuses (no filtering by default). */\n statuses?: CampaignStatusEnum[];\n /** Include campaigns with the following visibility statuses (no filtering by default). */\n visibilityStatuses?: CampaignVisibilityStatusEnum[];\n /** Filter by the following campaign types. */\n campaignType?: CampaignTypeEnum;\n /**\n * Include campaigns with the following distribution statuses (no filtering by default).\n * @internal\n */\n distributionStatuses?: Enum[];\n /**\n * Filter campaigns by publish date (no filtering by default).\n * @internal\n */\n datePublishedFrom?: Date;\n /** @internal */\n datePublishedTo?: Date;\n /**\n * Filter by subject line\n * @internal\n */\n subjectSubstring?: string | null;\n }\n interface ListCampaignsResponse {\n /** Paging parameters. */\n paging?: Paging;\n /** List of campaigns. */\n campaigns?: Campaign[];\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 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 /** Filter ids to send campaign to. */\n filterIds?: string[];\n /** For scheduling (at least one hour in the future, for premium users only). */\n sendAt?: Date;\n /**\n * Contacts filter expression (json).\n * @internal\n */\n contactsFilter?: Record | null;\n /**\n * Segment ids to send campaign to.\n * @internal\n */\n segmentIds?: string[];\n /**\n * Should \"inactive\" contacts be excluded or not (default value \"false\").\n * @internal\n */\n activeContactsOnly?: boolean;\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 /** 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 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 /** @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 * Shows if this is a rescheduling of previously scheduled campaign.\n * @internal\n */\n rescheduled?: boolean;\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 * Values to replace campaign placeholders with (unique for each campaign).\n * @internal\n */\n variables?: Record;\n /**\n * Preferred language for campaign content (optional).\n * @internal\n */\n language?: string | null;\n /**\n * Values to replace campaign placeholders with (unique for each campaign).\n * @internal\n */\n placeholders?: Record;\n /**\n * Sender from name.\n * @internal\n */\n fromName?: string | null;\n /**\n * Reply-to email address.\n * @internal\n */\n replyToEmailAddress?: string | null;\n }\n interface PlaceholderValue {\n /** Placeholder value (string or stringified JSON). */\n value?: string;\n /** Placeholder type. */\n valueType?: Type;\n }\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n PLAIN_TEXT = \"PLAIN_TEXT\",\n HTML = \"HTML\",\n LIVE_SITE_LINK = \"LIVE_SITE_LINK\",\n BACKOFFICE_LINK = \"BACKOFFICE_LINK\",\n MONEY = \"MONEY\",\n DATETIME = \"DATETIME\",\n DATETIME_WITH_TIMEZONE = \"DATETIME_WITH_TIMEZONE\",\n ENUM = \"ENUM\"\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 }\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 }\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 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 ArchiveCampaignRequest {\n /** ID of the campaign to archive. */\n campaignId: string;\n }\n interface ArchiveCampaignResponse {\n }\n interface UnarchiveCampaignRequest {\n /** ID of the campaign to unarchive. */\n campaignId: string;\n }\n interface UnarchiveCampaignResponse {\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 CreatePublishedAutomationRequest {\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 }\n interface CreatePublishedAutomationResponse {\n /** Campaign information. */\n campaign?: Campaign;\n }\n interface PreviewCampaignRequest {\n /** ID of the campaign to preview. */\n campaignId: string;\n /** Values to replace campaign placeholders with (unique for each campaign). */\n variables?: Record;\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 }\n interface PreviewCampaignResponse {\n /** Preview HTML. */\n html?: string;\n }\n interface GetComposerRequest {\n /** Campaign ID. */\n campaignId: string;\n }\n interface GetComposerResponse {\n /** composer */\n composer?: Composer;\n }\n /** INTERNAL */\n interface Composer {\n /** internal data structure for editor/viewer to render the campaign */\n composerDataJson?: string;\n }\n interface CreateCampaignRequest {\n /** Campaign composer. */\n composer: Composer;\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 /** Resend email message subject line. */\n emailSubject?: string | null;\n }\n interface ResendToNonOpenersResponse {\n /** ID of the newly created and resent campaign */\n campaignId?: string;\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](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-campaigns) to retrieve additional information for your campaigns.\n * Use [List Recipients](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-recipients) to retrieve a list of recipients and their activities related to a selected campaign.\n * @param campaignIds - IDs of the campaigns to retrieve.\n *\n * Max: 100 campaigns\n * @public\n * @documentationMaturity preview\n * @requiredField campaignIds\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](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-statistics) to retrieve a list of activity for selected campaigns.\n * Use [List Campaigns](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-campaigns) to retrieve additional information for your campaigns.\n *\n * > __Note__: If no `activity` is included, this endpoint returns an error.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function listRecipients(campaignId: string, options?: ListRecipientsOptions): Promise;\n interface ListRecipientsOptions {\n /** __Required.__ Email activity to filter for. */\n activity?: RecipientsActivityEnum;\n /** Pagination options. */\n paging?: CursorPaging;\n }\n /**\n * get campaign mapping for automation\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.automationRuleId\n * @requiredField identifiers.templateId\n */\n function getCampaignMapping(identifiers: GetCampaignMappingIdentifiers): Promise;\n interface GetCampaignMappingIdentifiers {\n /** rule ID in automations */\n automationRuleId: string;\n /** template ID configured for the automation */\n templateId: string;\n }\n /**\n * get campaign mapping for ping\n * @param streamId - ping stream ID.\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.automationRuleId\n * @requiredField identifiers.templateId\n * @requiredField options.appDefId\n * @requiredField options.language\n * @requiredField streamId\n */\n function getPingCampaignMapping(identifiers: GetPingCampaignMappingIdentifiers, streamId: string, options?: GetPingCampaignMappingOptions): Promise;\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 (optional). */\n language: string;\n }\n /**\n * query automation templates from \"action-triggers-server\" (enriched with campaignId and metaSiteId)\n * https://github.com/wix-private/crm/blob/master/action-triggers-server/action-triggers-integrator-idl/src/main/proto/services/AutomationTemplatesService.proto#L100\n * NOTE: it does not support multi-step automations - enrichment will happen for the first shoutout template id found\n * @documentationMaturity preview */\n function queryAutomationTemplates(options?: QueryAutomationTemplatesOptions): Promise;\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 /** @documentationMaturity preview */\n function queryAppTemplates(options?: QueryAppTemplatesOptions): Promise;\n interface QueryAppTemplatesOptions {\n queryType?: TemplateQueryType;\n }\n /** @documentationMaturity preview\n * @requiredField campaignId\n */\n function campaignLookup(campaignId: string): Promise;\n /** @documentationMaturity preview */\n function campaignLookupBatch(options?: CampaignLookupBatchOptions): Promise;\n interface CampaignLookupBatchOptions {\n campaignIds?: string[];\n }\n /**\n * Retrieves information about an email campaign.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise;\n interface GetCampaignOptions {\n /** If true, campaign should contain statistics (default is 'false'). */\n optionIncludeStatistics?: boolean;\n }\n /**\n * Returns a list of email campaigns. These are always ordered by `date_updated` in descending order.\n * @public\n * @documentationMaturity preview\n */\n function listCampaigns(options?: ListCampaignsOptions): Promise;\n interface ListCampaignsOptions {\n /** Paging parameters. */\n paging?: Paging;\n /** Whether a campaign should contain statistics (default is 'false'). */\n optionIncludeStatistics?: boolean;\n /** Include campaigns with the following statuses (no filtering by default). */\n statuses?: CampaignStatusEnum[];\n /** Include campaigns with the following visibility statuses (no filtering by default). */\n visibilityStatuses?: CampaignVisibilityStatusEnum[];\n /** Filter by the following campaign types. */\n campaignType?: CampaignTypeEnum;\n /**\n * Include campaigns with the following distribution statuses (no filtering by default).\n * @internal\n */\n distributionStatuses?: Enum[];\n /**\n * Filter campaigns by publish date (no filtering by default).\n * @internal\n */\n datePublishedFrom?: Date;\n /** @internal */\n datePublishedTo?: Date;\n /**\n * Filter by subject line\n * @internal\n */\n subjectSubstring?: string | null;\n }\n /**\n * Creates a new draft campaign from a specified template.\n * It can be accessed from TemplateService by tag, or you can ask your designer.\n * @param templateId - ID of the template to fork.\n * @documentationMaturity preview\n * @requiredField templateId\n */\n function createFromTemplate(templateId: string, options?: CreateFromTemplateOptions): Promise;\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 /**\n * Publishes/sends a specified campaign.\n * If `email_distribution_options` are not supplied, the campaign is only published as a landing page.\n * @param campaignId - Campaign ID\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\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. It is heavily throttled - do not use this for regular campaign sending.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField options.toEmailAddress\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 * Values to replace campaign placeholders with (unique for each campaign).\n * @internal\n */\n variables?: Record;\n /**\n * Preferred language for campaign content (optional).\n * @internal\n */\n language?: string | null;\n /**\n * Values to replace campaign placeholders with (unique for each campaign).\n * @internal\n */\n placeholders?: Record;\n /**\n * Sender from name.\n * @internal\n */\n fromName?: string | null;\n /**\n * Reply-to email address.\n * @internal\n */\n replyToEmailAddress?: string | null;\n }\n /**\n * Pauses a scheduled campaign. 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 */\n function pauseScheduling(campaignId: string): Promise;\n /**\n * Marks a campaign as archived\n * @param campaignId - ID of the campaign to archive.\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function archiveCampaign(campaignId: string): Promise;\n /**\n * Marks a campaign as active\n * @param campaignId - ID of the campaign to unarchive.\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function unarchiveCampaign(campaignId: string): Promise;\n /**\n * Changes title of the campaign\n * @param campaignId - ID of the campaign to change title of.\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField title\n */\n function updateTitle(campaignId: string, title: string): Promise;\n /**\n * Deletes a campaign (cannot be undone).\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function deleteCampaign(campaignId: string): Promise;\n /**\n * Creates a (draft) copy of an existing campaign.\n * @param campaignId - ID of the message to be duplicated.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function reuseCampaign(campaignId: string): Promise;\n /**\n * Used by verticals that need to create automations that are already enabled.\n * @param templateId - ID of the template to fork.\n * @documentationMaturity preview\n * @requiredField templateId\n */\n function createPublishedAutomation(templateId: string, options?: CreatePublishedAutomationOptions): Promise;\n interface CreatePublishedAutomationOptions {\n /** Values to replace template placeholders with (unique for each template). */\n variables?: Record;\n }\n /**\n * Build an HTML preview of the campaign. Useful if you need to show the user what their email will look like.\n * @param campaignId - ID of the campaign to preview.\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function preview(campaignId: string, options?: PreviewOptions): Promise;\n interface PreviewOptions {\n /** Values to replace campaign placeholders with (unique for each campaign). */\n variables?: Record;\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 }\n /**\n * For internal use.\n * @param campaignId - Campaign ID.\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function getComposer(campaignId: string): Promise;\n /**\n * For internal use.\n * @param composer - Campaign composer.\n * @documentationMaturity preview\n * @requiredField composer\n * @requiredField composer.composerDataJson\n */\n function create(composer: Composer): Promise;\n /**\n * Resends a copy of campaign to users that did not open it. Different subject line may be used for the new campaign if necessary.\n * @param campaignId - ID of the campaign to resend.\n * @documentationMaturity preview\n * @requiredField campaignId\n */\n function resendToNonOpeners(campaignId: string, options?: ResendToNonOpenersOptions): Promise;\n interface ResendToNonOpenersOptions {\n /** Resend email message subject line. */\n emailSubject?: string | null;\n }\n \n const emailMarketingV1Campaign_universal_d___debug: typeof __debug;\n type emailMarketingV1Campaign_universal_d_Campaign = Campaign;\n type emailMarketingV1Campaign_universal_d_CampaignEditorTypeEnum = CampaignEditorTypeEnum;\n const emailMarketingV1Campaign_universal_d_CampaignEditorTypeEnum: typeof CampaignEditorTypeEnum;\n type emailMarketingV1Campaign_universal_d_CampaignStatusEnum = CampaignStatusEnum;\n const emailMarketingV1Campaign_universal_d_CampaignStatusEnum: typeof CampaignStatusEnum;\n type emailMarketingV1Campaign_universal_d_CampaignVisibilityStatusEnum = CampaignVisibilityStatusEnum;\n const emailMarketingV1Campaign_universal_d_CampaignVisibilityStatusEnum: typeof CampaignVisibilityStatusEnum;\n type emailMarketingV1Campaign_universal_d_Enum = Enum;\n const emailMarketingV1Campaign_universal_d_Enum: typeof Enum;\n type emailMarketingV1Campaign_universal_d_PublishingData = PublishingData;\n type emailMarketingV1Campaign_universal_d_CampaignStatistics = CampaignStatistics;\n type emailMarketingV1Campaign_universal_d_LandingPageStatistics = LandingPageStatistics;\n type emailMarketingV1Campaign_universal_d_DistributionStatistics = DistributionStatistics;\n type emailMarketingV1Campaign_universal_d_TotalStatistics = TotalStatistics;\n type emailMarketingV1Campaign_universal_d_RejectionData = RejectionData;\n type emailMarketingV1Campaign_universal_d_RejectionReasonEnum = RejectionReasonEnum;\n const emailMarketingV1Campaign_universal_d_RejectionReasonEnum: typeof RejectionReasonEnum;\n type emailMarketingV1Campaign_universal_d_CampaignSendingStateEnum = CampaignSendingStateEnum;\n const emailMarketingV1Campaign_universal_d_CampaignSendingStateEnum: typeof CampaignSendingStateEnum;\n type emailMarketingV1Campaign_universal_d_CampaignTypeEnum = CampaignTypeEnum;\n const emailMarketingV1Campaign_universal_d_CampaignTypeEnum: typeof CampaignTypeEnum;\n type emailMarketingV1Campaign_universal_d_ListStatisticsRequest = ListStatisticsRequest;\n type emailMarketingV1Campaign_universal_d_ListStatisticsResponse = ListStatisticsResponse;\n type emailMarketingV1Campaign_universal_d_CampaignStatisticsContainer = CampaignStatisticsContainer;\n type emailMarketingV1Campaign_universal_d_ListRecipientsRequest = ListRecipientsRequest;\n type emailMarketingV1Campaign_universal_d_RecipientsActivityEnum = RecipientsActivityEnum;\n const emailMarketingV1Campaign_universal_d_RecipientsActivityEnum: typeof RecipientsActivityEnum;\n type emailMarketingV1Campaign_universal_d_CursorPaging = CursorPaging;\n type emailMarketingV1Campaign_universal_d_ListRecipientsResponse = ListRecipientsResponse;\n type emailMarketingV1Campaign_universal_d_CampaignRecipientDetails = CampaignRecipientDetails;\n type emailMarketingV1Campaign_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type emailMarketingV1Campaign_universal_d_Cursors = Cursors;\n type emailMarketingV1Campaign_universal_d_GetCampaignMappingRequest = GetCampaignMappingRequest;\n type emailMarketingV1Campaign_universal_d_GetCampaignMappingResponse = GetCampaignMappingResponse;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingRequest = GetPingCampaignMappingRequest;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingResponse = GetPingCampaignMappingResponse;\n type emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesRequest = QueryAutomationTemplatesRequest;\n type emailMarketingV1Campaign_universal_d_Query = Query;\n type emailMarketingV1Campaign_universal_d_Sorting = Sorting;\n type emailMarketingV1Campaign_universal_d_SortOrder = SortOrder;\n const emailMarketingV1Campaign_universal_d_SortOrder: typeof SortOrder;\n type emailMarketingV1Campaign_universal_d_Paging = Paging;\n type emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesResponse = QueryAutomationTemplatesResponse;\n type emailMarketingV1Campaign_universal_d_AutomationTemplateContainer = AutomationTemplateContainer;\n type emailMarketingV1Campaign_universal_d_AutomationTemplate = AutomationTemplate;\n type emailMarketingV1Campaign_universal_d_RuleConfiguration = RuleConfiguration;\n type emailMarketingV1Campaign_universal_d_ConditionConfiguration = ConditionConfiguration;\n type emailMarketingV1Campaign_universal_d_Operator = Operator;\n const emailMarketingV1Campaign_universal_d_Operator: typeof Operator;\n type emailMarketingV1Campaign_universal_d_TriggerConfiguration = TriggerConfiguration;\n type emailMarketingV1Campaign_universal_d_ActionConfiguration = ActionConfiguration;\n type emailMarketingV1Campaign_universal_d_RuleStatus = RuleStatus;\n const emailMarketingV1Campaign_universal_d_RuleStatus: typeof RuleStatus;\n type emailMarketingV1Campaign_universal_d_ActivationCycle = ActivationCycle;\n type emailMarketingV1Campaign_universal_d_RuleMetadata = RuleMetadata;\n type emailMarketingV1Campaign_universal_d_VersionType = VersionType;\n const emailMarketingV1Campaign_universal_d_VersionType: typeof VersionType;\n type emailMarketingV1Campaign_universal_d_TemplateType = TemplateType;\n const emailMarketingV1Campaign_universal_d_TemplateType: typeof TemplateType;\n type emailMarketingV1Campaign_universal_d_Precondition = Precondition;\n type emailMarketingV1Campaign_universal_d_PreconditionType = PreconditionType;\n const emailMarketingV1Campaign_universal_d_PreconditionType: typeof PreconditionType;\n type emailMarketingV1Campaign_universal_d_TemplateState = TemplateState;\n const emailMarketingV1Campaign_universal_d_TemplateState: typeof TemplateState;\n type emailMarketingV1Campaign_universal_d_Translation = Translation;\n type emailMarketingV1Campaign_universal_d_TranslationState = TranslationState;\n const emailMarketingV1Campaign_universal_d_TranslationState: typeof TranslationState;\n type emailMarketingV1Campaign_universal_d_AutomationTemplateEnrichmentData = AutomationTemplateEnrichmentData;\n type emailMarketingV1Campaign_universal_d_QueryMetadata = QueryMetadata;\n type emailMarketingV1Campaign_universal_d_QueryAppTemplatesRequest = QueryAppTemplatesRequest;\n type emailMarketingV1Campaign_universal_d_TemplateQueryType = TemplateQueryType;\n const emailMarketingV1Campaign_universal_d_TemplateQueryType: typeof TemplateQueryType;\n type emailMarketingV1Campaign_universal_d_QueryAppTemplatesResponse = QueryAppTemplatesResponse;\n type emailMarketingV1Campaign_universal_d_TemplateData = TemplateData;\n type emailMarketingV1Campaign_universal_d_CampaignLookupRequest = CampaignLookupRequest;\n type emailMarketingV1Campaign_universal_d_CampaignLookupResponse = CampaignLookupResponse;\n type emailMarketingV1Campaign_universal_d_CampaignLookupBatchRequest = CampaignLookupBatchRequest;\n type emailMarketingV1Campaign_universal_d_CampaignLookupBatchResponse = CampaignLookupBatchResponse;\n type emailMarketingV1Campaign_universal_d_CampaignArchivedEvent = CampaignArchivedEvent;\n type emailMarketingV1Campaign_universal_d_CampaignUnarchivedEvent = CampaignUnarchivedEvent;\n type emailMarketingV1Campaign_universal_d_GetCampaignRequest = GetCampaignRequest;\n type emailMarketingV1Campaign_universal_d_GetCampaignResponse = GetCampaignResponse;\n type emailMarketingV1Campaign_universal_d_ListCampaignsRequest = ListCampaignsRequest;\n type emailMarketingV1Campaign_universal_d_ListCampaignsResponse = ListCampaignsResponse;\n type emailMarketingV1Campaign_universal_d_CreateFromTemplateRequest = CreateFromTemplateRequest;\n type emailMarketingV1Campaign_universal_d_CreateFromTemplateResponse = CreateFromTemplateResponse;\n type emailMarketingV1Campaign_universal_d_PublishCampaignRequest = PublishCampaignRequest;\n type emailMarketingV1Campaign_universal_d_EmailDistributionOptions = EmailDistributionOptions;\n type emailMarketingV1Campaign_universal_d_PublishCampaignResponse = PublishCampaignResponse;\n type emailMarketingV1Campaign_universal_d_CampaignRejectedEvent = CampaignRejectedEvent;\n type emailMarketingV1Campaign_universal_d_CampaignPublishedEvent = CampaignPublishedEvent;\n type emailMarketingV1Campaign_universal_d_CampaignTerminatedEvent = CampaignTerminatedEvent;\n type emailMarketingV1Campaign_universal_d_CampaignDistributedEvent = CampaignDistributedEvent;\n type emailMarketingV1Campaign_universal_d_EmailActivityUpdated = EmailActivityUpdated;\n type emailMarketingV1Campaign_universal_d_EmailActivityUpdatedEventTypeOneOf = EmailActivityUpdatedEventTypeOneOf;\n type emailMarketingV1Campaign_universal_d_ActivityType = ActivityType;\n const emailMarketingV1Campaign_universal_d_ActivityType: typeof ActivityType;\n type emailMarketingV1Campaign_universal_d_Click = Click;\n type emailMarketingV1Campaign_universal_d_Open = Open;\n type emailMarketingV1Campaign_universal_d_SoftBounce = SoftBounce;\n type emailMarketingV1Campaign_universal_d_HardBounce = HardBounce;\n type emailMarketingV1Campaign_universal_d_CampaignScheduledEvent = CampaignScheduledEvent;\n type emailMarketingV1Campaign_universal_d_SendTestRequest = SendTestRequest;\n type emailMarketingV1Campaign_universal_d_PlaceholderValue = PlaceholderValue;\n type emailMarketingV1Campaign_universal_d_Type = Type;\n const emailMarketingV1Campaign_universal_d_Type: typeof Type;\n type emailMarketingV1Campaign_universal_d_PlaceholderContent = PlaceholderContent;\n type emailMarketingV1Campaign_universal_d_PlaceholderContentValueOneOf = PlaceholderContentValueOneOf;\n type emailMarketingV1Campaign_universal_d_PlainText = PlainText;\n type emailMarketingV1Campaign_universal_d_Html = Html;\n type emailMarketingV1Campaign_universal_d_Money = Money;\n type emailMarketingV1Campaign_universal_d_DateTime = DateTime;\n type emailMarketingV1Campaign_universal_d_Map = Map;\n type emailMarketingV1Campaign_universal_d_Array = Array;\n type emailMarketingV1Campaign_universal_d_PlaceholderContentEnum = PlaceholderContentEnum;\n type emailMarketingV1Campaign_universal_d_SendTestResponse = SendTestResponse;\n type emailMarketingV1Campaign_universal_d_PauseSchedulingRequest = PauseSchedulingRequest;\n type emailMarketingV1Campaign_universal_d_PauseSchedulingResponse = PauseSchedulingResponse;\n type emailMarketingV1Campaign_universal_d_CampaignPausedEvent = CampaignPausedEvent;\n type emailMarketingV1Campaign_universal_d_ArchiveCampaignRequest = ArchiveCampaignRequest;\n type emailMarketingV1Campaign_universal_d_ArchiveCampaignResponse = ArchiveCampaignResponse;\n type emailMarketingV1Campaign_universal_d_UnarchiveCampaignRequest = UnarchiveCampaignRequest;\n type emailMarketingV1Campaign_universal_d_UnarchiveCampaignResponse = UnarchiveCampaignResponse;\n type emailMarketingV1Campaign_universal_d_UpdateTitleRequest = UpdateTitleRequest;\n type emailMarketingV1Campaign_universal_d_UpdateTitleResponse = UpdateTitleResponse;\n type emailMarketingV1Campaign_universal_d_DeleteCampaignRequest = DeleteCampaignRequest;\n type emailMarketingV1Campaign_universal_d_DeleteCampaignResponse = DeleteCampaignResponse;\n type emailMarketingV1Campaign_universal_d_ReuseCampaignRequest = ReuseCampaignRequest;\n type emailMarketingV1Campaign_universal_d_ReuseCampaignResponse = ReuseCampaignResponse;\n type emailMarketingV1Campaign_universal_d_CreatePublishedAutomationRequest = CreatePublishedAutomationRequest;\n type emailMarketingV1Campaign_universal_d_CreatePublishedAutomationResponse = CreatePublishedAutomationResponse;\n type emailMarketingV1Campaign_universal_d_PreviewCampaignRequest = PreviewCampaignRequest;\n type emailMarketingV1Campaign_universal_d_PreviewCampaignResponse = PreviewCampaignResponse;\n type emailMarketingV1Campaign_universal_d_GetComposerRequest = GetComposerRequest;\n type emailMarketingV1Campaign_universal_d_GetComposerResponse = GetComposerResponse;\n type emailMarketingV1Campaign_universal_d_Composer = Composer;\n type emailMarketingV1Campaign_universal_d_CreateCampaignRequest = CreateCampaignRequest;\n type emailMarketingV1Campaign_universal_d_CreateCampaignResponse = CreateCampaignResponse;\n type emailMarketingV1Campaign_universal_d_ResendToNonOpenersRequest = ResendToNonOpenersRequest;\n type emailMarketingV1Campaign_universal_d_ResendToNonOpenersResponse = ResendToNonOpenersResponse;\n const emailMarketingV1Campaign_universal_d_listStatistics: typeof listStatistics;\n const emailMarketingV1Campaign_universal_d_listRecipients: typeof listRecipients;\n type emailMarketingV1Campaign_universal_d_ListRecipientsOptions = ListRecipientsOptions;\n const emailMarketingV1Campaign_universal_d_getCampaignMapping: typeof getCampaignMapping;\n type emailMarketingV1Campaign_universal_d_GetCampaignMappingIdentifiers = GetCampaignMappingIdentifiers;\n const emailMarketingV1Campaign_universal_d_getPingCampaignMapping: typeof getPingCampaignMapping;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingIdentifiers = GetPingCampaignMappingIdentifiers;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingOptions = GetPingCampaignMappingOptions;\n const emailMarketingV1Campaign_universal_d_queryAutomationTemplates: typeof queryAutomationTemplates;\n type emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesOptions = QueryAutomationTemplatesOptions;\n const emailMarketingV1Campaign_universal_d_queryAppTemplates: typeof queryAppTemplates;\n type emailMarketingV1Campaign_universal_d_QueryAppTemplatesOptions = QueryAppTemplatesOptions;\n const emailMarketingV1Campaign_universal_d_campaignLookup: typeof campaignLookup;\n const emailMarketingV1Campaign_universal_d_campaignLookupBatch: typeof campaignLookupBatch;\n type emailMarketingV1Campaign_universal_d_CampaignLookupBatchOptions = CampaignLookupBatchOptions;\n const emailMarketingV1Campaign_universal_d_getCampaign: typeof getCampaign;\n type emailMarketingV1Campaign_universal_d_GetCampaignOptions = GetCampaignOptions;\n const emailMarketingV1Campaign_universal_d_listCampaigns: typeof listCampaigns;\n type emailMarketingV1Campaign_universal_d_ListCampaignsOptions = ListCampaignsOptions;\n const emailMarketingV1Campaign_universal_d_createFromTemplate: typeof createFromTemplate;\n type emailMarketingV1Campaign_universal_d_CreateFromTemplateOptions = CreateFromTemplateOptions;\n const emailMarketingV1Campaign_universal_d_publishCampaign: typeof publishCampaign;\n type emailMarketingV1Campaign_universal_d_PublishCampaignOptions = PublishCampaignOptions;\n const emailMarketingV1Campaign_universal_d_sendTest: typeof sendTest;\n type emailMarketingV1Campaign_universal_d_SendTestOptions = SendTestOptions;\n const emailMarketingV1Campaign_universal_d_pauseScheduling: typeof pauseScheduling;\n const emailMarketingV1Campaign_universal_d_archiveCampaign: typeof archiveCampaign;\n const emailMarketingV1Campaign_universal_d_unarchiveCampaign: typeof unarchiveCampaign;\n const emailMarketingV1Campaign_universal_d_updateTitle: typeof updateTitle;\n const emailMarketingV1Campaign_universal_d_deleteCampaign: typeof deleteCampaign;\n const emailMarketingV1Campaign_universal_d_reuseCampaign: typeof reuseCampaign;\n const emailMarketingV1Campaign_universal_d_createPublishedAutomation: typeof createPublishedAutomation;\n type emailMarketingV1Campaign_universal_d_CreatePublishedAutomationOptions = CreatePublishedAutomationOptions;\n const emailMarketingV1Campaign_universal_d_preview: typeof preview;\n type emailMarketingV1Campaign_universal_d_PreviewOptions = PreviewOptions;\n const emailMarketingV1Campaign_universal_d_getComposer: typeof getComposer;\n const emailMarketingV1Campaign_universal_d_create: typeof create;\n const emailMarketingV1Campaign_universal_d_resendToNonOpeners: typeof resendToNonOpeners;\n type emailMarketingV1Campaign_universal_d_ResendToNonOpenersOptions = ResendToNonOpenersOptions;\n namespace emailMarketingV1Campaign_universal_d {\n export {\n emailMarketingV1Campaign_universal_d___debug as __debug,\n emailMarketingV1Campaign_universal_d_Campaign as Campaign,\n emailMarketingV1Campaign_universal_d_CampaignEditorTypeEnum as CampaignEditorTypeEnum,\n emailMarketingV1Campaign_universal_d_CampaignStatusEnum as CampaignStatusEnum,\n emailMarketingV1Campaign_universal_d_CampaignVisibilityStatusEnum as CampaignVisibilityStatusEnum,\n emailMarketingV1Campaign_universal_d_Enum as Enum,\n emailMarketingV1Campaign_universal_d_PublishingData as PublishingData,\n emailMarketingV1Campaign_universal_d_CampaignStatistics as CampaignStatistics,\n emailMarketingV1Campaign_universal_d_LandingPageStatistics as LandingPageStatistics,\n emailMarketingV1Campaign_universal_d_DistributionStatistics as DistributionStatistics,\n emailMarketingV1Campaign_universal_d_TotalStatistics as TotalStatistics,\n emailMarketingV1Campaign_universal_d_RejectionData as RejectionData,\n emailMarketingV1Campaign_universal_d_RejectionReasonEnum as RejectionReasonEnum,\n emailMarketingV1Campaign_universal_d_CampaignSendingStateEnum as CampaignSendingStateEnum,\n emailMarketingV1Campaign_universal_d_CampaignTypeEnum as CampaignTypeEnum,\n emailMarketingV1Campaign_universal_d_ListStatisticsRequest as ListStatisticsRequest,\n emailMarketingV1Campaign_universal_d_ListStatisticsResponse as ListStatisticsResponse,\n emailMarketingV1Campaign_universal_d_CampaignStatisticsContainer as CampaignStatisticsContainer,\n emailMarketingV1Campaign_universal_d_ListRecipientsRequest as ListRecipientsRequest,\n emailMarketingV1Campaign_universal_d_RecipientsActivityEnum as RecipientsActivityEnum,\n emailMarketingV1Campaign_universal_d_CursorPaging as CursorPaging,\n emailMarketingV1Campaign_universal_d_ListRecipientsResponse as ListRecipientsResponse,\n emailMarketingV1Campaign_universal_d_CampaignRecipientDetails as CampaignRecipientDetails,\n emailMarketingV1Campaign_universal_d_PagingMetadataV2 as PagingMetadataV2,\n emailMarketingV1Campaign_universal_d_Cursors as Cursors,\n emailMarketingV1Campaign_universal_d_GetCampaignMappingRequest as GetCampaignMappingRequest,\n emailMarketingV1Campaign_universal_d_GetCampaignMappingResponse as GetCampaignMappingResponse,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingRequest as GetPingCampaignMappingRequest,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingResponse as GetPingCampaignMappingResponse,\n emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesRequest as QueryAutomationTemplatesRequest,\n emailMarketingV1Campaign_universal_d_Query as Query,\n emailMarketingV1Campaign_universal_d_Sorting as Sorting,\n emailMarketingV1Campaign_universal_d_SortOrder as SortOrder,\n emailMarketingV1Campaign_universal_d_Paging as Paging,\n emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesResponse as QueryAutomationTemplatesResponse,\n emailMarketingV1Campaign_universal_d_AutomationTemplateContainer as AutomationTemplateContainer,\n emailMarketingV1Campaign_universal_d_AutomationTemplate as AutomationTemplate,\n emailMarketingV1Campaign_universal_d_RuleConfiguration as RuleConfiguration,\n emailMarketingV1Campaign_universal_d_ConditionConfiguration as ConditionConfiguration,\n emailMarketingV1Campaign_universal_d_Operator as Operator,\n emailMarketingV1Campaign_universal_d_TriggerConfiguration as TriggerConfiguration,\n emailMarketingV1Campaign_universal_d_ActionConfiguration as ActionConfiguration,\n emailMarketingV1Campaign_universal_d_RuleStatus as RuleStatus,\n emailMarketingV1Campaign_universal_d_ActivationCycle as ActivationCycle,\n emailMarketingV1Campaign_universal_d_RuleMetadata as RuleMetadata,\n emailMarketingV1Campaign_universal_d_VersionType as VersionType,\n emailMarketingV1Campaign_universal_d_TemplateType as TemplateType,\n emailMarketingV1Campaign_universal_d_Precondition as Precondition,\n emailMarketingV1Campaign_universal_d_PreconditionType as PreconditionType,\n emailMarketingV1Campaign_universal_d_TemplateState as TemplateState,\n emailMarketingV1Campaign_universal_d_Translation as Translation,\n emailMarketingV1Campaign_universal_d_TranslationState as TranslationState,\n emailMarketingV1Campaign_universal_d_AutomationTemplateEnrichmentData as AutomationTemplateEnrichmentData,\n emailMarketingV1Campaign_universal_d_QueryMetadata as QueryMetadata,\n emailMarketingV1Campaign_universal_d_QueryAppTemplatesRequest as QueryAppTemplatesRequest,\n emailMarketingV1Campaign_universal_d_TemplateQueryType as TemplateQueryType,\n emailMarketingV1Campaign_universal_d_QueryAppTemplatesResponse as QueryAppTemplatesResponse,\n emailMarketingV1Campaign_universal_d_TemplateData as TemplateData,\n emailMarketingV1Campaign_universal_d_CampaignLookupRequest as CampaignLookupRequest,\n emailMarketingV1Campaign_universal_d_CampaignLookupResponse as CampaignLookupResponse,\n emailMarketingV1Campaign_universal_d_CampaignLookupBatchRequest as CampaignLookupBatchRequest,\n emailMarketingV1Campaign_universal_d_CampaignLookupBatchResponse as CampaignLookupBatchResponse,\n emailMarketingV1Campaign_universal_d_CampaignArchivedEvent as CampaignArchivedEvent,\n emailMarketingV1Campaign_universal_d_CampaignUnarchivedEvent as CampaignUnarchivedEvent,\n emailMarketingV1Campaign_universal_d_GetCampaignRequest as GetCampaignRequest,\n emailMarketingV1Campaign_universal_d_GetCampaignResponse as GetCampaignResponse,\n emailMarketingV1Campaign_universal_d_ListCampaignsRequest as ListCampaignsRequest,\n emailMarketingV1Campaign_universal_d_ListCampaignsResponse as ListCampaignsResponse,\n emailMarketingV1Campaign_universal_d_CreateFromTemplateRequest as CreateFromTemplateRequest,\n emailMarketingV1Campaign_universal_d_CreateFromTemplateResponse as CreateFromTemplateResponse,\n emailMarketingV1Campaign_universal_d_PublishCampaignRequest as PublishCampaignRequest,\n emailMarketingV1Campaign_universal_d_EmailDistributionOptions as EmailDistributionOptions,\n emailMarketingV1Campaign_universal_d_PublishCampaignResponse as PublishCampaignResponse,\n emailMarketingV1Campaign_universal_d_CampaignRejectedEvent as CampaignRejectedEvent,\n emailMarketingV1Campaign_universal_d_CampaignPublishedEvent as CampaignPublishedEvent,\n emailMarketingV1Campaign_universal_d_CampaignTerminatedEvent as CampaignTerminatedEvent,\n emailMarketingV1Campaign_universal_d_CampaignDistributedEvent as CampaignDistributedEvent,\n emailMarketingV1Campaign_universal_d_EmailActivityUpdated as EmailActivityUpdated,\n emailMarketingV1Campaign_universal_d_EmailActivityUpdatedEventTypeOneOf as EmailActivityUpdatedEventTypeOneOf,\n emailMarketingV1Campaign_universal_d_ActivityType as ActivityType,\n emailMarketingV1Campaign_universal_d_Click as Click,\n emailMarketingV1Campaign_universal_d_Open as Open,\n emailMarketingV1Campaign_universal_d_SoftBounce as SoftBounce,\n emailMarketingV1Campaign_universal_d_HardBounce as HardBounce,\n emailMarketingV1Campaign_universal_d_CampaignScheduledEvent as CampaignScheduledEvent,\n emailMarketingV1Campaign_universal_d_SendTestRequest as SendTestRequest,\n emailMarketingV1Campaign_universal_d_PlaceholderValue as PlaceholderValue,\n emailMarketingV1Campaign_universal_d_Type as Type,\n emailMarketingV1Campaign_universal_d_PlaceholderContent as PlaceholderContent,\n emailMarketingV1Campaign_universal_d_PlaceholderContentValueOneOf as PlaceholderContentValueOneOf,\n emailMarketingV1Campaign_universal_d_PlainText as PlainText,\n emailMarketingV1Campaign_universal_d_Html as Html,\n emailMarketingV1Campaign_universal_d_Money as Money,\n emailMarketingV1Campaign_universal_d_DateTime as DateTime,\n emailMarketingV1Campaign_universal_d_Map as Map,\n emailMarketingV1Campaign_universal_d_Array as Array,\n emailMarketingV1Campaign_universal_d_PlaceholderContentEnum as PlaceholderContentEnum,\n emailMarketingV1Campaign_universal_d_SendTestResponse as SendTestResponse,\n emailMarketingV1Campaign_universal_d_PauseSchedulingRequest as PauseSchedulingRequest,\n emailMarketingV1Campaign_universal_d_PauseSchedulingResponse as PauseSchedulingResponse,\n emailMarketingV1Campaign_universal_d_CampaignPausedEvent as CampaignPausedEvent,\n emailMarketingV1Campaign_universal_d_ArchiveCampaignRequest as ArchiveCampaignRequest,\n emailMarketingV1Campaign_universal_d_ArchiveCampaignResponse as ArchiveCampaignResponse,\n emailMarketingV1Campaign_universal_d_UnarchiveCampaignRequest as UnarchiveCampaignRequest,\n emailMarketingV1Campaign_universal_d_UnarchiveCampaignResponse as UnarchiveCampaignResponse,\n emailMarketingV1Campaign_universal_d_UpdateTitleRequest as UpdateTitleRequest,\n emailMarketingV1Campaign_universal_d_UpdateTitleResponse as UpdateTitleResponse,\n emailMarketingV1Campaign_universal_d_DeleteCampaignRequest as DeleteCampaignRequest,\n emailMarketingV1Campaign_universal_d_DeleteCampaignResponse as DeleteCampaignResponse,\n emailMarketingV1Campaign_universal_d_ReuseCampaignRequest as ReuseCampaignRequest,\n emailMarketingV1Campaign_universal_d_ReuseCampaignResponse as ReuseCampaignResponse,\n emailMarketingV1Campaign_universal_d_CreatePublishedAutomationRequest as CreatePublishedAutomationRequest,\n emailMarketingV1Campaign_universal_d_CreatePublishedAutomationResponse as CreatePublishedAutomationResponse,\n emailMarketingV1Campaign_universal_d_PreviewCampaignRequest as PreviewCampaignRequest,\n emailMarketingV1Campaign_universal_d_PreviewCampaignResponse as PreviewCampaignResponse,\n emailMarketingV1Campaign_universal_d_GetComposerRequest as GetComposerRequest,\n emailMarketingV1Campaign_universal_d_GetComposerResponse as GetComposerResponse,\n emailMarketingV1Campaign_universal_d_Composer as Composer,\n emailMarketingV1Campaign_universal_d_CreateCampaignRequest as CreateCampaignRequest,\n emailMarketingV1Campaign_universal_d_CreateCampaignResponse as CreateCampaignResponse,\n emailMarketingV1Campaign_universal_d_ResendToNonOpenersRequest as ResendToNonOpenersRequest,\n emailMarketingV1Campaign_universal_d_ResendToNonOpenersResponse as ResendToNonOpenersResponse,\n emailMarketingV1Campaign_universal_d_listStatistics as listStatistics,\n emailMarketingV1Campaign_universal_d_listRecipients as listRecipients,\n emailMarketingV1Campaign_universal_d_ListRecipientsOptions as ListRecipientsOptions,\n emailMarketingV1Campaign_universal_d_getCampaignMapping as getCampaignMapping,\n emailMarketingV1Campaign_universal_d_GetCampaignMappingIdentifiers as GetCampaignMappingIdentifiers,\n emailMarketingV1Campaign_universal_d_getPingCampaignMapping as getPingCampaignMapping,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingIdentifiers as GetPingCampaignMappingIdentifiers,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingOptions as GetPingCampaignMappingOptions,\n emailMarketingV1Campaign_universal_d_queryAutomationTemplates as queryAutomationTemplates,\n emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesOptions as QueryAutomationTemplatesOptions,\n emailMarketingV1Campaign_universal_d_queryAppTemplates as queryAppTemplates,\n emailMarketingV1Campaign_universal_d_QueryAppTemplatesOptions as QueryAppTemplatesOptions,\n emailMarketingV1Campaign_universal_d_campaignLookup as campaignLookup,\n emailMarketingV1Campaign_universal_d_campaignLookupBatch as campaignLookupBatch,\n emailMarketingV1Campaign_universal_d_CampaignLookupBatchOptions as CampaignLookupBatchOptions,\n emailMarketingV1Campaign_universal_d_getCampaign as getCampaign,\n emailMarketingV1Campaign_universal_d_GetCampaignOptions as GetCampaignOptions,\n emailMarketingV1Campaign_universal_d_listCampaigns as listCampaigns,\n emailMarketingV1Campaign_universal_d_ListCampaignsOptions as ListCampaignsOptions,\n emailMarketingV1Campaign_universal_d_createFromTemplate as createFromTemplate,\n emailMarketingV1Campaign_universal_d_CreateFromTemplateOptions as CreateFromTemplateOptions,\n emailMarketingV1Campaign_universal_d_publishCampaign as publishCampaign,\n emailMarketingV1Campaign_universal_d_PublishCampaignOptions as PublishCampaignOptions,\n emailMarketingV1Campaign_universal_d_sendTest as sendTest,\n emailMarketingV1Campaign_universal_d_SendTestOptions as SendTestOptions,\n emailMarketingV1Campaign_universal_d_pauseScheduling as pauseScheduling,\n emailMarketingV1Campaign_universal_d_archiveCampaign as archiveCampaign,\n emailMarketingV1Campaign_universal_d_unarchiveCampaign as unarchiveCampaign,\n emailMarketingV1Campaign_universal_d_updateTitle as updateTitle,\n emailMarketingV1Campaign_universal_d_deleteCampaign as deleteCampaign,\n emailMarketingV1Campaign_universal_d_reuseCampaign as reuseCampaign,\n emailMarketingV1Campaign_universal_d_createPublishedAutomation as createPublishedAutomation,\n emailMarketingV1Campaign_universal_d_CreatePublishedAutomationOptions as CreatePublishedAutomationOptions,\n emailMarketingV1Campaign_universal_d_preview as preview,\n emailMarketingV1Campaign_universal_d_PreviewOptions as PreviewOptions,\n emailMarketingV1Campaign_universal_d_getComposer as getComposer,\n emailMarketingV1Campaign_universal_d_create as create,\n emailMarketingV1Campaign_universal_d_resendToNonOpeners as resendToNonOpeners,\n emailMarketingV1Campaign_universal_d_ResendToNonOpenersOptions as ResendToNonOpenersOptions,\n };\n }\n \n export { emailMarketingV1AccountDetails_universal_d as accountDetails, emailMarketingV1Campaign_universal_d as campaigns };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-sender-details-backend.d.ts", "content": "declare module \"wix-sender-details-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * Contains information about what will be displayed as the sender's email and name.\n * If public email domains (@gmail.com, @yahoo.com, etc.) are used for sending email campaigns, they will not be displayed in the 'from' header.\n * Instead, they will be replaced with @pb0x.ascendbywix.com, and the sender's email will be placed in the 'reply-to' header.\n * If the user uses an email from a Wix managed domain to send campaigns, that email will be displayed in the 'from' header.\n * If the user uses 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 ascendbywix.com.\n */\n interface SenderDetails {\n /** Sender name. */\n fromName?: string;\n /** Sender email address. */\n fromEmail?: string;\n /**\n * Email verification time (if relevant).\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 /**\n * Retrieves sender details.\n * @public\n * @documentationMaturity preview\n */\n function getSenderDetails(): Promise;\n /**\n * Updates sender details (only provided fields will be updated).\n * If `from_email` is changed - a verification code will be sent to new email address.\n * If verification is needed, a verification email will be sent to the user, and `verification_needed` will return true.\n * @param senderDetails - New sender details.\n * @public\n * @documentationMaturity preview\n * @requiredField senderDetails\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 */\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 */\n function resolveActualFromAddress(fromAddress: string): Promise;\n \n const emailMarketingV1SenderDetails_universal_d___debug: typeof __debug;\n type emailMarketingV1SenderDetails_universal_d_SenderDetails = SenderDetails;\n type emailMarketingV1SenderDetails_universal_d_GetSenderDetailsRequest = GetSenderDetailsRequest;\n type emailMarketingV1SenderDetails_universal_d_GetSenderDetailsResponse = GetSenderDetailsResponse;\n type emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsRequest = UpdateSenderDetailsRequest;\n type emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsResponse = UpdateSenderDetailsResponse;\n type emailMarketingV1SenderDetails_universal_d_VerifySenderEmailRequest = VerifySenderEmailRequest;\n type emailMarketingV1SenderDetails_universal_d_VerifySenderEmailResponse = VerifySenderEmailResponse;\n type emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressRequest = ResolveActualFromAddressRequest;\n type emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressResponse = ResolveActualFromAddressResponse;\n const emailMarketingV1SenderDetails_universal_d_getSenderDetails: typeof getSenderDetails;\n const emailMarketingV1SenderDetails_universal_d_updateSenderDetails: typeof updateSenderDetails;\n const emailMarketingV1SenderDetails_universal_d_verifyEmail: typeof verifyEmail;\n const emailMarketingV1SenderDetails_universal_d_resolveActualFromAddress: typeof resolveActualFromAddress;\n namespace emailMarketingV1SenderDetails_universal_d {\n export {\n emailMarketingV1SenderDetails_universal_d___debug as __debug,\n emailMarketingV1SenderDetails_universal_d_SenderDetails as SenderDetails,\n emailMarketingV1SenderDetails_universal_d_GetSenderDetailsRequest as GetSenderDetailsRequest,\n emailMarketingV1SenderDetails_universal_d_GetSenderDetailsResponse as GetSenderDetailsResponse,\n emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsRequest as UpdateSenderDetailsRequest,\n emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsResponse as UpdateSenderDetailsResponse,\n emailMarketingV1SenderDetails_universal_d_VerifySenderEmailRequest as VerifySenderEmailRequest,\n emailMarketingV1SenderDetails_universal_d_VerifySenderEmailResponse as VerifySenderEmailResponse,\n emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressRequest as ResolveActualFromAddressRequest,\n emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressResponse as ResolveActualFromAddressResponse,\n emailMarketingV1SenderDetails_universal_d_getSenderDetails as getSenderDetails,\n emailMarketingV1SenderDetails_universal_d_updateSenderDetails as updateSenderDetails,\n emailMarketingV1SenderDetails_universal_d_verifyEmail as verifyEmail,\n emailMarketingV1SenderDetails_universal_d_resolveActualFromAddress as resolveActualFromAddress,\n };\n }\n \n export { emailMarketingV1SenderDetails_universal_d as senderDetails };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-comments-backend.d.ts", "content": "declare module \"wix-comments-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** Comment definition */\n interface Comment {\n /**\n * Comment ID\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Comment was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Comment was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /** Owning vertical identifier */\n appId?: string | null;\n /** Verticals context */\n contextId?: string | null;\n /** Vertical context type. A single application can have multiple contexts, and context_type can be used to distinguish in what context comments are being used. Reserved for internal use. */\n contextType?: string | null;\n /** Context resource */\n resourceId?: string | null;\n /** Published comment content */\n content?: CommentContent;\n /** Unpublished comment content */\n draftContent?: CommentContent;\n /**\n * Comment's author\n * @readonly\n */\n author?: CommentAuthor;\n /** Reference to parent comment */\n parentComment?: ParentComment;\n /**\n * Materialized path of comments hierarchy. List of all current comment’s parent ids\n * @internal\n * @readonly\n */\n parentIdsInThread?: string[];\n /**\n * How many published replies comment has\n * @readonly\n */\n replyCount?: number;\n /**\n * Votes summary\n * @readonly\n */\n voteSummary?: VoteSummary;\n /**\n * Comment status\n * @readonly\n */\n status?: Status$1;\n /**\n * Comment rating value\n * @readonly\n */\n rating?: number | null;\n /**\n * Comment reaction summary\n * @readonly\n */\n reactionSummary?: CommentReactionSummary;\n /** Indicates if comment is marked */\n marked?: boolean;\n }\n /** Comment content */\n interface CommentContent {\n /** @internal */\n draftJs?: string | null;\n /** @internal */\n plainText?: string | null;\n richContent?: RichContent;\n mentions?: Mention[];\n /** @internal */\n effects?: Record;\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$1;\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$1 {\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$1 {\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$1;\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 userId?: string | null;\n memberId?: string | null;\n visitorId?: string | null;\n groupId?: string | null;\n }\n /** @oneof */\n interface MentionIdentityOneOf {\n userId?: string | null;\n memberId?: string | null;\n visitorId?: string | null;\n groupId?: string | null;\n }\n interface Attachment extends AttachmentMediaOneOf {\n /** Image */\n image?: string;\n /** Video */\n video?: string;\n /** Audio */\n audio?: string;\n /** Document */\n document?: string;\n /** Mime type of attachment. */\n mimeType?: string | null;\n }\n /** @oneof */\n interface AttachmentMediaOneOf {\n /** Image */\n image?: string;\n /** Video */\n video?: string;\n /** Audio */\n audio?: string;\n /** 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 CommentAuthor extends CommentAuthorIdentityOneOf {\n userId?: string | null;\n memberId?: string | null;\n visitorId?: string | null;\n }\n /** @oneof */\n interface CommentAuthorIdentityOneOf {\n userId?: string | null;\n memberId?: string | null;\n visitorId?: string | null;\n }\n interface ParentComment {\n _id?: string | null;\n /** @readonly */\n author?: CommentAuthor;\n }\n interface VoteSummary {\n netVoteCount?: number;\n upvoteCount?: number;\n downvoteCount?: number;\n }\n enum Status$1 {\n UNKNOWN = \"UNKNOWN\",\n PUBLISHED = \"PUBLISHED\",\n DELETED = \"DELETED\",\n PENDING = \"PENDING\",\n HIDDEN = \"HIDDEN\"\n }\n interface CommentReactionSummary {\n total?: number;\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 CreateCommentResponse {\n /** The created Comment */\n comment?: Comment;\n }\n interface GetCommentRequest {\n /** Id of the Comment to retrieve */\n commentId: string;\n }\n interface GetCommentResponse {\n /** The retrieved Comment */\n comment?: Comment;\n }\n interface UpdateCommentRequest {\n /** The updated Comment */\n comment?: Comment;\n }\n interface UpdateCommentResponse {\n /** The updated Comment */\n comment?: Comment;\n }\n interface DeleteCommentRequest {\n /** Id of the Comment to delete */\n commentId: string;\n /**\n * The revision of the Comment\n * @internal\n */\n revision?: string | null;\n /**\n * Indicates if child comments must be deleted as well.\n * Will be deprecated and be replaced by BulkCommentDelete\n */\n cascade?: boolean | null;\n }\n interface DeleteCommentResponse {\n }\n interface CommentDeleted {\n comment?: Comment;\n }\n interface ModerateDraftContentRequest {\n /** Id of the Comment to modify */\n commentId: string;\n /** The revision of the Comment */\n revision: string | null;\n /** Action to do regarding draft content */\n draftContentAction?: Action;\n }\n enum Action {\n UNKNOWN = \"UNKNOWN\",\n /** Approves draft content */\n APPROVE = \"APPROVE\",\n /** Rejects draft content */\n REJECT = \"REJECT\"\n }\n interface ModerateDraftContentResponse {\n /** Updated 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 appId: string;\n /** WQL expression */\n query: CursorQuery$1;\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$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 }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$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 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 QueryCommentsResponse {\n /** The retrieved Comments */\n comments?: Comment[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$2;\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$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 MarkCommentRequest {\n /** Id of the Comment to mark */\n commentId: string;\n /**\n * The revision of the Comment\n * @internal\n */\n revision?: string | null;\n }\n interface MarkCommentResponse {\n /** The marked Comment */\n comment?: Comment;\n }\n interface CommentMarked {\n comment?: Comment;\n }\n interface UnmarkCommentRequest {\n /** Id of the Comment to mark */\n commentId: string;\n /**\n * The revision of the Comment\n * @internal\n */\n revision?: string | null;\n }\n interface UnmarkCommentResponse {\n /** The 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 interface CountCommentsRequest {\n appId?: string;\n filter?: Record | null;\n }\n interface CountCommentsResponse {\n count?: number;\n }\n interface ListCommentsByResourceRequest {\n /** App Id */\n appId: string;\n /** Context Id */\n contextId: string;\n /** Context Type. 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 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 }\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 cursor?: string | null;\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$2;\n commentReplies?: Record;\n }\n interface RepliesListResponse {\n replies?: Comment[];\n pagingMetadata?: CursorPagingMetadata$2;\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$2;\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 /**\n * Creates a new Comment.\n * Provided content might be stored to draftContent field depending on moderation settings\n * @internal\n * @documentationMaturity preview\n * @requiredField options.comment.appId\n * @requiredField options.comment.content\n * @requiredField options.comment.contextId\n * @requiredField options.comment.resourceId\n */\n function createComment(options?: CreateCommentOptions): Promise;\n interface CreateCommentOptions {\n /** Comment to create */\n comment?: Comment;\n }\n /**\n * Get a Comment by id\n * @param commentId - Id of the Comment to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function getComment(commentId: string): Promise;\n /**\n * Update a Comment\n * Provided content might be stored to draftContent field depending on moderation settings\n * Pass the latest `revision` for a successful update\n * @param _id - Comment ID\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.comment.revision\n */\n function updateComment(_id: string | null, options?: UpdateCommentOptions): Promise;\n interface UpdateCommentOptions {\n comment: {\n /**\n * Comment ID\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Comment was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Comment was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /** Owning vertical identifier */\n appId?: string | null;\n /** Verticals context */\n contextId?: string | null;\n /** Vertical context type. A single application can have multiple contexts, and context_type can be used to distinguish in what context comments are being used. Reserved for internal use. */\n contextType?: string | null;\n /** Context resource */\n resourceId?: string | null;\n /** Published comment content */\n content?: CommentContent;\n /** Unpublished comment content */\n draftContent?: CommentContent;\n /**\n * Comment's author\n * @readonly\n */\n author?: CommentAuthor;\n /** Reference to parent comment */\n parentComment?: ParentComment;\n /**\n * Materialized path of comments hierarchy. List of all current comment’s parent ids\n * @internal\n * @readonly\n */\n parentIdsInThread?: string[];\n /**\n * How many published replies comment has\n * @readonly\n */\n replyCount?: number;\n /**\n * Votes summary\n * @readonly\n */\n voteSummary?: VoteSummary;\n /**\n * Comment status\n * @readonly\n */\n status?: Status$1;\n /**\n * Comment rating value\n * @readonly\n */\n rating?: number | null;\n /**\n * Comment reaction summary\n * @readonly\n */\n reactionSummary?: CommentReactionSummary;\n /** Indicates if comment is marked */\n marked?: boolean;\n };\n }\n /**\n * Delete a Comment\n * @param commentId - Id of the Comment to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function deleteComment(commentId: string, options?: DeleteCommentOptions): Promise;\n interface DeleteCommentOptions {\n /**\n * The revision of the Comment\n * @internal\n */\n revision?: string | null;\n /**\n * Indicates if child comments must be deleted as well.\n * Will be deprecated and be replaced by BulkCommentDelete\n */\n cascade?: boolean | null;\n }\n /**\n * Moderates the draft content of a comment.\n *\n * - `APPROVE`: Moves `draftContent` to `content` and updates the comment `status` to `PUBLISHED`.\n * - `REJECT`: Clears `draftContent` if comment `status` is `PUBLISHED` or, if comment `status` is `PENDING` it will keep `draftContent` the same and change `status` to `HIDDEN`.\n * @param commentId - Id of the Comment to modify\n * @param revision - The revision of the Comment\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n * @requiredField revision\n */\n function moderateDraftContent(commentId: string, revision: string | null, options?: ModerateDraftContentOptions): Promise;\n interface ModerateDraftContentOptions {\n /** Action to do regarding draft content */\n draftContentAction?: Action;\n }\n /**\n * Query Comments using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @requiredField options\n * @requiredField options.query\n */\n function queryComments(appId: string, options: QueryCommentsOptions): Promise;\n interface QueryCommentsOptions {\n /** WQL expression */\n query: CursorQuery$1;\n }\n /**\n * Mark a Comment\n * @param commentId - Id of the Comment to mark\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function markComment(commentId: string, options?: MarkCommentOptions): Promise;\n interface MarkCommentOptions {\n /**\n * The revision of the Comment\n * @internal\n */\n revision?: string | null;\n }\n /**\n * Unmark a Comment\n * @param commentId - Id of the Comment to mark\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function unmarkComment(commentId: string, options?: UnmarkCommentOptions): Promise;\n interface UnmarkCommentOptions {\n /**\n * The revision of the Comment\n * @internal\n */\n revision?: string | null;\n }\n /**\n * Hide a Comment\n * @param commentId - Id of the Comment to hide\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function hideComment(commentId: string): Promise;\n /**\n * Publish a Comment\n * @param commentId - Id of the Comment to publish\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function publishComment(commentId: string): Promise;\n /**\n * Counts comments that matches given filter\n * @internal\n * @documentationMaturity preview\n */\n function countComments(options?: CountCommentsOptions): Promise;\n interface CountCommentsOptions {\n appId?: string;\n filter?: Record | null;\n }\n /**\n * Lists published comments and replies\n *\n * API designed to load comments and replies. It return only published comments and replies.\n * Hidden or Deleted comment or reply are not returned unless they have more than one published reply.\n * @param appId - App Id\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @requiredField options\n * @requiredField options.contextId\n * @requiredField options.resourceId\n */\n function listCommentsByResource(appId: string, options: ListCommentsByResourceOptions): Promise;\n interface ListCommentsByResourceOptions {\n /** Context Id */\n contextId: string;\n /** Context Type. 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 cursorPaging?: ListCommentsByResourceCursorPaging;\n }\n /**\n * Return thread of a comment or reply\n *\n * If comment thread requested, the API will return a single comment along with cursors that can be utilized with the\n * ListCommentsByResource API to load previous and subsequent comment pages.\n *\n * In case reply thread requested, the API will return the root parent comment, the reply itself, and cursors that\n * can be utilized with the ListCommentsByResource API to load previous and subsequent pages of comments or replies.\n * @param commentId - Comment Id\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n */\n function getCommentThread(commentId: string, options?: GetCommentThreadOptions): Promise;\n interface GetCommentThreadOptions {\n /** App Id */\n appId?: string;\n /** Comment sorting. */\n commentSort?: CommentSort;\n /** Reply sorting */\n replySort?: ReplySort;\n }\n /**\n * Publishes multiple comments\n * @param appId - Owning vertical identifier\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @requiredField options\n * @requiredField options.filter\n */\n function bulkPublishComment(appId: string, options: BulkPublishCommentOptions): Promise;\n interface BulkPublishCommentOptions {\n /** Comments to publish */\n filter: Record | null;\n }\n /**\n * Hides multiple comments\n * @param appId - Owning vertical identifier\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @requiredField options\n * @requiredField options.filter\n */\n function bulkHideComment(appId: string, options: BulkHideCommentOptions): Promise;\n interface BulkHideCommentOptions {\n /** Comments to hide */\n filter: Record | null;\n }\n /**\n * Deletes multiple comments\n * @param appId - Owning vertical identifier\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @requiredField options\n * @requiredField options.filter\n */\n function bulkDeleteComment(appId: string, options: BulkDeleteCommentOptions): Promise;\n interface BulkDeleteCommentOptions {\n /** Comments to delete */\n filter: Record | null;\n }\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_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_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_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_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_CreateCommentResponse = CreateCommentResponse;\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_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_QueryCommentsResponse = QueryCommentsResponse;\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 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_UpdateCommentOptions = UpdateCommentOptions;\n const commentsV2Comment_universal_d_deleteComment: typeof deleteComment;\n type commentsV2Comment_universal_d_DeleteCommentOptions = DeleteCommentOptions;\n const commentsV2Comment_universal_d_moderateDraftContent: typeof moderateDraftContent;\n type commentsV2Comment_universal_d_ModerateDraftContentOptions = ModerateDraftContentOptions;\n const commentsV2Comment_universal_d_queryComments: typeof queryComments;\n type commentsV2Comment_universal_d_QueryCommentsOptions = QueryCommentsOptions;\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_hideComment: typeof hideComment;\n const commentsV2Comment_universal_d_publishComment: typeof publishComment;\n const commentsV2Comment_universal_d_countComments: typeof countComments;\n type commentsV2Comment_universal_d_CountCommentsOptions = CountCommentsOptions;\n const commentsV2Comment_universal_d_listCommentsByResource: typeof listCommentsByResource;\n type commentsV2Comment_universal_d_ListCommentsByResourceOptions = ListCommentsByResourceOptions;\n const commentsV2Comment_universal_d_getCommentThread: typeof getCommentThread;\n type commentsV2Comment_universal_d_GetCommentThreadOptions = GetCommentThreadOptions;\n const commentsV2Comment_universal_d_bulkPublishComment: typeof bulkPublishComment;\n type commentsV2Comment_universal_d_BulkPublishCommentOptions = BulkPublishCommentOptions;\n const commentsV2Comment_universal_d_bulkHideComment: typeof bulkHideComment;\n type commentsV2Comment_universal_d_BulkHideCommentOptions = BulkHideCommentOptions;\n const commentsV2Comment_universal_d_bulkDeleteComment: typeof bulkDeleteComment;\n type commentsV2Comment_universal_d_BulkDeleteCommentOptions = BulkDeleteCommentOptions;\n namespace commentsV2Comment_universal_d {\n export {\n commentsV2Comment_universal_d___debug as __debug,\n commentsV2Comment_universal_d_Comment as Comment,\n commentsV2Comment_universal_d_CommentContent as CommentContent,\n commentsV2Comment_universal_d_RichContent as RichContent,\n commentsV2Comment_universal_d_Node as Node,\n commentsV2Comment_universal_d_NodeDataOneOf as NodeDataOneOf,\n commentsV2Comment_universal_d_NodeType as NodeType,\n commentsV2Comment_universal_d_NodeStyle as NodeStyle,\n commentsV2Comment_universal_d_ButtonData as ButtonData,\n commentsV2Comment_universal_d_Border as Border,\n commentsV2Comment_universal_d_Colors as Colors,\n commentsV2Comment_universal_d_PluginContainerData as PluginContainerData,\n commentsV2Comment_universal_d_WidthType as WidthType,\n commentsV2Comment_universal_d_PluginContainerDataWidth as PluginContainerDataWidth,\n commentsV2Comment_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf,\n commentsV2Comment_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment,\n commentsV2Comment_universal_d_Spoiler as Spoiler,\n commentsV2Comment_universal_d_Height as Height,\n Type$1 as Type,\n commentsV2Comment_universal_d_Styles as Styles,\n commentsV2Comment_universal_d_Link as Link,\n commentsV2Comment_universal_d_LinkDataOneOf as LinkDataOneOf,\n commentsV2Comment_universal_d_Target as Target,\n commentsV2Comment_universal_d_Rel as Rel,\n commentsV2Comment_universal_d_CodeBlockData as CodeBlockData,\n commentsV2Comment_universal_d_TextStyle as TextStyle,\n commentsV2Comment_universal_d_TextAlignment as TextAlignment,\n commentsV2Comment_universal_d_DividerData as DividerData,\n commentsV2Comment_universal_d_LineStyle as LineStyle,\n commentsV2Comment_universal_d_Width as Width,\n commentsV2Comment_universal_d_Alignment as Alignment,\n commentsV2Comment_universal_d_FileData as FileData,\n commentsV2Comment_universal_d_ViewMode as ViewMode,\n commentsV2Comment_universal_d_FileSource as FileSource,\n commentsV2Comment_universal_d_FileSourceDataOneOf as FileSourceDataOneOf,\n commentsV2Comment_universal_d_PDFSettings as PDFSettings,\n commentsV2Comment_universal_d_GalleryData as GalleryData,\n commentsV2Comment_universal_d_Media as Media,\n commentsV2Comment_universal_d_Image as Image,\n commentsV2Comment_universal_d_Video as Video,\n commentsV2Comment_universal_d_Item as Item,\n commentsV2Comment_universal_d_ItemDataOneOf as ItemDataOneOf,\n commentsV2Comment_universal_d_GalleryOptions as GalleryOptions,\n commentsV2Comment_universal_d_LayoutType as LayoutType,\n commentsV2Comment_universal_d_Orientation as Orientation,\n commentsV2Comment_universal_d_Crop as Crop,\n commentsV2Comment_universal_d_ThumbnailsAlignment as ThumbnailsAlignment,\n commentsV2Comment_universal_d_Layout as Layout,\n commentsV2Comment_universal_d_ItemStyle as ItemStyle,\n commentsV2Comment_universal_d_Thumbnails as Thumbnails,\n commentsV2Comment_universal_d_GIFData as GIFData,\n commentsV2Comment_universal_d_GIF as GIF,\n commentsV2Comment_universal_d_HeadingData as HeadingData,\n commentsV2Comment_universal_d_HTMLData as HTMLData,\n commentsV2Comment_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf,\n commentsV2Comment_universal_d_Source as Source,\n commentsV2Comment_universal_d_ImageData as ImageData,\n commentsV2Comment_universal_d_LinkPreviewData as LinkPreviewData,\n commentsV2Comment_universal_d_MapData as MapData,\n commentsV2Comment_universal_d_MapSettings as MapSettings,\n commentsV2Comment_universal_d_MapType as MapType,\n commentsV2Comment_universal_d_ParagraphData as ParagraphData,\n commentsV2Comment_universal_d_PollData as PollData,\n commentsV2Comment_universal_d_ViewRole as ViewRole,\n commentsV2Comment_universal_d_VoteRole as VoteRole,\n Permissions$1 as Permissions,\n commentsV2Comment_universal_d_Option as Option,\n commentsV2Comment_universal_d_Settings as Settings,\n commentsV2Comment_universal_d_PollLayoutType as PollLayoutType,\n commentsV2Comment_universal_d_PollLayoutDirection as PollLayoutDirection,\n commentsV2Comment_universal_d_PollLayout as PollLayout,\n commentsV2Comment_universal_d_OptionLayout as OptionLayout,\n commentsV2Comment_universal_d_BackgroundType as BackgroundType,\n commentsV2Comment_universal_d_Gradient as Gradient,\n commentsV2Comment_universal_d_Background as Background,\n commentsV2Comment_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf,\n commentsV2Comment_universal_d_PollDesign as PollDesign,\n commentsV2Comment_universal_d_OptionDesign as OptionDesign,\n commentsV2Comment_universal_d_Poll as Poll,\n commentsV2Comment_universal_d_PollDataLayout as PollDataLayout,\n commentsV2Comment_universal_d_Design as Design,\n commentsV2Comment_universal_d_TextData as TextData,\n commentsV2Comment_universal_d_Decoration as Decoration,\n commentsV2Comment_universal_d_DecorationDataOneOf as DecorationDataOneOf,\n commentsV2Comment_universal_d_DecorationType as DecorationType,\n commentsV2Comment_universal_d_AnchorData as AnchorData,\n commentsV2Comment_universal_d_ColorData as ColorData,\n commentsV2Comment_universal_d_LinkData as LinkData,\n commentsV2Comment_universal_d_MentionData as MentionData,\n commentsV2Comment_universal_d_FontSizeData as FontSizeData,\n commentsV2Comment_universal_d_FontType as FontType,\n commentsV2Comment_universal_d_AppEmbedData as AppEmbedData,\n commentsV2Comment_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf,\n commentsV2Comment_universal_d_AppType as AppType,\n commentsV2Comment_universal_d_BookingData as BookingData,\n commentsV2Comment_universal_d_EventData as EventData,\n commentsV2Comment_universal_d_VideoData as VideoData,\n commentsV2Comment_universal_d_PlaybackOptions as PlaybackOptions,\n commentsV2Comment_universal_d_EmbedData as EmbedData,\n commentsV2Comment_universal_d_Oembed as Oembed,\n commentsV2Comment_universal_d_CollapsibleListData as CollapsibleListData,\n commentsV2Comment_universal_d_InitialExpandedItems as InitialExpandedItems,\n commentsV2Comment_universal_d_Direction as Direction,\n commentsV2Comment_universal_d_TableData as TableData,\n commentsV2Comment_universal_d_Dimensions as Dimensions,\n commentsV2Comment_universal_d_TableCellData as TableCellData,\n commentsV2Comment_universal_d_VerticalAlignment as VerticalAlignment,\n commentsV2Comment_universal_d_CellStyle as CellStyle,\n commentsV2Comment_universal_d_BorderColors as BorderColors,\n commentsV2Comment_universal_d_NullValue as NullValue,\n commentsV2Comment_universal_d_ListValue as ListValue,\n commentsV2Comment_universal_d_AudioData as AudioData,\n commentsV2Comment_universal_d_OrderedListData as OrderedListData,\n commentsV2Comment_universal_d_BulletedListData as BulletedListData,\n commentsV2Comment_universal_d_BlockquoteData as BlockquoteData,\n commentsV2Comment_universal_d_Metadata as Metadata,\n commentsV2Comment_universal_d_DocumentStyle as DocumentStyle,\n commentsV2Comment_universal_d_TextNodeStyle as TextNodeStyle,\n commentsV2Comment_universal_d_Mention as Mention,\n commentsV2Comment_universal_d_MentionIdentityOneOf as MentionIdentityOneOf,\n commentsV2Comment_universal_d_Attachment as Attachment,\n commentsV2Comment_universal_d_AttachmentMediaOneOf as AttachmentMediaOneOf,\n commentsV2Comment_universal_d_VideoResolution as VideoResolution,\n commentsV2Comment_universal_d_CommentAuthor as CommentAuthor,\n commentsV2Comment_universal_d_CommentAuthorIdentityOneOf as CommentAuthorIdentityOneOf,\n commentsV2Comment_universal_d_ParentComment as ParentComment,\n commentsV2Comment_universal_d_VoteSummary as VoteSummary,\n Status$1 as Status,\n commentsV2Comment_universal_d_CommentReactionSummary as CommentReactionSummary,\n commentsV2Comment_universal_d_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent,\n commentsV2Comment_universal_d_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf,\n commentsV2Comment_universal_d_InternalDocument as InternalDocument,\n commentsV2Comment_universal_d_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation,\n commentsV2Comment_universal_d_DeleteByIdsOperation as DeleteByIdsOperation,\n commentsV2Comment_universal_d_DeleteByFilterOperation as DeleteByFilterOperation,\n commentsV2Comment_universal_d_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation,\n commentsV2Comment_universal_d_InternalUpdateExistingOperation as InternalUpdateExistingOperation,\n commentsV2Comment_universal_d_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation,\n commentsV2Comment_universal_d_VersioningMode as VersioningMode,\n commentsV2Comment_universal_d_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation,\n commentsV2Comment_universal_d_VersionedDocumentId as VersionedDocumentId,\n commentsV2Comment_universal_d_CreateCommentRequest as CreateCommentRequest,\n commentsV2Comment_universal_d_CreateCommentResponse as CreateCommentResponse,\n commentsV2Comment_universal_d_GetCommentRequest as GetCommentRequest,\n commentsV2Comment_universal_d_GetCommentResponse as GetCommentResponse,\n commentsV2Comment_universal_d_UpdateCommentRequest as UpdateCommentRequest,\n commentsV2Comment_universal_d_UpdateCommentResponse as UpdateCommentResponse,\n commentsV2Comment_universal_d_DeleteCommentRequest as DeleteCommentRequest,\n commentsV2Comment_universal_d_DeleteCommentResponse as DeleteCommentResponse,\n commentsV2Comment_universal_d_CommentDeleted as CommentDeleted,\n commentsV2Comment_universal_d_ModerateDraftContentRequest as ModerateDraftContentRequest,\n commentsV2Comment_universal_d_Action as Action,\n commentsV2Comment_universal_d_ModerateDraftContentResponse as ModerateDraftContentResponse,\n commentsV2Comment_universal_d_CommentPublished as CommentPublished,\n commentsV2Comment_universal_d_CommentHidden as CommentHidden,\n commentsV2Comment_universal_d_QueryCommentsRequest as QueryCommentsRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$2 as CursorPaging,\n commentsV2Comment_universal_d_QueryCommentsResponse as QueryCommentsResponse,\n CursorPagingMetadata$2 as CursorPagingMetadata,\n Cursors$2 as Cursors,\n commentsV2Comment_universal_d_MarkCommentRequest as MarkCommentRequest,\n commentsV2Comment_universal_d_MarkCommentResponse as MarkCommentResponse,\n commentsV2Comment_universal_d_CommentMarked as CommentMarked,\n commentsV2Comment_universal_d_UnmarkCommentRequest as UnmarkCommentRequest,\n commentsV2Comment_universal_d_UnmarkCommentResponse as UnmarkCommentResponse,\n commentsV2Comment_universal_d_CommentUnmarked as CommentUnmarked,\n commentsV2Comment_universal_d_HideCommentRequest as HideCommentRequest,\n commentsV2Comment_universal_d_HideCommentResponse as HideCommentResponse,\n commentsV2Comment_universal_d_PublishCommentRequest as PublishCommentRequest,\n commentsV2Comment_universal_d_PublishCommentResponse as PublishCommentResponse,\n commentsV2Comment_universal_d_CountCommentsRequest as CountCommentsRequest,\n commentsV2Comment_universal_d_CountCommentsResponse as CountCommentsResponse,\n commentsV2Comment_universal_d_ListCommentsByResourceRequest as ListCommentsByResourceRequest,\n commentsV2Comment_universal_d_CommentSort as CommentSort,\n commentsV2Comment_universal_d_Order as Order,\n commentsV2Comment_universal_d_ReplySort as ReplySort,\n commentsV2Comment_universal_d_ReplySortOrder as ReplySortOrder,\n commentsV2Comment_universal_d_ListCommentsByResourceCursorPaging as ListCommentsByResourceCursorPaging,\n commentsV2Comment_universal_d_ListCommentsByResourceResponse as ListCommentsByResourceResponse,\n commentsV2Comment_universal_d_RepliesListResponse as RepliesListResponse,\n commentsV2Comment_universal_d_GetCommentThreadRequest as GetCommentThreadRequest,\n commentsV2Comment_universal_d_GetCommentThreadResponse as GetCommentThreadResponse,\n commentsV2Comment_universal_d_BulkPublishCommentRequest as BulkPublishCommentRequest,\n commentsV2Comment_universal_d_BulkPublishCommentResponse as BulkPublishCommentResponse,\n commentsV2Comment_universal_d_BulkHideCommentRequest as BulkHideCommentRequest,\n commentsV2Comment_universal_d_BulkHideCommentResponse as BulkHideCommentResponse,\n commentsV2Comment_universal_d_BulkDeleteCommentRequest as BulkDeleteCommentRequest,\n commentsV2Comment_universal_d_BulkDeleteCommentResponse as BulkDeleteCommentResponse,\n commentsV2Comment_universal_d_createComment as createComment,\n commentsV2Comment_universal_d_CreateCommentOptions as CreateCommentOptions,\n commentsV2Comment_universal_d_getComment as getComment,\n commentsV2Comment_universal_d_updateComment as updateComment,\n commentsV2Comment_universal_d_UpdateCommentOptions as UpdateCommentOptions,\n commentsV2Comment_universal_d_deleteComment as deleteComment,\n commentsV2Comment_universal_d_DeleteCommentOptions as DeleteCommentOptions,\n commentsV2Comment_universal_d_moderateDraftContent as moderateDraftContent,\n commentsV2Comment_universal_d_ModerateDraftContentOptions as ModerateDraftContentOptions,\n commentsV2Comment_universal_d_queryComments as queryComments,\n commentsV2Comment_universal_d_QueryCommentsOptions as QueryCommentsOptions,\n commentsV2Comment_universal_d_markComment as markComment,\n commentsV2Comment_universal_d_MarkCommentOptions as MarkCommentOptions,\n commentsV2Comment_universal_d_unmarkComment as unmarkComment,\n commentsV2Comment_universal_d_UnmarkCommentOptions as UnmarkCommentOptions,\n commentsV2Comment_universal_d_hideComment as hideComment,\n commentsV2Comment_universal_d_publishComment as publishComment,\n commentsV2Comment_universal_d_countComments as countComments,\n commentsV2Comment_universal_d_CountCommentsOptions as CountCommentsOptions,\n commentsV2Comment_universal_d_listCommentsByResource as listCommentsByResource,\n commentsV2Comment_universal_d_ListCommentsByResourceOptions as ListCommentsByResourceOptions,\n commentsV2Comment_universal_d_getCommentThread as getCommentThread,\n commentsV2Comment_universal_d_GetCommentThreadOptions as GetCommentThreadOptions,\n commentsV2Comment_universal_d_bulkPublishComment as bulkPublishComment,\n commentsV2Comment_universal_d_BulkPublishCommentOptions as BulkPublishCommentOptions,\n commentsV2Comment_universal_d_bulkHideComment as bulkHideComment,\n commentsV2Comment_universal_d_BulkHideCommentOptions as BulkHideCommentOptions,\n commentsV2Comment_universal_d_bulkDeleteComment as bulkDeleteComment,\n commentsV2Comment_universal_d_BulkDeleteCommentOptions as BulkDeleteCommentOptions,\n };\n }\n \n /** CommentsWidget is the main entity of CommentsWidgetRegistry that can be used for lorem ipsum dolor */\n interface CommentsWidget {\n /**\n * CommentsWidget ID\n * @readonly\n */\n _id?: string | null;\n /** Widget category ID */\n categoryId?: string;\n /** Widget resource ID */\n resourceId?: string;\n /** Path to widget location */\n urlPath?: string;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this CommentsResource was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this CommentsResource was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Component ID of the widget to which the category is attached to */\n componentId?: string | null;\n /** Count indicating how many published comments exist in category and resource */\n commentCount?: number | null;\n }\n interface RegisterCommentsWidgetRequest {\n /** Widget category ID */\n categoryId: string;\n /** Widget resource ID */\n resourceId: string;\n /** Deprecated field */\n componentId?: string;\n /** Dynamic page tittle, if the widget is inside a dynamic page */\n dynamicPageTitle?: string | null;\n /** PageId of the page, which contains the widget */\n pageId?: string | null;\n /** Page Url, provided by the client */\n urlPath?: string | null;\n }\n interface RegisterCommentsWidgetResponse {\n /** The registered CommentsWidget */\n commentsWidget?: CommentsWidget;\n }\n interface QueryCommentsWidgetResourcesRequest {\n /** Cursor query */\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$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 {\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryCommentsWidgetResourcesResponse {\n /** List of resources */\n resourceIds?: string[];\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 CreateCommentsWidgetRequest {\n /** CommentsWidget to be created */\n commentsWidget: CommentsWidget;\n }\n interface CreateCommentsWidgetResponse {\n /** The created CommentsWidget */\n commentsWidget?: CommentsWidget;\n }\n interface GetCommentsWidgetRequest {\n /** Id of the CommentsWidget to retrieve */\n commentsWidgetId: string;\n }\n interface GetCommentsWidgetResponse {\n /** The retrieved CommentsWidget */\n commentsWidget?: CommentsWidget;\n }\n interface UpdateCommentsWidgetRequest {\n /** CommentsWidget to be updated, may be partial */\n commentsWidget: CommentsWidget;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateCommentsWidgetResponse {\n /** The updated CommentsWidget */\n commentsWidget?: CommentsWidget;\n }\n interface DeleteCommentsWidgetRequest {\n /** Id of the CommentsWidget to delete */\n commentsWidgetId: string;\n /** The revision of the CommentsWidget */\n revision?: string;\n }\n interface DeleteCommentsWidgetResponse {\n }\n interface QueryCommentsWidgetRequest {\n /** WQL expression */\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$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 /** 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$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 QueryCommentsWidgetResponse {\n /** The retrieved CommentsWidgets */\n commentsWidgets?: CommentsWidget[];\n /** Paging metadata */\n metadata?: 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 * 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 * @internal\n */\n hasNext?: boolean | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface Empty$2 {\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 * Registers CommentsWidget. Whenever a widget is loaded for the first time or its resourceId changes, it saves the new resource information about the widget\n * @param categoryId - Widget category ID\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField options.resourceId\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_REGISTER\n */\n function registerCommentsWidget(categoryId: string, options?: RegisterCommentsWidgetOptions): Promise;\n interface RegisterCommentsWidgetOptions {\n /** Widget resource ID */\n resourceId: string;\n /** Deprecated field */\n componentId?: string;\n /** Dynamic page tittle, if the widget is inside a dynamic page */\n dynamicPageTitle?: string | null;\n /** PageId of the page, which contains the widget */\n pageId?: string | null;\n /** Page Url, provided by the client */\n urlPath?: string | null;\n }\n /**\n * Returns all registered widget resource ids contained in metaSite\n * @param query - Cursor query\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_RESOURCES_QUERY\n * @adminMethod\n */\n function queryCommentsWidgetResources(query: CursorQuery): Promise;\n /**\n * Creates a new CommentsWidget\n * @param commentsWidget - CommentsWidget to be created\n * @public\n * @documentationMaturity preview\n * @requiredField commentsWidget\n * @requiredField commentsWidget.categoryId\n * @requiredField commentsWidget.resourceId\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_CREATE\n * @adminMethod\n * @returns The created CommentsWidget\n */\n function createCommentsWidget(commentsWidget: CommentsWidget): Promise;\n /**\n * Get a CommentsWidget by id\n * @param commentsWidgetId - Id of the CommentsWidget to retrieve\n * @public\n * @documentationMaturity preview\n * @requiredField commentsWidgetId\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_READ\n * @returns The retrieved CommentsWidget\n */\n function getCommentsWidget(commentsWidgetId: string): Promise;\n /**\n * Update CommentsWidget, supports partial update\n * Pass the latest `revision` for a successful update\n * @param _id - CommentsWidget ID\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField commentsWidget\n * @requiredField commentsWidget.revision\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_EDIT\n * @adminMethod\n * @returns The updated CommentsWidget\n */\n function updateCommentsWidget(_id: string | null, commentsWidget: UpdateCommentsWidget, options?: UpdateCommentsWidgetOptions): Promise;\n interface UpdateCommentsWidget {\n /**\n * CommentsWidget ID\n * @readonly\n */\n _id?: string | null;\n /** Widget category ID */\n categoryId?: string;\n /** Widget resource ID */\n resourceId?: string;\n /** Path to widget location */\n urlPath?: string;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this CommentsResource was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this CommentsResource was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Component ID of the widget to which the category is attached to */\n componentId?: string | null;\n /** Count indicating how many published comments exist in category and resource */\n commentCount?: number | null;\n }\n interface UpdateCommentsWidgetOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Delete a CommentsWidget\n * @param commentsWidgetId - Id of the CommentsWidget to delete\n * @public\n * @documentationMaturity preview\n * @requiredField commentsWidgetId\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_DELETE\n * @adminMethod\n */\n function deleteCommentsWidget(commentsWidgetId: string, options?: DeleteCommentsWidgetOptions): Promise;\n interface DeleteCommentsWidgetOptions {\n /** The revision of the CommentsWidget */\n revision?: string;\n }\n /**\n * Query CommentsWidgets using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_COMMENTS.COMMENTS_WIDGET_QUERY\n */\n function queryCommentsWidget(): CommentsWidgetsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CommentsWidgetsQueryResult extends QueryCursorResult$1 {\n items: CommentsWidget[];\n query: CommentsWidgetsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CommentsWidgetsQueryBuilder {\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' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\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' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\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' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\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' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\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' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\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' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\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' | 'categoryId' | 'resourceId' | 'componentId', value: string) => CommentsWidgetsQueryBuilder;\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' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount', value: any[]) => CommentsWidgetsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount', value: any) => CommentsWidgetsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount', value: boolean) => CommentsWidgetsQueryBuilder;\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' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount'>) => CommentsWidgetsQueryBuilder;\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' | 'categoryId' | 'resourceId' | 'urlPath' | '_createdDate' | '_updatedDate' | 'componentId' | 'commentCount'>) => CommentsWidgetsQueryBuilder;\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) => CommentsWidgetsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => CommentsWidgetsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n type commentsCategoriesV1CommentsWidget_universal_d_CommentsWidget = CommentsWidget;\n type commentsCategoriesV1CommentsWidget_universal_d_RegisterCommentsWidgetRequest = RegisterCommentsWidgetRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_RegisterCommentsWidgetResponse = RegisterCommentsWidgetResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetResourcesRequest = QueryCommentsWidgetResourcesRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_CursorQuery = CursorQuery;\n type commentsCategoriesV1CommentsWidget_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetResourcesResponse = QueryCommentsWidgetResourcesResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_CreateCommentsWidgetRequest = CreateCommentsWidgetRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_CreateCommentsWidgetResponse = CreateCommentsWidgetResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_GetCommentsWidgetRequest = GetCommentsWidgetRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_GetCommentsWidgetResponse = GetCommentsWidgetResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidgetRequest = UpdateCommentsWidgetRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidgetResponse = UpdateCommentsWidgetResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_DeleteCommentsWidgetRequest = DeleteCommentsWidgetRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_DeleteCommentsWidgetResponse = DeleteCommentsWidgetResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetRequest = QueryCommentsWidgetRequest;\n type commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetResponse = QueryCommentsWidgetResponse;\n type commentsCategoriesV1CommentsWidget_universal_d_PagingMetadataV2 = PagingMetadataV2;\n const commentsCategoriesV1CommentsWidget_universal_d_registerCommentsWidget: typeof registerCommentsWidget;\n type commentsCategoriesV1CommentsWidget_universal_d_RegisterCommentsWidgetOptions = RegisterCommentsWidgetOptions;\n const commentsCategoriesV1CommentsWidget_universal_d_queryCommentsWidgetResources: typeof queryCommentsWidgetResources;\n const commentsCategoriesV1CommentsWidget_universal_d_createCommentsWidget: typeof createCommentsWidget;\n const commentsCategoriesV1CommentsWidget_universal_d_getCommentsWidget: typeof getCommentsWidget;\n const commentsCategoriesV1CommentsWidget_universal_d_updateCommentsWidget: typeof updateCommentsWidget;\n type commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidget = UpdateCommentsWidget;\n type commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidgetOptions = UpdateCommentsWidgetOptions;\n const commentsCategoriesV1CommentsWidget_universal_d_deleteCommentsWidget: typeof deleteCommentsWidget;\n type commentsCategoriesV1CommentsWidget_universal_d_DeleteCommentsWidgetOptions = DeleteCommentsWidgetOptions;\n const commentsCategoriesV1CommentsWidget_universal_d_queryCommentsWidget: typeof queryCommentsWidget;\n type commentsCategoriesV1CommentsWidget_universal_d_CommentsWidgetsQueryResult = CommentsWidgetsQueryResult;\n type commentsCategoriesV1CommentsWidget_universal_d_CommentsWidgetsQueryBuilder = CommentsWidgetsQueryBuilder;\n namespace commentsCategoriesV1CommentsWidget_universal_d {\n export {\n commentsCategoriesV1CommentsWidget_universal_d_CommentsWidget as CommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_RegisterCommentsWidgetRequest as RegisterCommentsWidgetRequest,\n commentsCategoriesV1CommentsWidget_universal_d_RegisterCommentsWidgetResponse as RegisterCommentsWidgetResponse,\n commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetResourcesRequest as QueryCommentsWidgetResourcesRequest,\n commentsCategoriesV1CommentsWidget_universal_d_CursorQuery as CursorQuery,\n commentsCategoriesV1CommentsWidget_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n CursorPaging$1 as CursorPaging,\n commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetResourcesResponse as QueryCommentsWidgetResourcesResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$1 as Cursors,\n commentsCategoriesV1CommentsWidget_universal_d_CreateCommentsWidgetRequest as CreateCommentsWidgetRequest,\n commentsCategoriesV1CommentsWidget_universal_d_CreateCommentsWidgetResponse as CreateCommentsWidgetResponse,\n commentsCategoriesV1CommentsWidget_universal_d_GetCommentsWidgetRequest as GetCommentsWidgetRequest,\n commentsCategoriesV1CommentsWidget_universal_d_GetCommentsWidgetResponse as GetCommentsWidgetResponse,\n commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidgetRequest as UpdateCommentsWidgetRequest,\n commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidgetResponse as UpdateCommentsWidgetResponse,\n commentsCategoriesV1CommentsWidget_universal_d_DeleteCommentsWidgetRequest as DeleteCommentsWidgetRequest,\n commentsCategoriesV1CommentsWidget_universal_d_DeleteCommentsWidgetResponse as DeleteCommentsWidgetResponse,\n commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetRequest as QueryCommentsWidgetRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Paging$1 as Paging,\n commentsCategoriesV1CommentsWidget_universal_d_QueryCommentsWidgetResponse as QueryCommentsWidgetResponse,\n commentsCategoriesV1CommentsWidget_universal_d_PagingMetadataV2 as PagingMetadataV2,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n Empty$2 as Empty,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n commentsCategoriesV1CommentsWidget_universal_d_registerCommentsWidget as registerCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_RegisterCommentsWidgetOptions as RegisterCommentsWidgetOptions,\n commentsCategoriesV1CommentsWidget_universal_d_queryCommentsWidgetResources as queryCommentsWidgetResources,\n commentsCategoriesV1CommentsWidget_universal_d_createCommentsWidget as createCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_getCommentsWidget as getCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_updateCommentsWidget as updateCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidget as UpdateCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_UpdateCommentsWidgetOptions as UpdateCommentsWidgetOptions,\n commentsCategoriesV1CommentsWidget_universal_d_deleteCommentsWidget as deleteCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_DeleteCommentsWidgetOptions as DeleteCommentsWidgetOptions,\n commentsCategoriesV1CommentsWidget_universal_d_queryCommentsWidget as queryCommentsWidget,\n commentsCategoriesV1CommentsWidget_universal_d_CommentsWidgetsQueryResult as CommentsWidgetsQueryResult,\n commentsCategoriesV1CommentsWidget_universal_d_CommentsWidgetsQueryBuilder as CommentsWidgetsQueryBuilder,\n };\n }\n \n /** Category is the main entity for Comments widget service */\n interface Category {\n /**\n * Category ID\n * @readonly\n */\n _id?: string | null;\n /** Name of the category */\n name?: string | null;\n /**\n * Setting to allow or permit guest commenting\n * @deprecated Setting to allow or permit guest commenting\n */\n guestCommenting?: boolean | null;\n /**\n * Setting to allow or permit guests to add reactions to comments\n * @deprecated Setting to allow or permit guests to add reactions to comments\n */\n guestReactions?: boolean | null;\n /** The selected type of reactions to be used in comments */\n reactionType?: ReactionTypeType;\n /** The selected type of reactions to be used in replies */\n repliesReactionType?: RepliesReactionTypeType;\n /** The default comment label for marked comment badges */\n markedCommentLabelType?: Type;\n /** Custom label value for marked comment badges */\n customMarkedCommentLabel?: string | null;\n /** The type of icons to be used for comment likes */\n mainReaction?: ReactionIcon;\n /** Category ratings settings. Describes whether ratings are enabled for category and if leaving a rating when placing a comment is mandatory */\n ratingsSettings?: RatingsSettings;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Category was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this Category was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Category permissions settings. Describes what UoU entities are allowed to perform actions */\n permissionsSettings?: PermissionsSettings;\n /** Indication of whether the category is active and being used in live site */\n active?: boolean | null;\n /** Application owning category */\n appId?: string | null;\n }\n enum ReactionTypeType {\n UNKNOWN = \"UNKNOWN\",\n VOTE = \"VOTE\",\n REACTIONS = \"REACTIONS\",\n MULTIPLE_REACTIONS = \"MULTIPLE_REACTIONS\"\n }\n enum RepliesReactionTypeType {\n UNKNOWN = \"UNKNOWN\",\n REACTIONS = \"REACTIONS\",\n MULTIPLE_REACTIONS = \"MULTIPLE_REACTIONS\"\n }\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n FEATURED = \"FEATURED\",\n BEST_ANSWER = \"BEST_ANSWER\",\n SOLVED = \"SOLVED\",\n PINNED = \"PINNED\",\n CUSTOM = \"CUSTOM\"\n }\n interface ReactionIcon extends ReactionIconIconsOneOf {\n /** Type of icon to be used for reactions */\n iconType?: IconTypeType;\n }\n /** @oneof */\n interface ReactionIconIconsOneOf {\n /** Type of icon to be used for reactions */\n iconType?: IconTypeType;\n }\n enum IconTypeType {\n UNKNOWN = \"UNKNOWN\",\n LOVE = \"LOVE\",\n THUMBS_UP = \"THUMBS_UP\"\n }\n interface RatingsSettings {\n /** Indicates whether ratings are enabled */\n ratingsEnabled?: boolean;\n /** Indicates whether leaving a rating is required */\n ratingRequired?: boolean;\n }\n interface PermissionsSettings {\n /** Indicates whether commenting is enabled and with what role permissions */\n createComment?: Permissions;\n /** Indicates whether replying is enabled and with what role permissions */\n createReply?: Permissions;\n /** Indicates whether reacting is enabled and with what role permissions */\n createReact?: Permissions;\n }\n interface Permissions {\n /** Defines the role for permissions */\n role?: Role;\n }\n enum Role {\n UNKNOWN_ROLE = \"UNKNOWN_ROLE\",\n ALL = \"ALL\",\n MEMBER = \"MEMBER\",\n ADMIN = \"ADMIN\"\n }\n interface CreateCategoryRequest {\n /** Category to be created */\n category: Category;\n }\n interface CreateCategoryResponse {\n /** The created Category */\n category?: Category;\n }\n interface GetCategoryRequest {\n /** Id of the Category to retrieve */\n categoryId: string;\n }\n interface GetCategoryResponse {\n /** The retrieved Category */\n category?: Category;\n }\n interface UpdateCategoryRequest {\n /** Category to be updated, may be partial and include only CategoryId and the field to change */\n category: Category;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateCategoryResponse {\n /** The updated Category */\n category?: Category;\n }\n interface DeleteCategoryRequest {\n /** Id of the Category to delete */\n categoryId: string;\n /** The revision of the Category */\n revision?: string;\n }\n interface DeleteCategoryResponse {\n }\n interface QueryCategoryRequest {\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;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryCategoryResponse {\n /** The retrieved Categories */\n categories?: Category[];\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$1 {\n bodyAsJson?: string;\n }\n interface Empty$1 {\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 }\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 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 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 Category\n * @param category - Category to be created\n * @public\n * @documentationMaturity preview\n * @requiredField category\n * @requiredField category.guestCommenting\n * @requiredField category.guestReactions\n * @requiredField category.name\n * @permissionId WIX_COMMENTS.CATEGORY_CREATE\n * @adminMethod\n * @returns The created Category\n */\n function createCategory(category: Category): Promise;\n /**\n * Get a Category by id\n * @param categoryId - Id of the Category to retrieve\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId WIX_COMMENTS.CATEGORY_READ\n * @returns The retrieved Category\n */\n function getCategory(categoryId: string): Promise;\n /**\n * Update a Category, supports partial update\n * Pass the latest `revision` for a successful update\n * @param _id - Category ID\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField category\n * @requiredField category.name\n * @requiredField category.revision\n * @permissionId WIX_COMMENTS.CATEGORY_EDIT\n * @adminMethod\n * @returns The updated Category\n */\n function updateCategory(_id: string | null, category: UpdateCategory, options?: UpdateCategoryOptions): Promise;\n interface UpdateCategory {\n /**\n * Category ID\n * @readonly\n */\n _id?: string | null;\n /** Name of the category */\n name?: string | null;\n /**\n * Setting to allow or permit guest commenting\n * @deprecated Setting to allow or permit guest commenting\n */\n guestCommenting?: boolean | null;\n /**\n * Setting to allow or permit guests to add reactions to comments\n * @deprecated Setting to allow or permit guests to add reactions to comments\n */\n guestReactions?: boolean | null;\n /** The selected type of reactions to be used in comments */\n reactionType?: ReactionTypeType;\n /** The selected type of reactions to be used in replies */\n repliesReactionType?: RepliesReactionTypeType;\n /** The default comment label for marked comment badges */\n markedCommentLabelType?: Type;\n /** Custom label value for marked comment badges */\n customMarkedCommentLabel?: string | null;\n /** The type of icons to be used for comment likes */\n mainReaction?: ReactionIcon;\n /** Category ratings settings. Describes whether ratings are enabled for category and if leaving a rating when placing a comment is mandatory */\n ratingsSettings?: RatingsSettings;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Category was created\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this Category was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Category permissions settings. Describes what UoU entities are allowed to perform actions */\n permissionsSettings?: PermissionsSettings;\n /** Indication of whether the category is active and being used in live site */\n active?: boolean | null;\n /** Application owning category */\n appId?: string | null;\n }\n interface UpdateCategoryOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Delete a Category\n * @param categoryId - Id of the Category to delete\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId WIX_COMMENTS.CATEGORY_DELETE\n * @adminMethod\n */\n function deleteCategory(categoryId: string, options?: DeleteCategoryOptions): Promise;\n interface DeleteCategoryOptions {\n /** The revision of the Category */\n revision?: string;\n }\n /**\n * Query Category using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_COMMENTS.CATEGORY_READ\n */\n function queryCategory(): CategoriesQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CategoriesQueryResult extends QueryCursorResult {\n items: Category[];\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: '_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId', 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: '_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId', 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: '_createdDate', 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: '_createdDate', 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: '_createdDate', 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: '_createdDate', 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: '_id' | 'name' | 'appId', 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: '_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId', value: any[]) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId', value: any) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId', value: boolean) => 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: Array<'_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId'>) => 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: Array<'_id' | 'name' | 'guestCommenting' | 'guestReactions' | 'ratingsSettings.ratingsEnabled' | 'ratingsSettings.ratingRequired' | '_createdDate' | 'permissionsSettings.createComment' | 'permissionsSettings.createReply' | 'permissionsSettings.createReact' | 'appId'>) => 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 cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n type commentsV1Category_universal_d_Category = Category;\n type commentsV1Category_universal_d_ReactionTypeType = ReactionTypeType;\n const commentsV1Category_universal_d_ReactionTypeType: typeof ReactionTypeType;\n type commentsV1Category_universal_d_RepliesReactionTypeType = RepliesReactionTypeType;\n const commentsV1Category_universal_d_RepliesReactionTypeType: typeof RepliesReactionTypeType;\n type commentsV1Category_universal_d_Type = Type;\n const commentsV1Category_universal_d_Type: typeof Type;\n type commentsV1Category_universal_d_ReactionIcon = ReactionIcon;\n type commentsV1Category_universal_d_ReactionIconIconsOneOf = ReactionIconIconsOneOf;\n type commentsV1Category_universal_d_IconTypeType = IconTypeType;\n const commentsV1Category_universal_d_IconTypeType: typeof IconTypeType;\n type commentsV1Category_universal_d_RatingsSettings = RatingsSettings;\n type commentsV1Category_universal_d_PermissionsSettings = PermissionsSettings;\n type commentsV1Category_universal_d_Permissions = Permissions;\n type commentsV1Category_universal_d_Role = Role;\n const commentsV1Category_universal_d_Role: typeof Role;\n type commentsV1Category_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type commentsV1Category_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type commentsV1Category_universal_d_GetCategoryRequest = GetCategoryRequest;\n type commentsV1Category_universal_d_GetCategoryResponse = GetCategoryResponse;\n type commentsV1Category_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type commentsV1Category_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type commentsV1Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type commentsV1Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type commentsV1Category_universal_d_QueryCategoryRequest = QueryCategoryRequest;\n type commentsV1Category_universal_d_QueryV2 = QueryV2;\n type commentsV1Category_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type commentsV1Category_universal_d_Sorting = Sorting;\n type commentsV1Category_universal_d_SortOrder = SortOrder;\n const commentsV1Category_universal_d_SortOrder: typeof SortOrder;\n type commentsV1Category_universal_d_Paging = Paging;\n type commentsV1Category_universal_d_CursorPaging = CursorPaging;\n type commentsV1Category_universal_d_QueryCategoryResponse = QueryCategoryResponse;\n type commentsV1Category_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type commentsV1Category_universal_d_Cursors = Cursors;\n type commentsV1Category_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type commentsV1Category_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type commentsV1Category_universal_d_Asset = Asset;\n type commentsV1Category_universal_d_State = State;\n const commentsV1Category_universal_d_State: typeof State;\n type commentsV1Category_universal_d_SiteCreated = SiteCreated;\n type commentsV1Category_universal_d_SiteCreatedContext = SiteCreatedContext;\n const commentsV1Category_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type commentsV1Category_universal_d_Namespace = Namespace;\n const commentsV1Category_universal_d_Namespace: typeof Namespace;\n type commentsV1Category_universal_d_SiteTransferred = SiteTransferred;\n type commentsV1Category_universal_d_SiteDeleted = SiteDeleted;\n type commentsV1Category_universal_d_DeleteContext = DeleteContext;\n type commentsV1Category_universal_d_DeleteStatus = DeleteStatus;\n const commentsV1Category_universal_d_DeleteStatus: typeof DeleteStatus;\n type commentsV1Category_universal_d_SiteUndeleted = SiteUndeleted;\n type commentsV1Category_universal_d_SitePublished = SitePublished;\n type commentsV1Category_universal_d_SiteUnpublished = SiteUnpublished;\n type commentsV1Category_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type commentsV1Category_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type commentsV1Category_universal_d_ServiceProvisioned = ServiceProvisioned;\n type commentsV1Category_universal_d_ServiceRemoved = ServiceRemoved;\n type commentsV1Category_universal_d_SiteRenamed = SiteRenamed;\n type commentsV1Category_universal_d_SiteHardDeleted = SiteHardDeleted;\n type commentsV1Category_universal_d_NamespaceChanged = NamespaceChanged;\n type commentsV1Category_universal_d_StudioAssigned = StudioAssigned;\n type commentsV1Category_universal_d_StudioUnassigned = StudioUnassigned;\n type commentsV1Category_universal_d_MessageEnvelope = MessageEnvelope;\n type commentsV1Category_universal_d_IdentificationData = IdentificationData;\n type commentsV1Category_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type commentsV1Category_universal_d_WebhookIdentityType = WebhookIdentityType;\n const commentsV1Category_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const commentsV1Category_universal_d_createCategory: typeof createCategory;\n const commentsV1Category_universal_d_getCategory: typeof getCategory;\n const commentsV1Category_universal_d_updateCategory: typeof updateCategory;\n type commentsV1Category_universal_d_UpdateCategory = UpdateCategory;\n type commentsV1Category_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const commentsV1Category_universal_d_deleteCategory: typeof deleteCategory;\n type commentsV1Category_universal_d_DeleteCategoryOptions = DeleteCategoryOptions;\n const commentsV1Category_universal_d_queryCategory: typeof queryCategory;\n type commentsV1Category_universal_d_CategoriesQueryResult = CategoriesQueryResult;\n type commentsV1Category_universal_d_CategoriesQueryBuilder = CategoriesQueryBuilder;\n namespace commentsV1Category_universal_d {\n export {\n commentsV1Category_universal_d_Category as Category,\n commentsV1Category_universal_d_ReactionTypeType as ReactionTypeType,\n commentsV1Category_universal_d_RepliesReactionTypeType as RepliesReactionTypeType,\n commentsV1Category_universal_d_Type as Type,\n commentsV1Category_universal_d_ReactionIcon as ReactionIcon,\n commentsV1Category_universal_d_ReactionIconIconsOneOf as ReactionIconIconsOneOf,\n commentsV1Category_universal_d_IconTypeType as IconTypeType,\n commentsV1Category_universal_d_RatingsSettings as RatingsSettings,\n commentsV1Category_universal_d_PermissionsSettings as PermissionsSettings,\n commentsV1Category_universal_d_Permissions as Permissions,\n commentsV1Category_universal_d_Role as Role,\n commentsV1Category_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n commentsV1Category_universal_d_CreateCategoryResponse as CreateCategoryResponse,\n commentsV1Category_universal_d_GetCategoryRequest as GetCategoryRequest,\n commentsV1Category_universal_d_GetCategoryResponse as GetCategoryResponse,\n commentsV1Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n commentsV1Category_universal_d_UpdateCategoryResponse as UpdateCategoryResponse,\n commentsV1Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n commentsV1Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n commentsV1Category_universal_d_QueryCategoryRequest as QueryCategoryRequest,\n commentsV1Category_universal_d_QueryV2 as QueryV2,\n commentsV1Category_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n commentsV1Category_universal_d_Sorting as Sorting,\n commentsV1Category_universal_d_SortOrder as SortOrder,\n commentsV1Category_universal_d_Paging as Paging,\n commentsV1Category_universal_d_CursorPaging as CursorPaging,\n commentsV1Category_universal_d_QueryCategoryResponse as QueryCategoryResponse,\n commentsV1Category_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n commentsV1Category_universal_d_Cursors as Cursors,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n Empty$1 as Empty,\n commentsV1Category_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n commentsV1Category_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n commentsV1Category_universal_d_Asset as Asset,\n commentsV1Category_universal_d_State as State,\n commentsV1Category_universal_d_SiteCreated as SiteCreated,\n commentsV1Category_universal_d_SiteCreatedContext as SiteCreatedContext,\n commentsV1Category_universal_d_Namespace as Namespace,\n commentsV1Category_universal_d_SiteTransferred as SiteTransferred,\n commentsV1Category_universal_d_SiteDeleted as SiteDeleted,\n commentsV1Category_universal_d_DeleteContext as DeleteContext,\n commentsV1Category_universal_d_DeleteStatus as DeleteStatus,\n commentsV1Category_universal_d_SiteUndeleted as SiteUndeleted,\n commentsV1Category_universal_d_SitePublished as SitePublished,\n commentsV1Category_universal_d_SiteUnpublished as SiteUnpublished,\n commentsV1Category_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n commentsV1Category_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n commentsV1Category_universal_d_ServiceProvisioned as ServiceProvisioned,\n commentsV1Category_universal_d_ServiceRemoved as ServiceRemoved,\n commentsV1Category_universal_d_SiteRenamed as SiteRenamed,\n commentsV1Category_universal_d_SiteHardDeleted as SiteHardDeleted,\n commentsV1Category_universal_d_NamespaceChanged as NamespaceChanged,\n commentsV1Category_universal_d_StudioAssigned as StudioAssigned,\n commentsV1Category_universal_d_StudioUnassigned as StudioUnassigned,\n commentsV1Category_universal_d_MessageEnvelope as MessageEnvelope,\n commentsV1Category_universal_d_IdentificationData as IdentificationData,\n commentsV1Category_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n commentsV1Category_universal_d_WebhookIdentityType as WebhookIdentityType,\n commentsV1Category_universal_d_createCategory as createCategory,\n commentsV1Category_universal_d_getCategory as getCategory,\n commentsV1Category_universal_d_updateCategory as updateCategory,\n commentsV1Category_universal_d_UpdateCategory as UpdateCategory,\n commentsV1Category_universal_d_UpdateCategoryOptions as UpdateCategoryOptions,\n commentsV1Category_universal_d_deleteCategory as deleteCategory,\n commentsV1Category_universal_d_DeleteCategoryOptions as DeleteCategoryOptions,\n commentsV1Category_universal_d_queryCategory as queryCategory,\n commentsV1Category_universal_d_CategoriesQueryResult as CategoriesQueryResult,\n commentsV1Category_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder,\n };\n }\n \n /** CommentsSubscription is the main entity for Comments subscriptions service */\n interface CommentsSubscription extends CommentsSubscriptionSubscriptionTypeOneOf {\n resource?: ResourceData;\n comment?: CommentData;\n /**\n * Subscription status. Read-only field\n * @readonly\n */\n subscriptionStatus?: Status;\n }\n /** @oneof */\n interface CommentsSubscriptionSubscriptionTypeOneOf {\n resource?: ResourceData;\n comment?: CommentData;\n }\n /** ContextId and resource Id, to which subscriptions are attached to */\n interface ResourceData {\n contextId?: string;\n resourceId?: string;\n }\n /** Context Id, resource Id and comment Id, to which subscriptions are attached to */\n interface CommentData {\n contextId?: string;\n resourceId?: string;\n commentId?: string;\n }\n enum Status {\n UNKNOWN = \"UNKNOWN\",\n UNSUBSCRIBED = \"UNSUBSCRIBED\",\n SUBSCRIBED = \"SUBSCRIBED\"\n }\n interface SubscribeRequest {\n /** Entity to which the user has to be subscribed to */\n subscription: CommentsSubscription;\n }\n interface SubscribeResponse {\n }\n interface UnsubscribeRequest {\n /** Entity from which the user is unsubscribing */\n subscription: CommentsSubscription;\n }\n interface UnsubscribeResponse {\n }\n interface GetSubscriptionRequest {\n /** Entity for which to get subscription status */\n subscription: CommentsSubscription;\n }\n interface GetSubscriptionResponse {\n /** Comments subscription with subscription status data */\n subscription?: CommentsSubscription;\n }\n interface ListSubscriptionsRequest {\n /** Comments subscriptions for which to get subscription statuses */\n subscriptions: CommentsSubscription[];\n }\n interface ListSubscriptionsResponse {\n /** Comments subscriptions with subscription statuses attached */\n subscriptions?: CommentsSubscription[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface Empty {\n }\n /**\n * Subscribes user to specified entity topic\n * @param subscription - Entity to which the user has to be subscribed to\n * @internal\n * @documentationMaturity preview\n * @requiredField subscription\n * @adminMethod\n */\n function subscribe(subscription: CommentsSubscription): Promise;\n /**\n * Unsubscribes user from specified entity topic\n * @param subscription - Entity from which the user is unsubscribing\n * @internal\n * @documentationMaturity preview\n * @requiredField subscription\n * @adminMethod\n */\n function unsubscribe(subscription: CommentsSubscription): Promise;\n /**\n * Gets subscription and its status\n * @param subscription - Entity for which to get subscription status\n * @internal\n * @documentationMaturity preview\n * @requiredField subscription\n * @adminMethod\n */\n function getSubscription(subscription: CommentsSubscription): Promise;\n /**\n * List of subscriptions with their status\n * @param subscriptions - Comments subscriptions for which to get subscription statuses\n * @internal\n * @documentationMaturity preview\n * @requiredField subscriptions\n * @adminMethod\n */\n function listSubscriptions(subscriptions: CommentsSubscription[]): Promise;\n \n type commentsV1CommentsSubscription_universal_d_CommentsSubscription = CommentsSubscription;\n type commentsV1CommentsSubscription_universal_d_CommentsSubscriptionSubscriptionTypeOneOf = CommentsSubscriptionSubscriptionTypeOneOf;\n type commentsV1CommentsSubscription_universal_d_ResourceData = ResourceData;\n type commentsV1CommentsSubscription_universal_d_CommentData = CommentData;\n type commentsV1CommentsSubscription_universal_d_Status = Status;\n const commentsV1CommentsSubscription_universal_d_Status: typeof Status;\n type commentsV1CommentsSubscription_universal_d_SubscribeRequest = SubscribeRequest;\n type commentsV1CommentsSubscription_universal_d_SubscribeResponse = SubscribeResponse;\n type commentsV1CommentsSubscription_universal_d_UnsubscribeRequest = UnsubscribeRequest;\n type commentsV1CommentsSubscription_universal_d_UnsubscribeResponse = UnsubscribeResponse;\n type commentsV1CommentsSubscription_universal_d_GetSubscriptionRequest = GetSubscriptionRequest;\n type commentsV1CommentsSubscription_universal_d_GetSubscriptionResponse = GetSubscriptionResponse;\n type commentsV1CommentsSubscription_universal_d_ListSubscriptionsRequest = ListSubscriptionsRequest;\n type commentsV1CommentsSubscription_universal_d_ListSubscriptionsResponse = ListSubscriptionsResponse;\n type commentsV1CommentsSubscription_universal_d_DomainEvent = DomainEvent;\n type commentsV1CommentsSubscription_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type commentsV1CommentsSubscription_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type commentsV1CommentsSubscription_universal_d_RestoreInfo = RestoreInfo;\n type commentsV1CommentsSubscription_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type commentsV1CommentsSubscription_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type commentsV1CommentsSubscription_universal_d_ActionEvent = ActionEvent;\n type commentsV1CommentsSubscription_universal_d_Empty = Empty;\n const commentsV1CommentsSubscription_universal_d_subscribe: typeof subscribe;\n const commentsV1CommentsSubscription_universal_d_unsubscribe: typeof unsubscribe;\n const commentsV1CommentsSubscription_universal_d_getSubscription: typeof getSubscription;\n const commentsV1CommentsSubscription_universal_d_listSubscriptions: typeof listSubscriptions;\n namespace commentsV1CommentsSubscription_universal_d {\n export {\n commentsV1CommentsSubscription_universal_d_CommentsSubscription as CommentsSubscription,\n commentsV1CommentsSubscription_universal_d_CommentsSubscriptionSubscriptionTypeOneOf as CommentsSubscriptionSubscriptionTypeOneOf,\n commentsV1CommentsSubscription_universal_d_ResourceData as ResourceData,\n commentsV1CommentsSubscription_universal_d_CommentData as CommentData,\n commentsV1CommentsSubscription_universal_d_Status as Status,\n commentsV1CommentsSubscription_universal_d_SubscribeRequest as SubscribeRequest,\n commentsV1CommentsSubscription_universal_d_SubscribeResponse as SubscribeResponse,\n commentsV1CommentsSubscription_universal_d_UnsubscribeRequest as UnsubscribeRequest,\n commentsV1CommentsSubscription_universal_d_UnsubscribeResponse as UnsubscribeResponse,\n commentsV1CommentsSubscription_universal_d_GetSubscriptionRequest as GetSubscriptionRequest,\n commentsV1CommentsSubscription_universal_d_GetSubscriptionResponse as GetSubscriptionResponse,\n commentsV1CommentsSubscription_universal_d_ListSubscriptionsRequest as ListSubscriptionsRequest,\n commentsV1CommentsSubscription_universal_d_ListSubscriptionsResponse as ListSubscriptionsResponse,\n commentsV1CommentsSubscription_universal_d_DomainEvent as DomainEvent,\n commentsV1CommentsSubscription_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n commentsV1CommentsSubscription_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n commentsV1CommentsSubscription_universal_d_RestoreInfo as RestoreInfo,\n commentsV1CommentsSubscription_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n commentsV1CommentsSubscription_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n commentsV1CommentsSubscription_universal_d_ActionEvent as ActionEvent,\n commentsV1CommentsSubscription_universal_d_Empty as Empty,\n commentsV1CommentsSubscription_universal_d_subscribe as subscribe,\n commentsV1CommentsSubscription_universal_d_unsubscribe as unsubscribe,\n commentsV1CommentsSubscription_universal_d_getSubscription as getSubscription,\n commentsV1CommentsSubscription_universal_d_listSubscriptions as listSubscriptions,\n };\n }\n \n export { commentsV1Category_universal_d as categories, commentsV2Comment_universal_d as comments, commentsV1CommentsSubscription_universal_d as subscriptions, commentsCategoriesV1CommentsWidget_universal_d as widgets };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-marketing-tags-backend.d.ts", "content": "declare module \"wix-marketing-tags-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface MarketingTag extends MarketingTagParamsOneOf {\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 * 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 /** @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 enum Type {\n /** Illegal default value, exception will be thrown if used */\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 }\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 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 /** optional filter */\n filter?: Filter;\n }\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 /**\n * Creates or updates a marketing tag.\n * @param tag - Marketing tag to create or update.\n * @public\n * @documentationMaturity preview\n * @requiredField tag\n * @requiredField tag\n */\n function upsertMarketingTag(tag: MarketingTag): Promise;\n /**\n * Retrieves marketing tags given the provided filter.\n * @public\n * @documentationMaturity preview\n */\n function listMarketingTags(options?: ListMarketingTagsOptions): Promise;\n interface ListMarketingTagsOptions {\n /** optional filter */\n filter?: Filter;\n }\n /**\n * Deletes a marketing tag.\n * @public\n * @documentationMaturity preview\n */\n function deleteMarketingTag(options?: DeleteMarketingTagOptions): Promise;\n interface DeleteMarketingTagOptions {\n /** Marketing tag to delete. */\n type?: Type;\n }\n /**\n * Deletes a marketing tag\n * @documentationMaturity preview */\n function deleteMarketingTagV2(options?: DeleteMarketingTagV2Options): Promise;\n interface DeleteMarketingTagV2Options {\n /** Marketing tag to delete. */\n tagType?: Type;\n }\n \n const marketingV1Tag_universal_d___debug: typeof __debug;\n type marketingV1Tag_universal_d_MarketingTag = MarketingTag;\n type marketingV1Tag_universal_d_MarketingTagParamsOneOf = MarketingTagParamsOneOf;\n type marketingV1Tag_universal_d_Type = Type;\n const marketingV1Tag_universal_d_Type: typeof Type;\n type marketingV1Tag_universal_d_GoogleAds = GoogleAds;\n type marketingV1Tag_universal_d_GoogleAnalytics = GoogleAnalytics;\n type marketingV1Tag_universal_d_YandexMetrica = YandexMetrica;\n type marketingV1Tag_universal_d_FacebookPixel = FacebookPixel;\n type marketingV1Tag_universal_d_GoogleTagManager = GoogleTagManager;\n type marketingV1Tag_universal_d_UpsertMarketingTagRequest = UpsertMarketingTagRequest;\n type marketingV1Tag_universal_d_UpsertMarketingTagResponse = UpsertMarketingTagResponse;\n type marketingV1Tag_universal_d_ListMarketingTagsRequest = ListMarketingTagsRequest;\n type marketingV1Tag_universal_d_Filter = Filter;\n type marketingV1Tag_universal_d_ListMarketingTagsResponse = ListMarketingTagsResponse;\n type marketingV1Tag_universal_d_DeleteMarketingTagRequest = DeleteMarketingTagRequest;\n type marketingV1Tag_universal_d_DeleteMarketingTagResponse = DeleteMarketingTagResponse;\n type marketingV1Tag_universal_d_DeleteMarketingTagV2Request = DeleteMarketingTagV2Request;\n type marketingV1Tag_universal_d_DeleteMarketingTagV2Response = DeleteMarketingTagV2Response;\n const marketingV1Tag_universal_d_upsertMarketingTag: typeof upsertMarketingTag;\n const marketingV1Tag_universal_d_listMarketingTags: typeof listMarketingTags;\n type marketingV1Tag_universal_d_ListMarketingTagsOptions = ListMarketingTagsOptions;\n const marketingV1Tag_universal_d_deleteMarketingTag: typeof deleteMarketingTag;\n type marketingV1Tag_universal_d_DeleteMarketingTagOptions = DeleteMarketingTagOptions;\n const marketingV1Tag_universal_d_deleteMarketingTagV2: typeof deleteMarketingTagV2;\n type marketingV1Tag_universal_d_DeleteMarketingTagV2Options = DeleteMarketingTagV2Options;\n namespace marketingV1Tag_universal_d {\n export {\n marketingV1Tag_universal_d___debug as __debug,\n marketingV1Tag_universal_d_MarketingTag as MarketingTag,\n marketingV1Tag_universal_d_MarketingTagParamsOneOf as MarketingTagParamsOneOf,\n marketingV1Tag_universal_d_Type as Type,\n marketingV1Tag_universal_d_GoogleAds as GoogleAds,\n marketingV1Tag_universal_d_GoogleAnalytics as GoogleAnalytics,\n marketingV1Tag_universal_d_YandexMetrica as YandexMetrica,\n marketingV1Tag_universal_d_FacebookPixel as FacebookPixel,\n marketingV1Tag_universal_d_GoogleTagManager as GoogleTagManager,\n marketingV1Tag_universal_d_UpsertMarketingTagRequest as UpsertMarketingTagRequest,\n marketingV1Tag_universal_d_UpsertMarketingTagResponse as UpsertMarketingTagResponse,\n marketingV1Tag_universal_d_ListMarketingTagsRequest as ListMarketingTagsRequest,\n marketingV1Tag_universal_d_Filter as Filter,\n marketingV1Tag_universal_d_ListMarketingTagsResponse as ListMarketingTagsResponse,\n marketingV1Tag_universal_d_DeleteMarketingTagRequest as DeleteMarketingTagRequest,\n marketingV1Tag_universal_d_DeleteMarketingTagResponse as DeleteMarketingTagResponse,\n marketingV1Tag_universal_d_DeleteMarketingTagV2Request as DeleteMarketingTagV2Request,\n marketingV1Tag_universal_d_DeleteMarketingTagV2Response as DeleteMarketingTagV2Response,\n marketingV1Tag_universal_d_upsertMarketingTag as upsertMarketingTag,\n marketingV1Tag_universal_d_listMarketingTags as listMarketingTags,\n marketingV1Tag_universal_d_ListMarketingTagsOptions as ListMarketingTagsOptions,\n marketingV1Tag_universal_d_deleteMarketingTag as deleteMarketingTag,\n marketingV1Tag_universal_d_DeleteMarketingTagOptions as DeleteMarketingTagOptions,\n marketingV1Tag_universal_d_deleteMarketingTagV2 as deleteMarketingTagV2,\n marketingV1Tag_universal_d_DeleteMarketingTagV2Options as DeleteMarketingTagV2Options,\n };\n }\n \n export { marketingV1Tag_universal_d as marketingTags };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-app-market-backend.d.ts", "content": "declare module \"wix-app-market-backend\" {\n interface SendBIEventResponse {\n }\n interface SendBIEventRequest {\n /**\n * Name of the event that's triggered in your app.\n *\n * + `\"APP_DASHBOARD_LOADED\"`: A site onwer or contributor loads your app's dashboard.\n * + `\"APP_FINISHED_CONFIGURATION\"`: The site owner completes all required configurations for your app in the Wix Developers Center.\n * + `\"APP_UPGRADED\"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.\n * + `\"PRIMARY_ACTION_PERFORMED\"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.\n * + `\"CHARGE\"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.\n * + `\"FUNDS_RETURNED\"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{\"eventData\": {\"sum\": \"5.99\"}}`.\n * + `\"CUSTOM\"`: Any event that's not listed here. Make sure to also send `customEventName`.\n * + `\"APP_DEPLOYED\"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.\n * + `\"APP_FINISH_BUSINESS_SETUP\"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `\"APP_SETUP_FINISHED\"` instead.\n * + `\"APP_SETUP_FINISHED\"`: The site owner completes your app's required business setup.\n */\n eventName?: EventName;\n /**\n * Name of your app's custom event that was triggered. Required when `{\"eventName\": \"CUSTOM\"}`.\n *\n * Min: 2 characters\n */\n customEventName?: string | null;\n /**\n * Supported values include: `\"cycle_name\"`, `\"currency\"`, `\"sum\"`, `\"reason\"`, `\"app_plan_id\"`.\n * You may also submit data with keys that aren't listed here.\n *\n * Additional data about your app's event.\n *\n * + `\"cycle_name\"`: Supported values: `\"monthly\"`, `\"yearly\"`, `\"2 years\"`, `\"one time\"`.\n * + `\"currency\"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * + `\"sum\"`: Amount of money. Required for `{\"eventName\": \"CHARGE\"}` and `{\"eventName\": \"FUNDS_RETURNED\"}`.\n * + `\"reason\"`: Information about why the event was triggered in your app.\n * + `\"app_plan_id\"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).\n */\n eventData?: Record;\n }\n enum EventName {\n UNKNOWN = \"UNKNOWN\",\n APP_DASHBOARD_LOADED = \"APP_DASHBOARD_LOADED\",\n APP_FINISHED_CONFIGURATION = \"APP_FINISHED_CONFIGURATION\",\n APP_UPGRADED = \"APP_UPGRADED\",\n PRIMARY_ACTION_PERFORMED = \"PRIMARY_ACTION_PERFORMED\",\n CUSTOM = \"CUSTOM\",\n CHARGE = \"CHARGE\",\n FUNDS_RETURNED = \"FUNDS_RETURNED\",\n APP_FINISH_BUSINESS_SETUP = \"APP_FINISH_BUSINESS_SETUP\",\n APP_DEPLOYED = \"APP_DEPLOYED\",\n APP_SETUP_FINISHED = \"APP_SETUP_FINISHED\"\n }\n /**\n * Submit a BI event to Wix.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function sendBiEvent(options?: SendBiEventOptions): Promise;\n interface SendBiEventOptions {\n /**\n * Name of the event that's triggered in your app.\n *\n * + `\"APP_DASHBOARD_LOADED\"`: A site onwer or contributor loads your app's dashboard.\n * + `\"APP_FINISHED_CONFIGURATION\"`: The site owner completes all required configurations for your app in the Wix Developers Center.\n * + `\"APP_UPGRADED\"`: The site owner upgrades your app's paid plan. An upgrade means that they have finished the checkout flow on the app's side but not necessarily on Wix's side.\n * + `\"PRIMARY_ACTION_PERFORMED\"`: A site owner, contributor, or visitor triggers your app's primary action. For example, a site visitor writes a product review using your product review app.\n * + `\"CHARGE\"`: You charge money from the site owner. For example, when the site owner purchases or renews a subscription for your app. Make sure to also send `eventData` and a key of `sum`.\n * + `\"FUNDS_RETURNED\"`: Trigger this event when you send money back to a site owner (for example, refunds or chargebacks). Make sure to also send the charge amount inside `eventData`. For example, `{\"eventData\": {\"sum\": \"5.99\"}}`.\n * + `\"CUSTOM\"`: Any event that's not listed here. Make sure to also send `customEventName`.\n * + `\"APP_DEPLOYED\"`: Your app’s internal code implementation is changed and might affect user flows or cause a regression.\n * + `\"APP_FINISH_BUSINESS_SETUP\"`: __Deprecation Notice:__ This enum value will be removed on March 30, 2023. Use `\"APP_SETUP_FINISHED\"` instead.\n * + `\"APP_SETUP_FINISHED\"`: The site owner completes your app's required business setup.\n */\n eventName?: EventName;\n /**\n * Name of your app's custom event that was triggered. Required when `{\"eventName\": \"CUSTOM\"}`.\n *\n * Min: 2 characters\n */\n customEventName?: string | null;\n /**\n * Supported values include: `\"cycle_name\"`, `\"currency\"`, `\"sum\"`, `\"reason\"`, `\"app_plan_id\"`.\n * You may also submit data with keys that aren't listed here.\n *\n * Additional data about your app's event.\n *\n * + `\"cycle_name\"`: Supported values: `\"monthly\"`, `\"yearly\"`, `\"2 years\"`, `\"one time\"`.\n * + `\"currency\"`: 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * + `\"sum\"`: Amount of money. Required for `{\"eventName\": \"CHARGE\"}` and `{\"eventName\": \"FUNDS_RETURNED\"}`.\n * + `\"reason\"`: Information about why the event was triggered in your app.\n * + `\"app_plan_id\"`: ID of the your app's plan as displayed in the Developers Center. Note that it's the same value as `vendorProductId` in the [Paid Plan Purchased webhook](https://dev.wix.com/docs/rest/api-reference/app-management/apps/app-instance/paid-plan-purchased).\n */\n eventData?: Record;\n }\n \n type devcenterBiEventsV1SendBiEventResponse_universal_d_SendBIEventResponse = SendBIEventResponse;\n type devcenterBiEventsV1SendBiEventResponse_universal_d_SendBIEventRequest = SendBIEventRequest;\n type devcenterBiEventsV1SendBiEventResponse_universal_d_EventName = EventName;\n const devcenterBiEventsV1SendBiEventResponse_universal_d_EventName: typeof EventName;\n const devcenterBiEventsV1SendBiEventResponse_universal_d_sendBiEvent: typeof sendBiEvent;\n type devcenterBiEventsV1SendBiEventResponse_universal_d_SendBiEventOptions = SendBiEventOptions;\n namespace devcenterBiEventsV1SendBiEventResponse_universal_d {\n export {\n devcenterBiEventsV1SendBiEventResponse_universal_d_SendBIEventResponse as SendBIEventResponse,\n devcenterBiEventsV1SendBiEventResponse_universal_d_SendBIEventRequest as SendBIEventRequest,\n devcenterBiEventsV1SendBiEventResponse_universal_d_EventName as EventName,\n devcenterBiEventsV1SendBiEventResponse_universal_d_sendBiEvent as sendBiEvent,\n devcenterBiEventsV1SendBiEventResponse_universal_d_SendBiEventOptions as SendBiEventOptions,\n };\n }\n \n interface PurchasedItem {\n /** ID of your app's paid plan. */\n productId?: string;\n /** Price of your app's paid plan. For example, `9.95`. */\n price?: string;\n /**\n * 3-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency?: string;\n /** Information about the billing cycle for your app's paid plan. */\n billingCycle?: PaymentCycle;\n /**\n * Date and time the site onwers have purchased your app's paid plan in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n dateCreated?: Date;\n }\n enum PaymentCycle {\n NO_CYCLE = \"NO_CYCLE\",\n MONTHLY = \"MONTHLY\",\n YEARLY = \"YEARLY\",\n ONE_TIME = \"ONE_TIME\",\n TWO_YEARS = \"TWO_YEARS\",\n THREE_YEARS = \"THREE_YEARS\",\n FOUR_YEARS = \"FOUR_YEARS\",\n FIVE_YEARS = \"FIVE_YEARS\"\n }\n interface InvoiceStatusUpdate {\n /** Invoice payment status. */\n status?: InvoiceStatus;\n /** Wix Premium invoice ID. */\n invoiceId?: string;\n /** App instance ID - a unique ID assigned to each app in each site. */\n instanceId?: string | null;\n /** Whether the invoice is for a single payment or for multiple, recurring payments. */\n recurring?: boolean;\n }\n enum InvoiceStatus {\n UNKNOWN_INVOICE_STATUS = \"UNKNOWN_INVOICE_STATUS\",\n PAYMENT_FAILED = \"PAYMENT_FAILED\",\n PAID = \"PAID\",\n REFUNDED = \"REFUNDED\",\n VOIDED = \"VOIDED\",\n CHARGEDBACK = \"CHARGEDBACK\"\n }\n interface GetUrlRequest {\n /**\n * ID of your app's paid plan to retrieve the Wix checkout URL for. Check the\n * Wix Developers Center for a list of your app's supported product IDs.\n */\n productId: string;\n /**\n * URL for the Wix checkout page. Redirect site owners to this URL after\n * they've successfully purchased a paid plan for your app.\n */\n successUrl?: string | null;\n /**\n * Whether the checkout is for testing purposes only. Testing is mainly\n * relevant for in-app purchase flows. When `true`, Wix charges the site\n * owners an amount of `0.00`.\n */\n testCheckout?: boolean;\n /** Information about the paid plan's billing cycle. */\n billingCycle?: PaymentCycle;\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 * Default: `\"US\"`\n */\n countryCode?: string | null;\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 * Default: `\"EN\"`\n */\n languageCode?: string | null;\n /**\n * Price and currency Wix uses to charge the site owners. Overrides the\n * default values you've set in the app's pricing plan in the Wix Developers\n * Center. Only supported in combination with `{\"billingCycle\": \"ONE_TIME\"}`.\n * Otherwise the call fails with a validation error.\n * @internal\n */\n chargeOverride?: ChargeOverride;\n /** Coupon code for the paid plan. Available only in case there is a discount. */\n couponCode?: string | null;\n }\n interface ChargeOverride {\n /**\n * Override price. In case you omit the override price, Wix charges site\n * owners the app's default price that's configured in the Wix Developers\n * Center.\n */\n price?: number;\n /**\n * Override 3-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency?: string;\n }\n interface GetUrlResponse {\n /** URL for the Wix checkout page. */\n checkoutUrl?: string;\n /**\n * Token for the Wix checkout page. The token holds all data about the order\n * you're creating a checkout for. It is [signed](),\n * so you can verify that it comes from Wix.\n */\n token?: string | null;\n }\n interface GetPurchaseHistoryRequest {\n }\n interface GetPurchaseHistoryResponse {\n /** Retrieved purchases the site owners have completed for you app. */\n purchases?: PurchasedItem[];\n }\n interface GetSitePaymentMethodsStatusRequest {\n }\n interface GetSitePaymentMethodsStatusResponse {\n /**\n * Whether the site owners have enabled at least a single online payment method.\n * Online payment methods include Wix Payments, Stripe, PayPal, and credit\n * cards.\n */\n onlineProviderEnabled?: boolean;\n /** Whether the site owners accept offline payments. */\n offlineProviderEnabled?: boolean;\n /**\n * Whether the site owners have enabled the\n * [Wix Point of Sale](https://www.wix.com/pos).\n * This allows their customers to make electronic payments in person.\n */\n wixPosProviderEnabled?: boolean;\n /**\n * Whether the site owners have enabled at least one 3rd-party point-of-sale\n * provider. This allows their customers to make electronic payments in person.\n */\n thirdPartyPosProviderEnabled?: boolean;\n }\n interface GetMeteredBillingChargesRequest {\n /**\n * 3-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency?: string | null;\n /**\n * Start of the period you want to retrieve the custom charges for in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n startDate?: Date;\n /**\n * End of the period you want to retrieve the custom charges for in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n endDate?: Date;\n }\n interface GetMeteredBillingChargesResponse {\n /** List of retrieved custom charges. */\n charges?: Charge[];\n }\n interface Charge {\n /** ID of the custom charge. The ID consists of 64 characters. */\n _id?: string | null;\n /** Description of the custom charge. */\n description?: string;\n /**\n * Charge amount.\n *\n * Min: `0.50`\n */\n amount?: 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 URL for a Wix checkout page for the specified paid plan of your app.\n *\n *\n * This call succeeds only in case you have previously\n * [set up an external pricing page in the Wix Developers Center](https://dev.wix.com/docs/build-apps/build-your-app/pricing-plans/set-up-an-external-pricing-page).\n *\n * The returned checkout URL is valid for 48 hours.\n *\n * This API allows your app to manage your pricing page outside of Wix while\n * still using the standard Wix checkout flow.\n * @param productId - ID of your app's paid plan to retrieve the Wix checkout URL for. Check the\n * Wix Developers Center for a list of your app's supported product IDs.\n * @public\n * @documentationMaturity preview\n * @requiredField productId\n * @adminMethod\n */\n function getUrl(productId: string, options?: GetUrlOptions): Promise;\n interface GetUrlOptions {\n /**\n * URL for the Wix checkout page. Redirect site owners to this URL after\n * they've successfully purchased a paid plan for your app.\n */\n successUrl?: string | null;\n /**\n * Whether the checkout is for testing purposes only. Testing is mainly\n * relevant for in-app purchase flows. When `true`, Wix charges the site\n * owners an amount of `0.00`.\n */\n testCheckout?: boolean;\n /** Information about the paid plan's billing cycle. */\n billingCycle?: PaymentCycle;\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 * Default: `\"US\"`\n */\n countryCode?: string | null;\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 * Default: `\"EN\"`\n */\n languageCode?: string | null;\n /**\n * Price and currency Wix uses to charge the site owners. Overrides the\n * default values you've set in the app's pricing plan in the Wix Developers\n * Center. Only supported in combination with `{\"billingCycle\": \"ONE_TIME\"}`.\n * Otherwise the call fails with a validation error.\n * @internal\n */\n chargeOverride?: ChargeOverride;\n /** Coupon code for the paid plan. Available only in case there is a discount. */\n couponCode?: string | null;\n }\n /**\n * Retrieves a list of the site owner's past purchases for your app.\n *\n *\n * You don't have to explicitly pass an identifier for the Wix site as part of\n * the request, since this information is taken automatically from the context.\n *\n * The response doesn't include any details about cancellations.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function getPurchaseHistory(): Promise;\n /**\n * Retrieves information about the site's enabled payment methods.\n *\n *\n * Checks whether online, offline, Wix POS, and external POS payments are\n * enabled.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getSitePaymentMethodsStatus(): Promise;\n /**\n * Triggers Wix to call the\n * [List Custom Charges SPI](https://dev.wix.com/docs/rest/internal-only/premium/custom-charges-spi/custom-charges-provider-v1/list-charges).\n *\n *\n * Wix doesn't use the response from _List Charges_ SPI to actually create an\n * invoice that's sent to the customer. Instead, calling _Get Metered Billing Charges_\n * allows you confirm that your integration with the Custom Charges SPI is\n * working as intended.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getMeteredBillingCharges(options?: GetMeteredBillingChargesOptions): Promise;\n interface GetMeteredBillingChargesOptions {\n /**\n * 3-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n */\n currency?: string | null;\n /**\n * Start of the period you want to retrieve the custom charges for in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n startDate?: Date;\n /**\n * End of the period you want to retrieve the custom charges for in\n * `YYYY-MM-DDThh:mm:ss.sssZ` format.\n */\n endDate?: Date;\n }\n \n type devcenterCheckoutV1PurchasedItem_universal_d_PurchasedItem = PurchasedItem;\n type devcenterCheckoutV1PurchasedItem_universal_d_PaymentCycle = PaymentCycle;\n const devcenterCheckoutV1PurchasedItem_universal_d_PaymentCycle: typeof PaymentCycle;\n type devcenterCheckoutV1PurchasedItem_universal_d_InvoiceStatusUpdate = InvoiceStatusUpdate;\n type devcenterCheckoutV1PurchasedItem_universal_d_InvoiceStatus = InvoiceStatus;\n const devcenterCheckoutV1PurchasedItem_universal_d_InvoiceStatus: typeof InvoiceStatus;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetUrlRequest = GetUrlRequest;\n type devcenterCheckoutV1PurchasedItem_universal_d_ChargeOverride = ChargeOverride;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetUrlResponse = GetUrlResponse;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetPurchaseHistoryRequest = GetPurchaseHistoryRequest;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetPurchaseHistoryResponse = GetPurchaseHistoryResponse;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetSitePaymentMethodsStatusRequest = GetSitePaymentMethodsStatusRequest;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetSitePaymentMethodsStatusResponse = GetSitePaymentMethodsStatusResponse;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetMeteredBillingChargesRequest = GetMeteredBillingChargesRequest;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetMeteredBillingChargesResponse = GetMeteredBillingChargesResponse;\n type devcenterCheckoutV1PurchasedItem_universal_d_Charge = Charge;\n type devcenterCheckoutV1PurchasedItem_universal_d_MessageEnvelope = MessageEnvelope;\n type devcenterCheckoutV1PurchasedItem_universal_d_IdentificationData = IdentificationData;\n type devcenterCheckoutV1PurchasedItem_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type devcenterCheckoutV1PurchasedItem_universal_d_WebhookIdentityType = WebhookIdentityType;\n const devcenterCheckoutV1PurchasedItem_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const devcenterCheckoutV1PurchasedItem_universal_d_getUrl: typeof getUrl;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetUrlOptions = GetUrlOptions;\n const devcenterCheckoutV1PurchasedItem_universal_d_getPurchaseHistory: typeof getPurchaseHistory;\n const devcenterCheckoutV1PurchasedItem_universal_d_getSitePaymentMethodsStatus: typeof getSitePaymentMethodsStatus;\n const devcenterCheckoutV1PurchasedItem_universal_d_getMeteredBillingCharges: typeof getMeteredBillingCharges;\n type devcenterCheckoutV1PurchasedItem_universal_d_GetMeteredBillingChargesOptions = GetMeteredBillingChargesOptions;\n namespace devcenterCheckoutV1PurchasedItem_universal_d {\n export {\n devcenterCheckoutV1PurchasedItem_universal_d_PurchasedItem as PurchasedItem,\n devcenterCheckoutV1PurchasedItem_universal_d_PaymentCycle as PaymentCycle,\n devcenterCheckoutV1PurchasedItem_universal_d_InvoiceStatusUpdate as InvoiceStatusUpdate,\n devcenterCheckoutV1PurchasedItem_universal_d_InvoiceStatus as InvoiceStatus,\n devcenterCheckoutV1PurchasedItem_universal_d_GetUrlRequest as GetUrlRequest,\n devcenterCheckoutV1PurchasedItem_universal_d_ChargeOverride as ChargeOverride,\n devcenterCheckoutV1PurchasedItem_universal_d_GetUrlResponse as GetUrlResponse,\n devcenterCheckoutV1PurchasedItem_universal_d_GetPurchaseHistoryRequest as GetPurchaseHistoryRequest,\n devcenterCheckoutV1PurchasedItem_universal_d_GetPurchaseHistoryResponse as GetPurchaseHistoryResponse,\n devcenterCheckoutV1PurchasedItem_universal_d_GetSitePaymentMethodsStatusRequest as GetSitePaymentMethodsStatusRequest,\n devcenterCheckoutV1PurchasedItem_universal_d_GetSitePaymentMethodsStatusResponse as GetSitePaymentMethodsStatusResponse,\n devcenterCheckoutV1PurchasedItem_universal_d_GetMeteredBillingChargesRequest as GetMeteredBillingChargesRequest,\n devcenterCheckoutV1PurchasedItem_universal_d_GetMeteredBillingChargesResponse as GetMeteredBillingChargesResponse,\n devcenterCheckoutV1PurchasedItem_universal_d_Charge as Charge,\n devcenterCheckoutV1PurchasedItem_universal_d_MessageEnvelope as MessageEnvelope,\n devcenterCheckoutV1PurchasedItem_universal_d_IdentificationData as IdentificationData,\n devcenterCheckoutV1PurchasedItem_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n devcenterCheckoutV1PurchasedItem_universal_d_WebhookIdentityType as WebhookIdentityType,\n devcenterCheckoutV1PurchasedItem_universal_d_getUrl as getUrl,\n devcenterCheckoutV1PurchasedItem_universal_d_GetUrlOptions as GetUrlOptions,\n devcenterCheckoutV1PurchasedItem_universal_d_getPurchaseHistory as getPurchaseHistory,\n devcenterCheckoutV1PurchasedItem_universal_d_getSitePaymentMethodsStatus as getSitePaymentMethodsStatus,\n devcenterCheckoutV1PurchasedItem_universal_d_getMeteredBillingCharges as getMeteredBillingCharges,\n devcenterCheckoutV1PurchasedItem_universal_d_GetMeteredBillingChargesOptions as GetMeteredBillingChargesOptions,\n };\n }\n \n /** Embedded script data */\n interface ScriptProperties {\n /** Script parameters */\n parameters?: Record;\n /** Whether script is disabled or not, defaults to false (not disabled) */\n disabled?: boolean;\n }\n interface EmbedScriptRequest {\n /** Details of the script to embed. */\n properties: ScriptProperties;\n /** ID of the corresponding embedded script component. */\n componentId?: string | null;\n }\n interface EmbedScriptResponse {\n /** Details of the embedded script. */\n properties?: ScriptProperties;\n }\n interface GetEmbeddedScriptRequest {\n /** Component ID of the embedded script to retrieve. */\n componentId?: string | null;\n }\n interface GetEmbeddedScriptResponse {\n /** Details of the retrieved embedded script. */\n properties?: ScriptProperties;\n }\n interface EmbedScriptByInstanceIdRequest {\n instanceId: string;\n /** Parameters to embed */\n properties: ScriptProperties;\n componentId?: string | null;\n }\n interface GetEmbeddedScriptByInstanceIdRequest {\n instanceId: string;\n componentId?: string | null;\n }\n /**\n * Inserts custom script tags into a site.\n *\n *\n * Your app must have an existing\n * [embedded script component](https://dev.wix.com/docs/build-apps/developer-tools/extensions/embedded-scripts),\n * with exactly matching parameter names.\n * @param properties - Details of the script to embed.\n * @public\n * @documentationMaturity preview\n * @requiredField properties\n * @adminMethod\n */\n function embedScript(properties: ScriptProperties, options?: EmbedScriptOptions): Promise;\n interface EmbedScriptOptions {\n /** ID of the corresponding embedded script component. */\n componentId?: string | null;\n }\n /**\n * Retrieves information about your app's existing embedded script.\n *\n *\n * The call fails with `404` error in case your app doesn't include an\n * embedded script on the site.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n * @returns Details of the retrieved embedded script.\n */\n function getEmbeddedScript(options?: GetEmbeddedScriptOptions): Promise;\n interface GetEmbeddedScriptOptions {\n /** Component ID of the embedded script to retrieve. */\n componentId?: string | null;\n }\n /** @param properties - Parameters to embed\n * @internal\n * @documentationMaturity preview\n * @requiredField instanceId\n * @requiredField properties\n * @adminMethod\n */\n function embedScriptByInstanceId(instanceId: string, properties: ScriptProperties, options?: EmbedScriptByInstanceIdOptions): Promise;\n interface EmbedScriptByInstanceIdOptions {\n componentId?: string | null;\n }\n /**\n * Retrieves this app's existing embedded script parameters\n * @internal\n * @documentationMaturity preview\n * @requiredField instanceId\n * @adminMethod\n */\n function getEmbeddedScriptByInstanceId(instanceId: string, options?: GetEmbeddedScriptByInstanceIdOptions): Promise;\n interface GetEmbeddedScriptByInstanceIdOptions {\n componentId?: string | null;\n }\n \n type devcenterScriptsV1ScriptProperties_universal_d_ScriptProperties = ScriptProperties;\n type devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptRequest = EmbedScriptRequest;\n type devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptResponse = EmbedScriptResponse;\n type devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptRequest = GetEmbeddedScriptRequest;\n type devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptResponse = GetEmbeddedScriptResponse;\n type devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptByInstanceIdRequest = EmbedScriptByInstanceIdRequest;\n type devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptByInstanceIdRequest = GetEmbeddedScriptByInstanceIdRequest;\n const devcenterScriptsV1ScriptProperties_universal_d_embedScript: typeof embedScript;\n type devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptOptions = EmbedScriptOptions;\n const devcenterScriptsV1ScriptProperties_universal_d_getEmbeddedScript: typeof getEmbeddedScript;\n type devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptOptions = GetEmbeddedScriptOptions;\n const devcenterScriptsV1ScriptProperties_universal_d_embedScriptByInstanceId: typeof embedScriptByInstanceId;\n type devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptByInstanceIdOptions = EmbedScriptByInstanceIdOptions;\n const devcenterScriptsV1ScriptProperties_universal_d_getEmbeddedScriptByInstanceId: typeof getEmbeddedScriptByInstanceId;\n type devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptByInstanceIdOptions = GetEmbeddedScriptByInstanceIdOptions;\n namespace devcenterScriptsV1ScriptProperties_universal_d {\n export {\n devcenterScriptsV1ScriptProperties_universal_d_ScriptProperties as ScriptProperties,\n devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptRequest as EmbedScriptRequest,\n devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptResponse as EmbedScriptResponse,\n devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptRequest as GetEmbeddedScriptRequest,\n devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptResponse as GetEmbeddedScriptResponse,\n devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptByInstanceIdRequest as EmbedScriptByInstanceIdRequest,\n devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptByInstanceIdRequest as GetEmbeddedScriptByInstanceIdRequest,\n devcenterScriptsV1ScriptProperties_universal_d_embedScript as embedScript,\n devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptOptions as EmbedScriptOptions,\n devcenterScriptsV1ScriptProperties_universal_d_getEmbeddedScript as getEmbeddedScript,\n devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptOptions as GetEmbeddedScriptOptions,\n devcenterScriptsV1ScriptProperties_universal_d_embedScriptByInstanceId as embedScriptByInstanceId,\n devcenterScriptsV1ScriptProperties_universal_d_EmbedScriptByInstanceIdOptions as EmbedScriptByInstanceIdOptions,\n devcenterScriptsV1ScriptProperties_universal_d_getEmbeddedScriptByInstanceId as getEmbeddedScriptByInstanceId,\n devcenterScriptsV1ScriptProperties_universal_d_GetEmbeddedScriptByInstanceIdOptions as GetEmbeddedScriptByInstanceIdOptions,\n };\n }\n \n export { devcenterBiEventsV1SendBiEventResponse_universal_d as biEvents, devcenterCheckoutV1PurchasedItem_universal_d as checkout, devcenterScriptsV1ScriptProperties_universal_d as embeddedScripts };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-contacts-backend.v2.d.ts", "content": "declare module \"wix-contacts-backend.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 used 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;\n /**\n * Date and time the contact was last updated.\n * @readonly\n */\n _updatedDate?: Date;\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 *\n * This property reflects the email address in `contactInfo.emails` where `primary` is `true`.\n * @readonly\n */\n primaryInfo?: PrimaryContactInfo;\n /**\n * Contact's profile picture.\n * This can contain an image URL and a Wix Media image ID.\n *\n * > **Deprecation Notice:**\n * > This property has been replaced with\n * > `info.picture`\n * > and will be removed on March 31, 2022. If your app uses this property,\n * > we recommend updating your code as soon as possible.\n * @readonly\n */\n picture?: string;\n /** Contact's details. */\n info?: ContactInfo;\n /**\n * Contact's segment IDs\n * @internal\n * @readonly\n */\n segments?: SegmentsWrapper;\n }\n interface ContactSource {\n /**\n * Some possible values:\n *\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 * @readonly\n */\n sourceType?: ContactSourceType;\n /**\n * App ID, if the contact was created by a Wix app.\n *\n * > **Deprecation Notice:**\n * > This property has been replaced with\n * > `appId`\n * > and will be removed on March 31, 2022. If your app uses this property,\n * > we recommend updating your code as soon as possible.\n * @readonly\n */\n wixAppId?: string | null;\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 }\n interface ContactActivity {\n /** Date and time of the last action. */\n activityDate?: Date;\n /**\n * Contact's last action in the site.\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 activityType?: ContactActivityType;\n }\n enum ContactActivityType {\n /** Last visit to your site (any unknown activity) */\n GENERAL = \"GENERAL\",\n /** This cannot be reported, used when contact created, will throw exception */\n CONTACT_CREATED = \"CONTACT_CREATED\",\n /** \"auth/login\" */\n MEMBER_LOGIN = \"MEMBER_LOGIN\",\n /** \"auth/register\" */\n MEMBER_REGISTER = \"MEMBER_REGISTER\",\n /** \"auth/status-change\" */\n MEMBER_STATUS_CHANGED = \"MEMBER_STATUS_CHANGED\",\n /** \"contact/contact-form\", (but also \"form/contact-form\", \"form/form\") */\n FORM_SUBMITTED = \"FORM_SUBMITTED\",\n /** \"form/lead-capture-form\" */\n INBOX_FORM_SUBMITTED = \"INBOX_FORM_SUBMITTED\",\n /** \"chat/payment-request-paid\" */\n INBOX_PAYMENT_REQUEST_PAID = \"INBOX_PAYMENT_REQUEST_PAID\",\n /** \"messaging/email\" - Direction BUSINESS_TO_CUSTOMER */\n INBOX_MESSAGE_TO_CUSTOMER = \"INBOX_MESSAGE_TO_CUSTOMER\",\n /** \"messaging/email\" - Direction CUSTOMER_TO_BUSINESS */\n INBOX_MESSAGE_FROM_CUSTOMER = \"INBOX_MESSAGE_FROM_CUSTOMER\",\n /** \"contact/subscription-form\" (but also \"form/subscription-form\") */\n NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = \"NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED\",\n /** \"contact/unsubscribe\" */\n NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = \"NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE\",\n /** \"e_commerce/purchase\" */\n ECOM_PURCHASE = \"ECOM_PURCHASE\",\n /** \"e_commerce/cart-abandon\" */\n ECOM_CART_ABANDON = \"ECOM_CART_ABANDON\",\n /** \"e_commerce/checkout-buyer\" */\n ECOM_CHECKOUT_BUYER = \"ECOM_CHECKOUT_BUYER\",\n /** \"scheduler/appointment\" */\n BOOKINGS_APPOINTMENT = \"BOOKINGS_APPOINTMENT\",\n /** \"hotels/reservation\" */\n HOTELS_RESERVATION = \"HOTELS_RESERVATION\",\n /** \"hotels/purchase\" */\n HOTELS_PURCHASE = \"HOTELS_PURCHASE\",\n /** \"hotels/confirmation\" */\n HOTELS_CONFIRMATION = \"HOTELS_CONFIRMATION\",\n /** \"hotels/cancel\" */\n HOTELS_CANCEL = \"HOTELS_CANCEL\",\n /** \"video/purchase\" */\n VIDEO_PURCHASE = \"VIDEO_PURCHASE\",\n /** \"video/rent\" */\n VIDEO_RENT = \"VIDEO_RENT\",\n /** \"cashier/button_purchase\" */\n CASHIER_BUTTON_PURCHASE = \"CASHIER_BUTTON_PURCHASE\",\n /** \"arena/new-lead\" */\n ARENA_NEW_LEAD = \"ARENA_NEW_LEAD\",\n /** \"events/rsvp\" */\n EVENTS_RSVP = \"EVENTS_RSVP\",\n /** \"invoice/pay\" */\n INVOICE_PAY = \"INVOICE_PAY\",\n /** \"invoice/overdue\" */\n INVOICE_OVERDUE = \"INVOICE_OVERDUE\",\n /** \"price-quote/accept\" */\n PRICE_QUOTE_ACCEPT = \"PRICE_QUOTE_ACCEPT\",\n /** \"price-quote/expire\" */\n PRICE_QUOTE_EXPIRE = \"PRICE_QUOTE_EXPIRE\",\n /** \"restaurants/order\" */\n RESTAURANTS_ORDER = \"RESTAURANTS_ORDER\",\n /** \"restaurants/reservation\" */\n RESTAURANTS_RESERVATION = \"RESTAURANTS_RESERVATION\",\n /** \"shoutout/open\" */\n SHOUTOUT_OPEN = \"SHOUTOUT_OPEN\",\n /** \"shoutout/click\" */\n SHOUTOUT_CLICK = \"SHOUTOUT_CLICK\",\n CONTACT_MERGED = \"CONTACT_MERGED\"\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 `contactInfo.phones` 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 /**\n * Contact's job title.\n * Corresponds to the **Position** field in the Dashboard.\n */\n jobTitle?: string | null;\n /** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */\n birthdate?: string | null;\n /**\n * Site contributors\n * who are assigned to manage communication with the contact.\n * @internal\n */\n assignedUserIds?: AssigneesWrapper;\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 label keys.\n * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\n * help categorize contacts.\n *\n *\n * Label keys must exist to be added to the contact.\n * Contact labels can be created or retrieved with\n * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n *\n */\n labelKeys?: LabelsWrapper;\n /**\n * Additional custom fields.\n * This includes fields managed by Wix, by 3rd-party apps, and by the site.\n *\n * Empty fields are not returned.\n */\n extendedFields?: ExtendedFieldsWrapper;\n /**\n * Contact locations\n * @internal\n */\n locations?: LocationsWrapper;\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 * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"MAIN\"`\n * - `\"HOME\"`\n * - `\"WORK\"`\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 */\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 * One of:\n *\n * - `\"UNTAGGED\"`\n * - `\"MAIN\"`\n * - `\"HOME\"`\n * - `\"MOBILE\"`\n * - `\"WORK\"`\n * - `\"FAX\"`\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`,\n * as long as both of those values are valid.\n * @readonly\n */\n e164Phone?: string | null;\n /**\n * Human-readable phone number.\n * Automatically generated using `phone` and `countryCode`,\n * as long as both of those values are valid.\n * @internal\n * @readonly\n */\n formattedPhone?: string | null;\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 | 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 *\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 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 * Apartment number.\n * @internal\n */\n apt?: 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 /** @internal */\n type?: SubdivisionType;\n /**\n * Free text that describes the subdivision type.\n *\n * Examples: `\"state\"`, `\"province\"`, `\"prefecture\"`.\n * @internal\n */\n typeInfo?: string | null;\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 /** cities/towns */\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 * [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\n * help categorize 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 items?: string[];\n }\n interface ExtendedFieldsWrapper {\n /**\n * Set of key-value pairs.\n *\n * Contact's\n * [extended fields](wix-crm-backend/contacts/introduction#about-extended-fields),\n * which allow you to store additional information about your contacts.\n *\n * To view or create extended fields, use\n * [`findOrCreateExtendedField()`](wix-crm-backend/contacts/findorcreateextendedfield),\n * [`getExtendedField()`](wix-crm-backend/contacts/getextendedfield), or\n * [`queryExtendedFields()`](wix-crm-backend/contacts/queryextendedfields).\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 * Indicates whether the image is retrieved from Wix Media\n * or an external provider.\n *\n * - `EXTERNAL`: The image is retrieved from an external provider.\n * - `WIX_MEDIA`: The image is retrieved from Wix Media.\n * @internal\n */\n imageProvider?: ImageProvider;\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 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 }\n interface EstimateAudienceSizeResponse {\n /** Audience size estimation. */\n estimation?: number;\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 /** 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 * Defaults to `false`.\n */\n allowDuplicates?: boolean;\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\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 * Defaults to `false`.\n */\n allowDuplicates?: boolean;\n /** Contact info. */\n info: ContactInfo;\n /**\n * Set of fields to update.\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * See\n * [Field Masks in Update Requests](https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests)\n * for details on working with field masks.\n *\n * > **Deprecation Notice:**\n * > This parameter will be removed on March 31, 2022.\n * > If your app uses this parameter, update your code as soon as possible.\n */\n fieldMask?: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\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 passed.\n */\n targetContactRevision: number | null;\n /**\n * IDs of up to 5 contacts to merge into the target contact.\n * If merging more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\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 * If merging more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\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 * Contact labels can be created or retrieved with\n * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n */\n labelKeys: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\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 * Language for localization.\n * @internal\n */\n language?: string | null;\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 * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n */\n labelKeysToAdd: string[];\n /** List of label keys to remove from the contact. */\n labelKeysToRemove: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n interface LabelAndUnlabelContactResponse {\n /** Updated contact. */\n contact?: Contact;\n }\n interface ListContactsRequest {\n /** Sort order. */\n sort?: Sorting;\n /** Pagination, defaults to offset = 0 and limit = 50 (max limit 1,000). */\n paging?: Paging;\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 * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n interface Sorting {\n /**\n * Field to sort by.\n *\n * Supported properties:\n * `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`,\n * `info.name.first`, `info.name.last`, `info.company`, `info.jobTitle`,\n * `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;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Number of items to return. */\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, addressses */\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;\n }\n interface PagingMetadata {\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryContactsRequest {\n /**\n * Plain text search for an exact match.\n *\n * Supported properties:\n * `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`\n *\n * Max: 100 characters\n */\n search?: string | null;\n /** Query options. */\n query?: Query;\n /**\n * Whether to calculate the total count the number of contacts\n * @internal\n */\n omitTotal?: boolean | null;\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n interface Query {\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[];\n /** Pagination options. */\n paging?: Paging;\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;\n }\n interface ListFacetsRequest {\n /** Allow paginating, default: offset = 0 and limit = 1000 */\n paging?: Paging;\n /** Language for localization */\n language?: string | null;\n /**\n * Wheter to count the number of contacts per facet\n * @internal\n */\n omitCount?: boolean;\n }\n interface ListFacetsResponse {\n /** List of facets. */\n facets?: ContactsFacet[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadata;\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 is applied to. */\n count?: number | null;\n /**\n * Legacy ID of the facet label\n * @internal\n */\n legacyId?: string | null;\n /** Filter used for 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 /** Allow paginating, default: offset = 0 and limit = 1000 */\n paging?: Paging;\n /** Language for localization */\n language?: string | null;\n /**\n * Wheter to count the number of contacts per facet\n * @internal\n */\n omitCount?: boolean;\n /**\n * Only allowed fields:\n * #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)\n * #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)\n * #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in)\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;\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 * For a detailed list of supported filters, see\n * filtering and sorting for\n * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\n * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\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\n * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\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 * For a detailed list of supported filters, see\n * filtering and sorting for\n * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\n * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\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 * Set of fields to update.\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * See\n * [Field Masks in Update Requests](https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests)\n * for details on working with field masks.\n *\n * > **Deprecation Notice:**\n * > This parameter will be removed on March 31, 2022.\n * > If your app uses this parameter, update your code as soon as possible.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateContactsResponse {\n /**\n * Bulk job ID.\n * The job's status can be retrieved with\n * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\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/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\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/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\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 * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\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\n * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\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 /** @internal */\n uploadId?: 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 * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /** The requested contact. */\n interface GetContactResponse {\n /** The requested contact. */\n contact?: Contact;\n /**\n * Contact response type.\n *\n * - `REGULAR`: The specified contact was returned.\n * - `IMPLICIT`: Not used.\n * - `MERGED`: The specified contact was previously merged with another contact, and the new contact was\n */\n responseType?: GetContactResponseType;\n }\n enum GetContactResponseType {\n /** Normal contact */\n REGULAR = \"REGULAR\",\n /** Contact that id was already allocated for it, but the contact not yet created. */\n IMPLICIT = \"IMPLICIT\",\n /** Contact was merged into another contact */\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 * Language for localization.\n * @internal\n */\n language?: string | null;\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[];\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 pagingMetadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\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 and 'too_many_to_count' flag is not set */\n total?: number | null;\n /** A flag that indicates the server failed to calculate 'total' field */\n tooManyToCount?: boolean | null;\n /** Cursors to navigate through result pages. Returned if cursor paging was used */\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 * @internal\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 /**\n * Estimates number of valid contacts by given filter and (optional) search expressions.\n * In Email Marketing context \"valid\" means that bounced/unsubscribed/blacklisted contacts are filtered out.\n * @param filter - Contacts filter expression.\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n */\n function estimateFilterSize(filter: Record | null, options?: EstimateFilterSizeOptions): Promise;\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 /**\n * Estimates number of contacts of campaign's audience.\n * Audience size depends on various filters and search expressions.\n * @internal\n * @documentationMaturity preview\n */\n function estimateAudienceSize(options?: EstimateAudienceSizeOptions): Promise;\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 }\n /**\n * Creates a new contact.\n *\n *\n * The `createContact()` function returns a Promise\n * that resolves to the new contact when it is created.\n * > **Note:**\n * > This function replaces the deprecated\n * > `wixCrmBackend.createContact()`.\n * > The deprecated function will continue to work, but it will not receive updates.\n * > To keep any existing code compatible with future changes, see the\n * > [migration instructions](wix-crm-backend/createcontact#migration-instructions).\n *\n * The `contactInfo` parameter object must include a name, phone number, or email address.\n * If all 3 of these parameters are missing,\n * the contact won't be created.\n *\n * \n * By default,\n * if the call contains an email already in use by another contact,\n * the new contact won't be created.\n * To override this behavior,\n * set `allowDuplicates` in the `options` object to `true`.\n * @param info - Contact info.\n * @public\n * @documentationMaturity preview\n * @requiredField info\n * @param options - Create contact options.\n * @returns Contact.\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 * Defaults to `false`.\n */\n allowDuplicates?: boolean;\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Updates a contact's properties.\n *\n * The `updateContact()` function returns a Promise that resolves\n * when the specified contact's information is updated.\n *\n * > **Note:**\n * > This function replaces the deprecated\n * > `wixCrmBackend.updateContact()`.\n * > The deprecated function will continue to work, but it will not receive updates.\n * > To keep any existing code compatible with future changes, see the\n * > [migration instructions](wix-crm-backend/updatecontact#migration-instructions).\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 * \n * @param contactId - ID of the contact to update.\n * @param revision - Revision number.\n * When updating, include the existing `revision`\n * to prevent conflicting updates.\n * @public\n * @documentationMaturity preview\n * @requiredField contactId\n * @requiredField options\n * @requiredField options.info\n * @requiredField revision\n * @param options - Contact update options.\n * @returns Updated contact.\n */\n function updateContact(contactId: string, revision: number | null, options: UpdateContactOptions): Promise;\n interface UpdateContactOptions {\n /**\n * Controls whether the call will succeed if the new contact information contains an email already used by another contact.\n *\n * If set to `true`, the call will succeed even if an email address is used by another contact. If set to `false`, the call will fail if an email address is used by another contact.\n *\n * Defaults to `false`.\n */\n allowDuplicates?: boolean;\n /** Contact info. */\n info: ContactInfo;\n /**\n * Set of fields to update.\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * See\n * [Field Masks in Update Requests](https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests)\n * for details on working with field masks.\n *\n * > **Deprecation Notice:**\n * > This parameter will be removed on March 31, 2022.\n * > If your app uses this parameter, update your code as soon as possible.\n */\n fieldMask?: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Merges source contacts into a target contact.\n *\n * Merging contacts has these effects on the target contact:\n *\n * - No target contact data is overwritten or deleted.\n * - Arrays (emails, phones, addresses, and labels) are merged from the source contacts.\n * - If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.\n *\n *
\n *\n * __Important:__\n * Merges cannot be undone.\n * Use [Preview Merge Contacts](#preview-merge-contacts)\n * to test before merging.\n *\n *
\n *\n * Source contacts are deleted when merging.\n * However, if a source contact is a site member or contributor,\n * the merge fails because site contributors and members can't be deleted.\n * Site members and contributors can be target contacts only.\n *\n * After merging,\n * if you call [Get Contact](#get-contact) with a deleted source contact ID,\n * the target contact ID is returned.\n * This is supported when calling Get Contact only.\n * Deleted source contact IDs are not supported on any other endpoint.\n *\n * Merging contacts triggers these webhooks:\n *\n * - [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.\n * - [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.\n * - [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) 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 passed.\n * @public\n * @documentationMaturity preview\n * @requiredField targetContactId\n * @requiredField targetContactRevision\n * @param options - Merge contacts options.\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 * If merging more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Previews merging source contacts into a target contact.\n *\n * This endpoint performs a dry run without deleting or updating any contacts.\n * A preview of the updated target contact is returned,\n * but no data is changed in the Contact List.\n *\n * To perform the actual merge, use [Merge Contacts](#merge-contacts).\n * @param targetContactId - Target contact ID.\n * @public\n * @documentationMaturity preview\n * @requiredField targetContactId\n * @param options - Preview merge contacts options.\n */\n function previewMergeContacts(targetContactId: string, options?: PreviewMergeContactsOptions): Promise;\n interface PreviewMergeContactsOptions {\n /**\n * IDs of up to 5 contacts to merge into the target contact.\n * If merging more than one source contact,\n * the first source is given precedence, then the second, and so on.\n */\n sourceContactIds?: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Deletes a contact who is not a site member or contributor.\n *\n * The `deleteContact()` function returns a Promise\n * that resolves when the specified contact is deleted.\n * > **Note:**\n * > This function replaces the deprecated\n * > `wixCrmBackend.deleteContact()`.\n * > The deprecated function will continue to work, but it will not receive updates.\n * > To keep any existing code compatible with future changes, see the\n * > [migration instructions](wix-crm-backend/deletecontact#migration-instructions).\n *\n * Deleting a contact permanently removes them from your Contact List.\n *\n * If the contact is also a site member,\n * the member must be deleted first,\n * and then the contact can be deleted.\n *\n * \n * @param contactId - ID of the contact to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField contactId\n */\n function deleteContact(contactId: string): Promise;\n /**\n * Adds labels to a contact.\n *\n *\n * The `labelContact()` function returns a Promise\n * that resolves when the specified labels are added to the contact.\n * - **To create new labels:** Use [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel).\n * - **To find labels:** Use [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel), [`getLabel()`](wix-crm-backend/contacts/getlabel), or [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n *\n * \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 * Contact labels can be created or retrieved with\n * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n * @public\n * @documentationMaturity preview\n * @requiredField contactId\n * @requiredField labelKeys\n * @returns Updated contact.\n */\n function labelContact(contactId: string, labelKeys: string[], options?: LabelContactOptions): Promise;\n interface LabelContactOptions {\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Removes labels from a contact.\n *\n * The `unlabelContact()` function returns a Promise\n * that resolves when the specified labels are removed from the contact.\n *\n * If a label is no longer needed\n * and you want to remove it from all contacts,\n * you can delete it with\n * [`deleteLabel()`](wix-crm-backend/contacts/deletelabel).\n *\n * \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 * @documentationMaturity preview\n * @requiredField contactId\n * @requiredField labelKeys\n * @returns Updated contact.\n */\n function unlabelContact(contactId: string, labelKeys: string[], options?: UnlabelContactOptions): Promise;\n interface UnlabelContactOptions {\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Adds and removes labels from a contact.\n * The requested labels must already exist for the site.\n * To create new labels, use\n * [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\n * (in the Contact Labels API) before running this request.\n * @param contactId - Contact ID.\n * @param labelKeysToAdd - 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 * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n * @internal\n * @documentationMaturity preview\n * @requiredField contactId\n * @requiredField labelKeysToAdd\n * @requiredField options\n * @requiredField options.labelKeysToRemove\n */\n function labelAndUnlabelContact(contactId: string, labelKeysToAdd: string[], options: LabelAndUnlabelContactOptions): Promise;\n interface LabelAndUnlabelContactOptions {\n /** List of label keys to remove from the contact. */\n labelKeysToRemove: string[];\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Retrieves a list of up to 1,000 contacts per request.\n * @public\n * @documentationMaturity preview\n * @param options - Object containing list of options for retrieving contacts.\n * @returns List of contacts.\n */\n function listContacts(options?: ListContactsOptions): Promise;\n interface ListContactsOptions {\n /** Sort order. */\n sort?: Sorting;\n /** Pagination, defaults to offset = 0 and limit = 50 (max limit 1,000). */\n paging?: Paging;\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 * Language for localization.\n * @internal\n */\n language?: string | null;\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\n * and returns a\n * [`ContactsQueryBuilder`](wix-crm-backend/contacts/contactsquerybuilder)\n * object.\n *\n * The returned object contains the query definition,\n * which is typically used to run the query using the\n * [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find)\n * function.\n *\n * You can refine the query\n * by chaining `ContactsQueryBuilder` functions onto the query.\n * `ContactsQueryBuilder` functions enable you to sort, filter,\n * and control the results `queryContacts()` returns.\n *\n * `queryContacts()` runs with these `ContactsQueryBuilder` defaults,\n * which you can override:\n *\n * - [`skip(0)`](wix-crm-backend/contacts/contactsquerybuilder/skip)\n * - [`limit(50)`](wix-crm-backend/contacts/contactsquerybuilder/limit)\n * - [`descending(\"_createdDate\")`](wix-crm-backend/contacts/contactsquerybuilder/descending)\n *\n * The functions that are chained to `queryContacts()`\n * are applied in the order they are called.\n * For example, if you apply `ascending('info.company')`\n * and then `descending('info.name.last')`,\n * the results are sorted first by the company name, and then,\n * if there are multiple results with the same company,\n * the items are sorted by last name.\n *\n * \n *\n * For property support for filters and sorting, see\n * [Query contacts: Supported filters, sorting, and search](wix-crm-backend/contacts/sort-and-filter#query-contacts-supported-filters,-sorting,-and-search).\n *\n * @public\n * @documentationMaturity preview\n * @param options - Query contact options.\n * @returns List of contacts.\n */\n function queryContacts(options?: QueryContactsOptions): Promise;\n interface QueryContactsOptions {\n /**\n * Plain text search for an exact match.\n *\n * Supported properties:\n * `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`\n *\n * Max: 100 characters\n */\n search?: string | null;\n /** Query options. */\n query?: Query;\n /**\n * Whether to calculate the total count the number of contacts\n * @internal\n */\n omitTotal?: boolean | null;\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /**\n * Lists facets from the site’s Contact List.\n * Facets are labels and subscription statuses.\n * Each facet returns its details (such as `key` and `value`),\n * as well as aggregated `count` of the number of contacts\n * the facet applies to.\n * @public\n * @documentationMaturity preview\n * @param options - List facets options.\n */\n function listFacets(options?: ListFacetsOptions): Promise;\n interface ListFacetsOptions {\n /** Allow paginating, default: offset = 0 and limit = 1000 */\n paging?: Paging;\n /** Language for localization */\n language?: string | null;\n /**\n * Wheter to count the number of contacts per facet\n * @internal\n */\n omitCount?: boolean;\n }\n /**\n * Retrieves facets from the site’s Contact List by filter.\n * Facets are labels and subscription statuses.\n * Each facet returns its details (such as `key` and `value`),\n * as well as aggregated `count` of the number of contacts\n * the facet applies to.\n * @public\n * @documentationMaturity preview\n * @param options - Query facets options.\n */\n function queryFacets(options?: QueryFacetsOptions): Promise;\n interface QueryFacetsOptions {\n /** Allow paginating, default: offset = 0 and limit = 1000 */\n paging?: Paging;\n /** Language for localization */\n language?: string | null;\n /**\n * Wheter to count the number of contacts per facet\n * @internal\n */\n omitCount?: boolean;\n /**\n * Only allowed fields:\n * #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)\n * #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)\n * #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in)\n */\n filter?: Record | null;\n }\n /**\n * Deletes multiple contacts.\n *\n * All contacts that meet the specified `filter` and `search` criteria are deleted.\n * The request should contain a `filter` value or a `search` value, or both.\n * To perform a dry run, use the intended filter options with\n * [Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n *\n * When this endpoint is used, a bulk job is started and the job ID is returned.\n * The job might not complete right away, depending on its size.\n * The job's status can be retrieved with\n * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n * @public\n * @documentationMaturity preview\n * @param options - Bulk delete contacts options.\n */\n function bulkDeleteContacts(options?: BulkDeleteContactsOptions): Promise;\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 * For a detailed list of supported filters, see\n * filtering and sorting for\n * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\n * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\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 /**\n * Updates the specified properties for multiple contacts.\n * Fields that are included in fieldMask.paths are updated,\n * while all other fields stay the same.\n *\n * All contacts that meet the specified `filter` and `search` criteria are updated.\n * To perform a dry run, use the intended filter options with\n * [Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n *\n * When this endpoint is used, a bulk job is started and the job ID is returned.\n * The job may not complete right away, depending on its size.\n * The job's status can be retrieved with\n * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n * @public\n * @documentationMaturity preview\n * @param options - Bulk update contacts options.\n */\n function bulkUpdateContacts(options?: BulkUpdateContactsOptions): Promise;\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 * For a detailed list of supported filters, see\n * filtering and sorting for\n * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\n * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\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 * Set of fields to update.\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * See\n * [Field Masks in Update Requests](https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests)\n * for details on working with field masks.\n *\n * > **Deprecation Notice:**\n * > This parameter will be removed on March 31, 2022.\n * > If your app uses this parameter, update your code as soon as possible.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Adds and removes labels from multiple contacts.\n *\n * Labels are added to and removed from all contacts that meet the specified\n * `filter` and `search` criteria.\n * The request should contain a `filter` value or a `search` value, or both. To perform a dry run, use the intended filter options with\n * [Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n *\n * When this endpoint is used, a bulk job is started and the job ID is returned.\n * The job might not not complete right away, depending on its size.\n * The job's status can be retrieved with\n * [Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n * [List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n * @public\n * @documentationMaturity preview\n * @param options - Bulk label and unlabel contacts options.\n */\n function bulkLabelAndUnlabelContacts(options?: BulkLabelAndUnlabelContactsOptions): Promise;\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/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\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/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\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 * [`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\n * or\n * [`queryLabels()`](wix-crm-backend/contacts/queryLabels).\n */\n labelKeysToAdd?: string[];\n /** List of label keys to remove from the contacts. */\n labelKeysToRemove?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n */\n function bulkUpsertContacts(options?: BulkUpsertContactsOptions): Promise;\n interface BulkUpsertContactsOptions {\n info?: ContactInfo[];\n returnFullEntity?: boolean;\n }\n /**\n * Update the requested contact, when found by given email and/or phone, otherwise create the contact.\n * @internal\n * @documentationMaturity preview\n * @requiredField info\n */\n function upsertContact(info: ContactInfo): Promise;\n /**\n * Generates an URL that can be used to upload a contact picture\n * @param contactId - ID of the contact whose picture is being updated.\n * @internal\n * @documentationMaturity preview\n * @requiredField contactId\n */\n function generatePictureUploadUrl(contactId: string, options?: GeneratePictureUploadUrlOptions): Promise;\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 *\n * The `getContact()` function returns a Promise\n * that resolves when the contact is found.\n * #### Getting Merged Contacts\n * When a source contact is merged\n * with a target contact, the source contact is deleted.\n * When calling `getContact()` for a merged contact,\n * you can use the source or target contact ID.\n * In both cases, the target contact is returned.\n *\n * This is supported only when calling `getContact()`,\n * and only for merged contacts.\n * Deleted source contact IDs are not supported on any other function.\n * > **Notes:**\n * >\n * > - This function replaces the deprecated\n * > `wixCrmBackend.getContactById()`.\n * > The deprecated function will continue to work, but it will not receive updates.\n * > To keep any existing code compatible with future changes, see the\n * > [migration instructions](wix-crm-backend/getcontactbyid#migration-instructions).\n * \n * @param _id - ID of the contact to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @param options - Get contact options.\n * @returns The requested contact.\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 * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n */\n function countContacts(): Promise;\n /**\n * Retrieves a list of contacts, given the provided cursorPaging, [filtering, and sorting](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching).\n * Up to 1,000 contacts can be returned per request.\n *\n * For a detailed list of supported operations, see\n * filtering and sorting for\n * [contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n * [extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\n * and [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\n * To learn how to query contacts, see\n * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * @internal\n * @documentationMaturity preview\n */\n function searchContacts(options?: SearchContactsOptions): Promise;\n interface SearchContactsOptions {\n /** Search object. Encapsulates filter, sorting, paging and other details */\n search?: Search;\n /**\n * Language for localization.\n * @internal\n */\n language?: string | null;\n }\n \n const contactsV4Contact_universal_d___debug: typeof __debug;\n type contactsV4Contact_universal_d_Contact = Contact;\n type contactsV4Contact_universal_d_ContactSource = ContactSource;\n type contactsV4Contact_universal_d_ContactSourceType = ContactSourceType;\n const contactsV4Contact_universal_d_ContactSourceType: typeof ContactSourceType;\n type contactsV4Contact_universal_d_ContactActivity = ContactActivity;\n type contactsV4Contact_universal_d_ContactActivityType = ContactActivityType;\n const contactsV4Contact_universal_d_ContactActivityType: typeof ContactActivityType;\n type contactsV4Contact_universal_d_PrimaryContactInfo = PrimaryContactInfo;\n type contactsV4Contact_universal_d_ContactInfo = ContactInfo;\n type contactsV4Contact_universal_d_ContactName = ContactName;\n type contactsV4Contact_universal_d_ContactEmailsWrapper = ContactEmailsWrapper;\n type contactsV4Contact_universal_d_ContactEmail = ContactEmail;\n type contactsV4Contact_universal_d_EmailTag = EmailTag;\n const contactsV4Contact_universal_d_EmailTag: typeof EmailTag;\n type contactsV4Contact_universal_d_ContactPhonesWrapper = ContactPhonesWrapper;\n type contactsV4Contact_universal_d_ContactPhone = ContactPhone;\n type contactsV4Contact_universal_d_PhoneTag = PhoneTag;\n const contactsV4Contact_universal_d_PhoneTag: typeof PhoneTag;\n type contactsV4Contact_universal_d_ContactAddressesWrapper = ContactAddressesWrapper;\n type contactsV4Contact_universal_d_ContactAddress = ContactAddress;\n type contactsV4Contact_universal_d_AddressTag = AddressTag;\n const contactsV4Contact_universal_d_AddressTag: typeof AddressTag;\n type contactsV4Contact_universal_d_Address = Address;\n type contactsV4Contact_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type contactsV4Contact_universal_d_StreetAddress = StreetAddress;\n type contactsV4Contact_universal_d_AddressLocation = AddressLocation;\n type contactsV4Contact_universal_d_Subdivision = Subdivision;\n type contactsV4Contact_universal_d_SubdivisionType = SubdivisionType;\n const contactsV4Contact_universal_d_SubdivisionType: typeof SubdivisionType;\n type contactsV4Contact_universal_d_AssigneesWrapper = AssigneesWrapper;\n type contactsV4Contact_universal_d_LabelsWrapper = LabelsWrapper;\n type contactsV4Contact_universal_d_ExtendedFieldsWrapper = ExtendedFieldsWrapper;\n type contactsV4Contact_universal_d_LocationsWrapper = LocationsWrapper;\n type contactsV4Contact_universal_d_ContactPicture = ContactPicture;\n type contactsV4Contact_universal_d_ImageProvider = ImageProvider;\n const contactsV4Contact_universal_d_ImageProvider: typeof ImageProvider;\n type contactsV4Contact_universal_d_SegmentsWrapper = SegmentsWrapper;\n type contactsV4Contact_universal_d_EstimateFilterSizeRequest = EstimateFilterSizeRequest;\n type contactsV4Contact_universal_d_EstimateFilterSizeResponse = EstimateFilterSizeResponse;\n type contactsV4Contact_universal_d_EstimateAudienceSizeRequest = EstimateAudienceSizeRequest;\n type contactsV4Contact_universal_d_EstimateAudienceSizeResponse = EstimateAudienceSizeResponse;\n type contactsV4Contact_universal_d_ContactSubmitted = ContactSubmitted;\n type contactsV4Contact_universal_d_ContactChanged = ContactChanged;\n type contactsV4Contact_universal_d_CreateContactRequest = CreateContactRequest;\n type contactsV4Contact_universal_d_CreateContactResponse = CreateContactResponse;\n type contactsV4Contact_universal_d_DuplicateContactExists = DuplicateContactExists;\n type contactsV4Contact_universal_d_UpdateContactRequest = UpdateContactRequest;\n type contactsV4Contact_universal_d_UpdateContactResponse = UpdateContactResponse;\n type contactsV4Contact_universal_d_MergeContactsRequest = MergeContactsRequest;\n type contactsV4Contact_universal_d_MergeContactsResponse = MergeContactsResponse;\n type contactsV4Contact_universal_d_ContactMerged = ContactMerged;\n type contactsV4Contact_universal_d_PreviewMergeContactsRequest = PreviewMergeContactsRequest;\n type contactsV4Contact_universal_d_PreviewMergeContactsResponse = PreviewMergeContactsResponse;\n type contactsV4Contact_universal_d_DeleteContactRequest = DeleteContactRequest;\n type contactsV4Contact_universal_d_DeleteContactResponse = DeleteContactResponse;\n type contactsV4Contact_universal_d_LabelContactRequest = LabelContactRequest;\n type contactsV4Contact_universal_d_LabelContactResponse = LabelContactResponse;\n type contactsV4Contact_universal_d_UnlabelContactRequest = UnlabelContactRequest;\n type contactsV4Contact_universal_d_UnlabelContactResponse = UnlabelContactResponse;\n type contactsV4Contact_universal_d_LabelAndUnlabelContactRequest = LabelAndUnlabelContactRequest;\n type contactsV4Contact_universal_d_LabelAndUnlabelContactResponse = LabelAndUnlabelContactResponse;\n type contactsV4Contact_universal_d_ListContactsRequest = ListContactsRequest;\n type contactsV4Contact_universal_d_Sorting = Sorting;\n type contactsV4Contact_universal_d_SortOrder = SortOrder;\n const contactsV4Contact_universal_d_SortOrder: typeof SortOrder;\n type contactsV4Contact_universal_d_Paging = Paging;\n type contactsV4Contact_universal_d_ContactFieldSet = ContactFieldSet;\n const contactsV4Contact_universal_d_ContactFieldSet: typeof ContactFieldSet;\n type contactsV4Contact_universal_d_ListContactsResponse = ListContactsResponse;\n type contactsV4Contact_universal_d_PagingMetadata = PagingMetadata;\n type contactsV4Contact_universal_d_QueryContactsRequest = QueryContactsRequest;\n type contactsV4Contact_universal_d_Query = Query;\n type contactsV4Contact_universal_d_QueryContactsResponse = QueryContactsResponse;\n type contactsV4Contact_universal_d_ListFacetsRequest = ListFacetsRequest;\n type contactsV4Contact_universal_d_ListFacetsResponse = ListFacetsResponse;\n type contactsV4Contact_universal_d_ContactsFacet = ContactsFacet;\n type contactsV4Contact_universal_d_ContactsFacetType = ContactsFacetType;\n const contactsV4Contact_universal_d_ContactsFacetType: typeof ContactsFacetType;\n type contactsV4Contact_universal_d_QueryFacetsRequest = QueryFacetsRequest;\n type contactsV4Contact_universal_d_QueryFacetsResponse = QueryFacetsResponse;\n type contactsV4Contact_universal_d_BulkDeleteContactsRequest = BulkDeleteContactsRequest;\n type contactsV4Contact_universal_d_BulkDeleteContactsResponse = BulkDeleteContactsResponse;\n type contactsV4Contact_universal_d_BulkUpdateContactsRequest = BulkUpdateContactsRequest;\n type contactsV4Contact_universal_d_BulkUpdateContactsResponse = BulkUpdateContactsResponse;\n type contactsV4Contact_universal_d_BulkLabelAndUnlabelContactsRequest = BulkLabelAndUnlabelContactsRequest;\n type contactsV4Contact_universal_d_BulkLabelAndUnlabelContactsResponse = BulkLabelAndUnlabelContactsResponse;\n type contactsV4Contact_universal_d_BulkUpsertContactsRequest = BulkUpsertContactsRequest;\n type contactsV4Contact_universal_d_BulkUpsertContactsResponse = BulkUpsertContactsResponse;\n type contactsV4Contact_universal_d_Action = Action;\n const contactsV4Contact_universal_d_Action: typeof Action;\n type contactsV4Contact_universal_d_Error = Error;\n type contactsV4Contact_universal_d_Metadata = Metadata;\n type contactsV4Contact_universal_d_Item = Item;\n type contactsV4Contact_universal_d_BulkUpsertContactsResponseMetadata = BulkUpsertContactsResponseMetadata;\n type contactsV4Contact_universal_d_UpsertContactRequest = UpsertContactRequest;\n type contactsV4Contact_universal_d_UpsertContactResponse = UpsertContactResponse;\n type contactsV4Contact_universal_d_UpsertContactResponseAction = UpsertContactResponseAction;\n const contactsV4Contact_universal_d_UpsertContactResponseAction: typeof UpsertContactResponseAction;\n type contactsV4Contact_universal_d_GeneratePictureUploadUrlRequest = GeneratePictureUploadUrlRequest;\n type contactsV4Contact_universal_d_GeneratePictureUploadUrlResponse = GeneratePictureUploadUrlResponse;\n type contactsV4Contact_universal_d_GetContactRequest = GetContactRequest;\n type contactsV4Contact_universal_d_GetContactResponse = GetContactResponse;\n type contactsV4Contact_universal_d_GetContactResponseType = GetContactResponseType;\n const contactsV4Contact_universal_d_GetContactResponseType: typeof GetContactResponseType;\n type contactsV4Contact_universal_d_SyncSubmitContactRequest = SyncSubmitContactRequest;\n type contactsV4Contact_universal_d_SubmitOperation = SubmitOperation;\n const contactsV4Contact_universal_d_SubmitOperation: typeof SubmitOperation;\n type contactsV4Contact_universal_d_SyncSubmitContactResponse = SyncSubmitContactResponse;\n type contactsV4Contact_universal_d_CountContactsRequest = CountContactsRequest;\n type contactsV4Contact_universal_d_CountContactsResponse = CountContactsResponse;\n type contactsV4Contact_universal_d_SearchContactsRequest = SearchContactsRequest;\n type contactsV4Contact_universal_d_Search = Search;\n type contactsV4Contact_universal_d_SearchPagingMethodOneOf = SearchPagingMethodOneOf;\n type contactsV4Contact_universal_d_SearchDetails = SearchDetails;\n type contactsV4Contact_universal_d_Mode = Mode;\n const contactsV4Contact_universal_d_Mode: typeof Mode;\n type contactsV4Contact_universal_d_CursorPaging = CursorPaging;\n type contactsV4Contact_universal_d_SearchContactsResponse = SearchContactsResponse;\n type contactsV4Contact_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type contactsV4Contact_universal_d_Cursors = Cursors;\n type contactsV4Contact_universal_d_BulkAddSegmentToContactsRequest = BulkAddSegmentToContactsRequest;\n type contactsV4Contact_universal_d_BulkAddSegmentToContactsResponse = BulkAddSegmentToContactsResponse;\n type contactsV4Contact_universal_d_ItemMetadata = ItemMetadata;\n type contactsV4Contact_universal_d_ApplicationError = ApplicationError;\n type contactsV4Contact_universal_d_BulkActionMetadata = BulkActionMetadata;\n type contactsV4Contact_universal_d_ContactAddedToSegment = ContactAddedToSegment;\n type contactsV4Contact_universal_d_BulkRemoveSegmentFromContactsRequest = BulkRemoveSegmentFromContactsRequest;\n type contactsV4Contact_universal_d_BulkRemoveSegmentFromContactsResponse = BulkRemoveSegmentFromContactsResponse;\n type contactsV4Contact_universal_d_ContactRemovedFromSegment = ContactRemovedFromSegment;\n const contactsV4Contact_universal_d_estimateFilterSize: typeof estimateFilterSize;\n type contactsV4Contact_universal_d_EstimateFilterSizeOptions = EstimateFilterSizeOptions;\n const contactsV4Contact_universal_d_estimateAudienceSize: typeof estimateAudienceSize;\n type contactsV4Contact_universal_d_EstimateAudienceSizeOptions = EstimateAudienceSizeOptions;\n const contactsV4Contact_universal_d_createContact: typeof createContact;\n type contactsV4Contact_universal_d_CreateContactOptions = CreateContactOptions;\n const contactsV4Contact_universal_d_updateContact: typeof updateContact;\n type contactsV4Contact_universal_d_UpdateContactOptions = UpdateContactOptions;\n const contactsV4Contact_universal_d_mergeContacts: typeof mergeContacts;\n type contactsV4Contact_universal_d_MergeContactsOptions = MergeContactsOptions;\n const contactsV4Contact_universal_d_previewMergeContacts: typeof previewMergeContacts;\n type contactsV4Contact_universal_d_PreviewMergeContactsOptions = PreviewMergeContactsOptions;\n const contactsV4Contact_universal_d_deleteContact: typeof deleteContact;\n const contactsV4Contact_universal_d_labelContact: typeof labelContact;\n type contactsV4Contact_universal_d_LabelContactOptions = LabelContactOptions;\n const contactsV4Contact_universal_d_unlabelContact: typeof unlabelContact;\n type contactsV4Contact_universal_d_UnlabelContactOptions = UnlabelContactOptions;\n const contactsV4Contact_universal_d_labelAndUnlabelContact: typeof labelAndUnlabelContact;\n type contactsV4Contact_universal_d_LabelAndUnlabelContactOptions = LabelAndUnlabelContactOptions;\n const contactsV4Contact_universal_d_listContacts: typeof listContacts;\n type contactsV4Contact_universal_d_ListContactsOptions = ListContactsOptions;\n const contactsV4Contact_universal_d_queryContacts: typeof queryContacts;\n type contactsV4Contact_universal_d_QueryContactsOptions = QueryContactsOptions;\n const contactsV4Contact_universal_d_listFacets: typeof listFacets;\n type contactsV4Contact_universal_d_ListFacetsOptions = ListFacetsOptions;\n const contactsV4Contact_universal_d_queryFacets: typeof queryFacets;\n type contactsV4Contact_universal_d_QueryFacetsOptions = QueryFacetsOptions;\n const contactsV4Contact_universal_d_bulkDeleteContacts: typeof bulkDeleteContacts;\n type contactsV4Contact_universal_d_BulkDeleteContactsOptions = BulkDeleteContactsOptions;\n const contactsV4Contact_universal_d_bulkUpdateContacts: typeof bulkUpdateContacts;\n type contactsV4Contact_universal_d_BulkUpdateContactsOptions = BulkUpdateContactsOptions;\n const contactsV4Contact_universal_d_bulkLabelAndUnlabelContacts: typeof bulkLabelAndUnlabelContacts;\n type contactsV4Contact_universal_d_BulkLabelAndUnlabelContactsOptions = BulkLabelAndUnlabelContactsOptions;\n const contactsV4Contact_universal_d_bulkUpsertContacts: typeof bulkUpsertContacts;\n type contactsV4Contact_universal_d_BulkUpsertContactsOptions = BulkUpsertContactsOptions;\n const contactsV4Contact_universal_d_upsertContact: typeof upsertContact;\n const contactsV4Contact_universal_d_generatePictureUploadUrl: typeof generatePictureUploadUrl;\n type contactsV4Contact_universal_d_GeneratePictureUploadUrlOptions = GeneratePictureUploadUrlOptions;\n const contactsV4Contact_universal_d_getContact: typeof getContact;\n type contactsV4Contact_universal_d_GetContactOptions = GetContactOptions;\n const contactsV4Contact_universal_d_countContacts: typeof countContacts;\n const contactsV4Contact_universal_d_searchContacts: typeof searchContacts;\n type contactsV4Contact_universal_d_SearchContactsOptions = SearchContactsOptions;\n namespace contactsV4Contact_universal_d {\n export {\n contactsV4Contact_universal_d___debug as __debug,\n contactsV4Contact_universal_d_Contact as Contact,\n contactsV4Contact_universal_d_ContactSource as ContactSource,\n contactsV4Contact_universal_d_ContactSourceType as ContactSourceType,\n contactsV4Contact_universal_d_ContactActivity as ContactActivity,\n contactsV4Contact_universal_d_ContactActivityType as ContactActivityType,\n contactsV4Contact_universal_d_PrimaryContactInfo as PrimaryContactInfo,\n contactsV4Contact_universal_d_ContactInfo as ContactInfo,\n contactsV4Contact_universal_d_ContactName as ContactName,\n contactsV4Contact_universal_d_ContactEmailsWrapper as ContactEmailsWrapper,\n contactsV4Contact_universal_d_ContactEmail as ContactEmail,\n contactsV4Contact_universal_d_EmailTag as EmailTag,\n contactsV4Contact_universal_d_ContactPhonesWrapper as ContactPhonesWrapper,\n contactsV4Contact_universal_d_ContactPhone as ContactPhone,\n contactsV4Contact_universal_d_PhoneTag as PhoneTag,\n contactsV4Contact_universal_d_ContactAddressesWrapper as ContactAddressesWrapper,\n contactsV4Contact_universal_d_ContactAddress as ContactAddress,\n contactsV4Contact_universal_d_AddressTag as AddressTag,\n contactsV4Contact_universal_d_Address as Address,\n contactsV4Contact_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n contactsV4Contact_universal_d_StreetAddress as StreetAddress,\n contactsV4Contact_universal_d_AddressLocation as AddressLocation,\n contactsV4Contact_universal_d_Subdivision as Subdivision,\n contactsV4Contact_universal_d_SubdivisionType as SubdivisionType,\n contactsV4Contact_universal_d_AssigneesWrapper as AssigneesWrapper,\n contactsV4Contact_universal_d_LabelsWrapper as LabelsWrapper,\n contactsV4Contact_universal_d_ExtendedFieldsWrapper as ExtendedFieldsWrapper,\n contactsV4Contact_universal_d_LocationsWrapper as LocationsWrapper,\n contactsV4Contact_universal_d_ContactPicture as ContactPicture,\n contactsV4Contact_universal_d_ImageProvider as ImageProvider,\n contactsV4Contact_universal_d_SegmentsWrapper as SegmentsWrapper,\n contactsV4Contact_universal_d_EstimateFilterSizeRequest as EstimateFilterSizeRequest,\n contactsV4Contact_universal_d_EstimateFilterSizeResponse as EstimateFilterSizeResponse,\n contactsV4Contact_universal_d_EstimateAudienceSizeRequest as EstimateAudienceSizeRequest,\n contactsV4Contact_universal_d_EstimateAudienceSizeResponse as EstimateAudienceSizeResponse,\n contactsV4Contact_universal_d_ContactSubmitted as ContactSubmitted,\n contactsV4Contact_universal_d_ContactChanged as ContactChanged,\n contactsV4Contact_universal_d_CreateContactRequest as CreateContactRequest,\n contactsV4Contact_universal_d_CreateContactResponse as CreateContactResponse,\n contactsV4Contact_universal_d_DuplicateContactExists as DuplicateContactExists,\n contactsV4Contact_universal_d_UpdateContactRequest as UpdateContactRequest,\n contactsV4Contact_universal_d_UpdateContactResponse as UpdateContactResponse,\n contactsV4Contact_universal_d_MergeContactsRequest as MergeContactsRequest,\n contactsV4Contact_universal_d_MergeContactsResponse as MergeContactsResponse,\n contactsV4Contact_universal_d_ContactMerged as ContactMerged,\n contactsV4Contact_universal_d_PreviewMergeContactsRequest as PreviewMergeContactsRequest,\n contactsV4Contact_universal_d_PreviewMergeContactsResponse as PreviewMergeContactsResponse,\n contactsV4Contact_universal_d_DeleteContactRequest as DeleteContactRequest,\n contactsV4Contact_universal_d_DeleteContactResponse as DeleteContactResponse,\n contactsV4Contact_universal_d_LabelContactRequest as LabelContactRequest,\n contactsV4Contact_universal_d_LabelContactResponse as LabelContactResponse,\n contactsV4Contact_universal_d_UnlabelContactRequest as UnlabelContactRequest,\n contactsV4Contact_universal_d_UnlabelContactResponse as UnlabelContactResponse,\n contactsV4Contact_universal_d_LabelAndUnlabelContactRequest as LabelAndUnlabelContactRequest,\n contactsV4Contact_universal_d_LabelAndUnlabelContactResponse as LabelAndUnlabelContactResponse,\n contactsV4Contact_universal_d_ListContactsRequest as ListContactsRequest,\n contactsV4Contact_universal_d_Sorting as Sorting,\n contactsV4Contact_universal_d_SortOrder as SortOrder,\n contactsV4Contact_universal_d_Paging as Paging,\n contactsV4Contact_universal_d_ContactFieldSet as ContactFieldSet,\n contactsV4Contact_universal_d_ListContactsResponse as ListContactsResponse,\n contactsV4Contact_universal_d_PagingMetadata as PagingMetadata,\n contactsV4Contact_universal_d_QueryContactsRequest as QueryContactsRequest,\n contactsV4Contact_universal_d_Query as Query,\n contactsV4Contact_universal_d_QueryContactsResponse as QueryContactsResponse,\n contactsV4Contact_universal_d_ListFacetsRequest as ListFacetsRequest,\n contactsV4Contact_universal_d_ListFacetsResponse as ListFacetsResponse,\n contactsV4Contact_universal_d_ContactsFacet as ContactsFacet,\n contactsV4Contact_universal_d_ContactsFacetType as ContactsFacetType,\n contactsV4Contact_universal_d_QueryFacetsRequest as QueryFacetsRequest,\n contactsV4Contact_universal_d_QueryFacetsResponse as QueryFacetsResponse,\n contactsV4Contact_universal_d_BulkDeleteContactsRequest as BulkDeleteContactsRequest,\n contactsV4Contact_universal_d_BulkDeleteContactsResponse as BulkDeleteContactsResponse,\n contactsV4Contact_universal_d_BulkUpdateContactsRequest as BulkUpdateContactsRequest,\n contactsV4Contact_universal_d_BulkUpdateContactsResponse as BulkUpdateContactsResponse,\n contactsV4Contact_universal_d_BulkLabelAndUnlabelContactsRequest as BulkLabelAndUnlabelContactsRequest,\n contactsV4Contact_universal_d_BulkLabelAndUnlabelContactsResponse as BulkLabelAndUnlabelContactsResponse,\n contactsV4Contact_universal_d_BulkUpsertContactsRequest as BulkUpsertContactsRequest,\n contactsV4Contact_universal_d_BulkUpsertContactsResponse as BulkUpsertContactsResponse,\n contactsV4Contact_universal_d_Action as Action,\n contactsV4Contact_universal_d_Error as Error,\n contactsV4Contact_universal_d_Metadata as Metadata,\n contactsV4Contact_universal_d_Item as Item,\n contactsV4Contact_universal_d_BulkUpsertContactsResponseMetadata as BulkUpsertContactsResponseMetadata,\n contactsV4Contact_universal_d_UpsertContactRequest as UpsertContactRequest,\n contactsV4Contact_universal_d_UpsertContactResponse as UpsertContactResponse,\n contactsV4Contact_universal_d_UpsertContactResponseAction as UpsertContactResponseAction,\n contactsV4Contact_universal_d_GeneratePictureUploadUrlRequest as GeneratePictureUploadUrlRequest,\n contactsV4Contact_universal_d_GeneratePictureUploadUrlResponse as GeneratePictureUploadUrlResponse,\n contactsV4Contact_universal_d_GetContactRequest as GetContactRequest,\n contactsV4Contact_universal_d_GetContactResponse as GetContactResponse,\n contactsV4Contact_universal_d_GetContactResponseType as GetContactResponseType,\n contactsV4Contact_universal_d_SyncSubmitContactRequest as SyncSubmitContactRequest,\n contactsV4Contact_universal_d_SubmitOperation as SubmitOperation,\n contactsV4Contact_universal_d_SyncSubmitContactResponse as SyncSubmitContactResponse,\n contactsV4Contact_universal_d_CountContactsRequest as CountContactsRequest,\n contactsV4Contact_universal_d_CountContactsResponse as CountContactsResponse,\n contactsV4Contact_universal_d_SearchContactsRequest as SearchContactsRequest,\n contactsV4Contact_universal_d_Search as Search,\n contactsV4Contact_universal_d_SearchPagingMethodOneOf as SearchPagingMethodOneOf,\n contactsV4Contact_universal_d_SearchDetails as SearchDetails,\n contactsV4Contact_universal_d_Mode as Mode,\n contactsV4Contact_universal_d_CursorPaging as CursorPaging,\n contactsV4Contact_universal_d_SearchContactsResponse as SearchContactsResponse,\n contactsV4Contact_universal_d_PagingMetadataV2 as PagingMetadataV2,\n contactsV4Contact_universal_d_Cursors as Cursors,\n contactsV4Contact_universal_d_BulkAddSegmentToContactsRequest as BulkAddSegmentToContactsRequest,\n contactsV4Contact_universal_d_BulkAddSegmentToContactsResponse as BulkAddSegmentToContactsResponse,\n contactsV4Contact_universal_d_ItemMetadata as ItemMetadata,\n contactsV4Contact_universal_d_ApplicationError as ApplicationError,\n contactsV4Contact_universal_d_BulkActionMetadata as BulkActionMetadata,\n contactsV4Contact_universal_d_ContactAddedToSegment as ContactAddedToSegment,\n contactsV4Contact_universal_d_BulkRemoveSegmentFromContactsRequest as BulkRemoveSegmentFromContactsRequest,\n contactsV4Contact_universal_d_BulkRemoveSegmentFromContactsResponse as BulkRemoveSegmentFromContactsResponse,\n contactsV4Contact_universal_d_ContactRemovedFromSegment as ContactRemovedFromSegment,\n contactsV4Contact_universal_d_estimateFilterSize as estimateFilterSize,\n contactsV4Contact_universal_d_EstimateFilterSizeOptions as EstimateFilterSizeOptions,\n contactsV4Contact_universal_d_estimateAudienceSize as estimateAudienceSize,\n contactsV4Contact_universal_d_EstimateAudienceSizeOptions as EstimateAudienceSizeOptions,\n contactsV4Contact_universal_d_createContact as createContact,\n contactsV4Contact_universal_d_CreateContactOptions as CreateContactOptions,\n contactsV4Contact_universal_d_updateContact as updateContact,\n contactsV4Contact_universal_d_UpdateContactOptions as UpdateContactOptions,\n contactsV4Contact_universal_d_mergeContacts as mergeContacts,\n contactsV4Contact_universal_d_MergeContactsOptions as MergeContactsOptions,\n contactsV4Contact_universal_d_previewMergeContacts as previewMergeContacts,\n contactsV4Contact_universal_d_PreviewMergeContactsOptions as PreviewMergeContactsOptions,\n contactsV4Contact_universal_d_deleteContact as deleteContact,\n contactsV4Contact_universal_d_labelContact as labelContact,\n contactsV4Contact_universal_d_LabelContactOptions as LabelContactOptions,\n contactsV4Contact_universal_d_unlabelContact as unlabelContact,\n contactsV4Contact_universal_d_UnlabelContactOptions as UnlabelContactOptions,\n contactsV4Contact_universal_d_labelAndUnlabelContact as labelAndUnlabelContact,\n contactsV4Contact_universal_d_LabelAndUnlabelContactOptions as LabelAndUnlabelContactOptions,\n contactsV4Contact_universal_d_listContacts as listContacts,\n contactsV4Contact_universal_d_ListContactsOptions as ListContactsOptions,\n contactsV4Contact_universal_d_queryContacts as queryContacts,\n contactsV4Contact_universal_d_QueryContactsOptions as QueryContactsOptions,\n contactsV4Contact_universal_d_listFacets as listFacets,\n contactsV4Contact_universal_d_ListFacetsOptions as ListFacetsOptions,\n contactsV4Contact_universal_d_queryFacets as queryFacets,\n contactsV4Contact_universal_d_QueryFacetsOptions as QueryFacetsOptions,\n contactsV4Contact_universal_d_bulkDeleteContacts as bulkDeleteContacts,\n contactsV4Contact_universal_d_BulkDeleteContactsOptions as BulkDeleteContactsOptions,\n contactsV4Contact_universal_d_bulkUpdateContacts as bulkUpdateContacts,\n contactsV4Contact_universal_d_BulkUpdateContactsOptions as BulkUpdateContactsOptions,\n contactsV4Contact_universal_d_bulkLabelAndUnlabelContacts as bulkLabelAndUnlabelContacts,\n contactsV4Contact_universal_d_BulkLabelAndUnlabelContactsOptions as BulkLabelAndUnlabelContactsOptions,\n contactsV4Contact_universal_d_bulkUpsertContacts as bulkUpsertContacts,\n contactsV4Contact_universal_d_BulkUpsertContactsOptions as BulkUpsertContactsOptions,\n contactsV4Contact_universal_d_upsertContact as upsertContact,\n contactsV4Contact_universal_d_generatePictureUploadUrl as generatePictureUploadUrl,\n contactsV4Contact_universal_d_GeneratePictureUploadUrlOptions as GeneratePictureUploadUrlOptions,\n contactsV4Contact_universal_d_getContact as getContact,\n contactsV4Contact_universal_d_GetContactOptions as GetContactOptions,\n contactsV4Contact_universal_d_countContacts as countContacts,\n contactsV4Contact_universal_d_searchContacts as searchContacts,\n contactsV4Contact_universal_d_SearchContactsOptions as SearchContactsOptions,\n };\n }\n \n export { contactsV4Contact_universal_d as contacts };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-events-backend.v2.d.ts", "content": "declare module \"wix-events-backend.v2\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** Each event can have up to 3 policies - free-text that define terms & conditions, refunds & exchanges and/or other policies, as relevant. */\n interface Policy {\n /**\n * Policy ID. (generated automatically)\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of Policy. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Date policy was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date policy was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Policy name. */\n name?: string;\n /** Policy body. */\n body?: string;\n /** Event ID. */\n eventId?: string;\n }\n interface CreatePolicyRequest {\n /** An Event Policy to be created */\n policy: Policy;\n }\n interface CreatePolicyResponse {\n /** The Event Policy that was created */\n policy?: Policy;\n }\n interface UpdatePolicyRequest {\n /** Event Policy to update */\n policy: Policy;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdatePolicyResponse {\n /** The updated Event 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 /** Event Policy to delete */\n policyId: string;\n /** The revision of the Event Policy */\n revision?: string;\n }\n interface DeletePolicyResponse {\n }\n interface QueryPoliciesRequest {\n /** WQL expression */\n query: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf$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 /** 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 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$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$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 QueryPoliciesResponse {\n /** Event Policies */\n policies?: Policy[];\n /** Query result's 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$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 * @internal\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 ReorderEventPoliciesRequest extends ReorderEventPoliciesRequestReferencePolicyOneOf {\n /** Event ID */\n eventId?: string;\n /** Event Policy ID */\n policyId?: string;\n /** Move the Event Policy Id before this Event Policy ID */\n beforePolicyId?: string;\n /** Move the Event Policy Id after this Event Policy ID */\n afterPolicyId?: string;\n }\n /** @oneof */\n interface ReorderEventPoliciesRequestReferencePolicyOneOf {\n /** Move the Event Policy Id before this Event Policy ID */\n beforePolicyId?: string;\n /** Move the Event Policy Id after this Event Policy ID */\n afterPolicyId?: string;\n }\n interface ReorderEventPoliciesResponse {\n /** Ordered Event Policies */\n policies?: Policy[];\n }\n interface GetEventPoliciesRequest {\n /** Event Id */\n eventId: string;\n }\n interface GetEventPoliciesResponse {\n /** All policies of a particular event */\n policies?: Policy[];\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?: Location;\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 Location {\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?: LocationType;\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 {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationType {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$1 extends AddressStreetOneOf$1 {\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 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 }\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 /** @internal */\n apt?: string;\n }\n interface AddressLocation$1 {\n latitude?: number | null;\n longitude?: number | null;\n }\n interface Subdivision$1 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n /** @internal */\n type?: SubdivisionType$1;\n /** @internal */\n typeInfo?: string | null;\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 {\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;\n }\n interface Recurrences {\n /** Event occurrences. */\n occurrences?: Occurrence[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status;\n }\n interface Occurrence {\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 {\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 Empty$1 {\n }\n /**\n * Creates a policy for an event.\n * Each event can have up to 3 policies.\n * @param policy - An Event Policy to be created\n * @public\n * @requiredField policy\n * @requiredField policy.body\n * @requiredField policy.eventId\n * @requiredField policy.name\n */\n function createPolicy(policy: Policy): Promise;\n /**\n * Updates a policy.\n * @param _id - Policy ID. (generated automatically)\n * @public\n * @requiredField _id\n * @requiredField policy\n * @requiredField policy.body\n * @requiredField policy.eventId\n * @requiredField policy.name\n */\n function updatePolicy(_id: string | null, policy: UpdatePolicy, options?: UpdatePolicyOptions): Promise;\n interface UpdatePolicy {\n /**\n * Policy ID. (generated automatically)\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of Policy. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Date policy was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date policy was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Policy name. */\n name?: string;\n /** Policy body. */\n body?: string;\n /** Event ID. */\n eventId?: string;\n }\n interface UpdatePolicyOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a policy.\n * @param policyId - Event Policy to delete\n * @public\n * @requiredField policyId\n */\n function deletePolicy(policyId: string, options?: DeletePolicyOptions): Promise;\n interface DeletePolicyOptions {\n /** The revision of the Event Policy */\n revision?: string;\n }\n /**\n * Retrieves a list of policies, given the provided paging and filter.\n * @param query - WQL expression\n * @public\n * @requiredField query\n */\n function queryPolicies(query: QueryV2$1): Promise;\n /**\n * Change the order of Event Policies\n * @public */\n function reorderEventPolicies(options?: ReorderEventPoliciesOptions): Promise;\n interface ReorderEventPoliciesOptions {\n /** Event ID */\n eventId?: string;\n /** Event Policy ID */\n policyId?: string;\n /** Move the Event Policy Id before this Event Policy ID */\n beforePolicyId?: string;\n /** Move the Event Policy Id after this Event Policy ID */\n afterPolicyId?: string;\n }\n /**\n * Get all Event Policies of an Event\n * @param eventId - Event Id\n * @public\n * @requiredField eventId\n */\n function getEventPolicies(eventId: string): Promise;\n \n type eventsV2Policy_universal_d_Policy = Policy;\n type eventsV2Policy_universal_d_CreatePolicyRequest = CreatePolicyRequest;\n type eventsV2Policy_universal_d_CreatePolicyResponse = CreatePolicyResponse;\n type eventsV2Policy_universal_d_UpdatePolicyRequest = UpdatePolicyRequest;\n type eventsV2Policy_universal_d_UpdatePolicyResponse = UpdatePolicyResponse;\n type eventsV2Policy_universal_d_UpdatePolicySortIndexRequest = UpdatePolicySortIndexRequest;\n type eventsV2Policy_universal_d_UpdatePolicySortIndexResponse = UpdatePolicySortIndexResponse;\n type eventsV2Policy_universal_d_DeletePolicyRequest = DeletePolicyRequest;\n type eventsV2Policy_universal_d_DeletePolicyResponse = DeletePolicyResponse;\n type eventsV2Policy_universal_d_QueryPoliciesRequest = QueryPoliciesRequest;\n type eventsV2Policy_universal_d_QueryPoliciesResponse = QueryPoliciesResponse;\n type eventsV2Policy_universal_d_ReorderEventPoliciesRequest = ReorderEventPoliciesRequest;\n type eventsV2Policy_universal_d_ReorderEventPoliciesRequestReferencePolicyOneOf = ReorderEventPoliciesRequestReferencePolicyOneOf;\n type eventsV2Policy_universal_d_ReorderEventPoliciesResponse = ReorderEventPoliciesResponse;\n type eventsV2Policy_universal_d_GetEventPoliciesRequest = GetEventPoliciesRequest;\n type eventsV2Policy_universal_d_GetEventPoliciesResponse = GetEventPoliciesResponse;\n type eventsV2Policy_universal_d_EventCopied = EventCopied;\n type eventsV2Policy_universal_d_Location = Location;\n type eventsV2Policy_universal_d_MapCoordinates = MapCoordinates;\n type eventsV2Policy_universal_d_LocationType = LocationType;\n const eventsV2Policy_universal_d_LocationType: typeof LocationType;\n type eventsV2Policy_universal_d_ScheduleConfig = ScheduleConfig;\n type eventsV2Policy_universal_d_Recurrences = Recurrences;\n type eventsV2Policy_universal_d_Occurrence = Occurrence;\n type eventsV2Policy_universal_d_Status = Status;\n const eventsV2Policy_universal_d_Status: typeof Status;\n type eventsV2Policy_universal_d_EventStatus = EventStatus;\n const eventsV2Policy_universal_d_EventStatus: typeof EventStatus;\n const eventsV2Policy_universal_d_createPolicy: typeof createPolicy;\n const eventsV2Policy_universal_d_updatePolicy: typeof updatePolicy;\n type eventsV2Policy_universal_d_UpdatePolicy = UpdatePolicy;\n type eventsV2Policy_universal_d_UpdatePolicyOptions = UpdatePolicyOptions;\n const eventsV2Policy_universal_d_deletePolicy: typeof deletePolicy;\n type eventsV2Policy_universal_d_DeletePolicyOptions = DeletePolicyOptions;\n const eventsV2Policy_universal_d_queryPolicies: typeof queryPolicies;\n const eventsV2Policy_universal_d_reorderEventPolicies: typeof reorderEventPolicies;\n type eventsV2Policy_universal_d_ReorderEventPoliciesOptions = ReorderEventPoliciesOptions;\n const eventsV2Policy_universal_d_getEventPolicies: typeof getEventPolicies;\n namespace eventsV2Policy_universal_d {\n export {\n __debug$1 as __debug,\n eventsV2Policy_universal_d_Policy as Policy,\n eventsV2Policy_universal_d_CreatePolicyRequest as CreatePolicyRequest,\n eventsV2Policy_universal_d_CreatePolicyResponse as CreatePolicyResponse,\n eventsV2Policy_universal_d_UpdatePolicyRequest as UpdatePolicyRequest,\n eventsV2Policy_universal_d_UpdatePolicyResponse as UpdatePolicyResponse,\n eventsV2Policy_universal_d_UpdatePolicySortIndexRequest as UpdatePolicySortIndexRequest,\n eventsV2Policy_universal_d_UpdatePolicySortIndexResponse as UpdatePolicySortIndexResponse,\n eventsV2Policy_universal_d_DeletePolicyRequest as DeletePolicyRequest,\n eventsV2Policy_universal_d_DeletePolicyResponse as DeletePolicyResponse,\n eventsV2Policy_universal_d_QueryPoliciesRequest as QueryPoliciesRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$1 as Paging,\n CursorPaging$1 as CursorPaging,\n eventsV2Policy_universal_d_QueryPoliciesResponse as QueryPoliciesResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n eventsV2Policy_universal_d_ReorderEventPoliciesRequest as ReorderEventPoliciesRequest,\n eventsV2Policy_universal_d_ReorderEventPoliciesRequestReferencePolicyOneOf as ReorderEventPoliciesRequestReferencePolicyOneOf,\n eventsV2Policy_universal_d_ReorderEventPoliciesResponse as ReorderEventPoliciesResponse,\n eventsV2Policy_universal_d_GetEventPoliciesRequest as GetEventPoliciesRequest,\n eventsV2Policy_universal_d_GetEventPoliciesResponse as GetEventPoliciesResponse,\n eventsV2Policy_universal_d_EventCopied as EventCopied,\n eventsV2Policy_universal_d_Location as Location,\n eventsV2Policy_universal_d_MapCoordinates as MapCoordinates,\n eventsV2Policy_universal_d_LocationType as LocationType,\n Address$1 as Address,\n AddressStreetOneOf$1 as AddressStreetOneOf,\n StreetAddress$1 as StreetAddress,\n AddressLocation$1 as AddressLocation,\n Subdivision$1 as Subdivision,\n SubdivisionType$1 as SubdivisionType,\n eventsV2Policy_universal_d_ScheduleConfig as ScheduleConfig,\n eventsV2Policy_universal_d_Recurrences as Recurrences,\n eventsV2Policy_universal_d_Occurrence as Occurrence,\n eventsV2Policy_universal_d_Status as Status,\n eventsV2Policy_universal_d_EventStatus as EventStatus,\n Empty$1 as Empty,\n eventsV2Policy_universal_d_createPolicy as createPolicy,\n eventsV2Policy_universal_d_updatePolicy as updatePolicy,\n eventsV2Policy_universal_d_UpdatePolicy as UpdatePolicy,\n eventsV2Policy_universal_d_UpdatePolicyOptions as UpdatePolicyOptions,\n eventsV2Policy_universal_d_deletePolicy as deletePolicy,\n eventsV2Policy_universal_d_DeletePolicyOptions as DeletePolicyOptions,\n eventsV2Policy_universal_d_queryPolicies as queryPolicies,\n eventsV2Policy_universal_d_reorderEventPolicies as reorderEventPolicies,\n eventsV2Policy_universal_d_ReorderEventPoliciesOptions as ReorderEventPoliciesOptions,\n eventsV2Policy_universal_d_getEventPolicies as getEventPolicies,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface EventGuest {\n /** Guest id. */\n _id?: string | null;\n /** Event id. */\n eventId?: string | null;\n /** Rsvp id. Available only when Guest type is RSVP. */\n rsvpId?: string | null;\n /** Order number. Available only when Guest type is ORDER or TICKET. */\n orderNumber?: string | null;\n /** Ticket number. Available only when Guest type is ORDER or TICKET. */\n ticketNumber?: string | null;\n /** List of bought tickets. */\n tickets?: string[];\n /** CRM contact ID for the person who is a guest. */\n contactId?: string | null;\n /** Guest details. */\n guestDetails?: GuestDetails;\n /** Attendance status */\n attendanceStatus?: AttendanceStatus;\n /** Secondary language code. */\n secondaryLanguageCode?: string | null;\n /** Date and time when the guest was created. */\n _createdDate?: Date;\n /** Date and time when the guest was updated. */\n _updatedDate?: Date;\n /** The last date and time when the guest attendance status was updated. */\n attendanceStatusUpdatedDate?: Date;\n /** Site member id. */\n memberId?: string | null;\n /** Guest source. */\n guestSource?: GuestSource;\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 /** Indicates if guests is checked in. */\n checkedIn?: boolean;\n }\n interface FormResponse {\n /** Input values entered upon ticket order. */\n inputValues?: InputValue[];\n }\n interface InputValue {\n /** Unique input name. */\n inputName?: string;\n /** Text value representation. */\n value?: string;\n /** Text value vector. */\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress;\n }\n interface FormattedAddress {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address;\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 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 GuestSource {\n /** Rsvp guest. */\n RSVP = \"RSVP\",\n /** Order source. */\n ORDER = \"ORDER\",\n /** Ticket source. */\n TICKET = \"TICKET\"\n }\n interface QueryEventGuestsRequest {\n /** WQL expression */\n query: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\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 /** 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 /** 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 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 /** 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 QueryEventGuestsResponse {\n /** List of guests. */\n guests?: EventGuest[];\n /** Metadata for the paginated results. */\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 * 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 * @internal\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 SecondaryLanguagesRequest {\n /** Guest event id. */\n eventId?: string;\n }\n interface SecondaryLanguagesResponse {\n /** Aggregated guests languages. */\n secondaryLanguages?: string[];\n }\n interface RsvpCreated {\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. */\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 }\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;\n }\n interface Empty {\n }\n interface RsvpUpdated {\n /** RSVP updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when RSVP created */\n language?: 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;\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 }\n interface RsvpDeleted {\n /** RSVP deleted timestamp in ISO UTC format. */\n timestamp?: Date;\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 OrderUpdated {\n /** Order updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: 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;\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 enum OrderStatus {\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 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;\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 /** Anonymized tickets no longer contain personally identifiable information (PII). */\n anonymized?: boolean;\n }\n interface Money {\n /** Decimal amount representation. 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 OrderDeleted {\n /** Order deleted timestamp in ISO UTC format. */\n timestamp?: Date;\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 /** 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 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 /**\n * Query to select guests.\n * Supports efficient filtering by `createdDate`, `eventId`, `attendanceStatus`, `secondaryLanguageCode`, `rsvpId`, `orderNumber`, `ticketNumber`, `memberId` or `guestDetails.checkedIn`\n * @param query - WQL expression\n * @public\n * @requiredField query\n */\n function queryEventGuests(query: QueryV2): Promise;\n \n const eventsGuestsV1Guest_universal_d___debug: typeof __debug;\n type eventsGuestsV1Guest_universal_d_EventGuest = EventGuest;\n type eventsGuestsV1Guest_universal_d_GuestDetails = GuestDetails;\n type eventsGuestsV1Guest_universal_d_FormResponse = FormResponse;\n type eventsGuestsV1Guest_universal_d_InputValue = InputValue;\n type eventsGuestsV1Guest_universal_d_FormattedAddress = FormattedAddress;\n type eventsGuestsV1Guest_universal_d_Address = Address;\n type eventsGuestsV1Guest_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type eventsGuestsV1Guest_universal_d_StreetAddress = StreetAddress;\n type eventsGuestsV1Guest_universal_d_AddressLocation = AddressLocation;\n type eventsGuestsV1Guest_universal_d_Subdivision = Subdivision;\n type eventsGuestsV1Guest_universal_d_SubdivisionType = SubdivisionType;\n const eventsGuestsV1Guest_universal_d_SubdivisionType: typeof SubdivisionType;\n type eventsGuestsV1Guest_universal_d_AttendanceStatus = AttendanceStatus;\n const eventsGuestsV1Guest_universal_d_AttendanceStatus: typeof AttendanceStatus;\n type eventsGuestsV1Guest_universal_d_GuestSource = GuestSource;\n const eventsGuestsV1Guest_universal_d_GuestSource: typeof GuestSource;\n type eventsGuestsV1Guest_universal_d_QueryEventGuestsRequest = QueryEventGuestsRequest;\n type eventsGuestsV1Guest_universal_d_QueryV2 = QueryV2;\n type eventsGuestsV1Guest_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type eventsGuestsV1Guest_universal_d_Sorting = Sorting;\n type eventsGuestsV1Guest_universal_d_SortOrder = SortOrder;\n const eventsGuestsV1Guest_universal_d_SortOrder: typeof SortOrder;\n type eventsGuestsV1Guest_universal_d_Paging = Paging;\n type eventsGuestsV1Guest_universal_d_CursorPaging = CursorPaging;\n type eventsGuestsV1Guest_universal_d_QueryEventGuestsResponse = QueryEventGuestsResponse;\n type eventsGuestsV1Guest_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type eventsGuestsV1Guest_universal_d_Cursors = Cursors;\n type eventsGuestsV1Guest_universal_d_SecondaryLanguagesRequest = SecondaryLanguagesRequest;\n type eventsGuestsV1Guest_universal_d_SecondaryLanguagesResponse = SecondaryLanguagesResponse;\n type eventsGuestsV1Guest_universal_d_RsvpCreated = RsvpCreated;\n type eventsGuestsV1Guest_universal_d_RsvpStatus = RsvpStatus;\n const eventsGuestsV1Guest_universal_d_RsvpStatus: typeof RsvpStatus;\n type eventsGuestsV1Guest_universal_d_Guest = Guest;\n type eventsGuestsV1Guest_universal_d_CheckIn = CheckIn;\n type eventsGuestsV1Guest_universal_d_Empty = Empty;\n type eventsGuestsV1Guest_universal_d_RsvpUpdated = RsvpUpdated;\n type eventsGuestsV1Guest_universal_d_RsvpDeleted = RsvpDeleted;\n type eventsGuestsV1Guest_universal_d_OrderUpdated = OrderUpdated;\n type eventsGuestsV1Guest_universal_d_OrderStatus = OrderStatus;\n const eventsGuestsV1Guest_universal_d_OrderStatus: typeof OrderStatus;\n type eventsGuestsV1Guest_universal_d_Ticket = Ticket;\n type eventsGuestsV1Guest_universal_d_Money = Money;\n type eventsGuestsV1Guest_universal_d_OrderDeleted = OrderDeleted;\n type eventsGuestsV1Guest_universal_d_OrderType = OrderType;\n const eventsGuestsV1Guest_universal_d_OrderType: typeof OrderType;\n type eventsGuestsV1Guest_universal_d_Task = Task;\n type eventsGuestsV1Guest_universal_d_TaskKey = TaskKey;\n const eventsGuestsV1Guest_universal_d_queryEventGuests: typeof queryEventGuests;\n namespace eventsGuestsV1Guest_universal_d {\n export {\n eventsGuestsV1Guest_universal_d___debug as __debug,\n eventsGuestsV1Guest_universal_d_EventGuest as EventGuest,\n eventsGuestsV1Guest_universal_d_GuestDetails as GuestDetails,\n eventsGuestsV1Guest_universal_d_FormResponse as FormResponse,\n eventsGuestsV1Guest_universal_d_InputValue as InputValue,\n eventsGuestsV1Guest_universal_d_FormattedAddress as FormattedAddress,\n eventsGuestsV1Guest_universal_d_Address as Address,\n eventsGuestsV1Guest_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n eventsGuestsV1Guest_universal_d_StreetAddress as StreetAddress,\n eventsGuestsV1Guest_universal_d_AddressLocation as AddressLocation,\n eventsGuestsV1Guest_universal_d_Subdivision as Subdivision,\n eventsGuestsV1Guest_universal_d_SubdivisionType as SubdivisionType,\n eventsGuestsV1Guest_universal_d_AttendanceStatus as AttendanceStatus,\n eventsGuestsV1Guest_universal_d_GuestSource as GuestSource,\n eventsGuestsV1Guest_universal_d_QueryEventGuestsRequest as QueryEventGuestsRequest,\n eventsGuestsV1Guest_universal_d_QueryV2 as QueryV2,\n eventsGuestsV1Guest_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n eventsGuestsV1Guest_universal_d_Sorting as Sorting,\n eventsGuestsV1Guest_universal_d_SortOrder as SortOrder,\n eventsGuestsV1Guest_universal_d_Paging as Paging,\n eventsGuestsV1Guest_universal_d_CursorPaging as CursorPaging,\n eventsGuestsV1Guest_universal_d_QueryEventGuestsResponse as QueryEventGuestsResponse,\n eventsGuestsV1Guest_universal_d_PagingMetadataV2 as PagingMetadataV2,\n eventsGuestsV1Guest_universal_d_Cursors as Cursors,\n eventsGuestsV1Guest_universal_d_SecondaryLanguagesRequest as SecondaryLanguagesRequest,\n eventsGuestsV1Guest_universal_d_SecondaryLanguagesResponse as SecondaryLanguagesResponse,\n eventsGuestsV1Guest_universal_d_RsvpCreated as RsvpCreated,\n eventsGuestsV1Guest_universal_d_RsvpStatus as RsvpStatus,\n eventsGuestsV1Guest_universal_d_Guest as Guest,\n eventsGuestsV1Guest_universal_d_CheckIn as CheckIn,\n eventsGuestsV1Guest_universal_d_Empty as Empty,\n eventsGuestsV1Guest_universal_d_RsvpUpdated as RsvpUpdated,\n eventsGuestsV1Guest_universal_d_RsvpDeleted as RsvpDeleted,\n eventsGuestsV1Guest_universal_d_OrderUpdated as OrderUpdated,\n eventsGuestsV1Guest_universal_d_OrderStatus as OrderStatus,\n eventsGuestsV1Guest_universal_d_Ticket as Ticket,\n eventsGuestsV1Guest_universal_d_Money as Money,\n eventsGuestsV1Guest_universal_d_OrderDeleted as OrderDeleted,\n eventsGuestsV1Guest_universal_d_OrderType as OrderType,\n eventsGuestsV1Guest_universal_d_Task as Task,\n eventsGuestsV1Guest_universal_d_TaskKey as TaskKey,\n eventsGuestsV1Guest_universal_d_queryEventGuests as queryEventGuests,\n };\n }\n \n export { eventsGuestsV1Guest_universal_d as guests, eventsV2Policy_universal_d as policy };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-inbox-conversations.backend.v1.d.ts", "content": "declare module \"wix-inbox-conversations.backend.v1\" {\n const __debug: {\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;\n /**\n * List of communication channels where the visitor, contact, or member can receive messages.\n * @readonly\n */\n channels?: ChannelType[];\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 extends IdentificationDataIdOneOf {\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 /** 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 IdentificationDataIdOneOf {\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 {\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;\n /** only message time is supported for field name */\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 ListConversationsResponse {\n conversations?: Conversation[];\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 * 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 * @internal\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 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;\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 {\n }\n /**\n * Retrieves a conversation by conversation ID.\n *\n * If you don't have the conversation ID,\n * use [Get Or Create Conversation](#get-or-create-conversation)\n * to retrieve the conversation with the visitor, contact, or member ID.\n * @param conversationId - Conversation ID.\n * @public\n * @requiredField conversationId\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 * @public */\n function getOrCreateConversation(options?: GetOrCreateConversationOptions): Promise;\n interface GetOrCreateConversationOptions {\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 function listConversations(options?: ListConversationsOptions): Promise;\n interface ListConversationsOptions {\n paging?: CursorPaging;\n /** only message time is supported for field name */\n sorting?: Sorting;\n }\n /** @requiredField conversationId */\n function deleteConversation(conversationId: string): Promise;\n /** @requiredField conversationId */\n function addConversationChannels(conversationId: string, options?: AddConversationChannelsOptions): Promise;\n interface AddConversationChannelsOptions {\n conversationChannels?: ConversationChannel[];\n }\n \n const crmInboxV2Conversation_universal_d___debug: typeof __debug;\n type crmInboxV2Conversation_universal_d_Conversation = Conversation;\n type crmInboxV2Conversation_universal_d_IdentificationData = IdentificationData;\n type crmInboxV2Conversation_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type crmInboxV2Conversation_universal_d_ChannelType = ChannelType;\n const crmInboxV2Conversation_universal_d_ChannelType: typeof ChannelType;\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_CursorPaging = CursorPaging;\n type crmInboxV2Conversation_universal_d_Sorting = Sorting;\n type crmInboxV2Conversation_universal_d_SortOrder = SortOrder;\n const crmInboxV2Conversation_universal_d_SortOrder: typeof SortOrder;\n type crmInboxV2Conversation_universal_d_ListConversationsResponse = ListConversationsResponse;\n type crmInboxV2Conversation_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type crmInboxV2Conversation_universal_d_Cursors = Cursors;\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 type crmInboxV2Conversation_universal_d_Empty = Empty;\n const crmInboxV2Conversation_universal_d_getConversation: typeof getConversation;\n const crmInboxV2Conversation_universal_d_getOrCreateConversation: typeof getOrCreateConversation;\n type crmInboxV2Conversation_universal_d_GetOrCreateConversationOptions = GetOrCreateConversationOptions;\n const crmInboxV2Conversation_universal_d_listConversations: typeof listConversations;\n type crmInboxV2Conversation_universal_d_ListConversationsOptions = ListConversationsOptions;\n const crmInboxV2Conversation_universal_d_deleteConversation: typeof deleteConversation;\n const crmInboxV2Conversation_universal_d_addConversationChannels: typeof addConversationChannels;\n type crmInboxV2Conversation_universal_d_AddConversationChannelsOptions = AddConversationChannelsOptions;\n namespace crmInboxV2Conversation_universal_d {\n export {\n crmInboxV2Conversation_universal_d___debug as __debug,\n crmInboxV2Conversation_universal_d_Conversation as Conversation,\n crmInboxV2Conversation_universal_d_IdentificationData as IdentificationData,\n crmInboxV2Conversation_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n crmInboxV2Conversation_universal_d_ChannelType as ChannelType,\n crmInboxV2Conversation_universal_d_ConversationDisplayData as ConversationDisplayData,\n crmInboxV2Conversation_universal_d_ConversationsMerged as ConversationsMerged,\n crmInboxV2Conversation_universal_d_GetConversationRequest as GetConversationRequest,\n crmInboxV2Conversation_universal_d_GetConversationResponse as GetConversationResponse,\n crmInboxV2Conversation_universal_d_GetOrCreateConversationRequest as GetOrCreateConversationRequest,\n crmInboxV2Conversation_universal_d_ParticipantId as ParticipantId,\n crmInboxV2Conversation_universal_d_ParticipantIdIdOneOf as ParticipantIdIdOneOf,\n crmInboxV2Conversation_universal_d_GetOrCreateConversationResponse as GetOrCreateConversationResponse,\n crmInboxV2Conversation_universal_d_ListConversationsRequest as ListConversationsRequest,\n crmInboxV2Conversation_universal_d_CursorPaging as CursorPaging,\n crmInboxV2Conversation_universal_d_Sorting as Sorting,\n crmInboxV2Conversation_universal_d_SortOrder as SortOrder,\n crmInboxV2Conversation_universal_d_ListConversationsResponse as ListConversationsResponse,\n crmInboxV2Conversation_universal_d_PagingMetadataV2 as PagingMetadataV2,\n crmInboxV2Conversation_universal_d_Cursors as Cursors,\n crmInboxV2Conversation_universal_d_DeleteConversationRequest as DeleteConversationRequest,\n crmInboxV2Conversation_universal_d_DeleteConversationResponse as DeleteConversationResponse,\n crmInboxV2Conversation_universal_d_AddConversationChannelsRequest as AddConversationChannelsRequest,\n crmInboxV2Conversation_universal_d_ConversationChannel as ConversationChannel,\n crmInboxV2Conversation_universal_d_AddConversationChannelsResponse as AddConversationChannelsResponse,\n crmInboxV2Conversation_universal_d_ChatroomsMerged as ChatroomsMerged,\n crmInboxV2Conversation_universal_d_Empty as Empty,\n crmInboxV2Conversation_universal_d_getConversation as getConversation,\n crmInboxV2Conversation_universal_d_getOrCreateConversation as getOrCreateConversation,\n crmInboxV2Conversation_universal_d_GetOrCreateConversationOptions as GetOrCreateConversationOptions,\n crmInboxV2Conversation_universal_d_listConversations as listConversations,\n crmInboxV2Conversation_universal_d_ListConversationsOptions as ListConversationsOptions,\n crmInboxV2Conversation_universal_d_deleteConversation as deleteConversation,\n crmInboxV2Conversation_universal_d_addConversationChannels as addConversationChannels,\n crmInboxV2Conversation_universal_d_AddConversationChannelsOptions as AddConversationChannelsOptions,\n };\n }\n \n export { crmInboxV2Conversation_universal_d as inboxConversations };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-ratings-backend.d.ts", "content": "declare module \"wix-ratings-backend\" {\n /**\n * A Rating object includes all of the details related to the rating of an entity or its attributes.\n * An entity is a resource to be rated, for example, a Wix Stores product.\n * You can manage existing ratings, create new ratings, and retrieve rating data.\n * Read more about ratings in this [tutorial](https://support.wix.com/en/article/velo-tutorial-capturing-and-displaying-ratings).\n */\n interface Rating {\n /**\n * Rating ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the rating is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the rating.\n * Ignored when creating a rating.\n * @readonly\n */\n revision?: string | null;\n /** The Wix module or app that the Ratings API is integrated with. For example, Wix Reviews as `reviews`. */\n namespace?: string | null;\n /** A group of entities in a namespace. A namespace can have one or more groups. For example, `blog` and `forum` groups in the `comments` namespace. */\n group?: string;\n /** ID of the entity being rated. For example, a Wix Stores product. */\n entityId?: string;\n /** Characteristic of an entity that can be rated individually. For example, `value for money`. */\n attributeName?: string;\n /**\n * Rating score.\n *\n * Min = `0`
\n * Max = `100`\n */\n value?: number | null;\n /** Rating owner. */\n owner?: IdentificationData;\n /**\n * Date and time the rating was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the rating was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Entities related to the entity being rated.\n * [Query Ratings](https://dev.wix.com/api/rest/ratings/query-ratings) can filter by this parameter.\n */\n relatedEntityIds?: string[] | null;\n /**\n * @internal\n * @deprecated\n * @replacedBy attribute_name\n */\n attributeId?: 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 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 {\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 }\n interface GroupAttributeSummaryUpdated {\n /** The Wix module or app that the Ratings API is integrated with. For example, Wix Reviews as `reviews`. */\n namespace?: string;\n /** A group of entities in a namespace. A namespace can have one or more groups. For example, `blog` and `forum` groups in the `comments` namespace. */\n group?: string;\n /** Rating summary of the attributes. */\n attributeSummary?: AttributeSummary;\n }\n interface AttributeSummary {\n /** Attribute name. An attribute is a feature of an entity that can be rated individually. */\n attributeName?: string | null;\n /** Total number of ratings. */\n total?: number;\n /** Average rating score for the attribute. */\n average?: number;\n /** Details of the rating scores. This includes every rating `value` given for the attribute and the `total` number of ratings with the `value`. */\n valueBreakdown?: ValueBreakdown[];\n /**\n * ID of the attribute.\n * @internal\n * @deprecated ID of the attribute.\n * @replacedBy attribute_name\n */\n attributeId?: string | null;\n }\n interface ValueBreakdown {\n /** Rating score. */\n value?: number;\n /** Total number of ratings scored with the `value`. */\n total?: number;\n }\n interface EntityAttributeSummaryUpdated {\n /** The Wix module or app that the Ratings API is integrated with. For example, Wix Reviews as `reviews`. */\n namespace?: string;\n /** A group of entities in a namespace. A namespace can have one or more groups. For example, `blog` and `forum` groups in the `comments` namespace. */\n group?: string;\n /** ID of the entity. */\n entityId?: string;\n /** Rating summary of the attributes. */\n attributeSummary?: AttributeSummary;\n }\n interface CreateRatingRequest {\n /** Rating to create. */\n rating: Rating;\n }\n interface CreateRatingResponse {\n /** Created rating. */\n rating?: Rating;\n }\n interface GetRatingRequest {\n /** ID of the rating to retrieve. */\n _id: string;\n /**\n * Namespace of ratings to retrieve.\n * @internal\n * @deprecated Namespace of ratings to retrieve.\n * @targetRemovalDate 2024-02-15\n */\n namespace?: string | null;\n }\n interface GetRatingResponse {\n /** Retrieved rating. */\n rating?: Rating;\n }\n interface UpdateRatingRequest {\n /** Rating to update. */\n rating: Rating;\n /**\n * Fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateRatingResponse {\n /** Updated rating. */\n rating?: Rating;\n }\n interface DeleteRatingRequest {\n /** ID of the rating to delete. */\n _id: string;\n }\n interface DeleteRatingResponse {\n }\n interface GetGroupSummaryRequest {\n /** Name of group to calculate the rating summaries for. */\n group: string;\n /** List of attributes for the summaries. */\n attributeNames?: string[];\n /** Namespace for the summaries. */\n namespace?: string | null;\n /**\n * List of attributes to calculate the summaries for.\n * @internal\n * @deprecated List of attributes to calculate the summaries for.\n * @replacedBy attribute_ids\n */\n attributeIds?: string[];\n }\n interface GetGroupSummaryResponse {\n /** Group name. */\n group?: string;\n /** List of attribute summaries. */\n attributeSummaries?: AttributeSummary[];\n }\n interface GetEntitySummaryRequest {\n /** Name of group to calculate the summaries for. */\n group: string;\n /** Entity ID. */\n entityId: string;\n /** List of attributes for the summaries. */\n attributeNames?: string[];\n /** Namespace for the summaries. */\n namespace?: string | null;\n /**\n * List of attributes to calculate the summaries for.\n * @internal\n * @deprecated List of attributes to calculate the summaries for.\n * @replacedBy attribute_names\n */\n attributeIds?: string[];\n }\n interface GetEntitySummaryResponse {\n /** Group name. */\n group?: string;\n /** Entity ID. */\n entityId?: string;\n /** List of attribute summaries. */\n attributeSummaries?: AttributeSummary[];\n }\n interface ListAttributeAveragesByEntityRequest {\n /** Name of group to calculate rating averages for. */\n group: string;\n /** Entity IDs to calculate rating averages for. */\n entityIds?: string[];\n /** Attribute to calculate rating averages for. */\n attributeName: string | null;\n /** Namespace to calculate rating averages for. */\n namespace?: string | null;\n /**\n * @internal\n * @deprecated\n * @replacedBy attribute_names\n */\n attributeId?: string | null;\n }\n interface ListAttributeAveragesByEntityResponse {\n /** Group name. */\n group?: string;\n /** Entity averages. */\n entityAverages?: EntityAverage[];\n }\n interface EntityAverage {\n /** Entity ID. */\n entityId?: string;\n /** Total number of ratings for the entity. */\n total?: number;\n /** Average rating for the attributes of the entity. */\n average?: number;\n }\n interface QueryRatingsRequest {\n /** Rating query. */\n query?: QueryV2;\n }\n interface QueryV2 {\n /**\n * Filter object. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information.\n * For a detailed list of supported filters, see [Ratings: Supported Filters and Sorting](https://dev.wix.com/api/rest/ratings/sort-and-filter),\n */\n filter?: Record | null;\n /** Sorting options. See [Ratings: Supported Filters and Sorting](https://dev.wix.com/api/rest/ratings/sort-and-filter) for more information, */\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 * Default: `ASC`.\n */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\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 QueryRatingsResponse {\n /** List of returned ratings. */\n ratings?: Rating[];\n /** Paging metadata. */\n metadata?: PagingMetadataV2;\n }\n interface PagingMetadataV2 {\n /** Number of items returned in the response. */\n count?: 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 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 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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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?: 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;\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 {\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 rating.\n *\n *\n * The request body must include `group`, `entityId`, and rating `value`.\n * @param rating - Rating to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField rating\n * @requiredField rating.entityId\n * @requiredField rating.group\n * @requiredField rating.value\n * @permissionId RATING.RATING_CREATE\n * @adminMethod\n * @returns Created rating.\n */\n function createRating(rating: Rating): Promise;\n /**\n * Retrieves a rating by ID.\n * @param _id - ID of the rating to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId RATING.RATING_READ\n * @returns Retrieved rating.\n */\n function getRating(_id: string, options?: GetRatingOptions): Promise;\n interface GetRatingOptions {\n /**\n * Namespace of ratings to retrieve.\n * @internal\n * @deprecated Namespace of ratings to retrieve.\n * @targetRemovalDate 2024-02-15\n */\n namespace?: string | null;\n }\n /**\n * Updates a rating or list of related entities.\n *\n *\n * Each time the rating is updated, `revision` increments by 1. The existing `revision` must be included\n * when updating the rating. This ensures you're working with the latest rating information, and it prevents unintended overwrites.\n * @param _id - Rating ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField rating\n * @requiredField rating.revision\n * @permissionId RATING.RATING_UPDATE\n * @adminMethod\n * @returns Updated rating.\n */\n function updateRating(_id: string | null, rating: UpdateRating, options?: UpdateRatingOptions): Promise;\n interface UpdateRating {\n /**\n * Rating ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the rating is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the rating.\n * Ignored when creating a rating.\n * @readonly\n */\n revision?: string | null;\n /** The Wix module or app that the Ratings API is integrated with. For example, Wix Reviews as `reviews`. */\n namespace?: string | null;\n /** A group of entities in a namespace. A namespace can have one or more groups. For example, `blog` and `forum` groups in the `comments` namespace. */\n group?: string;\n /** ID of the entity being rated. For example, a Wix Stores product. */\n entityId?: string;\n /** Characteristic of an entity that can be rated individually. For example, `value for money`. */\n attributeName?: string;\n /**\n * Rating score.\n *\n * Min = `0`
\n * Max = `100`\n */\n value?: number | null;\n /** Rating owner. */\n owner?: IdentificationData;\n /**\n * Date and time the rating was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the rating was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Entities related to the entity being rated.\n * [Query Ratings](https://dev.wix.com/api/rest/ratings/query-ratings) can filter by this parameter.\n */\n relatedEntityIds?: string[] | null;\n /**\n * @internal\n * @deprecated\n * @replacedBy attribute_name\n */\n attributeId?: string;\n }\n interface UpdateRatingOptions {\n /**\n * Fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a rating by ID.\n * @param _id - ID of the rating to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId RATING.RATING_DELETE\n * @adminMethod\n */\n function deleteRating(_id: string): Promise;\n /**\n * Retrieves a rating summary for a group.\n * @param group - Name of group to calculate the rating summaries for.\n * @internal\n * @documentationMaturity preview\n * @requiredField group\n * @permissionId RATING.RATING_GET_NAMESPACE_SUMMARY\n */\n function getGroupSummary(group: string, options?: GetGroupSummaryOptions): Promise;\n interface GetGroupSummaryOptions {\n /** List of attributes for the summaries. */\n attributeNames?: string[];\n /** Namespace for the summaries. */\n namespace?: string | null;\n /**\n * List of attributes to calculate the summaries for.\n * @internal\n * @deprecated List of attributes to calculate the summaries for.\n * @replacedBy attribute_ids\n */\n attributeIds?: string[];\n }\n /**\n * Retrieves a rating summary for the requested entity.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.entityId\n * @requiredField identifiers.group\n * @permissionId RATING.RATING_GET_ENTITY_SUMMARY\n */\n function getEntitySummary(identifiers: GetEntitySummaryIdentifiers, options?: GetEntitySummaryOptions): Promise;\n interface GetEntitySummaryIdentifiers {\n /** Name of group to calculate the summaries for. */\n group: string;\n /** Entity ID. */\n entityId: string;\n }\n interface GetEntitySummaryOptions {\n /** List of attributes for the summaries. */\n attributeNames?: string[];\n /** Namespace for the summaries. */\n namespace?: string | null;\n /**\n * List of attributes to calculate the summaries for.\n * @internal\n * @deprecated List of attributes to calculate the summaries for.\n * @replacedBy attribute_names\n */\n attributeIds?: string[];\n }\n /**\n * Retrieves average attribute ratings for entities in a group.\n * @param group - Name of group to calculate rating averages for.\n * @public\n * @documentationMaturity preview\n * @requiredField group\n * @requiredField options.attributeName\n * @permissionId RATING.RATING_READ\n */\n function listAttributeAveragesByEntity(group: string, options?: ListAttributeAveragesByEntityOptions): Promise;\n interface ListAttributeAveragesByEntityOptions {\n /** Entity IDs to calculate rating averages for. */\n entityIds?: string[];\n /** Attribute to calculate rating averages for. */\n attributeName: string | null;\n /** Namespace to calculate rating averages for. */\n namespace?: string | null;\n /**\n * @internal\n * @deprecated\n * @replacedBy attribute_names\n */\n attributeId?: string | null;\n }\n /**\n * Retrieves a list of ratings, given the provided paging, filtering, and sorting.\n * 100 ratings can be returned per request.\n *\n * Query Ratings runs with these defaults, which you can override:\n *\n * - `createdDate` is sorted in `ASC` order\n * - `paging.limit` is `100`\n *\n * For field support for filters and sorting, see\n * [Ratings: Supported Filters and Sorting](https://dev.wix.com/api/rest/ratings/sort-and-filter).\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 * @internal\n * @documentationMaturity preview\n * @permissionId RATING.RATING_READ\n */\n function queryRatings(): RatingsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface RatingsQueryResult extends QueryCursorResult {\n items: Rating[];\n query: RatingsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface RatingsQueryBuilder {\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' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds', value: any) => RatingsQueryBuilder;\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' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds', value: any) => RatingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'revision' | 'value' | '_createdDate' | '_updatedDate', value: any) => RatingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'revision' | 'value' | '_createdDate' | '_updatedDate', value: any) => RatingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'revision' | 'value' | '_createdDate' | '_updatedDate', value: any) => RatingsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'revision' | 'value' | '_createdDate' | '_updatedDate', value: any) => RatingsQueryBuilder;\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' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId', value: string) => RatingsQueryBuilder;\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' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds', value: any[]) => RatingsQueryBuilder;\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: 'relatedEntityIds', value: any[]) => RatingsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds', value: any) => RatingsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds', value: boolean) => RatingsQueryBuilder;\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' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds' | 'attributeId'>) => RatingsQueryBuilder;\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' | 'revision' | 'namespace' | 'group' | 'entityId' | 'attributeName' | 'value' | 'owner' | 'owner.anonymousVisitorId' | 'owner.memberId' | 'owner.contactId' | '_createdDate' | '_updatedDate' | 'relatedEntityIds' | 'attributeId'>) => RatingsQueryBuilder;\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) => RatingsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => RatingsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n export { ActionEvent, AttributeSummary, CreateRatingRequest, CreateRatingResponse, CursorPaging, Cursors, DeleteRatingRequest, DeleteRatingResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityAttributeSummaryUpdated, EntityAverage, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetEntitySummaryIdentifiers, GetEntitySummaryOptions, GetEntitySummaryRequest, GetEntitySummaryResponse, GetGroupSummaryOptions, GetGroupSummaryRequest, GetGroupSummaryResponse, GetRatingOptions, GetRatingRequest, GetRatingResponse, GroupAttributeSummaryUpdated, IdentificationData, IdentificationDataIdOneOf, ListAttributeAveragesByEntityOptions, ListAttributeAveragesByEntityRequest, ListAttributeAveragesByEntityResponse, MessageEnvelope, PagingMetadataV2, QueryRatingsRequest, QueryRatingsResponse, QueryV2, Rating, RatingsQueryBuilder, RatingsQueryResult, RestoreInfo, SortOrder, Sorting, UpdateRating, UpdateRatingOptions, UpdateRatingRequest, UpdateRatingResponse, ValueBreakdown, WebhookIdentityType, WebhooksIdentificationData, WebhooksIdentificationDataIdOneOf, createRating, deleteRating, getEntitySummary, getGroupSummary, getRating, listAttributeAveragesByEntity, queryRatings, updateRating };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecom-v1-related-items-provider.d.ts", "content": "declare module \"interfaces-ecom-v1-related-items-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface RecommendationsProviderEntity {\n }\n /** additional information can be passed via aspects, for example GEO */\n interface GetRecommendationsRequest {\n /** items for which related items will be found */\n items?: CatalogReference[];\n /** List of algorithms to find recommended items. Related items will be returned separately for each algorithm */\n algorithmIds?: string[];\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 GetRecommendationsResponse {\n /** Related items for each algorithm */\n recommendationPerAlgorithm?: RecommendationForAlgorithm[];\n }\n interface RecommendationForAlgorithm {\n /** algorithm which was used to find recommendation */\n algorithmId?: string;\n /** recommended items according to algorithm and items in request (when provided) */\n recommendedItems?: CatalogReference[];\n }\n interface RecommendationAlgorithmNotSupported {\n /** Not supported algorithms. */\n unsupportedAlgorithms?: string[];\n }\n interface ItemAppIdNotSupportedError {\n /** Items with not supported catalogs. */\n items?: CatalogReference[];\n }\n interface RecommendationsProviderConfig {\n /** app ids of catalogs for which recommended items can be found */\n catalogAppIds?: string[];\n /** supported algorithms */\n supportedAlgorithms?: AlgorithmConfig[];\n }\n interface AlgorithmConfig {\n /** Algorithm id which will be sent in requests. It must be unique per provider. */\n _id?: string;\n /** Name which will be shown to user in list of algorithms available for site. For example \"Best sellers\", \"Frequently watched together\". This value is not translatable. */\n name?: string;\n /** Description of algorithm which will be shown to user in list of algorithms available for site. This value is not translatable. It should describe how algorithm works, if it has any limitations regarding site content, number of items, site traffic and so on. */\n description?: string;\n /** This field can be used when `description ` field is not enough to describe algorithm and you want to have separate section with additional info. It can be used to not overload user with too much information on main page. Depending on frontend implementation it can be displayed as tooltip or as additional section which is collapsed by default. */\n additionalInfo?: string | null;\n /**\n * `RELATED_ITEMS` - algorithm provides recommendations based on some other items interested for user/user of user. For example once one item added to cart algorithm can suggest other items frequently bought together with given one.\n * `GLOBAL` - algorithm provides generic recommendations for given site. For example, best sellers items or new arrivals\n */\n algorithmType?: AlgorithmType;\n }\n enum AlgorithmType {\n UNSPECIFIED = \"UNSPECIFIED\",\n RELATED_ITEMS = \"RELATED_ITEMS\",\n GLOBAL = \"GLOBAL\"\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 GetRecommendationsOptions {\n /** items for which related items will be found */\n items?: CatalogReference[];\n /** List of algorithms to find recommended items. Related items will be returned separately for each algorithm */\n algorithmIds?: string[];\n }\n \n function algorithmNotSupportedError(data: RecommendationAlgorithmNotSupported): BusinessError;\n function itemAppIdNotSupportedError(data: ItemAppIdNotSupportedError): BusinessError;\n \n const getRecommendationsSpiErrors_d_algorithmNotSupportedError: typeof algorithmNotSupportedError;\n const getRecommendationsSpiErrors_d_itemAppIdNotSupportedError: typeof itemAppIdNotSupportedError;\n namespace getRecommendationsSpiErrors_d {\n export {\n getRecommendationsSpiErrors_d_algorithmNotSupportedError as algorithmNotSupportedError,\n getRecommendationsSpiErrors_d_itemAppIdNotSupportedError as itemAppIdNotSupportedError,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n getRecommendationsSpiErrors_d as getRecommendations,\n };\n }\n \n export { AlgorithmConfig, AlgorithmType, CatalogReference, Context, GetRecommendationsOptions, GetRecommendationsRequest, GetRecommendationsResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, ItemAppIdNotSupportedError, RecommendationAlgorithmNotSupported, RecommendationForAlgorithm, RecommendationsProviderConfig, RecommendationsProviderEntity, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-groups-backend.v2.d.ts", "content": "declare module \"wix-groups-backend.v2\" {\n const __debug$6: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * Guidelines ensuring that members post responsibly and respectfully. Site owners can set up Group Rules in the Business Manager.\n * >**Note:** Only admins can update the group rules.\n */\n interface GroupRules {\n /** Group rules. */\n rules?: GroupRule[];\n }\n interface GroupRule {\n /** Rule title. */\n title?: string;\n /** Rule description. */\n description?: string;\n }\n interface ListRulesRequest {\n /** Group ID. */\n groupId: string;\n }\n interface ListRulesResponse {\n /** Retrieved rules. */\n rules?: GroupRule[];\n }\n interface CreateOrReplaceAllRulesRequest {\n /** Group ID. */\n groupId: string;\n /** New rules. */\n rules?: GroupRule[];\n }\n interface CreateOrReplaceAllRulesResponse {\n /** Group ID. */\n groupId?: string;\n /** Rules. */\n rules?: GroupRule[];\n }\n interface Empty {\n }\n interface ListTemplatesResponse {\n /** Retrieved rule templates. */\n rules?: GroupRule[];\n }\n /**\n * Retrieves rules.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function listRules(groupId: string): Promise;\n /**\n * Creates rules if no rules have been set up. Otherwise, replaces all existing rules.\n * > **Note:** Only admins can create or replace rules.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function createOrReplaceAllRules(groupId: string, options?: CreateOrReplaceAllRulesOptions): Promise;\n interface CreateOrReplaceAllRulesOptions {\n /** New rules. */\n rules?: GroupRule[];\n }\n /**\n * Retrieves the rule templates.\n * @internal\n * @documentationMaturity preview\n */\n function listTemplates(): Promise;\n \n type socialGroupsV2GroupRules_universal_d_GroupRules = GroupRules;\n type socialGroupsV2GroupRules_universal_d_GroupRule = GroupRule;\n type socialGroupsV2GroupRules_universal_d_ListRulesRequest = ListRulesRequest;\n type socialGroupsV2GroupRules_universal_d_ListRulesResponse = ListRulesResponse;\n type socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesRequest = CreateOrReplaceAllRulesRequest;\n type socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesResponse = CreateOrReplaceAllRulesResponse;\n type socialGroupsV2GroupRules_universal_d_Empty = Empty;\n type socialGroupsV2GroupRules_universal_d_ListTemplatesResponse = ListTemplatesResponse;\n const socialGroupsV2GroupRules_universal_d_listRules: typeof listRules;\n const socialGroupsV2GroupRules_universal_d_createOrReplaceAllRules: typeof createOrReplaceAllRules;\n type socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesOptions = CreateOrReplaceAllRulesOptions;\n const socialGroupsV2GroupRules_universal_d_listTemplates: typeof listTemplates;\n namespace socialGroupsV2GroupRules_universal_d {\n export {\n __debug$6 as __debug,\n socialGroupsV2GroupRules_universal_d_GroupRules as GroupRules,\n socialGroupsV2GroupRules_universal_d_GroupRule as GroupRule,\n socialGroupsV2GroupRules_universal_d_ListRulesRequest as ListRulesRequest,\n socialGroupsV2GroupRules_universal_d_ListRulesResponse as ListRulesResponse,\n socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesRequest as CreateOrReplaceAllRulesRequest,\n socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesResponse as CreateOrReplaceAllRulesResponse,\n socialGroupsV2GroupRules_universal_d_Empty as Empty,\n socialGroupsV2GroupRules_universal_d_ListTemplatesResponse as ListTemplatesResponse,\n socialGroupsV2GroupRules_universal_d_listRules as listRules,\n socialGroupsV2GroupRules_universal_d_createOrReplaceAllRules as createOrReplaceAllRules,\n socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesOptions as CreateOrReplaceAllRulesOptions,\n socialGroupsV2GroupRules_universal_d_listTemplates as listTemplates,\n };\n }\n \n const __debug$5: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Group$1 {\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 /**\n * __Deprecated.__ Use `privacyStatus` instead.\n * This property will be removed on June 30, 2022.\n */\n privacyLevel?: PrivacyStatus$1;\n /**\n * Group privacy status.\n * - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.\n * - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.\n * - `SECRET` - Only admins and members can see the group. New members can only be added by other members.\n */\n privacyStatus?: PrivacyStatus$1;\n /** @internal */\n accessRestriction?: AccessRestriction$1;\n /**\n * __Deprecated.__ Use `name` instead.\n * This property will be removed on June 30, 2022.\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group description in DraftJS format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * __Deprecated.__\n * For `details.logo`, use `coverImage` instead.\n * For `details.membersTitle`, `memberTitle` instead.\n * This property will be removed on June 30, 2022.\n */\n details?: GroupDetails$1;\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$1;\n /** Group specific settings. Available to the site owners under `Admin Tools` in the Business Manager. */\n settings?: GroupSettings$1;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * __Deprecated.__ Use `ownerId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n createdBy?: Identity$1;\n /**\n * Group owner.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Group creation date and time.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of the latest group update.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * __Deprecated.__ Use `lastActivityDate` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n recentActivityDate?: Date;\n /**\n * Date and time of the most recent group activity, for example a post or comment.\n * @readonly\n */\n lastActivityDate?: Date;\n /**\n * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | null;\n }\n enum Type$1 {\n UNKNOWN = \"UNKNOWN\",\n ADMIN_APPROVAL = \"ADMIN_APPROVAL\",\n PAID_PLANS = \"PAID_PLANS\",\n EVENTS = \"EVENTS\"\n }\n interface Events$1 {\n eventIds?: string[];\n }\n interface Logo$1 {\n /** Logo image ID (for internal use). */\n mediaId?: string | null;\n /**\n * Logo image file URL.\n * @internal\n */\n fileUrl?: string | null;\n /** Logo image width. */\n width?: number | null;\n /** Logo image height. */\n height?: number | null;\n }\n interface GroupDetailsPosition$1 {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n interface Image$1 {\n /** Image ID (for internal use). */\n mediaId?: string | null;\n /**\n * Image file URL.\n * @internal\n */\n fileUrl?: string | null;\n /** Image width. */\n width?: number | null;\n /** Image height. */\n height?: number | null;\n }\n interface Position$1 {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n enum PrivacyStatus$1 {\n UNKNOWN = \"UNKNOWN\",\n /** Anyone can see the group in the group list and view its content. Anyone can join. */\n PUBLIC = \"PUBLIC\",\n /** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */\n PRIVATE = \"PRIVATE\",\n /** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */\n SECRET = \"SECRET\"\n }\n interface AccessRestriction$1 extends AccessRestrictionDataOneOf$1 {\n type?: Type$1;\n events?: Events$1;\n }\n /** @oneof */\n interface AccessRestrictionDataOneOf$1 {\n events?: Events$1;\n }\n interface GroupDetails$1 {\n /** Group logo. You cannot upload your own logo. */\n logo?: Logo$1;\n /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */\n membersTitle?: string | null;\n /**\n * Position of the corner of the cover image (or logo).\n * @internal\n */\n logoPosition?: GroupDetailsPosition$1;\n /**\n * Position of the corner of the cover image (or logo) for mobile browser.\n * @internal\n */\n mobileLogoPosition?: GroupDetailsPosition$1;\n }\n interface CoverImage$1 {\n /** Cover image. */\n image?: Image$1;\n /** Position of the corner of the cover image (or logo). */\n position?: Position$1;\n /** Position of the corner of the cover image (or logo) for mobile browser. */\n mobilePosition?: Position$1;\n }\n interface GroupSettings$1 {\n /**\n * __Deprecated.__ Use `membersCanInvite` instead.\n * This property will be removed on June 30, 2022.\n */\n membersPermittedToInvite?: boolean | null;\n /**\n * Whether regular members are permitted to invite new members.\n * If `false`, only admins can invite members. Defaults to `true`.\n */\n membersCanInvite?: boolean | null;\n /**\n * __Deprecated.__ Use `membersCanApprove` instead.\n * This property will be removed on June 30, 2022.\n */\n membersPermittedToApprove?: boolean | null;\n /**\n * Whether all group members are permitted to approve join group requests.\n * If `false`, member approval is limited to the admins.\n */\n membersCanApprove?: boolean | null;\n /**\n * __Deprecated.__ Use `welcomeMemberPostEnabled` instead.\n * This property will be removed on June 30, 2022.\n */\n memberWelcomePostEnabled?: 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 /**\n * Whether an automatic post about added events is enabled.\n * @internal\n */\n eventAddedPostEnabled?: boolean | null;\n }\n interface Identity$1 {\n /** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n _id?: string | null;\n identityType?: IdentityType$1;\n }\n enum IdentityType$1 {\n USER = \"USER\",\n MEMBER = \"MEMBER\"\n }\n interface CreateGroupRequest {\n /** Group to create. */\n group?: Group$1;\n /** ID of the member who created the group. This member will automatically become an admin. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n creatorId?: string | null;\n /**\n * Group ID.\n * @internal\n */\n groupId?: string | null;\n }\n interface CreateGroupResponse {\n /** Created group. */\n group?: Group$1;\n }\n interface UpdateGroupRequest {\n /** Group to update. */\n group?: Group$1;\n }\n interface UpdateGroupResponse {\n /** Updated group. */\n group?: Group$1;\n }\n interface GroupCoverChanged {\n oldUrl?: string | null;\n newUrl?: string | null;\n }\n interface GroupDescriptionChanged {\n oldDescription?: string | null;\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$1;\n }\n interface GetGroupRequest {\n /** ID of the group to retrieve. */\n groupId: string;\n }\n interface GetGroupResponse {\n /** Retrieved group. */\n group?: Group$1;\n }\n interface GetGroupBySlugRequest {\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 }\n interface GetGroupBySlugResponse {\n /** Retrieved group. */\n group?: Group$1;\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 }\n interface ListGroupsResponse {\n /** Retrieved Groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n interface PagingMetadata$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. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListGroupsByUserIdRequest {\n }\n interface ListGroupsByUserIdResponse {\n groups?: GroupWithMsId[];\n }\n /** Retrieved Groups by metasite id */\n interface GroupWithMsId {\n metaSiteId?: string;\n groups?: Group$1[];\n }\n interface QueryGroupsRequest {\n query?: Query$3;\n }\n interface Query$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?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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 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$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 QueryGroupsResponse {\n /** Retrieved groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n interface QueryJoinedGroupsRequest {\n query?: Query$3;\n }\n interface QueryJoinedGroupsResponse {\n /** Retrieved groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n interface QueryGroupsByMembershipRequest {\n query?: Query$3;\n membershipStatus?: MembershipStatus$1;\n }\n enum MembershipStatus$1 {\n NONE = \"NONE\",\n JOINED = \"JOINED\",\n PENDING = \"PENDING\"\n }\n interface QueryGroupsByMembershipResponse {\n /** Retrieved groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n /**\n * Creates a group.\n * >**Notes:**\n * > + The site owners may not allow members to create groups.\n * > + Specify a `creatorId` to set the group's creator.\n * > + The group's creator will automatically become an admin.\n * @public\n * @documentationMaturity preview\n */\n function createGroup(options?: CreateGroupOptions): Promise;\n interface CreateGroupOptions {\n /** Group to create. */\n group?: Group$1;\n /** ID of the member who created the group. This member will automatically become an admin. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n creatorId?: string | null;\n /**\n * Group ID.\n * @internal\n */\n groupId?: string | null;\n }\n /**\n * Updates a group.\n * >**Note:**\n * > + Only admins can update a group.\n * > + When `group.privacyLevel` is updated from `PRIVATE` to `PUBLIC`, all pending group join requests are automatically approved.\n * > + When `group.privacyLevel` is updated from `PRIVATE` to `SECRET`, all pending group join requests are automatically rejected.\n * @param _id - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function updateGroup(_id: string | null, options?: UpdateGroupOptions): Promise;\n interface UpdateGroupOptions {\n 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 /**\n * __Deprecated.__ Use `privacyStatus` instead.\n * This property will be removed on June 30, 2022.\n */\n privacyLevel?: PrivacyStatus$1;\n /**\n * Group privacy status.\n * - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.\n * - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.\n * - `SECRET` - Only admins and members can see the group. New members can only be added by other members.\n */\n privacyStatus?: PrivacyStatus$1;\n /** @internal */\n accessRestriction?: AccessRestriction$1;\n /**\n * __Deprecated.__ Use `name` instead.\n * This property will be removed on June 30, 2022.\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group description in DraftJS format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * __Deprecated.__\n * For `details.logo`, use `coverImage` instead.\n * For `details.membersTitle`, `memberTitle` instead.\n * This property will be removed on June 30, 2022.\n */\n details?: GroupDetails$1;\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$1;\n /** Group specific settings. Available to the site owners under `Admin Tools` in the Business Manager. */\n settings?: GroupSettings$1;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * __Deprecated.__ Use `ownerId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n createdBy?: Identity$1;\n /**\n * Group owner.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Group creation date and time.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of the latest group update.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * __Deprecated.__ Use `lastActivityDate` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n recentActivityDate?: Date;\n /**\n * Date and time of the most recent group activity, for example a post or comment.\n * @readonly\n */\n lastActivityDate?: Date;\n /**\n * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | null;\n };\n }\n /**\n * Hides a group from the Group List or cancels group request.\n * >**Notes:**\n * > + Only admins can delete a group.\n * > + The group will no longer be visible in the live site or the Wix business manager.\n * > + It is not possible to restore the group via the [Update Group](https://dev.wix.com/api/rest/wix-groups/groups/group/update-group) endpoint into the live site.\n * > + It is still possible to retrieve the group via the [Get Group](https://dev.wix.com/api/rest/wix-groups/groups/group/get-group), [List Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/list-groups) and [Query Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/query-groups) endpoints.\n * @param groupId - ID of the group to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function deleteGroup(groupId: string): Promise;\n /**\n * Retrieves a group.\n * @param groupId - ID of the group to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function getGroup(groupId: string): Promise;\n /**\n * Retrieves a group by slug.\n * @param slug - 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 * @public\n * @documentationMaturity preview\n * @requiredField slug\n */\n function getGroupBySlug(slug: string): Promise;\n /**\n * Retrieves up to 100 groups.\n * @public\n * @documentationMaturity preview\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 }\n /**\n * Retrieves a list of all groups user is member of from all sites. Expects Wix User authorization.\n * Used in My Activity widget inside of Spaces App\n * @internal\n * @documentationMaturity preview\n */\n function listGroupsByUserId(): Promise;\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 * @public\n * @documentationMaturity preview\n */\n function queryGroups(options?: QueryGroupsOptions): Promise;\n interface QueryGroupsOptions {\n query?: Query$3;\n }\n /**\n * Retrieves groups that the current member has joined (deprecated, use `QueryGroupsByMembership`).\n * @internal\n * @documentationMaturity preview\n */\n function queryJoinedGroups(options?: QueryJoinedGroupsOptions): Promise;\n interface QueryJoinedGroupsOptions {\n query?: Query$3;\n }\n /**\n * Retrieves groups by membership status for the current member.\n * @internal\n * @documentationMaturity preview\n */\n function queryGroupsByMembership(options?: QueryGroupsByMembershipOptions): Promise;\n interface QueryGroupsByMembershipOptions {\n query?: Query$3;\n membershipStatus?: MembershipStatus$1;\n }\n \n type socialGroupsV2Group_universal_d_CreateGroupRequest = CreateGroupRequest;\n type socialGroupsV2Group_universal_d_CreateGroupResponse = CreateGroupResponse;\n type socialGroupsV2Group_universal_d_UpdateGroupRequest = UpdateGroupRequest;\n type socialGroupsV2Group_universal_d_UpdateGroupResponse = UpdateGroupResponse;\n type socialGroupsV2Group_universal_d_GroupCoverChanged = GroupCoverChanged;\n type socialGroupsV2Group_universal_d_GroupDescriptionChanged = GroupDescriptionChanged;\n type socialGroupsV2Group_universal_d_DeleteGroupRequest = DeleteGroupRequest;\n type socialGroupsV2Group_universal_d_DeleteGroupResponse = DeleteGroupResponse;\n type socialGroupsV2Group_universal_d_GetGroupRequest = GetGroupRequest;\n type socialGroupsV2Group_universal_d_GetGroupResponse = GetGroupResponse;\n type socialGroupsV2Group_universal_d_GetGroupBySlugRequest = GetGroupBySlugRequest;\n type socialGroupsV2Group_universal_d_GetGroupBySlugResponse = GetGroupBySlugResponse;\n type socialGroupsV2Group_universal_d_ListGroupsRequest = ListGroupsRequest;\n type socialGroupsV2Group_universal_d_ListGroupsResponse = ListGroupsResponse;\n type socialGroupsV2Group_universal_d_ListGroupsByUserIdRequest = ListGroupsByUserIdRequest;\n type socialGroupsV2Group_universal_d_ListGroupsByUserIdResponse = ListGroupsByUserIdResponse;\n type socialGroupsV2Group_universal_d_GroupWithMsId = GroupWithMsId;\n type socialGroupsV2Group_universal_d_QueryGroupsRequest = QueryGroupsRequest;\n type socialGroupsV2Group_universal_d_QueryGroupsResponse = QueryGroupsResponse;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsRequest = QueryJoinedGroupsRequest;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsResponse = QueryJoinedGroupsResponse;\n type socialGroupsV2Group_universal_d_QueryGroupsByMembershipRequest = QueryGroupsByMembershipRequest;\n type socialGroupsV2Group_universal_d_QueryGroupsByMembershipResponse = QueryGroupsByMembershipResponse;\n const socialGroupsV2Group_universal_d_createGroup: typeof createGroup;\n type socialGroupsV2Group_universal_d_CreateGroupOptions = CreateGroupOptions;\n const socialGroupsV2Group_universal_d_updateGroup: typeof updateGroup;\n type socialGroupsV2Group_universal_d_UpdateGroupOptions = UpdateGroupOptions;\n const socialGroupsV2Group_universal_d_deleteGroup: typeof deleteGroup;\n const socialGroupsV2Group_universal_d_getGroup: typeof getGroup;\n const socialGroupsV2Group_universal_d_getGroupBySlug: typeof getGroupBySlug;\n const socialGroupsV2Group_universal_d_listGroups: typeof listGroups;\n type socialGroupsV2Group_universal_d_ListGroupsOptions = ListGroupsOptions;\n const socialGroupsV2Group_universal_d_listGroupsByUserId: typeof listGroupsByUserId;\n const socialGroupsV2Group_universal_d_queryGroups: typeof queryGroups;\n type socialGroupsV2Group_universal_d_QueryGroupsOptions = QueryGroupsOptions;\n const socialGroupsV2Group_universal_d_queryJoinedGroups: typeof queryJoinedGroups;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsOptions = QueryJoinedGroupsOptions;\n const socialGroupsV2Group_universal_d_queryGroupsByMembership: typeof queryGroupsByMembership;\n type socialGroupsV2Group_universal_d_QueryGroupsByMembershipOptions = QueryGroupsByMembershipOptions;\n namespace socialGroupsV2Group_universal_d {\n export {\n __debug$5 as __debug,\n Group$1 as Group,\n Type$1 as Type,\n Events$1 as Events,\n Logo$1 as Logo,\n GroupDetailsPosition$1 as GroupDetailsPosition,\n Image$1 as Image,\n Position$1 as Position,\n PrivacyStatus$1 as PrivacyStatus,\n AccessRestriction$1 as AccessRestriction,\n AccessRestrictionDataOneOf$1 as AccessRestrictionDataOneOf,\n GroupDetails$1 as GroupDetails,\n CoverImage$1 as CoverImage,\n GroupSettings$1 as GroupSettings,\n Identity$1 as Identity,\n IdentityType$1 as IdentityType,\n socialGroupsV2Group_universal_d_CreateGroupRequest as CreateGroupRequest,\n socialGroupsV2Group_universal_d_CreateGroupResponse as CreateGroupResponse,\n socialGroupsV2Group_universal_d_UpdateGroupRequest as UpdateGroupRequest,\n socialGroupsV2Group_universal_d_UpdateGroupResponse as UpdateGroupResponse,\n socialGroupsV2Group_universal_d_GroupCoverChanged as GroupCoverChanged,\n socialGroupsV2Group_universal_d_GroupDescriptionChanged as GroupDescriptionChanged,\n socialGroupsV2Group_universal_d_DeleteGroupRequest as DeleteGroupRequest,\n socialGroupsV2Group_universal_d_DeleteGroupResponse as DeleteGroupResponse,\n socialGroupsV2Group_universal_d_GetGroupRequest as GetGroupRequest,\n socialGroupsV2Group_universal_d_GetGroupResponse as GetGroupResponse,\n socialGroupsV2Group_universal_d_GetGroupBySlugRequest as GetGroupBySlugRequest,\n socialGroupsV2Group_universal_d_GetGroupBySlugResponse as GetGroupBySlugResponse,\n socialGroupsV2Group_universal_d_ListGroupsRequest as ListGroupsRequest,\n socialGroupsV2Group_universal_d_ListGroupsResponse as ListGroupsResponse,\n PagingMetadata$4 as PagingMetadata,\n socialGroupsV2Group_universal_d_ListGroupsByUserIdRequest as ListGroupsByUserIdRequest,\n socialGroupsV2Group_universal_d_ListGroupsByUserIdResponse as ListGroupsByUserIdResponse,\n socialGroupsV2Group_universal_d_GroupWithMsId as GroupWithMsId,\n socialGroupsV2Group_universal_d_QueryGroupsRequest as QueryGroupsRequest,\n Query$3 as Query,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n Paging$4 as Paging,\n socialGroupsV2Group_universal_d_QueryGroupsResponse as QueryGroupsResponse,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsRequest as QueryJoinedGroupsRequest,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsResponse as QueryJoinedGroupsResponse,\n socialGroupsV2Group_universal_d_QueryGroupsByMembershipRequest as QueryGroupsByMembershipRequest,\n MembershipStatus$1 as MembershipStatus,\n socialGroupsV2Group_universal_d_QueryGroupsByMembershipResponse as QueryGroupsByMembershipResponse,\n socialGroupsV2Group_universal_d_createGroup as createGroup,\n socialGroupsV2Group_universal_d_CreateGroupOptions as CreateGroupOptions,\n socialGroupsV2Group_universal_d_updateGroup as updateGroup,\n socialGroupsV2Group_universal_d_UpdateGroupOptions as UpdateGroupOptions,\n socialGroupsV2Group_universal_d_deleteGroup as deleteGroup,\n socialGroupsV2Group_universal_d_getGroup as getGroup,\n socialGroupsV2Group_universal_d_getGroupBySlug as getGroupBySlug,\n socialGroupsV2Group_universal_d_listGroups as listGroups,\n socialGroupsV2Group_universal_d_ListGroupsOptions as ListGroupsOptions,\n socialGroupsV2Group_universal_d_listGroupsByUserId as listGroupsByUserId,\n socialGroupsV2Group_universal_d_queryGroups as queryGroups,\n socialGroupsV2Group_universal_d_QueryGroupsOptions as QueryGroupsOptions,\n socialGroupsV2Group_universal_d_queryJoinedGroups as queryJoinedGroups,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsOptions as QueryJoinedGroupsOptions,\n socialGroupsV2Group_universal_d_queryGroupsByMembership as queryGroupsByMembership,\n socialGroupsV2Group_universal_d_QueryGroupsByMembershipOptions as QueryGroupsByMembershipOptions,\n };\n }\n \n const __debug$4: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface GroupMember$1 {\n /**\n * __Deprecated.__ Use `memberId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n siteMemberId?: string;\n /**\n * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.\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 * @internal\n * @readonly\n */\n contactId?: string | null;\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 * Member's role.\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 /** 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$2[];\n autoInviteId?: string | null;\n }\n /** Answer to a membership question. */\n interface MembershipQuestionAnswer$2 {\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 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 * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberIds?: string[];\n /**\n * Whether to send invitations to private site members. Defaults to `true`.\n * @internal\n */\n invitePrivateMembers?: boolean | null;\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 /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\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 items to skip in the current sort order. */\n offset?: number | null;\n /**\n * Return members who left groups (internal, used for history in analytics)\n * @internal\n */\n includeDeleted?: boolean;\n }\n interface ListGroupMembersResponse {\n /** Retrieved members. */\n members?: GroupMember$1[];\n metadata?: PagingMetadata$3;\n }\n interface PagingMetadata$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. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | 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 * @internal\n */\n hasNext?: 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$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 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$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 QueryGroupMembersResponse {\n /** Group members. */\n members?: GroupMember$1[];\n metadata?: PagingMetadata$3;\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 /**\n * __Deprecated.__ Use `memberId` instead.\n * This parameter will be removed on June 30, 2022.\n * @internal\n */\n siteMemberId?: string | null;\n /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberId: string | null;\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 ListMembershipsResponse {\n /** Site member's memberships. */\n memberships?: Membership[];\n metadata?: PagingMetadata$3;\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;\n /** Group member role. When membership status is not `JOINED`, this is empty. */\n role?: GroupRole$1;\n }\n enum MembershipStatus {\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 /**\n * __Deprecated.__ Use the `memberId` path parameter instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberId?: string | null;\n /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberId: string | null;\n query?: Query$2;\n }\n interface QueryMembershipsResponse {\n /** Site member's memberships. */\n memberships?: Membership[];\n metadata?: PagingMetadata$3;\n }\n /**\n * Join a specific group.\n * Site owners can use it for groups with any privacy level and automatically receives `ADMIN` group role. A site member can use it only for public groups.\n * This endpoint doesn't support server signing.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function joinGroup(groupId: string, options?: JoinGroupOptions): Promise;\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$2[];\n autoInviteId?: string | null;\n }\n /**\n * Leave a group.\n * This endpoint doesn't support server signing.\n * @param groupId - ID of the Group to leave.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function leaveGroup(groupId: string): Promise;\n /**\n * Add site members to a specific group.\n * Admins always have access to this functionality. Site owners may allow members to use this functionality as well.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function addGroupMembers(groupId: string, options?: AddGroupMembersOptions): Promise;\n interface AddGroupMembersOptions {\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberIds?: string[];\n /**\n * Whether to send invitations to private site members. Defaults to `true`.\n * @internal\n */\n invitePrivateMembers?: boolean | null;\n }\n /**\n * Removes site members from a specific group.\n * Only admins have can remove members from a group.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function removeGroupMembers(groupId: string, options?: RemoveGroupMembersOptions): Promise;\n interface RemoveGroupMembersOptions {\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberIds?: string[];\n }\n /**\n * Retrieves a list of up to 100 group members, given the provided paging.\n * Groups mangers can retrieve group members of any group.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function listGroupMembers(groupId: string, options?: ListGroupMembersOptions): Promise;\n interface ListGroupMembersOptions {\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 /**\n * Return members who left groups (internal, used for history in analytics)\n * @internal\n */\n includeDeleted?: boolean;\n }\n /**\n * Retrieves a list of up to 100 group members, given the provided paging, sorting and filtering.\n * Groups mangers can retrieve group members of any group.\n *\n * Supported fields for filtering:\n * - `role`\n *\n * Supported fields for sorting:\n * - `joinedOn`\n * - `role`\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function queryGroupMembers(groupId: string, options?: QueryGroupMembersOptions): Promise;\n interface QueryGroupMembersOptions {\n query?: Query$2;\n }\n /**\n * Don't expose to 3rd parties! (Use GroupMembersWithProfilesService.QueryNonGroupMembersWithProfiles)\n * @param groupId - Group ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function queryNonGroupMembers(groupId: string, options?: QueryNonGroupMembersOptions): Promise;\n interface QueryNonGroupMembersOptions {\n query?: Query$2;\n }\n /**\n * Retrieves a list of up to 100 members and their membership status, given the provided paging.\n * Groups mangers can see all memberships for any group.\n * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n */\n function listMemberships(memberId: string | null, options?: ListMembershipsOptions): Promise;\n interface ListMembershipsOptions {\n /**\n * __Deprecated.__ Use `memberId` instead.\n * This parameter will be removed on June 30, 2022.\n * @internal\n */\n siteMemberId?: string | null;\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 * Retrieves a list of up to 100 members and their membership status, given the provided paging and filtering.\n * Groups mangers can see all memberships for any group.\n *\n * Supported fields for filtering:\n * - `role`\n * - `status`\n *\n * No supported fields for sorting.\n * @param memberId - Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n */\n function queryMemberships(memberId: string | null, options?: QueryMembershipsOptions): Promise;\n interface QueryMembershipsOptions {\n /**\n * __Deprecated.__ Use the `memberId` path parameter instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberId?: string | null;\n query?: Query$2;\n }\n \n type socialGroupsV2GroupMember_universal_d_JoinRequest = JoinRequest;\n type socialGroupsV2GroupMember_universal_d_JoinResponse = JoinResponse;\n type socialGroupsV2GroupMember_universal_d_MemberJoined = MemberJoined;\n type socialGroupsV2GroupMember_universal_d_LeaveRequest = LeaveRequest;\n type socialGroupsV2GroupMember_universal_d_LeaveResponse = LeaveResponse;\n type socialGroupsV2GroupMember_universal_d_MemberLeft = MemberLeft;\n type socialGroupsV2GroupMember_universal_d_AddGroupMembersRequest = AddGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_AddGroupMembersResponse = AddGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_MemberAdded = MemberAdded;\n type socialGroupsV2GroupMember_universal_d_RemoveGroupMembersRequest = RemoveGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_RemoveGroupMembersResponse = RemoveGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_MemberRemoved = MemberRemoved;\n type socialGroupsV2GroupMember_universal_d_ListGroupMembersRequest = ListGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_ListGroupMembersResponse = ListGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_QueryGroupMembersRequest = QueryGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_QueryGroupMembersResponse = QueryGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersRequest = QueryNonGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersResponse = QueryNonGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_ListMembershipsRequest = ListMembershipsRequest;\n type socialGroupsV2GroupMember_universal_d_ListMembershipsResponse = ListMembershipsResponse;\n type socialGroupsV2GroupMember_universal_d_Membership = Membership;\n type socialGroupsV2GroupMember_universal_d_MembershipStatus = MembershipStatus;\n const socialGroupsV2GroupMember_universal_d_MembershipStatus: typeof MembershipStatus;\n type socialGroupsV2GroupMember_universal_d_QueryMembershipsRequest = QueryMembershipsRequest;\n type socialGroupsV2GroupMember_universal_d_QueryMembershipsResponse = QueryMembershipsResponse;\n const socialGroupsV2GroupMember_universal_d_joinGroup: typeof joinGroup;\n type socialGroupsV2GroupMember_universal_d_JoinGroupOptions = JoinGroupOptions;\n const socialGroupsV2GroupMember_universal_d_leaveGroup: typeof leaveGroup;\n const socialGroupsV2GroupMember_universal_d_addGroupMembers: typeof addGroupMembers;\n type socialGroupsV2GroupMember_universal_d_AddGroupMembersOptions = AddGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_removeGroupMembers: typeof removeGroupMembers;\n type socialGroupsV2GroupMember_universal_d_RemoveGroupMembersOptions = RemoveGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_listGroupMembers: typeof listGroupMembers;\n type socialGroupsV2GroupMember_universal_d_ListGroupMembersOptions = ListGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_queryGroupMembers: typeof queryGroupMembers;\n type socialGroupsV2GroupMember_universal_d_QueryGroupMembersOptions = QueryGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_queryNonGroupMembers: typeof queryNonGroupMembers;\n type socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersOptions = QueryNonGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_listMemberships: typeof listMemberships;\n type socialGroupsV2GroupMember_universal_d_ListMembershipsOptions = ListMembershipsOptions;\n const socialGroupsV2GroupMember_universal_d_queryMemberships: typeof queryMemberships;\n type socialGroupsV2GroupMember_universal_d_QueryMembershipsOptions = QueryMembershipsOptions;\n namespace socialGroupsV2GroupMember_universal_d {\n export {\n __debug$4 as __debug,\n GroupMember$1 as GroupMember,\n GroupRole$1 as GroupRole,\n Role$1 as Role,\n socialGroupsV2GroupMember_universal_d_JoinRequest as JoinRequest,\n MembershipQuestionAnswer$2 as MembershipQuestionAnswer,\n socialGroupsV2GroupMember_universal_d_JoinResponse as JoinResponse,\n socialGroupsV2GroupMember_universal_d_MemberJoined as MemberJoined,\n socialGroupsV2GroupMember_universal_d_LeaveRequest as LeaveRequest,\n socialGroupsV2GroupMember_universal_d_LeaveResponse as LeaveResponse,\n socialGroupsV2GroupMember_universal_d_MemberLeft as MemberLeft,\n socialGroupsV2GroupMember_universal_d_AddGroupMembersRequest as AddGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_AddGroupMembersResponse as AddGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_MemberAdded as MemberAdded,\n socialGroupsV2GroupMember_universal_d_RemoveGroupMembersRequest as RemoveGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_RemoveGroupMembersResponse as RemoveGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_MemberRemoved as MemberRemoved,\n socialGroupsV2GroupMember_universal_d_ListGroupMembersRequest as ListGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_ListGroupMembersResponse as ListGroupMembersResponse,\n PagingMetadata$3 as PagingMetadata,\n socialGroupsV2GroupMember_universal_d_QueryGroupMembersRequest as QueryGroupMembersRequest,\n Query$2 as Query,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n Paging$3 as Paging,\n socialGroupsV2GroupMember_universal_d_QueryGroupMembersResponse as QueryGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersRequest as QueryNonGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersResponse as QueryNonGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_ListMembershipsRequest as ListMembershipsRequest,\n socialGroupsV2GroupMember_universal_d_ListMembershipsResponse as ListMembershipsResponse,\n socialGroupsV2GroupMember_universal_d_Membership as Membership,\n socialGroupsV2GroupMember_universal_d_MembershipStatus as MembershipStatus,\n socialGroupsV2GroupMember_universal_d_QueryMembershipsRequest as QueryMembershipsRequest,\n socialGroupsV2GroupMember_universal_d_QueryMembershipsResponse as QueryMembershipsResponse,\n socialGroupsV2GroupMember_universal_d_joinGroup as joinGroup,\n socialGroupsV2GroupMember_universal_d_JoinGroupOptions as JoinGroupOptions,\n socialGroupsV2GroupMember_universal_d_leaveGroup as leaveGroup,\n socialGroupsV2GroupMember_universal_d_addGroupMembers as addGroupMembers,\n socialGroupsV2GroupMember_universal_d_AddGroupMembersOptions as AddGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_removeGroupMembers as removeGroupMembers,\n socialGroupsV2GroupMember_universal_d_RemoveGroupMembersOptions as RemoveGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_listGroupMembers as listGroupMembers,\n socialGroupsV2GroupMember_universal_d_ListGroupMembersOptions as ListGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_queryGroupMembers as queryGroupMembers,\n socialGroupsV2GroupMember_universal_d_QueryGroupMembersOptions as QueryGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_queryNonGroupMembers as queryNonGroupMembers,\n socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersOptions as QueryNonGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_listMemberships as listMemberships,\n socialGroupsV2GroupMember_universal_d_ListMembershipsOptions as ListMembershipsOptions,\n socialGroupsV2GroupMember_universal_d_queryMemberships as queryMemberships,\n socialGroupsV2GroupMember_universal_d_QueryMembershipsOptions as QueryMembershipsOptions,\n };\n }\n \n const __debug$3: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * >**Notes:**\n * > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.\n * > + In this situation, site members have to submit a Group Request to create a new group.\n * > + Group Requests can be approved or rejected by an admin.\n * > + After a Group Request has been approved, the new group is added to the Group List in the Wix Groups app home page.\n * > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.\n */\n interface GroupRequest {\n /**\n * Group request ID\n * @readonly\n */\n _id?: string | null;\n /** Group requested for creation. */\n group?: Group;\n /**\n * Status of group request.\n * - `PENDING` - Pending group request.\n * - `APPROVED` - Approved group request.\n * - `REJECTED` - Rejected group request.\n * - `CANCELED` - Canceled group request.\n */\n status?: RequestStatus$1;\n /** Group request details. */\n requestDetails?: RequestDetails$1;\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 /**\n * __Deprecated.__ Use `privacyStatus` instead.\n * This property will be removed on June 30, 2022.\n */\n privacyLevel?: PrivacyStatus;\n /**\n * Group privacy status.\n * - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.\n * - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.\n * - `SECRET` - Only admins and members can see the group. New members can only be added by other members.\n */\n privacyStatus?: PrivacyStatus;\n /** @internal */\n accessRestriction?: AccessRestriction;\n /**\n * __Deprecated.__ Use `name` instead.\n * This property will be removed on June 30, 2022.\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group description in DraftJS format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * __Deprecated.__\n * For `details.logo`, use `coverImage` instead.\n * For `details.membersTitle`, `memberTitle` instead.\n * This property will be removed on June 30, 2022.\n */\n details?: GroupDetails;\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 /** Group specific settings. Available to the site owners under `Admin Tools` in the Business Manager. */\n settings?: GroupSettings;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * __Deprecated.__ Use `ownerId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n createdBy?: Identity;\n /**\n * Group owner.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Group creation date and time.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of the latest group update.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * __Deprecated.__ Use `lastActivityDate` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n recentActivityDate?: Date;\n /**\n * Date and time of the most recent group activity, for example a post or comment.\n * @readonly\n */\n lastActivityDate?: Date;\n /**\n * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | 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 /**\n * Logo image file URL.\n * @internal\n */\n fileUrl?: 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 /**\n * Image file URL.\n * @internal\n */\n fileUrl?: string | null;\n /** Image width. */\n width?: number | null;\n /** Image height. */\n height?: number | null;\n }\n interface Position {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n enum PrivacyStatus {\n UNKNOWN = \"UNKNOWN\",\n /** Anyone can see the group in the group list and view its content. Anyone can join. */\n PUBLIC = \"PUBLIC\",\n /** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */\n PRIVATE = \"PRIVATE\",\n /** Only group members and admins can see the group in the group list. New group members can only be added by existing group members. */\n SECRET = \"SECRET\"\n }\n interface AccessRestriction extends AccessRestrictionDataOneOf {\n type?: Type;\n events?: Events;\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 * Position of the corner of the cover image (or logo).\n * @internal\n */\n logoPosition?: GroupDetailsPosition;\n /**\n * Position of the corner of the cover image (or logo) for mobile browser.\n * @internal\n */\n mobileLogoPosition?: GroupDetailsPosition;\n }\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 interface GroupSettings {\n /**\n * __Deprecated.__ Use `membersCanInvite` instead.\n * This property will be removed on June 30, 2022.\n */\n membersPermittedToInvite?: boolean | null;\n /**\n * Whether regular members are permitted to invite new members.\n * If `false`, only admins can invite members. Defaults to `true`.\n */\n membersCanInvite?: boolean | null;\n /**\n * __Deprecated.__ Use `membersCanApprove` instead.\n * This property will be removed on June 30, 2022.\n */\n membersPermittedToApprove?: boolean | null;\n /**\n * Whether all group members are permitted to approve join group requests.\n * If `false`, member approval is limited to the admins.\n */\n membersCanApprove?: boolean | null;\n /**\n * __Deprecated.__ Use `welcomeMemberPostEnabled` instead.\n * This property will be removed on June 30, 2022.\n */\n memberWelcomePostEnabled?: 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 /**\n * Whether an automatic post about added events is enabled.\n * @internal\n */\n eventAddedPostEnabled?: boolean | null;\n }\n interface Identity {\n /** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n _id?: string | null;\n identityType?: IdentityType;\n }\n enum IdentityType {\n USER = \"USER\",\n MEMBER = \"MEMBER\"\n }\n enum RequestStatus$1 {\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$1 {\n /** Reason the request has been rejected. */\n rejectionReason?: string | null;\n }\n interface SubmitGroupRequestRequest {\n /** Group submitted for creation. */\n group?: Group;\n }\n interface SubmitGroupRequestResponse {\n /** Submitted Group Request. */\n groupRequest?: GroupRequest;\n }\n interface ApproveGroupRequestsRequest {\n /**\n * Which items to approve.\n * @internal\n */\n itemsToApprove?: ItemsToUpdate$1;\n /** Group Request IDs to approve. Limited to `100`. */\n groupRequestIds?: string[];\n }\n enum ItemsToUpdate$1 {\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 ApproveGroupRequestsResponse {\n /** Approved Group Requests. */\n groupRequest?: GroupRequest[];\n }\n interface GroupRequestApproved {\n /** Approved group request. */\n groupRequest?: GroupRequest;\n }\n interface RejectGroupRequestsRequest {\n /**\n * Which items to reject.\n * @internal\n */\n itemsToReject?: ItemsToUpdate$1;\n /** Rejection data. */\n rejections?: Rejection$1[];\n }\n interface Rejection$1 {\n /** ID of the Group Request to reject. */\n groupRequestId?: string;\n /** Rejection reason. Free text displayed to the creator of the rejected Group Request. Limited to 1,000 characters. */\n reason?: string | null;\n }\n interface RejectGroupRequestsResponse {\n /** Rejected Group Requests. */\n groupRequest?: GroupRequest[];\n }\n interface GroupRequestRejected {\n /** Rejected group request. */\n groupRequest?: GroupRequest;\n }\n interface CancelGroupRequestRequest {\n /** ID of the Group Request to cancel. */\n groupRequestId: string;\n }\n interface CancelGroupRequestResponse {\n /** Canceled Group Request. */\n groupRequest?: GroupRequest;\n }\n interface ListGroupRequestsRequest {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All Group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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 }\n enum OwnershipFilter$1 {\n /** All items. */\n ALL = \"ALL\",\n /** Items for current site member. */\n CURRENT_MEMBER = \"CURRENT_MEMBER\"\n }\n interface ListGroupRequestsResponse {\n /** Group Requests. */\n groupRequests?: GroupRequest[];\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryGroupRequestsRequest {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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$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$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$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 QueryGroupRequestsResponse {\n /** Retrieved Group Requests. */\n groupRequests?: GroupRequest[];\n metadata?: PagingMetadata$2;\n }\n /**\n * Submit a group request.\n * Can be used in case `GroupsAppSettings.create_groups_policy` = `MEMBERS_WITH_APPROVAL`.\n * This endpoint doesn't support server signing.\n * @internal\n * @documentationMaturity preview\n */\n function submitGroupRequest(options?: SubmitGroupRequestOptions): Promise;\n interface SubmitGroupRequestOptions {\n /** Group submitted for creation. */\n group?: Group;\n }\n /**\n * Approves Group Requests.\n * Only admins can approve Group Requests.\n * @public\n * @documentationMaturity preview\n */\n function approveGroupRequests(options?: ApproveGroupRequestsOptions): Promise;\n interface ApproveGroupRequestsOptions {\n /**\n * Which items to approve.\n * @internal\n */\n itemsToApprove?: ItemsToUpdate$1;\n /** Group Request IDs to approve. Limited to `100`. */\n groupRequestIds?: string[];\n }\n /**\n * Rejects Group Requests.\n * Only admins can reject Group Requests.\n * @public\n * @documentationMaturity preview\n */\n function rejectGroupRequests(options?: RejectGroupRequestsOptions): Promise;\n interface RejectGroupRequestsOptions {\n /**\n * Which items to reject.\n * @internal\n */\n itemsToReject?: ItemsToUpdate$1;\n /** Rejection data. */\n rejections?: Rejection$1[];\n }\n /**\n * Cancels a Group Request.\n * Group managers always have access to this functionality. Site members can cancel their own group requests.\n * This endpoint doesn't support server signing.\n * @param groupRequestId - ID of the Group Request to cancel.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupRequestId\n */\n function cancelGroupRequest(groupRequestId: string): Promise;\n /**\n * Lists group requests across the site.\n * @public\n * @documentationMaturity preview\n */\n function listGroupRequests(options?: ListGroupRequestsOptions): Promise;\n interface ListGroupRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All Group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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 }\n /**\n * Retrieves a list of groups requests across the site.\n *\n * Supported fields for filtering:\n * - `status`\n *\n * Supported fields for sorting:\n * - `createdDate`\n * @public\n * @documentationMaturity preview\n */\n function queryGroupRequests(options?: QueryGroupRequestsOptions): Promise;\n interface QueryGroupRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\n query?: Query$1;\n }\n \n type socialGroupsV2GroupRequest_universal_d_GroupRequest = GroupRequest;\n type socialGroupsV2GroupRequest_universal_d_Group = Group;\n type socialGroupsV2GroupRequest_universal_d_Type = Type;\n const socialGroupsV2GroupRequest_universal_d_Type: typeof Type;\n type socialGroupsV2GroupRequest_universal_d_Events = Events;\n type socialGroupsV2GroupRequest_universal_d_Logo = Logo;\n type socialGroupsV2GroupRequest_universal_d_GroupDetailsPosition = GroupDetailsPosition;\n type socialGroupsV2GroupRequest_universal_d_Image = Image;\n type socialGroupsV2GroupRequest_universal_d_Position = Position;\n type socialGroupsV2GroupRequest_universal_d_PrivacyStatus = PrivacyStatus;\n const socialGroupsV2GroupRequest_universal_d_PrivacyStatus: typeof PrivacyStatus;\n type socialGroupsV2GroupRequest_universal_d_AccessRestriction = AccessRestriction;\n type socialGroupsV2GroupRequest_universal_d_AccessRestrictionDataOneOf = AccessRestrictionDataOneOf;\n type socialGroupsV2GroupRequest_universal_d_GroupDetails = GroupDetails;\n type socialGroupsV2GroupRequest_universal_d_CoverImage = CoverImage;\n type socialGroupsV2GroupRequest_universal_d_GroupSettings = GroupSettings;\n type socialGroupsV2GroupRequest_universal_d_Identity = Identity;\n type socialGroupsV2GroupRequest_universal_d_IdentityType = IdentityType;\n const socialGroupsV2GroupRequest_universal_d_IdentityType: typeof IdentityType;\n type socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestRequest = SubmitGroupRequestRequest;\n type socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestResponse = SubmitGroupRequestResponse;\n type socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsRequest = ApproveGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsResponse = ApproveGroupRequestsResponse;\n type socialGroupsV2GroupRequest_universal_d_GroupRequestApproved = GroupRequestApproved;\n type socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsRequest = RejectGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsResponse = RejectGroupRequestsResponse;\n type socialGroupsV2GroupRequest_universal_d_GroupRequestRejected = GroupRequestRejected;\n type socialGroupsV2GroupRequest_universal_d_CancelGroupRequestRequest = CancelGroupRequestRequest;\n type socialGroupsV2GroupRequest_universal_d_CancelGroupRequestResponse = CancelGroupRequestResponse;\n type socialGroupsV2GroupRequest_universal_d_ListGroupRequestsRequest = ListGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_ListGroupRequestsResponse = ListGroupRequestsResponse;\n type socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsRequest = QueryGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsResponse = QueryGroupRequestsResponse;\n const socialGroupsV2GroupRequest_universal_d_submitGroupRequest: typeof submitGroupRequest;\n type socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestOptions = SubmitGroupRequestOptions;\n const socialGroupsV2GroupRequest_universal_d_approveGroupRequests: typeof approveGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsOptions = ApproveGroupRequestsOptions;\n const socialGroupsV2GroupRequest_universal_d_rejectGroupRequests: typeof rejectGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsOptions = RejectGroupRequestsOptions;\n const socialGroupsV2GroupRequest_universal_d_cancelGroupRequest: typeof cancelGroupRequest;\n const socialGroupsV2GroupRequest_universal_d_listGroupRequests: typeof listGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_ListGroupRequestsOptions = ListGroupRequestsOptions;\n const socialGroupsV2GroupRequest_universal_d_queryGroupRequests: typeof queryGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsOptions = QueryGroupRequestsOptions;\n namespace socialGroupsV2GroupRequest_universal_d {\n export {\n __debug$3 as __debug,\n socialGroupsV2GroupRequest_universal_d_GroupRequest as GroupRequest,\n socialGroupsV2GroupRequest_universal_d_Group as Group,\n socialGroupsV2GroupRequest_universal_d_Type as Type,\n socialGroupsV2GroupRequest_universal_d_Events as Events,\n socialGroupsV2GroupRequest_universal_d_Logo as Logo,\n socialGroupsV2GroupRequest_universal_d_GroupDetailsPosition as GroupDetailsPosition,\n socialGroupsV2GroupRequest_universal_d_Image as Image,\n socialGroupsV2GroupRequest_universal_d_Position as Position,\n socialGroupsV2GroupRequest_universal_d_PrivacyStatus as PrivacyStatus,\n socialGroupsV2GroupRequest_universal_d_AccessRestriction as AccessRestriction,\n socialGroupsV2GroupRequest_universal_d_AccessRestrictionDataOneOf as AccessRestrictionDataOneOf,\n socialGroupsV2GroupRequest_universal_d_GroupDetails as GroupDetails,\n socialGroupsV2GroupRequest_universal_d_CoverImage as CoverImage,\n socialGroupsV2GroupRequest_universal_d_GroupSettings as GroupSettings,\n socialGroupsV2GroupRequest_universal_d_Identity as Identity,\n socialGroupsV2GroupRequest_universal_d_IdentityType as IdentityType,\n RequestStatus$1 as RequestStatus,\n RequestDetails$1 as RequestDetails,\n socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestRequest as SubmitGroupRequestRequest,\n socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestResponse as SubmitGroupRequestResponse,\n socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsRequest as ApproveGroupRequestsRequest,\n ItemsToUpdate$1 as ItemsToUpdate,\n socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsResponse as ApproveGroupRequestsResponse,\n socialGroupsV2GroupRequest_universal_d_GroupRequestApproved as GroupRequestApproved,\n socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsRequest as RejectGroupRequestsRequest,\n Rejection$1 as Rejection,\n socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsResponse as RejectGroupRequestsResponse,\n socialGroupsV2GroupRequest_universal_d_GroupRequestRejected as GroupRequestRejected,\n socialGroupsV2GroupRequest_universal_d_CancelGroupRequestRequest as CancelGroupRequestRequest,\n socialGroupsV2GroupRequest_universal_d_CancelGroupRequestResponse as CancelGroupRequestResponse,\n socialGroupsV2GroupRequest_universal_d_ListGroupRequestsRequest as ListGroupRequestsRequest,\n OwnershipFilter$1 as OwnershipFilter,\n socialGroupsV2GroupRequest_universal_d_ListGroupRequestsResponse as ListGroupRequestsResponse,\n PagingMetadata$2 as PagingMetadata,\n socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsRequest as QueryGroupRequestsRequest,\n Query$1 as Query,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$2 as Paging,\n socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsResponse as QueryGroupRequestsResponse,\n socialGroupsV2GroupRequest_universal_d_submitGroupRequest as submitGroupRequest,\n socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestOptions as SubmitGroupRequestOptions,\n socialGroupsV2GroupRequest_universal_d_approveGroupRequests as approveGroupRequests,\n socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsOptions as ApproveGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_rejectGroupRequests as rejectGroupRequests,\n socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsOptions as RejectGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_cancelGroupRequest as cancelGroupRequest,\n socialGroupsV2GroupRequest_universal_d_listGroupRequests as listGroupRequests,\n socialGroupsV2GroupRequest_universal_d_ListGroupRequestsOptions as ListGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_queryGroupRequests as queryGroupRequests,\n socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsOptions as QueryGroupRequestsOptions,\n };\n }\n \n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 /**\n * Member's role.\n * - `MEMBER` - Regular group member.\n * - `ADMIN` - Group administrator.\n */\n value?: Role;\n }\n enum 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 /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberIds?: string[];\n /** Role to assign. */\n role?: GroupRole;\n }\n interface AssignRoleResponse {\n /** Group ID. */\n groupId?: string;\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) 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 * __Deprecated.__ Use `memberId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n siteMemberId?: string;\n /**\n * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) 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;\n /**\n * @internal\n * @readonly\n */\n contactId?: string | null;\n }\n interface UnassignRoleRequest {\n /** Group ID. */\n groupId: string;\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) 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 [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n siteMemberIds?: string[];\n /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) 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 /**\n * Assigns a specific role to members.\n * >**Notes:**\n * > + Only admins can assign roles.\n * > + You cannot create new members via this endpoint.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function assignRole(groupId: string, options?: AssignRoleOptions): Promise;\n interface AssignRoleOptions {\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberIds?: string[];\n /** Role to assign. */\n role?: GroupRole;\n }\n /**\n * Unassigns a role from members.\n * >**Notes:**\n * > + Only admins can unassign roles.\n * > + You cannot remove members via this endpoint.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function unassignRole(groupId: string, options?: UnassignRoleOptions): Promise;\n interface UnassignRoleOptions {\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n */\n siteMemberIds?: string[];\n /** Member IDs. Limited to 100 member IDs. See [Members API](https://dev.wix.com/api/rest/members/members/member-object) for details. */\n memberIds?: string[];\n /** Role to unassign. */\n role?: GroupRole;\n }\n \n type socialGroupsV2GroupRole_universal_d_GroupRole = GroupRole;\n type socialGroupsV2GroupRole_universal_d_Role = Role;\n const socialGroupsV2GroupRole_universal_d_Role: typeof Role;\n type socialGroupsV2GroupRole_universal_d_AssignRoleRequest = AssignRoleRequest;\n type socialGroupsV2GroupRole_universal_d_AssignRoleResponse = AssignRoleResponse;\n type socialGroupsV2GroupRole_universal_d_RoleAssignedToGroupMember = RoleAssignedToGroupMember;\n type socialGroupsV2GroupRole_universal_d_GroupMember = GroupMember;\n type socialGroupsV2GroupRole_universal_d_UnassignRoleRequest = UnassignRoleRequest;\n type socialGroupsV2GroupRole_universal_d_UnassignRoleResponse = UnassignRoleResponse;\n type socialGroupsV2GroupRole_universal_d_RoleUnassignedFromGroupMember = RoleUnassignedFromGroupMember;\n const socialGroupsV2GroupRole_universal_d_assignRole: typeof assignRole;\n type socialGroupsV2GroupRole_universal_d_AssignRoleOptions = AssignRoleOptions;\n const socialGroupsV2GroupRole_universal_d_unassignRole: typeof unassignRole;\n type socialGroupsV2GroupRole_universal_d_UnassignRoleOptions = UnassignRoleOptions;\n namespace socialGroupsV2GroupRole_universal_d {\n export {\n __debug$2 as __debug,\n socialGroupsV2GroupRole_universal_d_GroupRole as GroupRole,\n socialGroupsV2GroupRole_universal_d_Role as Role,\n socialGroupsV2GroupRole_universal_d_AssignRoleRequest as AssignRoleRequest,\n socialGroupsV2GroupRole_universal_d_AssignRoleResponse as AssignRoleResponse,\n socialGroupsV2GroupRole_universal_d_RoleAssignedToGroupMember as RoleAssignedToGroupMember,\n socialGroupsV2GroupRole_universal_d_GroupMember as GroupMember,\n socialGroupsV2GroupRole_universal_d_UnassignRoleRequest as UnassignRoleRequest,\n socialGroupsV2GroupRole_universal_d_UnassignRoleResponse as UnassignRoleResponse,\n socialGroupsV2GroupRole_universal_d_RoleUnassignedFromGroupMember as RoleUnassignedFromGroupMember,\n socialGroupsV2GroupRole_universal_d_assignRole as assignRole,\n socialGroupsV2GroupRole_universal_d_AssignRoleOptions as AssignRoleOptions,\n socialGroupsV2GroupRole_universal_d_unassignRole as unassignRole,\n socialGroupsV2GroupRole_universal_d_UnassignRoleOptions as UnassignRoleOptions,\n };\n }\n \n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.\n * @readonly\n */\n siteMemberId?: string;\n /**\n * Join group request status.\n * - `PENDING` - Pending join group request.\n * - `APPROVED` - Approved join group request.\n * - `REJECTED` - Rejected join group request.\n * - `CANCELED` - Canceled join group request.\n */\n status?: RequestStatus;\n /** Join group request details. */\n requestDetails?: RequestDetails;\n /**\n * Date and time the request was created.\n * @internal\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Id of the group\n * @internal\n * @readonly\n */\n groupId?: string | null;\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 has been rejected. */\n rejectionReason?: string | null;\n }\n interface GetJoinRequirementsRequest {\n /** Group ID. */\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$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 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 violationType?: ViolationType;\n eventsOptions?: EventsViolationOptions;\n pricingPlansOptions?: PricingPlanViolationOptions;\n membershipQuestionsOptions?: MembershipQuestionViolationOptions;\n }\n /** @oneof */\n interface ViolationViolationOptionsOneOf {\n eventsOptions?: EventsViolationOptions;\n pricingPlansOptions?: PricingPlanViolationOptions;\n membershipQuestionsOptions?: MembershipQuestionViolationOptions;\n }\n interface SubmitJoinGroupRequestRequest {\n /** Relevant group. */\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$1[];\n }\n interface SubmitJoinGroupRequestResponse {\n /** Submitted join group request. */\n joinGroupRequest?: JoinGroupRequest;\n }\n interface CancelJoinGroupRequestRequest {\n /** Relevant group. */\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 /** Relevant group. */\n groupId: string;\n /** @internal */\n itemsToApprove?: ItemsToUpdate;\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n *\n * Required if `memberIds` is not provided.\n */\n siteMemberIds?: string[];\n /**\n * Member IDs to approve.\n *\n *
\n *\n * __Important:__\n * This parameter will be required after the deprecated `siteMemberIds` is removed\n * on June 30, 2022.\n *\n *
\n */\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 /** Relevant group. */\n groupId: string;\n /** @internal */\n itemsToReject?: ItemsToUpdate;\n /** Rejection data. */\n rejections?: Rejection[];\n }\n interface Rejection {\n /**\n * __Deprecated.__ Use `memberId` instead.\n * This parameter will be removed on June 30, 2022.\n * @internal\n */\n siteMemberId?: string;\n /** Member ID to reject. */\n memberId?: string;\n /** Rejection reason. Free text that will be displayed to the rejected site member (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 /** Group ID. */\n groupId: string;\n /**\n * Ownership filter. In case of server signing, `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\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$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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryJoinGroupRequestsRequest {\n /** Group ID. */\n groupId: string;\n /**\n * Ownership filter. In case of server signing `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\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$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 {\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 QueryJoinGroupRequestsResponse {\n /** Join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n metadata?: PagingMetadata$1;\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 }\n interface ListAllJoinGroupRequestsResponse {\n /** Join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n }\n /**\n * Get join group requirements. Will return empty response for public groups and details to fulfil if it's private.\n * @param groupId - Group ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function getJoinRequirements(groupId: string, options?: GetJoinRequirementsOptions): Promise;\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$1[];\n autoInviteId?: string | null;\n }\n /**\n * Submits a join group request.\n * Relevant only for private groups.\n * @param groupId - Relevant group.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function submitJoinGroupRequest(groupId: string, options?: SubmitJoinGroupRequestOptions): Promise;\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$1[];\n }\n /**\n * Cancels a join group request.\n * A site member can cancel only their own pending Join group requests.\n * @param groupId - Relevant group.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function cancelJoinGroupRequest(groupId: string): Promise;\n /**\n * Approves pending join group requests.\n * Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.\n * @param groupId - Relevant group.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function approveJoinGroupRequests(groupId: string, options?: ApproveJoinGroupRequestsOptions): Promise;\n interface ApproveJoinGroupRequestsOptions {\n /** @internal */\n itemsToApprove?: ItemsToUpdate;\n /**\n * __Deprecated.__ Use `memberIds` instead.\n * This parameter will be removed on June 30, 2022.\n *\n * Required if `memberIds` is not provided.\n */\n siteMemberIds?: string[];\n /**\n * Member IDs to approve.\n *\n *
\n *\n * __Important:__\n * This parameter will be required after the deprecated `siteMemberIds` is removed\n * on June 30, 2022.\n *\n *
\n */\n memberIds?: string[];\n }\n /**\n * Rejects pending join group requests.\n * Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.\n * @param groupId - Relevant group.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function rejectJoinGroupRequests(groupId: string, options?: RejectJoinGroupRequestsOptions): Promise;\n interface RejectJoinGroupRequestsOptions {\n /** @internal */\n itemsToReject?: ItemsToUpdate;\n /** Rejection data. */\n rejections?: Rejection[];\n }\n /**\n * Retrieves a list of up to 100 join group requests, given the provided paging.\n * Group managers always have access to this functionality (site members can access their own join group requests in the site).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function listJoinGroupRequests(groupId: string, options?: ListJoinGroupRequestsOptions): Promise;\n interface ListJoinGroupRequestsOptions {\n /**\n * Ownership filter. In case of server signing, `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\n limit?: number | null;\n offset?: number | null;\n }\n /**\n * Retrieves a list of up to 100 join group requests, given the provided paging and filtering.\n * Group managers always have access to this functionality (site members can access their own join group requests in the site).\n *\n * Supported fields for filtering:\n * - `status`\n *\n * No supported fields for sorting\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function queryJoinGroupRequests(groupId: string, options?: QueryJoinGroupRequestsOptions): Promise;\n interface QueryJoinGroupRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\n query?: Query;\n }\n /** @internal\n * @documentationMaturity preview\n */\n function rejectAllJoinGroupRequests(): Promise;\n /** @internal\n * @documentationMaturity preview\n */\n function approveAllJoinGroupRequests(): Promise;\n /** @internal\n * @documentationMaturity preview\n */\n function listAllJoinGroupRequests(): Promise;\n \n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequest = JoinGroupRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_RequestStatus = RequestStatus;\n const socialGroupsV2JoinGroupRequest_universal_d_RequestStatus: typeof RequestStatus;\n type socialGroupsV2JoinGroupRequest_universal_d_RequestDetails = RequestDetails;\n type socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsRequest = GetJoinRequirementsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsResponse = GetJoinRequirementsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_PaidPlan = PaidPlan;\n type socialGroupsV2JoinGroupRequest_universal_d_ViolationType = ViolationType;\n const socialGroupsV2JoinGroupRequest_universal_d_ViolationType: typeof ViolationType;\n type socialGroupsV2JoinGroupRequest_universal_d_EventsViolationOptions = EventsViolationOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_PricingPlanViolationOptions = PricingPlanViolationOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_MembershipQuestionViolationOptions = MembershipQuestionViolationOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_Violation = Violation;\n type socialGroupsV2JoinGroupRequest_universal_d_ViolationViolationOptionsOneOf = ViolationViolationOptionsOneOf;\n type socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestRequest = SubmitJoinGroupRequestRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestResponse = SubmitJoinGroupRequestResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestRequest = CancelJoinGroupRequestRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestResponse = CancelJoinGroupRequestResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestCancelled = JoinGroupRequestCancelled;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsRequest = ApproveJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_ItemsToUpdate = ItemsToUpdate;\n const socialGroupsV2JoinGroupRequest_universal_d_ItemsToUpdate: typeof ItemsToUpdate;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsResponse = ApproveJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestApproved = JoinGroupRequestApproved;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsRequest = RejectJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_Rejection = Rejection;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsResponse = RejectJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestRejected = JoinGroupRequestRejected;\n type socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsRequest = ListJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_OwnershipFilter = OwnershipFilter;\n const socialGroupsV2JoinGroupRequest_universal_d_OwnershipFilter: typeof OwnershipFilter;\n type socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsResponse = ListJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsRequest = QueryJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_Query = Query;\n type socialGroupsV2JoinGroupRequest_universal_d_Sorting = Sorting;\n type socialGroupsV2JoinGroupRequest_universal_d_SortOrder = SortOrder;\n const socialGroupsV2JoinGroupRequest_universal_d_SortOrder: typeof SortOrder;\n type socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsResponse = QueryJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsRequest = RejectAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsResponse = RejectAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsRequest = ApproveAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsResponse = ApproveAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsRequest = ListAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsResponse = ListAllJoinGroupRequestsResponse;\n const socialGroupsV2JoinGroupRequest_universal_d_getJoinRequirements: typeof getJoinRequirements;\n type socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsOptions = GetJoinRequirementsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_submitJoinGroupRequest: typeof submitJoinGroupRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestOptions = SubmitJoinGroupRequestOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_cancelJoinGroupRequest: typeof cancelJoinGroupRequest;\n const socialGroupsV2JoinGroupRequest_universal_d_approveJoinGroupRequests: typeof approveJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsOptions = ApproveJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_rejectJoinGroupRequests: typeof rejectJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsOptions = RejectJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_listJoinGroupRequests: typeof listJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsOptions = ListJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_queryJoinGroupRequests: typeof queryJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsOptions = QueryJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_rejectAllJoinGroupRequests: typeof rejectAllJoinGroupRequests;\n const socialGroupsV2JoinGroupRequest_universal_d_approveAllJoinGroupRequests: typeof approveAllJoinGroupRequests;\n const socialGroupsV2JoinGroupRequest_universal_d_listAllJoinGroupRequests: typeof listAllJoinGroupRequests;\n namespace socialGroupsV2JoinGroupRequest_universal_d {\n export {\n __debug$1 as __debug,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequest as JoinGroupRequest,\n socialGroupsV2JoinGroupRequest_universal_d_RequestStatus as RequestStatus,\n socialGroupsV2JoinGroupRequest_universal_d_RequestDetails as RequestDetails,\n socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsRequest as GetJoinRequirementsRequest,\n MembershipQuestionAnswer$1 as MembershipQuestionAnswer,\n socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsResponse as GetJoinRequirementsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_PaidPlan as PaidPlan,\n socialGroupsV2JoinGroupRequest_universal_d_ViolationType as ViolationType,\n socialGroupsV2JoinGroupRequest_universal_d_EventsViolationOptions as EventsViolationOptions,\n socialGroupsV2JoinGroupRequest_universal_d_PricingPlanViolationOptions as PricingPlanViolationOptions,\n socialGroupsV2JoinGroupRequest_universal_d_MembershipQuestionViolationOptions as MembershipQuestionViolationOptions,\n socialGroupsV2JoinGroupRequest_universal_d_Violation as Violation,\n socialGroupsV2JoinGroupRequest_universal_d_ViolationViolationOptionsOneOf as ViolationViolationOptionsOneOf,\n socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestRequest as SubmitJoinGroupRequestRequest,\n socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestResponse as SubmitJoinGroupRequestResponse,\n socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestRequest as CancelJoinGroupRequestRequest,\n socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestResponse as CancelJoinGroupRequestResponse,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestCancelled as JoinGroupRequestCancelled,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsRequest as ApproveJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_ItemsToUpdate as ItemsToUpdate,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsResponse as ApproveJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestApproved as JoinGroupRequestApproved,\n socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsRequest as RejectJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_Rejection as Rejection,\n socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsResponse as RejectJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestRejected as JoinGroupRequestRejected,\n socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsRequest as ListJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_OwnershipFilter as OwnershipFilter,\n socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsResponse as ListJoinGroupRequestsResponse,\n PagingMetadata$1 as PagingMetadata,\n socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsRequest as QueryJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_Query as Query,\n socialGroupsV2JoinGroupRequest_universal_d_Sorting as Sorting,\n socialGroupsV2JoinGroupRequest_universal_d_SortOrder as SortOrder,\n Paging$1 as Paging,\n socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsResponse as QueryJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsRequest as RejectAllJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsResponse as RejectAllJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsRequest as ApproveAllJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsResponse as ApproveAllJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsRequest as ListAllJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsResponse as ListAllJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_getJoinRequirements as getJoinRequirements,\n socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsOptions as GetJoinRequirementsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_submitJoinGroupRequest as submitJoinGroupRequest,\n socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestOptions as SubmitJoinGroupRequestOptions,\n socialGroupsV2JoinGroupRequest_universal_d_cancelJoinGroupRequest as cancelJoinGroupRequest,\n socialGroupsV2JoinGroupRequest_universal_d_approveJoinGroupRequests as approveJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsOptions as ApproveJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_rejectJoinGroupRequests as rejectJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsOptions as RejectJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_listJoinGroupRequests as listJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsOptions as ListJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_queryJoinGroupRequests as queryJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsOptions as QueryJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_rejectAllJoinGroupRequests as rejectAllJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_approveAllJoinGroupRequests as approveAllJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_listAllJoinGroupRequests as listAllJoinGroupRequests,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * Question asked to members when joining a group. Site owners can set whether it is required to answer the question in the Business Manager.\n * > **Note:** Only admins can create or update membership questions.\n */\n interface MembershipQuestion {\n /**\n * Question ID.\n * @readonly\n */\n _id?: string | null;\n /** Whether a member must answer this question when joining the group. */\n required?: boolean;\n /** Question text. */\n text?: string;\n }\n interface ListMembershipQuestionsRequest {\n /** Group ID. */\n groupId: string;\n }\n interface ListMembershipQuestionsResponse {\n /** Membership questions. */\n questions?: MembershipQuestion[];\n }\n interface CreateOrReplaceAllMembershipQuestionsRequest {\n /** Group ID. */\n groupId: string;\n /** New membership questions. */\n questions?: MembershipQuestion[];\n }\n interface CreateOrReplaceAllMembershipQuestionsResponse {\n /** Membership questions. */\n questions?: MembershipQuestion[];\n }\n interface ListAnswersRequest {\n /** Group ID. */\n groupId: string;\n /** Member IDs. If no member ID is provided, answers for all members will be returned. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n memberIds?: string[];\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 ListAnswersResponse {\n /** Answers to the membership questions, grouped by member. */\n memberAnswers?: MemberMembershipQuestionAnswers[];\n /** Membership questions by question ID. Inludes only questions that have been answered by the specified members. */\n questions?: Record;\n metadata?: PagingMetadata;\n }\n interface MemberMembershipQuestionAnswers {\n /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n memberId?: string;\n /** Answers to the membership question. */\n answers?: MembershipQuestionAnswer[];\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 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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListAnswerCountsRequest {\n memberIds?: string[];\n }\n interface ListAnswerCountsResponse {\n memberAnswerCounts?: MemberAnswerCount[];\n }\n interface MemberAnswerCount {\n memberId?: string;\n groupId?: string;\n count?: number;\n }\n /**\n * Retrieves the membership questions for the given group.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function listMembershipQuestions(groupId: string): Promise;\n /**\n * Creates membership questions if none have been set up. Otherwise, replaces all existing questions.\n * > **Notes:**\n * > * Only admins can create or replace membership questions.\n * > * Providing an empty array means that members won't have to answer any question when joining the group.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function createOrReplaceAllMembershipQuestions(groupId: string, options?: CreateOrReplaceAllMembershipQuestionsOptions): Promise;\n interface CreateOrReplaceAllMembershipQuestionsOptions {\n /** New membership questions. */\n questions?: MembershipQuestion[];\n }\n /**\n * Retrieves the answers to the membership questions, given the provided filters.\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n */\n function listAnswers(groupId: string, options?: ListAnswersOptions): Promise;\n interface ListAnswersOptions {\n /** Member IDs. If no member ID is provided, answers for all members will be returned. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n memberIds?: string[];\n paging?: Paging;\n }\n /** @internal\n * @documentationMaturity preview\n */\n function listAnswerCounts(options?: ListAnswerCountsOptions): Promise;\n interface ListAnswerCountsOptions {\n memberIds?: string[];\n }\n \n const socialGroupsV2MembershipQuestion_universal_d___debug: typeof __debug;\n type socialGroupsV2MembershipQuestion_universal_d_MembershipQuestion = MembershipQuestion;\n type socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsRequest = ListMembershipQuestionsRequest;\n type socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsResponse = ListMembershipQuestionsResponse;\n type socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsRequest = CreateOrReplaceAllMembershipQuestionsRequest;\n type socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsResponse = CreateOrReplaceAllMembershipQuestionsResponse;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswersRequest = ListAnswersRequest;\n type socialGroupsV2MembershipQuestion_universal_d_Paging = Paging;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswersResponse = ListAnswersResponse;\n type socialGroupsV2MembershipQuestion_universal_d_MemberMembershipQuestionAnswers = MemberMembershipQuestionAnswers;\n type socialGroupsV2MembershipQuestion_universal_d_MembershipQuestionAnswer = MembershipQuestionAnswer;\n type socialGroupsV2MembershipQuestion_universal_d_PagingMetadata = PagingMetadata;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsRequest = ListAnswerCountsRequest;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsResponse = ListAnswerCountsResponse;\n type socialGroupsV2MembershipQuestion_universal_d_MemberAnswerCount = MemberAnswerCount;\n const socialGroupsV2MembershipQuestion_universal_d_listMembershipQuestions: typeof listMembershipQuestions;\n const socialGroupsV2MembershipQuestion_universal_d_createOrReplaceAllMembershipQuestions: typeof createOrReplaceAllMembershipQuestions;\n type socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsOptions = CreateOrReplaceAllMembershipQuestionsOptions;\n const socialGroupsV2MembershipQuestion_universal_d_listAnswers: typeof listAnswers;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswersOptions = ListAnswersOptions;\n const socialGroupsV2MembershipQuestion_universal_d_listAnswerCounts: typeof listAnswerCounts;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsOptions = ListAnswerCountsOptions;\n namespace socialGroupsV2MembershipQuestion_universal_d {\n export {\n socialGroupsV2MembershipQuestion_universal_d___debug as __debug,\n socialGroupsV2MembershipQuestion_universal_d_MembershipQuestion as MembershipQuestion,\n socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsRequest as ListMembershipQuestionsRequest,\n socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsResponse as ListMembershipQuestionsResponse,\n socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsRequest as CreateOrReplaceAllMembershipQuestionsRequest,\n socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsResponse as CreateOrReplaceAllMembershipQuestionsResponse,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswersRequest as ListAnswersRequest,\n socialGroupsV2MembershipQuestion_universal_d_Paging as Paging,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswersResponse as ListAnswersResponse,\n socialGroupsV2MembershipQuestion_universal_d_MemberMembershipQuestionAnswers as MemberMembershipQuestionAnswers,\n socialGroupsV2MembershipQuestion_universal_d_MembershipQuestionAnswer as MembershipQuestionAnswer,\n socialGroupsV2MembershipQuestion_universal_d_PagingMetadata as PagingMetadata,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsRequest as ListAnswerCountsRequest,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsResponse as ListAnswerCountsResponse,\n socialGroupsV2MembershipQuestion_universal_d_MemberAnswerCount as MemberAnswerCount,\n socialGroupsV2MembershipQuestion_universal_d_listMembershipQuestions as listMembershipQuestions,\n socialGroupsV2MembershipQuestion_universal_d_createOrReplaceAllMembershipQuestions as createOrReplaceAllMembershipQuestions,\n socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsOptions as CreateOrReplaceAllMembershipQuestionsOptions,\n socialGroupsV2MembershipQuestion_universal_d_listAnswers as listAnswers,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswersOptions as ListAnswersOptions,\n socialGroupsV2MembershipQuestion_universal_d_listAnswerCounts as listAnswerCounts,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsOptions as ListAnswerCountsOptions,\n };\n }\n \n export { socialGroupsV2GroupRequest_universal_d as createRequests, socialGroupsV2Group_universal_d as groups, socialGroupsV2JoinGroupRequest_universal_d as joinRequests, socialGroupsV2GroupMember_universal_d as members, socialGroupsV2MembershipQuestion_universal_d as membershipQuestions, socialGroupsV2GroupRole_universal_d as roles, socialGroupsV2GroupRules_universal_d as rules };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecom-v1-recommendations-provider.d.ts", "content": "declare module \"interfaces-ecom-v1-recommendations-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n /** additional information can be passed via aspects, for example GEO */\n interface GetRecommendationsRequest {\n /** The set of items used by algorithms with the `RELATED_ITEMS` `algorithmType` to determine related item recommendations. */\n items?: CatalogReference[];\n /** List of algorithms used to find recommended items. Items will be returned in a separate object for each algorithm */\n algorithmIds?: string[];\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 [app dashboard](https://dev.wix.com/dc3/my-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 GetRecommendationsResponse {\n /**\n * Related items returned by each algorithm.\n *\n * Each object in the array contains an `algorithmId` and a list of the item recommendations provided by that algorithm.\n */\n recommendationPerAlgorithm?: RecommendationForAlgorithm[];\n }\n interface RecommendationForAlgorithm {\n /** Id of the algorithm that provided the recommendation. */\n algorithmId?: string;\n /** Item recommendations provided by the algorithm. Depending on the algorithm, these recommendations may be influenced by the items provided in the request. */\n recommendedItems?: CatalogReference[];\n }\n interface RecommendationAlgorithmNotSupported {\n /** Not supported algorithms. */\n unsupportedAlgorithms?: string[];\n }\n interface ItemAppIdNotSupportedError {\n /** Items with not supported catalogs. */\n items?: CatalogReference[];\n }\n interface RecommendationsProviderConfig {\n /** App IDs of catalogs for which recommended items can be found. */\n catalogAppIds?: string[];\n /** The algorithms that this application can use to calculate item recommendations. */\n supportedAlgorithms?: AlgorithmConfig[];\n }\n interface AlgorithmConfig {\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 /** 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 algorithmId?: string;\n }\n enum AlgorithmType {\n UNSPECIFIED = \"UNSPECIFIED\",\n RELATED_ITEMS = \"RELATED_ITEMS\",\n GLOBAL = \"GLOBAL\"\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, metadata }: OrderCanceledEvent) {\n * ...\n * }\n * ```\n */\n interface Context {\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 requestId?: string | null;\n /** [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. */\n currency?: string | null;\n /** An object that describes the identity that triggered this request. */\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. For example, `\"en-US\"`. */\n languages?: string[];\n /** The service provider app's instance ID. */\n instanceId?: string | null;\n /**\n * Extension ID in Dev Center.\n * @internal\n */\n appExtensionId?: string | null;\n /**\n * Extension type in Dev Center.\n * @internal\n */\n appExtensionType?: string | null;\n /**\n * Invoked function.\n * @internal\n */\n functionName?: 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 GetRecommendationsOptions {\n /** The set of items used by algorithms with the `RELATED_ITEMS` `algorithmType` to determine related item recommendations. */\n items?: CatalogReference[];\n /** List of algorithms used to find recommended items. Items will be returned in a separate object for each algorithm */\n algorithmIds?: string[];\n }\n \n function algorithmNotSupportedError(data: RecommendationAlgorithmNotSupported): BusinessError;\n function itemAppIdNotSupportedError(data: ItemAppIdNotSupportedError): BusinessError;\n \n const getRecommendationsSpiErrors_d_algorithmNotSupportedError: typeof algorithmNotSupportedError;\n const getRecommendationsSpiErrors_d_itemAppIdNotSupportedError: typeof itemAppIdNotSupportedError;\n namespace getRecommendationsSpiErrors_d {\n export {\n getRecommendationsSpiErrors_d_algorithmNotSupportedError as algorithmNotSupportedError,\n getRecommendationsSpiErrors_d_itemAppIdNotSupportedError as itemAppIdNotSupportedError,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n getRecommendationsSpiErrors_d as getRecommendations,\n };\n }\n \n export { AlgorithmConfig, AlgorithmType, BusinessError, CatalogReference, Context, GetRecommendationsOptions, GetRecommendationsRequest, GetRecommendationsResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, ItemAppIdNotSupportedError, RecommendationAlgorithmNotSupported, RecommendationForAlgorithm, RecommendationsProviderConfig, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-identity-backend.d.ts", "content": "declare module \"wix-identity-backend\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface AccountInvite {\n /** @readonly */\n _id?: string;\n /** @readonly */\n accountId?: string;\n email?: string;\n role?: string;\n /** @readonly */\n inviterId?: string;\n status?: InviteStatus;\n acceptLink?: string;\n /** @readonly */\n inviterAccountId?: string;\n /** @readonly */\n acceptedByAccountId?: string | null;\n dateCreated?: Date;\n policyIds?: string[];\n dateUpdated?: Date;\n assignments?: InviteResourceAssignment[];\n brandDomain?: string | null;\n /** Invite expiration date */\n expirationDate?: Date;\n }\n /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */\n enum InviteStatus {\n Pending = \"Pending\",\n Used = \"Used\",\n Deleted = \"Deleted\",\n Declined = \"Declined\",\n Expired = \"Expired\"\n }\n interface InviteResourceAssignment {\n policyId?: string;\n assignments?: InviteAssignment[];\n }\n interface InviteAssignment {\n /** The resource of the invite assignment */\n fullNameResource?: FullNameResource;\n /** A condition that will be applied on the assignment */\n condition?: PolicyCondition;\n }\n interface FullNameResource extends FullNameResourceResourceContextOneOf {\n /** A specific resource. We will determine the resource type based on the action. */\n resource?: Resource;\n /** A specific site (we will retrieve the account that the site belongs to) */\n siteContext?: SiteResourceContext;\n /** A specific account */\n accountContext?: AccountResourceContext;\n /** A specific organization */\n organizationContext?: OrganizationResourceContext;\n }\n /** @oneof */\n interface FullNameResourceResourceContextOneOf {\n /** A specific site (we will retrieve the account that the site belongs to) */\n siteContext?: SiteResourceContext;\n /** A specific account */\n accountContext?: AccountResourceContext;\n /** A specific organization */\n organizationContext?: OrganizationResourceContext;\n }\n /** Site resource context. It indicates that the resource is under a site (can be the site itself or some asset of a site, like a blog post) */\n interface SiteResourceContext {\n metasiteId?: string;\n }\n /** Account resource contexts. It indicates that the resource is under the account (can be the account itself or some asset of an account, like a logo or a domain) */\n interface AccountResourceContext {\n accountId?: string;\n }\n interface OrganizationResourceContext {\n }\n /**\n * A custom resource. Is used to represent some asset that is not a direct resource context (site or account), but something custom.\n * For example: payment method, blog post, domain, logo.\n */\n interface Resource {\n /** The resource id. */\n _id?: string | null;\n /** The resource type */\n type?: string | null;\n }\n interface PolicyCondition {\n /** The type of the condition */\n condition?: ConditionType;\n }\n interface ConditionType extends ConditionTypeOfOneOf {\n simpleCondition?: SimpleCondition;\n /** A logic combination between several conditions, with an operator between them */\n joinedConditions?: JoinedCondition;\n environmentCondition?: EnvironmentCondition;\n /** A single condition */\n condition?: Condition;\n }\n /** @oneof */\n interface ConditionTypeOfOneOf {\n simpleCondition?: SimpleCondition;\n /** A logic combination between several conditions, with an operator between them */\n joinedConditions?: JoinedCondition;\n environmentCondition?: EnvironmentCondition;\n /** A single condition */\n condition?: Condition;\n }\n interface SimpleCondition {\n attrName?: string;\n value?: SimpleConditionValue;\n op?: SimpleConditionOperator;\n conditionModelId?: string;\n }\n interface SimpleConditionValue extends SimpleConditionValueValueOneOf {\n attrName?: string;\n stringValue?: string;\n boolValue?: boolean;\n }\n /** @oneof */\n interface SimpleConditionValueValueOneOf {\n attrName?: string;\n stringValue?: string;\n boolValue?: boolean;\n }\n enum SimpleConditionOperator {\n UNKNOWN_SIMPLE_OP = \"UNKNOWN_SIMPLE_OP\",\n EQUAL = \"EQUAL\"\n }\n interface JoinedCondition {\n /** The operator that should be used when evaluating the condition */\n op?: JoinedConditionOperator;\n /** The conditions that should be evaluated, and then joined using the operator provided */\n conditions?: ConditionType[];\n }\n enum JoinedConditionOperator {\n UNKNOWN_JOIN_OP = \"UNKNOWN_JOIN_OP\",\n OR = \"OR\",\n AND = \"AND\"\n }\n interface EnvironmentCondition extends EnvironmentConditionConditionOneOf {\n experimentCondition?: ExperimentCondition;\n }\n /** @oneof */\n interface EnvironmentConditionConditionOneOf {\n experimentCondition?: ExperimentCondition;\n }\n interface ExperimentCondition {\n spec?: string;\n fallbackValue?: string;\n expectedValue?: string;\n }\n interface Condition {\n /** The unique identifier of the condition model. Indicates which actions the condition is working on */\n conditionModelId?: string;\n /** The operator that should be evaluated */\n operator?: ConditionOperator;\n }\n interface ConditionOperator extends ConditionOperatorOperatorsOneOf {\n /** Comparison of equality - will be evaluated to true if the given parties are equal */\n equals?: EqualOperator;\n /** Regex operator - will be evaluated to true if the given value matches the provided regex */\n like?: LikeOperator;\n /** Petri experiment - will be evaluated using petri. */\n experiment?: ExperimentOperator;\n /** Operator that indicates a dependency on another subject being allowed to perform something. */\n dependOn?: DependOnOperator;\n }\n /** @oneof */\n interface ConditionOperatorOperatorsOneOf {\n /** Comparison of equality - will be evaluated to true if the given parties are equal */\n equals?: EqualOperator;\n /** Regex operator - will be evaluated to true if the given value matches the provided regex */\n like?: LikeOperator;\n /** Petri experiment - will be evaluated using petri. */\n experiment?: ExperimentOperator;\n /** Operator that indicates a dependency on another subject being allowed to perform something. */\n dependOn?: DependOnOperator;\n }\n interface EqualOperator {\n /** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the other side (attribute/value) */\n attrName?: string;\n /** The value to compare to. If the two parties are equal - we will return true. */\n value?: ConditionValue;\n }\n interface ConditionValue extends ConditionValueValueOneOf {\n /** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */\n attrName?: string;\n /** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */\n stringValue?: string;\n /** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */\n boolValue?: boolean;\n }\n /** @oneof */\n interface ConditionValueValueOneOf {\n /** an attribute. We'll first retrieve the value of the attribute (from the request or from pre-indexed values), and then compare to what it needs to be compared with. */\n attrName?: string;\n /** a value with a string type. Will be compared to the attribute provided, and be true only if they match the operator. */\n stringValue?: string;\n /** a value with a boolean type. Will be compared to the attribute provided, and be true only if they match the operator. */\n boolValue?: boolean;\n }\n interface LikeOperator {\n /** The attribute which should be compared. The attribute will be first evaluated to a value, and then compared the regex values provided. */\n attrName?: string;\n /** The regex values which the attribute value should be evaluated on. If the attribute value matches at least one of the regular expressions provided - we will return true */\n values?: string[];\n }\n interface ExperimentOperator {\n /** The spec to conduct the experiment on. */\n spec?: string;\n /** The value to use if the experiment could not be conducted */\n fallbackValue?: string;\n /** The expected value of the experiment conduction. If it matches the actual value - true will be returned. Otherwise - false. */\n expectedValue?: string;\n }\n /** Implies that the policy takes affect only if the depend on subject is permitted as well. */\n interface DependOnOperator {\n /** The subject on which the current entry depends on. If the subject is allowed to perform what the query was about - the condition will be evaluated to true. Otherwise - false */\n dependOnSubject?: Subject;\n }\n interface Subject {\n _id?: string;\n subjectType?: SubjectType;\n /** The context of the subject. For example - the context of a user subject is his account. */\n context?: SubjectContext;\n }\n enum SubjectType {\n UNKNOWN = \"UNKNOWN\",\n ACCOUNT = \"ACCOUNT\",\n USER = \"USER\",\n USER_GROUP = \"USER_GROUP\",\n MEMBER_GROUP = \"MEMBER_GROUP\",\n VISITOR_GROUP = \"VISITOR_GROUP\",\n EXTERNAL_APP = \"EXTERNAL_APP\",\n ACCOUNT_GROUP = \"ACCOUNT_GROUP\"\n }\n interface SubjectContext {\n _id?: string;\n contextType?: SubjectContextType;\n }\n enum SubjectContextType {\n UNKNOWN_CTX = \"UNKNOWN_CTX\",\n ORG_CTX = \"ORG_CTX\",\n ACCOUNT_CTX = \"ACCOUNT_CTX\"\n }\n interface GetAccountInvitesRequest {\n }\n interface GetAccountInvitesResponse {\n invites?: AccountInvite[];\n }\n interface GetAccountInviteRequest {\n _id: string;\n }\n interface GetAccountInviteResponse {\n invite?: AccountInvite;\n }\n interface AccountInviteRequest {\n role?: string;\n email?: string;\n policyIds?: string[];\n }\n interface AccountInviteResponse {\n invite?: AccountInvite;\n }\n interface CreateInviteRequest {\n /** An array of new team members' email addresses and their corresponding new assignments to be assigned to it when their invite is accepted. */\n subjectsAssignments: SubjectInviteAssignments[];\n /**\n * An indicator for suppressing (not sending) emails to the assignees.\n * @internal\n */\n suppressEmail?: boolean;\n /** The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead */\n defaultEmailLanguage?: string | null;\n }\n interface SubjectInviteAssignments {\n /** invitee email. */\n subjectEmail?: string;\n /** an array of assignments to be assigned when the invitee accepts the invite. */\n assignments?: InviteResourceAssignment[];\n }\n interface CreateInviteResponse {\n successfulInvites?: AccountInvite[];\n failedInvites?: InviteFailure[];\n }\n interface InviteFailure {\n subjectEmail?: string;\n errorMessage?: string;\n }\n interface BulkAccountInviteRequest {\n role?: string;\n emails?: string[];\n policyIds?: string[];\n }\n interface BulkAccountInviteResponse {\n invites?: AccountInvite[];\n failedEmails?: string[];\n }\n interface ResendAccountInviteRequest {\n inviteId: string;\n /** The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead */\n defaultEmailLanguage?: string | null;\n }\n interface AcceptAccountInviteRequest {\n inviteToken?: string;\n }\n interface AcceptAccountInviteResponse {\n }\n interface RevokeAccountInviteRequest {\n inviteId: string;\n }\n interface RevokeAccountInviteResponse {\n }\n interface UpdateAccountInviteRequest {\n inviteId: string;\n role?: string;\n policyIds?: string[];\n }\n interface UpdateAccountInviteResponse {\n }\n interface UpdateAccountInviteAssignmentsRequest {\n inviteId: string;\n assignments?: InviteResourceAssignment[];\n }\n interface UpdateAccountInviteAssignmentsResponse {\n }\n interface ParseAccountInviteTokenRequest {\n inviteToken?: string;\n }\n interface ParseAccountInviteTokenResponse {\n inviteId?: string;\n accountId?: string;\n status?: InviteStatus;\n }\n /** @documentationMaturity preview */\n function getInvites(): Promise;\n /** @documentationMaturity preview\n * @requiredField _id\n */\n function getInvite(_id: string): Promise;\n /**\n * Deprecated: please use CreateInvite\n * @documentationMaturity preview */\n function invite(options?: InviteOptions): Promise;\n interface InviteOptions {\n role?: string;\n email?: string;\n policyIds?: string[];\n }\n /**\n * Create and send an invite to an array of potential users via email to become team members on this account.\n * The invite may be limited to a specific resource.\n * The caller identity must have sufficient permissions to send invites to the account and to any additional site\n * contexts.\n * Maximum amount of new users per invite is 50.\n * @param subjectsAssignments - An array of new team members' email addresses and their corresponding new assignments to be assigned to it when their invite is accepted.\n * @documentationMaturity preview\n * @requiredField subjectsAssignments\n */\n function createInvite(subjectsAssignments: SubjectInviteAssignments[], options?: CreateInviteOptions): Promise;\n interface CreateInviteOptions {\n /**\n * An indicator for suppressing (not sending) emails to the assignees.\n * @internal\n */\n suppressEmail?: boolean;\n /** The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead */\n defaultEmailLanguage?: string | null;\n }\n /**\n * Deprecated: please use CreateInvite\n * @documentationMaturity preview */\n function bulkInvite(options?: BulkInviteOptions): Promise;\n interface BulkInviteOptions {\n role?: string;\n emails?: string[];\n policyIds?: string[];\n }\n /** @documentationMaturity preview\n * @requiredField inviteId\n */\n function resendInvite(inviteId: string, options?: ResendInviteOptions): Promise;\n interface ResendInviteOptions {\n /** The language of emails that will be used only for recipients that don't have a user, in case this parameter is unspecified, the sender's language will be used instead */\n defaultEmailLanguage?: string | null;\n }\n /** @documentationMaturity preview */\n function acceptInvite(options?: AcceptInviteOptions): Promise;\n interface AcceptInviteOptions {\n inviteToken?: string;\n }\n /** @documentationMaturity preview\n * @requiredField inviteId\n */\n function revokeInvite(inviteId: string): Promise;\n /**\n * Deprecated: please use UpdateInviteAssignments\n * @documentationMaturity preview\n * @requiredField inviteId\n */\n function updateInvite(inviteId: string, options?: UpdateInviteOptions): Promise;\n interface UpdateInviteOptions {\n role?: string;\n policyIds?: string[];\n }\n /** @documentationMaturity preview\n * @requiredField inviteId\n */\n function updateInviteAssignments(inviteId: string, options?: UpdateInviteAssignmentsOptions): Promise;\n interface UpdateInviteAssignmentsOptions {\n assignments?: InviteResourceAssignment[];\n }\n \n type identityInvitesV1AccountInvite_universal_d_AccountInvite = AccountInvite;\n type identityInvitesV1AccountInvite_universal_d_InviteStatus = InviteStatus;\n const identityInvitesV1AccountInvite_universal_d_InviteStatus: typeof InviteStatus;\n type identityInvitesV1AccountInvite_universal_d_InviteResourceAssignment = InviteResourceAssignment;\n type identityInvitesV1AccountInvite_universal_d_InviteAssignment = InviteAssignment;\n type identityInvitesV1AccountInvite_universal_d_FullNameResource = FullNameResource;\n type identityInvitesV1AccountInvite_universal_d_FullNameResourceResourceContextOneOf = FullNameResourceResourceContextOneOf;\n type identityInvitesV1AccountInvite_universal_d_SiteResourceContext = SiteResourceContext;\n type identityInvitesV1AccountInvite_universal_d_AccountResourceContext = AccountResourceContext;\n type identityInvitesV1AccountInvite_universal_d_OrganizationResourceContext = OrganizationResourceContext;\n type identityInvitesV1AccountInvite_universal_d_Resource = Resource;\n type identityInvitesV1AccountInvite_universal_d_PolicyCondition = PolicyCondition;\n type identityInvitesV1AccountInvite_universal_d_ConditionType = ConditionType;\n type identityInvitesV1AccountInvite_universal_d_ConditionTypeOfOneOf = ConditionTypeOfOneOf;\n type identityInvitesV1AccountInvite_universal_d_SimpleCondition = SimpleCondition;\n type identityInvitesV1AccountInvite_universal_d_SimpleConditionValue = SimpleConditionValue;\n type identityInvitesV1AccountInvite_universal_d_SimpleConditionValueValueOneOf = SimpleConditionValueValueOneOf;\n type identityInvitesV1AccountInvite_universal_d_SimpleConditionOperator = SimpleConditionOperator;\n const identityInvitesV1AccountInvite_universal_d_SimpleConditionOperator: typeof SimpleConditionOperator;\n type identityInvitesV1AccountInvite_universal_d_JoinedCondition = JoinedCondition;\n type identityInvitesV1AccountInvite_universal_d_JoinedConditionOperator = JoinedConditionOperator;\n const identityInvitesV1AccountInvite_universal_d_JoinedConditionOperator: typeof JoinedConditionOperator;\n type identityInvitesV1AccountInvite_universal_d_EnvironmentCondition = EnvironmentCondition;\n type identityInvitesV1AccountInvite_universal_d_EnvironmentConditionConditionOneOf = EnvironmentConditionConditionOneOf;\n type identityInvitesV1AccountInvite_universal_d_ExperimentCondition = ExperimentCondition;\n type identityInvitesV1AccountInvite_universal_d_Condition = Condition;\n type identityInvitesV1AccountInvite_universal_d_ConditionOperator = ConditionOperator;\n type identityInvitesV1AccountInvite_universal_d_ConditionOperatorOperatorsOneOf = ConditionOperatorOperatorsOneOf;\n type identityInvitesV1AccountInvite_universal_d_EqualOperator = EqualOperator;\n type identityInvitesV1AccountInvite_universal_d_ConditionValue = ConditionValue;\n type identityInvitesV1AccountInvite_universal_d_ConditionValueValueOneOf = ConditionValueValueOneOf;\n type identityInvitesV1AccountInvite_universal_d_LikeOperator = LikeOperator;\n type identityInvitesV1AccountInvite_universal_d_ExperimentOperator = ExperimentOperator;\n type identityInvitesV1AccountInvite_universal_d_DependOnOperator = DependOnOperator;\n type identityInvitesV1AccountInvite_universal_d_Subject = Subject;\n type identityInvitesV1AccountInvite_universal_d_SubjectType = SubjectType;\n const identityInvitesV1AccountInvite_universal_d_SubjectType: typeof SubjectType;\n type identityInvitesV1AccountInvite_universal_d_SubjectContext = SubjectContext;\n type identityInvitesV1AccountInvite_universal_d_SubjectContextType = SubjectContextType;\n const identityInvitesV1AccountInvite_universal_d_SubjectContextType: typeof SubjectContextType;\n type identityInvitesV1AccountInvite_universal_d_GetAccountInvitesRequest = GetAccountInvitesRequest;\n type identityInvitesV1AccountInvite_universal_d_GetAccountInvitesResponse = GetAccountInvitesResponse;\n type identityInvitesV1AccountInvite_universal_d_GetAccountInviteRequest = GetAccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_GetAccountInviteResponse = GetAccountInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_AccountInviteRequest = AccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_AccountInviteResponse = AccountInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_CreateInviteRequest = CreateInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_SubjectInviteAssignments = SubjectInviteAssignments;\n type identityInvitesV1AccountInvite_universal_d_CreateInviteResponse = CreateInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_InviteFailure = InviteFailure;\n type identityInvitesV1AccountInvite_universal_d_BulkAccountInviteRequest = BulkAccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_BulkAccountInviteResponse = BulkAccountInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_ResendAccountInviteRequest = ResendAccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_AcceptAccountInviteRequest = AcceptAccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_AcceptAccountInviteResponse = AcceptAccountInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_RevokeAccountInviteRequest = RevokeAccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_RevokeAccountInviteResponse = RevokeAccountInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteRequest = UpdateAccountInviteRequest;\n type identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteResponse = UpdateAccountInviteResponse;\n type identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteAssignmentsRequest = UpdateAccountInviteAssignmentsRequest;\n type identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteAssignmentsResponse = UpdateAccountInviteAssignmentsResponse;\n type identityInvitesV1AccountInvite_universal_d_ParseAccountInviteTokenRequest = ParseAccountInviteTokenRequest;\n type identityInvitesV1AccountInvite_universal_d_ParseAccountInviteTokenResponse = ParseAccountInviteTokenResponse;\n const identityInvitesV1AccountInvite_universal_d_getInvites: typeof getInvites;\n const identityInvitesV1AccountInvite_universal_d_getInvite: typeof getInvite;\n const identityInvitesV1AccountInvite_universal_d_invite: typeof invite;\n type identityInvitesV1AccountInvite_universal_d_InviteOptions = InviteOptions;\n const identityInvitesV1AccountInvite_universal_d_createInvite: typeof createInvite;\n type identityInvitesV1AccountInvite_universal_d_CreateInviteOptions = CreateInviteOptions;\n const identityInvitesV1AccountInvite_universal_d_bulkInvite: typeof bulkInvite;\n type identityInvitesV1AccountInvite_universal_d_BulkInviteOptions = BulkInviteOptions;\n const identityInvitesV1AccountInvite_universal_d_resendInvite: typeof resendInvite;\n type identityInvitesV1AccountInvite_universal_d_ResendInviteOptions = ResendInviteOptions;\n const identityInvitesV1AccountInvite_universal_d_acceptInvite: typeof acceptInvite;\n type identityInvitesV1AccountInvite_universal_d_AcceptInviteOptions = AcceptInviteOptions;\n const identityInvitesV1AccountInvite_universal_d_revokeInvite: typeof revokeInvite;\n const identityInvitesV1AccountInvite_universal_d_updateInvite: typeof updateInvite;\n type identityInvitesV1AccountInvite_universal_d_UpdateInviteOptions = UpdateInviteOptions;\n const identityInvitesV1AccountInvite_universal_d_updateInviteAssignments: typeof updateInviteAssignments;\n type identityInvitesV1AccountInvite_universal_d_UpdateInviteAssignmentsOptions = UpdateInviteAssignmentsOptions;\n namespace identityInvitesV1AccountInvite_universal_d {\n export {\n __debug$1 as __debug,\n identityInvitesV1AccountInvite_universal_d_AccountInvite as AccountInvite,\n identityInvitesV1AccountInvite_universal_d_InviteStatus as InviteStatus,\n identityInvitesV1AccountInvite_universal_d_InviteResourceAssignment as InviteResourceAssignment,\n identityInvitesV1AccountInvite_universal_d_InviteAssignment as InviteAssignment,\n identityInvitesV1AccountInvite_universal_d_FullNameResource as FullNameResource,\n identityInvitesV1AccountInvite_universal_d_FullNameResourceResourceContextOneOf as FullNameResourceResourceContextOneOf,\n identityInvitesV1AccountInvite_universal_d_SiteResourceContext as SiteResourceContext,\n identityInvitesV1AccountInvite_universal_d_AccountResourceContext as AccountResourceContext,\n identityInvitesV1AccountInvite_universal_d_OrganizationResourceContext as OrganizationResourceContext,\n identityInvitesV1AccountInvite_universal_d_Resource as Resource,\n identityInvitesV1AccountInvite_universal_d_PolicyCondition as PolicyCondition,\n identityInvitesV1AccountInvite_universal_d_ConditionType as ConditionType,\n identityInvitesV1AccountInvite_universal_d_ConditionTypeOfOneOf as ConditionTypeOfOneOf,\n identityInvitesV1AccountInvite_universal_d_SimpleCondition as SimpleCondition,\n identityInvitesV1AccountInvite_universal_d_SimpleConditionValue as SimpleConditionValue,\n identityInvitesV1AccountInvite_universal_d_SimpleConditionValueValueOneOf as SimpleConditionValueValueOneOf,\n identityInvitesV1AccountInvite_universal_d_SimpleConditionOperator as SimpleConditionOperator,\n identityInvitesV1AccountInvite_universal_d_JoinedCondition as JoinedCondition,\n identityInvitesV1AccountInvite_universal_d_JoinedConditionOperator as JoinedConditionOperator,\n identityInvitesV1AccountInvite_universal_d_EnvironmentCondition as EnvironmentCondition,\n identityInvitesV1AccountInvite_universal_d_EnvironmentConditionConditionOneOf as EnvironmentConditionConditionOneOf,\n identityInvitesV1AccountInvite_universal_d_ExperimentCondition as ExperimentCondition,\n identityInvitesV1AccountInvite_universal_d_Condition as Condition,\n identityInvitesV1AccountInvite_universal_d_ConditionOperator as ConditionOperator,\n identityInvitesV1AccountInvite_universal_d_ConditionOperatorOperatorsOneOf as ConditionOperatorOperatorsOneOf,\n identityInvitesV1AccountInvite_universal_d_EqualOperator as EqualOperator,\n identityInvitesV1AccountInvite_universal_d_ConditionValue as ConditionValue,\n identityInvitesV1AccountInvite_universal_d_ConditionValueValueOneOf as ConditionValueValueOneOf,\n identityInvitesV1AccountInvite_universal_d_LikeOperator as LikeOperator,\n identityInvitesV1AccountInvite_universal_d_ExperimentOperator as ExperimentOperator,\n identityInvitesV1AccountInvite_universal_d_DependOnOperator as DependOnOperator,\n identityInvitesV1AccountInvite_universal_d_Subject as Subject,\n identityInvitesV1AccountInvite_universal_d_SubjectType as SubjectType,\n identityInvitesV1AccountInvite_universal_d_SubjectContext as SubjectContext,\n identityInvitesV1AccountInvite_universal_d_SubjectContextType as SubjectContextType,\n identityInvitesV1AccountInvite_universal_d_GetAccountInvitesRequest as GetAccountInvitesRequest,\n identityInvitesV1AccountInvite_universal_d_GetAccountInvitesResponse as GetAccountInvitesResponse,\n identityInvitesV1AccountInvite_universal_d_GetAccountInviteRequest as GetAccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_GetAccountInviteResponse as GetAccountInviteResponse,\n identityInvitesV1AccountInvite_universal_d_AccountInviteRequest as AccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_AccountInviteResponse as AccountInviteResponse,\n identityInvitesV1AccountInvite_universal_d_CreateInviteRequest as CreateInviteRequest,\n identityInvitesV1AccountInvite_universal_d_SubjectInviteAssignments as SubjectInviteAssignments,\n identityInvitesV1AccountInvite_universal_d_CreateInviteResponse as CreateInviteResponse,\n identityInvitesV1AccountInvite_universal_d_InviteFailure as InviteFailure,\n identityInvitesV1AccountInvite_universal_d_BulkAccountInviteRequest as BulkAccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_BulkAccountInviteResponse as BulkAccountInviteResponse,\n identityInvitesV1AccountInvite_universal_d_ResendAccountInviteRequest as ResendAccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_AcceptAccountInviteRequest as AcceptAccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_AcceptAccountInviteResponse as AcceptAccountInviteResponse,\n identityInvitesV1AccountInvite_universal_d_RevokeAccountInviteRequest as RevokeAccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_RevokeAccountInviteResponse as RevokeAccountInviteResponse,\n identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteRequest as UpdateAccountInviteRequest,\n identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteResponse as UpdateAccountInviteResponse,\n identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteAssignmentsRequest as UpdateAccountInviteAssignmentsRequest,\n identityInvitesV1AccountInvite_universal_d_UpdateAccountInviteAssignmentsResponse as UpdateAccountInviteAssignmentsResponse,\n identityInvitesV1AccountInvite_universal_d_ParseAccountInviteTokenRequest as ParseAccountInviteTokenRequest,\n identityInvitesV1AccountInvite_universal_d_ParseAccountInviteTokenResponse as ParseAccountInviteTokenResponse,\n identityInvitesV1AccountInvite_universal_d_getInvites as getInvites,\n identityInvitesV1AccountInvite_universal_d_getInvite as getInvite,\n identityInvitesV1AccountInvite_universal_d_invite as invite,\n identityInvitesV1AccountInvite_universal_d_InviteOptions as InviteOptions,\n identityInvitesV1AccountInvite_universal_d_createInvite as createInvite,\n identityInvitesV1AccountInvite_universal_d_CreateInviteOptions as CreateInviteOptions,\n identityInvitesV1AccountInvite_universal_d_bulkInvite as bulkInvite,\n identityInvitesV1AccountInvite_universal_d_BulkInviteOptions as BulkInviteOptions,\n identityInvitesV1AccountInvite_universal_d_resendInvite as resendInvite,\n identityInvitesV1AccountInvite_universal_d_ResendInviteOptions as ResendInviteOptions,\n identityInvitesV1AccountInvite_universal_d_acceptInvite as acceptInvite,\n identityInvitesV1AccountInvite_universal_d_AcceptInviteOptions as AcceptInviteOptions,\n identityInvitesV1AccountInvite_universal_d_revokeInvite as revokeInvite,\n identityInvitesV1AccountInvite_universal_d_updateInvite as updateInvite,\n identityInvitesV1AccountInvite_universal_d_UpdateInviteOptions as UpdateInviteOptions,\n identityInvitesV1AccountInvite_universal_d_updateInviteAssignments as updateInviteAssignments,\n identityInvitesV1AccountInvite_universal_d_UpdateInviteAssignmentsOptions as UpdateInviteAssignmentsOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface RefreshToken {\n token?: string;\n }\n interface AuthorizeRequest {\n /** Tells the authorization server which grant to execute. */\n responseType?: string;\n /** The ID of the application that asks for authorization. */\n clientId?: string;\n /** Holds a URL. A successful response from this endpoint results in a redirect to this URL. */\n redirectUri?: string | null;\n /** A list of scopes that the application requires. */\n scope?: Scope;\n /** An opaque value, used for security purposes. If this request parameter is set in the request, then it is returned to the application as part of the redirect_uri. */\n state?: string;\n /** (Optional) How the result of the authorization request is formatted */\n responseMode?: string | null;\n /** PKCE hashed code */\n codeChallenge?: string | null;\n /** PKCE hashing method */\n codeChallengeMethod?: string | null;\n /** Current client session */\n sessionToken?: string | null;\n }\n interface Scope {\n /** A list of permissions that the application requires. Empty list means the default list of scopes. */\n ids?: 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 TokenRequest extends TokenRequestGrantTypeOneOf {\n /** Authorization code given at the authorize endpoint. */\n authorizationCode?: AuthorizationCode;\n /** Authorization code given at the authorize endpoint with the PKCE extention. */\n pkce?: PKCE;\n /** Device code given at the device code endpoint. */\n deviceCode?: DeviceCode;\n /** Refresh Token that was issued by this service beforehand. */\n refreshToken?: RefreshToken;\n /** Client credentials for authenticating a client */\n clientCredentials?: ClientCredentials;\n /** Granting a pre authenticated token for basic access. */\n preAuthenticated?: PreAuthenticated;\n }\n /** @oneof */\n interface TokenRequestGrantTypeOneOf {\n /** Authorization code given at the authorize endpoint. */\n authorizationCode?: AuthorizationCode;\n /** Authorization code given at the authorize endpoint with the PKCE extention. */\n pkce?: PKCE;\n /** Device code given at the device code endpoint. */\n deviceCode?: DeviceCode;\n /** Refresh Token that was issued by this service beforehand. */\n refreshToken?: RefreshToken;\n /** Client credentials for authenticating a client */\n clientCredentials?: ClientCredentials;\n /** Granting a pre authenticated token for basic access. */\n preAuthenticated?: PreAuthenticated;\n }\n interface AuthorizationCode {\n code?: string;\n }\n interface PKCE {\n authorizationCode?: AuthorizationCode;\n /** PKCE code */\n code?: string | null;\n }\n interface DeviceCode {\n deviceCode?: string;\n }\n interface ClientCredentials {\n }\n interface PreAuthenticated {\n clientId?: string;\n }\n interface TokenResponse {\n accessToken?: AccessToken;\n refreshToken?: RefreshToken;\n }\n interface AccessToken {\n /** The access token string as issued by the authorization server. */\n token?: string;\n }\n interface DeviceCodeRequest {\n /** The ID of the application that asks for authorization. */\n clientId?: string;\n /** A list of permissions that the application requires. Empty list means the default list of scopes. */\n scope?: Scope;\n }\n interface DeviceCodeResponse {\n /** is the unique code for the device. When the user goes to the verification_uri in their browser-based device, this code will be bound to their session. */\n deviceCode?: string;\n /** contains the code that should be input at the verification_uri to authorize the device. */\n userCode?: string;\n /** contains the URL the user should visit to authorize the device. */\n verificationUri?: string;\n /** indicates the lifetime (in seconds) of the device_code and user_code. */\n expiresIn?: number;\n /** indicates the interval (in seconds) at which the app should poll the token URL to request a token. clients MUST use 5 as the default */\n interval?: number | null;\n }\n interface DeviceVerifyRequest {\n /** User code representing a currently authorizing device. */\n userCode?: string;\n }\n interface DeviceVerifyResponse {\n }\n /** @public\n * @documentationMaturity preview\n */\n function authorize(options?: AuthorizeOptions): Promise;\n interface AuthorizeOptions {\n /** Tells the authorization server which grant to execute. */\n responseType?: string;\n /** The ID of the application that asks for authorization. */\n clientId?: string;\n /** Holds a URL. A successful response from this endpoint results in a redirect to this URL. */\n redirectUri?: string | null;\n /** A list of scopes that the application requires. */\n scope?: Scope;\n /** An opaque value, used for security purposes. If this request parameter is set in the request, then it is returned to the application as part of the redirect_uri. */\n state?: string;\n /** (Optional) How the result of the authorization request is formatted */\n responseMode?: string | null;\n /** PKCE hashed code */\n codeChallenge?: string | null;\n /** PKCE hashing method */\n codeChallengeMethod?: string | null;\n /** Current client session */\n sessionToken?: string | null;\n }\n /** @public\n * @documentationMaturity preview\n */\n function token(options?: TokenOptions): Promise;\n interface TokenOptions {\n /** Authorization code given at the authorize endpoint. */\n authorizationCode?: AuthorizationCode;\n /** Authorization code given at the authorize endpoint with the PKCE extention. */\n pkce?: PKCE;\n /** Device code given at the device code endpoint. */\n deviceCode?: DeviceCode;\n /** Refresh Token that was issued by this service beforehand. */\n refreshToken?: RefreshToken;\n /** Client credentials for authenticating a client */\n clientCredentials?: ClientCredentials;\n /** Granting a pre authenticated token for basic access. */\n preAuthenticated?: PreAuthenticated;\n }\n /**\n * this endpoint serves the Device Authorization Flow as described in https://www.rfc-editor.org/rfc/pdfrfc/rfc8628.txt.pdf\n * @public\n * @documentationMaturity preview\n */\n function deviceCode(options?: DeviceCodeOptions): Promise;\n interface DeviceCodeOptions {\n /** The ID of the application that asks for authorization. */\n clientId?: string;\n /** A list of permissions that the application requires. Empty list means the default list of scopes. */\n scope?: Scope;\n }\n /**\n * this endpoint serves the Device Authorization Flow as described in https://www.rfc-editor.org/rfc/pdfrfc/rfc8628.txt.pdf\n * @public\n * @documentationMaturity preview\n */\n function deviceVerify(options?: DeviceVerifyOptions): Promise;\n interface DeviceVerifyOptions {\n /** User code representing a currently authorizing device. */\n userCode?: string;\n }\n \n const identityOauthV1RefreshToken_universal_d___debug: typeof __debug;\n type identityOauthV1RefreshToken_universal_d_RefreshToken = RefreshToken;\n type identityOauthV1RefreshToken_universal_d_AuthorizeRequest = AuthorizeRequest;\n type identityOauthV1RefreshToken_universal_d_Scope = Scope;\n type identityOauthV1RefreshToken_universal_d_RawHttpResponse = RawHttpResponse;\n type identityOauthV1RefreshToken_universal_d_HeadersEntry = HeadersEntry;\n type identityOauthV1RefreshToken_universal_d_TokenRequest = TokenRequest;\n type identityOauthV1RefreshToken_universal_d_TokenRequestGrantTypeOneOf = TokenRequestGrantTypeOneOf;\n type identityOauthV1RefreshToken_universal_d_AuthorizationCode = AuthorizationCode;\n type identityOauthV1RefreshToken_universal_d_PKCE = PKCE;\n type identityOauthV1RefreshToken_universal_d_DeviceCode = DeviceCode;\n type identityOauthV1RefreshToken_universal_d_ClientCredentials = ClientCredentials;\n type identityOauthV1RefreshToken_universal_d_PreAuthenticated = PreAuthenticated;\n type identityOauthV1RefreshToken_universal_d_TokenResponse = TokenResponse;\n type identityOauthV1RefreshToken_universal_d_AccessToken = AccessToken;\n type identityOauthV1RefreshToken_universal_d_DeviceCodeRequest = DeviceCodeRequest;\n type identityOauthV1RefreshToken_universal_d_DeviceCodeResponse = DeviceCodeResponse;\n type identityOauthV1RefreshToken_universal_d_DeviceVerifyRequest = DeviceVerifyRequest;\n type identityOauthV1RefreshToken_universal_d_DeviceVerifyResponse = DeviceVerifyResponse;\n const identityOauthV1RefreshToken_universal_d_authorize: typeof authorize;\n type identityOauthV1RefreshToken_universal_d_AuthorizeOptions = AuthorizeOptions;\n const identityOauthV1RefreshToken_universal_d_token: typeof token;\n type identityOauthV1RefreshToken_universal_d_TokenOptions = TokenOptions;\n const identityOauthV1RefreshToken_universal_d_deviceCode: typeof deviceCode;\n type identityOauthV1RefreshToken_universal_d_DeviceCodeOptions = DeviceCodeOptions;\n const identityOauthV1RefreshToken_universal_d_deviceVerify: typeof deviceVerify;\n type identityOauthV1RefreshToken_universal_d_DeviceVerifyOptions = DeviceVerifyOptions;\n namespace identityOauthV1RefreshToken_universal_d {\n export {\n identityOauthV1RefreshToken_universal_d___debug as __debug,\n identityOauthV1RefreshToken_universal_d_RefreshToken as RefreshToken,\n identityOauthV1RefreshToken_universal_d_AuthorizeRequest as AuthorizeRequest,\n identityOauthV1RefreshToken_universal_d_Scope as Scope,\n identityOauthV1RefreshToken_universal_d_RawHttpResponse as RawHttpResponse,\n identityOauthV1RefreshToken_universal_d_HeadersEntry as HeadersEntry,\n identityOauthV1RefreshToken_universal_d_TokenRequest as TokenRequest,\n identityOauthV1RefreshToken_universal_d_TokenRequestGrantTypeOneOf as TokenRequestGrantTypeOneOf,\n identityOauthV1RefreshToken_universal_d_AuthorizationCode as AuthorizationCode,\n identityOauthV1RefreshToken_universal_d_PKCE as PKCE,\n identityOauthV1RefreshToken_universal_d_DeviceCode as DeviceCode,\n identityOauthV1RefreshToken_universal_d_ClientCredentials as ClientCredentials,\n identityOauthV1RefreshToken_universal_d_PreAuthenticated as PreAuthenticated,\n identityOauthV1RefreshToken_universal_d_TokenResponse as TokenResponse,\n identityOauthV1RefreshToken_universal_d_AccessToken as AccessToken,\n identityOauthV1RefreshToken_universal_d_DeviceCodeRequest as DeviceCodeRequest,\n identityOauthV1RefreshToken_universal_d_DeviceCodeResponse as DeviceCodeResponse,\n identityOauthV1RefreshToken_universal_d_DeviceVerifyRequest as DeviceVerifyRequest,\n identityOauthV1RefreshToken_universal_d_DeviceVerifyResponse as DeviceVerifyResponse,\n identityOauthV1RefreshToken_universal_d_authorize as authorize,\n identityOauthV1RefreshToken_universal_d_AuthorizeOptions as AuthorizeOptions,\n identityOauthV1RefreshToken_universal_d_token as token,\n identityOauthV1RefreshToken_universal_d_TokenOptions as TokenOptions,\n identityOauthV1RefreshToken_universal_d_deviceCode as deviceCode,\n identityOauthV1RefreshToken_universal_d_DeviceCodeOptions as DeviceCodeOptions,\n identityOauthV1RefreshToken_universal_d_deviceVerify as deviceVerify,\n identityOauthV1RefreshToken_universal_d_DeviceVerifyOptions as DeviceVerifyOptions,\n };\n }\n \n export { identityInvitesV1AccountInvite_universal_d as invitesService, identityOauthV1RefreshToken_universal_d as oauth };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-entitlements-backend.d.ts", "content": "declare module \"wix-entitlements-backend\" {\n const __debug$2: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Balance {\n /**\n * The entitlement from which the balance has originated\n * @readonly\n */\n poolId?: string;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * The owner of this balance\n * @readonly\n */\n beneficiary?: IdentificationData$2;\n /** Balance for the entitlement */\n balance?: BalanceAmount;\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 /** 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 * @internal\n * @readonly\n */\n identityType?: IdentityType$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 IdentityType$2 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface BalanceAmount {\n /**\n * Represents the sum of the available credits for the entitlement\n * @readonly\n */\n available?: string;\n }\n interface GetBalanceRequest {\n /** The id of the entitlement */\n poolId: string;\n }\n interface GetBalanceResponse {\n /** Requested balance */\n balance?: Balance;\n }\n interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {\n /** Applies the delta to the current balance. If 0, change won't be performed, but the transaction is still going to be reported */\n adjustOptions?: AdjustOptions;\n /** Sets the balance to any amount. If the set amount is the same as the current balance no action will be performed */\n setOptions?: SetOptions;\n /**\n * Sets the initial balance to any amount. Initializes the entitlement account. Must be the first operation performed on the account and only called once\n * All subsequent SetInitialOperations will fail.\n */\n setInitialOptions?: SetInitialOptions;\n /** The id of the entitlement */\n poolId: string;\n /** Unique value generated by the client which the service uses to recognize subsequent retries of the same request */\n idempotencyKey: string;\n /** Party that initiated this change. Could be the site use, the entitlement owner or the beneficiary */\n instructingParty?: IdentificationData$2;\n /** The operation to perform on the balance */\n type?: Type$1;\n }\n /** @oneof */\n interface ChangeBalanceRequestOperationOneOf {\n /** Applies the delta to the current balance. If 0, change won't be performed, but the transaction is still going to be reported */\n adjustOptions?: AdjustOptions;\n /** Sets the balance to any amount. If the set amount is the same as the current balance no action will be performed */\n setOptions?: SetOptions;\n /**\n * Sets the initial balance to any amount. Initializes the entitlement account. Must be the first operation performed on the account and only called once\n * All subsequent SetInitialOperations will fail.\n */\n setInitialOptions?: SetInitialOptions;\n }\n enum Type$1 {\n UNKNOWN_OPERATION = \"UNKNOWN_OPERATION\",\n ADJUST = \"ADJUST\",\n SET = \"SET\",\n SET_INITIAL = \"SET_INITIAL\"\n }\n interface AdjustOptions {\n /** Change the available balance by the provided amount. Can be negative and positive values. */\n amount?: string;\n /** Beneficiary of the operation */\n beneficiary?: IdentificationData$2;\n /** Related item id to the balance change */\n itemId?: string | null;\n }\n interface SetOptions {\n /** Set the available balance to the provided amount. */\n amount?: string;\n /** Beneficiary of the transaction */\n beneficiary?: IdentificationData$2;\n }\n interface SetInitialOptions {\n /** Set the available balance to the provided amount. */\n amount?: string;\n /** Beneficiary of the transaction */\n beneficiary?: IdentificationData$2;\n }\n interface ChangeBalanceResponse {\n /** Changed balance */\n balance?: Balance;\n /** Id of the resulting transaction from balance change operation */\n transactionId?: string | null;\n }\n interface BalanceChanged {\n /** Balance after change */\n balance?: Balance;\n /** Transaction that made the change */\n lastTransaction?: Transaction$1;\n }\n interface Transaction$1 {\n /** @readonly */\n _id?: string | null;\n /**\n * Represents the time the transaction was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * The entitlement from which the balance was changed\n * @readonly\n */\n poolId?: string;\n /**\n * The item for which the balance was changed, used only for records\n * @readonly\n */\n itemId?: string | null;\n /**\n * Amount to adjust the balance with. Can be negative.\n * @readonly\n */\n amount?: string;\n /**\n * The type defines different functionalities. Use DEBIT_AVAILABLE for normal balance debiting.\n * @readonly\n */\n type?: TransactionType$1;\n /**\n * Generated idempotency key from the client when making a change to the balance.\n * @readonly\n */\n idempotencyKey?: string;\n /**\n * Free format string\n * @readonly\n */\n reason?: string | null;\n /**\n * The identity that benefited from this transaction\n * @readonly\n */\n beneficiary?: IdentificationData$2;\n /**\n * Related transaction id. For example - for a reservation cancellation transaction, the related transaction is the redemption itself.\n * @readonly\n */\n relatedTransactionId?: string | null;\n /**\n * The identity that created this transaction\n * @readonly\n */\n instructingParty?: IdentificationData$2;\n /**\n * status of the transaction\n * @readonly\n */\n status?: TransactionStatus$1;\n }\n enum TransactionType$1 {\n UNDEFINED = \"UNDEFINED\",\n /** Debits the AVAILABLE balance */\n DEBIT_AVAILABLE = \"DEBIT_AVAILABLE\",\n /** Moves the balance from AVAILABLE to RESERVED */\n RESERVE = \"RESERVE\",\n /** Debits the RESERVED balance */\n RELEASE_RESERVATION = \"RELEASE_RESERVATION\",\n /** Moves the balance back from RESERVED to AVAILABLE */\n CANCEL_RESERVATION = \"CANCEL_RESERVATION\",\n /** Credits the AVAILABLE balance */\n CREDIT_AVAILABLE = \"CREDIT_AVAILABLE\",\n /** Transaction type used for reporting free item usage */\n NO_CHANGE = \"NO_CHANGE\"\n }\n enum TransactionStatus$1 {\n UNDEFINED = \"UNDEFINED\",\n /** Transaction is pending. This is the initial status of the transaction. Once the balance is updated, the transaction will become COMPLETED. If the balance update fails, the transaction will become FAILED. */\n PENDING = \"PENDING\",\n /** Transaction is completed */\n COMPLETED = \"COMPLETED\",\n /** Transaction is failed */\n FAILED = \"FAILED\"\n }\n interface BalanceReachedZero {\n /** Balance after change */\n balance?: Balance;\n /** Transaction that made the change */\n lastTransaction?: Transaction$1;\n }\n interface TransactionAlreadyExists {\n /** The id of the transaction which already exists with the same idempotency key */\n transactionId?: string;\n }\n interface NotEnoughBalance$1 {\n /** Current balance */\n balance?: BalanceAmount;\n /**\n * The requested amount\n * @readonly\n */\n requested?: string;\n }\n interface RevertBalanceChangeRequest {\n /** Reverts the change to the balance made by the provided transaction */\n transactionId: string;\n /** Unique value generated by the client which the service uses to recognize subsequent retries of the same request */\n idempotencyKey: string;\n /** Party that initiated this change. Could be the site use, the entitlement owner or the beneficiary */\n instructingParty?: IdentificationData$2;\n }\n interface RevertBalanceChangeResponse {\n /** Id of the created reverse transaction */\n transactionId?: string | null;\n }\n interface ChangeAlreadyReverted {\n /** The id of the transaction which was already reverted */\n originalTransactionId?: string;\n /** The id of the transaction which reverted the original transaction */\n revertedTransactionId?: string;\n }\n interface ChangeIsNotReversible {\n /** The id of the transaction which cannot be reverted */\n transactionId?: string;\n }\n /**\n * Get the balance in the entitlement.\n *\n * This function is not a universal function and runs only on the backend.\n * @param poolId - The id of the entitlement\n * @internal\n * @documentationMaturity preview\n * @requiredField poolId\n * @adminMethod\n * @returns Requested balance\n */\n function getBalance(poolId: string): Promise;\n /**\n * Change balance using one of these operations:\n * ADJUST\n * SET\n * SET_INITIAL\n *\n * This function is not a universal function and runs only on the backend.\n * @param poolId - The id of the entitlement\n * @param idempotencyKey - Unique value generated by the client which the service uses to recognize subsequent retries of the same request\n * @internal\n * @documentationMaturity preview\n * @requiredField idempotencyKey\n * @requiredField poolId\n * @adminMethod\n */\n function changeBalance(poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions): Promise;\n interface ChangeBalanceOptions extends ChangeBalanceRequestOperationOneOf {\n /** Party that initiated this change. Could be the site use, the entitlement owner or the beneficiary */\n instructingParty?: IdentificationData$2;\n /** The operation to perform on the balance */\n type?: Type$1;\n /** Applies the delta to the current balance. If 0, change won't be performed, but the transaction is still going to be reported */\n adjustOptions?: AdjustOptions;\n /** Sets the balance to any amount. If the set amount is the same as the current balance no action will be performed */\n setOptions?: SetOptions;\n /**\n * Sets the initial balance to any amount. Initializes the entitlement account. Must be the first operation performed on the account and only called once\n * All subsequent SetInitialOperations will fail.\n */\n setInitialOptions?: SetInitialOptions;\n }\n /**\n * Reverts balance change done with ChangeBalance\n *\n * This function is not a universal function and runs only on the backend.\n * @param transactionId - Reverts the change to the balance made by the provided transaction\n * @param idempotencyKey - Unique value generated by the client which the service uses to recognize subsequent retries of the same request\n * @internal\n * @documentationMaturity preview\n * @requiredField idempotencyKey\n * @requiredField transactionId\n * @adminMethod\n */\n function revertBalanceChange(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions): Promise;\n interface RevertBalanceChangeOptions {\n /** Party that initiated this change. Could be the site use, the entitlement owner or the beneficiary */\n instructingParty?: IdentificationData$2;\n }\n \n type entitlementsV1Balance_universal_d_Balance = Balance;\n type entitlementsV1Balance_universal_d_BalanceAmount = BalanceAmount;\n type entitlementsV1Balance_universal_d_GetBalanceRequest = GetBalanceRequest;\n type entitlementsV1Balance_universal_d_GetBalanceResponse = GetBalanceResponse;\n type entitlementsV1Balance_universal_d_ChangeBalanceRequest = ChangeBalanceRequest;\n type entitlementsV1Balance_universal_d_ChangeBalanceRequestOperationOneOf = ChangeBalanceRequestOperationOneOf;\n type entitlementsV1Balance_universal_d_AdjustOptions = AdjustOptions;\n type entitlementsV1Balance_universal_d_SetOptions = SetOptions;\n type entitlementsV1Balance_universal_d_SetInitialOptions = SetInitialOptions;\n type entitlementsV1Balance_universal_d_ChangeBalanceResponse = ChangeBalanceResponse;\n type entitlementsV1Balance_universal_d_BalanceChanged = BalanceChanged;\n type entitlementsV1Balance_universal_d_BalanceReachedZero = BalanceReachedZero;\n type entitlementsV1Balance_universal_d_TransactionAlreadyExists = TransactionAlreadyExists;\n type entitlementsV1Balance_universal_d_RevertBalanceChangeRequest = RevertBalanceChangeRequest;\n type entitlementsV1Balance_universal_d_RevertBalanceChangeResponse = RevertBalanceChangeResponse;\n type entitlementsV1Balance_universal_d_ChangeAlreadyReverted = ChangeAlreadyReverted;\n type entitlementsV1Balance_universal_d_ChangeIsNotReversible = ChangeIsNotReversible;\n const entitlementsV1Balance_universal_d_getBalance: typeof getBalance;\n const entitlementsV1Balance_universal_d_changeBalance: typeof changeBalance;\n type entitlementsV1Balance_universal_d_ChangeBalanceOptions = ChangeBalanceOptions;\n const entitlementsV1Balance_universal_d_revertBalanceChange: typeof revertBalanceChange;\n type entitlementsV1Balance_universal_d_RevertBalanceChangeOptions = RevertBalanceChangeOptions;\n namespace entitlementsV1Balance_universal_d {\n export {\n __debug$2 as __debug,\n entitlementsV1Balance_universal_d_Balance as Balance,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n IdentityType$2 as IdentityType,\n entitlementsV1Balance_universal_d_BalanceAmount as BalanceAmount,\n entitlementsV1Balance_universal_d_GetBalanceRequest as GetBalanceRequest,\n entitlementsV1Balance_universal_d_GetBalanceResponse as GetBalanceResponse,\n entitlementsV1Balance_universal_d_ChangeBalanceRequest as ChangeBalanceRequest,\n entitlementsV1Balance_universal_d_ChangeBalanceRequestOperationOneOf as ChangeBalanceRequestOperationOneOf,\n Type$1 as Type,\n entitlementsV1Balance_universal_d_AdjustOptions as AdjustOptions,\n entitlementsV1Balance_universal_d_SetOptions as SetOptions,\n entitlementsV1Balance_universal_d_SetInitialOptions as SetInitialOptions,\n entitlementsV1Balance_universal_d_ChangeBalanceResponse as ChangeBalanceResponse,\n entitlementsV1Balance_universal_d_BalanceChanged as BalanceChanged,\n Transaction$1 as Transaction,\n TransactionType$1 as TransactionType,\n TransactionStatus$1 as TransactionStatus,\n entitlementsV1Balance_universal_d_BalanceReachedZero as BalanceReachedZero,\n entitlementsV1Balance_universal_d_TransactionAlreadyExists as TransactionAlreadyExists,\n NotEnoughBalance$1 as NotEnoughBalance,\n entitlementsV1Balance_universal_d_RevertBalanceChangeRequest as RevertBalanceChangeRequest,\n entitlementsV1Balance_universal_d_RevertBalanceChangeResponse as RevertBalanceChangeResponse,\n entitlementsV1Balance_universal_d_ChangeAlreadyReverted as ChangeAlreadyReverted,\n entitlementsV1Balance_universal_d_ChangeIsNotReversible as ChangeIsNotReversible,\n entitlementsV1Balance_universal_d_getBalance as getBalance,\n entitlementsV1Balance_universal_d_changeBalance as changeBalance,\n entitlementsV1Balance_universal_d_ChangeBalanceOptions as ChangeBalanceOptions,\n entitlementsV1Balance_universal_d_revertBalanceChange as revertBalanceChange,\n entitlementsV1Balance_universal_d_RevertBalanceChangeOptions as RevertBalanceChangeOptions,\n };\n }\n \n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * This represents the current state of what the beneficiary is entitled to. Entitlement is always created in the image of the template.\n * + Entitlement supports basic lifecycle, can be paused or resumed. E.g. for recurring entitlements they should be active only when the underlying subscription is active. Redemption would fail on a non-active entitlement\n * + Entitlement may be recurring. Recurrence is driven by an external system (e.g. pricing plans order billing cycle) via the grant method of this API.\n * + Depending on user input updates to entitlement templates may cascade to entitlements in 3 different ways:\n * + On Provision\n * + On Grant\n * + Immediately\n *\n * Entitlements much like their templates are also grouped together in packages which are identified by their id.\n * When entitlements are provisioned from either a single template or a template package they are always assigned to a new entitlement package (id provided by the caller). This reference\n * is then used throughout the lifecycle of the entitlement.\n */\n interface Entitlement {\n /**\n * Entitlement ID\n * @readonly\n */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this Entitlement was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Entitlement was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Template that this entitlement was created from\n * @readonly\n */\n templateId?: string;\n /**\n * Template package from which this entitlement was provisioned from\n * @readonly\n */\n templatePackageId?: string | null;\n /**\n * Package that this entitlement belongs to\n * @readonly\n */\n packageId?: string;\n /**\n * Status of entitlement\n * @readonly\n */\n status?: EntitlementStatus;\n /** Who is getting the entitlement */\n beneficiary?: IdentificationData$1;\n /** Items and policies how the entitlement works */\n details?: EntitlementDetails;\n /**\n * Name of the entitlement template that this Entitlement was provisioned from\n * @readonly\n */\n name?: string;\n /**\n * ID of the app that this entitlement belongs to\n * @readonly\n */\n appId?: string;\n }\n enum EntitlementStatus {\n UNDEFINED = \"UNDEFINED\",\n ACTIVE = \"ACTIVE\",\n PAUSED = \"PAUSED\",\n ENDED = \"ENDED\"\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 /** 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 * @internal\n * @readonly\n */\n identityType?: IdentityType$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 IdentityType$1 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface EntitlementDetails {\n /** A set of benefits that share the credit pool and policies of the entitlement */\n benefits?: Benefit[];\n /** Settings that control the behavior of the credit pool. If this value is left empty, then the entitlement is unlimited and items should not have prices */\n creditConfiguration?: CreditConfiguration;\n /** Defines entitlement eligibility. Default policy for all items, but may be overridden by a specific item */\n policyExpression?: PolicyExpression;\n /** Additional info that was set by the Entitlement Provider */\n additionalData?: Record | null;\n /** Entitlement provider */\n provider?: Provider;\n }\n /** Groups items that share the same credit pool and policies */\n interface Benefit {\n /** A unique identifier for the group. May be empty, but only one group can have an empty key */\n benefitKey?: string;\n /** A set of items that share the credit pool and policies of the entitlement */\n items?: Item[];\n /** Price of the item expressed in credits */\n price?: string | null;\n /** Overrides the default policies in Entitlement Data */\n policyExpression?: PolicyExpression;\n /** Additional info that was set by the Entitlement Provider */\n additionalData?: Record | null;\n }\n /**\n * Represents anything that an external system exposes as an entitlement. It could be a specific event, a booking session, or even a physical good.\n * `category` is used to identify the type of the item and id is used to uniquely identify it within the category. The `name` is used for display purposes only.\n * For example, if the item is a blog post, then the category could be \"post\" and the id could be the post id.\n */\n interface Item {\n /** External item identifier */\n _id?: string;\n /** Item category. Discriminates between different types of items. E.g. posts, groups etc. */\n category?: string | null;\n /** Name of the item */\n name?: string | null;\n }\n interface PolicyExpression extends PolicyExpressionExpressionOneOf {\n /** Negates the expression */\n operatorNotOptions?: PolicyExpressionNot;\n /** Combines the expressions with an `AND` operator */\n operatorAndOptions?: PolicyExpressionAnd;\n /** Combines the expressions with an `OR` operator */\n operatorOrOptions?: PolicyExpressionOr;\n /** Represents the specific policy */\n policyOptions?: Policy;\n type?: PolicyExpressionType;\n }\n /** @oneof */\n interface PolicyExpressionExpressionOneOf {\n /** Negates the expression */\n operatorNotOptions?: PolicyExpressionNot;\n /** Combines the expressions with an `AND` operator */\n operatorAndOptions?: PolicyExpressionAnd;\n /** Combines the expressions with an `OR` operator */\n operatorOrOptions?: PolicyExpressionOr;\n /** Represents the specific policy */\n policyOptions?: Policy;\n }\n enum PolicyExpressionType {\n UNKNOWN = \"UNKNOWN\",\n OPERATOR_NOT = \"OPERATOR_NOT\",\n OPERATOR_AND = \"OPERATOR_AND\",\n OPERATOR_OR = \"OPERATOR_OR\",\n POLICY = \"POLICY\"\n }\n interface PolicyExpressionNot {\n /** Expression that is negated */\n expression?: PolicyExpression;\n }\n interface PolicyExpressionAnd {\n /** Expressions that are combined with an `AND` operator */\n expressions?: PolicyExpression[];\n }\n interface PolicyExpressionOr {\n /** Expressions that are combined with an `OR` operator */\n expressions?: PolicyExpression[];\n }\n interface Policy extends PolicyPolicyOneOf {\n /** Policy which defines entitlement eligibility on particular days or hours */\n fixedIntervalOptions?: FixedIntervalPolicy;\n /** Policy which limits entitlement usage per time unit */\n rateLimitedOptions?: RateLimitedPolicy;\n /** Custom policy definition that is controlled by the CustomPolicyProvider */\n customOptions?: CustomPolicy;\n /** Policy type */\n type?: Type;\n }\n /** @oneof */\n interface PolicyPolicyOneOf {\n /** Policy which defines entitlement eligibility on particular days or hours */\n fixedIntervalOptions?: FixedIntervalPolicy;\n /** Policy which limits entitlement usage per time unit */\n rateLimitedOptions?: RateLimitedPolicy;\n /** Custom policy definition that is controlled by the CustomPolicyProvider */\n customOptions?: CustomPolicy;\n }\n enum Type {\n UNKNOWN = \"UNKNOWN\",\n FIXED_INTERVAL = \"FIXED_INTERVAL\",\n RATE_LIMITED = \"RATE_LIMITED\",\n CUSTOM = \"CUSTOM\"\n }\n interface FixedIntervalPolicy {\n /** Weekday that this interval starts from. If this is set then to_week_day must also be set */\n fromWeekDay?: WeekDay;\n /** Weekday that this interval ends at. If this is set then from_week_day must also be set */\n toWeekDay?: WeekDay;\n /** Hour that this interval starts from. If this is set then to_hour must also be set */\n fromHour?: number | null;\n /** Hour that this interval ends at. If this is set then from_hour must also be set */\n toHour?: number | null;\n /** Minute that this interval starts from. If this is set then to_minute must also be set */\n fromMinute?: number | null;\n /** Minute that this interval ends at. If this is set then from_minute must also be set */\n toMinute?: number | null;\n }\n enum WeekDay {\n UNKNOWN = \"UNKNOWN\",\n MONDAY = \"MONDAY\",\n TUESDAY = \"TUESDAY\",\n WEDNESDAY = \"WEDNESDAY\",\n THURSDAY = \"THURSDAY\",\n FRIDAY = \"FRIDAY\",\n SATURDAY = \"SATURDAY\",\n SUNDAY = \"SUNDAY\"\n }\n interface RateLimitedPolicy extends RateLimitedPolicyPeriodOneOf {\n /** Policy which defines entitlement eligibility on particular days or hours */\n fixedIntervalOptions?: FixedIntervalPolicy;\n /** Defines how many times it's allowed to consume a item over the period */\n times?: number;\n /** Type of period */\n type?: RateLimitedPolicyType;\n }\n /** @oneof */\n interface RateLimitedPolicyPeriodOneOf {\n /** Policy which defines entitlement eligibility on particular days or hours */\n fixedIntervalOptions?: FixedIntervalPolicy;\n }\n enum RateLimitedPolicyType {\n UNKNOWN = \"UNKNOWN\",\n FIXED_INTERVAL = \"FIXED_INTERVAL\",\n PER_CYCLE = \"PER_CYCLE\"\n }\n /** Custom policy as implemented by the Entitlement Policy Provider */\n interface CustomPolicy {\n /** References a specific custom policy on the provider's system */\n _id?: string | null;\n /** Custom policy provider id */\n appId?: string | null;\n /** Additional info for this custom policy. It's going to be passed to the policy provider during eligibility checks */\n additionalData?: Record | null;\n }\n interface CreditConfiguration {\n /** The total amount of credits available for this entitlement */\n amount?: string;\n /** Unused credits are rolled over to the new cycle */\n rollOver?: boolean;\n }\n interface Provider {\n /** AppId of a provider defined in a dev center which implements this entitlement custom lifecycle and redeem logic */\n appId?: string;\n /** Type of the entitlement, giving information to the SPI implementer so it knows what kind of entitlement it is */\n type?: string;\n }\n interface CreateEntitlementRequest {\n /** Entitlement to be created */\n entitlement: Entitlement;\n }\n interface CreateEntitlementResponse {\n /** The created Entitlement */\n entitlement?: Entitlement;\n }\n interface GetEntitlementRequest {\n /** Id of the Entitlement to retrieve */\n entitlementId: string;\n }\n interface GetEntitlementResponse {\n /** The retrieved Entitlement */\n entitlement?: Entitlement;\n }\n interface UpdateEntitlementRequest {\n /** Entitlement to be updated, may be partial */\n entitlement: Entitlement;\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateEntitlementResponse {\n /** The updated Entitlement */\n entitlement?: Entitlement;\n }\n interface DeleteEntitlementRequest {\n /** Id of the Entitlement to delete */\n entitlementId: string;\n /** The revision of the Entitlement */\n revision?: string;\n }\n interface DeleteEntitlementResponse {\n }\n /** In case template_id is provided should test if it's part of a package. If it is, reject the request */\n interface ProvisionEntitlementsRequest {\n /** Reference of the template that is used to provision the entitlements */\n templateReference: EntitlementTemplateReference;\n /** The main beneficiary of the entitlement */\n beneficiary: IdentificationData$1;\n /** Package that the provisioned entitlement is part of */\n packageId: string;\n }\n interface EntitlementTemplateReference extends EntitlementTemplateReferenceIdOneOf {\n /** Individual entitlement template */\n templateId?: string;\n /** Package of entitlement templates */\n templatePackageId?: string;\n }\n /** @oneof */\n interface EntitlementTemplateReferenceIdOneOf {\n /** Individual entitlement template */\n templateId?: string;\n /** Package of entitlement templates */\n templatePackageId?: string;\n }\n interface ProvisionEntitlementsResponse {\n /** Created entitlements as a result of provision */\n entitlements?: Entitlement[];\n }\n interface PackageAlreadyExists {\n /** Package id that already has entitlements */\n packageId?: string;\n }\n /** Updates the entitlement according to its template and grants credits */\n interface GrantEntitlementRequest {\n /** Package of entitlements to grant. Package id should be the same that was used to provision entitlements. */\n packageId: string;\n }\n interface GrantEntitlementResponse {\n /** Updated entitlements as a result of the grant */\n entitlements?: Entitlement[];\n }\n interface EntitlementGranted {\n /** Entitlement which has been granted */\n entitlement?: Entitlement;\n }\n interface QueryEntitlementsRequest {\n /** WQL expression */\n query: CursorQuery$1;\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$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 * 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 }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$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 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 /** 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 QueryEntitlementsResponse {\n /** The retrieved Entitlements */\n entitlements?: Entitlement[];\n /** Paging information */\n metadata?: 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 PauseEntitlementRequest {\n /** Package of entitlements */\n packageId: string;\n }\n interface PauseEntitlementResponse {\n /** Entitlements that were updated as a result of this request */\n entitlements?: Entitlement[];\n }\n interface EntitlementPaused {\n /** Entitlement which has been paused */\n entitlement?: Entitlement;\n }\n interface ResumeEntitlementRequest {\n /** Package of entitlements */\n packageId: string;\n }\n interface ResumeEntitlementResponse {\n /** Entitlements that were updated as a result of this request */\n entitlements?: Entitlement[];\n }\n interface EntitlementResumed {\n /** Entitlement which has been resumed */\n entitlement?: Entitlement;\n }\n interface EndEntitlementRequest {\n /** Package of entitlements */\n packageId: string;\n }\n interface EndEntitlementResponse {\n /** Entitlements that were updated as a result of this request */\n entitlements?: Entitlement[];\n }\n interface EntitlementEnded {\n /** Entitlement which has been ended */\n entitlement?: Entitlement;\n }\n interface RedeemEntitlementRequest {\n /** Id of the entitlement that is being redeemed from */\n entitlementId: string;\n /** Reference of the item that is being redeemed */\n itemReference?: ItemReference;\n /** If provided it will force the redemption to be done from the specific benefit instead of the first eligible one */\n benefitKey?: string | null;\n /** Number of of items to redeem */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by policy providers\n */\n targetDate?: Date;\n /** Idempotency key */\n idempotencyKey: string;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n interface ItemReference {\n /** Id of the item */\n _id?: string;\n /** Item category */\n category?: string | null;\n }\n interface RedeemEntitlementResponse {\n /** Id of the resulting transaction */\n transactionId?: string;\n }\n interface EntitlementRedeemed {\n /** Entitlement which has been redeemed */\n entitlement?: Entitlement;\n /** Details of the redemption */\n redemptionDetails?: RedemptionDetails;\n }\n interface RedemptionDetails {\n /** Id of the redemption transaction */\n transactionId?: string;\n /** Reference of the item that is being redeemed */\n itemReference?: ItemReference;\n /** Number of of items to redeem */\n itemCount?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by entitlement providers\n */\n targetDate?: Date;\n /** Idempotency key */\n idempotencyKey?: string;\n /** Additional info provided during redemption */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement */\n beneficiary?: IdentificationData$1;\n }\n interface NotEnoughBalance {\n /** Entitlement ID */\n entitlementId?: string;\n /** Item reference */\n itemReference?: ItemReference;\n /** Price of the item expressed in credits */\n availableBalance?: string;\n /** Price of the item expressed in credits */\n requestedBalance?: string;\n }\n interface PolicyExpressionEvaluatedToFalse {\n /** Entitlement ID */\n entitlementId?: string;\n /** Item reference */\n itemReference?: ItemReference;\n }\n interface EntitlementNotActive {\n /** Entitlement ID */\n entitlementId?: string;\n /** Entitlement status */\n entitlementStatus?: EntitlementStatus;\n }\n interface EntitlementAlreadyRedeemed {\n /** Entitlement ID */\n entitlementId?: string;\n /** Transaction that was used to redeem the entitlement */\n transactionId?: string;\n /** Idempotency key of the request that failed */\n idempotencyKey?: string;\n }\n interface ReserveEntitlementRequest {\n /** Id of the entitlement that is being redeemed from */\n entitlementId: string;\n /** Reference of the item that is being redeemed */\n itemReference?: ItemReference;\n /** If provided it will force the redemption to be done from the specific benefit instead of the first eligible one */\n benefitKey?: string | null;\n /** Number of items to redeem */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by Policy providers\n */\n targetDate?: Date;\n /** Idempotency key */\n idempotencyKey: string;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n interface ReserveEntitlementResponse {\n /** Id of the transaction that was created as a result of this request */\n transactionId?: string;\n }\n interface EntitlementReserved {\n /** Entitlement which was used to perform this transaction */\n entitlement?: Entitlement;\n /** Details of the redemption */\n redemptionDetails?: RedemptionDetails;\n }\n interface CancelEntitlementReservationRequest {\n /** Id of the transaction that was created as a result of this request */\n transactionId: string;\n }\n interface CancelEntitlementReservationResponse {\n /** Id of the transaction that was created as a result of this request */\n transactionId?: string;\n }\n interface EntitlementReservationCanceled {\n /** Entitlement which was used to perform this transaction */\n entitlement?: Entitlement;\n /** Id of the canceled reservation transaction */\n transactionId?: string;\n }\n interface ReleaseEntitlementReservationRequest {\n /** Id of the transaction that was created as a result of this request */\n transactionId: string;\n }\n interface ReleaseEntitlementReservationResponse {\n /** Id of the transaction that was created as a result of this request */\n transactionId?: string;\n }\n interface EntitlementReservationReleased {\n /** Entitlement which was used to perform this transaction */\n entitlement?: Entitlement;\n /** Id of the released reservation transaction */\n transactionId?: string;\n }\n interface CheckEntitlementEligibilityRequest {\n /** Id of the entitlement to check eligibility for */\n entitlementId: string;\n /** Reference of the item for which to check entitlement's eligibility */\n itemReference?: ItemReference;\n /** If provided it will force the redemption to be done from the specific benefit instead of the first eligible one */\n benefitKey?: string | null;\n /** Number of items to check eligibility for. This number if checked against the policies and credit pool of the entitlements */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by entitlement providers\n */\n targetDate?: Date;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n interface CheckEntitlementEligibilityResponse {\n /** The result of the eligibility check. Indicates whether the entitlement is eligible for redemption, and if not, returns the reason */\n result?: EligibilityCheckResult;\n }\n enum EligibilityCheckResult {\n UNKNOWN = \"UNKNOWN\",\n ELIGIBLE = \"ELIGIBLE\",\n NOT_ENOUGH_BALANCE = \"NOT_ENOUGH_BALANCE\",\n POLICY_EXPRESSION_EVALUATED_TO_FALSE = \"POLICY_EXPRESSION_EVALUATED_TO_FALSE\",\n ENTITLEMENT_NOT_ACTIVE = \"ENTITLEMENT_NOT_ACTIVE\"\n }\n /** TODO provide a bulk version of this endpoint */\n interface GetEligibleEntitlementsRequest {\n /** Reference of the item for which all eligible entitlements will be returned */\n itemReference?: ItemReference;\n /** Number of items to check eligibility for. This number is checked against the policies and credit pool of the entitlements */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by entitlement providers\n */\n targetDate?: Date;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n interface GetEligibleEntitlementsResponse {\n /** Eligible benefits */\n eligibleBenefits?: EligibleBenefit[];\n }\n interface EligibleBenefit {\n /**\n * Entitlement ID\n * @readonly\n */\n entitlementId?: string;\n /** A unique identifier for the group. May be empty, but only one group can have an empty key */\n benefitKey?: string;\n /** Item reference */\n itemReference?: ItemReference;\n /** Price of the item expressed in credits */\n price?: string | null;\n }\n /**\n * Creates a new Entitlement\n *\n * This function is not a universal function and runs only on the backend.\n * @param entitlement - Entitlement to be created\n * @internal\n * @documentationMaturity preview\n * @requiredField entitlement\n * @adminMethod\n * @returns The created Entitlement\n */\n function createEntitlement(entitlement: Entitlement): Promise;\n /**\n * Get an Entitlement by id\n *\n * This function is not a universal function and runs only on the backend.\n * @param entitlementId - Id of the Entitlement to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField entitlementId\n * @adminMethod\n * @returns The retrieved Entitlement\n */\n function getEntitlement(entitlementId: string): Promise;\n /**\n * Update an Entitlement, supports partial update\n * Pass the latest `revision` for a successful update\n *\n * This function is not a universal function and runs only on the backend.\n * @param _id - Entitlement ID\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField entitlement\n * @requiredField entitlement.revision\n * @adminMethod\n * @returns The updated Entitlement\n */\n function updateEntitlement(_id: string | null, entitlement: UpdateEntitlement, options?: UpdateEntitlementOptions): Promise;\n interface UpdateEntitlement {\n /**\n * Entitlement ID\n * @readonly\n */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */\n revision?: string | null;\n /**\n * Represents the time this Entitlement was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Entitlement was last updated\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Template that this entitlement was created from\n * @readonly\n */\n templateId?: string;\n /**\n * Template package from which this entitlement was provisioned from\n * @readonly\n */\n templatePackageId?: string | null;\n /**\n * Package that this entitlement belongs to\n * @readonly\n */\n packageId?: string;\n /**\n * Status of entitlement\n * @readonly\n */\n status?: EntitlementStatus;\n /** Who is getting the entitlement */\n beneficiary?: IdentificationData$1;\n /** Items and policies how the entitlement works */\n details?: EntitlementDetails;\n /**\n * Name of the entitlement template that this Entitlement was provisioned from\n * @readonly\n */\n name?: string;\n /**\n * ID of the app that this entitlement belongs to\n * @readonly\n */\n appId?: string;\n }\n interface UpdateEntitlementOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Delete an Entitlement\n *\n * This function is not a universal function and runs only on the backend.\n * @param entitlementId - Id of the Entitlement to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField entitlementId\n * @adminMethod\n */\n function deleteEntitlement(entitlementId: string, options?: DeleteEntitlementOptions): Promise;\n interface DeleteEntitlementOptions {\n /** The revision of the Entitlement */\n revision?: string;\n }\n /**\n * Provision entitlements from an individual template or a package of templates\n *\n * This function is not a universal function and runs only on the backend.\n * @param templateReference - Reference of the template that is used to provision the entitlements\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.beneficiary\n * @requiredField options.packageId\n * @requiredField templateReference\n * @adminMethod\n */\n function provisionEntitlements(templateReference: EntitlementTemplateReference, options: ProvisionEntitlementsOptions): Promise;\n interface ProvisionEntitlementsOptions {\n /** The main beneficiary of the entitlement */\n beneficiary: IdentificationData$1;\n /** Package that the provisioned entitlement is part of */\n packageId: string;\n }\n /**\n * Grants the entitlements as defined in the entitlement template configuration.\n * Typically used if the entitlement is cyclical to renew the credit pool on new cycle\n *\n * This function is not a universal function and runs only on the backend.\n * @param packageId - Package of entitlements to grant. Package id should be the same that was used to provision entitlements.\n * @internal\n * @documentationMaturity preview\n * @requiredField packageId\n * @adminMethod\n */\n function grantEntitlement(packageId: string): Promise;\n /**\n * Query Entitlements using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n *\n * This function is not a universal function and runs only on the backend.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryEntitlements(): EntitlementsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface EntitlementsQueryResult extends QueryCursorResult$1 {\n items: Entitlement[];\n query: EntitlementsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface EntitlementsQueryBuilder {\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' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'details' | 'details.benefits.benefitKey' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId', value: any) => EntitlementsQueryBuilder;\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' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'details' | 'details.benefits.benefitKey' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId', value: any) => EntitlementsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'revision' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times', value: any) => EntitlementsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'revision' | '_createdDate' | '_updatedDate' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times', value: any) => EntitlementsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'revision' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times', value: any) => EntitlementsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'revision' | '_createdDate' | '_updatedDate' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times', value: any) => EntitlementsQueryBuilder;\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' | 'templateId' | 'templatePackageId' | 'packageId' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'details.benefits.benefitKey' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.creditConfiguration.amount' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId', value: string) => EntitlementsQueryBuilder;\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' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'details' | 'details.benefits.benefitKey' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId', value: any[]) => EntitlementsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'details' | 'details.benefits.benefitKey' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId', value: any) => EntitlementsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'details' | 'details.benefits.benefitKey' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId', value: boolean) => EntitlementsQueryBuilder;\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' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'beneficiary.identityType' | 'details' | 'details.benefits' | 'details.benefits.benefitKey' | 'details.benefits.items' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId'>) => EntitlementsQueryBuilder;\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' | 'revision' | '_createdDate' | '_updatedDate' | 'templateId' | 'templatePackageId' | 'packageId' | 'status' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'beneficiary.identityType' | 'details' | 'details.benefits' | 'details.benefits.benefitKey' | 'details.benefits.items' | 'details.benefits.items.id' | 'details.benefits.items.category' | 'details.benefits.items.name' | 'details.benefits.price' | 'details.benefits.policyExpression' | 'details.benefits.policyExpression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorNotOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorAndOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.operatorOrOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.policyOptions' | 'details.benefits.policyExpression.operatorNotOptions.expression.type' | 'details.benefits.policyExpression.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorAndOptions.expressions.type' | 'details.benefits.policyExpression.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorNotOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorAndOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.operatorOrOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.policyOptions' | 'details.benefits.policyExpression.operatorOrOptions.expressions.type' | 'details.benefits.policyExpression.policyOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toWeekDay' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toHour' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.fromMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.fixedIntervalOptions.toMinute' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.times' | 'details.benefits.policyExpression.policyOptions.rateLimitedOptions.type' | 'details.benefits.policyExpression.policyOptions.customOptions' | 'details.benefits.policyExpression.policyOptions.customOptions.id' | 'details.benefits.policyExpression.policyOptions.customOptions.appId' | 'details.benefits.policyExpression.policyOptions.customOptions.additionalData' | 'details.benefits.policyExpression.policyOptions.type' | 'details.benefits.policyExpression.type' | 'details.benefits.additionalData' | 'details.creditConfiguration' | 'details.creditConfiguration.amount' | 'details.creditConfiguration.rollOver' | 'details.policyExpression' | 'details.policyExpression.operatorNotOptions' | 'details.policyExpression.operatorAndOptions' | 'details.policyExpression.operatorOrOptions' | 'details.policyExpression.policyOptions' | 'details.policyExpression.type' | 'details.additionalData' | 'details.provider' | 'details.provider.appId' | 'details.provider.type' | 'name' | 'appId'>) => EntitlementsQueryBuilder;\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) => EntitlementsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => EntitlementsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Pauses the entitlements in the provided package. If the package contains service type entitlements, the services will be paused.\n *\n * This function is not a universal function and runs only on the backend.\n * @param packageId - Package of entitlements\n * @internal\n * @documentationMaturity preview\n * @requiredField packageId\n * @adminMethod\n */\n function pauseEntitlement(packageId: string): Promise;\n /**\n * Resumes the entitlements in the provided package. If the package contains service type entitlements, the services will be resumed.\n *\n * This function is not a universal function and runs only on the backend.\n * @param packageId - Package of entitlements\n * @internal\n * @documentationMaturity preview\n * @requiredField packageId\n * @adminMethod\n */\n function resumeEntitlement(packageId: string): Promise;\n /**\n * Ends the entitlements in the provided package. If the package contains service type entitlements, the services will be paused.\n *\n * This function is not a universal function and runs only on the backend.\n * @param packageId - Package of entitlements\n * @internal\n * @documentationMaturity preview\n * @requiredField packageId\n * @adminMethod\n */\n function endEntitlement(packageId: string): Promise;\n /**\n * Redeems the requested number of credits for one specific item\n *\n * This function is not a universal function and runs only on the backend.\n * @param entitlementId - Id of the entitlement that is being redeemed from\n * @internal\n * @documentationMaturity preview\n * @requiredField entitlementId\n * @requiredField options.idempotencyKey\n * @requiredField options.itemReference._id\n * @adminMethod\n */\n function redeemEntitlement(entitlementId: string, options?: RedeemEntitlementOptions): Promise;\n interface RedeemEntitlementOptions {\n /** Reference of the item that is being redeemed */\n itemReference?: ItemReference;\n /** If provided it will force the redemption to be done from the specific benefit instead of the first eligible one */\n benefitKey?: string | null;\n /** Number of of items to redeem */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by policy providers\n */\n targetDate?: Date;\n /** Idempotency key */\n idempotencyKey: string;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n /**\n * Performed as two-part redemption\n *\n * This function is not a universal function and runs only on the backend.\n * @param entitlementId - Id of the entitlement that is being redeemed from\n * @internal\n * @documentationMaturity preview\n * @requiredField entitlementId\n * @requiredField options.idempotencyKey\n * @requiredField options.itemReference._id\n * @adminMethod\n */\n function reserveEntitlement(entitlementId: string, options?: ReserveEntitlementOptions): Promise;\n interface ReserveEntitlementOptions {\n /** Reference of the item that is being redeemed */\n itemReference?: ItemReference;\n /** If provided it will force the redemption to be done from the specific benefit instead of the first eligible one */\n benefitKey?: string | null;\n /** Number of items to redeem */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by Policy providers\n */\n targetDate?: Date;\n /** Idempotency key */\n idempotencyKey: string;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n /**\n * Performed as two-part redemption\n *\n * This function is not a universal function and runs only on the backend.\n * @param transactionId - Id of the transaction that was created as a result of this request\n * @internal\n * @documentationMaturity preview\n * @requiredField transactionId\n * @adminMethod\n */\n function cancelEntitlementReservation(transactionId: string): Promise;\n /**\n * Performed as two-part redemption\n *\n * This function is not a universal function and runs only on the backend.\n * @param transactionId - Id of the transaction that was created as a result of this request\n * @internal\n * @documentationMaturity preview\n * @requiredField transactionId\n * @adminMethod\n */\n function releaseEntitlementReservation(transactionId: string): Promise;\n /**\n * Performed as part of redemption, but can be called on its own\n *\n * This function is not a universal function and runs only on the backend.\n * @param entitlementId - Id of the entitlement to check eligibility for\n * @internal\n * @documentationMaturity preview\n * @requiredField entitlementId\n * @requiredField options.itemReference._id\n * @adminMethod\n */\n function checkEntitlementEligibility(entitlementId: string, options?: CheckEntitlementEligibilityOptions): Promise;\n interface CheckEntitlementEligibilityOptions {\n /** Reference of the item for which to check entitlement's eligibility */\n itemReference?: ItemReference;\n /** If provided it will force the redemption to be done from the specific benefit instead of the first eligible one */\n benefitKey?: string | null;\n /** Number of items to check eligibility for. This number if checked against the policies and credit pool of the entitlements */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by entitlement providers\n */\n targetDate?: Date;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n /**\n * Performed as part of redemption, but can be called on its own\n *\n * This function is not a universal function and runs only on the backend.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.itemReference._id\n * @adminMethod\n */\n function getEligibleEntitlements(options?: GetEligibleEntitlementsOptions): Promise;\n interface GetEligibleEntitlementsOptions {\n /** Reference of the item for which all eligible entitlements will be returned */\n itemReference?: ItemReference;\n /** Number of items to check eligibility for. This number is checked against the policies and credit pool of the entitlements */\n count?: number;\n /**\n * Date at which the item will be used. Target date does not necessarily equal the redemption date. Credits are redeemed immediately.\n * This date is only used for validations that may be performed by entitlement providers\n */\n targetDate?: Date;\n /** Additional info */\n additionalData?: Record | null;\n /** Beneficiary of the entitlement. If not provided, will use the identity in the context */\n beneficiary?: IdentificationData$1;\n }\n \n type entitlementsV1Entitlement_universal_d_Entitlement = Entitlement;\n type entitlementsV1Entitlement_universal_d_EntitlementStatus = EntitlementStatus;\n const entitlementsV1Entitlement_universal_d_EntitlementStatus: typeof EntitlementStatus;\n type entitlementsV1Entitlement_universal_d_EntitlementDetails = EntitlementDetails;\n type entitlementsV1Entitlement_universal_d_Benefit = Benefit;\n type entitlementsV1Entitlement_universal_d_Item = Item;\n type entitlementsV1Entitlement_universal_d_PolicyExpression = PolicyExpression;\n type entitlementsV1Entitlement_universal_d_PolicyExpressionExpressionOneOf = PolicyExpressionExpressionOneOf;\n type entitlementsV1Entitlement_universal_d_PolicyExpressionType = PolicyExpressionType;\n const entitlementsV1Entitlement_universal_d_PolicyExpressionType: typeof PolicyExpressionType;\n type entitlementsV1Entitlement_universal_d_PolicyExpressionNot = PolicyExpressionNot;\n type entitlementsV1Entitlement_universal_d_PolicyExpressionAnd = PolicyExpressionAnd;\n type entitlementsV1Entitlement_universal_d_PolicyExpressionOr = PolicyExpressionOr;\n type entitlementsV1Entitlement_universal_d_Policy = Policy;\n type entitlementsV1Entitlement_universal_d_PolicyPolicyOneOf = PolicyPolicyOneOf;\n type entitlementsV1Entitlement_universal_d_Type = Type;\n const entitlementsV1Entitlement_universal_d_Type: typeof Type;\n type entitlementsV1Entitlement_universal_d_FixedIntervalPolicy = FixedIntervalPolicy;\n type entitlementsV1Entitlement_universal_d_WeekDay = WeekDay;\n const entitlementsV1Entitlement_universal_d_WeekDay: typeof WeekDay;\n type entitlementsV1Entitlement_universal_d_RateLimitedPolicy = RateLimitedPolicy;\n type entitlementsV1Entitlement_universal_d_RateLimitedPolicyPeriodOneOf = RateLimitedPolicyPeriodOneOf;\n type entitlementsV1Entitlement_universal_d_RateLimitedPolicyType = RateLimitedPolicyType;\n const entitlementsV1Entitlement_universal_d_RateLimitedPolicyType: typeof RateLimitedPolicyType;\n type entitlementsV1Entitlement_universal_d_CustomPolicy = CustomPolicy;\n type entitlementsV1Entitlement_universal_d_CreditConfiguration = CreditConfiguration;\n type entitlementsV1Entitlement_universal_d_Provider = Provider;\n type entitlementsV1Entitlement_universal_d_CreateEntitlementRequest = CreateEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_CreateEntitlementResponse = CreateEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_GetEntitlementRequest = GetEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_GetEntitlementResponse = GetEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_UpdateEntitlementRequest = UpdateEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_UpdateEntitlementResponse = UpdateEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_DeleteEntitlementRequest = DeleteEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_DeleteEntitlementResponse = DeleteEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_ProvisionEntitlementsRequest = ProvisionEntitlementsRequest;\n type entitlementsV1Entitlement_universal_d_EntitlementTemplateReference = EntitlementTemplateReference;\n type entitlementsV1Entitlement_universal_d_EntitlementTemplateReferenceIdOneOf = EntitlementTemplateReferenceIdOneOf;\n type entitlementsV1Entitlement_universal_d_ProvisionEntitlementsResponse = ProvisionEntitlementsResponse;\n type entitlementsV1Entitlement_universal_d_PackageAlreadyExists = PackageAlreadyExists;\n type entitlementsV1Entitlement_universal_d_GrantEntitlementRequest = GrantEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_GrantEntitlementResponse = GrantEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementGranted = EntitlementGranted;\n type entitlementsV1Entitlement_universal_d_QueryEntitlementsRequest = QueryEntitlementsRequest;\n type entitlementsV1Entitlement_universal_d_QueryEntitlementsResponse = QueryEntitlementsResponse;\n type entitlementsV1Entitlement_universal_d_PauseEntitlementRequest = PauseEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_PauseEntitlementResponse = PauseEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementPaused = EntitlementPaused;\n type entitlementsV1Entitlement_universal_d_ResumeEntitlementRequest = ResumeEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_ResumeEntitlementResponse = ResumeEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementResumed = EntitlementResumed;\n type entitlementsV1Entitlement_universal_d_EndEntitlementRequest = EndEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_EndEntitlementResponse = EndEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementEnded = EntitlementEnded;\n type entitlementsV1Entitlement_universal_d_RedeemEntitlementRequest = RedeemEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_ItemReference = ItemReference;\n type entitlementsV1Entitlement_universal_d_RedeemEntitlementResponse = RedeemEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementRedeemed = EntitlementRedeemed;\n type entitlementsV1Entitlement_universal_d_RedemptionDetails = RedemptionDetails;\n type entitlementsV1Entitlement_universal_d_NotEnoughBalance = NotEnoughBalance;\n type entitlementsV1Entitlement_universal_d_PolicyExpressionEvaluatedToFalse = PolicyExpressionEvaluatedToFalse;\n type entitlementsV1Entitlement_universal_d_EntitlementNotActive = EntitlementNotActive;\n type entitlementsV1Entitlement_universal_d_EntitlementAlreadyRedeemed = EntitlementAlreadyRedeemed;\n type entitlementsV1Entitlement_universal_d_ReserveEntitlementRequest = ReserveEntitlementRequest;\n type entitlementsV1Entitlement_universal_d_ReserveEntitlementResponse = ReserveEntitlementResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementReserved = EntitlementReserved;\n type entitlementsV1Entitlement_universal_d_CancelEntitlementReservationRequest = CancelEntitlementReservationRequest;\n type entitlementsV1Entitlement_universal_d_CancelEntitlementReservationResponse = CancelEntitlementReservationResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementReservationCanceled = EntitlementReservationCanceled;\n type entitlementsV1Entitlement_universal_d_ReleaseEntitlementReservationRequest = ReleaseEntitlementReservationRequest;\n type entitlementsV1Entitlement_universal_d_ReleaseEntitlementReservationResponse = ReleaseEntitlementReservationResponse;\n type entitlementsV1Entitlement_universal_d_EntitlementReservationReleased = EntitlementReservationReleased;\n type entitlementsV1Entitlement_universal_d_CheckEntitlementEligibilityRequest = CheckEntitlementEligibilityRequest;\n type entitlementsV1Entitlement_universal_d_CheckEntitlementEligibilityResponse = CheckEntitlementEligibilityResponse;\n type entitlementsV1Entitlement_universal_d_EligibilityCheckResult = EligibilityCheckResult;\n const entitlementsV1Entitlement_universal_d_EligibilityCheckResult: typeof EligibilityCheckResult;\n type entitlementsV1Entitlement_universal_d_GetEligibleEntitlementsRequest = GetEligibleEntitlementsRequest;\n type entitlementsV1Entitlement_universal_d_GetEligibleEntitlementsResponse = GetEligibleEntitlementsResponse;\n type entitlementsV1Entitlement_universal_d_EligibleBenefit = EligibleBenefit;\n const entitlementsV1Entitlement_universal_d_createEntitlement: typeof createEntitlement;\n const entitlementsV1Entitlement_universal_d_getEntitlement: typeof getEntitlement;\n const entitlementsV1Entitlement_universal_d_updateEntitlement: typeof updateEntitlement;\n type entitlementsV1Entitlement_universal_d_UpdateEntitlement = UpdateEntitlement;\n type entitlementsV1Entitlement_universal_d_UpdateEntitlementOptions = UpdateEntitlementOptions;\n const entitlementsV1Entitlement_universal_d_deleteEntitlement: typeof deleteEntitlement;\n type entitlementsV1Entitlement_universal_d_DeleteEntitlementOptions = DeleteEntitlementOptions;\n const entitlementsV1Entitlement_universal_d_provisionEntitlements: typeof provisionEntitlements;\n type entitlementsV1Entitlement_universal_d_ProvisionEntitlementsOptions = ProvisionEntitlementsOptions;\n const entitlementsV1Entitlement_universal_d_grantEntitlement: typeof grantEntitlement;\n const entitlementsV1Entitlement_universal_d_queryEntitlements: typeof queryEntitlements;\n type entitlementsV1Entitlement_universal_d_EntitlementsQueryResult = EntitlementsQueryResult;\n type entitlementsV1Entitlement_universal_d_EntitlementsQueryBuilder = EntitlementsQueryBuilder;\n const entitlementsV1Entitlement_universal_d_pauseEntitlement: typeof pauseEntitlement;\n const entitlementsV1Entitlement_universal_d_resumeEntitlement: typeof resumeEntitlement;\n const entitlementsV1Entitlement_universal_d_endEntitlement: typeof endEntitlement;\n const entitlementsV1Entitlement_universal_d_redeemEntitlement: typeof redeemEntitlement;\n type entitlementsV1Entitlement_universal_d_RedeemEntitlementOptions = RedeemEntitlementOptions;\n const entitlementsV1Entitlement_universal_d_reserveEntitlement: typeof reserveEntitlement;\n type entitlementsV1Entitlement_universal_d_ReserveEntitlementOptions = ReserveEntitlementOptions;\n const entitlementsV1Entitlement_universal_d_cancelEntitlementReservation: typeof cancelEntitlementReservation;\n const entitlementsV1Entitlement_universal_d_releaseEntitlementReservation: typeof releaseEntitlementReservation;\n const entitlementsV1Entitlement_universal_d_checkEntitlementEligibility: typeof checkEntitlementEligibility;\n type entitlementsV1Entitlement_universal_d_CheckEntitlementEligibilityOptions = CheckEntitlementEligibilityOptions;\n const entitlementsV1Entitlement_universal_d_getEligibleEntitlements: typeof getEligibleEntitlements;\n type entitlementsV1Entitlement_universal_d_GetEligibleEntitlementsOptions = GetEligibleEntitlementsOptions;\n namespace entitlementsV1Entitlement_universal_d {\n export {\n __debug$1 as __debug,\n entitlementsV1Entitlement_universal_d_Entitlement as Entitlement,\n entitlementsV1Entitlement_universal_d_EntitlementStatus as EntitlementStatus,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n IdentityType$1 as IdentityType,\n entitlementsV1Entitlement_universal_d_EntitlementDetails as EntitlementDetails,\n entitlementsV1Entitlement_universal_d_Benefit as Benefit,\n entitlementsV1Entitlement_universal_d_Item as Item,\n entitlementsV1Entitlement_universal_d_PolicyExpression as PolicyExpression,\n entitlementsV1Entitlement_universal_d_PolicyExpressionExpressionOneOf as PolicyExpressionExpressionOneOf,\n entitlementsV1Entitlement_universal_d_PolicyExpressionType as PolicyExpressionType,\n entitlementsV1Entitlement_universal_d_PolicyExpressionNot as PolicyExpressionNot,\n entitlementsV1Entitlement_universal_d_PolicyExpressionAnd as PolicyExpressionAnd,\n entitlementsV1Entitlement_universal_d_PolicyExpressionOr as PolicyExpressionOr,\n entitlementsV1Entitlement_universal_d_Policy as Policy,\n entitlementsV1Entitlement_universal_d_PolicyPolicyOneOf as PolicyPolicyOneOf,\n entitlementsV1Entitlement_universal_d_Type as Type,\n entitlementsV1Entitlement_universal_d_FixedIntervalPolicy as FixedIntervalPolicy,\n entitlementsV1Entitlement_universal_d_WeekDay as WeekDay,\n entitlementsV1Entitlement_universal_d_RateLimitedPolicy as RateLimitedPolicy,\n entitlementsV1Entitlement_universal_d_RateLimitedPolicyPeriodOneOf as RateLimitedPolicyPeriodOneOf,\n entitlementsV1Entitlement_universal_d_RateLimitedPolicyType as RateLimitedPolicyType,\n entitlementsV1Entitlement_universal_d_CustomPolicy as CustomPolicy,\n entitlementsV1Entitlement_universal_d_CreditConfiguration as CreditConfiguration,\n entitlementsV1Entitlement_universal_d_Provider as Provider,\n entitlementsV1Entitlement_universal_d_CreateEntitlementRequest as CreateEntitlementRequest,\n entitlementsV1Entitlement_universal_d_CreateEntitlementResponse as CreateEntitlementResponse,\n entitlementsV1Entitlement_universal_d_GetEntitlementRequest as GetEntitlementRequest,\n entitlementsV1Entitlement_universal_d_GetEntitlementResponse as GetEntitlementResponse,\n entitlementsV1Entitlement_universal_d_UpdateEntitlementRequest as UpdateEntitlementRequest,\n entitlementsV1Entitlement_universal_d_UpdateEntitlementResponse as UpdateEntitlementResponse,\n entitlementsV1Entitlement_universal_d_DeleteEntitlementRequest as DeleteEntitlementRequest,\n entitlementsV1Entitlement_universal_d_DeleteEntitlementResponse as DeleteEntitlementResponse,\n entitlementsV1Entitlement_universal_d_ProvisionEntitlementsRequest as ProvisionEntitlementsRequest,\n entitlementsV1Entitlement_universal_d_EntitlementTemplateReference as EntitlementTemplateReference,\n entitlementsV1Entitlement_universal_d_EntitlementTemplateReferenceIdOneOf as EntitlementTemplateReferenceIdOneOf,\n entitlementsV1Entitlement_universal_d_ProvisionEntitlementsResponse as ProvisionEntitlementsResponse,\n entitlementsV1Entitlement_universal_d_PackageAlreadyExists as PackageAlreadyExists,\n entitlementsV1Entitlement_universal_d_GrantEntitlementRequest as GrantEntitlementRequest,\n entitlementsV1Entitlement_universal_d_GrantEntitlementResponse as GrantEntitlementResponse,\n entitlementsV1Entitlement_universal_d_EntitlementGranted as EntitlementGranted,\n entitlementsV1Entitlement_universal_d_QueryEntitlementsRequest as QueryEntitlementsRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n CursorPaging$1 as CursorPaging,\n entitlementsV1Entitlement_universal_d_QueryEntitlementsResponse as QueryEntitlementsResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$1 as Cursors,\n entitlementsV1Entitlement_universal_d_PauseEntitlementRequest as PauseEntitlementRequest,\n entitlementsV1Entitlement_universal_d_PauseEntitlementResponse as PauseEntitlementResponse,\n entitlementsV1Entitlement_universal_d_EntitlementPaused as EntitlementPaused,\n entitlementsV1Entitlement_universal_d_ResumeEntitlementRequest as ResumeEntitlementRequest,\n entitlementsV1Entitlement_universal_d_ResumeEntitlementResponse as ResumeEntitlementResponse,\n entitlementsV1Entitlement_universal_d_EntitlementResumed as EntitlementResumed,\n entitlementsV1Entitlement_universal_d_EndEntitlementRequest as EndEntitlementRequest,\n entitlementsV1Entitlement_universal_d_EndEntitlementResponse as EndEntitlementResponse,\n entitlementsV1Entitlement_universal_d_EntitlementEnded as EntitlementEnded,\n entitlementsV1Entitlement_universal_d_RedeemEntitlementRequest as RedeemEntitlementRequest,\n entitlementsV1Entitlement_universal_d_ItemReference as ItemReference,\n entitlementsV1Entitlement_universal_d_RedeemEntitlementResponse as RedeemEntitlementResponse,\n entitlementsV1Entitlement_universal_d_EntitlementRedeemed as EntitlementRedeemed,\n entitlementsV1Entitlement_universal_d_RedemptionDetails as RedemptionDetails,\n entitlementsV1Entitlement_universal_d_NotEnoughBalance as NotEnoughBalance,\n entitlementsV1Entitlement_universal_d_PolicyExpressionEvaluatedToFalse as PolicyExpressionEvaluatedToFalse,\n entitlementsV1Entitlement_universal_d_EntitlementNotActive as EntitlementNotActive,\n entitlementsV1Entitlement_universal_d_EntitlementAlreadyRedeemed as EntitlementAlreadyRedeemed,\n entitlementsV1Entitlement_universal_d_ReserveEntitlementRequest as ReserveEntitlementRequest,\n entitlementsV1Entitlement_universal_d_ReserveEntitlementResponse as ReserveEntitlementResponse,\n entitlementsV1Entitlement_universal_d_EntitlementReserved as EntitlementReserved,\n entitlementsV1Entitlement_universal_d_CancelEntitlementReservationRequest as CancelEntitlementReservationRequest,\n entitlementsV1Entitlement_universal_d_CancelEntitlementReservationResponse as CancelEntitlementReservationResponse,\n entitlementsV1Entitlement_universal_d_EntitlementReservationCanceled as EntitlementReservationCanceled,\n entitlementsV1Entitlement_universal_d_ReleaseEntitlementReservationRequest as ReleaseEntitlementReservationRequest,\n entitlementsV1Entitlement_universal_d_ReleaseEntitlementReservationResponse as ReleaseEntitlementReservationResponse,\n entitlementsV1Entitlement_universal_d_EntitlementReservationReleased as EntitlementReservationReleased,\n entitlementsV1Entitlement_universal_d_CheckEntitlementEligibilityRequest as CheckEntitlementEligibilityRequest,\n entitlementsV1Entitlement_universal_d_CheckEntitlementEligibilityResponse as CheckEntitlementEligibilityResponse,\n entitlementsV1Entitlement_universal_d_EligibilityCheckResult as EligibilityCheckResult,\n entitlementsV1Entitlement_universal_d_GetEligibleEntitlementsRequest as GetEligibleEntitlementsRequest,\n entitlementsV1Entitlement_universal_d_GetEligibleEntitlementsResponse as GetEligibleEntitlementsResponse,\n entitlementsV1Entitlement_universal_d_EligibleBenefit as EligibleBenefit,\n entitlementsV1Entitlement_universal_d_createEntitlement as createEntitlement,\n entitlementsV1Entitlement_universal_d_getEntitlement as getEntitlement,\n entitlementsV1Entitlement_universal_d_updateEntitlement as updateEntitlement,\n entitlementsV1Entitlement_universal_d_UpdateEntitlement as UpdateEntitlement,\n entitlementsV1Entitlement_universal_d_UpdateEntitlementOptions as UpdateEntitlementOptions,\n entitlementsV1Entitlement_universal_d_deleteEntitlement as deleteEntitlement,\n entitlementsV1Entitlement_universal_d_DeleteEntitlementOptions as DeleteEntitlementOptions,\n entitlementsV1Entitlement_universal_d_provisionEntitlements as provisionEntitlements,\n entitlementsV1Entitlement_universal_d_ProvisionEntitlementsOptions as ProvisionEntitlementsOptions,\n entitlementsV1Entitlement_universal_d_grantEntitlement as grantEntitlement,\n entitlementsV1Entitlement_universal_d_queryEntitlements as queryEntitlements,\n entitlementsV1Entitlement_universal_d_EntitlementsQueryResult as EntitlementsQueryResult,\n entitlementsV1Entitlement_universal_d_EntitlementsQueryBuilder as EntitlementsQueryBuilder,\n entitlementsV1Entitlement_universal_d_pauseEntitlement as pauseEntitlement,\n entitlementsV1Entitlement_universal_d_resumeEntitlement as resumeEntitlement,\n entitlementsV1Entitlement_universal_d_endEntitlement as endEntitlement,\n entitlementsV1Entitlement_universal_d_redeemEntitlement as redeemEntitlement,\n entitlementsV1Entitlement_universal_d_RedeemEntitlementOptions as RedeemEntitlementOptions,\n entitlementsV1Entitlement_universal_d_reserveEntitlement as reserveEntitlement,\n entitlementsV1Entitlement_universal_d_ReserveEntitlementOptions as ReserveEntitlementOptions,\n entitlementsV1Entitlement_universal_d_cancelEntitlementReservation as cancelEntitlementReservation,\n entitlementsV1Entitlement_universal_d_releaseEntitlementReservation as releaseEntitlementReservation,\n entitlementsV1Entitlement_universal_d_checkEntitlementEligibility as checkEntitlementEligibility,\n entitlementsV1Entitlement_universal_d_CheckEntitlementEligibilityOptions as CheckEntitlementEligibilityOptions,\n entitlementsV1Entitlement_universal_d_getEligibleEntitlements as getEligibleEntitlements,\n entitlementsV1Entitlement_universal_d_GetEligibleEntitlementsOptions as GetEligibleEntitlementsOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Transaction {\n /** @readonly */\n _id?: string | null;\n /**\n * Represents the time the transaction was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * The entitlement from which the balance was changed\n * @readonly\n */\n poolId?: string;\n /**\n * The item for which the balance was changed, used only for records\n * @readonly\n */\n itemId?: string | null;\n /**\n * Amount to adjust the balance with. Can be negative.\n * @readonly\n */\n amount?: string;\n /**\n * The type defines different functionalities. Use DEBIT_AVAILABLE for normal balance debiting.\n * @readonly\n */\n type?: TransactionType;\n /**\n * Generated idempotency key from the client when making a change to the balance.\n * @readonly\n */\n idempotencyKey?: string;\n /**\n * Free format string\n * @readonly\n */\n reason?: string | null;\n /**\n * The identity that benefited from this transaction\n * @readonly\n */\n beneficiary?: IdentificationData;\n /**\n * Related transaction id. For example - for a reservation cancellation transaction, the related transaction is the redemption itself.\n * @readonly\n */\n relatedTransactionId?: string | null;\n /**\n * The identity that created this transaction\n * @readonly\n */\n instructingParty?: IdentificationData;\n /**\n * status of the transaction\n * @readonly\n */\n status?: TransactionStatus;\n }\n enum TransactionType {\n UNDEFINED = \"UNDEFINED\",\n /** Debits the AVAILABLE balance */\n DEBIT_AVAILABLE = \"DEBIT_AVAILABLE\",\n /** Moves the balance from AVAILABLE to RESERVED */\n RESERVE = \"RESERVE\",\n /** Debits the RESERVED balance */\n RELEASE_RESERVATION = \"RELEASE_RESERVATION\",\n /** Moves the balance back from RESERVED to AVAILABLE */\n CANCEL_RESERVATION = \"CANCEL_RESERVATION\",\n /** Credits the AVAILABLE balance */\n CREDIT_AVAILABLE = \"CREDIT_AVAILABLE\",\n /** Transaction type used for reporting free item usage */\n NO_CHANGE = \"NO_CHANGE\"\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 /** 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 * @internal\n * @readonly\n */\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 enum IdentityType {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n enum TransactionStatus {\n UNDEFINED = \"UNDEFINED\",\n /** Transaction is pending. This is the initial status of the transaction. Once the balance is updated, the transaction will become COMPLETED. If the balance update fails, the transaction will become FAILED. */\n PENDING = \"PENDING\",\n /** Transaction is completed */\n COMPLETED = \"COMPLETED\",\n /** Transaction is failed */\n FAILED = \"FAILED\"\n }\n interface GetTransactionRequest {\n /** Id of the transaction to retrieve */\n transactionId: string;\n }\n interface GetTransactionResponse {\n /** The retrieved transaction */\n transaction?: Transaction;\n }\n interface GetTransactionReversibilityRequest {\n /** Id of the transaction to get the reversibility */\n transactionId: string;\n }\n interface GetTransactionReversibilityResponse {\n /** The result of transaction reversibility validation */\n transactionReversibility?: TransactionReversibility;\n }\n /** Transaction reversibility results */\n enum TransactionReversibility {\n /** Transaction is allowed to be reverted */\n TRANSACTION_IS_REVERSIBLE = \"TRANSACTION_IS_REVERSIBLE\",\n /** Transaction isn't allowed to be reverted, because it was already reverted */\n TRANSACTION_ALREADY_REVERSED = \"TRANSACTION_ALREADY_REVERSED\",\n /** Transaction isn't allowed to be reverted, because the type transaction type doesn't allow this action */\n TRANSACTION_IS_NOT_REVERSIBLE = \"TRANSACTION_IS_NOT_REVERSIBLE\"\n }\n interface QueryTransactionsRequest {\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;\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 QueryTransactionsResponse {\n /** The retrieved transactions */\n transactions?: Transaction[];\n /** Paging information */\n metadata?: 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 /**\n * Get a transaction by id\n *\n * This function is not a universal function and runs only on the backend.\n * @param transactionId - Id of the transaction to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField transactionId\n * @adminMethod\n * @returns The retrieved transaction\n */\n function getTransaction(transactionId: string): Promise;\n /**\n * Get a transaction reversibility by transaction id\n *\n * Should be always internal this is only used to support EcomMembershipSPI\n *\n * This function is not a universal function and runs only on the backend.\n * @param transactionId - Id of the transaction to get the reversibility\n * @internal\n * @documentationMaturity preview\n * @requiredField transactionId\n * @adminMethod\n */\n function getTransactionReversibility(transactionId: string): Promise;\n /**\n * Query transactions using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n *\n * This function is not a universal function and runs only on the backend.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryTransactions(): TransactionsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TransactionsQueryResult extends QueryCursorResult {\n items: Transaction[];\n query: TransactionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface TransactionsQueryBuilder {\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' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'status', value: any) => TransactionsQueryBuilder;\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' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'status', value: any) => TransactionsQueryBuilder;\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) => TransactionsQueryBuilder;\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) => TransactionsQueryBuilder;\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' | 'poolId' | 'itemId' | 'amount' | 'idempotencyKey' | 'reason' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'relatedTransactionId' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId', value: string) => TransactionsQueryBuilder;\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' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'status', value: any[]) => TransactionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | '_createdDate' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'status', value: any) => TransactionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | '_createdDate' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'status', value: boolean) => TransactionsQueryBuilder;\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' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'beneficiary.identityType' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'instructingParty.identityType' | 'status'>) => TransactionsQueryBuilder;\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' | 'poolId' | 'itemId' | 'amount' | 'type' | 'idempotencyKey' | 'reason' | 'beneficiary' | 'beneficiary.anonymousVisitorId' | 'beneficiary.memberId' | 'beneficiary.wixUserId' | 'beneficiary.appId' | 'beneficiary.contactId' | 'beneficiary.identityType' | 'relatedTransactionId' | 'instructingParty' | 'instructingParty.anonymousVisitorId' | 'instructingParty.memberId' | 'instructingParty.wixUserId' | 'instructingParty.appId' | 'instructingParty.contactId' | 'instructingParty.identityType' | 'status'>) => TransactionsQueryBuilder;\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) => TransactionsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => TransactionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n const entitlementsV1Transaction_universal_d___debug: typeof __debug;\n type entitlementsV1Transaction_universal_d_Transaction = Transaction;\n type entitlementsV1Transaction_universal_d_TransactionType = TransactionType;\n const entitlementsV1Transaction_universal_d_TransactionType: typeof TransactionType;\n type entitlementsV1Transaction_universal_d_IdentificationData = IdentificationData;\n type entitlementsV1Transaction_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type entitlementsV1Transaction_universal_d_IdentityType = IdentityType;\n const entitlementsV1Transaction_universal_d_IdentityType: typeof IdentityType;\n type entitlementsV1Transaction_universal_d_TransactionStatus = TransactionStatus;\n const entitlementsV1Transaction_universal_d_TransactionStatus: typeof TransactionStatus;\n type entitlementsV1Transaction_universal_d_GetTransactionRequest = GetTransactionRequest;\n type entitlementsV1Transaction_universal_d_GetTransactionResponse = GetTransactionResponse;\n type entitlementsV1Transaction_universal_d_GetTransactionReversibilityRequest = GetTransactionReversibilityRequest;\n type entitlementsV1Transaction_universal_d_GetTransactionReversibilityResponse = GetTransactionReversibilityResponse;\n type entitlementsV1Transaction_universal_d_TransactionReversibility = TransactionReversibility;\n const entitlementsV1Transaction_universal_d_TransactionReversibility: typeof TransactionReversibility;\n type entitlementsV1Transaction_universal_d_QueryTransactionsRequest = QueryTransactionsRequest;\n type entitlementsV1Transaction_universal_d_CursorQuery = CursorQuery;\n type entitlementsV1Transaction_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type entitlementsV1Transaction_universal_d_Sorting = Sorting;\n type entitlementsV1Transaction_universal_d_SortOrder = SortOrder;\n const entitlementsV1Transaction_universal_d_SortOrder: typeof SortOrder;\n type entitlementsV1Transaction_universal_d_CursorPaging = CursorPaging;\n type entitlementsV1Transaction_universal_d_QueryTransactionsResponse = QueryTransactionsResponse;\n type entitlementsV1Transaction_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type entitlementsV1Transaction_universal_d_Cursors = Cursors;\n const entitlementsV1Transaction_universal_d_getTransaction: typeof getTransaction;\n const entitlementsV1Transaction_universal_d_getTransactionReversibility: typeof getTransactionReversibility;\n const entitlementsV1Transaction_universal_d_queryTransactions: typeof queryTransactions;\n type entitlementsV1Transaction_universal_d_TransactionsQueryResult = TransactionsQueryResult;\n type entitlementsV1Transaction_universal_d_TransactionsQueryBuilder = TransactionsQueryBuilder;\n namespace entitlementsV1Transaction_universal_d {\n export {\n entitlementsV1Transaction_universal_d___debug as __debug,\n entitlementsV1Transaction_universal_d_Transaction as Transaction,\n entitlementsV1Transaction_universal_d_TransactionType as TransactionType,\n entitlementsV1Transaction_universal_d_IdentificationData as IdentificationData,\n entitlementsV1Transaction_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n entitlementsV1Transaction_universal_d_IdentityType as IdentityType,\n entitlementsV1Transaction_universal_d_TransactionStatus as TransactionStatus,\n entitlementsV1Transaction_universal_d_GetTransactionRequest as GetTransactionRequest,\n entitlementsV1Transaction_universal_d_GetTransactionResponse as GetTransactionResponse,\n entitlementsV1Transaction_universal_d_GetTransactionReversibilityRequest as GetTransactionReversibilityRequest,\n entitlementsV1Transaction_universal_d_GetTransactionReversibilityResponse as GetTransactionReversibilityResponse,\n entitlementsV1Transaction_universal_d_TransactionReversibility as TransactionReversibility,\n entitlementsV1Transaction_universal_d_QueryTransactionsRequest as QueryTransactionsRequest,\n entitlementsV1Transaction_universal_d_CursorQuery as CursorQuery,\n entitlementsV1Transaction_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n entitlementsV1Transaction_universal_d_Sorting as Sorting,\n entitlementsV1Transaction_universal_d_SortOrder as SortOrder,\n entitlementsV1Transaction_universal_d_CursorPaging as CursorPaging,\n entitlementsV1Transaction_universal_d_QueryTransactionsResponse as QueryTransactionsResponse,\n entitlementsV1Transaction_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n entitlementsV1Transaction_universal_d_Cursors as Cursors,\n entitlementsV1Transaction_universal_d_getTransaction as getTransaction,\n entitlementsV1Transaction_universal_d_getTransactionReversibility as getTransactionReversibility,\n entitlementsV1Transaction_universal_d_queryTransactions as queryTransactions,\n entitlementsV1Transaction_universal_d_TransactionsQueryResult as TransactionsQueryResult,\n entitlementsV1Transaction_universal_d_TransactionsQueryBuilder as TransactionsQueryBuilder,\n };\n }\n \n export { entitlementsV1Balance_universal_d as balance, entitlementsV1Entitlement_universal_d as entitlements, entitlementsV1Transaction_universal_d as transaction };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-events-backend.v1.d.ts", "content": "declare module \"wix-events-backend.v1\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Order {\n /** Unique order number. */\n orderNumber?: string;\n /** Reservation ID. */\n reservationId?: string;\n /**\n * Payment snapshot ID.\n * Empty for FREE order.\n * @readonly\n */\n snapshotId?: string;\n /** Event ID. */\n eventId?: string;\n /** Contact ID of buyer (resolved using email address). */\n contactId?: string;\n /** Member ID of buyer (if relevant). */\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;\n /** Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account). */\n confirmed?: boolean;\n /** Order status. */\n status?: OrderStatus;\n /** Payment method used for purchase, e.g., \"payPal\", \"creditCard\", etc. */\n method?: string;\n /** Tickets ordered. */\n ticketsQuantity?: number;\n /** Total order price. */\n totalPrice?: Money;\n /** URL to ticket PDF. */\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;\n /** Whether all tickets in order are checked-in. */\n fullyCheckedIn?: boolean;\n /**\n * Deprecated. Use `payment_details.transaction.transaction_id`.\n * @internal\n * @readonly\n */\n transactionId?: string;\n /** Internal order payment details */\n paymentDetails?: PaymentDetails;\n /** Checkout channel type */\n channel?: ChannelType;\n /**\n * Language in which Order was created.\n * @internal\n * @readonly\n */\n language?: string | null;\n }\n interface FormResponse {\n /** Input values entered upon ticket order. */\n inputValues?: InputValue[];\n }\n interface InputValue {\n /** Unique input name. */\n inputName?: string;\n /** Text value representation. */\n value?: string;\n /** Text value vector. */\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress;\n }\n interface FormattedAddress {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address;\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 * Apartment number.\n * @internal\n */\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 /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 enum OrderStatus {\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 {\n /** Decimal amount representation. 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 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;\n /**\n * Whether ticket requires payment.\n * @readonly\n */\n free?: boolean;\n /** Ticket policy (as displayed in PDF). */\n policy?: string;\n /** Deprecated, use `check_in_url`. */\n qrCode?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn;\n /** Associated order status. */\n orderStatus?: OrderStatus;\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;\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 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 .pkpass format for Apple Wallet\n * @readonly\n */\n walletPassUrl?: string;\n /**\n * Additional ticket details.\n * @internal\n * @readonly\n */\n ticketDetails?: TicketDetails;\n }\n interface CheckIn {\n /** Time of check-in */\n created?: Date;\n }\n interface GuestDetails {\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;\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 {\n /** Unique seat id in the event venue. */\n seatId?: string | null;\n /**\n * Optional sector name.\n * @internal\n * @readonly\n */\n sectorName?: string | null;\n /**\n * Area name.\n * @internal\n * @readonly\n */\n areaName?: string | null;\n /**\n * Table name.\n * @internal\n * @readonly\n */\n tableName?: string | null;\n /**\n * Row label.\n * @internal\n * @readonly\n */\n rowNumber?: string | null;\n /**\n * Seat label in a row or table.\n * @internal\n * @readonly\n */\n seatNumber?: 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 * @internal\n * @readonly\n */\n pricingOptionName?: string | null;\n }\n interface Invoice {\n items?: Item[];\n /** Total cart amount. */\n total?: Money;\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;\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;\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;\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 mame. */\n name?: string;\n /** Line item price. */\n price?: Money;\n /** Total price for line items. Always equal to price * quantity. */\n total?: Money;\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 Discount {\n /** Total discount amount. */\n amount?: Money;\n /** Total charge after applied discount. */\n afterDiscount?: Money;\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[];\n }\n interface DiscountItem extends DiscountItemDiscountOneOf {\n /** Total discount amount. */\n amount?: Money;\n /** Coupon discount. */\n coupon?: CouponDiscount;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount;\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 /** Name of pricing plan. */\n name?: string;\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount;\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;\n /**\n * Tax name.\n * @readonly\n */\n name?: string;\n /** Tax rate. */\n rate?: string;\n /** Taxable amount. */\n taxable?: Money;\n /** Total tax amount. */\n amount?: Money;\n }\n enum TaxType {\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;\n /**\n * Fee rate.\n * @readonly\n */\n rate?: string;\n /** Total amount of fee charges. */\n amount?: Money;\n }\n enum FeeName {\n /** Wix service fee charges applied to the line item. */\n WIX_FEE = \"WIX_FEE\"\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 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 {\n /** Order deleted timestamp in ISO UTC format. */\n timestamp?: Date;\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 /** 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 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;\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 /** Anonymized tickets no longer contain personally identifiable information (PII). */\n anonymized?: boolean;\n }\n interface ListOrdersRequest {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset). */\n fieldset?: OrderFieldset[];\n /** Status. */\n status?: OrderStatus[];\n /**\n * Deprecated: use tag = CONFIRMED\n * @internal\n */\n confirmed?: boolean | null;\n /** Event ID. */\n eventId?: string[];\n /** Order number. */\n orderNumber?: string[];\n /** Site member ID. */\n memberId?: string[];\n /**\n * Deprecated: use tag = MEMBER\n * @internal\n */\n membersOnly?: boolean;\n /**\n * Field 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-orders).\n */\n facet?: string[];\n /**\n * Deprecated: use tag = ARCHIVED / NON_ARCHIVED\n * @internal\n */\n archived?: boolean | null;\n /** Textual search filter - search is performed on \"full_name\", \"email\" and \"order_number\". */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Deprecated: use tag = FULLY_CHECKED_IN / NOT_FULLY_CHECKED_IN\n * @internal\n */\n fullyCheckedIn?: boolean | 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_list-orders).\n */\n sort?: string;\n /** Order tag. */\n tag?: OrderTag[];\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 /** Meta data of search results. */\n searchMetaData?: SearchMetaData;\n /** Order data enriched facets. */\n orderFacets?: OrderFacets;\n }\n interface FacetCounts {\n /** Facet counts aggregated per value */\n counts?: Record;\n }\n interface SearchMetaData {\n /** Search results */\n results?: Result[];\n }\n interface Result {\n /** Entity ID */\n _id?: string;\n /**\n * Entity score.\n * Higher is more relevant to search phrase.\n */\n score?: string;\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. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset). */\n fieldset?: OrderFieldset[];\n }\n interface GetOrderResponse {\n /** Requested order. */\n order?: Order;\n /** \"Add to calendar\" links. */\n calendarLinks?: CalendarLinks;\n }\n interface CalendarLinks {\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. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /** Set of field paths to update. */\n fields: string[];\n /** Checkout form. */\n checkoutForm?: FormResponse;\n /** Whether order is archived. */\n archived?: boolean;\n }\n interface UpdateOrderResponse {\n /** Updated order. */\n order?: Order;\n }\n interface OrderUpdated {\n /** Order updated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: 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;\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 BulkUpdateOrdersRequest {\n /** Event ID. */\n eventId: string;\n orderNumber?: string[];\n /** Set of fields to update. */\n fields?: 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. */\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;\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;\n }\n interface GetInvoicePreviewRequest {\n /** Event ID. */\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;\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;\n }\n interface OrderConfirmed {\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 /** 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;\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 OrderPaid {\n /** Order paid timestamp in ISO UTC. */\n timestamp?: Date;\n /** Event ID. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface ReservationCreated {\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;\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 ReservationUpdated {\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;\n /** Reservation expiration timestamp. */\n expires?: Date;\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, 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-available-tickets).\n */\n sort?: string;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date;\n state?: State[];\n }\n enum State {\n INCLUDE_HIDDEN_NOT_ON_SALE = \"INCLUDE_HIDDEN_NOT_ON_SALE\"\n }\n interface ListAvailableTicketsResponse {\n /** Ticket definitions meta data. */\n metaData?: ResponseMetaData;\n /** Ticket definitions. */\n definitions?: TicketDefinition[];\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 TicketDefinition {\n /** Ticket definition ID. */\n _id?: string;\n /** Ticket price. */\n price?: Money;\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;\n /** Event ID associated with the ticket. */\n eventId?: string;\n /**\n * Whether the fixed-rate service fee 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?: State[];\n /**\n * Ticket pricing.\n * @internal\n */\n pricing?: TicketPricing;\n }\n interface Dashboard {\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 definition). */\n quantity?: number | null;\n /** Number of unsold tickets (NULL for unlimited ticket definition). */\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 /** Fee calculation method. */\n type?: FeeType;\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 interface TicketPricing extends TicketPricingPriceOneOf {\n /**\n * Ticket pricing type.\n * @internal\n * @readonly\n */\n pricingType?: Type;\n /** Ticket price which is read only. */\n fixedPrice?: Money;\n /** Min price per ticket, customizable. */\n minPrice?: Money;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions;\n }\n /** @oneof */\n interface TicketPricingPriceOneOf {\n /** Ticket price which is read only. */\n fixedPrice?: Money;\n /** Min price per ticket, customizable. */\n minPrice?: Money;\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;\n }\n enum Type {\n STANDARD = \"STANDARD\",\n DONATION = \"DONATION\"\n }\n interface QueryAvailableTicketsRequest {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /**\n * Ticket definition.\n * 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-available-tickets).\n */\n filter?: Record | null;\n fieldset?: TicketDefinitionFieldset[];\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-available-tickets).\n */\n sort?: 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 QueryAvailableTicketsResponse {\n /** Ticket definitions meta data. */\n metaData?: ResponseMetaData;\n /** Ticket definitions. */\n definitions?: TicketDefinition[];\n }\n interface CreateReservationRequest {\n /** Event ID. */\n eventId: string;\n /** Tickets to reserve. */\n ticketQuantities?: TicketReservationQuantity[];\n /** Whether to ignore the available ticket limits upon reservation. */\n ignoreLimits?: boolean;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date;\n /** Whether to allow reservation for hidden tickets. */\n allowHiddenTickets?: boolean;\n /**\n * Whether to exclude Wix fee.\n * @internal\n */\n excludeFee?: boolean;\n }\n interface TicketReservationQuantity {\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Quantity of tickets to reserve. */\n quantity?: number;\n /** Ticket price to charge - overriding the ticket price. */\n priceOverride?: string | null;\n /**\n * Optional ticket details\n * @internal\n */\n ticketDetails?: TicketDetails[];\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;\n }\n interface TicketReservation {\n /** Quantity of reserved tickets. */\n quantity?: number;\n ticket?: TicketDefinition;\n /**\n * Optional ticket details.\n * @internal\n */\n ticketDetails?: TicketDetails[];\n }\n interface CancelReservationRequest {\n /** Event ID. */\n eventId: string;\n /** Reservation ID. */\n _id: string;\n }\n interface CancelReservationResponse {\n }\n interface GetInvoiceRequest {\n /** Event ID. */\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;\n /** Discount errors, if relevant. */\n discountErrors?: DiscountErrors;\n /** Time when the reservation expires. */\n expires?: Date;\n /** Reservation status. */\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 /** Error. */\n error?: Error[];\n }\n interface Error {\n code?: string;\n }\n interface CheckoutRequest {\n /** Event ID. */\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 /**\n * Deprecated.\n * @internal\n */\n silent?: boolean;\n /**\n * Deprecated.\n * @internal\n */\n payInPerson?: boolean;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest[];\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n /** Options controlling the checkout process. */\n options?: CheckoutOptions;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date;\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 {\n /** Specific guest info. */\n form?: FormResponse;\n }\n interface CheckoutResponse {\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 interface OrderInitiated {\n /** Order initiated timestamp in ISO UTC format. */\n timestamp?: Date;\n /** Site language when Order initiated */\n language?: 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 /** 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;\n /** Order status. */\n status?: OrderStatus;\n /** Invoice. */\n invoice?: Invoice;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface UpdateCheckoutRequest {\n /** Event ID. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest[];\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 }\n interface PosCheckoutRequest {\n /** Event ID. */\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, with basic filter support.\n * @public */\n function listOrders(options?: ListOrdersOptions): Promise;\n interface ListOrdersOptions {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset). */\n fieldset?: OrderFieldset[];\n /** Status. */\n status?: OrderStatus[];\n /**\n * Deprecated: use tag = CONFIRMED\n * @internal\n */\n confirmed?: boolean | null;\n /** Event ID. */\n eventId?: string[];\n /** Order number. */\n orderNumber?: string[];\n /** Site member ID. */\n memberId?: string[];\n /**\n * Deprecated: use tag = MEMBER\n * @internal\n */\n membersOnly?: boolean;\n /**\n * Field 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-orders).\n */\n facet?: string[];\n /**\n * Deprecated: use tag = ARCHIVED / NON_ARCHIVED\n * @internal\n */\n archived?: boolean | null;\n /** Textual search filter - search is performed on \"full_name\", \"email\" and \"order_number\". */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Deprecated: use tag = FULLY_CHECKED_IN / NOT_FULLY_CHECKED_IN\n * @internal\n */\n fullyCheckedIn?: boolean | 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_list-orders).\n */\n sort?: string;\n /** Order tag. */\n tag?: OrderTag[];\n }\n /**\n * Retrieves an order, including ticket data.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n */\n function getOrder(identifiers: GetOrderIdentifiers, options?: GetOrderOptions): Promise;\n interface GetOrderIdentifiers {\n /** Event ID. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n }\n interface GetOrderOptions {\n /** Controls which data is returned. See [Fieldset](https://dev.wix.com/api/rest/wix-events/wix-events/fieldset#wix-events_wix-events_fieldset_order-fieldset). */\n fieldset?: OrderFieldset[];\n }\n /**\n * Updates an order's `checkoutForm` and/or `archived` status.\n * @param fields - Set of field paths to update.\n * @public\n * @requiredField fields\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n */\n function updateOrder(identifiers: UpdateOrderIdentifiers, fields: string[], options?: UpdateOrderOptions): Promise;\n interface UpdateOrderIdentifiers {\n /** Event ID. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n }\n interface UpdateOrderOptions {\n /** Checkout form. */\n checkoutForm?: FormResponse;\n /** Whether order is archived. */\n archived?: boolean;\n }\n /**\n * Updates multiple orders' `archived` status.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n */\n function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise;\n interface BulkUpdateOrdersOptions {\n orderNumber?: string[];\n /** Set of fields to update. */\n fields?: string[];\n /** Whether to archive the order. */\n archived?: boolean;\n }\n /**\n * Changes order status to \"CONFIRMED\" - from \"INITIATED, \"PENDING\", \"OFFLINE_PENDING\" to \"PAID\".\n * Previously confirmed orders (with status \"PAID\" or \"FREE\") are not changed.\n * Confirming previously \"INITIATED\" or \"PENDING\" orders triggers an email with the tickets to the buyer (and to additional guests, if relevant and provided).\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\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 * @public */\n function getSummary(options?: GetSummaryOptions): Promise;\n interface GetSummaryOptions {\n /** Event ID. */\n eventId?: string | null;\n }\n /**\n * Returns invoice preview. Works only for PAID orders.\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n */\n function getInvoicePreview(identifiers: GetInvoicePreviewIdentifiers): Promise;\n interface GetInvoicePreviewIdentifiers {\n /** Event ID. */\n eventId: string;\n /** Order number. */\n orderNumber: string;\n }\n /**\n * Returns checkout meta data used in checkout UX.\n * @public */\n function getCheckoutOptions(): Promise;\n /**\n * Returns tickets available to reserve.\n * @public */\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, 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-available-tickets).\n */\n sort?: string;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date;\n state?: State[];\n }\n /**\n * Returns tickets available to reserve.\n * @public */\n function queryAvailableTickets(options?: QueryAvailableTicketsOptions): Promise;\n interface QueryAvailableTicketsOptions {\n /** Offset. */\n offset?: number;\n /** Limit. */\n limit?: number;\n /**\n * Ticket definition.\n * 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-available-tickets).\n */\n filter?: Record | null;\n fieldset?: TicketDefinitionFieldset[];\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-available-tickets).\n */\n sort?: string;\n }\n /**\n * Reserves tickets for 20 minutes.\n * Reserved tickets are deducted from tickets stock and cannot be bought by another party.\n * When the reservation expires, the tickets are added back in the stock.\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\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 /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date;\n /** Whether to allow reservation for hidden tickets. */\n allowHiddenTickets?: boolean;\n /**\n * Whether to exclude Wix fee.\n * @internal\n */\n excludeFee?: boolean;\n }\n /**\n * Cancels ticket reservation and returns tickets to stock.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.id\n */\n function cancelReservation(identifiers: CancelReservationIdentifiers): Promise;\n interface CancelReservationIdentifiers {\n /** Event ID. */\n eventId: string;\n /** Reservation ID. */\n _id: string;\n }\n /**\n * Generates a preview of a reservation invoice, including the given coupon or pricing plan.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.reservationId\n */\n function getInvoice(identifiers: GetInvoiceIdentifiers, options?: GetInvoiceOptions): Promise;\n interface GetInvoiceIdentifiers {\n /** Event ID. */\n eventId: string;\n /** Reservation ID. */\n reservationId: string;\n }\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 * Checkout reserved tickets.\n * Creates order and associates it with a site contact.\n * Guest details must be sent according to Registration Form input fields.\n * (To change an existing \"INITIATED, \"PENDING\", or \"OFFLINE_PENDING\" order, call the [Update Checkout](https://dev.wix.com/api/rest/wix-events/wix-events/checkout/update-checkout) endpoint).\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @requiredField options.guests.form\n */\n function checkout(eventId: string, options?: CheckoutOptions): Promise;\n interface CheckoutOptions {\n /** Whether to ignore settings to notify contacts or users. */\n /**\n * Deprecated.\n * @internal\n */\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 /**\n * Deprecated.\n * @internal\n */\n payInPerson?: boolean;\n /** Whether to ignore form validation. */\n ignoreFormValidation?: boolean;\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[];\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n /** Options controlling the checkout process. */\n options?: CheckoutOptions;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date;\n }\n interface CheckoutOptions {\n /** Ticket reservation ID. */\n reservationId?: string;\n }\n /**\n * Updates order and tickets (supported only for unconfirmed orders).\n * Guest details must be sent according to Registration Form input fields.\n * @public\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n */\n function updateCheckout(identifiers: UpdateCheckoutIdentifiers, options?: UpdateCheckoutOptions): Promise;\n interface UpdateCheckoutIdentifiers {\n /** Event ID. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n }\n interface UpdateCheckoutOptions {\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest[];\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 /**\n * Creates order with payment details already initiated via Cashier Pay API.\n * @param eventId - Event ID.\n * @param reservationId - Ticket reservation ID.\n * @requiredField eventId\n * @requiredField reservationId\n */\n function posCheckout(eventId: string, reservationId: string, options?: PosCheckoutOptions): Promise;\n interface PosCheckoutOptions {\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 \n const eventsV1Order_universal_d___debug: typeof __debug;\n type eventsV1Order_universal_d_Order = Order;\n type eventsV1Order_universal_d_FormResponse = FormResponse;\n type eventsV1Order_universal_d_InputValue = InputValue;\n type eventsV1Order_universal_d_FormattedAddress = FormattedAddress;\n type eventsV1Order_universal_d_Address = Address;\n type eventsV1Order_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type eventsV1Order_universal_d_StreetAddress = StreetAddress;\n type eventsV1Order_universal_d_AddressLocation = AddressLocation;\n type eventsV1Order_universal_d_Subdivision = Subdivision;\n type eventsV1Order_universal_d_SubdivisionType = SubdivisionType;\n const eventsV1Order_universal_d_SubdivisionType: typeof SubdivisionType;\n type eventsV1Order_universal_d_OrderStatus = OrderStatus;\n const eventsV1Order_universal_d_OrderStatus: typeof OrderStatus;\n type eventsV1Order_universal_d_Money = Money;\n type eventsV1Order_universal_d_TicketingTicket = TicketingTicket;\n type eventsV1Order_universal_d_CheckIn = CheckIn;\n type eventsV1Order_universal_d_GuestDetails = GuestDetails;\n type eventsV1Order_universal_d_ChannelType = ChannelType;\n const eventsV1Order_universal_d_ChannelType: typeof ChannelType;\n type eventsV1Order_universal_d_TicketDetails = TicketDetails;\n type eventsV1Order_universal_d_Invoice = Invoice;\n type eventsV1Order_universal_d_Item = Item;\n type eventsV1Order_universal_d_Discount = Discount;\n type eventsV1Order_universal_d_DiscountItem = DiscountItem;\n type eventsV1Order_universal_d_DiscountItemDiscountOneOf = DiscountItemDiscountOneOf;\n type eventsV1Order_universal_d_CouponDiscount = CouponDiscount;\n type eventsV1Order_universal_d_PaidPlanDiscount = PaidPlanDiscount;\n type eventsV1Order_universal_d_PaidPlanDiscountDiscountOneOf = PaidPlanDiscountDiscountOneOf;\n type eventsV1Order_universal_d_PercentDiscount = PercentDiscount;\n type eventsV1Order_universal_d_Tax = Tax;\n type eventsV1Order_universal_d_TaxType = TaxType;\n const eventsV1Order_universal_d_TaxType: typeof TaxType;\n type eventsV1Order_universal_d_Fee = Fee;\n type eventsV1Order_universal_d_FeeName = FeeName;\n const eventsV1Order_universal_d_FeeName: typeof FeeName;\n type eventsV1Order_universal_d_FeeType = FeeType;\n const eventsV1Order_universal_d_FeeType: typeof FeeType;\n type eventsV1Order_universal_d_PaymentDetails = PaymentDetails;\n type eventsV1Order_universal_d_PaymentTransaction = PaymentTransaction;\n type eventsV1Order_universal_d_OrderDeleted = OrderDeleted;\n type eventsV1Order_universal_d_OrderType = OrderType;\n const eventsV1Order_universal_d_OrderType: typeof OrderType;\n type eventsV1Order_universal_d_Ticket = Ticket;\n type eventsV1Order_universal_d_ListOrdersRequest = ListOrdersRequest;\n type eventsV1Order_universal_d_OrderFieldset = OrderFieldset;\n const eventsV1Order_universal_d_OrderFieldset: typeof OrderFieldset;\n type eventsV1Order_universal_d_OrderTag = OrderTag;\n const eventsV1Order_universal_d_OrderTag: typeof OrderTag;\n type eventsV1Order_universal_d_ListOrdersResponse = ListOrdersResponse;\n type eventsV1Order_universal_d_FacetCounts = FacetCounts;\n type eventsV1Order_universal_d_SearchMetaData = SearchMetaData;\n type eventsV1Order_universal_d_Result = Result;\n type eventsV1Order_universal_d_OrderFacets = OrderFacets;\n type eventsV1Order_universal_d_OrderFacetCounts = OrderFacetCounts;\n type eventsV1Order_universal_d_Counts = Counts;\n type eventsV1Order_universal_d_GetOrderRequest = GetOrderRequest;\n type eventsV1Order_universal_d_GetOrderResponse = GetOrderResponse;\n type eventsV1Order_universal_d_CalendarLinks = CalendarLinks;\n type eventsV1Order_universal_d_UpdateOrderRequest = UpdateOrderRequest;\n type eventsV1Order_universal_d_UpdateOrderResponse = UpdateOrderResponse;\n type eventsV1Order_universal_d_OrderUpdated = OrderUpdated;\n type eventsV1Order_universal_d_BulkUpdateOrdersRequest = BulkUpdateOrdersRequest;\n type eventsV1Order_universal_d_BulkUpdateOrdersResponse = BulkUpdateOrdersResponse;\n type eventsV1Order_universal_d_ConfirmOrderRequest = ConfirmOrderRequest;\n type eventsV1Order_universal_d_ConfirmOrderResponse = ConfirmOrderResponse;\n type eventsV1Order_universal_d_GetSummaryRequest = GetSummaryRequest;\n type eventsV1Order_universal_d_GetSummaryResponse = GetSummaryResponse;\n type eventsV1Order_universal_d_TicketSales = TicketSales;\n type eventsV1Order_universal_d_GetInvoicePreviewRequest = GetInvoicePreviewRequest;\n type eventsV1Order_universal_d_RawHttpResponse = RawHttpResponse;\n type eventsV1Order_universal_d_HeadersEntry = HeadersEntry;\n type eventsV1Order_universal_d_GetPaymentInfoRequest = GetPaymentInfoRequest;\n type eventsV1Order_universal_d_GetPaymentInfoResponse = GetPaymentInfoResponse;\n type eventsV1Order_universal_d_PaymentTransactionSummary = PaymentTransactionSummary;\n type eventsV1Order_universal_d_PaymentTransactionEvent = PaymentTransactionEvent;\n type eventsV1Order_universal_d_OrderConfirmed = OrderConfirmed;\n type eventsV1Order_universal_d_OrderPaid = OrderPaid;\n type eventsV1Order_universal_d_ReservationCreated = ReservationCreated;\n type eventsV1Order_universal_d_ReservationStatus = ReservationStatus;\n const eventsV1Order_universal_d_ReservationStatus: typeof ReservationStatus;\n type eventsV1Order_universal_d_ReservationUpdated = ReservationUpdated;\n type eventsV1Order_universal_d_GetCheckoutOptionsRequest = GetCheckoutOptionsRequest;\n type eventsV1Order_universal_d_GetCheckoutOptionsResponse = GetCheckoutOptionsResponse;\n type eventsV1Order_universal_d_ListAvailableTicketsRequest = ListAvailableTicketsRequest;\n type eventsV1Order_universal_d_State = State;\n const eventsV1Order_universal_d_State: typeof State;\n type eventsV1Order_universal_d_ListAvailableTicketsResponse = ListAvailableTicketsResponse;\n type eventsV1Order_universal_d_ResponseMetaData = ResponseMetaData;\n type eventsV1Order_universal_d_TicketDefinition = TicketDefinition;\n type eventsV1Order_universal_d_Dashboard = Dashboard;\n type eventsV1Order_universal_d_WixFeeConfig = WixFeeConfig;\n type eventsV1Order_universal_d_TicketSalePeriod = TicketSalePeriod;\n type eventsV1Order_universal_d_TicketSaleStatus = TicketSaleStatus;\n const eventsV1Order_universal_d_TicketSaleStatus: typeof TicketSaleStatus;\n type eventsV1Order_universal_d_TicketPricing = TicketPricing;\n type eventsV1Order_universal_d_TicketPricingPriceOneOf = TicketPricingPriceOneOf;\n type eventsV1Order_universal_d_PricingOptions = PricingOptions;\n type eventsV1Order_universal_d_PricingOption = PricingOption;\n type eventsV1Order_universal_d_Type = Type;\n const eventsV1Order_universal_d_Type: typeof Type;\n type eventsV1Order_universal_d_QueryAvailableTicketsRequest = QueryAvailableTicketsRequest;\n type eventsV1Order_universal_d_TicketDefinitionFieldset = TicketDefinitionFieldset;\n const eventsV1Order_universal_d_TicketDefinitionFieldset: typeof TicketDefinitionFieldset;\n type eventsV1Order_universal_d_QueryAvailableTicketsResponse = QueryAvailableTicketsResponse;\n type eventsV1Order_universal_d_CreateReservationRequest = CreateReservationRequest;\n type eventsV1Order_universal_d_TicketReservationQuantity = TicketReservationQuantity;\n type eventsV1Order_universal_d_CreateReservationResponse = CreateReservationResponse;\n type eventsV1Order_universal_d_TicketReservation = TicketReservation;\n type eventsV1Order_universal_d_CancelReservationRequest = CancelReservationRequest;\n type eventsV1Order_universal_d_CancelReservationResponse = CancelReservationResponse;\n type eventsV1Order_universal_d_GetInvoiceRequest = GetInvoiceRequest;\n type eventsV1Order_universal_d_DiscountRequest = DiscountRequest;\n type eventsV1Order_universal_d_PaidPlanBenefit = PaidPlanBenefit;\n type eventsV1Order_universal_d_GetInvoiceResponse = GetInvoiceResponse;\n type eventsV1Order_universal_d_DiscountErrors = DiscountErrors;\n type eventsV1Order_universal_d_Error = Error;\n type eventsV1Order_universal_d_CheckoutRequest = CheckoutRequest;\n type eventsV1Order_universal_d_Buyer = Buyer;\n type eventsV1Order_universal_d_Guest = Guest;\n type eventsV1Order_universal_d_CheckoutOptions = CheckoutOptions;\n type eventsV1Order_universal_d_CheckoutResponse = CheckoutResponse;\n type eventsV1Order_universal_d_OrderInitiated = OrderInitiated;\n type eventsV1Order_universal_d_UpdateCheckoutRequest = UpdateCheckoutRequest;\n type eventsV1Order_universal_d_UpdateCheckoutResponse = UpdateCheckoutResponse;\n type eventsV1Order_universal_d_PosCheckoutRequest = PosCheckoutRequest;\n type eventsV1Order_universal_d_PosCheckoutResponse = PosCheckoutResponse;\n const eventsV1Order_universal_d_listOrders: typeof listOrders;\n type eventsV1Order_universal_d_ListOrdersOptions = ListOrdersOptions;\n const eventsV1Order_universal_d_getOrder: typeof getOrder;\n type eventsV1Order_universal_d_GetOrderIdentifiers = GetOrderIdentifiers;\n type eventsV1Order_universal_d_GetOrderOptions = GetOrderOptions;\n const eventsV1Order_universal_d_updateOrder: typeof updateOrder;\n type eventsV1Order_universal_d_UpdateOrderIdentifiers = UpdateOrderIdentifiers;\n type eventsV1Order_universal_d_UpdateOrderOptions = UpdateOrderOptions;\n const eventsV1Order_universal_d_bulkUpdateOrders: typeof bulkUpdateOrders;\n type eventsV1Order_universal_d_BulkUpdateOrdersOptions = BulkUpdateOrdersOptions;\n const eventsV1Order_universal_d_confirmOrder: typeof confirmOrder;\n type eventsV1Order_universal_d_ConfirmOrderOptions = ConfirmOrderOptions;\n const eventsV1Order_universal_d_getSummary: typeof getSummary;\n type eventsV1Order_universal_d_GetSummaryOptions = GetSummaryOptions;\n const eventsV1Order_universal_d_getInvoicePreview: typeof getInvoicePreview;\n type eventsV1Order_universal_d_GetInvoicePreviewIdentifiers = GetInvoicePreviewIdentifiers;\n const eventsV1Order_universal_d_getCheckoutOptions: typeof getCheckoutOptions;\n const eventsV1Order_universal_d_listAvailableTickets: typeof listAvailableTickets;\n type eventsV1Order_universal_d_ListAvailableTicketsOptions = ListAvailableTicketsOptions;\n const eventsV1Order_universal_d_queryAvailableTickets: typeof queryAvailableTickets;\n type eventsV1Order_universal_d_QueryAvailableTicketsOptions = QueryAvailableTicketsOptions;\n const eventsV1Order_universal_d_createReservation: typeof createReservation;\n type eventsV1Order_universal_d_CreateReservationOptions = CreateReservationOptions;\n const eventsV1Order_universal_d_cancelReservation: typeof cancelReservation;\n type eventsV1Order_universal_d_CancelReservationIdentifiers = CancelReservationIdentifiers;\n const eventsV1Order_universal_d_getInvoice: typeof getInvoice;\n type eventsV1Order_universal_d_GetInvoiceIdentifiers = GetInvoiceIdentifiers;\n type eventsV1Order_universal_d_GetInvoiceOptions = GetInvoiceOptions;\n const eventsV1Order_universal_d_checkout: typeof checkout;\n const eventsV1Order_universal_d_updateCheckout: typeof updateCheckout;\n type eventsV1Order_universal_d_UpdateCheckoutIdentifiers = UpdateCheckoutIdentifiers;\n type eventsV1Order_universal_d_UpdateCheckoutOptions = UpdateCheckoutOptions;\n const eventsV1Order_universal_d_posCheckout: typeof posCheckout;\n type eventsV1Order_universal_d_PosCheckoutOptions = PosCheckoutOptions;\n namespace eventsV1Order_universal_d {\n export {\n eventsV1Order_universal_d___debug as __debug,\n eventsV1Order_universal_d_Order as Order,\n eventsV1Order_universal_d_FormResponse as FormResponse,\n eventsV1Order_universal_d_InputValue as InputValue,\n eventsV1Order_universal_d_FormattedAddress as FormattedAddress,\n eventsV1Order_universal_d_Address as Address,\n eventsV1Order_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n eventsV1Order_universal_d_StreetAddress as StreetAddress,\n eventsV1Order_universal_d_AddressLocation as AddressLocation,\n eventsV1Order_universal_d_Subdivision as Subdivision,\n eventsV1Order_universal_d_SubdivisionType as SubdivisionType,\n eventsV1Order_universal_d_OrderStatus as OrderStatus,\n eventsV1Order_universal_d_Money as Money,\n eventsV1Order_universal_d_TicketingTicket as TicketingTicket,\n eventsV1Order_universal_d_CheckIn as CheckIn,\n eventsV1Order_universal_d_GuestDetails as GuestDetails,\n eventsV1Order_universal_d_ChannelType as ChannelType,\n eventsV1Order_universal_d_TicketDetails as TicketDetails,\n eventsV1Order_universal_d_Invoice as Invoice,\n eventsV1Order_universal_d_Item as Item,\n eventsV1Order_universal_d_Discount as Discount,\n eventsV1Order_universal_d_DiscountItem as DiscountItem,\n eventsV1Order_universal_d_DiscountItemDiscountOneOf as DiscountItemDiscountOneOf,\n eventsV1Order_universal_d_CouponDiscount as CouponDiscount,\n eventsV1Order_universal_d_PaidPlanDiscount as PaidPlanDiscount,\n eventsV1Order_universal_d_PaidPlanDiscountDiscountOneOf as PaidPlanDiscountDiscountOneOf,\n eventsV1Order_universal_d_PercentDiscount as PercentDiscount,\n eventsV1Order_universal_d_Tax as Tax,\n eventsV1Order_universal_d_TaxType as TaxType,\n eventsV1Order_universal_d_Fee as Fee,\n eventsV1Order_universal_d_FeeName as FeeName,\n eventsV1Order_universal_d_FeeType as FeeType,\n eventsV1Order_universal_d_PaymentDetails as PaymentDetails,\n eventsV1Order_universal_d_PaymentTransaction as PaymentTransaction,\n eventsV1Order_universal_d_OrderDeleted as OrderDeleted,\n eventsV1Order_universal_d_OrderType as OrderType,\n eventsV1Order_universal_d_Ticket as Ticket,\n eventsV1Order_universal_d_ListOrdersRequest as ListOrdersRequest,\n eventsV1Order_universal_d_OrderFieldset as OrderFieldset,\n eventsV1Order_universal_d_OrderTag as OrderTag,\n eventsV1Order_universal_d_ListOrdersResponse as ListOrdersResponse,\n eventsV1Order_universal_d_FacetCounts as FacetCounts,\n eventsV1Order_universal_d_SearchMetaData as SearchMetaData,\n eventsV1Order_universal_d_Result as Result,\n eventsV1Order_universal_d_OrderFacets as OrderFacets,\n eventsV1Order_universal_d_OrderFacetCounts as OrderFacetCounts,\n eventsV1Order_universal_d_Counts as Counts,\n eventsV1Order_universal_d_GetOrderRequest as GetOrderRequest,\n eventsV1Order_universal_d_GetOrderResponse as GetOrderResponse,\n eventsV1Order_universal_d_CalendarLinks as CalendarLinks,\n eventsV1Order_universal_d_UpdateOrderRequest as UpdateOrderRequest,\n eventsV1Order_universal_d_UpdateOrderResponse as UpdateOrderResponse,\n eventsV1Order_universal_d_OrderUpdated as OrderUpdated,\n eventsV1Order_universal_d_BulkUpdateOrdersRequest as BulkUpdateOrdersRequest,\n eventsV1Order_universal_d_BulkUpdateOrdersResponse as BulkUpdateOrdersResponse,\n eventsV1Order_universal_d_ConfirmOrderRequest as ConfirmOrderRequest,\n eventsV1Order_universal_d_ConfirmOrderResponse as ConfirmOrderResponse,\n eventsV1Order_universal_d_GetSummaryRequest as GetSummaryRequest,\n eventsV1Order_universal_d_GetSummaryResponse as GetSummaryResponse,\n eventsV1Order_universal_d_TicketSales as TicketSales,\n eventsV1Order_universal_d_GetInvoicePreviewRequest as GetInvoicePreviewRequest,\n eventsV1Order_universal_d_RawHttpResponse as RawHttpResponse,\n eventsV1Order_universal_d_HeadersEntry as HeadersEntry,\n eventsV1Order_universal_d_GetPaymentInfoRequest as GetPaymentInfoRequest,\n eventsV1Order_universal_d_GetPaymentInfoResponse as GetPaymentInfoResponse,\n eventsV1Order_universal_d_PaymentTransactionSummary as PaymentTransactionSummary,\n eventsV1Order_universal_d_PaymentTransactionEvent as PaymentTransactionEvent,\n eventsV1Order_universal_d_OrderConfirmed as OrderConfirmed,\n eventsV1Order_universal_d_OrderPaid as OrderPaid,\n eventsV1Order_universal_d_ReservationCreated as ReservationCreated,\n eventsV1Order_universal_d_ReservationStatus as ReservationStatus,\n eventsV1Order_universal_d_ReservationUpdated as ReservationUpdated,\n eventsV1Order_universal_d_GetCheckoutOptionsRequest as GetCheckoutOptionsRequest,\n eventsV1Order_universal_d_GetCheckoutOptionsResponse as GetCheckoutOptionsResponse,\n eventsV1Order_universal_d_ListAvailableTicketsRequest as ListAvailableTicketsRequest,\n eventsV1Order_universal_d_State as State,\n eventsV1Order_universal_d_ListAvailableTicketsResponse as ListAvailableTicketsResponse,\n eventsV1Order_universal_d_ResponseMetaData as ResponseMetaData,\n eventsV1Order_universal_d_TicketDefinition as TicketDefinition,\n eventsV1Order_universal_d_Dashboard as Dashboard,\n eventsV1Order_universal_d_WixFeeConfig as WixFeeConfig,\n eventsV1Order_universal_d_TicketSalePeriod as TicketSalePeriod,\n eventsV1Order_universal_d_TicketSaleStatus as TicketSaleStatus,\n eventsV1Order_universal_d_TicketPricing as TicketPricing,\n eventsV1Order_universal_d_TicketPricingPriceOneOf as TicketPricingPriceOneOf,\n eventsV1Order_universal_d_PricingOptions as PricingOptions,\n eventsV1Order_universal_d_PricingOption as PricingOption,\n eventsV1Order_universal_d_Type as Type,\n eventsV1Order_universal_d_QueryAvailableTicketsRequest as QueryAvailableTicketsRequest,\n eventsV1Order_universal_d_TicketDefinitionFieldset as TicketDefinitionFieldset,\n eventsV1Order_universal_d_QueryAvailableTicketsResponse as QueryAvailableTicketsResponse,\n eventsV1Order_universal_d_CreateReservationRequest as CreateReservationRequest,\n eventsV1Order_universal_d_TicketReservationQuantity as TicketReservationQuantity,\n eventsV1Order_universal_d_CreateReservationResponse as CreateReservationResponse,\n eventsV1Order_universal_d_TicketReservation as TicketReservation,\n eventsV1Order_universal_d_CancelReservationRequest as CancelReservationRequest,\n eventsV1Order_universal_d_CancelReservationResponse as CancelReservationResponse,\n eventsV1Order_universal_d_GetInvoiceRequest as GetInvoiceRequest,\n eventsV1Order_universal_d_DiscountRequest as DiscountRequest,\n eventsV1Order_universal_d_PaidPlanBenefit as PaidPlanBenefit,\n eventsV1Order_universal_d_GetInvoiceResponse as GetInvoiceResponse,\n eventsV1Order_universal_d_DiscountErrors as DiscountErrors,\n eventsV1Order_universal_d_Error as Error,\n eventsV1Order_universal_d_CheckoutRequest as CheckoutRequest,\n eventsV1Order_universal_d_Buyer as Buyer,\n eventsV1Order_universal_d_Guest as Guest,\n eventsV1Order_universal_d_CheckoutOptions as CheckoutOptions,\n eventsV1Order_universal_d_CheckoutResponse as CheckoutResponse,\n eventsV1Order_universal_d_OrderInitiated as OrderInitiated,\n eventsV1Order_universal_d_UpdateCheckoutRequest as UpdateCheckoutRequest,\n eventsV1Order_universal_d_UpdateCheckoutResponse as UpdateCheckoutResponse,\n eventsV1Order_universal_d_PosCheckoutRequest as PosCheckoutRequest,\n eventsV1Order_universal_d_PosCheckoutResponse as PosCheckoutResponse,\n eventsV1Order_universal_d_listOrders as listOrders,\n eventsV1Order_universal_d_ListOrdersOptions as ListOrdersOptions,\n eventsV1Order_universal_d_getOrder as getOrder,\n eventsV1Order_universal_d_GetOrderIdentifiers as GetOrderIdentifiers,\n eventsV1Order_universal_d_GetOrderOptions as GetOrderOptions,\n eventsV1Order_universal_d_updateOrder as updateOrder,\n eventsV1Order_universal_d_UpdateOrderIdentifiers as UpdateOrderIdentifiers,\n eventsV1Order_universal_d_UpdateOrderOptions as UpdateOrderOptions,\n eventsV1Order_universal_d_bulkUpdateOrders as bulkUpdateOrders,\n eventsV1Order_universal_d_BulkUpdateOrdersOptions as BulkUpdateOrdersOptions,\n eventsV1Order_universal_d_confirmOrder as confirmOrder,\n eventsV1Order_universal_d_ConfirmOrderOptions as ConfirmOrderOptions,\n eventsV1Order_universal_d_getSummary as getSummary,\n eventsV1Order_universal_d_GetSummaryOptions as GetSummaryOptions,\n eventsV1Order_universal_d_getInvoicePreview as getInvoicePreview,\n eventsV1Order_universal_d_GetInvoicePreviewIdentifiers as GetInvoicePreviewIdentifiers,\n eventsV1Order_universal_d_getCheckoutOptions as getCheckoutOptions,\n eventsV1Order_universal_d_listAvailableTickets as listAvailableTickets,\n eventsV1Order_universal_d_ListAvailableTicketsOptions as ListAvailableTicketsOptions,\n eventsV1Order_universal_d_queryAvailableTickets as queryAvailableTickets,\n eventsV1Order_universal_d_QueryAvailableTicketsOptions as QueryAvailableTicketsOptions,\n eventsV1Order_universal_d_createReservation as createReservation,\n eventsV1Order_universal_d_CreateReservationOptions as CreateReservationOptions,\n eventsV1Order_universal_d_cancelReservation as cancelReservation,\n eventsV1Order_universal_d_CancelReservationIdentifiers as CancelReservationIdentifiers,\n eventsV1Order_universal_d_getInvoice as getInvoice,\n eventsV1Order_universal_d_GetInvoiceIdentifiers as GetInvoiceIdentifiers,\n eventsV1Order_universal_d_GetInvoiceOptions as GetInvoiceOptions,\n eventsV1Order_universal_d_checkout as checkout,\n eventsV1Order_universal_d_updateCheckout as updateCheckout,\n eventsV1Order_universal_d_UpdateCheckoutIdentifiers as UpdateCheckoutIdentifiers,\n eventsV1Order_universal_d_UpdateCheckoutOptions as UpdateCheckoutOptions,\n eventsV1Order_universal_d_posCheckout as posCheckout,\n eventsV1Order_universal_d_PosCheckoutOptions as PosCheckoutOptions,\n };\n }\n \n export { eventsV1Order_universal_d as order };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-data-index-service-v2.d.ts", "content": "declare module \"wix-data-index-service-v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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?: Field[];\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?: Status;\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 Field {\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 Status {\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 /**\n * Broad error code.\n * - `WD_UNKNOWN_ERROR`: Unknown error.\n * @internal\n */\n broadCode?: 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 /**\n * DEPRECATED. Use data_collection_id\n * @internal\n */\n collectionName?: string;\n /**\n * Environment on which to define the index. Default value is LIVE.\n * @internal\n */\n environment?: Environment;\n /** Details of the index to be created. */\n index: Index;\n /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which to generate the index. */\n dataCollectionId?: string;\n }\n enum Environment {\n LIVE = \"LIVE\",\n SANDBOX = \"SANDBOX\"\n }\n interface CreateIndexResponse {\n /** Details of the index being generated. */\n index?: Index;\n }\n interface DropIndexRequest {\n /**\n * DEPRECATED. Use data_collection_id\n * @internal\n */\n collectionName?: string;\n /**\n * Environment on which the index is defined. Default value is LIVE.\n * @internal\n */\n environment?: Environment;\n /** Name of the index to drop. */\n indexName: string;\n /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which the index to be dropped is defined. */\n dataCollectionId?: string;\n }\n interface DropIndexResponse {\n }\n interface ListIndexesRequest {\n /**\n * DEPRECATED. Use data_collection_id\n * @internal\n */\n collectionName?: string;\n /**\n * Environment to list indexes for\n * @internal\n */\n environment?: Environment;\n /**\n * slower read but consistent with recent updates\n * @internal\n */\n consistentRead?: boolean;\n /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which to list indexes. */\n dataCollectionId?: string;\n }\n interface ListIndexesResponse {\n /** List of all indexes for the requested data collection. */\n indexes?: Index[];\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 your index is ready using the [List Indexes](https://dev.wix.com/api/rest/wix-data/wix-data/indexes/list-indexes) endpoint.\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, use the Drop Index endpoint.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.index\n * @requiredField options.index.fields\n * @requiredField options.index.fields.path\n * @requiredField options.index.name\n */\n function createIndex(options: CreateIndexOptions): Promise;\n interface CreateIndexOptions {\n /**\n * DEPRECATED. Use data_collection_id\n * @internal\n */\n collectionName?: string;\n /**\n * Environment on which to define the index. Default value is LIVE.\n * @internal\n */\n environment?: Environment;\n /** Details of the index to be created. */\n index: Index;\n /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which to generate the index. */\n dataCollectionId?: string;\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 your index has been dropped by using the [List Indexes](https://dev.wix.com/api/rest/wix-data/wix-data/indexes/list-indexes) endpoint.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.indexName\n */\n function dropIndex(options: DropIndexOptions): Promise;\n interface DropIndexOptions {\n /**\n * DEPRECATED. Use data_collection_id\n * @internal\n */\n collectionName?: string;\n /**\n * Environment on which the index is defined. Default value is LIVE.\n * @internal\n */\n environment?: Environment;\n /** Name of the index to drop. */\n indexName: string;\n /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which the index to be dropped is defined. */\n dataCollectionId?: string;\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 * @public\n * @documentationMaturity preview\n */\n function listIndexes(options?: ListIndexesOptions): Promise;\n interface ListIndexesOptions {\n /**\n * DEPRECATED. Use data_collection_id\n * @internal\n */\n collectionName?: string;\n /**\n * Environment to list indexes for\n * @internal\n */\n environment?: Environment;\n /**\n * slower read but consistent with recent updates\n * @internal\n */\n consistentRead?: boolean;\n /** ID of the [data collection](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections) for which to list indexes. */\n dataCollectionId?: string;\n }\n \n const dataV2Index_universal_d___debug: typeof __debug;\n type dataV2Index_universal_d_Index = Index;\n type dataV2Index_universal_d_Order = Order;\n const dataV2Index_universal_d_Order: typeof Order;\n type dataV2Index_universal_d_Field = Field;\n type dataV2Index_universal_d_Status = Status;\n const dataV2Index_universal_d_Status: typeof Status;\n type dataV2Index_universal_d_Failure = Failure;\n type dataV2Index_universal_d_CreateIndexRequest = CreateIndexRequest;\n type dataV2Index_universal_d_Environment = Environment;\n const dataV2Index_universal_d_Environment: typeof Environment;\n type dataV2Index_universal_d_CreateIndexResponse = CreateIndexResponse;\n type dataV2Index_universal_d_DropIndexRequest = DropIndexRequest;\n type dataV2Index_universal_d_DropIndexResponse = DropIndexResponse;\n type dataV2Index_universal_d_ListIndexesRequest = ListIndexesRequest;\n type dataV2Index_universal_d_ListIndexesResponse = ListIndexesResponse;\n const dataV2Index_universal_d_createIndex: typeof createIndex;\n type dataV2Index_universal_d_CreateIndexOptions = CreateIndexOptions;\n const dataV2Index_universal_d_dropIndex: typeof dropIndex;\n type dataV2Index_universal_d_DropIndexOptions = DropIndexOptions;\n const dataV2Index_universal_d_listIndexes: typeof listIndexes;\n type dataV2Index_universal_d_ListIndexesOptions = ListIndexesOptions;\n namespace dataV2Index_universal_d {\n export {\n dataV2Index_universal_d___debug as __debug,\n dataV2Index_universal_d_Index as Index,\n dataV2Index_universal_d_Order as Order,\n dataV2Index_universal_d_Field as Field,\n dataV2Index_universal_d_Status as Status,\n dataV2Index_universal_d_Failure as Failure,\n dataV2Index_universal_d_CreateIndexRequest as CreateIndexRequest,\n dataV2Index_universal_d_Environment as Environment,\n dataV2Index_universal_d_CreateIndexResponse as CreateIndexResponse,\n dataV2Index_universal_d_DropIndexRequest as DropIndexRequest,\n dataV2Index_universal_d_DropIndexResponse as DropIndexResponse,\n dataV2Index_universal_d_ListIndexesRequest as ListIndexesRequest,\n dataV2Index_universal_d_ListIndexesResponse as ListIndexesResponse,\n dataV2Index_universal_d_createIndex as createIndex,\n dataV2Index_universal_d_CreateIndexOptions as CreateIndexOptions,\n dataV2Index_universal_d_dropIndex as dropIndex,\n dataV2Index_universal_d_DropIndexOptions as DropIndexOptions,\n dataV2Index_universal_d_listIndexes as listIndexes,\n dataV2Index_universal_d_ListIndexesOptions as ListIndexesOptions,\n };\n }\n \n export { dataV2Index_universal_d as data };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-category-backend.d.ts", "content": "declare module \"wix-category-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Category {\n /** Category ID. */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Category was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Category name. */\n name?: string | null;\n /**\n * Category image.\n * Pass existing media ID for image previously saved in Wix media manager.\n * Pass full image URL to upload an image to Wix media manager.\n * In case of full url the image will be updated eventually.\n */\n image?: string;\n /**\n * Number of items in this category alone.\n * @readonly\n */\n numberOfItems?: number;\n /**\n * Number of items including all items in subcategories.\n * @readonly\n */\n totalNumberOfItems?: number;\n /** Category description. */\n description?: string | null;\n /**\n * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).\n * Even if visible is `false`, it can still be added manually to static page.\n * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.\n * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.\n */\n visible?: boolean | null;\n /**\n * A category's breadcrumbs.\n * Updated on moved to different parent or on renamed.\n * @readonly\n */\n breadcrumbs?: BreadcrumbItem[];\n /** The parent category. */\n parentCategory?: ParentCategory;\n /**\n * A permanent, friendly URL name.\n * When not provided, generated automatically.\n * When provided, validated and should be unique.\n */\n slug?: string | null;\n /**\n * Custom SEO data for the category.\n * @internal\n */\n seoData?: SeoSchema;\n /**\n * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.\n * In order to use this field you have to integrate with \"Ricos\" on frontend side. To learn how to do it visit https://ricos.js.org/.\n */\n richContentDescription?: RichContent;\n }\n interface BreadcrumbItem {\n /** Represents the id of the breadcrumb item. */\n _id?: string;\n /** Represents the name of the breadcrumb item. */\n name?: string;\n /** Represents the slug of the breadcrumb item. */\n slug?: string;\n }\n interface ParentCategory {\n /**\n * Represents the id of the parent category.\n * If not passed, the default is the root category.\n */\n _id?: string | null;\n /**\n * Represents the index of current category within the parent category.\n * @readonly\n */\n index?: number | 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?: Tag[];\n /** SEO general settings. */\n settings?: Settings;\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 redirects feature creating `301 redirects` on a slug change is enabled.\n *\n *\n * Default: enabled\n */\n preventAutoRedirect?: boolean;\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 CreateCategoryRequest {\n /** Category to be created. */\n category: Category;\n }\n interface CreateCategoryResponse {\n /** The created Category. */\n category?: Category;\n }\n interface GetCategoryRequest {\n /** Id of the Category to retrieve. */\n categoryId: string;\n }\n interface GetCategoryResponse {\n /** The retrieved Category. */\n category?: Category;\n }\n interface UpdateCategoryRequest {\n /** Category to be updated, may be partial. */\n category: Category;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateCategoryResponse {\n /** The updated Category. */\n category?: Category;\n }\n interface DeleteCategoryRequest {\n /** Id of the Category to delete. */\n categoryId: string;\n }\n interface DeleteCategoryResponse {\n }\n interface QueryCategoriesRequest {\n /** WQL query expression. */\n query: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\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 /** 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 /** 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 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 /** 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 /** Categories which satisfy the provided query. */\n categories?: Category[];\n /** Paging metadata. Contains cursor which can be used in next query. */\n metadata?: 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 * 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 * @internal\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 PlaceCategoryInParentCategoryRequest {\n /** ID of category to place. */\n categoryId: string;\n /**\n * ID of parent category.\n * Optional. When not passed it will fallback to the root category\n */\n parentCategoryId?: string | null;\n /**\n * Where to place the subcategory.\n * `FIRST` - make category with `category_id` first subcategory with manual arrangement.\n * `LAST` - make category with `category_id` last subcategory with manual arrangement.\n * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.\n */\n position?: PlaceCategoryInParentCategoryRequestPosition;\n /** Required when `position` is `BEFORE`. */\n moveBeforeCategoryId?: string | null;\n }\n enum PlaceCategoryInParentCategoryRequestPosition {\n UNKNOWN = \"UNKNOWN\",\n FIRST = \"FIRST\",\n LAST = \"LAST\",\n BEFORE = \"BEFORE\"\n }\n interface PlaceCategoryInParentCategoryResponse {\n /** ID of parent category. */\n parentCategoryId?: string | null;\n /** Information about manually arranged categories after move. */\n arrangedCategoriesAfterMove?: string[];\n }\n interface BulkCreateCategoriesRequest {\n /** List of categories to be created. */\n categories: Category[];\n /** Whether to return the full category entity in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkCreateCategoriesResponse {\n /** Categories created by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCategoriesResult {\n /** Information about successful action or error for failure. */\n itemMetadata?: ItemMetadata;\n /** Created category. Optional - returned only if requested with `return_full_entity` set to `true`. */\n category?: Category;\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 code?: string;\n description?: string;\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 BulkSetVisibilityRequest {\n /** IDs of categories to be updated. */\n categoryIds: string[];\n /** Whether to return the full category entity in the response. */\n returnFullEntity?: boolean;\n }\n interface BulkSetVisibilityResponse {\n /** Categories updated by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkSetVisibilityByFilterRequest {\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 interface BulkSetVisibilityByFilterResponse {\n /** Token that can be used to query \"AsyncJobService\" */\n jobId?: string;\n }\n interface BulkDeleteCategoriesRequest {\n /** IDs of categories to be deleted. */\n categoryIds: string[];\n }\n interface BulkDeleteCategoriesResponse {\n /** Categories deleted by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkDeleteCategoriesByFilterRequest {\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 interface BulkDeleteCategoriesByFilterResponse {\n /** Token that can be used to query \"AsyncJobService\" */\n jobId?: string;\n }\n interface AddItemsToCategoryRequest {\n /** Category id. */\n categoryId: string;\n /** List of catalog items with reference info. */\n items?: ItemReference[];\n }\n interface ItemReference {\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 }\n interface AddItemsToCategoryResponse {\n /** Items added by bulk action. */\n results?: BulkItemsToCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkItemsToCategoryResult {\n /** Information about items that were added successfully and errors for failed items. */\n itemMetadata?: ItemReferenceMetadata;\n }\n interface ItemReferenceMetadata {\n /** Item reference from request. */\n itemReference?: ItemReference;\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 ItemAddedToCategory {\n /** Category ID. */\n categoryId?: string;\n /** Catalog item reference info. */\n itemReference?: ItemReference;\n }\n interface AddItemToCategoriesRequest {\n /** Catalog item reference info */\n itemReference: ItemReference;\n /** Category ids. */\n categoryIds?: string[];\n }\n interface AddItemToCategoriesResponse {\n /** Items added by bulk action. */\n results?: BulkItemToCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkItemToCategoriesResult {\n /** Information about categories to which item was added successfully and errors for failed items. `id` is ID of category. */\n itemMetadata?: ItemMetadata;\n }\n interface RemoveItemsFromCategoryRequest {\n /** Category id */\n categoryId: string;\n /** List of catalog items with reference info. */\n items?: ItemReference[];\n }\n interface RemoveItemsFromCategoryResponse {\n /** Items removed by bulk action. */\n results?: BulkItemsToCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ItemRemovedFromCategory {\n /** Category ID. */\n categoryId?: string;\n /** Catalog item reference info. */\n itemReference?: ItemReference;\n }\n interface RemoveItemFromCategoriesRequest {\n /** Catalog item reference info */\n itemReference: ItemReference;\n /** Category ids. */\n categoryIds?: string[];\n }\n interface RemoveItemFromCategoriesResponse {\n /** Items removed by bulk action. */\n results?: BulkItemToCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ListItemsInCategoryRequest {\n /** ID of category containing items. */\n categoryId: string;\n /** Default: `false`. When `true` items arranged by user will be return before all other items. */\n useCategoryArrangement?: boolean;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */\n paging?: CursorPaging;\n }\n interface ListItemsInCategoryResponse {\n /** Items which satisfy query. */\n items?: ItemReference[];\n /** Paging metadata. Contains cursor which can be used in next query */\n metadata?: PagingMetadataV2;\n }\n interface MoveItemInCategoryRequest {\n /**\n * ID of category.\n * Item must be direct child of this category, otherwise error returned\n */\n categoryId: string;\n /** Item to move. */\n item: ItemReference;\n /**\n * Where to move item.\n * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.\n * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.\n * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.\n * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.\n */\n position?: Position;\n /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */\n beforeItem?: ItemReference;\n }\n enum Position {\n UNKNOWN_POSITION = \"UNKNOWN_POSITION\",\n FIRST = \"FIRST\",\n LAST = \"LAST\",\n BEFORE = \"BEFORE\",\n NONE = \"NONE\"\n }\n interface MoveItemInCategoryResponse {\n /** Information about manually arranged items after move. */\n arrangedItemsAfterMove?: ItemReference[];\n }\n interface PutCategoriesTreeRequest {\n /** The number of categories to put */\n numberOfCategories: number | null;\n }\n interface PutCategoriesTreeResponse {\n }\n interface GetCategoriesTreeRequest {\n }\n interface GetCategoriesTreeResponse {\n /** Categories tree in dynamo */\n categoryTreeNodeDynamo?: CategoryTreeNode;\n /** Categories tree in sdl */\n categoryTreeNodeSdl?: CategoryTreeNode;\n /** Category ids in sdl */\n categoryIdsSdl?: string[];\n }\n /** Represents a node in the view of categories tree */\n interface CategoryTreeNode {\n /** Category ID. */\n _id?: Uint8Array;\n /**\n * The level of the category within the tree.\n * int32 level = 2 [(.wix.api.min) = 0, (.wix.api.max) = 5];\n * The parent category.\n * google.protobuf.StringValue parent_category_id = 3 [(.wix.api.format) = GUID];\n * A list of child category IDs arranged by the index.\n * repeated string subcategory_ids = 4 [(.wix.api.format) = GUID, (.wix.api.maxSize) = 10000];\n * A list of child categories.\n */\n subcategories?: CategoryTreeNode[];\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\n }\n /**\n * Creates a new Category.\n * @param category - Category to be created.\n * @requiredField category\n * @requiredField category.name\n * @requiredField category.parentCategory._id\n * @returns The created Category.\n */\n function createCategory(category: Category): Promise;\n /**\n * Retrieves a category with the provided ID.\n * @param categoryId - Id of the Category to retrieve.\n * @requiredField categoryId\n * @returns The retrieved Category.\n */\n function getCategory(categoryId: string): Promise;\n /**\n * Update a Category, supports partial update.\n * Pass the latest `revision` for a successful update.\n * Each time the category is updated, `revision` increments by 1.\n * @param _id - Category ID.\n * @requiredField _id\n * @requiredField category\n * @requiredField category.revision\n * @returns The updated Category.\n */\n function updateCategory(_id: string | null, category: UpdateCategory, options?: UpdateCategoryOptions): Promise;\n interface UpdateCategory {\n /** Category ID. */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Category was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Category name. */\n name?: string | null;\n /**\n * Category image.\n * Pass existing media ID for image previously saved in Wix media manager.\n * Pass full image URL to upload an image to Wix media manager.\n * In case of full url the image will be updated eventually.\n */\n image?: string;\n /**\n * Number of items in this category alone.\n * @readonly\n */\n numberOfItems?: number;\n /**\n * Number of items including all items in subcategories.\n * @readonly\n */\n totalNumberOfItems?: number;\n /** Category description. */\n description?: string | null;\n /**\n * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).\n * Even if visible is `false`, it can still be added manually to static page.\n * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.\n * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.\n */\n visible?: boolean | null;\n /**\n * A category's breadcrumbs.\n * Updated on moved to different parent or on renamed.\n * @readonly\n */\n breadcrumbs?: BreadcrumbItem[];\n /** The parent category. */\n parentCategory?: ParentCategory;\n /**\n * A permanent, friendly URL name.\n * When not provided, generated automatically.\n * When provided, validated and should be unique.\n */\n slug?: string | null;\n /**\n * Custom SEO data for the category.\n * @internal\n */\n seoData?: SeoSchema;\n /**\n * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.\n * In order to use this field you have to integrate with \"Ricos\" on frontend side. To learn how to do it visit https://ricos.js.org/.\n */\n richContentDescription?: RichContent;\n }\n interface UpdateCategoryOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a Category.\n * @param categoryId - Id of the Category to delete.\n * @requiredField categoryId\n */\n function deleteCategory(categoryId: string): Promise;\n /** Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) */\n function queryCategories(): CategoriesQueryBuilder;\n interface QueryCursorResult {\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CategoriesQueryResult extends QueryCursorResult {\n items: Category[];\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: string, value: any) => CategoriesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\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 */\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 */\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 */\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 */\n hasSome: (propertyName: string, value: any[]) => CategoriesQueryBuilder;\n in: (propertyName: string, value: any) => CategoriesQueryBuilder;\n exists: (propertyName: string, value: boolean) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: string[]) => CategoriesQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: string[]) => CategoriesQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => CategoriesQueryBuilder;\n find: () => Promise;\n }\n /**\n * Places category in parent category.\n * This operation updates `parentCategory` (`id` and `index`) for category with `categoryId`.\n * This endpoint can be used to move category to different parent or to change it's position in current parent.\n * @param categoryId - ID of category to place.\n * @requiredField categoryId\n */\n function placeCategoryInParentCategory(categoryId: string, options?: PlaceCategoryInParentCategoryOptions): Promise;\n interface PlaceCategoryInParentCategoryOptions {\n /**\n * ID of parent category.\n * Optional. When not passed it will fallback to the root category\n */\n parentCategoryId?: string | null;\n /**\n * Where to place the subcategory.\n * `FIRST` - make category with `category_id` first subcategory with manual arrangement.\n * `LAST` - make category with `category_id` last subcategory with manual arrangement.\n * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.\n */\n position?: PlaceCategoryInParentCategoryRequestPosition;\n /** Required when `position` is `BEFORE`. */\n moveBeforeCategoryId?: string | null;\n }\n /**\n * Creates multiple categories.\n * @param categories - List of categories to be created.\n * @requiredField categories\n */\n function bulkCreateCategories(categories: Category[], options?: BulkCreateCategoriesOptions): Promise;\n interface BulkCreateCategoriesOptions {\n /** Whether to return the full category entity in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Update `visible` field for multiple categories.\n * @param categoryIds - IDs of categories to be updated.\n * @requiredField categoryIds\n */\n function bulkSetVisibility(categoryIds: string[], options?: BulkSetVisibilityOptions): Promise;\n interface BulkSetVisibilityOptions {\n /** Whether to return the full category entity in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Update `visible` field for categories which satisfy the provided filter.\n * @param filter - 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 * @requiredField filter\n */\n function bulkSetVisibilityByFilter(filter: Record | null): Promise;\n /**\n * Deletes multiple categories.\n * @param categoryIds - IDs of categories to be deleted.\n * @requiredField categoryIds\n */\n function bulkDeleteCategories(categoryIds: string[]): Promise;\n /**\n * Delete multiple categories which satisfy the provided filter.\n * @param filter - 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 * @requiredField filter\n */\n function bulkDeleteCategoriesByFilter(filter: Record | null): Promise;\n /**\n * Adds multiple items to single category, fires as many domain events as many items successfully added.\n * @param categoryId - Category id.\n * @requiredField categoryId\n */\n function addItemsToCategory(categoryId: string, options?: AddItemsToCategoryOptions): Promise;\n interface AddItemsToCategoryOptions {\n /** List of catalog items with reference info. */\n items?: ItemReference[];\n }\n /**\n * Adds single item to multiple categories, fires as many domain events as many categories were successfully added.\n * @param itemReference - Catalog item reference info\n * @requiredField itemReference\n */\n function addItemToCategories(itemReference: ItemReference, options?: AddItemToCategoriesOptions): Promise;\n interface AddItemToCategoriesOptions {\n /** Category ids. */\n categoryIds?: string[];\n }\n /**\n * Removed multiple items from single category, fires as many domain events as many items successfully removed.\n * @param categoryId - Category id\n * @requiredField categoryId\n */\n function removeItemsFromCategory(categoryId: string, options?: RemoveItemsFromCategoryOptions): Promise;\n interface RemoveItemsFromCategoryOptions {\n /** List of catalog items with reference info. */\n items?: ItemReference[];\n }\n /**\n * Removes single item from multiple categories, fires as many domain events as many categories were successfully removed.\n * @param itemReference - Catalog item reference info\n * @requiredField itemReference\n */\n function removeItemFromCategories(itemReference: ItemReference, options?: RemoveItemFromCategoriesOptions): Promise;\n interface RemoveItemFromCategoriesOptions {\n /** Category ids. */\n categoryIds?: string[];\n }\n /**\n * Returns up to 100 items related to requested `category_id` sorted by time when item added to category, descending.\n * When items added to category in bulk they considered as added at exactly same time so order will be random but always the same.\n * @param categoryId - ID of category containing items.\n * @requiredField categoryId\n */\n function listItemsInCategory(categoryId: string, options?: ListItemsInCategoryOptions): Promise;\n interface ListItemsInCategoryOptions {\n /** Default: `false`. When `true` items arranged by user will be return before all other items. */\n useCategoryArrangement?: boolean;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */\n paging?: CursorPaging;\n }\n /**\n * Changes position of `item` in category. Will be used when sort items by manual arrangement\n * @param categoryId - ID of category.\n * Item must be direct child of this category, otherwise error returned\n * @param item - Item to move.\n * @requiredField categoryId\n * @requiredField item\n */\n function moveItemInCategory(categoryId: string, item: ItemReference, options?: MoveItemInCategoryOptions): Promise;\n interface MoveItemInCategoryOptions {\n /**\n * Where to move item.\n * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.\n * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.\n * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.\n * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.\n */\n position?: Position;\n /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */\n beforeItem?: ItemReference;\n }\n /**\n * Save the whole categories tree\n * @param numberOfCategories - The number of categories to put\n * @requiredField numberOfCategories\n */\n function putCategoriesTree(numberOfCategories: number | null): Promise;\n /** Retrieves the whole categories tree */\n function getCategoriesTree(): Promise;\n \n const ecomV1Category_universal_d___debug: typeof __debug;\n type ecomV1Category_universal_d_Category = Category;\n type ecomV1Category_universal_d_BreadcrumbItem = BreadcrumbItem;\n type ecomV1Category_universal_d_ParentCategory = ParentCategory;\n type ecomV1Category_universal_d_SeoSchema = SeoSchema;\n type ecomV1Category_universal_d_Tag = Tag;\n type ecomV1Category_universal_d_Settings = Settings;\n type ecomV1Category_universal_d_RichContent = RichContent;\n type ecomV1Category_universal_d_Node = Node;\n type ecomV1Category_universal_d_NodeDataOneOf = NodeDataOneOf;\n type ecomV1Category_universal_d_NodeType = NodeType;\n const ecomV1Category_universal_d_NodeType: typeof NodeType;\n type ecomV1Category_universal_d_NodeStyle = NodeStyle;\n type ecomV1Category_universal_d_ButtonData = ButtonData;\n type ecomV1Category_universal_d_Border = Border;\n type ecomV1Category_universal_d_Colors = Colors;\n type ecomV1Category_universal_d_PluginContainerData = PluginContainerData;\n type ecomV1Category_universal_d_WidthType = WidthType;\n const ecomV1Category_universal_d_WidthType: typeof WidthType;\n type ecomV1Category_universal_d_PluginContainerDataWidth = PluginContainerDataWidth;\n type ecomV1Category_universal_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;\n type ecomV1Category_universal_d_PluginContainerDataAlignment = PluginContainerDataAlignment;\n const ecomV1Category_universal_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;\n type ecomV1Category_universal_d_Spoiler = Spoiler;\n type ecomV1Category_universal_d_Height = Height;\n type ecomV1Category_universal_d_Type = Type;\n const ecomV1Category_universal_d_Type: typeof Type;\n type ecomV1Category_universal_d_Styles = Styles;\n type ecomV1Category_universal_d_Link = Link;\n type ecomV1Category_universal_d_LinkDataOneOf = LinkDataOneOf;\n type ecomV1Category_universal_d_Target = Target;\n const ecomV1Category_universal_d_Target: typeof Target;\n type ecomV1Category_universal_d_Rel = Rel;\n type ecomV1Category_universal_d_CodeBlockData = CodeBlockData;\n type ecomV1Category_universal_d_TextStyle = TextStyle;\n type ecomV1Category_universal_d_TextAlignment = TextAlignment;\n const ecomV1Category_universal_d_TextAlignment: typeof TextAlignment;\n type ecomV1Category_universal_d_DividerData = DividerData;\n type ecomV1Category_universal_d_LineStyle = LineStyle;\n const ecomV1Category_universal_d_LineStyle: typeof LineStyle;\n type ecomV1Category_universal_d_Width = Width;\n const ecomV1Category_universal_d_Width: typeof Width;\n type ecomV1Category_universal_d_Alignment = Alignment;\n const ecomV1Category_universal_d_Alignment: typeof Alignment;\n type ecomV1Category_universal_d_FileData = FileData;\n type ecomV1Category_universal_d_ViewMode = ViewMode;\n const ecomV1Category_universal_d_ViewMode: typeof ViewMode;\n type ecomV1Category_universal_d_FileSource = FileSource;\n type ecomV1Category_universal_d_FileSourceDataOneOf = FileSourceDataOneOf;\n type ecomV1Category_universal_d_PDFSettings = PDFSettings;\n type ecomV1Category_universal_d_GalleryData = GalleryData;\n type ecomV1Category_universal_d_Media = Media;\n type ecomV1Category_universal_d_Image = Image;\n type ecomV1Category_universal_d_Video = Video;\n type ecomV1Category_universal_d_Item = Item;\n type ecomV1Category_universal_d_ItemDataOneOf = ItemDataOneOf;\n type ecomV1Category_universal_d_GalleryOptions = GalleryOptions;\n type ecomV1Category_universal_d_LayoutType = LayoutType;\n const ecomV1Category_universal_d_LayoutType: typeof LayoutType;\n type ecomV1Category_universal_d_Orientation = Orientation;\n const ecomV1Category_universal_d_Orientation: typeof Orientation;\n type ecomV1Category_universal_d_Crop = Crop;\n const ecomV1Category_universal_d_Crop: typeof Crop;\n type ecomV1Category_universal_d_ThumbnailsAlignment = ThumbnailsAlignment;\n const ecomV1Category_universal_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;\n type ecomV1Category_universal_d_Layout = Layout;\n type ecomV1Category_universal_d_ItemStyle = ItemStyle;\n type ecomV1Category_universal_d_Thumbnails = Thumbnails;\n type ecomV1Category_universal_d_GIFData = GIFData;\n type ecomV1Category_universal_d_GIF = GIF;\n type ecomV1Category_universal_d_HeadingData = HeadingData;\n type ecomV1Category_universal_d_HTMLData = HTMLData;\n type ecomV1Category_universal_d_HTMLDataDataOneOf = HTMLDataDataOneOf;\n type ecomV1Category_universal_d_Source = Source;\n const ecomV1Category_universal_d_Source: typeof Source;\n type ecomV1Category_universal_d_ImageData = ImageData;\n type ecomV1Category_universal_d_LinkPreviewData = LinkPreviewData;\n type ecomV1Category_universal_d_MapData = MapData;\n type ecomV1Category_universal_d_MapSettings = MapSettings;\n type ecomV1Category_universal_d_MapType = MapType;\n const ecomV1Category_universal_d_MapType: typeof MapType;\n type ecomV1Category_universal_d_ParagraphData = ParagraphData;\n type ecomV1Category_universal_d_PollData = PollData;\n type ecomV1Category_universal_d_ViewRole = ViewRole;\n const ecomV1Category_universal_d_ViewRole: typeof ViewRole;\n type ecomV1Category_universal_d_VoteRole = VoteRole;\n const ecomV1Category_universal_d_VoteRole: typeof VoteRole;\n type ecomV1Category_universal_d_Permissions = Permissions;\n type ecomV1Category_universal_d_Option = Option;\n type ecomV1Category_universal_d_PollSettings = PollSettings;\n type ecomV1Category_universal_d_PollLayoutType = PollLayoutType;\n const ecomV1Category_universal_d_PollLayoutType: typeof PollLayoutType;\n type ecomV1Category_universal_d_PollLayoutDirection = PollLayoutDirection;\n const ecomV1Category_universal_d_PollLayoutDirection: typeof PollLayoutDirection;\n type ecomV1Category_universal_d_PollLayout = PollLayout;\n type ecomV1Category_universal_d_OptionLayout = OptionLayout;\n type ecomV1Category_universal_d_BackgroundType = BackgroundType;\n const ecomV1Category_universal_d_BackgroundType: typeof BackgroundType;\n type ecomV1Category_universal_d_Gradient = Gradient;\n type ecomV1Category_universal_d_Background = Background;\n type ecomV1Category_universal_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;\n type ecomV1Category_universal_d_PollDesign = PollDesign;\n type ecomV1Category_universal_d_OptionDesign = OptionDesign;\n type ecomV1Category_universal_d_Poll = Poll;\n type ecomV1Category_universal_d_PollDataLayout = PollDataLayout;\n type ecomV1Category_universal_d_Design = Design;\n type ecomV1Category_universal_d_TextData = TextData;\n type ecomV1Category_universal_d_Decoration = Decoration;\n type ecomV1Category_universal_d_DecorationDataOneOf = DecorationDataOneOf;\n type ecomV1Category_universal_d_DecorationType = DecorationType;\n const ecomV1Category_universal_d_DecorationType: typeof DecorationType;\n type ecomV1Category_universal_d_AnchorData = AnchorData;\n type ecomV1Category_universal_d_ColorData = ColorData;\n type ecomV1Category_universal_d_LinkData = LinkData;\n type ecomV1Category_universal_d_MentionData = MentionData;\n type ecomV1Category_universal_d_FontSizeData = FontSizeData;\n type ecomV1Category_universal_d_FontType = FontType;\n const ecomV1Category_universal_d_FontType: typeof FontType;\n type ecomV1Category_universal_d_AppEmbedData = AppEmbedData;\n type ecomV1Category_universal_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;\n type ecomV1Category_universal_d_AppType = AppType;\n const ecomV1Category_universal_d_AppType: typeof AppType;\n type ecomV1Category_universal_d_BookingData = BookingData;\n type ecomV1Category_universal_d_EventData = EventData;\n type ecomV1Category_universal_d_VideoData = VideoData;\n type ecomV1Category_universal_d_PlaybackOptions = PlaybackOptions;\n type ecomV1Category_universal_d_EmbedData = EmbedData;\n type ecomV1Category_universal_d_Oembed = Oembed;\n type ecomV1Category_universal_d_CollapsibleListData = CollapsibleListData;\n type ecomV1Category_universal_d_InitialExpandedItems = InitialExpandedItems;\n const ecomV1Category_universal_d_InitialExpandedItems: typeof InitialExpandedItems;\n type ecomV1Category_universal_d_Direction = Direction;\n const ecomV1Category_universal_d_Direction: typeof Direction;\n type ecomV1Category_universal_d_TableData = TableData;\n type ecomV1Category_universal_d_Dimensions = Dimensions;\n type ecomV1Category_universal_d_TableCellData = TableCellData;\n type ecomV1Category_universal_d_VerticalAlignment = VerticalAlignment;\n const ecomV1Category_universal_d_VerticalAlignment: typeof VerticalAlignment;\n type ecomV1Category_universal_d_CellStyle = CellStyle;\n type ecomV1Category_universal_d_BorderColors = BorderColors;\n type ecomV1Category_universal_d_NullValue = NullValue;\n const ecomV1Category_universal_d_NullValue: typeof NullValue;\n type ecomV1Category_universal_d_ListValue = ListValue;\n type ecomV1Category_universal_d_AudioData = AudioData;\n type ecomV1Category_universal_d_OrderedListData = OrderedListData;\n type ecomV1Category_universal_d_BulletedListData = BulletedListData;\n type ecomV1Category_universal_d_BlockquoteData = BlockquoteData;\n type ecomV1Category_universal_d_Metadata = Metadata;\n type ecomV1Category_universal_d_DocumentStyle = DocumentStyle;\n type ecomV1Category_universal_d_TextNodeStyle = TextNodeStyle;\n type ecomV1Category_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type ecomV1Category_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type ecomV1Category_universal_d_GetCategoryRequest = GetCategoryRequest;\n type ecomV1Category_universal_d_GetCategoryResponse = GetCategoryResponse;\n type ecomV1Category_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type ecomV1Category_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type ecomV1Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type ecomV1Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type ecomV1Category_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type ecomV1Category_universal_d_QueryV2 = QueryV2;\n type ecomV1Category_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type ecomV1Category_universal_d_Sorting = Sorting;\n type ecomV1Category_universal_d_SortOrder = SortOrder;\n const ecomV1Category_universal_d_SortOrder: typeof SortOrder;\n type ecomV1Category_universal_d_Paging = Paging;\n type ecomV1Category_universal_d_CursorPaging = CursorPaging;\n type ecomV1Category_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type ecomV1Category_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type ecomV1Category_universal_d_Cursors = Cursors;\n type ecomV1Category_universal_d_PlaceCategoryInParentCategoryRequest = PlaceCategoryInParentCategoryRequest;\n type ecomV1Category_universal_d_PlaceCategoryInParentCategoryRequestPosition = PlaceCategoryInParentCategoryRequestPosition;\n const ecomV1Category_universal_d_PlaceCategoryInParentCategoryRequestPosition: typeof PlaceCategoryInParentCategoryRequestPosition;\n type ecomV1Category_universal_d_PlaceCategoryInParentCategoryResponse = PlaceCategoryInParentCategoryResponse;\n type ecomV1Category_universal_d_BulkCreateCategoriesRequest = BulkCreateCategoriesRequest;\n type ecomV1Category_universal_d_BulkCreateCategoriesResponse = BulkCreateCategoriesResponse;\n type ecomV1Category_universal_d_BulkCategoriesResult = BulkCategoriesResult;\n type ecomV1Category_universal_d_ItemMetadata = ItemMetadata;\n type ecomV1Category_universal_d_ApplicationError = ApplicationError;\n type ecomV1Category_universal_d_BulkActionMetadata = BulkActionMetadata;\n type ecomV1Category_universal_d_BulkSetVisibilityRequest = BulkSetVisibilityRequest;\n type ecomV1Category_universal_d_BulkSetVisibilityResponse = BulkSetVisibilityResponse;\n type ecomV1Category_universal_d_BulkSetVisibilityByFilterRequest = BulkSetVisibilityByFilterRequest;\n type ecomV1Category_universal_d_BulkSetVisibilityByFilterResponse = BulkSetVisibilityByFilterResponse;\n type ecomV1Category_universal_d_BulkDeleteCategoriesRequest = BulkDeleteCategoriesRequest;\n type ecomV1Category_universal_d_BulkDeleteCategoriesResponse = BulkDeleteCategoriesResponse;\n type ecomV1Category_universal_d_BulkDeleteCategoriesByFilterRequest = BulkDeleteCategoriesByFilterRequest;\n type ecomV1Category_universal_d_BulkDeleteCategoriesByFilterResponse = BulkDeleteCategoriesByFilterResponse;\n type ecomV1Category_universal_d_AddItemsToCategoryRequest = AddItemsToCategoryRequest;\n type ecomV1Category_universal_d_ItemReference = ItemReference;\n type ecomV1Category_universal_d_AddItemsToCategoryResponse = AddItemsToCategoryResponse;\n type ecomV1Category_universal_d_BulkItemsToCategoryResult = BulkItemsToCategoryResult;\n type ecomV1Category_universal_d_ItemReferenceMetadata = ItemReferenceMetadata;\n type ecomV1Category_universal_d_ItemAddedToCategory = ItemAddedToCategory;\n type ecomV1Category_universal_d_AddItemToCategoriesRequest = AddItemToCategoriesRequest;\n type ecomV1Category_universal_d_AddItemToCategoriesResponse = AddItemToCategoriesResponse;\n type ecomV1Category_universal_d_BulkItemToCategoriesResult = BulkItemToCategoriesResult;\n type ecomV1Category_universal_d_RemoveItemsFromCategoryRequest = RemoveItemsFromCategoryRequest;\n type ecomV1Category_universal_d_RemoveItemsFromCategoryResponse = RemoveItemsFromCategoryResponse;\n type ecomV1Category_universal_d_ItemRemovedFromCategory = ItemRemovedFromCategory;\n type ecomV1Category_universal_d_RemoveItemFromCategoriesRequest = RemoveItemFromCategoriesRequest;\n type ecomV1Category_universal_d_RemoveItemFromCategoriesResponse = RemoveItemFromCategoriesResponse;\n type ecomV1Category_universal_d_ListItemsInCategoryRequest = ListItemsInCategoryRequest;\n type ecomV1Category_universal_d_ListItemsInCategoryResponse = ListItemsInCategoryResponse;\n type ecomV1Category_universal_d_MoveItemInCategoryRequest = MoveItemInCategoryRequest;\n type ecomV1Category_universal_d_Position = Position;\n const ecomV1Category_universal_d_Position: typeof Position;\n type ecomV1Category_universal_d_MoveItemInCategoryResponse = MoveItemInCategoryResponse;\n type ecomV1Category_universal_d_PutCategoriesTreeRequest = PutCategoriesTreeRequest;\n type ecomV1Category_universal_d_PutCategoriesTreeResponse = PutCategoriesTreeResponse;\n type ecomV1Category_universal_d_GetCategoriesTreeRequest = GetCategoriesTreeRequest;\n type ecomV1Category_universal_d_GetCategoriesTreeResponse = GetCategoriesTreeResponse;\n type ecomV1Category_universal_d_CategoryTreeNode = CategoryTreeNode;\n type ecomV1Category_universal_d_DomainEvent = DomainEvent;\n type ecomV1Category_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type ecomV1Category_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type ecomV1Category_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type ecomV1Category_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type ecomV1Category_universal_d_ActionEvent = ActionEvent;\n type ecomV1Category_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type ecomV1Category_universal_d_Empty = Empty;\n const ecomV1Category_universal_d_createCategory: typeof createCategory;\n const ecomV1Category_universal_d_getCategory: typeof getCategory;\n const ecomV1Category_universal_d_updateCategory: typeof updateCategory;\n type ecomV1Category_universal_d_UpdateCategory = UpdateCategory;\n type ecomV1Category_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const ecomV1Category_universal_d_deleteCategory: typeof deleteCategory;\n const ecomV1Category_universal_d_queryCategories: typeof queryCategories;\n type ecomV1Category_universal_d_CategoriesQueryResult = CategoriesQueryResult;\n type ecomV1Category_universal_d_CategoriesQueryBuilder = CategoriesQueryBuilder;\n const ecomV1Category_universal_d_placeCategoryInParentCategory: typeof placeCategoryInParentCategory;\n type ecomV1Category_universal_d_PlaceCategoryInParentCategoryOptions = PlaceCategoryInParentCategoryOptions;\n const ecomV1Category_universal_d_bulkCreateCategories: typeof bulkCreateCategories;\n type ecomV1Category_universal_d_BulkCreateCategoriesOptions = BulkCreateCategoriesOptions;\n const ecomV1Category_universal_d_bulkSetVisibility: typeof bulkSetVisibility;\n type ecomV1Category_universal_d_BulkSetVisibilityOptions = BulkSetVisibilityOptions;\n const ecomV1Category_universal_d_bulkSetVisibilityByFilter: typeof bulkSetVisibilityByFilter;\n const ecomV1Category_universal_d_bulkDeleteCategories: typeof bulkDeleteCategories;\n const ecomV1Category_universal_d_bulkDeleteCategoriesByFilter: typeof bulkDeleteCategoriesByFilter;\n const ecomV1Category_universal_d_addItemsToCategory: typeof addItemsToCategory;\n type ecomV1Category_universal_d_AddItemsToCategoryOptions = AddItemsToCategoryOptions;\n const ecomV1Category_universal_d_addItemToCategories: typeof addItemToCategories;\n type ecomV1Category_universal_d_AddItemToCategoriesOptions = AddItemToCategoriesOptions;\n const ecomV1Category_universal_d_removeItemsFromCategory: typeof removeItemsFromCategory;\n type ecomV1Category_universal_d_RemoveItemsFromCategoryOptions = RemoveItemsFromCategoryOptions;\n const ecomV1Category_universal_d_removeItemFromCategories: typeof removeItemFromCategories;\n type ecomV1Category_universal_d_RemoveItemFromCategoriesOptions = RemoveItemFromCategoriesOptions;\n const ecomV1Category_universal_d_listItemsInCategory: typeof listItemsInCategory;\n type ecomV1Category_universal_d_ListItemsInCategoryOptions = ListItemsInCategoryOptions;\n const ecomV1Category_universal_d_moveItemInCategory: typeof moveItemInCategory;\n type ecomV1Category_universal_d_MoveItemInCategoryOptions = MoveItemInCategoryOptions;\n const ecomV1Category_universal_d_putCategoriesTree: typeof putCategoriesTree;\n const ecomV1Category_universal_d_getCategoriesTree: typeof getCategoriesTree;\n namespace ecomV1Category_universal_d {\n export {\n ecomV1Category_universal_d___debug as __debug,\n ecomV1Category_universal_d_Category as Category,\n ecomV1Category_universal_d_BreadcrumbItem as BreadcrumbItem,\n ecomV1Category_universal_d_ParentCategory as ParentCategory,\n ecomV1Category_universal_d_SeoSchema as SeoSchema,\n ecomV1Category_universal_d_Tag as Tag,\n ecomV1Category_universal_d_Settings as Settings,\n ecomV1Category_universal_d_RichContent as RichContent,\n ecomV1Category_universal_d_Node as Node,\n ecomV1Category_universal_d_NodeDataOneOf as NodeDataOneOf,\n ecomV1Category_universal_d_NodeType as NodeType,\n ecomV1Category_universal_d_NodeStyle as NodeStyle,\n ecomV1Category_universal_d_ButtonData as ButtonData,\n ecomV1Category_universal_d_Border as Border,\n ecomV1Category_universal_d_Colors as Colors,\n ecomV1Category_universal_d_PluginContainerData as PluginContainerData,\n ecomV1Category_universal_d_WidthType as WidthType,\n ecomV1Category_universal_d_PluginContainerDataWidth as PluginContainerDataWidth,\n ecomV1Category_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf,\n ecomV1Category_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment,\n ecomV1Category_universal_d_Spoiler as Spoiler,\n ecomV1Category_universal_d_Height as Height,\n ecomV1Category_universal_d_Type as Type,\n ecomV1Category_universal_d_Styles as Styles,\n ecomV1Category_universal_d_Link as Link,\n ecomV1Category_universal_d_LinkDataOneOf as LinkDataOneOf,\n ecomV1Category_universal_d_Target as Target,\n ecomV1Category_universal_d_Rel as Rel,\n ecomV1Category_universal_d_CodeBlockData as CodeBlockData,\n ecomV1Category_universal_d_TextStyle as TextStyle,\n ecomV1Category_universal_d_TextAlignment as TextAlignment,\n ecomV1Category_universal_d_DividerData as DividerData,\n ecomV1Category_universal_d_LineStyle as LineStyle,\n ecomV1Category_universal_d_Width as Width,\n ecomV1Category_universal_d_Alignment as Alignment,\n ecomV1Category_universal_d_FileData as FileData,\n ecomV1Category_universal_d_ViewMode as ViewMode,\n ecomV1Category_universal_d_FileSource as FileSource,\n ecomV1Category_universal_d_FileSourceDataOneOf as FileSourceDataOneOf,\n ecomV1Category_universal_d_PDFSettings as PDFSettings,\n ecomV1Category_universal_d_GalleryData as GalleryData,\n ecomV1Category_universal_d_Media as Media,\n ecomV1Category_universal_d_Image as Image,\n ecomV1Category_universal_d_Video as Video,\n ecomV1Category_universal_d_Item as Item,\n ecomV1Category_universal_d_ItemDataOneOf as ItemDataOneOf,\n ecomV1Category_universal_d_GalleryOptions as GalleryOptions,\n ecomV1Category_universal_d_LayoutType as LayoutType,\n ecomV1Category_universal_d_Orientation as Orientation,\n ecomV1Category_universal_d_Crop as Crop,\n ecomV1Category_universal_d_ThumbnailsAlignment as ThumbnailsAlignment,\n ecomV1Category_universal_d_Layout as Layout,\n ecomV1Category_universal_d_ItemStyle as ItemStyle,\n ecomV1Category_universal_d_Thumbnails as Thumbnails,\n ecomV1Category_universal_d_GIFData as GIFData,\n ecomV1Category_universal_d_GIF as GIF,\n ecomV1Category_universal_d_HeadingData as HeadingData,\n ecomV1Category_universal_d_HTMLData as HTMLData,\n ecomV1Category_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf,\n ecomV1Category_universal_d_Source as Source,\n ecomV1Category_universal_d_ImageData as ImageData,\n ecomV1Category_universal_d_LinkPreviewData as LinkPreviewData,\n ecomV1Category_universal_d_MapData as MapData,\n ecomV1Category_universal_d_MapSettings as MapSettings,\n ecomV1Category_universal_d_MapType as MapType,\n ecomV1Category_universal_d_ParagraphData as ParagraphData,\n ecomV1Category_universal_d_PollData as PollData,\n ecomV1Category_universal_d_ViewRole as ViewRole,\n ecomV1Category_universal_d_VoteRole as VoteRole,\n ecomV1Category_universal_d_Permissions as Permissions,\n ecomV1Category_universal_d_Option as Option,\n ecomV1Category_universal_d_PollSettings as PollSettings,\n ecomV1Category_universal_d_PollLayoutType as PollLayoutType,\n ecomV1Category_universal_d_PollLayoutDirection as PollLayoutDirection,\n ecomV1Category_universal_d_PollLayout as PollLayout,\n ecomV1Category_universal_d_OptionLayout as OptionLayout,\n ecomV1Category_universal_d_BackgroundType as BackgroundType,\n ecomV1Category_universal_d_Gradient as Gradient,\n ecomV1Category_universal_d_Background as Background,\n ecomV1Category_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf,\n ecomV1Category_universal_d_PollDesign as PollDesign,\n ecomV1Category_universal_d_OptionDesign as OptionDesign,\n ecomV1Category_universal_d_Poll as Poll,\n ecomV1Category_universal_d_PollDataLayout as PollDataLayout,\n ecomV1Category_universal_d_Design as Design,\n ecomV1Category_universal_d_TextData as TextData,\n ecomV1Category_universal_d_Decoration as Decoration,\n ecomV1Category_universal_d_DecorationDataOneOf as DecorationDataOneOf,\n ecomV1Category_universal_d_DecorationType as DecorationType,\n ecomV1Category_universal_d_AnchorData as AnchorData,\n ecomV1Category_universal_d_ColorData as ColorData,\n ecomV1Category_universal_d_LinkData as LinkData,\n ecomV1Category_universal_d_MentionData as MentionData,\n ecomV1Category_universal_d_FontSizeData as FontSizeData,\n ecomV1Category_universal_d_FontType as FontType,\n ecomV1Category_universal_d_AppEmbedData as AppEmbedData,\n ecomV1Category_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf,\n ecomV1Category_universal_d_AppType as AppType,\n ecomV1Category_universal_d_BookingData as BookingData,\n ecomV1Category_universal_d_EventData as EventData,\n ecomV1Category_universal_d_VideoData as VideoData,\n ecomV1Category_universal_d_PlaybackOptions as PlaybackOptions,\n ecomV1Category_universal_d_EmbedData as EmbedData,\n ecomV1Category_universal_d_Oembed as Oembed,\n ecomV1Category_universal_d_CollapsibleListData as CollapsibleListData,\n ecomV1Category_universal_d_InitialExpandedItems as InitialExpandedItems,\n ecomV1Category_universal_d_Direction as Direction,\n ecomV1Category_universal_d_TableData as TableData,\n ecomV1Category_universal_d_Dimensions as Dimensions,\n ecomV1Category_universal_d_TableCellData as TableCellData,\n ecomV1Category_universal_d_VerticalAlignment as VerticalAlignment,\n ecomV1Category_universal_d_CellStyle as CellStyle,\n ecomV1Category_universal_d_BorderColors as BorderColors,\n ecomV1Category_universal_d_NullValue as NullValue,\n ecomV1Category_universal_d_ListValue as ListValue,\n ecomV1Category_universal_d_AudioData as AudioData,\n ecomV1Category_universal_d_OrderedListData as OrderedListData,\n ecomV1Category_universal_d_BulletedListData as BulletedListData,\n ecomV1Category_universal_d_BlockquoteData as BlockquoteData,\n ecomV1Category_universal_d_Metadata as Metadata,\n ecomV1Category_universal_d_DocumentStyle as DocumentStyle,\n ecomV1Category_universal_d_TextNodeStyle as TextNodeStyle,\n ecomV1Category_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n ecomV1Category_universal_d_CreateCategoryResponse as CreateCategoryResponse,\n ecomV1Category_universal_d_GetCategoryRequest as GetCategoryRequest,\n ecomV1Category_universal_d_GetCategoryResponse as GetCategoryResponse,\n ecomV1Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n ecomV1Category_universal_d_UpdateCategoryResponse as UpdateCategoryResponse,\n ecomV1Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n ecomV1Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n ecomV1Category_universal_d_QueryCategoriesRequest as QueryCategoriesRequest,\n ecomV1Category_universal_d_QueryV2 as QueryV2,\n ecomV1Category_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n ecomV1Category_universal_d_Sorting as Sorting,\n ecomV1Category_universal_d_SortOrder as SortOrder,\n ecomV1Category_universal_d_Paging as Paging,\n ecomV1Category_universal_d_CursorPaging as CursorPaging,\n ecomV1Category_universal_d_QueryCategoriesResponse as QueryCategoriesResponse,\n ecomV1Category_universal_d_PagingMetadataV2 as PagingMetadataV2,\n ecomV1Category_universal_d_Cursors as Cursors,\n ecomV1Category_universal_d_PlaceCategoryInParentCategoryRequest as PlaceCategoryInParentCategoryRequest,\n ecomV1Category_universal_d_PlaceCategoryInParentCategoryRequestPosition as PlaceCategoryInParentCategoryRequestPosition,\n ecomV1Category_universal_d_PlaceCategoryInParentCategoryResponse as PlaceCategoryInParentCategoryResponse,\n ecomV1Category_universal_d_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest,\n ecomV1Category_universal_d_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse,\n ecomV1Category_universal_d_BulkCategoriesResult as BulkCategoriesResult,\n ecomV1Category_universal_d_ItemMetadata as ItemMetadata,\n ecomV1Category_universal_d_ApplicationError as ApplicationError,\n ecomV1Category_universal_d_BulkActionMetadata as BulkActionMetadata,\n ecomV1Category_universal_d_BulkSetVisibilityRequest as BulkSetVisibilityRequest,\n ecomV1Category_universal_d_BulkSetVisibilityResponse as BulkSetVisibilityResponse,\n ecomV1Category_universal_d_BulkSetVisibilityByFilterRequest as BulkSetVisibilityByFilterRequest,\n ecomV1Category_universal_d_BulkSetVisibilityByFilterResponse as BulkSetVisibilityByFilterResponse,\n ecomV1Category_universal_d_BulkDeleteCategoriesRequest as BulkDeleteCategoriesRequest,\n ecomV1Category_universal_d_BulkDeleteCategoriesResponse as BulkDeleteCategoriesResponse,\n ecomV1Category_universal_d_BulkDeleteCategoriesByFilterRequest as BulkDeleteCategoriesByFilterRequest,\n ecomV1Category_universal_d_BulkDeleteCategoriesByFilterResponse as BulkDeleteCategoriesByFilterResponse,\n ecomV1Category_universal_d_AddItemsToCategoryRequest as AddItemsToCategoryRequest,\n ecomV1Category_universal_d_ItemReference as ItemReference,\n ecomV1Category_universal_d_AddItemsToCategoryResponse as AddItemsToCategoryResponse,\n ecomV1Category_universal_d_BulkItemsToCategoryResult as BulkItemsToCategoryResult,\n ecomV1Category_universal_d_ItemReferenceMetadata as ItemReferenceMetadata,\n ecomV1Category_universal_d_ItemAddedToCategory as ItemAddedToCategory,\n ecomV1Category_universal_d_AddItemToCategoriesRequest as AddItemToCategoriesRequest,\n ecomV1Category_universal_d_AddItemToCategoriesResponse as AddItemToCategoriesResponse,\n ecomV1Category_universal_d_BulkItemToCategoriesResult as BulkItemToCategoriesResult,\n ecomV1Category_universal_d_RemoveItemsFromCategoryRequest as RemoveItemsFromCategoryRequest,\n ecomV1Category_universal_d_RemoveItemsFromCategoryResponse as RemoveItemsFromCategoryResponse,\n ecomV1Category_universal_d_ItemRemovedFromCategory as ItemRemovedFromCategory,\n ecomV1Category_universal_d_RemoveItemFromCategoriesRequest as RemoveItemFromCategoriesRequest,\n ecomV1Category_universal_d_RemoveItemFromCategoriesResponse as RemoveItemFromCategoriesResponse,\n ecomV1Category_universal_d_ListItemsInCategoryRequest as ListItemsInCategoryRequest,\n ecomV1Category_universal_d_ListItemsInCategoryResponse as ListItemsInCategoryResponse,\n ecomV1Category_universal_d_MoveItemInCategoryRequest as MoveItemInCategoryRequest,\n ecomV1Category_universal_d_Position as Position,\n ecomV1Category_universal_d_MoveItemInCategoryResponse as MoveItemInCategoryResponse,\n ecomV1Category_universal_d_PutCategoriesTreeRequest as PutCategoriesTreeRequest,\n ecomV1Category_universal_d_PutCategoriesTreeResponse as PutCategoriesTreeResponse,\n ecomV1Category_universal_d_GetCategoriesTreeRequest as GetCategoriesTreeRequest,\n ecomV1Category_universal_d_GetCategoriesTreeResponse as GetCategoriesTreeResponse,\n ecomV1Category_universal_d_CategoryTreeNode as CategoryTreeNode,\n ecomV1Category_universal_d_DomainEvent as DomainEvent,\n ecomV1Category_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n ecomV1Category_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n ecomV1Category_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n ecomV1Category_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n ecomV1Category_universal_d_ActionEvent as ActionEvent,\n ecomV1Category_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n ecomV1Category_universal_d_Empty as Empty,\n ecomV1Category_universal_d_createCategory as createCategory,\n ecomV1Category_universal_d_getCategory as getCategory,\n ecomV1Category_universal_d_updateCategory as updateCategory,\n ecomV1Category_universal_d_UpdateCategory as UpdateCategory,\n ecomV1Category_universal_d_UpdateCategoryOptions as UpdateCategoryOptions,\n ecomV1Category_universal_d_deleteCategory as deleteCategory,\n ecomV1Category_universal_d_queryCategories as queryCategories,\n ecomV1Category_universal_d_CategoriesQueryResult as CategoriesQueryResult,\n ecomV1Category_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder,\n ecomV1Category_universal_d_placeCategoryInParentCategory as placeCategoryInParentCategory,\n ecomV1Category_universal_d_PlaceCategoryInParentCategoryOptions as PlaceCategoryInParentCategoryOptions,\n ecomV1Category_universal_d_bulkCreateCategories as bulkCreateCategories,\n ecomV1Category_universal_d_BulkCreateCategoriesOptions as BulkCreateCategoriesOptions,\n ecomV1Category_universal_d_bulkSetVisibility as bulkSetVisibility,\n ecomV1Category_universal_d_BulkSetVisibilityOptions as BulkSetVisibilityOptions,\n ecomV1Category_universal_d_bulkSetVisibilityByFilter as bulkSetVisibilityByFilter,\n ecomV1Category_universal_d_bulkDeleteCategories as bulkDeleteCategories,\n ecomV1Category_universal_d_bulkDeleteCategoriesByFilter as bulkDeleteCategoriesByFilter,\n ecomV1Category_universal_d_addItemsToCategory as addItemsToCategory,\n ecomV1Category_universal_d_AddItemsToCategoryOptions as AddItemsToCategoryOptions,\n ecomV1Category_universal_d_addItemToCategories as addItemToCategories,\n ecomV1Category_universal_d_AddItemToCategoriesOptions as AddItemToCategoriesOptions,\n ecomV1Category_universal_d_removeItemsFromCategory as removeItemsFromCategory,\n ecomV1Category_universal_d_RemoveItemsFromCategoryOptions as RemoveItemsFromCategoryOptions,\n ecomV1Category_universal_d_removeItemFromCategories as removeItemFromCategories,\n ecomV1Category_universal_d_RemoveItemFromCategoriesOptions as RemoveItemFromCategoriesOptions,\n ecomV1Category_universal_d_listItemsInCategory as listItemsInCategory,\n ecomV1Category_universal_d_ListItemsInCategoryOptions as ListItemsInCategoryOptions,\n ecomV1Category_universal_d_moveItemInCategory as moveItemInCategory,\n ecomV1Category_universal_d_MoveItemInCategoryOptions as MoveItemInCategoryOptions,\n ecomV1Category_universal_d_putCategoriesTree as putCategoriesTree,\n ecomV1Category_universal_d_getCategoriesTree as getCategoriesTree,\n };\n }\n \n export { ecomV1Category_universal_d as category };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-events.v2.d.ts", "content": "declare module \"wix-events.v2\" {\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$2[];\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$2;\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$2 {\n /** Ticket number. */\n number?: string;\n /** Ticket definition ID. */\n definitionId?: string | null;\n /** Ticket name. */\n name?: string | null;\n /**\n * Ticket guest details.\n * @internal\n */\n guestDetails?: TicketGuestDetails;\n }\n interface TicketGuestDetails {\n /** The login details for the guest to access the online conference event. */\n onlineConferencingLogin?: OnlineConferencingLogin$5;\n /** First name. */\n firstName?: string | null;\n /** Last name. */\n lastName?: string | null;\n }\n interface OnlineConferencingLogin$5 {\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$2 {\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$5;\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$5;\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$5 {\n inputValues?: InputValue$5[];\n }\n interface InputValue$5 {\n inputName?: string;\n value?: string;\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date | null;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress$5;\n }\n interface FormattedAddress$5 {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address$a;\n }\n /** Physical address */\n interface Address$a extends AddressStreetOneOf$a {\n /** Street name and number. */\n streetAddress?: StreetAddress$a;\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$a;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision$a[];\n }\n /** @oneof */\n interface AddressStreetOneOf$a {\n /** Street name and number. */\n streetAddress?: StreetAddress$a;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface StreetAddress$a {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface AddressLocation$a {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Subdivision$a {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$a;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails$5;\n }\n enum SubdivisionType$a {\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$5 {\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$5;\n }\n enum EventType$5 {\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$1;\n }\n interface EventDetails$1 {\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$7;\n /**\n * Event date and time settings.\n * @readonly\n */\n dateAndTimeSettings?: DateAndTimeSettings$2;\n /**\n * Event page URL components.\n * @readonly\n */\n eventPageUrl?: string;\n /**\n * Event status.\n * @readonly\n */\n status?: Status$8;\n }\n interface Location$7 {\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$7;\n /** Exact location address. */\n address?: CommonAddress$4;\n /** Whether the event location is TBD. */\n locationTbd?: boolean | null;\n }\n enum LocationType$7 {\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$4 extends CommonAddressStreetOneOf$4 {\n /** Street address. */\n streetAddress?: CommonStreetAddress$4;\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: CommonAddressLocation$4;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: CommonSubdivision$4[];\n }\n /** @oneof */\n interface CommonAddressStreetOneOf$4 {\n /** Street address. */\n streetAddress?: CommonStreetAddress$4;\n /** Primary address information (street and building number). */\n addressLine?: string | null;\n }\n interface CommonStreetAddress$4 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface CommonAddressLocation$4 {\n /** Address latitude coordinates. */\n latitude?: number | null;\n /** Address longitude coordinates. */\n longitude?: number | null;\n }\n interface CommonSubdivision$4 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionSubdivisionType$2;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n }\n enum SubdivisionSubdivisionType$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 DateAndTimeSettings$2 {\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$2;\n /** Event repetitions. */\n recurringEvents?: Recurrences$7;\n /** Formatted date and time settings. */\n formatted?: Formatted$2;\n }\n enum RecurrenceStatusStatus$2 {\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$7 {\n /** Individual event dates. */\n individualEventDates?: Occurrence$7[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n }\n interface Occurrence$7 {\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$2 {\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$8 {\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$1;\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$3;\n /** Invoice */\n invoice?: Invoice$2;\n }\n enum OrderStatus$3 {\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$2 {\n items?: Item$3[];\n /**\n * Total cart amount.\n * @deprecated\n */\n total?: Money$8;\n /** Discount applied to cart. */\n discount?: Discount$2;\n /** Tax applied to cart. */\n tax?: Tax$2;\n /** Total cart amount before discount, tax, and fees. */\n subTotal?: Money$8;\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$8;\n /**\n * Fees applied to the cart.\n * @readonly\n */\n fees?: Fee$2[];\n /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */\n revenue?: Money$8;\n /** URL to invoice preview. Returned only if order is paid. */\n previewUrl?: string | null;\n }\n interface Item$3 {\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$8;\n /** Total price for line items. Always equal to price * quantity. */\n total?: Money$8;\n /** Discount applied to the line item. */\n discount?: Discount$2;\n /** Tax applied to the item. */\n tax?: Tax$2;\n /**\n * Fees applied to the item.\n * @readonly\n */\n fees?: Fee$2[];\n }\n interface Money$8 {\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$2 {\n /** Total discount amount. */\n amount?: Money$8;\n /** Total charge after applied discount. */\n afterDiscount?: Money$8;\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$2[];\n }\n interface DiscountItem$2 extends DiscountItemDiscountOneOf$2 {\n /** Coupon discount. */\n coupon?: CouponDiscount$2;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount$2;\n /** Total discount amount. */\n amount?: Money$8;\n }\n /** @oneof */\n interface DiscountItemDiscountOneOf$2 {\n /** Coupon discount. */\n coupon?: CouponDiscount$2;\n /** Pricing plan discount. */\n paidPlan?: PaidPlanDiscount$2;\n }\n interface CouponDiscount$2 {\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$2 extends PaidPlanDiscountDiscountOneOf$2 {\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount$2;\n /** Name of pricing plan. */\n name?: string;\n }\n /** @oneof */\n interface PaidPlanDiscountDiscountOneOf$2 {\n /** Discount by percentage applied to tickets. */\n percentDiscount?: PercentDiscount$2;\n }\n interface PercentDiscount$2 {\n /** Percent rate. */\n rate?: string;\n /** Number of discounted tickets. */\n quantityDiscounted?: number;\n }\n interface Tax$2 {\n /** Tax type. */\n type?: TaxType$6;\n /**\n * Tax name.\n * @readonly\n */\n name?: string;\n /** Tax rate. */\n rate?: string;\n /** Taxable amount. */\n taxable?: Money$8;\n /** Total tax amount. */\n amount?: Money$8;\n }\n enum TaxType$6 {\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$2 {\n /** Fee identifier. */\n name?: FeeName$2;\n /** How fee is calculated. */\n type?: FeeType$3;\n /**\n * Fee rate.\n * @readonly\n */\n rate?: string;\n /** Total amount of fee charges. */\n amount?: Money$8;\n }\n enum FeeName$2 {\n /** Wix ticket service fee charges applied to the line item. */\n WIX_FEE = \"WIX_FEE\"\n }\n enum FeeType$3 {\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$1;\n }\n interface GuestEventStarts {\n /** Event guest. */\n guest?: EventGuest;\n /** Event context. */\n event?: EventDetails$1;\n /** Timing */\n timing?: Timing;\n }\n interface GuestOrderCanceled {\n /** Event guest. */\n guest?: EventGuest;\n /** Event context. */\n event?: EventDetails$1;\n /** Order context. */\n order?: OrderDetails;\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$9;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$9 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$9 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$9 {\n bodyAsJson?: string;\n }\n interface MessageEnvelope$d {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$d;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$d extends IdentificationDataIdOneOf$d {\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$d;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$d {\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$d {\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$8;\n /** Predefined sets of fields to return. */\n fields?: RequestedFieldsEnumRequestedFields[];\n }\n interface QueryV2$8 extends QueryV2PagingMethodOneOf$8 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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$7;\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$a[];\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$8 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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$7;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$a {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$9 {\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 /** 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$9;\n }\n interface PagingMetadataV2$9 {\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$a;\n }\n interface Cursors$a {\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$6 {\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$2 {\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 /**\n * Locale in which Rsvp was created.\n * @internal\n */\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 /** 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$5;\n /** RSVP response status. */\n status?: RsvpStatus$3;\n /** List of all guests. */\n guests?: Guest$4[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$5;\n }\n enum RsvpStatus$3 {\n YES = \"YES\",\n NO = \"NO\",\n WAITING = \"WAITING\"\n }\n interface Guest$4 {\n /** Index in the RSVP guest list. */\n index?: number;\n /** Guest full name. */\n fullName?: string;\n /** Guest check-in. */\n checkIn?: CheckIn$4;\n /** Unique guest ID per RSVP. */\n _id?: number;\n }\n interface CheckIn$4 {\n /** Time of check-in */\n created?: Date | null;\n }\n interface RsvpUpdated$2 {\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$5;\n /** RSVP response status. */\n status?: RsvpStatus$3;\n /** List of the guests. */\n guests?: Guest$4[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$5;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n }\n interface RsvpDeleted$1 {\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$2 {\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$5;\n /** Order status. */\n status?: OrderStatus$3;\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$3[];\n /** Invoice. */\n invoice?: Invoice$2;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface Ticket$3 {\n /** Unique issued ticket number. */\n ticketNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$4;\n /** Ticket price. */\n price?: Money$8;\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$5;\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$5;\n }\n interface OrderUpdated$2 {\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$5;\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$3;\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$3[];\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$1 {\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$1;\n /** Whether event was triggered by GDPR delete request. */\n triggeredByAnonymizeRequest?: boolean;\n /** Tickets generated after payment. */\n tickets?: Ticket$3[];\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 EventDeleted$5 {\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 * Event categories.\n * @internal\n */\n categories?: string[];\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$7;\n /** Requested fields. */\n fields?: RequestedFields$3[];\n }\n enum RequestedFields$3 {\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$9;\n }\n interface GuestListPreview {\n /** Event id. */\n eventId?: string;\n /** Latest attending members. */\n latestAttendingMembers?: EventGuests$1;\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$1 {\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 * @permissionId WIX_EVENTS.READ_GUESTS\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$7 {\n cursors: Cursors$a;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface GuestsQueryResult extends QueryCursorResult$7 {\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 /**\n * Returns a list of guest list summaries per event.\n * @param eventIds - Event ids.\n * @internal\n * @documentationMaturity preview\n * @requiredField eventIds\n * @permissionId WIX_EVENTS.READ_GUESTS\n * @adminMethod\n */\n function listGuestListPreviews(eventIds: string[], options?: ListGuestListPreviewsOptions): Promise;\n interface ListGuestListPreviewsOptions {\n /** Cursor paging. */\n cursorPaging?: CursorPaging$7;\n /** Requested fields. */\n fields?: RequestedFields$3[];\n }\n \n type eventsGuestsV1Guest_universal_d_EventGuest = EventGuest;\n type eventsGuestsV1Guest_universal_d_TicketGuestDetails = TicketGuestDetails;\n type eventsGuestsV1Guest_universal_d_AttendanceStatus = AttendanceStatus;\n const eventsGuestsV1Guest_universal_d_AttendanceStatus: typeof AttendanceStatus;\n type eventsGuestsV1Guest_universal_d_GuestType = GuestType;\n const eventsGuestsV1Guest_universal_d_GuestType: typeof GuestType;\n type eventsGuestsV1Guest_universal_d_GuestCountUpdated = GuestCountUpdated;\n type eventsGuestsV1Guest_universal_d_GuestCountUpdate = GuestCountUpdate;\n type eventsGuestsV1Guest_universal_d_MemberEventStatusUpdated = MemberEventStatusUpdated;\n type eventsGuestsV1Guest_universal_d_MemberEventStatusUpdatedEventType = MemberEventStatusUpdatedEventType;\n const eventsGuestsV1Guest_universal_d_MemberEventStatusUpdatedEventType: typeof MemberEventStatusUpdatedEventType;\n type eventsGuestsV1Guest_universal_d_ContactEventStatusUpdated = ContactEventStatusUpdated;\n type eventsGuestsV1Guest_universal_d_GuestCheckedIn = GuestCheckedIn;\n type eventsGuestsV1Guest_universal_d_NotifyGuestAction = NotifyGuestAction;\n type eventsGuestsV1Guest_universal_d_TaskContext = TaskContext;\n type eventsGuestsV1Guest_universal_d_NotifyActionType = NotifyActionType;\n const eventsGuestsV1Guest_universal_d_NotifyActionType: typeof NotifyActionType;\n type eventsGuestsV1Guest_universal_d_Timing = Timing;\n const eventsGuestsV1Guest_universal_d_Timing: typeof Timing;\n type eventsGuestsV1Guest_universal_d_OrderDetails = OrderDetails;\n type eventsGuestsV1Guest_universal_d_GuestEventCanceled = GuestEventCanceled;\n type eventsGuestsV1Guest_universal_d_GuestEventStarts = GuestEventStarts;\n type eventsGuestsV1Guest_universal_d_GuestOrderCanceled = GuestOrderCanceled;\n type eventsGuestsV1Guest_universal_d_QueryEventGuestsRequest = QueryEventGuestsRequest;\n type eventsGuestsV1Guest_universal_d_RequestedFieldsEnumRequestedFields = RequestedFieldsEnumRequestedFields;\n const eventsGuestsV1Guest_universal_d_RequestedFieldsEnumRequestedFields: typeof RequestedFieldsEnumRequestedFields;\n type eventsGuestsV1Guest_universal_d_QueryEventGuestsResponse = QueryEventGuestsResponse;\n type eventsGuestsV1Guest_universal_d_StreamEventGuestsRequest = StreamEventGuestsRequest;\n type eventsGuestsV1Guest_universal_d_SecondaryLanguagesRequest = SecondaryLanguagesRequest;\n type eventsGuestsV1Guest_universal_d_SecondaryLanguagesResponse = SecondaryLanguagesResponse;\n type eventsGuestsV1Guest_universal_d_Language = Language;\n type eventsGuestsV1Guest_universal_d_Task = Task;\n type eventsGuestsV1Guest_universal_d_TaskKey = TaskKey;\n type eventsGuestsV1Guest_universal_d_ListGuestListPreviewsRequest = ListGuestListPreviewsRequest;\n type eventsGuestsV1Guest_universal_d_ListGuestListPreviewsResponse = ListGuestListPreviewsResponse;\n type eventsGuestsV1Guest_universal_d_GuestListPreview = GuestListPreview;\n type eventsGuestsV1Guest_universal_d_GuestCount = GuestCount;\n type eventsGuestsV1Guest_universal_d_UpdateGuestRequest = UpdateGuestRequest;\n type eventsGuestsV1Guest_universal_d_UpdateGuestResponse = UpdateGuestResponse;\n const eventsGuestsV1Guest_universal_d_queryGuests: typeof queryGuests;\n type eventsGuestsV1Guest_universal_d_QueryEventGuestsOptions = QueryEventGuestsOptions;\n type eventsGuestsV1Guest_universal_d_GuestsQueryResult = GuestsQueryResult;\n type eventsGuestsV1Guest_universal_d_GuestsQueryBuilder = GuestsQueryBuilder;\n const eventsGuestsV1Guest_universal_d_listGuestListPreviews: typeof listGuestListPreviews;\n type eventsGuestsV1Guest_universal_d_ListGuestListPreviewsOptions = ListGuestListPreviewsOptions;\n namespace eventsGuestsV1Guest_universal_d {\n export {\n eventsGuestsV1Guest_universal_d_EventGuest as EventGuest,\n TicketDetails$2 as TicketDetails,\n eventsGuestsV1Guest_universal_d_TicketGuestDetails as TicketGuestDetails,\n OnlineConferencingLogin$5 as OnlineConferencingLogin,\n GuestDetails$2 as GuestDetails,\n FormResponse$5 as FormResponse,\n InputValue$5 as InputValue,\n FormattedAddress$5 as FormattedAddress,\n Address$a as Address,\n AddressStreetOneOf$a as AddressStreetOneOf,\n StreetAddress$a as StreetAddress,\n AddressLocation$a as AddressLocation,\n Subdivision$a as Subdivision,\n SubdivisionType$a as SubdivisionType,\n StandardDetails$5 as StandardDetails,\n eventsGuestsV1Guest_universal_d_AttendanceStatus as AttendanceStatus,\n eventsGuestsV1Guest_universal_d_GuestType as GuestType,\n eventsGuestsV1Guest_universal_d_GuestCountUpdated as GuestCountUpdated,\n eventsGuestsV1Guest_universal_d_GuestCountUpdate as GuestCountUpdate,\n eventsGuestsV1Guest_universal_d_MemberEventStatusUpdated as MemberEventStatusUpdated,\n eventsGuestsV1Guest_universal_d_MemberEventStatusUpdatedEventType as MemberEventStatusUpdatedEventType,\n eventsGuestsV1Guest_universal_d_ContactEventStatusUpdated as ContactEventStatusUpdated,\n EventType$5 as EventType,\n eventsGuestsV1Guest_universal_d_GuestCheckedIn as GuestCheckedIn,\n EventDetails$1 as EventDetails,\n Location$7 as Location,\n LocationType$7 as LocationType,\n CommonAddress$4 as CommonAddress,\n CommonAddressStreetOneOf$4 as CommonAddressStreetOneOf,\n CommonStreetAddress$4 as CommonStreetAddress,\n CommonAddressLocation$4 as CommonAddressLocation,\n CommonSubdivision$4 as CommonSubdivision,\n SubdivisionSubdivisionType$2 as SubdivisionSubdivisionType,\n DateAndTimeSettings$2 as DateAndTimeSettings,\n RecurrenceStatusStatus$2 as RecurrenceStatusStatus,\n Recurrences$7 as Recurrences,\n Occurrence$7 as Occurrence,\n Formatted$2 as Formatted,\n Status$8 as Status,\n eventsGuestsV1Guest_universal_d_NotifyGuestAction as NotifyGuestAction,\n eventsGuestsV1Guest_universal_d_TaskContext as TaskContext,\n eventsGuestsV1Guest_universal_d_NotifyActionType as NotifyActionType,\n eventsGuestsV1Guest_universal_d_Timing as Timing,\n eventsGuestsV1Guest_universal_d_OrderDetails as OrderDetails,\n OrderStatus$3 as OrderStatus,\n Invoice$2 as Invoice,\n Item$3 as Item,\n Money$8 as Money,\n Discount$2 as Discount,\n DiscountItem$2 as DiscountItem,\n DiscountItemDiscountOneOf$2 as DiscountItemDiscountOneOf,\n CouponDiscount$2 as CouponDiscount,\n PaidPlanDiscount$2 as PaidPlanDiscount,\n PaidPlanDiscountDiscountOneOf$2 as PaidPlanDiscountDiscountOneOf,\n PercentDiscount$2 as PercentDiscount,\n Tax$2 as Tax,\n TaxType$6 as TaxType,\n Fee$2 as Fee,\n FeeName$2 as FeeName,\n FeeType$3 as FeeType,\n eventsGuestsV1Guest_universal_d_GuestEventCanceled as GuestEventCanceled,\n eventsGuestsV1Guest_universal_d_GuestEventStarts as GuestEventStarts,\n eventsGuestsV1Guest_universal_d_GuestOrderCanceled as GuestOrderCanceled,\n DomainEvent$9 as DomainEvent,\n DomainEventBodyOneOf$9 as DomainEventBodyOneOf,\n EntityCreatedEvent$9 as EntityCreatedEvent,\n RestoreInfo$9 as RestoreInfo,\n EntityUpdatedEvent$9 as EntityUpdatedEvent,\n EntityDeletedEvent$9 as EntityDeletedEvent,\n ActionEvent$9 as ActionEvent,\n MessageEnvelope$d as MessageEnvelope,\n IdentificationData$d as IdentificationData,\n IdentificationDataIdOneOf$d as IdentificationDataIdOneOf,\n WebhookIdentityType$d as WebhookIdentityType,\n eventsGuestsV1Guest_universal_d_QueryEventGuestsRequest as QueryEventGuestsRequest,\n QueryV2$8 as QueryV2,\n QueryV2PagingMethodOneOf$8 as QueryV2PagingMethodOneOf,\n Sorting$a as Sorting,\n SortOrder$a as SortOrder,\n Paging$9 as Paging,\n CursorPaging$7 as CursorPaging,\n eventsGuestsV1Guest_universal_d_RequestedFieldsEnumRequestedFields as RequestedFieldsEnumRequestedFields,\n eventsGuestsV1Guest_universal_d_QueryEventGuestsResponse as QueryEventGuestsResponse,\n PagingMetadataV2$9 as PagingMetadataV2,\n Cursors$a as Cursors,\n eventsGuestsV1Guest_universal_d_StreamEventGuestsRequest as StreamEventGuestsRequest,\n Empty$6 as Empty,\n eventsGuestsV1Guest_universal_d_SecondaryLanguagesRequest as SecondaryLanguagesRequest,\n eventsGuestsV1Guest_universal_d_SecondaryLanguagesResponse as SecondaryLanguagesResponse,\n eventsGuestsV1Guest_universal_d_Language as Language,\n RsvpCreated$2 as RsvpCreated,\n RsvpStatus$3 as RsvpStatus,\n Guest$4 as Guest,\n CheckIn$4 as CheckIn,\n RsvpUpdated$2 as RsvpUpdated,\n RsvpDeleted$1 as RsvpDeleted,\n OrderConfirmed$2 as OrderConfirmed,\n Ticket$3 as Ticket,\n OrderUpdated$2 as OrderUpdated,\n OrderDeleted$1 as OrderDeleted,\n OrderType$1 as OrderType,\n EventDeleted$5 as EventDeleted,\n eventsGuestsV1Guest_universal_d_Task as Task,\n eventsGuestsV1Guest_universal_d_TaskKey as TaskKey,\n eventsGuestsV1Guest_universal_d_ListGuestListPreviewsRequest as ListGuestListPreviewsRequest,\n RequestedFields$3 as RequestedFields,\n eventsGuestsV1Guest_universal_d_ListGuestListPreviewsResponse as ListGuestListPreviewsResponse,\n eventsGuestsV1Guest_universal_d_GuestListPreview as GuestListPreview,\n EventGuests$1 as EventGuests,\n eventsGuestsV1Guest_universal_d_GuestCount as GuestCount,\n eventsGuestsV1Guest_universal_d_UpdateGuestRequest as UpdateGuestRequest,\n eventsGuestsV1Guest_universal_d_UpdateGuestResponse as UpdateGuestResponse,\n eventsGuestsV1Guest_universal_d_queryGuests as queryGuests,\n eventsGuestsV1Guest_universal_d_QueryEventGuestsOptions as QueryEventGuestsOptions,\n eventsGuestsV1Guest_universal_d_GuestsQueryResult as GuestsQueryResult,\n eventsGuestsV1Guest_universal_d_GuestsQueryBuilder as GuestsQueryBuilder,\n eventsGuestsV1Guest_universal_d_listGuestListPreviews as listGuestListPreviews,\n eventsGuestsV1Guest_universal_d_ListGuestListPreviewsOptions as ListGuestListPreviewsOptions,\n };\n }\n \n interface NotificationConfig {\n /** Event ID. */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */\n revision?: string | null;\n /**\n * Represents the time this NotificationConfig was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this NotificationConfig was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Rsvp confirmation. */\n rsvpConfirmation?: EmailNotificationConfig;\n /** New spots available. */\n newSpotsAvailable?: EmailNotificationConfig;\n /** Event cancelation. */\n eventCancelation?: EmailNotificationConfig;\n /** Event reminder. */\n upcomingEventReminder?: EmailNotificationConfig;\n /** Order confirmation. */\n orderConfirmation?: EmailNotificationConfig;\n /** Ticket confirmation. */\n ticketConfirmation?: EmailNotificationConfig;\n /** Invoice. */\n invoice?: EmailNotificationConfig;\n /** Order confirmation with tickets link. */\n orderConfirmationWithTicketsLink?: EmailNotificationConfig;\n }\n interface EmailNotificationConfig {\n /**\n * Predefined id of the notification type.\n * @readonly\n */\n notificationType?: EmailNotificationType;\n /** Email template values. */\n template?: EmailTemplate;\n /**\n * Desired timing of the notification in hours respectfully to event start time.\n * For example if value is 0 then notification is sent at the start of the event.\n */\n reminderTime?: EmailNotificationReminderTime;\n /** When true the notification will be sent when certain trigger occurs. */\n sendingEnabled?: boolean | null;\n }\n enum EmailNotificationType {\n /** Default value. This value is unused. */\n UNKNOWN_NOTIFICATION_TYPE = \"UNKNOWN_NOTIFICATION_TYPE\",\n /** Triggered when site user RSVP to the event. */\n EMAIL_RSVP_CONFIRMATION = \"EMAIL_RSVP_CONFIRMATION\",\n /** Triggered for waiting guests when additional RSVP spots appears in the fully booked event. */\n EMAIL_NEW_SPOTS_AVAILABLE = \"EMAIL_NEW_SPOTS_AVAILABLE\",\n /** Triggered when event is canceled. */\n EMAIL_EVENT_CANCELATION = \"EMAIL_EVENT_CANCELATION\",\n /** Triggered before the event start time. */\n EMAIL_UPCOMING_EVENT_REMINDER = \"EMAIL_UPCOMING_EVENT_REMINDER\",\n /** Triggered when site user creates Order. */\n EMAIL_ORDER_CONFIRMATION = \"EMAIL_ORDER_CONFIRMATION\",\n /** Triggered when resending ticket to ticket holder. */\n EMAIL_TICKET_CONFIRMATION = \"EMAIL_TICKET_CONFIRMATION\",\n /** Triggered when sending invoice. Currently only `enabled` flag update is supported. */\n EMAIL_INVOICE = \"EMAIL_INVOICE\",\n /** Triggered when order confirmation sending is delayed. Tickets are accessible via link. */\n EMAIL_ORDER_CONFIRMATION_WITH_TICKETS_LINK = \"EMAIL_ORDER_CONFIRMATION_WITH_TICKETS_LINK\"\n }\n interface EmailTemplate {\n /** Email subject. */\n subject?: string | null;\n /** Plain text message body. */\n body?: string | null;\n /** Description link visibility and display text */\n descriptionLink?: Link$1;\n /** Calendar link visibility and display text */\n calendarLink?: Link$1;\n /** Online conferencing link visibility and display text */\n onlineConferencingLink?: Link$1;\n /** When true the tickets are attached to the order confirmation email. */\n includeTickets?: boolean | null;\n }\n interface Link$1 {\n /** When true the link is added to the email. */\n display?: boolean | null;\n /** Text of the link. */\n linkText?: string | null;\n }\n enum EmailNotificationReminderTime {\n /** Default value. This value is unused. */\n UNKNOWN_REMINDER_TIME = \"UNKNOWN_REMINDER_TIME\",\n /** Notification is sent instantly */\n INSTANT = \"INSTANT\",\n /** 24 hours prior */\n BEFORE_1_DAY = \"BEFORE_1_DAY\",\n /** 3 days prior */\n BEFORE_3_DAYS = \"BEFORE_3_DAYS\",\n /** 7 days prior */\n BEFORE_1_WEEK = \"BEFORE_1_WEEK\",\n /** 1 hour prior */\n BEFORE_1_HOUR = \"BEFORE_1_HOUR\",\n /** 30 minutes prior */\n BEFORE_30_MINUTES = \"BEFORE_30_MINUTES\"\n }\n interface TriggerNotificationRequest extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {\n /** Email notification type */\n emailNotificationType?: EmailNotificationType;\n /** Push notification type */\n pushNotificationType?: PushNotificationType;\n /** Rsvp guest info */\n rsvpGuest?: RsvpGuest;\n /** Order guest info */\n orderGuest?: OrderGuest;\n /** Event guests info */\n eventGuests?: EventGuests;\n /** Ticket guests info */\n ticketGuest?: TicketGuest;\n }\n /** @oneof */\n interface TriggerNotificationRequestNotificationOneOf {\n /** Email notification type */\n emailNotificationType?: EmailNotificationType;\n /** Push notification type */\n pushNotificationType?: PushNotificationType;\n }\n /** @oneof */\n interface TriggerNotificationRequestGuestsOneOf {\n /** Rsvp guest info */\n rsvpGuest?: RsvpGuest;\n /** Order guest info */\n orderGuest?: OrderGuest;\n /** Event guests info */\n eventGuests?: EventGuests;\n /** Ticket guests info */\n ticketGuest?: TicketGuest;\n }\n enum PushNotificationType {\n /** This is default value. This value is unused. */\n UNKNOWN_PUSH_TYPE = \"UNKNOWN_PUSH_TYPE\",\n /** Triggered when event is updated. */\n PUSH_EVENT_UPDATED = \"PUSH_EVENT_UPDATED\",\n /** Triggered when event is canceled. */\n PUSH_EVENT_CANCELATION = \"PUSH_EVENT_CANCELATION\",\n /** Triggered before the event start time. */\n PUSH_UPCOMING_EVENT_REMINDER = \"PUSH_UPCOMING_EVENT_REMINDER\",\n /** Triggered when event is created. */\n PUSH_EVENT_CREATED = \"PUSH_EVENT_CREATED\"\n }\n /** Single guest associated to the RSVP */\n interface RsvpGuest {\n /** Event id */\n eventId?: string;\n /** Rsvp id */\n rsvpId?: string;\n }\n /** Single guest associated to the Order */\n interface OrderGuest {\n /** Event id */\n eventId?: string;\n /** Order number */\n orderNumber?: string;\n }\n /** All event guest from RSVPs and Orders */\n interface EventGuests {\n /** Event id */\n eventId?: string;\n }\n /** Multiple guests associated to Tickets */\n interface TicketGuest {\n /** Event id */\n eventId?: string;\n /** Order number */\n orderNumber?: string | null;\n /** Ticket numbers must be from the same order only. */\n ticketNumber?: string[];\n }\n interface TriggerNotificationResponse {\n }\n interface RsvpCreated$1 {\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 /**\n * Locale in which Rsvp was created.\n * @internal\n */\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 /** 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$4;\n /** RSVP response status. */\n status?: RsvpStatus$2;\n /** List of all guests. */\n guests?: Guest$3[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$4;\n }\n interface FormResponse$4 {\n inputValues?: InputValue$4[];\n }\n interface InputValue$4 {\n inputName?: string;\n value?: string;\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date | null;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress$4;\n }\n interface FormattedAddress$4 {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: CommonAddress$3;\n }\n /** Physical address */\n interface CommonAddress$3 extends CommonAddressStreetOneOf$3 {\n /** Street name and number. */\n streetAddress?: CommonStreetAddress$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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: CommonAddressLocation$3;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: CommonSubdivision$3[];\n }\n /** @oneof */\n interface CommonAddressStreetOneOf$3 {\n /** Street name and number. */\n streetAddress?: CommonStreetAddress$3;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface CommonStreetAddress$3 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface CommonAddressLocation$3 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface CommonSubdivision$3 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$9;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails$4;\n }\n enum SubdivisionType$9 {\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$4 {\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$2 {\n YES = \"YES\",\n NO = \"NO\",\n WAITING = \"WAITING\"\n }\n interface Guest$3 {\n /** Index in the RSVP guest list. */\n index?: number;\n /** Guest full name. */\n fullName?: string;\n /** Guest check-in. */\n checkIn?: CheckIn$3;\n /** Unique guest ID per RSVP. */\n _id?: number;\n }\n interface CheckIn$3 {\n /** Time of check-in */\n created?: Date | null;\n }\n interface OnlineConferencingLogin$4 {\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 Empty$5 {\n }\n interface RsvpUpdated$1 {\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$4;\n /** RSVP response status. */\n status?: RsvpStatus$2;\n /** List of the guests. */\n guests?: Guest$3[];\n /** URL and password to online conference */\n onlineConferencingLogin?: OnlineConferencingLogin$4;\n /** Notifications silenced for this domain event. */\n silent?: boolean | null;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$8;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$8 {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$8 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$8 {\n bodyAsJson?: string;\n }\n interface EventUpdated$3 {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$6;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$6;\n /** Event title. */\n title?: string;\n /**\n * Whether schedule configuration was updated.\n * @deprecated\n */\n scheduleConfigUpdated?: boolean;\n /**\n * The set of properties which were updated. For example 'title' or 'location'\n * @internal\n */\n fields?: string[];\n /**\n * Whether event has opened new spots with this update.\n * @internal\n */\n newSpotsOpened?: boolean | null;\n /** Updated event */\n event?: Event$4;\n }\n interface Location$6 {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates$6;\n /** Single line address representation. */\n address?: string | null;\n /** Location type. */\n type?: LocationType$6;\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$9;\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$6 {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationType$6 {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$9 extends AddressStreetOneOf$9 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$9;\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$9;\n /** country full-name */\n countryFullname?: string | null;\n /** multi-level subdivisions from top to bottom */\n subdivisions?: Subdivision$9[];\n }\n /** @oneof */\n interface AddressStreetOneOf$9 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$9;\n /** Main address line (usually street and number) as free text */\n addressLine?: string | null;\n }\n interface StreetAddress$9 {\n /** street number */\n number?: string;\n /** street name */\n name?: string;\n /**\n * apartment number\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation$9 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$9 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n /**\n * subdivision level\n * @internal\n */\n type?: SubdivisionType$9;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\n }\n interface ScheduleConfig$6 {\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$6;\n }\n interface Recurrences$6 {\n /** Event occurrences. */\n occurrences?: Occurrence$6[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status$7;\n }\n interface Occurrence$6 {\n /** Event start timestamp. */\n startDate?: Date | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$7 {\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$4 {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location$6;\n /** Event scheduling. */\n scheduling?: Scheduling$4;\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 | null;\n /** Event modified timestamp. */\n modified?: Date | null;\n /** Event status. */\n status?: EventStatus$6;\n /** RSVP or ticketing registration details. */\n registration?: Registration$4;\n /** \"Add to calendar\" URLs. */\n calendarLinks?: CalendarLinks$6;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl$4;\n /** Event registration form. */\n form?: Form$4;\n /** Event dashboard summary of RSVP / ticket sales. */\n dashboard?: Dashboard$6;\n /** Instance ID of the site where event is hosted. */\n instanceId?: string;\n /** Guest list configuration. */\n guestListConfig?: GuestListConfig$4;\n /** Event creator user ID. */\n userId?: string;\n /** Event discussion feed. For internal use. */\n feed?: Feed$4;\n /** Online conferencing details. */\n onlineConferencing?: OnlineConferencing$4;\n /** SEO settings. */\n seoSettings?: SeoSettings$4;\n /** Assigned contacts label key. */\n assignedContactsLabel?: string | null;\n /** Agenda details. */\n agenda?: Agenda$4;\n /** Categories this event is assigned to. */\n categories?: Category$5[];\n /** Visual settings for event. */\n eventDisplaySettings?: EventDisplaySettings$4;\n /**\n * @internal\n * @readonly\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: LabellingSettings$4;\n }\n interface Scheduling$4 {\n /** Schedule configuration. */\n config?: ScheduleConfig$6;\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$6 {\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$4 {\n /** Event type. */\n type?: EventType$4;\n /** Event registration status. */\n status?: RegistrationStatus$4;\n /** RSVP collection details. */\n rsvpCollection?: RsvpCollection$4;\n /** Ticketing details. */\n ticketing?: Ticketing$4;\n /** External registration details. */\n external?: ExternalEvent$4;\n /** Types of users allowed to register. */\n restrictedTo?: VisitorType$4;\n /** Initial event type which was set when creating an event. */\n initialType?: EventType$4;\n }\n enum EventType$4 {\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$4 {\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$4 {\n /** RSVP collection configuration. */\n config?: RsvpCollectionConfig$4;\n }\n interface RsvpCollectionConfig$4 {\n /** Defines the supported RSVP statuses. */\n rsvpStatusOptions?: RsvpStatusOptions$4;\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 | null;\n /** Registration end timestamp. */\n endDate?: Date | null;\n }\n enum RsvpStatusOptions$4 {\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$4 {\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$4;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: Money$7;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: Money$7;\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$4 {\n /** Whether the form must be filled out separately for each ticket. */\n guestAssignedTickets?: boolean;\n /** Tax configuration. */\n taxConfig?: TaxConfig$4;\n /** Limit of tickets that can be purchased per order, default 20. */\n ticketLimitPerOrder?: number;\n /**\n * App Id for external ticket stock management.\n * By default tickets stock is defined in TicketDefinition object.\n * If defined then limitation from TicketDefinition is ignored.\n * @internal\n */\n stockManagerAppId?: string | null;\n /** Duration for which the tickets being bought are reserved. */\n reservationDurationInMinutes?: number | null;\n }\n interface TaxConfig$4 {\n /** Tax application settings. */\n type?: TaxType$5;\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$5 {\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$7 {\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 ExternalEvent$4 {\n /** External event registration URL. */\n registration?: string;\n }\n enum VisitorType$4 {\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$6 {\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$4 {\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$4 {\n /** Nested fields as an ordered list. */\n controls?: InputControl$4[];\n /** Set of configured form messages. */\n messages?: FormMessages$4;\n }\n /**\n * A block of nested fields.\n * Used to aggregate similar inputs like First Name and Last Name.\n */\n interface InputControl$4 {\n /** Field control type. */\n type?: InputControlType$4;\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$4[];\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$4 {\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$4 {\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$4;\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$4;\n /**\n * Additional labels for multi-valued fields such as address.\n * @readonly\n */\n labels?: Label$4[];\n }\n enum ValueType$4 {\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$4 extends OptionSelectionSelectedOptionOneOf$4 {\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$4 {\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$4 {\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$4 {\n /** RSVP form messages. */\n rsvp?: RsvpFormMessages$4;\n /** Checkout form messages. */\n checkout?: CheckoutFormMessages$4;\n /** Messages shown when event registration is closed. */\n registrationClosed?: RegistrationClosedMessages$4;\n /** Messages shown when event tickets are unavailable. */\n ticketsUnavailable?: TicketsUnavailableMessages$4;\n }\n interface RsvpFormMessages$4 {\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$4;\n /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */\n waitlistMessages?: Positive$4;\n /** Messages shown for RSVP = `NO`. */\n negativeMessages?: Negative$4;\n /** \"Submit form\" call-to-action label text. */\n submitActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface PositiveResponseConfirmation$4 {\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$4 {\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$4 {\n /** Main form title for positive response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: PositiveResponseConfirmation$4;\n }\n /** A set of messages shown during registration with negative response */\n interface Negative$4 {\n /** Main form title for negative response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: NegativeResponseConfirmation$4;\n }\n interface CheckoutFormMessages$4 {\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$4;\n }\n /** Confirmation messages shown after checkout. */\n interface ResponseConfirmation$4 {\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$4 {\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$4 {\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$6 {\n /** Guest RSVP summary. */\n rsvpSummary?: RsvpSummary$5;\n /**\n * Summary of revenue and tickets sold.\n * (Archived orders are not included).\n */\n ticketingSummary?: TicketingSummary$4;\n }\n interface RsvpSummary$5 {\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$4 {\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$7;\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$7;\n }\n interface GuestListConfig$4 {\n /** Whether members can see other members attending the event (defaults to true). */\n publicGuestList?: boolean;\n }\n interface Feed$4 {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing$4 {\n config?: OnlineConferencingConfig$4;\n session?: OnlineConferencingSession$4;\n /**\n * Configured conferencing provider name.\n * @internal\n * @readonly\n */\n providerName?: string;\n }\n interface OnlineConferencingConfig$4 {\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$4;\n }\n enum ConferenceType$4 {\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$4 {\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$4 {\n /** URL slug */\n slug?: string;\n /** Advanced SEO data */\n advancedSeoData?: SeoSchema$4;\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$4 {\n /** SEO tag information. */\n tags?: Tag$4[];\n /** SEO general settings. */\n settings?: Settings$5;\n }\n interface Keyword$4 {\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$4 {\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$5 {\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$4[];\n }\n interface Agenda$4 {\n /** Whether the schedule is enabled for the event. */\n enabled?: boolean;\n /**\n * Agenda page URL.\n * @readonly\n */\n pageUrl?: SiteUrl$4;\n }\n interface Category$5 {\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 | null;\n /**\n * Assigned events count. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$5;\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$8[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\n }\n interface CategoryCounts$5 {\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$8 {\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$4 {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */\n hideEventDetailsPage?: boolean | null;\n }\n interface LabellingSettings$4 {\n /**\n * @internal\n * @readonly\n */\n assignedContactsLegacyLabelId?: string | null;\n /**\n * @internal\n * @readonly\n */\n assignedContactsLabelDeleted?: boolean | null;\n }\n interface OrderConfirmed$1 {\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$4;\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 /** Invoice. */\n invoice?: Invoice$1;\n /** Reservation ID associated with this order. */\n reservationId?: string;\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 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 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$7;\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$4;\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$4;\n }\n interface Invoice$1 {\n items?: Item$2[];\n /**\n * Total cart amount.\n * @deprecated\n */\n total?: Money$7;\n /** Discount applied to 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$7;\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$7;\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$7;\n /** URL to invoice preview. Returned only if order is paid. */\n previewUrl?: string | null;\n }\n interface Item$2 {\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$7;\n /** Total price for line items. Always equal to price * quantity. */\n total?: Money$7;\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$7;\n /** Total charge after applied discount. */\n afterDiscount?: Money$7;\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$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$7;\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$5;\n /**\n * Tax name.\n * @readonly\n */\n name?: string;\n /** Tax rate. */\n rate?: string;\n /** Taxable amount. */\n taxable?: Money$7;\n /** Total tax amount. */\n amount?: Money$7;\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$7;\n }\n enum FeeName$1 {\n /** Wix ticket 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 /** Produced if a buyer email was added to the existing order */\n interface OrderEmailAdded {\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 /** Notifications silenced for this domain event. */\n silent?: boolean | null;\n /** Event ID. */\n eventId?: string;\n /** Unique order number. */\n orderNumber?: string;\n /** Contact ID associated with this order. */\n contactId?: string | null;\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 | null;\n /** Buyer last name. */\n lastName?: string | null;\n /** Buyer email. */\n email?: string | null;\n /** Checkout form response. */\n checkoutForm?: FormResponse$4;\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 /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface EventCanceled$2 {\n /** Event canceled 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 EventReminder$1 {\n /** Reminder timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$6;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$6;\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$1;\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$1 {\n /** Number of days. */\n days?: number;\n /** Number of hours. */\n hours?: number;\n /** Number of minutes. */\n minutes?: number;\n }\n interface OrderPaid$1 {\n /** Order paid 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 /** 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 | 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$4;\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 /** Invoice. */\n invoice?: Invoice$1;\n }\n interface TicketPdfResolved {\n /** Optional order number */\n orderNumber?: string | null;\n /** Optional ticket number */\n ticketNumber?: string | null;\n /** Resolved download url */\n downloadUrl?: string | null;\n /** Resolve status */\n resolveFailed?: boolean | null;\n /** Papyrus document id */\n documentId?: string | null;\n }\n interface TicketPdfResolveDelayed {\n /** Optional order number */\n orderNumber?: string | null;\n /** Optional ticket number */\n ticketNumber?: string | null;\n /** Papyrus document id */\n documentId?: string | null;\n }\n interface OrderCanceled {\n /** Event ID. */\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 /** Buyer first name. */\n firstName?: string | null;\n /** Buyer last name. */\n lastName?: string | null;\n /** Buyer email address. */\n email?: string | null;\n /** Checkout form response. */\n checkoutForm?: FormResponse$4;\n /** Invoice. */\n invoice?: Invoice$1;\n }\n interface EventEnded$2 {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface EventStarted$1 {\n /** Event start timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface ResolveNotificationConfigRequest {\n /** Id of the NotificationConfig to retrieve */\n notificationConfigId: string;\n }\n interface ResolveNotificationConfigResponse {\n /** The retrieved NotificationConfig */\n notificationConfig?: NotificationConfig;\n }\n interface UpsertNotificationConfigRequest {\n /** NotificationConfig to be upserted */\n notificationConfig: NotificationConfig;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpsertNotificationConfigResponse {\n /** The upserted NotificationConfig */\n notificationConfig?: NotificationConfig;\n }\n interface ResolveEmailNotificationConfigRequest {\n /** Id of the NotificationConfig to retrieve */\n notificationConfigId?: string;\n /** Notification type */\n notificationType?: EmailNotificationType;\n }\n interface ResolveEmailNotificationConfigResponse {\n /** The retrieved EmailNotificationConfig */\n emailNotificationConfig?: EmailNotificationConfig;\n }\n interface EventDeleted$4 {\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 * Event categories.\n * @internal\n */\n categories?: string[];\n }\n interface EventCopied$3 {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$6;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$6;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus$6;\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 MessageEnvelope$c {\n /** App instance ID. */\n instanceId?: string | null;\n /** Event type. */\n eventType?: string;\n /** The identification type and identity data. */\n identity?: IdentificationData$c;\n /** Stringify payload. */\n data?: string;\n }\n interface IdentificationData$c extends IdentificationDataIdOneOf$c {\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$c;\n }\n /** @oneof */\n interface IdentificationDataIdOneOf$c {\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$c {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Triggers notification\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.MANAGE\n * @adminMethod\n */\n function triggerNotification(options?: TriggerNotificationOptions): Promise;\n interface TriggerNotificationOptions extends TriggerNotificationRequestNotificationOneOf, TriggerNotificationRequestGuestsOneOf {\n /** Email notification type */\n emailNotificationType?: EmailNotificationType;\n /** Push notification type */\n pushNotificationType?: PushNotificationType;\n /** Rsvp guest info */\n rsvpGuest?: RsvpGuest;\n /** Order guest info */\n orderGuest?: OrderGuest;\n /** Event guests info */\n eventGuests?: EventGuests;\n /** Ticket guests info */\n ticketGuest?: TicketGuest;\n }\n /**\n * Resolves a NotificationConfig by id. Returns saved value or default value if not saved yet.\n * @param notificationConfigId - Id of the NotificationConfig to retrieve\n * @public\n * @documentationMaturity preview\n * @requiredField notificationConfigId\n * @permissionId WIX_EVENTS.READ_NOTIFICATION_CONFIG\n * @adminMethod\n */\n function resolveNotificationConfig(notificationConfigId: string): Promise;\n /**\n * Upsert a NotificationConfig\n * @param _id - Event ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField notificationConfig\n * @permissionId WIX_EVENTS.UPDATE_NOTIFICATION_CONFIG\n * @adminMethod\n */\n function upsertNotificationConfig(_id: string | null, notificationConfig: UpsertNotificationConfig, options?: UpsertNotificationConfigOptions): Promise;\n interface UpsertNotificationConfig {\n /** Event ID. */\n _id?: string | null;\n /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */\n revision?: string | null;\n /**\n * Represents the time this NotificationConfig was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this NotificationConfig was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Rsvp confirmation. */\n rsvpConfirmation?: EmailNotificationConfig;\n /** New spots available. */\n newSpotsAvailable?: EmailNotificationConfig;\n /** Event cancelation. */\n eventCancelation?: EmailNotificationConfig;\n /** Event reminder. */\n upcomingEventReminder?: EmailNotificationConfig;\n /** Order confirmation. */\n orderConfirmation?: EmailNotificationConfig;\n /** Ticket confirmation. */\n ticketConfirmation?: EmailNotificationConfig;\n /** Invoice. */\n invoice?: EmailNotificationConfig;\n /** Order confirmation with tickets link. */\n orderConfirmationWithTicketsLink?: EmailNotificationConfig;\n }\n interface UpsertNotificationConfigOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n \n type eventsNotificationsV2NotificationConfig_universal_d_NotificationConfig = NotificationConfig;\n type eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationConfig = EmailNotificationConfig;\n type eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationType = EmailNotificationType;\n const eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationType: typeof EmailNotificationType;\n type eventsNotificationsV2NotificationConfig_universal_d_EmailTemplate = EmailTemplate;\n type eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationReminderTime = EmailNotificationReminderTime;\n const eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationReminderTime: typeof EmailNotificationReminderTime;\n type eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationRequest = TriggerNotificationRequest;\n type eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationRequestNotificationOneOf = TriggerNotificationRequestNotificationOneOf;\n type eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationRequestGuestsOneOf = TriggerNotificationRequestGuestsOneOf;\n type eventsNotificationsV2NotificationConfig_universal_d_PushNotificationType = PushNotificationType;\n const eventsNotificationsV2NotificationConfig_universal_d_PushNotificationType: typeof PushNotificationType;\n type eventsNotificationsV2NotificationConfig_universal_d_RsvpGuest = RsvpGuest;\n type eventsNotificationsV2NotificationConfig_universal_d_OrderGuest = OrderGuest;\n type eventsNotificationsV2NotificationConfig_universal_d_EventGuests = EventGuests;\n type eventsNotificationsV2NotificationConfig_universal_d_TicketGuest = TicketGuest;\n type eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationResponse = TriggerNotificationResponse;\n type eventsNotificationsV2NotificationConfig_universal_d_OrderEmailAdded = OrderEmailAdded;\n type eventsNotificationsV2NotificationConfig_universal_d_TicketPdfResolved = TicketPdfResolved;\n type eventsNotificationsV2NotificationConfig_universal_d_TicketPdfResolveDelayed = TicketPdfResolveDelayed;\n type eventsNotificationsV2NotificationConfig_universal_d_OrderCanceled = OrderCanceled;\n type eventsNotificationsV2NotificationConfig_universal_d_ResolveNotificationConfigRequest = ResolveNotificationConfigRequest;\n type eventsNotificationsV2NotificationConfig_universal_d_ResolveNotificationConfigResponse = ResolveNotificationConfigResponse;\n type eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfigRequest = UpsertNotificationConfigRequest;\n type eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfigResponse = UpsertNotificationConfigResponse;\n type eventsNotificationsV2NotificationConfig_universal_d_ResolveEmailNotificationConfigRequest = ResolveEmailNotificationConfigRequest;\n type eventsNotificationsV2NotificationConfig_universal_d_ResolveEmailNotificationConfigResponse = ResolveEmailNotificationConfigResponse;\n const eventsNotificationsV2NotificationConfig_universal_d_triggerNotification: typeof triggerNotification;\n type eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationOptions = TriggerNotificationOptions;\n const eventsNotificationsV2NotificationConfig_universal_d_resolveNotificationConfig: typeof resolveNotificationConfig;\n const eventsNotificationsV2NotificationConfig_universal_d_upsertNotificationConfig: typeof upsertNotificationConfig;\n type eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfig = UpsertNotificationConfig;\n type eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfigOptions = UpsertNotificationConfigOptions;\n namespace eventsNotificationsV2NotificationConfig_universal_d {\n export {\n eventsNotificationsV2NotificationConfig_universal_d_NotificationConfig as NotificationConfig,\n eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationConfig as EmailNotificationConfig,\n eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationType as EmailNotificationType,\n eventsNotificationsV2NotificationConfig_universal_d_EmailTemplate as EmailTemplate,\n Link$1 as Link,\n eventsNotificationsV2NotificationConfig_universal_d_EmailNotificationReminderTime as EmailNotificationReminderTime,\n eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationRequest as TriggerNotificationRequest,\n eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationRequestNotificationOneOf as TriggerNotificationRequestNotificationOneOf,\n eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationRequestGuestsOneOf as TriggerNotificationRequestGuestsOneOf,\n eventsNotificationsV2NotificationConfig_universal_d_PushNotificationType as PushNotificationType,\n eventsNotificationsV2NotificationConfig_universal_d_RsvpGuest as RsvpGuest,\n eventsNotificationsV2NotificationConfig_universal_d_OrderGuest as OrderGuest,\n eventsNotificationsV2NotificationConfig_universal_d_EventGuests as EventGuests,\n eventsNotificationsV2NotificationConfig_universal_d_TicketGuest as TicketGuest,\n eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationResponse as TriggerNotificationResponse,\n RsvpCreated$1 as RsvpCreated,\n FormResponse$4 as FormResponse,\n InputValue$4 as InputValue,\n FormattedAddress$4 as FormattedAddress,\n CommonAddress$3 as CommonAddress,\n CommonAddressStreetOneOf$3 as CommonAddressStreetOneOf,\n CommonStreetAddress$3 as CommonStreetAddress,\n CommonAddressLocation$3 as CommonAddressLocation,\n CommonSubdivision$3 as CommonSubdivision,\n SubdivisionType$9 as SubdivisionType,\n StandardDetails$4 as StandardDetails,\n RsvpStatus$2 as RsvpStatus,\n Guest$3 as Guest,\n CheckIn$3 as CheckIn,\n OnlineConferencingLogin$4 as OnlineConferencingLogin,\n Empty$5 as Empty,\n RsvpUpdated$1 as RsvpUpdated,\n DomainEvent$8 as DomainEvent,\n DomainEventBodyOneOf$8 as DomainEventBodyOneOf,\n EntityCreatedEvent$8 as EntityCreatedEvent,\n RestoreInfo$8 as RestoreInfo,\n EntityUpdatedEvent$8 as EntityUpdatedEvent,\n EntityDeletedEvent$8 as EntityDeletedEvent,\n ActionEvent$8 as ActionEvent,\n EventUpdated$3 as EventUpdated,\n Location$6 as Location,\n MapCoordinates$6 as MapCoordinates,\n LocationType$6 as LocationType,\n Address$9 as Address,\n AddressStreetOneOf$9 as AddressStreetOneOf,\n StreetAddress$9 as StreetAddress,\n AddressLocation$9 as AddressLocation,\n Subdivision$9 as Subdivision,\n ScheduleConfig$6 as ScheduleConfig,\n Recurrences$6 as Recurrences,\n Occurrence$6 as Occurrence,\n Status$7 as Status,\n Event$4 as Event,\n Scheduling$4 as Scheduling,\n EventStatus$6 as EventStatus,\n Registration$4 as Registration,\n EventType$4 as EventType,\n RegistrationStatus$4 as RegistrationStatus,\n RsvpCollection$4 as RsvpCollection,\n RsvpCollectionConfig$4 as RsvpCollectionConfig,\n RsvpStatusOptions$4 as RsvpStatusOptions,\n Ticketing$4 as Ticketing,\n TicketingConfig$4 as TicketingConfig,\n TaxConfig$4 as TaxConfig,\n TaxType$5 as TaxType,\n Money$7 as Money,\n ExternalEvent$4 as ExternalEvent,\n VisitorType$4 as VisitorType,\n CalendarLinks$6 as CalendarLinks,\n SiteUrl$4 as SiteUrl,\n Form$4 as Form,\n InputControl$4 as InputControl,\n InputControlType$4 as InputControlType,\n Input$4 as Input,\n ValueType$4 as ValueType,\n OptionSelection$4 as OptionSelection,\n OptionSelectionSelectedOptionOneOf$4 as OptionSelectionSelectedOptionOneOf,\n Label$4 as Label,\n FormMessages$4 as FormMessages,\n RsvpFormMessages$4 as RsvpFormMessages,\n PositiveResponseConfirmation$4 as PositiveResponseConfirmation,\n NegativeResponseConfirmation$4 as NegativeResponseConfirmation,\n Positive$4 as Positive,\n Negative$4 as Negative,\n CheckoutFormMessages$4 as CheckoutFormMessages,\n ResponseConfirmation$4 as ResponseConfirmation,\n RegistrationClosedMessages$4 as RegistrationClosedMessages,\n TicketsUnavailableMessages$4 as TicketsUnavailableMessages,\n Dashboard$6 as Dashboard,\n RsvpSummary$5 as RsvpSummary,\n TicketingSummary$4 as TicketingSummary,\n GuestListConfig$4 as GuestListConfig,\n Feed$4 as Feed,\n OnlineConferencing$4 as OnlineConferencing,\n OnlineConferencingConfig$4 as OnlineConferencingConfig,\n ConferenceType$4 as ConferenceType,\n OnlineConferencingSession$4 as OnlineConferencingSession,\n SeoSettings$4 as SeoSettings,\n SeoSchema$4 as SeoSchema,\n Keyword$4 as Keyword,\n Tag$4 as Tag,\n Settings$5 as Settings,\n Agenda$4 as Agenda,\n Category$5 as Category,\n CategoryCounts$5 as CategoryCounts,\n State$8 as State,\n EventDisplaySettings$4 as EventDisplaySettings,\n LabellingSettings$4 as LabellingSettings,\n OrderConfirmed$1 as OrderConfirmed,\n OrderStatus$2 as OrderStatus,\n Ticket$2 as Ticket,\n Invoice$1 as Invoice,\n Item$2 as Item,\n Discount$1 as Discount,\n DiscountItem$1 as DiscountItem,\n DiscountItemDiscountOneOf$1 as DiscountItemDiscountOneOf,\n CouponDiscount$1 as CouponDiscount,\n PaidPlanDiscount$1 as PaidPlanDiscount,\n PaidPlanDiscountDiscountOneOf$1 as PaidPlanDiscountDiscountOneOf,\n PercentDiscount$1 as PercentDiscount,\n Tax$1 as Tax,\n Fee$1 as Fee,\n FeeName$1 as FeeName,\n FeeType$2 as FeeType,\n eventsNotificationsV2NotificationConfig_universal_d_OrderEmailAdded as OrderEmailAdded,\n EventCanceled$2 as EventCanceled,\n EventReminder$1 as EventReminder,\n TimeDuration$1 as TimeDuration,\n OrderPaid$1 as OrderPaid,\n eventsNotificationsV2NotificationConfig_universal_d_TicketPdfResolved as TicketPdfResolved,\n eventsNotificationsV2NotificationConfig_universal_d_TicketPdfResolveDelayed as TicketPdfResolveDelayed,\n eventsNotificationsV2NotificationConfig_universal_d_OrderCanceled as OrderCanceled,\n EventEnded$2 as EventEnded,\n EventStarted$1 as EventStarted,\n eventsNotificationsV2NotificationConfig_universal_d_ResolveNotificationConfigRequest as ResolveNotificationConfigRequest,\n eventsNotificationsV2NotificationConfig_universal_d_ResolveNotificationConfigResponse as ResolveNotificationConfigResponse,\n eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfigRequest as UpsertNotificationConfigRequest,\n eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfigResponse as UpsertNotificationConfigResponse,\n eventsNotificationsV2NotificationConfig_universal_d_ResolveEmailNotificationConfigRequest as ResolveEmailNotificationConfigRequest,\n eventsNotificationsV2NotificationConfig_universal_d_ResolveEmailNotificationConfigResponse as ResolveEmailNotificationConfigResponse,\n EventDeleted$4 as EventDeleted,\n EventCopied$3 as EventCopied,\n MessageEnvelope$c as MessageEnvelope,\n IdentificationData$c as IdentificationData,\n IdentificationDataIdOneOf$c as IdentificationDataIdOneOf,\n WebhookIdentityType$c as WebhookIdentityType,\n eventsNotificationsV2NotificationConfig_universal_d_triggerNotification as triggerNotification,\n eventsNotificationsV2NotificationConfig_universal_d_TriggerNotificationOptions as TriggerNotificationOptions,\n eventsNotificationsV2NotificationConfig_universal_d_resolveNotificationConfig as resolveNotificationConfig,\n eventsNotificationsV2NotificationConfig_universal_d_upsertNotificationConfig as upsertNotificationConfig,\n eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfig as UpsertNotificationConfig,\n eventsNotificationsV2NotificationConfig_universal_d_UpsertNotificationConfigOptions as UpsertNotificationConfigOptions,\n };\n }\n \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 | null;\n /**\n * Date and time when the schedule item was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 | null;\n /** End of the interval. Non-inclusive. */\n end?: Date | null;\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 is 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 | null;\n /** Filters schedule items starting before specified point in time. Non-inclusive. */\n startingBefore?: Date | null;\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$8;\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$8 {\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$8;\n }\n interface FacetCounts$7 {\n /** Facet counts aggregated per value. */\n counts?: Record;\n }\n interface PagingMetadataV2$8 {\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$9;\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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$9 {\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$8;\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$9[];\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$8;\n }\n interface Sorting$9 {\n /** Name of the field to sort by */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\n order?: SortOrder$9;\n }\n enum SortOrder$9 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryScheduleItemsResponse$1 {\n pagingMetadata?: PagingMetadataV2$8;\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 * Set of field paths to update.\n * When fields are empty, request is interpreted as full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\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 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 */\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 */\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 */\n function deleteBookmark(itemId: string, eventId: string): Promise;\n \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 {\n ScheduleItem$1 as ScheduleItem,\n TimeInterval$1 as TimeInterval,\n ScheduleStatus$1 as ScheduleStatus,\n ListScheduleItemsRequest$1 as ListScheduleItemsRequest,\n StateFilter$1 as StateFilter,\n Paging$8 as Paging,\n ListScheduleItemsResponse$1 as ListScheduleItemsResponse,\n FacetCounts$7 as FacetCounts,\n PagingMetadataV2$8 as PagingMetadataV2,\n Cursors$9 as Cursors,\n QueryScheduleItemsRequest$1 as QueryScheduleItemsRequest,\n QueryV2$7 as QueryV2,\n QueryV2PagingMethodOneOf$7 as QueryV2PagingMethodOneOf,\n Sorting$9 as Sorting,\n SortOrder$9 as SortOrder,\n QueryScheduleItemsResponse$1 as QueryScheduleItemsResponse,\n GetScheduleItemRequest$1 as GetScheduleItemRequest,\n GetScheduleItemResponse$1 as GetScheduleItemResponse,\n AddScheduleItemRequest$1 as AddScheduleItemRequest,\n ScheduleItemData$1 as ScheduleItemData,\n AddScheduleItemResponse$1 as AddScheduleItemResponse,\n UpdateScheduleItemRequest$1 as UpdateScheduleItemRequest,\n UpdateScheduleItemResponse$1 as UpdateScheduleItemResponse,\n DeleteScheduleItemRequest$1 as DeleteScheduleItemRequest,\n DeleteScheduleItemResponse$1 as DeleteScheduleItemResponse,\n DiscardDraftRequest$2 as DiscardDraftRequest,\n DiscardDraftResponse$2 as DiscardDraftResponse,\n PublishDraftRequest$2 as PublishDraftRequest,\n PublishDraftResponse$2 as PublishDraftResponse,\n RescheduleDraftRequest$1 as RescheduleDraftRequest,\n RescheduleDraftResponse$1 as RescheduleDraftResponse,\n ListBookmarksRequest$1 as ListBookmarksRequest,\n ListBookmarksResponse$1 as ListBookmarksResponse,\n CreateBookmarkRequest$1 as CreateBookmarkRequest,\n CreateBookmarkResponse$1 as CreateBookmarkResponse,\n DeleteBookmarkRequest$1 as DeleteBookmarkRequest,\n DeleteBookmarkResponse$1 as DeleteBookmarkResponse,\n eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_listBookmarks as listBookmarks,\n eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_createBookmark as createBookmark,\n eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d_deleteBookmark as deleteBookmark,\n };\n }\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 | null;\n /**\n * Date and time when the schedule item was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 | null;\n /** End of the interval. Non-inclusive. */\n end?: Date | null;\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 is 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 | null;\n /** Filters schedule items starting before specified point in time. Non-inclusive. */\n startingBefore?: Date | null;\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 {\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 {\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$7;\n }\n interface FacetCounts$6 {\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$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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$8 {\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$6;\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$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$8[];\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$7;\n }\n interface Sorting$8 {\n /** Name of the field to sort by */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\n order?: SortOrder$8;\n }\n enum SortOrder$8 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface QueryScheduleItemsResponse {\n pagingMetadata?: PagingMetadataV2$7;\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 * Set of field paths to update.\n * When fields are empty, request is interpreted as full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\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$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface DiscardDraftResponse$1 {\n }\n interface PublishDraftRequest$1 {\n /** Event ID to which the schedule belongs. */\n eventId: string;\n }\n interface PublishDraftResponse$1 {\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 up to 100 schedule items\n * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_AGENDA\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[];\n /** Filters schedule items starting on or after specified point in time. Inclusive. */\n startingFrom?: Date | null;\n /** Filters schedule items starting before specified point in time. Non-inclusive. */\n startingBefore?: Date | null;\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 */\n function queryScheduleItems(): ItemsQueryBuilder;\n interface QueryCursorResult$6 {\n cursors: Cursors$8;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ItemsQueryResult extends QueryCursorResult$6 {\n items: ScheduleItem[];\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 * @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 * @adminMethod\n */\n function addScheduleItem(eventId: string, options?: AddScheduleItemOptions): Promise;\n interface AddScheduleItemOptions {\n /** Schedule item. */\n item?: ScheduleItemData;\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 * @adminMethod\n */\n function updateScheduleItem(itemId: string, eventId: string, options?: UpdateScheduleItemOptions): Promise;\n interface UpdateScheduleItemOptions {\n /** Schedule item. */\n item?: ScheduleItemData;\n /**\n * Set of field paths to update.\n * When fields are empty, request is interpreted as full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\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 * @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 * @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 * @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 * @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;\n }\n \n type eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleItem = ScheduleItem;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_TimeInterval = TimeInterval;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleStatus = ScheduleStatus;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleStatus: typeof ScheduleStatus;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsRequest = ListScheduleItemsRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_StateFilter = StateFilter;\n const eventsScheduleV1ScheduleItemSchedule_universal_d_StateFilter: typeof StateFilter;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsResponse = ListScheduleItemsResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_QueryScheduleItemsRequest = QueryScheduleItemsRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_QueryScheduleItemsResponse = QueryScheduleItemsResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemRequest = GetScheduleItemRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemResponse = GetScheduleItemResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemRequest = AddScheduleItemRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleItemData = ScheduleItemData;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemResponse = AddScheduleItemResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemRequest = UpdateScheduleItemRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemResponse = UpdateScheduleItemResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemRequest = DeleteScheduleItemRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemResponse = DeleteScheduleItemResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftRequest = RescheduleDraftRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftResponse = RescheduleDraftResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ListBookmarksRequest = ListBookmarksRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_ListBookmarksResponse = ListBookmarksResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_CreateBookmarkRequest = CreateBookmarkRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_CreateBookmarkResponse = CreateBookmarkResponse;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteBookmarkRequest = DeleteBookmarkRequest;\n type eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteBookmarkResponse = DeleteBookmarkResponse;\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 {\n eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleItem as ScheduleItem,\n eventsScheduleV1ScheduleItemSchedule_universal_d_TimeInterval as TimeInterval,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleStatus as ScheduleStatus,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsRequest as ListScheduleItemsRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_StateFilter as StateFilter,\n Paging$7 as Paging,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsResponse as ListScheduleItemsResponse,\n FacetCounts$6 as FacetCounts,\n PagingMetadataV2$7 as PagingMetadataV2,\n Cursors$8 as Cursors,\n eventsScheduleV1ScheduleItemSchedule_universal_d_QueryScheduleItemsRequest as QueryScheduleItemsRequest,\n QueryV2$6 as QueryV2,\n QueryV2PagingMethodOneOf$6 as QueryV2PagingMethodOneOf,\n Sorting$8 as Sorting,\n SortOrder$8 as SortOrder,\n eventsScheduleV1ScheduleItemSchedule_universal_d_QueryScheduleItemsResponse as QueryScheduleItemsResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemRequest as GetScheduleItemRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemResponse as GetScheduleItemResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemRequest as AddScheduleItemRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ScheduleItemData as ScheduleItemData,\n eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemResponse as AddScheduleItemResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemRequest as UpdateScheduleItemRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemResponse as UpdateScheduleItemResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemRequest as DeleteScheduleItemRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemResponse as DeleteScheduleItemResponse,\n DiscardDraftRequest$1 as DiscardDraftRequest,\n DiscardDraftResponse$1 as DiscardDraftResponse,\n PublishDraftRequest$1 as PublishDraftRequest,\n PublishDraftResponse$1 as PublishDraftResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftRequest as RescheduleDraftRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftResponse as RescheduleDraftResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ListBookmarksRequest as ListBookmarksRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ListBookmarksResponse as ListBookmarksResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_CreateBookmarkRequest as CreateBookmarkRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_CreateBookmarkResponse as CreateBookmarkResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteBookmarkRequest as DeleteBookmarkRequest,\n eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteBookmarkResponse as DeleteBookmarkResponse,\n eventsScheduleV1ScheduleItemSchedule_universal_d_listScheduleItems as listScheduleItems,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ListScheduleItemsOptions as ListScheduleItemsOptions,\n eventsScheduleV1ScheduleItemSchedule_universal_d_queryScheduleItems as queryScheduleItems,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ItemsQueryResult as ItemsQueryResult,\n eventsScheduleV1ScheduleItemSchedule_universal_d_ItemsQueryBuilder as ItemsQueryBuilder,\n eventsScheduleV1ScheduleItemSchedule_universal_d_getScheduleItem as getScheduleItem,\n eventsScheduleV1ScheduleItemSchedule_universal_d_GetScheduleItemOptions as GetScheduleItemOptions,\n eventsScheduleV1ScheduleItemSchedule_universal_d_addScheduleItem as addScheduleItem,\n eventsScheduleV1ScheduleItemSchedule_universal_d_AddScheduleItemOptions as AddScheduleItemOptions,\n eventsScheduleV1ScheduleItemSchedule_universal_d_updateScheduleItem as updateScheduleItem,\n eventsScheduleV1ScheduleItemSchedule_universal_d_UpdateScheduleItemOptions as UpdateScheduleItemOptions,\n eventsScheduleV1ScheduleItemSchedule_universal_d_deleteScheduleItem as deleteScheduleItem,\n eventsScheduleV1ScheduleItemSchedule_universal_d_DeleteScheduleItemOptions as DeleteScheduleItemOptions,\n discardDraft$1 as discardDraft,\n publishDraft$1 as publishDraft,\n eventsScheduleV1ScheduleItemSchedule_universal_d_rescheduleDraft as rescheduleDraft,\n eventsScheduleV1ScheduleItemSchedule_universal_d_RescheduleDraftOptions as RescheduleDraftOptions,\n };\n }\n \n /** Staff members are events hosts assigned persons who can perform check-in for tickets owners, sell tickets or add guests manually. */\n interface StaffMember extends StaffMemberEventAccessOneOf {\n /** All events. */\n allEvents?: AllEvents;\n /** Specific events. */\n specificEvents?: SpecificEvents;\n /**\n * Staff member ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the staff member was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the staff member was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name. */\n name?: string | null;\n /**\n * Scopes.\n * @deprecated Scopes.\n * @replacedBy permissions\n * @targetRemovalDate 2024-12-01\n */\n scopes?: Scope[];\n /** Status. Remains PENDING until staff member joins. Switches to SUSPENDED if user decides to temporarily revoke staff member access. */\n status?: Status$6;\n /**\n * Join link generated for staff member.\n * @readonly\n * @deprecated Join link generated for staff member.\n * @replacedBy login_link\n * @targetRemovalDate 2024-12-01\n */\n joinLink?: string | null;\n /** Data extensions */\n extendedFields?: ExtendedFields$3;\n /** Permissions. */\n permissions?: Permission[];\n /**\n * Login link generated for staff member.\n * @readonly\n */\n loginLink?: string | null;\n }\n /** @oneof */\n interface StaffMemberEventAccessOneOf {\n /** All events. */\n allEvents?: AllEvents;\n /** Specific events. */\n specificEvents?: SpecificEvents;\n }\n enum Scope {\n UNKNOWN_SCOPE = \"UNKNOWN_SCOPE\",\n /** Check in guests. */\n CHECK_IN_GUESTS = \"CHECK_IN_GUESTS\",\n /** Sell tickets. */\n SELL_TICKETS = \"SELL_TICKETS\",\n /** Add guests. */\n ADD_GUESTS = \"ADD_GUESTS\",\n /** Read analytics */\n READ_ANALYTICS = \"READ_ANALYTICS\"\n }\n interface AllEvents {\n }\n interface SpecificEvents {\n /** Specific events for which staff member have access (can perform check-in). */\n events?: string[];\n }\n enum Status$6 {\n /** Pending. Means that staff member has not joined. */\n PENDING = \"PENDING\",\n /** Has access. */\n HAS_ACCESS = \"HAS_ACCESS\",\n /** Access paused. When staff member is paused from performing actions. */\n ACCESS_PAUSED = \"ACCESS_PAUSED\"\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 enum Permission {\n UNKNOWN_PERMISSION = \"UNKNOWN_PERMISSION\",\n /** Check in guests. */\n CHECK_IN_GUESTS = \"CHECK_IN_GUESTS\",\n /** Sell tickets. */\n SELL_TICKETS = \"SELL_TICKETS\",\n /** Add guests. */\n ADD_GUESTS = \"ADD_GUESTS\",\n /** Read analytics */\n READ_ANALYTICS = \"READ_ANALYTICS\"\n }\n interface CreateStaffMemberRequest {\n /** Staff member to be created. */\n staffMember: StaffMember;\n }\n interface CreateStaffMemberResponse {\n /** The created staff member. */\n staffMember?: StaffMember;\n }\n interface GetStaffMemberRequest {\n /** ID of the staff member to retrieve. */\n staffMemberId: string;\n /**\n * List of additional staff member fields to include in the response. For example, use the `JOIN_LINK` fieldset to retrieve the join link field in\n * the response in addition to the staff member’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the staff member’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n }\n enum Fieldset {\n /**\n * Includes join link.\n * Deprecated, use LOGIN_LINK\n */\n JOIN_LINK = \"JOIN_LINK\",\n /** Includes login link. */\n LOGIN_LINK = \"LOGIN_LINK\"\n }\n interface GetStaffMemberResponse {\n /** The requested staff member. */\n staffMember?: StaffMember;\n }\n interface UpdateStaffMemberRequest {\n /** Staff member to be updated, may be partial. */\n staffMember: StaffMember;\n /**\n * Set of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateStaffMemberResponse {\n /** Updated staff member. */\n staffMember?: StaffMember;\n }\n interface DeleteStaffMemberRequest {\n /** Id of the staff member to delete. */\n staffMemberId: string;\n }\n interface DeleteStaffMemberResponse {\n }\n interface QueryStaffMembersRequest {\n /** WQL expression. */\n query?: QueryV2$5;\n /**\n * List of additional staff member fields to include in the response. For example, use the `JOIN_LINK` fieldset to retrieve the join link field in\n * the response in addition to the staff member’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the staff member’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n }\n interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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 /** 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$7[];\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 fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$5 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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$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 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 interface CursorPaging$6 {\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 *\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 QueryStaffMembersResponse {\n /** List of staff members. */\n staffMembers?: StaffMember[];\n /** Paging metadata */\n pagingMetadata?: 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$7;\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 JoinStaffMemberRequest {\n /** Used to authorise staff member */\n joinToken: string;\n }\n interface JoinStaffMemberResponse {\n /** The activated staff member. */\n staffMember?: StaffMember;\n /** Used to authorise service calls */\n accessToken?: string;\n /** The device id to which staff member is authorized */\n deviceId?: string;\n }\n interface LoginStaffMemberRequest {\n /** Used to authorise staff member */\n loginToken: string;\n }\n interface LoginStaffMemberResponse {\n /** The activated staff member. */\n staffMember?: StaffMember;\n /** Used to authorise service calls */\n accessToken?: string;\n /** The device id to which staff member is authorized */\n deviceId?: string;\n }\n interface AccessStaffMemberRequest {\n /** Used to authorise staff member */\n accessToken: string;\n }\n interface AccessStaffMemberResponse {\n /** The staff member. */\n staffMember?: StaffMember;\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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$7;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$7 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$7 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$7 {\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 /**\n * Creates a staff member.\n * @param staffMember - Staff member to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMember\n * @permissionId WIX_EVENTS.STAFF_MEMBER_CREATE\n * @adminMethod\n * @returns The created staff member.\n */\n function createStaffMember(staffMember: StaffMember): Promise;\n /**\n * Retrieves a staff member.\n * @param staffMemberId - ID of the staff member to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId WIX_EVENTS.STAFF_MEMBER_READ\n * @adminMethod\n * @returns The requested staff member.\n */\n function getStaffMember(staffMemberId: string, options?: GetStaffMemberOptions): Promise;\n interface GetStaffMemberOptions {\n /**\n * List of additional staff member fields to include in the response. For example, use the `JOIN_LINK` fieldset to retrieve the join link field in\n * the response in addition to the staff member’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the staff member’s base fields are returned.\n */\n fieldsets?: Fieldset[];\n }\n /**\n * Updates a staff member.\n *\n * Each time the staff member is updated,\n * `revision` increments by 1.\n * The current `revision` must be passed when updating the staff member.\n * This ensures you're working with the latest staff member\n * and prevents unintended overwrites.\n * @param _id - Staff member ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField staffMember\n * @requiredField staffMember.revision\n * @permissionId WIX_EVENTS.STAFF_MEMBER_UPDATE\n * @adminMethod\n * @returns Updated staff member.\n */\n function updateStaffMember(_id: string | null, staffMember: UpdateStaffMember, options?: UpdateStaffMemberOptions): Promise;\n interface UpdateStaffMember {\n /** All events. */\n allEvents?: AllEvents;\n /** Specific events. */\n specificEvents?: SpecificEvents;\n /**\n * Staff member ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the staff member was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the staff member was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name. */\n name?: string | null;\n /**\n * Scopes.\n * @deprecated Scopes.\n * @replacedBy permissions\n * @targetRemovalDate 2024-12-01\n */\n scopes?: Scope[];\n /** Status. Remains PENDING until staff member joins. Switches to SUSPENDED if user decides to temporarily revoke staff member access. */\n status?: Status$6;\n /**\n * Join link generated for staff member.\n * @readonly\n * @deprecated Join link generated for staff member.\n * @replacedBy login_link\n * @targetRemovalDate 2024-12-01\n */\n joinLink?: string | null;\n /** Data extensions */\n extendedFields?: ExtendedFields$3;\n /** Permissions. */\n permissions?: Permission[];\n /**\n * Login link generated for staff member.\n * @readonly\n */\n loginLink?: string | null;\n }\n interface UpdateStaffMemberOptions {\n /**\n * Set of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes a staff member.\n *\n * Deleting a staff member permanently removes them from the staff member List.\n * @param staffMemberId - Id of the staff member to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId WIX_EVENTS.STAFF_MEMBER_DELETE\n * @adminMethod\n */\n function deleteStaffMember(staffMemberId: string): Promise;\n /**\n * Retrieves a list of staff members, given the provided paging, filtering, and sorting.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.STAFF_MEMBER_READ\n * @adminMethod\n */\n function queryStaffMembers(options?: QueryStaffMembersOptions): StaffMembersQueryBuilder;\n interface QueryStaffMembersOptions {\n /**\n * List of additional staff member fields to include in the response. For example, use the `JOIN_LINK` fieldset to retrieve the join link field in\n * the response in addition to the staff member’s base fields. Base fields don’t include any of the supported fieldset values. By default\n * only the staff member’s base fields are returned.\n */\n fieldsets?: Fieldset[] | undefined;\n }\n interface QueryCursorResult$5 {\n cursors: Cursors$7;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface StaffMembersQueryResult extends QueryCursorResult$5 {\n items: StaffMember[];\n query: StaffMembersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface StaffMembersQueryBuilder {\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) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id', value: any) => StaffMembersQueryBuilder;\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'>) => StaffMembersQueryBuilder;\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'>) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => StaffMembersQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Joins as staff member if he's not in suspended status via provided token.\n * @param joinToken - Used to authorise staff member\n * @public\n * @documentationMaturity preview\n * @requiredField joinToken\n * @permissionId WIX_EVENTS.STAFF_MEMBER_ACTIVATE\n */\n function joinStaffMember(joinToken: string): Promise;\n /**\n * Logins as staff member if he's not in suspended status via provided token.\n * @param loginToken - Used to authorise staff member\n * @public\n * @documentationMaturity preview\n * @requiredField loginToken\n * @permissionId WIX_EVENTS.STAFF_MEMBER_ACTIVATE\n */\n function loginStaffMember(loginToken: string): Promise;\n /**\n * Retrieves a staff by access token.\n * @param accessToken - Used to authorise staff member\n * @public\n * @documentationMaturity preview\n * @requiredField accessToken\n * @permissionId WIX_EVENTS.STAFF_MEMBER_ACTIVATE\n */\n function accessStaffMember(accessToken: string): Promise;\n \n type eventsStaffmembersV1StaffMember_universal_d_StaffMember = StaffMember;\n type eventsStaffmembersV1StaffMember_universal_d_StaffMemberEventAccessOneOf = StaffMemberEventAccessOneOf;\n type eventsStaffmembersV1StaffMember_universal_d_Scope = Scope;\n const eventsStaffmembersV1StaffMember_universal_d_Scope: typeof Scope;\n type eventsStaffmembersV1StaffMember_universal_d_AllEvents = AllEvents;\n type eventsStaffmembersV1StaffMember_universal_d_SpecificEvents = SpecificEvents;\n type eventsStaffmembersV1StaffMember_universal_d_Permission = Permission;\n const eventsStaffmembersV1StaffMember_universal_d_Permission: typeof Permission;\n type eventsStaffmembersV1StaffMember_universal_d_CreateStaffMemberRequest = CreateStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_CreateStaffMemberResponse = CreateStaffMemberResponse;\n type eventsStaffmembersV1StaffMember_universal_d_GetStaffMemberRequest = GetStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_Fieldset = Fieldset;\n const eventsStaffmembersV1StaffMember_universal_d_Fieldset: typeof Fieldset;\n type eventsStaffmembersV1StaffMember_universal_d_GetStaffMemberResponse = GetStaffMemberResponse;\n type eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMemberRequest = UpdateStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMemberResponse = UpdateStaffMemberResponse;\n type eventsStaffmembersV1StaffMember_universal_d_DeleteStaffMemberRequest = DeleteStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_DeleteStaffMemberResponse = DeleteStaffMemberResponse;\n type eventsStaffmembersV1StaffMember_universal_d_QueryStaffMembersRequest = QueryStaffMembersRequest;\n type eventsStaffmembersV1StaffMember_universal_d_QueryStaffMembersResponse = QueryStaffMembersResponse;\n type eventsStaffmembersV1StaffMember_universal_d_JoinStaffMemberRequest = JoinStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_JoinStaffMemberResponse = JoinStaffMemberResponse;\n type eventsStaffmembersV1StaffMember_universal_d_LoginStaffMemberRequest = LoginStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_LoginStaffMemberResponse = LoginStaffMemberResponse;\n type eventsStaffmembersV1StaffMember_universal_d_AccessStaffMemberRequest = AccessStaffMemberRequest;\n type eventsStaffmembersV1StaffMember_universal_d_AccessStaffMemberResponse = AccessStaffMemberResponse;\n const eventsStaffmembersV1StaffMember_universal_d_createStaffMember: typeof createStaffMember;\n const eventsStaffmembersV1StaffMember_universal_d_getStaffMember: typeof getStaffMember;\n type eventsStaffmembersV1StaffMember_universal_d_GetStaffMemberOptions = GetStaffMemberOptions;\n const eventsStaffmembersV1StaffMember_universal_d_updateStaffMember: typeof updateStaffMember;\n type eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMember = UpdateStaffMember;\n type eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMemberOptions = UpdateStaffMemberOptions;\n const eventsStaffmembersV1StaffMember_universal_d_deleteStaffMember: typeof deleteStaffMember;\n const eventsStaffmembersV1StaffMember_universal_d_queryStaffMembers: typeof queryStaffMembers;\n type eventsStaffmembersV1StaffMember_universal_d_QueryStaffMembersOptions = QueryStaffMembersOptions;\n type eventsStaffmembersV1StaffMember_universal_d_StaffMembersQueryResult = StaffMembersQueryResult;\n type eventsStaffmembersV1StaffMember_universal_d_StaffMembersQueryBuilder = StaffMembersQueryBuilder;\n const eventsStaffmembersV1StaffMember_universal_d_joinStaffMember: typeof joinStaffMember;\n const eventsStaffmembersV1StaffMember_universal_d_loginStaffMember: typeof loginStaffMember;\n const eventsStaffmembersV1StaffMember_universal_d_accessStaffMember: typeof accessStaffMember;\n namespace eventsStaffmembersV1StaffMember_universal_d {\n export {\n eventsStaffmembersV1StaffMember_universal_d_StaffMember as StaffMember,\n eventsStaffmembersV1StaffMember_universal_d_StaffMemberEventAccessOneOf as StaffMemberEventAccessOneOf,\n eventsStaffmembersV1StaffMember_universal_d_Scope as Scope,\n eventsStaffmembersV1StaffMember_universal_d_AllEvents as AllEvents,\n eventsStaffmembersV1StaffMember_universal_d_SpecificEvents as SpecificEvents,\n Status$6 as Status,\n ExtendedFields$3 as ExtendedFields,\n eventsStaffmembersV1StaffMember_universal_d_Permission as Permission,\n eventsStaffmembersV1StaffMember_universal_d_CreateStaffMemberRequest as CreateStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_CreateStaffMemberResponse as CreateStaffMemberResponse,\n eventsStaffmembersV1StaffMember_universal_d_GetStaffMemberRequest as GetStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_Fieldset as Fieldset,\n eventsStaffmembersV1StaffMember_universal_d_GetStaffMemberResponse as GetStaffMemberResponse,\n eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMemberRequest as UpdateStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMemberResponse as UpdateStaffMemberResponse,\n eventsStaffmembersV1StaffMember_universal_d_DeleteStaffMemberRequest as DeleteStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_DeleteStaffMemberResponse as DeleteStaffMemberResponse,\n eventsStaffmembersV1StaffMember_universal_d_QueryStaffMembersRequest as QueryStaffMembersRequest,\n QueryV2$5 as QueryV2,\n QueryV2PagingMethodOneOf$5 as QueryV2PagingMethodOneOf,\n Sorting$7 as Sorting,\n SortOrder$7 as SortOrder,\n Paging$6 as Paging,\n CursorPaging$6 as CursorPaging,\n eventsStaffmembersV1StaffMember_universal_d_QueryStaffMembersResponse as QueryStaffMembersResponse,\n PagingMetadataV2$6 as PagingMetadataV2,\n Cursors$7 as Cursors,\n eventsStaffmembersV1StaffMember_universal_d_JoinStaffMemberRequest as JoinStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_JoinStaffMemberResponse as JoinStaffMemberResponse,\n eventsStaffmembersV1StaffMember_universal_d_LoginStaffMemberRequest as LoginStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_LoginStaffMemberResponse as LoginStaffMemberResponse,\n eventsStaffmembersV1StaffMember_universal_d_AccessStaffMemberRequest as AccessStaffMemberRequest,\n eventsStaffmembersV1StaffMember_universal_d_AccessStaffMemberResponse as AccessStaffMemberResponse,\n DomainEvent$7 as DomainEvent,\n DomainEventBodyOneOf$7 as DomainEventBodyOneOf,\n EntityCreatedEvent$7 as EntityCreatedEvent,\n RestoreInfo$7 as RestoreInfo,\n EntityUpdatedEvent$7 as EntityUpdatedEvent,\n EntityDeletedEvent$7 as EntityDeletedEvent,\n ActionEvent$7 as ActionEvent,\n MessageEnvelope$b as MessageEnvelope,\n IdentificationData$b as IdentificationData,\n IdentificationDataIdOneOf$b as IdentificationDataIdOneOf,\n WebhookIdentityType$b as WebhookIdentityType,\n eventsStaffmembersV1StaffMember_universal_d_createStaffMember as createStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_getStaffMember as getStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_GetStaffMemberOptions as GetStaffMemberOptions,\n eventsStaffmembersV1StaffMember_universal_d_updateStaffMember as updateStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMember as UpdateStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_UpdateStaffMemberOptions as UpdateStaffMemberOptions,\n eventsStaffmembersV1StaffMember_universal_d_deleteStaffMember as deleteStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_queryStaffMembers as queryStaffMembers,\n eventsStaffmembersV1StaffMember_universal_d_QueryStaffMembersOptions as QueryStaffMembersOptions,\n eventsStaffmembersV1StaffMember_universal_d_StaffMembersQueryResult as StaffMembersQueryResult,\n eventsStaffmembersV1StaffMember_universal_d_StaffMembersQueryBuilder as StaffMembersQueryBuilder,\n eventsStaffmembersV1StaffMember_universal_d_joinStaffMember as joinStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_loginStaffMember as loginStaffMember,\n eventsStaffmembersV1StaffMember_universal_d_accessStaffMember as accessStaffMember,\n };\n }\n \n interface Category$4 {\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 | null;\n /**\n * Total number of published events assigned to the category. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$4;\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$7[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\n }\n interface CategoryCounts$4 {\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$7 {\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$4;\n }\n interface CreateCategoryResponse {\n /** Created category. */\n category?: Category$4;\n }\n interface BulkCreateCategoryRequest {\n /** Categories to create. */\n categories: Category$4[];\n }\n interface BulkCreateCategoryResponse {\n /** Bulk create results. */\n results?: BulkCategoryResult[];\n /** Metadata of results. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkCategoryResult {\n /** Metadata. */\n itemMetadata?: ItemMetadata$1;\n /** Created categories. */\n item?: Category$4;\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 due to exceeding the threshold for detailed failures. */\n undetailedFailures?: number;\n }\n interface UpdateCategoryRequest {\n /** Category to update. */\n category: Category$4;\n }\n interface UpdateCategoryResponse {\n /** Updated category. */\n category?: Category$4;\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$4;\n /**\n * Predefined sets of fields to return.\n * - `COUNTS`: Returns `assignedEventsCount`.\n */\n fieldset?: CategoryFieldset[];\n }\n interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {\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$5;\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$4 {\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$5;\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$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 enum CategoryFieldset {\n /** Include `assignedEventsCount` in the response. */\n COUNTS = \"COUNTS\"\n }\n interface QueryCategoriesResponse {\n /** List of categories. */\n categories?: Category$4[];\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$6;\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 * @internal\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 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$1;\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$1;\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$4[];\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$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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$6 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent$6 {\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 category.\n * @public\n * @requiredField category\n * @param category - Category to create.\n * @permissionId WIX_EVENTS.MANAGE_CATEGORIES\n * @adminMethod\n * @returns Created category.\n */\n function createCategory(category: Category$4): 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 * @adminMethod\n */\n function bulkCreateCategory(categories: Category$4[]): 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 * @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 | null;\n /**\n * Total number of published events assigned to the category. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$4;\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$7[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\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 * @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 */\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$4[];\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 * @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 * @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 * @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 * @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 * @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 * @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 */\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 * @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 \n type eventsV1Category_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type eventsV1Category_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type eventsV1Category_universal_d_BulkCreateCategoryRequest = BulkCreateCategoryRequest;\n type eventsV1Category_universal_d_BulkCreateCategoryResponse = BulkCreateCategoryResponse;\n type eventsV1Category_universal_d_BulkCategoryResult = BulkCategoryResult;\n type eventsV1Category_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type eventsV1Category_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type eventsV1Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type eventsV1Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type eventsV1Category_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type eventsV1Category_universal_d_CategoryFieldset = CategoryFieldset;\n const eventsV1Category_universal_d_CategoryFieldset: typeof CategoryFieldset;\n type eventsV1Category_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type eventsV1Category_universal_d_AssignEventsRequest = AssignEventsRequest;\n type eventsV1Category_universal_d_AssignEventsResponse = AssignEventsResponse;\n type eventsV1Category_universal_d_BulkAssignEventsRequest = BulkAssignEventsRequest;\n type eventsV1Category_universal_d_BulkAssignEventsResponse = BulkAssignEventsResponse;\n type eventsV1Category_universal_d_BulkAssignEventsAsyncRequest = BulkAssignEventsAsyncRequest;\n type eventsV1Category_universal_d_BulkAssignEventsAsyncResponse = BulkAssignEventsAsyncResponse;\n type eventsV1Category_universal_d_UnassignEventsRequest = UnassignEventsRequest;\n type eventsV1Category_universal_d_UnassignEventsResponse = UnassignEventsResponse;\n type eventsV1Category_universal_d_BulkUnassignEventsRequest = BulkUnassignEventsRequest;\n type eventsV1Category_universal_d_BulkUnassignEventsResponse = BulkUnassignEventsResponse;\n type eventsV1Category_universal_d_BulkUnassignEventsAsyncRequest = BulkUnassignEventsAsyncRequest;\n type eventsV1Category_universal_d_BulkUnassignEventsAsyncResponse = BulkUnassignEventsAsyncResponse;\n type eventsV1Category_universal_d_ListEventCategoriesRequest = ListEventCategoriesRequest;\n type eventsV1Category_universal_d_ListEventCategoriesResponse = ListEventCategoriesResponse;\n type eventsV1Category_universal_d_ReorderCategoryEventsRequest = ReorderCategoryEventsRequest;\n type eventsV1Category_universal_d_ReorderCategoryEventsRequestReferenceEventOneOf = ReorderCategoryEventsRequestReferenceEventOneOf;\n type eventsV1Category_universal_d_ReorderCategoryEventsResponse = ReorderCategoryEventsResponse;\n const eventsV1Category_universal_d_createCategory: typeof createCategory;\n const eventsV1Category_universal_d_bulkCreateCategory: typeof bulkCreateCategory;\n const eventsV1Category_universal_d_updateCategory: typeof updateCategory;\n type eventsV1Category_universal_d_UpdateCategory = UpdateCategory;\n const eventsV1Category_universal_d_deleteCategory: typeof deleteCategory;\n const eventsV1Category_universal_d_queryCategories: typeof queryCategories;\n type eventsV1Category_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n type eventsV1Category_universal_d_CategoriesQueryResult = CategoriesQueryResult;\n type eventsV1Category_universal_d_CategoriesQueryBuilder = CategoriesQueryBuilder;\n const eventsV1Category_universal_d_assignEvents: typeof assignEvents;\n const eventsV1Category_universal_d_bulkAssignEvents: typeof bulkAssignEvents;\n type eventsV1Category_universal_d_BulkAssignEventsOptions = BulkAssignEventsOptions;\n const eventsV1Category_universal_d_bulkAssignEventsAsync: typeof bulkAssignEventsAsync;\n type eventsV1Category_universal_d_BulkAssignEventsAsyncOptions = BulkAssignEventsAsyncOptions;\n const eventsV1Category_universal_d_unassignEvents: typeof unassignEvents;\n const eventsV1Category_universal_d_bulkUnassignEvents: typeof bulkUnassignEvents;\n type eventsV1Category_universal_d_BulkUnassignEventsOptions = BulkUnassignEventsOptions;\n const eventsV1Category_universal_d_bulkUnassignEventsAsync: typeof bulkUnassignEventsAsync;\n type eventsV1Category_universal_d_BulkUnassignEventsAsyncOptions = BulkUnassignEventsAsyncOptions;\n const eventsV1Category_universal_d_listEventCategories: typeof listEventCategories;\n const eventsV1Category_universal_d_reorderCategoryEvents: typeof reorderCategoryEvents;\n type eventsV1Category_universal_d_ReorderCategoryEventsOptions = ReorderCategoryEventsOptions;\n namespace eventsV1Category_universal_d {\n export {\n Category$4 as Category,\n CategoryCounts$4 as CategoryCounts,\n State$7 as State,\n eventsV1Category_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n eventsV1Category_universal_d_CreateCategoryResponse as CreateCategoryResponse,\n eventsV1Category_universal_d_BulkCreateCategoryRequest as BulkCreateCategoryRequest,\n eventsV1Category_universal_d_BulkCreateCategoryResponse as BulkCreateCategoryResponse,\n eventsV1Category_universal_d_BulkCategoryResult as BulkCategoryResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n eventsV1Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n eventsV1Category_universal_d_UpdateCategoryResponse as UpdateCategoryResponse,\n eventsV1Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n eventsV1Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n eventsV1Category_universal_d_QueryCategoriesRequest as QueryCategoriesRequest,\n QueryV2$4 as QueryV2,\n QueryV2PagingMethodOneOf$4 as QueryV2PagingMethodOneOf,\n Sorting$6 as Sorting,\n SortOrder$6 as SortOrder,\n Paging$5 as Paging,\n eventsV1Category_universal_d_CategoryFieldset as CategoryFieldset,\n eventsV1Category_universal_d_QueryCategoriesResponse as QueryCategoriesResponse,\n PagingMetadataV2$5 as PagingMetadataV2,\n Cursors$6 as Cursors,\n eventsV1Category_universal_d_AssignEventsRequest as AssignEventsRequest,\n eventsV1Category_universal_d_AssignEventsResponse as AssignEventsResponse,\n eventsV1Category_universal_d_BulkAssignEventsRequest as BulkAssignEventsRequest,\n eventsV1Category_universal_d_BulkAssignEventsResponse as BulkAssignEventsResponse,\n eventsV1Category_universal_d_BulkAssignEventsAsyncRequest as BulkAssignEventsAsyncRequest,\n eventsV1Category_universal_d_BulkAssignEventsAsyncResponse as BulkAssignEventsAsyncResponse,\n eventsV1Category_universal_d_UnassignEventsRequest as UnassignEventsRequest,\n eventsV1Category_universal_d_UnassignEventsResponse as UnassignEventsResponse,\n eventsV1Category_universal_d_BulkUnassignEventsRequest as BulkUnassignEventsRequest,\n eventsV1Category_universal_d_BulkUnassignEventsResponse as BulkUnassignEventsResponse,\n eventsV1Category_universal_d_BulkUnassignEventsAsyncRequest as BulkUnassignEventsAsyncRequest,\n eventsV1Category_universal_d_BulkUnassignEventsAsyncResponse as BulkUnassignEventsAsyncResponse,\n eventsV1Category_universal_d_ListEventCategoriesRequest as ListEventCategoriesRequest,\n eventsV1Category_universal_d_ListEventCategoriesResponse as ListEventCategoriesResponse,\n eventsV1Category_universal_d_ReorderCategoryEventsRequest as ReorderCategoryEventsRequest,\n eventsV1Category_universal_d_ReorderCategoryEventsRequestReferenceEventOneOf as ReorderCategoryEventsRequestReferenceEventOneOf,\n eventsV1Category_universal_d_ReorderCategoryEventsResponse as ReorderCategoryEventsResponse,\n DomainEvent$6 as DomainEvent,\n DomainEventBodyOneOf$6 as DomainEventBodyOneOf,\n EntityCreatedEvent$6 as EntityCreatedEvent,\n RestoreInfo$6 as RestoreInfo,\n EntityUpdatedEvent$6 as EntityUpdatedEvent,\n EntityDeletedEvent$6 as EntityDeletedEvent,\n ActionEvent$6 as ActionEvent,\n MessageEnvelope$a as MessageEnvelope,\n IdentificationData$a as IdentificationData,\n IdentificationDataIdOneOf$a as IdentificationDataIdOneOf,\n WebhookIdentityType$a as WebhookIdentityType,\n eventsV1Category_universal_d_createCategory as createCategory,\n eventsV1Category_universal_d_bulkCreateCategory as bulkCreateCategory,\n eventsV1Category_universal_d_updateCategory as updateCategory,\n eventsV1Category_universal_d_UpdateCategory as UpdateCategory,\n eventsV1Category_universal_d_deleteCategory as deleteCategory,\n eventsV1Category_universal_d_queryCategories as queryCategories,\n eventsV1Category_universal_d_QueryCategoriesOptions as QueryCategoriesOptions,\n eventsV1Category_universal_d_CategoriesQueryResult as CategoriesQueryResult,\n eventsV1Category_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder,\n eventsV1Category_universal_d_assignEvents as assignEvents,\n eventsV1Category_universal_d_bulkAssignEvents as bulkAssignEvents,\n eventsV1Category_universal_d_BulkAssignEventsOptions as BulkAssignEventsOptions,\n eventsV1Category_universal_d_bulkAssignEventsAsync as bulkAssignEventsAsync,\n eventsV1Category_universal_d_BulkAssignEventsAsyncOptions as BulkAssignEventsAsyncOptions,\n eventsV1Category_universal_d_unassignEvents as unassignEvents,\n eventsV1Category_universal_d_bulkUnassignEvents as bulkUnassignEvents,\n eventsV1Category_universal_d_BulkUnassignEventsOptions as BulkUnassignEventsOptions,\n eventsV1Category_universal_d_bulkUnassignEventsAsync as bulkUnassignEventsAsync,\n eventsV1Category_universal_d_BulkUnassignEventsAsyncOptions as BulkUnassignEventsAsyncOptions,\n eventsV1Category_universal_d_listEventCategories as listEventCategories,\n eventsV1Category_universal_d_reorderCategoryEvents as reorderCategoryEvents,\n eventsV1Category_universal_d_ReorderCategoryEventsOptions as ReorderCategoryEventsOptions,\n };\n }\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$3 {\n /** Nested fields as an ordered list. */\n controls?: InputControl$3[];\n /** Set of configured form messages. */\n messages?: FormMessages$3;\n }\n /**\n * A block of nested fields.\n * Used to aggregate similar inputs like First Name and Last Name.\n */\n interface InputControl$3 {\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$3;\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 /**\n * Deprecated: Use `id`.\n * @deprecated\n */\n name?: string;\n /** Child inputs. */\n inputs?: Input$3[];\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$3 {\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$3 {\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$3;\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$3;\n /**\n * Additional labels for multi-valued fields such as address.\n * @readonly\n */\n labels?: Label$3[];\n }\n enum ValueType$3 {\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$3 extends OptionSelectionSelectedOptionOneOf$3 {\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$3 {\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$3 {\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$3 {\n /** RSVP form messages. */\n rsvp?: RsvpFormMessages$3;\n /** Checkout form messages. */\n checkout?: CheckoutFormMessages$3;\n /** Messages shown when event registration is closed. */\n registrationClosed?: RegistrationClosedMessages$3;\n /** Messages shown when event tickets are unavailable. */\n ticketsUnavailable?: TicketsUnavailableMessages$3;\n }\n interface RsvpFormMessages$3 {\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$3;\n /** Messages shown for RSVP = `WAITING` (when event is full and waitlist is available). */\n waitlistMessages?: Positive$3;\n /** Messages shown for RSVP = `NO`. */\n negativeMessages?: Negative$3;\n /** \"Submit form\" call-to-action label text. */\n submitActionLabel?: string;\n }\n /** Confirmation messages shown after registration. */\n interface PositiveResponseConfirmation$3 {\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$3 {\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$3 {\n /** Main form title for positive response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: PositiveResponseConfirmation$3;\n }\n /** A set of messages shown during registration with negative response */\n interface Negative$3 {\n /** Main form title for negative response. */\n title?: string;\n /** Confirmation messages shown after registration. */\n confirmation?: NegativeResponseConfirmation$3;\n }\n interface CheckoutFormMessages$3 {\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$3;\n }\n /** Confirmation messages shown after checkout. */\n interface ResponseConfirmation$3 {\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$3 {\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$3 {\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$3;\n }\n interface FormInputControlUpdated {\n /** Event ID to which the form belongs. */\n eventId?: string;\n /** Input control. */\n updatedInputControl?: InputControl$3;\n }\n interface FormInputControlDeleted {\n /** Event ID to which the form belongs. */\n eventId?: string;\n /** Input control. */\n deletedInputControl?: InputControl$3;\n }\n interface GetFormRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n /**\n * Whether to return additional data with the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n enum RequestedFields$2 {\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$3;\n /**\n * Draft event form.\n * Not available to visitors unless published.\n */\n draftForm?: Form$3;\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 /**\n * Deprecated. Use radioButton.\n * @internal\n * @deprecated\n */\n radio?: RadioButtonControl;\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 /**\n * Deprecated. Use radioButton.\n * @internal\n * @deprecated\n */\n radio?: RadioButtonControl;\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$3;\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$3;\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 /**\n * Single-choice radio style input control.\n * @internal\n * @deprecated\n */\n radio?: RadioButtonControl;\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 /**\n * Single-choice radio style input control.\n * @internal\n * @deprecated\n */\n radio?: RadioButtonControl;\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$3;\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$3;\n }\n interface UpdateMessagesRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n /**\n * Set of field paths, specifying which parts of this resource to update.\n * When fields are empty, request is interpreted as full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\n /** Set of configured form messages. */\n messages?: FormMessages$3;\n }\n interface UpdateMessagesResponse {\n /** Modified draft event form. */\n form?: Form$3;\n }\n interface PublishDraftRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n }\n interface PublishDraftResponse {\n /** Published event form. */\n form?: Form$3;\n }\n interface EventUpdated$2 {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$5;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$5;\n /** Event title. */\n title?: string;\n /**\n * Whether schedule configuration was updated.\n * @deprecated\n */\n scheduleConfigUpdated?: boolean;\n /**\n * The set of properties which were updated. For example 'title' or 'location'\n * @internal\n */\n fields?: string[];\n /**\n * Whether event has opened new spots with this update.\n * @internal\n */\n newSpotsOpened?: boolean | null;\n /** Updated event */\n event?: Event$3;\n }\n interface Location$5 {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates$5;\n /** Single line address representation. */\n address?: string | null;\n /** Location type. */\n type?: LocationType$5;\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$8;\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$5 {\n /** Latitude. */\n lat?: number;\n /** Longitude. */\n lng?: number;\n }\n enum LocationType$5 {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$8 extends AddressStreetOneOf$8 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$8;\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$8;\n /** country full-name */\n countryFullname?: string | null;\n /** multi-level subdivisions from top to bottom */\n subdivisions?: Subdivision$8[];\n }\n /** @oneof */\n interface AddressStreetOneOf$8 {\n /** a break down of the street to number and street name */\n streetAddress?: StreetAddress$8;\n /** Main address line (usually street and number) as free text */\n addressLine?: string | null;\n }\n interface StreetAddress$8 {\n /** street number */\n number?: string;\n /** street name */\n name?: string;\n /**\n * apartment number\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation$8 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$8 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n /**\n * subdivision level\n * @internal\n */\n type?: SubdivisionType$8;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\n }\n enum SubdivisionType$8 {\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$5 {\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$5;\n }\n interface Recurrences$5 {\n /** Event occurrences. */\n occurrences?: Occurrence$5[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status$5;\n }\n interface Occurrence$5 {\n /** Event start timestamp. */\n startDate?: Date | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$5 {\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$3 {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location$5;\n /** Event scheduling. */\n scheduling?: Scheduling$3;\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 | null;\n /** Event modified timestamp. */\n modified?: Date | null;\n /** Event status. */\n status?: EventStatus$5;\n /** RSVP or ticketing registration details. */\n registration?: Registration$3;\n /** \"Add to calendar\" URLs. */\n calendarLinks?: CalendarLinks$5;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl$3;\n /** Event registration form. */\n form?: Form$3;\n /** Event dashboard summary of RSVP / ticket sales. */\n dashboard?: Dashboard$5;\n /** Instance ID of the site where event is hosted. */\n instanceId?: string;\n /** Guest list configuration. */\n guestListConfig?: GuestListConfig$3;\n /** Event creator user ID. */\n userId?: string;\n /** Event discussion feed. For internal use. */\n feed?: Feed$3;\n /** Online conferencing details. */\n onlineConferencing?: OnlineConferencing$3;\n /** SEO settings. */\n seoSettings?: SeoSettings$3;\n /** Assigned contacts label key. */\n assignedContactsLabel?: string | null;\n /** Agenda details. */\n agenda?: Agenda$3;\n /** Categories this event is assigned to. */\n categories?: Category$3[];\n /** Visual settings for event. */\n eventDisplaySettings?: EventDisplaySettings$3;\n /**\n * @internal\n * @readonly\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: LabellingSettings$3;\n }\n interface Scheduling$3 {\n /** Schedule configuration. */\n config?: ScheduleConfig$5;\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$5 {\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$3 {\n /** Event type. */\n type?: EventType$3;\n /** Event registration status. */\n status?: RegistrationStatus$3;\n /** RSVP collection details. */\n rsvpCollection?: RsvpCollection$3;\n /** Ticketing details. */\n ticketing?: Ticketing$3;\n /** External registration details. */\n external?: ExternalEvent$3;\n /** Types of users allowed to register. */\n restrictedTo?: VisitorType$3;\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$3 {\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$3 {\n /** RSVP collection configuration. */\n config?: RsvpCollectionConfig$3;\n }\n interface RsvpCollectionConfig$3 {\n /** Defines the supported RSVP statuses. */\n rsvpStatusOptions?: RsvpStatusOptions$3;\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 | null;\n /** Registration end timestamp. */\n endDate?: Date | null;\n }\n enum RsvpStatusOptions$3 {\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$3 {\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$3;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: Money$6;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: Money$6;\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$3 {\n /** Whether the form must be filled out separately for each ticket. */\n guestAssignedTickets?: boolean;\n /** Tax configuration. */\n taxConfig?: TaxConfig$3;\n /** Limit of tickets that can be purchased per order, default 20. */\n ticketLimitPerOrder?: number;\n /**\n * App Id for external ticket stock management.\n * By default tickets stock is defined in TicketDefinition object.\n * If defined then limitation from TicketDefinition is ignored.\n * @internal\n */\n stockManagerAppId?: string | null;\n /** Duration for which the tickets being bought are reserved. */\n reservationDurationInMinutes?: number | null;\n }\n interface TaxConfig$3 {\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$6 {\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 ExternalEvent$3 {\n /** External event registration URL. */\n registration?: string;\n }\n enum VisitorType$3 {\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$5 {\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$3 {\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$5 {\n /** Guest RSVP summary. */\n rsvpSummary?: RsvpSummary$4;\n /**\n * Summary of revenue and tickets sold.\n * (Archived orders are not included).\n */\n ticketingSummary?: TicketingSummary$3;\n }\n interface RsvpSummary$4 {\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$3 {\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$6;\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$6;\n }\n interface GuestListConfig$3 {\n /** Whether members can see other members attending the event (defaults to true). */\n publicGuestList?: boolean;\n }\n interface Feed$3 {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing$3 {\n config?: OnlineConferencingConfig$3;\n session?: OnlineConferencingSession$3;\n /**\n * Configured conferencing provider name.\n * @internal\n * @readonly\n */\n providerName?: string;\n }\n interface OnlineConferencingConfig$3 {\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$3;\n }\n enum ConferenceType$3 {\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$3 {\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$3 {\n /** URL slug */\n slug?: string;\n /** Advanced SEO data */\n advancedSeoData?: SeoSchema$3;\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$3 {\n /** SEO tag information. */\n tags?: Tag$3[];\n /** SEO general settings. */\n settings?: Settings$4;\n }\n interface Keyword$3 {\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$3 {\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$4 {\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$3[];\n }\n interface Agenda$3 {\n /** Whether the schedule is enabled for the event. */\n enabled?: boolean;\n /**\n * Agenda page URL.\n * @readonly\n */\n pageUrl?: SiteUrl$3;\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 | null;\n /**\n * Assigned events count. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\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 *\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$6[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\n }\n interface CategoryCounts$3 {\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$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 EventDisplaySettings$3 {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */\n hideEventDetailsPage?: boolean | null;\n }\n interface LabellingSettings$3 {\n /**\n * @internal\n * @readonly\n */\n assignedContactsLegacyLabelId?: string | null;\n /**\n * @internal\n * @readonly\n */\n assignedContactsLabelDeleted?: boolean | null;\n }\n interface DiscardDraftRequest {\n /** Event ID to which the form belongs. */\n eventId: string;\n }\n interface DiscardDraftResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$5 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * 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 * @permissionId WIX_EVENTS.READ_EVENTS\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 * Whether to return additional data with the response.\n * @internal\n */\n fields?: RequestedFields$2[];\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 * @permissionId WIX_EVENTS.MANAGE_EVENTS\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 /**\n * Deprecated. Use radioButton.\n * @internal\n * @deprecated\n */\n radio?: RadioButtonControl;\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 * @permissionId WIX_EVENTS.MANAGE_EVENTS\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 /**\n * Single-choice radio style input control.\n * @internal\n * @deprecated\n */\n radio?: RadioButtonControl;\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 * @permissionId WIX_EVENTS.MANAGE_EVENTS\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 * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @adminMethod\n */\n function updateMessages(eventId: string, options?: UpdateMessagesOptions): Promise;\n interface UpdateMessagesOptions {\n /**\n * Set of field paths, specifying which parts of this resource to update.\n * When fields are empty, request is interpreted as full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\n /** Set of configured form messages. */\n messages?: FormMessages$3;\n }\n /**\n * Publishes the draft form.\n * @public\n * @requiredField eventId\n * @param eventId - Event ID to which the form belongs.\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\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 * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @adminMethod\n */\n function discardDraft(eventId: string): Promise;\n \n type eventsV1Form_universal_d_FormInputControlAdded = FormInputControlAdded;\n type eventsV1Form_universal_d_FormInputControlUpdated = FormInputControlUpdated;\n type eventsV1Form_universal_d_FormInputControlDeleted = FormInputControlDeleted;\n type eventsV1Form_universal_d_GetFormRequest = GetFormRequest;\n type eventsV1Form_universal_d_GetFormResponse = GetFormResponse;\n type eventsV1Form_universal_d_AddControlRequest = AddControlRequest;\n type eventsV1Form_universal_d_AddControlRequestControlOneOf = AddControlRequestControlOneOf;\n type eventsV1Form_universal_d_PhoneControl = PhoneControl;\n type eventsV1Form_universal_d_AddressControl = AddressControl;\n type eventsV1Form_universal_d_AddressControlLabels = AddressControlLabels;\n type eventsV1Form_universal_d_DateControl = DateControl;\n type eventsV1Form_universal_d_AdditionalGuestsControl = AdditionalGuestsControl;\n type eventsV1Form_universal_d_Labels = Labels;\n type eventsV1Form_universal_d_DropdownControl = DropdownControl;\n type eventsV1Form_universal_d_RadioButtonControl = RadioButtonControl;\n type eventsV1Form_universal_d_CheckboxControl = CheckboxControl;\n type eventsV1Form_universal_d_TextControl = TextControl;\n type eventsV1Form_universal_d_AddControlResponse = AddControlResponse;\n type eventsV1Form_universal_d_UpdateControlRequest = UpdateControlRequest;\n type eventsV1Form_universal_d_UpdateControlRequestControlOneOf = UpdateControlRequestControlOneOf;\n type eventsV1Form_universal_d_NameControl = NameControl;\n type eventsV1Form_universal_d_NameControlLabels = NameControlLabels;\n type eventsV1Form_universal_d_EmailControl = EmailControl;\n type eventsV1Form_universal_d_UpdateControlResponse = UpdateControlResponse;\n type eventsV1Form_universal_d_DeleteControlRequest = DeleteControlRequest;\n type eventsV1Form_universal_d_DeleteControlResponse = DeleteControlResponse;\n type eventsV1Form_universal_d_UpdateMessagesRequest = UpdateMessagesRequest;\n type eventsV1Form_universal_d_UpdateMessagesResponse = UpdateMessagesResponse;\n type eventsV1Form_universal_d_PublishDraftRequest = PublishDraftRequest;\n type eventsV1Form_universal_d_PublishDraftResponse = PublishDraftResponse;\n type eventsV1Form_universal_d_DiscardDraftRequest = DiscardDraftRequest;\n type eventsV1Form_universal_d_DiscardDraftResponse = DiscardDraftResponse;\n const eventsV1Form_universal_d_getForm: typeof getForm;\n type eventsV1Form_universal_d_GetFormOptions = GetFormOptions;\n const eventsV1Form_universal_d_addControl: typeof addControl;\n type eventsV1Form_universal_d_AddControlOptions = AddControlOptions;\n const eventsV1Form_universal_d_updateControl: typeof updateControl;\n type eventsV1Form_universal_d_UpdateControlIdentifiers = UpdateControlIdentifiers;\n type eventsV1Form_universal_d_UpdateControlOptions = UpdateControlOptions;\n const eventsV1Form_universal_d_deleteControl: typeof deleteControl;\n type eventsV1Form_universal_d_DeleteControlIdentifiers = DeleteControlIdentifiers;\n const eventsV1Form_universal_d_updateMessages: typeof updateMessages;\n type eventsV1Form_universal_d_UpdateMessagesOptions = UpdateMessagesOptions;\n const eventsV1Form_universal_d_publishDraft: typeof publishDraft;\n const eventsV1Form_universal_d_discardDraft: typeof discardDraft;\n namespace eventsV1Form_universal_d {\n export {\n Form$3 as Form,\n InputControl$3 as InputControl,\n InputControlType$3 as InputControlType,\n Input$3 as Input,\n ValueType$3 as ValueType,\n OptionSelection$3 as OptionSelection,\n OptionSelectionSelectedOptionOneOf$3 as OptionSelectionSelectedOptionOneOf,\n Label$3 as Label,\n FormMessages$3 as FormMessages,\n RsvpFormMessages$3 as RsvpFormMessages,\n PositiveResponseConfirmation$3 as PositiveResponseConfirmation,\n NegativeResponseConfirmation$3 as NegativeResponseConfirmation,\n Positive$3 as Positive,\n Negative$3 as Negative,\n CheckoutFormMessages$3 as CheckoutFormMessages,\n ResponseConfirmation$3 as ResponseConfirmation,\n RegistrationClosedMessages$3 as RegistrationClosedMessages,\n TicketsUnavailableMessages$3 as TicketsUnavailableMessages,\n eventsV1Form_universal_d_FormInputControlAdded as FormInputControlAdded,\n eventsV1Form_universal_d_FormInputControlUpdated as FormInputControlUpdated,\n eventsV1Form_universal_d_FormInputControlDeleted as FormInputControlDeleted,\n eventsV1Form_universal_d_GetFormRequest as GetFormRequest,\n RequestedFields$2 as RequestedFields,\n eventsV1Form_universal_d_GetFormResponse as GetFormResponse,\n eventsV1Form_universal_d_AddControlRequest as AddControlRequest,\n eventsV1Form_universal_d_AddControlRequestControlOneOf as AddControlRequestControlOneOf,\n eventsV1Form_universal_d_PhoneControl as PhoneControl,\n eventsV1Form_universal_d_AddressControl as AddressControl,\n eventsV1Form_universal_d_AddressControlLabels as AddressControlLabels,\n eventsV1Form_universal_d_DateControl as DateControl,\n eventsV1Form_universal_d_AdditionalGuestsControl as AdditionalGuestsControl,\n eventsV1Form_universal_d_Labels as Labels,\n eventsV1Form_universal_d_DropdownControl as DropdownControl,\n eventsV1Form_universal_d_RadioButtonControl as RadioButtonControl,\n eventsV1Form_universal_d_CheckboxControl as CheckboxControl,\n eventsV1Form_universal_d_TextControl as TextControl,\n eventsV1Form_universal_d_AddControlResponse as AddControlResponse,\n eventsV1Form_universal_d_UpdateControlRequest as UpdateControlRequest,\n eventsV1Form_universal_d_UpdateControlRequestControlOneOf as UpdateControlRequestControlOneOf,\n eventsV1Form_universal_d_NameControl as NameControl,\n eventsV1Form_universal_d_NameControlLabels as NameControlLabels,\n eventsV1Form_universal_d_EmailControl as EmailControl,\n eventsV1Form_universal_d_UpdateControlResponse as UpdateControlResponse,\n eventsV1Form_universal_d_DeleteControlRequest as DeleteControlRequest,\n eventsV1Form_universal_d_DeleteControlResponse as DeleteControlResponse,\n eventsV1Form_universal_d_UpdateMessagesRequest as UpdateMessagesRequest,\n eventsV1Form_universal_d_UpdateMessagesResponse as UpdateMessagesResponse,\n eventsV1Form_universal_d_PublishDraftRequest as PublishDraftRequest,\n eventsV1Form_universal_d_PublishDraftResponse as PublishDraftResponse,\n EventUpdated$2 as EventUpdated,\n Location$5 as Location,\n MapCoordinates$5 as MapCoordinates,\n LocationType$5 as LocationType,\n Address$8 as Address,\n AddressStreetOneOf$8 as AddressStreetOneOf,\n StreetAddress$8 as StreetAddress,\n AddressLocation$8 as AddressLocation,\n Subdivision$8 as Subdivision,\n SubdivisionType$8 as SubdivisionType,\n ScheduleConfig$5 as ScheduleConfig,\n Recurrences$5 as Recurrences,\n Occurrence$5 as Occurrence,\n Status$5 as Status,\n Event$3 as Event,\n Scheduling$3 as Scheduling,\n EventStatus$5 as EventStatus,\n Registration$3 as Registration,\n EventType$3 as EventType,\n RegistrationStatus$3 as RegistrationStatus,\n RsvpCollection$3 as RsvpCollection,\n RsvpCollectionConfig$3 as RsvpCollectionConfig,\n RsvpStatusOptions$3 as RsvpStatusOptions,\n Ticketing$3 as Ticketing,\n TicketingConfig$3 as TicketingConfig,\n TaxConfig$3 as TaxConfig,\n TaxType$4 as TaxType,\n Money$6 as Money,\n ExternalEvent$3 as ExternalEvent,\n VisitorType$3 as VisitorType,\n CalendarLinks$5 as CalendarLinks,\n SiteUrl$3 as SiteUrl,\n Dashboard$5 as Dashboard,\n RsvpSummary$4 as RsvpSummary,\n TicketingSummary$3 as TicketingSummary,\n GuestListConfig$3 as GuestListConfig,\n Feed$3 as Feed,\n OnlineConferencing$3 as OnlineConferencing,\n OnlineConferencingConfig$3 as OnlineConferencingConfig,\n ConferenceType$3 as ConferenceType,\n OnlineConferencingSession$3 as OnlineConferencingSession,\n SeoSettings$3 as SeoSettings,\n SeoSchema$3 as SeoSchema,\n Keyword$3 as Keyword,\n Tag$3 as Tag,\n Settings$4 as Settings,\n Agenda$3 as Agenda,\n Category$3 as Category,\n CategoryCounts$3 as CategoryCounts,\n State$6 as State,\n EventDisplaySettings$3 as EventDisplaySettings,\n LabellingSettings$3 as LabellingSettings,\n eventsV1Form_universal_d_DiscardDraftRequest as DiscardDraftRequest,\n eventsV1Form_universal_d_DiscardDraftResponse as DiscardDraftResponse,\n DomainEvent$5 as DomainEvent,\n DomainEventBodyOneOf$5 as DomainEventBodyOneOf,\n EntityCreatedEvent$5 as EntityCreatedEvent,\n RestoreInfo$5 as RestoreInfo,\n EntityUpdatedEvent$5 as EntityUpdatedEvent,\n EntityDeletedEvent$5 as EntityDeletedEvent,\n ActionEvent$5 as ActionEvent,\n MessageEnvelope$9 as MessageEnvelope,\n IdentificationData$9 as IdentificationData,\n IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf,\n WebhookIdentityType$9 as WebhookIdentityType,\n eventsV1Form_universal_d_getForm as getForm,\n eventsV1Form_universal_d_GetFormOptions as GetFormOptions,\n eventsV1Form_universal_d_addControl as addControl,\n eventsV1Form_universal_d_AddControlOptions as AddControlOptions,\n eventsV1Form_universal_d_updateControl as updateControl,\n eventsV1Form_universal_d_UpdateControlIdentifiers as UpdateControlIdentifiers,\n eventsV1Form_universal_d_UpdateControlOptions as UpdateControlOptions,\n eventsV1Form_universal_d_deleteControl as deleteControl,\n eventsV1Form_universal_d_DeleteControlIdentifiers as DeleteControlIdentifiers,\n eventsV1Form_universal_d_updateMessages as updateMessages,\n eventsV1Form_universal_d_UpdateMessagesOptions as UpdateMessagesOptions,\n eventsV1Form_universal_d_publishDraft as publishDraft,\n eventsV1Form_universal_d_discardDraft as discardDraft,\n };\n }\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 | null;\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$3;\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$5;\n /** Ticket PDF URL. */\n ticketsPdf?: string;\n /** Tickets (generated after payment). */\n tickets?: TicketingTicket$1[];\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;\n /** Whether all tickets in order are checked-in. */\n fullyCheckedIn?: boolean;\n /**\n * Deprecated. Use `payment_details.transaction.transaction_id`.\n * @internal\n * @readonly\n * @deprecated\n */\n transactionId?: string;\n /** Internal order payment details */\n paymentDetails?: PaymentDetails;\n /** Checkout channel type */\n channel?: ChannelType$1;\n /**\n * Language in which Order was created.\n * @internal\n */\n language?: string | null;\n /**\n * Locale in which Order was created.\n * @internal\n */\n locale?: string | null;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date | null;\n /**\n * Possible order actions.\n * @internal\n * @readonly\n */\n availableActions?: Action[];\n /**\n * Gift card payments.\n * @internal\n */\n giftCardPaymentDetails?: GiftCardPaymentDetails[];\n /**\n * Balance summary.\n * @internal\n */\n balanceSummary?: BalanceSummary;\n }\n interface FormResponse$3 {\n /** Input fields for a checkout form. */\n inputValues?: InputValue$3[];\n }\n interface InputValue$3 {\n /** Input field name. */\n inputName?: string;\n /** Input field value. */\n value?: string;\n /** Multiple input field values. */\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date | null;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress$3;\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$7;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision$7[];\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$7;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\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 OrderStatus$1 {\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 Money$5 {\n /**\n * *Deprecated:** Use `value` instead.\n * @deprecated\n */\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, starts with a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface TicketingTicket$1 {\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$5;\n /**\n * Whether the ticket requires payment.\n * @readonly\n */\n free?: boolean;\n /** Event and ticket policies. */\n policy?: string;\n /**\n * Deprecated, use `check_in_url`.\n * @deprecated\n */\n qrCode?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$2;\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 /**\n * Deprecated, use `ticket_pdf_url`.\n * @deprecated\n */\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$1;\n /**\n * URL to download ticket in the `.pkpass` format for Apple Wallet\n * @readonly\n */\n walletPassUrl?: string;\n /**\n * Additional ticket details.\n * @internal\n * @readonly\n */\n ticketDetails?: TicketDetails$1;\n }\n interface CheckIn$2 {\n /** Time of check-in */\n created?: Date | null;\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$3;\n /** Contact ID associated with this guest. */\n contactId?: string | null;\n /** Guest phone number. */\n phone?: string | null;\n }\n enum ChannelType$1 {\n /** Buyer created the order via an online channel such as a website or mobile app. */\n ONLINE = \"ONLINE\",\n /** Sales person created the order and collected the money. */\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 name.\n * @internal\n * @readonly\n */\n sectorName?: string | null;\n /**\n * Area name.\n * @internal\n * @readonly\n */\n areaName?: string | null;\n /**\n * Table name.\n * @internal\n * @readonly\n */\n tableName?: string | null;\n /**\n * Row label.\n * @internal\n * @readonly\n */\n rowNumber?: string | null;\n /**\n * Seat label in a row or table.\n * @internal\n * @readonly\n */\n seatNumber?: 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 {\n /** Items listed in the invoice. */\n items?: Item$1[];\n /**\n * Total cart amount.\n * @deprecated\n */\n total?: Money$5;\n /** Discount applied to a cart. */\n discount?: Discount;\n /** Tax applied to cart. */\n tax?: Tax;\n /** Total cart amount before discount, tax, and fees. */\n subTotal?: Money$5;\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$5;\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$5;\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 name. */\n name?: string;\n /** Line item price. */\n price?: Money$5;\n /** Total price for line items. It's calculated by multiplying price and item quantity. */\n total?: Money$5;\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 Discount {\n /** Total discount amount. */\n amount?: Money$5;\n /** Total sum after the discount. */\n afterDiscount?: Money$5;\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$5;\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$3;\n /**\n * Tax name.\n * @readonly\n */\n name?: string;\n /** Tax rate. */\n rate?: string;\n /** Taxable amount. */\n taxable?: Money$5;\n /** Total tax amount. */\n amount?: Money$5;\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 {\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$5;\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 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 * Scheduled action.\n * @internal\n * @readonly\n */\n scheduledAction?: ScheduledActionEnumAction;\n /**\n * Scheduled action execution date. Non empty for delayed transactions.\n * @internal\n * @readonly\n */\n scheduledActionExecutionDate?: Date | null;\n }\n enum ScheduledActionEnumAction {\n /** Action not scheduled. */\n UNKNOWN_ACTION = \"UNKNOWN_ACTION\",\n /** Captured after the delay. */\n CAPTURE = \"CAPTURE\",\n /** Void after the delay. */\n VOID = \"VOID\"\n }\n enum Action {\n /** Order can be archived. */\n ARCHIVE = \"ARCHIVE\",\n /** Order can be unarchived. */\n UNARCHIVE = \"UNARCHIVE\",\n /** Order can be confirmed. */\n CONFIRM = \"CONFIRM\",\n /** Order can be captured. */\n CAPTURE = \"CAPTURE\",\n /** Order can be voided. */\n VOID = \"VOID\"\n }\n interface GiftCardPaymentDetails {\n /** Gift card payment id. */\n giftCardPaymentId?: string | null;\n /** ID of the app that created the gift card. */\n appId?: string | null;\n /** Whether the gift card payment is voided. */\n voided?: boolean | null;\n /** Amount */\n amount?: Money$5;\n /** Obfuscated gift card code. */\n obfuscatedCode?: string | null;\n }\n interface BalanceSummary {\n /** Amount left to pay. */\n balance?: Money$5;\n }\n interface OrderDeleted {\n /** Order deleted timestamp in ISO UTC format. */\n timestamp?: Date | 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 | 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$1[];\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 Ticket$1 {\n /** Unique issued ticket number. */\n ticketNumber?: string;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn$2;\n /** Ticket price. */\n price?: Money$5;\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 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 /**\n * Deprecated: use tag = CONFIRMED\n * @internal\n * @deprecated\n */\n confirmed?: boolean | null;\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 /**\n * Deprecated: use tag = MEMBER\n * @internal\n * @deprecated\n */\n membersOnly?: boolean;\n /** Field facets, */\n facet?: string[];\n /**\n * Deprecated: use tag = ARCHIVED / NON_ARCHIVED\n * @internal\n * @deprecated\n */\n archived?: boolean | null;\n /** Search filter. You can search `fullName`, `email` and `orderNumber`. */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Deprecated: use tag = FULLY_CHECKED_IN / NOT_FULLY_CHECKED_IN\n * @internal\n * @deprecated\n */\n fullyCheckedIn?: boolean | null;\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 in the response: `status`, `firstName`, `lastName`, `email`, `created`, etc. */\n DETAILS = \"DETAILS\",\n /** Include `checkoutForm` in the response. */\n FORM = \"FORM\",\n /** Include `invoice` in the response. */\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$5 {\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$2 {\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$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 UpdateOrderRequest {\n /** Event ID to which the order belongs. */\n eventId: string;\n /** Unique order number. */\n orderNumber: string;\n /**\n * Set of field paths to update.\n * @internal\n */\n fields?: string[];\n /** Checkout form. */\n checkoutForm?: FormResponse$3;\n /** Whether order is archived. */\n archived?: boolean;\n /**\n * Only used in tests.\n * @internal\n */\n expires?: Date | null;\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2026-06-01\n */\n silent?: boolean | null;\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 | 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 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 | 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$3;\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 /**\n * Set of fields to update.\n * @internal\n */\n fields?: 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$5;\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$5;\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$5;\n /**\n * Crated date\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Reason code\n * @readonly\n */\n reasonCode?: string | null;\n /**\n * Refunded amount\n * @readonly\n */\n refundedAmount?: Money$5;\n }\n interface CaptureAuthorizedPaymentRequest {\n /** Event ID. */\n eventId?: string;\n /** Order number. */\n orderNumber: string;\n }\n interface CaptureAuthorizedPaymentResponse {\n }\n interface VoidAuthorizedPaymentRequest {\n /** Event ID. */\n eventId?: string;\n /** Order number. */\n orderNumber: string;\n }\n interface VoidAuthorizedPaymentResponse {\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 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 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 | 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$3;\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;\n /** Reservation ID associated with this order. */\n reservationId?: string;\n }\n interface OrderPaid {\n /** Order paid 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 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 | 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$3;\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;\n }\n interface ReservationCreated$1 {\n /** Reservation created timestamp in ISO UTC format. */\n timestamp?: Date | null;\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 | null;\n /** Reservation status. */\n status?: ReservationStatus$1;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity$1[];\n /** Reservation update timestamp. */\n _updatedDate?: Date | null;\n /** Reservation counts. */\n counts?: ReservationCount$1[];\n }\n enum ReservationStatus$1 {\n /** The Reservation is pending confirmation and will expire after the expiration due time. */\n RESERVATION_PENDING = \"RESERVATION_PENDING\",\n /** The reservation is confirmed and will not expire. */\n RESERVATION_CONFIRMED = \"RESERVATION_CONFIRMED\",\n /** The reservation is canceled because of non payment. */\n RESERVATION_CANCELED = \"RESERVATION_CANCELED\",\n /** The reservation is canceled manually by the buyer. */\n RESERVATION_CANCELED_MANUALLY = \"RESERVATION_CANCELED_MANUALLY\",\n /** The reservation is 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 | null;\n }\n interface ReservationCount$1 {\n /** Reservation Count snapshot timestamp. */\n timestamp?: Date | null;\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 | null;\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$1;\n /** Reservation expiration timestamp. */\n expires?: Date | null;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity$1[];\n /** Reservation update timestamp. */\n _updatedDate?: Date | null;\n /** Reservation counts. */\n counts?: ReservationCount$1[];\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 /** Whether gift cards are accepted at checkout. */\n acceptGiftCards?: 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 /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date | null;\n state?: State$5[];\n }\n enum State$5 {\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$2[];\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$2 {\n /** Ticket definition ID. */\n _id?: string;\n /** Ticket price. */\n price?: Money$5;\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$4;\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$5[];\n /** Ticket pricing. */\n pricing?: TicketPricing$1;\n }\n interface Dashboard$4 {\n /** Whether ticket is hidden and cannot be sold. */\n hidden?: boolean;\n /**\n * Number of tickets sold and reserved.\n * @deprecated\n */\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$1;\n }\n interface TicketSalePeriod$1 {\n /** Ticket sale start timestamp. */\n startDate?: Date | null;\n /** Ticket sale end timestamp. */\n endDate?: Date | null;\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$5;\n /** Min price per ticket, customizable. */\n minPrice?: Money$5;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions$2;\n /**\n * Ticket pricing type.\n * @readonly\n */\n pricingType?: Type$4;\n }\n /** @oneof */\n interface TicketPricingPriceOneOf$1 {\n /** Ticket price which is read only. */\n fixedPrice?: Money$5;\n /** Min price per ticket, customizable. */\n minPrice?: Money$5;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions$2;\n }\n interface PricingOptions$2 {\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$5;\n }\n enum Type$4 {\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$2[];\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 /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date | null;\n /** Whether to allow reservation for hidden tickets. */\n allowHiddenTickets?: boolean;\n /**\n * Whether to exclude Wix fee.\n * @internal\n */\n excludeFee?: boolean;\n /**\n * Whether to skip `ticketQuantities.ticketDetails.priceOverride` min validation.\n * @internal\n */\n skipPriceOverrideValidation?: 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 | null;\n /** Ticket reservations. */\n reservations?: TicketReservation[];\n /** Reservation invoice. */\n invoice?: Invoice;\n }\n interface TicketReservation {\n /** Quantity of reserved tickets. */\n quantity?: number;\n /** An object containing ticket information. */\n ticket?: TicketDefinition$2;\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 * Gift card code.\n * @internal\n */\n giftCardCode?: string | null;\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;\n /** Discount errors, if relevant. */\n discountErrors?: DiscountErrors;\n /** Reservation expiration time. */\n expires?: Date | null;\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$1;\n /** Whether this reservation is already used in checkout. */\n reservationOccupied?: boolean;\n /** Ticket reservations. */\n reservations?: TicketReservation[];\n /**\n * Gift card payments.\n * @internal\n */\n giftCardPaymentDetails?: GiftCardPaymentDetails[];\n /**\n * Balance summary.\n * @internal\n */\n balanceSummary?: BalanceSummary;\n /**\n * Gift card errors, if relevant.\n * @internal\n */\n giftCardErrors?: GiftCardErrors;\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 GiftCardErrors {\n /** Error. */\n error?: GiftCardErrorsError[];\n }\n interface GiftCardErrorsError {\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 /**\n * Deprecated.\n * @internal\n * @deprecated\n */\n silent?: boolean;\n /**\n * Deprecated.\n * @internal\n * @deprecated\n */\n payInPerson?: boolean;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest$2[];\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n /** Options controlling the checkout process. */\n options?: CheckoutOptions;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date | null;\n /**\n * Gift card code.\n * @internal\n */\n giftCardCode?: string | null;\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$2 {\n /** Specific guest info. */\n form?: FormResponse$3;\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 /**\n * URL which overrides default payment redirect URL.\n * @internal\n */\n paymentRedirectUrl?: string | null;\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 | null;\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 | 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 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 | null;\n /**\n * Order updated timestamp.\n * @readonly\n */\n updated?: Date | null;\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$3;\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;\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$2[];\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 * Payment details id.\n * @internal\n */\n paymentDetailsId?: string | null;\n /**\n * Payment method.\n * @internal\n */\n paymentMethod?: string | null;\n /**\n * Gift card code.\n * @internal\n */\n giftCardCode?: string | null;\n }\n interface UpdateCheckoutResponse {\n /** Updated order. */\n order?: Order;\n /** Order page URL. */\n orderPageUrl?: string | null;\n /**\n * Payment response token.\n * @internal\n */\n chargeToken?: string | null;\n /**\n * Order page URL.\n * @internal\n */\n orderPageUrls?: OrderPageUrls;\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 | null;\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 * @permissionId WIX_EVENTS.READ_ORDERS\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 /**\n * Deprecated: use tag = CONFIRMED\n * @internal\n * @deprecated\n */\n confirmed?: boolean | null;\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 /**\n * Deprecated: use tag = MEMBER\n * @internal\n * @deprecated\n */\n membersOnly?: boolean;\n /** Field facets. */\n facet?: string[];\n /**\n * Deprecated: use tag = ARCHIVED / NON_ARCHIVED\n * @internal\n * @deprecated\n */\n archived?: boolean | null;\n /** Search filter. You can search `fullName`, `email` and `orderNumber`. */\n searchPhrase?: string;\n /** Event creator ID. */\n eventCreatorId?: string[];\n /**\n * Deprecated: use tag = FULLY_CHECKED_IN / NOT_FULLY_CHECKED_IN\n * @internal\n * @deprecated\n */\n fullyCheckedIn?: boolean | null;\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 * @permissionId WIX_EVENTS.READ_ORDERS\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 * @permissionId WIX_EVENTS.MANAGE_ORDERS\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 /**\n * Set of field paths to update.\n * @internal\n */\n fields?: string[];\n /** Checkout form. */\n checkoutForm?: FormResponse$3;\n /** Whether order is archived. */\n archived?: boolean;\n /**\n * Only used in tests.\n * @internal\n */\n expires?: Date | null;\n /**\n * @internal\n * @deprecated\n * @targetRemovalDate 2026-06-01\n */\n silent?: boolean | null;\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 * @permissionId WIX_EVENTS.MANAGE_ORDERS\n * @adminMethod\n */\n function bulkUpdateOrders(eventId: string, options?: BulkUpdateOrdersOptions): Promise;\n interface BulkUpdateOrdersOptions {\n /** Unique order number. */\n orderNumber?: string[];\n /**\n * Set of fields to update.\n * @internal\n */\n fields?: 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 * @permissionId WIX_EVENTS.MANAGE_ORDERS\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 * @permissionId WIX_EVENTS.READ_ORDERS\n * @adminMethod\n */\n function getSummary(options?: GetSummaryOptions): Promise;\n interface GetSummaryOptions {\n /** Event ID. */\n eventId?: string | null;\n }\n /**\n * Returns invoice preview. Works only for PAID orders.\n * @internal\n * @requiredField identifiers\n * @requiredField identifiers.eventId\n * @requiredField identifiers.orderNumber\n * @permissionId WIX_EVENTS.READ_ORDERS\n * @adminMethod\n */\n function getInvoicePreview(identifiers: GetInvoicePreviewIdentifiers): Promise;\n interface GetInvoicePreviewIdentifiers {\n /** Event ID to which the invoice belongs. */\n eventId: string;\n /** Order number. */\n orderNumber: string;\n }\n /**\n * Captures authorized payment asynchronously.\n * Eventually order will become paid.\n * For orders with non-authorized payments request will fail.\n * @param orderNumber - Order number.\n * @public\n * @documentationMaturity preview\n * @requiredField orderNumber\n * @permissionId WIX_EVENTS.MANAGE_ORDERS\n * @adminMethod\n */\n function captureAuthorizedPayment(orderNumber: string, options?: CaptureAuthorizedPaymentOptions): Promise;\n interface CaptureAuthorizedPaymentOptions {\n /** Event ID. */\n eventId?: string;\n }\n /**\n * Voids authorized payment asynchronously.\n * Eventually order will become voided.\n * For orders with non-authorized payments request will fail.\n * @param orderNumber - Order number.\n * @public\n * @documentationMaturity preview\n * @requiredField orderNumber\n * @permissionId WIX_EVENTS.MANAGE_ORDERS\n * @adminMethod\n */\n function voidAuthorizedPayment(orderNumber: string, options?: VoidAuthorizedPaymentOptions): Promise;\n interface VoidAuthorizedPaymentOptions {\n /** Event ID. */\n eventId?: string;\n }\n /**\n * Retrieves checkout details.\n * @public\n * @permissionId WIX_EVENTS.READ_CHECKOUT\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 * @permissionId WIX_EVENTS.READ_CHECKOUT\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 /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date | null;\n state?: State$5[];\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 * @permissionId WIX_EVENTS.READ_CHECKOUT\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 * @permissionId WIX_EVENTS.CHECKOUT\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 /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date | null;\n /** Whether to allow reservation for hidden tickets. */\n allowHiddenTickets?: boolean;\n /**\n * Whether to exclude Wix fee.\n * @internal\n */\n excludeFee?: boolean;\n /**\n * Whether to skip `ticketQuantities.ticketDetails.priceOverride` min validation.\n * @internal\n */\n skipPriceOverrideValidation?: 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 * @permissionId WIX_EVENTS.CHECKOUT\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 * @permissionId WIX_EVENTS.READ_INVOICE\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 * Gift card code.\n * @internal\n */\n giftCardCode?: string | null;\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 * @permissionId WIX_EVENTS.CHECKOUT\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 /**\n * Deprecated.\n * @internal\n * @deprecated\n */\n silent?: boolean;\n /**\n * Deprecated.\n * @internal\n * @deprecated\n */\n payInPerson?: boolean;\n /** Buyer details. */\n buyer?: Buyer;\n /** Guest details. */\n guests?: Guest$2[];\n /** Benefit granted by the pricing plan. */\n paidPlanBenefit?: PaidPlanBenefit;\n /** Options controlling the checkout process. */\n options?: CheckoutOptions;\n /**\n * Only used in tests.\n * @internal\n */\n overrideRequestTime?: Date | null;\n /**\n * Gift card code.\n * @internal\n */\n giftCardCode?: string | null;\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 * @permissionId WIX_EVENTS.CHECKOUT\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$2[];\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 * Payment details id.\n * @internal\n */\n paymentDetailsId?: string | null;\n /**\n * Payment method.\n * @internal\n */\n paymentMethod?: string | null;\n /**\n * Gift card code.\n * @internal\n */\n giftCardCode?: string | null;\n }\n /**\n * Creates order with payment details already initiated via Cashier Pay API.\n * @public\n * @requiredField eventId\n * @requiredField options.reservationId\n * @param eventId - Event ID to which the checkout belongs.\n * @permissionId WIX_EVENTS.MANAGE_ORDERS\n * @adminMethod\n */\n function posCheckout(eventId: string, options?: PosCheckoutOptions): Promise;\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 \n type eventsV1Order_universal_d_Order = Order;\n type eventsV1Order_universal_d_Invoice = Invoice;\n type eventsV1Order_universal_d_Discount = Discount;\n type eventsV1Order_universal_d_DiscountItem = DiscountItem;\n type eventsV1Order_universal_d_DiscountItemDiscountOneOf = DiscountItemDiscountOneOf;\n type eventsV1Order_universal_d_CouponDiscount = CouponDiscount;\n type eventsV1Order_universal_d_PaidPlanDiscount = PaidPlanDiscount;\n type eventsV1Order_universal_d_PaidPlanDiscountDiscountOneOf = PaidPlanDiscountDiscountOneOf;\n type eventsV1Order_universal_d_PercentDiscount = PercentDiscount;\n type eventsV1Order_universal_d_Tax = Tax;\n type eventsV1Order_universal_d_Fee = Fee;\n type eventsV1Order_universal_d_FeeName = FeeName;\n const eventsV1Order_universal_d_FeeName: typeof FeeName;\n type eventsV1Order_universal_d_PaymentDetails = PaymentDetails;\n type eventsV1Order_universal_d_PaymentTransaction = PaymentTransaction;\n type eventsV1Order_universal_d_ScheduledActionEnumAction = ScheduledActionEnumAction;\n const eventsV1Order_universal_d_ScheduledActionEnumAction: typeof ScheduledActionEnumAction;\n type eventsV1Order_universal_d_Action = Action;\n const eventsV1Order_universal_d_Action: typeof Action;\n type eventsV1Order_universal_d_GiftCardPaymentDetails = GiftCardPaymentDetails;\n type eventsV1Order_universal_d_BalanceSummary = BalanceSummary;\n type eventsV1Order_universal_d_OrderDeleted = OrderDeleted;\n type eventsV1Order_universal_d_OrderType = OrderType;\n const eventsV1Order_universal_d_OrderType: typeof OrderType;\n type eventsV1Order_universal_d_ListOrdersRequest = ListOrdersRequest;\n type eventsV1Order_universal_d_OrderFieldset = OrderFieldset;\n const eventsV1Order_universal_d_OrderFieldset: typeof OrderFieldset;\n type eventsV1Order_universal_d_OrderTag = OrderTag;\n const eventsV1Order_universal_d_OrderTag: typeof OrderTag;\n type eventsV1Order_universal_d_ListOrdersResponse = ListOrdersResponse;\n type eventsV1Order_universal_d_OrderFacets = OrderFacets;\n type eventsV1Order_universal_d_OrderFacetCounts = OrderFacetCounts;\n type eventsV1Order_universal_d_GetOrderRequest = GetOrderRequest;\n type eventsV1Order_universal_d_GetOrderResponse = GetOrderResponse;\n type eventsV1Order_universal_d_UpdateOrderRequest = UpdateOrderRequest;\n type eventsV1Order_universal_d_UpdateOrderResponse = UpdateOrderResponse;\n type eventsV1Order_universal_d_BulkUpdateOrdersRequest = BulkUpdateOrdersRequest;\n type eventsV1Order_universal_d_BulkUpdateOrdersResponse = BulkUpdateOrdersResponse;\n type eventsV1Order_universal_d_ConfirmOrderRequest = ConfirmOrderRequest;\n type eventsV1Order_universal_d_ConfirmOrderResponse = ConfirmOrderResponse;\n type eventsV1Order_universal_d_GetSummaryRequest = GetSummaryRequest;\n type eventsV1Order_universal_d_GetSummaryResponse = GetSummaryResponse;\n type eventsV1Order_universal_d_TicketSales = TicketSales;\n type eventsV1Order_universal_d_GetInvoicePreviewRequest = GetInvoicePreviewRequest;\n type eventsV1Order_universal_d_RawHttpResponse = RawHttpResponse;\n type eventsV1Order_universal_d_HeadersEntry = HeadersEntry;\n type eventsV1Order_universal_d_GetPaymentInfoRequest = GetPaymentInfoRequest;\n type eventsV1Order_universal_d_GetPaymentInfoResponse = GetPaymentInfoResponse;\n type eventsV1Order_universal_d_PaymentTransactionSummary = PaymentTransactionSummary;\n type eventsV1Order_universal_d_PaymentTransactionEvent = PaymentTransactionEvent;\n type eventsV1Order_universal_d_CaptureAuthorizedPaymentRequest = CaptureAuthorizedPaymentRequest;\n type eventsV1Order_universal_d_CaptureAuthorizedPaymentResponse = CaptureAuthorizedPaymentResponse;\n type eventsV1Order_universal_d_VoidAuthorizedPaymentRequest = VoidAuthorizedPaymentRequest;\n type eventsV1Order_universal_d_VoidAuthorizedPaymentResponse = VoidAuthorizedPaymentResponse;\n type eventsV1Order_universal_d_OrderConfirmed = OrderConfirmed;\n type eventsV1Order_universal_d_OrderPaid = OrderPaid;\n type eventsV1Order_universal_d_GetCheckoutOptionsRequest = GetCheckoutOptionsRequest;\n type eventsV1Order_universal_d_GetCheckoutOptionsResponse = GetCheckoutOptionsResponse;\n type eventsV1Order_universal_d_ListAvailableTicketsRequest = ListAvailableTicketsRequest;\n type eventsV1Order_universal_d_ListAvailableTicketsResponse = ListAvailableTicketsResponse;\n type eventsV1Order_universal_d_QueryAvailableTicketsRequest = QueryAvailableTicketsRequest;\n type eventsV1Order_universal_d_QueryAvailableTicketsResponse = QueryAvailableTicketsResponse;\n type eventsV1Order_universal_d_CreateReservationRequest = CreateReservationRequest;\n type eventsV1Order_universal_d_TicketReservationQuantity = TicketReservationQuantity;\n type eventsV1Order_universal_d_CreateReservationResponse = CreateReservationResponse;\n type eventsV1Order_universal_d_TicketReservation = TicketReservation;\n type eventsV1Order_universal_d_CancelReservationRequest = CancelReservationRequest;\n type eventsV1Order_universal_d_CancelReservationResponse = CancelReservationResponse;\n type eventsV1Order_universal_d_GetInvoiceRequest = GetInvoiceRequest;\n type eventsV1Order_universal_d_DiscountRequest = DiscountRequest;\n type eventsV1Order_universal_d_PaidPlanBenefit = PaidPlanBenefit;\n type eventsV1Order_universal_d_GetInvoiceResponse = GetInvoiceResponse;\n type eventsV1Order_universal_d_DiscountErrors = DiscountErrors;\n type eventsV1Order_universal_d_Error = Error;\n type eventsV1Order_universal_d_GiftCardErrors = GiftCardErrors;\n type eventsV1Order_universal_d_GiftCardErrorsError = GiftCardErrorsError;\n type eventsV1Order_universal_d_CheckoutRequest = CheckoutRequest;\n type eventsV1Order_universal_d_Buyer = Buyer;\n type eventsV1Order_universal_d_CheckoutOptions = CheckoutOptions;\n type eventsV1Order_universal_d_CheckoutResponse = CheckoutResponse;\n type eventsV1Order_universal_d_OrderInitiated = OrderInitiated;\n type eventsV1Order_universal_d_UpdateCheckoutRequest = UpdateCheckoutRequest;\n type eventsV1Order_universal_d_UpdateCheckoutResponse = UpdateCheckoutResponse;\n type eventsV1Order_universal_d_OrderPageUrls = OrderPageUrls;\n type eventsV1Order_universal_d_PosCheckoutRequest = PosCheckoutRequest;\n type eventsV1Order_universal_d_PosCheckoutResponse = PosCheckoutResponse;\n const eventsV1Order_universal_d_listOrders: typeof listOrders;\n type eventsV1Order_universal_d_ListOrdersOptions = ListOrdersOptions;\n const eventsV1Order_universal_d_getOrder: typeof getOrder;\n type eventsV1Order_universal_d_GetOrderIdentifiers = GetOrderIdentifiers;\n type eventsV1Order_universal_d_GetOrderOptions = GetOrderOptions;\n const eventsV1Order_universal_d_updateOrder: typeof updateOrder;\n type eventsV1Order_universal_d_UpdateOrderIdentifiers = UpdateOrderIdentifiers;\n type eventsV1Order_universal_d_UpdateOrderOptions = UpdateOrderOptions;\n const eventsV1Order_universal_d_bulkUpdateOrders: typeof bulkUpdateOrders;\n type eventsV1Order_universal_d_BulkUpdateOrdersOptions = BulkUpdateOrdersOptions;\n const eventsV1Order_universal_d_confirmOrder: typeof confirmOrder;\n type eventsV1Order_universal_d_ConfirmOrderOptions = ConfirmOrderOptions;\n const eventsV1Order_universal_d_getSummary: typeof getSummary;\n type eventsV1Order_universal_d_GetSummaryOptions = GetSummaryOptions;\n const eventsV1Order_universal_d_getInvoicePreview: typeof getInvoicePreview;\n type eventsV1Order_universal_d_GetInvoicePreviewIdentifiers = GetInvoicePreviewIdentifiers;\n const eventsV1Order_universal_d_captureAuthorizedPayment: typeof captureAuthorizedPayment;\n type eventsV1Order_universal_d_CaptureAuthorizedPaymentOptions = CaptureAuthorizedPaymentOptions;\n const eventsV1Order_universal_d_voidAuthorizedPayment: typeof voidAuthorizedPayment;\n type eventsV1Order_universal_d_VoidAuthorizedPaymentOptions = VoidAuthorizedPaymentOptions;\n const eventsV1Order_universal_d_getCheckoutOptions: typeof getCheckoutOptions;\n const eventsV1Order_universal_d_listAvailableTickets: typeof listAvailableTickets;\n type eventsV1Order_universal_d_ListAvailableTicketsOptions = ListAvailableTicketsOptions;\n const eventsV1Order_universal_d_queryAvailableTickets: typeof queryAvailableTickets;\n type eventsV1Order_universal_d_QueryAvailableTicketsOptions = QueryAvailableTicketsOptions;\n const eventsV1Order_universal_d_createReservation: typeof createReservation;\n type eventsV1Order_universal_d_CreateReservationOptions = CreateReservationOptions;\n const eventsV1Order_universal_d_cancelReservation: typeof cancelReservation;\n const eventsV1Order_universal_d_getInvoice: typeof getInvoice;\n type eventsV1Order_universal_d_GetInvoiceOptions = GetInvoiceOptions;\n const eventsV1Order_universal_d_checkout: typeof checkout;\n type eventsV1Order_universal_d_CheckoutOptionsForRequest = CheckoutOptionsForRequest;\n const eventsV1Order_universal_d_updateCheckout: typeof updateCheckout;\n type eventsV1Order_universal_d_UpdateCheckoutOptions = UpdateCheckoutOptions;\n const eventsV1Order_universal_d_posCheckout: typeof posCheckout;\n type eventsV1Order_universal_d_PosCheckoutOptions = PosCheckoutOptions;\n namespace eventsV1Order_universal_d {\n export {\n eventsV1Order_universal_d_Order as Order,\n FormResponse$3 as FormResponse,\n InputValue$3 as InputValue,\n FormattedAddress$3 as FormattedAddress,\n Address$7 as Address,\n AddressStreetOneOf$7 as AddressStreetOneOf,\n StreetAddress$7 as StreetAddress,\n AddressLocation$7 as AddressLocation,\n Subdivision$7 as Subdivision,\n SubdivisionType$7 as SubdivisionType,\n StandardDetails$3 as StandardDetails,\n OrderStatus$1 as OrderStatus,\n Money$5 as Money,\n TicketingTicket$1 as TicketingTicket,\n CheckIn$2 as CheckIn,\n GuestDetails$1 as GuestDetails,\n ChannelType$1 as ChannelType,\n TicketDetails$1 as TicketDetails,\n eventsV1Order_universal_d_Invoice as Invoice,\n Item$1 as Item,\n eventsV1Order_universal_d_Discount as Discount,\n eventsV1Order_universal_d_DiscountItem as DiscountItem,\n eventsV1Order_universal_d_DiscountItemDiscountOneOf as DiscountItemDiscountOneOf,\n eventsV1Order_universal_d_CouponDiscount as CouponDiscount,\n eventsV1Order_universal_d_PaidPlanDiscount as PaidPlanDiscount,\n eventsV1Order_universal_d_PaidPlanDiscountDiscountOneOf as PaidPlanDiscountDiscountOneOf,\n eventsV1Order_universal_d_PercentDiscount as PercentDiscount,\n eventsV1Order_universal_d_Tax as Tax,\n TaxType$3 as TaxType,\n eventsV1Order_universal_d_Fee as Fee,\n eventsV1Order_universal_d_FeeName as FeeName,\n FeeType$1 as FeeType,\n eventsV1Order_universal_d_PaymentDetails as PaymentDetails,\n eventsV1Order_universal_d_PaymentTransaction as PaymentTransaction,\n eventsV1Order_universal_d_ScheduledActionEnumAction as ScheduledActionEnumAction,\n eventsV1Order_universal_d_Action as Action,\n eventsV1Order_universal_d_GiftCardPaymentDetails as GiftCardPaymentDetails,\n eventsV1Order_universal_d_BalanceSummary as BalanceSummary,\n eventsV1Order_universal_d_OrderDeleted as OrderDeleted,\n eventsV1Order_universal_d_OrderType as OrderType,\n Ticket$1 as Ticket,\n OnlineConferencingLogin$3 as OnlineConferencingLogin,\n eventsV1Order_universal_d_ListOrdersRequest as ListOrdersRequest,\n eventsV1Order_universal_d_OrderFieldset as OrderFieldset,\n eventsV1Order_universal_d_OrderTag as OrderTag,\n eventsV1Order_universal_d_ListOrdersResponse as ListOrdersResponse,\n FacetCounts$5 as FacetCounts,\n eventsV1Order_universal_d_OrderFacets as OrderFacets,\n eventsV1Order_universal_d_OrderFacetCounts as OrderFacetCounts,\n Counts$2 as Counts,\n eventsV1Order_universal_d_GetOrderRequest as GetOrderRequest,\n eventsV1Order_universal_d_GetOrderResponse as GetOrderResponse,\n CalendarLinks$4 as CalendarLinks,\n eventsV1Order_universal_d_UpdateOrderRequest as UpdateOrderRequest,\n eventsV1Order_universal_d_UpdateOrderResponse as UpdateOrderResponse,\n OrderUpdated$1 as OrderUpdated,\n eventsV1Order_universal_d_BulkUpdateOrdersRequest as BulkUpdateOrdersRequest,\n eventsV1Order_universal_d_BulkUpdateOrdersResponse as BulkUpdateOrdersResponse,\n eventsV1Order_universal_d_ConfirmOrderRequest as ConfirmOrderRequest,\n eventsV1Order_universal_d_ConfirmOrderResponse as ConfirmOrderResponse,\n eventsV1Order_universal_d_GetSummaryRequest as GetSummaryRequest,\n eventsV1Order_universal_d_GetSummaryResponse as GetSummaryResponse,\n eventsV1Order_universal_d_TicketSales as TicketSales,\n eventsV1Order_universal_d_GetInvoicePreviewRequest as GetInvoicePreviewRequest,\n eventsV1Order_universal_d_RawHttpResponse as RawHttpResponse,\n eventsV1Order_universal_d_HeadersEntry as HeadersEntry,\n eventsV1Order_universal_d_GetPaymentInfoRequest as GetPaymentInfoRequest,\n eventsV1Order_universal_d_GetPaymentInfoResponse as GetPaymentInfoResponse,\n eventsV1Order_universal_d_PaymentTransactionSummary as PaymentTransactionSummary,\n eventsV1Order_universal_d_PaymentTransactionEvent as PaymentTransactionEvent,\n eventsV1Order_universal_d_CaptureAuthorizedPaymentRequest as CaptureAuthorizedPaymentRequest,\n eventsV1Order_universal_d_CaptureAuthorizedPaymentResponse as CaptureAuthorizedPaymentResponse,\n eventsV1Order_universal_d_VoidAuthorizedPaymentRequest as VoidAuthorizedPaymentRequest,\n eventsV1Order_universal_d_VoidAuthorizedPaymentResponse as VoidAuthorizedPaymentResponse,\n MessageEnvelope$8 as MessageEnvelope,\n IdentificationData$8 as IdentificationData,\n IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf,\n WebhookIdentityType$8 as WebhookIdentityType,\n eventsV1Order_universal_d_OrderConfirmed as OrderConfirmed,\n eventsV1Order_universal_d_OrderPaid as OrderPaid,\n ReservationCreated$1 as ReservationCreated,\n ReservationStatus$1 as ReservationStatus,\n TicketQuantity$1 as TicketQuantity,\n ReservationCount$1 as ReservationCount,\n ReservationUpdated$1 as ReservationUpdated,\n eventsV1Order_universal_d_GetCheckoutOptionsRequest as GetCheckoutOptionsRequest,\n eventsV1Order_universal_d_GetCheckoutOptionsResponse as GetCheckoutOptionsResponse,\n eventsV1Order_universal_d_ListAvailableTicketsRequest as ListAvailableTicketsRequest,\n State$5 as State,\n eventsV1Order_universal_d_ListAvailableTicketsResponse as ListAvailableTicketsResponse,\n ResponseMetaData$1 as ResponseMetaData,\n TicketDefinition$2 as TicketDefinition,\n Dashboard$4 as Dashboard,\n WixFeeConfig$1 as WixFeeConfig,\n TicketSalePeriod$1 as TicketSalePeriod,\n TicketSaleStatus$1 as TicketSaleStatus,\n TicketPricing$1 as TicketPricing,\n TicketPricingPriceOneOf$1 as TicketPricingPriceOneOf,\n PricingOptions$2 as PricingOptions,\n PricingOption$1 as PricingOption,\n Type$4 as Type,\n eventsV1Order_universal_d_QueryAvailableTicketsRequest as QueryAvailableTicketsRequest,\n TicketDefinitionFieldset$1 as TicketDefinitionFieldset,\n eventsV1Order_universal_d_QueryAvailableTicketsResponse as QueryAvailableTicketsResponse,\n eventsV1Order_universal_d_CreateReservationRequest as CreateReservationRequest,\n eventsV1Order_universal_d_TicketReservationQuantity as TicketReservationQuantity,\n eventsV1Order_universal_d_CreateReservationResponse as CreateReservationResponse,\n eventsV1Order_universal_d_TicketReservation as TicketReservation,\n eventsV1Order_universal_d_CancelReservationRequest as CancelReservationRequest,\n eventsV1Order_universal_d_CancelReservationResponse as CancelReservationResponse,\n eventsV1Order_universal_d_GetInvoiceRequest as GetInvoiceRequest,\n eventsV1Order_universal_d_DiscountRequest as DiscountRequest,\n eventsV1Order_universal_d_PaidPlanBenefit as PaidPlanBenefit,\n eventsV1Order_universal_d_GetInvoiceResponse as GetInvoiceResponse,\n eventsV1Order_universal_d_DiscountErrors as DiscountErrors,\n eventsV1Order_universal_d_Error as Error,\n eventsV1Order_universal_d_GiftCardErrors as GiftCardErrors,\n eventsV1Order_universal_d_GiftCardErrorsError as GiftCardErrorsError,\n eventsV1Order_universal_d_CheckoutRequest as CheckoutRequest,\n eventsV1Order_universal_d_Buyer as Buyer,\n Guest$2 as Guest,\n eventsV1Order_universal_d_CheckoutOptions as CheckoutOptions,\n eventsV1Order_universal_d_CheckoutResponse as CheckoutResponse,\n eventsV1Order_universal_d_OrderInitiated as OrderInitiated,\n eventsV1Order_universal_d_UpdateCheckoutRequest as UpdateCheckoutRequest,\n eventsV1Order_universal_d_UpdateCheckoutResponse as UpdateCheckoutResponse,\n eventsV1Order_universal_d_OrderPageUrls as OrderPageUrls,\n eventsV1Order_universal_d_PosCheckoutRequest as PosCheckoutRequest,\n eventsV1Order_universal_d_PosCheckoutResponse as PosCheckoutResponse,\n eventsV1Order_universal_d_listOrders as listOrders,\n eventsV1Order_universal_d_ListOrdersOptions as ListOrdersOptions,\n eventsV1Order_universal_d_getOrder as getOrder,\n eventsV1Order_universal_d_GetOrderIdentifiers as GetOrderIdentifiers,\n eventsV1Order_universal_d_GetOrderOptions as GetOrderOptions,\n eventsV1Order_universal_d_updateOrder as updateOrder,\n eventsV1Order_universal_d_UpdateOrderIdentifiers as UpdateOrderIdentifiers,\n eventsV1Order_universal_d_UpdateOrderOptions as UpdateOrderOptions,\n eventsV1Order_universal_d_bulkUpdateOrders as bulkUpdateOrders,\n eventsV1Order_universal_d_BulkUpdateOrdersOptions as BulkUpdateOrdersOptions,\n eventsV1Order_universal_d_confirmOrder as confirmOrder,\n eventsV1Order_universal_d_ConfirmOrderOptions as ConfirmOrderOptions,\n eventsV1Order_universal_d_getSummary as getSummary,\n eventsV1Order_universal_d_GetSummaryOptions as GetSummaryOptions,\n eventsV1Order_universal_d_getInvoicePreview as getInvoicePreview,\n eventsV1Order_universal_d_GetInvoicePreviewIdentifiers as GetInvoicePreviewIdentifiers,\n eventsV1Order_universal_d_captureAuthorizedPayment as captureAuthorizedPayment,\n eventsV1Order_universal_d_CaptureAuthorizedPaymentOptions as CaptureAuthorizedPaymentOptions,\n eventsV1Order_universal_d_voidAuthorizedPayment as voidAuthorizedPayment,\n eventsV1Order_universal_d_VoidAuthorizedPaymentOptions as VoidAuthorizedPaymentOptions,\n eventsV1Order_universal_d_getCheckoutOptions as getCheckoutOptions,\n eventsV1Order_universal_d_listAvailableTickets as listAvailableTickets,\n eventsV1Order_universal_d_ListAvailableTicketsOptions as ListAvailableTicketsOptions,\n eventsV1Order_universal_d_queryAvailableTickets as queryAvailableTickets,\n eventsV1Order_universal_d_QueryAvailableTicketsOptions as QueryAvailableTicketsOptions,\n eventsV1Order_universal_d_createReservation as createReservation,\n eventsV1Order_universal_d_CreateReservationOptions as CreateReservationOptions,\n eventsV1Order_universal_d_cancelReservation as cancelReservation,\n eventsV1Order_universal_d_getInvoice as getInvoice,\n eventsV1Order_universal_d_GetInvoiceOptions as GetInvoiceOptions,\n eventsV1Order_universal_d_checkout as checkout,\n eventsV1Order_universal_d_CheckoutOptionsForRequest as CheckoutOptionsForRequest,\n eventsV1Order_universal_d_updateCheckout as updateCheckout,\n eventsV1Order_universal_d_UpdateCheckoutOptions as UpdateCheckoutOptions,\n eventsV1Order_universal_d_posCheckout as posCheckout,\n eventsV1Order_universal_d_PosCheckoutOptions as PosCheckoutOptions,\n };\n }\n \n interface RichContent {\n /**\n * Rich content ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time when rich content was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the rich content was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** ID of the event to which rich content is applied. */\n eventId?: string | null;\n /** Field name whose value uses rich content. For the event description, specify the `about` value. */\n fieldName?: string | null;\n /**\n * Rich content of the event description.\n *\n * \n * See Ricos document reference\n * \n */\n content?: V1RichContent;\n /**\n * Custom field data for the rich content object.\n *\n * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.\n */\n extendedFields?: ExtendedFields$2;\n }\n interface V1RichContent {\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 custom 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 /** Data for a caption node. */\n captionData?: CaptionData;\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 custom 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 /** Data for a caption node. */\n captionData?: CaptionData;\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 CAPTION = \"CAPTION\"\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$3;\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. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */\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`: A small width.\n * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.\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`: A small width.\n * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.\n * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.\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. Defaults to `false`. */\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$3 {\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. Defaults to `false`. */\n nofollow?: boolean | null;\n /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */\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. Defaults to `false`. */\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 expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */\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 /**\n * Use `sizeInKb` instead.\n * @deprecated\n */\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 /** File size in KB. */\n sizeInKb?: 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 /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n private?: boolean | null;\n }\n /** @oneof */\n interface FileSourceDataOneOf {\n /** The absolute URL for the file's source. */\n url?: string | null;\n /**\n * Custom ID. Use `id` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n disableDownload?: boolean | null;\n /** Sets whether the PDF print button is disabled. Defaults to `false`. */\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. Defaults to `false`. */\n disableExpand?: boolean | null;\n /** Sets whether the gallery's download button is disabled. Defaults to `false`. */\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. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */\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-4. */\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 /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\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 /**\n * Whether this is an AdSense element. Use `source` instead.\n * @deprecated\n */\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. Defaults to `false`. */\n disableExpand?: boolean | null;\n /** Image's alternative text. */\n altText?: string | null;\n /**\n * Deprecated: use Caption node instead.\n * @deprecated\n */\n caption?: string | null;\n /** Sets whether the image's download button is disabled. Defaults to `false`. */\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-4. */\n indentation?: number | null;\n /** Paragraph level */\n level?: 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. Defaults to `false`. */\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$3 {\n /** Permissions settings for voting. */\n permissions?: Permissions;\n /** Sets whether voters are displayed in the vote results. Defaults to `true`. */\n showVoters?: boolean | null;\n /** Sets whether the vote count is displayed. Defaults to `true`. */\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. Defaults to `false`. */\n enableImage?: boolean | null;\n }\n interface OptionLayout {\n /** Sets whether to display option images. Defaults to `false`. */\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$3;\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. Defaults to `true`. */\n italicData?: boolean | null;\n /** Data for an underline decoration. Defaults to `true`. */\n underlineData?: boolean | null;\n /** Data for a spoiler decoration. */\n spoilerData?: SpoilerData;\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. Defaults to `true`. */\n italicData?: boolean | null;\n /** Data for an underline decoration. Defaults to `true`. */\n underlineData?: boolean | null;\n /** Data for a spoiler decoration. */\n spoilerData?: SpoilerData;\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 SpoilerData {\n /** Spoiler ID. */\n _id?: string | null;\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 /**\n * Deprecated: Use `image` instead.\n * @deprecated\n */\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. Defaults to `false`. */\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. Defaults to `false`. */\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 /**\n * Deprecated: Use `rowHeader` and `columnHeader` instead.\n * @deprecated\n */\n header?: boolean | null;\n /** Sets whether the table's first row is a header. Defaults to `false`. */\n rowHeader?: boolean | null;\n /** Sets whether the table's first column is a header. Defaults to `false`. */\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. Defaults to `false`. */\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 from 0-4. */\n indentation?: number;\n /** Offset level from 0-4. */\n offset?: number | null;\n /** List start number. */\n start?: number | null;\n }\n interface BulletedListData {\n /** Indentation level from 0-4. */\n indentation?: number;\n /** Offset level from 0-4. */\n offset?: number | null;\n }\n interface BlockquoteData {\n /** Indentation level from 1-4. */\n indentation?: number;\n }\n interface CaptionData {\n textStyle?: TextStyle;\n }\n interface Metadata {\n /** Schema version. */\n version?: number;\n /**\n * When the object was created.\n * @readonly\n * @deprecated\n */\n createdTimestamp?: Date | null;\n /**\n * When the object was most recently updated.\n * @deprecated\n */\n updatedTimestamp?: Date | null;\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 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 CreateRichContentRequest {\n /** Rich content details. */\n richContent: RichContent;\n }\n interface CreateRichContentResponse {\n /** Created rich content. */\n richContent?: RichContent;\n }\n interface GetRichContentRequest {\n /** Rich content ID. */\n richContentId: string;\n }\n interface GetRichContentResponse {\n /** The requested rich content. */\n richContent?: RichContent;\n }\n interface FindRichContentBySlugRequest {\n /** The event slug */\n eventSlug: string;\n /** The field name */\n fieldName: string;\n }\n interface FindRichContentBySlugResponse {\n /** The RichContent */\n richContent?: RichContent;\n }\n interface UpdateRichContentRequest {\n /** Fields to update. */\n richContent: RichContent;\n /**\n * FieldMask to be applied to the RichContent.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateRichContentResponse {\n /** Updated rich content. */\n richContent?: RichContent;\n }\n interface DeleteRichContentRequest {\n /** ID of rich content to delete. */\n richContentId: string;\n }\n interface DeleteRichContentResponse {\n }\n interface QueryRichContentsRequest {\n /** WQL expression. */\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$5;\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$5[];\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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryRichContentsResponse {\n /** List of RichContents. */\n richContents?: RichContent[];\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$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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 QueryRichContentRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more details. */\n query?: CursorQuery$1;\n }\n interface QueryRichContentResponse {\n /** List of rich content entities. */\n richContent?: RichContent[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$1;\n }\n interface EventCopied$2 {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$4;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$4;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus$4;\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$4 {\n /** Location name. */\n name?: string | null;\n /** Location map coordinates. */\n coordinates?: MapCoordinates$4;\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$6;\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$4 {\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$6 extends AddressStreetOneOf$6 {\n /** a break down of the street to number and street name */\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 (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$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 /** a break down of the street to number and street name */\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 * apartment number\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation$6 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$6 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n /**\n * subdivision level\n * @internal\n */\n type?: SubdivisionType$6;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\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 interface ScheduleConfig$4 {\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$4 {\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$4 {\n }\n interface EventDeleted$3 {\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 * Event categories.\n * @internal\n */\n categories?: string[];\n }\n interface GetOrCreateRichContentRequest {\n /** The event id */\n eventId?: string;\n /** The field name */\n fieldName?: string;\n /** HTML content to be converted to RichContent */\n content?: string;\n }\n interface GetOrCreateRichContentResponse {\n /** The RichContent */\n richContent?: RichContent;\n }\n interface CountRichContentItemsRequest {\n filter?: Record | null;\n }\n interface CountRichContentItemsResponse {\n count?: number;\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$4 {\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 * Creates rich content, such as for an event description.\n *\n * This method passes rich content value to the description of an already created event.\n * @param richContent - Rich content details.\n * @public\n * @documentationMaturity preview\n * @requiredField richContent\n * @requiredField richContent.content\n * @requiredField richContent.fieldName\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @adminMethod\n * @returns Created rich content.\n */\n function createRichContent(richContent: RichContent): Promise;\n /**\n * Retrieves rich content of an event's field.\n * @param richContentId - Rich content ID.\n * @public\n * @documentationMaturity preview\n * @requiredField richContentId\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @returns The requested rich content.\n */\n function getRichContent(richContentId: string): Promise;\n /**\n * Retrieves a RichContent by event_slug and field_name. Return empty response if not found.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.eventSlug\n * @requiredField identifiers.fieldName\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @deprecated\n * @targetRemovalDate 2025-01-01\n */\n function findRichContentBySlug(identifiers: FindRichContentBySlugIdentifiers): Promise;\n interface FindRichContentBySlugIdentifiers {\n /** The event slug */\n eventSlug: string;\n /** The field name */\n fieldName: string;\n }\n /**\n * Updates rich content of an event description.\n *\n * Each time rich content is updated, `revision` increments by 1. The current `revision` must be passed when updating rich content. This ensures you're working with the latest rich content and prevents unintended overwrites.\n * @param _id - Rich content ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField richContent\n * @requiredField richContent.revision\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @adminMethod\n * @returns Updated rich content.\n */\n function updateRichContent(_id: string | null, richContent: UpdateRichContent, options?: UpdateRichContentOptions): Promise;\n interface UpdateRichContent {\n /**\n * Rich content ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the rich content is updated. To prevent conflicting changes, the existing revision must be used when updating rich content.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time when rich content was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the rich content was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** ID of the event to which rich content is applied. */\n eventId?: string | null;\n /** Field name whose value uses rich content. For the event description, specify the `about` value. */\n fieldName?: string | null;\n /**\n * Rich content of the event description.\n *\n * \n * See Ricos document reference\n * \n */\n content?: V1RichContent;\n /**\n * Custom field data for the rich content object.\n *\n * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.\n */\n extendedFields?: ExtendedFields$2;\n }\n interface UpdateRichContentOptions {\n /**\n * FieldMask to be applied to the RichContent.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Deletes rich content from the event description.\n * @param richContentId - ID of rich content to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField richContentId\n * @permissionId WIX_EVENTS.MANAGE_EVENTS\n * @adminMethod\n */\n function deleteRichContent(richContentId: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @deprecated\n * @replacedBy QueryRichContent\n * @targetRemovalDate 2025-01-01\n */\n function queryRichContents(options?: QueryRichContentsOptions): Promise;\n interface QueryRichContentsOptions {\n /** WQL expression. */\n query?: CursorQuery$1;\n }\n /**\n * Creates a query to retrieve a list of rich content entities.\n *\n * The `queryRichContent()` function builds a query to retrieve a list of events and returns a `RichContentQueryBuilder` 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 `RichContentQueryBuilder` functions onto the query. `RichContentQueryBuilder` functions enable you to sort, filter, and control the results `queryRichContent()` returns.\n *\n * `queryRichContent()` runs with these `RichContentQueryBuilder` defaults, which you can override:\n *\n * - `skip(0)`\n * - `limit(50)`\n * - `descending(\"_createdDate\")`\n * The functions that are chained to `queryRichContent()` are applied in the order they're called. For example, if you apply ascending('eventId') and then descending('id'), the results are sorted first by the event ID, and then, if there are multiple results with the same event ID, the items are sorted by ID.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.READ_EVENTS\n */\n function queryRichContent(): RichContentQueryBuilder;\n interface QueryCursorResult$4 {\n cursors: Cursors$5;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface RichContentQueryResult extends QueryCursorResult$4 {\n items: RichContent[];\n query: RichContentQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface RichContentQueryBuilder {\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' | 'eventId' | 'fieldName', value: any) => RichContentQueryBuilder;\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' | 'eventId' | 'fieldName', value: any) => RichContentQueryBuilder;\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' | 'eventId' | 'fieldName', value: string) => RichContentQueryBuilder;\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' | 'eventId' | 'fieldName', value: any[]) => RichContentQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'eventId' | 'fieldName', value: any) => RichContentQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'eventId' | 'fieldName', value: boolean) => RichContentQueryBuilder;\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' | 'eventId' | 'fieldName'>) => RichContentQueryBuilder;\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' | 'eventId' | 'fieldName'>) => RichContentQueryBuilder;\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) => RichContentQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => RichContentQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function countRichContentItems(options?: CountRichContentItemsOptions): Promise;\n interface CountRichContentItemsOptions {\n filter?: Record | null;\n }\n \n type eventsV1RichContent_universal_d_RichContent = RichContent;\n type eventsV1RichContent_universal_d_V1RichContent = V1RichContent;\n type eventsV1RichContent_universal_d_Node = Node;\n type eventsV1RichContent_universal_d_NodeDataOneOf = NodeDataOneOf;\n type eventsV1RichContent_universal_d_NodeType = NodeType;\n const eventsV1RichContent_universal_d_NodeType: typeof NodeType;\n type eventsV1RichContent_universal_d_NodeStyle = NodeStyle;\n type eventsV1RichContent_universal_d_ButtonData = ButtonData;\n type eventsV1RichContent_universal_d_Border = Border;\n type eventsV1RichContent_universal_d_Colors = Colors;\n type eventsV1RichContent_universal_d_PluginContainerData = PluginContainerData;\n type eventsV1RichContent_universal_d_WidthType = WidthType;\n const eventsV1RichContent_universal_d_WidthType: typeof WidthType;\n type eventsV1RichContent_universal_d_PluginContainerDataWidth = PluginContainerDataWidth;\n type eventsV1RichContent_universal_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;\n type eventsV1RichContent_universal_d_PluginContainerDataAlignment = PluginContainerDataAlignment;\n const eventsV1RichContent_universal_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;\n type eventsV1RichContent_universal_d_Spoiler = Spoiler;\n type eventsV1RichContent_universal_d_Height = Height;\n type eventsV1RichContent_universal_d_Styles = Styles;\n type eventsV1RichContent_universal_d_Link = Link;\n type eventsV1RichContent_universal_d_LinkDataOneOf = LinkDataOneOf;\n type eventsV1RichContent_universal_d_Target = Target;\n const eventsV1RichContent_universal_d_Target: typeof Target;\n type eventsV1RichContent_universal_d_Rel = Rel;\n type eventsV1RichContent_universal_d_CodeBlockData = CodeBlockData;\n type eventsV1RichContent_universal_d_TextStyle = TextStyle;\n type eventsV1RichContent_universal_d_TextAlignment = TextAlignment;\n const eventsV1RichContent_universal_d_TextAlignment: typeof TextAlignment;\n type eventsV1RichContent_universal_d_DividerData = DividerData;\n type eventsV1RichContent_universal_d_LineStyle = LineStyle;\n const eventsV1RichContent_universal_d_LineStyle: typeof LineStyle;\n type eventsV1RichContent_universal_d_Width = Width;\n const eventsV1RichContent_universal_d_Width: typeof Width;\n type eventsV1RichContent_universal_d_Alignment = Alignment;\n const eventsV1RichContent_universal_d_Alignment: typeof Alignment;\n type eventsV1RichContent_universal_d_FileData = FileData;\n type eventsV1RichContent_universal_d_ViewMode = ViewMode;\n const eventsV1RichContent_universal_d_ViewMode: typeof ViewMode;\n type eventsV1RichContent_universal_d_FileSource = FileSource;\n type eventsV1RichContent_universal_d_FileSourceDataOneOf = FileSourceDataOneOf;\n type eventsV1RichContent_universal_d_PDFSettings = PDFSettings;\n type eventsV1RichContent_universal_d_GalleryData = GalleryData;\n type eventsV1RichContent_universal_d_Media = Media;\n type eventsV1RichContent_universal_d_Image = Image;\n type eventsV1RichContent_universal_d_Video = Video;\n type eventsV1RichContent_universal_d_Item = Item;\n type eventsV1RichContent_universal_d_ItemDataOneOf = ItemDataOneOf;\n type eventsV1RichContent_universal_d_GalleryOptions = GalleryOptions;\n type eventsV1RichContent_universal_d_LayoutType = LayoutType;\n const eventsV1RichContent_universal_d_LayoutType: typeof LayoutType;\n type eventsV1RichContent_universal_d_Orientation = Orientation;\n const eventsV1RichContent_universal_d_Orientation: typeof Orientation;\n type eventsV1RichContent_universal_d_Crop = Crop;\n const eventsV1RichContent_universal_d_Crop: typeof Crop;\n type eventsV1RichContent_universal_d_ThumbnailsAlignment = ThumbnailsAlignment;\n const eventsV1RichContent_universal_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;\n type eventsV1RichContent_universal_d_Layout = Layout;\n type eventsV1RichContent_universal_d_ItemStyle = ItemStyle;\n type eventsV1RichContent_universal_d_Thumbnails = Thumbnails;\n type eventsV1RichContent_universal_d_GIFData = GIFData;\n type eventsV1RichContent_universal_d_GIF = GIF;\n type eventsV1RichContent_universal_d_HeadingData = HeadingData;\n type eventsV1RichContent_universal_d_HTMLData = HTMLData;\n type eventsV1RichContent_universal_d_HTMLDataDataOneOf = HTMLDataDataOneOf;\n type eventsV1RichContent_universal_d_Source = Source;\n const eventsV1RichContent_universal_d_Source: typeof Source;\n type eventsV1RichContent_universal_d_ImageData = ImageData;\n type eventsV1RichContent_universal_d_LinkPreviewData = LinkPreviewData;\n type eventsV1RichContent_universal_d_MapData = MapData;\n type eventsV1RichContent_universal_d_MapSettings = MapSettings;\n type eventsV1RichContent_universal_d_MapType = MapType;\n const eventsV1RichContent_universal_d_MapType: typeof MapType;\n type eventsV1RichContent_universal_d_ParagraphData = ParagraphData;\n type eventsV1RichContent_universal_d_PollData = PollData;\n type eventsV1RichContent_universal_d_ViewRole = ViewRole;\n const eventsV1RichContent_universal_d_ViewRole: typeof ViewRole;\n type eventsV1RichContent_universal_d_VoteRole = VoteRole;\n const eventsV1RichContent_universal_d_VoteRole: typeof VoteRole;\n type eventsV1RichContent_universal_d_Permissions = Permissions;\n type eventsV1RichContent_universal_d_Option = Option;\n type eventsV1RichContent_universal_d_PollLayoutType = PollLayoutType;\n const eventsV1RichContent_universal_d_PollLayoutType: typeof PollLayoutType;\n type eventsV1RichContent_universal_d_PollLayoutDirection = PollLayoutDirection;\n const eventsV1RichContent_universal_d_PollLayoutDirection: typeof PollLayoutDirection;\n type eventsV1RichContent_universal_d_PollLayout = PollLayout;\n type eventsV1RichContent_universal_d_OptionLayout = OptionLayout;\n type eventsV1RichContent_universal_d_BackgroundType = BackgroundType;\n const eventsV1RichContent_universal_d_BackgroundType: typeof BackgroundType;\n type eventsV1RichContent_universal_d_Gradient = Gradient;\n type eventsV1RichContent_universal_d_Background = Background;\n type eventsV1RichContent_universal_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;\n type eventsV1RichContent_universal_d_PollDesign = PollDesign;\n type eventsV1RichContent_universal_d_OptionDesign = OptionDesign;\n type eventsV1RichContent_universal_d_Poll = Poll;\n type eventsV1RichContent_universal_d_PollDataLayout = PollDataLayout;\n type eventsV1RichContent_universal_d_Design = Design;\n type eventsV1RichContent_universal_d_TextData = TextData;\n type eventsV1RichContent_universal_d_Decoration = Decoration;\n type eventsV1RichContent_universal_d_DecorationDataOneOf = DecorationDataOneOf;\n type eventsV1RichContent_universal_d_DecorationType = DecorationType;\n const eventsV1RichContent_universal_d_DecorationType: typeof DecorationType;\n type eventsV1RichContent_universal_d_AnchorData = AnchorData;\n type eventsV1RichContent_universal_d_ColorData = ColorData;\n type eventsV1RichContent_universal_d_LinkData = LinkData;\n type eventsV1RichContent_universal_d_MentionData = MentionData;\n type eventsV1RichContent_universal_d_FontSizeData = FontSizeData;\n type eventsV1RichContent_universal_d_FontType = FontType;\n const eventsV1RichContent_universal_d_FontType: typeof FontType;\n type eventsV1RichContent_universal_d_SpoilerData = SpoilerData;\n type eventsV1RichContent_universal_d_AppEmbedData = AppEmbedData;\n type eventsV1RichContent_universal_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;\n type eventsV1RichContent_universal_d_AppType = AppType;\n const eventsV1RichContent_universal_d_AppType: typeof AppType;\n type eventsV1RichContent_universal_d_BookingData = BookingData;\n type eventsV1RichContent_universal_d_EventData = EventData;\n type eventsV1RichContent_universal_d_VideoData = VideoData;\n type eventsV1RichContent_universal_d_PlaybackOptions = PlaybackOptions;\n type eventsV1RichContent_universal_d_EmbedData = EmbedData;\n type eventsV1RichContent_universal_d_Oembed = Oembed;\n type eventsV1RichContent_universal_d_CollapsibleListData = CollapsibleListData;\n type eventsV1RichContent_universal_d_InitialExpandedItems = InitialExpandedItems;\n const eventsV1RichContent_universal_d_InitialExpandedItems: typeof InitialExpandedItems;\n type eventsV1RichContent_universal_d_Direction = Direction;\n const eventsV1RichContent_universal_d_Direction: typeof Direction;\n type eventsV1RichContent_universal_d_TableData = TableData;\n type eventsV1RichContent_universal_d_Dimensions = Dimensions;\n type eventsV1RichContent_universal_d_TableCellData = TableCellData;\n type eventsV1RichContent_universal_d_VerticalAlignment = VerticalAlignment;\n const eventsV1RichContent_universal_d_VerticalAlignment: typeof VerticalAlignment;\n type eventsV1RichContent_universal_d_CellStyle = CellStyle;\n type eventsV1RichContent_universal_d_BorderColors = BorderColors;\n type eventsV1RichContent_universal_d_NullValue = NullValue;\n const eventsV1RichContent_universal_d_NullValue: typeof NullValue;\n type eventsV1RichContent_universal_d_ListValue = ListValue;\n type eventsV1RichContent_universal_d_AudioData = AudioData;\n type eventsV1RichContent_universal_d_OrderedListData = OrderedListData;\n type eventsV1RichContent_universal_d_BulletedListData = BulletedListData;\n type eventsV1RichContent_universal_d_BlockquoteData = BlockquoteData;\n type eventsV1RichContent_universal_d_CaptionData = CaptionData;\n type eventsV1RichContent_universal_d_Metadata = Metadata;\n type eventsV1RichContent_universal_d_DocumentStyle = DocumentStyle;\n type eventsV1RichContent_universal_d_TextNodeStyle = TextNodeStyle;\n type eventsV1RichContent_universal_d_CreateRichContentRequest = CreateRichContentRequest;\n type eventsV1RichContent_universal_d_CreateRichContentResponse = CreateRichContentResponse;\n type eventsV1RichContent_universal_d_GetRichContentRequest = GetRichContentRequest;\n type eventsV1RichContent_universal_d_GetRichContentResponse = GetRichContentResponse;\n type eventsV1RichContent_universal_d_FindRichContentBySlugRequest = FindRichContentBySlugRequest;\n type eventsV1RichContent_universal_d_FindRichContentBySlugResponse = FindRichContentBySlugResponse;\n type eventsV1RichContent_universal_d_UpdateRichContentRequest = UpdateRichContentRequest;\n type eventsV1RichContent_universal_d_UpdateRichContentResponse = UpdateRichContentResponse;\n type eventsV1RichContent_universal_d_DeleteRichContentRequest = DeleteRichContentRequest;\n type eventsV1RichContent_universal_d_DeleteRichContentResponse = DeleteRichContentResponse;\n type eventsV1RichContent_universal_d_QueryRichContentsRequest = QueryRichContentsRequest;\n type eventsV1RichContent_universal_d_QueryRichContentsResponse = QueryRichContentsResponse;\n type eventsV1RichContent_universal_d_QueryRichContentRequest = QueryRichContentRequest;\n type eventsV1RichContent_universal_d_QueryRichContentResponse = QueryRichContentResponse;\n type eventsV1RichContent_universal_d_GetOrCreateRichContentRequest = GetOrCreateRichContentRequest;\n type eventsV1RichContent_universal_d_GetOrCreateRichContentResponse = GetOrCreateRichContentResponse;\n type eventsV1RichContent_universal_d_CountRichContentItemsRequest = CountRichContentItemsRequest;\n type eventsV1RichContent_universal_d_CountRichContentItemsResponse = CountRichContentItemsResponse;\n const eventsV1RichContent_universal_d_createRichContent: typeof createRichContent;\n const eventsV1RichContent_universal_d_getRichContent: typeof getRichContent;\n const eventsV1RichContent_universal_d_findRichContentBySlug: typeof findRichContentBySlug;\n type eventsV1RichContent_universal_d_FindRichContentBySlugIdentifiers = FindRichContentBySlugIdentifiers;\n const eventsV1RichContent_universal_d_updateRichContent: typeof updateRichContent;\n type eventsV1RichContent_universal_d_UpdateRichContent = UpdateRichContent;\n type eventsV1RichContent_universal_d_UpdateRichContentOptions = UpdateRichContentOptions;\n const eventsV1RichContent_universal_d_deleteRichContent: typeof deleteRichContent;\n const eventsV1RichContent_universal_d_queryRichContents: typeof queryRichContents;\n type eventsV1RichContent_universal_d_QueryRichContentsOptions = QueryRichContentsOptions;\n const eventsV1RichContent_universal_d_queryRichContent: typeof queryRichContent;\n type eventsV1RichContent_universal_d_RichContentQueryResult = RichContentQueryResult;\n type eventsV1RichContent_universal_d_RichContentQueryBuilder = RichContentQueryBuilder;\n const eventsV1RichContent_universal_d_countRichContentItems: typeof countRichContentItems;\n type eventsV1RichContent_universal_d_CountRichContentItemsOptions = CountRichContentItemsOptions;\n namespace eventsV1RichContent_universal_d {\n export {\n eventsV1RichContent_universal_d_RichContent as RichContent,\n eventsV1RichContent_universal_d_V1RichContent as V1RichContent,\n eventsV1RichContent_universal_d_Node as Node,\n eventsV1RichContent_universal_d_NodeDataOneOf as NodeDataOneOf,\n eventsV1RichContent_universal_d_NodeType as NodeType,\n eventsV1RichContent_universal_d_NodeStyle as NodeStyle,\n eventsV1RichContent_universal_d_ButtonData as ButtonData,\n eventsV1RichContent_universal_d_Border as Border,\n eventsV1RichContent_universal_d_Colors as Colors,\n eventsV1RichContent_universal_d_PluginContainerData as PluginContainerData,\n eventsV1RichContent_universal_d_WidthType as WidthType,\n eventsV1RichContent_universal_d_PluginContainerDataWidth as PluginContainerDataWidth,\n eventsV1RichContent_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf,\n eventsV1RichContent_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment,\n eventsV1RichContent_universal_d_Spoiler as Spoiler,\n eventsV1RichContent_universal_d_Height as Height,\n Type$3 as Type,\n eventsV1RichContent_universal_d_Styles as Styles,\n eventsV1RichContent_universal_d_Link as Link,\n eventsV1RichContent_universal_d_LinkDataOneOf as LinkDataOneOf,\n eventsV1RichContent_universal_d_Target as Target,\n eventsV1RichContent_universal_d_Rel as Rel,\n eventsV1RichContent_universal_d_CodeBlockData as CodeBlockData,\n eventsV1RichContent_universal_d_TextStyle as TextStyle,\n eventsV1RichContent_universal_d_TextAlignment as TextAlignment,\n eventsV1RichContent_universal_d_DividerData as DividerData,\n eventsV1RichContent_universal_d_LineStyle as LineStyle,\n eventsV1RichContent_universal_d_Width as Width,\n eventsV1RichContent_universal_d_Alignment as Alignment,\n eventsV1RichContent_universal_d_FileData as FileData,\n eventsV1RichContent_universal_d_ViewMode as ViewMode,\n eventsV1RichContent_universal_d_FileSource as FileSource,\n eventsV1RichContent_universal_d_FileSourceDataOneOf as FileSourceDataOneOf,\n eventsV1RichContent_universal_d_PDFSettings as PDFSettings,\n eventsV1RichContent_universal_d_GalleryData as GalleryData,\n eventsV1RichContent_universal_d_Media as Media,\n eventsV1RichContent_universal_d_Image as Image,\n eventsV1RichContent_universal_d_Video as Video,\n eventsV1RichContent_universal_d_Item as Item,\n eventsV1RichContent_universal_d_ItemDataOneOf as ItemDataOneOf,\n eventsV1RichContent_universal_d_GalleryOptions as GalleryOptions,\n eventsV1RichContent_universal_d_LayoutType as LayoutType,\n eventsV1RichContent_universal_d_Orientation as Orientation,\n eventsV1RichContent_universal_d_Crop as Crop,\n eventsV1RichContent_universal_d_ThumbnailsAlignment as ThumbnailsAlignment,\n eventsV1RichContent_universal_d_Layout as Layout,\n eventsV1RichContent_universal_d_ItemStyle as ItemStyle,\n eventsV1RichContent_universal_d_Thumbnails as Thumbnails,\n eventsV1RichContent_universal_d_GIFData as GIFData,\n eventsV1RichContent_universal_d_GIF as GIF,\n eventsV1RichContent_universal_d_HeadingData as HeadingData,\n eventsV1RichContent_universal_d_HTMLData as HTMLData,\n eventsV1RichContent_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf,\n eventsV1RichContent_universal_d_Source as Source,\n eventsV1RichContent_universal_d_ImageData as ImageData,\n eventsV1RichContent_universal_d_LinkPreviewData as LinkPreviewData,\n eventsV1RichContent_universal_d_MapData as MapData,\n eventsV1RichContent_universal_d_MapSettings as MapSettings,\n eventsV1RichContent_universal_d_MapType as MapType,\n eventsV1RichContent_universal_d_ParagraphData as ParagraphData,\n eventsV1RichContent_universal_d_PollData as PollData,\n eventsV1RichContent_universal_d_ViewRole as ViewRole,\n eventsV1RichContent_universal_d_VoteRole as VoteRole,\n eventsV1RichContent_universal_d_Permissions as Permissions,\n eventsV1RichContent_universal_d_Option as Option,\n Settings$3 as Settings,\n eventsV1RichContent_universal_d_PollLayoutType as PollLayoutType,\n eventsV1RichContent_universal_d_PollLayoutDirection as PollLayoutDirection,\n eventsV1RichContent_universal_d_PollLayout as PollLayout,\n eventsV1RichContent_universal_d_OptionLayout as OptionLayout,\n eventsV1RichContent_universal_d_BackgroundType as BackgroundType,\n eventsV1RichContent_universal_d_Gradient as Gradient,\n eventsV1RichContent_universal_d_Background as Background,\n eventsV1RichContent_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf,\n eventsV1RichContent_universal_d_PollDesign as PollDesign,\n eventsV1RichContent_universal_d_OptionDesign as OptionDesign,\n eventsV1RichContent_universal_d_Poll as Poll,\n eventsV1RichContent_universal_d_PollDataLayout as PollDataLayout,\n eventsV1RichContent_universal_d_Design as Design,\n eventsV1RichContent_universal_d_TextData as TextData,\n eventsV1RichContent_universal_d_Decoration as Decoration,\n eventsV1RichContent_universal_d_DecorationDataOneOf as DecorationDataOneOf,\n eventsV1RichContent_universal_d_DecorationType as DecorationType,\n eventsV1RichContent_universal_d_AnchorData as AnchorData,\n eventsV1RichContent_universal_d_ColorData as ColorData,\n eventsV1RichContent_universal_d_LinkData as LinkData,\n eventsV1RichContent_universal_d_MentionData as MentionData,\n eventsV1RichContent_universal_d_FontSizeData as FontSizeData,\n eventsV1RichContent_universal_d_FontType as FontType,\n eventsV1RichContent_universal_d_SpoilerData as SpoilerData,\n eventsV1RichContent_universal_d_AppEmbedData as AppEmbedData,\n eventsV1RichContent_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf,\n eventsV1RichContent_universal_d_AppType as AppType,\n eventsV1RichContent_universal_d_BookingData as BookingData,\n eventsV1RichContent_universal_d_EventData as EventData,\n eventsV1RichContent_universal_d_VideoData as VideoData,\n eventsV1RichContent_universal_d_PlaybackOptions as PlaybackOptions,\n eventsV1RichContent_universal_d_EmbedData as EmbedData,\n eventsV1RichContent_universal_d_Oembed as Oembed,\n eventsV1RichContent_universal_d_CollapsibleListData as CollapsibleListData,\n eventsV1RichContent_universal_d_InitialExpandedItems as InitialExpandedItems,\n eventsV1RichContent_universal_d_Direction as Direction,\n eventsV1RichContent_universal_d_TableData as TableData,\n eventsV1RichContent_universal_d_Dimensions as Dimensions,\n eventsV1RichContent_universal_d_TableCellData as TableCellData,\n eventsV1RichContent_universal_d_VerticalAlignment as VerticalAlignment,\n eventsV1RichContent_universal_d_CellStyle as CellStyle,\n eventsV1RichContent_universal_d_BorderColors as BorderColors,\n eventsV1RichContent_universal_d_NullValue as NullValue,\n eventsV1RichContent_universal_d_ListValue as ListValue,\n eventsV1RichContent_universal_d_AudioData as AudioData,\n eventsV1RichContent_universal_d_OrderedListData as OrderedListData,\n eventsV1RichContent_universal_d_BulletedListData as BulletedListData,\n eventsV1RichContent_universal_d_BlockquoteData as BlockquoteData,\n eventsV1RichContent_universal_d_CaptionData as CaptionData,\n eventsV1RichContent_universal_d_Metadata as Metadata,\n eventsV1RichContent_universal_d_DocumentStyle as DocumentStyle,\n eventsV1RichContent_universal_d_TextNodeStyle as TextNodeStyle,\n ExtendedFields$2 as ExtendedFields,\n eventsV1RichContent_universal_d_CreateRichContentRequest as CreateRichContentRequest,\n eventsV1RichContent_universal_d_CreateRichContentResponse as CreateRichContentResponse,\n eventsV1RichContent_universal_d_GetRichContentRequest as GetRichContentRequest,\n eventsV1RichContent_universal_d_GetRichContentResponse as GetRichContentResponse,\n eventsV1RichContent_universal_d_FindRichContentBySlugRequest as FindRichContentBySlugRequest,\n eventsV1RichContent_universal_d_FindRichContentBySlugResponse as FindRichContentBySlugResponse,\n eventsV1RichContent_universal_d_UpdateRichContentRequest as UpdateRichContentRequest,\n eventsV1RichContent_universal_d_UpdateRichContentResponse as UpdateRichContentResponse,\n eventsV1RichContent_universal_d_DeleteRichContentRequest as DeleteRichContentRequest,\n eventsV1RichContent_universal_d_DeleteRichContentResponse as DeleteRichContentResponse,\n eventsV1RichContent_universal_d_QueryRichContentsRequest as QueryRichContentsRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$5 as Sorting,\n SortOrder$5 as SortOrder,\n CursorPaging$5 as CursorPaging,\n eventsV1RichContent_universal_d_QueryRichContentsResponse as QueryRichContentsResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$5 as Cursors,\n eventsV1RichContent_universal_d_QueryRichContentRequest as QueryRichContentRequest,\n eventsV1RichContent_universal_d_QueryRichContentResponse as QueryRichContentResponse,\n EventCopied$2 as EventCopied,\n Location$4 as Location,\n MapCoordinates$4 as MapCoordinates,\n LocationType$4 as LocationType,\n Address$6 as Address,\n AddressStreetOneOf$6 as AddressStreetOneOf,\n StreetAddress$6 as StreetAddress,\n AddressLocation$6 as AddressLocation,\n Subdivision$6 as Subdivision,\n SubdivisionType$6 as SubdivisionType,\n ScheduleConfig$4 as ScheduleConfig,\n Recurrences$4 as Recurrences,\n Occurrence$4 as Occurrence,\n Status$4 as Status,\n EventStatus$4 as EventStatus,\n Empty$4 as Empty,\n EventDeleted$3 as EventDeleted,\n eventsV1RichContent_universal_d_GetOrCreateRichContentRequest as GetOrCreateRichContentRequest,\n eventsV1RichContent_universal_d_GetOrCreateRichContentResponse as GetOrCreateRichContentResponse,\n eventsV1RichContent_universal_d_CountRichContentItemsRequest as CountRichContentItemsRequest,\n eventsV1RichContent_universal_d_CountRichContentItemsResponse as CountRichContentItemsResponse,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n MessageEnvelope$7 as MessageEnvelope,\n IdentificationData$7 as IdentificationData,\n IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf,\n WebhookIdentityType$7 as WebhookIdentityType,\n eventsV1RichContent_universal_d_createRichContent as createRichContent,\n eventsV1RichContent_universal_d_getRichContent as getRichContent,\n eventsV1RichContent_universal_d_findRichContentBySlug as findRichContentBySlug,\n eventsV1RichContent_universal_d_FindRichContentBySlugIdentifiers as FindRichContentBySlugIdentifiers,\n eventsV1RichContent_universal_d_updateRichContent as updateRichContent,\n eventsV1RichContent_universal_d_UpdateRichContent as UpdateRichContent,\n eventsV1RichContent_universal_d_UpdateRichContentOptions as UpdateRichContentOptions,\n eventsV1RichContent_universal_d_deleteRichContent as deleteRichContent,\n eventsV1RichContent_universal_d_queryRichContents as queryRichContents,\n eventsV1RichContent_universal_d_QueryRichContentsOptions as QueryRichContentsOptions,\n eventsV1RichContent_universal_d_queryRichContent as queryRichContent,\n eventsV1RichContent_universal_d_RichContentQueryResult as RichContentQueryResult,\n eventsV1RichContent_universal_d_RichContentQueryBuilder as RichContentQueryBuilder,\n eventsV1RichContent_universal_d_countRichContentItems as countRichContentItems,\n eventsV1RichContent_universal_d_CountRichContentItemsOptions as CountRichContentItemsOptions,\n };\n }\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 | null;\n /** RSVP modified timestamp. */\n modified?: Date | null;\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$1[];\n /** Whether RSVP is anonymized by GDPR delete. */\n anonymized?: boolean;\n /**\n * Language in which Rsvp was created.\n * @internal\n * @readonly\n */\n language?: string | null;\n /**\n * Locale in which Rsvp was created.\n * @internal\n * @readonly\n */\n locale?: string | null;\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 * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date | null;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress$2;\n }\n interface FormattedAddress$2 {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: Address$5;\n }\n /** Physical address */\n interface Address$5 extends AddressStreetOneOf$5 {\n /** Street name and number. */\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 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$5;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision$5[];\n }\n /** @oneof */\n interface AddressStreetOneOf$5 {\n /** Street name and 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 /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$5;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails$2;\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 /** 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$1 {\n /** Index in the RSVP guest list. */\n index?: number;\n /** Guest full name. */\n fullName?: string;\n /** Guest check-in. */\n checkIn?: CheckIn$1;\n /** Unique guest ID per RSVP. */\n _id?: number;\n }\n interface CheckIn$1 {\n /** Time of check-in */\n created?: Date | null;\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 * Deprecated: use tag = MEMBER\n * @internal\n * @deprecated\n */\n membersOnly?: boolean;\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 including: `created`, `modified`, `firstName`, `lastName`, `status`, `totalGuests`, `guests`, and `annonymized`. */\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 of all guests that are fully checked-in. */\n FULLY_CHECKED_IN = \"FULLY_CHECKED_IN\",\n /** Return only RSVPs of all guests that aren't fully checked-in. */\n NOT_FULLY_CHECKED_IN = \"NOT_FULLY_CHECKED_IN\",\n /** Return only RSVPs of guests that are members. */\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$4 {\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 * Deprecated: use tag = MEMBER\n * @internal\n * @deprecated\n */\n membersOnly?: boolean;\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$1 {\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$1 {\n /** RSVP. */\n rsvp?: Rsvp;\n }\n interface CreateRsvpRequest$1 {\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$1;\n }\n interface ModificationOptions$1 {\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$1 {\n /** Created RSVP. */\n rsvp?: Rsvp;\n /** \"Add to calendar\" links. */\n calendarLinks?: CalendarLinks$3;\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 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 /**\n * Locale in which Rsvp was created.\n * @internal\n */\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 /** 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$1[];\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$1 {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVP ID. */\n rsvpId: string;\n /**\n * Set of field paths, specifying which parts of RSVP to update.\n * @internal\n */\n fields: 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$1;\n }\n interface UpdateRsvpResponse$1 {\n /** Updated RSVP. */\n rsvp?: Rsvp;\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 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 | 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 the guests. */\n guests?: Guest$1[];\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$1 {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVPs to update. */\n rsvpId?: string[];\n /**\n * Set of fields to update.\n * @internal\n */\n fields?: 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$1 {\n /** Updated RSVPs. */\n rsvps?: Rsvp[];\n }\n interface BulkUpdateRsvpContactIdRequest$1 {\n /** RSVPs to update. */\n rsvps?: BulkUpdateRsvpContactIdRequestRsvp[];\n /** New RSVP contact ID. */\n contactId?: string | null;\n }\n interface BulkUpdateRsvpContactIdRequestRsvp {\n /** Event ID. */\n eventId?: string | null;\n /** Rsvp ID. */\n rsvpId?: string | null;\n }\n interface BulkUpdateRsvpContactIdResponse$1 {\n }\n interface DeleteRsvpRequest$1 {\n /** Event ID to which RSVP belongs. */\n eventId: string;\n /** RSVPs to delete. */\n rsvps?: string[];\n }\n interface DeleteRsvpResponse$1 {\n }\n interface RsvpDeleted {\n /** RSVP deleted timestamp in ISO UTC format. */\n timestamp?: Date | 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 /** 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 FindRsvpSummaryRequest {\n /** Event id. */\n eventId?: string | null;\n /** Consistent read. */\n consistentRead?: boolean | null;\n }\n interface FindRsvpSummaryResponse {\n /** RSVP summary. */\n rsvpSummary?: RsvpSummary$3;\n }\n interface RsvpSummary$3 {\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 CountRsvpAttendingGuestsRequest {\n /** Event id. */\n eventId?: string | null;\n /** Consistent read. */\n consistentRead?: boolean | null;\n }\n interface CountRsvpAttendingGuestsResponse {\n /** RSVP attending guest count. */\n count?: number | null;\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 * Retrieves a list of up to 100 RSVPs.\n * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_RSVP\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 * Deprecated: use tag = MEMBER\n * @internal\n * @deprecated\n */\n membersOnly?: boolean;\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 * @permissionId WIX_EVENTS.READ_RSVP\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 * Deprecated: use tag = MEMBER\n * @internal\n * @deprecated\n */\n membersOnly?: boolean;\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 * @permissionId WIX_EVENTS.READ_RSVP\n * @adminMethod\n * @returns RSVP.\n */\n function getRsvp$1(rsvpId: string, options?: GetRsvpOptions$1): Promise;\n interface GetRsvpOptions$1 {\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 * @permissionId WIX_EVENTS.CREATE_RSVP\n */\n function createRsvp$1(options?: CreateRsvpOptions$1): Promise;\n interface CreateRsvpOptions$1 {\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$1;\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 * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n */\n function updateRsvp$1(rsvpId: string, eventId: string, options?: UpdateRsvpOptions$1): Promise;\n interface UpdateRsvpOptions$1 {\n /**\n * Set of field paths, specifying which parts of RSVP to update.\n * @internal\n */\n fields: 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$1;\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 * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n */\n function bulkUpdateRsvp$1(eventId: string, options?: BulkUpdateRsvpOptions$1): Promise;\n interface BulkUpdateRsvpOptions$1 {\n /** RSVPs to update. */\n rsvpId?: string[];\n /**\n * Set of fields to update.\n * @internal\n */\n fields?: 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 * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n */\n function deleteRsvp$1(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 * @permissionId WIX_EVENTS.CHECK_IN\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 * @permissionId WIX_EVENTS.CHECK_IN\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 \n type eventsV1Rsvp_universal_d_Rsvp = Rsvp;\n type eventsV1Rsvp_universal_d_ListRsvpRequest = ListRsvpRequest;\n type eventsV1Rsvp_universal_d_RsvpFieldset = RsvpFieldset;\n const eventsV1Rsvp_universal_d_RsvpFieldset: typeof RsvpFieldset;\n type eventsV1Rsvp_universal_d_RsvpTag = RsvpTag;\n const eventsV1Rsvp_universal_d_RsvpTag: typeof RsvpTag;\n type eventsV1Rsvp_universal_d_ListRsvpResponse = ListRsvpResponse;\n type eventsV1Rsvp_universal_d_RsvpFacets = RsvpFacets;\n type eventsV1Rsvp_universal_d_RsvpFacetCounts = RsvpFacetCounts;\n type eventsV1Rsvp_universal_d_QueryRsvpRequest = QueryRsvpRequest;\n type eventsV1Rsvp_universal_d_QueryRsvpResponse = QueryRsvpResponse;\n type eventsV1Rsvp_universal_d_RsvpCreated = RsvpCreated;\n type eventsV1Rsvp_universal_d_RsvpUpdated = RsvpUpdated;\n type eventsV1Rsvp_universal_d_BulkUpdateRsvpContactIdRequestRsvp = BulkUpdateRsvpContactIdRequestRsvp;\n type eventsV1Rsvp_universal_d_RsvpDeleted = RsvpDeleted;\n type eventsV1Rsvp_universal_d_CheckInRsvpRequest = CheckInRsvpRequest;\n type eventsV1Rsvp_universal_d_CheckInRsvpResponse = CheckInRsvpResponse;\n type eventsV1Rsvp_universal_d_DeleteRsvpCheckInRequest = DeleteRsvpCheckInRequest;\n type eventsV1Rsvp_universal_d_DeleteRsvpCheckInResponse = DeleteRsvpCheckInResponse;\n type eventsV1Rsvp_universal_d_FindRsvpSummaryRequest = FindRsvpSummaryRequest;\n type eventsV1Rsvp_universal_d_FindRsvpSummaryResponse = FindRsvpSummaryResponse;\n type eventsV1Rsvp_universal_d_CountRsvpAttendingGuestsRequest = CountRsvpAttendingGuestsRequest;\n type eventsV1Rsvp_universal_d_CountRsvpAttendingGuestsResponse = CountRsvpAttendingGuestsResponse;\n const eventsV1Rsvp_universal_d_listRsvp: typeof listRsvp;\n type eventsV1Rsvp_universal_d_ListRsvpOptions = ListRsvpOptions;\n const eventsV1Rsvp_universal_d_queryRsvp: typeof queryRsvp;\n type eventsV1Rsvp_universal_d_QueryRsvpOptions = QueryRsvpOptions;\n type eventsV1Rsvp_universal_d_DeleteRsvpOptions = DeleteRsvpOptions;\n const eventsV1Rsvp_universal_d_checkInRsvp: typeof checkInRsvp;\n type eventsV1Rsvp_universal_d_CheckInRsvpOptions = CheckInRsvpOptions;\n const eventsV1Rsvp_universal_d_deleteRsvpCheckIn: typeof deleteRsvpCheckIn;\n type eventsV1Rsvp_universal_d_DeleteRsvpCheckInOptions = DeleteRsvpCheckInOptions;\n namespace eventsV1Rsvp_universal_d {\n export {\n eventsV1Rsvp_universal_d_Rsvp as Rsvp,\n FormResponse$2 as FormResponse,\n InputValue$2 as InputValue,\n FormattedAddress$2 as FormattedAddress,\n Address$5 as Address,\n AddressStreetOneOf$5 as AddressStreetOneOf,\n StreetAddress$5 as StreetAddress,\n AddressLocation$5 as AddressLocation,\n Subdivision$5 as Subdivision,\n SubdivisionType$5 as SubdivisionType,\n StandardDetails$2 as StandardDetails,\n RsvpStatus$1 as RsvpStatus,\n Guest$1 as Guest,\n CheckIn$1 as CheckIn,\n eventsV1Rsvp_universal_d_ListRsvpRequest as ListRsvpRequest,\n eventsV1Rsvp_universal_d_RsvpFieldset as RsvpFieldset,\n eventsV1Rsvp_universal_d_RsvpTag as RsvpTag,\n eventsV1Rsvp_universal_d_ListRsvpResponse as ListRsvpResponse,\n FacetCounts$4 as FacetCounts,\n eventsV1Rsvp_universal_d_RsvpFacets as RsvpFacets,\n eventsV1Rsvp_universal_d_RsvpFacetCounts as RsvpFacetCounts,\n Counts$1 as Counts,\n eventsV1Rsvp_universal_d_QueryRsvpRequest as QueryRsvpRequest,\n eventsV1Rsvp_universal_d_QueryRsvpResponse as QueryRsvpResponse,\n GetRsvpRequest$1 as GetRsvpRequest,\n GetRsvpResponse$1 as GetRsvpResponse,\n CreateRsvpRequest$1 as CreateRsvpRequest,\n ModificationOptions$1 as ModificationOptions,\n CreateRsvpResponse$1 as CreateRsvpResponse,\n CalendarLinks$3 as CalendarLinks,\n eventsV1Rsvp_universal_d_RsvpCreated as RsvpCreated,\n OnlineConferencingLogin$2 as OnlineConferencingLogin,\n UpdateRsvpRequest$1 as UpdateRsvpRequest,\n UpdateRsvpResponse$1 as UpdateRsvpResponse,\n eventsV1Rsvp_universal_d_RsvpUpdated as RsvpUpdated,\n BulkUpdateRsvpRequest$1 as BulkUpdateRsvpRequest,\n BulkUpdateRsvpResponse$1 as BulkUpdateRsvpResponse,\n BulkUpdateRsvpContactIdRequest$1 as BulkUpdateRsvpContactIdRequest,\n eventsV1Rsvp_universal_d_BulkUpdateRsvpContactIdRequestRsvp as BulkUpdateRsvpContactIdRequestRsvp,\n BulkUpdateRsvpContactIdResponse$1 as BulkUpdateRsvpContactIdResponse,\n DeleteRsvpRequest$1 as DeleteRsvpRequest,\n DeleteRsvpResponse$1 as DeleteRsvpResponse,\n eventsV1Rsvp_universal_d_RsvpDeleted as RsvpDeleted,\n eventsV1Rsvp_universal_d_CheckInRsvpRequest as CheckInRsvpRequest,\n eventsV1Rsvp_universal_d_CheckInRsvpResponse as CheckInRsvpResponse,\n eventsV1Rsvp_universal_d_DeleteRsvpCheckInRequest as DeleteRsvpCheckInRequest,\n eventsV1Rsvp_universal_d_DeleteRsvpCheckInResponse as DeleteRsvpCheckInResponse,\n eventsV1Rsvp_universal_d_FindRsvpSummaryRequest as FindRsvpSummaryRequest,\n eventsV1Rsvp_universal_d_FindRsvpSummaryResponse as FindRsvpSummaryResponse,\n RsvpSummary$3 as RsvpSummary,\n eventsV1Rsvp_universal_d_CountRsvpAttendingGuestsRequest as CountRsvpAttendingGuestsRequest,\n eventsV1Rsvp_universal_d_CountRsvpAttendingGuestsResponse as CountRsvpAttendingGuestsResponse,\n MessageEnvelope$6 as MessageEnvelope,\n IdentificationData$6 as IdentificationData,\n IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf,\n WebhookIdentityType$6 as WebhookIdentityType,\n eventsV1Rsvp_universal_d_listRsvp as listRsvp,\n eventsV1Rsvp_universal_d_ListRsvpOptions as ListRsvpOptions,\n eventsV1Rsvp_universal_d_queryRsvp as queryRsvp,\n eventsV1Rsvp_universal_d_QueryRsvpOptions as QueryRsvpOptions,\n getRsvp$1 as getRsvp,\n GetRsvpOptions$1 as GetRsvpOptions,\n createRsvp$1 as createRsvp,\n CreateRsvpOptions$1 as CreateRsvpOptions,\n updateRsvp$1 as updateRsvp,\n UpdateRsvpOptions$1 as UpdateRsvpOptions,\n bulkUpdateRsvp$1 as bulkUpdateRsvp,\n BulkUpdateRsvpOptions$1 as BulkUpdateRsvpOptions,\n deleteRsvp$1 as deleteRsvp,\n eventsV1Rsvp_universal_d_DeleteRsvpOptions as DeleteRsvpOptions,\n eventsV1Rsvp_universal_d_checkInRsvp as checkInRsvp,\n eventsV1Rsvp_universal_d_CheckInRsvpOptions as CheckInRsvpOptions,\n eventsV1Rsvp_universal_d_deleteRsvpCheckIn as deleteRsvpCheckIn,\n eventsV1Rsvp_universal_d_DeleteRsvpCheckInOptions as DeleteRsvpCheckInOptions,\n };\n }\n \n interface TicketingTicket {\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$4;\n /**\n * Whether ticket requires payment.\n * @readonly\n */\n free?: boolean;\n /** Ticket and event policies. */\n policy?: string;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n qrCode?: string;\n /** Ticket check-in. */\n checkIn?: CheckIn;\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;\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;\n /** Whether the ticket is visible in an order. */\n archived?: boolean;\n /**\n * @internal\n * @internal\n * @deprecated\n */\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 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;\n /**\n * An URL to download a ticket in the `.pkpass` format for Apple Wallet.\n * @readonly\n */\n walletPassUrl?: string;\n /**\n * Additional ticket details.\n * @internal\n * @readonly\n */\n ticketDetails?: TicketDetails;\n }\n interface Money$4 {\n /**\n * *Deprecated:** Use `value` instead.\n * @deprecated\n */\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, starts with a single (-), to indicate that the amount is negative. */\n value?: string | null;\n }\n interface CheckIn {\n /** Time of a ticket check-in. */\n created?: Date | null;\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 GuestDetails {\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 /** Guest phone number. */\n phone?: string | null;\n }\n interface FormResponse$1 {\n /** Form field inputs. */\n inputValues?: InputValue$1[];\n }\n interface InputValue$1 {\n /** Form field input name. */\n inputName?: string;\n /** Form field value. */\n value?: string;\n /** Form field values. */\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date | null;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress$1;\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$4;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: Subdivision$4[];\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$4;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\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 ChannelType {\n /** Buyer created the order via an online channel such as a website or mobile app. */\n ONLINE = \"ONLINE\",\n /** Sales person created the order and collected the money. */\n OFFLINE_POS = \"OFFLINE_POS\"\n }\n interface TicketDetails {\n /** Unique seat id in the event venue. */\n seatId?: string | null;\n /**\n * Optional sector name.\n * @internal\n * @readonly\n */\n sectorName?: string | null;\n /**\n * Area name.\n * @internal\n * @readonly\n */\n areaName?: string | null;\n /**\n * Table name.\n * @internal\n * @readonly\n */\n tableName?: string | null;\n /**\n * Row label.\n * @internal\n * @readonly\n */\n rowNumber?: string | null;\n /**\n * Seat label in a row or table.\n * @internal\n * @readonly\n */\n seatNumber?: 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 /**\n * Deprecated, use `sort` instead.\n * Sort order. Defaults to \"ticket_number: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-tickets).\n * @internal\n * @deprecated\n */\n order?: string;\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[];\n /**\n * Deprecated, use `ORDER_ARCHIVED` / `ORDER_ACTIVE` state filter instead.\n * @internal\n * @deprecated\n */\n orderArchived?: boolean | null;\n /**\n * Deprecated, use `CHECKED_IN` / `NON_CHECKED_IN` state filter instead.\n * @internal\n * @deprecated\n */\n checkedIn?: boolean | null;\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$4[];\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 the ticket response. */\n GUEST_DETAILS = \"GUEST_DETAILS\",\n /** Include ticket details in the ticket response. */\n TICKET_DETAILS = \"TICKET_DETAILS\",\n /** Include individual guest form in the ticket response. */\n GUEST_FORM = \"GUEST_FORM\"\n }\n enum State$4 {\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[];\n /** Facets. */\n facets?: Record;\n /**\n * Ticket data enriched facets.\n * @internal\n */\n ticketFacets?: TicketFacets;\n }\n interface FacetCounts$3 {\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 {\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;\n }\n interface CheckInTicketRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /**\n * Deprecated, use individual ticket numbers.\n * @internal\n * @deprecated\n */\n orderNumber?: string;\n /** Tickets to check-in. */\n ticketNumber?: string[];\n }\n interface CheckInTicketResponse {\n /** Updated tickets. */\n tickets?: TicketingTicket[];\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 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 | 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$1;\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 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$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 DeleteTicketCheckInRequest {\n /** Event ID to which the ticket belongs. */\n eventId: string;\n /**\n * Deprecated, use individual ticket numbers.\n * @internal\n * @deprecated\n */\n orderNumber?: string;\n /** Ticket numbers which check-ins to delete. */\n ticketNumber?: string[];\n }\n interface DeleteTicketCheckInResponse {\n /** Updated tickets. */\n tickets?: TicketingTicket[];\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 /**\n * Set of field paths, specifying which parts of this resource to update.\n * When `fields` is empty, the request is interpreted as a full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\n /**\n * Deprecated. Use `guestDetails.form`\n * @internal\n * @deprecated\n */\n checkoutForm?: FormResponse$1;\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$1;\n }\n interface UpdateTicketResponse {\n /** Updated ticket. */\n ticket?: TicketingTicket;\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[];\n }\n interface GetDemoTicketRequest {\n /** Ticket definition ID. */\n definitionId?: string;\n }\n interface GetDemoTicketResponse {\n /** Ticket. */\n ticket?: TicketingTicket;\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 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 * @permissionId WIX_EVENTS.READ_TICKETS\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 /**\n * Deprecated, use `sort` instead.\n * Sort order. Defaults to \"ticket_number: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-tickets).\n * @internal\n * @deprecated\n */\n order?: string;\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[];\n /**\n * Deprecated, use `ORDER_ARCHIVED` / `ORDER_ACTIVE` state filter instead.\n * @internal\n * @deprecated\n */\n orderArchived?: boolean | null;\n /**\n * Deprecated, use `CHECKED_IN` / `NON_CHECKED_IN` state filter instead.\n * @internal\n * @deprecated\n */\n checkedIn?: boolean | null;\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$4[];\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 * @permissionId WIX_EVENTS.READ_TICKET_DETAILS\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 * @permissionId WIX_EVENTS.CHECK-IN\n * @adminMethod\n */\n function checkInTickets(eventId: string, options?: CheckInTicketsOptions): Promise;\n interface CheckInTicketsOptions {\n /**\n * Deprecated, use individual ticket numbers.\n * @internal\n * @deprecated\n */\n orderNumber?: string;\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 * @permissionId WIX_EVENTS.CHECK-IN\n * @adminMethod\n */\n function deleteTicketCheckIns(eventId: string, options?: DeleteTicketCheckInsOptions): Promise;\n interface DeleteTicketCheckInsOptions {\n /**\n * Deprecated, use individual ticket numbers.\n * @internal\n * @deprecated\n */\n orderNumber?: string;\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 * @permissionId WIX_EVENTS.MANAGE_TICKETS\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 /**\n * Set of field paths, specifying which parts of this resource to update.\n * When `fields` is empty, the request is interpreted as a full update.\n * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.\n * @internal\n */\n fields?: string[];\n /**\n * Deprecated. Use `guestDetails.form`\n * @internal\n * @deprecated\n */\n checkoutForm?: FormResponse$1;\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 * @permissionId WIX_EVENTS.MANAGE_TICKETS\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 \n type eventsV1Ticket_universal_d_TicketingTicket = TicketingTicket;\n type eventsV1Ticket_universal_d_CheckIn = CheckIn;\n type eventsV1Ticket_universal_d_OrderStatus = OrderStatus;\n const eventsV1Ticket_universal_d_OrderStatus: typeof OrderStatus;\n type eventsV1Ticket_universal_d_GuestDetails = GuestDetails;\n type eventsV1Ticket_universal_d_ChannelType = ChannelType;\n const eventsV1Ticket_universal_d_ChannelType: typeof ChannelType;\n type eventsV1Ticket_universal_d_TicketDetails = TicketDetails;\n type eventsV1Ticket_universal_d_ListTicketsRequest = ListTicketsRequest;\n type eventsV1Ticket_universal_d_TicketFieldset = TicketFieldset;\n const eventsV1Ticket_universal_d_TicketFieldset: typeof TicketFieldset;\n type eventsV1Ticket_universal_d_ListTicketsResponse = ListTicketsResponse;\n type eventsV1Ticket_universal_d_TicketFacets = TicketFacets;\n type eventsV1Ticket_universal_d_TicketFacetCounts = TicketFacetCounts;\n type eventsV1Ticket_universal_d_Counts = Counts;\n type eventsV1Ticket_universal_d_GetTicketRequest = GetTicketRequest;\n type eventsV1Ticket_universal_d_GetTicketResponse = GetTicketResponse;\n type eventsV1Ticket_universal_d_CheckInTicketRequest = CheckInTicketRequest;\n type eventsV1Ticket_universal_d_CheckInTicketResponse = CheckInTicketResponse;\n type eventsV1Ticket_universal_d_OrderUpdated = OrderUpdated;\n type eventsV1Ticket_universal_d_Ticket = Ticket;\n type eventsV1Ticket_universal_d_DeleteTicketCheckInRequest = DeleteTicketCheckInRequest;\n type eventsV1Ticket_universal_d_DeleteTicketCheckInResponse = DeleteTicketCheckInResponse;\n type eventsV1Ticket_universal_d_UpdateTicketRequest = UpdateTicketRequest;\n type eventsV1Ticket_universal_d_GuestDetailsUpdate = GuestDetailsUpdate;\n type eventsV1Ticket_universal_d_UpdateTicketResponse = UpdateTicketResponse;\n type eventsV1Ticket_universal_d_BulkUpdateTicketsRequest = BulkUpdateTicketsRequest;\n type eventsV1Ticket_universal_d_BulkUpdateTicketsResponse = BulkUpdateTicketsResponse;\n type eventsV1Ticket_universal_d_GetDemoTicketRequest = GetDemoTicketRequest;\n type eventsV1Ticket_universal_d_GetDemoTicketResponse = GetDemoTicketResponse;\n const eventsV1Ticket_universal_d_listTickets: typeof listTickets;\n type eventsV1Ticket_universal_d_ListTicketsOptions = ListTicketsOptions;\n const eventsV1Ticket_universal_d_getTicket: typeof getTicket;\n type eventsV1Ticket_universal_d_GetTicketIdentifiers = GetTicketIdentifiers;\n type eventsV1Ticket_universal_d_GetTicketOptions = GetTicketOptions;\n const eventsV1Ticket_universal_d_checkInTickets: typeof checkInTickets;\n type eventsV1Ticket_universal_d_CheckInTicketsOptions = CheckInTicketsOptions;\n const eventsV1Ticket_universal_d_deleteTicketCheckIns: typeof deleteTicketCheckIns;\n type eventsV1Ticket_universal_d_DeleteTicketCheckInsOptions = DeleteTicketCheckInsOptions;\n const eventsV1Ticket_universal_d_updateTicket: typeof updateTicket;\n type eventsV1Ticket_universal_d_UpdateTicketIdentifiers = UpdateTicketIdentifiers;\n type eventsV1Ticket_universal_d_UpdateTicketOptions = UpdateTicketOptions;\n const eventsV1Ticket_universal_d_bulkUpdateTickets: typeof bulkUpdateTickets;\n type eventsV1Ticket_universal_d_BulkUpdateTicketsOptions = BulkUpdateTicketsOptions;\n namespace eventsV1Ticket_universal_d {\n export {\n eventsV1Ticket_universal_d_TicketingTicket as TicketingTicket,\n Money$4 as Money,\n eventsV1Ticket_universal_d_CheckIn as CheckIn,\n eventsV1Ticket_universal_d_OrderStatus as OrderStatus,\n eventsV1Ticket_universal_d_GuestDetails as GuestDetails,\n FormResponse$1 as FormResponse,\n InputValue$1 as InputValue,\n FormattedAddress$1 as FormattedAddress,\n Address$4 as Address,\n AddressStreetOneOf$4 as AddressStreetOneOf,\n StreetAddress$4 as StreetAddress,\n AddressLocation$4 as AddressLocation,\n Subdivision$4 as Subdivision,\n SubdivisionType$4 as SubdivisionType,\n StandardDetails$1 as StandardDetails,\n eventsV1Ticket_universal_d_ChannelType as ChannelType,\n eventsV1Ticket_universal_d_TicketDetails as TicketDetails,\n eventsV1Ticket_universal_d_ListTicketsRequest as ListTicketsRequest,\n eventsV1Ticket_universal_d_TicketFieldset as TicketFieldset,\n State$4 as State,\n eventsV1Ticket_universal_d_ListTicketsResponse as ListTicketsResponse,\n FacetCounts$3 as FacetCounts,\n eventsV1Ticket_universal_d_TicketFacets as TicketFacets,\n eventsV1Ticket_universal_d_TicketFacetCounts as TicketFacetCounts,\n eventsV1Ticket_universal_d_Counts as Counts,\n eventsV1Ticket_universal_d_GetTicketRequest as GetTicketRequest,\n eventsV1Ticket_universal_d_GetTicketResponse as GetTicketResponse,\n eventsV1Ticket_universal_d_CheckInTicketRequest as CheckInTicketRequest,\n eventsV1Ticket_universal_d_CheckInTicketResponse as CheckInTicketResponse,\n eventsV1Ticket_universal_d_OrderUpdated as OrderUpdated,\n eventsV1Ticket_universal_d_Ticket as Ticket,\n OnlineConferencingLogin$1 as OnlineConferencingLogin,\n eventsV1Ticket_universal_d_DeleteTicketCheckInRequest as DeleteTicketCheckInRequest,\n eventsV1Ticket_universal_d_DeleteTicketCheckInResponse as DeleteTicketCheckInResponse,\n eventsV1Ticket_universal_d_UpdateTicketRequest as UpdateTicketRequest,\n eventsV1Ticket_universal_d_GuestDetailsUpdate as GuestDetailsUpdate,\n eventsV1Ticket_universal_d_UpdateTicketResponse as UpdateTicketResponse,\n eventsV1Ticket_universal_d_BulkUpdateTicketsRequest as BulkUpdateTicketsRequest,\n eventsV1Ticket_universal_d_BulkUpdateTicketsResponse as BulkUpdateTicketsResponse,\n eventsV1Ticket_universal_d_GetDemoTicketRequest as GetDemoTicketRequest,\n eventsV1Ticket_universal_d_GetDemoTicketResponse as GetDemoTicketResponse,\n MessageEnvelope$5 as MessageEnvelope,\n IdentificationData$5 as IdentificationData,\n IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf,\n WebhookIdentityType$5 as WebhookIdentityType,\n eventsV1Ticket_universal_d_listTickets as listTickets,\n eventsV1Ticket_universal_d_ListTicketsOptions as ListTicketsOptions,\n eventsV1Ticket_universal_d_getTicket as getTicket,\n eventsV1Ticket_universal_d_GetTicketIdentifiers as GetTicketIdentifiers,\n eventsV1Ticket_universal_d_GetTicketOptions as GetTicketOptions,\n eventsV1Ticket_universal_d_checkInTickets as checkInTickets,\n eventsV1Ticket_universal_d_CheckInTicketsOptions as CheckInTicketsOptions,\n eventsV1Ticket_universal_d_deleteTicketCheckIns as deleteTicketCheckIns,\n eventsV1Ticket_universal_d_DeleteTicketCheckInsOptions as DeleteTicketCheckInsOptions,\n eventsV1Ticket_universal_d_updateTicket as updateTicket,\n eventsV1Ticket_universal_d_UpdateTicketIdentifiers as UpdateTicketIdentifiers,\n eventsV1Ticket_universal_d_UpdateTicketOptions as UpdateTicketOptions,\n eventsV1Ticket_universal_d_bulkUpdateTickets as bulkUpdateTickets,\n eventsV1Ticket_universal_d_BulkUpdateTicketsOptions as BulkUpdateTicketsOptions,\n };\n }\n \n interface TicketDefinition$1 {\n /** Ticket definition ID. */\n _id?: string;\n /** Ticket price. */\n price?: Money$3;\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$3;\n /** Event ID associated with the ticket. */\n eventId?: string;\n /**\n * Configuration of the fixed-rate Wix ticket 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$3 {\n /**\n * @internal\n * @internal\n * @deprecated\n */\n amount?: 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 /** 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 Dashboard$3 {\n /** Whether ticket is hidden and cannot be sold. */\n hidden?: boolean;\n /**\n * Number of tickets sold and reserved.\n * @deprecated\n */\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 | null;\n /** Ticket sale end timestamp. */\n endDate?: Date | null;\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$3;\n /** Min price per ticket, customizable. */\n minPrice?: Money$3;\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 {\n /** Ticket price which is read only. */\n fixedPrice?: Money$3;\n /** Min price per ticket, customizable. */\n minPrice?: Money$3;\n /** Ticket pricing options. */\n pricingOptions?: PricingOptions$1;\n }\n interface PricingOptions$1 {\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$3;\n }\n enum Type$2 {\n STANDARD = \"STANDARD\",\n DONATION = \"DONATION\"\n }\n interface QueryTicketDefinitionsRequest$1 {\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$1 {\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$1[];\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 * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null;\n }\n interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {\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$4;\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$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$3 {\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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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$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 QueryTicketDefinitionsV2Response {\n /** Ticket definitions. */\n definitions?: TicketDefinition$1[];\n /** Paging metadata definitions. */\n metadata?: 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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 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$3[];\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 * Visible for coupons. For internal use.\n * @internal\n */\n visibleForCoupons?: boolean | null;\n /**\n * For internal use.\n * @internal\n */\n groupBy?: GroupBy;\n /**\n * Ticket definition ID.\n * @internal\n */\n _id?: string[];\n }\n enum State$3 {\n /** The ticket is available for purchase. */\n VISIBLE = \"VISIBLE\",\n /** The ticket is unavailable for purchase. */\n HIDDEN = \"HIDDEN\",\n /** The ticket price is 0. */\n FREE = \"FREE\",\n /** The 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$1[];\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$1 {\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$1 {\n /** Retrieved ticket definition. */\n definition?: TicketDefinition$1;\n }\n interface CreateTicketDefinitionRequest$1 {\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$3;\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 ticket 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$1 {\n /** Created ticket definition. */\n definition?: TicketDefinition$1;\n }\n interface TicketDefinitionCreated {\n /** Ticket Definition created timestamp in ISO UTC format. */\n timestamp?: Date | null;\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$1 {\n /** Event ID. */\n eventId: string;\n /** Ticket definition ID. */\n definitionId: string;\n /** Ticket definition data. */\n definition?: TicketDefinitionData;\n /**\n * Set of field paths, specifying which parts of ticket definition to update.\n * @internal\n */\n fields?: string[];\n }\n interface UpdateTicketDefinitionResponse$1 {\n /** Updated ticket definition. */\n definition?: TicketDefinition$1;\n }\n interface TicketDefinitionUpdated {\n /** Ticket definition updated timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Event ID. */\n eventId?: string;\n }\n interface DeleteTicketDefinitionRequest$1 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$1 {\n }\n interface TicketDefinitionDeleted {\n /** Ticket definition deleted timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Ticket definition ID. */\n ticketDefinitionId?: string;\n /** Event ID. */\n eventId?: string;\n }\n interface ChangeCurrencyRequest$1 {\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$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 PaidTicketDefinitionExistsRequest {\n }\n interface PaidTicketDefinitionExistsResponse {\n /** Paid exists. */\n paidExists?: boolean;\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 * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions) 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()`](/ticket-definitions-v2/query-ticket-definitions).\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 * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\n * @adminMethod\n */\n function queryTicketDefinitions$1(options?: QueryTicketDefinitionsOptions$1): Promise;\n interface QueryTicketDefinitionsOptions$1 {\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 /**\n * **Deprecated.** This function will continue to work until October 29, 2024, but a newer version is available at [`queryTicketDefinitions()`](/ticket-definitions-v2/query-ticket-definitions).\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()`](/ticket-definitions-v2/query-ticket-definitions).\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 1,000 ticket definitions, given the provided paging and filtering.\n * @public\n * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\n * @adminMethod\n */\n function queryTicketDefinitionsV2(options?: QueryTicketDefinitionsV2Options): DefinitionsQueryBuilder;\n interface QueryTicketDefinitionsV2Options {\n /**\n * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null | undefined;\n }\n interface QueryCursorResult$3 {\n cursors: Cursors$4;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface DefinitionsQueryResult extends QueryCursorResult$3 {\n items: TicketDefinition$1[];\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()`](/ticket-definitions-v2/query-ticket-definitions) 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()`](/ticket-definitions-v2/query-ticket-definitions).\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 * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\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$3[];\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 * Visible for coupons. For internal use.\n * @internal\n */\n visibleForCoupons?: boolean | null;\n /**\n * For internal use.\n * @internal\n */\n groupBy?: GroupBy;\n /**\n * Ticket definition ID.\n * @internal\n */\n _id?: string[];\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`getTicketDefinition()`](/ticket-definitions-v2/get-ticket-definition) 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()`](/ticket-definitions-v2/get-ticket-definition).\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 * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\n * @adminMethod\n * @returns Retrieved ticket definition.\n */\n function getTicketDefinition$1(definitionId: string, options?: GetTicketDefinitionOptions$1): Promise;\n interface GetTicketDefinitionOptions$1 {\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()`](/ticket-definitions-v2/create-ticket-definition) 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()`](/ticket-definitions-v2/create-ticket-definition).\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n */\n function createTicketDefinition$1(eventId: string, options: CreateTicketDefinitionOptions$1): Promise;\n interface CreateTicketDefinitionOptions$1 {\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()`](/ticket-definitions-v2/update-ticket-definition) 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()`](/ticket-definitions-v2/update-ticket-definition).\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n */\n function updateTicketDefinition$1(definitionId: string, eventId: string, options?: UpdateTicketDefinitionOptions$1): Promise;\n interface UpdateTicketDefinitionOptions$1 {\n /** Ticket definition data. */\n definition?: TicketDefinitionData;\n /**\n * Set of field paths, specifying which parts of ticket definition to update.\n * @internal\n */\n fields?: string[];\n }\n /**\n * **Deprecated.** This function will continue to work until November 8, 2024, but a newer version is available. Use the [`deleteTicketDefinition()`](/ticket-definitions-v2/delete-ticket-definition) 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()`](/ticket-definitions-v2/delete-ticket-definition).\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n */\n function deleteTicketDefinition$1(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()`](/ticket-definitions-v2/change-currency).\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()`](/ticket-definitions-v2/change-currency).\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n */\n function changeCurrency$1(options?: ChangeCurrencyOptions$1): Promise;\n interface ChangeCurrencyOptions$1 {\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 \n type eventsV1TicketDefinition_universal_d_WixFeeConfig = WixFeeConfig;\n type eventsV1TicketDefinition_universal_d_FeeType = FeeType;\n const eventsV1TicketDefinition_universal_d_FeeType: typeof FeeType;\n type eventsV1TicketDefinition_universal_d_TicketSalePeriod = TicketSalePeriod;\n type eventsV1TicketDefinition_universal_d_TicketSaleStatus = TicketSaleStatus;\n const eventsV1TicketDefinition_universal_d_TicketSaleStatus: typeof TicketSaleStatus;\n type eventsV1TicketDefinition_universal_d_TicketDefinitionStateEnumState = TicketDefinitionStateEnumState;\n const eventsV1TicketDefinition_universal_d_TicketDefinitionStateEnumState: typeof TicketDefinitionStateEnumState;\n type eventsV1TicketDefinition_universal_d_TicketPricing = TicketPricing;\n type eventsV1TicketDefinition_universal_d_TicketPricingPriceOneOf = TicketPricingPriceOneOf;\n type eventsV1TicketDefinition_universal_d_PricingOption = PricingOption;\n type eventsV1TicketDefinition_universal_d_TicketDefinitionFieldset = TicketDefinitionFieldset;\n const eventsV1TicketDefinition_universal_d_TicketDefinitionFieldset: typeof TicketDefinitionFieldset;\n type eventsV1TicketDefinition_universal_d_QueryTicketDefinitionsV2Request = QueryTicketDefinitionsV2Request;\n type eventsV1TicketDefinition_universal_d_QueryTicketDefinitionsV2Response = QueryTicketDefinitionsV2Response;\n type eventsV1TicketDefinition_universal_d_ListTicketDefinitionsRequest = ListTicketDefinitionsRequest;\n type eventsV1TicketDefinition_universal_d_GroupBy = GroupBy;\n const eventsV1TicketDefinition_universal_d_GroupBy: typeof GroupBy;\n type eventsV1TicketDefinition_universal_d_ListTicketDefinitionsResponse = ListTicketDefinitionsResponse;\n type eventsV1TicketDefinition_universal_d_ResponseMetaData = ResponseMetaData;\n type eventsV1TicketDefinition_universal_d_TicketDefinitionData = TicketDefinitionData;\n type eventsV1TicketDefinition_universal_d_TicketDefinitionCreated = TicketDefinitionCreated;\n type eventsV1TicketDefinition_universal_d_OriginatedFrom = OriginatedFrom;\n type eventsV1TicketDefinition_universal_d_TicketDefinitionUpdated = TicketDefinitionUpdated;\n type eventsV1TicketDefinition_universal_d_DeleteTicketDefinitionRequestDeleteOneOf = DeleteTicketDefinitionRequestDeleteOneOf;\n type eventsV1TicketDefinition_universal_d_ById = ById;\n type eventsV1TicketDefinition_universal_d_TicketDefinitionDeleted = TicketDefinitionDeleted;\n type eventsV1TicketDefinition_universal_d_PaidTicketDefinitionExistsRequest = PaidTicketDefinitionExistsRequest;\n type eventsV1TicketDefinition_universal_d_PaidTicketDefinitionExistsResponse = PaidTicketDefinitionExistsResponse;\n const eventsV1TicketDefinition_universal_d_queryTicketDefinitionsV2: typeof queryTicketDefinitionsV2;\n type eventsV1TicketDefinition_universal_d_QueryTicketDefinitionsV2Options = QueryTicketDefinitionsV2Options;\n type eventsV1TicketDefinition_universal_d_DefinitionsQueryResult = DefinitionsQueryResult;\n type eventsV1TicketDefinition_universal_d_DefinitionsQueryBuilder = DefinitionsQueryBuilder;\n const eventsV1TicketDefinition_universal_d_listTicketDefinitions: typeof listTicketDefinitions;\n type eventsV1TicketDefinition_universal_d_ListTicketDefinitionsOptions = ListTicketDefinitionsOptions;\n type eventsV1TicketDefinition_universal_d_DeleteTicketDefinitionOptions = DeleteTicketDefinitionOptions;\n namespace eventsV1TicketDefinition_universal_d {\n export {\n TicketDefinition$1 as TicketDefinition,\n Money$3 as Money,\n Dashboard$3 as Dashboard,\n eventsV1TicketDefinition_universal_d_WixFeeConfig as WixFeeConfig,\n eventsV1TicketDefinition_universal_d_FeeType as FeeType,\n eventsV1TicketDefinition_universal_d_TicketSalePeriod as TicketSalePeriod,\n eventsV1TicketDefinition_universal_d_TicketSaleStatus as TicketSaleStatus,\n eventsV1TicketDefinition_universal_d_TicketDefinitionStateEnumState as TicketDefinitionStateEnumState,\n eventsV1TicketDefinition_universal_d_TicketPricing as TicketPricing,\n eventsV1TicketDefinition_universal_d_TicketPricingPriceOneOf as TicketPricingPriceOneOf,\n PricingOptions$1 as PricingOptions,\n eventsV1TicketDefinition_universal_d_PricingOption as PricingOption,\n Type$2 as Type,\n QueryTicketDefinitionsRequest$1 as QueryTicketDefinitionsRequest,\n eventsV1TicketDefinition_universal_d_TicketDefinitionFieldset as TicketDefinitionFieldset,\n QueryTicketDefinitionsResponse$1 as QueryTicketDefinitionsResponse,\n FacetCounts$2 as FacetCounts,\n eventsV1TicketDefinition_universal_d_QueryTicketDefinitionsV2Request as QueryTicketDefinitionsV2Request,\n QueryV2$3 as QueryV2,\n QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf,\n Sorting$4 as Sorting,\n SortOrder$4 as SortOrder,\n Paging$4 as Paging,\n CursorPaging$4 as CursorPaging,\n eventsV1TicketDefinition_universal_d_QueryTicketDefinitionsV2Response as QueryTicketDefinitionsV2Response,\n PagingMetadataV2$4 as PagingMetadataV2,\n Cursors$4 as Cursors,\n eventsV1TicketDefinition_universal_d_ListTicketDefinitionsRequest as ListTicketDefinitionsRequest,\n State$3 as State,\n eventsV1TicketDefinition_universal_d_GroupBy as GroupBy,\n eventsV1TicketDefinition_universal_d_ListTicketDefinitionsResponse as ListTicketDefinitionsResponse,\n eventsV1TicketDefinition_universal_d_ResponseMetaData as ResponseMetaData,\n GetTicketDefinitionRequest$1 as GetTicketDefinitionRequest,\n GetTicketDefinitionResponse$1 as GetTicketDefinitionResponse,\n CreateTicketDefinitionRequest$1 as CreateTicketDefinitionRequest,\n eventsV1TicketDefinition_universal_d_TicketDefinitionData as TicketDefinitionData,\n CreateTicketDefinitionResponse$1 as CreateTicketDefinitionResponse,\n eventsV1TicketDefinition_universal_d_TicketDefinitionCreated as TicketDefinitionCreated,\n eventsV1TicketDefinition_universal_d_OriginatedFrom as OriginatedFrom,\n UpdateTicketDefinitionRequest$1 as UpdateTicketDefinitionRequest,\n UpdateTicketDefinitionResponse$1 as UpdateTicketDefinitionResponse,\n eventsV1TicketDefinition_universal_d_TicketDefinitionUpdated as TicketDefinitionUpdated,\n DeleteTicketDefinitionRequest$1 as DeleteTicketDefinitionRequest,\n eventsV1TicketDefinition_universal_d_DeleteTicketDefinitionRequestDeleteOneOf as DeleteTicketDefinitionRequestDeleteOneOf,\n eventsV1TicketDefinition_universal_d_ById as ById,\n DeleteTicketDefinitionResponse$1 as DeleteTicketDefinitionResponse,\n eventsV1TicketDefinition_universal_d_TicketDefinitionDeleted as TicketDefinitionDeleted,\n ChangeCurrencyRequest$1 as ChangeCurrencyRequest,\n ChangeCurrencyResponse$1 as ChangeCurrencyResponse,\n BulkCopyTicketDefinitionsByEventIdRequest$1 as BulkCopyTicketDefinitionsByEventIdRequest,\n BulkCopyTicketDefinitionsByEventIdResponse$1 as BulkCopyTicketDefinitionsByEventIdResponse,\n CopiedTicketDefinition$1 as CopiedTicketDefinition,\n eventsV1TicketDefinition_universal_d_PaidTicketDefinitionExistsRequest as PaidTicketDefinitionExistsRequest,\n eventsV1TicketDefinition_universal_d_PaidTicketDefinitionExistsResponse as PaidTicketDefinitionExistsResponse,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n queryTicketDefinitions$1 as queryTicketDefinitions,\n QueryTicketDefinitionsOptions$1 as QueryTicketDefinitionsOptions,\n eventsV1TicketDefinition_universal_d_queryTicketDefinitionsV2 as queryTicketDefinitionsV2,\n eventsV1TicketDefinition_universal_d_QueryTicketDefinitionsV2Options as QueryTicketDefinitionsV2Options,\n eventsV1TicketDefinition_universal_d_DefinitionsQueryResult as DefinitionsQueryResult,\n eventsV1TicketDefinition_universal_d_DefinitionsQueryBuilder as DefinitionsQueryBuilder,\n eventsV1TicketDefinition_universal_d_listTicketDefinitions as listTicketDefinitions,\n eventsV1TicketDefinition_universal_d_ListTicketDefinitionsOptions as ListTicketDefinitionsOptions,\n getTicketDefinition$1 as getTicketDefinition,\n GetTicketDefinitionOptions$1 as GetTicketDefinitionOptions,\n createTicketDefinition$1 as createTicketDefinition,\n CreateTicketDefinitionOptions$1 as CreateTicketDefinitionOptions,\n updateTicketDefinition$1 as updateTicketDefinition,\n UpdateTicketDefinitionOptions$1 as UpdateTicketDefinitionOptions,\n deleteTicketDefinition$1 as deleteTicketDefinition,\n eventsV1TicketDefinition_universal_d_DeleteTicketDefinitionOptions as DeleteTicketDefinitionOptions,\n changeCurrency$1 as changeCurrency,\n ChangeCurrencyOptions$1 as ChangeCurrencyOptions,\n };\n }\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 | null;\n /**\n * Date and time of the policy's latest update in.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\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$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 /** 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$3[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$2 {\n /** Pagination options. */\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$3;\n }\n interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order (ASC/DESC). Defaults to ASC */\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 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$3 {\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$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 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 | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$3;\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 /**\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$3 {\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$3;\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$3;\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$3 {\n VENUE = \"VENUE\",\n ONLINE = \"ONLINE\"\n }\n /** Physical address */\n interface Address$3 extends AddressStreetOneOf$3 {\n /** a break down of the street to number and street name */\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 (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$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 /** a break down of the street to number and street name */\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 * apartment number\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation$3 {\n /** address latitude coordinates */\n latitude?: number | null;\n /** address longitude coordinates */\n longitude?: number | null;\n }\n interface Subdivision$3 {\n /** subdivision short code */\n code?: string;\n /** subdivision full-name */\n name?: string;\n /**\n * subdivision level\n * @internal\n */\n type?: SubdivisionType$3;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\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 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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$3;\n }\n interface Recurrences$3 {\n /** Event occurrences. */\n occurrences?: Occurrence$3[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status$3;\n }\n interface Occurrence$3 {\n /** Event start timestamp. */\n startDate?: Date | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$3 {\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 Empty$3 {\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 * @permissionId WIX_EVENTS.MANAGE_POLICIES\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 * @permissionId WIX_EVENTS.MANAGE_POLICIES\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 | null;\n /**\n * Date and time of the policy's latest update in `yyyy-mm-ddThh:mm:sssZ` format.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\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 * @permissionId WIX_EVENTS.MANAGE_POLICIES\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 * @permissionId WIX_EVENTS.READ_POLICIES\n */\n function queryPolicies(): PoliciesQueryBuilder;\n interface QueryCursorResult$2 {\n cursors: Cursors$3;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface PoliciesQueryResult extends QueryCursorResult$2 {\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 * @permissionId WIX_EVENTS.MANAGE_POLICIES\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 * @permissionId WIX_EVENTS.READ_POLICIES\n * @returns The requested policy.\n */\n function getPolicy(policyId: string): Promise;\n \n type eventsV2Policy_universal_d_Policy = Policy;\n type eventsV2Policy_universal_d_CreatePolicyRequest = CreatePolicyRequest;\n type eventsV2Policy_universal_d_CreatePolicyResponse = CreatePolicyResponse;\n type eventsV2Policy_universal_d_UpdatePolicyRequest = UpdatePolicyRequest;\n type eventsV2Policy_universal_d_UpdatePolicyResponse = UpdatePolicyResponse;\n type eventsV2Policy_universal_d_UpdatePolicySortIndexRequest = UpdatePolicySortIndexRequest;\n type eventsV2Policy_universal_d_UpdatePolicySortIndexResponse = UpdatePolicySortIndexResponse;\n type eventsV2Policy_universal_d_DeletePolicyRequest = DeletePolicyRequest;\n type eventsV2Policy_universal_d_DeletePolicyResponse = DeletePolicyResponse;\n type eventsV2Policy_universal_d_QueryPoliciesRequest = QueryPoliciesRequest;\n type eventsV2Policy_universal_d_QueryPoliciesResponse = QueryPoliciesResponse;\n type eventsV2Policy_universal_d_ReorderEventPoliciesRequest = ReorderEventPoliciesRequest;\n type eventsV2Policy_universal_d_ReorderEventPoliciesRequestReferencePolicyOneOf = ReorderEventPoliciesRequestReferencePolicyOneOf;\n type eventsV2Policy_universal_d_ReorderEventPoliciesResponse = ReorderEventPoliciesResponse;\n type eventsV2Policy_universal_d_GetPolicyRequest = GetPolicyRequest;\n type eventsV2Policy_universal_d_GetPolicyResponse = GetPolicyResponse;\n type eventsV2Policy_universal_d_GetPolicyFromTrashBinRequest = GetPolicyFromTrashBinRequest;\n type eventsV2Policy_universal_d_GetPolicyFromTrashBinResponse = GetPolicyFromTrashBinResponse;\n const eventsV2Policy_universal_d_createPolicy: typeof createPolicy;\n const eventsV2Policy_universal_d_updatePolicy: typeof updatePolicy;\n type eventsV2Policy_universal_d_UpdatePolicy = UpdatePolicy;\n type eventsV2Policy_universal_d_UpdatePolicyOptions = UpdatePolicyOptions;\n const eventsV2Policy_universal_d_deletePolicy: typeof deletePolicy;\n const eventsV2Policy_universal_d_queryPolicies: typeof queryPolicies;\n type eventsV2Policy_universal_d_PoliciesQueryResult = PoliciesQueryResult;\n type eventsV2Policy_universal_d_PoliciesQueryBuilder = PoliciesQueryBuilder;\n const eventsV2Policy_universal_d_reorderEventPolicies: typeof reorderEventPolicies;\n type eventsV2Policy_universal_d_ReorderEventPoliciesOptions = ReorderEventPoliciesOptions;\n const eventsV2Policy_universal_d_getPolicy: typeof getPolicy;\n namespace eventsV2Policy_universal_d {\n export {\n eventsV2Policy_universal_d_Policy as Policy,\n eventsV2Policy_universal_d_CreatePolicyRequest as CreatePolicyRequest,\n eventsV2Policy_universal_d_CreatePolicyResponse as CreatePolicyResponse,\n eventsV2Policy_universal_d_UpdatePolicyRequest as UpdatePolicyRequest,\n eventsV2Policy_universal_d_UpdatePolicyResponse as UpdatePolicyResponse,\n eventsV2Policy_universal_d_UpdatePolicySortIndexRequest as UpdatePolicySortIndexRequest,\n eventsV2Policy_universal_d_UpdatePolicySortIndexResponse as UpdatePolicySortIndexResponse,\n eventsV2Policy_universal_d_DeletePolicyRequest as DeletePolicyRequest,\n eventsV2Policy_universal_d_DeletePolicyResponse as DeletePolicyResponse,\n eventsV2Policy_universal_d_QueryPoliciesRequest as QueryPoliciesRequest,\n QueryV2$2 as QueryV2,\n QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n Paging$3 as Paging,\n CursorPaging$3 as CursorPaging,\n eventsV2Policy_universal_d_QueryPoliciesResponse as QueryPoliciesResponse,\n PagingMetadataV2$3 as PagingMetadataV2,\n Cursors$3 as Cursors,\n eventsV2Policy_universal_d_ReorderEventPoliciesRequest as ReorderEventPoliciesRequest,\n eventsV2Policy_universal_d_ReorderEventPoliciesRequestReferencePolicyOneOf as ReorderEventPoliciesRequestReferencePolicyOneOf,\n eventsV2Policy_universal_d_ReorderEventPoliciesResponse as ReorderEventPoliciesResponse,\n eventsV2Policy_universal_d_GetPolicyRequest as GetPolicyRequest,\n eventsV2Policy_universal_d_GetPolicyResponse as GetPolicyResponse,\n EventCopied$1 as EventCopied,\n Location$3 as Location,\n MapCoordinates$3 as MapCoordinates,\n LocationType$3 as LocationType,\n Address$3 as Address,\n AddressStreetOneOf$3 as AddressStreetOneOf,\n StreetAddress$3 as StreetAddress,\n AddressLocation$3 as AddressLocation,\n Subdivision$3 as Subdivision,\n SubdivisionType$3 as SubdivisionType,\n ScheduleConfig$3 as ScheduleConfig,\n Recurrences$3 as Recurrences,\n Occurrence$3 as Occurrence,\n Status$3 as Status,\n EventStatus$3 as EventStatus,\n Empty$3 as Empty,\n eventsV2Policy_universal_d_GetPolicyFromTrashBinRequest as GetPolicyFromTrashBinRequest,\n eventsV2Policy_universal_d_GetPolicyFromTrashBinResponse as GetPolicyFromTrashBinResponse,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n eventsV2Policy_universal_d_createPolicy as createPolicy,\n eventsV2Policy_universal_d_updatePolicy as updatePolicy,\n eventsV2Policy_universal_d_UpdatePolicy as UpdatePolicy,\n eventsV2Policy_universal_d_UpdatePolicyOptions as UpdatePolicyOptions,\n eventsV2Policy_universal_d_deletePolicy as deletePolicy,\n eventsV2Policy_universal_d_queryPolicies as queryPolicies,\n eventsV2Policy_universal_d_PoliciesQueryResult as PoliciesQueryResult,\n eventsV2Policy_universal_d_PoliciesQueryBuilder as PoliciesQueryBuilder,\n eventsV2Policy_universal_d_reorderEventPolicies as reorderEventPolicies,\n eventsV2Policy_universal_d_ReorderEventPoliciesOptions as ReorderEventPoliciesOptions,\n eventsV2Policy_universal_d_getPolicy as getPolicy,\n };\n }\n \n interface V2Rsvp {\n /**\n * RSVP ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing revision must be used when updating the RSVP.\n * @readonly\n */\n revision?: string | null;\n /** Event ID to which the RSVP belongs. */\n eventId?: string | null;\n /**\n * Date and time when the RSVP was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time when the RSVP was update.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Site member ID. You can override the field value when updating RSVP. Overriding member ID requires the **WIX_EVENTS.MANAGE_RSVP** permission. */\n memberId?: string | null;\n /** Contact ID of a guest who filled in the RSVP form. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */\n contactId?: string | null;\n /** First name of a guest who filled in the RSVP form. */\n firstName?: string | null;\n /** Last name of a guest who filled in the RSVP form. */\n lastName?: string | null;\n /** Email of a guest who filled in the RSVP form. */\n email?: string | null;\n /** Event registration form. */\n form?: FormResponse;\n /** RSVP response status. */\n status?: RsvpStatus;\n /**\n * Total number of guests per 1 RSVP.\n * @readonly\n */\n totalGuests?: number | null;\n /**\n * Guest list.\n * @readonly\n */\n guestList?: GuestList;\n /**\n * Site language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * @readonly\n */\n language?: string | null;\n /**\n * Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * @readonly\n */\n locale?: string | null;\n /**\n * Whether all guests are checked in.\n * @readonly\n */\n fullyCheckedIn?: boolean | null;\n /**\n * How many guests are checked in.\n * @readonly\n */\n checkedInGuestCount?: number | null;\n /** Additional guest details. */\n additionalGuestDetails?: AdditionalGuestDetails;\n /** Whether the notifications are disabled. */\n disableNotifications?: boolean | null;\n /**\n * Guest login details for accessing the online conference event.\n * @readonly\n */\n onlineConferencingLogin?: OnlineConferencingLogin;\n /**\n * Whether the RSVP is anonymized.\n * @readonly\n */\n anonymized?: boolean | null;\n /**\n * Email domain of a guest who filled in the RSVP form.\n * @internal\n * @readonly\n */\n emailDomain?: string | null;\n /**\n * Custom field data for the RSVP object.\n *\n * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.\n */\n extendedFields?: ExtendedFields$1;\n }\n interface FormResponse {\n inputValues?: InputValue[];\n }\n interface InputValue {\n inputName?: string;\n value?: string;\n values?: string[];\n /**\n * Int or floating point number value.\n * @internal\n */\n number?: number | null;\n /**\n * Date/time value.\n * @internal\n */\n dateTime?: Date | null;\n /**\n * Address type value.\n * @internal\n */\n address?: FormattedAddress;\n }\n interface FormattedAddress {\n /** One line address representation. */\n formatted?: string;\n /** Address components (optional). */\n address?: CommonAddress$2;\n }\n /** Physical address */\n interface CommonAddress$2 extends CommonAddressStreetOneOf$2 {\n /** Street name and number. */\n streetAddress?: CommonStreetAddress$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 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: CommonAddressLocation$2;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: CommonSubdivision$2[];\n }\n /** @oneof */\n interface CommonAddressStreetOneOf$2 {\n /** Street name and number. */\n streetAddress?: CommonStreetAddress$2;\n /** Main address line, usually street and number as free text. */\n addressLine?: string | null;\n }\n interface CommonStreetAddress$2 {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\n }\n interface CommonAddressLocation$2 {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface CommonSubdivision$2 {\n /** Short subdivision code. */\n code?: string;\n /** Subdivision full name. */\n name?: string;\n /**\n * Subdivision level\n * @internal\n */\n type?: SubdivisionType$2;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\n /**\n * Standard organizations details (e.g. ISO).\n * @internal\n */\n standardDetails?: StandardDetails;\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 /** 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 RsvpStatus {\n /** Unknown status. This value is not used. */\n UNKNOWN_RSVP_STATUS = \"UNKNOWN_RSVP_STATUS\",\n /** Guest is attending the event. */\n YES = \"YES\",\n /** Guest is not attending the event. */\n NO = \"NO\",\n /** Guest is in a waitlist. */\n WAITLIST = \"WAITLIST\"\n }\n interface GuestList {\n /** List of guests. */\n guests?: Guest[];\n }\n interface Guest {\n /** Index in the guest list. */\n index?: number | null;\n /** Full name. */\n fullName?: string | null;\n /** Check-in details. */\n checkInDetails?: CheckInDetails;\n /** Guest ID. */\n guestId?: number | null;\n }\n interface CheckInDetails {\n /** Whether the guest has checked in. */\n checkedIn?: boolean | null;\n /** Check-in date. */\n checkInDate?: Date | null;\n }\n interface AdditionalGuestDetails {\n /** Number of additional guests. */\n guestCount?: number | null;\n /** Names of additional guests. */\n guestNames?: 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 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 SearchRsvpsRequest {\n /** Search options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n search?: CursorSearch;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\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$2;\n /**\n * Filter object.\n *\n * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).\n */\n sort?: Sorting$2[];\n /**\n * Logical groupings of data into facets, with summaries for each facet.\n * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.\n */\n aggregations?: Aggregation[];\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n /**\n * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.\n * Applies to all relevant filters and aggregations, unless overridden by providing 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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Aggregation extends AggregationKindOneOf {\n /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */\n value?: ValueAggregation;\n /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */\n range?: RangeAggregation;\n /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */\n scalar?: ScalarAggregation;\n /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */\n dateHistogram?: DateHistogramAggregation;\n /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */\n nested?: NestedAggregation;\n /** Aggregation name displayed in the return. */\n name?: string | null;\n /** Type of aggregation to perform. */\n type?: AggregationType;\n /**\n * Field to aggregate by.\n * Use dot notation to specify a JSON path. For example, `order.address.streetName`.\n */\n fieldPath?: string;\n }\n /** @oneof */\n interface AggregationKindOneOf {\n /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */\n value?: ValueAggregation;\n /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */\n range?: RangeAggregation;\n /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */\n scalar?: ScalarAggregation;\n /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */\n dateHistogram?: DateHistogramAggregation;\n /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */\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 /** Number of matches in the results. */\n COUNT = \"COUNT\",\n /** Alphabetically by the field value. */\n VALUE = \"VALUE\"\n }\n enum SortDirection {\n /** Descending order. */\n DESC = \"DESC\",\n /** 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 /**\n * Specify a custom name for the bucket containing the missing values.\n * Defaults: `\"N/A\"` for strings, `0` for integers, and `false` for booleans.\n */\n addToBucket?: string;\n }\n enum ScalarType {\n /** Unknown scalar type. This value is not used. */\n UNKNOWN_SCALAR_TYPE = \"UNKNOWN_SCALAR_TYPE\",\n /** Total number 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 /**\n * Whether to include or exclude missing values in the aggregation results.\n * Default: `EXCLUDE`.\n */\n includeOptions?: IncludeMissingValuesOptions;\n /** Sort type. */\n sortType?: SortType;\n /** Sort direction. */\n sortDirection?: SortDirection;\n /**\n * Number of aggregation results to return.\n * Min: `1`\n * Max: `250`\n * Default: `10`\n */\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 /**\n * Whether to include or exclude missing values in the aggregation results.\n * Default: `EXCLUDE`.\n */\n includeOptions?: IncludeMissingValuesOptions;\n }\n enum NestedAggregationType {\n /** Unknown aggregation type. This value is not used. */\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */\n VALUE = \"VALUE\",\n /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */\n RANGE = \"RANGE\",\n /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */\n SCALAR = \"SCALAR\",\n /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */\n DATE_HISTOGRAM = \"DATE_HISTOGRAM\"\n }\n interface RangeAggregation {\n /** List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds. */\n buckets?: RangeBucket[];\n }\n interface ScalarAggregation {\n /** Operator type for the scalar aggregation. */\n type?: ScalarType;\n }\n interface DateHistogramAggregation {\n /** Interval for date histogram aggregation */\n interval?: Interval;\n }\n enum Interval {\n /** Unknown interval. This value is not used. */\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 /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */\n value?: ValueAggregation;\n /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */\n range?: RangeAggregation;\n /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */\n scalar?: ScalarAggregation;\n /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */\n dateHistogram?: DateHistogramAggregation;\n /** Unique, caller-defined aggregation name, returned in `aggregations.results`. */\n name?: string | null;\n /** Type of aggregation to perform. The matching aggregation field must be passed. */\n type?: NestedAggregationType;\n /**\n * Field to aggregate by.\n * Use dot notation to specify a JSON path. For example, `order.address.streetName`.\n */\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationItemKindOneOf {\n /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */\n value?: ValueAggregation;\n /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */\n range?: RangeAggregation;\n /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */\n scalar?: ScalarAggregation;\n /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */\n dateHistogram?: DateHistogramAggregation;\n }\n enum AggregationType {\n /** Unknown type. This value is not used. */\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */\n VALUE = \"VALUE\",\n /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */\n RANGE = \"RANGE\",\n /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */\n SCALAR = \"SCALAR\",\n /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */\n DATE_HISTOGRAM = \"DATE_HISTOGRAM\",\n /** Flattened list of aggregations, where each aggregation is nested within previous one. */\n NESTED = \"NESTED\"\n }\n /** Flattened list of aggregations, where each aggregation is nested within previous one. */\n interface NestedAggregation {\n /** Flattened list of aggregations, where each aggregation is nested within previous one. */\n nestedAggregations?: NestedAggregationItem[];\n }\n interface SearchDetails {\n /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */\n mode?: Mode;\n /** Search term or expression. */\n expression?: string | null;\n /**\n * Fields to search in. If the array is empty, all searchable fields are searched.\n * Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`.\n */\n fields?: string[];\n /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */\n fuzzy?: boolean;\n }\n enum Mode {\n /** At least one of the search terms must be present. */\n OR = \"OR\",\n /** Searches by all provided words. */\n AND = \"AND\"\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 enum RequestedFields$1 {\n /** Unknown requested field. This value is not used. */\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. */\n DETAILS = \"DETAILS\",\n /** Returns `form`. */\n FORM = \"FORM\",\n /** Returns `email`. */\n CONTACT_DETAILS = \"CONTACT_DETAILS\"\n }\n interface SearchRsvpsResponse {\n /** List of RSVPs. */\n rsvps?: V2Rsvp[];\n /** Metadata for the paginated results. */\n pagingMetadata?: CursorPagingMetadata;\n /** Aggregation data. */\n aggregationData?: AggregationData;\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$2;\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$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 AggregationData {\n /** List of the aggregated data results. */\n results?: AggregationResults[];\n }\n interface ValueAggregationResult {\n /** Value of the field. */\n value?: string;\n /** Total number 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 /** Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`. */\n name?: string;\n /** Aggregation type. */\n type?: AggregationType;\n /** Field which the data was aggregated by. */\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 ranges returned in the same order as requested. */\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 /** Total number 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 /** Total number 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](https://en.wikipedia.org/wiki/ISO_8601) format. */\n value?: string;\n /** Total number of entities 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 /** Results of `NESTED` aggregation type in a flattened array, identifiable by the requested aggregation `name`. */\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 /** Aggregation name displayed in the return. */\n name?: string;\n /** Type of aggregation that was performed. */\n type?: AggregationType;\n /** Field which the data was aggregated by. */\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 SearchRsvpsWithOffsetRequest {\n /** Search options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n search?: Search;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n interface Search extends SearchPagingMethodOneOf {\n /** Paging options to limit and offset 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 * Filter object.\n *\n * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).\n */\n filter?: Record | null;\n /**\n * Sort object.\n *\n * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).\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 * Logical groupings of data into facets, with summaries for each facet.\n * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.\n */\n aggregations?: Aggregation[];\n /** Free text to match in searchable fields. */\n search?: SearchDetails;\n /**\n * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.\n * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, \"2023-12-20T10:52:34.795Z\".\n */\n timeZone?: string | null;\n }\n /** @oneof */\n interface SearchPagingMethodOneOf {\n /** Paging options to limit and offset 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 SearchRsvpsWithOffsetResponse {\n /** List of RSVPs. */\n rsvps?: V2Rsvp[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$2;\n /** Aggregation data. */\n aggregationData?: AggregationData;\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryRsvpsRequest {\n /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n query?: CursorQuery;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\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`, `$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 }\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 QueryRsvpsResponse {\n /** List of RSVPs. */\n rsvps?: V2Rsvp[];\n /** Metadata for the paginated results. */\n pagingMetadata?: CursorPagingMetadata;\n }\n interface CountRsvpsRequest {\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 /** Search details. */\n search?: SearchDetails;\n }\n interface CountRsvpsResponse {\n /** Number of RSVPs. */\n count?: number;\n }\n interface GetRsvpRequest {\n /** RSVP ID. */\n rsvpId: string;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n interface GetRsvpResponse {\n /** The requested RSVP. */\n rsvp?: V2Rsvp;\n }\n interface CreateRsvpRequest {\n /** RSVP info. */\n rsvp: V2Rsvp;\n /** RSVP options.
      The **WIX_EVENTS.MANAGE_RSVP** permission is required. */\n options?: ModificationOptions;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n interface ModificationOptions {\n /** Whether to create or update RSVP regardless of event's guest limit. */\n ignoreLimits?: boolean;\n /** Whether to ignore the form validation. */\n ignoreFormValidation?: boolean;\n /** Whether to ignore response status. */\n ignoreResponseStatus?: boolean;\n /** Whether to ignore additional guest names validation. */\n ignoreAdditionalGuestNames?: boolean;\n }\n interface CreateRsvpResponse {\n /** Created RSVP. */\n rsvp?: V2Rsvp;\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 GuestLimitExceededData {\n /** Max rsvp guest list size. */\n maxRsvpSize?: number;\n }\n interface UpdateRsvpRequest {\n /** RSVP to update. */\n rsvp: V2Rsvp;\n /**\n * List of exact fields to update. For example, if you define only the `firstName`, all other fields are ignored.\n * @internal\n */\n fieldMask: string[];\n /** RSVP options.
      The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */\n options?: ModificationOptions;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n interface UpdateRsvpResponse {\n /** Updated RSVP. */\n rsvp?: V2Rsvp;\n }\n interface DeleteRsvpRequest {\n /** ID of RSVP to delete. */\n rsvpId: string | null;\n }\n interface DeleteRsvpResponse {\n }\n interface BulkUpdateRsvpRequest {\n /** RSVPs to update. */\n rsvps: MaskedRsvp[];\n /** Whether to return the whole `rsvp` object in the response. If `false`, only metadata is returned. */\n returnEntity?: boolean;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n /** RSVP options.
      The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */\n options?: ModificationOptions;\n }\n interface MaskedRsvp {\n /** RSVP to update. */\n rsvp?: V2Rsvp;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateRsvpResponse {\n /** Response of bulk update. */\n results?: BulkRsvpResult[];\n /** Response 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 BulkRsvpResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata;\n /** Updated RSVP. */\n rsvp?: V2Rsvp;\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 BulkDeleteRsvpsByFilterRequest {\n /** Filter object. */\n filter: Record | null;\n /** Search details. */\n search?: SearchDetails;\n }\n interface BulkDeleteRsvpsByFilterResponse {\n /** Job ID. 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 jobId?: string;\n }\n interface CheckInRsvpGuestsRequest {\n /** ID of RSVP to check-in. */\n rsvpId: string | null;\n /** IDs of guests to check-in. */\n guestIds?: number[];\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n interface CheckInRsvpGuestsResponse {\n /** Updated RSVP. */\n rsvp?: V2Rsvp;\n }\n interface CancelRsvpGuestsCheckInRequest {\n /** ID of RSVP to cancel check-in. */\n rsvpId: string;\n /** IDs of guests to check-in. */\n guestIds?: number[];\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n interface CancelRsvpGuestsCheckInResponse {\n /** Updated RSVP. */\n rsvp?: V2Rsvp;\n }\n interface ListRsvpSummaryRequest {\n /** Event ID. */\n eventId: string[] | null;\n /**\n * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null;\n }\n interface ListRsvpSummaryResponse {\n /** List of RSVP summary. */\n summaries?: V2RsvpSummary[];\n }\n interface V2RsvpSummary {\n /**\n * Event ID.\n * @readonly\n */\n eventId?: string | null;\n /**\n * Number of RSVPs that answered `yes`.\n * @readonly\n */\n yesGuestCount?: number | null;\n /**\n * Number of RSVPs that answered `no`.\n * @readonly\n */\n noGuestCount?: number | null;\n /**\n * Number of RSVPs that are in the waitlist.\n * @readonly\n */\n waitlistGuestCount?: number | null;\n /**\n * Total number of RSVPs.\n * @readonly\n */\n totalRsvpCount?: number | null;\n }\n interface CompareRsvpSummaryRequest {\n /** Event ID. */\n eventId?: string | null;\n /** Whether to apply fixes. */\n applyFix?: boolean | null;\n }\n interface CompareRsvpSummaryResponse {\n /** Actual Rsvp summary. */\n actualSummary?: V2RsvpSummary;\n /** Persisted Rsvp summary. */\n persistedSummary?: V2RsvpSummary;\n }\n interface EventCreated$2 {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date | null;\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 /** Event that was created. */\n event?: Event$2;\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 /** 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 /** 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 * apartment number\n * @internal\n */\n apt?: 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 * subdivision level\n * @internal\n */\n type?: SubdivisionType$2;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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 Event$2 {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location$2;\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 | null;\n /** Event modified timestamp. */\n modified?: Date | null;\n /** Event status. */\n status?: EventStatus$2;\n /** RSVP or ticketing registration details. */\n registration?: Registration$2;\n /** \"Add to calendar\" URLs. */\n calendarLinks?: CalendarLinks$2;\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$2;\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 * @internal\n * @readonly\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: LabellingSettings$2;\n }\n interface Scheduling$2 {\n /** Schedule configuration. */\n config?: ScheduleConfig$2;\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$2;\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$2;\n }\n enum EventType$2 {\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 | null;\n /** Registration end timestamp. */\n endDate?: Date | null;\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 /**\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$2;\n /**\n * Price of lowest priced ticket.\n * @readonly\n */\n lowestTicketPrice?: Money$2;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: Money$2;\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 /**\n * App Id for external ticket stock management.\n * By default tickets stock is defined in TicketDefinition object.\n * If defined then limitation from TicketDefinition is ignored.\n * @internal\n */\n stockManagerAppId?: string | null;\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$2;\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$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 Money$2 {\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 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 /** 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 /**\n * Deprecated: Use `id`.\n * @deprecated\n */\n name?: string;\n /** Child inputs. */\n inputs?: Input$2[];\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$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 /**\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$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$2 {\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$2;\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$2;\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 * Configured conferencing provider name.\n * @internal\n * @readonly\n */\n providerName?: string;\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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 * Date and time when category was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Assigned events count. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$2;\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$2[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\n }\n interface CategoryCounts$2 {\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$2 {\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 /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */\n hideEventDetailsPage?: boolean | null;\n }\n interface LabellingSettings$2 {\n /**\n * @internal\n * @readonly\n */\n assignedContactsLegacyLabelId?: string | null;\n /**\n * @internal\n * @readonly\n */\n assignedContactsLabelDeleted?: boolean | null;\n }\n interface Empty$2 {\n }\n interface EventDeleted$2 {\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 * Event categories.\n * @internal\n */\n categories?: string[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface BulkUpdateRsvpContactIdRequest {\n /** RSVP IDs. */\n rsvpIds?: string[] | null;\n /** New RSVP contact ID. */\n contactId?: string | null;\n }\n interface BulkUpdateRsvpContactIdResponse {\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 a list of RSVPs that match the provided search query and optionally performs aggregations on the data queried.\n *\n * To learn about working with _Search_ 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 * @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.READ_RSVP\n * @adminMethod\n */\n function searchRsvps(options?: SearchRsvpsOptions): Promise;\n interface SearchRsvpsOptions {\n /** Search options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */\n search?: CursorSearch;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n /**\n * Retrieves a list of RSVPs, given the provided paging, filtering, and sorting. Query RSVPs runs with these defaults, which you can override:\n *\n * - `createdDate` is sorted in `ASC` order\n * - `paging.limit` is `100`\n * - `paging.offset` is `0`\n *\n * For field support for filters and sorting, see [RSVP v2: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/filter-and-sort). To learn about working with Query endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n *\n * > **Note:** This method is quite slow. We suggest you using the following filter pairs for the most optimal speed:\n * > - `eventId` and `status`\n * > - `eventId` and `fullyCheckedIn`\n * > - `eventId` and `memberId`\n * > - `eventId` and `contactId`\n * > - `eventId` and `createdDate`\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.READ_RSVP\n * @adminMethod\n */\n function queryRsvps(options?: QueryRsvpsOptions): RsvpsQueryBuilder;\n interface QueryRsvpsOptions {\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[] | undefined;\n }\n interface QueryCursorResult$1 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface RsvpsQueryResult extends QueryCursorResult$1 {\n items: V2Rsvp[];\n query: RsvpsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface RsvpsQueryBuilder {\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' | 'eventId' | '_createdDate' | '_updatedDate' | 'memberId' | 'contactId' | 'status' | 'fullyCheckedIn', value: any) => RsvpsQueryBuilder;\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' | 'eventId' | '_createdDate' | '_updatedDate' | 'memberId' | 'contactId' | 'status' | 'fullyCheckedIn', value: any) => RsvpsQueryBuilder;\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) => RsvpsQueryBuilder;\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) => RsvpsQueryBuilder;\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) => RsvpsQueryBuilder;\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) => RsvpsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'eventId' | '_createdDate' | '_updatedDate' | 'memberId' | 'contactId' | 'status' | 'fullyCheckedIn', value: any) => RsvpsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'eventId' | 'memberId' | 'contactId', value: boolean) => RsvpsQueryBuilder;\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' | '_updatedDate' | 'status' | 'fullyCheckedIn'>) => RsvpsQueryBuilder;\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' | '_updatedDate' | 'status' | 'fullyCheckedIn'>) => RsvpsQueryBuilder;\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) => RsvpsQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => RsvpsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts RSVPs given the provided filtering and searching.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_EVENTS.READ_RSVP\n * @adminMethod\n */\n function countRsvps(options?: CountRsvpsOptions): Promise;\n interface CountRsvpsOptions {\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 /** Search details. */\n search?: SearchDetails;\n }\n /**\n * Retrieves RSVP by ID.\n * @param rsvpId - RSVP ID.\n * @public\n * @documentationMaturity preview\n * @requiredField rsvpId\n * @permissionId WIX_EVENTS.READ_RSVP\n * @adminMethod\n * @returns The requested RSVP.\n */\n function getRsvp(rsvpId: string, options?: GetRsvpOptions): Promise;\n interface GetRsvpOptions {\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n /**\n * Creates RSVP.\n *\n * To create RSVP with multiple guests, you have to specify the `additionalGuests` and `guestNames` fields.\n * @param rsvp - RSVP info.\n * @public\n * @documentationMaturity preview\n * @requiredField rsvp\n * @requiredField rsvp.additionalGuestDetails.guestCount\n * @requiredField rsvp.email\n * @requiredField rsvp.eventId\n * @requiredField rsvp.firstName\n * @requiredField rsvp.lastName\n * @requiredField rsvp.status\n * @permissionId WIX_EVENTS.CREATE_RSVP\n * @returns Created RSVP.\n */\n function createRsvp(rsvp: V2Rsvp, options?: CreateRsvpOptions): Promise;\n interface CreateRsvpOptions {\n /** RSVP options.
      The **WIX_EVENTS.MANAGE_RSVP** permission is required. */\n options?: ModificationOptions;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n /**\n * Updates RSVP.\n *\n * Each time the RSVP is updated, `revision` increments by 1. The existing `revision` must be included when updating the RSVP. This ensures you're working with the latest RSVP and prevents unintended overwrites.\n * @param _id - RSVP ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField rsvp\n * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n * @returns Updated RSVP.\n */\n function updateRsvp(_id: string | null, rsvp: UpdateRsvp, options?: UpdateRsvpOptions): Promise;\n interface UpdateRsvp {\n /**\n * RSVP ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing revision must be used when updating the RSVP.\n * @readonly\n */\n revision?: string | null;\n /** Event ID to which the RSVP belongs. */\n eventId?: string | null;\n /**\n * Date and time when the RSVP was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time when the RSVP was update.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Site member ID. You can override the field value when updating RSVP. Overriding member ID requires the **WIX_EVENTS.MANAGE_RSVP** permission. */\n memberId?: string | null;\n /** Contact ID of a guest who filled in the RSVP form. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */\n contactId?: string | null;\n /** First name of a guest who filled in the RSVP form. */\n firstName?: string | null;\n /** Last name of a guest who filled in the RSVP form. */\n lastName?: string | null;\n /** Email of a guest who filled in the RSVP form. */\n email?: string | null;\n /** Event registration form. */\n form?: FormResponse;\n /** RSVP response status. */\n status?: RsvpStatus;\n /**\n * Total number of guests per 1 RSVP.\n * @readonly\n */\n totalGuests?: number | null;\n /**\n * Guest list.\n * @readonly\n */\n guestList?: GuestList;\n /**\n * Site language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n * @readonly\n */\n language?: string | null;\n /**\n * Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format.\n * @readonly\n */\n locale?: string | null;\n /**\n * Whether all guests are checked in.\n * @readonly\n */\n fullyCheckedIn?: boolean | null;\n /**\n * How many guests are checked in.\n * @readonly\n */\n checkedInGuestCount?: number | null;\n /** Additional guest details. */\n additionalGuestDetails?: AdditionalGuestDetails;\n /** Whether the notifications are disabled. */\n disableNotifications?: boolean | null;\n /**\n * Guest login details for accessing the online conference event.\n * @readonly\n */\n onlineConferencingLogin?: OnlineConferencingLogin;\n /**\n * Whether the RSVP is anonymized.\n * @readonly\n */\n anonymized?: boolean | null;\n /**\n * Email domain of a guest who filled in the RSVP form.\n * @internal\n * @readonly\n */\n emailDomain?: string | null;\n /**\n * Custom field data for the RSVP object.\n *\n * **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.\n */\n extendedFields?: ExtendedFields$1;\n }\n interface UpdateRsvpOptions {\n /**\n * List of exact fields to update. For example, if you define only the `firstName`, all other fields are ignored.\n * @internal\n */\n fieldMask: string[];\n /** RSVP options.
      The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */\n options?: ModificationOptions;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n /**\n * Permanently deletes RSVP.\n * @param rsvpId - ID of RSVP to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField rsvpId\n * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n */\n function deleteRsvp(rsvpId: string | null): Promise;\n /**\n * Updates multiple RSVPs.\n *\n * You can update up to 100 RSVPs per request.\n * @param rsvps - RSVPs to update.\n * @public\n * @documentationMaturity preview\n * @requiredField rsvps\n * @requiredField rsvps.rsvp._id\n * @requiredField rsvps.rsvp.revision\n * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n */\n function bulkUpdateRsvp(rsvps: MaskedRsvp[], options?: BulkUpdateRsvpOptions): Promise;\n interface BulkUpdateRsvpOptions {\n /** Whether to return the whole `rsvp` object in the response. If `false`, only metadata is returned. */\n returnEntity?: boolean;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n /** RSVP options.
      The **WIX_EVENTS.MANAGE_RSVP** permission is required to pass these fields. */\n options?: ModificationOptions;\n }\n /**\n * Permanently deletes multiple RSVPs by filter.\n * @param filter - Filter object.\n * @public\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_EVENTS.MANAGE_RSVP\n * @adminMethod\n */\n function bulkDeleteRsvpsByFilter(filter: Record | null, options?: BulkDeleteRsvpsByFilterOptions): Promise;\n interface BulkDeleteRsvpsByFilterOptions {\n /** Search details. */\n search?: SearchDetails;\n }\n /**\n * Checks in RSVP guests.\n *\n * You can check in up to 11 guests per request.\n * @param rsvpId - ID of RSVP to check-in.\n * @public\n * @documentationMaturity preview\n * @requiredField rsvpId\n * @permissionId WIX_EVENTS.CHECK_IN\n * @adminMethod\n */\n function checkInRsvpGuests(rsvpId: string | null, options?: CheckInRsvpGuestsOptions): Promise;\n interface CheckInRsvpGuestsOptions {\n /** IDs of guests to check-in. */\n guestIds?: number[];\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n /**\n * Cancels the check-in of RSVP guests.\n *\n * If the request body is empty, cancels all check-ins from the RSVP. After the cancellation, the `guests.checkInDate` value becomes empty.\n *\n * You can cancel check-in of up to 11 guests per request.\n * @param rsvpId - ID of RSVP to cancel check-in.\n * @public\n * @documentationMaturity preview\n * @requiredField rsvpId\n * @permissionId WIX_EVENTS.CHECK_IN\n * @adminMethod\n */\n function cancelRsvpGuestsCheckIn(rsvpId: string, options?: CancelRsvpGuestsCheckInOptions): Promise;\n interface CancelRsvpGuestsCheckInOptions {\n /** IDs of guests to check-in. */\n guestIds?: number[];\n /** Predefined sets of fields to return. */\n fields?: RequestedFields$1[];\n }\n /**\n * Retrieves RSVP summary by ID.\n * @param eventId - Event ID.\n * @public\n * @documentationMaturity preview\n * @requiredField eventId\n * @permissionId WIX_EVENTS.READ_RSVP\n * @adminMethod\n */\n function listRsvpSummary(eventId: string[] | null, options?: ListRsvpSummaryOptions): Promise;\n interface ListRsvpSummaryOptions {\n /**\n * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null;\n }\n \n type eventsV2Rsvp_universal_d_V2Rsvp = V2Rsvp;\n type eventsV2Rsvp_universal_d_FormResponse = FormResponse;\n type eventsV2Rsvp_universal_d_InputValue = InputValue;\n type eventsV2Rsvp_universal_d_FormattedAddress = FormattedAddress;\n type eventsV2Rsvp_universal_d_StandardDetails = StandardDetails;\n type eventsV2Rsvp_universal_d_RsvpStatus = RsvpStatus;\n const eventsV2Rsvp_universal_d_RsvpStatus: typeof RsvpStatus;\n type eventsV2Rsvp_universal_d_GuestList = GuestList;\n type eventsV2Rsvp_universal_d_Guest = Guest;\n type eventsV2Rsvp_universal_d_CheckInDetails = CheckInDetails;\n type eventsV2Rsvp_universal_d_AdditionalGuestDetails = AdditionalGuestDetails;\n type eventsV2Rsvp_universal_d_OnlineConferencingLogin = OnlineConferencingLogin;\n type eventsV2Rsvp_universal_d_SearchRsvpsRequest = SearchRsvpsRequest;\n type eventsV2Rsvp_universal_d_CursorSearch = CursorSearch;\n type eventsV2Rsvp_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type eventsV2Rsvp_universal_d_Aggregation = Aggregation;\n type eventsV2Rsvp_universal_d_AggregationKindOneOf = AggregationKindOneOf;\n type eventsV2Rsvp_universal_d_RangeBucket = RangeBucket;\n type eventsV2Rsvp_universal_d_SortType = SortType;\n const eventsV2Rsvp_universal_d_SortType: typeof SortType;\n type eventsV2Rsvp_universal_d_SortDirection = SortDirection;\n const eventsV2Rsvp_universal_d_SortDirection: typeof SortDirection;\n type eventsV2Rsvp_universal_d_MissingValues = MissingValues;\n const eventsV2Rsvp_universal_d_MissingValues: typeof MissingValues;\n type eventsV2Rsvp_universal_d_IncludeMissingValuesOptions = IncludeMissingValuesOptions;\n type eventsV2Rsvp_universal_d_ScalarType = ScalarType;\n const eventsV2Rsvp_universal_d_ScalarType: typeof ScalarType;\n type eventsV2Rsvp_universal_d_ValueAggregation = ValueAggregation;\n type eventsV2Rsvp_universal_d_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;\n type eventsV2Rsvp_universal_d_NestedAggregationType = NestedAggregationType;\n const eventsV2Rsvp_universal_d_NestedAggregationType: typeof NestedAggregationType;\n type eventsV2Rsvp_universal_d_RangeAggregation = RangeAggregation;\n type eventsV2Rsvp_universal_d_ScalarAggregation = ScalarAggregation;\n type eventsV2Rsvp_universal_d_DateHistogramAggregation = DateHistogramAggregation;\n type eventsV2Rsvp_universal_d_Interval = Interval;\n const eventsV2Rsvp_universal_d_Interval: typeof Interval;\n type eventsV2Rsvp_universal_d_NestedAggregationItem = NestedAggregationItem;\n type eventsV2Rsvp_universal_d_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;\n type eventsV2Rsvp_universal_d_AggregationType = AggregationType;\n const eventsV2Rsvp_universal_d_AggregationType: typeof AggregationType;\n type eventsV2Rsvp_universal_d_NestedAggregation = NestedAggregation;\n type eventsV2Rsvp_universal_d_SearchDetails = SearchDetails;\n type eventsV2Rsvp_universal_d_Mode = Mode;\n const eventsV2Rsvp_universal_d_Mode: typeof Mode;\n type eventsV2Rsvp_universal_d_SearchRsvpsResponse = SearchRsvpsResponse;\n type eventsV2Rsvp_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type eventsV2Rsvp_universal_d_AggregationData = AggregationData;\n type eventsV2Rsvp_universal_d_ValueAggregationResult = ValueAggregationResult;\n type eventsV2Rsvp_universal_d_RangeAggregationResult = RangeAggregationResult;\n type eventsV2Rsvp_universal_d_NestedAggregationResults = NestedAggregationResults;\n type eventsV2Rsvp_universal_d_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;\n type eventsV2Rsvp_universal_d_ValueResults = ValueResults;\n type eventsV2Rsvp_universal_d_RangeResults = RangeResults;\n type eventsV2Rsvp_universal_d_AggregationResultsScalarResult = AggregationResultsScalarResult;\n type eventsV2Rsvp_universal_d_NestedValueAggregationResult = NestedValueAggregationResult;\n type eventsV2Rsvp_universal_d_ValueResult = ValueResult;\n type eventsV2Rsvp_universal_d_RangeResult = RangeResult;\n type eventsV2Rsvp_universal_d_ScalarResult = ScalarResult;\n type eventsV2Rsvp_universal_d_NestedResultValue = NestedResultValue;\n type eventsV2Rsvp_universal_d_NestedResultValueResultOneOf = NestedResultValueResultOneOf;\n type eventsV2Rsvp_universal_d_Results = Results;\n type eventsV2Rsvp_universal_d_DateHistogramResult = DateHistogramResult;\n type eventsV2Rsvp_universal_d_GroupByValueResults = GroupByValueResults;\n type eventsV2Rsvp_universal_d_DateHistogramResults = DateHistogramResults;\n type eventsV2Rsvp_universal_d_NestedResults = NestedResults;\n type eventsV2Rsvp_universal_d_AggregationResults = AggregationResults;\n type eventsV2Rsvp_universal_d_AggregationResultsResultOneOf = AggregationResultsResultOneOf;\n type eventsV2Rsvp_universal_d_SearchRsvpsWithOffsetRequest = SearchRsvpsWithOffsetRequest;\n type eventsV2Rsvp_universal_d_Search = Search;\n type eventsV2Rsvp_universal_d_SearchPagingMethodOneOf = SearchPagingMethodOneOf;\n type eventsV2Rsvp_universal_d_SearchRsvpsWithOffsetResponse = SearchRsvpsWithOffsetResponse;\n type eventsV2Rsvp_universal_d_QueryRsvpsRequest = QueryRsvpsRequest;\n type eventsV2Rsvp_universal_d_CursorQuery = CursorQuery;\n type eventsV2Rsvp_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type eventsV2Rsvp_universal_d_QueryRsvpsResponse = QueryRsvpsResponse;\n type eventsV2Rsvp_universal_d_CountRsvpsRequest = CountRsvpsRequest;\n type eventsV2Rsvp_universal_d_CountRsvpsResponse = CountRsvpsResponse;\n type eventsV2Rsvp_universal_d_GetRsvpRequest = GetRsvpRequest;\n type eventsV2Rsvp_universal_d_GetRsvpResponse = GetRsvpResponse;\n type eventsV2Rsvp_universal_d_CreateRsvpRequest = CreateRsvpRequest;\n type eventsV2Rsvp_universal_d_ModificationOptions = ModificationOptions;\n type eventsV2Rsvp_universal_d_CreateRsvpResponse = CreateRsvpResponse;\n type eventsV2Rsvp_universal_d_GuestLimitExceededData = GuestLimitExceededData;\n type eventsV2Rsvp_universal_d_UpdateRsvpRequest = UpdateRsvpRequest;\n type eventsV2Rsvp_universal_d_UpdateRsvpResponse = UpdateRsvpResponse;\n type eventsV2Rsvp_universal_d_DeleteRsvpRequest = DeleteRsvpRequest;\n type eventsV2Rsvp_universal_d_DeleteRsvpResponse = DeleteRsvpResponse;\n type eventsV2Rsvp_universal_d_BulkUpdateRsvpRequest = BulkUpdateRsvpRequest;\n type eventsV2Rsvp_universal_d_MaskedRsvp = MaskedRsvp;\n type eventsV2Rsvp_universal_d_BulkUpdateRsvpResponse = BulkUpdateRsvpResponse;\n type eventsV2Rsvp_universal_d_ItemMetadata = ItemMetadata;\n type eventsV2Rsvp_universal_d_ApplicationError = ApplicationError;\n type eventsV2Rsvp_universal_d_BulkRsvpResult = BulkRsvpResult;\n type eventsV2Rsvp_universal_d_BulkActionMetadata = BulkActionMetadata;\n type eventsV2Rsvp_universal_d_BulkDeleteRsvpsByFilterRequest = BulkDeleteRsvpsByFilterRequest;\n type eventsV2Rsvp_universal_d_BulkDeleteRsvpsByFilterResponse = BulkDeleteRsvpsByFilterResponse;\n type eventsV2Rsvp_universal_d_CheckInRsvpGuestsRequest = CheckInRsvpGuestsRequest;\n type eventsV2Rsvp_universal_d_CheckInRsvpGuestsResponse = CheckInRsvpGuestsResponse;\n type eventsV2Rsvp_universal_d_CancelRsvpGuestsCheckInRequest = CancelRsvpGuestsCheckInRequest;\n type eventsV2Rsvp_universal_d_CancelRsvpGuestsCheckInResponse = CancelRsvpGuestsCheckInResponse;\n type eventsV2Rsvp_universal_d_ListRsvpSummaryRequest = ListRsvpSummaryRequest;\n type eventsV2Rsvp_universal_d_ListRsvpSummaryResponse = ListRsvpSummaryResponse;\n type eventsV2Rsvp_universal_d_V2RsvpSummary = V2RsvpSummary;\n type eventsV2Rsvp_universal_d_CompareRsvpSummaryRequest = CompareRsvpSummaryRequest;\n type eventsV2Rsvp_universal_d_CompareRsvpSummaryResponse = CompareRsvpSummaryResponse;\n type eventsV2Rsvp_universal_d_BulkUpdateRsvpContactIdRequest = BulkUpdateRsvpContactIdRequest;\n type eventsV2Rsvp_universal_d_BulkUpdateRsvpContactIdResponse = BulkUpdateRsvpContactIdResponse;\n const eventsV2Rsvp_universal_d_searchRsvps: typeof searchRsvps;\n type eventsV2Rsvp_universal_d_SearchRsvpsOptions = SearchRsvpsOptions;\n const eventsV2Rsvp_universal_d_queryRsvps: typeof queryRsvps;\n type eventsV2Rsvp_universal_d_QueryRsvpsOptions = QueryRsvpsOptions;\n type eventsV2Rsvp_universal_d_RsvpsQueryResult = RsvpsQueryResult;\n type eventsV2Rsvp_universal_d_RsvpsQueryBuilder = RsvpsQueryBuilder;\n const eventsV2Rsvp_universal_d_countRsvps: typeof countRsvps;\n type eventsV2Rsvp_universal_d_CountRsvpsOptions = CountRsvpsOptions;\n const eventsV2Rsvp_universal_d_getRsvp: typeof getRsvp;\n type eventsV2Rsvp_universal_d_GetRsvpOptions = GetRsvpOptions;\n const eventsV2Rsvp_universal_d_createRsvp: typeof createRsvp;\n type eventsV2Rsvp_universal_d_CreateRsvpOptions = CreateRsvpOptions;\n const eventsV2Rsvp_universal_d_updateRsvp: typeof updateRsvp;\n type eventsV2Rsvp_universal_d_UpdateRsvp = UpdateRsvp;\n type eventsV2Rsvp_universal_d_UpdateRsvpOptions = UpdateRsvpOptions;\n const eventsV2Rsvp_universal_d_deleteRsvp: typeof deleteRsvp;\n const eventsV2Rsvp_universal_d_bulkUpdateRsvp: typeof bulkUpdateRsvp;\n type eventsV2Rsvp_universal_d_BulkUpdateRsvpOptions = BulkUpdateRsvpOptions;\n const eventsV2Rsvp_universal_d_bulkDeleteRsvpsByFilter: typeof bulkDeleteRsvpsByFilter;\n type eventsV2Rsvp_universal_d_BulkDeleteRsvpsByFilterOptions = BulkDeleteRsvpsByFilterOptions;\n const eventsV2Rsvp_universal_d_checkInRsvpGuests: typeof checkInRsvpGuests;\n type eventsV2Rsvp_universal_d_CheckInRsvpGuestsOptions = CheckInRsvpGuestsOptions;\n const eventsV2Rsvp_universal_d_cancelRsvpGuestsCheckIn: typeof cancelRsvpGuestsCheckIn;\n type eventsV2Rsvp_universal_d_CancelRsvpGuestsCheckInOptions = CancelRsvpGuestsCheckInOptions;\n const eventsV2Rsvp_universal_d_listRsvpSummary: typeof listRsvpSummary;\n type eventsV2Rsvp_universal_d_ListRsvpSummaryOptions = ListRsvpSummaryOptions;\n namespace eventsV2Rsvp_universal_d {\n export {\n eventsV2Rsvp_universal_d_V2Rsvp as V2Rsvp,\n eventsV2Rsvp_universal_d_FormResponse as FormResponse,\n eventsV2Rsvp_universal_d_InputValue as InputValue,\n eventsV2Rsvp_universal_d_FormattedAddress as FormattedAddress,\n CommonAddress$2 as CommonAddress,\n CommonAddressStreetOneOf$2 as CommonAddressStreetOneOf,\n CommonStreetAddress$2 as CommonStreetAddress,\n CommonAddressLocation$2 as CommonAddressLocation,\n CommonSubdivision$2 as CommonSubdivision,\n SubdivisionType$2 as SubdivisionType,\n eventsV2Rsvp_universal_d_StandardDetails as StandardDetails,\n eventsV2Rsvp_universal_d_RsvpStatus as RsvpStatus,\n eventsV2Rsvp_universal_d_GuestList as GuestList,\n eventsV2Rsvp_universal_d_Guest as Guest,\n eventsV2Rsvp_universal_d_CheckInDetails as CheckInDetails,\n eventsV2Rsvp_universal_d_AdditionalGuestDetails as AdditionalGuestDetails,\n eventsV2Rsvp_universal_d_OnlineConferencingLogin as OnlineConferencingLogin,\n ExtendedFields$1 as ExtendedFields,\n eventsV2Rsvp_universal_d_SearchRsvpsRequest as SearchRsvpsRequest,\n eventsV2Rsvp_universal_d_CursorSearch as CursorSearch,\n eventsV2Rsvp_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n eventsV2Rsvp_universal_d_Aggregation as Aggregation,\n eventsV2Rsvp_universal_d_AggregationKindOneOf as AggregationKindOneOf,\n eventsV2Rsvp_universal_d_RangeBucket as RangeBucket,\n eventsV2Rsvp_universal_d_SortType as SortType,\n eventsV2Rsvp_universal_d_SortDirection as SortDirection,\n eventsV2Rsvp_universal_d_MissingValues as MissingValues,\n eventsV2Rsvp_universal_d_IncludeMissingValuesOptions as IncludeMissingValuesOptions,\n eventsV2Rsvp_universal_d_ScalarType as ScalarType,\n eventsV2Rsvp_universal_d_ValueAggregation as ValueAggregation,\n eventsV2Rsvp_universal_d_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf,\n eventsV2Rsvp_universal_d_NestedAggregationType as NestedAggregationType,\n eventsV2Rsvp_universal_d_RangeAggregation as RangeAggregation,\n eventsV2Rsvp_universal_d_ScalarAggregation as ScalarAggregation,\n eventsV2Rsvp_universal_d_DateHistogramAggregation as DateHistogramAggregation,\n eventsV2Rsvp_universal_d_Interval as Interval,\n eventsV2Rsvp_universal_d_NestedAggregationItem as NestedAggregationItem,\n eventsV2Rsvp_universal_d_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf,\n eventsV2Rsvp_universal_d_AggregationType as AggregationType,\n eventsV2Rsvp_universal_d_NestedAggregation as NestedAggregation,\n eventsV2Rsvp_universal_d_SearchDetails as SearchDetails,\n eventsV2Rsvp_universal_d_Mode as Mode,\n CursorPaging$2 as CursorPaging,\n RequestedFields$1 as RequestedFields,\n eventsV2Rsvp_universal_d_SearchRsvpsResponse as SearchRsvpsResponse,\n eventsV2Rsvp_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n Cursors$2 as Cursors,\n eventsV2Rsvp_universal_d_AggregationData as AggregationData,\n eventsV2Rsvp_universal_d_ValueAggregationResult as ValueAggregationResult,\n eventsV2Rsvp_universal_d_RangeAggregationResult as RangeAggregationResult,\n eventsV2Rsvp_universal_d_NestedAggregationResults as NestedAggregationResults,\n eventsV2Rsvp_universal_d_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf,\n eventsV2Rsvp_universal_d_ValueResults as ValueResults,\n eventsV2Rsvp_universal_d_RangeResults as RangeResults,\n eventsV2Rsvp_universal_d_AggregationResultsScalarResult as AggregationResultsScalarResult,\n eventsV2Rsvp_universal_d_NestedValueAggregationResult as NestedValueAggregationResult,\n eventsV2Rsvp_universal_d_ValueResult as ValueResult,\n eventsV2Rsvp_universal_d_RangeResult as RangeResult,\n eventsV2Rsvp_universal_d_ScalarResult as ScalarResult,\n eventsV2Rsvp_universal_d_NestedResultValue as NestedResultValue,\n eventsV2Rsvp_universal_d_NestedResultValueResultOneOf as NestedResultValueResultOneOf,\n eventsV2Rsvp_universal_d_Results as Results,\n eventsV2Rsvp_universal_d_DateHistogramResult as DateHistogramResult,\n eventsV2Rsvp_universal_d_GroupByValueResults as GroupByValueResults,\n eventsV2Rsvp_universal_d_DateHistogramResults as DateHistogramResults,\n eventsV2Rsvp_universal_d_NestedResults as NestedResults,\n eventsV2Rsvp_universal_d_AggregationResults as AggregationResults,\n eventsV2Rsvp_universal_d_AggregationResultsResultOneOf as AggregationResultsResultOneOf,\n eventsV2Rsvp_universal_d_SearchRsvpsWithOffsetRequest as SearchRsvpsWithOffsetRequest,\n eventsV2Rsvp_universal_d_Search as Search,\n eventsV2Rsvp_universal_d_SearchPagingMethodOneOf as SearchPagingMethodOneOf,\n Paging$2 as Paging,\n eventsV2Rsvp_universal_d_SearchRsvpsWithOffsetResponse as SearchRsvpsWithOffsetResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n eventsV2Rsvp_universal_d_QueryRsvpsRequest as QueryRsvpsRequest,\n eventsV2Rsvp_universal_d_CursorQuery as CursorQuery,\n eventsV2Rsvp_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n eventsV2Rsvp_universal_d_QueryRsvpsResponse as QueryRsvpsResponse,\n eventsV2Rsvp_universal_d_CountRsvpsRequest as CountRsvpsRequest,\n eventsV2Rsvp_universal_d_CountRsvpsResponse as CountRsvpsResponse,\n eventsV2Rsvp_universal_d_GetRsvpRequest as GetRsvpRequest,\n eventsV2Rsvp_universal_d_GetRsvpResponse as GetRsvpResponse,\n eventsV2Rsvp_universal_d_CreateRsvpRequest as CreateRsvpRequest,\n eventsV2Rsvp_universal_d_ModificationOptions as ModificationOptions,\n eventsV2Rsvp_universal_d_CreateRsvpResponse as CreateRsvpResponse,\n CalendarLinks$2 as CalendarLinks,\n eventsV2Rsvp_universal_d_GuestLimitExceededData as GuestLimitExceededData,\n eventsV2Rsvp_universal_d_UpdateRsvpRequest as UpdateRsvpRequest,\n eventsV2Rsvp_universal_d_UpdateRsvpResponse as UpdateRsvpResponse,\n eventsV2Rsvp_universal_d_DeleteRsvpRequest as DeleteRsvpRequest,\n eventsV2Rsvp_universal_d_DeleteRsvpResponse as DeleteRsvpResponse,\n eventsV2Rsvp_universal_d_BulkUpdateRsvpRequest as BulkUpdateRsvpRequest,\n eventsV2Rsvp_universal_d_MaskedRsvp as MaskedRsvp,\n eventsV2Rsvp_universal_d_BulkUpdateRsvpResponse as BulkUpdateRsvpResponse,\n eventsV2Rsvp_universal_d_ItemMetadata as ItemMetadata,\n eventsV2Rsvp_universal_d_ApplicationError as ApplicationError,\n eventsV2Rsvp_universal_d_BulkRsvpResult as BulkRsvpResult,\n eventsV2Rsvp_universal_d_BulkActionMetadata as BulkActionMetadata,\n eventsV2Rsvp_universal_d_BulkDeleteRsvpsByFilterRequest as BulkDeleteRsvpsByFilterRequest,\n eventsV2Rsvp_universal_d_BulkDeleteRsvpsByFilterResponse as BulkDeleteRsvpsByFilterResponse,\n eventsV2Rsvp_universal_d_CheckInRsvpGuestsRequest as CheckInRsvpGuestsRequest,\n eventsV2Rsvp_universal_d_CheckInRsvpGuestsResponse as CheckInRsvpGuestsResponse,\n eventsV2Rsvp_universal_d_CancelRsvpGuestsCheckInRequest as CancelRsvpGuestsCheckInRequest,\n eventsV2Rsvp_universal_d_CancelRsvpGuestsCheckInResponse as CancelRsvpGuestsCheckInResponse,\n eventsV2Rsvp_universal_d_ListRsvpSummaryRequest as ListRsvpSummaryRequest,\n eventsV2Rsvp_universal_d_ListRsvpSummaryResponse as ListRsvpSummaryResponse,\n eventsV2Rsvp_universal_d_V2RsvpSummary as V2RsvpSummary,\n eventsV2Rsvp_universal_d_CompareRsvpSummaryRequest as CompareRsvpSummaryRequest,\n eventsV2Rsvp_universal_d_CompareRsvpSummaryResponse as CompareRsvpSummaryResponse,\n EventCreated$2 as EventCreated,\n Location$2 as Location,\n MapCoordinates$2 as MapCoordinates,\n LocationType$2 as LocationType,\n Address$2 as Address,\n AddressStreetOneOf$2 as AddressStreetOneOf,\n StreetAddress$2 as StreetAddress,\n AddressLocation$2 as AddressLocation,\n Subdivision$2 as Subdivision,\n ScheduleConfig$2 as ScheduleConfig,\n Recurrences$2 as Recurrences,\n Occurrence$2 as Occurrence,\n Status$2 as Status,\n EventStatus$2 as EventStatus,\n Event$2 as Event,\n Scheduling$2 as Scheduling,\n Registration$2 as Registration,\n EventType$2 as EventType,\n RegistrationStatus$2 as RegistrationStatus,\n RsvpCollection$2 as RsvpCollection,\n RsvpCollectionConfig$2 as RsvpCollectionConfig,\n RsvpStatusOptions$2 as RsvpStatusOptions,\n Ticketing$2 as Ticketing,\n TicketingConfig$2 as TicketingConfig,\n TaxConfig$2 as TaxConfig,\n TaxType$2 as TaxType,\n Money$2 as Money,\n ExternalEvent$2 as ExternalEvent,\n VisitorType$2 as VisitorType,\n SiteUrl$2 as SiteUrl,\n Form$2 as Form,\n InputControl$2 as InputControl,\n InputControlType$2 as InputControlType,\n Input$2 as Input,\n ValueType$2 as ValueType,\n OptionSelection$2 as OptionSelection,\n OptionSelectionSelectedOptionOneOf$2 as OptionSelectionSelectedOptionOneOf,\n Label$2 as Label,\n FormMessages$2 as FormMessages,\n RsvpFormMessages$2 as RsvpFormMessages,\n PositiveResponseConfirmation$2 as PositiveResponseConfirmation,\n NegativeResponseConfirmation$2 as NegativeResponseConfirmation,\n Positive$2 as Positive,\n Negative$2 as Negative,\n CheckoutFormMessages$2 as CheckoutFormMessages,\n ResponseConfirmation$2 as ResponseConfirmation,\n RegistrationClosedMessages$2 as RegistrationClosedMessages,\n TicketsUnavailableMessages$2 as TicketsUnavailableMessages,\n Dashboard$2 as Dashboard,\n RsvpSummary$2 as RsvpSummary,\n TicketingSummary$2 as TicketingSummary,\n GuestListConfig$2 as GuestListConfig,\n Feed$2 as Feed,\n OnlineConferencing$2 as OnlineConferencing,\n OnlineConferencingConfig$2 as OnlineConferencingConfig,\n ConferenceType$2 as ConferenceType,\n OnlineConferencingSession$2 as OnlineConferencingSession,\n SeoSettings$2 as SeoSettings,\n SeoSchema$2 as SeoSchema,\n Keyword$2 as Keyword,\n Tag$2 as Tag,\n Settings$2 as Settings,\n Agenda$2 as Agenda,\n Category$2 as Category,\n CategoryCounts$2 as CategoryCounts,\n State$2 as State,\n EventDisplaySettings$2 as EventDisplaySettings,\n LabellingSettings$2 as LabellingSettings,\n Empty$2 as Empty,\n EventDeleted$2 as EventDeleted,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n eventsV2Rsvp_universal_d_BulkUpdateRsvpContactIdRequest as BulkUpdateRsvpContactIdRequest,\n eventsV2Rsvp_universal_d_BulkUpdateRsvpContactIdResponse as BulkUpdateRsvpContactIdResponse,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n eventsV2Rsvp_universal_d_searchRsvps as searchRsvps,\n eventsV2Rsvp_universal_d_SearchRsvpsOptions as SearchRsvpsOptions,\n eventsV2Rsvp_universal_d_queryRsvps as queryRsvps,\n eventsV2Rsvp_universal_d_QueryRsvpsOptions as QueryRsvpsOptions,\n eventsV2Rsvp_universal_d_RsvpsQueryResult as RsvpsQueryResult,\n eventsV2Rsvp_universal_d_RsvpsQueryBuilder as RsvpsQueryBuilder,\n eventsV2Rsvp_universal_d_countRsvps as countRsvps,\n eventsV2Rsvp_universal_d_CountRsvpsOptions as CountRsvpsOptions,\n eventsV2Rsvp_universal_d_getRsvp as getRsvp,\n eventsV2Rsvp_universal_d_GetRsvpOptions as GetRsvpOptions,\n eventsV2Rsvp_universal_d_createRsvp as createRsvp,\n eventsV2Rsvp_universal_d_CreateRsvpOptions as CreateRsvpOptions,\n eventsV2Rsvp_universal_d_updateRsvp as updateRsvp,\n eventsV2Rsvp_universal_d_UpdateRsvp as UpdateRsvp,\n eventsV2Rsvp_universal_d_UpdateRsvpOptions as UpdateRsvpOptions,\n eventsV2Rsvp_universal_d_deleteRsvp as deleteRsvp,\n eventsV2Rsvp_universal_d_bulkUpdateRsvp as bulkUpdateRsvp,\n eventsV2Rsvp_universal_d_BulkUpdateRsvpOptions as BulkUpdateRsvpOptions,\n eventsV2Rsvp_universal_d_bulkDeleteRsvpsByFilter as bulkDeleteRsvpsByFilter,\n eventsV2Rsvp_universal_d_BulkDeleteRsvpsByFilterOptions as BulkDeleteRsvpsByFilterOptions,\n eventsV2Rsvp_universal_d_checkInRsvpGuests as checkInRsvpGuests,\n eventsV2Rsvp_universal_d_CheckInRsvpGuestsOptions as CheckInRsvpGuestsOptions,\n eventsV2Rsvp_universal_d_cancelRsvpGuestsCheckIn as cancelRsvpGuestsCheckIn,\n eventsV2Rsvp_universal_d_CancelRsvpGuestsCheckInOptions as CancelRsvpGuestsCheckInOptions,\n eventsV2Rsvp_universal_d_listRsvpSummary as listRsvpSummary,\n eventsV2Rsvp_universal_d_ListRsvpSummaryOptions as ListRsvpSummaryOptions,\n };\n }\n \n interface V3Event {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: Location$1;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings$1;\n /** Event title. */\n title?: string | null;\n /** Short description that appears under the event title. */\n shortDescription?: string | null;\n /**\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 * @deprecated Detailed description of an event.\n *\n * This field is deprecated. To create a description, see the flow in [introduction](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/introduction).\n * @replacedBy wix.events.v1.rich_content\n * @targetRemovalDate 2025-06-01\n */\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 | null;\n /**\n * Date and time when the event was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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$1;\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$1;\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$1;\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 * Event discussion feed. For internal use.\n * @internal\n */\n feed?: Feed$1;\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$1;\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$1;\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 /**\n * Event categories.\n * @internal\n */\n categories?: EventCategories;\n /** Visual settings for event. */\n eventDisplaySettings?: V3EventDisplaySettings;\n /**\n * True if ticket can be customised\n * @internal\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: V3LabellingSettings;\n }\n interface Location$1 {\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$1;\n /** Exact location address. */\n address?: CommonAddress$1;\n /** Whether the event location is TBD. */\n locationTbd?: boolean | null;\n }\n enum LocationType$1 {\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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: CommonAddressLocation$1;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: CommonSubdivision$1[];\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionSubdivisionType$1;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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. 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$1;\n /** Event repetitions. */\n recurringEvents?: Recurrences$1;\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$1 {\n /** Individual event dates info. */\n individualEventDates?: Occurrence$1[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n }\n interface Occurrence$1 {\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 *\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$1 {\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 Registration$1 {\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 /** Unknown registration type. */\n UNKNOWN_REGISTRATION_TYPE = \"UNKNOWN_REGISTRATION_TYPE\",\n /** Guests register by RSVPing to the event. */\n RSVP = \"RSVP\",\n /** Guests register by buying tickets. */\n TICKETING = \"TICKETING\",\n /** Guests register externally using some other site or platform. */\n EXTERNAL = \"EXTERNAL\",\n /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */\n NONE = \"NONE\"\n }\n enum RegistrationStatusStatus {\n /** Registration status is not applicable */\n UNKNOWN_REGISTRATION_STATUS = \"UNKNOWN_REGISTRATION_STATUS\",\n /** Registration is closed after tickets are sold out. */\n CLOSED_AUTOMATICALLY = \"CLOSED_AUTOMATICALLY\",\n /** Registration is closed when the `registration.registrationDisabled` property is set to `true`. */\n CLOSED_MANUALLY = \"CLOSED_MANUALLY\",\n /** Guests can start RSVPing to the event. */\n OPEN_RSVP = \"OPEN_RSVP\",\n /** Guest list has reached the maximum, new guests are added to a waitlist. */\n OPEN_RSVP_WAITLIST_ONLY = \"OPEN_RSVP_WAITLIST_ONLY\",\n /** Guests can buy tickets to the event. */\n OPEN_TICKETS = \"OPEN_TICKETS\",\n /** Guests register on a different page or web address. */\n OPEN_EXTERNAL = \"OPEN_EXTERNAL\",\n /** Registration via RSVP is scheduled for the future. */\n SCHEDULED_RSVP = \"SCHEDULED_RSVP\"\n }\n interface RsvpRegistration {\n /** Available answers for registration to an event. */\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 | null;\n /** Registration end date. */\n endDate?: Date | null;\n }\n enum ResponseType {\n /** Unknown response type. */\n UNKNOWN_RESPONSE_TYPE = \"UNKNOWN_RESPONSE_TYPE\",\n /** Only a **Yes** answer is available to select when RSVP'ing to an event. */\n YES_ONLY = \"YES_ONLY\",\n /** *Yes** and **No** answers are available to select when RSVP'ing to an event. */\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 /**\n * App ID for external ticket stock management.\n * The default ticket stock value is as defined in the `TicketDefinition` object. If the ticket stock is defined in the stock manager app, the default is ignored.\n * @internal\n */\n stockManagerAppId?: string | null;\n /** Ticket price currency. */\n currency?: string | null;\n /**\n * Lowest ticket price.\n * @readonly\n */\n lowestPrice?: Money$1;\n /**\n * Highest ticket price.\n * @readonly\n */\n highestPrice?: Money$1;\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$1 {\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 ticket 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 ticket service fee of $0.25 and pays $10.25 in total.\n */\n type?: TaxType$1;\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 /** Tax application settings. */\n enum TaxType$1 {\n /** Unknown tax type. */\n UNKNOWN_TAX_TYPE = \"UNKNOWN_TAX_TYPE\",\n /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */\n INCLUDED_IN_PRICE = \"INCLUDED_IN_PRICE\",\n /** Show the fee in 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 ticket ticket service fee of $0.25 and pays $10.25 in total. */\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 /** Unknown guest type. */\n UNKNOWN_GUEST_TYPE = \"UNKNOWN_GUEST_TYPE\",\n /** All site visitors can RSVP to the event. */\n VISITOR_OR_MEMBER = \"VISITOR_OR_MEMBER\",\n /** Only people who have signed up as members of your site are able to RSVP to the event. */\n MEMBER = \"MEMBER\"\n }\n enum InitialRegistrationTypeType {\n /** Unknown initial registration type. */\n UNKNOWN_INITIAL_REGISTRATION_TYPE = \"UNKNOWN_INITIAL_REGISTRATION_TYPE\",\n /** Guests register by RSVPing to the event. */\n RSVP = \"RSVP\",\n /** Guests register by buying tickets. This property value never changes. */\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$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 /** Field control type. */\n type?: InputControlType$1;\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$1[];\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$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 /**\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$1;\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$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 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$1 {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing$1 {\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 * Configured conferencing provider name.\n * @internal\n * @readonly\n */\n providerName?: string;\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$1;\n }\n enum ConferenceTypeType {\n /** Default value. This value is unused */\n UNKNOWN_CONFERENCE_TYPE = \"UNKNOWN_CONFERENCE_TYPE\",\n /** Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. */\n MEETING = \"MEETING\",\n /** Guests can only watch the conference. */\n WEBINAR = \"WEBINAR\"\n }\n interface OnlineConferencingSession$1 {\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$1 {\n /** URL slug. */\n slug?: string;\n /** Advanced SEO data. */\n advancedSeoData?: SeoSchema$1;\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$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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 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 | null;\n /**\n * Category is hidden.\n * @readonly\n */\n hidden?: boolean;\n /**\n * Category type.\n * @readonly\n */\n type?: Type$1;\n }\n enum Type$1 {\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 /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */\n hideEventDetailsPage?: boolean | null;\n }\n interface V3LabellingSettings {\n /**\n * @internal\n * @readonly\n */\n assignedContactsLegacyLabelId?: string | null;\n /**\n * @internal\n * @readonly\n */\n assignedContactsLabelDeleted?: boolean | null;\n }\n interface EventEventStarted {\n /** Event schedule configuration. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface EventEventEnded {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface EventEventReminder {\n /** Reminder timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$1;\n /** Event schedule configuration. */\n dateAndTimeSettings?: DateAndTimeSettings$1;\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 | null;\n /** Event ID. */\n eventId?: string;\n /** Event status. */\n status?: Status$1;\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$1;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings$1;\n /** Event page URL components. */\n eventPageUrl?: string;\n /** RSVP or ticketing registration details. */\n registration?: Registration$1;\n }\n interface EventCloned {\n /** Event creation timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location$1;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings$1;\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$1;\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 | null;\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 /** Predefined sets of fields to return. */\n fields?: RequestedFields[];\n }\n enum RequestedFields {\n /** Unknown requested field. */\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Returns `shortDescription`, `mainImage` and `calendarUrls`. */\n DETAILS = \"DETAILS\",\n /** Returns `detailedDescription`. */\n TEXTS = \"TEXTS\",\n /** Returns `registration`. */\n REGISTRATION = \"REGISTRATION\",\n /** Returns `eventPageUrl`. */\n URLS = \"URLS\",\n /** Returns `form`. */\n FORM = \"FORM\",\n /** Returns `summaries`. */\n DASHBOARD = \"DASHBOARD\",\n /** Returns `feed`. */\n FEED = \"FEED\",\n /** Returns `onlineConferencing.session`. */\n ONLINE_CONFERENCING_SESSION = \"ONLINE_CONFERENCING_SESSION\",\n /** Returns `seoSettings`. */\n SEO_SETTINGS = \"SEO_SETTINGS\",\n /** Returns `agendaSettings`. */\n AGENDA = \"AGENDA\",\n /** Returns `categories`. */\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 /**\n * Fields that are included in this parameter are updated, while all other fields stay the same. If paths are not defined, all field values from the `event` object are updated.\n * @internal\n */\n fieldmask?: string[];\n /** Whether to clone the event as a draft. */\n draft?: boolean;\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 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 * Fields that are included in this parameter are updated, while all other fields stay the same. If paths are not defined, all field values from the `event` object are updated.\n * @internal\n */\n fieldmask?: string[];\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 fields?: RequestedFields[];\n }\n interface UpdateEventResponse {\n /** Updated event. */\n event?: V3Event;\n }\n interface PublishDraftEventRequest {\n /** Event ID. */\n eventId: string;\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 fields?: RequestedFields[];\n }\n interface PublishDraftEventResponse {\n /** Published event. */\n event?: V3Event;\n }\n interface CancelEventRequest {\n /** Event ID. */\n eventId: string;\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 fields?: RequestedFields[];\n }\n interface CancelEventResponse {\n /** Canceled event. */\n event?: V3Event;\n }\n interface BulkCancelEventsByFilterRequest {\n /** Filter. */\n filter?: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {\n /** Paging options. Can't be used together with `cursorPaging`. */\n paging?: Paging$1;\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?: Sorting$1[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$1 {\n /** Paging options. Can't be used together with `cursorPaging`. */\n paging?: Paging$1;\n }\n interface Sorting$1 {\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?: SortOrder$1;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$1 {\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?: QueryV2$1;\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?: QueryV2$1;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields[];\n /**\n * Whether draft events should be returned in the response.
      \n * **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_EVENTS` permission.\n */\n includeDrafts?: boolean;\n }\n interface QueryEventsResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$1;\n /** List of events. */\n events?: V3Event[];\n }\n interface PagingMetadataV2$1 {\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?: Cursors$1;\n /**\n * Whether there are more results after the current page.\n * If `true`, another page of results can be retrieved.\n * If `false`, the current page is the final page.\n * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$1 {\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?: CommonQueryV2;\n }\n interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {\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$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?: CommonSorting[];\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 CommonQueryV2PagingMethodOneOf {\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$1;\n }\n interface CommonSorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: CommonSortOrder;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum CommonSortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\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 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 ExportEventsResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: CommonPagingMetadataV2;\n /** List of events. */\n events?: V3Event[];\n }\n interface CommonPagingMetadataV2 {\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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 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.READ_DRAFT_EVENTS` permission.\n */\n includeDrafts?: boolean;\n }\n interface CountEventsByStatusResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$1;\n /** Filter facets. */\n facets?: Record;\n }\n interface FacetCounts$1 {\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?: Paging$1;\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?: Sorting$1[];\n /** Event status. */\n status?: Status$1[];\n /** Allows to filter events by user relation to the event among all wix sites. */\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 * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.\n * @internal\n */\n fields?: RequestedFields[];\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 /** User is attending the event. The user RSVP'd with status of `YES` or has ordered tickets. */\n ATTENDING = \"ATTENDING\"\n }\n interface ListUserEventsResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$1;\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?: Paging$1;\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 fields?: RequestedFields[];\n }\n interface ListEventsByCategoryResponse {\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadataV2$1;\n /** List of events. */\n events?: V3Event[];\n }\n interface GetEventRequest {\n /** Event ID. */\n eventId: string | null;\n fields?: RequestedFields[];\n /**\n * indicates whether full_address should be resolved\n * @internal\n */\n resolveFullAddress?: boolean;\n }\n interface GetEventResponse {\n /** Event. */\n event?: V3Event;\n }\n interface GetEventBySlugRequest {\n /** URL slug. */\n slug: string | null;\n fields?: RequestedFields[];\n /**\n * indicates whether full_address should be resolved\n * @internal\n */\n resolveFullAddress?: boolean;\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 /** Predefined sets of fields to return. */\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$1 {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$1;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus$1;\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$1;\n }\n interface EventsLocation {\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?: LocationLocationType$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 LocationLocationType$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 /** 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 /** 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 * apartment number\n * @internal\n */\n apt?: 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 * subdivision level\n * @internal\n */\n type?: SubdivisionType$1;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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$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 Event$1 {\n /**\n * Event ID.\n * @readonly\n */\n _id?: string;\n /** Event location. */\n location?: EventsLocation;\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 | null;\n /** Event modified timestamp. */\n modified?: Date | null;\n /** Event status. */\n status?: EventStatus$1;\n /** RSVP or ticketing registration details. */\n registration?: EventsRegistration;\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?: 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$1;\n /** Categories this event is assigned to. */\n categories?: Category$1[];\n /** Visual settings for event. */\n eventDisplaySettings?: EventDisplaySettings$1;\n /**\n * @internal\n * @readonly\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: LabellingSettings$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 interface EventsRegistration {\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 | null;\n /** Registration end timestamp. */\n endDate?: Date | null;\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 /**\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$1;\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$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 /**\n * App Id for external ticket stock management.\n * By default tickets stock is defined in TicketDefinition object.\n * If defined then limitation from TicketDefinition is ignored.\n * @internal\n */\n stockManagerAppId?: string | null;\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?: 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$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?: 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$1 {\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$1;\n session?: EventsOnlineConferencingSession;\n /**\n * Configured conferencing provider name.\n * @internal\n * @readonly\n */\n providerName?: string;\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 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$1;\n /**\n * Hidden from SEO Site Map\n * @readonly\n */\n hidden?: boolean | null;\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 * Date and time when category was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Assigned events count. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\n /**\n * The total number of draft and published events assigned to the category.\n * @readonly\n */\n counts?: CategoryCounts$1;\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$1[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\n }\n interface CategoryCounts$1 {\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$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 /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */\n hideEventDetailsPage?: boolean | null;\n }\n interface LabellingSettings$1 {\n /**\n * @internal\n * @readonly\n */\n assignedContactsLegacyLabelId?: string | null;\n /**\n * @internal\n * @readonly\n */\n assignedContactsLabelDeleted?: boolean | null;\n }\n interface Empty$1 {\n }\n interface EventUpdated$1 {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$1;\n /** Event title. */\n title?: string;\n /**\n * Whether schedule configuration was updated.\n * @deprecated\n */\n scheduleConfigUpdated?: boolean;\n /**\n * The set of properties which were updated. For example 'title' or 'location'\n * @internal\n */\n fields?: string[];\n /**\n * Whether event has opened new spots with this update.\n * @internal\n */\n newSpotsOpened?: boolean | null;\n /** Updated event */\n event?: Event$1;\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 * Event categories.\n * @internal\n */\n categories?: string[];\n }\n interface EventCopied {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$1;\n /** Event title. */\n title?: string;\n /** Event creator user ID. */\n userId?: string | null;\n /** Event status. */\n status?: EventStatus$1;\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 | null;\n /** Event ID. */\n eventId?: string;\n /** Event status. */\n status?: EventStatus$1;\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$1;\n /** Event page URL components. */\n eventPageUrl?: SiteUrl$1;\n /** RSVP or ticketing registration details. */\n registration?: EventsRegistration;\n }\n interface EventCanceled$1 {\n /** Event canceled 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 EventStarted {\n /** Event start timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface EventEnded$1 {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface EventReminder {\n /** Reminder timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: EventsLocation;\n /** Event schedule configuration. */\n scheduleConfig?: ScheduleConfig$1;\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 * @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 /** Predefined sets of fields to return. */\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 * @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 /**\n * Fields that are included in this parameter are updated, while all other fields stay the same. If paths are not defined, all field values from the `event` object are updated.\n * @internal\n */\n fieldmask?: string[];\n /** Whether to clone the event as a draft. */\n draft?: boolean;\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 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 * @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$1;\n /** Event date and time settings. */\n dateAndTimeSettings?: DateAndTimeSettings$1;\n /** Event title. */\n title?: string | null;\n /** Short description that appears under the event title. */\n shortDescription?: string | null;\n /**\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 * @deprecated Detailed description of an event.\n *\n * This field is deprecated. To create a description, see the flow in [introduction](https://dev.wix.com/docs/rest/business-solutions/events/events-v3/introduction).\n * @replacedBy wix.events.v1.rich_content\n * @targetRemovalDate 2025-06-01\n */\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 | null;\n /**\n * Date and time when the event was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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$1;\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$1;\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$1;\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 * Event discussion feed. For internal use.\n * @internal\n */\n feed?: Feed$1;\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$1;\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$1;\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 /**\n * Event categories.\n * @internal\n */\n categories?: EventCategories;\n /** Visual settings for event. */\n eventDisplaySettings?: V3EventDisplaySettings;\n /**\n * True if ticket can be customised\n * @internal\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: V3LabellingSettings;\n };\n /**\n * Fields that are included in this parameter are updated, while all other fields stay the same. If paths are not defined, all field values from the `event` object are updated.\n * @internal\n */\n fieldmask?: string[];\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 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 * @adminMethod\n */\n function publishDraftEvent(eventId: string, options?: PublishDraftEventOptions): Promise;\n interface PublishDraftEventOptions {\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 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 * @adminMethod\n */\n function cancelEvent(eventId: string, options?: CancelEventOptions): Promise;\n interface CancelEventOptions {\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 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 * @adminMethod\n */\n function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise;\n interface BulkCancelEventsByFilterOptions {\n /** Filter. */\n filter?: QueryV2$1;\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 * @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 * @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?: QueryV2$1;\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 * @permissionId WIX_EVENTS.READ_EVENTS\n */\n function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;\n interface QueryEventsOptions {\n /** Predefined sets of fields to return. */\n fields?: RequestedFields[] | undefined;\n /**\n * Whether draft events should be returned in the response.
      \n * **Note:** This parameter requires the `WIX_EVENTS.READ_DRAFT_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 */\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.READ_DRAFT_EVENTS` permission.\n */\n includeDrafts?: boolean;\n }\n /**\n * Retrieves a list of up to 100 events that belong to the same event category.\n * @param categoryId - Category ID.\n * @internal\n * @requiredField categoryId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_EVENTS\n */\n function listEventsByCategory(categoryId: string, options?: ListEventsByCategoryOptions): Promise;\n interface ListEventsByCategoryOptions {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$1;\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 fields?: RequestedFields[];\n }\n /**\n * Retrieves an event by ID.\n *\n * To retrieve an event description, call [Get Rich Content](https://dev.wix.com/docs/rest/business-solutions/events/rich-content/get-rich-content).\n * @param eventId - Event ID.\n * @public\n * @requiredField eventId\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_EVENTS\n * @returns Event.\n */\n function getEvent(eventId: string | null, options?: GetEventOptions): Promise;\n interface GetEventOptions {\n fields?: RequestedFields[];\n /**\n * indicates whether full_address should be resolved\n * @internal\n */\n resolveFullAddress?: boolean;\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 */\n function getEventBySlug(slug: string | null, options?: GetEventBySlugOptions): Promise;\n interface GetEventBySlugOptions {\n fields?: RequestedFields[];\n /**\n * indicates whether full_address should be resolved\n * @internal\n */\n resolveFullAddress?: boolean;\n }\n /**\n * Finds an event by ID or URL slug.\n *\n *\n * Unlike the [`getEvent`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/getevent) function, which returns a \"not found\" error, `findEvent()` returns an empty response when an event is not found.\n * @internal\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_EVENTS\n */\n function findEvent(options?: FindEventOptions): Promise;\n interface FindEventOptions extends FindEventRequestFindByOneOf {\n /** Event ID. */\n eventId?: string | null;\n /** URL slug. */\n slug?: string | null;\n /** Predefined sets of fields to return. */\n fields?: RequestedFields[];\n }\n \n type eventsV3Event_universal_d_V3Event = V3Event;\n type eventsV3Event_universal_d_TimeDuration = TimeDuration;\n type eventsV3Event_universal_d_RegistrationTypeType = RegistrationTypeType;\n const eventsV3Event_universal_d_RegistrationTypeType: typeof RegistrationTypeType;\n type eventsV3Event_universal_d_RegistrationStatusStatus = RegistrationStatusStatus;\n const eventsV3Event_universal_d_RegistrationStatusStatus: typeof RegistrationStatusStatus;\n type eventsV3Event_universal_d_RsvpRegistration = RsvpRegistration;\n type eventsV3Event_universal_d_ResponseType = ResponseType;\n const eventsV3Event_universal_d_ResponseType: typeof ResponseType;\n type eventsV3Event_universal_d_TicketsRegistration = TicketsRegistration;\n type eventsV3Event_universal_d_TaxSettings = TaxSettings;\n type eventsV3Event_universal_d_ExternalRegistration = ExternalRegistration;\n type eventsV3Event_universal_d_GuestTypeType = GuestTypeType;\n const eventsV3Event_universal_d_GuestTypeType: typeof GuestTypeType;\n type eventsV3Event_universal_d_InitialRegistrationTypeType = InitialRegistrationTypeType;\n const eventsV3Event_universal_d_InitialRegistrationTypeType: typeof InitialRegistrationTypeType;\n type eventsV3Event_universal_d_CalendarUrls = CalendarUrls;\n type eventsV3Event_universal_d_Summaries = Summaries;\n type eventsV3Event_universal_d_EventsMoney = EventsMoney;\n type eventsV3Event_universal_d_Rsvps = Rsvps;\n type eventsV3Event_universal_d_Tickets = Tickets;\n type eventsV3Event_universal_d_GuestListSettings = GuestListSettings;\n type eventsV3Event_universal_d_ConferenceTypeType = ConferenceTypeType;\n const eventsV3Event_universal_d_ConferenceTypeType: typeof ConferenceTypeType;\n type eventsV3Event_universal_d_AgendaSettings = AgendaSettings;\n type eventsV3Event_universal_d_EventCategories = EventCategories;\n type eventsV3Event_universal_d_EventCategory = EventCategory;\n type eventsV3Event_universal_d_V3EventDisplaySettings = V3EventDisplaySettings;\n type eventsV3Event_universal_d_V3LabellingSettings = V3LabellingSettings;\n type eventsV3Event_universal_d_EventEventStarted = EventEventStarted;\n type eventsV3Event_universal_d_EventEventEnded = EventEventEnded;\n type eventsV3Event_universal_d_EventEventReminder = EventEventReminder;\n type eventsV3Event_universal_d_EventEventPublished = EventEventPublished;\n type eventsV3Event_universal_d_EventCloned = EventCloned;\n type eventsV3Event_universal_d_EventEventCanceled = EventEventCanceled;\n type eventsV3Event_universal_d_CreateEventRequest = CreateEventRequest;\n type eventsV3Event_universal_d_RequestedFields = RequestedFields;\n const eventsV3Event_universal_d_RequestedFields: typeof RequestedFields;\n type eventsV3Event_universal_d_CreateEventResponse = CreateEventResponse;\n type eventsV3Event_universal_d_CloneEventRequest = CloneEventRequest;\n type eventsV3Event_universal_d_CloneEventResponse = CloneEventResponse;\n type eventsV3Event_universal_d_UpdateEventRequest = UpdateEventRequest;\n type eventsV3Event_universal_d_UpdateEventResponse = UpdateEventResponse;\n type eventsV3Event_universal_d_PublishDraftEventRequest = PublishDraftEventRequest;\n type eventsV3Event_universal_d_PublishDraftEventResponse = PublishDraftEventResponse;\n type eventsV3Event_universal_d_CancelEventRequest = CancelEventRequest;\n type eventsV3Event_universal_d_CancelEventResponse = CancelEventResponse;\n type eventsV3Event_universal_d_BulkCancelEventsByFilterRequest = BulkCancelEventsByFilterRequest;\n type eventsV3Event_universal_d_BulkCancelEventsByFilterResponse = BulkCancelEventsByFilterResponse;\n type eventsV3Event_universal_d_DeleteEventRequest = DeleteEventRequest;\n type eventsV3Event_universal_d_DeleteEventResponse = DeleteEventResponse;\n type eventsV3Event_universal_d_BulkDeleteEventsByFilterRequest = BulkDeleteEventsByFilterRequest;\n type eventsV3Event_universal_d_BulkDeleteEventsByFilterResponse = BulkDeleteEventsByFilterResponse;\n type eventsV3Event_universal_d_QueryEventsRequest = QueryEventsRequest;\n type eventsV3Event_universal_d_QueryEventsResponse = QueryEventsResponse;\n type eventsV3Event_universal_d_ExportEventsRequest = ExportEventsRequest;\n type eventsV3Event_universal_d_CommonQueryV2 = CommonQueryV2;\n type eventsV3Event_universal_d_CommonQueryV2PagingMethodOneOf = CommonQueryV2PagingMethodOneOf;\n type eventsV3Event_universal_d_CommonSorting = CommonSorting;\n type eventsV3Event_universal_d_CommonSortOrder = CommonSortOrder;\n const eventsV3Event_universal_d_CommonSortOrder: typeof CommonSortOrder;\n type eventsV3Event_universal_d_CommonPaging = CommonPaging;\n type eventsV3Event_universal_d_ExportEventsResponse = ExportEventsResponse;\n type eventsV3Event_universal_d_CommonPagingMetadataV2 = CommonPagingMetadataV2;\n type eventsV3Event_universal_d_CommonCursors = CommonCursors;\n type eventsV3Event_universal_d_CountEventsByStatusRequest = CountEventsByStatusRequest;\n type eventsV3Event_universal_d_CountEventsByStatusResponse = CountEventsByStatusResponse;\n type eventsV3Event_universal_d_ListUserEventsRequest = ListUserEventsRequest;\n type eventsV3Event_universal_d_UserFilter = UserFilter;\n type eventsV3Event_universal_d_Relation = Relation;\n const eventsV3Event_universal_d_Relation: typeof Relation;\n type eventsV3Event_universal_d_ListUserEventsResponse = ListUserEventsResponse;\n type eventsV3Event_universal_d_ListEventsByCategoryRequest = ListEventsByCategoryRequest;\n type eventsV3Event_universal_d_ListEventsByCategoryResponse = ListEventsByCategoryResponse;\n type eventsV3Event_universal_d_GetEventRequest = GetEventRequest;\n type eventsV3Event_universal_d_GetEventResponse = GetEventResponse;\n type eventsV3Event_universal_d_GetEventBySlugRequest = GetEventBySlugRequest;\n type eventsV3Event_universal_d_GetEventBySlugResponse = GetEventBySlugResponse;\n type eventsV3Event_universal_d_FindEventRequest = FindEventRequest;\n type eventsV3Event_universal_d_FindEventRequestFindByOneOf = FindEventRequestFindByOneOf;\n type eventsV3Event_universal_d_FindEventResponse = FindEventResponse;\n type eventsV3Event_universal_d_EventsLocation = EventsLocation;\n type eventsV3Event_universal_d_EventsRecurrences = EventsRecurrences;\n type eventsV3Event_universal_d_EventsOccurrence = EventsOccurrence;\n type eventsV3Event_universal_d_EventsRecurrenceStatusStatus = EventsRecurrenceStatusStatus;\n const eventsV3Event_universal_d_EventsRecurrenceStatusStatus: typeof EventsRecurrenceStatusStatus;\n type eventsV3Event_universal_d_EventsRegistration = EventsRegistration;\n type eventsV3Event_universal_d_EventsTaxType = EventsTaxType;\n const eventsV3Event_universal_d_EventsTaxType: typeof EventsTaxType;\n type eventsV3Event_universal_d_EventsFeed = EventsFeed;\n type eventsV3Event_universal_d_EventsOnlineConferencing = EventsOnlineConferencing;\n type eventsV3Event_universal_d_EventsOnlineConferencingSession = EventsOnlineConferencingSession;\n type eventsV3Event_universal_d_EventsSeoSettings = EventsSeoSettings;\n type eventsV3Event_universal_d_EventCopied = EventCopied;\n type eventsV3Event_universal_d_EventPublished = EventPublished;\n type eventsV3Event_universal_d_EventStarted = EventStarted;\n type eventsV3Event_universal_d_EventReminder = EventReminder;\n const eventsV3Event_universal_d_createEvent: typeof createEvent;\n type eventsV3Event_universal_d_CreateEventOptions = CreateEventOptions;\n const eventsV3Event_universal_d_cloneEvent: typeof cloneEvent;\n type eventsV3Event_universal_d_CloneEventOptions = CloneEventOptions;\n const eventsV3Event_universal_d_updateEvent: typeof updateEvent;\n type eventsV3Event_universal_d_UpdateEventOptions = UpdateEventOptions;\n const eventsV3Event_universal_d_publishDraftEvent: typeof publishDraftEvent;\n type eventsV3Event_universal_d_PublishDraftEventOptions = PublishDraftEventOptions;\n const eventsV3Event_universal_d_cancelEvent: typeof cancelEvent;\n type eventsV3Event_universal_d_CancelEventOptions = CancelEventOptions;\n const eventsV3Event_universal_d_bulkCancelEventsByFilter: typeof bulkCancelEventsByFilter;\n type eventsV3Event_universal_d_BulkCancelEventsByFilterOptions = BulkCancelEventsByFilterOptions;\n const eventsV3Event_universal_d_deleteEvent: typeof deleteEvent;\n const eventsV3Event_universal_d_bulkDeleteEventsByFilter: typeof bulkDeleteEventsByFilter;\n type eventsV3Event_universal_d_BulkDeleteEventsByFilterOptions = BulkDeleteEventsByFilterOptions;\n const eventsV3Event_universal_d_queryEvents: typeof queryEvents;\n type eventsV3Event_universal_d_QueryEventsOptions = QueryEventsOptions;\n type eventsV3Event_universal_d_EventsQueryResult = EventsQueryResult;\n type eventsV3Event_universal_d_EventsQueryBuilder = EventsQueryBuilder;\n const eventsV3Event_universal_d_countEventsByStatus: typeof countEventsByStatus;\n type eventsV3Event_universal_d_CountEventsByStatusOptions = CountEventsByStatusOptions;\n const eventsV3Event_universal_d_listEventsByCategory: typeof listEventsByCategory;\n type eventsV3Event_universal_d_ListEventsByCategoryOptions = ListEventsByCategoryOptions;\n const eventsV3Event_universal_d_getEvent: typeof getEvent;\n type eventsV3Event_universal_d_GetEventOptions = GetEventOptions;\n const eventsV3Event_universal_d_getEventBySlug: typeof getEventBySlug;\n type eventsV3Event_universal_d_GetEventBySlugOptions = GetEventBySlugOptions;\n const eventsV3Event_universal_d_findEvent: typeof findEvent;\n type eventsV3Event_universal_d_FindEventOptions = FindEventOptions;\n namespace eventsV3Event_universal_d {\n export {\n eventsV3Event_universal_d_V3Event as V3Event,\n Location$1 as Location,\n LocationType$1 as LocationType,\n CommonAddress$1 as CommonAddress,\n CommonAddressStreetOneOf$1 as CommonAddressStreetOneOf,\n CommonStreetAddress$1 as CommonStreetAddress,\n CommonAddressLocation$1 as CommonAddressLocation,\n CommonSubdivision$1 as CommonSubdivision,\n SubdivisionSubdivisionType$1 as SubdivisionSubdivisionType,\n DateAndTimeSettings$1 as DateAndTimeSettings,\n RecurrenceStatusStatus$1 as RecurrenceStatusStatus,\n Recurrences$1 as Recurrences,\n Occurrence$1 as Occurrence,\n Formatted$1 as Formatted,\n eventsV3Event_universal_d_TimeDuration as TimeDuration,\n Status$1 as Status,\n Registration$1 as Registration,\n eventsV3Event_universal_d_RegistrationTypeType as RegistrationTypeType,\n eventsV3Event_universal_d_RegistrationStatusStatus as RegistrationStatusStatus,\n eventsV3Event_universal_d_RsvpRegistration as RsvpRegistration,\n eventsV3Event_universal_d_ResponseType as ResponseType,\n eventsV3Event_universal_d_TicketsRegistration as TicketsRegistration,\n Money$1 as Money,\n eventsV3Event_universal_d_TaxSettings as TaxSettings,\n TaxType$1 as TaxType,\n eventsV3Event_universal_d_ExternalRegistration as ExternalRegistration,\n eventsV3Event_universal_d_GuestTypeType as GuestTypeType,\n eventsV3Event_universal_d_InitialRegistrationTypeType as InitialRegistrationTypeType,\n eventsV3Event_universal_d_CalendarUrls as CalendarUrls,\n Form$1 as Form,\n InputControl$1 as InputControl,\n InputControlType$1 as InputControlType,\n Input$1 as Input,\n ValueType$1 as ValueType,\n OptionSelection$1 as OptionSelection,\n OptionSelectionSelectedOptionOneOf$1 as OptionSelectionSelectedOptionOneOf,\n Label$1 as Label,\n FormMessages$1 as FormMessages,\n RsvpFormMessages$1 as RsvpFormMessages,\n PositiveResponseConfirmation$1 as PositiveResponseConfirmation,\n NegativeResponseConfirmation$1 as NegativeResponseConfirmation,\n Positive$1 as Positive,\n Negative$1 as Negative,\n CheckoutFormMessages$1 as CheckoutFormMessages,\n ResponseConfirmation$1 as ResponseConfirmation,\n RegistrationClosedMessages$1 as RegistrationClosedMessages,\n TicketsUnavailableMessages$1 as TicketsUnavailableMessages,\n eventsV3Event_universal_d_Summaries as Summaries,\n eventsV3Event_universal_d_EventsMoney as EventsMoney,\n eventsV3Event_universal_d_Rsvps as Rsvps,\n eventsV3Event_universal_d_Tickets as Tickets,\n eventsV3Event_universal_d_GuestListSettings as GuestListSettings,\n Feed$1 as Feed,\n OnlineConferencing$1 as OnlineConferencing,\n eventsV3Event_universal_d_ConferenceTypeType as ConferenceTypeType,\n OnlineConferencingSession$1 as OnlineConferencingSession,\n SeoSettings$1 as SeoSettings,\n SeoSchema$1 as SeoSchema,\n Keyword$1 as Keyword,\n Tag$1 as Tag,\n Settings$1 as Settings,\n eventsV3Event_universal_d_AgendaSettings as AgendaSettings,\n eventsV3Event_universal_d_EventCategories as EventCategories,\n eventsV3Event_universal_d_EventCategory as EventCategory,\n Type$1 as Type,\n eventsV3Event_universal_d_V3EventDisplaySettings as V3EventDisplaySettings,\n eventsV3Event_universal_d_V3LabellingSettings as V3LabellingSettings,\n eventsV3Event_universal_d_EventEventStarted as EventEventStarted,\n eventsV3Event_universal_d_EventEventEnded as EventEventEnded,\n eventsV3Event_universal_d_EventEventReminder as EventEventReminder,\n eventsV3Event_universal_d_EventEventPublished as EventEventPublished,\n eventsV3Event_universal_d_EventCloned as EventCloned,\n eventsV3Event_universal_d_EventEventCanceled as EventEventCanceled,\n eventsV3Event_universal_d_CreateEventRequest as CreateEventRequest,\n eventsV3Event_universal_d_RequestedFields as RequestedFields,\n eventsV3Event_universal_d_CreateEventResponse as CreateEventResponse,\n eventsV3Event_universal_d_CloneEventRequest as CloneEventRequest,\n eventsV3Event_universal_d_CloneEventResponse as CloneEventResponse,\n eventsV3Event_universal_d_UpdateEventRequest as UpdateEventRequest,\n eventsV3Event_universal_d_UpdateEventResponse as UpdateEventResponse,\n eventsV3Event_universal_d_PublishDraftEventRequest as PublishDraftEventRequest,\n eventsV3Event_universal_d_PublishDraftEventResponse as PublishDraftEventResponse,\n eventsV3Event_universal_d_CancelEventRequest as CancelEventRequest,\n eventsV3Event_universal_d_CancelEventResponse as CancelEventResponse,\n eventsV3Event_universal_d_BulkCancelEventsByFilterRequest as BulkCancelEventsByFilterRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$1 as Paging,\n eventsV3Event_universal_d_BulkCancelEventsByFilterResponse as BulkCancelEventsByFilterResponse,\n eventsV3Event_universal_d_DeleteEventRequest as DeleteEventRequest,\n eventsV3Event_universal_d_DeleteEventResponse as DeleteEventResponse,\n eventsV3Event_universal_d_BulkDeleteEventsByFilterRequest as BulkDeleteEventsByFilterRequest,\n eventsV3Event_universal_d_BulkDeleteEventsByFilterResponse as BulkDeleteEventsByFilterResponse,\n eventsV3Event_universal_d_QueryEventsRequest as QueryEventsRequest,\n eventsV3Event_universal_d_QueryEventsResponse as QueryEventsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n eventsV3Event_universal_d_ExportEventsRequest as ExportEventsRequest,\n eventsV3Event_universal_d_CommonQueryV2 as CommonQueryV2,\n eventsV3Event_universal_d_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf,\n eventsV3Event_universal_d_CommonSorting as CommonSorting,\n eventsV3Event_universal_d_CommonSortOrder as CommonSortOrder,\n eventsV3Event_universal_d_CommonPaging as CommonPaging,\n CursorPaging$1 as CursorPaging,\n eventsV3Event_universal_d_ExportEventsResponse as ExportEventsResponse,\n eventsV3Event_universal_d_CommonPagingMetadataV2 as CommonPagingMetadataV2,\n eventsV3Event_universal_d_CommonCursors as CommonCursors,\n eventsV3Event_universal_d_CountEventsByStatusRequest as CountEventsByStatusRequest,\n eventsV3Event_universal_d_CountEventsByStatusResponse as CountEventsByStatusResponse,\n FacetCounts$1 as FacetCounts,\n eventsV3Event_universal_d_ListUserEventsRequest as ListUserEventsRequest,\n eventsV3Event_universal_d_UserFilter as UserFilter,\n eventsV3Event_universal_d_Relation as Relation,\n eventsV3Event_universal_d_ListUserEventsResponse as ListUserEventsResponse,\n eventsV3Event_universal_d_ListEventsByCategoryRequest as ListEventsByCategoryRequest,\n eventsV3Event_universal_d_ListEventsByCategoryResponse as ListEventsByCategoryResponse,\n eventsV3Event_universal_d_GetEventRequest as GetEventRequest,\n eventsV3Event_universal_d_GetEventResponse as GetEventResponse,\n eventsV3Event_universal_d_GetEventBySlugRequest as GetEventBySlugRequest,\n eventsV3Event_universal_d_GetEventBySlugResponse as GetEventBySlugResponse,\n eventsV3Event_universal_d_FindEventRequest as FindEventRequest,\n eventsV3Event_universal_d_FindEventRequestFindByOneOf as FindEventRequestFindByOneOf,\n eventsV3Event_universal_d_FindEventResponse as FindEventResponse,\n EventCreated$1 as EventCreated,\n eventsV3Event_universal_d_EventsLocation as EventsLocation,\n MapCoordinates$1 as MapCoordinates,\n LocationLocationType$1 as LocationLocationType,\n Address$1 as Address,\n AddressStreetOneOf$1 as AddressStreetOneOf,\n StreetAddress$1 as StreetAddress,\n AddressLocation$1 as AddressLocation,\n Subdivision$1 as Subdivision,\n SubdivisionType$1 as SubdivisionType,\n ScheduleConfig$1 as ScheduleConfig,\n eventsV3Event_universal_d_EventsRecurrences as EventsRecurrences,\n eventsV3Event_universal_d_EventsOccurrence as EventsOccurrence,\n eventsV3Event_universal_d_EventsRecurrenceStatusStatus as EventsRecurrenceStatusStatus,\n EventStatus$1 as EventStatus,\n Event$1 as Event,\n Scheduling$1 as Scheduling,\n eventsV3Event_universal_d_EventsRegistration as EventsRegistration,\n EventType$1 as EventType,\n RegistrationStatus$1 as RegistrationStatus,\n RsvpCollection$1 as RsvpCollection,\n RsvpCollectionConfig$1 as RsvpCollectionConfig,\n RsvpStatusOptions$1 as RsvpStatusOptions,\n Ticketing$1 as Ticketing,\n TicketingConfig$1 as TicketingConfig,\n TaxConfig$1 as TaxConfig,\n eventsV3Event_universal_d_EventsTaxType as EventsTaxType,\n ExternalEvent$1 as ExternalEvent,\n VisitorType$1 as VisitorType,\n CalendarLinks$1 as CalendarLinks,\n SiteUrl$1 as SiteUrl,\n Dashboard$1 as Dashboard,\n RsvpSummary$1 as RsvpSummary,\n TicketingSummary$1 as TicketingSummary,\n GuestListConfig$1 as GuestListConfig,\n eventsV3Event_universal_d_EventsFeed as EventsFeed,\n eventsV3Event_universal_d_EventsOnlineConferencing as EventsOnlineConferencing,\n OnlineConferencingConfig$1 as OnlineConferencingConfig,\n ConferenceType$1 as ConferenceType,\n eventsV3Event_universal_d_EventsOnlineConferencingSession as EventsOnlineConferencingSession,\n eventsV3Event_universal_d_EventsSeoSettings as EventsSeoSettings,\n Agenda$1 as Agenda,\n Category$1 as Category,\n CategoryCounts$1 as CategoryCounts,\n State$1 as State,\n EventDisplaySettings$1 as EventDisplaySettings,\n LabellingSettings$1 as LabellingSettings,\n Empty$1 as Empty,\n EventUpdated$1 as EventUpdated,\n EventDeleted$1 as EventDeleted,\n eventsV3Event_universal_d_EventCopied as EventCopied,\n eventsV3Event_universal_d_EventPublished as EventPublished,\n EventCanceled$1 as EventCanceled,\n eventsV3Event_universal_d_EventStarted as EventStarted,\n EventEnded$1 as EventEnded,\n eventsV3Event_universal_d_EventReminder as EventReminder,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n eventsV3Event_universal_d_createEvent as createEvent,\n eventsV3Event_universal_d_CreateEventOptions as CreateEventOptions,\n eventsV3Event_universal_d_cloneEvent as cloneEvent,\n eventsV3Event_universal_d_CloneEventOptions as CloneEventOptions,\n eventsV3Event_universal_d_updateEvent as updateEvent,\n eventsV3Event_universal_d_UpdateEventOptions as UpdateEventOptions,\n eventsV3Event_universal_d_publishDraftEvent as publishDraftEvent,\n eventsV3Event_universal_d_PublishDraftEventOptions as PublishDraftEventOptions,\n eventsV3Event_universal_d_cancelEvent as cancelEvent,\n eventsV3Event_universal_d_CancelEventOptions as CancelEventOptions,\n eventsV3Event_universal_d_bulkCancelEventsByFilter as bulkCancelEventsByFilter,\n eventsV3Event_universal_d_BulkCancelEventsByFilterOptions as BulkCancelEventsByFilterOptions,\n eventsV3Event_universal_d_deleteEvent as deleteEvent,\n eventsV3Event_universal_d_bulkDeleteEventsByFilter as bulkDeleteEventsByFilter,\n eventsV3Event_universal_d_BulkDeleteEventsByFilterOptions as BulkDeleteEventsByFilterOptions,\n eventsV3Event_universal_d_queryEvents as queryEvents,\n eventsV3Event_universal_d_QueryEventsOptions as QueryEventsOptions,\n eventsV3Event_universal_d_EventsQueryResult as EventsQueryResult,\n eventsV3Event_universal_d_EventsQueryBuilder as EventsQueryBuilder,\n eventsV3Event_universal_d_countEventsByStatus as countEventsByStatus,\n eventsV3Event_universal_d_CountEventsByStatusOptions as CountEventsByStatusOptions,\n eventsV3Event_universal_d_listEventsByCategory as listEventsByCategory,\n eventsV3Event_universal_d_ListEventsByCategoryOptions as ListEventsByCategoryOptions,\n eventsV3Event_universal_d_getEvent as getEvent,\n eventsV3Event_universal_d_GetEventOptions as GetEventOptions,\n eventsV3Event_universal_d_getEventBySlug as getEventBySlug,\n eventsV3Event_universal_d_GetEventBySlugOptions as GetEventBySlugOptions,\n eventsV3Event_universal_d_findEvent as findEvent,\n eventsV3Event_universal_d_FindEventOptions as FindEventOptions,\n };\n }\n \n interface TicketDefinition {\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 | null;\n /**\n * Date and time when the ticket definition was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */\n feeType?: Type;\n /** Ticket sale period. */\n salePeriod?: SalePeriod;\n /**\n * Ticket sale status.\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 * For proxy.\n * @internal\n * @readonly\n */\n sortIndex?: number;\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 * Event created timestamp in `yyyy-mm-ddThh:mm:sssZ` format.\n * @internal\n * @readonly\n */\n eventCreatedDate?: Date | null;\n /** Data extensions. */\n extendedFields?: ExtendedFields;\n /**\n * Associated event information.
      \n * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.\n */\n eventDetails?: EventDetails;\n }\n interface SalePeriod {\n /** Ticket sale start timestamp. */\n startDate?: Date | null;\n /** Ticket sale end timestamp. */\n endDate?: Date | null;\n /** Whether to display the ticket if it's not available to buy. */\n displayNotOnSale?: boolean;\n }\n interface PricingMethod extends PricingMethodPriceOneOf {\n /** Same ticket price for everyone. */\n fixedPrice?: CommonMoney;\n /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). 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;\n /**\n * Ticket price type.\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 /** Guests choose how much they'd like to pay for the ticket. You can set the minimum price, or make the ticket free(enter `0` in the request). 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;\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 {\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 /** Undefined pricing type. */\n UNKNOWN_PRICING_TYPE = \"UNKNOWN_PRICING_TYPE\",\n /** All money goes to a seller. Applies to all ticket pricing methods except for `guestPrice`. */\n STANDARD = \"STANDARD\",\n /** All collected money is a donation. This pricing type is automatically assigned when you select the `guestPrice` pricing method. */\n DONATION = \"DONATION\"\n }\n enum Type {\n /** Unknown fee type. */\n UNKNOWN_FEE_TYPE = \"UNKNOWN_FEE_TYPE\",\n /** The fee is deducted from the ticket price for a seller. For example, if you're selling tickets for $10, then a ticket service fee of $0.25 will be deducted from the price and you'll get $9.75. */\n FEE_INCLUDED = \"FEE_INCLUDED\",\n /** 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 ticket service fee of $0.25 and will pay $10.25 in total. */\n FEE_ADDED_AT_CHECKOUT = \"FEE_ADDED_AT_CHECKOUT\",\n /** Ticket service fee is not collected. Available only for free tickets and legacy users. */\n NO_FEE = \"NO_FEE\"\n }\n enum SaleStatusEnumStatus {\n /** Undefined sale status. */\n UNKNOWN_SALE_STATUS = \"UNKNOWN_SALE_STATUS\",\n /** Tickets are not on sale yet. */\n SALE_SCHEDULED = \"SALE_SCHEDULED\",\n /** Tickets are on sale. */\n SALE_STARTED = \"SALE_STARTED\",\n /** Tickets are not on sale. */\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 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 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?: V3Location;\n /**\n * Event date and time settings.\n * @readonly\n */\n dateAndTimeSettings?: DateAndTimeSettings;\n /**\n * Event page URL components.\n * @readonly\n */\n eventPageUrl?: string;\n /**\n * Event status.\n * @readonly\n */\n status?: EventStatusStatus;\n }\n interface V3Location {\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?: LocationLocationType;\n /** Exact location address. */\n address?: CommonAddress;\n /** Whether the event location is TBD. */\n locationTbd?: boolean | null;\n }\n enum LocationLocationType {\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 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 * A string containing the full address of this location.\n * @internal\n */\n formatted?: string | null;\n /**\n * Coordinates of the physical address.\n * @internal\n */\n location?: CommonAddressLocation;\n /**\n * Country full name.\n * @internal\n */\n countryFullname?: string | null;\n /**\n * Subdivision full name.\n * @internal\n */\n subdivisionFullname?: string | null;\n /**\n * Multi-level subdivisions from top to bottom.\n * @internal\n */\n subdivisions?: CommonSubdivision[];\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 * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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 * Subdivision level\n * @internal\n */\n type?: SubdivisionSubdivisionType;\n /**\n * Free text description of subdivision type.\n * @internal\n */\n typeInfo?: string | null;\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 | 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;\n /** Event repetitions. */\n recurringEvents?: V3Recurrences;\n /** Formatted date and time settings. */\n formatted?: Formatted;\n }\n enum RecurrenceStatusStatus {\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 V3Recurrences {\n /** Individual event dates. */\n individualEventDates?: V3Occurrence[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n }\n interface V3Occurrence {\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 {\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 EventStatusStatus {\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 SalePeriodUpdated {\n /** Ticket definition sale period after update. */\n afterUpdate?: SalePeriod;\n }\n interface TicketDefinitionSaleStarted {\n /** Ticket definition. */\n ticketDefinition?: TicketDefinition;\n }\n interface TicketDefinitionSaleEnded {\n /** Ticket definition. */\n ticketDefinition?: TicketDefinition;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 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 | null;\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 * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null;\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 | null;\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 /**\n * Currency used in event transactions.\n * @readonly\n */\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 Empty {\n }\n interface ReservationCreated {\n /** Reservation created timestamp in ISO UTC format. */\n timestamp?: Date | null;\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 | null;\n /** Reservation status. */\n status?: ReservationStatus;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity[];\n /** Reservation update timestamp. */\n _updatedDate?: Date | null;\n /** Reservation counts. */\n counts?: ReservationCount[];\n }\n enum ReservationStatus {\n /** The Reservation is pending confirmation and will expire after the expiration due time. */\n RESERVATION_PENDING = \"RESERVATION_PENDING\",\n /** The reservation is confirmed and will not expire. */\n RESERVATION_CONFIRMED = \"RESERVATION_CONFIRMED\",\n /** The reservation is canceled because of non payment. */\n RESERVATION_CANCELED = \"RESERVATION_CANCELED\",\n /** The reservation is canceled manually by the buyer. */\n RESERVATION_CANCELED_MANUALLY = \"RESERVATION_CANCELED_MANUALLY\",\n /** The reservation is 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 | null;\n }\n interface ReservationCount {\n /** Reservation Count snapshot timestamp. */\n timestamp?: Date | null;\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 | null;\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;\n /** Reservation expiration timestamp. */\n expires?: Date | null;\n /** Reservation ticket quantities. */\n quantities?: TicketQuantity[];\n /** Reservation update timestamp. */\n _updatedDate?: Date | null;\n /** Reservation counts. */\n counts?: ReservationCount[];\n }\n interface EventDeleted {\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 * Event categories.\n * @internal\n */\n categories?: string[];\n }\n interface CreateTicketDefinitionRequest {\n /** Ticket definition info. */\n ticketDefinition: TicketDefinition;\n /** Predefined sets of fields to return. */\n fields?: Field[];\n }\n enum Field {\n /** Unknown requested field. */\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /** Returns `salesDetails` in the response. */\n SALES_DETAILS = \"SALES_DETAILS\",\n /** Returns `eventDetails` in the response. */\n EVENT_DETAILS = \"EVENT_DETAILS\"\n }\n interface CreateTicketDefinitionResponse {\n /** Created ticket definition. */\n ticketDefinition?: TicketDefinition;\n }\n interface UpdateTicketDefinitionRequest {\n /** Ticket definition to update. */\n ticketDefinition: TicketDefinition;\n /**\n * List of exact fields to update. For example, if you define only `name`, all other fields are ignored.\n * @internal\n */\n mask?: string[];\n /** Predefined sets of fields to return. */\n fields?: Field[];\n }\n interface UpdateTicketDefinitionResponse {\n /** The updated ticket definition. */\n ticketDefinition?: TicketDefinition;\n }\n interface GetTicketDefinitionRequest {\n /** Ticket definition ID. */\n ticketDefinitionId: string;\n /** Predefined sets of fields to return. */\n fields?: Field[];\n }\n interface GetTicketDefinitionResponse {\n /** The requested ticket definition. */\n ticketDefinition?: TicketDefinition;\n }\n interface DeleteTicketDefinitionRequest {\n /** ID of the ticket definition to delete. */\n ticketDefinitionId: string;\n }\n interface DeleteTicketDefinitionResponse {\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;\n }\n interface QueryTicketDefinitionsRequest {\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 /** Predefined sets of fields to return. */\n fields?: Field[];\n /**\n * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null;\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` parameters. */\n cursorPaging?: CursorPaging;\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[];\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` parameters. */\n cursorPaging?: CursorPaging;\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Defaults to `ASC` */\n order?: SortOrder;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\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 {\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 {\n /** List of ticket definitions. */\n ticketDefinitions?: TicketDefinition[];\n /** Metadata for the paginated results. */\n metadata?: 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 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;\n /** Predefined sets of fields to return. */\n fields?: Field[];\n }\n interface QueryAvailableTicketDefinitionsResponse {\n /** List of ticket definitions. */\n ticketDefinitions?: TicketDefinition[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadataV2;\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;\n /** Filter facets. */\n facets?: Record;\n }\n interface FacetCounts {\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;\n /**\n * Filter facets.\n * @internal\n */\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 {\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 {\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 EventCanceled {\n /** Event canceled 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 EventEnded {\n /** Event end timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n }\n interface EventCreated {\n /** Event created timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location;\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 Location {\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?: LocationType;\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 LocationType {\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 /** 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 /** 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 * apartment number\n * @internal\n */\n apt?: 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 * subdivision level\n * @internal\n */\n type?: SubdivisionType;\n /**\n * free text description of subdivision type\n * @internal\n */\n typeInfo?: string | null;\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 | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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;\n }\n interface Recurrences {\n /** Event occurrences. */\n occurrences?: Occurrence[];\n /**\n * Recurring event category ID.\n * @readonly\n */\n categoryId?: string | null;\n /**\n * Recurrence status.\n * @readonly\n */\n status?: Status;\n }\n interface Occurrence {\n /** Event start timestamp. */\n startDate?: Date | null;\n /** Event end timestamp. */\n endDate?: Date | null;\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 {\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?: Location;\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 | null;\n /** Event modified timestamp. */\n modified?: Date | null;\n /** Event status. */\n status?: EventStatus;\n /** RSVP or ticketing registration details. */\n registration?: Registration;\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?: Feed;\n /** Online conferencing details. */\n onlineConferencing?: OnlineConferencing;\n /** SEO settings. */\n seoSettings?: SeoSettings;\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 * @internal\n * @readonly\n */\n customizableTickets?: boolean | null;\n /**\n * Labelling related data.\n * @internal\n */\n labellingSettings?: LabellingSettings;\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 Registration {\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 | null;\n /** Registration end timestamp. */\n endDate?: Date | null;\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?: Money;\n /**\n * Price of highest priced ticket.\n * @readonly\n */\n highestTicketPrice?: Money;\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 /**\n * App Id for external ticket stock management.\n * By default tickets stock is defined in TicketDefinition object.\n * If defined then limitation from TicketDefinition is ignored.\n * @internal\n */\n stockManagerAppId?: string | null;\n /** Duration for which the tickets being bought are reserved. */\n reservationDurationInMinutes?: number | null;\n }\n interface TaxConfig {\n /** Tax application settings. */\n type?: TaxType;\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 {\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 {\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 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 /**\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 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?: Money;\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;\n }\n interface GuestListConfig {\n /** Whether members can see other members attending the event (defaults to true). */\n publicGuestList?: boolean;\n }\n interface Feed {\n /** Event discussion feed token. */\n token?: string;\n }\n interface OnlineConferencing {\n config?: OnlineConferencingConfig;\n session?: OnlineConferencingSession;\n /**\n * Configured conferencing provider name.\n * @internal\n * @readonly\n */\n providerName?: string;\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 OnlineConferencingSession {\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 {\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 /**\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 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 | null;\n /**\n * Assigned events count. Deleted events are excluded.\n * @internal\n * @readonly\n * @deprecated\n */\n assignedEventsCount?: number | null;\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?: CategoryStateState[];\n /**\n * Optionally client defined external ID.\n * @internal\n */\n externalId?: string | null;\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 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 {\n /** Whether event details button is hidden. Only available for events with no registration. */\n hideEventDetailsButton?: boolean | null;\n /** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */\n hideEventDetailsPage?: boolean | null;\n }\n interface LabellingSettings {\n /**\n * @internal\n * @readonly\n */\n assignedContactsLegacyLabelId?: string | null;\n /**\n * @internal\n * @readonly\n */\n assignedContactsLabelDeleted?: boolean | null;\n }\n interface EventUpdated {\n /** Event update timestamp in ISO UTC format. */\n timestamp?: Date | null;\n /** Event ID. */\n eventId?: string;\n /** Event location. */\n location?: Location;\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 /**\n * The set of properties which were updated. For example 'title' or 'location'\n * @internal\n */\n fields?: string[];\n /**\n * Whether event has opened new spots with this update.\n * @internal\n */\n newSpotsOpened?: boolean | null;\n /** Updated event */\n event?: Event;\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 /**\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 /** 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 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;\n }\n interface ScheduleLegacyTimeCapsuleTaskRequest {\n /** Definition ID. */\n ticketDefinitionId?: 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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n * @returns Created ticket definition.\n */\n function createTicketDefinition(ticketDefinition: TicketDefinition, options?: CreateTicketDefinitionOptions): Promise;\n interface CreateTicketDefinitionOptions {\n /** Predefined sets of fields to return. */\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n * @returns The updated ticket definition.\n */\n function updateTicketDefinition(_id: string | null, ticketDefinition: UpdateTicketDefinition, options?: UpdateTicketDefinitionOptions): 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 | null;\n /**\n * Date and time when the ticket definition was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 /** Whether fee is included in the ticket price or customer pays it additionally at checkout. */\n feeType?: Type;\n /** Ticket sale period. */\n salePeriod?: SalePeriod;\n /**\n * Ticket sale status.\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 * For proxy.\n * @internal\n * @readonly\n */\n sortIndex?: number;\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 * Event created timestamp in `yyyy-mm-ddThh:mm:sssZ` format.\n * @internal\n * @readonly\n */\n eventCreatedDate?: Date | null;\n /** Data extensions. */\n extendedFields?: ExtendedFields;\n /**\n * Associated event information.
      \n * **Note:** This field is only returned when `EVENT_DETAILS` fieldset is included in the request.\n */\n eventDetails?: EventDetails;\n }\n interface UpdateTicketDefinitionOptions {\n /**\n * List of exact fields to update. For example, if you define only `name`, all other fields are ignored.\n * @internal\n */\n mask?: string[];\n /** Predefined sets of fields to return. */\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 * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\n * @adminMethod\n * @returns The requested ticket definition.\n */\n function getTicketDefinition(ticketDefinitionId: string, options?: GetTicketDefinitionOptions): Promise;\n interface GetTicketDefinitionOptions {\n /** Predefined sets of fields to return. */\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n */\n function deleteTicketDefinition(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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\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 * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\n * @adminMethod\n */\n function queryTicketDefinitions(options?: QueryTicketDefinitionsOptions): TicketDefinitionsQueryBuilder;\n interface QueryTicketDefinitionsOptions {\n /** Predefined sets of fields to return. */\n fields?: Field[] | undefined;\n /**\n * Consistent read.\n * @internal\n */\n consistentRead?: boolean | null | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface TicketDefinitionsQueryResult extends QueryCursorResult {\n items: TicketDefinition[];\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' | 'hidden' | 'initialLimit' | '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' | 'hidden' | 'initialLimit' | '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' | 'initialLimit', 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' | 'initialLimit', 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' | 'initialLimit', 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' | 'initialLimit', value: any) => TicketDefinitionsQueryBuilder;\n in: (propertyName: '_id' | 'eventId' | 'revision' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'hidden' | 'initialLimit' | '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' | 'hidden' | 'initialLimit' | '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' | 'hidden' | 'initialLimit' | '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' | 'hidden' | 'initialLimit' | '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 * Retrieves a list of available ticket definitions, given the provided paging, filtering, and sorting.\n *\n * This endpoint retrieves ticket definitions that aren't in the `hidden` state. The available ticket definitions can be retrieved by site visitors.\n *\n * > **Note:** You need the `WIX_EVENTS.READ_TICKET_DEFINITIONS` permission to get the `salesDetails` field values.\n *\n * Query Available 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 *\n * For field support for filters and sorting, see [Ticket Definitions: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/events/ticket-definition-v3/filter-and-sort).\n * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\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 * @permissionId WIX_EVENTS.READ_AVAILABLE_TICKET_DEFINITIONS\n */\n function queryAvailableTicketDefinitions(query: QueryV2, options?: QueryAvailableTicketDefinitionsOptions): Promise;\n interface QueryAvailableTicketDefinitionsOptions {\n /** Predefined sets of fields to return. */\n fields?: Field[];\n }\n /**\n * Counts ticket definitions by the `saleStatus` field, including those with the `hidden` status.\n * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_TICKET_DEFINITIONS\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 ticket definitions by the `saleStatus`, excluding those with the `hidden` status.\n * @public\n * @param options - Optional fields.\n * @permissionId WIX_EVENTS.READ_AVAILABLE_TICKET_DEFINITIONS\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\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 * @permissionId WIX_EVENTS.MANAGE_TICKET_DEFINITIONS\n * @adminMethod\n */\n function changeCurrency(eventId: string, options: ChangeCurrencyOptions): Promise;\n interface ChangeCurrencyOptions {\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 \n type eventsV3TicketDefinition_universal_d_TicketDefinition = TicketDefinition;\n type eventsV3TicketDefinition_universal_d_SalePeriod = SalePeriod;\n type eventsV3TicketDefinition_universal_d_PricingMethod = PricingMethod;\n type eventsV3TicketDefinition_universal_d_PricingMethodPriceOneOf = PricingMethodPriceOneOf;\n type eventsV3TicketDefinition_universal_d_CommonMoney = CommonMoney;\n type eventsV3TicketDefinition_universal_d_PricingOptions = PricingOptions;\n type eventsV3TicketDefinition_universal_d_OptionDetails = OptionDetails;\n type eventsV3TicketDefinition_universal_d_PricingTypeEnumType = PricingTypeEnumType;\n const eventsV3TicketDefinition_universal_d_PricingTypeEnumType: typeof PricingTypeEnumType;\n type eventsV3TicketDefinition_universal_d_Type = Type;\n const eventsV3TicketDefinition_universal_d_Type: typeof Type;\n type eventsV3TicketDefinition_universal_d_SaleStatusEnumStatus = SaleStatusEnumStatus;\n const eventsV3TicketDefinition_universal_d_SaleStatusEnumStatus: typeof SaleStatusEnumStatus;\n type eventsV3TicketDefinition_universal_d_SalesDetails = SalesDetails;\n type eventsV3TicketDefinition_universal_d_ExtendedFields = ExtendedFields;\n type eventsV3TicketDefinition_universal_d_EventDetails = EventDetails;\n type eventsV3TicketDefinition_universal_d_V3Location = V3Location;\n type eventsV3TicketDefinition_universal_d_LocationLocationType = LocationLocationType;\n const eventsV3TicketDefinition_universal_d_LocationLocationType: typeof LocationLocationType;\n type eventsV3TicketDefinition_universal_d_CommonAddress = CommonAddress;\n type eventsV3TicketDefinition_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type eventsV3TicketDefinition_universal_d_CommonStreetAddress = CommonStreetAddress;\n type eventsV3TicketDefinition_universal_d_CommonAddressLocation = CommonAddressLocation;\n type eventsV3TicketDefinition_universal_d_CommonSubdivision = CommonSubdivision;\n type eventsV3TicketDefinition_universal_d_SubdivisionSubdivisionType = SubdivisionSubdivisionType;\n const eventsV3TicketDefinition_universal_d_SubdivisionSubdivisionType: typeof SubdivisionSubdivisionType;\n type eventsV3TicketDefinition_universal_d_DateAndTimeSettings = DateAndTimeSettings;\n type eventsV3TicketDefinition_universal_d_RecurrenceStatusStatus = RecurrenceStatusStatus;\n const eventsV3TicketDefinition_universal_d_RecurrenceStatusStatus: typeof RecurrenceStatusStatus;\n type eventsV3TicketDefinition_universal_d_V3Recurrences = V3Recurrences;\n type eventsV3TicketDefinition_universal_d_V3Occurrence = V3Occurrence;\n type eventsV3TicketDefinition_universal_d_Formatted = Formatted;\n type eventsV3TicketDefinition_universal_d_EventStatusStatus = EventStatusStatus;\n const eventsV3TicketDefinition_universal_d_EventStatusStatus: typeof EventStatusStatus;\n type eventsV3TicketDefinition_universal_d_SalePeriodUpdated = SalePeriodUpdated;\n type eventsV3TicketDefinition_universal_d_TicketDefinitionSaleStarted = TicketDefinitionSaleStarted;\n type eventsV3TicketDefinition_universal_d_TicketDefinitionSaleEnded = TicketDefinitionSaleEnded;\n type eventsV3TicketDefinition_universal_d_DomainEvent = DomainEvent;\n type eventsV3TicketDefinition_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type eventsV3TicketDefinition_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type eventsV3TicketDefinition_universal_d_RestoreInfo = RestoreInfo;\n type eventsV3TicketDefinition_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type eventsV3TicketDefinition_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type eventsV3TicketDefinition_universal_d_ActionEvent = ActionEvent;\n type eventsV3TicketDefinition_universal_d_MessageEnvelope = MessageEnvelope;\n type eventsV3TicketDefinition_universal_d_IdentificationData = IdentificationData;\n type eventsV3TicketDefinition_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type eventsV3TicketDefinition_universal_d_WebhookIdentityType = WebhookIdentityType;\n const eventsV3TicketDefinition_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type eventsV3TicketDefinition_universal_d_InvalidateCache = InvalidateCache;\n type eventsV3TicketDefinition_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type eventsV3TicketDefinition_universal_d_App = App;\n type eventsV3TicketDefinition_universal_d_Page = Page;\n type eventsV3TicketDefinition_universal_d_URI = URI;\n type eventsV3TicketDefinition_universal_d_File = File;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionSummaryRequest = GetTicketDefinitionSummaryRequest;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionSummaryResponse = GetTicketDefinitionSummaryResponse;\n type eventsV3TicketDefinition_universal_d_TicketDefinitionSummary = TicketDefinitionSummary;\n type eventsV3TicketDefinition_universal_d_ListEventTicketingSummaryRequest = ListEventTicketingSummaryRequest;\n type eventsV3TicketDefinition_universal_d_ListEventTicketingSummaryResponse = ListEventTicketingSummaryResponse;\n type eventsV3TicketDefinition_universal_d_EventTicketingSummary = EventTicketingSummary;\n type eventsV3TicketDefinition_universal_d_Empty = Empty;\n type eventsV3TicketDefinition_universal_d_ReservationCreated = ReservationCreated;\n type eventsV3TicketDefinition_universal_d_ReservationStatus = ReservationStatus;\n const eventsV3TicketDefinition_universal_d_ReservationStatus: typeof ReservationStatus;\n type eventsV3TicketDefinition_universal_d_TicketQuantity = TicketQuantity;\n type eventsV3TicketDefinition_universal_d_ReservationCount = ReservationCount;\n type eventsV3TicketDefinition_universal_d_ReservationUpdated = ReservationUpdated;\n type eventsV3TicketDefinition_universal_d_EventDeleted = EventDeleted;\n type eventsV3TicketDefinition_universal_d_CreateTicketDefinitionRequest = CreateTicketDefinitionRequest;\n type eventsV3TicketDefinition_universal_d_Field = Field;\n const eventsV3TicketDefinition_universal_d_Field: typeof Field;\n type eventsV3TicketDefinition_universal_d_CreateTicketDefinitionResponse = CreateTicketDefinitionResponse;\n type eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionRequest = UpdateTicketDefinitionRequest;\n type eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionResponse = UpdateTicketDefinitionResponse;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionRequest = GetTicketDefinitionRequest;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionResponse = GetTicketDefinitionResponse;\n type eventsV3TicketDefinition_universal_d_DeleteTicketDefinitionRequest = DeleteTicketDefinitionRequest;\n type eventsV3TicketDefinition_universal_d_DeleteTicketDefinitionResponse = DeleteTicketDefinitionResponse;\n type eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsRequest = ReorderTicketDefinitionsRequest;\n type eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsRequestReferenceDefinitionOneOf = ReorderTicketDefinitionsRequestReferenceDefinitionOneOf;\n type eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsResponse = ReorderTicketDefinitionsResponse;\n type eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionSortIndexRequest = UpdateTicketDefinitionSortIndexRequest;\n type eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionSortIndexResponse = UpdateTicketDefinitionSortIndexResponse;\n type eventsV3TicketDefinition_universal_d_QueryTicketDefinitionsRequest = QueryTicketDefinitionsRequest;\n type eventsV3TicketDefinition_universal_d_QueryV2 = QueryV2;\n type eventsV3TicketDefinition_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type eventsV3TicketDefinition_universal_d_Sorting = Sorting;\n type eventsV3TicketDefinition_universal_d_SortOrder = SortOrder;\n const eventsV3TicketDefinition_universal_d_SortOrder: typeof SortOrder;\n type eventsV3TicketDefinition_universal_d_Paging = Paging;\n type eventsV3TicketDefinition_universal_d_CursorPaging = CursorPaging;\n type eventsV3TicketDefinition_universal_d_QueryTicketDefinitionsResponse = QueryTicketDefinitionsResponse;\n type eventsV3TicketDefinition_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type eventsV3TicketDefinition_universal_d_Cursors = Cursors;\n type eventsV3TicketDefinition_universal_d_QueryAvailableTicketDefinitionsRequest = QueryAvailableTicketDefinitionsRequest;\n type eventsV3TicketDefinition_universal_d_QueryAvailableTicketDefinitionsResponse = QueryAvailableTicketDefinitionsResponse;\n type eventsV3TicketDefinition_universal_d_CountTicketDefinitionsRequest = CountTicketDefinitionsRequest;\n type eventsV3TicketDefinition_universal_d_CountTicketDefinitionsResponse = CountTicketDefinitionsResponse;\n type eventsV3TicketDefinition_universal_d_FacetCounts = FacetCounts;\n type eventsV3TicketDefinition_universal_d_CountAvailableTicketDefinitionsRequest = CountAvailableTicketDefinitionsRequest;\n type eventsV3TicketDefinition_universal_d_CountAvailableTicketDefinitionsResponse = CountAvailableTicketDefinitionsResponse;\n type eventsV3TicketDefinition_universal_d_BulkDeleteTicketDefinitionsByFilterRequest = BulkDeleteTicketDefinitionsByFilterRequest;\n type eventsV3TicketDefinition_universal_d_BulkDeleteTicketDefinitionsByFilterResponse = BulkDeleteTicketDefinitionsByFilterResponse;\n type eventsV3TicketDefinition_universal_d_ChangeCurrencyRequest = ChangeCurrencyRequest;\n type eventsV3TicketDefinition_universal_d_ChangeCurrencyResponse = ChangeCurrencyResponse;\n type eventsV3TicketDefinition_universal_d_BulkCopyTicketDefinitionsByEventIdRequest = BulkCopyTicketDefinitionsByEventIdRequest;\n type eventsV3TicketDefinition_universal_d_BulkCopyTicketDefinitionsByEventIdResponse = BulkCopyTicketDefinitionsByEventIdResponse;\n type eventsV3TicketDefinition_universal_d_CopiedTicketDefinition = CopiedTicketDefinition;\n type eventsV3TicketDefinition_universal_d_EventCanceled = EventCanceled;\n type eventsV3TicketDefinition_universal_d_EventEnded = EventEnded;\n type eventsV3TicketDefinition_universal_d_EventCreated = EventCreated;\n type eventsV3TicketDefinition_universal_d_Location = Location;\n type eventsV3TicketDefinition_universal_d_MapCoordinates = MapCoordinates;\n type eventsV3TicketDefinition_universal_d_LocationType = LocationType;\n const eventsV3TicketDefinition_universal_d_LocationType: typeof LocationType;\n type eventsV3TicketDefinition_universal_d_Address = Address;\n type eventsV3TicketDefinition_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type eventsV3TicketDefinition_universal_d_StreetAddress = StreetAddress;\n type eventsV3TicketDefinition_universal_d_AddressLocation = AddressLocation;\n type eventsV3TicketDefinition_universal_d_Subdivision = Subdivision;\n type eventsV3TicketDefinition_universal_d_SubdivisionType = SubdivisionType;\n const eventsV3TicketDefinition_universal_d_SubdivisionType: typeof SubdivisionType;\n type eventsV3TicketDefinition_universal_d_ScheduleConfig = ScheduleConfig;\n type eventsV3TicketDefinition_universal_d_Recurrences = Recurrences;\n type eventsV3TicketDefinition_universal_d_Occurrence = Occurrence;\n type eventsV3TicketDefinition_universal_d_Status = Status;\n const eventsV3TicketDefinition_universal_d_Status: typeof Status;\n type eventsV3TicketDefinition_universal_d_EventStatus = EventStatus;\n const eventsV3TicketDefinition_universal_d_EventStatus: typeof EventStatus;\n type eventsV3TicketDefinition_universal_d_Event = Event;\n type eventsV3TicketDefinition_universal_d_Scheduling = Scheduling;\n type eventsV3TicketDefinition_universal_d_Registration = Registration;\n type eventsV3TicketDefinition_universal_d_EventType = EventType;\n const eventsV3TicketDefinition_universal_d_EventType: typeof EventType;\n type eventsV3TicketDefinition_universal_d_RegistrationStatus = RegistrationStatus;\n const eventsV3TicketDefinition_universal_d_RegistrationStatus: typeof RegistrationStatus;\n type eventsV3TicketDefinition_universal_d_RsvpCollection = RsvpCollection;\n type eventsV3TicketDefinition_universal_d_RsvpCollectionConfig = RsvpCollectionConfig;\n type eventsV3TicketDefinition_universal_d_RsvpStatusOptions = RsvpStatusOptions;\n const eventsV3TicketDefinition_universal_d_RsvpStatusOptions: typeof RsvpStatusOptions;\n type eventsV3TicketDefinition_universal_d_Ticketing = Ticketing;\n type eventsV3TicketDefinition_universal_d_TicketingConfig = TicketingConfig;\n type eventsV3TicketDefinition_universal_d_TaxConfig = TaxConfig;\n type eventsV3TicketDefinition_universal_d_TaxType = TaxType;\n const eventsV3TicketDefinition_universal_d_TaxType: typeof TaxType;\n type eventsV3TicketDefinition_universal_d_Money = Money;\n type eventsV3TicketDefinition_universal_d_ExternalEvent = ExternalEvent;\n type eventsV3TicketDefinition_universal_d_VisitorType = VisitorType;\n const eventsV3TicketDefinition_universal_d_VisitorType: typeof VisitorType;\n type eventsV3TicketDefinition_universal_d_CalendarLinks = CalendarLinks;\n type eventsV3TicketDefinition_universal_d_SiteUrl = SiteUrl;\n type eventsV3TicketDefinition_universal_d_Form = Form;\n type eventsV3TicketDefinition_universal_d_InputControl = InputControl;\n type eventsV3TicketDefinition_universal_d_InputControlType = InputControlType;\n const eventsV3TicketDefinition_universal_d_InputControlType: typeof InputControlType;\n type eventsV3TicketDefinition_universal_d_Input = Input;\n type eventsV3TicketDefinition_universal_d_ValueType = ValueType;\n const eventsV3TicketDefinition_universal_d_ValueType: typeof ValueType;\n type eventsV3TicketDefinition_universal_d_OptionSelection = OptionSelection;\n type eventsV3TicketDefinition_universal_d_OptionSelectionSelectedOptionOneOf = OptionSelectionSelectedOptionOneOf;\n type eventsV3TicketDefinition_universal_d_Label = Label;\n type eventsV3TicketDefinition_universal_d_FormMessages = FormMessages;\n type eventsV3TicketDefinition_universal_d_RsvpFormMessages = RsvpFormMessages;\n type eventsV3TicketDefinition_universal_d_PositiveResponseConfirmation = PositiveResponseConfirmation;\n type eventsV3TicketDefinition_universal_d_NegativeResponseConfirmation = NegativeResponseConfirmation;\n type eventsV3TicketDefinition_universal_d_Positive = Positive;\n type eventsV3TicketDefinition_universal_d_Negative = Negative;\n type eventsV3TicketDefinition_universal_d_CheckoutFormMessages = CheckoutFormMessages;\n type eventsV3TicketDefinition_universal_d_ResponseConfirmation = ResponseConfirmation;\n type eventsV3TicketDefinition_universal_d_RegistrationClosedMessages = RegistrationClosedMessages;\n type eventsV3TicketDefinition_universal_d_TicketsUnavailableMessages = TicketsUnavailableMessages;\n type eventsV3TicketDefinition_universal_d_Dashboard = Dashboard;\n type eventsV3TicketDefinition_universal_d_RsvpSummary = RsvpSummary;\n type eventsV3TicketDefinition_universal_d_TicketingSummary = TicketingSummary;\n type eventsV3TicketDefinition_universal_d_GuestListConfig = GuestListConfig;\n type eventsV3TicketDefinition_universal_d_Feed = Feed;\n type eventsV3TicketDefinition_universal_d_OnlineConferencing = OnlineConferencing;\n type eventsV3TicketDefinition_universal_d_OnlineConferencingConfig = OnlineConferencingConfig;\n type eventsV3TicketDefinition_universal_d_ConferenceType = ConferenceType;\n const eventsV3TicketDefinition_universal_d_ConferenceType: typeof ConferenceType;\n type eventsV3TicketDefinition_universal_d_OnlineConferencingSession = OnlineConferencingSession;\n type eventsV3TicketDefinition_universal_d_SeoSettings = SeoSettings;\n type eventsV3TicketDefinition_universal_d_SeoSchema = SeoSchema;\n type eventsV3TicketDefinition_universal_d_Keyword = Keyword;\n type eventsV3TicketDefinition_universal_d_Tag = Tag;\n type eventsV3TicketDefinition_universal_d_Settings = Settings;\n type eventsV3TicketDefinition_universal_d_Agenda = Agenda;\n type eventsV3TicketDefinition_universal_d_Category = Category;\n type eventsV3TicketDefinition_universal_d_CategoryCounts = CategoryCounts;\n type eventsV3TicketDefinition_universal_d_CategoryStateState = CategoryStateState;\n const eventsV3TicketDefinition_universal_d_CategoryStateState: typeof CategoryStateState;\n type eventsV3TicketDefinition_universal_d_EventDisplaySettings = EventDisplaySettings;\n type eventsV3TicketDefinition_universal_d_LabellingSettings = LabellingSettings;\n type eventsV3TicketDefinition_universal_d_EventUpdated = EventUpdated;\n type eventsV3TicketDefinition_universal_d_SeatingPlanCategoriesSummaryUpdated = SeatingPlanCategoriesSummaryUpdated;\n type eventsV3TicketDefinition_universal_d_CategoryDetails = CategoryDetails;\n type eventsV3TicketDefinition_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type eventsV3TicketDefinition_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type eventsV3TicketDefinition_universal_d_Asset = Asset;\n type eventsV3TicketDefinition_universal_d_State = State;\n const eventsV3TicketDefinition_universal_d_State: typeof State;\n type eventsV3TicketDefinition_universal_d_SiteCreated = SiteCreated;\n type eventsV3TicketDefinition_universal_d_SiteCreatedContext = SiteCreatedContext;\n const eventsV3TicketDefinition_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type eventsV3TicketDefinition_universal_d_Namespace = Namespace;\n const eventsV3TicketDefinition_universal_d_Namespace: typeof Namespace;\n type eventsV3TicketDefinition_universal_d_SiteTransferred = SiteTransferred;\n type eventsV3TicketDefinition_universal_d_SiteDeleted = SiteDeleted;\n type eventsV3TicketDefinition_universal_d_DeleteContext = DeleteContext;\n type eventsV3TicketDefinition_universal_d_DeleteStatus = DeleteStatus;\n const eventsV3TicketDefinition_universal_d_DeleteStatus: typeof DeleteStatus;\n type eventsV3TicketDefinition_universal_d_SiteUndeleted = SiteUndeleted;\n type eventsV3TicketDefinition_universal_d_SitePublished = SitePublished;\n type eventsV3TicketDefinition_universal_d_SiteUnpublished = SiteUnpublished;\n type eventsV3TicketDefinition_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type eventsV3TicketDefinition_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type eventsV3TicketDefinition_universal_d_ServiceProvisioned = ServiceProvisioned;\n type eventsV3TicketDefinition_universal_d_ServiceRemoved = ServiceRemoved;\n type eventsV3TicketDefinition_universal_d_SiteRenamed = SiteRenamed;\n type eventsV3TicketDefinition_universal_d_SiteHardDeleted = SiteHardDeleted;\n type eventsV3TicketDefinition_universal_d_NamespaceChanged = NamespaceChanged;\n type eventsV3TicketDefinition_universal_d_StudioAssigned = StudioAssigned;\n type eventsV3TicketDefinition_universal_d_StudioUnassigned = StudioUnassigned;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionFromTrashBinRequest = GetTicketDefinitionFromTrashBinRequest;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionFromTrashBinResponse = GetTicketDefinitionFromTrashBinResponse;\n type eventsV3TicketDefinition_universal_d_ScheduleLegacyTimeCapsuleTaskRequest = ScheduleLegacyTimeCapsuleTaskRequest;\n const eventsV3TicketDefinition_universal_d_createTicketDefinition: typeof createTicketDefinition;\n type eventsV3TicketDefinition_universal_d_CreateTicketDefinitionOptions = CreateTicketDefinitionOptions;\n const eventsV3TicketDefinition_universal_d_updateTicketDefinition: typeof updateTicketDefinition;\n type eventsV3TicketDefinition_universal_d_UpdateTicketDefinition = UpdateTicketDefinition;\n type eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionOptions = UpdateTicketDefinitionOptions;\n const eventsV3TicketDefinition_universal_d_getTicketDefinition: typeof getTicketDefinition;\n type eventsV3TicketDefinition_universal_d_GetTicketDefinitionOptions = GetTicketDefinitionOptions;\n const eventsV3TicketDefinition_universal_d_deleteTicketDefinition: typeof deleteTicketDefinition;\n const eventsV3TicketDefinition_universal_d_reorderTicketDefinitions: typeof reorderTicketDefinitions;\n type eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsOptions = ReorderTicketDefinitionsOptions;\n const eventsV3TicketDefinition_universal_d_queryTicketDefinitions: typeof queryTicketDefinitions;\n type eventsV3TicketDefinition_universal_d_QueryTicketDefinitionsOptions = QueryTicketDefinitionsOptions;\n type eventsV3TicketDefinition_universal_d_TicketDefinitionsQueryResult = TicketDefinitionsQueryResult;\n type eventsV3TicketDefinition_universal_d_TicketDefinitionsQueryBuilder = TicketDefinitionsQueryBuilder;\n const eventsV3TicketDefinition_universal_d_queryAvailableTicketDefinitions: typeof queryAvailableTicketDefinitions;\n type eventsV3TicketDefinition_universal_d_QueryAvailableTicketDefinitionsOptions = QueryAvailableTicketDefinitionsOptions;\n const eventsV3TicketDefinition_universal_d_countTicketDefinitions: typeof countTicketDefinitions;\n type eventsV3TicketDefinition_universal_d_CountTicketDefinitionsOptions = CountTicketDefinitionsOptions;\n const eventsV3TicketDefinition_universal_d_countAvailableTicketDefinitions: typeof countAvailableTicketDefinitions;\n type eventsV3TicketDefinition_universal_d_CountAvailableTicketDefinitionsOptions = CountAvailableTicketDefinitionsOptions;\n const eventsV3TicketDefinition_universal_d_bulkDeleteTicketDefinitionsByFilter: typeof bulkDeleteTicketDefinitionsByFilter;\n const eventsV3TicketDefinition_universal_d_changeCurrency: typeof changeCurrency;\n type eventsV3TicketDefinition_universal_d_ChangeCurrencyOptions = ChangeCurrencyOptions;\n namespace eventsV3TicketDefinition_universal_d {\n export {\n eventsV3TicketDefinition_universal_d_TicketDefinition as TicketDefinition,\n eventsV3TicketDefinition_universal_d_SalePeriod as SalePeriod,\n eventsV3TicketDefinition_universal_d_PricingMethod as PricingMethod,\n eventsV3TicketDefinition_universal_d_PricingMethodPriceOneOf as PricingMethodPriceOneOf,\n eventsV3TicketDefinition_universal_d_CommonMoney as CommonMoney,\n eventsV3TicketDefinition_universal_d_PricingOptions as PricingOptions,\n eventsV3TicketDefinition_universal_d_OptionDetails as OptionDetails,\n eventsV3TicketDefinition_universal_d_PricingTypeEnumType as PricingTypeEnumType,\n eventsV3TicketDefinition_universal_d_Type as Type,\n eventsV3TicketDefinition_universal_d_SaleStatusEnumStatus as SaleStatusEnumStatus,\n eventsV3TicketDefinition_universal_d_SalesDetails as SalesDetails,\n eventsV3TicketDefinition_universal_d_ExtendedFields as ExtendedFields,\n eventsV3TicketDefinition_universal_d_EventDetails as EventDetails,\n eventsV3TicketDefinition_universal_d_V3Location as V3Location,\n eventsV3TicketDefinition_universal_d_LocationLocationType as LocationLocationType,\n eventsV3TicketDefinition_universal_d_CommonAddress as CommonAddress,\n eventsV3TicketDefinition_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf,\n eventsV3TicketDefinition_universal_d_CommonStreetAddress as CommonStreetAddress,\n eventsV3TicketDefinition_universal_d_CommonAddressLocation as CommonAddressLocation,\n eventsV3TicketDefinition_universal_d_CommonSubdivision as CommonSubdivision,\n eventsV3TicketDefinition_universal_d_SubdivisionSubdivisionType as SubdivisionSubdivisionType,\n eventsV3TicketDefinition_universal_d_DateAndTimeSettings as DateAndTimeSettings,\n eventsV3TicketDefinition_universal_d_RecurrenceStatusStatus as RecurrenceStatusStatus,\n eventsV3TicketDefinition_universal_d_V3Recurrences as V3Recurrences,\n eventsV3TicketDefinition_universal_d_V3Occurrence as V3Occurrence,\n eventsV3TicketDefinition_universal_d_Formatted as Formatted,\n eventsV3TicketDefinition_universal_d_EventStatusStatus as EventStatusStatus,\n eventsV3TicketDefinition_universal_d_SalePeriodUpdated as SalePeriodUpdated,\n eventsV3TicketDefinition_universal_d_TicketDefinitionSaleStarted as TicketDefinitionSaleStarted,\n eventsV3TicketDefinition_universal_d_TicketDefinitionSaleEnded as TicketDefinitionSaleEnded,\n eventsV3TicketDefinition_universal_d_DomainEvent as DomainEvent,\n eventsV3TicketDefinition_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n eventsV3TicketDefinition_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n eventsV3TicketDefinition_universal_d_RestoreInfo as RestoreInfo,\n eventsV3TicketDefinition_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n eventsV3TicketDefinition_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n eventsV3TicketDefinition_universal_d_ActionEvent as ActionEvent,\n eventsV3TicketDefinition_universal_d_MessageEnvelope as MessageEnvelope,\n eventsV3TicketDefinition_universal_d_IdentificationData as IdentificationData,\n eventsV3TicketDefinition_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n eventsV3TicketDefinition_universal_d_WebhookIdentityType as WebhookIdentityType,\n eventsV3TicketDefinition_universal_d_InvalidateCache as InvalidateCache,\n eventsV3TicketDefinition_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n eventsV3TicketDefinition_universal_d_App as App,\n eventsV3TicketDefinition_universal_d_Page as Page,\n eventsV3TicketDefinition_universal_d_URI as URI,\n eventsV3TicketDefinition_universal_d_File as File,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionSummaryRequest as GetTicketDefinitionSummaryRequest,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionSummaryResponse as GetTicketDefinitionSummaryResponse,\n eventsV3TicketDefinition_universal_d_TicketDefinitionSummary as TicketDefinitionSummary,\n eventsV3TicketDefinition_universal_d_ListEventTicketingSummaryRequest as ListEventTicketingSummaryRequest,\n eventsV3TicketDefinition_universal_d_ListEventTicketingSummaryResponse as ListEventTicketingSummaryResponse,\n eventsV3TicketDefinition_universal_d_EventTicketingSummary as EventTicketingSummary,\n eventsV3TicketDefinition_universal_d_Empty as Empty,\n eventsV3TicketDefinition_universal_d_ReservationCreated as ReservationCreated,\n eventsV3TicketDefinition_universal_d_ReservationStatus as ReservationStatus,\n eventsV3TicketDefinition_universal_d_TicketQuantity as TicketQuantity,\n eventsV3TicketDefinition_universal_d_ReservationCount as ReservationCount,\n eventsV3TicketDefinition_universal_d_ReservationUpdated as ReservationUpdated,\n eventsV3TicketDefinition_universal_d_EventDeleted as EventDeleted,\n eventsV3TicketDefinition_universal_d_CreateTicketDefinitionRequest as CreateTicketDefinitionRequest,\n eventsV3TicketDefinition_universal_d_Field as Field,\n eventsV3TicketDefinition_universal_d_CreateTicketDefinitionResponse as CreateTicketDefinitionResponse,\n eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionRequest as UpdateTicketDefinitionRequest,\n eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionResponse as UpdateTicketDefinitionResponse,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionRequest as GetTicketDefinitionRequest,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionResponse as GetTicketDefinitionResponse,\n eventsV3TicketDefinition_universal_d_DeleteTicketDefinitionRequest as DeleteTicketDefinitionRequest,\n eventsV3TicketDefinition_universal_d_DeleteTicketDefinitionResponse as DeleteTicketDefinitionResponse,\n eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsRequest as ReorderTicketDefinitionsRequest,\n eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsRequestReferenceDefinitionOneOf as ReorderTicketDefinitionsRequestReferenceDefinitionOneOf,\n eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsResponse as ReorderTicketDefinitionsResponse,\n eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionSortIndexRequest as UpdateTicketDefinitionSortIndexRequest,\n eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionSortIndexResponse as UpdateTicketDefinitionSortIndexResponse,\n eventsV3TicketDefinition_universal_d_QueryTicketDefinitionsRequest as QueryTicketDefinitionsRequest,\n eventsV3TicketDefinition_universal_d_QueryV2 as QueryV2,\n eventsV3TicketDefinition_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n eventsV3TicketDefinition_universal_d_Sorting as Sorting,\n eventsV3TicketDefinition_universal_d_SortOrder as SortOrder,\n eventsV3TicketDefinition_universal_d_Paging as Paging,\n eventsV3TicketDefinition_universal_d_CursorPaging as CursorPaging,\n eventsV3TicketDefinition_universal_d_QueryTicketDefinitionsResponse as QueryTicketDefinitionsResponse,\n eventsV3TicketDefinition_universal_d_PagingMetadataV2 as PagingMetadataV2,\n eventsV3TicketDefinition_universal_d_Cursors as Cursors,\n eventsV3TicketDefinition_universal_d_QueryAvailableTicketDefinitionsRequest as QueryAvailableTicketDefinitionsRequest,\n eventsV3TicketDefinition_universal_d_QueryAvailableTicketDefinitionsResponse as QueryAvailableTicketDefinitionsResponse,\n eventsV3TicketDefinition_universal_d_CountTicketDefinitionsRequest as CountTicketDefinitionsRequest,\n eventsV3TicketDefinition_universal_d_CountTicketDefinitionsResponse as CountTicketDefinitionsResponse,\n eventsV3TicketDefinition_universal_d_FacetCounts as FacetCounts,\n eventsV3TicketDefinition_universal_d_CountAvailableTicketDefinitionsRequest as CountAvailableTicketDefinitionsRequest,\n eventsV3TicketDefinition_universal_d_CountAvailableTicketDefinitionsResponse as CountAvailableTicketDefinitionsResponse,\n eventsV3TicketDefinition_universal_d_BulkDeleteTicketDefinitionsByFilterRequest as BulkDeleteTicketDefinitionsByFilterRequest,\n eventsV3TicketDefinition_universal_d_BulkDeleteTicketDefinitionsByFilterResponse as BulkDeleteTicketDefinitionsByFilterResponse,\n eventsV3TicketDefinition_universal_d_ChangeCurrencyRequest as ChangeCurrencyRequest,\n eventsV3TicketDefinition_universal_d_ChangeCurrencyResponse as ChangeCurrencyResponse,\n eventsV3TicketDefinition_universal_d_BulkCopyTicketDefinitionsByEventIdRequest as BulkCopyTicketDefinitionsByEventIdRequest,\n eventsV3TicketDefinition_universal_d_BulkCopyTicketDefinitionsByEventIdResponse as BulkCopyTicketDefinitionsByEventIdResponse,\n eventsV3TicketDefinition_universal_d_CopiedTicketDefinition as CopiedTicketDefinition,\n eventsV3TicketDefinition_universal_d_EventCanceled as EventCanceled,\n eventsV3TicketDefinition_universal_d_EventEnded as EventEnded,\n eventsV3TicketDefinition_universal_d_EventCreated as EventCreated,\n eventsV3TicketDefinition_universal_d_Location as Location,\n eventsV3TicketDefinition_universal_d_MapCoordinates as MapCoordinates,\n eventsV3TicketDefinition_universal_d_LocationType as LocationType,\n eventsV3TicketDefinition_universal_d_Address as Address,\n eventsV3TicketDefinition_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n eventsV3TicketDefinition_universal_d_StreetAddress as StreetAddress,\n eventsV3TicketDefinition_universal_d_AddressLocation as AddressLocation,\n eventsV3TicketDefinition_universal_d_Subdivision as Subdivision,\n eventsV3TicketDefinition_universal_d_SubdivisionType as SubdivisionType,\n eventsV3TicketDefinition_universal_d_ScheduleConfig as ScheduleConfig,\n eventsV3TicketDefinition_universal_d_Recurrences as Recurrences,\n eventsV3TicketDefinition_universal_d_Occurrence as Occurrence,\n eventsV3TicketDefinition_universal_d_Status as Status,\n eventsV3TicketDefinition_universal_d_EventStatus as EventStatus,\n eventsV3TicketDefinition_universal_d_Event as Event,\n eventsV3TicketDefinition_universal_d_Scheduling as Scheduling,\n eventsV3TicketDefinition_universal_d_Registration as Registration,\n eventsV3TicketDefinition_universal_d_EventType as EventType,\n eventsV3TicketDefinition_universal_d_RegistrationStatus as RegistrationStatus,\n eventsV3TicketDefinition_universal_d_RsvpCollection as RsvpCollection,\n eventsV3TicketDefinition_universal_d_RsvpCollectionConfig as RsvpCollectionConfig,\n eventsV3TicketDefinition_universal_d_RsvpStatusOptions as RsvpStatusOptions,\n eventsV3TicketDefinition_universal_d_Ticketing as Ticketing,\n eventsV3TicketDefinition_universal_d_TicketingConfig as TicketingConfig,\n eventsV3TicketDefinition_universal_d_TaxConfig as TaxConfig,\n eventsV3TicketDefinition_universal_d_TaxType as TaxType,\n eventsV3TicketDefinition_universal_d_Money as Money,\n eventsV3TicketDefinition_universal_d_ExternalEvent as ExternalEvent,\n eventsV3TicketDefinition_universal_d_VisitorType as VisitorType,\n eventsV3TicketDefinition_universal_d_CalendarLinks as CalendarLinks,\n eventsV3TicketDefinition_universal_d_SiteUrl as SiteUrl,\n eventsV3TicketDefinition_universal_d_Form as Form,\n eventsV3TicketDefinition_universal_d_InputControl as InputControl,\n eventsV3TicketDefinition_universal_d_InputControlType as InputControlType,\n eventsV3TicketDefinition_universal_d_Input as Input,\n eventsV3TicketDefinition_universal_d_ValueType as ValueType,\n eventsV3TicketDefinition_universal_d_OptionSelection as OptionSelection,\n eventsV3TicketDefinition_universal_d_OptionSelectionSelectedOptionOneOf as OptionSelectionSelectedOptionOneOf,\n eventsV3TicketDefinition_universal_d_Label as Label,\n eventsV3TicketDefinition_universal_d_FormMessages as FormMessages,\n eventsV3TicketDefinition_universal_d_RsvpFormMessages as RsvpFormMessages,\n eventsV3TicketDefinition_universal_d_PositiveResponseConfirmation as PositiveResponseConfirmation,\n eventsV3TicketDefinition_universal_d_NegativeResponseConfirmation as NegativeResponseConfirmation,\n eventsV3TicketDefinition_universal_d_Positive as Positive,\n eventsV3TicketDefinition_universal_d_Negative as Negative,\n eventsV3TicketDefinition_universal_d_CheckoutFormMessages as CheckoutFormMessages,\n eventsV3TicketDefinition_universal_d_ResponseConfirmation as ResponseConfirmation,\n eventsV3TicketDefinition_universal_d_RegistrationClosedMessages as RegistrationClosedMessages,\n eventsV3TicketDefinition_universal_d_TicketsUnavailableMessages as TicketsUnavailableMessages,\n eventsV3TicketDefinition_universal_d_Dashboard as Dashboard,\n eventsV3TicketDefinition_universal_d_RsvpSummary as RsvpSummary,\n eventsV3TicketDefinition_universal_d_TicketingSummary as TicketingSummary,\n eventsV3TicketDefinition_universal_d_GuestListConfig as GuestListConfig,\n eventsV3TicketDefinition_universal_d_Feed as Feed,\n eventsV3TicketDefinition_universal_d_OnlineConferencing as OnlineConferencing,\n eventsV3TicketDefinition_universal_d_OnlineConferencingConfig as OnlineConferencingConfig,\n eventsV3TicketDefinition_universal_d_ConferenceType as ConferenceType,\n eventsV3TicketDefinition_universal_d_OnlineConferencingSession as OnlineConferencingSession,\n eventsV3TicketDefinition_universal_d_SeoSettings as SeoSettings,\n eventsV3TicketDefinition_universal_d_SeoSchema as SeoSchema,\n eventsV3TicketDefinition_universal_d_Keyword as Keyword,\n eventsV3TicketDefinition_universal_d_Tag as Tag,\n eventsV3TicketDefinition_universal_d_Settings as Settings,\n eventsV3TicketDefinition_universal_d_Agenda as Agenda,\n eventsV3TicketDefinition_universal_d_Category as Category,\n eventsV3TicketDefinition_universal_d_CategoryCounts as CategoryCounts,\n eventsV3TicketDefinition_universal_d_CategoryStateState as CategoryStateState,\n eventsV3TicketDefinition_universal_d_EventDisplaySettings as EventDisplaySettings,\n eventsV3TicketDefinition_universal_d_LabellingSettings as LabellingSettings,\n eventsV3TicketDefinition_universal_d_EventUpdated as EventUpdated,\n eventsV3TicketDefinition_universal_d_SeatingPlanCategoriesSummaryUpdated as SeatingPlanCategoriesSummaryUpdated,\n eventsV3TicketDefinition_universal_d_CategoryDetails as CategoryDetails,\n eventsV3TicketDefinition_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n eventsV3TicketDefinition_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n eventsV3TicketDefinition_universal_d_Asset as Asset,\n eventsV3TicketDefinition_universal_d_State as State,\n eventsV3TicketDefinition_universal_d_SiteCreated as SiteCreated,\n eventsV3TicketDefinition_universal_d_SiteCreatedContext as SiteCreatedContext,\n eventsV3TicketDefinition_universal_d_Namespace as Namespace,\n eventsV3TicketDefinition_universal_d_SiteTransferred as SiteTransferred,\n eventsV3TicketDefinition_universal_d_SiteDeleted as SiteDeleted,\n eventsV3TicketDefinition_universal_d_DeleteContext as DeleteContext,\n eventsV3TicketDefinition_universal_d_DeleteStatus as DeleteStatus,\n eventsV3TicketDefinition_universal_d_SiteUndeleted as SiteUndeleted,\n eventsV3TicketDefinition_universal_d_SitePublished as SitePublished,\n eventsV3TicketDefinition_universal_d_SiteUnpublished as SiteUnpublished,\n eventsV3TicketDefinition_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n eventsV3TicketDefinition_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n eventsV3TicketDefinition_universal_d_ServiceProvisioned as ServiceProvisioned,\n eventsV3TicketDefinition_universal_d_ServiceRemoved as ServiceRemoved,\n eventsV3TicketDefinition_universal_d_SiteRenamed as SiteRenamed,\n eventsV3TicketDefinition_universal_d_SiteHardDeleted as SiteHardDeleted,\n eventsV3TicketDefinition_universal_d_NamespaceChanged as NamespaceChanged,\n eventsV3TicketDefinition_universal_d_StudioAssigned as StudioAssigned,\n eventsV3TicketDefinition_universal_d_StudioUnassigned as StudioUnassigned,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionFromTrashBinRequest as GetTicketDefinitionFromTrashBinRequest,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionFromTrashBinResponse as GetTicketDefinitionFromTrashBinResponse,\n eventsV3TicketDefinition_universal_d_ScheduleLegacyTimeCapsuleTaskRequest as ScheduleLegacyTimeCapsuleTaskRequest,\n eventsV3TicketDefinition_universal_d_createTicketDefinition as createTicketDefinition,\n eventsV3TicketDefinition_universal_d_CreateTicketDefinitionOptions as CreateTicketDefinitionOptions,\n eventsV3TicketDefinition_universal_d_updateTicketDefinition as updateTicketDefinition,\n eventsV3TicketDefinition_universal_d_UpdateTicketDefinition as UpdateTicketDefinition,\n eventsV3TicketDefinition_universal_d_UpdateTicketDefinitionOptions as UpdateTicketDefinitionOptions,\n eventsV3TicketDefinition_universal_d_getTicketDefinition as getTicketDefinition,\n eventsV3TicketDefinition_universal_d_GetTicketDefinitionOptions as GetTicketDefinitionOptions,\n eventsV3TicketDefinition_universal_d_deleteTicketDefinition as deleteTicketDefinition,\n eventsV3TicketDefinition_universal_d_reorderTicketDefinitions as reorderTicketDefinitions,\n eventsV3TicketDefinition_universal_d_ReorderTicketDefinitionsOptions as ReorderTicketDefinitionsOptions,\n eventsV3TicketDefinition_universal_d_queryTicketDefinitions as queryTicketDefinitions,\n eventsV3TicketDefinition_universal_d_QueryTicketDefinitionsOptions as QueryTicketDefinitionsOptions,\n eventsV3TicketDefinition_universal_d_TicketDefinitionsQueryResult as TicketDefinitionsQueryResult,\n eventsV3TicketDefinition_universal_d_TicketDefinitionsQueryBuilder as TicketDefinitionsQueryBuilder,\n eventsV3TicketDefinition_universal_d_queryAvailableTicketDefinitions as queryAvailableTicketDefinitions,\n eventsV3TicketDefinition_universal_d_QueryAvailableTicketDefinitionsOptions as QueryAvailableTicketDefinitionsOptions,\n eventsV3TicketDefinition_universal_d_countTicketDefinitions as countTicketDefinitions,\n eventsV3TicketDefinition_universal_d_CountTicketDefinitionsOptions as CountTicketDefinitionsOptions,\n eventsV3TicketDefinition_universal_d_countAvailableTicketDefinitions as countAvailableTicketDefinitions,\n eventsV3TicketDefinition_universal_d_CountAvailableTicketDefinitionsOptions as CountAvailableTicketDefinitionsOptions,\n eventsV3TicketDefinition_universal_d_bulkDeleteTicketDefinitionsByFilter as bulkDeleteTicketDefinitionsByFilter,\n eventsV3TicketDefinition_universal_d_changeCurrency as changeCurrency,\n eventsV3TicketDefinition_universal_d_ChangeCurrencyOptions as ChangeCurrencyOptions,\n };\n }\n \n export { eventsV1Category_universal_d as categories, eventsV1Form_universal_d as forms, eventsGuestsV1Guest_universal_d as guests, eventsNotificationsV2NotificationConfig_universal_d as notifications, eventsV1Order_universal_d as orders, eventsV2Policy_universal_d as policies, eventsV1RichContent_universal_d as ricos, eventsV1Rsvp_universal_d as rsvp, eventsV2Rsvp_universal_d as rsvpV2, eventsScheduleV1ScheduleItemSchedule_universal_d as schedule, eventsScheduleV1ScheduleItemScheduleBookmarks_universal_d as scheduleBookmarks, eventsStaffmembersV1StaffMember_universal_d as staffMembers, eventsV1TicketDefinition_universal_d as ticketDefinitions, eventsV3TicketDefinition_universal_d as ticketDefinitionsV2, eventsV1Ticket_universal_d as tickets, eventsV3Event_universal_d as wixEventsV2 };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-categories-backend.d.ts", "content": "declare module \"wix-categories-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Category {\n /** Category ID. */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Category was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Category name. */\n name?: string | null;\n /**\n * Category image.\n * Pass existing media ID for image previously saved in Wix media manager.\n * Pass full image URL to upload an image to Wix media manager.\n * In case of full url the image will be updated eventually.\n */\n image?: string;\n /**\n * Number of items in this category alone.\n * @readonly\n */\n numberOfItems?: number;\n /**\n * Number of items including all items in subcategories.\n * @internal\n * @readonly\n */\n totalNumberOfItems?: number;\n /** Category description. */\n description?: string | null;\n /**\n * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).\n * Even if visible is `false`, it can still be added manually to static page.\n * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.\n * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.\n */\n visible?: boolean | null;\n /**\n * A category's breadcrumbs, Updated on moved to different parent or on renamed.\n * This field will only be returned if request.fields contains `BREADCRUMBS`\n * @readonly\n */\n breadcrumbs?: BreadcrumbItemValues;\n /** The parent category. */\n parentCategory?: ParentCategory;\n /**\n * A permanent, friendly URL name.\n * If not provided, on create generated automatically.\n * When provided, validated and must be unique.\n */\n slug?: string | null;\n /**\n * Custom SEO data for the category.\n * @internal\n */\n seoData?: SeoSchema;\n /**\n * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.\n * In order to use this field you have to integrate with \"Ricos\" on frontend side. To learn how to do it visit https://ricos.js.org/.\n */\n richContentDescription?: RichContent;\n /**\n * Data related to the tree that contains the category.\n * @internal\n * @readonly\n */\n treeReference?: TreeReference;\n /** Extensions enabling users to save custom data related to the category. */\n extendedFields?: ExtendedFields;\n }\n /** Wrapper for optional BreadcrumbItem values */\n interface BreadcrumbItemValues {\n /**\n * The wrapped BreadcrumbItem values\n * @readonly\n */\n values?: BreadcrumbItem[];\n }\n interface BreadcrumbItem {\n /** Represents the id of the category. */\n categoryId?: string;\n /** Represents the name of the category. Translatable */\n categoryName?: string;\n /** Represents the slug. A permanent, friendly URL name of the category. */\n categorySlug?: string;\n }\n interface ParentCategory {\n /**\n * Represents the id of the parent category.\n * If not passed, the default is the root category.\n */\n _id?: string | null;\n /**\n * Represents the index of current category within the parent category.\n * @readonly\n */\n index?: number | 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 }\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 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 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 /** 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?: 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 /** 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 TreeReference {\n /** The unique namespace of the app. */\n appNamespace?: string;\n /** Optional - The key of the tree. Must be provided when single app manages more than one tree. */\n treeKey?: string | null;\n }\n interface ExtendedFields {\n /**\n * Extended field data as key:object pairs. 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 created.\n *\n * You can only access fields for which you have the appropriate permissions.\n */\n namespaces?: Record>;\n }\n interface CreateCategoryRequest {\n /** Category to be created. */\n category: Category;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\n }\n enum RequestedFields {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n BREADCRUMBS = \"BREADCRUMBS\"\n }\n interface CreateCategoryResponse {\n /** The created Category. */\n category?: Category;\n }\n interface GetCategoryRequest {\n /** Id of the Category to retrieve. */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\n }\n interface GetCategoryResponse {\n /** The retrieved Category. */\n category?: Category;\n }\n interface UpdateCategoryRequest {\n /** Category to be updated, may be partial. */\n category: Category;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\n }\n interface UpdateCategoryResponse {\n /** The updated Category. */\n category?: Category;\n }\n interface DeleteCategoryRequest {\n /** Id of the Category to delete. */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n }\n interface DeleteCategoryResponse {\n }\n interface QueryCategoriesRequest {\n /** WQL query expression. */\n query: CursorQuery;\n /**\n * A reference to the tree that contains this category.\n * Used only in the first request. Following requests use the cursor token.\n */\n treeReference: TreeReference;\n /**\n * Whether hidden categories should be included in the response. Default is `false`.\n * Used only in the first request. Following requests use the cursor token.\n */\n includeHidden?: boolean;\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\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 QueryCategoriesResponse {\n /** Categories which satisfy the provided query. */\n categories?: Category[];\n /** Paging metadata. Contains cursor which can be used in next query. */\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 PlaceCategoryInParentCategoryRequest {\n /** ID of category to place. */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /**\n * ID of parent category.\n * Optional. When not passed it will fallback to the root category\n */\n parentCategoryId?: string | null;\n /**\n * Where to place the subcategory.\n * `FIRST` - make category with `category_id` first subcategory with manual arrangement.\n * `LAST` - make category with `category_id` last subcategory with manual arrangement.\n * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.\n */\n position: PlaceCategoryInParentCategoryRequestPosition;\n /** Required when `position` is `BEFORE`. Otherwise ignored */\n moveBeforeCategoryId?: string | null;\n }\n enum PlaceCategoryInParentCategoryRequestPosition {\n UNKNOWN_POSITION = \"UNKNOWN_POSITION\",\n FIRST = \"FIRST\",\n LAST = \"LAST\",\n BEFORE = \"BEFORE\"\n }\n interface PlaceCategoryInParentCategoryResponse {\n /** ID of parent category. */\n parentCategoryId?: string | null;\n /** Information about manually arranged categories after move. */\n arrangedCategoriesAfterMove?: string[];\n }\n interface BulkCreateCategoriesRequest {\n /** List of categories to be created. */\n categories: Category[];\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n /** Whether to return the category entity in the response. */\n returnEntity?: boolean;\n }\n interface BulkCreateCategoriesResponse {\n /** Categories created by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkCategoriesResult {\n /** Information about successful action or error for failure. */\n itemMetadata?: ItemMetadata;\n /** Created or updated category. Optional - returned only if requested with `return_entity` set to `true`. */\n category?: Category;\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 BulkUpdateCategoriesRequest {\n /** List of categories to be updated. */\n categories: MaskedCategory[];\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n /** Whether to return the category entity in the response. */\n returnEntity?: boolean;\n }\n interface MaskedCategory {\n /** Category to be updated, may be partial. */\n category?: Category;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface BulkUpdateCategoriesResponse {\n /** Categories updated by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface UpdateCategoryVisibilityRequest {\n /** ID of category to be updated */\n categoryId: string;\n /** value to set `visible` to */\n visible: boolean;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Latest revision of the category. */\n revision: string | null;\n }\n interface UpdateCategoryVisibilityResponse {\n /** The updated Category. */\n category?: Category;\n }\n interface BulkSetVisibilityRequest {\n /** IDs of categories to be updated. */\n categoryIds: string[];\n /** value to set `visible` to. This value will be set for all categories in the request */\n visible: boolean;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Whether to return the category entity in the response. */\n returnEntity?: boolean;\n }\n interface BulkSetVisibilityResponse {\n /** Categories updated by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkSetVisibilityByFilterRequest {\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 /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n /** value to set `visible` to. This value will be set for all categories that match the filter */\n visible: boolean;\n }\n interface BulkSetVisibilityByFilterResponse {\n /** Token that can be used to query \"AsyncJobService\" */\n jobId?: string;\n }\n interface BulkDeleteCategoriesRequest {\n /** IDs of categories to be deleted. */\n categoryIds: string[];\n }\n interface BulkDeleteCategoriesResponse {\n /** Categories deleted by bulk action. */\n results?: BulkCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkDeleteCategoriesByFilterRequest {\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 /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n interface BulkDeleteCategoriesByFilterResponse {\n /** Token that can be used to query \"AsyncJobService\" */\n jobId?: string;\n }\n interface AddItemsToCategoryRequest {\n /** Category id. */\n categoryId: string;\n /** List of catalog items with reference info. */\n items: ItemReference[];\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n }\n interface ItemReference {\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 }\n interface AddItemsToCategoryResponse {\n /** Items added by bulk action. */\n results?: BulkItemsToCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkItemsToCategoryResult {\n /** Information about items that were added successfully and errors for failed items. */\n itemMetadata?: ItemReferenceMetadata;\n }\n interface ItemReferenceMetadata {\n /** Item reference from request. */\n itemReference?: ItemReference;\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 ItemAddedToCategory {\n /** Category ID. */\n categoryId?: string;\n /** Catalog item reference info. */\n itemReference?: ItemReference;\n }\n interface ItemsAddedToCategory {\n /** Category ID. */\n categoryId?: string;\n /** List of catalog items with reference info. */\n items?: ItemReference[];\n }\n interface AddItemToCategoriesRequest {\n /** Catalog item reference info */\n itemReference: ItemReference;\n /** Category ids. */\n categoryIds: string[];\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n interface AddItemToCategoriesResponse {\n /** Items added by bulk action. */\n results?: BulkItemToCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkItemToCategoriesResult {\n /** Information about categories to which item was added successfully and errors for failed items. `id` is ID of category. */\n itemMetadata?: ItemMetadata;\n }\n interface RemoveItemsFromCategoryRequest {\n /** Category id */\n categoryId: string;\n /** List of catalog items with reference info. */\n items: ItemReference[];\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n }\n interface RemoveItemsFromCategoryResponse {\n /** Items removed by bulk action. */\n results?: BulkItemsToCategoryResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ItemRemovedFromCategory {\n /** Category ID. */\n categoryId?: string;\n /** Catalog item reference info. */\n itemReference?: ItemReference;\n }\n interface ItemsRemovedFromCategory {\n /** Category ID. */\n categoryId?: string;\n /** List of catalog items with reference info. */\n items?: ItemReference[];\n }\n interface RemoveItemFromCategoriesRequest {\n /** Catalog item reference info */\n itemReference: ItemReference;\n /** Category ids. */\n categoryIds: string[];\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n interface RemoveItemFromCategoriesResponse {\n /** Items removed by bulk action. */\n results?: BulkItemToCategoriesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface ListItemsInCategoryRequest {\n /** ID of category containing items. */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Default: `false`. When `true` items arranged by user will be return before all other items. */\n useCategoryArrangement?: boolean;\n /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */\n includeItemsFromSubcategories?: boolean;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */\n paging?: CursorPaging;\n }\n interface ListItemsInCategoryResponse {\n /** Items which satisfy query. */\n items?: ItemReference[];\n /** Paging metadata. Contains cursor which can be used in next query */\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListCategoriesForItemRequest {\n /** Catalog item reference info. */\n itemReference: ItemReference;\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n interface ListCategoriesForItemResponse {\n /** A list of category IDs that contain this item directly. */\n directCategoryIds?: string[];\n /** A list of category IDs that contain this item directly and their parent category IDs. */\n allCategoryIds?: string[];\n }\n interface MoveItemInCategoryRequest {\n /**\n * ID of category.\n * Item must be direct child of this category, otherwise error returned\n */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Item to move. */\n item: ItemReference;\n /**\n * Where to move item.\n * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.\n * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.\n * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.\n * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.\n */\n position: Position;\n /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */\n beforeItem?: ItemReference;\n }\n enum Position {\n UNKNOWN_POSITION = \"UNKNOWN_POSITION\",\n FIRST = \"FIRST\",\n LAST = \"LAST\",\n BEFORE = \"BEFORE\",\n NONE = \"NONE\"\n }\n interface MoveItemInCategoryResponse {\n /** Information about manually arranged items after move. */\n arrangedItemsAfterMove?: ItemReference[];\n }\n interface SetArrangedItemsRequest {\n /** ID of category. */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /**\n * List of arranged items to set.\n * All items must be direct children of category with `category_id`, otherwise error returned.\n */\n items?: ItemReference[];\n }\n interface SetArrangedItemsResponse {\n /** The updated list of arranged items in category. */\n items?: ItemReference[];\n }\n interface GetArrangedItemsRequest {\n /** ID of category. */\n categoryId: string;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n }\n interface GetArrangedItemsResponse {\n /** List of arranged items in category. */\n items?: ItemReference[];\n }\n interface GetCategoriesTreeRequest {\n /** The ID of the tree. */\n treeId?: string;\n }\n interface GetCategoriesTreeResponse {\n /** Categories tree. */\n categoriesTree?: CategoryTreeNode[];\n }\n /** Represents a node in the view of categories tree */\n interface CategoryTreeNode {\n /** Category ID. */\n _id?: Uint8Array;\n /** A list of child categories. */\n subcategories?: CategoryTreeNode[];\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\n }\n /**\n * Creates a new Category.\n * @param category - Category to be created.\n * @internal\n * @documentationMaturity preview\n * @requiredField category\n * @requiredField category.name\n * @requiredField category.parentCategory._id\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n * @returns The created Category.\n */\n function createCategory(category: Category, options: CreateCategoryOptions): Promise;\n interface CreateCategoryOptions {\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves a category with the provided ID.\n * @param categoryId - Id of the Category to retrieve.\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n * @returns The retrieved Category.\n */\n function getCategory(categoryId: string, treeReference: TreeReference, options?: GetCategoryOptions): Promise;\n interface GetCategoryOptions {\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\n }\n /**\n * Update a Category, supports partial update.\n * Pass the latest `revision` for a successful update.\n * Each time the category is updated, `revision` increments by 1.\n * @param _id - Category ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField category\n * @requiredField category.revision\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n * @returns The updated Category.\n */\n function updateCategory(_id: string | null, category: UpdateCategory, options: UpdateCategoryOptions): Promise;\n interface UpdateCategory {\n /** Category ID. */\n _id?: string | null;\n /**\n * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this Category was created.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Represents the time this Category was last updated.\n * @readonly\n */\n _updatedDate?: Date;\n /** Category name. */\n name?: string | null;\n /**\n * Category image.\n * Pass existing media ID for image previously saved in Wix media manager.\n * Pass full image URL to upload an image to Wix media manager.\n * In case of full url the image will be updated eventually.\n */\n image?: string;\n /**\n * Number of items in this category alone.\n * @readonly\n */\n numberOfItems?: number;\n /**\n * Number of items including all items in subcategories.\n * @internal\n * @readonly\n */\n totalNumberOfItems?: number;\n /** Category description. */\n description?: string | null;\n /**\n * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).\n * Even if visible is `false`, it can still be added manually to static page.\n * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.\n * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.\n */\n visible?: boolean | null;\n /**\n * A category's breadcrumbs, Updated on moved to different parent or on renamed.\n * This field will only be returned if request.fields contains `BREADCRUMBS`\n * @readonly\n */\n breadcrumbs?: BreadcrumbItemValues;\n /** The parent category. */\n parentCategory?: ParentCategory;\n /**\n * A permanent, friendly URL name.\n * If not provided, on create generated automatically.\n * When provided, validated and must be unique.\n */\n slug?: string | null;\n /**\n * Custom SEO data for the category.\n * @internal\n */\n seoData?: SeoSchema;\n /**\n * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.\n * In order to use this field you have to integrate with \"Ricos\" on frontend side. To learn how to do it visit https://ricos.js.org/.\n */\n richContentDescription?: RichContent;\n /**\n * Data related to the tree that contains the category.\n * @internal\n * @readonly\n */\n treeReference?: TreeReference;\n /** Extensions enabling users to save custom data related to the category. */\n extendedFields?: ExtendedFields;\n }\n interface UpdateCategoryOptions {\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[];\n }\n /**\n * Deletes a Category.\n * @param categoryId - Id of the Category to delete.\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n */\n function deleteCategory(categoryId: string, treeReference: TreeReference): Promise;\n /**\n * Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @internal\n * @documentationMaturity preview\n */\n function queryCategories(options: QueryCategoriesOptions): CategoriesQueryBuilder;\n interface QueryCategoriesOptions {\n /**\n * A reference to the tree that contains this category.\n * Used only in the first request. Following requests use the cursor token.\n */\n treeReference: TreeReference;\n /**\n * Whether hidden categories should be included in the response. Default is `false`.\n * Used only in the first request. Following requests use the cursor token.\n */\n includeHidden?: boolean | undefined;\n /** Fields to return in the response. When not provided, these fields are not returned. */\n fields?: RequestedFields[] | undefined;\n }\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface CategoriesQueryResult extends QueryCursorResult {\n items: Category[];\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: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', 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: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', 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: '_createdDate' | '_updatedDate', 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: '_createdDate' | '_updatedDate', 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: '_id' | 'name' | 'description' | 'slug', 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: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any[]) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: boolean) => 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: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => 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: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => 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 cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => CategoriesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Places category in parent category.\n * This operation updates `parentCategory` (`id` and `index`) for category with `categoryId` in tree with `treeId`.\n * This endpoint can be used to move category to different parent in the same tree or to change it's position in current parent.\n * @param categoryId - ID of category to place.\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField options\n * @requiredField options.position\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n */\n function placeCategoryInParentCategory(categoryId: string, treeReference: TreeReference, options: PlaceCategoryInParentCategoryOptions): Promise;\n interface PlaceCategoryInParentCategoryOptions {\n /**\n * ID of parent category.\n * Optional. When not passed it will fallback to the root category\n */\n parentCategoryId?: string | null;\n /**\n * Where to place the subcategory.\n * `FIRST` - make category with `category_id` first subcategory with manual arrangement.\n * `LAST` - make category with `category_id` last subcategory with manual arrangement.\n * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.\n */\n position: PlaceCategoryInParentCategoryRequestPosition;\n /** Required when `position` is `BEFORE`. Otherwise ignored */\n moveBeforeCategoryId?: string | null;\n }\n /**\n * Creates multiple categories.\n * Phase 2\n * @param categories - List of categories to be created.\n * @internal\n * @documentationMaturity preview\n * @requiredField categories\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function bulkCreateCategories(categories: Category[], options: BulkCreateCategoriesOptions): Promise;\n interface BulkCreateCategoriesOptions {\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n /** Whether to return the category entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * Update multiple Categories, supports partial update.\n * Pass the latest `revision` for a successful update.\n * To update visibility, call the BulkUpdateCategoryVisibility endpoint.\n * @param categories - List of categories to be updated.\n * @internal\n * @documentationMaturity preview\n * @requiredField categories\n * @requiredField categories.category\n * @requiredField categories.category._id\n * @requiredField categories.category.revision\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function bulkUpdateCategories(categories: MaskedCategory[], options: BulkUpdateCategoriesOptions): Promise;\n interface BulkUpdateCategoriesOptions {\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n /** Whether to return the category entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * Update `visible` field. If visible is set to false, all subcategories will be set to `visible=false`\n * @param categoryId - ID of category to be updated\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField options\n * @requiredField options.revision\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n * @requiredField options.visible\n */\n function updateCategoryVisibility(categoryId: string, options: UpdateCategoryVisibilityOptions): Promise;\n interface UpdateCategoryVisibilityOptions {\n /** value to set `visible` to */\n visible: boolean;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Latest revision of the category. */\n revision: string | null;\n }\n /**\n * Update `visible` field for multiple categories. If visible is set to false, all subcategories will be set to `visible=false`\n * Phase 2\n * @param categoryIds - IDs of categories to be updated.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryIds\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n * @requiredField options.visible\n */\n function bulkSetVisibility(categoryIds: string[], options: BulkSetVisibilityOptions): Promise;\n interface BulkSetVisibilityOptions {\n /** value to set `visible` to. This value will be set for all categories in the request */\n visible: boolean;\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n /** Whether to return the category entity in the response. */\n returnEntity?: boolean;\n }\n /**\n * Update `visible` field for categories which satisfy the provided filter. If visible is set to false, all subcategories will be set to `visible=false` as well\n * Phase 2\n * @param filter - 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 * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n * @requiredField options.visible\n */\n function bulkSetVisibilityByFilter(filter: Record | null, options: BulkSetVisibilityByFilterOptions): Promise;\n interface BulkSetVisibilityByFilterOptions {\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n /** value to set `visible` to. This value will be set for all categories that match the filter */\n visible: boolean;\n }\n /**\n * Deletes multiple categories.\n * Phase 2\n * @param categoryIds - IDs of categories to be deleted.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryIds\n */\n function bulkDeleteCategories(categoryIds: string[]): Promise;\n /**\n * Delete multiple categories which satisfy the provided filter.\n * Phase 2\n * @param filter - 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 * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function bulkDeleteCategoriesByFilter(filter: Record | null, options: BulkDeleteCategoriesByFilterOptions): Promise;\n interface BulkDeleteCategoriesByFilterOptions {\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n /**\n * Adds multiple items to single category, fires as many domain events as many items successfully added.\n * @param categoryId - Category id.\n * @param items - List of catalog items with reference info.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField items\n * @requiredField items.appId\n * @requiredField items.catalogItemId\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function addItemsToCategory(categoryId: string, items: ItemReference[], options: AddItemsToCategoryOptions): Promise;\n interface AddItemsToCategoryOptions {\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n }\n /**\n * Adds single item to multiple categories, fires as many domain events as many categories were successfully added.\n * @param itemReference - Catalog item reference info\n * @internal\n * @documentationMaturity preview\n * @requiredField itemReference\n * @requiredField itemReference.appId\n * @requiredField itemReference.catalogItemId\n * @requiredField options\n * @requiredField options.categoryIds\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function addItemToCategories(itemReference: ItemReference, options: AddItemToCategoriesOptions): Promise;\n interface AddItemToCategoriesOptions {\n /** Category ids. */\n categoryIds: string[];\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n /**\n * Removed multiple items from single category, fires as many domain events as many items successfully removed.\n * @param categoryId - Category id\n * @param items - List of catalog items with reference info.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField items\n * @requiredField items.appId\n * @requiredField items.catalogItemId\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function removeItemsFromCategory(categoryId: string, items: ItemReference[], options: RemoveItemsFromCategoryOptions): Promise;\n interface RemoveItemsFromCategoryOptions {\n /** A reference to the tree that contains this category. */\n treeReference: TreeReference;\n }\n /**\n * Removes single item from multiple categories, fires as many domain events as many categories were successfully removed.\n * @param itemReference - Catalog item reference info\n * @internal\n * @documentationMaturity preview\n * @requiredField itemReference\n * @requiredField itemReference.appId\n * @requiredField itemReference.catalogItemId\n * @requiredField options\n * @requiredField options.categoryIds\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function removeItemFromCategories(itemReference: ItemReference, options: RemoveItemFromCategoriesOptions): Promise;\n interface RemoveItemFromCategoriesOptions {\n /** Category ids. */\n categoryIds: string[];\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n /**\n * Returns up to 100 items related to requested `category_id` sorted by time when item added to category, descending.\n * When items added to category in bulk they considered as added at exactly same time so order will be random but always the same.\n * @param categoryId - ID of category containing items.\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n */\n function listItemsInCategory(categoryId: string, treeReference: TreeReference, options?: ListItemsInCategoryOptions): Promise;\n interface ListItemsInCategoryOptions {\n /** Default: `false`. When `true` items arranged by user will be return before all other items. */\n useCategoryArrangement?: boolean;\n /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */\n includeItemsFromSubcategories?: boolean;\n /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */\n paging?: CursorPaging;\n }\n /**\n * Returns all category IDs that contain the item and their parent category IDs.\n * @param itemReference - Catalog item reference info.\n * @internal\n * @documentationMaturity preview\n * @requiredField itemReference\n * @requiredField options\n * @requiredField options.treeReference\n * @requiredField options.treeReference.appNamespace\n */\n function listCategoriesForItem(itemReference: ItemReference, options: ListCategoriesForItemOptions): Promise;\n interface ListCategoriesForItemOptions {\n /** A reference to the tree that contains the categories. */\n treeReference: TreeReference;\n }\n /**\n * Changes position of `item` in category. Will be used when sort items by manual arrangement\n * @param categoryId - ID of category.\n * Item must be direct child of this category, otherwise error returned\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField options\n * @requiredField options.item\n * @requiredField options.position\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n */\n function moveItemInCategory(categoryId: string, treeReference: TreeReference, options: MoveItemInCategoryOptions): Promise;\n interface MoveItemInCategoryOptions {\n /** Item to move. */\n item: ItemReference;\n /**\n * Where to move item.\n * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.\n * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.\n * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.\n * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.\n */\n position: Position;\n /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */\n beforeItem?: ItemReference;\n }\n /**\n * Set arranged items in category. Will be used when sort items by manual arrangement.\n * Calling this endpoint overrides existing list of arranged items in category.\n * @param categoryId - ID of category.\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n */\n function setArrangedItems(categoryId: string, treeReference: TreeReference, options?: SetArrangedItemsOptions): Promise;\n interface SetArrangedItemsOptions {\n /**\n * List of arranged items to set.\n * All items must be direct children of category with `category_id`, otherwise error returned.\n */\n items?: ItemReference[];\n }\n /**\n * Returns arranged items in category\n * @param categoryId - ID of category.\n * @param treeReference - A reference to the tree that contains this category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @requiredField treeReference\n * @requiredField treeReference.appNamespace\n */\n function getArrangedItems(categoryId: string, treeReference: TreeReference): Promise;\n /**\n * Retrieves the whole categories tree\n * @internal\n * @documentationMaturity preview\n */\n function getCategoriesTree(options?: GetCategoriesTreeOptions): Promise;\n interface GetCategoriesTreeOptions {\n /** The ID of the tree. */\n treeId?: string;\n }\n \n const categoriesV1Category_universal_d___debug: typeof __debug;\n type categoriesV1Category_universal_d_Category = Category;\n type categoriesV1Category_universal_d_BreadcrumbItemValues = BreadcrumbItemValues;\n type categoriesV1Category_universal_d_BreadcrumbItem = BreadcrumbItem;\n type categoriesV1Category_universal_d_ParentCategory = ParentCategory;\n type categoriesV1Category_universal_d_SeoSchema = SeoSchema;\n type categoriesV1Category_universal_d_Keyword = Keyword;\n type categoriesV1Category_universal_d_Tag = Tag;\n type categoriesV1Category_universal_d_Settings = Settings;\n type categoriesV1Category_universal_d_RichContent = RichContent;\n type categoriesV1Category_universal_d_Node = Node;\n type categoriesV1Category_universal_d_NodeDataOneOf = NodeDataOneOf;\n type categoriesV1Category_universal_d_NodeType = NodeType;\n const categoriesV1Category_universal_d_NodeType: typeof NodeType;\n type categoriesV1Category_universal_d_NodeStyle = NodeStyle;\n type categoriesV1Category_universal_d_ButtonData = ButtonData;\n type categoriesV1Category_universal_d_Border = Border;\n type categoriesV1Category_universal_d_Colors = Colors;\n type categoriesV1Category_universal_d_PluginContainerData = PluginContainerData;\n type categoriesV1Category_universal_d_WidthType = WidthType;\n const categoriesV1Category_universal_d_WidthType: typeof WidthType;\n type categoriesV1Category_universal_d_PluginContainerDataWidth = PluginContainerDataWidth;\n type categoriesV1Category_universal_d_PluginContainerDataWidthDataOneOf = PluginContainerDataWidthDataOneOf;\n type categoriesV1Category_universal_d_PluginContainerDataAlignment = PluginContainerDataAlignment;\n const categoriesV1Category_universal_d_PluginContainerDataAlignment: typeof PluginContainerDataAlignment;\n type categoriesV1Category_universal_d_Spoiler = Spoiler;\n type categoriesV1Category_universal_d_Height = Height;\n type categoriesV1Category_universal_d_Type = Type;\n const categoriesV1Category_universal_d_Type: typeof Type;\n type categoriesV1Category_universal_d_Styles = Styles;\n type categoriesV1Category_universal_d_Link = Link;\n type categoriesV1Category_universal_d_LinkDataOneOf = LinkDataOneOf;\n type categoriesV1Category_universal_d_Target = Target;\n const categoriesV1Category_universal_d_Target: typeof Target;\n type categoriesV1Category_universal_d_Rel = Rel;\n type categoriesV1Category_universal_d_CodeBlockData = CodeBlockData;\n type categoriesV1Category_universal_d_TextStyle = TextStyle;\n type categoriesV1Category_universal_d_TextAlignment = TextAlignment;\n const categoriesV1Category_universal_d_TextAlignment: typeof TextAlignment;\n type categoriesV1Category_universal_d_DividerData = DividerData;\n type categoriesV1Category_universal_d_LineStyle = LineStyle;\n const categoriesV1Category_universal_d_LineStyle: typeof LineStyle;\n type categoriesV1Category_universal_d_Width = Width;\n const categoriesV1Category_universal_d_Width: typeof Width;\n type categoriesV1Category_universal_d_Alignment = Alignment;\n const categoriesV1Category_universal_d_Alignment: typeof Alignment;\n type categoriesV1Category_universal_d_FileData = FileData;\n type categoriesV1Category_universal_d_ViewMode = ViewMode;\n const categoriesV1Category_universal_d_ViewMode: typeof ViewMode;\n type categoriesV1Category_universal_d_FileSource = FileSource;\n type categoriesV1Category_universal_d_FileSourceDataOneOf = FileSourceDataOneOf;\n type categoriesV1Category_universal_d_PDFSettings = PDFSettings;\n type categoriesV1Category_universal_d_GalleryData = GalleryData;\n type categoriesV1Category_universal_d_Media = Media;\n type categoriesV1Category_universal_d_Image = Image;\n type categoriesV1Category_universal_d_Video = Video;\n type categoriesV1Category_universal_d_Item = Item;\n type categoriesV1Category_universal_d_ItemDataOneOf = ItemDataOneOf;\n type categoriesV1Category_universal_d_GalleryOptions = GalleryOptions;\n type categoriesV1Category_universal_d_LayoutType = LayoutType;\n const categoriesV1Category_universal_d_LayoutType: typeof LayoutType;\n type categoriesV1Category_universal_d_Orientation = Orientation;\n const categoriesV1Category_universal_d_Orientation: typeof Orientation;\n type categoriesV1Category_universal_d_Crop = Crop;\n const categoriesV1Category_universal_d_Crop: typeof Crop;\n type categoriesV1Category_universal_d_ThumbnailsAlignment = ThumbnailsAlignment;\n const categoriesV1Category_universal_d_ThumbnailsAlignment: typeof ThumbnailsAlignment;\n type categoriesV1Category_universal_d_Layout = Layout;\n type categoriesV1Category_universal_d_ItemStyle = ItemStyle;\n type categoriesV1Category_universal_d_Thumbnails = Thumbnails;\n type categoriesV1Category_universal_d_GIFData = GIFData;\n type categoriesV1Category_universal_d_GIF = GIF;\n type categoriesV1Category_universal_d_HeadingData = HeadingData;\n type categoriesV1Category_universal_d_HTMLData = HTMLData;\n type categoriesV1Category_universal_d_HTMLDataDataOneOf = HTMLDataDataOneOf;\n type categoriesV1Category_universal_d_Source = Source;\n const categoriesV1Category_universal_d_Source: typeof Source;\n type categoriesV1Category_universal_d_ImageData = ImageData;\n type categoriesV1Category_universal_d_LinkPreviewData = LinkPreviewData;\n type categoriesV1Category_universal_d_MapData = MapData;\n type categoriesV1Category_universal_d_MapSettings = MapSettings;\n type categoriesV1Category_universal_d_MapType = MapType;\n const categoriesV1Category_universal_d_MapType: typeof MapType;\n type categoriesV1Category_universal_d_ParagraphData = ParagraphData;\n type categoriesV1Category_universal_d_PollData = PollData;\n type categoriesV1Category_universal_d_ViewRole = ViewRole;\n const categoriesV1Category_universal_d_ViewRole: typeof ViewRole;\n type categoriesV1Category_universal_d_VoteRole = VoteRole;\n const categoriesV1Category_universal_d_VoteRole: typeof VoteRole;\n type categoriesV1Category_universal_d_Permissions = Permissions;\n type categoriesV1Category_universal_d_Option = Option;\n type categoriesV1Category_universal_d_PollSettings = PollSettings;\n type categoriesV1Category_universal_d_PollLayoutType = PollLayoutType;\n const categoriesV1Category_universal_d_PollLayoutType: typeof PollLayoutType;\n type categoriesV1Category_universal_d_PollLayoutDirection = PollLayoutDirection;\n const categoriesV1Category_universal_d_PollLayoutDirection: typeof PollLayoutDirection;\n type categoriesV1Category_universal_d_PollLayout = PollLayout;\n type categoriesV1Category_universal_d_OptionLayout = OptionLayout;\n type categoriesV1Category_universal_d_BackgroundType = BackgroundType;\n const categoriesV1Category_universal_d_BackgroundType: typeof BackgroundType;\n type categoriesV1Category_universal_d_Gradient = Gradient;\n type categoriesV1Category_universal_d_Background = Background;\n type categoriesV1Category_universal_d_BackgroundBackgroundOneOf = BackgroundBackgroundOneOf;\n type categoriesV1Category_universal_d_PollDesign = PollDesign;\n type categoriesV1Category_universal_d_OptionDesign = OptionDesign;\n type categoriesV1Category_universal_d_Poll = Poll;\n type categoriesV1Category_universal_d_PollDataLayout = PollDataLayout;\n type categoriesV1Category_universal_d_Design = Design;\n type categoriesV1Category_universal_d_TextData = TextData;\n type categoriesV1Category_universal_d_Decoration = Decoration;\n type categoriesV1Category_universal_d_DecorationDataOneOf = DecorationDataOneOf;\n type categoriesV1Category_universal_d_DecorationType = DecorationType;\n const categoriesV1Category_universal_d_DecorationType: typeof DecorationType;\n type categoriesV1Category_universal_d_AnchorData = AnchorData;\n type categoriesV1Category_universal_d_ColorData = ColorData;\n type categoriesV1Category_universal_d_LinkData = LinkData;\n type categoriesV1Category_universal_d_MentionData = MentionData;\n type categoriesV1Category_universal_d_FontSizeData = FontSizeData;\n type categoriesV1Category_universal_d_FontType = FontType;\n const categoriesV1Category_universal_d_FontType: typeof FontType;\n type categoriesV1Category_universal_d_AppEmbedData = AppEmbedData;\n type categoriesV1Category_universal_d_AppEmbedDataAppDataOneOf = AppEmbedDataAppDataOneOf;\n type categoriesV1Category_universal_d_AppType = AppType;\n const categoriesV1Category_universal_d_AppType: typeof AppType;\n type categoriesV1Category_universal_d_BookingData = BookingData;\n type categoriesV1Category_universal_d_EventData = EventData;\n type categoriesV1Category_universal_d_VideoData = VideoData;\n type categoriesV1Category_universal_d_PlaybackOptions = PlaybackOptions;\n type categoriesV1Category_universal_d_EmbedData = EmbedData;\n type categoriesV1Category_universal_d_Oembed = Oembed;\n type categoriesV1Category_universal_d_CollapsibleListData = CollapsibleListData;\n type categoriesV1Category_universal_d_InitialExpandedItems = InitialExpandedItems;\n const categoriesV1Category_universal_d_InitialExpandedItems: typeof InitialExpandedItems;\n type categoriesV1Category_universal_d_Direction = Direction;\n const categoriesV1Category_universal_d_Direction: typeof Direction;\n type categoriesV1Category_universal_d_TableData = TableData;\n type categoriesV1Category_universal_d_Dimensions = Dimensions;\n type categoriesV1Category_universal_d_TableCellData = TableCellData;\n type categoriesV1Category_universal_d_VerticalAlignment = VerticalAlignment;\n const categoriesV1Category_universal_d_VerticalAlignment: typeof VerticalAlignment;\n type categoriesV1Category_universal_d_CellStyle = CellStyle;\n type categoriesV1Category_universal_d_BorderColors = BorderColors;\n type categoriesV1Category_universal_d_NullValue = NullValue;\n const categoriesV1Category_universal_d_NullValue: typeof NullValue;\n type categoriesV1Category_universal_d_ListValue = ListValue;\n type categoriesV1Category_universal_d_AudioData = AudioData;\n type categoriesV1Category_universal_d_OrderedListData = OrderedListData;\n type categoriesV1Category_universal_d_BulletedListData = BulletedListData;\n type categoriesV1Category_universal_d_BlockquoteData = BlockquoteData;\n type categoriesV1Category_universal_d_Metadata = Metadata;\n type categoriesV1Category_universal_d_DocumentStyle = DocumentStyle;\n type categoriesV1Category_universal_d_TextNodeStyle = TextNodeStyle;\n type categoriesV1Category_universal_d_TreeReference = TreeReference;\n type categoriesV1Category_universal_d_ExtendedFields = ExtendedFields;\n type categoriesV1Category_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type categoriesV1Category_universal_d_RequestedFields = RequestedFields;\n const categoriesV1Category_universal_d_RequestedFields: typeof RequestedFields;\n type categoriesV1Category_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type categoriesV1Category_universal_d_GetCategoryRequest = GetCategoryRequest;\n type categoriesV1Category_universal_d_GetCategoryResponse = GetCategoryResponse;\n type categoriesV1Category_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type categoriesV1Category_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type categoriesV1Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type categoriesV1Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type categoriesV1Category_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type categoriesV1Category_universal_d_CursorQuery = CursorQuery;\n type categoriesV1Category_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type categoriesV1Category_universal_d_Sorting = Sorting;\n type categoriesV1Category_universal_d_SortOrder = SortOrder;\n const categoriesV1Category_universal_d_SortOrder: typeof SortOrder;\n type categoriesV1Category_universal_d_CursorPaging = CursorPaging;\n type categoriesV1Category_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type categoriesV1Category_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type categoriesV1Category_universal_d_Cursors = Cursors;\n type categoriesV1Category_universal_d_PlaceCategoryInParentCategoryRequest = PlaceCategoryInParentCategoryRequest;\n type categoriesV1Category_universal_d_PlaceCategoryInParentCategoryRequestPosition = PlaceCategoryInParentCategoryRequestPosition;\n const categoriesV1Category_universal_d_PlaceCategoryInParentCategoryRequestPosition: typeof PlaceCategoryInParentCategoryRequestPosition;\n type categoriesV1Category_universal_d_PlaceCategoryInParentCategoryResponse = PlaceCategoryInParentCategoryResponse;\n type categoriesV1Category_universal_d_BulkCreateCategoriesRequest = BulkCreateCategoriesRequest;\n type categoriesV1Category_universal_d_BulkCreateCategoriesResponse = BulkCreateCategoriesResponse;\n type categoriesV1Category_universal_d_BulkCategoriesResult = BulkCategoriesResult;\n type categoriesV1Category_universal_d_ItemMetadata = ItemMetadata;\n type categoriesV1Category_universal_d_ApplicationError = ApplicationError;\n type categoriesV1Category_universal_d_BulkActionMetadata = BulkActionMetadata;\n type categoriesV1Category_universal_d_BulkUpdateCategoriesRequest = BulkUpdateCategoriesRequest;\n type categoriesV1Category_universal_d_MaskedCategory = MaskedCategory;\n type categoriesV1Category_universal_d_BulkUpdateCategoriesResponse = BulkUpdateCategoriesResponse;\n type categoriesV1Category_universal_d_UpdateCategoryVisibilityRequest = UpdateCategoryVisibilityRequest;\n type categoriesV1Category_universal_d_UpdateCategoryVisibilityResponse = UpdateCategoryVisibilityResponse;\n type categoriesV1Category_universal_d_BulkSetVisibilityRequest = BulkSetVisibilityRequest;\n type categoriesV1Category_universal_d_BulkSetVisibilityResponse = BulkSetVisibilityResponse;\n type categoriesV1Category_universal_d_BulkSetVisibilityByFilterRequest = BulkSetVisibilityByFilterRequest;\n type categoriesV1Category_universal_d_BulkSetVisibilityByFilterResponse = BulkSetVisibilityByFilterResponse;\n type categoriesV1Category_universal_d_BulkDeleteCategoriesRequest = BulkDeleteCategoriesRequest;\n type categoriesV1Category_universal_d_BulkDeleteCategoriesResponse = BulkDeleteCategoriesResponse;\n type categoriesV1Category_universal_d_BulkDeleteCategoriesByFilterRequest = BulkDeleteCategoriesByFilterRequest;\n type categoriesV1Category_universal_d_BulkDeleteCategoriesByFilterResponse = BulkDeleteCategoriesByFilterResponse;\n type categoriesV1Category_universal_d_AddItemsToCategoryRequest = AddItemsToCategoryRequest;\n type categoriesV1Category_universal_d_ItemReference = ItemReference;\n type categoriesV1Category_universal_d_AddItemsToCategoryResponse = AddItemsToCategoryResponse;\n type categoriesV1Category_universal_d_BulkItemsToCategoryResult = BulkItemsToCategoryResult;\n type categoriesV1Category_universal_d_ItemReferenceMetadata = ItemReferenceMetadata;\n type categoriesV1Category_universal_d_ItemAddedToCategory = ItemAddedToCategory;\n type categoriesV1Category_universal_d_ItemsAddedToCategory = ItemsAddedToCategory;\n type categoriesV1Category_universal_d_AddItemToCategoriesRequest = AddItemToCategoriesRequest;\n type categoriesV1Category_universal_d_AddItemToCategoriesResponse = AddItemToCategoriesResponse;\n type categoriesV1Category_universal_d_BulkItemToCategoriesResult = BulkItemToCategoriesResult;\n type categoriesV1Category_universal_d_RemoveItemsFromCategoryRequest = RemoveItemsFromCategoryRequest;\n type categoriesV1Category_universal_d_RemoveItemsFromCategoryResponse = RemoveItemsFromCategoryResponse;\n type categoriesV1Category_universal_d_ItemRemovedFromCategory = ItemRemovedFromCategory;\n type categoriesV1Category_universal_d_ItemsRemovedFromCategory = ItemsRemovedFromCategory;\n type categoriesV1Category_universal_d_RemoveItemFromCategoriesRequest = RemoveItemFromCategoriesRequest;\n type categoriesV1Category_universal_d_RemoveItemFromCategoriesResponse = RemoveItemFromCategoriesResponse;\n type categoriesV1Category_universal_d_ListItemsInCategoryRequest = ListItemsInCategoryRequest;\n type categoriesV1Category_universal_d_ListItemsInCategoryResponse = ListItemsInCategoryResponse;\n type categoriesV1Category_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type categoriesV1Category_universal_d_ListCategoriesForItemRequest = ListCategoriesForItemRequest;\n type categoriesV1Category_universal_d_ListCategoriesForItemResponse = ListCategoriesForItemResponse;\n type categoriesV1Category_universal_d_MoveItemInCategoryRequest = MoveItemInCategoryRequest;\n type categoriesV1Category_universal_d_Position = Position;\n const categoriesV1Category_universal_d_Position: typeof Position;\n type categoriesV1Category_universal_d_MoveItemInCategoryResponse = MoveItemInCategoryResponse;\n type categoriesV1Category_universal_d_SetArrangedItemsRequest = SetArrangedItemsRequest;\n type categoriesV1Category_universal_d_SetArrangedItemsResponse = SetArrangedItemsResponse;\n type categoriesV1Category_universal_d_GetArrangedItemsRequest = GetArrangedItemsRequest;\n type categoriesV1Category_universal_d_GetArrangedItemsResponse = GetArrangedItemsResponse;\n type categoriesV1Category_universal_d_GetCategoriesTreeRequest = GetCategoriesTreeRequest;\n type categoriesV1Category_universal_d_GetCategoriesTreeResponse = GetCategoriesTreeResponse;\n type categoriesV1Category_universal_d_CategoryTreeNode = CategoryTreeNode;\n type categoriesV1Category_universal_d_DomainEvent = DomainEvent;\n type categoriesV1Category_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type categoriesV1Category_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type categoriesV1Category_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type categoriesV1Category_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type categoriesV1Category_universal_d_ActionEvent = ActionEvent;\n type categoriesV1Category_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type categoriesV1Category_universal_d_Empty = Empty;\n const categoriesV1Category_universal_d_createCategory: typeof createCategory;\n type categoriesV1Category_universal_d_CreateCategoryOptions = CreateCategoryOptions;\n const categoriesV1Category_universal_d_getCategory: typeof getCategory;\n type categoriesV1Category_universal_d_GetCategoryOptions = GetCategoryOptions;\n const categoriesV1Category_universal_d_updateCategory: typeof updateCategory;\n type categoriesV1Category_universal_d_UpdateCategory = UpdateCategory;\n type categoriesV1Category_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const categoriesV1Category_universal_d_deleteCategory: typeof deleteCategory;\n const categoriesV1Category_universal_d_queryCategories: typeof queryCategories;\n type categoriesV1Category_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n type categoriesV1Category_universal_d_CategoriesQueryResult = CategoriesQueryResult;\n type categoriesV1Category_universal_d_CategoriesQueryBuilder = CategoriesQueryBuilder;\n const categoriesV1Category_universal_d_placeCategoryInParentCategory: typeof placeCategoryInParentCategory;\n type categoriesV1Category_universal_d_PlaceCategoryInParentCategoryOptions = PlaceCategoryInParentCategoryOptions;\n const categoriesV1Category_universal_d_bulkCreateCategories: typeof bulkCreateCategories;\n type categoriesV1Category_universal_d_BulkCreateCategoriesOptions = BulkCreateCategoriesOptions;\n const categoriesV1Category_universal_d_bulkUpdateCategories: typeof bulkUpdateCategories;\n type categoriesV1Category_universal_d_BulkUpdateCategoriesOptions = BulkUpdateCategoriesOptions;\n const categoriesV1Category_universal_d_updateCategoryVisibility: typeof updateCategoryVisibility;\n type categoriesV1Category_universal_d_UpdateCategoryVisibilityOptions = UpdateCategoryVisibilityOptions;\n const categoriesV1Category_universal_d_bulkSetVisibility: typeof bulkSetVisibility;\n type categoriesV1Category_universal_d_BulkSetVisibilityOptions = BulkSetVisibilityOptions;\n const categoriesV1Category_universal_d_bulkSetVisibilityByFilter: typeof bulkSetVisibilityByFilter;\n type categoriesV1Category_universal_d_BulkSetVisibilityByFilterOptions = BulkSetVisibilityByFilterOptions;\n const categoriesV1Category_universal_d_bulkDeleteCategories: typeof bulkDeleteCategories;\n const categoriesV1Category_universal_d_bulkDeleteCategoriesByFilter: typeof bulkDeleteCategoriesByFilter;\n type categoriesV1Category_universal_d_BulkDeleteCategoriesByFilterOptions = BulkDeleteCategoriesByFilterOptions;\n const categoriesV1Category_universal_d_addItemsToCategory: typeof addItemsToCategory;\n type categoriesV1Category_universal_d_AddItemsToCategoryOptions = AddItemsToCategoryOptions;\n const categoriesV1Category_universal_d_addItemToCategories: typeof addItemToCategories;\n type categoriesV1Category_universal_d_AddItemToCategoriesOptions = AddItemToCategoriesOptions;\n const categoriesV1Category_universal_d_removeItemsFromCategory: typeof removeItemsFromCategory;\n type categoriesV1Category_universal_d_RemoveItemsFromCategoryOptions = RemoveItemsFromCategoryOptions;\n const categoriesV1Category_universal_d_removeItemFromCategories: typeof removeItemFromCategories;\n type categoriesV1Category_universal_d_RemoveItemFromCategoriesOptions = RemoveItemFromCategoriesOptions;\n const categoriesV1Category_universal_d_listItemsInCategory: typeof listItemsInCategory;\n type categoriesV1Category_universal_d_ListItemsInCategoryOptions = ListItemsInCategoryOptions;\n const categoriesV1Category_universal_d_listCategoriesForItem: typeof listCategoriesForItem;\n type categoriesV1Category_universal_d_ListCategoriesForItemOptions = ListCategoriesForItemOptions;\n const categoriesV1Category_universal_d_moveItemInCategory: typeof moveItemInCategory;\n type categoriesV1Category_universal_d_MoveItemInCategoryOptions = MoveItemInCategoryOptions;\n const categoriesV1Category_universal_d_setArrangedItems: typeof setArrangedItems;\n type categoriesV1Category_universal_d_SetArrangedItemsOptions = SetArrangedItemsOptions;\n const categoriesV1Category_universal_d_getArrangedItems: typeof getArrangedItems;\n const categoriesV1Category_universal_d_getCategoriesTree: typeof getCategoriesTree;\n type categoriesV1Category_universal_d_GetCategoriesTreeOptions = GetCategoriesTreeOptions;\n namespace categoriesV1Category_universal_d {\n export {\n categoriesV1Category_universal_d___debug as __debug,\n categoriesV1Category_universal_d_Category as Category,\n categoriesV1Category_universal_d_BreadcrumbItemValues as BreadcrumbItemValues,\n categoriesV1Category_universal_d_BreadcrumbItem as BreadcrumbItem,\n categoriesV1Category_universal_d_ParentCategory as ParentCategory,\n categoriesV1Category_universal_d_SeoSchema as SeoSchema,\n categoriesV1Category_universal_d_Keyword as Keyword,\n categoriesV1Category_universal_d_Tag as Tag,\n categoriesV1Category_universal_d_Settings as Settings,\n categoriesV1Category_universal_d_RichContent as RichContent,\n categoriesV1Category_universal_d_Node as Node,\n categoriesV1Category_universal_d_NodeDataOneOf as NodeDataOneOf,\n categoriesV1Category_universal_d_NodeType as NodeType,\n categoriesV1Category_universal_d_NodeStyle as NodeStyle,\n categoriesV1Category_universal_d_ButtonData as ButtonData,\n categoriesV1Category_universal_d_Border as Border,\n categoriesV1Category_universal_d_Colors as Colors,\n categoriesV1Category_universal_d_PluginContainerData as PluginContainerData,\n categoriesV1Category_universal_d_WidthType as WidthType,\n categoriesV1Category_universal_d_PluginContainerDataWidth as PluginContainerDataWidth,\n categoriesV1Category_universal_d_PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOf,\n categoriesV1Category_universal_d_PluginContainerDataAlignment as PluginContainerDataAlignment,\n categoriesV1Category_universal_d_Spoiler as Spoiler,\n categoriesV1Category_universal_d_Height as Height,\n categoriesV1Category_universal_d_Type as Type,\n categoriesV1Category_universal_d_Styles as Styles,\n categoriesV1Category_universal_d_Link as Link,\n categoriesV1Category_universal_d_LinkDataOneOf as LinkDataOneOf,\n categoriesV1Category_universal_d_Target as Target,\n categoriesV1Category_universal_d_Rel as Rel,\n categoriesV1Category_universal_d_CodeBlockData as CodeBlockData,\n categoriesV1Category_universal_d_TextStyle as TextStyle,\n categoriesV1Category_universal_d_TextAlignment as TextAlignment,\n categoriesV1Category_universal_d_DividerData as DividerData,\n categoriesV1Category_universal_d_LineStyle as LineStyle,\n categoriesV1Category_universal_d_Width as Width,\n categoriesV1Category_universal_d_Alignment as Alignment,\n categoriesV1Category_universal_d_FileData as FileData,\n categoriesV1Category_universal_d_ViewMode as ViewMode,\n categoriesV1Category_universal_d_FileSource as FileSource,\n categoriesV1Category_universal_d_FileSourceDataOneOf as FileSourceDataOneOf,\n categoriesV1Category_universal_d_PDFSettings as PDFSettings,\n categoriesV1Category_universal_d_GalleryData as GalleryData,\n categoriesV1Category_universal_d_Media as Media,\n categoriesV1Category_universal_d_Image as Image,\n categoriesV1Category_universal_d_Video as Video,\n categoriesV1Category_universal_d_Item as Item,\n categoriesV1Category_universal_d_ItemDataOneOf as ItemDataOneOf,\n categoriesV1Category_universal_d_GalleryOptions as GalleryOptions,\n categoriesV1Category_universal_d_LayoutType as LayoutType,\n categoriesV1Category_universal_d_Orientation as Orientation,\n categoriesV1Category_universal_d_Crop as Crop,\n categoriesV1Category_universal_d_ThumbnailsAlignment as ThumbnailsAlignment,\n categoriesV1Category_universal_d_Layout as Layout,\n categoriesV1Category_universal_d_ItemStyle as ItemStyle,\n categoriesV1Category_universal_d_Thumbnails as Thumbnails,\n categoriesV1Category_universal_d_GIFData as GIFData,\n categoriesV1Category_universal_d_GIF as GIF,\n categoriesV1Category_universal_d_HeadingData as HeadingData,\n categoriesV1Category_universal_d_HTMLData as HTMLData,\n categoriesV1Category_universal_d_HTMLDataDataOneOf as HTMLDataDataOneOf,\n categoriesV1Category_universal_d_Source as Source,\n categoriesV1Category_universal_d_ImageData as ImageData,\n categoriesV1Category_universal_d_LinkPreviewData as LinkPreviewData,\n categoriesV1Category_universal_d_MapData as MapData,\n categoriesV1Category_universal_d_MapSettings as MapSettings,\n categoriesV1Category_universal_d_MapType as MapType,\n categoriesV1Category_universal_d_ParagraphData as ParagraphData,\n categoriesV1Category_universal_d_PollData as PollData,\n categoriesV1Category_universal_d_ViewRole as ViewRole,\n categoriesV1Category_universal_d_VoteRole as VoteRole,\n categoriesV1Category_universal_d_Permissions as Permissions,\n categoriesV1Category_universal_d_Option as Option,\n categoriesV1Category_universal_d_PollSettings as PollSettings,\n categoriesV1Category_universal_d_PollLayoutType as PollLayoutType,\n categoriesV1Category_universal_d_PollLayoutDirection as PollLayoutDirection,\n categoriesV1Category_universal_d_PollLayout as PollLayout,\n categoriesV1Category_universal_d_OptionLayout as OptionLayout,\n categoriesV1Category_universal_d_BackgroundType as BackgroundType,\n categoriesV1Category_universal_d_Gradient as Gradient,\n categoriesV1Category_universal_d_Background as Background,\n categoriesV1Category_universal_d_BackgroundBackgroundOneOf as BackgroundBackgroundOneOf,\n categoriesV1Category_universal_d_PollDesign as PollDesign,\n categoriesV1Category_universal_d_OptionDesign as OptionDesign,\n categoriesV1Category_universal_d_Poll as Poll,\n categoriesV1Category_universal_d_PollDataLayout as PollDataLayout,\n categoriesV1Category_universal_d_Design as Design,\n categoriesV1Category_universal_d_TextData as TextData,\n categoriesV1Category_universal_d_Decoration as Decoration,\n categoriesV1Category_universal_d_DecorationDataOneOf as DecorationDataOneOf,\n categoriesV1Category_universal_d_DecorationType as DecorationType,\n categoriesV1Category_universal_d_AnchorData as AnchorData,\n categoriesV1Category_universal_d_ColorData as ColorData,\n categoriesV1Category_universal_d_LinkData as LinkData,\n categoriesV1Category_universal_d_MentionData as MentionData,\n categoriesV1Category_universal_d_FontSizeData as FontSizeData,\n categoriesV1Category_universal_d_FontType as FontType,\n categoriesV1Category_universal_d_AppEmbedData as AppEmbedData,\n categoriesV1Category_universal_d_AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOf,\n categoriesV1Category_universal_d_AppType as AppType,\n categoriesV1Category_universal_d_BookingData as BookingData,\n categoriesV1Category_universal_d_EventData as EventData,\n categoriesV1Category_universal_d_VideoData as VideoData,\n categoriesV1Category_universal_d_PlaybackOptions as PlaybackOptions,\n categoriesV1Category_universal_d_EmbedData as EmbedData,\n categoriesV1Category_universal_d_Oembed as Oembed,\n categoriesV1Category_universal_d_CollapsibleListData as CollapsibleListData,\n categoriesV1Category_universal_d_InitialExpandedItems as InitialExpandedItems,\n categoriesV1Category_universal_d_Direction as Direction,\n categoriesV1Category_universal_d_TableData as TableData,\n categoriesV1Category_universal_d_Dimensions as Dimensions,\n categoriesV1Category_universal_d_TableCellData as TableCellData,\n categoriesV1Category_universal_d_VerticalAlignment as VerticalAlignment,\n categoriesV1Category_universal_d_CellStyle as CellStyle,\n categoriesV1Category_universal_d_BorderColors as BorderColors,\n categoriesV1Category_universal_d_NullValue as NullValue,\n categoriesV1Category_universal_d_ListValue as ListValue,\n categoriesV1Category_universal_d_AudioData as AudioData,\n categoriesV1Category_universal_d_OrderedListData as OrderedListData,\n categoriesV1Category_universal_d_BulletedListData as BulletedListData,\n categoriesV1Category_universal_d_BlockquoteData as BlockquoteData,\n categoriesV1Category_universal_d_Metadata as Metadata,\n categoriesV1Category_universal_d_DocumentStyle as DocumentStyle,\n categoriesV1Category_universal_d_TextNodeStyle as TextNodeStyle,\n categoriesV1Category_universal_d_TreeReference as TreeReference,\n categoriesV1Category_universal_d_ExtendedFields as ExtendedFields,\n categoriesV1Category_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n categoriesV1Category_universal_d_RequestedFields as RequestedFields,\n categoriesV1Category_universal_d_CreateCategoryResponse as CreateCategoryResponse,\n categoriesV1Category_universal_d_GetCategoryRequest as GetCategoryRequest,\n categoriesV1Category_universal_d_GetCategoryResponse as GetCategoryResponse,\n categoriesV1Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n categoriesV1Category_universal_d_UpdateCategoryResponse as UpdateCategoryResponse,\n categoriesV1Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n categoriesV1Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n categoriesV1Category_universal_d_QueryCategoriesRequest as QueryCategoriesRequest,\n categoriesV1Category_universal_d_CursorQuery as CursorQuery,\n categoriesV1Category_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n categoriesV1Category_universal_d_Sorting as Sorting,\n categoriesV1Category_universal_d_SortOrder as SortOrder,\n categoriesV1Category_universal_d_CursorPaging as CursorPaging,\n categoriesV1Category_universal_d_QueryCategoriesResponse as QueryCategoriesResponse,\n categoriesV1Category_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n categoriesV1Category_universal_d_Cursors as Cursors,\n categoriesV1Category_universal_d_PlaceCategoryInParentCategoryRequest as PlaceCategoryInParentCategoryRequest,\n categoriesV1Category_universal_d_PlaceCategoryInParentCategoryRequestPosition as PlaceCategoryInParentCategoryRequestPosition,\n categoriesV1Category_universal_d_PlaceCategoryInParentCategoryResponse as PlaceCategoryInParentCategoryResponse,\n categoriesV1Category_universal_d_BulkCreateCategoriesRequest as BulkCreateCategoriesRequest,\n categoriesV1Category_universal_d_BulkCreateCategoriesResponse as BulkCreateCategoriesResponse,\n categoriesV1Category_universal_d_BulkCategoriesResult as BulkCategoriesResult,\n categoriesV1Category_universal_d_ItemMetadata as ItemMetadata,\n categoriesV1Category_universal_d_ApplicationError as ApplicationError,\n categoriesV1Category_universal_d_BulkActionMetadata as BulkActionMetadata,\n categoriesV1Category_universal_d_BulkUpdateCategoriesRequest as BulkUpdateCategoriesRequest,\n categoriesV1Category_universal_d_MaskedCategory as MaskedCategory,\n categoriesV1Category_universal_d_BulkUpdateCategoriesResponse as BulkUpdateCategoriesResponse,\n categoriesV1Category_universal_d_UpdateCategoryVisibilityRequest as UpdateCategoryVisibilityRequest,\n categoriesV1Category_universal_d_UpdateCategoryVisibilityResponse as UpdateCategoryVisibilityResponse,\n categoriesV1Category_universal_d_BulkSetVisibilityRequest as BulkSetVisibilityRequest,\n categoriesV1Category_universal_d_BulkSetVisibilityResponse as BulkSetVisibilityResponse,\n categoriesV1Category_universal_d_BulkSetVisibilityByFilterRequest as BulkSetVisibilityByFilterRequest,\n categoriesV1Category_universal_d_BulkSetVisibilityByFilterResponse as BulkSetVisibilityByFilterResponse,\n categoriesV1Category_universal_d_BulkDeleteCategoriesRequest as BulkDeleteCategoriesRequest,\n categoriesV1Category_universal_d_BulkDeleteCategoriesResponse as BulkDeleteCategoriesResponse,\n categoriesV1Category_universal_d_BulkDeleteCategoriesByFilterRequest as BulkDeleteCategoriesByFilterRequest,\n categoriesV1Category_universal_d_BulkDeleteCategoriesByFilterResponse as BulkDeleteCategoriesByFilterResponse,\n categoriesV1Category_universal_d_AddItemsToCategoryRequest as AddItemsToCategoryRequest,\n categoriesV1Category_universal_d_ItemReference as ItemReference,\n categoriesV1Category_universal_d_AddItemsToCategoryResponse as AddItemsToCategoryResponse,\n categoriesV1Category_universal_d_BulkItemsToCategoryResult as BulkItemsToCategoryResult,\n categoriesV1Category_universal_d_ItemReferenceMetadata as ItemReferenceMetadata,\n categoriesV1Category_universal_d_ItemAddedToCategory as ItemAddedToCategory,\n categoriesV1Category_universal_d_ItemsAddedToCategory as ItemsAddedToCategory,\n categoriesV1Category_universal_d_AddItemToCategoriesRequest as AddItemToCategoriesRequest,\n categoriesV1Category_universal_d_AddItemToCategoriesResponse as AddItemToCategoriesResponse,\n categoriesV1Category_universal_d_BulkItemToCategoriesResult as BulkItemToCategoriesResult,\n categoriesV1Category_universal_d_RemoveItemsFromCategoryRequest as RemoveItemsFromCategoryRequest,\n categoriesV1Category_universal_d_RemoveItemsFromCategoryResponse as RemoveItemsFromCategoryResponse,\n categoriesV1Category_universal_d_ItemRemovedFromCategory as ItemRemovedFromCategory,\n categoriesV1Category_universal_d_ItemsRemovedFromCategory as ItemsRemovedFromCategory,\n categoriesV1Category_universal_d_RemoveItemFromCategoriesRequest as RemoveItemFromCategoriesRequest,\n categoriesV1Category_universal_d_RemoveItemFromCategoriesResponse as RemoveItemFromCategoriesResponse,\n categoriesV1Category_universal_d_ListItemsInCategoryRequest as ListItemsInCategoryRequest,\n categoriesV1Category_universal_d_ListItemsInCategoryResponse as ListItemsInCategoryResponse,\n categoriesV1Category_universal_d_PagingMetadataV2 as PagingMetadataV2,\n categoriesV1Category_universal_d_ListCategoriesForItemRequest as ListCategoriesForItemRequest,\n categoriesV1Category_universal_d_ListCategoriesForItemResponse as ListCategoriesForItemResponse,\n categoriesV1Category_universal_d_MoveItemInCategoryRequest as MoveItemInCategoryRequest,\n categoriesV1Category_universal_d_Position as Position,\n categoriesV1Category_universal_d_MoveItemInCategoryResponse as MoveItemInCategoryResponse,\n categoriesV1Category_universal_d_SetArrangedItemsRequest as SetArrangedItemsRequest,\n categoriesV1Category_universal_d_SetArrangedItemsResponse as SetArrangedItemsResponse,\n categoriesV1Category_universal_d_GetArrangedItemsRequest as GetArrangedItemsRequest,\n categoriesV1Category_universal_d_GetArrangedItemsResponse as GetArrangedItemsResponse,\n categoriesV1Category_universal_d_GetCategoriesTreeRequest as GetCategoriesTreeRequest,\n categoriesV1Category_universal_d_GetCategoriesTreeResponse as GetCategoriesTreeResponse,\n categoriesV1Category_universal_d_CategoryTreeNode as CategoryTreeNode,\n categoriesV1Category_universal_d_DomainEvent as DomainEvent,\n categoriesV1Category_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n categoriesV1Category_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n categoriesV1Category_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n categoriesV1Category_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n categoriesV1Category_universal_d_ActionEvent as ActionEvent,\n categoriesV1Category_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n categoriesV1Category_universal_d_Empty as Empty,\n categoriesV1Category_universal_d_createCategory as createCategory,\n categoriesV1Category_universal_d_CreateCategoryOptions as CreateCategoryOptions,\n categoriesV1Category_universal_d_getCategory as getCategory,\n categoriesV1Category_universal_d_GetCategoryOptions as GetCategoryOptions,\n categoriesV1Category_universal_d_updateCategory as updateCategory,\n categoriesV1Category_universal_d_UpdateCategory as UpdateCategory,\n categoriesV1Category_universal_d_UpdateCategoryOptions as UpdateCategoryOptions,\n categoriesV1Category_universal_d_deleteCategory as deleteCategory,\n categoriesV1Category_universal_d_queryCategories as queryCategories,\n categoriesV1Category_universal_d_QueryCategoriesOptions as QueryCategoriesOptions,\n categoriesV1Category_universal_d_CategoriesQueryResult as CategoriesQueryResult,\n categoriesV1Category_universal_d_CategoriesQueryBuilder as CategoriesQueryBuilder,\n categoriesV1Category_universal_d_placeCategoryInParentCategory as placeCategoryInParentCategory,\n categoriesV1Category_universal_d_PlaceCategoryInParentCategoryOptions as PlaceCategoryInParentCategoryOptions,\n categoriesV1Category_universal_d_bulkCreateCategories as bulkCreateCategories,\n categoriesV1Category_universal_d_BulkCreateCategoriesOptions as BulkCreateCategoriesOptions,\n categoriesV1Category_universal_d_bulkUpdateCategories as bulkUpdateCategories,\n categoriesV1Category_universal_d_BulkUpdateCategoriesOptions as BulkUpdateCategoriesOptions,\n categoriesV1Category_universal_d_updateCategoryVisibility as updateCategoryVisibility,\n categoriesV1Category_universal_d_UpdateCategoryVisibilityOptions as UpdateCategoryVisibilityOptions,\n categoriesV1Category_universal_d_bulkSetVisibility as bulkSetVisibility,\n categoriesV1Category_universal_d_BulkSetVisibilityOptions as BulkSetVisibilityOptions,\n categoriesV1Category_universal_d_bulkSetVisibilityByFilter as bulkSetVisibilityByFilter,\n categoriesV1Category_universal_d_BulkSetVisibilityByFilterOptions as BulkSetVisibilityByFilterOptions,\n categoriesV1Category_universal_d_bulkDeleteCategories as bulkDeleteCategories,\n categoriesV1Category_universal_d_bulkDeleteCategoriesByFilter as bulkDeleteCategoriesByFilter,\n categoriesV1Category_universal_d_BulkDeleteCategoriesByFilterOptions as BulkDeleteCategoriesByFilterOptions,\n categoriesV1Category_universal_d_addItemsToCategory as addItemsToCategory,\n categoriesV1Category_universal_d_AddItemsToCategoryOptions as AddItemsToCategoryOptions,\n categoriesV1Category_universal_d_addItemToCategories as addItemToCategories,\n categoriesV1Category_universal_d_AddItemToCategoriesOptions as AddItemToCategoriesOptions,\n categoriesV1Category_universal_d_removeItemsFromCategory as removeItemsFromCategory,\n categoriesV1Category_universal_d_RemoveItemsFromCategoryOptions as RemoveItemsFromCategoryOptions,\n categoriesV1Category_universal_d_removeItemFromCategories as removeItemFromCategories,\n categoriesV1Category_universal_d_RemoveItemFromCategoriesOptions as RemoveItemFromCategoriesOptions,\n categoriesV1Category_universal_d_listItemsInCategory as listItemsInCategory,\n categoriesV1Category_universal_d_ListItemsInCategoryOptions as ListItemsInCategoryOptions,\n categoriesV1Category_universal_d_listCategoriesForItem as listCategoriesForItem,\n categoriesV1Category_universal_d_ListCategoriesForItemOptions as ListCategoriesForItemOptions,\n categoriesV1Category_universal_d_moveItemInCategory as moveItemInCategory,\n categoriesV1Category_universal_d_MoveItemInCategoryOptions as MoveItemInCategoryOptions,\n categoriesV1Category_universal_d_setArrangedItems as setArrangedItems,\n categoriesV1Category_universal_d_SetArrangedItemsOptions as SetArrangedItemsOptions,\n categoriesV1Category_universal_d_getArrangedItems as getArrangedItems,\n categoriesV1Category_universal_d_getCategoriesTree as getCategoriesTree,\n categoriesV1Category_universal_d_GetCategoriesTreeOptions as GetCategoriesTreeOptions,\n };\n }\n \n export { categoriesV1Category_universal_d as categories };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-badges-backend.v3.d.ts", "content": "declare module \"wix-badges-backend.v3\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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.\n * Uppercase letters only.\n * Example: `#FFFFFF`.\n */\n backgroundColor?: string | null;\n /**\n * Badge text color in hexadecimal RGB format.\n * Uppercase letters only.\n * Example: `#C81B53`.\n */\n textColor?: string | null;\n /**\n * URL of the badge icon image.\n * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.\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 site 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;\n /**\n * Date the badge was updated.\n * @readonly\n */\n _updatedDate?: Date;\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 /**\n * Pagination options. For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n */\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 * 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 * @internal\n */\n hasNext?: 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 /**\n * Pagination options. For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n */\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 /**\n * Pagination options. For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n */\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 /**\n * Creates a new badge.\n * @param badge - Badge to create.\n * @public\n * @requiredField badge\n * @requiredField badge.backgroundColor\n * @requiredField badge.textColor\n * @requiredField badge.title\n */\n function createBadge(badge: Badge): Promise;\n /**\n * Updates a badge's specified properties.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n * @requiredField badge\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.\n * Uppercase letters only.\n * Example: `#FFFFFF`.\n */\n backgroundColor?: string | null;\n /**\n * Badge text color in hexadecimal RGB format.\n * Uppercase letters only.\n * Example: `#C81B53`.\n */\n textColor?: string | null;\n /**\n * URL of the badge icon image.\n * _Recommended_ to use `SVG` image format as it is resolution independent and looks great at any scale.\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 site 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;\n /**\n * Date the badge was updated.\n * @readonly\n */\n _updatedDate?: Date;\n }\n /**\n * Retrieves up to 1000 badges, given the requested paging.\n * Default `paging.limit` is 100, `paging.offset` - 0.\n * For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n * @public */\n function listBadges(options?: ListBadgesOptions): Promise;\n interface ListBadgesOptions {\n /**\n * Pagination options. For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n */\n paging?: Paging;\n }\n /**\n * Retrieves up to 1000 badges, given the requested query options, paging, and sorting.\n * Default `paging.limit` is 100, `paging.offset` - 0.\n * For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n * @public */\n function queryBadges(options?: QueryBadgesOptions): Promise;\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 /**\n * Pagination options. For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n */\n paging?: Paging;\n }\n /**\n * Retrieves a badge.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n */\n function getBadge(_id: string): Promise;\n /**\n * Deletes a badge.\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n */\n function deleteBadge(_id: string): Promise;\n /** Retrieves the site's badge count, given the requested filtering. */\n function countBadges(options?: CountBadgesOptions): 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 the specified members.\n * The members inherit the badge's permissions when they receive the badge, if applicable.\n * Badge permissions are added to previous member permissions (they don't replace existing permissions).\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 */\n function assignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Assigns multiple badges to the specified member.\n * The member inherits the badges' permissions when they receive the badge, if applicable.\n * Badge permissions are added to previous member permissions (they don't replace existing permissions).\n * @param memberId - Member ID.\n * @param ids - List of badge IDs to assign to the member.\n * @requiredField ids\n * @requiredField memberId\n */\n function assignBadges(memberId: string, ids: string[]): Promise;\n /**\n * Removes the requested members from a badge.\n * Members removed from a badge lose the badge's permissions, if applicable.\n * @param _id - Badge ID.\n * @param memberIds - List of members to remove.\n * @public\n * @requiredField _id\n * @requiredField memberIds\n */\n function unassignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Retrieves up to 1000 site members\n * who have a specified badge.\n * Default `paging.limit` is 100, `paging.offset` - 0.\n * For more details on how to use paging, see documentation\n * [here](https://dev.wix.com/api/rest/getting-started/pagination).\n * @param _id - Badge ID.\n * @public\n * @requiredField _id\n */\n function listMembers(_id: string, options?: ListMembersOptions): Promise;\n interface ListMembersOptions {\n /**\n * Pagination options. For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n */\n paging?: Paging;\n }\n /**\n * Retrieves badges assigned to the requested members.\n * @param memberIds - List of members.\n * @public\n * @requiredField memberIds\n */\n function listMembersBadgeIds(memberIds: string[]): Promise;\n /**\n * Retrieves member count per badge.\n * @public */\n function getMemberCountsPerBadge(): Promise;\n /**\n * Updates badges' display order.\n * @public */\n function updateBadgesDisplayOrder(options?: UpdateBadgesDisplayOrderOptions): Promise;\n interface UpdateBadgesDisplayOrderOptions {\n /** Ordered badge IDs. */\n badgeIds?: string[];\n }\n \n export { AssignBadgeRequest, AssignBadgeResponse, AssignBadgesRequest, AssignBadgesResponse, Badge, BadgeAssigned, BadgeMemberCount, BadgeUnassigned, CountBadgesOptions, CountBadgesRequest, CountBadgesResponse, CreateBadgeRequest, CreateBadgeResponse, DeleteBadgeRequest, DeleteBadgeResponse, GetBadgeRequest, GetBadgeResponse, GetMemberCountsPerBadgeRequest, GetMemberCountsPerBadgeResponse, ListBadgesOptions, ListBadgesRequest, ListBadgesResponse, ListMembersBadgeIdsRequest, ListMembersBadgeIdsResponse, ListMembersOptions, ListMembersRequest, ListMembersResponse, MemberBadgeIds, Paging, PagingMetadata, QueryBadgesOptions, QueryBadgesRequest, QueryBadgesResponse, SortOrder, Sorting, UnassignBadgeRequest, UnassignBadgeResponse, UpdateBadge, UpdateBadgeRequest, UpdateBadgeResponse, UpdateBadgesDisplayOrderOptions, UpdateBadgesDisplayOrderRequest, UpdateBadgesDisplayOrderResponse, __debug, assignBadge, assignBadges, countBadges, createBadge, deleteBadge, getBadge, getMemberCountsPerBadge, listBadges, listMembers, listMembersBadgeIds, queryBadges, unassignBadge, updateBadge, updateBadgesDisplayOrder };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-badges-backend.v1.d.ts", "content": "declare module \"wix-badges-backend.v1\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Badge {\n /** Badge id */\n _id?: string;\n /** Badge title */\n title?: string;\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit color hex (e.g. #FFFFFF) */\n backgroundColor?: string;\n /** Badge text color in 6-digit color hex (e.g. #FFFFFF) */\n textColor?: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Id of role/group in groups service that badge assignee belongs to */\n roleId?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n /** Badge url keyword operator */\n slug?: string;\n /** Date when badge was created */\n dateCreated?: Date;\n /** Date when badge was last updated */\n dateUpdated?: Date;\n }\n interface CreateRequest {\n /** Badge title */\n title: string;\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor: string;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n }\n interface CreateResponse {\n /** Created badge */\n badge?: Badge;\n }\n interface UpdateRequest {\n /** Badge id */\n _id: string;\n /** Badge title */\n title: string;\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor: string;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n }\n interface UpdateResponse {\n /** Updated badge */\n badge?: Badge;\n }\n interface ListRequest {\n /** Limit the number of badges to return */\n limit?: number | null;\n /** Default offset is 0. */\n offset?: number | null;\n }\n interface ListResponse {\n /** List of badges in a site */\n badges?: Badge[];\n }\n interface QueryRequest {\n /** Filter criteria */\n filter?: Record | null;\n /** Sorting criteria */\n sorting?: Sorting[];\n /** Result paging data */\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 /** Limit the number of badges to return */\n limit?: number | null;\n /** Default offset is 0. */\n offset?: number | null;\n }\n interface QueryResponse {\n /** List of sorted badges in a site that satisfy filter and paging */\n badges?: Badge[];\n /** Total count of badges in a site that satisfy given filter */\n count?: string;\n }\n interface GetRequest {\n /** Badge id */\n _id: string;\n }\n interface GetResponse {\n /** Badge */\n badge?: Badge;\n }\n interface DeleteRequest {\n /** Badge id */\n _id: string;\n }\n interface DeleteResponse {\n }\n interface CountRequest {\n /** Filter criteria used for counting */\n filter?: Record | null;\n }\n interface CountResponse {\n /** Badges count */\n count?: string;\n }\n interface AssignMembersRequest {\n /** Badge id */\n _id: string;\n /** Ids of members this badge should be assigned to */\n memberIds: string[];\n }\n interface AssignMembersResponse {\n /** Ids of members given badge has been assigned to */\n memberIds?: string[];\n }\n interface ListMembersRequest {\n /** Badge id */\n _id: string;\n }\n interface ListMembersResponse {\n /** Member ids who have the given badge assigned */\n memberIds?: string[];\n }\n interface ListMembersBadgeIdsRequest {\n /** Ids of members whose badge ids should be listed */\n memberIds: string[];\n }\n interface ListMembersBadgeIdsResponse {\n /** List of members with Ids of badges assigned to them */\n memberBadgeIds?: MemberBadgeIds[];\n }\n interface MemberBadgeIds {\n /** Member id */\n memberId?: string;\n /** Badge ids assigned to a given member */\n badgeId?: string[];\n }\n interface BulkRemoveMembersFromBadgeRequest {\n /** Badge id */\n _id: string;\n /** Ids of members given badge will be removed from */\n memberIds: string[];\n }\n interface BulkRemoveMembersFromBadgeResponse {\n }\n interface GetBadgesMembersCountRequest {\n }\n interface GetBadgesMembersCountResponse {\n /** Ids of badges with a member count with this assigned badge */\n badgeMemberCount?: BadgeMemberCount[];\n }\n interface BadgeMemberCount {\n /** Badge id */\n badgeId?: string;\n /** Number of members with assigned badge */\n memberCount?: number;\n }\n /**\n * Create badge\n * @param title - Badge title\n * @internal\n * @documentationMaturity preview\n * @requiredField options.backgroundColor\n * @requiredField options.textColor\n * @requiredField title\n * @adminMethod\n */\n function create(title: string, options?: CreateOptions): Promise;\n interface CreateOptions {\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor: string;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n }\n /**\n * Update badge\n * @param _id - Badge id\n * @param title - Badge title\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.backgroundColor\n * @requiredField options.textColor\n * @requiredField title\n * @adminMethod\n */\n function update(_id: string, title: string, options?: UpdateOptions): Promise;\n interface UpdateOptions {\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor: string;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n }\n /**\n * List all badges in a site\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function list(options?: ListOptions): Promise;\n interface ListOptions {\n /** Limit the number of badges to return */\n limit?: number | null;\n /** Default offset is 0. */\n offset?: number | null;\n }\n /**\n * Query badges in a site\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function query(options?: QueryOptions): Promise;\n interface QueryOptions {\n /** Filter criteria */\n filter?: Record | null;\n /** Sorting criteria */\n sorting?: Sorting[];\n /** Result paging data */\n paging?: Paging;\n }\n /**\n * Get a badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function get(_id: string): Promise;\n /**\n * Delete a badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function _delete(_id: string): Promise;\n /**\n * Count badges in a site\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function count(options?: CountOptions): Promise;\n interface CountOptions {\n /** Filter criteria used for counting */\n filter?: Record | null;\n }\n /**\n * Assign a badge to the given members\n * @param _id - Badge id\n * @param memberIds - Ids of members this badge should be assigned to\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField memberIds\n * @adminMethod\n */\n function assignMembers(_id: string, memberIds: string[]): Promise;\n /**\n * Return list of members that have the given badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function listMembers(_id: string): Promise;\n /**\n * Return list of badge ids assigned to a given members\n * @param memberIds - Ids of members whose badge ids should be listed\n * @internal\n * @documentationMaturity preview\n * @requiredField memberIds\n * @adminMethod\n */\n function listMembersBadgeIds(memberIds: string[]): Promise;\n /**\n * Remove badge from given members\n * @param _id - Badge id\n * @param memberIds - Ids of members given badge will be removed from\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField memberIds\n * @adminMethod\n */\n function bulkRemoveMembersFromBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Return badge ids with a count of members they are assigned to\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getBadgesMembersCount(): Promise;\n \n export { AssignMembersRequest, AssignMembersResponse, Badge, BadgeMemberCount, BulkRemoveMembersFromBadgeRequest, BulkRemoveMembersFromBadgeResponse, CountOptions, CountRequest, CountResponse, CreateOptions, CreateRequest, CreateResponse, DeleteRequest, DeleteResponse, GetBadgesMembersCountRequest, GetBadgesMembersCountResponse, GetRequest, GetResponse, ListMembersBadgeIdsRequest, ListMembersBadgeIdsResponse, ListMembersRequest, ListMembersResponse, ListOptions, ListRequest, ListResponse, MemberBadgeIds, Paging, QueryOptions, QueryRequest, QueryResponse, SortOrder, Sorting, UpdateOptions, UpdateRequest, UpdateResponse, __debug, _delete, assignMembers, bulkRemoveMembersFromBadge, count, create, get, getBadgesMembersCount, list, listMembers, listMembersBadgeIds, query, update };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-badges-backend.v2.d.ts", "content": "declare module \"wix-badges-backend.v2\" {\n interface Badge {\n /** Badge id */\n _id?: string;\n /** Badge title */\n title?: string;\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit color hex in upper case (e.g. #FFFFFF) */\n backgroundColor?: string;\n /** Badge text color in 6-digit color hex in upper case (e.g. #FFFFFF) */\n textColor?: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Id of role/group in groups service that badge assignee belongs to */\n roleId?: string;\n /**\n * Indicates whether badge has permissions.\n *\n * Badges can have special permissions to access specific members-only pages.\n *\n * When the value is set to **true**, badge permissions can be managed in\n * [permissions table](https://www.wix.com/my-account/site-selector/?buttonText=Manage%20Permissions&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/member-permissions/roles/manage-permissions).\n * Site members will receive relevant permissions once assigned such badge.\n *\n * When the value is set to **false**, badge has no associated permissions\n * and is not visible in permissions table.\n * Site member will not receive any permissions once assigned such badge.\n */\n hasPermissions?: boolean;\n /** Badge url keyword operator */\n slug?: string;\n /** Date when badge was created */\n createDate?: Date | null;\n /** Date when badge was last updated */\n updateDate?: Date | null;\n }\n interface CreateRequest {\n /** Badge title */\n title: string;\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor: string;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n }\n interface CreateResponse {\n /** Created badge */\n badge?: Badge;\n }\n interface UpdateRequest {\n /** Badge id */\n _id: string;\n /** Badge title */\n title?: string | null;\n /** Badge description */\n description?: string | null;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor?: string | null;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor?: string | null;\n /** Badge icon SVG as 'https://...' */\n icon?: string | null;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean | null;\n }\n interface UpdateResponse {\n /** Updated badge */\n badge?: Badge;\n }\n interface ListRequest {\n /** Limit the number of badges to return */\n limit?: number | null;\n /** Default offset is 0. */\n offset?: number | null;\n }\n interface ListResponse {\n /** List of badges in a site */\n badges?: Badge[];\n }\n interface QueryRequest {\n /** Filter criteria */\n filter?: Record | null;\n /** Sorting criteria */\n sort?: Sorting[];\n /** Result paging data */\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging {\n /** Limit the number of badges to return */\n limit?: number | null;\n /** Default offset is 0. */\n offset?: number | null;\n }\n interface QueryResponse {\n /** List of sorted badges in a site that satisfy filter and paging */\n badges?: Badge[];\n /** Total count of badges in a site that satisfy given filter */\n count?: string;\n }\n interface GetRequest {\n /** Badge id */\n _id: string;\n }\n interface GetResponse {\n /** Badge */\n badge?: Badge;\n }\n interface DeleteRequest {\n /** Badge id */\n _id: string;\n }\n interface DeleteResponse {\n }\n interface CountRequest {\n /** Filter criteria used for counting */\n filter?: Record | null;\n }\n interface CountResponse {\n /** Badges count */\n count?: string;\n }\n interface AssignBadgeRequest {\n /** Badge id */\n _id: string;\n /** Ids of members this badge should be assigned to */\n memberIds: string[];\n }\n interface AssignBadgeResponse {\n /** Ids of members given badge has been assigned to */\n memberIds?: string[];\n }\n interface BadgeAssigned {\n /** Member ids who have the given badge assigned */\n memberId?: string;\n }\n interface UnassignBadgeRequest {\n /** Badge id */\n _id: string;\n /** Ids of members given badge will be removed from */\n memberIds: string[];\n }\n interface UnassignBadgeResponse {\n }\n interface BadgeUnassigned {\n /** Member id who had the badge unassigned */\n memberId?: string;\n }\n interface ListMembersRequest {\n /** Badge id */\n _id: string;\n }\n interface ListMembersResponse {\n /** Member ids who have the given badge assigned */\n memberIds?: string[];\n }\n interface ListMembersBadgeIdsRequest {\n /** Ids of members whose badge ids should be listed */\n memberIds: string[];\n }\n interface ListMembersBadgeIdsResponse {\n /** List of members with Ids of badges assigned to them */\n memberBadgeIds?: MemberBadgeIds[];\n }\n interface MemberBadgeIds {\n /** Member id */\n memberId?: string;\n /** Badge ids assigned to a given member */\n badgeIds?: string[];\n }\n interface GetBadgeCountersRequest {\n }\n interface GetBadgeCountersResponse {\n /** Ids of badges with a member count with this assigned badge */\n badgeMemberCounts?: BadgeMemberCount[];\n }\n interface BadgeMemberCount {\n /** Badge id */\n badgeId?: string;\n /** Number of members with assigned badge */\n memberCount?: number;\n }\n interface UpdateBadgesOrderRequest {\n /** Ordered badges ids */\n badgeIds?: string[];\n }\n interface UpdateBadgesOrderResponse {\n /** Reordered badges */\n badges?: Badge[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Create badge\n * @param title - Badge title\n * @internal\n * @documentationMaturity preview\n * @requiredField options.backgroundColor\n * @requiredField options.textColor\n * @requiredField title\n * @permissionId badges.manage\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.CreateBadge\n * @targetRemovalDate 2022-03-31\n */\n function create(title: string, options?: CreateOptions): Promise;\n interface CreateOptions {\n /** Badge description */\n description?: string;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor: string;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor: string;\n /** Badge icon SVG as 'https://...' */\n icon?: string;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean;\n }\n /**\n * Update badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId badges.manage\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.UpdateBadge\n * @targetRemovalDate 2022-03-31\n */\n function update(_id: string, options?: UpdateOptions): Promise;\n interface UpdateOptions {\n /** Badge title */\n title?: string | null;\n /** Badge description */\n description?: string | null;\n /** Badge background color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n backgroundColor?: string | null;\n /** Badge text color in 6-digit upper-cased color hex (e.g. #FFFFFF) */\n textColor?: string | null;\n /** Badge icon SVG as 'https://...' */\n icon?: string | null;\n /** Indicates whether badge has permissions */\n hasPermissions?: boolean | null;\n }\n /**\n * List all badges in a site\n * @internal\n * @documentationMaturity preview\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.ListBadges\n * @targetRemovalDate 2022-03-31\n */\n function list(options?: ListOptions): Promise;\n interface ListOptions {\n /** Limit the number of badges to return */\n limit?: number | null;\n /** Default offset is 0. */\n offset?: number | null;\n }\n /**\n * Query badges in a site\n * @internal\n * @documentationMaturity preview\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.QueryBadges\n * @targetRemovalDate 2022-03-31\n */\n function query(options?: QueryOptions): Promise;\n interface QueryOptions {\n /** Filter criteria */\n filter?: Record | null;\n /** Sorting criteria */\n sort?: Sorting[];\n /** Result paging data */\n paging?: Paging;\n }\n /**\n * Get a badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.GetBadge\n * @targetRemovalDate 2022-03-31\n */\n function get(_id: string): Promise;\n /**\n * Delete a badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId badges.manage\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.DeleteBadge\n * @targetRemovalDate 2022-03-31\n */\n function _delete(_id: string): Promise;\n /**\n * Count badges in a site\n * @internal\n * @documentationMaturity preview\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.CountBadges\n * @targetRemovalDate 2022-03-31\n */\n function count(options?: CountOptions): Promise;\n interface CountOptions {\n /** Filter criteria used for counting */\n filter?: Record | null;\n }\n /**\n * Assign a badge to the given members\n * @param _id - Badge id\n * @param memberIds - Ids of members this badge should be assigned to\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField memberIds\n * @permissionId BADGES.ASSIGN\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.AssignBadge\n * @targetRemovalDate 2022-03-31\n */\n function assignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Remove badge from given members\n * @param _id - Badge id\n * @param memberIds - Ids of members given badge will be removed from\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField memberIds\n * @permissionId BADGES.ASSIGN\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.UnassignBadge\n * @targetRemovalDate 2022-03-31\n */\n function unassignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Return list of members that have the given badge\n * @param _id - Badge id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.ListMembers\n * @targetRemovalDate 2022-03-31\n */\n function listMembers(_id: string): Promise;\n /**\n * Return list of badge ids assigned to a given members\n * @param memberIds - Ids of members whose badge ids should be listed\n * @internal\n * @documentationMaturity preview\n * @requiredField memberIds\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.ListMembersBadgeIds\n * @targetRemovalDate 2022-03-31\n */\n function listMembersBadgeIds(memberIds: string[]): Promise;\n /**\n * Return badge ids with a count of members they are assigned to\n * @internal\n * @documentationMaturity preview\n * @permissionId BADGES.READ\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.GetMemberCountsPerBadge\n * @targetRemovalDate 2022-03-31\n */\n function getBadgeCounters(): Promise;\n /**\n * Update badges order\n * @internal\n * @documentationMaturity preview\n * @permissionId badges.manage\n * @adminMethod\n * @deprecated\n * @replacedBy com.wixpress.badges.v3.BadgesServiceV3.UpdateBadgesDisplayOrder\n * @targetRemovalDate 2022-03-31\n */\n function updateBadgesOrder(options?: UpdateBadgesOrderOptions): Promise;\n interface UpdateBadgesOrderOptions {\n /** Ordered badges ids */\n badgeIds?: string[];\n }\n \n export { ActionEvent, AssignBadgeRequest, AssignBadgeResponse, Badge, BadgeAssigned, BadgeMemberCount, BadgeUnassigned, CountOptions, CountRequest, CountResponse, CreateOptions, CreateRequest, CreateResponse, DeleteRequest, DeleteResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetBadgeCountersRequest, GetBadgeCountersResponse, GetRequest, GetResponse, IdentificationData, IdentificationDataIdOneOf, ListMembersBadgeIdsRequest, ListMembersBadgeIdsResponse, ListMembersRequest, ListMembersResponse, ListOptions, ListRequest, ListResponse, MemberBadgeIds, MessageEnvelope, Paging, QueryOptions, QueryRequest, QueryResponse, RestoreInfo, SortOrder, Sorting, UnassignBadgeRequest, UnassignBadgeResponse, UpdateBadgesOrderOptions, UpdateBadgesOrderRequest, UpdateBadgesOrderResponse, UpdateOptions, UpdateRequest, UpdateResponse, WebhookIdentityType, _delete, assignBadge, count, create, get, getBadgeCounters, list, listMembers, listMembersBadgeIds, query, unassignBadge, update, updateBadgesOrder };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/localdelivery-spi-v2-tpa.d.ts", "content": "declare module \"localdelivery-spi-v2-tpa\" {\n interface Tpa {\n }\n interface ListAccountIdsRequest {\n }\n interface ListAccountIdsResponse {\n /** Account IDs. */\n accountIds?: string[];\n }\n interface GetAccountStatusRequest {\n /** Account ID. */\n accountId: string;\n }\n interface GetAccountStatusResponse {\n /** Account status. */\n status?: Status;\n }\n enum Status {\n UNKNOWN = \"UNKNOWN\",\n CREATED = \"CREATED\",\n ACTIVE = \"ACTIVE\",\n INACTIVE = \"INACTIVE\"\n }\n interface GetDeliveryEstimateRequest {\n /** Account ID. */\n accountId: string;\n /** Delivery pickup address. */\n pickupAddress?: Address;\n /** Delivery drop-off address. */\n dropOffAddress?: Address;\n /** Unique identifier of the specific store location that the delivery is for. */\n configurationId: string;\n /** Wix order details. */\n order: EstimateOrder;\n /** Estimated pickup time. */\n pickupTime?: Date;\n /** Estimated drop-off time. */\n dropOffTime?: Date;\n }\n /** Physical address */\n interface Address {\n /** Country code. */\n country?: string;\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;\n /** Zip/postal code. */\n postalCode?: string | null;\n /** Street name and number. */\n streetAddress?: StreetAddress;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n /** Coordinates of the physical address. */\n geocode?: AddressLocation;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n }\n interface AddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface EstimateOrder {\n /** The subtotal for all items in the order, excluding tax/tip. */\n subtotal?: Money;\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 GetDeliveryEstimateResponse {\n /** Retrieved Estimate. */\n estimate?: Estimate;\n }\n interface Estimate {\n /** Optional. Used as reference to the estimate when creating a new order. */\n deliveryId?: string | null;\n /** Estimate amount that is charged for this delivery. */\n deliveryFee?: Money;\n /** Estimated pickup time. */\n pickupTime?: Date;\n /** Estimated drop-off time. */\n dropOffTime?: Date;\n }\n interface CreateDeliveryRequest {\n /** Account ID. */\n accountId: string;\n /** Pickup Info in order to create a new delivery. */\n pickupInfo: PickupInfo;\n /** Drop-off Info in order to create a new delivery. */\n dropOffInfo: DropOffInfo;\n /** Optional. Estimate ID if needed. */\n estimateId?: string | null;\n /** Wix order details. */\n order: WixOrder;\n /** Is contactless delivery. */\n contactlessDelivery?: boolean | null;\n /** The requested time at which the order should be picked up. */\n pickupTime?: Date;\n /** The requested time at which the order should be delivered. */\n dropOffTime?: Date;\n }\n interface PickupInfo {\n /** Unique identifier of the specific store location that the delivery is for. */\n configurationId?: string;\n /** The name of the store where the order should be picked up from. */\n storeName?: string;\n /** Delivery pickup address. */\n address?: Address;\n /** Phone number of the store where the order should be picked up from. */\n phone?: string;\n /** Instructions for the courier at the pickup location. */\n instructions?: string | null;\n }\n interface DropOffInfo {\n /** Delivery drop-off address. */\n address?: Address;\n /** Instructions for the courier at the drop-off location. */\n instructions?: string | null;\n }\n interface WixOrder {\n /** Order ID. */\n _id?: string;\n /** Customer details. */\n customer?: Customer;\n /** The subtotal for all items in the order, excluding tax/tip. */\n subtotal?: Money;\n /** Amount that will be paid to the courier. */\n tip?: Money;\n /** Dishes and options included in the order. */\n lineItems?: LineItem[];\n }\n interface CatalogReference {\n /** Line item name as defined in the catalog. */\n catalogItemName?: string | null;\n }\n interface Customer {\n /** First name. */\n firstName?: string;\n /** Last name. */\n lastName?: string;\n /** Phone number. */\n phone?: string;\n /** Email address. */\n email?: string;\n }\n interface LineItem {\n /** Line item quantity. */\n quantity?: number;\n /** References to the line item’s origin catalog. */\n catalogReference?: CatalogReference;\n }\n interface CreateDeliveryResponse {\n /** The vendor new delivery order id */\n deliveryId?: string;\n /** When a delivery is ready to be picked up. This is the start of the pickup window. */\n pickupWindowStartTime?: Date;\n /** When a delivery must be picked up by. This is the end of the pickup window. */\n pickupWindowEndTime?: Date;\n /** When a delivery is ready to be dropped off. This is the start of the drop-off window. */\n dropOffWindowStartTime?: Date;\n /** When a delivery must be dropped off by. This is the end of the drop-off window. */\n dropOffWindowEndTime?: Date;\n /** Amount that is charged for this delivery. */\n deliveryFee?: Money;\n }\n /** Local Delivery component */\n interface LocalDeliveryComponentData {\n /**\n * URL for the Delivery provider registration web page.\n * The App Instance and Account Id query parameters are attached to the registration URL\n * so that you can identify your account when accessing the vendor api. [learn more](https://devforum.wix.com/en/article/app-instance)\n */\n registrationUrl?: string;\n }\n interface GetDeliveryEstimateOptions {\n pickupAddress?: Address;\n dropOffAddress?: Address;\n pickupTime?: Date;\n dropOffTime?: Date;\n configurationId: string;\n order: EstimateOrder;\n }\n interface CreateDeliveryOptions {\n pickupInfo: PickupInfo;\n dropOffInfo: DropOffInfo;\n pickupTime?: Date;\n dropOffTime?: Date;\n estimateId?: string | null;\n order: WixOrder;\n contactlessDelivery?: boolean | null;\n }\n \n export { Address, AddressLocation, CatalogReference, CreateDeliveryOptions, CreateDeliveryRequest, CreateDeliveryResponse, Customer, DropOffInfo, Estimate, EstimateOrder, GetAccountStatusRequest, GetAccountStatusResponse, GetDeliveryEstimateOptions, GetDeliveryEstimateRequest, GetDeliveryEstimateResponse, LineItem, ListAccountIdsRequest, ListAccountIdsResponse, LocalDeliveryComponentData, Money, PickupInfo, Status, StreetAddress, Tpa, WixOrder };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-forum-backend.d.ts", "content": "declare module \"wix-forum-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Comment {\n /**\n * Comment ID\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of parent comment (if relevant)\n * @readonly\n */\n parentId?: string | null;\n /** ID of post comment was made on */\n postId?: string | null;\n /**\n * SiteMember ID of comment owner\n * @readonly\n */\n ownerId?: string | null;\n /** Plain content text (no formatting) */\n contentText?: string | null;\n /**\n * Total number of comments made responding to this comment\n * @readonly\n */\n replyCount?: number | null;\n /**\n * Total number of comment likes\n * @readonly\n */\n likeCount?: number | null;\n /**\n * Date comment was created\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date comment was edited\n * @readonly\n */\n editedDate?: Date;\n /**\n * Date of latest activity on this comment (e.g., date the latest reply was added to comment)\n * @readonly\n */\n lastActivityDate?: Date;\n /**\n * Comment URL\n * @readonly\n */\n url?: string;\n /**\n * Total number of comment upvotes\n * @readonly\n */\n upvoteCount?: number | null;\n /**\n * Total number of comment downvotes\n * @readonly\n */\n downvoteCount?: number | null;\n /**\n * Score of comment\n * @readonly\n */\n score?: number | null;\n /**\n * Comment legacy ID\n * @internal\n * @readonly\n */\n legacyId?: string | null;\n /**\n * The comment content as a stringified DraftJs document.\n * @internal\n * @readonly\n */\n content?: string | null;\n /**\n * Whether comment is marked.\n * @readonly\n */\n marked?: boolean;\n /**\n * Ids of members mentioned in comment content\n * @readonly\n */\n mentions?: string[];\n /**\n * Images from comment content.\n * @readonly\n */\n images?: string[];\n }\n interface Upvoted {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface Downvoted {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface Unvoted {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface Liked {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface Unliked {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface MarkedAsBest {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface UnmarkedAsBest {\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface Reported {\n /** Report Type */\n reportType?: ReportType;\n /** Comment ID */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n enum ReportType {\n OFFENSIVE_CONTENT = \"OFFENSIVE_CONTENT\",\n OFFENSIVE_MEDIA = \"OFFENSIVE_MEDIA\",\n SPAM = \"SPAM\"\n }\n interface Deleted {\n /** ID of the deleted comment. */\n commentId?: string;\n /** Post ID */\n postId?: string;\n }\n interface CommentRequest {\n /** Comment ID */\n commentId: string;\n /** Supported values: URL, CONTENT */\n fieldsets?: string[];\n }\n interface CommentResponse {\n /** Comment for provided post ID */\n comment?: Comment;\n }\n interface ApiQueryCommentsRequest {\n /** Paging object (e.g., { limit: 10, offset: 100 } ) */\n paging?: CommentsPaging;\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?: CommentsSort[];\n /** Supported values: URL, CONTENT */\n fieldsets?: string[];\n }\n interface CommentsPaging {\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 CommentsSort {\n /**\n * Records can be sorted by:\n * lastActivityDate\n * createdDate\n * replyCount\n * likeCount\n */\n fieldName?: string;\n /** Records can be sorted in ascending (default) or descending order */\n order?: Order;\n }\n enum Order {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface ApiQueryCommentsResponse {\n /** Comments list */\n comments?: Comment[];\n /** Pagination */\n metaData?: QueryCommentsResponseMetaData;\n }\n interface QueryCommentsResponseMetaData {\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 CreateCommentRequest {\n /** Comment to create */\n comment?: Comment;\n }\n interface CreateCommentResponse {\n /** Created comment */\n comment?: Comment;\n }\n interface UpdateCommentRequest {\n /** ID of the comment to update */\n commentId: string;\n /** Field mask of fields to update */\n fieldMask?: string[];\n /** Comment data with partial data to update */\n comment?: Comment;\n }\n interface UpdateCommentResponse {\n /** Updated comment */\n comment?: Comment;\n }\n interface DeleteCommentRequest {\n /** ID of the comment to delete */\n commentId: string;\n }\n interface DeleteCommentResponse {\n /** Deleted comment */\n comment?: Comment;\n }\n interface GetCommentRequest {\n commentId: string;\n /** Supported values: URL, CONTENT */\n fieldsets?: string[];\n }\n interface GetCommentResponse {\n comment?: Comment;\n }\n interface QueryCommentsRequest {\n query: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\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 /** 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 /** 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 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 /** 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 comments?: Comment[];\n metadata?: 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 * 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 * @internal\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 DomainEvent extends DomainEventBodyOneOf {\n /** random GUID so clients can tell if event was already handled */\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 /**\n * Assuming that all messages including Actions have id\n * Example: The id of the specific order, the id of a specific campaign\n */\n entityId?: string;\n /** The time of the event. Useful if there was a delay in dispatching */\n eventTime?: Date;\n /**\n * A field that should be set if this event was triggered by an anonymize request.\n * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.\n * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.\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 createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n /** @oneof */\n interface DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n actionEvent?: ActionEvent;\n extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;\n }\n interface EntityCreatedEvent {\n entityAsJson?: string;\n /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n interface ExtendedFieldsUpdatedEvent {\n currentEntityAsJson?: string;\n }\n interface Empty {\n }\n /**\n * Returns a single comment by ID\n * @param commentId - Comment ID\n * @requiredField commentId\n */\n function getComment(commentId: string, options?: GetCommentOptions): Promise;\n interface GetCommentOptions {\n /** Supported values: URL, CONTENT */\n fieldsets?: string[];\n }\n /**\n * Returns a list of comments by [query](https://github.com/wix-private/platformization-guidelines/blob/master/Server/API-Query.md)\n *\n * Paging\n * - limit: default - 10, min - 0, max - 100\n * - offset: default - 0, min - 0\n *\n * Filterable fields:\n * - id\n * - parentId\n * - postId\n * - ownerId\n * - contentText\n * - replyCount\n * - likeCount\n * - createdDate\n * - editedDate\n * - lastActivityDate\n *\n * Sortable fields:\n * - lastActivityDate\n * - createdDate\n * - replyCount\n * - likeCount\n */\n function queryComments(options?: QueryCommentsOptions): Promise;\n interface QueryCommentsOptions {\n /** Paging object (e.g., { limit: 10, offset: 100 } ) */\n paging?: CommentsPaging;\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?: CommentsSort[];\n /** Supported values: URL, CONTENT */\n fieldsets?: string[];\n }\n /**\n * Creates comment\n * @requiredField options.comment.contentText\n * @requiredField options.comment.postId\n */\n function createComment(options?: CreateCommentOptions): Promise;\n interface CreateCommentOptions {\n /** Comment to create */\n comment?: Comment;\n }\n /**\n * Updates comment fields according to fieldMask\n * @param commentId - ID of the comment to update\n * @requiredField commentId\n */\n function updateComment(commentId: string, options?: UpdateCommentOptions): Promise;\n interface UpdateCommentOptions {\n /** Field mask of fields to update */\n fieldMask?: string[];\n /** Comment data with partial data to update */\n comment?: Comment;\n }\n /**\n * Deletes comment\n * @param commentId - ID of the comment to delete\n * @requiredField commentId\n */\n function deleteComment(commentId: string): Promise;\n /** @requiredField commentId */\n function forumCommentsAdapterGetComment(commentId: string, options?: ForumCommentsAdapterGetCommentOptions): Promise;\n interface ForumCommentsAdapterGetCommentOptions {\n /** Supported values: URL, CONTENT */\n fieldsets?: string[];\n }\n /** @requiredField QueryCommentsRequest */\n function forumCommentsAdapterQueryComments(query?: QueryV2): Promise;\n \n const forumV1Comment_universal_d___debug: typeof __debug;\n type forumV1Comment_universal_d_Comment = Comment;\n type forumV1Comment_universal_d_Upvoted = Upvoted;\n type forumV1Comment_universal_d_Downvoted = Downvoted;\n type forumV1Comment_universal_d_Unvoted = Unvoted;\n type forumV1Comment_universal_d_Liked = Liked;\n type forumV1Comment_universal_d_Unliked = Unliked;\n type forumV1Comment_universal_d_MarkedAsBest = MarkedAsBest;\n type forumV1Comment_universal_d_UnmarkedAsBest = UnmarkedAsBest;\n type forumV1Comment_universal_d_Reported = Reported;\n type forumV1Comment_universal_d_ReportType = ReportType;\n const forumV1Comment_universal_d_ReportType: typeof ReportType;\n type forumV1Comment_universal_d_Deleted = Deleted;\n type forumV1Comment_universal_d_CommentRequest = CommentRequest;\n type forumV1Comment_universal_d_CommentResponse = CommentResponse;\n type forumV1Comment_universal_d_ApiQueryCommentsRequest = ApiQueryCommentsRequest;\n type forumV1Comment_universal_d_CommentsPaging = CommentsPaging;\n type forumV1Comment_universal_d_CommentsSort = CommentsSort;\n type forumV1Comment_universal_d_Order = Order;\n const forumV1Comment_universal_d_Order: typeof Order;\n type forumV1Comment_universal_d_ApiQueryCommentsResponse = ApiQueryCommentsResponse;\n type forumV1Comment_universal_d_QueryCommentsResponseMetaData = QueryCommentsResponseMetaData;\n type forumV1Comment_universal_d_CreateCommentRequest = CreateCommentRequest;\n type forumV1Comment_universal_d_CreateCommentResponse = CreateCommentResponse;\n type forumV1Comment_universal_d_UpdateCommentRequest = UpdateCommentRequest;\n type forumV1Comment_universal_d_UpdateCommentResponse = UpdateCommentResponse;\n type forumV1Comment_universal_d_DeleteCommentRequest = DeleteCommentRequest;\n type forumV1Comment_universal_d_DeleteCommentResponse = DeleteCommentResponse;\n type forumV1Comment_universal_d_GetCommentRequest = GetCommentRequest;\n type forumV1Comment_universal_d_GetCommentResponse = GetCommentResponse;\n type forumV1Comment_universal_d_QueryCommentsRequest = QueryCommentsRequest;\n type forumV1Comment_universal_d_QueryV2 = QueryV2;\n type forumV1Comment_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type forumV1Comment_universal_d_Sorting = Sorting;\n type forumV1Comment_universal_d_SortOrder = SortOrder;\n const forumV1Comment_universal_d_SortOrder: typeof SortOrder;\n type forumV1Comment_universal_d_Paging = Paging;\n type forumV1Comment_universal_d_CursorPaging = CursorPaging;\n type forumV1Comment_universal_d_QueryCommentsResponse = QueryCommentsResponse;\n type forumV1Comment_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type forumV1Comment_universal_d_Cursors = Cursors;\n type forumV1Comment_universal_d_DomainEvent = DomainEvent;\n type forumV1Comment_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type forumV1Comment_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type forumV1Comment_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type forumV1Comment_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type forumV1Comment_universal_d_ActionEvent = ActionEvent;\n type forumV1Comment_universal_d_ExtendedFieldsUpdatedEvent = ExtendedFieldsUpdatedEvent;\n type forumV1Comment_universal_d_Empty = Empty;\n const forumV1Comment_universal_d_getComment: typeof getComment;\n type forumV1Comment_universal_d_GetCommentOptions = GetCommentOptions;\n const forumV1Comment_universal_d_queryComments: typeof queryComments;\n type forumV1Comment_universal_d_QueryCommentsOptions = QueryCommentsOptions;\n const forumV1Comment_universal_d_createComment: typeof createComment;\n type forumV1Comment_universal_d_CreateCommentOptions = CreateCommentOptions;\n const forumV1Comment_universal_d_updateComment: typeof updateComment;\n type forumV1Comment_universal_d_UpdateCommentOptions = UpdateCommentOptions;\n const forumV1Comment_universal_d_deleteComment: typeof deleteComment;\n const forumV1Comment_universal_d_forumCommentsAdapterGetComment: typeof forumCommentsAdapterGetComment;\n type forumV1Comment_universal_d_ForumCommentsAdapterGetCommentOptions = ForumCommentsAdapterGetCommentOptions;\n const forumV1Comment_universal_d_forumCommentsAdapterQueryComments: typeof forumCommentsAdapterQueryComments;\n namespace forumV1Comment_universal_d {\n export {\n forumV1Comment_universal_d___debug as __debug,\n forumV1Comment_universal_d_Comment as Comment,\n forumV1Comment_universal_d_Upvoted as Upvoted,\n forumV1Comment_universal_d_Downvoted as Downvoted,\n forumV1Comment_universal_d_Unvoted as Unvoted,\n forumV1Comment_universal_d_Liked as Liked,\n forumV1Comment_universal_d_Unliked as Unliked,\n forumV1Comment_universal_d_MarkedAsBest as MarkedAsBest,\n forumV1Comment_universal_d_UnmarkedAsBest as UnmarkedAsBest,\n forumV1Comment_universal_d_Reported as Reported,\n forumV1Comment_universal_d_ReportType as ReportType,\n forumV1Comment_universal_d_Deleted as Deleted,\n forumV1Comment_universal_d_CommentRequest as CommentRequest,\n forumV1Comment_universal_d_CommentResponse as CommentResponse,\n forumV1Comment_universal_d_ApiQueryCommentsRequest as ApiQueryCommentsRequest,\n forumV1Comment_universal_d_CommentsPaging as CommentsPaging,\n forumV1Comment_universal_d_CommentsSort as CommentsSort,\n forumV1Comment_universal_d_Order as Order,\n forumV1Comment_universal_d_ApiQueryCommentsResponse as ApiQueryCommentsResponse,\n forumV1Comment_universal_d_QueryCommentsResponseMetaData as QueryCommentsResponseMetaData,\n forumV1Comment_universal_d_CreateCommentRequest as CreateCommentRequest,\n forumV1Comment_universal_d_CreateCommentResponse as CreateCommentResponse,\n forumV1Comment_universal_d_UpdateCommentRequest as UpdateCommentRequest,\n forumV1Comment_universal_d_UpdateCommentResponse as UpdateCommentResponse,\n forumV1Comment_universal_d_DeleteCommentRequest as DeleteCommentRequest,\n forumV1Comment_universal_d_DeleteCommentResponse as DeleteCommentResponse,\n forumV1Comment_universal_d_GetCommentRequest as GetCommentRequest,\n forumV1Comment_universal_d_GetCommentResponse as GetCommentResponse,\n forumV1Comment_universal_d_QueryCommentsRequest as QueryCommentsRequest,\n forumV1Comment_universal_d_QueryV2 as QueryV2,\n forumV1Comment_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n forumV1Comment_universal_d_Sorting as Sorting,\n forumV1Comment_universal_d_SortOrder as SortOrder,\n forumV1Comment_universal_d_Paging as Paging,\n forumV1Comment_universal_d_CursorPaging as CursorPaging,\n forumV1Comment_universal_d_QueryCommentsResponse as QueryCommentsResponse,\n forumV1Comment_universal_d_PagingMetadataV2 as PagingMetadataV2,\n forumV1Comment_universal_d_Cursors as Cursors,\n forumV1Comment_universal_d_DomainEvent as DomainEvent,\n forumV1Comment_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n forumV1Comment_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n forumV1Comment_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n forumV1Comment_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n forumV1Comment_universal_d_ActionEvent as ActionEvent,\n forumV1Comment_universal_d_ExtendedFieldsUpdatedEvent as ExtendedFieldsUpdatedEvent,\n forumV1Comment_universal_d_Empty as Empty,\n forumV1Comment_universal_d_getComment as getComment,\n forumV1Comment_universal_d_GetCommentOptions as GetCommentOptions,\n forumV1Comment_universal_d_queryComments as queryComments,\n forumV1Comment_universal_d_QueryCommentsOptions as QueryCommentsOptions,\n forumV1Comment_universal_d_createComment as createComment,\n forumV1Comment_universal_d_CreateCommentOptions as CreateCommentOptions,\n forumV1Comment_universal_d_updateComment as updateComment,\n forumV1Comment_universal_d_UpdateCommentOptions as UpdateCommentOptions,\n forumV1Comment_universal_d_deleteComment as deleteComment,\n forumV1Comment_universal_d_forumCommentsAdapterGetComment as forumCommentsAdapterGetComment,\n forumV1Comment_universal_d_ForumCommentsAdapterGetCommentOptions as ForumCommentsAdapterGetCommentOptions,\n forumV1Comment_universal_d_forumCommentsAdapterQueryComments as forumCommentsAdapterQueryComments,\n };\n }\n \n export { forumV1Comment_universal_d as forum };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-v1-shipping-label-carrier-quote.d.ts", "content": "declare module \"interfaces-v1-shipping-label-carrier-quote\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface ShippingLabelCarrierQuote {\n /** service unique id */\n serviceId?: string;\n /** service display name (translated) */\n serviceName?: string;\n /** total value */\n total?: string;\n /** total breakdown details */\n details?: ShippingLabelQuoteDetail[];\n }\n interface ShippingLabelQuoteDetail {\n /** display name (translated) */\n title?: string;\n /** value */\n value?: string;\n }\n interface GetQuotesRequest {\n /** address and contact details of sender */\n originAddressWithContact?: AddressWithContact;\n /** address and contact details of receiver */\n destinationAddressWithContact?: AddressWithContact;\n /** carrier specific key for preset package types (Optional) */\n packageTypeId?: string | null;\n /** package dimension */\n packageDimension?: PackageDimension;\n /** weight of the package */\n weight?: number;\n /** require signature from receiver */\n requireSignature?: boolean | null;\n /** value for insurance */\n insuranceValue?: string | null;\n /** international customs information */\n internationalCustomsInfo?: InternationalCustomsInfo;\n }\n /** Billing Info and shipping details */\n interface AddressWithContact {\n /** Address. */\n address?: Address;\n /** Contact details. */\n contactDetails?: FullAddressContactDetails;\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. */\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 /** @internal */\n location?: AddressLocation;\n }\n interface StreetAddress {\n /** Street number. */\n number?: string;\n /** Street name. */\n name?: string;\n /**\n * Apartment number.\n * @internal\n */\n apt?: string;\n /**\n * Optional address line 1\n * @internal\n */\n formattedAddressLine?: string | null;\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;\n }\n interface VatId {\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;\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 interface PackageDimension {\n /** width of the package */\n width?: number;\n /** length of the package */\n length?: number;\n /** height of the package (Optional) */\n height?: number | null;\n }\n interface InternationalCustomsInfo {\n /** package content type for customs */\n packageContentType?: PackageContentType;\n /** description (Optional when package_content_type is not OTHER) */\n contentDescription?: string | null;\n /** item details for customs */\n itemsDetails?: ItemDetails[];\n }\n enum PackageContentType {\n GIFT = \"GIFT\",\n MERCHANDISE = \"MERCHANDISE\",\n OTHER = \"OTHER\"\n }\n interface ItemDetails {\n /** item unique id */\n _id?: string;\n /** quantity of item */\n quantity?: number;\n /** description */\n description?: string;\n /** weight of single item */\n weight?: number;\n /** value of single item */\n value?: string;\n }\n interface GetQuotesResponse {\n /** list of quotes */\n quotes?: ShippingLabelCarrierQuote[];\n }\n interface ShippingLabelCarrierSpiConfig {\n /** the countries supported to send from */\n originCountries?: string[];\n /** the countries supported to send to */\n destinationCountries?: string[];\n /** the currency of the labels */\n currency?: string;\n /** the measurement system of he labels (Metric or Imperial) */\n measurementSystem?: MeasurementSystem;\n /** does carrier support insurance */\n isInsuranceSupported?: boolean;\n /** preset carrier packages */\n packageTypes?: PackageType[];\n }\n enum MeasurementSystem {\n Metric = \"Metric\",\n Imperial = \"Imperial\"\n }\n interface PackageType {\n /** carrier id that can be used to get quotes and purchase */\n _id?: string;\n /** display name of the package (translated) */\n name?: string;\n /** description (translated) */\n description?: string;\n /** the dimensions of the package */\n dimension?: PackageDimension;\n /** image of the package (Optional) */\n image?: Image;\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 /** Image alt text. Optional. */\n altText?: string | null;\n /**\n * Optional - Image URL expiry date (when relevant).\n * @internal\n */\n urlExpirationDate?: Date;\n /** Optional - Image filename. */\n filename?: string | null;\n /**\n * Optional - Image size in bytes.\n * @internal\n */\n sizeInBytes?: string | null;\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 GetQuotesOptions {\n /** address and contact details of sender */\n originAddressWithContact?: AddressWithContact;\n /** address and contact details of receiver */\n destinationAddressWithContact?: AddressWithContact;\n /** carrier specific key for preset package types (Optional) */\n packageTypeId?: string | null;\n /** package dimension */\n packageDimension?: PackageDimension;\n /** weight of the package */\n weight?: number;\n /** require signature from receiver */\n requireSignature?: boolean | null;\n /** value for insurance */\n insuranceValue?: string | null;\n /** international customs information */\n internationalCustomsInfo?: InternationalCustomsInfo;\n }\n \n export { Address, AddressLocation, AddressWithContact, BusinessError, Context, FullAddressContactDetails, GetQuotesOptions, GetQuotesRequest, GetQuotesResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, Image, InternationalCustomsInfo, ItemDetails, MeasurementSystem, PackageContentType, PackageDimension, PackageType, ShippingLabelCarrierQuote, ShippingLabelCarrierSpiConfig, ShippingLabelQuoteDetail, StreetAddress, VatId, VatType };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-ecom-v1-gift-card-provider-entity.d.ts", "content": "declare module \"interfaces-ecom-v1-gift-card-provider-entity\" {\n interface GiftCardProviderEntity {\n }\n interface GetBalanceRequest {\n /** Gift Card unique code */\n code?: string;\n /** Gift Card provider app instance id */\n appInstanceId?: string;\n }\n interface GetBalanceResponse {\n /** Current Gift Card balance */\n balance?: number;\n /** The currency code of the Gift Card */\n currencyCode?: string;\n }\n interface RedeemRequest {\n /** Gift Card unique code */\n code?: string;\n /** Gift Card provider app instance id */\n appInstanceId?: string;\n /** Amount to redeem from the given Gift Card */\n amount?: number;\n /** Idempotency key for the current transaction */\n orderId?: string;\n /** The currency code to redeem */\n currencyCode?: string;\n }\n interface RedeemResponse {\n /** Remaining balance of the Gift Card after the redeem */\n remainingBalance?: number;\n /** The currency code of the Gift Card */\n currencyCode?: string;\n /** Id of the redeem transaction */\n transactionId?: string;\n }\n interface VoidRequest {\n /** Gift Card provider app instance id */\n appInstanceId?: string;\n /** Transaction id to void */\n transactionId?: string;\n }\n interface VoidResponse {\n /** Remaining balance of the Gift Card after void */\n remainingBalance?: number;\n /** The currency code of the Gift Card */\n currencyCode?: string;\n }\n interface GiftCardProviderConfig {\n }\n interface GetBalanceOptions {\n /** Gift Card unique code */\n code?: string;\n /** Gift Card provider app instance id */\n appInstanceId?: string;\n }\n interface RedeemOptions {\n /** Gift Card unique code */\n code?: string;\n /** Gift Card provider app instance id */\n appInstanceId?: string;\n /** Amount to redeem from the given Gift Card */\n amount?: number;\n /** Idempotency key for the current transaction */\n orderId?: string;\n /** The currency code to redeem */\n currencyCode?: string;\n }\n interface VoidOptions {\n /** Gift Card provider app instance id */\n appInstanceId?: string;\n /** Transaction id to void */\n transactionId?: string;\n }\n \n export { GetBalanceOptions, GetBalanceRequest, GetBalanceResponse, GiftCardProviderConfig, GiftCardProviderEntity, RedeemOptions, RedeemRequest, RedeemResponse, VoidOptions, VoidRequest, VoidResponse };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-notifications-backend.d.ts", "content": "declare module \"wix-notifications-backend\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface Notification {\n /** The id of the notification */\n _id?: string;\n }\n interface NotifyRequest {\n /**\n * Notification template ID. A notification template specifies the text and recipients for notifications.\n * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.\n */\n notificationTemplateId: string;\n /**\n * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).\n * The value is an object containing the text to replace the placeholder in the notifications.\n */\n dynamicValues?: Record;\n }\n interface DynamicValue extends DynamicValueOfTypeOneOf {\n /** Text to be integrated into the notification. */\n text?: string;\n /**\n * localized money parameter\n * @internal\n */\n money?: Money;\n /**\n * ISO 8601 timestamp\n * @internal\n */\n timestamp?: string;\n /**\n * map\n * @internal\n */\n map?: MapDynamicValue;\n /**\n * array\n * @internal\n */\n array?: ArrayDynamicValue;\n }\n /** @oneof */\n interface DynamicValueOfTypeOneOf {\n /** Text to be integrated into the notification. */\n text?: string;\n /**\n * localized money parameter\n * @internal\n */\n money?: Money;\n /**\n * ISO 8601 timestamp\n * @internal\n */\n timestamp?: string;\n /**\n * map\n * @internal\n */\n map?: MapDynamicValue;\n /**\n * array\n * @internal\n */\n array?: ArrayDynamicValue;\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 MapDynamicValue {\n /** items */\n items?: Record;\n }\n interface ArrayDynamicValue {\n /** items */\n items?: DynamicValue[];\n }\n interface NotifyResponse {\n /** ID of the batch of notifications triggered by one request. */\n notificationBatchId?: string;\n }\n interface NotifyByAppRequest {\n /** notification_template_id */\n notificationTemplateId: string;\n /** app_def_id */\n appDefId: string;\n /** dynamic_values */\n dynamicValues?: Record;\n /** template tenant */\n templateTenant?: string | null;\n /** overrides */\n overrides?: Overrides;\n }\n interface Overrides {\n /** excluded_channels */\n excludedChannels?: TemplateChannel[];\n /** excluded_audiences */\n excludedAudiences?: ExcludedAudiences;\n /** content overrides */\n content?: ChannelsContent;\n }\n enum TemplateChannel {\n WEB_FEED = \"WEB_FEED\",\n MOBILE_FEED = \"MOBILE_FEED\",\n MOBILE_PUSH = \"MOBILE_PUSH\",\n BROWSER = \"BROWSER\",\n SMS = \"SMS\",\n EMAIL = \"EMAIL\",\n KAFKA = \"KAFKA\",\n VOICE = \"VOICE\"\n }\n interface ExcludedAudiences {\n /** audience_key */\n audienceKey?: string[];\n }\n interface ChannelsContent {\n /** mobile push override */\n mobileContent?: MobileContent;\n }\n interface MobileContent {\n /** title override of mobile push content */\n title?: string;\n /** body override of mobile push content */\n body?: string;\n }\n interface NotifyByAppResponse {\n /** notification_batch_id */\n notificationBatchId?: string;\n }\n /**\n * Sends notifications based on the template and dynamic values provided.\n *\n * > This feature is not yet available to all users.\n *\n * An app can call this endpoint up to 100,000 times per month for each site.\n *\n * When you [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center, you are given a notification template ID.\n * Call the Notify endpoint with this ID as `notificationTemplateID` to trigger notifications based on the notification template.\n * If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the `dynamicValues` array.\n * The values you specify are incorporated seamlessly in the notifications sent out.\n * @param notificationTemplateId - Notification template ID. A notification template specifies the text and recipients for notifications.\n * To obtain a notification template ID, [create a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template) in the Wix Dev Center.\n * @public\n * @documentationMaturity preview\n * @requiredField notificationTemplateId\n */\n function notify(notificationTemplateId: string, options?: NotifyOptions): Promise;\n interface NotifyOptions {\n /**\n * Each key is a placeholder name you specify when [creating a notification template](https://dev.wix.com/api/rest/wix-notifications/notifications/creating-a-notification-template).\n * The value is an object containing the text to replace the placeholder in the notifications.\n */\n dynamicValues?: Record;\n }\n /**\n * NotifyByApp\n * @param notificationTemplateId - notification_template_id\n * @internal\n * @documentationMaturity preview\n * @requiredField notificationTemplateId\n * @requiredField options\n * @requiredField options.appDefId\n */\n function notifyByApp(notificationTemplateId: string, options: NotifyByAppOptions): Promise;\n interface NotifyByAppOptions {\n /** app_def_id */\n appDefId: string;\n /** dynamic_values */\n dynamicValues?: Record;\n /** template tenant */\n templateTenant?: string | null;\n /** overrides */\n overrides?: Overrides;\n }\n \n const pingNotificationsV3Notification_universal_d___debug: typeof __debug;\n type pingNotificationsV3Notification_universal_d_Notification = Notification;\n type pingNotificationsV3Notification_universal_d_NotifyRequest = NotifyRequest;\n type pingNotificationsV3Notification_universal_d_DynamicValue = DynamicValue;\n type pingNotificationsV3Notification_universal_d_DynamicValueOfTypeOneOf = DynamicValueOfTypeOneOf;\n type pingNotificationsV3Notification_universal_d_Money = Money;\n type pingNotificationsV3Notification_universal_d_MapDynamicValue = MapDynamicValue;\n type pingNotificationsV3Notification_universal_d_ArrayDynamicValue = ArrayDynamicValue;\n type pingNotificationsV3Notification_universal_d_NotifyResponse = NotifyResponse;\n type pingNotificationsV3Notification_universal_d_NotifyByAppRequest = NotifyByAppRequest;\n type pingNotificationsV3Notification_universal_d_Overrides = Overrides;\n type pingNotificationsV3Notification_universal_d_TemplateChannel = TemplateChannel;\n const pingNotificationsV3Notification_universal_d_TemplateChannel: typeof TemplateChannel;\n type pingNotificationsV3Notification_universal_d_ExcludedAudiences = ExcludedAudiences;\n type pingNotificationsV3Notification_universal_d_ChannelsContent = ChannelsContent;\n type pingNotificationsV3Notification_universal_d_MobileContent = MobileContent;\n type pingNotificationsV3Notification_universal_d_NotifyByAppResponse = NotifyByAppResponse;\n const pingNotificationsV3Notification_universal_d_notify: typeof notify;\n type pingNotificationsV3Notification_universal_d_NotifyOptions = NotifyOptions;\n const pingNotificationsV3Notification_universal_d_notifyByApp: typeof notifyByApp;\n type pingNotificationsV3Notification_universal_d_NotifyByAppOptions = NotifyByAppOptions;\n namespace pingNotificationsV3Notification_universal_d {\n export {\n pingNotificationsV3Notification_universal_d___debug as __debug,\n pingNotificationsV3Notification_universal_d_Notification as Notification,\n pingNotificationsV3Notification_universal_d_NotifyRequest as NotifyRequest,\n pingNotificationsV3Notification_universal_d_DynamicValue as DynamicValue,\n pingNotificationsV3Notification_universal_d_DynamicValueOfTypeOneOf as DynamicValueOfTypeOneOf,\n pingNotificationsV3Notification_universal_d_Money as Money,\n pingNotificationsV3Notification_universal_d_MapDynamicValue as MapDynamicValue,\n pingNotificationsV3Notification_universal_d_ArrayDynamicValue as ArrayDynamicValue,\n pingNotificationsV3Notification_universal_d_NotifyResponse as NotifyResponse,\n pingNotificationsV3Notification_universal_d_NotifyByAppRequest as NotifyByAppRequest,\n pingNotificationsV3Notification_universal_d_Overrides as Overrides,\n pingNotificationsV3Notification_universal_d_TemplateChannel as TemplateChannel,\n pingNotificationsV3Notification_universal_d_ExcludedAudiences as ExcludedAudiences,\n pingNotificationsV3Notification_universal_d_ChannelsContent as ChannelsContent,\n pingNotificationsV3Notification_universal_d_MobileContent as MobileContent,\n pingNotificationsV3Notification_universal_d_NotifyByAppResponse as NotifyByAppResponse,\n pingNotificationsV3Notification_universal_d_notify as notify,\n pingNotificationsV3Notification_universal_d_NotifyOptions as NotifyOptions,\n pingNotificationsV3Notification_universal_d_notifyByApp as notifyByApp,\n pingNotificationsV3Notification_universal_d_NotifyByAppOptions as NotifyByAppOptions,\n };\n }\n \n export { pingNotificationsV3Notification_universal_d as notifications };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-marketing-backend.v2.d.ts", "content": "declare module \"wix-marketing-backend.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\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 (should not be passed on creation). */\n _id?: string;\n /** Basic coupon metadata. */\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 interface Specification extends SpecificationScopeOrMinSubtotalOneOf, SpecificationBehaviorOneOf {\n /** Friendly name for display (up to 80 characters). */\n name?: string | null;\n /** Unique code entered to apply the coupon (up to 20 characters). */\n code?: string | null;\n /** Coupon valid from, in milliseconds (required). */\n startTime?: string | null;\n /** Coupon expiration time, in milliseconds (optional). */\n expirationTime?: string | null;\n /** Maximum number of times the coupon can be used (optional). */\n usageLimit?: number | null;\n /** Maximum number of times the coupon can be used **per customer** (optional). */\n limitPerCustomer?: number | null;\n /** Whether the coupon is limited to one item. */\n limitedToOneItem?: boolean | null;\n /** Whether the coupon applies to subscription products. */\n appliesToSubscriptions?: boolean | null;\n /**\n * Specifies the amount of discounted cycles for subscription item.\n * Can only be set when applies_to_subscriptions is true and scope namespace is 'pricingPlans'\n * Valid range is from 1 to 999, inclusive. Empty field specifies that the coupon applies to all available cycles.\n */\n discountedCycleCount?: number | null;\n /** Whether the coupon is currently active (if not passed - the default is active). */\n active?: boolean | null;\n /** Coupon type. Read-only. */\n type?: string;\n /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n scope?: Scope;\n /** Limit the coupon to carts with a subtotal above this number. */\n minimumSubtotal?: number | null;\n /** Discount as a fixed amount. */\n moneyOffAmount?: number;\n /** Discount as a percentage. */\n percentOffRate?: number;\n /** Free shipping. */\n freeShipping?: boolean;\n /** Fixed sale price. */\n fixedPriceAmount?: number;\n /** For example: buy 3, get 1. */\n buyXGetY?: BuyXGetY;\n }\n /** @oneof */\n interface SpecificationScopeOrMinSubtotalOneOf {\n /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */\n scope?: Scope;\n /** Limit the coupon to carts with a subtotal above this number. */\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 /** Free shipping. */\n freeShipping?: boolean;\n /** Fixed sale price. */\n fixedPriceAmount?: number;\n /** For example: buy 3, get 1. */\n buyXGetY?: BuyXGetY;\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 /** Coupon type and information */\n interface BuyXGetY {\n /** Coupon type and information */\n x?: number;\n /** Coupon type and information */\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 metadata. ID is ignored and created by the server. */\n specification?: Specification;\n }\n interface CreateCouponResponse {\n /** ID of the newly created coupon. */\n _id?: string;\n }\n interface UpdateCouponRequest {\n /** Coupon ID. */\n _id: string;\n /** 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 fieldMask?: string[];\n /** Coupon metadata to change. Changing the type is not allowed. */\n specification?: Specification;\n }\n interface UpdateCouponResponse {\n }\n interface GetCouponRequest {\n /** Coupon ID. */\n _id: string;\n }\n interface GetCouponResponse {\n /** Requested coupon. */\n coupon?: Coupon;\n }\n interface DeleteCouponRequest {\n /** Coupon ID. */\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 /** 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 /** 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 /** @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 /** List of coupon IDs 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 code?: string;\n description?: string;\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 /** Whether to return full coupon entity in the response. Defaults to `false`. */\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 coupon. */\n coupon?: Coupon;\n }\n /**\n * Creates a new coupon.\n * @public\n * @documentationMaturity preview\n */\n function create(options?: CreateOptions): Promise;\n interface CreateOptions {\n /** Coupon metadata. ID is ignored and created by the server. */\n specification?: Specification;\n }\n /**\n * Updates a coupon (coupon type can't be changed).\n * @param _id - Coupon ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function update(_id: string, options?: UpdateOptions): Promise;\n interface UpdateOptions {\n /** 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 fieldMask?: string[];\n /** Coupon metadata to change. Changing the type is not allowed. */\n specification?: Specification;\n }\n /**\n * Retrieves a coupon by ID.\n * @param _id - Coupon ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @returns Requested coupon.\n */\n function get(_id: string): Promise;\n /**\n * Deletes a coupon by ID.\n * @param _id - Coupon ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function _delete(_id: string): Promise;\n /**\n * Retrieves a list of coupons with pagination and filters.\n * A maximum of 100 coupons will be returned per request.\n * @public\n * @documentationMaturity preview\n */\n function query(options?: QueryOptions): Promise;\n interface QueryOptions {\n query?: Query;\n }\n /**\n * Calculate a cart's total price after applying a coupon.\n * Pass the Cart with line items and shipping, and the cart will be returned\n * along with its coupon's calculations applied.\n * @param code - For calculating by coupon code (usually for apply coupon phase - for validation).\n * @internal\n * @documentationMaturity preview\n * @requiredField code\n */\n function calculateCart(code: string, options?: CalculateCartOptions): Promise;\n interface CalculateCartOptions {\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 /**\n * It is the responsibility of the payment process to call this endpoint after\n * the coupon was used.\n * @param _id - Coupon ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n */\n function increaseUsage(_id: string, options?: IncreaseUsageOptions): Promise;\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 * Returns true if the site has ever had any coupons (even if they have all been deleted or deactivated).\n * @internal\n * @documentationMaturity preview\n */\n function hasCoupons(): Promise;\n /**\n * Deletes multiple coupons.\n * @public\n * @documentationMaturity preview\n */\n function bulkDeleteCoupons(options?: BulkDeleteCouponsOptions): Promise;\n interface BulkDeleteCouponsOptions {\n /** List of coupon IDs to delete. */\n ids?: string[];\n }\n /**\n * Creates multiple new coupons.\n * @public\n * @documentationMaturity preview\n */\n function bulkCreateCoupons(options?: BulkCreateCouponsOptions): Promise;\n interface BulkCreateCouponsOptions {\n /** List of coupon specifications to be created. */\n specifications?: Specification[];\n /** Whether to return full coupon entity in the response. Defaults to `false`. */\n returnFullEntity?: boolean;\n }\n \n const ecommerceCouponsV2Coupon_universal_d___debug: typeof __debug;\n type ecommerceCouponsV2Coupon_universal_d_Coupon = Coupon;\n type ecommerceCouponsV2Coupon_universal_d_MediaItem = MediaItem;\n type ecommerceCouponsV2Coupon_universal_d_Specification = Specification;\n type ecommerceCouponsV2Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf = SpecificationScopeOrMinSubtotalOneOf;\n type ecommerceCouponsV2Coupon_universal_d_SpecificationBehaviorOneOf = SpecificationBehaviorOneOf;\n type ecommerceCouponsV2Coupon_universal_d_Scope = Scope;\n type ecommerceCouponsV2Coupon_universal_d_Group = Group;\n type ecommerceCouponsV2Coupon_universal_d_BuyXGetY = BuyXGetY;\n type ecommerceCouponsV2Coupon_universal_d_DisplayData = DisplayData;\n type ecommerceCouponsV2Coupon_universal_d_CreateCouponRequest = CreateCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_CreateCouponResponse = CreateCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_UpdateCouponRequest = UpdateCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_UpdateCouponResponse = UpdateCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_GetCouponRequest = GetCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_GetCouponResponse = GetCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_DeleteCouponRequest = DeleteCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_DeleteCouponResponse = DeleteCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_QueryCouponsRequest = QueryCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_Query = Query;\n type ecommerceCouponsV2Coupon_universal_d_Paging = Paging;\n type ecommerceCouponsV2Coupon_universal_d_QueryCouponsResponse = QueryCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_CalculateRequest = CalculateRequest;\n type ecommerceCouponsV2Coupon_universal_d_CalculateRequestCalculateByOneOf = CalculateRequestCalculateByOneOf;\n type ecommerceCouponsV2Coupon_universal_d_Cart = Cart;\n type ecommerceCouponsV2Coupon_universal_d_AppliedDiscount = AppliedDiscount;\n type ecommerceCouponsV2Coupon_universal_d_LineItem = LineItem;\n type ecommerceCouponsV2Coupon_universal_d_Shipping = Shipping;\n type ecommerceCouponsV2Coupon_universal_d_Totals = Totals;\n type ecommerceCouponsV2Coupon_universal_d_CalculateResponse = CalculateResponse;\n type ecommerceCouponsV2Coupon_universal_d_AppliedCoupon = AppliedCoupon;\n type ecommerceCouponsV2Coupon_universal_d_Error = Error;\n type ecommerceCouponsV2Coupon_universal_d_IncreaseUsageRequest = IncreaseUsageRequest;\n type ecommerceCouponsV2Coupon_universal_d_IncreaseUsageResponse = IncreaseUsageResponse;\n type ecommerceCouponsV2Coupon_universal_d_CouponApplied = CouponApplied;\n type ecommerceCouponsV2Coupon_universal_d_HasCouponsRequest = HasCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_HasCouponsResponse = HasCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsRequest = BulkDeleteCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsResponse = BulkDeleteCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_ItemMetadata = ItemMetadata;\n type ecommerceCouponsV2Coupon_universal_d_ApplicationError = ApplicationError;\n type ecommerceCouponsV2Coupon_universal_d_BulkActionMetadata = BulkActionMetadata;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsRequest = BulkCreateCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsResponse = BulkCreateCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponResult = BulkCreateCouponResult;\n const ecommerceCouponsV2Coupon_universal_d_create: typeof create;\n type ecommerceCouponsV2Coupon_universal_d_CreateOptions = CreateOptions;\n const ecommerceCouponsV2Coupon_universal_d_update: typeof update;\n type ecommerceCouponsV2Coupon_universal_d_UpdateOptions = UpdateOptions;\n const ecommerceCouponsV2Coupon_universal_d_get: typeof get;\n const ecommerceCouponsV2Coupon_universal_d__delete: typeof _delete;\n const ecommerceCouponsV2Coupon_universal_d_query: typeof query;\n type ecommerceCouponsV2Coupon_universal_d_QueryOptions = QueryOptions;\n const ecommerceCouponsV2Coupon_universal_d_calculateCart: typeof calculateCart;\n type ecommerceCouponsV2Coupon_universal_d_CalculateCartOptions = CalculateCartOptions;\n const ecommerceCouponsV2Coupon_universal_d_increaseUsage: typeof increaseUsage;\n type ecommerceCouponsV2Coupon_universal_d_IncreaseUsageOptions = IncreaseUsageOptions;\n const ecommerceCouponsV2Coupon_universal_d_hasCoupons: typeof hasCoupons;\n const ecommerceCouponsV2Coupon_universal_d_bulkDeleteCoupons: typeof bulkDeleteCoupons;\n type ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsOptions = BulkDeleteCouponsOptions;\n const ecommerceCouponsV2Coupon_universal_d_bulkCreateCoupons: typeof bulkCreateCoupons;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsOptions = BulkCreateCouponsOptions;\n namespace ecommerceCouponsV2Coupon_universal_d {\n export {\n ecommerceCouponsV2Coupon_universal_d___debug as __debug,\n ecommerceCouponsV2Coupon_universal_d_Coupon as Coupon,\n ecommerceCouponsV2Coupon_universal_d_MediaItem as MediaItem,\n ecommerceCouponsV2Coupon_universal_d_Specification as Specification,\n ecommerceCouponsV2Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf as SpecificationScopeOrMinSubtotalOneOf,\n ecommerceCouponsV2Coupon_universal_d_SpecificationBehaviorOneOf as SpecificationBehaviorOneOf,\n ecommerceCouponsV2Coupon_universal_d_Scope as Scope,\n ecommerceCouponsV2Coupon_universal_d_Group as Group,\n ecommerceCouponsV2Coupon_universal_d_BuyXGetY as BuyXGetY,\n ecommerceCouponsV2Coupon_universal_d_DisplayData as DisplayData,\n ecommerceCouponsV2Coupon_universal_d_CreateCouponRequest as CreateCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_CreateCouponResponse as CreateCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_UpdateCouponRequest as UpdateCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_UpdateCouponResponse as UpdateCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_GetCouponRequest as GetCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_GetCouponResponse as GetCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_DeleteCouponRequest as DeleteCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_DeleteCouponResponse as DeleteCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_QueryCouponsRequest as QueryCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_Query as Query,\n ecommerceCouponsV2Coupon_universal_d_Paging as Paging,\n ecommerceCouponsV2Coupon_universal_d_QueryCouponsResponse as QueryCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_CalculateRequest as CalculateRequest,\n ecommerceCouponsV2Coupon_universal_d_CalculateRequestCalculateByOneOf as CalculateRequestCalculateByOneOf,\n ecommerceCouponsV2Coupon_universal_d_Cart as Cart,\n ecommerceCouponsV2Coupon_universal_d_AppliedDiscount as AppliedDiscount,\n ecommerceCouponsV2Coupon_universal_d_LineItem as LineItem,\n ecommerceCouponsV2Coupon_universal_d_Shipping as Shipping,\n ecommerceCouponsV2Coupon_universal_d_Totals as Totals,\n ecommerceCouponsV2Coupon_universal_d_CalculateResponse as CalculateResponse,\n ecommerceCouponsV2Coupon_universal_d_AppliedCoupon as AppliedCoupon,\n ecommerceCouponsV2Coupon_universal_d_Error as Error,\n ecommerceCouponsV2Coupon_universal_d_IncreaseUsageRequest as IncreaseUsageRequest,\n ecommerceCouponsV2Coupon_universal_d_IncreaseUsageResponse as IncreaseUsageResponse,\n ecommerceCouponsV2Coupon_universal_d_CouponApplied as CouponApplied,\n ecommerceCouponsV2Coupon_universal_d_HasCouponsRequest as HasCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_HasCouponsResponse as HasCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsRequest as BulkDeleteCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsResponse as BulkDeleteCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_ItemMetadata as ItemMetadata,\n ecommerceCouponsV2Coupon_universal_d_ApplicationError as ApplicationError,\n ecommerceCouponsV2Coupon_universal_d_BulkActionMetadata as BulkActionMetadata,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsRequest as BulkCreateCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsResponse as BulkCreateCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponResult as BulkCreateCouponResult,\n ecommerceCouponsV2Coupon_universal_d_create as create,\n ecommerceCouponsV2Coupon_universal_d_CreateOptions as CreateOptions,\n ecommerceCouponsV2Coupon_universal_d_update as update,\n ecommerceCouponsV2Coupon_universal_d_UpdateOptions as UpdateOptions,\n ecommerceCouponsV2Coupon_universal_d_get as get,\n ecommerceCouponsV2Coupon_universal_d__delete as _delete,\n ecommerceCouponsV2Coupon_universal_d_query as query,\n ecommerceCouponsV2Coupon_universal_d_QueryOptions as QueryOptions,\n ecommerceCouponsV2Coupon_universal_d_calculateCart as calculateCart,\n ecommerceCouponsV2Coupon_universal_d_CalculateCartOptions as CalculateCartOptions,\n ecommerceCouponsV2Coupon_universal_d_increaseUsage as increaseUsage,\n ecommerceCouponsV2Coupon_universal_d_IncreaseUsageOptions as IncreaseUsageOptions,\n ecommerceCouponsV2Coupon_universal_d_hasCoupons as hasCoupons,\n ecommerceCouponsV2Coupon_universal_d_bulkDeleteCoupons as bulkDeleteCoupons,\n ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsOptions as BulkDeleteCouponsOptions,\n ecommerceCouponsV2Coupon_universal_d_bulkCreateCoupons as bulkCreateCoupons,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsOptions as BulkCreateCouponsOptions,\n };\n }\n \n export { ecommerceCouponsV2Coupon_universal_d as coupons };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-groups-backend.v3.d.ts", "content": "declare module \"wix-groups-backend.v3\" {\n /**\n * >**Notes:**\n * > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.\n * > + In this situation, site members have to submit a Create Request to create a new group.\n * > + Create Requests can be approved or rejected by an admin.\n * > + After a Create Request has been approved, the new group is added to the Group List in the Wix Groups app home page.\n * > + See [Introduction](https://dev.wix.com/api/rest/wix-groups/groups/introduction#wix-groups_groups_introduction_terminology) for more details.\n */\n interface CreateRequest {\n /**\n * Create request ID\n * @readonly\n */\n _id?: string | null;\n /** Group requested for creation. */\n group?: Group;\n /**\n * Status of request.\n * - `PENDING` - Pending request.\n * - `APPROVED` - Approved request.\n * - `REJECTED` - Rejected request.\n * - `CANCELED` - Canceled request.\n */\n status?: RequestStatus$1;\n /** Request details. */\n requestDetails?: RequestDetails$1;\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 /**\n * __Deprecated.__ Use `privacyStatus` instead.\n * This property will be removed on June 30, 2022.\n */\n privacyLevel?: PrivacyStatus;\n /**\n * Group privacy status.\n * - `PUBLIC` - Anyone can see the group and its content. Anyone can join the group.\n * - `PRIVATE` - Anyone can see the group, but only members can see its content. New member must submit a `Join Group Request`.\n * - `SECRET` - Only admins and members can see the group. New members can only be added by other members.\n */\n privacyStatus?: PrivacyStatus;\n /** @internal */\n accessRestriction?: AccessRestriction;\n /**\n * __Deprecated.__ Use `name` instead.\n * This property will be removed on June 30, 2022.\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group description in DraftJS format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * __Deprecated.__\n * For `details.logo`, use `coverImage` instead.\n * For `details.membersTitle`, `memberTitle` instead.\n * This property will be removed on June 30, 2022.\n */\n details?: GroupDetails;\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 /** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */\n settings?: GroupSettings;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * __Deprecated.__ Use `ownerId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n createdBy?: Identity;\n /**\n * Group owner.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Group creation date and time.\n * @readonly\n */\n _createdDate?: Date;\n /**\n * Date and time of the latest group update.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * __Deprecated.__ Use `lastActivityDate` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n */\n recentActivityDate?: Date;\n /**\n * Date and time of the most recent group activity, for example a post or comment.\n * @readonly\n */\n lastActivityDate?: Date;\n /**\n * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | 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 /**\n * Logo image file URL.\n * @internal\n */\n fileUrl?: 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 /**\n * Image file URL.\n * @internal\n */\n fileUrl?: string | null;\n /** Image width. */\n width?: number | null;\n /** Image height. */\n height?: number | 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 UNKNOWN = \"UNKNOWN\",\n /** Anyone can see the group in the group list and view its content. Anyone can join. */\n PUBLIC = \"PUBLIC\",\n /** Anyone can see the group in the group list, but only group members can see its content. In order to join a group, a group join request must be submitted. */\n PRIVATE = \"PRIVATE\",\n /** Only group members and admins can see the group in the group list. New group members can only be added by existing group 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 * Position of the corner of the cover image (or logo).\n * @internal\n */\n logoPosition?: GroupDetailsPosition;\n /**\n * Position of the corner of the cover image (or logo) for mobile browser.\n * @internal\n */\n mobileLogoPosition?: GroupDetailsPosition;\n }\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 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 */\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 */\n membersCanApprove?: boolean | null;\n /**\n * __Deprecated.__ Use `welcomeMemberPostEnabled` instead.\n * This property will be removed on June 30, 2022.\n */\n memberWelcomePostEnabled?: 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 /**\n * Whether an automatic post about added events is enabled.\n * @internal\n */\n eventAddedPostEnabled?: boolean | null;\n /**\n * Determines who can invite members to the group\n * @internal\n */\n allowedToInviteMembers?: AllowPolicy;\n /**\n * Determines who can approve member join requests to the group\n * @internal\n */\n allowedToApproveJoinRequests?: AllowPolicy;\n /**\n * Determines who can add site members to the group\n * @internal\n */\n allowedToAddMembers?: AllowPolicy;\n /**\n * Determines who can create posts in the group\n * @internal\n */\n allowedToCreatePosts?: AllowPolicy;\n /**\n * Determines who can comment posts in the group\n * @internal\n */\n allowedToCommentPosts?: AllowPolicy;\n onboardingStepsSettings?: OnboardingStepSettings[];\n }\n interface Identity {\n /** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n _id?: string | null;\n identityType?: IdentityType;\n }\n enum IdentityType {\n USER = \"USER\",\n MEMBER = \"MEMBER\"\n }\n enum RequestStatus$1 {\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$1 {\n /** Reason the request has been rejected. */\n rejectionReason?: string | null;\n }\n interface SubmitCreateRequestRequest {\n /** Group submitted for creation. */\n group?: Group;\n }\n interface SubmitCreateRequestResponse {\n /** Submitted Create Request. */\n createRequest?: CreateRequest;\n }\n interface ApproveCreateRequestsRequest {\n /**\n * Which items to approve.\n * @internal\n */\n itemsToApprove?: ItemsToUpdate$1;\n /** Create Request IDs to approve. Limited to `100`. */\n createRequestIds?: string[];\n }\n enum ItemsToUpdate$1 {\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 ApproveCreateRequestsResponse {\n /** Approved Create Requests. */\n createRequest?: CreateRequest[];\n }\n interface CreateRequestApproved {\n /** Approved create request. */\n createRequest?: CreateRequest;\n }\n interface RejectCreateRequestsRequest {\n /**\n * Which items to reject.\n * @internal\n */\n itemsToReject?: ItemsToUpdate$1;\n /** Rejection data. */\n rejections?: Rejection$1[];\n }\n interface Rejection$1 {\n /** ID of the Create Request to reject. */\n createRequestId?: string;\n /** Rejection reason. Free text displayed to the creator of the rejected Create Request. Limited to 1,000 characters. */\n reason?: string | null;\n }\n interface RejectCreateRequestsResponse {\n /** Rejected Create Requests. */\n createRequest?: CreateRequest[];\n }\n interface CreateRequestRejected {\n /** Rejected create request. */\n createRequest?: CreateRequest;\n }\n interface CancelCreateRequestRequest {\n /** ID of the Create Request to cancel. */\n createRequestId: string;\n }\n interface CancelCreateRequestResponse {\n /** Canceled Create Request. */\n createRequest?: CreateRequest;\n }\n interface ListCreateRequestsRequest {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All Create requests.\n * - `CURRENT_MEMBER` - Create requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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 }\n enum OwnershipFilter$1 {\n /** All items. */\n ALL = \"ALL\",\n /** Items for current site member. */\n CURRENT_MEMBER = \"CURRENT_MEMBER\"\n }\n interface ListCreateRequestsResponse {\n /** Create Requests. */\n createRequests?: CreateRequest[];\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryCreateRequestsRequest {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All create requests.\n * - `CURRENT_MEMBER` - Create requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryCreateRequestsResponse {\n /** Retrieved Create Requests. */\n createRequests?: CreateRequest[];\n metadata?: PagingMetadata$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 * Submit a create request.\n * Can be used in case `GroupsAppSettings.create_groups_policy` = `MEMBERS_WITH_APPROVAL`.\n * This endpoint doesn't support server signing.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function submitCreateRequest(options?: SubmitCreateRequestOptions): Promise;\n interface SubmitCreateRequestOptions {\n /** Group submitted for creation. */\n group?: Group;\n }\n /**\n * Approves Create Requests.\n * Only admins can approve Create Requests.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function approveCreateRequests(options?: ApproveCreateRequestsOptions): Promise;\n interface ApproveCreateRequestsOptions {\n /**\n * Which items to approve.\n * @internal\n */\n itemsToApprove?: ItemsToUpdate$1;\n /** Create Request IDs to approve. Limited to `100`. */\n createRequestIds?: string[];\n }\n /**\n * Rejects Create Requests.\n * Only admins can reject Create Requests.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function rejectCreateRequests(options?: RejectCreateRequestsOptions): Promise;\n interface RejectCreateRequestsOptions {\n /**\n * Which items to reject.\n * @internal\n */\n itemsToReject?: ItemsToUpdate$1;\n /** Rejection data. */\n rejections?: Rejection$1[];\n }\n /**\n * Cancels a Create Request.\n * Group managers always have access to this functionality. Site members can cancel their own create requests.\n * This endpoint doesn't support server signing.\n * @param createRequestId - ID of the Create Request to cancel.\n * @internal\n * @documentationMaturity preview\n * @requiredField createRequestId\n * @adminMethod\n */\n function cancelCreateRequest(createRequestId: string): Promise;\n /**\n * Lists create requests across the site.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function listCreateRequests(options?: ListCreateRequestsOptions): Promise;\n interface ListCreateRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All Create requests.\n * - `CURRENT_MEMBER` - Create requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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 }\n /**\n * Retrieves a list of create requests across the site.\n *\n * Supported fields for filtering:\n * - `status`\n *\n * Supported fields for sorting:\n * - `createdDate`\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryCreateRequests(options?: QueryCreateRequestsOptions): Promise;\n interface QueryCreateRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All create requests.\n * - `CURRENT_MEMBER` - Create requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\n query?: Query$1;\n }\n \n type socialGroupsV3CreateRequest_universal_d_CreateRequest = CreateRequest;\n type socialGroupsV3CreateRequest_universal_d_Group = Group;\n type socialGroupsV3CreateRequest_universal_d_Type = Type;\n const socialGroupsV3CreateRequest_universal_d_Type: typeof Type;\n type socialGroupsV3CreateRequest_universal_d_Events = Events;\n type socialGroupsV3CreateRequest_universal_d_Logo = Logo;\n type socialGroupsV3CreateRequest_universal_d_GroupDetailsPosition = GroupDetailsPosition;\n type socialGroupsV3CreateRequest_universal_d_Image = Image;\n type socialGroupsV3CreateRequest_universal_d_Position = Position;\n type socialGroupsV3CreateRequest_universal_d_AllowPolicy = AllowPolicy;\n const socialGroupsV3CreateRequest_universal_d_AllowPolicy: typeof AllowPolicy;\n type socialGroupsV3CreateRequest_universal_d_OnboardingStepSettings = OnboardingStepSettings;\n type socialGroupsV3CreateRequest_universal_d_StepKey = StepKey;\n const socialGroupsV3CreateRequest_universal_d_StepKey: typeof StepKey;\n type socialGroupsV3CreateRequest_universal_d_PrivacyStatus = PrivacyStatus;\n const socialGroupsV3CreateRequest_universal_d_PrivacyStatus: typeof PrivacyStatus;\n type socialGroupsV3CreateRequest_universal_d_AccessRestriction = AccessRestriction;\n type socialGroupsV3CreateRequest_universal_d_AccessRestrictionDataOneOf = AccessRestrictionDataOneOf;\n type socialGroupsV3CreateRequest_universal_d_GroupDetails = GroupDetails;\n type socialGroupsV3CreateRequest_universal_d_CoverImage = CoverImage;\n type socialGroupsV3CreateRequest_universal_d_GroupSettings = GroupSettings;\n type socialGroupsV3CreateRequest_universal_d_Identity = Identity;\n type socialGroupsV3CreateRequest_universal_d_IdentityType = IdentityType;\n const socialGroupsV3CreateRequest_universal_d_IdentityType: typeof IdentityType;\n type socialGroupsV3CreateRequest_universal_d_SubmitCreateRequestRequest = SubmitCreateRequestRequest;\n type socialGroupsV3CreateRequest_universal_d_SubmitCreateRequestResponse = SubmitCreateRequestResponse;\n type socialGroupsV3CreateRequest_universal_d_ApproveCreateRequestsRequest = ApproveCreateRequestsRequest;\n type socialGroupsV3CreateRequest_universal_d_ApproveCreateRequestsResponse = ApproveCreateRequestsResponse;\n type socialGroupsV3CreateRequest_universal_d_CreateRequestApproved = CreateRequestApproved;\n type socialGroupsV3CreateRequest_universal_d_RejectCreateRequestsRequest = RejectCreateRequestsRequest;\n type socialGroupsV3CreateRequest_universal_d_RejectCreateRequestsResponse = RejectCreateRequestsResponse;\n type socialGroupsV3CreateRequest_universal_d_CreateRequestRejected = CreateRequestRejected;\n type socialGroupsV3CreateRequest_universal_d_CancelCreateRequestRequest = CancelCreateRequestRequest;\n type socialGroupsV3CreateRequest_universal_d_CancelCreateRequestResponse = CancelCreateRequestResponse;\n type socialGroupsV3CreateRequest_universal_d_ListCreateRequestsRequest = ListCreateRequestsRequest;\n type socialGroupsV3CreateRequest_universal_d_ListCreateRequestsResponse = ListCreateRequestsResponse;\n type socialGroupsV3CreateRequest_universal_d_QueryCreateRequestsRequest = QueryCreateRequestsRequest;\n type socialGroupsV3CreateRequest_universal_d_QueryCreateRequestsResponse = QueryCreateRequestsResponse;\n const socialGroupsV3CreateRequest_universal_d_submitCreateRequest: typeof submitCreateRequest;\n type socialGroupsV3CreateRequest_universal_d_SubmitCreateRequestOptions = SubmitCreateRequestOptions;\n const socialGroupsV3CreateRequest_universal_d_approveCreateRequests: typeof approveCreateRequests;\n type socialGroupsV3CreateRequest_universal_d_ApproveCreateRequestsOptions = ApproveCreateRequestsOptions;\n const socialGroupsV3CreateRequest_universal_d_rejectCreateRequests: typeof rejectCreateRequests;\n type socialGroupsV3CreateRequest_universal_d_RejectCreateRequestsOptions = RejectCreateRequestsOptions;\n const socialGroupsV3CreateRequest_universal_d_cancelCreateRequest: typeof cancelCreateRequest;\n const socialGroupsV3CreateRequest_universal_d_listCreateRequests: typeof listCreateRequests;\n type socialGroupsV3CreateRequest_universal_d_ListCreateRequestsOptions = ListCreateRequestsOptions;\n const socialGroupsV3CreateRequest_universal_d_queryCreateRequests: typeof queryCreateRequests;\n type socialGroupsV3CreateRequest_universal_d_QueryCreateRequestsOptions = QueryCreateRequestsOptions;\n namespace socialGroupsV3CreateRequest_universal_d {\n export {\n socialGroupsV3CreateRequest_universal_d_CreateRequest as CreateRequest,\n socialGroupsV3CreateRequest_universal_d_Group as Group,\n socialGroupsV3CreateRequest_universal_d_Type as Type,\n socialGroupsV3CreateRequest_universal_d_Events as Events,\n socialGroupsV3CreateRequest_universal_d_Logo as Logo,\n socialGroupsV3CreateRequest_universal_d_GroupDetailsPosition as GroupDetailsPosition,\n socialGroupsV3CreateRequest_universal_d_Image as Image,\n socialGroupsV3CreateRequest_universal_d_Position as Position,\n socialGroupsV3CreateRequest_universal_d_AllowPolicy as AllowPolicy,\n socialGroupsV3CreateRequest_universal_d_OnboardingStepSettings as OnboardingStepSettings,\n socialGroupsV3CreateRequest_universal_d_StepKey as StepKey,\n socialGroupsV3CreateRequest_universal_d_PrivacyStatus as PrivacyStatus,\n socialGroupsV3CreateRequest_universal_d_AccessRestriction as AccessRestriction,\n socialGroupsV3CreateRequest_universal_d_AccessRestrictionDataOneOf as AccessRestrictionDataOneOf,\n socialGroupsV3CreateRequest_universal_d_GroupDetails as GroupDetails,\n socialGroupsV3CreateRequest_universal_d_CoverImage as CoverImage,\n socialGroupsV3CreateRequest_universal_d_GroupSettings as GroupSettings,\n socialGroupsV3CreateRequest_universal_d_Identity as Identity,\n socialGroupsV3CreateRequest_universal_d_IdentityType as IdentityType,\n RequestStatus$1 as RequestStatus,\n RequestDetails$1 as RequestDetails,\n socialGroupsV3CreateRequest_universal_d_SubmitCreateRequestRequest as SubmitCreateRequestRequest,\n socialGroupsV3CreateRequest_universal_d_SubmitCreateRequestResponse as SubmitCreateRequestResponse,\n socialGroupsV3CreateRequest_universal_d_ApproveCreateRequestsRequest as ApproveCreateRequestsRequest,\n ItemsToUpdate$1 as ItemsToUpdate,\n socialGroupsV3CreateRequest_universal_d_ApproveCreateRequestsResponse as ApproveCreateRequestsResponse,\n socialGroupsV3CreateRequest_universal_d_CreateRequestApproved as CreateRequestApproved,\n socialGroupsV3CreateRequest_universal_d_RejectCreateRequestsRequest as RejectCreateRequestsRequest,\n Rejection$1 as Rejection,\n socialGroupsV3CreateRequest_universal_d_RejectCreateRequestsResponse as RejectCreateRequestsResponse,\n socialGroupsV3CreateRequest_universal_d_CreateRequestRejected as CreateRequestRejected,\n socialGroupsV3CreateRequest_universal_d_CancelCreateRequestRequest as CancelCreateRequestRequest,\n socialGroupsV3CreateRequest_universal_d_CancelCreateRequestResponse as CancelCreateRequestResponse,\n socialGroupsV3CreateRequest_universal_d_ListCreateRequestsRequest as ListCreateRequestsRequest,\n OwnershipFilter$1 as OwnershipFilter,\n socialGroupsV3CreateRequest_universal_d_ListCreateRequestsResponse as ListCreateRequestsResponse,\n PagingMetadata$1 as PagingMetadata,\n socialGroupsV3CreateRequest_universal_d_QueryCreateRequestsRequest as QueryCreateRequestsRequest,\n Query$1 as Query,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$1 as Paging,\n socialGroupsV3CreateRequest_universal_d_QueryCreateRequestsResponse as QueryCreateRequestsResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n socialGroupsV3CreateRequest_universal_d_submitCreateRequest as submitCreateRequest,\n socialGroupsV3CreateRequest_universal_d_SubmitCreateRequestOptions as SubmitCreateRequestOptions,\n socialGroupsV3CreateRequest_universal_d_approveCreateRequests as approveCreateRequests,\n socialGroupsV3CreateRequest_universal_d_ApproveCreateRequestsOptions as ApproveCreateRequestsOptions,\n socialGroupsV3CreateRequest_universal_d_rejectCreateRequests as rejectCreateRequests,\n socialGroupsV3CreateRequest_universal_d_RejectCreateRequestsOptions as RejectCreateRequestsOptions,\n socialGroupsV3CreateRequest_universal_d_cancelCreateRequest as cancelCreateRequest,\n socialGroupsV3CreateRequest_universal_d_listCreateRequests as listCreateRequests,\n socialGroupsV3CreateRequest_universal_d_ListCreateRequestsOptions as ListCreateRequestsOptions,\n socialGroupsV3CreateRequest_universal_d_queryCreateRequests as queryCreateRequests,\n socialGroupsV3CreateRequest_universal_d_QueryCreateRequestsOptions as QueryCreateRequestsOptions,\n };\n }\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 JoinRequest {\n /**\n * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details.\n * @readonly\n */\n memberId?: string;\n /**\n * Join request status.\n * - `PENDING` - Pending join request.\n * - `APPROVED` - Approved join request.\n * - `REJECTED` - Rejected join request.\n * - `CANCELED` - Canceled join request.\n */\n status?: RequestStatus;\n /** Join request details. */\n requestDetails?: RequestDetails;\n /**\n * Date and time the request was created.\n * @internal\n * @readonly\n */\n _createdDate?: Date;\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 has been rejected. */\n rejectionReason?: string | null;\n }\n interface SubmitJoinRequestRequest {\n /** Relevant group. */\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 /** Answer to a membership question. */\n interface MembershipQuestionAnswer {\n /** Question ID. */\n _id?: string;\n /** Answer text. */\n text?: string | null;\n }\n interface SubmitJoinRequestResponse {\n /** Submitted join request. */\n joinRequest?: JoinRequest;\n }\n interface CancelJoinRequestRequest {\n /** Relevant group. */\n groupId: string;\n }\n interface CancelJoinRequestResponse {\n /** Cancelled join request. */\n joinRequest?: JoinRequest;\n }\n interface JoinRequestCancelled {\n /** Group ID for which join request was cancelled. */\n groupId?: string;\n /** Cancelled join request. */\n joinRequest?: JoinRequest;\n }\n interface ApproveJoinRequestsRequest {\n /** Relevant group. */\n groupId: string;\n /** @internal */\n itemsToApprove?: ItemsToUpdate;\n /** Member IDs 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 ApproveJoinRequestsResponse {\n /** Approved join requests. */\n joinRequests?: JoinRequest[];\n }\n interface JoinRequestApproved {\n /** Group ID for which join request was approved. */\n groupId?: string;\n /** Approved join request. */\n joinRequest?: JoinRequest;\n }\n interface RejectJoinRequestsRequest {\n /** Relevant group. */\n groupId: string;\n /** @internal */\n itemsToReject?: ItemsToUpdate;\n /** Rejection data. */\n rejections?: Rejection[];\n }\n interface Rejection {\n /** Member ID to reject. */\n memberId?: string;\n /** Rejection reason. Free text that will be displayed to the rejected site member (max 1,000 characters). */\n reason?: string | null;\n }\n interface RejectJoinRequestsResponse {\n /** Rejected join requests. */\n joinRequests?: JoinRequest[];\n }\n interface JoinRequestRejected {\n /** Group ID for which join request was rejected. */\n groupId?: string;\n /** Rejected join request. */\n joinRequest?: JoinRequest;\n }\n interface ListJoinRequestsRequest {\n /** Group ID. */\n groupId: string;\n /**\n * Ownership filter. In case of server signing, `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\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 ListJoinRequestsResponse {\n /** Join requests. */\n joinRequests?: JoinRequest[];\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryJoinRequestsRequest {\n /** Group ID. */\n groupId: string;\n /**\n * Ownership filter. In case of server signing `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryJoinRequestsResponse {\n /** Join requests. */\n joinRequests?: JoinRequest[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 * Submits a join request.\n * Relevant only for private groups.\n * @param groupId - Relevant group.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function submitJoinRequest(groupId: string, options?: SubmitJoinRequestOptions): Promise;\n interface SubmitJoinRequestOptions {\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 * Cancels a join request.\n * A site member can cancel only their own pending Join requests.\n * @param groupId - Relevant group.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function cancelJoinRequest(groupId: string): Promise;\n /**\n * Approves pending join requests.\n * Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.\n * @param groupId - Relevant group.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @requiredField options.memberIds\n * @adminMethod\n */\n function approveJoinRequests(groupId: string, options?: ApproveJoinRequestsOptions): Promise;\n interface ApproveJoinRequestsOptions {\n /** @internal */\n itemsToApprove?: ItemsToUpdate;\n /** Member IDs to approve. */\n memberIds: string[];\n }\n /**\n * Rejects pending join requests.\n * Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.\n * @param groupId - Relevant group.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function rejectJoinRequests(groupId: string, options?: RejectJoinRequestsOptions): Promise;\n interface RejectJoinRequestsOptions {\n /** @internal */\n itemsToReject?: ItemsToUpdate;\n /** Rejection data. */\n rejections?: Rejection[];\n }\n /**\n * Retrieves a list of up to 100 join requests, given the provided paging.\n * Group managers always have access to this functionality (site members can access their own join requests in the site).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function listJoinRequests(groupId: string, options?: ListJoinRequestsOptions): Promise;\n interface ListJoinRequestsOptions {\n /**\n * Ownership filter. In case of server signing, `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\n limit?: number | null;\n offset?: number | null;\n }\n /**\n * Retrieves a list of up to 100 join requests, given the provided paging and filtering.\n * Group managers always have access to this functionality (site members can access their own join requests in the site).\n *\n * Supported fields for filtering:\n * - `status`\n *\n * No supported fields for sorting\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function queryJoinRequests(groupId: string, options?: QueryJoinRequestsOptions): Promise;\n interface QueryJoinRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\n query?: Query;\n }\n \n type socialGroupsV3JoinRequest_universal_d_JoinRequest = JoinRequest;\n type socialGroupsV3JoinRequest_universal_d_RequestStatus = RequestStatus;\n const socialGroupsV3JoinRequest_universal_d_RequestStatus: typeof RequestStatus;\n type socialGroupsV3JoinRequest_universal_d_RequestDetails = RequestDetails;\n type socialGroupsV3JoinRequest_universal_d_SubmitJoinRequestRequest = SubmitJoinRequestRequest;\n type socialGroupsV3JoinRequest_universal_d_MembershipQuestionAnswer = MembershipQuestionAnswer;\n type socialGroupsV3JoinRequest_universal_d_SubmitJoinRequestResponse = SubmitJoinRequestResponse;\n type socialGroupsV3JoinRequest_universal_d_CancelJoinRequestRequest = CancelJoinRequestRequest;\n type socialGroupsV3JoinRequest_universal_d_CancelJoinRequestResponse = CancelJoinRequestResponse;\n type socialGroupsV3JoinRequest_universal_d_JoinRequestCancelled = JoinRequestCancelled;\n type socialGroupsV3JoinRequest_universal_d_ApproveJoinRequestsRequest = ApproveJoinRequestsRequest;\n type socialGroupsV3JoinRequest_universal_d_ItemsToUpdate = ItemsToUpdate;\n const socialGroupsV3JoinRequest_universal_d_ItemsToUpdate: typeof ItemsToUpdate;\n type socialGroupsV3JoinRequest_universal_d_ApproveJoinRequestsResponse = ApproveJoinRequestsResponse;\n type socialGroupsV3JoinRequest_universal_d_JoinRequestApproved = JoinRequestApproved;\n type socialGroupsV3JoinRequest_universal_d_RejectJoinRequestsRequest = RejectJoinRequestsRequest;\n type socialGroupsV3JoinRequest_universal_d_Rejection = Rejection;\n type socialGroupsV3JoinRequest_universal_d_RejectJoinRequestsResponse = RejectJoinRequestsResponse;\n type socialGroupsV3JoinRequest_universal_d_JoinRequestRejected = JoinRequestRejected;\n type socialGroupsV3JoinRequest_universal_d_ListJoinRequestsRequest = ListJoinRequestsRequest;\n type socialGroupsV3JoinRequest_universal_d_OwnershipFilter = OwnershipFilter;\n const socialGroupsV3JoinRequest_universal_d_OwnershipFilter: typeof OwnershipFilter;\n type socialGroupsV3JoinRequest_universal_d_ListJoinRequestsResponse = ListJoinRequestsResponse;\n type socialGroupsV3JoinRequest_universal_d_PagingMetadata = PagingMetadata;\n type socialGroupsV3JoinRequest_universal_d_QueryJoinRequestsRequest = QueryJoinRequestsRequest;\n type socialGroupsV3JoinRequest_universal_d_Query = Query;\n type socialGroupsV3JoinRequest_universal_d_Sorting = Sorting;\n type socialGroupsV3JoinRequest_universal_d_SortOrder = SortOrder;\n const socialGroupsV3JoinRequest_universal_d_SortOrder: typeof SortOrder;\n type socialGroupsV3JoinRequest_universal_d_Paging = Paging;\n type socialGroupsV3JoinRequest_universal_d_QueryJoinRequestsResponse = QueryJoinRequestsResponse;\n type socialGroupsV3JoinRequest_universal_d_DomainEvent = DomainEvent;\n type socialGroupsV3JoinRequest_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type socialGroupsV3JoinRequest_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type socialGroupsV3JoinRequest_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type socialGroupsV3JoinRequest_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type socialGroupsV3JoinRequest_universal_d_ActionEvent = ActionEvent;\n type socialGroupsV3JoinRequest_universal_d_MessageEnvelope = MessageEnvelope;\n type socialGroupsV3JoinRequest_universal_d_IdentificationData = IdentificationData;\n type socialGroupsV3JoinRequest_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type socialGroupsV3JoinRequest_universal_d_WebhookIdentityType = WebhookIdentityType;\n const socialGroupsV3JoinRequest_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const socialGroupsV3JoinRequest_universal_d_submitJoinRequest: typeof submitJoinRequest;\n type socialGroupsV3JoinRequest_universal_d_SubmitJoinRequestOptions = SubmitJoinRequestOptions;\n const socialGroupsV3JoinRequest_universal_d_cancelJoinRequest: typeof cancelJoinRequest;\n const socialGroupsV3JoinRequest_universal_d_approveJoinRequests: typeof approveJoinRequests;\n type socialGroupsV3JoinRequest_universal_d_ApproveJoinRequestsOptions = ApproveJoinRequestsOptions;\n const socialGroupsV3JoinRequest_universal_d_rejectJoinRequests: typeof rejectJoinRequests;\n type socialGroupsV3JoinRequest_universal_d_RejectJoinRequestsOptions = RejectJoinRequestsOptions;\n const socialGroupsV3JoinRequest_universal_d_listJoinRequests: typeof listJoinRequests;\n type socialGroupsV3JoinRequest_universal_d_ListJoinRequestsOptions = ListJoinRequestsOptions;\n const socialGroupsV3JoinRequest_universal_d_queryJoinRequests: typeof queryJoinRequests;\n type socialGroupsV3JoinRequest_universal_d_QueryJoinRequestsOptions = QueryJoinRequestsOptions;\n namespace socialGroupsV3JoinRequest_universal_d {\n export {\n socialGroupsV3JoinRequest_universal_d_JoinRequest as JoinRequest,\n socialGroupsV3JoinRequest_universal_d_RequestStatus as RequestStatus,\n socialGroupsV3JoinRequest_universal_d_RequestDetails as RequestDetails,\n socialGroupsV3JoinRequest_universal_d_SubmitJoinRequestRequest as SubmitJoinRequestRequest,\n socialGroupsV3JoinRequest_universal_d_MembershipQuestionAnswer as MembershipQuestionAnswer,\n socialGroupsV3JoinRequest_universal_d_SubmitJoinRequestResponse as SubmitJoinRequestResponse,\n socialGroupsV3JoinRequest_universal_d_CancelJoinRequestRequest as CancelJoinRequestRequest,\n socialGroupsV3JoinRequest_universal_d_CancelJoinRequestResponse as CancelJoinRequestResponse,\n socialGroupsV3JoinRequest_universal_d_JoinRequestCancelled as JoinRequestCancelled,\n socialGroupsV3JoinRequest_universal_d_ApproveJoinRequestsRequest as ApproveJoinRequestsRequest,\n socialGroupsV3JoinRequest_universal_d_ItemsToUpdate as ItemsToUpdate,\n socialGroupsV3JoinRequest_universal_d_ApproveJoinRequestsResponse as ApproveJoinRequestsResponse,\n socialGroupsV3JoinRequest_universal_d_JoinRequestApproved as JoinRequestApproved,\n socialGroupsV3JoinRequest_universal_d_RejectJoinRequestsRequest as RejectJoinRequestsRequest,\n socialGroupsV3JoinRequest_universal_d_Rejection as Rejection,\n socialGroupsV3JoinRequest_universal_d_RejectJoinRequestsResponse as RejectJoinRequestsResponse,\n socialGroupsV3JoinRequest_universal_d_JoinRequestRejected as JoinRequestRejected,\n socialGroupsV3JoinRequest_universal_d_ListJoinRequestsRequest as ListJoinRequestsRequest,\n socialGroupsV3JoinRequest_universal_d_OwnershipFilter as OwnershipFilter,\n socialGroupsV3JoinRequest_universal_d_ListJoinRequestsResponse as ListJoinRequestsResponse,\n socialGroupsV3JoinRequest_universal_d_PagingMetadata as PagingMetadata,\n socialGroupsV3JoinRequest_universal_d_QueryJoinRequestsRequest as QueryJoinRequestsRequest,\n socialGroupsV3JoinRequest_universal_d_Query as Query,\n socialGroupsV3JoinRequest_universal_d_Sorting as Sorting,\n socialGroupsV3JoinRequest_universal_d_SortOrder as SortOrder,\n socialGroupsV3JoinRequest_universal_d_Paging as Paging,\n socialGroupsV3JoinRequest_universal_d_QueryJoinRequestsResponse as QueryJoinRequestsResponse,\n socialGroupsV3JoinRequest_universal_d_DomainEvent as DomainEvent,\n socialGroupsV3JoinRequest_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n socialGroupsV3JoinRequest_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n socialGroupsV3JoinRequest_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n socialGroupsV3JoinRequest_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n socialGroupsV3JoinRequest_universal_d_ActionEvent as ActionEvent,\n socialGroupsV3JoinRequest_universal_d_MessageEnvelope as MessageEnvelope,\n socialGroupsV3JoinRequest_universal_d_IdentificationData as IdentificationData,\n socialGroupsV3JoinRequest_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n socialGroupsV3JoinRequest_universal_d_WebhookIdentityType as WebhookIdentityType,\n socialGroupsV3JoinRequest_universal_d_submitJoinRequest as submitJoinRequest,\n socialGroupsV3JoinRequest_universal_d_SubmitJoinRequestOptions as SubmitJoinRequestOptions,\n socialGroupsV3JoinRequest_universal_d_cancelJoinRequest as cancelJoinRequest,\n socialGroupsV3JoinRequest_universal_d_approveJoinRequests as approveJoinRequests,\n socialGroupsV3JoinRequest_universal_d_ApproveJoinRequestsOptions as ApproveJoinRequestsOptions,\n socialGroupsV3JoinRequest_universal_d_rejectJoinRequests as rejectJoinRequests,\n socialGroupsV3JoinRequest_universal_d_RejectJoinRequestsOptions as RejectJoinRequestsOptions,\n socialGroupsV3JoinRequest_universal_d_listJoinRequests as listJoinRequests,\n socialGroupsV3JoinRequest_universal_d_ListJoinRequestsOptions as ListJoinRequestsOptions,\n socialGroupsV3JoinRequest_universal_d_queryJoinRequests as queryJoinRequests,\n socialGroupsV3JoinRequest_universal_d_QueryJoinRequestsOptions as QueryJoinRequestsOptions,\n };\n }\n \n export { socialGroupsV3CreateRequest_universal_d as createRequests, socialGroupsV3JoinRequest_universal_d as joinRequests };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-data-collection-service-v2.d.ts", "content": "declare module \"wix-data-collection-service-v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 Content Manager. 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 */\n displayNamespace?: string | null;\n /**\n * The field whose value the Content Manager displays to represent the collection item when referenced in a different collection.\n * @readonly\n */\n displayField?: string;\n /**\n * Capabilities the collection supports.\n * @readonly\n */\n capabilities?: CollectionCapabilities;\n /** Collection's field structure. A collection must have at least 1 field. */\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 /** Data operations the collection supports. */\n dataOperations?: DataOperation[];\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 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 Content Manager. For example, `First Name`. */\n displayName?: string;\n /** Field's data type. */\n type?: TypeEnum;\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 /** Capabilities the field supports. */\n capabilities?: FieldCapabilities;\n /** Indicates if field is encrypted. */\n encrypted?: boolean;\n /** Defines reference to router pattern in the site document. */\n linkedRouterPage?: string | null;\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 }\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 TypeEnum {\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$1;\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$1;\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 /** Query operators that can be used for this field. */\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;\n /** Field type. */\n type?: TypeEnum;\n /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */\n typeMetadata?: TypeMetadata;\n /** Capabilities the object field supports. */\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 _id?: string;\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 Content Manager for the referenced data. */\n referencingDisplayName?: string;\n }\n interface Object$1 {\n /** Fields within the object. */\n fields?: ObjectField[];\n }\n interface Array {\n /** Element's data type. */\n elementType?: TypeEnum;\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 }\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 /** 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 /** 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 Gridappless plugin. */\n gridapplessOptions?: GridapplessPluginOptions;\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 * * `GRIDAPPLESS`: This plugin is read-only and can't be manually added. Indicates the collection structure is shared between sandbox and live environments.\n */\n type?: Type;\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 Gridappless plugin. */\n gridapplessOptions?: GridapplessPluginOptions;\n }\n enum Status {\n PUBLISHED = \"PUBLISHED\",\n DRAFT = \"DRAFT\"\n }\n enum Format {\n ORIGINAL = \"ORIGINAL\",\n PLAIN = \"PLAIN\"\n }\n enum 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 /** This plugin is read-only and can't be manually added. Indicates collection structure is shared between sandbox and live environments. */\n GRIDAPPLESS = \"GRIDAPPLESS\"\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 GridapplessPluginOptions {\n /** indicates if tenant is migrated to gridappless or initially on it */\n migrated?: boolean;\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?: Field[];\n /** list of removed fields */\n fieldsRemoved?: Field[];\n /** list of new plugins */\n pluginsAdded?: Plugin[];\n /** list of changed plugins */\n pluginsUpdated?: Plugin[];\n /** list of removed plugins */\n pluginsRemoved?: 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 return all collections referenced by the requested collection.\n *\n * Default: `false`\n */\n includeReferencedCollections?: 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 extends ListDataCollectionsRequestPagingMethodOneOf {\n /** Offset-based paging. */\n paging?: Paging;\n /** Cursor-based paging. */\n cursorPaging?: CursorPaging;\n /**\n * Defines how collections in the response are sorted.\n *\n * Default: Ordered by ID in ascending order.\n */\n sort?: Sorting;\n }\n /** @oneof */\n interface ListDataCollectionsRequestPagingMethodOneOf {\n /** Offset-based paging. */\n paging?: Paging;\n /** Cursor-based paging. */\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 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 /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\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 * @internal\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 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 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 BulkGetDataCollectionsBySnapshotsRequest {\n /** Ids of schema snapshot */\n snapshotIds?: string[];\n }\n interface BulkGetDataCollectionsBySnapshotsResponse {\n /** List of snapshot collection map */\n snapshotCollections?: SnapshotDataCollections[];\n }\n interface SnapshotDataCollections {\n snapshotId?: string;\n collections?: 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 /**\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 * @public\n * @documentationMaturity preview\n * @requiredField options.collection._id\n * @requiredField options.collection.fields\n * @requiredField options.collection.permissions\n */\n function createDataCollection(options?: CreateDataCollectionOptions): Promise;\n interface CreateDataCollectionOptions {\n /** Collection details. */\n collection?: DataCollection;\n }\n /**\n * Retrieves a data collection by ID.\n * @param dataCollectionId - ID of the collection to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField GetDataCollectionRequest\n * @requiredField dataCollectionId\n */\n function getDataCollection(dataCollectionId: string, options?: GetDataCollectionOptions): Promise;\n interface GetDataCollectionOptions {\n /**\n * Whether to return all collections referenced by the requested collection.\n *\n * Default: `false`\n */\n includeReferencedCollections?: boolean;\n }\n /**\n * Retrieves a list of all data collections associated with the site.\n *\n * By default, the list is ordered by ID in ascending order.\n * @public\n * @documentationMaturity preview\n */\n function listDataCollections(options?: ListDataCollectionsOptions): Promise;\n interface ListDataCollectionsOptions extends ListDataCollectionsRequestPagingMethodOneOf {\n /**\n * Defines how collections in the response are sorted.\n *\n * Default: Ordered by ID in ascending order.\n */\n sort?: Sorting;\n /** Offset-based paging. */\n paging?: Paging;\n /** Cursor-based paging. */\n cursorPaging?: CursorPaging;\n }\n /**\n * Retrieves multiple data collections by ID.\n * Used in frontend databinding to load multiple specific collections at once. For internal use only.\n * @internal\n * @documentationMaturity preview\n */\n function bulkGetDataCollections(options?: BulkGetDataCollectionsOptions): Promise;\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 /**\n * Updates a data collection.\n *\n * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.\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 Update Data Collection request. 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 * @public\n * @documentationMaturity preview\n * @requiredField options.collection._id\n * @requiredField options.collection.fields\n * @requiredField options.collection.permissions\n * @requiredField options.collection.revision\n */\n function updateDataCollection(options?: UpdateDataCollectionOptions): Promise;\n interface UpdateDataCollectionOptions {\n /** Updated collection details. The existing collection is replaced with this version. */\n collection?: DataCollection;\n }\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 * @documentationMaturity preview\n * @requiredField DeleteDataCollectionRequest\n * @requiredField dataCollectionId\n */\n function deleteDataCollection(dataCollectionId: string): Promise;\n \n const dataV1DataCollection_universal_d___debug: typeof __debug;\n type dataV1DataCollection_universal_d_DataCollection = DataCollection;\n type dataV1DataCollection_universal_d_CollectionType = CollectionType;\n const dataV1DataCollection_universal_d_CollectionType: typeof CollectionType;\n type dataV1DataCollection_universal_d_Sort = Sort;\n type dataV1DataCollection_universal_d_Direction = Direction;\n const dataV1DataCollection_universal_d_Direction: typeof Direction;\n type dataV1DataCollection_universal_d_CollectionCapabilities = CollectionCapabilities;\n type dataV1DataCollection_universal_d_DataOperation = DataOperation;\n const dataV1DataCollection_universal_d_DataOperation: typeof DataOperation;\n type dataV1DataCollection_universal_d_Field = Field;\n type dataV1DataCollection_universal_d_FieldRangeValidationsOneOf = FieldRangeValidationsOneOf;\n type dataV1DataCollection_universal_d_TypeEnum = TypeEnum;\n const dataV1DataCollection_universal_d_TypeEnum: typeof TypeEnum;\n type dataV1DataCollection_universal_d_TypeMetadata = TypeMetadata;\n type dataV1DataCollection_universal_d_TypeMetadataMetadataOneOf = TypeMetadataMetadataOneOf;\n type dataV1DataCollection_universal_d_FieldCapabilities = FieldCapabilities;\n type dataV1DataCollection_universal_d_QueryOperator = QueryOperator;\n const dataV1DataCollection_universal_d_QueryOperator: typeof QueryOperator;\n type dataV1DataCollection_universal_d_ObjectField = ObjectField;\n type dataV1DataCollection_universal_d_FieldsPattern = FieldsPattern;\n type dataV1DataCollection_universal_d_UrlizedOnlyPattern = UrlizedOnlyPattern;\n type dataV1DataCollection_universal_d_Calculator = Calculator;\n type dataV1DataCollection_universal_d_CalculatorPatternOneOf = CalculatorPatternOneOf;\n type dataV1DataCollection_universal_d_Reference = Reference;\n type dataV1DataCollection_universal_d_MultiReference = MultiReference;\n type dataV1DataCollection_universal_d_Array = Array;\n type dataV1DataCollection_universal_d_PageLink = PageLink;\n type dataV1DataCollection_universal_d_NumberRange = NumberRange;\n type dataV1DataCollection_universal_d_StringLengthRange = StringLengthRange;\n type dataV1DataCollection_universal_d_ArraySizeRange = ArraySizeRange;\n type dataV1DataCollection_universal_d_Permissions = Permissions;\n type dataV1DataCollection_universal_d_Role = Role;\n const dataV1DataCollection_universal_d_Role: typeof Role;\n type dataV1DataCollection_universal_d_Plugin = Plugin;\n type dataV1DataCollection_universal_d_PluginOptionsOneOf = PluginOptionsOneOf;\n type dataV1DataCollection_universal_d_Status = Status;\n const dataV1DataCollection_universal_d_Status: typeof Status;\n type dataV1DataCollection_universal_d_Format = Format;\n const dataV1DataCollection_universal_d_Format: typeof Format;\n type dataV1DataCollection_universal_d_Type = Type;\n const dataV1DataCollection_universal_d_Type: typeof Type;\n type dataV1DataCollection_universal_d_PublishPluginOptions = PublishPluginOptions;\n type dataV1DataCollection_universal_d_SingleItemPluginOptions = SingleItemPluginOptions;\n type dataV1DataCollection_universal_d_UrlizedPluginOptions = UrlizedPluginOptions;\n type dataV1DataCollection_universal_d_GridapplessPluginOptions = GridapplessPluginOptions;\n type dataV1DataCollection_universal_d_PagingMode = PagingMode;\n const dataV1DataCollection_universal_d_PagingMode: typeof PagingMode;\n type dataV1DataCollection_universal_d_DataCollectionClonedEvent = DataCollectionClonedEvent;\n type dataV1DataCollection_universal_d_DataCollectionChangedEvent = DataCollectionChangedEvent;\n type dataV1DataCollection_universal_d_CreateDataCollectionRequest = CreateDataCollectionRequest;\n type dataV1DataCollection_universal_d_CreateDataCollectionResponse = CreateDataCollectionResponse;\n type dataV1DataCollection_universal_d_GetDataCollectionRequest = GetDataCollectionRequest;\n type dataV1DataCollection_universal_d_GetDataCollectionResponse = GetDataCollectionResponse;\n type dataV1DataCollection_universal_d_ListDataCollectionsRequest = ListDataCollectionsRequest;\n type dataV1DataCollection_universal_d_ListDataCollectionsRequestPagingMethodOneOf = ListDataCollectionsRequestPagingMethodOneOf;\n type dataV1DataCollection_universal_d_Sorting = Sorting;\n type dataV1DataCollection_universal_d_SortOrder = SortOrder;\n const dataV1DataCollection_universal_d_SortOrder: typeof SortOrder;\n type dataV1DataCollection_universal_d_Paging = Paging;\n type dataV1DataCollection_universal_d_CursorPaging = CursorPaging;\n type dataV1DataCollection_universal_d_ListDataCollectionsResponse = ListDataCollectionsResponse;\n type dataV1DataCollection_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type dataV1DataCollection_universal_d_Cursors = Cursors;\n type dataV1DataCollection_universal_d_BulkGetDataCollectionsRequest = BulkGetDataCollectionsRequest;\n type dataV1DataCollection_universal_d_BulkGetDataCollectionsResponse = BulkGetDataCollectionsResponse;\n type dataV1DataCollection_universal_d_BulkGetDataCollectionsBySnapshotsRequest = BulkGetDataCollectionsBySnapshotsRequest;\n type dataV1DataCollection_universal_d_BulkGetDataCollectionsBySnapshotsResponse = BulkGetDataCollectionsBySnapshotsResponse;\n type dataV1DataCollection_universal_d_SnapshotDataCollections = SnapshotDataCollections;\n type dataV1DataCollection_universal_d_UpdateDataCollectionRequest = UpdateDataCollectionRequest;\n type dataV1DataCollection_universal_d_UpdateDataCollectionResponse = UpdateDataCollectionResponse;\n type dataV1DataCollection_universal_d_DeleteDataCollectionRequest = DeleteDataCollectionRequest;\n type dataV1DataCollection_universal_d_DeleteDataCollectionResponse = DeleteDataCollectionResponse;\n const dataV1DataCollection_universal_d_createDataCollection: typeof createDataCollection;\n type dataV1DataCollection_universal_d_CreateDataCollectionOptions = CreateDataCollectionOptions;\n const dataV1DataCollection_universal_d_getDataCollection: typeof getDataCollection;\n type dataV1DataCollection_universal_d_GetDataCollectionOptions = GetDataCollectionOptions;\n const dataV1DataCollection_universal_d_listDataCollections: typeof listDataCollections;\n type dataV1DataCollection_universal_d_ListDataCollectionsOptions = ListDataCollectionsOptions;\n const dataV1DataCollection_universal_d_bulkGetDataCollections: typeof bulkGetDataCollections;\n type dataV1DataCollection_universal_d_BulkGetDataCollectionsOptions = BulkGetDataCollectionsOptions;\n const dataV1DataCollection_universal_d_updateDataCollection: typeof updateDataCollection;\n type dataV1DataCollection_universal_d_UpdateDataCollectionOptions = UpdateDataCollectionOptions;\n const dataV1DataCollection_universal_d_deleteDataCollection: typeof deleteDataCollection;\n namespace dataV1DataCollection_universal_d {\n export {\n dataV1DataCollection_universal_d___debug as __debug,\n dataV1DataCollection_universal_d_DataCollection as DataCollection,\n dataV1DataCollection_universal_d_CollectionType as CollectionType,\n dataV1DataCollection_universal_d_Sort as Sort,\n dataV1DataCollection_universal_d_Direction as Direction,\n dataV1DataCollection_universal_d_CollectionCapabilities as CollectionCapabilities,\n dataV1DataCollection_universal_d_DataOperation as DataOperation,\n dataV1DataCollection_universal_d_Field as Field,\n dataV1DataCollection_universal_d_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf,\n dataV1DataCollection_universal_d_TypeEnum as TypeEnum,\n dataV1DataCollection_universal_d_TypeMetadata as TypeMetadata,\n dataV1DataCollection_universal_d_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf,\n dataV1DataCollection_universal_d_FieldCapabilities as FieldCapabilities,\n dataV1DataCollection_universal_d_QueryOperator as QueryOperator,\n dataV1DataCollection_universal_d_ObjectField as ObjectField,\n dataV1DataCollection_universal_d_FieldsPattern as FieldsPattern,\n dataV1DataCollection_universal_d_UrlizedOnlyPattern as UrlizedOnlyPattern,\n dataV1DataCollection_universal_d_Calculator as Calculator,\n dataV1DataCollection_universal_d_CalculatorPatternOneOf as CalculatorPatternOneOf,\n dataV1DataCollection_universal_d_Reference as Reference,\n dataV1DataCollection_universal_d_MultiReference as MultiReference,\n Object$1 as Object,\n dataV1DataCollection_universal_d_Array as Array,\n dataV1DataCollection_universal_d_PageLink as PageLink,\n dataV1DataCollection_universal_d_NumberRange as NumberRange,\n dataV1DataCollection_universal_d_StringLengthRange as StringLengthRange,\n dataV1DataCollection_universal_d_ArraySizeRange as ArraySizeRange,\n dataV1DataCollection_universal_d_Permissions as Permissions,\n dataV1DataCollection_universal_d_Role as Role,\n dataV1DataCollection_universal_d_Plugin as Plugin,\n dataV1DataCollection_universal_d_PluginOptionsOneOf as PluginOptionsOneOf,\n dataV1DataCollection_universal_d_Status as Status,\n dataV1DataCollection_universal_d_Format as Format,\n dataV1DataCollection_universal_d_Type as Type,\n dataV1DataCollection_universal_d_PublishPluginOptions as PublishPluginOptions,\n dataV1DataCollection_universal_d_SingleItemPluginOptions as SingleItemPluginOptions,\n dataV1DataCollection_universal_d_UrlizedPluginOptions as UrlizedPluginOptions,\n dataV1DataCollection_universal_d_GridapplessPluginOptions as GridapplessPluginOptions,\n dataV1DataCollection_universal_d_PagingMode as PagingMode,\n dataV1DataCollection_universal_d_DataCollectionClonedEvent as DataCollectionClonedEvent,\n dataV1DataCollection_universal_d_DataCollectionChangedEvent as DataCollectionChangedEvent,\n dataV1DataCollection_universal_d_CreateDataCollectionRequest as CreateDataCollectionRequest,\n dataV1DataCollection_universal_d_CreateDataCollectionResponse as CreateDataCollectionResponse,\n dataV1DataCollection_universal_d_GetDataCollectionRequest as GetDataCollectionRequest,\n dataV1DataCollection_universal_d_GetDataCollectionResponse as GetDataCollectionResponse,\n dataV1DataCollection_universal_d_ListDataCollectionsRequest as ListDataCollectionsRequest,\n dataV1DataCollection_universal_d_ListDataCollectionsRequestPagingMethodOneOf as ListDataCollectionsRequestPagingMethodOneOf,\n dataV1DataCollection_universal_d_Sorting as Sorting,\n dataV1DataCollection_universal_d_SortOrder as SortOrder,\n dataV1DataCollection_universal_d_Paging as Paging,\n dataV1DataCollection_universal_d_CursorPaging as CursorPaging,\n dataV1DataCollection_universal_d_ListDataCollectionsResponse as ListDataCollectionsResponse,\n dataV1DataCollection_universal_d_PagingMetadataV2 as PagingMetadataV2,\n dataV1DataCollection_universal_d_Cursors as Cursors,\n dataV1DataCollection_universal_d_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest,\n dataV1DataCollection_universal_d_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse,\n dataV1DataCollection_universal_d_BulkGetDataCollectionsBySnapshotsRequest as BulkGetDataCollectionsBySnapshotsRequest,\n dataV1DataCollection_universal_d_BulkGetDataCollectionsBySnapshotsResponse as BulkGetDataCollectionsBySnapshotsResponse,\n dataV1DataCollection_universal_d_SnapshotDataCollections as SnapshotDataCollections,\n dataV1DataCollection_universal_d_UpdateDataCollectionRequest as UpdateDataCollectionRequest,\n dataV1DataCollection_universal_d_UpdateDataCollectionResponse as UpdateDataCollectionResponse,\n dataV1DataCollection_universal_d_DeleteDataCollectionRequest as DeleteDataCollectionRequest,\n dataV1DataCollection_universal_d_DeleteDataCollectionResponse as DeleteDataCollectionResponse,\n dataV1DataCollection_universal_d_createDataCollection as createDataCollection,\n dataV1DataCollection_universal_d_CreateDataCollectionOptions as CreateDataCollectionOptions,\n dataV1DataCollection_universal_d_getDataCollection as getDataCollection,\n dataV1DataCollection_universal_d_GetDataCollectionOptions as GetDataCollectionOptions,\n dataV1DataCollection_universal_d_listDataCollections as listDataCollections,\n dataV1DataCollection_universal_d_ListDataCollectionsOptions as ListDataCollectionsOptions,\n dataV1DataCollection_universal_d_bulkGetDataCollections as bulkGetDataCollections,\n dataV1DataCollection_universal_d_BulkGetDataCollectionsOptions as BulkGetDataCollectionsOptions,\n dataV1DataCollection_universal_d_updateDataCollection as updateDataCollection,\n dataV1DataCollection_universal_d_UpdateDataCollectionOptions as UpdateDataCollectionOptions,\n dataV1DataCollection_universal_d_deleteDataCollection as deleteDataCollection,\n };\n }\n \n export { dataV1DataCollection_universal_d as data };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-inbox.v2.d.ts", "content": "declare module \"wix-inbox.v2\" {\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 /** ID of a site member. */\n memberId?: string;\n /**\n * ID of a site contact.\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 /** ID of a site member. */\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 AI_ASSISTANT = \"AI_ASSISTANT\",\n PHONE = \"PHONE\"\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 /** ID of a site contact. */\n contactId?: string;\n /** ID of an anonymous site visitor. */\n anonymousVisitorId?: string;\n /** ID of a site member. */\n memberId?: string;\n }\n /** @oneof */\n interface ParticipantIdIdOneOf {\n /** ID of a site contact. */\n contactId?: string;\n /** ID of an anonymous site visitor. */\n anonymousVisitorId?: string;\n /** ID of a site member. */\n memberId?: string;\n }\n interface GetOrCreateConversationResponse {\n /** Created or retrieved conversation. */\n conversation?: Conversation;\n /**\n * Indicates whether the conversation previously exists or 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 /** 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 Sorting$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 * 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 * @internal\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 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 interface ReadConversationRequest {\n conversationId: string;\n channelId: string | null;\n readBy: ParticipantId;\n timestamp: Date | null;\n }\n interface ReadConversationResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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?: WebhooksIdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface WebhooksIdentificationData$1 extends WebhooksIdentificationDataIdOneOf$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 WebhooksIdentificationDataIdOneOf$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 conversation by conversation ID.\n *\n * If you don't have the conversation ID, use `getOrCreateConversation()` to retrieve the conversation using the visitor, contact, or member ID.\n *\n * @param conversationId - Conversation ID.\n * @public\n * @documentationMaturity preview\n * @requiredField conversationId\n * @permissionId INBOX.READ_CONVERSATIONS\n * @adminMethod\n * @returns Retrieved conversation.\n */\n function getConversation(conversationId: string): Promise;\n /**\n * Retrieves a conversation by the specified visitor, contact, or member ID. If the conversation does not exist for the provided visitor, contact, or member, the function creates a new conversation.\n * @public\n * @documentationMaturity preview\n * @requiredField participantId\n * @param participantId - ID of the visitor, contact, or member chatting with the business.\n * @permissionId INBOX.CREATE_CONVERSATIONS\n * @adminMethod\n */\n function getOrCreateConversation(participantId: ParticipantId): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId INBOX.READ_CONVERSATIONS\n * @adminMethod\n */\n function listConversations(options?: ListConversationsOptions): Promise;\n interface ListConversationsOptions {\n paging?: CursorPaging$1;\n /** only message time is supported for field name */\n sorting?: Sorting$1;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField conversationId\n * @permissionId INBOX.DELETE_CONVERSATIONS\n * @adminMethod\n */\n function deleteConversation(conversationId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField conversationId\n * @permissionId INBOX.CREATE_CONVERSATIONS\n * @adminMethod\n */\n function addConversationChannels(conversationId: string, options?: AddConversationChannelsOptions): Promise;\n interface AddConversationChannelsOptions {\n conversationChannels?: ConversationChannel[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField channelId\n * @requiredField conversationId\n * @requiredField options\n * @requiredField options.readBy\n * @requiredField options.timestamp\n * @permissionId INBOX.READ_CONVERSATIONS\n * @adminMethod\n */\n function readConversation(conversationId: string, channelId: string | null, options: ReadConversationOptions): Promise;\n interface ReadConversationOptions {\n readBy: ParticipantId;\n timestamp: Date | null;\n }\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 type crmInboxV2Conversation_universal_d_ReadConversationRequest = ReadConversationRequest;\n type crmInboxV2Conversation_universal_d_ReadConversationResponse = ReadConversationResponse;\n const crmInboxV2Conversation_universal_d_getConversation: typeof getConversation;\n const crmInboxV2Conversation_universal_d_getOrCreateConversation: typeof getOrCreateConversation;\n const crmInboxV2Conversation_universal_d_listConversations: typeof listConversations;\n type crmInboxV2Conversation_universal_d_ListConversationsOptions = ListConversationsOptions;\n const crmInboxV2Conversation_universal_d_deleteConversation: typeof deleteConversation;\n const crmInboxV2Conversation_universal_d_addConversationChannels: typeof addConversationChannels;\n type crmInboxV2Conversation_universal_d_AddConversationChannelsOptions = AddConversationChannelsOptions;\n const crmInboxV2Conversation_universal_d_readConversation: typeof readConversation;\n type crmInboxV2Conversation_universal_d_ReadConversationOptions = ReadConversationOptions;\n namespace crmInboxV2Conversation_universal_d {\n export {\n crmInboxV2Conversation_universal_d_Conversation as Conversation,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n ChannelType$1 as ChannelType,\n crmInboxV2Conversation_universal_d_ConversationDisplayData as ConversationDisplayData,\n crmInboxV2Conversation_universal_d_ConversationsMerged as ConversationsMerged,\n crmInboxV2Conversation_universal_d_GetConversationRequest as GetConversationRequest,\n crmInboxV2Conversation_universal_d_GetConversationResponse as GetConversationResponse,\n crmInboxV2Conversation_universal_d_GetOrCreateConversationRequest as GetOrCreateConversationRequest,\n crmInboxV2Conversation_universal_d_ParticipantId as ParticipantId,\n crmInboxV2Conversation_universal_d_ParticipantIdIdOneOf as ParticipantIdIdOneOf,\n crmInboxV2Conversation_universal_d_GetOrCreateConversationResponse as GetOrCreateConversationResponse,\n crmInboxV2Conversation_universal_d_ListConversationsRequest as ListConversationsRequest,\n CursorPaging$1 as CursorPaging,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n crmInboxV2Conversation_universal_d_ListConversationsResponse as ListConversationsResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n crmInboxV2Conversation_universal_d_DeleteConversationRequest as DeleteConversationRequest,\n crmInboxV2Conversation_universal_d_DeleteConversationResponse as DeleteConversationResponse,\n crmInboxV2Conversation_universal_d_AddConversationChannelsRequest as AddConversationChannelsRequest,\n crmInboxV2Conversation_universal_d_ConversationChannel as ConversationChannel,\n crmInboxV2Conversation_universal_d_AddConversationChannelsResponse as AddConversationChannelsResponse,\n crmInboxV2Conversation_universal_d_ChatroomsMerged as ChatroomsMerged,\n Empty$1 as Empty,\n crmInboxV2Conversation_universal_d_ReadConversationRequest as ReadConversationRequest,\n crmInboxV2Conversation_universal_d_ReadConversationResponse as ReadConversationResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n WebhooksIdentificationData$1 as WebhooksIdentificationData,\n WebhooksIdentificationDataIdOneOf$1 as WebhooksIdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n crmInboxV2Conversation_universal_d_getConversation as getConversation,\n crmInboxV2Conversation_universal_d_getOrCreateConversation as getOrCreateConversation,\n crmInboxV2Conversation_universal_d_listConversations as listConversations,\n crmInboxV2Conversation_universal_d_ListConversationsOptions as ListConversationsOptions,\n crmInboxV2Conversation_universal_d_deleteConversation as deleteConversation,\n crmInboxV2Conversation_universal_d_addConversationChannels as addConversationChannels,\n crmInboxV2Conversation_universal_d_AddConversationChannelsOptions as AddConversationChannelsOptions,\n crmInboxV2Conversation_universal_d_readConversation as readConversation,\n crmInboxV2Conversation_universal_d_ReadConversationOptions as ReadConversationOptions,\n };\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 using the property that matches their identity type.\n *\n * You can override the default behavior when calling\n * `sendMessage()` by using the `sendAs` field from the `options` object.\n *\n * @readonly\n */\n sender?: IdentificationData;\n /**\n * Optional icon and short text providing additional details about the message,\n * such as the app from which the message was sent, 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 * Reserved for internal use.\n *\n * ID of the application that sent the message.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 collaborators.\n * - `\"BUSINESS\"`: Visible to site collaborators only.\n */\n visibility?: MessageVisibility;\n /**\n * Sequential ordering of the message.\n *\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 | null;\n /**\n * Sequence of channel IDs required for channels integration via the CC host\n * @internal\n */\n targetChannelIds?: string[];\n /** @internal */\n sourceChannelId?: string | null;\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 * Reserved for internal use.\n *\n * System message.\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 * An enum that says what the Content Type expected to be populated inside payload\n * @internal\n */\n contentType?: ContentType;\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 /**\n * File size, in bytes.\n * @internal\n */\n fileSize?: 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 /**\n * File size, in bytes.\n * @internal\n */\n fileSize?: 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 * `onMessageButtonInteracted()` event.\n *\n * Max: 10 buttons.\n */\n buttons?: Button[];\n /** Controls whether the message is displayed in portrait or landscape layout. */\n orientation?: Orientation;\n /**\n * an icon key\n * @internal\n */\n icon?: string | null;\n /**\n * List of lines of text. Each item in the array is displayed on a new line.\n *\n * Max: 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 /** Properties to pass to the `onMessageButtonInteracted()` event when the button is clicked. */\n postbackProperties?: PostbackProperties;\n }\n interface PostbackProperties {\n /**\n * For internal use.\n *\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. */\n UNKNOWN_ORIENTATION = \"UNKNOWN_ORIENTATION\",\n /** Portrait layout. */\n PORTRAIT = \"PORTRAIT\",\n /** Landscape layout. */\n LANDSCAPE = \"LANDSCAPE\"\n }\n interface MinimalMessagePayload {\n /** Message text. */\n text?: string;\n /**\n * an icon key\n * @internal\n */\n icon?: string | null;\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 * `onMessageButtonInteracted()` event.\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 /**\n * an icon key\n * @internal\n */\n icon?: string | null;\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 /** Unkown visibility. */\n UNKNOWN_BADGE_VISIBILITY = \"UNKNOWN_BADGE_VISIBILITY\",\n /** Visible to the participant and site collaborators. */\n BUSINESS_AND_PARTICIPANT = \"BUSINESS_AND_PARTICIPANT\",\n /** Visible to site collaborators only. */\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 AI_ASSISTANT = \"AI_ASSISTANT\",\n PHONE = \"PHONE\"\n }\n enum MessageVisibility {\n /** Unknown message visibility. */\n UNKNOWN_VISIBILITY = \"UNKNOWN_VISIBILITY\",\n /** Visible to the participant and site collaborators. */\n BUSINESS_AND_PARTICIPANT = \"BUSINESS_AND_PARTICIPANT\",\n /** Visible to site collaborators only. */\n BUSINESS = \"BUSINESS\"\n }\n enum MessageDirection {\n /** Unknown message direction. */\n UNKNOWN_DIRECTION = \"UNKNOWN_DIRECTION\",\n /** The message was sent from the business to the participant. */\n BUSINESS_TO_PARTICIPANT = \"BUSINESS_TO_PARTICIPANT\",\n /** The message was sent from the participant to the business. */\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 /**\n * The type of the indication\n * - `UNKNOWN_INDICATION_TYPE`: Unknown indication type.\n * - `SENT`: Message was sent.\n * - `SEEN`: Message was seen.\n * - `ERROR`: There was an error.\n * - `DELIVERED`: Message was delivered.\n */\n type?: IndicationType;\n /** The channel to which this indication was added */\n channel?: ChannelType;\n /**\n * The error code when it is an ERROR indication\n * @internal\n */\n errorCode?: string | null;\n /** The time when action happened */\n timestamp?: Date | null;\n /**\n * The channel id that the message was sent in\n * @internal\n */\n channelId?: string | null;\n }\n enum IndicationType {\n /** Unknown indication type. */\n UNKNOWN_INDICATION_TYPE = \"UNKNOWN_INDICATION_TYPE\",\n /** Message was sent. */\n SENT = \"SENT\",\n /** Message was seen. */\n SEEN = \"SEEN\",\n /** There was an error. */\n ERROR = \"ERROR\",\n /** Message was delivered. */\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 performer. */\n UNKNOWN_PERFORMED_BY = \"UNKNOWN_PERFORMED_BY\",\n /** Business performed the action. */\n BUSINESS = \"BUSINESS\",\n /** Participant performed the action. */\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 * Internal data about custom messages\n * @internal\n */\n customMessageData?: CustomMessageData;\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 /**\n * Internal data about custom messages\n * @internal\n */\n customMessageData?: CustomMessageData;\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 /** 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 Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 * 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 * @internal\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 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 * Default: `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 * Default: `false`\n */\n silent?: boolean;\n /** @internal */\n typingDelay?: number | null;\n /**\n * Controls which identity to use in the message's `sender` property.\n * Default: `CALLER`\n * For 3rd-party apps, the app is the caller.\n */\n sendAs?: OverrideSenderOptions;\n /**\n * Wix user ID of the message sender.\n *\n * Required if `sendAs` is set to `BUSINESS_USER`.\n * @internal\n */\n businessUserId?: string | null;\n }\n enum OverrideSenderOptions {\n /** Uses the identity included in the request header. */\n CALLER = \"CALLER\",\n /** Uses the `anonymousVisitorId`, `contactId`, or `memberId` of the conversation's participant. */\n PARTICIPANT = \"PARTICIPANT\",\n /** For internal use. Uses the `wixUserId` of the person sending messages on behalf of the business. */\n BUSINESS_USER = \"BUSINESS_USER\"\n }\n interface SendMessageResponse {\n /** Sent message. */\n message?: Message;\n }\n interface Empty {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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?: 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;\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 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField conversationId\n * @requiredField messageId\n * @permissionId INBOX.READ_MESSAGES\n * @adminMethod\n */\n function getMessageIndications(messageId: string, conversationId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField conversationId\n * @requiredField options.indication\n * @requiredField options.messageIds\n * @permissionId INBOX.ADD_MESSAGE_INDICATIONS\n * @adminMethod\n */\n function addMessageIndications(conversationId: string, options?: AddMessageIndicationsOptions): Promise;\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. If the number of messages in a conversation is larger than 30,\n * `pagingMetadata.cursors` is returned in the response, indicating that another page of results is available.\n * To retrieve the next page of messages, 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 and sorted by `sequence` in descending order\n * (the most recent messages are first in the list).\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 * @permissionId INBOX.READ_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 * @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 * @permissionId INBOX.SEND_MESSAGES\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 * Default: `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 * Default: `false`\n */\n silent?: boolean;\n /** @internal */\n typingDelay?: number | null;\n /**\n * Controls which identity to use in the message's `sender` property.\n *\n * - `\"CALLER\"`: Uses the identity of the initiator of the sent message.\n * - `\"PARTICIPANT\"`: Uses the `anonymousVisitorId`, `contactId`, or `memberId` of the conversation's participant.\n *\n * Default: `\"CALLER\"`\n *\n */\n sendAs?: OverrideSenderOptions;\n /**\n * Wix user ID of the message sender.\n *\n * Required if `sendAs` is set to `BUSINESS_USER`.\n * @internal\n */\n businessUserId?: string | null;\n }\n \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_DomainEvent = DomainEvent;\n type crmInboxV2Message_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type crmInboxV2Message_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type crmInboxV2Message_universal_d_RestoreInfo = RestoreInfo;\n type crmInboxV2Message_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type crmInboxV2Message_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type crmInboxV2Message_universal_d_ActionEvent = ActionEvent;\n type crmInboxV2Message_universal_d_MessageEnvelope = MessageEnvelope;\n type crmInboxV2Message_universal_d_WebhooksIdentificationData = WebhooksIdentificationData;\n type crmInboxV2Message_universal_d_WebhooksIdentificationDataIdOneOf = WebhooksIdentificationDataIdOneOf;\n type crmInboxV2Message_universal_d_WebhookIdentityType = WebhookIdentityType;\n const crmInboxV2Message_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const crmInboxV2Message_universal_d_getMessageIndications: typeof getMessageIndications;\n const crmInboxV2Message_universal_d_addMessageIndications: typeof addMessageIndications;\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 {\n crmInboxV2Message_universal_d_Message as Message,\n crmInboxV2Message_universal_d_MessageContent as MessageContent,\n crmInboxV2Message_universal_d_MessageContentPayloadOneOf as MessageContentPayloadOneOf,\n crmInboxV2Message_universal_d_BasicMessagePayload as BasicMessagePayload,\n crmInboxV2Message_universal_d_BasicMessageData as BasicMessageData,\n crmInboxV2Message_universal_d_BasicMessageDataDataOneOf as BasicMessageDataDataOneOf,\n crmInboxV2Message_universal_d_ImageMessage as ImageMessage,\n crmInboxV2Message_universal_d_FileMessage as FileMessage,\n crmInboxV2Message_universal_d_TemplateMessagePayload as TemplateMessagePayload,\n crmInboxV2Message_universal_d_Button as Button,\n crmInboxV2Message_universal_d_PostbackProperties as PostbackProperties,\n crmInboxV2Message_universal_d_Orientation as Orientation,\n crmInboxV2Message_universal_d_MinimalMessagePayload as MinimalMessagePayload,\n crmInboxV2Message_universal_d_FormMessagePayload as FormMessagePayload,\n crmInboxV2Message_universal_d_FormField as FormField,\n crmInboxV2Message_universal_d_MediaItem as MediaItem,\n crmInboxV2Message_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf,\n crmInboxV2Message_universal_d_SystemMessagePayload as SystemMessagePayload,\n crmInboxV2Message_universal_d_ContentType as ContentType,\n crmInboxV2Message_universal_d_IdentificationData as IdentificationData,\n crmInboxV2Message_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n crmInboxV2Message_universal_d_Badge as Badge,\n crmInboxV2Message_universal_d_BadgeVisibility as BadgeVisibility,\n crmInboxV2Message_universal_d_ChannelType as ChannelType,\n crmInboxV2Message_universal_d_MessageVisibility as MessageVisibility,\n crmInboxV2Message_universal_d_MessageDirection as MessageDirection,\n crmInboxV2Message_universal_d_GetMessageIndicationsRequest as GetMessageIndicationsRequest,\n crmInboxV2Message_universal_d_GetMessageIndicationsResponse as GetMessageIndicationsResponse,\n crmInboxV2Message_universal_d_MessageIndication as MessageIndication,\n crmInboxV2Message_universal_d_IndicationType as IndicationType,\n crmInboxV2Message_universal_d_AddMessageIndicationsRequest as AddMessageIndicationsRequest,\n crmInboxV2Message_universal_d_PerformedBy as PerformedBy,\n crmInboxV2Message_universal_d_AddMessageIndicationsResponse as AddMessageIndicationsResponse,\n crmInboxV2Message_universal_d_MessageSentToParticipant as MessageSentToParticipant,\n crmInboxV2Message_universal_d_CustomMessageData as CustomMessageData,\n crmInboxV2Message_universal_d_MessageSentToBusiness as MessageSentToBusiness,\n crmInboxV2Message_universal_d_InteractionInfo as InteractionInfo,\n crmInboxV2Message_universal_d_ButtonInteracted as ButtonInteracted,\n crmInboxV2Message_universal_d_ListMessagesRequest as ListMessagesRequest,\n crmInboxV2Message_universal_d_CursorPaging as CursorPaging,\n crmInboxV2Message_universal_d_Sorting as Sorting,\n crmInboxV2Message_universal_d_SortOrder as SortOrder,\n crmInboxV2Message_universal_d_ListMessagesResponse as ListMessagesResponse,\n crmInboxV2Message_universal_d_PagingMetadataV2 as PagingMetadataV2,\n crmInboxV2Message_universal_d_Cursors as Cursors,\n crmInboxV2Message_universal_d_SendMessageRequest as SendMessageRequest,\n crmInboxV2Message_universal_d_OverrideSenderOptions as OverrideSenderOptions,\n crmInboxV2Message_universal_d_SendMessageResponse as SendMessageResponse,\n crmInboxV2Message_universal_d_Empty as Empty,\n crmInboxV2Message_universal_d_DomainEvent as DomainEvent,\n crmInboxV2Message_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n crmInboxV2Message_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n crmInboxV2Message_universal_d_RestoreInfo as RestoreInfo,\n crmInboxV2Message_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n crmInboxV2Message_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n crmInboxV2Message_universal_d_ActionEvent as ActionEvent,\n crmInboxV2Message_universal_d_MessageEnvelope as MessageEnvelope,\n crmInboxV2Message_universal_d_WebhooksIdentificationData as WebhooksIdentificationData,\n crmInboxV2Message_universal_d_WebhooksIdentificationDataIdOneOf as WebhooksIdentificationDataIdOneOf,\n crmInboxV2Message_universal_d_WebhookIdentityType as WebhookIdentityType,\n crmInboxV2Message_universal_d_getMessageIndications as getMessageIndications,\n crmInboxV2Message_universal_d_addMessageIndications as addMessageIndications,\n crmInboxV2Message_universal_d_AddMessageIndicationsOptions as AddMessageIndicationsOptions,\n crmInboxV2Message_universal_d_listMessages as listMessages,\n crmInboxV2Message_universal_d_ListMessagesOptions as ListMessagesOptions,\n crmInboxV2Message_universal_d_sendMessage as sendMessage,\n crmInboxV2Message_universal_d_SendMessageOptions as SendMessageOptions,\n };\n }\n \n export { crmInboxV2Conversation_universal_d as conversations, crmInboxV2Message_universal_d as messages };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 * Features.\n * @internal\n */\n features?: Features;\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 * Billing cycle.\n * @internal\n */\n billingCycle?: BillingCycle;\n /**\n * \"false\" if premium plan can be upgraded, \"true\" if it's already the most advanced.\n * @internal\n */\n topTier?: boolean;\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 enum BillingCycle {\n UNKNOWN = \"UNKNOWN\",\n TWO_YEARS = \"TWO_YEARS\",\n YEARLY = \"YEARLY\",\n MONTHLY = \"MONTHLY\"\n }\n interface QuotaPeriod {\n /** Current quota period start date. */\n dateFrom?: Date | null;\n /** Current quota period end date - after which quota will roll over. */\n dateTo?: Date | null;\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 SupportTicketData {\n subject?: string;\n body?: string;\n agentReplyBody?: string | null;\n }\n interface RespondResponse {\n /** ID of the support ticket created (optional). */\n supportTicketId?: string | null;\n }\n /**\n * Retrieves email marketing account details.\n * @public\n * @documentationMaturity preview\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getAccountDetails(): Promise;\n /**\n * Retrieves email marketing account compliance details.\n * @internal\n * @documentationMaturity preview\n * @permissionId Shoutout.Read\n * @adminMethod\n */\n function getComplianceDetails(): Promise;\n /**\n * User response to an existing account suspension.\n * @internal\n * @documentationMaturity preview\n * @requiredField action\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function respond(action: Action, options?: RespondOptions): Promise;\n interface RespondOptions {\n supportTicketData?: SupportTicketData;\n }\n \n type emailMarketingV1AccountDetails_universal_d_AccountDetails = AccountDetails;\n type emailMarketingV1AccountDetails_universal_d_Package = Package;\n type emailMarketingV1AccountDetails_universal_d_Quota = Quota;\n type emailMarketingV1AccountDetails_universal_d_BillingCycle = BillingCycle;\n const emailMarketingV1AccountDetails_universal_d_BillingCycle: typeof BillingCycle;\n type emailMarketingV1AccountDetails_universal_d_QuotaPeriod = QuotaPeriod;\n type emailMarketingV1AccountDetails_universal_d_Features = Features;\n type emailMarketingV1AccountDetails_universal_d_GetAccountDetailsRequest = GetAccountDetailsRequest;\n type emailMarketingV1AccountDetails_universal_d_GetAccountDetailsResponse = GetAccountDetailsResponse;\n type emailMarketingV1AccountDetails_universal_d_GetComplianceDetailsRequest = GetComplianceDetailsRequest;\n type emailMarketingV1AccountDetails_universal_d_GetComplianceDetailsResponse = GetComplianceDetailsResponse;\n type emailMarketingV1AccountDetails_universal_d_ComplianceDetails = ComplianceDetails;\n type emailMarketingV1AccountDetails_universal_d_RespondRequest = RespondRequest;\n type emailMarketingV1AccountDetails_universal_d_Action = Action;\n const emailMarketingV1AccountDetails_universal_d_Action: typeof Action;\n type emailMarketingV1AccountDetails_universal_d_SupportTicketData = SupportTicketData;\n type emailMarketingV1AccountDetails_universal_d_RespondResponse = RespondResponse;\n const emailMarketingV1AccountDetails_universal_d_getAccountDetails: typeof getAccountDetails;\n const emailMarketingV1AccountDetails_universal_d_getComplianceDetails: typeof getComplianceDetails;\n const emailMarketingV1AccountDetails_universal_d_respond: typeof respond;\n type emailMarketingV1AccountDetails_universal_d_RespondOptions = RespondOptions;\n namespace emailMarketingV1AccountDetails_universal_d {\n export {\n emailMarketingV1AccountDetails_universal_d_AccountDetails as AccountDetails,\n Enum$1 as Enum,\n emailMarketingV1AccountDetails_universal_d_Package as Package,\n emailMarketingV1AccountDetails_universal_d_Quota as Quota,\n emailMarketingV1AccountDetails_universal_d_BillingCycle as BillingCycle,\n emailMarketingV1AccountDetails_universal_d_QuotaPeriod as QuotaPeriod,\n emailMarketingV1AccountDetails_universal_d_Features as Features,\n emailMarketingV1AccountDetails_universal_d_GetAccountDetailsRequest as GetAccountDetailsRequest,\n emailMarketingV1AccountDetails_universal_d_GetAccountDetailsResponse as GetAccountDetailsResponse,\n emailMarketingV1AccountDetails_universal_d_GetComplianceDetailsRequest as GetComplianceDetailsRequest,\n emailMarketingV1AccountDetails_universal_d_GetComplianceDetailsResponse as GetComplianceDetailsResponse,\n emailMarketingV1AccountDetails_universal_d_ComplianceDetails as ComplianceDetails,\n emailMarketingV1AccountDetails_universal_d_RespondRequest as RespondRequest,\n emailMarketingV1AccountDetails_universal_d_Action as Action,\n emailMarketingV1AccountDetails_universal_d_SupportTicketData as SupportTicketData,\n emailMarketingV1AccountDetails_universal_d_RespondResponse as RespondResponse,\n emailMarketingV1AccountDetails_universal_d_getAccountDetails as getAccountDetails,\n emailMarketingV1AccountDetails_universal_d_getComplianceDetails as getComplianceDetails,\n emailMarketingV1AccountDetails_universal_d_respond as respond,\n emailMarketingV1AccountDetails_universal_d_RespondOptions as RespondOptions,\n };\n }\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 the first image after the logo. */\n firstImageUrl?: string | null;\n /**\n * Landing page snapshot URL.
      \n * This field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.\n * The value of this field will soon become the same as the value of the `firstImageUrl` field.\n * @deprecated Landing page snapshot URL.
      \n * This field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.\n * The value of this field will soon become the same as the value of the `firstImageUrl` field.\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 | null;\n /** Campaign last update date. */\n dateUpdated?: Date | null;\n /**\n * Date when the campaign is scheduled, only set if it is a scheduled campaign.\n * @internal\n */\n dateScheduled?: Date | null;\n /**\n * Rejection data (present only if campaign was rejected).\n * @internal\n */\n rejectionData?: RejectionData;\n /**\n * The sending state of the campaign.\n * @internal\n */\n sendingState?: CampaignSendingStateEnum;\n /**\n * The type of campaign: email marketing, triggered email or automations.\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * Transactional code of the campaign (only relevant for triggered emails).\n * @internal\n */\n transactionalCode?: string | null;\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 | null;\n /**\n * \"Parent\" campaign ID.\n * @internal\n */\n resentFromCampaignId?: string | null;\n /**\n * Whether this campaign was resent to recipients who did not open an email.\n * @internal\n */\n wasResentToNonOpeners?: boolean;\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 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 | null;\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 * 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 * @internal\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 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 | null;\n /**\n * Automation template updated date\n * @readonly\n */\n _updatedDate?: Date | null;\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 LookupCampaignMappingRequest {\n /** rule ID in automations */\n automationRuleId?: string;\n /** template ID configured for the automation */\n templateId?: string;\n }\n interface LookupCampaignMappingResponse {\n campaignId?: string | null;\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * Include campaigns with the following distribution statuses (no filtering by default). 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 * @internal\n */\n distributionStatuses?: Enum[];\n /**\n * Filter campaigns by publish date (no filtering by default).\n * @internal\n */\n datePublishedFrom?: Date | null;\n /** @internal */\n datePublishedTo?: Date | null;\n /**\n * Filter by subject line.\n * @internal\n */\n subjectSubstring?: string | null;\n /**\n * Preferred language for campaign content (optional).\n * @internal\n */\n language?: string | null;\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 | null;\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 30 minutes in the future, for premium users only). */\n sendAt?: Date | null;\n /**\n * Contacts filter expression (json).\n * @internal\n */\n contactsFilter?: Record | null;\n /**\n * Segment ids to send campaign to.\n * @internal\n */\n segmentIds?: string[];\n /**\n * Should \"inactive\" contacts be excluded or not (default value \"false\").\n * @internal\n */\n activeContactsOnly?: boolean;\n /**\n * Contacts plain text search expression (searches in name, phone and email fields).\n * @internal\n */\n search?: string | null;\n }\n interface PublishCampaignResponse {\n /** `publishingData.statistics` will be empty. */\n publishingData?: PublishingData;\n }\n interface Rejected {\n /** ID of the campaign that was rejected. */\n campaignId?: string;\n }\n interface Published {\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 Terminated {\n /** ID of the campaign that was terminated. */\n campaignId?: string;\n }\n interface Distributed {\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 | null;\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 a 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 Scheduled {\n /** ID of the campaign that was scheduled. */\n campaignId?: string;\n /** The timestamp campaign is scheduled for. */\n sendAt?: Date | null;\n /** Shows if this is a rescheduling of previously scheduled campaign. */\n rescheduled?: boolean;\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 * Preferred language for campaign content (optional).\n * @internal\n */\n language?: string | null;\n /**\n * Values to replace campaign placeholders with (unique for each campaign).\n * @internal\n */\n placeholders?: Record;\n /**\n * Sender from name.\n * @internal\n */\n fromName?: string | null;\n /**\n * Reply-to email address.\n * @internal\n */\n replyToEmailAddress?: string | null;\n /**\n * Whether to hide the ad (default value \"false\").\n * @internal\n */\n forceHideAd?: boolean;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 | null;\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 Paused {\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 /** The new time for sending out the campaign. */\n sendAt: Date | null;\n }\n interface RescheduleResponse {\n }\n interface ArchiveCampaignRequest {\n /** ID of the campaign to archive. */\n campaignId: string;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n interface ArchiveCampaignResponse {\n }\n /** Sent when status of the campaign is changed from \"Active\" to \"Archived\" */\n interface Archived {\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n interface UnarchiveCampaignResponse {\n }\n /** Sent when status of the campaign is changed from \"Archived\" to \"Active\" */\n interface Unarchived {\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 /** New title to set. */\n title: string;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n interface UpdateTitleResponse {\n }\n interface DeleteCampaignRequest {\n /** Campaign ID. */\n campaignId: string;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n interface DeleteCampaignResponse {\n }\n interface ReuseCampaignRequest {\n /** ID of the message to be duplicated. */\n campaignId: string;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 GetAudienceRequest {\n /** Campaign ID. */\n campaignId: string;\n }\n interface GetAudienceResponse {\n /** Campaign audience. */\n audience?: CampaignAudience;\n }\n interface CampaignAudience {\n /** Contact IDs to send campaign to. */\n contactIds?: string[];\n /** Label IDs to send campaign to. */\n labelIds?: string[];\n /** Segment ids to send campaign to. */\n segmentIds?: string[];\n /** Contacts filter expression (json). */\n contactsFilter?: Record | null;\n /** Contacts plain text search expression (searches in name, phone and email fields). */\n contactsSearchTerm?: string | null;\n /** Should \"inactive\" contacts be excluded or not. */\n activeContactsOnly?: boolean;\n }\n interface IdentifySenderAddressRequest {\n /** User's provided arbitrary email address. */\n emailAddress: string;\n }\n interface IdentifySenderAddressResponse {\n /** Actual from-address that will be used for sending emails. */\n senderAddress?: 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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Estimates number of valid contacts by given filter and (optional) search expressions.\n * In Email Marketing context \"valid\" means that bounced/unsubscribed/blacklisted contacts are filtered out.\n * @param filter - Contacts filter expression.\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function estimateFilterSize(filter: Record | null, options?: EstimateFilterSizeOptions): Promise;\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 /**\n * Estimates number of contacts of campaign's audience.\n * Audience size depends on various filters and search expressions.\n * @internal\n * @documentationMaturity preview\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function estimateAudienceSize(options?: EstimateAudienceSizeOptions): Promise;\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 /**\n * Creates new contact with given email address if one didn't exist before.\n * @param emailAddress - Email address of the contact.\n * @internal\n * @documentationMaturity preview\n * @requiredField emailAddress\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function reconcileContact(emailAddress: string): Promise;\n /**\n * Searches for contacts with an email address.\n * @param searchTerm - Text to search contacts by - can search by name or email address.\n * @internal\n * @documentationMaturity preview\n * @requiredField searchTerm\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function searchContacts(searchTerm: string, options?: SearchContactsOptions): Promise;\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 /**\n * Get labels with contact counts.\n * @internal\n * @documentationMaturity preview\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getLabels(options?: GetLabelsOptions): Promise;\n interface GetLabelsOptions {\n /** Should \"inactive\" contacts be excluded or not (default value \"false\"). */\n activeContactsOnly?: boolean;\n }\n /**\n * Create and subscribe contact after filling subscription form in campaign landing page.\n * @param campaignId - Campaign ID that the subscription is happening from.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField options.emailAddress\n * @adminMethod\n */\n function subscribeFromLandingPage(campaignId: string, options?: SubscribeFromLandingPageOptions): Promise;\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 * Get keys of placeholders used in a given campaign, excluding email marketing placeholder keys.\n * @param campaignId - Campaign ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getPlaceholderKeys(campaignId: string): Promise;\n /**\n * Get default campaign components - \"footer\", \"logo\", \"follow\".\n * @internal\n * @documentationMaturity preview\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getDefaultComponents(): Promise;\n /**\n * validate given link for use in campaign against abuse rules\n * supplied link could be a placeholder - it should be counted as valid\n * @param url - web URL\n * @public\n * @documentationMaturity preview\n * @requiredField url\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function validateLink(url: string): Promise;\n /**\n * extract links from given html and validate them for use in campaign against abuse rules\n * @param html - string containing HTML\n * @public\n * @documentationMaturity preview\n * @requiredField html\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function validateHtmlLinks(html: string): Promise;\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 * @permissionId Shoutout.Read\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 * @permissionId Shoutout.Read\n * @adminMethod\n */\n function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise;\n interface ListRecipientsOptions {\n /** Pagination options. */\n paging?: CursorPaging;\n }\n /**\n * get or create campaign mapping for automation\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.automationRuleId\n * @requiredField identifiers.templateId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getCampaignMapping(identifiers: GetCampaignMappingIdentifiers): Promise;\n interface GetCampaignMappingIdentifiers {\n /** rule ID in automations */\n automationRuleId: string;\n /** template ID configured for the automation */\n templateId: string;\n }\n /**\n * get campaign mapping for ping\n * @param streamId - ping stream ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.automationRuleId\n * @requiredField identifiers.templateId\n * @requiredField options.appDefId\n * @requiredField options.language\n * @requiredField streamId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getPingCampaignMapping(identifiers: GetPingCampaignMappingIdentifiers, streamId: string, options?: GetPingCampaignMappingOptions): Promise;\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 /**\n * query automation templates from \"action-triggers-server\" (enriched with campaignId and metaSiteId)\n * https://github.com/wix-private/crm/blob/master/action-triggers-server/action-triggers-integrator-idl/src/main/proto/services/AutomationTemplatesService.proto#L100\n * NOTE: it does not support multi-step automations - enrichment will happen for the first shoutout template id found\n * @internal\n * @documentationMaturity preview\n * @permissionId EMAIL_MARKETING.LIST_AUTOMATIONS\n * @adminMethod\n */\n function queryAutomationTemplates(options?: QueryAutomationTemplatesOptions): Promise;\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 /** @internal\n * @documentationMaturity preview\n * @permissionId EMAIL_MARKETING.LIST_AUTOMATIONS\n * @adminMethod\n */\n function queryAppTemplates(options?: QueryAppTemplatesOptions): Promise;\n interface QueryAppTemplatesOptions {\n queryType?: TemplateQueryType;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId EMAIL_MARKETING.LOOKUP_CAMPAIGN\n * @adminMethod\n */\n function campaignLookup(campaignId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId EMAIL_MARKETING.LOOKUP_CAMPAIGN\n * @adminMethod\n */\n function campaignLookupBatch(options?: CampaignLookupBatchOptions): Promise;\n interface CampaignLookupBatchOptions {\n campaignIds?: string[];\n }\n /** @param campaignId - Campaign ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField options.composer.composerDataJson\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function upsertTranslation(campaignId: string, options?: UpsertTranslationOptions): Promise;\n interface UpsertTranslationOptions {\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 /**\n * get keys of placeholders used in a given automation.\n * @param campaignId - Campaign ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getUsedPlaceholderKeys(campaignId: string): Promise;\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 * @permissionId Shoutout.Manage\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\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 * @permissionId Shoutout.Manage\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 * Include campaigns with the following distribution statuses (no filtering by default). 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 * @internal\n */\n distributionStatuses?: Enum[];\n /**\n * Filter campaigns by publish date (no filtering by default).\n * @internal\n */\n datePublishedFrom?: Date | null;\n /** @internal */\n datePublishedTo?: Date | null;\n /**\n * Filter by subject line.\n * @internal\n */\n subjectSubstring?: string | null;\n /**\n * Preferred language for campaign content (optional).\n * @internal\n */\n language?: string | null;\n }\n /**\n * Counts site campaigns.\n * @internal\n * @documentationMaturity preview\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function count(options?: CountOptions): Promise;\n interface CountOptions {\n /** Since when should we start counting (optional, default value \"1970-01-01T00:00:00.000Z\") */\n dateFrom?: Date | null;\n }\n /**\n * Creates a new draft campaign from a specified template.\n * It can be accessed from TemplateService by tag, or you can ask your designer.\n * @param templateId - ID of the template to fork.\n * @internal\n * @documentationMaturity preview\n * @requiredField templateId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function createFromTemplate(templateId: string, options?: CreateFromTemplateOptions): Promise;\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 /**\n * Create a user template from campaign.\n * @param campaignId - ID of campaign to create template from.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function createUserTemplate(campaignId: string, options?: CreateUserTemplateOptions): Promise;\n interface CreateUserTemplateOptions {\n /** Title of template. */\n title?: string | null;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * Create a draft EM campaign from user template.\n * @param campaignId - ID of the user template campaign to use.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function createFromUserTemplate(campaignId: string): Promise;\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 * @permissionId Shoutout.Manage\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 * @permissionId Shoutout.Manage\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 * Preferred language for campaign content (optional).\n * @internal\n */\n language?: string | null;\n /**\n * Values to replace campaign placeholders with (unique for each campaign).\n * @internal\n */\n placeholders?: Record;\n /**\n * Sender from name.\n * @internal\n */\n fromName?: string | null;\n /**\n * Reply-to email address.\n * @internal\n */\n replyToEmailAddress?: string | null;\n /**\n * Whether to hide the ad (default value \"false\").\n * @internal\n */\n forceHideAd?: boolean;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * Pauses a scheduled campaign. 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 * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function pauseScheduling(campaignId: string): Promise;\n /**\n * Changes the sending time for an already scheduled campaign.\n * @param campaignId - ID of the campaign to reschedule.\n * @param sendAt - The new time for sending out the campaign.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField sendAt\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function reschedule(campaignId: string, sendAt: Date | null): Promise;\n /**\n * Marks a campaign as archived\n * @param campaignId - ID of the campaign to archive.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function archiveCampaign(campaignId: string, options?: ArchiveCampaignOptions): Promise;\n interface ArchiveCampaignOptions {\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * Marks a campaign as active\n * @param campaignId - ID of the campaign to unarchive.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function unarchiveCampaign(campaignId: string, options?: UnarchiveCampaignOptions): Promise;\n interface UnarchiveCampaignOptions {\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * Changes title of the campaign\n * @param campaignId - ID of the campaign to change title of.\n * @param title - New title to set.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField title\n * @permissionId EMAIL_MARKETING.UPDATE_CAMPAIGN_TITLE\n * @adminMethod\n */\n function updateTitle(campaignId: string, title: string, options?: UpdateTitleOptions): Promise;\n interface UpdateTitleOptions {\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * Permanently deletes a campaign.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function deleteCampaign(campaignId: string, options?: DeleteCampaignOptions): Promise;\n interface DeleteCampaignOptions {\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\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 * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function reuseCampaign(campaignId: string, options?: ReuseCampaignOptions): Promise;\n interface ReuseCampaignOptions {\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * Build an HTML preview of the campaign. Useful if you need to show the user what their email will look like.\n * @param campaignId - ID of the campaign to preview.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function preview(campaignId: string, options?: PreviewOptions): 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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * For internal use.\n * @param campaignId - Campaign ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getComposer(campaignId: string, options?: GetComposerOptions): Promise;\n interface GetComposerOptions {\n /** Preferred language for campaign content (optional). */\n language?: string | null;\n /**\n * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * For internal use.\n * @param campaignId - Campaign ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @requiredField options.composer.composerDataJson\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function updateComposer(campaignId: string, options?: UpdateComposerOptions): Promise;\n interface UpdateComposerOptions {\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 * Entity type (for api-proxy).\n * @internal\n */\n campaignType?: CampaignTypeEnum;\n }\n /**\n * For internal use (EM).\n * @param composer - Campaign composer.\n * @internal\n * @documentationMaturity preview\n * @requiredField composer\n * @requiredField composer.composerDataJson\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function create(composer: Composer, options?: CreateOptions): Promise;\n interface CreateOptions {\n /** Campaign editor type. Either web app or mobile app (optional, default \"Web\"). */\n campaignEditorType?: CampaignEditorType;\n }\n /**\n * Resends a copy of campaign to users that did not open it. Different subject line may be used for the new campaign if necessary.\n * @param campaignId - ID of the campaign to resend.\n * @internal\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function resendToNonOpeners(campaignId: string, options?: ResendToNonOpenersOptions): Promise;\n interface ResendToNonOpenersOptions {\n /** Subject line to use with the resent copy of campaign. */\n emailSubject?: string | null;\n }\n /**\n * Return audience \"assigned\" to paused campaign at the time of scheduling.\n * @param campaignId - Campaign ID.\n * @public\n * @documentationMaturity preview\n * @requiredField campaignId\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function getAudience(campaignId: string): Promise;\n /**\n * Check if user's email address will be used as from address or will it be replaced and to what exactly.\n * @param emailAddress - User's provided arbitrary email address.\n * @public\n * @documentationMaturity preview\n * @requiredField emailAddress\n * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function identifySenderAddress(emailAddress: string): Promise;\n \n type emailMarketingV1Campaign_universal_d_Campaign = Campaign;\n type emailMarketingV1Campaign_universal_d_CampaignEditorTypeEnum = CampaignEditorTypeEnum;\n const emailMarketingV1Campaign_universal_d_CampaignEditorTypeEnum: typeof CampaignEditorTypeEnum;\n type emailMarketingV1Campaign_universal_d_CampaignStatusEnum = CampaignStatusEnum;\n const emailMarketingV1Campaign_universal_d_CampaignStatusEnum: typeof CampaignStatusEnum;\n type emailMarketingV1Campaign_universal_d_CampaignVisibilityStatusEnum = CampaignVisibilityStatusEnum;\n const emailMarketingV1Campaign_universal_d_CampaignVisibilityStatusEnum: typeof CampaignVisibilityStatusEnum;\n type emailMarketingV1Campaign_universal_d_Enum = Enum;\n const emailMarketingV1Campaign_universal_d_Enum: typeof Enum;\n type emailMarketingV1Campaign_universal_d_PublishingData = PublishingData;\n type emailMarketingV1Campaign_universal_d_CampaignStatistics = CampaignStatistics;\n type emailMarketingV1Campaign_universal_d_LandingPageStatistics = LandingPageStatistics;\n type emailMarketingV1Campaign_universal_d_DistributionStatistics = DistributionStatistics;\n type emailMarketingV1Campaign_universal_d_TotalStatistics = TotalStatistics;\n type emailMarketingV1Campaign_universal_d_RejectionData = RejectionData;\n type emailMarketingV1Campaign_universal_d_RejectionReasonEnum = RejectionReasonEnum;\n const emailMarketingV1Campaign_universal_d_RejectionReasonEnum: typeof RejectionReasonEnum;\n type emailMarketingV1Campaign_universal_d_CampaignSendingStateEnum = CampaignSendingStateEnum;\n const emailMarketingV1Campaign_universal_d_CampaignSendingStateEnum: typeof CampaignSendingStateEnum;\n type emailMarketingV1Campaign_universal_d_CampaignTypeEnum = CampaignTypeEnum;\n const emailMarketingV1Campaign_universal_d_CampaignTypeEnum: typeof CampaignTypeEnum;\n type emailMarketingV1Campaign_universal_d_EstimateFilterSizeRequest = EstimateFilterSizeRequest;\n type emailMarketingV1Campaign_universal_d_EstimateFilterSizeResponse = EstimateFilterSizeResponse;\n type emailMarketingV1Campaign_universal_d_EstimateAudienceSizeRequest = EstimateAudienceSizeRequest;\n type emailMarketingV1Campaign_universal_d_EstimateAudienceSizeResponse = EstimateAudienceSizeResponse;\n type emailMarketingV1Campaign_universal_d_ReconcileContactRequest = ReconcileContactRequest;\n type emailMarketingV1Campaign_universal_d_ReconcileContactResponse = ReconcileContactResponse;\n type emailMarketingV1Campaign_universal_d_Contact = Contact;\n type emailMarketingV1Campaign_universal_d_SearchContactsRequest = SearchContactsRequest;\n type emailMarketingV1Campaign_universal_d_SearchContactsResponse = SearchContactsResponse;\n type emailMarketingV1Campaign_universal_d_GetLabelsRequest = GetLabelsRequest;\n type emailMarketingV1Campaign_universal_d_GetLabelsResponse = GetLabelsResponse;\n type emailMarketingV1Campaign_universal_d_Label = Label;\n type emailMarketingV1Campaign_universal_d_SubscribeFromLandingPageRequest = SubscribeFromLandingPageRequest;\n type emailMarketingV1Campaign_universal_d_SubscribeFromLandingPageResponse = SubscribeFromLandingPageResponse;\n type emailMarketingV1Campaign_universal_d_GetPlaceholderKeysRequest = GetPlaceholderKeysRequest;\n type emailMarketingV1Campaign_universal_d_GetPlaceholderKeysResponse = GetPlaceholderKeysResponse;\n type emailMarketingV1Campaign_universal_d_GetDefaultComponentsRequest = GetDefaultComponentsRequest;\n type emailMarketingV1Campaign_universal_d_GetDefaultComponentsResponse = GetDefaultComponentsResponse;\n type emailMarketingV1Campaign_universal_d_ValidateLinkRequest = ValidateLinkRequest;\n type emailMarketingV1Campaign_universal_d_ValidateLinkResponse = ValidateLinkResponse;\n type emailMarketingV1Campaign_universal_d_ValidateHtmlLinksRequest = ValidateHtmlLinksRequest;\n type emailMarketingV1Campaign_universal_d_ValidateHtmlLinksResponse = ValidateHtmlLinksResponse;\n type emailMarketingV1Campaign_universal_d_ListStatisticsRequest = ListStatisticsRequest;\n type emailMarketingV1Campaign_universal_d_ListStatisticsResponse = ListStatisticsResponse;\n type emailMarketingV1Campaign_universal_d_CampaignStatisticsContainer = CampaignStatisticsContainer;\n type emailMarketingV1Campaign_universal_d_ListRecipientsRequest = ListRecipientsRequest;\n type emailMarketingV1Campaign_universal_d_RecipientsActivityEnum = RecipientsActivityEnum;\n const emailMarketingV1Campaign_universal_d_RecipientsActivityEnum: typeof RecipientsActivityEnum;\n type emailMarketingV1Campaign_universal_d_CursorPaging = CursorPaging;\n type emailMarketingV1Campaign_universal_d_ListRecipientsResponse = ListRecipientsResponse;\n type emailMarketingV1Campaign_universal_d_CampaignRecipientDetails = CampaignRecipientDetails;\n type emailMarketingV1Campaign_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type emailMarketingV1Campaign_universal_d_Cursors = Cursors;\n type emailMarketingV1Campaign_universal_d_GetCampaignMappingRequest = GetCampaignMappingRequest;\n type emailMarketingV1Campaign_universal_d_GetCampaignMappingResponse = GetCampaignMappingResponse;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingRequest = GetPingCampaignMappingRequest;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingResponse = GetPingCampaignMappingResponse;\n type emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesRequest = QueryAutomationTemplatesRequest;\n type emailMarketingV1Campaign_universal_d_Query = Query;\n type emailMarketingV1Campaign_universal_d_Sorting = Sorting;\n type emailMarketingV1Campaign_universal_d_SortOrder = SortOrder;\n const emailMarketingV1Campaign_universal_d_SortOrder: typeof SortOrder;\n type emailMarketingV1Campaign_universal_d_Paging = Paging;\n type emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesResponse = QueryAutomationTemplatesResponse;\n type emailMarketingV1Campaign_universal_d_AutomationTemplateContainer = AutomationTemplateContainer;\n type emailMarketingV1Campaign_universal_d_AutomationTemplate = AutomationTemplate;\n type emailMarketingV1Campaign_universal_d_RuleConfiguration = RuleConfiguration;\n type emailMarketingV1Campaign_universal_d_ConditionConfiguration = ConditionConfiguration;\n type emailMarketingV1Campaign_universal_d_Operator = Operator;\n const emailMarketingV1Campaign_universal_d_Operator: typeof Operator;\n type emailMarketingV1Campaign_universal_d_TriggerConfiguration = TriggerConfiguration;\n type emailMarketingV1Campaign_universal_d_ActionConfiguration = ActionConfiguration;\n type emailMarketingV1Campaign_universal_d_RuleStatus = RuleStatus;\n const emailMarketingV1Campaign_universal_d_RuleStatus: typeof RuleStatus;\n type emailMarketingV1Campaign_universal_d_ActivationCycle = ActivationCycle;\n type emailMarketingV1Campaign_universal_d_RuleMetadata = RuleMetadata;\n type emailMarketingV1Campaign_universal_d_VersionType = VersionType;\n const emailMarketingV1Campaign_universal_d_VersionType: typeof VersionType;\n type emailMarketingV1Campaign_universal_d_TemplateType = TemplateType;\n const emailMarketingV1Campaign_universal_d_TemplateType: typeof TemplateType;\n type emailMarketingV1Campaign_universal_d_Precondition = Precondition;\n type emailMarketingV1Campaign_universal_d_PreconditionType = PreconditionType;\n const emailMarketingV1Campaign_universal_d_PreconditionType: typeof PreconditionType;\n type emailMarketingV1Campaign_universal_d_TemplateState = TemplateState;\n const emailMarketingV1Campaign_universal_d_TemplateState: typeof TemplateState;\n type emailMarketingV1Campaign_universal_d_Translation = Translation;\n type emailMarketingV1Campaign_universal_d_TranslationState = TranslationState;\n const emailMarketingV1Campaign_universal_d_TranslationState: typeof TranslationState;\n type emailMarketingV1Campaign_universal_d_AutomationTemplateEnrichmentData = AutomationTemplateEnrichmentData;\n type emailMarketingV1Campaign_universal_d_QueryMetadata = QueryMetadata;\n type emailMarketingV1Campaign_universal_d_QueryAppTemplatesRequest = QueryAppTemplatesRequest;\n type emailMarketingV1Campaign_universal_d_TemplateQueryType = TemplateQueryType;\n const emailMarketingV1Campaign_universal_d_TemplateQueryType: typeof TemplateQueryType;\n type emailMarketingV1Campaign_universal_d_QueryAppTemplatesResponse = QueryAppTemplatesResponse;\n type emailMarketingV1Campaign_universal_d_TemplateData = TemplateData;\n type emailMarketingV1Campaign_universal_d_CampaignLookupRequest = CampaignLookupRequest;\n type emailMarketingV1Campaign_universal_d_CampaignLookupResponse = CampaignLookupResponse;\n type emailMarketingV1Campaign_universal_d_CampaignLookupBatchRequest = CampaignLookupBatchRequest;\n type emailMarketingV1Campaign_universal_d_CampaignLookupBatchResponse = CampaignLookupBatchResponse;\n type emailMarketingV1Campaign_universal_d_UpsertTranslationRequest = UpsertTranslationRequest;\n type emailMarketingV1Campaign_universal_d_Composer = Composer;\n type emailMarketingV1Campaign_universal_d_DefaultValues = DefaultValues;\n type emailMarketingV1Campaign_universal_d_UpsertTranslationResponse = UpsertTranslationResponse;\n type emailMarketingV1Campaign_universal_d_GetUsedPlaceholderKeysRequest = GetUsedPlaceholderKeysRequest;\n type emailMarketingV1Campaign_universal_d_GetUsedPlaceholderKeysResponse = GetUsedPlaceholderKeysResponse;\n type emailMarketingV1Campaign_universal_d_LookupCampaignMappingRequest = LookupCampaignMappingRequest;\n type emailMarketingV1Campaign_universal_d_LookupCampaignMappingResponse = LookupCampaignMappingResponse;\n type emailMarketingV1Campaign_universal_d_GetCampaignRequest = GetCampaignRequest;\n type emailMarketingV1Campaign_universal_d_GetCampaignResponse = GetCampaignResponse;\n type emailMarketingV1Campaign_universal_d_ListCampaignsRequest = ListCampaignsRequest;\n type emailMarketingV1Campaign_universal_d_ListCampaignsResponse = ListCampaignsResponse;\n type emailMarketingV1Campaign_universal_d_CountCampaignsRequest = CountCampaignsRequest;\n type emailMarketingV1Campaign_universal_d_CountCampaignsResponse = CountCampaignsResponse;\n type emailMarketingV1Campaign_universal_d_CreateFromTemplateRequest = CreateFromTemplateRequest;\n type emailMarketingV1Campaign_universal_d_CreateFromTemplateResponse = CreateFromTemplateResponse;\n type emailMarketingV1Campaign_universal_d_CreateUserTemplateRequest = CreateUserTemplateRequest;\n type emailMarketingV1Campaign_universal_d_CreateUserTemplateResponse = CreateUserTemplateResponse;\n type emailMarketingV1Campaign_universal_d_CreateFromUserTemplateRequest = CreateFromUserTemplateRequest;\n type emailMarketingV1Campaign_universal_d_CreateFromUserTemplateResponse = CreateFromUserTemplateResponse;\n type emailMarketingV1Campaign_universal_d_PublishCampaignRequest = PublishCampaignRequest;\n type emailMarketingV1Campaign_universal_d_EmailDistributionOptions = EmailDistributionOptions;\n type emailMarketingV1Campaign_universal_d_PublishCampaignResponse = PublishCampaignResponse;\n type emailMarketingV1Campaign_universal_d_Rejected = Rejected;\n type emailMarketingV1Campaign_universal_d_Published = Published;\n type emailMarketingV1Campaign_universal_d_Terminated = Terminated;\n type emailMarketingV1Campaign_universal_d_Distributed = Distributed;\n type emailMarketingV1Campaign_universal_d_EmailActivityUpdated = EmailActivityUpdated;\n type emailMarketingV1Campaign_universal_d_EmailActivityUpdatedEventTypeOneOf = EmailActivityUpdatedEventTypeOneOf;\n type emailMarketingV1Campaign_universal_d_ActivityType = ActivityType;\n const emailMarketingV1Campaign_universal_d_ActivityType: typeof ActivityType;\n type emailMarketingV1Campaign_universal_d_Click = Click;\n type emailMarketingV1Campaign_universal_d_Open = Open;\n type emailMarketingV1Campaign_universal_d_SoftBounce = SoftBounce;\n type emailMarketingV1Campaign_universal_d_HardBounce = HardBounce;\n type emailMarketingV1Campaign_universal_d_Scheduled = Scheduled;\n type emailMarketingV1Campaign_universal_d_SendTestRequest = SendTestRequest;\n type emailMarketingV1Campaign_universal_d_PlaceholderContent = PlaceholderContent;\n type emailMarketingV1Campaign_universal_d_PlaceholderContentValueOneOf = PlaceholderContentValueOneOf;\n type emailMarketingV1Campaign_universal_d_PlainText = PlainText;\n type emailMarketingV1Campaign_universal_d_Html = Html;\n type emailMarketingV1Campaign_universal_d_Money = Money;\n type emailMarketingV1Campaign_universal_d_DateTime = DateTime;\n type emailMarketingV1Campaign_universal_d_Map = Map;\n type emailMarketingV1Campaign_universal_d_Array = Array;\n type emailMarketingV1Campaign_universal_d_PlaceholderContentEnum = PlaceholderContentEnum;\n type emailMarketingV1Campaign_universal_d_Attachment = Attachment;\n type emailMarketingV1Campaign_universal_d_Integer = Integer;\n type emailMarketingV1Campaign_universal_d_Decimal = Decimal;\n type emailMarketingV1Campaign_universal_d_SendTestResponse = SendTestResponse;\n type emailMarketingV1Campaign_universal_d_PauseSchedulingRequest = PauseSchedulingRequest;\n type emailMarketingV1Campaign_universal_d_PauseSchedulingResponse = PauseSchedulingResponse;\n type emailMarketingV1Campaign_universal_d_Paused = Paused;\n type emailMarketingV1Campaign_universal_d_RescheduleRequest = RescheduleRequest;\n type emailMarketingV1Campaign_universal_d_RescheduleResponse = RescheduleResponse;\n type emailMarketingV1Campaign_universal_d_ArchiveCampaignRequest = ArchiveCampaignRequest;\n type emailMarketingV1Campaign_universal_d_ArchiveCampaignResponse = ArchiveCampaignResponse;\n type emailMarketingV1Campaign_universal_d_Archived = Archived;\n type emailMarketingV1Campaign_universal_d_UnarchiveCampaignRequest = UnarchiveCampaignRequest;\n type emailMarketingV1Campaign_universal_d_UnarchiveCampaignResponse = UnarchiveCampaignResponse;\n type emailMarketingV1Campaign_universal_d_Unarchived = Unarchived;\n type emailMarketingV1Campaign_universal_d_UpdateTitleRequest = UpdateTitleRequest;\n type emailMarketingV1Campaign_universal_d_UpdateTitleResponse = UpdateTitleResponse;\n type emailMarketingV1Campaign_universal_d_DeleteCampaignRequest = DeleteCampaignRequest;\n type emailMarketingV1Campaign_universal_d_DeleteCampaignResponse = DeleteCampaignResponse;\n type emailMarketingV1Campaign_universal_d_ReuseCampaignRequest = ReuseCampaignRequest;\n type emailMarketingV1Campaign_universal_d_ReuseCampaignResponse = ReuseCampaignResponse;\n type emailMarketingV1Campaign_universal_d_PreviewCampaignRequest = PreviewCampaignRequest;\n type emailMarketingV1Campaign_universal_d_PreviewCampaignResponse = PreviewCampaignResponse;\n type emailMarketingV1Campaign_universal_d_GetComposerRequest = GetComposerRequest;\n type emailMarketingV1Campaign_universal_d_GetComposerResponse = GetComposerResponse;\n type emailMarketingV1Campaign_universal_d_UpdateComposerRequest = UpdateComposerRequest;\n type emailMarketingV1Campaign_universal_d_CampaignEditorType = CampaignEditorType;\n type emailMarketingV1Campaign_universal_d_UpdateComposerResponse = UpdateComposerResponse;\n type emailMarketingV1Campaign_universal_d_CreateCampaignRequest = CreateCampaignRequest;\n type emailMarketingV1Campaign_universal_d_CreateCampaignResponse = CreateCampaignResponse;\n type emailMarketingV1Campaign_universal_d_ResendToNonOpenersRequest = ResendToNonOpenersRequest;\n type emailMarketingV1Campaign_universal_d_ResendToNonOpenersResponse = ResendToNonOpenersResponse;\n type emailMarketingV1Campaign_universal_d_GetAudienceRequest = GetAudienceRequest;\n type emailMarketingV1Campaign_universal_d_GetAudienceResponse = GetAudienceResponse;\n type emailMarketingV1Campaign_universal_d_CampaignAudience = CampaignAudience;\n type emailMarketingV1Campaign_universal_d_IdentifySenderAddressRequest = IdentifySenderAddressRequest;\n type emailMarketingV1Campaign_universal_d_IdentifySenderAddressResponse = IdentifySenderAddressResponse;\n const emailMarketingV1Campaign_universal_d_estimateFilterSize: typeof estimateFilterSize;\n type emailMarketingV1Campaign_universal_d_EstimateFilterSizeOptions = EstimateFilterSizeOptions;\n const emailMarketingV1Campaign_universal_d_estimateAudienceSize: typeof estimateAudienceSize;\n type emailMarketingV1Campaign_universal_d_EstimateAudienceSizeOptions = EstimateAudienceSizeOptions;\n const emailMarketingV1Campaign_universal_d_reconcileContact: typeof reconcileContact;\n const emailMarketingV1Campaign_universal_d_searchContacts: typeof searchContacts;\n type emailMarketingV1Campaign_universal_d_SearchContactsOptions = SearchContactsOptions;\n const emailMarketingV1Campaign_universal_d_getLabels: typeof getLabels;\n type emailMarketingV1Campaign_universal_d_GetLabelsOptions = GetLabelsOptions;\n const emailMarketingV1Campaign_universal_d_subscribeFromLandingPage: typeof subscribeFromLandingPage;\n type emailMarketingV1Campaign_universal_d_SubscribeFromLandingPageOptions = SubscribeFromLandingPageOptions;\n const emailMarketingV1Campaign_universal_d_getPlaceholderKeys: typeof getPlaceholderKeys;\n const emailMarketingV1Campaign_universal_d_getDefaultComponents: typeof getDefaultComponents;\n const emailMarketingV1Campaign_universal_d_validateLink: typeof validateLink;\n const emailMarketingV1Campaign_universal_d_validateHtmlLinks: typeof validateHtmlLinks;\n const emailMarketingV1Campaign_universal_d_listStatistics: typeof listStatistics;\n const emailMarketingV1Campaign_universal_d_listRecipients: typeof listRecipients;\n type emailMarketingV1Campaign_universal_d_ListRecipientsOptions = ListRecipientsOptions;\n const emailMarketingV1Campaign_universal_d_getCampaignMapping: typeof getCampaignMapping;\n type emailMarketingV1Campaign_universal_d_GetCampaignMappingIdentifiers = GetCampaignMappingIdentifiers;\n const emailMarketingV1Campaign_universal_d_getPingCampaignMapping: typeof getPingCampaignMapping;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingIdentifiers = GetPingCampaignMappingIdentifiers;\n type emailMarketingV1Campaign_universal_d_GetPingCampaignMappingOptions = GetPingCampaignMappingOptions;\n const emailMarketingV1Campaign_universal_d_queryAutomationTemplates: typeof queryAutomationTemplates;\n type emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesOptions = QueryAutomationTemplatesOptions;\n const emailMarketingV1Campaign_universal_d_queryAppTemplates: typeof queryAppTemplates;\n type emailMarketingV1Campaign_universal_d_QueryAppTemplatesOptions = QueryAppTemplatesOptions;\n const emailMarketingV1Campaign_universal_d_campaignLookup: typeof campaignLookup;\n const emailMarketingV1Campaign_universal_d_campaignLookupBatch: typeof campaignLookupBatch;\n type emailMarketingV1Campaign_universal_d_CampaignLookupBatchOptions = CampaignLookupBatchOptions;\n const emailMarketingV1Campaign_universal_d_upsertTranslation: typeof upsertTranslation;\n type emailMarketingV1Campaign_universal_d_UpsertTranslationOptions = UpsertTranslationOptions;\n const emailMarketingV1Campaign_universal_d_getUsedPlaceholderKeys: typeof getUsedPlaceholderKeys;\n const emailMarketingV1Campaign_universal_d_getCampaign: typeof getCampaign;\n type emailMarketingV1Campaign_universal_d_GetCampaignOptions = GetCampaignOptions;\n const emailMarketingV1Campaign_universal_d_listCampaigns: typeof listCampaigns;\n type emailMarketingV1Campaign_universal_d_ListCampaignsOptions = ListCampaignsOptions;\n const emailMarketingV1Campaign_universal_d_count: typeof count;\n type emailMarketingV1Campaign_universal_d_CountOptions = CountOptions;\n const emailMarketingV1Campaign_universal_d_createFromTemplate: typeof createFromTemplate;\n type emailMarketingV1Campaign_universal_d_CreateFromTemplateOptions = CreateFromTemplateOptions;\n const emailMarketingV1Campaign_universal_d_createUserTemplate: typeof createUserTemplate;\n type emailMarketingV1Campaign_universal_d_CreateUserTemplateOptions = CreateUserTemplateOptions;\n const emailMarketingV1Campaign_universal_d_createFromUserTemplate: typeof createFromUserTemplate;\n const emailMarketingV1Campaign_universal_d_publishCampaign: typeof publishCampaign;\n type emailMarketingV1Campaign_universal_d_PublishCampaignOptions = PublishCampaignOptions;\n const emailMarketingV1Campaign_universal_d_sendTest: typeof sendTest;\n type emailMarketingV1Campaign_universal_d_SendTestOptions = SendTestOptions;\n const emailMarketingV1Campaign_universal_d_pauseScheduling: typeof pauseScheduling;\n const emailMarketingV1Campaign_universal_d_reschedule: typeof reschedule;\n const emailMarketingV1Campaign_universal_d_archiveCampaign: typeof archiveCampaign;\n type emailMarketingV1Campaign_universal_d_ArchiveCampaignOptions = ArchiveCampaignOptions;\n const emailMarketingV1Campaign_universal_d_unarchiveCampaign: typeof unarchiveCampaign;\n type emailMarketingV1Campaign_universal_d_UnarchiveCampaignOptions = UnarchiveCampaignOptions;\n const emailMarketingV1Campaign_universal_d_updateTitle: typeof updateTitle;\n type emailMarketingV1Campaign_universal_d_UpdateTitleOptions = UpdateTitleOptions;\n const emailMarketingV1Campaign_universal_d_deleteCampaign: typeof deleteCampaign;\n type emailMarketingV1Campaign_universal_d_DeleteCampaignOptions = DeleteCampaignOptions;\n const emailMarketingV1Campaign_universal_d_reuseCampaign: typeof reuseCampaign;\n type emailMarketingV1Campaign_universal_d_ReuseCampaignOptions = ReuseCampaignOptions;\n const emailMarketingV1Campaign_universal_d_preview: typeof preview;\n type emailMarketingV1Campaign_universal_d_PreviewOptions = PreviewOptions;\n const emailMarketingV1Campaign_universal_d_getComposer: typeof getComposer;\n type emailMarketingV1Campaign_universal_d_GetComposerOptions = GetComposerOptions;\n const emailMarketingV1Campaign_universal_d_updateComposer: typeof updateComposer;\n type emailMarketingV1Campaign_universal_d_UpdateComposerOptions = UpdateComposerOptions;\n const emailMarketingV1Campaign_universal_d_create: typeof create;\n type emailMarketingV1Campaign_universal_d_CreateOptions = CreateOptions;\n const emailMarketingV1Campaign_universal_d_resendToNonOpeners: typeof resendToNonOpeners;\n type emailMarketingV1Campaign_universal_d_ResendToNonOpenersOptions = ResendToNonOpenersOptions;\n const emailMarketingV1Campaign_universal_d_getAudience: typeof getAudience;\n const emailMarketingV1Campaign_universal_d_identifySenderAddress: typeof identifySenderAddress;\n namespace emailMarketingV1Campaign_universal_d {\n export {\n emailMarketingV1Campaign_universal_d_Campaign as Campaign,\n emailMarketingV1Campaign_universal_d_CampaignEditorTypeEnum as CampaignEditorTypeEnum,\n emailMarketingV1Campaign_universal_d_CampaignStatusEnum as CampaignStatusEnum,\n emailMarketingV1Campaign_universal_d_CampaignVisibilityStatusEnum as CampaignVisibilityStatusEnum,\n emailMarketingV1Campaign_universal_d_Enum as Enum,\n emailMarketingV1Campaign_universal_d_PublishingData as PublishingData,\n emailMarketingV1Campaign_universal_d_CampaignStatistics as CampaignStatistics,\n emailMarketingV1Campaign_universal_d_LandingPageStatistics as LandingPageStatistics,\n emailMarketingV1Campaign_universal_d_DistributionStatistics as DistributionStatistics,\n emailMarketingV1Campaign_universal_d_TotalStatistics as TotalStatistics,\n emailMarketingV1Campaign_universal_d_RejectionData as RejectionData,\n emailMarketingV1Campaign_universal_d_RejectionReasonEnum as RejectionReasonEnum,\n emailMarketingV1Campaign_universal_d_CampaignSendingStateEnum as CampaignSendingStateEnum,\n emailMarketingV1Campaign_universal_d_CampaignTypeEnum as CampaignTypeEnum,\n emailMarketingV1Campaign_universal_d_EstimateFilterSizeRequest as EstimateFilterSizeRequest,\n emailMarketingV1Campaign_universal_d_EstimateFilterSizeResponse as EstimateFilterSizeResponse,\n emailMarketingV1Campaign_universal_d_EstimateAudienceSizeRequest as EstimateAudienceSizeRequest,\n emailMarketingV1Campaign_universal_d_EstimateAudienceSizeResponse as EstimateAudienceSizeResponse,\n emailMarketingV1Campaign_universal_d_ReconcileContactRequest as ReconcileContactRequest,\n emailMarketingV1Campaign_universal_d_ReconcileContactResponse as ReconcileContactResponse,\n emailMarketingV1Campaign_universal_d_Contact as Contact,\n emailMarketingV1Campaign_universal_d_SearchContactsRequest as SearchContactsRequest,\n emailMarketingV1Campaign_universal_d_SearchContactsResponse as SearchContactsResponse,\n emailMarketingV1Campaign_universal_d_GetLabelsRequest as GetLabelsRequest,\n emailMarketingV1Campaign_universal_d_GetLabelsResponse as GetLabelsResponse,\n emailMarketingV1Campaign_universal_d_Label as Label,\n emailMarketingV1Campaign_universal_d_SubscribeFromLandingPageRequest as SubscribeFromLandingPageRequest,\n emailMarketingV1Campaign_universal_d_SubscribeFromLandingPageResponse as SubscribeFromLandingPageResponse,\n emailMarketingV1Campaign_universal_d_GetPlaceholderKeysRequest as GetPlaceholderKeysRequest,\n emailMarketingV1Campaign_universal_d_GetPlaceholderKeysResponse as GetPlaceholderKeysResponse,\n emailMarketingV1Campaign_universal_d_GetDefaultComponentsRequest as GetDefaultComponentsRequest,\n emailMarketingV1Campaign_universal_d_GetDefaultComponentsResponse as GetDefaultComponentsResponse,\n emailMarketingV1Campaign_universal_d_ValidateLinkRequest as ValidateLinkRequest,\n emailMarketingV1Campaign_universal_d_ValidateLinkResponse as ValidateLinkResponse,\n emailMarketingV1Campaign_universal_d_ValidateHtmlLinksRequest as ValidateHtmlLinksRequest,\n emailMarketingV1Campaign_universal_d_ValidateHtmlLinksResponse as ValidateHtmlLinksResponse,\n emailMarketingV1Campaign_universal_d_ListStatisticsRequest as ListStatisticsRequest,\n emailMarketingV1Campaign_universal_d_ListStatisticsResponse as ListStatisticsResponse,\n emailMarketingV1Campaign_universal_d_CampaignStatisticsContainer as CampaignStatisticsContainer,\n emailMarketingV1Campaign_universal_d_ListRecipientsRequest as ListRecipientsRequest,\n emailMarketingV1Campaign_universal_d_RecipientsActivityEnum as RecipientsActivityEnum,\n emailMarketingV1Campaign_universal_d_CursorPaging as CursorPaging,\n emailMarketingV1Campaign_universal_d_ListRecipientsResponse as ListRecipientsResponse,\n emailMarketingV1Campaign_universal_d_CampaignRecipientDetails as CampaignRecipientDetails,\n emailMarketingV1Campaign_universal_d_PagingMetadataV2 as PagingMetadataV2,\n emailMarketingV1Campaign_universal_d_Cursors as Cursors,\n emailMarketingV1Campaign_universal_d_GetCampaignMappingRequest as GetCampaignMappingRequest,\n emailMarketingV1Campaign_universal_d_GetCampaignMappingResponse as GetCampaignMappingResponse,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingRequest as GetPingCampaignMappingRequest,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingResponse as GetPingCampaignMappingResponse,\n emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesRequest as QueryAutomationTemplatesRequest,\n emailMarketingV1Campaign_universal_d_Query as Query,\n emailMarketingV1Campaign_universal_d_Sorting as Sorting,\n emailMarketingV1Campaign_universal_d_SortOrder as SortOrder,\n emailMarketingV1Campaign_universal_d_Paging as Paging,\n emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesResponse as QueryAutomationTemplatesResponse,\n emailMarketingV1Campaign_universal_d_AutomationTemplateContainer as AutomationTemplateContainer,\n emailMarketingV1Campaign_universal_d_AutomationTemplate as AutomationTemplate,\n emailMarketingV1Campaign_universal_d_RuleConfiguration as RuleConfiguration,\n emailMarketingV1Campaign_universal_d_ConditionConfiguration as ConditionConfiguration,\n emailMarketingV1Campaign_universal_d_Operator as Operator,\n emailMarketingV1Campaign_universal_d_TriggerConfiguration as TriggerConfiguration,\n emailMarketingV1Campaign_universal_d_ActionConfiguration as ActionConfiguration,\n emailMarketingV1Campaign_universal_d_RuleStatus as RuleStatus,\n emailMarketingV1Campaign_universal_d_ActivationCycle as ActivationCycle,\n emailMarketingV1Campaign_universal_d_RuleMetadata as RuleMetadata,\n emailMarketingV1Campaign_universal_d_VersionType as VersionType,\n emailMarketingV1Campaign_universal_d_TemplateType as TemplateType,\n emailMarketingV1Campaign_universal_d_Precondition as Precondition,\n emailMarketingV1Campaign_universal_d_PreconditionType as PreconditionType,\n emailMarketingV1Campaign_universal_d_TemplateState as TemplateState,\n emailMarketingV1Campaign_universal_d_Translation as Translation,\n emailMarketingV1Campaign_universal_d_TranslationState as TranslationState,\n emailMarketingV1Campaign_universal_d_AutomationTemplateEnrichmentData as AutomationTemplateEnrichmentData,\n emailMarketingV1Campaign_universal_d_QueryMetadata as QueryMetadata,\n emailMarketingV1Campaign_universal_d_QueryAppTemplatesRequest as QueryAppTemplatesRequest,\n emailMarketingV1Campaign_universal_d_TemplateQueryType as TemplateQueryType,\n emailMarketingV1Campaign_universal_d_QueryAppTemplatesResponse as QueryAppTemplatesResponse,\n emailMarketingV1Campaign_universal_d_TemplateData as TemplateData,\n emailMarketingV1Campaign_universal_d_CampaignLookupRequest as CampaignLookupRequest,\n emailMarketingV1Campaign_universal_d_CampaignLookupResponse as CampaignLookupResponse,\n emailMarketingV1Campaign_universal_d_CampaignLookupBatchRequest as CampaignLookupBatchRequest,\n emailMarketingV1Campaign_universal_d_CampaignLookupBatchResponse as CampaignLookupBatchResponse,\n emailMarketingV1Campaign_universal_d_UpsertTranslationRequest as UpsertTranslationRequest,\n emailMarketingV1Campaign_universal_d_Composer as Composer,\n emailMarketingV1Campaign_universal_d_DefaultValues as DefaultValues,\n emailMarketingV1Campaign_universal_d_UpsertTranslationResponse as UpsertTranslationResponse,\n emailMarketingV1Campaign_universal_d_GetUsedPlaceholderKeysRequest as GetUsedPlaceholderKeysRequest,\n emailMarketingV1Campaign_universal_d_GetUsedPlaceholderKeysResponse as GetUsedPlaceholderKeysResponse,\n emailMarketingV1Campaign_universal_d_LookupCampaignMappingRequest as LookupCampaignMappingRequest,\n emailMarketingV1Campaign_universal_d_LookupCampaignMappingResponse as LookupCampaignMappingResponse,\n emailMarketingV1Campaign_universal_d_GetCampaignRequest as GetCampaignRequest,\n emailMarketingV1Campaign_universal_d_GetCampaignResponse as GetCampaignResponse,\n emailMarketingV1Campaign_universal_d_ListCampaignsRequest as ListCampaignsRequest,\n emailMarketingV1Campaign_universal_d_ListCampaignsResponse as ListCampaignsResponse,\n emailMarketingV1Campaign_universal_d_CountCampaignsRequest as CountCampaignsRequest,\n emailMarketingV1Campaign_universal_d_CountCampaignsResponse as CountCampaignsResponse,\n emailMarketingV1Campaign_universal_d_CreateFromTemplateRequest as CreateFromTemplateRequest,\n emailMarketingV1Campaign_universal_d_CreateFromTemplateResponse as CreateFromTemplateResponse,\n emailMarketingV1Campaign_universal_d_CreateUserTemplateRequest as CreateUserTemplateRequest,\n emailMarketingV1Campaign_universal_d_CreateUserTemplateResponse as CreateUserTemplateResponse,\n emailMarketingV1Campaign_universal_d_CreateFromUserTemplateRequest as CreateFromUserTemplateRequest,\n emailMarketingV1Campaign_universal_d_CreateFromUserTemplateResponse as CreateFromUserTemplateResponse,\n emailMarketingV1Campaign_universal_d_PublishCampaignRequest as PublishCampaignRequest,\n emailMarketingV1Campaign_universal_d_EmailDistributionOptions as EmailDistributionOptions,\n emailMarketingV1Campaign_universal_d_PublishCampaignResponse as PublishCampaignResponse,\n emailMarketingV1Campaign_universal_d_Rejected as Rejected,\n emailMarketingV1Campaign_universal_d_Published as Published,\n emailMarketingV1Campaign_universal_d_Terminated as Terminated,\n emailMarketingV1Campaign_universal_d_Distributed as Distributed,\n emailMarketingV1Campaign_universal_d_EmailActivityUpdated as EmailActivityUpdated,\n emailMarketingV1Campaign_universal_d_EmailActivityUpdatedEventTypeOneOf as EmailActivityUpdatedEventTypeOneOf,\n emailMarketingV1Campaign_universal_d_ActivityType as ActivityType,\n emailMarketingV1Campaign_universal_d_Click as Click,\n emailMarketingV1Campaign_universal_d_Open as Open,\n emailMarketingV1Campaign_universal_d_SoftBounce as SoftBounce,\n emailMarketingV1Campaign_universal_d_HardBounce as HardBounce,\n emailMarketingV1Campaign_universal_d_Scheduled as Scheduled,\n emailMarketingV1Campaign_universal_d_SendTestRequest as SendTestRequest,\n emailMarketingV1Campaign_universal_d_PlaceholderContent as PlaceholderContent,\n emailMarketingV1Campaign_universal_d_PlaceholderContentValueOneOf as PlaceholderContentValueOneOf,\n emailMarketingV1Campaign_universal_d_PlainText as PlainText,\n emailMarketingV1Campaign_universal_d_Html as Html,\n emailMarketingV1Campaign_universal_d_Money as Money,\n emailMarketingV1Campaign_universal_d_DateTime as DateTime,\n emailMarketingV1Campaign_universal_d_Map as Map,\n emailMarketingV1Campaign_universal_d_Array as Array,\n emailMarketingV1Campaign_universal_d_PlaceholderContentEnum as PlaceholderContentEnum,\n emailMarketingV1Campaign_universal_d_Attachment as Attachment,\n emailMarketingV1Campaign_universal_d_Integer as Integer,\n emailMarketingV1Campaign_universal_d_Decimal as Decimal,\n emailMarketingV1Campaign_universal_d_SendTestResponse as SendTestResponse,\n emailMarketingV1Campaign_universal_d_PauseSchedulingRequest as PauseSchedulingRequest,\n emailMarketingV1Campaign_universal_d_PauseSchedulingResponse as PauseSchedulingResponse,\n emailMarketingV1Campaign_universal_d_Paused as Paused,\n emailMarketingV1Campaign_universal_d_RescheduleRequest as RescheduleRequest,\n emailMarketingV1Campaign_universal_d_RescheduleResponse as RescheduleResponse,\n emailMarketingV1Campaign_universal_d_ArchiveCampaignRequest as ArchiveCampaignRequest,\n emailMarketingV1Campaign_universal_d_ArchiveCampaignResponse as ArchiveCampaignResponse,\n emailMarketingV1Campaign_universal_d_Archived as Archived,\n emailMarketingV1Campaign_universal_d_UnarchiveCampaignRequest as UnarchiveCampaignRequest,\n emailMarketingV1Campaign_universal_d_UnarchiveCampaignResponse as UnarchiveCampaignResponse,\n emailMarketingV1Campaign_universal_d_Unarchived as Unarchived,\n emailMarketingV1Campaign_universal_d_UpdateTitleRequest as UpdateTitleRequest,\n emailMarketingV1Campaign_universal_d_UpdateTitleResponse as UpdateTitleResponse,\n emailMarketingV1Campaign_universal_d_DeleteCampaignRequest as DeleteCampaignRequest,\n emailMarketingV1Campaign_universal_d_DeleteCampaignResponse as DeleteCampaignResponse,\n emailMarketingV1Campaign_universal_d_ReuseCampaignRequest as ReuseCampaignRequest,\n emailMarketingV1Campaign_universal_d_ReuseCampaignResponse as ReuseCampaignResponse,\n emailMarketingV1Campaign_universal_d_PreviewCampaignRequest as PreviewCampaignRequest,\n emailMarketingV1Campaign_universal_d_PreviewCampaignResponse as PreviewCampaignResponse,\n emailMarketingV1Campaign_universal_d_GetComposerRequest as GetComposerRequest,\n emailMarketingV1Campaign_universal_d_GetComposerResponse as GetComposerResponse,\n emailMarketingV1Campaign_universal_d_UpdateComposerRequest as UpdateComposerRequest,\n emailMarketingV1Campaign_universal_d_CampaignEditorType as CampaignEditorType,\n emailMarketingV1Campaign_universal_d_UpdateComposerResponse as UpdateComposerResponse,\n emailMarketingV1Campaign_universal_d_CreateCampaignRequest as CreateCampaignRequest,\n emailMarketingV1Campaign_universal_d_CreateCampaignResponse as CreateCampaignResponse,\n emailMarketingV1Campaign_universal_d_ResendToNonOpenersRequest as ResendToNonOpenersRequest,\n emailMarketingV1Campaign_universal_d_ResendToNonOpenersResponse as ResendToNonOpenersResponse,\n emailMarketingV1Campaign_universal_d_GetAudienceRequest as GetAudienceRequest,\n emailMarketingV1Campaign_universal_d_GetAudienceResponse as GetAudienceResponse,\n emailMarketingV1Campaign_universal_d_CampaignAudience as CampaignAudience,\n emailMarketingV1Campaign_universal_d_IdentifySenderAddressRequest as IdentifySenderAddressRequest,\n emailMarketingV1Campaign_universal_d_IdentifySenderAddressResponse as IdentifySenderAddressResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n emailMarketingV1Campaign_universal_d_estimateFilterSize as estimateFilterSize,\n emailMarketingV1Campaign_universal_d_EstimateFilterSizeOptions as EstimateFilterSizeOptions,\n emailMarketingV1Campaign_universal_d_estimateAudienceSize as estimateAudienceSize,\n emailMarketingV1Campaign_universal_d_EstimateAudienceSizeOptions as EstimateAudienceSizeOptions,\n emailMarketingV1Campaign_universal_d_reconcileContact as reconcileContact,\n emailMarketingV1Campaign_universal_d_searchContacts as searchContacts,\n emailMarketingV1Campaign_universal_d_SearchContactsOptions as SearchContactsOptions,\n emailMarketingV1Campaign_universal_d_getLabels as getLabels,\n emailMarketingV1Campaign_universal_d_GetLabelsOptions as GetLabelsOptions,\n emailMarketingV1Campaign_universal_d_subscribeFromLandingPage as subscribeFromLandingPage,\n emailMarketingV1Campaign_universal_d_SubscribeFromLandingPageOptions as SubscribeFromLandingPageOptions,\n emailMarketingV1Campaign_universal_d_getPlaceholderKeys as getPlaceholderKeys,\n emailMarketingV1Campaign_universal_d_getDefaultComponents as getDefaultComponents,\n emailMarketingV1Campaign_universal_d_validateLink as validateLink,\n emailMarketingV1Campaign_universal_d_validateHtmlLinks as validateHtmlLinks,\n emailMarketingV1Campaign_universal_d_listStatistics as listStatistics,\n emailMarketingV1Campaign_universal_d_listRecipients as listRecipients,\n emailMarketingV1Campaign_universal_d_ListRecipientsOptions as ListRecipientsOptions,\n emailMarketingV1Campaign_universal_d_getCampaignMapping as getCampaignMapping,\n emailMarketingV1Campaign_universal_d_GetCampaignMappingIdentifiers as GetCampaignMappingIdentifiers,\n emailMarketingV1Campaign_universal_d_getPingCampaignMapping as getPingCampaignMapping,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingIdentifiers as GetPingCampaignMappingIdentifiers,\n emailMarketingV1Campaign_universal_d_GetPingCampaignMappingOptions as GetPingCampaignMappingOptions,\n emailMarketingV1Campaign_universal_d_queryAutomationTemplates as queryAutomationTemplates,\n emailMarketingV1Campaign_universal_d_QueryAutomationTemplatesOptions as QueryAutomationTemplatesOptions,\n emailMarketingV1Campaign_universal_d_queryAppTemplates as queryAppTemplates,\n emailMarketingV1Campaign_universal_d_QueryAppTemplatesOptions as QueryAppTemplatesOptions,\n emailMarketingV1Campaign_universal_d_campaignLookup as campaignLookup,\n emailMarketingV1Campaign_universal_d_campaignLookupBatch as campaignLookupBatch,\n emailMarketingV1Campaign_universal_d_CampaignLookupBatchOptions as CampaignLookupBatchOptions,\n emailMarketingV1Campaign_universal_d_upsertTranslation as upsertTranslation,\n emailMarketingV1Campaign_universal_d_UpsertTranslationOptions as UpsertTranslationOptions,\n emailMarketingV1Campaign_universal_d_getUsedPlaceholderKeys as getUsedPlaceholderKeys,\n emailMarketingV1Campaign_universal_d_getCampaign as getCampaign,\n emailMarketingV1Campaign_universal_d_GetCampaignOptions as GetCampaignOptions,\n emailMarketingV1Campaign_universal_d_listCampaigns as listCampaigns,\n emailMarketingV1Campaign_universal_d_ListCampaignsOptions as ListCampaignsOptions,\n emailMarketingV1Campaign_universal_d_count as count,\n emailMarketingV1Campaign_universal_d_CountOptions as CountOptions,\n emailMarketingV1Campaign_universal_d_createFromTemplate as createFromTemplate,\n emailMarketingV1Campaign_universal_d_CreateFromTemplateOptions as CreateFromTemplateOptions,\n emailMarketingV1Campaign_universal_d_createUserTemplate as createUserTemplate,\n emailMarketingV1Campaign_universal_d_CreateUserTemplateOptions as CreateUserTemplateOptions,\n emailMarketingV1Campaign_universal_d_createFromUserTemplate as createFromUserTemplate,\n emailMarketingV1Campaign_universal_d_publishCampaign as publishCampaign,\n emailMarketingV1Campaign_universal_d_PublishCampaignOptions as PublishCampaignOptions,\n emailMarketingV1Campaign_universal_d_sendTest as sendTest,\n emailMarketingV1Campaign_universal_d_SendTestOptions as SendTestOptions,\n emailMarketingV1Campaign_universal_d_pauseScheduling as pauseScheduling,\n emailMarketingV1Campaign_universal_d_reschedule as reschedule,\n emailMarketingV1Campaign_universal_d_archiveCampaign as archiveCampaign,\n emailMarketingV1Campaign_universal_d_ArchiveCampaignOptions as ArchiveCampaignOptions,\n emailMarketingV1Campaign_universal_d_unarchiveCampaign as unarchiveCampaign,\n emailMarketingV1Campaign_universal_d_UnarchiveCampaignOptions as UnarchiveCampaignOptions,\n emailMarketingV1Campaign_universal_d_updateTitle as updateTitle,\n emailMarketingV1Campaign_universal_d_UpdateTitleOptions as UpdateTitleOptions,\n emailMarketingV1Campaign_universal_d_deleteCampaign as deleteCampaign,\n emailMarketingV1Campaign_universal_d_DeleteCampaignOptions as DeleteCampaignOptions,\n emailMarketingV1Campaign_universal_d_reuseCampaign as reuseCampaign,\n emailMarketingV1Campaign_universal_d_ReuseCampaignOptions as ReuseCampaignOptions,\n emailMarketingV1Campaign_universal_d_preview as preview,\n emailMarketingV1Campaign_universal_d_PreviewOptions as PreviewOptions,\n emailMarketingV1Campaign_universal_d_getComposer as getComposer,\n emailMarketingV1Campaign_universal_d_GetComposerOptions as GetComposerOptions,\n emailMarketingV1Campaign_universal_d_updateComposer as updateComposer,\n emailMarketingV1Campaign_universal_d_UpdateComposerOptions as UpdateComposerOptions,\n emailMarketingV1Campaign_universal_d_create as create,\n emailMarketingV1Campaign_universal_d_CreateOptions as CreateOptions,\n emailMarketingV1Campaign_universal_d_resendToNonOpeners as resendToNonOpeners,\n emailMarketingV1Campaign_universal_d_ResendToNonOpenersOptions as ResendToNonOpenersOptions,\n emailMarketingV1Campaign_universal_d_getAudience as getAudience,\n emailMarketingV1Campaign_universal_d_identifySenderAddress as identifySenderAddress,\n };\n }\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 | null;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * @permissionId Shoutout.Manage\n * @adminMethod\n * @deprecated\n * @replacedBy wix.promote.v1.SenderDetailsService.GetDefaultSenderDetails\n * @targetRemovalDate 2025-04-01\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 * @permissionId Shoutout.Manage\n * @adminMethod\n * @deprecated\n * @replacedBy wix.promote.v1.SenderEmailService.GetOrCreateSenderEmail + wix.promote.v1.SenderEmailService.SendVerificationCode\n * @targetRemovalDate 2025-04-01\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 * @permissionId Shoutout.Manage\n * @adminMethod\n * @deprecated\n * @replacedBy wix.promote.v1.SenderEmailService.VerifySenderEmail + wix.promote.v1.SenderDetailsService.UpdateSenderDetails\n * @targetRemovalDate 2025-04-01\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 * @permissionId Shoutout.Manage\n * @adminMethod\n */\n function resolveActualFromAddress(fromAddress: string): Promise;\n \n type emailMarketingV1SenderDetails_universal_d_SenderDetails = SenderDetails;\n type emailMarketingV1SenderDetails_universal_d_GetSenderDetailsRequest = GetSenderDetailsRequest;\n type emailMarketingV1SenderDetails_universal_d_GetSenderDetailsResponse = GetSenderDetailsResponse;\n type emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsRequest = UpdateSenderDetailsRequest;\n type emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsResponse = UpdateSenderDetailsResponse;\n type emailMarketingV1SenderDetails_universal_d_VerifySenderEmailRequest = VerifySenderEmailRequest;\n type emailMarketingV1SenderDetails_universal_d_VerifySenderEmailResponse = VerifySenderEmailResponse;\n type emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressRequest = ResolveActualFromAddressRequest;\n type emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressResponse = ResolveActualFromAddressResponse;\n type emailMarketingV1SenderDetails_universal_d_DomainEvent = DomainEvent;\n type emailMarketingV1SenderDetails_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type emailMarketingV1SenderDetails_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type emailMarketingV1SenderDetails_universal_d_RestoreInfo = RestoreInfo;\n type emailMarketingV1SenderDetails_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type emailMarketingV1SenderDetails_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type emailMarketingV1SenderDetails_universal_d_ActionEvent = ActionEvent;\n type emailMarketingV1SenderDetails_universal_d_MessageEnvelope = MessageEnvelope;\n type emailMarketingV1SenderDetails_universal_d_IdentificationData = IdentificationData;\n type emailMarketingV1SenderDetails_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type emailMarketingV1SenderDetails_universal_d_WebhookIdentityType = WebhookIdentityType;\n const emailMarketingV1SenderDetails_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const emailMarketingV1SenderDetails_universal_d_getSenderDetails: typeof getSenderDetails;\n const emailMarketingV1SenderDetails_universal_d_updateSenderDetails: typeof updateSenderDetails;\n const emailMarketingV1SenderDetails_universal_d_verifyEmail: typeof verifyEmail;\n const emailMarketingV1SenderDetails_universal_d_resolveActualFromAddress: typeof resolveActualFromAddress;\n namespace emailMarketingV1SenderDetails_universal_d {\n export {\n emailMarketingV1SenderDetails_universal_d_SenderDetails as SenderDetails,\n emailMarketingV1SenderDetails_universal_d_GetSenderDetailsRequest as GetSenderDetailsRequest,\n emailMarketingV1SenderDetails_universal_d_GetSenderDetailsResponse as GetSenderDetailsResponse,\n emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsRequest as UpdateSenderDetailsRequest,\n emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsResponse as UpdateSenderDetailsResponse,\n emailMarketingV1SenderDetails_universal_d_VerifySenderEmailRequest as VerifySenderEmailRequest,\n emailMarketingV1SenderDetails_universal_d_VerifySenderEmailResponse as VerifySenderEmailResponse,\n emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressRequest as ResolveActualFromAddressRequest,\n emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressResponse as ResolveActualFromAddressResponse,\n emailMarketingV1SenderDetails_universal_d_DomainEvent as DomainEvent,\n emailMarketingV1SenderDetails_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n emailMarketingV1SenderDetails_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n emailMarketingV1SenderDetails_universal_d_RestoreInfo as RestoreInfo,\n emailMarketingV1SenderDetails_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n emailMarketingV1SenderDetails_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n emailMarketingV1SenderDetails_universal_d_ActionEvent as ActionEvent,\n emailMarketingV1SenderDetails_universal_d_MessageEnvelope as MessageEnvelope,\n emailMarketingV1SenderDetails_universal_d_IdentificationData as IdentificationData,\n emailMarketingV1SenderDetails_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n emailMarketingV1SenderDetails_universal_d_WebhookIdentityType as WebhookIdentityType,\n emailMarketingV1SenderDetails_universal_d_getSenderDetails as getSenderDetails,\n emailMarketingV1SenderDetails_universal_d_updateSenderDetails as updateSenderDetails,\n emailMarketingV1SenderDetails_universal_d_verifyEmail as verifyEmail,\n emailMarketingV1SenderDetails_universal_d_resolveActualFromAddress as resolveActualFromAddress,\n };\n }\n \n export { emailMarketingV1AccountDetails_universal_d as accountDetails, emailMarketingV1Campaign_universal_d as campaigns, emailMarketingV1SenderDetails_universal_d as senderDetails };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-bookings.v2.d.ts", "content": "declare module \"wix-bookings.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /**\n * The `TimeSlot` object represents the availability information\n * for an `Appointment` service's specific slot, including:\n *\n * 1. Whether the slot is bookable for the given service?\n *\n * 2. In what location the service is available for this slot?\n *\n * 3. Which available resources can provide the service for this slot?\n *\n * 4. Does booking the slot for the service violates any of the service booking policies?\n *\n * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?\n *\n * > __Note:__\n * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information\n * > for a given list of `Appointment` services within a specific time slot.\n */\n interface TimeSlot$4 {\n /**\n * Service ID.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own serviceId.\n */\n serviceId?: string | null;\n /**\n * Local start date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string | null;\n /**\n * Local end date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string | null;\n /**\n * Whether the slot is bookable according to the service's booking policies.\n *\n * If booking this time slot does not violates any of the service's booking policies,\n * the returned value is `true`. Otherwise, returns `false`.\n */\n bookable?: boolean | null;\n /** The geographic location of the slot. */\n location?: Location$b;\n /**\n * Returned only for event.\n * @internal\n */\n eventInfo?: EventInfo$4;\n /** Total number of spots for the slot. */\n totalCapacity?: number | null;\n /**\n * Remaining number of spots for the slot.\n * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.\n */\n remainingCapacity?: number | null;\n /**\n * Indicators for booking policy violations for the slot.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$5;\n /**\n * List of `AvailableResources` for the time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own available resources.\n */\n availableResources?: AvailableResources$5[];\n /**\n * > Nested time slots.\n * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.\n */\n nestedTimeSlots?: NestedTimeSlot$4[];\n }\n interface Location$b {\n /** Business Location ID. Present only if the location is a business location. */\n _id?: string | null;\n /** The location name. */\n name?: string | null;\n /** A string representation for the full address of the location. */\n formattedAddress?: string | null;\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.\n * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.\n */\n locationType?: LocationType$b;\n }\n enum LocationType$b {\n UNKNOWN_LOCATION_TYPE = \"UNKNOWN_LOCATION_TYPE\",\n /** A business location, either the default business address, or locations defined for the business by the Business Info. */\n BUSINESS = \"BUSINESS\",\n /** The location is unique to this service and isn't defined as one of the business locations. */\n CUSTOM = \"CUSTOM\",\n /** The location can be determined by the customer and is not set up beforehand. */\n CUSTOMER = \"CUSTOMER\"\n }\n /** relevant for event based slots, and not for availability based slots */\n interface EventInfo$4 {\n /**\n * TODO: format - might not be a guid?\n * @internal\n */\n eventId?: string | null;\n /** @internal */\n waitingList?: WaitingList$5;\n }\n interface WaitingList$5 {\n /** Total number of spots in this wait list. */\n totalCapacity?: number | null;\n /**\n * Number of remaining spots for this wait list.\n * For example, a Yoga event with 10 waitList spots and 3 registered\n * on the waitList has 10 `total_capacity` and 7 `remaining_capacity`.\n */\n remainingCapacity?: number | null;\n }\n interface BookingPolicyViolations$5 {\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 the `TimeSlot` service. */\n bookOnlineDisabled?: boolean | null;\n }\n interface AvailableResources$5 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Available resources for the time slot.\n *\n * + When returned from `ListAvailabilityTimeSlots`, empty by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains __up__ to 10 available resources out of those provided.\n *\n * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains all of the available resources out of those provided.\n *\n *\n * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains __up__ to 10 available resources out of those provided.\n *\n * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains all of the available resources out of those provided.\n */\n resources?: Resource$8[];\n /**\n * The required number of resources of this type in order to book the service.\n * For example, a slot for a service that provides a double massage\n * requires two resources of type `Staff Member` and one resource of type `Room`.\n * @internal\n */\n numberOfResourcesRequired?: number | null;\n /**\n * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.\n * @readonly\n */\n hasMoreAvailableResources?: boolean | null;\n }\n interface Resource$8 {\n /** Resource ID. */\n _id?: string;\n /** Resource name. */\n name?: string | null;\n }\n interface NestedTimeSlot$4 {\n /** Service ID of the nested time slot. */\n serviceId?: string;\n /**\n * Local start date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string;\n /**\n * Local end date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string;\n /**\n * List of `AvailableResources` for the nested time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n */\n availableResources?: AvailableResources$5[];\n }\n interface CalculateEventBasedAvailabilityRequest$3 {\n serviceIds: string[];\n from: string;\n to: string;\n timeZone: string;\n /**\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 * TODO: Locks are not taken into account. // Class is not supported yet. (relevant only for classes with waiting list)\n * Aliza's suggestion to consider locks in bookable\n */\n bookable?: boolean | null;\n /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$b[];\n resourceIds?: string[];\n /** if not empty, return slots with openSpots >= X */\n openSpots?: number | 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$5;\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$e;\n }\n interface CursorPaging$e {\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 CalculateEventBasedAvailabilityResponse$3 {\n slots?: TimeSlot$4[];\n cursorPagingMetadata?: CursorPagingMetadata$c;\n }\n interface CursorPagingMetadata$c {\n /** Number of items returned in the response. */\n count?: number | null;\n /** Offset that was requested. */\n cursors?: Cursors$f;\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$f {\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 ListEventTimeSlotsRequest$3 {\n /** The services for which the time slots are being returned. */\n serviceIds: string[] | null;\n /**\n * Local start date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n fromLocalDate: string | null;\n /**\n * Local end date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n toLocalDate: string | null;\n /**\n * The time zone, in IANA time zone format.\n * Default is the Wix Business time zone.\n */\n timeZone: string | null;\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 /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$b[];\n /** TODO: maxsize && do we need include_resource_type_id here? also is the behavior is the same as availabilityTimeSlots, we won't return resources by default? */\n resourceIds?: string[] | null;\n /** if not empty, return slots with remainingCapacity >= X */\n remainingCapacity?: number | 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$5;\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 timeSlotsPerDay?: number | null;\n cursorPaging?: CursorPaging$e;\n }\n interface ListEventTimeSlotsResponse$3 {\n /** TODO: maxsize */\n timeSlots?: TimeSlot$4[];\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n cursorPagingMetadata?: CursorPagingMetadata$c;\n }\n interface ListMultiServiceAvailabilityTimeSlotsRequest$3 {\n /**\n * Services for which the multiService time slots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: `2`.\n * MaxSize: `8`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n services?: Service$5[];\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Location for which the multiService TimeSlots are being returned for.\n *\n * You can specify location or location type for which the TimeSlots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n location?: Location$b;\n /**\n * Whether the `TimeSlot` is bookable according to all of the services booking policies.\n *\n * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,\n * returns as `false`. Otherwise, returns as `true`.\n *\n * > __Note:__\n * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,\n * > while a `TimeSlot` with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s\n * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether\n * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.\n *\n * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$5;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch TimeSlots in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`\n * the `cursorPaging`.`limit`. You may pass a different `limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$3;\n }\n interface Service$5 {\n /** Service ID. */\n serviceId?: string;\n /** Resources to include in response. */\n resourceIds?: string[];\n /**\n * The resource type ID's to include in returned time slots.\n * This is in addition to the specifically requested resources.\n *\n *
      \n * Currently supported only for Staff Member resource type.\n * Staff Member type ID: 1cd44cf8-756f-41c3-bd90-3e2ffcaf1155\n *
      \n */\n includeResourceTypeIds?: string[];\n }\n interface CommonCursorPaging$3 {\n /**\n * Number of results to load.\n *\n * Default: `1000`.\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 ListMultiServiceAvailabilityTimeSlotsResponse$3 {\n /** Time slots. */\n timeSlots?: TimeSlot$4[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata$3;\n }\n interface CommonCursorPagingMetadata$3 {\n /** Offset that was requested. */\n cursors?: CommonCursors$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 CommonCursors$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 GetMultiServiceAvailabilityTimeSlotRequest$3 {\n /**\n * Services for which the multiService TimeSlots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: 2.\n * MaxSize: 8.\n */\n services: Service$5[];\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$b;\n }\n interface GetMultiServiceAvailabilityTimeSlotResponse$3 {\n /** Time slot. */\n timeSlot?: TimeSlot$4;\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n interface ListAvailabilityTimeSlotsRequest$3 {\n /**\n * Service ID for which the time slots are being returned for.\n * Currently supported only for services of type `APPOINTMENT`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n serviceId?: string | null;\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Locations to include in response.\n *\n * By default,\n * if no locations are provided,\n * the response contains TimeSlots for all locations where the service is available.\n *\n * You can specify locations or location types for which the time slots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n */\n locations?: Location$b[];\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.\n * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains __up__ to 10 available resources of this type.\n */\n includeResourceTypeIds?: string[];\n /**\n * Whether the `TimeSlot` is bookable according to the service's booking policies.\n *\n * If booking this `TimeSlot` does not violates any of the service's booking policies,\n * returns as `true`. Otherwise, returns as `false`.\n *\n * > __Note:__\n * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,\n * > while a time slot with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$5;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch results in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and\n * a `cursorPaging`.`limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$3;\n /**\n * Specifies whether to return all available resources in response.\n * @internal\n */\n shouldReturnAllResources?: boolean;\n }\n interface ListAvailabilityTimeSlotsResponse$3 {\n /** Time slots. */\n timeSlots?: TimeSlot$4[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata$3;\n }\n interface GetAvailabilityTimeSlotRequest$4 {\n /**\n * Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n */\n serviceId: string;\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$b;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n }\n interface GetAvailabilityTimeSlotResponse$4 {\n /** Time slot. */\n timeSlot?: TimeSlot$4;\n /** Time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField options.from\n * @requiredField options.timeZone\n * @requiredField options.to\n * @requiredField serviceIds\n */\n function calculateEventBasedAvailability$1(serviceIds: string[], options?: CalculateEventBasedAvailabilityOptions$1): Promise;\n interface CalculateEventBasedAvailabilityOptions$1 {\n from: string;\n to: string;\n timeZone: string;\n /**\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 * TODO: Locks are not taken into account. // Class is not supported yet. (relevant only for classes with waiting list)\n * Aliza's suggestion to consider locks in bookable\n */\n bookable?: boolean | null;\n /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$b[];\n resourceIds?: string[];\n /** if not empty, return slots with openSpots >= X */\n openSpots?: number | 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$5;\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$e;\n }\n /**\n * TODO explain the sorting tie breaker\n * Return a list of available slots, for Event based services\n * can be called only for services with tag \"GROUP\"\n * @param serviceIds - The services for which the time slots are being returned.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.fromLocalDate\n * @requiredField options.timeZone\n * @requiredField options.toLocalDate\n * @requiredField serviceIds\n */\n function listEventTimeSlots$1(serviceIds: string[] | null, options?: ListEventTimeSlotsOptions$1): Promise;\n interface ListEventTimeSlotsOptions$1 {\n /**\n * Local start date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n fromLocalDate: string | null;\n /**\n * Local end date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n toLocalDate: string | null;\n /**\n * The time zone, in IANA time zone format.\n * Default is the Wix Business time zone.\n */\n timeZone: string | null;\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 /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$b[];\n /** TODO: maxsize && do we need include_resource_type_id here? also is the behavior is the same as availabilityTimeSlots, we won't return resources by default? */\n resourceIds?: string[] | null;\n /** if not empty, return slots with remainingCapacity >= X */\n remainingCapacity?: number | 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$5;\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 timeSlotsPerDay?: number | null;\n cursorPaging?: CursorPaging$e;\n }\n /**\n * Retrieves a list of multiService `TimeSlot`s that match the provided filters.\n *\n *
      \n *

      Important:
      \n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * The request body __must__ include either:\n * + All of the following filters: `service`.`serviceId`, `fromLocalDate`, `toLocalDate`, `location`, and `timeZone`. You may add additional filters as you wish.\n * + A `cursorPaging` with a valid `cursor` from previous response.\n *\n *\n * Each [TimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/availability-time-slots/time-slot-object) in response\n * represents the availability of the given sequence of services in a specific order, location, and within a given range of time.\n *\n * Each `TimeSlot`.`NestedTimeSlot` represents a single service from the given list. The order of the `NestedTimeSlots` is the same as the order\n * of the given services in request.\n * The first `NestedTimeSlot` has `localStartDate` within the given `fromLocalDate` and `toLocalDate` exclusive,\n * and each following `NestedTimeSlot` has a `localStartDate` that equals to the previous `NestedTimeSlot`'s `localEndDate`.\n *\n * By default,\n * the response contains at most 1000 results.\n * If there are more than 1000 results, we return a `cursorPagingMetadata` with\n * a cursor for the next page of results, regardless of whether a `cursorPaging`\n * was provided in request.\n *\n * > __Notes:__\n * > + All nested time slots share the same location.\n * > + You can pass up to 8 services in request.\n *\n * ### AvailableResources in response:\n * The `TimeSlot`.`NestedTimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service\n * within the `NestedTimeSlot` range of time. Each `AvailableResources` contains information about available resources of the same type.\n *\n *
      \n *

      Important:
      \n * By default,\n * if you don't specify service.includeResourceTypeIds\n * or service.resourceIds filters in request,\n * we return TimeSlots with NestedTimeSlots with an empty AvailableResources.\n *
      Note:
      Not specifying resources filters can be handy in case you want to avoid large response in flows that only\n * interested of whether the time slots are available. [Finding the next available slot within the next 3 months](https://bo.wix.com/wix-docs/rest/all-apis/service-availability/multi-service-availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_multi-service-availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-all-selected-services-are-available-for)\n * is an example for such flow.\n *

      \n *
      \n *\n *\n * If you wish to get a list of available resources for a `TimeSlot`.`NestedTimeSlot` you should either:\n * + provide `service`.`resourceIds` in request.\n * + provide `service`.`includeResourceTypeIds` in request.\n *\n * __Notes:__\n * + In both cases the returned `TimeSlot`.`NestedTimeSlot` contains __up__ to 10 `AvailableResources` that match the provided filters. Each `AvailableResources` contains __up__ to 10 available `resources` of the same type that match the provided filters.\n * + If an `AvailableResources` has more available resources which are not listed within it, we return `AvailableResources`.`hasMoreAvailableResources` as true.\n * + If you wish to get the full available resources list for all `NestedTimeSlot` of a specific `TimeSlot`, you should call [GetMultiServiceAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/get-multi-service-availability-time-slot).\n *\n *\n * ### Availability VS Bookability\n * An `available` time slot is not necessarily `bookable`.\n * The `bookable` field of a `TimeSlot` indicates whether the customer can book all of the of the services within the given time slot,\n * at a specific period of time.\n * Read more about [Availability VS Bookability](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/introduction#all-apis_wix-service-availability_multi-service-availability-time-slots_introduction_availability-vs-bookability).\n *\n * By default,\n * + The response does not contains `unavailable` TimeSlots.For example, if there are no available resources to provide one of the services from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`, we don't return TimeSlots with `NestedTimeSlot`.`localStartDate` within this range for this service.\n * + The response contains both `bookable` and `un-bookable` TimeSlots.For example, if one of the services has a booking policy which enforces booking the service up to 10 minutes before the session starts, we return TimeSlots with the violating `NestedTimeSlot`.`localStartDate`, with `bookable` as `false`. If you want to list only __bookable__ TimeSlots you should pass `bookable` as `true`.\n * + If booking one of the `NestedTimeSlot`s violates one of the corresponding service's booking policies, the `TimeSlot` returns with `bookable` as false. There is no indication which service's policy was violated.\n *\n *
      \n *

      Important:\n * Because of DST, there are edge cases where certain times either do not exist or exist twice for a local time zone.\n * Read more about DST Handling

      \n *
      \n *\n * ### ListAvailabilityTimeSlots runs with the following defaults:\n * + `localStartDate` is sorted in `ASC` order.\n * + `cursorPaging`.`limit` is `1000`.\n * @public\n * @documentationMaturity preview\n */\n function listMultiServiceAvailabilityTimeSlots$1(options?: ListMultiServiceAvailabilityTimeSlotsOptions$1): Promise;\n interface ListMultiServiceAvailabilityTimeSlotsOptions$1 {\n /**\n * Services for which the multiService time slots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: `2`.\n * MaxSize: `8`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n services?: Service$5[];\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Location for which the multiService TimeSlots are being returned for.\n *\n * You can specify location or location type for which the TimeSlots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n location?: Location$b;\n /**\n * Whether the `TimeSlot` is bookable according to all of the services booking policies.\n *\n * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,\n * returns as `false`. Otherwise, returns as `true`.\n *\n * > __Note:__\n * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,\n * > while a `TimeSlot` with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s\n * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether\n * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.\n *\n * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$5;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch TimeSlots in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`\n * the `cursorPaging`.`limit`. You may pass a different `limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$3;\n }\n /**\n * Retrieves an available multiService `TimeSlot` that match the provided filters.\n *\n * Throws `SlotNotFound` if there is no such available time slot.\n *\n *
      \n *

      Important:
      \n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * By default,\n * if you don't provide a `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,\n * we return for each `TimeSlot`.`NestedTimeSlot` all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide\n * the corresponding service within the time slot.\n *\n * If you specify `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,\n * the returned `TimeSlot`.`NestedTimeSlot` for this service will contain only `AvailableResources` with at least one available resource\n * which match the given resources filters,\n * each contains all available resources out of those requested.\n *\n * + Notes:\n * + All nested time slots share the same location.\n * + You can pass up to 8 services.\n *\n *
      \n *

      Tip:
      \n * Use this API in order to get the availability of a specific TimeSlot out of those returned from ListMultiServiceAvailabilityTimeSlots API.

      \n *
      \n * @param services - Services for which the multiService TimeSlots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: 2.\n * MaxSize: 8.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.localEndDate\n * @requiredField options.localStartDate\n * @requiredField options.location\n * @requiredField options.location.locationType\n * @requiredField options.timeZone\n * @requiredField services\n * @requiredField services.serviceId\n */\n function getMultiServiceAvailabilityTimeSlot$1(services: Service$5[], options: GetMultiServiceAvailabilityTimeSlotOptions): Promise;\n interface GetMultiServiceAvailabilityTimeSlotOptions {\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$b;\n }\n /**\n * Retrieves a list of `TimeSlot`s that match the provided filters.\n *\n *
      \n *

      Important:\n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * The request body __must__ include either:\n * + All of the following filters: `serviceId`, `fromLocalDate`, `toLocalDate`, and `timeZone`.\n * You may add additional filters as you wish.\n * + A `cursorPaging` with a valid `cursor` from previous response.\n *\n *\n * Each [TimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/availability-time-slots/time-slot-object) in response\n * represents the availability of the service in a specific location,\n * and has a `localStartDate` within the range of the provided `fromLocalDate` and `toLocalDate` exclusive.\n * The `localEndDate` of a `TimeSlot` is calculated as the sum of the `TimeSlot`'s `localStartDate` and the duration of the service.\n *\n * By default,\n * the response contains at most 1000 results.\n * If there are more than 1000 results, we return a `cursorPagingMetadata` with\n * a cursor for the next page of results, regardless of whether a `cursorPaging`\n * was provided in request.\n *\n * ### AvailableResources in response\n * The `TimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service\n * within the time slot. Each `AvailableResources` contains information about available resources of the same type.\n *\n *
      \n *

      Important:
      \n * By default,\n * if you don't specify includeResourceTypeIds\n * or resourceIds filters in request,\n * we return TimeSlots with an empty AvailableResources.\n *
      Note:
      Not specifying resources filters can be handy in case you want to avoid large response in flows that only\n * interested of whether the time slots are available. [Finding the next available slot within the next 3 months](https://bo.wix.com/wix-docs/rest/all-apis/service-availability/availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-the-selected-service-is-available-for)\n * is an example for such flow.\n *

      \n *
      \n *\n * If you wish to get a list of available resources for each `TimeSlot` you should either:\n * + provide `resourceIds` in request.\n * + provide `includeResourceTypeIds` in request.\n *\n * __Notes:__\n * + In both cases the returned TimeSlots contains __up__ to 10 `AvailableResources` that match the provided filters.\n * Each `AvailableResources` contains __up__ to 10 available `resources` of the same type that match the provided filters.\n * + If an `AvailableResources` has more available resources which are not listed within it,\n * we return `AvailableResources`.`hasMoreAvailableResources` as true.\n * > __Note:__\n * > If you wish to get the full available resources list for a specific `TimeSlot`,\n * > you should call [GetAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/get-availability-time-slot).\n *\n *\n * ### Availability VS Bookability\n * An `available` time slot is not necessarily `bookable`.\n * The `bookable` field of a `TimeSlot` indicates whether a customer can book the service within the given time slot,\n * at a specific period of time.\n * Read more about [Availability VS Bookability](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/introduction#all-apis_wix-service-availability_service-availability-time-slots_introduction_availability-vs-bookability).\n *\n * By default,\n * + The response does not contains `unavailable` TimeSlots.\n * For example,\n * if there are no available resources to provide the service from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`,\n * we don't return TimeSlots with `localStartDate` within this range.\n * + The response contains both `bookable` and `un-bookable` TimeSlots.\n * For example,\n * if the service has a booking policy which enforces booking the service up to 10 minutes before the session starts,\n * we return TimeSlots with the violating `localStartDate` with `bookable` as false.\n * If you wish to list only available __bookable__ TimeSlots you should pass `bookable` filter as true.\n *\n *
      \n *

      Important:\n * Because of DST, there are edge cases where certain times either do not exist or exist twice for a local time zone.\n * Read more about DST Handling

      \n *
      \n *\n *\n * ### ListAvailabilityTimeSlots runs with the following defaults\n * + `localStartDate` is sorted in `ASC` order\n * + `cursorPaging`.`limit` is `1000`\n * @public\n * @documentationMaturity preview\n */\n function listAvailabilityTimeSlots$1(options?: ListAvailabilityTimeSlotsOptions$1): Promise;\n interface ListAvailabilityTimeSlotsOptions$1 {\n /**\n * Service ID for which the time slots are being returned for.\n * Currently supported only for services of type `APPOINTMENT`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n serviceId?: string | null;\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Locations to include in response.\n *\n * By default,\n * if no locations are provided,\n * the response contains TimeSlots for all locations where the service is available.\n *\n * You can specify locations or location types for which the time slots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n */\n locations?: Location$b[];\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.\n * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains __up__ to 10 available resources of this type.\n */\n includeResourceTypeIds?: string[];\n /**\n * Whether the `TimeSlot` is bookable according to the service's booking policies.\n *\n * If booking this `TimeSlot` does not violates any of the service's booking policies,\n * returns as `true`. Otherwise, returns as `false`.\n *\n * > __Note:__\n * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,\n * > while a time slot with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$5;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch results in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and\n * a `cursorPaging`.`limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$3;\n /**\n * Specifies whether to return all available resources in response.\n * @internal\n */\n shouldReturnAllResources?: boolean;\n }\n /**\n * Retrieves an available `TimeSlot` that match the provided filters.\n *\n * Throws `SlotNotFound` if there is no such available time slot.\n *\n *
      \n *

      Important:
      \n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * By default,\n * if you don't provide `includeResourceTypeIds` or `resourceIds` in request,\n * we return all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide\n * the service within the time slot.\n *\n * If you specify `includeResourceTypeIds` or `resourceIds` in request,\n * the returned `TimeSlot` will contain only `AvailableResources` with at least one available resource\n * which match the given resources filters,\n * each contains all available resources out of those requested.\n *\n *\n *
      \n *

      Tip:
      \n * Use this API in order to get the availability of a specific TimeSlot out of those returned from ListAvailabilityTimeSlots API.

      \n *
      \n * @param serviceId - Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n * @public\n * @documentationMaturity preview\n * @requiredField options.localEndDate\n * @requiredField options.localStartDate\n * @requiredField options.location\n * @requiredField options.timeZone\n * @requiredField serviceId\n */\n function getAvailabilityTimeSlot$2(serviceId: string, options?: GetAvailabilityTimeSlotOptions$2): Promise;\n interface GetAvailabilityTimeSlotOptions$2 {\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$b;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n }\n \n const bookingsAvailabilityV2TimeSlot_universal_d___debug: typeof __debug;\n type bookingsAvailabilityV2TimeSlot_universal_d_GetMultiServiceAvailabilityTimeSlotOptions = GetMultiServiceAvailabilityTimeSlotOptions;\n namespace bookingsAvailabilityV2TimeSlot_universal_d {\n export {\n bookingsAvailabilityV2TimeSlot_universal_d___debug as __debug,\n TimeSlot$4 as TimeSlot,\n Location$b as Location,\n LocationType$b as LocationType,\n EventInfo$4 as EventInfo,\n WaitingList$5 as WaitingList,\n BookingPolicyViolations$5 as BookingPolicyViolations,\n AvailableResources$5 as AvailableResources,\n Resource$8 as Resource,\n NestedTimeSlot$4 as NestedTimeSlot,\n CalculateEventBasedAvailabilityRequest$3 as CalculateEventBasedAvailabilityRequest,\n CursorPaging$e as CursorPaging,\n CalculateEventBasedAvailabilityResponse$3 as CalculateEventBasedAvailabilityResponse,\n CursorPagingMetadata$c as CursorPagingMetadata,\n Cursors$f as Cursors,\n ListEventTimeSlotsRequest$3 as ListEventTimeSlotsRequest,\n ListEventTimeSlotsResponse$3 as ListEventTimeSlotsResponse,\n ListMultiServiceAvailabilityTimeSlotsRequest$3 as ListMultiServiceAvailabilityTimeSlotsRequest,\n Service$5 as Service,\n CommonCursorPaging$3 as CommonCursorPaging,\n ListMultiServiceAvailabilityTimeSlotsResponse$3 as ListMultiServiceAvailabilityTimeSlotsResponse,\n CommonCursorPagingMetadata$3 as CommonCursorPagingMetadata,\n CommonCursors$3 as CommonCursors,\n GetMultiServiceAvailabilityTimeSlotRequest$3 as GetMultiServiceAvailabilityTimeSlotRequest,\n GetMultiServiceAvailabilityTimeSlotResponse$3 as GetMultiServiceAvailabilityTimeSlotResponse,\n ListAvailabilityTimeSlotsRequest$3 as ListAvailabilityTimeSlotsRequest,\n ListAvailabilityTimeSlotsResponse$3 as ListAvailabilityTimeSlotsResponse,\n GetAvailabilityTimeSlotRequest$4 as GetAvailabilityTimeSlotRequest,\n GetAvailabilityTimeSlotResponse$4 as GetAvailabilityTimeSlotResponse,\n calculateEventBasedAvailability$1 as calculateEventBasedAvailability,\n CalculateEventBasedAvailabilityOptions$1 as CalculateEventBasedAvailabilityOptions,\n listEventTimeSlots$1 as listEventTimeSlots,\n ListEventTimeSlotsOptions$1 as ListEventTimeSlotsOptions,\n listMultiServiceAvailabilityTimeSlots$1 as listMultiServiceAvailabilityTimeSlots,\n ListMultiServiceAvailabilityTimeSlotsOptions$1 as ListMultiServiceAvailabilityTimeSlotsOptions,\n getMultiServiceAvailabilityTimeSlot$1 as getMultiServiceAvailabilityTimeSlot,\n bookingsAvailabilityV2TimeSlot_universal_d_GetMultiServiceAvailabilityTimeSlotOptions as GetMultiServiceAvailabilityTimeSlotOptions,\n listAvailabilityTimeSlots$1 as listAvailabilityTimeSlots,\n ListAvailabilityTimeSlotsOptions$1 as ListAvailabilityTimeSlotsOptions,\n getAvailabilityTimeSlot$2 as getAvailabilityTimeSlot,\n GetAvailabilityTimeSlotOptions$2 as GetAvailabilityTimeSlotOptions,\n };\n }\n \n interface SlotAvailability$1 {\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$1;\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$4;\n /** Booking policy violations for the slot. */\n bookingPolicyViolations?: BookingPolicyViolations$4;\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 /** @internal */\n nestedSlots?: NestedTimeSlot$3[];\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. 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$1;\n /** Geographic location of the slot. */\n location?: Location$a;\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 * Schedule ID. Read only.\n * @internal\n */\n scheduleId?: string | null;\n }\n interface Location$a {\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 /** The full translated address of this location. */\n formattedAddressTranslated?: 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$a;\n }\n enum LocationType$a {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n interface WaitingList$4 {\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$4 {\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$3 {\n serviceId?: string;\n start?: string;\n end?: string;\n resource?: SlotResource$1;\n /** Schedule ID. */\n scheduleId?: string;\n }\n interface QueryAvailabilityRequest {\n /** Query options. */\n query: QueryV2$5;\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 * specifies whether this request should be proxied to availability\n * @internal\n */\n allowProxyToAvailability?: boolean;\n /**\n * specifies whether slots v2 should be premutated or not, true will mean to not premutate and won't return resource on the slot response.\n * @internal\n */\n anyResource?: boolean;\n /**\n * Selected customer choices.\n * If specified, the selected choices will be used to calculate service configuration.\n * If not specified, the service default configuration will be used.\n * @internal\n */\n customerChoices?: CustomerChoices$3;\n }\n interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {\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 * @internal\n */\n cursorPaging?: CursorPaging$d;\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$9[];\n /**\n * List of projected fields to return. All fields are supported.\n * @internal\n */\n fields?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$5 {\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 * @internal\n */\n cursorPaging?: CursorPaging$d;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$9 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface CursorPaging$d {\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$3 {\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$1[];\n /**\n * Details on the paged set of returned results.\n * @internal\n */\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$e;\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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$e {\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$1 {\n /** The slot for which the availability is checked. */\n slot?: Slot$1;\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 * Return the IDs of bookings that are currently allowed to book\n * the given slot due to being a part of a waitlist in a \"suggested\" status.\n * @internal\n */\n returnAllowedBookingIds?: boolean;\n /**\n * Check if this booking is allowed to book the given slot due to\n * being a part of a waitlist in a \"suggested\" status.\n * If passed and the slot is locked for a different booking than this,\n * then `bookable` = `false` is returned.\n * @internal\n */\n bookingId?: string | null;\n /**\n * Check if should call consistentQuery in order to calculate open spots //todo: this field is temporary in order to align bookings ft conduction with availabilityCalendar ft\n * @internal\n */\n shouldNotCallConsistentQuery?: boolean | null;\n }\n interface GetSlotAvailabilityResponse$1 {\n availability?: SlotAvailability$1;\n bookingPolicySettings?: BookingPolicySettings$2;\n /**\n * Bookings that are currently allowed to book the given slot due to being a part of a waitlist in a \"suggested\" status.\n * @internal\n */\n allowedBookingIds?: string[];\n }\n interface BookingPolicySettings$2 {\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$1 {\n /** The schedule ID for which availability is being checked. */\n scheduleId: string;\n /**\n * Check if should call consistentQuery in order to calculate open spots //todo: this field is temporary in order to align bookings ft conduction with availabilityCalendar ft\n * @internal\n */\n shouldNotCallConsistentQuery?: boolean | null;\n }\n interface GetScheduleAvailabilityResponse$1 {\n availability?: ScheduleAvailability$1;\n bookingPolicySettings?: BookingPolicySettings$2;\n }\n interface ScheduleAvailability$1 {\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$4;\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$4;\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$a;\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$d;\n }\n interface RuleBasedConstraints {\n serviceId?: string;\n resourcesFilter?: ResourcesFilter;\n /**\n * specifies whether slots v2 should be premutated or not, true will mean to not premutate and won't return resource on the slot response.\n * @internal\n */\n anyResource?: boolean;\n }\n interface ResourcesFilter {\n resourceIds?: string[];\n }\n interface CalculateMultiSlotAvailabilityResponse {\n slots?: SlotAvailability$1[];\n cursorPagingMetadata?: CursorPagingMetadata$b;\n }\n interface CursorPagingMetadata$b {\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$e;\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | null;\n }\n interface GetAvailabilityTimeSlotRequest$3 {\n /**\n * Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n */\n serviceId: string;\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location?: TimeSlotLocation;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n fromV2?: boolean | null;\n }\n interface TimeSlotLocation {\n /** Business Location ID. Present only if the location is a business location. */\n _id?: string | null;\n /** The location name. */\n name?: string | null;\n /** A string representation for the full address of the location. */\n formattedAddress?: string | null;\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.\n * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.\n */\n locationType?: LocationLocationType$2;\n }\n enum LocationLocationType$2 {\n UNKNOWN_LOCATION_TYPE = \"UNKNOWN_LOCATION_TYPE\",\n /** A business location, either the default business address, or locations defined for the business by the Business Info. */\n BUSINESS = \"BUSINESS\",\n /** The location is unique to this service and isn't defined as one of the business locations. */\n CUSTOM = \"CUSTOM\",\n /** The location can be determined by the customer and is not set up beforehand. */\n CUSTOMER = \"CUSTOMER\"\n }\n interface GetAvailabilityTimeSlotResponse$3 {\n /** Time slot. */\n timeSlot?: TimeSlot$3;\n /** Time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n /**\n * The `TimeSlot` object represents the availability information\n * for an `Appointment` service's specific slot, including:\n *\n * 1. Whether the slot is bookable for the given service?\n *\n * 2. In what location the service is available for this slot?\n *\n * 3. Which available resources can provide the service for this slot?\n *\n * 4. Does booking the slot for the service violates any of the service booking policies?\n *\n * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?\n *\n * > __Note:__\n * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information\n * > for a given list of `Appointment` services within a specific time slot.\n */\n interface TimeSlot$3 {\n /**\n * Service ID.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own serviceId.\n */\n serviceId?: string | null;\n /**\n * Local start date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string | null;\n /**\n * Local end date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string | null;\n /**\n * Whether the slot is bookable according to the service's booking policies.\n *\n * If booking this time slot does not violates any of the service's booking policies,\n * the returned value is `true`. Otherwise, returns `false`.\n */\n bookable?: boolean | null;\n /** The geographic location of the slot. */\n location?: TimeSlotLocation;\n /**\n * Returned only for event.\n * @internal\n */\n eventInfo?: EventInfo$3;\n /** Total number of spots for the slot. */\n totalCapacity?: number | null;\n /**\n * Remaining number of spots for the slot.\n * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.\n */\n remainingCapacity?: number | null;\n /**\n * Indicators for booking policy violations for the slot.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: Service_availabilityBookingPolicyViolations;\n /**\n * List of `AvailableResources` for the time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own available resources.\n */\n availableResources?: AvailableResources$4[];\n /**\n * > Nested time slots.\n * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.\n */\n nestedTimeSlots?: Service_availabilityNestedTimeSlot[];\n }\n /** relevant for event based slots, and not for availability based slots */\n interface EventInfo$3 {\n /**\n * TODO: format - might not be a guid?\n * @internal\n */\n eventId?: string | null;\n /** @internal */\n waitingList?: Service_availabilityWaitingList;\n }\n interface Service_availabilityWaitingList {\n /** Total number of spots in this wait list. */\n totalCapacity?: number | null;\n /**\n * Number of remaining spots for this wait list.\n * For example, a Yoga event with 10 waitList spots and 3 registered\n * on the waitList has 10 `total_capacity` and 7 `remaining_capacity`.\n */\n remainingCapacity?: number | null;\n }\n interface Service_availabilityBookingPolicyViolations {\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 the `TimeSlot` service. */\n bookOnlineDisabled?: boolean | null;\n }\n interface AvailableResources$4 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Available resources for the time slot.\n *\n * + When returned from `ListAvailabilityTimeSlots`, empty by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains __up__ to 10 available resources out of those provided.\n *\n * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains all of the available resources out of those provided.\n *\n *\n * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains __up__ to 10 available resources out of those provided.\n *\n * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains all of the available resources out of those provided.\n */\n resources?: Resource$7[];\n /**\n * The required number of resources of this type in order to book the service.\n * For example, a slot for a service that provides a double massage\n * requires two resources of type `Staff Member` and one resource of type `Room`.\n * @internal\n */\n numberOfResourcesRequired?: number | null;\n /**\n * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.\n * @readonly\n */\n hasMoreAvailableResources?: boolean | null;\n }\n interface Resource$7 {\n /** Resource ID. */\n _id?: string;\n /** Resource name. */\n name?: string | null;\n }\n interface Service_availabilityNestedTimeSlot {\n /** Service ID of the nested time slot. */\n serviceId?: string;\n /**\n * Local start date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string;\n /**\n * Local end date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string;\n /**\n * List of `AvailableResources` for the nested time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n */\n availableResources?: AvailableResources$4[];\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 * @permissionId BOOKINGS.AVAILABILITY_READ\n * @adminMethod\n */\n function queryAvailability(query: QueryV2$5, 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 * specifies whether this request should be proxied to availability\n * @internal\n */\n allowProxyToAvailability?: boolean;\n /**\n * specifies whether slots v2 should be premutated or not, true will mean to not premutate and won't return resource on the slot response.\n * @internal\n */\n anyResource?: boolean;\n /**\n * Selected customer choices.\n * If specified, the selected choices will be used to calculate service configuration.\n * If not specified, the service default configuration will be used.\n * @internal\n */\n customerChoices?: CustomerChoices$3;\n }\n /**\n * Returns the availability for a given slot.\n *\n * A slot for an appointment does not have a `sessionId. Only a slot for a class has a `sessionId`.\n *\n * Availability for an appointment is calculated as follows:\n * - Checking for available slots in the calendar, and calculating the open spots\n * - Checking for existing bookings with overlapping time, service & resource, where the booked session has transparency set to `\"BUSY\"` When the booking is in the process of being checked out, it may not have a sessionId yet. In this case it is considered as `\"BUSY\"`.\n * - Checking for booking policy violations in the services-catalog.\n * The following fields are required to get the availability for an appointment:\n * - `startDate`\n * - `endDate`\n * - `serviceId`\n * - `resourceId`\n * - `scheduleId`\n * Availability for classes is calculated as follows:\n * - Checking for total spots by the session's capacity\n * - Checking for open spots by subtracting the current number of participants from the total spots\n * - Checking for booking policy violations in the services-catalog\n * - Checking for a waitlist and its occupancy in the waiting-list\n * - Checking for locked in the locks\n * For a class, the following fields are required:\n * - `sessionId`\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getSlotAvailability$1(options?: GetSlotAvailabilityOptions$1): Promise;\n interface GetSlotAvailabilityOptions$1 {\n /** The slot for which the availability is checked. */\n slot?: Slot$1;\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 * Return the IDs of bookings that are currently allowed to book\n * the given slot due to being a part of a waitlist in a \"suggested\" status.\n * @internal\n */\n returnAllowedBookingIds?: boolean;\n /**\n * Check if this booking is allowed to book the given slot due to\n * being a part of a waitlist in a \"suggested\" status.\n * If passed and the slot is locked for a different booking than this,\n * then `bookable` = `false` is returned.\n * @internal\n */\n bookingId?: string | null;\n /**\n * Check if should call consistentQuery in order to calculate open spots //todo: this field is temporary in order to align bookings ft conduction with availabilityCalendar ft\n * @internal\n */\n shouldNotCallConsistentQuery?: boolean | null;\n }\n /**\n * Returns availability for a given schedule ID\n * The availability for a course is calculated by:\n * - Checking for total spots by the schedule's capacity\n * - Checking for open spots by subtracting the current number of participants from the total spots\n * current number of participants is calculated by summing the number of participants of all bookings booked to the schedule\n * @param scheduleId - The schedule ID for which availability is being checked.\n * @public\n * @documentationMaturity preview\n * @requiredField scheduleId\n * @adminMethod\n * @deprecated\n */\n function getScheduleAvailability$1(scheduleId: string, options?: GetScheduleAvailabilityOptions): Promise;\n interface GetScheduleAvailabilityOptions {\n /**\n * Check if should call consistentQuery in order to calculate open spots //todo: this field is temporary in order to align bookings ft conduction with availabilityCalendar ft\n * @internal\n */\n shouldNotCallConsistentQuery?: boolean | null;\n }\n /** @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.AVAILABILITY_READ_MULTI_SLOT\n */\n function calculateMultiSlotAvailability(options?: CalculateMultiSlotAvailabilityOptions): Promise;\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$4;\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$a;\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$d;\n }\n /**\n * a decision based proxy between GetSlotAvailability and service-availability's GetAvailabilityTimeSlot\n * this is a temporary solution based on FromV2 flag, and will be removed once all the clients are migrated to v2\n * the request will be proxied to GetSlotAvailability if from_v2 is false, and to GetAvailabilityTimeSlot if from_v2 is true\n * it supports only appointment services (NOT classes, and NOT courses)\n * in case from_v2 is not provided, the request will be proxied based on `ShouldCallAvailabilityService` FT and ResourceManagement check [exists not staff resource]\n * in case from_v2 is false and ResourceManagement check is true, an FAILED_PRECONDITION error will be thrown\n * @param serviceId - Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.localEndDate\n * @requiredField options.localStartDate\n * @requiredField options.timeZone\n * @requiredField serviceId\n * @permissionId BOOKINGS.AVAILABILITY_READ\n */\n function getAvailabilityTimeSlot$1(serviceId: string, options?: GetAvailabilityTimeSlotOptions$1): Promise;\n interface GetAvailabilityTimeSlotOptions$1 {\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location?: TimeSlotLocation;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n fromV2?: boolean | null;\n }\n \n type bookingsAvailabilityV1SlotAvailability_universal_d_QueryAvailabilityRequest = QueryAvailabilityRequest;\n type bookingsAvailabilityV1SlotAvailability_universal_d_QueryAvailabilityResponse = QueryAvailabilityResponse;\n type bookingsAvailabilityV1SlotAvailability_universal_d_CalculateMultiSlotAvailabilityRequest = CalculateMultiSlotAvailabilityRequest;\n type bookingsAvailabilityV1SlotAvailability_universal_d_RuleBasedConstraints = RuleBasedConstraints;\n type bookingsAvailabilityV1SlotAvailability_universal_d_ResourcesFilter = ResourcesFilter;\n type bookingsAvailabilityV1SlotAvailability_universal_d_CalculateMultiSlotAvailabilityResponse = CalculateMultiSlotAvailabilityResponse;\n type bookingsAvailabilityV1SlotAvailability_universal_d_TimeSlotLocation = TimeSlotLocation;\n type bookingsAvailabilityV1SlotAvailability_universal_d_Service_availabilityWaitingList = Service_availabilityWaitingList;\n type bookingsAvailabilityV1SlotAvailability_universal_d_Service_availabilityBookingPolicyViolations = Service_availabilityBookingPolicyViolations;\n type bookingsAvailabilityV1SlotAvailability_universal_d_Service_availabilityNestedTimeSlot = Service_availabilityNestedTimeSlot;\n const bookingsAvailabilityV1SlotAvailability_universal_d_queryAvailability: typeof queryAvailability;\n type bookingsAvailabilityV1SlotAvailability_universal_d_QueryAvailabilityOptions = QueryAvailabilityOptions;\n type bookingsAvailabilityV1SlotAvailability_universal_d_GetScheduleAvailabilityOptions = GetScheduleAvailabilityOptions;\n const bookingsAvailabilityV1SlotAvailability_universal_d_calculateMultiSlotAvailability: typeof calculateMultiSlotAvailability;\n type bookingsAvailabilityV1SlotAvailability_universal_d_CalculateMultiSlotAvailabilityOptions = CalculateMultiSlotAvailabilityOptions;\n namespace bookingsAvailabilityV1SlotAvailability_universal_d {\n export {\n SlotAvailability$1 as SlotAvailability,\n Slot$1 as Slot,\n SlotResource$1 as SlotResource,\n Location$a as Location,\n LocationType$a as LocationType,\n WaitingList$4 as WaitingList,\n BookingPolicyViolations$4 as BookingPolicyViolations,\n NestedTimeSlot$3 as NestedTimeSlot,\n bookingsAvailabilityV1SlotAvailability_universal_d_QueryAvailabilityRequest as QueryAvailabilityRequest,\n QueryV2$5 as QueryV2,\n QueryV2PagingMethodOneOf$5 as QueryV2PagingMethodOneOf,\n Sorting$9 as Sorting,\n SortOrder$9 as SortOrder,\n CursorPaging$d as CursorPaging,\n CustomerChoices$3 as CustomerChoices,\n bookingsAvailabilityV1SlotAvailability_universal_d_QueryAvailabilityResponse as QueryAvailabilityResponse,\n PagingMetadataV2$4 as PagingMetadataV2,\n Cursors$e as Cursors,\n GetSlotAvailabilityRequest$1 as GetSlotAvailabilityRequest,\n GetSlotAvailabilityResponse$1 as GetSlotAvailabilityResponse,\n BookingPolicySettings$2 as BookingPolicySettings,\n GetScheduleAvailabilityRequest$1 as GetScheduleAvailabilityRequest,\n GetScheduleAvailabilityResponse$1 as GetScheduleAvailabilityResponse,\n ScheduleAvailability$1 as ScheduleAvailability,\n bookingsAvailabilityV1SlotAvailability_universal_d_CalculateMultiSlotAvailabilityRequest as CalculateMultiSlotAvailabilityRequest,\n bookingsAvailabilityV1SlotAvailability_universal_d_RuleBasedConstraints as RuleBasedConstraints,\n bookingsAvailabilityV1SlotAvailability_universal_d_ResourcesFilter as ResourcesFilter,\n bookingsAvailabilityV1SlotAvailability_universal_d_CalculateMultiSlotAvailabilityResponse as CalculateMultiSlotAvailabilityResponse,\n CursorPagingMetadata$b as CursorPagingMetadata,\n GetAvailabilityTimeSlotRequest$3 as GetAvailabilityTimeSlotRequest,\n bookingsAvailabilityV1SlotAvailability_universal_d_TimeSlotLocation as TimeSlotLocation,\n LocationLocationType$2 as LocationLocationType,\n GetAvailabilityTimeSlotResponse$3 as GetAvailabilityTimeSlotResponse,\n TimeSlot$3 as TimeSlot,\n EventInfo$3 as EventInfo,\n bookingsAvailabilityV1SlotAvailability_universal_d_Service_availabilityWaitingList as Service_availabilityWaitingList,\n bookingsAvailabilityV1SlotAvailability_universal_d_Service_availabilityBookingPolicyViolations as Service_availabilityBookingPolicyViolations,\n AvailableResources$4 as AvailableResources,\n Resource$7 as Resource,\n bookingsAvailabilityV1SlotAvailability_universal_d_Service_availabilityNestedTimeSlot as Service_availabilityNestedTimeSlot,\n bookingsAvailabilityV1SlotAvailability_universal_d_queryAvailability as queryAvailability,\n bookingsAvailabilityV1SlotAvailability_universal_d_QueryAvailabilityOptions as QueryAvailabilityOptions,\n getSlotAvailability$1 as getSlotAvailability,\n GetSlotAvailabilityOptions$1 as GetSlotAvailabilityOptions,\n getScheduleAvailability$1 as getScheduleAvailability,\n bookingsAvailabilityV1SlotAvailability_universal_d_GetScheduleAvailabilityOptions as GetScheduleAvailabilityOptions,\n bookingsAvailabilityV1SlotAvailability_universal_d_calculateMultiSlotAvailability as calculateMultiSlotAvailability,\n bookingsAvailabilityV1SlotAvailability_universal_d_CalculateMultiSlotAvailabilityOptions as CalculateMultiSlotAvailabilityOptions,\n getAvailabilityTimeSlot$1 as getAvailabilityTimeSlot,\n GetAvailabilityTimeSlotOptions$1 as GetAvailabilityTimeSlotOptions,\n };\n }\n \n /**\n * The `TimeSlot` object represents the availability information\n * for an `Appointment` service's specific slot, including:\n *\n * 1. Whether the slot is bookable for the given service?\n *\n * 2. In what location the service is available for this slot?\n *\n * 3. Which available resources can provide the service for this slot?\n *\n * 4. Does booking the slot for the service violates any of the service booking policies?\n *\n * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?\n *\n * > __Note:__\n * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information\n * > for a given list of `Appointment` services within a specific time slot.\n */\n interface TimeSlot$2 {\n /**\n * Service ID.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own serviceId.\n */\n serviceId?: string | null;\n /**\n * Local start date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string | null;\n /**\n * Local end date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string | null;\n /**\n * Whether the slot is bookable according to the service's booking policies.\n *\n * If booking this time slot does not violates any of the service's booking policies,\n * the returned value is `true`. Otherwise, returns `false`.\n */\n bookable?: boolean | null;\n /** The geographic location of the slot. */\n location?: Location$9;\n /**\n * Returned only for event.\n * @internal\n */\n eventInfo?: EventInfo$2;\n /** Total number of spots for the slot. */\n totalCapacity?: number | null;\n /**\n * Remaining number of spots for the slot.\n * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.\n */\n remainingCapacity?: number | null;\n /**\n * Indicators for booking policy violations for the slot.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$3;\n /**\n * List of `AvailableResources` for the time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own available resources.\n */\n availableResources?: AvailableResources$3[];\n /**\n * > Nested time slots.\n * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.\n */\n nestedTimeSlots?: NestedTimeSlot$2[];\n }\n interface Location$9 {\n /** Business Location ID. Present only if the location is a business location. */\n _id?: string | null;\n /** The location name. */\n name?: string | null;\n /** A string representation for the full address of the location. */\n formattedAddress?: string | null;\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.\n * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.\n */\n locationType?: LocationType$9;\n }\n enum LocationType$9 {\n UNKNOWN_LOCATION_TYPE = \"UNKNOWN_LOCATION_TYPE\",\n /** A business location, either the default business address, or locations defined for the business by the Business Info. */\n BUSINESS = \"BUSINESS\",\n /** The location is unique to this service and isn't defined as one of the business locations. */\n CUSTOM = \"CUSTOM\",\n /** The location can be determined by the customer and is not set up beforehand. */\n CUSTOMER = \"CUSTOMER\"\n }\n /** relevant for event based slots, and not for availability based slots */\n interface EventInfo$2 {\n /**\n * TODO: format - might not be a guid?\n * @internal\n */\n eventId?: string | null;\n /** @internal */\n waitingList?: WaitingList$3;\n }\n interface WaitingList$3 {\n /** Total number of spots in this wait list. */\n totalCapacity?: number | null;\n /**\n * Number of remaining spots for this wait list.\n * For example, a Yoga event with 10 waitList spots and 3 registered\n * on the waitList has 10 `total_capacity` and 7 `remaining_capacity`.\n */\n remainingCapacity?: number | null;\n }\n interface BookingPolicyViolations$3 {\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 the `TimeSlot` service. */\n bookOnlineDisabled?: boolean | null;\n }\n interface AvailableResources$3 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Available resources for the time slot.\n *\n * + When returned from `ListAvailabilityTimeSlots`, empty by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains __up__ to 10 available resources out of those provided.\n *\n * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains all of the available resources out of those provided.\n *\n *\n * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains __up__ to 10 available resources out of those provided.\n *\n * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains all of the available resources out of those provided.\n */\n resources?: Resource$6[];\n /**\n * The required number of resources of this type in order to book the service.\n * For example, a slot for a service that provides a double massage\n * requires two resources of type `Staff Member` and one resource of type `Room`.\n * @internal\n */\n numberOfResourcesRequired?: number | null;\n /**\n * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.\n * @readonly\n */\n hasMoreAvailableResources?: boolean | null;\n }\n interface Resource$6 {\n /** Resource ID. */\n _id?: string;\n /** Resource name. */\n name?: string | null;\n }\n interface NestedTimeSlot$2 {\n /** Service ID of the nested time slot. */\n serviceId?: string;\n /**\n * Local start date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string;\n /**\n * Local end date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string;\n /**\n * List of `AvailableResources` for the nested time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n */\n availableResources?: AvailableResources$3[];\n }\n interface CalculateEventBasedAvailabilityRequest$2 {\n serviceIds: string[];\n from: string;\n to: string;\n timeZone: string;\n /**\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 * TODO: Locks are not taken into account. // Class is not supported yet. (relevant only for classes with waiting list)\n * Aliza's suggestion to consider locks in bookable\n */\n bookable?: boolean | null;\n /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$9[];\n resourceIds?: string[];\n /** if not empty, return slots with openSpots >= X */\n openSpots?: number | 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$3;\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$c;\n }\n interface CursorPaging$c {\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 CalculateEventBasedAvailabilityResponse$2 {\n slots?: TimeSlot$2[];\n cursorPagingMetadata?: CursorPagingMetadata$a;\n }\n interface CursorPagingMetadata$a {\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$d;\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$d {\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 ListEventTimeSlotsRequest$2 {\n /** The services for which the time slots are being returned. */\n serviceIds: string[] | null;\n /**\n * Local start date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n fromLocalDate: string | null;\n /**\n * Local end date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n toLocalDate: string | null;\n /**\n * The time zone, in IANA time zone format.\n * Default is the Wix Business time zone.\n */\n timeZone: string | null;\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 /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$9[];\n /** TODO: maxsize && do we need include_resource_type_id here? also is the behavior is the same as availabilityTimeSlots, we won't return resources by default? */\n resourceIds?: string[] | null;\n /** if not empty, return slots with remainingCapacity >= X */\n remainingCapacity?: number | 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$3;\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 timeSlotsPerDay?: number | null;\n cursorPaging?: CursorPaging$c;\n }\n interface ListEventTimeSlotsResponse$2 {\n /** TODO: maxsize */\n timeSlots?: TimeSlot$2[];\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n cursorPagingMetadata?: CursorPagingMetadata$a;\n }\n interface ListMultiServiceAvailabilityTimeSlotsRequest$2 {\n /**\n * Services for which the multiService time slots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: `2`.\n * MaxSize: `8`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n services?: Service$4[];\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Location for which the multiService TimeSlots are being returned for.\n *\n * You can specify location or location type for which the TimeSlots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n location?: Location$9;\n /**\n * Whether the `TimeSlot` is bookable according to all of the services booking policies.\n *\n * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,\n * returns as `false`. Otherwise, returns as `true`.\n *\n * > __Note:__\n * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,\n * > while a `TimeSlot` with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s\n * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether\n * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.\n *\n * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$3;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch TimeSlots in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`\n * the `cursorPaging`.`limit`. You may pass a different `limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$2;\n }\n interface Service$4 {\n /** Service ID. */\n serviceId?: string;\n /** Resources to include in response. */\n resourceIds?: string[];\n /**\n * The resource type ID's to include in returned time slots.\n * This is in addition to the specifically requested resources.\n *\n *
      \n * Currently supported only for Staff Member resource type.\n * Staff Member type ID: 1cd44cf8-756f-41c3-bd90-3e2ffcaf1155\n *
      \n */\n includeResourceTypeIds?: string[];\n }\n interface CommonCursorPaging$2 {\n /**\n * Number of results to load.\n *\n * Default: `1000`.\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 ListMultiServiceAvailabilityTimeSlotsResponse$2 {\n /** Time slots. */\n timeSlots?: TimeSlot$2[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata$2;\n }\n interface CommonCursorPagingMetadata$2 {\n /** Offset that was requested. */\n cursors?: CommonCursors$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 CommonCursors$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 GetMultiServiceAvailabilityTimeSlotRequest$2 {\n /**\n * Services for which the multiService TimeSlots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: 2.\n * MaxSize: 8.\n */\n services: Service$4[];\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$9;\n }\n interface GetMultiServiceAvailabilityTimeSlotResponse$2 {\n /** Time slot. */\n timeSlot?: TimeSlot$2;\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n interface ListAvailabilityTimeSlotsRequest$2 {\n /**\n * Service ID for which the time slots are being returned for.\n * Currently supported only for services of type `APPOINTMENT`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n serviceId?: string | null;\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Locations to include in response.\n *\n * By default,\n * if no locations are provided,\n * the response contains TimeSlots for all locations where the service is available.\n *\n * You can specify locations or location types for which the time slots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n */\n locations?: Location$9[];\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.\n * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.\n * @deprecated\n */\n resourceIds?: string[];\n /**\n * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains __up__ to 10 available resources of this type.\n */\n includeResourceTypeIds?: string[];\n /**\n * Whether the `TimeSlot` is bookable according to the service's booking policies.\n *\n * If booking this `TimeSlot` does not violates any of the service's booking policies,\n * returns as `true`. Otherwise, returns as `false`.\n *\n * > __Note:__\n * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,\n * > while a time slot with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$3;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch results in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and\n * a `cursorPaging`.`limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$2;\n /**\n * Specifies whether to return all available resources in response.\n * @internal\n */\n shouldReturnAllResources?: boolean;\n /**\n * Selected customer choices.\n * If specified, the selected choices will be used to calculate service configuration.\n * If not specified, the service default configuration will be used.\n * Enforcing this field is the responsibility of the SPI implementer, and not by the Availability API.\n * @internal\n */\n customerChoices?: CustomerChoices$2;\n /**\n * resources filter\n * If specified, only time slots with these resources will be returned.\n */\n resourceTypes?: ResourceType$4[];\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$2 {\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 ResourceType$4 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Resource IDs.\n * The response will contain only slots that have at least one of the specified resources.\n */\n resourceIds?: string[] | null;\n }\n interface ListAvailabilityTimeSlotsResponse$2 {\n /** Time slots. */\n timeSlots?: TimeSlot$2[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata$2;\n }\n interface GetAvailabilityTimeSlotRequest$2 {\n /**\n * Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n */\n serviceId: string;\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$9;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n }\n interface GetAvailabilityTimeSlotResponse$2 {\n /** Time slot. */\n timeSlot?: TimeSlot$2;\n /** Time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n /**\n * Retrieves a list of `TimeSlot`s that match the provided filters.\n *\n *
      \n *

      Important:\n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * The request body __must__ include either:\n * + All of the following filters: `serviceId`, `fromLocalDate`, `toLocalDate`, and `timeZone`.\n * You may add additional filters as you wish.\n * + A `cursorPaging` with a valid `cursor` from previous response.\n *\n *\n * Each [TimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/availability-time-slots/time-slot-object) in response\n * represents the availability of the service in a specific location,\n * and has a `localStartDate` within the range of the provided `fromLocalDate` and `toLocalDate` exclusive.\n * The `localEndDate` of a `TimeSlot` is calculated as the sum of the `TimeSlot`'s `localStartDate` and the duration of the service.\n *\n * By default,\n * the response contains at most 1000 results.\n * If there are more than 1000 results, we return a `cursorPagingMetadata` with\n * a cursor for the next page of results, regardless of whether a `cursorPaging`\n * was provided in request.\n *\n * ### AvailableResources in response\n * The `TimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service\n * within the time slot. Each `AvailableResources` contains information about available resources of the same type.\n *\n *
      \n *

      Important:
      \n * By default,\n * if you don't specify includeResourceTypeIds\n * or resourceIds filters in request,\n * we return TimeSlots with an empty AvailableResources.\n *
      Note:
      Not specifying resources filters can be handy in case you want to avoid large response in flows that only\n * interested of whether the time slots are available. [Finding the next available slot within the next 3 months](https://bo.wix.com/wix-docs/rest/all-apis/service-availability/availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-the-selected-service-is-available-for)\n * is an example for such flow.\n *

      \n *
      \n *\n * If you wish to get a list of available resources for each `TimeSlot` you should either:\n * + provide `resourceIds` in request.\n * + provide `includeResourceTypeIds` in request.\n *\n * __Notes:__\n * + In both cases the returned TimeSlots contains __up__ to 10 `AvailableResources` that match the provided filters.\n * Each `AvailableResources` contains __up__ to 10 available `resources` of the same type that match the provided filters.\n * + If an `AvailableResources` has more available resources which are not listed within it,\n * we return `AvailableResources`.`hasMoreAvailableResources` as true.\n * > __Note:__\n * > If you wish to get the full available resources list for a specific `TimeSlot`,\n * > you should call [GetAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/get-availability-time-slot).\n *\n *\n * ### Availability VS Bookability\n * An `available` time slot is not necessarily `bookable`.\n * The `bookable` field of a `TimeSlot` indicates whether a customer can book the service within the given time slot,\n * at a specific period of time.\n * Read more about [Availability VS Bookability](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/service-availability-time-slots/introduction#all-apis_wix-service-availability_service-availability-time-slots_introduction_availability-vs-bookability).\n *\n * By default,\n * + The response does not contains `unavailable` TimeSlots.\n * For example,\n * if there are no available resources to provide the service from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`,\n * we don't return TimeSlots with `localStartDate` within this range.\n * + The response contains both `bookable` and `un-bookable` TimeSlots.\n * For example,\n * if the service has a booking policy which enforces booking the service up to 10 minutes before the session starts,\n * we return TimeSlots with the violating `localStartDate` with `bookable` as false.\n * If you wish to list only available __bookable__ TimeSlots you should pass `bookable` filter as true.\n *\n *
      \n *

      Important:\n * Because of DST, there are edge cases where certain times either do not exist or exist twice for a local time zone.\n * Read more about DST Handling

      \n *
      \n *\n *\n * ### ListAvailabilityTimeSlots runs with the following defaults\n * + `localStartDate` is sorted in `ASC` order\n * + `cursorPaging`.`limit` is `1000`\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.AVAILABILITY_READ_TIME_SLOTS\n */\n function listAvailabilityTimeSlots(options?: ListAvailabilityTimeSlotsOptions): Promise;\n interface ListAvailabilityTimeSlotsOptions {\n /**\n * Service ID for which the time slots are being returned for.\n * Currently supported only for services of type `APPOINTMENT`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n serviceId?: string | null;\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Locations to include in response.\n *\n * By default,\n * if no locations are provided,\n * the response contains TimeSlots for all locations where the service is available.\n *\n * You can specify locations or location types for which the time slots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n */\n locations?: Location$9[];\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.\n * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.\n * @deprecated\n */\n resourceIds?: string[];\n /**\n * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains __up__ to 10 available resources of this type.\n */\n includeResourceTypeIds?: string[];\n /**\n * Whether the `TimeSlot` is bookable according to the service's booking policies.\n *\n * If booking this `TimeSlot` does not violates any of the service's booking policies,\n * returns as `true`. Otherwise, returns as `false`.\n *\n * > __Note:__\n * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,\n * > while a time slot with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$3;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch results in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and\n * a `cursorPaging`.`limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$2;\n /**\n * Specifies whether to return all available resources in response.\n * @internal\n */\n shouldReturnAllResources?: boolean;\n /**\n * Selected customer choices.\n * If specified, the selected choices will be used to calculate service configuration.\n * If not specified, the service default configuration will be used.\n * Enforcing this field is the responsibility of the SPI implementer, and not by the Availability API.\n * @internal\n */\n customerChoices?: CustomerChoices$2;\n /**\n * resources filter\n * If specified, only time slots with these resources will be returned.\n */\n resourceTypes?: ResourceType$4[];\n }\n /**\n * Retrieves an available `TimeSlot` that match the provided filters.\n *\n * Throws `SlotNotFound` if there is no such available time slot.\n *\n *
      \n *

      Important:
      \n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * By default,\n * if you don't provide `includeResourceTypeIds` or `resourceIds` in request,\n * we return all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide\n * the service within the time slot.\n *\n * If you specify `includeResourceTypeIds` or `resourceIds` in request,\n * the returned `TimeSlot` will contain only `AvailableResources` with at least one available resource\n * which match the given resources filters,\n * each contains all available resources out of those requested.\n *\n *\n *
      \n *

      Tip:
      \n * Use this API in order to get the availability of a specific TimeSlot out of those returned from ListAvailabilityTimeSlots API.

      \n *
      \n * @param serviceId - Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n * @param localStartDate - Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n * @param localEndDate - Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n * @param timeZone - Time zone, in IANA time zone format.\n * @param location - The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n * @public\n * @documentationMaturity preview\n * @requiredField localEndDate\n * @requiredField localStartDate\n * @requiredField location\n * @requiredField serviceId\n * @requiredField timeZone\n * @permissionId BOOKINGS.AVAILABILITY_READ_TIME_SLOTS\n */\n function getAvailabilityTimeSlot(serviceId: string, localStartDate: string, localEndDate: string, timeZone: string | null, location: Location$9, options?: GetAvailabilityTimeSlotOptions): Promise;\n interface GetAvailabilityTimeSlotOptions {\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n }\n \n const bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_listAvailabilityTimeSlots: typeof listAvailabilityTimeSlots;\n type bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_ListAvailabilityTimeSlotsOptions = ListAvailabilityTimeSlotsOptions;\n const bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_getAvailabilityTimeSlot: typeof getAvailabilityTimeSlot;\n type bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_GetAvailabilityTimeSlotOptions = GetAvailabilityTimeSlotOptions;\n namespace bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d {\n export {\n TimeSlot$2 as TimeSlot,\n Location$9 as Location,\n LocationType$9 as LocationType,\n EventInfo$2 as EventInfo,\n WaitingList$3 as WaitingList,\n BookingPolicyViolations$3 as BookingPolicyViolations,\n AvailableResources$3 as AvailableResources,\n Resource$6 as Resource,\n NestedTimeSlot$2 as NestedTimeSlot,\n CalculateEventBasedAvailabilityRequest$2 as CalculateEventBasedAvailabilityRequest,\n CursorPaging$c as CursorPaging,\n CalculateEventBasedAvailabilityResponse$2 as CalculateEventBasedAvailabilityResponse,\n CursorPagingMetadata$a as CursorPagingMetadata,\n Cursors$d as Cursors,\n ListEventTimeSlotsRequest$2 as ListEventTimeSlotsRequest,\n ListEventTimeSlotsResponse$2 as ListEventTimeSlotsResponse,\n ListMultiServiceAvailabilityTimeSlotsRequest$2 as ListMultiServiceAvailabilityTimeSlotsRequest,\n Service$4 as Service,\n CommonCursorPaging$2 as CommonCursorPaging,\n ListMultiServiceAvailabilityTimeSlotsResponse$2 as ListMultiServiceAvailabilityTimeSlotsResponse,\n CommonCursorPagingMetadata$2 as CommonCursorPagingMetadata,\n CommonCursors$2 as CommonCursors,\n GetMultiServiceAvailabilityTimeSlotRequest$2 as GetMultiServiceAvailabilityTimeSlotRequest,\n GetMultiServiceAvailabilityTimeSlotResponse$2 as GetMultiServiceAvailabilityTimeSlotResponse,\n ListAvailabilityTimeSlotsRequest$2 as ListAvailabilityTimeSlotsRequest,\n CustomerChoices$2 as CustomerChoices,\n ResourceType$4 as ResourceType,\n ListAvailabilityTimeSlotsResponse$2 as ListAvailabilityTimeSlotsResponse,\n GetAvailabilityTimeSlotRequest$2 as GetAvailabilityTimeSlotRequest,\n GetAvailabilityTimeSlotResponse$2 as GetAvailabilityTimeSlotResponse,\n bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_listAvailabilityTimeSlots as listAvailabilityTimeSlots,\n bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_ListAvailabilityTimeSlotsOptions as ListAvailabilityTimeSlotsOptions,\n bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_getAvailabilityTimeSlot as getAvailabilityTimeSlot,\n bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d_GetAvailabilityTimeSlotOptions as GetAvailabilityTimeSlotOptions,\n };\n }\n \n /**\n * The `TimeSlot` object represents the availability information\n * for an `Appointment` service's specific slot, including:\n *\n * 1. Whether the slot is bookable for the given service?\n *\n * 2. In what location the service is available for this slot?\n *\n * 3. Which available resources can provide the service for this slot?\n *\n * 4. Does booking the slot for the service violates any of the service booking policies?\n *\n * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?\n *\n * > __Note:__\n * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information\n * > for a given list of `Appointment` services within a specific time slot.\n */\n interface TimeSlot$1 {\n /**\n * Service ID.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own serviceId.\n */\n serviceId?: string | null;\n /**\n * Local start date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string | null;\n /**\n * Local end date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string | null;\n /**\n * Whether the slot is bookable according to the service's booking policies.\n *\n * If booking this time slot does not violates any of the service's booking policies,\n * the returned value is `true`. Otherwise, returns `false`.\n */\n bookable?: boolean | null;\n /** The geographic location of the slot. */\n location?: Location$8;\n /**\n * Returned only for event.\n * @internal\n */\n eventInfo?: EventInfo$1;\n /** Total number of spots for the slot. */\n totalCapacity?: number | null;\n /**\n * Remaining number of spots for the slot.\n * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.\n */\n remainingCapacity?: number | null;\n /**\n * Indicators for booking policy violations for the slot.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$2;\n /**\n * List of `AvailableResources` for the time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own available resources.\n */\n availableResources?: AvailableResources$2[];\n /**\n * > Nested time slots.\n * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.\n */\n nestedTimeSlots?: NestedTimeSlot$1[];\n }\n interface Location$8 {\n /** Business Location ID. Present only if the location is a business location. */\n _id?: string | null;\n /** The location name. */\n name?: string | null;\n /** A string representation for the full address of the location. */\n formattedAddress?: string | null;\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.\n * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.\n */\n locationType?: LocationType$8;\n }\n enum LocationType$8 {\n UNKNOWN_LOCATION_TYPE = \"UNKNOWN_LOCATION_TYPE\",\n /** A business location, either the default business address, or locations defined for the business by the Business Info. */\n BUSINESS = \"BUSINESS\",\n /** The location is unique to this service and isn't defined as one of the business locations. */\n CUSTOM = \"CUSTOM\",\n /** The location can be determined by the customer and is not set up beforehand. */\n CUSTOMER = \"CUSTOMER\"\n }\n /** relevant for event based slots, and not for availability based slots */\n interface EventInfo$1 {\n /**\n * TODO: format - might not be a guid?\n * @internal\n */\n eventId?: string | null;\n /** @internal */\n waitingList?: WaitingList$2;\n }\n interface WaitingList$2 {\n /** Total number of spots in this wait list. */\n totalCapacity?: number | null;\n /**\n * Number of remaining spots for this wait list.\n * For example, a Yoga event with 10 waitList spots and 3 registered\n * on the waitList has 10 `total_capacity` and 7 `remaining_capacity`.\n */\n remainingCapacity?: number | null;\n }\n interface BookingPolicyViolations$2 {\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 the `TimeSlot` service. */\n bookOnlineDisabled?: boolean | null;\n }\n interface AvailableResources$2 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Available resources for the time slot.\n *\n * + When returned from `ListAvailabilityTimeSlots`, empty by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains __up__ to 10 available resources out of those provided.\n *\n * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains all of the available resources out of those provided.\n *\n *\n * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains __up__ to 10 available resources out of those provided.\n *\n * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains all of the available resources out of those provided.\n */\n resources?: Resource$5[];\n /**\n * The required number of resources of this type in order to book the service.\n * For example, a slot for a service that provides a double massage\n * requires two resources of type `Staff Member` and one resource of type `Room`.\n * @internal\n */\n numberOfResourcesRequired?: number | null;\n /**\n * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.\n * @readonly\n */\n hasMoreAvailableResources?: boolean | null;\n }\n interface Resource$5 {\n /** Resource ID. */\n _id?: string;\n /** Resource name. */\n name?: string | null;\n }\n interface NestedTimeSlot$1 {\n /** Service ID of the nested time slot. */\n serviceId?: string;\n /**\n * Local start date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string;\n /**\n * Local end date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string;\n /**\n * List of `AvailableResources` for the nested time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n */\n availableResources?: AvailableResources$2[];\n }\n interface CalculateEventBasedAvailabilityRequest$1 {\n serviceIds: string[];\n from: string;\n to: string;\n timeZone: string;\n /**\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 * TODO: Locks are not taken into account. // Class is not supported yet. (relevant only for classes with waiting list)\n * Aliza's suggestion to consider locks in bookable\n */\n bookable?: boolean | null;\n /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$8[];\n resourceIds?: string[];\n /** if not empty, return slots with openSpots >= X */\n openSpots?: number | 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$2;\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$b;\n }\n interface CursorPaging$b {\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 CalculateEventBasedAvailabilityResponse$1 {\n slots?: TimeSlot$1[];\n cursorPagingMetadata?: CursorPagingMetadata$9;\n }\n interface CursorPagingMetadata$9 {\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$c;\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$c {\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 ListEventTimeSlotsRequest$1 {\n /** The services for which the time slots are being returned. */\n serviceIds: string[] | null;\n /**\n * Local start date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n fromLocalDate: string | null;\n /**\n * Local end date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n toLocalDate: string | null;\n /**\n * The time zone, in IANA time zone format.\n * Default is the Wix Business time zone.\n */\n timeZone: string | null;\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 /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$8[];\n /** TODO: maxsize && do we need include_resource_type_id here? also is the behavior is the same as availabilityTimeSlots, we won't return resources by default? */\n resourceIds?: string[] | null;\n /** if not empty, return slots with remainingCapacity >= X */\n remainingCapacity?: number | 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$2;\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 timeSlotsPerDay?: number | null;\n cursorPaging?: CursorPaging$b;\n }\n interface ListEventTimeSlotsResponse$1 {\n /** TODO: maxsize */\n timeSlots?: TimeSlot$1[];\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n cursorPagingMetadata?: CursorPagingMetadata$9;\n }\n interface ListMultiServiceAvailabilityTimeSlotsRequest$1 {\n /**\n * Services for which the multiService time slots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: `2`.\n * MaxSize: `8`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n services?: Service$3[];\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Location for which the multiService TimeSlots are being returned for.\n *\n * You can specify location or location type for which the TimeSlots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n location?: Location$8;\n /**\n * Whether the `TimeSlot` is bookable according to all of the services booking policies.\n *\n * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,\n * returns as `false`. Otherwise, returns as `true`.\n *\n * > __Note:__\n * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,\n * > while a `TimeSlot` with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s\n * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether\n * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.\n *\n * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$2;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch TimeSlots in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`\n * the `cursorPaging`.`limit`. You may pass a different `limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$1;\n }\n interface Service$3 {\n /** Service ID. */\n serviceId?: string;\n /** Resources to include in response. */\n resourceIds?: string[];\n /**\n * The resource type ID's to include in returned time slots.\n * This is in addition to the specifically requested resources.\n *\n *
      \n * Currently supported only for Staff Member resource type.\n * Staff Member type ID: 1cd44cf8-756f-41c3-bd90-3e2ffcaf1155\n *
      \n */\n includeResourceTypeIds?: string[];\n }\n interface CommonCursorPaging$1 {\n /**\n * Number of results to load.\n *\n * Default: `1000`.\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 ListMultiServiceAvailabilityTimeSlotsResponse$1 {\n /** Time slots. */\n timeSlots?: TimeSlot$1[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata$1;\n }\n interface CommonCursorPagingMetadata$1 {\n /** Offset that was requested. */\n cursors?: CommonCursors$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 CommonCursors$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 GetMultiServiceAvailabilityTimeSlotRequest$1 {\n /**\n * Services for which the multiService TimeSlots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: 2.\n * MaxSize: 8.\n */\n services: Service$3[];\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$8;\n }\n interface GetMultiServiceAvailabilityTimeSlotResponse$1 {\n /** Time slot. */\n timeSlot?: TimeSlot$1;\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n interface ListAvailabilityTimeSlotsRequest$1 {\n /**\n * Service ID for which the time slots are being returned for.\n * Currently supported only for services of type `APPOINTMENT`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n serviceId?: string | null;\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Locations to include in response.\n *\n * By default,\n * if no locations are provided,\n * the response contains TimeSlots for all locations where the service is available.\n *\n * You can specify locations or location types for which the time slots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n */\n locations?: Location$8[];\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.\n * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.\n * @deprecated\n */\n resourceIds?: string[];\n /**\n * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains __up__ to 10 available resources of this type.\n */\n includeResourceTypeIds?: string[];\n /**\n * Whether the `TimeSlot` is bookable according to the service's booking policies.\n *\n * If booking this `TimeSlot` does not violates any of the service's booking policies,\n * returns as `true`. Otherwise, returns as `false`.\n *\n * > __Note:__\n * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,\n * > while a time slot with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$2;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch results in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and\n * a `cursorPaging`.`limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging$1;\n /**\n * Specifies whether to return all available resources in response.\n * @internal\n */\n shouldReturnAllResources?: boolean;\n /**\n * Selected customer choices.\n * If specified, the selected choices will be used to calculate service configuration.\n * If not specified, the service default configuration will be used.\n * Enforcing this field is the responsibility of the SPI implementer, and not by the Availability API.\n * @internal\n */\n customerChoices?: CustomerChoices$1;\n /**\n * resources filter\n * If specified, only time slots with these resources will be returned.\n */\n resourceTypes?: ResourceType$3[];\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$1 {\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 ResourceType$3 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Resource IDs.\n * The response will contain only slots that have at least one of the specified resources.\n */\n resourceIds?: string[] | null;\n }\n interface ListAvailabilityTimeSlotsResponse$1 {\n /** Time slots. */\n timeSlots?: TimeSlot$1[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata$1;\n }\n interface GetAvailabilityTimeSlotRequest$1 {\n /**\n * Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n */\n serviceId: string;\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$8;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n }\n interface GetAvailabilityTimeSlotResponse$1 {\n /** Time slot. */\n timeSlot?: TimeSlot$1;\n /** Time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField options.from\n * @requiredField options.timeZone\n * @requiredField options.to\n * @requiredField serviceIds\n * @permissionId BOOKINGS.AVAILABILITY_READ\n */\n function calculateEventBasedAvailability(serviceIds: string[], options?: CalculateEventBasedAvailabilityOptions): Promise;\n interface CalculateEventBasedAvailabilityOptions {\n from: string;\n to: string;\n timeZone: string;\n /**\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 * TODO: Locks are not taken into account. // Class is not supported yet. (relevant only for classes with waiting list)\n * Aliza's suggestion to consider locks in bookable\n */\n bookable?: boolean | null;\n /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$8[];\n resourceIds?: string[];\n /** if not empty, return slots with openSpots >= X */\n openSpots?: number | 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$2;\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$b;\n }\n /**\n * TODO explain the sorting tie breaker\n * Return a list of available slots, for Event based services\n * can be called only for services with tag \"GROUP\"\n * @param serviceIds - The services for which the time slots are being returned.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.fromLocalDate\n * @requiredField options.timeZone\n * @requiredField options.toLocalDate\n * @requiredField serviceIds\n * @permissionId BOOKINGS.AVAILABILITY_READ\n */\n function listEventTimeSlots(serviceIds: string[] | null, options?: ListEventTimeSlotsOptions): Promise;\n interface ListEventTimeSlotsOptions {\n /**\n * Local start date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n fromLocalDate: string | null;\n /**\n * Local end date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n toLocalDate: string | null;\n /**\n * The time zone, in IANA time zone format.\n * Default is the Wix Business time zone.\n */\n timeZone: string | null;\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 /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$8[];\n /** TODO: maxsize && do we need include_resource_type_id here? also is the behavior is the same as availabilityTimeSlots, we won't return resources by default? */\n resourceIds?: string[] | null;\n /** if not empty, return slots with remainingCapacity >= X */\n remainingCapacity?: number | 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$2;\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 timeSlotsPerDay?: number | null;\n cursorPaging?: CursorPaging$b;\n }\n \n const bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_calculateEventBasedAvailability: typeof calculateEventBasedAvailability;\n type bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_CalculateEventBasedAvailabilityOptions = CalculateEventBasedAvailabilityOptions;\n const bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_listEventTimeSlots: typeof listEventTimeSlots;\n type bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_ListEventTimeSlotsOptions = ListEventTimeSlotsOptions;\n namespace bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d {\n export {\n TimeSlot$1 as TimeSlot,\n Location$8 as Location,\n LocationType$8 as LocationType,\n EventInfo$1 as EventInfo,\n WaitingList$2 as WaitingList,\n BookingPolicyViolations$2 as BookingPolicyViolations,\n AvailableResources$2 as AvailableResources,\n Resource$5 as Resource,\n NestedTimeSlot$1 as NestedTimeSlot,\n CalculateEventBasedAvailabilityRequest$1 as CalculateEventBasedAvailabilityRequest,\n CursorPaging$b as CursorPaging,\n CalculateEventBasedAvailabilityResponse$1 as CalculateEventBasedAvailabilityResponse,\n CursorPagingMetadata$9 as CursorPagingMetadata,\n Cursors$c as Cursors,\n ListEventTimeSlotsRequest$1 as ListEventTimeSlotsRequest,\n ListEventTimeSlotsResponse$1 as ListEventTimeSlotsResponse,\n ListMultiServiceAvailabilityTimeSlotsRequest$1 as ListMultiServiceAvailabilityTimeSlotsRequest,\n Service$3 as Service,\n CommonCursorPaging$1 as CommonCursorPaging,\n ListMultiServiceAvailabilityTimeSlotsResponse$1 as ListMultiServiceAvailabilityTimeSlotsResponse,\n CommonCursorPagingMetadata$1 as CommonCursorPagingMetadata,\n CommonCursors$1 as CommonCursors,\n GetMultiServiceAvailabilityTimeSlotRequest$1 as GetMultiServiceAvailabilityTimeSlotRequest,\n GetMultiServiceAvailabilityTimeSlotResponse$1 as GetMultiServiceAvailabilityTimeSlotResponse,\n ListAvailabilityTimeSlotsRequest$1 as ListAvailabilityTimeSlotsRequest,\n CustomerChoices$1 as CustomerChoices,\n ResourceType$3 as ResourceType,\n ListAvailabilityTimeSlotsResponse$1 as ListAvailabilityTimeSlotsResponse,\n GetAvailabilityTimeSlotRequest$1 as GetAvailabilityTimeSlotRequest,\n GetAvailabilityTimeSlotResponse$1 as GetAvailabilityTimeSlotResponse,\n bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_calculateEventBasedAvailability as calculateEventBasedAvailability,\n bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_CalculateEventBasedAvailabilityOptions as CalculateEventBasedAvailabilityOptions,\n bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_listEventTimeSlots as listEventTimeSlots,\n bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d_ListEventTimeSlotsOptions as ListEventTimeSlotsOptions,\n };\n }\n \n /**\n * The `TimeSlot` object represents the availability information\n * for an `Appointment` service's specific slot, including:\n *\n * 1. Whether the slot is bookable for the given service?\n *\n * 2. In what location the service is available for this slot?\n *\n * 3. Which available resources can provide the service for this slot?\n *\n * 4. Does booking the slot for the service violates any of the service booking policies?\n *\n * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?\n *\n * > __Note:__\n * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information\n * > for a given list of `Appointment` services within a specific time slot.\n */\n interface TimeSlot {\n /**\n * Service ID.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own serviceId.\n */\n serviceId?: string | null;\n /**\n * Local start date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string | null;\n /**\n * Local end date of the time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string | null;\n /**\n * Whether the slot is bookable according to the service's booking policies.\n *\n * If booking this time slot does not violates any of the service's booking policies,\n * the returned value is `true`. Otherwise, returns `false`.\n */\n bookable?: boolean | null;\n /** The geographic location of the slot. */\n location?: Location$7;\n /**\n * Returned only for event.\n * @internal\n */\n eventInfo?: EventInfo;\n /** Total number of spots for the slot. */\n totalCapacity?: number | null;\n /**\n * Remaining number of spots for the slot.\n * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.\n */\n remainingCapacity?: number | null;\n /**\n * Indicators for booking policy violations for the slot.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$1;\n /**\n * List of `AvailableResources` for the time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n *\n * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.\n * > Instead, each nested time slot has its own available resources.\n */\n availableResources?: AvailableResources$1[];\n /**\n * > Nested time slots.\n * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.\n */\n nestedTimeSlots?: NestedTimeSlot[];\n }\n interface Location$7 {\n /** Business Location ID. Present only if the location is a business location. */\n _id?: string | null;\n /** The location name. */\n name?: string | null;\n /** A string representation for the full address of the location. */\n formattedAddress?: string | null;\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.\n * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.\n */\n locationType?: LocationType$7;\n }\n enum LocationType$7 {\n UNKNOWN_LOCATION_TYPE = \"UNKNOWN_LOCATION_TYPE\",\n /** A business location, either the default business address, or locations defined for the business by the Business Info. */\n BUSINESS = \"BUSINESS\",\n /** The location is unique to this service and isn't defined as one of the business locations. */\n CUSTOM = \"CUSTOM\",\n /** The location can be determined by the customer and is not set up beforehand. */\n CUSTOMER = \"CUSTOMER\"\n }\n /** relevant for event based slots, and not for availability based slots */\n interface EventInfo {\n /**\n * TODO: format - might not be a guid?\n * @internal\n */\n eventId?: string | null;\n /** @internal */\n waitingList?: WaitingList$1;\n }\n interface WaitingList$1 {\n /** Total number of spots in this wait list. */\n totalCapacity?: number | null;\n /**\n * Number of remaining spots for this wait list.\n * For example, a Yoga event with 10 waitList spots and 3 registered\n * on the waitList has 10 `total_capacity` and 7 `remaining_capacity`.\n */\n remainingCapacity?: number | null;\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 the `TimeSlot` service. */\n bookOnlineDisabled?: boolean | null;\n }\n interface AvailableResources$1 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Available resources for the time slot.\n *\n * + When returned from `ListAvailabilityTimeSlots`, empty by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains __up__ to 10 available resources out of those provided.\n *\n * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.\n * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * contains all of the available resources out of those provided.\n *\n *\n * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains __up__ to 10 available resources out of those provided.\n *\n * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.\n * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,\n * > contains all of the available resources out of those provided.\n */\n resources?: Resource$4[];\n /**\n * The required number of resources of this type in order to book the service.\n * For example, a slot for a service that provides a double massage\n * requires two resources of type `Staff Member` and one resource of type `Room`.\n * @internal\n */\n numberOfResourcesRequired?: number | null;\n /**\n * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.\n * @readonly\n */\n hasMoreAvailableResources?: boolean | null;\n }\n interface Resource$4 {\n /** Resource ID. */\n _id?: string;\n /** Resource name. */\n name?: string | null;\n }\n interface NestedTimeSlot {\n /** Service ID of the nested time slot. */\n serviceId?: string;\n /**\n * Local start date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate?: string;\n /**\n * Local end date of the nested time slot in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate?: string;\n /**\n * List of `AvailableResources` for the nested time slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n */\n availableResources?: AvailableResources$1[];\n }\n interface CalculateEventBasedAvailabilityRequest {\n serviceIds: string[];\n from: string;\n to: string;\n timeZone: string;\n /**\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 * TODO: Locks are not taken into account. // Class is not supported yet. (relevant only for classes with waiting list)\n * Aliza's suggestion to consider locks in bookable\n */\n bookable?: boolean | null;\n /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$7[];\n resourceIds?: string[];\n /** if not empty, return slots with openSpots >= X */\n openSpots?: number | 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$1;\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$a;\n }\n interface CursorPaging$a {\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 CalculateEventBasedAvailabilityResponse {\n slots?: TimeSlot[];\n cursorPagingMetadata?: CursorPagingMetadata$8;\n }\n interface CursorPagingMetadata$8 {\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$b;\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$b {\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 ListEventTimeSlotsRequest {\n /** The services for which the time slots are being returned. */\n serviceIds: string[] | null;\n /**\n * Local start date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n fromLocalDate: string | null;\n /**\n * Local end date for which event time slots are returned, in ISO-8601 format.\n * E.g, \"2024-01-30T13:30:00\".\n * Required, unless `cursorPaging` is provided.\n */\n toLocalDate: string | null;\n /**\n * The time zone, in IANA time zone format.\n * Default is the Wix Business time zone.\n */\n timeZone: string | null;\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 /** support filtering by location type, or by locationId. Other fields like `name` are ignored */\n location?: Location$7[];\n /** TODO: maxsize && do we need include_resource_type_id here? also is the behavior is the same as availabilityTimeSlots, we won't return resources by default? */\n resourceIds?: string[] | null;\n /** if not empty, return slots with remainingCapacity >= X */\n remainingCapacity?: number | 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$1;\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 timeSlotsPerDay?: number | null;\n cursorPaging?: CursorPaging$a;\n }\n interface ListEventTimeSlotsResponse {\n /** TODO: maxsize */\n timeSlots?: TimeSlot[];\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n cursorPagingMetadata?: CursorPagingMetadata$8;\n }\n interface ListMultiServiceAvailabilityTimeSlotsRequest {\n /**\n * Services for which the multiService time slots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: `2`.\n * MaxSize: `8`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n services?: Service$2[];\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Location for which the multiService TimeSlots are being returned for.\n *\n * You can specify location or location type for which the TimeSlots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n location?: Location$7;\n /**\n * Whether the `TimeSlot` is bookable according to all of the services booking policies.\n *\n * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,\n * returns as `false`. Otherwise, returns as `true`.\n *\n * > __Note:__\n * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,\n * > while a `TimeSlot` with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s\n * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether\n * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.\n *\n * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$1;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch TimeSlots in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`\n * the `cursorPaging`.`limit`. You may pass a different `limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging;\n }\n interface Service$2 {\n /** Service ID. */\n serviceId?: string;\n /** Resources to include in response. */\n resourceIds?: string[];\n /**\n * The resource type ID's to include in returned time slots.\n * This is in addition to the specifically requested resources.\n *\n *
      \n * Currently supported only for Staff Member resource type.\n * Staff Member type ID: 1cd44cf8-756f-41c3-bd90-3e2ffcaf1155\n *
      \n */\n includeResourceTypeIds?: string[];\n }\n interface CommonCursorPaging {\n /**\n * Number of results to load.\n *\n * Default: `1000`.\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 ListMultiServiceAvailabilityTimeSlotsResponse {\n /** Time slots. */\n timeSlots?: TimeSlot[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata;\n }\n interface CommonCursorPagingMetadata {\n /** Offset that was requested. */\n cursors?: CommonCursors;\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 CommonCursors {\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 GetMultiServiceAvailabilityTimeSlotRequest {\n /**\n * Services for which the multiService TimeSlots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: 2.\n * MaxSize: 8.\n */\n services: Service$2[];\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$7;\n }\n interface GetMultiServiceAvailabilityTimeSlotResponse {\n /** Time slot. */\n timeSlot?: TimeSlot;\n /** The time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n interface ListAvailabilityTimeSlotsRequest {\n /**\n * Service ID for which the time slots are being returned for.\n * Currently supported only for services of type `APPOINTMENT`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n serviceId?: string | null;\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Locations to include in response.\n *\n * By default,\n * if no locations are provided,\n * the response contains TimeSlots for all locations where the service is available.\n *\n * You can specify locations or location types for which the time slots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n */\n locations?: Location$7[];\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.\n * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.\n * @deprecated\n */\n resourceIds?: string[];\n /**\n * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains __up__ to 10 available resources of this type.\n */\n includeResourceTypeIds?: string[];\n /**\n * Whether the `TimeSlot` is bookable according to the service's booking policies.\n *\n * If booking this `TimeSlot` does not violates any of the service's booking policies,\n * returns as `true`. Otherwise, returns as `false`.\n *\n * > __Note:__\n * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,\n * > while a time slot with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$1;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch results in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and\n * a `cursorPaging`.`limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging;\n /**\n * Specifies whether to return all available resources in response.\n * @internal\n */\n shouldReturnAllResources?: boolean;\n /**\n * Selected customer choices.\n * If specified, the selected choices will be used to calculate service configuration.\n * If not specified, the service default configuration will be used.\n * Enforcing this field is the responsibility of the SPI implementer, and not by the Availability API.\n * @internal\n */\n customerChoices?: CustomerChoices;\n /**\n * resources filter\n * If specified, only time slots with these resources will be returned.\n */\n resourceTypes?: ResourceType$2[];\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 ResourceType$2 {\n /** Resource type ID. */\n resourceTypeId?: string | null;\n /**\n * Resource IDs.\n * The response will contain only slots that have at least one of the specified resources.\n */\n resourceIds?: string[] | null;\n }\n interface ListAvailabilityTimeSlotsResponse {\n /** Time slots. */\n timeSlots?: TimeSlot[];\n /**\n * Time zone, in IANA time zone format.\n * Shared for all TimeSlots in response.\n */\n timeZone?: string | null;\n /**\n * CursorPagingMetaData.\n * Contains information about the next page of results.\n *\n * By default,\n * if there are more than 1000 results,\n * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.\n *\n *
      \n *

      Important:
      \n * count is not supported.

      \n *
      \n */\n cursorPagingMetadata?: CommonCursorPagingMetadata;\n }\n interface GetAvailabilityTimeSlotRequest {\n /**\n * Service ID of the time slot.\n * Currently supported only for services of type `APPOINTMENT`.\n */\n serviceId: string;\n /**\n * Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n */\n localStartDate: string;\n /**\n * Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n */\n localEndDate: string;\n /** Time zone, in IANA time zone format. */\n timeZone: string | null;\n /**\n * The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n */\n location: Location$7;\n /**\n * Resources to include in response.\n *\n * If specified,\n * the returned `TimeSlot` contains only the available resources out of provided list.\n * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.\n */\n resourceIds?: string[];\n /**\n * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.\n *\n * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`\n * out of those specified, each contains all the available resources of this type.\n */\n includeResourceTypeIds?: string[];\n }\n interface GetAvailabilityTimeSlotResponse {\n /** Time slot. */\n timeSlot?: TimeSlot;\n /** Time zone, in IANA time zone format. */\n timeZone?: string | null;\n }\n /**\n * Retrieves a list of multiService `TimeSlot`s that match the provided filters.\n *\n *
      \n *

      Important:
      \n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * The request body __must__ include either:\n * + All of the following filters: `service`.`serviceId`, `fromLocalDate`, `toLocalDate`, `location`, and `timeZone`. You may add additional filters as you wish.\n * + A `cursorPaging` with a valid `cursor` from previous response.\n *\n *\n * Each [TimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/availability-time-slots/time-slot-object) in response\n * represents the availability of the given sequence of services in a specific order, location, and within a given range of time.\n *\n * Each `TimeSlot`.`NestedTimeSlot` represents a single service from the given list. The order of the `NestedTimeSlots` is the same as the order\n * of the given services in request.\n * The first `NestedTimeSlot` has `localStartDate` within the given `fromLocalDate` and `toLocalDate` exclusive,\n * and each following `NestedTimeSlot` has a `localStartDate` that equals to the previous `NestedTimeSlot`'s `localEndDate`.\n *\n * By default,\n * the response contains at most 1000 results.\n * If there are more than 1000 results, we return a `cursorPagingMetadata` with\n * a cursor for the next page of results, regardless of whether a `cursorPaging`\n * was provided in request.\n *\n * > __Notes:__\n * > + All nested time slots share the same location.\n * > + You can pass up to 8 services in request.\n *\n * ### AvailableResources in response:\n * The `TimeSlot`.`NestedTimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service\n * within the `NestedTimeSlot` range of time. Each `AvailableResources` contains information about available resources of the same type.\n *\n *
      \n *

      Important:
      \n * By default,\n * if you don't specify service.includeResourceTypeIds\n * or service.resourceIds filters in request,\n * we return TimeSlots with NestedTimeSlots with an empty AvailableResources.\n *
      Note:
      Not specifying resources filters can be handy in case you want to avoid large response in flows that only\n * interested of whether the time slots are available. [Finding the next available slot within the next 3 months](https://bo.wix.com/wix-docs/rest/all-apis/service-availability/multi-service-availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_multi-service-availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-all-selected-services-are-available-for)\n * is an example for such flow.\n *

      \n *
      \n *\n *\n * If you wish to get a list of available resources for a `TimeSlot`.`NestedTimeSlot` you should either:\n * + provide `service`.`resourceIds` in request.\n * + provide `service`.`includeResourceTypeIds` in request.\n *\n * __Notes:__\n * + In both cases the returned `TimeSlot`.`NestedTimeSlot` contains __up__ to 10 `AvailableResources` that match the provided filters. Each `AvailableResources` contains __up__ to 10 available `resources` of the same type that match the provided filters.\n * + If an `AvailableResources` has more available resources which are not listed within it, we return `AvailableResources`.`hasMoreAvailableResources` as true.\n * + If you wish to get the full available resources list for all `NestedTimeSlot` of a specific `TimeSlot`, you should call [GetMultiServiceAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/get-multi-service-availability-time-slot).\n *\n *\n * ### Availability VS Bookability\n * An `available` time slot is not necessarily `bookable`.\n * The `bookable` field of a `TimeSlot` indicates whether the customer can book all of the of the services within the given time slot,\n * at a specific period of time.\n * Read more about [Availability VS Bookability](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/introduction#all-apis_wix-service-availability_multi-service-availability-time-slots_introduction_availability-vs-bookability).\n *\n * By default,\n * + The response does not contains `unavailable` TimeSlots.For example, if there are no available resources to provide one of the services from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`, we don't return TimeSlots with `NestedTimeSlot`.`localStartDate` within this range for this service.\n * + The response contains both `bookable` and `un-bookable` TimeSlots.For example, if one of the services has a booking policy which enforces booking the service up to 10 minutes before the session starts, we return TimeSlots with the violating `NestedTimeSlot`.`localStartDate`, with `bookable` as `false`. If you want to list only __bookable__ TimeSlots you should pass `bookable` as `true`.\n * + If booking one of the `NestedTimeSlot`s violates one of the corresponding service's booking policies, the `TimeSlot` returns with `bookable` as false. There is no indication which service's policy was violated.\n *\n *
      \n *

      Important:\n * Because of DST, there are edge cases where certain times either do not exist or exist twice for a local time zone.\n * Read more about DST Handling

      \n *
      \n *\n * ### ListAvailabilityTimeSlots runs with the following defaults:\n * + `localStartDate` is sorted in `ASC` order.\n * + `cursorPaging`.`limit` is `1000`.\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.AVAILABILITY_READ_MULTI_SERVICE_TIME_SLOTS\n */\n function listMultiServiceAvailabilityTimeSlots(options?: ListMultiServiceAvailabilityTimeSlotsOptions): Promise;\n interface ListMultiServiceAvailabilityTimeSlotsOptions {\n /**\n * Services for which the multiService time slots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: `2`.\n * MaxSize: `8`.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n services?: Service$2[];\n /**\n * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n fromLocalDate?: string | null;\n /**\n * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n *\n * Each returned `TimeSlot` in response has a `localStartDate`\n * within the provided `fromLocalDate` and `toLocalDate` exclusive.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n toLocalDate?: string | null;\n /**\n * Time zone, in IANA time zone format.\n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n timeZone?: string | null;\n /**\n * Location for which the multiService TimeSlots are being returned for.\n *\n * You can specify location or location type for which the TimeSlots will be returned for.\n * If locationType is `BUSINESS`, you __must__ provide a locationId.\n *\n *
      \n *

      warning:
      \n * Supports filtering by location type, or by location ID.
      \n * Other fields like name are ignored.

      \n *
      \n *\n * Required, unless `cursorPaging`.`cursor` is provided.\n */\n location?: Location$7;\n /**\n * Whether the `TimeSlot` is bookable according to all of the services booking policies.\n *\n * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,\n * returns as `false`. Otherwise, returns as `true`.\n *\n * > __Note:__\n * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,\n * > while a `TimeSlot` with no available resources will not be returned at all.\n */\n bookable?: boolean | null;\n /**\n * Indicators for service's booking policy violations for booking the `TimeSlot`.\n *\n * A bookable time slot must not violate any policy,\n * therefor, this filter is only relevant when `bookable` filter is false.\n *\n * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s\n * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether\n * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.\n *\n * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined\n * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.\n */\n bookingPolicyViolations?: BookingPolicyViolations$1;\n /**\n * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,\n * we return at most 3 available TimeSlots for each day within the date range specified in request.\n *\n * By default,\n * if `bookable` filter was not specified,\n * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.\n *\n * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,\n * `un-bookable` slots will be returned according to the specified filters.\n */\n timeSlotsPerDay?: number | null;\n /**\n * CursorPaging.\n *\n * Enables you to fetch TimeSlots in smaller, more manageable chunks\n * by setting a limit on the number of results returned in response.\n * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.\n *\n * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`\n * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the\n * returned cursor to the next call as `cursorPaging`.`cursor`.\n *\n * For the first call, you should only specify the `limit` for the results page.\n * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`\n * the `cursorPaging`.`limit`. You may pass a different `limit`.\n * No need to specify any additional parameters.\n *\n *
      \n *

      Important:
      \n * If you only provide a cursorPaging. cursor,\n * the response will contain the default size of results which is `1000`.\n *

      \n *
      \n */\n cursorPaging?: CommonCursorPaging;\n }\n /**\n * Retrieves an available multiService `TimeSlot` that match the provided filters.\n *\n * Throws `SlotNotFound` if there is no such available time slot.\n *\n *
      \n *

      Important:
      \n * Currently supported only for services of type APPOINTMENT.

      \n *
      \n *\n * By default,\n * if you don't provide a `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,\n * we return for each `TimeSlot`.`NestedTimeSlot` all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide\n * the corresponding service within the time slot.\n *\n * If you specify `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,\n * the returned `TimeSlot`.`NestedTimeSlot` for this service will contain only `AvailableResources` with at least one available resource\n * which match the given resources filters,\n * each contains all available resources out of those requested.\n *\n * + Notes:\n * + All nested time slots share the same location.\n * + You can pass up to 8 services.\n *\n *
      \n *

      Tip:
      \n * Use this API in order to get the availability of a specific TimeSlot out of those returned from ListMultiServiceAvailabilityTimeSlots API.

      \n *
      \n * @param services - Services for which the multiService TimeSlots are being returned for.\n * Each service contains its own resources filters within.\n *\n * MinSize: 2.\n * MaxSize: 8.\n * @param localStartDate - Local start date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T13:30:00\".\n * @param localEndDate - Local end date of the time slot, in ISO-8601 format.\n * For example, \"2024-01-30T14:30:00\".\n * @param timeZone - Time zone, in IANA time zone format.\n * @param location - The location of the time slot.\n *\n * You must provide a specific `locationType`.\n * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.\n *\n *
      \n *

      Supports filtering by location type, or by location ID.\n * Other fields like name are ignored.

      \n *
      \n * @public\n * @documentationMaturity preview\n * @requiredField localEndDate\n * @requiredField localStartDate\n * @requiredField location\n * @requiredField location.locationType\n * @requiredField services\n * @requiredField services.serviceId\n * @requiredField timeZone\n * @permissionId BOOKINGS.AVAILABILITY_READ_MULTI_SERVICE_TIME_SLOTS\n */\n function getMultiServiceAvailabilityTimeSlot(services: Service$2[], localStartDate: string, localEndDate: string, timeZone: string | null, location: Location$7): Promise;\n \n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_TimeSlot = TimeSlot;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_EventInfo = EventInfo;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_NestedTimeSlot = NestedTimeSlot;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CalculateEventBasedAvailabilityRequest = CalculateEventBasedAvailabilityRequest;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CalculateEventBasedAvailabilityResponse = CalculateEventBasedAvailabilityResponse;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListEventTimeSlotsRequest = ListEventTimeSlotsRequest;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListEventTimeSlotsResponse = ListEventTimeSlotsResponse;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListMultiServiceAvailabilityTimeSlotsRequest = ListMultiServiceAvailabilityTimeSlotsRequest;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CommonCursorPaging = CommonCursorPaging;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListMultiServiceAvailabilityTimeSlotsResponse = ListMultiServiceAvailabilityTimeSlotsResponse;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CommonCursorPagingMetadata = CommonCursorPagingMetadata;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CommonCursors = CommonCursors;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetMultiServiceAvailabilityTimeSlotRequest = GetMultiServiceAvailabilityTimeSlotRequest;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetMultiServiceAvailabilityTimeSlotResponse = GetMultiServiceAvailabilityTimeSlotResponse;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListAvailabilityTimeSlotsRequest = ListAvailabilityTimeSlotsRequest;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CustomerChoices = CustomerChoices;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListAvailabilityTimeSlotsResponse = ListAvailabilityTimeSlotsResponse;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetAvailabilityTimeSlotRequest = GetAvailabilityTimeSlotRequest;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetAvailabilityTimeSlotResponse = GetAvailabilityTimeSlotResponse;\n const bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_listMultiServiceAvailabilityTimeSlots: typeof listMultiServiceAvailabilityTimeSlots;\n type bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListMultiServiceAvailabilityTimeSlotsOptions = ListMultiServiceAvailabilityTimeSlotsOptions;\n const bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_getMultiServiceAvailabilityTimeSlot: typeof getMultiServiceAvailabilityTimeSlot;\n namespace bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d {\n export {\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_TimeSlot as TimeSlot,\n Location$7 as Location,\n LocationType$7 as LocationType,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_EventInfo as EventInfo,\n WaitingList$1 as WaitingList,\n BookingPolicyViolations$1 as BookingPolicyViolations,\n AvailableResources$1 as AvailableResources,\n Resource$4 as Resource,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_NestedTimeSlot as NestedTimeSlot,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CalculateEventBasedAvailabilityRequest as CalculateEventBasedAvailabilityRequest,\n CursorPaging$a as CursorPaging,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CalculateEventBasedAvailabilityResponse as CalculateEventBasedAvailabilityResponse,\n CursorPagingMetadata$8 as CursorPagingMetadata,\n Cursors$b as Cursors,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListEventTimeSlotsRequest as ListEventTimeSlotsRequest,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListEventTimeSlotsResponse as ListEventTimeSlotsResponse,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListMultiServiceAvailabilityTimeSlotsRequest as ListMultiServiceAvailabilityTimeSlotsRequest,\n Service$2 as Service,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CommonCursorPaging as CommonCursorPaging,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListMultiServiceAvailabilityTimeSlotsResponse as ListMultiServiceAvailabilityTimeSlotsResponse,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CommonCursorPagingMetadata as CommonCursorPagingMetadata,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CommonCursors as CommonCursors,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetMultiServiceAvailabilityTimeSlotRequest as GetMultiServiceAvailabilityTimeSlotRequest,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetMultiServiceAvailabilityTimeSlotResponse as GetMultiServiceAvailabilityTimeSlotResponse,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListAvailabilityTimeSlotsRequest as ListAvailabilityTimeSlotsRequest,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_CustomerChoices as CustomerChoices,\n ResourceType$2 as ResourceType,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListAvailabilityTimeSlotsResponse as ListAvailabilityTimeSlotsResponse,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetAvailabilityTimeSlotRequest as GetAvailabilityTimeSlotRequest,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_GetAvailabilityTimeSlotResponse as GetAvailabilityTimeSlotResponse,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_listMultiServiceAvailabilityTimeSlots as listMultiServiceAvailabilityTimeSlots,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_ListMultiServiceAvailabilityTimeSlotsOptions as ListMultiServiceAvailabilityTimeSlotsOptions,\n bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d_getMultiServiceAvailabilityTimeSlot as getMultiServiceAvailabilityTimeSlot,\n };\n }\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()` or `connectByOAuth()` 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 * ID of the calendar provider.\n * Deprecated. Please use `id` instead.\n * @internal\n * @deprecated\n */\n appDefId?: string | null;\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()` function.\n * For providers supporting `CREDENTIALS`, connect with the `connectByCredentials()` 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()` 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()` 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()` 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 * Deprecated. Use `errorReason` instead.\n * @internal\n * @deprecated\n */\n syncToErrorReason?: SyncToErrorReason;\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()` 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 * Whether to append the participant name to the event summary, for sessions having a single participant. E.g 1:1 Booking Sessions.\n * Default is false.\n * Note: DRAFT/PROPOSAL. Not implemented and aimed to replace `session.external_calendar_overrides`.\n * @internal\n */\n appendSingleParticipantNameToEventSummary?: 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()` 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 * Deprecated.\n * @internal\n * @deprecated\n */\n calendarType?: CalendarType$3;\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()` 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 * Optional list of fields to update. If provided, only the specified fields are updated.\n * @internal\n */\n fieldMask?: string[];\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$9;\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 * Deprecated.\n * @internal\n * @deprecated\n */\n includePi?: boolean | null;\n }\n interface CursorPaging$9 {\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$7;\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 * @internal\n * @deprecated\n */\n paging?: CursorPagingMetadata$7;\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$7 {\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 }\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 /** @deprecated */\n intervalSplit?: IntervalSplit$3;\n recurringSessionSplit?: RecurringSessionSplit$3;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$3;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated$3;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent$3;\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$3;\n instanceId?: string;\n /**\n * true when the schedule belongs to a site that is rolled out to calendar v3\n * @internal\n */\n rolledOut?: boolean | null;\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 /** @deprecated */\n intervalSplit?: IntervalSplit$3;\n recurringSessionSplit?: RecurringSessionSplit$3;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$3;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated$3;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent$3;\n }\n interface ScheduleCreated$3 {\n schedule?: Schedule$4;\n }\n interface Schedule$4 {\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 * Start time of the first session in the schedule.\n * @internal\n * @readonly\n */\n firstSessionStart?: Date | null;\n /**\n * End time of the last session in the schedule.\n * @internal\n * @readonly\n */\n lastSessionEnd?: Date | 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$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 * @deprecated\n */\n tags?: string[] | null;\n /** Default location for the schedule's sessions. */\n location?: Location$6;\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$3;\n /**\n * __Deprecated.__\n * @deprecated\n */\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 /**\n * __Deprecated.__\n * @deprecated\n */\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 | null;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date | null;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * The schedule version, updated each time the schedule or the schedule participants are updated.\n * @internal\n * @readonly\n */\n versions?: Version$3;\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$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 * @deprecated\n */\n calendarConference?: CalendarConference$3;\n /**\n * The name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * Currently, in Bookings system, it would be present when the schedule is owned by a staff resource and the resource is connected to a user.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 | null;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date | null;\n /** The interval rules. The day, hour and minutes the interval is recurring. */\n interval?: Interval$4;\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 /** The type of recurring interval. */\n intervalType?: RecurringIntervalType$3;\n }\n interface Interval$4 {\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 * 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$3;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n /**\n * The name of the linked schedule owner. It may be a resource name or a service name. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the linked schedule owner. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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$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 /**\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$7;\n /**\n * The Wix Business location formatted address.\n * Valid when `locationType` is `OWNER_BUSINESS`. Defaults to the business's location.\n * To retrieve the full location data please use the [Locations API](https://dev.wix.com/api/rest/business-info/locations).\n * @internal\n */\n businessLocation?: LocationsLocation$3;\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$7 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 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 * @deprecated\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$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://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$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$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 * Default service price. Always available when a service has\n * [variants](https://support.wix.com/en/article/about-service-categories-in-wix-bookings).\n * Sometimes also available for services without variants.\n * @internal\n */\n defaultVariedPrice?: Price$4;\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 /**\n * \n */\n interface Availability$3 {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date | null;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date | null;\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 * Not supported yet.\n * A list of possible locations for the session when `use_default_location` is set to `false`. Slots are generated for each location. Only one of the possible locations can be chosen by the customer.\n *\n * **NOTE**: When using the `locations` parameter, the default location is not automatically included in the list.\n * @internal\n */\n locations?: Location$6[];\n /**\n * Not supported yet.\n * Whether the schedule's slots are only available at the schedule's default location, as set in `schedule.location`. If set to `false`, the `locations` array is used to set the possible locations of the schedule's sessions.\n * Default is `true`.\n * @internal\n */\n useDefaultLocation?: boolean | null;\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 * @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$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 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 /**\n * A generated id for the conference entity - Base62($providerId$accountOwnerId$conferenceId)\n * @internal\n */\n conferenceId?: string | null;\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$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$4;\n /** The new schedule after the update. */\n newSchedule?: Schedule$4;\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$7;\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 | null;\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 * @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$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 /**\n * The remaining number of participants that can be added to the session. Read-only.\n * Can be negative, in case the session is over capacity.\n * @internal\n * @readonly\n */\n remainingCapacity?: 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$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 /**\n * Information about the external calendar, if the session originated in an external calendar.\n * @internal\n * @readonly\n */\n externalCalendarInfo?: ExternalCalendarInfo$3;\n /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides$3;\n /**\n * Session status.\n * @readonly\n */\n status?: SessionStatus$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$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 * @deprecated\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 name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * NOT IMPLEMENTED YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: 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 * The ID of the event in the new Calendar Events V3 API.\n * @internal\n * @readonly\n */\n eventId?: string | null;\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 | null;\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$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$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 /**\n * Schedule version number, updated each time the schedule is updated.\n * @internal\n */\n scheduleVersion?: number;\n /**\n * Session version number, updated each time the session is updated.\n * @internal\n */\n sessionVersion?: number;\n /**\n * Participants version number, updated each time the session participants are updated.\n * @internal\n */\n participantsVersion?: number | null;\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$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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\n }\n interface ScheduleCancelled$3 {\n schedule?: Schedule$4;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$7;\n oldSchedule?: Schedule$4;\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$7;\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$7;\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$4;\n }\n interface MultipleSessionsCreated$3 {\n schedulesWithSessions?: ScheduleWithSessions$3[];\n }\n interface ScheduleWithSessions$3 {\n schedule?: Schedule$4;\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$6 {\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()` or `connectByOAuth()` to establish a connection.\n *\n * @public\n * @documentationMaturity preview\n * @permissionId CALENDAR.LIST_EXTERNAL_CALENDAR_PROVIDERS\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 * @permissionId CALENDAR.READ_OWN_EXTERNAL_CALENDAR_CONNECTIONS\n * @permissionId CALENDAR.READ_ALL_EXTERNAL_CALENDAR_CONNECTIONS\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 * @permissionId CALENDAR.READ_OWN_EXTERNAL_CALENDAR_CONNECTIONS\n * @permissionId CALENDAR.READ_ALL_EXTERNAL_CALENDAR_CONNECTIONS\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()` to obtain an up-to-date list of events in the connected external calendars.\n *\n * > **Note:**\n * > Use `listProviders()` to find out whether to connect to a particular provider using this endpoint or `connectByCredentials()`.\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()` function.\n * @permissionId CALENDAR.MANAGE_OWN_EXTERNAL_CALENDAR_CONNECTIONS\n * @permissionId CALENDAR.MANAGE_ALL_EXTERNAL_CALENDAR_CONNECTIONS\n * @adminMethod\n */\n function connectByOAuth(providerId: string | null, scheduleId: string | null, redirectUrl: string | null, options?: ConnectByOAuthOptions): Promise;\n interface ConnectByOAuthOptions {\n /**\n * Deprecated.\n * @internal\n * @deprecated\n */\n calendarType?: CalendarType$3;\n }\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function oAuthCompleted(options?: OAuthCompletedOptions): Promise;\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()` to obtain an up-to-date list of events in the connected external calendars.\n *\n * > **Note:**\n * > Use `listProviders()` to find out whether to connect to a particular provider using this method or `connectByOAuth()`.\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()` function.\n * @permissionId CALENDAR.MANAGE_OWN_EXTERNAL_CALENDAR_CONNECTIONS\n * @permissionId CALENDAR.MANAGE_ALL_EXTERNAL_CALENDAR_CONNECTIONS\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()` or `connectByOAuth()`.\n * @param connectionId - ID of the external calendar connection to list calendars for.\n * @public\n * @documentationMaturity preview\n * @requiredField connectionId\n * @permissionId CALENDAR.READ_OWN_EXTERNAL_CALENDAR_CONNECTIONS\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()` 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()` or `listConnections()` and see the `syncConfig` property.\n *\n * > **Note:**\n * > Supported functionality depends on the provider. Use `listProviders()` 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 * @permissionId CALENDAR.MANAGE_OWN_EXTERNAL_CALENDAR_CONNECTIONS\n * @adminMethod\n */\n function updateSyncConfig(connectionId: string | null, syncConfig: ConnectionSyncConfig, options?: UpdateSyncConfigOptions): Promise;\n interface UpdateSyncConfigOptions {\n /**\n * Optional list of fields to update. If provided, only the specified fields are updated.\n * @internal\n */\n fieldMask?: string[];\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()` 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 * @permissionId CALENDAR.MANAGE_OWN_EXTERNAL_CALENDAR_CONNECTIONS\n * @permissionId CALENDAR.MANAGE_ALL_EXTERNAL_CALENDAR_CONNECTIONS\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()` or `connectByOAuth()`.\n * @public\n * @documentationMaturity preview\n * @permissionId CALENDAR.READ_EXTERNAL_CALENDAR_EVENTS\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$9;\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 * Deprecated.\n * @internal\n * @deprecated\n */\n includePi?: boolean | null;\n }\n \n type bookingsCalendarV2ExternalCalendar_universal_d_ExternalCalendar = ExternalCalendar;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListProvidersRequest = ListProvidersRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListProvidersResponse = ListProvidersResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_Provider = Provider;\n type bookingsCalendarV2ExternalCalendar_universal_d_ProviderFeatures = ProviderFeatures;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectMethod = ConnectMethod;\n const bookingsCalendarV2ExternalCalendar_universal_d_ConnectMethod: typeof ConnectMethod;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListEventFromCalendars = ListEventFromCalendars;\n const bookingsCalendarV2ExternalCalendar_universal_d_ListEventFromCalendars: typeof ListEventFromCalendars;\n type bookingsCalendarV2ExternalCalendar_universal_d_SyncToCalendar = SyncToCalendar;\n const bookingsCalendarV2ExternalCalendar_universal_d_SyncToCalendar: typeof SyncToCalendar;\n type bookingsCalendarV2ExternalCalendar_universal_d_GetConnectionRequest = GetConnectionRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_GetConnectionResponse = GetConnectionResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_Connection = Connection;\n type bookingsCalendarV2ExternalCalendar_universal_d_ErrorReason = ErrorReason;\n const bookingsCalendarV2ExternalCalendar_universal_d_ErrorReason: typeof ErrorReason;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfig = ConnectionSyncConfig;\n type bookingsCalendarV2ExternalCalendar_universal_d_Calendar = Calendar;\n type bookingsCalendarV2ExternalCalendar_universal_d_PrimaryCalendar = PrimaryCalendar;\n type bookingsCalendarV2ExternalCalendar_universal_d_Calendars = Calendars;\n type bookingsCalendarV2ExternalCalendar_universal_d_DedicatedCalendar = DedicatedCalendar;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigListEventFromCalendars = ConnectionSyncConfigListEventFromCalendars;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigListEventFromCalendarsListFromOneOf = ConnectionSyncConfigListEventFromCalendarsListFromOneOf;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigSyncToCalendar = ConnectionSyncConfigSyncToCalendar;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigSyncToCalendarSyncToOneOf = ConnectionSyncConfigSyncToCalendarSyncToOneOf;\n type bookingsCalendarV2ExternalCalendar_universal_d_SyncToErrorReason = SyncToErrorReason;\n const bookingsCalendarV2ExternalCalendar_universal_d_SyncToErrorReason: typeof SyncToErrorReason;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListConnectionsRequest = ListConnectionsRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListConnectionsResponse = ListConnectionsResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectByOAuthRequest = ConnectByOAuthRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectByOAuthResponse = ConnectByOAuthResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_RawHttpRequest = RawHttpRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_PathParametersEntry = PathParametersEntry;\n type bookingsCalendarV2ExternalCalendar_universal_d_QueryParametersEntry = QueryParametersEntry;\n type bookingsCalendarV2ExternalCalendar_universal_d_HeadersEntry = HeadersEntry;\n type bookingsCalendarV2ExternalCalendar_universal_d_RawHttpResponse = RawHttpResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectByCredentialsRequest = ConnectByCredentialsRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectByCredentialsResponse = ConnectByCredentialsResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListCalendarsRequest = ListCalendarsRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListCalendarsResponse = ListCalendarsResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_UpdateSyncConfigRequest = UpdateSyncConfigRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_UpdateSyncConfigResponse = UpdateSyncConfigResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_DisconnectRequest = DisconnectRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_DisconnectResponse = DisconnectResponse;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListEventsRequest = ListEventsRequest;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListEventsResponse = ListEventsResponse;\n const bookingsCalendarV2ExternalCalendar_universal_d_listProviders: typeof listProviders;\n const bookingsCalendarV2ExternalCalendar_universal_d_getConnection: typeof getConnection;\n const bookingsCalendarV2ExternalCalendar_universal_d_listConnections: typeof listConnections;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListConnectionsOptions = ListConnectionsOptions;\n const bookingsCalendarV2ExternalCalendar_universal_d_connectByOAuth: typeof connectByOAuth;\n type bookingsCalendarV2ExternalCalendar_universal_d_ConnectByOAuthOptions = ConnectByOAuthOptions;\n const bookingsCalendarV2ExternalCalendar_universal_d_oAuthCompleted: typeof oAuthCompleted;\n type bookingsCalendarV2ExternalCalendar_universal_d_OAuthCompletedOptions = OAuthCompletedOptions;\n const bookingsCalendarV2ExternalCalendar_universal_d_connectByCredentials: typeof connectByCredentials;\n const bookingsCalendarV2ExternalCalendar_universal_d_listCalendars: typeof listCalendars;\n const bookingsCalendarV2ExternalCalendar_universal_d_updateSyncConfig: typeof updateSyncConfig;\n type bookingsCalendarV2ExternalCalendar_universal_d_UpdateSyncConfigOptions = UpdateSyncConfigOptions;\n const bookingsCalendarV2ExternalCalendar_universal_d_disconnect: typeof disconnect;\n const bookingsCalendarV2ExternalCalendar_universal_d_listEvents: typeof listEvents;\n type bookingsCalendarV2ExternalCalendar_universal_d_ListEventsOptions = ListEventsOptions;\n namespace bookingsCalendarV2ExternalCalendar_universal_d {\n export {\n bookingsCalendarV2ExternalCalendar_universal_d_ExternalCalendar as ExternalCalendar,\n bookingsCalendarV2ExternalCalendar_universal_d_ListProvidersRequest as ListProvidersRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_ListProvidersResponse as ListProvidersResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_Provider as Provider,\n CalendarType$3 as CalendarType,\n bookingsCalendarV2ExternalCalendar_universal_d_ProviderFeatures as ProviderFeatures,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectMethod as ConnectMethod,\n bookingsCalendarV2ExternalCalendar_universal_d_ListEventFromCalendars as ListEventFromCalendars,\n bookingsCalendarV2ExternalCalendar_universal_d_SyncToCalendar as SyncToCalendar,\n bookingsCalendarV2ExternalCalendar_universal_d_GetConnectionRequest as GetConnectionRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_GetConnectionResponse as GetConnectionResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_Connection as Connection,\n Status$3 as Status,\n bookingsCalendarV2ExternalCalendar_universal_d_ErrorReason as ErrorReason,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfig as ConnectionSyncConfig,\n bookingsCalendarV2ExternalCalendar_universal_d_Calendar as Calendar,\n bookingsCalendarV2ExternalCalendar_universal_d_PrimaryCalendar as PrimaryCalendar,\n bookingsCalendarV2ExternalCalendar_universal_d_Calendars as Calendars,\n bookingsCalendarV2ExternalCalendar_universal_d_DedicatedCalendar as DedicatedCalendar,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigListEventFromCalendars as ConnectionSyncConfigListEventFromCalendars,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigListEventFromCalendarsListFromOneOf as ConnectionSyncConfigListEventFromCalendarsListFromOneOf,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigSyncToCalendar as ConnectionSyncConfigSyncToCalendar,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectionSyncConfigSyncToCalendarSyncToOneOf as ConnectionSyncConfigSyncToCalendarSyncToOneOf,\n bookingsCalendarV2ExternalCalendar_universal_d_SyncToErrorReason as SyncToErrorReason,\n bookingsCalendarV2ExternalCalendar_universal_d_ListConnectionsRequest as ListConnectionsRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_ListConnectionsResponse as ListConnectionsResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectByOAuthRequest as ConnectByOAuthRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectByOAuthResponse as ConnectByOAuthResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_RawHttpRequest as RawHttpRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_PathParametersEntry as PathParametersEntry,\n bookingsCalendarV2ExternalCalendar_universal_d_QueryParametersEntry as QueryParametersEntry,\n bookingsCalendarV2ExternalCalendar_universal_d_HeadersEntry as HeadersEntry,\n bookingsCalendarV2ExternalCalendar_universal_d_RawHttpResponse as RawHttpResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectByCredentialsRequest as ConnectByCredentialsRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectByCredentialsResponse as ConnectByCredentialsResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_ListCalendarsRequest as ListCalendarsRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_ListCalendarsResponse as ListCalendarsResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_UpdateSyncConfigRequest as UpdateSyncConfigRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_UpdateSyncConfigResponse as UpdateSyncConfigResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_DisconnectRequest as DisconnectRequest,\n bookingsCalendarV2ExternalCalendar_universal_d_DisconnectResponse as DisconnectResponse,\n bookingsCalendarV2ExternalCalendar_universal_d_ListEventsRequest as ListEventsRequest,\n CursorPaging$9 as CursorPaging,\n bookingsCalendarV2ExternalCalendar_universal_d_ListEventsResponse as ListEventsResponse,\n Event$2 as Event,\n CursorPagingMetadata$7 as CursorPagingMetadata,\n Cursors$a as Cursors,\n ScheduleNotification$3 as ScheduleNotification,\n ScheduleNotificationEventOneOf$3 as ScheduleNotificationEventOneOf,\n ScheduleCreated$3 as ScheduleCreated,\n Schedule$4 as Schedule,\n RecurringInterval$3 as RecurringInterval,\n Interval$4 as Interval,\n Day$3 as Day,\n Frequency$3 as Frequency,\n LinkedSchedule$3 as LinkedSchedule,\n Transparency$3 as Transparency,\n RecurringIntervalType$3 as RecurringIntervalType,\n Location$6 as Location,\n LocationType$6 as LocationType,\n Address$7 as Address,\n AddressStreetOneOf$6 as AddressStreetOneOf,\n StreetAddress$6 as StreetAddress,\n AddressLocation$6 as AddressLocation,\n Subdivision$6 as Subdivision,\n LocationsLocation$3 as LocationsLocation,\n LocationStatus$3 as LocationStatus,\n LocationsLocationType$3 as LocationsLocationType,\n LocationsAddress$3 as LocationsAddress,\n LocationsStreetAddress$3 as LocationsStreetAddress,\n LocationsAddressLocation$3 as LocationsAddressLocation,\n BusinessSchedule$4 as BusinessSchedule,\n TimePeriod$4 as TimePeriod,\n DayOfWeek$4 as DayOfWeek,\n SpecialHourPeriod$4 as SpecialHourPeriod,\n Rate$3 as Rate,\n Price$4 as Price,\n Availability$3 as Availability,\n AvailabilityConstraints$3 as AvailabilityConstraints,\n SplitInterval$3 as SplitInterval,\n Participant$3 as Participant,\n ApprovalStatus$3 as ApprovalStatus,\n ExternalCalendarOverrides$3 as ExternalCalendarOverrides,\n ScheduleStatus$3 as ScheduleStatus,\n Version$3 as Version,\n ConferenceProvider$3 as ConferenceProvider,\n CalendarConference$3 as CalendarConference,\n ConferenceType$3 as ConferenceType,\n ScheduleUpdated$3 as ScheduleUpdated,\n RecurringSessionsUpdated$3 as RecurringSessionsUpdated,\n Session$3 as Session,\n CalendarDateTime$3 as CalendarDateTime,\n LocalDateTime$3 as LocalDateTime,\n ExternalCalendarInfo$3 as ExternalCalendarInfo,\n SessionStatus$1 as SessionStatus,\n SessionType$3 as SessionType,\n SessionVersion$3 as SessionVersion,\n ParticipantNotification$7 as ParticipantNotification,\n ScheduleCancelled$3 as ScheduleCancelled,\n SessionCreated$3 as SessionCreated,\n SessionUpdated$3 as SessionUpdated,\n SessionCancelled$3 as SessionCancelled,\n AvailabilityPolicyUpdated$3 as AvailabilityPolicyUpdated,\n AvailabilityPolicy$3 as AvailabilityPolicy,\n IntervalSplit$3 as IntervalSplit,\n RecurringSessionSplit$3 as RecurringSessionSplit,\n ScheduleUnassignedFromUser$3 as ScheduleUnassignedFromUser,\n MultipleSessionsCreated$3 as MultipleSessionsCreated,\n ScheduleWithSessions$3 as ScheduleWithSessions,\n SitePropertiesOnScheduleCreation$3 as SitePropertiesOnScheduleCreation,\n MigrationEvent$3 as MigrationEvent,\n MigrationData$3 as MigrationData,\n StaffData$3 as StaffData,\n Empty$6 as Empty,\n bookingsCalendarV2ExternalCalendar_universal_d_listProviders as listProviders,\n bookingsCalendarV2ExternalCalendar_universal_d_getConnection as getConnection,\n bookingsCalendarV2ExternalCalendar_universal_d_listConnections as listConnections,\n bookingsCalendarV2ExternalCalendar_universal_d_ListConnectionsOptions as ListConnectionsOptions,\n bookingsCalendarV2ExternalCalendar_universal_d_connectByOAuth as connectByOAuth,\n bookingsCalendarV2ExternalCalendar_universal_d_ConnectByOAuthOptions as ConnectByOAuthOptions,\n bookingsCalendarV2ExternalCalendar_universal_d_oAuthCompleted as oAuthCompleted,\n bookingsCalendarV2ExternalCalendar_universal_d_OAuthCompletedOptions as OAuthCompletedOptions,\n bookingsCalendarV2ExternalCalendar_universal_d_connectByCredentials as connectByCredentials,\n bookingsCalendarV2ExternalCalendar_universal_d_listCalendars as listCalendars,\n bookingsCalendarV2ExternalCalendar_universal_d_updateSyncConfig as updateSyncConfig,\n bookingsCalendarV2ExternalCalendar_universal_d_UpdateSyncConfigOptions as UpdateSyncConfigOptions,\n bookingsCalendarV2ExternalCalendar_universal_d_disconnect as disconnect,\n bookingsCalendarV2ExternalCalendar_universal_d_listEvents as listEvents,\n bookingsCalendarV2ExternalCalendar_universal_d_ListEventsOptions as ListEventsOptions,\n };\n }\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$3;\n /**\n * Price of the most expensive service variant.\n * @readonly\n */\n maxPrice?: Money$3;\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 /** Extensions enabling users to save custom data related to service options and variants. */\n extendedFields?: ExtendedFields$8;\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 * ID of the service variant.\n * Used by multilingual translations.\n * @internal\n */\n _id?: string | null;\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$3[];\n /** Information about the service variant's price. */\n price?: Money$3;\n }\n interface ServiceChoice$3 extends ServiceChoiceChoiceOneOf$3 {\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 /**\n * ID of the service choice.\n * Used by multilingual translations.\n * @internal\n */\n _id?: string | null;\n /** ID of the service option. */\n optionId?: string;\n }\n /** @oneof */\n interface ServiceChoiceChoiceOneOf$3 {\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$3 {\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 ExtendedFields$8 {\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 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 * Field mask containing information about the fields to update.\n * @internal\n */\n mask?: string[];\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$4;\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$8;\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$8[];\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 * @internal\n */\n fields?: string[];\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 * @internal\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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$8 {\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$8 {\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$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$9;\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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$9 {\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$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$3;\n /** Event type. */\n event?: Event$1;\n }\n interface Resource$3 {\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$3[];\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$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 * @readonly\n */\n wixUserId?: string | null;\n /**\n * The ID of the Resource Group that this resource belongs to. This is an optional field as not every resource is part of a group.\n * @internal\n */\n groupId?: string | null;\n /**\n * This field determines how to resolve the working hours of this resource. Defaults to `true` if was not set by the client.\n * When set to `true` then working hours (including location information) can be found in the sessions of a schedule that is connected to this resource.\n * If `false`, then the working hours are not specified as sessions of a connected schedule. Instead this resource is then by definition full-time available (7 x 24).\n * @internal\n */\n hasWorkingHoursSchedule?: boolean | null;\n /**\n * True if the resource is available in all locations, false if the resource is available only in a specific business location. Empty if `has_working_hours_schedule` is true.\n * Information on the location(s) can then be found in the sessions of one of the connected schedules.\n * @internal\n */\n availableInAllLocations?: boolean | null;\n /**\n * Information about business location connected to the resource. Should be empty if `available_in_all_locations` is true or if no business location exists in OS.\n * @internal\n */\n businessLocation?: BusinessLocation$3;\n /**\n * This schedule contains the sessions in which this resource is booked.\n * Equals to the first element of `schedules` array.\n * @internal\n * @readonly\n */\n eventsSchedule?: Schedule$3;\n /**\n * The type of of the resource. Currently this field is only filled for staff and will contain the ID as configured in the\n * BOOKINGS_RESOURCE_TYPES component of the Bookings app.\n * @internal\n * @readonly\n */\n type?: string | null;\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 * Start time of the first session in the schedule.\n * @internal\n * @readonly\n */\n firstSessionStart?: Date | null;\n /**\n * End time of the last session in the schedule.\n * @internal\n * @readonly\n */\n lastSessionEnd?: Date | 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$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 * @deprecated\n */\n tags?: string[] | null;\n /** Default location for the schedule's sessions. */\n location?: Location$5;\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$2;\n /**\n * __Deprecated.__\n * @deprecated\n */\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 /**\n * __Deprecated.__\n * @deprecated\n */\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 | null;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date | null;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * The schedule version, updated each time the schedule or the schedule participants are updated.\n * @internal\n * @readonly\n */\n versions?: Version$2;\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$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 * @deprecated\n */\n calendarConference?: CalendarConference$2;\n /**\n * The name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * Currently, in Bookings system, it would be present when the schedule is owned by a staff resource and the resource is connected to a user.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 | null;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date | null;\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$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 /** The type of recurring interval. */\n intervalType?: RecurringIntervalType$2;\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$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 * 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$2;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n /**\n * The name of the linked schedule owner. It may be a resource name or a service name. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the linked schedule owner. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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$5 {\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$5;\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$6;\n /**\n * The Wix Business location formatted address.\n * Valid when `locationType` is `OWNER_BUSINESS`. Defaults to the business's location.\n * To retrieve the full location data please use the [Locations API](https://dev.wix.com/api/rest/business-info/locations).\n * @internal\n */\n businessLocation?: LocationsLocation$2;\n }\n enum LocationType$5 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface Address$6 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$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 * __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$2;\n /**\n * Location type.\n *\n * **Note:** Currently not supported.\n * @deprecated\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$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://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$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$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 * Default service price. Always vailable when a service has\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Sometimes also available for services without variants.\n * Ignored in [updates to a service](https://dev.wix.com/api/rest/wix-bookings/services/service/update-service),\n * when either `labeled_price_options` or `price_text` is also specified.\n * @internal\n */\n defaultVariedPrice?: Price$3;\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$2 {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date | null;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date | null;\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 * Not supported yet.\n * A list of possible locations for the session when `use_default_location` is set to `false`. Slots are generated for each location. Only one of the possible locations can be chosen by the customer.\n *\n * **NOTE**: When using the `locations` parameter, the default location is not automatically included in the list.\n * @internal\n */\n locations?: Location$5[];\n /**\n * Not supported yet.\n * Whether the schedule's slots are only available at the schedule's default location, as set in `schedule.location`. If set to `false`, the `locations` array is used to set the possible locations of the schedule's sessions.\n * Default is `true`.\n * @internal\n */\n useDefaultLocation?: boolean | null;\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 * @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$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 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 /**\n * A generated id for the conference entity - Base62($providerId$accountOwnerId$conferenceId)\n * @internal\n */\n conferenceId?: string | null;\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$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 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$3 {\n /** The ID of the business location. Has to be non-empty */\n locationId?: string;\n }\n enum Event$1 {\n UNDEFINED = \"UNDEFINED\",\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\",\n Schedule_Updated = \"Schedule_Updated\"\n }\n interface Empty$5 {\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$1;\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$1 {\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$3;\n /** Payment options available for use when booking the service. */\n paymentOptions?: PaymentOptions$1;\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$1;\n /** SEO data */\n seoData?: SeoSchema$1;\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$1;\n }\n interface Media$1 {\n /** Images associated with the service. */\n items?: MediaItem$2[];\n /** Primary image associated with the service. */\n mainMedia?: MediaItem$2;\n /** Cover image associated with the service. */\n coverMedia?: MediaItem$2;\n }\n interface MediaItem$2 extends MediaItemItemOneOf$1 {\n /** Image metadata. */\n image?: string;\n }\n /** @oneof */\n interface MediaItemItemOneOf$1 {\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$3 {\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$1 {\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$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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 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$6;\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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\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 /** @deprecated */\n intervalSplit?: IntervalSplit$2;\n recurringSessionSplit?: RecurringSessionSplit$2;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$2;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated$2;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent$2;\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$2;\n instanceId?: string;\n /**\n * true when the schedule belongs to a site that is rolled out to calendar v3\n * @internal\n */\n rolledOut?: boolean | null;\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 /** @deprecated */\n intervalSplit?: IntervalSplit$2;\n recurringSessionSplit?: RecurringSessionSplit$2;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser$2;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated$2;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent$2;\n }\n interface ScheduleCreated$2 {\n schedule?: Schedule$3;\n }\n interface ScheduleUpdated$2 {\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$2;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$6;\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 | null;\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 * @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$5;\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 * The remaining number of participants that can be added to the session. Read-only.\n * Can be negative, in case the session is over capacity.\n * @internal\n * @readonly\n */\n remainingCapacity?: 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$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 /**\n * Information about the external calendar, if the session originated in an external calendar.\n * @internal\n * @readonly\n */\n externalCalendarInfo?: ExternalCalendarInfo$2;\n /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides$2;\n /**\n * Session status.\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 * @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$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 * @deprecated\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 name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * NOT IMPLEMENTED YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: 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 * The ID of the event in the new Calendar Events V3 API.\n * @internal\n * @readonly\n */\n eventId?: string | null;\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 | null;\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 /**\n * Schedule version number, updated each time the schedule is updated.\n * @internal\n */\n scheduleVersion?: number;\n /**\n * Session version number, updated each time the session is updated.\n * @internal\n */\n sessionVersion?: number;\n /**\n * Participants version number, updated each time the session participants are updated.\n * @internal\n */\n participantsVersion?: number | null;\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$2 {\n schedule?: Schedule$3;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$6;\n oldSchedule?: Schedule$3;\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$6;\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$6;\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$3;\n }\n interface MultipleSessionsCreated$2 {\n schedulesWithSessions?: ScheduleWithSessions$2[];\n }\n interface ScheduleWithSessions$2 {\n schedule?: Schedule$3;\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 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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$9;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$9 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$9 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$9 {\n bodyAsJson?: string;\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 /**\n * Set of properties that were updated - corresponds to the fields in \"properties\".\n * @internal\n */\n fields?: string[];\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?: 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$3;\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 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$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 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$4;\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$4;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$2;\n }\n interface PropertiesChange$2 {\n }\n interface SiteCreated$4 {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned$2 {\n /** Origin site id. */\n originMetaSiteId?: 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$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$8;\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$8 {\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_CREATE\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_CREATE\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_UPDATE\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$3;\n /**\n * Price of the most expensive service variant.\n * @readonly\n */\n maxPrice?: Money$3;\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 /** Extensions enabling users to save custom data related to service options and variants. */\n extendedFields?: ExtendedFields$8;\n }\n interface UpdateServiceOptionsAndVariantsOptions {\n /**\n * Field mask containing information about the fields to update.\n * @internal\n */\n mask?: string[];\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_DELETE\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 * @permissionId BOOKINGS.SERVICE_OPTIONS_AND_VARIANTS_READ\n */\n function queryServiceOptionsAndVariants(): ServiceOptionsAndVariantsListQueryBuilder;\n interface QueryCursorResult$5 {\n cursors: Cursors$9;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ServiceOptionsAndVariantsListQueryResult extends QueryCursorResult$5 {\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 \n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariants = ServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOption = ServiceOption;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionOptionSpecificDataOneOf = ServiceOptionOptionSpecificDataOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionType = ServiceOptionType;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionType: typeof ServiceOptionType;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CustomServiceOption = CustomServiceOption;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceVariant = ServiceVariant;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptions = ServiceOptions;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceVariants = ServiceVariants;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsRequest = CreateServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsResponse = CreateServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsRequest = CloneServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsResponse = CloneServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsRequest = GetServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsResponse = GetServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdRequest = GetServiceOptionsAndVariantsByServiceIdRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdResponse = GetServiceOptionsAndVariantsByServiceIdResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsRequest = UpdateServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsResponse = UpdateServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsRequest = DeleteServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsResponse = DeleteServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsRequest = QueryServiceOptionsAndVariantsRequest;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsResponse = QueryServiceOptionsAndVariantsResponse;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotification = ServiceNotification;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotificationMetadataOneOf = ServiceNotificationMetadataOneOf;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceInfo = ServiceInfo;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_FutureBookingPolicy = FutureBookingPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_WaitingListPolicy = WaitingListPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_BookingsApprovalPolicy = BookingsApprovalPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceStatus = ServiceStatus;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceStatus: typeof ServiceStatus;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotificationEvent = ServiceNotificationEvent;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotificationEvent: typeof ServiceNotificationEvent;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_BusinessServicesPolicy = BusinessServicesPolicy;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteMetadata = DeleteMetadata;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_createServiceOptionsAndVariants: typeof createServiceOptionsAndVariants;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_cloneServiceOptionsAndVariants: typeof cloneServiceOptionsAndVariants;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariants: typeof getServiceOptionsAndVariants;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariantsByServiceId: typeof getServiceOptionsAndVariantsByServiceId;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_updateServiceOptionsAndVariants: typeof updateServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariants = UpdateServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsOptions = UpdateServiceOptionsAndVariantsOptions;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_deleteServiceOptionsAndVariants: typeof deleteServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsOptions = DeleteServiceOptionsAndVariantsOptions;\n const bookingsCatalogV1ServiceOptionsAndVariants_universal_d_queryServiceOptionsAndVariants: typeof queryServiceOptionsAndVariants;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryResult = ServiceOptionsAndVariantsListQueryResult;\n type bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryBuilder = ServiceOptionsAndVariantsListQueryBuilder;\n namespace bookingsCatalogV1ServiceOptionsAndVariants_universal_d {\n export {\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariants as ServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOption as ServiceOption,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionOptionSpecificDataOneOf as ServiceOptionOptionSpecificDataOneOf,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionType as ServiceOptionType,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CustomServiceOption as CustomServiceOption,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceVariant as ServiceVariant,\n ServiceChoice$3 as ServiceChoice,\n ServiceChoiceChoiceOneOf$3 as ServiceChoiceChoiceOneOf,\n Money$3 as Money,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptions as ServiceOptions,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceVariants as ServiceVariants,\n ExtendedFields$8 as ExtendedFields,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsRequest as CreateServiceOptionsAndVariantsRequest,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CreateServiceOptionsAndVariantsResponse as CreateServiceOptionsAndVariantsResponse,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsRequest as CloneServiceOptionsAndVariantsRequest,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_CloneServiceOptionsAndVariantsResponse as CloneServiceOptionsAndVariantsResponse,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsRequest as GetServiceOptionsAndVariantsRequest,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsResponse as GetServiceOptionsAndVariantsResponse,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdRequest as GetServiceOptionsAndVariantsByServiceIdRequest,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_GetServiceOptionsAndVariantsByServiceIdResponse as GetServiceOptionsAndVariantsByServiceIdResponse,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsRequest as UpdateServiceOptionsAndVariantsRequest,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsResponse as UpdateServiceOptionsAndVariantsResponse,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsRequest as DeleteServiceOptionsAndVariantsRequest,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsResponse as DeleteServiceOptionsAndVariantsResponse,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsRequest as QueryServiceOptionsAndVariantsRequest,\n QueryV2$4 as QueryV2,\n QueryV2PagingMethodOneOf$4 as QueryV2PagingMethodOneOf,\n Sorting$8 as Sorting,\n SortOrder$8 as SortOrder,\n Paging$4 as Paging,\n CursorPaging$8 as CursorPaging,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_QueryServiceOptionsAndVariantsResponse as QueryServiceOptionsAndVariantsResponse,\n PagingMetadataV2$3 as PagingMetadataV2,\n Cursors$9 as Cursors,\n ResourceNotification$1 as ResourceNotification,\n Resource$3 as Resource,\n Schedule$3 as Schedule,\n RecurringInterval$2 as RecurringInterval,\n Interval$3 as Interval,\n Day$2 as Day,\n Frequency$2 as Frequency,\n LinkedSchedule$2 as LinkedSchedule,\n Transparency$2 as Transparency,\n RecurringIntervalType$2 as RecurringIntervalType,\n Location$5 as Location,\n LocationType$5 as LocationType,\n Address$6 as Address,\n AddressStreetOneOf$5 as AddressStreetOneOf,\n StreetAddress$5 as StreetAddress,\n AddressLocation$5 as AddressLocation,\n Subdivision$5 as Subdivision,\n LocationsLocation$2 as LocationsLocation,\n LocationStatus$2 as LocationStatus,\n LocationsLocationType$2 as LocationsLocationType,\n LocationsAddress$2 as LocationsAddress,\n LocationsStreetAddress$2 as LocationsStreetAddress,\n LocationsAddressLocation$2 as LocationsAddressLocation,\n BusinessSchedule$3 as BusinessSchedule,\n TimePeriod$3 as TimePeriod,\n DayOfWeek$3 as DayOfWeek,\n SpecialHourPeriod$3 as SpecialHourPeriod,\n Rate$2 as Rate,\n Price$3 as Price,\n Availability$2 as Availability,\n AvailabilityConstraints$2 as AvailabilityConstraints,\n SplitInterval$2 as SplitInterval,\n Participant$2 as Participant,\n ApprovalStatus$2 as ApprovalStatus,\n ExternalCalendarOverrides$2 as ExternalCalendarOverrides,\n ScheduleStatus$2 as ScheduleStatus,\n Version$2 as Version,\n ConferenceProvider$2 as ConferenceProvider,\n CalendarConference$2 as CalendarConference,\n ConferenceType$2 as ConferenceType,\n ResourceStatus$1 as ResourceStatus,\n BusinessLocation$3 as BusinessLocation,\n Event$1 as Event,\n Empty$5 as Empty,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotification as ServiceNotification,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotificationMetadataOneOf as ServiceNotificationMetadataOneOf,\n Service$1 as Service,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceInfo as ServiceInfo,\n Media$1 as Media,\n MediaItem$2 as MediaItem,\n MediaItemItemOneOf$1 as MediaItemItemOneOf,\n BookingPolicy$3 as BookingPolicy,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_FutureBookingPolicy as FutureBookingPolicy,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_WaitingListPolicy as WaitingListPolicy,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_BookingsApprovalPolicy as BookingsApprovalPolicy,\n PaymentOptions$1 as PaymentOptions,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceStatus as ServiceStatus,\n SeoSchema$1 as SeoSchema,\n Keyword$1 as Keyword,\n Tag$1 as Tag,\n Settings$1 as Settings,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceNotificationEvent as ServiceNotificationEvent,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_BusinessServicesPolicy as BusinessServicesPolicy,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteMetadata as DeleteMetadata,\n ParticipantNotification$6 as ParticipantNotification,\n ScheduleNotification$2 as ScheduleNotification,\n ScheduleNotificationEventOneOf$2 as ScheduleNotificationEventOneOf,\n ScheduleCreated$2 as ScheduleCreated,\n ScheduleUpdated$2 as ScheduleUpdated,\n RecurringSessionsUpdated$2 as RecurringSessionsUpdated,\n Session$2 as Session,\n CalendarDateTime$2 as CalendarDateTime,\n LocalDateTime$2 as LocalDateTime,\n ExternalCalendarInfo$2 as ExternalCalendarInfo,\n CalendarType$2 as CalendarType,\n Status$2 as Status,\n SessionType$2 as SessionType,\n SessionVersion$2 as SessionVersion,\n ScheduleCancelled$2 as ScheduleCancelled,\n SessionCreated$2 as SessionCreated,\n SessionUpdated$2 as SessionUpdated,\n SessionCancelled$2 as SessionCancelled,\n AvailabilityPolicyUpdated$2 as AvailabilityPolicyUpdated,\n AvailabilityPolicy$2 as AvailabilityPolicy,\n IntervalSplit$2 as IntervalSplit,\n RecurringSessionSplit$2 as RecurringSessionSplit,\n ScheduleUnassignedFromUser$2 as ScheduleUnassignedFromUser,\n MultipleSessionsCreated$2 as MultipleSessionsCreated,\n ScheduleWithSessions$2 as ScheduleWithSessions,\n SitePropertiesOnScheduleCreation$2 as SitePropertiesOnScheduleCreation,\n MigrationEvent$2 as MigrationEvent,\n MigrationData$2 as MigrationData,\n StaffData$2 as StaffData,\n DomainEvent$9 as DomainEvent,\n DomainEventBodyOneOf$9 as DomainEventBodyOneOf,\n EntityCreatedEvent$9 as EntityCreatedEvent,\n RestoreInfo$9 as RestoreInfo,\n EntityUpdatedEvent$9 as EntityUpdatedEvent,\n EntityDeletedEvent$9 as EntityDeletedEvent,\n ActionEvent$9 as ActionEvent,\n SitePropertiesNotification$2 as SitePropertiesNotification,\n SitePropertiesEvent$2 as SitePropertiesEvent,\n Properties$2 as Properties,\n Categories$2 as Categories,\n Locale$2 as Locale,\n V4Address$1 as V4Address,\n AddressHint$2 as AddressHint,\n PlacementType$2 as PlacementType,\n GeoCoordinates$2 as GeoCoordinates,\n Multilingual$2 as Multilingual,\n SupportedLanguage$2 as SupportedLanguage,\n ResolutionMethod$2 as ResolutionMethod,\n ConsentPolicy$2 as ConsentPolicy,\n Translation$2 as Translation,\n ChangeContext$2 as ChangeContext,\n ChangeContextPayloadOneOf$2 as ChangeContextPayloadOneOf,\n PropertiesChange$2 as PropertiesChange,\n SiteCreated$4 as SiteCreated,\n SiteCloned$2 as SiteCloned,\n MessageEnvelope$8 as MessageEnvelope,\n IdentificationData$a as IdentificationData,\n IdentificationDataIdOneOf$a as IdentificationDataIdOneOf,\n WebhookIdentityType$8 as WebhookIdentityType,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_createServiceOptionsAndVariants as createServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_cloneServiceOptionsAndVariants as cloneServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariants as getServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_getServiceOptionsAndVariantsByServiceId as getServiceOptionsAndVariantsByServiceId,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_updateServiceOptionsAndVariants as updateServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariants as UpdateServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_UpdateServiceOptionsAndVariantsOptions as UpdateServiceOptionsAndVariantsOptions,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_deleteServiceOptionsAndVariants as deleteServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_DeleteServiceOptionsAndVariantsOptions as DeleteServiceOptionsAndVariantsOptions,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_queryServiceOptionsAndVariants as queryServiceOptionsAndVariants,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryResult as ServiceOptionsAndVariantsListQueryResult,\n bookingsCatalogV1ServiceOptionsAndVariants_universal_d_ServiceOptionsAndVariantsListQueryBuilder as ServiceOptionsAndVariantsListQueryBuilder,\n };\n }\n \n interface BookingFee {\n /**\n * Booking fee ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the booking associated with the fee. */\n bookingId?: string | null;\n /** Cancellation fee details. */\n cancellationFee?: CancellationFee;\n /**\n * Information about the [booking policy snapshot](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/introduction)\n * according to which the fee was created.\n */\n policyDetails?: PolicyDetails;\n }\n interface CancellationFee {\n /** Price the customer must pay. */\n price?: Money$2;\n /**\n * Status of the booking fee.\n *\n * + `UNKNOWN_STATUS`: There is no eCommerce order associated with the booking.\n * + `PREVIEW`: The fee is informational only; the customer doesn't have to pay it. For example, it shows how much the customer would owe if they canceled the booking now.\n * + `NOT_YET_APPLIED_TO_ORDER`: The booking fee hasn't been added to the eCommerce order yet.\n * + `APPLIED_TO_ORDER`: The booking fee has been added to the eCommerce order. The customer may not have paid it yet.\n */\n status?: BookingFeeStatus$1;\n /**\n * Information about what triggered the creation of the booking fee.\n *\n * + `UNKNOWN_STATUS`: There is no information about what triggered the creation of the booking fee.\n * + `NOT_ATTENDED`: The booking fee was created because the customer didn't show up to the booking or canceled after the expiration of the last cancellation window.\n * + `BOOKING_CANCELED`: The booking fee was created because the customer canceled the booking before the expiration of the last cancellation window.\n * @readonly\n */\n trigger?: Trigger;\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 /**\n * Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.\n * @readonly\n */\n formattedValue?: string | null;\n }\n enum BookingFeeStatus$1 {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n PREVIEW = \"PREVIEW\",\n NOT_YET_APPLIED_TO_ORDER = \"NOT_YET_APPLIED_TO_ORDER\",\n APPLIED_TO_ORDER = \"APPLIED_TO_ORDER\"\n }\n /** the domain event trigger the booking fee calculation */\n enum Trigger {\n UNKNOWN_TRIGGER = \"UNKNOWN_TRIGGER\",\n NOT_ATTENDED = \"NOT_ATTENDED\",\n BOOKING_CANCELED = \"BOOKING_CANCELED\"\n }\n interface PolicyDetails {\n /**\n * ID of the booking policy.\n * @readonly\n */\n _id?: string | null;\n /** Description of the booking policy. */\n description?: string | null;\n }\n interface FailedToApplyBookingFeeToOrder {\n /** Booking fee which couldn't to be applied to the eCommerce order. */\n bookingFee?: BookingFee;\n /**\n * IDs of the booking fees that are related to the booking fee which couldn't be\n * applied to the eCommerce order.\n */\n relatedBookingFeeIds?: string[];\n /** Information about the affected eCommerce order. */\n ecomOrderInfo?: EcomOrderInfo;\n /**\n * Information about whether to notify the business about failing to apply the\n * booking fees to the eCommerce order and the message to send.\n */\n businessNotification?: BusinessNotification;\n /**\n * Failure date and time.\n * @internal\n */\n failureDate?: Date | null;\n }\n interface EcomOrderInfo {\n /** Order ID. */\n orderId?: string | null;\n /** Additional fee price. */\n additionalFeePrice?: Price$2;\n /** The eCommerce additional fee id that was created on the order. */\n additionalFeeId?: string | null;\n }\n interface Price$2 {\n /** Amount. */\n amount?: string;\n /**\n * Amount formatted with currency symbol.\n * @readonly\n */\n formattedAmount?: string;\n }\n interface BusinessNotification {\n /**\n * Whether to notify the business about changes made to the booking fees.\n * Default is false.\n */\n notifyBusiness?: boolean | null;\n /** Optional custom message to send. */\n message?: string | null;\n }\n interface FailedToCollectAppliedBookingFees {\n /**\n * IDs of the bookings for which the booking fees couldn't be collected from the\n * customer.\n */\n bookingIds?: string[];\n /** Information about the affected eCommerce order. */\n ecomOrderInfo?: EcomOrderInfo;\n /**\n * Information about whether to notify the business about failing to collect the\n * booking fees from the customer and the message to send.\n */\n businessNotification?: BusinessNotification;\n /**\n * Failure date and time.\n * @internal\n */\n failureDate?: Date | null;\n }\n interface ListBookingFeesByBookingIdsRequest {\n /** IDs of the bookings to retrieve booking fees for. */\n bookingIds?: string[];\n /** IDs of the multi service bookings to retrieve booking fees for. */\n multiServiceBookingIds?: string[];\n }\n interface ListBookingFeesByBookingIdsResponse {\n /** List of retrieved booking fees. */\n bookingFees?: BookingFee[];\n /** Paging metadata. */\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$8;\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$8 {\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 ApplyBookingFeesToOrderRequest {\n /** IDs of the bookings for which to apply booking fees to an eCommerce order. */\n bookingIds: string[] | null;\n /**\n * Custome price override for the additional fee that's added to the eCommerce\n * order. The override mustn't exceed the sum of all booking fees. You must have\n * the `OVERRIDE_BOOKING_FEE_PRICE` permission to use this property.\n */\n priceOverride?: Money$2;\n /**\n * Information about the message to the business and whether to send it if the\n * booking fee application to the eCommerce order fails.\n */\n businessNotification?: BusinessNotification;\n }\n interface ApplyBookingFeesToOrderResponse {\n /**\n * Booking fees that were applied as a single additional fee to the eCommerce\n * order.\n */\n bookingFees?: BookingFee[];\n /** Information about the eCommerce order to which the booking fees are applied. */\n ecomOrderInfo?: EcomOrderInfo;\n }\n interface ListNonPreviewBookingFeesByBookingIdsRequest {\n /** IDs of the bookings to retrieve booking fees for. */\n bookingIds: string[];\n }\n interface ListNonPreviewBookingFeesByBookingIdsResponse {\n /** List of retrieved booking fees. */\n bookingFees?: BookingFee[];\n }\n interface CollectAppliedBookingFeesRequest {\n /**\n * ID of the eCommmerce order that includes the booking fees as a single\n * `additionalFee`.\n */\n orderId: string | null;\n /** ID of the additional fee that's related to all given booking fees. */\n additionalFeeId: string | null;\n /**\n * Information about whether to notify the business about failing to collect the\n * booking fees from the customer and the message to send.\n */\n businessNotification?: BusinessNotification;\n }\n interface CollectAppliedBookingFeesResponse {\n /** Collected amount. */\n collectedPrice?: Price$2;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$8;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$8 {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$8 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$8 {\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$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$7;\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$7 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n /**\n * Retrieves booking fees by booking IDs and multi service booking IDs.\n *\n *\n * Instead of returning `bookingFee` objects with the `cancellationFee.price.value`\n * set to `0.00`, the endpoint doesn't return a `bookingFee` object for the relevant\n * booking IDs. For example, no `bookingFee` object is returned if the canceled\n * booking was free or if the booking was canceled before the start of the earliest\n * cancellation window.\n *\n * If the service's booking policy has been updated since the booking was created,\n * booking fees are calculated according to the\n * [policy snapshot](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policy-snapshots/introduction)\n * rather than the current version of the policy.\n *\n * This endpoint calculates the cancellation fee amount based on the time of the\n * call, you can't specify a time. Similarly, it calculates the cancellation fee\n * based on the number of participants who canceled, not a provided number.\n *\n * A `cancellationFee.status` of `PREVIEW` indicates that the booking fee is\n * informational only; the customer isn't required to pay it. When the `status` is\n * set to `UNKNOWN_STATUS` there is no eCommerce order associated with the booking. For\n * example, if a custom checkout was used for the booking instead of the\n * [Wix eCommerce checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/setup).\n *\n * If multiple events would trigger the calculation of a booking fee, for example\n * when a booking is first canceled and then marked as not attended, Wix calculates\n * the booking fee based on the first trigger. In this example, the booking\n * cancellation.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when listing booking fees.\n * @permissionId BOOKINGS.BOOKING_FEES_READ\n */\n function listBookingFeesByBookingIds(options?: ListBookingFeesByBookingIdsOptions): Promise;\n interface ListBookingFeesByBookingIdsOptions {\n /** IDs of the bookings to retrieve booking fees for. */\n bookingIds?: string[];\n /** IDs of the multi service bookings to retrieve booking fees for. */\n multiServiceBookingIds?: string[];\n }\n /**\n * Applies booking fees to an\n * [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup).\n *\n *\n * The booking fees are added as a single additional fee to the eCommerce order.\n * The order's `additionalFee.lineItemIds` array is set to the list of corresponding\n * booking IDs. By default, the `additionalFee.price.amount` is the sum of all\n * booking fee prices. But you may provide a `priceOverride` instead. The override\n * price can't be higher than the sum of all booking fees.\n *\n * Apply Booking Fees to Order also updates the prices of all affected line items\n * in the relevant eCommerce order to zero. After a cancellation fee is applied\n * to an eCommerce order, the cancellation fee's `price.value` is updated to `0.00`\n * and its trigger is set to `UNKNOWN_TRIGGER`. You can retrieve the fee amount\n * from the corresponding `additionalFee` object of the eCommerce order with\n * [getOrder()](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/get-order).\n *\n * If you apply multiple booking fees to an eCommerce order, they either all fail or\n * all succeed together. For example, the call fails if the booking fees are associated\n * with different eCommmerce orders.\n * @param bookingIds - IDs of the bookings for which to apply booking fees to an eCommerce order.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingIds\n * @requiredField options.priceOverride.currency\n * @requiredField options.priceOverride.value\n * @param options - Options to use when applying booking fees to an eCommerce order.\n * @permissionId BOOKINGS.BOOKING_FEE_APPLY_TO_ORDER\n * @adminMethod\n */\n function applyBookingFeesToOrder(bookingIds: string[] | null, options?: ApplyBookingFeesToOrderOptions): Promise;\n interface ApplyBookingFeesToOrderOptions {\n /**\n * Custome price override for the additional fee that's added to the eCommerce\n * order. The override mustn't exceed the sum of all booking fees. You must have\n * the `OVERRIDE_BOOKING_FEE_PRICE` permission to use this property.\n */\n priceOverride?: Money$2;\n /**\n * Information about the message to the business and whether to send it if the\n * booking fee application to the eCommerce order fails.\n */\n businessNotification?: BusinessNotification;\n }\n /**\n * Retrieves non-preview booking fees by booking IDs.\n *\n * Returns only booking fees with status `APPLIED_TO_ORDER` or `NOT_YET_APPLIED_TO_ORDER`.\n *\n * Use [listBookingFeesByBookingIds()](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-fees/list-booking-fees-by-booking-ids) to retrieve all booking fees.\n *\n * For performance reasons when retrieving only booking fees with status `APPLIED_TO_ORDER` or `NOT_YET_APPLIED_TO_ORDER`, we recommend using this method over listBookingFeesByBookingIds().\n * @param bookingIds - IDs of the bookings to retrieve booking fees for.\n * @internal\n * @documentationMaturity preview\n * @requiredField bookingIds\n * @permissionId BOOKINGS.BOOKING_FEES_READ\n */\n function listNonPreviewBookingFeesByBookingIds(bookingIds: string[]): Promise;\n /**\n * Collects booking fees by charging the customer using the payment method that's\n * saved on the corresponding [eCommerce order](https://dev.wix.com/docs/sdk/backend-modules/ecom/orders/setup).\n *\n *\n *
      \n *\n * __Warning:__\n * Currently, there is no validation that prevents idempotent requests.\n * This means that your code must make sure to not charge customers multiple\n * times for the same booking fee. You could use [listTransactionsForSingleOrder()](https://dev.wix.com/docs/sdk/backend-modules/ecom/order-transactions/list-transactions-for-single-order) to check which charges were made previously for an eCommerce order.\n *
      \n *\n * An HTTP status of `200` means that all booking fees were successfully collected.\n * Any other HTPP status means that collection failed.\n *\n * Collects the order's `additionalFees.price.amount` that's related to the\n * booking fees. If there are multiple additional fees on the eCommerce order,\n * the amount that's collected differs from `priceSummary.totalAdditionalFees.amount`.\n *\n * Possible failure reason's include:\n * + The order's `status` isn't `APPROVED`.\n * + There is no payment method saved on the order.\n * + The order's `balanceSummary.balance.amount` is lower than the\n * `additionalFees.price.amount` to collect.\n * + The order's `additionalFeeId` doesn't belong to a Wix Bookings cancellation fee.\n * @param orderId - ID of the eCommmerce order that includes the booking fees as a single\n * `additionalFee`.\n * @public\n * @documentationMaturity preview\n * @requiredField options.additionalFeeId\n * @requiredField orderId\n * @param options - Options to use when collecting booking fees that have been applied to an eCommerce order.\n * @permissionId BOOKINGS.BOOKING_FEE_COLLECT\n * @adminMethod\n */\n function collectAppliedBookingFees(orderId: string | null, options?: CollectAppliedBookingFeesOptions): Promise;\n interface CollectAppliedBookingFeesOptions {\n /** ID of the additional fee that's related to all given booking fees. */\n additionalFeeId: string | null;\n /**\n * Information about whether to notify the business about failing to collect the\n * booking fees from the customer and the message to send.\n */\n businessNotification?: BusinessNotification;\n }\n \n type bookingsFeesV1BookingFee_universal_d_BookingFee = BookingFee;\n type bookingsFeesV1BookingFee_universal_d_CancellationFee = CancellationFee;\n type bookingsFeesV1BookingFee_universal_d_Trigger = Trigger;\n const bookingsFeesV1BookingFee_universal_d_Trigger: typeof Trigger;\n type bookingsFeesV1BookingFee_universal_d_PolicyDetails = PolicyDetails;\n type bookingsFeesV1BookingFee_universal_d_FailedToApplyBookingFeeToOrder = FailedToApplyBookingFeeToOrder;\n type bookingsFeesV1BookingFee_universal_d_EcomOrderInfo = EcomOrderInfo;\n type bookingsFeesV1BookingFee_universal_d_BusinessNotification = BusinessNotification;\n type bookingsFeesV1BookingFee_universal_d_FailedToCollectAppliedBookingFees = FailedToCollectAppliedBookingFees;\n type bookingsFeesV1BookingFee_universal_d_ListBookingFeesByBookingIdsRequest = ListBookingFeesByBookingIdsRequest;\n type bookingsFeesV1BookingFee_universal_d_ListBookingFeesByBookingIdsResponse = ListBookingFeesByBookingIdsResponse;\n type bookingsFeesV1BookingFee_universal_d_ApplyBookingFeesToOrderRequest = ApplyBookingFeesToOrderRequest;\n type bookingsFeesV1BookingFee_universal_d_ApplyBookingFeesToOrderResponse = ApplyBookingFeesToOrderResponse;\n type bookingsFeesV1BookingFee_universal_d_ListNonPreviewBookingFeesByBookingIdsRequest = ListNonPreviewBookingFeesByBookingIdsRequest;\n type bookingsFeesV1BookingFee_universal_d_ListNonPreviewBookingFeesByBookingIdsResponse = ListNonPreviewBookingFeesByBookingIdsResponse;\n type bookingsFeesV1BookingFee_universal_d_CollectAppliedBookingFeesRequest = CollectAppliedBookingFeesRequest;\n type bookingsFeesV1BookingFee_universal_d_CollectAppliedBookingFeesResponse = CollectAppliedBookingFeesResponse;\n const bookingsFeesV1BookingFee_universal_d_listBookingFeesByBookingIds: typeof listBookingFeesByBookingIds;\n type bookingsFeesV1BookingFee_universal_d_ListBookingFeesByBookingIdsOptions = ListBookingFeesByBookingIdsOptions;\n const bookingsFeesV1BookingFee_universal_d_applyBookingFeesToOrder: typeof applyBookingFeesToOrder;\n type bookingsFeesV1BookingFee_universal_d_ApplyBookingFeesToOrderOptions = ApplyBookingFeesToOrderOptions;\n const bookingsFeesV1BookingFee_universal_d_listNonPreviewBookingFeesByBookingIds: typeof listNonPreviewBookingFeesByBookingIds;\n const bookingsFeesV1BookingFee_universal_d_collectAppliedBookingFees: typeof collectAppliedBookingFees;\n type bookingsFeesV1BookingFee_universal_d_CollectAppliedBookingFeesOptions = CollectAppliedBookingFeesOptions;\n namespace bookingsFeesV1BookingFee_universal_d {\n export {\n bookingsFeesV1BookingFee_universal_d_BookingFee as BookingFee,\n bookingsFeesV1BookingFee_universal_d_CancellationFee as CancellationFee,\n Money$2 as Money,\n BookingFeeStatus$1 as BookingFeeStatus,\n bookingsFeesV1BookingFee_universal_d_Trigger as Trigger,\n bookingsFeesV1BookingFee_universal_d_PolicyDetails as PolicyDetails,\n bookingsFeesV1BookingFee_universal_d_FailedToApplyBookingFeeToOrder as FailedToApplyBookingFeeToOrder,\n bookingsFeesV1BookingFee_universal_d_EcomOrderInfo as EcomOrderInfo,\n Price$2 as Price,\n bookingsFeesV1BookingFee_universal_d_BusinessNotification as BusinessNotification,\n bookingsFeesV1BookingFee_universal_d_FailedToCollectAppliedBookingFees as FailedToCollectAppliedBookingFees,\n bookingsFeesV1BookingFee_universal_d_ListBookingFeesByBookingIdsRequest as ListBookingFeesByBookingIdsRequest,\n bookingsFeesV1BookingFee_universal_d_ListBookingFeesByBookingIdsResponse as ListBookingFeesByBookingIdsResponse,\n CursorPagingMetadata$6 as CursorPagingMetadata,\n Cursors$8 as Cursors,\n bookingsFeesV1BookingFee_universal_d_ApplyBookingFeesToOrderRequest as ApplyBookingFeesToOrderRequest,\n bookingsFeesV1BookingFee_universal_d_ApplyBookingFeesToOrderResponse as ApplyBookingFeesToOrderResponse,\n bookingsFeesV1BookingFee_universal_d_ListNonPreviewBookingFeesByBookingIdsRequest as ListNonPreviewBookingFeesByBookingIdsRequest,\n bookingsFeesV1BookingFee_universal_d_ListNonPreviewBookingFeesByBookingIdsResponse as ListNonPreviewBookingFeesByBookingIdsResponse,\n bookingsFeesV1BookingFee_universal_d_CollectAppliedBookingFeesRequest as CollectAppliedBookingFeesRequest,\n bookingsFeesV1BookingFee_universal_d_CollectAppliedBookingFeesResponse as CollectAppliedBookingFeesResponse,\n DomainEvent$8 as DomainEvent,\n DomainEventBodyOneOf$8 as DomainEventBodyOneOf,\n EntityCreatedEvent$8 as EntityCreatedEvent,\n RestoreInfo$8 as RestoreInfo,\n EntityUpdatedEvent$8 as EntityUpdatedEvent,\n EntityDeletedEvent$8 as EntityDeletedEvent,\n ActionEvent$8 as ActionEvent,\n MessageEnvelope$7 as MessageEnvelope,\n IdentificationData$9 as IdentificationData,\n IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf,\n WebhookIdentityType$7 as WebhookIdentityType,\n bookingsFeesV1BookingFee_universal_d_listBookingFeesByBookingIds as listBookingFeesByBookingIds,\n bookingsFeesV1BookingFee_universal_d_ListBookingFeesByBookingIdsOptions as ListBookingFeesByBookingIdsOptions,\n bookingsFeesV1BookingFee_universal_d_applyBookingFeesToOrder as applyBookingFeesToOrder,\n bookingsFeesV1BookingFee_universal_d_ApplyBookingFeesToOrderOptions as ApplyBookingFeesToOrderOptions,\n bookingsFeesV1BookingFee_universal_d_listNonPreviewBookingFeesByBookingIds as listNonPreviewBookingFeesByBookingIds,\n bookingsFeesV1BookingFee_universal_d_collectAppliedBookingFees as collectAppliedBookingFees,\n bookingsFeesV1BookingFee_universal_d_CollectAppliedBookingFeesOptions as CollectAppliedBookingFeesOptions,\n };\n }\n \n /**\n * The `bookingPolicySnapshot` object is the version of a service's booking policy\n * at the time a booking is created. This allows you for example to charge\n * customers the correct cancellation fee even after a service's cancellation\n * policy has been updated.\n */\n interface BookingPolicySnapshot {\n /**\n * Booking policy snapshot ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the booking that's associated with this policy snapshot. */\n bookingId?: string | null;\n /**\n * Snapshot of the [booking policy](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/get-booking-policy).\n * at the time the corresponding booking was created.\n */\n policy?: BookingPolicy$2;\n /**\n * Date and time the booking policy snapshot was created in `YYYY-MM-DDThh:mm:ssZ` format.\n * @readonly\n */\n _createdDate?: Date | null;\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 * - The `CancellationPolicy` object defines the policy for canceling a booked session.\n * - The `ReschedulePolicy` object defines the policy for rescheduling booked session.\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$2 {\n /**\n * Booking policy ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the booking policy is updated. To prevent conflicting changes, the current `revision` must be passed when updating the booking policy.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the booking policy was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the booking policy was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name of the booking policy. */\n name?: string | null;\n /** Custom description for the booking policy and whether the booking policy is displayed to the participant. */\n customPolicyDescription?: PolicyDescription$2;\n /**\n * Whether the booking policy is the default.\n * @readonly\n */\n default?: boolean | null;\n /** Rule for canceling a booking. */\n cancellationPolicy?: CancellationPolicy$2;\n /** Rule for rescheduling a booking. */\n reschedulePolicy?: ReschedulePolicy$2;\n /** Rules for cancellation fees. */\n cancellationFeePolicy?: CancellationFeePolicy$2;\n /** Rule for saving credit card details. */\n saveCreditCardPolicy?: SaveCreditCardPolicy$2;\n }\n /** A description of the booking policy to display to participants. */\n interface PolicyDescription$2 {\n /**\n * Whether the description is displayed to the participant. `true` means the\n * description is displayed.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Description of the booking policy.\n *\n * Default: Empty\n * Max length: 2500 characters\n */\n description?: string;\n /**\n * Description of the translated booking policy.\n *\n * Default: Empty\n * Max length: 2500 characters\n */\n descriptionTranslated?: string | null;\n }\n /** The rule for canceling a booked session. */\n interface CancellationPolicy$2 {\n /**\n * Whether customers can cancel the booking. `true` means customers can cancel\n * the booking.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether there's a limit on the latest cancellation time. `false` means\n * customers can cancel the booking until the last minute before the course or\n * session starts.\n *\n * Default: `false`\n */\n limitLatestCancellation?: boolean;\n /**\n * Minimum number of minutes before the start of the session customers can cancel.\n * For courses, this refers to the start of the first course session.\n *\n * Default: `1440` minutes (1 day)\n * Min: `1` minute\n */\n latestCancellationInMinutes?: number;\n }\n /** The rule for rescheduling a booked session. */\n interface ReschedulePolicy$2 {\n /**\n * Whether customers can reschedule a booking for an appointment-based service.\n * `true` means customers can reschedule.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether there's a limit on the latest supported rescheduling time. `false`\n * means customers can reschedule until the last minute before the session start.\n *\n * Default: `false`\n */\n limitLatestReschedule?: boolean;\n /**\n * Minimum number of minutes before the session start session customers can\n * reschedule their booking.\n *\n * Default: `1440` minutes (1 day)\n * Min: `1` minute\n */\n latestRescheduleInMinutes?: number;\n }\n interface CancellationFeePolicy$2 {\n /**\n * Whether customers must pay a cancellation fee when canceling a booking.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Time windows relative to the session start during which customers can cancel\n * their booking. Each window includes details about the fee for canceling\n * within it.\n */\n cancellationWindows?: CancellationWindow$2[];\n /**\n * Whether Wix automatically charges the cancellation fee from the customer once\n * they cancel their booking.\n *\n * Default: true\n */\n autoCollectFeeEnabled?: boolean | 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$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 CancellationWindow$2 extends CancellationWindowFeeOneOf$2 {\n /** Fixed amount customers must pay when canceling the booking within this window. */\n amount?: Money$1;\n /**\n * Percentage of the booking price customers must pay when canceling within this window.\n *\n * Min: `0.01` percent\n * Max: `100` percent\n */\n percentage?: string;\n /**\n * Start of the cancellation window in minutes before the session start. For\n * courses, this refers to the start of the first course session.\n */\n startInMinutes?: number | null;\n }\n /** @oneof */\n interface CancellationWindowFeeOneOf$2 {\n /** Fixed amount customers must pay when canceling the booking within this window. */\n amount?: Money$1;\n /**\n * Percentage of the booking price customers must pay when canceling within this window.\n *\n * Min: `0.01` percent\n * Max: `100` percent\n */\n percentage?: string;\n }\n interface SaveCreditCardPolicy$2 {\n /**\n * Whether Wix stores credit card details of the customer. Storing the details\n * allows Wix to prefill the checkout and thus increases the likelyhood that the\n * customer completes the booking process.\n *\n * Default: `false`\n */\n enabled?: boolean;\n }\n interface ListPolicySnapshotsByBookingIdsRequest {\n /** List of booking IDs to retrieve policy snapshots for. */\n bookingIds: string[] | null;\n }\n interface ListPolicySnapshotsByBookingIdsResponse {\n /** Retrieved booking Policy snapshots. */\n bookingPolicySnapshots?: BookingPolicySnapshot[];\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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$7;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$7 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$7 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$7 {\n bodyAsJson?: string;\n }\n interface Empty$4 {\n }\n /**\n * Retrieves a list of booking policy snapshots by booking IDs.\n * @param bookingIds - List of booking IDs to retrieve policy snapshots for.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingIds\n * @permissionId BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ\n */\n function listPolicySnapshotsByBookingIds(bookingIds: string[] | null): Promise;\n \n type bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_BookingPolicySnapshot = BookingPolicySnapshot;\n type bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_ListPolicySnapshotsByBookingIdsRequest = ListPolicySnapshotsByBookingIdsRequest;\n type bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_ListPolicySnapshotsByBookingIdsResponse = ListPolicySnapshotsByBookingIdsResponse;\n const bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_listPolicySnapshotsByBookingIds: typeof listPolicySnapshotsByBookingIds;\n namespace bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d {\n export {\n bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_BookingPolicySnapshot as BookingPolicySnapshot,\n BookingPolicy$2 as BookingPolicy,\n PolicyDescription$2 as PolicyDescription,\n CancellationPolicy$2 as CancellationPolicy,\n ReschedulePolicy$2 as ReschedulePolicy,\n CancellationFeePolicy$2 as CancellationFeePolicy,\n Money$1 as Money,\n CancellationWindow$2 as CancellationWindow,\n CancellationWindowFeeOneOf$2 as CancellationWindowFeeOneOf,\n SaveCreditCardPolicy$2 as SaveCreditCardPolicy,\n bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_ListPolicySnapshotsByBookingIdsRequest as ListPolicySnapshotsByBookingIdsRequest,\n bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_ListPolicySnapshotsByBookingIdsResponse as ListPolicySnapshotsByBookingIdsResponse,\n DomainEvent$7 as DomainEvent,\n DomainEventBodyOneOf$7 as DomainEventBodyOneOf,\n EntityCreatedEvent$7 as EntityCreatedEvent,\n RestoreInfo$7 as RestoreInfo,\n EntityUpdatedEvent$7 as EntityUpdatedEvent,\n EntityDeletedEvent$7 as EntityDeletedEvent,\n ActionEvent$7 as ActionEvent,\n Empty$4 as Empty,\n bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d_listPolicySnapshotsByBookingIds as listPolicySnapshotsByBookingIds,\n };\n }\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$1;\n /**\n * Information about the online conferencing details. Available only when passing\n * `withBookingConferencingDetails` as `true`.\n */\n conferencingDetails?: ConferencingDetails;\n /**\n * Information about the booking's policy settings according to the relevant\n * [booking policy snapshot](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy-snapshots/introduction).\n * Available only when passing `withBookingPolicySettings` as `true`.\n * @internal\n */\n bookingPolicySettings?: BookingPolicySettings$1;\n /**\n * Information about the booking fee statuses. Available only when passing\n * `withBookingFeeDetailsBooking` as `true`. No details are returned when there\n * is no booking fee for the booking. For example, when a booking was canceled\n * before the start of the earliest cancellation window or the customer hasn't\n * canceled the booking yet.\n * @internal\n */\n bookingFeeDetails?: BookingFeeDetails;\n }\n enum AttendanceStatus$1 {\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 * Number of participants.\n * @internal\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note\n * @internal\n * @deprecated\n */\n internalBusinessNote?: string | null;\n /**\n * Booking status.\n *\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 onwer confirmation and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) 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](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).\n * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) 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$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 */\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 | null;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /**\n * An object describing the platform and application that made the booking.\n * @internal\n */\n bookingSource?: BookingSource$2;\n /**\n * The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.\n * @internal\n * @deprecated\n */\n participantNotification?: ParticipantNotification$5;\n /**\n * When value is set to True, an SMS reminder would be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.\n * @internal\n * @deprecated\n */\n sendSmsReminder?: boolean | 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$8;\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 | null;\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 | null;\n /**\n * Sets the booking flow behavior. Some behaviors require permissions.\n * @internal\n */\n flowControlSettings?: FlowControlSettings$2;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.\n * For usage of extended fields with [Wix Forms](https://dev.wix.com/docs/rest/crm/forms/form-schema-api/introduction-to-forms), after configuring your form custom fields, pass the form field values under the `_user_fields` namespace.\n * For example, if you have a custom form field named `age`, pass it as `\"extendedFields\":{\"_user_fields\": { \"age\": 22 }}`.\n */\n extendedFields?: ExtendedFields$7;\n /**\n * Whether this booking overlaps another existing confirmed booking. Returned when: `true`\n * @readonly\n */\n doubleBooked?: boolean | null;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\n /**\n * Multi service booking info of which the booking is part of.\n * @internal\n * @readonly\n */\n multiServiceBookingInfo?: MultiServiceBookingInfo$2;\n /**\n * The date this booking was canceled on\n * @internal\n * @readonly\n */\n canceledDate?: Date | null;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2AvailabilityProxy?: boolean | null;\n /**\n * Having booking language means that the booking was made in a secondary language, having no booking.language implies that the booking was made using the main language\n * @internal\n */\n language?: string | 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 * If the user made the booking in a secondary language, this field will contain the translated title.\n * @internal\n * @readonly\n */\n titleTranslated?: 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$4;\n /**\n * Optional.\n * In addition to the `resource` field, these are the additional enriched resources that are assigned to the slot.\n * For example the room, equipment or the additional staff member that are assigned to the slot.\n * @internal\n */\n additionalResources?: BookedResource$2[];\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 /**\n * Resource's name translated to the language the booking was made in if applicable.\n * @internal\n * @readonly\n */\n nameTranslated?: 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 * Indicates whether the resource was specifically requested or should be auto selected by the Server.\n * The value will be true if the resource was explicitly given in the request, otherwise false.\n * @internal\n * @readonly\n */\n explicitlyRequested?: boolean | null;\n /**\n * Resource's type.\n * @internal\n * @readonly\n */\n type?: string | null;\n }\n interface Location$4 {\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 /** The full translated address of this location. */\n formattedAddressTranslated?: 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$4;\n }\n enum LocationType$4 {\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$4;\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$5;\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$5 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$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 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 /** Platform from which a booking was created */\n platform?: Platform$2;\n /** Actor that created this booking. */\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$5 {\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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\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 /** 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 * @internal\n * @readonly\n */\n identityType?: IdentityType$3;\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 IdentityType$3 {\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 the service defined booking-window in the booking policy.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n * private because it's confusing to external users - collides with skip_availability_validation\n * and yet, clients send it (though always with skip_availability_validation=true) so we're not just removing it\n * When removing, we need to use proto's `reserved` field\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: boolean;\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$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 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$2[];\n }\n interface ServiceChoice$2 extends ServiceChoiceChoiceOneOf$2 {\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$2 {\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 * Whether the customer is allowed to add another service to the booking.\n * @internal\n */\n bookAnother?: boolean;\n /**\n * Deprecated.\n * Whether the customer is entitled to a refund when canceling the booking.\n * @deprecated\n */\n refund?: boolean | null;\n }\n interface Attendance$1 {\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$1;\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 * Optional conference description.\n * @internal\n */\n description?: string | null;\n }\n interface BookingPolicySettings$1 {\n /** Whether the booking has an active cancellation fee policy. */\n cancellationFeeEnabled?: boolean | null;\n /**\n * Whether the booking has an active rescheduling fee policy.\n * @internal\n */\n reschedulingFeeEnabled?: boolean | null;\n }\n interface BookingFeeDetails {\n /** The cancellation fee status. */\n cancellationFeeStatus?: BookingFeeStatus;\n /**\n * The rescheduling fee status.\n * @internal\n */\n reschedulingFeeStatus?: BookingFeeStatus;\n }\n enum BookingFeeStatus {\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n NOT_YET_APPLIED_TO_ORDER = \"NOT_YET_APPLIED_TO_ORDER\",\n APPLIED_TO_ORDER = \"APPLIED_TO_ORDER\"\n }\n interface QueryExtendedBookingRequest {\n /** Information about filters, paging, and sorting. */\n query: QueryV2$3;\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 * Whether information about the total entities is returned.\n * @internal\n */\n withPagingMetadataTotal?: boolean;\n /**\n * Whether information about the online conferencing details for the bookings is returned.\n * @internal\n */\n withBookingConferencingDetails?: boolean;\n /**\n * Whether to retrieve information about booking policy settings.\n * You must have the `BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ` permission scope\n * when passing `true`.\n *\n * Default: `false`.\n * @internal\n */\n withBookingPolicySettings?: boolean;\n /**\n * Whether to retrieve information about the booking fee statuses.\n * Information about booking fees with a status of `PREVIEW` isn't returned.\n * You must have the `BOOKINGS.BOOKING_FEES_READ` permission scope when passing\n * `true`. In order to retrieve complete booking fee objects or to get information\n * about `PREVIEW` fees, use [List Booking Fees By Booking Ids](https://dev.wix.com/docs/rest/business-solutions/bookings/booking-fees/list-booking-fees-by-booking-ids)\n * instead.\n *\n * Default: `false`.\n * @internal\n */\n withBookingFeeDetails?: boolean;\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$7;\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$7[];\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$7;\n }\n interface Sorting$7 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$7;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$7 {\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$7 {\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$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$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 * @internal\n */\n hasNext?: boolean | null;\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 QueryExtendedBookingsRequest {\n /** Information about filters, paging, and sorting. */\n query: CommonQueryV2;\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 /** Whether information about the online conferencing details for the bookings is returned. */\n withBookingConferencingDetails?: boolean;\n /**\n * Whether to retrieve information about booking policy settings.\n * You must have the `BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ` permission scope\n * when passing `true`.\n *\n * Default: `false`.\n * @internal\n */\n withBookingPolicySettings?: boolean;\n /**\n * Whether to retrieve information about the booking fee statuses.\n * Information about booking fees with a status of `PREVIEW` isn't returned.\n * You must have the `BOOKINGS.BOOKING_FEES_READ` permission scope when passing\n * `true`. In order to retrieve complete booking fee objects or to get information\n * about `PREVIEW` fees, use [List Booking Fees By Booking Ids](https://dev.wix.com/docs/rest/business-solutions/bookings/booking-fees/list-booking-fees-by-booking-ids)\n * instead.\n *\n * Default: `false`.\n * @internal\n */\n withBookingFeeDetails?: boolean;\n }\n interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {\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$7;\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$7[];\n }\n /** @oneof */\n interface CommonQueryV2PagingMethodOneOf {\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$7;\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$2;\n }\n /**\n * > **Deprecation Notice**\n * >\n * > **This endpoint has been replaced with [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) and will be removed on May 31, 2025.**\n * > **If your app uses this endpoint, we recommend updating your code as soon as possible.**\n *\n *\n * Retrieves a list of bookings, given the provided paging, filtering, and sorting.\n *\n *\n * You can also retrieve information about which actions the customer can perform\n * for the bookings. To do so, pass `withBookingAllowedActions` as `true`.\n *\n * Query Bookings runs with these defaults:\n *\n * - `createdDate` sorted in `DESC` order\n * - `cursorPaging.limit` is `50`\n *\n * You can check the overview about all\n * [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/supported-filters)\n * for more information.\n *\n * `query.fields` and `query.fieldsets` aren't supported for this endpoint.\n *\n * You can only specify a filter only once per query. If a filter is provided\n * more than once, only the first occurrence affects the returned bookings.\n *\n * When using filters for dates, you must use [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).\n *\n * Bookings belonging to a schedule don't have a `sessionId`. Therefore you\n * must use the `sessionId` filter that isn't part of the `query` object to\n * filter bookings for courses.\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/api/rest/getting-started/sorting-and-paging),\n * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n *\n * When calling Query Bookings, the retrieved data may not contain your most recent changes. See\n * [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency)\n * for more information.\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 * @permissionId BOOKINGS.BOOKING_READ\n * @deprecated\n */\n function query$1(query: QueryV2$3, options?: QueryOptions$1): Promise;\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 * Whether information about the total entities is returned.\n * @internal\n */\n withPagingMetadataTotal?: boolean;\n /**\n * Whether information about the online conferencing details for the bookings is returned.\n * @internal\n */\n withBookingConferencingDetails?: boolean;\n /**\n * Whether to retrieve information about booking policy settings.\n * You must have the `BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ` permission scope\n * when passing `true`.\n *\n * Default: `false`.\n * @internal\n */\n withBookingPolicySettings?: boolean;\n /**\n * Whether to retrieve information about the booking fee statuses.\n * Information about booking fees with a status of `PREVIEW` isn't returned.\n * You must have the `BOOKINGS.BOOKING_FEES_READ` permission scope when passing\n * `true`. In order to retrieve complete booking fee objects or to get information\n * about `PREVIEW` fees, use [List Booking Fees By Booking Ids](https://dev.wix.com/docs/rest/business-solutions/bookings/booking-fees/list-booking-fees-by-booking-ids)\n * instead.\n *\n * Default: `false`.\n * @internal\n */\n withBookingFeeDetails?: boolean;\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 * @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 * @permissionId BOOKINGS.BOOKING_READ\n * @permissionId BOOKINGS.MANAGE_BOOKINGS\n * @permissionId BOOKINGS.BOOKING_READ_ANY\n */\n function queryExtendedBookings(query: CommonQueryV2, 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 /** Whether information about the online conferencing details for the bookings is returned. */\n withBookingConferencingDetails?: boolean;\n /**\n * Whether to retrieve information about booking policy settings.\n * You must have the `BOOKINGS.BOOKING_POLICY_SNAPSHOT_READ` permission scope\n * when passing `true`.\n *\n * Default: `false`.\n * @internal\n */\n withBookingPolicySettings?: boolean;\n /**\n * Whether to retrieve information about the booking fee statuses.\n * Information about booking fees with a status of `PREVIEW` isn't returned.\n * You must have the `BOOKINGS.BOOKING_FEES_READ` permission scope when passing\n * `true`. In order to retrieve complete booking fee objects or to get information\n * about `PREVIEW` fees, use [List Booking Fees By Booking Ids](https://dev.wix.com/docs/rest/business-solutions/bookings/booking-fees/list-booking-fees-by-booking-ids)\n * instead.\n *\n * Default: `false`.\n * @internal\n */\n withBookingFeeDetails?: boolean;\n }\n \n type bookingsReaderV2ExtendedBooking_universal_d_ExtendedBooking = ExtendedBooking;\n type bookingsReaderV2ExtendedBooking_universal_d_ConferencingDetails = ConferencingDetails;\n type bookingsReaderV2ExtendedBooking_universal_d_BookingFeeDetails = BookingFeeDetails;\n type bookingsReaderV2ExtendedBooking_universal_d_BookingFeeStatus = BookingFeeStatus;\n const bookingsReaderV2ExtendedBooking_universal_d_BookingFeeStatus: typeof BookingFeeStatus;\n type bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingRequest = QueryExtendedBookingRequest;\n type bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingResponse = QueryExtendedBookingResponse;\n type bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingsRequest = QueryExtendedBookingsRequest;\n type bookingsReaderV2ExtendedBooking_universal_d_CommonQueryV2 = CommonQueryV2;\n type bookingsReaderV2ExtendedBooking_universal_d_CommonQueryV2PagingMethodOneOf = CommonQueryV2PagingMethodOneOf;\n type bookingsReaderV2ExtendedBooking_universal_d_CommonPaging = CommonPaging;\n type bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingsResponse = QueryExtendedBookingsResponse;\n const bookingsReaderV2ExtendedBooking_universal_d_queryExtendedBookings: typeof queryExtendedBookings;\n type bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingsOptions = QueryExtendedBookingsOptions;\n namespace bookingsReaderV2ExtendedBooking_universal_d {\n export {\n bookingsReaderV2ExtendedBooking_universal_d_ExtendedBooking as ExtendedBooking,\n AttendanceStatus$1 as AttendanceStatus,\n Booking$2 as Booking,\n BookingParticipantsInfoOneOf$2 as BookingParticipantsInfoOneOf,\n MultiServiceBookingType$2 as MultiServiceBookingType,\n BookedEntity$2 as BookedEntity,\n BookedEntityItemOneOf$2 as BookedEntityItemOneOf,\n BookedSlot$2 as BookedSlot,\n BookedResource$2 as BookedResource,\n Location$4 as Location,\n LocationType$4 as LocationType,\n BookedSchedule$2 as BookedSchedule,\n ContactDetails$2 as ContactDetails,\n Address$5 as Address,\n AddressStreetOneOf$4 as AddressStreetOneOf,\n StreetAddress$4 as StreetAddress,\n AddressLocation$4 as AddressLocation,\n Subdivision$4 as Subdivision,\n CustomFormField$2 as CustomFormField,\n ValueType$2 as ValueType,\n BookingStatus$2 as BookingStatus,\n PaymentStatus$2 as PaymentStatus,\n SelectedPaymentOption$2 as SelectedPaymentOption,\n BookingSource$2 as BookingSource,\n Platform$2 as Platform,\n Actor$2 as Actor,\n ParticipantNotification$5 as ParticipantNotification,\n IdentificationData$8 as IdentificationData,\n IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf,\n IdentityType$3 as IdentityType,\n FlowControlSettings$2 as FlowControlSettings,\n ExtendedFields$7 as ExtendedFields,\n ParticipantChoices$2 as ParticipantChoices,\n ServiceChoices$2 as ServiceChoices,\n ServiceChoice$2 as ServiceChoice,\n ServiceChoiceChoiceOneOf$2 as ServiceChoiceChoiceOneOf,\n MultiServiceBookingInfo$2 as MultiServiceBookingInfo,\n AllowedActions$1 as AllowedActions,\n Attendance$1 as Attendance,\n bookingsReaderV2ExtendedBooking_universal_d_ConferencingDetails as ConferencingDetails,\n BookingPolicySettings$1 as BookingPolicySettings,\n bookingsReaderV2ExtendedBooking_universal_d_BookingFeeDetails as BookingFeeDetails,\n bookingsReaderV2ExtendedBooking_universal_d_BookingFeeStatus as BookingFeeStatus,\n bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingRequest as QueryExtendedBookingRequest,\n QueryV2$3 as QueryV2,\n QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf,\n Sorting$7 as Sorting,\n SortOrder$7 as SortOrder,\n Paging$3 as Paging,\n CursorPaging$7 as CursorPaging,\n bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingResponse as QueryExtendedBookingResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n Cursors$7 as Cursors,\n bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingsRequest as QueryExtendedBookingsRequest,\n bookingsReaderV2ExtendedBooking_universal_d_CommonQueryV2 as CommonQueryV2,\n bookingsReaderV2ExtendedBooking_universal_d_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf,\n bookingsReaderV2ExtendedBooking_universal_d_CommonPaging as CommonPaging,\n bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingsResponse as QueryExtendedBookingsResponse,\n query$1 as query,\n QueryOptions$1 as QueryOptions,\n bookingsReaderV2ExtendedBooking_universal_d_queryExtendedBookings as queryExtendedBookings,\n bookingsReaderV2ExtendedBooking_universal_d_QueryExtendedBookingsOptions as QueryExtendedBookingsOptions,\n };\n }\n \n /**\n * A resource represents an entity that can be scheduled for use, such as a room or a staff member.\n * The availability of a resource is tracked to ensure that it can be allocated at a requested time slot and to prevent double bookings.\n * Read more about resources in this [article](https://support.wix.com/en/article/wix-bookings-managing-your-resources).\n */\n interface Resource$2 extends ResourceCompositionDetailsOneOf {\n /**\n * Details of a single resource.\n * @internal\n * @deprecated Details of a single resource.\n * @targetRemovalDate 2025-01-01\n */\n singleResource?: SingleResource;\n /**\n * Resource ID\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the staff member is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the staff member.\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this resource was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this resource was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name of the resource. */\n name?: string | null;\n /**\n * The type of the resource.\n *\n * Resources can be created without a type. However, this field must be set to ensure that a resource can be allocated\n * at a requested time slot and to prevent double bookings.\n *\n * The value to assign to this field depends on how the type is managed. There are 2 options:\n * - The resource type is managed by a user (for example the site owner or contributor) in the Resources section of the\n * dashboard or it is managed via the `/v2/resource-types` endpoint.\n * In this case, the `type` field must be set to the id of the resource type entity.\n * - The resource type is managed by an app implementing the `BOOKINGS_RESOURCE_TYPES_PROVIDER` SPI component.\n * In this case the `type` field must match one of the `id` fields in the `bookingsResourceTypes` structure of the SPI configuration.\n *\n * Once a type has been set it cannot be modified.\n * @deprecated\n * @replacedBy type_id\n * @targetRemovalDate 2025-01-01\n */\n type?: string | null;\n typeId?: string | null;\n /**\n * Schedule details that specify the working hours and locations of this resource.\n *\n * When this field is not set or `working_hours_schedules.enabled` is `false` then the resource is assumed to be\n * available full time (7 x 24) at the locations specified in the field `location_options`.\n * When both `working_hours_schedules` and `location_options` are set then `working_hours_schedules` takes precedence.\n */\n workingHoursSchedules?: ResourceWorkingHoursSchedules;\n /**\n * Location details that specify where this resource is available.\n *\n * If this field is not supplied then `location_options.available_in_all_locations` is set to `true`.\n */\n locationOptions?: LocationOptions$1;\n /**\n * This schedule contains the sessions in which this resource has been booked.\n * @readonly\n */\n eventsSchedule?: EventsSchedule;\n /**\n * The ID of the app of which this resource belongs to.\n * Default: Bookings App ID.\n * @internal\n */\n appId?: string | null;\n /**\n * Specifies whether this resource is managed by a user (site owner, contributor, etc) or by an app.\n * Default: `WIX_USER`.\n * @internal\n */\n managementType?: ManagementType;\n /** Extensions enabling users to save custom data related to the resource. */\n extendedFields?: ExtendedFields$6;\n }\n /** @oneof */\n interface ResourceCompositionDetailsOneOf {\n /**\n * Details of a single resource.\n * @internal\n * @deprecated Details of a single resource.\n * @targetRemovalDate 2025-01-01\n */\n singleResource?: SingleResource;\n }\n interface WorkingHoursSchedule$1 {\n /** schedule ID */\n _id?: string | null;\n /**\n * Whether this schedule is used by multiple resources or unique for this resource.\n *\n * `true` if it is a shared schedule (for example from a business or location), `false` this is a custom schedule specific to the resource.\n * Default: `false`.\n * @readonly\n */\n shared?: boolean | null;\n }\n interface SingleResource {\n /**\n * Schedule details that specify the working hours and locations of this resource.\n *\n * When this field is not set or `working_hours_schedules.enabled` is `false` then the resource is assumed to be\n * available full time (7 x 24) at the locations specified in the field `location_options`.\n * When both `working_hours_schedules` and `location_options` are set then `working_hours_schedules` takes precedence.\n */\n workingHoursSchedules?: WorkingHoursSchedules;\n /**\n * Location details that specify where this resource is available.\n *\n * If this field is not supplied then `location_options.available_in_all_locations` is set to `true`.\n */\n locationOptions?: LocationOptions$1;\n /**\n * This schedule contains the sessions in which this resource has been booked.\n * @readonly\n */\n eventsSchedule?: Schedule$2;\n }\n interface WorkingHoursSchedules {\n /**\n * Whether the working hours schedules is enabled.\n *\n * `true` if the working_hours_schedules should be considered for availability, `false` otherwise.\n * Default: `false`.\n * This field is currently marked as `NOT_IMPLEMENTED` until Resource Management will use this from the dashboard or through the API.\n */\n enabled?: boolean | null;\n /** schedules specifying all the working hours of the resource. Currently a single schedule is supported. */\n values?: Schedule$2[];\n }\n /** Deprecated and subject to removal */\n interface Schedule$2 {\n /** schedule ID */\n scheduleId?: string | null;\n /**\n * Whether this schedule is used by multiple resources or unique for this resource.\n *\n * `true` if it is a shared schedule (for example from a business or location), `false` this is a custom schedule specific to the resource.\n * Default: `false`.\n */\n shared?: boolean | null;\n }\n interface LocationOptions$1 {\n /**\n * `true` if the resource is available in all locations, `false` if the resource is available only in specific locations.\n * Default: `false`.\n */\n availableInAllLocations?: boolean | null;\n /**\n * Details of specific locations. It must be left empty if `available_in_all_locations` is `true`.\n * If supplied then the field `specific_location_options.available_in_business_locations` must be set to `true`.\n */\n specificLocationOptions?: SpecificLocation$1;\n }\n interface SpecificLocation$1 {\n /**\n * `true` if the resource can be used at a customer selected location, `false` otherwise.\n * Read more about locations in this [article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations).\n * Default: `false`.\n * @internal\n */\n availableInCustomerLocations?: boolean | null;\n /**\n * `true` if the resource is available in custom locations, `false` otherwise.\n * Default: `false`.\n * @internal\n */\n availableInCustomLocations?: boolean | null;\n /**\n * `true` if the resource is available in some business locations, `false` otherwise.\n * Default: `false`.\n */\n availableInBusinessLocations?: boolean | null;\n /**\n * Information about business locations. Should be empty if `available_in_business_locations` is `false` or if no business location exists in Locations.\n * Currently a single business location can be set.\n * Read more about business locations in this [article](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n */\n businessLocations?: BusinessLocation$2[];\n }\n interface BusinessLocation$2 {\n /** The ID of the business location. Must not be empty. */\n locationId?: string | null;\n }\n interface ResourceWorkingHoursSchedules {\n /** schedules specifying all the working hours of the resource. Currently a single schedule is supported. */\n values?: WorkingHoursSchedule$1[];\n }\n interface EventsSchedule {\n /** schedule ID */\n _id?: string | null;\n }\n enum ManagementType {\n UNKNOWN_MANAGEMENT_TYPE = \"UNKNOWN_MANAGEMENT_TYPE\",\n /** The resource is managed by an app. */\n APP = \"APP\",\n /** The resource is managed by a Wix user. */\n WIX_USER = \"WIX_USER\"\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 CreateResourceRequest {\n /** Resource to be created. */\n resource: Resource$2;\n }\n interface CreateResourceResponse {\n /** The created resource. */\n resource?: Resource$2;\n }\n interface BulkCreateResourcesRequest {\n /** Resources to create. */\n resources: Resource$2[];\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 BulkCreateResourcesResponse {\n /** The result of each resource creation. */\n results?: BulkResourceResult[];\n /** Create statistics. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface BulkResourceResult {\n /** Item metadata */\n itemMetadata?: ItemMetadata$3;\n /** The resulting resource after the bulk operation. */\n item?: Resource$2;\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 GetResourceRequest {\n /** Id of the resource to retrieve. */\n resourceId: string;\n }\n interface GetResourceResponse {\n /** The retrieved resource. */\n resource?: Resource$2;\n }\n interface GetDeletedResourceRequest {\n /** Id of the resource to retrieve. */\n resourceId: string;\n }\n interface GetDeletedResourceResponse {\n /** The retrieved resource. */\n resource?: Resource$2;\n }\n interface ListDeletedResourcesRequest {\n /** The ids of the resources to retrieve. */\n resourceIds?: string[];\n /** Paging parameter, enabling to pass a limit and a cursor. */\n paging?: CursorPaging$6;\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 ListDeletedResourcesResponse {\n /** The retrieved Resources */\n resources?: Resource$2[];\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$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 RemoveResourceFromTrashBinRequest {\n /** Id of the resource to remove from the trash bin. */\n resourceId: string;\n }\n interface RemoveResourceFromTrashBinResponse {\n }\n interface RestoreResourceFromTrashBinRequest {\n /** Id of the resource to restore from the trash bin. */\n resourceId: string;\n }\n interface RestoreResourceFromTrashBinResponse {\n /** The restored resource. */\n resource?: Resource$2;\n }\n interface UpdateResourceRequest {\n /** Resource to be updated, may be partial. */\n resource: Resource$2;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateResourceResponse {\n /** The updated resource. */\n resource?: Resource$2;\n }\n interface DeleteResourceRequest {\n /** Id of the resource to delete. */\n resourceId: string;\n }\n interface DeleteResourceResponse {\n }\n interface BulkDeleteResourcesRequest {\n /** The ids of the resources to delete. */\n ids: string[];\n }\n interface BulkDeleteResourcesResponse {\n /** The result of each resource removal. */\n results?: BulkResourceResult[];\n /** Delete statistics. */\n bulkActionMetadata?: BulkActionMetadata$3;\n }\n interface SearchResourcesRequest {\n /** Search condition */\n search?: CursorSearch$2;\n }\n interface CursorSearch$2 extends CursorSearchPagingMethodOneOf$2 {\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$6;\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$6[];\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$1[];\n /** Free text to match in searchable fields */\n search?: SearchDetails$2;\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. e.g. `\"2023-12-20T10:52:34.795Z\"`\n */\n timeZone?: string | null;\n }\n /** @oneof */\n interface CursorSearchPagingMethodOneOf$2 {\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$6;\n }\n interface Sorting$6 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$6;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$6 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Aggregation$1 extends AggregationKindOneOf$1 {\n /** Value aggregation */\n value?: ValueAggregation$1;\n /** Range aggregation */\n range?: RangeAggregation$1;\n /** Scalar aggregation */\n scalar?: ScalarAggregation$1;\n /** Date histogram aggregation */\n dateHistogram?: DateHistogramAggregation$1;\n /** Nested aggregation */\n nested?: NestedAggregation$1;\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$2;\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$1;\n }\n /** @oneof */\n interface AggregationKindOneOf$1 {\n /** Value aggregation */\n value?: ValueAggregation$1;\n /** Range aggregation */\n range?: RangeAggregation$1;\n /** Scalar aggregation */\n scalar?: ScalarAggregation$1;\n /** Date histogram aggregation */\n dateHistogram?: DateHistogramAggregation$1;\n /** Nested aggregation */\n nested?: NestedAggregation$1;\n }\n interface RangeBucket$1 {\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$1 {\n /** Should sort by number of matches */\n COUNT = \"COUNT\",\n /** Should sort by value of the field alphabetically */\n VALUE = \"VALUE\"\n }\n enum SortDirection$1 {\n /** Should sort in descending order */\n DESC = \"DESC\",\n /** Should sort in ascending order */\n ASC = \"ASC\"\n }\n enum MissingValues$1 {\n /** Should missing values be excluded from the aggregation results */\n EXCLUDE = \"EXCLUDE\",\n /** Should missing values be included in the aggregation results */\n INCLUDE = \"INCLUDE\"\n }\n interface IncludeMissingValuesOptions$1 {\n /** Can specify custom bucket name. Defaults are [string -> \"N/A\"], [int -> \"0\"], [bool -> \"false\"] ... */\n addToBucket?: string;\n }\n enum ScalarType$2 {\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$1 extends ValueAggregationOptionsOneOf$1 {\n /** Options for including missing values */\n includeOptions?: IncludeMissingValuesOptions$1;\n /** Should sort by number of matches or value of the field */\n sortType?: SortType$1;\n /** Should sort in ascending or descending order */\n sortDirection?: SortDirection$1;\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$1;\n }\n /** @oneof */\n interface ValueAggregationOptionsOneOf$1 {\n /** Options for including missing values */\n includeOptions?: IncludeMissingValuesOptions$1;\n }\n enum NestedAggregationType$1 {\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 - e.g. 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$1 {\n /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */\n buckets?: RangeBucket$1[];\n }\n interface ScalarAggregation$1 {\n /** Define the operator for the scalar aggregation */\n type?: ScalarType$2;\n }\n interface DateHistogramAggregation$1 {\n /** Interval for date histogram aggregation */\n interval?: Interval$2;\n }\n enum Interval$2 {\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$1 extends NestedAggregationItemKindOneOf$1 {\n /** Value aggregation */\n value?: ValueAggregation$1;\n /** Range aggregation */\n range?: RangeAggregation$1;\n /** Scalar aggregation */\n scalar?: ScalarAggregation$1;\n /** Date histogram aggregation */\n dateHistogram?: DateHistogramAggregation$1;\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$1;\n /** Field to aggregate by, use dont notation to specify json path */\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationItemKindOneOf$1 {\n /** Value aggregation */\n value?: ValueAggregation$1;\n /** Range aggregation */\n range?: RangeAggregation$1;\n /** Scalar aggregation */\n scalar?: ScalarAggregation$1;\n /** Date histogram aggregation */\n dateHistogram?: DateHistogramAggregation$1;\n }\n enum AggregationType$2 {\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 - e.g. 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$1 {\n /** Flattened list of aggregations, where each next aggregation is nested within previous one */\n nestedAggregations?: NestedAggregationItem$1[];\n }\n interface GroupByAggregation$1 extends GroupByAggregationKindOneOf$1 {\n /** Value aggregation configuration */\n value?: ValueAggregation$1;\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$1 {\n /** Value aggregation configuration */\n value?: ValueAggregation$1;\n }\n interface SearchDetails$2 {\n /** Defines how separate search terms in `expression` are combined */\n mode?: Mode$2;\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 /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */\n fuzzy?: boolean;\n }\n enum Mode$2 {\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 SearchResourcesResponse {\n /** The retrieved resources */\n resources?: Resource$2[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$5;\n /** Aggregation results */\n aggregationData?: AggregationData$2;\n }\n interface AggregationData$2 {\n /** key = aggregation name (as derived from search request) */\n results?: AggregationResults$2[];\n }\n interface ValueAggregationResult$2 {\n /** Value of the field */\n value?: string;\n /** Count of entities with this value */\n count?: number;\n }\n interface RangeAggregationResult$2 {\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$2 extends NestedAggregationResultsResultOneOf$2 {\n /** Value aggregation results */\n values?: ValueResults$2;\n /** Range aggregation results */\n ranges?: RangeResults$2;\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$2;\n /** Field to aggregate by, matches the one provided in request */\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationResultsResultOneOf$2 {\n /** Value aggregation results */\n values?: ValueResults$2;\n /** Range aggregation results */\n ranges?: RangeResults$2;\n /** Scalar aggregation results */\n scalar?: AggregationResultsScalarResult;\n }\n interface ValueResults$2 {\n /** List of value aggregations */\n results?: ValueAggregationResult$2[];\n }\n interface RangeResults$2 {\n /** List of ranges returned in same order as requested */\n results?: RangeAggregationResult$2[];\n }\n interface AggregationResultsScalarResult {\n /** Type of scalar aggregation */\n type?: ScalarType$2;\n /** Value of the scalar aggregation */\n value?: number;\n }\n interface NestedValueAggregationResult$2 {\n /** Value of the field */\n value?: string;\n /** Nested aggregations */\n nestedResults?: NestedAggregationResults$2;\n }\n interface ValueResult$1 {\n /** Value of the field */\n value?: string;\n /** Count of entities with this value */\n count?: number | null;\n }\n interface RangeResult$1 {\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$2 {\n /** Value of the scalar aggregation */\n value?: number;\n }\n interface NestedResultValue$1 extends NestedResultValueResultOneOf$1 {\n /** Value aggregation result */\n value?: ValueResult$1;\n /** Range aggregation result */\n range?: RangeResult$1;\n /** Scalar aggregation result */\n scalar?: ScalarResult$2;\n /** Date histogram aggregation result */\n dateHistogram?: ValueResult$1;\n }\n /** @oneof */\n interface NestedResultValueResultOneOf$1 {\n /** Value aggregation result */\n value?: ValueResult$1;\n /** Range aggregation result */\n range?: RangeResult$1;\n /** Scalar aggregation result */\n scalar?: ScalarResult$2;\n /** Date histogram aggregation result */\n dateHistogram?: ValueResult$1;\n }\n interface Results$1 {\n /** List of nested aggregations */\n results?: Record;\n }\n interface DateHistogramResult$1 {\n /** Date in ISO 8601 format */\n value?: string;\n /** Count of documents in the bucket */\n count?: number;\n }\n interface GroupByValueResults$2 {\n /** List of value aggregations */\n results?: NestedValueAggregationResult$2[];\n }\n interface DateHistogramResults$1 {\n /** List of date histogram aggregations */\n results?: DateHistogramResult$1[];\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$1 {\n /** List of nested aggregations */\n results?: Results$1[];\n }\n interface AggregationResults$2 extends AggregationResultsResultOneOf$2 {\n /** Value aggregation results */\n values?: ValueResults$2;\n /** Range aggregation results */\n ranges?: RangeResults$2;\n /** Scalar aggregation results */\n scalar?: AggregationResultsScalarResult;\n /** Group by value aggregation results */\n groupedByValue?: GroupByValueResults$2;\n /** Date histogram aggregation results */\n dateHistogram?: DateHistogramResults$1;\n /** Nested aggregation results */\n nested?: NestedResults$1;\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$2;\n /** Field to aggregate by as derived from search request */\n fieldPath?: string;\n }\n /** @oneof */\n interface AggregationResultsResultOneOf$2 {\n /** Value aggregation results */\n values?: ValueResults$2;\n /** Range aggregation results */\n ranges?: RangeResults$2;\n /** Scalar aggregation results */\n scalar?: AggregationResultsScalarResult;\n /** Group by value aggregation results */\n groupedByValue?: GroupByValueResults$2;\n /** Date histogram aggregation results */\n dateHistogram?: DateHistogramResults$1;\n /** Nested aggregation results */\n nested?: NestedResults$1;\n }\n interface QueryResourcesRequest {\n /** WQL expression. */\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$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$6[];\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$6;\n }\n interface QueryResourcesResponse {\n /** The retrieved Resources. */\n resources?: Resource$2[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$5;\n }\n interface CountResourcesRequest {\n /** Filter to apply on resources to count. */\n filter?: Record | null;\n /**\n * @deprecated\n * @targetRemovalDate 2024-05-01\n */\n search?: SearchDetails$2;\n }\n interface CountResourcesResponse {\n /** The number of resources matching the given filter. */\n count?: number;\n }\n interface ImportResourceRequest {\n /** Resource to be imported. */\n resource?: Resource$2;\n }\n interface ImportResourceResponse {\n /** The imported resource. */\n resource?: Resource$2;\n }\n interface FixResourceSchedulesRequest {\n /** Id of the resource of which the schedules must be fixed */\n resourceId?: string;\n /** the working hours schedule that must be set for this resource. */\n workingHoursSchedule?: Schedule$2;\n }\n interface FixResourceSchedulesResponse {\n /** The resource with the fixed schedule IDs. */\n resource?: Resource$2;\n }\n interface ReindexTenantRequest {\n }\n interface ReindexTenantResponse {\n }\n interface MetaSiteSpecialEvent$1 extends MetaSiteSpecialEventPayloadOneOf$1 {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated$3;\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 /**\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$1[];\n }\n /** @oneof */\n interface MetaSiteSpecialEventPayloadOneOf$1 {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated$3;\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$3 {\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 * 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 }\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 | null;\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 /** The origin meta site id */\n originMetaSiteId?: 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$3 {\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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$6;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$6 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$6 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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$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$6;\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$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 new resource.\n *\n * By using the create API you can create a resource, set its name, working hours and location details.\n * The system creates an events schedule that contains the sessions in which the resource is booked.\n * @param resource - Resource to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField resource\n * @requiredField resource.name\n * @permissionId BOOKINGS.RESOURCE_CREATE\n * @adminMethod\n * @returns The created resource.\n */\n function createResource(resource: Resource$2): Promise;\n /**\n * Creates multiple resources.\n *\n * By using the bulk create API you can create multiple resources in a single request.\n * To query the created resources in the same order as they were sent in the request sort them by creation date and ID.\n * @param resources - Resources to create.\n * @public\n * @documentationMaturity preview\n * @requiredField resources\n * @requiredField resources.name\n * @permissionId BOOKINGS.RESOURCE_CREATE\n * @adminMethod\n */\n function bulkCreateResources(resources: Resource$2[], options?: BulkCreateResourcesOptions): Promise;\n interface BulkCreateResourcesOptions {\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 resource by id.\n * @param resourceId - Id of the resource to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField resourceId\n * @permissionId BOOKINGS.RESOURCE_READ\n * @adminMethod\n * @returns The retrieved resource.\n */\n function getResource(resourceId: string): Promise;\n /**\n * Retrieves a deleted resource from the trash bin.\n * @param resourceId - Id of the resource to retrieve.\n * @internal\n * @documentationMaturity preview\n * @requiredField resourceId\n * @permissionId BOOKINGS.RESOURCE_READ\n */\n function getDeletedResource(resourceId: string): Promise;\n /**\n * Retrieves a list of deleted resources from the trash bin.\n *\n * List runs with these defaults, which you can override:\n * - `paging.limit` is `50`.\n * @internal\n * @documentationMaturity preview\n * @permissionId BOOKINGS.RESOURCE_READ\n */\n function listDeletedResources(options?: ListDeletedResourcesOptions): Promise;\n interface ListDeletedResourcesOptions {\n /** The ids of the resources to retrieve. */\n resourceIds?: string[];\n /** Paging parameter, enabling to pass a limit and a cursor. */\n paging?: CursorPaging$6;\n }\n /**\n * Removes a resource from the trash bin, permanently deleting it. This action is irreversible.\n * @param resourceId - Id of the resource to remove from the trash bin.\n * @internal\n * @documentationMaturity preview\n * @requiredField resourceId\n * @permissionId BOOKINGS.RESOURCE_REMOVE_FROM_TRASH_BIN\n * @adminMethod\n */\n function removeResourceFromTrashBin(resourceId: string): Promise;\n /**\n * Restores a resource from the trash bin.\n * @param resourceId - Id of the resource to restore from the trash bin.\n * @internal\n * @documentationMaturity preview\n * @requiredField resourceId\n * @permissionId BOOKINGS.RESOURCE_RESTORE_FROM_TRASH_BIN\n * @adminMethod\n */\n function restoreResourceFromTrashBin(resourceId: string): Promise;\n /**\n * Updates a resource.\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 resource is updated, `revision` increments by 1. You must include the current revision of the resource when updating it.\n * This ensures you're working with the latest service information and prevents unintended overwrites.\n * @param _id - Resource ID\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField resource\n * @requiredField resource.revision\n * @permissionId BOOKINGS.RESOURCE_UPDATE\n * @adminMethod\n * @returns The updated resource.\n */\n function updateResource(_id: string | null, resource: UpdateResource, options?: UpdateResourceOptions): Promise;\n interface UpdateResource {\n /**\n * Details of a single resource.\n * @internal\n * @deprecated Details of a single resource.\n * @targetRemovalDate 2025-01-01\n */\n singleResource?: SingleResource;\n /**\n * Resource ID\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the staff member is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the staff member.\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this resource was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this resource was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name of the resource. */\n name?: string | null;\n /**\n * The type of the resource.\n *\n * Resources can be created without a type. However, this field must be set to ensure that a resource can be allocated\n * at a requested time slot and to prevent double bookings.\n *\n * The value to assign to this field depends on how the type is managed. There are 2 options:\n * - The resource type is managed by a user (for example the site owner or contributor) in the Resources section of the\n * dashboard or it is managed via the `/v2/resource-types` endpoint.\n * In this case, the `type` field must be set to the id of the resource type entity.\n * - The resource type is managed by an app implementing the `BOOKINGS_RESOURCE_TYPES_PROVIDER` SPI component.\n * In this case the `type` field must match one of the `id` fields in the `bookingsResourceTypes` structure of the SPI configuration.\n *\n * Once a type has been set it cannot be modified.\n * @deprecated\n * @replacedBy type_id\n * @targetRemovalDate 2025-01-01\n */\n type?: string | null;\n typeId?: string | null;\n /**\n * Schedule details that specify the working hours and locations of this resource.\n *\n * When this field is not set or `working_hours_schedules.enabled` is `false` then the resource is assumed to be\n * available full time (7 x 24) at the locations specified in the field `location_options`.\n * When both `working_hours_schedules` and `location_options` are set then `working_hours_schedules` takes precedence.\n */\n workingHoursSchedules?: ResourceWorkingHoursSchedules;\n /**\n * Location details that specify where this resource is available.\n *\n * If this field is not supplied then `location_options.available_in_all_locations` is set to `true`.\n */\n locationOptions?: LocationOptions$1;\n /**\n * This schedule contains the sessions in which this resource has been booked.\n * @readonly\n */\n eventsSchedule?: EventsSchedule;\n /**\n * The ID of the app of which this resource belongs to.\n * Default: Bookings App ID.\n * @internal\n */\n appId?: string | null;\n /**\n * Specifies whether this resource is managed by a user (site owner, contributor, etc) or by an app.\n * Default: `WIX_USER`.\n * @internal\n */\n managementType?: ManagementType;\n /** Extensions enabling users to save custom data related to the resource. */\n extendedFields?: ExtendedFields$6;\n }\n interface UpdateResourceOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a resource.\n * @param resourceId - Id of the resource to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField resourceId\n * @permissionId BOOKINGS.RESOURCE_DELETE\n * @adminMethod\n */\n function deleteResource(resourceId: string): Promise;\n /**\n * Deletes multiple resources.\n * @param ids - The ids of the resources to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId BOOKINGS.RESOURCE_DELETE\n * @adminMethod\n */\n function bulkDeleteResources(ids: string[]): Promise;\n /**\n * Retrieves a list of resources matching the provided search criteria.\n *\n * The search endpoints allow to perform advanced search including partial text search, exact match, and more.\n * The endpoint also allows to aggregate resources by type, name, app id, management type, management type and location options.\n * @internal\n * @documentationMaturity preview\n * @permissionId BOOKINGS.RESOURCE_READ\n * @adminMethod\n */\n function searchResources(options?: SearchResourcesOptions): Promise;\n interface SearchResourcesOptions {\n /** Search condition */\n search?: CursorSearch$2;\n }\n /**\n * Query resources using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.RESOURCE_READ\n * @adminMethod\n */\n function queryResources(): ResourcesQueryBuilder;\n interface QueryCursorResult$4 {\n cursors: Cursors$6;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface ResourcesQueryResult extends QueryCursorResult$4 {\n items: Resource$2[];\n query: ResourcesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ResourcesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type', value: any) => ResourcesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type', value: any) => ResourcesQueryBuilder;\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) => ResourcesQueryBuilder;\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) => ResourcesQueryBuilder;\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) => ResourcesQueryBuilder;\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) => ResourcesQueryBuilder;\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: 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | 'name' | 'type', value: string) => ResourcesQueryBuilder;\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: 'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type', value: any[]) => ResourcesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type', value: any) => ResourcesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type', value: boolean) => ResourcesQueryBuilder;\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<'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInCustomerLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInCustomLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type' | 'appId' | 'managementType'>) => ResourcesQueryBuilder;\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<'singleResource.locationOptions.availableInAllLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInCustomerLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInCustomLocations' | 'singleResource.locationOptions.specificLocationOptions.availableInBusinessLocations' | 'singleResource.locationOptions.specificLocationOptions.businessLocations.locationId' | '_id' | '_createdDate' | '_updatedDate' | 'name' | 'type' | 'appId' | 'managementType'>) => ResourcesQueryBuilder;\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) => ResourcesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ResourcesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts resources according to given criteria.\n *\n * Use [WQL filter](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section) to define the criteria.\n * @internal\n * @documentationMaturity preview\n * @permissionId BOOKINGS.RESOURCE_READ\n * @adminMethod\n */\n function countResources(options?: CountResourcesOptions): Promise;\n interface CountResourcesOptions {\n /** Filter to apply on resources to count. */\n filter?: Record | null;\n /**\n * @deprecated\n * @targetRemovalDate 2024-05-01\n */\n search?: SearchDetails$2;\n }\n \n type bookingsResourcesV2Resource_universal_d_ResourceCompositionDetailsOneOf = ResourceCompositionDetailsOneOf;\n type bookingsResourcesV2Resource_universal_d_SingleResource = SingleResource;\n type bookingsResourcesV2Resource_universal_d_WorkingHoursSchedules = WorkingHoursSchedules;\n type bookingsResourcesV2Resource_universal_d_ResourceWorkingHoursSchedules = ResourceWorkingHoursSchedules;\n type bookingsResourcesV2Resource_universal_d_EventsSchedule = EventsSchedule;\n type bookingsResourcesV2Resource_universal_d_ManagementType = ManagementType;\n const bookingsResourcesV2Resource_universal_d_ManagementType: typeof ManagementType;\n type bookingsResourcesV2Resource_universal_d_CreateResourceRequest = CreateResourceRequest;\n type bookingsResourcesV2Resource_universal_d_CreateResourceResponse = CreateResourceResponse;\n type bookingsResourcesV2Resource_universal_d_BulkCreateResourcesRequest = BulkCreateResourcesRequest;\n type bookingsResourcesV2Resource_universal_d_BulkCreateResourcesResponse = BulkCreateResourcesResponse;\n type bookingsResourcesV2Resource_universal_d_BulkResourceResult = BulkResourceResult;\n type bookingsResourcesV2Resource_universal_d_GetResourceRequest = GetResourceRequest;\n type bookingsResourcesV2Resource_universal_d_GetResourceResponse = GetResourceResponse;\n type bookingsResourcesV2Resource_universal_d_GetDeletedResourceRequest = GetDeletedResourceRequest;\n type bookingsResourcesV2Resource_universal_d_GetDeletedResourceResponse = GetDeletedResourceResponse;\n type bookingsResourcesV2Resource_universal_d_ListDeletedResourcesRequest = ListDeletedResourcesRequest;\n type bookingsResourcesV2Resource_universal_d_ListDeletedResourcesResponse = ListDeletedResourcesResponse;\n type bookingsResourcesV2Resource_universal_d_RemoveResourceFromTrashBinRequest = RemoveResourceFromTrashBinRequest;\n type bookingsResourcesV2Resource_universal_d_RemoveResourceFromTrashBinResponse = RemoveResourceFromTrashBinResponse;\n type bookingsResourcesV2Resource_universal_d_RestoreResourceFromTrashBinRequest = RestoreResourceFromTrashBinRequest;\n type bookingsResourcesV2Resource_universal_d_RestoreResourceFromTrashBinResponse = RestoreResourceFromTrashBinResponse;\n type bookingsResourcesV2Resource_universal_d_UpdateResourceRequest = UpdateResourceRequest;\n type bookingsResourcesV2Resource_universal_d_UpdateResourceResponse = UpdateResourceResponse;\n type bookingsResourcesV2Resource_universal_d_DeleteResourceRequest = DeleteResourceRequest;\n type bookingsResourcesV2Resource_universal_d_DeleteResourceResponse = DeleteResourceResponse;\n type bookingsResourcesV2Resource_universal_d_BulkDeleteResourcesRequest = BulkDeleteResourcesRequest;\n type bookingsResourcesV2Resource_universal_d_BulkDeleteResourcesResponse = BulkDeleteResourcesResponse;\n type bookingsResourcesV2Resource_universal_d_SearchResourcesRequest = SearchResourcesRequest;\n type bookingsResourcesV2Resource_universal_d_SearchResourcesResponse = SearchResourcesResponse;\n type bookingsResourcesV2Resource_universal_d_AggregationResultsScalarResult = AggregationResultsScalarResult;\n type bookingsResourcesV2Resource_universal_d_QueryResourcesRequest = QueryResourcesRequest;\n type bookingsResourcesV2Resource_universal_d_QueryResourcesResponse = QueryResourcesResponse;\n type bookingsResourcesV2Resource_universal_d_CountResourcesRequest = CountResourcesRequest;\n type bookingsResourcesV2Resource_universal_d_CountResourcesResponse = CountResourcesResponse;\n type bookingsResourcesV2Resource_universal_d_ImportResourceRequest = ImportResourceRequest;\n type bookingsResourcesV2Resource_universal_d_ImportResourceResponse = ImportResourceResponse;\n type bookingsResourcesV2Resource_universal_d_FixResourceSchedulesRequest = FixResourceSchedulesRequest;\n type bookingsResourcesV2Resource_universal_d_FixResourceSchedulesResponse = FixResourceSchedulesResponse;\n type bookingsResourcesV2Resource_universal_d_ReindexTenantRequest = ReindexTenantRequest;\n type bookingsResourcesV2Resource_universal_d_ReindexTenantResponse = ReindexTenantResponse;\n const bookingsResourcesV2Resource_universal_d_createResource: typeof createResource;\n const bookingsResourcesV2Resource_universal_d_bulkCreateResources: typeof bulkCreateResources;\n type bookingsResourcesV2Resource_universal_d_BulkCreateResourcesOptions = BulkCreateResourcesOptions;\n const bookingsResourcesV2Resource_universal_d_getResource: typeof getResource;\n const bookingsResourcesV2Resource_universal_d_getDeletedResource: typeof getDeletedResource;\n const bookingsResourcesV2Resource_universal_d_listDeletedResources: typeof listDeletedResources;\n type bookingsResourcesV2Resource_universal_d_ListDeletedResourcesOptions = ListDeletedResourcesOptions;\n const bookingsResourcesV2Resource_universal_d_removeResourceFromTrashBin: typeof removeResourceFromTrashBin;\n const bookingsResourcesV2Resource_universal_d_restoreResourceFromTrashBin: typeof restoreResourceFromTrashBin;\n const bookingsResourcesV2Resource_universal_d_updateResource: typeof updateResource;\n type bookingsResourcesV2Resource_universal_d_UpdateResource = UpdateResource;\n type bookingsResourcesV2Resource_universal_d_UpdateResourceOptions = UpdateResourceOptions;\n const bookingsResourcesV2Resource_universal_d_deleteResource: typeof deleteResource;\n const bookingsResourcesV2Resource_universal_d_bulkDeleteResources: typeof bulkDeleteResources;\n const bookingsResourcesV2Resource_universal_d_searchResources: typeof searchResources;\n type bookingsResourcesV2Resource_universal_d_SearchResourcesOptions = SearchResourcesOptions;\n const bookingsResourcesV2Resource_universal_d_queryResources: typeof queryResources;\n type bookingsResourcesV2Resource_universal_d_ResourcesQueryResult = ResourcesQueryResult;\n type bookingsResourcesV2Resource_universal_d_ResourcesQueryBuilder = ResourcesQueryBuilder;\n const bookingsResourcesV2Resource_universal_d_countResources: typeof countResources;\n type bookingsResourcesV2Resource_universal_d_CountResourcesOptions = CountResourcesOptions;\n namespace bookingsResourcesV2Resource_universal_d {\n export {\n Resource$2 as Resource,\n bookingsResourcesV2Resource_universal_d_ResourceCompositionDetailsOneOf as ResourceCompositionDetailsOneOf,\n WorkingHoursSchedule$1 as WorkingHoursSchedule,\n bookingsResourcesV2Resource_universal_d_SingleResource as SingleResource,\n bookingsResourcesV2Resource_universal_d_WorkingHoursSchedules as WorkingHoursSchedules,\n Schedule$2 as Schedule,\n LocationOptions$1 as LocationOptions,\n SpecificLocation$1 as SpecificLocation,\n BusinessLocation$2 as BusinessLocation,\n bookingsResourcesV2Resource_universal_d_ResourceWorkingHoursSchedules as ResourceWorkingHoursSchedules,\n bookingsResourcesV2Resource_universal_d_EventsSchedule as EventsSchedule,\n bookingsResourcesV2Resource_universal_d_ManagementType as ManagementType,\n ExtendedFields$6 as ExtendedFields,\n bookingsResourcesV2Resource_universal_d_CreateResourceRequest as CreateResourceRequest,\n bookingsResourcesV2Resource_universal_d_CreateResourceResponse as CreateResourceResponse,\n bookingsResourcesV2Resource_universal_d_BulkCreateResourcesRequest as BulkCreateResourcesRequest,\n bookingsResourcesV2Resource_universal_d_BulkCreateResourcesResponse as BulkCreateResourcesResponse,\n bookingsResourcesV2Resource_universal_d_BulkResourceResult as BulkResourceResult,\n ItemMetadata$3 as ItemMetadata,\n ApplicationError$3 as ApplicationError,\n BulkActionMetadata$3 as BulkActionMetadata,\n bookingsResourcesV2Resource_universal_d_GetResourceRequest as GetResourceRequest,\n bookingsResourcesV2Resource_universal_d_GetResourceResponse as GetResourceResponse,\n bookingsResourcesV2Resource_universal_d_GetDeletedResourceRequest as GetDeletedResourceRequest,\n bookingsResourcesV2Resource_universal_d_GetDeletedResourceResponse as GetDeletedResourceResponse,\n bookingsResourcesV2Resource_universal_d_ListDeletedResourcesRequest as ListDeletedResourcesRequest,\n CursorPaging$6 as CursorPaging,\n bookingsResourcesV2Resource_universal_d_ListDeletedResourcesResponse as ListDeletedResourcesResponse,\n CursorPagingMetadata$5 as CursorPagingMetadata,\n Cursors$6 as Cursors,\n bookingsResourcesV2Resource_universal_d_RemoveResourceFromTrashBinRequest as RemoveResourceFromTrashBinRequest,\n bookingsResourcesV2Resource_universal_d_RemoveResourceFromTrashBinResponse as RemoveResourceFromTrashBinResponse,\n bookingsResourcesV2Resource_universal_d_RestoreResourceFromTrashBinRequest as RestoreResourceFromTrashBinRequest,\n bookingsResourcesV2Resource_universal_d_RestoreResourceFromTrashBinResponse as RestoreResourceFromTrashBinResponse,\n bookingsResourcesV2Resource_universal_d_UpdateResourceRequest as UpdateResourceRequest,\n bookingsResourcesV2Resource_universal_d_UpdateResourceResponse as UpdateResourceResponse,\n bookingsResourcesV2Resource_universal_d_DeleteResourceRequest as DeleteResourceRequest,\n bookingsResourcesV2Resource_universal_d_DeleteResourceResponse as DeleteResourceResponse,\n bookingsResourcesV2Resource_universal_d_BulkDeleteResourcesRequest as BulkDeleteResourcesRequest,\n bookingsResourcesV2Resource_universal_d_BulkDeleteResourcesResponse as BulkDeleteResourcesResponse,\n bookingsResourcesV2Resource_universal_d_SearchResourcesRequest as SearchResourcesRequest,\n CursorSearch$2 as CursorSearch,\n CursorSearchPagingMethodOneOf$2 as CursorSearchPagingMethodOneOf,\n Sorting$6 as Sorting,\n SortOrder$6 as SortOrder,\n Aggregation$1 as Aggregation,\n AggregationKindOneOf$1 as AggregationKindOneOf,\n RangeBucket$1 as RangeBucket,\n SortType$1 as SortType,\n SortDirection$1 as SortDirection,\n MissingValues$1 as MissingValues,\n IncludeMissingValuesOptions$1 as IncludeMissingValuesOptions,\n ScalarType$2 as ScalarType,\n ValueAggregation$1 as ValueAggregation,\n ValueAggregationOptionsOneOf$1 as ValueAggregationOptionsOneOf,\n NestedAggregationType$1 as NestedAggregationType,\n RangeAggregation$1 as RangeAggregation,\n ScalarAggregation$1 as ScalarAggregation,\n DateHistogramAggregation$1 as DateHistogramAggregation,\n Interval$2 as Interval,\n NestedAggregationItem$1 as NestedAggregationItem,\n NestedAggregationItemKindOneOf$1 as NestedAggregationItemKindOneOf,\n AggregationType$2 as AggregationType,\n NestedAggregation$1 as NestedAggregation,\n GroupByAggregation$1 as GroupByAggregation,\n GroupByAggregationKindOneOf$1 as GroupByAggregationKindOneOf,\n SearchDetails$2 as SearchDetails,\n Mode$2 as Mode,\n bookingsResourcesV2Resource_universal_d_SearchResourcesResponse as SearchResourcesResponse,\n AggregationData$2 as AggregationData,\n ValueAggregationResult$2 as ValueAggregationResult,\n RangeAggregationResult$2 as RangeAggregationResult,\n NestedAggregationResults$2 as NestedAggregationResults,\n NestedAggregationResultsResultOneOf$2 as NestedAggregationResultsResultOneOf,\n ValueResults$2 as ValueResults,\n RangeResults$2 as RangeResults,\n bookingsResourcesV2Resource_universal_d_AggregationResultsScalarResult as AggregationResultsScalarResult,\n NestedValueAggregationResult$2 as NestedValueAggregationResult,\n ValueResult$1 as ValueResult,\n RangeResult$1 as RangeResult,\n ScalarResult$2 as ScalarResult,\n NestedResultValue$1 as NestedResultValue,\n NestedResultValueResultOneOf$1 as NestedResultValueResultOneOf,\n Results$1 as Results,\n DateHistogramResult$1 as DateHistogramResult,\n GroupByValueResults$2 as GroupByValueResults,\n DateHistogramResults$1 as DateHistogramResults,\n NestedResults$1 as NestedResults,\n AggregationResults$2 as AggregationResults,\n AggregationResultsResultOneOf$2 as AggregationResultsResultOneOf,\n bookingsResourcesV2Resource_universal_d_QueryResourcesRequest as QueryResourcesRequest,\n CursorQuery$4 as CursorQuery,\n CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf,\n bookingsResourcesV2Resource_universal_d_QueryResourcesResponse as QueryResourcesResponse,\n bookingsResourcesV2Resource_universal_d_CountResourcesRequest as CountResourcesRequest,\n bookingsResourcesV2Resource_universal_d_CountResourcesResponse as CountResourcesResponse,\n bookingsResourcesV2Resource_universal_d_ImportResourceRequest as ImportResourceRequest,\n bookingsResourcesV2Resource_universal_d_ImportResourceResponse as ImportResourceResponse,\n bookingsResourcesV2Resource_universal_d_FixResourceSchedulesRequest as FixResourceSchedulesRequest,\n bookingsResourcesV2Resource_universal_d_FixResourceSchedulesResponse as FixResourceSchedulesResponse,\n bookingsResourcesV2Resource_universal_d_ReindexTenantRequest as ReindexTenantRequest,\n bookingsResourcesV2Resource_universal_d_ReindexTenantResponse as ReindexTenantResponse,\n MetaSiteSpecialEvent$1 as MetaSiteSpecialEvent,\n MetaSiteSpecialEventPayloadOneOf$1 as MetaSiteSpecialEventPayloadOneOf,\n Asset$1 as Asset,\n State$1 as State,\n SiteCreated$3 as SiteCreated,\n SiteCreatedContext$1 as SiteCreatedContext,\n Namespace$1 as Namespace,\n SiteTransferred$1 as SiteTransferred,\n SiteDeleted$1 as SiteDeleted,\n DeleteContext$1 as DeleteContext,\n DeleteStatus$1 as DeleteStatus,\n SiteUndeleted$1 as SiteUndeleted,\n SitePublished$1 as SitePublished,\n SiteUnpublished$1 as SiteUnpublished,\n SiteMarkedAsTemplate$1 as SiteMarkedAsTemplate,\n SiteMarkedAsWixSite$1 as SiteMarkedAsWixSite,\n ServiceProvisioned$1 as ServiceProvisioned,\n ServiceRemoved$1 as ServiceRemoved,\n SiteRenamed$1 as SiteRenamed,\n SiteHardDeleted$1 as SiteHardDeleted,\n NamespaceChanged$1 as NamespaceChanged,\n StudioAssigned$1 as StudioAssigned,\n StudioUnassigned$1 as StudioUnassigned,\n Empty$3 as Empty,\n DomainEvent$6 as DomainEvent,\n DomainEventBodyOneOf$6 as DomainEventBodyOneOf,\n EntityCreatedEvent$6 as EntityCreatedEvent,\n RestoreInfo$6 as RestoreInfo,\n EntityUpdatedEvent$6 as EntityUpdatedEvent,\n EntityDeletedEvent$6 as EntityDeletedEvent,\n ActionEvent$6 as ActionEvent,\n MessageEnvelope$6 as MessageEnvelope,\n IdentificationData$7 as IdentificationData,\n IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf,\n WebhookIdentityType$6 as WebhookIdentityType,\n bookingsResourcesV2Resource_universal_d_createResource as createResource,\n bookingsResourcesV2Resource_universal_d_bulkCreateResources as bulkCreateResources,\n bookingsResourcesV2Resource_universal_d_BulkCreateResourcesOptions as BulkCreateResourcesOptions,\n bookingsResourcesV2Resource_universal_d_getResource as getResource,\n bookingsResourcesV2Resource_universal_d_getDeletedResource as getDeletedResource,\n bookingsResourcesV2Resource_universal_d_listDeletedResources as listDeletedResources,\n bookingsResourcesV2Resource_universal_d_ListDeletedResourcesOptions as ListDeletedResourcesOptions,\n bookingsResourcesV2Resource_universal_d_removeResourceFromTrashBin as removeResourceFromTrashBin,\n bookingsResourcesV2Resource_universal_d_restoreResourceFromTrashBin as restoreResourceFromTrashBin,\n bookingsResourcesV2Resource_universal_d_updateResource as updateResource,\n bookingsResourcesV2Resource_universal_d_UpdateResource as UpdateResource,\n bookingsResourcesV2Resource_universal_d_UpdateResourceOptions as UpdateResourceOptions,\n bookingsResourcesV2Resource_universal_d_deleteResource as deleteResource,\n bookingsResourcesV2Resource_universal_d_bulkDeleteResources as bulkDeleteResources,\n bookingsResourcesV2Resource_universal_d_searchResources as searchResources,\n bookingsResourcesV2Resource_universal_d_SearchResourcesOptions as SearchResourcesOptions,\n bookingsResourcesV2Resource_universal_d_queryResources as queryResources,\n bookingsResourcesV2Resource_universal_d_ResourcesQueryResult as ResourcesQueryResult,\n bookingsResourcesV2Resource_universal_d_ResourcesQueryBuilder as ResourcesQueryBuilder,\n bookingsResourcesV2Resource_universal_d_countResources as countResources,\n bookingsResourcesV2Resource_universal_d_CountResourcesOptions as CountResourcesOptions,\n };\n }\n \n /** A ResourceType is a classification of resources, e.g. room, equipment or vehicle. */\n interface ResourceType$1 {\n /**\n * ResourceType ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of this resource type.\n * Each time the resource type is modified, its `revision` changes by the server.\n * For an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this resource type was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this resource type was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** The name of this resource type, for example `meeting room`. The name must be unique per site. */\n name?: string | null;\n /**\n * The ID of the app of which the resources of this type belong to. Default: Bookings App ID.\n * @internal\n */\n appId?: string | null;\n /**\n * Aggregation data about counts of resources that have this type.\n * @internal\n * @readonly\n */\n resourceCounts?: ResourceCounts;\n /** Extensions enabling users to save custom data related to the resource type. */\n extendedFields?: ExtendedFields$5;\n }\n interface ResourceCounts {\n /**\n * The number of resources that have this type.\n * @readonly\n */\n total?: number | null;\n /**\n * Whether a resource of this type exists that is available in all locations\n * @readonly\n */\n hasResourcesInAllLocations?: boolean | null;\n /**\n * Whether a resource of this type exists that is available in any customer location\n * @readonly\n */\n hasResourcesInCustomerLocations?: boolean | null;\n /**\n * Whether a resource of this type exists that is available in any custom location\n * @readonly\n */\n hasResourcesInCustomLocations?: boolean | null;\n /**\n * Number of distinct business locations of resources with this type.\n * @readonly\n */\n distinctBusinessLocationsCount?: number | null;\n /**\n * Distinct business location ids of resources with this type. Only first 50 are returned.\n * @readonly\n */\n distinctLocationIds?: DistinctLocationIds;\n }\n interface DistinctLocationIds {\n /** Locations ids of business locations */\n values?: 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 CreateResourceTypeRequest {\n /** Resource type to be created. */\n resourceType: ResourceType$1;\n /**\n * The number of resources that must be created initially for this type\n * @internal\n */\n quantity?: number;\n /**\n * Locations where created resources are available\n * @internal\n */\n locationOptions?: LocationOptions;\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n interface LocationOptions {\n /**\n * `true` if the resource is available in all locations, `false` if the resource is available only in specific locations.\n * Default: `false`.\n */\n availableInAllLocations?: boolean | null;\n /**\n * Details of specific locations. It must be left empty if `available_in_all_locations` is `true`.\n * If supplied then the field `specific_location_options.available_in_business_locations` must be set to `true`.\n */\n specificLocationOptions?: SpecificLocation;\n }\n interface SpecificLocation {\n /**\n * `true` if the resource can be used at a customer selected location, `false` otherwise.\n * Read more about locations in this [article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations).\n * Default: `false`.\n * @internal\n */\n availableInCustomerLocations?: boolean | null;\n /**\n * `true` if the resource is available in custom locations, `false` otherwise.\n * Default: `false`.\n * @internal\n */\n availableInCustomLocations?: boolean | null;\n /**\n * `true` if the resource is available in some business locations, `false` otherwise.\n * Default: `false`.\n */\n availableInBusinessLocations?: boolean | null;\n /**\n * Information about business locations. Should be empty if `available_in_business_locations` is `false` or if no business location exists in Locations.\n * Currently a single business location can be set.\n * Read more about business locations in this [article](https://dev.wix.com/docs/rest/business-management/locations/introduction).\n */\n businessLocations?: BusinessLocation$1[];\n }\n interface BusinessLocation$1 {\n /** The ID of the business location. Must not be empty. */\n locationId?: string | null;\n }\n enum RequestedFields$2 {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n TOTAL_RESOURCE_COUNT = \"TOTAL_RESOURCE_COUNT\",\n SPECIFIC_LOCATION_TYPE_RESOURCE_COUNTS = \"SPECIFIC_LOCATION_TYPE_RESOURCE_COUNTS\",\n DISTINCT_RESOURCE_LOCATIONS = \"DISTINCT_RESOURCE_LOCATIONS\"\n }\n interface CreateResourceTypeResponse {\n /** The created resource type. */\n resourceType?: ResourceType$1;\n /**\n * Partial errors. ResourceType entity was created but requested dependant entities were not.\n * @internal\n */\n partialErrors?: CreateResourceTypeErrors[];\n }\n enum CreateResourceTypeErrors {\n UNKNOWN_CREATE_RESOURCE_TYPE_ERROR = \"UNKNOWN_CREATE_RESOURCE_TYPE_ERROR\",\n /** Failed to create requested `quantity` of resources for the resource type */\n FAILED_TO_CREATE_RESOURCES = \"FAILED_TO_CREATE_RESOURCES\"\n }\n interface GetResourceTypeRequest {\n /** ID of the resource type to retrieve. */\n resourceTypeId: string;\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n interface GetResourceTypeResponse {\n /** The requested resource type. */\n resourceType?: ResourceType$1;\n }\n interface UpdateResourceTypeRequest {\n /** Resource type to update. [Partial updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests) are supported. */\n resourceType: ResourceType$1;\n /**\n * Set of fields to update.\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * See [Field Masks in Update Requests][1] for details on working with field masks.\n * [1]: https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests\n * @internal\n */\n mask?: string[];\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n interface UpdateResourceTypeResponse {\n /** Updated resource type. */\n resourceType?: ResourceType$1;\n }\n interface DeleteResourceTypeRequest {\n /** ID of the resource type to delete. */\n resourceTypeId: string;\n }\n interface DeleteResourceTypeResponse {\n }\n interface QueryResourceTypesRequest {\n /** WQL expression. */\n query?: CursorQuery$3;\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\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$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$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$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 /** 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 QueryResourceTypesResponse {\n /** The retrieved resource types. */\n resourceTypes?: ResourceType$1[];\n /** Paging metadata, including offset and count. */\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$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 /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface CountResourceTypesRequest {\n /** Filter to apply on resource types to count. */\n filter?: Record | null;\n }\n interface CountResourceTypesResponse {\n /** The number of resource types matching the given filter. */\n count?: number;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$5 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\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$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$5;\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$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 ResourceType.\n *\n * By using the create API, you can create a resource type and set its name and the ID of the app it belongs to.\n * @param resourceType - Resource type to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField resourceType\n * @requiredField resourceType.name\n * @permissionId BOOKINGS.RESOURCE_TYPE_CREATE\n * @adminMethod\n * @returns The created resource type.\n */\n function createResourceType(resourceType: ResourceType$1, options?: CreateResourceTypeOptions): Promise;\n interface CreateResourceTypeOptions {\n /**\n * The number of resources that must be created initially for this type\n * @internal\n */\n quantity?: number;\n /**\n * Locations where created resources are available\n * @internal\n */\n locationOptions?: LocationOptions;\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n /**\n * Retrieves a ResourceType by ID.\n * @param resourceTypeId - ID of the resource type to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField resourceTypeId\n * @permissionId BOOKINGS.RESOURCE_TYPE_READ\n * @permissionId BOOKINGS.RESOURCES_READ\n * @returns The requested resource type.\n */\n function getResourceType(resourceTypeId: string, options?: GetResourceTypeOptions): Promise;\n interface GetResourceTypeOptions {\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n /**\n * Updates a ResourceType.\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 resource type is updated, `revision` increments by 1. You must include current revision of the resource type when updating it.\n * This ensures you're working with the latest service information and prevents unintended overwrites.\n * @param _id - ResourceType ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField resourceType\n * @requiredField resourceType.revision\n * @permissionId BOOKINGS.RESOURCE_TYPE_UPDATE\n * @adminMethod\n * @returns Updated resource type.\n */\n function updateResourceType(_id: string | null, resourceType: UpdateResourceType, options?: UpdateResourceTypeOptions): Promise;\n interface UpdateResourceType {\n /**\n * ResourceType ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the current state of this resource type.\n * Each time the resource type is modified, its `revision` changes by the server.\n * For an update operation to succeed, you MUST pass the latest revision.\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this resource type was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this resource type was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** The name of this resource type, for example `meeting room`. The name must be unique per site. */\n name?: string | null;\n /**\n * The ID of the app of which the resources of this type belong to. Default: Bookings App ID.\n * @internal\n */\n appId?: string | null;\n /**\n * Aggregation data about counts of resources that have this type.\n * @internal\n * @readonly\n */\n resourceCounts?: ResourceCounts;\n /** Extensions enabling users to save custom data related to the resource type. */\n extendedFields?: ExtendedFields$5;\n }\n interface UpdateResourceTypeOptions {\n /**\n * Set of fields to update.\n * Fields that aren't included in `fieldMask.paths` are ignored.\n * See [Field Masks in Update Requests][1] for details on working with field masks.\n * [1]: https://dev.wix.com/api/rest/contacts/contacts/field-masks-in-update-requests\n * @internal\n */\n mask?: string[];\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[];\n }\n /**\n * Deletes a ResourceType.\n * @param resourceTypeId - ID of the resource type to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField resourceTypeId\n * @permissionId BOOKINGS.RESOURCE_TYPE_DELETE\n * @adminMethod\n */\n function deleteResourceType(resourceTypeId: string): Promise;\n /**\n * Queries resource types, given the provided [paging, filtering, and sorting][1].\n *\n * Up to 100 resource types can be returned per request.\n *\n * To learn how to query ResourceTypes, 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 * @permissionId BOOKINGS.RESOURCE_TYPE_READ\n */\n function queryResourceTypes(options?: QueryResourceTypesOptions): ResourceTypesQueryBuilder;\n interface QueryResourceTypesOptions {\n /**\n * List of additional fields to be included in the response.\n * @internal\n */\n fields?: RequestedFields$2[] | 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 ResourceTypesQueryResult extends QueryCursorResult$3 {\n items: ResourceType$1[];\n query: ResourceTypesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface ResourceTypesQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'name', value: any) => ResourceTypesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'name', value: any) => ResourceTypesQueryBuilder;\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', value: string) => ResourceTypesQueryBuilder;\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: 'name', value: any[]) => ResourceTypesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'name', value: any) => ResourceTypesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'name', value: boolean) => ResourceTypesQueryBuilder;\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) => ResourceTypesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => ResourceTypesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts resource types according to given criteria.\n *\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 * @permissionId BOOKINGS.RESOURCE_TYPE_READ\n */\n function countResourceTypes(options?: CountResourceTypesOptions): Promise;\n interface CountResourceTypesOptions {\n /** Filter to apply on resource types to count. */\n filter?: Record | null;\n }\n \n type bookingsResourcesV2ResourceType_universal_d_ResourceCounts = ResourceCounts;\n type bookingsResourcesV2ResourceType_universal_d_DistinctLocationIds = DistinctLocationIds;\n type bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeRequest = CreateResourceTypeRequest;\n type bookingsResourcesV2ResourceType_universal_d_LocationOptions = LocationOptions;\n type bookingsResourcesV2ResourceType_universal_d_SpecificLocation = SpecificLocation;\n type bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeResponse = CreateResourceTypeResponse;\n type bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeErrors = CreateResourceTypeErrors;\n const bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeErrors: typeof CreateResourceTypeErrors;\n type bookingsResourcesV2ResourceType_universal_d_GetResourceTypeRequest = GetResourceTypeRequest;\n type bookingsResourcesV2ResourceType_universal_d_GetResourceTypeResponse = GetResourceTypeResponse;\n type bookingsResourcesV2ResourceType_universal_d_UpdateResourceTypeRequest = UpdateResourceTypeRequest;\n type bookingsResourcesV2ResourceType_universal_d_UpdateResourceTypeResponse = UpdateResourceTypeResponse;\n type bookingsResourcesV2ResourceType_universal_d_DeleteResourceTypeRequest = DeleteResourceTypeRequest;\n type bookingsResourcesV2ResourceType_universal_d_DeleteResourceTypeResponse = DeleteResourceTypeResponse;\n type bookingsResourcesV2ResourceType_universal_d_QueryResourceTypesRequest = QueryResourceTypesRequest;\n type bookingsResourcesV2ResourceType_universal_d_QueryResourceTypesResponse = QueryResourceTypesResponse;\n type bookingsResourcesV2ResourceType_universal_d_CountResourceTypesRequest = CountResourceTypesRequest;\n type bookingsResourcesV2ResourceType_universal_d_CountResourceTypesResponse = CountResourceTypesResponse;\n const bookingsResourcesV2ResourceType_universal_d_createResourceType: typeof createResourceType;\n type bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeOptions = CreateResourceTypeOptions;\n const bookingsResourcesV2ResourceType_universal_d_getResourceType: typeof getResourceType;\n type bookingsResourcesV2ResourceType_universal_d_GetResourceTypeOptions = GetResourceTypeOptions;\n const bookingsResourcesV2ResourceType_universal_d_updateResourceType: typeof updateResourceType;\n type bookingsResourcesV2ResourceType_universal_d_UpdateResourceType = UpdateResourceType;\n type bookingsResourcesV2ResourceType_universal_d_UpdateResourceTypeOptions = UpdateResourceTypeOptions;\n const bookingsResourcesV2ResourceType_universal_d_deleteResourceType: typeof deleteResourceType;\n const bookingsResourcesV2ResourceType_universal_d_queryResourceTypes: typeof queryResourceTypes;\n type bookingsResourcesV2ResourceType_universal_d_QueryResourceTypesOptions = QueryResourceTypesOptions;\n type bookingsResourcesV2ResourceType_universal_d_ResourceTypesQueryResult = ResourceTypesQueryResult;\n type bookingsResourcesV2ResourceType_universal_d_ResourceTypesQueryBuilder = ResourceTypesQueryBuilder;\n const bookingsResourcesV2ResourceType_universal_d_countResourceTypes: typeof countResourceTypes;\n type bookingsResourcesV2ResourceType_universal_d_CountResourceTypesOptions = CountResourceTypesOptions;\n namespace bookingsResourcesV2ResourceType_universal_d {\n export {\n ResourceType$1 as ResourceType,\n bookingsResourcesV2ResourceType_universal_d_ResourceCounts as ResourceCounts,\n bookingsResourcesV2ResourceType_universal_d_DistinctLocationIds as DistinctLocationIds,\n ExtendedFields$5 as ExtendedFields,\n bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeRequest as CreateResourceTypeRequest,\n bookingsResourcesV2ResourceType_universal_d_LocationOptions as LocationOptions,\n bookingsResourcesV2ResourceType_universal_d_SpecificLocation as SpecificLocation,\n BusinessLocation$1 as BusinessLocation,\n RequestedFields$2 as RequestedFields,\n bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeResponse as CreateResourceTypeResponse,\n bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeErrors as CreateResourceTypeErrors,\n bookingsResourcesV2ResourceType_universal_d_GetResourceTypeRequest as GetResourceTypeRequest,\n bookingsResourcesV2ResourceType_universal_d_GetResourceTypeResponse as GetResourceTypeResponse,\n bookingsResourcesV2ResourceType_universal_d_UpdateResourceTypeRequest as UpdateResourceTypeRequest,\n bookingsResourcesV2ResourceType_universal_d_UpdateResourceTypeResponse as UpdateResourceTypeResponse,\n bookingsResourcesV2ResourceType_universal_d_DeleteResourceTypeRequest as DeleteResourceTypeRequest,\n bookingsResourcesV2ResourceType_universal_d_DeleteResourceTypeResponse as DeleteResourceTypeResponse,\n bookingsResourcesV2ResourceType_universal_d_QueryResourceTypesRequest as QueryResourceTypesRequest,\n CursorQuery$3 as CursorQuery,\n CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf,\n Sorting$5 as Sorting,\n SortOrder$5 as SortOrder,\n CursorPaging$5 as CursorPaging,\n bookingsResourcesV2ResourceType_universal_d_QueryResourceTypesResponse as QueryResourceTypesResponse,\n CursorPagingMetadata$4 as CursorPagingMetadata,\n Cursors$5 as Cursors,\n bookingsResourcesV2ResourceType_universal_d_CountResourceTypesRequest as CountResourceTypesRequest,\n bookingsResourcesV2ResourceType_universal_d_CountResourceTypesResponse as CountResourceTypesResponse,\n DomainEvent$5 as DomainEvent,\n DomainEventBodyOneOf$5 as DomainEventBodyOneOf,\n EntityCreatedEvent$5 as EntityCreatedEvent,\n RestoreInfo$5 as RestoreInfo,\n EntityUpdatedEvent$5 as EntityUpdatedEvent,\n EntityDeletedEvent$5 as EntityDeletedEvent,\n ActionEvent$5 as ActionEvent,\n MessageEnvelope$5 as MessageEnvelope,\n IdentificationData$6 as IdentificationData,\n IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf,\n WebhookIdentityType$5 as WebhookIdentityType,\n bookingsResourcesV2ResourceType_universal_d_createResourceType as createResourceType,\n bookingsResourcesV2ResourceType_universal_d_CreateResourceTypeOptions as CreateResourceTypeOptions,\n bookingsResourcesV2ResourceType_universal_d_getResourceType as getResourceType,\n bookingsResourcesV2ResourceType_universal_d_GetResourceTypeOptions as GetResourceTypeOptions,\n bookingsResourcesV2ResourceType_universal_d_updateResourceType as updateResourceType,\n bookingsResourcesV2ResourceType_universal_d_UpdateResourceType as UpdateResourceType,\n bookingsResourcesV2ResourceType_universal_d_UpdateResourceTypeOptions as UpdateResourceTypeOptions,\n bookingsResourcesV2ResourceType_universal_d_deleteResourceType as deleteResourceType,\n bookingsResourcesV2ResourceType_universal_d_queryResourceTypes as queryResourceTypes,\n bookingsResourcesV2ResourceType_universal_d_QueryResourceTypesOptions as QueryResourceTypesOptions,\n bookingsResourcesV2ResourceType_universal_d_ResourceTypesQueryResult as ResourceTypesQueryResult,\n bookingsResourcesV2ResourceType_universal_d_ResourceTypesQueryBuilder as ResourceTypesQueryBuilder,\n bookingsResourcesV2ResourceType_universal_d_countResourceTypes as countResourceTypes,\n bookingsResourcesV2ResourceType_universal_d_CountResourceTypesOptions as CountResourceTypesOptions,\n };\n }\n \n /** The `Service` object represents 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 /** Service type. */\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;\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?: Location$3[];\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?: Schedule$1;\n /** IDs of the staff members providing the service. For appointments only. */\n staffMemberIds?: string[];\n /**\n * Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was passed.\n * @internal\n * @readonly\n * @deprecated Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was passed.\n * @replacedBy staff_member_details.staff_members\n * @targetRemovalDate 2025-01-01\n */\n staffMembers?: StaffMember$1[];\n /**\n * Staff members details. Returned only if `STAFF_MEMBER_DETAILS` conditional field was passed.\n * @internal\n */\n staffMemberDetails?: StaffMemberDetails;\n /**\n * Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named \"rooms\".\n * @internal\n * @deprecated Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named \"rooms\".\n * @replacedBy service_resources\n * @targetRemovalDate 2024-08-19\n */\n resourceGroups?: ResourceGroup[];\n /**\n * Details on resources that are required to book the service. For example, to book this service, you must book a room out of the resource type named \"rooms\".\n * @internal\n */\n serviceResources?: ServiceResource[];\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 /** Extensions enabling users to save custom data related to the service. */\n extendedFields?: ExtendedFields$4;\n /** Custom SEO data for the service. */\n seoData?: SeoSchema;\n /**\n * Date and time the service was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the service was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 {\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 {\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 {\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 * Settings that apply to the service booking form on mobile clients.\n * @internal\n */\n mobileSettings?: FormSettings;\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;\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?: CommonMoney;\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?: CommonMoney;\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 /**\n * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n * @readonly\n */\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?: CommonMoney;\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?: CommonMoney;\n /**\n * The minimal price a customer may pay for this service, based on its variants.\n * @readonly\n */\n minPrice?: CommonMoney;\n /**\n * The maximum price a customer may pay for this service, based on its variants.\n * @readonly\n */\n maxPrice?: CommonMoney;\n }\n interface PaymentOptions {\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 Location$3 extends LocationOptionsOneOf {\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 * A reflection of the id of the location.\n * @readonly\n */\n _id?: string;\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, as defined for the by the Business Info [Locations API](https://www.wix.com/velo/reference/wix-business-tools-v2/locations).\n * - `CUSTOMER`: Will be determined by the customer. For appointments only.\n */\n type?: LocationType$3;\n /**\n * The location address, based on the location `type`. If `type` is `CUSTOMER`, this address is empty.\n * @readonly\n */\n calculatedAddress?: Address$4;\n }\n /** @oneof */\n interface LocationOptionsOneOf {\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 LocationType$3 {\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 Address$4 extends AddressStreetOneOf$3 {\n /** Street name and number. */\n streetAddress?: StreetAddress$3;\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 * Coordinates of the physical address.\n * @internal\n */\n location?: AddressLocation$3;\n }\n /** @oneof */\n interface AddressStreetOneOf$3 {\n /** Street name and number. */\n streetAddress?: StreetAddress$3;\n addressLine?: string | null;\n }\n /** Street address. Includes street name, number, and apartment number in separate fields. */\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 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?: Address$4;\n /**\n * Business location email\n * @readonly\n */\n email?: string | null;\n /**\n * Business location phone\n * @readonly\n */\n phone?: string | null;\n }\n interface CustomLocationOptions {\n /**\n * A constant id for the custom location.\n * @readonly\n */\n _id?: string;\n /** A custom address for the location. */\n address?: Address$4;\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 * - The `CancellationFeePolicy` object defines the policy regarding cancellation fees.\n * - The `SaveCreditCardPolicy` object defines the policy for saving credit card details.\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 * Revision number, which increments by 1 each time the policy is updated. To prevent conflicting changes, the existing revision must be used when updating a policy. Can be empty after the service was cloned as part of site clone.\n * @internal\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the policy was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the policy was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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$1;\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$1;\n /**\n * Policy for limiting late bookings.\n * @readonly\n */\n limitLateBookingPolicy?: LimitLateBookingPolicy$1;\n /**\n * Policy on booking an entity after the start of the schedule.\n * @readonly\n */\n bookAfterStartPolicy?: BookAfterStartPolicy$1;\n /**\n * Policy for canceling a booked entity.\n * @readonly\n */\n cancellationPolicy?: CancellationPolicy$1;\n /**\n * Policy for rescheduling a booked entity.\n * @readonly\n */\n reschedulePolicy?: ReschedulePolicy$1;\n /**\n * Waitlist policy for the service.\n * @readonly\n */\n waitlistPolicy?: WaitlistPolicy$1;\n /**\n * Policy regarding the participants per booking.\n * @readonly\n */\n participantsPolicy?: ParticipantsPolicy$1;\n /**\n * Policy for allocating resources.\n * @readonly\n */\n resourcesPolicy?: ResourcesPolicy$1;\n /**\n * Rules for cancellation fees.\n * @readonly\n */\n cancellationFeePolicy?: CancellationFeePolicy$1;\n /**\n * Rule for saving credit card.\n * @readonly\n */\n saveCreditCardPolicy?: SaveCreditCardPolicy$1;\n }\n /** A description of the policy to display to participants. */\n interface PolicyDescription$1 {\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$1 {\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$1 {\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$1 {\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$1 {\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$1 {\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$1 {\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$1 {\n /**\n * Whether the maximum number of participants applies. When `false`, there is\n * no maximum.\n *\n * Default: `false`\n * Private because not limiting participants per booking is not supported by Bookings flows today\n * @internal\n */\n enabled?: boolean;\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$1 {\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 CancellationFeePolicy$1 {\n /**\n * Whether canceling a booking will result in a cancellation fee\n *\n * Default: `false`\n */\n enabled?: boolean;\n /** Cancellation windows describing the time of cancellation and the fee to charge. */\n cancellationWindows?: CancellationWindow$1[];\n /**\n * Whether the cancellation fee should not be automatically collected when customer cancels the booking.\n *\n * Default: `true`\n */\n autoCollectFeeEnabled?: boolean | null;\n }\n interface CancellationWindow$1 extends CancellationWindowFeeOneOf$1 {\n /** Amount to be charged as a cancellation fee. */\n amount?: CommonMoney;\n /** Percentage of the original price to be charged as a cancellation fee. */\n percentage?: string;\n /** The fee will be applied if the booked session starts within this start time in minutes. */\n startInMinutes?: number | null;\n }\n /** @oneof */\n interface CancellationWindowFeeOneOf$1 {\n /** Amount to be charged as a cancellation fee. */\n amount?: CommonMoney;\n /** Percentage of the original price to be charged as a cancellation fee. */\n percentage?: string;\n }\n interface SaveCreditCardPolicy$1 {\n /** Default: `false` */\n enabled?: boolean;\n }\n interface Schedule$1 {\n /**\n * Schedule ID, used to manage the service's sessions.\n * @readonly\n */\n _id?: string | null;\n /**\n * Start time of the first session in the schedule. For courses only.\n * @readonly\n */\n firstSessionStart?: Date | null;\n /**\n * End time of the last session in the schedule. For courses only.\n * @readonly\n */\n lastSessionEnd?: Date | null;\n /** Limitations dictating the way session availability is calculated. For appointments only. */\n availabilityConstraints?: AvailabilityConstraints$1;\n }\n interface AvailabilityConstraints$1 {\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$1 {\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 /**\n * Name of the staff member\n * @readonly\n */\n name?: string | null;\n /**\n * Main media associated with the service.\n * @readonly\n */\n mainMedia?: StaffMediaItem;\n }\n interface StaffMediaItem extends StaffMediaItemItemOneOf {\n /** Details of the image associated with the staff, such as URL and size. */\n image?: string;\n }\n /** @oneof */\n interface StaffMediaItemItemOneOf {\n /** Details of the image associated with the staff, such as URL and size. */\n image?: string;\n }\n interface StaffMemberDetails {\n /** Staff members providing the service. For appointments only. */\n staffMembers?: StaffMember$1[];\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 /** Service resource type data. */\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 | null;\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$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 /**\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 /**\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 | null;\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 SetCustomSlugEvent {\n /** The main slug for the service after the update */\n mainSlug?: Slug;\n }\n interface ServicesUrlsChanged {\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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$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$4;\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$4 {\n UNKNOWN = \"UNKNOWN\",\n ANONYMOUS_VISITOR = \"ANONYMOUS_VISITOR\",\n MEMBER = \"MEMBER\",\n WIX_USER = \"WIX_USER\",\n APP = \"APP\"\n }\n interface CreateServiceRequest {\n /** Service to be created. */\n service: Service;\n }\n interface CreateServiceResponse {\n /** The created service. */\n service?: Service;\n }\n interface BulkCreateServicesRequest {\n services: Service[];\n /** `true` if the created entities must be included in the response, */\n returnEntity?: boolean;\n /**\n * otherwise no entities are included in the response.\n * @internal\n */\n skipScheduleCreation?: boolean;\n }\n interface BulkCreateServicesResponse {\n /** The result of each service creation. */\n results?: BulkServiceResult[];\n /** Create statistics. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkServiceResult {\n /** Updated service metadata. */\n itemMetadata?: ItemMetadata$2;\n /** The updated service. */\n item?: Service;\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 GetServiceRequest {\n serviceId: string;\n /** @internal */\n conditionalFields?: RequestedFields$1[];\n /** @internal */\n eventuallyConsistent?: boolean | null;\n }\n enum RequestedFields$1 {\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 */\n RESOURCE_TYPE_DETAILS = \"RESOURCE_TYPE_DETAILS\"\n }\n interface GetServiceResponse {\n /** The retrieved service. */\n service?: Service;\n }\n interface GetServiceAvailabilityConstraintsRequest {\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?: Schedule$1;\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?: Location$3[];\n /**\n * Resource groups required to book the service. For backwards compatibility only. Use `serviceResources` instead.\n * @readonly\n * @deprecated Resource groups required to book the service. For backwards compatibility only. Use `serviceResources` instead.\n * @replacedBy service_resources\n * @targetRemovalDate 2024-08-19\n */\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 */\n service: Service;\n /**\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n * @internal\n */\n mask?: string[];\n }\n interface UpdateServiceResponse {\n /** The updated service. */\n service?: Service;\n }\n interface BulkUpdateServicesRequest {\n services?: MaskedService[];\n /** `true` if the updated entities must be included in the response, */\n returnEntity?: boolean;\n }\n interface MaskedService {\n /** Service to update. [Partial */\n service?: Service;\n /**\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n * @internal\n */\n mask?: string[];\n }\n interface BulkUpdateServicesResponse {\n /** The result of each service update. */\n results?: BulkServiceResult[];\n /** Update statistics. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkUpdateServicesByFilterRequest {\n /** Filter to identify the services that need to be updated. */\n filter: Record | null;\n /**\n * Service to update. [Partial\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n */\n service: Service;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n interface BulkUpdateServicesByFilterResponse {\n /** ID of the service update job. */\n jobId?: string;\n }\n interface DeleteServiceRequest {\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 */\n participantNotification?: ParticipantNotification$4;\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 | 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 of the services for deletion. */\n ids: 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 */\n participantNotification?: ParticipantNotification$4;\n }\n interface BulkDeleteServicesResponse {\n /** The result of each service removal. */\n results?: BulkServiceResult[];\n /** Update statistics. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkDeleteServicesByFilterRequest {\n /** Filter to identify the services that need to be deleted. */\n filter: Record | null;\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?: ParticipantNotification$4;\n }\n interface BulkDeleteServicesByFilterResponse {\n /** ID of the service deletion job. */\n jobId?: string;\n }\n interface QueryServicesRequest {\n /** WQL expression. */\n query: QueryV2$2;\n /** @internal */\n conditionalFields?: RequestedFields$1[];\n /** @internal */\n eventuallyConsistent?: boolean | null;\n }\n interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\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 * @internal\n */\n cursorPaging?: CursorPaging$4;\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$4[];\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 * @internal\n */\n fields?: string[];\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 * @internal\n */\n fieldsets?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$2 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$2;\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 * @internal\n */\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 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 /** 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[];\n /** Paging metadata, including offset and count. */\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$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 * @internal\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 SearchServicesRequest {\n /** WQL, search or aggregation expression. */\n search: CursorSearch$1;\n }\n interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {\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$4;\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$4[];\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$1;\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. e.g. `\"2023-12-20T10:52:34.795Z\"`\n */\n timeZone?: string | null;\n }\n /** @oneof */\n interface CursorSearchPagingMethodOneOf$1 {\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$4;\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$1;\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 2025-01-01\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 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$1 {\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 /** Should sort by number of matches or value of the field */\n sortType?: SortType;\n /** Should sort in ascending or descending order */\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 /** Define the operator for the scalar aggregation */\n type?: ScalarType$1;\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 dont 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$1 {\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 /** 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$1 {\n /** Boolean search mode */\n mode?: Mode$1;\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$1 {\n /** Any */\n OR = \"OR\",\n /** All */\n AND = \"AND\"\n }\n interface SearchServicesResponse {\n /** The retrieved services. */\n services?: Service[];\n /** Cursor paging metadata */\n pagingMetadata?: CursorPagingMetadata$3;\n /** Response aggregation data */\n aggregationData?: AggregationData$1;\n }\n interface CursorPagingMetadata$3 {\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$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 AggregationData$1 {\n /** key = aggregation name (as derived from search request) */\n results?: AggregationResults$1[];\n }\n interface ValueAggregationResult$1 {\n /** Value of the field */\n value?: string;\n /** Count of entities with this value */\n count?: number;\n }\n interface RangeAggregationResult$1 {\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$1 extends NestedAggregationResultsResultOneOf$1 {\n /** Value aggregation results */\n values?: ValueResults$1;\n /** Range aggregation results */\n ranges?: RangeResults$1;\n /** Scalar aggregation results */\n scalar?: ScalarResult$1;\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$1;\n /** Field to aggregate by, matches the one provided in request */\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationResultsResultOneOf$1 {\n /** Value aggregation results */\n values?: ValueResults$1;\n /** Range aggregation results */\n ranges?: RangeResults$1;\n /** Scalar aggregation results */\n scalar?: ScalarResult$1;\n }\n interface ValueResults$1 {\n /** List of value aggregations */\n results?: ValueAggregationResult$1[];\n }\n interface RangeResults$1 {\n /** List of ranges returned in same order as requested */\n results?: RangeAggregationResult$1[];\n }\n interface ScalarResult$1 {\n /** Type of scalar aggregation */\n type?: ScalarType$1;\n /** Value of the scalar aggregation */\n value?: number;\n }\n interface NestedValueAggregationResult$1 {\n /** Value of the field */\n value?: string;\n /** Nested aggregations */\n nestedResults?: NestedAggregationResults$1;\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 NestedResultsScalarResult {\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?: NestedResultsScalarResult;\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?: NestedResultsScalarResult;\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$1 {\n /** List of value aggregations */\n results?: NestedValueAggregationResult$1[];\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$1 extends AggregationResultsResultOneOf$1 {\n /** Value aggregation results */\n values?: ValueResults$1;\n /** Range aggregation results */\n ranges?: RangeResults$1;\n /** Scalar aggregation results */\n scalar?: ScalarResult$1;\n /** Group by value aggregation results */\n groupedByValue?: GroupByValueResults$1;\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$1;\n /** Field to aggregate by as derived from search request */\n fieldPath?: string;\n }\n /** @oneof */\n interface AggregationResultsResultOneOf$1 {\n /** Value aggregation results */\n values?: ValueResults$1;\n /** Range aggregation results */\n ranges?: RangeResults$1;\n /** Scalar aggregation results */\n scalar?: ScalarResult$1;\n /** Group by value aggregation results */\n groupedByValue?: GroupByValueResults$1;\n /** Date histogram aggregation results */\n dateHistogram?: DateHistogramResults;\n /** Nested aggregation results */\n nested?: NestedResults;\n }\n interface QueryPoliciesRequest {\n /** WQL expression. */\n query: CursorQuery$2;\n }\n interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$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`\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$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 QueryPoliciesResponse {\n /** The retrieved policies. */\n bookingPolicies?: BookingPolicyWithServices[];\n /** Paging metadata, including offset and count. */\n pagingMetadata?: CursorPagingMetadata$3;\n }\n interface BookingPolicyWithServices {\n /** The booking policy. */\n bookingPolicy?: BookingPolicy$1;\n services?: Service[];\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 interface QueryLocationsRequest {\n /** The filter for the query. */\n filter?: QueryLocationsFilter;\n }\n interface QueryLocationsFilter {\n /** The filter sent to search services. */\n services?: Record | null;\n /** IDs of business locations to query. */\n businessLocationIds?: string[];\n }\n interface QueryLocationsResponse {\n /** business locations on non hidden services. */\n businessLocations?: BusinessLocations;\n /** custom locations on non hidden services. */\n customLocations?: CustomLocations;\n /** customer location on non hidden services. */\n customerLocations?: CustomerLocations;\n }\n interface BusinessLocations {\n /** Whether there are any services with business locations */\n exists?: boolean;\n /** The retrieved locations sorted according to the Sort in Query. */\n locations?: Location$3[];\n }\n interface CustomLocations {\n /** Whether there are any services with custom location */\n exists?: boolean;\n }\n interface CustomerLocations {\n /** Whether there are any services with customer location */\n exists?: boolean;\n }\n interface QueryCategoriesRequest {\n /** The filter for the query. */\n filter?: QueryCategoriesFilter;\n }\n interface QueryCategoriesFilter {\n /** The filter sent to search services. */\n services?: Record | null;\n /** IDs of categories to query. */\n categoryIds?: string[];\n }\n interface QueryCategoriesResponse {\n /** The retrieved categories. */\n categories?: V2Category[];\n }\n interface QueryServicesMultiLanguageRequest {\n /** WQL expression. */\n query: QueryV2$2;\n /** @internal */\n conditionalFields?: RequestedFields$1[];\n }\n interface QueryServicesMultiLanguageResponse {\n /** The retrieved services in the main language */\n services?: Service[];\n /** the retrieved services in the requested language according to the */\n translatedServices?: Service[];\n /** Paging metadata, including offset and count. */\n pagingMetadata?: PagingMetadataV2$1;\n }\n interface SetServiceLocationsRequest {\n /** ID of the service. */\n serviceId: string;\n /** The locations you specify replace the existing service locations. */\n locations: Location$3[];\n /**\n * The action to perform on sessions currently set to a removed location. For\n * example, move existing sessions to a new specified location.\n */\n removedLocationSessionsAction?: RemovedLocationSessionsAction;\n /**\n * Whether to notify participants about the change of location, and an\n * optional custom message.\n */\n participantNotification?: ParticipantNotification$4;\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?: Location$3;\n }\n interface SetServiceLocationsResponse {\n /** The updated service with the newly set locations. */\n service?: Service;\n }\n interface EnablePricingPlansForServiceRequest {\n serviceId: string;\n pricingPlanIds: string[];\n }\n interface EnablePricingPlansForServiceResponse {\n pricingPlanIds?: string[];\n /** The service after the pricing plans update. */\n service?: Service;\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 serviceId: string;\n pricingPlanIds?: string[];\n }\n interface DisablePricingPlansForServiceResponse {\n /** The service after the pricing plans update. */\n service?: Service;\n }\n interface SetCustomSlugRequest {\n serviceId: string;\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;\n }\n interface ValidateSlugRequest {\n serviceId: string;\n slugName: string;\n }\n interface ValidateSlugResponse {\n /** Whether the requested slug name is valid. */\n valid?: boolean;\n slugName?: string | null;\n /**\n * be set as a slug for the service and is populated with the requested\n * slug. Otherwise, `slugName` is empty.\n * If the slug is invalid, this field is populated with the reasons why the\n * slug is invalid. Validation errors may include `SLUG_IS_TOO_LONG`,\n * `SLUG_CONTAIN_ILLEGAL_CHARACTERS`, and `SLUG_ALREADY_EXISTS`.\n */\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 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 */\n copyPricingPlans?: boolean;\n /**\n * service. If the source service is connected to more than 120\n * benefits with pricing plans then they will not be copied. In that\n * case the field `error_types` in the response will include\n * `PRICING_PLANS`.\n */\n hideService?: boolean | null;\n /** copy this value from the source service without overriding it */\n cloneServiceName?: string | null;\n }\n interface CloneServiceResponse {\n /** Cloned service */\n service?: Service;\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 /** An event sent every time a category entity is changed. */\n interface CategoryNotification {\n category?: Category;\n event?: Event;\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 * Custom properties that can be associated with the category.\n * @internal\n */\n customProperties?: Record;\n /**\n * Category status.\n *\n * Supported values:\n * - `\"CREATED\"`: The category is created.\n * - `\"DELETED\"`: The category is deleted.\n *\n * Default: `\"CREATED\"`\n * @readonly\n */\n status?: Status$1;\n /** Sort order of the category in the Dashboard. */\n sortOrder?: number | null;\n }\n enum Status$1 {\n /** The category is created. */\n CREATED = \"CREATED\",\n /** The category is deleted. */\n DELETED = \"DELETED\"\n }\n enum Event {\n Updated = \"Updated\",\n Deleted = \"Deleted\",\n Created = \"Created\"\n }\n interface Empty$2 {\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 /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated$1;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent$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 * true when the schedule belongs to a site that is rolled out to calendar v3\n * @internal\n */\n rolledOut?: boolean | null;\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 * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated$1;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent$1;\n }\n interface ScheduleCreated$1 {\n schedule?: V1Schedule;\n }\n interface V1Schedule {\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 * Start time of the first session in the schedule.\n * @internal\n * @readonly\n */\n firstSessionStart?: Date | null;\n /**\n * End time of the last session in the schedule.\n * @internal\n * @readonly\n */\n lastSessionEnd?: Date | 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?: V1Location;\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 | null;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date | null;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * The schedule version, updated each time the schedule or the schedule participants are updated.\n * @internal\n * @readonly\n */\n versions?: Version$1;\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 * The name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * Currently, in Bookings system, it would be present when the schedule is owned by a staff resource and the resource is connected to a user.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 | null;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date | null;\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 * The name of the linked schedule owner. It may be a resource name or a service name. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the linked schedule owner. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 V1Location {\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$1;\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?: CommonAddress;\n /**\n * The Wix Business location formatted address.\n * Valid when `locationType` is `OWNER_BUSINESS`. Defaults to the business's location.\n * To retrieve the full location data please use the [Locations API](https://dev.wix.com/api/rest/business-info/locations).\n * @internal\n */\n businessLocation?: LocationsLocation$1;\n }\n enum LocationLocationType$1 {\n UNDEFINED = \"UNDEFINED\",\n OWNER_BUSINESS = \"OWNER_BUSINESS\",\n OWNER_CUSTOM = \"OWNER_CUSTOM\",\n CUSTOM = \"CUSTOM\"\n }\n /** Physical address */\n interface CommonAddress extends CommonAddressStreetOneOf {\n /** Street name, number and apartment number. */\n streetAddress?: CommonStreetAddress;\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?: CommonAddressLocation;\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 CommonAddressStreetOneOf {\n /** Street name, number and apartment number. */\n streetAddress?: CommonStreetAddress;\n /** Main address line, usually street and number, as free text. */\n addressLine?: string | null;\n }\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 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$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$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$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$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$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 * Default service price. Always vailable when a service has\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Sometimes also available for services without variants.\n * Ignored in [updates to a service](https://dev.wix.com/api/rest/wix-bookings/services/service/update-service),\n * when either `labeled_price_options` or `price_text` is also specified.\n * @internal\n */\n defaultVariedPrice?: Price$1;\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 | null;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date | null;\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?: V1AvailabilityConstraints;\n /**\n * Not supported yet.\n * A list of possible locations for the session when `use_default_location` is set to `false`. Slots are generated for each location. Only one of the possible locations can be chosen by the customer.\n *\n * **NOTE**: When using the `locations` parameter, the default location is not automatically included in the list.\n * @internal\n */\n locations?: V1Location[];\n /**\n * Not supported yet.\n * Whether the schedule's slots are only available at the schedule's default location, as set in `schedule.location`. If set to `false`, the `locations` array is used to set the possible locations of the schedule's sessions.\n * Default is `true`.\n * @internal\n */\n useDefaultLocation?: boolean | null;\n }\n /** Describes how to calculate the specific slots that are available for booking. */\n interface V1AvailabilityConstraints {\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 /**\n * A generated id for the conference entity - Base62($providerId$accountOwnerId$conferenceId)\n * @internal\n */\n conferenceId?: string | null;\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 interface ScheduleUpdated$1 {\n /** The old schedule before the update. */\n oldSchedule?: V1Schedule;\n /** The new schedule after the update. */\n newSchedule?: V1Schedule;\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?: V1ParticipantNotification;\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 | null;\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?: V1Location;\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 * The remaining number of participants that can be added to the session. Read-only.\n * Can be negative, in case the session is over capacity.\n * @internal\n * @readonly\n */\n remainingCapacity?: 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 * Information about the external calendar, if the session originated in an external calendar.\n * @internal\n * @readonly\n */\n externalCalendarInfo?: ExternalCalendarInfo$1;\n /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides$1;\n /**\n * Session status.\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 * @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 name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * NOT IMPLEMENTED YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: 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 * The ID of the event in the new Calendar Events V3 API.\n * @internal\n * @readonly\n */\n eventId?: string | null;\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 | null;\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 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$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 /**\n * Schedule version number, updated each time the schedule is updated.\n * @internal\n */\n scheduleVersion?: number;\n /**\n * Session version number, updated each time the session is updated.\n * @internal\n */\n sessionVersion?: number;\n /**\n * Participants version number, updated each time the session participants are updated.\n * @internal\n */\n participantsVersion?: number | null;\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 V1ParticipantNotification {\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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\n }\n interface ScheduleCancelled$1 {\n schedule?: V1Schedule;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: V1ParticipantNotification;\n oldSchedule?: V1Schedule;\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?: V1ParticipantNotification;\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?: V1ParticipantNotification;\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?: V1Schedule;\n }\n interface MultipleSessionsCreated$1 {\n schedulesWithSessions?: ScheduleWithSessions$1[];\n }\n interface ScheduleWithSessions$1 {\n schedule?: V1Schedule;\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 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$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 /**\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?: V1Schedule[];\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 * The ID of the Resource Group that this resource belongs to. This is an optional field as not every resource is part of a group.\n * @internal\n */\n groupId?: string | null;\n /**\n * This field determines how to resolve the working hours of this resource. Defaults to `true` if was not set by the client.\n * When set to `true` then working hours (including location information) can be found in the sessions of a schedule that is connected to this resource.\n * If `false`, then the working hours are not specified as sessions of a connected schedule. Instead this resource is then by definition full-time available (7 x 24).\n * @internal\n */\n hasWorkingHoursSchedule?: boolean | null;\n /**\n * True if the resource is available in all locations, false if the resource is available only in a specific business location. Empty if `has_working_hours_schedule` is true.\n * Information on the location(s) can then be found in the sessions of one of the connected schedules.\n * @internal\n */\n availableInAllLocations?: boolean | null;\n /**\n * Information about business location connected to the resource. Should be empty if `available_in_all_locations` is true or if no business location exists in OS.\n * @internal\n */\n businessLocation?: BusinessLocation;\n /**\n * This schedule contains the sessions in which this resource is booked.\n * Equals to the first element of `schedules` array.\n * @internal\n * @readonly\n */\n eventsSchedule?: V1Schedule;\n /**\n * The type of of the resource. Currently this field is only filled for staff and will contain the ID as configured in the\n * BOOKINGS_RESOURCE_TYPES component of the Bookings app.\n * @internal\n * @readonly\n */\n type?: string | null;\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 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?: BenefitNotificationEvent;\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 BenefitNotificationEvent {\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 | null;\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 /**\n * Set of properties that were updated - corresponds to the fields in \"properties\".\n * @internal\n */\n fields?: string[];\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;\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 {\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$2;\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$2;\n /** Properties were cloned on site cloning. */\n siteCloned?: SiteCloned$1;\n }\n interface PropertiesChange$1 {\n }\n interface SiteCreated$2 {\n /** Origin template site id. */\n originTemplateId?: string | null;\n }\n interface SiteCloned$1 {\n /** Origin site id. */\n originMetaSiteId?: string;\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 * @permissionId BOOKINGS.SERVICES_CREATE\n * @adminMethod\n * @returns The created service.\n */\n function createService(service: Service): Promise;\n /**\n * Creates multiple new services.\n * @internal\n * @documentationMaturity preview\n * @requiredField services\n * @permissionId BOOKINGS.SERVICES_CREATE\n * @adminMethod\n */\n function bulkCreateServices(services: Service[], options?: BulkCreateServicesOptions): Promise;\n interface BulkCreateServicesOptions {\n /** `true` if the created entities must be included in the response, */\n returnEntity?: boolean;\n /**\n * otherwise no entities are included in the response.\n * @internal\n */\n skipScheduleCreation?: boolean;\n }\n /**\n * Retrieves a service.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceId\n * @permissionId BOOKINGS.SERVICES_READ\n * @returns The retrieved service.\n */\n function getService(serviceId: string, options?: GetServiceOptions): Promise;\n interface GetServiceOptions {\n /** @internal */\n conditionalFields?: RequestedFields$1[];\n /** @internal */\n eventuallyConsistent?: boolean | null;\n }\n /**\n * Retrieves the service constraints for availability calculation\n * @internal\n * @documentationMaturity preview\n * @requiredField serviceId\n * @permissionId BOOKINGS.SERVICES_READ\n */\n function getServiceAvailabilityConstraints(serviceId: string): Promise;\n /**\n * Updates a service.\n *\n * [Partial\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n *\n * Each time the service is updated, `revision` increments by 1. You must\n * include the number of the existing revision when updating the service.\n * This ensures you're working with the latest service information and\n * prevents unintended overwrites.\n * @param _id - Service ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField service\n * @requiredField service.revision\n * @permissionId BOOKINGS.SERVICES_UPDATE\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 /** Service type. */\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;\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?: Location$3[];\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?: Schedule$1;\n /** IDs of the staff members providing the service. For appointments only. */\n staffMemberIds?: string[];\n /**\n * Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was passed.\n * @internal\n * @readonly\n * @deprecated Staff members providing the service. For appointments only. Returned only if `STAFF_MEMBER_DETAILS` conditional field was passed.\n * @replacedBy staff_member_details.staff_members\n * @targetRemovalDate 2025-01-01\n */\n staffMembers?: StaffMember$1[];\n /**\n * Staff members details. Returned only if `STAFF_MEMBER_DETAILS` conditional field was passed.\n * @internal\n */\n staffMemberDetails?: StaffMemberDetails;\n /**\n * Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named \"rooms\".\n * @internal\n * @deprecated Resource groups required to book the service. For example, to book this service, you must book a room out of the resource group named \"rooms\".\n * @replacedBy service_resources\n * @targetRemovalDate 2024-08-19\n */\n resourceGroups?: ResourceGroup[];\n /**\n * Details on resources that are required to book the service. For example, to book this service, you must book a room out of the resource type named \"rooms\".\n * @internal\n */\n serviceResources?: ServiceResource[];\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 /** Extensions enabling users to save custom data related to the service. */\n extendedFields?: ExtendedFields$4;\n /** Custom SEO data for the service. */\n seoData?: SeoSchema;\n /**\n * Date and time the service was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the service was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Updates multiple services.\n *\n * [Partial\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n *\n * Each time a service is updated, `revision` increments by 1. You must\n * include the number of the existing revision for each service to update.\n * This ensures you're working with the latest service information and\n * prevents unintended overwrites.\n * @public\n * @documentationMaturity preview\n * @requiredField options.services.service\n * @requiredField options.services.service._id\n * @requiredField options.services.service.revision\n * @permissionId BOOKINGS.SERVICES_UPDATE\n * @adminMethod\n */\n function bulkUpdateServices(options?: BulkUpdateServicesOptions): Promise;\n interface BulkUpdateServicesOptions {\n services?: MaskedService[];\n /** `true` if the updated entities must be included in the response, */\n returnEntity?: boolean;\n }\n /**\n * Updates multiple services by filter.\n *\n * [Partial\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n *\n * Each time a service is updated, `revision` increments by 1.\n * @param filter - Filter to identify the services that need to be updated.\n * @public\n * @documentationMaturity preview\n * @requiredField filter\n * @requiredField options.service\n * @permissionId BOOKINGS.SERVICES_UPDATE\n * @adminMethod\n */\n function bulkUpdateServicesByFilter(filter: Record | null, options?: BulkUpdateServicesByFilterOptions): Promise;\n interface BulkUpdateServicesByFilterOptions {\n /**\n * Service to update. [Partial\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n */\n service: Service;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n mask?: string[];\n }\n /**\n * Deletes a service.\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 * @permissionId BOOKINGS.SERVICES_DELETE\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 */\n participantNotification?: ParticipantNotification$4;\n }\n /**\n * Deletes multiple services.\n * @param ids - Ids of the services for deletion.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId BOOKINGS.SERVICES_DELETE\n * @adminMethod\n */\n function bulkDeleteServices(ids: string[], options?: BulkDeleteServicesOptions): Promise;\n interface BulkDeleteServicesOptions {\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 */\n participantNotification?: ParticipantNotification$4;\n }\n /**\n * Deletes multiple services by filter.\n * @param filter - Filter to identify the services that need to be deleted.\n * @public\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId BOOKINGS.SERVICES_DELETE\n * @adminMethod\n */\n function bulkDeleteServicesByFilter(filter: Record | null, options?: BulkDeleteServicesByFilterOptions): Promise;\n interface BulkDeleteServicesByFilterOptions {\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?: ParticipantNotification$4;\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 * @permissionId BOOKINGS.SERVICES_READ\n */\n function queryServices(options?: QueryServicesOptions): ServicesQueryBuilder;\n interface QueryServicesOptions {\n /** @internal */\n conditionalFields?: RequestedFields$1[] | undefined;\n /** @internal */\n eventuallyConsistent?: boolean | null | 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 ServicesQueryResult extends QueryOffsetResult {\n items: Service[];\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: '_id' | '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' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | '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: '_id' | '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' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | '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 ge: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', 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 gt: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', 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 le: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', 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 lt: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', 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: '_id' | '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: '_id' | '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' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | '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: '_id' | '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' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'staffMemberIds' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | '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' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | '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 * Retrieves a list of up to 100 services, given the provided query string,\n * and paging.\n * @param search - WQL, search or aggregation expression.\n * @public\n * @documentationMaturity preview\n * @requiredField search\n * @permissionId BOOKINGS.SERVICES_READ\n */\n function searchServices(search: CursorSearch$1): Promise;\n /**\n * Retrieves a list of up to 100 policies, given the provided paging,\n * filtering, and sorting.\n *\n *\n * Define queries using [WQL - Wix Query\n * Language](https://dev.wix.com/api/rest/getting-started/api-query-language).\n * For field support for filters and sorting, see [Supported Filters and\n * Sorting](https://dev.wix.com/api/rest/wix-bookings/services-v2/supported-filters-and-sorting).\n *\n * To retrieve all policies use an empty query:\n *\n * ```javascript\n * {\n * \"query\": {}\n * }\n * ```\n * `Query Policies` 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\n * is defined more than once in a query, only the first occurrence is\n * processed.\n * @param query - WQL expression.\n * @public\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId BOOKINGS.BOOKING_POLICY_READ\n * @permissionId BOOKINGS.SERVICES_READ\n */\n function queryPolicies(query: CursorQuery$2): Promise;\n /**\n * Retrieves the number of services that match the provided filters.\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.SERVICES_COUNT\n */\n function countServices(options?: CountServicesOptions): Promise;\n interface CountServicesOptions {\n /** The filters for performing the count. */\n filter?: Record | null;\n }\n /**\n * Query locations that exist on services.\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.SERVICES_READ\n */\n function queryLocations(options?: QueryLocationsOptions): Promise;\n interface QueryLocationsOptions {\n /** The filter for the query. */\n filter?: QueryLocationsFilter;\n }\n /**\n * Query categories that exist on services.\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.SERVICES_READ\n */\n function queryCategories(options?: QueryCategoriesOptions): Promise;\n interface QueryCategoriesOptions {\n /** The filter for the query. */\n filter?: QueryCategoriesFilter;\n }\n /**\n * Query services in both the main language and the provided language according to the linguist aspect.\n * @param query - WQL expression.\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId BOOKINGS.SERVICES_READ\n */\n function queryServicesMultiLanguage(query: QueryV2$2, options?: QueryServicesMultiLanguageOptions): Promise;\n interface QueryServicesMultiLanguageOptions {\n /** @internal */\n conditionalFields?: RequestedFields$1[];\n }\n /**\n * Change the locations this service is offered at.\n * Changing locations may have impact on existing sessions and their\n * participants. When removing locations from a service, this endpoint\n * requires stating what to do with existing sessions occurring at the removed\n * locations.\n * @param serviceId - ID of the service.\n * @param locations - The locations you specify replace the existing service locations.\n * @public\n * @documentationMaturity preview\n * @requiredField locations\n * @requiredField serviceId\n * @permissionId BOOKINGS.SERVICES_LOCATIONS_SET\n * @adminMethod\n */\n function setServiceLocations(serviceId: string, locations: Location$3[], options?: SetServiceLocationsOptions): Promise;\n interface SetServiceLocationsOptions {\n /**\n * The action to perform on sessions currently set to a removed location. For\n * example, move existing sessions to a new specified location.\n */\n removedLocationSessionsAction?: RemovedLocationSessionsAction;\n /**\n * Whether to notify participants about the change of location, and an\n * optional custom message.\n */\n participantNotification?: ParticipantNotification$4;\n }\n /**\n * Enables specific [pricing\n * plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object)\n * as payment methods for a service. This API enables customers to pay for the\n * service using one of the specified pricing plans.\n * @public\n * @documentationMaturity preview\n * @requiredField pricingPlanIds\n * @requiredField serviceId\n * @permissionId BOOKINGS.SERVICES_PRICING_PLANS_ADD\n * @adminMethod\n */\n function enablePricingPlansForService(serviceId: string, pricingPlanIds: string[]): Promise;\n /**\n * Disables specific [pricing\n * plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object)\n * as payment methods for a service. Customers can't pay for the service using\n * a removed pricing plan. Existing payments with a removed plan aren't\n * affected.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceId\n * @permissionId BOOKINGS.SERVICES_PRICING_PLANS_REMOVE\n * @adminMethod\n */\n function disablePricingPlansForService(serviceId: string, options?: DisablePricingPlansForServiceOptions): Promise;\n interface DisablePricingPlansForServiceOptions {\n pricingPlanIds?: string[];\n }\n /**\n * Sets a custom (user-defined) slug for the various service pages.\n * The call may fail if there's another service with the same slug, either by\n * past name or by a custom slug.\n * @public\n * @documentationMaturity preview\n * @requiredField serviceId\n * @requiredField slugName\n * @permissionId BOOKINGS.SERVICES_CUSTOM_SLUGS_SET\n * @adminMethod\n */\n function setCustomSlug(serviceId: string, slugName: string): Promise;\n /**\n * Validate a custom (user-defined) slug, making sure no other service uses\n * the same slug. The call may fail if there's another service with the same\n * slug, either by past name or by a custom set slug.\n * @public\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.slugName\n * @requiredField serviceId\n * @permissionId BOOKINGS.SERVICES_CUSTOM_SLUGS_SET\n * @adminMethod\n */\n function validateSlug(serviceId: string, options: ValidateSlugOptions): Promise;\n interface ValidateSlugOptions {\n slugName: string;\n }\n /**\n * Clones a service.\n * @public\n * @documentationMaturity preview\n * @requiredField sourceServiceId\n * @permissionId BOOKINGS.SERVICE_CLONE\n * @adminMethod\n */\n function cloneService(sourceServiceId: string, options?: CloneServiceOptions): Promise;\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 */\n copyPricingPlans?: boolean;\n /**\n * service. If the source service is connected to more than 120\n * benefits with pricing plans then they will not be copied. In that\n * case the field `error_types` in the response will include\n * `PRICING_PLANS`.\n */\n hideService?: boolean | null;\n /** copy this value from the source service without overriding it */\n cloneServiceName?: string | null;\n }\n \n type bookingsServicesV2Service_universal_d_Service = Service;\n type bookingsServicesV2Service_universal_d_ServiceType = ServiceType;\n const bookingsServicesV2Service_universal_d_ServiceType: typeof ServiceType;\n type bookingsServicesV2Service_universal_d_Media = Media;\n type bookingsServicesV2Service_universal_d_MediaItemItemOneOf = MediaItemItemOneOf;\n type bookingsServicesV2Service_universal_d_V2Category = V2Category;\n type bookingsServicesV2Service_universal_d_Form = Form;\n type bookingsServicesV2Service_universal_d_FormSettings = FormSettings;\n type bookingsServicesV2Service_universal_d_Payment = Payment;\n type bookingsServicesV2Service_universal_d_PaymentRateOneOf = PaymentRateOneOf;\n type bookingsServicesV2Service_universal_d_RateType = RateType;\n const bookingsServicesV2Service_universal_d_RateType: typeof RateType;\n type bookingsServicesV2Service_universal_d_FixedPayment = FixedPayment;\n type bookingsServicesV2Service_universal_d_CommonMoney = CommonMoney;\n type bookingsServicesV2Service_universal_d_CustomPayment = CustomPayment;\n type bookingsServicesV2Service_universal_d_VariedPayment = VariedPayment;\n type bookingsServicesV2Service_universal_d_PaymentOptions = PaymentOptions;\n type bookingsServicesV2Service_universal_d_OnlineBooking = OnlineBooking;\n type bookingsServicesV2Service_universal_d_Conferencing = Conferencing;\n type bookingsServicesV2Service_universal_d_LocationOptionsOneOf = LocationOptionsOneOf;\n type bookingsServicesV2Service_universal_d_BusinessLocationOptions = BusinessLocationOptions;\n type bookingsServicesV2Service_universal_d_CustomLocationOptions = CustomLocationOptions;\n type bookingsServicesV2Service_universal_d_StaffMediaItem = StaffMediaItem;\n type bookingsServicesV2Service_universal_d_StaffMediaItemItemOneOf = StaffMediaItemItemOneOf;\n type bookingsServicesV2Service_universal_d_StaffMemberDetails = StaffMemberDetails;\n type bookingsServicesV2Service_universal_d_ResourceGroup = ResourceGroup;\n type bookingsServicesV2Service_universal_d_ResourceIds = ResourceIds;\n type bookingsServicesV2Service_universal_d_ServiceResource = ServiceResource;\n type bookingsServicesV2Service_universal_d_ServiceResourceSelectionOneOf = ServiceResourceSelectionOneOf;\n type bookingsServicesV2Service_universal_d_ResourceType = ResourceType;\n type bookingsServicesV2Service_universal_d_Slug = Slug;\n type bookingsServicesV2Service_universal_d_URLs = URLs;\n type bookingsServicesV2Service_universal_d_SeoSchema = SeoSchema;\n type bookingsServicesV2Service_universal_d_Keyword = Keyword;\n type bookingsServicesV2Service_universal_d_Tag = Tag;\n type bookingsServicesV2Service_universal_d_Settings = Settings;\n type bookingsServicesV2Service_universal_d_ReindexMessage = ReindexMessage;\n type bookingsServicesV2Service_universal_d_ReindexMessageActionOneOf = ReindexMessageActionOneOf;\n type bookingsServicesV2Service_universal_d_Upsert = Upsert;\n type bookingsServicesV2Service_universal_d_Delete = Delete;\n type bookingsServicesV2Service_universal_d_Schema = Schema;\n type bookingsServicesV2Service_universal_d_SetCustomSlugEvent = SetCustomSlugEvent;\n type bookingsServicesV2Service_universal_d_ServicesUrlsChanged = ServicesUrlsChanged;\n type bookingsServicesV2Service_universal_d_CreateServiceRequest = CreateServiceRequest;\n type bookingsServicesV2Service_universal_d_CreateServiceResponse = CreateServiceResponse;\n type bookingsServicesV2Service_universal_d_BulkCreateServicesRequest = BulkCreateServicesRequest;\n type bookingsServicesV2Service_universal_d_BulkCreateServicesResponse = BulkCreateServicesResponse;\n type bookingsServicesV2Service_universal_d_BulkServiceResult = BulkServiceResult;\n type bookingsServicesV2Service_universal_d_GetServiceRequest = GetServiceRequest;\n type bookingsServicesV2Service_universal_d_GetServiceResponse = GetServiceResponse;\n type bookingsServicesV2Service_universal_d_GetServiceAvailabilityConstraintsRequest = GetServiceAvailabilityConstraintsRequest;\n type bookingsServicesV2Service_universal_d_GetServiceAvailabilityConstraintsResponse = GetServiceAvailabilityConstraintsResponse;\n type bookingsServicesV2Service_universal_d_ServiceAvailabilityConstraints = ServiceAvailabilityConstraints;\n type bookingsServicesV2Service_universal_d_V1SplitInterval = V1SplitInterval;\n type bookingsServicesV2Service_universal_d_UpdateServiceRequest = UpdateServiceRequest;\n type bookingsServicesV2Service_universal_d_UpdateServiceResponse = UpdateServiceResponse;\n type bookingsServicesV2Service_universal_d_BulkUpdateServicesRequest = BulkUpdateServicesRequest;\n type bookingsServicesV2Service_universal_d_MaskedService = MaskedService;\n type bookingsServicesV2Service_universal_d_BulkUpdateServicesResponse = BulkUpdateServicesResponse;\n type bookingsServicesV2Service_universal_d_BulkUpdateServicesByFilterRequest = BulkUpdateServicesByFilterRequest;\n type bookingsServicesV2Service_universal_d_BulkUpdateServicesByFilterResponse = BulkUpdateServicesByFilterResponse;\n type bookingsServicesV2Service_universal_d_DeleteServiceRequest = DeleteServiceRequest;\n type bookingsServicesV2Service_universal_d_DeleteServiceResponse = DeleteServiceResponse;\n type bookingsServicesV2Service_universal_d_BulkDeleteServicesRequest = BulkDeleteServicesRequest;\n type bookingsServicesV2Service_universal_d_BulkDeleteServicesResponse = BulkDeleteServicesResponse;\n type bookingsServicesV2Service_universal_d_BulkDeleteServicesByFilterRequest = BulkDeleteServicesByFilterRequest;\n type bookingsServicesV2Service_universal_d_BulkDeleteServicesByFilterResponse = BulkDeleteServicesByFilterResponse;\n type bookingsServicesV2Service_universal_d_QueryServicesRequest = QueryServicesRequest;\n type bookingsServicesV2Service_universal_d_QueryServicesResponse = QueryServicesResponse;\n type bookingsServicesV2Service_universal_d_SearchServicesRequest = SearchServicesRequest;\n type bookingsServicesV2Service_universal_d_Aggregation = Aggregation;\n type bookingsServicesV2Service_universal_d_AggregationKindOneOf = AggregationKindOneOf;\n type bookingsServicesV2Service_universal_d_RangeBucket = RangeBucket;\n type bookingsServicesV2Service_universal_d_SortType = SortType;\n const bookingsServicesV2Service_universal_d_SortType: typeof SortType;\n type bookingsServicesV2Service_universal_d_SortDirection = SortDirection;\n const bookingsServicesV2Service_universal_d_SortDirection: typeof SortDirection;\n type bookingsServicesV2Service_universal_d_MissingValues = MissingValues;\n const bookingsServicesV2Service_universal_d_MissingValues: typeof MissingValues;\n type bookingsServicesV2Service_universal_d_IncludeMissingValuesOptions = IncludeMissingValuesOptions;\n type bookingsServicesV2Service_universal_d_ValueAggregation = ValueAggregation;\n type bookingsServicesV2Service_universal_d_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;\n type bookingsServicesV2Service_universal_d_NestedAggregationType = NestedAggregationType;\n const bookingsServicesV2Service_universal_d_NestedAggregationType: typeof NestedAggregationType;\n type bookingsServicesV2Service_universal_d_RangeAggregation = RangeAggregation;\n type bookingsServicesV2Service_universal_d_ScalarAggregation = ScalarAggregation;\n type bookingsServicesV2Service_universal_d_DateHistogramAggregation = DateHistogramAggregation;\n type bookingsServicesV2Service_universal_d_DateHistogramAggregationInterval = DateHistogramAggregationInterval;\n const bookingsServicesV2Service_universal_d_DateHistogramAggregationInterval: typeof DateHistogramAggregationInterval;\n type bookingsServicesV2Service_universal_d_NestedAggregationItem = NestedAggregationItem;\n type bookingsServicesV2Service_universal_d_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;\n type bookingsServicesV2Service_universal_d_NestedAggregation = NestedAggregation;\n type bookingsServicesV2Service_universal_d_GroupByAggregation = GroupByAggregation;\n type bookingsServicesV2Service_universal_d_GroupByAggregationKindOneOf = GroupByAggregationKindOneOf;\n type bookingsServicesV2Service_universal_d_SearchServicesResponse = SearchServicesResponse;\n type bookingsServicesV2Service_universal_d_ValueResult = ValueResult;\n type bookingsServicesV2Service_universal_d_RangeResult = RangeResult;\n type bookingsServicesV2Service_universal_d_NestedResultsScalarResult = NestedResultsScalarResult;\n type bookingsServicesV2Service_universal_d_NestedResultValue = NestedResultValue;\n type bookingsServicesV2Service_universal_d_NestedResultValueResultOneOf = NestedResultValueResultOneOf;\n type bookingsServicesV2Service_universal_d_Results = Results;\n type bookingsServicesV2Service_universal_d_DateHistogramResult = DateHistogramResult;\n type bookingsServicesV2Service_universal_d_DateHistogramResults = DateHistogramResults;\n type bookingsServicesV2Service_universal_d_NestedResults = NestedResults;\n type bookingsServicesV2Service_universal_d_QueryPoliciesRequest = QueryPoliciesRequest;\n type bookingsServicesV2Service_universal_d_QueryPoliciesResponse = QueryPoliciesResponse;\n type bookingsServicesV2Service_universal_d_BookingPolicyWithServices = BookingPolicyWithServices;\n type bookingsServicesV2Service_universal_d_CountServicesRequest = CountServicesRequest;\n type bookingsServicesV2Service_universal_d_CountServicesResponse = CountServicesResponse;\n type bookingsServicesV2Service_universal_d_QueryLocationsRequest = QueryLocationsRequest;\n type bookingsServicesV2Service_universal_d_QueryLocationsFilter = QueryLocationsFilter;\n type bookingsServicesV2Service_universal_d_QueryLocationsResponse = QueryLocationsResponse;\n type bookingsServicesV2Service_universal_d_BusinessLocations = BusinessLocations;\n type bookingsServicesV2Service_universal_d_CustomLocations = CustomLocations;\n type bookingsServicesV2Service_universal_d_CustomerLocations = CustomerLocations;\n type bookingsServicesV2Service_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type bookingsServicesV2Service_universal_d_QueryCategoriesFilter = QueryCategoriesFilter;\n type bookingsServicesV2Service_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type bookingsServicesV2Service_universal_d_QueryServicesMultiLanguageRequest = QueryServicesMultiLanguageRequest;\n type bookingsServicesV2Service_universal_d_QueryServicesMultiLanguageResponse = QueryServicesMultiLanguageResponse;\n type bookingsServicesV2Service_universal_d_SetServiceLocationsRequest = SetServiceLocationsRequest;\n type bookingsServicesV2Service_universal_d_RemovedLocationSessionsAction = RemovedLocationSessionsAction;\n type bookingsServicesV2Service_universal_d_RemovedLocationSessionsActionActionOptionsOneOf = RemovedLocationSessionsActionActionOptionsOneOf;\n type bookingsServicesV2Service_universal_d_Action = Action;\n const bookingsServicesV2Service_universal_d_Action: typeof Action;\n type bookingsServicesV2Service_universal_d_MoveToNewLocationsOptions = MoveToNewLocationsOptions;\n type bookingsServicesV2Service_universal_d_SetServiceLocationsResponse = SetServiceLocationsResponse;\n type bookingsServicesV2Service_universal_d_EnablePricingPlansForServiceRequest = EnablePricingPlansForServiceRequest;\n type bookingsServicesV2Service_universal_d_EnablePricingPlansForServiceResponse = EnablePricingPlansForServiceResponse;\n type bookingsServicesV2Service_universal_d_InvalidPricingPlan = InvalidPricingPlan;\n type bookingsServicesV2Service_universal_d_DisablePricingPlansForServiceRequest = DisablePricingPlansForServiceRequest;\n type bookingsServicesV2Service_universal_d_DisablePricingPlansForServiceResponse = DisablePricingPlansForServiceResponse;\n type bookingsServicesV2Service_universal_d_SetCustomSlugRequest = SetCustomSlugRequest;\n type bookingsServicesV2Service_universal_d_SetCustomSlugResponse = SetCustomSlugResponse;\n type bookingsServicesV2Service_universal_d_ValidateSlugRequest = ValidateSlugRequest;\n type bookingsServicesV2Service_universal_d_ValidateSlugResponse = ValidateSlugResponse;\n type bookingsServicesV2Service_universal_d_InvalidSlugError = InvalidSlugError;\n const bookingsServicesV2Service_universal_d_InvalidSlugError: typeof InvalidSlugError;\n type bookingsServicesV2Service_universal_d_CloneServiceRequest = CloneServiceRequest;\n type bookingsServicesV2Service_universal_d_CloneServiceResponse = CloneServiceResponse;\n type bookingsServicesV2Service_universal_d_CloneErrors = CloneErrors;\n const bookingsServicesV2Service_universal_d_CloneErrors: typeof CloneErrors;\n type bookingsServicesV2Service_universal_d_CategoryNotification = CategoryNotification;\n type bookingsServicesV2Service_universal_d_Category = Category;\n type bookingsServicesV2Service_universal_d_Event = Event;\n const bookingsServicesV2Service_universal_d_Event: typeof Event;\n type bookingsServicesV2Service_universal_d_V1Schedule = V1Schedule;\n type bookingsServicesV2Service_universal_d_V1Location = V1Location;\n type bookingsServicesV2Service_universal_d_CommonAddress = CommonAddress;\n type bookingsServicesV2Service_universal_d_CommonAddressStreetOneOf = CommonAddressStreetOneOf;\n type bookingsServicesV2Service_universal_d_CommonStreetAddress = CommonStreetAddress;\n type bookingsServicesV2Service_universal_d_CommonAddressLocation = CommonAddressLocation;\n type bookingsServicesV2Service_universal_d_V1AvailabilityConstraints = V1AvailabilityConstraints;\n type bookingsServicesV2Service_universal_d_SessionStatus = SessionStatus;\n const bookingsServicesV2Service_universal_d_SessionStatus: typeof SessionStatus;\n type bookingsServicesV2Service_universal_d_V1ParticipantNotification = V1ParticipantNotification;\n type bookingsServicesV2Service_universal_d_ResourceNotification = ResourceNotification;\n type bookingsServicesV2Service_universal_d_ResourceStatus = ResourceStatus;\n const bookingsServicesV2Service_universal_d_ResourceStatus: typeof ResourceStatus;\n type bookingsServicesV2Service_universal_d_BusinessLocation = BusinessLocation;\n type bookingsServicesV2Service_universal_d_ResourceNotificationEvent = ResourceNotificationEvent;\n const bookingsServicesV2Service_universal_d_ResourceNotificationEvent: typeof ResourceNotificationEvent;\n type bookingsServicesV2Service_universal_d_BenefitNotification = BenefitNotification;\n type bookingsServicesV2Service_universal_d_Benefit = Benefit;\n type bookingsServicesV2Service_universal_d_EntryPass = EntryPass;\n type bookingsServicesV2Service_universal_d_Discount = Discount;\n type bookingsServicesV2Service_universal_d_DiscountDiscountOneOf = DiscountDiscountOneOf;\n type bookingsServicesV2Service_universal_d_BenefitType = BenefitType;\n const bookingsServicesV2Service_universal_d_BenefitType: typeof BenefitType;\n type bookingsServicesV2Service_universal_d_Behavior = Behavior;\n type bookingsServicesV2Service_universal_d_BehaviorBehaviorOneOf = BehaviorBehaviorOneOf;\n type bookingsServicesV2Service_universal_d_BenefitNotificationEvent = BenefitNotificationEvent;\n const bookingsServicesV2Service_universal_d_BenefitNotificationEvent: typeof BenefitNotificationEvent;\n type bookingsServicesV2Service_universal_d_UserDomainInfoChangedEvent = UserDomainInfoChangedEvent;\n type bookingsServicesV2Service_universal_d_CrudType = CrudType;\n const bookingsServicesV2Service_universal_d_CrudType: typeof CrudType;\n type bookingsServicesV2Service_universal_d_HtmlSitePublished = HtmlSitePublished;\n type bookingsServicesV2Service_universal_d_Page = Page;\n type bookingsServicesV2Service_universal_d_V4Address = V4Address;\n type bookingsServicesV2Service_universal_d_MultiServiceEnabledNotification = MultiServiceEnabledNotification;\n const bookingsServicesV2Service_universal_d_createService: typeof createService;\n const bookingsServicesV2Service_universal_d_bulkCreateServices: typeof bulkCreateServices;\n type bookingsServicesV2Service_universal_d_BulkCreateServicesOptions = BulkCreateServicesOptions;\n const bookingsServicesV2Service_universal_d_getService: typeof getService;\n type bookingsServicesV2Service_universal_d_GetServiceOptions = GetServiceOptions;\n const bookingsServicesV2Service_universal_d_getServiceAvailabilityConstraints: typeof getServiceAvailabilityConstraints;\n const bookingsServicesV2Service_universal_d_updateService: typeof updateService;\n type bookingsServicesV2Service_universal_d_UpdateService = UpdateService;\n type bookingsServicesV2Service_universal_d_UpdateServiceOptions = UpdateServiceOptions;\n const bookingsServicesV2Service_universal_d_bulkUpdateServices: typeof bulkUpdateServices;\n type bookingsServicesV2Service_universal_d_BulkUpdateServicesOptions = BulkUpdateServicesOptions;\n const bookingsServicesV2Service_universal_d_bulkUpdateServicesByFilter: typeof bulkUpdateServicesByFilter;\n type bookingsServicesV2Service_universal_d_BulkUpdateServicesByFilterOptions = BulkUpdateServicesByFilterOptions;\n const bookingsServicesV2Service_universal_d_deleteService: typeof deleteService;\n type bookingsServicesV2Service_universal_d_DeleteServiceOptions = DeleteServiceOptions;\n const bookingsServicesV2Service_universal_d_bulkDeleteServices: typeof bulkDeleteServices;\n type bookingsServicesV2Service_universal_d_BulkDeleteServicesOptions = BulkDeleteServicesOptions;\n const bookingsServicesV2Service_universal_d_bulkDeleteServicesByFilter: typeof bulkDeleteServicesByFilter;\n type bookingsServicesV2Service_universal_d_BulkDeleteServicesByFilterOptions = BulkDeleteServicesByFilterOptions;\n const bookingsServicesV2Service_universal_d_queryServices: typeof queryServices;\n type bookingsServicesV2Service_universal_d_QueryServicesOptions = QueryServicesOptions;\n type bookingsServicesV2Service_universal_d_ServicesQueryResult = ServicesQueryResult;\n type bookingsServicesV2Service_universal_d_ServicesQueryBuilder = ServicesQueryBuilder;\n const bookingsServicesV2Service_universal_d_searchServices: typeof searchServices;\n const bookingsServicesV2Service_universal_d_queryPolicies: typeof queryPolicies;\n const bookingsServicesV2Service_universal_d_countServices: typeof countServices;\n type bookingsServicesV2Service_universal_d_CountServicesOptions = CountServicesOptions;\n const bookingsServicesV2Service_universal_d_queryLocations: typeof queryLocations;\n type bookingsServicesV2Service_universal_d_QueryLocationsOptions = QueryLocationsOptions;\n const bookingsServicesV2Service_universal_d_queryCategories: typeof queryCategories;\n type bookingsServicesV2Service_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n const bookingsServicesV2Service_universal_d_queryServicesMultiLanguage: typeof queryServicesMultiLanguage;\n type bookingsServicesV2Service_universal_d_QueryServicesMultiLanguageOptions = QueryServicesMultiLanguageOptions;\n const bookingsServicesV2Service_universal_d_setServiceLocations: typeof setServiceLocations;\n type bookingsServicesV2Service_universal_d_SetServiceLocationsOptions = SetServiceLocationsOptions;\n const bookingsServicesV2Service_universal_d_enablePricingPlansForService: typeof enablePricingPlansForService;\n const bookingsServicesV2Service_universal_d_disablePricingPlansForService: typeof disablePricingPlansForService;\n type bookingsServicesV2Service_universal_d_DisablePricingPlansForServiceOptions = DisablePricingPlansForServiceOptions;\n const bookingsServicesV2Service_universal_d_setCustomSlug: typeof setCustomSlug;\n const bookingsServicesV2Service_universal_d_validateSlug: typeof validateSlug;\n type bookingsServicesV2Service_universal_d_ValidateSlugOptions = ValidateSlugOptions;\n const bookingsServicesV2Service_universal_d_cloneService: typeof cloneService;\n type bookingsServicesV2Service_universal_d_CloneServiceOptions = CloneServiceOptions;\n namespace bookingsServicesV2Service_universal_d {\n export {\n bookingsServicesV2Service_universal_d_Service as Service,\n bookingsServicesV2Service_universal_d_ServiceType as ServiceType,\n bookingsServicesV2Service_universal_d_Media as Media,\n MediaItem$1 as MediaItem,\n bookingsServicesV2Service_universal_d_MediaItemItemOneOf as MediaItemItemOneOf,\n bookingsServicesV2Service_universal_d_V2Category as V2Category,\n bookingsServicesV2Service_universal_d_Form as Form,\n bookingsServicesV2Service_universal_d_FormSettings as FormSettings,\n bookingsServicesV2Service_universal_d_Payment as Payment,\n bookingsServicesV2Service_universal_d_PaymentRateOneOf as PaymentRateOneOf,\n bookingsServicesV2Service_universal_d_RateType as RateType,\n bookingsServicesV2Service_universal_d_FixedPayment as FixedPayment,\n bookingsServicesV2Service_universal_d_CommonMoney as CommonMoney,\n bookingsServicesV2Service_universal_d_CustomPayment as CustomPayment,\n bookingsServicesV2Service_universal_d_VariedPayment as VariedPayment,\n bookingsServicesV2Service_universal_d_PaymentOptions as PaymentOptions,\n bookingsServicesV2Service_universal_d_OnlineBooking as OnlineBooking,\n bookingsServicesV2Service_universal_d_Conferencing as Conferencing,\n Location$3 as Location,\n bookingsServicesV2Service_universal_d_LocationOptionsOneOf as LocationOptionsOneOf,\n LocationType$3 as LocationType,\n Address$4 as Address,\n AddressStreetOneOf$3 as AddressStreetOneOf,\n StreetAddress$3 as StreetAddress,\n AddressLocation$3 as AddressLocation,\n bookingsServicesV2Service_universal_d_BusinessLocationOptions as BusinessLocationOptions,\n bookingsServicesV2Service_universal_d_CustomLocationOptions as CustomLocationOptions,\n BookingPolicy$1 as BookingPolicy,\n PolicyDescription$1 as PolicyDescription,\n LimitEarlyBookingPolicy$1 as LimitEarlyBookingPolicy,\n LimitLateBookingPolicy$1 as LimitLateBookingPolicy,\n BookAfterStartPolicy$1 as BookAfterStartPolicy,\n CancellationPolicy$1 as CancellationPolicy,\n ReschedulePolicy$1 as ReschedulePolicy,\n WaitlistPolicy$1 as WaitlistPolicy,\n ParticipantsPolicy$1 as ParticipantsPolicy,\n ResourcesPolicy$1 as ResourcesPolicy,\n CancellationFeePolicy$1 as CancellationFeePolicy,\n CancellationWindow$1 as CancellationWindow,\n CancellationWindowFeeOneOf$1 as CancellationWindowFeeOneOf,\n SaveCreditCardPolicy$1 as SaveCreditCardPolicy,\n Schedule$1 as Schedule,\n AvailabilityConstraints$1 as AvailabilityConstraints,\n StaffMember$1 as StaffMember,\n bookingsServicesV2Service_universal_d_StaffMediaItem as StaffMediaItem,\n bookingsServicesV2Service_universal_d_StaffMediaItemItemOneOf as StaffMediaItemItemOneOf,\n bookingsServicesV2Service_universal_d_StaffMemberDetails as StaffMemberDetails,\n bookingsServicesV2Service_universal_d_ResourceGroup as ResourceGroup,\n bookingsServicesV2Service_universal_d_ResourceIds as ResourceIds,\n bookingsServicesV2Service_universal_d_ServiceResource as ServiceResource,\n bookingsServicesV2Service_universal_d_ServiceResourceSelectionOneOf as ServiceResourceSelectionOneOf,\n bookingsServicesV2Service_universal_d_ResourceType as ResourceType,\n bookingsServicesV2Service_universal_d_Slug as Slug,\n bookingsServicesV2Service_universal_d_URLs as URLs,\n ExtendedFields$4 as ExtendedFields,\n bookingsServicesV2Service_universal_d_SeoSchema as SeoSchema,\n bookingsServicesV2Service_universal_d_Keyword as Keyword,\n bookingsServicesV2Service_universal_d_Tag as Tag,\n bookingsServicesV2Service_universal_d_Settings as Settings,\n bookingsServicesV2Service_universal_d_ReindexMessage as ReindexMessage,\n bookingsServicesV2Service_universal_d_ReindexMessageActionOneOf as ReindexMessageActionOneOf,\n bookingsServicesV2Service_universal_d_Upsert as Upsert,\n bookingsServicesV2Service_universal_d_Delete as Delete,\n bookingsServicesV2Service_universal_d_Schema as Schema,\n bookingsServicesV2Service_universal_d_SetCustomSlugEvent as SetCustomSlugEvent,\n bookingsServicesV2Service_universal_d_ServicesUrlsChanged as ServicesUrlsChanged,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$5 as IdentificationData,\n IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n bookingsServicesV2Service_universal_d_CreateServiceRequest as CreateServiceRequest,\n bookingsServicesV2Service_universal_d_CreateServiceResponse as CreateServiceResponse,\n bookingsServicesV2Service_universal_d_BulkCreateServicesRequest as BulkCreateServicesRequest,\n bookingsServicesV2Service_universal_d_BulkCreateServicesResponse as BulkCreateServicesResponse,\n bookingsServicesV2Service_universal_d_BulkServiceResult as BulkServiceResult,\n ItemMetadata$2 as ItemMetadata,\n ApplicationError$2 as ApplicationError,\n BulkActionMetadata$2 as BulkActionMetadata,\n bookingsServicesV2Service_universal_d_GetServiceRequest as GetServiceRequest,\n RequestedFields$1 as RequestedFields,\n bookingsServicesV2Service_universal_d_GetServiceResponse as GetServiceResponse,\n bookingsServicesV2Service_universal_d_GetServiceAvailabilityConstraintsRequest as GetServiceAvailabilityConstraintsRequest,\n bookingsServicesV2Service_universal_d_GetServiceAvailabilityConstraintsResponse as GetServiceAvailabilityConstraintsResponse,\n bookingsServicesV2Service_universal_d_ServiceAvailabilityConstraints as ServiceAvailabilityConstraints,\n bookingsServicesV2Service_universal_d_V1SplitInterval as V1SplitInterval,\n bookingsServicesV2Service_universal_d_UpdateServiceRequest as UpdateServiceRequest,\n bookingsServicesV2Service_universal_d_UpdateServiceResponse as UpdateServiceResponse,\n bookingsServicesV2Service_universal_d_BulkUpdateServicesRequest as BulkUpdateServicesRequest,\n bookingsServicesV2Service_universal_d_MaskedService as MaskedService,\n bookingsServicesV2Service_universal_d_BulkUpdateServicesResponse as BulkUpdateServicesResponse,\n bookingsServicesV2Service_universal_d_BulkUpdateServicesByFilterRequest as BulkUpdateServicesByFilterRequest,\n bookingsServicesV2Service_universal_d_BulkUpdateServicesByFilterResponse as BulkUpdateServicesByFilterResponse,\n bookingsServicesV2Service_universal_d_DeleteServiceRequest as DeleteServiceRequest,\n ParticipantNotification$4 as ParticipantNotification,\n bookingsServicesV2Service_universal_d_DeleteServiceResponse as DeleteServiceResponse,\n bookingsServicesV2Service_universal_d_BulkDeleteServicesRequest as BulkDeleteServicesRequest,\n bookingsServicesV2Service_universal_d_BulkDeleteServicesResponse as BulkDeleteServicesResponse,\n bookingsServicesV2Service_universal_d_BulkDeleteServicesByFilterRequest as BulkDeleteServicesByFilterRequest,\n bookingsServicesV2Service_universal_d_BulkDeleteServicesByFilterResponse as BulkDeleteServicesByFilterResponse,\n bookingsServicesV2Service_universal_d_QueryServicesRequest as QueryServicesRequest,\n QueryV2$2 as QueryV2,\n QueryV2PagingMethodOneOf$2 as QueryV2PagingMethodOneOf,\n Sorting$4 as Sorting,\n SortOrder$4 as SortOrder,\n Paging$2 as Paging,\n CursorPaging$4 as CursorPaging,\n bookingsServicesV2Service_universal_d_QueryServicesResponse as QueryServicesResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$4 as Cursors,\n bookingsServicesV2Service_universal_d_SearchServicesRequest as SearchServicesRequest,\n CursorSearch$1 as CursorSearch,\n CursorSearchPagingMethodOneOf$1 as CursorSearchPagingMethodOneOf,\n bookingsServicesV2Service_universal_d_Aggregation as Aggregation,\n bookingsServicesV2Service_universal_d_AggregationKindOneOf as AggregationKindOneOf,\n bookingsServicesV2Service_universal_d_RangeBucket as RangeBucket,\n bookingsServicesV2Service_universal_d_SortType as SortType,\n bookingsServicesV2Service_universal_d_SortDirection as SortDirection,\n bookingsServicesV2Service_universal_d_MissingValues as MissingValues,\n bookingsServicesV2Service_universal_d_IncludeMissingValuesOptions as IncludeMissingValuesOptions,\n ScalarType$1 as ScalarType,\n bookingsServicesV2Service_universal_d_ValueAggregation as ValueAggregation,\n bookingsServicesV2Service_universal_d_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf,\n bookingsServicesV2Service_universal_d_NestedAggregationType as NestedAggregationType,\n bookingsServicesV2Service_universal_d_RangeAggregation as RangeAggregation,\n bookingsServicesV2Service_universal_d_ScalarAggregation as ScalarAggregation,\n bookingsServicesV2Service_universal_d_DateHistogramAggregation as DateHistogramAggregation,\n bookingsServicesV2Service_universal_d_DateHistogramAggregationInterval as DateHistogramAggregationInterval,\n bookingsServicesV2Service_universal_d_NestedAggregationItem as NestedAggregationItem,\n bookingsServicesV2Service_universal_d_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf,\n AggregationType$1 as AggregationType,\n bookingsServicesV2Service_universal_d_NestedAggregation as NestedAggregation,\n bookingsServicesV2Service_universal_d_GroupByAggregation as GroupByAggregation,\n bookingsServicesV2Service_universal_d_GroupByAggregationKindOneOf as GroupByAggregationKindOneOf,\n SearchDetails$1 as SearchDetails,\n Mode$1 as Mode,\n bookingsServicesV2Service_universal_d_SearchServicesResponse as SearchServicesResponse,\n CursorPagingMetadata$3 as CursorPagingMetadata,\n AggregationData$1 as AggregationData,\n ValueAggregationResult$1 as ValueAggregationResult,\n RangeAggregationResult$1 as RangeAggregationResult,\n NestedAggregationResults$1 as NestedAggregationResults,\n NestedAggregationResultsResultOneOf$1 as NestedAggregationResultsResultOneOf,\n ValueResults$1 as ValueResults,\n RangeResults$1 as RangeResults,\n ScalarResult$1 as ScalarResult,\n NestedValueAggregationResult$1 as NestedValueAggregationResult,\n bookingsServicesV2Service_universal_d_ValueResult as ValueResult,\n bookingsServicesV2Service_universal_d_RangeResult as RangeResult,\n bookingsServicesV2Service_universal_d_NestedResultsScalarResult as NestedResultsScalarResult,\n bookingsServicesV2Service_universal_d_NestedResultValue as NestedResultValue,\n bookingsServicesV2Service_universal_d_NestedResultValueResultOneOf as NestedResultValueResultOneOf,\n bookingsServicesV2Service_universal_d_Results as Results,\n bookingsServicesV2Service_universal_d_DateHistogramResult as DateHistogramResult,\n GroupByValueResults$1 as GroupByValueResults,\n bookingsServicesV2Service_universal_d_DateHistogramResults as DateHistogramResults,\n bookingsServicesV2Service_universal_d_NestedResults as NestedResults,\n AggregationResults$1 as AggregationResults,\n AggregationResultsResultOneOf$1 as AggregationResultsResultOneOf,\n bookingsServicesV2Service_universal_d_QueryPoliciesRequest as QueryPoliciesRequest,\n CursorQuery$2 as CursorQuery,\n CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf,\n bookingsServicesV2Service_universal_d_QueryPoliciesResponse as QueryPoliciesResponse,\n bookingsServicesV2Service_universal_d_BookingPolicyWithServices as BookingPolicyWithServices,\n bookingsServicesV2Service_universal_d_CountServicesRequest as CountServicesRequest,\n bookingsServicesV2Service_universal_d_CountServicesResponse as CountServicesResponse,\n bookingsServicesV2Service_universal_d_QueryLocationsRequest as QueryLocationsRequest,\n bookingsServicesV2Service_universal_d_QueryLocationsFilter as QueryLocationsFilter,\n bookingsServicesV2Service_universal_d_QueryLocationsResponse as QueryLocationsResponse,\n bookingsServicesV2Service_universal_d_BusinessLocations as BusinessLocations,\n bookingsServicesV2Service_universal_d_CustomLocations as CustomLocations,\n bookingsServicesV2Service_universal_d_CustomerLocations as CustomerLocations,\n bookingsServicesV2Service_universal_d_QueryCategoriesRequest as QueryCategoriesRequest,\n bookingsServicesV2Service_universal_d_QueryCategoriesFilter as QueryCategoriesFilter,\n bookingsServicesV2Service_universal_d_QueryCategoriesResponse as QueryCategoriesResponse,\n bookingsServicesV2Service_universal_d_QueryServicesMultiLanguageRequest as QueryServicesMultiLanguageRequest,\n bookingsServicesV2Service_universal_d_QueryServicesMultiLanguageResponse as QueryServicesMultiLanguageResponse,\n bookingsServicesV2Service_universal_d_SetServiceLocationsRequest as SetServiceLocationsRequest,\n bookingsServicesV2Service_universal_d_RemovedLocationSessionsAction as RemovedLocationSessionsAction,\n bookingsServicesV2Service_universal_d_RemovedLocationSessionsActionActionOptionsOneOf as RemovedLocationSessionsActionActionOptionsOneOf,\n bookingsServicesV2Service_universal_d_Action as Action,\n bookingsServicesV2Service_universal_d_MoveToNewLocationsOptions as MoveToNewLocationsOptions,\n bookingsServicesV2Service_universal_d_SetServiceLocationsResponse as SetServiceLocationsResponse,\n bookingsServicesV2Service_universal_d_EnablePricingPlansForServiceRequest as EnablePricingPlansForServiceRequest,\n bookingsServicesV2Service_universal_d_EnablePricingPlansForServiceResponse as EnablePricingPlansForServiceResponse,\n bookingsServicesV2Service_universal_d_InvalidPricingPlan as InvalidPricingPlan,\n bookingsServicesV2Service_universal_d_DisablePricingPlansForServiceRequest as DisablePricingPlansForServiceRequest,\n bookingsServicesV2Service_universal_d_DisablePricingPlansForServiceResponse as DisablePricingPlansForServiceResponse,\n bookingsServicesV2Service_universal_d_SetCustomSlugRequest as SetCustomSlugRequest,\n bookingsServicesV2Service_universal_d_SetCustomSlugResponse as SetCustomSlugResponse,\n bookingsServicesV2Service_universal_d_ValidateSlugRequest as ValidateSlugRequest,\n bookingsServicesV2Service_universal_d_ValidateSlugResponse as ValidateSlugResponse,\n bookingsServicesV2Service_universal_d_InvalidSlugError as InvalidSlugError,\n bookingsServicesV2Service_universal_d_CloneServiceRequest as CloneServiceRequest,\n bookingsServicesV2Service_universal_d_CloneServiceResponse as CloneServiceResponse,\n bookingsServicesV2Service_universal_d_CloneErrors as CloneErrors,\n bookingsServicesV2Service_universal_d_CategoryNotification as CategoryNotification,\n bookingsServicesV2Service_universal_d_Category as Category,\n Status$1 as Status,\n bookingsServicesV2Service_universal_d_Event as Event,\n Empty$2 as Empty,\n ScheduleNotification$1 as ScheduleNotification,\n ScheduleNotificationEventOneOf$1 as ScheduleNotificationEventOneOf,\n ScheduleCreated$1 as ScheduleCreated,\n bookingsServicesV2Service_universal_d_V1Schedule as V1Schedule,\n RecurringInterval$1 as RecurringInterval,\n Interval$1 as Interval,\n Day$1 as Day,\n Frequency$1 as Frequency,\n LinkedSchedule$1 as LinkedSchedule,\n Transparency$1 as Transparency,\n RecurringIntervalType$1 as RecurringIntervalType,\n bookingsServicesV2Service_universal_d_V1Location as V1Location,\n LocationLocationType$1 as LocationLocationType,\n bookingsServicesV2Service_universal_d_CommonAddress as CommonAddress,\n bookingsServicesV2Service_universal_d_CommonAddressStreetOneOf as CommonAddressStreetOneOf,\n bookingsServicesV2Service_universal_d_CommonStreetAddress as CommonStreetAddress,\n bookingsServicesV2Service_universal_d_CommonAddressLocation as CommonAddressLocation,\n Subdivision$3 as Subdivision,\n LocationsLocation$1 as LocationsLocation,\n LocationStatus$1 as LocationStatus,\n LocationsLocationType$1 as LocationsLocationType,\n LocationsAddress$1 as LocationsAddress,\n LocationsStreetAddress$1 as LocationsStreetAddress,\n LocationsAddressLocation$1 as LocationsAddressLocation,\n BusinessSchedule$2 as BusinessSchedule,\n TimePeriod$2 as TimePeriod,\n DayOfWeek$2 as DayOfWeek,\n SpecialHourPeriod$2 as SpecialHourPeriod,\n Rate$1 as Rate,\n Price$1 as Price,\n Availability$1 as Availability,\n bookingsServicesV2Service_universal_d_V1AvailabilityConstraints as V1AvailabilityConstraints,\n SplitInterval$1 as SplitInterval,\n Participant$1 as Participant,\n ApprovalStatus$1 as ApprovalStatus,\n ExternalCalendarOverrides$1 as ExternalCalendarOverrides,\n ScheduleStatus$1 as ScheduleStatus,\n Version$1 as Version,\n ConferenceProvider$1 as ConferenceProvider,\n CalendarConference$1 as CalendarConference,\n ConferenceType$1 as ConferenceType,\n ScheduleUpdated$1 as ScheduleUpdated,\n RecurringSessionsUpdated$1 as RecurringSessionsUpdated,\n Session$1 as Session,\n CalendarDateTime$1 as CalendarDateTime,\n LocalDateTime$1 as LocalDateTime,\n ExternalCalendarInfo$1 as ExternalCalendarInfo,\n CalendarType$1 as CalendarType,\n bookingsServicesV2Service_universal_d_SessionStatus as SessionStatus,\n SessionType$1 as SessionType,\n SessionVersion$1 as SessionVersion,\n bookingsServicesV2Service_universal_d_V1ParticipantNotification as V1ParticipantNotification,\n ScheduleCancelled$1 as ScheduleCancelled,\n SessionCreated$1 as SessionCreated,\n SessionUpdated$1 as SessionUpdated,\n SessionCancelled$1 as SessionCancelled,\n AvailabilityPolicyUpdated$1 as AvailabilityPolicyUpdated,\n AvailabilityPolicy$1 as AvailabilityPolicy,\n IntervalSplit$1 as IntervalSplit,\n RecurringSessionSplit$1 as RecurringSessionSplit,\n ScheduleUnassignedFromUser$1 as ScheduleUnassignedFromUser,\n MultipleSessionsCreated$1 as MultipleSessionsCreated,\n ScheduleWithSessions$1 as ScheduleWithSessions,\n SitePropertiesOnScheduleCreation$1 as SitePropertiesOnScheduleCreation,\n MigrationEvent$1 as MigrationEvent,\n MigrationData$1 as MigrationData,\n StaffData$1 as StaffData,\n bookingsServicesV2Service_universal_d_ResourceNotification as ResourceNotification,\n Resource$1 as Resource,\n bookingsServicesV2Service_universal_d_ResourceStatus as ResourceStatus,\n bookingsServicesV2Service_universal_d_BusinessLocation as BusinessLocation,\n bookingsServicesV2Service_universal_d_ResourceNotificationEvent as ResourceNotificationEvent,\n bookingsServicesV2Service_universal_d_BenefitNotification as BenefitNotification,\n bookingsServicesV2Service_universal_d_Benefit as Benefit,\n bookingsServicesV2Service_universal_d_EntryPass as EntryPass,\n bookingsServicesV2Service_universal_d_Discount as Discount,\n bookingsServicesV2Service_universal_d_DiscountDiscountOneOf as DiscountDiscountOneOf,\n bookingsServicesV2Service_universal_d_BenefitType as BenefitType,\n bookingsServicesV2Service_universal_d_Behavior as Behavior,\n bookingsServicesV2Service_universal_d_BehaviorBehaviorOneOf as BehaviorBehaviorOneOf,\n bookingsServicesV2Service_universal_d_BenefitNotificationEvent as BenefitNotificationEvent,\n bookingsServicesV2Service_universal_d_UserDomainInfoChangedEvent as UserDomainInfoChangedEvent,\n bookingsServicesV2Service_universal_d_CrudType as CrudType,\n bookingsServicesV2Service_universal_d_HtmlSitePublished as HtmlSitePublished,\n bookingsServicesV2Service_universal_d_Page as Page,\n SitePropertiesNotification$1 as SitePropertiesNotification,\n SitePropertiesEvent$1 as SitePropertiesEvent,\n Properties$1 as Properties,\n Categories$1 as Categories,\n Locale$1 as Locale,\n bookingsServicesV2Service_universal_d_V4Address as V4Address,\n AddressHint$1 as AddressHint,\n PlacementType$1 as PlacementType,\n GeoCoordinates$1 as GeoCoordinates,\n Multilingual$1 as Multilingual,\n SupportedLanguage$1 as SupportedLanguage,\n ResolutionMethod$1 as ResolutionMethod,\n ConsentPolicy$1 as ConsentPolicy,\n Translation$1 as Translation,\n ChangeContext$1 as ChangeContext,\n ChangeContextPayloadOneOf$1 as ChangeContextPayloadOneOf,\n PropertiesChange$1 as PropertiesChange,\n SiteCreated$2 as SiteCreated,\n SiteCloned$1 as SiteCloned,\n bookingsServicesV2Service_universal_d_MultiServiceEnabledNotification as MultiServiceEnabledNotification,\n bookingsServicesV2Service_universal_d_createService as createService,\n bookingsServicesV2Service_universal_d_bulkCreateServices as bulkCreateServices,\n bookingsServicesV2Service_universal_d_BulkCreateServicesOptions as BulkCreateServicesOptions,\n bookingsServicesV2Service_universal_d_getService as getService,\n bookingsServicesV2Service_universal_d_GetServiceOptions as GetServiceOptions,\n bookingsServicesV2Service_universal_d_getServiceAvailabilityConstraints as getServiceAvailabilityConstraints,\n bookingsServicesV2Service_universal_d_updateService as updateService,\n bookingsServicesV2Service_universal_d_UpdateService as UpdateService,\n bookingsServicesV2Service_universal_d_UpdateServiceOptions as UpdateServiceOptions,\n bookingsServicesV2Service_universal_d_bulkUpdateServices as bulkUpdateServices,\n bookingsServicesV2Service_universal_d_BulkUpdateServicesOptions as BulkUpdateServicesOptions,\n bookingsServicesV2Service_universal_d_bulkUpdateServicesByFilter as bulkUpdateServicesByFilter,\n bookingsServicesV2Service_universal_d_BulkUpdateServicesByFilterOptions as BulkUpdateServicesByFilterOptions,\n bookingsServicesV2Service_universal_d_deleteService as deleteService,\n bookingsServicesV2Service_universal_d_DeleteServiceOptions as DeleteServiceOptions,\n bookingsServicesV2Service_universal_d_bulkDeleteServices as bulkDeleteServices,\n bookingsServicesV2Service_universal_d_BulkDeleteServicesOptions as BulkDeleteServicesOptions,\n bookingsServicesV2Service_universal_d_bulkDeleteServicesByFilter as bulkDeleteServicesByFilter,\n bookingsServicesV2Service_universal_d_BulkDeleteServicesByFilterOptions as BulkDeleteServicesByFilterOptions,\n bookingsServicesV2Service_universal_d_queryServices as queryServices,\n bookingsServicesV2Service_universal_d_QueryServicesOptions as QueryServicesOptions,\n bookingsServicesV2Service_universal_d_ServicesQueryResult as ServicesQueryResult,\n bookingsServicesV2Service_universal_d_ServicesQueryBuilder as ServicesQueryBuilder,\n bookingsServicesV2Service_universal_d_searchServices as searchServices,\n bookingsServicesV2Service_universal_d_queryPolicies as queryPolicies,\n bookingsServicesV2Service_universal_d_countServices as countServices,\n bookingsServicesV2Service_universal_d_CountServicesOptions as CountServicesOptions,\n bookingsServicesV2Service_universal_d_queryLocations as queryLocations,\n bookingsServicesV2Service_universal_d_QueryLocationsOptions as QueryLocationsOptions,\n bookingsServicesV2Service_universal_d_queryCategories as queryCategories,\n bookingsServicesV2Service_universal_d_QueryCategoriesOptions as QueryCategoriesOptions,\n bookingsServicesV2Service_universal_d_queryServicesMultiLanguage as queryServicesMultiLanguage,\n bookingsServicesV2Service_universal_d_QueryServicesMultiLanguageOptions as QueryServicesMultiLanguageOptions,\n bookingsServicesV2Service_universal_d_setServiceLocations as setServiceLocations,\n bookingsServicesV2Service_universal_d_SetServiceLocationsOptions as SetServiceLocationsOptions,\n bookingsServicesV2Service_universal_d_enablePricingPlansForService as enablePricingPlansForService,\n bookingsServicesV2Service_universal_d_disablePricingPlansForService as disablePricingPlansForService,\n bookingsServicesV2Service_universal_d_DisablePricingPlansForServiceOptions as DisablePricingPlansForServiceOptions,\n bookingsServicesV2Service_universal_d_setCustomSlug as setCustomSlug,\n bookingsServicesV2Service_universal_d_validateSlug as validateSlug,\n bookingsServicesV2Service_universal_d_ValidateSlugOptions as ValidateSlugOptions,\n bookingsServicesV2Service_universal_d_cloneService as cloneService,\n bookingsServicesV2Service_universal_d_CloneServiceOptions as CloneServiceOptions,\n };\n }\n \n /** StaffMember is the main entity of Bookings StaffMembers. used to manage staff providing services */\n interface StaffMember {\n /**\n * Staff member's ID\n * @readonly\n */\n _id?: string | null;\n /** Staff member's name. */\n name?: string | null;\n /** Staff member's email address. */\n email?: string | null;\n /** Staff member's phone number. */\n phone?: string | null;\n /** Description, For example: \"The best masseuse in all of the land\" */\n description?: string | null;\n /** The media of the staff. */\n mainMedia?: MediaItem;\n /**\n * The related calendar resource id, same as `resource.id`\n * @readonly\n */\n resourceId?: string | null;\n /**\n * The related calendar resource\n * @readonly\n */\n resource?: Resource;\n /**\n * The identity of the Wix user associated with the staff member.\n *\n * To connect a staff member to a Wix user, use `ConnectStaffMemberToUser`.\n * To disconnect a staff member from a Wix user, use `DisconnectStaffMemberFromUser`.\n * @readonly\n */\n associatedWixIdentity?: AssociatedWixIdentity;\n /**\n * A staff member conferencing providers.\n * Field is deprecated, use associated_conferencing_accounts instead.\n * @internal\n * @readonly\n * @deprecated\n * @replacedBy associated_conferencing_accounts\n * @targetRemovalDate 2024-10-01\n */\n associatedConferencingProviders?: AssociatedConferencingProviders;\n /**\n * Conferencing accounts used to create meetings links with this staff member.\n * @internal\n * @readonly\n */\n associatedConferencingAccounts?: AssociatedConferencingAccounts;\n /**\n * `true` - if staff was auto created default staff.\n * @internal\n * @readonly\n */\n default?: boolean;\n /**\n * Revision number, which increments by 1 each time the staff member is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the staff member.\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this staff member was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this staff member was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Extensions enabling users to save custom data related to the staff member. */\n extendedFields?: ExtendedFields$3;\n }\n interface MediaItem extends MediaItemMediaOneOf {\n /** Staff members main image. */\n image?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /** Staff members main image. */\n image?: string;\n }\n interface Resource {\n /** The related calendar resource Id, same as `resourceId`. */\n _id?: string | null;\n /** The working hours schedules of the staff member, used to determine the availability of the staff member. Currently only one is supported. */\n workingHoursSchedules?: WorkingHoursSchedule[];\n /** The schedule containing the sessions in which this resource is booked. */\n eventsSchedule?: EventSchedule;\n /** `true` if the staff member uses the default business working hours schedule. Returns `false` otherwise. */\n usesDefaultWorkingHours?: boolean;\n }\n interface WorkingHoursSchedule {\n /** The related schedule ID */\n _id?: string | null;\n /** `true` if it is a shared schedule (For example, the default business working hours schedule), `false` or empty if this is a custom schedule specific to the resource. */\n shared?: boolean;\n }\n interface EventSchedule {\n /** The related schedule ID */\n _id?: string | null;\n }\n /** A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager. */\n interface AssociatedWixIdentity {\n /** Users identification data, returned only when the staff member is connected to a Wix user */\n identificationData?: IdentificationData$4;\n /**\n * Staff members connection status to the user.\n * @readonly\n * @deprecated Staff members connection status to the user.\n * @replacedBy connection_state\n * @targetRemovalDate 2024-12-01\n */\n connectionStatus?: AssociatedWixIdentityConnectionStatusEnumConnectionStatus;\n /**\n * The connection state between a staff member and a Wix user.\n * Returned only when `ASSOCIATED_IDENTITY_STATUS` is provided in the `fields` parameter.\n * @readonly\n */\n connectionState?: ConnectionState;\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 * @internal\n * @readonly\n */\n identityType?: IdentityType$2;\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 enum AssociatedWixIdentityConnectionStatusEnumConnectionStatus {\n /** User connection status is unknown. */\n UNKNOWN = \"UNKNOWN\",\n /** User is connected to the staff member. */\n CONNECTED = \"CONNECTED\",\n /** User connection is pending. */\n PENDING = \"PENDING\",\n /** Pending connections invite has expired. */\n EXPIRED = \"EXPIRED\",\n /** User is disconnected from the staff member. */\n DISCONNECTED = \"DISCONNECTED\"\n }\n interface ConnectionState {\n /** @readonly */\n status?: ConnectionStateConnectionState;\n }\n enum ConnectionStateConnectionState {\n /** User connection status is unknown. Only returned when conditional field for status is not selected. */\n UNKNOWN = \"UNKNOWN\",\n /** User is connected to the staff member. */\n CONNECTED = \"CONNECTED\",\n /** User connection is pending. */\n PENDING = \"PENDING\",\n /** Pending connections invite has expired. */\n EXPIRED = \"EXPIRED\",\n /** User is disconnected from the staff member. */\n DISCONNECTED = \"DISCONNECTED\"\n }\n interface AssociatedConferencingProviders {\n /** Conferencing accounts that are connected to this staff. */\n items?: AssociatedConferencingProvider[];\n }\n interface AssociatedConferencingProvider {\n /** Conferencing provider id, e.g. Zoom integration identifier. */\n _id?: string;\n /** Provider name, e.g. Zoom. */\n name?: string;\n /** Connection status. */\n connectionStatus?: ConnectionStatus;\n /** Conferencing account email. Might not match staff email. */\n accountEmail?: string | null;\n }\n enum ConnectionStatus {\n UNKNOWN = \"UNKNOWN\",\n /** Provider is connected to site and user is authenticated. */\n CONNECTED = \"CONNECTED\",\n /** Provider is not connected to site or user is not authenticated. */\n DISCONNECTED = \"DISCONNECTED\"\n }\n interface AssociatedConferencingAccounts {\n /** Conferencing accounts that are connected to this staff. */\n items?: AssociatedConferencingAccount[];\n }\n interface AssociatedConferencingAccount extends AssociatedConferencingAccountAccountOneOf {\n /**\n * Conferencing for this staff member is configured via an external provider.\n * For example, Zoom integration generating a link for sessions with the staff member.\n */\n providerAccount?: AssociatedConferencingProvider;\n /**\n * Conferencing for this staff member is configured via a custom conference link.\n * Custom conference link details.\n */\n customAccount?: CustomConferenceAccount;\n }\n /** @oneof */\n interface AssociatedConferencingAccountAccountOneOf {\n /**\n * Conferencing for this staff member is configured via an external provider.\n * For example, Zoom integration generating a link for sessions with the staff member.\n */\n providerAccount?: AssociatedConferencingProvider;\n /**\n * Conferencing for this staff member is configured via a custom conference link.\n * Custom conference link details.\n */\n customAccount?: CustomConferenceAccount;\n }\n interface CustomConferenceAccount {\n /** Conferencing url. For example, a Google meet link. */\n url?: string | null;\n /** Optional password that protects the conferencing link. */\n password?: string | null;\n /** Optional description of the conference link. */\n description?: 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 CreateStaffMemberRequest {\n /** Staff Member to be created. */\n staffMember: StaffMember;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n enum RequestedFields {\n UNKNOWN_REQUESTED_FIELD = \"UNKNOWN_REQUESTED_FIELD\",\n /**\n * Stating this value in the `fields` parameter would\n * return the resource details, including the resource's schedule ids in the `resource` field.\n */\n RESOURCE_DETAILS = \"RESOURCE_DETAILS\",\n /**\n * Stating this value in the `fields` parameter would\n * return the conference accounts used to create conference links, in the `associatedConferencingProviders` property.\n */\n ASSOCIATED_CONFERENCING_PROVIDERS = \"ASSOCIATED_CONFERENCING_PROVIDERS\",\n /**\n * Stating this value in the `fields` parameter would\n * return `associatedWixIdentity.connectionState` which contains the connection status of a staff member to a Wix user.\n */\n ASSOCIATED_IDENTITY_STATUS = \"ASSOCIATED_IDENTITY_STATUS\",\n /**\n * Stating this value in the `fields` parameter would\n * return the conference accounts used to create conference links, in the `associatedConferencingAccounts` property.\n */\n ASSOCIATED_CONFERENCING_ACCOUNTS = \"ASSOCIATED_CONFERENCING_ACCOUNTS\"\n }\n interface CreateStaffMemberResponse {\n /** The created staff member. */\n staffMember?: StaffMember;\n }\n /**\n * This message is used to notify that a staff member has been fully created. For now it is only needed for\n * producing the correct Resources V1 events. A decision will be made later whether to keep it or not.\n */\n interface StaffMemberFullyCreated {\n /** the staff member that */\n staffMember?: StaffMember;\n }\n interface GetStaffMemberRequest {\n /** ID of the staff member to retrieve. */\n staffMemberId: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface GetStaffMemberResponse {\n /** The retrieved StaffMember. */\n staffMember?: StaffMember;\n }\n interface GetDeletedStaffMemberRequest {\n /** Id of the staff member to retrieve */\n staffMemberId: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface GetDeletedStaffMemberResponse {\n /** The retrieved staff member. */\n staffMember?: StaffMember;\n }\n interface ListDeletedStaffMembersRequest {\n /** The Ids of the staff members to retrieve. If omitted all deleted staff members will be retrieved paginated. */\n staffMemberIds?: string[];\n /** Paging parameter, enabling to pass a limit and a cursor. */\n paging?: CursorPaging$3;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\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 ListDeletedStaffMembersResponse {\n /** The retrieved staff members. */\n staffMembers?: StaffMember[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$2;\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 /** Cursor pointing to previous page in the list of results. */\n prev?: string | null;\n }\n interface RemoveStaffMemberFromTrashBinRequest {\n /** Id of the staff member to remove from the trash bin */\n staffMemberId: string;\n }\n interface RemoveStaffMemberFromTrashBinResponse {\n }\n interface RestoreStaffMemberFromTrashBinRequest {\n /** Id of the staff member to restore from the trash bin */\n staffMemberId: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface RestoreStaffMemberFromTrashBinResponse {\n /** The restored staff member. */\n staffMember?: StaffMember;\n }\n interface UpdateStaffMemberRequest {\n /** Staff member to update. [Partial */\n staffMember: StaffMember;\n /**\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n * @internal\n */\n fieldMask?: string[];\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface UpdateStaffMemberResponse {\n /** The updated staff member. */\n staffMember?: StaffMember;\n }\n interface DeleteStaffMemberRequest {\n /** Id of the staff member to delete. */\n staffMemberId: string;\n }\n interface DeleteStaffMemberResponse {\n }\n interface StaffMemberDisconnectedFromUser {\n /** The staff member entity after disconnecting it from a user. */\n staffMember?: StaffMember;\n }\n interface QueryStaffMembersRequest {\n /** WQL expression. */\n query?: CursorQuery$1;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$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$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$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$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 QueryStaffMembersResponse {\n /** The retrieved staff members. */\n staffMembers?: StaffMember[];\n /** Paging metadata */\n pagingMetadata?: CursorPagingMetadata$2;\n }\n interface QueryStaffMembersMultiLanguageRequest {\n /** WQL expression. */\n query: CursorQuery$1;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface QueryStaffMembersMultiLanguageResponse {\n /** The retrieved staff members. */\n staffMembers?: StaffMember[];\n /** The retrieved staff members in the requested language according to the provided linguist aspect. */\n translatedStaffMembers?: StaffMember[];\n /** Paging metadata, including offset and count. */\n pagingMetadata?: CursorPagingMetadata$2;\n }\n interface CountStaffMembersRequest {\n /** The filters for performing the count. */\n filter?: Record | null;\n }\n interface CountStaffMembersResponse {\n /** The number of staff members matching the given filter. */\n count?: number;\n }\n interface ConnectStaffMemberToUserRequest {\n /** Id of the staff member. The staff member to connect to a user. */\n staffMemberId: string;\n /** Email of the user to send invitation to. The staff existing email would be used if not provided. */\n email?: string | null;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface ConnectStaffMemberToUserResponse {\n /** The updated staff member. After connecting to the user. */\n staffMember?: StaffMember;\n }\n interface StaffMemberConnectedToUser {\n /** The staff member entity after connecting it to a user. */\n staffMember?: StaffMember;\n }\n interface SearchStaffMembersRequest {\n /** WQL expression. */\n search: CursorSearch;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\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$3;\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$3[];\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$3;\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 /** 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 SearchStaffMembersResponse {\n /** The retrieved staff members matching the search criteria. */\n staffMembers?: StaffMember[];\n /** Paging metadata. including paging, offset and cursor. */\n pagingMetadata?: CursorPagingMetadata$2;\n /** Aggregation data results, resulting from the aggregations stated in the request. */\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?: string;\n count?: number;\n }\n interface RangeAggregationResult {\n from?: number | null;\n to?: number | null;\n count?: number;\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 NestedAggregationResults extends NestedAggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: ScalarResult;\n name?: string;\n type?: AggregationType;\n fieldPath?: string;\n }\n /** @oneof */\n interface NestedAggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: ScalarResult;\n }\n enum AggregationType {\n UNKNOWN_AGGREGATION_TYPE = \"UNKNOWN_AGGREGATION_TYPE\",\n VALUE = \"VALUE\",\n RANGE = \"RANGE\",\n SCALAR = \"SCALAR\"\n }\n interface ValueResults {\n results?: ValueAggregationResult[];\n }\n interface RangeResults {\n results?: RangeAggregationResult[];\n }\n interface ScalarResult {\n type?: ScalarType;\n value?: number;\n }\n interface NestedValueAggregationResult {\n value?: string;\n nestedResults?: NestedAggregationResults;\n }\n interface GroupByValueResults {\n results?: NestedValueAggregationResult[];\n }\n interface AggregationResults extends AggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: ScalarResult;\n groupedByValue?: GroupByValueResults;\n name?: string;\n type?: AggregationType;\n fieldPath?: string;\n }\n /** @oneof */\n interface AggregationResultsResultOneOf {\n values?: ValueResults;\n ranges?: RangeResults;\n scalar?: ScalarResult;\n groupedByValue?: GroupByValueResults;\n }\n interface DisconnectStaffMemberFromUserRequest {\n /** Id of the StaffMember to disconnect. The staff member to disconnect from a user. */\n staffMemberId: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface DisconnectStaffMemberFromUserResponse {\n /** The updated staff member. After disconnecting from the user. */\n staffMember?: StaffMember;\n }\n interface AssignWorkingHoursScheduleRequest {\n /** Id of the staff member to assign the schedule to. */\n staffMemberId: string;\n /** Id of a schedule to assign to the staff's working hours schedule. */\n scheduleId: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface AssignWorkingHoursScheduleResponse {\n /** The updated staff member. After assigning the custom schedule. */\n staffMember?: StaffMember;\n }\n interface AssignCustomScheduleRequest {\n /** Id of the staff member to assign the schedule to. */\n staffMemberId: string;\n /** Id of a schedule to assign to the staff's working hours schedule. */\n scheduleId: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface AssignCustomScheduleResponse {\n /** The updated staff member. After assigning the custom schedule. */\n staffMember?: StaffMember;\n }\n interface RestoreStaffRequest {\n /** Id of the staff member to restore. */\n staffMemberId?: string;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface RestoreStaffResponse {\n /** The restored staff member. */\n staffMember?: StaffMember;\n }\n interface ImportStaffMemberRequest {\n /** StaffMember to be created. */\n staffMember?: StaffMember;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n interface ImportStaffMemberResponse {\n /** The imported StaffMember. */\n staffMember?: StaffMember;\n }\n interface Empty$1 {\n }\n interface PolicyRemovedFromContributor {\n accountId?: string;\n metaSiteId?: string;\n policyIds?: string[];\n }\n interface PolicyUpdatedForContributor {\n accountId?: string;\n metaSiteId?: string;\n oldPolicyIds?: string[];\n newPolicyIds?: 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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$3 {\n bodyAsJson?: string;\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 /** @deprecated */\n intervalSplit?: IntervalSplit;\n recurringSessionSplit?: RecurringSessionSplit;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent;\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;\n instanceId?: string;\n /**\n * true when the schedule belongs to a site that is rolled out to calendar v3\n * @internal\n */\n rolledOut?: boolean | null;\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 /** @deprecated */\n intervalSplit?: IntervalSplit;\n recurringSessionSplit?: RecurringSessionSplit;\n /**\n * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.\n * @deprecated\n */\n scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n multipleSessionsCreated?: MultipleSessionsCreated;\n /**\n * supported only for schedule migration apis.\n * @internal\n */\n migrationEvent?: MigrationEvent;\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 * Start time of the first session in the schedule.\n * @internal\n * @readonly\n */\n firstSessionStart?: Date | null;\n /**\n * End time of the last session in the schedule.\n * @internal\n * @readonly\n */\n lastSessionEnd?: Date | 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[];\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;\n /**\n * __Deprecated.__\n * @deprecated\n */\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 /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides;\n /**\n * Schedule status.\n * @readonly\n */\n status?: ScheduleStatus;\n /**\n * Schedule creation date.\n * @readonly\n */\n created?: Date | null;\n /**\n * Schedule last update date.\n * @readonly\n */\n updated?: Date | null;\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @readonly\n */\n version?: number;\n /**\n * The schedule version, updated each time the schedule or the schedule participants are updated.\n * @internal\n * @readonly\n */\n versions?: Version;\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;\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;\n /**\n * The name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * Currently, in Bookings system, it would be present when the schedule is owned by a staff resource and the resource is connected to a user.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 | null;\n /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */\n end?: Date | null;\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 /** The type of recurring interval. */\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. */\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 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 * 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;\n /**\n * Owner ID, of the linked schedule.\n * @readonly\n */\n scheduleOwnerId?: string;\n /**\n * The name of the linked schedule owner. It may be a resource name or a service name. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the linked schedule owner. Optional.\n * This field is inherited from the schedule identified by scheduleId above.\n * NOT IMPLEMENTED. YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\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 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 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$3;\n /**\n * The Wix Business location formatted address.\n * Valid when `locationType` is `OWNER_BUSINESS`. Defaults to the business's location.\n * To retrieve the full location data please use the [Locations API](https://dev.wix.com/api/rest/business-info/locations).\n * @internal\n */\n businessLocation?: LocationsLocation;\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$3 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 {\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?: 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$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[];\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$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 {\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 * Default service price. Always vailable when a service has\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Sometimes also available for services without variants.\n * Ignored in [updates to a service](https://dev.wix.com/api/rest/wix-bookings/services/service/update-service),\n * when either `labeled_price_options` or `price_text` is also specified.\n * @internal\n */\n defaultVariedPrice?: Price;\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 /**\n * \n */\n interface Availability {\n /** Date and time the schedule starts to be available for booking. */\n start?: Date | null;\n /** Date and time the schedule stops being available for booking. No value indicates no end time. */\n end?: Date | null;\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 * Not supported yet.\n * A list of possible locations for the session when `use_default_location` is set to `false`. Slots are generated for each location. Only one of the possible locations can be chosen by the customer.\n *\n * **NOTE**: When using the `locations` parameter, the default location is not automatically included in the list.\n * @internal\n */\n locations?: Location$2[];\n /**\n * Not supported yet.\n * Whether the schedule's slots are only available at the schedule's default location, as set in `schedule.location`. If set to `false`, the `locations` array is used to set the possible locations of the schedule's sessions.\n * Default is `true`.\n * @internal\n */\n useDefaultLocation?: boolean | null;\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 * @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;\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 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 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 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 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 CalendarConference {\n /** Wix Calendar conference ID. */\n _id?: string;\n /** Conference meeting ID in the provider's conferencing system. */\n externalId?: string;\n /**\n * A generated id for the conference entity - Base62($providerId$accountOwnerId$conferenceId)\n * @internal\n */\n conferenceId?: string | null;\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;\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 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$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 {\n /** Old schedule's recurring session list. */\n oldRecurringSessions?: Session[];\n /** New schedule's recurring session list. */\n newRecurringSessions?: 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 | null;\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 * @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 * The remaining number of participants that can be added to the session. Read-only.\n * Can be negative, in case the session is over capacity.\n * @internal\n * @readonly\n */\n remainingCapacity?: 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;\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 /**\n * Information about the external calendar, if the session originated in an external calendar.\n * @internal\n * @readonly\n */\n externalCalendarInfo?: ExternalCalendarInfo;\n /**\n * __Deprecated.__\n * @deprecated\n */\n externalCalendarOverrides?: ExternalCalendarOverrides;\n /**\n * Session status.\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 * @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;\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;\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 name of the schedule owner. It may be a resource name or a service name. Optional.\n * @internal\n * @readonly\n */\n scheduleOwnerName?: string | null;\n /**\n * The user id of the schedule owner. Optional.\n * NOT IMPLEMENTED YET.\n * @internal\n * @readonly\n */\n scheduleOwnerUserId?: string | null;\n /**\n * The session version.\n * Composed by the schedule, session and participants versions.\n * @readonly\n */\n version?: SessionVersion;\n /**\n * The ID of the event in the new Calendar Events V3 API.\n * @internal\n * @readonly\n */\n eventId?: string | null;\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 | null;\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 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 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 SessionVersion {\n /**\n * Schedule version number, updated each time the schedule is updated.\n * @internal\n */\n scheduleVersion?: number;\n /**\n * Session version number, updated each time the session is updated.\n * @internal\n */\n sessionVersion?: number;\n /**\n * Participants version number, updated each time the session participants are updated.\n * @internal\n */\n participantsVersion?: number | null;\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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\n }\n interface ScheduleCancelled {\n schedule?: Schedule;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$3;\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$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 {\n session?: Session;\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$3;\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 MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {\n /** Emitted on a meta site creation. */\n siteCreated?: SiteCreated$1;\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$1;\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$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;\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 }\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 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 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?: WebhooksIdentificationData$1;\n /** Stringify payload. */\n data?: string;\n }\n interface WebhooksIdentificationData$1 extends WebhooksIdentificationDataIdOneOf$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$3;\n }\n /** @oneof */\n interface WebhooksIdentificationDataIdOneOf$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$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 staff member.\n *\n *\n * By using the create API, you can create a staff member and set its name, email, phone, description and media.\n * By default any staff member that is created will be linked to the business working hours, allowing customers to book appointments with the staff\n * based on the business working hours.\n * @param staffMember - Staff Member to be created.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMember\n * @requiredField staffMember.name\n * @permissionId BOOKINGS.STAFF_MEMBER_CREATE\n * @adminMethod\n * @returns The created staff member.\n */\n function createStaffMember(staffMember: StaffMember, options?: CreateStaffMemberOptions): Promise;\n interface CreateStaffMemberOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves a staff member by id.\n * @param staffMemberId - ID of the staff member to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_READ\n * @adminMethod\n * @returns The retrieved StaffMember.\n */\n function getStaffMember(staffMemberId: string, options?: GetStaffMemberOptions): Promise;\n interface GetStaffMemberOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves a deleted staff member from the trash-bin.\n * @param staffMemberId - Id of the staff member to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_READ\n */\n function getDeletedStaffMember(staffMemberId: string, options?: GetDeletedStaffMemberOptions): Promise;\n interface GetDeletedStaffMemberOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves a list of deleted staff members from the trash-bin.\n * List runs with these defaults, which you can override:\n * - `paging.limit` is `50`.\n * @internal\n * @documentationMaturity preview\n * @permissionId BOOKINGS.STAFF_MEMBER_READ\n */\n function listDeletedStaffMembers(options?: ListDeletedStaffMembersOptions): Promise;\n interface ListDeletedStaffMembersOptions {\n /** The Ids of the staff members to retrieve. If omitted all deleted staff members will be retrieved paginated. */\n staffMemberIds?: string[];\n /** Paging parameter, enabling to pass a limit and a cursor. */\n paging?: CursorPaging$3;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Remove a staff member from the trash bin, permanently deleting it.\n * This action is irreversible.\n * @param staffMemberId - Id of the staff member to remove from the trash bin\n * @internal\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_REMOVE_FROM_TRASH_BIN\n * @adminMethod\n */\n function removeStaffMemberFromTrashBin(staffMemberId: string): Promise;\n /**\n * Restore a staff member from the trash bin.\n * This action also restores the staff member's resource.\n * @param staffMemberId - Id of the staff member to restore from the trash bin\n * @internal\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_RESTORE_FROM_TRASH_BIN\n * @adminMethod\n */\n function restoreStaffMemberFromTrashBin(staffMemberId: string, options?: RestoreStaffMemberFromTrashBinOptions): Promise;\n interface RestoreStaffMemberFromTrashBinOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Updates a StaffMember.\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 staff member is updated, `revision` increments by 1. You must include current revision of the staff member when updating it.\n * This ensures you're working with the latest service information and prevents unintended overwrites.\n * @param _id - Staff member's ID\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField staffMember\n * @requiredField staffMember.revision\n * @permissionId BOOKINGS.STAFF_MEMBER_UPDATE\n * @adminMethod\n * @returns The updated staff member.\n */\n function updateStaffMember(_id: string | null, staffMember: UpdateStaffMember, options?: UpdateStaffMemberOptions): Promise;\n interface UpdateStaffMember {\n /**\n * Staff member's ID\n * @readonly\n */\n _id?: string | null;\n /** Staff member's name. */\n name?: string | null;\n /** Staff member's email address. */\n email?: string | null;\n /** Staff member's phone number. */\n phone?: string | null;\n /** Description, For example: \"The best masseuse in all of the land\" */\n description?: string | null;\n /** The media of the staff. */\n mainMedia?: MediaItem;\n /**\n * The related calendar resource id, same as `resource.id`\n * @readonly\n */\n resourceId?: string | null;\n /**\n * The related calendar resource\n * @readonly\n */\n resource?: Resource;\n /**\n * The identity of the Wix user associated with the staff member.\n *\n * To connect a staff member to a Wix user, use `ConnectStaffMemberToUser`.\n * To disconnect a staff member from a Wix user, use `DisconnectStaffMemberFromUser`.\n * @readonly\n */\n associatedWixIdentity?: AssociatedWixIdentity;\n /**\n * A staff member conferencing providers.\n * Field is deprecated, use associated_conferencing_accounts instead.\n * @internal\n * @readonly\n * @deprecated\n * @replacedBy associated_conferencing_accounts\n * @targetRemovalDate 2024-10-01\n */\n associatedConferencingProviders?: AssociatedConferencingProviders;\n /**\n * Conferencing accounts used to create meetings links with this staff member.\n * @internal\n * @readonly\n */\n associatedConferencingAccounts?: AssociatedConferencingAccounts;\n /**\n * `true` - if staff was auto created default staff.\n * @internal\n * @readonly\n */\n default?: boolean;\n /**\n * Revision number, which increments by 1 each time the staff member is updated.\n * To prevent conflicting changes,\n * the current revision must be passed when updating the staff member.\n * @readonly\n */\n revision?: string | null;\n /**\n * Represents the time this staff member was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Represents the time this staff member was last updated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Extensions enabling users to save custom data related to the staff member. */\n extendedFields?: ExtendedFields$3;\n }\n interface UpdateStaffMemberOptions {\n /**\n * updates](https://dev.wix.com/api/rest/wix-bookings/bookings/patch-endpoints-and-field-masks-in-update-requests)\n * are supported.\n * @internal\n */\n fieldMask?: string[];\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Deletes a StaffMember.\n * @param staffMemberId - Id of the staff member to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_DELETE\n * @adminMethod\n */\n function deleteStaffMember(staffMemberId: string): Promise;\n /**\n * Query StaffMembers using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.STAFF_MEMBER_READ\n * @adminMethod\n */\n function queryStaffMembers(options?: QueryStaffMembersOptions): StaffMembersQueryBuilder;\n interface QueryStaffMembersOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[] | undefined;\n }\n interface QueryCursorResult$2 {\n cursors: Cursors$3;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface StaffMembersQueryResult extends QueryCursorResult$2 {\n items: StaffMember[];\n query: StaffMembersQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface StaffMembersQueryBuilder {\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' | 'email' | 'phone' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | '_createdDate' | '_updatedDate', value: any) => StaffMembersQueryBuilder;\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' | 'email' | 'phone' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | '_createdDate' | '_updatedDate', value: any) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\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' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId', value: string) => StaffMembersQueryBuilder;\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' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | '_createdDate' | '_updatedDate', value: any[]) => StaffMembersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'name' | 'email' | 'phone' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | '_createdDate' | '_updatedDate', value: any) => StaffMembersQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'name' | 'email' | 'phone' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | '_createdDate' | '_updatedDate', value: boolean) => StaffMembersQueryBuilder;\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' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | 'associatedWixIdentity.identificationData.identityType' | 'default' | '_createdDate' | '_updatedDate'>) => StaffMembersQueryBuilder;\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' | 'description' | 'resourceId' | 'resource.id' | 'associatedWixIdentity.identificationData.wixUserId' | 'associatedWixIdentity.identificationData.contactId' | 'associatedWixIdentity.identificationData.identityType' | 'default' | '_createdDate' | '_updatedDate'>) => StaffMembersQueryBuilder;\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) => StaffMembersQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => StaffMembersQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Query staff members in multiple languages.\n *\n * Supports responses with text values (such as translated description) in different languages.\n * @param query - WQL expression.\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId BOOKINGS.STAFF_MEMBER_READ\n */\n function queryStaffMembersMultiLanguage(query: CursorQuery$1, options?: QueryStaffMembersMultiLanguageOptions): Promise;\n interface QueryStaffMembersMultiLanguageOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Counts staff members according to given criteria.\n *\n *\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 * @permissionId BOOKINGS.STAFF_MEMBER_READ\n * @adminMethod\n */\n function countStaffMembers(options?: CountStaffMembersOptions): Promise;\n interface CountStaffMembersOptions {\n /** The filters for performing the count. */\n filter?: Record | null;\n }\n /**\n * Connects staff member to a Wix user.\n *\n *\n * By default the staff member's email is used to connect to the user.\n * If the email is already associated with a wix user with roles and permissions to access the site, the staff member is connected to that user.\n * If the email is not associated with a wix user, an invitation is sent to the email to join the site.\n *\n * *Connecting a staff member to a user gives access to the user to manage the staff's schedule via the Wix backoffice.**\n *\n * The status of a staff member's connection is stored in the `associatedWixIdentity` field, and can be fetched using the requested field `ASSOCIATED_IDENTITY_STATUS`.\n * @param staffMemberId - Id of the staff member. The staff member to connect to a user.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_UPDATE\n * @adminMethod\n */\n function connectStaffMemberToUser(staffMemberId: string, options?: ConnectStaffMemberToUserOptions): Promise;\n interface ConnectStaffMemberToUserOptions {\n /** Email of the user to send invitation to. The staff existing email would be used if not provided. */\n email?: string | null;\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Retrieves a list of staff members matching the provided search criteria.\n *\n * The search endpoints allow to perform advance search including partial text search, exact match, and more.\n * The endpoint also allows to aggregate staff members by their name, email, phone, description, or resource id.\n * @param search - WQL expression.\n * @public\n * @documentationMaturity preview\n * @requiredField search\n * @permissionId BOOKINGS.STAFF_MEMBER_READ\n * @adminMethod\n */\n function searchStaffMembers(search: CursorSearch, options?: SearchStaffMembersOptions): Promise;\n interface SearchStaffMembersOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Disconnects a staff member from the Wix user.\n *\n * If the staff member is connected to a user, this API disconnects the staff member from the user, removing the `associatedWixIdentity` field.\n * The action removes the user's access to manage the staff member's schedule via the Wix backoffice.\n * @param staffMemberId - Id of the StaffMember to disconnect. The staff member to disconnect from a user.\n * @public\n * @documentationMaturity preview\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_UPDATE\n * @adminMethod\n */\n function disconnectStaffMemberFromUser(staffMemberId: string, options?: DisconnectStaffMemberFromUserOptions): Promise;\n interface DisconnectStaffMemberFromUserOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Assigns a custom working hours schedule to the staff member\n *\n *\n * The working hours schedule is a schedule that defines the working hours of a staff member,\n * and dictate when the staff member is available for bookings.\n *\n * By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member,\n * you can define specific working hours for that staff member.\n *\n * To create and manage schedules and working hours sessions, use [Schedules and Sessions API](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/schedules-and-sessions/introduction).\n * @param staffMemberId - Id of the staff member to assign the schedule to.\n * @param scheduleId - Id of a schedule to assign to the staff's working hours schedule.\n * @public\n * @documentationMaturity preview\n * @requiredField scheduleId\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_UPDATE\n * @adminMethod\n */\n function assignWorkingHoursSchedule(staffMemberId: string, scheduleId: string, options?: AssignWorkingHoursScheduleOptions): Promise;\n interface AssignWorkingHoursScheduleOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n /**\n * Assigns a custom working hours schedule to the staff member\n *\n *\n * The working hours schedule is a schedule that defines the working hours of a staff member,\n * and dictate when the staff member is available for bookings.\n *\n * By default staff members use the shared business working hours schedule. By assigning a custom working hours schedule to a staff member,\n * you can define specific working hours for that staff member.\n *\n * To create and manage schedules and working hours sessions, use [Schedules and Sessions API](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/schedules-and-sessions/introduction).\n * @param staffMemberId - Id of the staff member to assign the schedule to.\n * @param scheduleId - Id of a schedule to assign to the staff's working hours schedule.\n * @public\n * @documentationMaturity preview\n * @requiredField scheduleId\n * @requiredField staffMemberId\n * @permissionId BOOKINGS.STAFF_MEMBER_UPDATE\n * @adminMethod\n * @deprecated\n * @replacedBy AssignWorkingHoursSchedule\n * @targetRemovalDate 2024-12-31\n */\n function assignCustomSchedule(staffMemberId: string, scheduleId: string, options?: AssignCustomScheduleOptions): Promise;\n interface AssignCustomScheduleOptions {\n /** Conditional fields to return. */\n fields?: RequestedFields[];\n }\n \n type bookingsStaffV1StaffMember_universal_d_StaffMember = StaffMember;\n type bookingsStaffV1StaffMember_universal_d_MediaItem = MediaItem;\n type bookingsStaffV1StaffMember_universal_d_MediaItemMediaOneOf = MediaItemMediaOneOf;\n type bookingsStaffV1StaffMember_universal_d_Resource = Resource;\n type bookingsStaffV1StaffMember_universal_d_WorkingHoursSchedule = WorkingHoursSchedule;\n type bookingsStaffV1StaffMember_universal_d_EventSchedule = EventSchedule;\n type bookingsStaffV1StaffMember_universal_d_AssociatedWixIdentity = AssociatedWixIdentity;\n type bookingsStaffV1StaffMember_universal_d_AssociatedWixIdentityConnectionStatusEnumConnectionStatus = AssociatedWixIdentityConnectionStatusEnumConnectionStatus;\n const bookingsStaffV1StaffMember_universal_d_AssociatedWixIdentityConnectionStatusEnumConnectionStatus: typeof AssociatedWixIdentityConnectionStatusEnumConnectionStatus;\n type bookingsStaffV1StaffMember_universal_d_ConnectionState = ConnectionState;\n type bookingsStaffV1StaffMember_universal_d_ConnectionStateConnectionState = ConnectionStateConnectionState;\n const bookingsStaffV1StaffMember_universal_d_ConnectionStateConnectionState: typeof ConnectionStateConnectionState;\n type bookingsStaffV1StaffMember_universal_d_AssociatedConferencingProviders = AssociatedConferencingProviders;\n type bookingsStaffV1StaffMember_universal_d_AssociatedConferencingProvider = AssociatedConferencingProvider;\n type bookingsStaffV1StaffMember_universal_d_ConnectionStatus = ConnectionStatus;\n const bookingsStaffV1StaffMember_universal_d_ConnectionStatus: typeof ConnectionStatus;\n type bookingsStaffV1StaffMember_universal_d_AssociatedConferencingAccounts = AssociatedConferencingAccounts;\n type bookingsStaffV1StaffMember_universal_d_AssociatedConferencingAccount = AssociatedConferencingAccount;\n type bookingsStaffV1StaffMember_universal_d_AssociatedConferencingAccountAccountOneOf = AssociatedConferencingAccountAccountOneOf;\n type bookingsStaffV1StaffMember_universal_d_CustomConferenceAccount = CustomConferenceAccount;\n type bookingsStaffV1StaffMember_universal_d_CreateStaffMemberRequest = CreateStaffMemberRequest;\n type bookingsStaffV1StaffMember_universal_d_RequestedFields = RequestedFields;\n const bookingsStaffV1StaffMember_universal_d_RequestedFields: typeof RequestedFields;\n type bookingsStaffV1StaffMember_universal_d_CreateStaffMemberResponse = CreateStaffMemberResponse;\n type bookingsStaffV1StaffMember_universal_d_StaffMemberFullyCreated = StaffMemberFullyCreated;\n type bookingsStaffV1StaffMember_universal_d_GetStaffMemberRequest = GetStaffMemberRequest;\n type bookingsStaffV1StaffMember_universal_d_GetStaffMemberResponse = GetStaffMemberResponse;\n type bookingsStaffV1StaffMember_universal_d_GetDeletedStaffMemberRequest = GetDeletedStaffMemberRequest;\n type bookingsStaffV1StaffMember_universal_d_GetDeletedStaffMemberResponse = GetDeletedStaffMemberResponse;\n type bookingsStaffV1StaffMember_universal_d_ListDeletedStaffMembersRequest = ListDeletedStaffMembersRequest;\n type bookingsStaffV1StaffMember_universal_d_ListDeletedStaffMembersResponse = ListDeletedStaffMembersResponse;\n type bookingsStaffV1StaffMember_universal_d_RemoveStaffMemberFromTrashBinRequest = RemoveStaffMemberFromTrashBinRequest;\n type bookingsStaffV1StaffMember_universal_d_RemoveStaffMemberFromTrashBinResponse = RemoveStaffMemberFromTrashBinResponse;\n type bookingsStaffV1StaffMember_universal_d_RestoreStaffMemberFromTrashBinRequest = RestoreStaffMemberFromTrashBinRequest;\n type bookingsStaffV1StaffMember_universal_d_RestoreStaffMemberFromTrashBinResponse = RestoreStaffMemberFromTrashBinResponse;\n type bookingsStaffV1StaffMember_universal_d_UpdateStaffMemberRequest = UpdateStaffMemberRequest;\n type bookingsStaffV1StaffMember_universal_d_UpdateStaffMemberResponse = UpdateStaffMemberResponse;\n type bookingsStaffV1StaffMember_universal_d_DeleteStaffMemberRequest = DeleteStaffMemberRequest;\n type bookingsStaffV1StaffMember_universal_d_DeleteStaffMemberResponse = DeleteStaffMemberResponse;\n type bookingsStaffV1StaffMember_universal_d_StaffMemberDisconnectedFromUser = StaffMemberDisconnectedFromUser;\n type bookingsStaffV1StaffMember_universal_d_QueryStaffMembersRequest = QueryStaffMembersRequest;\n type bookingsStaffV1StaffMember_universal_d_QueryStaffMembersResponse = QueryStaffMembersResponse;\n type bookingsStaffV1StaffMember_universal_d_QueryStaffMembersMultiLanguageRequest = QueryStaffMembersMultiLanguageRequest;\n type bookingsStaffV1StaffMember_universal_d_QueryStaffMembersMultiLanguageResponse = QueryStaffMembersMultiLanguageResponse;\n type bookingsStaffV1StaffMember_universal_d_CountStaffMembersRequest = CountStaffMembersRequest;\n type bookingsStaffV1StaffMember_universal_d_CountStaffMembersResponse = CountStaffMembersResponse;\n type bookingsStaffV1StaffMember_universal_d_ConnectStaffMemberToUserRequest = ConnectStaffMemberToUserRequest;\n type bookingsStaffV1StaffMember_universal_d_ConnectStaffMemberToUserResponse = ConnectStaffMemberToUserResponse;\n type bookingsStaffV1StaffMember_universal_d_StaffMemberConnectedToUser = StaffMemberConnectedToUser;\n type bookingsStaffV1StaffMember_universal_d_SearchStaffMembersRequest = SearchStaffMembersRequest;\n type bookingsStaffV1StaffMember_universal_d_CursorSearch = CursorSearch;\n type bookingsStaffV1StaffMember_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type bookingsStaffV1StaffMember_universal_d_SearchDetails = SearchDetails;\n type bookingsStaffV1StaffMember_universal_d_Mode = Mode;\n const bookingsStaffV1StaffMember_universal_d_Mode: typeof Mode;\n type bookingsStaffV1StaffMember_universal_d_SearchStaffMembersResponse = SearchStaffMembersResponse;\n type bookingsStaffV1StaffMember_universal_d_AggregationData = AggregationData;\n type bookingsStaffV1StaffMember_universal_d_ValueAggregationResult = ValueAggregationResult;\n type bookingsStaffV1StaffMember_universal_d_RangeAggregationResult = RangeAggregationResult;\n type bookingsStaffV1StaffMember_universal_d_ScalarType = ScalarType;\n const bookingsStaffV1StaffMember_universal_d_ScalarType: typeof ScalarType;\n type bookingsStaffV1StaffMember_universal_d_NestedAggregationResults = NestedAggregationResults;\n type bookingsStaffV1StaffMember_universal_d_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;\n type bookingsStaffV1StaffMember_universal_d_AggregationType = AggregationType;\n const bookingsStaffV1StaffMember_universal_d_AggregationType: typeof AggregationType;\n type bookingsStaffV1StaffMember_universal_d_ValueResults = ValueResults;\n type bookingsStaffV1StaffMember_universal_d_RangeResults = RangeResults;\n type bookingsStaffV1StaffMember_universal_d_ScalarResult = ScalarResult;\n type bookingsStaffV1StaffMember_universal_d_NestedValueAggregationResult = NestedValueAggregationResult;\n type bookingsStaffV1StaffMember_universal_d_GroupByValueResults = GroupByValueResults;\n type bookingsStaffV1StaffMember_universal_d_AggregationResults = AggregationResults;\n type bookingsStaffV1StaffMember_universal_d_AggregationResultsResultOneOf = AggregationResultsResultOneOf;\n type bookingsStaffV1StaffMember_universal_d_DisconnectStaffMemberFromUserRequest = DisconnectStaffMemberFromUserRequest;\n type bookingsStaffV1StaffMember_universal_d_DisconnectStaffMemberFromUserResponse = DisconnectStaffMemberFromUserResponse;\n type bookingsStaffV1StaffMember_universal_d_AssignWorkingHoursScheduleRequest = AssignWorkingHoursScheduleRequest;\n type bookingsStaffV1StaffMember_universal_d_AssignWorkingHoursScheduleResponse = AssignWorkingHoursScheduleResponse;\n type bookingsStaffV1StaffMember_universal_d_AssignCustomScheduleRequest = AssignCustomScheduleRequest;\n type bookingsStaffV1StaffMember_universal_d_AssignCustomScheduleResponse = AssignCustomScheduleResponse;\n type bookingsStaffV1StaffMember_universal_d_RestoreStaffRequest = RestoreStaffRequest;\n type bookingsStaffV1StaffMember_universal_d_RestoreStaffResponse = RestoreStaffResponse;\n type bookingsStaffV1StaffMember_universal_d_ImportStaffMemberRequest = ImportStaffMemberRequest;\n type bookingsStaffV1StaffMember_universal_d_ImportStaffMemberResponse = ImportStaffMemberResponse;\n type bookingsStaffV1StaffMember_universal_d_PolicyRemovedFromContributor = PolicyRemovedFromContributor;\n type bookingsStaffV1StaffMember_universal_d_PolicyUpdatedForContributor = PolicyUpdatedForContributor;\n type bookingsStaffV1StaffMember_universal_d_ScheduleNotification = ScheduleNotification;\n type bookingsStaffV1StaffMember_universal_d_ScheduleNotificationEventOneOf = ScheduleNotificationEventOneOf;\n type bookingsStaffV1StaffMember_universal_d_ScheduleCreated = ScheduleCreated;\n type bookingsStaffV1StaffMember_universal_d_Schedule = Schedule;\n type bookingsStaffV1StaffMember_universal_d_RecurringInterval = RecurringInterval;\n type bookingsStaffV1StaffMember_universal_d_Interval = Interval;\n type bookingsStaffV1StaffMember_universal_d_Day = Day;\n const bookingsStaffV1StaffMember_universal_d_Day: typeof Day;\n type bookingsStaffV1StaffMember_universal_d_Frequency = Frequency;\n type bookingsStaffV1StaffMember_universal_d_LinkedSchedule = LinkedSchedule;\n type bookingsStaffV1StaffMember_universal_d_Transparency = Transparency;\n const bookingsStaffV1StaffMember_universal_d_Transparency: typeof Transparency;\n type bookingsStaffV1StaffMember_universal_d_RecurringIntervalType = RecurringIntervalType;\n const bookingsStaffV1StaffMember_universal_d_RecurringIntervalType: typeof RecurringIntervalType;\n type bookingsStaffV1StaffMember_universal_d_LocationsLocation = LocationsLocation;\n type bookingsStaffV1StaffMember_universal_d_LocationStatus = LocationStatus;\n const bookingsStaffV1StaffMember_universal_d_LocationStatus: typeof LocationStatus;\n type bookingsStaffV1StaffMember_universal_d_LocationsLocationType = LocationsLocationType;\n const bookingsStaffV1StaffMember_universal_d_LocationsLocationType: typeof LocationsLocationType;\n type bookingsStaffV1StaffMember_universal_d_LocationsAddress = LocationsAddress;\n type bookingsStaffV1StaffMember_universal_d_LocationsStreetAddress = LocationsStreetAddress;\n type bookingsStaffV1StaffMember_universal_d_LocationsAddressLocation = LocationsAddressLocation;\n type bookingsStaffV1StaffMember_universal_d_Rate = Rate;\n type bookingsStaffV1StaffMember_universal_d_Price = Price;\n type bookingsStaffV1StaffMember_universal_d_Availability = Availability;\n type bookingsStaffV1StaffMember_universal_d_AvailabilityConstraints = AvailabilityConstraints;\n type bookingsStaffV1StaffMember_universal_d_SplitInterval = SplitInterval;\n type bookingsStaffV1StaffMember_universal_d_Participant = Participant;\n type bookingsStaffV1StaffMember_universal_d_ApprovalStatus = ApprovalStatus;\n const bookingsStaffV1StaffMember_universal_d_ApprovalStatus: typeof ApprovalStatus;\n type bookingsStaffV1StaffMember_universal_d_ExternalCalendarOverrides = ExternalCalendarOverrides;\n type bookingsStaffV1StaffMember_universal_d_ScheduleStatus = ScheduleStatus;\n const bookingsStaffV1StaffMember_universal_d_ScheduleStatus: typeof ScheduleStatus;\n type bookingsStaffV1StaffMember_universal_d_Version = Version;\n type bookingsStaffV1StaffMember_universal_d_ConferenceProvider = ConferenceProvider;\n type bookingsStaffV1StaffMember_universal_d_CalendarConference = CalendarConference;\n type bookingsStaffV1StaffMember_universal_d_ConferenceType = ConferenceType;\n const bookingsStaffV1StaffMember_universal_d_ConferenceType: typeof ConferenceType;\n type bookingsStaffV1StaffMember_universal_d_ScheduleUpdated = ScheduleUpdated;\n type bookingsStaffV1StaffMember_universal_d_RecurringSessionsUpdated = RecurringSessionsUpdated;\n type bookingsStaffV1StaffMember_universal_d_Session = Session;\n type bookingsStaffV1StaffMember_universal_d_CalendarDateTime = CalendarDateTime;\n type bookingsStaffV1StaffMember_universal_d_LocalDateTime = LocalDateTime;\n type bookingsStaffV1StaffMember_universal_d_ExternalCalendarInfo = ExternalCalendarInfo;\n type bookingsStaffV1StaffMember_universal_d_CalendarType = CalendarType;\n const bookingsStaffV1StaffMember_universal_d_CalendarType: typeof CalendarType;\n type bookingsStaffV1StaffMember_universal_d_Status = Status;\n const bookingsStaffV1StaffMember_universal_d_Status: typeof Status;\n type bookingsStaffV1StaffMember_universal_d_SessionType = SessionType;\n const bookingsStaffV1StaffMember_universal_d_SessionType: typeof SessionType;\n type bookingsStaffV1StaffMember_universal_d_SessionVersion = SessionVersion;\n type bookingsStaffV1StaffMember_universal_d_ScheduleCancelled = ScheduleCancelled;\n type bookingsStaffV1StaffMember_universal_d_SessionCreated = SessionCreated;\n type bookingsStaffV1StaffMember_universal_d_SessionUpdated = SessionUpdated;\n type bookingsStaffV1StaffMember_universal_d_SessionCancelled = SessionCancelled;\n type bookingsStaffV1StaffMember_universal_d_AvailabilityPolicyUpdated = AvailabilityPolicyUpdated;\n type bookingsStaffV1StaffMember_universal_d_AvailabilityPolicy = AvailabilityPolicy;\n type bookingsStaffV1StaffMember_universal_d_IntervalSplit = IntervalSplit;\n type bookingsStaffV1StaffMember_universal_d_RecurringSessionSplit = RecurringSessionSplit;\n type bookingsStaffV1StaffMember_universal_d_ScheduleUnassignedFromUser = ScheduleUnassignedFromUser;\n type bookingsStaffV1StaffMember_universal_d_MultipleSessionsCreated = MultipleSessionsCreated;\n type bookingsStaffV1StaffMember_universal_d_ScheduleWithSessions = ScheduleWithSessions;\n type bookingsStaffV1StaffMember_universal_d_SitePropertiesOnScheduleCreation = SitePropertiesOnScheduleCreation;\n type bookingsStaffV1StaffMember_universal_d_MigrationEvent = MigrationEvent;\n type bookingsStaffV1StaffMember_universal_d_MigrationData = MigrationData;\n type bookingsStaffV1StaffMember_universal_d_StaffData = StaffData;\n type bookingsStaffV1StaffMember_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type bookingsStaffV1StaffMember_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type bookingsStaffV1StaffMember_universal_d_Asset = Asset;\n type bookingsStaffV1StaffMember_universal_d_State = State;\n const bookingsStaffV1StaffMember_universal_d_State: typeof State;\n type bookingsStaffV1StaffMember_universal_d_SiteCreatedContext = SiteCreatedContext;\n const bookingsStaffV1StaffMember_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type bookingsStaffV1StaffMember_universal_d_Namespace = Namespace;\n const bookingsStaffV1StaffMember_universal_d_Namespace: typeof Namespace;\n type bookingsStaffV1StaffMember_universal_d_SiteTransferred = SiteTransferred;\n type bookingsStaffV1StaffMember_universal_d_SiteDeleted = SiteDeleted;\n type bookingsStaffV1StaffMember_universal_d_DeleteContext = DeleteContext;\n type bookingsStaffV1StaffMember_universal_d_DeleteStatus = DeleteStatus;\n const bookingsStaffV1StaffMember_universal_d_DeleteStatus: typeof DeleteStatus;\n type bookingsStaffV1StaffMember_universal_d_SiteUndeleted = SiteUndeleted;\n type bookingsStaffV1StaffMember_universal_d_SitePublished = SitePublished;\n type bookingsStaffV1StaffMember_universal_d_SiteUnpublished = SiteUnpublished;\n type bookingsStaffV1StaffMember_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type bookingsStaffV1StaffMember_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type bookingsStaffV1StaffMember_universal_d_ServiceProvisioned = ServiceProvisioned;\n type bookingsStaffV1StaffMember_universal_d_ServiceRemoved = ServiceRemoved;\n type bookingsStaffV1StaffMember_universal_d_SiteRenamed = SiteRenamed;\n type bookingsStaffV1StaffMember_universal_d_SiteHardDeleted = SiteHardDeleted;\n type bookingsStaffV1StaffMember_universal_d_NamespaceChanged = NamespaceChanged;\n type bookingsStaffV1StaffMember_universal_d_StudioAssigned = StudioAssigned;\n type bookingsStaffV1StaffMember_universal_d_StudioUnassigned = StudioUnassigned;\n const bookingsStaffV1StaffMember_universal_d_createStaffMember: typeof createStaffMember;\n type bookingsStaffV1StaffMember_universal_d_CreateStaffMemberOptions = CreateStaffMemberOptions;\n const bookingsStaffV1StaffMember_universal_d_getStaffMember: typeof getStaffMember;\n type bookingsStaffV1StaffMember_universal_d_GetStaffMemberOptions = GetStaffMemberOptions;\n const bookingsStaffV1StaffMember_universal_d_getDeletedStaffMember: typeof getDeletedStaffMember;\n type bookingsStaffV1StaffMember_universal_d_GetDeletedStaffMemberOptions = GetDeletedStaffMemberOptions;\n const bookingsStaffV1StaffMember_universal_d_listDeletedStaffMembers: typeof listDeletedStaffMembers;\n type bookingsStaffV1StaffMember_universal_d_ListDeletedStaffMembersOptions = ListDeletedStaffMembersOptions;\n const bookingsStaffV1StaffMember_universal_d_removeStaffMemberFromTrashBin: typeof removeStaffMemberFromTrashBin;\n const bookingsStaffV1StaffMember_universal_d_restoreStaffMemberFromTrashBin: typeof restoreStaffMemberFromTrashBin;\n type bookingsStaffV1StaffMember_universal_d_RestoreStaffMemberFromTrashBinOptions = RestoreStaffMemberFromTrashBinOptions;\n const bookingsStaffV1StaffMember_universal_d_updateStaffMember: typeof updateStaffMember;\n type bookingsStaffV1StaffMember_universal_d_UpdateStaffMember = UpdateStaffMember;\n type bookingsStaffV1StaffMember_universal_d_UpdateStaffMemberOptions = UpdateStaffMemberOptions;\n const bookingsStaffV1StaffMember_universal_d_deleteStaffMember: typeof deleteStaffMember;\n const bookingsStaffV1StaffMember_universal_d_queryStaffMembers: typeof queryStaffMembers;\n type bookingsStaffV1StaffMember_universal_d_QueryStaffMembersOptions = QueryStaffMembersOptions;\n type bookingsStaffV1StaffMember_universal_d_StaffMembersQueryResult = StaffMembersQueryResult;\n type bookingsStaffV1StaffMember_universal_d_StaffMembersQueryBuilder = StaffMembersQueryBuilder;\n const bookingsStaffV1StaffMember_universal_d_queryStaffMembersMultiLanguage: typeof queryStaffMembersMultiLanguage;\n type bookingsStaffV1StaffMember_universal_d_QueryStaffMembersMultiLanguageOptions = QueryStaffMembersMultiLanguageOptions;\n const bookingsStaffV1StaffMember_universal_d_countStaffMembers: typeof countStaffMembers;\n type bookingsStaffV1StaffMember_universal_d_CountStaffMembersOptions = CountStaffMembersOptions;\n const bookingsStaffV1StaffMember_universal_d_connectStaffMemberToUser: typeof connectStaffMemberToUser;\n type bookingsStaffV1StaffMember_universal_d_ConnectStaffMemberToUserOptions = ConnectStaffMemberToUserOptions;\n const bookingsStaffV1StaffMember_universal_d_searchStaffMembers: typeof searchStaffMembers;\n type bookingsStaffV1StaffMember_universal_d_SearchStaffMembersOptions = SearchStaffMembersOptions;\n const bookingsStaffV1StaffMember_universal_d_disconnectStaffMemberFromUser: typeof disconnectStaffMemberFromUser;\n type bookingsStaffV1StaffMember_universal_d_DisconnectStaffMemberFromUserOptions = DisconnectStaffMemberFromUserOptions;\n const bookingsStaffV1StaffMember_universal_d_assignWorkingHoursSchedule: typeof assignWorkingHoursSchedule;\n type bookingsStaffV1StaffMember_universal_d_AssignWorkingHoursScheduleOptions = AssignWorkingHoursScheduleOptions;\n const bookingsStaffV1StaffMember_universal_d_assignCustomSchedule: typeof assignCustomSchedule;\n type bookingsStaffV1StaffMember_universal_d_AssignCustomScheduleOptions = AssignCustomScheduleOptions;\n namespace bookingsStaffV1StaffMember_universal_d {\n export {\n bookingsStaffV1StaffMember_universal_d_StaffMember as StaffMember,\n bookingsStaffV1StaffMember_universal_d_MediaItem as MediaItem,\n bookingsStaffV1StaffMember_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf,\n bookingsStaffV1StaffMember_universal_d_Resource as Resource,\n bookingsStaffV1StaffMember_universal_d_WorkingHoursSchedule as WorkingHoursSchedule,\n bookingsStaffV1StaffMember_universal_d_EventSchedule as EventSchedule,\n bookingsStaffV1StaffMember_universal_d_AssociatedWixIdentity as AssociatedWixIdentity,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n IdentityType$2 as IdentityType,\n bookingsStaffV1StaffMember_universal_d_AssociatedWixIdentityConnectionStatusEnumConnectionStatus as AssociatedWixIdentityConnectionStatusEnumConnectionStatus,\n bookingsStaffV1StaffMember_universal_d_ConnectionState as ConnectionState,\n bookingsStaffV1StaffMember_universal_d_ConnectionStateConnectionState as ConnectionStateConnectionState,\n bookingsStaffV1StaffMember_universal_d_AssociatedConferencingProviders as AssociatedConferencingProviders,\n bookingsStaffV1StaffMember_universal_d_AssociatedConferencingProvider as AssociatedConferencingProvider,\n bookingsStaffV1StaffMember_universal_d_ConnectionStatus as ConnectionStatus,\n bookingsStaffV1StaffMember_universal_d_AssociatedConferencingAccounts as AssociatedConferencingAccounts,\n bookingsStaffV1StaffMember_universal_d_AssociatedConferencingAccount as AssociatedConferencingAccount,\n bookingsStaffV1StaffMember_universal_d_AssociatedConferencingAccountAccountOneOf as AssociatedConferencingAccountAccountOneOf,\n bookingsStaffV1StaffMember_universal_d_CustomConferenceAccount as CustomConferenceAccount,\n ExtendedFields$3 as ExtendedFields,\n bookingsStaffV1StaffMember_universal_d_CreateStaffMemberRequest as CreateStaffMemberRequest,\n bookingsStaffV1StaffMember_universal_d_RequestedFields as RequestedFields,\n bookingsStaffV1StaffMember_universal_d_CreateStaffMemberResponse as CreateStaffMemberResponse,\n bookingsStaffV1StaffMember_universal_d_StaffMemberFullyCreated as StaffMemberFullyCreated,\n bookingsStaffV1StaffMember_universal_d_GetStaffMemberRequest as GetStaffMemberRequest,\n bookingsStaffV1StaffMember_universal_d_GetStaffMemberResponse as GetStaffMemberResponse,\n bookingsStaffV1StaffMember_universal_d_GetDeletedStaffMemberRequest as GetDeletedStaffMemberRequest,\n bookingsStaffV1StaffMember_universal_d_GetDeletedStaffMemberResponse as GetDeletedStaffMemberResponse,\n bookingsStaffV1StaffMember_universal_d_ListDeletedStaffMembersRequest as ListDeletedStaffMembersRequest,\n CursorPaging$3 as CursorPaging,\n bookingsStaffV1StaffMember_universal_d_ListDeletedStaffMembersResponse as ListDeletedStaffMembersResponse,\n CursorPagingMetadata$2 as CursorPagingMetadata,\n Cursors$3 as Cursors,\n bookingsStaffV1StaffMember_universal_d_RemoveStaffMemberFromTrashBinRequest as RemoveStaffMemberFromTrashBinRequest,\n bookingsStaffV1StaffMember_universal_d_RemoveStaffMemberFromTrashBinResponse as RemoveStaffMemberFromTrashBinResponse,\n bookingsStaffV1StaffMember_universal_d_RestoreStaffMemberFromTrashBinRequest as RestoreStaffMemberFromTrashBinRequest,\n bookingsStaffV1StaffMember_universal_d_RestoreStaffMemberFromTrashBinResponse as RestoreStaffMemberFromTrashBinResponse,\n bookingsStaffV1StaffMember_universal_d_UpdateStaffMemberRequest as UpdateStaffMemberRequest,\n bookingsStaffV1StaffMember_universal_d_UpdateStaffMemberResponse as UpdateStaffMemberResponse,\n bookingsStaffV1StaffMember_universal_d_DeleteStaffMemberRequest as DeleteStaffMemberRequest,\n bookingsStaffV1StaffMember_universal_d_DeleteStaffMemberResponse as DeleteStaffMemberResponse,\n bookingsStaffV1StaffMember_universal_d_StaffMemberDisconnectedFromUser as StaffMemberDisconnectedFromUser,\n bookingsStaffV1StaffMember_universal_d_QueryStaffMembersRequest as QueryStaffMembersRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n bookingsStaffV1StaffMember_universal_d_QueryStaffMembersResponse as QueryStaffMembersResponse,\n bookingsStaffV1StaffMember_universal_d_QueryStaffMembersMultiLanguageRequest as QueryStaffMembersMultiLanguageRequest,\n bookingsStaffV1StaffMember_universal_d_QueryStaffMembersMultiLanguageResponse as QueryStaffMembersMultiLanguageResponse,\n bookingsStaffV1StaffMember_universal_d_CountStaffMembersRequest as CountStaffMembersRequest,\n bookingsStaffV1StaffMember_universal_d_CountStaffMembersResponse as CountStaffMembersResponse,\n bookingsStaffV1StaffMember_universal_d_ConnectStaffMemberToUserRequest as ConnectStaffMemberToUserRequest,\n bookingsStaffV1StaffMember_universal_d_ConnectStaffMemberToUserResponse as ConnectStaffMemberToUserResponse,\n bookingsStaffV1StaffMember_universal_d_StaffMemberConnectedToUser as StaffMemberConnectedToUser,\n bookingsStaffV1StaffMember_universal_d_SearchStaffMembersRequest as SearchStaffMembersRequest,\n bookingsStaffV1StaffMember_universal_d_CursorSearch as CursorSearch,\n bookingsStaffV1StaffMember_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf,\n bookingsStaffV1StaffMember_universal_d_SearchDetails as SearchDetails,\n bookingsStaffV1StaffMember_universal_d_Mode as Mode,\n bookingsStaffV1StaffMember_universal_d_SearchStaffMembersResponse as SearchStaffMembersResponse,\n bookingsStaffV1StaffMember_universal_d_AggregationData as AggregationData,\n bookingsStaffV1StaffMember_universal_d_ValueAggregationResult as ValueAggregationResult,\n bookingsStaffV1StaffMember_universal_d_RangeAggregationResult as RangeAggregationResult,\n bookingsStaffV1StaffMember_universal_d_ScalarType as ScalarType,\n bookingsStaffV1StaffMember_universal_d_NestedAggregationResults as NestedAggregationResults,\n bookingsStaffV1StaffMember_universal_d_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf,\n bookingsStaffV1StaffMember_universal_d_AggregationType as AggregationType,\n bookingsStaffV1StaffMember_universal_d_ValueResults as ValueResults,\n bookingsStaffV1StaffMember_universal_d_RangeResults as RangeResults,\n bookingsStaffV1StaffMember_universal_d_ScalarResult as ScalarResult,\n bookingsStaffV1StaffMember_universal_d_NestedValueAggregationResult as NestedValueAggregationResult,\n bookingsStaffV1StaffMember_universal_d_GroupByValueResults as GroupByValueResults,\n bookingsStaffV1StaffMember_universal_d_AggregationResults as AggregationResults,\n bookingsStaffV1StaffMember_universal_d_AggregationResultsResultOneOf as AggregationResultsResultOneOf,\n bookingsStaffV1StaffMember_universal_d_DisconnectStaffMemberFromUserRequest as DisconnectStaffMemberFromUserRequest,\n bookingsStaffV1StaffMember_universal_d_DisconnectStaffMemberFromUserResponse as DisconnectStaffMemberFromUserResponse,\n bookingsStaffV1StaffMember_universal_d_AssignWorkingHoursScheduleRequest as AssignWorkingHoursScheduleRequest,\n bookingsStaffV1StaffMember_universal_d_AssignWorkingHoursScheduleResponse as AssignWorkingHoursScheduleResponse,\n bookingsStaffV1StaffMember_universal_d_AssignCustomScheduleRequest as AssignCustomScheduleRequest,\n bookingsStaffV1StaffMember_universal_d_AssignCustomScheduleResponse as AssignCustomScheduleResponse,\n bookingsStaffV1StaffMember_universal_d_RestoreStaffRequest as RestoreStaffRequest,\n bookingsStaffV1StaffMember_universal_d_RestoreStaffResponse as RestoreStaffResponse,\n bookingsStaffV1StaffMember_universal_d_ImportStaffMemberRequest as ImportStaffMemberRequest,\n bookingsStaffV1StaffMember_universal_d_ImportStaffMemberResponse as ImportStaffMemberResponse,\n Empty$1 as Empty,\n bookingsStaffV1StaffMember_universal_d_PolicyRemovedFromContributor as PolicyRemovedFromContributor,\n bookingsStaffV1StaffMember_universal_d_PolicyUpdatedForContributor as PolicyUpdatedForContributor,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n bookingsStaffV1StaffMember_universal_d_ScheduleNotification as ScheduleNotification,\n bookingsStaffV1StaffMember_universal_d_ScheduleNotificationEventOneOf as ScheduleNotificationEventOneOf,\n bookingsStaffV1StaffMember_universal_d_ScheduleCreated as ScheduleCreated,\n bookingsStaffV1StaffMember_universal_d_Schedule as Schedule,\n bookingsStaffV1StaffMember_universal_d_RecurringInterval as RecurringInterval,\n bookingsStaffV1StaffMember_universal_d_Interval as Interval,\n bookingsStaffV1StaffMember_universal_d_Day as Day,\n bookingsStaffV1StaffMember_universal_d_Frequency as Frequency,\n bookingsStaffV1StaffMember_universal_d_LinkedSchedule as LinkedSchedule,\n bookingsStaffV1StaffMember_universal_d_Transparency as Transparency,\n bookingsStaffV1StaffMember_universal_d_RecurringIntervalType as RecurringIntervalType,\n Location$2 as Location,\n LocationType$2 as LocationType,\n Address$3 as Address,\n AddressStreetOneOf$2 as AddressStreetOneOf,\n StreetAddress$2 as StreetAddress,\n AddressLocation$2 as AddressLocation,\n Subdivision$2 as Subdivision,\n bookingsStaffV1StaffMember_universal_d_LocationsLocation as LocationsLocation,\n bookingsStaffV1StaffMember_universal_d_LocationStatus as LocationStatus,\n bookingsStaffV1StaffMember_universal_d_LocationsLocationType as LocationsLocationType,\n bookingsStaffV1StaffMember_universal_d_LocationsAddress as LocationsAddress,\n bookingsStaffV1StaffMember_universal_d_LocationsStreetAddress as LocationsStreetAddress,\n bookingsStaffV1StaffMember_universal_d_LocationsAddressLocation as LocationsAddressLocation,\n BusinessSchedule$1 as BusinessSchedule,\n TimePeriod$1 as TimePeriod,\n DayOfWeek$1 as DayOfWeek,\n SpecialHourPeriod$1 as SpecialHourPeriod,\n bookingsStaffV1StaffMember_universal_d_Rate as Rate,\n bookingsStaffV1StaffMember_universal_d_Price as Price,\n bookingsStaffV1StaffMember_universal_d_Availability as Availability,\n bookingsStaffV1StaffMember_universal_d_AvailabilityConstraints as AvailabilityConstraints,\n bookingsStaffV1StaffMember_universal_d_SplitInterval as SplitInterval,\n bookingsStaffV1StaffMember_universal_d_Participant as Participant,\n bookingsStaffV1StaffMember_universal_d_ApprovalStatus as ApprovalStatus,\n bookingsStaffV1StaffMember_universal_d_ExternalCalendarOverrides as ExternalCalendarOverrides,\n bookingsStaffV1StaffMember_universal_d_ScheduleStatus as ScheduleStatus,\n bookingsStaffV1StaffMember_universal_d_Version as Version,\n bookingsStaffV1StaffMember_universal_d_ConferenceProvider as ConferenceProvider,\n bookingsStaffV1StaffMember_universal_d_CalendarConference as CalendarConference,\n bookingsStaffV1StaffMember_universal_d_ConferenceType as ConferenceType,\n bookingsStaffV1StaffMember_universal_d_ScheduleUpdated as ScheduleUpdated,\n bookingsStaffV1StaffMember_universal_d_RecurringSessionsUpdated as RecurringSessionsUpdated,\n bookingsStaffV1StaffMember_universal_d_Session as Session,\n bookingsStaffV1StaffMember_universal_d_CalendarDateTime as CalendarDateTime,\n bookingsStaffV1StaffMember_universal_d_LocalDateTime as LocalDateTime,\n bookingsStaffV1StaffMember_universal_d_ExternalCalendarInfo as ExternalCalendarInfo,\n bookingsStaffV1StaffMember_universal_d_CalendarType as CalendarType,\n bookingsStaffV1StaffMember_universal_d_Status as Status,\n bookingsStaffV1StaffMember_universal_d_SessionType as SessionType,\n bookingsStaffV1StaffMember_universal_d_SessionVersion as SessionVersion,\n ParticipantNotification$3 as ParticipantNotification,\n bookingsStaffV1StaffMember_universal_d_ScheduleCancelled as ScheduleCancelled,\n bookingsStaffV1StaffMember_universal_d_SessionCreated as SessionCreated,\n bookingsStaffV1StaffMember_universal_d_SessionUpdated as SessionUpdated,\n bookingsStaffV1StaffMember_universal_d_SessionCancelled as SessionCancelled,\n bookingsStaffV1StaffMember_universal_d_AvailabilityPolicyUpdated as AvailabilityPolicyUpdated,\n bookingsStaffV1StaffMember_universal_d_AvailabilityPolicy as AvailabilityPolicy,\n bookingsStaffV1StaffMember_universal_d_IntervalSplit as IntervalSplit,\n bookingsStaffV1StaffMember_universal_d_RecurringSessionSplit as RecurringSessionSplit,\n bookingsStaffV1StaffMember_universal_d_ScheduleUnassignedFromUser as ScheduleUnassignedFromUser,\n bookingsStaffV1StaffMember_universal_d_MultipleSessionsCreated as MultipleSessionsCreated,\n bookingsStaffV1StaffMember_universal_d_ScheduleWithSessions as ScheduleWithSessions,\n bookingsStaffV1StaffMember_universal_d_SitePropertiesOnScheduleCreation as SitePropertiesOnScheduleCreation,\n bookingsStaffV1StaffMember_universal_d_MigrationEvent as MigrationEvent,\n bookingsStaffV1StaffMember_universal_d_MigrationData as MigrationData,\n bookingsStaffV1StaffMember_universal_d_StaffData as StaffData,\n bookingsStaffV1StaffMember_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n bookingsStaffV1StaffMember_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n bookingsStaffV1StaffMember_universal_d_Asset as Asset,\n bookingsStaffV1StaffMember_universal_d_State as State,\n SiteCreated$1 as SiteCreated,\n bookingsStaffV1StaffMember_universal_d_SiteCreatedContext as SiteCreatedContext,\n bookingsStaffV1StaffMember_universal_d_Namespace as Namespace,\n bookingsStaffV1StaffMember_universal_d_SiteTransferred as SiteTransferred,\n bookingsStaffV1StaffMember_universal_d_SiteDeleted as SiteDeleted,\n bookingsStaffV1StaffMember_universal_d_DeleteContext as DeleteContext,\n bookingsStaffV1StaffMember_universal_d_DeleteStatus as DeleteStatus,\n bookingsStaffV1StaffMember_universal_d_SiteUndeleted as SiteUndeleted,\n bookingsStaffV1StaffMember_universal_d_SitePublished as SitePublished,\n bookingsStaffV1StaffMember_universal_d_SiteUnpublished as SiteUnpublished,\n bookingsStaffV1StaffMember_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n bookingsStaffV1StaffMember_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n bookingsStaffV1StaffMember_universal_d_ServiceProvisioned as ServiceProvisioned,\n bookingsStaffV1StaffMember_universal_d_ServiceRemoved as ServiceRemoved,\n bookingsStaffV1StaffMember_universal_d_SiteRenamed as SiteRenamed,\n bookingsStaffV1StaffMember_universal_d_SiteHardDeleted as SiteHardDeleted,\n bookingsStaffV1StaffMember_universal_d_NamespaceChanged as NamespaceChanged,\n bookingsStaffV1StaffMember_universal_d_StudioAssigned as StudioAssigned,\n bookingsStaffV1StaffMember_universal_d_StudioUnassigned as StudioUnassigned,\n MessageEnvelope$3 as MessageEnvelope,\n WebhooksIdentificationData$1 as WebhooksIdentificationData,\n WebhooksIdentificationDataIdOneOf$1 as WebhooksIdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n bookingsStaffV1StaffMember_universal_d_createStaffMember as createStaffMember,\n bookingsStaffV1StaffMember_universal_d_CreateStaffMemberOptions as CreateStaffMemberOptions,\n bookingsStaffV1StaffMember_universal_d_getStaffMember as getStaffMember,\n bookingsStaffV1StaffMember_universal_d_GetStaffMemberOptions as GetStaffMemberOptions,\n bookingsStaffV1StaffMember_universal_d_getDeletedStaffMember as getDeletedStaffMember,\n bookingsStaffV1StaffMember_universal_d_GetDeletedStaffMemberOptions as GetDeletedStaffMemberOptions,\n bookingsStaffV1StaffMember_universal_d_listDeletedStaffMembers as listDeletedStaffMembers,\n bookingsStaffV1StaffMember_universal_d_ListDeletedStaffMembersOptions as ListDeletedStaffMembersOptions,\n bookingsStaffV1StaffMember_universal_d_removeStaffMemberFromTrashBin as removeStaffMemberFromTrashBin,\n bookingsStaffV1StaffMember_universal_d_restoreStaffMemberFromTrashBin as restoreStaffMemberFromTrashBin,\n bookingsStaffV1StaffMember_universal_d_RestoreStaffMemberFromTrashBinOptions as RestoreStaffMemberFromTrashBinOptions,\n bookingsStaffV1StaffMember_universal_d_updateStaffMember as updateStaffMember,\n bookingsStaffV1StaffMember_universal_d_UpdateStaffMember as UpdateStaffMember,\n bookingsStaffV1StaffMember_universal_d_UpdateStaffMemberOptions as UpdateStaffMemberOptions,\n bookingsStaffV1StaffMember_universal_d_deleteStaffMember as deleteStaffMember,\n bookingsStaffV1StaffMember_universal_d_queryStaffMembers as queryStaffMembers,\n bookingsStaffV1StaffMember_universal_d_QueryStaffMembersOptions as QueryStaffMembersOptions,\n bookingsStaffV1StaffMember_universal_d_StaffMembersQueryResult as StaffMembersQueryResult,\n bookingsStaffV1StaffMember_universal_d_StaffMembersQueryBuilder as StaffMembersQueryBuilder,\n bookingsStaffV1StaffMember_universal_d_queryStaffMembersMultiLanguage as queryStaffMembersMultiLanguage,\n bookingsStaffV1StaffMember_universal_d_QueryStaffMembersMultiLanguageOptions as QueryStaffMembersMultiLanguageOptions,\n bookingsStaffV1StaffMember_universal_d_countStaffMembers as countStaffMembers,\n bookingsStaffV1StaffMember_universal_d_CountStaffMembersOptions as CountStaffMembersOptions,\n bookingsStaffV1StaffMember_universal_d_connectStaffMemberToUser as connectStaffMemberToUser,\n bookingsStaffV1StaffMember_universal_d_ConnectStaffMemberToUserOptions as ConnectStaffMemberToUserOptions,\n bookingsStaffV1StaffMember_universal_d_searchStaffMembers as searchStaffMembers,\n bookingsStaffV1StaffMember_universal_d_SearchStaffMembersOptions as SearchStaffMembersOptions,\n bookingsStaffV1StaffMember_universal_d_disconnectStaffMemberFromUser as disconnectStaffMemberFromUser,\n bookingsStaffV1StaffMember_universal_d_DisconnectStaffMemberFromUserOptions as DisconnectStaffMemberFromUserOptions,\n bookingsStaffV1StaffMember_universal_d_assignWorkingHoursSchedule as assignWorkingHoursSchedule,\n bookingsStaffV1StaffMember_universal_d_AssignWorkingHoursScheduleOptions as AssignWorkingHoursScheduleOptions,\n bookingsStaffV1StaffMember_universal_d_assignCustomSchedule as assignCustomSchedule,\n bookingsStaffV1StaffMember_universal_d_AssignCustomScheduleOptions as AssignCustomScheduleOptions,\n };\n }\n \n /**\n * A booking policy is a set of rules that determine how customers can book a\n * service, including timeframes for booking, canceling, or rescheduling.\n */\n interface BookingPolicy {\n /**\n * ID of the booking policy.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the booking policy is updated.\n * To prevent conflicting changes, the current `revision` must be passed when\n * updating the booking policy.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the booking policy was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the booking policy was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name of the booking policy. */\n name?: string | null;\n /**\n * Custom description for the booking policy and whether it's displayed to the\n * participant.\n */\n customPolicyDescription?: PolicyDescription;\n /**\n * Whether the booking policy is the default.\n * @readonly\n */\n default?: boolean | null;\n /** Rule for limiting early bookings. */\n limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;\n /**\n * Rule for limiting late bookings. This rule and `bookAfterStartPolicy` can't\n * be both enabled at the same time.\n */\n limitLateBookingPolicy?: LimitLateBookingPolicy;\n /**\n * Rule for booking after the start of a session or course. This rule and\n * `limitLateBookingPolicy` can't be both enabled at the same time.\n */\n bookAfterStartPolicy?: BookAfterStartPolicy;\n /** Rule for canceling a booking. */\n cancellationPolicy?: CancellationPolicy;\n /** Rule for rescheduling a booking. */\n reschedulePolicy?: ReschedulePolicy;\n /** Waitlist rule for the service. */\n waitlistPolicy?: WaitlistPolicy;\n /** Rule for participants per booking. */\n participantsPolicy?: ParticipantsPolicy;\n /**\n * Rule for allocating resources.\n * @internal\n */\n resourcesPolicy?: ResourcesPolicy;\n /** Rules for cancellation fees. */\n cancellationFeePolicy?: CancellationFeePolicy;\n /** Rule for saving credit card details. */\n saveCreditCardPolicy?: SaveCreditCardPolicy;\n /** Extensions enabling users to save custom data related to the booking policies. */\n extendedFields?: ExtendedFields$2;\n }\n /** A description of the booking policy to display to participants. */\n interface PolicyDescription {\n /**\n * Whether the description is displayed to the participant. `true` means the\n * description is displayed.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Description of the booking policy.\n *\n * Default: Empty\n * Max length: 2500 characters\n */\n description?: string;\n }\n /** The rule for limiting early bookings. */\n interface LimitEarlyBookingPolicy {\n /**\n * Whether there's a limit about how early a customer can book. `false` means there's\n * no limit to the earliest supported booking time.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Maximum number of minutes before the start of a session or course customers can book.\n * Must be greater than `limitLateBookingPolicy.latestBookingInMinutes`.\n *\n * Default: `10080` minutes (7 days)\n * Min: `1` minute\n */\n earliestBookingInMinutes?: number;\n }\n /**\n * Rule limiting late bookings.\n *\n * This rule and `bookAfterStartPolicy` can't be both enabled at the same time.\n */\n interface LimitLateBookingPolicy {\n /**\n * Whether there's a limit about how late customers can book. `false` means\n * customers can book up to the last minute. If set to `true`,\n * `bookAfterStartPolicy.enabled` must be set to `false`.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Minimum number of minutes before the start of the session customers can book.\n * For courses, this is relative to the start time of the next session and doesn't\n * consider course sessions in the past. This value must be less than\n * `limitEarlyBookingPolicy.earliestBookingInMinutes`.\n *\n * Default: `1440` minutes (1 day)\n * Min: `1` minute\n */\n latestBookingInMinutes?: number;\n }\n /**\n * The rule for whether a session can be booked after the start of the schedule.\n * This rule and `LimitLateBookingPolicy` cannot be enabled at the same time. So if this rule\n * is enabled, the `LimitLateBookingPolicy` rule must be disabled.\n */\n interface BookAfterStartPolicy {\n /**\n * Whether customers can book after the session has started. `true` means\n * customers can book after the session has started. For courses, this refers to\n * the start of the last course session. If set to `true`,\n * `limitLateBookingPolicy.enabled` must be set to `false`.\n *\n * Default: `false`\n */\n enabled?: boolean;\n }\n /** The rule for canceling a booked session. */\n interface CancellationPolicy {\n /**\n * Whether customers can cancel the booking. `true` means customers can cancel\n * the booking.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether there's a limit on the latest cancellation time. `false` means customers\n * can cancel the booking until the last minute before the course or session starts.\n *\n * Default: `false`\n */\n limitLatestCancellation?: boolean;\n /**\n * Minimum number of minutes before the start of the session customers can cancel.\n * For courses, this refers to the start of the first course session.\n *\n * Default: `1440` minutes (1 day)\n * Min: `1` minute\n */\n latestCancellationInMinutes?: number;\n }\n /** The rule for rescheduling a booked session. */\n interface ReschedulePolicy {\n /**\n * Whether customers can reschedule a booking for an appointment-based service.\n * `true` means customers can reschedule.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether there's a limit on the latest supported rescheduling time. `false`\n * means customers can reschedule until the last minute before the session start.\n *\n * Default: `false`\n */\n limitLatestReschedule?: boolean;\n /**\n * Minimum number of minutes before the session start session customers can\n * reschedule their booking.\n *\n * Default: `1440` minutes (1 day)\n * Min: `1` minute\n */\n latestRescheduleInMinutes?: number;\n }\n /** The rule for the waitlist. */\n interface WaitlistPolicy {\n /**\n * Whether the service has a waitlist. `true` means there's a waitlist.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Number of spots in the waitlist.\n *\n * Default: `10` spots\n * Min: `1` spot\n */\n capacity?: number;\n /**\n * Time in minutes the potential customer is given to book after they've been\n * notified that a spot has opened up for them. If they don't respond in time,\n * the open spot is offered to the next potential customer on the waitlist.\n *\n * Default: `10` minutes\n * Min: `1` minute\n */\n reservationTimeInMinutes?: number;\n }\n /** The rule for the maximum number of participants per booking. */\n interface ParticipantsPolicy {\n /**\n * Whether there's a maximum number of participants per booking. `false` means\n * there is no maximum.\n *\n * Default: `false`\n * Private because not limiting participants per booking is not supported by Bookings flows today\n * @internal\n */\n enabled?: boolean;\n /**\n * Maximum number of participants per booking.\n *\n * Default: `1` participant\n * Min: `1` participant\n */\n maxParticipantsPerBooking?: number;\n }\n /** The rule regarding the allocation of resources (e.g. staff members). */\n interface ResourcesPolicy {\n /**\n * Whether the customer must select a resource, for example a staff member, when\n * booking. `false` means the customer can book without selecting a resource.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Whether Wix Bookings automatically assigns a resource, for example a staff\n * member, to the booking. `false` means the customer must select the resource\n * themselves and Wix Bookings doesn't assign it automatically.\n *\n * Default: `false`\n */\n autoAssignAllowed?: boolean;\n }\n interface CancellationFeePolicy {\n /**\n * Whether customers must pay a cancellation fee when canceling a booking.\n *\n * Default: `false`\n */\n enabled?: boolean;\n /**\n * Time windows relative to the session start during which customers can cancel\n * their booking. Each window includes details about the fee for canceling within it.\n */\n cancellationWindows?: CancellationWindow[];\n /**\n * Whether Wix automatically charges the cancellation fee from the customer once\n * they cancel their booking.\n *\n * Default: `true`\n */\n autoCollectFeeEnabled?: boolean | 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 /**\n * Currency code. Must be valid ISO 4217 currency code (e.g., USD).\n * @readonly\n */\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 CancellationWindow extends CancellationWindowFeeOneOf {\n /** Fixed amount customers must pay when canceling the booking within this window. */\n amount?: Money;\n /**\n * Percentage of the booking price customers must pay when canceling within\n * this window.\n *\n * Min: `0.01` percent\n * Max: `100` percent\n */\n percentage?: string;\n /**\n * Start of the cancellation window in minutes before the session start. For\n * courses, this refers to the start of the first course session.\n */\n startInMinutes?: number | null;\n }\n /** @oneof */\n interface CancellationWindowFeeOneOf {\n /** Fixed amount customers must pay when canceling the booking within this window. */\n amount?: Money;\n /**\n * Percentage of the booking price customers must pay when canceling within\n * this window.\n *\n * Min: `0.01` percent\n * Max: `100` percent\n */\n percentage?: string;\n }\n interface SaveCreditCardPolicy {\n /**\n * Whether Wix stores credit card details of the customer. Storing the details\n * allows Wix to prefill the [checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)\n * and thus increases the likelyhood that the customer completes the booking\n * process.\n *\n * Default: `false`\n */\n enabled?: boolean;\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 /** This event is triggered when a different booking policy has been set as the default policy. */\n interface DefaultBookingPolicySet {\n /** The new default booking policy. */\n currentDefaultBookingPolicy?: BookingPolicy;\n /**\n * The booking policy that was the default before this endpoint was called.\n * This field will be empty if there was no default booking policy before this method was called.\n */\n previousDefaultBookingPolicy?: BookingPolicy;\n }\n interface CreateBookingPolicyRequest {\n /** Booking policy to create. */\n bookingPolicy: BookingPolicy;\n }\n interface CreateBookingPolicyResponse {\n /** Created booking policy. */\n bookingPolicy?: BookingPolicy;\n }\n interface GetBookingPolicyRequest {\n /** ID of the booking policy to retrieve. */\n bookingPolicyId: string;\n }\n interface GetBookingPolicyResponse {\n /** Retrieved booking policy. */\n bookingPolicy?: BookingPolicy;\n }\n interface GetStrictestBookingPolicyRequest {\n /** IDs of the booking policies for which to retrieve the strictest rules for. */\n bookingPolicyIds: string[];\n }\n interface GetStrictestBookingPolicyResponse {\n /**\n * Hypothetical `bookingPolicy` object that combines the strictest version of\n * each rule. `bookingPolicy.id` is `null` and the returned object isn't actually\n * created. To create a new policy, you can use\n * [Create Booking Policy](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/create-booking-policy).\n */\n bookingPolicy?: BookingPolicy;\n }\n interface UpdateBookingPolicyRequest {\n /** Booking policy to update. */\n bookingPolicy: BookingPolicy;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateBookingPolicyResponse {\n /** Updated booking policy. */\n bookingPolicy?: BookingPolicy;\n }\n interface SetDefaultBookingPolicyRequest {\n /** ID of the booking policy that's set as default. */\n bookingPolicyId: string;\n }\n interface SetDefaultBookingPolicyResponse {\n /** New default booking policy. */\n currentDefaultBookingPolicy?: BookingPolicy;\n /**\n * Previous default booking policy. Not available if the provided booking policy\n * was already the default.\n */\n previousDefaultBookingPolicy?: BookingPolicy;\n }\n interface DeleteBookingPolicyRequest {\n /** ID of the booking policy to delete. */\n bookingPolicyId: string;\n }\n interface DeleteBookingPolicyResponse {\n }\n interface QueryBookingPoliciesRequest {\n /**\n * The query by which to select booking policies. See\n * [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters)\n * for details.\n */\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`, `$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 }\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 QueryBookingPoliciesResponse {\n /** Retrieved booking policies. */\n bookingPolicies?: BookingPolicy[];\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 CountBookingPoliciesRequest {\n /**\n * Filter to base the count on. See\n * [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters)\n * for details.\n */\n filter?: Record | null;\n }\n interface CountBookingPoliciesResponse {\n /** Number of booking policies matching the provided filter. */\n count?: number;\n }\n interface UpdateAllPoliciesRequest {\n /** Fields to set to all booking policies. */\n bookingPolicy?: BookingPolicy;\n /**\n * List of fields to update\n * @internal\n */\n mask?: string[];\n }\n interface UpdateAllPoliciesResponse {\n }\n interface CreateMissingDefaultPolicyRequest {\n }\n interface CreateMissingDefaultPolicyResponse {\n /** The default booking policy. */\n defaultBookingPolicy?: BookingPolicy;\n /** Whether a new default policy was created. */\n wasANewPolicyCreated?: boolean;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$2 {\n bodyAsJson?: string;\n }\n interface Empty {\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 /**\n * Set of properties that were updated - corresponds to the fields in \"properties\".\n * @internal\n */\n fields?: string[];\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?: 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;\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$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;\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 /** 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$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$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$2;\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$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 booking policy.\n * @param bookingPolicy - Booking policy to create.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingPolicy\n * @permissionId BOOKINGS.BOOKING_POLICY_CREATE\n * @adminMethod\n * @returns Created booking policy.\n */\n function createBookingPolicy(bookingPolicy: BookingPolicy): Promise;\n /**\n * Retrieves a booking policy.\n * @param bookingPolicyId - ID of the booking policy to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingPolicyId\n * @permissionId BOOKINGS.BOOKING_POLICY_READ\n * @returns Retrieved booking policy.\n */\n function getBookingPolicy(bookingPolicyId: string): Promise;\n /**\n * Retrieves the strictest version of each policy rule from a list of booking\n * policies.\n *\n *\n * Returns a hypothetical `bookingPolicy` object that combines the strictest\n * version of each rule. The `id` of the returned policy is `null` and no\n * corresponding `bookingPolicy` object is created. To create a new policy, you\n * can use [Create Booking Policy](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/create-booking-policy).\n * @param bookingPolicyIds - IDs of the booking policies for which to retrieve the strictest rules for.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingPolicyIds\n * @permissionId BOOKINGS.BOOKING_POLICY_READ\n */\n function getStrictestBookingPolicy(bookingPolicyIds: string[]): Promise;\n /**\n * Updates a booking policy.\n *\n *\n * Each time the booking policy is updated, `revision` increments by 1.\n * The current `revision` must be passed when updating the booking policy.\n * This ensures you're working with the latest booking policy and prevents unintended overwrites.\n * @param _id - ID of the booking policy.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField bookingPolicy\n * @requiredField bookingPolicy.revision\n * @permissionId BOOKINGS.BOOKING_POLICY_UPDATE\n * @adminMethod\n * @returns Updated booking policy.\n */\n function updateBookingPolicy(_id: string | null, bookingPolicy: UpdateBookingPolicy, options?: UpdateBookingPolicyOptions): Promise;\n interface UpdateBookingPolicy {\n /**\n * ID of the booking policy.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number, which increments by 1 each time the booking policy is updated.\n * To prevent conflicting changes, the current `revision` must be passed when\n * updating the booking policy.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the booking policy was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the booking policy was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Name of the booking policy. */\n name?: string | null;\n /**\n * Custom description for the booking policy and whether it's displayed to the\n * participant.\n */\n customPolicyDescription?: PolicyDescription;\n /**\n * Whether the booking policy is the default.\n * @readonly\n */\n default?: boolean | null;\n /** Rule for limiting early bookings. */\n limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;\n /**\n * Rule for limiting late bookings. This rule and `bookAfterStartPolicy` can't\n * be both enabled at the same time.\n */\n limitLateBookingPolicy?: LimitLateBookingPolicy;\n /**\n * Rule for booking after the start of a session or course. This rule and\n * `limitLateBookingPolicy` can't be both enabled at the same time.\n */\n bookAfterStartPolicy?: BookAfterStartPolicy;\n /** Rule for canceling a booking. */\n cancellationPolicy?: CancellationPolicy;\n /** Rule for rescheduling a booking. */\n reschedulePolicy?: ReschedulePolicy;\n /** Waitlist rule for the service. */\n waitlistPolicy?: WaitlistPolicy;\n /** Rule for participants per booking. */\n participantsPolicy?: ParticipantsPolicy;\n /**\n * Rule for allocating resources.\n * @internal\n */\n resourcesPolicy?: ResourcesPolicy;\n /** Rules for cancellation fees. */\n cancellationFeePolicy?: CancellationFeePolicy;\n /** Rule for saving credit card details. */\n saveCreditCardPolicy?: SaveCreditCardPolicy;\n /** Extensions enabling users to save custom data related to the booking policies. */\n extendedFields?: ExtendedFields$2;\n }\n interface UpdateBookingPolicyOptions {\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask?: string[];\n }\n /**\n * Sets a booking policy as the default.\n *\n *\n * Also updates the site's current default policy by setting its `default`\n * attribute to `false`. If the provided policy is already the site's\n * default, the call succeeds without changing any `bookingPolicy` object.\n * @param bookingPolicyId - ID of the booking policy that's set as default.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingPolicyId\n * @permissionId BOOKINGS.BOOKING_POLICY_SET_DEFAULT\n * @adminMethod\n */\n function setDefaultBookingPolicy(bookingPolicyId: string): Promise;\n /**\n * Deletes a booking policy.\n *\n *\n * You can't delete the default policy without\n * [setting a different policy as default](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/set-default-booking-policy)\n * first.\n * @param bookingPolicyId - ID of the booking policy to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField bookingPolicyId\n * @permissionId BOOKINGS.BOOKING_POLICY_DELETE\n * @adminMethod\n */\n function deleteBookingPolicy(bookingPolicyId: string): Promise;\n /**\n * Retrieves a list of booking policies, given the provided paging, filtering, and sorting.\n *\n *\n * Query Booking Policies runs with these defaults, which you can override:\n *\n * - Sorted by `createdDate` in ascending order.\n * - `cursorPaging.limit` set to `100`.\n *\n * For details about all supported filters and sorting options, see\n * [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters).\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/api/rest/getting-started/pagination),\n * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.BOOKING_POLICY_READ\n */\n function queryBookingPolicies(): BookingPoliciesQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface BookingPoliciesQueryResult extends QueryCursorResult$1 {\n items: BookingPolicy[];\n query: BookingPoliciesQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface BookingPoliciesQueryBuilder {\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' | 'customPolicyDescription.enabled' | 'customPolicyDescription.description' | 'default' | 'limitEarlyBookingPolicy.enabled' | 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.enabled' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'bookAfterStartPolicy.enabled' | 'cancellationPolicy.enabled' | 'cancellationPolicy.limitLatestCancellation' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.enabled' | 'reschedulePolicy.limitLatestReschedule' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.enabled' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking' | 'resourcesPolicy.enabled' | 'resourcesPolicy.autoAssignAllowed', value: any) => BookingPoliciesQueryBuilder;\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' | 'customPolicyDescription.enabled' | 'customPolicyDescription.description' | 'default' | 'limitEarlyBookingPolicy.enabled' | 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.enabled' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'bookAfterStartPolicy.enabled' | 'cancellationPolicy.enabled' | 'cancellationPolicy.limitLatestCancellation' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.enabled' | 'reschedulePolicy.limitLatestReschedule' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.enabled' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking' | 'resourcesPolicy.enabled' | 'resourcesPolicy.autoAssignAllowed', value: any) => BookingPoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ge: (propertyName: 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking', value: any) => BookingPoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n gt: (propertyName: 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking', value: any) => BookingPoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n le: (propertyName: 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking', value: any) => BookingPoliciesQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n lt: (propertyName: 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking', value: any) => BookingPoliciesQueryBuilder;\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' | 'customPolicyDescription.description', value: string) => BookingPoliciesQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.maxParticipantsPerBooking', value: any) => BookingPoliciesQueryBuilder;\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' | 'name' | 'customPolicyDescription.enabled' | 'customPolicyDescription.description' | 'default' | 'limitEarlyBookingPolicy.enabled' | 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.enabled' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'bookAfterStartPolicy.enabled' | 'cancellationPolicy.enabled' | 'cancellationPolicy.limitLatestCancellation' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.enabled' | 'reschedulePolicy.limitLatestReschedule' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.enabled' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.enabled' | 'participantsPolicy.maxParticipantsPerBooking' | 'resourcesPolicy.enabled' | 'resourcesPolicy.autoAssignAllowed'>) => BookingPoliciesQueryBuilder;\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' | 'name' | 'customPolicyDescription.enabled' | 'customPolicyDescription.description' | 'default' | 'limitEarlyBookingPolicy.enabled' | 'limitEarlyBookingPolicy.earliestBookingInMinutes' | 'limitLateBookingPolicy.enabled' | 'limitLateBookingPolicy.latestBookingInMinutes' | 'bookAfterStartPolicy.enabled' | 'cancellationPolicy.enabled' | 'cancellationPolicy.limitLatestCancellation' | 'cancellationPolicy.latestCancellationInMinutes' | 'reschedulePolicy.enabled' | 'reschedulePolicy.limitLatestReschedule' | 'reschedulePolicy.latestRescheduleInMinutes' | 'waitlistPolicy.enabled' | 'waitlistPolicy.capacity' | 'waitlistPolicy.reservationTimeInMinutes' | 'participantsPolicy.enabled' | 'participantsPolicy.maxParticipantsPerBooking' | 'resourcesPolicy.enabled' | 'resourcesPolicy.autoAssignAllowed'>) => BookingPoliciesQueryBuilder;\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) => BookingPoliciesQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => BookingPoliciesQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Counts booking policies, given the provided filtering.\n *\n *\n * See [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters)\n * for details.\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.BOOKING_POLICY_READ\n */\n function countBookingPolicies(options?: CountBookingPoliciesOptions): Promise;\n interface CountBookingPoliciesOptions {\n /**\n * Filter to base the count on. See\n * [the supported filters article](https://dev.wix.com/docs/rest/business-solutions/bookings/services/booking-policy/supported-filters)\n * for details.\n */\n filter?: Record | null;\n }\n \n type bookingsV1BookingPolicy_universal_d_BookingPolicy = BookingPolicy;\n type bookingsV1BookingPolicy_universal_d_PolicyDescription = PolicyDescription;\n type bookingsV1BookingPolicy_universal_d_LimitEarlyBookingPolicy = LimitEarlyBookingPolicy;\n type bookingsV1BookingPolicy_universal_d_LimitLateBookingPolicy = LimitLateBookingPolicy;\n type bookingsV1BookingPolicy_universal_d_BookAfterStartPolicy = BookAfterStartPolicy;\n type bookingsV1BookingPolicy_universal_d_CancellationPolicy = CancellationPolicy;\n type bookingsV1BookingPolicy_universal_d_ReschedulePolicy = ReschedulePolicy;\n type bookingsV1BookingPolicy_universal_d_WaitlistPolicy = WaitlistPolicy;\n type bookingsV1BookingPolicy_universal_d_ParticipantsPolicy = ParticipantsPolicy;\n type bookingsV1BookingPolicy_universal_d_ResourcesPolicy = ResourcesPolicy;\n type bookingsV1BookingPolicy_universal_d_CancellationFeePolicy = CancellationFeePolicy;\n type bookingsV1BookingPolicy_universal_d_Money = Money;\n type bookingsV1BookingPolicy_universal_d_CancellationWindow = CancellationWindow;\n type bookingsV1BookingPolicy_universal_d_CancellationWindowFeeOneOf = CancellationWindowFeeOneOf;\n type bookingsV1BookingPolicy_universal_d_SaveCreditCardPolicy = SaveCreditCardPolicy;\n type bookingsV1BookingPolicy_universal_d_DefaultBookingPolicySet = DefaultBookingPolicySet;\n type bookingsV1BookingPolicy_universal_d_CreateBookingPolicyRequest = CreateBookingPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_CreateBookingPolicyResponse = CreateBookingPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_GetBookingPolicyRequest = GetBookingPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_GetBookingPolicyResponse = GetBookingPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_GetStrictestBookingPolicyRequest = GetStrictestBookingPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_GetStrictestBookingPolicyResponse = GetStrictestBookingPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_UpdateBookingPolicyRequest = UpdateBookingPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_UpdateBookingPolicyResponse = UpdateBookingPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_SetDefaultBookingPolicyRequest = SetDefaultBookingPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_SetDefaultBookingPolicyResponse = SetDefaultBookingPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_DeleteBookingPolicyRequest = DeleteBookingPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_DeleteBookingPolicyResponse = DeleteBookingPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_QueryBookingPoliciesRequest = QueryBookingPoliciesRequest;\n type bookingsV1BookingPolicy_universal_d_CursorQuery = CursorQuery;\n type bookingsV1BookingPolicy_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type bookingsV1BookingPolicy_universal_d_QueryBookingPoliciesResponse = QueryBookingPoliciesResponse;\n type bookingsV1BookingPolicy_universal_d_CountBookingPoliciesRequest = CountBookingPoliciesRequest;\n type bookingsV1BookingPolicy_universal_d_CountBookingPoliciesResponse = CountBookingPoliciesResponse;\n type bookingsV1BookingPolicy_universal_d_UpdateAllPoliciesRequest = UpdateAllPoliciesRequest;\n type bookingsV1BookingPolicy_universal_d_UpdateAllPoliciesResponse = UpdateAllPoliciesResponse;\n type bookingsV1BookingPolicy_universal_d_CreateMissingDefaultPolicyRequest = CreateMissingDefaultPolicyRequest;\n type bookingsV1BookingPolicy_universal_d_CreateMissingDefaultPolicyResponse = CreateMissingDefaultPolicyResponse;\n type bookingsV1BookingPolicy_universal_d_Empty = Empty;\n type bookingsV1BookingPolicy_universal_d_SitePropertiesNotification = SitePropertiesNotification;\n type bookingsV1BookingPolicy_universal_d_SitePropertiesEvent = SitePropertiesEvent;\n type bookingsV1BookingPolicy_universal_d_Properties = Properties;\n type bookingsV1BookingPolicy_universal_d_Categories = Categories;\n type bookingsV1BookingPolicy_universal_d_Locale = Locale;\n type bookingsV1BookingPolicy_universal_d_AddressHint = AddressHint;\n type bookingsV1BookingPolicy_universal_d_PlacementType = PlacementType;\n const bookingsV1BookingPolicy_universal_d_PlacementType: typeof PlacementType;\n type bookingsV1BookingPolicy_universal_d_GeoCoordinates = GeoCoordinates;\n type bookingsV1BookingPolicy_universal_d_BusinessSchedule = BusinessSchedule;\n type bookingsV1BookingPolicy_universal_d_TimePeriod = TimePeriod;\n type bookingsV1BookingPolicy_universal_d_DayOfWeek = DayOfWeek;\n const bookingsV1BookingPolicy_universal_d_DayOfWeek: typeof DayOfWeek;\n type bookingsV1BookingPolicy_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type bookingsV1BookingPolicy_universal_d_Multilingual = Multilingual;\n type bookingsV1BookingPolicy_universal_d_SupportedLanguage = SupportedLanguage;\n type bookingsV1BookingPolicy_universal_d_ResolutionMethod = ResolutionMethod;\n const bookingsV1BookingPolicy_universal_d_ResolutionMethod: typeof ResolutionMethod;\n type bookingsV1BookingPolicy_universal_d_ConsentPolicy = ConsentPolicy;\n type bookingsV1BookingPolicy_universal_d_Translation = Translation;\n type bookingsV1BookingPolicy_universal_d_ChangeContext = ChangeContext;\n type bookingsV1BookingPolicy_universal_d_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;\n type bookingsV1BookingPolicy_universal_d_PropertiesChange = PropertiesChange;\n type bookingsV1BookingPolicy_universal_d_SiteCreated = SiteCreated;\n type bookingsV1BookingPolicy_universal_d_SiteCloned = SiteCloned;\n const bookingsV1BookingPolicy_universal_d_createBookingPolicy: typeof createBookingPolicy;\n const bookingsV1BookingPolicy_universal_d_getBookingPolicy: typeof getBookingPolicy;\n const bookingsV1BookingPolicy_universal_d_getStrictestBookingPolicy: typeof getStrictestBookingPolicy;\n const bookingsV1BookingPolicy_universal_d_updateBookingPolicy: typeof updateBookingPolicy;\n type bookingsV1BookingPolicy_universal_d_UpdateBookingPolicy = UpdateBookingPolicy;\n type bookingsV1BookingPolicy_universal_d_UpdateBookingPolicyOptions = UpdateBookingPolicyOptions;\n const bookingsV1BookingPolicy_universal_d_setDefaultBookingPolicy: typeof setDefaultBookingPolicy;\n const bookingsV1BookingPolicy_universal_d_deleteBookingPolicy: typeof deleteBookingPolicy;\n const bookingsV1BookingPolicy_universal_d_queryBookingPolicies: typeof queryBookingPolicies;\n type bookingsV1BookingPolicy_universal_d_BookingPoliciesQueryResult = BookingPoliciesQueryResult;\n type bookingsV1BookingPolicy_universal_d_BookingPoliciesQueryBuilder = BookingPoliciesQueryBuilder;\n const bookingsV1BookingPolicy_universal_d_countBookingPolicies: typeof countBookingPolicies;\n type bookingsV1BookingPolicy_universal_d_CountBookingPoliciesOptions = CountBookingPoliciesOptions;\n namespace bookingsV1BookingPolicy_universal_d {\n export {\n bookingsV1BookingPolicy_universal_d_BookingPolicy as BookingPolicy,\n bookingsV1BookingPolicy_universal_d_PolicyDescription as PolicyDescription,\n bookingsV1BookingPolicy_universal_d_LimitEarlyBookingPolicy as LimitEarlyBookingPolicy,\n bookingsV1BookingPolicy_universal_d_LimitLateBookingPolicy as LimitLateBookingPolicy,\n bookingsV1BookingPolicy_universal_d_BookAfterStartPolicy as BookAfterStartPolicy,\n bookingsV1BookingPolicy_universal_d_CancellationPolicy as CancellationPolicy,\n bookingsV1BookingPolicy_universal_d_ReschedulePolicy as ReschedulePolicy,\n bookingsV1BookingPolicy_universal_d_WaitlistPolicy as WaitlistPolicy,\n bookingsV1BookingPolicy_universal_d_ParticipantsPolicy as ParticipantsPolicy,\n bookingsV1BookingPolicy_universal_d_ResourcesPolicy as ResourcesPolicy,\n bookingsV1BookingPolicy_universal_d_CancellationFeePolicy as CancellationFeePolicy,\n bookingsV1BookingPolicy_universal_d_Money as Money,\n bookingsV1BookingPolicy_universal_d_CancellationWindow as CancellationWindow,\n bookingsV1BookingPolicy_universal_d_CancellationWindowFeeOneOf as CancellationWindowFeeOneOf,\n bookingsV1BookingPolicy_universal_d_SaveCreditCardPolicy as SaveCreditCardPolicy,\n ExtendedFields$2 as ExtendedFields,\n bookingsV1BookingPolicy_universal_d_DefaultBookingPolicySet as DefaultBookingPolicySet,\n bookingsV1BookingPolicy_universal_d_CreateBookingPolicyRequest as CreateBookingPolicyRequest,\n bookingsV1BookingPolicy_universal_d_CreateBookingPolicyResponse as CreateBookingPolicyResponse,\n bookingsV1BookingPolicy_universal_d_GetBookingPolicyRequest as GetBookingPolicyRequest,\n bookingsV1BookingPolicy_universal_d_GetBookingPolicyResponse as GetBookingPolicyResponse,\n bookingsV1BookingPolicy_universal_d_GetStrictestBookingPolicyRequest as GetStrictestBookingPolicyRequest,\n bookingsV1BookingPolicy_universal_d_GetStrictestBookingPolicyResponse as GetStrictestBookingPolicyResponse,\n bookingsV1BookingPolicy_universal_d_UpdateBookingPolicyRequest as UpdateBookingPolicyRequest,\n bookingsV1BookingPolicy_universal_d_UpdateBookingPolicyResponse as UpdateBookingPolicyResponse,\n bookingsV1BookingPolicy_universal_d_SetDefaultBookingPolicyRequest as SetDefaultBookingPolicyRequest,\n bookingsV1BookingPolicy_universal_d_SetDefaultBookingPolicyResponse as SetDefaultBookingPolicyResponse,\n bookingsV1BookingPolicy_universal_d_DeleteBookingPolicyRequest as DeleteBookingPolicyRequest,\n bookingsV1BookingPolicy_universal_d_DeleteBookingPolicyResponse as DeleteBookingPolicyResponse,\n bookingsV1BookingPolicy_universal_d_QueryBookingPoliciesRequest as QueryBookingPoliciesRequest,\n bookingsV1BookingPolicy_universal_d_CursorQuery as CursorQuery,\n bookingsV1BookingPolicy_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$2 as CursorPaging,\n bookingsV1BookingPolicy_universal_d_QueryBookingPoliciesResponse as QueryBookingPoliciesResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$2 as Cursors,\n bookingsV1BookingPolicy_universal_d_CountBookingPoliciesRequest as CountBookingPoliciesRequest,\n bookingsV1BookingPolicy_universal_d_CountBookingPoliciesResponse as CountBookingPoliciesResponse,\n bookingsV1BookingPolicy_universal_d_UpdateAllPoliciesRequest as UpdateAllPoliciesRequest,\n bookingsV1BookingPolicy_universal_d_UpdateAllPoliciesResponse as UpdateAllPoliciesResponse,\n bookingsV1BookingPolicy_universal_d_CreateMissingDefaultPolicyRequest as CreateMissingDefaultPolicyRequest,\n bookingsV1BookingPolicy_universal_d_CreateMissingDefaultPolicyResponse as CreateMissingDefaultPolicyResponse,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n bookingsV1BookingPolicy_universal_d_Empty as Empty,\n bookingsV1BookingPolicy_universal_d_SitePropertiesNotification as SitePropertiesNotification,\n bookingsV1BookingPolicy_universal_d_SitePropertiesEvent as SitePropertiesEvent,\n bookingsV1BookingPolicy_universal_d_Properties as Properties,\n bookingsV1BookingPolicy_universal_d_Categories as Categories,\n bookingsV1BookingPolicy_universal_d_Locale as Locale,\n Address$2 as Address,\n bookingsV1BookingPolicy_universal_d_AddressHint as AddressHint,\n bookingsV1BookingPolicy_universal_d_PlacementType as PlacementType,\n bookingsV1BookingPolicy_universal_d_GeoCoordinates as GeoCoordinates,\n bookingsV1BookingPolicy_universal_d_BusinessSchedule as BusinessSchedule,\n bookingsV1BookingPolicy_universal_d_TimePeriod as TimePeriod,\n bookingsV1BookingPolicy_universal_d_DayOfWeek as DayOfWeek,\n bookingsV1BookingPolicy_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n bookingsV1BookingPolicy_universal_d_Multilingual as Multilingual,\n bookingsV1BookingPolicy_universal_d_SupportedLanguage as SupportedLanguage,\n bookingsV1BookingPolicy_universal_d_ResolutionMethod as ResolutionMethod,\n bookingsV1BookingPolicy_universal_d_ConsentPolicy as ConsentPolicy,\n bookingsV1BookingPolicy_universal_d_Translation as Translation,\n bookingsV1BookingPolicy_universal_d_ChangeContext as ChangeContext,\n bookingsV1BookingPolicy_universal_d_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf,\n bookingsV1BookingPolicy_universal_d_PropertiesChange as PropertiesChange,\n bookingsV1BookingPolicy_universal_d_SiteCreated as SiteCreated,\n bookingsV1BookingPolicy_universal_d_SiteCloned as SiteCloned,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n bookingsV1BookingPolicy_universal_d_createBookingPolicy as createBookingPolicy,\n bookingsV1BookingPolicy_universal_d_getBookingPolicy as getBookingPolicy,\n bookingsV1BookingPolicy_universal_d_getStrictestBookingPolicy as getStrictestBookingPolicy,\n bookingsV1BookingPolicy_universal_d_updateBookingPolicy as updateBookingPolicy,\n bookingsV1BookingPolicy_universal_d_UpdateBookingPolicy as UpdateBookingPolicy,\n bookingsV1BookingPolicy_universal_d_UpdateBookingPolicyOptions as UpdateBookingPolicyOptions,\n bookingsV1BookingPolicy_universal_d_setDefaultBookingPolicy as setDefaultBookingPolicy,\n bookingsV1BookingPolicy_universal_d_deleteBookingPolicy as deleteBookingPolicy,\n bookingsV1BookingPolicy_universal_d_queryBookingPolicies as queryBookingPolicies,\n bookingsV1BookingPolicy_universal_d_BookingPoliciesQueryResult as BookingPoliciesQueryResult,\n bookingsV1BookingPolicy_universal_d_BookingPoliciesQueryBuilder as BookingPoliciesQueryBuilder,\n bookingsV1BookingPolicy_universal_d_countBookingPolicies as countBookingPolicies,\n bookingsV1BookingPolicy_universal_d_CountBookingPoliciesOptions as CountBookingPoliciesOptions,\n };\n }\n \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 {\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;\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 * Corresponding event ID.\n * @internal\n */\n eventId?: string | null;\n /**\n * Date and time the attendance was updated.\n * @internal\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Date and time the attendance status was updated.\n * @internal\n * @readonly\n */\n statusUpdatedDate?: Date | null;\n }\n enum AttendanceStatus {\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;\n }\n interface SetAttendanceRequest {\n /** The attendance information for a booked session that you want to create or update. */\n attendance: Attendance;\n /** Information about whether to send a message to a customer after their attendance was set. */\n participantNotification?: ParticipantNotification$2;\n }\n interface ParticipantNotification$2 {\n /**\n * Whether to send the message about the changes to the customer.\n * Default is false.\n */\n notifyParticipants?: boolean | null;\n /** Optional custom message to send to the participants about the changes to the booking. */\n message?: string | null;\n }\n interface SetAttendanceResponse {\n /** The created or updated attendance information for the booked session. */\n attendance?: Attendance;\n }\n interface AttendanceMarkedAsNotAttended {\n /** The attendance information for a booked session that you want to create or update. */\n attendance?: Attendance;\n /** Information about whether to send a message to a customer after their attendance was set. */\n participantNotification?: ParticipantNotification$2;\n }\n interface BulkSetAttendanceRequest {\n /**\n * The attendance information for a booked sessions that you want to create or update. Min size 1.\n * Deprecated. use `attendance_details`.\n * @internal\n * @deprecated The attendance information for a booked sessions that you want to create or update. Min size 1.\n * Deprecated. use `attendance_details`.\n * @replacedBy attendance_details\n * @targetRemovalDate 2024-06-01\n */\n attendanceList?: Attendance[];\n returnFullEntity?: boolean;\n /** The attendance information for a booked sessions that you want to create or update. Min size 1. */\n attendanceDetails?: AttendanceDetails[];\n }\n interface AttendanceDetails {\n /** The created or updated attendance information for the booked session. */\n attendance?: Attendance;\n /** Information about whether to send a message to a customer after their attendance was set. */\n participantNotification?: ParticipantNotification$2;\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$1;\n }\n interface BulkAttendanceResult {\n item?: Attendance;\n itemMetadata?: ItemMetadata$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 QueryAttendanceRequest {\n /** Query options. */\n query: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {\n /**\n * Paging options to limit and skip the number of items.\n * @internal\n */\n paging?: Paging$1;\n /** Cursors to navigate through the result pages using `next` and `prev`. */\n cursorPaging?: CursorPaging$1;\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$1[];\n /** @internal */\n fieldsets?: string[];\n /**\n * Array of projected fields. A list of specific field names to return.\n * @internal\n */\n fields?: string[];\n }\n /** @oneof */\n interface QueryV2PagingMethodOneOf$1 {\n /**\n * Paging options to limit and skip the number of items.\n * @internal\n */\n paging?: Paging$1;\n /** Cursors to navigate through the result pages using `next` and `prev`. */\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 /**\n * Sort order. Use `ASC` for ascending order or `DESC` for descending order.\n *\n * Default: `ASC`.\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 CursorPaging$1 {\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[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: CursorPagingMetadata;\n }\n /** This is the preferred message for cursor-paging enabled services */\n interface CursorPagingMetadata {\n /** @internal */\n totalCount?: number;\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$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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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$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$1;\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$1 {\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 * @permissionId BOOKINGS.ATTENDANCE_READ\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 * @permissionId BOOKINGS.ATTENDANCE_SET\n * @adminMethod\n */\n function setAttendance(attendance: Attendance, options?: SetAttendanceOptions): Promise;\n interface SetAttendanceOptions {\n /** Information about whether to send a message to a customer after their attendance was set. */\n participantNotification?: ParticipantNotification$2;\n }\n /**\n * Sets information about whether a booking's session was attended for multiple bookings\n *\n *\n * See [SetAttendance](https://dev.wix.com/docs/rest/api-reference/wix-bookings/attendance/set-attendance) documentation for more information.\n *\n * If any of the attendance list required fields were not passed on the request or if the caller doesn't have the required permissions to set the attendance, the call fails.\n * If the request contains attendance info for unavailable sessions, the call completes successfully but the attendance info for the unavailable sessions are not created and are not considered as failures in the response.\n * @public\n * @documentationMaturity preview\n * @permissionId BOOKINGS.ATTENDANCE_SET\n * @adminMethod\n */\n function bulkSetAttendance(options?: BulkSetAttendanceOptions): Promise;\n interface BulkSetAttendanceOptions {\n /**\n * The attendance information for a booked sessions that you want to create or update. Min size 1.\n * Deprecated. use `attendance_details`.\n * @internal\n * @deprecated The attendance information for a booked sessions that you want to create or update. Min size 1.\n * Deprecated. use `attendance_details`.\n * @replacedBy attendance_details\n * @targetRemovalDate 2024-06-01\n */\n attendanceList?: Attendance[];\n returnFullEntity?: boolean;\n /** The attendance information for a booked sessions that you want to create or update. Min size 1. */\n attendanceDetails?: AttendanceDetails[];\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 `withBookingAttendanceDetails` 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 * @permissionId BOOKINGS.ATTENDANCE_READ\n */\n function queryAttendance(): AttendancesQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors$1;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface AttendancesQueryResult extends QueryCursorResult {\n items: Attendance[];\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 \n type bookingsV2Attendance_universal_d_Attendance = Attendance;\n type bookingsV2Attendance_universal_d_AttendanceStatus = AttendanceStatus;\n const bookingsV2Attendance_universal_d_AttendanceStatus: typeof AttendanceStatus;\n type bookingsV2Attendance_universal_d_GetAttendanceRequest = GetAttendanceRequest;\n type bookingsV2Attendance_universal_d_GetAttendanceResponse = GetAttendanceResponse;\n type bookingsV2Attendance_universal_d_SetAttendanceRequest = SetAttendanceRequest;\n type bookingsV2Attendance_universal_d_SetAttendanceResponse = SetAttendanceResponse;\n type bookingsV2Attendance_universal_d_AttendanceMarkedAsNotAttended = AttendanceMarkedAsNotAttended;\n type bookingsV2Attendance_universal_d_BulkSetAttendanceRequest = BulkSetAttendanceRequest;\n type bookingsV2Attendance_universal_d_AttendanceDetails = AttendanceDetails;\n type bookingsV2Attendance_universal_d_BulkSetAttendanceResponse = BulkSetAttendanceResponse;\n type bookingsV2Attendance_universal_d_BulkAttendanceResult = BulkAttendanceResult;\n type bookingsV2Attendance_universal_d_QueryAttendanceRequest = QueryAttendanceRequest;\n type bookingsV2Attendance_universal_d_QueryAttendanceResponse = QueryAttendanceResponse;\n type bookingsV2Attendance_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n const bookingsV2Attendance_universal_d_getAttendance: typeof getAttendance;\n const bookingsV2Attendance_universal_d_setAttendance: typeof setAttendance;\n type bookingsV2Attendance_universal_d_SetAttendanceOptions = SetAttendanceOptions;\n const bookingsV2Attendance_universal_d_bulkSetAttendance: typeof bulkSetAttendance;\n type bookingsV2Attendance_universal_d_BulkSetAttendanceOptions = BulkSetAttendanceOptions;\n const bookingsV2Attendance_universal_d_queryAttendance: typeof queryAttendance;\n type bookingsV2Attendance_universal_d_AttendancesQueryResult = AttendancesQueryResult;\n type bookingsV2Attendance_universal_d_AttendancesQueryBuilder = AttendancesQueryBuilder;\n namespace bookingsV2Attendance_universal_d {\n export {\n bookingsV2Attendance_universal_d_Attendance as Attendance,\n bookingsV2Attendance_universal_d_AttendanceStatus as AttendanceStatus,\n bookingsV2Attendance_universal_d_GetAttendanceRequest as GetAttendanceRequest,\n bookingsV2Attendance_universal_d_GetAttendanceResponse as GetAttendanceResponse,\n bookingsV2Attendance_universal_d_SetAttendanceRequest as SetAttendanceRequest,\n ParticipantNotification$2 as ParticipantNotification,\n bookingsV2Attendance_universal_d_SetAttendanceResponse as SetAttendanceResponse,\n bookingsV2Attendance_universal_d_AttendanceMarkedAsNotAttended as AttendanceMarkedAsNotAttended,\n bookingsV2Attendance_universal_d_BulkSetAttendanceRequest as BulkSetAttendanceRequest,\n bookingsV2Attendance_universal_d_AttendanceDetails as AttendanceDetails,\n bookingsV2Attendance_universal_d_BulkSetAttendanceResponse as BulkSetAttendanceResponse,\n bookingsV2Attendance_universal_d_BulkAttendanceResult as BulkAttendanceResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n bookingsV2Attendance_universal_d_QueryAttendanceRequest as QueryAttendanceRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$1 as Paging,\n CursorPaging$1 as CursorPaging,\n bookingsV2Attendance_universal_d_QueryAttendanceResponse as QueryAttendanceResponse,\n bookingsV2Attendance_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n Cursors$1 as Cursors,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n bookingsV2Attendance_universal_d_getAttendance as getAttendance,\n bookingsV2Attendance_universal_d_setAttendance as setAttendance,\n bookingsV2Attendance_universal_d_SetAttendanceOptions as SetAttendanceOptions,\n bookingsV2Attendance_universal_d_bulkSetAttendance as bulkSetAttendance,\n bookingsV2Attendance_universal_d_BulkSetAttendanceOptions as BulkSetAttendanceOptions,\n bookingsV2Attendance_universal_d_queryAttendance as queryAttendance,\n bookingsV2Attendance_universal_d_AttendancesQueryResult as AttendancesQueryResult,\n bookingsV2Attendance_universal_d_AttendancesQueryBuilder as AttendancesQueryBuilder,\n };\n }\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 * Number of participants.\n * @internal\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note\n * @internal\n * @deprecated\n */\n internalBusinessNote?: string | null;\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$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 */\n paymentStatus?: PaymentStatus$1;\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$1;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /**\n * An object describing the platform and application that made the booking.\n * @internal\n */\n bookingSource?: BookingSource$1;\n /**\n * The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.\n * @internal\n * @deprecated\n */\n participantNotification?: ParticipantNotification$1;\n /**\n * When value is set to True, an SMS reminder would be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.\n * @internal\n * @deprecated\n */\n sendSmsReminder?: boolean | 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 | null;\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 | null;\n /**\n * Sets the booking flow behavior. Some behaviors require permissions.\n * @internal\n */\n flowControlSettings?: FlowControlSettings$1;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.\n * For usage of extended fields with [Wix Forms](https://dev.wix.com/docs/rest/crm/forms/form-schema-api/introduction-to-forms), after configuring your form custom fields, pass the form field values under the `_user_fields` namespace.\n * For example, if you have a custom form field named `age`, pass it as `\"extendedFields\":{\"_user_fields\": { \"age\": 22 }}`.\n */\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 * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\n /**\n * Multi service booking info of which the booking is part of.\n * @internal\n * @readonly\n */\n multiServiceBookingInfo?: MultiServiceBookingInfo$1;\n /**\n * The date this booking was canceled on\n * @internal\n * @readonly\n */\n canceledDate?: Date | null;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2AvailabilityProxy?: boolean | null;\n /**\n * Having booking language means that the booking was made in a secondary language, having no booking.language implies that the booking was made using the main language\n * @internal\n */\n language?: string | 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 * If the user made the booking in a secondary language, this field will contain the translated title.\n * @internal\n * @readonly\n */\n titleTranslated?: 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$1;\n /**\n * Optional.\n * In addition to the `resource` field, these are the additional enriched resources that are assigned to the slot.\n * For example the room, equipment or the additional staff member that are assigned to the slot.\n * @internal\n */\n additionalResources?: BookedResource$1[];\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 /**\n * Resource's name translated to the language the booking was made in if applicable.\n * @internal\n * @readonly\n */\n nameTranslated?: 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 * Indicates whether the resource was specifically requested or should be auto selected by the Server.\n * The value will be true if the resource was explicitly given in the request, otherwise false.\n * @internal\n * @readonly\n */\n explicitlyRequested?: boolean | null;\n /**\n * Resource's type.\n * @internal\n * @readonly\n */\n type?: string | null;\n }\n interface Location$1 {\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 /** The full translated address of this location. */\n formattedAddressTranslated?: 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$1;\n }\n enum LocationType$1 {\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$1;\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/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$1;\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$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 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 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 /** Platform from which a booking was created */\n platform?: Platform$1;\n /** Actor that created this booking. */\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$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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\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 * @internal\n * @readonly\n */\n identityType?: IdentificationDataIdentityType;\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$1 {\n /**\n * When true, skips the service defined booking-window in the booking policy.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n * private because it's confusing to external users - collides with skip_availability_validation\n * and yet, clients send it (though always with skip_availability_validation=true) so we're not just removing it\n * When removing, we need to use proto's `reserved` field\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: boolean;\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$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$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$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 CreateMultiServiceBookingRequest {\n /** The bookings to create as multi service booking. */\n bookings: Booking$1[];\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$1;\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$1;\n }\n interface CreateBookingFlowControlSettings {\n /**\n * when defined as `true`, skips the service defined booking-window in the booking policy.\n * required BOOKINGS.IGNORE_BOOKING_POLICY permission. TODO - check if can be merged with skit_availability_validation\n * private because it's confusing to external users - collides with skip_availability_validation\n * and yet, clients send it (though always with skip_availability_validation=true) so we're not just removing it\n * When removing, we need to use proto's `reserved` field\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: boolean;\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$1;\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: RescheduleMultiServiceBookingRequestRescheduleBookingInfo[];\n /** Information about whether to notify the customer about the rescheduling and the message to send. */\n participantNotification?: ParticipantNotification$1;\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 * Calendar 3 event ID - not supported\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 * @internal\n */\n eventId?: string | null;\n /**\n * Optional.\n * In addition to the `resource` field, these are the additional enriched resources that are assigned to the slot.\n * For example the room, equipment or the additional staff member that are assigned to the slot.\n * @internal\n */\n additionalResources?: SlotSlotResource[];\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 * Read only. Schedule ID\n * @internal\n */\n scheduleId?: 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 RescheduleMultiServiceBookingRequestRescheduleBookingInfo extends RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf {\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$1;\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 RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf {\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$1;\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 * when defined as true, skips the service defined booking-window validation in the booking policy.\n * required BOOKINGS.IGNORE_BOOKING_POLICY permission.\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: 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$1;\n /** The rescheduled booking object. */\n booking?: Booking$1;\n /** Information about whether to notify the customer about the rescheduling and the message to send. */\n participantNotification?: ParticipantNotification$1;\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$1;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus$1;\n /** An object describing the previous slot or schedule of the booking. */\n previousBookedEntity?: BookedEntity$1;\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 | null;\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 | null;\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$1;\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 /**\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 * @internal\n * @readonly\n */\n identityType?: IdentityType$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 IdentityType$1 {\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;\n /** Multi service booking policy settings */\n policySettings?: BookingPolicySettings;\n /** Info of the bookings this availability was calculated for. */\n multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];\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 BookingPolicySettings {\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$1;\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 * Whether to waive the cancellation fee when canceling the booking.\n * By default, cancellation fee will be applied.\n * If passing `true`, the cancellation fee will not be applied upon canceling the booking.\n * Must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing `true`.\n * Default: `false`.\n * @internal\n */\n waiveCancellationFee?: 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$1;\n /** Information about whether to notify the customer about the cancelation and the message to send. */\n participantNotification?: ParticipantNotification$1;\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$1;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus$1;\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$1;\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$1;\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$1;\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 * 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$1;\n /** Information about whether to notify the customer about the confirmation and the message to send. */\n participantNotification?: ParticipantNotification$1;\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$1;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus$1;\n /** The previous payment status of the booking. */\n previousPaymentStatus?: PaymentStatus$1;\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$1;\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 * Information about whether specific procedures of the standard Wix Bookings\n * declining flow are changed. For example, whether to issue a refund.\n */\n flowControlSettings?: DeclineBookingFlowControlSettings;\n }\n interface DeclineBookingFlowControlSettings {\n /**\n * Whether to issue a refund when declining 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 DeclineMultiServiceBookingResponse {\n /** Declined multi service booking. */\n multiServiceBooking?: MultiServiceBooking;\n }\n interface BookingDeclined {\n /** The declined booking object. */\n booking?: Booking$1;\n /** Information about whether to notify the customer about the decline and the message to send. */\n participantNotification?: ParticipantNotification$1;\n /** Whether this booking overlaps with another existing confirmed booking. */\n doubleBooked?: boolean | null;\n /** ID of the decline initiator. */\n initiatedBy?: IdentificationData$1;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus$1;\n /** The previous payment status of the booking. */\n previousPaymentStatus?: PaymentStatus$1;\n /**\n * Information about whether specific procedures of the standard Wix Bookings\n * declining flow are changed. For example, whether to issue a refund.\n */\n flowControlSettings?: DeclineBookingFlowControlSettings;\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;\n }\n interface BulkCalculateAllowedActionsResult {\n /** (id, indexInGivenSeq, isSuccessful, error) */\n itemMetadata?: ItemMetadata;\n item?: AllowedActions;\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 /** 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 * Is it possible to book another booking to the same service.\n * @internal\n */\n bookAnother?: boolean;\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 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$1;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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?: 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;\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 {\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$1;\n /** The booking after the changes. */\n currentBooking?: Booking$1;\n }\n interface CreateBookingRequest {\n /** The booking to create. */\n booking: Booking$1;\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$1;\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$1;\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$1;\n /** @internal */\n mask?: string[];\n }\n interface UpdateBookingResponse {\n booking?: Booking$1;\n }\n interface LegacyCreateBookingRequest {\n booking: Booking$1;\n }\n interface LegacyCreateBookingResponse {\n booking?: Booking$1;\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$1;\n /** @internal */\n mask?: string[];\n }\n interface BulkUpdateBookingResponse {\n results?: ItemMetadata[];\n bulkActionMetadata?: BulkActionMetadata;\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$1;\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$1;\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;\n }\n interface BulkBookingResult {\n itemMetadata?: ItemMetadata;\n item?: Booking$1;\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$1;\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$1;\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 * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\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$1;\n }\n interface RescheduleBookingResponse {\n /** Rescheduled booking. */\n booking?: Booking$1;\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$1;\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$1;\n }\n interface BulkRescheduleBookingResponse {\n /** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */\n results?: ItemMetadata[];\n /** Total successes and failures of the bulk reschedule action. */\n bulkActionMetadata?: BulkActionMetadata;\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$1;\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[];\n /** Total successes and failures of the bulk update action. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface QueryBookingsRequest {\n query: QueryV2;\n /**\n * Whether the authorization constraint should be handled on Bookings-Service. To be removed when rollout of SCHED-SCHED-25500 is finished.\n * @internal\n */\n shouldNotHandleAuthorizationConstraints?: boolean;\n /**\n * Whether information about the total entities is returned.\n * @internal\n */\n withPagingMetadataTotal?: boolean;\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 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 /** 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryBookingsResponse {\n bookings?: Booking$1[];\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 * 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 * @internal\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 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$1;\n }\n interface ConfirmResponse {\n /** Confirmed booking. */\n booking?: Booking$1;\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$1;\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$1;\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$1;\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;\n }\n interface ConsistentQueryBookingsResponse {\n bookings?: Booking$1[];\n pagingMetadata?: PagingMetadataV2;\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$1;\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$1;\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$1;\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 * declining flow are changed. For example, whether to issue a refund.\n */\n flowControlSettings?: DeclineBookingFlowControlSettings;\n }\n interface DeclineBookingResponse {\n /** eclined booking */\n booking?: Booking$1;\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$1;\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$1;\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$1;\n /** ID of the booking to update the number of participants for. */\n bookingId: string;\n /**\n * Updated number of participants.\n * @internal\n * @deprecated\n */\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 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$1;\n }\n interface UpdateNumberOfParticipantsResponse {\n /** Booking with updated number of participants. */\n booking?: Booking$1;\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$1;\n /** The updated booking object. */\n booking?: Booking$1;\n /** ID of the participant number update initiator. */\n initiatedBy?: IdentificationData$1;\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$1;\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;\n }\n interface GetSlotAvailabilityRequest {\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 * Return the IDs of bookings that are currently allowed to book the given slot due to being a part of a waitlist in a \"suggested\" status.\n * @internal\n */\n returnAllowedBookingIds?: boolean;\n /**\n * Check if this booking is allowed to book the given slot due to being a part of a waitlist in a \"suggested\" status.\n * If passed and the slot is locked for a booking other than this one, `bookable = false` is returned.\n * @internal\n */\n bookingId?: string | null;\n /**\n * Whether availability should be queried to availability calendar or availability service\n * @internal\n */\n shouldUseV2Availability?: boolean;\n /**\n * TODO: remove after qa and add a dedicated EP for calculating all available non double booked resources instead.\n * Whether to skip optimizations during the calculation for overlapping bookings, in order to get the full list of possible\n * non double booked resources.\n * @internal\n */\n returnAllAvailableResources?: boolean;\n /**\n * Whether availability should be queried to availability calendar or availability service\n * @internal\n */\n v2Availability?: boolean | null;\n }\n interface GetSlotAvailabilityResponse {\n availability?: SlotAvailability;\n bookingPolicySettings?: BookingPolicySettings;\n /**\n * Bookings that are currently allowed to book the given slot due to being a part of a waitlist in a \"suggested\" status.\n * @internal\n */\n allowedBookingIds?: string[];\n /**\n * List of `AvailableResources` for the slot.\n * Each `AvailableResources` contains information about available resources of the same type.\n * @internal\n */\n availableResources?: AvailableResources[];\n }\n interface SlotAvailability {\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;\n /** Indicators for booking policy violations for the slot. */\n bookingPolicyViolations?: BookingPolicyViolations;\n /** Indicates whether this slot is locked. */\n locked?: boolean | null;\n }\n interface WaitingList {\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 * The required number of resources of this type in order to book the service.\n * @internal\n */\n numberOfResourcesRequired?: number | null;\n }\n interface GetScheduleAvailabilityRequest {\n /** The schedule ID for which availability is checked. */\n scheduleId: string;\n }\n interface GetScheduleAvailabilityResponse {\n availability?: ScheduleAvailability;\n bookingPolicySettings?: BookingPolicySettings;\n }\n interface ScheduleAvailability {\n totalSpots?: number | null;\n openSpots?: number | null;\n /** Indicators of booking policy violations for the given Schedule. */\n bookingPolicyViolations?: BookingPolicyViolations;\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$1;\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$1;\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$1;\n }\n interface BookingMarkedAsPending {\n /** The booking object that was marked as pending. */\n booking?: Booking$1;\n /** Information about whether to notify the customer upon manual confirmation of the pending booking and the message to send. */\n participantNotification?: ParticipantNotification$1;\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$1;\n /** The previous status of the booking. */\n previousStatus?: BookingStatus$1;\n /** The previous payment status of the booking. */\n previousPaymentStatus?: PaymentStatus$1;\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 /**\n * Current payment status of the booking when using a custom checkout page and\n * not the [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).\n *\n * The booking is declined if there is a double booking conflict and you provide\n * one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.\n */\n paymentStatus?: PaymentStatus$1;\n /**\n * When true – decline the booking if double booked.\n * @internal\n */\n declineDoubleBooking?: boolean | null;\n }\n interface ConfirmOrDeclineBookingResponse {\n /** Updated booking. */\n booking?: Booking$1;\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 /**\n * Current payment status of the booking when using a custom checkout page and\n * not the [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).\n *\n * The booking is declined if there is a double booking conflict and you provide\n * one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.\n */\n paymentStatus?: PaymentStatus$1;\n /**\n * When true – decline the booking if double booked.\n * @internal\n */\n declineDoubleBooking?: boolean | null;\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;\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;\n /** Information about the schedule to create a booking for. */\n schedule?: BookedSchedule$1;\n /**\n * Total number of participants.\n * Provide when the service doesn't have\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Provide for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n /** Contact details of the customer booking the service. */\n contactDetails?: ContactDetails$1;\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$1;\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$1[];\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$1;\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$1;\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$1;\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 * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\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;\n /** Information about the schedule to create a booking for. */\n schedule?: BookedSchedule$1;\n }\n /** @oneof */\n interface V2CreateBookingRequestParticipantsInfoOneOf {\n /**\n * Total number of participants.\n * Provide when the service doesn't have\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Provide for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\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$1;\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 * Schedule ID. Read only.\n * @internal\n */\n scheduleId?: string | null;\n }\n interface CreateBookingRequestFlowControlSettings {\n /**\n * when defined as true, skips the service defined booking-window in the booking policy.\n * required BOOKINGS.IGNORE_BOOKING_POLICY permission. TODO - check if can be merged with skit_availability_validation\n * private because it's confusing to external users - collides with skip_availability_validation\n * and yet, clients send it (though always with skip_availability_validation=true) so we're not just removing it\n * When removing, we need to use proto's `reserved` field\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: boolean;\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$1;\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$1;\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 * @internal\n */\n flowControlSettings?: V2CancelBookingRequestFlowControlSettings;\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 V2CancelBookingRequestFlowControlSettings {\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 * Whether to waive the cancellation fee when canceling the booking.\n * By default, cancellation fee will be applied.\n * If passing `true`, the cancellation fee will not be applied upon canceling the booking.\n * Must have the `BOOKINGS.MANAGE_PAYMENTS` permission scope when passing `true`.\n *\n * Default: `false`.\n * @internal\n */\n waiveCancellationFee?: boolean | null;\n }\n interface V2CancelBookingResponse {\n /** Canceled booking. */\n booking?: Booking$1;\n }\n interface V2RescheduleBookingRequest extends V2RescheduleBookingRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when all participants book the same variant.\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when not all participants book the same variant.\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n /** Id of the booking to reschedule. */\n bookingId: string;\n /** Information about the new slot. */\n slot: Slot;\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$1;\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 * @internal\n */\n flowControlSettings?: V2RescheduleBookingRequestFlowControlSettings;\n }\n /** @oneof */\n interface V2RescheduleBookingRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when all participants book the same variant.\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when not all participants book the same variant.\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n }\n interface V2RescheduleBookingRequestFlowControlSettings {\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 * when defined as true, skips the service defined booking-window validation in the booking policy.\n * required BOOKINGS.IGNORE_BOOKING_POLICY permission.\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: 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$1;\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$1;\n }\n interface V2ConfirmBookingResponse {\n booking?: Booking$1;\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$1;\n }\n interface V2DeclineBookingResponse {\n /** Declined booking. */\n booking?: Booking$1;\n }\n interface V2UpdateNumberOfParticipantsRequest extends V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /**\n * Total number of participants. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when all participants book the same variant.\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when not all participants book the same variant.\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\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 * Total number of participants. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when all participants book the same variant.\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when not all participants book the same variant.\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n }\n interface V2UpdateNumberOfParticipantsResponse {\n /** Booking with updated number of participants. */\n booking?: Booking$1;\n }\n /**\n * Creates multi service booking.\n *\n * See [Create Booking](/bookings-v2/bookings-v2-and-confirmation/bookings-create-booking) documentation.\n * @param bookings - The bookings to create as multi service booking.\n * @public\n * @documentationMaturity preview\n * @requiredField bookings\n * @requiredField bookings.additionalFields._id\n * @requiredField bookings.bookedEntity\n * @requiredField bookings.bookedEntity.slot\n * @requiredField bookings.bookedEntity.slot.endDate\n * @requiredField bookings.bookedEntity.slot.location.locationType\n * @requiredField bookings.bookedEntity.slot.scheduleId\n * @requiredField bookings.bookedEntity.slot.startDate\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_CREATE\n */\n function createMultiServiceBooking(bookings: Booking$1[], options?: CreateMultiServiceBookingOptions): Promise;\n interface CreateMultiServiceBookingOptions {\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$1;\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$1;\n }\n /**\n * Reschedules the multi service booking.\n * Validates all the bookings were passed.\n * Throws an exception if there is reschedule policy violation for any of the bookings or if the requested slots are not available.\n * See [Reschedule Booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/reschedule-booking) documentation.\n * @param multiServiceBookingId - ID of the multi service booking to reschedule it's related bookings.\n * @param rescheduleBookingsInfo - Bookings to reschedule.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @requiredField rescheduleBookingsInfo\n * @requiredField rescheduleBookingsInfo.bookingId\n * @requiredField rescheduleBookingsInfo.revision\n * @requiredField rescheduleBookingsInfo.slot\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_RESCHEDULE\n */\n function rescheduleMultiServiceBooking(multiServiceBookingId: string | null, rescheduleBookingsInfo: RescheduleMultiServiceBookingRequestRescheduleBookingInfo[], options?: RescheduleMultiServiceBookingOptions): Promise;\n interface RescheduleMultiServiceBookingOptions {\n /** Information about whether to notify the customer about the rescheduling and the message to send. */\n participantNotification?: ParticipantNotification$1;\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 /**\n * Get multi service booking availability.\n * If the multi service booking is of type SEQUENTIAL_BOOKINGS, its availability is checked through ListMultiServiceAvailabilityTimeSlots API.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_GET_AVAILABILITY\n */\n function getMultiServiceBookingAvailability(multiServiceBookingId: string | null): Promise;\n /**\n * Cancels the multi service booking.\n * Each booking within this multi service booking is being canceled.\n * @param multiServiceBookingId - ID of the multi service booking to cancel it's related bookings.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_CANCEL\n */\n function cancelMultiServiceBooking(multiServiceBookingId: string | null, options?: CancelMultiServiceBookingOptions): Promise;\n interface CancelMultiServiceBookingOptions {\n /** Information about whether to notify the customer about the cancelation and the message to send. */\n participantNotification?: ParticipantNotification$1;\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 /**\n * Mark the multi service booking as PENDING.\n * Changes the status of each of the bookings within the multi service booking to PENDING\n * Validates all the bookings were passed.\n * See [MarkBookingAsPending](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/mark-booking-as-pending) documentation.\n * @param multiServiceBookingId - ID of the multi service booking to mark as pending it's related bookings.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_MARK_AS_PENDING\n * @adminMethod\n */\n function markMultiServiceBookingAsPending(multiServiceBookingId: string | null, options?: MarkMultiServiceBookingAsPendingOptions): Promise;\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$1;\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 /**\n * Confirms the multi service booking.\n * Each booking within this multi service booking is being confirmed.\n * Validates all the bookings were passed.\n * See [Confirm Booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/confirm-booking) documentation.\n * @param multiServiceBookingId - ID of the multi service booking to confirm it's related bookings.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_CONFIRM\n * @adminMethod\n */\n function confirmMultiServiceBooking(multiServiceBookingId: string | null, options?: ConfirmMultiServiceBookingOptions): Promise;\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$1;\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 /**\n * Declines the multi service booking.\n * Each booking within this multi service booking is being declined.\n * Validates all the bookings were passed.\n * See [Decline Booking](https://dev.wix.com/api/rest/wix-bookings/bookings-v2/decline-booking) documentation.\n * @param multiServiceBookingId - ID of the multi service booking to decline it's related bookings.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_DECLINE\n * @adminMethod\n */\n function declineMultiServiceBooking(multiServiceBookingId: string | null, options?: DeclineMultiServiceBookingOptions): Promise;\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$1;\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 * Information about whether specific procedures of the standard Wix Bookings\n * declining flow are changed. For example, whether to issue a refund.\n */\n flowControlSettings?: DeclineBookingFlowControlSettings;\n }\n /**\n * Get the allowed actions for a given multi service bookings by a list of multi service booking ids\n * @param multiServiceBookingIds - The multi service booking ids to get the allowedActions for.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingIds\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_GET_ALLOWED_ACTIONS\n */\n function bulkGetMultiServiceBookingAllowedActions(multiServiceBookingIds: string[] | null): Promise;\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$1;\n }\n /**\n * Retrieves the bookings of a given multi service booking id.\n * In case the caller have permissions to read only part of a bookings, only the permitted bookings would be\n * retrieved, but the total amount of bookings would be returned on response.\n * @param multiServiceBookingId - Multi service booking ID.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_READ\n * @adminMethod\n * @returns Multi service booking.\n */\n function getMultiServiceBooking(multiServiceBookingId: string | null): Promise;\n /**\n * Adds existing bookings to a multi service booking.\n * @param multiServiceBookingId - ID of the multi service booking.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @requiredField options.bookings\n * @requiredField options.bookings.bookingId\n * @requiredField options.bookings.revision\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_ADD_BOOKINGS\n * @adminMethod\n */\n function addBookingsToMultiServiceBooking(multiServiceBookingId: string | null, options?: AddBookingsToMultiServiceBookingOptions): Promise;\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 /**\n * Removes existing bookings from a multi service booking.\n * If request.bookings is empty, all the bookings that the caller is authorized to read will be removed from the multi booking service.\n * Otherwise only the bookings in the request will be removed.\n * Throws an exception if the multi booking service is not found or one of the bookings in the request if present.\n * If the removal of the bookings was successful, the response will contain the bookings that were removed.\n * In case that the removal of the bookings will result in a multi bookings service with only one booking, the multi booking service will be deleted,\n * meaning also the last booking will be removed from the multi booking service.\n * @param multiServiceBookingId - ID of the multi service booking.\n * @public\n * @documentationMaturity preview\n * @requiredField multiServiceBookingId\n * @permissionId MULTI_SERVICE_BOOKINGS.MULTI_SERVICE_BOOKING_REMOVE_BOOKINGS\n * @adminMethod\n */\n function removeBookingsFromMultiServiceBooking(multiServiceBookingId: string | null, options?: RemoveBookingsFromMultiServiceBookingOptions): Promise;\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 * @permissionId BOOKINGS.BOOKING_CREATE\n */\n function createBooking(booking: Booking$1, options?: CreateBookingOptions): Promise;\n interface CreateBookingOptions {\n /** Information about a message to send to the customer. */\n participantNotification?: ParticipantNotification$1;\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 /** @param _id - Booking ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField booking\n * @requiredField booking.revision\n * @permissionId BOOKINGS.BOOKING_MANAGE\n * @adminMethod\n * @deprecated\n */\n function updateBooking(_id: string | null, booking: UpdateBooking, options?: UpdateBookingOptions): Promise;\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$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 * Number of participants.\n * @internal\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note\n * @internal\n * @deprecated\n */\n internalBusinessNote?: string | null;\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$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 */\n paymentStatus?: PaymentStatus$1;\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$1;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /**\n * An object describing the platform and application that made the booking.\n * @internal\n */\n bookingSource?: BookingSource$1;\n /**\n * The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.\n * @internal\n * @deprecated\n */\n participantNotification?: ParticipantNotification$1;\n /**\n * When value is set to True, an SMS reminder would be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.\n * @internal\n * @deprecated\n */\n sendSmsReminder?: boolean | 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 | null;\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 | null;\n /**\n * Sets the booking flow behavior. Some behaviors require permissions.\n * @internal\n */\n flowControlSettings?: FlowControlSettings$1;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.\n * For usage of extended fields with [Wix Forms](https://dev.wix.com/docs/rest/crm/forms/form-schema-api/introduction-to-forms), after configuring your form custom fields, pass the form field values under the `_user_fields` namespace.\n * For example, if you have a custom form field named `age`, pass it as `\"extendedFields\":{\"_user_fields\": { \"age\": 22 }}`.\n */\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 * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\n /**\n * Multi service booking info of which the booking is part of.\n * @internal\n * @readonly\n */\n multiServiceBookingInfo?: MultiServiceBookingInfo$1;\n /**\n * The date this booking was canceled on\n * @internal\n * @readonly\n */\n canceledDate?: Date | null;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2AvailabilityProxy?: boolean | null;\n /**\n * Having booking language means that the booking was made in a secondary language, having no booking.language implies that the booking was made using the main language\n * @internal\n */\n language?: string | null;\n }\n interface UpdateBookingOptions {\n /** @internal */\n mask?: string[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField booking\n * @requiredField booking.additionalFields._id\n * @requiredField booking.bookedEntity\n * @permissionId BOOKINGS.BOOKING_MANAGE\n * @adminMethod\n */\n function legacyCreateBooking(booking: Booking$1): Promise;\n /**\n * Updates a batch of bookings.\n * If any `fieldMask` contains `numberOfParticipants` and the field is not defined in the `request.booking` the update fails.\n * If any `fieldMask` contains `participantsInfo` and the field is not defined in the `request.booking` the update fails.\n * If any `fieldMask` contains both `numberOfParticipants` and `participantsInfo` the update fails.\n * If participantsChoices are provided, they are validated against the service variants.if not all choices exist in the variants list a INVALID_SERVICE_CHOICES error is returned.\n * @internal\n * @documentationMaturity preview\n * @requiredField bookings\n * @requiredField bookings.booking\n * @requiredField bookings.booking._id\n * @requiredField bookings.booking.revision\n * @permissionId BOOKINGS.BOOKING_MANAGE\n * @adminMethod\n */\n function bulkUpdateBooking(bookings: MaskedBooking[]): Promise;\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 * @permissionId BOOKINGS.BOOKING_CREATE\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 * @permissionId BOOKINGS.BOOKING_RESCHEDULE\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$1;\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$1;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\n }\n /** @param slotsBookings - Reschedule multiple bookings to multiple slots.\n * @internal\n * @documentationMaturity preview\n * @requiredField slotsBookings\n * @requiredField slotsBookings.bookings\n * @requiredField slotsBookings.bookings._id\n * @requiredField slotsBookings.bookings.revision\n * @requiredField slotsBookings.slot\n * @permissionId BOOKINGS.BOOKING_MANAGE\n * @adminMethod\n */\n function bulkRescheduleBooking(slotsBookings: SlotBookings[], options?: BulkRescheduleBookingOptions): Promise;\n interface BulkRescheduleBookingOptions {\n /** Whether to notify participants about the change and an optional custom message */\n participantNotification?: ParticipantNotification$1;\n }\n /** @param bookings - The bookings whose booked schedule is to be updated to the given schedule.\n * @internal\n * @documentationMaturity preview\n * @requiredField bookings\n * @requiredField bookings._id\n * @requiredField bookings.revision\n * @requiredField options.scheduleId\n * @permissionId BOOKINGS.BOOKING_MANAGE\n * @adminMethod\n */\n function bulkUpdateBookedSchedule(bookings: BookingDetails[], options?: BulkUpdateBookedScheduleOptions): Promise;\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$1;\n }\n /**\n * > **Deprecation Notice**\n * >\n * > **This endpoint has been replaced with [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) and will be removed on December 31, 2023.**\n * > **If your app uses this endpoint, we recommend updating your code as soon as possible.**\n *\n * Retrieves a list of bookings according to the provided filters and paging.\n *\n * \n *\n * Create a query with filters on any booking object property.\n * See [Query Syntax: Filters, Sorting, Fields, and Paging.](https://bo.wix.com/wix-docs/rest/bookings/bookings---bookings-service/query-syntax) for the full query syntax description.\n *\n * To retrieve all bookings use an empty query:\n * ```javascript\n * {\n * \"query\": {}\n * }\n * ```\n *\n * The query runs with the following defaults:\n * + skip(0)\n * + limit(50)\n * + descending(\"_createdDate\")\n *\n *\n * >**Notes:**\n * > + Use UTC when specifying filters with dates.\n * > + The following objects in the `query` parameter are not supported for this query:\n * > - `fields`\n * > - `fieldsets`\n * > - Only 1 use at a time of each filter once in the same query is supported. If a filter is defined more than once in a query, only the first occurrence is taken.\n * > - To get the available actions for a member for each booking, based on the business bookings policy, use the `withBookingAllowedActions` field.\n * > - When using the queryBookings() function immediately following a change to your bookings, the data retrieved may not contain your most recent changes. See [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency) for more information.\n * > - The `businessLocation.businessSchedule` object in the `bookedEntity.location` object is not supported.\n *\n *\n * > **Permissions**\n * > This endpoint requires the Read Bookings - Including Participants permission scope.\n * @internal\n * @documentationMaturity preview\n * @requiredField query\n * @permissionId BOOKINGS.BOOKING_READ\n */\n function query(query: QueryV2, options?: QueryOptions): Promise;\n interface QueryOptions {\n /**\n * Whether the authorization constraint should be handled on Bookings-Service. To be removed when rollout of SCHED-SCHED-25500 is finished.\n * @internal\n */\n shouldNotHandleAuthorizationConstraints?: boolean;\n /**\n * Whether information about the total entities is returned.\n * @internal\n */\n withPagingMetadataTotal?: boolean;\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 * @permissionId BOOKINGS.BOOKING_CONFIRM\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$1;\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$1;\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 /**\n * private API, similarly to Query, with consistent DB connection\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function consistentQuery(options?: ConsistentQueryOptions): Promise;\n interface ConsistentQueryOptions {\n query?: QueryV2;\n }\n /**\n * Private API, dedicated for setting booking sessionId after the session was created for the booking.\n * @param _id - ID of the booking to set its sessionId.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function setBookingSessionId(_id: string, options?: SetBookingSessionIdOptions): Promise;\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 * @permissionId BOOKINGS.BOOKING_UPDATE_EXTENDED_FIELDS\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 * @permissionId BOOKINGS.BOOKING_DECLINE\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$1;\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$1;\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 * declining flow are changed. For example, whether to issue a refund.\n */\n flowControlSettings?: DeclineBookingFlowControlSettings;\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 * @permissionId BOOKINGS.BOOKING_CANCEL\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$1;\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 * @permissionId BOOKINGS.NUMBER_OF_PARTICIPANTS_UPDATE\n * @adminMethod\n */\n function updateNumberOfParticipants(bookingId: string, options?: UpdateNumberOfParticipantsOptions): Promise;\n interface UpdateNumberOfParticipantsOptions extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {\n /**\n * Updated number of participants.\n * @internal\n * @deprecated\n */\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 * 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$1;\n }\n /**\n * Calculates the allowed actions for a given list of booking id's\n * @param bookingIds - The booking id's that we want to calculate the allowedActions for\n * @internal\n * @documentationMaturity preview\n * @requiredField bookingIds\n * @permissionId BOOKINGS.BULK_CALCULATE_ALLOWED_ACTIONS\n */\n function bulkCalculateAllowedActions(bookingIds: string[] | null): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getSlotAvailability(options?: GetSlotAvailabilityOptions): Promise;\n interface GetSlotAvailabilityOptions {\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 * Return the IDs of bookings that are currently allowed to book the given slot due to being a part of a waitlist in a \"suggested\" status.\n * @internal\n */\n returnAllowedBookingIds?: boolean;\n /**\n * Check if this booking is allowed to book the given slot due to being a part of a waitlist in a \"suggested\" status.\n * If passed and the slot is locked for a booking other than this one, `bookable = false` is returned.\n * @internal\n */\n bookingId?: string | null;\n /**\n * Whether availability should be queried to availability calendar or availability service\n * @internal\n */\n shouldUseV2Availability?: boolean;\n /**\n * TODO: remove after qa and add a dedicated EP for calculating all available non double booked resources instead.\n * Whether to skip optimizations during the calculation for overlapping bookings, in order to get the full list of possible\n * non double booked resources.\n * @internal\n */\n returnAllAvailableResources?: boolean;\n /**\n * Whether availability should be queried to availability calendar or availability service\n * @internal\n */\n v2Availability?: boolean | null;\n }\n /**\n * Returns availability for a given schedule ID\n * The availability for a course is calculated by:\n * - Checking for total spots by the schedule's capacity\n * - Checking for open spots by subtracting the current number of participants from the total spots\n * @param scheduleId - The schedule ID for which availability is checked.\n * @internal\n * @documentationMaturity preview\n * @requiredField scheduleId\n * @adminMethod\n */\n function getScheduleAvailability(scheduleId: string): Promise;\n /** @param bookingId - ID of the booking to mark as PENDING.\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 * @internal\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField revision\n * @permissionId BOOKINGS.BOOKING_MARK_BOOKING_AS_PENDING\n * @adminMethod\n */\n function markBookingAsPending(bookingId: string, revision: string | null, options?: MarkBookingAsPendingOptions): Promise;\n interface MarkBookingAsPendingOptions {\n /**\n * Information about whether to notify the customer and\n * the message to send.\n */\n participantNotification?: ParticipantNotification$1;\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$1;\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 * @permissionId BOOKINGS.BOOKING_CONFIRM_OR_DECLINE\n * @adminMethod\n */\n function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise;\n interface ConfirmOrDeclineBookingOptions {\n /**\n * Current payment status of the booking when using a custom checkout page and\n * not the [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).\n *\n * The booking is declined if there is a double booking conflict and you provide\n * one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.\n */\n paymentStatus?: PaymentStatus$1;\n /**\n * When true – decline the booking if double booked.\n * @internal\n */\n declineDoubleBooking?: boolean | null;\n }\n /**\n * Confirms or declines multiple bookings.\n *\n *\n * See [Confirm Or Decline Booking](/bookings-v2/bookings-v2-and-confirmation/bookings-confirm-or-decline-booking)\n * for details about when a booking is confirmed or declined.\n * @param details - The bookings to confirm or decline.\n * @internal\n * @documentationMaturity preview\n * @requiredField details\n * @requiredField details.bookingId\n * @permissionId BOOKINGS.BOOKING_CONFIRM_OR_DECLINE\n * @adminMethod\n */\n function bulkConfirmOrDeclineBooking(details: BulkConfirmOrDeclineBookingRequestBookingDetails[], options?: BulkConfirmOrDeclineBookingOptions): Promise;\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 /**\n * Creates a booking.\n *\n *\n * To create a booking for an appointment or a session of a class, pass the\n * relevant `slot` in the body of the request. You can use the\n * [Get Slot Availability](https://bo.wix.com/wix-docs/rest/bookings/availabilitycalendar---wip/get-slot-availability)\n * endpoint to check the availability of the session beforehand.\n *\n * To create a booking for the entire course, pass the relevant `schedule` in\n * the body of the request. You can use the\n * [Get Schedule Availability](https://bo.wix.com/wix-docs/rest/bookings/availabilitycalendar---wip/get-schedule-availability)\n * endpoint to check the availability of the course beforehand.\n *\n * Bookings are created with a status of `CREATED`. `CREATED` bookings don't\n * appear on the business calendar and don't affect a related schedule's\n * availability.\n *\n * If you create a booking for an existing session, we recommend that you\n * only pass `slot.sessionId`. Then, any specified slot details are\n * calculated.\n *\n * If you create a booking for a new session, we recommend to call\n * [Get Slot Availability](https://bo.wix.com/wix-docs/rest/bookings/availabilitycalendar---wip/get-slot-availability)\n * first. Then, pass the retrieved `availability.slot` object in the body of\n * the Create Booking request.\n *\n * If you create a booking for a course, we recommend that you pass only\n * `schedule.scheduleId` and not the entire `schedule` object. Then, all\n * schedule details are automatically calculated.\n *\n * When creating a booking you must pass either `participantsChoices` or\n * `totalParticipants`. If you pass `participantsChoices`, all of the\n * provided choices must exist for the service. Otherwise the call returns an\n * `INVALID_SERVICE_CHOICES` error.\n *\n * When creating a booking, you can pass a `selectedPaymentOption`. This specifies\n * which payment method the customer intends to use. But it's possible for\n * them to later use another supported payment method.\n *\n * After you have created the booking, you can use the\n * [Wix eCommerce APIs](https://bo.wix.com/wix-docs/rest/ecommerce/checkout/introduction)\n * for the [checkout](https://bo.wix.com/wix-docs/rest/ecommerce/checkout/create-checkout)\n * and [order](https://bo.wix.com/wix-docs/rest/ecommerce/checkout/create-order-from-checkout)\n * steps of the payment flow.\n * @internal\n * @documentationMaturity preview\n * @permissionId BOOKINGS.BOOKING_CREATE\n * @deprecated\n */\n function bookingsGatewayCreateBooking(options?: BookingsGatewayCreateBookingOptions): Promise;\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;\n /** Information about the schedule to create a booking for. */\n schedule?: BookedSchedule$1;\n /** Contact details of the customer booking the service. */\n contactDetails?: ContactDetails$1;\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$1;\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$1[];\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$1;\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$1;\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$1;\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 * Total number of participants.\n * Provide when the service doesn't have\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Provide for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: 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 * remain 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 * @internal\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField options.revision\n * @permissionId BOOKINGS.BOOKING_CANCEL\n * @deprecated\n */\n function bookingsGatewayCancelBooking(bookingId: string, options?: BookingsGatewayCancelBookingOptions): Promise;\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$1;\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 * @internal\n */\n flowControlSettings?: V2CancelBookingRequestFlowControlSettings;\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 * 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](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction),\n * you can call this endpoint to update the booking's `totalParticipants` or `participantsChoices`. If you\n * 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 * @internal\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField options.revision\n * @requiredField slot\n * @permissionId BOOKINGS.BOOKING_RESCHEDULE\n * @deprecated\n */\n function bookingsGatewayRescheduleBooking(bookingId: string, slot: Slot, options?: BookingsGatewayRescheduleBookingOptions): Promise;\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$1;\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 * @internal\n */\n flowControlSettings?: V2RescheduleBookingRequestFlowControlSettings;\n /**\n * Total number of participants. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when all participants book the same variant.\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when not all participants book the same variant.\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n }\n /**\n * Confirms a booking request and changes the booking status to `CONFIRMED`.\n *\n *\n * Calling this endpoint 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`. You can read more about\n * [creating a service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service).\n *\n * For appointment services the slot may become unavailable, depending on the\n * [service's](https://dev.wix.com/api/rest/wix-bookings/services/service/service-object)\n * `policy.bookingApprovalPolicy.requestsAffectsAvailability`.\n *\n * Calling this endpoint also changes the\n * [session's](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)\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](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service)\n * bookings and the [eCommerce order](https://bo.wix.com/wix-docs/rest/ecommerce/checkout/create-order-from-checkout)\n * has been approved. The slot's or schedule's availabity 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 * @internal\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField revision\n * @permissionId BOOKINGS.BOOKING_CONFIRM\n * @adminMethod\n * @deprecated\n */\n function bookingsGatewayConfirmBooking(bookingId: string, revision: string | null, options?: BookingsGatewayConfirmBookingOptions): Promise;\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$1;\n }\n /**\n * Declines a `PENDING` booking request and changes the booking status to\n * `DECLINED`.\n *\n * Calling this endpoint also changes the\n * [session's](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)\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`. You can read more about\n * [creating a service](https://dev.wix.com/api/rest/wix-bookings/services/service/create-service).\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 * @internal\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField revision\n * @permissionId BOOKINGS.BOOKING_DECLINE\n * @adminMethod\n * @deprecated\n */\n function bookingsGatewayDeclineBooking(bookingId: string, revision: string | null, options?: BookingsGatewayDeclineBookingOptions): Promise;\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$1;\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 endpoint also changes the\n * [session's](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)\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\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction),\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 * @internal\n * @documentationMaturity preview\n * @requiredField bookingId\n * @requiredField options.revision\n * @permissionId BOOKINGS.NUMBER_OF_PARTICIPANTS_UPDATE\n * @adminMethod\n * @deprecated\n */\n function bookingsGatewayUpdateNumberOfParticipants(bookingId: string, options?: BookingsGatewayUpdateNumberOfParticipantsOptions): Promise;\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 * Total number of participants. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when all participants book the same variant.\n * @internal\n */\n totalParticipants?: number;\n /**\n * Information about the service choices to book. Available only for services with\n * [variants](https://dev.wix.com/api/rest/wix-bookings/service-options-and-variants/introduction).\n * Pass when not all participants book the same variant.\n * @internal\n */\n participantsChoices?: ParticipantChoices$1;\n }\n \n type bookingsV2Booking_universal_d_CommonIdentificationData = CommonIdentificationData;\n type bookingsV2Booking_universal_d_CommonIdentificationDataIdOneOf = CommonIdentificationDataIdOneOf;\n type bookingsV2Booking_universal_d_IdentificationDataIdentityType = IdentificationDataIdentityType;\n const bookingsV2Booking_universal_d_IdentificationDataIdentityType: typeof IdentificationDataIdentityType;\n type bookingsV2Booking_universal_d_CreateMultiServiceBookingRequest = CreateMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_CreateBookingFlowControlSettings = CreateBookingFlowControlSettings;\n type bookingsV2Booking_universal_d_CreateMultiServiceBookingResponse = CreateMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_MultiServiceBooking = MultiServiceBooking;\n type bookingsV2Booking_universal_d_BookingResult = BookingResult;\n type bookingsV2Booking_universal_d_RescheduleMultiServiceBookingRequest = RescheduleMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_V2Slot = V2Slot;\n type bookingsV2Booking_universal_d_LocationLocationType = LocationLocationType;\n const bookingsV2Booking_universal_d_LocationLocationType: typeof LocationLocationType;\n type bookingsV2Booking_universal_d_SlotSlotResource = SlotSlotResource;\n type bookingsV2Booking_universal_d_SlotLocation = SlotLocation;\n type bookingsV2Booking_universal_d_RescheduleMultiServiceBookingRequestRescheduleBookingInfo = RescheduleMultiServiceBookingRequestRescheduleBookingInfo;\n type bookingsV2Booking_universal_d_RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf = RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_RescheduleBookingFlowControlSettings = RescheduleBookingFlowControlSettings;\n type bookingsV2Booking_universal_d_RescheduleMultiServiceBookingResponse = RescheduleMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_BookingRescheduled = BookingRescheduled;\n type bookingsV2Booking_universal_d_BookingRescheduledPreviousParticipantsInfoOneOf = BookingRescheduledPreviousParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_GetMultiServiceBookingAvailabilityRequest = GetMultiServiceBookingAvailabilityRequest;\n type bookingsV2Booking_universal_d_GetMultiServiceBookingAvailabilityResponse = GetMultiServiceBookingAvailabilityResponse;\n type bookingsV2Booking_universal_d_BookingPolicyViolations = BookingPolicyViolations;\n type bookingsV2Booking_universal_d_BookingPolicySettings = BookingPolicySettings;\n type bookingsV2Booking_universal_d_GetMultiServiceBookingAvailabilityResponseBookingInfo = GetMultiServiceBookingAvailabilityResponseBookingInfo;\n type bookingsV2Booking_universal_d_CancelMultiServiceBookingRequest = CancelMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_CancelBookingFlowControlSettings = CancelBookingFlowControlSettings;\n type bookingsV2Booking_universal_d_CancelMultiServiceBookingResponse = CancelMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_BookingCanceled = BookingCanceled;\n type bookingsV2Booking_universal_d_MarkMultiServiceBookingAsPendingRequest = MarkMultiServiceBookingAsPendingRequest;\n type bookingsV2Booking_universal_d_BookingInfo = BookingInfo;\n type bookingsV2Booking_universal_d_MarkBookingAsPendingFlowControlSettings = MarkBookingAsPendingFlowControlSettings;\n type bookingsV2Booking_universal_d_MarkMultiServiceBookingAsPendingResponse = MarkMultiServiceBookingAsPendingResponse;\n type bookingsV2Booking_universal_d_ConfirmMultiServiceBookingRequest = ConfirmMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_ConfirmBookingFlowControlSettings = ConfirmBookingFlowControlSettings;\n type bookingsV2Booking_universal_d_ConfirmMultiServiceBookingResponse = ConfirmMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_BookingConfirmed = BookingConfirmed;\n type bookingsV2Booking_universal_d_DeclineMultiServiceBookingRequest = DeclineMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_DeclineBookingFlowControlSettings = DeclineBookingFlowControlSettings;\n type bookingsV2Booking_universal_d_DeclineMultiServiceBookingResponse = DeclineMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_BookingDeclined = BookingDeclined;\n type bookingsV2Booking_universal_d_BulkGetMultiServiceBookingAllowedActionsRequest = BulkGetMultiServiceBookingAllowedActionsRequest;\n type bookingsV2Booking_universal_d_BulkGetMultiServiceBookingAllowedActionsResponse = BulkGetMultiServiceBookingAllowedActionsResponse;\n type bookingsV2Booking_universal_d_BulkCalculateAllowedActionsResult = BulkCalculateAllowedActionsResult;\n type bookingsV2Booking_universal_d_ItemMetadata = ItemMetadata;\n type bookingsV2Booking_universal_d_ApplicationError = ApplicationError;\n type bookingsV2Booking_universal_d_AllowedActions = AllowedActions;\n type bookingsV2Booking_universal_d_BulkActionMetadata = BulkActionMetadata;\n type bookingsV2Booking_universal_d_MarkAsMultiServiceBookingRequest = MarkAsMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_MarkAsMultiServiceBookingResponse = MarkAsMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_GetMultiServiceBookingRequest = GetMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_GetMultiServiceBookingResponse = GetMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_MultiServiceBookingMetadata = MultiServiceBookingMetadata;\n type bookingsV2Booking_universal_d_AddBookingsToMultiServiceBookingRequest = AddBookingsToMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_BookingIdAndRevision = BookingIdAndRevision;\n type bookingsV2Booking_universal_d_AddBookingsToMultiServiceBookingResponse = AddBookingsToMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_RemoveBookingsFromMultiServiceBookingRequest = RemoveBookingsFromMultiServiceBookingRequest;\n type bookingsV2Booking_universal_d_RemoveBookingsFromMultiServiceBookingResponse = RemoveBookingsFromMultiServiceBookingResponse;\n type bookingsV2Booking_universal_d_DomainEvent = DomainEvent;\n type bookingsV2Booking_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type bookingsV2Booking_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type bookingsV2Booking_universal_d_RestoreInfo = RestoreInfo;\n type bookingsV2Booking_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type bookingsV2Booking_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type bookingsV2Booking_universal_d_ActionEvent = ActionEvent;\n type bookingsV2Booking_universal_d_MessageEnvelope = MessageEnvelope;\n type bookingsV2Booking_universal_d_WebhooksIdentificationData = WebhooksIdentificationData;\n type bookingsV2Booking_universal_d_WebhooksIdentificationDataIdOneOf = WebhooksIdentificationDataIdOneOf;\n type bookingsV2Booking_universal_d_WebhookIdentityType = WebhookIdentityType;\n const bookingsV2Booking_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type bookingsV2Booking_universal_d_BookingChanged = BookingChanged;\n type bookingsV2Booking_universal_d_CreateBookingRequest = CreateBookingRequest;\n type bookingsV2Booking_universal_d_CreateBookingResponse = CreateBookingResponse;\n type bookingsV2Booking_universal_d_UpdateBookingRequest = UpdateBookingRequest;\n type bookingsV2Booking_universal_d_UpdateBookingResponse = UpdateBookingResponse;\n type bookingsV2Booking_universal_d_LegacyCreateBookingRequest = LegacyCreateBookingRequest;\n type bookingsV2Booking_universal_d_LegacyCreateBookingResponse = LegacyCreateBookingResponse;\n type bookingsV2Booking_universal_d_BulkUpdateBookingRequest = BulkUpdateBookingRequest;\n type bookingsV2Booking_universal_d_MaskedBooking = MaskedBooking;\n type bookingsV2Booking_universal_d_BulkUpdateBookingResponse = BulkUpdateBookingResponse;\n type bookingsV2Booking_universal_d_BulkCreateBookingRequest = BulkCreateBookingRequest;\n type bookingsV2Booking_universal_d_CreateBookingInfo = CreateBookingInfo;\n type bookingsV2Booking_universal_d_BulkCreateBookingResponse = BulkCreateBookingResponse;\n type bookingsV2Booking_universal_d_BulkBookingResult = BulkBookingResult;\n type bookingsV2Booking_universal_d_RescheduleBookingRequest = RescheduleBookingRequest;\n type bookingsV2Booking_universal_d_RescheduleBookingRequestParticipantsInfoOneOf = RescheduleBookingRequestParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_RescheduleBookingResponse = RescheduleBookingResponse;\n type bookingsV2Booking_universal_d_BulkRescheduleBookingRequest = BulkRescheduleBookingRequest;\n type bookingsV2Booking_universal_d_BulkRescheduleBookingRequestBooking = BulkRescheduleBookingRequestBooking;\n type bookingsV2Booking_universal_d_SlotBookings = SlotBookings;\n type bookingsV2Booking_universal_d_BulkRescheduleBookingResponse = BulkRescheduleBookingResponse;\n type bookingsV2Booking_universal_d_BulkUpdateBookedScheduleRequest = BulkUpdateBookedScheduleRequest;\n type bookingsV2Booking_universal_d_BookingDetails = BookingDetails;\n type bookingsV2Booking_universal_d_BulkUpdateBookedScheduleResponse = BulkUpdateBookedScheduleResponse;\n type bookingsV2Booking_universal_d_QueryBookingsRequest = QueryBookingsRequest;\n type bookingsV2Booking_universal_d_QueryV2 = QueryV2;\n type bookingsV2Booking_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type bookingsV2Booking_universal_d_Sorting = Sorting;\n type bookingsV2Booking_universal_d_SortOrder = SortOrder;\n const bookingsV2Booking_universal_d_SortOrder: typeof SortOrder;\n type bookingsV2Booking_universal_d_Paging = Paging;\n type bookingsV2Booking_universal_d_CursorPaging = CursorPaging;\n type bookingsV2Booking_universal_d_QueryBookingsResponse = QueryBookingsResponse;\n type bookingsV2Booking_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type bookingsV2Booking_universal_d_Cursors = Cursors;\n type bookingsV2Booking_universal_d_ConfirmRequest = ConfirmRequest;\n type bookingsV2Booking_universal_d_ConfirmResponse = ConfirmResponse;\n type bookingsV2Booking_universal_d_ConfirmBookingRequest = ConfirmBookingRequest;\n type bookingsV2Booking_universal_d_ConfirmBookingResponse = ConfirmBookingResponse;\n type bookingsV2Booking_universal_d_PartySizeRequest = PartySizeRequest;\n type bookingsV2Booking_universal_d_PartySizeRequestPartySizeForOneOf = PartySizeRequestPartySizeForOneOf;\n type bookingsV2Booking_universal_d_PartySizeResponse = PartySizeResponse;\n type bookingsV2Booking_universal_d_ConsistentQueryBookingsRequest = ConsistentQueryBookingsRequest;\n type bookingsV2Booking_universal_d_ConsistentQueryBookingsResponse = ConsistentQueryBookingsResponse;\n type bookingsV2Booking_universal_d_SetBookingSessionIdRequest = SetBookingSessionIdRequest;\n type bookingsV2Booking_universal_d_SetBookingSessionIdResponse = SetBookingSessionIdResponse;\n type bookingsV2Booking_universal_d_UpdateExtendedFieldsRequest = UpdateExtendedFieldsRequest;\n type bookingsV2Booking_universal_d_UpdateExtendedFieldsResponse = UpdateExtendedFieldsResponse;\n type bookingsV2Booking_universal_d_DeclineBookingRequest = DeclineBookingRequest;\n type bookingsV2Booking_universal_d_DeclineBookingResponse = DeclineBookingResponse;\n type bookingsV2Booking_universal_d_CancelBookingRequest = CancelBookingRequest;\n type bookingsV2Booking_universal_d_CancelBookingResponse = CancelBookingResponse;\n type bookingsV2Booking_universal_d_UpdateNumberOfParticipantsRequest = UpdateNumberOfParticipantsRequest;\n type bookingsV2Booking_universal_d_UpdateNumberOfParticipantsRequestParticipantsInfoOneOf = UpdateNumberOfParticipantsRequestParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_UpdateNumberOfParticipantsResponse = UpdateNumberOfParticipantsResponse;\n type bookingsV2Booking_universal_d_NumberOfParticipantsUpdated = NumberOfParticipantsUpdated;\n type bookingsV2Booking_universal_d_NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf = NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_CalculateAllowedActionsRequest = CalculateAllowedActionsRequest;\n type bookingsV2Booking_universal_d_CalculateAllowedActionsResponse = CalculateAllowedActionsResponse;\n type bookingsV2Booking_universal_d_BulkCalculateAllowedActionsRequest = BulkCalculateAllowedActionsRequest;\n type bookingsV2Booking_universal_d_BulkCalculateAllowedActionsResponse = BulkCalculateAllowedActionsResponse;\n type bookingsV2Booking_universal_d_GetSlotAvailabilityRequest = GetSlotAvailabilityRequest;\n type bookingsV2Booking_universal_d_GetSlotAvailabilityResponse = GetSlotAvailabilityResponse;\n type bookingsV2Booking_universal_d_SlotAvailability = SlotAvailability;\n type bookingsV2Booking_universal_d_WaitingList = WaitingList;\n type bookingsV2Booking_universal_d_AvailableResources = AvailableResources;\n type bookingsV2Booking_universal_d_GetScheduleAvailabilityRequest = GetScheduleAvailabilityRequest;\n type bookingsV2Booking_universal_d_GetScheduleAvailabilityResponse = GetScheduleAvailabilityResponse;\n type bookingsV2Booking_universal_d_ScheduleAvailability = ScheduleAvailability;\n type bookingsV2Booking_universal_d_MarkBookingAsPendingRequest = MarkBookingAsPendingRequest;\n type bookingsV2Booking_universal_d_MarkBookingAsPendingResponse = MarkBookingAsPendingResponse;\n type bookingsV2Booking_universal_d_BookingMarkedAsPending = BookingMarkedAsPending;\n type bookingsV2Booking_universal_d_MigrationCheckIfClashesWithBlockedTimeRequest = MigrationCheckIfClashesWithBlockedTimeRequest;\n type bookingsV2Booking_universal_d_MsidAndBookingId = MsidAndBookingId;\n type bookingsV2Booking_universal_d_MigrationCheckIfClashesWithBlockedTimeResponse = MigrationCheckIfClashesWithBlockedTimeResponse;\n type bookingsV2Booking_universal_d_Clash = Clash;\n type bookingsV2Booking_universal_d_ConfirmOrDeclineBookingRequest = ConfirmOrDeclineBookingRequest;\n type bookingsV2Booking_universal_d_ConfirmOrDeclineBookingResponse = ConfirmOrDeclineBookingResponse;\n type bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingRequest = BulkConfirmOrDeclineBookingRequest;\n type bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingRequestBookingDetails = BulkConfirmOrDeclineBookingRequestBookingDetails;\n type bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingResponse = BulkConfirmOrDeclineBookingResponse;\n type bookingsV2Booking_universal_d_V2CreateBookingRequest = V2CreateBookingRequest;\n type bookingsV2Booking_universal_d_V2CreateBookingRequestBookableItemOneOf = V2CreateBookingRequestBookableItemOneOf;\n type bookingsV2Booking_universal_d_V2CreateBookingRequestParticipantsInfoOneOf = V2CreateBookingRequestParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_Slot = Slot;\n type bookingsV2Booking_universal_d_SlotResource = SlotResource;\n type bookingsV2Booking_universal_d_CreateBookingRequestFlowControlSettings = CreateBookingRequestFlowControlSettings;\n type bookingsV2Booking_universal_d_V2CreateBookingResponse = V2CreateBookingResponse;\n type bookingsV2Booking_universal_d_V2CancelBookingRequest = V2CancelBookingRequest;\n type bookingsV2Booking_universal_d_V2CancelBookingRequestFlowControlSettings = V2CancelBookingRequestFlowControlSettings;\n type bookingsV2Booking_universal_d_V2CancelBookingResponse = V2CancelBookingResponse;\n type bookingsV2Booking_universal_d_V2RescheduleBookingRequest = V2RescheduleBookingRequest;\n type bookingsV2Booking_universal_d_V2RescheduleBookingRequestParticipantsInfoOneOf = V2RescheduleBookingRequestParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_V2RescheduleBookingRequestFlowControlSettings = V2RescheduleBookingRequestFlowControlSettings;\n type bookingsV2Booking_universal_d_V2RescheduleBookingResponse = V2RescheduleBookingResponse;\n type bookingsV2Booking_universal_d_V2ConfirmBookingRequest = V2ConfirmBookingRequest;\n type bookingsV2Booking_universal_d_V2ConfirmBookingResponse = V2ConfirmBookingResponse;\n type bookingsV2Booking_universal_d_V2DeclineBookingRequest = V2DeclineBookingRequest;\n type bookingsV2Booking_universal_d_V2DeclineBookingResponse = V2DeclineBookingResponse;\n type bookingsV2Booking_universal_d_V2UpdateNumberOfParticipantsRequest = V2UpdateNumberOfParticipantsRequest;\n type bookingsV2Booking_universal_d_V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf = V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf;\n type bookingsV2Booking_universal_d_V2UpdateNumberOfParticipantsResponse = V2UpdateNumberOfParticipantsResponse;\n const bookingsV2Booking_universal_d_createMultiServiceBooking: typeof createMultiServiceBooking;\n type bookingsV2Booking_universal_d_CreateMultiServiceBookingOptions = CreateMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_rescheduleMultiServiceBooking: typeof rescheduleMultiServiceBooking;\n type bookingsV2Booking_universal_d_RescheduleMultiServiceBookingOptions = RescheduleMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_getMultiServiceBookingAvailability: typeof getMultiServiceBookingAvailability;\n const bookingsV2Booking_universal_d_cancelMultiServiceBooking: typeof cancelMultiServiceBooking;\n type bookingsV2Booking_universal_d_CancelMultiServiceBookingOptions = CancelMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_markMultiServiceBookingAsPending: typeof markMultiServiceBookingAsPending;\n type bookingsV2Booking_universal_d_MarkMultiServiceBookingAsPendingOptions = MarkMultiServiceBookingAsPendingOptions;\n const bookingsV2Booking_universal_d_confirmMultiServiceBooking: typeof confirmMultiServiceBooking;\n type bookingsV2Booking_universal_d_ConfirmMultiServiceBookingOptions = ConfirmMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_declineMultiServiceBooking: typeof declineMultiServiceBooking;\n type bookingsV2Booking_universal_d_DeclineMultiServiceBookingOptions = DeclineMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_bulkGetMultiServiceBookingAllowedActions: typeof bulkGetMultiServiceBookingAllowedActions;\n type bookingsV2Booking_universal_d_MarkAsMultiServiceBookingOptions = MarkAsMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_getMultiServiceBooking: typeof getMultiServiceBooking;\n const bookingsV2Booking_universal_d_addBookingsToMultiServiceBooking: typeof addBookingsToMultiServiceBooking;\n type bookingsV2Booking_universal_d_AddBookingsToMultiServiceBookingOptions = AddBookingsToMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_removeBookingsFromMultiServiceBooking: typeof removeBookingsFromMultiServiceBooking;\n type bookingsV2Booking_universal_d_RemoveBookingsFromMultiServiceBookingOptions = RemoveBookingsFromMultiServiceBookingOptions;\n const bookingsV2Booking_universal_d_createBooking: typeof createBooking;\n type bookingsV2Booking_universal_d_CreateBookingOptions = CreateBookingOptions;\n const bookingsV2Booking_universal_d_updateBooking: typeof updateBooking;\n type bookingsV2Booking_universal_d_UpdateBooking = UpdateBooking;\n type bookingsV2Booking_universal_d_UpdateBookingOptions = UpdateBookingOptions;\n const bookingsV2Booking_universal_d_legacyCreateBooking: typeof legacyCreateBooking;\n const bookingsV2Booking_universal_d_bulkUpdateBooking: typeof bulkUpdateBooking;\n const bookingsV2Booking_universal_d_bulkCreateBooking: typeof bulkCreateBooking;\n type bookingsV2Booking_universal_d_BulkCreateBookingOptions = BulkCreateBookingOptions;\n const bookingsV2Booking_universal_d_rescheduleBooking: typeof rescheduleBooking;\n type bookingsV2Booking_universal_d_RescheduleBookingOptions = RescheduleBookingOptions;\n const bookingsV2Booking_universal_d_bulkRescheduleBooking: typeof bulkRescheduleBooking;\n type bookingsV2Booking_universal_d_BulkRescheduleBookingOptions = BulkRescheduleBookingOptions;\n const bookingsV2Booking_universal_d_bulkUpdateBookedSchedule: typeof bulkUpdateBookedSchedule;\n type bookingsV2Booking_universal_d_BulkUpdateBookedScheduleOptions = BulkUpdateBookedScheduleOptions;\n const bookingsV2Booking_universal_d_query: typeof query;\n type bookingsV2Booking_universal_d_QueryOptions = QueryOptions;\n const bookingsV2Booking_universal_d_confirmBooking: typeof confirmBooking;\n type bookingsV2Booking_universal_d_ConfirmBookingOptions = ConfirmBookingOptions;\n type bookingsV2Booking_universal_d_PartySizeOptions = PartySizeOptions;\n const bookingsV2Booking_universal_d_consistentQuery: typeof consistentQuery;\n type bookingsV2Booking_universal_d_ConsistentQueryOptions = ConsistentQueryOptions;\n const bookingsV2Booking_universal_d_setBookingSessionId: typeof setBookingSessionId;\n type bookingsV2Booking_universal_d_SetBookingSessionIdOptions = SetBookingSessionIdOptions;\n const bookingsV2Booking_universal_d_updateExtendedFields: typeof updateExtendedFields;\n type bookingsV2Booking_universal_d_UpdateExtendedFieldsOptions = UpdateExtendedFieldsOptions;\n const bookingsV2Booking_universal_d_declineBooking: typeof declineBooking;\n type bookingsV2Booking_universal_d_DeclineBookingOptions = DeclineBookingOptions;\n const bookingsV2Booking_universal_d_cancelBooking: typeof cancelBooking;\n type bookingsV2Booking_universal_d_CancelBookingOptions = CancelBookingOptions;\n const bookingsV2Booking_universal_d_updateNumberOfParticipants: typeof updateNumberOfParticipants;\n type bookingsV2Booking_universal_d_UpdateNumberOfParticipantsOptions = UpdateNumberOfParticipantsOptions;\n const bookingsV2Booking_universal_d_bulkCalculateAllowedActions: typeof bulkCalculateAllowedActions;\n const bookingsV2Booking_universal_d_getSlotAvailability: typeof getSlotAvailability;\n type bookingsV2Booking_universal_d_GetSlotAvailabilityOptions = GetSlotAvailabilityOptions;\n const bookingsV2Booking_universal_d_getScheduleAvailability: typeof getScheduleAvailability;\n const bookingsV2Booking_universal_d_markBookingAsPending: typeof markBookingAsPending;\n type bookingsV2Booking_universal_d_MarkBookingAsPendingOptions = MarkBookingAsPendingOptions;\n const bookingsV2Booking_universal_d_confirmOrDeclineBooking: typeof confirmOrDeclineBooking;\n type bookingsV2Booking_universal_d_ConfirmOrDeclineBookingOptions = ConfirmOrDeclineBookingOptions;\n const bookingsV2Booking_universal_d_bulkConfirmOrDeclineBooking: typeof bulkConfirmOrDeclineBooking;\n type bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingOptions = BulkConfirmOrDeclineBookingOptions;\n const bookingsV2Booking_universal_d_bookingsGatewayCreateBooking: typeof bookingsGatewayCreateBooking;\n type bookingsV2Booking_universal_d_BookingsGatewayCreateBookingOptions = BookingsGatewayCreateBookingOptions;\n const bookingsV2Booking_universal_d_bookingsGatewayCancelBooking: typeof bookingsGatewayCancelBooking;\n type bookingsV2Booking_universal_d_BookingsGatewayCancelBookingOptions = BookingsGatewayCancelBookingOptions;\n const bookingsV2Booking_universal_d_bookingsGatewayRescheduleBooking: typeof bookingsGatewayRescheduleBooking;\n type bookingsV2Booking_universal_d_BookingsGatewayRescheduleBookingOptions = BookingsGatewayRescheduleBookingOptions;\n const bookingsV2Booking_universal_d_bookingsGatewayConfirmBooking: typeof bookingsGatewayConfirmBooking;\n type bookingsV2Booking_universal_d_BookingsGatewayConfirmBookingOptions = BookingsGatewayConfirmBookingOptions;\n const bookingsV2Booking_universal_d_bookingsGatewayDeclineBooking: typeof bookingsGatewayDeclineBooking;\n type bookingsV2Booking_universal_d_BookingsGatewayDeclineBookingOptions = BookingsGatewayDeclineBookingOptions;\n const bookingsV2Booking_universal_d_bookingsGatewayUpdateNumberOfParticipants: typeof bookingsGatewayUpdateNumberOfParticipants;\n type bookingsV2Booking_universal_d_BookingsGatewayUpdateNumberOfParticipantsOptions = BookingsGatewayUpdateNumberOfParticipantsOptions;\n namespace bookingsV2Booking_universal_d {\n export {\n Booking$1 as Booking,\n BookingParticipantsInfoOneOf$1 as BookingParticipantsInfoOneOf,\n MultiServiceBookingType$1 as MultiServiceBookingType,\n BookedEntity$1 as BookedEntity,\n BookedEntityItemOneOf$1 as BookedEntityItemOneOf,\n BookedSlot$1 as BookedSlot,\n BookedResource$1 as BookedResource,\n Location$1 as Location,\n LocationType$1 as LocationType,\n BookedSchedule$1 as BookedSchedule,\n ContactDetails$1 as ContactDetails,\n Address$1 as Address,\n AddressStreetOneOf$1 as AddressStreetOneOf,\n StreetAddress$1 as StreetAddress,\n AddressLocation$1 as AddressLocation,\n Subdivision$1 as Subdivision,\n CustomFormField$1 as CustomFormField,\n ValueType$1 as ValueType,\n BookingStatus$1 as BookingStatus,\n PaymentStatus$1 as PaymentStatus,\n SelectedPaymentOption$1 as SelectedPaymentOption,\n BookingSource$1 as BookingSource,\n Platform$1 as Platform,\n Actor$1 as Actor,\n ParticipantNotification$1 as ParticipantNotification,\n bookingsV2Booking_universal_d_CommonIdentificationData as CommonIdentificationData,\n bookingsV2Booking_universal_d_CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOf,\n bookingsV2Booking_universal_d_IdentificationDataIdentityType as IdentificationDataIdentityType,\n FlowControlSettings$1 as FlowControlSettings,\n ExtendedFields$1 as ExtendedFields,\n ParticipantChoices$1 as ParticipantChoices,\n ServiceChoices$1 as ServiceChoices,\n ServiceChoice$1 as ServiceChoice,\n ServiceChoiceChoiceOneOf$1 as ServiceChoiceChoiceOneOf,\n MultiServiceBookingInfo$1 as MultiServiceBookingInfo,\n bookingsV2Booking_universal_d_CreateMultiServiceBookingRequest as CreateMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_CreateBookingFlowControlSettings as CreateBookingFlowControlSettings,\n bookingsV2Booking_universal_d_CreateMultiServiceBookingResponse as CreateMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_MultiServiceBooking as MultiServiceBooking,\n bookingsV2Booking_universal_d_BookingResult as BookingResult,\n bookingsV2Booking_universal_d_RescheduleMultiServiceBookingRequest as RescheduleMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_V2Slot as V2Slot,\n bookingsV2Booking_universal_d_LocationLocationType as LocationLocationType,\n bookingsV2Booking_universal_d_SlotSlotResource as SlotSlotResource,\n bookingsV2Booking_universal_d_SlotLocation as SlotLocation,\n bookingsV2Booking_universal_d_RescheduleMultiServiceBookingRequestRescheduleBookingInfo as RescheduleMultiServiceBookingRequestRescheduleBookingInfo,\n bookingsV2Booking_universal_d_RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf as RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_RescheduleBookingFlowControlSettings as RescheduleBookingFlowControlSettings,\n bookingsV2Booking_universal_d_RescheduleMultiServiceBookingResponse as RescheduleMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_BookingRescheduled as BookingRescheduled,\n bookingsV2Booking_universal_d_BookingRescheduledPreviousParticipantsInfoOneOf as BookingRescheduledPreviousParticipantsInfoOneOf,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n IdentityType$1 as IdentityType,\n bookingsV2Booking_universal_d_GetMultiServiceBookingAvailabilityRequest as GetMultiServiceBookingAvailabilityRequest,\n bookingsV2Booking_universal_d_GetMultiServiceBookingAvailabilityResponse as GetMultiServiceBookingAvailabilityResponse,\n bookingsV2Booking_universal_d_BookingPolicyViolations as BookingPolicyViolations,\n bookingsV2Booking_universal_d_BookingPolicySettings as BookingPolicySettings,\n bookingsV2Booking_universal_d_GetMultiServiceBookingAvailabilityResponseBookingInfo as GetMultiServiceBookingAvailabilityResponseBookingInfo,\n bookingsV2Booking_universal_d_CancelMultiServiceBookingRequest as CancelMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_CancelBookingFlowControlSettings as CancelBookingFlowControlSettings,\n bookingsV2Booking_universal_d_CancelMultiServiceBookingResponse as CancelMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_BookingCanceled as BookingCanceled,\n bookingsV2Booking_universal_d_MarkMultiServiceBookingAsPendingRequest as MarkMultiServiceBookingAsPendingRequest,\n bookingsV2Booking_universal_d_BookingInfo as BookingInfo,\n bookingsV2Booking_universal_d_MarkBookingAsPendingFlowControlSettings as MarkBookingAsPendingFlowControlSettings,\n bookingsV2Booking_universal_d_MarkMultiServiceBookingAsPendingResponse as MarkMultiServiceBookingAsPendingResponse,\n bookingsV2Booking_universal_d_ConfirmMultiServiceBookingRequest as ConfirmMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_ConfirmBookingFlowControlSettings as ConfirmBookingFlowControlSettings,\n bookingsV2Booking_universal_d_ConfirmMultiServiceBookingResponse as ConfirmMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_BookingConfirmed as BookingConfirmed,\n bookingsV2Booking_universal_d_DeclineMultiServiceBookingRequest as DeclineMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_DeclineBookingFlowControlSettings as DeclineBookingFlowControlSettings,\n bookingsV2Booking_universal_d_DeclineMultiServiceBookingResponse as DeclineMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_BookingDeclined as BookingDeclined,\n bookingsV2Booking_universal_d_BulkGetMultiServiceBookingAllowedActionsRequest as BulkGetMultiServiceBookingAllowedActionsRequest,\n bookingsV2Booking_universal_d_BulkGetMultiServiceBookingAllowedActionsResponse as BulkGetMultiServiceBookingAllowedActionsResponse,\n bookingsV2Booking_universal_d_BulkCalculateAllowedActionsResult as BulkCalculateAllowedActionsResult,\n bookingsV2Booking_universal_d_ItemMetadata as ItemMetadata,\n bookingsV2Booking_universal_d_ApplicationError as ApplicationError,\n bookingsV2Booking_universal_d_AllowedActions as AllowedActions,\n bookingsV2Booking_universal_d_BulkActionMetadata as BulkActionMetadata,\n bookingsV2Booking_universal_d_MarkAsMultiServiceBookingRequest as MarkAsMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_MarkAsMultiServiceBookingResponse as MarkAsMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_GetMultiServiceBookingRequest as GetMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_GetMultiServiceBookingResponse as GetMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_MultiServiceBookingMetadata as MultiServiceBookingMetadata,\n bookingsV2Booking_universal_d_AddBookingsToMultiServiceBookingRequest as AddBookingsToMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_BookingIdAndRevision as BookingIdAndRevision,\n bookingsV2Booking_universal_d_AddBookingsToMultiServiceBookingResponse as AddBookingsToMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_RemoveBookingsFromMultiServiceBookingRequest as RemoveBookingsFromMultiServiceBookingRequest,\n bookingsV2Booking_universal_d_RemoveBookingsFromMultiServiceBookingResponse as RemoveBookingsFromMultiServiceBookingResponse,\n bookingsV2Booking_universal_d_DomainEvent as DomainEvent,\n bookingsV2Booking_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n bookingsV2Booking_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n bookingsV2Booking_universal_d_RestoreInfo as RestoreInfo,\n bookingsV2Booking_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n bookingsV2Booking_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n bookingsV2Booking_universal_d_ActionEvent as ActionEvent,\n bookingsV2Booking_universal_d_MessageEnvelope as MessageEnvelope,\n bookingsV2Booking_universal_d_WebhooksIdentificationData as WebhooksIdentificationData,\n bookingsV2Booking_universal_d_WebhooksIdentificationDataIdOneOf as WebhooksIdentificationDataIdOneOf,\n bookingsV2Booking_universal_d_WebhookIdentityType as WebhookIdentityType,\n bookingsV2Booking_universal_d_BookingChanged as BookingChanged,\n bookingsV2Booking_universal_d_CreateBookingRequest as CreateBookingRequest,\n bookingsV2Booking_universal_d_CreateBookingResponse as CreateBookingResponse,\n bookingsV2Booking_universal_d_UpdateBookingRequest as UpdateBookingRequest,\n bookingsV2Booking_universal_d_UpdateBookingResponse as UpdateBookingResponse,\n bookingsV2Booking_universal_d_LegacyCreateBookingRequest as LegacyCreateBookingRequest,\n bookingsV2Booking_universal_d_LegacyCreateBookingResponse as LegacyCreateBookingResponse,\n bookingsV2Booking_universal_d_BulkUpdateBookingRequest as BulkUpdateBookingRequest,\n bookingsV2Booking_universal_d_MaskedBooking as MaskedBooking,\n bookingsV2Booking_universal_d_BulkUpdateBookingResponse as BulkUpdateBookingResponse,\n bookingsV2Booking_universal_d_BulkCreateBookingRequest as BulkCreateBookingRequest,\n bookingsV2Booking_universal_d_CreateBookingInfo as CreateBookingInfo,\n bookingsV2Booking_universal_d_BulkCreateBookingResponse as BulkCreateBookingResponse,\n bookingsV2Booking_universal_d_BulkBookingResult as BulkBookingResult,\n bookingsV2Booking_universal_d_RescheduleBookingRequest as RescheduleBookingRequest,\n bookingsV2Booking_universal_d_RescheduleBookingRequestParticipantsInfoOneOf as RescheduleBookingRequestParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_RescheduleBookingResponse as RescheduleBookingResponse,\n bookingsV2Booking_universal_d_BulkRescheduleBookingRequest as BulkRescheduleBookingRequest,\n bookingsV2Booking_universal_d_BulkRescheduleBookingRequestBooking as BulkRescheduleBookingRequestBooking,\n bookingsV2Booking_universal_d_SlotBookings as SlotBookings,\n bookingsV2Booking_universal_d_BulkRescheduleBookingResponse as BulkRescheduleBookingResponse,\n bookingsV2Booking_universal_d_BulkUpdateBookedScheduleRequest as BulkUpdateBookedScheduleRequest,\n bookingsV2Booking_universal_d_BookingDetails as BookingDetails,\n bookingsV2Booking_universal_d_BulkUpdateBookedScheduleResponse as BulkUpdateBookedScheduleResponse,\n bookingsV2Booking_universal_d_QueryBookingsRequest as QueryBookingsRequest,\n bookingsV2Booking_universal_d_QueryV2 as QueryV2,\n bookingsV2Booking_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n bookingsV2Booking_universal_d_Sorting as Sorting,\n bookingsV2Booking_universal_d_SortOrder as SortOrder,\n bookingsV2Booking_universal_d_Paging as Paging,\n bookingsV2Booking_universal_d_CursorPaging as CursorPaging,\n bookingsV2Booking_universal_d_QueryBookingsResponse as QueryBookingsResponse,\n bookingsV2Booking_universal_d_PagingMetadataV2 as PagingMetadataV2,\n bookingsV2Booking_universal_d_Cursors as Cursors,\n bookingsV2Booking_universal_d_ConfirmRequest as ConfirmRequest,\n bookingsV2Booking_universal_d_ConfirmResponse as ConfirmResponse,\n bookingsV2Booking_universal_d_ConfirmBookingRequest as ConfirmBookingRequest,\n bookingsV2Booking_universal_d_ConfirmBookingResponse as ConfirmBookingResponse,\n bookingsV2Booking_universal_d_PartySizeRequest as PartySizeRequest,\n bookingsV2Booking_universal_d_PartySizeRequestPartySizeForOneOf as PartySizeRequestPartySizeForOneOf,\n bookingsV2Booking_universal_d_PartySizeResponse as PartySizeResponse,\n bookingsV2Booking_universal_d_ConsistentQueryBookingsRequest as ConsistentQueryBookingsRequest,\n bookingsV2Booking_universal_d_ConsistentQueryBookingsResponse as ConsistentQueryBookingsResponse,\n bookingsV2Booking_universal_d_SetBookingSessionIdRequest as SetBookingSessionIdRequest,\n bookingsV2Booking_universal_d_SetBookingSessionIdResponse as SetBookingSessionIdResponse,\n bookingsV2Booking_universal_d_UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest,\n bookingsV2Booking_universal_d_UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse,\n bookingsV2Booking_universal_d_DeclineBookingRequest as DeclineBookingRequest,\n bookingsV2Booking_universal_d_DeclineBookingResponse as DeclineBookingResponse,\n bookingsV2Booking_universal_d_CancelBookingRequest as CancelBookingRequest,\n bookingsV2Booking_universal_d_CancelBookingResponse as CancelBookingResponse,\n bookingsV2Booking_universal_d_UpdateNumberOfParticipantsRequest as UpdateNumberOfParticipantsRequest,\n bookingsV2Booking_universal_d_UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as UpdateNumberOfParticipantsRequestParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_UpdateNumberOfParticipantsResponse as UpdateNumberOfParticipantsResponse,\n bookingsV2Booking_universal_d_NumberOfParticipantsUpdated as NumberOfParticipantsUpdated,\n bookingsV2Booking_universal_d_NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf as NumberOfParticipantsUpdatedPreviousParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_CalculateAllowedActionsRequest as CalculateAllowedActionsRequest,\n bookingsV2Booking_universal_d_CalculateAllowedActionsResponse as CalculateAllowedActionsResponse,\n bookingsV2Booking_universal_d_BulkCalculateAllowedActionsRequest as BulkCalculateAllowedActionsRequest,\n bookingsV2Booking_universal_d_BulkCalculateAllowedActionsResponse as BulkCalculateAllowedActionsResponse,\n bookingsV2Booking_universal_d_GetSlotAvailabilityRequest as GetSlotAvailabilityRequest,\n bookingsV2Booking_universal_d_GetSlotAvailabilityResponse as GetSlotAvailabilityResponse,\n bookingsV2Booking_universal_d_SlotAvailability as SlotAvailability,\n bookingsV2Booking_universal_d_WaitingList as WaitingList,\n bookingsV2Booking_universal_d_AvailableResources as AvailableResources,\n bookingsV2Booking_universal_d_GetScheduleAvailabilityRequest as GetScheduleAvailabilityRequest,\n bookingsV2Booking_universal_d_GetScheduleAvailabilityResponse as GetScheduleAvailabilityResponse,\n bookingsV2Booking_universal_d_ScheduleAvailability as ScheduleAvailability,\n bookingsV2Booking_universal_d_MarkBookingAsPendingRequest as MarkBookingAsPendingRequest,\n bookingsV2Booking_universal_d_MarkBookingAsPendingResponse as MarkBookingAsPendingResponse,\n bookingsV2Booking_universal_d_BookingMarkedAsPending as BookingMarkedAsPending,\n bookingsV2Booking_universal_d_MigrationCheckIfClashesWithBlockedTimeRequest as MigrationCheckIfClashesWithBlockedTimeRequest,\n bookingsV2Booking_universal_d_MsidAndBookingId as MsidAndBookingId,\n bookingsV2Booking_universal_d_MigrationCheckIfClashesWithBlockedTimeResponse as MigrationCheckIfClashesWithBlockedTimeResponse,\n bookingsV2Booking_universal_d_Clash as Clash,\n bookingsV2Booking_universal_d_ConfirmOrDeclineBookingRequest as ConfirmOrDeclineBookingRequest,\n bookingsV2Booking_universal_d_ConfirmOrDeclineBookingResponse as ConfirmOrDeclineBookingResponse,\n bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingRequest as BulkConfirmOrDeclineBookingRequest,\n bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingRequestBookingDetails as BulkConfirmOrDeclineBookingRequestBookingDetails,\n bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingResponse as BulkConfirmOrDeclineBookingResponse,\n bookingsV2Booking_universal_d_V2CreateBookingRequest as V2CreateBookingRequest,\n bookingsV2Booking_universal_d_V2CreateBookingRequestBookableItemOneOf as V2CreateBookingRequestBookableItemOneOf,\n bookingsV2Booking_universal_d_V2CreateBookingRequestParticipantsInfoOneOf as V2CreateBookingRequestParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_Slot as Slot,\n bookingsV2Booking_universal_d_SlotResource as SlotResource,\n bookingsV2Booking_universal_d_CreateBookingRequestFlowControlSettings as CreateBookingRequestFlowControlSettings,\n bookingsV2Booking_universal_d_V2CreateBookingResponse as V2CreateBookingResponse,\n bookingsV2Booking_universal_d_V2CancelBookingRequest as V2CancelBookingRequest,\n bookingsV2Booking_universal_d_V2CancelBookingRequestFlowControlSettings as V2CancelBookingRequestFlowControlSettings,\n bookingsV2Booking_universal_d_V2CancelBookingResponse as V2CancelBookingResponse,\n bookingsV2Booking_universal_d_V2RescheduleBookingRequest as V2RescheduleBookingRequest,\n bookingsV2Booking_universal_d_V2RescheduleBookingRequestParticipantsInfoOneOf as V2RescheduleBookingRequestParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_V2RescheduleBookingRequestFlowControlSettings as V2RescheduleBookingRequestFlowControlSettings,\n bookingsV2Booking_universal_d_V2RescheduleBookingResponse as V2RescheduleBookingResponse,\n bookingsV2Booking_universal_d_V2ConfirmBookingRequest as V2ConfirmBookingRequest,\n bookingsV2Booking_universal_d_V2ConfirmBookingResponse as V2ConfirmBookingResponse,\n bookingsV2Booking_universal_d_V2DeclineBookingRequest as V2DeclineBookingRequest,\n bookingsV2Booking_universal_d_V2DeclineBookingResponse as V2DeclineBookingResponse,\n bookingsV2Booking_universal_d_V2UpdateNumberOfParticipantsRequest as V2UpdateNumberOfParticipantsRequest,\n bookingsV2Booking_universal_d_V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf as V2UpdateNumberOfParticipantsRequestParticipantsInfoOneOf,\n bookingsV2Booking_universal_d_V2UpdateNumberOfParticipantsResponse as V2UpdateNumberOfParticipantsResponse,\n bookingsV2Booking_universal_d_createMultiServiceBooking as createMultiServiceBooking,\n bookingsV2Booking_universal_d_CreateMultiServiceBookingOptions as CreateMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_rescheduleMultiServiceBooking as rescheduleMultiServiceBooking,\n bookingsV2Booking_universal_d_RescheduleMultiServiceBookingOptions as RescheduleMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_getMultiServiceBookingAvailability as getMultiServiceBookingAvailability,\n bookingsV2Booking_universal_d_cancelMultiServiceBooking as cancelMultiServiceBooking,\n bookingsV2Booking_universal_d_CancelMultiServiceBookingOptions as CancelMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_markMultiServiceBookingAsPending as markMultiServiceBookingAsPending,\n bookingsV2Booking_universal_d_MarkMultiServiceBookingAsPendingOptions as MarkMultiServiceBookingAsPendingOptions,\n bookingsV2Booking_universal_d_confirmMultiServiceBooking as confirmMultiServiceBooking,\n bookingsV2Booking_universal_d_ConfirmMultiServiceBookingOptions as ConfirmMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_declineMultiServiceBooking as declineMultiServiceBooking,\n bookingsV2Booking_universal_d_DeclineMultiServiceBookingOptions as DeclineMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_bulkGetMultiServiceBookingAllowedActions as bulkGetMultiServiceBookingAllowedActions,\n bookingsV2Booking_universal_d_MarkAsMultiServiceBookingOptions as MarkAsMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_getMultiServiceBooking as getMultiServiceBooking,\n bookingsV2Booking_universal_d_addBookingsToMultiServiceBooking as addBookingsToMultiServiceBooking,\n bookingsV2Booking_universal_d_AddBookingsToMultiServiceBookingOptions as AddBookingsToMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_removeBookingsFromMultiServiceBooking as removeBookingsFromMultiServiceBooking,\n bookingsV2Booking_universal_d_RemoveBookingsFromMultiServiceBookingOptions as RemoveBookingsFromMultiServiceBookingOptions,\n bookingsV2Booking_universal_d_createBooking as createBooking,\n bookingsV2Booking_universal_d_CreateBookingOptions as CreateBookingOptions,\n bookingsV2Booking_universal_d_updateBooking as updateBooking,\n bookingsV2Booking_universal_d_UpdateBooking as UpdateBooking,\n bookingsV2Booking_universal_d_UpdateBookingOptions as UpdateBookingOptions,\n bookingsV2Booking_universal_d_legacyCreateBooking as legacyCreateBooking,\n bookingsV2Booking_universal_d_bulkUpdateBooking as bulkUpdateBooking,\n bookingsV2Booking_universal_d_bulkCreateBooking as bulkCreateBooking,\n bookingsV2Booking_universal_d_BulkCreateBookingOptions as BulkCreateBookingOptions,\n bookingsV2Booking_universal_d_rescheduleBooking as rescheduleBooking,\n bookingsV2Booking_universal_d_RescheduleBookingOptions as RescheduleBookingOptions,\n bookingsV2Booking_universal_d_bulkRescheduleBooking as bulkRescheduleBooking,\n bookingsV2Booking_universal_d_BulkRescheduleBookingOptions as BulkRescheduleBookingOptions,\n bookingsV2Booking_universal_d_bulkUpdateBookedSchedule as bulkUpdateBookedSchedule,\n bookingsV2Booking_universal_d_BulkUpdateBookedScheduleOptions as BulkUpdateBookedScheduleOptions,\n bookingsV2Booking_universal_d_query as query,\n bookingsV2Booking_universal_d_QueryOptions as QueryOptions,\n bookingsV2Booking_universal_d_confirmBooking as confirmBooking,\n bookingsV2Booking_universal_d_ConfirmBookingOptions as ConfirmBookingOptions,\n bookingsV2Booking_universal_d_PartySizeOptions as PartySizeOptions,\n bookingsV2Booking_universal_d_consistentQuery as consistentQuery,\n bookingsV2Booking_universal_d_ConsistentQueryOptions as ConsistentQueryOptions,\n bookingsV2Booking_universal_d_setBookingSessionId as setBookingSessionId,\n bookingsV2Booking_universal_d_SetBookingSessionIdOptions as SetBookingSessionIdOptions,\n bookingsV2Booking_universal_d_updateExtendedFields as updateExtendedFields,\n bookingsV2Booking_universal_d_UpdateExtendedFieldsOptions as UpdateExtendedFieldsOptions,\n bookingsV2Booking_universal_d_declineBooking as declineBooking,\n bookingsV2Booking_universal_d_DeclineBookingOptions as DeclineBookingOptions,\n bookingsV2Booking_universal_d_cancelBooking as cancelBooking,\n bookingsV2Booking_universal_d_CancelBookingOptions as CancelBookingOptions,\n bookingsV2Booking_universal_d_updateNumberOfParticipants as updateNumberOfParticipants,\n bookingsV2Booking_universal_d_UpdateNumberOfParticipantsOptions as UpdateNumberOfParticipantsOptions,\n bookingsV2Booking_universal_d_bulkCalculateAllowedActions as bulkCalculateAllowedActions,\n bookingsV2Booking_universal_d_getSlotAvailability as getSlotAvailability,\n bookingsV2Booking_universal_d_GetSlotAvailabilityOptions as GetSlotAvailabilityOptions,\n bookingsV2Booking_universal_d_getScheduleAvailability as getScheduleAvailability,\n bookingsV2Booking_universal_d_markBookingAsPending as markBookingAsPending,\n bookingsV2Booking_universal_d_MarkBookingAsPendingOptions as MarkBookingAsPendingOptions,\n bookingsV2Booking_universal_d_confirmOrDeclineBooking as confirmOrDeclineBooking,\n bookingsV2Booking_universal_d_ConfirmOrDeclineBookingOptions as ConfirmOrDeclineBookingOptions,\n bookingsV2Booking_universal_d_bulkConfirmOrDeclineBooking as bulkConfirmOrDeclineBooking,\n bookingsV2Booking_universal_d_BulkConfirmOrDeclineBookingOptions as BulkConfirmOrDeclineBookingOptions,\n bookingsV2Booking_universal_d_bookingsGatewayCreateBooking as bookingsGatewayCreateBooking,\n bookingsV2Booking_universal_d_BookingsGatewayCreateBookingOptions as BookingsGatewayCreateBookingOptions,\n bookingsV2Booking_universal_d_bookingsGatewayCancelBooking as bookingsGatewayCancelBooking,\n bookingsV2Booking_universal_d_BookingsGatewayCancelBookingOptions as BookingsGatewayCancelBookingOptions,\n bookingsV2Booking_universal_d_bookingsGatewayRescheduleBooking as bookingsGatewayRescheduleBooking,\n bookingsV2Booking_universal_d_BookingsGatewayRescheduleBookingOptions as BookingsGatewayRescheduleBookingOptions,\n bookingsV2Booking_universal_d_bookingsGatewayConfirmBooking as bookingsGatewayConfirmBooking,\n bookingsV2Booking_universal_d_BookingsGatewayConfirmBookingOptions as BookingsGatewayConfirmBookingOptions,\n bookingsV2Booking_universal_d_bookingsGatewayDeclineBooking as bookingsGatewayDeclineBooking,\n bookingsV2Booking_universal_d_BookingsGatewayDeclineBookingOptions as BookingsGatewayDeclineBookingOptions,\n bookingsV2Booking_universal_d_bookingsGatewayUpdateNumberOfParticipants as bookingsGatewayUpdateNumberOfParticipants,\n bookingsV2Booking_universal_d_BookingsGatewayUpdateNumberOfParticipantsOptions as BookingsGatewayUpdateNumberOfParticipantsOptions,\n };\n }\n \n interface BookingsAppSettings {\n /** @readonly */\n _id?: string | null;\n /** @readonly */\n revision?: string | null;\n /** @readonly */\n _createdDate?: Date | null;\n /** @readonly */\n _updatedDate?: Date | null;\n /**\n * Cart checkout settings\n * @readonly\n */\n cartCheckout?: CartCheckout;\n }\n interface CartCheckout {\n /** Whether the cart checkout feature is enabled */\n enabled?: boolean | null;\n }\n interface GetBookingsAppSettingsRequest {\n }\n interface GetBookingsAppSettingsResponse {\n /** Settings for the Bookings app */\n bookingsAppSettings?: BookingsAppSettings;\n }\n /**\n * Retrieves the settings for the Wix Bookings app\n * @internal\n * @documentationMaturity preview\n * @permissionId BOOKINGS.APP_SETTINGS_READ\n * @adminMethod\n */\n function getBookingsAppSettings(): Promise;\n \n type bookingsV2BookingsAppSettings_universal_d_BookingsAppSettings = BookingsAppSettings;\n type bookingsV2BookingsAppSettings_universal_d_CartCheckout = CartCheckout;\n type bookingsV2BookingsAppSettings_universal_d_GetBookingsAppSettingsRequest = GetBookingsAppSettingsRequest;\n type bookingsV2BookingsAppSettings_universal_d_GetBookingsAppSettingsResponse = GetBookingsAppSettingsResponse;\n const bookingsV2BookingsAppSettings_universal_d_getBookingsAppSettings: typeof getBookingsAppSettings;\n namespace bookingsV2BookingsAppSettings_universal_d {\n export {\n bookingsV2BookingsAppSettings_universal_d_BookingsAppSettings as BookingsAppSettings,\n bookingsV2BookingsAppSettings_universal_d_CartCheckout as CartCheckout,\n bookingsV2BookingsAppSettings_universal_d_GetBookingsAppSettingsRequest as GetBookingsAppSettingsRequest,\n bookingsV2BookingsAppSettings_universal_d_GetBookingsAppSettingsResponse as GetBookingsAppSettingsResponse,\n bookingsV2BookingsAppSettings_universal_d_getBookingsAppSettings as getBookingsAppSettings,\n };\n }\n \n interface PriceInfo extends PriceInfoTotalPriceOneOf {\n /**\n * Calculated total price. Available only when the\n * [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-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. __Deprecated.__ Use `priceDescriptionInfo.original` instead.\n * `priceDescription` will be removed on March 31, 2025.\n * @deprecated 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 * @replacedBy price_description_info.original\n * @targetRemovalDate 2025-01-10\n */\n priceDescription?: string;\n /**\n * Description of the total price. Available only when the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s\n * `payment.rateType` is set to `CUSTOM`.\n */\n priceDescriptionInfo?: PriceDescriptionInfo;\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 * 3-letter currency code in\n * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.\n * @internal\n */\n currency?: string | null;\n }\n /** @oneof */\n interface PriceInfoTotalPriceOneOf {\n /**\n * Calculated total price. Available only when the\n * [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s\n * price has been set up as a numerical value in\n * `schedule.rate.labeledPriceOptions`.\n *\n */\n calculatedPrice?: number;\n /**\n * Description of the total price. __Deprecated.__ Use `priceDescriptionInfo.original` instead.\n * `priceDescription` will be removed on March 31, 2025.\n * @deprecated 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 * @replacedBy price_description_info.original\n * @targetRemovalDate 2025-01-10\n */\n priceDescription?: string;\n /**\n * Description of the total price. Available only when the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/get-service)'s\n * `payment.rateType` is set to `CUSTOM`.\n */\n priceDescriptionInfo?: PriceDescriptionInfo;\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[];\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 extends ServiceChoiceChoiceOneOf {\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 {\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 PriceDescriptionInfo {\n /** Price description in the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages). */\n original?: string;\n /** Translated price description. Available if the customer booked in a language other than the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages). */\n translated?: string | null;\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;\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 * Number of participants.\n * @internal\n */\n numberOfParticipants?: number | null;\n /**\n * Internal business note\n * @internal\n * @deprecated\n */\n internalBusinessNote?: string | null;\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;\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 */\n paymentStatus?: PaymentStatus;\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;\n /**\n * Date and time the booking was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /** External ID provided by the client app on creation. */\n externalUserId?: string | null;\n /**\n * An object describing the platform and application that made the booking.\n * @internal\n */\n bookingSource?: BookingSource;\n /**\n * The last notification used by Cancel, Confirm, Decline, or Reschedule Booking.\n * @internal\n * @deprecated\n */\n participantNotification?: ParticipantNotification;\n /**\n * When value is set to True, an SMS reminder would be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.\n * @internal\n * @deprecated\n */\n sendSmsReminder?: boolean | 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;\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 | null;\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 | null;\n /**\n * Sets the booking flow behavior. Some behaviors require permissions.\n * @internal\n */\n flowControlSettings?: FlowControlSettings;\n /**\n * Date and time the booking was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Custom field data for this object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.\n * For usage of extended fields with [Wix Forms](https://dev.wix.com/docs/rest/crm/forms/form-schema-api/introduction-to-forms), after configuring your form custom fields, pass the form field values under the `_user_fields` namespace.\n * For example, if you have a custom form field named `age`, pass it as `\"extendedFields\":{\"_user_fields\": { \"age\": 22 }}`.\n */\n extendedFields?: ExtendedFields;\n /**\n * Whether this booking overlaps another existing confirmed booking. Returned when: `true`\n * @readonly\n */\n doubleBooked?: boolean | null;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2Availability?: boolean | null;\n /**\n * Multi service booking info of which the booking is part of.\n * @internal\n * @readonly\n */\n multiServiceBookingInfo?: MultiServiceBookingInfo;\n /**\n * The date this booking was canceled on\n * @internal\n * @readonly\n */\n canceledDate?: Date | null;\n /**\n * whether this booking availability should be checked with v1 or v2\n * @internal\n */\n v2AvailabilityProxy?: boolean | null;\n /**\n * Having booking language means that the booking was made in a secondary language, having no booking.language implies that the booking was made using the main language\n * @internal\n */\n language?: string | 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 * If the user made the booking in a secondary language, this field will contain the translated title.\n * @internal\n * @readonly\n */\n titleTranslated?: 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;\n /**\n * Optional.\n * In addition to the `resource` field, these are the additional enriched resources that are assigned to the slot.\n * For example the room, equipment or the additional staff member that are assigned to the slot.\n * @internal\n */\n additionalResources?: BookedResource[];\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 /**\n * Resource's name translated to the language the booking was made in if applicable.\n * @internal\n * @readonly\n */\n nameTranslated?: 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 * Indicates whether the resource was specifically requested or should be auto selected by the Server.\n * The value will be true if the resource was explicitly given in the request, otherwise false.\n * @internal\n * @readonly\n */\n explicitlyRequested?: boolean | null;\n /**\n * Resource's type.\n * @internal\n * @readonly\n */\n type?: 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 /** The full translated address of this location. */\n formattedAddressTranslated?: 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 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;\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). 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;\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 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 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 /**\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;\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 {\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 * Optional additional metadata.\n * Supported only in V3 APIs.\n * @internal\n */\n metadata?: Record;\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 /** 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 * @internal\n * @readonly\n */\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 enum IdentityType {\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 the service defined booking-window in the booking policy.\n * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.\n * private because it's confusing to external users - collides with skip_availability_validation\n * and yet, clients send it (though always with skip_availability_validation=true) so we're not just removing it\n * When removing, we need to use proto's `reserved` field\n * @internal\n * @deprecated\n */\n ignoreBookingWindow?: boolean;\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 {\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 {\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[];\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 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 * [BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin. 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 * @permissionId BOOKINGS.PRICE_PREVIEW\n */\n function previewPrice(bookingLineItems: BookingLineItem[]): Promise;\n /**\n * Calculates the base price of a booking.\n *\n *\n *\n * You can call `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()` 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()`.\n *\n * Alternatively you can customize the pricing logic using the\n * [BookingsCustomPricing](https://dev.wix.com/docs/velo/api-reference/wix-bookings-v2/service-plugins-spis/bookings-custom-pricing/introduction) service plugin.\n * If you integrate with a pricing provider, the customized pricing logic becomes\n * the default logic. This means that, if the Custom Pricing service plugin 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 * @permissionId BOOKINGS.PRICE_CALCULATE\n */\n function calculatePrice(booking: Booking): Promise;\n \n type bookingsV2PriceInfo_universal_d_PriceInfo = PriceInfo;\n type bookingsV2PriceInfo_universal_d_PriceInfoTotalPriceOneOf = PriceInfoTotalPriceOneOf;\n type bookingsV2PriceInfo_universal_d_BookingLineItem = BookingLineItem;\n type bookingsV2PriceInfo_universal_d_ServiceChoice = ServiceChoice;\n type bookingsV2PriceInfo_universal_d_ServiceChoiceChoiceOneOf = ServiceChoiceChoiceOneOf;\n type bookingsV2PriceInfo_universal_d_PriceDescriptionInfo = PriceDescriptionInfo;\n type bookingsV2PriceInfo_universal_d_PreviewPriceRequest = PreviewPriceRequest;\n type bookingsV2PriceInfo_universal_d_PreviewPriceResponse = PreviewPriceResponse;\n type bookingsV2PriceInfo_universal_d_CalculatePriceRequest = CalculatePriceRequest;\n type bookingsV2PriceInfo_universal_d_Booking = Booking;\n type bookingsV2PriceInfo_universal_d_BookingParticipantsInfoOneOf = BookingParticipantsInfoOneOf;\n type bookingsV2PriceInfo_universal_d_MultiServiceBookingType = MultiServiceBookingType;\n const bookingsV2PriceInfo_universal_d_MultiServiceBookingType: typeof MultiServiceBookingType;\n type bookingsV2PriceInfo_universal_d_BookedEntity = BookedEntity;\n type bookingsV2PriceInfo_universal_d_BookedEntityItemOneOf = BookedEntityItemOneOf;\n type bookingsV2PriceInfo_universal_d_BookedSlot = BookedSlot;\n type bookingsV2PriceInfo_universal_d_BookedResource = BookedResource;\n type bookingsV2PriceInfo_universal_d_Location = Location;\n type bookingsV2PriceInfo_universal_d_LocationType = LocationType;\n const bookingsV2PriceInfo_universal_d_LocationType: typeof LocationType;\n type bookingsV2PriceInfo_universal_d_BookedSchedule = BookedSchedule;\n type bookingsV2PriceInfo_universal_d_ContactDetails = ContactDetails;\n type bookingsV2PriceInfo_universal_d_Address = Address;\n type bookingsV2PriceInfo_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type bookingsV2PriceInfo_universal_d_StreetAddress = StreetAddress;\n type bookingsV2PriceInfo_universal_d_AddressLocation = AddressLocation;\n type bookingsV2PriceInfo_universal_d_Subdivision = Subdivision;\n type bookingsV2PriceInfo_universal_d_CustomFormField = CustomFormField;\n type bookingsV2PriceInfo_universal_d_ValueType = ValueType;\n const bookingsV2PriceInfo_universal_d_ValueType: typeof ValueType;\n type bookingsV2PriceInfo_universal_d_BookingStatus = BookingStatus;\n const bookingsV2PriceInfo_universal_d_BookingStatus: typeof BookingStatus;\n type bookingsV2PriceInfo_universal_d_PaymentStatus = PaymentStatus;\n const bookingsV2PriceInfo_universal_d_PaymentStatus: typeof PaymentStatus;\n type bookingsV2PriceInfo_universal_d_SelectedPaymentOption = SelectedPaymentOption;\n const bookingsV2PriceInfo_universal_d_SelectedPaymentOption: typeof SelectedPaymentOption;\n type bookingsV2PriceInfo_universal_d_BookingSource = BookingSource;\n type bookingsV2PriceInfo_universal_d_Platform = Platform;\n const bookingsV2PriceInfo_universal_d_Platform: typeof Platform;\n type bookingsV2PriceInfo_universal_d_Actor = Actor;\n const bookingsV2PriceInfo_universal_d_Actor: typeof Actor;\n type bookingsV2PriceInfo_universal_d_ParticipantNotification = ParticipantNotification;\n type bookingsV2PriceInfo_universal_d_IdentificationData = IdentificationData;\n type bookingsV2PriceInfo_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type bookingsV2PriceInfo_universal_d_IdentityType = IdentityType;\n const bookingsV2PriceInfo_universal_d_IdentityType: typeof IdentityType;\n type bookingsV2PriceInfo_universal_d_FlowControlSettings = FlowControlSettings;\n type bookingsV2PriceInfo_universal_d_ExtendedFields = ExtendedFields;\n type bookingsV2PriceInfo_universal_d_ParticipantChoices = ParticipantChoices;\n type bookingsV2PriceInfo_universal_d_ServiceChoices = ServiceChoices;\n type bookingsV2PriceInfo_universal_d_MultiServiceBookingInfo = MultiServiceBookingInfo;\n type bookingsV2PriceInfo_universal_d_CalculatePriceResponse = CalculatePriceResponse;\n const bookingsV2PriceInfo_universal_d_previewPrice: typeof previewPrice;\n const bookingsV2PriceInfo_universal_d_calculatePrice: typeof calculatePrice;\n namespace bookingsV2PriceInfo_universal_d {\n export {\n bookingsV2PriceInfo_universal_d_PriceInfo as PriceInfo,\n bookingsV2PriceInfo_universal_d_PriceInfoTotalPriceOneOf as PriceInfoTotalPriceOneOf,\n bookingsV2PriceInfo_universal_d_BookingLineItem as BookingLineItem,\n bookingsV2PriceInfo_universal_d_ServiceChoice as ServiceChoice,\n bookingsV2PriceInfo_universal_d_ServiceChoiceChoiceOneOf as ServiceChoiceChoiceOneOf,\n bookingsV2PriceInfo_universal_d_PriceDescriptionInfo as PriceDescriptionInfo,\n bookingsV2PriceInfo_universal_d_PreviewPriceRequest as PreviewPriceRequest,\n bookingsV2PriceInfo_universal_d_PreviewPriceResponse as PreviewPriceResponse,\n bookingsV2PriceInfo_universal_d_CalculatePriceRequest as CalculatePriceRequest,\n bookingsV2PriceInfo_universal_d_Booking as Booking,\n bookingsV2PriceInfo_universal_d_BookingParticipantsInfoOneOf as BookingParticipantsInfoOneOf,\n bookingsV2PriceInfo_universal_d_MultiServiceBookingType as MultiServiceBookingType,\n bookingsV2PriceInfo_universal_d_BookedEntity as BookedEntity,\n bookingsV2PriceInfo_universal_d_BookedEntityItemOneOf as BookedEntityItemOneOf,\n bookingsV2PriceInfo_universal_d_BookedSlot as BookedSlot,\n bookingsV2PriceInfo_universal_d_BookedResource as BookedResource,\n bookingsV2PriceInfo_universal_d_Location as Location,\n bookingsV2PriceInfo_universal_d_LocationType as LocationType,\n bookingsV2PriceInfo_universal_d_BookedSchedule as BookedSchedule,\n bookingsV2PriceInfo_universal_d_ContactDetails as ContactDetails,\n bookingsV2PriceInfo_universal_d_Address as Address,\n bookingsV2PriceInfo_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n bookingsV2PriceInfo_universal_d_StreetAddress as StreetAddress,\n bookingsV2PriceInfo_universal_d_AddressLocation as AddressLocation,\n bookingsV2PriceInfo_universal_d_Subdivision as Subdivision,\n bookingsV2PriceInfo_universal_d_CustomFormField as CustomFormField,\n bookingsV2PriceInfo_universal_d_ValueType as ValueType,\n bookingsV2PriceInfo_universal_d_BookingStatus as BookingStatus,\n bookingsV2PriceInfo_universal_d_PaymentStatus as PaymentStatus,\n bookingsV2PriceInfo_universal_d_SelectedPaymentOption as SelectedPaymentOption,\n bookingsV2PriceInfo_universal_d_BookingSource as BookingSource,\n bookingsV2PriceInfo_universal_d_Platform as Platform,\n bookingsV2PriceInfo_universal_d_Actor as Actor,\n bookingsV2PriceInfo_universal_d_ParticipantNotification as ParticipantNotification,\n bookingsV2PriceInfo_universal_d_IdentificationData as IdentificationData,\n bookingsV2PriceInfo_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n bookingsV2PriceInfo_universal_d_IdentityType as IdentityType,\n bookingsV2PriceInfo_universal_d_FlowControlSettings as FlowControlSettings,\n bookingsV2PriceInfo_universal_d_ExtendedFields as ExtendedFields,\n bookingsV2PriceInfo_universal_d_ParticipantChoices as ParticipantChoices,\n bookingsV2PriceInfo_universal_d_ServiceChoices as ServiceChoices,\n bookingsV2PriceInfo_universal_d_MultiServiceBookingInfo as MultiServiceBookingInfo,\n bookingsV2PriceInfo_universal_d_CalculatePriceResponse as CalculatePriceResponse,\n bookingsV2PriceInfo_universal_d_previewPrice as previewPrice,\n bookingsV2PriceInfo_universal_d_calculatePrice as calculatePrice,\n };\n }\n \n export { bookingsV2BookingsAppSettings_universal_d as appSettings, bookingsV2Attendance_universal_d as attendance, bookingsAvailabilityV1SlotAvailability_universal_d as availabilityCalendar, bookingsAvailabilityV2TimeSlotAvailabilityTimeSlots_universal_d as availabilityTimeSlots, bookingsFeesV1BookingFee_universal_d as bookingFees, bookingsV1BookingPolicy_universal_d as bookingPolicies, bookingsPolicySnapshotsV1BookingPolicySnapshot_universal_d as bookingPolicySnapshots, bookingsV2Booking_universal_d as bookings, bookingsAvailabilityV2TimeSlotEventTimeSlots_universal_d as eventTimeSlots, bookingsReaderV2ExtendedBooking_universal_d as extendedBookings, bookingsCalendarV2ExternalCalendar_universal_d as externalCalendars, bookingsAvailabilityV2TimeSlotMultiServiceAvailabilityTimeSlots_universal_d as multiServiceAvailabilityTimeSlots, bookingsV2PriceInfo_universal_d as pricing, bookingsResourcesV2ResourceType_universal_d as resourceTypes, bookingsResourcesV2Resource_universal_d as resources, bookingsAvailabilityV2TimeSlot_universal_d as serviceAvailability, bookingsCatalogV1ServiceOptionsAndVariants_universal_d as serviceOptionsAndVariants, bookingsServicesV2Service_universal_d as services, bookingsStaffV1StaffMember_universal_d as staffMembers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-forum.v2.d.ts", "content": "declare module \"wix-forum.v2\" {\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 header image overlay color.\n * @internal\n */\n headerImageOverlayColor?: ColorComponent;\n /**\n * Category header background color.\n * @internal\n */\n headerBackgroundColor?: ColorComponent;\n /**\n * Category header text color.\n * @internal\n */\n headerTextColor?: ColorComponent;\n /**\n * The position of the category in the 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 * @internal\n * @internal\n * @deprecated\n */\n postTypes?: PostType$1[];\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 category if `categoryAccess` is `'PRIVATE'`.\n *\n * @readonly\n */\n groups?: string[];\n /** Defines what interactions may be applied on the comment under the posts created in this category. */\n commentInteraction?: Interaction$1;\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 * Enables guest commenting under the posts created in this category.\n * Default false.\n * @internal\n */\n guestReactionsEnabled?: boolean;\n /**\n * Enables guest reactions in this category.\n * Default false.\n * @internal\n */\n guestCommentsEnabled?: boolean;\n /**\n * Defines order of comments under the posts created in this category.\n * Default NEWEST.\n * @internal\n */\n commentOrder?: CommentOrder;\n /**\n * Enables replies creation to comments under the posts created in this category.\n * Default true.\n * @internal\n */\n commentRepliesEnabled?: boolean | null;\n /**\n * Comment button label text.\n * @internal\n */\n commentButtonLabel?: string | null;\n /**\n * Comment placeholder text.\n * @internal\n */\n commentPlaceholderText?: string | null;\n /**\n * Comment section header text.\n * @internal\n */\n commentSectionHeader?: string | null;\n /**\n * Category SEO data\n * @internal\n * @readonly\n */\n seoData?: SeoSchema;\n }\n enum HeaderType {\n NONE = \"NONE\",\n COLOR = \"COLOR\",\n IMAGE = \"IMAGE\"\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 ColorComponent {\n /** Hex Color Code */\n color?: string | null;\n /** Opacity (from 0 to 1) */\n opacity?: number | null;\n }\n enum PostType$1 {\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$1 {\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 /**\n * Array of category fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned. `UNKNOWN` must not be passed.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: CategoryFieldField[];\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field$1[];\n }\n enum CategoryFieldField {\n UNKNOWN = \"UNKNOWN\",\n /** Includes the category's URL. */\n URL = \"URL\"\n }\n enum Field$1 {\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 /**\n * Array of category fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned. `UNKNOWN` must not be passed.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: CategoryFieldField[];\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field$1[];\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 /**\n * Array of category fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned. `UNKNOWN` must not be passed.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: CategoryFieldField[];\n /** Array of extra category fields to be added in the response. `UNKNOWN` must not be passed. */\n extraFields?: Field$1[];\n /**\n * Allows to skip calculating meta data for response.\n * @internal\n */\n skipMetaData?: boolean;\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$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 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 /**\n * Field mask of fields to update.\n * @internal\n */\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * 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 * @adminMethod\n * @returns Retrieved category for the provided category ID.\n */\n function getCategory(categoryId: string, options?: GetCategoryOptions): Promise;\n interface GetCategoryOptions {\n /**\n * Array of category fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned. `UNKNOWN` must not be passed.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: CategoryFieldField[];\n /** Array of extra category fields to be included in the response. */\n extraFields?: Field$1[];\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 * @adminMethod\n */\n function getCategoryBySlug(slug: string, options?: GetCategoryBySlugOptions): Promise;\n interface GetCategoryBySlugOptions {\n /**\n * Array of category fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned. `UNKNOWN` must not be passed.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: CategoryFieldField[];\n /** Array of extra category fields to be included in the response. */\n extraFields?: Field$1[];\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 * @adminMethod\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 /**\n * Array of category fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned. `UNKNOWN` must not be passed.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: CategoryFieldField[];\n /** Array of extra category fields to be included in the response. */\n extraFields?: Field$1[];\n /**\n * Allows to skip calculating meta data for response.\n * @internal\n */\n skipMetaData?: boolean;\n }\n /**\n * Marks category as read for identity who made a request.\n * @param categoryId - ID of the read category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId WIX_FORUM.CATEGORY_MARK_READ\n * @adminMethod\n */\n function markCategoryRead(categoryId: string): Promise;\n /**\n * Marks all category posts as read for identity who made a request. If categoryId is not provided it marks all posts in the forum as read\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_FORUM.POST_MARK_READ\n * @adminMethod\n */\n function markAllPostsAsRead(options?: MarkAllPostsAsReadOptions): Promise;\n interface MarkAllPostsAsReadOptions {\n /** ID of the read posts category. */\n categoryId?: string;\n }\n /**\n * Creates a new category.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.category.description\n * @requiredField options.category.name\n * @permissionId WIX_FORUM.CATEGORY_CREATE\n * @adminMethod\n * @returns Retrieved category for the provided category ID.\n */\n function createCategory(options?: CreateCategoryOptions): Promise;\n interface CreateCategoryOptions {\n category?: Category;\n }\n /**\n * Updates a category's fields according to `fieldMask`.\n * @param categoryId - ID of category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId WIX_FORUM.CATEGORY_EDIT\n * @adminMethod\n * @returns Retrieved category for the provided category ID.\n */\n function updateCategory(categoryId: string, options?: UpdateCategoryOptions): Promise;\n interface UpdateCategoryOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /** Editable category data. */\n category?: Category;\n }\n /**\n * Deletes a category (only if it is not last category).\n * @param categoryId - ID of category.\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId WIX_FORUM.CATEGORY_DELETE\n * @adminMethod\n */\n function deleteCategory(categoryId: string): Promise;\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 * @adminMethod\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 *\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 * @adminMethod\n */\n function unsubscribeContactFromCategory(categoryId: string, options?: UnsubscribeContactFromCategoryOptions): Promise;\n interface UnsubscribeContactFromCategoryOptions {\n /** Contact ID. */\n contactId?: string | null;\n }\n \n type forumV1Category_universal_d_Category = Category;\n type forumV1Category_universal_d_HeaderType = HeaderType;\n const forumV1Category_universal_d_HeaderType: typeof HeaderType;\n type forumV1Category_universal_d_ColorComponent = ColorComponent;\n type forumV1Category_universal_d_Access = Access;\n const forumV1Category_universal_d_Access: typeof Access;\n type forumV1Category_universal_d_Reaction = Reaction;\n type forumV1Category_universal_d_ReactionReactionOneOf = ReactionReactionOneOf;\n type forumV1Category_universal_d_Type = Type;\n const forumV1Category_universal_d_Type: typeof Type;\n type forumV1Category_universal_d_PostInteraction = PostInteraction;\n const forumV1Category_universal_d_PostInteraction: typeof PostInteraction;\n type forumV1Category_universal_d_CommentOrder = CommentOrder;\n const forumV1Category_universal_d_CommentOrder: typeof CommentOrder;\n type forumV1Category_universal_d_SeoSchema = SeoSchema;\n type forumV1Category_universal_d_Keyword = Keyword;\n type forumV1Category_universal_d_Tag = Tag;\n type forumV1Category_universal_d_Settings = Settings;\n type forumV1Category_universal_d_CategoryRequest = CategoryRequest;\n type forumV1Category_universal_d_CategoryFieldField = CategoryFieldField;\n const forumV1Category_universal_d_CategoryFieldField: typeof CategoryFieldField;\n type forumV1Category_universal_d_CategoryResponse = CategoryResponse;\n type forumV1Category_universal_d_CategorySlugRequest = CategorySlugRequest;\n type forumV1Category_universal_d_QueryCategoriesRequest = QueryCategoriesRequest;\n type forumV1Category_universal_d_CategoriesPaging = CategoriesPaging;\n type forumV1Category_universal_d_CategoriesSort = CategoriesSort;\n type forumV1Category_universal_d_QueryCategoriesResponse = QueryCategoriesResponse;\n type forumV1Category_universal_d_QueryCategoriesResponseMetaData = QueryCategoriesResponseMetaData;\n type forumV1Category_universal_d_MarkCategoryReadRequest = MarkCategoryReadRequest;\n type forumV1Category_universal_d_MarkCategoryReadResponse = MarkCategoryReadResponse;\n type forumV1Category_universal_d_MarkAllPostsAsReadRequest = MarkAllPostsAsReadRequest;\n type forumV1Category_universal_d_MarkAllPostsAsReadResponse = MarkAllPostsAsReadResponse;\n type forumV1Category_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type forumV1Category_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type forumV1Category_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type forumV1Category_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type forumV1Category_universal_d_SubscribeContactToCategoryRequest = SubscribeContactToCategoryRequest;\n type forumV1Category_universal_d_SubscribeContactToCategoryResponse = SubscribeContactToCategoryResponse;\n type forumV1Category_universal_d_UnsubscribeContactFromCategoryRequest = UnsubscribeContactFromCategoryRequest;\n type forumV1Category_universal_d_UnsubscribeContactFromCategoryResponse = UnsubscribeContactFromCategoryResponse;\n const forumV1Category_universal_d_getCategory: typeof getCategory;\n type forumV1Category_universal_d_GetCategoryOptions = GetCategoryOptions;\n const forumV1Category_universal_d_getCategoryBySlug: typeof getCategoryBySlug;\n type forumV1Category_universal_d_GetCategoryBySlugOptions = GetCategoryBySlugOptions;\n const forumV1Category_universal_d_queryCategories: typeof queryCategories;\n type forumV1Category_universal_d_QueryCategoriesOptions = QueryCategoriesOptions;\n const forumV1Category_universal_d_markCategoryRead: typeof markCategoryRead;\n const forumV1Category_universal_d_markAllPostsAsRead: typeof markAllPostsAsRead;\n type forumV1Category_universal_d_MarkAllPostsAsReadOptions = MarkAllPostsAsReadOptions;\n const forumV1Category_universal_d_createCategory: typeof createCategory;\n type forumV1Category_universal_d_CreateCategoryOptions = CreateCategoryOptions;\n const forumV1Category_universal_d_updateCategory: typeof updateCategory;\n type forumV1Category_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const forumV1Category_universal_d_deleteCategory: typeof deleteCategory;\n const forumV1Category_universal_d_subscribeContactToCategory: typeof subscribeContactToCategory;\n type forumV1Category_universal_d_SubscribeContactToCategoryOptions = SubscribeContactToCategoryOptions;\n const forumV1Category_universal_d_unsubscribeContactFromCategory: typeof unsubscribeContactFromCategory;\n type forumV1Category_universal_d_UnsubscribeContactFromCategoryOptions = UnsubscribeContactFromCategoryOptions;\n namespace forumV1Category_universal_d {\n export {\n forumV1Category_universal_d_Category as Category,\n forumV1Category_universal_d_HeaderType as HeaderType,\n FocalPoint$1 as FocalPoint,\n forumV1Category_universal_d_ColorComponent as ColorComponent,\n PostType$1 as PostType,\n forumV1Category_universal_d_Access as Access,\n Interaction$1 as Interaction,\n forumV1Category_universal_d_Reaction as Reaction,\n forumV1Category_universal_d_ReactionReactionOneOf as ReactionReactionOneOf,\n forumV1Category_universal_d_Type as Type,\n forumV1Category_universal_d_PostInteraction as PostInteraction,\n forumV1Category_universal_d_CommentOrder as CommentOrder,\n forumV1Category_universal_d_SeoSchema as SeoSchema,\n forumV1Category_universal_d_Keyword as Keyword,\n forumV1Category_universal_d_Tag as Tag,\n forumV1Category_universal_d_Settings as Settings,\n forumV1Category_universal_d_CategoryRequest as CategoryRequest,\n forumV1Category_universal_d_CategoryFieldField as CategoryFieldField,\n Field$1 as Field,\n forumV1Category_universal_d_CategoryResponse as CategoryResponse,\n forumV1Category_universal_d_CategorySlugRequest as CategorySlugRequest,\n forumV1Category_universal_d_QueryCategoriesRequest as QueryCategoriesRequest,\n forumV1Category_universal_d_CategoriesPaging as CategoriesPaging,\n forumV1Category_universal_d_CategoriesSort as CategoriesSort,\n Order$1 as Order,\n forumV1Category_universal_d_QueryCategoriesResponse as QueryCategoriesResponse,\n forumV1Category_universal_d_QueryCategoriesResponseMetaData as QueryCategoriesResponseMetaData,\n forumV1Category_universal_d_MarkCategoryReadRequest as MarkCategoryReadRequest,\n forumV1Category_universal_d_MarkCategoryReadResponse as MarkCategoryReadResponse,\n forumV1Category_universal_d_MarkAllPostsAsReadRequest as MarkAllPostsAsReadRequest,\n forumV1Category_universal_d_MarkAllPostsAsReadResponse as MarkAllPostsAsReadResponse,\n forumV1Category_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n forumV1Category_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n forumV1Category_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n forumV1Category_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n forumV1Category_universal_d_SubscribeContactToCategoryRequest as SubscribeContactToCategoryRequest,\n forumV1Category_universal_d_SubscribeContactToCategoryResponse as SubscribeContactToCategoryResponse,\n forumV1Category_universal_d_UnsubscribeContactFromCategoryRequest as UnsubscribeContactFromCategoryRequest,\n forumV1Category_universal_d_UnsubscribeContactFromCategoryResponse as UnsubscribeContactFromCategoryResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n forumV1Category_universal_d_getCategory as getCategory,\n forumV1Category_universal_d_GetCategoryOptions as GetCategoryOptions,\n forumV1Category_universal_d_getCategoryBySlug as getCategoryBySlug,\n forumV1Category_universal_d_GetCategoryBySlugOptions as GetCategoryBySlugOptions,\n forumV1Category_universal_d_queryCategories as queryCategories,\n forumV1Category_universal_d_QueryCategoriesOptions as QueryCategoriesOptions,\n forumV1Category_universal_d_markCategoryRead as markCategoryRead,\n forumV1Category_universal_d_markAllPostsAsRead as markAllPostsAsRead,\n forumV1Category_universal_d_MarkAllPostsAsReadOptions as MarkAllPostsAsReadOptions,\n forumV1Category_universal_d_createCategory as createCategory,\n forumV1Category_universal_d_CreateCategoryOptions as CreateCategoryOptions,\n forumV1Category_universal_d_updateCategory as updateCategory,\n forumV1Category_universal_d_UpdateCategoryOptions as UpdateCategoryOptions,\n forumV1Category_universal_d_deleteCategory as deleteCategory,\n forumV1Category_universal_d_subscribeContactToCategory as subscribeContactToCategory,\n forumV1Category_universal_d_SubscribeContactToCategoryOptions as SubscribeContactToCategoryOptions,\n forumV1Category_universal_d_unsubscribeContactFromCategory as unsubscribeContactFromCategory,\n forumV1Category_universal_d_UnsubscribeContactFromCategoryOptions as UnsubscribeContactFromCategoryOptions,\n };\n }\n \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. For example, date the latest comment was added to post.\n *\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 * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n bestAnswerCommentId?: string | null;\n /**\n * Post type. Question type posts allows comments to be voted on. This can not be changed after post is created.\n * Deprecated on '2021-08-03'.\n * @internal\n * @deprecated\n */\n postType?: PostType;\n /**\n * Contact Id of post owner.\n * Currently exposed only in created domain event.\n * @internal\n * @readonly\n */\n ownerContactId?: string | null;\n /**\n * The post content as a stringified RichContent document.\n * @internal\n * @readonly\n */\n content?: 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. */\n commentInteraction?: Interaction;\n /**\n * IDs of the marked comments for this post (selected by forum admin or post owner).\n *\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 * Total number of comment reactions.\n * @internal\n * @readonly\n */\n reactionCount?: number;\n /**\n * List of different reactions counts.\n * @internal\n * @readonly\n */\n reactionCodeCounts?: ReactionCodeCount[];\n /**\n * List of reaction identities grouped by reaction code.\n * @readonly\n */\n reactionIdentities?: ReactionIdentity[];\n }\n enum PostType {\n DISCUSSION = \"DISCUSSION\",\n QUESTION = \"QUESTION\"\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 /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n enum Interaction {\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 /**\n * Array of post fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: PostFieldField[];\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field[];\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 {\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 /**\n * Array of post fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: PostFieldField[];\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field[];\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 /**\n * Array of post fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: PostFieldField[];\n /** Array of extra post fields to be added in the response. */\n extraFields?: Field[];\n /**\n * Allows to skip calculating meta data for response.\n * @internal\n */\n skipMetaData?: boolean;\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;\n }\n enum Order {\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 /**\n * Field mask of fields to update.\n * @internal\n */\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 * @adminMethod\n * @returns Post for the provided post ID.\n */\n function getPost(postId: string, options?: GetPostOptions): Promise;\n interface GetPostOptions {\n /**\n * Array of post fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: PostFieldField[];\n /** Array of extra post fields to be included in the response. */\n extraFields?: Field[];\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 * @adminMethod\n */\n function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise;\n interface GetPostBySlugOptions {\n /**\n * Array of post fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: PostFieldField[];\n /** Array of extra post fields to be included in the response. */\n extraFields?: Field[];\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 * @adminMethod\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 /**\n * Array of post fields to be included in the response. By default, any `fieldsToInclude` not passed are not returned.\n * @internal\n * @deprecated\n */\n fieldsToInclude?: PostFieldField[];\n /** Array of extra post fields to be included in the response. */\n extraFields?: Field[];\n /**\n * Allows to skip calculating meta data for response.\n * @internal\n */\n skipMetaData?: boolean;\n }\n /**\n * Increments postViewCount of the post.\n * @param postId - ID of the read post.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_READ\n * @adminMethod\n */\n function viewPost(postId: string): Promise;\n /**\n * Marks post as read for identity who made a request.\n * @param postId - ID of the read post.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_MARK_READ\n * @adminMethod\n */\n function markPostRead(postId: string): Promise;\n /**\n * Marks posts as seen for identity who made a request.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_FORUM.POST_MARK_SEEN\n * @adminMethod\n */\n function markPostsSeen(options?: MarkPostsSeenOptions): Promise;\n interface MarkPostsSeenOptions {\n /** IDs of the seen posts. */\n postsIds?: string[];\n }\n /**\n * Marks post as unread for identity who made a request.\n * @param postId - ID of the unread post.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_MARK_READ\n * @adminMethod\n */\n function markPostUnread(postId: string): Promise;\n /**\n * Creates a new post.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.post.categoryId\n * @requiredField options.post.title\n * @permissionId WIX_FORUM.CATEGORY_CREATE_POST\n * @adminMethod\n * @returns Created post.\n */\n function createPost(options?: CreatePostOptions): Promise;\n interface CreatePostOptions {\n /** New post to create. */\n post?: Post;\n }\n /**\n * Updates post fields according to `fieldMask`.\n * @param postId - ID of the post to update.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_EDIT\n * @adminMethod\n * @returns Updated post.\n */\n function updatePost(postId: string, options?: UpdatePostOptions): Promise;\n interface UpdatePostOptions {\n /**\n * Field mask of fields to update.\n * @internal\n */\n fieldMask?: string[];\n /** Post data with partial data to update. */\n post?: Post;\n }\n /**\n * Deletes a post.\n * @param postId - ID of the post to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_DELETE\n * @adminMethod\n */\n function deletePost(postId: string): Promise;\n /**\n * Sets the \"best answer\" comment on a post.\n * @param postId - Post ID.\n * @param commentId - ID of the \"best answer\" comment on the post.\n * @internal\n * @documentationMaturity preview\n * @requiredField commentId\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_ADD_BEST_ANSWER_COMMENT\n * @adminMethod\n */\n function setBestAnswer(postId: string, commentId: string): Promise;\n /**\n * Removes \"best answer\" from a comment on a post.\n * @param postId - Post ID\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_REMOVE_BEST_ANSWER_COMMENT\n * @adminMethod\n */\n function removeBestAnswer(postId: string): Promise;\n /**\n * Pins post\n * @param postId - Post ID\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_PIN\n * @adminMethod\n */\n function pinPost(postId: string, options?: PinPostOptions): Promise;\n interface PinPostOptions {\n /** The amount of minutes after which the pin will be removed (unpinned) */\n expiresInMinutes?: number | null;\n }\n /**\n * Unpins post\n * @param postId - Post ID\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_PIN\n * @adminMethod\n */\n function unpinPost(postId: string): Promise;\n /**\n * Adds reaction to post\n * @param postId - Post ID\n * @param reactionCode - Code of reaction to add.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @requiredField reactionCode\n * @permissionId WIX_FORUM.POST_ADD_REACTION\n * @adminMethod\n */\n function addReaction(postId: string, reactionCode: string): Promise;\n /**\n * Removes reaction from post\n * @param postId - Post ID\n * @param reactionCode - Code of reaction to remove.\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @requiredField reactionCode\n * @permissionId WIX_FORUM.POST_REMOVE_REACTION\n * @adminMethod\n */\n function removeReaction(postId: string, reactionCode: string): Promise;\n /**\n * Report post\n * @param postId - Post ID\n * @internal\n * @documentationMaturity preview\n * @requiredField postId\n * @permissionId WIX_FORUM.POST_POST_REPORT\n * @adminMethod\n */\n function reportPost(postId: string, options?: ReportPostOptions): Promise;\n interface ReportPostOptions {\n /** Type of report. */\n reportType?: ReportType;\n }\n \n type forumV1Post_universal_d_Post = Post;\n type forumV1Post_universal_d_PostType = PostType;\n const forumV1Post_universal_d_PostType: typeof PostType;\n type forumV1Post_universal_d_FocalPoint = FocalPoint;\n type forumV1Post_universal_d_VideoResolution = VideoResolution;\n type forumV1Post_universal_d_Interaction = Interaction;\n const forumV1Post_universal_d_Interaction: typeof Interaction;\n type forumV1Post_universal_d_RecentActivity = RecentActivity;\n type forumV1Post_universal_d_RecentActivityInitiatorOneOf = RecentActivityInitiatorOneOf;\n type forumV1Post_universal_d_EntityType = EntityType;\n const forumV1Post_universal_d_EntityType: typeof EntityType;\n type forumV1Post_universal_d_ReactionCodeCount = ReactionCodeCount;\n type forumV1Post_universal_d_ReactionIdentity = ReactionIdentity;\n type forumV1Post_universal_d_IdentityType = IdentityType;\n const forumV1Post_universal_d_IdentityType: typeof IdentityType;\n type forumV1Post_universal_d_Identity = Identity;\n type forumV1Post_universal_d_Moved = Moved;\n type forumV1Post_universal_d_Liked = Liked;\n type forumV1Post_universal_d_Unliked = Unliked;\n type forumV1Post_universal_d_Pinned = Pinned;\n type forumV1Post_universal_d_Unpinned = Unpinned;\n type forumV1Post_universal_d_Closed = Closed;\n type forumV1Post_universal_d_Opened = Opened;\n type forumV1Post_universal_d_Reported = Reported;\n type forumV1Post_universal_d_ReportType = ReportType;\n const forumV1Post_universal_d_ReportType: typeof ReportType;\n type forumV1Post_universal_d_Reacted = Reacted;\n type forumV1Post_universal_d_Unreacted = Unreacted;\n type forumV1Post_universal_d_PostRequest = PostRequest;\n type forumV1Post_universal_d_PostFieldField = PostFieldField;\n const forumV1Post_universal_d_PostFieldField: typeof PostFieldField;\n type forumV1Post_universal_d_Field = Field;\n const forumV1Post_universal_d_Field: typeof Field;\n type forumV1Post_universal_d_PostResponse = PostResponse;\n type forumV1Post_universal_d_PostSlugRequest = PostSlugRequest;\n type forumV1Post_universal_d_QueryPostsRequest = QueryPostsRequest;\n type forumV1Post_universal_d_PostsPaging = PostsPaging;\n type forumV1Post_universal_d_PostsSort = PostsSort;\n type forumV1Post_universal_d_Order = Order;\n const forumV1Post_universal_d_Order: typeof Order;\n type forumV1Post_universal_d_QueryPostsResponse = QueryPostsResponse;\n type forumV1Post_universal_d_QueryPostsResponseMetaData = QueryPostsResponseMetaData;\n type forumV1Post_universal_d_ViewPostRequest = ViewPostRequest;\n type forumV1Post_universal_d_ViewPostResponse = ViewPostResponse;\n type forumV1Post_universal_d_MarkPostReadRequest = MarkPostReadRequest;\n type forumV1Post_universal_d_MarkPostReadResponse = MarkPostReadResponse;\n type forumV1Post_universal_d_MarkPostsSeenRequest = MarkPostsSeenRequest;\n type forumV1Post_universal_d_MarkPostsSeenResponse = MarkPostsSeenResponse;\n type forumV1Post_universal_d_MarkPostUnreadRequest = MarkPostUnreadRequest;\n type forumV1Post_universal_d_MarkPostUnreadResponse = MarkPostUnreadResponse;\n type forumV1Post_universal_d_CreatePostRequest = CreatePostRequest;\n type forumV1Post_universal_d_CreatePostResponse = CreatePostResponse;\n type forumV1Post_universal_d_UpdatePostRequest = UpdatePostRequest;\n type forumV1Post_universal_d_UpdatePostResponse = UpdatePostResponse;\n type forumV1Post_universal_d_DeletePostRequest = DeletePostRequest;\n type forumV1Post_universal_d_DeletePostResponse = DeletePostResponse;\n type forumV1Post_universal_d_SetBestAnswerRequest = SetBestAnswerRequest;\n type forumV1Post_universal_d_SetBestAnswerResponse = SetBestAnswerResponse;\n type forumV1Post_universal_d_RemoveBestAnswerRequest = RemoveBestAnswerRequest;\n type forumV1Post_universal_d_RemoveBestAnswerResponse = RemoveBestAnswerResponse;\n type forumV1Post_universal_d_PinPostRequest = PinPostRequest;\n type forumV1Post_universal_d_PinPostResponse = PinPostResponse;\n type forumV1Post_universal_d_UnpinPostRequest = UnpinPostRequest;\n type forumV1Post_universal_d_UnpinPostResponse = UnpinPostResponse;\n type forumV1Post_universal_d_AddReactionRequest = AddReactionRequest;\n type forumV1Post_universal_d_AddReactionResponse = AddReactionResponse;\n type forumV1Post_universal_d_RemoveReactionRequest = RemoveReactionRequest;\n type forumV1Post_universal_d_RemoveReactionResponse = RemoveReactionResponse;\n type forumV1Post_universal_d_ReportPostRequest = ReportPostRequest;\n type forumV1Post_universal_d_ReportPostResponse = ReportPostResponse;\n type forumV1Post_universal_d_DomainEvent = DomainEvent;\n type forumV1Post_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type forumV1Post_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type forumV1Post_universal_d_RestoreInfo = RestoreInfo;\n type forumV1Post_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type forumV1Post_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type forumV1Post_universal_d_ActionEvent = ActionEvent;\n type forumV1Post_universal_d_MessageEnvelope = MessageEnvelope;\n type forumV1Post_universal_d_IdentificationData = IdentificationData;\n type forumV1Post_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type forumV1Post_universal_d_WebhookIdentityType = WebhookIdentityType;\n const forumV1Post_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const forumV1Post_universal_d_getPost: typeof getPost;\n type forumV1Post_universal_d_GetPostOptions = GetPostOptions;\n const forumV1Post_universal_d_getPostBySlug: typeof getPostBySlug;\n type forumV1Post_universal_d_GetPostBySlugOptions = GetPostBySlugOptions;\n const forumV1Post_universal_d_queryPosts: typeof queryPosts;\n type forumV1Post_universal_d_QueryPostsOptions = QueryPostsOptions;\n const forumV1Post_universal_d_viewPost: typeof viewPost;\n const forumV1Post_universal_d_markPostRead: typeof markPostRead;\n const forumV1Post_universal_d_markPostsSeen: typeof markPostsSeen;\n type forumV1Post_universal_d_MarkPostsSeenOptions = MarkPostsSeenOptions;\n const forumV1Post_universal_d_markPostUnread: typeof markPostUnread;\n const forumV1Post_universal_d_createPost: typeof createPost;\n type forumV1Post_universal_d_CreatePostOptions = CreatePostOptions;\n const forumV1Post_universal_d_updatePost: typeof updatePost;\n type forumV1Post_universal_d_UpdatePostOptions = UpdatePostOptions;\n const forumV1Post_universal_d_deletePost: typeof deletePost;\n const forumV1Post_universal_d_setBestAnswer: typeof setBestAnswer;\n const forumV1Post_universal_d_removeBestAnswer: typeof removeBestAnswer;\n const forumV1Post_universal_d_pinPost: typeof pinPost;\n type forumV1Post_universal_d_PinPostOptions = PinPostOptions;\n const forumV1Post_universal_d_unpinPost: typeof unpinPost;\n const forumV1Post_universal_d_addReaction: typeof addReaction;\n const forumV1Post_universal_d_removeReaction: typeof removeReaction;\n const forumV1Post_universal_d_reportPost: typeof reportPost;\n type forumV1Post_universal_d_ReportPostOptions = ReportPostOptions;\n namespace forumV1Post_universal_d {\n export {\n forumV1Post_universal_d_Post as Post,\n forumV1Post_universal_d_PostType as PostType,\n forumV1Post_universal_d_FocalPoint as FocalPoint,\n forumV1Post_universal_d_VideoResolution as VideoResolution,\n forumV1Post_universal_d_Interaction as Interaction,\n forumV1Post_universal_d_RecentActivity as RecentActivity,\n forumV1Post_universal_d_RecentActivityInitiatorOneOf as RecentActivityInitiatorOneOf,\n forumV1Post_universal_d_EntityType as EntityType,\n forumV1Post_universal_d_ReactionCodeCount as ReactionCodeCount,\n forumV1Post_universal_d_ReactionIdentity as ReactionIdentity,\n forumV1Post_universal_d_IdentityType as IdentityType,\n forumV1Post_universal_d_Identity as Identity,\n forumV1Post_universal_d_Moved as Moved,\n forumV1Post_universal_d_Liked as Liked,\n forumV1Post_universal_d_Unliked as Unliked,\n forumV1Post_universal_d_Pinned as Pinned,\n forumV1Post_universal_d_Unpinned as Unpinned,\n forumV1Post_universal_d_Closed as Closed,\n forumV1Post_universal_d_Opened as Opened,\n forumV1Post_universal_d_Reported as Reported,\n forumV1Post_universal_d_ReportType as ReportType,\n forumV1Post_universal_d_Reacted as Reacted,\n forumV1Post_universal_d_Unreacted as Unreacted,\n forumV1Post_universal_d_PostRequest as PostRequest,\n forumV1Post_universal_d_PostFieldField as PostFieldField,\n forumV1Post_universal_d_Field as Field,\n forumV1Post_universal_d_PostResponse as PostResponse,\n forumV1Post_universal_d_PostSlugRequest as PostSlugRequest,\n forumV1Post_universal_d_QueryPostsRequest as QueryPostsRequest,\n forumV1Post_universal_d_PostsPaging as PostsPaging,\n forumV1Post_universal_d_PostsSort as PostsSort,\n forumV1Post_universal_d_Order as Order,\n forumV1Post_universal_d_QueryPostsResponse as QueryPostsResponse,\n forumV1Post_universal_d_QueryPostsResponseMetaData as QueryPostsResponseMetaData,\n forumV1Post_universal_d_ViewPostRequest as ViewPostRequest,\n forumV1Post_universal_d_ViewPostResponse as ViewPostResponse,\n forumV1Post_universal_d_MarkPostReadRequest as MarkPostReadRequest,\n forumV1Post_universal_d_MarkPostReadResponse as MarkPostReadResponse,\n forumV1Post_universal_d_MarkPostsSeenRequest as MarkPostsSeenRequest,\n forumV1Post_universal_d_MarkPostsSeenResponse as MarkPostsSeenResponse,\n forumV1Post_universal_d_MarkPostUnreadRequest as MarkPostUnreadRequest,\n forumV1Post_universal_d_MarkPostUnreadResponse as MarkPostUnreadResponse,\n forumV1Post_universal_d_CreatePostRequest as CreatePostRequest,\n forumV1Post_universal_d_CreatePostResponse as CreatePostResponse,\n forumV1Post_universal_d_UpdatePostRequest as UpdatePostRequest,\n forumV1Post_universal_d_UpdatePostResponse as UpdatePostResponse,\n forumV1Post_universal_d_DeletePostRequest as DeletePostRequest,\n forumV1Post_universal_d_DeletePostResponse as DeletePostResponse,\n forumV1Post_universal_d_SetBestAnswerRequest as SetBestAnswerRequest,\n forumV1Post_universal_d_SetBestAnswerResponse as SetBestAnswerResponse,\n forumV1Post_universal_d_RemoveBestAnswerRequest as RemoveBestAnswerRequest,\n forumV1Post_universal_d_RemoveBestAnswerResponse as RemoveBestAnswerResponse,\n forumV1Post_universal_d_PinPostRequest as PinPostRequest,\n forumV1Post_universal_d_PinPostResponse as PinPostResponse,\n forumV1Post_universal_d_UnpinPostRequest as UnpinPostRequest,\n forumV1Post_universal_d_UnpinPostResponse as UnpinPostResponse,\n forumV1Post_universal_d_AddReactionRequest as AddReactionRequest,\n forumV1Post_universal_d_AddReactionResponse as AddReactionResponse,\n forumV1Post_universal_d_RemoveReactionRequest as RemoveReactionRequest,\n forumV1Post_universal_d_RemoveReactionResponse as RemoveReactionResponse,\n forumV1Post_universal_d_ReportPostRequest as ReportPostRequest,\n forumV1Post_universal_d_ReportPostResponse as ReportPostResponse,\n forumV1Post_universal_d_DomainEvent as DomainEvent,\n forumV1Post_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n forumV1Post_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n forumV1Post_universal_d_RestoreInfo as RestoreInfo,\n forumV1Post_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n forumV1Post_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n forumV1Post_universal_d_ActionEvent as ActionEvent,\n forumV1Post_universal_d_MessageEnvelope as MessageEnvelope,\n forumV1Post_universal_d_IdentificationData as IdentificationData,\n forumV1Post_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n forumV1Post_universal_d_WebhookIdentityType as WebhookIdentityType,\n forumV1Post_universal_d_getPost as getPost,\n forumV1Post_universal_d_GetPostOptions as GetPostOptions,\n forumV1Post_universal_d_getPostBySlug as getPostBySlug,\n forumV1Post_universal_d_GetPostBySlugOptions as GetPostBySlugOptions,\n forumV1Post_universal_d_queryPosts as queryPosts,\n forumV1Post_universal_d_QueryPostsOptions as QueryPostsOptions,\n forumV1Post_universal_d_viewPost as viewPost,\n forumV1Post_universal_d_markPostRead as markPostRead,\n forumV1Post_universal_d_markPostsSeen as markPostsSeen,\n forumV1Post_universal_d_MarkPostsSeenOptions as MarkPostsSeenOptions,\n forumV1Post_universal_d_markPostUnread as markPostUnread,\n forumV1Post_universal_d_createPost as createPost,\n forumV1Post_universal_d_CreatePostOptions as CreatePostOptions,\n forumV1Post_universal_d_updatePost as updatePost,\n forumV1Post_universal_d_UpdatePostOptions as UpdatePostOptions,\n forumV1Post_universal_d_deletePost as deletePost,\n forumV1Post_universal_d_setBestAnswer as setBestAnswer,\n forumV1Post_universal_d_removeBestAnswer as removeBestAnswer,\n forumV1Post_universal_d_pinPost as pinPost,\n forumV1Post_universal_d_PinPostOptions as PinPostOptions,\n forumV1Post_universal_d_unpinPost as unpinPost,\n forumV1Post_universal_d_addReaction as addReaction,\n forumV1Post_universal_d_removeReaction as removeReaction,\n forumV1Post_universal_d_reportPost as reportPost,\n forumV1Post_universal_d_ReportPostOptions as ReportPostOptions,\n };\n }\n \n export { forumV1Category_universal_d as categories, forumV1Post_universal_d as posts };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 * 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 * @internal\n */\n hasNext?: 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * @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 * @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 */\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 * @permissionId MEMBERS.ACTIVITY_COUNTERS_READ\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 \n type membersV1ActivityCounter_universal_d_ActivityCounter = ActivityCounter;\n type membersV1ActivityCounter_universal_d_Counter = Counter;\n type membersV1ActivityCounter_universal_d_SetActivityCountersRequest = SetActivityCountersRequest;\n type membersV1ActivityCounter_universal_d_SetActivityCountersResponse = SetActivityCountersResponse;\n type membersV1ActivityCounter_universal_d_IncrementActivityCountersRequest = IncrementActivityCountersRequest;\n type membersV1ActivityCounter_universal_d_IncrementActivityCountersResponse = IncrementActivityCountersResponse;\n type membersV1ActivityCounter_universal_d_GetActivityCountersRequest = GetActivityCountersRequest;\n type membersV1ActivityCounter_universal_d_GetActivityCountersResponse = GetActivityCountersResponse;\n type membersV1ActivityCounter_universal_d_QueryActivityCountersRequest = QueryActivityCountersRequest;\n type membersV1ActivityCounter_universal_d_Query = Query;\n type membersV1ActivityCounter_universal_d_Paging = Paging;\n type membersV1ActivityCounter_universal_d_QueryActivityCountersResponse = QueryActivityCountersResponse;\n type membersV1ActivityCounter_universal_d_PagingMetadata = PagingMetadata;\n type membersV1ActivityCounter_universal_d_DomainEvent = DomainEvent;\n type membersV1ActivityCounter_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type membersV1ActivityCounter_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type membersV1ActivityCounter_universal_d_RestoreInfo = RestoreInfo;\n type membersV1ActivityCounter_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type membersV1ActivityCounter_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type membersV1ActivityCounter_universal_d_ActionEvent = ActionEvent;\n type membersV1ActivityCounter_universal_d_Empty = Empty;\n type membersV1ActivityCounter_universal_d_MessageEnvelope = MessageEnvelope;\n type membersV1ActivityCounter_universal_d_IdentificationData = IdentificationData;\n type membersV1ActivityCounter_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type membersV1ActivityCounter_universal_d_WebhookIdentityType = WebhookIdentityType;\n const membersV1ActivityCounter_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const membersV1ActivityCounter_universal_d_setActivityCounters: typeof setActivityCounters;\n const membersV1ActivityCounter_universal_d_incrementActivityCounters: typeof incrementActivityCounters;\n const membersV1ActivityCounter_universal_d_getActivityCounters: typeof getActivityCounters;\n const membersV1ActivityCounter_universal_d_queryActivityCounters: typeof queryActivityCounters;\n type membersV1ActivityCounter_universal_d_ActivityCountersQueryResult = ActivityCountersQueryResult;\n type membersV1ActivityCounter_universal_d_ActivityCountersQueryBuilder = ActivityCountersQueryBuilder;\n namespace membersV1ActivityCounter_universal_d {\n export {\n membersV1ActivityCounter_universal_d_ActivityCounter as ActivityCounter,\n membersV1ActivityCounter_universal_d_Counter as Counter,\n membersV1ActivityCounter_universal_d_SetActivityCountersRequest as SetActivityCountersRequest,\n membersV1ActivityCounter_universal_d_SetActivityCountersResponse as SetActivityCountersResponse,\n membersV1ActivityCounter_universal_d_IncrementActivityCountersRequest as IncrementActivityCountersRequest,\n membersV1ActivityCounter_universal_d_IncrementActivityCountersResponse as IncrementActivityCountersResponse,\n membersV1ActivityCounter_universal_d_GetActivityCountersRequest as GetActivityCountersRequest,\n membersV1ActivityCounter_universal_d_GetActivityCountersResponse as GetActivityCountersResponse,\n membersV1ActivityCounter_universal_d_QueryActivityCountersRequest as QueryActivityCountersRequest,\n membersV1ActivityCounter_universal_d_Query as Query,\n membersV1ActivityCounter_universal_d_Paging as Paging,\n membersV1ActivityCounter_universal_d_QueryActivityCountersResponse as QueryActivityCountersResponse,\n membersV1ActivityCounter_universal_d_PagingMetadata as PagingMetadata,\n membersV1ActivityCounter_universal_d_DomainEvent as DomainEvent,\n membersV1ActivityCounter_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n membersV1ActivityCounter_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n membersV1ActivityCounter_universal_d_RestoreInfo as RestoreInfo,\n membersV1ActivityCounter_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n membersV1ActivityCounter_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n membersV1ActivityCounter_universal_d_ActionEvent as ActionEvent,\n membersV1ActivityCounter_universal_d_Empty as Empty,\n membersV1ActivityCounter_universal_d_MessageEnvelope as MessageEnvelope,\n membersV1ActivityCounter_universal_d_IdentificationData as IdentificationData,\n membersV1ActivityCounter_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n membersV1ActivityCounter_universal_d_WebhookIdentityType as WebhookIdentityType,\n membersV1ActivityCounter_universal_d_setActivityCounters as setActivityCounters,\n membersV1ActivityCounter_universal_d_incrementActivityCounters as incrementActivityCounters,\n membersV1ActivityCounter_universal_d_getActivityCounters as getActivityCounters,\n membersV1ActivityCounter_universal_d_queryActivityCounters as queryActivityCounters,\n membersV1ActivityCounter_universal_d_ActivityCountersQueryResult as ActivityCountersQueryResult,\n membersV1ActivityCounter_universal_d_ActivityCountersQueryBuilder as ActivityCountersQueryBuilder,\n };\n }\n \n export { membersV1ActivityCounter_universal_d as activityCounters };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-loyalty.v2.d.ts", "content": "declare module \"wix-loyalty.v2\" {\n /** A loyalty checkout discount represents a discount applied to a checkout using loyalty rewards, coupons, or referral rewards. */\n interface LoyaltyCheckoutDiscount extends LoyaltyCheckoutDiscountDiscountOneOf {\n /** ID of the loyalty reward used for this discount. */\n rewardId?: string;\n /** ID of the loyalty coupon used for this discount. */\n loyaltyCouponId?: string;\n /** ID of the referral reward used for this discount. */\n referralRewardId?: string;\n /**\n * Loyalty checkout discount ID.\n * @readonly\n */\n _id?: string;\n /** ID of the checkout this discount is applied to. */\n checkoutId?: string;\n /**\n * Current status of the discount.\n * @readonly\n */\n status?: DiscountStatus;\n /**\n * The type of discount applied.\n * @readonly\n */\n discountType?: DiscountType;\n }\n /** @oneof */\n interface LoyaltyCheckoutDiscountDiscountOneOf {\n /** ID of the loyalty reward used for this discount. */\n rewardId?: string;\n /** ID of the loyalty coupon used for this discount. */\n loyaltyCouponId?: string;\n /** ID of the referral reward used for this discount. */\n referralRewardId?: string;\n }\n enum DiscountStatus {\n /** Status is unknown or not specified. */\n UNKNOWN = \"UNKNOWN\",\n /** Discount has been applied to the checkout. */\n APPLIED = \"APPLIED\",\n /** Discount application is in progress. */\n IN_PROGRESS = \"IN_PROGRESS\",\n /** Discount has been successfully completed. */\n COMPLETED = \"COMPLETED\",\n /** Discount has been refunded. */\n REFUNDED = \"REFUNDED\",\n /** Attempt to refund the discount failed. */\n FAILED_TO_REFUND = \"FAILED_TO_REFUND\",\n /** Discount was refunded due to a timeout. */\n REFUNDED_DUE_TO_TIMEOUT = \"REFUNDED_DUE_TO_TIMEOUT\",\n /** Discount was refunded due to manual removal. */\n REFUNDED_DUE_TO_MANUAL_DISCOUNT_REMOVAL = \"REFUNDED_DUE_TO_MANUAL_DISCOUNT_REMOVAL\",\n /** Discount is scheduled for refund. */\n SCHEDULED_FOR_REFUND = \"SCHEDULED_FOR_REFUND\",\n /** Discount was not used. */\n UNUSED = \"UNUSED\"\n }\n enum DiscountType {\n /** Discount type is unknown or not specified. */\n UNKNOWN = \"UNKNOWN\",\n /** A discount from a flexible reward. */\n DISCOUNT_AMOUNT = \"DISCOUNT_AMOUNT\",\n /** A discount from a redeemed loyalty program coupon. */\n LOYALTY_COUPON = \"LOYALTY_COUPON\",\n /** A discount from a coupon reward that has not yet been redeemed. */\n COUPON_REWARD = \"COUPON_REWARD\",\n /** A discount from a referral reward. */\n REFERRAL_REWARD = \"REFERRAL_REWARD\"\n }\n /** Request to apply a discount to a checkout. */\n interface ApplyDiscountToCheckoutRequest extends ApplyDiscountToCheckoutRequestDiscountOneOf {\n /** Unredeemed loyalty reward discount. */\n reward?: Reward$1;\n /** Loyalty coupon discount. */\n loyaltyCoupon?: LoyaltyCoupon$1;\n /** Referral reward discount. */\n referralReward?: ReferralReward;\n /** ID of the checkout to apply the discount to. */\n checkoutId: string;\n }\n /** @oneof */\n interface ApplyDiscountToCheckoutRequestDiscountOneOf {\n /** Unredeemed loyalty reward discount. */\n reward?: Reward$1;\n /** Loyalty coupon discount. */\n loyaltyCoupon?: LoyaltyCoupon$1;\n /** Referral reward discount. */\n referralReward?: ReferralReward;\n }\n interface Reward$1 {\n /** ID of the loyalty reward to be used for this discount. */\n _id?: string;\n /**\n * Number of points to spend for this reward.\n * For example, if the reward is 10 points = $1, then 35 points would give a $3.50 discount.\n *\n * >**Note:** Only relevant when using a flexible type reward. Depending on how your loyalty program is set up, there may be a minimum number of points you must spend.\n */\n pointsToSpend?: number | null;\n /**\n * Revision of the reward object. Incremented by 1 each time the reward object is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string;\n }\n interface LoyaltyCoupon$1 {\n /** ID of the loyalty coupon to be used for this discount. */\n _id?: string;\n /**\n * Revision of the coupon object. Incremented by 1 each time the coupon object is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string;\n }\n interface ReferralReward {\n /** Referral reward discount ID. */\n _id?: string;\n /**\n * Revision of the referral object. Incremented by 1 each time the referral object is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string;\n }\n /** Response after applying a discount to a checkout. */\n interface ApplyDiscountToCheckoutResponse {\n /** The applied loyalty checkout discount. */\n discount?: LoyaltyCheckoutDiscount;\n }\n interface DiscountRefundedDueToManualDiscountRemoval {\n /** Loyalty checkout discount refunded due to manual removal. */\n discount?: LoyaltyCheckoutDiscount;\n }\n interface DiscountRefundedDueToTimeout {\n /** Loyalty checkout discount refunded due to timeout. */\n discount?: LoyaltyCheckoutDiscount;\n }\n interface DiscountScheduledForRefund {\n /** Loyalty checkout discount scheduled for refund. */\n discount?: LoyaltyCheckoutDiscount;\n }\n interface QueryLoyaltyCheckoutDiscountsRequest {\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$5;\n }\n interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {\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$6;\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$5[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$5 {\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$6;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$5 {\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 /** Response from querying loyalty checkout discounts. */\n interface QueryLoyaltyCheckoutDiscountsResponse {\n /** List of loyalty checkout discounts matching the query. */\n loyaltyCheckoutDiscounts?: LoyaltyCheckoutDiscount[];\n /** Paging metadata for the response. */\n pagingMetadata?: CursorPagingMetadata$4;\n }\n interface CursorPagingMetadata$4 {\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$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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$9;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$9 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$9 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$9 {\n bodyAsJson?: string;\n }\n interface Empty$9 {\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 * Applies a discount to a checkout.\n *\n * You can apply one of the following discounts, which are exchanged for loyalty points: `reward`, `loyaltyCoupon`, or `referralReward`.\n * @param checkoutId - ID of the checkout to apply the discount to.\n * @public\n * @requiredField checkoutId\n * @permissionId LOYALTY.REDEEM_OWN_COUPON\n * @returns Response after applying a discount to a checkout.\n */\n function applyDiscountToCheckout(checkoutId: string, options?: ApplyDiscountToCheckoutOptions): Promise;\n interface ApplyDiscountToCheckoutOptions extends ApplyDiscountToCheckoutRequestDiscountOneOf {\n /** Unredeemed loyalty reward discount. */\n reward?: Reward$1;\n /** Loyalty coupon discount. */\n loyaltyCoupon?: LoyaltyCoupon$1;\n /** Referral reward discount. */\n referralReward?: ReferralReward;\n }\n /**\n * Creates a query to retrieve a list of checkout discounts.\n *\n * The `queryLoyaltyCheckoutDiscount()` function builds a query to retrieve a list of checkout discounts and returns a `LoyaltyCheckoutDiscountQueryBuilder` 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 `LoyaltyCheckoutDiscountQueryBuilder` functions onto the query. `LoyaltyCheckoutDiscountQueryBuilder` functions enable you to sort, filter, and control the results `queryLoyaltyCheckoutDiscount()` returns.\n *\n * `queryLoyaltyCheckoutDiscount()` runs with these `LoyaltyCheckoutDiscountQueryBuilder` defaults, which you can override:\n *\n * - `limit(50)`\n * - `descending(\"_createdDate\")`\n *\n * The functions that are chained to `queryLoyaltyCheckoutDiscount()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('checkoutId'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by checkout ID.\n * @public\n * @permissionId LOYALTY.QUERY_CHECKOUT_DISCOUNTS\n */\n function queryLoyaltyCheckoutDiscounts(): LoyaltyCheckoutDiscountsQueryBuilder;\n interface QueryCursorResult$4 {\n cursors: Cursors$6;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyCheckoutDiscountsQueryResult extends QueryCursorResult$4 {\n items: LoyaltyCheckoutDiscount[];\n query: LoyaltyCheckoutDiscountsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LoyaltyCheckoutDiscountsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: 'checkoutId' | 'status', value: any) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: 'checkoutId' | 'status', value: any) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `string`.\n * @param string - String to compare against. Case-insensitive.\n */\n startsWith: (propertyName: 'checkoutId', value: string) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: 'checkoutId' | 'status', value: any[]) => LoyaltyCheckoutDiscountsQueryBuilder;\n in: (propertyName: 'checkoutId' | 'status', value: any) => LoyaltyCheckoutDiscountsQueryBuilder;\n exists: (propertyName: 'checkoutId' | 'status', value: boolean) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<'checkoutId' | 'status'>) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'checkoutId' | 'status'>) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => LoyaltyCheckoutDiscountsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => LoyaltyCheckoutDiscountsQueryBuilder;\n find: () => Promise;\n }\n \n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscount = LoyaltyCheckoutDiscount;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscountDiscountOneOf = LoyaltyCheckoutDiscountDiscountOneOf;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountStatus = DiscountStatus;\n const loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountStatus: typeof DiscountStatus;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountType = DiscountType;\n const loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountType: typeof DiscountType;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutRequest = ApplyDiscountToCheckoutRequest;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutRequestDiscountOneOf = ApplyDiscountToCheckoutRequestDiscountOneOf;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ReferralReward = ReferralReward;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutResponse = ApplyDiscountToCheckoutResponse;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountRefundedDueToManualDiscountRemoval = DiscountRefundedDueToManualDiscountRemoval;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountRefundedDueToTimeout = DiscountRefundedDueToTimeout;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountScheduledForRefund = DiscountScheduledForRefund;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_QueryLoyaltyCheckoutDiscountsRequest = QueryLoyaltyCheckoutDiscountsRequest;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_QueryLoyaltyCheckoutDiscountsResponse = QueryLoyaltyCheckoutDiscountsResponse;\n const loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_applyDiscountToCheckout: typeof applyDiscountToCheckout;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutOptions = ApplyDiscountToCheckoutOptions;\n const loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_queryLoyaltyCheckoutDiscounts: typeof queryLoyaltyCheckoutDiscounts;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscountsQueryResult = LoyaltyCheckoutDiscountsQueryResult;\n type loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscountsQueryBuilder = LoyaltyCheckoutDiscountsQueryBuilder;\n namespace loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d {\n export {\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscount as LoyaltyCheckoutDiscount,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscountDiscountOneOf as LoyaltyCheckoutDiscountDiscountOneOf,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountStatus as DiscountStatus,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountType as DiscountType,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutRequest as ApplyDiscountToCheckoutRequest,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutRequestDiscountOneOf as ApplyDiscountToCheckoutRequestDiscountOneOf,\n Reward$1 as Reward,\n LoyaltyCoupon$1 as LoyaltyCoupon,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ReferralReward as ReferralReward,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutResponse as ApplyDiscountToCheckoutResponse,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountRefundedDueToManualDiscountRemoval as DiscountRefundedDueToManualDiscountRemoval,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountRefundedDueToTimeout as DiscountRefundedDueToTimeout,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_DiscountScheduledForRefund as DiscountScheduledForRefund,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_QueryLoyaltyCheckoutDiscountsRequest as QueryLoyaltyCheckoutDiscountsRequest,\n CursorQuery$5 as CursorQuery,\n CursorQueryPagingMethodOneOf$5 as CursorQueryPagingMethodOneOf,\n Sorting$5 as Sorting,\n SortOrder$5 as SortOrder,\n CursorPaging$6 as CursorPaging,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_QueryLoyaltyCheckoutDiscountsResponse as QueryLoyaltyCheckoutDiscountsResponse,\n CursorPagingMetadata$4 as CursorPagingMetadata,\n Cursors$6 as Cursors,\n DomainEvent$9 as DomainEvent,\n DomainEventBodyOneOf$9 as DomainEventBodyOneOf,\n EntityCreatedEvent$9 as EntityCreatedEvent,\n RestoreInfo$9 as RestoreInfo,\n EntityUpdatedEvent$9 as EntityUpdatedEvent,\n EntityDeletedEvent$9 as EntityDeletedEvent,\n ActionEvent$9 as ActionEvent,\n Empty$9 as Empty,\n MessageEnvelope$9 as MessageEnvelope,\n IdentificationData$9 as IdentificationData,\n IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf,\n WebhookIdentityType$9 as WebhookIdentityType,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_applyDiscountToCheckout as applyDiscountToCheckout,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_ApplyDiscountToCheckoutOptions as ApplyDiscountToCheckoutOptions,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_queryLoyaltyCheckoutDiscounts as queryLoyaltyCheckoutDiscounts,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscountsQueryResult as LoyaltyCheckoutDiscountsQueryResult,\n loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d_LoyaltyCheckoutDiscountsQueryBuilder as LoyaltyCheckoutDiscountsQueryBuilder,\n };\n }\n \n /**\n * An Import object is a batch import of loyalty points for existing customers.\n * You can use Loyalty Imports to import loyalty points from 3rd-party providers or update existing customer point balances.\n * This object tracks the entire import process from file upload to data processing.\n */\n interface LoyaltyImport {\n /**\n * The ID of the import.\n * @readonly\n */\n _id?: string | null;\n /**\n * ID of the asynchronous import job associated with this import.\n * @readonly\n */\n asyncImportJobId?: string | null;\n /**\n * Revision number, which increments by 1 each time the Loyalty Import is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the Loyalty Import.\n *\n * Ignored when creating a Loyalty Import.\n * @readonly\n */\n revision?: string | null;\n /**\n * Date and time the Loyalty Import was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the Loyalty Import was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Current status of the import process.\n * @readonly\n */\n status?: ImportStatus;\n /** Metadata of the uploaded file containing loyalty points data. */\n fileMetadata?: FileMetadata;\n /** Results of parsing the uploaded file, including the number of rows parsed and any parse errors. */\n parseResult?: ParseResult;\n /** Results of the import process, including success and failure counts. */\n importResult?: ImportResult;\n }\n enum ImportStatus {\n /** Status is unknown or not specified. */\n UNKNOWN = \"UNKNOWN\",\n /** The import has been initiated but processing has not yet begun. */\n INITIATED = \"INITIATED\",\n /** The system is currently parsing the import file. */\n PARSING = \"PARSING\",\n /** The import file has been successfully parsed and is ready for importing. */\n PARSED = \"PARSED\",\n /** The system is currently importing the parsed data. */\n IMPORTING = \"IMPORTING\",\n /** The import process is complete. This status indicates the process finished, but doesn't guarantee all data imported successfully. */\n IMPORTED = \"IMPORTED\",\n /** The import process has failed. */\n FAILED = \"FAILED\"\n }\n interface FileMetadata {\n /**\n * Size of the uploaded file in bytes. Max: `10 MB`.\n * @readonly\n */\n size?: number | null;\n /**\n * Name of the uploaded file.\n * @readonly\n */\n name?: string | null;\n /** URL of the uploaded file. */\n url?: string;\n /** Column headings from the first row of the uploaded CSV file. */\n header?: FileHeader;\n /**\n * Mapping between loyalty data fields and the corresponding columns in the uploaded file.\n *\n * Must include mappings for both `EMAIL` and `POINTS` to be valid.\n */\n headerMappingInfo?: HeaderMappingInfo;\n /** Up to 5 sample rows from the import file, providing a preview of the data to be imported. */\n sampleDataRows?: SampleDataRow[];\n }\n interface FileHeader {\n /** Column headings from the first row of the uploaded file. */\n values?: string[];\n }\n interface HeaderMappingInfo {\n /**\n * Mappings between required loyalty data fields and file columns.\n * Must contain exactly 2 mappings: one for `EMAIL` and one for `POINTS`.\n */\n headerMappings?: HeaderMapping[];\n }\n interface HeaderMapping {\n /** The required loyalty data field that this mapping corresponds to. Must be either `EMAIL` or `POINTS`. */\n columnName?: ColumnName;\n /**\n * The zero-based index of the column in the uploaded file that contains the data for this loyalty field.\n * For example, if the email addresses are in the second column of the CSV file, this value would be 1.\n */\n columnIndex?: number;\n }\n enum ColumnName {\n /** Column containing the customer's email address. */\n EMAIL = \"EMAIL\",\n /** Column containing the customer's loyalty point balance to be imported or updated. */\n POINTS = \"POINTS\"\n }\n interface SampleDataRow {\n /**\n * Values in one sample data row. Each value corresponds to a column in the CSV file.\n * The number of values matches the number of columns in the file.\n */\n values?: string[];\n }\n interface ParseResult {\n /**\n * Number of rows parsed from the uploaded import file.\n * @readonly\n */\n parsedRowCount?: number | null;\n /**\n * Reason code explaining why parsing failed, if applicable.\n * @readonly\n */\n parseErrorReason?: string | null;\n }\n interface ImportResult {\n /** Whether an error file detailing import failures is available for download. The file includes row-by-row import status, error reasons, and original data. */\n errorFileExists?: boolean;\n /**\n * Number of rows successfully imported.\n * @readonly\n */\n successCount?: number | null;\n /**\n * Number of rows that failed to import due to errors.\n * @readonly\n */\n failureCount?: number | null;\n }\n interface CreateLoyaltyImportRequest {\n /** URL of the file to import. */\n fileUrl: string | null;\n /** Name of the file to import. */\n fileName?: string | null;\n /** Size of the file to import, in bytes. */\n fileSize?: number | null;\n }\n interface CreateLoyaltyImportResponse {\n /** Created loyalty import. */\n loyaltyImport?: LoyaltyImport;\n }\n interface GetLoyaltyImportRequest {\n /** Loyalty import ID. */\n loyaltyImportId: string;\n }\n interface GetLoyaltyImportResponse {\n /** Retrieved loyalty import. */\n loyaltyImport?: LoyaltyImport;\n }\n interface GetErrorFileDownloadUrlRequest {\n /** Loyalty import ID. */\n loyaltyImportId: string;\n }\n interface GetErrorFileDownloadUrlResponse {\n /** URL for downloading the error file. */\n url?: string | null;\n }\n interface ExecuteLoyaltyImportRequest {\n /** Loyalty import ID. */\n loyaltyImportId: string;\n /** Header mapping information for the import file. */\n headerMappingInfo?: HeaderMappingInfo;\n }\n interface ExecuteLoyaltyImportResponse {\n /** Executed loyalty import. */\n loyaltyImport?: LoyaltyImport;\n }\n interface CreateLoyaltyImportFileUrlRequest {\n }\n interface CreateLoyaltyImportFileUrlResponse {\n /** Path where the file will be stored. */\n filePath?: string | null;\n /** URL for uploading the loyalty import file. */\n uploadUrl?: string | null;\n }\n interface QueryLoyaltyImportsRequest {\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/wix-loyalty-program/loyalty-imports/supported-filters).\n */\n query: CursorQuery$4;\n }\n interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {\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$5;\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$4[];\n }\n /** @oneof */\n interface CursorQueryPagingMethodOneOf$4 {\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$5;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$4 {\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 QueryLoyaltyImportsResponse {\n /** List of loyalty imports matching the query. */\n loyaltyImports?: LoyaltyImport[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$3;\n }\n interface CursorPagingMetadata$3 {\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$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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 DeleteLoyaltyImportRequest {\n /** Loyalty import ID. */\n loyaltyImportId: string;\n /**\n * Revision number, which increments by 1 each time the loyalty import is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the loyalty import.\n */\n revision?: string;\n }\n interface DeleteLoyaltyImportResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$8;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$8 {\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$8 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$8 {\n bodyAsJson?: string;\n }\n interface Empty$8 {\n }\n interface ImportFinished {\n /** Completed loyalty import. */\n loyaltyImport?: LoyaltyImport;\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 * Creates an import object based on an uploaded file.\n *\n * Call this method after uploading your file to the URL obtained from `createLoyaltyImportFileUrl()`.\n * @param fileUrl - URL of the file to import.\n * @public\n * @requiredField fileUrl\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n */\n function createLoyaltyImport(fileUrl: string | null, options?: CreateLoyaltyImportOptions): Promise;\n interface CreateLoyaltyImportOptions {\n /** Name of the file to import. */\n fileName?: string | null;\n /** Size of the file to import, in bytes. */\n fileSize?: number | null;\n }\n /**\n * Retrieves a loyalty import.\n * @param loyaltyImportId - Loyalty import ID.\n * @public\n * @requiredField loyaltyImportId\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n * @returns Retrieved loyalty import.\n */\n function getLoyaltyImport(loyaltyImportId: string): Promise;\n /**\n * Retrieves the download URL for the error file of a failed loyalty import.\n *\n * If an import fails, the `importResult.errorFileExists` field in the `LoyaltyImport` object is set to `true`.\n *\n * Use this method to get the URL of the error file, which contains details about which items couldn't be imported and why.\n * @param loyaltyImportId - Loyalty import ID.\n * @public\n * @requiredField loyaltyImportId\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n */\n function getErrorFileDownloadUrl(loyaltyImportId: string): Promise;\n /**\n * Starts the actual import process for a loyalty import.\n *\n * Call this method after the loyalty import object reaches the `PARSED` status.\n * @param loyaltyImportId - Loyalty import ID.\n * @public\n * @requiredField loyaltyImportId\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n */\n function executeLoyaltyImport(loyaltyImportId: string, options?: ExecuteLoyaltyImportOptions): Promise;\n interface ExecuteLoyaltyImportOptions {\n /** Header mapping information for the import file. */\n headerMappingInfo?: HeaderMappingInfo;\n }\n /**\n * Creates a URL for uploading a loyalty import file.\n *\n * This method is the first step in the loyalty import process. It returns a file path and an upload URL, which you'll use in subsequent steps of the import process.\n * @public\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n */\n function createLoyaltyImportFileUrl(): Promise;\n /**\n * Creates a query to retrieve a list of loyalty imports.\n *\n * The `queryLoyaltyImports()` function builds a query to retrieve a list of imports and returns a `LoyaltyImportsQueryBuilder` 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 `LoyaltyImportsQueryBuilder` functions onto the query. `LoyaltyImportsQueryBuilder` functions enable you to sort, filter, and control the results `queryLoyaltyImports()` returns.\n *\n * `queryLoyaltyImports()` runs with these `LoyaltyImportsQueryBuilder` defaults, which you can override:\n *\n * - `limit(50)`\n * - `descending(\"_createdDate\")`\n *\n * The functions that are chained to `queryLoyaltyImports()` are applied in the order they're called. For example, if you apply ascending('status') and then descending('_createdDate'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by the created date.\n * @public\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n */\n function queryLoyaltyImports(): LoyaltyImportsQueryBuilder;\n interface QueryCursorResult$3 {\n cursors: Cursors$5;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyImportsQueryResult extends QueryCursorResult$3 {\n items: LoyaltyImport[];\n query: LoyaltyImportsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface LoyaltyImportsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n eq: (propertyName: '_createdDate' | '_updatedDate' | 'status', value: any) => LoyaltyImportsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: '_createdDate' | '_updatedDate' | 'status', value: any) => LoyaltyImportsQueryBuilder;\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) => LoyaltyImportsQueryBuilder;\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) => LoyaltyImportsQueryBuilder;\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) => LoyaltyImportsQueryBuilder;\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) => LoyaltyImportsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `values`.\n * @param values - List of values to compare against.\n */\n hasSome: (propertyName: '_createdDate' | '_updatedDate' | 'status', value: any[]) => LoyaltyImportsQueryBuilder;\n in: (propertyName: '_createdDate' | '_updatedDate' | 'status', value: any) => LoyaltyImportsQueryBuilder;\n exists: (propertyName: '_createdDate' | '_updatedDate' | 'status', value: boolean) => LoyaltyImportsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => LoyaltyImportsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => LoyaltyImportsQueryBuilder;\n /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n limit: (limit: number) => LoyaltyImportsQueryBuilder;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => LoyaltyImportsQueryBuilder;\n find: () => Promise;\n }\n /**\n * Deletes a loyalty import.\n * @param loyaltyImportId - Loyalty import ID.\n * @internal\n * @requiredField loyaltyImportId\n * @permissionId LOYALTY.MANAGE_IMPORTS\n * @adminMethod\n */\n function deleteLoyaltyImport(loyaltyImportId: string, options?: DeleteLoyaltyImportOptions): Promise;\n interface DeleteLoyaltyImportOptions {\n /**\n * Revision number, which increments by 1 each time the loyalty import is updated.\n * To prevent conflicting changes, the current revision must be passed when updating the loyalty import.\n */\n revision?: string;\n }\n \n type loyaltyImportsV1LoyaltyImport_universal_d_LoyaltyImport = LoyaltyImport;\n type loyaltyImportsV1LoyaltyImport_universal_d_ImportStatus = ImportStatus;\n const loyaltyImportsV1LoyaltyImport_universal_d_ImportStatus: typeof ImportStatus;\n type loyaltyImportsV1LoyaltyImport_universal_d_FileMetadata = FileMetadata;\n type loyaltyImportsV1LoyaltyImport_universal_d_FileHeader = FileHeader;\n type loyaltyImportsV1LoyaltyImport_universal_d_HeaderMappingInfo = HeaderMappingInfo;\n type loyaltyImportsV1LoyaltyImport_universal_d_HeaderMapping = HeaderMapping;\n type loyaltyImportsV1LoyaltyImport_universal_d_ColumnName = ColumnName;\n const loyaltyImportsV1LoyaltyImport_universal_d_ColumnName: typeof ColumnName;\n type loyaltyImportsV1LoyaltyImport_universal_d_SampleDataRow = SampleDataRow;\n type loyaltyImportsV1LoyaltyImport_universal_d_ParseResult = ParseResult;\n type loyaltyImportsV1LoyaltyImport_universal_d_ImportResult = ImportResult;\n type loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportRequest = CreateLoyaltyImportRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportResponse = CreateLoyaltyImportResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_GetLoyaltyImportRequest = GetLoyaltyImportRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_GetLoyaltyImportResponse = GetLoyaltyImportResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_GetErrorFileDownloadUrlRequest = GetErrorFileDownloadUrlRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_GetErrorFileDownloadUrlResponse = GetErrorFileDownloadUrlResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_ExecuteLoyaltyImportRequest = ExecuteLoyaltyImportRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_ExecuteLoyaltyImportResponse = ExecuteLoyaltyImportResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportFileUrlRequest = CreateLoyaltyImportFileUrlRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportFileUrlResponse = CreateLoyaltyImportFileUrlResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_QueryLoyaltyImportsRequest = QueryLoyaltyImportsRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_QueryLoyaltyImportsResponse = QueryLoyaltyImportsResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_DeleteLoyaltyImportRequest = DeleteLoyaltyImportRequest;\n type loyaltyImportsV1LoyaltyImport_universal_d_DeleteLoyaltyImportResponse = DeleteLoyaltyImportResponse;\n type loyaltyImportsV1LoyaltyImport_universal_d_ImportFinished = ImportFinished;\n const loyaltyImportsV1LoyaltyImport_universal_d_createLoyaltyImport: typeof createLoyaltyImport;\n type loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportOptions = CreateLoyaltyImportOptions;\n const loyaltyImportsV1LoyaltyImport_universal_d_getLoyaltyImport: typeof getLoyaltyImport;\n const loyaltyImportsV1LoyaltyImport_universal_d_getErrorFileDownloadUrl: typeof getErrorFileDownloadUrl;\n const loyaltyImportsV1LoyaltyImport_universal_d_executeLoyaltyImport: typeof executeLoyaltyImport;\n type loyaltyImportsV1LoyaltyImport_universal_d_ExecuteLoyaltyImportOptions = ExecuteLoyaltyImportOptions;\n const loyaltyImportsV1LoyaltyImport_universal_d_createLoyaltyImportFileUrl: typeof createLoyaltyImportFileUrl;\n const loyaltyImportsV1LoyaltyImport_universal_d_queryLoyaltyImports: typeof queryLoyaltyImports;\n type loyaltyImportsV1LoyaltyImport_universal_d_LoyaltyImportsQueryResult = LoyaltyImportsQueryResult;\n type loyaltyImportsV1LoyaltyImport_universal_d_LoyaltyImportsQueryBuilder = LoyaltyImportsQueryBuilder;\n const loyaltyImportsV1LoyaltyImport_universal_d_deleteLoyaltyImport: typeof deleteLoyaltyImport;\n type loyaltyImportsV1LoyaltyImport_universal_d_DeleteLoyaltyImportOptions = DeleteLoyaltyImportOptions;\n namespace loyaltyImportsV1LoyaltyImport_universal_d {\n export {\n loyaltyImportsV1LoyaltyImport_universal_d_LoyaltyImport as LoyaltyImport,\n loyaltyImportsV1LoyaltyImport_universal_d_ImportStatus as ImportStatus,\n loyaltyImportsV1LoyaltyImport_universal_d_FileMetadata as FileMetadata,\n loyaltyImportsV1LoyaltyImport_universal_d_FileHeader as FileHeader,\n loyaltyImportsV1LoyaltyImport_universal_d_HeaderMappingInfo as HeaderMappingInfo,\n loyaltyImportsV1LoyaltyImport_universal_d_HeaderMapping as HeaderMapping,\n loyaltyImportsV1LoyaltyImport_universal_d_ColumnName as ColumnName,\n loyaltyImportsV1LoyaltyImport_universal_d_SampleDataRow as SampleDataRow,\n loyaltyImportsV1LoyaltyImport_universal_d_ParseResult as ParseResult,\n loyaltyImportsV1LoyaltyImport_universal_d_ImportResult as ImportResult,\n loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportRequest as CreateLoyaltyImportRequest,\n loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportResponse as CreateLoyaltyImportResponse,\n loyaltyImportsV1LoyaltyImport_universal_d_GetLoyaltyImportRequest as GetLoyaltyImportRequest,\n loyaltyImportsV1LoyaltyImport_universal_d_GetLoyaltyImportResponse as GetLoyaltyImportResponse,\n loyaltyImportsV1LoyaltyImport_universal_d_GetErrorFileDownloadUrlRequest as GetErrorFileDownloadUrlRequest,\n loyaltyImportsV1LoyaltyImport_universal_d_GetErrorFileDownloadUrlResponse as GetErrorFileDownloadUrlResponse,\n loyaltyImportsV1LoyaltyImport_universal_d_ExecuteLoyaltyImportRequest as ExecuteLoyaltyImportRequest,\n loyaltyImportsV1LoyaltyImport_universal_d_ExecuteLoyaltyImportResponse as ExecuteLoyaltyImportResponse,\n loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportFileUrlRequest as CreateLoyaltyImportFileUrlRequest,\n loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportFileUrlResponse as CreateLoyaltyImportFileUrlResponse,\n loyaltyImportsV1LoyaltyImport_universal_d_QueryLoyaltyImportsRequest as QueryLoyaltyImportsRequest,\n CursorQuery$4 as CursorQuery,\n CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf,\n Sorting$4 as Sorting,\n SortOrder$4 as SortOrder,\n CursorPaging$5 as CursorPaging,\n loyaltyImportsV1LoyaltyImport_universal_d_QueryLoyaltyImportsResponse as QueryLoyaltyImportsResponse,\n CursorPagingMetadata$3 as CursorPagingMetadata,\n Cursors$5 as Cursors,\n loyaltyImportsV1LoyaltyImport_universal_d_DeleteLoyaltyImportRequest as DeleteLoyaltyImportRequest,\n loyaltyImportsV1LoyaltyImport_universal_d_DeleteLoyaltyImportResponse as DeleteLoyaltyImportResponse,\n DomainEvent$8 as DomainEvent,\n DomainEventBodyOneOf$8 as DomainEventBodyOneOf,\n EntityCreatedEvent$8 as EntityCreatedEvent,\n RestoreInfo$8 as RestoreInfo,\n EntityUpdatedEvent$8 as EntityUpdatedEvent,\n EntityDeletedEvent$8 as EntityDeletedEvent,\n ActionEvent$8 as ActionEvent,\n Empty$8 as Empty,\n loyaltyImportsV1LoyaltyImport_universal_d_ImportFinished as ImportFinished,\n MessageEnvelope$8 as MessageEnvelope,\n IdentificationData$8 as IdentificationData,\n IdentificationDataIdOneOf$8 as IdentificationDataIdOneOf,\n WebhookIdentityType$8 as WebhookIdentityType,\n loyaltyImportsV1LoyaltyImport_universal_d_createLoyaltyImport as createLoyaltyImport,\n loyaltyImportsV1LoyaltyImport_universal_d_CreateLoyaltyImportOptions as CreateLoyaltyImportOptions,\n loyaltyImportsV1LoyaltyImport_universal_d_getLoyaltyImport as getLoyaltyImport,\n loyaltyImportsV1LoyaltyImport_universal_d_getErrorFileDownloadUrl as getErrorFileDownloadUrl,\n loyaltyImportsV1LoyaltyImport_universal_d_executeLoyaltyImport as executeLoyaltyImport,\n loyaltyImportsV1LoyaltyImport_universal_d_ExecuteLoyaltyImportOptions as ExecuteLoyaltyImportOptions,\n loyaltyImportsV1LoyaltyImport_universal_d_createLoyaltyImportFileUrl as createLoyaltyImportFileUrl,\n loyaltyImportsV1LoyaltyImport_universal_d_queryLoyaltyImports as queryLoyaltyImports,\n loyaltyImportsV1LoyaltyImport_universal_d_LoyaltyImportsQueryResult as LoyaltyImportsQueryResult,\n loyaltyImportsV1LoyaltyImport_universal_d_LoyaltyImportsQueryBuilder as LoyaltyImportsQueryBuilder,\n loyaltyImportsV1LoyaltyImport_universal_d_deleteLoyaltyImport as deleteLoyaltyImport,\n loyaltyImportsV1LoyaltyImport_universal_d_DeleteLoyaltyImportOptions as DeleteLoyaltyImportOptions,\n };\n }\n \n interface FollowedChannel {\n /**\n * Followed social media channel ID.\n * @readonly\n */\n _id?: string;\n /**\n * ID of the account that has followed a social media channel.\n * @readonly\n */\n accountId?: string;\n /** Followed social media channel type. */\n channel?: Type$3;\n /**\n * Date when an entity for following a social media channel was created.\n * @readonly\n */\n _createdDate?: Date | null;\n }\n enum Type$3 {\n /** Unknown social media channel type. */\n UNKNOWN_CHANNEL = \"UNKNOWN_CHANNEL\",\n /** Facebook social media channel. */\n FACEBOOK = \"FACEBOOK\",\n /** Instagram social media channel. */\n INSTAGRAM = \"INSTAGRAM\",\n /** LinkedIn social media channel. */\n LINKEDIN = \"LINKEDIN\",\n /** X social media channel. */\n X = \"X\",\n /** TikTok social media channel. */\n TIKTOK = \"TIKTOK\"\n }\n interface CreateFollowedChannelRequest {\n /** Followed social media channel details. */\n followedChannel: FollowedChannel;\n }\n interface CreateFollowedChannelResponse {\n /** Followed social media channel details. */\n followedChannel?: FollowedChannel;\n }\n interface ListFollowedChannelsRequest {\n }\n interface ListFollowedChannelsResponse {\n /** List of followed social media channels. */\n followedChannels?: FollowedChannel[];\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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$7;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$7 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$7 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$7 {\n bodyAsJson?: string;\n }\n interface Empty$7 {\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 * Creates an entity for the specified account ID when the account follows a social media channel.\n *\n * Members can only follow enabled channels. A site owner has to enable channels in the dashboard.\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 * @param followedChannel - Followed social media channel details.\n * @public\n * @documentationMaturity preview\n * @requiredField followedChannel\n * @requiredField followedChannel.channel\n * @permissionId LOYALTY.FOLLOWED_CHANNEL_CREATE\n * @returns Followed social media channel details.\n */\n function createFollowedChannel(followedChannel: FollowedChannel): Promise;\n /**\n * Retrieves a list of social media channels followed by the account. The list is ordered by creation date.\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 * @documentationMaturity preview\n * @permissionId LOYALTY.FOLLOWED_CHANNEL_READ\n */\n function listFollowedChannels(): Promise;\n \n type loyaltySocialmediaV1FollowedChannel_universal_d_FollowedChannel = FollowedChannel;\n type loyaltySocialmediaV1FollowedChannel_universal_d_CreateFollowedChannelRequest = CreateFollowedChannelRequest;\n type loyaltySocialmediaV1FollowedChannel_universal_d_CreateFollowedChannelResponse = CreateFollowedChannelResponse;\n type loyaltySocialmediaV1FollowedChannel_universal_d_ListFollowedChannelsRequest = ListFollowedChannelsRequest;\n type loyaltySocialmediaV1FollowedChannel_universal_d_ListFollowedChannelsResponse = ListFollowedChannelsResponse;\n const loyaltySocialmediaV1FollowedChannel_universal_d_createFollowedChannel: typeof createFollowedChannel;\n const loyaltySocialmediaV1FollowedChannel_universal_d_listFollowedChannels: typeof listFollowedChannels;\n namespace loyaltySocialmediaV1FollowedChannel_universal_d {\n export {\n loyaltySocialmediaV1FollowedChannel_universal_d_FollowedChannel as FollowedChannel,\n Type$3 as Type,\n loyaltySocialmediaV1FollowedChannel_universal_d_CreateFollowedChannelRequest as CreateFollowedChannelRequest,\n loyaltySocialmediaV1FollowedChannel_universal_d_CreateFollowedChannelResponse as CreateFollowedChannelResponse,\n loyaltySocialmediaV1FollowedChannel_universal_d_ListFollowedChannelsRequest as ListFollowedChannelsRequest,\n loyaltySocialmediaV1FollowedChannel_universal_d_ListFollowedChannelsResponse as ListFollowedChannelsResponse,\n DomainEvent$7 as DomainEvent,\n DomainEventBodyOneOf$7 as DomainEventBodyOneOf,\n EntityCreatedEvent$7 as EntityCreatedEvent,\n RestoreInfo$7 as RestoreInfo,\n EntityUpdatedEvent$7 as EntityUpdatedEvent,\n EntityDeletedEvent$7 as EntityDeletedEvent,\n ActionEvent$7 as ActionEvent,\n Empty$7 as Empty,\n MessageEnvelope$7 as MessageEnvelope,\n IdentificationData$7 as IdentificationData,\n IdentificationDataIdOneOf$7 as IdentificationDataIdOneOf,\n WebhookIdentityType$7 as WebhookIdentityType,\n loyaltySocialmediaV1FollowedChannel_universal_d_createFollowedChannel as createFollowedChannel,\n loyaltySocialmediaV1FollowedChannel_universal_d_listFollowedChannels as listFollowedChannels,\n };\n }\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 | null;\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 /** Transaction types. */\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 transaction type. */\n UNKNOWN = \"UNKNOWN\",\n /** 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 EARN = \"EARN\",\n /** Number of points redeemed by the customer for a reward. */\n REDEEM = \"REDEEM\",\n /** 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 ADJUST = \"ADJUST\",\n /** Number of points refunded for a previously redeemed reward. */\n REFUND = \"REFUND\",\n /** Number of points that expired due to customer inactivity for a configured period. */\n EXPIRE = \"EXPIRE\"\n }\n interface EarnInfo extends EarnInfoActivityDetailsOneOf {\n /**\n * Followed social media details.\n * @internal\n */\n followedSocialMedia?: FollowedSocialMedia$1;\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 /** @oneof */\n interface EarnInfoActivityDetailsOneOf {\n /**\n * Followed social media details.\n * @internal\n */\n followedSocialMedia?: FollowedSocialMedia$1;\n }\n interface FollowedSocialMedia$1 {\n /**\n * Social media channel.\n * Example: `FACEBOOK`, `INSTAGRAM`.\n */\n channel?: string;\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$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 BulkLoyaltyTransactionResult {\n /** Individual loyalty transaction metadata. */\n itemMetadata?: ItemMetadata$4;\n /** Only exists if `returnEntity` was set to true in the request. */\n item?: LoyaltyTransaction;\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 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$3;\n }\n interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {\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$4;\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$3 {\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$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$3 {\n ASC = \"ASC\",\n DESC = \"DESC\"\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 QueryLoyaltyTransactionsResponse {\n /** List of loyalty transactions. */\n loyaltyTransactions?: LoyaltyTransaction[];\n /** Paging metadata. */\n pagingMetadata?: CursorPagingMetadata$2;\n }\n interface CursorPagingMetadata$2 {\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$4;\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | null;\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 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 | 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$6;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$6 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$6 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$6 {\n bodyAsJson?: string;\n }\n interface Empty$6 {\n }\n interface GetTransactionSumRequest {\n /** Filter loyalty transactions to sum */\n filter?: Record | null;\n }\n interface GetTransactionSumResponse {\n /** Total amount of all filtered loyalty transactions */\n totalAmount?: number;\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 LoyaltyTransaction.\n * @param loyaltyTransaction - LoyaltyTransaction to be created.\n * @internal\n * @documentationMaturity preview\n * @requiredField loyaltyTransaction\n * @permissionId LOYALTY.MANAGE_TRANSACTIONS\n * @adminMethod\n * @returns The created LoyaltyTransaction.\n */\n function createLoyaltyTransaction(loyaltyTransaction: LoyaltyTransaction): Promise;\n /**\n * Creates up to 100 loyalty transactions.\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.MANAGE_TRANSACTIONS\n * @adminMethod\n */\n function bulkCreateLoyaltyTransactions(options?: BulkCreateLoyaltyTransactionsOptions): Promise;\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 * @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 * @permissionId LOYALTY.READ_TRANSACTIONS\n * @adminMethod\n */\n function queryLoyaltyTransactions(): LoyaltyTransactionsQueryBuilder;\n interface QueryCursorResult$2 {\n cursors: Cursors$4;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyTransactionsQueryResult extends QueryCursorResult$2 {\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 /**\n * Returns total amount sum of filtered transactions\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.READ_TRANSACTIONS\n * @adminMethod\n */\n function getTransactionSum(options?: GetTransactionSumOptions): Promise;\n interface GetTransactionSumOptions {\n /** Filter loyalty transactions to sum */\n filter?: Record | null;\n }\n \n type loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransaction = LoyaltyTransaction;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransactionTransactionTypeInfoOneOf = LoyaltyTransactionTransactionTypeInfoOneOf;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_TransactionType = TransactionType;\n const loyaltyTransactionV1LoyaltyTransaction_universal_d_TransactionType: typeof TransactionType;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_EarnInfo = EarnInfo;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_EarnInfoActivityDetailsOneOf = EarnInfoActivityDetailsOneOf;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_RedeemInfo = RedeemInfo;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_AdjustInfo = AdjustInfo;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_RefundInfo = RefundInfo;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_ExpireInfo = ExpireInfo;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_CreateLoyaltyTransactionRequest = CreateLoyaltyTransactionRequest;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_CreateLoyaltyTransactionResponse = CreateLoyaltyTransactionResponse;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkCreateLoyaltyTransactionsRequest = BulkCreateLoyaltyTransactionsRequest;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkCreateLoyaltyTransactionsResponse = BulkCreateLoyaltyTransactionsResponse;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkLoyaltyTransactionResult = BulkLoyaltyTransactionResult;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_GetLoyaltyTransactionRequest = GetLoyaltyTransactionRequest;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_GetLoyaltyTransactionResponse = GetLoyaltyTransactionResponse;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_QueryLoyaltyTransactionsRequest = QueryLoyaltyTransactionsRequest;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_QueryLoyaltyTransactionsResponse = QueryLoyaltyTransactionsResponse;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_GetTransactionSumRequest = GetTransactionSumRequest;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_GetTransactionSumResponse = GetTransactionSumResponse;\n const loyaltyTransactionV1LoyaltyTransaction_universal_d_createLoyaltyTransaction: typeof createLoyaltyTransaction;\n const loyaltyTransactionV1LoyaltyTransaction_universal_d_bulkCreateLoyaltyTransactions: typeof bulkCreateLoyaltyTransactions;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkCreateLoyaltyTransactionsOptions = BulkCreateLoyaltyTransactionsOptions;\n const loyaltyTransactionV1LoyaltyTransaction_universal_d_getLoyaltyTransaction: typeof getLoyaltyTransaction;\n const loyaltyTransactionV1LoyaltyTransaction_universal_d_queryLoyaltyTransactions: typeof queryLoyaltyTransactions;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransactionsQueryResult = LoyaltyTransactionsQueryResult;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransactionsQueryBuilder = LoyaltyTransactionsQueryBuilder;\n const loyaltyTransactionV1LoyaltyTransaction_universal_d_getTransactionSum: typeof getTransactionSum;\n type loyaltyTransactionV1LoyaltyTransaction_universal_d_GetTransactionSumOptions = GetTransactionSumOptions;\n namespace loyaltyTransactionV1LoyaltyTransaction_universal_d {\n export {\n loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransaction as LoyaltyTransaction,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransactionTransactionTypeInfoOneOf as LoyaltyTransactionTransactionTypeInfoOneOf,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_TransactionType as TransactionType,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_EarnInfo as EarnInfo,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_EarnInfoActivityDetailsOneOf as EarnInfoActivityDetailsOneOf,\n FollowedSocialMedia$1 as FollowedSocialMedia,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_RedeemInfo as RedeemInfo,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_AdjustInfo as AdjustInfo,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_RefundInfo as RefundInfo,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_ExpireInfo as ExpireInfo,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_CreateLoyaltyTransactionRequest as CreateLoyaltyTransactionRequest,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_CreateLoyaltyTransactionResponse as CreateLoyaltyTransactionResponse,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkCreateLoyaltyTransactionsRequest as BulkCreateLoyaltyTransactionsRequest,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkCreateLoyaltyTransactionsResponse as BulkCreateLoyaltyTransactionsResponse,\n ItemMetadata$4 as ItemMetadata,\n ApplicationError$4 as ApplicationError,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkLoyaltyTransactionResult as BulkLoyaltyTransactionResult,\n BulkActionMetadata$4 as BulkActionMetadata,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_GetLoyaltyTransactionRequest as GetLoyaltyTransactionRequest,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_GetLoyaltyTransactionResponse as GetLoyaltyTransactionResponse,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_QueryLoyaltyTransactionsRequest as QueryLoyaltyTransactionsRequest,\n CursorQuery$3 as CursorQuery,\n CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n CursorPaging$4 as CursorPaging,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_QueryLoyaltyTransactionsResponse as QueryLoyaltyTransactionsResponse,\n CursorPagingMetadata$2 as CursorPagingMetadata,\n Cursors$4 as Cursors,\n DomainEvent$6 as DomainEvent,\n DomainEventBodyOneOf$6 as DomainEventBodyOneOf,\n EntityCreatedEvent$6 as EntityCreatedEvent,\n RestoreInfo$6 as RestoreInfo,\n EntityUpdatedEvent$6 as EntityUpdatedEvent,\n EntityDeletedEvent$6 as EntityDeletedEvent,\n ActionEvent$6 as ActionEvent,\n Empty$6 as Empty,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_GetTransactionSumRequest as GetTransactionSumRequest,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_GetTransactionSumResponse as GetTransactionSumResponse,\n MessageEnvelope$6 as MessageEnvelope,\n IdentificationData$6 as IdentificationData,\n IdentificationDataIdOneOf$6 as IdentificationDataIdOneOf,\n WebhookIdentityType$6 as WebhookIdentityType,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_createLoyaltyTransaction as createLoyaltyTransaction,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_bulkCreateLoyaltyTransactions as bulkCreateLoyaltyTransactions,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_BulkCreateLoyaltyTransactionsOptions as BulkCreateLoyaltyTransactionsOptions,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_getLoyaltyTransaction as getLoyaltyTransaction,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_queryLoyaltyTransactions as queryLoyaltyTransactions,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransactionsQueryResult as LoyaltyTransactionsQueryResult,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_LoyaltyTransactionsQueryBuilder as LoyaltyTransactionsQueryBuilder,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_getTransactionSum as getTransactionSum,\n loyaltyTransactionV1LoyaltyTransaction_universal_d_GetTransactionSumOptions as GetTransactionSumOptions,\n };\n }\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$1;\n /**\n * Contact information.\n * @readonly\n */\n contact?: Contact;\n /**\n * Points expiration information\n * @readonly\n */\n pointsExpiration?: PointsExpiration$1;\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$1 {\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 * Reserved for internal use.\n * @internal\n * @readonly\n */\n recalculationDate?: 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$1 {\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 /**\n * Adjusts the account's point balance by this amount. Also account's \"redeemed points\" is reduced by this amount.\n * 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 * @internal\n */\n refund?: 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 * Adjusts the account's point balance by this amount. Also account's \"redeemed points\" is reduced by this amount.\n * 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 * @internal\n */\n refund?: 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$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$2[];\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$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$2 {\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 QueryLoyaltyAccountsResponse {\n /** Loyalty accounts. */\n loyaltyAccounts?: LoyaltyAccount[];\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$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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 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$3;\n }\n interface ListAccountsResponse {\n /** Retrieved loyalty accounts. */\n accounts?: LoyaltyAccount[];\n /** Details on the paged set of results returned. */\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$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 * @internal\n */\n hasNext?: boolean | null;\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$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 * 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$2[];\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$3;\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$1;\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?: ScalarResult;\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?: ScalarResult;\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 ScalarResult {\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 NestedResultsScalarResult {\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?: NestedResultsScalarResult;\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?: NestedResultsScalarResult;\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?: ScalarResult;\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?: ScalarResult;\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$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$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$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$3;\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 ExportAccountsResponse {\n accounts?: LoyaltyAccount[];\n pagingMetadata?: CursorPagingMetadata$1;\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$5 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\n }\n interface Empty$5 {\n }\n interface TiersRollingUpdate$1 {\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$4;\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$4 {\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$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$2 {\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$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 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$3;\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$3;\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 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$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 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 * @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 * @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 * @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 * Adjusts the account's point balance by this amount. Also account's \"redeemed points\" is reduced by this amount.\n * 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 * @internal\n */\n refund?: 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 /**\n * Redeems points from a loyalty account, given the provided reward.\n * @param accountId - Loyalty account ID.\n * @param rewardId - Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details.\n * @internal\n * @documentationMaturity preview\n * @requiredField accountId\n * @requiredField rewardId\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @adminMethod\n */\n function redeemPoints(accountId: string, rewardId: string, options?: RedeemPointsOptions): Promise;\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 /**\n * Redeems given amount of points from a loyalty account, given the provided reward.\n * @param accountId - Loyalty account ID.\n * @param rewardId - Reward ID. See [Rewards API](https://dev.wix.com/api/rest/loyalty/rewards/rewards-object) for more details.\n * @internal\n * @documentationMaturity preview\n * @requiredField accountId\n * @requiredField rewardId\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @adminMethod\n */\n function redeemDeterminedAmountOfPoints(accountId: string, rewardId: string, options?: RedeemDeterminedAmountOfPointsOptions): Promise;\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 * Refunds a redeem transaction by deleting the loyalty coupon and adjusting the points balance.\n * @param transactionId - Transaction ID associated with the refund.\n * @internal\n * @documentationMaturity preview\n * @requiredField transactionId\n * @permissionId LOYALTY.TRANSACTION_REFUND\n * @adminMethod\n */\n function refundTransaction(transactionId: string): Promise;\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 * @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 * @permissionId LOYALTY.READ_ACCOUNTS\n * @adminMethod\n */\n function queryLoyaltyAccounts(): LoyaltyAccountsQueryBuilder;\n interface QueryCursorResult$1 {\n cursors: Cursors$3;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyAccountsQueryResult extends QueryCursorResult$1 {\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 /**\n * Lists all accounts for Wix user.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listUserAccounts(options?: ListUserAccountsOptions): Promise;\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 * @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 */\n function getCurrentMemberAccount(): Promise;\n /**\n * Retrieves the current visitors' loyalty account if it exists\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.READ_OWN_ACCOUNT\n * @deprecated\n * @targetRemovalDate 2024-11-07\n */\n function getMyAccount(): 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 * @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 * @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$3;\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 * @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 /**\n * Endpoint that proxies request with QueryV2 payload to SearchAccounts endpoint with CursorSearch in the payload\n * If search results are expected, they should be passed in the filter as the following fields:\n * \"_search_mode\": \"OR\" or \"AND\"\n * \"_search_expression\": Any string value\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.READ_ACCOUNTS\n * @adminMethod\n */\n function exportAccounts(options?: ExportAccountsOptions): Promise;\n interface ExportAccountsOptions {\n query?: QueryV2$1;\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 * @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 * @adminMethod\n */\n function bulkAdjustPoints(options?: BulkAdjustPointsOptions): Promise;\n interface BulkAdjustPointsOptions extends BulkAdjustPointsRequestTypeOneOf {\n search?: CursorSearch;\n balance?: number;\n amount?: number;\n }\n /**\n * Creates loyalty accounts for given contactIds with given points, or updates loyalty accounts if they already exist\n * @param accounts - List of contactIds + points to either insert as new loyalty accounts, or update if contacts already exist as loyalty accounts\n * @internal\n * @documentationMaturity preview\n * @requiredField accounts\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @adminMethod\n */\n function bulkUpsertAccounts(accounts: AccountToUpsert[], options?: BulkUpsertAccountsOptions): Promise;\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 /**\n * Updates account's member id if it is not already set but member exists\n * @param accountId - ID of the account to retrieve.\n * @internal\n * @documentationMaturity preview\n * @requiredField accountId\n * @permissionId LOYALTY.MANAGE_ACCOUNTS\n * @adminMethod\n */\n function setMissingMemberId(accountId: string): Promise;\n \n type loyaltyV1Account_universal_d_LoyaltyAccount = LoyaltyAccount;\n type loyaltyV1Account_universal_d_Points = Points;\n type loyaltyV1Account_universal_d_Contact = Contact;\n type loyaltyV1Account_universal_d_Image = Image;\n type loyaltyV1Account_universal_d_RewardAvailabilityUpdated = RewardAvailabilityUpdated;\n type loyaltyV1Account_universal_d_UpdateTrigger = UpdateTrigger;\n const loyaltyV1Account_universal_d_UpdateTrigger: typeof UpdateTrigger;\n type loyaltyV1Account_universal_d_CreateAccountRequest = CreateAccountRequest;\n type loyaltyV1Account_universal_d_CreateAccountResponse = CreateAccountResponse;\n type loyaltyV1Account_universal_d_EarnPointsRequest = EarnPointsRequest;\n type loyaltyV1Account_universal_d_EarnPointsRequestActivityDetailsOneOf = EarnPointsRequestActivityDetailsOneOf;\n type loyaltyV1Account_universal_d_FollowedSocialMedia = FollowedSocialMedia;\n type loyaltyV1Account_universal_d_EarnPointsResponse = EarnPointsResponse;\n type loyaltyV1Account_universal_d_PointsUpdated = PointsUpdated;\n type loyaltyV1Account_universal_d_FirstTransaction = FirstTransaction;\n type loyaltyV1Account_universal_d_AdjustPointsRequest = AdjustPointsRequest;\n type loyaltyV1Account_universal_d_AdjustPointsRequestTypeOneOf = AdjustPointsRequestTypeOneOf;\n type loyaltyV1Account_universal_d_AdjustPointsResponse = AdjustPointsResponse;\n type loyaltyV1Account_universal_d_RedeemPointsRequest = RedeemPointsRequest;\n type loyaltyV1Account_universal_d_RedeemPointsResponse = RedeemPointsResponse;\n type loyaltyV1Account_universal_d_RedeemDeterminedAmountOfPointsRequest = RedeemDeterminedAmountOfPointsRequest;\n type loyaltyV1Account_universal_d_RedeemDeterminedAmountOfPointsResponse = RedeemDeterminedAmountOfPointsResponse;\n type loyaltyV1Account_universal_d_RefundTransactionRequest = RefundTransactionRequest;\n type loyaltyV1Account_universal_d_RefundTransactionResponse = RefundTransactionResponse;\n type loyaltyV1Account_universal_d_GetAccountRequest = GetAccountRequest;\n type loyaltyV1Account_universal_d_GetAccountResponse = GetAccountResponse;\n type loyaltyV1Account_universal_d_QueryLoyaltyAccountsRequest = QueryLoyaltyAccountsRequest;\n type loyaltyV1Account_universal_d_QueryLoyaltyAccountsResponse = QueryLoyaltyAccountsResponse;\n type loyaltyV1Account_universal_d_ListUserAccountsRequest = ListUserAccountsRequest;\n type loyaltyV1Account_universal_d_ListUserAccountsResponse = ListUserAccountsResponse;\n type loyaltyV1Account_universal_d_LoyaltyAccountForMetaSite = LoyaltyAccountForMetaSite;\n type loyaltyV1Account_universal_d_GetProgramTotalsRequest = GetProgramTotalsRequest;\n type loyaltyV1Account_universal_d_GetProgramTotalsResponse = GetProgramTotalsResponse;\n type loyaltyV1Account_universal_d_TierTotal = TierTotal;\n type loyaltyV1Account_universal_d_GetCurrentMemberAccountRequest = GetCurrentMemberAccountRequest;\n type loyaltyV1Account_universal_d_GetCurrentMemberAccountResponse = GetCurrentMemberAccountResponse;\n type loyaltyV1Account_universal_d_GetMyAccountRequest = GetMyAccountRequest;\n type loyaltyV1Account_universal_d_GetMyAccountResponse = GetMyAccountResponse;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequest = GetAccountBySecondaryIdRequest;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequestIdOneOf = GetAccountBySecondaryIdRequestIdOneOf;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdResponse = GetAccountBySecondaryIdResponse;\n type loyaltyV1Account_universal_d_ListAccountsRequest = ListAccountsRequest;\n type loyaltyV1Account_universal_d_ListAccountsResponse = ListAccountsResponse;\n type loyaltyV1Account_universal_d_SearchAccountsRequest = SearchAccountsRequest;\n type loyaltyV1Account_universal_d_CursorSearch = CursorSearch;\n type loyaltyV1Account_universal_d_CursorSearchPagingMethodOneOf = CursorSearchPagingMethodOneOf;\n type loyaltyV1Account_universal_d_Aggregation = Aggregation;\n type loyaltyV1Account_universal_d_AggregationKindOneOf = AggregationKindOneOf;\n type loyaltyV1Account_universal_d_RangeBucket = RangeBucket;\n type loyaltyV1Account_universal_d_SortType = SortType;\n const loyaltyV1Account_universal_d_SortType: typeof SortType;\n type loyaltyV1Account_universal_d_SortDirection = SortDirection;\n const loyaltyV1Account_universal_d_SortDirection: typeof SortDirection;\n type loyaltyV1Account_universal_d_MissingValues = MissingValues;\n const loyaltyV1Account_universal_d_MissingValues: typeof MissingValues;\n type loyaltyV1Account_universal_d_IncludeMissingValuesOptions = IncludeMissingValuesOptions;\n type loyaltyV1Account_universal_d_ScalarType = ScalarType;\n const loyaltyV1Account_universal_d_ScalarType: typeof ScalarType;\n type loyaltyV1Account_universal_d_ValueAggregation = ValueAggregation;\n type loyaltyV1Account_universal_d_ValueAggregationOptionsOneOf = ValueAggregationOptionsOneOf;\n type loyaltyV1Account_universal_d_NestedAggregationType = NestedAggregationType;\n const loyaltyV1Account_universal_d_NestedAggregationType: typeof NestedAggregationType;\n type loyaltyV1Account_universal_d_RangeAggregation = RangeAggregation;\n type loyaltyV1Account_universal_d_ScalarAggregation = ScalarAggregation;\n type loyaltyV1Account_universal_d_DateHistogramAggregation = DateHistogramAggregation;\n type loyaltyV1Account_universal_d_DateHistogramAggregationInterval = DateHistogramAggregationInterval;\n const loyaltyV1Account_universal_d_DateHistogramAggregationInterval: typeof DateHistogramAggregationInterval;\n type loyaltyV1Account_universal_d_NestedAggregationItem = NestedAggregationItem;\n type loyaltyV1Account_universal_d_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;\n type loyaltyV1Account_universal_d_AggregationType = AggregationType;\n const loyaltyV1Account_universal_d_AggregationType: typeof AggregationType;\n type loyaltyV1Account_universal_d_NestedAggregation = NestedAggregation;\n type loyaltyV1Account_universal_d_GroupByAggregation = GroupByAggregation;\n type loyaltyV1Account_universal_d_GroupByAggregationKindOneOf = GroupByAggregationKindOneOf;\n type loyaltyV1Account_universal_d_SearchDetails = SearchDetails;\n type loyaltyV1Account_universal_d_Mode = Mode;\n const loyaltyV1Account_universal_d_Mode: typeof Mode;\n type loyaltyV1Account_universal_d_SearchAccountsResponse = SearchAccountsResponse;\n type loyaltyV1Account_universal_d_AggregationData = AggregationData;\n type loyaltyV1Account_universal_d_ValueAggregationResult = ValueAggregationResult;\n type loyaltyV1Account_universal_d_RangeAggregationResult = RangeAggregationResult;\n type loyaltyV1Account_universal_d_NestedAggregationResults = NestedAggregationResults;\n type loyaltyV1Account_universal_d_NestedAggregationResultsResultOneOf = NestedAggregationResultsResultOneOf;\n type loyaltyV1Account_universal_d_ValueResults = ValueResults;\n type loyaltyV1Account_universal_d_RangeResults = RangeResults;\n type loyaltyV1Account_universal_d_ScalarResult = ScalarResult;\n type loyaltyV1Account_universal_d_NestedValueAggregationResult = NestedValueAggregationResult;\n type loyaltyV1Account_universal_d_ValueResult = ValueResult;\n type loyaltyV1Account_universal_d_RangeResult = RangeResult;\n type loyaltyV1Account_universal_d_NestedResultsScalarResult = NestedResultsScalarResult;\n type loyaltyV1Account_universal_d_NestedResultValue = NestedResultValue;\n type loyaltyV1Account_universal_d_NestedResultValueResultOneOf = NestedResultValueResultOneOf;\n type loyaltyV1Account_universal_d_Results = Results;\n type loyaltyV1Account_universal_d_DateHistogramResult = DateHistogramResult;\n type loyaltyV1Account_universal_d_GroupByValueResults = GroupByValueResults;\n type loyaltyV1Account_universal_d_DateHistogramResults = DateHistogramResults;\n type loyaltyV1Account_universal_d_NestedResults = NestedResults;\n type loyaltyV1Account_universal_d_AggregationResults = AggregationResults;\n type loyaltyV1Account_universal_d_AggregationResultsResultOneOf = AggregationResultsResultOneOf;\n type loyaltyV1Account_universal_d_ExportAccountsRequest = ExportAccountsRequest;\n type loyaltyV1Account_universal_d_ExportAccountsResponse = ExportAccountsResponse;\n type loyaltyV1Account_universal_d_CountAccountsRequest = CountAccountsRequest;\n type loyaltyV1Account_universal_d_CountAccountsResponse = CountAccountsResponse;\n type loyaltyV1Account_universal_d_BulkAdjustPointsRequest = BulkAdjustPointsRequest;\n type loyaltyV1Account_universal_d_BulkAdjustPointsRequestTypeOneOf = BulkAdjustPointsRequestTypeOneOf;\n type loyaltyV1Account_universal_d_BulkAdjustPointsResponse = BulkAdjustPointsResponse;\n type loyaltyV1Account_universal_d_SubscriptionEvent = SubscriptionEvent;\n type loyaltyV1Account_universal_d_SubscriptionEventEventOneOf = SubscriptionEventEventOneOf;\n type loyaltyV1Account_universal_d_SubscriptionCreated = SubscriptionCreated;\n type loyaltyV1Account_universal_d_Subscription = Subscription;\n type loyaltyV1Account_universal_d_BillingReference = BillingReference;\n type loyaltyV1Account_universal_d_ProviderName = ProviderName;\n const loyaltyV1Account_universal_d_ProviderName: typeof ProviderName;\n type loyaltyV1Account_universal_d_Cycle = Cycle;\n type loyaltyV1Account_universal_d_CycleCycleSelectorOneOf = CycleCycleSelectorOneOf;\n type loyaltyV1Account_universal_d_Interval = Interval;\n type loyaltyV1Account_universal_d_IntervalUnit = IntervalUnit;\n const loyaltyV1Account_universal_d_IntervalUnit: typeof IntervalUnit;\n type loyaltyV1Account_universal_d_OneTime = OneTime;\n type loyaltyV1Account_universal_d_SubscriptionStatus = SubscriptionStatus;\n const loyaltyV1Account_universal_d_SubscriptionStatus: typeof SubscriptionStatus;\n type loyaltyV1Account_universal_d_ReactivationData = ReactivationData;\n type loyaltyV1Account_universal_d_ReactivationReasonEnum = ReactivationReasonEnum;\n const loyaltyV1Account_universal_d_ReactivationReasonEnum: typeof ReactivationReasonEnum;\n type loyaltyV1Account_universal_d_SubscriptionAssigned = SubscriptionAssigned;\n type loyaltyV1Account_universal_d_SubscriptionCancelled = SubscriptionCancelled;\n type loyaltyV1Account_universal_d_CancellationDetails = CancellationDetails;\n type loyaltyV1Account_universal_d_Initiator = Initiator;\n const loyaltyV1Account_universal_d_Initiator: typeof Initiator;\n type loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOn = SubscriptionAutoRenewTurnedOn;\n type loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOff = SubscriptionAutoRenewTurnedOff;\n type loyaltyV1Account_universal_d_SubscriptionUnassigned = SubscriptionUnassigned;\n type loyaltyV1Account_universal_d_UnassignReason = UnassignReason;\n const loyaltyV1Account_universal_d_UnassignReason: typeof UnassignReason;\n type loyaltyV1Account_universal_d_SubscriptionTransferred = SubscriptionTransferred;\n type loyaltyV1Account_universal_d_RecurringChargeSucceeded = RecurringChargeSucceeded;\n type loyaltyV1Account_universal_d_ContractSwitched = ContractSwitched;\n type loyaltyV1Account_universal_d_ContractSwitchType = ContractSwitchType;\n const loyaltyV1Account_universal_d_ContractSwitchType: typeof ContractSwitchType;\n type loyaltyV1Account_universal_d_ContractSwitchReason = ContractSwitchReason;\n const loyaltyV1Account_universal_d_ContractSwitchReason: typeof ContractSwitchReason;\n type loyaltyV1Account_universal_d_ProductPriceIncreaseData = ProductPriceIncreaseData;\n type loyaltyV1Account_universal_d_PriceIncreaseTrigger = PriceIncreaseTrigger;\n const loyaltyV1Account_universal_d_PriceIncreaseTrigger: typeof PriceIncreaseTrigger;\n type loyaltyV1Account_universal_d_ProductAdjustment = ProductAdjustment;\n const loyaltyV1Account_universal_d_ProductAdjustment: typeof ProductAdjustment;\n type loyaltyV1Account_universal_d_SubscriptionNearEndOfPeriod = SubscriptionNearEndOfPeriod;\n type loyaltyV1Account_universal_d_SubscriptionPendingChange = SubscriptionPendingChange;\n type loyaltyV1Account_universal_d_ContactSyncRequest = ContactSyncRequest;\n type loyaltyV1Account_universal_d_BulkUpsertAccountsRequest = BulkUpsertAccountsRequest;\n type loyaltyV1Account_universal_d_AccountToUpsert = AccountToUpsert;\n type loyaltyV1Account_universal_d_BulkUpsertAccountsResponse = BulkUpsertAccountsResponse;\n type loyaltyV1Account_universal_d_BulkAccountResult = BulkAccountResult;\n type loyaltyV1Account_universal_d_SetMissingMemberIdRequest = SetMissingMemberIdRequest;\n type loyaltyV1Account_universal_d_SetMissingMemberIdResponse = SetMissingMemberIdResponse;\n const loyaltyV1Account_universal_d_createAccount: typeof createAccount;\n const loyaltyV1Account_universal_d_earnPoints: typeof earnPoints;\n type loyaltyV1Account_universal_d_EarnPointsOptions = EarnPointsOptions;\n const loyaltyV1Account_universal_d_adjustPoints: typeof adjustPoints;\n type loyaltyV1Account_universal_d_AdjustPointsOptions = AdjustPointsOptions;\n const loyaltyV1Account_universal_d_redeemPoints: typeof redeemPoints;\n type loyaltyV1Account_universal_d_RedeemPointsOptions = RedeemPointsOptions;\n const loyaltyV1Account_universal_d_redeemDeterminedAmountOfPoints: typeof redeemDeterminedAmountOfPoints;\n type loyaltyV1Account_universal_d_RedeemDeterminedAmountOfPointsOptions = RedeemDeterminedAmountOfPointsOptions;\n const loyaltyV1Account_universal_d_refundTransaction: typeof refundTransaction;\n const loyaltyV1Account_universal_d_getAccount: typeof getAccount;\n const loyaltyV1Account_universal_d_queryLoyaltyAccounts: typeof queryLoyaltyAccounts;\n type loyaltyV1Account_universal_d_LoyaltyAccountsQueryResult = LoyaltyAccountsQueryResult;\n type loyaltyV1Account_universal_d_LoyaltyAccountsQueryBuilder = LoyaltyAccountsQueryBuilder;\n const loyaltyV1Account_universal_d_listUserAccounts: typeof listUserAccounts;\n type loyaltyV1Account_universal_d_ListUserAccountsOptions = ListUserAccountsOptions;\n const loyaltyV1Account_universal_d_getProgramTotals: typeof getProgramTotals;\n const loyaltyV1Account_universal_d_getCurrentMemberAccount: typeof getCurrentMemberAccount;\n const loyaltyV1Account_universal_d_getMyAccount: typeof getMyAccount;\n const loyaltyV1Account_universal_d_getAccountBySecondaryId: typeof getAccountBySecondaryId;\n type loyaltyV1Account_universal_d_GetAccountBySecondaryIdOptions = GetAccountBySecondaryIdOptions;\n const loyaltyV1Account_universal_d_listAccounts: typeof listAccounts;\n type loyaltyV1Account_universal_d_ListAccountsOptions = ListAccountsOptions;\n const loyaltyV1Account_universal_d_searchAccounts: typeof searchAccounts;\n type loyaltyV1Account_universal_d_SearchAccountsOptions = SearchAccountsOptions;\n const loyaltyV1Account_universal_d_exportAccounts: typeof exportAccounts;\n type loyaltyV1Account_universal_d_ExportAccountsOptions = ExportAccountsOptions;\n const loyaltyV1Account_universal_d_countAccounts: typeof countAccounts;\n type loyaltyV1Account_universal_d_CountAccountsOptions = CountAccountsOptions;\n const loyaltyV1Account_universal_d_bulkAdjustPoints: typeof bulkAdjustPoints;\n type loyaltyV1Account_universal_d_BulkAdjustPointsOptions = BulkAdjustPointsOptions;\n const loyaltyV1Account_universal_d_bulkUpsertAccounts: typeof bulkUpsertAccounts;\n type loyaltyV1Account_universal_d_BulkUpsertAccountsOptions = BulkUpsertAccountsOptions;\n const loyaltyV1Account_universal_d_setMissingMemberId: typeof setMissingMemberId;\n namespace loyaltyV1Account_universal_d {\n export {\n loyaltyV1Account_universal_d_LoyaltyAccount as LoyaltyAccount,\n loyaltyV1Account_universal_d_Points as Points,\n Tier$1 as Tier,\n loyaltyV1Account_universal_d_Contact as Contact,\n loyaltyV1Account_universal_d_Image as Image,\n PointsExpiration$1 as PointsExpiration,\n loyaltyV1Account_universal_d_RewardAvailabilityUpdated as RewardAvailabilityUpdated,\n loyaltyV1Account_universal_d_UpdateTrigger as UpdateTrigger,\n loyaltyV1Account_universal_d_CreateAccountRequest as CreateAccountRequest,\n loyaltyV1Account_universal_d_CreateAccountResponse as CreateAccountResponse,\n loyaltyV1Account_universal_d_EarnPointsRequest as EarnPointsRequest,\n loyaltyV1Account_universal_d_EarnPointsRequestActivityDetailsOneOf as EarnPointsRequestActivityDetailsOneOf,\n loyaltyV1Account_universal_d_FollowedSocialMedia as FollowedSocialMedia,\n loyaltyV1Account_universal_d_EarnPointsResponse as EarnPointsResponse,\n loyaltyV1Account_universal_d_PointsUpdated as PointsUpdated,\n loyaltyV1Account_universal_d_FirstTransaction as FirstTransaction,\n loyaltyV1Account_universal_d_AdjustPointsRequest as AdjustPointsRequest,\n loyaltyV1Account_universal_d_AdjustPointsRequestTypeOneOf as AdjustPointsRequestTypeOneOf,\n loyaltyV1Account_universal_d_AdjustPointsResponse as AdjustPointsResponse,\n loyaltyV1Account_universal_d_RedeemPointsRequest as RedeemPointsRequest,\n loyaltyV1Account_universal_d_RedeemPointsResponse as RedeemPointsResponse,\n loyaltyV1Account_universal_d_RedeemDeterminedAmountOfPointsRequest as RedeemDeterminedAmountOfPointsRequest,\n loyaltyV1Account_universal_d_RedeemDeterminedAmountOfPointsResponse as RedeemDeterminedAmountOfPointsResponse,\n loyaltyV1Account_universal_d_RefundTransactionRequest as RefundTransactionRequest,\n loyaltyV1Account_universal_d_RefundTransactionResponse as RefundTransactionResponse,\n loyaltyV1Account_universal_d_GetAccountRequest as GetAccountRequest,\n loyaltyV1Account_universal_d_GetAccountResponse as GetAccountResponse,\n loyaltyV1Account_universal_d_QueryLoyaltyAccountsRequest as QueryLoyaltyAccountsRequest,\n CursorQuery$2 as CursorQuery,\n CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$3 as CursorPaging,\n loyaltyV1Account_universal_d_QueryLoyaltyAccountsResponse as QueryLoyaltyAccountsResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$3 as Cursors,\n loyaltyV1Account_universal_d_ListUserAccountsRequest as ListUserAccountsRequest,\n loyaltyV1Account_universal_d_ListUserAccountsResponse as ListUserAccountsResponse,\n loyaltyV1Account_universal_d_LoyaltyAccountForMetaSite as LoyaltyAccountForMetaSite,\n loyaltyV1Account_universal_d_GetProgramTotalsRequest as GetProgramTotalsRequest,\n loyaltyV1Account_universal_d_GetProgramTotalsResponse as GetProgramTotalsResponse,\n loyaltyV1Account_universal_d_TierTotal as TierTotal,\n loyaltyV1Account_universal_d_GetCurrentMemberAccountRequest as GetCurrentMemberAccountRequest,\n loyaltyV1Account_universal_d_GetCurrentMemberAccountResponse as GetCurrentMemberAccountResponse,\n loyaltyV1Account_universal_d_GetMyAccountRequest as GetMyAccountRequest,\n loyaltyV1Account_universal_d_GetMyAccountResponse as GetMyAccountResponse,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequest as GetAccountBySecondaryIdRequest,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdRequestIdOneOf as GetAccountBySecondaryIdRequestIdOneOf,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdResponse as GetAccountBySecondaryIdResponse,\n loyaltyV1Account_universal_d_ListAccountsRequest as ListAccountsRequest,\n loyaltyV1Account_universal_d_ListAccountsResponse as ListAccountsResponse,\n PagingMetadataV2$3 as PagingMetadataV2,\n loyaltyV1Account_universal_d_SearchAccountsRequest as SearchAccountsRequest,\n loyaltyV1Account_universal_d_CursorSearch as CursorSearch,\n loyaltyV1Account_universal_d_CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOf,\n loyaltyV1Account_universal_d_Aggregation as Aggregation,\n loyaltyV1Account_universal_d_AggregationKindOneOf as AggregationKindOneOf,\n loyaltyV1Account_universal_d_RangeBucket as RangeBucket,\n loyaltyV1Account_universal_d_SortType as SortType,\n loyaltyV1Account_universal_d_SortDirection as SortDirection,\n loyaltyV1Account_universal_d_MissingValues as MissingValues,\n loyaltyV1Account_universal_d_IncludeMissingValuesOptions as IncludeMissingValuesOptions,\n loyaltyV1Account_universal_d_ScalarType as ScalarType,\n loyaltyV1Account_universal_d_ValueAggregation as ValueAggregation,\n loyaltyV1Account_universal_d_ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOf,\n loyaltyV1Account_universal_d_NestedAggregationType as NestedAggregationType,\n loyaltyV1Account_universal_d_RangeAggregation as RangeAggregation,\n loyaltyV1Account_universal_d_ScalarAggregation as ScalarAggregation,\n loyaltyV1Account_universal_d_DateHistogramAggregation as DateHistogramAggregation,\n loyaltyV1Account_universal_d_DateHistogramAggregationInterval as DateHistogramAggregationInterval,\n loyaltyV1Account_universal_d_NestedAggregationItem as NestedAggregationItem,\n loyaltyV1Account_universal_d_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf,\n loyaltyV1Account_universal_d_AggregationType as AggregationType,\n loyaltyV1Account_universal_d_NestedAggregation as NestedAggregation,\n loyaltyV1Account_universal_d_GroupByAggregation as GroupByAggregation,\n loyaltyV1Account_universal_d_GroupByAggregationKindOneOf as GroupByAggregationKindOneOf,\n loyaltyV1Account_universal_d_SearchDetails as SearchDetails,\n loyaltyV1Account_universal_d_Mode as Mode,\n loyaltyV1Account_universal_d_SearchAccountsResponse as SearchAccountsResponse,\n loyaltyV1Account_universal_d_AggregationData as AggregationData,\n loyaltyV1Account_universal_d_ValueAggregationResult as ValueAggregationResult,\n loyaltyV1Account_universal_d_RangeAggregationResult as RangeAggregationResult,\n loyaltyV1Account_universal_d_NestedAggregationResults as NestedAggregationResults,\n loyaltyV1Account_universal_d_NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOf,\n loyaltyV1Account_universal_d_ValueResults as ValueResults,\n loyaltyV1Account_universal_d_RangeResults as RangeResults,\n loyaltyV1Account_universal_d_ScalarResult as ScalarResult,\n loyaltyV1Account_universal_d_NestedValueAggregationResult as NestedValueAggregationResult,\n loyaltyV1Account_universal_d_ValueResult as ValueResult,\n loyaltyV1Account_universal_d_RangeResult as RangeResult,\n loyaltyV1Account_universal_d_NestedResultsScalarResult as NestedResultsScalarResult,\n loyaltyV1Account_universal_d_NestedResultValue as NestedResultValue,\n loyaltyV1Account_universal_d_NestedResultValueResultOneOf as NestedResultValueResultOneOf,\n loyaltyV1Account_universal_d_Results as Results,\n loyaltyV1Account_universal_d_DateHistogramResult as DateHistogramResult,\n loyaltyV1Account_universal_d_GroupByValueResults as GroupByValueResults,\n loyaltyV1Account_universal_d_DateHistogramResults as DateHistogramResults,\n loyaltyV1Account_universal_d_NestedResults as NestedResults,\n loyaltyV1Account_universal_d_AggregationResults as AggregationResults,\n loyaltyV1Account_universal_d_AggregationResultsResultOneOf as AggregationResultsResultOneOf,\n loyaltyV1Account_universal_d_ExportAccountsRequest as ExportAccountsRequest,\n QueryV2$1 as QueryV2,\n QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf,\n Paging$1 as Paging,\n loyaltyV1Account_universal_d_ExportAccountsResponse as ExportAccountsResponse,\n loyaltyV1Account_universal_d_CountAccountsRequest as CountAccountsRequest,\n loyaltyV1Account_universal_d_CountAccountsResponse as CountAccountsResponse,\n loyaltyV1Account_universal_d_BulkAdjustPointsRequest as BulkAdjustPointsRequest,\n loyaltyV1Account_universal_d_BulkAdjustPointsRequestTypeOneOf as BulkAdjustPointsRequestTypeOneOf,\n loyaltyV1Account_universal_d_BulkAdjustPointsResponse as BulkAdjustPointsResponse,\n DomainEvent$5 as DomainEvent,\n DomainEventBodyOneOf$5 as DomainEventBodyOneOf,\n EntityCreatedEvent$5 as EntityCreatedEvent,\n RestoreInfo$5 as RestoreInfo,\n EntityUpdatedEvent$5 as EntityUpdatedEvent,\n EntityDeletedEvent$5 as EntityDeletedEvent,\n ActionEvent$5 as ActionEvent,\n Empty$5 as Empty,\n TiersRollingUpdate$1 as TiersRollingUpdate,\n TiersProgramSettingsChanged$1 as TiersProgramSettingsChanged,\n TiersProgramSettings$1 as TiersProgramSettings,\n TiersProgramSettingsPeriodOneOf$1 as TiersProgramSettingsPeriodOneOf,\n Status$4 as Status,\n TierDefinition$1 as TierDefinition,\n FocalPoint$2 as FocalPoint,\n RollingWindow$1 as RollingWindow,\n loyaltyV1Account_universal_d_SubscriptionEvent as SubscriptionEvent,\n loyaltyV1Account_universal_d_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf,\n loyaltyV1Account_universal_d_SubscriptionCreated as SubscriptionCreated,\n loyaltyV1Account_universal_d_Subscription as Subscription,\n loyaltyV1Account_universal_d_BillingReference as BillingReference,\n loyaltyV1Account_universal_d_ProviderName as ProviderName,\n loyaltyV1Account_universal_d_Cycle as Cycle,\n loyaltyV1Account_universal_d_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf,\n loyaltyV1Account_universal_d_Interval as Interval,\n loyaltyV1Account_universal_d_IntervalUnit as IntervalUnit,\n loyaltyV1Account_universal_d_OneTime as OneTime,\n loyaltyV1Account_universal_d_SubscriptionStatus as SubscriptionStatus,\n loyaltyV1Account_universal_d_ReactivationData as ReactivationData,\n loyaltyV1Account_universal_d_ReactivationReasonEnum as ReactivationReasonEnum,\n loyaltyV1Account_universal_d_SubscriptionAssigned as SubscriptionAssigned,\n loyaltyV1Account_universal_d_SubscriptionCancelled as SubscriptionCancelled,\n loyaltyV1Account_universal_d_CancellationDetails as CancellationDetails,\n loyaltyV1Account_universal_d_Initiator as Initiator,\n loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn,\n loyaltyV1Account_universal_d_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff,\n loyaltyV1Account_universal_d_SubscriptionUnassigned as SubscriptionUnassigned,\n loyaltyV1Account_universal_d_UnassignReason as UnassignReason,\n loyaltyV1Account_universal_d_SubscriptionTransferred as SubscriptionTransferred,\n loyaltyV1Account_universal_d_RecurringChargeSucceeded as RecurringChargeSucceeded,\n loyaltyV1Account_universal_d_ContractSwitched as ContractSwitched,\n loyaltyV1Account_universal_d_ContractSwitchType as ContractSwitchType,\n loyaltyV1Account_universal_d_ContractSwitchReason as ContractSwitchReason,\n loyaltyV1Account_universal_d_ProductPriceIncreaseData as ProductPriceIncreaseData,\n loyaltyV1Account_universal_d_PriceIncreaseTrigger as PriceIncreaseTrigger,\n loyaltyV1Account_universal_d_ProductAdjustment as ProductAdjustment,\n loyaltyV1Account_universal_d_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod,\n loyaltyV1Account_universal_d_SubscriptionPendingChange as SubscriptionPendingChange,\n loyaltyV1Account_universal_d_ContactSyncRequest as ContactSyncRequest,\n loyaltyV1Account_universal_d_BulkUpsertAccountsRequest as BulkUpsertAccountsRequest,\n loyaltyV1Account_universal_d_AccountToUpsert as AccountToUpsert,\n loyaltyV1Account_universal_d_BulkUpsertAccountsResponse as BulkUpsertAccountsResponse,\n loyaltyV1Account_universal_d_BulkAccountResult as BulkAccountResult,\n ItemMetadata$3 as ItemMetadata,\n ApplicationError$3 as ApplicationError,\n BulkActionMetadata$3 as BulkActionMetadata,\n loyaltyV1Account_universal_d_SetMissingMemberIdRequest as SetMissingMemberIdRequest,\n loyaltyV1Account_universal_d_SetMissingMemberIdResponse as SetMissingMemberIdResponse,\n MessageEnvelope$5 as MessageEnvelope,\n IdentificationData$5 as IdentificationData,\n IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf,\n WebhookIdentityType$5 as WebhookIdentityType,\n loyaltyV1Account_universal_d_createAccount as createAccount,\n loyaltyV1Account_universal_d_earnPoints as earnPoints,\n loyaltyV1Account_universal_d_EarnPointsOptions as EarnPointsOptions,\n loyaltyV1Account_universal_d_adjustPoints as adjustPoints,\n loyaltyV1Account_universal_d_AdjustPointsOptions as AdjustPointsOptions,\n loyaltyV1Account_universal_d_redeemPoints as redeemPoints,\n loyaltyV1Account_universal_d_RedeemPointsOptions as RedeemPointsOptions,\n loyaltyV1Account_universal_d_redeemDeterminedAmountOfPoints as redeemDeterminedAmountOfPoints,\n loyaltyV1Account_universal_d_RedeemDeterminedAmountOfPointsOptions as RedeemDeterminedAmountOfPointsOptions,\n loyaltyV1Account_universal_d_refundTransaction as refundTransaction,\n loyaltyV1Account_universal_d_getAccount as getAccount,\n loyaltyV1Account_universal_d_queryLoyaltyAccounts as queryLoyaltyAccounts,\n loyaltyV1Account_universal_d_LoyaltyAccountsQueryResult as LoyaltyAccountsQueryResult,\n loyaltyV1Account_universal_d_LoyaltyAccountsQueryBuilder as LoyaltyAccountsQueryBuilder,\n loyaltyV1Account_universal_d_listUserAccounts as listUserAccounts,\n loyaltyV1Account_universal_d_ListUserAccountsOptions as ListUserAccountsOptions,\n loyaltyV1Account_universal_d_getProgramTotals as getProgramTotals,\n loyaltyV1Account_universal_d_getCurrentMemberAccount as getCurrentMemberAccount,\n loyaltyV1Account_universal_d_getMyAccount as getMyAccount,\n loyaltyV1Account_universal_d_getAccountBySecondaryId as getAccountBySecondaryId,\n loyaltyV1Account_universal_d_GetAccountBySecondaryIdOptions as GetAccountBySecondaryIdOptions,\n loyaltyV1Account_universal_d_listAccounts as listAccounts,\n loyaltyV1Account_universal_d_ListAccountsOptions as ListAccountsOptions,\n loyaltyV1Account_universal_d_searchAccounts as searchAccounts,\n loyaltyV1Account_universal_d_SearchAccountsOptions as SearchAccountsOptions,\n loyaltyV1Account_universal_d_exportAccounts as exportAccounts,\n loyaltyV1Account_universal_d_ExportAccountsOptions as ExportAccountsOptions,\n loyaltyV1Account_universal_d_countAccounts as countAccounts,\n loyaltyV1Account_universal_d_CountAccountsOptions as CountAccountsOptions,\n loyaltyV1Account_universal_d_bulkAdjustPoints as bulkAdjustPoints,\n loyaltyV1Account_universal_d_BulkAdjustPointsOptions as BulkAdjustPointsOptions,\n loyaltyV1Account_universal_d_bulkUpsertAccounts as bulkUpsertAccounts,\n loyaltyV1Account_universal_d_BulkUpsertAccountsOptions as BulkUpsertAccountsOptions,\n loyaltyV1Account_universal_d_setMissingMemberId as setMissingMemberId,\n };\n }\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 * @readonly\n */\n status?: Status$3;\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 | null;\n /**\n * Date and time the loyalty coupon was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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$2;\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$2 {\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$3 {\n /** Unknown status. */\n UNKNOWN = \"UNKNOWN\",\n /** The reference coupon was created but the loyalty points have not been redeemed yet. */\n PENDING = \"PENDING\",\n /** The reference coupon is active and available to the customer. */\n ACTIVE = \"ACTIVE\",\n /** The reference coupon was applied and is no longer available for use. */\n APPLIED = \"APPLIED\",\n /** The reference coupon was created but something went wrong when redeeming points from the loyalty account. */\n FAILED = \"FAILED\",\n /** The 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 * Transaction id of the coupon redemption\n * @internal\n */\n transactionId?: string;\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 BulkGetLoyaltyCouponRequest {\n /** Query to filter loyalty coupons. */\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$2;\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$2;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\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 BulkGetLoyaltyCouponResponse {\n /** Retrieved loyalty coupons. */\n couponsInSite?: CouponsInSite[];\n }\n interface CouponsInSite {\n /** Metasite id */\n metaSiteId?: string;\n /** Retrieved loyalty coupons. */\n loyaltyCoupons?: 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;\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$2;\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;\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 {\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 QueryLoyaltyCouponResponse {\n /** Retrieved loyalty coupons. */\n loyaltyCoupons?: LoyaltyCoupon[];\n /** 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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 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$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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$4 {\n bodyAsJson?: string;\n }\n interface Empty$4 {\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 * 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 * @permissionId LOYALTY.REDEEM_COUPON\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 *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\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 * @permissionId LOYALTY.REDEEM_OWN_COUPON\n */\n function redeemCurrentMemberPointsForCoupon(rewardId: string): Promise;\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/api/rest/wix-loyalty-program/rewards/list-rewards).\n * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/api/rest/wix-loyalty-program/rewards) to redeem.\n * @internal\n * @requiredField options\n * @requiredField options.loyaltyAccountId\n * @requiredField options.pointsToRedeem\n * @requiredField options.specification\n * @requiredField rewardId\n * @permissionId LOYALTY.REDEEM_COUPON\n * @adminMethod\n */\n function redeemMemberPointsForDiscountAmountCoupon(rewardId: string, options: RedeemMemberPointsForDiscountAmountCouponOptions): 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 * @permissionId LOYALTY.READ_COUPONS\n * @adminMethod\n * @returns Retrieved loyalty coupon.\n */\n function getLoyaltyCoupon(loyaltyCouponId: string): Promise;\n /**\n * Retrieves a sequence of loyalty coupons\n * @public\n * @documentationMaturity preview\n * @permissionId LOYALTY.REWARD_BULK_READ\n * @adminMethod\n */\n function bulkGetLoyaltyCoupon(options?: BulkGetLoyaltyCouponOptions): Promise;\n interface BulkGetLoyaltyCouponOptions {\n /** Query to filter loyalty coupons. */\n query?: CursorQuery$1;\n }\n /**\n * Retrieves the loyalty coupons for the currently logged-in member.\n *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @public\n * @permissionId LOYALTY.READ_OWN_COUPONS\n */\n function getCurrentMemberCoupons(): Promise;\n /**\n * Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.\n * @public\n * @permissionId LOYALTY.READ_COUPONS\n * @adminMethod\n */\n function queryLoyaltyCoupons(): LoyaltyCouponsQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors$2;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface LoyaltyCouponsQueryResult extends QueryCursorResult {\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 * @permissionId LOYALTY.MANAGE_COUPONS\n * @adminMethod\n */\n function deleteLoyaltyCoupon(_id: string, revision: string): Promise;\n \n type loyaltyV1Coupon_universal_d_LoyaltyCoupon = LoyaltyCoupon;\n type loyaltyV1Coupon_universal_d_CouponReference = CouponReference;\n type loyaltyV1Coupon_universal_d_Specification = Specification;\n type loyaltyV1Coupon_universal_d_SpecificationTypeDetailsOneOf = SpecificationTypeDetailsOneOf;\n type loyaltyV1Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf = SpecificationScopeOrMinSubtotalOneOf;\n type loyaltyV1Coupon_universal_d_BuyXGetY = BuyXGetY;\n type loyaltyV1Coupon_universal_d_Scope = Scope;\n type loyaltyV1Coupon_universal_d_RedeemPointsForCouponRequest = RedeemPointsForCouponRequest;\n type loyaltyV1Coupon_universal_d_RedeemPointsForCouponResponse = RedeemPointsForCouponResponse;\n type loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponRequest = RedeemCurrentMemberPointsForCouponRequest;\n type loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponResponse = RedeemCurrentMemberPointsForCouponResponse;\n type loyaltyV1Coupon_universal_d_RedeemMemberPointsForDiscountAmountCouponRequest = RedeemMemberPointsForDiscountAmountCouponRequest;\n type loyaltyV1Coupon_universal_d_RedeemMemberPointsForDiscountAmountCouponResponse = RedeemMemberPointsForDiscountAmountCouponResponse;\n type loyaltyV1Coupon_universal_d_GetLoyaltyCouponRequest = GetLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_GetLoyaltyCouponResponse = GetLoyaltyCouponResponse;\n type loyaltyV1Coupon_universal_d_BulkGetLoyaltyCouponRequest = BulkGetLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_BulkGetLoyaltyCouponResponse = BulkGetLoyaltyCouponResponse;\n type loyaltyV1Coupon_universal_d_CouponsInSite = CouponsInSite;\n type loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsRequest = GetCurrentMemberCouponsRequest;\n type loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsResponse = GetCurrentMemberCouponsResponse;\n type loyaltyV1Coupon_universal_d_QueryLoyaltyCouponRequest = QueryLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_QueryV2 = QueryV2;\n type loyaltyV1Coupon_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type loyaltyV1Coupon_universal_d_Paging = Paging;\n type loyaltyV1Coupon_universal_d_QueryLoyaltyCouponResponse = QueryLoyaltyCouponResponse;\n type loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponRequest = DeleteLoyaltyCouponRequest;\n type loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponResponse = DeleteLoyaltyCouponResponse;\n const loyaltyV1Coupon_universal_d_redeemPointsForCoupon: typeof redeemPointsForCoupon;\n type loyaltyV1Coupon_universal_d_RedeemPointsForCouponOptions = RedeemPointsForCouponOptions;\n const loyaltyV1Coupon_universal_d_redeemCurrentMemberPointsForCoupon: typeof redeemCurrentMemberPointsForCoupon;\n const loyaltyV1Coupon_universal_d_redeemMemberPointsForDiscountAmountCoupon: typeof redeemMemberPointsForDiscountAmountCoupon;\n type loyaltyV1Coupon_universal_d_RedeemMemberPointsForDiscountAmountCouponOptions = RedeemMemberPointsForDiscountAmountCouponOptions;\n const loyaltyV1Coupon_universal_d_getLoyaltyCoupon: typeof getLoyaltyCoupon;\n const loyaltyV1Coupon_universal_d_bulkGetLoyaltyCoupon: typeof bulkGetLoyaltyCoupon;\n type loyaltyV1Coupon_universal_d_BulkGetLoyaltyCouponOptions = BulkGetLoyaltyCouponOptions;\n const loyaltyV1Coupon_universal_d_getCurrentMemberCoupons: typeof getCurrentMemberCoupons;\n const loyaltyV1Coupon_universal_d_queryLoyaltyCoupons: typeof queryLoyaltyCoupons;\n type loyaltyV1Coupon_universal_d_LoyaltyCouponsQueryResult = LoyaltyCouponsQueryResult;\n type loyaltyV1Coupon_universal_d_LoyaltyCouponsQueryBuilder = LoyaltyCouponsQueryBuilder;\n const loyaltyV1Coupon_universal_d_deleteLoyaltyCoupon: typeof deleteLoyaltyCoupon;\n namespace loyaltyV1Coupon_universal_d {\n export {\n loyaltyV1Coupon_universal_d_LoyaltyCoupon as LoyaltyCoupon,\n loyaltyV1Coupon_universal_d_CouponReference as CouponReference,\n loyaltyV1Coupon_universal_d_Specification as Specification,\n loyaltyV1Coupon_universal_d_SpecificationTypeDetailsOneOf as SpecificationTypeDetailsOneOf,\n loyaltyV1Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf as SpecificationScopeOrMinSubtotalOneOf,\n Type$2 as Type,\n loyaltyV1Coupon_universal_d_BuyXGetY as BuyXGetY,\n loyaltyV1Coupon_universal_d_Scope as Scope,\n Status$3 as Status,\n loyaltyV1Coupon_universal_d_RedeemPointsForCouponRequest as RedeemPointsForCouponRequest,\n loyaltyV1Coupon_universal_d_RedeemPointsForCouponResponse as RedeemPointsForCouponResponse,\n loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponRequest as RedeemCurrentMemberPointsForCouponRequest,\n loyaltyV1Coupon_universal_d_RedeemCurrentMemberPointsForCouponResponse as RedeemCurrentMemberPointsForCouponResponse,\n loyaltyV1Coupon_universal_d_RedeemMemberPointsForDiscountAmountCouponRequest as RedeemMemberPointsForDiscountAmountCouponRequest,\n loyaltyV1Coupon_universal_d_RedeemMemberPointsForDiscountAmountCouponResponse as RedeemMemberPointsForDiscountAmountCouponResponse,\n loyaltyV1Coupon_universal_d_GetLoyaltyCouponRequest as GetLoyaltyCouponRequest,\n loyaltyV1Coupon_universal_d_GetLoyaltyCouponResponse as GetLoyaltyCouponResponse,\n loyaltyV1Coupon_universal_d_BulkGetLoyaltyCouponRequest as BulkGetLoyaltyCouponRequest,\n CursorQuery$1 as CursorQuery,\n CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n CursorPaging$2 as CursorPaging,\n loyaltyV1Coupon_universal_d_BulkGetLoyaltyCouponResponse as BulkGetLoyaltyCouponResponse,\n loyaltyV1Coupon_universal_d_CouponsInSite as CouponsInSite,\n loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsRequest as GetCurrentMemberCouponsRequest,\n loyaltyV1Coupon_universal_d_GetCurrentMemberCouponsResponse as GetCurrentMemberCouponsResponse,\n loyaltyV1Coupon_universal_d_QueryLoyaltyCouponRequest as QueryLoyaltyCouponRequest,\n loyaltyV1Coupon_universal_d_QueryV2 as QueryV2,\n loyaltyV1Coupon_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n loyaltyV1Coupon_universal_d_Paging as Paging,\n loyaltyV1Coupon_universal_d_QueryLoyaltyCouponResponse as QueryLoyaltyCouponResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n Cursors$2 as Cursors,\n loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponRequest as DeleteLoyaltyCouponRequest,\n loyaltyV1Coupon_universal_d_DeleteLoyaltyCouponResponse as DeleteLoyaltyCouponResponse,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n Empty$4 as Empty,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n loyaltyV1Coupon_universal_d_redeemPointsForCoupon as redeemPointsForCoupon,\n loyaltyV1Coupon_universal_d_RedeemPointsForCouponOptions as RedeemPointsForCouponOptions,\n loyaltyV1Coupon_universal_d_redeemCurrentMemberPointsForCoupon as redeemCurrentMemberPointsForCoupon,\n loyaltyV1Coupon_universal_d_redeemMemberPointsForDiscountAmountCoupon as redeemMemberPointsForDiscountAmountCoupon,\n loyaltyV1Coupon_universal_d_RedeemMemberPointsForDiscountAmountCouponOptions as RedeemMemberPointsForDiscountAmountCouponOptions,\n loyaltyV1Coupon_universal_d_getLoyaltyCoupon as getLoyaltyCoupon,\n loyaltyV1Coupon_universal_d_bulkGetLoyaltyCoupon as bulkGetLoyaltyCoupon,\n loyaltyV1Coupon_universal_d_BulkGetLoyaltyCouponOptions as BulkGetLoyaltyCouponOptions,\n loyaltyV1Coupon_universal_d_getCurrentMemberCoupons as getCurrentMemberCoupons,\n loyaltyV1Coupon_universal_d_queryLoyaltyCoupons as queryLoyaltyCoupons,\n loyaltyV1Coupon_universal_d_LoyaltyCouponsQueryResult as LoyaltyCouponsQueryResult,\n loyaltyV1Coupon_universal_d_LoyaltyCouponsQueryBuilder as LoyaltyCouponsQueryBuilder,\n loyaltyV1Coupon_universal_d_deleteLoyaltyCoupon as deleteLoyaltyCoupon,\n };\n }\n \n /**\n * A loyalty earning rule defines how customers earn points in a loyalty program.\n * You can create rules for different activities, such as making purchases.\n */\n interface LoyaltyEarningRule extends LoyaltyEarningRuleTypeOneOf {\n /** Fixed amount of points awarded for each qualifying activity. */\n fixedAmount?: FixedAmount;\n /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */\n conversionRate?: ConversionRate;\n /**\n * Loyalty earning rule ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID. */\n sourceAppId?: string;\n /** ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events. */\n triggerAppId?: string;\n /** Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`. */\n triggerActivityType?: string;\n /** Name of the earning rule. */\n title?: string;\n /** Current status of the earning rule. */\n status?: Status$2;\n /**\n * Revision number, incremented by 1 each time the earning rule is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string | null;\n /**\n * Date and time the earning rule was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the earning rule was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Additional metadata about the earning rule.\n * @readonly\n */\n metadata?: Metadata;\n }\n /** @oneof */\n interface LoyaltyEarningRuleTypeOneOf {\n /** Fixed amount of points awarded for each qualifying activity. */\n fixedAmount?: FixedAmount;\n /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */\n conversionRate?: ConversionRate;\n }\n /** Fixed amount type of earning rule. */\n interface FixedAmount {\n /**\n * Deprecated. Use `configs` instead.\n * @deprecated Deprecated. Use `configs` instead.\n * @replacedBy configs\n * @targetRemovalDate 2022-09-01\n */\n points?: number;\n /** Fixed amount configurations for each tier. */\n configs?: FixedAmountConfig[];\n }\n interface FixedAmountConfig {\n /**\n * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction#terminology) is used.\n * @readonly\n */\n tierId?: string | null;\n /** Number of points to award. */\n points?: number;\n }\n /**\n * Conversion rate type of earning rule.\n * Customers earn points based on the amount spent.\n * For example, for every $10 spent, a customer might earn 1 point.\n */\n interface ConversionRate {\n /**\n * Deprecated. Use `configs` instead.\n * @deprecated Deprecated. Use `configs` instead.\n * @replacedBy configs\n * @targetRemovalDate 2022-09-01\n */\n moneyAmount?: number;\n /**\n * Deprecated. Use `configs` instead.\n * @deprecated Deprecated. Use `configs` instead.\n * @replacedBy configs\n * @targetRemovalDate 2022-09-01\n */\n points?: number;\n /**\n * Conversion rate configurations for each tier.\n *\n * Points are awarded proportionally to the amount spent.\n *\n * Formula: `(amount spent) / (money_amount * points)`.\n */\n configs?: ConversionRateConfig[];\n /**\n * Specifies which field in the Wix automations [trigger payload](https://dev.wix.com/docs/rest/business-management/automations/introduction#how-do-automations-work) to use for calculating points in conversion rate rules.\n * For example, if set to \"priceSummary.totalAmount\", the rule uses the total order amount to calculate loyalty points to be awarded.\n * This field is only applicable for automated earning rules.\n */\n field?: string | null;\n }\n interface ConversionRateConfig {\n /**\n * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction) is used.\n * @readonly\n */\n tierId?: string | null;\n /**\n * The amount of money used as a reference for point calculation.\n * Points are awarded proportionally to the amount spent.\n *\n * For example, if set to 10, 1 point is awarded for every 10 units of currency spent (assuming `points` is set to 1).\n *\n * Formula for points is: `(amount spent) / (money_amount * points)`.\n */\n moneyAmount?: number;\n /**\n * Points given for the specified `money_amount`.\n * Works in conjunction with `money_amount` to define the earning rule.\n *\n * For example: If `money_amount` is 20 and `points` is 10:\n * - Spending 10 units of currency earns 5 points\n * - Spending 20 units of currency earns 10 points\n * - Spending 30 units of currency earns 15 points\n */\n points?: number;\n }\n enum Status$2 {\n /** Status is unknown or not specified. */\n UNKNOWN = \"UNKNOWN\",\n /** Earning rule is active and can assign points. */\n ACTIVE = \"ACTIVE\",\n /** Earning rule is paused and can't assign points. */\n PAUSED = \"PAUSED\"\n }\n interface Metadata {\n /** Whether the earning rule can be deleted. */\n canBeDeleted?: boolean;\n /**\n * Information about the type of custom earning rule.\n * @internal\n */\n ruleTypeTag?: LoyaltyEarningRuleTypeTag;\n }\n interface LoyaltyEarningRuleTypeTag {\n /** Type of custom earning rule. */\n ruleType?: LoyaltyEarningRuleTypeTagType;\n }\n enum LoyaltyEarningRuleTypeTagType {\n /** Type is unknown or not specified. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /** Earning rule for a customer's birthday. */\n BIRTHDAY = \"BIRTHDAY\"\n }\n interface EarningRuleDisabled {\n }\n interface CreateLoyaltyEarningRuleRequest {\n /** Earning rule to create. */\n earningRule: LoyaltyEarningRule;\n }\n interface CreateLoyaltyEarningRuleResponse {\n /** Created earning rule. */\n earningRule?: LoyaltyEarningRule;\n }\n interface BulkCreateLoyaltyEarningRulesRequest {\n /** Earning rules to create. */\n earningRules: LoyaltyEarningRule[];\n }\n interface BulkCreateLoyaltyEarningRulesResponse {\n /** Created earning rules. */\n results?: BulkLoyaltyEarningRuleResult[];\n /** Additional metadata for the created earning rules. */\n bulkActionMetadata?: BulkActionMetadata$2;\n }\n interface BulkLoyaltyEarningRuleResult {\n /** Additional metadata for the created earning rules. */\n itemMetadata?: ItemMetadata$2;\n /** Created earning rule. */\n item?: LoyaltyEarningRule;\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 CreateCustomLoyaltyEarningRuleRequest {\n /** Type of the custom earning rule. */\n type: Type$1;\n /** Custom earning rule to create. */\n earningRule?: CustomLoyaltyEarningRule;\n }\n enum Type$1 {\n /** Unknown type. */\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n /** Earning rule for social media. */\n SOCIAL_MEDIA = \"SOCIAL_MEDIA\",\n /** Earning rule for birthdays. */\n BIRTHDAY = \"BIRTHDAY\"\n }\n /** Used in CreateCustomLoyaltyEarningRuleRequest */\n interface CustomLoyaltyEarningRule extends CustomLoyaltyEarningRuleTypeOneOf {\n /** Fixed amount of points awarded for each qualifying activity. */\n fixedAmount?: FixedAmount;\n /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */\n conversionRate?: ConversionRate;\n /** Name of the earning rule. */\n title?: string;\n }\n /** @oneof */\n interface CustomLoyaltyEarningRuleTypeOneOf {\n /** Fixed amount of points awarded for each qualifying activity. */\n fixedAmount?: FixedAmount;\n /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */\n conversionRate?: ConversionRate;\n }\n interface CreateCustomLoyaltyEarningRuleResponse {\n /** Created earning rule. */\n earningRule?: LoyaltyEarningRule;\n }\n interface GetLoyaltyEarningRuleRequest {\n /** ID of the earning rule to retrieve. */\n _id: string;\n }\n interface GetLoyaltyEarningRuleResponse {\n /** Retrieved earning rule. */\n earningRule?: LoyaltyEarningRule;\n }\n interface GetAutomationEarningRuleRequest {\n /** ID of the earning rule to retrieve. */\n _id: string;\n }\n interface GetAutomationEarningRuleResponse {\n /** Retrieved earning rule. */\n earningRule?: LoyaltyEarningRule;\n }\n interface UpdateLoyaltyEarningRuleRequest {\n /** Earning rule to update. */\n earningRule: LoyaltyEarningRule;\n }\n interface UpdateLoyaltyEarningRuleResponse {\n /** The updated earning rule. */\n earningRule?: LoyaltyEarningRule;\n }\n interface DeleteLoyaltyEarningRuleRequest {\n /** ID of the earning rule to delete. */\n _id: string;\n /**\n * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string;\n }\n interface DeleteLoyaltyEarningRuleResponse {\n }\n interface DeleteAutomationEarningRuleRequest {\n /** ID of the earning rule to delete. */\n _id: string;\n }\n interface DeleteAutomationEarningRuleResponse {\n }\n interface ListEarningRulesRequest {\n /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */\n triggerAppId?: string | null;\n /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */\n triggerActivityType?: string | null;\n }\n interface ListEarningRulesResponse {\n /** Retrieved earning rules. */\n earningRules?: LoyaltyEarningRule[];\n }\n interface ListEarningRulesInTierRequest {\n /** ID of the tier for which the earning rules will be returned. */\n tierId?: string | null;\n /** Pagination options. */\n paging?: CursorPaging$1;\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 ListEarningRulesInTierResponse {\n /** Retrieved earning rules. */\n earningRules?: LoyaltyEarningRule[];\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 * 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 * @internal\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Creates a non-automated earning rule.\n *\n * >**Note**: You can only create non-automated earning rules from a supported list.\n * For the supported list of services, see the introduction.\n * @param earningRule - Earning rule to create.\n * @public\n * @requiredField earningRule\n * @requiredField earningRule.sourceAppId\n * @requiredField earningRule.status\n * @requiredField earningRule.title\n * @requiredField earningRule.triggerActivityType\n * @requiredField earningRule.triggerAppId\n * @permissionId LOYALTY.MANAGE_EARNING_RULES\n * @adminMethod\n * @returns Created earning rule.\n */\n function createLoyaltyEarningRule(earningRule: LoyaltyEarningRule): Promise;\n /**\n * Creates multiple non-automated earning rules.\n *\n * >**Note**: You can only create non-automated earning rules from a supported list.\n * For the supported list of services, see the introduction.\n * @param earningRules - Earning rules to create.\n * @public\n * @requiredField earningRules\n * @requiredField earningRules.sourceAppId\n * @requiredField earningRules.status\n * @requiredField earningRules.title\n * @requiredField earningRules.triggerActivityType\n * @requiredField earningRules.triggerAppId\n * @permissionId LOYALTY.MANAGE_EARNING_RULES\n * @adminMethod\n */\n function bulkCreateLoyaltyEarningRules(earningRules: LoyaltyEarningRule[]): Promise;\n /**\n * Creates a custom automated earning rule.\n *\n * Currently, only social media earning rule is supported.\n * @param type - Type of the custom earning rule.\n * @public\n * @documentationMaturity preview\n * @requiredField type\n * @permissionId LOYALTY.MANAGE_EARNING_RULES\n * @adminMethod\n */\n function createCustomLoyaltyEarningRule(type: Type$1, options?: CreateCustomLoyaltyEarningRuleOptions): Promise;\n interface CreateCustomLoyaltyEarningRuleOptions {\n /** Custom earning rule to create. */\n earningRule?: CustomLoyaltyEarningRule;\n }\n /**\n * Retrieves a specified non-automated earning rule.\n * @param _id - ID of the earning rule to retrieve.\n * @public\n * @requiredField _id\n * @permissionId LOYALTY.READ_EARNING_RULES\n * @returns Retrieved earning rule.\n */\n function getLoyaltyEarningRule(_id: string): Promise;\n /**\n * Retrieves an automated earning rule.\n *\n * Currently, only legacy automated earning rules are supported.\n *\n * To get both automated and non-automated earning rules, use [List Earning Rules](https://dev.wix.com/docs/rest/crm/loyalty-program/earning-rules/list-earning-rules).\n * @param _id - ID of the earning rule to retrieve.\n * @public\n * @requiredField _id\n * @permissionId LOYALTY.READ_EARNING_RULES\n * @deprecated\n * @targetRemovalDate 2024-09-01\n */\n function getAutomationEarningRule(_id: string): Promise;\n /**\n * Updates an earning rule.\n *\n * Supports partial updates.\n *\n * Revision number, which increments by 1 each time the earning rule is updated. To prevent conflicting changes,\n * the current revision must be passed when updating the earning rule.\n * @param _id - Loyalty earning rule ID.\n * @public\n * @requiredField _id\n * @requiredField earningRule\n * @permissionId LOYALTY.MANAGE_EARNING_RULES\n * @adminMethod\n */\n function updateLoyaltyEarningRule(_id: string | null, earningRule: UpdateLoyaltyEarningRule): Promise;\n interface UpdateLoyaltyEarningRule {\n /** Fixed amount of points awarded for each qualifying activity. */\n fixedAmount?: FixedAmount;\n /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */\n conversionRate?: ConversionRate;\n /**\n * Loyalty earning rule ID.\n * @readonly\n */\n _id?: string | null;\n /** ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID. */\n sourceAppId?: string;\n /** ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events. */\n triggerAppId?: string;\n /** Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`. */\n triggerActivityType?: string;\n /** Name of the earning rule. */\n title?: string;\n /** Current status of the earning rule. */\n status?: Status$2;\n /**\n * Revision number, incremented by 1 each time the earning rule is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string | null;\n /**\n * Date and time the earning rule was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the earning rule was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * Additional metadata about the earning rule.\n * @readonly\n */\n metadata?: Metadata;\n }\n /**\n * Deletes a non-automated earning rule.\n * @param _id - ID of the earning rule to delete.\n * @public\n * @requiredField _id\n * @permissionId LOYALTY.MANAGE_EARNING_RULES\n * @adminMethod\n */\n function deleteLoyaltyEarningRule(_id: string, options?: DeleteLoyaltyEarningRuleOptions): Promise;\n interface DeleteLoyaltyEarningRuleOptions {\n /**\n * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.\n * Pass the latest revision when updating to prevent conflicting changes.\n */\n revision?: string;\n }\n /**\n * Deletes a custom automated earning rule.\n *\n * > **Note:** Pre-installed automated rules can only be paused, not deleted.\n * @param _id - ID of the earning rule to delete.\n * @public\n * @requiredField _id\n * @permissionId LOYALTY.MANAGE_EARNING_RULES\n * @adminMethod\n */\n function deleteAutomationEarningRule(_id: string): Promise;\n /**\n * Retrieves a list of earning rules.\n *\n * Returns both automated and non-automated earning rules.\n *\n * You can filter the results by `triggerAppId` or `triggerActivityType`.\n * @public\n * @permissionId LOYALTY.READ_EARNING_RULES\n */\n function listEarningRules(options?: ListEarningRulesOptions): Promise;\n interface ListEarningRulesOptions {\n /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */\n triggerAppId?: string | null;\n /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */\n triggerActivityType?: string | null;\n }\n /** @internal\n * @permissionId LOYALTY.READ_EARNING_RULES\n */\n function listEarningRulesInTier(options?: ListEarningRulesInTierOptions): Promise;\n interface ListEarningRulesInTierOptions {\n /** ID of the tier for which the earning rules will be returned. */\n tierId?: string | null;\n /** Pagination options. */\n paging?: CursorPaging$1;\n }\n \n type loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRule = LoyaltyEarningRule;\n type loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeOneOf = LoyaltyEarningRuleTypeOneOf;\n type loyaltyV1LoyaltyEarningRule_universal_d_FixedAmount = FixedAmount;\n type loyaltyV1LoyaltyEarningRule_universal_d_FixedAmountConfig = FixedAmountConfig;\n type loyaltyV1LoyaltyEarningRule_universal_d_ConversionRate = ConversionRate;\n type loyaltyV1LoyaltyEarningRule_universal_d_ConversionRateConfig = ConversionRateConfig;\n type loyaltyV1LoyaltyEarningRule_universal_d_Metadata = Metadata;\n type loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeTag = LoyaltyEarningRuleTypeTag;\n type loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeTagType = LoyaltyEarningRuleTypeTagType;\n const loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeTagType: typeof LoyaltyEarningRuleTypeTagType;\n type loyaltyV1LoyaltyEarningRule_universal_d_EarningRuleDisabled = EarningRuleDisabled;\n type loyaltyV1LoyaltyEarningRule_universal_d_CreateLoyaltyEarningRuleRequest = CreateLoyaltyEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_CreateLoyaltyEarningRuleResponse = CreateLoyaltyEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_BulkCreateLoyaltyEarningRulesRequest = BulkCreateLoyaltyEarningRulesRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_BulkCreateLoyaltyEarningRulesResponse = BulkCreateLoyaltyEarningRulesResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_BulkLoyaltyEarningRuleResult = BulkLoyaltyEarningRuleResult;\n type loyaltyV1LoyaltyEarningRule_universal_d_CreateCustomLoyaltyEarningRuleRequest = CreateCustomLoyaltyEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_CustomLoyaltyEarningRule = CustomLoyaltyEarningRule;\n type loyaltyV1LoyaltyEarningRule_universal_d_CustomLoyaltyEarningRuleTypeOneOf = CustomLoyaltyEarningRuleTypeOneOf;\n type loyaltyV1LoyaltyEarningRule_universal_d_CreateCustomLoyaltyEarningRuleResponse = CreateCustomLoyaltyEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_GetLoyaltyEarningRuleRequest = GetLoyaltyEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_GetLoyaltyEarningRuleResponse = GetLoyaltyEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_GetAutomationEarningRuleRequest = GetAutomationEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_GetAutomationEarningRuleResponse = GetAutomationEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_UpdateLoyaltyEarningRuleRequest = UpdateLoyaltyEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_UpdateLoyaltyEarningRuleResponse = UpdateLoyaltyEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_DeleteLoyaltyEarningRuleRequest = DeleteLoyaltyEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_DeleteLoyaltyEarningRuleResponse = DeleteLoyaltyEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_DeleteAutomationEarningRuleRequest = DeleteAutomationEarningRuleRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_DeleteAutomationEarningRuleResponse = DeleteAutomationEarningRuleResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesRequest = ListEarningRulesRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesResponse = ListEarningRulesResponse;\n type loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesInTierRequest = ListEarningRulesInTierRequest;\n type loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesInTierResponse = ListEarningRulesInTierResponse;\n const loyaltyV1LoyaltyEarningRule_universal_d_createLoyaltyEarningRule: typeof createLoyaltyEarningRule;\n const loyaltyV1LoyaltyEarningRule_universal_d_bulkCreateLoyaltyEarningRules: typeof bulkCreateLoyaltyEarningRules;\n const loyaltyV1LoyaltyEarningRule_universal_d_createCustomLoyaltyEarningRule: typeof createCustomLoyaltyEarningRule;\n type loyaltyV1LoyaltyEarningRule_universal_d_CreateCustomLoyaltyEarningRuleOptions = CreateCustomLoyaltyEarningRuleOptions;\n const loyaltyV1LoyaltyEarningRule_universal_d_getLoyaltyEarningRule: typeof getLoyaltyEarningRule;\n const loyaltyV1LoyaltyEarningRule_universal_d_getAutomationEarningRule: typeof getAutomationEarningRule;\n const loyaltyV1LoyaltyEarningRule_universal_d_updateLoyaltyEarningRule: typeof updateLoyaltyEarningRule;\n type loyaltyV1LoyaltyEarningRule_universal_d_UpdateLoyaltyEarningRule = UpdateLoyaltyEarningRule;\n const loyaltyV1LoyaltyEarningRule_universal_d_deleteLoyaltyEarningRule: typeof deleteLoyaltyEarningRule;\n type loyaltyV1LoyaltyEarningRule_universal_d_DeleteLoyaltyEarningRuleOptions = DeleteLoyaltyEarningRuleOptions;\n const loyaltyV1LoyaltyEarningRule_universal_d_deleteAutomationEarningRule: typeof deleteAutomationEarningRule;\n const loyaltyV1LoyaltyEarningRule_universal_d_listEarningRules: typeof listEarningRules;\n type loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesOptions = ListEarningRulesOptions;\n const loyaltyV1LoyaltyEarningRule_universal_d_listEarningRulesInTier: typeof listEarningRulesInTier;\n type loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesInTierOptions = ListEarningRulesInTierOptions;\n namespace loyaltyV1LoyaltyEarningRule_universal_d {\n export {\n loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRule as LoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeOneOf as LoyaltyEarningRuleTypeOneOf,\n loyaltyV1LoyaltyEarningRule_universal_d_FixedAmount as FixedAmount,\n loyaltyV1LoyaltyEarningRule_universal_d_FixedAmountConfig as FixedAmountConfig,\n loyaltyV1LoyaltyEarningRule_universal_d_ConversionRate as ConversionRate,\n loyaltyV1LoyaltyEarningRule_universal_d_ConversionRateConfig as ConversionRateConfig,\n Status$2 as Status,\n loyaltyV1LoyaltyEarningRule_universal_d_Metadata as Metadata,\n loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeTag as LoyaltyEarningRuleTypeTag,\n loyaltyV1LoyaltyEarningRule_universal_d_LoyaltyEarningRuleTypeTagType as LoyaltyEarningRuleTypeTagType,\n loyaltyV1LoyaltyEarningRule_universal_d_EarningRuleDisabled as EarningRuleDisabled,\n loyaltyV1LoyaltyEarningRule_universal_d_CreateLoyaltyEarningRuleRequest as CreateLoyaltyEarningRuleRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_CreateLoyaltyEarningRuleResponse as CreateLoyaltyEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_BulkCreateLoyaltyEarningRulesRequest as BulkCreateLoyaltyEarningRulesRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_BulkCreateLoyaltyEarningRulesResponse as BulkCreateLoyaltyEarningRulesResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_BulkLoyaltyEarningRuleResult as BulkLoyaltyEarningRuleResult,\n ItemMetadata$2 as ItemMetadata,\n ApplicationError$2 as ApplicationError,\n BulkActionMetadata$2 as BulkActionMetadata,\n loyaltyV1LoyaltyEarningRule_universal_d_CreateCustomLoyaltyEarningRuleRequest as CreateCustomLoyaltyEarningRuleRequest,\n Type$1 as Type,\n loyaltyV1LoyaltyEarningRule_universal_d_CustomLoyaltyEarningRule as CustomLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_CustomLoyaltyEarningRuleTypeOneOf as CustomLoyaltyEarningRuleTypeOneOf,\n loyaltyV1LoyaltyEarningRule_universal_d_CreateCustomLoyaltyEarningRuleResponse as CreateCustomLoyaltyEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_GetLoyaltyEarningRuleRequest as GetLoyaltyEarningRuleRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_GetLoyaltyEarningRuleResponse as GetLoyaltyEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_GetAutomationEarningRuleRequest as GetAutomationEarningRuleRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_GetAutomationEarningRuleResponse as GetAutomationEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_UpdateLoyaltyEarningRuleRequest as UpdateLoyaltyEarningRuleRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_UpdateLoyaltyEarningRuleResponse as UpdateLoyaltyEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_DeleteLoyaltyEarningRuleRequest as DeleteLoyaltyEarningRuleRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_DeleteLoyaltyEarningRuleResponse as DeleteLoyaltyEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_DeleteAutomationEarningRuleRequest as DeleteAutomationEarningRuleRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_DeleteAutomationEarningRuleResponse as DeleteAutomationEarningRuleResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesRequest as ListEarningRulesRequest,\n loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesResponse as ListEarningRulesResponse,\n loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesInTierRequest as ListEarningRulesInTierRequest,\n CursorPaging$1 as CursorPaging,\n loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesInTierResponse as ListEarningRulesInTierResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n Empty$3 as Empty,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n loyaltyV1LoyaltyEarningRule_universal_d_createLoyaltyEarningRule as createLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_bulkCreateLoyaltyEarningRules as bulkCreateLoyaltyEarningRules,\n loyaltyV1LoyaltyEarningRule_universal_d_createCustomLoyaltyEarningRule as createCustomLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_CreateCustomLoyaltyEarningRuleOptions as CreateCustomLoyaltyEarningRuleOptions,\n loyaltyV1LoyaltyEarningRule_universal_d_getLoyaltyEarningRule as getLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_getAutomationEarningRule as getAutomationEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_updateLoyaltyEarningRule as updateLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_UpdateLoyaltyEarningRule as UpdateLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_deleteLoyaltyEarningRule as deleteLoyaltyEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_DeleteLoyaltyEarningRuleOptions as DeleteLoyaltyEarningRuleOptions,\n loyaltyV1LoyaltyEarningRule_universal_d_deleteAutomationEarningRule as deleteAutomationEarningRule,\n loyaltyV1LoyaltyEarningRule_universal_d_listEarningRules as listEarningRules,\n loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesOptions as ListEarningRulesOptions,\n loyaltyV1LoyaltyEarningRule_universal_d_listEarningRulesInTier as listEarningRulesInTier,\n loyaltyV1LoyaltyEarningRule_universal_d_ListEarningRulesInTierOptions as ListEarningRulesInTierOptions,\n };\n }\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 | null;\n /**\n * Date and time the program was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Points expiration configuration */\n pointsExpiration?: PointsExpiration;\n /**\n * Information about available premium features\n * @readonly\n */\n premiumFeatures?: PremiumFeatures;\n /**\n * Social media settings\n * @internal\n */\n socialMediaSettings?: SocialMediaSettings;\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 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 enum ProgramStatus {\n /** Unknown program status. */\n UNKNOWN = \"UNKNOWN\",\n /** Program was created but is 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 the user can set it to be active again. */\n PAUSED = \"PAUSED\"\n }\n interface PointsExpiration {\n /**\n * Status of points expiration feature\n * @readonly\n */\n status?: Status$1;\n /** Expire points after set months of inactivity */\n monthsOfInactivity?: number;\n /** Percentage of points expiring */\n expiringPointsPercentage?: number;\n }\n enum Status$1 {\n /** Unknown points expiration status. */\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 SocialMediaSettings {\n /** List of social media channels */\n channels?: SocialMediaChannel[];\n }\n interface SocialMediaChannel {\n /** Social media channel type */\n type?: Type;\n /** Enable or disable social media channel */\n enabled?: boolean;\n /** Social media channel ID. For example, Instagram username. */\n _id?: string;\n /**\n * Social media channel URL\n * @readonly\n */\n url?: string | null;\n }\n enum Type {\n /** Unknown social media channel type. */\n UNKNOWN_CHANNEL = \"UNKNOWN_CHANNEL\",\n /** Facebook social media channel. */\n FACEBOOK = \"FACEBOOK\",\n /** Instagram social media channel. */\n INSTAGRAM = \"INSTAGRAM\",\n /** LinkedIn social media channel. */\n LINKEDIN = \"LINKEDIN\",\n /** X social media channel. */\n X = \"X\",\n /** TikTok social media channel. */\n TIKTOK = \"TIKTOK\"\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 | null;\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 /**\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$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 * 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 /** 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 | null;\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 /**\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$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 /** The origin meta site id */\n originMetaSiteId?: 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$2 {\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 | null;\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 | null;\n /**\n * Deprecated.\n * @readonly\n * @deprecated\n */\n updatedAt?: Date | null;\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 */\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 * @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 * @adminMethod\n */\n function activateLoyaltyProgram(): Promise;\n /**\n * Changes the program status to `PAUSED`.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @adminMethod\n */\n function pauseLoyaltyProgram(): Promise;\n /**\n * Retrieves the program description.\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.READ_PROGRAM\n * @returns The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.\n */\n function getLoyaltyProgramDescription(options?: GetLoyaltyProgramDescriptionOptions): Promise;\n interface GetLoyaltyProgramDescriptionOptions {\n /** List of description fields to retrieve. Supported values: `description`, `updatedDate`. */\n fields?: string[];\n }\n /**\n * Updates the program description.\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @adminMethod\n */\n function updateLoyaltyProgramDescription(options?: UpdateLoyaltyProgramDescriptionOptions): Promise;\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 */\n function getLoyaltyProgramPremiumFeatures(): Promise;\n /**\n * Updates the `pointsExpiration` status to `ENABLED`.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @adminMethod\n */\n function enablePointsExpiration(): Promise;\n /**\n * Updates the `pointsExpiration` status to `DISABLED`.\n * @public\n * @permissionId LOYALTY.MANAGE_PROGRAM\n * @adminMethod\n */\n function disablePointsExpiration(): Promise;\n \n type loyaltyV1Program_universal_d_LoyaltyProgram = LoyaltyProgram;\n type loyaltyV1Program_universal_d_PointDefinition = PointDefinition;\n type loyaltyV1Program_universal_d_ProgramStatus = ProgramStatus;\n const loyaltyV1Program_universal_d_ProgramStatus: typeof ProgramStatus;\n type loyaltyV1Program_universal_d_PointsExpiration = PointsExpiration;\n type loyaltyV1Program_universal_d_PremiumFeatures = PremiumFeatures;\n type loyaltyV1Program_universal_d_SocialMediaSettings = SocialMediaSettings;\n type loyaltyV1Program_universal_d_SocialMediaChannel = SocialMediaChannel;\n type loyaltyV1Program_universal_d_Type = Type;\n const loyaltyV1Program_universal_d_Type: typeof Type;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramRequest = GetLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramResponse = GetLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_BulkGetLoyaltyProgramRequest = BulkGetLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_BulkGetLoyaltyProgramResponse = BulkGetLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_ProgramInSite = ProgramInSite;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramRequest = UpdateLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramResponse = UpdateLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_PointsExpirationConfigurationChanged = PointsExpirationConfigurationChanged;\n type loyaltyV1Program_universal_d_PointsExpirationChanges = PointsExpirationChanges;\n type loyaltyV1Program_universal_d_ActivateLoyaltyProgramRequest = ActivateLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_ActivateLoyaltyProgramResponse = ActivateLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_LoyaltyProgramActivated = LoyaltyProgramActivated;\n type loyaltyV1Program_universal_d_PauseLoyaltyProgramRequest = PauseLoyaltyProgramRequest;\n type loyaltyV1Program_universal_d_PauseLoyaltyProgramResponse = PauseLoyaltyProgramResponse;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionRequest = GetLoyaltyProgramDescriptionRequest;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionResponse = GetLoyaltyProgramDescriptionResponse;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionRequest = UpdateLoyaltyProgramDescriptionRequest;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionResponse = UpdateLoyaltyProgramDescriptionResponse;\n type loyaltyV1Program_universal_d_LoyaltyProgramDescriptionUpdated = LoyaltyProgramDescriptionUpdated;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramPremiumFeaturesRequest = GetLoyaltyProgramPremiumFeaturesRequest;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramPremiumFeaturesResponse = GetLoyaltyProgramPremiumFeaturesResponse;\n type loyaltyV1Program_universal_d_EnablePointsExpirationRequest = EnablePointsExpirationRequest;\n type loyaltyV1Program_universal_d_EnablePointsExpirationResponse = EnablePointsExpirationResponse;\n type loyaltyV1Program_universal_d_PointsExpirationEnabled = PointsExpirationEnabled;\n type loyaltyV1Program_universal_d_DisablePointsExpirationRequest = DisablePointsExpirationRequest;\n type loyaltyV1Program_universal_d_DisablePointsExpirationResponse = DisablePointsExpirationResponse;\n type loyaltyV1Program_universal_d_PointsExpirationDisabled = PointsExpirationDisabled;\n type loyaltyV1Program_universal_d_FeatureEvent = FeatureEvent;\n type loyaltyV1Program_universal_d_FeatureEventEventOneOf = FeatureEventEventOneOf;\n type loyaltyV1Program_universal_d_FeatureEnabled = FeatureEnabled;\n type loyaltyV1Program_universal_d_FeatureEnabledReasonOneOf = FeatureEnabledReasonOneOf;\n type loyaltyV1Program_universal_d_Feature = Feature;\n type loyaltyV1Program_universal_d_FeatureQuantityInfoOneOf = FeatureQuantityInfoOneOf;\n type loyaltyV1Program_universal_d_FeatureContext = FeatureContext;\n type loyaltyV1Program_universal_d_BooleanFeature = BooleanFeature;\n type loyaltyV1Program_universal_d_QuotaFeature = QuotaFeature;\n type loyaltyV1Program_universal_d_FeaturePeriod = FeaturePeriod;\n const loyaltyV1Program_universal_d_FeaturePeriod: typeof FeaturePeriod;\n type loyaltyV1Program_universal_d_QuotaInfo = QuotaInfo;\n type loyaltyV1Program_universal_d_TransferredFromAnotherAccountReason = TransferredFromAnotherAccountReason;\n type loyaltyV1Program_universal_d_ReassignedFromSiteReason = ReassignedFromSiteReason;\n type loyaltyV1Program_universal_d_AssignedFromFloatingReason = AssignedFromFloatingReason;\n type loyaltyV1Program_universal_d_NewFeatureReason = NewFeatureReason;\n type loyaltyV1Program_universal_d_ContractSwitchedReason = ContractSwitchedReason;\n type loyaltyV1Program_universal_d_ManualFeatureCreationReason = ManualFeatureCreationReason;\n type loyaltyV1Program_universal_d_MigratedFromLegacyReason = MigratedFromLegacyReason;\n type loyaltyV1Program_universal_d_FeatureDisabled = FeatureDisabled;\n type loyaltyV1Program_universal_d_FeatureDisabledReasonOneOf = FeatureDisabledReasonOneOf;\n type loyaltyV1Program_universal_d_UnAssingedToFloatingReason = UnAssingedToFloatingReason;\n type loyaltyV1Program_universal_d_ReplacedByAnotherSubscriptionReason = ReplacedByAnotherSubscriptionReason;\n type loyaltyV1Program_universal_d_ReassignedToAnotherSiteReason = ReassignedToAnotherSiteReason;\n type loyaltyV1Program_universal_d_FeatureUpdated = FeatureUpdated;\n type loyaltyV1Program_universal_d_FeatureUpdatedPreviousQuantityInfoOneOf = FeatureUpdatedPreviousQuantityInfoOneOf;\n type loyaltyV1Program_universal_d_FeatureUpdatedReasonOneOf = FeatureUpdatedReasonOneOf;\n type loyaltyV1Program_universal_d_FeatureCancelled = FeatureCancelled;\n type loyaltyV1Program_universal_d_FeatureCancelledReasonOneOf = FeatureCancelledReasonOneOf;\n type loyaltyV1Program_universal_d_TransferredToAnotherAccountReason = TransferredToAnotherAccountReason;\n type loyaltyV1Program_universal_d_CancelRequestedReason = CancelRequestedReason;\n const loyaltyV1Program_universal_d_getLoyaltyProgram: typeof getLoyaltyProgram;\n const loyaltyV1Program_universal_d_bulkGetLoyaltyProgram: typeof bulkGetLoyaltyProgram;\n const loyaltyV1Program_universal_d_updateLoyaltyProgram: typeof updateLoyaltyProgram;\n const loyaltyV1Program_universal_d_activateLoyaltyProgram: typeof activateLoyaltyProgram;\n const loyaltyV1Program_universal_d_pauseLoyaltyProgram: typeof pauseLoyaltyProgram;\n const loyaltyV1Program_universal_d_getLoyaltyProgramDescription: typeof getLoyaltyProgramDescription;\n type loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionOptions = GetLoyaltyProgramDescriptionOptions;\n const loyaltyV1Program_universal_d_updateLoyaltyProgramDescription: typeof updateLoyaltyProgramDescription;\n type loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionOptions = UpdateLoyaltyProgramDescriptionOptions;\n const loyaltyV1Program_universal_d_getLoyaltyProgramPremiumFeatures: typeof getLoyaltyProgramPremiumFeatures;\n const loyaltyV1Program_universal_d_enablePointsExpiration: typeof enablePointsExpiration;\n const loyaltyV1Program_universal_d_disablePointsExpiration: typeof disablePointsExpiration;\n namespace loyaltyV1Program_universal_d {\n export {\n loyaltyV1Program_universal_d_LoyaltyProgram as LoyaltyProgram,\n loyaltyV1Program_universal_d_PointDefinition as PointDefinition,\n FocalPoint$1 as FocalPoint,\n loyaltyV1Program_universal_d_ProgramStatus as ProgramStatus,\n loyaltyV1Program_universal_d_PointsExpiration as PointsExpiration,\n Status$1 as Status,\n loyaltyV1Program_universal_d_PremiumFeatures as PremiumFeatures,\n loyaltyV1Program_universal_d_SocialMediaSettings as SocialMediaSettings,\n loyaltyV1Program_universal_d_SocialMediaChannel as SocialMediaChannel,\n loyaltyV1Program_universal_d_Type as Type,\n loyaltyV1Program_universal_d_GetLoyaltyProgramRequest as GetLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_GetLoyaltyProgramResponse as GetLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_BulkGetLoyaltyProgramRequest as BulkGetLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_BulkGetLoyaltyProgramResponse as BulkGetLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_ProgramInSite as ProgramInSite,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramRequest as UpdateLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramResponse as UpdateLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_PointsExpirationConfigurationChanged as PointsExpirationConfigurationChanged,\n loyaltyV1Program_universal_d_PointsExpirationChanges as PointsExpirationChanges,\n loyaltyV1Program_universal_d_ActivateLoyaltyProgramRequest as ActivateLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_ActivateLoyaltyProgramResponse as ActivateLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_LoyaltyProgramActivated as LoyaltyProgramActivated,\n loyaltyV1Program_universal_d_PauseLoyaltyProgramRequest as PauseLoyaltyProgramRequest,\n loyaltyV1Program_universal_d_PauseLoyaltyProgramResponse as PauseLoyaltyProgramResponse,\n loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionRequest as GetLoyaltyProgramDescriptionRequest,\n loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionResponse as GetLoyaltyProgramDescriptionResponse,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionRequest as UpdateLoyaltyProgramDescriptionRequest,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionResponse as UpdateLoyaltyProgramDescriptionResponse,\n loyaltyV1Program_universal_d_LoyaltyProgramDescriptionUpdated as LoyaltyProgramDescriptionUpdated,\n loyaltyV1Program_universal_d_GetLoyaltyProgramPremiumFeaturesRequest as GetLoyaltyProgramPremiumFeaturesRequest,\n loyaltyV1Program_universal_d_GetLoyaltyProgramPremiumFeaturesResponse as GetLoyaltyProgramPremiumFeaturesResponse,\n loyaltyV1Program_universal_d_EnablePointsExpirationRequest as EnablePointsExpirationRequest,\n loyaltyV1Program_universal_d_EnablePointsExpirationResponse as EnablePointsExpirationResponse,\n loyaltyV1Program_universal_d_PointsExpirationEnabled as PointsExpirationEnabled,\n loyaltyV1Program_universal_d_DisablePointsExpirationRequest as DisablePointsExpirationRequest,\n loyaltyV1Program_universal_d_DisablePointsExpirationResponse as DisablePointsExpirationResponse,\n loyaltyV1Program_universal_d_PointsExpirationDisabled as PointsExpirationDisabled,\n MetaSiteSpecialEvent$1 as MetaSiteSpecialEvent,\n MetaSiteSpecialEventPayloadOneOf$1 as MetaSiteSpecialEventPayloadOneOf,\n Asset$1 as Asset,\n State$1 as State,\n SiteCreated$1 as SiteCreated,\n SiteCreatedContext$1 as SiteCreatedContext,\n Namespace$1 as Namespace,\n SiteTransferred$1 as SiteTransferred,\n SiteDeleted$1 as SiteDeleted,\n DeleteContext$1 as DeleteContext,\n DeleteStatus$1 as DeleteStatus,\n SiteUndeleted$1 as SiteUndeleted,\n SitePublished$1 as SitePublished,\n SiteUnpublished$1 as SiteUnpublished,\n SiteMarkedAsTemplate$1 as SiteMarkedAsTemplate,\n SiteMarkedAsWixSite$1 as SiteMarkedAsWixSite,\n ServiceProvisioned$1 as ServiceProvisioned,\n ServiceRemoved$1 as ServiceRemoved,\n SiteRenamed$1 as SiteRenamed,\n SiteHardDeleted$1 as SiteHardDeleted,\n NamespaceChanged$1 as NamespaceChanged,\n StudioAssigned$1 as StudioAssigned,\n StudioUnassigned$1 as StudioUnassigned,\n Empty$2 as Empty,\n loyaltyV1Program_universal_d_FeatureEvent as FeatureEvent,\n loyaltyV1Program_universal_d_FeatureEventEventOneOf as FeatureEventEventOneOf,\n loyaltyV1Program_universal_d_FeatureEnabled as FeatureEnabled,\n loyaltyV1Program_universal_d_FeatureEnabledReasonOneOf as FeatureEnabledReasonOneOf,\n loyaltyV1Program_universal_d_Feature as Feature,\n loyaltyV1Program_universal_d_FeatureQuantityInfoOneOf as FeatureQuantityInfoOneOf,\n loyaltyV1Program_universal_d_FeatureContext as FeatureContext,\n loyaltyV1Program_universal_d_BooleanFeature as BooleanFeature,\n loyaltyV1Program_universal_d_QuotaFeature as QuotaFeature,\n loyaltyV1Program_universal_d_FeaturePeriod as FeaturePeriod,\n loyaltyV1Program_universal_d_QuotaInfo as QuotaInfo,\n loyaltyV1Program_universal_d_TransferredFromAnotherAccountReason as TransferredFromAnotherAccountReason,\n loyaltyV1Program_universal_d_ReassignedFromSiteReason as ReassignedFromSiteReason,\n loyaltyV1Program_universal_d_AssignedFromFloatingReason as AssignedFromFloatingReason,\n loyaltyV1Program_universal_d_NewFeatureReason as NewFeatureReason,\n loyaltyV1Program_universal_d_ContractSwitchedReason as ContractSwitchedReason,\n loyaltyV1Program_universal_d_ManualFeatureCreationReason as ManualFeatureCreationReason,\n loyaltyV1Program_universal_d_MigratedFromLegacyReason as MigratedFromLegacyReason,\n loyaltyV1Program_universal_d_FeatureDisabled as FeatureDisabled,\n loyaltyV1Program_universal_d_FeatureDisabledReasonOneOf as FeatureDisabledReasonOneOf,\n loyaltyV1Program_universal_d_UnAssingedToFloatingReason as UnAssingedToFloatingReason,\n loyaltyV1Program_universal_d_ReplacedByAnotherSubscriptionReason as ReplacedByAnotherSubscriptionReason,\n loyaltyV1Program_universal_d_ReassignedToAnotherSiteReason as ReassignedToAnotherSiteReason,\n loyaltyV1Program_universal_d_FeatureUpdated as FeatureUpdated,\n loyaltyV1Program_universal_d_FeatureUpdatedPreviousQuantityInfoOneOf as FeatureUpdatedPreviousQuantityInfoOneOf,\n loyaltyV1Program_universal_d_FeatureUpdatedReasonOneOf as FeatureUpdatedReasonOneOf,\n loyaltyV1Program_universal_d_FeatureCancelled as FeatureCancelled,\n loyaltyV1Program_universal_d_FeatureCancelledReasonOneOf as FeatureCancelledReasonOneOf,\n loyaltyV1Program_universal_d_TransferredToAnotherAccountReason as TransferredToAnotherAccountReason,\n loyaltyV1Program_universal_d_CancelRequestedReason as CancelRequestedReason,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n loyaltyV1Program_universal_d_getLoyaltyProgram as getLoyaltyProgram,\n loyaltyV1Program_universal_d_bulkGetLoyaltyProgram as bulkGetLoyaltyProgram,\n loyaltyV1Program_universal_d_updateLoyaltyProgram as updateLoyaltyProgram,\n loyaltyV1Program_universal_d_activateLoyaltyProgram as activateLoyaltyProgram,\n loyaltyV1Program_universal_d_pauseLoyaltyProgram as pauseLoyaltyProgram,\n loyaltyV1Program_universal_d_getLoyaltyProgramDescription as getLoyaltyProgramDescription,\n loyaltyV1Program_universal_d_GetLoyaltyProgramDescriptionOptions as GetLoyaltyProgramDescriptionOptions,\n loyaltyV1Program_universal_d_updateLoyaltyProgramDescription as updateLoyaltyProgramDescription,\n loyaltyV1Program_universal_d_UpdateLoyaltyProgramDescriptionOptions as UpdateLoyaltyProgramDescriptionOptions,\n loyaltyV1Program_universal_d_getLoyaltyProgramPremiumFeatures as getLoyaltyProgramPremiumFeatures,\n loyaltyV1Program_universal_d_enablePointsExpiration as enablePointsExpiration,\n loyaltyV1Program_universal_d_disablePointsExpiration as disablePointsExpiration,\n };\n }\n \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 * Details of a flexible reward implemented in SPI.\n * @internal\n */\n spiDiscountAmount?: SpiDiscountAmount;\n /**\n * Reward ID.\n * @readonly\n */\n _id?: string | null;\n /** Reward name. */\n name?: string;\n /**\n * Amount of points required to receive the reward.\n * @internal\n * @deprecated Amount of points required to receive the reward.\n * @replacedBy type_details\n * @targetRemovalDate 2024-06-01\n */\n requiredPoints?: number;\n /** Whether the reward is active. Default: `FALSE` */\n active?: boolean;\n /** Reward type. */\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 | null;\n /**\n * Date and time the reward was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n }\n /** @oneof */\n interface RewardTypeDetailsOneOf {\n /** Discount details. */\n discountAmount?: DiscountAmount;\n /** Coupon details. */\n couponReward?: CouponReward;\n /**\n * Details of a flexible reward implemented in SPI.\n * @internal\n */\n spiDiscountAmount?: SpiDiscountAmount;\n }\n /** Available reward types. */\n enum RewardType {\n /** Undefined reward type. */\n UNDEFINED = \"UNDEFINED\",\n /** Discount reward. Special flexible reward type used in checkout. */\n DISCOUNT_AMOUNT = \"DISCOUNT_AMOUNT\",\n /** Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards) */\n COUPON_REWARD = \"COUPON_REWARD\",\n /** For internal use. */\n SPI_DISCOUNT_AMOUNT = \"SPI_DISCOUNT_AMOUNT\"\n }\n interface DiscountAmount {\n /**\n * Discount amount. Must be a positive value.\n * @internal\n * @deprecated Discount amount. Must be a positive value.\n * @replacedBy configs_by_tier\n * @targetRemovalDate 2024-06-01\n */\n amount?: string;\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$1;\n }\n interface BulkRewardResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata$1;\n /** Created reward. */\n item?: Reward;\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 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;\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryRewardsResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\n /** Details on the paged set of results returned. */\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 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;\n /**\n * Whether rewards are being listed for \"redemption\" purposes, i.e. from checkout-exchange.\n * If value is true - existing SPI implementors will be called to fetch Custom Rewards for current user.\n * @internal\n */\n redemptionContext?: boolean | null;\n }\n interface ListRewardsResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListRewardsInTierRequest {\n /**\n * Tier id.\n * @readonly\n */\n tierId?: string | null;\n /** Pagination options. */\n cursorPaging?: CursorPaging;\n }\n interface ListRewardsInTierResponse {\n /** Retrieved loyalty rewards. */\n rewards?: Reward[];\n /** Details on the paged set of results returned. */\n pagingMetadata?: PagingMetadataV2;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 /**\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 * @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 * @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 * @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 */\n function queryRewards(query: CursorQuery): 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 * @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 * Details of a flexible reward implemented in SPI.\n * @internal\n */\n spiDiscountAmount?: SpiDiscountAmount;\n /**\n * Reward ID.\n * @readonly\n */\n _id?: string | null;\n /** Reward name. */\n name?: string;\n /**\n * Amount of points required to receive the reward.\n * @internal\n * @deprecated Amount of points required to receive the reward.\n * @replacedBy type_details\n * @targetRemovalDate 2024-06-01\n */\n requiredPoints?: number;\n /** Whether the reward is active. Default: `FALSE` */\n active?: boolean;\n /** Reward type. */\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 | null;\n /**\n * Date and time the reward was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * @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 */\n function listRewards(options?: ListRewardsOptions): Promise;\n interface ListRewardsOptions {\n /** Pagination options. */\n cursorPaging?: CursorPaging;\n /**\n * Whether rewards are being listed for \"redemption\" purposes, i.e. from checkout-exchange.\n * If value is true - existing SPI implementors will be called to fetch Custom Rewards for current user.\n * @internal\n */\n redemptionContext?: boolean | null;\n }\n /**\n * Retrieves a list of rewards in a given tier.\n *\n * Filters out rewards that don't have configuration in a given tier.\n * @internal\n * @documentationMaturity preview\n * @permissionId LOYALTY.READ_REWARDS\n */\n function listRewardsInTier(options?: ListRewardsInTierOptions): Promise;\n interface ListRewardsInTierOptions {\n /**\n * Tier id.\n * @readonly\n */\n tierId?: string | null;\n /** Pagination options. */\n cursorPaging?: CursorPaging;\n }\n \n type loyaltyV1Reward_universal_d_Reward = Reward;\n type loyaltyV1Reward_universal_d_RewardTypeDetailsOneOf = RewardTypeDetailsOneOf;\n type loyaltyV1Reward_universal_d_RewardType = RewardType;\n const loyaltyV1Reward_universal_d_RewardType: typeof RewardType;\n type loyaltyV1Reward_universal_d_DiscountAmount = DiscountAmount;\n type loyaltyV1Reward_universal_d_DiscountAmountConfig = DiscountAmountConfig;\n type loyaltyV1Reward_universal_d_CouponReward = CouponReward;\n type loyaltyV1Reward_universal_d_CouponRewardDiscountTypeOneOf = CouponRewardDiscountTypeOneOf;\n type loyaltyV1Reward_universal_d_CouponRewardScopeOrMinSubtotalOneOf = CouponRewardScopeOrMinSubtotalOneOf;\n type loyaltyV1Reward_universal_d_FixedAmountDiscount = FixedAmountDiscount;\n type loyaltyV1Reward_universal_d_FixedAmountDiscountConfig = FixedAmountDiscountConfig;\n type loyaltyV1Reward_universal_d_PercentageDiscount = PercentageDiscount;\n type loyaltyV1Reward_universal_d_PercentageDiscountConfig = PercentageDiscountConfig;\n type loyaltyV1Reward_universal_d_FreeShippingDiscount = FreeShippingDiscount;\n type loyaltyV1Reward_universal_d_FreeShippingDiscountConfig = FreeShippingDiscountConfig;\n type loyaltyV1Reward_universal_d_CouponScope = CouponScope;\n type loyaltyV1Reward_universal_d_Group = Group;\n type loyaltyV1Reward_universal_d_SpiDiscountAmount = SpiDiscountAmount;\n type loyaltyV1Reward_universal_d_RewardDisabled = RewardDisabled;\n type loyaltyV1Reward_universal_d_CreateRewardRequest = CreateRewardRequest;\n type loyaltyV1Reward_universal_d_CreateRewardResponse = CreateRewardResponse;\n type loyaltyV1Reward_universal_d_BulkCreateRewardsRequest = BulkCreateRewardsRequest;\n type loyaltyV1Reward_universal_d_BulkCreateRewardsResponse = BulkCreateRewardsResponse;\n type loyaltyV1Reward_universal_d_BulkRewardResult = BulkRewardResult;\n type loyaltyV1Reward_universal_d_GetRewardRequest = GetRewardRequest;\n type loyaltyV1Reward_universal_d_GetRewardResponse = GetRewardResponse;\n type loyaltyV1Reward_universal_d_BulkGetRewardsRequest = BulkGetRewardsRequest;\n type loyaltyV1Reward_universal_d_BulkGetRewardsResponse = BulkGetRewardsResponse;\n type loyaltyV1Reward_universal_d_RewardsInSite = RewardsInSite;\n type loyaltyV1Reward_universal_d_QueryRewardsRequest = QueryRewardsRequest;\n type loyaltyV1Reward_universal_d_CursorQuery = CursorQuery;\n type loyaltyV1Reward_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type loyaltyV1Reward_universal_d_Sorting = Sorting;\n type loyaltyV1Reward_universal_d_SortOrder = SortOrder;\n const loyaltyV1Reward_universal_d_SortOrder: typeof SortOrder;\n type loyaltyV1Reward_universal_d_CursorPaging = CursorPaging;\n type loyaltyV1Reward_universal_d_QueryRewardsResponse = QueryRewardsResponse;\n type loyaltyV1Reward_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type loyaltyV1Reward_universal_d_Cursors = Cursors;\n type loyaltyV1Reward_universal_d_UpdateRewardRequest = UpdateRewardRequest;\n type loyaltyV1Reward_universal_d_UpdateRewardResponse = UpdateRewardResponse;\n type loyaltyV1Reward_universal_d_DeleteRewardRequest = DeleteRewardRequest;\n type loyaltyV1Reward_universal_d_DeleteRewardResponse = DeleteRewardResponse;\n type loyaltyV1Reward_universal_d_ListRewardsRequest = ListRewardsRequest;\n type loyaltyV1Reward_universal_d_ListRewardsResponse = ListRewardsResponse;\n type loyaltyV1Reward_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type loyaltyV1Reward_universal_d_ListRewardsInTierRequest = ListRewardsInTierRequest;\n type loyaltyV1Reward_universal_d_ListRewardsInTierResponse = ListRewardsInTierResponse;\n const loyaltyV1Reward_universal_d_createReward: typeof createReward;\n const loyaltyV1Reward_universal_d_bulkCreateRewards: typeof bulkCreateRewards;\n const loyaltyV1Reward_universal_d_getReward: typeof getReward;\n const loyaltyV1Reward_universal_d_bulkGetRewards: typeof bulkGetRewards;\n const loyaltyV1Reward_universal_d_queryRewards: typeof queryRewards;\n const loyaltyV1Reward_universal_d_updateReward: typeof updateReward;\n type loyaltyV1Reward_universal_d_UpdateReward = UpdateReward;\n const loyaltyV1Reward_universal_d_deleteReward: typeof deleteReward;\n const loyaltyV1Reward_universal_d_listRewards: typeof listRewards;\n type loyaltyV1Reward_universal_d_ListRewardsOptions = ListRewardsOptions;\n const loyaltyV1Reward_universal_d_listRewardsInTier: typeof listRewardsInTier;\n type loyaltyV1Reward_universal_d_ListRewardsInTierOptions = ListRewardsInTierOptions;\n namespace loyaltyV1Reward_universal_d {\n export {\n loyaltyV1Reward_universal_d_Reward as Reward,\n loyaltyV1Reward_universal_d_RewardTypeDetailsOneOf as RewardTypeDetailsOneOf,\n loyaltyV1Reward_universal_d_RewardType as RewardType,\n loyaltyV1Reward_universal_d_DiscountAmount as DiscountAmount,\n loyaltyV1Reward_universal_d_DiscountAmountConfig as DiscountAmountConfig,\n loyaltyV1Reward_universal_d_CouponReward as CouponReward,\n loyaltyV1Reward_universal_d_CouponRewardDiscountTypeOneOf as CouponRewardDiscountTypeOneOf,\n loyaltyV1Reward_universal_d_CouponRewardScopeOrMinSubtotalOneOf as CouponRewardScopeOrMinSubtotalOneOf,\n loyaltyV1Reward_universal_d_FixedAmountDiscount as FixedAmountDiscount,\n loyaltyV1Reward_universal_d_FixedAmountDiscountConfig as FixedAmountDiscountConfig,\n loyaltyV1Reward_universal_d_PercentageDiscount as PercentageDiscount,\n loyaltyV1Reward_universal_d_PercentageDiscountConfig as PercentageDiscountConfig,\n loyaltyV1Reward_universal_d_FreeShippingDiscount as FreeShippingDiscount,\n loyaltyV1Reward_universal_d_FreeShippingDiscountConfig as FreeShippingDiscountConfig,\n loyaltyV1Reward_universal_d_CouponScope as CouponScope,\n loyaltyV1Reward_universal_d_Group as Group,\n loyaltyV1Reward_universal_d_SpiDiscountAmount as SpiDiscountAmount,\n loyaltyV1Reward_universal_d_RewardDisabled as RewardDisabled,\n loyaltyV1Reward_universal_d_CreateRewardRequest as CreateRewardRequest,\n loyaltyV1Reward_universal_d_CreateRewardResponse as CreateRewardResponse,\n loyaltyV1Reward_universal_d_BulkCreateRewardsRequest as BulkCreateRewardsRequest,\n loyaltyV1Reward_universal_d_BulkCreateRewardsResponse as BulkCreateRewardsResponse,\n loyaltyV1Reward_universal_d_BulkRewardResult as BulkRewardResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n loyaltyV1Reward_universal_d_GetRewardRequest as GetRewardRequest,\n loyaltyV1Reward_universal_d_GetRewardResponse as GetRewardResponse,\n loyaltyV1Reward_universal_d_BulkGetRewardsRequest as BulkGetRewardsRequest,\n loyaltyV1Reward_universal_d_BulkGetRewardsResponse as BulkGetRewardsResponse,\n loyaltyV1Reward_universal_d_RewardsInSite as RewardsInSite,\n loyaltyV1Reward_universal_d_QueryRewardsRequest as QueryRewardsRequest,\n loyaltyV1Reward_universal_d_CursorQuery as CursorQuery,\n loyaltyV1Reward_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n loyaltyV1Reward_universal_d_Sorting as Sorting,\n loyaltyV1Reward_universal_d_SortOrder as SortOrder,\n loyaltyV1Reward_universal_d_CursorPaging as CursorPaging,\n loyaltyV1Reward_universal_d_QueryRewardsResponse as QueryRewardsResponse,\n loyaltyV1Reward_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n loyaltyV1Reward_universal_d_Cursors as Cursors,\n loyaltyV1Reward_universal_d_UpdateRewardRequest as UpdateRewardRequest,\n loyaltyV1Reward_universal_d_UpdateRewardResponse as UpdateRewardResponse,\n loyaltyV1Reward_universal_d_DeleteRewardRequest as DeleteRewardRequest,\n loyaltyV1Reward_universal_d_DeleteRewardResponse as DeleteRewardResponse,\n loyaltyV1Reward_universal_d_ListRewardsRequest as ListRewardsRequest,\n loyaltyV1Reward_universal_d_ListRewardsResponse as ListRewardsResponse,\n loyaltyV1Reward_universal_d_PagingMetadataV2 as PagingMetadataV2,\n loyaltyV1Reward_universal_d_ListRewardsInTierRequest as ListRewardsInTierRequest,\n loyaltyV1Reward_universal_d_ListRewardsInTierResponse as ListRewardsInTierResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n Empty$1 as Empty,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n loyaltyV1Reward_universal_d_createReward as createReward,\n loyaltyV1Reward_universal_d_bulkCreateRewards as bulkCreateRewards,\n loyaltyV1Reward_universal_d_getReward as getReward,\n loyaltyV1Reward_universal_d_bulkGetRewards as bulkGetRewards,\n loyaltyV1Reward_universal_d_queryRewards as queryRewards,\n loyaltyV1Reward_universal_d_updateReward as updateReward,\n loyaltyV1Reward_universal_d_UpdateReward as UpdateReward,\n loyaltyV1Reward_universal_d_deleteReward as deleteReward,\n loyaltyV1Reward_universal_d_listRewards as listRewards,\n loyaltyV1Reward_universal_d_ListRewardsOptions as ListRewardsOptions,\n loyaltyV1Reward_universal_d_listRewardsInTier as listRewardsInTier,\n loyaltyV1Reward_universal_d_ListRewardsInTierOptions as ListRewardsInTierOptions,\n };\n }\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 {\n /**\n * Tier ID.\n * @readonly\n */\n _id?: string | null;\n /** Information about the tier. */\n tierDefinition?: TierDefinition;\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 {\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 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 /**\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 TiersRollingUpdate {\n }\n interface CreateTierRequest {\n /** Tier to create. */\n tier: Tier;\n }\n interface CreateTierResponse {\n /** Created loyalty tier. */\n tier?: Tier;\n }\n interface BulkCreateTiersRequest {\n /** Tiers to create. */\n tiers?: Tier[];\n }\n interface BulkCreateTiersResponse {\n /** Created tiers. */\n results?: BulkTierResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata;\n }\n /** Retrieved tiers. */\n interface BulkTierResult {\n /** Individual tier metadata. */\n itemMetadata?: ItemMetadata;\n /** Individual tier information. */\n item?: Tier;\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 GetTierRequest {\n /** ID of the tier to retrieve. */\n tierId: string;\n }\n interface GetTierResponse {\n /** Retrieved loyalty tier. */\n tier?: Tier;\n }\n interface UpdateTierRequest {\n /** Tier details to update. */\n tier: Tier;\n }\n interface UpdateTierResponse {\n /** Updated loyalty tier. */\n tier?: Tier;\n }\n interface TierRequiredPointsChanged {\n /** Tier. */\n tier?: Tier;\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[];\n }\n interface CreateTiersProgramSettingsRequest {\n /** Tiers program settings. */\n programSettings: TiersProgramSettings;\n }\n interface CreateTiersProgramSettingsResponse {\n /** Created tiers program settings. */\n programSettings?: TiersProgramSettings;\n }\n interface GetTiersProgramRequest {\n }\n interface GetTiersProgramResponse {\n /** Tiers. */\n tiers?: Tier[];\n /** Tiers program settings. */\n programSettings?: TiersProgramSettings;\n }\n interface GetTiersProgramSettingsRequest {\n }\n interface GetTiersProgramSettingsResponse {\n /** Tiers program settings. */\n programSettings?: TiersProgramSettings;\n }\n interface UpdateTiersProgramSettingsRequest {\n /** Settings for the tiers program. */\n programSettings: TiersProgramSettings;\n }\n interface UpdateTiersProgramSettingsResponse {\n /** Updated program settings. */\n programSettings?: TiersProgramSettings;\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 }\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 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 {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 * @adminMethod\n * @returns Created loyalty tier.\n */\n function createTier(tier: Tier): 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 * @adminMethod\n */\n function bulkCreateTiers(tiers: Tier[]): 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 * @returns Retrieved loyalty tier.\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 * @adminMethod\n * @returns Updated loyalty tier.\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;\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 * @adminMethod\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 */\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 * @adminMethod\n */\n function createTiersProgramSettings(programSettings: TiersProgramSettings): 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 */\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 */\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 * @adminMethod\n */\n function updateTiersProgramSettings(programSettings: TiersProgramSettings): Promise;\n \n type loyaltyV1Tier_universal_d_Tier = Tier;\n type loyaltyV1Tier_universal_d_TierDefinition = TierDefinition;\n type loyaltyV1Tier_universal_d_FocalPoint = FocalPoint;\n type loyaltyV1Tier_universal_d_TiersProgramSettingsChanged = TiersProgramSettingsChanged;\n type loyaltyV1Tier_universal_d_TiersProgramSettings = TiersProgramSettings;\n type loyaltyV1Tier_universal_d_TiersProgramSettingsPeriodOneOf = TiersProgramSettingsPeriodOneOf;\n type loyaltyV1Tier_universal_d_Status = Status;\n const loyaltyV1Tier_universal_d_Status: typeof Status;\n type loyaltyV1Tier_universal_d_RollingWindow = RollingWindow;\n type loyaltyV1Tier_universal_d_TiersRollingUpdate = TiersRollingUpdate;\n type loyaltyV1Tier_universal_d_CreateTierRequest = CreateTierRequest;\n type loyaltyV1Tier_universal_d_CreateTierResponse = CreateTierResponse;\n type loyaltyV1Tier_universal_d_BulkCreateTiersRequest = BulkCreateTiersRequest;\n type loyaltyV1Tier_universal_d_BulkCreateTiersResponse = BulkCreateTiersResponse;\n type loyaltyV1Tier_universal_d_BulkTierResult = BulkTierResult;\n type loyaltyV1Tier_universal_d_ItemMetadata = ItemMetadata;\n type loyaltyV1Tier_universal_d_ApplicationError = ApplicationError;\n type loyaltyV1Tier_universal_d_BulkActionMetadata = BulkActionMetadata;\n type loyaltyV1Tier_universal_d_GetTierRequest = GetTierRequest;\n type loyaltyV1Tier_universal_d_GetTierResponse = GetTierResponse;\n type loyaltyV1Tier_universal_d_UpdateTierRequest = UpdateTierRequest;\n type loyaltyV1Tier_universal_d_UpdateTierResponse = UpdateTierResponse;\n type loyaltyV1Tier_universal_d_TierRequiredPointsChanged = TierRequiredPointsChanged;\n type loyaltyV1Tier_universal_d_DeleteTierRequest = DeleteTierRequest;\n type loyaltyV1Tier_universal_d_DeleteTierResponse = DeleteTierResponse;\n type loyaltyV1Tier_universal_d_ListTiersRequest = ListTiersRequest;\n type loyaltyV1Tier_universal_d_ListTiersResponse = ListTiersResponse;\n type loyaltyV1Tier_universal_d_CreateTiersProgramSettingsRequest = CreateTiersProgramSettingsRequest;\n type loyaltyV1Tier_universal_d_CreateTiersProgramSettingsResponse = CreateTiersProgramSettingsResponse;\n type loyaltyV1Tier_universal_d_GetTiersProgramRequest = GetTiersProgramRequest;\n type loyaltyV1Tier_universal_d_GetTiersProgramResponse = GetTiersProgramResponse;\n type loyaltyV1Tier_universal_d_GetTiersProgramSettingsRequest = GetTiersProgramSettingsRequest;\n type loyaltyV1Tier_universal_d_GetTiersProgramSettingsResponse = GetTiersProgramSettingsResponse;\n type loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsRequest = UpdateTiersProgramSettingsRequest;\n type loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsResponse = UpdateTiersProgramSettingsResponse;\n type loyaltyV1Tier_universal_d_RecalculateAllTiersRequest = RecalculateAllTiersRequest;\n type loyaltyV1Tier_universal_d_RecalculateAllTiersResponse = RecalculateAllTiersResponse;\n type loyaltyV1Tier_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type loyaltyV1Tier_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type loyaltyV1Tier_universal_d_Asset = Asset;\n type loyaltyV1Tier_universal_d_State = State;\n const loyaltyV1Tier_universal_d_State: typeof State;\n type loyaltyV1Tier_universal_d_SiteCreated = SiteCreated;\n type loyaltyV1Tier_universal_d_SiteCreatedContext = SiteCreatedContext;\n const loyaltyV1Tier_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type loyaltyV1Tier_universal_d_Namespace = Namespace;\n const loyaltyV1Tier_universal_d_Namespace: typeof Namespace;\n type loyaltyV1Tier_universal_d_SiteTransferred = SiteTransferred;\n type loyaltyV1Tier_universal_d_SiteDeleted = SiteDeleted;\n type loyaltyV1Tier_universal_d_DeleteContext = DeleteContext;\n type loyaltyV1Tier_universal_d_DeleteStatus = DeleteStatus;\n const loyaltyV1Tier_universal_d_DeleteStatus: typeof DeleteStatus;\n type loyaltyV1Tier_universal_d_SiteUndeleted = SiteUndeleted;\n type loyaltyV1Tier_universal_d_SitePublished = SitePublished;\n type loyaltyV1Tier_universal_d_SiteUnpublished = SiteUnpublished;\n type loyaltyV1Tier_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type loyaltyV1Tier_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type loyaltyV1Tier_universal_d_ServiceProvisioned = ServiceProvisioned;\n type loyaltyV1Tier_universal_d_ServiceRemoved = ServiceRemoved;\n type loyaltyV1Tier_universal_d_SiteRenamed = SiteRenamed;\n type loyaltyV1Tier_universal_d_SiteHardDeleted = SiteHardDeleted;\n type loyaltyV1Tier_universal_d_NamespaceChanged = NamespaceChanged;\n type loyaltyV1Tier_universal_d_StudioAssigned = StudioAssigned;\n type loyaltyV1Tier_universal_d_StudioUnassigned = StudioUnassigned;\n type loyaltyV1Tier_universal_d_Empty = Empty;\n type loyaltyV1Tier_universal_d_DomainEvent = DomainEvent;\n type loyaltyV1Tier_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type loyaltyV1Tier_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type loyaltyV1Tier_universal_d_RestoreInfo = RestoreInfo;\n type loyaltyV1Tier_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type loyaltyV1Tier_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type loyaltyV1Tier_universal_d_ActionEvent = ActionEvent;\n type loyaltyV1Tier_universal_d_MessageEnvelope = MessageEnvelope;\n type loyaltyV1Tier_universal_d_IdentificationData = IdentificationData;\n type loyaltyV1Tier_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type loyaltyV1Tier_universal_d_WebhookIdentityType = WebhookIdentityType;\n const loyaltyV1Tier_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const loyaltyV1Tier_universal_d_createTier: typeof createTier;\n const loyaltyV1Tier_universal_d_bulkCreateTiers: typeof bulkCreateTiers;\n const loyaltyV1Tier_universal_d_getTier: typeof getTier;\n const loyaltyV1Tier_universal_d_updateTier: typeof updateTier;\n type loyaltyV1Tier_universal_d_UpdateTier = UpdateTier;\n const loyaltyV1Tier_universal_d_deleteTier: typeof deleteTier;\n const loyaltyV1Tier_universal_d_listTiers: typeof listTiers;\n const loyaltyV1Tier_universal_d_createTiersProgramSettings: typeof createTiersProgramSettings;\n const loyaltyV1Tier_universal_d_getTiersProgram: typeof getTiersProgram;\n const loyaltyV1Tier_universal_d_getTiersProgramSettings: typeof getTiersProgramSettings;\n const loyaltyV1Tier_universal_d_updateTiersProgramSettings: typeof updateTiersProgramSettings;\n namespace loyaltyV1Tier_universal_d {\n export {\n loyaltyV1Tier_universal_d_Tier as Tier,\n loyaltyV1Tier_universal_d_TierDefinition as TierDefinition,\n loyaltyV1Tier_universal_d_FocalPoint as FocalPoint,\n loyaltyV1Tier_universal_d_TiersProgramSettingsChanged as TiersProgramSettingsChanged,\n loyaltyV1Tier_universal_d_TiersProgramSettings as TiersProgramSettings,\n loyaltyV1Tier_universal_d_TiersProgramSettingsPeriodOneOf as TiersProgramSettingsPeriodOneOf,\n loyaltyV1Tier_universal_d_Status as Status,\n loyaltyV1Tier_universal_d_RollingWindow as RollingWindow,\n loyaltyV1Tier_universal_d_TiersRollingUpdate as TiersRollingUpdate,\n loyaltyV1Tier_universal_d_CreateTierRequest as CreateTierRequest,\n loyaltyV1Tier_universal_d_CreateTierResponse as CreateTierResponse,\n loyaltyV1Tier_universal_d_BulkCreateTiersRequest as BulkCreateTiersRequest,\n loyaltyV1Tier_universal_d_BulkCreateTiersResponse as BulkCreateTiersResponse,\n loyaltyV1Tier_universal_d_BulkTierResult as BulkTierResult,\n loyaltyV1Tier_universal_d_ItemMetadata as ItemMetadata,\n loyaltyV1Tier_universal_d_ApplicationError as ApplicationError,\n loyaltyV1Tier_universal_d_BulkActionMetadata as BulkActionMetadata,\n loyaltyV1Tier_universal_d_GetTierRequest as GetTierRequest,\n loyaltyV1Tier_universal_d_GetTierResponse as GetTierResponse,\n loyaltyV1Tier_universal_d_UpdateTierRequest as UpdateTierRequest,\n loyaltyV1Tier_universal_d_UpdateTierResponse as UpdateTierResponse,\n loyaltyV1Tier_universal_d_TierRequiredPointsChanged as TierRequiredPointsChanged,\n loyaltyV1Tier_universal_d_DeleteTierRequest as DeleteTierRequest,\n loyaltyV1Tier_universal_d_DeleteTierResponse as DeleteTierResponse,\n loyaltyV1Tier_universal_d_ListTiersRequest as ListTiersRequest,\n loyaltyV1Tier_universal_d_ListTiersResponse as ListTiersResponse,\n loyaltyV1Tier_universal_d_CreateTiersProgramSettingsRequest as CreateTiersProgramSettingsRequest,\n loyaltyV1Tier_universal_d_CreateTiersProgramSettingsResponse as CreateTiersProgramSettingsResponse,\n loyaltyV1Tier_universal_d_GetTiersProgramRequest as GetTiersProgramRequest,\n loyaltyV1Tier_universal_d_GetTiersProgramResponse as GetTiersProgramResponse,\n loyaltyV1Tier_universal_d_GetTiersProgramSettingsRequest as GetTiersProgramSettingsRequest,\n loyaltyV1Tier_universal_d_GetTiersProgramSettingsResponse as GetTiersProgramSettingsResponse,\n loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsRequest as UpdateTiersProgramSettingsRequest,\n loyaltyV1Tier_universal_d_UpdateTiersProgramSettingsResponse as UpdateTiersProgramSettingsResponse,\n loyaltyV1Tier_universal_d_RecalculateAllTiersRequest as RecalculateAllTiersRequest,\n loyaltyV1Tier_universal_d_RecalculateAllTiersResponse as RecalculateAllTiersResponse,\n loyaltyV1Tier_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n loyaltyV1Tier_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n loyaltyV1Tier_universal_d_Asset as Asset,\n loyaltyV1Tier_universal_d_State as State,\n loyaltyV1Tier_universal_d_SiteCreated as SiteCreated,\n loyaltyV1Tier_universal_d_SiteCreatedContext as SiteCreatedContext,\n loyaltyV1Tier_universal_d_Namespace as Namespace,\n loyaltyV1Tier_universal_d_SiteTransferred as SiteTransferred,\n loyaltyV1Tier_universal_d_SiteDeleted as SiteDeleted,\n loyaltyV1Tier_universal_d_DeleteContext as DeleteContext,\n loyaltyV1Tier_universal_d_DeleteStatus as DeleteStatus,\n loyaltyV1Tier_universal_d_SiteUndeleted as SiteUndeleted,\n loyaltyV1Tier_universal_d_SitePublished as SitePublished,\n loyaltyV1Tier_universal_d_SiteUnpublished as SiteUnpublished,\n loyaltyV1Tier_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n loyaltyV1Tier_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n loyaltyV1Tier_universal_d_ServiceProvisioned as ServiceProvisioned,\n loyaltyV1Tier_universal_d_ServiceRemoved as ServiceRemoved,\n loyaltyV1Tier_universal_d_SiteRenamed as SiteRenamed,\n loyaltyV1Tier_universal_d_SiteHardDeleted as SiteHardDeleted,\n loyaltyV1Tier_universal_d_NamespaceChanged as NamespaceChanged,\n loyaltyV1Tier_universal_d_StudioAssigned as StudioAssigned,\n loyaltyV1Tier_universal_d_StudioUnassigned as StudioUnassigned,\n loyaltyV1Tier_universal_d_Empty as Empty,\n loyaltyV1Tier_universal_d_DomainEvent as DomainEvent,\n loyaltyV1Tier_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n loyaltyV1Tier_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n loyaltyV1Tier_universal_d_RestoreInfo as RestoreInfo,\n loyaltyV1Tier_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n loyaltyV1Tier_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n loyaltyV1Tier_universal_d_ActionEvent as ActionEvent,\n loyaltyV1Tier_universal_d_MessageEnvelope as MessageEnvelope,\n loyaltyV1Tier_universal_d_IdentificationData as IdentificationData,\n loyaltyV1Tier_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n loyaltyV1Tier_universal_d_WebhookIdentityType as WebhookIdentityType,\n loyaltyV1Tier_universal_d_createTier as createTier,\n loyaltyV1Tier_universal_d_bulkCreateTiers as bulkCreateTiers,\n loyaltyV1Tier_universal_d_getTier as getTier,\n loyaltyV1Tier_universal_d_updateTier as updateTier,\n loyaltyV1Tier_universal_d_UpdateTier as UpdateTier,\n loyaltyV1Tier_universal_d_deleteTier as deleteTier,\n loyaltyV1Tier_universal_d_listTiers as listTiers,\n loyaltyV1Tier_universal_d_createTiersProgramSettings as createTiersProgramSettings,\n loyaltyV1Tier_universal_d_getTiersProgram as getTiersProgram,\n loyaltyV1Tier_universal_d_getTiersProgramSettings as getTiersProgramSettings,\n loyaltyV1Tier_universal_d_updateTiersProgramSettings as updateTiersProgramSettings,\n };\n }\n \n export { loyaltyV1Account_universal_d as accounts, loyaltyCheckoutexchangeV1LoyaltyCheckoutDiscount_universal_d as checkoutExchange, loyaltyV1Coupon_universal_d as coupons, loyaltyV1LoyaltyEarningRule_universal_d as earningRules, loyaltyImportsV1LoyaltyImport_universal_d as imports, loyaltyV1Program_universal_d as programs, loyaltyV1Reward_universal_d as rewards, loyaltySocialmediaV1FollowedChannel_universal_d as socialMedia, loyaltyV1Tier_universal_d as tiers, loyaltyTransactionV1LoyaltyTransaction_universal_d as transactions };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * @adminMethod\n * @returns Created location.\n */\n function createLocation(location: Location): Promise;\n /**\n * Creates locations in bulk.\n * @param locations - Locations to create.\n * @internal\n * @documentationMaturity preview\n * @requiredField locations\n * @permissionId LOCATIONS.MANAGE\n * @adminMethod\n */\n function bulkCreateLocation(locations: 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 * @adminMethod\n * @returns Retrieved location.\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 * @adminMethod\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 * @adminMethod\n * @returns Updated location.\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 * Replaces locations in bulk.\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 locations - Locations to update.\n * @internal\n * @documentationMaturity preview\n * @requiredField locations\n * @permissionId LOCATIONS.MANAGE\n * @adminMethod\n */\n function bulkUpdateLocation(locations: Location[]): Promise;\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 * @permissionId LOCATIONS.READ\n * @adminMethod\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 * @adminMethod\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 * @adminMethod\n */\n function archiveLocation(_id: string): 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 * @param _id - Location id to add type\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField locationType\n * @permissionId LOCATIONS.MANAGE\n * @adminMethod\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 * @param _id - Location id to add type\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField locationType\n * @permissionId LOCATIONS.MANAGE\n * @adminMethod\n */\n function removeLocationType(_id: string, locationType: LocationType): Promise;\n \n type locationsV1Location_universal_d_Location = Location;\n type locationsV1Location_universal_d_LocationStatus = LocationStatus;\n const locationsV1Location_universal_d_LocationStatus: typeof LocationStatus;\n type locationsV1Location_universal_d_LocationType = LocationType;\n const locationsV1Location_universal_d_LocationType: typeof LocationType;\n type locationsV1Location_universal_d_StreetAddress = StreetAddress;\n type locationsV1Location_universal_d_AddressLocation = AddressLocation;\n type locationsV1Location_universal_d_CreateLocationRequest = CreateLocationRequest;\n type locationsV1Location_universal_d_CreateLocationResponse = CreateLocationResponse;\n type locationsV1Location_universal_d_BulkCreateLocationRequest = BulkCreateLocationRequest;\n type locationsV1Location_universal_d_BulkCreateLocationResponse = BulkCreateLocationResponse;\n type locationsV1Location_universal_d_FailedCreateLocation = FailedCreateLocation;\n type locationsV1Location_universal_d_GetLocationRequest = GetLocationRequest;\n type locationsV1Location_universal_d_GetLocationResponse = GetLocationResponse;\n type locationsV1Location_universal_d_ListLocationsRequest = ListLocationsRequest;\n type locationsV1Location_universal_d_Sorting = Sorting;\n type locationsV1Location_universal_d_SortOrder = SortOrder;\n const locationsV1Location_universal_d_SortOrder: typeof SortOrder;\n type locationsV1Location_universal_d_Paging = Paging;\n type locationsV1Location_universal_d_ListLocationsResponse = ListLocationsResponse;\n type locationsV1Location_universal_d_PagingMetadata = PagingMetadata;\n type locationsV1Location_universal_d_UpdateLocationRequest = UpdateLocationRequest;\n type locationsV1Location_universal_d_UpdateLocationResponse = UpdateLocationResponse;\n type locationsV1Location_universal_d_BulkUpdateLocationRequest = BulkUpdateLocationRequest;\n type locationsV1Location_universal_d_BulkUpdateLocationResponse = BulkUpdateLocationResponse;\n type locationsV1Location_universal_d_FailedUpdateLocation = FailedUpdateLocation;\n type locationsV1Location_universal_d_QueryLocationsRequest = QueryLocationsRequest;\n type locationsV1Location_universal_d_Query = Query;\n type locationsV1Location_universal_d_QueryLocationsResponse = QueryLocationsResponse;\n type locationsV1Location_universal_d_SetDefaultLocationRequest = SetDefaultLocationRequest;\n type locationsV1Location_universal_d_SetDefaultLocationResponse = SetDefaultLocationResponse;\n type locationsV1Location_universal_d_SetDefaultLocation = SetDefaultLocation;\n type locationsV1Location_universal_d_ArchiveLocationRequest = ArchiveLocationRequest;\n type locationsV1Location_universal_d_ArchiveLocationResponse = ArchiveLocationResponse;\n type locationsV1Location_universal_d_ArchiveLocation = ArchiveLocation;\n type locationsV1Location_universal_d_AddLocationTypeRequest = AddLocationTypeRequest;\n type locationsV1Location_universal_d_AddLocationTypeResponse = AddLocationTypeResponse;\n type locationsV1Location_universal_d_RemoveLocationTypeRequest = RemoveLocationTypeRequest;\n type locationsV1Location_universal_d_RemoveLocationTypeResponse = RemoveLocationTypeResponse;\n type locationsV1Location_universal_d_DomainEvent = DomainEvent;\n type locationsV1Location_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type locationsV1Location_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type locationsV1Location_universal_d_RestoreInfo = RestoreInfo;\n type locationsV1Location_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type locationsV1Location_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type locationsV1Location_universal_d_ActionEvent = ActionEvent;\n const locationsV1Location_universal_d_createLocation: typeof createLocation;\n const locationsV1Location_universal_d_bulkCreateLocation: typeof bulkCreateLocation;\n const locationsV1Location_universal_d_getLocation: typeof getLocation;\n const locationsV1Location_universal_d_listLocations: typeof listLocations;\n type locationsV1Location_universal_d_ListLocationsOptions = ListLocationsOptions;\n const locationsV1Location_universal_d_updateLocation: typeof updateLocation;\n type locationsV1Location_universal_d_UpdateLocation = UpdateLocation;\n const locationsV1Location_universal_d_bulkUpdateLocation: typeof bulkUpdateLocation;\n const locationsV1Location_universal_d_queryLocations: typeof queryLocations;\n type locationsV1Location_universal_d_LocationsQueryResult = LocationsQueryResult;\n type locationsV1Location_universal_d_LocationsQueryBuilder = LocationsQueryBuilder;\n const locationsV1Location_universal_d_setDefaultLocation: typeof setDefaultLocation;\n const locationsV1Location_universal_d_archiveLocation: typeof archiveLocation;\n const locationsV1Location_universal_d_addLocationType: typeof addLocationType;\n const locationsV1Location_universal_d_removeLocationType: typeof removeLocationType;\n namespace locationsV1Location_universal_d {\n export {\n locationsV1Location_universal_d_Location as Location,\n locationsV1Location_universal_d_LocationStatus as LocationStatus,\n locationsV1Location_universal_d_LocationType as LocationType,\n Address$1 as Address,\n locationsV1Location_universal_d_StreetAddress as StreetAddress,\n locationsV1Location_universal_d_AddressLocation as AddressLocation,\n BusinessSchedule$1 as BusinessSchedule,\n TimePeriod$1 as TimePeriod,\n DayOfWeek$1 as DayOfWeek,\n SpecialHourPeriod$1 as SpecialHourPeriod,\n locationsV1Location_universal_d_CreateLocationRequest as CreateLocationRequest,\n locationsV1Location_universal_d_CreateLocationResponse as CreateLocationResponse,\n locationsV1Location_universal_d_BulkCreateLocationRequest as BulkCreateLocationRequest,\n locationsV1Location_universal_d_BulkCreateLocationResponse as BulkCreateLocationResponse,\n locationsV1Location_universal_d_FailedCreateLocation as FailedCreateLocation,\n locationsV1Location_universal_d_GetLocationRequest as GetLocationRequest,\n locationsV1Location_universal_d_GetLocationResponse as GetLocationResponse,\n locationsV1Location_universal_d_ListLocationsRequest as ListLocationsRequest,\n locationsV1Location_universal_d_Sorting as Sorting,\n locationsV1Location_universal_d_SortOrder as SortOrder,\n locationsV1Location_universal_d_Paging as Paging,\n locationsV1Location_universal_d_ListLocationsResponse as ListLocationsResponse,\n locationsV1Location_universal_d_PagingMetadata as PagingMetadata,\n locationsV1Location_universal_d_UpdateLocationRequest as UpdateLocationRequest,\n locationsV1Location_universal_d_UpdateLocationResponse as UpdateLocationResponse,\n locationsV1Location_universal_d_BulkUpdateLocationRequest as BulkUpdateLocationRequest,\n locationsV1Location_universal_d_BulkUpdateLocationResponse as BulkUpdateLocationResponse,\n locationsV1Location_universal_d_FailedUpdateLocation as FailedUpdateLocation,\n locationsV1Location_universal_d_QueryLocationsRequest as QueryLocationsRequest,\n locationsV1Location_universal_d_Query as Query,\n locationsV1Location_universal_d_QueryLocationsResponse as QueryLocationsResponse,\n locationsV1Location_universal_d_SetDefaultLocationRequest as SetDefaultLocationRequest,\n locationsV1Location_universal_d_SetDefaultLocationResponse as SetDefaultLocationResponse,\n locationsV1Location_universal_d_SetDefaultLocation as SetDefaultLocation,\n locationsV1Location_universal_d_ArchiveLocationRequest as ArchiveLocationRequest,\n locationsV1Location_universal_d_ArchiveLocationResponse as ArchiveLocationResponse,\n locationsV1Location_universal_d_ArchiveLocation as ArchiveLocation,\n locationsV1Location_universal_d_AddLocationTypeRequest as AddLocationTypeRequest,\n locationsV1Location_universal_d_AddLocationTypeResponse as AddLocationTypeResponse,\n locationsV1Location_universal_d_RemoveLocationTypeRequest as RemoveLocationTypeRequest,\n locationsV1Location_universal_d_RemoveLocationTypeResponse as RemoveLocationTypeResponse,\n locationsV1Location_universal_d_DomainEvent as DomainEvent,\n locationsV1Location_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n locationsV1Location_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n locationsV1Location_universal_d_RestoreInfo as RestoreInfo,\n locationsV1Location_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n locationsV1Location_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n locationsV1Location_universal_d_ActionEvent as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n locationsV1Location_universal_d_createLocation as createLocation,\n locationsV1Location_universal_d_bulkCreateLocation as bulkCreateLocation,\n locationsV1Location_universal_d_getLocation as getLocation,\n locationsV1Location_universal_d_listLocations as listLocations,\n locationsV1Location_universal_d_ListLocationsOptions as ListLocationsOptions,\n locationsV1Location_universal_d_updateLocation as updateLocation,\n locationsV1Location_universal_d_UpdateLocation as UpdateLocation,\n locationsV1Location_universal_d_bulkUpdateLocation as bulkUpdateLocation,\n locationsV1Location_universal_d_queryLocations as queryLocations,\n locationsV1Location_universal_d_LocationsQueryResult as LocationsQueryResult,\n locationsV1Location_universal_d_LocationsQueryBuilder as LocationsQueryBuilder,\n locationsV1Location_universal_d_setDefaultLocation as setDefaultLocation,\n locationsV1Location_universal_d_archiveLocation as archiveLocation,\n locationsV1Location_universal_d_addLocationType as addLocationType,\n locationsV1Location_universal_d_removeLocationType as removeLocationType,\n };\n }\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 Wix user defined for their site (before the site visitor 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 to display the additional description - before, after, or instead of 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 * List of fields to return.\n * If omitted, all fields are returned.\n * @internal\n */\n fields?: string[];\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 properties to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `properties` are cleared.\n * @internal\n */\n fields?: string[];\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 /**\n * Set of properties that were updated - corresponds to the fields in \"properties\".\n * @internal\n */\n fields?: string[];\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 * The properties of `businessProfile` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessProfile` are cleared.\n * @internal\n */\n fields?: string[];\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 * The properties of `businessContact` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessContact` are cleared.\n * @internal\n */\n fields?: string[];\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 a site's default consent policy. */\n interface UpdateConsentPolicyRequest {\n /** Default consent policy defined by the Wix user. Can be further limited by site visitors. */\n consentPolicy?: ConsentPolicy;\n }\n interface UpdateConsentPolicyResponse {\n }\n interface BulkPropertiesReadRequest {\n /** Site 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 a current snapshot of a site's properties.\n * @public\n * @documentationMaturity preview\n * @param options - Field options.\n * @permissionId SITE_SETTINGS.VIEW\n * @adminMethod\n * @returns The resulting properties for the requested site.\n */\n function getSiteProperties(options?: GetSitePropertiesOptions): Promise;\n interface GetSitePropertiesOptions {\n /**\n * List of fields to return.\n * If omitted, all fields are returned.\n * @internal\n */\n fields?: string[];\n }\n /**\n * Updates one or more of a site's properties. The site ID is resolved via the Identification Service.\n * @internal\n * @documentationMaturity preview\n * @permissionId SITE_SETTINGS.MODIFY\n * @adminMethod\n * @returns The details resulting from an update operation.\n */\n function update(options?: UpdateOptions): Promise;\n interface UpdateOptions {\n properties?: Properties;\n /**\n * The properties to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `properties` are cleared.\n * @internal\n */\n fields?: string[];\n }\n /**\n * Updates a site's business profile.\n * @param businessProfile - The site's business profile.\n * @public\n * @documentationMaturity preview\n * @requiredField businessProfile\n * @permissionId SITE_PROPERTIES.UPDATE_BUSINESS_PROFILE\n * @adminMethod\n */\n function updateBusinessProfile(businessProfile: BusinessProfileData, options?: UpdateBusinessProfileOptions): Promise;\n interface UpdateBusinessProfileOptions {\n /**\n * The properties of `businessProfile` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessProfile` are cleared.\n * @internal\n */\n fields?: string[];\n }\n /**\n * Updates a site's business contact information.\n * @param businessContact - The site's business contact information.\n * @public\n * @documentationMaturity preview\n * @requiredField businessContact\n * @permissionId SITE_PROPERTIES.UPDATE_BUSINESS_CONTACT\n * @adminMethod\n */\n function updateBusinessContact(businessContact: BusinessContactData, options?: UpdateBusinessContactOptions): Promise;\n interface UpdateBusinessContactOptions {\n /**\n * The properties of `businessContact` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessContact` are cleared.\n * @internal\n */\n fields?: string[];\n }\n /**\n * Updates a site's business schedule.\n *\n * > **Note:** This method 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 specify it in the API call.\n * @param businessSchedule - The site's business schedule in the site time zone.\n * @public\n * @documentationMaturity preview\n * @requiredField businessSchedule\n * @permissionId SITE_PROPERTIES.UPDATE_BUSINESS_SCHEDULE\n * @adminMethod\n */\n function updateBusinessSchedule(businessSchedule: BusinessSchedule): Promise;\n /**\n * Updates a site's default consent policy.\n * @param consentPolicy - Default consent policy defined by the Wix user. Can be further limited by site visitors.\n * @public\n * @documentationMaturity preview\n * @requiredField consentPolicy\n * @permissionId SITE_PROPERTIES.UPDATE_CONSENT_POLICY\n * @adminMethod\n */\n function updateConsentPolicy(consentPolicy: ConsentPolicy): Promise;\n \n type sitepropertiesV4Properties_universal_d_Properties = Properties;\n type sitepropertiesV4Properties_universal_d_Categories = Categories;\n type sitepropertiesV4Properties_universal_d_Locale = Locale;\n type sitepropertiesV4Properties_universal_d_Address = Address;\n type sitepropertiesV4Properties_universal_d_AddressHint = AddressHint;\n type sitepropertiesV4Properties_universal_d_PlacementType = PlacementType;\n const sitepropertiesV4Properties_universal_d_PlacementType: typeof PlacementType;\n type sitepropertiesV4Properties_universal_d_GeoCoordinates = GeoCoordinates;\n type sitepropertiesV4Properties_universal_d_BusinessSchedule = BusinessSchedule;\n type sitepropertiesV4Properties_universal_d_TimePeriod = TimePeriod;\n type sitepropertiesV4Properties_universal_d_DayOfWeek = DayOfWeek;\n const sitepropertiesV4Properties_universal_d_DayOfWeek: typeof DayOfWeek;\n type sitepropertiesV4Properties_universal_d_SpecialHourPeriod = SpecialHourPeriod;\n type sitepropertiesV4Properties_universal_d_Multilingual = Multilingual;\n type sitepropertiesV4Properties_universal_d_SupportedLanguage = SupportedLanguage;\n type sitepropertiesV4Properties_universal_d_ResolutionMethod = ResolutionMethod;\n const sitepropertiesV4Properties_universal_d_ResolutionMethod: typeof ResolutionMethod;\n type sitepropertiesV4Properties_universal_d_ConsentPolicy = ConsentPolicy;\n type sitepropertiesV4Properties_universal_d_PropertiesReadRequest = PropertiesReadRequest;\n type sitepropertiesV4Properties_universal_d_PropertiesReadResponse = PropertiesReadResponse;\n type sitepropertiesV4Properties_universal_d_PropertiesUpdateRequest = PropertiesUpdateRequest;\n type sitepropertiesV4Properties_universal_d_PropertiesUpdateResponse = PropertiesUpdateResponse;\n type sitepropertiesV4Properties_universal_d_SitePropertiesNotification = SitePropertiesNotification;\n type sitepropertiesV4Properties_universal_d_SitePropertiesEvent = SitePropertiesEvent;\n type sitepropertiesV4Properties_universal_d_Translation = Translation;\n type sitepropertiesV4Properties_universal_d_ChangeContext = ChangeContext;\n type sitepropertiesV4Properties_universal_d_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;\n type sitepropertiesV4Properties_universal_d_PropertiesChange = PropertiesChange;\n type sitepropertiesV4Properties_universal_d_SiteCreated = SiteCreated;\n type sitepropertiesV4Properties_universal_d_SiteCloned = SiteCloned;\n type sitepropertiesV4Properties_universal_d_SitePropertiesUpdated = SitePropertiesUpdated;\n type sitepropertiesV4Properties_universal_d_SitePropertiesFullNotification = SitePropertiesFullNotification;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessProfileRequest = UpdateBusinessProfileRequest;\n type sitepropertiesV4Properties_universal_d_BusinessProfileData = BusinessProfileData;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessProfileResponse = UpdateBusinessProfileResponse;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessContactRequest = UpdateBusinessContactRequest;\n type sitepropertiesV4Properties_universal_d_BusinessContactData = BusinessContactData;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessContactResponse = UpdateBusinessContactResponse;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessScheduleRequest = UpdateBusinessScheduleRequest;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessScheduleResponse = UpdateBusinessScheduleResponse;\n type sitepropertiesV4Properties_universal_d_UpdateConsentPolicyRequest = UpdateConsentPolicyRequest;\n type sitepropertiesV4Properties_universal_d_UpdateConsentPolicyResponse = UpdateConsentPolicyResponse;\n type sitepropertiesV4Properties_universal_d_BulkPropertiesReadRequest = BulkPropertiesReadRequest;\n type sitepropertiesV4Properties_universal_d_BulkPropertiesReadResponse = BulkPropertiesReadResponse;\n type sitepropertiesV4Properties_universal_d_MessageEnvelope = MessageEnvelope;\n type sitepropertiesV4Properties_universal_d_IdentificationData = IdentificationData;\n type sitepropertiesV4Properties_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type sitepropertiesV4Properties_universal_d_WebhookIdentityType = WebhookIdentityType;\n const sitepropertiesV4Properties_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const sitepropertiesV4Properties_universal_d_getSiteProperties: typeof getSiteProperties;\n type sitepropertiesV4Properties_universal_d_GetSitePropertiesOptions = GetSitePropertiesOptions;\n const sitepropertiesV4Properties_universal_d_update: typeof update;\n type sitepropertiesV4Properties_universal_d_UpdateOptions = UpdateOptions;\n const sitepropertiesV4Properties_universal_d_updateBusinessProfile: typeof updateBusinessProfile;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessProfileOptions = UpdateBusinessProfileOptions;\n const sitepropertiesV4Properties_universal_d_updateBusinessContact: typeof updateBusinessContact;\n type sitepropertiesV4Properties_universal_d_UpdateBusinessContactOptions = UpdateBusinessContactOptions;\n const sitepropertiesV4Properties_universal_d_updateBusinessSchedule: typeof updateBusinessSchedule;\n const sitepropertiesV4Properties_universal_d_updateConsentPolicy: typeof updateConsentPolicy;\n namespace sitepropertiesV4Properties_universal_d {\n export {\n sitepropertiesV4Properties_universal_d_Properties as Properties,\n sitepropertiesV4Properties_universal_d_Categories as Categories,\n sitepropertiesV4Properties_universal_d_Locale as Locale,\n sitepropertiesV4Properties_universal_d_Address as Address,\n sitepropertiesV4Properties_universal_d_AddressHint as AddressHint,\n sitepropertiesV4Properties_universal_d_PlacementType as PlacementType,\n sitepropertiesV4Properties_universal_d_GeoCoordinates as GeoCoordinates,\n sitepropertiesV4Properties_universal_d_BusinessSchedule as BusinessSchedule,\n sitepropertiesV4Properties_universal_d_TimePeriod as TimePeriod,\n sitepropertiesV4Properties_universal_d_DayOfWeek as DayOfWeek,\n sitepropertiesV4Properties_universal_d_SpecialHourPeriod as SpecialHourPeriod,\n sitepropertiesV4Properties_universal_d_Multilingual as Multilingual,\n sitepropertiesV4Properties_universal_d_SupportedLanguage as SupportedLanguage,\n sitepropertiesV4Properties_universal_d_ResolutionMethod as ResolutionMethod,\n sitepropertiesV4Properties_universal_d_ConsentPolicy as ConsentPolicy,\n sitepropertiesV4Properties_universal_d_PropertiesReadRequest as PropertiesReadRequest,\n sitepropertiesV4Properties_universal_d_PropertiesReadResponse as PropertiesReadResponse,\n sitepropertiesV4Properties_universal_d_PropertiesUpdateRequest as PropertiesUpdateRequest,\n sitepropertiesV4Properties_universal_d_PropertiesUpdateResponse as PropertiesUpdateResponse,\n sitepropertiesV4Properties_universal_d_SitePropertiesNotification as SitePropertiesNotification,\n sitepropertiesV4Properties_universal_d_SitePropertiesEvent as SitePropertiesEvent,\n sitepropertiesV4Properties_universal_d_Translation as Translation,\n sitepropertiesV4Properties_universal_d_ChangeContext as ChangeContext,\n sitepropertiesV4Properties_universal_d_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf,\n sitepropertiesV4Properties_universal_d_PropertiesChange as PropertiesChange,\n sitepropertiesV4Properties_universal_d_SiteCreated as SiteCreated,\n sitepropertiesV4Properties_universal_d_SiteCloned as SiteCloned,\n sitepropertiesV4Properties_universal_d_SitePropertiesUpdated as SitePropertiesUpdated,\n sitepropertiesV4Properties_universal_d_SitePropertiesFullNotification as SitePropertiesFullNotification,\n sitepropertiesV4Properties_universal_d_UpdateBusinessProfileRequest as UpdateBusinessProfileRequest,\n sitepropertiesV4Properties_universal_d_BusinessProfileData as BusinessProfileData,\n sitepropertiesV4Properties_universal_d_UpdateBusinessProfileResponse as UpdateBusinessProfileResponse,\n sitepropertiesV4Properties_universal_d_UpdateBusinessContactRequest as UpdateBusinessContactRequest,\n sitepropertiesV4Properties_universal_d_BusinessContactData as BusinessContactData,\n sitepropertiesV4Properties_universal_d_UpdateBusinessContactResponse as UpdateBusinessContactResponse,\n sitepropertiesV4Properties_universal_d_UpdateBusinessScheduleRequest as UpdateBusinessScheduleRequest,\n sitepropertiesV4Properties_universal_d_UpdateBusinessScheduleResponse as UpdateBusinessScheduleResponse,\n sitepropertiesV4Properties_universal_d_UpdateConsentPolicyRequest as UpdateConsentPolicyRequest,\n sitepropertiesV4Properties_universal_d_UpdateConsentPolicyResponse as UpdateConsentPolicyResponse,\n sitepropertiesV4Properties_universal_d_BulkPropertiesReadRequest as BulkPropertiesReadRequest,\n sitepropertiesV4Properties_universal_d_BulkPropertiesReadResponse as BulkPropertiesReadResponse,\n sitepropertiesV4Properties_universal_d_MessageEnvelope as MessageEnvelope,\n sitepropertiesV4Properties_universal_d_IdentificationData as IdentificationData,\n sitepropertiesV4Properties_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n sitepropertiesV4Properties_universal_d_WebhookIdentityType as WebhookIdentityType,\n sitepropertiesV4Properties_universal_d_getSiteProperties as getSiteProperties,\n sitepropertiesV4Properties_universal_d_GetSitePropertiesOptions as GetSitePropertiesOptions,\n sitepropertiesV4Properties_universal_d_update as update,\n sitepropertiesV4Properties_universal_d_UpdateOptions as UpdateOptions,\n sitepropertiesV4Properties_universal_d_updateBusinessProfile as updateBusinessProfile,\n sitepropertiesV4Properties_universal_d_UpdateBusinessProfileOptions as UpdateBusinessProfileOptions,\n sitepropertiesV4Properties_universal_d_updateBusinessContact as updateBusinessContact,\n sitepropertiesV4Properties_universal_d_UpdateBusinessContactOptions as UpdateBusinessContactOptions,\n sitepropertiesV4Properties_universal_d_updateBusinessSchedule as updateBusinessSchedule,\n sitepropertiesV4Properties_universal_d_updateConsentPolicy as updateConsentPolicy,\n };\n }\n \n export { locationsV1Location_universal_d as locations, sitepropertiesV4Properties_universal_d as siteProperties };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * @adminMethod\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 * @adminMethod\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 * @adminMethod\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 /**\n * Deletes a marketing tag.\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 * @internal\n * @documentationMaturity preview\n * @param options - Options to use when deleting a marketing tag.\n * @permissionId MARKETING_TAGS.MANAGE\n * @adminMethod\n */\n function deleteMarketingTagV2(options?: DeleteMarketingTagV2Options): Promise;\n interface DeleteMarketingTagV2Options {\n /** Marketing tag to delete. */\n tagType?: Type;\n }\n \n type marketingV1Tag_universal_d_MarketingTag = MarketingTag;\n type marketingV1Tag_universal_d_MarketingTagParamsOneOf = MarketingTagParamsOneOf;\n type marketingV1Tag_universal_d_Type = Type;\n const marketingV1Tag_universal_d_Type: typeof Type;\n type marketingV1Tag_universal_d_GoogleAds = GoogleAds;\n type marketingV1Tag_universal_d_GoogleAnalytics = GoogleAnalytics;\n type marketingV1Tag_universal_d_YandexMetrica = YandexMetrica;\n type marketingV1Tag_universal_d_FacebookPixel = FacebookPixel;\n type marketingV1Tag_universal_d_GoogleTagManager = GoogleTagManager;\n type marketingV1Tag_universal_d_TikTokPixel = TikTokPixel;\n type marketingV1Tag_universal_d_GoogleTagManagerConsentMode = GoogleTagManagerConsentMode;\n type marketingV1Tag_universal_d_GoogleAnalyticsConsentMode = GoogleAnalyticsConsentMode;\n type marketingV1Tag_universal_d_HtmlEmbedUpdateMessage = HtmlEmbedUpdateMessage;\n type marketingV1Tag_universal_d_UpsertMarketingTagRequest = UpsertMarketingTagRequest;\n type marketingV1Tag_universal_d_UpsertMarketingTagResponse = UpsertMarketingTagResponse;\n type marketingV1Tag_universal_d_ListMarketingTagsRequest = ListMarketingTagsRequest;\n type marketingV1Tag_universal_d_Filter = Filter;\n type marketingV1Tag_universal_d_ListMarketingTagsResponse = ListMarketingTagsResponse;\n type marketingV1Tag_universal_d_DeleteMarketingTagRequest = DeleteMarketingTagRequest;\n type marketingV1Tag_universal_d_DeleteMarketingTagResponse = DeleteMarketingTagResponse;\n type marketingV1Tag_universal_d_DeleteMarketingTagV2Request = DeleteMarketingTagV2Request;\n type marketingV1Tag_universal_d_DeleteMarketingTagV2Response = DeleteMarketingTagV2Response;\n type marketingV1Tag_universal_d_DomainEvent = DomainEvent;\n type marketingV1Tag_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type marketingV1Tag_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type marketingV1Tag_universal_d_RestoreInfo = RestoreInfo;\n type marketingV1Tag_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type marketingV1Tag_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type marketingV1Tag_universal_d_ActionEvent = ActionEvent;\n type marketingV1Tag_universal_d_MessageEnvelope = MessageEnvelope;\n type marketingV1Tag_universal_d_IdentificationData = IdentificationData;\n type marketingV1Tag_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type marketingV1Tag_universal_d_WebhookIdentityType = WebhookIdentityType;\n const marketingV1Tag_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const marketingV1Tag_universal_d_upsertMarketingTag: typeof upsertMarketingTag;\n const marketingV1Tag_universal_d_listMarketingTags: typeof listMarketingTags;\n type marketingV1Tag_universal_d_ListMarketingTagsOptions = ListMarketingTagsOptions;\n const marketingV1Tag_universal_d_deleteMarketingTag: typeof deleteMarketingTag;\n type marketingV1Tag_universal_d_DeleteMarketingTagOptions = DeleteMarketingTagOptions;\n const marketingV1Tag_universal_d_deleteMarketingTagV2: typeof deleteMarketingTagV2;\n type marketingV1Tag_universal_d_DeleteMarketingTagV2Options = DeleteMarketingTagV2Options;\n namespace marketingV1Tag_universal_d {\n export {\n marketingV1Tag_universal_d_MarketingTag as MarketingTag,\n marketingV1Tag_universal_d_MarketingTagParamsOneOf as MarketingTagParamsOneOf,\n marketingV1Tag_universal_d_Type as Type,\n marketingV1Tag_universal_d_GoogleAds as GoogleAds,\n marketingV1Tag_universal_d_GoogleAnalytics as GoogleAnalytics,\n marketingV1Tag_universal_d_YandexMetrica as YandexMetrica,\n marketingV1Tag_universal_d_FacebookPixel as FacebookPixel,\n marketingV1Tag_universal_d_GoogleTagManager as GoogleTagManager,\n marketingV1Tag_universal_d_TikTokPixel as TikTokPixel,\n marketingV1Tag_universal_d_GoogleTagManagerConsentMode as GoogleTagManagerConsentMode,\n marketingV1Tag_universal_d_GoogleAnalyticsConsentMode as GoogleAnalyticsConsentMode,\n marketingV1Tag_universal_d_HtmlEmbedUpdateMessage as HtmlEmbedUpdateMessage,\n marketingV1Tag_universal_d_UpsertMarketingTagRequest as UpsertMarketingTagRequest,\n marketingV1Tag_universal_d_UpsertMarketingTagResponse as UpsertMarketingTagResponse,\n marketingV1Tag_universal_d_ListMarketingTagsRequest as ListMarketingTagsRequest,\n marketingV1Tag_universal_d_Filter as Filter,\n marketingV1Tag_universal_d_ListMarketingTagsResponse as ListMarketingTagsResponse,\n marketingV1Tag_universal_d_DeleteMarketingTagRequest as DeleteMarketingTagRequest,\n marketingV1Tag_universal_d_DeleteMarketingTagResponse as DeleteMarketingTagResponse,\n marketingV1Tag_universal_d_DeleteMarketingTagV2Request as DeleteMarketingTagV2Request,\n marketingV1Tag_universal_d_DeleteMarketingTagV2Response as DeleteMarketingTagV2Response,\n marketingV1Tag_universal_d_DomainEvent as DomainEvent,\n marketingV1Tag_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n marketingV1Tag_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n marketingV1Tag_universal_d_RestoreInfo as RestoreInfo,\n marketingV1Tag_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n marketingV1Tag_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n marketingV1Tag_universal_d_ActionEvent as ActionEvent,\n marketingV1Tag_universal_d_MessageEnvelope as MessageEnvelope,\n marketingV1Tag_universal_d_IdentificationData as IdentificationData,\n marketingV1Tag_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n marketingV1Tag_universal_d_WebhookIdentityType as WebhookIdentityType,\n marketingV1Tag_universal_d_upsertMarketingTag as upsertMarketingTag,\n marketingV1Tag_universal_d_listMarketingTags as listMarketingTags,\n marketingV1Tag_universal_d_ListMarketingTagsOptions as ListMarketingTagsOptions,\n marketingV1Tag_universal_d_deleteMarketingTag as deleteMarketingTag,\n marketingV1Tag_universal_d_DeleteMarketingTagOptions as DeleteMarketingTagOptions,\n marketingV1Tag_universal_d_deleteMarketingTagV2 as deleteMarketingTagV2,\n marketingV1Tag_universal_d_DeleteMarketingTagV2Options as DeleteMarketingTagV2Options,\n };\n }\n \n export { marketingV1Tag_universal_d as marketingTags };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-stores.v2.d.ts", "content": "declare module \"wix-stores.v2\" {\n interface Collection$1 {\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$1;\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 * Custom SEO data for the collection.\n * @internal\n */\n seoSchema?: SeoSchema$1;\n }\n interface Media$1 {\n /** Primary media (image, video etc) associated with this product. */\n mainMedia?: MediaItem$2;\n /** Media (images, videos etc) associated with this product. */\n items?: MediaItem$2[];\n }\n interface MediaItem$2 extends MediaItemItemOneOf$1 {\n /** Image data (URL, size). */\n image?: MediaItemUrlAndSize$1;\n /** Video data (URL, size). */\n video?: MediaItemVideo$1;\n /** Media item thumbnail details. */\n thumbnail?: MediaItemUrlAndSize$1;\n /** Media item type (image, video, etc.). */\n mediaType?: MediaItemType$2;\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$1 {\n /** Image data (URL, size). */\n image?: MediaItemUrlAndSize$1;\n /** Video data (URL, size). */\n video?: MediaItemVideo$1;\n }\n interface MediaItemUrlAndSize$1 {\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$2 {\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$1 {\n /** Data (URL, size) about each resolution for which this video is available. */\n files?: MediaItemUrlAndSize$1[];\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 /**\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 /** The source that added the keyword terms to the SEO settings. */\n origin?: string | null;\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 QueryCollectionsRequest$1 {\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryCollectionsResponse$1 {\n collections?: Collection$1[];\n metadata?: 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 GetCollectionRequest$1 {\n /** Requested collection ID. */\n _id: string;\n }\n interface GetCollectionResponse$1 {\n collection?: Collection$1;\n }\n interface GetCollectionBySlugRequest$1 {\n /** Slug of the collection to retrieve. */\n slug: string;\n }\n interface GetCollectionBySlugResponse$1 {\n /** The requested collection. */\n collection?: Collection$1;\n }\n /**\n * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryCollections$1(): CollectionsQueryBuilder;\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 CollectionsQueryResult extends QueryOffsetResult$1 {\n items: Collection$1[];\n query: CollectionsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface CollectionsQueryBuilder {\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', value: any) => CollectionsQueryBuilder;\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', value: any) => CollectionsQueryBuilder;\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) => CollectionsQueryBuilder;\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', value: any[]) => CollectionsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: '_id' | 'name', value: boolean) => CollectionsQueryBuilder;\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' | 'name'>) => CollectionsQueryBuilder;\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' | 'name'>) => CollectionsQueryBuilder;\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) => CollectionsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => CollectionsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Retrieves a collection with the provided ID.\n * @param _id - Requested collection ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function getCollection$1(_id: string): Promise;\n /**\n * Retrieves a collection with the provided slug.\n * @param slug - Slug of the collection to retrieve.\n * @public\n * @documentationMaturity preview\n * @requiredField slug\n * @adminMethod\n */\n function getCollectionBySlug$1(slug: string): Promise;\n \n type storesCatalogV1Collection_universal_d_CollectionsQueryResult = CollectionsQueryResult;\n type storesCatalogV1Collection_universal_d_CollectionsQueryBuilder = CollectionsQueryBuilder;\n namespace storesCatalogV1Collection_universal_d {\n export {\n Collection$1 as Collection,\n Media$1 as Media,\n MediaItem$2 as MediaItem,\n MediaItemItemOneOf$1 as MediaItemItemOneOf,\n MediaItemUrlAndSize$1 as MediaItemUrlAndSize,\n MediaItemType$2 as MediaItemType,\n MediaItemVideo$1 as MediaItemVideo,\n SeoSchema$1 as SeoSchema,\n Keyword$1 as Keyword,\n Tag$1 as Tag,\n Settings$1 as Settings,\n QueryCollectionsRequest$1 as QueryCollectionsRequest,\n PlatformQuery$1 as PlatformQuery,\n PlatformQueryPagingMethodOneOf$1 as PlatformQueryPagingMethodOneOf,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n PlatformPaging$1 as PlatformPaging,\n CursorPaging$1 as CursorPaging,\n QueryCollectionsResponse$1 as QueryCollectionsResponse,\n PlatformPagingMetadata$1 as PlatformPagingMetadata,\n Cursors$1 as Cursors,\n GetCollectionRequest$1 as GetCollectionRequest,\n GetCollectionResponse$1 as GetCollectionResponse,\n GetCollectionBySlugRequest$1 as GetCollectionBySlugRequest,\n GetCollectionBySlugResponse$1 as GetCollectionBySlugResponse,\n queryCollections$1 as queryCollections,\n storesCatalogV1Collection_universal_d_CollectionsQueryResult as CollectionsQueryResult,\n storesCatalogV1Collection_universal_d_CollectionsQueryBuilder as CollectionsQueryBuilder,\n getCollection$1 as getCollection,\n getCollectionBySlug$1 as getCollectionBySlug,\n };\n }\n \n interface InventoryItemV2 {\n /** Inventory item ID. */\n _id?: string | null;\n /**\n * @internal\n * @internal\n * @readonly\n * @deprecated Deprecated: use productId.\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: 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 /**\n * @internal\n * @internal\n * @deprecated Deprecated: use productId.\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: string;\n /** Product ID. */\n productId?: string;\n /** Whether inventory is being tracked. */\n trackInventory?: boolean;\n /** Preorder information. */\n preorderInfo?: PreorderInfo$1;\n /**\n * Field mask of updated fields.\n * @internal\n */\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 /**\n * @internal\n * @internal\n * @deprecated Deprecated: use productId.\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: string;\n /** Product ID. */\n productId?: string;\n /** Information about changed variants. */\n variants?: ChangedInventoryVariant[];\n /**\n * Reason data\n * @internal\n */\n reason?: ReasonType;\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 /**\n * @internal\n * @internal\n * @deprecated Deprecated (use productID instead).\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: 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 /**\n * @internal\n * @internal\n * @deprecated Deprecated (use productID instead).\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: 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$3;\n }\n interface Query$3 {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$4;\n /** Filter string */\n filter?: string | null;\n /** Sort string */\n sort?: string | null;\n }\n interface Paging$4 {\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$3;\n /** Number of total results. */\n totalResults?: number;\n }\n interface PagingMetadata$3 {\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$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 UpdateInventoryVariantsRequest {\n /** Inventory item. */\n inventoryItem: InventoryItemV2;\n /** @internal */\n reason?: ReasonType;\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 /** @internal */\n reason?: ReasonType;\n /** @internal */\n changeTrackingMethod?: boolean;\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 /** @internal */\n reason?: ReasonType;\n /** @internal */\n restrictInventoryValue?: boolean;\n }\n interface DecrementData extends DecrementDataIdOneOf {\n /** Inventory item ID. */\n inventoryId?: string;\n /**\n * @internal\n * @internal\n * @deprecated Deprecated: use productId.\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: 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 /**\n * @internal\n * @internal\n * @deprecated Deprecated: use productId.\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: 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 /** @internal */\n reason?: ReasonType;\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 */\n function getInventoryVariants(inventoryId: string, options?: GetInventoryVariantsOptions): Promise;\n interface GetInventoryVariantsOptions extends GetInventoryVariantsRequestIdOneOf {\n /**\n * @internal\n * @internal\n * @deprecated Deprecated (use productID instead).\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: string;\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 * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_INVENTORY\n */\n function queryInventory(options?: QueryInventoryOptions): Promise;\n interface QueryInventoryOptions {\n /** Information about paging, filters, sorting. */\n query?: Query$3;\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 * @adminMethod\n */\n function updateInventoryVariants(productId: string | null, inventoryItem: UpdateInventoryVariantsInventoryItem, options?: UpdateInventoryVariantsOptions): Promise;\n interface UpdateInventoryVariantsInventoryItem {\n /** Inventory item ID. */\n _id?: string | null;\n /**\n * @internal\n * @internal\n * @readonly\n * @deprecated Deprecated: use productId.\n * @replacedBy product_id\n * @targetRemovalDate 2024-12-31\n */\n externalId?: 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 /** @internal */\n reason?: ReasonType;\n }\n /**\n * Updates variants in bulk by filter, including total quantity, whether the product is in stock, and whether the product inventory is tracked.\n * @param filter - Variants filter. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @adminMethod\n */\n function bulkUpdateInventoryVariants(filter: Record | null, options?: BulkUpdateInventoryVariantsOptions): Promise;\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 /** @internal */\n reason?: ReasonType;\n /** @internal */\n changeTrackingMethod?: boolean;\n }\n /**\n * Updates inventory tracking method in bulk by filter.\n * @param variantsFilter - Variants filter\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.trackInventory\n * @requiredField variantsFilter\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @adminMethod\n */\n function bulkUpdateInventoryItems(variantsFilter: Record | null, options: BulkUpdateInventoryItemsOptions): Promise;\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 * @requiredField decrementData\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @adminMethod\n */\n function decrementInventory(decrementData: DecrementData[], options?: DecrementInventoryOptions): Promise;\n interface DecrementInventoryOptions {\n /** @internal */\n reason?: ReasonType;\n /** @internal */\n restrictInventoryValue?: boolean;\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 * @requiredField incrementData\n * @permissionId WIX_STORES.MODIFY_INVENTORY\n * @adminMethod\n */\n function incrementInventory(incrementData: IncrementData[], options?: IncrementInventoryOptions): Promise;\n interface IncrementInventoryOptions {\n /** @internal */\n reason?: ReasonType;\n }\n \n type storesV2Inventory_universal_d_InventoryItemV2 = InventoryItemV2;\n type storesV2Inventory_universal_d_InventoryVariantV2 = InventoryVariantV2;\n type storesV2Inventory_universal_d_InventoryItemChanged = InventoryItemChanged;\n type storesV2Inventory_universal_d_InventoryVariantsChanged = InventoryVariantsChanged;\n type storesV2Inventory_universal_d_ChangedInventoryVariant = ChangedInventoryVariant;\n type storesV2Inventory_universal_d_ChangedInventoryVariantData = ChangedInventoryVariantData;\n type storesV2Inventory_universal_d_ReasonType = ReasonType;\n const storesV2Inventory_universal_d_ReasonType: typeof ReasonType;\n type storesV2Inventory_universal_d_GetInventoryVariantsRequest = GetInventoryVariantsRequest;\n type storesV2Inventory_universal_d_GetInventoryVariantsRequestIdOneOf = GetInventoryVariantsRequestIdOneOf;\n type storesV2Inventory_universal_d_GetInventoryVariantsResponse = GetInventoryVariantsResponse;\n type storesV2Inventory_universal_d_GetInventoryItemsRequest = GetInventoryItemsRequest;\n type storesV2Inventory_universal_d_GetInventoryItemsResponse = GetInventoryItemsResponse;\n type storesV2Inventory_universal_d_QueryInventoryRequest = QueryInventoryRequest;\n type storesV2Inventory_universal_d_QueryInventoryResponse = QueryInventoryResponse;\n type storesV2Inventory_universal_d_UpdateInventoryVariantsRequest = UpdateInventoryVariantsRequest;\n type storesV2Inventory_universal_d_UpdateInventoryVariantsResponse = UpdateInventoryVariantsResponse;\n type storesV2Inventory_universal_d_BulkUpdateInventoryVariantsRequest = BulkUpdateInventoryVariantsRequest;\n type storesV2Inventory_universal_d_BulkUpdateInventoryVariantsRequestActionOneOf = BulkUpdateInventoryVariantsRequestActionOneOf;\n type storesV2Inventory_universal_d_BulkUpdateInventoryVariantsResponse = BulkUpdateInventoryVariantsResponse;\n type storesV2Inventory_universal_d_BulkUpdateInventoryItemsRequest = BulkUpdateInventoryItemsRequest;\n type storesV2Inventory_universal_d_BulkUpdateInventoryItemsResponse = BulkUpdateInventoryItemsResponse;\n type storesV2Inventory_universal_d_DecrementInventoryRequest = DecrementInventoryRequest;\n type storesV2Inventory_universal_d_DecrementData = DecrementData;\n type storesV2Inventory_universal_d_DecrementDataIdOneOf = DecrementDataIdOneOf;\n type storesV2Inventory_universal_d_DecrementInventoryResponse = DecrementInventoryResponse;\n type storesV2Inventory_universal_d_IncrementInventoryRequest = IncrementInventoryRequest;\n type storesV2Inventory_universal_d_IncrementData = IncrementData;\n type storesV2Inventory_universal_d_IncrementDataIdOneOf = IncrementDataIdOneOf;\n type storesV2Inventory_universal_d_IncrementInventoryResponse = IncrementInventoryResponse;\n const storesV2Inventory_universal_d_getInventoryVariants: typeof getInventoryVariants;\n type storesV2Inventory_universal_d_GetInventoryVariantsOptions = GetInventoryVariantsOptions;\n const storesV2Inventory_universal_d_queryInventory: typeof queryInventory;\n type storesV2Inventory_universal_d_QueryInventoryOptions = QueryInventoryOptions;\n const storesV2Inventory_universal_d_updateInventoryVariants: typeof updateInventoryVariants;\n type storesV2Inventory_universal_d_UpdateInventoryVariantsInventoryItem = UpdateInventoryVariantsInventoryItem;\n type storesV2Inventory_universal_d_UpdateInventoryVariantsOptions = UpdateInventoryVariantsOptions;\n const storesV2Inventory_universal_d_bulkUpdateInventoryVariants: typeof bulkUpdateInventoryVariants;\n type storesV2Inventory_universal_d_BulkUpdateInventoryVariantsOptions = BulkUpdateInventoryVariantsOptions;\n const storesV2Inventory_universal_d_bulkUpdateInventoryItems: typeof bulkUpdateInventoryItems;\n type storesV2Inventory_universal_d_BulkUpdateInventoryItemsOptions = BulkUpdateInventoryItemsOptions;\n const storesV2Inventory_universal_d_decrementInventory: typeof decrementInventory;\n type storesV2Inventory_universal_d_DecrementInventoryOptions = DecrementInventoryOptions;\n const storesV2Inventory_universal_d_incrementInventory: typeof incrementInventory;\n type storesV2Inventory_universal_d_IncrementInventoryOptions = IncrementInventoryOptions;\n namespace storesV2Inventory_universal_d {\n export {\n storesV2Inventory_universal_d_InventoryItemV2 as InventoryItemV2,\n storesV2Inventory_universal_d_InventoryVariantV2 as InventoryVariantV2,\n PreorderInfo$1 as PreorderInfo,\n storesV2Inventory_universal_d_InventoryItemChanged as InventoryItemChanged,\n storesV2Inventory_universal_d_InventoryVariantsChanged as InventoryVariantsChanged,\n storesV2Inventory_universal_d_ChangedInventoryVariant as ChangedInventoryVariant,\n storesV2Inventory_universal_d_ChangedInventoryVariantData as ChangedInventoryVariantData,\n storesV2Inventory_universal_d_ReasonType as ReasonType,\n storesV2Inventory_universal_d_GetInventoryVariantsRequest as GetInventoryVariantsRequest,\n storesV2Inventory_universal_d_GetInventoryVariantsRequestIdOneOf as GetInventoryVariantsRequestIdOneOf,\n storesV2Inventory_universal_d_GetInventoryVariantsResponse as GetInventoryVariantsResponse,\n storesV2Inventory_universal_d_GetInventoryItemsRequest as GetInventoryItemsRequest,\n storesV2Inventory_universal_d_GetInventoryItemsResponse as GetInventoryItemsResponse,\n storesV2Inventory_universal_d_QueryInventoryRequest as QueryInventoryRequest,\n Query$3 as Query,\n Paging$4 as Paging,\n storesV2Inventory_universal_d_QueryInventoryResponse as QueryInventoryResponse,\n PagingMetadata$3 as PagingMetadata,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n storesV2Inventory_universal_d_UpdateInventoryVariantsRequest as UpdateInventoryVariantsRequest,\n storesV2Inventory_universal_d_UpdateInventoryVariantsResponse as UpdateInventoryVariantsResponse,\n storesV2Inventory_universal_d_BulkUpdateInventoryVariantsRequest as BulkUpdateInventoryVariantsRequest,\n storesV2Inventory_universal_d_BulkUpdateInventoryVariantsRequestActionOneOf as BulkUpdateInventoryVariantsRequestActionOneOf,\n storesV2Inventory_universal_d_BulkUpdateInventoryVariantsResponse as BulkUpdateInventoryVariantsResponse,\n storesV2Inventory_universal_d_BulkUpdateInventoryItemsRequest as BulkUpdateInventoryItemsRequest,\n storesV2Inventory_universal_d_BulkUpdateInventoryItemsResponse as BulkUpdateInventoryItemsResponse,\n storesV2Inventory_universal_d_DecrementInventoryRequest as DecrementInventoryRequest,\n storesV2Inventory_universal_d_DecrementData as DecrementData,\n storesV2Inventory_universal_d_DecrementDataIdOneOf as DecrementDataIdOneOf,\n storesV2Inventory_universal_d_DecrementInventoryResponse as DecrementInventoryResponse,\n storesV2Inventory_universal_d_IncrementInventoryRequest as IncrementInventoryRequest,\n storesV2Inventory_universal_d_IncrementData as IncrementData,\n storesV2Inventory_universal_d_IncrementDataIdOneOf as IncrementDataIdOneOf,\n storesV2Inventory_universal_d_IncrementInventoryResponse as IncrementInventoryResponse,\n storesV2Inventory_universal_d_getInventoryVariants as getInventoryVariants,\n storesV2Inventory_universal_d_GetInventoryVariantsOptions as GetInventoryVariantsOptions,\n storesV2Inventory_universal_d_queryInventory as queryInventory,\n storesV2Inventory_universal_d_QueryInventoryOptions as QueryInventoryOptions,\n storesV2Inventory_universal_d_updateInventoryVariants as updateInventoryVariants,\n storesV2Inventory_universal_d_UpdateInventoryVariantsInventoryItem as UpdateInventoryVariantsInventoryItem,\n storesV2Inventory_universal_d_UpdateInventoryVariantsOptions as UpdateInventoryVariantsOptions,\n storesV2Inventory_universal_d_bulkUpdateInventoryVariants as bulkUpdateInventoryVariants,\n storesV2Inventory_universal_d_BulkUpdateInventoryVariantsOptions as BulkUpdateInventoryVariantsOptions,\n storesV2Inventory_universal_d_bulkUpdateInventoryItems as bulkUpdateInventoryItems,\n storesV2Inventory_universal_d_BulkUpdateInventoryItemsOptions as BulkUpdateInventoryItemsOptions,\n storesV2Inventory_universal_d_decrementInventory as decrementInventory,\n storesV2Inventory_universal_d_DecrementInventoryOptions as DecrementInventoryOptions,\n storesV2Inventory_universal_d_incrementInventory as incrementInventory,\n storesV2Inventory_universal_d_IncrementInventoryOptions as IncrementInventoryOptions,\n };\n }\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 | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$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 /** Weight unit used in this store. */\n weightUnit?: WeightUnit;\n /** Totals for order's line items. */\n totals?: Totals$1;\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 * @deprecated\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$1[];\n /** Invoice information. */\n invoiceInfo?: InvoiceInfo;\n /**\n * Order fulfillment information.\n * @readonly\n */\n fulfillments?: Fulfillment[];\n /** Discount information. */\n discount?: Discount$2;\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 | null;\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?: Refund[];\n /**\n * Gift card information.\n * @internal\n */\n giftCard?: GiftCard;\n /**\n * ID of the checkout associated with this order.\n * @internal\n */\n checkoutId?: string | null;\n /**\n * Private API flag that allows using read-only \"id\" during order creation\n * @internal\n */\n isInternalOrderCreate?: boolean;\n }\n /** Buyer Info */\n interface BuyerInfo$1 {\n /** Wix customer ID */\n _id?: string | null;\n /**\n * Deprecated (use identityType instead)\n * @readonly\n * @deprecated\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 * Contact Id. needed for cases where the user is the buyer and so it doesn't exist on the buyer info\n * @internal\n * @readonly\n */\n contactId?: string | null;\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$1 {\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 * @deprecated\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 | null;\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 /**\n * Deprecated - Latest expected delivery date.\n * @deprecated\n */\n deliverByDate?: Date | null;\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 * @deprecated\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 * @deprecated\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 * @deprecated\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 * @deprecated\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$1;\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 * @deprecated\n */\n taxIncludedInPrice?: boolean;\n /** Tax group ID */\n taxGroupId?: string | null;\n /** Price data */\n priceData?: LineItemPriceData;\n /**\n * Line item refundedQuantity (from refund). No value means not refunded. Shows the number of line items that were refunded\n * @internal\n * @readonly\n */\n refundedQuantity?: number | null;\n /**\n * Digital file identifier, relevant only for items with type DIGITAL\n * @internal\n */\n digitalFile?: DigitalFile;\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$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 /**\n * Deprecated\n * @deprecated\n */\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$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 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$1 {\n /**\n * Activity item type\n * @readonly\n */\n type?: ActivityType$1;\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 | null;\n }\n enum ActivityType$1 {\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 InvoiceInfo {\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 | null;\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$2 {\n /**\n * Deprecated (use Totals.discount instead)\n * @readonly\n * @deprecated\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$1;\n /** Subscription options info. */\n subscriptionOptionInfo?: SubscriptionOptionInfo;\n }\n interface SubscriptionSettings$1 {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency$1;\n /**\n * Interval of recurring payment (optional: default value 1 will be used if not provided)\n * @internal\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: 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 SubscriptionOptionInfo {\n /**\n * Subscription option ID.\n * @internal\n */\n _id?: string | null;\n /** Subscription option title. */\n title?: string;\n /** Subscription option description. */\n description?: string | null;\n }\n interface Refund {\n /** Refund created timestamp. */\n dateCreated?: Date | null;\n /** Refund amount. */\n amount?: string;\n /** Reason for refund, given by user (optional). */\n reason?: string | null;\n /**\n * Deprecated. Use externalRefund.\n * @internal\n * @deprecated\n */\n isManual?: boolean;\n /**\n * Deprecated. Use payment_provider_transaction_id.\n * @internal\n * @deprecated\n */\n providerTransactionId?: string | null;\n /**\n * Deprecated. Use id.\n * @internal\n * @deprecated\n */\n refundId?: string;\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 /**\n * giftcard internal ID\n * @deprecated giftcard internal ID\n * @targetRemovalDate 2024-12-31\n */\n _id?: string;\n /** giftcard provider appid */\n providerId?: string;\n /** giftcard amount */\n amount?: string;\n }\n interface OrderEvent {\n /** Order ID (auto generated upon order creation) */\n orderId?: string;\n /** ID displayed in the owner's store (auto generated) */\n number?: string;\n /** Order creation date */\n dateCreated?: Date | null;\n /** Customer information */\n buyerInfo?: BuyerInfo$1;\n /** Currency used for pricing in this store */\n currency?: string;\n /** Weight unit used in this store */\n weightUnit?: WeightUnit;\n /** Totals for order's line items */\n totals?: Totals$1;\n /** Whether the order was read by the store owner */\n read?: boolean;\n /** Order archive status */\n archived?: boolean;\n /** Order payment status */\n paymentStatus?: PaymentStatus;\n /** Order fulfillment status */\n fulfillmentStatus?: FulfillmentStatus;\n /** @internal */\n ordersExperiments?: OrdersExperiments;\n /**\n * Checkout id\n * @internal\n */\n checkoutId?: string | null;\n /**\n * Applied coupon\n * @internal\n */\n appliedCoupon?: AppliedCoupon;\n /**\n * Subscription information\n * @internal\n */\n subscriptionInfo?: SubscriptionInfo;\n /** @internal */\n cartId?: string | null;\n /**\n * Billing information.\n * @internal\n */\n billingInfo?: BillingInfo;\n }\n interface OrdersExperiments {\n epCommitTax?: boolean;\n moveMerchantEmailToEp?: boolean;\n moveBuyerOrderConfirmationEmailToEp?: boolean;\n producedByEpBridge?: boolean;\n enableRewrittenSideEffects?: boolean;\n }\n interface MarkAsPaidRequest {\n /** The order id */\n _id: string;\n /** The payment info */\n paymentInfo: RequestPaymentInfo;\n }\n interface RequestPaymentInfo {\n /** Payment method used for this order */\n paymentMethod?: string;\n /** External transaction ID */\n externalTransactionId?: string;\n }\n interface MarkAsPaidResponse {\n }\n interface SetShippingFulfillmentRequest {\n /** The order id */\n _id: string;\n /** Shipment fulfillment status */\n status?: ShipmentFulfillmentStatus;\n }\n /** This may be expanded in the future to include partial fulfillments */\n enum ShipmentFulfillmentStatus {\n /** Shipment fulfillment status can't be classified, due to an error */\n UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS = \"UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS\",\n /** Entire order's shipment is not fulfilled */\n SHIPMENT_NOT_FULFILLED = \"SHIPMENT_NOT_FULFILLED\",\n /** Entire order's shipment is fulfilled */\n SHIPMENT_FULFILLED = \"SHIPMENT_FULFILLED\"\n }\n interface SetShippingFulfillmentResponse {\n }\n interface SendFulfillmentConfirmationRequest {\n /** The order id */\n _id: string;\n }\n interface SendFulfillmentConfirmationResponse {\n }\n interface MarkAsReadRequest {\n /** The order id */\n _id: string;\n }\n interface MarkAsReadResponse {\n }\n interface SetArchiveStatusRequest {\n /** The order id */\n _id: string;\n /** New archive status */\n archived?: boolean;\n }\n interface SetArchiveStatusResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent {\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 OrderAddressUpdated {\n /**\n * Updated order data.\n * @readonly\n */\n order?: Order;\n }\n interface CreateOrderRequest {\n order: Order;\n /**\n * Additional order settings.\n * @internal\n */\n additionalOrderSettings?: AdditionalOrderSettings[];\n }\n interface AdditionalOrderSettings {\n /** ID of the line item this setting applies to */\n lineItemId?: string | null;\n /** Whether this line item purchase was made as part of a purchase that includes preorder items. */\n preorderRequest?: boolean;\n }\n interface CreateOrderResponse {\n order?: Order;\n }\n interface BulkFulfillOrdersRequest {\n filter: Record | null;\n /** when true shipping confirmation email will be sent to the buyer for all orders with shipment delivery */\n sendShippingConfirmationEmail?: boolean;\n /** when true pickup ready email will be sent to the buyer for all orders with pickup delivery */\n sendPickupReadyEmail?: boolean;\n }\n interface BulkFulfillOrdersResponse {\n }\n interface BulkMarkOrdersAsPaidRequest {\n filter: Record | null;\n }\n interface BulkMarkOrdersAsPaidResponse {\n }\n interface BulkArchiveOrdersRequest {\n filter: Record | null;\n }\n interface BulkArchiveOrdersResponse {\n }\n interface BulkUnarchiveOrdersRequest {\n filter: Record | null;\n }\n interface BulkUnarchiveOrdersResponse {\n }\n interface AddFulfillerEmailWasSentActivityRequest {\n orderId: string;\n }\n interface AddFulfillerEmailWasSentActivityResponse {\n }\n interface DeclineOrderRequest {\n orderId: string;\n eventTime?: Date | null;\n reason?: string | null;\n }\n interface DeclineOrderResponse {\n }\n interface UpdateOrderEmailRequest {\n /**\n * Order ID.\n * @readonly\n */\n orderId: string;\n /** New email address for billing and shipping info. */\n email?: string;\n }\n interface UpdateOrderEmailResponse {\n /** Updated order data. */\n order?: Order;\n }\n interface UpdateOrderShippingAddressRequest {\n /**\n * Order ID.\n * @readonly\n */\n orderId: string;\n /** New order shipping address. */\n shippingAddress?: Address;\n }\n interface UpdateOrderShippingAddressResponse {\n /** Updated order data. */\n order?: Order;\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 OrderCreated {\n /** Order ID (auto generated upon order creation) */\n orderId?: string;\n /** ID displayed in the owner's store (auto generated) */\n number?: string;\n /** Order creation date */\n dateCreated?: Date | null;\n /** Customer information */\n buyerInfo?: BuyerInfo$1;\n /** Currency used for pricing in this store */\n currency?: string;\n /** Weight unit used in this store */\n weightUnit?: WeightUnit;\n /** Totals for order's line items */\n totals?: Totals$1;\n /** Whether the order was read by the store owner */\n read?: boolean;\n /** Order archive status */\n archived?: boolean;\n /** Order payment status */\n paymentStatus?: PaymentStatus;\n /** Order fulfillment status */\n fulfillmentStatus?: FulfillmentStatus;\n /** @internal */\n ordersExperiments?: OrdersExperiments;\n /**\n * Checkout id\n * @internal\n */\n checkoutId?: string | null;\n /**\n * Applied coupon\n * @internal\n */\n appliedCoupon?: AppliedCoupon;\n /**\n * Subscription information\n * @internal\n */\n subscriptionInfo?: SubscriptionInfo;\n /** @internal */\n cartId?: string | null;\n /**\n * Billing information.\n * @internal\n */\n billingInfo?: BillingInfo;\n }\n interface OrderPaid {\n /** Paid order data. */\n order?: Order;\n /** @internal */\n ordersExperiments?: OrdersExperiments;\n }\n interface OrderCancelRefundEvent {\n /** @readonly */\n isCancel?: boolean;\n /**\n * date when cancel/refund was issued\n * @readonly\n */\n issueDate?: Date | null;\n /** will be defined if order was refunded */\n refund?: Refund;\n orderData?: OrderData;\n }\n interface OrderData {\n /**\n * Order ID (auto generated upon order creation)\n * @readonly\n */\n orderId?: string;\n /**\n * means that order paid with cash, such orders might be not paid\n * @readonly\n */\n isOffline?: boolean;\n /**\n * Order payment status\n * @readonly\n */\n paymentStatus?: PaymentStatus;\n /** Total price charged when order placed, this value isn't affected by refunds */\n originalTotal?: string;\n /**\n * Order creation date\n * @readonly\n */\n dateCreated?: Date | null;\n }\n interface OrderCanceled {\n /**\n * Canceled order data.\n * @readonly\n */\n order?: Order;\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 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 | null;\n /** Buyer information. */\n buyerInfo?: BuyerInfo$1;\n /** Order fulfillment status. */\n fulfillmentStatus?: FulfillmentStatus;\n /** Fulfillment tracking information. */\n trackingInfo?: FulfillmentTrackingInfo;\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?: FulfillmentTrackingInfo;\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;\n }\n interface OrderDeclined {\n order?: Order;\n }\n interface GetOrderRequestV2 {\n /** Requested order ID */\n _id: string;\n }\n interface GetOrderResponseV2 {\n /** Order data */\n order?: Order;\n }\n interface QueryOrdersRequestV2 {\n /** Query */\n query?: Query$2;\n }\n interface Query$2 {\n paging?: Paging$3;\n /** A filter string */\n filter?: string | null;\n /** A sort string */\n sort?: string | null;\n }\n interface Paging$3 {\n /** Number of items to load */\n limit?: number | null;\n /** The offset since the beginning of the collection */\n offset?: number | null;\n }\n interface QueryOrdersResponseV2 {\n /** Order data */\n orders?: Order[];\n /** Paging metadata */\n metadata?: PagingMetadata$2;\n /** Total results */\n totalResults?: number;\n }\n interface PagingMetadata$2 {\n /** Requested number of items to load */\n items?: number;\n /** Requested offset since the beginning of the collection */\n offset?: number;\n }\n interface CreateFulfillmentRequest {\n /** Order ID (to which the fulfillment will be related). */\n orderId: string;\n /** Fulfillment info. */\n fulfillment: Fulfillment;\n }\n interface CreateFulfillmentResponse {\n /** Fulfillment ID. */\n _id?: string;\n /** Updated order data. */\n order?: Order;\n }\n interface UpdateFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID */\n fulfillmentId: string;\n /** Updated tracking info. */\n fulfillmentTrackingInfo?: FulfillmentTrackingInfo;\n }\n interface UpdateFulfillmentResponse {\n /** Updated order data. */\n order?: Order;\n }\n interface DeleteFulfillmentRequest {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID. */\n fulfillmentId: string;\n }\n interface DeleteFulfillmentResponse {\n /** Updated order data. */\n order?: Order;\n }\n /**\n * Add payment data for an order\n * @param _id - The order id\n * @param paymentInfo - The payment info\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField paymentInfo\n * @adminMethod\n */\n function markAsPaid(_id: string, paymentInfo: RequestPaymentInfo): Promise;\n /**\n * Set order's shipping's fulfillment status\n * @param _id - The order id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function setShippingFulfillment(_id: string, options?: SetShippingFulfillmentOptions): Promise;\n interface SetShippingFulfillmentOptions {\n /** Shipment fulfillment status */\n status?: ShipmentFulfillmentStatus;\n }\n /**\n * Send confirmation mail for either pickup/shipment fulfillment\n * @param _id - The order id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function sendFulfillmentConfirmation(_id: string): Promise;\n /**\n * Mark order as read\n * @param _id - The order id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function markAsRead(_id: string): Promise;\n /**\n * Set order's archive status\n * @param _id - The order id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function setArchiveStatus(_id: string, options?: SetArchiveStatusOptions): Promise;\n interface SetArchiveStatusOptions {\n /** New archive status */\n archived?: boolean;\n }\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Create Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/create-order)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Creates a new order.\n *\n * > **Notes:**\n * > + Only orders with the `paymentStatus` parameter set as `\"PAID\"` or `\"NOT_PAID\"` will show up in the site owner's Stores Orders tab in their dashboard.\n * > + The `billingInfo.paymentProviderTransactionId` and `billingInfo.paymentMethod` parameters can only be passed when paymentStatus is PAID.\n * > + The `billingInfo`.address parameter is required unless `channelInfo.type: \"POS\"`.\n * > + The `shippingInfo.shipmentDetails.address` parameter is required unless one of the following is true:\n * > + The `shippingInfo.pickupDetails` is passed instead\n * > + `channelInfo.type: \"POS\"`\n * > + All order items are of type digital - `lineItems.lineItemType: \"DIGITAL\"`.\n * > + When passing `lineItems.variantId`, `lineItems.options` is required.\n * > + When passing `lineItems.productId`, `lineItem.lineItemType` is limited to `\"PHYSICAL\"`.\n * > + When not passing `lineItems.productId`, `lineItem.lineItemType` is limited to `\"CUSTOM_AMOUNT_ITEM\"`.\n * @internal\n * @documentationMaturity preview\n * @requiredField order\n * @requiredField order.totals\n * @permissionId WIX_STORES.CREATE_ORDERS\n * @adminMethod\n * @deprecated Stores Create Order has been replaced with eCommerce Create Order.\n * @replacedBy com.wix.ecom.orders.v1.Orders.CreateOrder\n * @targetRemovalDate 2024-09-04\n */\n function createOrder(order: Order, options?: CreateOrderOptions): Promise;\n interface CreateOrderOptions {\n /**\n * Additional order settings.\n * @internal\n */\n additionalOrderSettings?: AdditionalOrderSettings[];\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkFulfillOrders(filter: Record | null, options?: BulkFulfillOrdersOptions): Promise;\n interface BulkFulfillOrdersOptions {\n /** when true shipping confirmation email will be sent to the buyer for all orders with shipment delivery */\n sendShippingConfirmationEmail?: boolean;\n /** when true pickup ready email will be sent to the buyer for all orders with pickup delivery */\n sendPickupReadyEmail?: boolean;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkMarkOrdersAsPaid(filter: Record | null): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n * @deprecated\n * @replacedBy com.wix.ecom.orders.v1.Orders.BulkUpdateOrders\n * @targetRemovalDate 2025-03-02\n */\n function bulkArchiveOrders(filter: Record | null): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n */\n function bulkUnarchiveOrders(filter: Record | null): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n */\n function addFulfillerEmailWasSentActivity(orderId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n */\n function declineOrder(orderId: string, options?: DeclineOrderOptions): Promise;\n interface DeclineOrderOptions {\n eventTime?: Date | null;\n reason?: string | null;\n }\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Update Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/update-order)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Updates the email address of a specified order's billing info.\n * If shipping was selected as the delivery method, shipping info email will also be updated.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n * @deprecated Stores Update Order Email has been replaced with eCommerce Update Order.\n * @replacedBy com.wix.ecom.orders.v1.Orders.UpdateOrder\n * @targetRemovalDate 2024-09-04\n */\n function updateOrderEmail(orderId: string, options?: UpdateOrderEmailOptions): Promise;\n interface UpdateOrderEmailOptions {\n /** New email address for billing and shipping info. */\n email?: string;\n }\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Update Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/update-order)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Updates the shipping address of a specified order.\n * @param orderId - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n * @deprecated Stores Update Order Shipping Address has been replaced with eCommerce Update Order.\n * @replacedBy com.wix.ecom.orders.v1.Orders.UpdateOrder\n * @targetRemovalDate 2024-09-04\n */\n function updateOrderShippingAddress(orderId: string, options?: UpdateOrderShippingAddressOptions): Promise;\n interface UpdateOrderShippingAddressOptions {\n /** New order shipping address. */\n shippingAddress?: Address;\n }\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Get Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/get-order)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Returns an order with the provided ID.\n * @param _id - Requested order ID\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.READ_ORDERS\n * @adminMethod\n * @deprecated Stores Get Order has been replaced with eCommerce Get Order.\n * @replacedBy com.wix.ecom.orders.v1.Orders.GetOrder\n * @targetRemovalDate 2024-09-04\n */\n function getOrder(_id: string): Promise;\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Search Orders](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/search-orders)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Returns a list of up to 100 orders, given the provided paging, sorting and filters.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * Hidden orders are not returned.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_ORDERS\n * @adminMethod\n * @deprecated Stores Query Orders has been replaced with eCommerce Search Orders.\n * @replacedBy com.wix.ecom.orders.v1.Orders.SearchOrders\n * @targetRemovalDate 2024-09-04\n */\n function queryOrders(options?: QueryOrdersOptions): Promise;\n interface QueryOrdersOptions {\n /** Query */\n query?: Query$2;\n }\n /**\n * Temp method for analytics migration\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_ORDERS\n * @adminMethod\n */\n function queryOrdersEventuallyConsistent(options?: QueryOrdersEventuallyConsistentOptions): Promise;\n interface QueryOrdersEventuallyConsistentOptions {\n /** Query */\n query?: Query$2;\n }\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Create Fulfillment](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/create-fulfillment)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Creates a fulfillment (a subset of an order, with line items that are being shipped together) based on the body parameters passed with the request.\n * If the site owner has requested it, calling this request will trigger an email to the customer (based on the Wix store settings).\n * @param orderId - Order ID (to which the fulfillment will be related).\n * @param fulfillment - Fulfillment info.\n * @internal\n * @documentationMaturity preview\n * @requiredField fulfillment\n * @requiredField orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n * @deprecated Stores Create Fulfillment has been replaced with eCommerce Create Fulfillment.\n * @replacedBy com.wix.ecom.orders.fulfillments.v1.Fulfillments.CreateFulfillment\n * @targetRemovalDate 2024-09-04\n */\n function createFulfillment(orderId: string, fulfillment: Fulfillment): Promise;\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Update Fulfillment](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/update-fulfillment)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Updates an existing fulfillment.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.fulfillmentId\n * @requiredField identifiers.orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n * @deprecated Stores Update Fulfillment has been replaced with eCommerce Update Fulfillment.\n * @replacedBy com.wix.ecom.orders.fulfillments.v1.Fulfillments.UpdateFulfillment\n * @targetRemovalDate 2024-09-04\n */\n function updateFulfillment(identifiers: UpdateFulfillmentIdentifiers, options?: UpdateFulfillmentOptions): Promise;\n interface UpdateFulfillmentIdentifiers {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID */\n fulfillmentId: string;\n }\n interface UpdateFulfillmentOptions {\n /** Updated tracking info. */\n fulfillmentTrackingInfo?: FulfillmentTrackingInfo;\n }\n /**\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with\n * [eCommerce Delete Fulfillment](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/delete-fulfillment)\n * and will be removed on September 4, 2024.\n *\n *
      \n *\n * Deletes an existing fulfillment.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.fulfillmentId\n * @requiredField identifiers.orderId\n * @permissionId WIX_STORES.MODIFY_ORDERS\n * @adminMethod\n * @deprecated Stores Delete Fulfillment has been replaced with eCommerce Delete Fulfillment.\n * @replacedBy com.wix.ecom.orders.fulfillments.v1.Fulfillments.DeleteFulfillment\n * @targetRemovalDate 2024-09-04\n */\n function deleteFulfillment(identifiers: DeleteFulfillmentIdentifiers): Promise;\n interface DeleteFulfillmentIdentifiers {\n /** Order ID. */\n orderId: string;\n /** Fulfillment ID. */\n fulfillmentId: string;\n }\n \n type storesV2Orders_universal_d_Order = Order;\n type storesV2Orders_universal_d_IdentityType = IdentityType;\n const storesV2Orders_universal_d_IdentityType: typeof IdentityType;\n type storesV2Orders_universal_d_WeightUnit = WeightUnit;\n const storesV2Orders_universal_d_WeightUnit: typeof WeightUnit;\n type storesV2Orders_universal_d_BillingInfo = BillingInfo;\n type storesV2Orders_universal_d_Address = Address;\n type storesV2Orders_universal_d_AddressAddressLine1OptionsOneOf = AddressAddressLine1OptionsOneOf;\n type storesV2Orders_universal_d_FullName = FullName;\n type storesV2Orders_universal_d_Street = Street;\n type storesV2Orders_universal_d_VatId = VatId;\n type storesV2Orders_universal_d_VatType = VatType;\n const storesV2Orders_universal_d_VatType: typeof VatType;\n type storesV2Orders_universal_d_ShippingInfo = ShippingInfo;\n type storesV2Orders_universal_d_ShippingInfoDetailsOneOf = ShippingInfoDetailsOneOf;\n type storesV2Orders_universal_d_ShipmentDetails = ShipmentDetails;\n type storesV2Orders_universal_d_TrackingInfo = TrackingInfo;\n type storesV2Orders_universal_d_ShippingPriceData = ShippingPriceData;\n type storesV2Orders_universal_d_PickupDetails = PickupDetails;\n type storesV2Orders_universal_d_PickupAddress = PickupAddress;\n type storesV2Orders_universal_d_BuyerDetails = BuyerDetails;\n type storesV2Orders_universal_d_PaymentStatus = PaymentStatus;\n const storesV2Orders_universal_d_PaymentStatus: typeof PaymentStatus;\n type storesV2Orders_universal_d_FulfillmentStatus = FulfillmentStatus;\n const storesV2Orders_universal_d_FulfillmentStatus: typeof FulfillmentStatus;\n type storesV2Orders_universal_d_LineItem = LineItem;\n type storesV2Orders_universal_d_LineItemType = LineItemType;\n const storesV2Orders_universal_d_LineItemType: typeof LineItemType;\n type storesV2Orders_universal_d_OptionSelection = OptionSelection;\n type storesV2Orders_universal_d_CustomTextFieldSelection = CustomTextFieldSelection;\n type storesV2Orders_universal_d_LineItemPriceData = LineItemPriceData;\n type storesV2Orders_universal_d_DigitalFile = DigitalFile;\n type storesV2Orders_universal_d_InvoiceInfo = InvoiceInfo;\n type storesV2Orders_universal_d_InvoiceSource = InvoiceSource;\n const storesV2Orders_universal_d_InvoiceSource: typeof InvoiceSource;\n type storesV2Orders_universal_d_Fulfillment = Fulfillment;\n type storesV2Orders_universal_d_FulfillmentLineItem = FulfillmentLineItem;\n type storesV2Orders_universal_d_FulfillmentTrackingInfo = FulfillmentTrackingInfo;\n type storesV2Orders_universal_d_AppliedCoupon = AppliedCoupon;\n type storesV2Orders_universal_d_CustomField = CustomField;\n type storesV2Orders_universal_d_ChannelInfo = ChannelInfo;\n type storesV2Orders_universal_d_ChannelType = ChannelType;\n const storesV2Orders_universal_d_ChannelType: typeof ChannelType;\n type storesV2Orders_universal_d_EnteredBy = EnteredBy;\n type storesV2Orders_universal_d_EnteredByIdentityType = EnteredByIdentityType;\n const storesV2Orders_universal_d_EnteredByIdentityType: typeof EnteredByIdentityType;\n type storesV2Orders_universal_d_SubscriptionInfo = SubscriptionInfo;\n type storesV2Orders_universal_d_SubscriptionOptionInfo = SubscriptionOptionInfo;\n type storesV2Orders_universal_d_Refund = Refund;\n type storesV2Orders_universal_d_GiftCard = GiftCard;\n type storesV2Orders_universal_d_OrderEvent = OrderEvent;\n type storesV2Orders_universal_d_OrdersExperiments = OrdersExperiments;\n type storesV2Orders_universal_d_MarkAsPaidRequest = MarkAsPaidRequest;\n type storesV2Orders_universal_d_RequestPaymentInfo = RequestPaymentInfo;\n type storesV2Orders_universal_d_MarkAsPaidResponse = MarkAsPaidResponse;\n type storesV2Orders_universal_d_SetShippingFulfillmentRequest = SetShippingFulfillmentRequest;\n type storesV2Orders_universal_d_ShipmentFulfillmentStatus = ShipmentFulfillmentStatus;\n const storesV2Orders_universal_d_ShipmentFulfillmentStatus: typeof ShipmentFulfillmentStatus;\n type storesV2Orders_universal_d_SetShippingFulfillmentResponse = SetShippingFulfillmentResponse;\n type storesV2Orders_universal_d_SendFulfillmentConfirmationRequest = SendFulfillmentConfirmationRequest;\n type storesV2Orders_universal_d_SendFulfillmentConfirmationResponse = SendFulfillmentConfirmationResponse;\n type storesV2Orders_universal_d_MarkAsReadRequest = MarkAsReadRequest;\n type storesV2Orders_universal_d_MarkAsReadResponse = MarkAsReadResponse;\n type storesV2Orders_universal_d_SetArchiveStatusRequest = SetArchiveStatusRequest;\n type storesV2Orders_universal_d_SetArchiveStatusResponse = SetArchiveStatusResponse;\n type storesV2Orders_universal_d_DomainEvent = DomainEvent;\n type storesV2Orders_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type storesV2Orders_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type storesV2Orders_universal_d_RestoreInfo = RestoreInfo;\n type storesV2Orders_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type storesV2Orders_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type storesV2Orders_universal_d_ActionEvent = ActionEvent;\n type storesV2Orders_universal_d_OrderAddressUpdated = OrderAddressUpdated;\n type storesV2Orders_universal_d_CreateOrderRequest = CreateOrderRequest;\n type storesV2Orders_universal_d_AdditionalOrderSettings = AdditionalOrderSettings;\n type storesV2Orders_universal_d_CreateOrderResponse = CreateOrderResponse;\n type storesV2Orders_universal_d_BulkFulfillOrdersRequest = BulkFulfillOrdersRequest;\n type storesV2Orders_universal_d_BulkFulfillOrdersResponse = BulkFulfillOrdersResponse;\n type storesV2Orders_universal_d_BulkMarkOrdersAsPaidRequest = BulkMarkOrdersAsPaidRequest;\n type storesV2Orders_universal_d_BulkMarkOrdersAsPaidResponse = BulkMarkOrdersAsPaidResponse;\n type storesV2Orders_universal_d_BulkArchiveOrdersRequest = BulkArchiveOrdersRequest;\n type storesV2Orders_universal_d_BulkArchiveOrdersResponse = BulkArchiveOrdersResponse;\n type storesV2Orders_universal_d_BulkUnarchiveOrdersRequest = BulkUnarchiveOrdersRequest;\n type storesV2Orders_universal_d_BulkUnarchiveOrdersResponse = BulkUnarchiveOrdersResponse;\n type storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityRequest = AddFulfillerEmailWasSentActivityRequest;\n type storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityResponse = AddFulfillerEmailWasSentActivityResponse;\n type storesV2Orders_universal_d_DeclineOrderRequest = DeclineOrderRequest;\n type storesV2Orders_universal_d_DeclineOrderResponse = DeclineOrderResponse;\n type storesV2Orders_universal_d_UpdateOrderEmailRequest = UpdateOrderEmailRequest;\n type storesV2Orders_universal_d_UpdateOrderEmailResponse = UpdateOrderEmailResponse;\n type storesV2Orders_universal_d_UpdateOrderShippingAddressRequest = UpdateOrderShippingAddressRequest;\n type storesV2Orders_universal_d_UpdateOrderShippingAddressResponse = UpdateOrderShippingAddressResponse;\n type storesV2Orders_universal_d_DiffmatokyPayload = DiffmatokyPayload;\n type storesV2Orders_universal_d_ErrorInformation = ErrorInformation;\n type storesV2Orders_universal_d_OrderCreated = OrderCreated;\n type storesV2Orders_universal_d_OrderPaid = OrderPaid;\n type storesV2Orders_universal_d_OrderCancelRefundEvent = OrderCancelRefundEvent;\n type storesV2Orders_universal_d_OrderData = OrderData;\n type storesV2Orders_universal_d_OrderCanceled = OrderCanceled;\n type storesV2Orders_universal_d_OrderRefunded = OrderRefunded;\n type storesV2Orders_universal_d_FulfillmentCreated = FulfillmentCreated;\n type storesV2Orders_universal_d_FulfillmentUpdated = FulfillmentUpdated;\n type storesV2Orders_universal_d_FulfillmentDeleted = FulfillmentDeleted;\n type storesV2Orders_universal_d_OrderDeclined = OrderDeclined;\n type storesV2Orders_universal_d_GetOrderRequestV2 = GetOrderRequestV2;\n type storesV2Orders_universal_d_GetOrderResponseV2 = GetOrderResponseV2;\n type storesV2Orders_universal_d_QueryOrdersRequestV2 = QueryOrdersRequestV2;\n type storesV2Orders_universal_d_QueryOrdersResponseV2 = QueryOrdersResponseV2;\n type storesV2Orders_universal_d_CreateFulfillmentRequest = CreateFulfillmentRequest;\n type storesV2Orders_universal_d_CreateFulfillmentResponse = CreateFulfillmentResponse;\n type storesV2Orders_universal_d_UpdateFulfillmentRequest = UpdateFulfillmentRequest;\n type storesV2Orders_universal_d_UpdateFulfillmentResponse = UpdateFulfillmentResponse;\n type storesV2Orders_universal_d_DeleteFulfillmentRequest = DeleteFulfillmentRequest;\n type storesV2Orders_universal_d_DeleteFulfillmentResponse = DeleteFulfillmentResponse;\n const storesV2Orders_universal_d_markAsPaid: typeof markAsPaid;\n const storesV2Orders_universal_d_setShippingFulfillment: typeof setShippingFulfillment;\n type storesV2Orders_universal_d_SetShippingFulfillmentOptions = SetShippingFulfillmentOptions;\n const storesV2Orders_universal_d_sendFulfillmentConfirmation: typeof sendFulfillmentConfirmation;\n const storesV2Orders_universal_d_markAsRead: typeof markAsRead;\n const storesV2Orders_universal_d_setArchiveStatus: typeof setArchiveStatus;\n type storesV2Orders_universal_d_SetArchiveStatusOptions = SetArchiveStatusOptions;\n const storesV2Orders_universal_d_createOrder: typeof createOrder;\n type storesV2Orders_universal_d_CreateOrderOptions = CreateOrderOptions;\n const storesV2Orders_universal_d_bulkFulfillOrders: typeof bulkFulfillOrders;\n type storesV2Orders_universal_d_BulkFulfillOrdersOptions = BulkFulfillOrdersOptions;\n const storesV2Orders_universal_d_bulkMarkOrdersAsPaid: typeof bulkMarkOrdersAsPaid;\n const storesV2Orders_universal_d_bulkArchiveOrders: typeof bulkArchiveOrders;\n const storesV2Orders_universal_d_bulkUnarchiveOrders: typeof bulkUnarchiveOrders;\n const storesV2Orders_universal_d_addFulfillerEmailWasSentActivity: typeof addFulfillerEmailWasSentActivity;\n const storesV2Orders_universal_d_declineOrder: typeof declineOrder;\n type storesV2Orders_universal_d_DeclineOrderOptions = DeclineOrderOptions;\n const storesV2Orders_universal_d_updateOrderEmail: typeof updateOrderEmail;\n type storesV2Orders_universal_d_UpdateOrderEmailOptions = UpdateOrderEmailOptions;\n const storesV2Orders_universal_d_updateOrderShippingAddress: typeof updateOrderShippingAddress;\n type storesV2Orders_universal_d_UpdateOrderShippingAddressOptions = UpdateOrderShippingAddressOptions;\n const storesV2Orders_universal_d_getOrder: typeof getOrder;\n const storesV2Orders_universal_d_queryOrders: typeof queryOrders;\n type storesV2Orders_universal_d_QueryOrdersOptions = QueryOrdersOptions;\n const storesV2Orders_universal_d_queryOrdersEventuallyConsistent: typeof queryOrdersEventuallyConsistent;\n type storesV2Orders_universal_d_QueryOrdersEventuallyConsistentOptions = QueryOrdersEventuallyConsistentOptions;\n const storesV2Orders_universal_d_createFulfillment: typeof createFulfillment;\n const storesV2Orders_universal_d_updateFulfillment: typeof updateFulfillment;\n type storesV2Orders_universal_d_UpdateFulfillmentIdentifiers = UpdateFulfillmentIdentifiers;\n type storesV2Orders_universal_d_UpdateFulfillmentOptions = UpdateFulfillmentOptions;\n const storesV2Orders_universal_d_deleteFulfillment: typeof deleteFulfillment;\n type storesV2Orders_universal_d_DeleteFulfillmentIdentifiers = DeleteFulfillmentIdentifiers;\n namespace storesV2Orders_universal_d {\n export {\n storesV2Orders_universal_d_Order as Order,\n BuyerInfo$1 as BuyerInfo,\n storesV2Orders_universal_d_IdentityType as IdentityType,\n storesV2Orders_universal_d_WeightUnit as WeightUnit,\n Totals$1 as Totals,\n storesV2Orders_universal_d_BillingInfo as BillingInfo,\n storesV2Orders_universal_d_Address as Address,\n storesV2Orders_universal_d_AddressAddressLine1OptionsOneOf as AddressAddressLine1OptionsOneOf,\n storesV2Orders_universal_d_FullName as FullName,\n storesV2Orders_universal_d_Street as Street,\n storesV2Orders_universal_d_VatId as VatId,\n storesV2Orders_universal_d_VatType as VatType,\n storesV2Orders_universal_d_ShippingInfo as ShippingInfo,\n storesV2Orders_universal_d_ShippingInfoDetailsOneOf as ShippingInfoDetailsOneOf,\n storesV2Orders_universal_d_ShipmentDetails as ShipmentDetails,\n storesV2Orders_universal_d_TrackingInfo as TrackingInfo,\n storesV2Orders_universal_d_ShippingPriceData as ShippingPriceData,\n storesV2Orders_universal_d_PickupDetails as PickupDetails,\n storesV2Orders_universal_d_PickupAddress as PickupAddress,\n storesV2Orders_universal_d_BuyerDetails as BuyerDetails,\n storesV2Orders_universal_d_PaymentStatus as PaymentStatus,\n storesV2Orders_universal_d_FulfillmentStatus as FulfillmentStatus,\n storesV2Orders_universal_d_LineItem as LineItem,\n storesV2Orders_universal_d_LineItemType as LineItemType,\n storesV2Orders_universal_d_OptionSelection as OptionSelection,\n storesV2Orders_universal_d_CustomTextFieldSelection as CustomTextFieldSelection,\n MediaItem$1 as MediaItem,\n MediaItemType$1 as MediaItemType,\n storesV2Orders_universal_d_LineItemPriceData as LineItemPriceData,\n storesV2Orders_universal_d_DigitalFile as DigitalFile,\n Activity$1 as Activity,\n ActivityType$1 as ActivityType,\n storesV2Orders_universal_d_InvoiceInfo as InvoiceInfo,\n storesV2Orders_universal_d_InvoiceSource as InvoiceSource,\n storesV2Orders_universal_d_Fulfillment as Fulfillment,\n storesV2Orders_universal_d_FulfillmentLineItem as FulfillmentLineItem,\n storesV2Orders_universal_d_FulfillmentTrackingInfo as FulfillmentTrackingInfo,\n Discount$2 as Discount,\n storesV2Orders_universal_d_AppliedCoupon as AppliedCoupon,\n storesV2Orders_universal_d_CustomField as CustomField,\n storesV2Orders_universal_d_ChannelInfo as ChannelInfo,\n storesV2Orders_universal_d_ChannelType as ChannelType,\n storesV2Orders_universal_d_EnteredBy as EnteredBy,\n storesV2Orders_universal_d_EnteredByIdentityType as EnteredByIdentityType,\n storesV2Orders_universal_d_SubscriptionInfo as SubscriptionInfo,\n SubscriptionSettings$1 as SubscriptionSettings,\n SubscriptionFrequency$1 as SubscriptionFrequency,\n storesV2Orders_universal_d_SubscriptionOptionInfo as SubscriptionOptionInfo,\n storesV2Orders_universal_d_Refund as Refund,\n storesV2Orders_universal_d_GiftCard as GiftCard,\n storesV2Orders_universal_d_OrderEvent as OrderEvent,\n storesV2Orders_universal_d_OrdersExperiments as OrdersExperiments,\n storesV2Orders_universal_d_MarkAsPaidRequest as MarkAsPaidRequest,\n storesV2Orders_universal_d_RequestPaymentInfo as RequestPaymentInfo,\n storesV2Orders_universal_d_MarkAsPaidResponse as MarkAsPaidResponse,\n storesV2Orders_universal_d_SetShippingFulfillmentRequest as SetShippingFulfillmentRequest,\n storesV2Orders_universal_d_ShipmentFulfillmentStatus as ShipmentFulfillmentStatus,\n storesV2Orders_universal_d_SetShippingFulfillmentResponse as SetShippingFulfillmentResponse,\n storesV2Orders_universal_d_SendFulfillmentConfirmationRequest as SendFulfillmentConfirmationRequest,\n storesV2Orders_universal_d_SendFulfillmentConfirmationResponse as SendFulfillmentConfirmationResponse,\n storesV2Orders_universal_d_MarkAsReadRequest as MarkAsReadRequest,\n storesV2Orders_universal_d_MarkAsReadResponse as MarkAsReadResponse,\n storesV2Orders_universal_d_SetArchiveStatusRequest as SetArchiveStatusRequest,\n storesV2Orders_universal_d_SetArchiveStatusResponse as SetArchiveStatusResponse,\n storesV2Orders_universal_d_DomainEvent as DomainEvent,\n storesV2Orders_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n storesV2Orders_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n storesV2Orders_universal_d_RestoreInfo as RestoreInfo,\n storesV2Orders_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n storesV2Orders_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n storesV2Orders_universal_d_ActionEvent as ActionEvent,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n storesV2Orders_universal_d_OrderAddressUpdated as OrderAddressUpdated,\n storesV2Orders_universal_d_CreateOrderRequest as CreateOrderRequest,\n storesV2Orders_universal_d_AdditionalOrderSettings as AdditionalOrderSettings,\n storesV2Orders_universal_d_CreateOrderResponse as CreateOrderResponse,\n storesV2Orders_universal_d_BulkFulfillOrdersRequest as BulkFulfillOrdersRequest,\n storesV2Orders_universal_d_BulkFulfillOrdersResponse as BulkFulfillOrdersResponse,\n storesV2Orders_universal_d_BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequest,\n storesV2Orders_universal_d_BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponse,\n storesV2Orders_universal_d_BulkArchiveOrdersRequest as BulkArchiveOrdersRequest,\n storesV2Orders_universal_d_BulkArchiveOrdersResponse as BulkArchiveOrdersResponse,\n storesV2Orders_universal_d_BulkUnarchiveOrdersRequest as BulkUnarchiveOrdersRequest,\n storesV2Orders_universal_d_BulkUnarchiveOrdersResponse as BulkUnarchiveOrdersResponse,\n storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityRequest as AddFulfillerEmailWasSentActivityRequest,\n storesV2Orders_universal_d_AddFulfillerEmailWasSentActivityResponse as AddFulfillerEmailWasSentActivityResponse,\n storesV2Orders_universal_d_DeclineOrderRequest as DeclineOrderRequest,\n storesV2Orders_universal_d_DeclineOrderResponse as DeclineOrderResponse,\n storesV2Orders_universal_d_UpdateOrderEmailRequest as UpdateOrderEmailRequest,\n storesV2Orders_universal_d_UpdateOrderEmailResponse as UpdateOrderEmailResponse,\n storesV2Orders_universal_d_UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequest,\n storesV2Orders_universal_d_UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponse,\n storesV2Orders_universal_d_DiffmatokyPayload as DiffmatokyPayload,\n storesV2Orders_universal_d_ErrorInformation as ErrorInformation,\n storesV2Orders_universal_d_OrderCreated as OrderCreated,\n storesV2Orders_universal_d_OrderPaid as OrderPaid,\n storesV2Orders_universal_d_OrderCancelRefundEvent as OrderCancelRefundEvent,\n storesV2Orders_universal_d_OrderData as OrderData,\n storesV2Orders_universal_d_OrderCanceled as OrderCanceled,\n storesV2Orders_universal_d_OrderRefunded as OrderRefunded,\n storesV2Orders_universal_d_FulfillmentCreated as FulfillmentCreated,\n storesV2Orders_universal_d_FulfillmentUpdated as FulfillmentUpdated,\n storesV2Orders_universal_d_FulfillmentDeleted as FulfillmentDeleted,\n storesV2Orders_universal_d_OrderDeclined as OrderDeclined,\n storesV2Orders_universal_d_GetOrderRequestV2 as GetOrderRequestV2,\n storesV2Orders_universal_d_GetOrderResponseV2 as GetOrderResponseV2,\n storesV2Orders_universal_d_QueryOrdersRequestV2 as QueryOrdersRequestV2,\n Query$2 as Query,\n Paging$3 as Paging,\n storesV2Orders_universal_d_QueryOrdersResponseV2 as QueryOrdersResponseV2,\n PagingMetadata$2 as PagingMetadata,\n storesV2Orders_universal_d_CreateFulfillmentRequest as CreateFulfillmentRequest,\n storesV2Orders_universal_d_CreateFulfillmentResponse as CreateFulfillmentResponse,\n storesV2Orders_universal_d_UpdateFulfillmentRequest as UpdateFulfillmentRequest,\n storesV2Orders_universal_d_UpdateFulfillmentResponse as UpdateFulfillmentResponse,\n storesV2Orders_universal_d_DeleteFulfillmentRequest as DeleteFulfillmentRequest,\n storesV2Orders_universal_d_DeleteFulfillmentResponse as DeleteFulfillmentResponse,\n storesV2Orders_universal_d_markAsPaid as markAsPaid,\n storesV2Orders_universal_d_setShippingFulfillment as setShippingFulfillment,\n storesV2Orders_universal_d_SetShippingFulfillmentOptions as SetShippingFulfillmentOptions,\n storesV2Orders_universal_d_sendFulfillmentConfirmation as sendFulfillmentConfirmation,\n storesV2Orders_universal_d_markAsRead as markAsRead,\n storesV2Orders_universal_d_setArchiveStatus as setArchiveStatus,\n storesV2Orders_universal_d_SetArchiveStatusOptions as SetArchiveStatusOptions,\n storesV2Orders_universal_d_createOrder as createOrder,\n storesV2Orders_universal_d_CreateOrderOptions as CreateOrderOptions,\n storesV2Orders_universal_d_bulkFulfillOrders as bulkFulfillOrders,\n storesV2Orders_universal_d_BulkFulfillOrdersOptions as BulkFulfillOrdersOptions,\n storesV2Orders_universal_d_bulkMarkOrdersAsPaid as bulkMarkOrdersAsPaid,\n storesV2Orders_universal_d_bulkArchiveOrders as bulkArchiveOrders,\n storesV2Orders_universal_d_bulkUnarchiveOrders as bulkUnarchiveOrders,\n storesV2Orders_universal_d_addFulfillerEmailWasSentActivity as addFulfillerEmailWasSentActivity,\n storesV2Orders_universal_d_declineOrder as declineOrder,\n storesV2Orders_universal_d_DeclineOrderOptions as DeclineOrderOptions,\n storesV2Orders_universal_d_updateOrderEmail as updateOrderEmail,\n storesV2Orders_universal_d_UpdateOrderEmailOptions as UpdateOrderEmailOptions,\n storesV2Orders_universal_d_updateOrderShippingAddress as updateOrderShippingAddress,\n storesV2Orders_universal_d_UpdateOrderShippingAddressOptions as UpdateOrderShippingAddressOptions,\n storesV2Orders_universal_d_getOrder as getOrder,\n storesV2Orders_universal_d_queryOrders as queryOrders,\n storesV2Orders_universal_d_QueryOrdersOptions as QueryOrdersOptions,\n storesV2Orders_universal_d_queryOrdersEventuallyConsistent as queryOrdersEventuallyConsistent,\n storesV2Orders_universal_d_QueryOrdersEventuallyConsistentOptions as QueryOrdersEventuallyConsistentOptions,\n storesV2Orders_universal_d_createFulfillment as createFulfillment,\n storesV2Orders_universal_d_updateFulfillment as updateFulfillment,\n storesV2Orders_universal_d_UpdateFulfillmentIdentifiers as UpdateFulfillmentIdentifiers,\n storesV2Orders_universal_d_UpdateFulfillmentOptions as UpdateFulfillmentOptions,\n storesV2Orders_universal_d_deleteFulfillment as deleteFulfillment,\n storesV2Orders_universal_d_DeleteFulfillmentIdentifiers as DeleteFulfillmentIdentifiers,\n };\n }\n \n interface WishlistData {\n /** GUID unique to this list for this site */\n _id?: string | null;\n /** Member id the list belongs to */\n ownerId?: string;\n /** List of items in the list. Not necessarily the full list (can depends on request data) */\n items?: WishlistItem[];\n /** Total count of items in the list */\n totalCount?: number;\n }\n interface WishlistItem {\n /** Unique identifier for an item of this type and origin */\n _id?: string;\n /**\n * The data the item was save to the list\n * @readonly\n */\n dateAdded?: Date | null;\n /** The type of the item. For example \"product\" */\n type?: string;\n /** The origin of the item. Should be the scope the item type is related to. For example \"wixstores\" */\n origin?: string;\n }\n interface ItemsAddedToWishlist {\n /** GUID unique to this list for its site */\n _id?: string | null;\n /** Member id the list belongs to */\n ownerId?: string;\n /** List of items that were added to wishlist */\n items?: WishlistItem[];\n }\n interface ItemsRemovedFromWishlist {\n /** GUID unique to this list for its site */\n _id?: string | null;\n /** Member id the list belongs to */\n ownerId?: string;\n /** List of items that were removed from wishlist */\n items?: WishlistItem[];\n }\n interface GetWishlistRequest {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n interface WishlistItemKind {\n /** The type of the item. For example \"product\" */\n type?: string;\n /** The origin of the item. Should be the scope the item type is related to. For example \"wixstores\" */\n origin?: string;\n }\n interface GetWishlistResponse {\n /** Object containing requested list data */\n wishlist?: WishlistData;\n }\n interface AddToWishlistRequest {\n /** List of items to add to list */\n items?: WishlistItem[];\n }\n interface AddToWishlistResponse {\n }\n interface RemoveFromWishlistRequest {\n /** List of items to remove from list */\n items?: WishlistItem[];\n }\n interface RemoveFromWishlistResponse {\n }\n interface GetWishlistByIdRequest {\n /** Unique identifier representing requested list */\n _id: string;\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n interface GetWishlistByIdResponse {\n /** Object containing requested list data */\n wishlist?: WishlistData;\n }\n interface GetWishlistsRequest {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n }\n interface GetWishlistsResponse {\n /** List result of requested wishlists */\n wishlists?: WishlistData[];\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 * Get default wishlist by context's member and site\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getWishlist(options?: GetWishlistOptions): Promise;\n interface GetWishlistOptions {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n /**\n * Add items to default wishlist by context's member and site\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items._id\n * @requiredField options.items.origin\n * @requiredField options.items.type\n * @adminMethod\n */\n function addToWishlist(options?: AddToWishlistOptions): Promise;\n interface AddToWishlistOptions {\n /** List of items to add to list */\n items?: WishlistItem[];\n }\n /**\n * Remove items to default wishlist by context's member and site\n * @internal\n * @documentationMaturity preview\n * @requiredField options.items._id\n * @requiredField options.items.origin\n * @requiredField options.items.type\n * @adminMethod\n */\n function removeFromWishlist(options?: RemoveFromWishlistOptions): Promise;\n interface RemoveFromWishlistOptions {\n /** List of items to remove from list */\n items?: WishlistItem[];\n }\n /**\n * Get wishlist by id\n * @param _id - Unique identifier representing requested list\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WISHLIST.MANAGE-SITE-WISHLISTS\n * @adminMethod\n * @returns Object containing requested list data\n */\n function getWishlistById(_id: string, options?: GetWishlistByIdOptions): Promise;\n interface GetWishlistByIdOptions {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n /** Filter requested list by specific kinds of items */\n kind?: WishlistItemKind[];\n }\n /**\n * Get wishlists of site\n * @internal\n * @documentationMaturity preview\n * @permissionId WISHLIST.MANAGE-SITE-WISHLISTS\n * @adminMethod\n */\n function getWishlists(options?: GetWishlistsOptions): Promise;\n interface GetWishlistsOptions {\n /** List length limit. Default is 100 */\n limit?: number | null;\n /** List starting index offset. Default is 0 */\n offset?: number | null;\n }\n \n type platformV1Wishlist_universal_d_WishlistData = WishlistData;\n type platformV1Wishlist_universal_d_WishlistItem = WishlistItem;\n type platformV1Wishlist_universal_d_ItemsAddedToWishlist = ItemsAddedToWishlist;\n type platformV1Wishlist_universal_d_ItemsRemovedFromWishlist = ItemsRemovedFromWishlist;\n type platformV1Wishlist_universal_d_GetWishlistRequest = GetWishlistRequest;\n type platformV1Wishlist_universal_d_WishlistItemKind = WishlistItemKind;\n type platformV1Wishlist_universal_d_GetWishlistResponse = GetWishlistResponse;\n type platformV1Wishlist_universal_d_AddToWishlistRequest = AddToWishlistRequest;\n type platformV1Wishlist_universal_d_AddToWishlistResponse = AddToWishlistResponse;\n type platformV1Wishlist_universal_d_RemoveFromWishlistRequest = RemoveFromWishlistRequest;\n type platformV1Wishlist_universal_d_RemoveFromWishlistResponse = RemoveFromWishlistResponse;\n type platformV1Wishlist_universal_d_GetWishlistByIdRequest = GetWishlistByIdRequest;\n type platformV1Wishlist_universal_d_GetWishlistByIdResponse = GetWishlistByIdResponse;\n type platformV1Wishlist_universal_d_GetWishlistsRequest = GetWishlistsRequest;\n type platformV1Wishlist_universal_d_GetWishlistsResponse = GetWishlistsResponse;\n const platformV1Wishlist_universal_d_getWishlist: typeof getWishlist;\n type platformV1Wishlist_universal_d_GetWishlistOptions = GetWishlistOptions;\n const platformV1Wishlist_universal_d_addToWishlist: typeof addToWishlist;\n type platformV1Wishlist_universal_d_AddToWishlistOptions = AddToWishlistOptions;\n const platformV1Wishlist_universal_d_removeFromWishlist: typeof removeFromWishlist;\n type platformV1Wishlist_universal_d_RemoveFromWishlistOptions = RemoveFromWishlistOptions;\n const platformV1Wishlist_universal_d_getWishlistById: typeof getWishlistById;\n type platformV1Wishlist_universal_d_GetWishlistByIdOptions = GetWishlistByIdOptions;\n const platformV1Wishlist_universal_d_getWishlists: typeof getWishlists;\n type platformV1Wishlist_universal_d_GetWishlistsOptions = GetWishlistsOptions;\n namespace platformV1Wishlist_universal_d {\n export {\n platformV1Wishlist_universal_d_WishlistData as WishlistData,\n platformV1Wishlist_universal_d_WishlistItem as WishlistItem,\n platformV1Wishlist_universal_d_ItemsAddedToWishlist as ItemsAddedToWishlist,\n platformV1Wishlist_universal_d_ItemsRemovedFromWishlist as ItemsRemovedFromWishlist,\n platformV1Wishlist_universal_d_GetWishlistRequest as GetWishlistRequest,\n platformV1Wishlist_universal_d_WishlistItemKind as WishlistItemKind,\n platformV1Wishlist_universal_d_GetWishlistResponse as GetWishlistResponse,\n platformV1Wishlist_universal_d_AddToWishlistRequest as AddToWishlistRequest,\n platformV1Wishlist_universal_d_AddToWishlistResponse as AddToWishlistResponse,\n platformV1Wishlist_universal_d_RemoveFromWishlistRequest as RemoveFromWishlistRequest,\n platformV1Wishlist_universal_d_RemoveFromWishlistResponse as RemoveFromWishlistResponse,\n platformV1Wishlist_universal_d_GetWishlistByIdRequest as GetWishlistByIdRequest,\n platformV1Wishlist_universal_d_GetWishlistByIdResponse as GetWishlistByIdResponse,\n platformV1Wishlist_universal_d_GetWishlistsRequest as GetWishlistsRequest,\n platformV1Wishlist_universal_d_GetWishlistsResponse as GetWishlistsResponse,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n platformV1Wishlist_universal_d_getWishlist as getWishlist,\n platformV1Wishlist_universal_d_GetWishlistOptions as GetWishlistOptions,\n platformV1Wishlist_universal_d_addToWishlist as addToWishlist,\n platformV1Wishlist_universal_d_AddToWishlistOptions as AddToWishlistOptions,\n platformV1Wishlist_universal_d_removeFromWishlist as removeFromWishlist,\n platformV1Wishlist_universal_d_RemoveFromWishlistOptions as RemoveFromWishlistOptions,\n platformV1Wishlist_universal_d_getWishlistById as getWishlistById,\n platformV1Wishlist_universal_d_GetWishlistByIdOptions as GetWishlistByIdOptions,\n platformV1Wishlist_universal_d_getWishlists as getWishlists,\n platformV1Wishlist_universal_d_GetWishlistsOptions as GetWishlistsOptions,\n };\n }\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$1;\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 * tax group id\n * @internal\n */\n taxGroupId?: string | null;\n /**\n * internal field used by import/export to know how to link products in csv file to product ids\n * @internal\n * @readonly\n */\n exportProductId?: string;\n /**\n * Digital file which will be downloaded by buyer after successful purchase.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia;\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$1 {\n /**\n * Discount type:\n * + `\"AMOUNT\"`\n * + `\"PERCENT\"`\n */\n type?: DiscountType$1;\n /** Discount value */\n value?: number;\n }\n enum DiscountType$1 {\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 * The location of the inventory in question. None indicates the online-store default location.\n * @internal\n */\n locationId?: 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 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 * Custom SEO data for the collection.\n * @internal\n */\n seoSchema?: SeoSchema;\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 /**\n * product revision\n * @internal\n */\n revision?: 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$1;\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$1 {\n paging?: Paging$2;\n /** Filter string */\n filter?: string | null;\n /** Sort string */\n sort?: string | null;\n }\n interface Paging$2 {\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$1;\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 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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$1;\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 * Include SeoSchema in response. When False, SeoSchema will be null\n * @internal\n */\n includeSeoSchema?: boolean;\n }\n interface QueryCollectionsResponse {\n /** List of collections. */\n collections?: Collection[];\n /** Details on the paged set of results returned. */\n metadata?: PagingMetadata$1;\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 * Whether the variant is managed or represents a product.\n * @internal\n */\n managedProduct?: 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 * Variant ID.\n * @internal\n */\n variantId?: string;\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$2;\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$1;\n totalResults?: number;\n }\n interface QueryStoreVariantsRequest {\n /** Query options. */\n query?: PlatformQuery;\n /**\n * Requested custom field names.\n * @internal\n */\n customFields?: string[];\n /**\n * Include variants for different locations\n * @internal\n */\n includeLocationVariants?: boolean;\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 /** @internal */\n customFields?: Record;\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 /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\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 * Requested custom field names.\n * @internal\n */\n customFields?: string[];\n /**\n * Include variants for different locations\n * @internal\n */\n includeLocationVariants?: boolean;\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$1;\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$1;\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$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 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 * @adminMethod\n */\n function createProduct(product: Product): Promise;\n /**\n * Creates a new product.\n * @param product - Product information.\n * @internal\n * @documentationMaturity preview\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 * @adminMethod\n */\n function createProductPlatformized(product: Product): Promise;\n /**\n * Creates a new digital product.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.product.costAndProfitData.itemCost\n * @requiredField options.product.name\n * @requiredField options.product.priceData\n * @requiredField options.product.priceData.price\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function createDigitalProduct(options?: CreateDigitalProductOptions): 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 * @adminMethod\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$1;\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 * tax group id\n * @internal\n */\n taxGroupId?: string | null;\n /**\n * internal field used by import/export to know how to link products in csv file to product ids\n * @internal\n * @readonly\n */\n exportProductId?: string;\n /**\n * Digital file which will be downloaded by buyer after successful purchase.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia;\n }\n /**\n * Updates specified fields in a product.\n * @param _id - Product ID (generated automatically by the catalog).\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField product\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function updateProductPlatformized(_id: string, product: UpdateProductPlatformizedProduct): Promise;\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$1;\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 * tax group id\n * @internal\n */\n taxGroupId?: string | null;\n /**\n * internal field used by import/export to know how to link products in csv file to product ids\n * @internal\n * @readonly\n */\n exportProductId?: string;\n /**\n * Digital file which will be downloaded by buyer after successful purchase.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia;\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 * @adminMethod\n */\n function deleteProduct(_id: string): Promise;\n /**\n * Deletes a product.\n * @param _id - ID of the product to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function deleteProductPlatformized(_id: string): Promise;\n /**\n * Deletes a bulk of products.\n * @param ids - IDs of the products to be deleted.\n * @internal\n * @requiredField ids\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function bulkDeleteProducts(ids: 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 * @documentationMaturity preview\n * @requiredField _id\n * @requiredField variants\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @adminMethod\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 * @requiredField _id\n * @requiredField productIds\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @adminMethod\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 * @adminMethod\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 * @requiredField _id\n * @requiredField media\n * @requiredField media.choice\n * @requiredField media.option\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @requiredField _id\n * @requiredField media\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function deleteProductOptions(_id: string): Promise;\n /** @param _id - Product ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function setCustomFields(_id: string, options?: SetCustomFieldsOptions): 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 /** @param _id - Product ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function removeCustomFields(_id: string, options?: RemoveCustomFieldsOptions): Promise;\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function removeBrand(_id: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function bulkSetCustomFields(options?: BulkSetCustomFieldsOptions): 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 /** @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function bulkRemoveCustomFields(options?: BulkRemoveCustomFieldsOptions): Promise;\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 * @documentationMaturity preview\n * @requiredField collection\n * @requiredField collection.name\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @requiredField _id\n * @requiredField collection\n * @param collection - Collection info to update.\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * Custom SEO data for the collection.\n * @internal\n */\n seoSchema?: SeoSchema;\n }\n /**\n * Deletes a collection.\n * @public\n * @requiredField _id\n * @param _id - ID of the collection to delete.\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function deleteCollection(_id: string): Promise;\n /**\n * Deletes a product's ribbon.\n * @param _id - Product ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\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 * @adminMethod\n */\n function bulkUpdateProductsProperty(ids: string[], set: SetValue): Promise;\n /**\n * Updates a bulk of products, selected by filter.\n * The number of products that can be updated by filter is limited to 1000.\n * Internal only. Will be replaced in some point.\n * @param filter - Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function bulkUpdateProductsByFilterSync(filter: Record | null, options?: BulkUpdateProductsByFilterSyncOptions): 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 * @adminMethod\n */\n function bulkAdjustProductProperty(adjust: AdjustValue, ids: string[]): Promise;\n /**\n * Adjust property for multiple products, selected by filter.\n * The number of products that can be updated by filter is limited to 1000.\n * Internal only. Will be replaced at some point.\n * @param filter - Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @requiredField filter\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function bulkAdjustProductPropertiesByFilterSync(filter: Record | null, options?: BulkAdjustProductPropertiesByFilterSyncOptions): Promise;\n interface BulkAdjustProductPropertiesByFilterSyncOptions {\n /** Numerical property to adjust. */\n adjust?: AdjustValue;\n }\n /** @param metasiteId - Description of value\n * @internal\n * @documentationMaturity preview\n * @requiredField metasiteId\n * @permissionId WIX_STORES.RECLONE_STORE\n * @adminMethod\n */\n function reCloneStore(metasiteId: string | null, options?: ReCloneStoreOptions): Promise;\n interface ReCloneStoreOptions {\n originalMetasiteId?: string | null;\n }\n /**\n * Creates a new product.\n * @param product - Product information.\n * @internal\n * @documentationMaturity preview\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 * @adminMethod\n */\n function writeProxyCreateProductPlatformized(product: Product): Promise;\n /**\n * Updates specified fields in a product.\n * @param _id - Product ID (generated automatically by the catalog).\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField product\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function writeProxyUpdateProductPlatformized(_id: string, product: WriteProxyUpdateProductPlatformizedProduct): Promise;\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$1;\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 * tax group id\n * @internal\n */\n taxGroupId?: string | null;\n /**\n * internal field used by import/export to know how to link products in csv file to product ids\n * @internal\n * @readonly\n */\n exportProductId?: string;\n /**\n * Digital file which will be downloaded by buyer after successful purchase.\n * @internal\n * @readonly\n */\n digitalFile?: SecuredMedia;\n }\n /**\n * Deletes a product.\n * @param _id - ID of the product to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_PRODUCTS\n * @adminMethod\n */\n function writeProxyDeleteProductPlatformized(_id: string): Promise;\n /**\n * Returns a list of up to 100 products, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_PRODUCTS\n */\n function queryProductsNonPlatformized(options?: QueryProductsNonPlatformizedOptions): Promise;\n interface QueryProductsNonPlatformizedOptions {\n query?: Query$1;\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 * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_PRODUCTS\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\n */\n hasAll: (propertyName: 'collectionIds', value: any[]) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'name' | 'slug' | 'productType' | 'description' | 'sku' | 'price' | 'priceData.price' | 'numericId' | 'collectionIds' | 'lastUpdated' | '_createdDate', value: any) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\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 * @documentationMaturity preview\n */\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 * @documentationMaturity preview\n */\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 * @documentationMaturity preview\n */\n limit: (limit: number) => ProductsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => ProductsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Returns a list of up to 600 products, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_PRODUCTS_QUERY_WITH_BIG_PAGE_LIMIT\n * @adminMethod\n */\n function queryProductsWithBigPageLimit(options?: QueryProductsWithBigPageLimitOptions): Promise;\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\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 /**\n * Retrieves a product with the provided ID.\n * @param _id - Requested product ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\n * @returns Requested product data.\n */\n function getProductPlatformized(_id: string, options?: GetProductPlatformizedOptions): Promise;\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 /**\n * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_PRODUCTS\n */\n function queryCollections(options?: QueryCollectionsOptions): Promise;\n interface QueryCollectionsOptions {\n /** Query options. */\n query?: Query$1;\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 * Include SeoSchema in response. When False, SeoSchema will be null\n * @internal\n */\n includeSeoSchema?: boolean;\n }\n /**\n * Retrieves a collection with the provided ID.\n * @param _id - Requested collection ID.\n * @internal\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\n */\n function getCollection(_id: string, options?: GetCollectionOptions): Promise;\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 */\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 */\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\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$2;\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 * @documentationMaturity preview\n * @requiredField query\n * @permissionId WIX_STORES.READ_PRODUCTS\n */\n function queryStoreVariants(query: PlatformQuery, options?: QueryStoreVariantsOptions): Promise;\n interface QueryStoreVariantsOptions {\n /**\n * Requested custom field names.\n * @internal\n */\n customFields?: string[];\n /**\n * Include variants for different locations\n * @internal\n */\n includeLocationVariants?: boolean;\n }\n /**\n * Retrieves up to 1000 store variants, given the provided paging, filtering, and sorting.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_PRODUCTS_QUERY_WITH_BIG_PAGE_LIMIT\n * @adminMethod\n */\n function queryStoreVariantsWithBigLimit(options?: QueryStoreVariantsWithBigLimitOptions): Promise;\n interface QueryStoreVariantsWithBigLimitOptions {\n /** Query options. */\n query?: UnlimitedPlatformQuery;\n /**\n * Requested custom field names.\n * @internal\n */\n customFields?: string[];\n /**\n * Include variants for different locations\n * @internal\n */\n includeLocationVariants?: boolean;\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.READ_PRODUCTS\n */\n function getStoreVariant(_id: string): Promise;\n /**\n * Before open to users we should support group by field which will impact all aggregations\n * Group by field is optional, in case you want to count all, max on all etc\n * Issue: for count we allow 2-dimensional aggregation which will not be supported when group by single field\n * To support group by we need to add support of it in object-search library\n * This is exposed only to internal since it has limitations and there isn't an aggregate spec yet\n * @internal\n * @documentationMaturity preview\n * @requiredField options.aggregation\n * @permissionId WIX_STORES.READ_PRODUCTS\n */\n function aggregateProducts(options?: AggregateProductsOptions): 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 \n type storesCatalogV1Product_universal_d_Product = Product;\n type storesCatalogV1Product_universal_d_ProductType = ProductType;\n const storesCatalogV1Product_universal_d_ProductType: typeof ProductType;\n type storesCatalogV1Product_universal_d_NumericPropertyRange = NumericPropertyRange;\n type storesCatalogV1Product_universal_d_Stock = Stock;\n type storesCatalogV1Product_universal_d_InventoryStatus = InventoryStatus;\n const storesCatalogV1Product_universal_d_InventoryStatus: typeof InventoryStatus;\n type storesCatalogV1Product_universal_d_PriceData = PriceData;\n type storesCatalogV1Product_universal_d_FormattedPrice = FormattedPrice;\n type storesCatalogV1Product_universal_d_CostAndProfitData = CostAndProfitData;\n type storesCatalogV1Product_universal_d_PricePerUnitData = PricePerUnitData;\n type storesCatalogV1Product_universal_d_MeasurementUnit = MeasurementUnit;\n const storesCatalogV1Product_universal_d_MeasurementUnit: typeof MeasurementUnit;\n type storesCatalogV1Product_universal_d_AdditionalInfoSection = AdditionalInfoSection;\n type storesCatalogV1Product_universal_d_Ribbon = Ribbon;\n type storesCatalogV1Product_universal_d_Media = Media;\n type storesCatalogV1Product_universal_d_MediaItem = MediaItem;\n type storesCatalogV1Product_universal_d_MediaItemItemOneOf = MediaItemItemOneOf;\n type storesCatalogV1Product_universal_d_MediaItemUrlAndSize = MediaItemUrlAndSize;\n type storesCatalogV1Product_universal_d_MediaItemType = MediaItemType;\n const storesCatalogV1Product_universal_d_MediaItemType: typeof MediaItemType;\n type storesCatalogV1Product_universal_d_MediaItemVideo = MediaItemVideo;\n type storesCatalogV1Product_universal_d_CustomTextField = CustomTextField;\n type storesCatalogV1Product_universal_d_ProductOption = ProductOption;\n type storesCatalogV1Product_universal_d_OptionType = OptionType;\n const storesCatalogV1Product_universal_d_OptionType: typeof OptionType;\n type storesCatalogV1Product_universal_d_Choice = Choice;\n type storesCatalogV1Product_universal_d_PageUrl = PageUrl;\n type storesCatalogV1Product_universal_d_Variant = Variant;\n type storesCatalogV1Product_universal_d_VariantDataWithNoStock = VariantDataWithNoStock;\n type storesCatalogV1Product_universal_d_VariantStock = VariantStock;\n type storesCatalogV1Product_universal_d_SeoSchema = SeoSchema;\n type storesCatalogV1Product_universal_d_Keyword = Keyword;\n type storesCatalogV1Product_universal_d_Tag = Tag;\n type storesCatalogV1Product_universal_d_Settings = Settings;\n type storesCatalogV1Product_universal_d_SecuredMedia = SecuredMedia;\n type storesCatalogV1Product_universal_d_FileType = FileType;\n const storesCatalogV1Product_universal_d_FileType: typeof FileType;\n type storesCatalogV1Product_universal_d_CreateProductRequest = CreateProductRequest;\n type storesCatalogV1Product_universal_d_CreateProductResponse = CreateProductResponse;\n type storesCatalogV1Product_universal_d_CreateProductPlatformizedRequest = CreateProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_CreateProductPlatformizedResponse = CreateProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_CreateDigitalProductRequest = CreateDigitalProductRequest;\n type storesCatalogV1Product_universal_d_CreateDigitalProductResponse = CreateDigitalProductResponse;\n type storesCatalogV1Product_universal_d_UpdateProductRequest = UpdateProductRequest;\n type storesCatalogV1Product_universal_d_UpdateProductResponse = UpdateProductResponse;\n type storesCatalogV1Product_universal_d_UpdateProductPlatformizedRequest = UpdateProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_UpdateProductPlatformizedResponse = UpdateProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_DeleteProductRequest = DeleteProductRequest;\n type storesCatalogV1Product_universal_d_DeleteProductResponse = DeleteProductResponse;\n type storesCatalogV1Product_universal_d_DeleteProductPlatformizedRequest = DeleteProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_DeleteProductPlatformizedResponse = DeleteProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_BulkDeleteProductsRequest = BulkDeleteProductsRequest;\n type storesCatalogV1Product_universal_d_BulkDeleteProductsResponse = BulkDeleteProductsResponse;\n type storesCatalogV1Product_universal_d_UpdateVariantsRequest = UpdateVariantsRequest;\n type storesCatalogV1Product_universal_d_VariantOverride = VariantOverride;\n type storesCatalogV1Product_universal_d_UpdateVariantsResponse = UpdateVariantsResponse;\n type storesCatalogV1Product_universal_d_ResetAllVariantDataRequest = ResetAllVariantDataRequest;\n type storesCatalogV1Product_universal_d_ResetAllVariantDataResponse = ResetAllVariantDataResponse;\n type storesCatalogV1Product_universal_d_AddProductsToCollectionRequest = AddProductsToCollectionRequest;\n type storesCatalogV1Product_universal_d_AddProductsToCollectionResponse = AddProductsToCollectionResponse;\n type storesCatalogV1Product_universal_d_RemoveProductsFromCollectionRequest = RemoveProductsFromCollectionRequest;\n type storesCatalogV1Product_universal_d_RemoveProductsFromCollectionResponse = RemoveProductsFromCollectionResponse;\n type storesCatalogV1Product_universal_d_AddProductMediaRequest = AddProductMediaRequest;\n type storesCatalogV1Product_universal_d_MediaDataForWrite = MediaDataForWrite;\n type storesCatalogV1Product_universal_d_MediaDataForWriteMediaSourceOneOf = MediaDataForWriteMediaSourceOneOf;\n type storesCatalogV1Product_universal_d_OptionAndChoice = OptionAndChoice;\n type storesCatalogV1Product_universal_d_AddProductMediaResponse = AddProductMediaResponse;\n type storesCatalogV1Product_universal_d_RemoveProductMediaRequest = RemoveProductMediaRequest;\n type storesCatalogV1Product_universal_d_RemoveProductMediaResponse = RemoveProductMediaResponse;\n type storesCatalogV1Product_universal_d_AddProductMediaToChoicesRequest = AddProductMediaToChoicesRequest;\n type storesCatalogV1Product_universal_d_MediaAssignmentToChoice = MediaAssignmentToChoice;\n type storesCatalogV1Product_universal_d_AddProductMediaToChoicesResponse = AddProductMediaToChoicesResponse;\n type storesCatalogV1Product_universal_d_RemoveProductMediaFromChoicesRequest = RemoveProductMediaFromChoicesRequest;\n type storesCatalogV1Product_universal_d_RemoveProductMediaFromChoicesResponse = RemoveProductMediaFromChoicesResponse;\n type storesCatalogV1Product_universal_d_DeleteProductOptionsRequest = DeleteProductOptionsRequest;\n type storesCatalogV1Product_universal_d_DeleteProductOptionsResponse = DeleteProductOptionsResponse;\n type storesCatalogV1Product_universal_d_SetCustomFieldsRequest = SetCustomFieldsRequest;\n type storesCatalogV1Product_universal_d_SetCustomFieldsResponse = SetCustomFieldsResponse;\n type storesCatalogV1Product_universal_d_RemoveCustomFieldsRequest = RemoveCustomFieldsRequest;\n type storesCatalogV1Product_universal_d_RemoveCustomFieldsResponse = RemoveCustomFieldsResponse;\n type storesCatalogV1Product_universal_d_RemoveProductBrandRequest = RemoveProductBrandRequest;\n type storesCatalogV1Product_universal_d_RemoveProductBrandResponse = RemoveProductBrandResponse;\n type storesCatalogV1Product_universal_d_BulkSetCustomFieldsRequest = BulkSetCustomFieldsRequest;\n type storesCatalogV1Product_universal_d_BulkSetCustomFieldsResponse = BulkSetCustomFieldsResponse;\n type storesCatalogV1Product_universal_d_BulkRemoveCustomFieldsRequest = BulkRemoveCustomFieldsRequest;\n type storesCatalogV1Product_universal_d_BulkRemoveCustomFieldsResponse = BulkRemoveCustomFieldsResponse;\n type storesCatalogV1Product_universal_d_CreateCollectionRequest = CreateCollectionRequest;\n type storesCatalogV1Product_universal_d_Collection = Collection;\n type storesCatalogV1Product_universal_d_CreateCollectionResponse = CreateCollectionResponse;\n type storesCatalogV1Product_universal_d_UpdateCollectionRequest = UpdateCollectionRequest;\n type storesCatalogV1Product_universal_d_UpdateCollectionResponse = UpdateCollectionResponse;\n type storesCatalogV1Product_universal_d_DeleteCollectionRequest = DeleteCollectionRequest;\n type storesCatalogV1Product_universal_d_DeleteCollectionResponse = DeleteCollectionResponse;\n type storesCatalogV1Product_universal_d_RemoveProductRibbonRequest = RemoveProductRibbonRequest;\n type storesCatalogV1Product_universal_d_RemoveProductRibbonResponse = RemoveProductRibbonResponse;\n type storesCatalogV1Product_universal_d_BulkUpdateProductsRequest = BulkUpdateProductsRequest;\n type storesCatalogV1Product_universal_d_SetValue = SetValue;\n type storesCatalogV1Product_universal_d_SetValueValueOneOf = SetValueValueOneOf;\n type storesCatalogV1Product_universal_d_BulkUpdateProductsResponse = BulkUpdateProductsResponse;\n type storesCatalogV1Product_universal_d_BulkProductResult = BulkProductResult;\n type storesCatalogV1Product_universal_d_ItemMetadata = ItemMetadata;\n type storesCatalogV1Product_universal_d_ApplicationError = ApplicationError;\n type storesCatalogV1Product_universal_d_BulkActionMetadata = BulkActionMetadata;\n type storesCatalogV1Product_universal_d_BulkUpdateProductsByFilterSyncRequest = BulkUpdateProductsByFilterSyncRequest;\n type storesCatalogV1Product_universal_d_BulkUpdateProductsByFilterSyncResponse = BulkUpdateProductsByFilterSyncResponse;\n type storesCatalogV1Product_universal_d_AllowedProductsCountLimitExceededErrorData = AllowedProductsCountLimitExceededErrorData;\n type storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesRequest = BulkAdjustProductPropertiesRequest;\n type storesCatalogV1Product_universal_d_AdjustValue = AdjustValue;\n type storesCatalogV1Product_universal_d_AdjustValueValueOneOf = AdjustValueValueOneOf;\n type storesCatalogV1Product_universal_d_PropertyAdjustmentData = PropertyAdjustmentData;\n type storesCatalogV1Product_universal_d_PropertyAdjustmentDataByOneOf = PropertyAdjustmentDataByOneOf;\n type storesCatalogV1Product_universal_d_PercentageData = PercentageData;\n type storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesResponse = BulkAdjustProductPropertiesResponse;\n type storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesByFilterSyncRequest = BulkAdjustProductPropertiesByFilterSyncRequest;\n type storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesByFilterSyncResponse = BulkAdjustProductPropertiesByFilterSyncResponse;\n type storesCatalogV1Product_universal_d_ReCloneStoreRequest = ReCloneStoreRequest;\n type storesCatalogV1Product_universal_d_ReCloneStoreResponse = ReCloneStoreResponse;\n type storesCatalogV1Product_universal_d_V1CreateProductPlatformizedRequest = V1CreateProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_V1CreateProductPlatformizedResponse = V1CreateProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_V1UpdateProductPlatformizedRequest = V1UpdateProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_V1UpdateProductPlatformizedResponse = V1UpdateProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_V1DeleteProductPlatformizedRequest = V1DeleteProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_V1DeleteProductPlatformizedResponse = V1DeleteProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_ProductCreated = ProductCreated;\n type storesCatalogV1Product_universal_d_Version = Version;\n const storesCatalogV1Product_universal_d_Version: typeof Version;\n type storesCatalogV1Product_universal_d_ProductChanged = ProductChanged;\n type storesCatalogV1Product_universal_d_ProductDeleted = ProductDeleted;\n type storesCatalogV1Product_universal_d_CollectionCreated = CollectionCreated;\n type storesCatalogV1Product_universal_d_CollectionChanged = CollectionChanged;\n type storesCatalogV1Product_universal_d_CollectionDeleted = CollectionDeleted;\n type storesCatalogV1Product_universal_d_VariantsChanged = VariantsChanged;\n type storesCatalogV1Product_universal_d_VariantChanged = VariantChanged;\n type storesCatalogV1Product_universal_d_QueryProductsRequest = QueryProductsRequest;\n type storesCatalogV1Product_universal_d_QueryProductsResponse = QueryProductsResponse;\n type storesCatalogV1Product_universal_d_QueryProductsPlatformizedRequest = QueryProductsPlatformizedRequest;\n type storesCatalogV1Product_universal_d_PlatformQuery = PlatformQuery;\n type storesCatalogV1Product_universal_d_PlatformQueryPagingMethodOneOf = PlatformQueryPagingMethodOneOf;\n type storesCatalogV1Product_universal_d_Sorting = Sorting;\n type storesCatalogV1Product_universal_d_SortOrder = SortOrder;\n const storesCatalogV1Product_universal_d_SortOrder: typeof SortOrder;\n type storesCatalogV1Product_universal_d_PlatformPaging = PlatformPaging;\n type storesCatalogV1Product_universal_d_CursorPaging = CursorPaging;\n type storesCatalogV1Product_universal_d_QueryProductsPlatformizedResponse = QueryProductsPlatformizedResponse;\n type storesCatalogV1Product_universal_d_PlatformPagingMetadata = PlatformPagingMetadata;\n type storesCatalogV1Product_universal_d_Cursors = Cursors;\n type storesCatalogV1Product_universal_d_QueryProductsWithBigPageLimitRequest = QueryProductsWithBigPageLimitRequest;\n type storesCatalogV1Product_universal_d_QueryWithBigPageLimit = QueryWithBigPageLimit;\n type storesCatalogV1Product_universal_d_PagingWithBigLimit = PagingWithBigLimit;\n type storesCatalogV1Product_universal_d_GetProductsRequest = GetProductsRequest;\n type storesCatalogV1Product_universal_d_GetProductsResponse = GetProductsResponse;\n type storesCatalogV1Product_universal_d_GetProductRequest = GetProductRequest;\n type storesCatalogV1Product_universal_d_GetProductResponse = GetProductResponse;\n type storesCatalogV1Product_universal_d_GetProductPlatformizedRequest = GetProductPlatformizedRequest;\n type storesCatalogV1Product_universal_d_GetProductPlatformizedResponse = GetProductPlatformizedResponse;\n type storesCatalogV1Product_universal_d_QueryCollectionsRequest = QueryCollectionsRequest;\n type storesCatalogV1Product_universal_d_QueryCollectionsResponse = QueryCollectionsResponse;\n type storesCatalogV1Product_universal_d_QueryCollectionsPlatformizedRequest = QueryCollectionsPlatformizedRequest;\n type storesCatalogV1Product_universal_d_QueryCollectionsPlatformizedResponse = QueryCollectionsPlatformizedResponse;\n type storesCatalogV1Product_universal_d_GetCollectionRequest = GetCollectionRequest;\n type storesCatalogV1Product_universal_d_GetCollectionResponse = GetCollectionResponse;\n type storesCatalogV1Product_universal_d_GetCollectionBySlugRequest = GetCollectionBySlugRequest;\n type storesCatalogV1Product_universal_d_GetCollectionBySlugResponse = GetCollectionBySlugResponse;\n type storesCatalogV1Product_universal_d_ProductOptionsAvailabilityRequest = ProductOptionsAvailabilityRequest;\n type storesCatalogV1Product_universal_d_ProductOptionsAvailabilityResponse = ProductOptionsAvailabilityResponse;\n type storesCatalogV1Product_universal_d_VariantData = VariantData;\n type storesCatalogV1Product_universal_d_QueryProductVariantsRequest = QueryProductVariantsRequest;\n type storesCatalogV1Product_universal_d_QueryProductVariantsResponse = QueryProductVariantsResponse;\n type storesCatalogV1Product_universal_d_QueryStoreVariantsRequest = QueryStoreVariantsRequest;\n type storesCatalogV1Product_universal_d_QueryStoreVariantsResponse = QueryStoreVariantsResponse;\n type storesCatalogV1Product_universal_d_StoreVariant = StoreVariant;\n type storesCatalogV1Product_universal_d_PlatformMedia = PlatformMedia;\n type storesCatalogV1Product_universal_d_PlatformMediaMediaOneOf = PlatformMediaMediaOneOf;\n type storesCatalogV1Product_universal_d_FocalPoint = FocalPoint;\n type storesCatalogV1Product_universal_d_VideoResolution = VideoResolution;\n type storesCatalogV1Product_universal_d_PreorderInfo = PreorderInfo;\n type storesCatalogV1Product_universal_d_QueryStoreVariantsWithBigLimitRequest = QueryStoreVariantsWithBigLimitRequest;\n type storesCatalogV1Product_universal_d_UnlimitedPlatformQuery = UnlimitedPlatformQuery;\n type storesCatalogV1Product_universal_d_UnlimitedPlatformQueryPagingMethodOneOf = UnlimitedPlatformQueryPagingMethodOneOf;\n type storesCatalogV1Product_universal_d_UnlimitedPlatformPaging = UnlimitedPlatformPaging;\n type storesCatalogV1Product_universal_d_UnlimitedPlatformCursorPaging = UnlimitedPlatformCursorPaging;\n type storesCatalogV1Product_universal_d_GetStoreVariantRequest = GetStoreVariantRequest;\n type storesCatalogV1Product_universal_d_GetStoreVariantResponse = GetStoreVariantResponse;\n type storesCatalogV1Product_universal_d_QueryCustomFieldsRequest = QueryCustomFieldsRequest;\n type storesCatalogV1Product_universal_d_QueryCustomFieldsResponse = QueryCustomFieldsResponse;\n type storesCatalogV1Product_universal_d_BulkQueryCustomFieldsRequest = BulkQueryCustomFieldsRequest;\n type storesCatalogV1Product_universal_d_BulkQueryCustomFieldsResponse = BulkQueryCustomFieldsResponse;\n type storesCatalogV1Product_universal_d_CustomFieldsContainer = CustomFieldsContainer;\n type storesCatalogV1Product_universal_d_AggregateProductsRequest = AggregateProductsRequest;\n type storesCatalogV1Product_universal_d_AggregateProductsResponse = AggregateProductsResponse;\n const storesCatalogV1Product_universal_d_createProduct: typeof createProduct;\n const storesCatalogV1Product_universal_d_createProductPlatformized: typeof createProductPlatformized;\n const storesCatalogV1Product_universal_d_createDigitalProduct: typeof createDigitalProduct;\n type storesCatalogV1Product_universal_d_CreateDigitalProductOptions = CreateDigitalProductOptions;\n const storesCatalogV1Product_universal_d_updateProduct: typeof updateProduct;\n type storesCatalogV1Product_universal_d_UpdateProduct = UpdateProduct;\n const storesCatalogV1Product_universal_d_updateProductPlatformized: typeof updateProductPlatformized;\n type storesCatalogV1Product_universal_d_UpdateProductPlatformizedProduct = UpdateProductPlatformizedProduct;\n const storesCatalogV1Product_universal_d_deleteProduct: typeof deleteProduct;\n const storesCatalogV1Product_universal_d_deleteProductPlatformized: typeof deleteProductPlatformized;\n const storesCatalogV1Product_universal_d_bulkDeleteProducts: typeof bulkDeleteProducts;\n const storesCatalogV1Product_universal_d_updateProductVariants: typeof updateProductVariants;\n const storesCatalogV1Product_universal_d_resetAllProductVariantData: typeof resetAllProductVariantData;\n const storesCatalogV1Product_universal_d_addProductsToCollection: typeof addProductsToCollection;\n const storesCatalogV1Product_universal_d_removeProductsFromCollection: typeof removeProductsFromCollection;\n const storesCatalogV1Product_universal_d_addProductMedia: typeof addProductMedia;\n const storesCatalogV1Product_universal_d_removeProductMedia: typeof removeProductMedia;\n const storesCatalogV1Product_universal_d_addProductMediaToChoices: typeof addProductMediaToChoices;\n const storesCatalogV1Product_universal_d_removeProductMediaFromChoices: typeof removeProductMediaFromChoices;\n const storesCatalogV1Product_universal_d_deleteProductOptions: typeof deleteProductOptions;\n const storesCatalogV1Product_universal_d_setCustomFields: typeof setCustomFields;\n type storesCatalogV1Product_universal_d_SetCustomFieldsOptions = SetCustomFieldsOptions;\n const storesCatalogV1Product_universal_d_removeCustomFields: typeof removeCustomFields;\n type storesCatalogV1Product_universal_d_RemoveCustomFieldsOptions = RemoveCustomFieldsOptions;\n const storesCatalogV1Product_universal_d_removeBrand: typeof removeBrand;\n const storesCatalogV1Product_universal_d_bulkSetCustomFields: typeof bulkSetCustomFields;\n type storesCatalogV1Product_universal_d_BulkSetCustomFieldsOptions = BulkSetCustomFieldsOptions;\n const storesCatalogV1Product_universal_d_bulkRemoveCustomFields: typeof bulkRemoveCustomFields;\n type storesCatalogV1Product_universal_d_BulkRemoveCustomFieldsOptions = BulkRemoveCustomFieldsOptions;\n const storesCatalogV1Product_universal_d_createCollection: typeof createCollection;\n const storesCatalogV1Product_universal_d_updateCollection: typeof updateCollection;\n type storesCatalogV1Product_universal_d_UpdateCollection = UpdateCollection;\n const storesCatalogV1Product_universal_d_deleteCollection: typeof deleteCollection;\n const storesCatalogV1Product_universal_d_removeRibbon: typeof removeRibbon;\n const storesCatalogV1Product_universal_d_bulkUpdateProductsProperty: typeof bulkUpdateProductsProperty;\n const storesCatalogV1Product_universal_d_bulkUpdateProductsByFilterSync: typeof bulkUpdateProductsByFilterSync;\n type storesCatalogV1Product_universal_d_BulkUpdateProductsByFilterSyncOptions = BulkUpdateProductsByFilterSyncOptions;\n const storesCatalogV1Product_universal_d_bulkAdjustProductProperty: typeof bulkAdjustProductProperty;\n const storesCatalogV1Product_universal_d_bulkAdjustProductPropertiesByFilterSync: typeof bulkAdjustProductPropertiesByFilterSync;\n type storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesByFilterSyncOptions = BulkAdjustProductPropertiesByFilterSyncOptions;\n const storesCatalogV1Product_universal_d_reCloneStore: typeof reCloneStore;\n type storesCatalogV1Product_universal_d_ReCloneStoreOptions = ReCloneStoreOptions;\n const storesCatalogV1Product_universal_d_writeProxyCreateProductPlatformized: typeof writeProxyCreateProductPlatformized;\n const storesCatalogV1Product_universal_d_writeProxyUpdateProductPlatformized: typeof writeProxyUpdateProductPlatformized;\n type storesCatalogV1Product_universal_d_WriteProxyUpdateProductPlatformizedProduct = WriteProxyUpdateProductPlatformizedProduct;\n const storesCatalogV1Product_universal_d_writeProxyDeleteProductPlatformized: typeof writeProxyDeleteProductPlatformized;\n const storesCatalogV1Product_universal_d_queryProductsNonPlatformized: typeof queryProductsNonPlatformized;\n type storesCatalogV1Product_universal_d_QueryProductsNonPlatformizedOptions = QueryProductsNonPlatformizedOptions;\n const storesCatalogV1Product_universal_d_queryProducts: typeof queryProducts;\n type storesCatalogV1Product_universal_d_ProductsQueryResult = ProductsQueryResult;\n type storesCatalogV1Product_universal_d_ProductsQueryBuilder = ProductsQueryBuilder;\n const storesCatalogV1Product_universal_d_queryProductsWithBigPageLimit: typeof queryProductsWithBigPageLimit;\n type storesCatalogV1Product_universal_d_QueryProductsWithBigPageLimitOptions = QueryProductsWithBigPageLimitOptions;\n const storesCatalogV1Product_universal_d_getProduct: typeof getProduct;\n type storesCatalogV1Product_universal_d_GetProductOptions = GetProductOptions;\n const storesCatalogV1Product_universal_d_getProductPlatformized: typeof getProductPlatformized;\n type storesCatalogV1Product_universal_d_GetProductPlatformizedOptions = GetProductPlatformizedOptions;\n const storesCatalogV1Product_universal_d_queryCollections: typeof queryCollections;\n type storesCatalogV1Product_universal_d_QueryCollectionsOptions = QueryCollectionsOptions;\n const storesCatalogV1Product_universal_d_getCollection: typeof getCollection;\n type storesCatalogV1Product_universal_d_GetCollectionOptions = GetCollectionOptions;\n const storesCatalogV1Product_universal_d_getCollectionBySlug: typeof getCollectionBySlug;\n const storesCatalogV1Product_universal_d_getProductOptionsAvailability: typeof getProductOptionsAvailability;\n const storesCatalogV1Product_universal_d_queryProductVariants: typeof queryProductVariants;\n type storesCatalogV1Product_universal_d_QueryProductVariantsOptions = QueryProductVariantsOptions;\n const storesCatalogV1Product_universal_d_queryStoreVariants: typeof queryStoreVariants;\n type storesCatalogV1Product_universal_d_QueryStoreVariantsOptions = QueryStoreVariantsOptions;\n const storesCatalogV1Product_universal_d_queryStoreVariantsWithBigLimit: typeof queryStoreVariantsWithBigLimit;\n type storesCatalogV1Product_universal_d_QueryStoreVariantsWithBigLimitOptions = QueryStoreVariantsWithBigLimitOptions;\n const storesCatalogV1Product_universal_d_getStoreVariant: typeof getStoreVariant;\n const storesCatalogV1Product_universal_d_aggregateProducts: typeof aggregateProducts;\n type storesCatalogV1Product_universal_d_AggregateProductsOptions = AggregateProductsOptions;\n namespace storesCatalogV1Product_universal_d {\n export {\n storesCatalogV1Product_universal_d_Product as Product,\n storesCatalogV1Product_universal_d_ProductType as ProductType,\n storesCatalogV1Product_universal_d_NumericPropertyRange as NumericPropertyRange,\n storesCatalogV1Product_universal_d_Stock as Stock,\n storesCatalogV1Product_universal_d_InventoryStatus as InventoryStatus,\n storesCatalogV1Product_universal_d_PriceData as PriceData,\n storesCatalogV1Product_universal_d_FormattedPrice as FormattedPrice,\n storesCatalogV1Product_universal_d_CostAndProfitData as CostAndProfitData,\n storesCatalogV1Product_universal_d_PricePerUnitData as PricePerUnitData,\n storesCatalogV1Product_universal_d_MeasurementUnit as MeasurementUnit,\n storesCatalogV1Product_universal_d_AdditionalInfoSection as AdditionalInfoSection,\n storesCatalogV1Product_universal_d_Ribbon as Ribbon,\n storesCatalogV1Product_universal_d_Media as Media,\n storesCatalogV1Product_universal_d_MediaItem as MediaItem,\n storesCatalogV1Product_universal_d_MediaItemItemOneOf as MediaItemItemOneOf,\n storesCatalogV1Product_universal_d_MediaItemUrlAndSize as MediaItemUrlAndSize,\n storesCatalogV1Product_universal_d_MediaItemType as MediaItemType,\n storesCatalogV1Product_universal_d_MediaItemVideo as MediaItemVideo,\n storesCatalogV1Product_universal_d_CustomTextField as CustomTextField,\n storesCatalogV1Product_universal_d_ProductOption as ProductOption,\n storesCatalogV1Product_universal_d_OptionType as OptionType,\n storesCatalogV1Product_universal_d_Choice as Choice,\n storesCatalogV1Product_universal_d_PageUrl as PageUrl,\n Discount$1 as Discount,\n DiscountType$1 as DiscountType,\n storesCatalogV1Product_universal_d_Variant as Variant,\n storesCatalogV1Product_universal_d_VariantDataWithNoStock as VariantDataWithNoStock,\n storesCatalogV1Product_universal_d_VariantStock as VariantStock,\n storesCatalogV1Product_universal_d_SeoSchema as SeoSchema,\n storesCatalogV1Product_universal_d_Keyword as Keyword,\n storesCatalogV1Product_universal_d_Tag as Tag,\n storesCatalogV1Product_universal_d_Settings as Settings,\n storesCatalogV1Product_universal_d_SecuredMedia as SecuredMedia,\n storesCatalogV1Product_universal_d_FileType as FileType,\n storesCatalogV1Product_universal_d_CreateProductRequest as CreateProductRequest,\n storesCatalogV1Product_universal_d_CreateProductResponse as CreateProductResponse,\n storesCatalogV1Product_universal_d_CreateProductPlatformizedRequest as CreateProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_CreateProductPlatformizedResponse as CreateProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_CreateDigitalProductRequest as CreateDigitalProductRequest,\n storesCatalogV1Product_universal_d_CreateDigitalProductResponse as CreateDigitalProductResponse,\n storesCatalogV1Product_universal_d_UpdateProductRequest as UpdateProductRequest,\n storesCatalogV1Product_universal_d_UpdateProductResponse as UpdateProductResponse,\n storesCatalogV1Product_universal_d_UpdateProductPlatformizedRequest as UpdateProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_UpdateProductPlatformizedResponse as UpdateProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_DeleteProductRequest as DeleteProductRequest,\n storesCatalogV1Product_universal_d_DeleteProductResponse as DeleteProductResponse,\n storesCatalogV1Product_universal_d_DeleteProductPlatformizedRequest as DeleteProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_DeleteProductPlatformizedResponse as DeleteProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_BulkDeleteProductsRequest as BulkDeleteProductsRequest,\n storesCatalogV1Product_universal_d_BulkDeleteProductsResponse as BulkDeleteProductsResponse,\n storesCatalogV1Product_universal_d_UpdateVariantsRequest as UpdateVariantsRequest,\n storesCatalogV1Product_universal_d_VariantOverride as VariantOverride,\n storesCatalogV1Product_universal_d_UpdateVariantsResponse as UpdateVariantsResponse,\n storesCatalogV1Product_universal_d_ResetAllVariantDataRequest as ResetAllVariantDataRequest,\n storesCatalogV1Product_universal_d_ResetAllVariantDataResponse as ResetAllVariantDataResponse,\n storesCatalogV1Product_universal_d_AddProductsToCollectionRequest as AddProductsToCollectionRequest,\n storesCatalogV1Product_universal_d_AddProductsToCollectionResponse as AddProductsToCollectionResponse,\n storesCatalogV1Product_universal_d_RemoveProductsFromCollectionRequest as RemoveProductsFromCollectionRequest,\n storesCatalogV1Product_universal_d_RemoveProductsFromCollectionResponse as RemoveProductsFromCollectionResponse,\n storesCatalogV1Product_universal_d_AddProductMediaRequest as AddProductMediaRequest,\n storesCatalogV1Product_universal_d_MediaDataForWrite as MediaDataForWrite,\n storesCatalogV1Product_universal_d_MediaDataForWriteMediaSourceOneOf as MediaDataForWriteMediaSourceOneOf,\n storesCatalogV1Product_universal_d_OptionAndChoice as OptionAndChoice,\n storesCatalogV1Product_universal_d_AddProductMediaResponse as AddProductMediaResponse,\n storesCatalogV1Product_universal_d_RemoveProductMediaRequest as RemoveProductMediaRequest,\n storesCatalogV1Product_universal_d_RemoveProductMediaResponse as RemoveProductMediaResponse,\n storesCatalogV1Product_universal_d_AddProductMediaToChoicesRequest as AddProductMediaToChoicesRequest,\n storesCatalogV1Product_universal_d_MediaAssignmentToChoice as MediaAssignmentToChoice,\n storesCatalogV1Product_universal_d_AddProductMediaToChoicesResponse as AddProductMediaToChoicesResponse,\n storesCatalogV1Product_universal_d_RemoveProductMediaFromChoicesRequest as RemoveProductMediaFromChoicesRequest,\n storesCatalogV1Product_universal_d_RemoveProductMediaFromChoicesResponse as RemoveProductMediaFromChoicesResponse,\n storesCatalogV1Product_universal_d_DeleteProductOptionsRequest as DeleteProductOptionsRequest,\n storesCatalogV1Product_universal_d_DeleteProductOptionsResponse as DeleteProductOptionsResponse,\n storesCatalogV1Product_universal_d_SetCustomFieldsRequest as SetCustomFieldsRequest,\n storesCatalogV1Product_universal_d_SetCustomFieldsResponse as SetCustomFieldsResponse,\n storesCatalogV1Product_universal_d_RemoveCustomFieldsRequest as RemoveCustomFieldsRequest,\n storesCatalogV1Product_universal_d_RemoveCustomFieldsResponse as RemoveCustomFieldsResponse,\n storesCatalogV1Product_universal_d_RemoveProductBrandRequest as RemoveProductBrandRequest,\n storesCatalogV1Product_universal_d_RemoveProductBrandResponse as RemoveProductBrandResponse,\n storesCatalogV1Product_universal_d_BulkSetCustomFieldsRequest as BulkSetCustomFieldsRequest,\n storesCatalogV1Product_universal_d_BulkSetCustomFieldsResponse as BulkSetCustomFieldsResponse,\n storesCatalogV1Product_universal_d_BulkRemoveCustomFieldsRequest as BulkRemoveCustomFieldsRequest,\n storesCatalogV1Product_universal_d_BulkRemoveCustomFieldsResponse as BulkRemoveCustomFieldsResponse,\n storesCatalogV1Product_universal_d_CreateCollectionRequest as CreateCollectionRequest,\n storesCatalogV1Product_universal_d_Collection as Collection,\n storesCatalogV1Product_universal_d_CreateCollectionResponse as CreateCollectionResponse,\n storesCatalogV1Product_universal_d_UpdateCollectionRequest as UpdateCollectionRequest,\n storesCatalogV1Product_universal_d_UpdateCollectionResponse as UpdateCollectionResponse,\n storesCatalogV1Product_universal_d_DeleteCollectionRequest as DeleteCollectionRequest,\n storesCatalogV1Product_universal_d_DeleteCollectionResponse as DeleteCollectionResponse,\n storesCatalogV1Product_universal_d_RemoveProductRibbonRequest as RemoveProductRibbonRequest,\n storesCatalogV1Product_universal_d_RemoveProductRibbonResponse as RemoveProductRibbonResponse,\n storesCatalogV1Product_universal_d_BulkUpdateProductsRequest as BulkUpdateProductsRequest,\n storesCatalogV1Product_universal_d_SetValue as SetValue,\n storesCatalogV1Product_universal_d_SetValueValueOneOf as SetValueValueOneOf,\n storesCatalogV1Product_universal_d_BulkUpdateProductsResponse as BulkUpdateProductsResponse,\n storesCatalogV1Product_universal_d_BulkProductResult as BulkProductResult,\n storesCatalogV1Product_universal_d_ItemMetadata as ItemMetadata,\n storesCatalogV1Product_universal_d_ApplicationError as ApplicationError,\n storesCatalogV1Product_universal_d_BulkActionMetadata as BulkActionMetadata,\n storesCatalogV1Product_universal_d_BulkUpdateProductsByFilterSyncRequest as BulkUpdateProductsByFilterSyncRequest,\n storesCatalogV1Product_universal_d_BulkUpdateProductsByFilterSyncResponse as BulkUpdateProductsByFilterSyncResponse,\n storesCatalogV1Product_universal_d_AllowedProductsCountLimitExceededErrorData as AllowedProductsCountLimitExceededErrorData,\n storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesRequest as BulkAdjustProductPropertiesRequest,\n storesCatalogV1Product_universal_d_AdjustValue as AdjustValue,\n storesCatalogV1Product_universal_d_AdjustValueValueOneOf as AdjustValueValueOneOf,\n storesCatalogV1Product_universal_d_PropertyAdjustmentData as PropertyAdjustmentData,\n storesCatalogV1Product_universal_d_PropertyAdjustmentDataByOneOf as PropertyAdjustmentDataByOneOf,\n storesCatalogV1Product_universal_d_PercentageData as PercentageData,\n storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesResponse as BulkAdjustProductPropertiesResponse,\n storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesByFilterSyncRequest as BulkAdjustProductPropertiesByFilterSyncRequest,\n storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesByFilterSyncResponse as BulkAdjustProductPropertiesByFilterSyncResponse,\n storesCatalogV1Product_universal_d_ReCloneStoreRequest as ReCloneStoreRequest,\n storesCatalogV1Product_universal_d_ReCloneStoreResponse as ReCloneStoreResponse,\n storesCatalogV1Product_universal_d_V1CreateProductPlatformizedRequest as V1CreateProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_V1CreateProductPlatformizedResponse as V1CreateProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_V1UpdateProductPlatformizedRequest as V1UpdateProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_V1UpdateProductPlatformizedResponse as V1UpdateProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_V1DeleteProductPlatformizedRequest as V1DeleteProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_V1DeleteProductPlatformizedResponse as V1DeleteProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_ProductCreated as ProductCreated,\n storesCatalogV1Product_universal_d_Version as Version,\n storesCatalogV1Product_universal_d_ProductChanged as ProductChanged,\n storesCatalogV1Product_universal_d_ProductDeleted as ProductDeleted,\n storesCatalogV1Product_universal_d_CollectionCreated as CollectionCreated,\n storesCatalogV1Product_universal_d_CollectionChanged as CollectionChanged,\n storesCatalogV1Product_universal_d_CollectionDeleted as CollectionDeleted,\n storesCatalogV1Product_universal_d_VariantsChanged as VariantsChanged,\n storesCatalogV1Product_universal_d_VariantChanged as VariantChanged,\n storesCatalogV1Product_universal_d_QueryProductsRequest as QueryProductsRequest,\n Query$1 as Query,\n Paging$2 as Paging,\n storesCatalogV1Product_universal_d_QueryProductsResponse as QueryProductsResponse,\n PagingMetadata$1 as PagingMetadata,\n storesCatalogV1Product_universal_d_QueryProductsPlatformizedRequest as QueryProductsPlatformizedRequest,\n storesCatalogV1Product_universal_d_PlatformQuery as PlatformQuery,\n storesCatalogV1Product_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf,\n storesCatalogV1Product_universal_d_Sorting as Sorting,\n storesCatalogV1Product_universal_d_SortOrder as SortOrder,\n storesCatalogV1Product_universal_d_PlatformPaging as PlatformPaging,\n storesCatalogV1Product_universal_d_CursorPaging as CursorPaging,\n storesCatalogV1Product_universal_d_QueryProductsPlatformizedResponse as QueryProductsPlatformizedResponse,\n storesCatalogV1Product_universal_d_PlatformPagingMetadata as PlatformPagingMetadata,\n storesCatalogV1Product_universal_d_Cursors as Cursors,\n storesCatalogV1Product_universal_d_QueryProductsWithBigPageLimitRequest as QueryProductsWithBigPageLimitRequest,\n storesCatalogV1Product_universal_d_QueryWithBigPageLimit as QueryWithBigPageLimit,\n storesCatalogV1Product_universal_d_PagingWithBigLimit as PagingWithBigLimit,\n storesCatalogV1Product_universal_d_GetProductsRequest as GetProductsRequest,\n storesCatalogV1Product_universal_d_GetProductsResponse as GetProductsResponse,\n storesCatalogV1Product_universal_d_GetProductRequest as GetProductRequest,\n storesCatalogV1Product_universal_d_GetProductResponse as GetProductResponse,\n storesCatalogV1Product_universal_d_GetProductPlatformizedRequest as GetProductPlatformizedRequest,\n storesCatalogV1Product_universal_d_GetProductPlatformizedResponse as GetProductPlatformizedResponse,\n storesCatalogV1Product_universal_d_QueryCollectionsRequest as QueryCollectionsRequest,\n storesCatalogV1Product_universal_d_QueryCollectionsResponse as QueryCollectionsResponse,\n storesCatalogV1Product_universal_d_QueryCollectionsPlatformizedRequest as QueryCollectionsPlatformizedRequest,\n storesCatalogV1Product_universal_d_QueryCollectionsPlatformizedResponse as QueryCollectionsPlatformizedResponse,\n storesCatalogV1Product_universal_d_GetCollectionRequest as GetCollectionRequest,\n storesCatalogV1Product_universal_d_GetCollectionResponse as GetCollectionResponse,\n storesCatalogV1Product_universal_d_GetCollectionBySlugRequest as GetCollectionBySlugRequest,\n storesCatalogV1Product_universal_d_GetCollectionBySlugResponse as GetCollectionBySlugResponse,\n storesCatalogV1Product_universal_d_ProductOptionsAvailabilityRequest as ProductOptionsAvailabilityRequest,\n storesCatalogV1Product_universal_d_ProductOptionsAvailabilityResponse as ProductOptionsAvailabilityResponse,\n storesCatalogV1Product_universal_d_VariantData as VariantData,\n storesCatalogV1Product_universal_d_QueryProductVariantsRequest as QueryProductVariantsRequest,\n storesCatalogV1Product_universal_d_QueryProductVariantsResponse as QueryProductVariantsResponse,\n storesCatalogV1Product_universal_d_QueryStoreVariantsRequest as QueryStoreVariantsRequest,\n storesCatalogV1Product_universal_d_QueryStoreVariantsResponse as QueryStoreVariantsResponse,\n storesCatalogV1Product_universal_d_StoreVariant as StoreVariant,\n storesCatalogV1Product_universal_d_PlatformMedia as PlatformMedia,\n storesCatalogV1Product_universal_d_PlatformMediaMediaOneOf as PlatformMediaMediaOneOf,\n storesCatalogV1Product_universal_d_FocalPoint as FocalPoint,\n storesCatalogV1Product_universal_d_VideoResolution as VideoResolution,\n storesCatalogV1Product_universal_d_PreorderInfo as PreorderInfo,\n storesCatalogV1Product_universal_d_QueryStoreVariantsWithBigLimitRequest as QueryStoreVariantsWithBigLimitRequest,\n storesCatalogV1Product_universal_d_UnlimitedPlatformQuery as UnlimitedPlatformQuery,\n storesCatalogV1Product_universal_d_UnlimitedPlatformQueryPagingMethodOneOf as UnlimitedPlatformQueryPagingMethodOneOf,\n storesCatalogV1Product_universal_d_UnlimitedPlatformPaging as UnlimitedPlatformPaging,\n storesCatalogV1Product_universal_d_UnlimitedPlatformCursorPaging as UnlimitedPlatformCursorPaging,\n storesCatalogV1Product_universal_d_GetStoreVariantRequest as GetStoreVariantRequest,\n storesCatalogV1Product_universal_d_GetStoreVariantResponse as GetStoreVariantResponse,\n storesCatalogV1Product_universal_d_QueryCustomFieldsRequest as QueryCustomFieldsRequest,\n storesCatalogV1Product_universal_d_QueryCustomFieldsResponse as QueryCustomFieldsResponse,\n storesCatalogV1Product_universal_d_BulkQueryCustomFieldsRequest as BulkQueryCustomFieldsRequest,\n storesCatalogV1Product_universal_d_BulkQueryCustomFieldsResponse as BulkQueryCustomFieldsResponse,\n storesCatalogV1Product_universal_d_CustomFieldsContainer as CustomFieldsContainer,\n storesCatalogV1Product_universal_d_AggregateProductsRequest as AggregateProductsRequest,\n storesCatalogV1Product_universal_d_AggregateProductsResponse as AggregateProductsResponse,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n storesCatalogV1Product_universal_d_createProduct as createProduct,\n storesCatalogV1Product_universal_d_createProductPlatformized as createProductPlatformized,\n storesCatalogV1Product_universal_d_createDigitalProduct as createDigitalProduct,\n storesCatalogV1Product_universal_d_CreateDigitalProductOptions as CreateDigitalProductOptions,\n storesCatalogV1Product_universal_d_updateProduct as updateProduct,\n storesCatalogV1Product_universal_d_UpdateProduct as UpdateProduct,\n storesCatalogV1Product_universal_d_updateProductPlatformized as updateProductPlatformized,\n storesCatalogV1Product_universal_d_UpdateProductPlatformizedProduct as UpdateProductPlatformizedProduct,\n storesCatalogV1Product_universal_d_deleteProduct as deleteProduct,\n storesCatalogV1Product_universal_d_deleteProductPlatformized as deleteProductPlatformized,\n storesCatalogV1Product_universal_d_bulkDeleteProducts as bulkDeleteProducts,\n storesCatalogV1Product_universal_d_updateProductVariants as updateProductVariants,\n storesCatalogV1Product_universal_d_resetAllProductVariantData as resetAllProductVariantData,\n storesCatalogV1Product_universal_d_addProductsToCollection as addProductsToCollection,\n storesCatalogV1Product_universal_d_removeProductsFromCollection as removeProductsFromCollection,\n storesCatalogV1Product_universal_d_addProductMedia as addProductMedia,\n storesCatalogV1Product_universal_d_removeProductMedia as removeProductMedia,\n storesCatalogV1Product_universal_d_addProductMediaToChoices as addProductMediaToChoices,\n storesCatalogV1Product_universal_d_removeProductMediaFromChoices as removeProductMediaFromChoices,\n storesCatalogV1Product_universal_d_deleteProductOptions as deleteProductOptions,\n storesCatalogV1Product_universal_d_setCustomFields as setCustomFields,\n storesCatalogV1Product_universal_d_SetCustomFieldsOptions as SetCustomFieldsOptions,\n storesCatalogV1Product_universal_d_removeCustomFields as removeCustomFields,\n storesCatalogV1Product_universal_d_RemoveCustomFieldsOptions as RemoveCustomFieldsOptions,\n storesCatalogV1Product_universal_d_removeBrand as removeBrand,\n storesCatalogV1Product_universal_d_bulkSetCustomFields as bulkSetCustomFields,\n storesCatalogV1Product_universal_d_BulkSetCustomFieldsOptions as BulkSetCustomFieldsOptions,\n storesCatalogV1Product_universal_d_bulkRemoveCustomFields as bulkRemoveCustomFields,\n storesCatalogV1Product_universal_d_BulkRemoveCustomFieldsOptions as BulkRemoveCustomFieldsOptions,\n storesCatalogV1Product_universal_d_createCollection as createCollection,\n storesCatalogV1Product_universal_d_updateCollection as updateCollection,\n storesCatalogV1Product_universal_d_UpdateCollection as UpdateCollection,\n storesCatalogV1Product_universal_d_deleteCollection as deleteCollection,\n storesCatalogV1Product_universal_d_removeRibbon as removeRibbon,\n storesCatalogV1Product_universal_d_bulkUpdateProductsProperty as bulkUpdateProductsProperty,\n storesCatalogV1Product_universal_d_bulkUpdateProductsByFilterSync as bulkUpdateProductsByFilterSync,\n storesCatalogV1Product_universal_d_BulkUpdateProductsByFilterSyncOptions as BulkUpdateProductsByFilterSyncOptions,\n storesCatalogV1Product_universal_d_bulkAdjustProductProperty as bulkAdjustProductProperty,\n storesCatalogV1Product_universal_d_bulkAdjustProductPropertiesByFilterSync as bulkAdjustProductPropertiesByFilterSync,\n storesCatalogV1Product_universal_d_BulkAdjustProductPropertiesByFilterSyncOptions as BulkAdjustProductPropertiesByFilterSyncOptions,\n storesCatalogV1Product_universal_d_reCloneStore as reCloneStore,\n storesCatalogV1Product_universal_d_ReCloneStoreOptions as ReCloneStoreOptions,\n storesCatalogV1Product_universal_d_writeProxyCreateProductPlatformized as writeProxyCreateProductPlatformized,\n storesCatalogV1Product_universal_d_writeProxyUpdateProductPlatformized as writeProxyUpdateProductPlatformized,\n storesCatalogV1Product_universal_d_WriteProxyUpdateProductPlatformizedProduct as WriteProxyUpdateProductPlatformizedProduct,\n storesCatalogV1Product_universal_d_writeProxyDeleteProductPlatformized as writeProxyDeleteProductPlatformized,\n storesCatalogV1Product_universal_d_queryProductsNonPlatformized as queryProductsNonPlatformized,\n storesCatalogV1Product_universal_d_QueryProductsNonPlatformizedOptions as QueryProductsNonPlatformizedOptions,\n storesCatalogV1Product_universal_d_queryProducts as queryProducts,\n storesCatalogV1Product_universal_d_ProductsQueryResult as ProductsQueryResult,\n storesCatalogV1Product_universal_d_ProductsQueryBuilder as ProductsQueryBuilder,\n storesCatalogV1Product_universal_d_queryProductsWithBigPageLimit as queryProductsWithBigPageLimit,\n storesCatalogV1Product_universal_d_QueryProductsWithBigPageLimitOptions as QueryProductsWithBigPageLimitOptions,\n storesCatalogV1Product_universal_d_getProduct as getProduct,\n storesCatalogV1Product_universal_d_GetProductOptions as GetProductOptions,\n storesCatalogV1Product_universal_d_getProductPlatformized as getProductPlatformized,\n storesCatalogV1Product_universal_d_GetProductPlatformizedOptions as GetProductPlatformizedOptions,\n storesCatalogV1Product_universal_d_queryCollections as queryCollections,\n storesCatalogV1Product_universal_d_QueryCollectionsOptions as QueryCollectionsOptions,\n storesCatalogV1Product_universal_d_getCollection as getCollection,\n storesCatalogV1Product_universal_d_GetCollectionOptions as GetCollectionOptions,\n storesCatalogV1Product_universal_d_getCollectionBySlug as getCollectionBySlug,\n storesCatalogV1Product_universal_d_getProductOptionsAvailability as getProductOptionsAvailability,\n storesCatalogV1Product_universal_d_queryProductVariants as queryProductVariants,\n storesCatalogV1Product_universal_d_QueryProductVariantsOptions as QueryProductVariantsOptions,\n storesCatalogV1Product_universal_d_queryStoreVariants as queryStoreVariants,\n storesCatalogV1Product_universal_d_QueryStoreVariantsOptions as QueryStoreVariantsOptions,\n storesCatalogV1Product_universal_d_queryStoreVariantsWithBigLimit as queryStoreVariantsWithBigLimit,\n storesCatalogV1Product_universal_d_QueryStoreVariantsWithBigLimitOptions as QueryStoreVariantsWithBigLimitOptions,\n storesCatalogV1Product_universal_d_getStoreVariant as getStoreVariant,\n storesCatalogV1Product_universal_d_aggregateProducts as aggregateProducts,\n storesCatalogV1Product_universal_d_AggregateProductsOptions as AggregateProductsOptions,\n };\n }\n \n interface AbandonedCart {\n /** Original cart ID */\n _id?: string;\n /** Cart status */\n status?: Status;\n /**\n * Time the cart was abandoned\n * @readonly\n */\n abandonTime?: Date | null;\n /** Buyer information */\n buyerInfo?: BuyerInfo;\n /** Cart total including currency symbol */\n total?: string | null;\n /**\n * History activities\n * @readonly\n */\n activities?: Activity[];\n }\n enum Status {\n ABANDONED = \"ABANDONED\",\n RECOVERED = \"RECOVERED\"\n }\n interface BuyerInfo {\n /** Wix customer ID */\n _id?: string;\n /** Customer information */\n identityType?: Identity;\n /** Customer's email address */\n email?: string | null;\n /** Customer's phone number */\n phone?: string | null;\n /** Customer's first name */\n firstName?: string | null;\n /** Customer's last name */\n lastName?: string | null;\n }\n enum Identity {\n /** Customer is the site owner */\n ADMIN = \"ADMIN\",\n /** Customer is logged in */\n MEMBER = \"MEMBER\",\n /** Customer is not logged in */\n VISITOR = \"VISITOR\",\n /** Contact was created for the customer */\n CONTACT = \"CONTACT\"\n }\n interface Activity {\n /**\n * Log item type\n * @readonly\n */\n activityType?: ActivityType;\n /**\n * Comment added to Log item\n * @readonly\n */\n message?: string | null;\n /**\n * Log item occurrence timestamp\n * @readonly\n */\n timestamp?: Date | null;\n /** Custom data for un-typed activities */\n customData?: CustomData;\n }\n enum ActivityType {\n UNRECOGNIZED_TYPE = \"UNRECOGNIZED_TYPE\",\n SCHEDULED = \"SCHEDULED\",\n EMAIL_SENT = \"EMAIL_SENT\",\n EMAIL_NOT_SENT = \"EMAIL_NOT_SENT\",\n NOTIFICATION_SENT = \"NOTIFICATION_SENT\",\n TASK_CREATED = \"TASK_CREATED\",\n CUSTOM_ACTIVITY = \"CUSTOM_ACTIVITY\"\n }\n interface CustomData {\n /** Activity unique namespace */\n namespace?: string | null;\n /** Custom json field for any desired data */\n customValue?: Record | null;\n }\n interface CartAbandonedEvent {\n cartId?: string;\n /**\n * Time the cart was created\n * @readonly\n */\n creationTime?: Date | null;\n /**\n * Time the cart was abandoned\n * @readonly\n */\n abandonTime?: Date | null;\n /** Buyer information */\n buyerInfo?: BuyerInfo;\n /** Amount of items in cart */\n itemsCount?: number;\n /** Coupon ID (if relevant) */\n couponId?: string;\n /** Subtotal of all line items in cart, not before shipping and taxes */\n totals?: Totals;\n /** Checkout URL - checkout with the abandoned cart details */\n checkoutUrl?: string;\n /**\n * checkout id for buy now flow\n * @internal\n * @readonly\n */\n checkoutId?: string | null;\n }\n interface Totals {\n /** Subtotal of all line items in cart, without shipping and taxes */\n subtotal?: number | null;\n /** Total cart price */\n total?: number | null;\n /** Formatted total cart price includes currency symbol */\n formattedTotal?: string;\n }\n interface CartRecoveredEvent {\n cartId?: string;\n /**\n * Time the cart was recovered\n * @readonly\n */\n recoveredTime?: Date | null;\n /**\n * Time the cart was created\n * @readonly\n */\n creationTime?: Date | null;\n /**\n * Time the cart was abandoned\n * @readonly\n */\n abandonedTime?: Date | null;\n /**\n * Checkout id\n * @internal\n * @readonly\n */\n checkoutId?: string | null;\n }\n interface CartDeletedEvent {\n instanceId?: string;\n cartId?: string;\n }\n interface GetAbandonedCartRequest {\n /** Cart ID */\n _id: string;\n }\n interface GetAbandonedCartResponse {\n /** Cart details */\n abandonedCart?: AbandonedCart;\n }\n interface QueryAbandonedCartsRequest {\n /** Query details */\n query?: Query;\n }\n interface Query {\n paging?: Paging$1;\n /** A filter string, for more information see the intro section */\n filter?: string | null;\n /** Sort string, for more information see the intro section */\n sort?: string | null;\n }\n interface Paging$1 {\n /** The number of items to load */\n limit?: number | null;\n /** The offset since the beginning of the collection */\n offset?: number | null;\n }\n interface QueryAbandonedCartsResponse {\n /** Abandoned carts list */\n abandonedCarts?: AbandonedCart[];\n /** Total number of carts */\n totalResults?: number;\n }\n interface DeleteCartRequest {\n /** Cart ID */\n _id: string;\n }\n interface DeleteCartResponse {\n }\n interface RedirectToCheckoutRequest {\n /** abandoned cart id */\n _id: string;\n /** Identifier of the metaSite this cart uses */\n metaSiteId?: string;\n /** The currency code to create the redirection link with */\n currency?: string | null;\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 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 abandoned carts based on the cart ID\n * @param _id - Cart ID\n * @internal\n * @requiredField _id\n * @permissionId WIX_STORES.READ_ABANDONED_CARTS\n * @adminMethod\n * @returns Cart details\n */\n function getAbandonedCart(_id: string): Promise;\n /**\n * Returns abandoned carts based on the requested query parameters\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_STORES.READ_ABANDONED_CARTS\n * @adminMethod\n */\n function queryAbandonedCarts(options?: QueryAbandonedCartsOptions): Promise;\n interface QueryAbandonedCartsOptions {\n /** Query details */\n query?: Query;\n }\n /**\n * Delete a cart by cart ID\n * @param _id - Cart ID\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.DELETE_ABANDONED_CARTS\n * @adminMethod\n */\n function deleteCart(_id: string): Promise;\n /**\n * Search abandonment cart/checkout by id and redirect to checkout page.\n * @param _id - abandoned cart id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function redirectToCheckout(_id: string, options?: RedirectToCheckoutOptions): Promise;\n interface RedirectToCheckoutOptions {\n /** Identifier of the metaSite this cart uses */\n metaSiteId?: string;\n /** The currency code to create the redirection link with */\n currency?: string | null;\n }\n \n type storesV1AbandonedCart_universal_d_AbandonedCart = AbandonedCart;\n type storesV1AbandonedCart_universal_d_Status = Status;\n const storesV1AbandonedCart_universal_d_Status: typeof Status;\n type storesV1AbandonedCart_universal_d_BuyerInfo = BuyerInfo;\n type storesV1AbandonedCart_universal_d_Identity = Identity;\n const storesV1AbandonedCart_universal_d_Identity: typeof Identity;\n type storesV1AbandonedCart_universal_d_Activity = Activity;\n type storesV1AbandonedCart_universal_d_ActivityType = ActivityType;\n const storesV1AbandonedCart_universal_d_ActivityType: typeof ActivityType;\n type storesV1AbandonedCart_universal_d_CustomData = CustomData;\n type storesV1AbandonedCart_universal_d_CartAbandonedEvent = CartAbandonedEvent;\n type storesV1AbandonedCart_universal_d_Totals = Totals;\n type storesV1AbandonedCart_universal_d_CartRecoveredEvent = CartRecoveredEvent;\n type storesV1AbandonedCart_universal_d_CartDeletedEvent = CartDeletedEvent;\n type storesV1AbandonedCart_universal_d_GetAbandonedCartRequest = GetAbandonedCartRequest;\n type storesV1AbandonedCart_universal_d_GetAbandonedCartResponse = GetAbandonedCartResponse;\n type storesV1AbandonedCart_universal_d_QueryAbandonedCartsRequest = QueryAbandonedCartsRequest;\n type storesV1AbandonedCart_universal_d_Query = Query;\n type storesV1AbandonedCart_universal_d_QueryAbandonedCartsResponse = QueryAbandonedCartsResponse;\n type storesV1AbandonedCart_universal_d_DeleteCartRequest = DeleteCartRequest;\n type storesV1AbandonedCart_universal_d_DeleteCartResponse = DeleteCartResponse;\n type storesV1AbandonedCart_universal_d_RedirectToCheckoutRequest = RedirectToCheckoutRequest;\n type storesV1AbandonedCart_universal_d_RawHttpResponse = RawHttpResponse;\n type storesV1AbandonedCart_universal_d_HeadersEntry = HeadersEntry;\n type storesV1AbandonedCart_universal_d_MessageEnvelope = MessageEnvelope;\n type storesV1AbandonedCart_universal_d_IdentificationData = IdentificationData;\n type storesV1AbandonedCart_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type storesV1AbandonedCart_universal_d_WebhookIdentityType = WebhookIdentityType;\n const storesV1AbandonedCart_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const storesV1AbandonedCart_universal_d_getAbandonedCart: typeof getAbandonedCart;\n const storesV1AbandonedCart_universal_d_queryAbandonedCarts: typeof queryAbandonedCarts;\n type storesV1AbandonedCart_universal_d_QueryAbandonedCartsOptions = QueryAbandonedCartsOptions;\n const storesV1AbandonedCart_universal_d_deleteCart: typeof deleteCart;\n const storesV1AbandonedCart_universal_d_redirectToCheckout: typeof redirectToCheckout;\n type storesV1AbandonedCart_universal_d_RedirectToCheckoutOptions = RedirectToCheckoutOptions;\n namespace storesV1AbandonedCart_universal_d {\n export {\n storesV1AbandonedCart_universal_d_AbandonedCart as AbandonedCart,\n storesV1AbandonedCart_universal_d_Status as Status,\n storesV1AbandonedCart_universal_d_BuyerInfo as BuyerInfo,\n storesV1AbandonedCart_universal_d_Identity as Identity,\n storesV1AbandonedCart_universal_d_Activity as Activity,\n storesV1AbandonedCart_universal_d_ActivityType as ActivityType,\n storesV1AbandonedCart_universal_d_CustomData as CustomData,\n storesV1AbandonedCart_universal_d_CartAbandonedEvent as CartAbandonedEvent,\n storesV1AbandonedCart_universal_d_Totals as Totals,\n storesV1AbandonedCart_universal_d_CartRecoveredEvent as CartRecoveredEvent,\n storesV1AbandonedCart_universal_d_CartDeletedEvent as CartDeletedEvent,\n storesV1AbandonedCart_universal_d_GetAbandonedCartRequest as GetAbandonedCartRequest,\n storesV1AbandonedCart_universal_d_GetAbandonedCartResponse as GetAbandonedCartResponse,\n storesV1AbandonedCart_universal_d_QueryAbandonedCartsRequest as QueryAbandonedCartsRequest,\n storesV1AbandonedCart_universal_d_Query as Query,\n Paging$1 as Paging,\n storesV1AbandonedCart_universal_d_QueryAbandonedCartsResponse as QueryAbandonedCartsResponse,\n storesV1AbandonedCart_universal_d_DeleteCartRequest as DeleteCartRequest,\n storesV1AbandonedCart_universal_d_DeleteCartResponse as DeleteCartResponse,\n storesV1AbandonedCart_universal_d_RedirectToCheckoutRequest as RedirectToCheckoutRequest,\n storesV1AbandonedCart_universal_d_RawHttpResponse as RawHttpResponse,\n storesV1AbandonedCart_universal_d_HeadersEntry as HeadersEntry,\n storesV1AbandonedCart_universal_d_MessageEnvelope as MessageEnvelope,\n storesV1AbandonedCart_universal_d_IdentificationData as IdentificationData,\n storesV1AbandonedCart_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n storesV1AbandonedCart_universal_d_WebhookIdentityType as WebhookIdentityType,\n storesV1AbandonedCart_universal_d_getAbandonedCart as getAbandonedCart,\n storesV1AbandonedCart_universal_d_queryAbandonedCarts as queryAbandonedCarts,\n storesV1AbandonedCart_universal_d_QueryAbandonedCartsOptions as QueryAbandonedCartsOptions,\n storesV1AbandonedCart_universal_d_deleteCart as deleteCart,\n storesV1AbandonedCart_universal_d_redirectToCheckout as redirectToCheckout,\n storesV1AbandonedCart_universal_d_RedirectToCheckoutOptions as RedirectToCheckoutOptions,\n };\n }\n \n interface SubscriptionOption {\n /** Subscription option ID (auto-generated upon subscription option creation). */\n _id?: string | null;\n /** Subscription option title. */\n title?: string | null;\n /** Subscription option description (optional). */\n description?: string | null;\n /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */\n subscriptionSettings?: SubscriptionSettings;\n /**\n * Discount info (optional).\n * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.\n */\n discount?: Discount;\n }\n interface SubscriptionSettings {\n /** Frequency of recurring payment. */\n frequency?: SubscriptionFrequency;\n /**\n * Interval of recurring payment (optional: default value 1 will be used if not provided)\n * @internal\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: 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 Discount {\n /** Discount type. */\n type?: DiscountType;\n /** Discount value. */\n value?: number;\n }\n enum DiscountType {\n UNDEFINED = \"UNDEFINED\",\n /** No discount */\n AMOUNT = \"AMOUNT\",\n PERCENT = \"PERCENT\"\n }\n interface CreateSubscriptionOptionRequest {\n /** Subscription option info. */\n subscriptionOption: SubscriptionOption;\n }\n interface CreateSubscriptionOptionResponse {\n /** Newly created subscription option. */\n subscriptionOption?: SubscriptionOption;\n }\n interface UpdateSubscriptionOptionRequest {\n /** Subscription option info. Only the passed parameters will be updated. */\n subscriptionOption: SubscriptionOption;\n }\n interface UpdateSubscriptionOptionResponse {\n /** Updated subscription option. */\n subscriptionOption?: SubscriptionOption;\n }\n interface DeleteSubscriptionOptionRequest {\n /** ID of the subscription option to delete. */\n _id: string;\n }\n interface DeleteSubscriptionOptionResponse {\n }\n interface BulkCreateSubscriptionOptionsRequest {\n /** Subscription options info. */\n subscriptionOptions: SubscriptionOption[];\n }\n interface BulkCreateSubscriptionOptionsResponse {\n /** Newly created subscription options. */\n subscriptionOptions?: SubscriptionOption[];\n }\n interface BulkUpdateSubscriptionOptionsRequest {\n /** Subscription options info. Only the passed parameters in each subscription option will be updated. */\n subscriptionOptions: SubscriptionOption[];\n }\n interface BulkUpdateSubscriptionOptionsResponse {\n /** Updated subscription options. */\n subscriptionOptions?: SubscriptionOption[];\n }\n interface BulkDeleteSubscriptionOptionsRequest {\n /** IDs of the subscription options to delete. */\n ids: string[];\n }\n interface BulkDeleteSubscriptionOptionsResponse {\n }\n interface AssignSubscriptionOptionsToProductRequest {\n /** Product ID. */\n productId: string;\n /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */\n assignedSubscriptionOptions?: SubscriptionOptionInProduct[];\n }\n interface SubscriptionOptionInProduct {\n /** Subscription option ID. */\n _id?: string;\n /** Whether the subscription option is hidden for the product (the default is false). */\n hidden?: boolean;\n /**\n * Subscription option title.\n * @readonly\n */\n title?: string | null;\n /**\n * Subscription option description (optional).\n * @readonly\n */\n description?: string | null;\n /**\n * Subscription payment settings. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.\n * @readonly\n */\n subscriptionSettings?: SubscriptionSettings;\n /**\n * Discount info (optional).\n * @readonly\n */\n discount?: Discount;\n }\n interface AssignSubscriptionOptionsToProductResponse {\n }\n interface AllowOneTimePurchasesRequest {\n /** Product ID. */\n productId: string;\n /** Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only. */\n allowed: boolean | null;\n }\n interface AllowOneTimePurchasesResponse {\n }\n interface GetSubscriptionOptionRequest {\n /** Subscription option ID. */\n _id: string;\n }\n interface GetSubscriptionOptionResponse {\n /** Subscription option. */\n subscriptionOption?: SubscriptionOption;\n }\n interface GetSubscriptionOptionsForProductRequest {\n /** Product ID. */\n productId: string;\n /** Whether to include hidden subscription options in the results. */\n includeHiddenSubscriptionOptions?: boolean;\n }\n interface GetSubscriptionOptionsForProductResponse {\n /** Subscription options. */\n subscriptionOptions?: SubscriptionOptionInProduct[];\n }\n interface ListSubscriptionOptionsRequest {\n /** Subscription option IDs. */\n ids: string[];\n }\n interface ListSubscriptionOptionsResponse {\n /** Subscription options. */\n subscriptionOptions?: SubscriptionOption[];\n }\n interface CalculatePricesRequest {\n /** original price to which subscription options discount will be applied */\n price?: number;\n /** ids of subscription options which will be applied to original price */\n ids: string[];\n }\n interface CalculatePricesResponse {\n /** array of calculated prices */\n prices?: SubscriptionOptionPrices[];\n /** price to which subscription options discount applied */\n originalPrice?: number;\n }\n interface SubscriptionOptionPrices {\n /** Subscription option id */\n _id?: string;\n /** Price data calculated for subscription option */\n priceData?: SubscriptionOptionPriceData;\n /** Price data calculated for subscription option, converted to the currency requested in request header */\n convertedPriceData?: SubscriptionOptionPriceData;\n }\n interface SubscriptionOptionPriceData {\n /** Subscription option price currency */\n currency?: string;\n /** Price calculated after subscription option discount applied */\n discountedPrice?: number;\n /** Price calculated after subscription option discount applied, formatted with the currency */\n formattedDiscountedPrice?: string;\n }\n interface BulkCalculatePricesRequest {\n /**\n * Original prices to which subscription options discount will be applied.\n * Key is identifier unique per price that can be used to match calculated prices with original price\n */\n prices: Record;\n /** ids of subscription options which will be applied to original price */\n ids: string[];\n }\n interface BulkCalculatePricesResponse {\n /**\n * Key is identifier unique per price that can be used to match calculated prices with original price\n * Value is response with calculated prices for each subscription option\n */\n calculatedPrices?: Record;\n }\n interface BulkCalculatePricesRequestV2 {\n /** Original prices to be calculated for each corresponding product id with related subscription plan ids */\n items: BulkCalculatePricesRequestItem[];\n }\n interface BulkCalculatePricesRequestItem {\n /** Calculation id (product id) */\n _id?: string;\n /**\n * Original prices to which subscription options discount will be applied.\n * Key is identifier unique per price that can be used to match calculated prices with original price\n */\n prices?: Record;\n /** ids of subscription options which will be applied to original price. */\n subscriptionOptionIds?: string[];\n }\n interface BulkCalculatePricesResponseV2 {\n /**\n * Key is identifier unique per price that can be used to match calculated prices with original price\n * Value is response with calculated prices for each subscription option for each product\n */\n calculatedPricesPerProduct?: BulkCalculatePricesResponseItem[];\n }\n interface BulkCalculatePricesResponseItem {\n /** Calculation id (product id) */\n _id?: string;\n /**\n * Key is identifier unique per price that can be used to match calculated prices with original price\n * Value is response with calculated prices for each subscription option\n */\n calculatedPrices?: Record;\n }\n interface GetProductIdsForSubscriptionOptionRequest {\n /** Subscription option ID. */\n _id: string;\n /** Whether to include hidden products in the returned results. */\n includeHiddenProducts?: boolean;\n /** Optional pagination parameters */\n paging?: Paging;\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 GetProductIdsForSubscriptionOptionResponse {\n /** IDs of products associated with the specified subscription option. */\n productIds?: string[];\n /** Paging metadata. */\n metadata?: PagingMetadata;\n /** Number of total results. */\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 GetOneTimePurchasesStatusRequest {\n /** Product ID. */\n productId: string;\n }\n interface GetOneTimePurchasesStatusResponse {\n /** Whether the specified product is available for one-time purchase */\n allowed?: boolean;\n }\n /**\n * Creates a subscription option.\n * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).\n * Subscription options that are not assigned to a product will not be visible in the Wix business manager.\n * @param subscriptionOption - Subscription option info.\n * @public\n * @documentationMaturity preview\n * @requiredField subscriptionOption\n * @requiredField subscriptionOption.subscriptionSettings\n * @requiredField subscriptionOption.title\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @returns Newly created subscription option.\n * @deprecated\n */\n function createSubscriptionOption(subscriptionOption: SubscriptionOption): Promise;\n /**\n * Updates a subscription option.\n * Only parameters passed will be updated.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param _id - Subscription option ID (auto-generated upon subscription option creation).\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField subscriptionOption\n * @param subscriptionOption - Subscription option update options.\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @returns Updated subscription option.\n * @deprecated\n */\n function updateSubscriptionOption(_id: string | null, subscriptionOption: UpdateSubscriptionOption): Promise;\n interface UpdateSubscriptionOption {\n /** Subscription option ID (auto-generated upon subscription option creation). */\n _id?: string | null;\n /** Subscription option title. */\n title?: string | null;\n /** Subscription option description (optional). */\n description?: string | null;\n /** Subscription charge times. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months. */\n subscriptionSettings?: SubscriptionSettings;\n /**\n * Discount info (optional).\n * For example, a $20 discount would be `value: 20`, `type: AMOUNT`.\n */\n discount?: Discount;\n }\n /**\n * Deletes a subscription option.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param _id - ID of the subscription option to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function deleteSubscriptionOption(_id: string): Promise;\n /**\n * Creates multiple subscription options (up to 100).\n * To assign to a product, call [`assignSubscriptionOptionsToProduct()`](https://www.wix.com/velo/reference/wix-stores-v2/subscriptionoptions/assign-subscription-options-to-product).\n * Subscription options that are not assigned to a product will not be visible in the Wix business manager.\n * @param subscriptionOptions - Subscription options info.\n * @public\n * @documentationMaturity preview\n * @requiredField subscriptionOptions\n * @requiredField subscriptionOptions.subscriptionSettings\n * @requiredField subscriptionOptions.title\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function bulkCreateSubscriptionOptions(subscriptionOptions: SubscriptionOption[]): Promise;\n /**\n * Updates multiple subscription options.\n * Only parameters passed will be updated.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param subscriptionOptions - Subscription options info. Only the passed parameters in each subscription option will be updated.\n * @public\n * @documentationMaturity preview\n * @requiredField subscriptionOptions\n * @requiredField subscriptionOptions._id\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function bulkUpdateSubscriptionOptions(subscriptionOptions: SubscriptionOption[]): Promise;\n /**\n * Deletes multiple subscription options.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param ids - IDs of the subscription options to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function bulkDeleteSubscriptionOptions(ids: string[]): Promise;\n /**\n * Assign up to 6 subscription options to a specified product.\n * Pass an empty array to remove all subscription options assigned to a product.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param productId - Product ID.\n * @public\n * @documentationMaturity preview\n * @requiredField productId\n * @param options - Subscription option assignment options.\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function assignSubscriptionOptionsToProduct(productId: string, options?: AssignSubscriptionOptionsToProductOptions): Promise;\n interface AssignSubscriptionOptionsToProductOptions {\n /** Ordered array of subscription options that will be assigned to the product. Pass an empty array to remove all subscription options from the product. */\n assignedSubscriptionOptions?: SubscriptionOptionInProduct[];\n }\n /**\n * Allow for one-time purchase of a product.\n * By default, product can be sold only as part of a subscription, not as a one-time purchase.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param productId - Product ID.\n * @param allowed - Pass `true` to offer product by subscription and as one-time purchase. Pass `false` to offer product as subscription only.\n * @public\n * @documentationMaturity preview\n * @requiredField allowed\n * @requiredField productId\n * @permissionId WIX_STORES.MODIFY_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function allowOneTimePurchases(productId: string, allowed: boolean | null): Promise;\n /**\n * Retrieves a subscription option by ID.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param _id - Subscription option ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @returns Subscription option.\n * @deprecated\n */\n function getSubscriptionOption(_id: string): Promise;\n /**\n * Retrieves all subscription options assigned to a specified product.\n * By default, hidden subscription options are not returned. To retrieve all subscription options you must pass `includeHiddenSubscriptionOptions = true`.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param productId - Product ID.\n * @public\n * @documentationMaturity preview\n * @requiredField productId\n * @param options - Options.\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function getSubscriptionOptionsForProduct(productId: string, options?: GetSubscriptionOptionsForProductOptions): Promise;\n interface GetSubscriptionOptionsForProductOptions {\n /** Whether to include hidden subscription options in the results. */\n includeHiddenSubscriptionOptions?: boolean;\n }\n /**\n * Returns the specified subscription options.\n * If the specified subscription option doesn't exist, the request will be successful but the response will be empty.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param ids - Subscription option IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function listSubscriptionOptions(ids: string[]): Promise;\n /**\n * Calculates discounted price when specified subscription option applied to given price.\n * before open to users it should support price calculations by productId/variantId in addition to price\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @internal\n * @documentationMaturity preview\n * @requiredField options.ids\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function calculatePrices(options?: CalculatePricesOptions): Promise;\n interface CalculatePricesOptions {\n /** original price to which subscription options discount will be applied */\n price?: number;\n /** ids of subscription options which will be applied to original price */\n ids: string[];\n }\n /**\n * Calculates discounted price when specified subscription option applied for each of prices provided.\n * before open to users it should support price calculations by productId/variantId in addition to price\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param prices - Original prices to which subscription options discount will be applied.\n * Key is identifier unique per price that can be used to match calculated prices with original price\n * @internal\n * @documentationMaturity preview\n * @requiredField options\n * @requiredField options.ids\n * @requiredField prices\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function bulkCalculatePrices(prices: Record, options: BulkCalculatePricesOptions): Promise;\n interface BulkCalculatePricesOptions {\n /** ids of subscription options which will be applied to original price */\n ids: string[];\n }\n /**\n * Calculates discounted price when specified subscription option applied for each of prices provided for each product.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param items - Original prices to be calculated for each corresponding product id with related subscription plan ids\n * @internal\n * @documentationMaturity preview\n * @requiredField items\n * @requiredField items._id\n * @requiredField items.prices\n * @requiredField items.subscriptionOptionIds\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function bulkCalculatePricesForProducts(items: BulkCalculatePricesRequestItem[]): Promise;\n /**\n * Retrieves the IDs of products associated with a specified subscription option.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param _id - Subscription option ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @param options - Paging and other options.\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function getProductIdsForSubscriptionOption(_id: string, options?: GetProductIdsForSubscriptionOptionOptions): Promise;\n interface GetProductIdsForSubscriptionOptionOptions {\n /** Whether to include hidden products in the returned results. */\n includeHiddenProducts?: boolean;\n /** Optional pagination parameters */\n paging?: Paging;\n }\n /**\n * Checks whether a specified product (associated with subscription options) is available for one-time purchase.\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been deprecated and will be removed on January 29, 2024.\n *\n *
      \n * @param productId - Product ID.\n * @public\n * @documentationMaturity preview\n * @requiredField productId\n * @permissionId WIX_STORES.READ_SUBSCRIPTION_OPTIONS\n * @adminMethod\n * @deprecated\n */\n function getOneTimePurchasesStatus(productId: string): Promise;\n \n type storesV1SubscriptionOption_universal_d_SubscriptionOption = SubscriptionOption;\n type storesV1SubscriptionOption_universal_d_SubscriptionSettings = SubscriptionSettings;\n type storesV1SubscriptionOption_universal_d_SubscriptionFrequency = SubscriptionFrequency;\n const storesV1SubscriptionOption_universal_d_SubscriptionFrequency: typeof SubscriptionFrequency;\n type storesV1SubscriptionOption_universal_d_Discount = Discount;\n type storesV1SubscriptionOption_universal_d_DiscountType = DiscountType;\n const storesV1SubscriptionOption_universal_d_DiscountType: typeof DiscountType;\n type storesV1SubscriptionOption_universal_d_CreateSubscriptionOptionRequest = CreateSubscriptionOptionRequest;\n type storesV1SubscriptionOption_universal_d_CreateSubscriptionOptionResponse = CreateSubscriptionOptionResponse;\n type storesV1SubscriptionOption_universal_d_UpdateSubscriptionOptionRequest = UpdateSubscriptionOptionRequest;\n type storesV1SubscriptionOption_universal_d_UpdateSubscriptionOptionResponse = UpdateSubscriptionOptionResponse;\n type storesV1SubscriptionOption_universal_d_DeleteSubscriptionOptionRequest = DeleteSubscriptionOptionRequest;\n type storesV1SubscriptionOption_universal_d_DeleteSubscriptionOptionResponse = DeleteSubscriptionOptionResponse;\n type storesV1SubscriptionOption_universal_d_BulkCreateSubscriptionOptionsRequest = BulkCreateSubscriptionOptionsRequest;\n type storesV1SubscriptionOption_universal_d_BulkCreateSubscriptionOptionsResponse = BulkCreateSubscriptionOptionsResponse;\n type storesV1SubscriptionOption_universal_d_BulkUpdateSubscriptionOptionsRequest = BulkUpdateSubscriptionOptionsRequest;\n type storesV1SubscriptionOption_universal_d_BulkUpdateSubscriptionOptionsResponse = BulkUpdateSubscriptionOptionsResponse;\n type storesV1SubscriptionOption_universal_d_BulkDeleteSubscriptionOptionsRequest = BulkDeleteSubscriptionOptionsRequest;\n type storesV1SubscriptionOption_universal_d_BulkDeleteSubscriptionOptionsResponse = BulkDeleteSubscriptionOptionsResponse;\n type storesV1SubscriptionOption_universal_d_AssignSubscriptionOptionsToProductRequest = AssignSubscriptionOptionsToProductRequest;\n type storesV1SubscriptionOption_universal_d_SubscriptionOptionInProduct = SubscriptionOptionInProduct;\n type storesV1SubscriptionOption_universal_d_AssignSubscriptionOptionsToProductResponse = AssignSubscriptionOptionsToProductResponse;\n type storesV1SubscriptionOption_universal_d_AllowOneTimePurchasesRequest = AllowOneTimePurchasesRequest;\n type storesV1SubscriptionOption_universal_d_AllowOneTimePurchasesResponse = AllowOneTimePurchasesResponse;\n type storesV1SubscriptionOption_universal_d_GetSubscriptionOptionRequest = GetSubscriptionOptionRequest;\n type storesV1SubscriptionOption_universal_d_GetSubscriptionOptionResponse = GetSubscriptionOptionResponse;\n type storesV1SubscriptionOption_universal_d_GetSubscriptionOptionsForProductRequest = GetSubscriptionOptionsForProductRequest;\n type storesV1SubscriptionOption_universal_d_GetSubscriptionOptionsForProductResponse = GetSubscriptionOptionsForProductResponse;\n type storesV1SubscriptionOption_universal_d_ListSubscriptionOptionsRequest = ListSubscriptionOptionsRequest;\n type storesV1SubscriptionOption_universal_d_ListSubscriptionOptionsResponse = ListSubscriptionOptionsResponse;\n type storesV1SubscriptionOption_universal_d_CalculatePricesRequest = CalculatePricesRequest;\n type storesV1SubscriptionOption_universal_d_CalculatePricesResponse = CalculatePricesResponse;\n type storesV1SubscriptionOption_universal_d_SubscriptionOptionPrices = SubscriptionOptionPrices;\n type storesV1SubscriptionOption_universal_d_SubscriptionOptionPriceData = SubscriptionOptionPriceData;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesRequest = BulkCalculatePricesRequest;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesResponse = BulkCalculatePricesResponse;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesRequestV2 = BulkCalculatePricesRequestV2;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesRequestItem = BulkCalculatePricesRequestItem;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesResponseV2 = BulkCalculatePricesResponseV2;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesResponseItem = BulkCalculatePricesResponseItem;\n type storesV1SubscriptionOption_universal_d_GetProductIdsForSubscriptionOptionRequest = GetProductIdsForSubscriptionOptionRequest;\n type storesV1SubscriptionOption_universal_d_Paging = Paging;\n type storesV1SubscriptionOption_universal_d_GetProductIdsForSubscriptionOptionResponse = GetProductIdsForSubscriptionOptionResponse;\n type storesV1SubscriptionOption_universal_d_PagingMetadata = PagingMetadata;\n type storesV1SubscriptionOption_universal_d_GetOneTimePurchasesStatusRequest = GetOneTimePurchasesStatusRequest;\n type storesV1SubscriptionOption_universal_d_GetOneTimePurchasesStatusResponse = GetOneTimePurchasesStatusResponse;\n const storesV1SubscriptionOption_universal_d_createSubscriptionOption: typeof createSubscriptionOption;\n const storesV1SubscriptionOption_universal_d_updateSubscriptionOption: typeof updateSubscriptionOption;\n type storesV1SubscriptionOption_universal_d_UpdateSubscriptionOption = UpdateSubscriptionOption;\n const storesV1SubscriptionOption_universal_d_deleteSubscriptionOption: typeof deleteSubscriptionOption;\n const storesV1SubscriptionOption_universal_d_bulkCreateSubscriptionOptions: typeof bulkCreateSubscriptionOptions;\n const storesV1SubscriptionOption_universal_d_bulkUpdateSubscriptionOptions: typeof bulkUpdateSubscriptionOptions;\n const storesV1SubscriptionOption_universal_d_bulkDeleteSubscriptionOptions: typeof bulkDeleteSubscriptionOptions;\n const storesV1SubscriptionOption_universal_d_assignSubscriptionOptionsToProduct: typeof assignSubscriptionOptionsToProduct;\n type storesV1SubscriptionOption_universal_d_AssignSubscriptionOptionsToProductOptions = AssignSubscriptionOptionsToProductOptions;\n const storesV1SubscriptionOption_universal_d_allowOneTimePurchases: typeof allowOneTimePurchases;\n const storesV1SubscriptionOption_universal_d_getSubscriptionOption: typeof getSubscriptionOption;\n const storesV1SubscriptionOption_universal_d_getSubscriptionOptionsForProduct: typeof getSubscriptionOptionsForProduct;\n type storesV1SubscriptionOption_universal_d_GetSubscriptionOptionsForProductOptions = GetSubscriptionOptionsForProductOptions;\n const storesV1SubscriptionOption_universal_d_listSubscriptionOptions: typeof listSubscriptionOptions;\n const storesV1SubscriptionOption_universal_d_calculatePrices: typeof calculatePrices;\n type storesV1SubscriptionOption_universal_d_CalculatePricesOptions = CalculatePricesOptions;\n const storesV1SubscriptionOption_universal_d_bulkCalculatePrices: typeof bulkCalculatePrices;\n type storesV1SubscriptionOption_universal_d_BulkCalculatePricesOptions = BulkCalculatePricesOptions;\n const storesV1SubscriptionOption_universal_d_bulkCalculatePricesForProducts: typeof bulkCalculatePricesForProducts;\n const storesV1SubscriptionOption_universal_d_getProductIdsForSubscriptionOption: typeof getProductIdsForSubscriptionOption;\n type storesV1SubscriptionOption_universal_d_GetProductIdsForSubscriptionOptionOptions = GetProductIdsForSubscriptionOptionOptions;\n const storesV1SubscriptionOption_universal_d_getOneTimePurchasesStatus: typeof getOneTimePurchasesStatus;\n namespace storesV1SubscriptionOption_universal_d {\n export {\n storesV1SubscriptionOption_universal_d_SubscriptionOption as SubscriptionOption,\n storesV1SubscriptionOption_universal_d_SubscriptionSettings as SubscriptionSettings,\n storesV1SubscriptionOption_universal_d_SubscriptionFrequency as SubscriptionFrequency,\n storesV1SubscriptionOption_universal_d_Discount as Discount,\n storesV1SubscriptionOption_universal_d_DiscountType as DiscountType,\n storesV1SubscriptionOption_universal_d_CreateSubscriptionOptionRequest as CreateSubscriptionOptionRequest,\n storesV1SubscriptionOption_universal_d_CreateSubscriptionOptionResponse as CreateSubscriptionOptionResponse,\n storesV1SubscriptionOption_universal_d_UpdateSubscriptionOptionRequest as UpdateSubscriptionOptionRequest,\n storesV1SubscriptionOption_universal_d_UpdateSubscriptionOptionResponse as UpdateSubscriptionOptionResponse,\n storesV1SubscriptionOption_universal_d_DeleteSubscriptionOptionRequest as DeleteSubscriptionOptionRequest,\n storesV1SubscriptionOption_universal_d_DeleteSubscriptionOptionResponse as DeleteSubscriptionOptionResponse,\n storesV1SubscriptionOption_universal_d_BulkCreateSubscriptionOptionsRequest as BulkCreateSubscriptionOptionsRequest,\n storesV1SubscriptionOption_universal_d_BulkCreateSubscriptionOptionsResponse as BulkCreateSubscriptionOptionsResponse,\n storesV1SubscriptionOption_universal_d_BulkUpdateSubscriptionOptionsRequest as BulkUpdateSubscriptionOptionsRequest,\n storesV1SubscriptionOption_universal_d_BulkUpdateSubscriptionOptionsResponse as BulkUpdateSubscriptionOptionsResponse,\n storesV1SubscriptionOption_universal_d_BulkDeleteSubscriptionOptionsRequest as BulkDeleteSubscriptionOptionsRequest,\n storesV1SubscriptionOption_universal_d_BulkDeleteSubscriptionOptionsResponse as BulkDeleteSubscriptionOptionsResponse,\n storesV1SubscriptionOption_universal_d_AssignSubscriptionOptionsToProductRequest as AssignSubscriptionOptionsToProductRequest,\n storesV1SubscriptionOption_universal_d_SubscriptionOptionInProduct as SubscriptionOptionInProduct,\n storesV1SubscriptionOption_universal_d_AssignSubscriptionOptionsToProductResponse as AssignSubscriptionOptionsToProductResponse,\n storesV1SubscriptionOption_universal_d_AllowOneTimePurchasesRequest as AllowOneTimePurchasesRequest,\n storesV1SubscriptionOption_universal_d_AllowOneTimePurchasesResponse as AllowOneTimePurchasesResponse,\n storesV1SubscriptionOption_universal_d_GetSubscriptionOptionRequest as GetSubscriptionOptionRequest,\n storesV1SubscriptionOption_universal_d_GetSubscriptionOptionResponse as GetSubscriptionOptionResponse,\n storesV1SubscriptionOption_universal_d_GetSubscriptionOptionsForProductRequest as GetSubscriptionOptionsForProductRequest,\n storesV1SubscriptionOption_universal_d_GetSubscriptionOptionsForProductResponse as GetSubscriptionOptionsForProductResponse,\n storesV1SubscriptionOption_universal_d_ListSubscriptionOptionsRequest as ListSubscriptionOptionsRequest,\n storesV1SubscriptionOption_universal_d_ListSubscriptionOptionsResponse as ListSubscriptionOptionsResponse,\n storesV1SubscriptionOption_universal_d_CalculatePricesRequest as CalculatePricesRequest,\n storesV1SubscriptionOption_universal_d_CalculatePricesResponse as CalculatePricesResponse,\n storesV1SubscriptionOption_universal_d_SubscriptionOptionPrices as SubscriptionOptionPrices,\n storesV1SubscriptionOption_universal_d_SubscriptionOptionPriceData as SubscriptionOptionPriceData,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesRequest as BulkCalculatePricesRequest,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesResponse as BulkCalculatePricesResponse,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesRequestV2 as BulkCalculatePricesRequestV2,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesRequestItem as BulkCalculatePricesRequestItem,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesResponseV2 as BulkCalculatePricesResponseV2,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesResponseItem as BulkCalculatePricesResponseItem,\n storesV1SubscriptionOption_universal_d_GetProductIdsForSubscriptionOptionRequest as GetProductIdsForSubscriptionOptionRequest,\n storesV1SubscriptionOption_universal_d_Paging as Paging,\n storesV1SubscriptionOption_universal_d_GetProductIdsForSubscriptionOptionResponse as GetProductIdsForSubscriptionOptionResponse,\n storesV1SubscriptionOption_universal_d_PagingMetadata as PagingMetadata,\n storesV1SubscriptionOption_universal_d_GetOneTimePurchasesStatusRequest as GetOneTimePurchasesStatusRequest,\n storesV1SubscriptionOption_universal_d_GetOneTimePurchasesStatusResponse as GetOneTimePurchasesStatusResponse,\n storesV1SubscriptionOption_universal_d_createSubscriptionOption as createSubscriptionOption,\n storesV1SubscriptionOption_universal_d_updateSubscriptionOption as updateSubscriptionOption,\n storesV1SubscriptionOption_universal_d_UpdateSubscriptionOption as UpdateSubscriptionOption,\n storesV1SubscriptionOption_universal_d_deleteSubscriptionOption as deleteSubscriptionOption,\n storesV1SubscriptionOption_universal_d_bulkCreateSubscriptionOptions as bulkCreateSubscriptionOptions,\n storesV1SubscriptionOption_universal_d_bulkUpdateSubscriptionOptions as bulkUpdateSubscriptionOptions,\n storesV1SubscriptionOption_universal_d_bulkDeleteSubscriptionOptions as bulkDeleteSubscriptionOptions,\n storesV1SubscriptionOption_universal_d_assignSubscriptionOptionsToProduct as assignSubscriptionOptionsToProduct,\n storesV1SubscriptionOption_universal_d_AssignSubscriptionOptionsToProductOptions as AssignSubscriptionOptionsToProductOptions,\n storesV1SubscriptionOption_universal_d_allowOneTimePurchases as allowOneTimePurchases,\n storesV1SubscriptionOption_universal_d_getSubscriptionOption as getSubscriptionOption,\n storesV1SubscriptionOption_universal_d_getSubscriptionOptionsForProduct as getSubscriptionOptionsForProduct,\n storesV1SubscriptionOption_universal_d_GetSubscriptionOptionsForProductOptions as GetSubscriptionOptionsForProductOptions,\n storesV1SubscriptionOption_universal_d_listSubscriptionOptions as listSubscriptionOptions,\n storesV1SubscriptionOption_universal_d_calculatePrices as calculatePrices,\n storesV1SubscriptionOption_universal_d_CalculatePricesOptions as CalculatePricesOptions,\n storesV1SubscriptionOption_universal_d_bulkCalculatePrices as bulkCalculatePrices,\n storesV1SubscriptionOption_universal_d_BulkCalculatePricesOptions as BulkCalculatePricesOptions,\n storesV1SubscriptionOption_universal_d_bulkCalculatePricesForProducts as bulkCalculatePricesForProducts,\n storesV1SubscriptionOption_universal_d_getProductIdsForSubscriptionOption as getProductIdsForSubscriptionOption,\n storesV1SubscriptionOption_universal_d_GetProductIdsForSubscriptionOptionOptions as GetProductIdsForSubscriptionOptionOptions,\n storesV1SubscriptionOption_universal_d_getOneTimePurchasesStatus as getOneTimePurchasesStatus,\n };\n }\n \n export { storesV1AbandonedCart_universal_d as abandonedCarts, storesCatalogV1Collection_universal_d as collections, storesV2Inventory_universal_d as inventory, storesV2Orders_universal_d as orders, storesCatalogV1Product_universal_d as products, storesV1SubscriptionOption_universal_d as subscriptionOptions, platformV1Wishlist_universal_d as wishlist };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 * Schedule ID. Read only.\n * @internal\n */\n scheduleId?: 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 \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 {\n headlessV1WixUrl_universal_d___debug as __debug,\n headlessV1WixUrl_universal_d_WixUrl as WixUrl,\n headlessV1WixUrl_universal_d_CreateWixUrlRequest as CreateWixUrlRequest,\n headlessV1WixUrl_universal_d_CreateWixUrlRequestUrlParamsOneOf as CreateWixUrlRequestUrlParamsOneOf,\n headlessV1WixUrl_universal_d_WixUrlBookingsCheckoutParams as WixUrlBookingsCheckoutParams,\n headlessV1WixUrl_universal_d_SlotAvailability as SlotAvailability,\n headlessV1WixUrl_universal_d_Slot as Slot,\n headlessV1WixUrl_universal_d_SlotResource as SlotResource,\n headlessV1WixUrl_universal_d_Location as Location,\n headlessV1WixUrl_universal_d_LocationType as LocationType,\n headlessV1WixUrl_universal_d_WaitingList as WaitingList,\n headlessV1WixUrl_universal_d_BookingPolicyViolations as BookingPolicyViolations,\n headlessV1WixUrl_universal_d_WixUrlEcomCheckoutParams as WixUrlEcomCheckoutParams,\n headlessV1WixUrl_universal_d_WixUrlEventsCheckoutParams as WixUrlEventsCheckoutParams,\n headlessV1WixUrl_universal_d_WixUrlPaidPlansCheckoutParams as WixUrlPaidPlansCheckoutParams,\n headlessV1WixUrl_universal_d_WixUrlLoginParams as WixUrlLoginParams,\n headlessV1WixUrl_universal_d_CallbackParams as CallbackParams,\n headlessV1WixUrl_universal_d_CreateWixUrlResponse as CreateWixUrlResponse,\n headlessV1WixUrl_universal_d_createWixUrl as createWixUrl,\n headlessV1WixUrl_universal_d_CreateWixUrlOptions as CreateWixUrlOptions,\n };\n }\n \n export { headlessV1WixUrl_universal_d as redirects };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-ads-txt.v1.d.ts", "content": "declare module \"wix-ads-txt.v1\" {\n interface AdsTxt {\n /** Content of Ads.txt. */\n content?: string;\n /** Whether current Ads.txt is Wix's default. */\n default?: boolean;\n /** Subdomain of Ads.txt, for example `www`, `es`, `fr`. Default is `www`. */\n subdomain?: string;\n /**\n * entity Id\n * @internal\n */\n _id?: string;\n }\n /** The request to get the Ads.txt file content */\n interface GetAdsTxtRequest {\n /** Subdomain of Ads.txt, for example `www`, `es`, `fr`. Default is `www`. */\n subdomain?: string;\n }\n /** The response of the Ads.txt file request */\n interface GetAdsTxtResponse {\n /** Ads txt object */\n adsTxt?: AdsTxt;\n }\n /** The request to update the content of the Ads.txt file */\n interface UpdateAdsTxtRequest {\n /**\n * Submitted `adsTxT` object will replace the existing Ads.txt file.\n * To reset Ads.txt to Wix's default, submit `default:true` without a `content` object.\n */\n adsTxt?: AdsTxt;\n }\n interface UpdateAdsTxtResponse {\n /** Updated Ads txt object */\n adsTxt?: AdsTxt;\n }\n /** The request to append the content of the Ads.txt file */\n interface AppendAdsTxtRequest {\n /**\n * Submitted `content` object will be appended to the existing Ads.txt file.\n * To reset Ads.txt to Wix's default, submit `default:true` without a `content` object.\n */\n adsTxt?: AdsTxt;\n }\n interface AppendAdsTxtResponse {\n /** Appended Ads.txt file. */\n adsTxt?: AdsTxt;\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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 Ads.txt file.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n * @returns The response of the Ads.txt file request\n */\n function getAdsTxt(options?: GetAdsTxtOptions): Promise;\n interface GetAdsTxtOptions {\n /** Subdomain of Ads.txt, for example `www`, `es`, `fr`. Default is `www`. */\n subdomain?: string;\n }\n /**\n * Updates the Ads.txt file.\n * When setting the `content` object to an empty string, an empty Ads.txt file will be created.\n * In order to reset Ads.txt to Wix's default, send `default: true` without a `content` object.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function updateAdsTxt(options?: UpdateAdsTxtOptions): Promise;\n interface UpdateAdsTxtOptions {\n /**\n * Submitted `adsTxT` object will replace the existing Ads.txt file.\n * To reset Ads.txt to Wix's default, submit `default:true` without a `content` object.\n */\n adsTxt?: AdsTxt;\n }\n /**\n * Appends the submitted `content` object to Ads.txt.\n * In order to reset Ads.txt to Wix's default, send `default: true` without a `content` object.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function appendAdsTxt(options?: AppendAdsTxtOptions): Promise;\n interface AppendAdsTxtOptions {\n /**\n * Submitted `content` object will be appended to the existing Ads.txt file.\n * To reset Ads.txt to Wix's default, submit `default:true` without a `content` object.\n */\n adsTxt?: AdsTxt;\n }\n \n type promoteMarketingV2AdsTxt_universal_d_AdsTxt = AdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_GetAdsTxtRequest = GetAdsTxtRequest;\n type promoteMarketingV2AdsTxt_universal_d_GetAdsTxtResponse = GetAdsTxtResponse;\n type promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtRequest = UpdateAdsTxtRequest;\n type promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtResponse = UpdateAdsTxtResponse;\n type promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtRequest = AppendAdsTxtRequest;\n type promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtResponse = AppendAdsTxtResponse;\n type promoteMarketingV2AdsTxt_universal_d_DomainEvent = DomainEvent;\n type promoteMarketingV2AdsTxt_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type promoteMarketingV2AdsTxt_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type promoteMarketingV2AdsTxt_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type promoteMarketingV2AdsTxt_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type promoteMarketingV2AdsTxt_universal_d_ActionEvent = ActionEvent;\n type promoteMarketingV2AdsTxt_universal_d_MessageEnvelope = MessageEnvelope;\n type promoteMarketingV2AdsTxt_universal_d_IdentificationData = IdentificationData;\n type promoteMarketingV2AdsTxt_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type promoteMarketingV2AdsTxt_universal_d_WebhookIdentityType = WebhookIdentityType;\n const promoteMarketingV2AdsTxt_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const promoteMarketingV2AdsTxt_universal_d_getAdsTxt: typeof getAdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_GetAdsTxtOptions = GetAdsTxtOptions;\n const promoteMarketingV2AdsTxt_universal_d_updateAdsTxt: typeof updateAdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtOptions = UpdateAdsTxtOptions;\n const promoteMarketingV2AdsTxt_universal_d_appendAdsTxt: typeof appendAdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtOptions = AppendAdsTxtOptions;\n namespace promoteMarketingV2AdsTxt_universal_d {\n export {\n promoteMarketingV2AdsTxt_universal_d_AdsTxt as AdsTxt,\n promoteMarketingV2AdsTxt_universal_d_GetAdsTxtRequest as GetAdsTxtRequest,\n promoteMarketingV2AdsTxt_universal_d_GetAdsTxtResponse as GetAdsTxtResponse,\n promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtRequest as UpdateAdsTxtRequest,\n promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtResponse as UpdateAdsTxtResponse,\n promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtRequest as AppendAdsTxtRequest,\n promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtResponse as AppendAdsTxtResponse,\n promoteMarketingV2AdsTxt_universal_d_DomainEvent as DomainEvent,\n promoteMarketingV2AdsTxt_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n promoteMarketingV2AdsTxt_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n promoteMarketingV2AdsTxt_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n promoteMarketingV2AdsTxt_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n promoteMarketingV2AdsTxt_universal_d_ActionEvent as ActionEvent,\n promoteMarketingV2AdsTxt_universal_d_MessageEnvelope as MessageEnvelope,\n promoteMarketingV2AdsTxt_universal_d_IdentificationData as IdentificationData,\n promoteMarketingV2AdsTxt_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n promoteMarketingV2AdsTxt_universal_d_WebhookIdentityType as WebhookIdentityType,\n promoteMarketingV2AdsTxt_universal_d_getAdsTxt as getAdsTxt,\n promoteMarketingV2AdsTxt_universal_d_GetAdsTxtOptions as GetAdsTxtOptions,\n promoteMarketingV2AdsTxt_universal_d_updateAdsTxt as updateAdsTxt,\n promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtOptions as UpdateAdsTxtOptions,\n promoteMarketingV2AdsTxt_universal_d_appendAdsTxt as appendAdsTxt,\n promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtOptions as AppendAdsTxtOptions,\n };\n }\n \n export { promoteMarketingV2AdsTxt_universal_d as marketing };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-sender-details.v2.d.ts", "content": "declare module \"wix-sender-details.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 /**\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 *\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 */\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 *\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 * @param senderDetails - New sender details.\n * @public\n * @documentationMaturity preview\n * @requiredField senderDetails\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 *\n *\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 * @param verificationCode - Verification code.\n * @public\n * @documentationMaturity preview\n * @requiredField verificationCode\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 *\n *\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 * @param fromAddress - User's provided address from which to send email marketing campaign.\n * @public\n * @documentationMaturity preview\n * @requiredField fromAddress\n */\n function resolveActualFromAddress(fromAddress: string): Promise;\n \n const emailMarketingV1SenderDetails_universal_d___debug: typeof __debug;\n type emailMarketingV1SenderDetails_universal_d_SenderDetails = SenderDetails;\n type emailMarketingV1SenderDetails_universal_d_GetSenderDetailsRequest = GetSenderDetailsRequest;\n type emailMarketingV1SenderDetails_universal_d_GetSenderDetailsResponse = GetSenderDetailsResponse;\n type emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsRequest = UpdateSenderDetailsRequest;\n type emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsResponse = UpdateSenderDetailsResponse;\n type emailMarketingV1SenderDetails_universal_d_VerifySenderEmailRequest = VerifySenderEmailRequest;\n type emailMarketingV1SenderDetails_universal_d_VerifySenderEmailResponse = VerifySenderEmailResponse;\n type emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressRequest = ResolveActualFromAddressRequest;\n type emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressResponse = ResolveActualFromAddressResponse;\n const emailMarketingV1SenderDetails_universal_d_getSenderDetails: typeof getSenderDetails;\n const emailMarketingV1SenderDetails_universal_d_updateSenderDetails: typeof updateSenderDetails;\n const emailMarketingV1SenderDetails_universal_d_verifyEmail: typeof verifyEmail;\n const emailMarketingV1SenderDetails_universal_d_resolveActualFromAddress: typeof resolveActualFromAddress;\n namespace emailMarketingV1SenderDetails_universal_d {\n export {\n emailMarketingV1SenderDetails_universal_d___debug as __debug,\n emailMarketingV1SenderDetails_universal_d_SenderDetails as SenderDetails,\n emailMarketingV1SenderDetails_universal_d_GetSenderDetailsRequest as GetSenderDetailsRequest,\n emailMarketingV1SenderDetails_universal_d_GetSenderDetailsResponse as GetSenderDetailsResponse,\n emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsRequest as UpdateSenderDetailsRequest,\n emailMarketingV1SenderDetails_universal_d_UpdateSenderDetailsResponse as UpdateSenderDetailsResponse,\n emailMarketingV1SenderDetails_universal_d_VerifySenderEmailRequest as VerifySenderEmailRequest,\n emailMarketingV1SenderDetails_universal_d_VerifySenderEmailResponse as VerifySenderEmailResponse,\n emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressRequest as ResolveActualFromAddressRequest,\n emailMarketingV1SenderDetails_universal_d_ResolveActualFromAddressResponse as ResolveActualFromAddressResponse,\n emailMarketingV1SenderDetails_universal_d_getSenderDetails as getSenderDetails,\n emailMarketingV1SenderDetails_universal_d_updateSenderDetails as updateSenderDetails,\n emailMarketingV1SenderDetails_universal_d_verifyEmail as verifyEmail,\n emailMarketingV1SenderDetails_universal_d_resolveActualFromAddress as resolveActualFromAddress,\n };\n }\n \n export { emailMarketingV1SenderDetails_universal_d as senderDetails };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/billing-spi-v1-tax-calculator.d.ts", "content": "declare module \"billing-spi-v1-tax-calculator\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface TaxCalculator {\n /** Identifier of this tax calculator */\n _id?: string | null;\n }\n interface CalculateTaxRequest {\n /** The Estimate Tax request details - elaborated in the EstimateTaxRequestDetails message. */\n estimateTaxRequestDetails?: EstimateTaxRequestDetails;\n }\n /** TaxEstimateRequestDetails represents the details required to calculate tax for a transaction. */\n interface EstimateTaxRequestDetails {\n /** An optional identifier of the entity that you are calculating tax for. For example, cart ID or checkout ID. */\n externalId?: string | null;\n /** The time when the tax estimation was calculated. */\n taxDate?: Date;\n /** A list of tax exemptions to be applied. */\n exemptions?: Exemptions;\n /** The tax estimation three-character ISO 4217 currency code that was used for payment for this transaction. */\n currencyCode?: string;\n /** All the relevant addresses for this estimation should be listed here. Line items will hold only reference to them. */\n addressesInfo?: Address[];\n /** A list of line items to be taxed. */\n lineItems?: LineItem[];\n /**\n * The desired currency fraction size. Optional, default is 2.\n * This will affect the way we will format the tax amount, but not affect the rate value that is always 4 as its 0.0000 to 1.0000 value.\n * e.g. when using USD the required fraction size is 2 - so for 25.544$ we will show 25.55$. (round up)\n */\n currencyFractionSize?: number | null;\n /** External estimateTax Id */\n estimationId?: string | null;\n }\n interface Exemptions {\n /** A list of tax exemptions to be applied. see ExemptionModel. */\n exemptions?: ExemptionModel[];\n }\n /** Exemption allows the user to specify what tax is exempt (no need to pay) by giving the vatId && taxType that this vat id refers to. */\n interface ExemptionModel {\n /** The vat id of the buyer. */\n vatId?: string;\n /** The tax type this vat id exempt from. */\n taxType?: string | null;\n }\n /** Wix common address format for physical address to use if you plan to store addresses in your service. */\n interface Address {\n /** Country code - 2 letters ISO-3166-1. */\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 /** Main address line, usually street and number as free text. */\n addressLine1?: string | null;\n /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */\n addressLine2?: string | null;\n }\n /** LineItem represents information about a line item. */\n interface LineItem {\n /** The ID of the line item. */\n lineNumber?: string;\n /** The number of items in this line (must be between 0 and 1,000,000). */\n quantity?: number;\n /** The price of the line item (Decimal value). */\n price?: string;\n /** The tax group ID this item is related to. */\n taxGroupId?: string | null;\n /** the default tax group ID of this item - will be used in case we did not find mapping for the taxGroupId */\n defaultTaxGroupId?: string | null;\n /** The known SKU (item code) for this line item. */\n itemCode?: string | null;\n /** Indicates whether the price already includes tax. If not provided, the default from the relevant tax region is used. */\n taxIncluded?: boolean;\n /** Free text description for this line item. (Optional) */\n description?: string | null;\n /** The address of this line, which can be either from and to locations, or a single location. */\n addressIndices?: AddressesModel;\n /** The tax region ID representing this item address model */\n taxRegionId?: string | null;\n }\n /** AddressesModel represents the address of a specific line item, which can be either from and to locations, or a single location. */\n interface AddressesModel extends AddressesModelAddressInfoOneOf {\n /**\n * Tax should be calculated by a single location. e.g. a store location.\n * Index refers to the address in the TaxEstimate addresses_info list.\n */\n singleLocationAddressIndex?: number;\n /** Tax should be calculated by a \"from\" and \"to\" locations. e.g. a shipping address. */\n fromToLocationsIndices?: FromToAddressesIndices;\n }\n /** @oneof */\n interface AddressesModelAddressInfoOneOf {\n /**\n * Tax should be calculated by a single location. e.g. a store location.\n * Index refers to the address in the TaxEstimate addresses_info list.\n */\n singleLocationAddressIndex?: number;\n /** Tax should be calculated by a \"from\" and \"to\" locations. e.g. a shipping address. */\n fromToLocationsIndices?: FromToAddressesIndices;\n }\n interface FromToAddressesIndices {\n /** The index of the \"from\" address in the TaxEstimate addresses_info list. */\n fromAddressIndex?: number;\n /** The index of the \"to\" address in the TaxEstimate addresses_info list. */\n toAddressIndex?: number;\n }\n interface CalculateTaxResponse {\n /** The tax estimation result - elaborated in the TaxEstimate message. */\n taxEstimate?: TaxEstimate;\n }\n interface TaxEstimate {\n /** Tax Estimation ID. */\n _id?: string | null;\n /** An optional identifier of the entity that you are calculating tax for. For example, cart ID or checkout ID. */\n externalId?: string | null;\n /** The time when the tax estimation was calculated. */\n taxDate?: Date;\n /** The tax estimation three-character ISO 4217 currency code that was used for payment for this transaction. */\n currencyCode?: string;\n /** The total amount of this estimate (the actual amount of money that exchanged hands). */\n totalAmount?: string;\n /** The amount of this estimate that was exempt (for all lines). */\n totalExempt?: string | null;\n /** The total amount of tax calculated for all lines in this estimate. */\n totalTax?: string;\n /** The portion of the total amount of this estimate that was taxable. */\n totalTaxable?: string;\n /** Total tax divided by total taxable. */\n averageTaxRate?: string;\n /** All the relevant addresses for this estimation should be listed here. Line items will hold only reference to them. */\n addressesInfo?: Address[];\n /** Optional tax exemptions. */\n exemptions?: Exemptions;\n /** The calculated tax for each line. */\n lineItemsTax?: LineItemTaxModel[];\n /** The errors that occurred during the tax calculation. */\n errors?: ApplicationError[];\n /** The sum of all the tax that is already included in the price. */\n totalTaxIncludedInPrice?: string | null;\n }\n /** LineItemTaxModel represents tax information for a line item. */\n interface LineItemTaxModel {\n /** The ID of the line item. */\n lineNumber?: string;\n /** Line description. */\n description?: string | null;\n /** The index of the \"destination\" address in the TaxEstimate addresses_info. */\n destinationAddressIndex?: number;\n /** The index of the \"origin\" address in the TaxEstimate addresses_info. */\n originAddressIndex?: number;\n /** The amount of this line item that was exempt. (Decimal value) */\n exemptAmount?: string | null;\n /** IDs of the used exemptions from the TaxEstimate exemptions array. */\n exemptionIds?: number[];\n /** True for items we have a tax applied on them. */\n isItemTaxable?: boolean | null;\n /** The number of items (must be between 0 and 1,000,000). */\n quantity?: number;\n /**\n * The total amount of the line, including both taxable and exempt.\n * This is the total price for all items. To determine the individual item price,\n * divide this by quantity. (Decimal value)\n */\n lineAmount?: string | null;\n /** The tax for this line in this estimation. (Decimal value) */\n tax?: string;\n /** The taxable amount of this line. (Decimal value) */\n taxableAmount?: string;\n /** True if the lineAmount includes tax in it. */\n taxIncluded?: boolean | null;\n /** A detailed description of all the tax authorities applied on this item and exemptions. */\n taxDetails?: LineItemDetailTaxModel[];\n /** The calculator that calculated this line tax. */\n calculatorName?: string | null;\n /** True if the seller has a tax region defined for this line item taxable address. */\n taxAddressHasTaxRegion?: boolean | null;\n /**\n * The rate at which this line item tax was calculated, a number between 0.0 to 1.0.\n * (This is the average of the tax applied from all the LineItemDetailTaxModel)\n */\n averageTaxRate?: string | null;\n }\n /**\n * LineItemDetailTaxModel represents tax information for a line item.\n * It will hold the tax amount and the tax rate for each tax authority that apply on the line item.\n */\n interface LineItemDetailTaxModel {\n /** The id of the line item */\n lineNumber?: string;\n /** The name of the jurisdiction in which this tax detail applies. */\n jurisdictionName?: string | null;\n /** The amount of this line item that was exempt from this authority. (Decimal value) */\n exemptAmount?: string | null;\n /** IDs of the used exemptions from the TaxEstimate exemptions array. */\n exemptionIds?: number[];\n /** The amount of this line item price that was considered nontaxable. (Decimal value) */\n nonTaxableAmount?: string | null;\n /** The rate at which this tax detail was calculated, a number between 0.0000 to 1.0000. */\n rate?: string | null;\n /** The amount of tax estimated for this line item. (Decimal value) */\n tax?: string | null;\n /** The taxable amount of this line item. (Decimal value) */\n taxableAmount?: string | null;\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 | null;\n /** The name of the tax against which this tax amount was calculated. */\n taxName?: string | null;\n /** The Taxes/Fee component. True if the fee is applied. */\n isFee?: boolean | null;\n /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */\n jurisdictionType?: JurisdictionType;\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 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 TaxCalculatorSpiConfig {\n /** User-friendly name of the tax calculator */\n calculatorDisplayName?: string;\n /** list of countries and boolean represents if its a white list or black list (supported or unsupported countries) */\n taxCountriesConfig?: TaxCountriesConfig;\n }\n interface TaxCountriesConfig {\n /** list of countries */\n countries?: string[];\n /** represents if the calculator supports tax in those countries or not */\n isSupported?: 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 /** 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 CalculateTaxOptions {\n /** The Estimate Tax request details - elaborated in the EstimateTaxRequestDetails message. */\n estimateTaxRequestDetails?: EstimateTaxRequestDetails;\n }\n \n export { Address, AddressesModel, AddressesModelAddressInfoOneOf, ApplicationError, BusinessError, CalculateTaxOptions, CalculateTaxRequest, CalculateTaxResponse, Context, EstimateTaxRequestDetails, ExemptionModel, Exemptions, FromToAddressesIndices, IdentificationData, IdentificationDataIdOneOf, IdentityType, JurisdictionType, LineItem, LineItemDetailTaxModel, LineItemTaxModel, TaxCalculator, TaxCalculatorSpiConfig, TaxCountriesConfig, TaxEstimate };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/restaurants-posspihost-v1-tpa.d.ts", "content": "declare module \"restaurants-posspihost-v1-tpa\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface Tpa {\n }\n interface ListAccountIdsRequest {\n }\n interface ListAccountIdsResponse {\n /** Account IDs with the POS system. */\n accountIds?: string[];\n }\n interface GetConfigurationStatusRequest {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n }\n interface GetConfigurationStatusResponse {\n /**\n * Status of the configuration.\n * + `NOT_STARTED` - This is the initial status for the configuration. The status is set to `NOT_STARTED` after installing the 3rd party integration app and before the integration app is authenticated.\n * + `PENDING` - The status is set to `PENDING` after authentication but before completing the app's integration for this configuration.\n * + `READY` - Integration for this configuration is completed and the business is ready to activate the integration.\n * + `ERROR` - The integration for this configuration did not complete. An error occurred.\n */\n status?: ConfigurationStatus;\n }\n enum ConfigurationStatus {\n UNKNOWN = \"UNKNOWN\",\n NOT_STARTED = \"NOT_STARTED\",\n PENDING = \"PENDING\",\n READY = \"READY\",\n ERROR = \"ERROR\"\n }\n interface SyncCatalogRequest {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n }\n interface SyncCatalogResponse {\n }\n interface CatalogSyncFailureData {\n errors?: CatalogSyncError[];\n }\n interface CatalogSyncError {\n /**\n * Error code.\n * + `NONE` - No error code available.\n * + `OTHER` - Error doesn't resemble the existing synchronization errors.\n * + `SYSTEM_ERROR` - A system error occurred during synchronization.\n * + `ACCOUNT_NOT_FOUND` - Synchronization failed because the corresponding account with the POS system could not be found.\n * + `ACCOUNT_NOT_AUTHORIZED` - Synchronization failed because the corresponding account with the POS system could was not authorized.\n * + `LOCATION_NOT_FOUND` - Synchronization failed because the corresponding location with the POS system could not be found.\n * + `ACCOUNT_NOT_CONNECTED` - Synchronization failed because the corresponding account with the POS system was not connected successfully.\n * + `ACCOUNT_CONFIGURATION` - Synchronization failed because of a configuration error.\n * + `OVERLOADED_MENU` - Synchronization failed because storage limit was reached.\n */\n code?: Code;\n /** Error message. */\n message?: string;\n /** Error parameters. */\n params?: Record;\n }\n enum Code {\n NONE = \"NONE\",\n OTHER = \"OTHER\",\n SYSTEM_ERROR = \"SYSTEM_ERROR\",\n ACCOUNT_NOT_FOUND = \"ACCOUNT_NOT_FOUND\",\n ACCOUNT_NOT_AUTHORIZED = \"ACCOUNT_NOT_AUTHORIZED\",\n LOCATION_NOT_FOUND = \"LOCATION_NOT_FOUND\",\n ACCOUNT_NOT_CONNECTED = \"ACCOUNT_NOT_CONNECTED\",\n ACCOUNT_CONFIGURATION = \"ACCOUNT_CONFIGURATION\",\n OVERLOADED_MENU = \"OVERLOADED_MENU\"\n }\n interface GetCatalogSyncStatusRequest {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n }\n interface GetCatalogSyncStatusResponse extends GetCatalogSyncStatusResponseStatusModeOneOf {\n /** Additional information available if the catalog (menu) synchronization is in progress. */\n inProgress?: SyncInProgress;\n /** Additional information available if the catalog (menu) synchronization has completed successfully. */\n synced?: SyncSynced;\n /** Additional information available if the catalog (menu) synchronization ended with failure. */\n failed?: SyncFailed;\n /**\n * Status of the catalog (menu) synchronization.\n * + `PENDING` - Synchronization did not yet start.\n * + `IN_PROGRESS` - Synchronization has started.\n * + `SYNCED` - Synchronization completed successfully.\n * + `ERROR` - Synchronization ended with failure.\n */\n status?: Status;\n }\n /** @oneof */\n interface GetCatalogSyncStatusResponseStatusModeOneOf {\n /** Additional information available if the catalog (menu) synchronization is in progress. */\n inProgress?: SyncInProgress;\n /** Additional information available if the catalog (menu) synchronization has completed successfully. */\n synced?: SyncSynced;\n /** Additional information available if the catalog (menu) synchronization ended with failure. */\n failed?: SyncFailed;\n }\n enum Status {\n /** UNKNOWN STATUS. */\n UNKNOWN = \"UNKNOWN\",\n /** Sync didn't started yet. */\n PENDING = \"PENDING\",\n /** Sync is in progress. */\n IN_PROGRESS = \"IN_PROGRESS\",\n /** Sync completed successfully. */\n SYNCED = \"SYNCED\",\n /** Sync completed with failure. */\n FAILED = \"FAILED\"\n }\n interface SyncInProgress {\n /** Number of seconds that have elapsed since the catalog (menu) synchronization process started. */\n elapsedSeconds?: number | null;\n }\n interface SyncSynced {\n /** Date and time of the latest catalog (menu) synchronization process. */\n lastSyncDate?: Date;\n }\n interface SyncFailed {\n /** Date and time of the latest sync process. */\n lastSyncDate?: Date;\n /** Date and time of the latest successfully sync process. */\n lastSuccessfullySyncDate?: Date;\n /** Failure reason. */\n reason?: string;\n /**\n * Error code.\n * + `NONE` - No error code available.\n * + `OTHER` - Error doesn't resemble the existing synchronization errors.\n * + `SYSTEM_ERROR` - A system error occurred during synchronization.\n * + `ACCOUNT_NOT_FOUND` - Synchronization failed because the corresponding account with the POS system could not be found.\n * + `ACCOUNT_NOT_AUTHORIZED` - Synchronization failed because the corresponding account with the POS system could was not authorized.\n * + `LOCATION_NOT_FOUND` - Synchronization failed because the corresponding location with the POS system could not be found.\n * + `ACCOUNT_NOT_CONNECTED` - Synchronization failed because the corresponding account with the POS system was not connected successfully.\n * + `ACCOUNT_CONFIGURATION` - Synchronization failed because of a configuration error.\n */\n code?: SyncFailedCode;\n /** Error parameters. */\n params?: Record;\n }\n enum SyncFailedCode {\n NONE = \"NONE\",\n OTHER = \"OTHER\",\n SYSTEM_ERROR = \"SYSTEM_ERROR\",\n ACCOUNT_NOT_FOUND = \"ACCOUNT_NOT_FOUND\",\n ACCOUNT_NOT_AUTHORIZED = \"ACCOUNT_NOT_AUTHORIZED\",\n LOCATION_NOT_FOUND = \"LOCATION_NOT_FOUND\",\n ACCOUNT_NOT_CONNECTED = \"ACCOUNT_NOT_CONNECTED\",\n ACCOUNT_CONFIGURATION = \"ACCOUNT_CONFIGURATION\",\n OVERLOADED_MENU = \"OVERLOADED_MENU\"\n }\n interface GetCatalogSyncStatusFailureData {\n errors?: CatalogSyncStatusError[];\n }\n interface CatalogSyncStatusError {\n /**\n * Error code.\n * + `NONE` - No error code available.\n * + `OTHER` - Error doesn't resemble the existing synchronization errors.\n * + `SYSTEM_ERROR` - A system error occurred during synchronization.\n * + `ACCOUNT_NOT_FOUND` - Synchronization failed because the corresponding account with the POS system could not be found.\n * + `ACCOUNT_NOT_AUTHORIZED` - Synchronization failed because the corresponding account with the POS system could was not authorized.\n * + `LOCATION_NOT_FOUND` - Synchronization failed because the corresponding location with the POS system could not be found.\n * + `ACCOUNT_NOT_CONNECTED` - Synchronization failed because the corresponding account with the POS system was not connected successfully.\n * + `ACCOUNT_CONFIGURATION` - Synchronization failed because of a configuration error.\n * + `OVERLOADED_MENU` - Synchronization failed because storage limit was reached.\n */\n code?: CatalogSyncStatusErrorCode;\n /** Error message. */\n message?: string;\n /** Error parameters. */\n params?: Record;\n }\n enum CatalogSyncStatusErrorCode {\n NONE = \"NONE\",\n OTHER = \"OTHER\",\n SYSTEM_ERROR = \"SYSTEM_ERROR\",\n ACCOUNT_NOT_FOUND = \"ACCOUNT_NOT_FOUND\",\n ACCOUNT_NOT_AUTHORIZED = \"ACCOUNT_NOT_AUTHORIZED\",\n LOCATION_NOT_FOUND = \"LOCATION_NOT_FOUND\",\n ACCOUNT_NOT_CONNECTED = \"ACCOUNT_NOT_CONNECTED\",\n ACCOUNT_CONFIGURATION = \"ACCOUNT_CONFIGURATION\",\n OVERLOADED_MENU = \"OVERLOADED_MENU\"\n }\n interface CreateOrderRequest {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n /** Details of the order being created on the Wix site. */\n order?: WixOrder;\n /** Whether the order is being paid by the same payment gateway as the POS. */\n paidByPosGateway?: boolean;\n }\n /** Details of the order being created on the Wix site. */\n interface WixOrder {\n /**\n * Order ID.\n * @readonly\n */\n _id?: string;\n /** Currency of the order. */\n currency?: string | null;\n /** Dishes and options included in the order. */\n lineItems?: LineItem[];\n /** Discounts associated with the order. */\n discounts?: Discount[];\n /** Order fulfillment information. */\n fulfillment?: Fulfillment;\n /** Order payment information. */\n payments?: Payment[];\n /** Customer information. */\n customer?: Customer;\n /** Order totals. */\n totals?: Totals;\n /** Order comment. */\n comment?: string | null;\n /** Amount saved by redeeming a Wix Loyalty reward. */\n loyaltyInfo?: LoyaltyInfo;\n }\n interface LineItem {\n /** Line item quantity. */\n quantity?: number;\n /** Line item price. */\n price?: string;\n /** Comment about the line item added by the customer. */\n comment?: string | null;\n /** List of all dish options available for the line item. */\n dishOptions?: LineItemOption[];\n /** References to the line item’s origin catalog. */\n catalogReference?: CatalogReference;\n }\n interface LineItemOption {\n /** Line item option name. */\n name?: string | null;\n /** List of all dish options selected by the customer. */\n selectedChoices?: LineItem[];\n /** Minimum number of dish options the customer is required to choose. */\n minChoices?: number | null;\n /** Maximum number of dish options the customer is allowed to choose. */\n maxChoices?: number | null;\n /** Dish option type. */\n type?: DisplayType;\n /** List of all available choices for the dish option. */\n availableChoices?: LineItemOptionItem[];\n /** List of dish option IDs selected by default. */\n defaultChoices?: string[] | null;\n }\n enum DisplayType {\n /** DisplayType, due to an error */\n UNSPECIFIED_DISPLAY_TYPE = \"UNSPECIFIED_DISPLAY_TYPE\",\n /** Single choice selection */\n SELECTION = \"SELECTION\",\n /** Multiple choices selection */\n EXTRAS = \"EXTRAS\",\n /** Allow choices removal */\n DESELECTION = \"DESELECTION\"\n }\n interface LineItemOptionItem {\n /** Line item ID as defined in the catalog. */\n itemId?: string | null;\n /** Line item price. */\n price?: string | null;\n /** Line item name. */\n name?: string | null;\n }\n interface CatalogReference {\n /** Line item ID as defined in the catalog. */\n catalogItemId?: string;\n /**\n * Line item name as defined in the catalog.\n * @readonly\n */\n catalogItemName?: string | null;\n /**\n * Item description as defined in the catalog.\n * @readonly\n */\n catalogItemDescription?: string | null;\n /**\n * Item media url as defined in the catalog.\n * @readonly\n */\n catalogItemMedia?: string | null;\n }\n interface Discount {\n /** Discount ID as defined in the catalog. */\n catalogDiscountId?: string;\n /** Amount saved. */\n appliedAmount?: string;\n /** Discount type. */\n catalogDiscountType?: DiscountType;\n /** Discount name as defined in the catalog. */\n catalogDiscountName?: string;\n /**\n * Discount description as defined in the catalog.\n *\n * Max: 1,000 characters\n * @readonly\n */\n catalogDiscountDescription?: string;\n }\n enum DiscountType {\n UNSPECIFIED_TYPE = \"UNSPECIFIED_TYPE\",\n OFF_ITEM = \"OFF_ITEM\",\n OFF_ORDER = \"OFF_ORDER\",\n OFF_ORDER_MANAGER_DISCOUNT = \"OFF_ORDER_MANAGER_DISCOUNT\"\n }\n interface Fulfillment extends FulfillmentDetailsOneOf {\n /** Delivery details. */\n deliveryDetails?: DeliveryDetails;\n /** Pickup details. */\n pickupDetails?: PickupDetails;\n /** Dine-in details */\n dineInDetails?: DineInDetails;\n /** Fulfillment type. */\n type?: Type;\n /** Latest delivery time promised by the restaurant. */\n promisedTime?: Date;\n /** Whether the order should be fulfilled as soon as possible. Defaults to `true`. */\n asap?: boolean | null;\n /**\n * The time it takes to prepare and deliver the order in minutes\n * @internal\n */\n preparationTime?: number | null;\n }\n /** @oneof */\n interface FulfillmentDetailsOneOf {\n /** Delivery details. */\n deliveryDetails?: DeliveryDetails;\n /** Pickup details. */\n pickupDetails?: PickupDetails;\n /** Dine-in details */\n dineInDetails?: DineInDetails;\n }\n enum Type {\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 }\n interface DeliveryDetails extends DeliveryDetailsProviderOneOf {\n /** Delivery through the restaurant. */\n restaurant?: Restaurant;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider;\n /** Delivery address. */\n address?: DeliveryAddress;\n /** Information about the delivery pickup. */\n pickupInfo?: PickupInfo;\n /**\n * Information about the delivery drop-off.\n * @internal\n */\n dropOffInfo?: DropOffInfo;\n }\n /** @oneof */\n interface DeliveryDetailsProviderOneOf {\n /** Delivery through the restaurant. */\n restaurant?: Restaurant;\n /** Delivery through an external provider. */\n externalProvider?: ExternalProvider;\n }\n interface DeliveryAddress {\n /** Formatted delivery address. */\n formatted?: string | null;\n /** Country. */\n country?: string | null;\n /** City name. */\n city?: string | null;\n /** Street name. */\n street?: string | null;\n /** Street number. */\n streetNumber?: string | null;\n /** Apartment number. */\n apt?: string | null;\n /** Floor. */\n floor?: string | null;\n /** Entrance. */\n entrance?: string | null;\n /** ZIP/postal code. */\n zipCode?: string | null;\n /** Country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */\n countryCode?: string | null;\n /** Special delivery instructions upon arrival to the address. */\n onArrival?: OnArrival;\n /** Whether an approximate address is used. Defaults to `false`. In case of `false` a house number is required. */\n approximate?: boolean | null;\n /** Delivery Instructions added by the customer. */\n comment?: string | null;\n /** Geo coordinates of the address. */\n location?: DeliveryAddressLocation;\n /** Address Line 2. */\n addressLine2?: 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 }\n enum OnArrival {\n /** Missing type due to an error */\n UNSPECIFIED_ON_ARRIVAL_TYPE = \"UNSPECIFIED_ON_ARRIVAL_TYPE\",\n /** Buzz the door */\n BUZZ_DOOR = \"BUZZ_DOOR\",\n /** Phone me */\n CALL_ME = \"CALL_ME\"\n }\n interface DeliveryAddressLocation {\n /** Address latitude. */\n latitude?: number | null;\n /** Address longitude. */\n longitude?: number | null;\n }\n interface Restaurant {\n /** Delivery fee. */\n fee?: string | null;\n }\n interface ExternalProvider {\n /** ID of the external delivery provider. */\n _id?: string;\n /**\n * Name of the external delivery provider.\n * @readonly\n */\n name?: string;\n /**\n * Delivery ID.\n * @internal\n */\n deliveryId?: string | null;\n /**\n * Estimate ID.\n * @internal\n */\n estimateId?: string | null;\n /** Delivery fee charged to the customer. */\n customerFee?: string | null;\n /**\n * Fee paid by the restaurant to the external delivery provider.\n * @readonly\n */\n commission?: string | null;\n /** Order pickup time. */\n pickupTime?: Date;\n /** Order drop off time. */\n dropOffTime?: Date;\n /**\n * Icon of the external delivery provider.\n * @internal\n */\n iconUrl?: string | null;\n }\n interface PickupInfo {\n /** When a delivery is ready to be picked up. This is the start time of the pickup window. */\n windowStartTime?: Date;\n /** When a delivery must be picked up by. This is the end time of the pickup window. */\n windowEndTime?: Date;\n }\n interface DropOffInfo {\n /** Whether the order is delivered contactless. */\n contactless?: boolean;\n /**\n * When a delivery will be drop off. This is the start time of the drop off window.\n * @internal\n */\n windowStartTime?: Date;\n /**\n * When a delivery will be drop off. This is the end time of the drop off window.\n * @internal\n */\n windowEndTime?: Date;\n }\n interface PickupDetails {\n /** Pickup fee charged to the customer. */\n fee?: string | null;\n /** Curbside pickup method */\n curbside?: Curbside;\n }\n interface Curbside {\n /** Additional information for curbside pickup. */\n info?: string;\n }\n interface DineInDetails {\n /** Label of dine-in information added by the restaurant, e.g. `table` or `booth`. */\n label?: string;\n /** Value of dine-in information added by the restaurant, e.g. `#6`. */\n value?: string;\n }\n interface Payment {\n /** Payment type. */\n type?: PaymentType;\n /** Amount paid using this payment type. Only differs from total amount paid in case of split payments. */\n amount?: string | null;\n /** Payment method. */\n method?: string | null;\n /**\n * Transaction ID.\n * See [Cashier API](https://dev.wix.com/api/rest/wix-cashier/payments/transaction) for more details.\n */\n providerTransactionId?: string | null;\n }\n enum PaymentType {\n /** PaymentType, due to an error */\n UNSPECIFIED_PAYMENT_TYPE = \"UNSPECIFIED_PAYMENT_TYPE\",\n /** Cash */\n CASH = \"CASH\",\n /** credit */\n CREDIT = \"CREDIT\",\n /** Delivery club */\n DELIVERY_CLUB = \"DELIVERY_CLUB\",\n /** Delivery com */\n DELIVERY_COM = \"DELIVERY_COM\",\n /** Bitpay */\n BITPAY = \"BITPAY\",\n /** Cellarix */\n CELLARIX = \"CELLARIX\",\n /** Bits of gold */\n BITSOFGOLD = \"BITSOFGOLD\",\n /** Multi pass */\n MULTIPASS = \"MULTIPASS\",\n /** Tenbis */\n TENBIS = \"TENBIS\",\n /** Paypal */\n PAYPAL = \"PAYPAL\",\n /** Mysodexo */\n MYSODEXO = \"MYSODEXO\",\n /** Wix Payments */\n WIX_PAYMENTS = \"WIX_PAYMENTS\"\n }\n /** Customer information. */\n interface Customer extends CustomerIdOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n /** First name. */\n firstName?: string;\n /** Last name. */\n lastName?: string;\n /** Phone number. */\n phone?: string | null;\n /** Email address. */\n email?: string;\n /**\n * Customer's contact ID.\n * See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.\n */\n contactId?: string | null;\n }\n /** @oneof */\n interface CustomerIdOneOf {\n /** Member ID. */\n memberId?: string | null;\n /** Visitor ID. */\n visitorId?: string | null;\n }\n interface Totals {\n /** Order subtotal. Calculated by substracting delivery fee, tax and discount from order total. */\n subtotal?: string;\n /** Total order price. */\n total?: string;\n /** Total delivery fees charged to the customer. */\n delivery?: string | null;\n /** Total tax. */\n tax?: string | null;\n /** Total discount amount. */\n discount?: string | null;\n /** Total amount saved through the Wix Loyalty program. */\n loyaltySavings?: string | null;\n /**\n * Total number of line items.\n * @readonly\n */\n quantity?: number;\n /** Total tip. */\n tip?: string | null;\n /**\n * Information about the order's service fees.\n * @internal\n */\n serviceFees?: ServiceFee[];\n }\n interface ServiceFee {\n /** The service fee's unique id. */\n ruleId?: string;\n /**\n * The service fee's name.\n * @readonly\n */\n name?: string;\n /** The service fee's fee as Money. */\n fee?: Money;\n /** The service fee's tax as Money. */\n tax?: Money;\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 LoyaltyInfo {\n /** Amount saved by redeeming a Wix Loyalty reward. */\n appliedAmount?: string | null;\n }\n interface CreateOrderResponse {\n /** Unique identifier of the order with the POS system. */\n posOrderId?: string;\n /** Unique identifier of the location for the order in the POS system. */\n posLocationId?: string;\n }\n interface CreateOrderFailureData {\n /** Error codes. */\n errors?: OrderError[];\n }\n interface OrderError {\n /**\n * Error code.\n * + `NONE` - No error code available.\n * + `OTHER` - Error doesn't resemble the existing synchronization errors.\n * + `SYSTEM_ERROR` - A system error occurred during synchronization.\n * + `ACCOUNT_NOT_FOUND` - Synchronization failed because the corresponding account with the POS system could not be found.\n * + `ACCOUNT_NOT_AUTHORIZED` - Synchronization failed because the corresponding account with the POS system could was not authorized.\n * + `LOCATION_NOT_FOUND` - Synchronization failed because the corresponding location with the POS system could not be found.\n * + `ACCOUNT_NOT_CONNECTED` - Synchronization failed because the corresponding account with the POS system was not connected successfully.\n * + `ACCOUNT_CONFIGURATION` - Synchronization failed because of a configuration error.\n * + `OVERLOADED_MENU` - Synchronization failed because storage limit was reached.\n */\n code?: OrderErrorCode;\n /** Error message. */\n message?: string;\n /** Error parameters. */\n params?: Record;\n }\n enum OrderErrorCode {\n NONE = \"NONE\",\n OTHER = \"OTHER\",\n SYSTEM_ERROR = \"SYSTEM_ERROR\",\n ACCOUNT_NOT_FOUND = \"ACCOUNT_NOT_FOUND\",\n ACCOUNT_NOT_AUTHORIZED = \"ACCOUNT_NOT_AUTHORIZED\",\n LOCATION_NOT_FOUND = \"LOCATION_NOT_FOUND\",\n ACCOUNT_NOT_CONNECTED = \"ACCOUNT_NOT_CONNECTED\",\n ACCOUNT_CONFIGURATION = \"ACCOUNT_CONFIGURATION\",\n PROMO_NOT_RECOGNIZED = \"PROMO_NOT_RECOGNIZED\",\n PROMO_USER_INELIGIBLE = \"PROMO_USER_INELIGIBLE\",\n PROMO_ALREADY_USED = \"PROMO_ALREADY_USED\",\n PROMO_EXPIRED = \"PROMO_EXPIRED\",\n DISCOUNT = \"DISCOUNT\",\n LOYALTY = \"LOYALTY\",\n OUT_OF_SERVICE_AREA = \"OUT_OF_SERVICE_AREA\",\n AVAILABILITY_CHANGED = \"AVAILABILITY_CHANGED\",\n PRICE_CHANGED = \"PRICE_CHANGED\",\n NO_CAPACITY = \"NO_CAPACITY\",\n CLOSED = \"CLOSED\",\n REQUIREMENTS_NOT_MET = \"REQUIREMENTS_NOT_MET\",\n ORDER_TOTAL = \"ORDER_TOTAL\",\n ORDER_ITEM = \"ORDER_ITEM\",\n ORDER_REJECTED = \"ORDER_REJECTED\",\n PAYMENT_FAILED = \"PAYMENT_FAILED\",\n CUSTOMER_PHONE_MISSING = \"CUSTOMER_PHONE_MISSING\",\n CUSTOMER_EMAIL_MISSING = \"CUSTOMER_EMAIL_MISSING\",\n CUSTOMER_BLOCKED = \"CUSTOMER_BLOCKED\"\n }\n interface ValidateOrderRequest {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n /** Details of the order created on the Wix site. */\n order?: WixOrder;\n }\n interface ValidateOrderResponse {\n /** Status of the order in the POS system. */\n posOrderStatus?: string;\n }\n /** Restaurants POS component */\n interface RestaurantsPOSComponentData {\n /**\n * URL for the Restaurants POS registration web page.\n * The App Instance and Account Id query parameters are attached to the registration URL\n * so you can identify your account when accessing the vendor API. [Learn more...](https://devforum.wix.com/en/article/app-instance)\n */\n registrationUrl?: string;\n /** Configuration parameters defining the behavior of catalog (menu) synchronization. */\n catalogSyncConfiguration?: CatalogSyncConfiguration;\n }\n interface CatalogSyncConfiguration {\n /** Whether Menu/Section/Dish availability will be updated on the POS side or on Wix Menus. */\n entityAvailabilityUpdated?: Default;\n /** Whether fulfillment method will be defined on the POS side or on Wix menus. */\n fulfillmentMethodsDefinition?: Default;\n /** Whether Dish images will be updated on the POS side or on Wix Menus. */\n dishImagesUpdated?: Default;\n /** Whether sorting (Menu/Category/Dish/Options) will be done on the POS side (API order) or on Wix Menus. */\n entitySortingControl?: Default;\n /** Whether Labels will be updated on the POS side or on Wix Menus. */\n dishLabelsUpdated?: Default;\n /** whether min/max amount of choices to be set on the POS side or on Wix Menus. */\n dishOptionsMinMaxUpdated?: Default;\n /** Whether Dish in/out of stock will be updated on Wix Menus or retrieved from POS. */\n dishInStockUpdated?: Default;\n }\n enum Default {\n WIX = \"WIX\",\n POS = \"POS\"\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 GetConfigurationStatusOptions {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n }\n interface SyncCatalogOptions {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n }\n interface GetCatalogSyncStatusOptions {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n }\n interface CreateOrderOptions {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n /** Details of the order being created on the Wix site. */\n order?: WixOrder;\n /** Whether the order is being paid by the same payment gateway as the POS. */\n paidByPosGateway?: boolean;\n }\n interface ValidateOrderOptions {\n /** Merchant's account ID with the POS system. */\n accountId: string;\n /** Unique identifier of the merchant's Wix location configuration. */\n configurationId: string;\n /** Details of the order created on the Wix site. */\n order?: WixOrder;\n }\n \n function catalogSyncFailure(data: CatalogSyncFailureData): BusinessError;\n \n const syncCatalogSpiErrors_d_catalogSyncFailure: typeof catalogSyncFailure;\n namespace syncCatalogSpiErrors_d {\n export {\n syncCatalogSpiErrors_d_catalogSyncFailure as catalogSyncFailure,\n };\n }\n \n function getCatalogSyncStatusFailure(data: GetCatalogSyncStatusFailureData): BusinessError;\n \n const getCatalogSyncStatusSpiErrors_d_getCatalogSyncStatusFailure: typeof getCatalogSyncStatusFailure;\n namespace getCatalogSyncStatusSpiErrors_d {\n export {\n getCatalogSyncStatusSpiErrors_d_getCatalogSyncStatusFailure as getCatalogSyncStatusFailure,\n };\n }\n \n function createOrderFailure(data: CreateOrderFailureData): BusinessError;\n \n const createOrderSpiErrors_d_createOrderFailure: typeof createOrderFailure;\n namespace createOrderSpiErrors_d {\n export {\n createOrderSpiErrors_d_createOrderFailure as createOrderFailure,\n };\n }\n \n function validateOrderFailure(data: CreateOrderFailureData): BusinessError;\n \n const validateOrderSpiErrors_d_validateOrderFailure: typeof validateOrderFailure;\n namespace validateOrderSpiErrors_d {\n export {\n validateOrderSpiErrors_d_validateOrderFailure as validateOrderFailure,\n };\n }\n \n namespace spiErrorHelpers_d {\n export {\n syncCatalogSpiErrors_d as syncCatalog,\n getCatalogSyncStatusSpiErrors_d as getCatalogSyncStatus,\n createOrderSpiErrors_d as createOrder,\n validateOrderSpiErrors_d as validateOrder,\n };\n }\n \n export { BusinessError, CatalogReference, CatalogSyncConfiguration, CatalogSyncError, CatalogSyncFailureData, CatalogSyncStatusError, CatalogSyncStatusErrorCode, Code, ConfigurationStatus, Context, CreateOrderFailureData, CreateOrderOptions, CreateOrderRequest, CreateOrderResponse, Curbside, Customer, CustomerIdOneOf, Default, DeliveryAddress, DeliveryAddressLocation, DeliveryDetails, DeliveryDetailsProviderOneOf, DineInDetails, Discount, DiscountType, DisplayType, DropOffInfo, ExternalProvider, Fulfillment, FulfillmentDetailsOneOf, GetCatalogSyncStatusFailureData, GetCatalogSyncStatusOptions, GetCatalogSyncStatusRequest, GetCatalogSyncStatusResponse, GetCatalogSyncStatusResponseStatusModeOneOf, GetConfigurationStatusOptions, GetConfigurationStatusRequest, GetConfigurationStatusResponse, IdentificationData, IdentificationDataIdOneOf, IdentityType, LineItem, LineItemOption, LineItemOptionItem, ListAccountIdsRequest, ListAccountIdsResponse, LoyaltyInfo, Money, OnArrival, OrderError, OrderErrorCode, Payment, PaymentType, PickupDetails, PickupInfo, Restaurant, RestaurantsPOSComponentData, ServiceFee, Status, SyncCatalogOptions, SyncCatalogRequest, SyncCatalogResponse, SyncFailed, SyncFailedCode, SyncInProgress, SyncSynced, Totals, Tpa, Type, ValidateOrderOptions, ValidateOrderRequest, ValidateOrderResponse, WixOrder, spiErrorHelpers_d as errorHelpers };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-media.v2.d.ts", "content": "declare module \"wix-media.v2\" {\n interface EnterpriseCategory {\n /**\n * Id of the category\n * @readonly\n */\n _id?: string;\n /** The display name that will be shown for the item */\n displayName?: string | null;\n /** Id of the parent category, will default to the account master category */\n parentCategoryId?: string | null;\n /** Sort order number of the category, will determine the order of the category with other categories under the same parent category */\n sortOrder?: number | null;\n /** Publish status of the category */\n publishStatus?: PublishStatus$1;\n /**\n * Date and time the category was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the category was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * the media type of the category - should be ignored - will add mixed\n * @internal\n */\n mediaType?: MediaType$3;\n }\n enum PublishStatus$1 {\n UNDEFINED = \"UNDEFINED\",\n UNPUBLISHED = \"UNPUBLISHED\",\n PUBLISHED = \"PUBLISHED\",\n WIX_ONLY = \"WIX_ONLY\"\n }\n enum MediaType$3 {\n MIXED = \"MIXED\",\n IMAGE = \"IMAGE\",\n VIDEO = \"VIDEO\",\n AUDIO = \"AUDIO\",\n DOCUMENT = \"DOCUMENT\",\n VECTOR = \"VECTOR\",\n ARCHIVE = \"ARCHIVE\",\n MODEL3D = \"MODEL3D\"\n }\n interface CreateCategoryRequest {\n /** The category object that will be created */\n category: EnterpriseCategory;\n }\n interface CreateCategoryResponse {\n /** A list of items matching the request */\n category?: EnterpriseCategory;\n }\n interface DeleteCategoryRequest {\n /** Category id */\n categoryId: string;\n }\n interface DeleteCategoryResponse {\n }\n interface UpdateCategoryRequest {\n /** The category object that will be created */\n category: EnterpriseCategory;\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateCategoryResponse {\n /** The updated category */\n category?: EnterpriseCategory;\n }\n interface GetCategoryRequest {\n /** Category id */\n categoryId: string;\n /** number of sub category levels */\n levels?: number | null;\n /** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */\n publishStatus?: PublishStatus$1;\n }\n interface GetCategoryResponse {\n /** The category details */\n category?: EnterpriseCategoryTree;\n }\n interface EnterpriseCategoryTree {\n /** Category information */\n category?: EnterpriseCategory;\n /** Information about the sub categories */\n subCategories?: EnterpriseCategoryTree[];\n }\n interface EnterpriseOnboardingRequest {\n /** The account id of the organization - will be used as the organization category id */\n accountId: string;\n /** The account name of the organization - will be used as the organization category name */\n accountName?: string;\n }\n interface EnterpriseOnboardingResponse {\n /** The enterprise category */\n category?: EnterpriseCategory;\n }\n interface LinkItemsToCategoryRequest {\n /** The category to link to */\n categoryId: string;\n /** The item ids that will be added to the category */\n itemIds?: string[];\n }\n interface LinkItemsToCategoryResponse {\n }\n interface UnlinkItemsFromCategoryRequest {\n /** The category to link to */\n categoryId: string;\n /** The item ids that will be added to the category */\n itemIds?: string[];\n }\n interface UnlinkItemsFromCategoryResponse {\n }\n interface GetMediaManagerCategoriesRequest {\n }\n interface GetMediaManagerCategoriesResponse {\n /** The category details */\n category?: EnterpriseCategoryTree;\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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 * Fetch a list of random media from different providers, using site information to customize results when available\n * @param category - The category object that will be created\n * @public\n * @documentationMaturity preview\n * @requiredField category\n * @requiredField category.displayName\n * @permissionId MEDIA.ENTERPRISE_MEDIA_CATEGORIES_CREATE\n * @adminMethod\n * @returns A list of items matching the request\n */\n function createCategory(category: EnterpriseCategory): Promise;\n /**\n * Delete a category including all its subcategories - but not the items\n * @param categoryId - Category id\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_CATEGORIES_DELETE\n * @adminMethod\n */\n function deleteCategory(categoryId: string): Promise;\n /**\n * Update category details\n * @param _id - Id of the category\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField category\n * @permissionId MEDIA.ENTERPRISE_MEDIA_CATEGORIES_UPDATE\n * @adminMethod\n * @returns The updated category\n */\n function updateCategory(_id: string, category: UpdateCategory, options?: UpdateCategoryOptions): Promise;\n interface UpdateCategory {\n /**\n * Id of the category\n * @readonly\n */\n _id?: string;\n /** The display name that will be shown for the item */\n displayName?: string | null;\n /** Id of the parent category, will default to the account master category */\n parentCategoryId?: string | null;\n /** Sort order number of the category, will determine the order of the category with other categories under the same parent category */\n sortOrder?: number | null;\n /** Publish status of the category */\n publishStatus?: PublishStatus$1;\n /**\n * Date and time the category was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the category was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * the media type of the category - should be ignored - will add mixed\n * @internal\n */\n mediaType?: MediaType$3;\n }\n interface UpdateCategoryOptions {\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Get information about a specific category\n * @param categoryId - Category id\n * @public\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_CATEGORIES_READ\n * @adminMethod\n * @returns The category details\n */\n function getCategory(categoryId: string, options?: GetCategoryOptions): Promise;\n interface GetCategoryOptions {\n /** number of sub category levels */\n levels?: number | null;\n /** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */\n publishStatus?: PublishStatus$1;\n }\n /**\n * Create the enterprise category under \"enterprise-media\" main category\n * the caller identity must be have the same accountId of the request\n * @param accountId - The account id of the organization - will be used as the organization category id\n * @public\n * @documentationMaturity preview\n * @requiredField accountId\n * @adminMethod\n */\n function enterpriseOnboarding(accountId: string, options?: EnterpriseOnboardingOptions): Promise;\n interface EnterpriseOnboardingOptions {\n /** The account name of the organization - will be used as the organization category name */\n accountName?: string;\n }\n /**\n * link multiple items to the same category\n * @param categoryId - The category to link to\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_CATEGORIES_UPDATE_ITEMS\n * @adminMethod\n */\n function linkItemsToCategory(categoryId: string, options?: LinkItemsToCategoryOptions): Promise;\n interface LinkItemsToCategoryOptions {\n /** The item ids that will be added to the category */\n itemIds?: string[];\n }\n /**\n * unlink multiple items from a category\n * @param categoryId - The category to link to\n * @internal\n * @documentationMaturity preview\n * @requiredField categoryId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_CATEGORIES_UPDATE_ITEMS\n * @adminMethod\n */\n function unlinkItemsFromCategory(categoryId: string, options?: UnlinkItemsFromCategoryOptions): Promise;\n interface UnlinkItemsFromCategoryOptions {\n /** The item ids that will be added to the category */\n itemIds?: string[];\n }\n /**\n * Get the account category tree details\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function getMediaManagerCategories(): Promise;\n \n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseCategory = EnterpriseCategory;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_CreateCategoryRequest = CreateCategoryRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_CreateCategoryResponse = CreateCategoryResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_DeleteCategoryRequest = DeleteCategoryRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_DeleteCategoryResponse = DeleteCategoryResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategoryRequest = UpdateCategoryRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategoryResponse = UpdateCategoryResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetCategoryRequest = GetCategoryRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetCategoryResponse = GetCategoryResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseCategoryTree = EnterpriseCategoryTree;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseOnboardingRequest = EnterpriseOnboardingRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseOnboardingResponse = EnterpriseOnboardingResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_LinkItemsToCategoryRequest = LinkItemsToCategoryRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_LinkItemsToCategoryResponse = LinkItemsToCategoryResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UnlinkItemsFromCategoryRequest = UnlinkItemsFromCategoryRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UnlinkItemsFromCategoryResponse = UnlinkItemsFromCategoryResponse;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetMediaManagerCategoriesRequest = GetMediaManagerCategoriesRequest;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetMediaManagerCategoriesResponse = GetMediaManagerCategoriesResponse;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_createCategory: typeof createCategory;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_deleteCategory: typeof deleteCategory;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_updateCategory: typeof updateCategory;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategory = UpdateCategory;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategoryOptions = UpdateCategoryOptions;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_getCategory: typeof getCategory;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetCategoryOptions = GetCategoryOptions;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_enterpriseOnboarding: typeof enterpriseOnboarding;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseOnboardingOptions = EnterpriseOnboardingOptions;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_linkItemsToCategory: typeof linkItemsToCategory;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_LinkItemsToCategoryOptions = LinkItemsToCategoryOptions;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_unlinkItemsFromCategory: typeof unlinkItemsFromCategory;\n type mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UnlinkItemsFromCategoryOptions = UnlinkItemsFromCategoryOptions;\n const mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_getMediaManagerCategories: typeof getMediaManagerCategories;\n namespace mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d {\n export {\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseCategory as EnterpriseCategory,\n PublishStatus$1 as PublishStatus,\n MediaType$3 as MediaType,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_CreateCategoryRequest as CreateCategoryRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_CreateCategoryResponse as CreateCategoryResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_DeleteCategoryRequest as DeleteCategoryRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_DeleteCategoryResponse as DeleteCategoryResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategoryRequest as UpdateCategoryRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategoryResponse as UpdateCategoryResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetCategoryRequest as GetCategoryRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetCategoryResponse as GetCategoryResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseCategoryTree as EnterpriseCategoryTree,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseOnboardingRequest as EnterpriseOnboardingRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseOnboardingResponse as EnterpriseOnboardingResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_LinkItemsToCategoryRequest as LinkItemsToCategoryRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_LinkItemsToCategoryResponse as LinkItemsToCategoryResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UnlinkItemsFromCategoryRequest as UnlinkItemsFromCategoryRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UnlinkItemsFromCategoryResponse as UnlinkItemsFromCategoryResponse,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetMediaManagerCategoriesRequest as GetMediaManagerCategoriesRequest,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetMediaManagerCategoriesResponse as GetMediaManagerCategoriesResponse,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_createCategory as createCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_deleteCategory as deleteCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_updateCategory as updateCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategory as UpdateCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UpdateCategoryOptions as UpdateCategoryOptions,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_getCategory as getCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_GetCategoryOptions as GetCategoryOptions,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_enterpriseOnboarding as enterpriseOnboarding,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_EnterpriseOnboardingOptions as EnterpriseOnboardingOptions,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_linkItemsToCategory as linkItemsToCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_LinkItemsToCategoryOptions as LinkItemsToCategoryOptions,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_unlinkItemsFromCategory as unlinkItemsFromCategory,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_UnlinkItemsFromCategoryOptions as UnlinkItemsFromCategoryOptions,\n mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d_getMediaManagerCategories as getMediaManagerCategories,\n };\n }\n \n /**\n * Duration for video fits better if there will be type specific media item.. however, is it ok to implement\n * an additional one of field called details?\n */\n interface EnterpriseMediaItem {\n /**\n * Id of the item in public media\n * @readonly\n */\n _id?: string;\n /**\n * Media type of the item\n * @readonly\n */\n mediaType?: MediaType$2;\n /**\n * Size of the uploaded file in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /** The item title, part of searchable fields */\n title?: string | null;\n /**\n * The aspect ratio of the item\n * An object containing urls for different views of the item\n * @readonly\n */\n assets?: ItemAssets;\n /** Tags describing the image, part of searchable fields */\n displayTags?: string[] | null;\n /** Tags for internal client use, part of searchable fields */\n internalTags?: string[] | null;\n /**\n * Tags for filtering items in the search\n * @readonly\n */\n systemTags?: string[] | null;\n /**\n * Category ids this item belongs to\n * @readonly\n */\n parentCategoryIds?: string[] | null;\n /** Status of the item */\n publishStatus?: PublishStatus;\n /**\n * Date and time the item was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the item was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * An internal id used with different wix media systems\n * @readonly\n */\n internalId?: string | null;\n }\n enum MediaType$2 {\n MIXED = \"MIXED\",\n IMAGE = \"IMAGE\",\n VIDEO = \"VIDEO\",\n AUDIO = \"AUDIO\",\n DOCUMENT = \"DOCUMENT\",\n VECTOR = \"VECTOR\",\n ARCHIVE = \"ARCHIVE\",\n MODEL3D = \"MODEL3D\"\n }\n interface ItemAssets extends ItemAssetsAssetsOneOf {\n /** Assets for image media type */\n image?: string;\n /** Assets for video media type */\n video?: string;\n /** Assets for vector media type */\n vector?: string;\n /** Assets for audio media type */\n audio?: string;\n /** Assets for document media type */\n document?: string;\n /** Information about the archive. */\n archive?: Archive$2;\n /** Information about the 3D Model. */\n model3d?: Model3D$2;\n }\n /** @oneof */\n interface ItemAssetsAssetsOneOf {\n /** Assets for image media type */\n image?: string;\n /** Assets for video media type */\n video?: string;\n /** Assets for vector media type */\n vector?: string;\n /** Assets for audio media type */\n audio?: string;\n /** Assets for document media type */\n document?: string;\n /** Information about the archive. */\n archive?: Archive$2;\n /** Information about the 3D Model. */\n model3d?: Model3D$2;\n }\n interface VideoResolution$2 {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\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' ]\n */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface Archive$2 {\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 | null;\n /** Archive size in bytes. */\n sizeInBytes?: string | null;\n /** Archive filename. */\n filename?: string | null;\n }\n interface Model3D$2 {\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 | null;\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 enum PublishStatus {\n UNDEFINED = \"UNDEFINED\",\n UNPUBLISHED = \"UNPUBLISHED\",\n PUBLISHED = \"PUBLISHED\",\n WIX_ONLY = \"WIX_ONLY\"\n }\n interface ItemCategoriesChanged {\n /** A list of the current item categories */\n itemCategoryIds?: string[] | null;\n /** A list of the categories that where unlinked from the item */\n unlinkedCategoryIds?: string[] | null;\n /** A list of the categories that where linked to the item */\n linkedCategoryIds?: string[] | null;\n /** The full updated item information */\n entity?: EnterpriseMediaItem;\n }\n interface ItemUploadCallbackRequest {\n /** The item id of the created item */\n itemId?: string;\n /** The callback passed to the upload endpoint */\n callbackToken?: string;\n }\n interface ItemUploadCallbackResponse {\n /** A message describing what happened on the endpoint */\n message?: string | null;\n }\n interface GenerateFileUploadUrlRequest$1 {\n /** The uploaded original file name including the extension */\n fileName?: string;\n /** The file mime-type - will be used to identify the type of media */\n contentType?: string;\n /** The file size in bytes */\n sizeInBytes?: number;\n /**\n * An optional list of categories to link the created item to\n * The item will be linked to the account category automatically\n */\n categoryIds?: string[] | null;\n }\n interface GenerateFileUploadUrlResponse$1 {\n /** The upload url to upload the file to */\n uploadUrl?: string;\n }\n interface ImportFileRequest$1 {\n /** The url to the file to be imported */\n url: string;\n /** The uploaded original file name including the extension - will be used as the initial display name */\n fileName?: string | null;\n /** The file mime-type - will be used to identify the type of media */\n contentType?: string | null;\n /** The file size in bytes */\n sizeInBytes?: number | null;\n /**\n * An optional list of categories to link the created item to\n * The item will be linked to the account category automatically\n */\n categoryIds?: string[] | null;\n /** The media type of the uploaded file */\n mediaType?: MediaType$2;\n /**\n * A unique identifier of the client that imported the file\n * This information will exist in the system_tags field prefixed by '_external_uploader:{uploader_system_tag}'\n */\n uploaderSystemTag?: string | null;\n /**\n * An additional container for external information\n * mostly used to pass identifying information of related entities in external services\n * This information will exist in the system_tags field prefixed by '_external_uploader_info:{uploader_info_system_tag}'\n */\n uploaderInfoSystemTag?: string | null;\n }\n interface ImportFileResponse$1 {\n /**\n * Partial item - without the assets\n * At this stage of implementation only the 'internal_id' will be filled\n * all other required values will be fake values\n */\n item?: EnterpriseMediaItem;\n }\n interface BulkImportFilesRequest$1 {\n /** Information about the files to import. */\n importFileRequests: ImportFileRequest$1[];\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 * Default: `true`\n */\n returnEntity?: boolean | null;\n /**\n * An optional list of categories to link all the items to\n * The item will be linked to the account category automatically\n */\n categoryIds?: string[] | null;\n }\n interface BulkImportFilesResponse$1 {\n /** Items created by bulk action. */\n results?: BulkImportFilesResult[];\n /** Bulk action metadata. */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkImportFilesResult {\n /** Item metadata. */\n itemMetadata?: ItemMetadata$1;\n /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */\n item?: EnterpriseMediaItem;\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 SearchItemsRequest {\n /** Items search query */\n query?: Search;\n }\n interface Search extends SearchPagingMethodOneOf {\n /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */\n paging?: Paging;\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$3[];\n /** free text to match in searchable fields */\n search?: SearchDetails;\n }\n /** @oneof */\n interface SearchPagingMethodOneOf {\n /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */\n paging?: Paging;\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 SearchDetails {\n /** search term or expression */\n expression?: string | null;\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 SearchItemsResponse {\n /** A list of items matching the request */\n items?: EnterpriseMediaItem[];\n /** Information about the search results. */\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 /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\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 * @internal\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 QueryItemsRequest {\n /** Items query */\n query?: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\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 QueryV2PagingMethodOneOf {\n /** Paging options to limit and skip the number of items. */\n paging?: Paging;\n }\n interface QueryItemsResponse {\n /** A list of items matching the request */\n items?: EnterpriseMediaItem[];\n /** Information for the next request. */\n pagingMetadata?: PagingMetadataV2$3;\n }\n interface UpdateItemRequest {\n /** The category object that will be created */\n item: EnterpriseMediaItem;\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateItemResponse {\n /** Updated item info */\n item?: EnterpriseMediaItem;\n }\n interface PublishStatusChanged {\n /** The new item status */\n publishStatus?: PublishStatus;\n /** The full updated item information */\n entity?: EnterpriseMediaItem;\n }\n interface BulkUpdateItemRequest {\n /** Requests to update individual item */\n updateItemRequests: UpdateItemRequest[];\n /** Should the response return the updated item */\n returnEntity?: boolean;\n }\n interface BulkUpdateItemResponse {\n /** Requests to update individual item */\n results?: BulkItemUpdateResult[];\n /** Metadata of the operation */\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkItemUpdateResult {\n /** updated item metadata */\n itemMetadata?: ItemMetadata$1;\n /** only returned if operation was successful and if returnEntity flag was on */\n item?: EnterpriseMediaItem;\n }\n interface GetItemRequest {\n /** Item id */\n itemId: string;\n }\n interface GetItemResponse {\n /** item info */\n item?: EnterpriseMediaItem;\n }\n interface LinkItemToCategoriesRequest {\n /** The item id */\n itemId: string;\n /** The category ids that the item will be linked to */\n categoryIds?: string[];\n }\n interface LinkItemToCategoriesResponse {\n /** The linked category ids */\n linkedCategoryIds?: string[] | null;\n }\n interface UnlinkItemFromCategoriesRequest {\n /** The item id */\n itemId: string;\n /** The category ids that the item will be unlinked from */\n categoryIds?: string[];\n }\n interface UnlinkItemFromCategoriesResponse {\n /** The unlinked category ids */\n unlinkedCategoryIds?: string[] | null;\n }\n interface OverwriteItemCategoriesRequest {\n /** The item id */\n itemId: string;\n /** The category ids the item will be linked to after this operation */\n categoryIds?: string[];\n }\n interface OverwriteItemCategoriesResponse {\n /** The linked category ids */\n linkedCategoryIds?: string[] | null;\n /** The unlinked category ids */\n unlinkedCategoryIds?: 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Internal API called by the public media backend, notify about a file that was created enterprise public media server\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function itemUploadCallback(options?: ItemUploadCallbackOptions): Promise;\n interface ItemUploadCallbackOptions {\n /** The item id of the created item */\n itemId?: string;\n /** The callback passed to the upload endpoint */\n callbackToken?: string;\n }\n /**\n * Generate an upload url that will make public media to call the enterprise callback endpoint\n * @public\n * @documentationMaturity preview\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_GENERATE_UPLOAD_URL\n * @adminMethod\n */\n function generateFileUploadUrl$1(options?: GenerateFileUploadUrlOptions$1): Promise;\n interface GenerateFileUploadUrlOptions$1 {\n /** The uploaded original file name including the extension */\n fileName?: string;\n /** The file mime-type - will be used to identify the type of media */\n contentType?: string;\n /** The file size in bytes */\n sizeInBytes?: number;\n /**\n * An optional list of categories to link the created item to\n * The item will be linked to the account category automatically\n */\n categoryIds?: string[] | null;\n }\n /**\n * Import a file using a url\n * @param url - The url to the file to be imported\n * @public\n * @documentationMaturity preview\n * @requiredField url\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_IMPORT\n * @adminMethod\n */\n function importFile$1(url: string, options?: ImportFileOptions$1): Promise;\n interface ImportFileOptions$1 {\n /** The uploaded original file name including the extension - will be used as the initial display name */\n fileName?: string | null;\n /** The file mime-type - will be used to identify the type of media */\n contentType?: string | null;\n /** The file size in bytes */\n sizeInBytes?: number | null;\n /**\n * An optional list of categories to link the created item to\n * The item will be linked to the account category automatically\n */\n categoryIds?: string[] | null;\n /** The media type of the uploaded file */\n mediaType?: MediaType$2;\n /**\n * A unique identifier of the client that imported the file\n * This information will exist in the system_tags field prefixed by '_external_uploader:{uploader_system_tag}'\n */\n uploaderSystemTag?: string | null;\n /**\n * An additional container for external information\n * mostly used to pass identifying information of related entities in external services\n * This information will exist in the system_tags field prefixed by '_external_uploader_info:{uploader_info_system_tag}'\n */\n uploaderInfoSystemTag?: string | null;\n }\n /** @param importFileRequests - Information about the files to import.\n * @public\n * @documentationMaturity preview\n * @requiredField importFileRequests\n * @requiredField importFileRequests.url\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_IMPORT\n * @adminMethod\n */\n function bulkImportFiles$1(importFileRequests: ImportFileRequest$1[], options?: BulkImportFilesOptions): Promise;\n interface BulkImportFilesOptions {\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 * Default: `true`\n */\n returnEntity?: boolean | null;\n /**\n * An optional list of categories to link all the items to\n * The item will be linked to the account category automatically\n */\n categoryIds?: string[] | null;\n }\n /**\n * Search items, all filters only support equality\n * Each query must contain a categoryId filter\n * @public\n * @documentationMaturity preview\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_READ\n * @adminMethod\n */\n function searchItems(options?: SearchItemsOptions): Promise;\n interface SearchItemsOptions {\n /** Items search query */\n query?: Search;\n }\n /**\n * Query items allowing to sort by specified fields, all filters only support equality\n * Each query must contain a categoryId filter\n * @public\n * @documentationMaturity preview\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_READ\n * @adminMethod\n */\n function queryItems(): ItemsQueryBuilder;\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 ItemsQueryResult extends QueryOffsetResult {\n items: EnterpriseMediaItem[];\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: 'sizeInBytes' | 'title' | '_createdDate' | '_updatedDate', value: any) => ItemsQueryBuilder;\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: 'parentCategoryIds', value: any[]) => ItemsQueryBuilder;\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<'sizeInBytes' | 'title' | '_createdDate' | '_updatedDate'>) => ItemsQueryBuilder;\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<'sizeInBytes' | 'title' | '_createdDate' | '_updatedDate'>) => 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 skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => ItemsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Update an item\n * @param _id - Id of the item in public media\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField item\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_UPDATE\n * @adminMethod\n * @returns Updated item info\n */\n function updateItem(_id: string, item: UpdateItem, options?: UpdateItemOptions): Promise;\n interface UpdateItem {\n /**\n * Id of the item in public media\n * @readonly\n */\n _id?: string;\n /**\n * Media type of the item\n * @readonly\n */\n mediaType?: MediaType$2;\n /**\n * Size of the uploaded file in bytes.\n * @readonly\n */\n sizeInBytes?: string | null;\n /** The item title, part of searchable fields */\n title?: string | null;\n /**\n * The aspect ratio of the item\n * An object containing urls for different views of the item\n * @readonly\n */\n assets?: ItemAssets;\n /** Tags describing the image, part of searchable fields */\n displayTags?: string[] | null;\n /** Tags for internal client use, part of searchable fields */\n internalTags?: string[] | null;\n /**\n * Tags for filtering items in the search\n * @readonly\n */\n systemTags?: string[] | null;\n /**\n * Category ids this item belongs to\n * @readonly\n */\n parentCategoryIds?: string[] | null;\n /** Status of the item */\n publishStatus?: PublishStatus;\n /**\n * Date and time the item was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the item was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * An internal id used with different wix media systems\n * @readonly\n */\n internalId?: string | null;\n }\n interface UpdateItemOptions {\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Bulk update an item\n * @param updateItemRequests - Requests to update individual item\n * @public\n * @documentationMaturity preview\n * @requiredField updateItemRequests\n * @requiredField updateItemRequests.item._id\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_UPDATE\n * @adminMethod\n */\n function bulkUpdateItem(updateItemRequests: UpdateItemRequest[], options?: BulkUpdateItemOptions): Promise;\n interface BulkUpdateItemOptions {\n /** Should the response return the updated item */\n returnEntity?: boolean;\n }\n /**\n * Get item details\n * @param itemId - Item id\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_READ\n * @adminMethod\n * @returns item info\n */\n function getItem(itemId: string): Promise;\n /**\n * Link the item to multiple categories\n * @param itemId - The item id\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_UPDATE_CATEGORIES\n * @adminMethod\n */\n function linkItemToCategories(itemId: string, options?: LinkItemToCategoriesOptions): Promise;\n interface LinkItemToCategoriesOptions {\n /** The category ids that the item will be linked to */\n categoryIds?: string[];\n }\n /**\n * Unlink the item from multiple categories\n * @param itemId - The item id\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_UPDATE_CATEGORIES\n * @adminMethod\n */\n function unlinkItemFromCategories(itemId: string, options?: UnlinkItemFromCategoriesOptions): Promise;\n interface UnlinkItemFromCategoriesOptions {\n /** The category ids that the item will be unlinked from */\n categoryIds?: string[];\n }\n /**\n * Overwrite item categories\n * @param itemId - The item id\n * @public\n * @documentationMaturity preview\n * @requiredField itemId\n * @permissionId MEDIA.ENTERPRISE_MEDIA_ITEMS_UPDATE_CATEGORIES\n * @adminMethod\n */\n function overwriteItemCategories(itemId: string, options?: OverwriteItemCategoriesOptions): Promise;\n interface OverwriteItemCategoriesOptions {\n /** The category ids the item will be linked to after this operation */\n categoryIds?: string[];\n }\n \n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_EnterpriseMediaItem = EnterpriseMediaItem;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemAssets = ItemAssets;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemAssetsAssetsOneOf = ItemAssetsAssetsOneOf;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_PublishStatus = PublishStatus;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_PublishStatus: typeof PublishStatus;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemCategoriesChanged = ItemCategoriesChanged;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemUploadCallbackRequest = ItemUploadCallbackRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemUploadCallbackResponse = ItemUploadCallbackResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkImportFilesResult = BulkImportFilesResult;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchItemsRequest = SearchItemsRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_Search = Search;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchPagingMethodOneOf = SearchPagingMethodOneOf;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchDetails = SearchDetails;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_Paging = Paging;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchItemsResponse = SearchItemsResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryItemsRequest = QueryItemsRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryV2 = QueryV2;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryItemsResponse = QueryItemsResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItemRequest = UpdateItemRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItemResponse = UpdateItemResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_PublishStatusChanged = PublishStatusChanged;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkUpdateItemRequest = BulkUpdateItemRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkUpdateItemResponse = BulkUpdateItemResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkItemUpdateResult = BulkItemUpdateResult;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_GetItemRequest = GetItemRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_GetItemResponse = GetItemResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_LinkItemToCategoriesRequest = LinkItemToCategoriesRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_LinkItemToCategoriesResponse = LinkItemToCategoriesResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UnlinkItemFromCategoriesRequest = UnlinkItemFromCategoriesRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UnlinkItemFromCategoriesResponse = UnlinkItemFromCategoriesResponse;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_OverwriteItemCategoriesRequest = OverwriteItemCategoriesRequest;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_OverwriteItemCategoriesResponse = OverwriteItemCategoriesResponse;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_itemUploadCallback: typeof itemUploadCallback;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemUploadCallbackOptions = ItemUploadCallbackOptions;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkImportFilesOptions = BulkImportFilesOptions;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_searchItems: typeof searchItems;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchItemsOptions = SearchItemsOptions;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_queryItems: typeof queryItems;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemsQueryResult = ItemsQueryResult;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemsQueryBuilder = ItemsQueryBuilder;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_updateItem: typeof updateItem;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItem = UpdateItem;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItemOptions = UpdateItemOptions;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_bulkUpdateItem: typeof bulkUpdateItem;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkUpdateItemOptions = BulkUpdateItemOptions;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_getItem: typeof getItem;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_linkItemToCategories: typeof linkItemToCategories;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_LinkItemToCategoriesOptions = LinkItemToCategoriesOptions;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_unlinkItemFromCategories: typeof unlinkItemFromCategories;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UnlinkItemFromCategoriesOptions = UnlinkItemFromCategoriesOptions;\n const mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_overwriteItemCategories: typeof overwriteItemCategories;\n type mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_OverwriteItemCategoriesOptions = OverwriteItemCategoriesOptions;\n namespace mediaEnterprisePublicMediaV1EnterpriseItem_universal_d {\n export {\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_EnterpriseMediaItem as EnterpriseMediaItem,\n MediaType$2 as MediaType,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemAssets as ItemAssets,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemAssetsAssetsOneOf as ItemAssetsAssetsOneOf,\n VideoResolution$2 as VideoResolution,\n Archive$2 as Archive,\n Model3D$2 as Model3D,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_PublishStatus as PublishStatus,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemCategoriesChanged as ItemCategoriesChanged,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemUploadCallbackRequest as ItemUploadCallbackRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemUploadCallbackResponse as ItemUploadCallbackResponse,\n GenerateFileUploadUrlRequest$1 as GenerateFileUploadUrlRequest,\n GenerateFileUploadUrlResponse$1 as GenerateFileUploadUrlResponse,\n ImportFileRequest$1 as ImportFileRequest,\n ImportFileResponse$1 as ImportFileResponse,\n BulkImportFilesRequest$1 as BulkImportFilesRequest,\n BulkImportFilesResponse$1 as BulkImportFilesResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkImportFilesResult as BulkImportFilesResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchItemsRequest as SearchItemsRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_Search as Search,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchPagingMethodOneOf as SearchPagingMethodOneOf,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchDetails as SearchDetails,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_Paging as Paging,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchItemsResponse as SearchItemsResponse,\n PagingMetadataV2$3 as PagingMetadataV2,\n Cursors$3 as Cursors,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryItemsRequest as QueryItemsRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryV2 as QueryV2,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_QueryItemsResponse as QueryItemsResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItemRequest as UpdateItemRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItemResponse as UpdateItemResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_PublishStatusChanged as PublishStatusChanged,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkUpdateItemRequest as BulkUpdateItemRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkUpdateItemResponse as BulkUpdateItemResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkItemUpdateResult as BulkItemUpdateResult,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_GetItemRequest as GetItemRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_GetItemResponse as GetItemResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_LinkItemToCategoriesRequest as LinkItemToCategoriesRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_LinkItemToCategoriesResponse as LinkItemToCategoriesResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UnlinkItemFromCategoriesRequest as UnlinkItemFromCategoriesRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UnlinkItemFromCategoriesResponse as UnlinkItemFromCategoriesResponse,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_OverwriteItemCategoriesRequest as OverwriteItemCategoriesRequest,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_OverwriteItemCategoriesResponse as OverwriteItemCategoriesResponse,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_itemUploadCallback as itemUploadCallback,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemUploadCallbackOptions as ItemUploadCallbackOptions,\n generateFileUploadUrl$1 as generateFileUploadUrl,\n GenerateFileUploadUrlOptions$1 as GenerateFileUploadUrlOptions,\n importFile$1 as importFile,\n ImportFileOptions$1 as ImportFileOptions,\n bulkImportFiles$1 as bulkImportFiles,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkImportFilesOptions as BulkImportFilesOptions,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_searchItems as searchItems,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_SearchItemsOptions as SearchItemsOptions,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_queryItems as queryItems,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemsQueryResult as ItemsQueryResult,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_ItemsQueryBuilder as ItemsQueryBuilder,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_updateItem as updateItem,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItem as UpdateItem,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UpdateItemOptions as UpdateItemOptions,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_bulkUpdateItem as bulkUpdateItem,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_BulkUpdateItemOptions as BulkUpdateItemOptions,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_getItem as getItem,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_linkItemToCategories as linkItemToCategories,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_LinkItemToCategoriesOptions as LinkItemToCategoriesOptions,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_unlinkItemFromCategories as unlinkItemFromCategories,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_UnlinkItemFromCategoriesOptions as UnlinkItemFromCategoriesOptions,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_overwriteItemCategories as overwriteItemCategories,\n mediaEnterprisePublicMediaV1EnterpriseItem_universal_d_OverwriteItemCategoriesOptions as OverwriteItemCategoriesOptions,\n };\n }\n \n interface GeneratedImage {\n /** a url pointing to the generated image */\n url?: string;\n }\n interface GenerateImageRequest {\n /** Text description of the generated image */\n textPrompt?: string | null;\n /**\n * A string containing information about the style of the generated image\n * Can be taken from the Configuration response\n */\n style?: string | null;\n /** The image width */\n width?: number | null;\n /** The image height */\n height?: number | null;\n /**\n * The client that is making this request, Used for quota enforcement\n * Please contact the media team to add your own client here\n */\n requestSource?: RequestSource;\n /** Text description of things to be excluded from the image */\n negativePrompt?: string | null;\n /**\n * The product feature that the image is generated from\n * @internal\n */\n productFeature?: ProductFeature;\n }\n enum RequestSource {\n UNDEFINED = \"UNDEFINED\",\n STORES = \"STORES\",\n PHOTO_STUDIO = \"PHOTO_STUDIO\",\n MEDIA_MANAGER = \"MEDIA_MANAGER\",\n MOBILE_BRANDED_APPS = \"MOBILE_BRANDED_APPS\",\n FUNNEL_RESTAURANTS_MENU = \"FUNNEL_RESTAURANTS_MENU\",\n FUNNEL_STORES = \"FUNNEL_STORES\",\n FUNNEL_BLOG = \"FUNNEL_BLOG\",\n FUNNEL_BOOKINGS = \"FUNNEL_BOOKINGS\",\n FUNNEL_EVENTS = \"FUNNEL_EVENTS\",\n FUNNEL_ONLINE_PROGRAMS = \"FUNNEL_ONLINE_PROGRAMS\",\n FUNNEL_PORTFOLIO = \"FUNNEL_PORTFOLIO\",\n FUNNEL_PRICING_PLANS = \"FUNNEL_PRICING_PLANS\",\n MEDIA_MANAGER_MOBILE = \"MEDIA_MANAGER_MOBILE\",\n SITE_GENERATOR = \"SITE_GENERATOR\"\n }\n enum ProductFeature {\n UNDEFINED_PRODUCT_FEATURE = \"UNDEFINED_PRODUCT_FEATURE\",\n REGENERATION = \"REGENERATION\"\n }\n interface GenerateImageResponse {\n /**\n * A list of image objects containing urls for the generated images\n * Using\n */\n variations?: GeneratedImage[];\n /** The number of generated images for this site */\n usedQuota?: number | null;\n /** The number of generated images for this user - limited to 1000 */\n userUsedQuota?: number | null;\n }\n interface ConfigurationRequest {\n }\n interface ConfigurationResponse {\n /** A list of possible image styles that can be used when generating media */\n generationStyles?: string[] | null;\n }\n interface SetUserQuotaRequest {\n /** The user count of generated images */\n quota?: number;\n /** The user to change the quota for selected user only */\n userId?: string | null;\n }\n interface SetUserQuotaResponse {\n }\n interface ResetQuotaRequest {\n }\n interface ResetQuotaResponse {\n }\n /**\n * Generate images according to the specified prompt\n * Due to provider limitations, we may need to switch between providers.\n * This means that the result size of the image (width and height) may not be the same as the requested size\n * This method will always try to find the closest size that the AI provider allows\n * @internal\n * @documentationMaturity preview\n * @permissionId MEDIA.GENERATION_TEXT_TO_IMAGE\n * @adminMethod\n * @deprecated\n * @targetRemovalDate 2024-11-01\n */\n function generateImage(options?: GenerateImageOptions): Promise;\n interface GenerateImageOptions {\n /** Text description of the generated image */\n textPrompt?: string | null;\n /**\n * A string containing information about the style of the generated image\n * Can be taken from the Configuration response\n */\n style?: string | null;\n /** The image width */\n width?: number | null;\n /** The image height */\n height?: number | null;\n /**\n * The client that is making this request, Used for quota enforcement\n * Please contact the media team to add your own client here\n */\n requestSource?: RequestSource;\n /** Text description of things to be excluded from the image */\n negativePrompt?: string | null;\n /**\n * The product feature that the image is generated from\n * @internal\n */\n productFeature?: ProductFeature;\n }\n /**\n * Return service level configurations to the client for dropdown fields content\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function configuration(): Promise;\n /**\n * Return quota record for a site\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function setUserQuota(options?: SetUserQuotaOptions): Promise;\n interface SetUserQuotaOptions {\n /** The user count of generated images */\n quota?: number;\n /** The user to change the quota for selected user only */\n userId?: string | null;\n }\n /**\n * only allowed for specific users, resets the quota for all users\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function resetQuota(): Promise;\n \n type mediaGenerationV1GeneratedImage_universal_d_GeneratedImage = GeneratedImage;\n type mediaGenerationV1GeneratedImage_universal_d_GenerateImageRequest = GenerateImageRequest;\n type mediaGenerationV1GeneratedImage_universal_d_RequestSource = RequestSource;\n const mediaGenerationV1GeneratedImage_universal_d_RequestSource: typeof RequestSource;\n type mediaGenerationV1GeneratedImage_universal_d_ProductFeature = ProductFeature;\n const mediaGenerationV1GeneratedImage_universal_d_ProductFeature: typeof ProductFeature;\n type mediaGenerationV1GeneratedImage_universal_d_GenerateImageResponse = GenerateImageResponse;\n type mediaGenerationV1GeneratedImage_universal_d_ConfigurationRequest = ConfigurationRequest;\n type mediaGenerationV1GeneratedImage_universal_d_ConfigurationResponse = ConfigurationResponse;\n type mediaGenerationV1GeneratedImage_universal_d_SetUserQuotaRequest = SetUserQuotaRequest;\n type mediaGenerationV1GeneratedImage_universal_d_SetUserQuotaResponse = SetUserQuotaResponse;\n type mediaGenerationV1GeneratedImage_universal_d_ResetQuotaRequest = ResetQuotaRequest;\n type mediaGenerationV1GeneratedImage_universal_d_ResetQuotaResponse = ResetQuotaResponse;\n const mediaGenerationV1GeneratedImage_universal_d_generateImage: typeof generateImage;\n type mediaGenerationV1GeneratedImage_universal_d_GenerateImageOptions = GenerateImageOptions;\n const mediaGenerationV1GeneratedImage_universal_d_configuration: typeof configuration;\n const mediaGenerationV1GeneratedImage_universal_d_setUserQuota: typeof setUserQuota;\n type mediaGenerationV1GeneratedImage_universal_d_SetUserQuotaOptions = SetUserQuotaOptions;\n const mediaGenerationV1GeneratedImage_universal_d_resetQuota: typeof resetQuota;\n namespace mediaGenerationV1GeneratedImage_universal_d {\n export {\n mediaGenerationV1GeneratedImage_universal_d_GeneratedImage as GeneratedImage,\n mediaGenerationV1GeneratedImage_universal_d_GenerateImageRequest as GenerateImageRequest,\n mediaGenerationV1GeneratedImage_universal_d_RequestSource as RequestSource,\n mediaGenerationV1GeneratedImage_universal_d_ProductFeature as ProductFeature,\n mediaGenerationV1GeneratedImage_universal_d_GenerateImageResponse as GenerateImageResponse,\n mediaGenerationV1GeneratedImage_universal_d_ConfigurationRequest as ConfigurationRequest,\n mediaGenerationV1GeneratedImage_universal_d_ConfigurationResponse as ConfigurationResponse,\n mediaGenerationV1GeneratedImage_universal_d_SetUserQuotaRequest as SetUserQuotaRequest,\n mediaGenerationV1GeneratedImage_universal_d_SetUserQuotaResponse as SetUserQuotaResponse,\n mediaGenerationV1GeneratedImage_universal_d_ResetQuotaRequest as ResetQuotaRequest,\n mediaGenerationV1GeneratedImage_universal_d_ResetQuotaResponse as ResetQuotaResponse,\n mediaGenerationV1GeneratedImage_universal_d_generateImage as generateImage,\n mediaGenerationV1GeneratedImage_universal_d_GenerateImageOptions as GenerateImageOptions,\n mediaGenerationV1GeneratedImage_universal_d_configuration as configuration,\n mediaGenerationV1GeneratedImage_universal_d_setUserQuota as setUserQuota,\n mediaGenerationV1GeneratedImage_universal_d_SetUserQuotaOptions as SetUserQuotaOptions,\n mediaGenerationV1GeneratedImage_universal_d_resetQuota as resetQuota,\n };\n }\n \n interface FileDescriptor$1 {\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 file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).\n * @readonly\n */\n private?: boolean;\n /**\n * Media file type.\n * @readonly\n */\n mediaType?: MediaType$1;\n /**\n * Media file content.\n * @readonly\n */\n media?: FileMedia$1;\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$1;\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 Wix 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 | null;\n /**\n * Date and time the file was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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$2;\n /**\n * Internal tags describing the item, can be used in specific client use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The namespace containing the file\n * @internal\n */\n namespace?: Namespace$2;\n /**\n * Information about the identity that added this file\n * @internal\n */\n addedBy?: IdentityInfo$1;\n /**\n * The raw namespace containing the file\n * @internal\n * @readonly\n */\n rawNamespace?: string | null;\n /**\n * The date this file was last viewed from the last day, can be used to know if this file is still in use\n * @internal\n * @readonly\n */\n lastUsedDate?: Date | null;\n /**\n * The date this file was last viewed from the last day, can be used to know if this file is still in use\n * @internal\n * @readonly\n */\n mimeType?: string | null;\n }\n enum MediaType$1 {\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 ICON = \"ICON\",\n FLASH = \"FLASH\",\n FONT = \"FONT\"\n }\n interface FileMedia$1 extends FileMediaMediaOneOf$1 {\n /** Information about the image. */\n image?: ImageMedia$1;\n /** Information about the video. */\n video?: string;\n /** Information about the audio. */\n audio?: AudioV2$1;\n /** Information about the document. */\n document?: string;\n /** Information about the vector. */\n vector?: ImageMedia$1;\n /** Information about the archive. */\n archive?: Archive$1;\n /** Information about the 3D Model. */\n model3d?: Model3D$1;\n /**\n * Information about other file types\n * @internal\n */\n other?: OtherMedia$1;\n /**\n * Information about the icon.\n * @internal\n */\n icon?: ImageMedia$1;\n /**\n * Information about flash\n * @internal\n */\n flash?: OtherMedia$1;\n /**\n * Information about the font\n * @internal\n */\n font?: FontMedia$1;\n }\n /** @oneof */\n interface FileMediaMediaOneOf$1 {\n /** Information about the image. */\n image?: ImageMedia$1;\n /** Information about the video. */\n video?: string;\n /** Information about the audio. */\n audio?: AudioV2$1;\n /** Information about the document. */\n document?: string;\n /** Information about the vector. */\n vector?: ImageMedia$1;\n /** Information about the archive. */\n archive?: Archive$1;\n /** Information about the 3D Model. */\n model3d?: Model3D$1;\n /**\n * Information about other file types\n * @internal\n */\n other?: OtherMedia$1;\n /**\n * Information about the icon.\n * @internal\n */\n icon?: ImageMedia$1;\n /**\n * Information about flash\n * @internal\n */\n flash?: OtherMedia$1;\n /**\n * Information about the font\n * @internal\n */\n font?: FontMedia$1;\n }\n interface ImageMedia$1 {\n /** Image data. */\n image?: string;\n /** Image colors. */\n colors?: Colors$1;\n /** Information about faces in the image. Use to crop images without cutting out faces. */\n faces?: FaceRecognition$1[];\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 * Optional, return true or false if the image has text, or empty for unknown\n * @internal\n * @readonly\n */\n containsText?: boolean | null;\n /**\n * Optional, return true or false if the image has text, or empty for unknown\n * @internal\n * @readonly\n */\n animated?: boolean | 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 Colors$1 {\n /** Main color of the image. */\n prominent?: Color$1;\n /** Color palette of the image. */\n palette?: Color$1[];\n }\n interface Color$1 {\n /** HEX color. */\n hex?: string | null;\n /** RGB color. */\n rgb?: ColorRGB$1;\n }\n interface ColorRGB$1 {\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$1 {\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$1 {\n /** Video URL. */\n url?: string;\n /** Video height. */\n height?: number;\n /** Video width. */\n width?: number;\n /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\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 * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface AudioV2$1 {\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$1 {\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 | null;\n /** Archive size in bytes. */\n sizeInBytes?: string | null;\n /** Archive filename. */\n filename?: string | null;\n }\n interface Model3D$1 {\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 | null;\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$1 {\n /** WixMedia ID. for use with Site Media APIs only */\n _id?: string;\n /**\n * The media type of the file: 'package', 'raw'\n * @readonly\n */\n internalMediaType?: string | null;\n /**\n * size in bytes. Optional.\n * @readonly\n */\n sizeInBytes?: string | null;\n /** The file URL. */\n url?: string;\n }\n interface FontMedia$1 {\n /** WixMedia ID. for use with Site Media APIs only */\n _id?: string | null;\n /**\n * size in bytes. Optional.\n * @readonly\n */\n sizeInBytes?: string | null;\n /** The format of the font asset. ttf, woff, woff2 */\n format?: string | null;\n /** The font family name. */\n family?: string | null;\n /** The font name */\n fontName?: string | null;\n /** Font formats available for this file. */\n assets?: FontAsset$1[];\n }\n interface FontAsset$1 {\n /**\n * Keys for downloading different assets of a file.\n * Default: `src`, key representing the original file's format and quality.\n */\n assetKey?: string | null;\n /** The URL of the font asset. */\n url?: string | null;\n /** The format of the font asset. ttf, woff, woff2 */\n format?: string | null;\n }\n enum OperationStatus$1 {\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$2 {\n /** File is ready for consumption */\n OK = \"OK\",\n /** Deleted file */\n DELETED = \"DELETED\"\n }\n enum Namespace$2 {\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 /** _nsDraft */\n DRAFTS = \"DRAFTS\"\n }\n interface IdentityInfo$1 {\n /** The type of the user that uploaded the file */\n identityType?: IdentityType$1;\n /** User Id. empty when UNKNOWN */\n identityId?: string | null;\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 FileReady {\n /** File entity that is ready with full information. */\n file?: FileDescriptor$1;\n /** External information specified in the file import or upload. */\n externalInfo?: ExternalInfo;\n /** File was restored from the trash-bin. */\n triggeredByUndelete?: boolean;\n }\n interface ExternalInfo {\n /** External information to specify in the File Ready or File Failed events. */\n origin?: string;\n /** External IDs to specify in the File Ready or File Failed events. */\n externalIds?: string[];\n }\n interface FileFailed {\n /** External information specified in the file import or upload. */\n externalInfo?: ExternalInfo;\n /** Error information. */\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 DraftFilePublished {\n /** The file after it was published */\n file?: FileDescriptor$1;\n /** The namespace the file was published to */\n namespace?: Namespace$2;\n }\n interface BulkAnnotateImagesRequest {\n /** The file ids to run detection on */\n fileIds: string[];\n /** A list of detections types to fill for the image */\n annotationTypes: ImageAnnotationType[];\n /** When true the endpoint will detect listed information even if the image has this information */\n overwrite?: boolean | null;\n /** Should the response return the item following the operation */\n returnEntity?: boolean;\n }\n enum ImageAnnotationType {\n UNKNOWN_IMAGE_ANNOTATION_TYPE = \"UNKNOWN_IMAGE_ANNOTATION_TYPE\",\n CONTAINS_TEXT = \"CONTAINS_TEXT\",\n IS_ANIMATED = \"IS_ANIMATED\",\n FACES = \"FACES\",\n LABELS = \"LABELS\",\n COLORS = \"COLORS\",\n CAPTION = \"CAPTION\"\n }\n interface BulkAnnotateImagesResponse {\n /** Results of individual items */\n results?: BulkAnnotateImageResult[];\n /** Metadata of the operation */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkAnnotateImageResult {\n /** Item metadata */\n itemMetadata?: ItemMetadata;\n /**\n * The item following the operation\n * Only returned if operation was successful and if returnEntity flag was on\n */\n item?: FileDescriptor$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 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 GenerateFilesDownloadUrlRequest {\n /**\n * IDs of the files to download.\n *\n * You can also specify the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\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 specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\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` parameter in the Generate File Upload Url call.\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 ServiceError {\n /**\n * Error codes are groups of related errors\n * The error code can be used to provide additional details to wix support while debugging service errors\n */\n internalCode?: string | null;\n /** Debugging information, http status code returned from wix media internal API */\n internalHttpStatusCode?: number | null;\n /** Optional Debugging information, error key will represent the error \"family\" returned from wix media internal API */\n internalKey?: string | null;\n }\n interface GetFileDescriptorRequest {\n /**\n * File ID.\n *\n * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\n *\n * If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.\n */\n fileId: string;\n }\n interface GetFileDescriptorResponse {\n /** Information about the file. */\n file?: FileDescriptor$1;\n }\n interface GetFileDescriptorsRequest {\n /**\n * File IDs.\n *\n * You can also specify the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\n */\n fileIds: string[];\n }\n interface GetFileDescriptorsResponse {\n /** Information about the requested files. */\n files?: FileDescriptor$1[];\n }\n interface UpdateFileDescriptorRequest {\n /** The file to update. */\n file: FileDescriptor$1;\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateFileDescriptorResponse {\n /** Information about the updated file. */\n file?: FileDescriptor$1;\n }\n interface UnsupportedRequestValueError$2 {\n /** Optional A list of allowed values */\n allowedValues?: string[];\n /** The unsupported value send in the request */\n requestValue?: string;\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` parameter in the Generate File Upload Url call.\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 file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** A place to map an external entity to an uploaded file in the Wix Media Manager. */\n externalInfo?: ExternalInfo;\n /**\n * The uploaded file will be created under this namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The uploaded file will be created under this namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\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 * Internal tags describing the item, can be used in specific clients use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The time in hours for a draft file to expire and be deleted\n * Allowed only on DRAFT namespace\n * parent folder id and file path are not allowed when using draft_ttl_in_hours\n * @internal\n */\n draftTtlInHours?: number | null;\n /**\n * Configure what annotations will be done for an image file\n * @internal\n */\n imageAnnotationConfigurations?: ImageAnnotationConfigurations;\n }\n interface ImageAnnotationConfigurations {\n /** Whether to skip detection for the image */\n skipDetection?: boolean | null;\n /**\n * A list of detections types to fill for the image\n * If specified at least one valid annotation type should be provided\n * Default will be all detections\n */\n annotationTypes?: ImageAnnotationType[];\n }\n interface GenerateFileUploadUrlResponse {\n /** The URL for uploading a file to the Media Manager. */\n uploadUrl?: string;\n }\n interface SiteQuotaExceededError {\n /**\n * Error codes are groups of related errors\n * The error code can be used to provide additional details to wix support while debugging service errors\n */\n internalCode?: string | null;\n /** Debugging information, http status code returned from wix media internal API */\n internalHttpStatusCode?: number | null;\n /** Optional Debugging information, error key will represent the error \"family\" returned from wix media internal API */\n internalKey?: string | null;\n /** The quota details */\n quota?: TotalQuota$1;\n }\n interface TotalQuota$1 {\n /** Storage quota in bytes */\n storage?: string | null;\n /** Plans that are related to the quota */\n plans?: Plans$1;\n /** Time for which the quota is relevant - When the plans were retrieved from premium */\n timestamp?: Date | null;\n }\n interface Plans$1 {\n /** Premium Plan */\n premium?: Plan$1;\n /** Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available. */\n upgradeUrl?: string;\n }\n interface Plan$1 {\n /**\n * Plan ID - Premium product ID\n * @readonly\n */\n _id?: string;\n /** Plan name */\n name?: string;\n /** When the plan was created */\n createdAt?: Date | null;\n /** When then plan expires */\n expiresAt?: Date | null;\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` parameter in the Generate File Upload Url call.\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 file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the Wix 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 * The uploaded file will be created under this namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The uploaded file will be created under this namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\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 * Internal tags describing the item, can be used in specific clients use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The time in hours for a draft file to expire and be deleted\n * Allowed only on DRAFT namespace\n * @internal\n */\n draftTtlInHours?: number | null;\n /**\n * Configure what annotations will be done for an image file\n * @internal\n */\n imageAnnotationConfigurations?: ImageAnnotationConfigurations;\n }\n enum UploadProtocol {\n /** The upload protocol to use for implementing the resumable upload. */\n TUS = \"TUS\"\n }\n interface GenerateFileResumableUploadUrlResponse {\n /** The upload protocol to use for implementing the resumable upload. */\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 /**\n * Media type of the file to import.\n * excluding: OTHER media type\n */\n mediaType?: MediaType$1;\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 file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the Wix 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 File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) 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 * The imported file will be created under this namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The imported file will be created under this namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\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 * Internal tags describing the item, can be used in specific clients use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The time in hours for a draft file to expire and be deleted\n * Allowed only on DRAFT namespace\n * @internal\n */\n draftTtlInHours?: number | null;\n /**\n * Configure what annotations will be done for an image file\n * @internal\n */\n imageAnnotationConfigurations?: ImageAnnotationConfigurations;\n }\n interface ImportFileResponse {\n /** Information about the imported file. */\n file?: FileDescriptor$1;\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$1[];\n }\n interface BulkImportFileRequest {\n /** Information about the files to import. */\n importFileRequests: ImportFileRequest[];\n /** Default: `true` */\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 included in the response if the operation was successful and `returnEntity` is not set to `false`. */\n item?: FileDescriptor$1;\n }\n interface ListFilesRequest {\n /**\n * ID of the file's parent folder.
      \n * Default:`media-root`.\n */\n parentFolderId?: string | null;\n /** File media type. */\n mediaTypes?: MediaType$1[];\n /** \\n`true`: Returns only private files. \\n`false`: Returns only public files. \\n`undefined`: Returns public and private files. \\n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$2;\n /** Cursor and paging information. */\n paging?: CursorPaging$2;\n /**\n * List files of the specified namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List files of the specified namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$2 {\n ASC = \"ASC\",\n DESC = \"DESC\"\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 ListFilesResponse {\n /** List of files in the Media Manager. */\n files?: FileDescriptor$1[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2$2;\n }\n interface PagingMetadataV2$2 {\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$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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface Cursors$2 {\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$2;\n /** File media type. */\n mediaTypes?: MediaType$1[];\n /** \\n`true`: Returns only private files. \\n`false`: Returns only public files. \\n`undefined`: Returns public and private files. \\n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$2;\n /** Cursor and paging information. */\n paging?: CursorPaging$2;\n /**\n * search by an internal tag that describe the item - for internal wix use only\n * @internal\n */\n internalTag?: string | null;\n /**\n * Search files of the specified namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * Search files of the specified namespace
      \n * Note - Namespace value `Others` is not supported in this request and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\n }\n enum RootFolder$2 {\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$1[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2$2;\n }\n interface GenerateVideoStreamingUrlRequest {\n /**\n * File ID.\n *\n * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\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 specify the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\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 specify the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\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 /** File media type. */\n mediaTypes?: MediaType$1[];\n /** \\n`true`: Returns only private files. \\n`false`: Returns only public files. \\n`undefined`: Returns public and private files. \\n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$2;\n /** Cursor and paging information. */\n paging?: CursorPaging$2;\n /**\n * List files of the specified namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List files of the specified namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\n }\n interface ListDeletedFilesResponse {\n /** List of files in the Media Manager's trash bin. */\n files?: FileDescriptor$1[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2$2;\n }\n interface BulkPublishDraftFilesRequest {\n /**\n * IDs of the draft files to be published.\n *\n * You can also specify the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\n */\n fileIds: string[];\n /**\n * The namespace the files will be published to\n * Note, private files must have a namespace\n */\n namespace?: Namespace$2;\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 /**\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 /** Should the response return the item following the operation */\n returnEntity?: boolean;\n }\n interface BulkPublishDraftFilesResponse {\n /** Results of individual items */\n results?: BulkPublishDraftFileResult[];\n /** Metadata of the operation */\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkPublishDraftFileResult {\n /** Item metadata */\n itemMetadata?: ItemMetadata;\n /**\n * The item following the operation\n * Only returned if operation was successful and if returnEntity flag was on\n */\n item?: FileDescriptor$1;\n }\n interface UpdateFileRequest {\n /**\n * ID of the file to update.\n *\n * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\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 Wix 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$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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Run Image Annotation process on provided list of file ids\n * Note - the processes of this endpoint are synchronous and may take time to complete\n * @param fileIds - The file ids to run detection on\n * @internal\n * @documentationMaturity preview\n * @requiredField fileIds\n * @requiredField options.annotationTypes\n * @permissionId MEDIA.SITE_MEDIA_FILES_IMAGE_DETECTION\n * @adminMethod\n */\n function bulkAnnotateImages(fileIds: string[], options?: BulkAnnotateImagesOptions): Promise;\n interface BulkAnnotateImagesOptions {\n /** A list of detections types to fill for the image */\n annotationTypes: ImageAnnotationType[];\n /** When true the endpoint will detect listed information even if the image has this information */\n overwrite?: boolean | null;\n /** Should the response return the item following the operation */\n returnEntity?: boolean;\n }\n /**\n * Generates a URL for downloading a compressed file containing specific files in the Media Manager.\n *\n * The compressed file can contain up to 1000 files.\n *\n * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.\n * Since this is a permanent URL, it is less secure.\n * Therefore, to download private files, call the Generate File Download URL endpoint 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 * @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD\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 * To download different assets of the file, specify the `assetKeys` parameter which generates a download URL for each asset.\n * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.\n *\n * Call this endpoint to grant external clients access to a private media file. Specify 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, call the Generate Files Download URL endpoint.\n * Since this is a permanent URL, it is less secure.\n * Therefore, to download private files, call the Generate File Download URL endpoint 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 * @permissionId MEDIA.SITE_MEDIA_FILES_DOWNLOAD_URL\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` parameter in the Generate File Upload Url call.\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 a specific file in the Media Manager.\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 * @permissionId MEDIA.SITE_MEDIA_FILES_READ\n * @adminMethod\n * @returns Information about the file.\n */\n function getFileDescriptor(fileId: string): Promise;\n /**\n * Gets information about specific files in the Media Manager.\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 * @permissionId MEDIA.SITE_MEDIA_FILES_READ\n * @adminMethod\n */\n function getFileDescriptors(fileIds: string[]): Promise;\n /**\n * Updates a file.
      \n *\n * Specify 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 * @permissionId MEDIA.SITE_MEDIA_FILES_UPDATE\n * @adminMethod\n * @returns Information about the updated file.\n */\n function updateFileDescriptor(file: FileDescriptor$1, options?: UpdateFileDescriptorOptions): Promise;\n interface UpdateFileDescriptorOptions {\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Generates an upload URL to allow external clients to upload a file to the Media Manager.
      \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 Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).\n * > **Notes:**\n * > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).\n * > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, call Generate File Resumable Upload URL 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 * @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD\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` parameter in the Generate File Upload Url call.\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 file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n /** A place to map an external entity to an uploaded file in the Wix Media Manager. */\n externalInfo?: ExternalInfo;\n /**\n * The uploaded file will be created under this namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The uploaded file will be created under this namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\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 * Internal tags describing the item, can be used in specific clients use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The time in hours for a draft file to expire and be deleted\n * Allowed only on DRAFT namespace\n * parent folder id and file path are not allowed when using draft_ttl_in_hours\n * @internal\n */\n draftTtlInHours?: number | null;\n /**\n * Configure what annotations will be done for an image file\n * @internal\n */\n imageAnnotationConfigurations?: ImageAnnotationConfigurations;\n }\n /**\n * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager.
      \n *\n * With the resumable upload URL, any interruptions in the upload process pauses the file upload, and resumes the file upload process after the interruption. The resumable upload URL is also helpful when network connection is poor.\n * To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see Resumable Upload API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/resumable-upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/resumable-upload-api)).\n *\n * > **Note:** When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).\n * @param mimeType - File mime type.\n * @public\n * @requiredField mimeType\n * @param options - Options to use when generating a resumable upload URL.\n * @permissionId MEDIA.SITE_MEDIA_FILES_UPLOAD\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` parameter in the Generate File Upload Url call.\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 file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the Wix 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 * The uploaded file will be created under this namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The uploaded file will be created under this namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\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 * Internal tags describing the item, can be used in specific clients use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The time in hours for a draft file to expire and be deleted\n * Allowed only on DRAFT namespace\n * @internal\n */\n draftTtlInHours?: number | null;\n /**\n * Configure what annotations will be done for an image file\n * @internal\n */\n imageAnnotationConfigurations?: ImageAnnotationConfigurations;\n }\n /**\n * Imports a file to the Media Manager using an external url.\n *\n * Returns information about the imported file.\n * Specify 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 * >**Notes:**\n * > - The `media` property isn't returned in the `files` response object.\n * > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).\n *\n * To import a file, you need to do one of the following:\n * - Specify 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 * - Specify 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, specify 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 * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT\n * @adminMethod\n */\n function importFile(url: string, options?: ImportFileOptions): Promise;\n interface ImportFileOptions {\n /**\n * Media type of the file to import.\n * excluding: OTHER media type\n */\n mediaType?: MediaType$1;\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 file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /** Labels assigned to media files that describe and categorize them. Provided by the Wix 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 File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) 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 * The imported file will be created under this namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The imported file will be created under this namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\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 * Internal tags describing the item, can be used in specific clients use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The time in hours for a draft file to expire and be deleted\n * Allowed only on DRAFT namespace\n * @internal\n */\n draftTtlInHours?: number | null;\n /**\n * Configure what annotations will be done for an image file\n * @internal\n */\n imageAnnotationConfigurations?: ImageAnnotationConfigurations;\n }\n /**\n * Imports a bulk of files to the Media Manager using external urls.
      \n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with Bulk Import File and will be removed on March 31, 2024.\n *\n *
      \n *\n * Returns information about the imported files.\n *\n * Use the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.\n * If no folder is specified, the file is imported to the `media-root` folder.\n *\n * >**Notes:**\n * > - The `media` property isn't returned in the `files` response object.\n * > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).\n *\n * To import files, you need to do one of the following for each file:\n * - Specify 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, specify 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 * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT\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 * Returns information about the imported files.\n *\n * Specify the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.\n * If no folder is specified, the file is imported to the `media-root` folder.\n *\n * >**Notes:**\n * > - The `media` property isn't returned in the `files` response object.\n * > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).\n *\n * To import files, you need to do one of the following for each file:\n * - Specify 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, specify 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 * @permissionId MEDIA.SITE_MEDIA_FILES_IMPORT\n * @adminMethod\n */\n function bulkImportFile(importFileRequests: ImportFileRequest[], options?: BulkImportFileOptions): Promise;\n interface BulkImportFileOptions {\n /** Default: `true` */\n returnEntity?: boolean | null;\n }\n /**\n * Retrieves a list of files in the Media Manager.\n *\n * To retrieve a list of files within a specific folder in the Media Manager, specify the folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves the list of files in the root folder of the Media Manager.\n * @public\n * @param options - Options to use when listing media files.\n * @permissionId MEDIA.SITE_MEDIA_FILES_LIST\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 /** File media type. */\n mediaTypes?: MediaType$1[];\n /** \\n`true`: Returns only private files. \\n`false`: Returns only public files. \\n`undefined`: Returns public and private files. \\n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$2;\n /** Cursor and paging information. */\n paging?: CursorPaging$2;\n /**\n * List files of the specified namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List files of the specified namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\n }\n /**\n * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters.
      \n *\n * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.\n * @public\n * @param options - Options to specify which folders to search.\n * @permissionId MEDIA.SITE_MEDIA_FILES_LIST\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 * Default: `MEDIA_ROOT`.\n */\n rootFolder?: RootFolder$2;\n /** File media type. */\n mediaTypes?: MediaType$1[];\n /** \\n`true`: Returns only private files. \\n`false`: Returns only public files. \\n`undefined`: Returns public and private files. \\n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$2;\n /** Cursor and paging information. */\n paging?: CursorPaging$2;\n /**\n * search by an internal tag that describe the item - for internal wix use only\n * @internal\n */\n internalTag?: string | null;\n /**\n * Search files of the specified namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * Search files of the specified namespace
      \n * Note - Namespace value `Others` is not supported in this request and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\n }\n /**\n * Generates a URL for streaming a specific video file in the Media Manager.
      \n *\n * To stream different assets of the file, specify the `assetKeys` parameter which generates a video streaming URL for each asset. If no assetKey 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 * @permissionId MEDIA.SITE_MEDIA_FILES_READ\n * @adminMethod\n */\n function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise;\n interface GenerateVideoStreamingUrlOptions {\n /** Video stream format. */\n format?: StreamFormat;\n }\n /**\n * Return a token for a direct web socket notification channel\n * This API is not platformized (Contact the Media team for use instructions)\n * This API should be internal only\n * @internal\n * @documentationMaturity preview\n * @permissionId MEDIA.SITE_MEDIA_WEB_NOTIFICATIONS_TOKEN\n * @adminMethod\n */\n function generateWebSocketToken(): Promise;\n /**\n * Deletes the specified files from the Media Manager.
      \n *\n * The deleted files are moved to the Media Manager's trash bin (`TRASH-ROOT` folder) unless permanently deleted. To permanently delete files, specify 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 * Note the following:\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 a site contains deleted media files, the deleted media files still appear on the site as the files are still in the Media Manager (in the trash bin).\n * * You can use Bulk Restore Files From Trash Bin 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 * @permissionId MEDIA.SITE_MEDIA_FILES_MOVE_TO_TRASH\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 * @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 * @permissionId MEDIA.SITE_MEDIA_FILES_RESTORE_FROM_TRASH\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 * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.\n * @public\n * @param options - Options to use when listing deleted files from the trash bin.\n * @permissionId MEDIA.SITE_MEDIA_FILES_LIST_DELETED\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 /** File media type. */\n mediaTypes?: MediaType$1[];\n /** \\n`true`: Returns only private files. \\n`false`: Returns only public files. \\n`undefined`: Returns public and private files. \\n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */\n private?: boolean | null;\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$2;\n /** Cursor and paging information. */\n paging?: CursorPaging$2;\n /**\n * List files of the specified namespace\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List files of the specified namespace\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$2;\n }\n /**\n * @param fileIds - IDs of the draft files to be published.\n *\n * You can also specify the files' Wix media URLs. For example, `[\"wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032\"]`.\n * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).\n * @internal\n * @documentationMaturity preview\n * @requiredField fileIds\n * @permissionId MEDIA.SITE_MEDIA_FILES_PUBLISH\n * @adminMethod\n */\n function bulkPublishDraftFiles(fileIds: string[], options?: BulkPublishDraftFilesOptions): Promise;\n interface BulkPublishDraftFilesOptions {\n /**\n * The namespace the files will be published to\n * Note, private files must have a namespace\n */\n namespace?: Namespace$2;\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 /**\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 /** Should the response return the item following the operation */\n returnEntity?: boolean;\n }\n /**\n * Updates a file.\n *\n *
      \n *\n * __Deprecation Notice:__\n *\n * This endpoint has been replaced with [Update File Descriptor](https://dev.wix.com/api/rest/media/media-manager/files/update-file-descriptor) and will be removed on March 31, 2023.\n *\n *
      \n *\n * Specify the `parentFolderId` parameter to move a file from its current folder to a different folder.\n * @internal\n * @requiredField fileId\n * @param options - Fields to update.\n * @param fileId - ID of the file to update.\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 * @permissionId MEDIA.SITE_MEDIA_FILES_UPDATE\n * @adminMethod\n * @deprecated method is deprecated due to standard aligning\n * @replacedBy com.wix.media.site_media.v1.filesService.UpdateFileDescriptor\n * @targetRemovalDate 2023-03-31\n */\n function updateFile(fileId: string, options?: UpdateFileOptions): Promise;\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 Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */\n labels?: string[] | null;\n }\n \n type mediaSiteMediaV1FileDescriptor_universal_d_FileReady = FileReady;\n type mediaSiteMediaV1FileDescriptor_universal_d_ExternalInfo = ExternalInfo;\n type mediaSiteMediaV1FileDescriptor_universal_d_FileFailed = FileFailed;\n type mediaSiteMediaV1FileDescriptor_universal_d_ApplicationError = ApplicationError;\n type mediaSiteMediaV1FileDescriptor_universal_d_DraftFilePublished = DraftFilePublished;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImagesRequest = BulkAnnotateImagesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImageAnnotationType = ImageAnnotationType;\n const mediaSiteMediaV1FileDescriptor_universal_d_ImageAnnotationType: typeof ImageAnnotationType;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImagesResponse = BulkAnnotateImagesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImageResult = BulkAnnotateImageResult;\n type mediaSiteMediaV1FileDescriptor_universal_d_ItemMetadata = ItemMetadata;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkActionMetadata = BulkActionMetadata;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlRequest = GenerateFilesDownloadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlResponse = GenerateFilesDownloadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlRequest = GenerateFileDownloadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ContentDisposition = ContentDisposition;\n const mediaSiteMediaV1FileDescriptor_universal_d_ContentDisposition: typeof ContentDisposition;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlResponse = GenerateFileDownloadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_DownloadUrl = DownloadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_ServiceError = ServiceError;\n type mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorRequest = GetFileDescriptorRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorResponse = GetFileDescriptorResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorsRequest = GetFileDescriptorsRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorsResponse = GetFileDescriptorsResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileDescriptorRequest = UpdateFileDescriptorRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileDescriptorResponse = UpdateFileDescriptorResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlRequest = GenerateFileUploadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImageAnnotationConfigurations = ImageAnnotationConfigurations;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlResponse = GenerateFileUploadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_SiteQuotaExceededError = SiteQuotaExceededError;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlRequest = GenerateFileResumableUploadUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_UploadProtocol = UploadProtocol;\n const mediaSiteMediaV1FileDescriptor_universal_d_UploadProtocol: typeof UploadProtocol;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlResponse = GenerateFileResumableUploadUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImportFileRequest = ImportFileRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImportFileResponse = ImportFileResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesRequest = BulkImportFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesResponse = BulkImportFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileRequest = BulkImportFileRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileResponse = BulkImportFileResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileResult = BulkImportFileResult;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListFilesRequest = ListFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListFilesResponse = ListFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_SearchFilesRequest = SearchFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_SearchFilesResponse = SearchFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlRequest = GenerateVideoStreamingUrlRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_StreamFormat = StreamFormat;\n const mediaSiteMediaV1FileDescriptor_universal_d_StreamFormat: typeof StreamFormat;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlResponse = GenerateVideoStreamingUrlResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenRequest = GenerateWebSocketTokenRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenResponse = GenerateWebSocketTokenResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesRequest = BulkDeleteFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesResponse = BulkDeleteFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinRequest = BulkRestoreFilesFromTrashBinRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinResponse = BulkRestoreFilesFromTrashBinResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesRequest = ListDeletedFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesResponse = ListDeletedFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFilesRequest = BulkPublishDraftFilesRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFilesResponse = BulkPublishDraftFilesResponse;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFileResult = BulkPublishDraftFileResult;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileRequest = UpdateFileRequest;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileResponse = UpdateFileResponse;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkAnnotateImages: typeof bulkAnnotateImages;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImagesOptions = BulkAnnotateImagesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFilesDownloadUrl: typeof generateFilesDownloadUrl;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFileDownloadUrl: typeof generateFileDownloadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlOptions = GenerateFileDownloadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_getFileDescriptor: typeof getFileDescriptor;\n const mediaSiteMediaV1FileDescriptor_universal_d_getFileDescriptors: typeof getFileDescriptors;\n const mediaSiteMediaV1FileDescriptor_universal_d_updateFileDescriptor: typeof updateFileDescriptor;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileDescriptorOptions = UpdateFileDescriptorOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFileUploadUrl: typeof generateFileUploadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlOptions = GenerateFileUploadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateFileResumableUploadUrl: typeof generateFileResumableUploadUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlOptions = GenerateFileResumableUploadUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_importFile: typeof importFile;\n type mediaSiteMediaV1FileDescriptor_universal_d_ImportFileOptions = ImportFileOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkImportFiles: typeof bulkImportFiles;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkImportFile: typeof bulkImportFile;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileOptions = BulkImportFileOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_listFiles: typeof listFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListFilesOptions = ListFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_searchFiles: typeof searchFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_SearchFilesOptions = SearchFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateVideoStreamingUrl: typeof generateVideoStreamingUrl;\n type mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlOptions = GenerateVideoStreamingUrlOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_generateWebSocketToken: typeof generateWebSocketToken;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkDeleteFiles: typeof bulkDeleteFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesOptions = BulkDeleteFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkRestoreFilesFromTrashBin: typeof bulkRestoreFilesFromTrashBin;\n const mediaSiteMediaV1FileDescriptor_universal_d_listDeletedFiles: typeof listDeletedFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesOptions = ListDeletedFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_bulkPublishDraftFiles: typeof bulkPublishDraftFiles;\n type mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFilesOptions = BulkPublishDraftFilesOptions;\n const mediaSiteMediaV1FileDescriptor_universal_d_updateFile: typeof updateFile;\n type mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileOptions = UpdateFileOptions;\n namespace mediaSiteMediaV1FileDescriptor_universal_d {\n export {\n FileDescriptor$1 as FileDescriptor,\n MediaType$1 as MediaType,\n FileMedia$1 as FileMedia,\n FileMediaMediaOneOf$1 as FileMediaMediaOneOf,\n ImageMedia$1 as ImageMedia,\n FocalPoint$1 as FocalPoint,\n Colors$1 as Colors,\n Color$1 as Color,\n ColorRGB$1 as ColorRGB,\n FaceRecognition$1 as FaceRecognition,\n VideoResolution$1 as VideoResolution,\n AudioV2$1 as AudioV2,\n Archive$1 as Archive,\n Model3D$1 as Model3D,\n OtherMedia$1 as OtherMedia,\n FontMedia$1 as FontMedia,\n FontAsset$1 as FontAsset,\n OperationStatus$1 as OperationStatus,\n State$2 as State,\n Namespace$2 as Namespace,\n IdentityInfo$1 as IdentityInfo,\n IdentityType$1 as IdentityType,\n mediaSiteMediaV1FileDescriptor_universal_d_FileReady as FileReady,\n mediaSiteMediaV1FileDescriptor_universal_d_ExternalInfo as ExternalInfo,\n mediaSiteMediaV1FileDescriptor_universal_d_FileFailed as FileFailed,\n mediaSiteMediaV1FileDescriptor_universal_d_ApplicationError as ApplicationError,\n mediaSiteMediaV1FileDescriptor_universal_d_DraftFilePublished as DraftFilePublished,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImagesRequest as BulkAnnotateImagesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ImageAnnotationType as ImageAnnotationType,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImagesResponse as BulkAnnotateImagesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImageResult as BulkAnnotateImageResult,\n mediaSiteMediaV1FileDescriptor_universal_d_ItemMetadata as ItemMetadata,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkActionMetadata as BulkActionMetadata,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlRequest as GenerateFilesDownloadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFilesDownloadUrlResponse as GenerateFilesDownloadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlRequest as GenerateFileDownloadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ContentDisposition as ContentDisposition,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlResponse as GenerateFileDownloadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_DownloadUrl as DownloadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_ServiceError as ServiceError,\n mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorRequest as GetFileDescriptorRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorResponse as GetFileDescriptorResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorsRequest as GetFileDescriptorsRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GetFileDescriptorsResponse as GetFileDescriptorsResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileDescriptorRequest as UpdateFileDescriptorRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileDescriptorResponse as UpdateFileDescriptorResponse,\n UnsupportedRequestValueError$2 as UnsupportedRequestValueError,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlRequest as GenerateFileUploadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ImageAnnotationConfigurations as ImageAnnotationConfigurations,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlResponse as GenerateFileUploadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_SiteQuotaExceededError as SiteQuotaExceededError,\n TotalQuota$1 as TotalQuota,\n Plans$1 as Plans,\n Plan$1 as Plan,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlRequest as GenerateFileResumableUploadUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_UploadProtocol as UploadProtocol,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlResponse as GenerateFileResumableUploadUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_ImportFileRequest as ImportFileRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ImportFileResponse as ImportFileResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesRequest as BulkImportFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFilesResponse as BulkImportFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileRequest as BulkImportFileRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileResponse as BulkImportFileResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileResult as BulkImportFileResult,\n mediaSiteMediaV1FileDescriptor_universal_d_ListFilesRequest as ListFilesRequest,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n CursorPaging$2 as CursorPaging,\n mediaSiteMediaV1FileDescriptor_universal_d_ListFilesResponse as ListFilesResponse,\n PagingMetadataV2$2 as PagingMetadataV2,\n Cursors$2 as Cursors,\n mediaSiteMediaV1FileDescriptor_universal_d_SearchFilesRequest as SearchFilesRequest,\n RootFolder$2 as RootFolder,\n mediaSiteMediaV1FileDescriptor_universal_d_SearchFilesResponse as SearchFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlRequest as GenerateVideoStreamingUrlRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_StreamFormat as StreamFormat,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlResponse as GenerateVideoStreamingUrlResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenRequest as GenerateWebSocketTokenRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateWebSocketTokenResponse as GenerateWebSocketTokenResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesRequest as BulkDeleteFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesResponse as BulkDeleteFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinRequest as BulkRestoreFilesFromTrashBinRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkRestoreFilesFromTrashBinResponse as BulkRestoreFilesFromTrashBinResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesRequest as ListDeletedFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesResponse as ListDeletedFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFilesRequest as BulkPublishDraftFilesRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFilesResponse as BulkPublishDraftFilesResponse,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFileResult as BulkPublishDraftFileResult,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileRequest as UpdateFileRequest,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileResponse as UpdateFileResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkAnnotateImages as bulkAnnotateImages,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkAnnotateImagesOptions as BulkAnnotateImagesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFilesDownloadUrl as generateFilesDownloadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFileDownloadUrl as generateFileDownloadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileDownloadUrlOptions as GenerateFileDownloadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_getFileDescriptor as getFileDescriptor,\n mediaSiteMediaV1FileDescriptor_universal_d_getFileDescriptors as getFileDescriptors,\n mediaSiteMediaV1FileDescriptor_universal_d_updateFileDescriptor as updateFileDescriptor,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileDescriptorOptions as UpdateFileDescriptorOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFileUploadUrl as generateFileUploadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileUploadUrlOptions as GenerateFileUploadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateFileResumableUploadUrl as generateFileResumableUploadUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateFileResumableUploadUrlOptions as GenerateFileResumableUploadUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_importFile as importFile,\n mediaSiteMediaV1FileDescriptor_universal_d_ImportFileOptions as ImportFileOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkImportFiles as bulkImportFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkImportFile as bulkImportFile,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkImportFileOptions as BulkImportFileOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_listFiles as listFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_ListFilesOptions as ListFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_searchFiles as searchFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_SearchFilesOptions as SearchFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateVideoStreamingUrl as generateVideoStreamingUrl,\n mediaSiteMediaV1FileDescriptor_universal_d_GenerateVideoStreamingUrlOptions as GenerateVideoStreamingUrlOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_generateWebSocketToken as generateWebSocketToken,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkDeleteFiles as bulkDeleteFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkDeleteFilesOptions as BulkDeleteFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkRestoreFilesFromTrashBin as bulkRestoreFilesFromTrashBin,\n mediaSiteMediaV1FileDescriptor_universal_d_listDeletedFiles as listDeletedFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_ListDeletedFilesOptions as ListDeletedFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_bulkPublishDraftFiles as bulkPublishDraftFiles,\n mediaSiteMediaV1FileDescriptor_universal_d_BulkPublishDraftFilesOptions as BulkPublishDraftFilesOptions,\n mediaSiteMediaV1FileDescriptor_universal_d_updateFile as updateFile,\n mediaSiteMediaV1FileDescriptor_universal_d_UpdateFileOptions as UpdateFileOptions,\n };\n }\n \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 | null;\n /**\n * Date the folder was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * State of the folder.\n * @readonly\n */\n state?: State$1;\n /**\n * Namespace of the folder.\n * @internal\n */\n namespace?: Namespace$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 /** _nsDraft */\n DRAFTS = \"DRAFTS\"\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 * The namespace this folder will be created under\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The namespace this folder will be created under\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$1;\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 * List folders of the specified namespace.\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List folders of the specified namespace.\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 * 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 * @internal\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 }\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 * 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 * Search folders of the specified namespace.\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * Search folders of the specified namespace.\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$1;\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 /** Folder to update. */\n folder: Folder;\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdateFolderResponse {\n /** Information about the updated folder. */\n folder?: Folder;\n }\n interface UnsupportedRequestValueError$1 {\n /** Optional A list of allowed values */\n allowedValues?: string[];\n /** The unsupported value send in the request */\n requestValue?: string;\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 * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n /**\n * List folders of the specified namespace.\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List folders of the specified namespace.\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 folder in the Media Manager.
      \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 * @permissionId MEDIA.SITE_MEDIA_FOLDERS_CREATE\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 * The namespace this folder will be created under\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * The namespace this folder will be created under\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$1;\n }\n /**\n * Gets information from a specific folder in the Media Manager.\n * @param folderId - Folder ID.\n * @public\n * @requiredField folderId\n * @permissionId MEDIA.SITE_MEDIA_FOLDERS_READ\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. To retrieve a list of folders within a specific folder in the Media Manager, specify the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves a list of folders within the root folder of the Media Manager.\n * @public\n * @param options - Options to use when listing folders from the Media Manager.\n * @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST\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 * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n /**\n * List folders of the specified namespace.\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List folders of the specified namespace.\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$1;\n }\n /**\n * Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.
      \n *\n * If no parameters are specified, the method returns all folders in the `MEDIA_ROOT` folder.\n * @public\n * @param options - Options specifying which folders to search.\n * @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST\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 * 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 * Search folders of the specified namespace.\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * Search folders of the specified namespace.\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$1;\n }\n /**\n * Updates a folder.
      \n *\n * You can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.\n * @param _id - Folder ID. Generated when a folder is created in the Media Manager.\n * @public\n * @requiredField _id\n * @requiredField folder\n * @param folder - Folder to update.\n * @permissionId MEDIA.SITE_MEDIA_FOLDERS_UPDATE\n * @adminMethod\n * @returns Information about the updated folder.\n */\n function updateFolder(_id: string, folder: UpdateFolder, options?: UpdateFolderOptions): Promise;\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 | null;\n /**\n * Date the folder was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * State of the folder.\n * @readonly\n */\n state?: State$1;\n /**\n * Namespace of the folder.\n * @internal\n */\n namespace?: Namespace$1;\n }\n interface UpdateFolderOptions {\n /**\n * Set of fields to update. Fields that aren't included in `fieldMask.paths` are ignored.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
      \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 * @permissionId MEDIA.SITE_MEDIA_FOLDERS_DOWNLOAD\n * @adminMethod\n */\n function generateFolderDownloadUrl(folderId: string): Promise;\n /**\n * Temporarily deletes the specified folders from the Media Manager.
      \n *\n * The deleted folders are moved to the Media Manager's `trash-root` folder (trash bin) unless permanently deleted. To permanently delete folders, specify 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 * Note the following:\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 a site contains files from a deleted media folder, the files still appear on the site as the deleted folder is still in the Media Manager (in the trash bin).\n * * You can also use the Bulk Restore Folders From Trash Bin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/folders/bulk-restore-folders-from-trash-bin) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/folders/bulk-restore-folders-from-trash-bin)) method 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 * @permissionId MEDIA.SITE_MEDIA_FOLDERS_MOVE_TO_TRASH\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 * @param folderIds - IDs of the folders to restore from the Media Manager's trash bin.\n * @public\n * @requiredField folderIds\n * @permissionId MEDIA.SITE_MEDIA_FOLDERS_RESTORE_FROM_TRASH\n * @adminMethod\n */\n function bulkRestoreFoldersFromTrashBin(folderIds: string[]): Promise;\n /**\n * Retrieves a list of folders in the Media Manager's trash bin.\n * @public\n * @param options - Options to use when listing deleted folders from the trash bin.\n * @permissionId MEDIA.SITE_MEDIA_FOLDERS_LIST_DELETED\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 * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting$1;\n /** Cursor and paging information. */\n paging?: CursorPaging$1;\n /**\n * List folders of the specified namespace.\n * @internal\n */\n rawNamespace?: string | null;\n /**\n * List folders of the specified namespace.\n * Note - Namespace value `Others` is not supported and will produce an error\n * @internal\n */\n namespace?: Namespace$1;\n }\n \n type mediaSiteMediaV1Folder_universal_d_Folder = Folder;\n type mediaSiteMediaV1Folder_universal_d_CreateFolderRequest = CreateFolderRequest;\n type mediaSiteMediaV1Folder_universal_d_CreateFolderResponse = CreateFolderResponse;\n type mediaSiteMediaV1Folder_universal_d_GetFolderRequest = GetFolderRequest;\n type mediaSiteMediaV1Folder_universal_d_GetFolderResponse = GetFolderResponse;\n type mediaSiteMediaV1Folder_universal_d_ListFoldersRequest = ListFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_ListFoldersResponse = ListFoldersResponse;\n type mediaSiteMediaV1Folder_universal_d_SearchFoldersRequest = SearchFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_SearchFoldersResponse = SearchFoldersResponse;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolderRequest = UpdateFolderRequest;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolderResponse = UpdateFolderResponse;\n type mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlRequest = GenerateFolderDownloadUrlRequest;\n type mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlResponse = GenerateFolderDownloadUrlResponse;\n type mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersRequest = BulkDeleteFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersResponse = BulkDeleteFoldersResponse;\n type mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinRequest = BulkRestoreFoldersFromTrashBinRequest;\n type mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinResponse = BulkRestoreFoldersFromTrashBinResponse;\n type mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersRequest = ListDeletedFoldersRequest;\n type mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersResponse = ListDeletedFoldersResponse;\n type mediaSiteMediaV1Folder_universal_d_DomainEvent = DomainEvent;\n type mediaSiteMediaV1Folder_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type mediaSiteMediaV1Folder_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type mediaSiteMediaV1Folder_universal_d_RestoreInfo = RestoreInfo;\n type mediaSiteMediaV1Folder_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type mediaSiteMediaV1Folder_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type mediaSiteMediaV1Folder_universal_d_ActionEvent = ActionEvent;\n type mediaSiteMediaV1Folder_universal_d_MessageEnvelope = MessageEnvelope;\n type mediaSiteMediaV1Folder_universal_d_IdentificationData = IdentificationData;\n type mediaSiteMediaV1Folder_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type mediaSiteMediaV1Folder_universal_d_WebhookIdentityType = WebhookIdentityType;\n const mediaSiteMediaV1Folder_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const mediaSiteMediaV1Folder_universal_d_createFolder: typeof createFolder;\n type mediaSiteMediaV1Folder_universal_d_CreateFolderOptions = CreateFolderOptions;\n const mediaSiteMediaV1Folder_universal_d_getFolder: typeof getFolder;\n const mediaSiteMediaV1Folder_universal_d_listFolders: typeof listFolders;\n type mediaSiteMediaV1Folder_universal_d_ListFoldersOptions = ListFoldersOptions;\n const mediaSiteMediaV1Folder_universal_d_searchFolders: typeof searchFolders;\n type mediaSiteMediaV1Folder_universal_d_SearchFoldersOptions = SearchFoldersOptions;\n const mediaSiteMediaV1Folder_universal_d_updateFolder: typeof updateFolder;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolder = UpdateFolder;\n type mediaSiteMediaV1Folder_universal_d_UpdateFolderOptions = UpdateFolderOptions;\n const mediaSiteMediaV1Folder_universal_d_generateFolderDownloadUrl: typeof generateFolderDownloadUrl;\n const mediaSiteMediaV1Folder_universal_d_bulkDeleteFolders: typeof bulkDeleteFolders;\n type mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersOptions = BulkDeleteFoldersOptions;\n const mediaSiteMediaV1Folder_universal_d_bulkRestoreFoldersFromTrashBin: typeof bulkRestoreFoldersFromTrashBin;\n const mediaSiteMediaV1Folder_universal_d_listDeletedFolders: typeof listDeletedFolders;\n type mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersOptions = ListDeletedFoldersOptions;\n namespace mediaSiteMediaV1Folder_universal_d {\n export {\n mediaSiteMediaV1Folder_universal_d_Folder as Folder,\n State$1 as State,\n Namespace$1 as Namespace,\n mediaSiteMediaV1Folder_universal_d_CreateFolderRequest as CreateFolderRequest,\n mediaSiteMediaV1Folder_universal_d_CreateFolderResponse as CreateFolderResponse,\n mediaSiteMediaV1Folder_universal_d_GetFolderRequest as GetFolderRequest,\n mediaSiteMediaV1Folder_universal_d_GetFolderResponse as GetFolderResponse,\n mediaSiteMediaV1Folder_universal_d_ListFoldersRequest as ListFoldersRequest,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n CursorPaging$1 as CursorPaging,\n mediaSiteMediaV1Folder_universal_d_ListFoldersResponse as ListFoldersResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n mediaSiteMediaV1Folder_universal_d_SearchFoldersRequest as SearchFoldersRequest,\n RootFolder$1 as RootFolder,\n mediaSiteMediaV1Folder_universal_d_SearchFoldersResponse as SearchFoldersResponse,\n mediaSiteMediaV1Folder_universal_d_UpdateFolderRequest as UpdateFolderRequest,\n mediaSiteMediaV1Folder_universal_d_UpdateFolderResponse as UpdateFolderResponse,\n UnsupportedRequestValueError$1 as UnsupportedRequestValueError,\n mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlRequest as GenerateFolderDownloadUrlRequest,\n mediaSiteMediaV1Folder_universal_d_GenerateFolderDownloadUrlResponse as GenerateFolderDownloadUrlResponse,\n mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersRequest as BulkDeleteFoldersRequest,\n mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersResponse as BulkDeleteFoldersResponse,\n mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinRequest as BulkRestoreFoldersFromTrashBinRequest,\n mediaSiteMediaV1Folder_universal_d_BulkRestoreFoldersFromTrashBinResponse as BulkRestoreFoldersFromTrashBinResponse,\n mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersRequest as ListDeletedFoldersRequest,\n mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersResponse as ListDeletedFoldersResponse,\n mediaSiteMediaV1Folder_universal_d_DomainEvent as DomainEvent,\n mediaSiteMediaV1Folder_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n mediaSiteMediaV1Folder_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n mediaSiteMediaV1Folder_universal_d_RestoreInfo as RestoreInfo,\n mediaSiteMediaV1Folder_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n mediaSiteMediaV1Folder_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n mediaSiteMediaV1Folder_universal_d_ActionEvent as ActionEvent,\n mediaSiteMediaV1Folder_universal_d_MessageEnvelope as MessageEnvelope,\n mediaSiteMediaV1Folder_universal_d_IdentificationData as IdentificationData,\n mediaSiteMediaV1Folder_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n mediaSiteMediaV1Folder_universal_d_WebhookIdentityType as WebhookIdentityType,\n mediaSiteMediaV1Folder_universal_d_createFolder as createFolder,\n mediaSiteMediaV1Folder_universal_d_CreateFolderOptions as CreateFolderOptions,\n mediaSiteMediaV1Folder_universal_d_getFolder as getFolder,\n mediaSiteMediaV1Folder_universal_d_listFolders as listFolders,\n mediaSiteMediaV1Folder_universal_d_ListFoldersOptions as ListFoldersOptions,\n mediaSiteMediaV1Folder_universal_d_searchFolders as searchFolders,\n mediaSiteMediaV1Folder_universal_d_SearchFoldersOptions as SearchFoldersOptions,\n mediaSiteMediaV1Folder_universal_d_updateFolder as updateFolder,\n mediaSiteMediaV1Folder_universal_d_UpdateFolder as UpdateFolder,\n mediaSiteMediaV1Folder_universal_d_UpdateFolderOptions as UpdateFolderOptions,\n mediaSiteMediaV1Folder_universal_d_generateFolderDownloadUrl as generateFolderDownloadUrl,\n mediaSiteMediaV1Folder_universal_d_bulkDeleteFolders as bulkDeleteFolders,\n mediaSiteMediaV1Folder_universal_d_BulkDeleteFoldersOptions as BulkDeleteFoldersOptions,\n mediaSiteMediaV1Folder_universal_d_bulkRestoreFoldersFromTrashBin as bulkRestoreFoldersFromTrashBin,\n mediaSiteMediaV1Folder_universal_d_listDeletedFolders as listDeletedFolders,\n mediaSiteMediaV1Folder_universal_d_ListDeletedFoldersOptions as ListDeletedFoldersOptions,\n };\n }\n \n interface StorageInfo {\n }\n interface ListStorageFilesRequest {\n /** File media type. */\n mediaTypes?: MediaType[];\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * * `lastUsedDate`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n /** Get files with update date greater than set value */\n fromUpdatedDate?: Date | null;\n /** Get files with update date lower than set value */\n toUpdatedDate?: Date | null;\n /**\n * Get files with size greater than set value\n * @readonly\n */\n fromSizeInBytes?: string | null;\n /**\n * Get files with size greater than set value\n * @readonly\n */\n toSizeInBytes?: string | null;\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 /** Get files that were added by the provided entity */\n addedBy?: IdentityInfo;\n /**\n * A list of root folders.
      \n * Default: empty list will get files from all root folders.\n */\n rootFolders?: RootFolder[];\n /**\n * A list of namespaces to list files from
      \n * Default: empty list will get files from all root folders.\n * Note - Namespace value `Others` is not supported in this request and will produce an error\n */\n namespaces?: Namespace[];\n /** Get files with update date greater than set value */\n fromLastUsedDate?: Date | null;\n /** Get files with update date lower than set value */\n toLastUsedDate?: Date | null;\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 ICON = \"ICON\",\n FLASH = \"FLASH\",\n FONT = \"FONT\"\n }\n interface Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 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 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 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 /** _nsDraft */\n DRAFTS = \"DRAFTS\"\n }\n interface ListStorageFilesResponse {\n /** List of files in the Media Manager. */\n files?: FileDescriptor[];\n /** The next cursor if it exists. */\n nextCursor?: PagingMetadataV2;\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 file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).\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 Wix 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 | null;\n /**\n * Date and time the file was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 * Internal tags describing the item, can be used in specific client use cases\n * @internal\n */\n internalTags?: string[];\n /**\n * The namespace containing the file\n * @internal\n */\n namespace?: Namespace;\n /**\n * Information about the identity that added this file\n * @internal\n */\n addedBy?: IdentityInfo;\n /**\n * The raw namespace containing the file\n * @internal\n * @readonly\n */\n rawNamespace?: string | null;\n /**\n * The date this file was last viewed from the last day, can be used to know if this file is still in use\n * @internal\n * @readonly\n */\n lastUsedDate?: Date | null;\n /**\n * The date this file was last viewed from the last day, can be used to know if this file is still in use\n * @internal\n * @readonly\n */\n mimeType?: string | null;\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 * Information about other file types\n * @internal\n */\n other?: OtherMedia;\n /**\n * Information about the icon.\n * @internal\n */\n icon?: ImageMedia;\n /**\n * Information about flash\n * @internal\n */\n flash?: OtherMedia;\n /**\n * Information about the font\n * @internal\n */\n font?: FontMedia;\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 * Information about other file types\n * @internal\n */\n other?: OtherMedia;\n /**\n * Information about the icon.\n * @internal\n */\n icon?: ImageMedia;\n /**\n * Information about flash\n * @internal\n */\n flash?: OtherMedia;\n /**\n * Information about the font\n * @internal\n */\n font?: FontMedia;\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 * Optional, return true or false if the image has text, or empty for unknown\n * @internal\n * @readonly\n */\n containsText?: boolean | null;\n /**\n * Optional, return true or false if the image has text, or empty for unknown\n * @internal\n * @readonly\n */\n animated?: boolean | 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 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 * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\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 * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\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 | null;\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 | null;\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: 'package', 'raw'\n * @readonly\n */\n internalMediaType?: string | null;\n /**\n * size in bytes. Optional.\n * @readonly\n */\n sizeInBytes?: string | null;\n /** The file URL. */\n url?: string;\n }\n interface FontMedia {\n /** WixMedia ID. for use with Site Media APIs only */\n _id?: string | null;\n /**\n * size in bytes. Optional.\n * @readonly\n */\n sizeInBytes?: string | null;\n /** The format of the font asset. ttf, woff, woff2 */\n format?: string | null;\n /** The font family name. */\n family?: string | null;\n /** The font name */\n fontName?: string | null;\n /** Font formats available for this file. */\n assets?: FontAsset[];\n }\n interface FontAsset {\n /**\n * Keys for downloading different assets of a file.\n * Default: `src`, key representing the original file's format and quality.\n */\n assetKey?: string | null;\n /** The URL of the font asset. */\n url?: string | null;\n /** The format of the font asset. ttf, woff, woff2 */\n format?: 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 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 * 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 * @internal\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 }\n interface UnsupportedRequestValueError {\n /** Optional A list of allowed values */\n allowedValues?: string[];\n /** The unsupported value send in the request */\n requestValue?: string;\n }\n interface GetSiteStorageRequest {\n }\n interface GetSiteStorageResponse {\n /** Site level storage details */\n total?: StorageDetails;\n /** Storage information about big files */\n bigFiles?: StorageDetails;\n /** Trash storage details */\n trash?: StorageDetails;\n /** Storage information by media types for public files */\n storageByMediaType?: MediaTypeStorageDetails[];\n /**\n * The last date the storage information was calculated\n * @readonly\n */\n _updatedDate?: Date | null;\n /** The quota details */\n quota?: TotalQuota;\n /** The user id of the site owner - use this id to identify files uploaded by the current site owner */\n siteOwnerInfo?: IdentityInfo;\n }\n /** Information about storage */\n interface StorageDetails {\n /** The number of files */\n fileCount?: number | null;\n /**\n * The size of the stored files in bytes\n * @readonly\n */\n sizeInBytes?: string | null;\n }\n /** Storage information of a specific media type */\n interface MediaTypeStorageDetails {\n /** The media type */\n mediaType?: MediaType;\n /** Storage details about the media type */\n details?: StorageDetails;\n }\n interface TotalQuota {\n /** Storage quota in bytes */\n storage?: string | null;\n /** Plans that are related to the quota */\n plans?: Plans;\n /** Time for which the quota is relevant - When the plans were retrieved from premium */\n timestamp?: Date | null;\n }\n interface Plans {\n /** Premium Plan */\n premium?: Plan;\n /** Upgrade URL - the URL which a site owner can use to upgrade their quota. May be empty if an upgrade is not available. */\n upgradeUrl?: string;\n }\n interface Plan {\n /**\n * Plan ID - Premium product ID\n * @readonly\n */\n _id?: string;\n /** Plan name */\n name?: string;\n /** When the plan was created */\n createdAt?: Date | null;\n /** When then plan expires */\n expiresAt?: Date | null;\n }\n /**\n * Retrieves a list of files in the Media Manager.\n *\n * To retrieve a list of files from all the folders in the Media Manager\n * @internal\n * @documentationMaturity preview\n * @permissionId MEDIA.SITE_MEDIA_FILES_LIST\n * @adminMethod\n */\n function listStorageFiles(options?: ListStorageFilesOptions): Promise;\n interface ListStorageFilesOptions {\n /** File media type. */\n mediaTypes?: MediaType[];\n /**\n * Field name and order to sort by. One of:
      \n * * `displayName`\n * * `updatedDate`\n * * `sizeInBytes`\n * * `lastUsedDate`\n * Default: `updatedDate` in `desc` order.\n */\n sort?: Sorting;\n /** Cursor and paging information. */\n paging?: CursorPaging;\n /** Get files with update date greater than set value */\n fromUpdatedDate?: Date | null;\n /** Get files with update date lower than set value */\n toUpdatedDate?: Date | null;\n /**\n * Get files with size greater than set value\n * @readonly\n */\n fromSizeInBytes?: string | null;\n /**\n * Get files with size greater than set value\n * @readonly\n */\n toSizeInBytes?: string | null;\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 /** Get files that were added by the provided entity */\n addedBy?: IdentityInfo;\n /**\n * A list of root folders.
      \n * Default: empty list will get files from all root folders.\n */\n rootFolders?: RootFolder[];\n /**\n * A list of namespaces to list files from
      \n * Default: empty list will get files from all root folders.\n * Note - Namespace value `Others` is not supported in this request and will produce an error\n */\n namespaces?: Namespace[];\n /** Get files with update date greater than set value */\n fromLastUsedDate?: Date | null;\n /** Get files with update date lower than set value */\n toLastUsedDate?: Date | null;\n }\n /**\n * Get information about the site storage\n * @internal\n * @documentationMaturity preview\n * @permissionId MEDIA.SITE_MEDIA_STORAGE_READ\n * @adminMethod\n */\n function getSiteStorage(): Promise;\n \n type mediaSiteMediaV1StorageInfo_universal_d_StorageInfo = StorageInfo;\n type mediaSiteMediaV1StorageInfo_universal_d_ListStorageFilesRequest = ListStorageFilesRequest;\n type mediaSiteMediaV1StorageInfo_universal_d_MediaType = MediaType;\n const mediaSiteMediaV1StorageInfo_universal_d_MediaType: typeof MediaType;\n type mediaSiteMediaV1StorageInfo_universal_d_Sorting = Sorting;\n type mediaSiteMediaV1StorageInfo_universal_d_SortOrder = SortOrder;\n const mediaSiteMediaV1StorageInfo_universal_d_SortOrder: typeof SortOrder;\n type mediaSiteMediaV1StorageInfo_universal_d_CursorPaging = CursorPaging;\n type mediaSiteMediaV1StorageInfo_universal_d_IdentityInfo = IdentityInfo;\n type mediaSiteMediaV1StorageInfo_universal_d_IdentityType = IdentityType;\n const mediaSiteMediaV1StorageInfo_universal_d_IdentityType: typeof IdentityType;\n type mediaSiteMediaV1StorageInfo_universal_d_RootFolder = RootFolder;\n const mediaSiteMediaV1StorageInfo_universal_d_RootFolder: typeof RootFolder;\n type mediaSiteMediaV1StorageInfo_universal_d_Namespace = Namespace;\n const mediaSiteMediaV1StorageInfo_universal_d_Namespace: typeof Namespace;\n type mediaSiteMediaV1StorageInfo_universal_d_ListStorageFilesResponse = ListStorageFilesResponse;\n type mediaSiteMediaV1StorageInfo_universal_d_FileDescriptor = FileDescriptor;\n type mediaSiteMediaV1StorageInfo_universal_d_FileMedia = FileMedia;\n type mediaSiteMediaV1StorageInfo_universal_d_FileMediaMediaOneOf = FileMediaMediaOneOf;\n type mediaSiteMediaV1StorageInfo_universal_d_ImageMedia = ImageMedia;\n type mediaSiteMediaV1StorageInfo_universal_d_FocalPoint = FocalPoint;\n type mediaSiteMediaV1StorageInfo_universal_d_Colors = Colors;\n type mediaSiteMediaV1StorageInfo_universal_d_Color = Color;\n type mediaSiteMediaV1StorageInfo_universal_d_ColorRGB = ColorRGB;\n type mediaSiteMediaV1StorageInfo_universal_d_FaceRecognition = FaceRecognition;\n type mediaSiteMediaV1StorageInfo_universal_d_VideoResolution = VideoResolution;\n type mediaSiteMediaV1StorageInfo_universal_d_AudioV2 = AudioV2;\n type mediaSiteMediaV1StorageInfo_universal_d_Archive = Archive;\n type mediaSiteMediaV1StorageInfo_universal_d_Model3D = Model3D;\n type mediaSiteMediaV1StorageInfo_universal_d_OtherMedia = OtherMedia;\n type mediaSiteMediaV1StorageInfo_universal_d_FontMedia = FontMedia;\n type mediaSiteMediaV1StorageInfo_universal_d_FontAsset = FontAsset;\n type mediaSiteMediaV1StorageInfo_universal_d_OperationStatus = OperationStatus;\n const mediaSiteMediaV1StorageInfo_universal_d_OperationStatus: typeof OperationStatus;\n type mediaSiteMediaV1StorageInfo_universal_d_State = State;\n const mediaSiteMediaV1StorageInfo_universal_d_State: typeof State;\n type mediaSiteMediaV1StorageInfo_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type mediaSiteMediaV1StorageInfo_universal_d_Cursors = Cursors;\n type mediaSiteMediaV1StorageInfo_universal_d_UnsupportedRequestValueError = UnsupportedRequestValueError;\n type mediaSiteMediaV1StorageInfo_universal_d_GetSiteStorageRequest = GetSiteStorageRequest;\n type mediaSiteMediaV1StorageInfo_universal_d_GetSiteStorageResponse = GetSiteStorageResponse;\n type mediaSiteMediaV1StorageInfo_universal_d_StorageDetails = StorageDetails;\n type mediaSiteMediaV1StorageInfo_universal_d_MediaTypeStorageDetails = MediaTypeStorageDetails;\n type mediaSiteMediaV1StorageInfo_universal_d_TotalQuota = TotalQuota;\n type mediaSiteMediaV1StorageInfo_universal_d_Plans = Plans;\n type mediaSiteMediaV1StorageInfo_universal_d_Plan = Plan;\n const mediaSiteMediaV1StorageInfo_universal_d_listStorageFiles: typeof listStorageFiles;\n type mediaSiteMediaV1StorageInfo_universal_d_ListStorageFilesOptions = ListStorageFilesOptions;\n const mediaSiteMediaV1StorageInfo_universal_d_getSiteStorage: typeof getSiteStorage;\n namespace mediaSiteMediaV1StorageInfo_universal_d {\n export {\n mediaSiteMediaV1StorageInfo_universal_d_StorageInfo as StorageInfo,\n mediaSiteMediaV1StorageInfo_universal_d_ListStorageFilesRequest as ListStorageFilesRequest,\n mediaSiteMediaV1StorageInfo_universal_d_MediaType as MediaType,\n mediaSiteMediaV1StorageInfo_universal_d_Sorting as Sorting,\n mediaSiteMediaV1StorageInfo_universal_d_SortOrder as SortOrder,\n mediaSiteMediaV1StorageInfo_universal_d_CursorPaging as CursorPaging,\n mediaSiteMediaV1StorageInfo_universal_d_IdentityInfo as IdentityInfo,\n mediaSiteMediaV1StorageInfo_universal_d_IdentityType as IdentityType,\n mediaSiteMediaV1StorageInfo_universal_d_RootFolder as RootFolder,\n mediaSiteMediaV1StorageInfo_universal_d_Namespace as Namespace,\n mediaSiteMediaV1StorageInfo_universal_d_ListStorageFilesResponse as ListStorageFilesResponse,\n mediaSiteMediaV1StorageInfo_universal_d_FileDescriptor as FileDescriptor,\n mediaSiteMediaV1StorageInfo_universal_d_FileMedia as FileMedia,\n mediaSiteMediaV1StorageInfo_universal_d_FileMediaMediaOneOf as FileMediaMediaOneOf,\n mediaSiteMediaV1StorageInfo_universal_d_ImageMedia as ImageMedia,\n mediaSiteMediaV1StorageInfo_universal_d_FocalPoint as FocalPoint,\n mediaSiteMediaV1StorageInfo_universal_d_Colors as Colors,\n mediaSiteMediaV1StorageInfo_universal_d_Color as Color,\n mediaSiteMediaV1StorageInfo_universal_d_ColorRGB as ColorRGB,\n mediaSiteMediaV1StorageInfo_universal_d_FaceRecognition as FaceRecognition,\n mediaSiteMediaV1StorageInfo_universal_d_VideoResolution as VideoResolution,\n mediaSiteMediaV1StorageInfo_universal_d_AudioV2 as AudioV2,\n mediaSiteMediaV1StorageInfo_universal_d_Archive as Archive,\n mediaSiteMediaV1StorageInfo_universal_d_Model3D as Model3D,\n mediaSiteMediaV1StorageInfo_universal_d_OtherMedia as OtherMedia,\n mediaSiteMediaV1StorageInfo_universal_d_FontMedia as FontMedia,\n mediaSiteMediaV1StorageInfo_universal_d_FontAsset as FontAsset,\n mediaSiteMediaV1StorageInfo_universal_d_OperationStatus as OperationStatus,\n mediaSiteMediaV1StorageInfo_universal_d_State as State,\n mediaSiteMediaV1StorageInfo_universal_d_PagingMetadataV2 as PagingMetadataV2,\n mediaSiteMediaV1StorageInfo_universal_d_Cursors as Cursors,\n mediaSiteMediaV1StorageInfo_universal_d_UnsupportedRequestValueError as UnsupportedRequestValueError,\n mediaSiteMediaV1StorageInfo_universal_d_GetSiteStorageRequest as GetSiteStorageRequest,\n mediaSiteMediaV1StorageInfo_universal_d_GetSiteStorageResponse as GetSiteStorageResponse,\n mediaSiteMediaV1StorageInfo_universal_d_StorageDetails as StorageDetails,\n mediaSiteMediaV1StorageInfo_universal_d_MediaTypeStorageDetails as MediaTypeStorageDetails,\n mediaSiteMediaV1StorageInfo_universal_d_TotalQuota as TotalQuota,\n mediaSiteMediaV1StorageInfo_universal_d_Plans as Plans,\n mediaSiteMediaV1StorageInfo_universal_d_Plan as Plan,\n mediaSiteMediaV1StorageInfo_universal_d_listStorageFiles as listStorageFiles,\n mediaSiteMediaV1StorageInfo_universal_d_ListStorageFilesOptions as ListStorageFilesOptions,\n mediaSiteMediaV1StorageInfo_universal_d_getSiteStorage as getSiteStorage,\n };\n }\n \n export { mediaEnterprisePublicMediaV1EnterpriseCategory_universal_d as enterpriseMediaCategories, mediaEnterprisePublicMediaV1EnterpriseItem_universal_d as enterpriseMediaItems, mediaSiteMediaV1FileDescriptor_universal_d as files, mediaSiteMediaV1Folder_universal_d as folders, mediaGenerationV1GeneratedImage_universal_d as generation, mediaSiteMediaV1StorageInfo_universal_d as storage };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-pricing-plans-backend.v2.d.ts", "content": "declare module \"wix-pricing-plans-backend.v2\" {\n const __debug$1: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\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. See here to\n * [learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_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. See [Plans for more information about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/introduction).\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. See here\n * for 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 * __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.\n * @readonly\n */\n priceDetails?: PriceDetails;\n /**\n * Order pricing model, price, and payment schedule.\n *\n * [Learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models).\n * @readonly\n */\n pricing?: PricingDetails;\n /**\n * How the order was processed. One of:\n * + `ONLINE`: The buyer purchased the plan using the site.\n * + `OFFLINE`: The buyer made a manual, offline purchase without using the site.\n * @readonly\n */\n type?: OrderType;\n /**\n * Method by which checkout was initiated on buyer's behalf.\n * @internal\n * @readonly\n */\n orderMethod?: OrderMethod;\n /**\n * Status of the order. One of:\n * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.\n * + `PENDING`: Order has been purchased and its start date is set in the future.\n * + `ACTIVE`: Order has been processed. The plan is available for use.\n * + `PAUSED`: Order, and use of the plan, is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order). The order, and use of the plan, can be [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order).\n * + `ENDED`: Order has completed its duration and is no longer available for use.\n * + `CANCELED`: Order has been [canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/cancel-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 site owner for offline orders. One of:\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 * @readonly\n */\n lastPaymentStatus?: PaymentStatus;\n /**\n * Start date and time for the ordered plan.\n * @readonly\n */\n startDate?: Date;\n /**\n * Current end date and time for the ordered plan.\n *\n * `endDate` may be updated over the course of an order. If the order is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order),\n * it will have a later `endDate` once it [resumes](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order). `endDate` may also be [postponed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/postpone-end-date).\n *\n * Omitted if the order is valid until canceled and still `ACTIVE`.\n * @readonly\n */\n endDate?: Date;\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;\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 * Past and current cycles for the order.\n * @internal\n * @readonly\n */\n cycles?: OrderCycle[];\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;\n /**\n * Date and time the order was updated.\n * @readonly\n */\n _updatedDate?: Date;\n /**\n * Reference to the form and its submission that was used in checkout.\n * @internal\n * @readonly\n */\n formData?: FormData;\n /**\n * TODO PPL-1357: Remove when migration to new status is completed\n * @internal\n */\n statusNew?: OrderStatus;\n }\n interface Buyer {\n /**\n * Member ID for a Wix site member. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members).\n * @readonly\n */\n memberId?: string;\n /**\n * Contact ID for a Wix site contact. See [Contacts to learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).\n * @readonly\n */\n contactId?: string;\n }\n interface PriceDetails extends PriceDetailsPricingModelOneOf {\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 /** 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 /** @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 /** Length of one payment cycle. */\n cycleDuration?: Duration$1;\n /**\n * Amount of payment cycles this subscription is valid for.\n *\n * `0` for unlimited or until-canceled.\n */\n cycleCount?: number | null;\n }\n /** A duration expressed in number of time units. */\n interface Duration$1 {\n /**\n * The amount of a duration `unit` in a single payment cycle.\n *\n * Currently limited to support only `1`.\n */\n count?: number | null;\n /** Unit of time for the cycle duration. */\n unit?: PeriodUnit$1;\n }\n enum PeriodUnit$1 {\n UNDEFINED = \"UNDEFINED\",\n DAY = \"DAY\",\n WEEK = \"WEEK\",\n MONTH = \"MONTH\",\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 /**\n * Pricing details for all pricing models.\n * @readonly\n */\n prices?: SpannedPrice[];\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 /** @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 /**\n * Coupon applied to the order.\n *\n * See Coupons [to learn more about coupons](https://dev.wix.com/api/rest/coupons).\n */\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 }\n enum OrderType {\n UNDEFINED = \"UNDEFINED\",\n /** Payments made by the buyer */\n ONLINE = \"ONLINE\",\n /** Payments managed manually by the site owner */\n OFFLINE = \"OFFLINE\"\n }\n enum OrderMethod {\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 /** Order status undefined */\n UNDEFINED = \"UNDEFINED\",\n /** Order created, but hasn't been paid for yet. Filtered out in ListOrders response by default. */\n DRAFT = \"DRAFT\",\n /** Order has been paid for, but the start date is in the future */\n PENDING = \"PENDING\",\n /** Order is active */\n ACTIVE = \"ACTIVE\",\n /** Order is paused until site owner resumes it */\n PAUSED = \"PAUSED\",\n /** Order has ended */\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;\n /**\n * Reason for the cancellation. One of:\n * + `OWNER_ACTION`: Site owner canceled the order.\n * + `MEMBER_ACTION`: Buyer initiated the cancellation.\n * + `PAYMENT_FAILURE`: Payment transaction failed.\n * + `PAYMENT_SETUP_FAILURE`: Buyer's payment details weren't set up correctly.\n * + `UNKNOWN`: Reason for the cancellation is unknown.\n */\n cause?: CancellationCause;\n /**\n * When the cancellation takes effect. Set when cancelling the order. One of:\n * + `IMMEDIATELY`: Cancellation occurs immediately and the buyer can no longer use the plan.\n * + `NEXT_PAYMENT_DATE`: Cancellation occurs at the next payment date and time. Buyer can continue to use the plan until that date and time.\n */\n effectiveAt?: CancellationEffectiveAt;\n }\n enum CancellationCause {\n /** Cancellation initiator undefined */\n UNDEFINED = \"UNDEFINED\",\n /** Order was canceled by site owner (default if canceled by user or service identity) */\n OWNER_ACTION = \"OWNER_ACTION\",\n /** Order was canceled by member (default if canceled by member identity) */\n MEMBER_ACTION = \"MEMBER_ACTION\",\n /** Order was canceled because of payment failure */\n PAYMENT_FAILURE = \"PAYMENT_FAILURE\",\n /** Order was canceled because of payment setup failure */\n PAYMENT_SETUP_FAILURE = \"PAYMENT_SETUP_FAILURE\",\n /** Order was cancelled because of an unknown reason. It's not possible to know with certain payment providers (e.g. paypal) */\n UNKNOWN = \"UNKNOWN\"\n }\n enum CancellationEffectiveAt {\n /** Cancellation time undefined */\n UNDEFINED = \"UNDEFINED\",\n /** Will cancel the order now, i.e. update validUntil to the current date */\n IMMEDIATELY = \"IMMEDIATELY\",\n /** Will cancel the order at the date when next payment should have been made */\n NEXT_PAYMENT_DATE = \"NEXT_PAYMENT_DATE\"\n }\n enum PaymentStatus {\n /** Payment status undefined */\n UNDEFINED = \"UNDEFINED\",\n /** Payment has been paid */\n PAID = \"PAID\",\n /** Payment has been refunded */\n REFUNDED = \"REFUNDED\",\n /** Recurring payment has failed */\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. Can happen for free trial and PayPal */\n PENDING = \"PENDING\",\n /** Used in cases where the plan is free */\n NOT_APPLICABLE = \"NOT_APPLICABLE\"\n }\n interface PausePeriod {\n /**\n * Status of the pause period. One of:\n *\n * + `ACTIVE`: Status while the order is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).\n * + `ENDED`: Status when the order is [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order).\n */\n status?: Status;\n /** Start date and time of the pause period. */\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 enum Status {\n UNDEFINED = \"UNDEFINED\",\n /** Order suspension is active */\n ACTIVE = \"ACTIVE\",\n /** Order suspension has ended */\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;\n /** End date and time for the current payment cycle. */\n endedDate?: Date;\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;\n /** End date and time for this order cycle. */\n endedDate?: Date;\n }\n interface FormData {\n /** Reference to the form which was used to gather additional data in checkout. */\n formId?: string | null;\n /** Reference to the submission of the form. */\n submissionId?: string | null;\n /**\n * Data submitted to the form at checkout.\n * This field is only returned when `FieldSet.FULL` is specified when fetching the data\n * @readonly\n */\n submissionData?: Record;\n }\n interface MemberGetOrderRequest {\n /** Order ID. */\n _id: string;\n fieldSet?: Set;\n }\n enum Set {\n /** Same behavior as BASIC */\n UNKNOWN_SET = \"UNKNOWN_SET\",\n /**\n * Returns fields of the entity that are available in the database.\n * By default a field is available in the database unless explicitly specified in the documentation\n */\n BASIC = \"BASIC\",\n /**\n * Returns all fields in the entity.\n * This might make additional calls to gather the full entity\n */\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. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\n sorting?: Sorting$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 MemberListOrdersResponse {\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 * 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 * @internal\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 /**\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](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).\n */\n interface QueryOrdersRequest {\n query?: QueryV2$1;\n }\n interface QueryV2$1 extends QueryV2PagingMethodOneOf {\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 /** 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 /** @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 /** 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 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 CreateOnlineOrderRequest {\n /** Plan ID. */\n planId: string;\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Provided if checkout is initiated on buyer's behalf. */\n onBehalf?: OnBehalf;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n interface OnBehalf {\n /** Member ID. */\n memberId?: string;\n /** Method by which checkout is initiated on buyer's behalf */\n orderMethod?: OrderMethod;\n }\n interface CreateOnlineOrderResponse {\n /** Order. */\n order?: Order;\n }\n interface CouponsError {\n couponCode?: string;\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;\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. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */\n planId: string;\n /** ID of the member ordering the plan. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */\n memberId: string;\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 | null;\n /**\n * Coupon code to apply.\n *\n * See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).\n */\n couponCode?: string | null;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n interface CreateOfflineOrderResponse {\n /** Order. */\n order?: Order;\n }\n interface GetOnlineOrderPreviewRequest {\n /** Plan ID. */\n planId: string;\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date;\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n interface GetOnlineOrderPreviewResponse {\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 member.\n * Always false for plans without purchase limits.\n */\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;\n /** Coupon code to apply. */\n couponCode?: string | null;\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. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */\n planId: string;\n /** Member ID of the buyer the previewed order is for. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */\n memberId: string;\n /**\n * Start date and time for plan of the previewed order.\n *\n * Default: Current date and time\n */\n startDate?: Date;\n /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */\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 /**\n * Coupon code to apply.\n *\n * See Coupons [to learn more](https://dev.wix.com/api/rest/coupons).\n */\n couponCode?: string | null;\n }\n interface GetPricePreviewResponse {\n /** __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022. */\n price?: PriceDetails;\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;\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 orderId: string;\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 fieldSet?: Set;\n }\n interface GetOrderResponse {\n /** Order. */\n order?: Order;\n }\n interface ListOrdersRequest {\n /** Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members). */\n buyerIds?: string[];\n /** Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */\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 [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_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 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 /** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\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 /** Reason unknown */\n UNDEFINED = \"UNDEFINED\",\n /** Saved in the database but is awaiting payment. Non-active orders cannot be suspended */\n PENDING = \"PENDING\",\n /** Trial orders cannot be suspended */\n TRIAL = \"TRIAL\",\n /** Canceled orders cannot be suspended */\n CANCELED = \"CANCELED\",\n /** Ended orders cannot be suspended */\n ENDED = \"ENDED\",\n /** Paid for orders with future start dates cannot 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 cannot 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;\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 results?: BulkOrderResult[];\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n interface BulkOrderResult {\n itemMetadata?: ItemMetadata$1;\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 results?: BulkOrderResult[];\n bulkActionMetadata?: BulkActionMetadata$1;\n }\n /**\n * Retrieves an order by ID.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise;\n interface MemberGetOrderOptions {\n fieldSet?: Set;\n }\n /**\n * Returns orders for currently logged in member.\n * @public\n * @documentationMaturity preview\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. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\n sorting?: Sorting$1;\n }\n /**\n * Returns orders for currently logged in member based on provided query\n * @internal\n * @documentationMaturity preview\n */\n function memberQueryOrders(options?: MemberQueryOrdersOptions): Promise;\n interface MemberQueryOrdersOptions {\n query?: QueryV2$1;\n }\n /**\n * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date.\n * One time orders can only be canceled immediately.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function requestCancellation(_id: string, options?: RequestCancellationOptions): Promise;\n interface RequestCancellationOptions {\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 /**\n * Creates an order and initiates payment for currently logged in member.\n * Will not be exposed to 3rd parties until Wix Payments are exposed.\n * @param planId - Plan ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.onBehalf.memberId\n * @requiredField planId\n */\n function createOnlineOrder(planId: string, options?: CreateOnlineOrderOptions): Promise;\n interface CreateOnlineOrderOptions {\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date;\n /** Coupon code to apply. */\n couponCode?: string | null;\n /** Provided if checkout is initiated on buyer's behalf. */\n onBehalf?: OnBehalf;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n /**\n * Creates an order and initiates payment for currently logged in member.\n * Will not be exposed to 3rd parties until Wix Payments are exposed.\n * @param planId - Plan ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.captcha\n * @requiredField options.captcha.token\n * @requiredField options.guest\n * @requiredField options.guest.email\n * @requiredField planId\n */\n function createGuestOnlineOrder(planId: string, options?: CreateGuestOnlineOrderOptions): Promise;\n interface CreateGuestOnlineOrderOptions {\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date;\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 `offline` in `type`. 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 * Handle payment for an offline order in 1 of 2 ways:\n * + When creating the order, select `true` in the `paid` request parameter.\n * + After creation, use [Mark As Paid to mark the order as paid](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/mark-as-paid).\n * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).\n * @public\n * @documentationMaturity preview\n * @requiredField options.memberId\n * @requiredField planId\n */\n function createOfflineOrder(planId: string, options?: CreateOfflineOrderOptions): Promise;\n interface CreateOfflineOrderOptions {\n /** ID of the member ordering the plan. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */\n memberId: string;\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 | null;\n /**\n * Coupon code to apply.\n *\n * See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).\n */\n couponCode?: string | null;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n /**\n * Forms an order preview using same logic as purchasing, except that it is not persisted anywhere.\n * Checks for purchase limitations, intended to be called with member identity.\n * [More information on tax here](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n * Will not be exposed until CreateOnlineOrder is exposed.\n * @param planId - Plan ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField planId\n */\n function getOnlineOrderPreview(planId: string, options?: GetOnlineOrderPreviewOptions): Promise;\n interface GetOnlineOrderPreviewOptions {\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date;\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n /**\n * Forms an order preview using same logic as purchasing, except that it is not persisted anywhere.\n * Checks for purchase limitations\n * [More information on tax here](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n * Will not be exposed until CreateGuestOnlineOrder is exposed.\n * @param planId - Plan ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.email\n * @requiredField planId\n */\n function getGuestOnlineOrderPreview(planId: string, options?: GetGuestOnlineOrderPreviewOptions): Promise;\n interface GetGuestOnlineOrderPreviewOptions {\n /**\n * Start date for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date;\n /** Coupon code to apply. */\n couponCode?: string | null;\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, use [Get Price Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-price-preview).\n * @param planId - ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).\n * @public\n * @documentationMaturity preview\n * @requiredField options.memberId\n * @requiredField planId\n */\n function getOfflineOrderPreview(planId: string, options?: GetOfflineOrderPreviewOptions): Promise;\n interface GetOfflineOrderPreviewOptions {\n /** Member ID of the buyer the previewed order is for. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */\n memberId: string;\n /**\n * Start date and time for plan of the previewed order.\n *\n * Default: Current date and time\n */\n startDate?: Date;\n /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */\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](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models) format used for orders.\n *\n * Buyers do not have to be logged in to preview the price, as such, the details returned are not buyer-specific. To\n * generate a preview of a purchase for a specific buyer, use [Get Offline Order Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-offline-order-preview).\n * @param planId - ID of plan to preview.\n * @public\n * @documentationMaturity preview\n * @requiredField planId\n */\n function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise;\n interface GetPricePreviewOptions {\n /**\n * Coupon code to apply.\n *\n * See Coupons [to learn more](https://dev.wix.com/api/rest/coupons).\n */\n couponCode?: string | null;\n }\n /**\n * Changes the start date of a draft order.\n * @param orderId - Draft order ID.\n * @param startDate - New valid from date (timestamp).\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField startDate\n */\n function changeStartDate(orderId: string, startDate: Date): Promise;\n /**\n * Applies a coupon to an order and recalculates tax if needed. Should be called at the last moment before the payment.\n * If you don't want to make change to an order and only want to see the plan price with applied coupon\n * you can use GetPricePreview, GetOnlineOrderPreview or GetOfflineOrderPreview endpoints with coupon code.\n * @param orderId - Draft order ID.\n * @param couponCode - Coupon code to apply.\n * @internal\n * @documentationMaturity preview\n * @requiredField couponCode\n * @requiredField orderId\n */\n function applyCoupon(orderId: string, couponCode: string): Promise;\n /**\n * Adds to a draft order reference to a submission. Member can only revise orders what were created by them.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField submissionId\n */\n function setSubmission(orderId: string, submissionId: string): Promise;\n /**\n * Retrieves an order by ID.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise;\n interface ManagementGetOrderOptions {\n fieldSet?: Set;\n }\n /**\n * Retrieves a list of orders and details, given the provided 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 * @documentationMaturity preview\n */\n function managementListOrders(options?: ManagementListOrdersOptions): Promise;\n interface ManagementListOrdersOptions {\n /** Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members). */\n buyerIds?: string[];\n /** Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */\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 [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_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 /**\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](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n */\n function managementQueryOrders(options?: ManagementQueryOrdersOptions): Promise;\n interface ManagementQueryOrdersOptions {\n /** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\n query?: QueryV2$1;\n }\n /**\n * Retrieves statistics about the pricing plans orders. Currently providing the total number of orders and active orders.\n * @internal\n * @documentationMaturity preview\n */\n function getOrdersStats(): Promise;\n /** @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n */\n function getAvailableOrderActions(_id: string): Promise;\n /**\n * Extends the duration of a pricing plan order by postponing the order's `endDate`.\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 while it is [`PAUSED`](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function postponeEndDate(_id: string, options?: PostponeEndDateOptions): Promise;\n interface PostponeEndDateOptions {\n /**\n * New end date and time.\n *\n * Must be later than the current end date and time.\n */\n endDate?: Date;\n }\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 site owner cancels an ordered plan during the free trial period, they choose 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 * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function cancelOrder(_id: string, options?: CancelOrderOptions): Promise;\n interface CancelOrderOptions {\n /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */\n effectiveAt?: CancellationEffectiveAt;\n }\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.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function markAsPaid(_id: string): Promise;\n /**\n * Pauses an order.\n *\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`. Can only pause orders with an `ACTIVE` status.\n *\n * Use [Resume Order to resume a paused order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order/).\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function pauseOrder(_id: string): Promise;\n /**\n * Pauses multiple orders.\n * @param ids - List of Order IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n */\n function bulkPauseOrder(ids: string[], options?: BulkPauseOrderOptions): Promise;\n interface BulkPauseOrderOptions {\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n /**\n * Resumes a paused order.\n *\n * Updates `endDate` by adding the time the plan was paused.\n * For orders with recurring payments, it also restarts the payment schedule.\n * Use [Pause Order to pause an order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order/).\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function resumeOrder(_id: string): Promise;\n /**\n * Resumes multiple paused orders.\n * @param ids - List of Order IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n */\n function bulkResumeOrder(ids: string[], options?: BulkResumeOrderOptions): Promise;\n interface BulkResumeOrderOptions {\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n \n type pricingPlansV2Order_universal_d_Order = Order;\n type pricingPlansV2Order_universal_d_Buyer = Buyer;\n type pricingPlansV2Order_universal_d_PriceDetails = PriceDetails;\n type pricingPlansV2Order_universal_d_PriceDetailsPricingModelOneOf = PriceDetailsPricingModelOneOf;\n type pricingPlansV2Order_universal_d_Tax = Tax;\n type pricingPlansV2Order_universal_d_Coupon = Coupon;\n type pricingPlansV2Order_universal_d_PricingDetails = PricingDetails;\n type pricingPlansV2Order_universal_d_PricingDetailsPricingModelOneOf = PricingDetailsPricingModelOneOf;\n type pricingPlansV2Order_universal_d_SpannedPrice = SpannedPrice;\n type pricingPlansV2Order_universal_d_PriceDuration = PriceDuration;\n type pricingPlansV2Order_universal_d_Price = Price;\n type pricingPlansV2Order_universal_d_OrderType = OrderType;\n const pricingPlansV2Order_universal_d_OrderType: typeof OrderType;\n type pricingPlansV2Order_universal_d_OrderMethod = OrderMethod;\n const pricingPlansV2Order_universal_d_OrderMethod: typeof OrderMethod;\n type pricingPlansV2Order_universal_d_OrderStatus = OrderStatus;\n const pricingPlansV2Order_universal_d_OrderStatus: typeof OrderStatus;\n type pricingPlansV2Order_universal_d_Cancellation = Cancellation;\n type pricingPlansV2Order_universal_d_CancellationCause = CancellationCause;\n const pricingPlansV2Order_universal_d_CancellationCause: typeof CancellationCause;\n type pricingPlansV2Order_universal_d_CancellationEffectiveAt = CancellationEffectiveAt;\n const pricingPlansV2Order_universal_d_CancellationEffectiveAt: typeof CancellationEffectiveAt;\n type pricingPlansV2Order_universal_d_PaymentStatus = PaymentStatus;\n const pricingPlansV2Order_universal_d_PaymentStatus: typeof PaymentStatus;\n type pricingPlansV2Order_universal_d_PausePeriod = PausePeriod;\n type pricingPlansV2Order_universal_d_Status = Status;\n const pricingPlansV2Order_universal_d_Status: typeof Status;\n type pricingPlansV2Order_universal_d_CurrentCycle = CurrentCycle;\n type pricingPlansV2Order_universal_d_OrderCycle = OrderCycle;\n type pricingPlansV2Order_universal_d_FormData = FormData;\n type pricingPlansV2Order_universal_d_MemberGetOrderRequest = MemberGetOrderRequest;\n type pricingPlansV2Order_universal_d_Set = Set;\n const pricingPlansV2Order_universal_d_Set: typeof Set;\n type pricingPlansV2Order_universal_d_MemberGetOrderResponse = MemberGetOrderResponse;\n type pricingPlansV2Order_universal_d_MemberListOrdersRequest = MemberListOrdersRequest;\n type pricingPlansV2Order_universal_d_MemberListOrdersResponse = MemberListOrdersResponse;\n type pricingPlansV2Order_universal_d_QueryOrdersRequest = QueryOrdersRequest;\n type pricingPlansV2Order_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type pricingPlansV2Order_universal_d_CursorPaging = CursorPaging;\n type pricingPlansV2Order_universal_d_QueryOrdersResponse = QueryOrdersResponse;\n type pricingPlansV2Order_universal_d_RequestCancellationRequest = RequestCancellationRequest;\n type pricingPlansV2Order_universal_d_RequestCancellationResponse = RequestCancellationResponse;\n type pricingPlansV2Order_universal_d_OrderCanceled = OrderCanceled;\n type pricingPlansV2Order_universal_d_CreateOnlineOrderRequest = CreateOnlineOrderRequest;\n type pricingPlansV2Order_universal_d_OnBehalf = OnBehalf;\n type pricingPlansV2Order_universal_d_CreateOnlineOrderResponse = CreateOnlineOrderResponse;\n type pricingPlansV2Order_universal_d_CouponsError = CouponsError;\n type pricingPlansV2Order_universal_d_CreateGuestOnlineOrderRequest = CreateGuestOnlineOrderRequest;\n type pricingPlansV2Order_universal_d_Captcha = Captcha;\n type pricingPlansV2Order_universal_d_Guest = Guest;\n type pricingPlansV2Order_universal_d_CreateGuestOnlineOrderResponse = CreateGuestOnlineOrderResponse;\n type pricingPlansV2Order_universal_d_CreateOfflineOrderRequest = CreateOfflineOrderRequest;\n type pricingPlansV2Order_universal_d_CreateOfflineOrderResponse = CreateOfflineOrderResponse;\n type pricingPlansV2Order_universal_d_GetOnlineOrderPreviewRequest = GetOnlineOrderPreviewRequest;\n type pricingPlansV2Order_universal_d_GetOnlineOrderPreviewResponse = GetOnlineOrderPreviewResponse;\n type pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewRequest = GetGuestOnlineOrderPreviewRequest;\n type pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewResponse = GetGuestOnlineOrderPreviewResponse;\n type pricingPlansV2Order_universal_d_GetOfflineOrderPreviewRequest = GetOfflineOrderPreviewRequest;\n type pricingPlansV2Order_universal_d_GetOfflineOrderPreviewResponse = GetOfflineOrderPreviewResponse;\n type pricingPlansV2Order_universal_d_GetPricePreviewRequest = GetPricePreviewRequest;\n type pricingPlansV2Order_universal_d_GetPricePreviewResponse = GetPricePreviewResponse;\n type pricingPlansV2Order_universal_d_ChangeStartDateRequest = ChangeStartDateRequest;\n type pricingPlansV2Order_universal_d_ChangeStartDateResponse = ChangeStartDateResponse;\n type pricingPlansV2Order_universal_d_OrderStartDateChanged = OrderStartDateChanged;\n type pricingPlansV2Order_universal_d_ApplyCouponRequest = ApplyCouponRequest;\n type pricingPlansV2Order_universal_d_ApplyCouponResponse = ApplyCouponResponse;\n type pricingPlansV2Order_universal_d_SetSubmissionRequest = SetSubmissionRequest;\n type pricingPlansV2Order_universal_d_SetSubmissionResponse = SetSubmissionResponse;\n type pricingPlansV2Order_universal_d_OrderPurchased = OrderPurchased;\n type pricingPlansV2Order_universal_d_OrderStarted = OrderStarted;\n type pricingPlansV2Order_universal_d_OrderCycleStarted = OrderCycleStarted;\n type pricingPlansV2Order_universal_d_OrderAutoRenewCanceled = OrderAutoRenewCanceled;\n type pricingPlansV2Order_universal_d_OrderEnded = OrderEnded;\n type pricingPlansV2Order_universal_d_GetOrderRequest = GetOrderRequest;\n type pricingPlansV2Order_universal_d_GetOrderResponse = GetOrderResponse;\n type pricingPlansV2Order_universal_d_ListOrdersRequest = ListOrdersRequest;\n type pricingPlansV2Order_universal_d_ListOrdersResponse = ListOrdersResponse;\n type pricingPlansV2Order_universal_d_OrdersQueryOrdersRequest = OrdersQueryOrdersRequest;\n type pricingPlansV2Order_universal_d_OrdersQueryOrdersResponse = OrdersQueryOrdersResponse;\n type pricingPlansV2Order_universal_d_GetOrdersStatsRequest = GetOrdersStatsRequest;\n type pricingPlansV2Order_universal_d_GetOrdersStatsResponse = GetOrdersStatsResponse;\n type pricingPlansV2Order_universal_d_GetAvailableOrderActionsRequest = GetAvailableOrderActionsRequest;\n type pricingPlansV2Order_universal_d_GetAvailableOrderActionsResponse = GetAvailableOrderActionsResponse;\n type pricingPlansV2Order_universal_d_ReasonNotSuspendable = ReasonNotSuspendable;\n const pricingPlansV2Order_universal_d_ReasonNotSuspendable: typeof ReasonNotSuspendable;\n type pricingPlansV2Order_universal_d_PostponeEndDateRequest = PostponeEndDateRequest;\n type pricingPlansV2Order_universal_d_PostponeEndDateResponse = PostponeEndDateResponse;\n type pricingPlansV2Order_universal_d_OrderEndDatePostponed = OrderEndDatePostponed;\n type pricingPlansV2Order_universal_d_CancelOrderRequest = CancelOrderRequest;\n type pricingPlansV2Order_universal_d_CancelOrderResponse = CancelOrderResponse;\n type pricingPlansV2Order_universal_d_MarkAsPaidRequest = MarkAsPaidRequest;\n type pricingPlansV2Order_universal_d_MarkAsPaidResponse = MarkAsPaidResponse;\n type pricingPlansV2Order_universal_d_OrderMarkedAsPaid = OrderMarkedAsPaid;\n type pricingPlansV2Order_universal_d_PauseOrderRequest = PauseOrderRequest;\n type pricingPlansV2Order_universal_d_PauseOrderResponse = PauseOrderResponse;\n type pricingPlansV2Order_universal_d_OrderPaused = OrderPaused;\n type pricingPlansV2Order_universal_d_BulkPauseOrderRequest = BulkPauseOrderRequest;\n type pricingPlansV2Order_universal_d_BulkPauseOrderResponse = BulkPauseOrderResponse;\n type pricingPlansV2Order_universal_d_BulkOrderResult = BulkOrderResult;\n type pricingPlansV2Order_universal_d_ResumeOrderRequest = ResumeOrderRequest;\n type pricingPlansV2Order_universal_d_ResumeOrderResponse = ResumeOrderResponse;\n type pricingPlansV2Order_universal_d_OrderResumed = OrderResumed;\n type pricingPlansV2Order_universal_d_BulkResumeOrderRequest = BulkResumeOrderRequest;\n type pricingPlansV2Order_universal_d_BulkResumeOrderResponse = BulkResumeOrderResponse;\n const pricingPlansV2Order_universal_d_memberGetOrder: typeof memberGetOrder;\n type pricingPlansV2Order_universal_d_MemberGetOrderOptions = MemberGetOrderOptions;\n const pricingPlansV2Order_universal_d_memberListOrders: typeof memberListOrders;\n type pricingPlansV2Order_universal_d_MemberListOrdersOptions = MemberListOrdersOptions;\n const pricingPlansV2Order_universal_d_memberQueryOrders: typeof memberQueryOrders;\n type pricingPlansV2Order_universal_d_MemberQueryOrdersOptions = MemberQueryOrdersOptions;\n const pricingPlansV2Order_universal_d_requestCancellation: typeof requestCancellation;\n type pricingPlansV2Order_universal_d_RequestCancellationOptions = RequestCancellationOptions;\n const pricingPlansV2Order_universal_d_createOnlineOrder: typeof createOnlineOrder;\n type pricingPlansV2Order_universal_d_CreateOnlineOrderOptions = CreateOnlineOrderOptions;\n const pricingPlansV2Order_universal_d_createGuestOnlineOrder: typeof createGuestOnlineOrder;\n type pricingPlansV2Order_universal_d_CreateGuestOnlineOrderOptions = CreateGuestOnlineOrderOptions;\n const pricingPlansV2Order_universal_d_createOfflineOrder: typeof createOfflineOrder;\n type pricingPlansV2Order_universal_d_CreateOfflineOrderOptions = CreateOfflineOrderOptions;\n const pricingPlansV2Order_universal_d_getOnlineOrderPreview: typeof getOnlineOrderPreview;\n type pricingPlansV2Order_universal_d_GetOnlineOrderPreviewOptions = GetOnlineOrderPreviewOptions;\n const pricingPlansV2Order_universal_d_getGuestOnlineOrderPreview: typeof getGuestOnlineOrderPreview;\n type pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewOptions = GetGuestOnlineOrderPreviewOptions;\n const pricingPlansV2Order_universal_d_getOfflineOrderPreview: typeof getOfflineOrderPreview;\n type pricingPlansV2Order_universal_d_GetOfflineOrderPreviewOptions = GetOfflineOrderPreviewOptions;\n const pricingPlansV2Order_universal_d_getPricePreview: typeof getPricePreview;\n type pricingPlansV2Order_universal_d_GetPricePreviewOptions = GetPricePreviewOptions;\n const pricingPlansV2Order_universal_d_changeStartDate: typeof changeStartDate;\n const pricingPlansV2Order_universal_d_applyCoupon: typeof applyCoupon;\n const pricingPlansV2Order_universal_d_setSubmission: typeof setSubmission;\n const pricingPlansV2Order_universal_d_managementGetOrder: typeof managementGetOrder;\n type pricingPlansV2Order_universal_d_ManagementGetOrderOptions = ManagementGetOrderOptions;\n const pricingPlansV2Order_universal_d_managementListOrders: typeof managementListOrders;\n type pricingPlansV2Order_universal_d_ManagementListOrdersOptions = ManagementListOrdersOptions;\n const pricingPlansV2Order_universal_d_managementQueryOrders: typeof managementQueryOrders;\n type pricingPlansV2Order_universal_d_ManagementQueryOrdersOptions = ManagementQueryOrdersOptions;\n const pricingPlansV2Order_universal_d_getOrdersStats: typeof getOrdersStats;\n const pricingPlansV2Order_universal_d_getAvailableOrderActions: typeof getAvailableOrderActions;\n const pricingPlansV2Order_universal_d_postponeEndDate: typeof postponeEndDate;\n type pricingPlansV2Order_universal_d_PostponeEndDateOptions = PostponeEndDateOptions;\n const pricingPlansV2Order_universal_d_cancelOrder: typeof cancelOrder;\n type pricingPlansV2Order_universal_d_CancelOrderOptions = CancelOrderOptions;\n const pricingPlansV2Order_universal_d_markAsPaid: typeof markAsPaid;\n const pricingPlansV2Order_universal_d_pauseOrder: typeof pauseOrder;\n const pricingPlansV2Order_universal_d_bulkPauseOrder: typeof bulkPauseOrder;\n type pricingPlansV2Order_universal_d_BulkPauseOrderOptions = BulkPauseOrderOptions;\n const pricingPlansV2Order_universal_d_resumeOrder: typeof resumeOrder;\n const pricingPlansV2Order_universal_d_bulkResumeOrder: typeof bulkResumeOrder;\n type pricingPlansV2Order_universal_d_BulkResumeOrderOptions = BulkResumeOrderOptions;\n namespace pricingPlansV2Order_universal_d {\n export {\n __debug$1 as __debug,\n pricingPlansV2Order_universal_d_Order as Order,\n pricingPlansV2Order_universal_d_Buyer as Buyer,\n pricingPlansV2Order_universal_d_PriceDetails as PriceDetails,\n pricingPlansV2Order_universal_d_PriceDetailsPricingModelOneOf as PriceDetailsPricingModelOneOf,\n pricingPlansV2Order_universal_d_Tax as Tax,\n Recurrence$1 as Recurrence,\n Duration$1 as Duration,\n PeriodUnit$1 as PeriodUnit,\n pricingPlansV2Order_universal_d_Coupon as Coupon,\n pricingPlansV2Order_universal_d_PricingDetails as PricingDetails,\n pricingPlansV2Order_universal_d_PricingDetailsPricingModelOneOf as PricingDetailsPricingModelOneOf,\n pricingPlansV2Order_universal_d_SpannedPrice as SpannedPrice,\n pricingPlansV2Order_universal_d_PriceDuration as PriceDuration,\n pricingPlansV2Order_universal_d_Price as Price,\n pricingPlansV2Order_universal_d_OrderType as OrderType,\n pricingPlansV2Order_universal_d_OrderMethod as OrderMethod,\n pricingPlansV2Order_universal_d_OrderStatus as OrderStatus,\n pricingPlansV2Order_universal_d_Cancellation as Cancellation,\n pricingPlansV2Order_universal_d_CancellationCause as CancellationCause,\n pricingPlansV2Order_universal_d_CancellationEffectiveAt as CancellationEffectiveAt,\n pricingPlansV2Order_universal_d_PaymentStatus as PaymentStatus,\n pricingPlansV2Order_universal_d_PausePeriod as PausePeriod,\n pricingPlansV2Order_universal_d_Status as Status,\n pricingPlansV2Order_universal_d_CurrentCycle as CurrentCycle,\n pricingPlansV2Order_universal_d_OrderCycle as OrderCycle,\n pricingPlansV2Order_universal_d_FormData as FormData,\n pricingPlansV2Order_universal_d_MemberGetOrderRequest as MemberGetOrderRequest,\n pricingPlansV2Order_universal_d_Set as Set,\n pricingPlansV2Order_universal_d_MemberGetOrderResponse as MemberGetOrderResponse,\n pricingPlansV2Order_universal_d_MemberListOrdersRequest as MemberListOrdersRequest,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n pricingPlansV2Order_universal_d_MemberListOrdersResponse as MemberListOrdersResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n pricingPlansV2Order_universal_d_QueryOrdersRequest as QueryOrdersRequest,\n QueryV2$1 as QueryV2,\n pricingPlansV2Order_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n Paging$1 as Paging,\n pricingPlansV2Order_universal_d_CursorPaging as CursorPaging,\n pricingPlansV2Order_universal_d_QueryOrdersResponse as QueryOrdersResponse,\n pricingPlansV2Order_universal_d_RequestCancellationRequest as RequestCancellationRequest,\n pricingPlansV2Order_universal_d_RequestCancellationResponse as RequestCancellationResponse,\n pricingPlansV2Order_universal_d_OrderCanceled as OrderCanceled,\n pricingPlansV2Order_universal_d_CreateOnlineOrderRequest as CreateOnlineOrderRequest,\n pricingPlansV2Order_universal_d_OnBehalf as OnBehalf,\n pricingPlansV2Order_universal_d_CreateOnlineOrderResponse as CreateOnlineOrderResponse,\n pricingPlansV2Order_universal_d_CouponsError as CouponsError,\n pricingPlansV2Order_universal_d_CreateGuestOnlineOrderRequest as CreateGuestOnlineOrderRequest,\n pricingPlansV2Order_universal_d_Captcha as Captcha,\n pricingPlansV2Order_universal_d_Guest as Guest,\n pricingPlansV2Order_universal_d_CreateGuestOnlineOrderResponse as CreateGuestOnlineOrderResponse,\n pricingPlansV2Order_universal_d_CreateOfflineOrderRequest as CreateOfflineOrderRequest,\n pricingPlansV2Order_universal_d_CreateOfflineOrderResponse as CreateOfflineOrderResponse,\n pricingPlansV2Order_universal_d_GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequest,\n pricingPlansV2Order_universal_d_GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponse,\n pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewRequest as GetGuestOnlineOrderPreviewRequest,\n pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewResponse as GetGuestOnlineOrderPreviewResponse,\n pricingPlansV2Order_universal_d_GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequest,\n pricingPlansV2Order_universal_d_GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponse,\n pricingPlansV2Order_universal_d_GetPricePreviewRequest as GetPricePreviewRequest,\n pricingPlansV2Order_universal_d_GetPricePreviewResponse as GetPricePreviewResponse,\n pricingPlansV2Order_universal_d_ChangeStartDateRequest as ChangeStartDateRequest,\n pricingPlansV2Order_universal_d_ChangeStartDateResponse as ChangeStartDateResponse,\n pricingPlansV2Order_universal_d_OrderStartDateChanged as OrderStartDateChanged,\n pricingPlansV2Order_universal_d_ApplyCouponRequest as ApplyCouponRequest,\n pricingPlansV2Order_universal_d_ApplyCouponResponse as ApplyCouponResponse,\n pricingPlansV2Order_universal_d_SetSubmissionRequest as SetSubmissionRequest,\n pricingPlansV2Order_universal_d_SetSubmissionResponse as SetSubmissionResponse,\n pricingPlansV2Order_universal_d_OrderPurchased as OrderPurchased,\n pricingPlansV2Order_universal_d_OrderStarted as OrderStarted,\n pricingPlansV2Order_universal_d_OrderCycleStarted as OrderCycleStarted,\n pricingPlansV2Order_universal_d_OrderAutoRenewCanceled as OrderAutoRenewCanceled,\n pricingPlansV2Order_universal_d_OrderEnded as OrderEnded,\n pricingPlansV2Order_universal_d_GetOrderRequest as GetOrderRequest,\n pricingPlansV2Order_universal_d_GetOrderResponse as GetOrderResponse,\n pricingPlansV2Order_universal_d_ListOrdersRequest as ListOrdersRequest,\n pricingPlansV2Order_universal_d_ListOrdersResponse as ListOrdersResponse,\n pricingPlansV2Order_universal_d_OrdersQueryOrdersRequest as OrdersQueryOrdersRequest,\n pricingPlansV2Order_universal_d_OrdersQueryOrdersResponse as OrdersQueryOrdersResponse,\n pricingPlansV2Order_universal_d_GetOrdersStatsRequest as GetOrdersStatsRequest,\n pricingPlansV2Order_universal_d_GetOrdersStatsResponse as GetOrdersStatsResponse,\n pricingPlansV2Order_universal_d_GetAvailableOrderActionsRequest as GetAvailableOrderActionsRequest,\n pricingPlansV2Order_universal_d_GetAvailableOrderActionsResponse as GetAvailableOrderActionsResponse,\n pricingPlansV2Order_universal_d_ReasonNotSuspendable as ReasonNotSuspendable,\n pricingPlansV2Order_universal_d_PostponeEndDateRequest as PostponeEndDateRequest,\n pricingPlansV2Order_universal_d_PostponeEndDateResponse as PostponeEndDateResponse,\n pricingPlansV2Order_universal_d_OrderEndDatePostponed as OrderEndDatePostponed,\n pricingPlansV2Order_universal_d_CancelOrderRequest as CancelOrderRequest,\n pricingPlansV2Order_universal_d_CancelOrderResponse as CancelOrderResponse,\n pricingPlansV2Order_universal_d_MarkAsPaidRequest as MarkAsPaidRequest,\n pricingPlansV2Order_universal_d_MarkAsPaidResponse as MarkAsPaidResponse,\n pricingPlansV2Order_universal_d_OrderMarkedAsPaid as OrderMarkedAsPaid,\n pricingPlansV2Order_universal_d_PauseOrderRequest as PauseOrderRequest,\n pricingPlansV2Order_universal_d_PauseOrderResponse as PauseOrderResponse,\n pricingPlansV2Order_universal_d_OrderPaused as OrderPaused,\n pricingPlansV2Order_universal_d_BulkPauseOrderRequest as BulkPauseOrderRequest,\n pricingPlansV2Order_universal_d_BulkPauseOrderResponse as BulkPauseOrderResponse,\n pricingPlansV2Order_universal_d_BulkOrderResult as BulkOrderResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n pricingPlansV2Order_universal_d_ResumeOrderRequest as ResumeOrderRequest,\n pricingPlansV2Order_universal_d_ResumeOrderResponse as ResumeOrderResponse,\n pricingPlansV2Order_universal_d_OrderResumed as OrderResumed,\n pricingPlansV2Order_universal_d_BulkResumeOrderRequest as BulkResumeOrderRequest,\n pricingPlansV2Order_universal_d_BulkResumeOrderResponse as BulkResumeOrderResponse,\n pricingPlansV2Order_universal_d_memberGetOrder as memberGetOrder,\n pricingPlansV2Order_universal_d_MemberGetOrderOptions as MemberGetOrderOptions,\n pricingPlansV2Order_universal_d_memberListOrders as memberListOrders,\n pricingPlansV2Order_universal_d_MemberListOrdersOptions as MemberListOrdersOptions,\n pricingPlansV2Order_universal_d_memberQueryOrders as memberQueryOrders,\n pricingPlansV2Order_universal_d_MemberQueryOrdersOptions as MemberQueryOrdersOptions,\n pricingPlansV2Order_universal_d_requestCancellation as requestCancellation,\n pricingPlansV2Order_universal_d_RequestCancellationOptions as RequestCancellationOptions,\n pricingPlansV2Order_universal_d_createOnlineOrder as createOnlineOrder,\n pricingPlansV2Order_universal_d_CreateOnlineOrderOptions as CreateOnlineOrderOptions,\n pricingPlansV2Order_universal_d_createGuestOnlineOrder as createGuestOnlineOrder,\n pricingPlansV2Order_universal_d_CreateGuestOnlineOrderOptions as CreateGuestOnlineOrderOptions,\n pricingPlansV2Order_universal_d_createOfflineOrder as createOfflineOrder,\n pricingPlansV2Order_universal_d_CreateOfflineOrderOptions as CreateOfflineOrderOptions,\n pricingPlansV2Order_universal_d_getOnlineOrderPreview as getOnlineOrderPreview,\n pricingPlansV2Order_universal_d_GetOnlineOrderPreviewOptions as GetOnlineOrderPreviewOptions,\n pricingPlansV2Order_universal_d_getGuestOnlineOrderPreview as getGuestOnlineOrderPreview,\n pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewOptions as GetGuestOnlineOrderPreviewOptions,\n pricingPlansV2Order_universal_d_getOfflineOrderPreview as getOfflineOrderPreview,\n pricingPlansV2Order_universal_d_GetOfflineOrderPreviewOptions as GetOfflineOrderPreviewOptions,\n pricingPlansV2Order_universal_d_getPricePreview as getPricePreview,\n pricingPlansV2Order_universal_d_GetPricePreviewOptions as GetPricePreviewOptions,\n pricingPlansV2Order_universal_d_changeStartDate as changeStartDate,\n pricingPlansV2Order_universal_d_applyCoupon as applyCoupon,\n pricingPlansV2Order_universal_d_setSubmission as setSubmission,\n pricingPlansV2Order_universal_d_managementGetOrder as managementGetOrder,\n pricingPlansV2Order_universal_d_ManagementGetOrderOptions as ManagementGetOrderOptions,\n pricingPlansV2Order_universal_d_managementListOrders as managementListOrders,\n pricingPlansV2Order_universal_d_ManagementListOrdersOptions as ManagementListOrdersOptions,\n pricingPlansV2Order_universal_d_managementQueryOrders as managementQueryOrders,\n pricingPlansV2Order_universal_d_ManagementQueryOrdersOptions as ManagementQueryOrdersOptions,\n pricingPlansV2Order_universal_d_getOrdersStats as getOrdersStats,\n pricingPlansV2Order_universal_d_getAvailableOrderActions as getAvailableOrderActions,\n pricingPlansV2Order_universal_d_postponeEndDate as postponeEndDate,\n pricingPlansV2Order_universal_d_PostponeEndDateOptions as PostponeEndDateOptions,\n pricingPlansV2Order_universal_d_cancelOrder as cancelOrder,\n pricingPlansV2Order_universal_d_CancelOrderOptions as CancelOrderOptions,\n pricingPlansV2Order_universal_d_markAsPaid as markAsPaid,\n pricingPlansV2Order_universal_d_pauseOrder as pauseOrder,\n pricingPlansV2Order_universal_d_bulkPauseOrder as bulkPauseOrder,\n pricingPlansV2Order_universal_d_BulkPauseOrderOptions as BulkPauseOrderOptions,\n pricingPlansV2Order_universal_d_resumeOrder as resumeOrder,\n pricingPlansV2Order_universal_d_bulkResumeOrder as bulkResumeOrder,\n pricingPlansV2Order_universal_d_BulkResumeOrderOptions as BulkResumeOrderOptions,\n };\n }\n \n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\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 /** 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 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.\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 /** 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 clientData?: Record;\n /** Reference to a form which is shown in checkout to gather additional data */\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 /** List of strings */\n values?: string[];\n }\n /** Plan pricing information. Includes the price of the plan and payment details. */\n interface Pricing extends PricingPricingModelOneOf {\n /** Amount for a single payment (or the whole subscription if it's not a recurring plan) */\n price?: Money;\n /** Free trial period for the plan in days. It’s available only for recurring plans. Set to 0 to remove free trial. */\n freeTrialDays?: number | null;\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 /** @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. */\n cycleDuration?: Duration;\n /**\n * Amount of payment cycles this subscription is valid for.\n *\n * `0` for unlimited or until-canceled.\n */\n cycleCount?: number | null;\n }\n /** A duration expressed in number of time units. */\n interface Duration {\n /**\n * The amount of a duration `unit` in a single payment cycle.\n *\n * Currently limited to support only `1`.\n */\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 (e.g., 3.99). */\n value?: string;\n /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */\n currency?: string;\n }\n interface BuyerCanCancelUpdated {\n plan?: Plan;\n }\n interface ListPublicPlansRequest {\n /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number | null;\n /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number | null;\n /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. 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 /** Object containing paging-related data (number of plans returned, offset). */\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 clientData?: Record;\n /** Reference to a form which is shown in checkout to gather additional data */\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 * 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 * @internal\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 QueryPublicPlansRequest {\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. */\n plan?: Plan;\n }\n interface ListPlansRequest {\n /** Archived filter. Defaults to ACTIVE (not archived) only. */\n archived?: ArchivedFilter;\n /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */\n public?: PublicFilter;\n /** Number of pricing plans to list. Defaults to 75. */\n limit?: number | null;\n /** Number of pricing plans to skip. Defaults to 0. */\n offset?: number | null;\n /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. 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 /** Object containing paging-related data (number of plans returned, offset). */\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 plan: Plan;\n }\n interface CreatePlanResponse {\n plan?: Plan;\n }\n interface UpdatePlanRequest {\n plan?: Plan;\n fieldMask?: string[];\n }\n interface UpdatePlanResponse {\n plan?: Plan;\n }\n interface SetPlanVisibilityRequest {\n _id: string;\n visible?: boolean;\n }\n interface SetPlanVisibilityResponse {\n plan?: Plan;\n }\n interface MakePlanPrimaryRequest {\n _id: string;\n }\n interface MakePlanPrimaryResponse {\n plan?: Plan;\n }\n interface ClearPrimaryRequest {\n }\n interface ClearPrimaryResponse {\n }\n interface ArchivePlanRequest {\n _id: string;\n }\n interface ArchivePlanResponse {\n plan?: Plan;\n }\n interface PlanArchived {\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 results?: BulkPlanResult[];\n bulkActionMetadata?: BulkActionMetadata;\n }\n interface BulkPlanResult {\n itemMetadata?: ItemMetadata;\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?: string[];\n }\n interface ArrangePlansResponse {\n }\n /**\n * Retrieves a list of up to 100 public pricing plans.\n * @public\n * @documentationMaturity preview\n */\n function listPublicPlans(options?: ListPublicPlansOptions): Promise;\n interface ListPublicPlansOptions {\n /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n limit?: number | null;\n /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */\n offset?: number | null;\n /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs. */\n planIds?: string[];\n }\n /**\n * Retrieves a list of up to 1,000 public pricing plans, given the provided pagination, [sorting, and filtering](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort).\n * @public\n * @documentationMaturity preview\n */\n function queryPublicPlans(options?: QueryPublicPlansOptions): Promise;\n interface QueryPublicPlansOptions {\n query?: QueryV2;\n }\n /**\n * Retrieves a pricing plan by ID.\n * @param _id - Plan ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function getPlan(_id: string): Promise;\n /**\n * Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).\n * @public\n * @documentationMaturity preview\n */\n function listPlans(options?: ListPlansOptions): Promise;\n interface ListPlansOptions {\n /** Archived filter. Defaults to ACTIVE (not archived) only. */\n archived?: ArchivedFilter;\n /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */\n public?: PublicFilter;\n /** Number of pricing plans to list. Defaults to 75. */\n limit?: number | null;\n /** Number of pricing plans to skip. Defaults to 0. */\n offset?: number | null;\n /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs. */\n planIds?: string[];\n }\n /**\n * Gets statistics about the pricing plans. Currently providing only the total number of pricing plans.\n * @public\n * @documentationMaturity preview\n */\n function getPlanStats(): Promise;\n /**\n * Creates a pricing plan.\n * @public\n * @documentationMaturity preview\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 */\n function createPlan(plan: Plan): Promise;\n /**\n * Updates a pricing plan.\n * Updating a plan does not impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of purchase.\n * @param _id - Plan ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function updatePlan(_id: string, options?: UpdatePlanOptions): Promise;\n interface UpdatePlanOptions {\n 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 /** 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 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.\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 /** 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 clientData?: Record;\n /** Reference to a form which is shown in checkout to gather additional data */\n formId?: string | null;\n };\n fieldMask?: string[];\n }\n /**\n * Sets visibility for pricing plans. Visible plans are considered public plans.\n * By default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors cannot choose them.\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). (An archived plan always remains archived and cannot be made active again.)\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 perks.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function setPlanVisibility(_id: string, options?: SetPlanVisibilityOptions): Promise;\n interface SetPlanVisibilityOptions {\n visible?: boolean;\n }\n /**\n * Marks a pricing plan as the primary pricing plan. When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function makePlanPrimary(_id: string): Promise;\n /**\n * Sets all pricing plans as not primary. When viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.\n * @public\n * @documentationMaturity preview\n */\n function clearPrimary(): Promise;\n /**\n * Archives a single plan.\n * When a plan is archived, it is no longer visible as a public plan that can be chosen by site members or visitors. Archived plans cannot be purchased.\n * An archived plan cannot be made active again.\n * Plan archiving does not impact existing orders made for the plan. All orders for the plan are still active and keep their perks.\n * Site owners can see archived plans in the Dashboard under Pricing Plans -> Archived Plans.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n */\n function archivePlan(_id: string): Promise;\n /**\n * Archives multiple plans.\n * See \"Archives a single plan\" for more information.\n * @param ids - List of Plan IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n */\n function bulkArchivePlan(ids: string[], options?: BulkArchivePlanOptions): Promise;\n interface BulkArchivePlanOptions {\n /** Set to true to return Plan entity in response. */\n returnFullEntity?: boolean;\n }\n /**\n * Changes the display order of the plans on the site. To rearrange the order of the plans, provide a list of plan IDs in the desired order.\n * Include all public and hidden plans in the list you provide.\n * Make sure to provide all non-archived plan IDs to avoid unpredictable results\n * @public\n * @documentationMaturity preview\n */\n function arrangePlans(options?: ArrangePlansOptions): Promise;\n interface ArrangePlansOptions {\n ids?: string[];\n }\n \n const pricingPlansV2Plan_universal_d___debug: typeof __debug;\n type pricingPlansV2Plan_universal_d_Plan = Plan;\n type pricingPlansV2Plan_universal_d_StringList = StringList;\n type pricingPlansV2Plan_universal_d_Pricing = Pricing;\n type pricingPlansV2Plan_universal_d_PricingPricingModelOneOf = PricingPricingModelOneOf;\n type pricingPlansV2Plan_universal_d_Recurrence = Recurrence;\n type pricingPlansV2Plan_universal_d_Duration = Duration;\n type pricingPlansV2Plan_universal_d_PeriodUnit = PeriodUnit;\n const pricingPlansV2Plan_universal_d_PeriodUnit: typeof PeriodUnit;\n type pricingPlansV2Plan_universal_d_Money = Money;\n type pricingPlansV2Plan_universal_d_BuyerCanCancelUpdated = BuyerCanCancelUpdated;\n type pricingPlansV2Plan_universal_d_ListPublicPlansRequest = ListPublicPlansRequest;\n type pricingPlansV2Plan_universal_d_ListPublicPlansResponse = ListPublicPlansResponse;\n type pricingPlansV2Plan_universal_d_PublicPlan = PublicPlan;\n type pricingPlansV2Plan_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type pricingPlansV2Plan_universal_d_Cursors = Cursors;\n type pricingPlansV2Plan_universal_d_QueryPublicPlansRequest = QueryPublicPlansRequest;\n type pricingPlansV2Plan_universal_d_QueryV2 = QueryV2;\n type pricingPlansV2Plan_universal_d_Sorting = Sorting;\n type pricingPlansV2Plan_universal_d_SortOrder = SortOrder;\n const pricingPlansV2Plan_universal_d_SortOrder: typeof SortOrder;\n type pricingPlansV2Plan_universal_d_Paging = Paging;\n type pricingPlansV2Plan_universal_d_QueryPublicPlansResponse = QueryPublicPlansResponse;\n type pricingPlansV2Plan_universal_d_GetPlanRequest = GetPlanRequest;\n type pricingPlansV2Plan_universal_d_GetPlanResponse = GetPlanResponse;\n type pricingPlansV2Plan_universal_d_ListPlansRequest = ListPlansRequest;\n type pricingPlansV2Plan_universal_d_ArchivedFilter = ArchivedFilter;\n const pricingPlansV2Plan_universal_d_ArchivedFilter: typeof ArchivedFilter;\n type pricingPlansV2Plan_universal_d_PublicFilter = PublicFilter;\n const pricingPlansV2Plan_universal_d_PublicFilter: typeof PublicFilter;\n type pricingPlansV2Plan_universal_d_ListPlansResponse = ListPlansResponse;\n type pricingPlansV2Plan_universal_d_GetPlanStatsRequest = GetPlanStatsRequest;\n type pricingPlansV2Plan_universal_d_GetPlanStatsResponse = GetPlanStatsResponse;\n type pricingPlansV2Plan_universal_d_CreatePlanRequest = CreatePlanRequest;\n type pricingPlansV2Plan_universal_d_CreatePlanResponse = CreatePlanResponse;\n type pricingPlansV2Plan_universal_d_UpdatePlanRequest = UpdatePlanRequest;\n type pricingPlansV2Plan_universal_d_UpdatePlanResponse = UpdatePlanResponse;\n type pricingPlansV2Plan_universal_d_SetPlanVisibilityRequest = SetPlanVisibilityRequest;\n type pricingPlansV2Plan_universal_d_SetPlanVisibilityResponse = SetPlanVisibilityResponse;\n type pricingPlansV2Plan_universal_d_MakePlanPrimaryRequest = MakePlanPrimaryRequest;\n type pricingPlansV2Plan_universal_d_MakePlanPrimaryResponse = MakePlanPrimaryResponse;\n type pricingPlansV2Plan_universal_d_ClearPrimaryRequest = ClearPrimaryRequest;\n type pricingPlansV2Plan_universal_d_ClearPrimaryResponse = ClearPrimaryResponse;\n type pricingPlansV2Plan_universal_d_ArchivePlanRequest = ArchivePlanRequest;\n type pricingPlansV2Plan_universal_d_ArchivePlanResponse = ArchivePlanResponse;\n type pricingPlansV2Plan_universal_d_PlanArchived = PlanArchived;\n type pricingPlansV2Plan_universal_d_BulkArchivePlanRequest = BulkArchivePlanRequest;\n type pricingPlansV2Plan_universal_d_BulkArchivePlanResponse = BulkArchivePlanResponse;\n type pricingPlansV2Plan_universal_d_BulkPlanResult = BulkPlanResult;\n type pricingPlansV2Plan_universal_d_ItemMetadata = ItemMetadata;\n type pricingPlansV2Plan_universal_d_ApplicationError = ApplicationError;\n type pricingPlansV2Plan_universal_d_BulkActionMetadata = BulkActionMetadata;\n type pricingPlansV2Plan_universal_d_ArrangePlansRequest = ArrangePlansRequest;\n type pricingPlansV2Plan_universal_d_ArrangePlansResponse = ArrangePlansResponse;\n const pricingPlansV2Plan_universal_d_listPublicPlans: typeof listPublicPlans;\n type pricingPlansV2Plan_universal_d_ListPublicPlansOptions = ListPublicPlansOptions;\n const pricingPlansV2Plan_universal_d_queryPublicPlans: typeof queryPublicPlans;\n type pricingPlansV2Plan_universal_d_QueryPublicPlansOptions = QueryPublicPlansOptions;\n const pricingPlansV2Plan_universal_d_getPlan: typeof getPlan;\n const pricingPlansV2Plan_universal_d_listPlans: typeof listPlans;\n type pricingPlansV2Plan_universal_d_ListPlansOptions = ListPlansOptions;\n const pricingPlansV2Plan_universal_d_getPlanStats: typeof getPlanStats;\n const pricingPlansV2Plan_universal_d_createPlan: typeof createPlan;\n const pricingPlansV2Plan_universal_d_updatePlan: typeof updatePlan;\n type pricingPlansV2Plan_universal_d_UpdatePlanOptions = UpdatePlanOptions;\n const pricingPlansV2Plan_universal_d_setPlanVisibility: typeof setPlanVisibility;\n type pricingPlansV2Plan_universal_d_SetPlanVisibilityOptions = SetPlanVisibilityOptions;\n const pricingPlansV2Plan_universal_d_makePlanPrimary: typeof makePlanPrimary;\n const pricingPlansV2Plan_universal_d_clearPrimary: typeof clearPrimary;\n const pricingPlansV2Plan_universal_d_archivePlan: typeof archivePlan;\n const pricingPlansV2Plan_universal_d_bulkArchivePlan: typeof bulkArchivePlan;\n type pricingPlansV2Plan_universal_d_BulkArchivePlanOptions = BulkArchivePlanOptions;\n const pricingPlansV2Plan_universal_d_arrangePlans: typeof arrangePlans;\n type pricingPlansV2Plan_universal_d_ArrangePlansOptions = ArrangePlansOptions;\n namespace pricingPlansV2Plan_universal_d {\n export {\n pricingPlansV2Plan_universal_d___debug as __debug,\n pricingPlansV2Plan_universal_d_Plan as Plan,\n pricingPlansV2Plan_universal_d_StringList as StringList,\n pricingPlansV2Plan_universal_d_Pricing as Pricing,\n pricingPlansV2Plan_universal_d_PricingPricingModelOneOf as PricingPricingModelOneOf,\n pricingPlansV2Plan_universal_d_Recurrence as Recurrence,\n pricingPlansV2Plan_universal_d_Duration as Duration,\n pricingPlansV2Plan_universal_d_PeriodUnit as PeriodUnit,\n pricingPlansV2Plan_universal_d_Money as Money,\n pricingPlansV2Plan_universal_d_BuyerCanCancelUpdated as BuyerCanCancelUpdated,\n pricingPlansV2Plan_universal_d_ListPublicPlansRequest as ListPublicPlansRequest,\n pricingPlansV2Plan_universal_d_ListPublicPlansResponse as ListPublicPlansResponse,\n pricingPlansV2Plan_universal_d_PublicPlan as PublicPlan,\n pricingPlansV2Plan_universal_d_PagingMetadataV2 as PagingMetadataV2,\n pricingPlansV2Plan_universal_d_Cursors as Cursors,\n pricingPlansV2Plan_universal_d_QueryPublicPlansRequest as QueryPublicPlansRequest,\n pricingPlansV2Plan_universal_d_QueryV2 as QueryV2,\n pricingPlansV2Plan_universal_d_Sorting as Sorting,\n pricingPlansV2Plan_universal_d_SortOrder as SortOrder,\n pricingPlansV2Plan_universal_d_Paging as Paging,\n pricingPlansV2Plan_universal_d_QueryPublicPlansResponse as QueryPublicPlansResponse,\n pricingPlansV2Plan_universal_d_GetPlanRequest as GetPlanRequest,\n pricingPlansV2Plan_universal_d_GetPlanResponse as GetPlanResponse,\n pricingPlansV2Plan_universal_d_ListPlansRequest as ListPlansRequest,\n pricingPlansV2Plan_universal_d_ArchivedFilter as ArchivedFilter,\n pricingPlansV2Plan_universal_d_PublicFilter as PublicFilter,\n pricingPlansV2Plan_universal_d_ListPlansResponse as ListPlansResponse,\n pricingPlansV2Plan_universal_d_GetPlanStatsRequest as GetPlanStatsRequest,\n pricingPlansV2Plan_universal_d_GetPlanStatsResponse as GetPlanStatsResponse,\n pricingPlansV2Plan_universal_d_CreatePlanRequest as CreatePlanRequest,\n pricingPlansV2Plan_universal_d_CreatePlanResponse as CreatePlanResponse,\n pricingPlansV2Plan_universal_d_UpdatePlanRequest as UpdatePlanRequest,\n pricingPlansV2Plan_universal_d_UpdatePlanResponse as UpdatePlanResponse,\n pricingPlansV2Plan_universal_d_SetPlanVisibilityRequest as SetPlanVisibilityRequest,\n pricingPlansV2Plan_universal_d_SetPlanVisibilityResponse as SetPlanVisibilityResponse,\n pricingPlansV2Plan_universal_d_MakePlanPrimaryRequest as MakePlanPrimaryRequest,\n pricingPlansV2Plan_universal_d_MakePlanPrimaryResponse as MakePlanPrimaryResponse,\n pricingPlansV2Plan_universal_d_ClearPrimaryRequest as ClearPrimaryRequest,\n pricingPlansV2Plan_universal_d_ClearPrimaryResponse as ClearPrimaryResponse,\n pricingPlansV2Plan_universal_d_ArchivePlanRequest as ArchivePlanRequest,\n pricingPlansV2Plan_universal_d_ArchivePlanResponse as ArchivePlanResponse,\n pricingPlansV2Plan_universal_d_PlanArchived as PlanArchived,\n pricingPlansV2Plan_universal_d_BulkArchivePlanRequest as BulkArchivePlanRequest,\n pricingPlansV2Plan_universal_d_BulkArchivePlanResponse as BulkArchivePlanResponse,\n pricingPlansV2Plan_universal_d_BulkPlanResult as BulkPlanResult,\n pricingPlansV2Plan_universal_d_ItemMetadata as ItemMetadata,\n pricingPlansV2Plan_universal_d_ApplicationError as ApplicationError,\n pricingPlansV2Plan_universal_d_BulkActionMetadata as BulkActionMetadata,\n pricingPlansV2Plan_universal_d_ArrangePlansRequest as ArrangePlansRequest,\n pricingPlansV2Plan_universal_d_ArrangePlansResponse as ArrangePlansResponse,\n pricingPlansV2Plan_universal_d_listPublicPlans as listPublicPlans,\n pricingPlansV2Plan_universal_d_ListPublicPlansOptions as ListPublicPlansOptions,\n pricingPlansV2Plan_universal_d_queryPublicPlans as queryPublicPlans,\n pricingPlansV2Plan_universal_d_QueryPublicPlansOptions as QueryPublicPlansOptions,\n pricingPlansV2Plan_universal_d_getPlan as getPlan,\n pricingPlansV2Plan_universal_d_listPlans as listPlans,\n pricingPlansV2Plan_universal_d_ListPlansOptions as ListPlansOptions,\n pricingPlansV2Plan_universal_d_getPlanStats as getPlanStats,\n pricingPlansV2Plan_universal_d_createPlan as createPlan,\n pricingPlansV2Plan_universal_d_updatePlan as updatePlan,\n pricingPlansV2Plan_universal_d_UpdatePlanOptions as UpdatePlanOptions,\n pricingPlansV2Plan_universal_d_setPlanVisibility as setPlanVisibility,\n pricingPlansV2Plan_universal_d_SetPlanVisibilityOptions as SetPlanVisibilityOptions,\n pricingPlansV2Plan_universal_d_makePlanPrimary as makePlanPrimary,\n pricingPlansV2Plan_universal_d_clearPrimary as clearPrimary,\n pricingPlansV2Plan_universal_d_archivePlan as archivePlan,\n pricingPlansV2Plan_universal_d_bulkArchivePlan as bulkArchivePlan,\n pricingPlansV2Plan_universal_d_BulkArchivePlanOptions as BulkArchivePlanOptions,\n pricingPlansV2Plan_universal_d_arrangePlans as arrangePlans,\n pricingPlansV2Plan_universal_d_ArrangePlansOptions as ArrangePlansOptions,\n };\n }\n \n export { pricingPlansV2Order_universal_d as orders, pricingPlansV2Plan_universal_d as plans };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-comments-moderation-v1-comments-moderation-provider.d.ts", "content": "declare module \"interfaces-comments-moderation-v1-comments-moderation-provider\" {\n interface CommentModeration {\n }\n interface SubmitCommentRequest {\n /** Comment id, only available when comment get edited */\n commentId?: string | null;\n /** App id */\n appId?: string;\n /** Context Id */\n contextId?: string;\n /** Resource Id */\n resourceId?: string;\n /** Comment content */\n content?: CommentContent;\n /** Comment author */\n author?: CommentAuthor;\n }\n interface CommentContent {\n /** @internal */\n draftJs?: string | null;\n /** @internal */\n plainText?: string | null;\n richContent?: RichContent;\n attachmentUrls?: string[];\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 CommentAuthor extends CommentAuthorAuthorIdOneOf {\n userId?: string | null;\n memberId?: string | null;\n visitorId?: string | null;\n }\n /** @oneof */\n interface CommentAuthorAuthorIdOneOf {\n userId?: string | null;\n memberId?: string | null;\n visitorId?: string | null;\n }\n interface SubmitCommentResponse {\n /** Submit results */\n submitResults?: Result;\n /** Reason */\n reason?: string | null;\n }\n enum Result {\n UNKNOWN_RESULT = \"UNKNOWN_RESULT\",\n /** Comment gets created with status PUBLISHED. It will be visible for all site visitors */\n APPROVE = \"APPROVE\",\n /** Comment gets created with status PENDING. It requires manual approval be visible for other site visitors */\n MODERATE = \"MODERATE\",\n /** Site visitor won't be able to create a comment */\n REJECT = \"REJECT\"\n }\n interface CommentModerationProviderConfig {\n /** List of app ids which moderation implementation supports */\n supportedAppIds?: 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 /** 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 SubmitCommentOptions {\n /** Comment id, only available when comment get edited */\n commentId?: string | null;\n /** App id */\n appId?: string;\n /** Context Id */\n contextId?: string;\n /** Resource Id */\n resourceId?: string;\n /** Comment content */\n content?: CommentContent;\n /** Comment author */\n author?: CommentAuthor;\n }\n \n export { Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BlockquoteData, BookingData, Border, BorderColors, BulletedListData, ButtonData, CellStyle, CodeBlockData, CollapsibleListData, ColorData, Colors, CommentAuthor, CommentAuthorAuthorIdOneOf, CommentContent, CommentModeration, CommentModerationProviderConfig, Context, Crop, Decoration, DecorationDataOneOf, DecorationType, Design, Dimensions, Direction, DividerData, DocumentStyle, EmbedData, EventData, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, GIF, GIFData, GalleryData, GalleryOptions, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, IdentityType, Image, ImageData, InitialExpandedItems, Item, ItemDataOneOf, ItemStyle, Layout, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, ListValue, MapData, MapSettings, MapType, Media, MentionData, Metadata, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Oembed, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, PDFSettings, ParagraphData, Permissions, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, Rel, Result, RichContent, Settings, Source, Spoiler, Styles, SubmitCommentOptions, SubmitCommentRequest, SubmitCommentResponse, TableCellData, TableData, Target, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Type, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VoteRole, Width, WidthType };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-authentication-management.d.ts", "content": "declare module \"wix-authentication-management\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n /** OAuthApp is the main entity of OAuthAppService */\n interface OAuthApp {\n /**\n * OAuthApp ID\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the time this OAuthApp was created\n * @readonly\n */\n _createdDate?: Date;\n /** OAuthApp name */\n name?: string | null;\n /** OAuthApp description */\n description?: string | null;\n /**\n * App Secret;\n * @readonly\n */\n secret?: string | null;\n /** list of valid domains for callback URLs from wix pages */\n allowedDomains?: string[];\n /** login url to automatically redirect users to from wix pages */\n loginUrl?: string | null;\n }\n interface CreateOAuthAppRequest {\n /** OAuthApp to be created */\n oAuthApp: OAuthApp;\n }\n interface CreateOAuthAppResponse {\n /** The created OAuthApp */\n oAuthApp?: OAuthApp;\n }\n interface GetOAuthAppRequest {\n /** Id of the OAuthApp to retrieve */\n oAuthAppId: string;\n }\n interface GetOAuthAppResponse {\n /** The retrieved OAuthApp */\n oAuthApp?: OAuthApp;\n }\n interface UpdateOAuthAppRequest {\n /** OAuthApp to be updated, may be partial */\n oAuthApp: OAuthApp;\n /** Explicit list of fields to update */\n mask: string[];\n }\n interface UpdateOAuthAppResponse {\n /** The updated OAuthApp */\n oAuthApp?: OAuthApp;\n }\n interface DeleteOAuthAppRequest {\n /** Id of the OAuthApp to delete */\n oAuthAppId: string;\n /** The revision of the OAuthApp */\n revision?: string;\n }\n interface DeleteOAuthAppResponse {\n }\n interface QueryOAuthAppRequest {\n /** WQL expression */\n query: QueryV2;\n }\n interface QueryV2 extends QueryV2PagingMethodOneOf {\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 /** 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 /** 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 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 /** 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 QueryOAuthAppResponse {\n /** The retrieved OAuthApps */\n oAuthApps?: OAuthApp[];\n /** Paging metadata */\n metadata?: 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 * 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 * @internal\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 /**\n * Creates a new OAuthApp\n * @param oAuthApp - OAuthApp to be created\n * @internal\n * @documentationMaturity preview\n * @requiredField oAuthApp\n * @requiredField oAuthApp.name\n * @returns The created OAuthApp\n */\n function createOAuthApp(oAuthApp: OAuthApp): Promise;\n /**\n * Get a OAuthApp by id\n * @param oAuthAppId - Id of the OAuthApp to retrieve\n * @internal\n * @documentationMaturity preview\n * @requiredField oAuthAppId\n * @returns The retrieved OAuthApp\n */\n function getOAuthApp(oAuthAppId: string): Promise;\n /**\n * Update a OAuthApp, supports partial update.\n * Updatable fields:\n * name\n * description\n * allowed_domain\n * login_url\n * @param _id - OAuthApp ID\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField oAuthApp\n * @requiredField options\n * @requiredField options.mask\n * @returns The updated OAuthApp\n */\n function updateOAuthApp(_id: string | null, oAuthApp: UpdateOAuthApp, options: UpdateOAuthAppOptions): Promise;\n interface UpdateOAuthApp {\n /**\n * OAuthApp ID\n * @readonly\n */\n _id?: string | null;\n /**\n * Represents the time this OAuthApp was created\n * @readonly\n */\n _createdDate?: Date;\n /** OAuthApp name */\n name?: string | null;\n /** OAuthApp description */\n description?: string | null;\n /**\n * App Secret;\n * @readonly\n */\n secret?: string | null;\n /** list of valid domains for callback URLs from wix pages */\n allowedDomains?: string[];\n /** login url to automatically redirect users to from wix pages */\n loginUrl?: string | null;\n }\n interface UpdateOAuthAppOptions {\n /** Explicit list of fields to update */\n mask: string[];\n }\n /**\n * Delete a OAuthApp\n * @param oAuthAppId - Id of the OAuthApp to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField oAuthAppId\n */\n function deleteOAuthApp(oAuthAppId: string, options?: DeleteOAuthAppOptions): Promise;\n interface DeleteOAuthAppOptions {\n /** The revision of the OAuthApp */\n revision?: string;\n }\n /**\n * Query OAuthApps using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\n * @internal\n * @documentationMaturity preview\n */\n function queryOAuthApp(): 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: string, 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: string[]) => 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: string[]) => 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 \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_QueryOAuthAppRequest = QueryOAuthAppRequest;\n type headlessV1OAuthApp_universal_d_QueryV2 = QueryV2;\n type headlessV1OAuthApp_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\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_QueryOAuthAppResponse = QueryOAuthAppResponse;\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 type headlessV1OAuthApp_universal_d_UpdateOAuthAppOptions = UpdateOAuthAppOptions;\n const headlessV1OAuthApp_universal_d_deleteOAuthApp: typeof deleteOAuthApp;\n type headlessV1OAuthApp_universal_d_DeleteOAuthAppOptions = DeleteOAuthAppOptions;\n const headlessV1OAuthApp_universal_d_queryOAuthApp: typeof queryOAuthApp;\n type headlessV1OAuthApp_universal_d_OAuthAppsQueryResult = OAuthAppsQueryResult;\n type headlessV1OAuthApp_universal_d_OAuthAppsQueryBuilder = OAuthAppsQueryBuilder;\n namespace headlessV1OAuthApp_universal_d {\n export {\n headlessV1OAuthApp_universal_d___debug as __debug,\n headlessV1OAuthApp_universal_d_OAuthApp as OAuthApp,\n headlessV1OAuthApp_universal_d_CreateOAuthAppRequest as CreateOAuthAppRequest,\n headlessV1OAuthApp_universal_d_CreateOAuthAppResponse as CreateOAuthAppResponse,\n headlessV1OAuthApp_universal_d_GetOAuthAppRequest as GetOAuthAppRequest,\n headlessV1OAuthApp_universal_d_GetOAuthAppResponse as GetOAuthAppResponse,\n headlessV1OAuthApp_universal_d_UpdateOAuthAppRequest as UpdateOAuthAppRequest,\n headlessV1OAuthApp_universal_d_UpdateOAuthAppResponse as UpdateOAuthAppResponse,\n headlessV1OAuthApp_universal_d_DeleteOAuthAppRequest as DeleteOAuthAppRequest,\n headlessV1OAuthApp_universal_d_DeleteOAuthAppResponse as DeleteOAuthAppResponse,\n headlessV1OAuthApp_universal_d_QueryOAuthAppRequest as QueryOAuthAppRequest,\n headlessV1OAuthApp_universal_d_QueryV2 as QueryV2,\n headlessV1OAuthApp_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n headlessV1OAuthApp_universal_d_Sorting as Sorting,\n headlessV1OAuthApp_universal_d_SortOrder as SortOrder,\n headlessV1OAuthApp_universal_d_Paging as Paging,\n headlessV1OAuthApp_universal_d_CursorPaging as CursorPaging,\n headlessV1OAuthApp_universal_d_QueryOAuthAppResponse as QueryOAuthAppResponse,\n headlessV1OAuthApp_universal_d_PagingMetadataV2 as PagingMetadataV2,\n headlessV1OAuthApp_universal_d_Cursors as Cursors,\n headlessV1OAuthApp_universal_d_createOAuthApp as createOAuthApp,\n headlessV1OAuthApp_universal_d_getOAuthApp as getOAuthApp,\n headlessV1OAuthApp_universal_d_updateOAuthApp as updateOAuthApp,\n headlessV1OAuthApp_universal_d_UpdateOAuthApp as UpdateOAuthApp,\n headlessV1OAuthApp_universal_d_UpdateOAuthAppOptions as UpdateOAuthAppOptions,\n headlessV1OAuthApp_universal_d_deleteOAuthApp as deleteOAuthApp,\n headlessV1OAuthApp_universal_d_DeleteOAuthAppOptions as DeleteOAuthAppOptions,\n headlessV1OAuthApp_universal_d_queryOAuthApp as queryOAuthApp,\n headlessV1OAuthApp_universal_d_OAuthAppsQueryResult as OAuthAppsQueryResult,\n headlessV1OAuthApp_universal_d_OAuthAppsQueryBuilder as OAuthAppsQueryBuilder,\n };\n }\n \n export { headlessV1OAuthApp_universal_d as oAuthApps };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 /**\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 * @internal\n */\n allowedDomains?: string[];\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 * 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 * @internal\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 /**\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 /**\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 * @internal\n */\n allowedDomains?: string[];\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 * Deletes an OAuth app by ID.\n *\n *\n * > **Note:** After you delete an OAuth app, an external client can no longer make API calls by authenticating with its client ID.\n * @param oAuthAppId - ID of the OAuth app to delete.\n * @internal\n * @documentationMaturity preview\n * @requiredField oAuthAppId\n */\n function deleteOAuthApp(oAuthAppId: string): Promise;\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 \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_deleteOAuthApp: typeof deleteOAuthApp;\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 {\n headlessV1OAuthApp_universal_d___debug as __debug,\n headlessV1OAuthApp_universal_d_OAuthApp as OAuthApp,\n headlessV1OAuthApp_universal_d_CreateOAuthAppRequest as CreateOAuthAppRequest,\n headlessV1OAuthApp_universal_d_CreateOAuthAppResponse as CreateOAuthAppResponse,\n headlessV1OAuthApp_universal_d_GetOAuthAppRequest as GetOAuthAppRequest,\n headlessV1OAuthApp_universal_d_GetOAuthAppResponse as GetOAuthAppResponse,\n headlessV1OAuthApp_universal_d_UpdateOAuthAppRequest as UpdateOAuthAppRequest,\n headlessV1OAuthApp_universal_d_UpdateOAuthAppResponse as UpdateOAuthAppResponse,\n headlessV1OAuthApp_universal_d_DeleteOAuthAppRequest as DeleteOAuthAppRequest,\n headlessV1OAuthApp_universal_d_DeleteOAuthAppResponse as DeleteOAuthAppResponse,\n headlessV1OAuthApp_universal_d_QueryOAuthAppsRequest as QueryOAuthAppsRequest,\n headlessV1OAuthApp_universal_d_PlatformQuery as PlatformQuery,\n headlessV1OAuthApp_universal_d_PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOf,\n headlessV1OAuthApp_universal_d_Sorting as Sorting,\n headlessV1OAuthApp_universal_d_SortOrder as SortOrder,\n headlessV1OAuthApp_universal_d_Paging as Paging,\n headlessV1OAuthApp_universal_d_CursorPaging as CursorPaging,\n headlessV1OAuthApp_universal_d_QueryOAuthAppsResponse as QueryOAuthAppsResponse,\n headlessV1OAuthApp_universal_d_PagingMetadataV2 as PagingMetadataV2,\n headlessV1OAuthApp_universal_d_Cursors as Cursors,\n headlessV1OAuthApp_universal_d_createOAuthApp as createOAuthApp,\n headlessV1OAuthApp_universal_d_getOAuthApp as getOAuthApp,\n headlessV1OAuthApp_universal_d_updateOAuthApp as updateOAuthApp,\n headlessV1OAuthApp_universal_d_UpdateOAuthApp as UpdateOAuthApp,\n headlessV1OAuthApp_universal_d_deleteOAuthApp as deleteOAuthApp,\n headlessV1OAuthApp_universal_d_queryOAuthApps as queryOAuthApps,\n headlessV1OAuthApp_universal_d_OAuthAppsQueryResult as OAuthAppsQueryResult,\n headlessV1OAuthApp_universal_d_OAuthAppsQueryBuilder as OAuthAppsQueryBuilder,\n };\n }\n \n export { headlessV1OAuthApp_universal_d as oAuthApps };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-multilingual-localization.d.ts", "content": "declare module \"wix-multilingual-localization\" {\n interface LocalizedContent {\n /** UUID identifier for content */\n _id?: string;\n /** Compound key identifier for content */\n key?: LocalizedContentKey;\n /** Localized fields for every language this entity has content */\n fieldsPerLanguage?: LanguageFields[];\n /** Optional field that will group in the UI contents with the same group name */\n groupByName?: string | null;\n }\n interface LocalizedContentKey {\n /** Schema unique key identifier */\n schemaKey?: SchemaKey;\n /** Unique identifier that represents a specific entity in the app */\n entityId?: string;\n }\n interface SchemaKey {\n /** ID of app that created the schema. */\n appId?: string;\n /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */\n entityType?: string;\n /** Scope schema is defined in (Global/Site) */\n scope?: SchemaScope;\n }\n enum SchemaScope {\n /** Global schema, relevant to all sites */\n GLOBAL = \"GLOBAL\",\n /** Site schema, relevant to specific site only */\n SITE = \"SITE\"\n }\n interface LanguageFields {\n /** Language identifier in IETF BCP 47 tag format. */\n languageTag?: string;\n /** List of fields localized in the given language */\n languageFields?: LocalizedContentField[];\n }\n interface LocalizedContentField extends LocalizedContentFieldValueOneOf {\n /** Field actual localized content as simple text type */\n textValue?: string;\n /** Field actual localized content as rich content editor type */\n wixRichContentEditorValue?: string;\n /** Field actual localized content as media type (image, video or document) */\n mediaValue?: MediaItem;\n /** Field unique identifier. This id must have a matching schema field id */\n _id?: string;\n /** Describes the updater identity (site owner / app / auto translator) */\n updatedBy?: UpdaterIdentity;\n /** Owner of the last change on this field */\n updaterId?: string | null;\n /** Is content published to live site or not */\n published?: boolean;\n /** Status of the field in the workflow (e.g. pending, reviewed, approved). Value is free text - defined by the client and only stored here. */\n status?: string | null;\n /** In case field is reachable via sequence/s, this array represents all the sequences names in the path, and their corresponding item id */\n sequencePath?: FieldSequence[];\n }\n /** @oneof */\n interface LocalizedContentFieldValueOneOf {\n /** Field actual localized content as simple text type */\n textValue?: string;\n /** Field actual localized content as rich content editor type */\n wixRichContentEditorValue?: string;\n /** Field actual localized content as media type (image, video or document) */\n mediaValue?: MediaItem;\n }\n interface MediaItem extends MediaItemMediaOneOf {\n /** Image media item */\n image?: string;\n /** Video media item */\n video?: string;\n /** Document media item */\n document?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /** Image media item */\n image?: string;\n /** Video media item */\n video?: string;\n /** Document media item */\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 /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n enum UpdaterIdentity {\n /** Site Owner identity */\n SITE_OWNER = \"SITE_OWNER\",\n /** External hired human translator */\n EXTERNAL = \"EXTERNAL\",\n /** Machine translation like Google Translate */\n MACHINE = \"MACHINE\"\n }\n interface FieldSequence {\n /** Name of sequence */\n seqName?: string;\n /** Id of relevant item in the sequence */\n itemId?: string;\n /** Optional field - in case set sequences will be ordered by priority index (best effort) */\n priorityIndex?: number | null;\n }\n interface SearchEntityContentRequest {\n schemaKey: SchemaKey;\n primaryLanguage?: string;\n secondaryLanguage?: string;\n fieldSearch?: FieldSearch;\n translationStatus?: TranslationStatus;\n paging?: Paging;\n }\n interface FieldSearch {\n fieldIdToSearch?: string;\n stringToSearch?: string;\n }\n enum TranslationStatus {\n ALL = \"ALL\",\n AWAIT_TRANSLATION = \"AWAIT_TRANSLATION\",\n IN_PROGRESS = \"IN_PROGRESS\",\n TRANSLATED = \"TRANSLATED\"\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 SearchEntityContentResponse {\n localizedContents?: LocalizedContent[];\n paging?: Paging;\n total?: number;\n }\n interface Person {\n /**\n * @internal\n * @readonly\n */\n _id?: string;\n /** @internal */\n name?: string;\n /** @internal */\n description?: string;\n /** @internal */\n image?: Image;\n /** @internal */\n birthDate?: string;\n /** @internal */\n genericMessage?: GenericMessage;\n /** @internal */\n hobbies?: Hobby[];\n /** @internal */\n additionalDetails?: Record;\n }\n interface Image {\n /**\n * WixMedia image ID\n * @internal\n */\n _id?: string;\n /**\n * URL of image\n * @internal\n */\n url?: string;\n /**\n * Original image width\n * @internal\n */\n height?: number;\n /**\n * Original image height\n * @internal\n */\n width?: number;\n }\n interface GenericMessage {\n /** @internal */\n data1?: string;\n /** @internal */\n data2?: string;\n /** @internal */\n data3?: string;\n /** @internal */\n data4?: string;\n }\n interface Hobby {\n /** @internal */\n name?: string;\n /** @internal */\n category?: string;\n }\n interface DetailType {\n /** @internal */\n name?: string;\n }\n interface AddPersonRequest {\n /** @internal */\n person?: Person;\n }\n interface AddPersonResponse {\n }\n interface UpdatePersonRequest {\n /** @internal */\n person?: Person;\n }\n interface UpdatePersonResponse {\n }\n interface DeletePersonRequest {\n /** @internal */\n personId: string;\n }\n interface DeletePersonResponse {\n }\n interface PersonsListRequest {\n }\n interface PersonsListResponse {\n /** @internal */\n persons?: Person[];\n }\n interface Empty {\n }\n interface LocalizedContentChanged {\n /** The action that changed the content */\n action?: LocalizationContentChangedAction;\n /** token to identify the flow this event is part of and the total number of event in this flow. */\n flowToken?: string | null;\n }\n interface LocalizedLanguageContent {\n /** UUID identifier for the original content */\n localizationRecordId?: string;\n /** Compound key identifier for content */\n key?: LocalizedLanguageContentKey;\n /** Localized fields this entity has content */\n fields?: LocalizedContentField[];\n /** Optional field that will group in the UI contents with the same group name */\n groupByName?: string | null;\n }\n interface LocalizedLanguageContentKey {\n /** Language identifier in IETF BCP 47 tag format. */\n languageTag?: string;\n /** Schema unique key identifier */\n schemaKey?: SchemaKey;\n /** Unique identifier that represents a specific entity in the app */\n entityId?: string;\n }\n interface CreateOrUpdateAction {\n /** The new Localized published state */\n localizedLanguageContent?: LocalizedLanguageContent;\n }\n interface DeleteAction {\n /** UUID identifier for the original content */\n localizationRecordId?: string;\n /** Language identifier in IETF BCP 47 tag format. */\n languageTag?: string;\n /** Compound key identifier for content */\n key?: LocalizedLanguageContentKey;\n }\n interface LocalizationContentChangedAction extends LocalizationContentChangedActionActionOneOf {\n /** Content has changes in its fields */\n createOrUpdateAction?: CreateOrUpdateAction;\n /** Content deleted */\n deleteAction?: DeleteAction;\n }\n /** @oneof */\n interface LocalizationContentChangedActionActionOneOf {\n /** Content has changes in its fields */\n createOrUpdateAction?: CreateOrUpdateAction;\n /** Content deleted */\n deleteAction?: DeleteAction;\n }\n interface CreateOrUpdateContentsByKeyRequest {\n /** Language ID in IETF BCP 47 tag format. */\n languageTag?: string;\n /** List of content for creation/update. */\n languageContents?: LanguageContentByKey[];\n /** When true - uploaded language contents will replace existing language contents */\n overrideData?: boolean;\n }\n interface LanguageContentByKey {\n /** Content unique key identifier */\n contentKey?: LocalizedContentKey;\n /** List of localized fields */\n languageFields?: LocalizedContentField[];\n /** Optional field that will group in the UI contents with the same group name */\n groupByName?: string | null;\n }\n interface CreateOrUpdateContentsResponse {\n /** List of all created/updated content. */\n localizedContents?: LocalizedContent[];\n }\n interface UpdateContentsRequest {\n /** Language ID in IETF BCP 47 tag format. */\n languageTag?: string;\n /** List of content in a given language for update. */\n languageContents?: LanguageContentById[];\n /** When true - uploaded language contents will replace existing language contents */\n overrideData?: boolean;\n }\n interface LanguageContentById {\n /** Content uuid identifier */\n contentId?: string;\n /** List of localized fields */\n languageFields?: LocalizedContentField[];\n /** Optional field that will group in the UI contents with the same group name */\n groupByName?: string | null;\n }\n interface RemoveContentFieldsRequest {\n /** Content IDs for fields removal */\n contentId: string;\n /** Language ID (in IETF BCP 47 tag format) for fields removal, remove from all languages if empty */\n languageTagsMask?: string[];\n /** Field unique identifier to remove */\n fieldsIdentifiers?: ContentFieldIdentifier[];\n }\n interface ContentFieldIdentifier {\n /** This id must have a matching schema field id */\n _id?: string;\n /** In case field is reachable via sequence/s, this array represents all the sequences names in the path, and their corresponding item id */\n sequencePath?: FieldSequence[];\n }\n interface RemoveContentFieldsResponse {\n /** localized contents in its most recent state */\n localizedContent?: LocalizedContent;\n }\n interface RemoveContentFieldsByKeyRequest {\n /** Content key for removal */\n contentKey: LocalizedContentKey;\n /** Language ID (in IETF BCP 47 tag format) for fields removal, remove from all languages if empty */\n languageTagsMask?: string[];\n /** Field unique identifier to remove. */\n fieldsIdentifiers?: ContentFieldIdentifier[];\n }\n interface ListContentsRequest {\n /** Filter object */\n filter?: LocalizedContentFilter;\n /** Paging options. */\n paging?: Paging;\n /** Optional field to order results by. */\n order?: OrderByField;\n }\n interface LocalizedContentFilter {\n /** Optional list of content ids */\n contentIds?: string[];\n /** App def id */\n appId?: string | null;\n /** Type of the connected source entity to the localized content. Using this filter without specifying also app id filter might result in slow queries */\n entityType?: string | null;\n /** Id of the connected source entity to the localized content. Using this filter without specifying also entity type filter might result in slow queries */\n entityId?: string | null;\n /** IETF BCP 47 language tag filter. Show only contents having at least one field localized to this language. Using this filter without specifying also entity id filter might result in slow queries */\n languageTag?: string | null;\n /** Optional list of language tags. Will return partial contents containing only fields that are localized in languages from given list or empty contents if there are no such fields */\n languageMask?: string[];\n /**\n * @deprecated\n * @replacedBy group_names\n * @targetRemovalDate 2023-02-21\n */\n groupName?: string | null;\n /** Fetch only contents with given group name */\n groupNames?: string[];\n /** Optional filter to fetch only contents that are in a specific scope */\n scope?: FilterSchemaScope;\n }\n interface FilterSchemaScope {\n /** The scope type of the schema */\n scope?: SchemaScope;\n }\n enum OrderByField {\n UNSPECIFIED_FIELD = \"UNSPECIFIED_FIELD\",\n ENTITY_ID = \"ENTITY_ID\"\n }\n interface ListContentsResponse {\n /** Content that meets request conditions. */\n localizedContents?: LocalizedContent[];\n }\n interface RemoveSiteLanguagesRequest {\n /** Optional list of language tags. Will remove only the languages that are listed or empty to remove all languages */\n languagesToRemove?: string[];\n }\n interface RemoveSiteLanguagesResponse {\n }\n interface RemoveContentsByEntityTypeRequest {\n /** The app id of the entity you want to delete */\n appId: string;\n /** The entity type of the entity you want to delete */\n entityType: string;\n /** The secret of the entity you want to delete */\n secret: string;\n }\n interface RemoveContentsResponse {\n }\n interface RepublishSchemaContentRequest {\n /** Schema key of the content to republish. */\n schemaKey?: SchemaKey;\n /** Secret of the content to republish. */\n secret: string;\n }\n interface RepublishSchemaContentResponse {\n }\n interface GetContentHistoryRequest {\n /** Content ID. */\n contentId: string;\n /** Paging options. */\n paging?: Paging;\n }\n interface GetContentHistoryResponse {\n /** List of contents, representing all content's changes through its lifecycle */\n contentHistory?: RevisionLocalizedContent[];\n }\n interface RevisionLocalizedContent {\n /** Content data */\n content?: LocalizedContent;\n /** Revision data */\n revision?: Revision;\n }\n interface Revision {\n /** Identify the localized content point in history. the revision is created during call to Localization.UpdateSiteLocalizedContent */\n version?: number;\n /** Identify the localized content date in history. two revisions can have the same date. */\n date?: Date | null;\n }\n interface GetContentHistoryByKeyRequest {\n /** Content key. */\n contentKey: LocalizedContentKey;\n /** Paging options. */\n paging?: Paging;\n }\n interface RemoveContentsRequest {\n /** Content IDs to delete. */\n contentIds?: string[];\n }\n interface RemoveContentsByKeyRequest {\n /** Content keys to delete. */\n contentKeys: LocalizedContentKey[];\n }\n interface RemoveContentsByFilterRequest {\n /** Filter object */\n filter?: LocalizedContentFilter;\n }\n interface SetContentGroupsRequest {\n /** Selected content key identifiers for removal */\n contentGroup?: ContentGroupById[];\n }\n interface ContentGroupById {\n /** Content uuid identifier */\n contentId?: string;\n /** Optional field that will group in the UI contents with the same group name. If not set - will delete group name if exists. Case insensitive */\n group?: string | null;\n }\n interface SetContentGroupsResponse {\n }\n interface SetContentGroupsByKeyRequest {\n /** Selected content key identifiers for removal */\n contentGroup?: ContentGroupByKey[];\n }\n interface ContentGroupByKey {\n /** Content unique key identifier */\n contentKey?: LocalizedContentKey;\n /** Optional field that will group in the UI contents with the same group name. If not set - will delete group name if exists. Case insensitive */\n group?: string | null;\n }\n interface GetAppGroupNamesRequest {\n /** App def id of the app this schema belongs to */\n appId: string;\n }\n interface GetAppGroupNamesResponse {\n /** All distinct group names defined for this app's contents */\n groups?: 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 /** 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;\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 }\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 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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 /** @public\n * @documentationMaturity preview\n * @requiredField schemaKey\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function searchEntityContent(schemaKey: SchemaKey, options?: SearchEntityContentOptions): Promise;\n interface SearchEntityContentOptions {\n primaryLanguage?: string;\n secondaryLanguage?: string;\n fieldSearch?: FieldSearch;\n translationStatus?: TranslationStatus;\n paging?: Paging;\n }\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function addPersonDetails(options?: AddPersonDetailsOptions): Promise;\n interface AddPersonDetailsOptions {\n /** @internal */\n person?: Person;\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function updatePersonDetails(_id: string, options?: UpdatePersonDetailsOptions): Promise;\n interface UpdatePersonDetailsOptions {\n person: {\n /**\n * @internal\n * @readonly\n */\n _id?: string;\n /** @internal */\n name?: string;\n /** @internal */\n description?: string;\n /** @internal */\n image?: Image;\n /** @internal */\n birthDate?: string;\n /** @internal */\n genericMessage?: GenericMessage;\n /** @internal */\n hobbies?: Hobby[];\n /** @internal */\n additionalDetails?: Record;\n };\n }\n /** @internal\n * @documentationMaturity preview\n * @requiredField personId\n * @adminMethod\n */\n function deletePersonDetails(personId: string): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function list(): Promise;\n /**\n * Adds or updates a localized content key for a given language.\n * Localized content is identified by its schemaKey and entityId.\n * Partial updates are supported - uploaded fields will be merged with existing language fields.\n * Override is also supported - need to mark explicitly in the request\n * Language content will be merged with entity's list of languages.\n * @public\n * @documentationMaturity preview\n * @requiredField options.languageContents.contentKey\n * @requiredField options.languageContents.contentKey.schemaKey\n * @requiredField options.languageContents.languageFields\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function createOrUpdateContentsByKey(options?: CreateOrUpdateContentsByKeyOptions): Promise;\n interface CreateOrUpdateContentsByKeyOptions {\n /** Language ID in IETF BCP 47 tag format. */\n languageTag?: string;\n /** List of content for creation/update. */\n languageContents?: LanguageContentByKey[];\n /** When true - uploaded language contents will replace existing language contents */\n overrideData?: boolean;\n }\n /**\n * Updates existing localized content for a given language by contentId.\n * Partial updates are supported - uploaded fields will be merged with existing language fields.\n * Override is also supported - need to mark explicitly in the request\n * Language content will be merged with entity's list of languages.\n * @public\n * @documentationMaturity preview\n * @requiredField options.languageContents.languageFields\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function updateContents(options?: UpdateContentsOptions): Promise;\n interface UpdateContentsOptions {\n /** Language ID in IETF BCP 47 tag format. */\n languageTag?: string;\n /** List of content in a given language for update. */\n languageContents?: LanguageContentById[];\n /** When true - uploaded language contents will replace existing language contents */\n overrideData?: boolean;\n }\n /**\n * Removes specified content fields from given languages by contentId and sequencePath.\n * If no language is specified, the fields will be removed from all existing languages.\n * No error will be thrown if some fields do not exist in all languages.\n * @param contentId - Content IDs for fields removal\n * @public\n * @documentationMaturity preview\n * @requiredField contentId\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeContentFields(contentId: string, options?: RemoveContentFieldsOptions): Promise;\n interface RemoveContentFieldsOptions {\n /** Language ID (in IETF BCP 47 tag format) for fields removal, remove from all languages if empty */\n languageTagsMask?: string[];\n /** Field unique identifier to remove */\n fieldsIdentifiers?: ContentFieldIdentifier[];\n }\n /**\n * Removes specified content fields from given languages by schemaKey and entityId.\n * If no language is specified the fields will be removed from all existing languages.\n * Field is identified by its id and sequence path\n * No error will be thrown if some fields do not exist in all languages.\n * @param contentKey - Content key for removal\n * @public\n * @documentationMaturity preview\n * @requiredField contentKey\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeContentFieldsByKey(contentKey: LocalizedContentKey, options?: RemoveContentFieldsByKeyOptions): Promise;\n interface RemoveContentFieldsByKeyOptions {\n /** Language ID (in IETF BCP 47 tag format) for fields removal, remove from all languages if empty */\n languageTagsMask?: string[];\n /** Field unique identifier to remove. */\n fieldsIdentifiers?: ContentFieldIdentifier[];\n }\n /**\n * Retrieves localized content, including published and unpublished values, given the provided filtering.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function listContents(options?: ListContentsOptions): Promise;\n interface ListContentsOptions {\n /** Filter object */\n filter?: LocalizedContentFilter;\n /** Paging options. */\n paging?: Paging;\n /** Optional field to order results by. */\n order?: OrderByField;\n }\n /**\n * Removes specified languages from given a given site.\n * If no languages specified all languages will be removed.\n * No error will be thrown if some languages do not exist in the site.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeSiteLanguages(options?: RemoveSiteLanguagesOptions): Promise;\n interface RemoveSiteLanguagesOptions {\n /** Optional list of language tags. Will remove only the languages that are listed or empty to remove all languages */\n languagesToRemove?: string[];\n }\n /**\n * Removes all content in a given entity type\n * @param appId - The app id of the entity you want to delete\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @requiredField options\n * @requiredField options.entityType\n * @requiredField options.secret\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeContentsByEntityType(appId: string, options: RemoveContentsByEntityTypeOptions): Promise;\n interface RemoveContentsByEntityTypeOptions {\n /** The entity type of the entity you want to delete */\n entityType: string;\n /** The secret of the entity you want to delete */\n secret: string;\n }\n /**\n * Start republish all content with a specific schema key\n * @internal\n * @documentationMaturity preview\n * @requiredField options.schemaKey.appId\n * @requiredField options.schemaKey.entityType\n * @requiredField options.secret\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function republishSchemaContent(options?: RepublishSchemaContentOptions): Promise;\n interface RepublishSchemaContentOptions {\n /** Schema key of the content to republish. */\n schemaKey?: SchemaKey;\n /** Secret of the content to republish. */\n secret: string;\n }\n /**\n * Retrieves full content revision history by contentId.\n * Note: If the requested contentId doesn't exist, the API will ignore the request and return successfully - with no error message.\n * @param contentId - Content ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField contentId\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function getContentHistory(contentId: string, options?: GetContentHistoryOptions): Promise;\n interface GetContentHistoryOptions {\n /** Paging options. */\n paging?: Paging;\n }\n /**\n * Retrieves content full revision history by schemaKey and entityId.\n * Note: If the requested content doesn't exist, the API will ignore the request and return successfully - with no error message.\n * @param contentKey - Content key.\n * @internal\n * @documentationMaturity preview\n * @requiredField contentKey\n * @requiredField contentKey.schemaKey\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function getContentHistoryByKey(contentKey: LocalizedContentKey, options?: GetContentHistoryByKeyOptions): Promise;\n interface GetContentHistoryByKeyOptions {\n /** Paging options. */\n paging?: Paging;\n }\n /**\n * Removes existing localized content by contentId. Non-existent contentIds are ignored.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeContents(options?: RemoveContentsOptions): Promise;\n interface RemoveContentsOptions {\n /** Content IDs to delete. */\n contentIds?: string[];\n }\n /**\n * Removes existing localized content by contentKey. Non-existent contentKeys are ignored.\n * @param contentKeys - Content keys to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField contentKeys\n * @requiredField contentKeys.schemaKey\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeContentsByKey(contentKeys: LocalizedContentKey[]): Promise;\n /**\n * Removes existing localized content by filter. Non-matching filters are ignored.\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function removeContentsByFilter(options?: RemoveContentsByFilterOptions): Promise;\n interface RemoveContentsByFilterOptions {\n /** Filter object */\n filter?: LocalizedContentFilter;\n }\n /**\n * Set for each content a name to be grouped by in ML TMS UI\n * Identify localized contents by their uuid\n * Ignores non existing ids\n * @internal\n * @documentationMaturity preview\n * @requiredField options.contentGroup.contentId\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function setContentGroups(options?: SetContentGroupsOptions): Promise;\n interface SetContentGroupsOptions {\n /** Selected content key identifiers for removal */\n contentGroup?: ContentGroupById[];\n }\n /**\n * Set for each content a name to be grouped by in ML TMS UI\n * Identify localized contents by their schema and entity\n * Ignores non existing keys\n * @internal\n * @documentationMaturity preview\n * @requiredField options.contentGroup.contentKey\n * @requiredField options.contentGroup.contentKey.schemaKey\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function setContentGroupsByKey(options?: SetContentGroupsByKeyOptions): Promise;\n interface SetContentGroupsByKeyOptions {\n /** Selected content key identifiers for removal */\n contentGroup?: ContentGroupByKey[];\n }\n /**\n * Get all app's group names in a given site\n * Will return empty sequence if no groups exist\n * Results are confined to the site found in the context\n * @param appId - App def id of the app this schema belongs to\n * @internal\n * @documentationMaturity preview\n * @requiredField appId\n * @permissionId WIX_MULTILINGUAL.TRANSLATE_APPS\n * @adminMethod\n */\n function getAppGroupNames(appId: string): Promise;\n \n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContent = LocalizedContent;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentKey = LocalizedContentKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_SchemaKey = SchemaKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_SchemaScope = SchemaScope;\n const multilingualLocalizationV1LocalizedContent_universal_d_SchemaScope: typeof SchemaScope;\n type multilingualLocalizationV1LocalizedContent_universal_d_LanguageFields = LanguageFields;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentField = LocalizedContentField;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentFieldValueOneOf = LocalizedContentFieldValueOneOf;\n type multilingualLocalizationV1LocalizedContent_universal_d_MediaItem = MediaItem;\n type multilingualLocalizationV1LocalizedContent_universal_d_MediaItemMediaOneOf = MediaItemMediaOneOf;\n type multilingualLocalizationV1LocalizedContent_universal_d_VideoResolution = VideoResolution;\n type multilingualLocalizationV1LocalizedContent_universal_d_UpdaterIdentity = UpdaterIdentity;\n const multilingualLocalizationV1LocalizedContent_universal_d_UpdaterIdentity: typeof UpdaterIdentity;\n type multilingualLocalizationV1LocalizedContent_universal_d_FieldSequence = FieldSequence;\n type multilingualLocalizationV1LocalizedContent_universal_d_SearchEntityContentRequest = SearchEntityContentRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_FieldSearch = FieldSearch;\n type multilingualLocalizationV1LocalizedContent_universal_d_TranslationStatus = TranslationStatus;\n const multilingualLocalizationV1LocalizedContent_universal_d_TranslationStatus: typeof TranslationStatus;\n type multilingualLocalizationV1LocalizedContent_universal_d_Paging = Paging;\n type multilingualLocalizationV1LocalizedContent_universal_d_SearchEntityContentResponse = SearchEntityContentResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_Person = Person;\n type multilingualLocalizationV1LocalizedContent_universal_d_Image = Image;\n type multilingualLocalizationV1LocalizedContent_universal_d_GenericMessage = GenericMessage;\n type multilingualLocalizationV1LocalizedContent_universal_d_Hobby = Hobby;\n type multilingualLocalizationV1LocalizedContent_universal_d_DetailType = DetailType;\n type multilingualLocalizationV1LocalizedContent_universal_d_AddPersonRequest = AddPersonRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_AddPersonResponse = AddPersonResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_UpdatePersonRequest = UpdatePersonRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_UpdatePersonResponse = UpdatePersonResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_DeletePersonRequest = DeletePersonRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_DeletePersonResponse = DeletePersonResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_PersonsListRequest = PersonsListRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_PersonsListResponse = PersonsListResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_Empty = Empty;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentChanged = LocalizedContentChanged;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedLanguageContent = LocalizedLanguageContent;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedLanguageContentKey = LocalizedLanguageContentKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateAction = CreateOrUpdateAction;\n type multilingualLocalizationV1LocalizedContent_universal_d_DeleteAction = DeleteAction;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizationContentChangedAction = LocalizationContentChangedAction;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizationContentChangedActionActionOneOf = LocalizationContentChangedActionActionOneOf;\n type multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateContentsByKeyRequest = CreateOrUpdateContentsByKeyRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_LanguageContentByKey = LanguageContentByKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateContentsResponse = CreateOrUpdateContentsResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_UpdateContentsRequest = UpdateContentsRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_LanguageContentById = LanguageContentById;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsRequest = RemoveContentFieldsRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_ContentFieldIdentifier = ContentFieldIdentifier;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsResponse = RemoveContentFieldsResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsByKeyRequest = RemoveContentFieldsByKeyRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_ListContentsRequest = ListContentsRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentFilter = LocalizedContentFilter;\n type multilingualLocalizationV1LocalizedContent_universal_d_FilterSchemaScope = FilterSchemaScope;\n type multilingualLocalizationV1LocalizedContent_universal_d_OrderByField = OrderByField;\n const multilingualLocalizationV1LocalizedContent_universal_d_OrderByField: typeof OrderByField;\n type multilingualLocalizationV1LocalizedContent_universal_d_ListContentsResponse = ListContentsResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveSiteLanguagesRequest = RemoveSiteLanguagesRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveSiteLanguagesResponse = RemoveSiteLanguagesResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByEntityTypeRequest = RemoveContentsByEntityTypeRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsResponse = RemoveContentsResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_RepublishSchemaContentRequest = RepublishSchemaContentRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_RepublishSchemaContentResponse = RepublishSchemaContentResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryRequest = GetContentHistoryRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryResponse = GetContentHistoryResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_RevisionLocalizedContent = RevisionLocalizedContent;\n type multilingualLocalizationV1LocalizedContent_universal_d_Revision = Revision;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryByKeyRequest = GetContentHistoryByKeyRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsRequest = RemoveContentsRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByKeyRequest = RemoveContentsByKeyRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByFilterRequest = RemoveContentsByFilterRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsRequest = SetContentGroupsRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_ContentGroupById = ContentGroupById;\n type multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsResponse = SetContentGroupsResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsByKeyRequest = SetContentGroupsByKeyRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_ContentGroupByKey = ContentGroupByKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetAppGroupNamesRequest = GetAppGroupNamesRequest;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetAppGroupNamesResponse = GetAppGroupNamesResponse;\n type multilingualLocalizationV1LocalizedContent_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type multilingualLocalizationV1LocalizedContent_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type multilingualLocalizationV1LocalizedContent_universal_d_Asset = Asset;\n type multilingualLocalizationV1LocalizedContent_universal_d_State = State;\n const multilingualLocalizationV1LocalizedContent_universal_d_State: typeof State;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteCreated = SiteCreated;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteCreatedContext = SiteCreatedContext;\n const multilingualLocalizationV1LocalizedContent_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type multilingualLocalizationV1LocalizedContent_universal_d_Namespace = Namespace;\n const multilingualLocalizationV1LocalizedContent_universal_d_Namespace: typeof Namespace;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteTransferred = SiteTransferred;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteDeleted = SiteDeleted;\n type multilingualLocalizationV1LocalizedContent_universal_d_DeleteContext = DeleteContext;\n type multilingualLocalizationV1LocalizedContent_universal_d_DeleteStatus = DeleteStatus;\n const multilingualLocalizationV1LocalizedContent_universal_d_DeleteStatus: typeof DeleteStatus;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteUndeleted = SiteUndeleted;\n type multilingualLocalizationV1LocalizedContent_universal_d_SitePublished = SitePublished;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteUnpublished = SiteUnpublished;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type multilingualLocalizationV1LocalizedContent_universal_d_ServiceProvisioned = ServiceProvisioned;\n type multilingualLocalizationV1LocalizedContent_universal_d_ServiceRemoved = ServiceRemoved;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteRenamed = SiteRenamed;\n type multilingualLocalizationV1LocalizedContent_universal_d_SiteHardDeleted = SiteHardDeleted;\n type multilingualLocalizationV1LocalizedContent_universal_d_NamespaceChanged = NamespaceChanged;\n type multilingualLocalizationV1LocalizedContent_universal_d_StudioAssigned = StudioAssigned;\n type multilingualLocalizationV1LocalizedContent_universal_d_StudioUnassigned = StudioUnassigned;\n type multilingualLocalizationV1LocalizedContent_universal_d_DomainEvent = DomainEvent;\n type multilingualLocalizationV1LocalizedContent_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type multilingualLocalizationV1LocalizedContent_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type multilingualLocalizationV1LocalizedContent_universal_d_RestoreInfo = RestoreInfo;\n type multilingualLocalizationV1LocalizedContent_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type multilingualLocalizationV1LocalizedContent_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type multilingualLocalizationV1LocalizedContent_universal_d_ActionEvent = ActionEvent;\n type multilingualLocalizationV1LocalizedContent_universal_d_MessageEnvelope = MessageEnvelope;\n type multilingualLocalizationV1LocalizedContent_universal_d_IdentificationData = IdentificationData;\n type multilingualLocalizationV1LocalizedContent_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type multilingualLocalizationV1LocalizedContent_universal_d_WebhookIdentityType = WebhookIdentityType;\n const multilingualLocalizationV1LocalizedContent_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const multilingualLocalizationV1LocalizedContent_universal_d_searchEntityContent: typeof searchEntityContent;\n type multilingualLocalizationV1LocalizedContent_universal_d_SearchEntityContentOptions = SearchEntityContentOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_addPersonDetails: typeof addPersonDetails;\n type multilingualLocalizationV1LocalizedContent_universal_d_AddPersonDetailsOptions = AddPersonDetailsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_updatePersonDetails: typeof updatePersonDetails;\n type multilingualLocalizationV1LocalizedContent_universal_d_UpdatePersonDetailsOptions = UpdatePersonDetailsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_deletePersonDetails: typeof deletePersonDetails;\n const multilingualLocalizationV1LocalizedContent_universal_d_list: typeof list;\n const multilingualLocalizationV1LocalizedContent_universal_d_createOrUpdateContentsByKey: typeof createOrUpdateContentsByKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateContentsByKeyOptions = CreateOrUpdateContentsByKeyOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_updateContents: typeof updateContents;\n type multilingualLocalizationV1LocalizedContent_universal_d_UpdateContentsOptions = UpdateContentsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeContentFields: typeof removeContentFields;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsOptions = RemoveContentFieldsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeContentFieldsByKey: typeof removeContentFieldsByKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsByKeyOptions = RemoveContentFieldsByKeyOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_listContents: typeof listContents;\n type multilingualLocalizationV1LocalizedContent_universal_d_ListContentsOptions = ListContentsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeSiteLanguages: typeof removeSiteLanguages;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveSiteLanguagesOptions = RemoveSiteLanguagesOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeContentsByEntityType: typeof removeContentsByEntityType;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByEntityTypeOptions = RemoveContentsByEntityTypeOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_republishSchemaContent: typeof republishSchemaContent;\n type multilingualLocalizationV1LocalizedContent_universal_d_RepublishSchemaContentOptions = RepublishSchemaContentOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_getContentHistory: typeof getContentHistory;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryOptions = GetContentHistoryOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_getContentHistoryByKey: typeof getContentHistoryByKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryByKeyOptions = GetContentHistoryByKeyOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeContents: typeof removeContents;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsOptions = RemoveContentsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeContentsByKey: typeof removeContentsByKey;\n const multilingualLocalizationV1LocalizedContent_universal_d_removeContentsByFilter: typeof removeContentsByFilter;\n type multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByFilterOptions = RemoveContentsByFilterOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_setContentGroups: typeof setContentGroups;\n type multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsOptions = SetContentGroupsOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_setContentGroupsByKey: typeof setContentGroupsByKey;\n type multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsByKeyOptions = SetContentGroupsByKeyOptions;\n const multilingualLocalizationV1LocalizedContent_universal_d_getAppGroupNames: typeof getAppGroupNames;\n namespace multilingualLocalizationV1LocalizedContent_universal_d {\n export {\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContent as LocalizedContent,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentKey as LocalizedContentKey,\n multilingualLocalizationV1LocalizedContent_universal_d_SchemaKey as SchemaKey,\n multilingualLocalizationV1LocalizedContent_universal_d_SchemaScope as SchemaScope,\n multilingualLocalizationV1LocalizedContent_universal_d_LanguageFields as LanguageFields,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentField as LocalizedContentField,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentFieldValueOneOf as LocalizedContentFieldValueOneOf,\n multilingualLocalizationV1LocalizedContent_universal_d_MediaItem as MediaItem,\n multilingualLocalizationV1LocalizedContent_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf,\n multilingualLocalizationV1LocalizedContent_universal_d_VideoResolution as VideoResolution,\n multilingualLocalizationV1LocalizedContent_universal_d_UpdaterIdentity as UpdaterIdentity,\n multilingualLocalizationV1LocalizedContent_universal_d_FieldSequence as FieldSequence,\n multilingualLocalizationV1LocalizedContent_universal_d_SearchEntityContentRequest as SearchEntityContentRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_FieldSearch as FieldSearch,\n multilingualLocalizationV1LocalizedContent_universal_d_TranslationStatus as TranslationStatus,\n multilingualLocalizationV1LocalizedContent_universal_d_Paging as Paging,\n multilingualLocalizationV1LocalizedContent_universal_d_SearchEntityContentResponse as SearchEntityContentResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_Person as Person,\n multilingualLocalizationV1LocalizedContent_universal_d_Image as Image,\n multilingualLocalizationV1LocalizedContent_universal_d_GenericMessage as GenericMessage,\n multilingualLocalizationV1LocalizedContent_universal_d_Hobby as Hobby,\n multilingualLocalizationV1LocalizedContent_universal_d_DetailType as DetailType,\n multilingualLocalizationV1LocalizedContent_universal_d_AddPersonRequest as AddPersonRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_AddPersonResponse as AddPersonResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_UpdatePersonRequest as UpdatePersonRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_UpdatePersonResponse as UpdatePersonResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_DeletePersonRequest as DeletePersonRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_DeletePersonResponse as DeletePersonResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_PersonsListRequest as PersonsListRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_PersonsListResponse as PersonsListResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_Empty as Empty,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentChanged as LocalizedContentChanged,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedLanguageContent as LocalizedLanguageContent,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedLanguageContentKey as LocalizedLanguageContentKey,\n multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateAction as CreateOrUpdateAction,\n multilingualLocalizationV1LocalizedContent_universal_d_DeleteAction as DeleteAction,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizationContentChangedAction as LocalizationContentChangedAction,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizationContentChangedActionActionOneOf as LocalizationContentChangedActionActionOneOf,\n multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateContentsByKeyRequest as CreateOrUpdateContentsByKeyRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_LanguageContentByKey as LanguageContentByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateContentsResponse as CreateOrUpdateContentsResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_UpdateContentsRequest as UpdateContentsRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_LanguageContentById as LanguageContentById,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsRequest as RemoveContentFieldsRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_ContentFieldIdentifier as ContentFieldIdentifier,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsResponse as RemoveContentFieldsResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsByKeyRequest as RemoveContentFieldsByKeyRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_ListContentsRequest as ListContentsRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_LocalizedContentFilter as LocalizedContentFilter,\n multilingualLocalizationV1LocalizedContent_universal_d_FilterSchemaScope as FilterSchemaScope,\n multilingualLocalizationV1LocalizedContent_universal_d_OrderByField as OrderByField,\n multilingualLocalizationV1LocalizedContent_universal_d_ListContentsResponse as ListContentsResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveSiteLanguagesRequest as RemoveSiteLanguagesRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveSiteLanguagesResponse as RemoveSiteLanguagesResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByEntityTypeRequest as RemoveContentsByEntityTypeRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsResponse as RemoveContentsResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_RepublishSchemaContentRequest as RepublishSchemaContentRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_RepublishSchemaContentResponse as RepublishSchemaContentResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryRequest as GetContentHistoryRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryResponse as GetContentHistoryResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_RevisionLocalizedContent as RevisionLocalizedContent,\n multilingualLocalizationV1LocalizedContent_universal_d_Revision as Revision,\n multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryByKeyRequest as GetContentHistoryByKeyRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsRequest as RemoveContentsRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByKeyRequest as RemoveContentsByKeyRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByFilterRequest as RemoveContentsByFilterRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsRequest as SetContentGroupsRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_ContentGroupById as ContentGroupById,\n multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsResponse as SetContentGroupsResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsByKeyRequest as SetContentGroupsByKeyRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_ContentGroupByKey as ContentGroupByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_GetAppGroupNamesRequest as GetAppGroupNamesRequest,\n multilingualLocalizationV1LocalizedContent_universal_d_GetAppGroupNamesResponse as GetAppGroupNamesResponse,\n multilingualLocalizationV1LocalizedContent_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n multilingualLocalizationV1LocalizedContent_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n multilingualLocalizationV1LocalizedContent_universal_d_Asset as Asset,\n multilingualLocalizationV1LocalizedContent_universal_d_State as State,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteCreated as SiteCreated,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteCreatedContext as SiteCreatedContext,\n multilingualLocalizationV1LocalizedContent_universal_d_Namespace as Namespace,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteTransferred as SiteTransferred,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteDeleted as SiteDeleted,\n multilingualLocalizationV1LocalizedContent_universal_d_DeleteContext as DeleteContext,\n multilingualLocalizationV1LocalizedContent_universal_d_DeleteStatus as DeleteStatus,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteUndeleted as SiteUndeleted,\n multilingualLocalizationV1LocalizedContent_universal_d_SitePublished as SitePublished,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteUnpublished as SiteUnpublished,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n multilingualLocalizationV1LocalizedContent_universal_d_ServiceProvisioned as ServiceProvisioned,\n multilingualLocalizationV1LocalizedContent_universal_d_ServiceRemoved as ServiceRemoved,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteRenamed as SiteRenamed,\n multilingualLocalizationV1LocalizedContent_universal_d_SiteHardDeleted as SiteHardDeleted,\n multilingualLocalizationV1LocalizedContent_universal_d_NamespaceChanged as NamespaceChanged,\n multilingualLocalizationV1LocalizedContent_universal_d_StudioAssigned as StudioAssigned,\n multilingualLocalizationV1LocalizedContent_universal_d_StudioUnassigned as StudioUnassigned,\n multilingualLocalizationV1LocalizedContent_universal_d_DomainEvent as DomainEvent,\n multilingualLocalizationV1LocalizedContent_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n multilingualLocalizationV1LocalizedContent_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n multilingualLocalizationV1LocalizedContent_universal_d_RestoreInfo as RestoreInfo,\n multilingualLocalizationV1LocalizedContent_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n multilingualLocalizationV1LocalizedContent_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n multilingualLocalizationV1LocalizedContent_universal_d_ActionEvent as ActionEvent,\n multilingualLocalizationV1LocalizedContent_universal_d_MessageEnvelope as MessageEnvelope,\n multilingualLocalizationV1LocalizedContent_universal_d_IdentificationData as IdentificationData,\n multilingualLocalizationV1LocalizedContent_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n multilingualLocalizationV1LocalizedContent_universal_d_WebhookIdentityType as WebhookIdentityType,\n multilingualLocalizationV1LocalizedContent_universal_d_searchEntityContent as searchEntityContent,\n multilingualLocalizationV1LocalizedContent_universal_d_SearchEntityContentOptions as SearchEntityContentOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_addPersonDetails as addPersonDetails,\n multilingualLocalizationV1LocalizedContent_universal_d_AddPersonDetailsOptions as AddPersonDetailsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_updatePersonDetails as updatePersonDetails,\n multilingualLocalizationV1LocalizedContent_universal_d_UpdatePersonDetailsOptions as UpdatePersonDetailsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_deletePersonDetails as deletePersonDetails,\n multilingualLocalizationV1LocalizedContent_universal_d_list as list,\n multilingualLocalizationV1LocalizedContent_universal_d_createOrUpdateContentsByKey as createOrUpdateContentsByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_CreateOrUpdateContentsByKeyOptions as CreateOrUpdateContentsByKeyOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_updateContents as updateContents,\n multilingualLocalizationV1LocalizedContent_universal_d_UpdateContentsOptions as UpdateContentsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_removeContentFields as removeContentFields,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsOptions as RemoveContentFieldsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_removeContentFieldsByKey as removeContentFieldsByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentFieldsByKeyOptions as RemoveContentFieldsByKeyOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_listContents as listContents,\n multilingualLocalizationV1LocalizedContent_universal_d_ListContentsOptions as ListContentsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_removeSiteLanguages as removeSiteLanguages,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveSiteLanguagesOptions as RemoveSiteLanguagesOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_removeContentsByEntityType as removeContentsByEntityType,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByEntityTypeOptions as RemoveContentsByEntityTypeOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_republishSchemaContent as republishSchemaContent,\n multilingualLocalizationV1LocalizedContent_universal_d_RepublishSchemaContentOptions as RepublishSchemaContentOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_getContentHistory as getContentHistory,\n multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryOptions as GetContentHistoryOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_getContentHistoryByKey as getContentHistoryByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_GetContentHistoryByKeyOptions as GetContentHistoryByKeyOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_removeContents as removeContents,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsOptions as RemoveContentsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_removeContentsByKey as removeContentsByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_removeContentsByFilter as removeContentsByFilter,\n multilingualLocalizationV1LocalizedContent_universal_d_RemoveContentsByFilterOptions as RemoveContentsByFilterOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_setContentGroups as setContentGroups,\n multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsOptions as SetContentGroupsOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_setContentGroupsByKey as setContentGroupsByKey,\n multilingualLocalizationV1LocalizedContent_universal_d_SetContentGroupsByKeyOptions as SetContentGroupsByKeyOptions,\n multilingualLocalizationV1LocalizedContent_universal_d_getAppGroupNames as getAppGroupNames,\n };\n }\n \n export { multilingualLocalizationV1LocalizedContent_universal_d as localization };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-multilingual-localization-public.d.ts", "content": "declare module \"wix-multilingual-localization-public\" {\n /** content with published data only */\n interface LocalizedPublishedContent {\n /** UUID identifier for content. */\n contentId?: string;\n /** compound key identifier for content. */\n contentKey?: LocalizedContentKey;\n /** holds localized published fields for every language this entity has content */\n publishedFieldsPerLanguage?: LanguagePublishedFields[];\n }\n interface LocalizedContentKey {\n /** Schema unique key identifier */\n schemaKey?: SchemaKey;\n /** Unique identifier that represents a specific entity in the app */\n entityId?: string;\n }\n interface SchemaKey {\n /** ID of app that created the schema. */\n appId?: string;\n /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */\n entityType?: string;\n /** Scope schema is defined in (Global/Site) */\n scope?: SchemaScope;\n }\n enum SchemaScope {\n /** Global schema, relevant to all sites */\n GLOBAL = \"GLOBAL\",\n /** Site schema, relevant to specific site only */\n SITE = \"SITE\"\n }\n /** Associate language with the published fields localized in that language */\n interface LanguagePublishedFields {\n /** content IETF BCP 47 language tag */\n languageTag?: string;\n /** localized content list of published fields. */\n languagePublishedFields?: LocalizedPublishedContentField[];\n }\n /** contains only information relevant to UoU */\n interface LocalizedPublishedContentField extends LocalizedPublishedContentFieldValueOneOf {\n /** Field actual localized content as simple text type */\n textValue?: string;\n /** Field actual localized content as rich content editor type */\n wixRichContentEditorValue?: string;\n /** Field actual localized content as media type (image, video or document) */\n mediaValue?: MediaItem;\n /** Field unique identifier. This id has to fit to a schema field id. */\n _id?: string;\n /** In case field is reachable via sequence/s, this array represents all the sequences names in the path, and their corresponding item id. */\n sequencePath?: FieldSequence[];\n }\n /** @oneof */\n interface LocalizedPublishedContentFieldValueOneOf {\n /** Field actual localized content as simple text type */\n textValue?: string;\n /** Field actual localized content as rich content editor type */\n wixRichContentEditorValue?: string;\n /** Field actual localized content as media type (image, video or document) */\n mediaValue?: MediaItem;\n }\n interface MediaItem extends MediaItemMediaOneOf {\n /** Image media item */\n image?: string;\n /** Video media item */\n video?: string;\n /** Document media item */\n document?: string;\n }\n /** @oneof */\n interface MediaItemMediaOneOf {\n /** Image media item */\n image?: string;\n /** Video media item */\n video?: string;\n /** Document media item */\n document?: 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 /**\n * Deprecated. Use the `posters` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n poster?: string;\n /** Video format for example, mp4, hls. */\n format?: string;\n /**\n * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.\n * @internal\n * @deprecated\n */\n urlExpirationDate?: Date | null;\n /**\n * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.\n * @internal\n * @deprecated\n */\n sizeInBytes?: string | null;\n /**\n * Video quality. For example: 480p, 720p.\n * @internal\n */\n quality?: string | null;\n /**\n * Video filename.\n * @internal\n */\n filename?: string | null;\n /**\n * Video duration in seconds.\n * @internal\n * @readonly\n * @deprecated Video duration in seconds.\n * @replacedBy duration_in_milliseconds\n * @targetRemovalDate 2024-08-01\n */\n durationInSeconds?: number | null;\n /**\n * Video duration in milliseconds.\n * @internal\n * @readonly\n */\n durationInMilliseconds?: 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 * @internal\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 * @internal\n * @readonly\n */\n assetKey?: string | null;\n }\n interface FieldSequence {\n /** Name of sequence */\n seqName?: string;\n /** Id of relevant item in the sequence */\n itemId?: string;\n /** Optional field - in case set sequences will be ordered by priority index (best effort) */\n priorityIndex?: number | null;\n }\n interface LocalizedPublishedLanguageContentChanged {\n /** The action that changed the content */\n action?: LocalizationPublicAction;\n /** token to identify the flow this event is part of and the total number of event in this flow. */\n flowToken?: string | null;\n }\n interface LocalizationPublicActionLocalizedPublishedContent {\n /** UUID identifier for content. */\n contentId?: string;\n /** compound key identifier for content. */\n contentKey?: LocalizedContentKey;\n /** content IETF BCP 47 language tag */\n languageTag?: string;\n /** localized content list of published fields. */\n languagePublishedFields?: LocalizedPublishedContentField[];\n /** Optional field that will group in the UI contents with the same group name */\n groupByName?: string | null;\n }\n interface LocalizationPublicActionCreateOrUpdateAction {\n /** The new Localized published state */\n localizedPublishedContent?: LocalizationPublicActionLocalizedPublishedContent;\n }\n interface LocalizationPublicActionDeleteAction {\n /** compound key identifier for removed content. */\n contentKey?: LocalizedContentKey;\n /** content IETF BCP 47 language tag */\n languageTag?: string;\n }\n interface LocalizationPublicAction extends LocalizationPublicActionActionOneOf {\n /** Content has changes in its fields */\n createOrUpdateAction?: LocalizationPublicActionCreateOrUpdateAction;\n /** Content deleted */\n deleteAction?: LocalizationPublicActionDeleteAction;\n }\n /** @oneof */\n interface LocalizationPublicActionActionOneOf {\n /** Content has changes in its fields */\n createOrUpdateAction?: LocalizationPublicActionCreateOrUpdateAction;\n /** Content deleted */\n deleteAction?: LocalizationPublicActionDeleteAction;\n }\n interface GetPublishedContentsRequest {\n /** Selected content ids for fetching published fields */\n contentIds?: string[];\n /** Optional list of language tags. Will return partial contents containing only fields that are localized in languages from given list or empty contents if there are no such fields */\n languageMask?: string[];\n }\n interface GetPublishedContentsResponse {\n /** List of site localized published contents */\n localizedPublishedContents?: LocalizedPublishedContent[];\n }\n interface GetPublishedContentsByKeyRequest {\n /** Selected content keys for fetching published fields */\n contentKeys?: LocalizedContentKey[];\n /** Optional list of language tags. Will return partial contents containing only fields that are localized in languages from given list or empty contents if there are no such fields */\n languageMask?: 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 * Get published contents by id\n * @internal\n * @documentationMaturity preview\n * @permissionId WIX_MULTILINGUAL.READ_TRANSLATIONS\n */\n function getPublishedContents(options?: GetPublishedContentsOptions): Promise;\n interface GetPublishedContentsOptions {\n /** Selected content ids for fetching published fields */\n contentIds?: string[];\n /** Optional list of language tags. Will return partial contents containing only fields that are localized in languages from given list or empty contents if there are no such fields */\n languageMask?: string[];\n }\n /**\n * Get published contents by key\n * @internal\n * @documentationMaturity preview\n * @requiredField options.contentKeys.schemaKey\n * @permissionId WIX_MULTILINGUAL.READ_TRANSLATIONS\n */\n function getPublishedContentsByKey(options?: GetPublishedContentsByKeyOptions): Promise;\n interface GetPublishedContentsByKeyOptions {\n /** Selected content keys for fetching published fields */\n contentKeys?: LocalizedContentKey[];\n /** Optional list of language tags. Will return partial contents containing only fields that are localized in languages from given list or empty contents if there are no such fields */\n languageMask?: string[];\n }\n \n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedContent = LocalizedPublishedContent;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedContentKey = LocalizedContentKey;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_SchemaKey = SchemaKey;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_SchemaScope = SchemaScope;\n const multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_SchemaScope: typeof SchemaScope;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LanguagePublishedFields = LanguagePublishedFields;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedContentField = LocalizedPublishedContentField;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedContentFieldValueOneOf = LocalizedPublishedContentFieldValueOneOf;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_MediaItem = MediaItem;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_MediaItemMediaOneOf = MediaItemMediaOneOf;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_FocalPoint = FocalPoint;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_VideoResolution = VideoResolution;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_FieldSequence = FieldSequence;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedLanguageContentChanged = LocalizedPublishedLanguageContentChanged;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionLocalizedPublishedContent = LocalizationPublicActionLocalizedPublishedContent;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionCreateOrUpdateAction = LocalizationPublicActionCreateOrUpdateAction;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionDeleteAction = LocalizationPublicActionDeleteAction;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicAction = LocalizationPublicAction;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionActionOneOf = LocalizationPublicActionActionOneOf;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsRequest = GetPublishedContentsRequest;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsResponse = GetPublishedContentsResponse;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsByKeyRequest = GetPublishedContentsByKeyRequest;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_MessageEnvelope = MessageEnvelope;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_IdentificationData = IdentificationData;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_WebhookIdentityType = WebhookIdentityType;\n const multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_getPublishedContents: typeof getPublishedContents;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsOptions = GetPublishedContentsOptions;\n const multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_getPublishedContentsByKey: typeof getPublishedContentsByKey;\n type multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsByKeyOptions = GetPublishedContentsByKeyOptions;\n namespace multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d {\n export {\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedContent as LocalizedPublishedContent,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedContentKey as LocalizedContentKey,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_SchemaKey as SchemaKey,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_SchemaScope as SchemaScope,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LanguagePublishedFields as LanguagePublishedFields,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedContentField as LocalizedPublishedContentField,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedContentFieldValueOneOf as LocalizedPublishedContentFieldValueOneOf,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_MediaItem as MediaItem,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_MediaItemMediaOneOf as MediaItemMediaOneOf,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_FocalPoint as FocalPoint,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_VideoResolution as VideoResolution,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_FieldSequence as FieldSequence,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizedPublishedLanguageContentChanged as LocalizedPublishedLanguageContentChanged,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionLocalizedPublishedContent as LocalizationPublicActionLocalizedPublishedContent,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionCreateOrUpdateAction as LocalizationPublicActionCreateOrUpdateAction,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionDeleteAction as LocalizationPublicActionDeleteAction,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicAction as LocalizationPublicAction,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_LocalizationPublicActionActionOneOf as LocalizationPublicActionActionOneOf,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsRequest as GetPublishedContentsRequest,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsResponse as GetPublishedContentsResponse,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsByKeyRequest as GetPublishedContentsByKeyRequest,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_MessageEnvelope as MessageEnvelope,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_IdentificationData as IdentificationData,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_WebhookIdentityType as WebhookIdentityType,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_getPublishedContents as getPublishedContents,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsOptions as GetPublishedContentsOptions,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_getPublishedContentsByKey as getPublishedContentsByKey,\n multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d_GetPublishedContentsByKeyOptions as GetPublishedContentsByKeyOptions,\n };\n }\n \n export { multilingualLocalizationPublicV1LocalizedPublishedContent_universal_d as localizationPublic };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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. See here to\n * [learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_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.\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. See 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 * @internal\n * @internal\n * @readonly\n * @deprecated __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.\n * @replacedBy pricing\n * @targetRemovalDate 2022-10-01\n */\n priceDetails?: PriceDetails;\n /**\n * Pricing model, price, and payment schedule for the order.\n * @readonly\n */\n pricing?: PricingDetails;\n /**\n * How the order was processed. Supported values:\n * + `\"ONLINE\"`: The buyer purchased the plan using the site.\n * + `\"OFFLINE\"`: The buyer made a manual, offline purchase without using the site.\n * @readonly\n */\n type?: OrderType;\n /**\n * Method by which checkout was initiated on buyer's behalf.\n * @internal\n * @readonly\n */\n orderMethod?: OrderMethod;\n /**\n * Status of the order. Supported values:\n * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.\n * + `PENDING`: Order has been purchased and its start date is set in the future.\n * + `ACTIVE`: Order has been processed. The plan is available for use.\n * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).\n * + `ENDED`: Order has completed its duration and is no longer available for use.\n * + `CANCELED`: Order has been [canceled](#cancelorder).\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 *\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 site owner for offline orders.\n *\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 * @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. If the order is [paused](#pauseorder),\n * it will have a later `endDate` once it [resumes](#resumeorder). `endDate` may also be [postponed](#postponeenddate).\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 * Past and current cycles for the order.\n * @internal\n * @readonly\n */\n cycles?: OrderCycle[];\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 * TODO PPL-1357: Remove when migration to new status is completed\n * @internal\n */\n statusNew?: OrderStatus;\n }\n interface Buyer {\n /**\n * Member ID for a buyer.\n * @readonly\n */\n memberId?: string;\n /**\n * Contact ID for a buyer.\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. */\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 /**\n * Additional fees that would have been applied to the price, one of which could be a setup fee.\n *\n * Tax is also applied to additional fees.\n * @internal\n * @readonly\n */\n fees?: Fee$1[];\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](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order). The order, and use of the plan, can be [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order). */\n PAUSED = \"PAUSED\",\n /** Order has completed its duration and is no longer available for use. */\n ENDED = \"ENDED\",\n /** Order has been [canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/cancel-order). */\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 /** Site owner 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 /**\n * Status of the pause period. Supported values:\n * + `ACTIVE`: Status while the order is [paused](#pauseorder).\n * + `ENDED`: Status when the order is [resumed](#resumeorder).\n */\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](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order). */\n ACTIVE = \"ACTIVE\",\n /** Status when the order is [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order). */\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 form 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 *\n * This field is returned when a method's `fieldset` is set to `\"FULL\"`.\n *\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface MemberListOrdersResponse {\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 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 * 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 * @internal\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 /**\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](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).\n */\n interface QueryOrdersRequest {\n /** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\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 /**\n * Whether to cancel the order immediately or at the next payment date.\n * One-time payment orders can only be canceled immediately.\n *\n * Supported values:\n * - `\"IMMEDIATELY\"`: Indicates that the order should be canceled immediately.\n * - `\"NEXT_PAYMENT_DATE\"`: Indicates that the order be canceled at the next payment date.\n */\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 for the ordered plan.\n *\n * Default: Current date\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 /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n interface OnBehalf {\n /** Member ID. */\n memberId?: string;\n /** Method by which checkout is initiated on buyer's behalf */\n orderMethod?: OrderMethod;\n }\n interface CreateOnlineOrderResponse {\n /** 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. */\n planId: string;\n /** ID of the member ordering the plan. */\n memberId: string;\n /**\n * Start date and time for the ordered plan.\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 /**\n * Coupon code to apply.\n *\n * See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).\n */\n couponCode?: string | null;\n /** Form submission id that was submitted together 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 for the ordered plan.\n *\n * Default: Current date\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n interface GetOnlineOrderPreviewResponse {\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 member.\n * Always false for plans without purchase limits.\n */\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. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */\n planId: string;\n /** Member ID of the buyer the previewed order is for. */\n memberId: string;\n /**\n * Start date and time for plan of the previewed order.\n *\n * Default: Current date and time\n */\n startDate?: Date | null;\n /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */\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 /**\n * Coupon code to apply.\n *\n * See Coupons [to learn more](https://dev.wix.com/api/rest/coupons).\n */\n couponCode?: string | null;\n }\n interface GetPricePreviewResponse {\n /**\n * @internal\n * @internal\n * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.\n * @replacedBy prices\n * @targetRemovalDate 2022-10-01\n */\n price?: PriceDetails;\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. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members). */\n buyerIds?: string[];\n /** Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */\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 [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_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 * Filter by order IDs.\n * @internal\n */\n orderIds?: string[];\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 /** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\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 /**\n * When the order is canceled.\n *\n * One time orders can only be canceled immediately. Supported values:\n * - `\"IMMEDIATELY\"`: The order is canceled immediately.\n * - `\"NEXT_PAYMENT_DATE\"`: The order is canceled at the next payment date.\n */\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 * Gets an order by ID for the currently logged-in member.\n *\n * The `memberGetOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.\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 * @returns Requested order.\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 * Lists orders for the currently logged-in member.\n *\n * The `memberListOrders()` function returns a Promise that resolves to a list of up to 100 pricing plan orders.\n * @public\n * @documentationMaturity preview\n * @param options - Filtering, sorting, and pagination options.\n * @permissionId PRICING_PLANS.READ_OWN_ORDERS\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 /**\n * Filter by the order status. Supported values:\n * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.\n * + `PENDING`: Order has been purchased and its start date is set in the future.\n * + `ACTIVE`: Order has been processed. The plan is available for use.\n * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).\n * + `ENDED`: Order has completed its duration and is no longer available for use.\n * + `CANCELED`: Order has been [canceled](#cancelorder).\n */\n orderStatuses?: OrderStatus[];\n /**\n * Key Path to edit\n * ManagementListOrdersOptions.paymentStatuses\n * Production value\n * Filter by payment status.\n * Override\n * Filter by payment status.\n *\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 * Mark down view\n * Filter by payment status.\n *\n * Supported values:\n *\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 paymentStatuses?: PaymentStatus[];\n /**\n * Number of pricing plan orders to return.\n *\n * Default: `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: `ASC`\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 /**\n * Returns orders for currently logged in member based on provided query\n * @internal\n * @permissionId PRICING_PLANS.READ_OWN_ORDERS\n */\n function memberQueryOrders(): PlansQueryBuilder$1;\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 */\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 */\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 */\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 */\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 */\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 */\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 */\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 */\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 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 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 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 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 limit: (limit: number) => PlansQueryBuilder$1;\n /** @param cursor - A pointer to specific record */\n skipTo: (cursor: string) => PlansQueryBuilder$1;\n find: () => Promise;\n }\n /**\n * Starts the process of canceling an order.\n *\n *\n * The `requestCancellation()` function returns a Promise that resolves when the order cancellation is successfully requested.\n *\n * For orders with recurring payments, a cancellation can be set to occur either immediately or at the next payment date. For orders with one-time payments, a cancellation occurs immediately after the request is processed.\n *\n * Requesting an order cancellation starts the cancellation process. 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.\n *\n * 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 * @param _id - Order ID.\n * @param effectiveAt - Whether to cancel the order immediately or at the next payment date.\n * One-time payment orders can only be canceled immediately.\n *\n * Supported values:\n * - `\"IMMEDIATELY\"`: Indicates that the order should be canceled immediately.\n * - `\"NEXT_PAYMENT_DATE\"`: Indicates that the order be canceled at the next payment date.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField effectiveAt\n * @param options - Options for requesting a cancellation.\n * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS\n * @returns Fulfilled - When the cancellation process is started.\n */\n function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAt): Promise;\n /**\n * Creates an order and initiates payment for currently logged in member.\n * Will not be exposed to 3rd parties until Wix Payments are exposed.\n * @param planId - Plan ID.\n * @internal\n * @requiredField options.onBehalf.memberId\n * @requiredField planId\n * @adminMethod\n */\n function createOnlineOrder(planId: string, options?: CreateOnlineOrderOptions): Promise;\n interface CreateOnlineOrderOptions {\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 /** Provided if checkout is initiated on buyer's behalf. */\n onBehalf?: OnBehalf;\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n /**\n * Creates an order and initiates payment for currently logged in member.\n * Will not be exposed to 3rd parties until Wix Payments are exposed.\n * @param planId - Plan ID.\n * @internal\n * @requiredField options.captcha\n * @requiredField options.captcha.token\n * @requiredField options.guest\n * @requiredField options.guest.email\n * @requiredField planId\n * @permissionId PRICING_PLANS.CREATE_GUEST_ORDER\n * @deprecated\n * @targetRemovalDate 2025-07-31\n */\n function createGuestOnlineOrder(planId: string, options?: CreateGuestOnlineOrderOptions): Promise;\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 * The `createOfflineOrder()` function returns a Promise that resolves to an `order` object when the order has been created.\n *\n * Payment of an offline order is handled in 1 of 2 ways.\n * - When creating the order, select `true` in the `paid` request parameter.\n * - After creation, with the [`markAsPaid()`](#markaspaid) function.\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\"`.\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 * @param memberId - ID of the member ordering the plan.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @requiredField planId\n * @param options - Options for creating an offline order.\n * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](plans)\n * @permissionId PRICING_PLANS.REGISTER_OFFLINE_ORDERS\n * @adminMethod\n * @returns Fulfilled - The order of the plan.\n */\n function createOfflineOrder(planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise;\n interface CreateOfflineOrderOptions {\n /**\n * Start date and time for the ordered plan.\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. */\n couponCode?: string | null;\n /** Form submission ID that was submitted together with the order. */\n submissionId?: string | null;\n }\n /**\n * Creates an order with payment method \"EXTERNAL\" and initiates payment for currently logged in member.\n * Will not be exposed to 3rd parties until Wix Payments are exposed.\n * @param planId - Plan ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField planId\n * @adminMethod\n */\n function createExternalOrder(planId: string, options?: CreateExternalOrderOptions): Promise;\n interface CreateExternalOrderOptions {\n /** Form submission id that was submitted together with the order */\n submissionId?: string | null;\n }\n /**\n * Forms an order preview using same logic as purchasing, except that it is not persisted anywhere.\n * Checks for purchase limitations, intended to be called with member identity.\n * [More information on tax here](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n * Will not be exposed until CreateOnlineOrder is exposed.\n * @param planId - Plan ID.\n * @internal\n * @requiredField planId\n * @permissionId PRICING_PLANS.PURCHASE_PLANS\n */\n function getOnlineOrderPreview(planId: string, options?: GetOnlineOrderPreviewOptions): Promise;\n interface GetOnlineOrderPreviewOptions {\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 }\n /**\n * Forms an order preview using same logic as purchasing, except that it is not persisted anywhere.\n * Checks for purchase limitations\n * [More information on tax here](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).\n * Will not be exposed until CreateGuestOnlineOrder is exposed.\n * @param planId - Plan ID.\n * @internal\n * @requiredField options.email\n * @requiredField planId\n * @permissionId PRICING_PLANS.CREATE_GUEST_ORDER\n * @deprecated\n * @targetRemovalDate 2025-07-31\n */\n function getGuestOnlineOrderPreview(planId: string, options?: GetGuestOnlineOrderPreviewOptions): Promise;\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 * Provides a preview of an offline order as if it was purchased.\n *\n * The `getOfflineOrderPreview()` function returns a Promise that resolves to a temporary preview of the offline order.\n *\n * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually created, the preview's `_id` and `subscriptionId` properties are displayed as a string of multiple zero characters (`000000-0000`).\n *\n * If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, `tax` previews as `null`.\n *\n * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.\n * @param memberId - Member ID of the buyer the previewed order is for.\n * @public\n * @documentationMaturity preview\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 * @adminMethod\n * @returns Fulfilled - A preview of the order.\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.\n *\n * Default: Current date and time\n */\n startDate?: Date | null;\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n /**\n * Retrieves a preview of an order's pricing as if it was purchased.\n *\n * The `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.\n *\n * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.\n *\n * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](#getofflineorderpreview).\n * @param planId - ID of plan to preview.\n * @public\n * @documentationMaturity preview\n * @requiredField planId\n * @param options - Options for getting a price preview.\n * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS\n * @returns Fulfilled - A preview of the pricing for the order.\n */\n function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise;\n interface GetPricePreviewOptions {\n /** Coupon code to apply. */\n couponCode?: string | null;\n }\n /**\n * Changes the start date of a draft order.\n *\n * Deprecated: use CreateOnlineOrder or CreateOfflineOrder with the desired start date to create a new order\n * instead.\n * @param orderId - Draft order ID.\n * @param startDate - New valid from date (timestamp).\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField startDate\n * @permissionId PRICING_PLANS.CHANGE_START_DATE\n * @deprecated\n * @replacedBy com.wixpress.membership.v2.orders.CheckoutService.CreateOnlineOrder\n * @targetRemovalDate 2025-07-31\n */\n function changeStartDate(orderId: string, startDate: Date | null): Promise;\n /**\n * Applies a coupon to an order and recalculates tax if needed. Should be called at the last moment before the payment.\n * If you don't want to make change to an order and only want to see the plan price with applied coupon\n * you can use GetPricePreview, GetOnlineOrderPreview or GetOfflineOrderPreview endpoints with coupon code.\n *\n * Deprecated: use CreateOnlineOrder or CreateOfflineOrder with the coupon code to create a new order with the\n * coupon applied instead.\n * @param orderId - Draft order ID.\n * @param couponCode - Coupon code to apply.\n * @internal\n * @documentationMaturity preview\n * @requiredField couponCode\n * @requiredField orderId\n * @permissionId PRICING_PLANS.APPLY_COUPON\n * @deprecated\n * @replacedBy com.wixpress.membership.v2.orders.CheckoutService.CreateOnlineOrder\n * @targetRemovalDate 2025-07-31\n */\n function applyCoupon(orderId: string, couponCode: string): Promise;\n /**\n * Adds to a draft order reference to a submission. Member can only revise orders what were created by them.\n *\n * Deprecated: use CreateOnlineOrder or CreateOfflineOrder with the submission to create a new order with submission\n * instead.\n * @param orderId - Order ID.\n * @param submissionId - Submission ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField orderId\n * @requiredField submissionId\n * @permissionId PRICING_PLANS.SET_SUBMISSION\n * @deprecated\n * @replacedBy com.wixpress.membership.v2.orders.CheckoutService.CreateOnlineOrder\n * @targetRemovalDate 2025-07-31\n */\n function setSubmission(orderId: string, submissionId: string): Promise;\n /**\n * Retrieves an order by ID.\n *\n * The `managementGetOrder()` function returns a Promise that resolves to information about the specified order.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @param options - Options to use when getting an order.\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @adminMethod\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 * Lists pricing plan orders.\n *\n * The `managementListOrders()` function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.\n *\n * This function returns the orders on the site. To list orders for the currently logged-in member, use [`memberListOrders()`](#memberlistorders).\n * @public\n * @documentationMaturity preview\n * @param options - Filtering, sorting, and pagination options.\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @adminMethod\n */\n function managementListOrders(options?: ManagementListOrdersOptions): Promise;\n interface ManagementListOrdersOptions {\n /** Filter by specific member IDs of buyers who ordered a pricing plan. */\n buyerIds?: string[];\n /** Filter by specific IDs of plans that were ordered. */\n planIds?: string[];\n /** Filter by whether or not the auto-renewal of recurring orders was canceled. */\n autoRenewCanceled?: boolean | null;\n /**\n * Filter by the order status. Supported values:\n * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.\n * + `PENDING`: Order has been purchased and its start date is set in the future.\n * + `ACTIVE`: Order has been processed. The plan is available for use.\n * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).\n * + `ENDED`: Order has completed its duration and is no longer available for use.\n * + `CANCELED`: Order has been [canceled](#cancelorder).\n */\n orderStatuses?: OrderStatus[];\n /**\n * Filter by payment status.\n *\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 paymentStatuses?: PaymentStatus[];\n /**\n * Number of pricing plan orders to return.\n *\n * Default: `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 * Filter by order IDs.\n * @internal\n */\n orderIds?: string[];\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](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).\n * @internal\n * @documentationMaturity preview\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @adminMethod\n */\n function managementQueryOrders(options?: ManagementQueryOrdersOptions): Promise;\n interface ManagementQueryOrdersOptions {\n /** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */\n query?: QueryV2$1;\n }\n /**\n * Retrieves statistics about the pricing plans orders. Currently providing the total number of orders and active orders.\n * @internal\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @adminMethod\n */\n function getOrdersStats(): Promise;\n /** @param _id - Order ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId PRICING_PLANS.READ_ORDERS\n * @adminMethod\n */\n function getAvailableOrderActions(_id: string): Promise;\n /**\n * Extends the duration of a pricing plan order by postponing the order's `endDate`.\n *\n * The `postponeEndDate()` function returns a Promise that resolves when the order's end date is successfully changed.\n *\n * The new end date and time must be later than the order's current `endDate`.\n *\n * Postponing the end date of an order does not impact payments. For example, if the pricing plan is for a membership to an online lecture series, and you want to extend the duration of the series because the lecturer could not attend some sessions, you can postpone the end date of the orders for all relevant participants. The participants will not be billed additionally.\n *\n * Postponing an order causes the following changes:\n * - The `endDate` for the order is adjusted to the new end date.\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 * @documentationMaturity preview\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 * @adminMethod\n * @returns Fulfilled - When the order's end date has been postponed or made earlier.\n *\n *\n */\n function postponeEndDate(_id: string, endDate: Date | null): Promise;\n /**\n * Cancels an existing order.\n *\n * The `cancelOrder()` function returns a Promise that resolves when the order is successfully canceled.\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 occurs `IMMEDIATELY`.\n *\n * Canceling an order changes the order status to `CANCELED`.\n *\n * #### Canceling during the free trial period.\n *\n * When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.\n *\n * Canceling `IMMEDIATELY` will end the subscription for the buyer\n * immediately, even during the free trial period and the buyer won't be billed.\n *\n * Canceling at the `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period. Then, the subscription ends and the buyer is not billed.\n * @param _id - Order ID.\n * @param effectiveAt - When the order is canceled.\n *\n * One time orders can only be canceled immediately. Supported values:\n * - `\"IMMEDIATELY\"`: The order is canceled immediately.\n * - `\"NEXT_PAYMENT_DATE\"`: The order is canceled at the next payment date.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField effectiveAt\n * @param options - Options for canceling orders.\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @adminMethod\n * @returns Fulfilled - When the order is canceled.\n */\n function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAt): Promise;\n /**\n * Marks an offline order as paid.\n *\n * The `markAsPaid()` function returns a Promise that resolves when the offline order is successfully marked as paid.\n *\n * The entire order is marked as paid, even if the order's payments are recurring.\n *\n * >**Note:** Marking separate payment cycles as paid is not yet supported. 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 make an offline order as paid twice.\n * - Mark an online order as paid. The `markAsPaid()` function is supported for offline orders only.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @adminMethod\n * @returns Fulfilled - When the order is marked as paid.\n */\n function markAsPaid(_id: string): Promise;\n /**\n * Pauses a pricing plan order.\n *\n * The `pauseOrder()` function returns a Promise that resolves when the order is successfully paused.\n *\n * For orders with recurring payments, `pauseOrder()` also pauses the payment schedule. Buyers are not charged when an order is paused. Use `pauseOrder()`, for example, if the buyer is away and would like to put their pricing plan membership on hold until they return. Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. You can only pause orders with an `\"ACTIVE`\" status.\n *\n * Pausing an order causes the following changes:\n * - The order status changes to `\"PAUSED\"`.\n * - The `pausePeriods` array is updated.\n *\n * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.\n *\n * Paused orders can be continued with the [`resumeOrder()`](#resumeorder) function.\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @adminMethod\n * @returns Fulfilled - When the order is paused.\n */\n function pauseOrder(_id: string): Promise;\n /**\n * Pauses multiple orders.\n * @param ids - List of Order IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @adminMethod\n */\n function bulkPauseOrder(ids: string[], options?: BulkPauseOrderOptions): Promise;\n interface BulkPauseOrderOptions {\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n /**\n * Resumes a paused pricing plan order.\n *\n * The `resumeOrder()` function returns a Promise that resolves when a paused order is successfully resumed.\n *\n * For orders with recurring payments, `resumeOrder()` 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 * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).\n * @param _id - Order ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @adminMethod\n * @returns Fulfilled - When the order is resumed.\n */\n function resumeOrder(_id: string): Promise;\n /**\n * Resumes multiple paused orders.\n * @param ids - List of Order IDs.\n * @internal\n * @documentationMaturity preview\n * @requiredField ids\n * @permissionId PRICING_PLANS.MANAGE_ORDERS\n * @adminMethod\n */\n function bulkResumeOrder(ids: string[], options?: BulkResumeOrderOptions): Promise;\n interface BulkResumeOrderOptions {\n /** Set to true to return Order entity in response. */\n returnFullEntity?: boolean;\n }\n \n type pricingPlansV2Order_universal_d_Order = Order;\n type pricingPlansV2Order_universal_d_Buyer = Buyer;\n type pricingPlansV2Order_universal_d_PriceDetails = PriceDetails;\n type pricingPlansV2Order_universal_d_PriceDetailsPricingModelOneOf = PriceDetailsPricingModelOneOf;\n type pricingPlansV2Order_universal_d_Tax = Tax;\n type pricingPlansV2Order_universal_d_Coupon = Coupon;\n type pricingPlansV2Order_universal_d_PricingDetails = PricingDetails;\n type pricingPlansV2Order_universal_d_PricingDetailsPricingModelOneOf = PricingDetailsPricingModelOneOf;\n type pricingPlansV2Order_universal_d_SpannedPrice = SpannedPrice;\n type pricingPlansV2Order_universal_d_PriceDuration = PriceDuration;\n type pricingPlansV2Order_universal_d_Price = Price;\n type pricingPlansV2Order_universal_d_OrderType = OrderType;\n const pricingPlansV2Order_universal_d_OrderType: typeof OrderType;\n type pricingPlansV2Order_universal_d_OrderMethod = OrderMethod;\n const pricingPlansV2Order_universal_d_OrderMethod: typeof OrderMethod;\n type pricingPlansV2Order_universal_d_OrderStatus = OrderStatus;\n const pricingPlansV2Order_universal_d_OrderStatus: typeof OrderStatus;\n type pricingPlansV2Order_universal_d_Cancellation = Cancellation;\n type pricingPlansV2Order_universal_d_CancellationCause = CancellationCause;\n const pricingPlansV2Order_universal_d_CancellationCause: typeof CancellationCause;\n type pricingPlansV2Order_universal_d_CancellationEffectiveAt = CancellationEffectiveAt;\n const pricingPlansV2Order_universal_d_CancellationEffectiveAt: typeof CancellationEffectiveAt;\n type pricingPlansV2Order_universal_d_PaymentStatus = PaymentStatus;\n const pricingPlansV2Order_universal_d_PaymentStatus: typeof PaymentStatus;\n type pricingPlansV2Order_universal_d_PausePeriod = PausePeriod;\n type pricingPlansV2Order_universal_d_Status = Status;\n const pricingPlansV2Order_universal_d_Status: typeof Status;\n type pricingPlansV2Order_universal_d_CurrentCycle = CurrentCycle;\n type pricingPlansV2Order_universal_d_OrderCycle = OrderCycle;\n type pricingPlansV2Order_universal_d_FormData = FormData;\n type pricingPlansV2Order_universal_d_Empty = Empty;\n type pricingPlansV2Order_universal_d_MemberGetOrderRequest = MemberGetOrderRequest;\n type pricingPlansV2Order_universal_d_Set = Set;\n const pricingPlansV2Order_universal_d_Set: typeof Set;\n type pricingPlansV2Order_universal_d_MemberGetOrderResponse = MemberGetOrderResponse;\n type pricingPlansV2Order_universal_d_MemberListOrdersRequest = MemberListOrdersRequest;\n type pricingPlansV2Order_universal_d_MemberListOrdersResponse = MemberListOrdersResponse;\n type pricingPlansV2Order_universal_d_QueryOrdersRequest = QueryOrdersRequest;\n type pricingPlansV2Order_universal_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;\n type pricingPlansV2Order_universal_d_CursorPaging = CursorPaging;\n type pricingPlansV2Order_universal_d_QueryOrdersResponse = QueryOrdersResponse;\n type pricingPlansV2Order_universal_d_RequestCancellationRequest = RequestCancellationRequest;\n type pricingPlansV2Order_universal_d_RequestCancellationResponse = RequestCancellationResponse;\n type pricingPlansV2Order_universal_d_OrderCanceled = OrderCanceled;\n type pricingPlansV2Order_universal_d_CreateOnlineOrderRequest = CreateOnlineOrderRequest;\n type pricingPlansV2Order_universal_d_OnBehalf = OnBehalf;\n type pricingPlansV2Order_universal_d_CreateOnlineOrderResponse = CreateOnlineOrderResponse;\n type pricingPlansV2Order_universal_d_CouponsError = CouponsError;\n type pricingPlansV2Order_universal_d_CreateGuestOnlineOrderRequest = CreateGuestOnlineOrderRequest;\n type pricingPlansV2Order_universal_d_Captcha = Captcha;\n type pricingPlansV2Order_universal_d_Guest = Guest;\n type pricingPlansV2Order_universal_d_CreateGuestOnlineOrderResponse = CreateGuestOnlineOrderResponse;\n type pricingPlansV2Order_universal_d_CreateOfflineOrderRequest = CreateOfflineOrderRequest;\n type pricingPlansV2Order_universal_d_CreateOfflineOrderResponse = CreateOfflineOrderResponse;\n type pricingPlansV2Order_universal_d_CreateExternalOrderRequest = CreateExternalOrderRequest;\n type pricingPlansV2Order_universal_d_CreateExternalOrderResponse = CreateExternalOrderResponse;\n type pricingPlansV2Order_universal_d_GetOnlineOrderPreviewRequest = GetOnlineOrderPreviewRequest;\n type pricingPlansV2Order_universal_d_GetOnlineOrderPreviewResponse = GetOnlineOrderPreviewResponse;\n type pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewRequest = GetGuestOnlineOrderPreviewRequest;\n type pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewResponse = GetGuestOnlineOrderPreviewResponse;\n type pricingPlansV2Order_universal_d_GetOfflineOrderPreviewRequest = GetOfflineOrderPreviewRequest;\n type pricingPlansV2Order_universal_d_GetOfflineOrderPreviewResponse = GetOfflineOrderPreviewResponse;\n type pricingPlansV2Order_universal_d_GetPricePreviewRequest = GetPricePreviewRequest;\n type pricingPlansV2Order_universal_d_GetPricePreviewResponse = GetPricePreviewResponse;\n type pricingPlansV2Order_universal_d_ChangeStartDateRequest = ChangeStartDateRequest;\n type pricingPlansV2Order_universal_d_ChangeStartDateResponse = ChangeStartDateResponse;\n type pricingPlansV2Order_universal_d_OrderStartDateChanged = OrderStartDateChanged;\n type pricingPlansV2Order_universal_d_ApplyCouponRequest = ApplyCouponRequest;\n type pricingPlansV2Order_universal_d_ApplyCouponResponse = ApplyCouponResponse;\n type pricingPlansV2Order_universal_d_SetSubmissionRequest = SetSubmissionRequest;\n type pricingPlansV2Order_universal_d_SetSubmissionResponse = SetSubmissionResponse;\n type pricingPlansV2Order_universal_d_OrderPurchased = OrderPurchased;\n type pricingPlansV2Order_universal_d_OrderStarted = OrderStarted;\n type pricingPlansV2Order_universal_d_OrderCycleStarted = OrderCycleStarted;\n type pricingPlansV2Order_universal_d_OrderAutoRenewCanceled = OrderAutoRenewCanceled;\n type pricingPlansV2Order_universal_d_OrderEnded = OrderEnded;\n type pricingPlansV2Order_universal_d_GetOrderRequest = GetOrderRequest;\n type pricingPlansV2Order_universal_d_GetOrderResponse = GetOrderResponse;\n type pricingPlansV2Order_universal_d_ListOrdersRequest = ListOrdersRequest;\n type pricingPlansV2Order_universal_d_ListOrdersResponse = ListOrdersResponse;\n type pricingPlansV2Order_universal_d_OrdersQueryOrdersRequest = OrdersQueryOrdersRequest;\n type pricingPlansV2Order_universal_d_OrdersQueryOrdersResponse = OrdersQueryOrdersResponse;\n type pricingPlansV2Order_universal_d_GetOrdersStatsRequest = GetOrdersStatsRequest;\n type pricingPlansV2Order_universal_d_GetOrdersStatsResponse = GetOrdersStatsResponse;\n type pricingPlansV2Order_universal_d_GetAvailableOrderActionsRequest = GetAvailableOrderActionsRequest;\n type pricingPlansV2Order_universal_d_GetAvailableOrderActionsResponse = GetAvailableOrderActionsResponse;\n type pricingPlansV2Order_universal_d_ReasonNotSuspendable = ReasonNotSuspendable;\n const pricingPlansV2Order_universal_d_ReasonNotSuspendable: typeof ReasonNotSuspendable;\n type pricingPlansV2Order_universal_d_PostponeEndDateRequest = PostponeEndDateRequest;\n type pricingPlansV2Order_universal_d_PostponeEndDateResponse = PostponeEndDateResponse;\n type pricingPlansV2Order_universal_d_OrderEndDatePostponed = OrderEndDatePostponed;\n type pricingPlansV2Order_universal_d_CancelOrderRequest = CancelOrderRequest;\n type pricingPlansV2Order_universal_d_CancelOrderResponse = CancelOrderResponse;\n type pricingPlansV2Order_universal_d_MarkAsPaidRequest = MarkAsPaidRequest;\n type pricingPlansV2Order_universal_d_MarkAsPaidResponse = MarkAsPaidResponse;\n type pricingPlansV2Order_universal_d_OrderMarkedAsPaid = OrderMarkedAsPaid;\n type pricingPlansV2Order_universal_d_PauseOrderRequest = PauseOrderRequest;\n type pricingPlansV2Order_universal_d_PauseOrderResponse = PauseOrderResponse;\n type pricingPlansV2Order_universal_d_OrderPaused = OrderPaused;\n type pricingPlansV2Order_universal_d_BulkPauseOrderRequest = BulkPauseOrderRequest;\n type pricingPlansV2Order_universal_d_BulkPauseOrderResponse = BulkPauseOrderResponse;\n type pricingPlansV2Order_universal_d_BulkOrderResult = BulkOrderResult;\n type pricingPlansV2Order_universal_d_ResumeOrderRequest = ResumeOrderRequest;\n type pricingPlansV2Order_universal_d_ResumeOrderResponse = ResumeOrderResponse;\n type pricingPlansV2Order_universal_d_OrderResumed = OrderResumed;\n type pricingPlansV2Order_universal_d_BulkResumeOrderRequest = BulkResumeOrderRequest;\n type pricingPlansV2Order_universal_d_BulkResumeOrderResponse = BulkResumeOrderResponse;\n const pricingPlansV2Order_universal_d_memberGetOrder: typeof memberGetOrder;\n type pricingPlansV2Order_universal_d_MemberGetOrderOptions = MemberGetOrderOptions;\n const pricingPlansV2Order_universal_d_memberListOrders: typeof memberListOrders;\n type pricingPlansV2Order_universal_d_MemberListOrdersOptions = MemberListOrdersOptions;\n const pricingPlansV2Order_universal_d_memberQueryOrders: typeof memberQueryOrders;\n const pricingPlansV2Order_universal_d_requestCancellation: typeof requestCancellation;\n const pricingPlansV2Order_universal_d_createOnlineOrder: typeof createOnlineOrder;\n type pricingPlansV2Order_universal_d_CreateOnlineOrderOptions = CreateOnlineOrderOptions;\n const pricingPlansV2Order_universal_d_createGuestOnlineOrder: typeof createGuestOnlineOrder;\n type pricingPlansV2Order_universal_d_CreateGuestOnlineOrderOptions = CreateGuestOnlineOrderOptions;\n const pricingPlansV2Order_universal_d_createOfflineOrder: typeof createOfflineOrder;\n type pricingPlansV2Order_universal_d_CreateOfflineOrderOptions = CreateOfflineOrderOptions;\n const pricingPlansV2Order_universal_d_createExternalOrder: typeof createExternalOrder;\n type pricingPlansV2Order_universal_d_CreateExternalOrderOptions = CreateExternalOrderOptions;\n const pricingPlansV2Order_universal_d_getOnlineOrderPreview: typeof getOnlineOrderPreview;\n type pricingPlansV2Order_universal_d_GetOnlineOrderPreviewOptions = GetOnlineOrderPreviewOptions;\n const pricingPlansV2Order_universal_d_getGuestOnlineOrderPreview: typeof getGuestOnlineOrderPreview;\n type pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewOptions = GetGuestOnlineOrderPreviewOptions;\n const pricingPlansV2Order_universal_d_getOfflineOrderPreview: typeof getOfflineOrderPreview;\n type pricingPlansV2Order_universal_d_GetOfflineOrderPreviewOptions = GetOfflineOrderPreviewOptions;\n const pricingPlansV2Order_universal_d_getPricePreview: typeof getPricePreview;\n type pricingPlansV2Order_universal_d_GetPricePreviewOptions = GetPricePreviewOptions;\n const pricingPlansV2Order_universal_d_changeStartDate: typeof changeStartDate;\n const pricingPlansV2Order_universal_d_applyCoupon: typeof applyCoupon;\n const pricingPlansV2Order_universal_d_setSubmission: typeof setSubmission;\n const pricingPlansV2Order_universal_d_managementGetOrder: typeof managementGetOrder;\n type pricingPlansV2Order_universal_d_ManagementGetOrderOptions = ManagementGetOrderOptions;\n const pricingPlansV2Order_universal_d_managementListOrders: typeof managementListOrders;\n type pricingPlansV2Order_universal_d_ManagementListOrdersOptions = ManagementListOrdersOptions;\n const pricingPlansV2Order_universal_d_managementQueryOrders: typeof managementQueryOrders;\n type pricingPlansV2Order_universal_d_ManagementQueryOrdersOptions = ManagementQueryOrdersOptions;\n const pricingPlansV2Order_universal_d_getOrdersStats: typeof getOrdersStats;\n const pricingPlansV2Order_universal_d_getAvailableOrderActions: typeof getAvailableOrderActions;\n const pricingPlansV2Order_universal_d_postponeEndDate: typeof postponeEndDate;\n const pricingPlansV2Order_universal_d_cancelOrder: typeof cancelOrder;\n const pricingPlansV2Order_universal_d_markAsPaid: typeof markAsPaid;\n const pricingPlansV2Order_universal_d_pauseOrder: typeof pauseOrder;\n const pricingPlansV2Order_universal_d_bulkPauseOrder: typeof bulkPauseOrder;\n type pricingPlansV2Order_universal_d_BulkPauseOrderOptions = BulkPauseOrderOptions;\n const pricingPlansV2Order_universal_d_resumeOrder: typeof resumeOrder;\n const pricingPlansV2Order_universal_d_bulkResumeOrder: typeof bulkResumeOrder;\n type pricingPlansV2Order_universal_d_BulkResumeOrderOptions = BulkResumeOrderOptions;\n namespace pricingPlansV2Order_universal_d {\n export {\n pricingPlansV2Order_universal_d_Order as Order,\n pricingPlansV2Order_universal_d_Buyer as Buyer,\n pricingPlansV2Order_universal_d_PriceDetails as PriceDetails,\n pricingPlansV2Order_universal_d_PriceDetailsPricingModelOneOf as PriceDetailsPricingModelOneOf,\n pricingPlansV2Order_universal_d_Tax as Tax,\n Recurrence$1 as Recurrence,\n Duration$1 as Duration,\n PeriodUnit$1 as PeriodUnit,\n pricingPlansV2Order_universal_d_Coupon as Coupon,\n pricingPlansV2Order_universal_d_PricingDetails as PricingDetails,\n pricingPlansV2Order_universal_d_PricingDetailsPricingModelOneOf as PricingDetailsPricingModelOneOf,\n pricingPlansV2Order_universal_d_SpannedPrice as SpannedPrice,\n pricingPlansV2Order_universal_d_PriceDuration as PriceDuration,\n pricingPlansV2Order_universal_d_Price as Price,\n Fee$1 as Fee,\n pricingPlansV2Order_universal_d_OrderType as OrderType,\n pricingPlansV2Order_universal_d_OrderMethod as OrderMethod,\n pricingPlansV2Order_universal_d_OrderStatus as OrderStatus,\n pricingPlansV2Order_universal_d_Cancellation as Cancellation,\n pricingPlansV2Order_universal_d_CancellationCause as CancellationCause,\n pricingPlansV2Order_universal_d_CancellationEffectiveAt as CancellationEffectiveAt,\n pricingPlansV2Order_universal_d_PaymentStatus as PaymentStatus,\n pricingPlansV2Order_universal_d_PausePeriod as PausePeriod,\n pricingPlansV2Order_universal_d_Status as Status,\n pricingPlansV2Order_universal_d_CurrentCycle as CurrentCycle,\n pricingPlansV2Order_universal_d_OrderCycle as OrderCycle,\n pricingPlansV2Order_universal_d_FormData as FormData,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n pricingPlansV2Order_universal_d_Empty as Empty,\n pricingPlansV2Order_universal_d_MemberGetOrderRequest as MemberGetOrderRequest,\n pricingPlansV2Order_universal_d_Set as Set,\n pricingPlansV2Order_universal_d_MemberGetOrderResponse as MemberGetOrderResponse,\n pricingPlansV2Order_universal_d_MemberListOrdersRequest as MemberListOrdersRequest,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n pricingPlansV2Order_universal_d_MemberListOrdersResponse as MemberListOrdersResponse,\n PagingMetadataV2$1 as PagingMetadataV2,\n Cursors$1 as Cursors,\n pricingPlansV2Order_universal_d_QueryOrdersRequest as QueryOrdersRequest,\n QueryV2$1 as QueryV2,\n pricingPlansV2Order_universal_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf,\n Paging$1 as Paging,\n pricingPlansV2Order_universal_d_CursorPaging as CursorPaging,\n pricingPlansV2Order_universal_d_QueryOrdersResponse as QueryOrdersResponse,\n pricingPlansV2Order_universal_d_RequestCancellationRequest as RequestCancellationRequest,\n pricingPlansV2Order_universal_d_RequestCancellationResponse as RequestCancellationResponse,\n pricingPlansV2Order_universal_d_OrderCanceled as OrderCanceled,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n pricingPlansV2Order_universal_d_CreateOnlineOrderRequest as CreateOnlineOrderRequest,\n pricingPlansV2Order_universal_d_OnBehalf as OnBehalf,\n pricingPlansV2Order_universal_d_CreateOnlineOrderResponse as CreateOnlineOrderResponse,\n pricingPlansV2Order_universal_d_CouponsError as CouponsError,\n pricingPlansV2Order_universal_d_CreateGuestOnlineOrderRequest as CreateGuestOnlineOrderRequest,\n pricingPlansV2Order_universal_d_Captcha as Captcha,\n pricingPlansV2Order_universal_d_Guest as Guest,\n pricingPlansV2Order_universal_d_CreateGuestOnlineOrderResponse as CreateGuestOnlineOrderResponse,\n pricingPlansV2Order_universal_d_CreateOfflineOrderRequest as CreateOfflineOrderRequest,\n pricingPlansV2Order_universal_d_CreateOfflineOrderResponse as CreateOfflineOrderResponse,\n pricingPlansV2Order_universal_d_CreateExternalOrderRequest as CreateExternalOrderRequest,\n pricingPlansV2Order_universal_d_CreateExternalOrderResponse as CreateExternalOrderResponse,\n pricingPlansV2Order_universal_d_GetOnlineOrderPreviewRequest as GetOnlineOrderPreviewRequest,\n pricingPlansV2Order_universal_d_GetOnlineOrderPreviewResponse as GetOnlineOrderPreviewResponse,\n pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewRequest as GetGuestOnlineOrderPreviewRequest,\n pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewResponse as GetGuestOnlineOrderPreviewResponse,\n pricingPlansV2Order_universal_d_GetOfflineOrderPreviewRequest as GetOfflineOrderPreviewRequest,\n pricingPlansV2Order_universal_d_GetOfflineOrderPreviewResponse as GetOfflineOrderPreviewResponse,\n pricingPlansV2Order_universal_d_GetPricePreviewRequest as GetPricePreviewRequest,\n pricingPlansV2Order_universal_d_GetPricePreviewResponse as GetPricePreviewResponse,\n pricingPlansV2Order_universal_d_ChangeStartDateRequest as ChangeStartDateRequest,\n pricingPlansV2Order_universal_d_ChangeStartDateResponse as ChangeStartDateResponse,\n pricingPlansV2Order_universal_d_OrderStartDateChanged as OrderStartDateChanged,\n pricingPlansV2Order_universal_d_ApplyCouponRequest as ApplyCouponRequest,\n pricingPlansV2Order_universal_d_ApplyCouponResponse as ApplyCouponResponse,\n pricingPlansV2Order_universal_d_SetSubmissionRequest as SetSubmissionRequest,\n pricingPlansV2Order_universal_d_SetSubmissionResponse as SetSubmissionResponse,\n pricingPlansV2Order_universal_d_OrderPurchased as OrderPurchased,\n pricingPlansV2Order_universal_d_OrderStarted as OrderStarted,\n pricingPlansV2Order_universal_d_OrderCycleStarted as OrderCycleStarted,\n pricingPlansV2Order_universal_d_OrderAutoRenewCanceled as OrderAutoRenewCanceled,\n pricingPlansV2Order_universal_d_OrderEnded as OrderEnded,\n pricingPlansV2Order_universal_d_GetOrderRequest as GetOrderRequest,\n pricingPlansV2Order_universal_d_GetOrderResponse as GetOrderResponse,\n pricingPlansV2Order_universal_d_ListOrdersRequest as ListOrdersRequest,\n pricingPlansV2Order_universal_d_ListOrdersResponse as ListOrdersResponse,\n pricingPlansV2Order_universal_d_OrdersQueryOrdersRequest as OrdersQueryOrdersRequest,\n pricingPlansV2Order_universal_d_OrdersQueryOrdersResponse as OrdersQueryOrdersResponse,\n pricingPlansV2Order_universal_d_GetOrdersStatsRequest as GetOrdersStatsRequest,\n pricingPlansV2Order_universal_d_GetOrdersStatsResponse as GetOrdersStatsResponse,\n pricingPlansV2Order_universal_d_GetAvailableOrderActionsRequest as GetAvailableOrderActionsRequest,\n pricingPlansV2Order_universal_d_GetAvailableOrderActionsResponse as GetAvailableOrderActionsResponse,\n pricingPlansV2Order_universal_d_ReasonNotSuspendable as ReasonNotSuspendable,\n pricingPlansV2Order_universal_d_PostponeEndDateRequest as PostponeEndDateRequest,\n pricingPlansV2Order_universal_d_PostponeEndDateResponse as PostponeEndDateResponse,\n pricingPlansV2Order_universal_d_OrderEndDatePostponed as OrderEndDatePostponed,\n pricingPlansV2Order_universal_d_CancelOrderRequest as CancelOrderRequest,\n pricingPlansV2Order_universal_d_CancelOrderResponse as CancelOrderResponse,\n pricingPlansV2Order_universal_d_MarkAsPaidRequest as MarkAsPaidRequest,\n pricingPlansV2Order_universal_d_MarkAsPaidResponse as MarkAsPaidResponse,\n pricingPlansV2Order_universal_d_OrderMarkedAsPaid as OrderMarkedAsPaid,\n pricingPlansV2Order_universal_d_PauseOrderRequest as PauseOrderRequest,\n pricingPlansV2Order_universal_d_PauseOrderResponse as PauseOrderResponse,\n pricingPlansV2Order_universal_d_OrderPaused as OrderPaused,\n pricingPlansV2Order_universal_d_BulkPauseOrderRequest as BulkPauseOrderRequest,\n pricingPlansV2Order_universal_d_BulkPauseOrderResponse as BulkPauseOrderResponse,\n pricingPlansV2Order_universal_d_BulkOrderResult as BulkOrderResult,\n ItemMetadata$1 as ItemMetadata,\n ApplicationError$1 as ApplicationError,\n BulkActionMetadata$1 as BulkActionMetadata,\n pricingPlansV2Order_universal_d_ResumeOrderRequest as ResumeOrderRequest,\n pricingPlansV2Order_universal_d_ResumeOrderResponse as ResumeOrderResponse,\n pricingPlansV2Order_universal_d_OrderResumed as OrderResumed,\n pricingPlansV2Order_universal_d_BulkResumeOrderRequest as BulkResumeOrderRequest,\n pricingPlansV2Order_universal_d_BulkResumeOrderResponse as BulkResumeOrderResponse,\n pricingPlansV2Order_universal_d_memberGetOrder as memberGetOrder,\n pricingPlansV2Order_universal_d_MemberGetOrderOptions as MemberGetOrderOptions,\n pricingPlansV2Order_universal_d_memberListOrders as memberListOrders,\n pricingPlansV2Order_universal_d_MemberListOrdersOptions as MemberListOrdersOptions,\n pricingPlansV2Order_universal_d_memberQueryOrders as memberQueryOrders,\n PlansQueryResult$1 as PlansQueryResult,\n PlansQueryBuilder$1 as PlansQueryBuilder,\n pricingPlansV2Order_universal_d_requestCancellation as requestCancellation,\n pricingPlansV2Order_universal_d_createOnlineOrder as createOnlineOrder,\n pricingPlansV2Order_universal_d_CreateOnlineOrderOptions as CreateOnlineOrderOptions,\n pricingPlansV2Order_universal_d_createGuestOnlineOrder as createGuestOnlineOrder,\n pricingPlansV2Order_universal_d_CreateGuestOnlineOrderOptions as CreateGuestOnlineOrderOptions,\n pricingPlansV2Order_universal_d_createOfflineOrder as createOfflineOrder,\n pricingPlansV2Order_universal_d_CreateOfflineOrderOptions as CreateOfflineOrderOptions,\n pricingPlansV2Order_universal_d_createExternalOrder as createExternalOrder,\n pricingPlansV2Order_universal_d_CreateExternalOrderOptions as CreateExternalOrderOptions,\n pricingPlansV2Order_universal_d_getOnlineOrderPreview as getOnlineOrderPreview,\n pricingPlansV2Order_universal_d_GetOnlineOrderPreviewOptions as GetOnlineOrderPreviewOptions,\n pricingPlansV2Order_universal_d_getGuestOnlineOrderPreview as getGuestOnlineOrderPreview,\n pricingPlansV2Order_universal_d_GetGuestOnlineOrderPreviewOptions as GetGuestOnlineOrderPreviewOptions,\n pricingPlansV2Order_universal_d_getOfflineOrderPreview as getOfflineOrderPreview,\n pricingPlansV2Order_universal_d_GetOfflineOrderPreviewOptions as GetOfflineOrderPreviewOptions,\n pricingPlansV2Order_universal_d_getPricePreview as getPricePreview,\n pricingPlansV2Order_universal_d_GetPricePreviewOptions as GetPricePreviewOptions,\n pricingPlansV2Order_universal_d_changeStartDate as changeStartDate,\n pricingPlansV2Order_universal_d_applyCoupon as applyCoupon,\n pricingPlansV2Order_universal_d_setSubmission as setSubmission,\n pricingPlansV2Order_universal_d_managementGetOrder as managementGetOrder,\n pricingPlansV2Order_universal_d_ManagementGetOrderOptions as ManagementGetOrderOptions,\n pricingPlansV2Order_universal_d_managementListOrders as managementListOrders,\n pricingPlansV2Order_universal_d_ManagementListOrdersOptions as ManagementListOrdersOptions,\n pricingPlansV2Order_universal_d_managementQueryOrders as managementQueryOrders,\n pricingPlansV2Order_universal_d_ManagementQueryOrdersOptions as ManagementQueryOrdersOptions,\n pricingPlansV2Order_universal_d_getOrdersStats as getOrdersStats,\n pricingPlansV2Order_universal_d_getAvailableOrderActions as getAvailableOrderActions,\n pricingPlansV2Order_universal_d_postponeEndDate as postponeEndDate,\n pricingPlansV2Order_universal_d_cancelOrder as cancelOrder,\n pricingPlansV2Order_universal_d_markAsPaid as markAsPaid,\n pricingPlansV2Order_universal_d_pauseOrder as pauseOrder,\n pricingPlansV2Order_universal_d_bulkPauseOrder as bulkPauseOrder,\n pricingPlansV2Order_universal_d_BulkPauseOrderOptions as BulkPauseOrderOptions,\n pricingPlansV2Order_universal_d_resumeOrder as resumeOrder,\n pricingPlansV2Order_universal_d_bulkResumeOrder as bulkResumeOrder,\n pricingPlansV2Order_universal_d_BulkResumeOrderOptions as BulkResumeOrderOptions,\n };\n }\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 /** List of text strings that promote what is included with this plan. For example, \"Plenty of parking\" or \"Free gift on your birthday.\" */\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.\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 | null;\n /**\n * Date plan was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 1 purchase per buyer.\n */\n maxPurchasesPerBuyer?: number | null;\n /** Whether the buyer can start the plan at a later date. Defaults to false. */\n allowFutureStartDate?: boolean | null;\n /**\n * Whether the buyer is allowed to cancel their plan. Defaults to false.\n * If false, calling Request Cancellation returns an error.\n */\n buyerCanCancel?: boolean | null;\n /** Any terms and conditions that apply to the plan. This information is displayed during checkout. */\n termsAndConditions?: string | null;\n /**\n * Client data such as the plan's cover image, terms & conditions settings.\n * @internal\n */\n clientData?: Record;\n /**\n * ID of the form associated with the plan at checkout.\n *\n * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).\n */\n formId?: string | null;\n }\n /** This wrapper type exists 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 /** 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 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 a 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 * Additional fees that would apply to the order, one of which might be a setup fee.\n * @internal\n */\n feeConfigs?: FeeConfig[];\n }\n /** @oneof */\n interface PricingPricingModelOneOf {\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 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 a single payment. The plan is valid until 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 /**\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;\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 {\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;\n }\n enum PeriodUnit {\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 Money {\n /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Can't be negative. */\n value?: string;\n /** Currency code. Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`. */\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 the first payment. If the order has a free trial, it will charge after the free trial. */\n FIRST_PAYMENT = \"FIRST_PAYMENT\"\n }\n interface ListPublicPlansRequest {\n /** Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */\n limit?: number | null;\n /** Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */\n offset?: number | null;\n /** IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs. */\n planIds?: string[];\n }\n interface ListPublicPlansResponse {\n /** List of public pricing plans. */\n plans?: PublicPlan[];\n /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */\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 (for example, 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 | null;\n /** Date plan was last updated. */\n _updatedDate?: Date | null;\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 0 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 is displayed during checkout. */\n termsAndConditions?: string | null;\n /**\n * Client data such as the plan's cover image, terms & conditions settings.\n * @internal\n */\n clientData?: Record;\n /**\n * ID of the form associated with the plan at checkout.\n *\n * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).\n */\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 * 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 * @internal\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 QueryPublicPlansRequest {\n /** Query options. */\n query?: QueryV2;\n }\n interface QueryV2 {\n /** A filter object. See supported fields and operators ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/query-public-plans) | [REST](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't 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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 (such as the number of plans returned, the offset, and so on). */\n pagingMetadata?: PagingMetadataV2;\n }\n interface GetPlanRequest {\n /** Plan ID. */\n _id: string;\n }\n interface GetPlanResponse {\n /** Pricing plan. */\n plan?: Plan;\n }\n interface ListPlansRequest {\n /** Archived filter. Defaults to `ACTIVE` (not archived) only. */\n archived?: ArchivedFilter;\n /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */\n public?: PublicFilter;\n /** Number of pricing plans to list. Defaults to `75`. */\n limit?: number | null;\n /** Number of pricing plans to skip. Defaults to `0`. */\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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs. */\n planIds?: string[];\n /**\n * Plan name for filtering. Also checks for and includes partial matches.\n * @internal\n */\n name?: string | null;\n /**\n * Filters for free plans only.\n * @internal\n */\n free?: boolean | null;\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 /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */\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 /** Plan details. */\n plan: Plan;\n }\n interface CreatePlanResponse {\n /** Created plan. */\n plan?: Plan;\n }\n interface UpdatePlanRequest {\n /** ID of the plan to update. */\n plan: Plan;\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n interface UpdatePlanResponse {\n /** Updated plan. */\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 a site page. */\n _id: string;\n /** Whether a plan is visible to members and site visitors. Updates the `public` field. */\n visible: boolean;\n }\n interface SetPlanVisibilityResponse {\n /** Pricing plan. */\n plan?: Plan;\n }\n interface MakePlanPrimaryRequest {\n /** Pricing plan ID. */\n _id: string;\n }\n interface MakePlanPrimaryResponse {\n /** Pricing plan. */\n plan?: Plan;\n }\n interface ClearPrimaryRequest {\n }\n interface ClearPrimaryResponse {\n }\n interface ArchivePlanRequest {\n /** ID of the active plan to archive. */\n _id: string;\n }\n interface ArchivePlanResponse {\n /** Archived plan. */\n plan?: Plan;\n }\n interface PlanArchived {\n /** Pricing plan. */\n plan?: Plan;\n }\n interface BulkArchivePlanRequest {\n /** List of Plan IDs to archive. */\n ids: string[];\n /** Set to `true` to return the `Plan` entity in the 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, counts only visible plans (visible and not archived). If no value is specified, all plans are 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 a site has non-free, non-template plans. */\n hasPaidPlans?: boolean;\n /** True if a site has plans that were created before Pricing Plans became a premium app. */\n hasOldPlans?: boolean;\n }\n interface SearchPlansRequest {\n /** Query options. */\n query?: QueryV2;\n /** Search phrase for the plan name. */\n searchPhrase?: string | null;\n }\n interface SearchPlansResponse {\n /** List of pricing plans that match the specified filter and search phrase. */\n plans?: Plan[];\n /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */\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 | 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 up to 100 public pricing plans. Public plans are visible plans that are available to site visitors and can be purchased.\n * @public\n * @param options - Options for filtering and paging the list of public plans.\n * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS\n */\n function listPublicPlans(options?: ListPublicPlansOptions): Promise;\n interface ListPublicPlansOptions {\n /** Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */\n limit?: number | null;\n /** Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */\n offset?: number | null;\n /** IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify 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()` method 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) method.\n *\n * You can refine the query by chaining `PublicPlansQueryBuilder` methods onto the query. `PublicPlansQueryBuilder` methods 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 methods 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` methods are supported for the `queryPublicPlans()` method. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).\n * @public\n * @permissionId PRICING_PLANS.READ_PUBLIC_PLANS\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 ID.\n * @param _id - Plan ID.\n * @public\n * @requiredField _id\n * @permissionId PRICING_PLANS.READ_PLANS\n * @adminMethod\n * @returns Pricing plan.\n */\n function getPlan(_id: string): Promise;\n /**\n * Retrieves a list of up to 100 pricing plans (including 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 * @adminMethod\n */\n function listPlans(options?: ListPlansOptions): Promise;\n interface ListPlansOptions {\n /** Archived filter. Defaults to `ACTIVE` (not archived) only. */\n archived?: ArchivedFilter;\n /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */\n public?: PublicFilter;\n /** Number of pricing plans to list. Defaults to `75`. */\n limit?: number | null;\n /** Number of pricing plans to skip. Defaults to `0`. */\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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs. */\n planIds?: string[];\n /**\n * Plan name for filtering. Also checks for and includes partial matches.\n * @internal\n */\n name?: string | null;\n /**\n * Filters for free plans only.\n * @internal\n */\n free?: boolean | null;\n }\n /**\n * Gets statistics about the pricing plans. Currently provides only the total number of pricing plans, including archived plans.\n * @public\n * @permissionId PRICING_PLANS.READ_PLANS\n * @adminMethod\n */\n function getPlanStats(): Promise;\n /**\n * Creates a pricing plan. The specified `plan` object must contain a pricing model. A pricing model can be 1 of the following:\n * - **A subscription**: A subscription with recurring payments and how often the plan occurs. Subscriptions can have free trial days.\n * - **A plan that doesn't 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 * Pricing plans are available to the Wix user in the Pricing Plans section in a site's 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 * @adminMethod\n * @returns Created plan.\n */\n function createPlan(plan: Plan): Promise;\n /**\n * Updates a pricing plan.\n * Updating a plan doesn't impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of 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 * @adminMethod\n * @returns Updated plan.\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 /** List of text strings that promote what is included with this plan. For example, \"Plenty of parking\" or \"Free gift on your birthday.\" */\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.\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 | null;\n /**\n * Date plan was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\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 1 purchase per buyer.\n */\n maxPurchasesPerBuyer?: number | null;\n /** Whether the buyer can start the plan at a later date. Defaults to false. */\n allowFutureStartDate?: boolean | null;\n /**\n * Whether the buyer is allowed to cancel their plan. Defaults to false.\n * If false, calling Request Cancellation returns an error.\n */\n buyerCanCancel?: boolean | null;\n /** Any terms and conditions that apply to the plan. This information is displayed during checkout. */\n termsAndConditions?: string | null;\n /**\n * Client data such as the plan's cover image, terms & conditions settings.\n * @internal\n */\n clientData?: Record;\n /**\n * ID of the form associated with the plan at checkout.\n *\n * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).\n */\n formId?: string | null;\n }\n interface UpdatePlanOptions {\n /**\n * Explicit list of fields to update.\n * @internal\n */\n fieldMask?: string[];\n }\n /**\n * Sets visibility for pricing plans. Visible plans are considered public plans.\n * By default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors can't choose them.\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). (An archived plan always remains archived and can't be made active again.)\n * Changing a plan’s visibility doesn't impact existing orders for the plan. All orders for hidden plans are still active and keep their perks.\n * @param visible - Whether a plan is visible to members and site visitors. Updates the `public` field.\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 * @adminMethod\n */\n function setPlanVisibility(_id: string, visible: boolean): Promise;\n /**\n * Marks a pricing plan as the primary pricing plan. When viewing pricing plans on a site, the primary plan is highlighted with a customizable ribbon. 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 Make Plan Primary causes the existing primary plan to lose its primary status.\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 * @adminMethod\n */\n function makePlanPrimary(_id: string): Promise;\n /**\n * Sets all pricing plans as not primary. When viewing pricing plans on a site, no plan is highlighted with a customizable ribbon.\n * @public\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @adminMethod\n */\n function clearPrimary(): Promise;\n /**\n * Archives a single plan.\n * When a plan is archived, it's no longer visible as a public plan that can be chosen by site members or visitors.\n * This is because the plan's `public` property is automatically set to `false`.\n * Archived plans can't be purchased or reactivated.\n * Plan archiving doesn't impact existing orders made for the plan. All orders for the plan are still active and keep their perks, payment options, and terms.\n * Wix users can see archived plans in a site's dashboard under **Pricing Plans -> Archived Plans**.\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 * @adminMethod\n */\n function archivePlan(_id: string): Promise;\n /**\n * Archives multiple plans.\n * See \"Archives a single plan\" for more information.\n * @param ids - List of Plan IDs to archive.\n * @internal\n * @requiredField ids\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @adminMethod\n */\n function bulkArchivePlan(ids: string[], options?: BulkArchivePlanOptions): Promise;\n interface BulkArchivePlanOptions {\n /** Set to `true` to return the `Plan` entity in the response. */\n returnFullEntity?: boolean;\n }\n /**\n * Changes the display order of the plans on a site and in a site's dashboard.\n * To rearrange the order of the plans, provide a list of plan IDs in the desired order.\n * Include all public and hidden plans in the list you provide.\n * Make sure to provide **all** non-archived plan IDs to avoid unpredictable results.\n * @param ids - IDs of all non-archived plans in the order you want them arranged.\n * @internal\n * @requiredField ids\n * @permissionId PRICING_PLANS.MANAGE_PLANS\n * @adminMethod\n */\n function arrangePlans(ids: string[]): Promise;\n /**\n * Returns a count of plans for a site.\n * @internal\n * @documentationMaturity preview\n * @permissionId PRICING_PLANS.READ_PLANS\n * @adminMethod\n */\n function countPlans(options?: CountPlansOptions): Promise;\n interface CountPlansOptions {\n /** The filter. */\n filter?: Record | null;\n /** If true, counts only visible plans (visible and not archived). If no value is specified, all plans are counted. */\n visibility?: boolean | null;\n }\n /**\n * Checks whether a site has non-free plans and plans created before Pricing Plans became premium.\n * @internal\n * @documentationMaturity preview\n * @permissionId PRICING_PLANS.READ_PLANS\n * @adminMethod\n */\n function getPlansPremiumStatus(): Promise;\n /**\n * Retrieves a list of plans matching the filter and search phrase for the name.\n * @internal\n * @documentationMaturity preview\n * @permissionId PRICING_PLANS.READ_PLANS\n * @adminMethod\n */\n function searchPlans(options?: SearchPlansOptions): Promise;\n interface SearchPlansOptions {\n /** Query options. */\n query?: QueryV2;\n /** Search phrase for the plan name. */\n searchPhrase?: string | null;\n }\n \n type pricingPlansV2Plan_universal_d_Plan = Plan;\n type pricingPlansV2Plan_universal_d_StringList = StringList;\n type pricingPlansV2Plan_universal_d_Pricing = Pricing;\n type pricingPlansV2Plan_universal_d_PricingPricingModelOneOf = PricingPricingModelOneOf;\n type pricingPlansV2Plan_universal_d_Recurrence = Recurrence;\n type pricingPlansV2Plan_universal_d_Duration = Duration;\n type pricingPlansV2Plan_universal_d_PeriodUnit = PeriodUnit;\n const pricingPlansV2Plan_universal_d_PeriodUnit: typeof PeriodUnit;\n type pricingPlansV2Plan_universal_d_Money = Money;\n type pricingPlansV2Plan_universal_d_FeeConfig = FeeConfig;\n type pricingPlansV2Plan_universal_d_Fee = Fee;\n type pricingPlansV2Plan_universal_d_AppliedAt = AppliedAt;\n const pricingPlansV2Plan_universal_d_AppliedAt: typeof AppliedAt;\n type pricingPlansV2Plan_universal_d_ListPublicPlansRequest = ListPublicPlansRequest;\n type pricingPlansV2Plan_universal_d_ListPublicPlansResponse = ListPublicPlansResponse;\n type pricingPlansV2Plan_universal_d_PublicPlan = PublicPlan;\n type pricingPlansV2Plan_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type pricingPlansV2Plan_universal_d_Cursors = Cursors;\n type pricingPlansV2Plan_universal_d_QueryPublicPlansRequest = QueryPublicPlansRequest;\n type pricingPlansV2Plan_universal_d_QueryV2 = QueryV2;\n type pricingPlansV2Plan_universal_d_Sorting = Sorting;\n type pricingPlansV2Plan_universal_d_SortOrder = SortOrder;\n const pricingPlansV2Plan_universal_d_SortOrder: typeof SortOrder;\n type pricingPlansV2Plan_universal_d_Paging = Paging;\n type pricingPlansV2Plan_universal_d_QueryPublicPlansResponse = QueryPublicPlansResponse;\n type pricingPlansV2Plan_universal_d_GetPlanRequest = GetPlanRequest;\n type pricingPlansV2Plan_universal_d_GetPlanResponse = GetPlanResponse;\n type pricingPlansV2Plan_universal_d_ListPlansRequest = ListPlansRequest;\n type pricingPlansV2Plan_universal_d_ArchivedFilter = ArchivedFilter;\n const pricingPlansV2Plan_universal_d_ArchivedFilter: typeof ArchivedFilter;\n type pricingPlansV2Plan_universal_d_PublicFilter = PublicFilter;\n const pricingPlansV2Plan_universal_d_PublicFilter: typeof PublicFilter;\n type pricingPlansV2Plan_universal_d_ListPlansResponse = ListPlansResponse;\n type pricingPlansV2Plan_universal_d_GetPlanStatsRequest = GetPlanStatsRequest;\n type pricingPlansV2Plan_universal_d_GetPlanStatsResponse = GetPlanStatsResponse;\n type pricingPlansV2Plan_universal_d_CreatePlanRequest = CreatePlanRequest;\n type pricingPlansV2Plan_universal_d_CreatePlanResponse = CreatePlanResponse;\n type pricingPlansV2Plan_universal_d_UpdatePlanRequest = UpdatePlanRequest;\n type pricingPlansV2Plan_universal_d_UpdatePlanResponse = UpdatePlanResponse;\n type pricingPlansV2Plan_universal_d_BuyerCanCancelUpdated = BuyerCanCancelUpdated;\n type pricingPlansV2Plan_universal_d_SetPlanVisibilityRequest = SetPlanVisibilityRequest;\n type pricingPlansV2Plan_universal_d_SetPlanVisibilityResponse = SetPlanVisibilityResponse;\n type pricingPlansV2Plan_universal_d_MakePlanPrimaryRequest = MakePlanPrimaryRequest;\n type pricingPlansV2Plan_universal_d_MakePlanPrimaryResponse = MakePlanPrimaryResponse;\n type pricingPlansV2Plan_universal_d_ClearPrimaryRequest = ClearPrimaryRequest;\n type pricingPlansV2Plan_universal_d_ClearPrimaryResponse = ClearPrimaryResponse;\n type pricingPlansV2Plan_universal_d_ArchivePlanRequest = ArchivePlanRequest;\n type pricingPlansV2Plan_universal_d_ArchivePlanResponse = ArchivePlanResponse;\n type pricingPlansV2Plan_universal_d_PlanArchived = PlanArchived;\n type pricingPlansV2Plan_universal_d_BulkArchivePlanRequest = BulkArchivePlanRequest;\n type pricingPlansV2Plan_universal_d_BulkArchivePlanResponse = BulkArchivePlanResponse;\n type pricingPlansV2Plan_universal_d_BulkPlanResult = BulkPlanResult;\n type pricingPlansV2Plan_universal_d_ItemMetadata = ItemMetadata;\n type pricingPlansV2Plan_universal_d_ApplicationError = ApplicationError;\n type pricingPlansV2Plan_universal_d_BulkActionMetadata = BulkActionMetadata;\n type pricingPlansV2Plan_universal_d_ArrangePlansRequest = ArrangePlansRequest;\n type pricingPlansV2Plan_universal_d_ArrangePlansResponse = ArrangePlansResponse;\n type pricingPlansV2Plan_universal_d_CountPlansRequest = CountPlansRequest;\n type pricingPlansV2Plan_universal_d_CountPlansResponse = CountPlansResponse;\n type pricingPlansV2Plan_universal_d_GetPlansPremiumStatusRequest = GetPlansPremiumStatusRequest;\n type pricingPlansV2Plan_universal_d_GetPlansPremiumStatusResponse = GetPlansPremiumStatusResponse;\n type pricingPlansV2Plan_universal_d_SearchPlansRequest = SearchPlansRequest;\n type pricingPlansV2Plan_universal_d_SearchPlansResponse = SearchPlansResponse;\n type pricingPlansV2Plan_universal_d_DomainEvent = DomainEvent;\n type pricingPlansV2Plan_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type pricingPlansV2Plan_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type pricingPlansV2Plan_universal_d_RestoreInfo = RestoreInfo;\n type pricingPlansV2Plan_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type pricingPlansV2Plan_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type pricingPlansV2Plan_universal_d_ActionEvent = ActionEvent;\n type pricingPlansV2Plan_universal_d_MessageEnvelope = MessageEnvelope;\n type pricingPlansV2Plan_universal_d_IdentificationData = IdentificationData;\n type pricingPlansV2Plan_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type pricingPlansV2Plan_universal_d_WebhookIdentityType = WebhookIdentityType;\n const pricingPlansV2Plan_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const pricingPlansV2Plan_universal_d_listPublicPlans: typeof listPublicPlans;\n type pricingPlansV2Plan_universal_d_ListPublicPlansOptions = ListPublicPlansOptions;\n const pricingPlansV2Plan_universal_d_queryPublicPlans: typeof queryPublicPlans;\n type pricingPlansV2Plan_universal_d_PlansQueryResult = PlansQueryResult;\n type pricingPlansV2Plan_universal_d_PlansQueryBuilder = PlansQueryBuilder;\n const pricingPlansV2Plan_universal_d_getPlan: typeof getPlan;\n const pricingPlansV2Plan_universal_d_listPlans: typeof listPlans;\n type pricingPlansV2Plan_universal_d_ListPlansOptions = ListPlansOptions;\n const pricingPlansV2Plan_universal_d_getPlanStats: typeof getPlanStats;\n const pricingPlansV2Plan_universal_d_createPlan: typeof createPlan;\n const pricingPlansV2Plan_universal_d_updatePlan: typeof updatePlan;\n type pricingPlansV2Plan_universal_d_UpdatePlan = UpdatePlan;\n type pricingPlansV2Plan_universal_d_UpdatePlanOptions = UpdatePlanOptions;\n const pricingPlansV2Plan_universal_d_setPlanVisibility: typeof setPlanVisibility;\n const pricingPlansV2Plan_universal_d_makePlanPrimary: typeof makePlanPrimary;\n const pricingPlansV2Plan_universal_d_clearPrimary: typeof clearPrimary;\n const pricingPlansV2Plan_universal_d_archivePlan: typeof archivePlan;\n const pricingPlansV2Plan_universal_d_bulkArchivePlan: typeof bulkArchivePlan;\n type pricingPlansV2Plan_universal_d_BulkArchivePlanOptions = BulkArchivePlanOptions;\n const pricingPlansV2Plan_universal_d_arrangePlans: typeof arrangePlans;\n const pricingPlansV2Plan_universal_d_countPlans: typeof countPlans;\n type pricingPlansV2Plan_universal_d_CountPlansOptions = CountPlansOptions;\n const pricingPlansV2Plan_universal_d_getPlansPremiumStatus: typeof getPlansPremiumStatus;\n const pricingPlansV2Plan_universal_d_searchPlans: typeof searchPlans;\n type pricingPlansV2Plan_universal_d_SearchPlansOptions = SearchPlansOptions;\n namespace pricingPlansV2Plan_universal_d {\n export {\n pricingPlansV2Plan_universal_d_Plan as Plan,\n pricingPlansV2Plan_universal_d_StringList as StringList,\n pricingPlansV2Plan_universal_d_Pricing as Pricing,\n pricingPlansV2Plan_universal_d_PricingPricingModelOneOf as PricingPricingModelOneOf,\n pricingPlansV2Plan_universal_d_Recurrence as Recurrence,\n pricingPlansV2Plan_universal_d_Duration as Duration,\n pricingPlansV2Plan_universal_d_PeriodUnit as PeriodUnit,\n pricingPlansV2Plan_universal_d_Money as Money,\n pricingPlansV2Plan_universal_d_FeeConfig as FeeConfig,\n pricingPlansV2Plan_universal_d_Fee as Fee,\n pricingPlansV2Plan_universal_d_AppliedAt as AppliedAt,\n pricingPlansV2Plan_universal_d_ListPublicPlansRequest as ListPublicPlansRequest,\n pricingPlansV2Plan_universal_d_ListPublicPlansResponse as ListPublicPlansResponse,\n pricingPlansV2Plan_universal_d_PublicPlan as PublicPlan,\n pricingPlansV2Plan_universal_d_PagingMetadataV2 as PagingMetadataV2,\n pricingPlansV2Plan_universal_d_Cursors as Cursors,\n pricingPlansV2Plan_universal_d_QueryPublicPlansRequest as QueryPublicPlansRequest,\n pricingPlansV2Plan_universal_d_QueryV2 as QueryV2,\n pricingPlansV2Plan_universal_d_Sorting as Sorting,\n pricingPlansV2Plan_universal_d_SortOrder as SortOrder,\n pricingPlansV2Plan_universal_d_Paging as Paging,\n pricingPlansV2Plan_universal_d_QueryPublicPlansResponse as QueryPublicPlansResponse,\n pricingPlansV2Plan_universal_d_GetPlanRequest as GetPlanRequest,\n pricingPlansV2Plan_universal_d_GetPlanResponse as GetPlanResponse,\n pricingPlansV2Plan_universal_d_ListPlansRequest as ListPlansRequest,\n pricingPlansV2Plan_universal_d_ArchivedFilter as ArchivedFilter,\n pricingPlansV2Plan_universal_d_PublicFilter as PublicFilter,\n pricingPlansV2Plan_universal_d_ListPlansResponse as ListPlansResponse,\n pricingPlansV2Plan_universal_d_GetPlanStatsRequest as GetPlanStatsRequest,\n pricingPlansV2Plan_universal_d_GetPlanStatsResponse as GetPlanStatsResponse,\n pricingPlansV2Plan_universal_d_CreatePlanRequest as CreatePlanRequest,\n pricingPlansV2Plan_universal_d_CreatePlanResponse as CreatePlanResponse,\n pricingPlansV2Plan_universal_d_UpdatePlanRequest as UpdatePlanRequest,\n pricingPlansV2Plan_universal_d_UpdatePlanResponse as UpdatePlanResponse,\n pricingPlansV2Plan_universal_d_BuyerCanCancelUpdated as BuyerCanCancelUpdated,\n pricingPlansV2Plan_universal_d_SetPlanVisibilityRequest as SetPlanVisibilityRequest,\n pricingPlansV2Plan_universal_d_SetPlanVisibilityResponse as SetPlanVisibilityResponse,\n pricingPlansV2Plan_universal_d_MakePlanPrimaryRequest as MakePlanPrimaryRequest,\n pricingPlansV2Plan_universal_d_MakePlanPrimaryResponse as MakePlanPrimaryResponse,\n pricingPlansV2Plan_universal_d_ClearPrimaryRequest as ClearPrimaryRequest,\n pricingPlansV2Plan_universal_d_ClearPrimaryResponse as ClearPrimaryResponse,\n pricingPlansV2Plan_universal_d_ArchivePlanRequest as ArchivePlanRequest,\n pricingPlansV2Plan_universal_d_ArchivePlanResponse as ArchivePlanResponse,\n pricingPlansV2Plan_universal_d_PlanArchived as PlanArchived,\n pricingPlansV2Plan_universal_d_BulkArchivePlanRequest as BulkArchivePlanRequest,\n pricingPlansV2Plan_universal_d_BulkArchivePlanResponse as BulkArchivePlanResponse,\n pricingPlansV2Plan_universal_d_BulkPlanResult as BulkPlanResult,\n pricingPlansV2Plan_universal_d_ItemMetadata as ItemMetadata,\n pricingPlansV2Plan_universal_d_ApplicationError as ApplicationError,\n pricingPlansV2Plan_universal_d_BulkActionMetadata as BulkActionMetadata,\n pricingPlansV2Plan_universal_d_ArrangePlansRequest as ArrangePlansRequest,\n pricingPlansV2Plan_universal_d_ArrangePlansResponse as ArrangePlansResponse,\n pricingPlansV2Plan_universal_d_CountPlansRequest as CountPlansRequest,\n pricingPlansV2Plan_universal_d_CountPlansResponse as CountPlansResponse,\n pricingPlansV2Plan_universal_d_GetPlansPremiumStatusRequest as GetPlansPremiumStatusRequest,\n pricingPlansV2Plan_universal_d_GetPlansPremiumStatusResponse as GetPlansPremiumStatusResponse,\n pricingPlansV2Plan_universal_d_SearchPlansRequest as SearchPlansRequest,\n pricingPlansV2Plan_universal_d_SearchPlansResponse as SearchPlansResponse,\n pricingPlansV2Plan_universal_d_DomainEvent as DomainEvent,\n pricingPlansV2Plan_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n pricingPlansV2Plan_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n pricingPlansV2Plan_universal_d_RestoreInfo as RestoreInfo,\n pricingPlansV2Plan_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n pricingPlansV2Plan_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n pricingPlansV2Plan_universal_d_ActionEvent as ActionEvent,\n pricingPlansV2Plan_universal_d_MessageEnvelope as MessageEnvelope,\n pricingPlansV2Plan_universal_d_IdentificationData as IdentificationData,\n pricingPlansV2Plan_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n pricingPlansV2Plan_universal_d_WebhookIdentityType as WebhookIdentityType,\n pricingPlansV2Plan_universal_d_listPublicPlans as listPublicPlans,\n pricingPlansV2Plan_universal_d_ListPublicPlansOptions as ListPublicPlansOptions,\n pricingPlansV2Plan_universal_d_queryPublicPlans as queryPublicPlans,\n pricingPlansV2Plan_universal_d_PlansQueryResult as PlansQueryResult,\n pricingPlansV2Plan_universal_d_PlansQueryBuilder as PlansQueryBuilder,\n pricingPlansV2Plan_universal_d_getPlan as getPlan,\n pricingPlansV2Plan_universal_d_listPlans as listPlans,\n pricingPlansV2Plan_universal_d_ListPlansOptions as ListPlansOptions,\n pricingPlansV2Plan_universal_d_getPlanStats as getPlanStats,\n pricingPlansV2Plan_universal_d_createPlan as createPlan,\n pricingPlansV2Plan_universal_d_updatePlan as updatePlan,\n pricingPlansV2Plan_universal_d_UpdatePlan as UpdatePlan,\n pricingPlansV2Plan_universal_d_UpdatePlanOptions as UpdatePlanOptions,\n pricingPlansV2Plan_universal_d_setPlanVisibility as setPlanVisibility,\n pricingPlansV2Plan_universal_d_makePlanPrimary as makePlanPrimary,\n pricingPlansV2Plan_universal_d_clearPrimary as clearPrimary,\n pricingPlansV2Plan_universal_d_archivePlan as archivePlan,\n pricingPlansV2Plan_universal_d_bulkArchivePlan as bulkArchivePlan,\n pricingPlansV2Plan_universal_d_BulkArchivePlanOptions as BulkArchivePlanOptions,\n pricingPlansV2Plan_universal_d_arrangePlans as arrangePlans,\n pricingPlansV2Plan_universal_d_countPlans as countPlans,\n pricingPlansV2Plan_universal_d_CountPlansOptions as CountPlansOptions,\n pricingPlansV2Plan_universal_d_getPlansPremiumStatus as getPlansPremiumStatus,\n pricingPlansV2Plan_universal_d_searchPlans as searchPlans,\n pricingPlansV2Plan_universal_d_SearchPlansOptions as SearchPlansOptions,\n };\n }\n \n export { pricingPlansV2Order_universal_d as orders, pricingPlansV2Plan_universal_d as plans };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-members.v2.d.ts", "content": "declare module \"wix-members.v2\" {\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$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 ListBadgesResponse {\n /** List of badges. */\n badges?: Badge[];\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 * 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 * @internal\n */\n hasNext?: 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$2[];\n /** Pagination options. */\n paging?: Paging$2;\n }\n interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$1 {\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$1;\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$2 {\n /** Badge ID. */\n _id: string;\n /** Pagination options. */\n paging?: Paging$2;\n }\n interface ListMembersResponse$2 {\n /** Member IDs assigned to the badge. */\n memberIds?: string[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata$1;\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$1;\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 ListMembersWithBadgesResponse {\n /** List of members */\n memberIds?: string[];\n /** Metadata for the paginated results */\n pagingMetadata?: CursorPagingMetadata$1;\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 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 * @adminMethod\n * @returns Created badge.\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 * @adminMethod\n * @returns Updated badge.\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 */\n function listBadges(options?: ListBadgesOptions): Promise;\n interface ListBadgesOptions {\n /** Pagination options. */\n paging?: Paging$2;\n }\n /**\n * Retrieves up to 1000 badges, given the requested query options, paging, and sorting.\n * Default `paging.limit` is 100, `paging.offset` - 0.\n * For more information, see\n * [API Query Language: The Paging Section](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-paging-section).\n * @internal\n * @permissionId BADGES.BADGE_READ\n */\n function queryBadges(options?: QueryBadgesOptions): Promise;\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$2[];\n /** Pagination options. */\n paging?: Paging$2;\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 * @returns Badge.\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 * @adminMethod\n */\n function deleteBadge(_id: string): Promise;\n /**\n * Retrieves the site's badge count, given the requested filtering.\n * @internal\n * @documentationMaturity preview\n * @permissionId BADGES.BADGE_READ\n */\n function countBadges(options?: CountBadgesOptions): 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 * @adminMethod\n */\n function assignBadge(_id: string, memberIds: string[]): Promise;\n /**\n * Assigns multiple badges to the specified member.\n * The member inherits the badges' permissions when they receive the badge, if applicable.\n * Badge permissions are added to previous member permissions (they don't replace existing permissions).\n * @param memberId - Member ID.\n * @param ids - List of badge IDs to assign to the member.\n * @internal\n * @requiredField ids\n * @requiredField memberId\n * @permissionId BADGES.BADGE_ASSIGN\n * @adminMethod\n */\n function assignBadges(memberId: string, ids: 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 * @adminMethod\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 */\n function listMembersByBadge(_id: string, options?: ListMembersByBadgeOptions): Promise;\n interface ListMembersByBadgeOptions {\n /** Pagination options. */\n paging?: Paging$2;\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 */\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 */\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 * @adminMethod\n */\n function updateBadgesDisplayOrder(badgeIds: string[]): Promise;\n \n type badgesV3Badge_universal_d_Badge = Badge;\n type badgesV3Badge_universal_d_CreateBadgeRequest = CreateBadgeRequest;\n type badgesV3Badge_universal_d_CreateBadgeResponse = CreateBadgeResponse;\n type badgesV3Badge_universal_d_UpdateBadgeRequest = UpdateBadgeRequest;\n type badgesV3Badge_universal_d_UpdateBadgeResponse = UpdateBadgeResponse;\n type badgesV3Badge_universal_d_ListBadgesRequest = ListBadgesRequest;\n type badgesV3Badge_universal_d_ListBadgesResponse = ListBadgesResponse;\n type badgesV3Badge_universal_d_QueryBadgesRequest = QueryBadgesRequest;\n type badgesV3Badge_universal_d_QueryBadgesResponse = QueryBadgesResponse;\n type badgesV3Badge_universal_d_GetBadgeRequest = GetBadgeRequest;\n type badgesV3Badge_universal_d_GetBadgeResponse = GetBadgeResponse;\n type badgesV3Badge_universal_d_DeleteBadgeRequest = DeleteBadgeRequest;\n type badgesV3Badge_universal_d_DeleteBadgeResponse = DeleteBadgeResponse;\n type badgesV3Badge_universal_d_CountBadgesRequest = CountBadgesRequest;\n type badgesV3Badge_universal_d_CountBadgesResponse = CountBadgesResponse;\n type badgesV3Badge_universal_d_AssignBadgeRequest = AssignBadgeRequest;\n type badgesV3Badge_universal_d_AssignBadgeResponse = AssignBadgeResponse;\n type badgesV3Badge_universal_d_BadgeAssigned = BadgeAssigned;\n type badgesV3Badge_universal_d_AssignBadgesRequest = AssignBadgesRequest;\n type badgesV3Badge_universal_d_AssignBadgesResponse = AssignBadgesResponse;\n type badgesV3Badge_universal_d_UnassignBadgeRequest = UnassignBadgeRequest;\n type badgesV3Badge_universal_d_UnassignBadgeResponse = UnassignBadgeResponse;\n type badgesV3Badge_universal_d_BadgeUnassigned = BadgeUnassigned;\n type badgesV3Badge_universal_d_ListMembersBadgeIdsRequest = ListMembersBadgeIdsRequest;\n type badgesV3Badge_universal_d_ListMembersBadgeIdsResponse = ListMembersBadgeIdsResponse;\n type badgesV3Badge_universal_d_MemberBadgeIds = MemberBadgeIds;\n type badgesV3Badge_universal_d_GetMemberCountsPerBadgeRequest = GetMemberCountsPerBadgeRequest;\n type badgesV3Badge_universal_d_GetMemberCountsPerBadgeResponse = GetMemberCountsPerBadgeResponse;\n type badgesV3Badge_universal_d_BadgeMemberCount = BadgeMemberCount;\n type badgesV3Badge_universal_d_UpdateBadgesDisplayOrderRequest = UpdateBadgesDisplayOrderRequest;\n type badgesV3Badge_universal_d_UpdateBadgesDisplayOrderResponse = UpdateBadgesDisplayOrderResponse;\n type badgesV3Badge_universal_d_ListMembersWithBadgesRequest = ListMembersWithBadgesRequest;\n type badgesV3Badge_universal_d_ListMembersWithBadgesResponse = ListMembersWithBadgesResponse;\n const badgesV3Badge_universal_d_createBadge: typeof createBadge;\n const badgesV3Badge_universal_d_updateBadge: typeof updateBadge;\n type badgesV3Badge_universal_d_UpdateBadge = UpdateBadge;\n const badgesV3Badge_universal_d_listBadges: typeof listBadges;\n type badgesV3Badge_universal_d_ListBadgesOptions = ListBadgesOptions;\n const badgesV3Badge_universal_d_queryBadges: typeof queryBadges;\n type badgesV3Badge_universal_d_QueryBadgesOptions = QueryBadgesOptions;\n const badgesV3Badge_universal_d_getBadge: typeof getBadge;\n const badgesV3Badge_universal_d_deleteBadge: typeof deleteBadge;\n const badgesV3Badge_universal_d_countBadges: typeof countBadges;\n type badgesV3Badge_universal_d_CountBadgesOptions = CountBadgesOptions;\n const badgesV3Badge_universal_d_assignBadge: typeof assignBadge;\n const badgesV3Badge_universal_d_assignBadges: typeof assignBadges;\n const badgesV3Badge_universal_d_unassignBadge: typeof unassignBadge;\n const badgesV3Badge_universal_d_listMembersByBadge: typeof listMembersByBadge;\n type badgesV3Badge_universal_d_ListMembersByBadgeOptions = ListMembersByBadgeOptions;\n const badgesV3Badge_universal_d_listBadgesPerMember: typeof listBadgesPerMember;\n const badgesV3Badge_universal_d_getMemberCountsPerBadge: typeof getMemberCountsPerBadge;\n const badgesV3Badge_universal_d_updateBadgesDisplayOrder: typeof updateBadgesDisplayOrder;\n namespace badgesV3Badge_universal_d {\n export {\n badgesV3Badge_universal_d_Badge as Badge,\n badgesV3Badge_universal_d_CreateBadgeRequest as CreateBadgeRequest,\n badgesV3Badge_universal_d_CreateBadgeResponse as CreateBadgeResponse,\n badgesV3Badge_universal_d_UpdateBadgeRequest as UpdateBadgeRequest,\n badgesV3Badge_universal_d_UpdateBadgeResponse as UpdateBadgeResponse,\n badgesV3Badge_universal_d_ListBadgesRequest as ListBadgesRequest,\n Paging$2 as Paging,\n badgesV3Badge_universal_d_ListBadgesResponse as ListBadgesResponse,\n PagingMetadata$1 as PagingMetadata,\n badgesV3Badge_universal_d_QueryBadgesRequest as QueryBadgesRequest,\n Sorting$2 as Sorting,\n SortOrder$1 as SortOrder,\n badgesV3Badge_universal_d_QueryBadgesResponse as QueryBadgesResponse,\n badgesV3Badge_universal_d_GetBadgeRequest as GetBadgeRequest,\n badgesV3Badge_universal_d_GetBadgeResponse as GetBadgeResponse,\n badgesV3Badge_universal_d_DeleteBadgeRequest as DeleteBadgeRequest,\n badgesV3Badge_universal_d_DeleteBadgeResponse as DeleteBadgeResponse,\n badgesV3Badge_universal_d_CountBadgesRequest as CountBadgesRequest,\n badgesV3Badge_universal_d_CountBadgesResponse as CountBadgesResponse,\n badgesV3Badge_universal_d_AssignBadgeRequest as AssignBadgeRequest,\n badgesV3Badge_universal_d_AssignBadgeResponse as AssignBadgeResponse,\n badgesV3Badge_universal_d_BadgeAssigned as BadgeAssigned,\n badgesV3Badge_universal_d_AssignBadgesRequest as AssignBadgesRequest,\n badgesV3Badge_universal_d_AssignBadgesResponse as AssignBadgesResponse,\n badgesV3Badge_universal_d_UnassignBadgeRequest as UnassignBadgeRequest,\n badgesV3Badge_universal_d_UnassignBadgeResponse as UnassignBadgeResponse,\n badgesV3Badge_universal_d_BadgeUnassigned as BadgeUnassigned,\n ListMembersRequest$2 as ListMembersRequest,\n ListMembersResponse$2 as ListMembersResponse,\n badgesV3Badge_universal_d_ListMembersBadgeIdsRequest as ListMembersBadgeIdsRequest,\n badgesV3Badge_universal_d_ListMembersBadgeIdsResponse as ListMembersBadgeIdsResponse,\n badgesV3Badge_universal_d_MemberBadgeIds as MemberBadgeIds,\n badgesV3Badge_universal_d_GetMemberCountsPerBadgeRequest as GetMemberCountsPerBadgeRequest,\n badgesV3Badge_universal_d_GetMemberCountsPerBadgeResponse as GetMemberCountsPerBadgeResponse,\n badgesV3Badge_universal_d_BadgeMemberCount as BadgeMemberCount,\n badgesV3Badge_universal_d_UpdateBadgesDisplayOrderRequest as UpdateBadgesDisplayOrderRequest,\n badgesV3Badge_universal_d_UpdateBadgesDisplayOrderResponse as UpdateBadgesDisplayOrderResponse,\n badgesV3Badge_universal_d_ListMembersWithBadgesRequest as ListMembersWithBadgesRequest,\n CursorPaging$1 as CursorPaging,\n badgesV3Badge_universal_d_ListMembersWithBadgesResponse as ListMembersWithBadgesResponse,\n CursorPagingMetadata$1 as CursorPagingMetadata,\n Cursors$1 as Cursors,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n badgesV3Badge_universal_d_createBadge as createBadge,\n badgesV3Badge_universal_d_updateBadge as updateBadge,\n badgesV3Badge_universal_d_UpdateBadge as UpdateBadge,\n badgesV3Badge_universal_d_listBadges as listBadges,\n badgesV3Badge_universal_d_ListBadgesOptions as ListBadgesOptions,\n badgesV3Badge_universal_d_queryBadges as queryBadges,\n badgesV3Badge_universal_d_QueryBadgesOptions as QueryBadgesOptions,\n badgesV3Badge_universal_d_getBadge as getBadge,\n badgesV3Badge_universal_d_deleteBadge as deleteBadge,\n badgesV3Badge_universal_d_countBadges as countBadges,\n badgesV3Badge_universal_d_CountBadgesOptions as CountBadgesOptions,\n badgesV3Badge_universal_d_assignBadge as assignBadge,\n badgesV3Badge_universal_d_assignBadges as assignBadges,\n badgesV3Badge_universal_d_unassignBadge as unassignBadge,\n badgesV3Badge_universal_d_listMembersByBadge as listMembersByBadge,\n badgesV3Badge_universal_d_ListMembersByBadgeOptions as ListMembersByBadgeOptions,\n badgesV3Badge_universal_d_listBadgesPerMember as listBadgesPerMember,\n badgesV3Badge_universal_d_getMemberCountsPerBadge as getMemberCountsPerBadge,\n badgesV3Badge_universal_d_updateBadgesDisplayOrder as updateBadgesDisplayOrder,\n };\n }\n \n interface Member$1 {\n /**\n * Member ID.\n * @readonly\n */\n _id?: string;\n /**\n * @internal\n * @internal\n * @readonly\n */\n emailVerified?: boolean;\n /**\n * @internal\n * @internal */\n role?: Role$1;\n /**\n * Email used by the member to log in to the site.\n *\n *\n */\n loginEmail?: string | null;\n /**\n * @internal\n * @internal */\n memberName?: string | null;\n /** Member's first name. */\n firstName?: string | null;\n /** Member's last name. */\n lastName?: string | null;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n imageUrl?: 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 * @internal\n * @internal */\n language?: 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 | null;\n /**\n * Date and time when the member was last updated.\n *\n *\n * @readonly\n */\n lastUpdateDate?: Date | null;\n /**\n * Date and time when the member last logged in to the site.\n *\n * @readonly\n */\n lastLoginDate?: Date | null;\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 * @internal\n * @internal */\n labels?: string[];\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 * @internal\n * @internal */\n userId?: string | null;\n /**\n * @internal\n * @internal */\n groups?: Group[];\n /**\n * Member's contact ID.\n * @readonly\n */\n contactId?: string | null;\n }\n enum Role$1 {\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 | null;\n /** Display name. */\n name?: string;\n }\n /** @oneof */\n interface CustomFieldValueOneOf {\n strValue?: string | null;\n numValue?: number;\n dateValue?: Date | 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 interface Group {\n _id?: string;\n name?: string;\n type?: string;\n }\n interface ListMembersRequest$1 {\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$1 {\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$1;\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$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 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$1[];\n }\n enum Sorting$1 {\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$1;\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$1;\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$1 {\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$1;\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 * an explicit declaration of contact fields that should be updated by this request.\n * *Currently only affects contact fields.\n * @internal\n */\n fieldMask?: string[];\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 * @internal\n * @internal */\n revokeCurrentSessions?: boolean | null;\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 * @internal\n * @internal */\n source?: Source;\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 * @internal\n * @internal */\n dialogData?: DialogData;\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 * @internal\n * @internal */\n isOfflineRegistration?: boolean;\n /**\n * @internal\n * @internal */\n recaptchaToken?: string | null;\n /**\n * @internal\n * @internal */\n invisibleRecaptchaToken?: string | null;\n /**\n * @internal\n * @internal */\n emailVerification?: EmailVerification;\n /**\n * @internal\n * @internal */\n isMobile?: boolean | null;\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 * @internal\n * @internal */\n locale?: string | null;\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 * @internal\n * @internal */\n recaptchaToken?: string;\n /**\n * @internal\n * @internal */\n invisibleRecaptchaToken?: string;\n /**\n * @internal\n * @internal */\n emailVerification?: EmailVerification;\n /**\n * @internal\n * @internal */\n isMobile?: boolean | null;\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 * @internal\n * @internal\n * @deprecated\n */\n requestedByMember?: boolean;\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 /**\n * Returns a list of members according to:\n * - Pagination: `offset`, `limit`\n * - Order: by some of the following fields: `id`, `login_email`, `status`, `language`, `date_created`, `last_update_date`, `flags`, `name`, `first_name`, `last_name`, `nickname`, `email_verified`, `privacy_status`\n * - Optional filter by `SiteMemberStatus`\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function list(options?: ListOptions): Promise;\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 /**\n * Returns a list of members according to search and filter inputs:\n * - Pagination: `offset`, `limit`\n * - Optional filter by `group_id` `SiteMemberStatus`\n * - Optional search by `nickname`\n * - Order: by `date_created`\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function search(options?: SearchOptions): Promise;\n interface SearchOptions {\n /** paging - offset and limit */\n paging?: Paging$1;\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$1;\n }\n /**\n * Returns information about a current member (by authorization header)\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getCurrent(): Promise;\n /**\n * Returns information about a particular member\n * @param _id - unique identifier of the requested member(required)\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function get(_id: string, options?: GetOptions): Promise;\n interface GetOptions {\n /** whether to include contact details */\n includeContactDetails?: boolean;\n /** whether to include groups details */\n includeGroupsDetails?: boolean;\n }\n /**\n * Returns all user memberships\n * @param userId - unique identifier of the requested **Wix** user\n * @internal\n * @documentationMaturity preview\n * @requiredField userId\n * @adminMethod\n */\n function getUserMemberships(userId: string, options?: GetUserMembershipsOptions): Promise;\n interface GetUserMembershipsOptions {\n /** paging - offset and limit ( the max limit for page is 200) */\n paging?: Paging$1;\n }\n /**\n * Returns member role.\n * This endpoint is needed for migration from this API to umbrella API, because umbrella API does not expose role.\n * Accepts siteMemberId as id param, which can be: contactId, userId\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function getRole(_id: string): Promise;\n /**\n * Returns members roles.\n * This endpoint is needed for migration from this API to umbrella API, because umbrella API does not expose role.\n * Accepts siteMemberId as id params, which can be: contactId, userId\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function getRoles$1(options?: GetRolesOptions): Promise;\n interface GetRolesOptions {\n /** user_id and/or contact_id */\n ids?: string[];\n }\n /**\n * Returns information about a list member\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function batchGet(options?: BatchGetOptions): Promise;\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 /** @internal\n * @documentationMaturity preview\n * @requiredField siteId\n * @adminMethod\n */\n function getAuthorizedPages(siteId: string, options?: GetAuthorizedPagesOptions): Promise;\n interface GetAuthorizedPagesOptions {\n _id?: string;\n }\n /**\n * Update fields of an existing member\n * - Possible fields are: `imageUrl`, `nickname`, `privacyStatus`, `slug`\n * @param _id - member id\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function update(_id: string, options?: UpdateOptions): Promise;\n interface UpdateOptions {\n /** the Member object containing the fields to update */\n member?: Member$1;\n /**\n * an explicit declaration of contact fields that should be updated by this request.\n * *Currently only affects contact fields.\n * @internal\n */\n fieldMask?: string[];\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 * @internal\n * @internal */\n revokeCurrentSessions?: boolean | null;\n }\n /**\n * Returns a list of members, given the provided paging, sort and filter\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function query(options?: QueryOptions): Promise;\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 /**\n * Delete a member by id\n * @param _id - id of member that should be deleted (required)\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function _delete(_id: string, options?: DeleteOptions): Promise;\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 * @permissionId MEMBERS.MEMBER_APPROVE\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 * @internal\n * @internal */\n source?: Source;\n }\n /**\n * Make member offline.\n * After this action, member `status` field is set to `OFFLINE_ONLY`.\n * Offline member cannot log into a site. Member is not visible in Business Manager site members list.\n * @param _id - unique identifier of the requested member\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_DISCONNECT\n * @adminMethod\n */\n function makeMemberOffline(_id: string): Promise;\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 /** @internal */\n dialogData?: DialogData;\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 /** @internal */\n isOfflineRegistration?: boolean;\n /** @internal */\n recaptchaToken?: string | null;\n /** @internal */\n invisibleRecaptchaToken?: string | null;\n /**\n * Email verification.\n * @internal */\n emailVerification?: EmailVerification;\n /** @internal */\n isMobile?: boolean | null;\n }\n /**\n * Registers new site member.\n * This will try to connect the member to an existing contact, or create a new one in case no matches were found.\n *\n * To resend email with `otp` code, please provide `emailVerification` with `verificationId` only, and no `otp`.\n * It will skip recaptcha and resend the code to the given email.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function signup(options?: SignupOptions): Promise;\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 /** @internal */\n dialogData?: DialogData;\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 /** @internal */\n isOfflineRegistration?: boolean;\n /** @internal */\n recaptchaToken?: string | null;\n /** @internal */\n invisibleRecaptchaToken?: string | null;\n /** @internal */\n emailVerification?: EmailVerification;\n /** @internal */\n isMobile?: boolean | null;\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 /** @internal */\n recaptchaToken?: string;\n /** @internal */\n invisibleRecaptchaToken?: string;\n /** @internal */\n emailVerification?: EmailVerification;\n /** @internal */\n isMobile?: boolean | null;\n }\n /**\n * Creates a link to reset a site member's password.\n *\n * The returned link must be provided to the site member,\n * who must click the link and provide a new password.\n * The link is valid for one use, up to two weeks from when it is created.\n * @param contactId - Contact ID of the member whose password will be reset.\n * @internal\n * @documentationMaturity preview\n * @requiredField contactId\n * @permissionId MEMBERS.CREATE_RESET_PASSWORD_LINK\n * @adminMethod\n */\n function getResetPasswordLink(contactId: string): Promise;\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 * @permissionId MEMBERS.SEND_SET_PASSWORD_EMAIL\n */\n function sendSetPasswordEmail(email: string, options?: SendSetPasswordEmailOptions): Promise;\n interface SendSetPasswordEmailOptions {\n /**\n * @internal\n * @internal\n * @deprecated\n */\n requestedByMember?: boolean;\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 /**\n * Reset member password\n *\n * Replaces the member password with a random password and it requires the member to reset his password to login\n * @param contactId - Contact ID of the member whose password will be reset.\n * @internal\n * @documentationMaturity preview\n * @requiredField contactId\n * @permissionId MEMBERS.RESET_PASSWORD\n * @adminMethod\n */\n function resetPassword(contactId: string): Promise;\n /**\n * Logs a member in with a social provider.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n * @returns Session token for logging the member in.\n */\n function socialLogin(options?: SocialLoginOptions): Promise;\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 \n type identityMembersV1Member_universal_d_SiteMemberPrivacyStatus = SiteMemberPrivacyStatus;\n const identityMembersV1Member_universal_d_SiteMemberPrivacyStatus: typeof SiteMemberPrivacyStatus;\n type identityMembersV1Member_universal_d_SiteMemberStatus = SiteMemberStatus;\n const identityMembersV1Member_universal_d_SiteMemberStatus: typeof SiteMemberStatus;\n type identityMembersV1Member_universal_d_CustomFieldValueOneOf = CustomFieldValueOneOf;\n type identityMembersV1Member_universal_d_FocalPoint = FocalPoint;\n type identityMembersV1Member_universal_d_Group = Group;\n type identityMembersV1Member_universal_d_PaginationResponse = PaginationResponse;\n type identityMembersV1Member_universal_d_SearchRequest = SearchRequest;\n type identityMembersV1Member_universal_d_SearchBy = SearchBy;\n type identityMembersV1Member_universal_d_FilterBy = FilterBy;\n type identityMembersV1Member_universal_d_SearchResponse = SearchResponse;\n type identityMembersV1Member_universal_d_GetCurrentMemberRequest = GetCurrentMemberRequest;\n type identityMembersV1Member_universal_d_GetUserMembershipsRequest = GetUserMembershipsRequest;\n type identityMembersV1Member_universal_d_GetUserMembershipsResponse = GetUserMembershipsResponse;\n type identityMembersV1Member_universal_d_UserMembership = UserMembership;\n type identityMembersV1Member_universal_d_GetMemberRoleRequest = GetMemberRoleRequest;\n type identityMembersV1Member_universal_d_GetMemberRoleResponse = GetMemberRoleResponse;\n type identityMembersV1Member_universal_d_GetMemberRolesRequest = GetMemberRolesRequest;\n type identityMembersV1Member_universal_d_GetMemberRolesResponse = GetMemberRolesResponse;\n type identityMembersV1Member_universal_d_BatchGetMembersRequest = BatchGetMembersRequest;\n type identityMembersV1Member_universal_d_BatchGetMembersResponse = BatchGetMembersResponse;\n type identityMembersV1Member_universal_d_GetAuthorizedPagesRequest = GetAuthorizedPagesRequest;\n type identityMembersV1Member_universal_d_GetAuthorizedPagesResponse = GetAuthorizedPagesResponse;\n type identityMembersV1Member_universal_d_ChangeLoginEmailRequest = ChangeLoginEmailRequest;\n type identityMembersV1Member_universal_d_ChangeLoginEmailResponse = ChangeLoginEmailResponse;\n type identityMembersV1Member_universal_d_ApproveMemberRequestMemberIdentifierOneOf = ApproveMemberRequestMemberIdentifierOneOf;\n type identityMembersV1Member_universal_d_Session = Session;\n type identityMembersV1Member_universal_d_BlockMemberRequestMemberIdentifierOneOf = BlockMemberRequestMemberIdentifierOneOf;\n type identityMembersV1Member_universal_d_Source = Source;\n const identityMembersV1Member_universal_d_Source: typeof Source;\n type identityMembersV1Member_universal_d_MakeMemberOfflineRequest = MakeMemberOfflineRequest;\n type identityMembersV1Member_universal_d_MakeMemberOfflineResponse = MakeMemberOfflineResponse;\n type identityMembersV1Member_universal_d_RegisterRequest = RegisterRequest;\n type identityMembersV1Member_universal_d_MemberContactInfo = MemberContactInfo;\n type identityMembersV1Member_universal_d_DialogData = DialogData;\n type identityMembersV1Member_universal_d_EmailVerification = EmailVerification;\n type identityMembersV1Member_universal_d_RegisterResponse = RegisterResponse;\n type identityMembersV1Member_universal_d_EmailVerificationRequired = EmailVerificationRequired;\n type identityMembersV1Member_universal_d_EmailVerificationFailed = EmailVerificationFailed;\n type identityMembersV1Member_universal_d_VerificationFailureReason = VerificationFailureReason;\n const identityMembersV1Member_universal_d_VerificationFailureReason: typeof VerificationFailureReason;\n type identityMembersV1Member_universal_d_LoginRequest = LoginRequest;\n type identityMembersV1Member_universal_d_LoginResponse = LoginResponse;\n type identityMembersV1Member_universal_d_GetResetPasswordLinkRequest = GetResetPasswordLinkRequest;\n type identityMembersV1Member_universal_d_GetResetPasswordLinkResponse = GetResetPasswordLinkResponse;\n type identityMembersV1Member_universal_d_SendSetPasswordEmailRequest = SendSetPasswordEmailRequest;\n type identityMembersV1Member_universal_d_SendSetPasswordEmailResponse = SendSetPasswordEmailResponse;\n type identityMembersV1Member_universal_d_ResetPasswordRequest = ResetPasswordRequest;\n type identityMembersV1Member_universal_d_ResetPasswordResponse = ResetPasswordResponse;\n type identityMembersV1Member_universal_d_SocialLoginRequest = SocialLoginRequest;\n type identityMembersV1Member_universal_d_SocialLoginRequestLoginOneOf = SocialLoginRequestLoginOneOf;\n type identityMembersV1Member_universal_d_AppleLogin = AppleLogin;\n type identityMembersV1Member_universal_d_GoogleLogin = GoogleLogin;\n type identityMembersV1Member_universal_d_FacebookLogin = FacebookLogin;\n const identityMembersV1Member_universal_d_list: typeof list;\n type identityMembersV1Member_universal_d_ListOptions = ListOptions;\n const identityMembersV1Member_universal_d_search: typeof search;\n type identityMembersV1Member_universal_d_SearchOptions = SearchOptions;\n const identityMembersV1Member_universal_d_getCurrent: typeof getCurrent;\n const identityMembersV1Member_universal_d_get: typeof get;\n type identityMembersV1Member_universal_d_GetOptions = GetOptions;\n const identityMembersV1Member_universal_d_getUserMemberships: typeof getUserMemberships;\n type identityMembersV1Member_universal_d_GetUserMembershipsOptions = GetUserMembershipsOptions;\n const identityMembersV1Member_universal_d_getRole: typeof getRole;\n type identityMembersV1Member_universal_d_GetRolesOptions = GetRolesOptions;\n const identityMembersV1Member_universal_d_batchGet: typeof batchGet;\n type identityMembersV1Member_universal_d_BatchGetOptions = BatchGetOptions;\n const identityMembersV1Member_universal_d_getAuthorizedPages: typeof getAuthorizedPages;\n type identityMembersV1Member_universal_d_GetAuthorizedPagesOptions = GetAuthorizedPagesOptions;\n const identityMembersV1Member_universal_d_update: typeof update;\n type identityMembersV1Member_universal_d_UpdateOptions = UpdateOptions;\n const identityMembersV1Member_universal_d_changeLoginEmail: typeof changeLoginEmail;\n type identityMembersV1Member_universal_d_ChangeLoginEmailOptions = ChangeLoginEmailOptions;\n const identityMembersV1Member_universal_d_query: typeof query;\n type identityMembersV1Member_universal_d_QueryOptions = QueryOptions;\n const identityMembersV1Member_universal_d__delete: typeof _delete;\n type identityMembersV1Member_universal_d_DeleteOptions = DeleteOptions;\n const identityMembersV1Member_universal_d_approve: typeof approve;\n type identityMembersV1Member_universal_d_ApproveOptions = ApproveOptions;\n const identityMembersV1Member_universal_d_block: typeof block;\n type identityMembersV1Member_universal_d_BlockOptions = BlockOptions;\n const identityMembersV1Member_universal_d_makeMemberOffline: typeof makeMemberOffline;\n const identityMembersV1Member_universal_d_register: typeof register;\n type identityMembersV1Member_universal_d_RegisterOptions = RegisterOptions;\n const identityMembersV1Member_universal_d_signup: typeof signup;\n type identityMembersV1Member_universal_d_SignupOptions = SignupOptions;\n const identityMembersV1Member_universal_d_login: typeof login;\n type identityMembersV1Member_universal_d_LoginOptions = LoginOptions;\n const identityMembersV1Member_universal_d_getResetPasswordLink: typeof getResetPasswordLink;\n const identityMembersV1Member_universal_d_sendSetPasswordEmail: typeof sendSetPasswordEmail;\n type identityMembersV1Member_universal_d_SendSetPasswordEmailOptions = SendSetPasswordEmailOptions;\n const identityMembersV1Member_universal_d_resetPassword: typeof resetPassword;\n const identityMembersV1Member_universal_d_socialLogin: typeof socialLogin;\n type identityMembersV1Member_universal_d_SocialLoginOptions = SocialLoginOptions;\n namespace identityMembersV1Member_universal_d {\n export {\n Member$1 as Member,\n Role$1 as Role,\n identityMembersV1Member_universal_d_SiteMemberPrivacyStatus as SiteMemberPrivacyStatus,\n identityMembersV1Member_universal_d_SiteMemberStatus as SiteMemberStatus,\n Address$1 as Address,\n CustomField$1 as CustomField,\n identityMembersV1Member_universal_d_CustomFieldValueOneOf as CustomFieldValueOneOf,\n identityMembersV1Member_universal_d_FocalPoint as FocalPoint,\n identityMembersV1Member_universal_d_Group as Group,\n ListMembersRequest$1 as ListMembersRequest,\n ListMembersResponse$1 as ListMembersResponse,\n identityMembersV1Member_universal_d_PaginationResponse as PaginationResponse,\n identityMembersV1Member_universal_d_SearchRequest as SearchRequest,\n Paging$1 as Paging,\n identityMembersV1Member_universal_d_SearchBy as SearchBy,\n identityMembersV1Member_universal_d_FilterBy as FilterBy,\n Sorting$1 as Sorting,\n identityMembersV1Member_universal_d_SearchResponse as SearchResponse,\n identityMembersV1Member_universal_d_GetCurrentMemberRequest as GetCurrentMemberRequest,\n GetMemberResponse$1 as GetMemberResponse,\n GetMemberRequest$1 as GetMemberRequest,\n identityMembersV1Member_universal_d_GetUserMembershipsRequest as GetUserMembershipsRequest,\n identityMembersV1Member_universal_d_GetUserMembershipsResponse as GetUserMembershipsResponse,\n identityMembersV1Member_universal_d_UserMembership as UserMembership,\n identityMembersV1Member_universal_d_GetMemberRoleRequest as GetMemberRoleRequest,\n identityMembersV1Member_universal_d_GetMemberRoleResponse as GetMemberRoleResponse,\n identityMembersV1Member_universal_d_GetMemberRolesRequest as GetMemberRolesRequest,\n identityMembersV1Member_universal_d_GetMemberRolesResponse as GetMemberRolesResponse,\n MemberRole$1 as MemberRole,\n identityMembersV1Member_universal_d_BatchGetMembersRequest as BatchGetMembersRequest,\n identityMembersV1Member_universal_d_BatchGetMembersResponse as BatchGetMembersResponse,\n identityMembersV1Member_universal_d_GetAuthorizedPagesRequest as GetAuthorizedPagesRequest,\n identityMembersV1Member_universal_d_GetAuthorizedPagesResponse as GetAuthorizedPagesResponse,\n UpdateMemberRequest$1 as UpdateMemberRequest,\n UpdateMemberResponse$1 as UpdateMemberResponse,\n identityMembersV1Member_universal_d_ChangeLoginEmailRequest as ChangeLoginEmailRequest,\n identityMembersV1Member_universal_d_ChangeLoginEmailResponse as ChangeLoginEmailResponse,\n QueryMembersRequest$1 as QueryMembersRequest,\n QueryMembersResponse$1 as QueryMembersResponse,\n DeleteMemberRequest$1 as DeleteMemberRequest,\n DeleteMemberResponse$1 as DeleteMemberResponse,\n ApproveMemberRequest$1 as ApproveMemberRequest,\n identityMembersV1Member_universal_d_ApproveMemberRequestMemberIdentifierOneOf as ApproveMemberRequestMemberIdentifierOneOf,\n ApproveMemberResponse$1 as ApproveMemberResponse,\n identityMembersV1Member_universal_d_Session as Session,\n BlockMemberRequest$1 as BlockMemberRequest,\n identityMembersV1Member_universal_d_BlockMemberRequestMemberIdentifierOneOf as BlockMemberRequestMemberIdentifierOneOf,\n identityMembersV1Member_universal_d_Source as Source,\n BlockMemberResponse$1 as BlockMemberResponse,\n identityMembersV1Member_universal_d_MakeMemberOfflineRequest as MakeMemberOfflineRequest,\n identityMembersV1Member_universal_d_MakeMemberOfflineResponse as MakeMemberOfflineResponse,\n identityMembersV1Member_universal_d_RegisterRequest as RegisterRequest,\n identityMembersV1Member_universal_d_MemberContactInfo as MemberContactInfo,\n identityMembersV1Member_universal_d_DialogData as DialogData,\n identityMembersV1Member_universal_d_EmailVerification as EmailVerification,\n identityMembersV1Member_universal_d_RegisterResponse as RegisterResponse,\n identityMembersV1Member_universal_d_EmailVerificationRequired as EmailVerificationRequired,\n identityMembersV1Member_universal_d_EmailVerificationFailed as EmailVerificationFailed,\n identityMembersV1Member_universal_d_VerificationFailureReason as VerificationFailureReason,\n identityMembersV1Member_universal_d_LoginRequest as LoginRequest,\n identityMembersV1Member_universal_d_LoginResponse as LoginResponse,\n identityMembersV1Member_universal_d_GetResetPasswordLinkRequest as GetResetPasswordLinkRequest,\n identityMembersV1Member_universal_d_GetResetPasswordLinkResponse as GetResetPasswordLinkResponse,\n identityMembersV1Member_universal_d_SendSetPasswordEmailRequest as SendSetPasswordEmailRequest,\n identityMembersV1Member_universal_d_SendSetPasswordEmailResponse as SendSetPasswordEmailResponse,\n identityMembersV1Member_universal_d_ResetPasswordRequest as ResetPasswordRequest,\n identityMembersV1Member_universal_d_ResetPasswordResponse as ResetPasswordResponse,\n identityMembersV1Member_universal_d_SocialLoginRequest as SocialLoginRequest,\n identityMembersV1Member_universal_d_SocialLoginRequestLoginOneOf as SocialLoginRequestLoginOneOf,\n identityMembersV1Member_universal_d_AppleLogin as AppleLogin,\n identityMembersV1Member_universal_d_GoogleLogin as GoogleLogin,\n identityMembersV1Member_universal_d_FacebookLogin as FacebookLogin,\n identityMembersV1Member_universal_d_list as list,\n identityMembersV1Member_universal_d_ListOptions as ListOptions,\n identityMembersV1Member_universal_d_search as search,\n identityMembersV1Member_universal_d_SearchOptions as SearchOptions,\n identityMembersV1Member_universal_d_getCurrent as getCurrent,\n identityMembersV1Member_universal_d_get as get,\n identityMembersV1Member_universal_d_GetOptions as GetOptions,\n identityMembersV1Member_universal_d_getUserMemberships as getUserMemberships,\n identityMembersV1Member_universal_d_GetUserMembershipsOptions as GetUserMembershipsOptions,\n identityMembersV1Member_universal_d_getRole as getRole,\n getRoles$1 as getRoles,\n identityMembersV1Member_universal_d_GetRolesOptions as GetRolesOptions,\n identityMembersV1Member_universal_d_batchGet as batchGet,\n identityMembersV1Member_universal_d_BatchGetOptions as BatchGetOptions,\n identityMembersV1Member_universal_d_getAuthorizedPages as getAuthorizedPages,\n identityMembersV1Member_universal_d_GetAuthorizedPagesOptions as GetAuthorizedPagesOptions,\n identityMembersV1Member_universal_d_update as update,\n identityMembersV1Member_universal_d_UpdateOptions as UpdateOptions,\n identityMembersV1Member_universal_d_changeLoginEmail as changeLoginEmail,\n identityMembersV1Member_universal_d_ChangeLoginEmailOptions as ChangeLoginEmailOptions,\n identityMembersV1Member_universal_d_query as query,\n identityMembersV1Member_universal_d_QueryOptions as QueryOptions,\n identityMembersV1Member_universal_d__delete as _delete,\n identityMembersV1Member_universal_d_DeleteOptions as DeleteOptions,\n identityMembersV1Member_universal_d_approve as approve,\n identityMembersV1Member_universal_d_ApproveOptions as ApproveOptions,\n identityMembersV1Member_universal_d_block as block,\n identityMembersV1Member_universal_d_BlockOptions as BlockOptions,\n identityMembersV1Member_universal_d_makeMemberOffline as makeMemberOffline,\n identityMembersV1Member_universal_d_register as register,\n identityMembersV1Member_universal_d_RegisterOptions as RegisterOptions,\n identityMembersV1Member_universal_d_signup as signup,\n identityMembersV1Member_universal_d_SignupOptions as SignupOptions,\n identityMembersV1Member_universal_d_login as login,\n identityMembersV1Member_universal_d_LoginOptions as LoginOptions,\n identityMembersV1Member_universal_d_getResetPasswordLink as getResetPasswordLink,\n identityMembersV1Member_universal_d_sendSetPasswordEmail as sendSetPasswordEmail,\n identityMembersV1Member_universal_d_SendSetPasswordEmailOptions as SendSetPasswordEmailOptions,\n identityMembersV1Member_universal_d_resetPassword as resetPassword,\n identityMembersV1Member_universal_d_socialLogin as socialLogin,\n identityMembersV1Member_universal_d_SocialLoginOptions as SocialLoginOptions,\n };\n }\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 * Extended fields\n * @internal\n * @deprecated Extended fields\n * @targetRemovalDate 2024-06-01\n */\n extendedFields?: ExtendedFields;\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 /**\n * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n contactId?: string | null;\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 * @internal\n * @internal\n * @internal\n * @deprecated\n */\n fieldSet?: Set;\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 {\n paging?: Paging;\n /**\n * @internal\n * @internal\n * @internal\n * @deprecated\n */\n fieldSet?: Set;\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[];\n /**\n * Cursor paging.\n *\n * Priority over paging property\n * @internal\n */\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 Sorting {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 ListMembersResponse {\n /** List of members. */\n members?: Member[];\n /** Metadata for the paginated results. */\n metadata?: PagingMetadata;\n /**\n * Cursor metadata for paginated results.\n * @internal\n */\n cursorPagingMetadata?: CursorPagingMetadata;\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 * 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 * @internal\n */\n hasNext?: boolean | null;\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 QueryMembersRequest {\n /** Query options. */\n query?: Query$1;\n /**\n * @internal\n * @internal\n * @internal\n * @deprecated\n */\n fieldSet?: Set;\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$1 {\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;\n /** Sort the results */\n sorting?: Sorting[];\n /**\n * Cursor paging.\n *\n * Priority over paging property\n * @internal\n */\n cursorPaging?: CursorPaging;\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;\n /**\n * Cursor metadata for paginated results.\n * @internal\n */\n cursorPagingMetadata?: CursorPagingMetadata;\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 * ID of a member receiving deleted member's content.\n * @internal\n */\n contentAssigneeId?: string | null;\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$1 {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent {\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 /** 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 {\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 * 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 * @documentationMaturity preview\n * @requiredField slug\n * @permissionId MEMBERS.MEMBER_UPDATE\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 * @documentationMaturity preview\n * @requiredField _id\n * @requiredField slug\n * @permissionId MEMBERS.MEMBER_UPDATE\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 * @returns Member profile.\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 * @returns Member profile.\n */\n function leaveCommunity(): Promise;\n /**\n * Retrieves the currently logged-in member.\n * @public\n * @documentationMaturity preview\n * @permissionId MEMBERS.MEMBER_READ\n * @returns Member profile.\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 * @returns The requested member.\n */\n function getMember(_id: string, options?: GetMemberOptions): Promise;\n interface GetMemberOptions {\n /**\n * @internal\n * @internal\n * @deprecated\n */\n fieldSet?: Set;\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 * @documentationMaturity preview\n * @param options - Options for paging, sorting, and specifying fields to return.\n * @permissionId MEMBERS.MEMBER_READ\n */\n function listMembers(options?: ListMembersOptions): Promise;\n interface ListMembersOptions {\n /** Paging options. */\n paging?: Paging;\n /**\n * @internal\n * @internal\n * @internal\n * @deprecated\n */\n fieldSet?: Set;\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[];\n /**\n * Cursor paging.\n *\n * Priority over paging property\n * @internal\n */\n cursorPaging?: CursorPaging;\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 * @documentationMaturity preview\n * @param options - Query options.\n * @permissionId MEMBERS.MEMBER_READ\n */\n function queryMembers(options?: QueryMembersOptions): MembersQueryBuilder;\n interface QueryMembersOptions {\n /**\n * @internal\n * @internal\n * @internal\n * @deprecated\n */\n fieldSet?: Set | undefined;\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\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 * @documentationMaturity preview\n */\n hasSome: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any[]) => MembersQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: '_id' | 'loginEmail' | 'contactId' | 'contact.firstName' | 'contact.lastName' | 'profile.nickname' | 'profile.slug' | 'privacyStatus', value: any) => MembersQueryBuilder;\n /** @documentationMaturity preview */\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 * @documentationMaturity preview\n */\n limit: (limit: number) => MembersQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => MembersQueryBuilder;\n /** @documentationMaturity preview */\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_MUTE\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_MUTE\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_APPROVE\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_BLOCK\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField _id\n * @permissionId MEMBERS.MEMBER_DISCONNECT\n * @adminMethod\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 * @adminMethod\n */\n function deleteMember(_id: string, options?: DeleteMemberOptions): Promise;\n interface DeleteMemberOptions {\n /**\n * ID of a member receiving deleted member's content.\n * @internal\n */\n contentAssigneeId?: string | null;\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 * @documentationMaturity preview\n * @permissionId MEMBERS.MEMBER_DELETE\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField memberIds\n * @permissionId MEMBERS.MEMBER_DELETE\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField filter\n * @permissionId MEMBERS.MEMBER_DELETE\n * @adminMethod\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 peding 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 * @documentationMaturity preview\n * @requiredField filter\n * @permissionId MEMBERS.MEMBER_APPROVE\n * @adminMethod\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 * @documentationMaturity preview\n * @requiredField filter\n * @permissionId MEMBERS.MEMBER_BLOCK\n * @adminMethod\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 * @documentationMaturity preview\n * @permissionId MEMBERS.MEMBER_CREATE\n * @adminMethod\n * @returns New member.\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 * @returns Updated member.\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 * Extended fields\n * @internal\n * @deprecated Extended fields\n * @targetRemovalDate 2024-06-01\n */\n extendedFields?: ExtendedFields;\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 */\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 */\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 */\n function deleteMemberAddresses(_id: string): Promise;\n \n type membersV1Member_universal_d_Member = Member;\n type membersV1Member_universal_d_Status = Status;\n const membersV1Member_universal_d_Status: typeof Status;\n type membersV1Member_universal_d_Contact = Contact;\n type membersV1Member_universal_d_Address = Address;\n type membersV1Member_universal_d_AddressStreetOneOf = AddressStreetOneOf;\n type membersV1Member_universal_d_StreetAddress = StreetAddress;\n type membersV1Member_universal_d_CustomField = CustomField;\n type membersV1Member_universal_d_Profile = Profile;\n type membersV1Member_universal_d_Image = Image;\n type membersV1Member_universal_d_PrivacyStatusStatus = PrivacyStatusStatus;\n const membersV1Member_universal_d_PrivacyStatusStatus: typeof PrivacyStatusStatus;\n type membersV1Member_universal_d_ActivityStatusStatus = ActivityStatusStatus;\n const membersV1Member_universal_d_ActivityStatusStatus: typeof ActivityStatusStatus;\n type membersV1Member_universal_d_ExtendedFields = ExtendedFields;\n type membersV1Member_universal_d_InvalidateCache = InvalidateCache;\n type membersV1Member_universal_d_InvalidateCacheGetByOneOf = InvalidateCacheGetByOneOf;\n type membersV1Member_universal_d_App = App;\n type membersV1Member_universal_d_Page = Page;\n type membersV1Member_universal_d_URI = URI;\n type membersV1Member_universal_d_File = File;\n type membersV1Member_universal_d_UpdateMySlugRequest = UpdateMySlugRequest;\n type membersV1Member_universal_d_UpdateMySlugResponse = UpdateMySlugResponse;\n type membersV1Member_universal_d_SlugAlreadyExistsPayload = SlugAlreadyExistsPayload;\n type membersV1Member_universal_d_UpdateMemberSlugRequest = UpdateMemberSlugRequest;\n type membersV1Member_universal_d_UpdateMemberSlugResponse = UpdateMemberSlugResponse;\n type membersV1Member_universal_d_JoinCommunityRequest = JoinCommunityRequest;\n type membersV1Member_universal_d_JoinCommunityResponse = JoinCommunityResponse;\n type membersV1Member_universal_d_MemberJoinedCommunity = MemberJoinedCommunity;\n type membersV1Member_universal_d_LeaveCommunityRequest = LeaveCommunityRequest;\n type membersV1Member_universal_d_LeaveCommunityResponse = LeaveCommunityResponse;\n type membersV1Member_universal_d_MemberLeftCommunity = MemberLeftCommunity;\n type membersV1Member_universal_d_GetMyMemberRequest = GetMyMemberRequest;\n type membersV1Member_universal_d_Set = Set;\n const membersV1Member_universal_d_Set: typeof Set;\n type membersV1Member_universal_d_GetMyMemberResponse = GetMyMemberResponse;\n type membersV1Member_universal_d_GetMemberRequest = GetMemberRequest;\n type membersV1Member_universal_d_GetMemberResponse = GetMemberResponse;\n type membersV1Member_universal_d_MemberToMemberBlockedPayload = MemberToMemberBlockedPayload;\n type membersV1Member_universal_d_ListMembersRequest = ListMembersRequest;\n type membersV1Member_universal_d_Paging = Paging;\n type membersV1Member_universal_d_Sorting = Sorting;\n type membersV1Member_universal_d_SortOrder = SortOrder;\n const membersV1Member_universal_d_SortOrder: typeof SortOrder;\n type membersV1Member_universal_d_CursorPaging = CursorPaging;\n type membersV1Member_universal_d_ListMembersResponse = ListMembersResponse;\n type membersV1Member_universal_d_PagingMetadata = PagingMetadata;\n type membersV1Member_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type membersV1Member_universal_d_Cursors = Cursors;\n type membersV1Member_universal_d_QueryMembersRequest = QueryMembersRequest;\n type membersV1Member_universal_d_Search = Search;\n type membersV1Member_universal_d_QueryMembersResponse = QueryMembersResponse;\n type membersV1Member_universal_d_MuteMemberRequest = MuteMemberRequest;\n type membersV1Member_universal_d_MuteMemberResponse = MuteMemberResponse;\n type membersV1Member_universal_d_MemberMuted = MemberMuted;\n type membersV1Member_universal_d_UnmuteMemberRequest = UnmuteMemberRequest;\n type membersV1Member_universal_d_UnmuteMemberResponse = UnmuteMemberResponse;\n type membersV1Member_universal_d_MemberUnmuted = MemberUnmuted;\n type membersV1Member_universal_d_ApproveMemberRequest = ApproveMemberRequest;\n type membersV1Member_universal_d_ApproveMemberResponse = ApproveMemberResponse;\n type membersV1Member_universal_d_MemberApproved = MemberApproved;\n type membersV1Member_universal_d_BlockMemberRequest = BlockMemberRequest;\n type membersV1Member_universal_d_BlockMemberResponse = BlockMemberResponse;\n type membersV1Member_universal_d_MemberBlocked = MemberBlocked;\n type membersV1Member_universal_d_MemberSelfBlockForbiddenPayload = MemberSelfBlockForbiddenPayload;\n type membersV1Member_universal_d_OwnerMemberBlockForbiddenPayload = OwnerMemberBlockForbiddenPayload;\n type membersV1Member_universal_d_ActiveSubscriptionMemberBlockForbiddenPayload = ActiveSubscriptionMemberBlockForbiddenPayload;\n type membersV1Member_universal_d_DisconnectMemberRequest = DisconnectMemberRequest;\n type membersV1Member_universal_d_DisconnectMemberResponse = DisconnectMemberResponse;\n type membersV1Member_universal_d_DeleteMemberRequest = DeleteMemberRequest;\n type membersV1Member_universal_d_DeleteMemberResponse = DeleteMemberResponse;\n type membersV1Member_universal_d_ContentReassignmentRequested = ContentReassignmentRequested;\n type membersV1Member_universal_d_ContentDeletionRequested = ContentDeletionRequested;\n type membersV1Member_universal_d_OwnerOrContributorDeleteForbiddenPayload = OwnerOrContributorDeleteForbiddenPayload;\n type membersV1Member_universal_d_ActiveSubscriptionMemberDeleteForbiddenPayload = ActiveSubscriptionMemberDeleteForbiddenPayload;\n type membersV1Member_universal_d_DeleteMyMemberRequest = DeleteMyMemberRequest;\n type membersV1Member_universal_d_DeleteMyMemberResponse = DeleteMyMemberResponse;\n type membersV1Member_universal_d_BulkDeleteMembersRequest = BulkDeleteMembersRequest;\n type membersV1Member_universal_d_BulkDeleteMembersResponse = BulkDeleteMembersResponse;\n type membersV1Member_universal_d_ItemMetadata = ItemMetadata;\n type membersV1Member_universal_d_ApplicationError = ApplicationError;\n type membersV1Member_universal_d_BulkMemberResult = BulkMemberResult;\n type membersV1Member_universal_d_BulkActionMetadata = BulkActionMetadata;\n type membersV1Member_universal_d_BulkDeleteMembersByFilterRequest = BulkDeleteMembersByFilterRequest;\n type membersV1Member_universal_d_BulkDeleteMembersByFilterResponse = BulkDeleteMembersByFilterResponse;\n type membersV1Member_universal_d_BulkApproveMembersRequest = BulkApproveMembersRequest;\n type membersV1Member_universal_d_BulkApproveMembersResponse = BulkApproveMembersResponse;\n type membersV1Member_universal_d_BulkBlockMembersRequest = BulkBlockMembersRequest;\n type membersV1Member_universal_d_BulkBlockMembersResponse = BulkBlockMembersResponse;\n type membersV1Member_universal_d_CreateMemberRequest = CreateMemberRequest;\n type membersV1Member_universal_d_CreateMemberResponse = CreateMemberResponse;\n type membersV1Member_universal_d_UpdateMemberRequest = UpdateMemberRequest;\n type membersV1Member_universal_d_UpdateMemberResponse = UpdateMemberResponse;\n type membersV1Member_universal_d_InvalidCustomFieldUrlPayload = InvalidCustomFieldUrlPayload;\n type membersV1Member_universal_d_DeleteMemberPhonesRequest = DeleteMemberPhonesRequest;\n type membersV1Member_universal_d_DeleteMemberPhonesResponse = DeleteMemberPhonesResponse;\n type membersV1Member_universal_d_DeleteMemberEmailsRequest = DeleteMemberEmailsRequest;\n type membersV1Member_universal_d_DeleteMemberEmailsResponse = DeleteMemberEmailsResponse;\n type membersV1Member_universal_d_DeleteMemberAddressesRequest = DeleteMemberAddressesRequest;\n type membersV1Member_universal_d_DeleteMemberAddressesResponse = DeleteMemberAddressesResponse;\n type membersV1Member_universal_d_DomainEvent = DomainEvent;\n type membersV1Member_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type membersV1Member_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type membersV1Member_universal_d_RestoreInfo = RestoreInfo;\n type membersV1Member_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type membersV1Member_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type membersV1Member_universal_d_ActionEvent = ActionEvent;\n type membersV1Member_universal_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;\n type membersV1Member_universal_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;\n type membersV1Member_universal_d_Asset = Asset;\n type membersV1Member_universal_d_State = State;\n const membersV1Member_universal_d_State: typeof State;\n type membersV1Member_universal_d_SiteCreated = SiteCreated;\n type membersV1Member_universal_d_SiteCreatedContext = SiteCreatedContext;\n const membersV1Member_universal_d_SiteCreatedContext: typeof SiteCreatedContext;\n type membersV1Member_universal_d_Namespace = Namespace;\n const membersV1Member_universal_d_Namespace: typeof Namespace;\n type membersV1Member_universal_d_SiteTransferred = SiteTransferred;\n type membersV1Member_universal_d_SiteDeleted = SiteDeleted;\n type membersV1Member_universal_d_DeleteContext = DeleteContext;\n type membersV1Member_universal_d_DeleteStatus = DeleteStatus;\n const membersV1Member_universal_d_DeleteStatus: typeof DeleteStatus;\n type membersV1Member_universal_d_SiteUndeleted = SiteUndeleted;\n type membersV1Member_universal_d_SitePublished = SitePublished;\n type membersV1Member_universal_d_SiteUnpublished = SiteUnpublished;\n type membersV1Member_universal_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;\n type membersV1Member_universal_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;\n type membersV1Member_universal_d_ServiceProvisioned = ServiceProvisioned;\n type membersV1Member_universal_d_ServiceRemoved = ServiceRemoved;\n type membersV1Member_universal_d_SiteRenamed = SiteRenamed;\n type membersV1Member_universal_d_SiteHardDeleted = SiteHardDeleted;\n type membersV1Member_universal_d_NamespaceChanged = NamespaceChanged;\n type membersV1Member_universal_d_StudioAssigned = StudioAssigned;\n type membersV1Member_universal_d_StudioUnassigned = StudioUnassigned;\n type membersV1Member_universal_d_MemberOwnershipTransferred = MemberOwnershipTransferred;\n type membersV1Member_universal_d_MemberIdChanged = MemberIdChanged;\n type membersV1Member_universal_d_MessageEnvelope = MessageEnvelope;\n type membersV1Member_universal_d_IdentificationData = IdentificationData;\n type membersV1Member_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type membersV1Member_universal_d_WebhookIdentityType = WebhookIdentityType;\n const membersV1Member_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const membersV1Member_universal_d_updateCurrentMemberSlug: typeof updateCurrentMemberSlug;\n const membersV1Member_universal_d_updateMemberSlug: typeof updateMemberSlug;\n const membersV1Member_universal_d_joinCommunity: typeof joinCommunity;\n const membersV1Member_universal_d_leaveCommunity: typeof leaveCommunity;\n const membersV1Member_universal_d_getCurrentMember: typeof getCurrentMember;\n type membersV1Member_universal_d_GetCurrentMemberOptions = GetCurrentMemberOptions;\n const membersV1Member_universal_d_getMember: typeof getMember;\n type membersV1Member_universal_d_GetMemberOptions = GetMemberOptions;\n const membersV1Member_universal_d_listMembers: typeof listMembers;\n type membersV1Member_universal_d_ListMembersOptions = ListMembersOptions;\n const membersV1Member_universal_d_queryMembers: typeof queryMembers;\n type membersV1Member_universal_d_QueryMembersOptions = QueryMembersOptions;\n type membersV1Member_universal_d_MembersQueryResult = MembersQueryResult;\n type membersV1Member_universal_d_MembersQueryBuilder = MembersQueryBuilder;\n const membersV1Member_universal_d_muteMember: typeof muteMember;\n const membersV1Member_universal_d_unmuteMember: typeof unmuteMember;\n const membersV1Member_universal_d_approveMember: typeof approveMember;\n const membersV1Member_universal_d_blockMember: typeof blockMember;\n const membersV1Member_universal_d_disconnectMember: typeof disconnectMember;\n const membersV1Member_universal_d_deleteMember: typeof deleteMember;\n type membersV1Member_universal_d_DeleteMemberOptions = DeleteMemberOptions;\n const membersV1Member_universal_d_deleteMyMember: typeof deleteMyMember;\n type membersV1Member_universal_d_DeleteMyMemberOptions = DeleteMyMemberOptions;\n const membersV1Member_universal_d_bulkDeleteMembers: typeof bulkDeleteMembers;\n const membersV1Member_universal_d_bulkDeleteMembersByFilter: typeof bulkDeleteMembersByFilter;\n type membersV1Member_universal_d_BulkDeleteMembersByFilterOptions = BulkDeleteMembersByFilterOptions;\n const membersV1Member_universal_d_bulkApproveMembers: typeof bulkApproveMembers;\n const membersV1Member_universal_d_bulkBlockMembers: typeof bulkBlockMembers;\n const membersV1Member_universal_d_createMember: typeof createMember;\n type membersV1Member_universal_d_CreateMemberOptions = CreateMemberOptions;\n const membersV1Member_universal_d_updateMember: typeof updateMember;\n type membersV1Member_universal_d_UpdateMember = UpdateMember;\n const membersV1Member_universal_d_deleteMemberPhones: typeof deleteMemberPhones;\n const membersV1Member_universal_d_deleteMemberEmails: typeof deleteMemberEmails;\n const membersV1Member_universal_d_deleteMemberAddresses: typeof deleteMemberAddresses;\n namespace membersV1Member_universal_d {\n export {\n membersV1Member_universal_d_Member as Member,\n membersV1Member_universal_d_Status as Status,\n membersV1Member_universal_d_Contact as Contact,\n membersV1Member_universal_d_Address as Address,\n membersV1Member_universal_d_AddressStreetOneOf as AddressStreetOneOf,\n membersV1Member_universal_d_StreetAddress as StreetAddress,\n membersV1Member_universal_d_CustomField as CustomField,\n membersV1Member_universal_d_Profile as Profile,\n membersV1Member_universal_d_Image as Image,\n membersV1Member_universal_d_PrivacyStatusStatus as PrivacyStatusStatus,\n membersV1Member_universal_d_ActivityStatusStatus as ActivityStatusStatus,\n membersV1Member_universal_d_ExtendedFields as ExtendedFields,\n membersV1Member_universal_d_InvalidateCache as InvalidateCache,\n membersV1Member_universal_d_InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOf,\n membersV1Member_universal_d_App as App,\n membersV1Member_universal_d_Page as Page,\n membersV1Member_universal_d_URI as URI,\n membersV1Member_universal_d_File as File,\n membersV1Member_universal_d_UpdateMySlugRequest as UpdateMySlugRequest,\n membersV1Member_universal_d_UpdateMySlugResponse as UpdateMySlugResponse,\n membersV1Member_universal_d_SlugAlreadyExistsPayload as SlugAlreadyExistsPayload,\n membersV1Member_universal_d_UpdateMemberSlugRequest as UpdateMemberSlugRequest,\n membersV1Member_universal_d_UpdateMemberSlugResponse as UpdateMemberSlugResponse,\n membersV1Member_universal_d_JoinCommunityRequest as JoinCommunityRequest,\n membersV1Member_universal_d_JoinCommunityResponse as JoinCommunityResponse,\n membersV1Member_universal_d_MemberJoinedCommunity as MemberJoinedCommunity,\n membersV1Member_universal_d_LeaveCommunityRequest as LeaveCommunityRequest,\n membersV1Member_universal_d_LeaveCommunityResponse as LeaveCommunityResponse,\n membersV1Member_universal_d_MemberLeftCommunity as MemberLeftCommunity,\n membersV1Member_universal_d_GetMyMemberRequest as GetMyMemberRequest,\n membersV1Member_universal_d_Set as Set,\n membersV1Member_universal_d_GetMyMemberResponse as GetMyMemberResponse,\n membersV1Member_universal_d_GetMemberRequest as GetMemberRequest,\n membersV1Member_universal_d_GetMemberResponse as GetMemberResponse,\n membersV1Member_universal_d_MemberToMemberBlockedPayload as MemberToMemberBlockedPayload,\n membersV1Member_universal_d_ListMembersRequest as ListMembersRequest,\n membersV1Member_universal_d_Paging as Paging,\n membersV1Member_universal_d_Sorting as Sorting,\n membersV1Member_universal_d_SortOrder as SortOrder,\n membersV1Member_universal_d_CursorPaging as CursorPaging,\n membersV1Member_universal_d_ListMembersResponse as ListMembersResponse,\n membersV1Member_universal_d_PagingMetadata as PagingMetadata,\n membersV1Member_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n membersV1Member_universal_d_Cursors as Cursors,\n membersV1Member_universal_d_QueryMembersRequest as QueryMembersRequest,\n Query$1 as Query,\n membersV1Member_universal_d_Search as Search,\n membersV1Member_universal_d_QueryMembersResponse as QueryMembersResponse,\n membersV1Member_universal_d_MuteMemberRequest as MuteMemberRequest,\n membersV1Member_universal_d_MuteMemberResponse as MuteMemberResponse,\n membersV1Member_universal_d_MemberMuted as MemberMuted,\n membersV1Member_universal_d_UnmuteMemberRequest as UnmuteMemberRequest,\n membersV1Member_universal_d_UnmuteMemberResponse as UnmuteMemberResponse,\n membersV1Member_universal_d_MemberUnmuted as MemberUnmuted,\n membersV1Member_universal_d_ApproveMemberRequest as ApproveMemberRequest,\n membersV1Member_universal_d_ApproveMemberResponse as ApproveMemberResponse,\n membersV1Member_universal_d_MemberApproved as MemberApproved,\n membersV1Member_universal_d_BlockMemberRequest as BlockMemberRequest,\n membersV1Member_universal_d_BlockMemberResponse as BlockMemberResponse,\n membersV1Member_universal_d_MemberBlocked as MemberBlocked,\n membersV1Member_universal_d_MemberSelfBlockForbiddenPayload as MemberSelfBlockForbiddenPayload,\n membersV1Member_universal_d_OwnerMemberBlockForbiddenPayload as OwnerMemberBlockForbiddenPayload,\n membersV1Member_universal_d_ActiveSubscriptionMemberBlockForbiddenPayload as ActiveSubscriptionMemberBlockForbiddenPayload,\n membersV1Member_universal_d_DisconnectMemberRequest as DisconnectMemberRequest,\n membersV1Member_universal_d_DisconnectMemberResponse as DisconnectMemberResponse,\n membersV1Member_universal_d_DeleteMemberRequest as DeleteMemberRequest,\n membersV1Member_universal_d_DeleteMemberResponse as DeleteMemberResponse,\n membersV1Member_universal_d_ContentReassignmentRequested as ContentReassignmentRequested,\n membersV1Member_universal_d_ContentDeletionRequested as ContentDeletionRequested,\n membersV1Member_universal_d_OwnerOrContributorDeleteForbiddenPayload as OwnerOrContributorDeleteForbiddenPayload,\n membersV1Member_universal_d_ActiveSubscriptionMemberDeleteForbiddenPayload as ActiveSubscriptionMemberDeleteForbiddenPayload,\n membersV1Member_universal_d_DeleteMyMemberRequest as DeleteMyMemberRequest,\n membersV1Member_universal_d_DeleteMyMemberResponse as DeleteMyMemberResponse,\n membersV1Member_universal_d_BulkDeleteMembersRequest as BulkDeleteMembersRequest,\n membersV1Member_universal_d_BulkDeleteMembersResponse as BulkDeleteMembersResponse,\n membersV1Member_universal_d_ItemMetadata as ItemMetadata,\n membersV1Member_universal_d_ApplicationError as ApplicationError,\n membersV1Member_universal_d_BulkMemberResult as BulkMemberResult,\n membersV1Member_universal_d_BulkActionMetadata as BulkActionMetadata,\n membersV1Member_universal_d_BulkDeleteMembersByFilterRequest as BulkDeleteMembersByFilterRequest,\n membersV1Member_universal_d_BulkDeleteMembersByFilterResponse as BulkDeleteMembersByFilterResponse,\n membersV1Member_universal_d_BulkApproveMembersRequest as BulkApproveMembersRequest,\n membersV1Member_universal_d_BulkApproveMembersResponse as BulkApproveMembersResponse,\n membersV1Member_universal_d_BulkBlockMembersRequest as BulkBlockMembersRequest,\n membersV1Member_universal_d_BulkBlockMembersResponse as BulkBlockMembersResponse,\n membersV1Member_universal_d_CreateMemberRequest as CreateMemberRequest,\n membersV1Member_universal_d_CreateMemberResponse as CreateMemberResponse,\n membersV1Member_universal_d_UpdateMemberRequest as UpdateMemberRequest,\n membersV1Member_universal_d_UpdateMemberResponse as UpdateMemberResponse,\n membersV1Member_universal_d_InvalidCustomFieldUrlPayload as InvalidCustomFieldUrlPayload,\n membersV1Member_universal_d_DeleteMemberPhonesRequest as DeleteMemberPhonesRequest,\n membersV1Member_universal_d_DeleteMemberPhonesResponse as DeleteMemberPhonesResponse,\n membersV1Member_universal_d_DeleteMemberEmailsRequest as DeleteMemberEmailsRequest,\n membersV1Member_universal_d_DeleteMemberEmailsResponse as DeleteMemberEmailsResponse,\n membersV1Member_universal_d_DeleteMemberAddressesRequest as DeleteMemberAddressesRequest,\n membersV1Member_universal_d_DeleteMemberAddressesResponse as DeleteMemberAddressesResponse,\n Empty$1 as Empty,\n membersV1Member_universal_d_DomainEvent as DomainEvent,\n membersV1Member_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n membersV1Member_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n membersV1Member_universal_d_RestoreInfo as RestoreInfo,\n membersV1Member_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n membersV1Member_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n membersV1Member_universal_d_ActionEvent as ActionEvent,\n membersV1Member_universal_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent,\n membersV1Member_universal_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf,\n membersV1Member_universal_d_Asset as Asset,\n membersV1Member_universal_d_State as State,\n membersV1Member_universal_d_SiteCreated as SiteCreated,\n membersV1Member_universal_d_SiteCreatedContext as SiteCreatedContext,\n membersV1Member_universal_d_Namespace as Namespace,\n membersV1Member_universal_d_SiteTransferred as SiteTransferred,\n membersV1Member_universal_d_SiteDeleted as SiteDeleted,\n membersV1Member_universal_d_DeleteContext as DeleteContext,\n membersV1Member_universal_d_DeleteStatus as DeleteStatus,\n membersV1Member_universal_d_SiteUndeleted as SiteUndeleted,\n membersV1Member_universal_d_SitePublished as SitePublished,\n membersV1Member_universal_d_SiteUnpublished as SiteUnpublished,\n membersV1Member_universal_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate,\n membersV1Member_universal_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite,\n membersV1Member_universal_d_ServiceProvisioned as ServiceProvisioned,\n membersV1Member_universal_d_ServiceRemoved as ServiceRemoved,\n membersV1Member_universal_d_SiteRenamed as SiteRenamed,\n membersV1Member_universal_d_SiteHardDeleted as SiteHardDeleted,\n membersV1Member_universal_d_NamespaceChanged as NamespaceChanged,\n membersV1Member_universal_d_StudioAssigned as StudioAssigned,\n membersV1Member_universal_d_StudioUnassigned as StudioUnassigned,\n membersV1Member_universal_d_MemberOwnershipTransferred as MemberOwnershipTransferred,\n membersV1Member_universal_d_MemberIdChanged as MemberIdChanged,\n membersV1Member_universal_d_MessageEnvelope as MessageEnvelope,\n membersV1Member_universal_d_IdentificationData as IdentificationData,\n membersV1Member_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n membersV1Member_universal_d_WebhookIdentityType as WebhookIdentityType,\n membersV1Member_universal_d_updateCurrentMemberSlug as updateCurrentMemberSlug,\n membersV1Member_universal_d_updateMemberSlug as updateMemberSlug,\n membersV1Member_universal_d_joinCommunity as joinCommunity,\n membersV1Member_universal_d_leaveCommunity as leaveCommunity,\n membersV1Member_universal_d_getCurrentMember as getCurrentMember,\n membersV1Member_universal_d_GetCurrentMemberOptions as GetCurrentMemberOptions,\n membersV1Member_universal_d_getMember as getMember,\n membersV1Member_universal_d_GetMemberOptions as GetMemberOptions,\n membersV1Member_universal_d_listMembers as listMembers,\n membersV1Member_universal_d_ListMembersOptions as ListMembersOptions,\n membersV1Member_universal_d_queryMembers as queryMembers,\n membersV1Member_universal_d_QueryMembersOptions as QueryMembersOptions,\n membersV1Member_universal_d_MembersQueryResult as MembersQueryResult,\n membersV1Member_universal_d_MembersQueryBuilder as MembersQueryBuilder,\n membersV1Member_universal_d_muteMember as muteMember,\n membersV1Member_universal_d_unmuteMember as unmuteMember,\n membersV1Member_universal_d_approveMember as approveMember,\n membersV1Member_universal_d_blockMember as blockMember,\n membersV1Member_universal_d_disconnectMember as disconnectMember,\n membersV1Member_universal_d_deleteMember as deleteMember,\n membersV1Member_universal_d_DeleteMemberOptions as DeleteMemberOptions,\n membersV1Member_universal_d_deleteMyMember as deleteMyMember,\n membersV1Member_universal_d_DeleteMyMemberOptions as DeleteMyMemberOptions,\n membersV1Member_universal_d_bulkDeleteMembers as bulkDeleteMembers,\n membersV1Member_universal_d_bulkDeleteMembersByFilter as bulkDeleteMembersByFilter,\n membersV1Member_universal_d_BulkDeleteMembersByFilterOptions as BulkDeleteMembersByFilterOptions,\n membersV1Member_universal_d_bulkApproveMembers as bulkApproveMembers,\n membersV1Member_universal_d_bulkBlockMembers as bulkBlockMembers,\n membersV1Member_universal_d_createMember as createMember,\n membersV1Member_universal_d_CreateMemberOptions as CreateMemberOptions,\n membersV1Member_universal_d_updateMember as updateMember,\n membersV1Member_universal_d_UpdateMember as UpdateMember,\n membersV1Member_universal_d_deleteMemberPhones as deleteMemberPhones,\n membersV1Member_universal_d_deleteMemberEmails as deleteMemberEmails,\n membersV1Member_universal_d_deleteMemberAddresses as deleteMemberAddresses,\n };\n }\n \n interface Role {\n roleKey?: string;\n title?: string;\n }\n interface AssignRoleRequest {\n memberId: string;\n roleKey: string;\n }\n interface AssignRoleResponse {\n roleKey?: string;\n }\n interface UnassignRoleRequest {\n memberId: string;\n roleKey: string;\n }\n interface UnassignRoleResponse {\n roleKey?: string;\n }\n interface GetRolesRequest {\n memberId: string;\n }\n interface GetRolesResponse {\n roles?: Role[];\n }\n interface QueryRolesRequest {\n /** Query options. */\n query?: Query;\n }\n interface Query {\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?: any;\n }\n interface QueryRolesResponse {\n /** Map of members that met the query filter criteria. */\n rolesByMemberId?: Record;\n }\n interface MemberRole {\n roles?: Role[];\n }\n interface PolicyAssignedToContributor {\n accountId?: string;\n metaSiteId?: string;\n policyIds?: string[];\n }\n interface Empty {\n }\n interface PolicyRemovedFromContributor {\n accountId?: string;\n metaSiteId?: string;\n policyIds?: string[];\n }\n interface PolicyUpdatedForContributor {\n accountId?: string;\n metaSiteId?: string;\n oldPolicyIds?: string[];\n newPolicyIds?: string[];\n }\n /** @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @requiredField roleKey\n * @permissionId MEMBERS.MEMBER_ROLES_MANAGE\n */\n function assignRole(memberId: string, roleKey: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @requiredField roleKey\n * @permissionId MEMBERS.MEMBER_ROLES_MANAGE\n */\n function unassignRole(memberId: string, roleKey: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId MEMBERS.ROLES_READ\n */\n function getRoles(memberId: string): Promise;\n /** @public\n * @documentationMaturity preview\n * @permissionId MEMBERS.ROLES_READ\n */\n function queryRoles(options?: QueryRolesOptions): Promise;\n interface QueryRolesOptions {\n /** Query options. */\n query?: Query;\n }\n \n type membersV1Role_universal_d_Role = Role;\n type membersV1Role_universal_d_AssignRoleRequest = AssignRoleRequest;\n type membersV1Role_universal_d_AssignRoleResponse = AssignRoleResponse;\n type membersV1Role_universal_d_UnassignRoleRequest = UnassignRoleRequest;\n type membersV1Role_universal_d_UnassignRoleResponse = UnassignRoleResponse;\n type membersV1Role_universal_d_GetRolesRequest = GetRolesRequest;\n type membersV1Role_universal_d_GetRolesResponse = GetRolesResponse;\n type membersV1Role_universal_d_QueryRolesRequest = QueryRolesRequest;\n type membersV1Role_universal_d_Query = Query;\n type membersV1Role_universal_d_QueryRolesResponse = QueryRolesResponse;\n type membersV1Role_universal_d_MemberRole = MemberRole;\n type membersV1Role_universal_d_PolicyAssignedToContributor = PolicyAssignedToContributor;\n type membersV1Role_universal_d_Empty = Empty;\n type membersV1Role_universal_d_PolicyRemovedFromContributor = PolicyRemovedFromContributor;\n type membersV1Role_universal_d_PolicyUpdatedForContributor = PolicyUpdatedForContributor;\n const membersV1Role_universal_d_assignRole: typeof assignRole;\n const membersV1Role_universal_d_unassignRole: typeof unassignRole;\n const membersV1Role_universal_d_getRoles: typeof getRoles;\n const membersV1Role_universal_d_queryRoles: typeof queryRoles;\n type membersV1Role_universal_d_QueryRolesOptions = QueryRolesOptions;\n namespace membersV1Role_universal_d {\n export {\n membersV1Role_universal_d_Role as Role,\n membersV1Role_universal_d_AssignRoleRequest as AssignRoleRequest,\n membersV1Role_universal_d_AssignRoleResponse as AssignRoleResponse,\n membersV1Role_universal_d_UnassignRoleRequest as UnassignRoleRequest,\n membersV1Role_universal_d_UnassignRoleResponse as UnassignRoleResponse,\n membersV1Role_universal_d_GetRolesRequest as GetRolesRequest,\n membersV1Role_universal_d_GetRolesResponse as GetRolesResponse,\n membersV1Role_universal_d_QueryRolesRequest as QueryRolesRequest,\n membersV1Role_universal_d_Query as Query,\n membersV1Role_universal_d_QueryRolesResponse as QueryRolesResponse,\n membersV1Role_universal_d_MemberRole as MemberRole,\n membersV1Role_universal_d_PolicyAssignedToContributor as PolicyAssignedToContributor,\n membersV1Role_universal_d_Empty as Empty,\n membersV1Role_universal_d_PolicyRemovedFromContributor as PolicyRemovedFromContributor,\n membersV1Role_universal_d_PolicyUpdatedForContributor as PolicyUpdatedForContributor,\n membersV1Role_universal_d_assignRole as assignRole,\n membersV1Role_universal_d_unassignRole as unassignRole,\n membersV1Role_universal_d_getRoles as getRoles,\n membersV1Role_universal_d_queryRoles as queryRoles,\n membersV1Role_universal_d_QueryRolesOptions as QueryRolesOptions,\n };\n }\n \n export { identityMembersV1Member_universal_d as authentication, membersV1Role_universal_d as authorization, badgesV3Badge_universal_d as badges, membersV1Member_universal_d as members };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-groups.v2.d.ts", "content": "declare module \"wix-groups.v2\" {\n interface Group$1 {\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 /**\n * @internal\n * @internal\n * @deprecated\n */\n privacyLevel?: PrivacyStatus$1;\n /** Group privacy status. */\n privacyStatus?: PrivacyStatus$1;\n /** @internal */\n accessRestriction?: AccessRestriction$1;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group description in DraftJS format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n details?: GroupDetails$1;\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$1;\n /** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */\n settings?: GroupSettings$1;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n createdBy?: Identity$1;\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 * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n recentActivityDate?: 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 * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | null;\n }\n enum Type$1 {\n UNKNOWN = \"UNKNOWN\",\n ADMIN_APPROVAL = \"ADMIN_APPROVAL\",\n PAID_PLANS = \"PAID_PLANS\",\n EVENTS = \"EVENTS\"\n }\n interface Events$1 {\n eventIds?: string[];\n }\n interface Logo$1 {\n /** Logo image ID (for internal use). */\n mediaId?: string | null;\n /**\n * Logo image file URL.\n * @internal\n */\n fileUrl?: string | null;\n /** Logo image width. */\n width?: number | null;\n /** Logo image height. */\n height?: number | null;\n }\n interface GroupDetailsPosition$1 {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n interface Image$1 {\n /** Image ID (for internal use). */\n mediaId?: string | null;\n /**\n * Image file URL.\n * @internal\n */\n fileUrl?: 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$1 {\n /** horizontal coordinate */\n x?: number;\n /** vertical coordinate */\n y?: number;\n }\n enum AllowPolicy$1 {\n UNKNOWN = \"UNKNOWN\",\n OWNER_AND_ADMINS = \"OWNER_AND_ADMINS\",\n OWNER = \"OWNER\",\n ALL_MEMBERS = \"ALL_MEMBERS\"\n }\n interface OnboardingStepSettings$1 {\n stepKey?: StepKey$1;\n visible?: boolean;\n }\n enum StepKey$1 {\n UNKNOWN = \"UNKNOWN\",\n CREATE_POST = \"CREATE_POST\",\n REACT_TO_POST = \"REACT_TO_POST\",\n INVITE_MEMBERS = \"INVITE_MEMBERS\"\n }\n enum PrivacyStatus$1 {\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$1 extends AccessRestrictionDataOneOf$1 {\n events?: Events$1;\n type?: Type$1;\n }\n /** @oneof */\n interface AccessRestrictionDataOneOf$1 {\n events?: Events$1;\n }\n interface GroupDetails$1 {\n /** Group logo. You cannot upload your own logo. */\n logo?: Logo$1;\n /** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */\n membersTitle?: string | null;\n /**\n * Position of the corner of the cover image (or logo).\n * @internal\n */\n logoPosition?: GroupDetailsPosition$1;\n /**\n * Position of the corner of the cover image (or logo) for mobile browser.\n * @internal\n */\n mobileLogoPosition?: GroupDetailsPosition$1;\n }\n interface CoverImage$1 {\n /** Cover image. */\n image?: Image$1;\n /** Position of the corner of the cover image (or logo). */\n position?: Position$1;\n /** Position of the corner of the cover image (or logo) for mobile browser. */\n mobilePosition?: Position$1;\n }\n interface GroupSettings$1 {\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 /**\n * @internal\n * @internal\n * @deprecated\n */\n memberWelcomePostEnabled?: 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 /**\n * Whether an automatic post about added events is enabled.\n * @internal\n */\n eventAddedPostEnabled?: boolean | null;\n /**\n * Determines who can invite members to the group\n * @internal\n */\n allowedToInviteMembers?: AllowPolicy$1;\n /**\n * Determines who can approve member join requests to the group\n * @internal\n */\n allowedToApproveJoinRequests?: AllowPolicy$1;\n /**\n * Determines who can add site members to the group\n * @internal\n */\n allowedToAddMembers?: AllowPolicy$1;\n /**\n * Determines who can create posts in the group\n * @internal\n */\n allowedToCreatePosts?: AllowPolicy$1;\n /**\n * Determines who can comment posts in the group\n * @internal\n */\n allowedToCommentPosts?: AllowPolicy$1;\n /**\n * Onboarding step settings\n * @internal\n */\n onboardingStepsSettings?: OnboardingStepSettings$1[];\n /**\n * Determines who can create events in the group\n * @internal\n */\n allowedToCreateEvents?: AllowPolicy$1;\n }\n interface Identity$1 {\n /** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n _id?: string | null;\n identityType?: IdentityType$1;\n }\n enum IdentityType$1 {\n USER = \"USER\",\n MEMBER = \"MEMBER\"\n }\n interface CreateGroupRequest {\n /** Group to create. */\n group: Group$1;\n /** ID of the member who created the group. This member will automatically become an admin. */\n creatorId?: string | null;\n /**\n * Group ID.\n * @internal\n */\n groupId?: string | null;\n /** Content Type */\n contentType?: ContentType$1;\n }\n enum ContentType$1 {\n PLAIN_TEXT = \"PLAIN_TEXT\",\n DRAFTJS = \"DRAFTJS\",\n RICH_CONTENT = \"RICH_CONTENT\"\n }\n interface CreateGroupResponse {\n /** Created group. */\n group?: Group$1;\n }\n interface UpdateGroupRequest {\n /** Group to update. */\n group: Group$1;\n /** Content Type */\n contentType?: ContentType$1;\n }\n interface UpdateGroupResponse {\n /** Updated group. */\n group?: Group$1;\n }\n interface GroupCoverChanged {\n oldUrl?: string | null;\n newUrl?: string | null;\n }\n interface GroupDescriptionChanged {\n oldDescription?: string | null;\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$1;\n }\n interface GetGroupRequest {\n /** ID of the group to retrieve. */\n groupId: string;\n /**\n * ID of the auto invite to get hidden groups\n * @internal\n */\n autoInviteId?: string | null;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface GetGroupResponse {\n /** Retrieved group. */\n group?: Group$1;\n }\n interface GetGroupBySlugRequest {\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 /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface GetGroupBySlugResponse {\n /** Retrieved group. */\n group?: Group$1;\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 (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface ListGroupsResponse {\n /** Retrieved Groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n interface PagingMetadata$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. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListGroupsByUserIdRequest {\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface ListGroupsByUserIdResponse {\n groups?: GroupWithMsId[];\n }\n /** Retrieved Groups by metasite id */\n interface GroupWithMsId {\n metaSiteId?: string;\n groups?: Group$1[];\n }\n interface QueryGroupsRequest {\n query?: Query$3;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface Query$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?: any;\n /**\n * Sort object in the following format:\n * `[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`\n */\n sort?: Sorting$3[];\n /** Paging options to limit and skip the number of items. */\n paging?: Paging$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 interface Sorting$3 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$3;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$3 {\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 QueryGroupsResponse {\n /** Retrieved groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n interface QueryJoinedGroupsRequest {\n query?: Query$3;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface QueryJoinedGroupsResponse {\n /** Retrieved groups. */\n groups?: Group$1[];\n metadata?: PagingMetadata$4;\n }\n interface QueryGroupsByMembershipRequest {\n query?: Query$3;\n membershipStatus?: MembershipStatus$1;\n /** Filter groups by permissions. */\n permissionsFilter?: GroupPermissions;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n enum MembershipStatus$1 {\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$1[];\n metadata?: PagingMetadata$4;\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?: Query$3;\n /** ID of the member to find common groups with */\n memberId?: string;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n interface QueryJoinedGroupsWithMemberResponse {\n /** Retrieved groups. */\n groups?: Group$1[];\n /** Paging metadata. */\n metadata?: PagingMetadata$4;\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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$5;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$5 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface ActionEvent$5 {\n bodyAsJson?: string;\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 group.\n *\n *\n * The `createGroup()` function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.\n *\n * Site admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. If set to admin approval required, a site member uses this function to create a group, and the group becomes a `createRequest` with a status of `PENDING` until the group is reviewed. The default is set to site members with admin 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 */\n function createGroup(group: Group$1, options?: CreateGroupOptions): Promise;\n interface CreateGroupOptions {\n /** ID of the member who created the group. This member will automatically become an admin. */\n creatorId?: string | null;\n /**\n * Group ID.\n * @internal\n */\n groupId?: string | null;\n /** Content Type */\n contentType?: ContentType$1;\n }\n /**\n * Updates a group.\n *\n *\n * The `updateGroup()` function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.\n *\n * > **Notes:**\n *\n * - When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.\n * - When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.\n * - When a public or private group's name is updated, the slug is updated to reflect the new group name.\n * @param _id - Group ID.\n * @public\n * @requiredField _id\n * @requiredField group\n * @adminMethod\n * @returns Updated group.\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 /**\n * @internal\n * @deprecated\n */\n privacyLevel?: PrivacyStatus$1;\n /** Group privacy status. */\n privacyStatus?: PrivacyStatus$1;\n /** @internal */\n accessRestriction?: AccessRestriction$1;\n /**\n * @internal\n * @deprecated\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group description in DraftJS format. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * @internal\n * @deprecated\n */\n details?: GroupDetails$1;\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$1;\n /** Group specific settings. Available to the site owners under `Admin Tools` in the dashboard. */\n settings?: GroupSettings$1;\n /**\n * Total count of current group members.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * @internal\n * @readonly\n * @deprecated\n */\n createdBy?: Identity$1;\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 * @internal\n * @readonly\n * @deprecated\n */\n recentActivityDate?: 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 * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | null;\n }\n interface UpdateGroupOptions {\n /** Content Type */\n contentType?: ContentType$1;\n }\n /**\n * Deletes a group.\n *\n *\n * The `deleteGroup()` function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.\n *\n * @param groupId - ID of the group to delete.\n * @public\n * @requiredField groupId\n * @adminMethod\n */\n function deleteGroup(groupId: string): Promise;\n /**\n * Gets a group by ID.\n *\n *\n * The `getGroup()` function returns a Promise that resolves to a group whose ID matches the given ID.\n *\n * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a 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 */\n function getGroup(groupId: string, options?: GetGroupOptions): Promise;\n interface GetGroupOptions {\n /**\n * ID of the auto invite to get hidden groups\n * @internal\n */\n autoInviteId?: string | null;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n /**\n * Gets a group by slug.\n *\n *\n * The `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `https:/example.com/groups/{5D3yTX}`.\n *\n * > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.\n * @param slug - 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 * @public\n * @requiredField slug\n * @adminMethod\n */\n function getGroupBySlug(slug: string, options?: GetGroupBySlugOptions): Promise;\n interface GetGroupBySlugOptions {\n autoInviteId?: string | null;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n /**\n * Retrieves a group by slug.\n * @param slug - 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 * @internal\n * @documentationMaturity preview\n * @requiredField slug\n * @adminMethod\n */\n function getGroupIdBySlug(slug: string, options?: GetGroupIdBySlugOptions): Promise;\n interface GetGroupIdBySlugOptions {\n autoInviteId?: string | null;\n }\n /**\n * Lists groups.\n *\n *\n * The `listGroups()` function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to `_createdDate` in descending order.\n *\n * > **Notes:**\n *\n * - For `SECRET` groups, only site admins, group admins, and group members can see a list of group and their content.\n * - 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 */\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 (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n /**\n * Retrieves a list of all groups user is member of from all sites. Expects Wix User authorization.\n * Used in My Activity widget inside of Spaces App\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n * @deprecated\n */\n function listGroupsByUserId(options?: ListGroupsByUserIdOptions): Promise;\n interface ListGroupsByUserIdOptions {\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n /**\n * Creates a query to retrieve a list of groups.\n *\n *\n * Note: For `SECRET` groups, only site admins, group admins, and group members can query groups and their content.\n *\n * The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.\n * @public\n * @adminMethod\n */\n function queryGroups(options?: QueryGroupsOptions): GroupsQueryBuilder;\n interface QueryGroupsOptions {\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1 | undefined;\n }\n interface QueryOffsetResult$3 {\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$3 {\n items: Group$1[];\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: 'title', value: any) => GroupsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n */\n ne: (propertyName: 'title', 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: 'title', 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: 'title', value: any[]) => GroupsQueryBuilder;\n in: (propertyName: 'title', value: any) => GroupsQueryBuilder;\n exists: (propertyName: 'title', 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<'title' | 'membersCount' | '_createdDate' | 'recentActivityDate'>) => GroupsQueryBuilder;\n /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n descending: (...propertyNames: Array<'title' | 'membersCount' | '_createdDate' | 'recentActivityDate'>) => 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 /**\n * @internal\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n * @deprecated\n */\n function queryJoinedGroups(options?: QueryJoinedGroupsOptions): Promise;\n interface QueryJoinedGroupsOptions {\n query?: Query$3;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n /**\n * Retrieves groups by membership status for the current member.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryGroupsByMembership(options?: QueryGroupsByMembershipOptions): Promise;\n interface QueryGroupsByMembershipOptions {\n query?: Query$3;\n membershipStatus?: MembershipStatus$1;\n /** Filter groups by permissions. */\n permissionsFilter?: GroupPermissions;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n /**\n * Returns general data about integrations (e.g. counts of events or topics) for specified group ids\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listGroupIntegrationsData(options?: ListGroupIntegrationsDataOptions): Promise;\n interface ListGroupIntegrationsDataOptions {\n groupIds?: string[];\n }\n /** @param groupId - ID of the group to retrieve BM features.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function getGroupBmFeatures(groupId: string): Promise;\n /**\n * Retrieves groups that both the current member and specified member have joined.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryJoinedGroupsWithMember(options?: QueryJoinedGroupsWithMemberOptions): Promise;\n interface QueryJoinedGroupsWithMemberOptions {\n query?: Query$3;\n /** ID of the member to find common groups with */\n memberId?: string;\n /** Content type (PLAIN_TEXT returns content as it is) */\n contentType?: ContentType$1;\n }\n \n type socialGroupsV2Group_universal_d_CreateGroupRequest = CreateGroupRequest;\n type socialGroupsV2Group_universal_d_CreateGroupResponse = CreateGroupResponse;\n type socialGroupsV2Group_universal_d_UpdateGroupRequest = UpdateGroupRequest;\n type socialGroupsV2Group_universal_d_UpdateGroupResponse = UpdateGroupResponse;\n type socialGroupsV2Group_universal_d_GroupCoverChanged = GroupCoverChanged;\n type socialGroupsV2Group_universal_d_GroupDescriptionChanged = GroupDescriptionChanged;\n type socialGroupsV2Group_universal_d_DeleteGroupRequest = DeleteGroupRequest;\n type socialGroupsV2Group_universal_d_DeleteGroupResponse = DeleteGroupResponse;\n type socialGroupsV2Group_universal_d_GetGroupRequest = GetGroupRequest;\n type socialGroupsV2Group_universal_d_GetGroupResponse = GetGroupResponse;\n type socialGroupsV2Group_universal_d_GetGroupBySlugRequest = GetGroupBySlugRequest;\n type socialGroupsV2Group_universal_d_GetGroupBySlugResponse = GetGroupBySlugResponse;\n type socialGroupsV2Group_universal_d_GetGroupIdBySlugRequest = GetGroupIdBySlugRequest;\n type socialGroupsV2Group_universal_d_GetGroupIdBySlugResponse = GetGroupIdBySlugResponse;\n type socialGroupsV2Group_universal_d_GlobalFeedPermissions = GlobalFeedPermissions;\n type socialGroupsV2Group_universal_d_FeedPermissions = FeedPermissions;\n type socialGroupsV2Group_universal_d_FeedItemPermissions = FeedItemPermissions;\n type socialGroupsV2Group_universal_d_ListGroupsRequest = ListGroupsRequest;\n type socialGroupsV2Group_universal_d_ListGroupsResponse = ListGroupsResponse;\n type socialGroupsV2Group_universal_d_ListGroupsByUserIdRequest = ListGroupsByUserIdRequest;\n type socialGroupsV2Group_universal_d_ListGroupsByUserIdResponse = ListGroupsByUserIdResponse;\n type socialGroupsV2Group_universal_d_GroupWithMsId = GroupWithMsId;\n type socialGroupsV2Group_universal_d_QueryGroupsRequest = QueryGroupsRequest;\n type socialGroupsV2Group_universal_d_QueryGroupsResponse = QueryGroupsResponse;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsRequest = QueryJoinedGroupsRequest;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsResponse = QueryJoinedGroupsResponse;\n type socialGroupsV2Group_universal_d_QueryGroupsByMembershipRequest = QueryGroupsByMembershipRequest;\n type socialGroupsV2Group_universal_d_GroupPermissions = GroupPermissions;\n type socialGroupsV2Group_universal_d_QueryGroupsByMembershipResponse = QueryGroupsByMembershipResponse;\n type socialGroupsV2Group_universal_d_ListGroupIntegrationsDataRequest = ListGroupIntegrationsDataRequest;\n type socialGroupsV2Group_universal_d_ListGroupIntegrationsDataResponse = ListGroupIntegrationsDataResponse;\n type socialGroupsV2Group_universal_d_GroupIntegrationsData = GroupIntegrationsData;\n type socialGroupsV2Group_universal_d_GetGroupMembersGroupIdsRequest = GetGroupMembersGroupIdsRequest;\n type socialGroupsV2Group_universal_d_GetGroupMembersGroupIdsResponse = GetGroupMembersGroupIdsResponse;\n type socialGroupsV2Group_universal_d_GetGroupBMFeaturesRequest = GetGroupBMFeaturesRequest;\n type socialGroupsV2Group_universal_d_GetGroupBMFeaturesResponse = GetGroupBMFeaturesResponse;\n type socialGroupsV2Group_universal_d_BMFeatures = BMFeatures;\n type socialGroupsV2Group_universal_d_BMFeaturesBMFeatures = BMFeaturesBMFeatures;\n const socialGroupsV2Group_universal_d_BMFeaturesBMFeatures: typeof BMFeaturesBMFeatures;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsWithMemberRequest = QueryJoinedGroupsWithMemberRequest;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsWithMemberResponse = QueryJoinedGroupsWithMemberResponse;\n type socialGroupsV2Group_universal_d_GetPrivacyRequest = GetPrivacyRequest;\n type socialGroupsV2Group_universal_d_GetPrivacyResponse = GetPrivacyResponse;\n const socialGroupsV2Group_universal_d_createGroup: typeof createGroup;\n type socialGroupsV2Group_universal_d_CreateGroupOptions = CreateGroupOptions;\n const socialGroupsV2Group_universal_d_updateGroup: typeof updateGroup;\n type socialGroupsV2Group_universal_d_UpdateGroup = UpdateGroup;\n type socialGroupsV2Group_universal_d_UpdateGroupOptions = UpdateGroupOptions;\n const socialGroupsV2Group_universal_d_deleteGroup: typeof deleteGroup;\n const socialGroupsV2Group_universal_d_getGroup: typeof getGroup;\n type socialGroupsV2Group_universal_d_GetGroupOptions = GetGroupOptions;\n const socialGroupsV2Group_universal_d_getGroupBySlug: typeof getGroupBySlug;\n type socialGroupsV2Group_universal_d_GetGroupBySlugOptions = GetGroupBySlugOptions;\n const socialGroupsV2Group_universal_d_getGroupIdBySlug: typeof getGroupIdBySlug;\n type socialGroupsV2Group_universal_d_GetGroupIdBySlugOptions = GetGroupIdBySlugOptions;\n const socialGroupsV2Group_universal_d_listGroups: typeof listGroups;\n type socialGroupsV2Group_universal_d_ListGroupsOptions = ListGroupsOptions;\n const socialGroupsV2Group_universal_d_listGroupsByUserId: typeof listGroupsByUserId;\n type socialGroupsV2Group_universal_d_ListGroupsByUserIdOptions = ListGroupsByUserIdOptions;\n const socialGroupsV2Group_universal_d_queryGroups: typeof queryGroups;\n type socialGroupsV2Group_universal_d_QueryGroupsOptions = QueryGroupsOptions;\n type socialGroupsV2Group_universal_d_GroupsQueryResult = GroupsQueryResult;\n type socialGroupsV2Group_universal_d_GroupsQueryBuilder = GroupsQueryBuilder;\n const socialGroupsV2Group_universal_d_queryJoinedGroups: typeof queryJoinedGroups;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsOptions = QueryJoinedGroupsOptions;\n const socialGroupsV2Group_universal_d_queryGroupsByMembership: typeof queryGroupsByMembership;\n type socialGroupsV2Group_universal_d_QueryGroupsByMembershipOptions = QueryGroupsByMembershipOptions;\n const socialGroupsV2Group_universal_d_listGroupIntegrationsData: typeof listGroupIntegrationsData;\n type socialGroupsV2Group_universal_d_ListGroupIntegrationsDataOptions = ListGroupIntegrationsDataOptions;\n const socialGroupsV2Group_universal_d_getGroupBmFeatures: typeof getGroupBmFeatures;\n const socialGroupsV2Group_universal_d_queryJoinedGroupsWithMember: typeof queryJoinedGroupsWithMember;\n type socialGroupsV2Group_universal_d_QueryJoinedGroupsWithMemberOptions = QueryJoinedGroupsWithMemberOptions;\n namespace socialGroupsV2Group_universal_d {\n export {\n Group$1 as Group,\n Type$1 as Type,\n Events$1 as Events,\n Logo$1 as Logo,\n GroupDetailsPosition$1 as GroupDetailsPosition,\n Image$1 as Image,\n Position$1 as Position,\n AllowPolicy$1 as AllowPolicy,\n OnboardingStepSettings$1 as OnboardingStepSettings,\n StepKey$1 as StepKey,\n PrivacyStatus$1 as PrivacyStatus,\n AccessRestriction$1 as AccessRestriction,\n AccessRestrictionDataOneOf$1 as AccessRestrictionDataOneOf,\n GroupDetails$1 as GroupDetails,\n CoverImage$1 as CoverImage,\n GroupSettings$1 as GroupSettings,\n Identity$1 as Identity,\n IdentityType$1 as IdentityType,\n socialGroupsV2Group_universal_d_CreateGroupRequest as CreateGroupRequest,\n ContentType$1 as ContentType,\n socialGroupsV2Group_universal_d_CreateGroupResponse as CreateGroupResponse,\n socialGroupsV2Group_universal_d_UpdateGroupRequest as UpdateGroupRequest,\n socialGroupsV2Group_universal_d_UpdateGroupResponse as UpdateGroupResponse,\n socialGroupsV2Group_universal_d_GroupCoverChanged as GroupCoverChanged,\n socialGroupsV2Group_universal_d_GroupDescriptionChanged as GroupDescriptionChanged,\n socialGroupsV2Group_universal_d_DeleteGroupRequest as DeleteGroupRequest,\n socialGroupsV2Group_universal_d_DeleteGroupResponse as DeleteGroupResponse,\n socialGroupsV2Group_universal_d_GetGroupRequest as GetGroupRequest,\n socialGroupsV2Group_universal_d_GetGroupResponse as GetGroupResponse,\n socialGroupsV2Group_universal_d_GetGroupBySlugRequest as GetGroupBySlugRequest,\n socialGroupsV2Group_universal_d_GetGroupBySlugResponse as GetGroupBySlugResponse,\n socialGroupsV2Group_universal_d_GetGroupIdBySlugRequest as GetGroupIdBySlugRequest,\n socialGroupsV2Group_universal_d_GetGroupIdBySlugResponse as GetGroupIdBySlugResponse,\n socialGroupsV2Group_universal_d_GlobalFeedPermissions as GlobalFeedPermissions,\n socialGroupsV2Group_universal_d_FeedPermissions as FeedPermissions,\n socialGroupsV2Group_universal_d_FeedItemPermissions as FeedItemPermissions,\n socialGroupsV2Group_universal_d_ListGroupsRequest as ListGroupsRequest,\n socialGroupsV2Group_universal_d_ListGroupsResponse as ListGroupsResponse,\n PagingMetadata$4 as PagingMetadata,\n socialGroupsV2Group_universal_d_ListGroupsByUserIdRequest as ListGroupsByUserIdRequest,\n socialGroupsV2Group_universal_d_ListGroupsByUserIdResponse as ListGroupsByUserIdResponse,\n socialGroupsV2Group_universal_d_GroupWithMsId as GroupWithMsId,\n socialGroupsV2Group_universal_d_QueryGroupsRequest as QueryGroupsRequest,\n Query$3 as Query,\n Sorting$3 as Sorting,\n SortOrder$3 as SortOrder,\n Paging$4 as Paging,\n socialGroupsV2Group_universal_d_QueryGroupsResponse as QueryGroupsResponse,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsRequest as QueryJoinedGroupsRequest,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsResponse as QueryJoinedGroupsResponse,\n socialGroupsV2Group_universal_d_QueryGroupsByMembershipRequest as QueryGroupsByMembershipRequest,\n MembershipStatus$1 as MembershipStatus,\n socialGroupsV2Group_universal_d_GroupPermissions as GroupPermissions,\n socialGroupsV2Group_universal_d_QueryGroupsByMembershipResponse as QueryGroupsByMembershipResponse,\n socialGroupsV2Group_universal_d_ListGroupIntegrationsDataRequest as ListGroupIntegrationsDataRequest,\n socialGroupsV2Group_universal_d_ListGroupIntegrationsDataResponse as ListGroupIntegrationsDataResponse,\n socialGroupsV2Group_universal_d_GroupIntegrationsData as GroupIntegrationsData,\n socialGroupsV2Group_universal_d_GetGroupMembersGroupIdsRequest as GetGroupMembersGroupIdsRequest,\n socialGroupsV2Group_universal_d_GetGroupMembersGroupIdsResponse as GetGroupMembersGroupIdsResponse,\n socialGroupsV2Group_universal_d_GetGroupBMFeaturesRequest as GetGroupBMFeaturesRequest,\n socialGroupsV2Group_universal_d_GetGroupBMFeaturesResponse as GetGroupBMFeaturesResponse,\n socialGroupsV2Group_universal_d_BMFeatures as BMFeatures,\n socialGroupsV2Group_universal_d_BMFeaturesBMFeatures as BMFeaturesBMFeatures,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsWithMemberRequest as QueryJoinedGroupsWithMemberRequest,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsWithMemberResponse as QueryJoinedGroupsWithMemberResponse,\n socialGroupsV2Group_universal_d_GetPrivacyRequest as GetPrivacyRequest,\n socialGroupsV2Group_universal_d_GetPrivacyResponse as GetPrivacyResponse,\n DomainEvent$5 as DomainEvent,\n DomainEventBodyOneOf$5 as DomainEventBodyOneOf,\n EntityCreatedEvent$5 as EntityCreatedEvent,\n RestoreInfo$5 as RestoreInfo,\n EntityUpdatedEvent$5 as EntityUpdatedEvent,\n EntityDeletedEvent$5 as EntityDeletedEvent,\n ActionEvent$5 as ActionEvent,\n MessageEnvelope$5 as MessageEnvelope,\n IdentificationData$5 as IdentificationData,\n IdentificationDataIdOneOf$5 as IdentificationDataIdOneOf,\n WebhookIdentityType$5 as WebhookIdentityType,\n socialGroupsV2Group_universal_d_createGroup as createGroup,\n socialGroupsV2Group_universal_d_CreateGroupOptions as CreateGroupOptions,\n socialGroupsV2Group_universal_d_updateGroup as updateGroup,\n socialGroupsV2Group_universal_d_UpdateGroup as UpdateGroup,\n socialGroupsV2Group_universal_d_UpdateGroupOptions as UpdateGroupOptions,\n socialGroupsV2Group_universal_d_deleteGroup as deleteGroup,\n socialGroupsV2Group_universal_d_getGroup as getGroup,\n socialGroupsV2Group_universal_d_GetGroupOptions as GetGroupOptions,\n socialGroupsV2Group_universal_d_getGroupBySlug as getGroupBySlug,\n socialGroupsV2Group_universal_d_GetGroupBySlugOptions as GetGroupBySlugOptions,\n socialGroupsV2Group_universal_d_getGroupIdBySlug as getGroupIdBySlug,\n socialGroupsV2Group_universal_d_GetGroupIdBySlugOptions as GetGroupIdBySlugOptions,\n socialGroupsV2Group_universal_d_listGroups as listGroups,\n socialGroupsV2Group_universal_d_ListGroupsOptions as ListGroupsOptions,\n socialGroupsV2Group_universal_d_listGroupsByUserId as listGroupsByUserId,\n socialGroupsV2Group_universal_d_ListGroupsByUserIdOptions as ListGroupsByUserIdOptions,\n socialGroupsV2Group_universal_d_queryGroups as queryGroups,\n socialGroupsV2Group_universal_d_QueryGroupsOptions as QueryGroupsOptions,\n socialGroupsV2Group_universal_d_GroupsQueryResult as GroupsQueryResult,\n socialGroupsV2Group_universal_d_GroupsQueryBuilder as GroupsQueryBuilder,\n socialGroupsV2Group_universal_d_queryJoinedGroups as queryJoinedGroups,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsOptions as QueryJoinedGroupsOptions,\n socialGroupsV2Group_universal_d_queryGroupsByMembership as queryGroupsByMembership,\n socialGroupsV2Group_universal_d_QueryGroupsByMembershipOptions as QueryGroupsByMembershipOptions,\n socialGroupsV2Group_universal_d_listGroupIntegrationsData as listGroupIntegrationsData,\n socialGroupsV2Group_universal_d_ListGroupIntegrationsDataOptions as ListGroupIntegrationsDataOptions,\n socialGroupsV2Group_universal_d_getGroupBmFeatures as getGroupBmFeatures,\n socialGroupsV2Group_universal_d_queryJoinedGroupsWithMember as queryJoinedGroupsWithMember,\n socialGroupsV2Group_universal_d_QueryJoinedGroupsWithMemberOptions as QueryJoinedGroupsWithMemberOptions,\n };\n }\n \n interface GroupMember$1 {\n /**\n * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n siteMemberId?: string;\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 | null;\n /**\n * @internal\n * @readonly\n */\n contactId?: string | null;\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 /** 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 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$2[];\n autoInviteId?: string | null;\n }\n /** Answer to a membership question. */\n interface MembershipQuestionAnswer$2 {\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 * Type of join - can be either invite or clicking join button in the group.\n * @internal\n */\n joinBy?: JoinBy;\n /**\n * ID of the invite that was used to join the group. It can be empty if the member joined manually.\n * @internal\n */\n inviteId?: string | null;\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 * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /**\n * IDs of the site members to add to the group.\n *\n *\n */\n memberIds?: string[];\n /**\n * Whether to send invitations to private site members. Defaults to `true`.\n * @internal\n * @deprecated\n */\n invitePrivateMembers?: boolean | null;\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 /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: 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 * Return members who left groups (internal, used for history in analytics)\n * @internal\n * @deprecated\n * @targetRemovalDate 2024-05-28\n */\n includeDeleted?: boolean;\n }\n interface ListGroupMembersResponse {\n /** Retrieved members. */\n members?: GroupMember$1[];\n /** Paging information. */\n metadata?: PagingMetadata$3;\n }\n interface PagingMetadata$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. */\n total?: number | null;\n /** Flag that indicates the server failed to calculate the `total` field. */\n tooManyToCount?: boolean | 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 * @internal\n */\n hasNext?: 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$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 interface Sorting$2 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$2;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$2 {\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 QueryGroupMembersResponse {\n /** Group members. */\n members?: GroupMember$1[];\n /** Paging information. */\n metadata?: PagingMetadata$3;\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 /**\n * @internal\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberId?: string | null;\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$3;\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;\n /** Group member role. When membership status is not `JOINED`, this is empty. */\n role?: GroupRole$1;\n }\n enum MembershipStatus {\n /** Undefined membership status. */\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Site member is a group member. */\n JOINED = \"JOINED\",\n /** Site member has submitted a Join Request for this group that is still `PENDING`. */\n PENDING = \"PENDING\"\n }\n interface QueryMembershipsRequest {\n /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberId?: string | null;\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$3;\n }\n interface QueryMyMembershipRequest {\n query?: Query$2;\n }\n interface QueryMyMembershipResponse {\n /** Site member's memberships. */\n memberships?: Membership[];\n /** Paging information. */\n metadata?: PagingMetadata$3;\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 | 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$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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$4;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface RestoreInfo$4 {\n deletedDate?: Date | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$4 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Join a specific group.\n * Site owners can use it for groups with any privacy level and automatically receives `ADMIN` group role. A site member can use it only for public groups.\n * This endpoint doesn't support server signing.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function joinGroup(groupId: string, options?: JoinGroupOptions): Promise;\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$2[];\n autoInviteId?: string | null;\n }\n /**\n * Leave a group.\n * This endpoint doesn't support server signing.\n * @param groupId - ID of the Group to leave.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function leaveGroup(groupId: string): Promise;\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 * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /**\n * Whether to send invitations to private site members. Defaults to `true`.\n * @internal\n * @deprecated\n */\n invitePrivateMembers?: boolean | null;\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 * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\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 * Return members who left groups (internal, used for history in analytics)\n * @internal\n * @deprecated\n * @targetRemovalDate 2024-05-28\n */\n includeDeleted?: boolean;\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 /**\n * Don't expose to 3rd parties! (Use GroupMembersWithProfilesService.QueryNonGroupMembersWithProfiles)\n * @param groupId - Group ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n * @deprecated\n */\n function queryNonGroupMembers(groupId: string, options?: QueryNonGroupMembersOptions): Promise;\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 /**\n * @internal\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberId?: string | null;\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 /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberId?: string | null;\n query?: Query$2;\n }\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryMyMembership(options?: QueryMyMembershipOptions): Promise;\n interface QueryMyMembershipOptions {\n query?: Query$2;\n }\n \n type socialGroupsV2GroupMember_universal_d_JoinRequest = JoinRequest;\n type socialGroupsV2GroupMember_universal_d_JoinResponse = JoinResponse;\n type socialGroupsV2GroupMember_universal_d_MemberJoined = MemberJoined;\n type socialGroupsV2GroupMember_universal_d_JoinBy = JoinBy;\n const socialGroupsV2GroupMember_universal_d_JoinBy: typeof JoinBy;\n type socialGroupsV2GroupMember_universal_d_LeaveRequest = LeaveRequest;\n type socialGroupsV2GroupMember_universal_d_LeaveResponse = LeaveResponse;\n type socialGroupsV2GroupMember_universal_d_MemberLeft = MemberLeft;\n type socialGroupsV2GroupMember_universal_d_AddGroupMembersRequest = AddGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_AddGroupMembersResponse = AddGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_MemberAdded = MemberAdded;\n type socialGroupsV2GroupMember_universal_d_RemoveGroupMembersRequest = RemoveGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_RemoveGroupMembersResponse = RemoveGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_MemberRemoved = MemberRemoved;\n type socialGroupsV2GroupMember_universal_d_ListGroupMembersRequest = ListGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_ListGroupMembersResponse = ListGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_QueryGroupMembersRequest = QueryGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_QueryGroupMembersResponse = QueryGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersRequest = QueryNonGroupMembersRequest;\n type socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersResponse = QueryNonGroupMembersResponse;\n type socialGroupsV2GroupMember_universal_d_ListMembershipsRequest = ListMembershipsRequest;\n type socialGroupsV2GroupMember_universal_d_ListMembershipsResponse = ListMembershipsResponse;\n type socialGroupsV2GroupMember_universal_d_Membership = Membership;\n type socialGroupsV2GroupMember_universal_d_MembershipStatus = MembershipStatus;\n const socialGroupsV2GroupMember_universal_d_MembershipStatus: typeof MembershipStatus;\n type socialGroupsV2GroupMember_universal_d_QueryMembershipsRequest = QueryMembershipsRequest;\n type socialGroupsV2GroupMember_universal_d_QueryMembershipsResponse = QueryMembershipsResponse;\n type socialGroupsV2GroupMember_universal_d_QueryMyMembershipRequest = QueryMyMembershipRequest;\n type socialGroupsV2GroupMember_universal_d_QueryMyMembershipResponse = QueryMyMembershipResponse;\n const socialGroupsV2GroupMember_universal_d_joinGroup: typeof joinGroup;\n type socialGroupsV2GroupMember_universal_d_JoinGroupOptions = JoinGroupOptions;\n const socialGroupsV2GroupMember_universal_d_leaveGroup: typeof leaveGroup;\n const socialGroupsV2GroupMember_universal_d_addGroupMembers: typeof addGroupMembers;\n type socialGroupsV2GroupMember_universal_d_AddGroupMembersOptions = AddGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_removeGroupMembers: typeof removeGroupMembers;\n type socialGroupsV2GroupMember_universal_d_RemoveGroupMembersOptions = RemoveGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_listGroupMembers: typeof listGroupMembers;\n type socialGroupsV2GroupMember_universal_d_ListGroupMembersOptions = ListGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_queryGroupMembers: typeof queryGroupMembers;\n type socialGroupsV2GroupMember_universal_d_MembersQueryResult = MembersQueryResult;\n type socialGroupsV2GroupMember_universal_d_MembersQueryBuilder = MembersQueryBuilder;\n const socialGroupsV2GroupMember_universal_d_queryNonGroupMembers: typeof queryNonGroupMembers;\n type socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersOptions = QueryNonGroupMembersOptions;\n const socialGroupsV2GroupMember_universal_d_listMemberships: typeof listMemberships;\n type socialGroupsV2GroupMember_universal_d_ListMembershipsOptions = ListMembershipsOptions;\n const socialGroupsV2GroupMember_universal_d_queryMemberships: typeof queryMemberships;\n type socialGroupsV2GroupMember_universal_d_QueryMembershipsOptions = QueryMembershipsOptions;\n const socialGroupsV2GroupMember_universal_d_queryMyMembership: typeof queryMyMembership;\n type socialGroupsV2GroupMember_universal_d_QueryMyMembershipOptions = QueryMyMembershipOptions;\n namespace socialGroupsV2GroupMember_universal_d {\n export {\n GroupMember$1 as GroupMember,\n GroupRole$1 as GroupRole,\n Role$1 as Role,\n SocialGroupsEvent$1 as SocialGroupsEvent,\n SocialGroupsEventPayloadOneOf$1 as SocialGroupsEventPayloadOneOf,\n MemberJoinedGroup$1 as MemberJoinedGroup,\n MembersAddedToGroup$1 as MembersAddedToGroup,\n JoinRequestsApproved$1 as JoinRequestsApproved,\n MembersInvitedToGroup$1 as MembersInvitedToGroup,\n socialGroupsV2GroupMember_universal_d_JoinRequest as JoinRequest,\n MembershipQuestionAnswer$2 as MembershipQuestionAnswer,\n socialGroupsV2GroupMember_universal_d_JoinResponse as JoinResponse,\n socialGroupsV2GroupMember_universal_d_MemberJoined as MemberJoined,\n socialGroupsV2GroupMember_universal_d_JoinBy as JoinBy,\n socialGroupsV2GroupMember_universal_d_LeaveRequest as LeaveRequest,\n socialGroupsV2GroupMember_universal_d_LeaveResponse as LeaveResponse,\n socialGroupsV2GroupMember_universal_d_MemberLeft as MemberLeft,\n socialGroupsV2GroupMember_universal_d_AddGroupMembersRequest as AddGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_AddGroupMembersResponse as AddGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_MemberAdded as MemberAdded,\n socialGroupsV2GroupMember_universal_d_RemoveGroupMembersRequest as RemoveGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_RemoveGroupMembersResponse as RemoveGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_MemberRemoved as MemberRemoved,\n socialGroupsV2GroupMember_universal_d_ListGroupMembersRequest as ListGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_ListGroupMembersResponse as ListGroupMembersResponse,\n PagingMetadata$3 as PagingMetadata,\n socialGroupsV2GroupMember_universal_d_QueryGroupMembersRequest as QueryGroupMembersRequest,\n Query$2 as Query,\n Sorting$2 as Sorting,\n SortOrder$2 as SortOrder,\n Paging$3 as Paging,\n socialGroupsV2GroupMember_universal_d_QueryGroupMembersResponse as QueryGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersRequest as QueryNonGroupMembersRequest,\n socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersResponse as QueryNonGroupMembersResponse,\n socialGroupsV2GroupMember_universal_d_ListMembershipsRequest as ListMembershipsRequest,\n socialGroupsV2GroupMember_universal_d_ListMembershipsResponse as ListMembershipsResponse,\n socialGroupsV2GroupMember_universal_d_Membership as Membership,\n socialGroupsV2GroupMember_universal_d_MembershipStatus as MembershipStatus,\n socialGroupsV2GroupMember_universal_d_QueryMembershipsRequest as QueryMembershipsRequest,\n socialGroupsV2GroupMember_universal_d_QueryMembershipsResponse as QueryMembershipsResponse,\n socialGroupsV2GroupMember_universal_d_QueryMyMembershipRequest as QueryMyMembershipRequest,\n socialGroupsV2GroupMember_universal_d_QueryMyMembershipResponse as QueryMyMembershipResponse,\n DomainEvent$4 as DomainEvent,\n DomainEventBodyOneOf$4 as DomainEventBodyOneOf,\n EntityCreatedEvent$4 as EntityCreatedEvent,\n RestoreInfo$4 as RestoreInfo,\n EntityUpdatedEvent$4 as EntityUpdatedEvent,\n EntityDeletedEvent$4 as EntityDeletedEvent,\n ActionEvent$4 as ActionEvent,\n MessageEnvelope$4 as MessageEnvelope,\n IdentificationData$4 as IdentificationData,\n IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf,\n WebhookIdentityType$4 as WebhookIdentityType,\n socialGroupsV2GroupMember_universal_d_joinGroup as joinGroup,\n socialGroupsV2GroupMember_universal_d_JoinGroupOptions as JoinGroupOptions,\n socialGroupsV2GroupMember_universal_d_leaveGroup as leaveGroup,\n socialGroupsV2GroupMember_universal_d_addGroupMembers as addGroupMembers,\n socialGroupsV2GroupMember_universal_d_AddGroupMembersOptions as AddGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_removeGroupMembers as removeGroupMembers,\n socialGroupsV2GroupMember_universal_d_RemoveGroupMembersOptions as RemoveGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_listGroupMembers as listGroupMembers,\n socialGroupsV2GroupMember_universal_d_ListGroupMembersOptions as ListGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_queryGroupMembers as queryGroupMembers,\n socialGroupsV2GroupMember_universal_d_MembersQueryResult as MembersQueryResult,\n socialGroupsV2GroupMember_universal_d_MembersQueryBuilder as MembersQueryBuilder,\n socialGroupsV2GroupMember_universal_d_queryNonGroupMembers as queryNonGroupMembers,\n socialGroupsV2GroupMember_universal_d_QueryNonGroupMembersOptions as QueryNonGroupMembersOptions,\n socialGroupsV2GroupMember_universal_d_listMemberships as listMemberships,\n socialGroupsV2GroupMember_universal_d_ListMembershipsOptions as ListMembershipsOptions,\n socialGroupsV2GroupMember_universal_d_queryMemberships as queryMemberships,\n socialGroupsV2GroupMember_universal_d_QueryMembershipsOptions as QueryMembershipsOptions,\n socialGroupsV2GroupMember_universal_d_queryMyMembership as queryMyMembership,\n socialGroupsV2GroupMember_universal_d_QueryMyMembershipOptions as QueryMyMembershipOptions,\n };\n }\n \n /**\n * >**Notes:**\n * > + Site owners may set that members are not permitted to create groups in the Wix Groups application settings.\n * > + In this situation, site members have to submit a Group Request to create a new group.\n * > + Group Requests can be approved or rejected by an admin.\n * > + After a Group Request has been approved, the new group is added to the Group List in the Wix Groups app home page.\n * > + See [About Wix Groups](https://dev.wix.com/docs/rest/crm/community/groups/introduction) for more details.\n */\n interface GroupRequest {\n /**\n * ID of the request to create a group. Same as group ID.\n * @readonly\n */\n _id?: string | null;\n /** Group requested to create. */\n group?: Group;\n /**\n * Status of the request to create a group. One of:\n * - `\"PENDING\"` - Pending group request.\n * - `\"APPROVED\"` - Approved group request.\n * - `\"REJECTED\"` - Rejected group request.\n * - `\"CANCELED\"` - Canceled group request.\n */\n status?: RequestStatus$1;\n /** Details of request to create a group. */\n requestDetails?: RequestDetails$1;\n }\n interface Group {\n /**\n * Group ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Part of a group's URL.\n *\n * For example, `'https:/example.com/groups/{my-group-slug}'`. Generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `'https:/example.com/groups/{5D3yTX}'`. It is case-sensitive.\n */\n slug?: string | null;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n privacyLevel?: PrivacyStatus;\n /**\n * Group privacy status.\n * - `\"PUBLIC\"` - Site visitors can see the group and its content in the list of groups. Members can join the group.\n * - `\"PRIVATE\"` - Site visitors can see the group in the list of groups, but only site members can see its content. Members can request to join the group.\n * - `\"SECRET\"` - Only admins and group members can see the group and its content in the list of groups. Members can only join a group if invited by group admins, or other group members.\n */\n privacyStatus?: PrivacyStatus;\n /** @internal */\n accessRestriction?: AccessRestriction;\n /**\n * @interal\n * @interal\n * @deprecated\n */\n title?: string | null;\n /** Group name. */\n name?: string | null;\n /** Group Description. */\n description?: string | null;\n /** Group teaser. */\n teaser?: string | null;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n details?: GroupDetails;\n /**\n * What group members are called.\n *\n * For example, 'Coworkers', 'Friends', or 'Students'.\n */\n memberTitle?: string | null;\n /**\n * Group cover image. You cannot upload your own cover image.\n *\n */\n coverImage?: CoverImage;\n /** Group settings. */\n settings?: GroupSettings;\n /**\n * Total number of members in the group.\n * @readonly\n */\n membersCount?: number | null;\n /**\n * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n createdBy?: Identity;\n /**\n * Member ID of the group creator.\n * @readonly\n */\n ownerId?: string | null;\n /**\n * Date and time the group was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the group was last updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /**\n * @internal\n * @internal\n * @readonly\n * @deprecated\n */\n recentActivityDate?: Date | null;\n /**\n * Date and time the group was last active.\n *\n * For example, a post or comment made in the group.\n * @readonly\n */\n lastActivityDate?: Date | null;\n /**\n * Number of pending group members. Relevant only for `PRIVATE` groups.\n * @internal\n * @readonly\n */\n pendingMembersCount?: number | null;\n /**\n * Number of posts and comments in the group since the calling member last saw the group.\n * @internal\n * @readonly\n */\n updatesCount?: number | 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 /**\n * Logo image file URL.\n * @internal\n */\n fileUrl?: 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 /**\n * Image file URL.\n * @internal\n */\n fileUrl?: 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 * Position of the corner of the cover image (or logo).\n * @internal\n */\n logoPosition?: GroupDetailsPosition;\n /**\n * Position of the corner of the cover image (or logo) for mobile browser.\n * @internal\n */\n mobileLogoPosition?: GroupDetailsPosition;\n }\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 interface 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.\n *\n * Default: `false`\n * @deprecated\n */\n membersCanInvite?: boolean | null;\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 a group.\n *\n * Default: `false`\n * @deprecated\n */\n membersCanApprove?: boolean | null;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n memberWelcomePostEnabled?: boolean | null;\n /**\n * Whether to create a daily group post welcoming new members.\n *\n * Default: `true`\n */\n welcomeMemberPostEnabled?: boolean | null;\n /**\n * Whether to create an automatic group post when group details are changed.\n *\n * Default: `true`\n */\n groupDetailsChangedPostEnabled?: boolean | null;\n /**\n * Whether all group members can view the full list of group members.\n *\n * Default: `true`\n */\n showMemberList?: boolean | null;\n /**\n * Whether an automatic post about added events is enabled.\n * @internal\n */\n eventAddedPostEnabled?: boolean | null;\n /**\n * Determines who can invite members to the group\n * @internal\n */\n allowedToInviteMembers?: AllowPolicy;\n /**\n * Determines who can approve member join requests to the group\n * @internal\n */\n allowedToApproveJoinRequests?: AllowPolicy;\n /**\n * Determines who can add site members to the group\n * @internal\n */\n allowedToAddMembers?: AllowPolicy;\n /**\n * Determines who can create posts in the group\n * @internal\n */\n allowedToCreatePosts?: AllowPolicy;\n /**\n * Determines who can comment posts in the group\n * @internal\n */\n allowedToCommentPosts?: AllowPolicy;\n /**\n * Onboarding step settings\n * @internal\n */\n onboardingStepsSettings?: OnboardingStepSettings[];\n /**\n * Determines who can create events in the group\n * @internal\n */\n allowedToCreateEvents?: AllowPolicy;\n }\n interface Identity {\n /** Member ID of the group creator. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n _id?: string | null;\n identityType?: IdentityType;\n }\n enum IdentityType {\n USER = \"USER\",\n MEMBER = \"MEMBER\"\n }\n enum RequestStatus$1 {\n /** Undefined request status. */\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Pending group request. */\n PENDING = \"PENDING\",\n /** Approved group request. */\n APPROVED = \"APPROVED\",\n /** Rejected group request. */\n REJECTED = \"REJECTED\",\n /** Cancelled group request. */\n CANCELLED = \"CANCELLED\",\n /** Canceled group request. */\n CANCELED = \"CANCELED\"\n }\n interface RequestDetails$1 {\n /** Reason the request to create a group is rejected. */\n rejectionReason?: string | null;\n }\n interface SubmitGroupRequestRequest {\n /** Group submitted for creation. */\n group?: Group;\n /** Content type of group description. */\n contentType?: ContentType;\n }\n enum ContentType {\n PLAIN_TEXT = \"PLAIN_TEXT\",\n DRAFTJS = \"DRAFTJS\",\n RICH_CONTENT = \"RICH_CONTENT\"\n }\n interface SubmitGroupRequestResponse {\n /** Submitted Group Request. */\n groupRequest?: GroupRequest;\n }\n interface ApproveGroupRequestsRequest {\n /**\n * Which items to approve.\n * @internal\n * @deprecated\n */\n itemsToApprove?: ItemsToUpdate$1;\n /**\n * IDs of the requests create groups to approve.\n *\n * Max: 100 create group request IDs\n */\n groupRequestIds?: string[];\n }\n enum ItemsToUpdate$1 {\n /** Take into account only items which are listed in the request. */\n BY_ID = \"BY_ID\",\n /** Update all items. */\n ALL_ITEMS = \"ALL_ITEMS\"\n }\n interface ApproveGroupRequestsResponse {\n /** Approved request to create a group. */\n groupRequest?: GroupRequest[];\n }\n interface GroupRequestApproved {\n /** Approved group request. */\n groupRequest?: GroupRequest;\n }\n interface RejectGroupRequestsRequest {\n /**\n * Which items to reject.\n * @internal\n * @deprecated\n */\n itemsToReject?: ItemsToUpdate$1;\n /** Rejection data. */\n rejections?: Rejection$1[];\n }\n interface Rejection$1 {\n /**\n * ID of the requests to create groups to reject.\n *\n */\n groupRequestId?: string;\n /**\n * Reason the request to create a group is rejected. This text is displayed to the creator of the rejected request.\n *\n * Max: 1,000 characters.\n */\n reason?: string | null;\n }\n interface RejectGroupRequestsResponse {\n /** Rejected Group Requests. */\n groupRequest?: GroupRequest[];\n }\n interface GroupRequestRejected {\n /** Rejected group request. */\n groupRequest?: GroupRequest;\n }\n interface CancelGroupRequestRequest {\n /** ID of the Group Request to cancel. */\n groupRequestId: string;\n }\n interface CancelGroupRequestResponse {\n /** Canceled Group Request. */\n groupRequest?: GroupRequest;\n }\n interface ListGroupRequestsRequest {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All Group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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 }\n enum OwnershipFilter$1 {\n /** All items. */\n ALL = \"ALL\",\n /** Items for the current site member. */\n CURRENT_MEMBER = \"CURRENT_MEMBER\"\n }\n interface ListGroupRequestsResponse {\n /** List of requests to create a group. */\n groupRequests?: GroupRequest[];\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryGroupRequestsRequest {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\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$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$1 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder$1;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\n }\n enum SortOrder$1 {\n ASC = \"ASC\",\n DESC = \"DESC\"\n }\n interface Paging$2 {\n /**\n * Number of items to load.\n *\n * Max: `100`\n */\n limit?: number | null;\n /**\n * Number of items to skip in the current sort order.\n *\n */\n offset?: number | null;\n }\n interface QueryGroupRequestsResponse {\n /** Retrieved Group Requests. */\n groupRequests?: GroupRequest[];\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 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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$3;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$3 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Submit a group request.\n * Can be used in case `GroupsAppSettings.create_groups_policy` = `MEMBERS_WITH_APPROVAL`.\n * This endpoint doesn't support server signing.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function submitGroupRequest(options?: SubmitGroupRequestOptions): Promise;\n interface SubmitGroupRequestOptions {\n /** Group submitted for creation. */\n group?: Group;\n /** Content type of group description. */\n contentType?: ContentType;\n }\n /**\n * Approves requests to create a group.\n *\n * The `approveGroupRequests()` function returns a Promise that resolves when a site member's request to create a group is approved. Only site admins can approve requests to create a group. When the request is approved, the new group is added to the Groups List page of your site.\n *\n * >**Note:** This function is only relevant if admin approval is required for creating a group.\n * @param groupRequestIds - IDs of the requests create groups to approve.\n *\n * Max: 100 create group request IDs\n * @public\n * @documentationMaturity preview\n * @requiredField groupRequestIds\n * @adminMethod\n */\n function approveGroupRequests(groupRequestIds: string[], options?: ApproveGroupRequestsOptions): Promise;\n interface ApproveGroupRequestsOptions {\n /**\n * Which items to approve.\n * @internal\n * @deprecated\n */\n itemsToApprove?: ItemsToUpdate$1;\n }\n /**\n * Rejects a request to create a group.\n *\n * The `rejectGroupRequests()` function returns a Promise that resolves when a member's request to create a group is rejected. Only site admins can reject requests to create a group.\n *\n * >**Note:** This function is only relevant if admin approval is required for creating a group.\n * @param rejections - Rejection data.\n * @public\n * @documentationMaturity preview\n * @requiredField rejections\n * @adminMethod\n */\n function rejectGroupRequests(rejections: Rejection$1[], options?: RejectGroupRequestsOptions): Promise;\n interface RejectGroupRequestsOptions {\n /**\n * Which items to reject.\n * @internal\n * @deprecated\n */\n itemsToReject?: ItemsToUpdate$1;\n }\n /**\n * Cancels a Group Request.\n * Group managers always have access to this functionality. Site members can cancel their own group requests.\n * This endpoint doesn't support server signing.\n * @param groupRequestId - ID of the Group Request to cancel.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupRequestId\n * @adminMethod\n */\n function cancelGroupRequest(groupRequestId: string): Promise;\n /**\n * Lists requests to create a group.\n *\n * The `listGroupRequests()` function returns a Promise that resolves to a list of up to 1,000 create group requests on your site.\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 `_createdDate` in descending order. Only admins can see create group requests. Members can access their own create group requests in their site.\n *\n * >**Note:** This function is only relevant if admin approval is required for creating a group.\n *\n * @public\n * @documentationMaturity preview\n * @param options - Paging options.\n * @adminMethod\n */\n function listGroupRequests(options?: ListGroupRequestsOptions): Promise;\n interface ListGroupRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All Group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1;\n /**\n * Number of items to load.\n *\n * Max: `100`\n *\n */\n limit?: number | null;\n /** Number of items to skip in the current sort order. */\n offset?: number | null;\n }\n /**\n * Creates a query to retrieve a list of create requests.\n *\n * The `queryGroupRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a `GroupRequestsQueryBuilder` object.\n *\n * The returned object contains the query definition which is typically used to run the query using the [`find()`](/group-requests-query-builder/find) function. You can refine the query by chaining `GroupRequestQueryBuilder` functions onto the query. `GroupRequestQueryBuilder` functions enable you to sort, filter, and control the results that `queryGroupRequests()` returns.\n *\n * `queryGorupRequests()` runs with these `GroupRequestsQueryBuilder` defaults, which you can override:\n * - [`limit(1000)`](/group-requests-query-builder/limit)\n * - [`descending('_createdDate')`](/group-requests-query-builder/descending)\n *\n * The following `GroupRequestsQueryBuilder` functions are supported for `queryGroupRequests()`. For a full description of the `GroupRequests` object, see the object returned for the [`items`](/group-requests-query-result/items) property in `GroupRequestsQueryResult`.\n * @public\n * @documentationMaturity preview\n * @adminMethod\n */\n function queryGroupRequests(options?: QueryGroupRequestsOptions): GroupRequestsQueryBuilder;\n interface QueryGroupRequestsOptions {\n /**\n * Ownership filter. In case of server signing `ALL` value has to be used.\n * - `ALL` - All group requests.\n * - `CURRENT_MEMBER` - Group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter$1 | 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 GroupRequestsQueryResult extends QueryOffsetResult$1 {\n items: GroupRequest[];\n query: GroupRequestsQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface GroupRequestsQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'status', value: any) => GroupRequestsQueryBuilder;\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n ne: (propertyName: 'status', value: any) => GroupRequestsQueryBuilder;\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: 'status', value: any[]) => GroupRequestsQueryBuilder;\n /** @documentationMaturity preview */\n in: (propertyName: 'status', value: any) => GroupRequestsQueryBuilder;\n /** @documentationMaturity preview */\n exists: (propertyName: 'status', value: boolean) => GroupRequestsQueryBuilder;\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) => GroupRequestsQueryBuilder;\n /** @param skip - Number of items to skip in the query results before returning the results.\n * @documentationMaturity preview\n */\n skip: (skip: number) => GroupRequestsQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n \n type socialGroupsV2GroupRequest_universal_d_GroupRequest = GroupRequest;\n type socialGroupsV2GroupRequest_universal_d_Group = Group;\n type socialGroupsV2GroupRequest_universal_d_Type = Type;\n const socialGroupsV2GroupRequest_universal_d_Type: typeof Type;\n type socialGroupsV2GroupRequest_universal_d_Events = Events;\n type socialGroupsV2GroupRequest_universal_d_Logo = Logo;\n type socialGroupsV2GroupRequest_universal_d_GroupDetailsPosition = GroupDetailsPosition;\n type socialGroupsV2GroupRequest_universal_d_Image = Image;\n type socialGroupsV2GroupRequest_universal_d_Position = Position;\n type socialGroupsV2GroupRequest_universal_d_AllowPolicy = AllowPolicy;\n const socialGroupsV2GroupRequest_universal_d_AllowPolicy: typeof AllowPolicy;\n type socialGroupsV2GroupRequest_universal_d_OnboardingStepSettings = OnboardingStepSettings;\n type socialGroupsV2GroupRequest_universal_d_StepKey = StepKey;\n const socialGroupsV2GroupRequest_universal_d_StepKey: typeof StepKey;\n type socialGroupsV2GroupRequest_universal_d_PrivacyStatus = PrivacyStatus;\n const socialGroupsV2GroupRequest_universal_d_PrivacyStatus: typeof PrivacyStatus;\n type socialGroupsV2GroupRequest_universal_d_AccessRestriction = AccessRestriction;\n type socialGroupsV2GroupRequest_universal_d_AccessRestrictionDataOneOf = AccessRestrictionDataOneOf;\n type socialGroupsV2GroupRequest_universal_d_GroupDetails = GroupDetails;\n type socialGroupsV2GroupRequest_universal_d_CoverImage = CoverImage;\n type socialGroupsV2GroupRequest_universal_d_GroupSettings = GroupSettings;\n type socialGroupsV2GroupRequest_universal_d_Identity = Identity;\n type socialGroupsV2GroupRequest_universal_d_IdentityType = IdentityType;\n const socialGroupsV2GroupRequest_universal_d_IdentityType: typeof IdentityType;\n type socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestRequest = SubmitGroupRequestRequest;\n type socialGroupsV2GroupRequest_universal_d_ContentType = ContentType;\n const socialGroupsV2GroupRequest_universal_d_ContentType: typeof ContentType;\n type socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestResponse = SubmitGroupRequestResponse;\n type socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsRequest = ApproveGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsResponse = ApproveGroupRequestsResponse;\n type socialGroupsV2GroupRequest_universal_d_GroupRequestApproved = GroupRequestApproved;\n type socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsRequest = RejectGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsResponse = RejectGroupRequestsResponse;\n type socialGroupsV2GroupRequest_universal_d_GroupRequestRejected = GroupRequestRejected;\n type socialGroupsV2GroupRequest_universal_d_CancelGroupRequestRequest = CancelGroupRequestRequest;\n type socialGroupsV2GroupRequest_universal_d_CancelGroupRequestResponse = CancelGroupRequestResponse;\n type socialGroupsV2GroupRequest_universal_d_ListGroupRequestsRequest = ListGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_ListGroupRequestsResponse = ListGroupRequestsResponse;\n type socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsRequest = QueryGroupRequestsRequest;\n type socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsResponse = QueryGroupRequestsResponse;\n const socialGroupsV2GroupRequest_universal_d_submitGroupRequest: typeof submitGroupRequest;\n type socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestOptions = SubmitGroupRequestOptions;\n const socialGroupsV2GroupRequest_universal_d_approveGroupRequests: typeof approveGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsOptions = ApproveGroupRequestsOptions;\n const socialGroupsV2GroupRequest_universal_d_rejectGroupRequests: typeof rejectGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsOptions = RejectGroupRequestsOptions;\n const socialGroupsV2GroupRequest_universal_d_cancelGroupRequest: typeof cancelGroupRequest;\n const socialGroupsV2GroupRequest_universal_d_listGroupRequests: typeof listGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_ListGroupRequestsOptions = ListGroupRequestsOptions;\n const socialGroupsV2GroupRequest_universal_d_queryGroupRequests: typeof queryGroupRequests;\n type socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsOptions = QueryGroupRequestsOptions;\n type socialGroupsV2GroupRequest_universal_d_GroupRequestsQueryResult = GroupRequestsQueryResult;\n type socialGroupsV2GroupRequest_universal_d_GroupRequestsQueryBuilder = GroupRequestsQueryBuilder;\n namespace socialGroupsV2GroupRequest_universal_d {\n export {\n socialGroupsV2GroupRequest_universal_d_GroupRequest as GroupRequest,\n socialGroupsV2GroupRequest_universal_d_Group as Group,\n socialGroupsV2GroupRequest_universal_d_Type as Type,\n socialGroupsV2GroupRequest_universal_d_Events as Events,\n socialGroupsV2GroupRequest_universal_d_Logo as Logo,\n socialGroupsV2GroupRequest_universal_d_GroupDetailsPosition as GroupDetailsPosition,\n socialGroupsV2GroupRequest_universal_d_Image as Image,\n socialGroupsV2GroupRequest_universal_d_Position as Position,\n socialGroupsV2GroupRequest_universal_d_AllowPolicy as AllowPolicy,\n socialGroupsV2GroupRequest_universal_d_OnboardingStepSettings as OnboardingStepSettings,\n socialGroupsV2GroupRequest_universal_d_StepKey as StepKey,\n socialGroupsV2GroupRequest_universal_d_PrivacyStatus as PrivacyStatus,\n socialGroupsV2GroupRequest_universal_d_AccessRestriction as AccessRestriction,\n socialGroupsV2GroupRequest_universal_d_AccessRestrictionDataOneOf as AccessRestrictionDataOneOf,\n socialGroupsV2GroupRequest_universal_d_GroupDetails as GroupDetails,\n socialGroupsV2GroupRequest_universal_d_CoverImage as CoverImage,\n socialGroupsV2GroupRequest_universal_d_GroupSettings as GroupSettings,\n socialGroupsV2GroupRequest_universal_d_Identity as Identity,\n socialGroupsV2GroupRequest_universal_d_IdentityType as IdentityType,\n RequestStatus$1 as RequestStatus,\n RequestDetails$1 as RequestDetails,\n socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestRequest as SubmitGroupRequestRequest,\n socialGroupsV2GroupRequest_universal_d_ContentType as ContentType,\n socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestResponse as SubmitGroupRequestResponse,\n socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsRequest as ApproveGroupRequestsRequest,\n ItemsToUpdate$1 as ItemsToUpdate,\n socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsResponse as ApproveGroupRequestsResponse,\n socialGroupsV2GroupRequest_universal_d_GroupRequestApproved as GroupRequestApproved,\n socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsRequest as RejectGroupRequestsRequest,\n Rejection$1 as Rejection,\n socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsResponse as RejectGroupRequestsResponse,\n socialGroupsV2GroupRequest_universal_d_GroupRequestRejected as GroupRequestRejected,\n socialGroupsV2GroupRequest_universal_d_CancelGroupRequestRequest as CancelGroupRequestRequest,\n socialGroupsV2GroupRequest_universal_d_CancelGroupRequestResponse as CancelGroupRequestResponse,\n socialGroupsV2GroupRequest_universal_d_ListGroupRequestsRequest as ListGroupRequestsRequest,\n OwnershipFilter$1 as OwnershipFilter,\n socialGroupsV2GroupRequest_universal_d_ListGroupRequestsResponse as ListGroupRequestsResponse,\n PagingMetadata$2 as PagingMetadata,\n socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsRequest as QueryGroupRequestsRequest,\n Query$1 as Query,\n Sorting$1 as Sorting,\n SortOrder$1 as SortOrder,\n Paging$2 as Paging,\n socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsResponse as QueryGroupRequestsResponse,\n DomainEvent$3 as DomainEvent,\n DomainEventBodyOneOf$3 as DomainEventBodyOneOf,\n EntityCreatedEvent$3 as EntityCreatedEvent,\n RestoreInfo$3 as RestoreInfo,\n EntityUpdatedEvent$3 as EntityUpdatedEvent,\n EntityDeletedEvent$3 as EntityDeletedEvent,\n ActionEvent$3 as ActionEvent,\n MessageEnvelope$3 as MessageEnvelope,\n IdentificationData$3 as IdentificationData,\n IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf,\n WebhookIdentityType$3 as WebhookIdentityType,\n socialGroupsV2GroupRequest_universal_d_submitGroupRequest as submitGroupRequest,\n socialGroupsV2GroupRequest_universal_d_SubmitGroupRequestOptions as SubmitGroupRequestOptions,\n socialGroupsV2GroupRequest_universal_d_approveGroupRequests as approveGroupRequests,\n socialGroupsV2GroupRequest_universal_d_ApproveGroupRequestsOptions as ApproveGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_rejectGroupRequests as rejectGroupRequests,\n socialGroupsV2GroupRequest_universal_d_RejectGroupRequestsOptions as RejectGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_cancelGroupRequest as cancelGroupRequest,\n socialGroupsV2GroupRequest_universal_d_listGroupRequests as listGroupRequests,\n socialGroupsV2GroupRequest_universal_d_ListGroupRequestsOptions as ListGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_queryGroupRequests as queryGroupRequests,\n socialGroupsV2GroupRequest_universal_d_QueryGroupRequestsOptions as QueryGroupRequestsOptions,\n socialGroupsV2GroupRequest_universal_d_GroupRequestsQueryResult as GroupRequestsQueryResult,\n socialGroupsV2GroupRequest_universal_d_GroupRequestsQueryBuilder as GroupRequestsQueryBuilder,\n };\n }\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 /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /**\n * Member IDs.\n *\n * Max: 100 member IDs\n */\n memberIds?: string[];\n /** Role to assign. */\n role?: GroupRole;\n }\n interface AssignRoleResponse {\n /** Group ID. */\n groupId?: string;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /** Member IDs */\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 * __Deprecated.__ Use `memberId` instead.\n * This property will be removed on June 30, 2022.\n * @readonly\n * @deprecated\n */\n siteMemberId?: string;\n /**\n * Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) 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 * @internal\n * @readonly\n */\n contactId?: string | null;\n }\n interface UnassignRoleRequest {\n /** Group ID. */\n groupId: string;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /**\n * Member IDs.\n *\n * Max: 100 member IDs\n */\n memberIds?: string[];\n /** Role to unassign. */\n role?: GroupRole;\n }\n interface UnassignRoleResponse {\n /** Group ID. */\n groupId?: string;\n /**\n * @internal\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n /** Member IDs. */\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 *\n * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.\n *\n * The `assignRole()` function returns a Promise that resolves to the newly-assigned role after it has successfully been assigned. Assigning a role overrides an existing role. For example, assigning a member role to an admin unassigned their admin role.\n * @param groupId - Group ID.\n * @param memberIds - Member IDs.\n *\n * Max: 100 member IDs\n * @param role - Role to assign.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @requiredField role\n * @adminMethod\n */\n function assignRole(groupId: string, memberIds: string[], role: GroupRole, options?: AssignRoleOptions): Promise;\n interface AssignRoleOptions {\n /**\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n }\n /**\n * Unassigns a role from group members.\n *\n * >**Note:** This function is only relevant for site admins, and group members with group admin permissions.\n *\n * The `unassignRole()` function returns a Promise that resolves to the unassigned role after it has successfully been unassigned. This function only applies to admin roles. Using this function with member roles returns an error.\n * @param groupId - Group ID.\n * @param memberIds - Member IDs.\n *\n * Max: 100 member IDs\n * @param role - Role to unassign.\n * @public\n * @requiredField groupId\n * @requiredField memberIds\n * @requiredField role\n * @adminMethod\n */\n function unassignRole(groupId: string, memberIds: string[], role: GroupRole, options?: UnassignRoleOptions): Promise;\n interface UnassignRoleOptions {\n /**\n * @internal\n * @deprecated\n */\n siteMemberIds?: string[];\n }\n \n type socialGroupsV2GroupRole_universal_d_GroupRole = GroupRole;\n type socialGroupsV2GroupRole_universal_d_Role = Role;\n const socialGroupsV2GroupRole_universal_d_Role: typeof Role;\n type socialGroupsV2GroupRole_universal_d_AssignRoleRequest = AssignRoleRequest;\n type socialGroupsV2GroupRole_universal_d_AssignRoleResponse = AssignRoleResponse;\n type socialGroupsV2GroupRole_universal_d_RoleAssignedToGroupMember = RoleAssignedToGroupMember;\n type socialGroupsV2GroupRole_universal_d_GroupMember = GroupMember;\n type socialGroupsV2GroupRole_universal_d_UnassignRoleRequest = UnassignRoleRequest;\n type socialGroupsV2GroupRole_universal_d_UnassignRoleResponse = UnassignRoleResponse;\n type socialGroupsV2GroupRole_universal_d_RoleUnassignedFromGroupMember = RoleUnassignedFromGroupMember;\n const socialGroupsV2GroupRole_universal_d_assignRole: typeof assignRole;\n type socialGroupsV2GroupRole_universal_d_AssignRoleOptions = AssignRoleOptions;\n const socialGroupsV2GroupRole_universal_d_unassignRole: typeof unassignRole;\n type socialGroupsV2GroupRole_universal_d_UnassignRoleOptions = UnassignRoleOptions;\n namespace socialGroupsV2GroupRole_universal_d {\n export {\n socialGroupsV2GroupRole_universal_d_GroupRole as GroupRole,\n socialGroupsV2GroupRole_universal_d_Role as Role,\n socialGroupsV2GroupRole_universal_d_AssignRoleRequest as AssignRoleRequest,\n socialGroupsV2GroupRole_universal_d_AssignRoleResponse as AssignRoleResponse,\n socialGroupsV2GroupRole_universal_d_RoleAssignedToGroupMember as RoleAssignedToGroupMember,\n socialGroupsV2GroupRole_universal_d_GroupMember as GroupMember,\n socialGroupsV2GroupRole_universal_d_UnassignRoleRequest as UnassignRoleRequest,\n socialGroupsV2GroupRole_universal_d_UnassignRoleResponse as UnassignRoleResponse,\n socialGroupsV2GroupRole_universal_d_RoleUnassignedFromGroupMember as RoleUnassignedFromGroupMember,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n socialGroupsV2GroupRole_universal_d_assignRole as assignRole,\n socialGroupsV2GroupRole_universal_d_AssignRoleOptions as AssignRoleOptions,\n socialGroupsV2GroupRole_universal_d_unassignRole as unassignRole,\n socialGroupsV2GroupRole_universal_d_UnassignRoleOptions as UnassignRoleOptions,\n };\n }\n \n /**\n * Guidelines ensuring that members post responsibly and respectfully. Site owners can set up Group Rules in the dashboard.\n * >**Note:** Only admins can update the group rules.\n */\n interface GroupRules {\n /** Group rules. */\n rules?: GroupRule[];\n }\n interface GroupRule {\n /** Rule title. */\n title?: string;\n /** Rule description. */\n description?: string;\n }\n interface ListRulesRequest {\n /** Group ID. */\n groupId: string;\n }\n interface ListRulesResponse {\n /** Retrieved rules. */\n rules?: GroupRule[];\n }\n interface CreateOrReplaceAllRulesRequest {\n /** Group ID. */\n groupId: string;\n /** New rules. */\n rules?: GroupRule[];\n }\n interface CreateOrReplaceAllRulesResponse {\n /** Group ID. */\n groupId?: string;\n /** Rules. */\n rules?: GroupRule[];\n }\n interface Empty {\n }\n interface ListTemplatesResponse {\n /** Retrieved rule templates. */\n rules?: GroupRule[];\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 rules.\n *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function listRules(groupId: string): Promise;\n /**\n * Creates rules if no rules have been set up. Otherwise, replaces all existing rules.\n * > **Note:** Only admins can create or replace rules.\n *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function createOrReplaceAllRules(groupId: string, options?: CreateOrReplaceAllRulesOptions): Promise;\n interface CreateOrReplaceAllRulesOptions {\n /** New rules. */\n rules?: GroupRule[];\n }\n /**\n * Retrieves the rule templates.\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listTemplates(): Promise;\n \n type socialGroupsV2GroupRules_universal_d_GroupRules = GroupRules;\n type socialGroupsV2GroupRules_universal_d_GroupRule = GroupRule;\n type socialGroupsV2GroupRules_universal_d_ListRulesRequest = ListRulesRequest;\n type socialGroupsV2GroupRules_universal_d_ListRulesResponse = ListRulesResponse;\n type socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesRequest = CreateOrReplaceAllRulesRequest;\n type socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesResponse = CreateOrReplaceAllRulesResponse;\n type socialGroupsV2GroupRules_universal_d_Empty = Empty;\n type socialGroupsV2GroupRules_universal_d_ListTemplatesResponse = ListTemplatesResponse;\n const socialGroupsV2GroupRules_universal_d_listRules: typeof listRules;\n const socialGroupsV2GroupRules_universal_d_createOrReplaceAllRules: typeof createOrReplaceAllRules;\n type socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesOptions = CreateOrReplaceAllRulesOptions;\n const socialGroupsV2GroupRules_universal_d_listTemplates: typeof listTemplates;\n namespace socialGroupsV2GroupRules_universal_d {\n export {\n socialGroupsV2GroupRules_universal_d_GroupRules as GroupRules,\n socialGroupsV2GroupRules_universal_d_GroupRule as GroupRule,\n socialGroupsV2GroupRules_universal_d_ListRulesRequest as ListRulesRequest,\n socialGroupsV2GroupRules_universal_d_ListRulesResponse as ListRulesResponse,\n socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesRequest as CreateOrReplaceAllRulesRequest,\n socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesResponse as CreateOrReplaceAllRulesResponse,\n socialGroupsV2GroupRules_universal_d_Empty as Empty,\n socialGroupsV2GroupRules_universal_d_ListTemplatesResponse as ListTemplatesResponse,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n socialGroupsV2GroupRules_universal_d_listRules as listRules,\n socialGroupsV2GroupRules_universal_d_createOrReplaceAllRules as createOrReplaceAllRules,\n socialGroupsV2GroupRules_universal_d_CreateOrReplaceAllRulesOptions as CreateOrReplaceAllRulesOptions,\n socialGroupsV2GroupRules_universal_d_listTemplates as listTemplates,\n };\n }\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 * Date and time the request was created.\n * @internal\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * ID of the group requested to join.\n * @internal\n * @readonly\n */\n groupId?: string | null;\n /**\n * Membership questions answers count\n * @internal\n * @readonly\n */\n membershipQuestionAnswersCount?: number | null;\n }\n enum RequestStatus {\n /** Undefined request status. */\n UNKNOWN_STATUS = \"UNKNOWN_STATUS\",\n /** Pending group request. */\n PENDING = \"PENDING\",\n /** Approved group request. */\n APPROVED = \"APPROVED\",\n /** Rejected group request. */\n REJECTED = \"REJECTED\",\n /** Cancelled group request. */\n CANCELLED = \"CANCELLED\",\n /** Canceled group 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$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 GetJoinRequirementsResponse {\n violation?: Violation;\n }\n interface PaidPlan {\n planId?: string;\n name?: string;\n startsAt?: Date | null;\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$1[];\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 * @deprecated\n */\n itemsToApprove?: ItemsToUpdate;\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 the 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 /**\n * @internal\n * @deprecated\n */\n itemsToReject?: ItemsToUpdate;\n /** Rejection data. */\n rejections?: Rejection[];\n }\n interface Rejection {\n /**\n * @Internal\n * @Internal\n * @internal\n * @deprecated\n */\n siteMemberId?: string;\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 /**\n * Ownership filter. In case of server signing, `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\n limit?: number | null;\n offset?: number | null;\n }\n enum OwnershipFilter {\n /** All items. */\n ALL = \"ALL\",\n /** Items for the current site member. */\n CURRENT_MEMBER = \"CURRENT_MEMBER\"\n }\n interface ListJoinGroupRequestsResponse {\n /** Join group requests. */\n joinGroupRequests?: JoinGroupRequest[];\n metadata?: PagingMetadata$1;\n }\n interface PagingMetadata$1 {\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface QueryJoinGroupRequestsRequest {\n /** ID of the group requested to join. */\n groupId: string;\n /**\n * Ownership filter. In case of server signing `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\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$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 {\n /** Name of the field to sort by. */\n fieldName?: string;\n /** Sort order. */\n order?: SortOrder;\n /**\n * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryJoinGroupRequestsResponse {\n /** Requests to join a group. */\n joinGroupRequests?: JoinGroupRequest[];\n metadata?: PagingMetadata$1;\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$1;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 * Get join group requirements. Will return empty response for public groups and details to fulfil if it's private.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @param groupId - ID of the group requested to join.\n * @adminMethod\n */\n function getJoinRequirements(groupId: string, options?: GetJoinRequirementsOptions): Promise;\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$1[];\n autoInviteId?: string | null;\n }\n /**\n * Submits a join group request.\n * Relevant only for private groups.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @param groupId - ID of the group requested to join.\n * @adminMethod\n */\n function submitJoinGroupRequest(groupId: string, options?: SubmitJoinGroupRequestOptions): Promise;\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$1[];\n }\n /**\n * Cancels a join group request.\n * A site member can cancel only their own pending Join group requests.\n * @internal\n * @documentationMaturity preview\n * @requiredField groupId\n * @param groupId - ID of the group requested to join.\n * @adminMethod\n */\n function cancelJoinGroupRequest(groupId: string): Promise;\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 * @deprecated\n */\n itemsToApprove?: ItemsToUpdate;\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 * @internal\n * @deprecated\n */\n itemsToReject?: ItemsToUpdate;\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 /**\n * Ownership filter. In case of server signing, `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter;\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 * Ownership filter. In case of server signing `ALL` value must be used.\n * - `ALL` - All join group requests.\n * - `CURRENT_MEMBER` - Join group requests for current site member.\n * @internal\n */\n ownershipFilter?: OwnershipFilter | 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 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 /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function rejectAllJoinGroupRequests(): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function approveAllJoinGroupRequests(): Promise;\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listAllJoinGroupRequests(options?: ListAllJoinGroupRequestsOptions): Promise;\n interface ListAllJoinGroupRequestsOptions {\n query?: Query;\n }\n \n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequest = JoinGroupRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_RequestStatus = RequestStatus;\n const socialGroupsV2JoinGroupRequest_universal_d_RequestStatus: typeof RequestStatus;\n type socialGroupsV2JoinGroupRequest_universal_d_RequestDetails = RequestDetails;\n type socialGroupsV2JoinGroupRequest_universal_d_SocialGroupsEvent = SocialGroupsEvent;\n type socialGroupsV2JoinGroupRequest_universal_d_SocialGroupsEventPayloadOneOf = SocialGroupsEventPayloadOneOf;\n type socialGroupsV2JoinGroupRequest_universal_d_MemberJoinedGroup = MemberJoinedGroup;\n type socialGroupsV2JoinGroupRequest_universal_d_MembersAddedToGroup = MembersAddedToGroup;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinRequestsApproved = JoinRequestsApproved;\n type socialGroupsV2JoinGroupRequest_universal_d_MembersInvitedToGroup = MembersInvitedToGroup;\n type socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsRequest = GetJoinRequirementsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsResponse = GetJoinRequirementsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_PaidPlan = PaidPlan;\n type socialGroupsV2JoinGroupRequest_universal_d_ViolationType = ViolationType;\n const socialGroupsV2JoinGroupRequest_universal_d_ViolationType: typeof ViolationType;\n type socialGroupsV2JoinGroupRequest_universal_d_EventsViolationOptions = EventsViolationOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_PricingPlanViolationOptions = PricingPlanViolationOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_MembershipQuestionViolationOptions = MembershipQuestionViolationOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_Violation = Violation;\n type socialGroupsV2JoinGroupRequest_universal_d_ViolationViolationOptionsOneOf = ViolationViolationOptionsOneOf;\n type socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestRequest = SubmitJoinGroupRequestRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestResponse = SubmitJoinGroupRequestResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestRequest = CancelJoinGroupRequestRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestResponse = CancelJoinGroupRequestResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestCancelled = JoinGroupRequestCancelled;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsRequest = ApproveJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_ItemsToUpdate = ItemsToUpdate;\n const socialGroupsV2JoinGroupRequest_universal_d_ItemsToUpdate: typeof ItemsToUpdate;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsResponse = ApproveJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestApproved = JoinGroupRequestApproved;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsRequest = RejectJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_Rejection = Rejection;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsResponse = RejectJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestRejected = JoinGroupRequestRejected;\n type socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsRequest = ListJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_OwnershipFilter = OwnershipFilter;\n const socialGroupsV2JoinGroupRequest_universal_d_OwnershipFilter: typeof OwnershipFilter;\n type socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsResponse = ListJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsRequest = QueryJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_Query = Query;\n type socialGroupsV2JoinGroupRequest_universal_d_Sorting = Sorting;\n type socialGroupsV2JoinGroupRequest_universal_d_SortOrder = SortOrder;\n const socialGroupsV2JoinGroupRequest_universal_d_SortOrder: typeof SortOrder;\n type socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsResponse = QueryJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsRequest = RejectAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsResponse = RejectAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsRequest = ApproveAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsResponse = ApproveAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsRequest = ListAllJoinGroupRequestsRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsResponse = ListAllJoinGroupRequestsResponse;\n type socialGroupsV2JoinGroupRequest_universal_d_DomainEvent = DomainEvent;\n type socialGroupsV2JoinGroupRequest_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type socialGroupsV2JoinGroupRequest_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type socialGroupsV2JoinGroupRequest_universal_d_RestoreInfo = RestoreInfo;\n type socialGroupsV2JoinGroupRequest_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type socialGroupsV2JoinGroupRequest_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type socialGroupsV2JoinGroupRequest_universal_d_ActionEvent = ActionEvent;\n type socialGroupsV2JoinGroupRequest_universal_d_MessageEnvelope = MessageEnvelope;\n type socialGroupsV2JoinGroupRequest_universal_d_IdentificationData = IdentificationData;\n type socialGroupsV2JoinGroupRequest_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type socialGroupsV2JoinGroupRequest_universal_d_WebhookIdentityType = WebhookIdentityType;\n const socialGroupsV2JoinGroupRequest_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const socialGroupsV2JoinGroupRequest_universal_d_getJoinRequirements: typeof getJoinRequirements;\n type socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsOptions = GetJoinRequirementsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_submitJoinGroupRequest: typeof submitJoinGroupRequest;\n type socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestOptions = SubmitJoinGroupRequestOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_cancelJoinGroupRequest: typeof cancelJoinGroupRequest;\n const socialGroupsV2JoinGroupRequest_universal_d_approveJoinGroupRequests: typeof approveJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsOptions = ApproveJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_rejectJoinGroupRequests: typeof rejectJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsOptions = RejectJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_listJoinGroupRequests: typeof listJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsOptions = ListJoinGroupRequestsOptions;\n const socialGroupsV2JoinGroupRequest_universal_d_queryJoinGroupRequests: typeof queryJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsOptions = QueryJoinGroupRequestsOptions;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestsQueryResult = JoinGroupRequestsQueryResult;\n type socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestsQueryBuilder = JoinGroupRequestsQueryBuilder;\n const socialGroupsV2JoinGroupRequest_universal_d_rejectAllJoinGroupRequests: typeof rejectAllJoinGroupRequests;\n const socialGroupsV2JoinGroupRequest_universal_d_approveAllJoinGroupRequests: typeof approveAllJoinGroupRequests;\n const socialGroupsV2JoinGroupRequest_universal_d_listAllJoinGroupRequests: typeof listAllJoinGroupRequests;\n type socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsOptions = ListAllJoinGroupRequestsOptions;\n namespace socialGroupsV2JoinGroupRequest_universal_d {\n export {\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequest as JoinGroupRequest,\n socialGroupsV2JoinGroupRequest_universal_d_RequestStatus as RequestStatus,\n socialGroupsV2JoinGroupRequest_universal_d_RequestDetails as RequestDetails,\n socialGroupsV2JoinGroupRequest_universal_d_SocialGroupsEvent as SocialGroupsEvent,\n socialGroupsV2JoinGroupRequest_universal_d_SocialGroupsEventPayloadOneOf as SocialGroupsEventPayloadOneOf,\n socialGroupsV2JoinGroupRequest_universal_d_MemberJoinedGroup as MemberJoinedGroup,\n socialGroupsV2JoinGroupRequest_universal_d_MembersAddedToGroup as MembersAddedToGroup,\n socialGroupsV2JoinGroupRequest_universal_d_JoinRequestsApproved as JoinRequestsApproved,\n socialGroupsV2JoinGroupRequest_universal_d_MembersInvitedToGroup as MembersInvitedToGroup,\n socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsRequest as GetJoinRequirementsRequest,\n MembershipQuestionAnswer$1 as MembershipQuestionAnswer,\n socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsResponse as GetJoinRequirementsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_PaidPlan as PaidPlan,\n socialGroupsV2JoinGroupRequest_universal_d_ViolationType as ViolationType,\n socialGroupsV2JoinGroupRequest_universal_d_EventsViolationOptions as EventsViolationOptions,\n socialGroupsV2JoinGroupRequest_universal_d_PricingPlanViolationOptions as PricingPlanViolationOptions,\n socialGroupsV2JoinGroupRequest_universal_d_MembershipQuestionViolationOptions as MembershipQuestionViolationOptions,\n socialGroupsV2JoinGroupRequest_universal_d_Violation as Violation,\n socialGroupsV2JoinGroupRequest_universal_d_ViolationViolationOptionsOneOf as ViolationViolationOptionsOneOf,\n socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestRequest as SubmitJoinGroupRequestRequest,\n socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestResponse as SubmitJoinGroupRequestResponse,\n socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestRequest as CancelJoinGroupRequestRequest,\n socialGroupsV2JoinGroupRequest_universal_d_CancelJoinGroupRequestResponse as CancelJoinGroupRequestResponse,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestCancelled as JoinGroupRequestCancelled,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsRequest as ApproveJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_ItemsToUpdate as ItemsToUpdate,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsResponse as ApproveJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestApproved as JoinGroupRequestApproved,\n socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsRequest as RejectJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_Rejection as Rejection,\n socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsResponse as RejectJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestRejected as JoinGroupRequestRejected,\n socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsRequest as ListJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_OwnershipFilter as OwnershipFilter,\n socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsResponse as ListJoinGroupRequestsResponse,\n PagingMetadata$1 as PagingMetadata,\n socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsRequest as QueryJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_Query as Query,\n socialGroupsV2JoinGroupRequest_universal_d_Sorting as Sorting,\n socialGroupsV2JoinGroupRequest_universal_d_SortOrder as SortOrder,\n Paging$1 as Paging,\n socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsResponse as QueryJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsRequest as RejectAllJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_RejectAllJoinGroupRequestsResponse as RejectAllJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsRequest as ApproveAllJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveAllJoinGroupRequestsResponse as ApproveAllJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsRequest as ListAllJoinGroupRequestsRequest,\n socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsResponse as ListAllJoinGroupRequestsResponse,\n socialGroupsV2JoinGroupRequest_universal_d_DomainEvent as DomainEvent,\n socialGroupsV2JoinGroupRequest_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n socialGroupsV2JoinGroupRequest_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n socialGroupsV2JoinGroupRequest_universal_d_RestoreInfo as RestoreInfo,\n socialGroupsV2JoinGroupRequest_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n socialGroupsV2JoinGroupRequest_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n socialGroupsV2JoinGroupRequest_universal_d_ActionEvent as ActionEvent,\n socialGroupsV2JoinGroupRequest_universal_d_MessageEnvelope as MessageEnvelope,\n socialGroupsV2JoinGroupRequest_universal_d_IdentificationData as IdentificationData,\n socialGroupsV2JoinGroupRequest_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n socialGroupsV2JoinGroupRequest_universal_d_WebhookIdentityType as WebhookIdentityType,\n socialGroupsV2JoinGroupRequest_universal_d_getJoinRequirements as getJoinRequirements,\n socialGroupsV2JoinGroupRequest_universal_d_GetJoinRequirementsOptions as GetJoinRequirementsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_submitJoinGroupRequest as submitJoinGroupRequest,\n socialGroupsV2JoinGroupRequest_universal_d_SubmitJoinGroupRequestOptions as SubmitJoinGroupRequestOptions,\n socialGroupsV2JoinGroupRequest_universal_d_cancelJoinGroupRequest as cancelJoinGroupRequest,\n socialGroupsV2JoinGroupRequest_universal_d_approveJoinGroupRequests as approveJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_ApproveJoinGroupRequestsOptions as ApproveJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_rejectJoinGroupRequests as rejectJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_RejectJoinGroupRequestsOptions as RejectJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_listJoinGroupRequests as listJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_ListJoinGroupRequestsOptions as ListJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_queryJoinGroupRequests as queryJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_QueryJoinGroupRequestsOptions as QueryJoinGroupRequestsOptions,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestsQueryResult as JoinGroupRequestsQueryResult,\n socialGroupsV2JoinGroupRequest_universal_d_JoinGroupRequestsQueryBuilder as JoinGroupRequestsQueryBuilder,\n socialGroupsV2JoinGroupRequest_universal_d_rejectAllJoinGroupRequests as rejectAllJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_approveAllJoinGroupRequests as approveAllJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_listAllJoinGroupRequests as listAllJoinGroupRequests,\n socialGroupsV2JoinGroupRequest_universal_d_ListAllJoinGroupRequestsOptions as ListAllJoinGroupRequestsOptions,\n };\n }\n \n /**\n * Question asked to members when joining a group. Site owners can set whether it is required to answer the question in the dashboard.\n * > **Note:** Only admins can create or update membership questions.\n */\n interface MembershipQuestion {\n /**\n * Question ID.\n * @readonly\n */\n _id?: string | null;\n /** Whether a member must answer this question when joining the group. */\n required?: boolean;\n /** Question text. */\n text?: string;\n }\n interface ListMembershipQuestionsRequest {\n /** Group ID. */\n groupId: string;\n }\n interface ListMembershipQuestionsResponse {\n /** Membership questions. */\n questions?: MembershipQuestion[];\n }\n interface CreateOrReplaceAllMembershipQuestionsRequest {\n /** Group ID. */\n groupId: string;\n /** New membership questions. */\n questions?: MembershipQuestion[];\n }\n interface CreateOrReplaceAllMembershipQuestionsResponse {\n /** Membership questions. */\n questions?: MembershipQuestion[];\n }\n interface ListAnswersRequest {\n /** Group ID. */\n groupId: string;\n /** Member IDs. If no member ID is provided, answers for all members will be returned. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n memberIds?: string[];\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 ListAnswersResponse {\n /** Answers to the membership questions, grouped by member. */\n memberAnswers?: MemberMembershipQuestionAnswers[];\n /** Membership questions by question ID. Inludes only questions that have been answered by the specified members. */\n questions?: Record;\n metadata?: PagingMetadata;\n }\n interface MemberMembershipQuestionAnswers {\n /** Member ID. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n memberId?: string;\n /** Answers to the membership question. */\n answers?: MembershipQuestionAnswer[];\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 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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListAnswerCountsRequest {\n memberIds?: string[];\n }\n interface ListAnswerCountsResponse {\n memberAnswerCounts?: MemberAnswerCount[];\n }\n interface MemberAnswerCount {\n memberId?: string;\n groupId?: string;\n count?: number;\n }\n /**\n * Retrieves the membership questions for the given group.\n *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function listMembershipQuestions(groupId: string): Promise;\n /**\n * Creates membership questions if none have been set up. Otherwise, replaces all existing questions.\n * > **Notes:**\n * > * Only admins can create or replace membership questions.\n * > * Providing an empty array means that members won't have to answer any question when joining the group.\n *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function createOrReplaceAllMembershipQuestions(groupId: string, options?: CreateOrReplaceAllMembershipQuestionsOptions): Promise;\n interface CreateOrReplaceAllMembershipQuestionsOptions {\n /** New membership questions. */\n questions?: MembershipQuestion[];\n }\n /**\n * Retrieves the answers to the membership questions, given the provided filters.\n *\n * >**Note:**\n * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).\n * @param groupId - Group ID.\n * @public\n * @documentationMaturity preview\n * @requiredField groupId\n * @adminMethod\n */\n function listAnswers(groupId: string, options?: ListAnswersOptions): Promise;\n interface ListAnswersOptions {\n /** Member IDs. If no member ID is provided, answers for all members will be returned. See [Members API](https://dev.wix.com/api/rest/members/members/about-wix-members) for more details. */\n memberIds?: string[];\n paging?: Paging;\n }\n /** @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function listAnswerCounts(options?: ListAnswerCountsOptions): Promise;\n interface ListAnswerCountsOptions {\n memberIds?: string[];\n }\n \n type socialGroupsV2MembershipQuestion_universal_d_MembershipQuestion = MembershipQuestion;\n type socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsRequest = ListMembershipQuestionsRequest;\n type socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsResponse = ListMembershipQuestionsResponse;\n type socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsRequest = CreateOrReplaceAllMembershipQuestionsRequest;\n type socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsResponse = CreateOrReplaceAllMembershipQuestionsResponse;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswersRequest = ListAnswersRequest;\n type socialGroupsV2MembershipQuestion_universal_d_Paging = Paging;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswersResponse = ListAnswersResponse;\n type socialGroupsV2MembershipQuestion_universal_d_MemberMembershipQuestionAnswers = MemberMembershipQuestionAnswers;\n type socialGroupsV2MembershipQuestion_universal_d_MembershipQuestionAnswer = MembershipQuestionAnswer;\n type socialGroupsV2MembershipQuestion_universal_d_PagingMetadata = PagingMetadata;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsRequest = ListAnswerCountsRequest;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsResponse = ListAnswerCountsResponse;\n type socialGroupsV2MembershipQuestion_universal_d_MemberAnswerCount = MemberAnswerCount;\n const socialGroupsV2MembershipQuestion_universal_d_listMembershipQuestions: typeof listMembershipQuestions;\n const socialGroupsV2MembershipQuestion_universal_d_createOrReplaceAllMembershipQuestions: typeof createOrReplaceAllMembershipQuestions;\n type socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsOptions = CreateOrReplaceAllMembershipQuestionsOptions;\n const socialGroupsV2MembershipQuestion_universal_d_listAnswers: typeof listAnswers;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswersOptions = ListAnswersOptions;\n const socialGroupsV2MembershipQuestion_universal_d_listAnswerCounts: typeof listAnswerCounts;\n type socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsOptions = ListAnswerCountsOptions;\n namespace socialGroupsV2MembershipQuestion_universal_d {\n export {\n socialGroupsV2MembershipQuestion_universal_d_MembershipQuestion as MembershipQuestion,\n socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsRequest as ListMembershipQuestionsRequest,\n socialGroupsV2MembershipQuestion_universal_d_ListMembershipQuestionsResponse as ListMembershipQuestionsResponse,\n socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsRequest as CreateOrReplaceAllMembershipQuestionsRequest,\n socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsResponse as CreateOrReplaceAllMembershipQuestionsResponse,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswersRequest as ListAnswersRequest,\n socialGroupsV2MembershipQuestion_universal_d_Paging as Paging,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswersResponse as ListAnswersResponse,\n socialGroupsV2MembershipQuestion_universal_d_MemberMembershipQuestionAnswers as MemberMembershipQuestionAnswers,\n socialGroupsV2MembershipQuestion_universal_d_MembershipQuestionAnswer as MembershipQuestionAnswer,\n socialGroupsV2MembershipQuestion_universal_d_PagingMetadata as PagingMetadata,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsRequest as ListAnswerCountsRequest,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsResponse as ListAnswerCountsResponse,\n socialGroupsV2MembershipQuestion_universal_d_MemberAnswerCount as MemberAnswerCount,\n socialGroupsV2MembershipQuestion_universal_d_listMembershipQuestions as listMembershipQuestions,\n socialGroupsV2MembershipQuestion_universal_d_createOrReplaceAllMembershipQuestions as createOrReplaceAllMembershipQuestions,\n socialGroupsV2MembershipQuestion_universal_d_CreateOrReplaceAllMembershipQuestionsOptions as CreateOrReplaceAllMembershipQuestionsOptions,\n socialGroupsV2MembershipQuestion_universal_d_listAnswers as listAnswers,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswersOptions as ListAnswersOptions,\n socialGroupsV2MembershipQuestion_universal_d_listAnswerCounts as listAnswerCounts,\n socialGroupsV2MembershipQuestion_universal_d_ListAnswerCountsOptions as ListAnswerCountsOptions,\n };\n }\n \n export { socialGroupsV2GroupRequest_universal_d as groupRequests, socialGroupsV2Group_universal_d as groups, socialGroupsV2JoinGroupRequest_universal_d as joinGroupRequests, socialGroupsV2GroupMember_universal_d as members, socialGroupsV2MembershipQuestion_universal_d as membershipQuestions, socialGroupsV2GroupRole_universal_d as roles, socialGroupsV2GroupRules_universal_d as rules };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-data-backup-service-v2.d.ts", "content": "declare module \"wix-data-backup-service-v2\" {\n interface GCBackup {\n /** @readonly */\n _id?: string;\n }\n interface CreateGCBackupRequest {\n instanceId?: string;\n segment?: Segment;\n clusterId?: string;\n databaseName?: string;\n }\n enum Segment {\n Dev = \"Dev\",\n Public = \"Public\"\n }\n interface CreateGCBackupResponse {\n backupId?: string | null;\n }\n interface GetGCBackupRequest {\n backupId?: string;\n }\n interface GCBackupResponse {\n backupId?: string;\n instanceId?: string;\n segment?: Segment;\n clusterId?: string;\n databaseName?: string;\n status?: GCBackupResponseStatus;\n size?: string | null;\n requestedDate?: Date | null;\n finishedDate?: Date | null;\n restorations?: GCBackupResponseRestoration[];\n }\n enum GCBackupResponseRestorationStatus {\n PENDING = \"PENDING\",\n FAILED = \"FAILED\",\n COMPLETED = \"COMPLETED\",\n CANCELED = \"CANCELED\"\n }\n enum GCBackupResponseStatus {\n PENDING = \"PENDING\",\n READY = \"READY\",\n FAILED = \"FAILED\",\n CANCELED = \"CANCELED\"\n }\n interface GCBackupResponseRestoration {\n restorationId?: string;\n clusterId?: string;\n databaseName?: string;\n status?: GCBackupResponseRestorationStatus;\n instanceId?: string | null;\n }\n interface FindGCBackupRequest {\n instanceId?: string;\n segment?: Segment;\n clusterId?: string;\n databaseName?: string;\n }\n interface FindGCBackupResponse {\n backups?: GCBackupResponse[];\n }\n interface RestoreGCBackupRequest {\n instanceId?: string;\n backupId?: string;\n clusterId?: string;\n databaseName?: string;\n }\n interface RestoreGCBackupResponse {\n restorationId?: string;\n }\n interface CancelGCBackupRequest {\n backupId?: string;\n }\n interface CancelGCBackupResponse {\n }\n interface CancelGCRestorationRequest {\n backupId?: string;\n restorationId?: string;\n }\n interface CancelGCRestorationResponse {\n }\n interface DeleteExpiredBackupRecordsRequest {\n }\n interface DeleteExpiredBackupRecordsResponse {\n }\n interface Backup {\n /**\n * Backup ID.\n * @readonly\n */\n _id?: string;\n /**\n * Backup status.\n * @readonly\n */\n status?: Status;\n /**\n * Type of backup, based on how it was triggered.\n * @readonly\n */\n type?: Type;\n /**\n * Date and time the backup was requested.\n * @readonly\n */\n requestedDate?: Date | null;\n /**\n * Date and time the backup commenced. Value is `null` until the backup process begins in the background.\n * @readonly\n */\n startedDate?: Date | null;\n /**\n * Date and time the backup process finished. Value is `null` until the backup process is completed in the background.\n * @readonly\n */\n finishedDate?: Date | null;\n /**\n * Date and time the backup was deleted. Value is `null` if that backup hasn't been deleted.\n * @readonly\n */\n deletedDate?: Date | null;\n /**\n * Backup size in bytes. Value is `null` until the backup process is completed.\n * @readonly\n */\n sizeInBytes?: string | null;\n /**\n * IDs and display names of collections the backup contains.\n * @readonly\n */\n collections?: Collection[];\n }\n enum Status {\n /** Backup creation is in progress. */\n PENDING = \"PENDING\",\n /** Backup has been created successfully and can be used for data restoration. */\n READY = \"READY\",\n /** Backup creation has failed. */\n FAILED = \"FAILED\",\n /** Backup has been deleted. */\n DELETED = \"DELETED\",\n /** Backup has been canceled. */\n CANCELED = \"CANCELED\"\n }\n enum Type {\n /** Backup taken on demand. */\n ON_DEMAND = \"ON_DEMAND\",\n /** Automatically triggered backup (taken repeatedly on a regular interval). */\n AUTO = \"AUTO\"\n }\n interface Collection {\n /**\n * Collection ID.\n * @readonly\n */\n _id?: string;\n /**\n * Collection display name.\n * @readonly\n */\n displayName?: string | null;\n }\n /** event triggered when backup state is changed (i.e. it was created, started, completed or failed) */\n interface BackupStateChanged {\n /**\n * current state of backup\n * @readonly\n */\n backup?: Backup;\n }\n /** event triggered when backup restoration state is changed (i.e. it was created, started or completed) */\n interface RestorationStateChanged {\n /**\n * current state of restoration\n * @readonly\n */\n restoration?: Restoration;\n }\n interface Restoration {\n /**\n * Restoration ID.\n * @readonly\n */\n _id?: string;\n /**\n * Details of the backup used for the restoration.\n * @readonly\n */\n backup?: Backup;\n /**\n * Status of restoration.\n * @readonly\n */\n status?: RestorationStatus;\n /**\n * Date and time the restoration was requested.\n * @readonly\n */\n requestedDate?: Date | null;\n /**\n * Date and time the restoration commenced. Value is `null` until the restoration process begins in the background.\n * @readonly\n */\n startedDate?: Date | null;\n /**\n * Date and time the restoration finished. Value is `null` until the restoration process is completed in the background.\n * @readonly\n */\n finishedDate?: Date | null;\n /**\n * List of collections restored.\n * @readonly\n * @deprecated\n * @replacedBy restoration_collections\n * @targetRemovalDate 2025-12-31\n */\n collections?: Collection[];\n /** @readonly */\n restorationCollections?: RestorationCollection[];\n }\n enum RestorationStatus {\n /** Restoration from a backup is in progress. */\n PENDING = \"PENDING\",\n /** Restoration from a backup has been successful. */\n COMPLETED = \"COMPLETED\",\n /** Restoration from a backup has failed. */\n FAILED = \"FAILED\"\n }\n interface RestorationCollection {\n /**\n * Collection to be restored.\n *\n * **Note**: If two collections have a multireference relation, the references will be restored only if both collections are restored.\n */\n dataCollectionId?: string;\n /**\n * Destination where to restore the collection.\n * When not specified destination is taken from backup.\n */\n restoreDestination?: RestoreDestination;\n }\n interface RestoreDestination {\n /** Collection id. */\n dataCollectionId?: string;\n /** Display name. When not specified value is taken from the backup. */\n displayName?: string | null;\n }\n interface CreateBackupRequest {\n /**\n * Type of backup to create. Default value is `ON_DEMAND`.\n * @internal\n */\n type?: Type;\n }\n interface CreateBackupResponse {\n /** Details of the requested backup. */\n backup?: Backup;\n }\n interface ListBackupsRequest {\n /**\n * Statuses to filter by.\n * If provided, only backups with the specified statuses are listed.\n * For example, to list only completed backups, use `?status=READY`.\n * To list completed and pending backups, use `?status=READY&status=PENDING`.\n *\n * - **`PENDING`**: A backup that was initiated but isn't yet completed.\n * - **`READY`**: A successfully completed backup.\n * - **`FAILED`**: A backup that was initiated but didn't successfully complete.\n * - **`DELETED`**: A successfully deleted backup.\n * - **`CANCELED`**: A backup that was canceled after being initiated.\n *\n * Default: No filtering\n */\n status?: Status[];\n /**\n * Type to filter by. If provided, only backups of the specified type are listed.\n *\n * - **`AUTO`**: A backup taken automatically by the system on a regular schedule.\n * - **`ON_DEMAND`**: A backup initiated manually.\n *\n * Default: No filtering\n */\n type?: Type[];\n /** Paging preferences. */\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 ListBackupsResponse {\n /** Retrieved backups. */\n backups?: Backup[];\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 }\n interface RestoreBackupRequest {\n /** ID of backup to be restored. */\n backupId: string;\n }\n interface RestoreBackupResponse {\n /** Details of data restoration from backup. */\n restoration?: Restoration;\n }\n interface RestorePartialBackupRequest {\n /** ID of backup to be restored. */\n backupId: string;\n /**\n * Collections to be restored.\n *\n * **Note**: If two collections have a multireference relation, the references will be restored only if both collections are restored.\n * @deprecated\n * @replacedBy restoration_collections\n * @targetRemovalDate 2025-12-31\n */\n dataCollectionIds?: string[];\n /** Collections to be restored. */\n restorationCollections?: RestorationCollection[];\n }\n interface ListRestorationsRequest {\n /**\n * Statuses to filter by. If provided, only restorations with the specified statuses are listed.\n * For example, to list only completed restorations, use `?status=COMPLETED`.\n * To list completed and pending restorations, use `?status=COMPLETED&status=PENDING`.\n *\n * - **`PENDING`**: A restoration that was initiated but isn't yet completed.\n * - **`COMPLETED`**: A successfully completed restoration.\n * - **`FAILED`**: A restoration that was initiated but didn't successfully complete.\n *\n * Default: No filtering\n */\n status?: RestorationStatus[];\n /** Offset and limit of items to retrieve. */\n paging?: Paging;\n }\n interface ListRestorationsResponse {\n /** Retrieved restorations. */\n restorations?: Restoration[];\n /** Paging information. */\n pagingMetadata?: PagingMetadataV2;\n }\n interface DeleteBackupRequest {\n /** ID of the backup to be deleted. */\n backupId: string;\n }\n interface DeleteBackupResponse {\n }\n interface CancelBackupRequest {\n /** ID of the backup to be cancelled. */\n backupId: string;\n }\n interface CancelBackupResponse {\n }\n interface MigrateNamespaceRequest {\n newNamespace?: string;\n existingNamespace?: string;\n }\n interface MigrateNamespaceResponse {\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 DisableInstanceRequest {\n instanceId?: string;\n }\n interface Empty {\n }\n interface EnableInstanceRequest {\n instanceId?: string;\n }\n interface DeleteAllRequest {\n instanceId?: string;\n }\n interface GetBackupMetadataRequest {\n backupId?: string;\n }\n interface GetBackupMetadataResponse {\n metaData?: Record | null;\n }\n interface RebuildRequest {\n backupId?: string;\n }\n interface MoveRequest {\n backupId?: string;\n }\n interface RemoveDeletedRequest {\n limit?: number;\n }\n interface FailRestorationRequest {\n restorationId?: string;\n }\n interface TakeBackupRequest {\n instanceId?: string;\n type?: Type;\n }\n interface UpdateBackupMetadataRequest {\n backupId?: string;\n s3Region?: string;\n s3Bucket?: string;\n }\n /**\n * Creates an on-demand backup of live content in a site's collections.\n *\n *\n * By default, all of the site's collections are included in the backup. For a partial backup, specify which collections to include in the `backup.collections` parameter.\n *\n * The process of creating a backup takes time.\n * You can check whether a backup has completed successfully with List Backups.\n *\n * You can store up to 3 on-demand backups for each site.\n * If 3 on-demand backups already exist, the oldest existing on-demand backup for the site is deleted when a new one is created. Automated backups are not affected.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_DATA.CREATE_BACKUP\n * @adminMethod\n */\n function createBackup(options?: CreateBackupOptions): Promise;\n interface CreateBackupOptions {\n /**\n * Type of backup to create. Default value is `ON_DEMAND`.\n * @internal\n */\n type?: Type;\n }\n /**\n * Retrieves a list of all backups for a site.\n *\n * Results are sorted by requested date, with the newest first.\n *\n * You can use this method to check whether a backup initiated with Create Backup has been completed successfully.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_DATA.LIST_BACKUPS\n * @adminMethod\n */\n function listBackups(options?: ListBackupsOptions): Promise;\n interface ListBackupsOptions {\n /**\n * Statuses to filter by.\n * If provided, only backups with the specified statuses are listed.\n * For example, to list only completed backups, use `?status=READY`.\n * To list completed and pending backups, use `?status=READY&status=PENDING`.\n *\n * - **`PENDING`**: A backup that was initiated but isn't yet completed.\n * - **`READY`**: A successfully completed backup.\n * - **`FAILED`**: A backup that was initiated but didn't successfully complete.\n * - **`DELETED`**: A successfully deleted backup.\n * - **`CANCELED`**: A backup that was canceled after being initiated.\n *\n * Default: No filtering\n */\n status?: Status[];\n /**\n * Type to filter by. If provided, only backups of the specified type are listed.\n *\n * - **`AUTO`**: A backup taken automatically by the system on a regular schedule.\n * - **`ON_DEMAND`**: A backup initiated manually.\n *\n * Default: No filtering\n */\n type?: Type[];\n /** Paging preferences. */\n paging?: Paging;\n }\n /**\n * Restores all data from a backup.\n *\n * The process of restoring data from a backup takes time.\n * You can check whether your restoration has completed successfully with List Restorations.\n * @param backupId - ID of backup to be restored.\n * @public\n * @documentationMaturity preview\n * @requiredField backupId\n * @permissionId WIX_DATA.RESTORE_BACKUP\n * @adminMethod\n */\n function restoreBackup(backupId: string): Promise;\n /**\n * Restores specific collections from a backup.\n *\n * The process of restoring data from a backup takes time.\n * You can check whether your restoration has completed successfully with List Restorations.\n * @param backupId - ID of backup to be restored.\n * @param dataCollectionIds - Collections to be restored.\n *\n * **Note**: If two collections have a multireference relation, the references will be restored only if both collections are restored.\n * @public\n * @documentationMaturity preview\n * @requiredField backupId\n * @requiredField dataCollectionIds\n * @permissionId WIX_DATA.RESTORE_BACKUP\n * @adminMethod\n */\n function restorePartialBackup(backupId: string, dataCollectionIds: string[], options?: RestorePartialBackupOptions): Promise;\n interface RestorePartialBackupOptions {\n /** Collections to be restored. */\n restorationCollections?: RestorationCollection[];\n }\n /**\n * Retrieves a list of all data restorations from backups.\n *\n * Results are sorted by requested date, with the newest first.\n *\n * You can use this method to check whether a restoration initiated with Restore Backup has been completed successfully.\n * @public\n * @documentationMaturity preview\n * @permissionId WIX_DATA.LIST_RESTORATIONS\n * @adminMethod\n */\n function listRestorations(options?: ListRestorationsOptions): Promise;\n interface ListRestorationsOptions {\n /**\n * Statuses to filter by. If provided, only restorations with the specified statuses are listed.\n * For example, to list only completed restorations, use `?status=COMPLETED`.\n * To list completed and pending restorations, use `?status=COMPLETED&status=PENDING`.\n *\n * - **`PENDING`**: A restoration that was initiated but isn't yet completed.\n * - **`COMPLETED`**: A successfully completed restoration.\n * - **`FAILED`**: A restoration that was initiated but didn't successfully complete.\n *\n * Default: No filtering\n */\n status?: RestorationStatus[];\n /** Offset and limit of items to retrieve. */\n paging?: Paging;\n }\n /**\n * Deletes a backup.\n *\n * The process of deleting a backup takes time.\n * You can check whether a backup has been deleted successfully with List Backups.\n * @param backupId - ID of the backup to be deleted.\n * @public\n * @documentationMaturity preview\n * @requiredField backupId\n * @permissionId WIX_DATA.DELETE_BACKUP\n * @adminMethod\n */\n function deleteBackup(backupId: string): Promise;\n /**\n * Cancels a backup.\n *\n * This method is used to cancel a backup that was initiated with Create Backup and is still underway.\n * The process of canceling a backup takes time. You can check whether your backup has been canceled successfully with List Backups.\n * @param backupId - ID of the backup to be cancelled.\n * @internal\n * @documentationMaturity preview\n * @requiredField backupId\n * @permissionId WIX_DATA.CANCEL_BACKUP\n * @adminMethod\n */\n function cancelBackup(backupId: string): Promise;\n \n type dataV2Backup_universal_d_GCBackup = GCBackup;\n type dataV2Backup_universal_d_CreateGCBackupRequest = CreateGCBackupRequest;\n type dataV2Backup_universal_d_Segment = Segment;\n const dataV2Backup_universal_d_Segment: typeof Segment;\n type dataV2Backup_universal_d_CreateGCBackupResponse = CreateGCBackupResponse;\n type dataV2Backup_universal_d_GetGCBackupRequest = GetGCBackupRequest;\n type dataV2Backup_universal_d_GCBackupResponse = GCBackupResponse;\n type dataV2Backup_universal_d_GCBackupResponseRestorationStatus = GCBackupResponseRestorationStatus;\n const dataV2Backup_universal_d_GCBackupResponseRestorationStatus: typeof GCBackupResponseRestorationStatus;\n type dataV2Backup_universal_d_GCBackupResponseStatus = GCBackupResponseStatus;\n const dataV2Backup_universal_d_GCBackupResponseStatus: typeof GCBackupResponseStatus;\n type dataV2Backup_universal_d_GCBackupResponseRestoration = GCBackupResponseRestoration;\n type dataV2Backup_universal_d_FindGCBackupRequest = FindGCBackupRequest;\n type dataV2Backup_universal_d_FindGCBackupResponse = FindGCBackupResponse;\n type dataV2Backup_universal_d_RestoreGCBackupRequest = RestoreGCBackupRequest;\n type dataV2Backup_universal_d_RestoreGCBackupResponse = RestoreGCBackupResponse;\n type dataV2Backup_universal_d_CancelGCBackupRequest = CancelGCBackupRequest;\n type dataV2Backup_universal_d_CancelGCBackupResponse = CancelGCBackupResponse;\n type dataV2Backup_universal_d_CancelGCRestorationRequest = CancelGCRestorationRequest;\n type dataV2Backup_universal_d_CancelGCRestorationResponse = CancelGCRestorationResponse;\n type dataV2Backup_universal_d_DeleteExpiredBackupRecordsRequest = DeleteExpiredBackupRecordsRequest;\n type dataV2Backup_universal_d_DeleteExpiredBackupRecordsResponse = DeleteExpiredBackupRecordsResponse;\n type dataV2Backup_universal_d_Backup = Backup;\n type dataV2Backup_universal_d_Status = Status;\n const dataV2Backup_universal_d_Status: typeof Status;\n type dataV2Backup_universal_d_Type = Type;\n const dataV2Backup_universal_d_Type: typeof Type;\n type dataV2Backup_universal_d_Collection = Collection;\n type dataV2Backup_universal_d_BackupStateChanged = BackupStateChanged;\n type dataV2Backup_universal_d_RestorationStateChanged = RestorationStateChanged;\n type dataV2Backup_universal_d_Restoration = Restoration;\n type dataV2Backup_universal_d_RestorationStatus = RestorationStatus;\n const dataV2Backup_universal_d_RestorationStatus: typeof RestorationStatus;\n type dataV2Backup_universal_d_RestorationCollection = RestorationCollection;\n type dataV2Backup_universal_d_RestoreDestination = RestoreDestination;\n type dataV2Backup_universal_d_CreateBackupRequest = CreateBackupRequest;\n type dataV2Backup_universal_d_CreateBackupResponse = CreateBackupResponse;\n type dataV2Backup_universal_d_ListBackupsRequest = ListBackupsRequest;\n type dataV2Backup_universal_d_Paging = Paging;\n type dataV2Backup_universal_d_ListBackupsResponse = ListBackupsResponse;\n type dataV2Backup_universal_d_PagingMetadataV2 = PagingMetadataV2;\n type dataV2Backup_universal_d_RestoreBackupRequest = RestoreBackupRequest;\n type dataV2Backup_universal_d_RestoreBackupResponse = RestoreBackupResponse;\n type dataV2Backup_universal_d_RestorePartialBackupRequest = RestorePartialBackupRequest;\n type dataV2Backup_universal_d_ListRestorationsRequest = ListRestorationsRequest;\n type dataV2Backup_universal_d_ListRestorationsResponse = ListRestorationsResponse;\n type dataV2Backup_universal_d_DeleteBackupRequest = DeleteBackupRequest;\n type dataV2Backup_universal_d_DeleteBackupResponse = DeleteBackupResponse;\n type dataV2Backup_universal_d_CancelBackupRequest = CancelBackupRequest;\n type dataV2Backup_universal_d_CancelBackupResponse = CancelBackupResponse;\n type dataV2Backup_universal_d_MigrateNamespaceRequest = MigrateNamespaceRequest;\n type dataV2Backup_universal_d_MigrateNamespaceResponse = MigrateNamespaceResponse;\n type dataV2Backup_universal_d_DomainEvent = DomainEvent;\n type dataV2Backup_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type dataV2Backup_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type dataV2Backup_universal_d_RestoreInfo = RestoreInfo;\n type dataV2Backup_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type dataV2Backup_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type dataV2Backup_universal_d_ActionEvent = ActionEvent;\n type dataV2Backup_universal_d_MessageEnvelope = MessageEnvelope;\n type dataV2Backup_universal_d_IdentificationData = IdentificationData;\n type dataV2Backup_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type dataV2Backup_universal_d_WebhookIdentityType = WebhookIdentityType;\n const dataV2Backup_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n type dataV2Backup_universal_d_DisableInstanceRequest = DisableInstanceRequest;\n type dataV2Backup_universal_d_Empty = Empty;\n type dataV2Backup_universal_d_EnableInstanceRequest = EnableInstanceRequest;\n type dataV2Backup_universal_d_DeleteAllRequest = DeleteAllRequest;\n type dataV2Backup_universal_d_GetBackupMetadataRequest = GetBackupMetadataRequest;\n type dataV2Backup_universal_d_GetBackupMetadataResponse = GetBackupMetadataResponse;\n type dataV2Backup_universal_d_RebuildRequest = RebuildRequest;\n type dataV2Backup_universal_d_MoveRequest = MoveRequest;\n type dataV2Backup_universal_d_RemoveDeletedRequest = RemoveDeletedRequest;\n type dataV2Backup_universal_d_FailRestorationRequest = FailRestorationRequest;\n type dataV2Backup_universal_d_TakeBackupRequest = TakeBackupRequest;\n type dataV2Backup_universal_d_UpdateBackupMetadataRequest = UpdateBackupMetadataRequest;\n const dataV2Backup_universal_d_createBackup: typeof createBackup;\n type dataV2Backup_universal_d_CreateBackupOptions = CreateBackupOptions;\n const dataV2Backup_universal_d_listBackups: typeof listBackups;\n type dataV2Backup_universal_d_ListBackupsOptions = ListBackupsOptions;\n const dataV2Backup_universal_d_restoreBackup: typeof restoreBackup;\n const dataV2Backup_universal_d_restorePartialBackup: typeof restorePartialBackup;\n type dataV2Backup_universal_d_RestorePartialBackupOptions = RestorePartialBackupOptions;\n const dataV2Backup_universal_d_listRestorations: typeof listRestorations;\n type dataV2Backup_universal_d_ListRestorationsOptions = ListRestorationsOptions;\n const dataV2Backup_universal_d_deleteBackup: typeof deleteBackup;\n const dataV2Backup_universal_d_cancelBackup: typeof cancelBackup;\n namespace dataV2Backup_universal_d {\n export {\n dataV2Backup_universal_d_GCBackup as GCBackup,\n dataV2Backup_universal_d_CreateGCBackupRequest as CreateGCBackupRequest,\n dataV2Backup_universal_d_Segment as Segment,\n dataV2Backup_universal_d_CreateGCBackupResponse as CreateGCBackupResponse,\n dataV2Backup_universal_d_GetGCBackupRequest as GetGCBackupRequest,\n dataV2Backup_universal_d_GCBackupResponse as GCBackupResponse,\n dataV2Backup_universal_d_GCBackupResponseRestorationStatus as GCBackupResponseRestorationStatus,\n dataV2Backup_universal_d_GCBackupResponseStatus as GCBackupResponseStatus,\n dataV2Backup_universal_d_GCBackupResponseRestoration as GCBackupResponseRestoration,\n dataV2Backup_universal_d_FindGCBackupRequest as FindGCBackupRequest,\n dataV2Backup_universal_d_FindGCBackupResponse as FindGCBackupResponse,\n dataV2Backup_universal_d_RestoreGCBackupRequest as RestoreGCBackupRequest,\n dataV2Backup_universal_d_RestoreGCBackupResponse as RestoreGCBackupResponse,\n dataV2Backup_universal_d_CancelGCBackupRequest as CancelGCBackupRequest,\n dataV2Backup_universal_d_CancelGCBackupResponse as CancelGCBackupResponse,\n dataV2Backup_universal_d_CancelGCRestorationRequest as CancelGCRestorationRequest,\n dataV2Backup_universal_d_CancelGCRestorationResponse as CancelGCRestorationResponse,\n dataV2Backup_universal_d_DeleteExpiredBackupRecordsRequest as DeleteExpiredBackupRecordsRequest,\n dataV2Backup_universal_d_DeleteExpiredBackupRecordsResponse as DeleteExpiredBackupRecordsResponse,\n dataV2Backup_universal_d_Backup as Backup,\n dataV2Backup_universal_d_Status as Status,\n dataV2Backup_universal_d_Type as Type,\n dataV2Backup_universal_d_Collection as Collection,\n dataV2Backup_universal_d_BackupStateChanged as BackupStateChanged,\n dataV2Backup_universal_d_RestorationStateChanged as RestorationStateChanged,\n dataV2Backup_universal_d_Restoration as Restoration,\n dataV2Backup_universal_d_RestorationStatus as RestorationStatus,\n dataV2Backup_universal_d_RestorationCollection as RestorationCollection,\n dataV2Backup_universal_d_RestoreDestination as RestoreDestination,\n dataV2Backup_universal_d_CreateBackupRequest as CreateBackupRequest,\n dataV2Backup_universal_d_CreateBackupResponse as CreateBackupResponse,\n dataV2Backup_universal_d_ListBackupsRequest as ListBackupsRequest,\n dataV2Backup_universal_d_Paging as Paging,\n dataV2Backup_universal_d_ListBackupsResponse as ListBackupsResponse,\n dataV2Backup_universal_d_PagingMetadataV2 as PagingMetadataV2,\n dataV2Backup_universal_d_RestoreBackupRequest as RestoreBackupRequest,\n dataV2Backup_universal_d_RestoreBackupResponse as RestoreBackupResponse,\n dataV2Backup_universal_d_RestorePartialBackupRequest as RestorePartialBackupRequest,\n dataV2Backup_universal_d_ListRestorationsRequest as ListRestorationsRequest,\n dataV2Backup_universal_d_ListRestorationsResponse as ListRestorationsResponse,\n dataV2Backup_universal_d_DeleteBackupRequest as DeleteBackupRequest,\n dataV2Backup_universal_d_DeleteBackupResponse as DeleteBackupResponse,\n dataV2Backup_universal_d_CancelBackupRequest as CancelBackupRequest,\n dataV2Backup_universal_d_CancelBackupResponse as CancelBackupResponse,\n dataV2Backup_universal_d_MigrateNamespaceRequest as MigrateNamespaceRequest,\n dataV2Backup_universal_d_MigrateNamespaceResponse as MigrateNamespaceResponse,\n dataV2Backup_universal_d_DomainEvent as DomainEvent,\n dataV2Backup_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n dataV2Backup_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n dataV2Backup_universal_d_RestoreInfo as RestoreInfo,\n dataV2Backup_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n dataV2Backup_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n dataV2Backup_universal_d_ActionEvent as ActionEvent,\n dataV2Backup_universal_d_MessageEnvelope as MessageEnvelope,\n dataV2Backup_universal_d_IdentificationData as IdentificationData,\n dataV2Backup_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n dataV2Backup_universal_d_WebhookIdentityType as WebhookIdentityType,\n dataV2Backup_universal_d_DisableInstanceRequest as DisableInstanceRequest,\n dataV2Backup_universal_d_Empty as Empty,\n dataV2Backup_universal_d_EnableInstanceRequest as EnableInstanceRequest,\n dataV2Backup_universal_d_DeleteAllRequest as DeleteAllRequest,\n dataV2Backup_universal_d_GetBackupMetadataRequest as GetBackupMetadataRequest,\n dataV2Backup_universal_d_GetBackupMetadataResponse as GetBackupMetadataResponse,\n dataV2Backup_universal_d_RebuildRequest as RebuildRequest,\n dataV2Backup_universal_d_MoveRequest as MoveRequest,\n dataV2Backup_universal_d_RemoveDeletedRequest as RemoveDeletedRequest,\n dataV2Backup_universal_d_FailRestorationRequest as FailRestorationRequest,\n dataV2Backup_universal_d_TakeBackupRequest as TakeBackupRequest,\n dataV2Backup_universal_d_UpdateBackupMetadataRequest as UpdateBackupMetadataRequest,\n dataV2Backup_universal_d_createBackup as createBackup,\n dataV2Backup_universal_d_CreateBackupOptions as CreateBackupOptions,\n dataV2Backup_universal_d_listBackups as listBackups,\n dataV2Backup_universal_d_ListBackupsOptions as ListBackupsOptions,\n dataV2Backup_universal_d_restoreBackup as restoreBackup,\n dataV2Backup_universal_d_restorePartialBackup as restorePartialBackup,\n dataV2Backup_universal_d_RestorePartialBackupOptions as RestorePartialBackupOptions,\n dataV2Backup_universal_d_listRestorations as listRestorations,\n dataV2Backup_universal_d_ListRestorationsOptions as ListRestorationsOptions,\n dataV2Backup_universal_d_deleteBackup as deleteBackup,\n dataV2Backup_universal_d_cancelBackup as cancelBackup,\n };\n }\n \n export { dataV2Backup_universal_d as data };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/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 /**\n * 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 * @internal\n */\n fieldMask?: 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$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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$2;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$2 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 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 * @permissionId COUPONS.MANAGE\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 * @permissionId COUPONS.MANAGE\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 * @permissionId COUPONS.MANAGE\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 * @permissionId COUPONS.MANAGE\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 * @permissionId COUPONS.MANAGE\n * @adminMethod\n */\n function queryCoupons(query: Query): Promise;\n /**\n * Calculate a cart's total price after applying a coupon.\n * Pass the Cart with line items and shipping, and the cart will be returned\n * along with its coupon's calculations applied.\n * @param code - For calculating by coupon code (usually for apply coupon phase - for validation).\n * @internal\n * @documentationMaturity preview\n * @requiredField code\n * @permissionId COUPONS.MANAGE\n * @adminMethod\n */\n function calculateCart(code: string, options?: CalculateCartOptions): 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 /**\n * It is the responsibility of the payment process to call this endpoint after\n * the coupon was used.\n * @param _id - Coupon ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField _id\n * @adminMethod\n */\n function increaseUsage(_id: string, options?: IncreaseUsageOptions): Promise;\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 * Returns true if the site has ever had any coupons (even if they have all been deleted or deactivated).\n * @internal\n * @documentationMaturity preview\n * @adminMethod\n */\n function hasCoupons(): Promise;\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 * @permissionId COUPONS.MANAGE\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 * @permissionId COUPONS.MANAGE\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 \n type ecommerceCouponsV2Coupon_universal_d_Coupon = Coupon;\n type ecommerceCouponsV2Coupon_universal_d_MediaItem = MediaItem;\n type ecommerceCouponsV2Coupon_universal_d_Specification = Specification;\n type ecommerceCouponsV2Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf = SpecificationScopeOrMinSubtotalOneOf;\n type ecommerceCouponsV2Coupon_universal_d_SpecificationBehaviorOneOf = SpecificationBehaviorOneOf;\n type ecommerceCouponsV2Coupon_universal_d_Scope = Scope;\n type ecommerceCouponsV2Coupon_universal_d_Group = Group;\n type ecommerceCouponsV2Coupon_universal_d_BuyXGetY = BuyXGetY;\n type ecommerceCouponsV2Coupon_universal_d_DisplayData = DisplayData;\n type ecommerceCouponsV2Coupon_universal_d_CreateCouponRequest = CreateCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_CreateCouponResponse = CreateCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_UpdateCouponRequest = UpdateCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_UpdateCouponResponse = UpdateCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_GetCouponRequest = GetCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_GetCouponResponse = GetCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_DeleteCouponRequest = DeleteCouponRequest;\n type ecommerceCouponsV2Coupon_universal_d_DeleteCouponResponse = DeleteCouponResponse;\n type ecommerceCouponsV2Coupon_universal_d_QueryCouponsRequest = QueryCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_Query = Query;\n type ecommerceCouponsV2Coupon_universal_d_Paging = Paging;\n type ecommerceCouponsV2Coupon_universal_d_QueryCouponsResponse = QueryCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_CalculateRequest = CalculateRequest;\n type ecommerceCouponsV2Coupon_universal_d_CalculateRequestCalculateByOneOf = CalculateRequestCalculateByOneOf;\n type ecommerceCouponsV2Coupon_universal_d_Cart = Cart;\n type ecommerceCouponsV2Coupon_universal_d_AppliedDiscount = AppliedDiscount;\n type ecommerceCouponsV2Coupon_universal_d_LineItem = LineItem;\n type ecommerceCouponsV2Coupon_universal_d_Shipping = Shipping;\n type ecommerceCouponsV2Coupon_universal_d_Totals = Totals;\n type ecommerceCouponsV2Coupon_universal_d_CalculateResponse = CalculateResponse;\n type ecommerceCouponsV2Coupon_universal_d_AppliedCoupon = AppliedCoupon;\n type ecommerceCouponsV2Coupon_universal_d_Error = Error;\n type ecommerceCouponsV2Coupon_universal_d_IncreaseUsageRequest = IncreaseUsageRequest;\n type ecommerceCouponsV2Coupon_universal_d_IncreaseUsageResponse = IncreaseUsageResponse;\n type ecommerceCouponsV2Coupon_universal_d_CouponApplied = CouponApplied;\n type ecommerceCouponsV2Coupon_universal_d_HasCouponsRequest = HasCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_HasCouponsResponse = HasCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsRequest = BulkDeleteCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsResponse = BulkDeleteCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_ItemMetadata = ItemMetadata;\n type ecommerceCouponsV2Coupon_universal_d_ApplicationError = ApplicationError;\n type ecommerceCouponsV2Coupon_universal_d_BulkActionMetadata = BulkActionMetadata;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsRequest = BulkCreateCouponsRequest;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsResponse = BulkCreateCouponsResponse;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponResult = BulkCreateCouponResult;\n const ecommerceCouponsV2Coupon_universal_d_createCoupon: typeof createCoupon;\n const ecommerceCouponsV2Coupon_universal_d_updateCoupon: typeof updateCoupon;\n const ecommerceCouponsV2Coupon_universal_d_getCoupon: typeof getCoupon;\n const ecommerceCouponsV2Coupon_universal_d_deleteCoupon: typeof deleteCoupon;\n const ecommerceCouponsV2Coupon_universal_d_queryCoupons: typeof queryCoupons;\n const ecommerceCouponsV2Coupon_universal_d_calculateCart: typeof calculateCart;\n type ecommerceCouponsV2Coupon_universal_d_CalculateCartOptions = CalculateCartOptions;\n const ecommerceCouponsV2Coupon_universal_d_increaseUsage: typeof increaseUsage;\n type ecommerceCouponsV2Coupon_universal_d_IncreaseUsageOptions = IncreaseUsageOptions;\n const ecommerceCouponsV2Coupon_universal_d_hasCoupons: typeof hasCoupons;\n const ecommerceCouponsV2Coupon_universal_d_bulkDeleteCoupons: typeof bulkDeleteCoupons;\n const ecommerceCouponsV2Coupon_universal_d_bulkCreateCoupons: typeof bulkCreateCoupons;\n type ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsOptions = BulkCreateCouponsOptions;\n namespace ecommerceCouponsV2Coupon_universal_d {\n export {\n ecommerceCouponsV2Coupon_universal_d_Coupon as Coupon,\n ecommerceCouponsV2Coupon_universal_d_MediaItem as MediaItem,\n ecommerceCouponsV2Coupon_universal_d_Specification as Specification,\n ecommerceCouponsV2Coupon_universal_d_SpecificationScopeOrMinSubtotalOneOf as SpecificationScopeOrMinSubtotalOneOf,\n ecommerceCouponsV2Coupon_universal_d_SpecificationBehaviorOneOf as SpecificationBehaviorOneOf,\n ecommerceCouponsV2Coupon_universal_d_Scope as Scope,\n ecommerceCouponsV2Coupon_universal_d_Group as Group,\n ecommerceCouponsV2Coupon_universal_d_BuyXGetY as BuyXGetY,\n ecommerceCouponsV2Coupon_universal_d_DisplayData as DisplayData,\n ecommerceCouponsV2Coupon_universal_d_CreateCouponRequest as CreateCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_CreateCouponResponse as CreateCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_UpdateCouponRequest as UpdateCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_UpdateCouponResponse as UpdateCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_GetCouponRequest as GetCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_GetCouponResponse as GetCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_DeleteCouponRequest as DeleteCouponRequest,\n ecommerceCouponsV2Coupon_universal_d_DeleteCouponResponse as DeleteCouponResponse,\n ecommerceCouponsV2Coupon_universal_d_QueryCouponsRequest as QueryCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_Query as Query,\n ecommerceCouponsV2Coupon_universal_d_Paging as Paging,\n ecommerceCouponsV2Coupon_universal_d_QueryCouponsResponse as QueryCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_CalculateRequest as CalculateRequest,\n ecommerceCouponsV2Coupon_universal_d_CalculateRequestCalculateByOneOf as CalculateRequestCalculateByOneOf,\n ecommerceCouponsV2Coupon_universal_d_Cart as Cart,\n ecommerceCouponsV2Coupon_universal_d_AppliedDiscount as AppliedDiscount,\n ecommerceCouponsV2Coupon_universal_d_LineItem as LineItem,\n ecommerceCouponsV2Coupon_universal_d_Shipping as Shipping,\n ecommerceCouponsV2Coupon_universal_d_Totals as Totals,\n ecommerceCouponsV2Coupon_universal_d_CalculateResponse as CalculateResponse,\n ecommerceCouponsV2Coupon_universal_d_AppliedCoupon as AppliedCoupon,\n ecommerceCouponsV2Coupon_universal_d_Error as Error,\n ecommerceCouponsV2Coupon_universal_d_IncreaseUsageRequest as IncreaseUsageRequest,\n ecommerceCouponsV2Coupon_universal_d_IncreaseUsageResponse as IncreaseUsageResponse,\n ecommerceCouponsV2Coupon_universal_d_CouponApplied as CouponApplied,\n ecommerceCouponsV2Coupon_universal_d_HasCouponsRequest as HasCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_HasCouponsResponse as HasCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsRequest as BulkDeleteCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_BulkDeleteCouponsResponse as BulkDeleteCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_ItemMetadata as ItemMetadata,\n ecommerceCouponsV2Coupon_universal_d_ApplicationError as ApplicationError,\n ecommerceCouponsV2Coupon_universal_d_BulkActionMetadata as BulkActionMetadata,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsRequest as BulkCreateCouponsRequest,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsResponse as BulkCreateCouponsResponse,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponResult as BulkCreateCouponResult,\n DomainEvent$2 as DomainEvent,\n DomainEventBodyOneOf$2 as DomainEventBodyOneOf,\n EntityCreatedEvent$2 as EntityCreatedEvent,\n RestoreInfo$2 as RestoreInfo,\n EntityUpdatedEvent$2 as EntityUpdatedEvent,\n EntityDeletedEvent$2 as EntityDeletedEvent,\n ActionEvent$2 as ActionEvent,\n MessageEnvelope$2 as MessageEnvelope,\n IdentificationData$2 as IdentificationData,\n IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf,\n WebhookIdentityType$2 as WebhookIdentityType,\n ecommerceCouponsV2Coupon_universal_d_createCoupon as createCoupon,\n ecommerceCouponsV2Coupon_universal_d_updateCoupon as updateCoupon,\n ecommerceCouponsV2Coupon_universal_d_getCoupon as getCoupon,\n ecommerceCouponsV2Coupon_universal_d_deleteCoupon as deleteCoupon,\n ecommerceCouponsV2Coupon_universal_d_queryCoupons as queryCoupons,\n ecommerceCouponsV2Coupon_universal_d_calculateCart as calculateCart,\n ecommerceCouponsV2Coupon_universal_d_CalculateCartOptions as CalculateCartOptions,\n ecommerceCouponsV2Coupon_universal_d_increaseUsage as increaseUsage,\n ecommerceCouponsV2Coupon_universal_d_IncreaseUsageOptions as IncreaseUsageOptions,\n ecommerceCouponsV2Coupon_universal_d_hasCoupons as hasCoupons,\n ecommerceCouponsV2Coupon_universal_d_bulkDeleteCoupons as bulkDeleteCoupons,\n ecommerceCouponsV2Coupon_universal_d_bulkCreateCoupons as bulkCreateCoupons,\n ecommerceCouponsV2Coupon_universal_d_BulkCreateCouponsOptions as BulkCreateCouponsOptions,\n };\n }\n \n interface MarketingConsent {\n /**\n * Marketing consent ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number.\n * @readonly\n */\n revision?: string | null;\n /** Marketing consent communication details. */\n details?: MarketingConsentDetails;\n /**\n * Marketing consent state.\n *\n * Default: `UNKNOWN_STATE`.\n */\n state?: MarketingConsentState;\n /**\n * Date and time the marketing consent was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the marketing consent was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Last confirmation activity of the marketing consent. */\n lastConfirmationActivity?: LastConfirmationActivity;\n /** Last revoke activity of the marketing consent. */\n lastRevokeActivity?: LastRevokeActivity;\n /** Additional fields. */\n extendedFields?: ExtendedFields;\n }\n interface MarketingConsentDetails extends MarketingConsentDetailsIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n /** The communication channel of the marketing consent. */\n type?: MarketingConsentDetailsIdentifierType;\n }\n /** @oneof */\n interface MarketingConsentDetailsIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n }\n enum MarketingConsentDetailsIdentifierType {\n UNKNOWN_TYPE = \"UNKNOWN_TYPE\",\n EMAIL = \"EMAIL\",\n PHONE = \"PHONE\"\n }\n enum MarketingConsentState {\n /** State of the marketing consent is unknown. */\n UNKNOWN_STATE = \"UNKNOWN_STATE\",\n /** The site visitor never confirmed to receive marketing consents. */\n NEVER_CONFIRMED = \"NEVER_CONFIRMED\",\n /** The marketing consent has been removed, for example, when a site visitor unsubscribes from a newsletter. */\n REVOKED = \"REVOKED\",\n /** The marketing consent is pending confirmation. Relevant only for `{\"optInLevel\": \"DOUBLE_CONFIRMATION\"}`. */\n PENDING = \"PENDING\",\n /** The site visitor has confirmed their marketing consent. */\n CONFIRMED = \"CONFIRMED\"\n }\n interface LastConfirmationActivity {\n /** Source of the given consent (how the site visitor signed up). */\n source?: Source;\n /** Consent description. */\n description?: string | null;\n /** Date and time the consent was updated. */\n _updatedDate?: Date | null;\n /** Consent opt in level, either single or double confirmation. */\n optInLevel?: OptInLevel;\n }\n enum Source {\n UNKNOWN_SOURCE = \"UNKNOWN_SOURCE\",\n IN_PERSON = \"IN_PERSON\",\n FORM = \"FORM\",\n LINK_CONFIRMATION = \"LINK_CONFIRMATION\",\n EMAIL_SERVICE = \"EMAIL_SERVICE\",\n WIX_USERS = \"WIX_USERS\",\n OTHER = \"OTHER\"\n }\n enum OptInLevel {\n UNKNOWN_OPT_IN_LEVEL = \"UNKNOWN_OPT_IN_LEVEL\",\n SINGLE_CONFIRMATION = \"SINGLE_CONFIRMATION\",\n DOUBLE_CONFIRMATION = \"DOUBLE_CONFIRMATION\"\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 LastRevokeActivity {\n /** Source of the given revoke (how the visitor signed up). */\n source?: LastRevokeActivitySource;\n /** Details about the revoke, if relevant. */\n description?: string | null;\n /** Date and time the consent was updated. */\n _updatedDate?: Date | null;\n }\n enum LastRevokeActivitySource {\n UNKNOWN_SOURCE = \"UNKNOWN_SOURCE\",\n IN_PERSON = \"IN_PERSON\",\n FORM = \"FORM\",\n REVOKE_LINK = \"REVOKE_LINK\",\n OTHER = \"OTHER\"\n }\n interface GetMarketingConsentRequest {\n /** Marketing consent ID. */\n marketingConsentId: string;\n }\n interface GetMarketingConsentResponse {\n /** The requested marketing consent. */\n marketingConsent?: MarketingConsent;\n }\n interface GetMarketingConsentByIdentifierRequest extends GetMarketingConsentByIdentifierRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n /** The communication channel of the marketing consent. */\n type: MarketingConsentDetailsIdentifierType;\n /** Language of the page */\n linkLanguage?: string | null;\n }\n /** @oneof */\n interface GetMarketingConsentByIdentifierRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n }\n interface GetMarketingConsentByIdentifierResponse {\n /** The requested marketing consent. */\n marketingConsent?: MarketingConsent;\n /** Details about whether the subject of the marketing consent is eligible to receive marketing messages. */\n communicationEligibility?: CommunicationEligibility;\n }\n interface CommunicationEligibility {\n /** Whether the recipient of the marketing consent is eligible to receive marketing messages. For example, if a visitor cancels their marketing consent, `CommunicationEligibility.granted` is `false`. Note that this only serves as a signal for your app to decide whether or not it should send marketing messages to the recipient's email address or phone number. */\n granted?: boolean;\n /** Cancellation link. */\n revokeConfirmationLink?: string | null;\n /** The reason the recipient of the marketing consent isn't eligible to receive marketing messages, for example, if the visitor unsubscribed from a newsletter. */\n reason?: string | null;\n }\n interface GetConsistentMarketingConsentByIdentifierRequest extends GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n /** The communication channel of the marketing consent. */\n type: MarketingConsentDetailsIdentifierType;\n /** Language of the page */\n linkLanguage?: string | null;\n }\n /** @oneof */\n interface GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n }\n interface GetConsistentMarketingConsentByIdentifierResponse {\n /** The requested marketing consent. */\n marketingConsent?: MarketingConsent;\n /** Details about whether the recipient of the marketing consent is eligible to receive marketing messages. */\n communicationEligibility?: CommunicationEligibility;\n }\n interface CreateMarketingConsentRequest {\n /** Marketing consent to create. */\n marketingConsent?: MarketingConsent;\n }\n interface CreateMarketingConsentResponse {\n /** Newly created marketing consent. */\n marketingConsent?: MarketingConsent;\n /** Marketing consent confirmation link. */\n link?: Link;\n }\n interface Link {\n /** Link type. */\n type?: LinkType;\n /** The link's URL. */\n url?: string;\n }\n enum LinkType {\n UNKNOWN_LINK_TYPE = \"UNKNOWN_LINK_TYPE\",\n CONFIRMATION = \"CONFIRMATION\",\n REVOKE_CONFIRMATION = \"REVOKE_CONFIRMATION\"\n }\n interface UpdateMarketingConsentRequest {\n /** Marketing consent to update. */\n marketingConsent?: MarketingConsent;\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask: string[];\n }\n interface UpdateMarketingConsentResponse {\n /** Updated marketing consent. */\n marketingConsent?: MarketingConsent;\n /** Marketing consent confirmation or cancelation link. */\n link?: Link;\n }\n interface DeleteMarketingConsentRequest {\n /** ID of the marketing consent to delete. */\n marketingConsentId: string;\n }\n interface DeleteMarketingConsentResponse {\n }\n interface RemoveMarketingConsentRequest {\n /** Marketing consent communication details. */\n details: MarketingConsentDetails;\n /** Information about the last revoke. */\n lastRevokeActivity?: LastRevokeActivity;\n }\n interface RemoveMarketingConsentResponse {\n /** The canceled marketing consent. */\n marketingConsent?: MarketingConsent;\n }\n interface CreateMarketingConsentByTokenRequest {\n /** Encrypted token with essential information */\n token: string;\n }\n interface CreateMarketingConsentByTokenResponse {\n /** The subscribed MarketingConsent */\n marketingConsent?: MarketingConsent;\n }\n interface RemoveMarketingConsentByTokenRequest {\n /** Encrypted token with essential information */\n token: string;\n }\n interface RemoveMarketingConsentByTokenResponse {\n /** The subscribed MarketingConsent */\n marketingConsent?: MarketingConsent;\n }\n interface QueryMarketingConsentRequest {\n /** Query options. */\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryMarketingConsentResponse {\n /** List of marketing consents. */\n marketingConsent?: MarketingConsent[];\n /** Details on the paged set of results returned. */\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 * Total number of items matching the filter.\n * Available only on the first page of *Search* results, not included in *Query* or *List* results.\n * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.\n * @internal\n */\n total?: number | 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 UpsertMarketingConsentRequest {\n /** Marketing consent to create or update. */\n marketingConsent?: MarketingConsent;\n }\n interface UpsertMarketingConsentResponse {\n /** Newly created or updated marketing consent. */\n marketingConsent?: MarketingConsent;\n /** Marketing consent confirmation or cancelation link. */\n link?: Link;\n }\n interface BulkUpsertMarketingConsentRequest {\n /** List of marketing consent information to update or create. */\n info?: MarketingConsent[];\n }\n interface BulkUpsertMarketingConsentResponse {\n /** List of created or updated marketing consents. */\n results?: BulkUpsertMarketingConsentResult[];\n /** Numbers of successful and failed actions. */\n metadata?: Metadata;\n }\n interface BulkUpsertMarketingConsentResult {\n /** Position of the newly created or updated marketing consent in the array. */\n originalIndex?: number;\n /** Newly created or updated marketing consent. */\n marketingConsent?: MarketingConsent;\n /** Information about the error. Only returns if the action fails. */\n error?: string | null;\n /** Marketing consent confirmation or cancelation link. */\n link?: Link;\n }\n interface Metadata {\n /** Number of successful actions. */\n totalSuccess?: number;\n /** Number of failed actions. */\n totalFailure?: number;\n }\n interface GenerateLinkRequest extends GenerateLinkRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n /** The communication channel of the marketing consent. */\n type: MarketingConsentDetailsIdentifierType;\n linkType: LinkType;\n /** Language of the page */\n language?: string | null;\n /** Arbitrary parameters for closing-the-loop. */\n metadata?: Record;\n }\n /** @oneof */\n interface GenerateLinkRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n }\n interface GenerateLinkResponse {\n /** confirmation or revoke link */\n link?: Link;\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\n /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */\n restoreInfo?: RestoreInfo$1;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and previous values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: string | null;\n }\n interface EntityDeletedEvent$1 {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n /**\n * WIP\n * @internal\n */\n additionalMetadataAsJson?: 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 marketing consent.\n * @param marketingConsentId - Marketing consent ID.\n * @public\n * @documentationMaturity preview\n * @requiredField marketingConsentId\n * @permissionId MARKETING.CONSENT_READ\n * @adminMethod\n * @returns The requested marketing consent.\n */\n function getMarketingConsent(marketingConsentId: string): Promise;\n /**\n * Retrieves a marketing consent by its details.\n * Required fields:\n * - `details.type`.\n * - `details.email` OR `details.phone`.\n *\n * >**Note:** Due to the ongoing development of our new documentation portal, the query parameter is not displaying as expected. Use the `details` object located in the marketing consent object in the request. You can also see the code example for reference.\n * @param type - The communication channel of the marketing consent.\n * @public\n * @documentationMaturity preview\n * @requiredField type\n * @param options - Field options. The relevant `email` or `phone` **must** be passed.\n * @permissionId MARKETING.CONSENT_READ\n * @adminMethod\n */\n function getMarketingConsentByIdentifier(type: MarketingConsentDetailsIdentifierType, options?: GetMarketingConsentByIdentifierOptions): Promise;\n interface GetMarketingConsentByIdentifierOptions extends GetMarketingConsentByIdentifierRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n /** Language of the page */\n linkLanguage?: string | null;\n }\n /** @param type - The communication channel of the marketing consent.\n * @internal\n * @documentationMaturity preview\n * @requiredField type\n * @permissionId MARKETING.CONSENT_READ_CONSISTENT\n * @adminMethod\n */\n function getConsistentMarketingConsentByIdentifier(type: MarketingConsentDetailsIdentifierType, options?: GetConsistentMarketingConsentByIdentifierOptions): Promise;\n interface GetConsistentMarketingConsentByIdentifierOptions extends GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n /** Language of the page */\n linkLanguage?: string | null;\n }\n /**\n * Creates a confirmed marketing consent with a `state` of `CONFIRMED`.\n * Required fields:\n * - `details.type`.\n * - `details.email` OR `details.phone`.\n * - `lastConfirmationActivity`.\n *\n * To create a marketing consent with a different state, use Upsert Marketing Consent, or Bulk Upsert Marketing Consent.\n * @param marketingConsent - Marketing consent to create.\n * @public\n * @documentationMaturity preview\n * @requiredField marketingConsent\n * @requiredField marketingConsent.details\n * @requiredField marketingConsent.lastConfirmationActivity\n * @permissionId MARKETING.CONSENT_UPSERT\n * @adminMethod\n * @returns Newly created marketing consent.\n */\n function createMarketingConsent(marketingConsent: MarketingConsent): Promise;\n /**\n * Updates a marketing consent.\n * Required fields:\n * - `details.type`.\n * - `details.email` OR `details.phone`.\n * - `state`.\n *\n * When a marketing consent's `state` is `PENDING` or `CONFIRMED`, the `info.lastConfirmationActivity` field is required.\n * When a marketing consent's `state` is `REVOKED`, the `info.lastRevokeActivity` field is required.\n *\n * >**Note:** For existing marketing consents with `{\"type\": \"EMAIL\"}`, you can't update the `state` to `UNKNOWN_STATE`. Trying to do so maintains the current state. However, you can create a new marketing consent and set the `state` to `UNKNOWN_STATE`. Note that you can't create more than a single consent per email or phone number.\n * @param _id - Marketing consent ID.\n * @public\n * @documentationMaturity preview\n * @requiredField _id\n * @requiredField options.marketingConsent.details\n * @param options - Field options. The following fields **must** be passed: `details.type`, the relevant `email` OR `phone`, and `state`.\n * @permissionId MARKETING.CONSENT_UPDATE\n * @adminMethod\n * @returns Updated marketing consent.\n */\n function updateMarketingConsent(_id: string | null, options?: UpdateMarketingConsentOptions): Promise;\n interface UpdateMarketingConsentOptions {\n marketingConsent: {\n /**\n * Marketing consent ID.\n * @readonly\n */\n _id?: string | null;\n /**\n * Revision number.\n * @readonly\n */\n revision?: string | null;\n /** Marketing consent communication details. */\n details?: MarketingConsentDetails;\n /**\n * Marketing consent state.\n *\n * Default: `UNKNOWN_STATE`.\n */\n state?: MarketingConsentState;\n /**\n * Date and time the marketing consent was created.\n * @readonly\n */\n _createdDate?: Date | null;\n /**\n * Date and time the marketing consent was updated.\n * @readonly\n */\n _updatedDate?: Date | null;\n /** Last confirmation activity of the marketing consent. */\n lastConfirmationActivity?: LastConfirmationActivity;\n /** Last revoke activity of the marketing consent. */\n lastRevokeActivity?: LastRevokeActivity;\n /** Additional fields. */\n extendedFields?: ExtendedFields;\n };\n /**\n * Explicit list of fields to update\n * @internal\n */\n mask: string[];\n }\n /**\n * Deletes a marketing consent.\n * @param marketingConsentId - ID of the marketing consent to delete.\n * @public\n * @documentationMaturity preview\n * @requiredField marketingConsentId\n * @permissionId MARKETING.CONSENT_DELETE\n * @adminMethod\n */\n function deleteMarketingConsent(marketingConsentId: string): Promise;\n /**\n * Removes a marketing consent. The consent is cancelled, and the `state` is updated to `REVOKED`.\n * The marketing consent entity still exists, but the recipient is no longer eligible to receive commmunication.\n * To delete a marketing consent entirely, use Delete Marketing Consent.\n *\n * Required fields:\n * - `details.type`.\n * - `details.email` OR `details.phone`.\n * - `info.lastRevokeActivity`.\n * @param details - Marketing consent communication details.\n * @public\n * @documentationMaturity preview\n * @requiredField details\n * @requiredField details.type\n * @param options - Field options. The `lastRevokeActivity` field **must** be passed.\n * @permissionId MARKETING.CONSENT_UPSERT\n * @adminMethod\n */\n function removeMarketingConsent(details: MarketingConsentDetails, options?: RemoveMarketingConsentOptions): Promise;\n interface RemoveMarketingConsentOptions {\n /** Information about the last revoke. */\n lastRevokeActivity?: LastRevokeActivity;\n }\n /**\n * CreateMarketingConsent the specified marketing_consent in the token\n * @param token - Encrypted token with essential information\n * @internal\n * @documentationMaturity preview\n * @requiredField token\n * @permissionId MARKETING.CONSENT_UPSERT\n * @adminMethod\n */\n function createMarketingConsentByToken(token: string): Promise;\n /**\n * RemoveMarketingConsent the specified marketing_consent in the token\n * @param token - Encrypted token with essential information\n * @internal\n * @documentationMaturity preview\n * @requiredField token\n * @permissionId MARKETING.CONSENT_UPSERT\n * @adminMethod\n */\n function removeMarketingConsentByToken(token: string): Promise;\n /**\n * Retrieves a list of marketing consents, given the provided paging, filtering, and sorting. Up to 100 marketing consents can be returned per request.\n *\n * The default `sort` is `id` in `ASC` order. For a detailed list of supported operations, see filtering and sorting for marketing consent properties. To learn how to query marketing consents, see API Query Language.\n * @public\n * @documentationMaturity preview\n * @permissionId MARKETING.CONSENT_READ\n * @adminMethod\n */\n function queryMarketingConsent(): MarketingConsentQueryBuilder;\n interface QueryCursorResult {\n cursors: Cursors;\n hasNext: () => boolean;\n hasPrev: () => boolean;\n length: number;\n pageSize: number;\n }\n interface MarketingConsentQueryResult extends QueryCursorResult {\n items: MarketingConsent[];\n query: MarketingConsentQueryBuilder;\n next: () => Promise;\n prev: () => Promise;\n }\n interface MarketingConsentQueryBuilder {\n /** @param propertyName - Property whose value is compared with `value`.\n * @param value - Value to compare against.\n * @documentationMaturity preview\n */\n eq: (propertyName: 'details.email' | 'details.phone' | 'state', value: any) => MarketingConsentQueryBuilder;\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) => MarketingConsentQueryBuilder;\n /** @param cursor - A pointer to specific record\n * @documentationMaturity preview\n */\n skipTo: (cursor: string) => MarketingConsentQueryBuilder;\n /** @documentationMaturity preview */\n find: () => Promise;\n }\n /**\n * Creates or updates a marketing consent.\n * Required fields:\n * - `details.type`.\n * - `details.email` OR `details.phone`.\n * - `state`.\n *\n * When a marketing consent's `state` is `PENDING` or `CONFIRMED`, the `info.lastConfirmationActivity` field is required.\n * When a marketing consent's `state` is `REVOKED`, the `info.lastRevokeActivity` field is required.\n *\n * >**Note:** For existing marketing consents with `{\"type\": \"EMAIL\"}`, you can't update the `state` to `UNKNOWN_STATE`. Trying to do so maintains the current state. However, you can create a new marketing consent and set the `state` to `UNKNOWN_STATE`. Note that you can't create more than a single consent per email or phone number.\n * @param marketingConsent - Marketing consent to create or update.\n * @public\n * @documentationMaturity preview\n * @requiredField marketingConsent\n * @requiredField marketingConsent.details\n * @requiredField marketingConsent.details.type\n * @permissionId MARKETING.CONSENT_UPSERT\n * @adminMethod\n */\n function upsertMarketingConsent(marketingConsent: MarketingConsent): Promise;\n /**\n * Creates or updates multiple marketing consents.\n * Required fields:\n * - `details.type`.\n * - `details.email` OR `details.phone`.\n * - `state`.\n *\n * When a marketing consent's `state` is `PENDING` or `CONFIRMED`, the `info.lastConfirmationActivity` field is required.\n * When a marketing consent's `state` is `REVOKED`, the `info.lastRevokeActivity` field is required.\n *\n * >**Note:** For existing marketing consents with `{\"type\": \"EMAIL\"}`, you can't update the `state` to `UNKNOWN_STATE`. Trying to do so maintains the current state. However, you can create a new marketing consent and set the `state` to `UNKNOWN_STATE`. Note that you can't create more than a single consent per email or phone number.\n * @param info - List of marketing consent information to update or create.\n * @public\n * @documentationMaturity preview\n * @requiredField info\n * @requiredField info.details\n * @permissionId MARKETING.CONSENT_UPSERT\n * @adminMethod\n */\n function bulkUpsertMarketingConsent(info: MarketingConsent[]): Promise;\n /**\n * Creates an unsubscribe link to be shared with the relevant recipient.\n *\n * If someone clicks the **Unsubscribe** button on the confirmation page,\n * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.\n * @param type - The communication channel of the marketing consent.\n * @internal\n * @documentationMaturity preview\n * @requiredField options.linkType\n * @requiredField type\n * @permissionId MARKETING.CONSENT_READ\n * @adminMethod\n */\n function generateLink(type: MarketingConsentDetailsIdentifierType, options?: GenerateLinkOptions): Promise;\n interface GenerateLinkOptions extends GenerateLinkRequestIdentifierOneOf {\n /** Email address used for the marketing consent. */\n email?: string;\n /** Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format used for the SMS marketing consent. */\n phone?: string;\n linkType: LinkType;\n /** Language of the page */\n language?: string | null;\n /** Arbitrary parameters for closing-the-loop. */\n metadata?: Record;\n }\n \n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsent = MarketingConsent;\n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetails = MarketingConsentDetails;\n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetailsIdentifierOneOf = MarketingConsentDetailsIdentifierOneOf;\n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetailsIdentifierType = MarketingConsentDetailsIdentifierType;\n const marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetailsIdentifierType: typeof MarketingConsentDetailsIdentifierType;\n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentState = MarketingConsentState;\n const marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentState: typeof MarketingConsentState;\n type marketingMarketingConsentV1MarketingConsent_universal_d_LastConfirmationActivity = LastConfirmationActivity;\n type marketingMarketingConsentV1MarketingConsent_universal_d_Source = Source;\n const marketingMarketingConsentV1MarketingConsent_universal_d_Source: typeof Source;\n type marketingMarketingConsentV1MarketingConsent_universal_d_OptInLevel = OptInLevel;\n const marketingMarketingConsentV1MarketingConsent_universal_d_OptInLevel: typeof OptInLevel;\n type marketingMarketingConsentV1MarketingConsent_universal_d_ExtendedFields = ExtendedFields;\n type marketingMarketingConsentV1MarketingConsent_universal_d_LastRevokeActivity = LastRevokeActivity;\n type marketingMarketingConsentV1MarketingConsent_universal_d_LastRevokeActivitySource = LastRevokeActivitySource;\n const marketingMarketingConsentV1MarketingConsent_universal_d_LastRevokeActivitySource: typeof LastRevokeActivitySource;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentRequest = GetMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentResponse = GetMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierRequest = GetMarketingConsentByIdentifierRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierRequestIdentifierOneOf = GetMarketingConsentByIdentifierRequestIdentifierOneOf;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierResponse = GetMarketingConsentByIdentifierResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CommunicationEligibility = CommunicationEligibility;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierRequest = GetConsistentMarketingConsentByIdentifierRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf = GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierResponse = GetConsistentMarketingConsentByIdentifierResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentRequest = CreateMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentResponse = CreateMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_Link = Link;\n type marketingMarketingConsentV1MarketingConsent_universal_d_LinkType = LinkType;\n const marketingMarketingConsentV1MarketingConsent_universal_d_LinkType: typeof LinkType;\n type marketingMarketingConsentV1MarketingConsent_universal_d_UpdateMarketingConsentRequest = UpdateMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_UpdateMarketingConsentResponse = UpdateMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_DeleteMarketingConsentRequest = DeleteMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_DeleteMarketingConsentResponse = DeleteMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentRequest = RemoveMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentResponse = RemoveMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentByTokenRequest = CreateMarketingConsentByTokenRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentByTokenResponse = CreateMarketingConsentByTokenResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentByTokenRequest = RemoveMarketingConsentByTokenRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentByTokenResponse = RemoveMarketingConsentByTokenResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_QueryMarketingConsentRequest = QueryMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CursorQuery = CursorQuery;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;\n type marketingMarketingConsentV1MarketingConsent_universal_d_Sorting = Sorting;\n type marketingMarketingConsentV1MarketingConsent_universal_d_SortOrder = SortOrder;\n const marketingMarketingConsentV1MarketingConsent_universal_d_SortOrder: typeof SortOrder;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CursorPaging = CursorPaging;\n type marketingMarketingConsentV1MarketingConsent_universal_d_QueryMarketingConsentResponse = QueryMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_CursorPagingMetadata = CursorPagingMetadata;\n type marketingMarketingConsentV1MarketingConsent_universal_d_Cursors = Cursors;\n type marketingMarketingConsentV1MarketingConsent_universal_d_UpsertMarketingConsentRequest = UpsertMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_UpsertMarketingConsentResponse = UpsertMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_BulkUpsertMarketingConsentRequest = BulkUpsertMarketingConsentRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_BulkUpsertMarketingConsentResponse = BulkUpsertMarketingConsentResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_BulkUpsertMarketingConsentResult = BulkUpsertMarketingConsentResult;\n type marketingMarketingConsentV1MarketingConsent_universal_d_Metadata = Metadata;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkRequest = GenerateLinkRequest;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkRequestIdentifierOneOf = GenerateLinkRequestIdentifierOneOf;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkResponse = GenerateLinkResponse;\n type marketingMarketingConsentV1MarketingConsent_universal_d_Empty = Empty;\n const marketingMarketingConsentV1MarketingConsent_universal_d_getMarketingConsent: typeof getMarketingConsent;\n const marketingMarketingConsentV1MarketingConsent_universal_d_getMarketingConsentByIdentifier: typeof getMarketingConsentByIdentifier;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierOptions = GetMarketingConsentByIdentifierOptions;\n const marketingMarketingConsentV1MarketingConsent_universal_d_getConsistentMarketingConsentByIdentifier: typeof getConsistentMarketingConsentByIdentifier;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierOptions = GetConsistentMarketingConsentByIdentifierOptions;\n const marketingMarketingConsentV1MarketingConsent_universal_d_createMarketingConsent: typeof createMarketingConsent;\n const marketingMarketingConsentV1MarketingConsent_universal_d_updateMarketingConsent: typeof updateMarketingConsent;\n type marketingMarketingConsentV1MarketingConsent_universal_d_UpdateMarketingConsentOptions = UpdateMarketingConsentOptions;\n const marketingMarketingConsentV1MarketingConsent_universal_d_deleteMarketingConsent: typeof deleteMarketingConsent;\n const marketingMarketingConsentV1MarketingConsent_universal_d_removeMarketingConsent: typeof removeMarketingConsent;\n type marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentOptions = RemoveMarketingConsentOptions;\n const marketingMarketingConsentV1MarketingConsent_universal_d_createMarketingConsentByToken: typeof createMarketingConsentByToken;\n const marketingMarketingConsentV1MarketingConsent_universal_d_removeMarketingConsentByToken: typeof removeMarketingConsentByToken;\n const marketingMarketingConsentV1MarketingConsent_universal_d_queryMarketingConsent: typeof queryMarketingConsent;\n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentQueryResult = MarketingConsentQueryResult;\n type marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentQueryBuilder = MarketingConsentQueryBuilder;\n const marketingMarketingConsentV1MarketingConsent_universal_d_upsertMarketingConsent: typeof upsertMarketingConsent;\n const marketingMarketingConsentV1MarketingConsent_universal_d_bulkUpsertMarketingConsent: typeof bulkUpsertMarketingConsent;\n const marketingMarketingConsentV1MarketingConsent_universal_d_generateLink: typeof generateLink;\n type marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkOptions = GenerateLinkOptions;\n namespace marketingMarketingConsentV1MarketingConsent_universal_d {\n export {\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsent as MarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetails as MarketingConsentDetails,\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetailsIdentifierOneOf as MarketingConsentDetailsIdentifierOneOf,\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentDetailsIdentifierType as MarketingConsentDetailsIdentifierType,\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentState as MarketingConsentState,\n marketingMarketingConsentV1MarketingConsent_universal_d_LastConfirmationActivity as LastConfirmationActivity,\n marketingMarketingConsentV1MarketingConsent_universal_d_Source as Source,\n marketingMarketingConsentV1MarketingConsent_universal_d_OptInLevel as OptInLevel,\n marketingMarketingConsentV1MarketingConsent_universal_d_ExtendedFields as ExtendedFields,\n marketingMarketingConsentV1MarketingConsent_universal_d_LastRevokeActivity as LastRevokeActivity,\n marketingMarketingConsentV1MarketingConsent_universal_d_LastRevokeActivitySource as LastRevokeActivitySource,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentRequest as GetMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentResponse as GetMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierRequest as GetMarketingConsentByIdentifierRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierRequestIdentifierOneOf as GetMarketingConsentByIdentifierRequestIdentifierOneOf,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierResponse as GetMarketingConsentByIdentifierResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_CommunicationEligibility as CommunicationEligibility,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierRequest as GetConsistentMarketingConsentByIdentifierRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf as GetConsistentMarketingConsentByIdentifierRequestIdentifierOneOf,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierResponse as GetConsistentMarketingConsentByIdentifierResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentRequest as CreateMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentResponse as CreateMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_Link as Link,\n marketingMarketingConsentV1MarketingConsent_universal_d_LinkType as LinkType,\n marketingMarketingConsentV1MarketingConsent_universal_d_UpdateMarketingConsentRequest as UpdateMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_UpdateMarketingConsentResponse as UpdateMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_DeleteMarketingConsentRequest as DeleteMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_DeleteMarketingConsentResponse as DeleteMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentRequest as RemoveMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentResponse as RemoveMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentByTokenRequest as CreateMarketingConsentByTokenRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_CreateMarketingConsentByTokenResponse as CreateMarketingConsentByTokenResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentByTokenRequest as RemoveMarketingConsentByTokenRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentByTokenResponse as RemoveMarketingConsentByTokenResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_QueryMarketingConsentRequest as QueryMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_CursorQuery as CursorQuery,\n marketingMarketingConsentV1MarketingConsent_universal_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf,\n marketingMarketingConsentV1MarketingConsent_universal_d_Sorting as Sorting,\n marketingMarketingConsentV1MarketingConsent_universal_d_SortOrder as SortOrder,\n marketingMarketingConsentV1MarketingConsent_universal_d_CursorPaging as CursorPaging,\n marketingMarketingConsentV1MarketingConsent_universal_d_QueryMarketingConsentResponse as QueryMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_CursorPagingMetadata as CursorPagingMetadata,\n marketingMarketingConsentV1MarketingConsent_universal_d_Cursors as Cursors,\n marketingMarketingConsentV1MarketingConsent_universal_d_UpsertMarketingConsentRequest as UpsertMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_UpsertMarketingConsentResponse as UpsertMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_BulkUpsertMarketingConsentRequest as BulkUpsertMarketingConsentRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_BulkUpsertMarketingConsentResponse as BulkUpsertMarketingConsentResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_BulkUpsertMarketingConsentResult as BulkUpsertMarketingConsentResult,\n marketingMarketingConsentV1MarketingConsent_universal_d_Metadata as Metadata,\n marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkRequest as GenerateLinkRequest,\n marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkRequestIdentifierOneOf as GenerateLinkRequestIdentifierOneOf,\n marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkResponse as GenerateLinkResponse,\n marketingMarketingConsentV1MarketingConsent_universal_d_Empty as Empty,\n DomainEvent$1 as DomainEvent,\n DomainEventBodyOneOf$1 as DomainEventBodyOneOf,\n EntityCreatedEvent$1 as EntityCreatedEvent,\n RestoreInfo$1 as RestoreInfo,\n EntityUpdatedEvent$1 as EntityUpdatedEvent,\n EntityDeletedEvent$1 as EntityDeletedEvent,\n ActionEvent$1 as ActionEvent,\n MessageEnvelope$1 as MessageEnvelope,\n IdentificationData$1 as IdentificationData,\n IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf,\n WebhookIdentityType$1 as WebhookIdentityType,\n marketingMarketingConsentV1MarketingConsent_universal_d_getMarketingConsent as getMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_getMarketingConsentByIdentifier as getMarketingConsentByIdentifier,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetMarketingConsentByIdentifierOptions as GetMarketingConsentByIdentifierOptions,\n marketingMarketingConsentV1MarketingConsent_universal_d_getConsistentMarketingConsentByIdentifier as getConsistentMarketingConsentByIdentifier,\n marketingMarketingConsentV1MarketingConsent_universal_d_GetConsistentMarketingConsentByIdentifierOptions as GetConsistentMarketingConsentByIdentifierOptions,\n marketingMarketingConsentV1MarketingConsent_universal_d_createMarketingConsent as createMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_updateMarketingConsent as updateMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_UpdateMarketingConsentOptions as UpdateMarketingConsentOptions,\n marketingMarketingConsentV1MarketingConsent_universal_d_deleteMarketingConsent as deleteMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_removeMarketingConsent as removeMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_RemoveMarketingConsentOptions as RemoveMarketingConsentOptions,\n marketingMarketingConsentV1MarketingConsent_universal_d_createMarketingConsentByToken as createMarketingConsentByToken,\n marketingMarketingConsentV1MarketingConsent_universal_d_removeMarketingConsentByToken as removeMarketingConsentByToken,\n marketingMarketingConsentV1MarketingConsent_universal_d_queryMarketingConsent as queryMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentQueryResult as MarketingConsentQueryResult,\n marketingMarketingConsentV1MarketingConsent_universal_d_MarketingConsentQueryBuilder as MarketingConsentQueryBuilder,\n marketingMarketingConsentV1MarketingConsent_universal_d_upsertMarketingConsent as upsertMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_bulkUpsertMarketingConsent as bulkUpsertMarketingConsent,\n marketingMarketingConsentV1MarketingConsent_universal_d_generateLink as generateLink,\n marketingMarketingConsentV1MarketingConsent_universal_d_GenerateLinkOptions as GenerateLinkOptions,\n };\n }\n \n interface AdsTxt {\n /** Content of Ads.txt. */\n content?: string;\n /** Whether the current Ads.txt file is Wix's default. */\n default?: boolean;\n /**\n * Subdomain of the Ads.txt file. For example, `www`, `es`, or `fr`.\n *\n * Default: `www`\n */\n subdomain?: string;\n /**\n * ID of the `adsTxt` object.\n * @internal\n */\n _id?: string;\n }\n /** The request to get the Ads.txt file content */\n interface GetAdsTxtRequest {\n /**\n * Subdomain of the Ads.txt file. For example, `www`, `es`, or `fr`.\n *\n * Default: `www`\n */\n subdomain?: string;\n }\n /** The response of the Ads.txt file request */\n interface GetAdsTxtResponse {\n /** Retrieved `adsTxt` object. */\n adsTxt?: AdsTxt;\n }\n /** The request to update the content of the Ads.txt file */\n interface UpdateAdsTxtRequest {\n /**\n * Details about how to replace the existing Ads.txt file.\n * To reset the Ads.txt file to Wix's default, set `default` to `true` and omit `content`.\n */\n adsTxt?: AdsTxt;\n }\n interface UpdateAdsTxtResponse {\n /** Updated `adsTxt` object. */\n adsTxt?: AdsTxt;\n }\n /** The request to append the content of the Ads.txt file */\n interface AppendAdsTxtRequest {\n /**\n * Details to add to the existing Ads.txt file.\n * To reset the Ads.txt file to Wix's default, set `default` to `true` and omit `content`.\n */\n adsTxt?: AdsTxt;\n }\n interface AppendAdsTxtResponse {\n /** Updated `adsTxt` object. */\n adsTxt?: AdsTxt;\n }\n interface DomainEvent extends DomainEventBodyOneOf {\n createdEvent?: EntityCreatedEvent;\n /** Triggered when the Ads.txt file is updated. */\n updatedEvent?: EntityUpdatedEvent;\n deletedEvent?: EntityDeletedEvent;\n /** Triggered when the Ads.txt file is updated. */\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 /**\n * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | null;\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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n * @deprecated\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\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 Ads.txt file.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when retrieving the Ads.txt file.\n * @permissionId PROMOTE.ADS_TXT_READ\n * @adminMethod\n * @returns The response of the Ads.txt file request\n */\n function getAdsTxt(options?: GetAdsTxtOptions): Promise;\n interface GetAdsTxtOptions {\n /**\n * Subdomain of the Ads.txt file. For example, `www`, `es`, or `fr`.\n *\n * Default: `www`\n */\n subdomain?: string;\n }\n /**\n * Replaces the Ads.txt file.\n *\n * When setting `content` to an empty string, an empty Ads.txt file is created. To reset Ads.txt to Wix's default, set `default` to `true` and omit `content`.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when replacing the Ads.txt file.\n * @permissionId PROMOTE.ADS_TXT_WRITE\n * @adminMethod\n */\n function updateAdsTxt(options?: UpdateAdsTxtOptions): Promise;\n interface UpdateAdsTxtOptions {\n /**\n * Details about how to replace the existing Ads.txt file.\n * To reset the Ads.txt file to Wix's default, set `default` to `true` and omit `content`.\n */\n adsTxt?: AdsTxt;\n }\n /**\n * Adds `content` to the Ads.txt file.\n *\n * To reset the Ads.txt file to Wix's default, set `default` to `true` and omit `content`.\n * @public\n * @documentationMaturity preview\n * @param options - Options to use when appending the Ads.txt file.\n * @permissionId PROMOTE.ADS_TXT_WRITE\n * @adminMethod\n */\n function appendAdsTxt(options?: AppendAdsTxtOptions): Promise;\n interface AppendAdsTxtOptions {\n /**\n * Details to add to the existing Ads.txt file.\n * To reset the Ads.txt file to Wix's default, set `default` to `true` and omit `content`.\n */\n adsTxt?: AdsTxt;\n }\n \n type promoteMarketingV2AdsTxt_universal_d_AdsTxt = AdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_GetAdsTxtRequest = GetAdsTxtRequest;\n type promoteMarketingV2AdsTxt_universal_d_GetAdsTxtResponse = GetAdsTxtResponse;\n type promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtRequest = UpdateAdsTxtRequest;\n type promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtResponse = UpdateAdsTxtResponse;\n type promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtRequest = AppendAdsTxtRequest;\n type promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtResponse = AppendAdsTxtResponse;\n type promoteMarketingV2AdsTxt_universal_d_DomainEvent = DomainEvent;\n type promoteMarketingV2AdsTxt_universal_d_DomainEventBodyOneOf = DomainEventBodyOneOf;\n type promoteMarketingV2AdsTxt_universal_d_EntityCreatedEvent = EntityCreatedEvent;\n type promoteMarketingV2AdsTxt_universal_d_RestoreInfo = RestoreInfo;\n type promoteMarketingV2AdsTxt_universal_d_EntityUpdatedEvent = EntityUpdatedEvent;\n type promoteMarketingV2AdsTxt_universal_d_EntityDeletedEvent = EntityDeletedEvent;\n type promoteMarketingV2AdsTxt_universal_d_ActionEvent = ActionEvent;\n type promoteMarketingV2AdsTxt_universal_d_MessageEnvelope = MessageEnvelope;\n type promoteMarketingV2AdsTxt_universal_d_IdentificationData = IdentificationData;\n type promoteMarketingV2AdsTxt_universal_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;\n type promoteMarketingV2AdsTxt_universal_d_WebhookIdentityType = WebhookIdentityType;\n const promoteMarketingV2AdsTxt_universal_d_WebhookIdentityType: typeof WebhookIdentityType;\n const promoteMarketingV2AdsTxt_universal_d_getAdsTxt: typeof getAdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_GetAdsTxtOptions = GetAdsTxtOptions;\n const promoteMarketingV2AdsTxt_universal_d_updateAdsTxt: typeof updateAdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtOptions = UpdateAdsTxtOptions;\n const promoteMarketingV2AdsTxt_universal_d_appendAdsTxt: typeof appendAdsTxt;\n type promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtOptions = AppendAdsTxtOptions;\n namespace promoteMarketingV2AdsTxt_universal_d {\n export {\n promoteMarketingV2AdsTxt_universal_d_AdsTxt as AdsTxt,\n promoteMarketingV2AdsTxt_universal_d_GetAdsTxtRequest as GetAdsTxtRequest,\n promoteMarketingV2AdsTxt_universal_d_GetAdsTxtResponse as GetAdsTxtResponse,\n promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtRequest as UpdateAdsTxtRequest,\n promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtResponse as UpdateAdsTxtResponse,\n promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtRequest as AppendAdsTxtRequest,\n promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtResponse as AppendAdsTxtResponse,\n promoteMarketingV2AdsTxt_universal_d_DomainEvent as DomainEvent,\n promoteMarketingV2AdsTxt_universal_d_DomainEventBodyOneOf as DomainEventBodyOneOf,\n promoteMarketingV2AdsTxt_universal_d_EntityCreatedEvent as EntityCreatedEvent,\n promoteMarketingV2AdsTxt_universal_d_RestoreInfo as RestoreInfo,\n promoteMarketingV2AdsTxt_universal_d_EntityUpdatedEvent as EntityUpdatedEvent,\n promoteMarketingV2AdsTxt_universal_d_EntityDeletedEvent as EntityDeletedEvent,\n promoteMarketingV2AdsTxt_universal_d_ActionEvent as ActionEvent,\n promoteMarketingV2AdsTxt_universal_d_MessageEnvelope as MessageEnvelope,\n promoteMarketingV2AdsTxt_universal_d_IdentificationData as IdentificationData,\n promoteMarketingV2AdsTxt_universal_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf,\n promoteMarketingV2AdsTxt_universal_d_WebhookIdentityType as WebhookIdentityType,\n promoteMarketingV2AdsTxt_universal_d_getAdsTxt as getAdsTxt,\n promoteMarketingV2AdsTxt_universal_d_GetAdsTxtOptions as GetAdsTxtOptions,\n promoteMarketingV2AdsTxt_universal_d_updateAdsTxt as updateAdsTxt,\n promoteMarketingV2AdsTxt_universal_d_UpdateAdsTxtOptions as UpdateAdsTxtOptions,\n promoteMarketingV2AdsTxt_universal_d_appendAdsTxt as appendAdsTxt,\n promoteMarketingV2AdsTxt_universal_d_AppendAdsTxtOptions as AppendAdsTxtOptions,\n };\n }\n \n export { promoteMarketingV2AdsTxt_universal_d as adsTxt, ecommerceCouponsV2Coupon_universal_d as coupons, marketingMarketingConsentV1MarketingConsent_universal_d as marketingConsent };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-currencies.v2.d.ts", "content": "declare module \"wix-currencies.v2\" {\n const __debug: {\n verboseLogging: {\n on: () => boolean;\n off: () => boolean;\n };\n };\n interface CurrencyRate {\n }\n interface ListCurrenciesRequest {\n }\n interface ListCurrenciesResponse {\n /** Supported currencies */\n currencies?: Currency[];\n }\n interface Currency {\n /** 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. */\n from: string;\n /** Target currency. */\n to: string;\n }\n interface DecimalValue {\n /** Value without decimals (e.g., for 10.95 value will be 1095). */\n value?: string;\n /** Decimal places to apply (e.g., for 10.95 decimal_places will be 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. */\n from: string;\n /** Target currency. */\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 all currencies currently supported by Wix.\n * @public\n * @documentationMaturity preview\n */\n function listCurrencies(): Promise;\n /**\n * Returns a list of converted amounts, from the original (from) currency to the target (to) currency.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.from\n * @requiredField identifiers.to\n */\n function convertCurrency(identifiers: ConvertCurrencyIdentifiers, options?: ConvertCurrencyOptions): Promise;\n interface ConvertCurrencyIdentifiers {\n /** Original currency. */\n from: string;\n /** Target currency. */\n to: string;\n }\n interface ConvertCurrencyOptions {\n /** Amounts to convert. */\n amounts?: DecimalValue[];\n }\n /**\n * Returns the conversion rate between 2 currencies.\n * @public\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.from\n * @requiredField identifiers.to\n */\n function conversionRate(identifiers: ConversionRateIdentifiers): Promise;\n interface ConversionRateIdentifiers {\n /** Original currency. */\n from: string;\n /** Target currency. */\n to: string;\n }\n \n const ecommerceCurrencyConverterV1CurrencyRate_universal_d___debug: typeof __debug;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_CurrencyRate = CurrencyRate;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ListCurrenciesRequest = ListCurrenciesRequest;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ListCurrenciesResponse = ListCurrenciesResponse;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_Currency = Currency;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyRequest = ConvertCurrencyRequest;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_DecimalValue = DecimalValue;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyResponse = ConvertCurrencyResponse;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConversionRateRequest = ConversionRateRequest;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConversionRateResponse = ConversionRateResponse;\n const ecommerceCurrencyConverterV1CurrencyRate_universal_d_listCurrencies: typeof listCurrencies;\n const ecommerceCurrencyConverterV1CurrencyRate_universal_d_convertCurrency: typeof convertCurrency;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyIdentifiers = ConvertCurrencyIdentifiers;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyOptions = ConvertCurrencyOptions;\n const ecommerceCurrencyConverterV1CurrencyRate_universal_d_conversionRate: typeof conversionRate;\n type ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConversionRateIdentifiers = ConversionRateIdentifiers;\n namespace ecommerceCurrencyConverterV1CurrencyRate_universal_d {\n export {\n ecommerceCurrencyConverterV1CurrencyRate_universal_d___debug as __debug,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_CurrencyRate as CurrencyRate,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ListCurrenciesRequest as ListCurrenciesRequest,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ListCurrenciesResponse as ListCurrenciesResponse,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_Currency as Currency,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyRequest as ConvertCurrencyRequest,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_DecimalValue as DecimalValue,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyResponse as ConvertCurrencyResponse,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConversionRateRequest as ConversionRateRequest,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConversionRateResponse as ConversionRateResponse,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_listCurrencies as listCurrencies,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_convertCurrency as convertCurrency,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyIdentifiers as ConvertCurrencyIdentifiers,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConvertCurrencyOptions as ConvertCurrencyOptions,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_conversionRate as conversionRate,\n ecommerceCurrencyConverterV1CurrencyRate_universal_d_ConversionRateIdentifiers as ConversionRateIdentifiers,\n };\n }\n \n export { ecommerceCurrencyConverterV1CurrencyRate_universal_d as currencyConverter };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-members-about-backend.v1.d.ts", "content": "declare module \"wix-members-about-backend.v1\" {\n interface About {\n /** Member ID. */\n memberId?: string;\n /** About content. */\n content?: string;\n }\n interface SaveAboutDraftRequest {\n /** Member ID. */\n memberId: string;\n /** About content. */\n content: string;\n }\n interface SaveAboutDraftResponse {\n /** About content. */\n content?: string;\n /** State of the about. */\n state?: State;\n }\n enum State {\n /** Published version, visible to other members. */\n PUBLIC = \"PUBLIC\",\n /** Not published version, visible only to oneself. */\n DRAFT = \"DRAFT\"\n }\n interface SaveMyAboutDraftRequest {\n /** About content. */\n content: string;\n }\n interface SaveMyAboutDraftResponse {\n /** About content. */\n content?: string;\n /** State of the about. */\n state?: State;\n }\n interface TooManyLinksInAboutContent {\n }\n interface TextTooLongInAboutContent {\n }\n interface PublishAboutRequest {\n /** Member ID. */\n memberId: string;\n }\n interface PublishAboutResponse {\n /** About content. */\n content?: string;\n /** State of the about. */\n state?: State;\n }\n interface PublishMyAboutRequest {\n }\n interface PublishMyAboutResponse {\n /** About content. */\n content?: string;\n /** State of the about. */\n state?: State;\n }\n interface GetAboutRequest {\n /** Member ID. */\n memberId: string;\n /**\n * State of the about.\n * Defaults to `PUBLIC` state when not provided.\n */\n state: State;\n }\n interface GetAboutResponse {\n /** About content. */\n content?: string;\n /** State of the about. */\n state?: State;\n }\n interface QueryAboutsRequest {\n /** Query options. */\n query?: QueryV2;\n }\n interface QueryV2 {\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 the results. */\n sorting?: Sorting[];\n /** Paging options to limit and skip the number of items. */\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 * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by\n * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.\n *\n * If multiple filters are provided, they are combined with AND operator.\n *\n * Example:\n * Given we have document like {\"id\": \"1\", \"nestedField\": [{\"price\": 10, \"region\": \"EU\"}, {\"price\": 20, \"region\": \"US\"}]}\n * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be\n * { fieldName: \"nestedField.price\", \"select_items_by\": [{\"nestedField.region\": \"US\"}] }\n * @internal\n */\n selectItemsBy?: Record[] | null;\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 QueryAboutsResponse {\n /**\n * List of about entities.\n * Only the *public* entities are included.\n */\n abouts?: About[];\n /** Metadata for the paginated results. */\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 * 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 * @internal\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 DiscardMyChangesRequest {\n }\n interface DiscardMyChangesResponse {\n }\n /**\n * Saves member's about as draft.\n * @param memberId - Member ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField memberId\n * @requiredField options\n * @requiredField options.content\n * @permissionId MEMBERS.ABOUT_MANAGE_DRAFT\n * @adminMethod\n */\n function saveAboutDraft(memberId: string, options: SaveAboutDraftOptions): Promise;\n interface SaveAboutDraftOptions {\n /** About content. */\n content: string;\n }\n /**\n * Saves currently logged in member's about as draft.\n * @param content - About content.\n * @internal\n * @documentationMaturity preview\n * @requiredField content\n * @permissionId MEMBERS.ABOUT_MANAGE_MY_DRAFT\n * @adminMethod\n */\n function saveMyAboutDraft(content: string): Promise;\n /**\n * Makes member's about draft public.\n * @param memberId - Member ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField memberId\n * @permissionId MEMBERS.ABOUT_PUBLISH\n * @adminMethod\n */\n function publishAbout(memberId: string): Promise;\n /**\n * Makes currently logged in member's about draft public.\n * @internal\n * @documentationMaturity preview\n * @permissionId MEMBERS.ABOUT_PUBLISH_MY\n */\n function publishMyAbout(): Promise;\n /**\n * Retrieves member's about.\n * @internal\n * @documentationMaturity preview\n * @requiredField identifiers\n * @requiredField identifiers.memberId\n * @requiredField identifiers.state\n * @permissionId MEMBERS.ABOUT_READ\n */\n function getAbout(identifiers: GetAboutIdentifiers): Promise;\n interface GetAboutIdentifiers {\n /** Member ID. */\n memberId: string;\n /**\n * State of the about.\n * Defaults to `PUBLIC` state when not provided.\n */\n state: State;\n }\n /**\n * Retrieves about entities.\n * Only the *public* entities are included.\n *\n * Supported fields for filtering:\n * - `memberId`\n *\n * Supported fields for sorting:\n * - `memberId`\n * @internal\n * @documentationMaturity preview\n * @permissionId MEMBERS.ABOUT_READ\n */\n function queryAbouts(options?: QueryAboutsOptions): Promise;\n interface QueryAboutsOptions {\n /** Query options. */\n query?: QueryV2;\n }\n /**\n * Discard currently logged in member's unpublished changes.\n * @internal\n * @documentationMaturity preview\n * @permissionId MEMBERS.ABOUT_MANAGE_MY_DRAFT\n * @adminMethod\n */\n function discardMyChanges(): Promise;\n \n export { About, Cursors, DiscardMyChangesRequest, DiscardMyChangesResponse, GetAboutIdentifiers, GetAboutRequest, GetAboutResponse, Paging, PagingMetadataV2, PublishAboutRequest, PublishAboutResponse, PublishMyAboutRequest, PublishMyAboutResponse, QueryAboutsOptions, QueryAboutsRequest, QueryAboutsResponse, QueryV2, SaveAboutDraftOptions, SaveAboutDraftRequest, SaveAboutDraftResponse, SaveMyAboutDraftRequest, SaveMyAboutDraftResponse, SortOrder, Sorting, State, TextTooLongInAboutContent, TooManyLinksInAboutContent, discardMyChanges, getAbout, publishAbout, publishMyAbout, queryAbouts, saveAboutDraft, saveMyAboutDraft };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/wix-members-followers-backend.v2.d.ts", "content": "declare module \"wix-members-followers-backend.v2\" {\n interface Follower {\n /** Member ID of the member who performed the action. */\n memberId?: string;\n /** Member ID of the member being followed or unfollowed. */\n affectedMemberId?: string;\n }\n interface FollowMemberRequest {\n /** Member ID. */\n memberId: string;\n }\n interface FollowMemberResponse {\n }\n interface MemberFollowed {\n /** Member who is following the other member. */\n memberConnection?: Follower;\n }\n interface UnfollowMemberRequest {\n /** Member ID. */\n memberId: string;\n }\n interface UnfollowMemberResponse {\n }\n interface MemberUnfollowed {\n /** Member who is unfollowing the other member. */\n memberConnection?: Follower;\n }\n interface ListMyMemberFollowingRequest {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\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 ListMyMemberFollowingResponse {\n /** List of site members who are followed by the current member. */\n memberIds?: string[];\n /** Metadata for the paginated results. */\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 * 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 * @internal\n */\n hasNext?: boolean | null;\n }\n interface ListMemberFollowingRequest {\n /** Member ID. */\n memberId: string;\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging;\n }\n interface ListMemberFollowingResponse {\n /** List of site members who are followed by the requested member. */\n memberIds?: string[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadata;\n }\n interface ListMyMemberFollowersRequest {\n /** Metadata for the paginated results. */\n paging?: Paging;\n }\n interface ListMyMemberFollowersResponse {\n /** List of members who are following the current member. */\n memberIds?: string[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadata;\n }\n interface ListMemberFollowersRequest {\n /** Member ID. */\n memberId: string;\n /** Metadata for the paginated results. */\n paging?: Paging;\n }\n interface ListMemberFollowersResponse {\n /** List of members who are following the request member. */\n memberIds?: string[];\n /** Metadata for the paginated results. */\n pagingMetadata?: PagingMetadata;\n }\n interface ListMyMemberConnectionsRequest {\n /**\n * List of member IDs whose connections to the current member\n * will be retrieved.\n */\n connectedMemberIds: string[];\n }\n interface ListMyMemberConnectionsResponse {\n /** List of site members whose connections to the current member were retrieved. */\n connectedMembers?: ConnectedMembers[];\n }\n interface ConnectedMembers {\n /** Site member ID. */\n connectedMemberId?: string;\n /** Indicates if the listed member is followed by the requested member. */\n followedByMember?: boolean;\n /** Indicates if the listed member is following the requested member. */\n followingMember?: boolean;\n }\n interface ListMemberConnectionsRequest {\n /**\n * List of member IDs whose connections to the requested member\n * will be retrieved.\n * For multiple connections, format as\n * `?connectedMemberIds=member-1-id&connectedMemberIds=member-2-id`.\n */\n connectedMemberIds: string[];\n /** ID of the requested member. */\n memberId: string;\n }\n interface ListMemberConnectionsResponse {\n /** List of site members whose connections to the requested member were retrieved. */\n connectedMembers?: ConnectedMembers[];\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 * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity\n * @internal\n */\n triggeredByUndelete?: boolean | 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 * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard\n * wont populate it / have any reference to it in the API.\n * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,\n * the developer should send only the new (current) entity.\n * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big\n * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.\n * @internal\n */\n previousEntityAsJson?: string | null;\n /**\n * WIP - This property will hold both names and values of the updated fields of the entity.\n * For more details please see [adr](https://docs.google.com/document/d/1PdqsOM20Ph2HAkmx8zvUnzzk3Sekp3BR9h34wSvsRnI/edit#heading=h.phlw87mh2imx) or [issue](https://github.com/wix-private/nile-tracker/issues/363)\n * @internal\n */\n modifiedFields?: Record;\n }\n interface EntityDeletedEvent {\n /**\n * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled\n * @internal\n */\n movedToTrash?: boolean | null;\n /** Entity that was deleted */\n deletedEntityAsJson?: string | null;\n }\n interface ActionEvent {\n bodyAsJson?: string;\n }\n /**\n * Sets the current member to follow another member.\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 memberId - Member ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField memberId\n */\n function followMember(memberId: string): Promise;\n /** @param memberId - Member ID.\n * @internal\n * @documentationMaturity preview\n * @requiredField memberId\n */\n function unfollowMember(memberId: string): Promise;\n /**\n * Returns IDs of members followed by the member making the call\n * @internal\n * @documentationMaturity preview\n */\n function listMyMemberFollowing(options?: ListMyMemberFollowingOptions): Promise;\n interface ListMyMemberFollowingOptions {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging;\n }\n /** @param memberId - Member ID.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n */\n function listMemberFollowing(memberId: string, options?: ListMemberFollowingOptions): Promise;\n interface ListMemberFollowingOptions {\n /**\n * Pagination options. For more information, see\n * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).\n */\n paging?: Paging;\n }\n /**\n * Returns IDs of members who follow the member making the call\n * @internal\n * @documentationMaturity preview\n */\n function listMyMemberFollowers(options?: ListMyMemberFollowersOptions): Promise;\n interface ListMyMemberFollowersOptions {\n /** Metadata for the paginated results. */\n paging?: Paging;\n }\n /**\n * Lists members who follow the requested member.\n * @param memberId - Member ID.\n * @public\n * @documentationMaturity preview\n * @requiredField memberId\n */\n function listMemberFollowers(memberId: string, options?: ListMemberFollowersOptions): Promise;\n interface ListMemberFollowersOptions {\n /** Metadata for the paginated results. */\n paging?: Paging;\n }\n /**\n * Returns information if provided site members are followers or are followed by the member making the call.\n * @param connectedMemberIds - List of member IDs whose connections to the current member\n * will be retrieved.\n * @internal\n * @documentationMaturity preview\n * @requiredField connectedMemberIds\n */\n function listMyMemberConnections(connectedMemberIds: string[]): Promise;\n /**\n * Lists a member's follower or following connections to the other members specified in the request.\n * > Note: If no other members' IDs (`connectedMemberIds`) are passed, the call will return successful, but with no data.\n * @param memberId - ID of the requested member.\n * @param connectedMemberIds - List of member IDs whose connections to the requested member\n * will be retrieved.\n * For multiple connections, format as\n * `?connectedMemberIds=member-1-id&connectedMemberIds=member-2-id`.\n * @public\n * @documentationMaturity preview\n * @requiredField connectedMemberIds\n * @requiredField memberId\n */\n function listMemberConnections(memberId: string, connectedMemberIds: string[]): Promise;\n \n export { ActionEvent, ConnectedMembers, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FollowMemberRequest, FollowMemberResponse, Follower, ListMemberConnectionsRequest, ListMemberConnectionsResponse, ListMemberFollowersOptions, ListMemberFollowersRequest, ListMemberFollowersResponse, ListMemberFollowingOptions, ListMemberFollowingRequest, ListMemberFollowingResponse, ListMyMemberConnectionsRequest, ListMyMemberConnectionsResponse, ListMyMemberFollowersOptions, ListMyMemberFollowersRequest, ListMyMemberFollowersResponse, ListMyMemberFollowingOptions, ListMyMemberFollowingRequest, ListMyMemberFollowingResponse, MemberFollowed, MemberUnfollowed, Paging, PagingMetadata, UnfollowMemberRequest, UnfollowMemberResponse, followMember, listMemberConnections, listMemberFollowers, listMemberFollowing, listMyMemberConnections, listMyMemberFollowers, listMyMemberFollowing, unfollowMember };\n}\n" }, { "path": "@wix/wix-code-types/dist/types/beta/common/interfaces-components-translation-v1-translations-provider.d.ts", "content": "declare module \"interfaces-components-translation-v1-translations-provider\" {\n type BusinessError = {\n __tag: 'BusinessError';\n httpCode: string;\n errorDescription: string;\n applicationCode: string;\n messageSchema: string;\n data: T;\n };\n \n interface GetAdditionalKeysRequest {\n /** components that have been created or have been modified */\n component?: Component;\n }\n /** Component is the main entity of ComponentsService */\n interface Component {\n /** Component Id */\n _id?: string | null;\n /**\n * The version of the component: None (the mutable instance) or Long (versioned immutable). Domain Entity has 0 instead of None for proper indexing\n * @readonly\n */\n version?: string | null;\n /** The app id of the application which this component belongs to */\n appId?: string;\n /** The name of the component */\n name?: string | null;\n /**\n * the type of the component\n * @readonly\n */\n type?: ComponentType;\n /** the data of the component */\n data?: ComponentData;\n /**\n * revision of draft component\n * @readonly\n */\n revision?: string | null;\n externalId?: string | null;\n createdBy?: CreatedBy;\n /** @readonly */\n _createdDate?: Date;\n /** @readonly */\n _updatedDate?: Date;\n }\n /** Component type */\n enum ComponentType {\n NONE = \"NONE\",\n STUDIO = \"STUDIO\",\n PLATFORM = \"PLATFORM\",\n WORKER = \"WORKER\",\n DASHBOARD = \"DASHBOARD\",\n WIDGET = \"WIDGET\",\n PAGE = \"PAGE\",\n DASHBOARD_PLATFORM = \"DASHBOARD_PLATFORM\",\n STUDIO_WIDGET = \"STUDIO_WIDGET\",\n EMBEDDED_SCRIPT = \"EMBEDDED_SCRIPT\",\n EXTENSION = \"EXTENSION\",\n SNIPPET_SOLUTION = \"SNIPPET_SOLUTION\",\n DATA_COMPONENT = \"DATA_COMPONENT\",\n WEB = \"WEB\",\n DC_CONFIG = \"DC_CONFIG\",\n WIDGET_OUT_OF_IFRAME = \"WIDGET_OUT_OF_IFRAME\",\n PAGE_OUT_OF_IFRAME = \"PAGE_OUT_OF_IFRAME\",\n STATIC_FILE = \"STATIC_FILE\",\n APP_CONFIG = \"APP_CONFIG\",\n MULTIPLE_DASHBOARDS = \"MULTIPLE_DASHBOARDS\",\n PAYMENTS_GATEWAY = \"PAYMENTS_GATEWAY\",\n CODE_PACKAGE = \"CODE_PACKAGE\",\n AUTOMATION_TRIGGER = \"AUTOMATION_TRIGGER\",\n INVOICES_ACTIONS = \"INVOICES_ACTIONS\",\n DASHBOARD_APPLICATION = \"DASHBOARD_APPLICATION\",\n CONTACT_LABELS = \"CONTACT_LABELS\",\n WIDGET_PLUGIN = \"WIDGET_PLUGIN\",\n CROSS_SELL = \"CROSS_SELL\",\n LOCAL_DELIVERY = \"LOCAL_DELIVERY\",\n PAYMENT_PROVIDER = \"PAYMENT_PROVIDER\",\n ECOM_MEMBERSHIPS = \"ECOM_MEMBERSHIPS\",\n ECOM_LINE_ITEMS_ENRICHER = \"ECOM_LINE_ITEMS_ENRICHER\",\n ECOM_SHIPPING_RATES = \"ECOM_SHIPPING_RATES\",\n SHIPPING_LABEL_CARRIER = \"SHIPPING_LABEL_CARRIER\",\n RESTAURANTS_POS = \"RESTAURANTS_POS\",\n FICTIONAL_SHIPPING_PROVIDER = \"FICTIONAL_SHIPPING_PROVIDER\",\n ALERT_ENRICHER = \"ALERT_ENRICHER\",\n DATA_EXTENSIONS = \"DATA_EXTENSIONS\",\n GENERIC_HOOKS = \"GENERIC_HOOKS\",\n AUTOMATIONS_ACTION_PROVIDER = \"AUTOMATIONS_ACTION_PROVIDER\",\n ECOM_CATALOG = \"ECOM_CATALOG\",\n BACK_OFFICE_EXTENSION_CONTAINER = \"BACK_OFFICE_EXTENSION_CONTAINER\",\n BACK_OFFICE_EXTENSION = \"BACK_OFFICE_EXTENSION\",\n AUTOMATIONS_TRIGGER_PROVIDER = \"AUTOMATIONS_TRIGGER_PROVIDER\",\n IDENTITY_PRE_REGISTRATION = \"IDENTITY_PRE_REGISTRATION\",\n PREMIUM_PRODUCTS_PATHS = \"PREMIUM_PRODUCTS_PATHS\",\n ECOM_CUSTOM_SCOPE = \"ECOM_CUSTOM_SCOPE\",\n GIFT_CARDS_PROVIDER = \"GIFT_CARDS_PROVIDER\",\n DEALER_EXTERNAL_FILTER_PROVIDER = \"DEALER_EXTERNAL_FILTER_PROVIDER\",\n ECOM_DROPSHIPPING_PROVIDER = \"ECOM_DROPSHIPPING_PROVIDER\",\n INVOICES_PROVIDER = \"INVOICES_PROVIDER\",\n SEO_KEYWORDS_SUGGESTIONS = \"SEO_KEYWORDS_SUGGESTIONS\",\n ECOM_DISCOUNTS_TRIGGER = \"ECOM_DISCOUNTS_TRIGGER\",\n MULTILINGUAL_CONTENT_PROVIDER = \"MULTILINGUAL_CONTENT_PROVIDER\",\n APPLICATION_AUTOMATION = \"APPLICATION_AUTOMATION\",\n BACK_OFFICE_SIDEBAR_CATEGORY = \"BACK_OFFICE_SIDEBAR_CATEGORY\",\n BACK_OFFICE_PAGE = \"BACK_OFFICE_PAGE\",\n ECOM_ADDITIONAL_FEES = \"ECOM_ADDITIONAL_FEES\",\n PING_USER_NOTIFICATION = \"PING_USER_NOTIFICATION\",\n ECOM_RECOMMENDATIONS_PROVIDER = \"ECOM_RECOMMENDATIONS_PROVIDER\",\n BOOKINGS_PRICING_PROVIDER = \"BOOKINGS_PRICING_PROVIDER\",\n IDENTITY_AUTHENTICATOR = \"IDENTITY_AUTHENTICATOR\",\n IDENTITY_IDP_CONNECTOR = \"IDENTITY_IDP_CONNECTOR\",\n ITEMS_SELECTION_PROVIDER = \"ITEMS_SELECTION_PROVIDER\",\n PORTFOLIO_SYNCED_PROJECTS_PROVIDER = \"PORTFOLIO_SYNCED_PROJECTS_PROVIDER\",\n COMMUNICATION_CHANNEL = \"COMMUNICATION_CHANNEL\",\n IDENTITY_POST_LOGIN = \"IDENTITY_POST_LOGIN\",\n BACK_OFFICE_WIDGET = \"BACK_OFFICE_WIDGET\",\n SOCIAL_MARKETING_DESIGN = \"SOCIAL_MARKETING_DESIGN\",\n FORMS_SUBMISSIONS_PROVIDER = \"FORMS_SUBMISSIONS_PROVIDER\",\n WIX_OFFERING = \"WIX_OFFERING\",\n DEV_CENTER_TESTING_COMPONENT = \"DEV_CENTER_TESTING_COMPONENT\",\n COMPONENTS_VALIDATOR_PROVIDER = \"COMPONENTS_VALIDATOR_PROVIDER\",\n COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER = \"COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER\",\n FORMS_SCHEMA_PROVIDER = \"FORMS_SCHEMA_PROVIDER\",\n BOOKINGS_EXTERNAL_CALENDAR_PROVIDER = \"BOOKINGS_EXTERNAL_CALENDAR_PROVIDER\",\n ECOM_DEFAULT_TAXATION_CATEGORY = \"ECOM_DEFAULT_TAXATION_CATEGORY\",\n VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER = \"VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER\",\n PING_UOU_NOTIFICATION = \"PING_UOU_NOTIFICATION\",\n HEADLESS_OAUTH = \"HEADLESS_OAUTH\",\n ECOM_TAX_CALCULATOR_SPI = \"ECOM_TAX_CALCULATOR_SPI\",\n COMMENTS_MODERATION_PROVIDER = \"COMMENTS_MODERATION_PROVIDER\",\n GRID_APP_FILES_TRANSFORMER = \"GRID_APP_FILES_TRANSFORMER\",\n BENEFIT_PROGRAMS_POLICY_PROVIDER = \"BENEFIT_PROGRAMS_POLICY_PROVIDER\",\n PREMIUM_CUSTOM_CHARGES = \"PREMIUM_CUSTOM_CHARGES\",\n ECOM_VALIDATIONS = \"ECOM_VALIDATIONS\",\n COMPONENT_REFERENCE_DATA_PROVIDER = \"COMPONENT_REFERENCE_DATA_PROVIDER\",\n WIX_REVIEWS_PRODUCT_CATALOG = \"WIX_REVIEWS_PRODUCT_CATALOG\",\n SOCIAL_MARKETING_DESIGNS_PROVIDER = \"SOCIAL_MARKETING_DESIGNS_PROVIDER\",\n GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER = \"GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER\",\n COMMENTS_FILTER_PROVIDER = \"COMMENTS_FILTER_PROVIDER\",\n BILLING_TAX_ID_VALIDATOR = \"BILLING_TAX_ID_VALIDATOR\",\n PING_SETTINGS_GROUP = \"PING_SETTINGS_GROUP\",\n FORMS_SPAM_SUBMISSIONS_PROVIDER = \"FORMS_SPAM_SUBMISSIONS_PROVIDER\",\n EDITOR_ADDON = \"EDITOR_ADDON\",\n EXTERNAL_DATABASE_PROVIDER = \"EXTERNAL_DATABASE_PROVIDER\",\n ECOM_PAYMENT_SETTINGS = \"ECOM_PAYMENT_SETTINGS\",\n NOTIFICATION_TOPIC = \"NOTIFICATION_TOPIC\",\n NOTIFICATION_PREFERENCES_FILTER_PROVIDER = \"NOTIFICATION_PREFERENCES_FILTER_PROVIDER\",\n BOOKINGS_RESOURCE_TYPES_PROVIDER = \"BOOKINGS_RESOURCE_TYPES_PROVIDER\",\n PRICING_PLANS_FORM_CONFIGURATION = \"PRICING_PLANS_FORM_CONFIGURATION\",\n USER_NOTIFICATION = \"USER_NOTIFICATION\",\n CONTACT_NOTIFICATION = \"CONTACT_NOTIFICATION\",\n UNIFIED_PAGE = \"UNIFIED_PAGE\",\n AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER = \"AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER\",\n PROPOSAL_EDITOR_PROVIDER = \"PROPOSAL_EDITOR_PROVIDER\",\n CUSTOM_TABLE_RESERVATIONS_PROVIDER = \"CUSTOM_TABLE_RESERVATIONS_PROVIDER\",\n COMMENTS_CONTEXT_PROVIDER = \"COMMENTS_CONTEXT_PROVIDER\",\n FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER = \"FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER\",\n AUTOMATIONS_VELO_ACTION_PROVIDER = \"AUTOMATIONS_VELO_ACTION_PROVIDER\",\n CALENDAR_EVENT_TYPE_PROVIDER = \"CALENDAR_EVENT_TYPE_PROVIDER\",\n /** Reserved - previously was `SERVICE_AVAILABILITY_POLICY_PROVIDER` */\n RESERVED = \"RESERVED\",\n SMS_ACTION_MESSAGE = \"SMS_ACTION_MESSAGE\",\n BOOKING_POLICY_PROVIDER = \"BOOKING_POLICY_PROVIDER\",\n MULTI_SERVICE_BOOKING_POLICY_PROVIDER = \"MULTI_SERVICE_BOOKING_POLICY_PROVIDER\",\n AI_ASSISTANT = \"AI_ASSISTANT\",\n FORMS_SUBMISSIONS_EXTENSION_PROVIDER = \"FORMS_SUBMISSIONS_EXTENSION_PROVIDER\",\n MULTILINGUAL_TRANSLATION_SCHEMA = \"MULTILINGUAL_TRANSLATION_SCHEMA\",\n TAX_CALCULATION_PROVIDER = \"TAX_CALCULATION_PROVIDER\",\n TAX_GROUPS_PROVIDER = \"TAX_GROUPS_PROVIDER\",\n BACK_OFFICE_MODAL = \"BACK_OFFICE_MODAL\",\n DEPLOYMENT_PIPELINE_PROVIDER = \"DEPLOYMENT_PIPELINE_PROVIDER\",\n CUSTOM_ELEMENT_WIDGET = \"CUSTOM_ELEMENT_WIDGET\",\n BACK_OFFICE_EXTENSION_WIDGET = \"BACK_OFFICE_EXTENSION_WIDGET\",\n BACK_OFFICE_EXTENSION_MENU_ITEM = \"BACK_OFFICE_EXTENSION_MENU_ITEM\",\n FORM_TEMPLATE = \"FORM_TEMPLATE\",\n NOTIFICATION_CONTENT = \"NOTIFICATION_CONTENT\",\n BROADCAST_LIST = \"BROADCAST_LIST\",\n PARTNERS_PAYOUTS = \"PARTNERS_PAYOUTS\",\n WIX_REVIEWS_ENTITY_CATALOG = \"WIX_REVIEWS_ENTITY_CATALOG\",\n VELO_PUBLISH_PIPELINE_TASK_PROVIDER = \"VELO_PUBLISH_PIPELINE_TASK_PROVIDER\",\n FUNCTIONS_SHOP_PRICE_PROVIDER = \"FUNCTIONS_SHOP_PRICE_PROVIDER\",\n FUNCTION = \"FUNCTION\"\n }\n /** Component data */\n interface ComponentData extends ComponentDataDataOneOf {\n /**\n * Create a widget iframe that users can display on their site. We recommend submitting a proposal before using iframes in your app.\n * Learn More: https://devforum.wix.com/en/article/widget-components\n */\n widgetComponentData?: WidgetComponentData;\n /**\n * Display an iframe as a page on a user's site.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/iframes/guide-to-page-extensions\n */\n pageComponentData?: PageComponentData;\n /**\n * Load a WOOI directly in the Editor DOM.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/editor-widget-out-of-iframe/widget-out-of-iframe-component-data-object\n * @internal\n */\n widgetOutOfIframeData?: WidgetOutOfIframeComponentData;\n /**\n * Load a POOI directly in the Editor DOM.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/editor-page-out-of-iframe/page-out-of-iframe-component-data-object\n * @internal\n */\n pageOutOfIframeData?: PageOutOfIframeComponentData;\n /**\n * Load a collection of native Editor components directly in the Editor DOM.\n * Learn More: https://bo.wix.com/wix-docs/fe-guild/editor-platform\n * @internal\n */\n platformComponentData?: PlatfromComponentData;\n /**\n * Open an iframe in the Dashboard, or add a link to a page on your platform.\n * Learn More: https://devforum.wix.com/en/article/create-a-dashboard-page-component\n */\n dashboardComponentData?: DashboardComponentData;\n /**\n * Use an invisible iframe to track activity. It’s added to every page on the site (max. 1).\n * Learn More: https://devforum.wix.com/en/article/worker-components\n */\n workerComponentData?: WorkerComponentData;\n /**\n * Use Wix Blocks to create a widget component. Wix Blocks will open in a new tab.\n * Learn More: https://bo.wix.com/wix-docs/rest/drafts/wix-blocks-server---app-builder\n * @internal\n */\n studioComponentData?: StudioComponentData;\n /**\n * A widget component in the Wix Blocks.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/wix-blocks\n * @internal\n */\n studioWidgetComponentData?: StudioWidgetComponentData;\n /**\n * A component that indicates the existence of an importable code package in a Wix Blocks application.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/wix-blocks-code-package\n * @internal\n */\n codePackageComponentData?: CodePackageComponentData;\n /**\n * Load a collection of native components directly in the Business Manager.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/dashboard-platfrom/dashboard-platfrom-component-data-object\n * @internal\n */\n dashboardPlatformComponentData?: DashboardPlatfromComponentData;\n /**\n * Inject a script into a site’s HTML code.\n * Learn More: https://devforum.wix.com/en/article/about-embedded-script-components\n */\n embeddedScriptComponentData?: EmbeddedScriptComponentData;\n /**\n * Display a draggable component in the Editor using an HTML custom element.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-custom-element\n */\n webComponentData?: WebComponentData;\n /**\n * Extend app with internal Wix extension.\n * @internal\n */\n extensionData?: ExtensionData;\n /** @internal */\n snippetSolutionsData?: SnippetSolutionData;\n /** @internal */\n dataComponent?: DataComponent;\n /** @internal */\n dcConfigData?: DCConfigData;\n /**\n * Serve a file from the user’s site domain.\n * Learn More: https://devforum.wix.com/en/article/serving-staic-files-from-the-installed-sites-domain\n * @internal\n */\n staticFileComponentData?: StaticFileComponentData;\n /** @internal */\n appConfig?: AppConfig;\n /**\n * Create a multi-page dashboard in the Business Manager.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/multiple-dashboards\n * @internal\n */\n multipleDashboardsComponentData?: MultipleDashboardsComponentData;\n /**\n * Payments gateway extension description\n * @internal\n */\n paymentsGateway?: PaymentsGatewayComponentData;\n /**\n * Extend an app with automation capabilities using CRM Automations\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/automation-trigger\n * @internal\n */\n automationTrigger?: AutomationTrigger;\n /**\n * Any restrictions on invoices actions\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/invoices-actions\n * @internal\n */\n invoicesActionsComponentData?: InvoicesActionsComponentData;\n /**\n * Experimental-WIP: Business manager app_config, configures a module and its page components in business manager.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/dashboard-application\n * @internal\n */\n dashboardApplicationData?: DashboardApplicationData;\n /**\n * Contact Labels Components\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/contact-labels\n * @internal\n */\n contactLabels?: ContactLabelsComponentData;\n /**\n * Display a widget that fits into a predefined slot in a Wix app.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/plugins/about-plugins\n */\n widgetPlugin?: WidgetPluginComponentData;\n /**\n * Cross Sell Integration\n * @internal\n */\n crossSell?: CrossSellConfig;\n /**\n * Experimental-WIP: Local Delivery extension description.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/local-delivery\n * @internal\n */\n localDelivery?: LocalDeliveryComponentData;\n /**\n * WIP: Velo payment provider SPI\n * @internal\n */\n paymentProvider?: PaymentServiceProviderConfig;\n /**\n * Memberships SPI for ECOM platform\n * @internal\n */\n ecomMemberships?: MembershipsSPIConfig;\n /**\n * Line Items Enricher SPI for ECOM platform\n * @internal\n */\n ecomLineItemsEnricher?: LineItemsEnricherConfig;\n /**\n * Displays the options from your Shipping Rates SPI in a site's cart and checkout.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/shipping-rates-integration-spi/introduction\n */\n ecomShippingRates?: ShippingRatesConfig;\n /**\n * Shipping Label Carrier SPI\n * @internal\n */\n shippingLabelCarrier?: ShippingLabelCarrierSpiConfig;\n /**\n * Restaurants POS SPI\n * @internal\n */\n restaurantsPos?: RestaurantsPOSComponentData;\n /**\n * A fictional Shipping SPI that is used by developers to complete SPI training\n * https://github.com/wix-academy/spi-in-scala-path\n * @internal\n */\n fictionalShippingProvider?: ShippingProviderConfig;\n /**\n * Alert Enricher Integration\n * @internal\n */\n alertEnricher?: AlertEnricherSpiConfiguration;\n /** Extend a Wix entity with custom fields for your app */\n dataExtensions?: DataExtensionsComponentData;\n /**\n * A common component type for all Generic Hooks\n * @internal\n */\n genericHooks?: GenericHooksConfig;\n /**\n * WIP: automations action provider\n * @internal\n */\n automationsActionProvider?: ActionProviderSPIConfig;\n /**\n * Catalog SPI for ECOM platform\n * @internal\n */\n ecomCatalog?: CatalogSPIConfig;\n /**\n * Add a space to a Wix Dashboard page that can be extended with a widget or menu item.\n * @internal\n */\n backOfficeExtensionContainer?: BackOfficeExtensionContainer;\n /**\n * Create a widget or menu item that will be rendered within a Wix Dashboard page.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-wix-dashboard-extension\n * @internal\n */\n backOfficeExtension?: BackOfficeExtension;\n /**\n * WIP: automations trigger provider\n * @internal\n */\n automationsTriggerProvider?: TriggerProviderSPIConfig;\n /**\n * WIP - SPI for execution before identity creation in the new IAM platform\n * @internal\n */\n identityPreRegistration?: PreRegisterConfig;\n /**\n * Premium products upgrades/downgrades\n * @internal\n */\n premiumProductsPaths?: ProductsPathsConfig;\n /**\n * ECOM custom scopes provider - define scopes of catalog items based custom attributes\n * @internal\n */\n ecomCustomScope?: CustomScopeConfig;\n /**\n * Gift Card SPI for Ecom Platform\n * @internal\n */\n giftCardsProvider?: GiftCardProviderConfig;\n /**\n * Dealer External Filter SPI\n * @internal\n */\n dealerExternalFilterProvider?: ExternalFilterProviderConfig;\n /**\n * Recommendations provider SPI\n * @internal\n */\n ecomRecommendationsProvider?: RecommendationsProviderConfig;\n /**\n * Dropshipping Provider SPI for Ecom Platform\n * @internal\n */\n ecomDropshippingProvider?: DropshippingProviderSPIConfig;\n /**\n * Invoices SPI\n * @internal\n */\n invoicesProvider?: InvoicesConfig;\n /**\n * Provide SEO keyword suggestions to site collaborators, report quota usage, and provide a page where users can upgrade their plan.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/marketing/seo-keywords-suggestions-v-1/introduction\n */\n seoKeywordsSuggestions?: SeoKeywordsSuggestionsSPIConfig;\n /**\n * Ecom custom discount trigger SPI provider - define custom triggers to apply discount rules\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/custom-discount-triggers-integration-spi/introduction\n * @internal\n */\n ecomDiscountsTrigger?: CustomTriggerConfig;\n /**\n * Multilingual content provider for site translator to read and update translations\n * @internal\n */\n multilingualContentProvider?: ContentProviderConfig;\n /**\n * Application Automation\n * @internal\n */\n applicationAutomation?: ApplicationAutomationComponent;\n /**\n * Experimental-WIP: A back office page category\n * @internal\n */\n backOfficeSidebarCategory?: BackOfficeSidebarCategory;\n /**\n * Configure a page for your app that will be embedded in the Wix Dashboard.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-dashboard-page-component\n */\n backOfficePage?: BackOfficePage;\n /**\n * Displays the fees from your Additional Fees SPI in a site's cart and checkout.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/additional-fees-integration-spi/introduction\n */\n ecomAdditionalFees?: AdditionalFeesSPIConfig;\n /**\n * Send notifications to your app users\n * @internal\n */\n pingUserNotification?: PingNotificationComponentData;\n /**\n * Bookings Pricing Provider SPI\n * @internal\n */\n bookingsPricingProvider?: BookingsPricingProviderConfig;\n /**\n * Authenticator SPI\n * @internal\n */\n identityAuthenticator?: AuthenticatorConfig;\n /**\n * WIP - SPI for authenticating via external IDP in the new IAM platform\n * @internal\n */\n identityIdpConnector?: IDPConnectionConfig;\n /**\n * Items Selection\n * @internal\n */\n itemsSelectionProvider?: ItemsSelectionProviderConfig;\n /**\n * Portfolio synced projects provider\n * @internal\n */\n portfolioSyncedProjectsProvider?: SyncedProjectsProviderConfig;\n /**\n * Communication Channel\n * @internal\n */\n communicationChannel?: CommunicationChannelConfiguration;\n /**\n * WIP - SPI to run after the login process\n * @internal\n */\n identityPostLogin?: PostLoginConfig;\n /**\n * Create a component that can be easily placed in or opened from a Wix app page.\n * @internal\n */\n backOfficeWidget?: BackOfficeWidget;\n /**\n * Social Marketing Design SPI\n * @internal\n */\n socialMarketingDesign?: SocialMarketingDesignSPIConfig;\n /**\n * Forms Submissions SPI\n * @internal\n */\n formsSubmissionsProvider?: FormSubmissionSpiConfig;\n /**\n * Wix Offering\n * @internal\n */\n wixOffering?: WixOfferingComponentData;\n /**\n * Components translation test component\n * @internal\n */\n devCenterTestingComponent?: DevCenterTestingComponentData;\n /**\n * Components Validator SPI\n * @internal\n */\n componentsValidatorProvider?: ComponentsValidatorConfig;\n /**\n * Components Translations additional fields config\n * @internal\n */\n componentsTranslationsAdditionalFieldsProvider?: ComponentTranslationAdditionalFieldsConfig;\n /**\n * Forms Schema SPI\n * @internal\n */\n formsSchemaProvider?: FormSchemaSpiConfig;\n /**\n * Bookings External Calendar Provider\n * @internal\n */\n bookingsExternalCalendarProvider?: ProviderConfig;\n /**\n * Default Tax Category Config\n * Learn More: https://bo.wix.com/wix-docs/rest/drafts/platform-tax\n * @internal\n */\n ecomDefaultTaxationCategory?: DefaultTaxGroupProviderConfig;\n /**\n * Viewer Dynamic Site Structure Config\n * @internal\n */\n viewerDynamicSiteStructureProvider?: DynamicSiteStructureProviderConfig;\n /**\n * Send notifications to your app users of users\n * @internal\n */\n pingUouNotification?: PingNotificationComponentData;\n /**\n * Holds data for authenticating Headless Applications\n * @internal\n */\n headlessOauth?: HeadlessOAuth;\n /**\n * Tax Calculator Structure Config\n * Learn More: https://bo.wix.com/wix-docs/rest/drafts/platform-tax\n * @internal\n */\n ecomTaxCalculatorSpi?: TaxCalculatorSpiConfig;\n /**\n * Comments Moderation Provider Config\n * @internal\n */\n commentsModerationProvider?: CommentModerationProviderConfig;\n /**\n * GridApp files transformer config\n * @internal\n */\n gridAppFilesTransformer?: GridAppFilesTransformerConfig;\n /**\n * Holds benefit programs policy provider configuration\n * @internal\n */\n benefitProgramsPolicyProvider?: PolicyConfig;\n /**\n * Premium Custom Charges Config\n * Learn More: https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/introduction\n */\n premiumCustomCharges?: CustomChargesConfig;\n /**\n * Performs Validations for a site's cart and checkout.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/validations-integration-spi/introduction\n */\n ecomValidations?: ValidationsSPIConfig;\n /**\n * Component Reference Data SPI\n * @internal\n */\n componentReferenceDataProvider?: ComponentReferenceDataConfig;\n /**\n * Wix Reviews SPI\n * @internal\n */\n wixReviewsProductCatalog?: ReviewsProductCatalogProviderConfig;\n /**\n * Promote Social Marketing Designs Provider Configuration\n * @internal\n */\n socialMarketingDesignsProvider?: SocialMarketingDesignsProviderConfig;\n /**\n * Promote Google Business Profile Provider Configuration\n * @internal\n */\n googleBusinessProfileFeatureProvider?: GbpFeatureConfig;\n /**\n * Comments Filter Provider Config\n * @internal\n */\n commentsFilterProvider?: CommentFilterProviderConfig;\n /**\n * Tax ID Validator SPI Config\n * @internal\n */\n billingTaxIdValidator?: TaxIdValidatorConfig;\n /**\n * Ping Settings Group Data\n * @internal\n */\n pingSettingsGroup?: PingSettingsGroupComponentData;\n /**\n * Forms Spam Submissions SPI\n * @internal\n */\n formsSpamSubmissionsProvider?: FormSpamSubmissionSpiConfig;\n /**\n * Editor Addon component\n * @internal\n */\n editorAddon?: EditorAddon;\n /**\n * External Database component\n * @internal\n */\n externalDatabaseProvider?: ExternalDatabaseSpiConfig;\n /**\n * Ecom Payment Settings SPI Config\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/payment-settings-integration-spi/introduction\n */\n ecomPaymentSettings?: PaymentSettingsSPIConfig;\n /**\n * Group multiple notifications into one preference toggle.\n * Learn More: https://dev.wix.com/docs/build-apps/build-your-app/user-notifications/add-notification-topics\n * @internal\n */\n notificationTopic?: NotificationTopic;\n /**\n * Notification Preference SPI\n * @internal\n */\n notificationPreferencesFilterProvider?: NotificationPreferencesFilterConfig;\n /**\n * Bookings Resource Types provider SPI config\n * @internal\n */\n bookingsResourceTypesProvider?: BookingsResourceTypesProviderConfig;\n /**\n * Pricing Plans form configuration\n * @internal\n */\n pricingPlansFormConfiguration?: PricingPlansFormConfiguration;\n /**\n * Create a notification to alert your app users about important updates and events.\n * Learn More: https://dev.wix.com/docs/build-apps/build-your-app/user-notifications/app-notifications\n * @internal\n */\n userNotification?: UserNotification;\n /**\n * Contact Notification\n * @internal\n */\n contactNotification?: ContactNotification;\n /**\n * Add a site page that displays selected widgets.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/create-a-site-page\n * @internal\n */\n unifiedPage?: UnifiedPage;\n /**\n * Availability Time Slots Configuration Provider SPI\n * @internal\n */\n availabilityTimeSlotsConfigurationProvider?: AvailabilityTimeSlotsProviderConfig;\n /**\n * Proposal Editor Provider SPI config\n * @internal\n */\n proposalEditorProvider?: ProposalEditorProviderConfig;\n /**\n * Custom Table Reservations Provider SPI config\n * @internal\n */\n customTableReservationsProvider?: CustomReservationsApprovalConfig;\n /**\n * Comments Context provider\n * @internal\n */\n commentsContextProvider?: CommentsContextProviderConfig;\n /**\n * Forms Spam Submission Reports SPI\n * @internal\n */\n formsSpamSubmissionReportsProvider?: FormSpamSubmissionReportSpiConfig;\n /**\n * Automation Velo Action Spi Provider\n * @internal\n */\n automationsVeloActionProvider?: VeloActionConfig;\n /**\n * Calendar Event Type Provider\n * @internal\n */\n calendarEventTypeProvider?: EventTypeProviderConfig;\n /**\n * Reserved - previously was `service_availability_policy_provider`\n * @internal\n */\n reserved?: ServiceAvailabilityPolicyProviderConfig;\n /**\n * Create an SMS message for a pre-installed automation, in order to translate it.\n * @internal\n */\n smsActionMessage?: SmsActionMessage;\n /**\n * Booking Policy Provider SPI\n * @internal\n */\n bookingPolicyProvider?: BookingPolicyProviderConfig;\n /**\n * Multi Service Booking Policy Provider SPI\n * @internal\n */\n multiServiceBookingPolicyProvider?: MultiServiceBookingPolicyProviderConfig;\n /**\n * Forms Submissions Extension SPI\n * @internal\n */\n formsSubmissionsExtensionProvider?: FormSubmissionSpiExtensionConfig;\n /**\n * AI Assistant SPI\n * @internal\n */\n aiAssistant?: AssistantSpiConfig;\n /**\n * Multilingual translation schema\n * @internal\n */\n multilingualTranslationSchema?: MultilingualTranslationSchema;\n /**\n * Tax Groups Provider SPI\n * @internal\n */\n taxGroupsProvider?: TaxGroupsProviderConfig;\n /**\n * Tax Calculation Provider SPI\n * @internal\n */\n taxCalculationProvider?: TaxCalculationConfig;\n /** Create a reusable modal that can be utilized across multiple pages within your app and in other applications. */\n backOfficeModal?: BackOfficeModal;\n /**\n * Deployment Pipeline Provider SPI\n * @internal\n */\n deploymentPipelineProvider?: DeploymentPipelineProviderConfig;\n /**\n * Display a draggable widget on a site using a self-hosted custom element.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/build-a-site-widget-using-a-self-hosted-custom-element\n * @internal\n */\n customElementWidget?: CustomElementWidget;\n /**\n * Create a widget that will be rendered within a Wix Dashboard page.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-wix-dashboard-extension\n * @internal\n */\n backOfficeExtensionWidget?: BackOfficeExtensionWidget;\n /**\n * Create a menu item that will be rendered within a Wix Dashboard page.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-wix-dashboard-extension\n * @internal\n */\n backOfficeExtensionMenuItem?: BackOfficeExtensionMenuItem;\n /**\n * Form Template\n * @internal\n */\n formTemplate?: FormTemplate;\n /**\n * Notification Content\n * @internal\n */\n notificationContent?: NotificationContent;\n /**\n * Broadcast List\n * @internal\n */\n broadcastList?: BroadcastList;\n /**\n * Partners Payouts\n * @internal\n */\n partnersPayouts?: PayoutsProviderConfig;\n /**\n * Wix Reviews Entity Catalog Provider SPI\n * @internal\n */\n wixReviewsEntityCatalog?: ReviewsEntityCatalogProviderConfig;\n /**\n * Velo Publish Pipeline Task Provider SPI\n * @internal\n */\n veloPublishPipelineTaskProvider?: VeloPublishPipelineTaskProviderConfig;\n /**\n * Function shop POC SPI\n * @internal\n */\n functionsShopPriceProvider?: FunctionsShopPriceSpiConfig;\n /**\n * Function\n * @internal\n */\n function?: Function;\n }\n /** @oneof */\n interface ComponentDataDataOneOf {\n /**\n * Create a widget iframe that users can display on their site. We recommend submitting a proposal before using iframes in your app.\n * Learn More: https://devforum.wix.com/en/article/widget-components\n */\n widgetComponentData?: WidgetComponentData;\n /**\n * Display an iframe as a page on a user's site.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/iframes/guide-to-page-extensions\n */\n pageComponentData?: PageComponentData;\n /**\n * Load a WOOI directly in the Editor DOM.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/editor-widget-out-of-iframe/widget-out-of-iframe-component-data-object\n * @internal\n */\n widgetOutOfIframeData?: WidgetOutOfIframeComponentData;\n /**\n * Load a POOI directly in the Editor DOM.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/editor-page-out-of-iframe/page-out-of-iframe-component-data-object\n * @internal\n */\n pageOutOfIframeData?: PageOutOfIframeComponentData;\n /**\n * Load a collection of native Editor components directly in the Editor DOM.\n * Learn More: https://bo.wix.com/wix-docs/fe-guild/editor-platform\n * @internal\n */\n platformComponentData?: PlatfromComponentData;\n /**\n * Open an iframe in the Dashboard, or add a link to a page on your platform.\n * Learn More: https://devforum.wix.com/en/article/create-a-dashboard-page-component\n */\n dashboardComponentData?: DashboardComponentData;\n /**\n * Use an invisible iframe to track activity. It’s added to every page on the site (max. 1).\n * Learn More: https://devforum.wix.com/en/article/worker-components\n */\n workerComponentData?: WorkerComponentData;\n /**\n * Use Wix Blocks to create a widget component. Wix Blocks will open in a new tab.\n * Learn More: https://bo.wix.com/wix-docs/rest/drafts/wix-blocks-server---app-builder\n * @internal\n */\n studioComponentData?: StudioComponentData;\n /**\n * A widget component in the Wix Blocks.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/wix-blocks\n * @internal\n */\n studioWidgetComponentData?: StudioWidgetComponentData;\n /**\n * A component that indicates the existence of an importable code package in a Wix Blocks application.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/wix-blocks-code-package\n * @internal\n */\n codePackageComponentData?: CodePackageComponentData;\n /**\n * Load a collection of native components directly in the Business Manager.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/dashboard-platfrom/dashboard-platfrom-component-data-object\n * @internal\n */\n dashboardPlatformComponentData?: DashboardPlatfromComponentData;\n /**\n * Inject a script into a site’s HTML code.\n * Learn More: https://devforum.wix.com/en/article/about-embedded-script-components\n */\n embeddedScriptComponentData?: EmbeddedScriptComponentData;\n /**\n * Display a draggable component in the Editor using an HTML custom element.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-custom-element\n */\n webComponentData?: WebComponentData;\n /**\n * Extend app with internal Wix extension.\n * @internal\n */\n extensionData?: ExtensionData;\n /** @internal */\n snippetSolutionsData?: SnippetSolutionData;\n /** @internal */\n dataComponent?: DataComponent;\n /** @internal */\n dcConfigData?: DCConfigData;\n /**\n * Serve a file from the user’s site domain.\n * Learn More: https://devforum.wix.com/en/article/serving-staic-files-from-the-installed-sites-domain\n * @internal\n */\n staticFileComponentData?: StaticFileComponentData;\n /** @internal */\n appConfig?: AppConfig;\n /**\n * Create a multi-page dashboard in the Business Manager.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/multiple-dashboards\n * @internal\n */\n multipleDashboardsComponentData?: MultipleDashboardsComponentData;\n /**\n * Payments gateway extension description\n * @internal\n */\n paymentsGateway?: PaymentsGatewayComponentData;\n /**\n * Extend an app with automation capabilities using CRM Automations\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/automation-trigger\n * @internal\n */\n automationTrigger?: AutomationTrigger;\n /**\n * Any restrictions on invoices actions\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/invoices-actions\n * @internal\n */\n invoicesActionsComponentData?: InvoicesActionsComponentData;\n /**\n * Experimental-WIP: Business manager app_config, configures a module and its page components in business manager.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/dashboard-application\n * @internal\n */\n dashboardApplicationData?: DashboardApplicationData;\n /**\n * Contact Labels Components\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/contact-labels\n * @internal\n */\n contactLabels?: ContactLabelsComponentData;\n /**\n * Display a widget that fits into a predefined slot in a Wix app.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/plugins/about-plugins\n */\n widgetPlugin?: WidgetPluginComponentData;\n /**\n * Cross Sell Integration\n * @internal\n */\n crossSell?: CrossSellConfig;\n /**\n * Experimental-WIP: Local Delivery extension description.\n * Learn More: https://bo.wix.com/wix-docs/rnd/dev-center/components-catalog/local-delivery\n * @internal\n */\n localDelivery?: LocalDeliveryComponentData;\n /**\n * WIP: Velo payment provider SPI\n * @internal\n */\n paymentProvider?: PaymentServiceProviderConfig;\n /**\n * Memberships SPI for ECOM platform\n * @internal\n */\n ecomMemberships?: MembershipsSPIConfig;\n /**\n * Line Items Enricher SPI for ECOM platform\n * @internal\n */\n ecomLineItemsEnricher?: LineItemsEnricherConfig;\n /**\n * Displays the options from your Shipping Rates SPI in a site's cart and checkout.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/shipping-rates-integration-spi/introduction\n */\n ecomShippingRates?: ShippingRatesConfig;\n /**\n * Shipping Label Carrier SPI\n * @internal\n */\n shippingLabelCarrier?: ShippingLabelCarrierSpiConfig;\n /**\n * Restaurants POS SPI\n * @internal\n */\n restaurantsPos?: RestaurantsPOSComponentData;\n /**\n * A fictional Shipping SPI that is used by developers to complete SPI training\n * https://github.com/wix-academy/spi-in-scala-path\n * @internal\n */\n fictionalShippingProvider?: ShippingProviderConfig;\n /**\n * Alert Enricher Integration\n * @internal\n */\n alertEnricher?: AlertEnricherSpiConfiguration;\n /** Extend a Wix entity with custom fields for your app */\n dataExtensions?: DataExtensionsComponentData;\n /**\n * A common component type for all Generic Hooks\n * @internal\n */\n genericHooks?: GenericHooksConfig;\n /**\n * WIP: automations action provider\n * @internal\n */\n automationsActionProvider?: ActionProviderSPIConfig;\n /**\n * Catalog SPI for ECOM platform\n * @internal\n */\n ecomCatalog?: CatalogSPIConfig;\n /**\n * Add a space to a Wix Dashboard page that can be extended with a widget or menu item.\n * @internal\n */\n backOfficeExtensionContainer?: BackOfficeExtensionContainer;\n /**\n * Create a widget or menu item that will be rendered within a Wix Dashboard page.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-wix-dashboard-extension\n * @internal\n */\n backOfficeExtension?: BackOfficeExtension;\n /**\n * WIP: automations trigger provider\n * @internal\n */\n automationsTriggerProvider?: TriggerProviderSPIConfig;\n /**\n * WIP - SPI for execution before identity creation in the new IAM platform\n * @internal\n */\n identityPreRegistration?: PreRegisterConfig;\n /**\n * Premium products upgrades/downgrades\n * @internal\n */\n premiumProductsPaths?: ProductsPathsConfig;\n /**\n * ECOM custom scopes provider - define scopes of catalog items based custom attributes\n * @internal\n */\n ecomCustomScope?: CustomScopeConfig;\n /**\n * Gift Card SPI for Ecom Platform\n * @internal\n */\n giftCardsProvider?: GiftCardProviderConfig;\n /**\n * Dealer External Filter SPI\n * @internal\n */\n dealerExternalFilterProvider?: ExternalFilterProviderConfig;\n /**\n * Recommendations provider SPI\n * @internal\n */\n ecomRecommendationsProvider?: RecommendationsProviderConfig;\n /**\n * Dropshipping Provider SPI for Ecom Platform\n * @internal\n */\n ecomDropshippingProvider?: DropshippingProviderSPIConfig;\n /**\n * Invoices SPI\n * @internal\n */\n invoicesProvider?: InvoicesConfig;\n /**\n * Provide SEO keyword suggestions to site collaborators, report quota usage, and provide a page where users can upgrade their plan.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/marketing/seo-keywords-suggestions-v-1/introduction\n */\n seoKeywordsSuggestions?: SeoKeywordsSuggestionsSPIConfig;\n /**\n * Ecom custom discount trigger SPI provider - define custom triggers to apply discount rules\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/custom-discount-triggers-integration-spi/introduction\n * @internal\n */\n ecomDiscountsTrigger?: CustomTriggerConfig;\n /**\n * Multilingual content provider for site translator to read and update translations\n * @internal\n */\n multilingualContentProvider?: ContentProviderConfig;\n /**\n * Application Automation\n * @internal\n */\n applicationAutomation?: ApplicationAutomationComponent;\n /**\n * Experimental-WIP: A back office page category\n * @internal\n */\n backOfficeSidebarCategory?: BackOfficeSidebarCategory;\n /**\n * Configure a page for your app that will be embedded in the Wix Dashboard.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-dashboard-page-component\n */\n backOfficePage?: BackOfficePage;\n /**\n * Displays the fees from your Additional Fees SPI in a site's cart and checkout.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/additional-fees-integration-spi/introduction\n */\n ecomAdditionalFees?: AdditionalFeesSPIConfig;\n /**\n * Send notifications to your app users\n * @internal\n */\n pingUserNotification?: PingNotificationComponentData;\n /**\n * Bookings Pricing Provider SPI\n * @internal\n */\n bookingsPricingProvider?: BookingsPricingProviderConfig;\n /**\n * Authenticator SPI\n * @internal\n */\n identityAuthenticator?: AuthenticatorConfig;\n /**\n * WIP - SPI for authenticating via external IDP in the new IAM platform\n * @internal\n */\n identityIdpConnector?: IDPConnectionConfig;\n /**\n * Items Selection\n * @internal\n */\n itemsSelectionProvider?: ItemsSelectionProviderConfig;\n /**\n * Portfolio synced projects provider\n * @internal\n */\n portfolioSyncedProjectsProvider?: SyncedProjectsProviderConfig;\n /**\n * Communication Channel\n * @internal\n */\n communicationChannel?: CommunicationChannelConfiguration;\n /**\n * WIP - SPI to run after the login process\n * @internal\n */\n identityPostLogin?: PostLoginConfig;\n /**\n * Create a component that can be easily placed in or opened from a Wix app page.\n * @internal\n */\n backOfficeWidget?: BackOfficeWidget;\n /**\n * Social Marketing Design SPI\n * @internal\n */\n socialMarketingDesign?: SocialMarketingDesignSPIConfig;\n /**\n * Forms Submissions SPI\n * @internal\n */\n formsSubmissionsProvider?: FormSubmissionSpiConfig;\n /**\n * Wix Offering\n * @internal\n */\n wixOffering?: WixOfferingComponentData;\n /**\n * Components translation test component\n * @internal\n */\n devCenterTestingComponent?: DevCenterTestingComponentData;\n /**\n * Components Validator SPI\n * @internal\n */\n componentsValidatorProvider?: ComponentsValidatorConfig;\n /**\n * Components Translations additional fields config\n * @internal\n */\n componentsTranslationsAdditionalFieldsProvider?: ComponentTranslationAdditionalFieldsConfig;\n /**\n * Forms Schema SPI\n * @internal\n */\n formsSchemaProvider?: FormSchemaSpiConfig;\n /**\n * Bookings External Calendar Provider\n * @internal\n */\n bookingsExternalCalendarProvider?: ProviderConfig;\n /**\n * Default Tax Category Config\n * Learn More: https://bo.wix.com/wix-docs/rest/drafts/platform-tax\n * @internal\n */\n ecomDefaultTaxationCategory?: DefaultTaxGroupProviderConfig;\n /**\n * Viewer Dynamic Site Structure Config\n * @internal\n */\n viewerDynamicSiteStructureProvider?: DynamicSiteStructureProviderConfig;\n /**\n * Send notifications to your app users of users\n * @internal\n */\n pingUouNotification?: PingNotificationComponentData;\n /**\n * Holds data for authenticating Headless Applications\n * @internal\n */\n headlessOauth?: HeadlessOAuth;\n /**\n * Tax Calculator Structure Config\n * Learn More: https://bo.wix.com/wix-docs/rest/drafts/platform-tax\n * @internal\n */\n ecomTaxCalculatorSpi?: TaxCalculatorSpiConfig;\n /**\n * Comments Moderation Provider Config\n * @internal\n */\n commentsModerationProvider?: CommentModerationProviderConfig;\n /**\n * GridApp files transformer config\n * @internal\n */\n gridAppFilesTransformer?: GridAppFilesTransformerConfig;\n /**\n * Holds benefit programs policy provider configuration\n * @internal\n */\n benefitProgramsPolicyProvider?: PolicyConfig;\n /**\n * Premium Custom Charges Config\n * Learn More: https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/introduction\n */\n premiumCustomCharges?: CustomChargesConfig;\n /**\n * Performs Validations for a site's cart and checkout.\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/validations-integration-spi/introduction\n */\n ecomValidations?: ValidationsSPIConfig;\n /**\n * Component Reference Data SPI\n * @internal\n */\n componentReferenceDataProvider?: ComponentReferenceDataConfig;\n /**\n * Wix Reviews SPI\n * @internal\n */\n wixReviewsProductCatalog?: ReviewsProductCatalogProviderConfig;\n /**\n * Promote Social Marketing Designs Provider Configuration\n * @internal\n */\n socialMarketingDesignsProvider?: SocialMarketingDesignsProviderConfig;\n /**\n * Promote Google Business Profile Provider Configuration\n * @internal\n */\n googleBusinessProfileFeatureProvider?: GbpFeatureConfig;\n /**\n * Comments Filter Provider Config\n * @internal\n */\n commentsFilterProvider?: CommentFilterProviderConfig;\n /**\n * Tax ID Validator SPI Config\n * @internal\n */\n billingTaxIdValidator?: TaxIdValidatorConfig;\n /**\n * Ping Settings Group Data\n * @internal\n */\n pingSettingsGroup?: PingSettingsGroupComponentData;\n /**\n * Forms Spam Submissions SPI\n * @internal\n */\n formsSpamSubmissionsProvider?: FormSpamSubmissionSpiConfig;\n /**\n * Editor Addon component\n * @internal\n */\n editorAddon?: EditorAddon;\n /**\n * External Database component\n * @internal\n */\n externalDatabaseProvider?: ExternalDatabaseSpiConfig;\n /**\n * Ecom Payment Settings SPI Config\n * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/payment-settings-integration-spi/introduction\n */\n ecomPaymentSettings?: PaymentSettingsSPIConfig;\n /**\n * Group multiple notifications into one preference toggle.\n * Learn More: https://dev.wix.com/docs/build-apps/build-your-app/user-notifications/add-notification-topics\n * @internal\n */\n notificationTopic?: NotificationTopic;\n /**\n * Notification Preference SPI\n * @internal\n */\n notificationPreferencesFilterProvider?: NotificationPreferencesFilterConfig;\n /**\n * Bookings Resource Types provider SPI config\n * @internal\n */\n bookingsResourceTypesProvider?: BookingsResourceTypesProviderConfig;\n /**\n * Pricing Plans form configuration\n * @internal\n */\n pricingPlansFormConfiguration?: PricingPlansFormConfiguration;\n /**\n * Create a notification to alert your app users about important updates and events.\n * Learn More: https://dev.wix.com/docs/build-apps/build-your-app/user-notifications/app-notifications\n * @internal\n */\n userNotification?: UserNotification;\n /**\n * Contact Notification\n * @internal\n */\n contactNotification?: ContactNotification;\n /**\n * Add a site page that displays selected widgets.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/create-a-site-page\n * @internal\n */\n unifiedPage?: UnifiedPage;\n /**\n * Availability Time Slots Configuration Provider SPI\n * @internal\n */\n availabilityTimeSlotsConfigurationProvider?: AvailabilityTimeSlotsProviderConfig;\n /**\n * Proposal Editor Provider SPI config\n * @internal\n */\n proposalEditorProvider?: ProposalEditorProviderConfig;\n /**\n * Custom Table Reservations Provider SPI config\n * @internal\n */\n customTableReservationsProvider?: CustomReservationsApprovalConfig;\n /**\n * Comments Context provider\n * @internal\n */\n commentsContextProvider?: CommentsContextProviderConfig;\n /**\n * Forms Spam Submission Reports SPI\n * @internal\n */\n formsSpamSubmissionReportsProvider?: FormSpamSubmissionReportSpiConfig;\n /**\n * Automation Velo Action Spi Provider\n * @internal\n */\n automationsVeloActionProvider?: VeloActionConfig;\n /**\n * Calendar Event Type Provider\n * @internal\n */\n calendarEventTypeProvider?: EventTypeProviderConfig;\n /**\n * Reserved - previously was `service_availability_policy_provider`\n * @internal\n */\n reserved?: ServiceAvailabilityPolicyProviderConfig;\n /**\n * Create an SMS message for a pre-installed automation, in order to translate it.\n * @internal\n */\n smsActionMessage?: SmsActionMessage;\n /**\n * Booking Policy Provider SPI\n * @internal\n */\n bookingPolicyProvider?: BookingPolicyProviderConfig;\n /**\n * Multi Service Booking Policy Provider SPI\n * @internal\n */\n multiServiceBookingPolicyProvider?: MultiServiceBookingPolicyProviderConfig;\n /**\n * Forms Submissions Extension SPI\n * @internal\n */\n formsSubmissionsExtensionProvider?: FormSubmissionSpiExtensionConfig;\n /**\n * AI Assistant SPI\n * @internal\n */\n aiAssistant?: AssistantSpiConfig;\n /**\n * Multilingual translation schema\n * @internal\n */\n multilingualTranslationSchema?: MultilingualTranslationSchema;\n /**\n * Tax Groups Provider SPI\n * @internal\n */\n taxGroupsProvider?: TaxGroupsProviderConfig;\n /**\n * Tax Calculation Provider SPI\n * @internal\n */\n taxCalculationProvider?: TaxCalculationConfig;\n /** Create a reusable modal that can be utilized across multiple pages within your app and in other applications. */\n backOfficeModal?: BackOfficeModal;\n /**\n * Deployment Pipeline Provider SPI\n * @internal\n */\n deploymentPipelineProvider?: DeploymentPipelineProviderConfig;\n /**\n * Display a draggable widget on a site using a self-hosted custom element.\n * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/build-a-site-widget-using-a-self-hosted-custom-element\n * @internal\n */\n customElementWidget?: CustomElementWidget;\n /**\n * Create a widget that will be rendered within a Wix Dashboard page.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-wix-dashboard-extension\n * @internal\n */\n backOfficeExtensionWidget?: BackOfficeExtensionWidget;\n /**\n * Create a menu item that will be rendered within a Wix Dashboard page.\n * Learn More: https://devforum.wix.com/kb/en/article/create-a-wix-dashboard-extension\n * @internal\n */\n backOfficeExtensionMenuItem?: BackOfficeExtensionMenuItem;\n /**\n * Form Template\n * @internal\n */\n formTemplate?: FormTemplate;\n /**\n * Notification Content\n * @internal\n */\n notificationContent?: NotificationContent;\n /**\n * Broadcast List\n * @internal\n */\n broadcastList?: BroadcastList;\n /**\n * Partners Payouts\n * @internal\n */\n partnersPayouts?: PayoutsProviderConfig;\n /**\n * Wix Reviews Entity Catalog Provider SPI\n * @internal\n */\n wixReviewsEntityCatalog?: ReviewsEntityCatalogProviderConfig;\n /**\n * Velo Publish Pipeline Task Provider SPI\n * @internal\n */\n veloPublishPipelineTaskProvider?: VeloPublishPipelineTaskProviderConfig;\n /**\n * Function shop POC SPI\n * @internal\n */\n functionsShopPriceProvider?: FunctionsShopPriceSpiConfig;\n /**\n * Function\n * @internal\n */\n function?: Function;\n }\n /** An iframe to be displayed on the user’s site */\n interface WidgetComponentData {\n /** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */\n fixedPositionOption?: FixedPositionOptions;\n /** Widget will automatically be stretched to this width after installing it */\n widgetWidthType?: WidgetWidthType;\n /** Widget width size */\n width?: number | null;\n /** Widget width height */\n height?: number | null;\n /** A public link to the widget endpoint */\n widgetEndpointUrl?: string | null;\n /** A public link to the mobile endpoint */\n widgetMobileEndpointUrl?: string | null;\n /** A public link to the settings endpoint */\n settingsEndpointUrl?: string | null;\n /** A public link to the SEO endpoint */\n seoEndpointUrl?: string | null;\n /** Product display data for this component */\n widgetDisplay?: WidgetDisplay;\n /** When true, this is the default component */\n default?: boolean;\n /** When this is turned on, this page will be added to the site when installing the app, regardless of whether it's the default component or not */\n essential?: boolean;\n /** Published state for this widget */\n published?: boolean;\n /** When true, allow this widget to be added only once */\n addOnlyOnce?: boolean;\n /**\n * This ID is used to identify your widget endpoint in a Wix site. You can use this ID when using methods of the Wix SDK\n * @readonly\n */\n tpaWidgetId?: string;\n /** Where this should be rendered */\n position?: Position;\n /** Article id in settings panel */\n helpId?: string | null;\n /** Default Mobile Height */\n defaultMobileHeight?: number | null;\n /** Min Mobile Height */\n minMobileHeight?: number | null;\n /** Mobile Settings Enabled */\n mobileSettingsEnabled?: boolean;\n /** Mobile article id in settings panel */\n mobileHelpId?: string | null;\n /** Editor setting version. optional values: 1 (old - deprecated) or 2 (new). default value is 2 */\n settingsVersion?: number | null;\n /** If setting version is 1, this will be the public link to the settings endpoint */\n settingsEndpointUrlV1?: string | null;\n /** A public link to the settings endpoint on ADI editor */\n onBoardingSettingsEndpointUrl?: string | null;\n /** The sub pages list for this component to be rendered in */\n subPages?: SubPage[];\n /** If this component should be stretched in relation to a form factor (desktop, tablet, mobile) */\n isStretched?: IsStretched;\n /** Any margins this page should have in relation to a form factor (desktop, tablet, mobile) */\n margins?: Margins;\n /** Any docking this page (horizontal / vertical) should have in relation to a form factor (desktop, tablet, mobile) */\n docking?: Docking;\n /** The height of this page in relation to a form factor (desktop, tablet, mobile) */\n heightBreakPoints?: Height;\n /** The width of this page in relation to a form factor (desktop, tablet, mobile) */\n widthBreakPoints?: ApiWidth;\n /** Keep default and let users stretch widget to full width (GFPP) */\n addStretchButton?: boolean;\n /** toggle to mark whether the editor should revoke an app that contains this component. */\n excludeFromAutoRevoke?: boolean;\n /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */\n settingsEndpointUrlTemplate?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */\n settingsEndpointUrlV1Template?: string | null;\n }\n /** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */\n interface FixedPositionOptions {\n /** Vertical widget position in the browser window */\n widgetVertical?: WidgetVertical;\n /** Horizontal widget position in the browser window */\n widgetHorizontal?: WidgetHorizontal;\n }\n /** Vertical widget position in the browser window */\n enum WidgetVertical {\n NONE_VERTICAL = \"NONE_VERTICAL\",\n TOP = \"TOP\",\n CENTER_VERTICAL = \"CENTER_VERTICAL\",\n BOTTOM = \"BOTTOM\"\n }\n /** Horizontal widget position in the browser window */\n enum WidgetHorizontal {\n NONE_HORIZONTAL = \"NONE_HORIZONTAL\",\n LEFT = \"LEFT\",\n CENTER_HORIZONTAL = \"CENTER_HORIZONTAL\",\n RIGHT = \"RIGHT\"\n }\n /** Widget will automatically be stretched to this width after installing it */\n enum WidgetWidthType {\n NONE_TYPE = \"NONE_TYPE\",\n /** A custom width for the widget */\n CUSTOM = \"CUSTOM\",\n /** Full width of the browser window */\n FULL = \"FULL\"\n }\n interface WidgetDisplay {\n name?: string;\n /** short description about the widget */\n shortDescription?: string | null;\n /** images showing off how the widget looks */\n images?: string[];\n /** optional, if no order exist for all components, will be decided by order in array (non-deterministic) */\n order?: number | null;\n price?: number | null;\n variationId?: string | null;\n }\n interface Position {\n region?: Region;\n }\n enum Region {\n no_region = \"no_region\",\n header = \"header\",\n pageContainer = \"pageContainer\",\n footer = \"footer\"\n }\n interface SubPage {\n /** The path of the subpage */\n key?: string;\n /** If it's sub entities are enumerable for querying (for example, a search endpoint is not enumerable) */\n enumerable?: boolean;\n /** Should hide inner routes of this sub page from floating dynamic pages navigation bar */\n hideFromFloatingNavBar?: boolean;\n /** Should hide this sub page from selections in link panel */\n hideFromLinkPanel?: boolean;\n }\n interface IsStretched {\n desktop?: boolean | null;\n tablet?: boolean | null;\n mobile?: boolean | null;\n }\n interface Margins {\n desktop?: DisplayProperties;\n tablet?: DisplayProperties;\n mobile?: DisplayProperties;\n }\n interface DisplayProperties {\n top?: DisplayValue;\n right?: DisplayValue;\n bottom?: DisplayValue;\n left?: DisplayValue;\n }\n interface DisplayValue {\n type?: UnitType;\n value?: number | null;\n }\n enum UnitType {\n NO_UNIT = \"NO_UNIT\",\n AUTO = \"AUTO\",\n PX = \"PX\",\n VH = \"VH\",\n VW = \"VW\",\n PERCENTAGE = \"PERCENTAGE\"\n }\n interface Docking {\n desktop?: DockingProperties;\n tablet?: DockingProperties;\n mobile?: DockingProperties;\n }\n interface DockingProperties {\n horizontal?: HorizontalDocking;\n vertical?: VerticalDocking;\n }\n enum HorizontalDocking {\n NO_HDOCKING = \"NO_HDOCKING\",\n LEFT_DOCKING = \"LEFT_DOCKING\",\n HCENTER = \"HCENTER\",\n RIGHT_DOCKING = \"RIGHT_DOCKING\"\n }\n enum VerticalDocking {\n NO_VDOCKING = \"NO_VDOCKING\",\n TOP_DOCKING = \"TOP_DOCKING\",\n VCENTER = \"VCENTER\",\n BOTTOM_DOCKING = \"BOTTOM_DOCKING\"\n }\n interface Height {\n desktop?: DisplayValue;\n tablet?: DisplayValue;\n mobile?: DisplayValue;\n }\n interface ApiWidth {\n desktop?: DisplayValue;\n tablet?: DisplayValue;\n mobile?: DisplayValue;\n }\n /** An iframe to be displayed as a full page on the user’s site */\n interface PageComponentData {\n /** Hide this page from the user’s site menu */\n isHidden?: boolean;\n /** Show in pages menu */\n showInPanel?: boolean | null;\n /** Set page to full width */\n isFullWidth?: boolean;\n /** Keep default and let users stretch page to full width (GFPP) */\n addStrechButton?: boolean;\n /** A public link to the page endpoint */\n pageEndpointUrl?: string | null;\n /** A public link to the mobile endpoint */\n pageMobileEndpointUrl?: string | null;\n /** A public link to the settings endpoint */\n settingsEndpointUrl?: string | null;\n /** A public link to the SEO endpoint */\n seoEndpointUrl?: string | null;\n /**\n * When true, this is the default component\n * Main visual component. One components must be default (no more than 1 component)\n */\n default?: boolean;\n /**\n * Second visual component\n * When this is turned on, this page will be added to the site when installing the app, regardless of whether it's the default component or not\n */\n essential?: boolean;\n /** Published state for this page */\n published?: boolean;\n /**\n * This ID is used to identify your page endpoint in a Wix site. You can use this ID when using methods of the Wix SDK\n * @readonly\n */\n tpaWidgetId?: string;\n /** Article id in settings panel */\n helpId?: string | null;\n /** Default Mobile Height */\n defaultMobileHeight?: number | null;\n /** Min Mobile Height */\n minMobileHeight?: number | null;\n /** Mobile Settings Enabled */\n mobileSettingsEnabled?: boolean;\n /** Mobile article id in settings panel */\n mobileHelpId?: string | null;\n /** Editor setting version. optional values: 1 (old - deprecated) or 2 (new). default value is 2 */\n settingsVersion?: number | null;\n /** If setting version is 1, this will be the public link to the settings endpoint */\n settingsEndpointUrlV1?: string | null;\n /** A public link to the settings endpoint on ADI editor */\n onBoardingSettingsEndpointUrl?: string | null;\n /** The padding to use in different views */\n padding?: Padding;\n /** The sub pages list for this component to be rendered in */\n subPages?: SubPage[];\n /** toggle to mark whether the editor should revoke an app that contains this component. */\n excludeFromAutoRevoke?: boolean;\n /** Options to mark whether this page is replacing other page or is replaced by other page. */\n pageReplaceOptions?: PageReplaceOptions;\n /** Elements in the editor can be linked to this page (a button for example) */\n linkable?: boolean | null;\n /** Should add the page to site menu. defaults to true (will add the page to site menu) */\n addToSiteMenu?: boolean | null;\n }\n interface Padding {\n desktop?: DisplayProperties;\n tablet?: DisplayProperties;\n mobile?: DisplayProperties;\n }\n interface PageReplaceOptions extends PageReplaceOptionsOptionsOneOf {\n replacingOptions?: ReplacingOptions;\n replaceableOptions?: ReplaceableOptions;\n type?: ReplacementType;\n }\n /** @oneof */\n interface PageReplaceOptionsOptionsOneOf {\n replacingOptions?: ReplacingOptions;\n replaceableOptions?: ReplaceableOptions;\n }\n interface PageReplace {\n /** The app id of the page the app can replace */\n appId?: string;\n /** The page id the app can replace */\n pageId?: string;\n }\n enum ReplacementType {\n UNKNOWN_REPLACEMENT = \"UNKNOWN_REPLACEMENT\",\n REPLACING = \"REPLACING\",\n REPLACEABLE = \"REPLACEABLE\"\n }\n interface ReplacingOptions {\n /** describe the page and application id that this page will replace. */\n pageReplace?: PageReplace;\n }\n interface ReplaceableOptions {\n /** toggle to mark whether this page can be replaced by other page or app. */\n isReplaceable?: boolean;\n }\n /** A widget out of iframe component that loads directly in the Editor DOM */\n interface WidgetOutOfIframeComponentData {\n /** A link to the out of iframe component */\n componentUrl?: string;\n /** A link to the out of iframe controller */\n controllerUrl?: string | null;\n /** This is that widget's data. */\n widgetData?: WidgetComponentData;\n /** A link to the out of iframe SSR */\n ssrComponentUrl?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', 'component_url_bundle_file')%> */\n componentUrlTemplate?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', 'controller_url_bundle_file')%> */\n controllerUrlTemplate?: string | null;\n /** Additional info on this OOI widget */\n outOfIframeData?: OutOfIframeData;\n /** should be <%=serviceUrl('your_artifact_id', 'no_css_component_url_bundle_file')%> */\n noCssComponentUrlTemplate?: string | null;\n /** A link to the out of iframe no css component url */\n noCssComponentUrl?: string | null;\n /** Enable support for different style param values for different breakpoint (Css Per Breakpoint) */\n cssPerBreakpoint?: boolean | null;\n }\n /** Out Of Iframes additional info */\n interface OutOfIframeData {\n /** The setting URLs for the app */\n settingsUrls?: SettingsUrl[];\n /** Automatically installed on app installation */\n autoInstall?: boolean;\n /** The info about how to report errors for the App */\n errorReporting?: ErrorReporting;\n /** The list of slots available */\n slots?: Slot[];\n /** if true, ssr will not cache pages that contain this widget */\n ssrCacheExcluded?: boolean;\n /** Should use loadable-components */\n isLoadable?: boolean;\n }\n /** An editor settings configuration */\n interface SettingsUrl {\n /** The URL for the setting panel */\n url?: string;\n /** What type of editor this is */\n editorType?: string;\n /** How this view is rendered (mobile, tablet, etc) */\n viewType?: string;\n /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */\n urlTemplate?: string | null;\n }\n /** Error reporting configuration for the App */\n interface ErrorReporting {\n /** An error reporting URL to be used by our infra (Example: A sentry DSN url) */\n url?: string;\n /** Optional: Data about the artifact that reports the error. */\n artifact?: ErrorReportingArtifact;\n }\n /** Data of the artifact that reports an error. */\n interface ErrorReportingArtifact {\n /** The full artifact id of the project which errors are associated with (Example: com.wixpress.my-artifact) */\n fullArtifactId?: string;\n /** The project version which errors are associated with (Example: Falcon fingerprint) */\n version?: string;\n }\n /** Definition of slot */\n interface Slot {\n /** Role of the slot component (uniquely identifies slot within parent comp; used by Velo) - former \"slotName\" */\n slotRole?: string;\n /** The list of interfaces that should be implemented by a plugin in order to fit the slot */\n pluginInterfaces?: PluginInterface[];\n /** Id of the slot component (a.k.a. Velo role) */\n slotId?: string;\n }\n /** The types of public APIs exposed by the Plugin */\n enum PluginInterface {\n /** No public APIs exposed */\n NONE_INTERFACE = \"NONE_INTERFACE\",\n /** The slot requires the REVIEWS interface to be implemented by the plugin. The plugin specifies the implementation of the REVIEWS interface */\n REVIEWS = \"REVIEWS\",\n /** The slot requires the RATINGS_SUMMARY interface to be implemented by the plugin. The plugin specifies the implementation of the RATINGS_SUMMARY interface */\n RATINGS_SUMMARY = \"RATINGS_SUMMARY\",\n /** The slot requires the RATINGS_SUMMARY_OOI_LIST interface to be implemented by the plugin. The plugin specifies the implementation of the RATINGS_SUMMARY_OOI_LIST interface */\n RATINGS_SUMMARY_OOI_LIST = \"RATINGS_SUMMARY_OOI_LIST\",\n /** The slot requires the BOOKINGS_SERVICE interface to be implemented by the plugin. The plugin specifies the implementation of the BOOKINGS_SERVICE interface */\n BOOKINGS_SERVICE = \"BOOKINGS_SERVICE\",\n /** The slot requires the BOOKINGS_FORM interface to be implemented by the plugin. The plugin specifies the implementation of the BOOKINGS_FORM interface */\n BOOKINGS_FORM = \"BOOKINGS_FORM\",\n /** The slot requires the BASE interface to be implemented by the plugin. The plugin specifies the implementation of the BASE interface */\n BASE = \"BASE\",\n /** The slot requires the EVENT interface to be implemented by the plugin. The plugin specifies the implementation of the EVENT interface */\n EVENT = \"EVENT\",\n /** The slot requires the PRODUCT interface to be implemented by the plugin. The plugin specifies the implementation of the PRODUCT interface */\n PRODUCT = \"PRODUCT\",\n /** The slot requires the CHECKOUT interface to be implemented by the plugin. The plugin specifies the implementation of the CHECKOUT interface */\n CHECKOUT = \"CHECKOUT\",\n /** The slot requires the CATEGORY interface to be implemented by the plugin. The plugin specifies the implementation of the CATEGORY interface */\n CATEGORY = \"CATEGORY\"\n }\n /** A page out of iframe component that loads directly in the Editor DOM */\n interface PageOutOfIframeComponentData {\n /** A link to the out of iframe component */\n componentUrl?: string;\n /** A link to the out of iframe controller */\n controllerUrl?: string | null;\n /** This is that page's data */\n pageData?: PageComponentData;\n /** A link to the out of iframe SSR */\n ssrComponentUrl?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', 'component_url_bundle_file')%> */\n componentUrlTemplate?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', 'controller_url_bundle_file')%> */\n controllerUrlTemplate?: string | null;\n /** Additional info on this OOI page */\n outOfIframeData?: OutOfIframeData;\n /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */\n settingsEndpointUrlTemplate?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', '')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */\n settingsEndpointUrlV1Template?: string | null;\n /** should be <%=serviceUrl('your_artifact_id', 'no_css_component_url_bundle_file')%> */\n noCssComponentUrlTemplate?: string | null;\n /** A link to the out of iframe no css component url */\n noCssComponentUrl?: string | null;\n /** Enable support for different style param values for different breakpoint (Css Per Breakpoint) */\n cssPerBreakpoint?: boolean | null;\n }\n /** Create a collection of native Editor components that loads directly in the Editor DOM */\n interface PlatfromComponentData {\n /** Path to a Javascript file that Editor runs on app install */\n editorScriptUrl?: string | null;\n /** Path to a Javascript file that viewer runs for page components / widgets and applicative business logic */\n viewerScriptUrl?: string | null;\n /** If true, components of the app wont be added to the editor (only run editor scripts) */\n platformOnly?: boolean;\n /** If the viewer script should run in the Editor */\n enableInEditor?: boolean;\n /** URL to get complex routing decisions at runtime from a platform app. Some spec can be seen here: https://docs.google.com/document/d/1t_3bl9vVMoPVm_I9Sx59LsVUPXi07gihGIg3-F7z8Q0/edit?ts=595512f6#heading=h.9ca9859ng5d */\n routerServiceUrl?: string | null;\n /** Path to a Javascript file that viewer runs for page components / widgets and applicative business logic. Includes verbose logs for Wix runtime. */\n viewerVerboseScriptUrl?: string | null;\n /** A map of string descriptor the app understands to a versioned URL topology value, can be an API or statics data. Example: `storesCartAPI: https://stores.com/api/v2/cart/ */\n baseUrls?: Record;\n /** Used by DAC (gradual roll-out). A map of string descriptor the app understands to a template versioned URL topology value, Example: `storeCSSStuff: https://static.pararstorage.com/services/stores-css-stuff/<%=serviceVersion('your_artifact_id')%>/main.css */\n baseUrlsTemplate?: Record;\n /** should be <%=serviceUrl('your_artifact_id', 'viewer_script_url_bundle_file')%> */\n viewerScriptUrlTemplate?: string | null;\n /** If this component should be stretched in relation to a form factor (desktop, tablet, mobile) */\n isStretched?: IsStretched;\n /** Any margins this page should have in relation to a form factor (desktop, tablet, mobile) */\n margins?: Margins;\n /** Any docking this page (horizontal / vertical) should have in relation to a form factor (desktop, tablet, mobile) */\n docking?: Docking;\n /** The height of this page in relation to a form factor (desktop, tablet, mobile) */\n height?: Height;\n /** The width of this page in relation to a form factor (desktop, tablet, mobile) */\n width?: ApiWidth;\n /**\n * Support adding application pages with preset data\n * Vertical endpoint that clones the data\n * https://docs.google.com/document/d/1pUp-d9vVMCTjDdQffBuwh1mBvQacQZy0n6nm2amCMV4/edit\n */\n cloneAppDataUrl?: string | null;\n /**\n * False by default\n * If false, data is cloned per app\n * If true, the data is cloned per add component on component addition\n */\n shouldCloneDataPerComponent?: boolean;\n /**\n * Error reporting URL used to report errors at platform level,\n * and as fallback for pageOOI and widgetOOI error reporting\n */\n errorReporting?: ErrorReporting;\n /** A concrete versioned URL of the translation template, contains `{language}` parameter in the path */\n editorTranslationUrl?: string | null;\n /** A version templated URL of the translation template, contains a <%=serviceVersion('your_artifact_id')%> template and a `{language}` template */\n editorTranslationUrlTemplate?: string | null;\n excludeFromAutoRevoke?: boolean;\n /**\n * Should be <%=serviceUrl('your_artifact_id', 'editor_script_url_bundle_file')%>, this will later be resolved to the right version in the context of the request, meaning, URL/Cookie overrides, Rollout version, Employee Preview version and override the version of editor_script_url.\n * @internal\n */\n editorScriptUrlTemplate?: string | null;\n }\n /**\n * An iframe that opens in the user’s Wix Dashboard,\n * or add a link to open the page directly in your platform.\n */\n interface DashboardComponentData {\n /** The dashboard url. */\n url?: string;\n /**\n * External or Internal dashboard.\n * The user’s Wix Dashboard (recommended) or your platform or site\n */\n embedded?: boolean;\n /** A settings page for users to customize your dashboard */\n settingsPageUrl?: string | null;\n /** todo: WEB_URL */\n checkStatusUrl?: string | null;\n published?: boolean | null;\n hideWixSideMenu?: boolean | null;\n }\n /** An invisible iframe to track site activity. It’ll be added to every page on the user’s site */\n interface WorkerComponentData {\n /** A public link to the worker endpoint */\n workerEndpointUrl?: string;\n }\n /**\n * An extension to platform used by Wix Blocks UI\n * The main component in the Wix Blocks.\n * no manual adding. auto-created only from Wix Blocks\n */\n interface StudioComponentData {\n /** Path to a Javascript file that Editor runs on app install */\n editorScriptUrl?: string;\n /** Path to a Javascript file that viewer runs for page components / widgets and applicative business logic */\n viewerScriptUrl?: string;\n /** If true, components of the app wont be added to the editor (only run editor scripts) */\n platformOnly?: boolean;\n /** If the viewer script should run in the Editor */\n enableInEditor?: boolean;\n /** URL to get complex routing decisions at runtime from a platform app. Some spec can be seen here: https://docs.google.com/document/d/1t_3bl9vVMoPVm_I9Sx59LsVUPXi07gihGIg3-F7z8Q0/edit?ts=595512f6#heading=h.9ca9859ng5d */\n routerServiceUrl?: string;\n /** Path to a Javascript file that viewer runs for page components / widgets and applicative business logic. Includes verbose logs for Wix runtime. */\n viewerVerboseScriptUrl?: string;\n /** Instance id of wixCode in the original dev site. used in order to access the widgets code */\n wixCodeInstanceId?: string;\n /** Id of the grid in wixCode FS where the widgets code is located. used in order to access the widgets code */\n wixCodeGridId?: string;\n /** Path to a json which contains metaData of the devSite */\n siteHeaderUrl?: string;\n /** A map of string descriptor the app understands to a versioned URL topology value, can be an API or statics data. This may have some values which are NOT URL since Studio computes some values on the fly. */\n baseUrls?: Record;\n /** If true, not shown in add panel and apps panel when it is installed */\n hideInAddPanel?: boolean;\n /** if true, this studio component enforce permissions */\n permissionsEnforced?: boolean;\n }\n /** A widget component in the Wix Blocks. */\n interface StudioWidgetComponentData {\n /** Id of the widget */\n studioWidgetId?: string;\n /** Path to a json which contains the widget data and structure */\n pageJsonFilename?: string;\n /** variationId -> widget variation data */\n variations?: Record;\n /** Product display data for this component */\n widgetDisplay?: WidgetDisplay;\n /** If it is required to be installed as part of the app */\n essential?: boolean;\n /** The version of blocks used to build this widget */\n blocksVersion?: string;\n /** If this component should be stretched in relation to a form factor (desktop, tablet, mobile) */\n isStretched?: IsStretched;\n /** Any margins this page should have in relation to a form factor (desktop, tablet, mobile) */\n margins?: Margins;\n /** Any docking this page (horizontal / vertical) should have in relation to a form factor (desktop, tablet, mobile) */\n docking?: Docking;\n /** The height of this page in relation to a form factor (desktop, tablet, mobile) */\n height?: Height;\n /** The width of this page in relation to a form factor (desktop, tablet, mobile) */\n width?: ApiWidth;\n /**\n * Optional, static artifact short name, used for BoB application to indicate the relation between the widget and its static artifact\n * @internal\n */\n relatedArtifact?: string | null;\n /** Properties of installed custom elements */\n customElement?: CustomElement;\n /** ids of nested widgets in this widget */\n nestedWidgets?: NestedWidgets;\n /** Properties of widget's presets */\n presetsInfo?: PresetInfo[];\n /** Widget properties that affect the way it behaves during installation in a site. */\n installationSettings?: InstallationSettings;\n /** Properties that affect the widget's presence in the editor. */\n editorPresence?: EditorPresence;\n /** Base info of component by shared logic of unified components */\n base?: BaseInfo;\n /** Unified widget installation settings */\n installation?: WidgetInstallationSettings;\n /**\n * if true, ssr will not cache pages that contain this widget\n * @internal\n */\n ssrCacheExcluded?: boolean;\n /**\n * The builder component model by shared logic of unified components. Required in oder to create a builder component\n * @internal\n */\n componentModel?: ComponentModel;\n }\n /** A variation of a blocks widget */\n interface StudioWidgetVariation {\n /** Id of the widget variation */\n _id?: string;\n /** Display name of the variation */\n name?: string;\n /** Path to a json which contains the widget variation data and structure */\n pageJsonFilename?: string;\n }\n interface CustomElement extends CustomElementConsentCategoryOneOf {\n essential?: boolean;\n /** Related to performance and other functional measurements. */\n functional?: boolean;\n /** Related to analytics about how the site is used in order to improve it. */\n analytics?: boolean;\n /** Related to allowing better customization of the experience to a current visitor. */\n advertising?: boolean;\n /** Boolean to make custom element in this widget be available for free sites */\n allowedForFreeSite?: boolean;\n /** CCPA compliance flag. */\n dataToThirdParty?: boolean;\n }\n /** @oneof */\n interface CustomElementConsentCategoryOneOf {\n essential?: boolean;\n /** Related to performance and other functional measurements. */\n functional?: boolean;\n /** Related to analytics about how the site is used in order to improve it. */\n analytics?: boolean;\n /** Related to allowing better customization of the experience to a current visitor. */\n advertising?: boolean;\n }\n /** Nested widgets */\n interface NestedWidgets {\n /** ids of all recursively nested widgets from the same Blocks app */\n internal?: string[];\n }\n /** Preset Info */\n interface PresetInfo {\n /** Id of the widget's preset */\n presetId?: string;\n /** Display name of the widget's preset */\n presetName?: string;\n /** The default size used when the preset is added to the stage */\n defaultSize?: PresetSize;\n }\n /** Preset Size */\n interface PresetSize {\n /** The width of the preset when it's added to the stage */\n width?: DisplayValue;\n /** The height of the preset when it's added to the stage */\n height?: DisplayValue;\n }\n /** Settings to control the behavour of widgets when installed in a wix site. */\n interface InstallationSettings extends InstallationSettingsOptionsOneOf {\n /** Extra options needed when `install_page` is set to `PAGE`. */\n pageOptions?: PageOptions;\n /** Extra options needed when `install_page` is set to `LIGHTBOX`. */\n lightboxOptions?: LightboxOptions;\n /** How to add the widget automatically to the site. Options could be `NO_PAGE`, `CURRENT`, `PAGE` or `LIGHTBOX`. */\n installPage?: InstallPage;\n /** Controls whether to show or hide the widget in the add panel. */\n showInAddPanel?: boolean | null;\n /** Defines the main preset per breakpoint for the widget. */\n mainPresets?: MainPresets;\n }\n /** @oneof */\n interface InstallationSettingsOptionsOneOf {\n /** Extra options needed when `install_page` is set to `PAGE`. */\n pageOptions?: PageOptions;\n /** Extra options needed when `install_page` is set to `LIGHTBOX`. */\n lightboxOptions?: LightboxOptions;\n }\n /** The page to which a new widget can be added */\n enum InstallPage {\n /** Don't add widget to a page */\n NO_PAGE = \"NO_PAGE\",\n /** Add widget to the current page in the editor */\n CURRENT = \"CURRENT\",\n /** Add widget to a new page in the editor */\n PAGE = \"PAGE\",\n /** Add widget to a new lightbox in the editor */\n LIGHTBOX = \"LIGHTBOX\"\n }\n /** Defines the main preset per breakpoint for the widget. */\n interface MainPresets {\n /** The main desktop preset. */\n desktopPresetId?: string;\n /** The main tablet preset. */\n tabletPresetId?: string;\n /** The main mobile preset. */\n mobilePresetId?: string;\n }\n /** Options for widgets that are added as a page during installation */\n interface PageOptions {\n /** Display name of the page that will be shown in the page menu. */\n pageName?: string;\n /** The page ID used for navigation purposes. Once set cannot be changed. */\n pageId?: string;\n }\n interface LightboxOptions {\n /** Display name of the lightbox that will be shown in the lightbox menu. */\n lightboxName?: string;\n /** The lightbox ID used for navigation purposes. Once set cannot be changed. */\n lightboxId?: string;\n }\n interface EditorPresence {\n /** Properties that describe the presence of each of the widget's presets */\n presetsEditorPresence?: PresetEditorPresence[];\n }\n interface PresetEditorPresence {\n /** Id of the widget's preset */\n presetId?: string;\n /** Controls whether to show or hide the preset in the Add Panel */\n showInAddPanel?: boolean;\n /** Controls whether to show or hide the preset in the Presets Panel */\n showInPresetsPanel?: boolean;\n /** Optional image to show as the preset's thumbnail in the editor, if left empty an automatic snapshot of the preset will be used */\n wixMediaThumbnail?: string;\n /** Another preset id that is a mobile variation of this preset */\n mobilePresetId?: string;\n }\n interface BaseInfo {\n /** The name of the component */\n name?: string;\n /** The internal id of the component by the own app */\n _id?: string;\n }\n interface WidgetInstallationSettings {\n /** Shared installation settings for unified components */\n base?: BaseInstallation;\n /** Widget installation settings for unified components */\n widget?: WidgetInstallation;\n }\n interface BaseInstallation {\n /** Auto add component to stage */\n autoAdd?: boolean;\n /** Mark component as essential for the existence of the app (force to delete the whole app) */\n essential?: boolean;\n /** Max instances of the component that can be on site */\n maxInstances?: number | null;\n }\n interface WidgetInstallation {\n /** Preset should be selected defaultly with installation */\n defaultPreset?: MainPresets;\n /** Region of widget */\n region?: RegionType;\n }\n enum RegionType {\n HEADER = \"HEADER\",\n BODY = \"BODY\",\n FOOTER = \"FOOTER\"\n }\n interface ComponentModel {\n /** The component type of the builder component. */\n componentType?: string;\n /** The component URL of the builder component */\n componentUrl?: string;\n }\n /** A component that indicates the existence of an importable code package in a Wix Blocks application. */\n interface CodePackageComponentData {\n /** The GUID to access the package code in the Velo/Wix Code system */\n gridId?: string;\n /** Name of the package for display */\n displayName?: string;\n /** Name of the package for import */\n importName?: string;\n /** An optional description of this package and what it does */\n description?: string | null;\n }\n /** A collection of native components that load directly in the Business Manager */\n interface DashboardPlatfromComponentData {\n /** Path to a Javascript file that Dashboard runs on app install */\n scriptUrl?: string;\n }\n /** Inject third party scripts into the user’s site */\n interface EmbeddedScriptComponentData {\n /** The script */\n template?: string;\n /** A name that’s unique to this component. Names can include letters and the hyphen (-) character only */\n name?: string;\n /** What category of pages this will be embedded on (single, many, none) */\n pages?: EmbeddedScriptPages;\n /** Where in the HTML this should be embedded */\n placement?: EmbeddedScriptPlacement;\n /** An article explaining how to activate the script */\n connectArticleUrl?: string;\n /** Type of script you are injecting. This will be used for GDPR and cookie consent purposes */\n embedCategory?: EmbedCategory;\n /**\n * if the script should be loaded once - default and only supported value is true\n * @readonly\n */\n loadOnce?: boolean;\n /** allow developers to decide if their app script can be install on free sites */\n allowedForFreeSite?: boolean;\n /** The runtime dependencies array to declare the widget packages. */\n dependencies?: WixDependency[];\n }\n /** Category of pages this will be embedded on (single, many, none) */\n enum EmbeddedScriptPages {\n /** It will not be embedded */\n NONE_PAGES = \"NONE_PAGES\",\n /** It will be embedded once */\n ONCE = \"ONCE\",\n /** It will be embedded multiple times on specific pages */\n SPECIFIC_PAGES = \"SPECIFIC_PAGES\"\n }\n /** Where that embed will be rendered */\n enum EmbeddedScriptPlacement {\n /** It will not be rendered */\n NONE_PLACEMENT = \"NONE_PLACEMENT\",\n /** In the document head */\n HEAD = \"HEAD\",\n /** Prepended before all children already rendered in the body tag */\n BODY_START = \"BODY_START\",\n /** Appended after the last child already rendered in the body tag */\n BODY_END = \"BODY_END\"\n }\n /** Embed category defined for Privacy regulation compliance in EU and CCPA in the US */\n enum EmbedCategory {\n /** Not categorized yet */\n UNKNOWN = \"UNKNOWN\",\n /** Must load regardless of policy */\n ESSENTIAL = \"ESSENTIAL\",\n /** Adds optional functionality to the site */\n FUNCTIONAL = \"FUNCTIONAL\",\n /** Adds analytics abilities to the site */\n ANALYTICS = \"ANALYTICS\",\n /** Adds advertising content or advertising tracking to the site */\n ADVERTISING = \"ADVERTISING\"\n }\n interface WixDependency {\n /** The fully qualified package name from npm, example: @wix/frontend-location */\n packageName?: string;\n /** The major version of the package (this may be a detail included in the package name, but is conventional in NPM with semver semantics */\n version?: number;\n }\n /** A draggable custom element. Add your custom script and generate ui directly in the viewer */\n interface WebComponentData {\n /** A link to a preview image we can render in the editor in place of your component */\n imagePreview?: string;\n /** Web component size */\n size?: Size;\n /** This script url should render temp empty state */\n scriptTag?: string;\n /** Unique tag name to use in order to connect your JS script to your web component */\n tagName?: string;\n /** The settings panel URL for this component */\n settingsUrl?: string | null;\n /** The editor modal that the user will see */\n modalTitle?: string;\n /** Settings CTA label */\n connectLabel?: string;\n /** Dynamic settings(Graphic Floating Properties Panel settings) */\n gfppSettings?: Settings;\n /** Custom element type PAGE / WIDGET */\n type?: ElementType;\n /** Boolean to make this component be available for free sites */\n allowedForFreeSite?: boolean;\n /** A public link to the SEO endpoint */\n seoUrl?: string | null;\n /** For case that the widget will be used as page */\n slug?: string | null;\n /** For case that the widget will be used as page */\n showPageInMenu?: boolean;\n /** The details of the selected widget to add */\n widget?: WidgetDetails;\n /** Give the option to change the script type */\n scriptType?: ScriptType;\n /** Web component default mobile height */\n defaultMobileHeight?: number | null;\n /** Prevent the deletion of the widget when set to true. */\n essential?: boolean;\n /** Toggle to mark whether the editor should revoke an app that contains this component. */\n excludeFromAutoRevoke?: boolean;\n /** defines the widget's behaviour in editor page */\n widgetBehavior?: WidgetBehavior;\n }\n /** Web component size */\n interface Size {\n /** Height in pixels */\n height?: number;\n /** Width in pixels */\n width?: number;\n }\n /** Graphic Floating Properties Panel settings */\n interface Settings {\n activeTab?: string;\n fetchInitialData?: string | null;\n tabs?: Tab[];\n }\n /** Setting tab definition */\n interface Tab {\n label?: string;\n items?: Container[];\n /** hidden tab will not be visible in editor and dev center preview */\n hidden?: boolean;\n }\n /** UI Container in page */\n interface Container extends ContainerDataOneOf {\n /** containers */\n main?: Main;\n section?: Section;\n drillInListItem?: DrillInListItem;\n /** items */\n thumbnails?: Thumbnails;\n sliderLabeled?: SliderLabeled;\n dropDownLabeled?: DropDownLabeled;\n toggleLabeled?: ToggleLabeled;\n barAlignment?: BarAlignment;\n textInputLabeled?: TextInputLabeled;\n resetButton?: ResetButton;\n fontFamilyWithColorPicker?: FontFamilyWithColorPicker;\n radioButtonLabeled?: RadioButtonLabeled;\n colorSelectLabeled?: ColorSelectLabeled;\n textStyle?: TextStyle;\n }\n /** @oneof */\n interface ContainerDataOneOf {\n /** containers */\n main?: Main;\n section?: Section;\n drillInListItem?: DrillInListItem;\n /** items */\n thumbnails?: Thumbnails;\n sliderLabeled?: SliderLabeled;\n dropDownLabeled?: DropDownLabeled;\n toggleLabeled?: ToggleLabeled;\n barAlignment?: BarAlignment;\n textInputLabeled?: TextInputLabeled;\n resetButton?: ResetButton;\n fontFamilyWithColorPicker?: FontFamilyWithColorPicker;\n radioButtonLabeled?: RadioButtonLabeled;\n colorSelectLabeled?: ColorSelectLabeled;\n textStyle?: TextStyle;\n }\n /** Main 1 */\n interface Main {\n items?: MainPropsData[];\n }\n /** MainPropsData */\n interface MainPropsData {\n dashboardButton?: DashboardButton;\n richTextWithIllustrationVertical?: RichTextWithIllustrationVertical;\n }\n /** DashboardButton main 2 */\n interface DashboardButton {\n title?: string;\n label?: string;\n }\n /** RichTextWithIllustrationVertical main 1 */\n interface RichTextWithIllustrationVertical {\n key?: string;\n label?: string;\n text?: string;\n }\n /** Section 2 */\n interface Section {\n label?: string;\n }\n /** DrillInListItem 3 */\n interface DrillInListItem {\n items?: DrillItem[];\n label?: string;\n }\n /** DrillItem */\n interface DrillItem extends DrillItemDataOneOf {\n /** containers */\n section?: Section;\n /** items */\n radioButtonLabeled?: RadioButtonLabeled;\n colorSelectLabeled?: ColorSelectLabeled;\n thumbnails?: Thumbnails;\n sliderLabeled?: SliderLabeled;\n dropDownLabeled?: DropDownLabeled;\n toggleLabeled?: ToggleLabeled;\n barAlignment?: BarAlignment;\n textInputLabeled?: TextInputLabeled;\n fontFamilyWithColorPicker?: FontFamilyWithColorPicker;\n textStyle?: TextStyle;\n }\n /** @oneof */\n interface DrillItemDataOneOf {\n /** containers */\n section?: Section;\n /** items */\n radioButtonLabeled?: RadioButtonLabeled;\n colorSelectLabeled?: ColorSelectLabeled;\n thumbnails?: Thumbnails;\n sliderLabeled?: SliderLabeled;\n dropDownLabeled?: DropDownLabeled;\n toggleLabeled?: ToggleLabeled;\n barAlignment?: BarAlignment;\n textInputLabeled?: TextInputLabeled;\n fontFamilyWithColorPicker?: FontFamilyWithColorPicker;\n textStyle?: TextStyle;\n }\n /** RadioButtonLabeled 12 */\n interface RadioButtonLabeled {\n key?: string;\n title?: string;\n value?: string;\n options?: string[];\n description?: string;\n conditions?: Condition[];\n }\n interface Condition {\n value?: string;\n state?: SingleKeyCondition[];\n }\n interface SingleKeyCondition {\n key?: string;\n value?: string;\n visible?: boolean;\n }\n /** ColorSelectLabeled 13 */\n interface ColorSelectLabeled extends ColorSelectLabeledDataOneOf {\n customColor?: ColorDefinition;\n templateColor?: TemplateDefaultColor;\n title?: string;\n key?: string;\n color?: string;\n defaultData?: ColorDefinition;\n description?: string;\n }\n /** @oneof */\n interface ColorSelectLabeledDataOneOf {\n customColor?: ColorDefinition;\n templateColor?: TemplateDefaultColor;\n }\n interface ColorDefinition {\n value?: string;\n opacity?: string;\n }\n enum TemplateDefaultColor {\n BACKGROUND = \"BACKGROUND\",\n SECONDARY_TEXTS = \"SECONDARY_TEXTS\",\n MAIN_TEXT_AND_ICONS = \"MAIN_TEXT_AND_ICONS\",\n BORDERS_AND_DIVIDERS = \"BORDERS_AND_DIVIDERS\",\n BUTTONS_AND_LINKS = \"BUTTONS_AND_LINKS\"\n }\n /** Thumbnails 4 */\n interface Thumbnails {\n key?: string;\n title?: string;\n value?: string;\n options?: ThumbnailData[];\n size?: ThumbnailsSize;\n description?: string;\n conditions?: Condition[];\n }\n /** Structure for thumbnail */\n interface ThumbnailData {\n value?: string;\n src?: string | null;\n selectedSrc?: string | null;\n onHoverSrc?: string | null;\n label?: string;\n }\n enum ThumbnailsSize {\n SMALL = \"SMALL\",\n MEDIUM = \"MEDIUM\",\n LARGE = \"LARGE\",\n XLARGE = \"XLARGE\"\n }\n /** SliderLabeled 5 */\n interface SliderLabeled {\n key?: string;\n title?: string;\n size?: string;\n placeholder?: string;\n description?: string;\n minSize?: number;\n maxSize?: number;\n }\n /** DropDownLabeled 6 */\n interface DropDownLabeled {\n key?: string;\n title?: string;\n value?: string;\n options?: string[];\n description?: string;\n conditions?: Condition[];\n }\n /** ToggleLabeled 7 */\n interface ToggleLabeled {\n key?: string;\n title?: string;\n value?: boolean;\n description?: string;\n conditions?: Condition[];\n }\n /**\n * Elements =========\n * BarAlignment 8\n */\n interface BarAlignment {\n selected?: BarAlignmentSelected;\n key?: string;\n title?: string;\n description?: string;\n value?: BarAlignmentSelected;\n conditions?: Condition[];\n }\n /** Bar alignment selected value */\n enum BarAlignmentSelected {\n ALIGN_LEFT = \"ALIGN_LEFT\",\n ALIGN_CENTER = \"ALIGN_CENTER\",\n ALIGN_RIGHT = \"ALIGN_RIGHT\"\n }\n /** TextInputLabeled 9 */\n interface TextInputLabeled {\n key?: string;\n title?: string;\n placeholder?: string;\n value?: string;\n description?: string;\n }\n /** 11 */\n interface FontFamilyWithColorPicker {\n key?: string;\n title?: string;\n description?: string;\n value?: FontDefinition;\n defaultValue?: FontDefinition;\n }\n /** defintion and enums */\n interface FontDefinition {\n font?: string;\n color?: ColorDefinition;\n }\n /** TextStyle 14 */\n interface TextStyle extends TextStyleDefaultColorOneOf {\n customColor?: ColorDefinition;\n templateColor?: TemplateDefaultColor;\n key?: string;\n title?: string;\n description?: string;\n defaultTextStyle?: DefaultTextStyle;\n }\n /** @oneof */\n interface TextStyleDefaultColorOneOf {\n customColor?: ColorDefinition;\n templateColor?: TemplateDefaultColor;\n }\n enum DefaultTextStyle {\n TITLE = \"TITLE\",\n PARAGRAPH = \"PARAGRAPH\",\n LOWER_HIERARCHY_TEXTS = \"LOWER_HIERARCHY_TEXTS\"\n }\n /** 10 */\n interface ResetButton {\n label?: string;\n }\n enum ElementType {\n WIDGET = \"WIDGET\",\n PAGE = \"PAGE\"\n }\n interface WidgetDetails {\n name?: string | null;\n icon?: string | null;\n description?: string | null;\n }\n enum ScriptType {\n NO_SCRIPT_TYPE = \"NO_SCRIPT_TYPE\",\n MODULE = \"MODULE\"\n }\n interface WidgetBehavior {\n /** Toggle whether the widget is removable from the page. */\n removable?: boolean;\n /** Toggle whether the widget is duplicatable from the page. */\n duplicatable?: boolean;\n }\n interface ExtensionData {\n data?: string;\n extensionType?: ExtensionType;\n }\n enum ExtensionType {\n NONE_EXTENSION = \"NONE_EXTENSION\",\n PAYMENTS_GATEWAY_EXTENSION = \"PAYMENTS_GATEWAY_EXTENSION\",\n COUPONS_EXTENSION = \"COUPONS_EXTENSION\",\n DROPSHIPPING_EXTENSION = \"DROPSHIPPING_EXTENSION\",\n FULFILMENT_EXTENSION = \"FULFILMENT_EXTENSION\",\n DROPSHIPPING_SUPPLIER_EXTENSION = \"DROPSHIPPING_SUPPLIER_EXTENSION\",\n FULFILLMENT_CENTER_EXTENSION = \"FULFILLMENT_CENTER_EXTENSION\",\n RESTAURANTS_POS_EXTENSION = \"RESTAURANTS_POS_EXTENSION\",\n ART_STORE_EXTENSION = \"ART_STORE_EXTENSION\",\n ASCEND_AUTOMATION_EXTENSION = \"ASCEND_AUTOMATION_EXTENSION\",\n CONTACT_LABELS_EXTENSION = \"CONTACT_LABELS_EXTENSION\"\n }\n interface SnippetSolutionData {\n code?: string;\n instructions?: string;\n }\n /** A component which represents collections that will be installed as part of the app */\n interface DataComponent {\n /**\n * Token used used by blocks to allow installing collections when the app is installed\n * @internal\n */\n collectionsToken?: string | null;\n }\n interface DCConfigData {\n isVisualApp?: boolean;\n }\n interface StaticFileComponentData {\n url?: string;\n }\n interface AppConfig {\n siteConfig?: SiteConfig;\n namespace?: string;\n }\n interface SiteConfig {\n /** todo: WEB_URL */\n siteStructureApi?: string | null;\n }\n /**\n * Business Manager sidebar category that contains sidebar links.\n * each link in the category opens in the business manager in an iframe.\n */\n interface MultipleDashboardsComponentData {\n /** items inside the category */\n items?: DashboardItem[];\n }\n /**\n * a single dashboard page,\n * represented in Business Manager as sidebar link that opens in an iframe\n */\n interface DashboardItem {\n /** name of the sidebar link of the page */\n label?: string;\n /** data about the current page */\n dashboardData?: DashboardComponentData;\n /** permission to check for this page. */\n permissionId?: string | null;\n }\n /** Test component extension */\n interface PaymentsGatewayComponentData {\n /** The shop url */\n shopUrl?: string;\n }\n interface AutomationTrigger {\n /** The name that will be passed with trigger report event to activate an Automation. */\n name?: string;\n /** The name displayed to the user. */\n displayName?: string;\n /** The schema of the payload that will be passed with trigger when activating an Automation. */\n schemaConfig?: SchemaConfig;\n /**\n * Email template to be shown when user choose this trigger and email action.\n * @internal\n */\n emailTemplateName?: string | null;\n deploymentUri?: string;\n revision?: number;\n }\n interface SchemaConfig {\n /** The fields of the payload as sent in the report event */\n fields?: SchemaField[];\n /**\n * Dynamic schema service URL.\n * Dynamic schema is used when user needs to choose specific entities from site to activate the Automation.\n * For example form name, purchased product, etc.\n */\n dynamicSchemaUrl?: string | null;\n }\n interface SchemaField {\n /** The key as it appears on the report event payload. */\n key?: string;\n /** The name displayed to the user. */\n displayName?: string;\n /** The field type */\n fieldType?: SchemaFieldType;\n /** Sample values, values that could show up in the payload of a trigger. */\n sampleValues?: string[];\n /** The field exposure */\n exposure?: Exposure;\n }\n enum PrimitiveType {\n UNKNOWN_PRIMITIVE_TYPE = \"UNKNOWN_PRIMITIVE_TYPE\",\n TEXT = \"TEXT\",\n BOOLEAN = \"BOOLEAN\",\n NUMBER = \"NUMBER\"\n }\n enum SimpleType {\n UNKNOWN_SIMPLE_TYPE = \"UNKNOWN_SIMPLE_TYPE\",\n MONEY = \"MONEY\",\n LINK = \"LINK\",\n BACKOFFICE_LINK = \"BACKOFFICE_LINK\",\n LIVESITE_LINK = \"LIVESITE_LINK\",\n MULTILINGUAL = \"MULTILINGUAL\",\n IMAGE_LINK = \"IMAGE_LINK\",\n GUID = \"GUID\",\n EMAIL = \"EMAIL\",\n PHONE = \"PHONE\",\n CONTACT_ID = \"CONTACT_ID\"\n }\n interface Primitive {\n primitiveType?: PrimitiveType;\n }\n interface Simple {\n simpleType?: SimpleType;\n }\n interface _Date {\n /** Default: false, set this to true if the date is normally a future date, like: Invoice expiration date, Membership renewal date */\n allowNegativeOffset?: boolean | null;\n }\n interface SchemaFieldType extends SchemaFieldTypeFieldTypeOneOf {\n primitive?: Primitive;\n simple?: Simple;\n /**\n * The field value must conform to the following JSON structure { \"timestamp\": string, \"timeZone\": string }, where the timestamp is ISO format UTC, and the time zone is the full name\n * Example: { \"timestamp\": \"2021-03-22T11:41:47.992Z\", timeZone: \"Asia/Jerusalem\" }\n */\n date?: _Date;\n }\n /** @oneof */\n interface SchemaFieldTypeFieldTypeOneOf {\n primitive?: Primitive;\n simple?: Simple;\n /**\n * The field value must conform to the following JSON structure { \"timestamp\": string, \"timeZone\": string }, where the timestamp is ISO format UTC, and the time zone is the full name\n * Example: { \"timestamp\": \"2021-03-22T11:41:47.992Z\", timeZone: \"Asia/Jerusalem\" }\n */\n date?: _Date;\n }\n enum Exposure {\n UNKNOWN_EXPOSURE = \"UNKNOWN_EXPOSURE\",\n /** Not sent to the action provider */\n SETUP = \"SETUP\",\n /** Sent to the action provider and usually hidden from user */\n HIDDEN = \"HIDDEN\",\n /** Sent to the action provider and usually shown to user */\n EXPOSED = \"EXPOSED\"\n }\n /** represents Invoices integration policies */\n interface InvoicesActionsComponentData {\n /** partial payment restriction on invoice */\n partialPayment?: PartialPaymentRestriction;\n }\n /** Possible Partial Payment Policy Values */\n enum PartialPaymentRestriction {\n UNDEFINED = \"UNDEFINED\",\n /** Allow Partial Payment */\n ALLOW = \"ALLOW\",\n /** Disallow Partial Payment */\n DISALLOW = \"DISALLOW\"\n }\n /** Experimental-WIP: Specifies the app module configuration of business manager module */\n interface DashboardApplicationData {\n /** List of bundles to be loaded for your module */\n bundles?: Bundle[];\n /** Your module id as defined in business-manager-api */\n _id?: string | null;\n /** List of available page components that your module is registering */\n pageComponents?: PageDashboardApplicationComponent[];\n /** The default component to load when another app navigates to your module */\n defaultPageComponentId?: string | null;\n /** Config section that will be provided to your lazy component and component along with all other properties from business-manager, if your config object will contain topology parameter, you'll be able to benefit from statics override machanism */\n config?: AppConfiguration;\n /** Allows an application to declare that when it's opened inside the business-manager without a deeplink the business-manager home should be shown. It currently only affects opening the app from Editor/ADI */\n useHomeAsLandingPage?: boolean | null;\n /** If there are some experiments that define if this page should be enabled, list of experiment lists with OR relationship between them, experiments should be in business manager scope */\n enabledByExperiments?: ExperimentGroupWrapper[];\n /** If this module should load in absence of any pages, by default this won't run */\n loadWithoutPages?: boolean | null;\n /** List of hosted component of the application */\n components?: HostedComponent[];\n }\n /** Specifes business manager module file bundle */\n interface Bundle {\n /** The JavaScript file to load */\n file?: string;\n /** If there are some experiments that define if this page should be enabled, list of experiment lists with OR relationship between them, experiments should be in business manager scope */\n enabledByExperiments?: ExperimentGroupWrapper[];\n /** A alternative debug file for debugging issues */\n debugFile?: string | null;\n }\n /** Specifies a list of experiments that have AND relationship between them, and OR relationship between each list */\n interface ExperimentGroupWrapper {\n /** list of experiments with AND relationship between them, for false value use ! before experiment spec */\n experimentsGroup?: string[];\n }\n /** Specifies page components for a business manager module */\n interface PageDashboardApplicationComponent {\n /** The id of the page */\n _id?: string;\n /** The route of the page, the part of the url after /dashboard/{msid}/ (must be unique in the specific application) */\n route?: string;\n /** The name you used to register this component to the ModuleRegistry (must be unique across apps) */\n name?: string;\n /** If there are some experiments that define if this page should be enabled, list of experiment lists with OR relationship between them, experiments should be in business manager scope. */\n enabledByExperiments?: ExperimentGroupWrapper[];\n /** Additional routes to the page */\n routeAliases?: string[];\n }\n /** Specifies config for topology and config data */\n interface AppConfiguration {\n /** A map of topology key to template url */\n topology?: Record;\n /** Config section that will be provided to your lazy component and component along with all other properties from business-manager, if your config object will contain topology parameter */\n configData?: Record;\n }\n /** Specifes business hosted component configuration */\n interface HostedComponent {\n /** A unique id for the component, maps between the host and name */\n _id?: string;\n /** The component name used in registerComponentWithModuleParams components can be shared by using the same name but a unique id */\n name?: string;\n /** Permissions required for the component, this is not strictly enforced */\n requiredPermission?: string;\n /** Represents the collection of components where the component will be hosted, get this value from the host provider. */\n hostContainerId?: HostContainerId;\n /** If there are some experiments that define if this page should be enabled, list of experiment lists with OR relationship between them, experiments should be in business manager scope */\n enabledByExperiments?: ExperimentGroupWrapper[];\n /** A URI used to send component error events */\n errorReporting?: ErrorReporting;\n }\n enum HostContainerId {\n BUSINESS_MANAGER = \"BUSINESS_MANAGER\",\n BUSINESS_DASHBOARD_HOST = \"BUSINESS_DASHBOARD_HOST\",\n SIDEBAR_FOOTER = \"SIDEBAR_FOOTER\"\n }\n /** Contact Labels Extensions */\n interface ContactLabelsComponentData {\n /** Allow app-defined labels (Check this box to allow apps to create labels in this namespace.) */\n allowAppDefinedLabels?: boolean | null;\n /**\n * Required permissions to manage app-defined labels\n * Only apps with this permission will be able to create labels in this namespace.\n * relevant if allow_app_defined_labels is true\n * (e.g. EMAIL_MARKETING.MANAGE_LABELS)\n */\n permission?: string | null;\n /**\n * Predefined labels\n * These labels exist on all sites that install the app.\n */\n predefinedLabels?: PredefinedLabel[];\n }\n interface PredefinedLabel {\n /**\n * Label key\n * Can contain letters, dashes, or underscores.\n * (e.g. my-label)\n */\n key?: string;\n /**\n * Display Name\n * Human-readable name to be shown on the UI.\n * (e.g. My Label)\n */\n displayName?: string;\n }\n /** A component to be rendered within Widget Slots */\n interface WidgetPluginComponentData {\n /** The ID of the actual widget used that is the Plugin component */\n referenceComponentId?: string;\n /** The APIs implemented by the Plugin's widget */\n pluginInterfaces?: PluginInterface[];\n /** Marketing information about the plugin */\n marketData?: PluginMarketData;\n /** The list of placements where the plugin is allowed to be installed */\n placements?: PluginPlacement[];\n /** Widget plugin installation settings */\n installation?: PluginInstallationSettings;\n }\n /** Marketing information about the plugin */\n interface PluginMarketData {\n /** The name of the Plugin */\n name?: string;\n /** The short description of the Plugin */\n description?: string;\n /** The logo of the Plugin, should be a square image 35 x 35 px in `JPG` or `PNG` format */\n logoUrl?: string | null;\n }\n /** Combination of IDs that uniquely identify a slot in the app component */\n interface PluginPlacement {\n /** Slot app definition ID */\n appDefinitionId?: string;\n /** Slot app component ID */\n widgetId?: string;\n /** Slot ID (a.k.a. Velo role) */\n slotId?: string;\n }\n interface PluginInstallationSettings {\n /** Shared installation settings for unified components */\n base?: BaseInstallation;\n }\n interface CrossSellConfig {\n /** uri for call implementor, could be one of `grpc://`, `velo://`, `https://` */\n baseUri?: string;\n }\n /** Local Delivery component */\n interface LocalDeliveryComponentData {\n /**\n * URL for the Delivery provider registration web page.\n * The App Instance and Account Id query parameters are attached to the registration URL\n * so that you can identify your account when accessing the vendor api. [learn more](https://devforum.wix.com/en/article/app-instance)\n */\n registrationUrl?: string;\n /**\n * The base URL for all the local delivery api calls.\n * Description of end points and schema can be find in the local delivery documentation.\n */\n apiBaseUri?: string;\n }\n /** Configuration for the payment service SPI implementor */\n interface PaymentServiceProviderConfig {\n /** Payment service provider to display on Accept payments tab in Business manager */\n title?: string;\n /** SPI base url */\n baseUrl?: string;\n /** Available payment methods */\n paymentMethods?: PaymentMethod[];\n /** Provider authentication methods */\n credentialsFields?: PaymentServiceProviderCredentialsField[];\n }\n interface PaymentMethod extends PaymentMethodMethodOneOf {\n /** Information about hosted page payment method */\n hostedPage?: HostedPage;\n }\n /** @oneof */\n interface PaymentMethodMethodOneOf {\n /** Information about hosted page payment method */\n hostedPage?: HostedPage;\n }\n interface HostedPage {\n /** The payment method title to be will be displayed on accept payments tab in business manager as well as on the checkout */\n title?: string;\n /** Url to images in different formats and colors */\n logos?: Logos;\n /** Billing address fields that buyer needs to fill in order to process payment with the specified payment method */\n billingAddressMandatoryFields?: MandatoryField[];\n }\n interface Logos {\n /** white theme logos */\n white?: Color;\n /** colored theme logos */\n colored?: Color;\n }\n interface Color {\n /** URL to SVG image */\n svg?: string;\n /** URL to PNG image */\n png?: string;\n }\n enum MandatoryField {\n ZIPCODE = \"ZIPCODE\",\n CITY = \"CITY\",\n STATE = \"STATE\",\n ADDRESS = \"ADDRESS\",\n COUNTRY_CODE = \"COUNTRY_CODE\",\n EMAIL = \"EMAIL\",\n PHONE = \"PHONE\",\n FIRST_NAME = \"FIRST_NAME\",\n LAST_NAME = \"LAST_NAME\",\n STREET = \"STREET\",\n HOUSE_NUMBER = \"HOUSE_NUMBER\",\n TAX_IDENTIFIER = \"TAX_IDENTIFIER\"\n }\n interface PaymentServiceProviderCredentialsField extends PaymentServiceProviderCredentialsFieldFieldOneOf {\n /** text field */\n simpleField?: SimpleField;\n /** checkbox field */\n checkboxField?: CheckboxField;\n /** dropdown field */\n dropdownField?: DropdownField;\n }\n /** @oneof */\n interface PaymentServiceProviderCredentialsFieldFieldOneOf {\n /** text field */\n simpleField?: SimpleField;\n /** checkbox field */\n checkboxField?: CheckboxField;\n /** dropdown field */\n dropdownField?: DropdownField;\n }\n interface SimpleField {\n /** field name */\n name?: string;\n /** field label */\n label?: string;\n }\n interface CheckboxField {\n /** field name */\n name?: string;\n /** field label */\n label?: string;\n /** field tooltip */\n tooltip?: string | null;\n }\n interface DropdownField {\n /** field name */\n name?: string;\n /** field label */\n label?: string;\n /** specific options */\n options?: DropdownFieldOption[];\n }\n interface DropdownFieldOption {\n /** option key */\n key?: string;\n /** option value */\n value?: string;\n }\n interface MembershipsSPIConfig {\n /** The URL of the SPI implementation */\n deploymentUri?: string;\n catalogAppDefIds?: string[];\n }\n interface LineItemsEnricherConfig {\n /** the base URI where all the methods are deployed. */\n baseUri?: string;\n }\n interface ShippingRatesConfig {\n /**\n * Base URI where the endpoints are called.\n * Wix eCommerce appends the endpoint path to the base URI.\n * For example, to call the Get Shipping Rates endpoint at `https://my-shipping-provider.com/v1/getRates`,\n * the base URI you provide here is `https://my-shipping-provider.com/`.\n */\n deploymentUri?: string;\n /** Human-readable name of the shipping provider. */\n name?: string;\n /** Description of the shipping provider. */\n description?: string | null;\n /** URL to more info about the shipping provider. */\n learnMoreUrl?: string | null;\n /** URL to reach the shipping provider app's dashboard. */\n dashboardUrl?: string | null;\n /** Whether to require the site owner to define a fallback/default rate. Set to `true` if you do not provide rates as part of the integration. */\n fallbackDefinitionMandatory?: boolean;\n /**\n * Thumbnail image of the shipping rates provider. Displayed in the shipping settings section in the Dashboard.\n * The URL must be of an image uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager).\n */\n thumbnailUrl?: string | null;\n }\n interface ShippingLabelCarrierSpiConfig {\n /** the base URI where all the methods are deployed */\n baseUri?: string;\n /** the countries supported to send from */\n originCountries?: string[];\n /** the countries supported to send to */\n destinationCountries?: string[];\n /** the currency of the labels */\n currency?: string;\n /** the measurement system of he labels (Metric or Imperial) */\n measurementSystem?: MeasurementSystem;\n /** does carrier support insurance */\n isInsuranceSupported?: boolean;\n /** preset carrier packages */\n packageTypes?: PackageType[];\n }\n enum MeasurementSystem {\n Metric = \"Metric\",\n Imperial = \"Imperial\"\n }\n interface PackageType {\n /** carrier id that can be used to get quotes and purchase */\n _id?: string;\n /** display name of the package (translated) */\n name?: string;\n /** description (translated) */\n description?: string;\n /** the dimensions of the package */\n dimension?: PackageDimension;\n /** image of the package (Optional) */\n image?: Image;\n }\n interface PackageDimension {\n /** width of the package */\n width?: number;\n /** length of the package */\n length?: number;\n /** height of the package (Optional) */\n height?: number | 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 /** Image alt text. Optional. */\n altText?: string | null;\n /**\n * Image URL expiration date (when relevant). Optional\n * @internal\n */\n urlExpirationDate?: Date;\n /** Image filename. Optional. */\n filename?: string | null;\n /**\n * Image size in bytes. Optional.\n * @internal\n */\n sizeInBytes?: string | null;\n }\n /** Restaurants POS component */\n interface RestaurantsPOSComponentData {\n /**\n * URL for the Restaurants POS registration web page.\n * The App Instance and Account Id query parameters are attached to the registration URL\n * so that you can identify your account when accessing the vendor api. [learn more](https://devforum.wix.com/en/article/app-instance)\n */\n registrationUrl?: string;\n /**\n * The base URL for all the Restaurants POS api calls.\n * Description of end points and schema can be find in the Restaurants POS documentation.\n */\n apiBaseUri?: string;\n /** Configuration parameters defining the behavoiur of the catalog sync. */\n catalogSyncConfiguration?: CatalogSyncConfiguration;\n }\n interface CatalogSyncConfiguration {\n /** Whether Menu/Section/Dish availability will be updated on the POS side or on Wix Menus. */\n entityAvailabilityUpdated?: Default;\n /** Whether fulfillment method will be defined on the POS side or on Wix menus. */\n fulfillmentMethodsDefinition?: Default;\n /** Whether Dish images will be updated on the POS side or on Wix Menus. */\n dishImagesUpdated?: Default;\n /** Whether sorting (Menu/Category/Dish/Options) will be done on the POS side (API order) or on Wix Menus. */\n entitySortingControl?: Default;\n /** Whether Labels will be updated on the POS side or on Wix Menus. */\n dishLabelsUpdated?: Default;\n /** whether min/max amount of choices to be set on the POS side or on Wix Menus. */\n dishOptionsMinMaxUpdated?: Default;\n /** Whether Dish in/out of stock will be updated on Wix Menus or retrieved from POS. */\n dishInStockUpdated?: Default;\n }\n enum Default {\n WIX = \"WIX\",\n POS = \"POS\"\n }\n interface ShippingProviderConfig {\n /** URI configuration of the deployment */\n deploymentUri?: SpiBaseUri;\n /** User-friendly name of the shipping provider */\n shippingCompanyName?: string;\n /** Cost of making a shipment */\n shippingPrice?: number;\n }\n interface SpiBaseUri {\n /** URI that will be used by the host to call the implementer. The path-suffix defined on the method will be appended to it */\n baseUri?: string;\n /** override method mappings per method */\n alternativeUris?: AlternativeUri[];\n }\n interface AlternativeUri {\n /** name of the method as it appears in the proto */\n methodName?: string;\n /** absolute uri that will be used by the host to call that method. The path-suffix mapped from the method http option will NOT be appended to this URI. For TPAs. it must be https */\n absoluteUri?: string;\n }\n interface AlertEnricherSpiConfiguration {\n deploymentUri?: string;\n }\n /** A component holding schema of Data Extensions */\n interface DataExtensionsComponentData {\n /**\n * Deprecated, use fqdn and schema instead.\n * @internal\n */\n schemas?: Record;\n /** FQDN of the entity that the application extends */\n fqdn?: string;\n /** Schema of the extended fields in JSON Schema compatible format */\n schema?: Record | null;\n }\n interface GenericHooksConfig {\n /** Hook definitions */\n hooks?: GenericHookConfig[];\n }\n enum HookType {\n UNDEFINED = \"UNDEFINED\",\n BEFORE_BLOCKING = \"BEFORE_BLOCKING\",\n BEFORE = \"BEFORE\",\n AFTER = \"AFTER\"\n }\n interface GenericHookConfig {\n /** FQN of proto service */\n serviceFqn?: string;\n /** Name of RPC inside given proto service */\n methodName?: string;\n /** An URI, which uniquely identifies the hook for invocation */\n uri?: string;\n /** Type of hook */\n hookType?: HookType;\n }\n interface ActionProviderSPIConfig {\n /** URL to action provider service for this action */\n baseUri?: string;\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 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 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 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 * Lets us know if we should wait for the action to complete before executing the next actions or finish and\n * expect a call back in actionCompleted method\n */\n executionType?: ExecutionType;\n metadata?: Metadata;\n /** chosen ui interface for action */\n interfaceConfiguration?: InterfaceConfiguration;\n /** icon representing the action in UI */\n icon?: string;\n }\n enum InterfaceConfigurationType {\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 /** Implements GetDynamicInputSchema */\n getDynamicInputSchema?: boolean;\n }\n enum ExecutionType {\n UNKNOWN_EXECUTION_TYPE = \"UNKNOWN_EXECUTION_TYPE\",\n SYNC = \"SYNC\",\n ASYNC = \"ASYNC\"\n }\n interface Metadata {\n /** if the action is hidden from Users in the UI (Wizard) */\n hidden?: boolean;\n }\n interface InterfaceConfiguration extends InterfaceConfigurationOptionsOneOf {\n widgetComponentOptions?: WidgetComponentOptions;\n genericOptions?: GenericOptions;\n /** type of chosen interface */\n type?: InterfaceConfigurationType;\n }\n /** @oneof */\n interface InterfaceConfigurationOptionsOneOf {\n widgetComponentOptions?: WidgetComponentOptions;\n genericOptions?: GenericOptions;\n }\n interface CatalogSPIConfig {\n /** The URL of the SPI implementation */\n deploymentUri?: string;\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 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 /** A container (slot) that can be extended by other applications (e.g. widget slot or context menu slot) */\n interface BackOfficeExtensionContainer {\n /** The properties that define this container */\n extendable?: Extendable;\n /**\n * The platform this page is hosted on (e.g. Wix Dashboard)\n * @internal\n */\n hostingPlatform?: BackOfficeHostingPlatforms;\n }\n /** Extensibility properties used by containers (slots) */\n interface Extendable {\n /** Component type allowed in this extendable (enum) */\n extendedBy?: ExtendingComponentType;\n }\n /** Which component types can be extended in containers */\n enum ExtendingComponentType {\n INVALID = \"INVALID\",\n BACK_OFFICE_MENU_ITEM = \"BACK_OFFICE_MENU_ITEM\",\n BACK_OFFICE_EXTENSION_WIDGET = \"BACK_OFFICE_EXTENSION_WIDGET\"\n }\n /** List of back-office hosting platforms */\n enum BackOfficeHostingPlatforms {\n NO_HOSTING_PLATFORM = \"NO_HOSTING_PLATFORM\",\n /** Site Dashboard (The Wix Dashboard) */\n BUSINESS_MANAGER = \"BUSINESS_MANAGER\",\n /** User Account Dashboard */\n ACCOUNT_MANAGER = \"ACCOUNT_MANAGER\",\n /** Internal: Dev center */\n DEV_CENTER = \"DEV_CENTER\",\n /** Enterprise dashboard (available to enterprise accounts only) */\n ENTERPRISE = \"ENTERPRISE\",\n /** Partners dashboard (available to partners accounts only) */\n PARTNERS_DASHBOARD = \"PARTNERS_DASHBOARD\",\n /** Employee only financial support dashboard */\n FINANCIALS_INTERNAL_BO = \"FINANCIALS_INTERNAL_BO\",\n /** FED Guild POC dashboard */\n FED_GUILD_POC = \"FED_GUILD_POC\",\n /** Studio dashboard */\n STUDIO_DASHBOARD = \"STUDIO_DASHBOARD\",\n /** Channels dashboard (available to channels accounts only) */\n CHANNELS = \"CHANNELS\",\n /** Wix internal dashboard for data tools */\n DATA_TOOLS = \"DATA_TOOLS\",\n /** Internal back-office for payment service provider management */\n PSP_BACKOFFICE = \"PSP_BACKOFFICE\",\n /** Rise.ai account dashboard */\n RISE_PLATFORM_ACCOUNT_DASHBOARD = \"RISE_PLATFORM_ACCOUNT_DASHBOARD\",\n /** Enterprise demo dashboard (available to possible enterprise accounts for demo purposes) */\n DEMO_DASHBOARD_ENTERPRISE = \"DEMO_DASHBOARD_ENTERPRISE\"\n }\n /**\n * A component that enables extending Wix Dashboard Functionality, as defined by ExtendingComponentType.\n * Currently this supports extending menus and extending widget slots (for Wix apps that expose such menus and slots)\n */\n interface BackOfficeExtension extends BackOfficeExtensionExtensionOneOf {\n /** Data for the widget extension type */\n widget?: LegacyBackOfficeExtensionWidget;\n /** Data for the menu item extension type */\n menuItem?: LegacyBackOfficeMenuItem;\n /** The Identifier of the container that this extension applies to (e.g. Widget slot or menu slot) */\n extends?: string;\n /** The title of the extension, as displayed in Dev Center */\n title?: string;\n /** The description of the extension, as displayed in Dev Center */\n description?: string | null;\n /** The type of this extension (e.g. Widget extension) */\n extensionType?: ExtendingComponentType;\n /** The platform this page is hosted on (e.g. The Wix Dashboard, or Enterprise Dashboard) */\n hostingPlatform?: BackOfficeHostingPlatforms;\n /**\n * Required permission to view the extension.\n * @internal\n */\n requiredPermission?: string;\n /**\n * Sentry error reporting DSN (internal)\n * @internal\n */\n errorReporting?: ErrorReporting;\n }\n /** @oneof */\n interface BackOfficeExtensionExtensionOneOf {\n /** Data for the widget extension type */\n widget?: LegacyBackOfficeExtensionWidget;\n /** Data for the menu item extension type */\n menuItem?: LegacyBackOfficeMenuItem;\n }\n /** The schema of a widget extending a slot exposed in a page in the Wix Dashboard */\n interface LegacyBackOfficeExtensionWidget extends LegacyBackOfficeExtensionWidgetAssetOneOf {\n /** Url of the iframe to render in the widget */\n iframeUrl?: string;\n /**\n * Wix script asset to use in this widget\n * @internal\n */\n scriptAsset?: BackOfficeScriptAsset;\n /** Initial widget width size in pixels while loading, width may be adjusted dynamicaly according to content and/or limited by the container */\n width?: number | null;\n /** Initial widget height size in pixels while loading, height may be adjusted dynamicaly according to content and/or limited by the container */\n height?: number | null;\n }\n /** @oneof */\n interface LegacyBackOfficeExtensionWidgetAssetOneOf {\n /** Url of the iframe to render in the widget */\n iframeUrl?: string;\n /**\n * Wix script asset to use in this widget\n * @internal\n */\n scriptAsset?: BackOfficeScriptAsset;\n }\n /** Internal: Specifications for loading an asset via JS in the back office */\n interface BackOfficeScriptAsset {\n /** The JavaScript file to load */\n url?: string;\n /** Namespacing of the component in the Webpack Module Federation registry */\n containerId?: string;\n /** Key name for the retrieval of the component */\n exportedName?: string;\n /** Optional: What type should by used on