import * as _wix_sdk_types from '@wix/sdk-types'; import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types'; /** * A program is an Online Programs course, challenge, or structured journey. * Programs contain lifecycle state, public description, timeline, access rules, * pricing, SEO, rewards, and summary information for their content. */ interface Program { /** * Program ID. * @format GUID * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating a program. * @readonly */ revision?: string | null; /** * Date and time the program was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the program was last updated. * @readonly */ _updatedDate?: Date | null; /** * Current program lifecycle status. * @readonly */ status?: StatusWithLiterals; /** * Date and time when `status` last changed. * @readonly */ statusUpdatedDate?: Date | null; /** * Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories. * @readonly * @format GUID * @maxSize 10 */ categoryIds?: string[]; /** Public-facing program title, details, and media. */ description?: Description; /** Program timeline settings. Use this to configure self-paced or scheduled programs. */ timeline?: Timeline; /** Program access, participation, and progression rules. */ restrictions?: Restrictions; /** * Optional one-time payment price for joining the program. When creating or updating a program, * provide `price.value` only. `price.currency` is read-only and is populated from the site's * payment currency in Site Properties. */ price?: Money; /** SEO settings used for the program page. */ seo?: Seo; /** * Rewards assigned to participants when they reach configured milestones. * @maxSize 10 */ rewards?: Reward[]; /** * ID of the social group connected to the program, if one exists. * @format GUID */ socialGroupId?: string | null; /** Custom fields for apps that extend the Program entity. */ extendedFields?: ExtendedFields; /** Whether to send an invoice after a single-payment purchase. When false, the buyer receives a payment confirmation email instead. */ shouldSendInvoice?: boolean; /** Settings that control how video steps behave in this program. */ videoStepsSettings?: VideoStepsSettings; /** * Read-only counts of content entities in the program. * @readonly */ contentSummary?: ContentSummary; /** * ID of the site user who created the program. * @format GUID * @readonly */ ownerUserId?: string | null; /** * Freemium enablement. Absent settings mean Freemium is disabled. * This field cannot be set through generic create or update operations. * @internal * @readonly */ freemiumSettings?: FreemiumSettings; } declare enum Status { /** The program is editable and visible only in management contexts. */ DRAFT = "DRAFT", /** The program is available according to its access restrictions. */ PUBLISHED = "PUBLISHED", /** The program is no longer available for new participation. */ ENDED = "ENDED", /** The program is closed and removed from normal public discovery. */ ARCHIVED = "ARCHIVED" } /** @enumType */ type StatusWithLiterals = Status | 'DRAFT' | 'PUBLISHED' | 'ENDED' | 'ARCHIVED'; /** Public program description and media. */ interface Description extends DescriptionMediaOneOf { /** Program image. */ image?: string; /** Program video. */ video?: string; /** * Program title. * @maxLength 150 */ title?: string; /** * Detailed program description. * @maxLength 8000 */ details?: string | null; } /** @oneof */ interface DescriptionMediaOneOf { /** Program image. */ image?: string; /** Program video. */ video?: string; } interface FocalPoint { /** X-coordinate of the focal point. */ x?: number; /** Y-coordinate of the focal point. */ y?: number; /** crop by height */ height?: number | null; /** crop by width */ width?: number | null; } interface VideoResolution { /** Video URL. */ url?: string; /** Video height. */ height?: number; /** Video width. */ width?: number; /** * Deprecated. Use the `posters` property in the parent entity instead. * @internal * @deprecated */ poster?: string; /** Video format for example, mp4, hls. */ format?: string; /** * Deprecated. Use the `urlExpirationDate` property in the parent entity instead. * @internal * @deprecated */ urlExpirationDate?: Date | null; /** * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution. * @internal * @format DECIMAL_VALUE * @deprecated */ sizeInBytes?: string | null; /** * Video quality. For example: 480p, 720p. * @internal */ quality?: string | null; /** * Video filename. * @internal */ filename?: string | null; /** * Video duration in seconds. * @internal * @readonly * @deprecated Video duration in seconds. * @replacedBy duration_in_milliseconds * @targetRemovalDate 2024-08-01 */ durationInSeconds?: number | null; /** * Video duration in milliseconds. * @internal * @readonly */ durationInMilliseconds?: number | null; /** * When true, this is a protected asset, and calling the URL will return a 403 error. * In order to access private assets, make a request to: * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request * @internal * @readonly */ private?: boolean | null; /** * Key to identify the video resolution's relationship to the original media in WixMedia. * Can be used to request a download for the specific video resolution. * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4 * @internal * @readonly */ assetKey?: string | null; } /** Program scheduling settings. */ interface Timeline { /** Whether participants can progress at their own pace. */ selfPaced?: boolean; /** * Local date when the scheduled program starts. * @format LOCAL_DATE */ startDate?: string | null; /** Scheduled program duration in days. */ durationInDays?: number | null; } /** Access and participation restrictions for a program. */ interface Restrictions { /** * Maximum number of active participants allowed in the program. * @min 1 */ maxParticipants?: number | null; /** Whether future steps are hidden from participants until they become available. */ hideFutureSteps?: boolean; /** Whether participants must complete steps in order. */ resolveStepsInOrder?: boolean; /** Whether participants can share progress in the connected group. */ shareProgress?: boolean; /** Program discovery and join access. When creating a program, explicitly set this field to `PUBLIC`, `PRIVATE`, or `SECRET` to avoid unintended visibility. If omitted, the access type defaults to `PUBLIC`. */ accessType?: AccessTypeWithLiterals; } declare enum AccessType { /** Anyone who can access the site can discover the program and start the join flow. */ PUBLIC = "PUBLIC", /** The program can be discovered, but joining requires owner approval. */ PRIVATE = "PRIVATE", /** The program is hidden from public discovery and visible only to participants, owners, and trusted apps. */ SECRET = "SECRET" } /** @enumType */ type AccessTypeWithLiterals = AccessType | 'PUBLIC' | 'PRIVATE' | 'SECRET'; /** Monetary amount for an Online Program. */ interface Money { /** * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). * @decimalValue options { gt:0.00, maxScale:3 } */ value?: string; /** * Site payment currency code in ISO 4217 format (for example, `USD`). This field is read-only and * is populated from Site Properties. Don't provide it when creating or updating a program. * @format CURRENCY * @readonly */ currency?: string; } /** SEO settings for the program page. */ interface Seo { /** * Unique URL slug for the program page. * @format URL_SLUG */ slug?: string; /** Advanced SEO schema data. */ seoData?: SeoSchema; /** * Program page URL. * @readonly */ url?: string; /** * Image URL derived from the program description media. * @format WEB_URL */ imageUrl?: string | null; /** * Alternative text for the SEO image. * @maxLength 1000 */ imageAlt?: string; /** * Approximate SEO program duration in ISO 8601 duration format. * @maxLength 100 * @readonly */ courseWorkload?: string; } /** * The SEO data for a single page or dynamic item, in the shape stored today. * * FROZEN. Existing server code maps onto this message field by field, so its * field set must never change (see the file header). New writers use * `SeoSchemaV2`. * * These tags are rendered into the of the HTML document and are not * visible on the page itself. They override every other source of tags * (site defaults, vertical presets, patterns) for this page. */ interface SeoSchema { /** * The tags rendered into , in no particular order. Render order is * decided by the renderer, not by position in this list. * * No maxSize: this list is already populated by data written years ago, and * a bound added now could reject a page that is already stored. */ tags?: Tag[]; /** Page-level SEO settings that are not themselves tags. */ settings?: Settings; } /** A keyword term the user is targeting. */ interface Keyword { /** * The term itself, e.g. "trail running shoes". * * No maxLength, for the same reason as the legacy tag fields: keywords are * already stored, and a bound added now could reject a record written * before the bound existed. The flynt `missing-string-validations` warning * on this field is accepted deliberately. */ term?: string; /** Whether this is the page's primary focus keyword. At most one per page. */ isMain?: boolean; /** * Which surface added the term, e.g. a panel or a suggestion flow. Used for * attribution in BI. Opaque to the renderer. * @maxLength 1000 */ origin?: string | null; } /** * One tag in the page's . * * Not deprecated, and with no removal date, deliberately: stored data is * never migrated, so this shape stays valid input forever. `seo-renderer` * normalizes both shapes on READ. */ interface Tag { /** * Legacy. Was a free-form string: "title" | "meta" | "script" | "link". * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes * the invalid combinations unrepresentable rather than merely discouraged. * * Which of these an API actually accepts depends on where the tag is being * set: this list is not a blanket guarantee across every API that reuses * this message. Site SEO Tags in particular accepts only `meta` (see * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation * error even though they appear here — check the field description of the * specific `tags`-typed field you are writing to. * * Limitation: `title` and `script` (e.g. a `script` tag with `props.type` * "application/ld+json" carrying structured data) are supported only when * `custom` is unset or `false`. Setting `custom: true` on a `title` or * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because * `custom: true` routes the write through the site's Advanced/Custom Tags * list. To write structured data, omit `custom` (or set it to `false`). * * No length limit: this field holds data written years ago by writers we * are not migrating. A constraint here could reject a record that is * already stored, which is exactly the promise this design makes. */ type?: string; /** * Legacy. Was an untyped bag of HTML attributes. * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`. */ props?: Record | null; /** * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2` * its contents are split by purpose: per-page structured-data state moves to * StructuredDataTag, authorship to `written_by`, and render-time preset * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the * stored document entirely — it belongs to the preset definition, not to the * page. See the design log for the full key-by-key mapping. */ meta?: Record | null; /** * Legacy. Was the tag's inner content, doubling as the JSON-LD payload * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and * `StructuredDataTag.json_ld`. * No length limit, for the same reason as `type` above. */ children?: string; /** * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) — * i.e. an entry from the site's Advanced/Custom Tags list. * * Setting this to `true` on a write restricts which `type` values are * accepted — the same restriction the Advanced/Custom Tags UI enforces. * `title` and `script` tags (including JSON-LD structured data) must be sent * with `custom` omitted or `false`; sending them with `custom: true` is * rejected with `TAG_TYPE_NOT_ALLOWED`. * * Note this is a separate restriction from Site SEO Tags' own type * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags * rejects `script` (e.g. for site-wide structured data) unconditionally. * There is currently no way to set site-wide, every-page structured data * through any of these APIs — write a per-page `script` tag through the Item * SEO Tags API instead. * * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed * default/pattern — standard tags always resolve with `custom: false`, even when their content comes * from a page's manually saved SEO title/description override. Don't use this field to verify whether * a live page reflects a manual per-page SEO edit. * * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the * response entirely — there, `false` means this API could not tell, not that no custom tag exists. * Pass `seoData` explicitly to resolve against a known set of tags. * * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`. */ custom?: boolean; /** * Whether the tag is excluded from the rendered . * * A disabled tag is still stored, so the user can re-enable it and so a * pattern-provided tag stays suppressed on this page. Default false. */ disabled?: boolean; } /** Page-level SEO settings that are not tags. */ interface Settings { /** * Whether to suppress the automatic redirect from this page's previous URL to * its current one after a slug change. * * Default false, meaning the redirect IS created. The field is named for the * exception rather than the rule, which reads backwards; kept as-is because * renaming a stored boolean is not worth the migration. */ preventAutoRedirect?: boolean; /** * Keyword terms the user is targeting for this page. Used by the SEO * assistant and checklist; never rendered into . * * 20 is a sanity bound, not the product limit. v1 declared 5 — the number * the panel happens to allow today — which is exactly the mistake we are * fixing for structured data. A product decision to allow 8 should not need * a proto release, so the panel owns that number and the proto only stops * something absurd. * @maxSize 20 */ keywords?: Keyword[]; } /** Reward configuration for a program milestone. */ interface Reward { /** Program milestone that grants the reward. If omitted, the trigger defaults to `JOINED_TO_PROGRAM` for compatibility with existing rewards. */ trigger?: TriggerWithLiterals; /** * Badge IDs to assign when the reward is granted. * @format GUID * @maxSize 50 */ badgeIds?: string[]; /** Certificate assigned when the reward is granted. */ certificate?: Certificate; } declare enum Trigger { /** Default trigger for existing rewards. The reward is granted when a member joins the program. */ JOINED_TO_PROGRAM = "JOINED_TO_PROGRAM", /** The reward is granted when at least one step is completed. */ STEP_COMPLETED = "STEP_COMPLETED", /** The reward is granted when all required steps are completed. */ ALL_STEPS_COMPLETED = "ALL_STEPS_COMPLETED" } /** @enumType */ type TriggerWithLiterals = Trigger | 'JOINED_TO_PROGRAM' | 'STEP_COMPLETED' | 'ALL_STEPS_COMPLETED'; /** Certificate reward metadata. */ interface Certificate { /** * Certificate ID. Currently this is the program GUID. * @format GUID */ _id?: string; /** Date and time the certificate was connected to the program. */ connectedDate?: Date | null; } interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } /** Video step playback and completion settings. */ interface VideoStepsSettings { /** Whether the participant is automatically moved to the next video step after finishing the current one. */ autoNavigate?: boolean; /** Percentage of a video that must be watched to complete a video step. */ requiredCompletionPercentage?: number; } /** Read-only summary of program content. */ interface ContentSummary { /** * Number of steps in the program. * @max 3000 */ stepCount?: number; /** * Number of sections in the program. * @max 1000 */ sectionCount?: number; } /** Program Freemium enablement settings. Divider placement is stored separately. */ interface FreemiumSettings { /** * Whether Freemium is enabled. Defaults to false. * @internal * @readonly */ enabled?: boolean; } /** Triggered when a program is published. */ interface ProgramPublished { /** Snapshot of the program after it was published. */ program?: Program; } /** Triggered when a program ends, either automatically or manually by the owner. */ interface ProgramEnded { /** Whether the program was ended manually by the owner. */ endedByOwner?: boolean; /** Snapshot of the program after it ended. */ program?: Program; } /** Triggered when a program is archived. */ interface ProgramArchived { /** Snapshot of the program after it was archived. */ program?: Program; } /** Triggered when a program is duplicated. */ interface ProgramDuplicated { /** Newly created program. */ program?: Program; /** Program that was duplicated. */ duplicatedFrom?: Program; /** Whether the program was cloned from a template. */ fromTemplate?: boolean; } /** Triggered when a program's Freemium setting changes to enabled. */ interface ProgramFreemiumEnabled { /** * Snapshot of the program after the mode change committed. * @internal */ program?: Program; } /** Triggered when a program's Freemium setting changes to disabled. */ interface ProgramFreemiumDisabled { /** * Snapshot of the program after the mode change committed. * @internal */ program?: Program; } interface GetPageRequest { /** * The site's assigned router prefix, including the leading slash. * @maxLength 512 */ routerPrefix?: string; /** * Encoded path after the prefix. Literal slashes separate route segments. * @maxLength 4096 */ routerSuffix?: string; /** * Absolute site URL, including the site base path and requested route. * @format WEB_URL */ fullUrl?: string; /** * Maps router roles to site-specific installed pages. * @maxSize 20 */ pageRoles?: Record; /** Platform router configuration; it does not grant access to programs. */ config?: Record | null; /** Rendering information; it is not an authorization claim. */ requestInfo?: Record | null; /** Page variations supplied by the Viewer; they do not override program identity. */ roleVariations?: Record | null; /** * Editor page override supplied by the Viewer, subject to connected-role checks. * @maxLength 255 */ dynamicPageIdOverride?: string; } interface ProgramRouterPageRole { /** * Site-specific installed page ID. * @maxLength 255 */ _id?: string; /** * Display title of the connected page. * @maxLength 1000 */ title?: string; } interface GetPageResponse { /** Page result consumed by the Viewer. Router status is inside this envelope. */ result?: ProgramRouterPageResult; } interface ProgramRouterPageResult { /** * Site response status, such as 200 for a page or 404 for a missing route. * @min 100 * @max 599 */ status?: number; /** * Site-specific installed page ID selected from the request's page roles. * @maxLength 255 */ page?: string; /** Authorized program data and the selected learning target. */ publicData?: ProgramRouterData; /** Platform-supported page head metadata. */ head?: Record | null; /** * Safe routing-error description without private program content. * @maxLength 1000 */ message?: string; } interface ProgramRouterData extends ProgramRouterDataSelectionOneOf { /** * Selected step after verifying that it belongs to the program. * @format GUID */ stepId?: string; /** Whether the program description was requested. */ description?: boolean; /** Full Program API object, returned only after router access checks pass. */ program?: Program; } /** @oneof */ interface ProgramRouterDataSelectionOneOf { /** * Selected step after verifying that it belongs to the program. * @format GUID */ stepId?: string; /** Whether the program description was requested. */ description?: boolean; } interface GetSitemapRequest { /** * The site's assigned router prefix, including the leading slash. * @maxLength 512 */ routerPrefix?: string; /** * Encoded path after the prefix. Literal slashes separate route segments. * @maxLength 4096 */ routerSuffix?: string; /** * Absolute site URL, including the site base path and requested route. * @format WEB_URL */ fullUrl?: string; /** * Maps router roles to site-specific installed pages. * @maxSize 20 */ pageRoles?: Record; /** Platform router configuration; it does not grant access to programs. */ config?: Record | null; /** Rendering information; it is not an authorization claim. */ requestInfo?: Record | null; /** Page variations supplied by the Viewer; they do not override program identity. */ roleVariations?: Record | null; /** * Editor page override supplied by the Viewer, subject to connected-role checks. * @maxLength 255 */ dynamicPageIdOverride?: string; } interface GetSitemapResponse { /** Connected Builder routes, including an explicit empty array when no routes are visible. */ result?: any; } interface GetSitemapCountRequest { /** * The site's assigned router prefix, including the leading slash. * @maxLength 512 */ routerPrefix?: string; /** * Encoded path after the prefix. Literal slashes separate route segments. * @maxLength 4096 */ routerSuffix?: string; /** * Absolute site URL, including the site base path and requested route. * @format WEB_URL */ fullUrl?: string; /** * Maps router roles to site-specific installed pages. * @maxSize 20 */ pageRoles?: Record; /** Platform router configuration; it does not grant access to programs. */ config?: Record | null; /** Rendering information; it is not an authorization claim. */ requestInfo?: Record | null; /** Page variations supplied by the Viewer; they do not override program identity. */ roleVariations?: Record | null; /** * Editor page override supplied by the Viewer, subject to connected-role checks. * @maxLength 255 */ dynamicPageIdOverride?: string; } interface GetSitemapCountResponse { /** Per-page route counts, including explicit numeric zeroes and an explicit empty array. */ result?: any; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ _id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entity?: string; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntity?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntity?: string | null; } interface ActionEvent { body?: string; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf { /** insert/update documents */ update?: DocumentUpdateOperation; /** delete by document ids */ deleteByIds?: DeleteByIdsOperation; /** delete documents matching filter */ deleteByFilter?: DeleteByFilterOperation; /** update documents matching filter */ updateByFilter?: UpdateByFilterOperation; /** update only existing documents */ updateExisting?: UpdateExistingOperation; /** * application which owns documents * @minLength 2 */ appDefId?: string | null; /** * type of the documents * @minLength 2 */ documentType?: string | null; /** * language of the documents * @minLength 2 */ language?: string | null; /** * site documents belong to * @minLength 2 */ msId?: string | null; } /** @oneof */ interface UpdateDocumentsEventOperationOneOf { /** insert/update documents */ update?: DocumentUpdateOperation; /** delete by document ids */ deleteByIds?: DeleteByIdsOperation; /** delete documents matching filter */ deleteByFilter?: DeleteByFilterOperation; /** update documents matching filter */ updateByFilter?: UpdateByFilterOperation; /** update only existing documents */ updateExisting?: UpdateExistingOperation; } interface DocumentUpdateOperation { /** documents to index or update */ documents?: IndexDocument[]; } interface IndexDocument { /** data bag with non-searchable fields (url, image) */ payload?: DocumentPayload; /** what type of users should documents be visible to */ exposure?: EnumWithLiterals; /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */ document?: Record | null; /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */ permittedMemberGroups?: string[]; /** if true SEO is disabled for this document */ seoHidden?: boolean | null; /** if true the page is a lightbox popup */ isPopup?: boolean | null; } interface DocumentPayload { /** url of the page representing the document */ url?: string | null; /** image which represents the document */ documentImage?: DocumentImage; } interface DocumentImage { /** the name of the image */ name?: string; /** the width of the image */ width?: number; /** the height of the image */ height?: number; } declare enum Enum { /** Default value. Means that permission not set */ UNKNOWN = "UNKNOWN", /** Protected exposure. Exposed to members and owners */ PROTECTED = "PROTECTED", /** Private exposure. Exposed to owners */ PRIVATE = "PRIVATE", /** Public exposure. Visible to everyone */ PUBLIC = "PUBLIC", /** Used for partial updates, to state that exposure is not changing */ UNCHANGED = "UNCHANGED", /** Protected to members of permitted groups and owners */ GROUP_PROTECTED = "GROUP_PROTECTED" } /** @enumType */ type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED'; interface DeleteByIdsOperation { /** ids of the documents to delete */ documentIds?: string[]; } interface DeleteByFilterOperation { /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */ filter?: Record | null; } interface UpdateByFilterOperation { /** documents matching this filter will be updated */ filter?: Record | null; /** partial document to apply */ document?: IndexDocument; } interface UpdateExistingOperation { /** documents to update */ documents?: IndexDocument[]; } interface InvalidateCache extends InvalidateCacheGetByOneOf { /** * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ metaSiteId?: string; /** * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; /** * tell us why you're invalidating the cache. You don't need to add your app name * @maxLength 256 */ reason?: string | null; /** Is local DS */ localDc?: boolean; hardPurge?: boolean; /** * Optional caller-provided ID for tracking this invalidation through the system. * When set, the corresponding CDN purge completion event will include this ID, * allowing you to confirm when the invalidation has fully propagated. * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event. * @maxLength 256 */ correlationId?: string | null; } /** @oneof */ interface InvalidateCacheGetByOneOf { /** * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ metaSiteId?: string; /** * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! * @format GUID */ siteId?: string; /** Invalidate by App */ app?: App; /** Invalidate by page id */ page?: Page; /** Invalidate by URI path */ uri?: URI; /** Invalidate by file (for media files such as PDFs) */ file?: File; /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */ customTag?: CustomTag; /** Invalidate by multiple page ids */ pages?: Pages; /** Invalidate by multiple URI paths */ uris?: URIs; } interface App { /** * The AppDefId * @minLength 1 */ appDefId?: string; /** * The instance Id * @format GUID */ instanceId?: string; } interface Page { /** * the msid the page is on * @format GUID */ metaSiteId?: string; /** * Invalidate by Page ID * @minLength 1 */ pageId?: string; } interface URI { /** * the msid the URI is on * @format GUID */ metaSiteId?: string; /** * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes * @minLength 1 */ uriPath?: string; } interface File { /** * the msid the file is related to * @format GUID */ metaSiteId?: string; /** * Invalidate by filename (for media files such as PDFs) * @minLength 1 * @maxLength 256 */ fileName?: string; } interface CustomTag { /** * the msid the tag is related to * @format GUID */ metaSiteId?: string; /** * Tag to invalidate by * @minLength 1 * @maxLength 256 */ tag?: string; } interface Pages { /** * the msid the pages are on * @format GUID */ metaSiteId?: string; /** * Invalidate by multiple Page IDs in a single message * @maxSize 100 * @minLength 1 */ pageIds?: string[]; } interface URIs { /** * the msid the URIs are on * @format GUID */ metaSiteId?: string; /** * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes * @maxSize 100 * @minLength 1 */ uriPaths?: string[]; } /** * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as * performs context manipulation with adding tenant, provided in message to callscope. */ interface ReindexMessage extends ReindexMessageActionOneOf { upsert?: Upsert; delete?: Delete; entityFqdn?: string; tenantId?: string; eventTime?: Date | null; entityEventSequence?: string | null; schema?: Schema; } /** @oneof */ interface ReindexMessageActionOneOf { upsert?: Upsert; delete?: Delete; } interface Upsert { entityId?: string; entityAsJson?: string; } interface Delete { entityId?: string; } interface Schema { label?: string; clusterName?: string; } interface CreateProgramRequest { /** Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. */ program: Program; } interface CreateProgramResponse { /** Created draft program. */ program?: Program; } interface BulkCreateProgramsMigrationRequest { /** * List of programs you want to create * @minSize 1 * @maxSize 100 */ programs?: ProgramMigration[]; } interface ProgramMigration { /** program to create */ program?: Program; /** * section ids in program * @maxSize 5000 * @format GUID */ sectionIds?: string[]; /** * step ids in program * @maxSize 5000 * @format GUID */ stepIds?: string[]; } interface BulkCreateProgramsMigrationResponse { /** Results of bulk action. */ results?: BulkProgramResult[]; /** Metadata about whole bulk action. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkProgramResult { /** Metadata of item. */ itemMetadata?: ItemMetadata; /** Item itself (empty if return_entity in request is false). */ item?: Program; /** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */ action?: BulkActionTypeWithLiterals; } interface ItemMetadata { /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */ _id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } declare enum BulkActionType { /** UNKNOWN_ACTION_TYPE */ UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE", /** INSERT */ INSERT = "INSERT", /** UPDATE */ UPDATE = "UPDATE", /** DELETE */ DELETE = "DELETE" } /** @enumType */ type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE' | 'DELETE'; interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface DeleteAllProgramsMigrationRequest { } interface DeleteAllProgramsMigrationResponse { } interface RestoreProgramFromTrashRequest { /** * ID of the deleted program to restore. * @format GUID */ programId?: string; } interface RestoreProgramFromTrashResponse { /** Restored draft program. Remains a draft even when some content can't be restored. */ program?: Program; /** * Result for each recorded section, including sections already present in this program. * @maxSize 5000 */ sectionResults?: ItemMetadata[]; /** * Result for each recorded step. Steps aren't attempted until all sections are available. * @maxSize 5000 */ stepResults?: ItemMetadata[]; /** Summary of the section and step results. Any failure means recovery is incomplete. */ contentActionMetadata?: BulkActionMetadata; } interface DuplicateProgramRequest { /** * ID of the program to duplicate. * @format GUID */ programId: string; } interface DuplicateProgramResponse { /** New draft program created from the source program. */ program?: Program; } interface GetProgramRequest { /** * ID of the program to retrieve. * @format GUID */ programId: string; } interface GetProgramResponse { /** Requested program. */ program?: Program; } interface UpdateProgramRequest { /** Program fields to update. Include `id` and the latest `revision`. */ program: Program; /** * The list of fields to update. For REST requests, this list is inferred from the request body. * @internal */ fieldMask?: string[]; } interface UpdateProgramResponse { /** Updated program. */ program?: Program; } interface WrongStateErrorDetails { } interface WrongStartDateErrorDetails { } interface WrongParticipantsNumberErrorDetails { /** Number of active participants already in the program. */ activeParticipantsCount?: number; } interface DuplicatedSlugErrorDetails { } interface TimelineSwitchForbiddenErrorDetails { } interface DeleteProgramRequest { /** * ID of the program to delete. * @format GUID */ programId: string; } interface DeleteProgramResponse { } interface QueryProgramsRequest { /** Query used to filter, sort, and page programs. */ query?: QueryV2; } interface QueryV2 extends QueryV2PagingMethodOneOf { /** Paging options to limit and skip the number of items. */ paging?: Paging; /** 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`. */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language). */ filter?: Record | null; /** * Sort object. * * Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). * @maxSize 100 */ sort?: Sorting[]; /** * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. * @maxSize 100 * @maxLength 1000 */ fields?: string[]; /** * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. * @maxSize 100 * @maxLength 1000 */ fieldsets?: string[]; } /** @oneof */ interface QueryV2PagingMethodOneOf { /** Paging options to limit and skip the number of items. */ paging?: Paging; /** 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`. */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; /** * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. * * If multiple filters are provided, they are combined with AND operator. * * Example: * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } * @internal * @maxSize 10 */ selectItemsBy?: Record[] | null; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface Paging { /** Number of items to load. */ limit?: number | null; offset?: number | null; } interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface QueryProgramsResponse { /** Programs that match the query and caller visibility. */ programs?: Program[]; /** Paging metadata for the query response. */ pagingMetadata?: PagingMetadataV2; } interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. * @internal */ hasNext?: boolean | null; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface SearchProgramsRequest { /** Search expression, filters, sorting, and cursor paging options. */ search?: CursorSearch; } interface CursorSearch extends CursorSearchPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language). */ filter?: Record | null; /** * List of sort objects. * * Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). * @maxSize 10 */ sort?: Sorting[]; /** * 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. * @maxSize 10 */ aggregations?: Aggregation[]; /** Free text to match in searchable fields. */ search?: SearchDetails; /** * UTC offset or IANA time zone. Valid values are * ISO 8601 UTC offsets, such as +02:00 or -06:00, * and IANA time zone IDs, such as Europe/Rome. * * Affects all filters and aggregations returned values. * You may override this behavior in a specific filter by providing * timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`. * @maxLength 50 */ timeZone?: string | null; } /** @oneof */ interface CursorSearchPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). */ cursorPaging?: CursorPaging; } interface Aggregation extends AggregationKindOneOf { /** Value aggregation. */ value?: ValueAggregation; /** Range aggregation. */ range?: RangeAggregation; /** Scalar aggregation. */ scalar?: ScalarAggregation; /** Date histogram aggregation. */ dateHistogram?: DateHistogramAggregation; /** Nested aggregation. */ nested?: NestedAggregation; /** * User-defined name of aggregation, should be unique, will appear in aggregation results. * @maxLength 100 */ name?: string | null; /** Type of aggregation, client must provide matching aggregation field below. */ type?: AggregationTypeWithLiterals; /** * Field to aggregate by, use dot notation to specify json path. * @maxLength 200 */ fieldPath?: string; /** * Deprecated. Use `nested` instead. * @deprecated Deprecated. Use `nested` instead. * @replacedBy kind.nested * @targetRemovalDate 2024-03-30 */ groupBy?: GroupByAggregation; } /** @oneof */ interface AggregationKindOneOf { /** Value aggregation. */ value?: ValueAggregation; /** Range aggregation. */ range?: RangeAggregation; /** Scalar aggregation. */ scalar?: ScalarAggregation; /** Date histogram aggregation. */ dateHistogram?: DateHistogramAggregation; /** Nested aggregation. */ nested?: NestedAggregation; } interface RangeBucket { /** Inclusive lower bound of the range. Required if `to` is not provided. */ from?: number | null; /** Exclusive upper bound of the range. Required if `from` is not provided. */ to?: number | null; } declare enum SortType { /** Sort by number of matches. */ COUNT = "COUNT", /** Sort by value of the field alphabetically. */ VALUE = "VALUE" } /** @enumType */ type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE'; declare enum SortDirection { /** Sort in descending order. */ DESC = "DESC", /** Sort in ascending order. */ ASC = "ASC" } /** @enumType */ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC'; declare enum MissingValues { /** Exclude missing values from the aggregation results. */ EXCLUDE = "EXCLUDE", /** Include missing values in the aggregation results. */ INCLUDE = "INCLUDE" } /** @enumType */ type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE'; interface IncludeMissingValuesOptions { /** * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... * @maxLength 20 */ addToBucket?: string; } declare enum ScalarType { /** Count of distinct values. */ COUNT_DISTINCT = "COUNT_DISTINCT", /** Minimum value. */ MIN = "MIN", /** Maximum value. */ MAX = "MAX", /** * Sum of values. * @internal */ SUM = "SUM", /** * Average of values. * @internal */ AVG = "AVG" } /** @enumType */ type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX'; interface ValueAggregation extends ValueAggregationOptionsOneOf { /** Options for including missing values. */ includeOptions?: IncludeMissingValuesOptions; /** Whether to sort by number of matches or value of the field. */ sortType?: SortTypeWithLiterals; /** Whether to sort in ascending or descending order. */ sortDirection?: SortDirectionWithLiterals; /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */ limit?: number | null; /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */ missingValues?: MissingValuesWithLiterals; } /** @oneof */ interface ValueAggregationOptionsOneOf { /** Options for including missing values. */ includeOptions?: IncludeMissingValuesOptions; } declare enum NestedAggregationType { /** An aggregation where result buckets are dynamically built - one per unique value. */ VALUE = "VALUE", /** An aggregation, where user can define set of ranges - each representing a bucket. */ RANGE = "RANGE", /** A single-value metric aggregation. For example, min, max, sum, avg. */ SCALAR = "SCALAR", /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */ DATE_HISTOGRAM = "DATE_HISTOGRAM" } /** @enumType */ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM'; interface RangeAggregation { /** * 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. * @maxSize 50 */ buckets?: RangeBucket[]; } interface ScalarAggregation { /** Define the operator for the scalar aggregation. */ type?: ScalarTypeWithLiterals; } interface DateHistogramAggregation { /** Interval for date histogram aggregation. */ interval?: IntervalWithLiterals; } declare enum Interval { /** Yearly interval */ YEAR = "YEAR", /** Monthly interval */ MONTH = "MONTH", /** Weekly interval */ WEEK = "WEEK", /** Daily interval */ DAY = "DAY", /** Hourly interval */ HOUR = "HOUR", /** Minute interval */ MINUTE = "MINUTE", /** Second interval */ SECOND = "SECOND" } /** @enumType */ type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND'; interface NestedAggregationItem extends NestedAggregationItemKindOneOf { /** Value aggregation. */ value?: ValueAggregation; /** Range aggregation. */ range?: RangeAggregation; /** Scalar aggregation. */ scalar?: ScalarAggregation; /** Date histogram aggregation. */ dateHistogram?: DateHistogramAggregation; /** * User-defined name of aggregation, should be unique, will appear in aggregation results. * @maxLength 100 */ name?: string | null; /** Type of aggregation, client must provide matching aggregation field below. */ type?: NestedAggregationTypeWithLiterals; /** * Field to aggregate by, use dot notation to specify json path. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface NestedAggregationItemKindOneOf { /** Value aggregation. */ value?: ValueAggregation; /** Range aggregation. */ range?: RangeAggregation; /** Scalar aggregation. */ scalar?: ScalarAggregation; /** Date histogram aggregation. */ dateHistogram?: DateHistogramAggregation; } declare enum AggregationType { /** An aggregation where result buckets are dynamically built - one per unique value. */ VALUE = "VALUE", /** An aggregation, where user can define set of ranges - each representing a bucket. */ RANGE = "RANGE", /** A single-value metric aggregation. For example, min, max, sum, avg. */ SCALAR = "SCALAR", /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */ DATE_HISTOGRAM = "DATE_HISTOGRAM", /** Multi-level aggregation, where each next aggregation is nested within previous one. */ NESTED = "NESTED" } /** @enumType */ type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED'; /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */ interface NestedAggregation { /** * Flattened list of aggregations, where each next aggregation is nested within previous one. * @minSize 2 * @maxSize 3 */ nestedAggregations?: NestedAggregationItem[]; } interface GroupByAggregation extends GroupByAggregationKindOneOf { /** Value aggregation configuration. */ value?: ValueAggregation; /** * User-defined name of aggregation, should be unique, will appear in aggregation results. * @maxLength 100 */ name?: string | null; /** * Field to aggregate by. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface GroupByAggregationKindOneOf { /** Value aggregation configuration. */ value?: ValueAggregation; } interface SearchDetails { /** Defines how separate search terms in `expression` are combined. */ mode?: ModeWithLiterals; /** * Search term or expression. * @maxLength 100 */ expression?: string | null; /** * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. * @maxLength 200 * @maxSize 20 */ fields?: string[]; /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */ fuzzy?: boolean; } declare enum Mode { /** Any of the search terms must be present. */ OR = "OR", /** All search terms must be present. */ AND = "AND" } /** @enumType */ type ModeWithLiterals = Mode | 'OR' | 'AND'; interface SearchProgramsResponse { /** Programs that match the search and caller visibility. */ programs?: Program[]; /** Cursor paging metadata. */ pagingMetadata?: CursorPagingMetadata; /** Aggregation data returned by the search backend. */ aggregationData?: AggregationData; } interface CursorPagingMetadata { /** Number of items returned in current page. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; /** * Total number of items matching the filter. * Available only on the first page of *Search* results, not included in *Query* or *List* results. * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page. * @internal */ total?: number | null; } interface AggregationData { /** * key = aggregation name (as derived from search request). * @maxSize 10000 */ results?: AggregationResults[]; } interface ValueAggregationResult { /** * Value of the field. * @maxLength 100 */ value?: string; /** Count of entities with this value. */ count?: number; } interface RangeAggregationResult { /** Inclusive lower bound of the range. */ from?: number | null; /** Exclusive upper bound of the range. */ to?: number | null; /** Count of entities in this range. */ count?: number; } interface NestedAggregationResults extends NestedAggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; /** * User-defined name of aggregation, matches the one provided in request. * @maxLength 100 */ name?: string; /** Type of aggregation that matches result. */ type?: AggregationTypeWithLiterals; /** * Field to aggregate by, matches the one provided in request. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface NestedAggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; } interface ValueResults { /** * List of value aggregations. * @maxSize 250 */ results?: ValueAggregationResult[]; } interface RangeResults { /** * List of ranges returned in same order as requested. * @maxSize 50 */ results?: RangeAggregationResult[]; } interface AggregationResultsScalarResult { /** Type of scalar aggregation. */ type?: ScalarTypeWithLiterals; /** Value of the scalar aggregation. */ value?: number; } interface NestedValueAggregationResult { /** * Value of the field. * @maxLength 1000 */ value?: string; /** Nested aggregations. */ nestedResults?: NestedAggregationResults; } interface ValueResult { /** * Value of the field. * @maxLength 1000 */ value?: string; /** Count of entities with this value. */ count?: number | null; } interface RangeResult { /** Inclusive lower bound of the range. */ from?: number | null; /** Exclusive upper bound of the range. */ to?: number | null; /** Count of entities in this range. */ count?: number | null; } interface ScalarResult { /** Value of the scalar aggregation. */ value?: number; } interface NestedResultValue extends NestedResultValueResultOneOf { /** Value aggregation result. */ value?: ValueResult; /** Range aggregation result. */ range?: RangeResult; /** Scalar aggregation result. */ scalar?: ScalarResult; /** Date histogram aggregation result. */ dateHistogram?: ValueResult; } /** @oneof */ interface NestedResultValueResultOneOf { /** Value aggregation result. */ value?: ValueResult; /** Range aggregation result. */ range?: RangeResult; /** Scalar aggregation result. */ scalar?: ScalarResult; /** Date histogram aggregation result. */ dateHistogram?: ValueResult; } interface Results { /** List of nested aggregations. */ results?: Record; } interface DateHistogramResult { /** * Date in ISO 8601 format. * @maxLength 100 */ value?: string; /** Count of documents in the bucket. */ count?: number; } interface GroupByValueResults { /** * List of value aggregations. * @maxSize 1000 */ results?: NestedValueAggregationResult[]; } interface DateHistogramResults { /** * List of date histogram aggregations. * @maxSize 200 */ results?: DateHistogramResult[]; } /** * Results of `NESTED` aggregation type in a flattened form. * Aggregations in resulting array are keyed by requested aggregation `name`. */ interface NestedResults { /** * List of nested aggregations. * @maxSize 1000 */ results?: Results[]; } interface AggregationResults extends AggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; /** Group by value aggregation results. */ groupedByValue?: GroupByValueResults; /** Date histogram aggregation results. */ dateHistogram?: DateHistogramResults; /** Nested aggregation results. */ nested?: NestedResults; /** * User-defined name of aggregation as derived from search request. * @maxLength 100 */ name?: string; /** Type of aggregation that must match provided kind as derived from search request. */ type?: AggregationTypeWithLiterals; /** * Field to aggregate by as derived from search request. * @maxLength 200 */ fieldPath?: string; } /** @oneof */ interface AggregationResultsResultOneOf { /** Value aggregation results. */ values?: ValueResults; /** Range aggregation results. */ ranges?: RangeResults; /** Scalar aggregation results. */ scalar?: AggregationResultsScalarResult; /** Group by value aggregation results. */ groupedByValue?: GroupByValueResults; /** Date histogram aggregation results. */ dateHistogram?: DateHistogramResults; /** Nested aggregation results. */ nested?: NestedResults; } interface PublishProgramRequest { /** * ID of the draft program to publish. * @format GUID */ programId: string; } interface PublishProgramResponse { /** Published program. */ program?: Program; } interface EndProgramRequest { /** * ID of the published program to end. * @format GUID */ programId: string; } interface EndProgramResponse { /** Ended program. */ program?: Program; } interface ArchiveProgramRequest { /** * ID of the program to archive. * @format GUID */ programId: string; } interface ArchiveProgramResponse { /** Archived program. */ program?: Program; } interface EnableProgramFreemiumRequest { /** * ID of the program to enable Freemium for. * @format GUID */ programId: string; } interface EnableProgramFreemiumResponse { /** Program with the persisted Freemium setting. */ program?: Program; } interface DisableProgramFreemiumRequest { /** * ID of the program to disable Freemium for. * @format GUID */ programId: string; } interface DisableProgramFreemiumResponse { /** Program with the persisted Freemium setting. */ program?: Program; } interface BulkUpdateProgramsRequest { /** * Programs to update. Each item contains partial program data. * @minSize 1 * @maxSize 100 */ programs: MaskedProgram[]; /** Whether to return updated programs in the response. */ returnEntity?: boolean; } interface MaskedProgram { /** Partial program to update. Include `id` and the latest `revision`. */ program?: Program; /** The list of fields to update for this program. For REST requests, this list is inferred from the request body. */ fieldMask?: string[]; } interface BulkUpdateProgramsResponse { /** * Per-item update results. * @minSize 1 * @maxSize 100 */ results?: BulkUpdateProgramResult[]; /** Summary metadata for the bulk update. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkUpdateProgramResult { /** Result metadata for this item. */ itemMetadata?: ItemMetadata; /** Updated program. This is returned only when `return_entity` is true. */ item?: Program; } interface CountProgramsRequest { /** WQL filter for the programs to count. */ filter?: Record | null; } interface CountProgramsResponse { /** Number of programs matching the filter and caller visibility. */ count?: number; } interface ListSampleProgramsRequest { } interface ListSampleProgramsResponse { /** * Sample programs available as templates. * @maxSize 100 */ programs?: LabeledProgram[]; } interface LabeledProgram { /** Sample program. */ program?: Program; /** * Display label for the sample program. * @maxLength 1000 */ label?: string; } interface Empty { } interface ResolveProgramSlugRequest { /** * seo slug of online program. * @maxLength 1000 */ slug?: string; } interface ResolveProgramSlugResponse { /** @format GUID */ programId?: string; } interface MissingMetasiteIdErrorDetails { } interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; /** * A meta site id. * @format GUID */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** * TODO(meta-site): Change validation once validations are disabled for consumers * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659 * @maxSize 4000 */ assets?: Asset[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; } interface Asset { /** * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). * @maxLength 36 */ appDefId?: string; /** * An instance id. For legacy reasons may be UUID or a string. * @maxLength 200 */ instanceId?: string; /** An application state. */ state?: StateWithLiterals; } declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } /** @enumType */ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO'; interface SiteCreated { /** * A template identifier (empty if not created from a template). * @maxLength 36 */ originTemplateId?: string; /** * An account id of the owner. * @format GUID */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContextWithLiterals; /** * A meta site id from which this site was created. * * In case of a creation from a template it's a template id. * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site. * @format GUID */ originMetaSiteId?: string | null; /** * A meta site name (URL slug). * @maxLength 20 */ siteName?: string; /** A namespace. */ namespace?: NamespaceWithLiterals; } declare enum SiteCreatedContext { /** A valid option, we don't expose all reasons why site might be created. */ OTHER = "OTHER", /** A meta site was created from template. */ FROM_TEMPLATE = "FROM_TEMPLATE", /** A meta site was created by copying of the transfferred meta site. */ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER", /** A copy of existing meta site. */ DUPLICATE = "DUPLICATE", /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER", /** deprecated A meta site was created for Flash editor. */ FLASH = "FLASH" } /** @enumType */ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH'; declare enum Namespace { UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE", /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */ WIX = "WIX", /** 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. */ SHOUT_OUT = "SHOUT_OUT", /** 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. */ ALBUMS = "ALBUMS", /** 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. */ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE", /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ HOTELS = "HOTELS", /** 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. */ CLUBS = "CLUBS", /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ONBOARDING_DRAFT = "ONBOARDING_DRAFT", /** * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG). */ DEV_SITE = "DEV_SITE", /** 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. */ LOGOS = "LOGOS", /** 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. */ VIDEO_MAKER = "VIDEO_MAKER", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ PARTNER_DASHBOARD = "PARTNER_DASHBOARD", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY", /** * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain. * * Meta site with this namespace will *not* be shown in a user's site list by default. */ HTML_DRAFT = "HTML_DRAFT", /** * the user-journey for Fitness users who want to start from managing their business instead of designing their website. * Will be accessible from Site List and will not have a website app. * Once the user attaches a site, the site will become a regular wixsite. */ SITELESS_BUSINESS = "SITELESS_BUSINESS", /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */ CREATOR_ECONOMY = "CREATOR_ECONOMY", /** It is to be used in the Business First efforts. */ DASHBOARD_FIRST = "DASHBOARD_FIRST", /** Bookings business flow with no site. */ ANYWHERE = "ANYWHERE", /** Namespace for Headless Backoffice with no editor */ HEADLESS = "HEADLESS", /** * Namespace for master site that will exist in parent account that will be referenced by subaccounts * The site will be used for account level CSM feature for enterprise */ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS", /** Rise.ai Siteless account management for Gift Cards and Store Credit. */ RISE = "RISE", /** * As part of the branded app new funnel, users now can create a meta site that will be branded app first. * There's a blank site behind the scene but it's blank). * The Mobile company will be the owner of this namespace. */ BRANDED_FIRST = "BRANDED_FIRST", /** Nownia.com Siteless account management for Ai Scheduling Assistant. */ NOWNIA = "NOWNIA", /** * UGC Templates are templates that are created by users for personal use and to sale to other users. * The Partners company owns this namespace. */ UGC_TEMPLATE = "UGC_TEMPLATE", /** Codux Headless Sites */ CODUX = "CODUX", /** Bobb - AI Design Creator. */ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR", /** * Shared Blog Site is a unique single site across Enterprise account, * This site will hold all Blog posts related to the Marketing product. */ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE", /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_FORMS = "STANDALONE_FORMS", /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_EVENTS = "STANDALONE_EVENTS", /** MIMIR - Siteless account for MIMIR Ai Job runner. */ MIMIR = "MIMIR", /** Wix Twins platform. */ TWINS = "TWINS", /** Wix Nano. */ NANO = "NANO", /** Base44 headless sites. */ BASE44 = "BASE44", /** Wix Channels Sites */ CHANNELS = "CHANNELS", /** Nautilus platform. */ NAUTILUS = "NAUTILUS", /** * Symphony — a siteless site representing a project within Symphony (the evolution of Orion). * Holds project data, conversations, assets, and manages collaborators / shared team members for the project. */ SYMPHONY = "SYMPHONY", /** Nautilus platform app. */ NAUTILUS_APPS = "NAUTILUS_APPS", /** * Vibu — a siteless site representing a project built with Vibu (the AI app builder). * Holds the project's generated code, conversations, assets, and manages collaborators for the project. */ VIBU = "VIBU", /** * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit * (an Enterprise account may have several), holding that BrandKit's brand definition * (theme, typography, assets) which is rolled out to the BrandKit's connected sites. * MetaSites with this namespace will *not* be shown in a user's site list by default. */ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT", /** * Dev-center development sites (com.wixpress.devcenter.dsm). * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites. */ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE", /** * KidOS (Tuned): a siteless site representing one kid in a Tuned family, owned by the parent's account. Holds the kid's data. * MetaSites with this namespace will *not* be shown in a user's site list by default. */ KIDOS = "KIDOS" } /** @enumType */ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE' | 'KIDOS'; /** Site transferred to another user. */ interface SiteTransferred { /** * A previous owner id (user that transfers meta site). * @format GUID */ oldOwnerId?: string; /** * A new owner id (user that accepts meta site). * @format GUID */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatusWithLiterals; /** * A reason (flow). * @maxLength 255 */ deleteOrigin?: string; /** * A service that deleted it. * @maxLength 255 */ initiatorId?: string | null; } declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE", PURGED_EXTERNALLY = "PURGED_EXTERNALLY" } /** @enumType */ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY'; /** Restoration of the meta site. */ interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished { } interface SiteUnpublished { /** * A list of URLs previously associated with the meta site. * @maxLength 4000 * @maxSize 10000 */ urls?: string[]; } interface SiteMarkedAsTemplate { } interface SiteMarkedAsWixSite { } /** * Represents a service provisioned a site. * * Note on `origin_instance_id`: * There is no guarantee that you will be able to find a meta site using `origin_instance_id`. * This is because of the following scenario: * * Imagine you have a template where a third-party application (TPA) includes some stub data, * such as a product catalog. When you create a site from this template, you inherit this * default product catalog. However, if the template's product catalog is modified, * your site will retain the catalog as it was at the time of site creation. This ensures that * your site remains consistent with what you initially received and does not include any * changes made to the original template afterward. * To ensure this, the TPA on the template gets a new instance_id. */ interface ServiceProvisioned { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * An instance id from which this instance is originated. * @maxLength 36 */ originInstanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; /** * The origin meta site id * @format GUID */ originMetaSiteId?: string | null; } interface ServiceRemoved { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed { /** * A new meta site name (URL slug). * @maxLength 20 */ newSiteName?: string; /** * A previous meta site name (URL slug). * @maxLength 255 */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: NamespaceWithLiterals; /** A new namespace. */ newNamespace?: NamespaceWithLiterals; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ interface StudioUnassigned { } /** * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc. * * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up * with sites and its urls, you need to listen to another topic/event. Read about it: * * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service */ interface SiteUrlChanged { } /** * Used at the end of the deletion flow for both draft sites and when a user deletes a site. * Consumed by other teams to remove relevant data. */ interface SitePurgedExternally { /** * @maxLength 2048 * @maxSize 100 * @deprecated * @targetRemovalDate 2025-04-15 */ appDefId?: string[]; } /** Assigned Odeditor */ interface OdeditorAssigned { } /** Unassigned Odeditor */ interface OdeditorUnassigned { } /** Assigned Picasso editor */ interface PicassoAssigned { } /** Unassigned Picasso */ interface PicassoUnassigned { } /** Assigned Wixel */ interface WixelAssigned { } /** Unassigned Wixel */ interface WixelUnassigned { } /** Assigned StudioTwo */ interface StudioTwoAssigned { } /** Unassigned StudioTwo */ interface StudioTwoUnassigned { } /** Media from user domain is enabled. */ interface UserDomainMediaEnabled { } /** Media from user domain is disabled. */ interface UserDomainMediaDisabled { } /** Assigned Editorless */ interface EditorlessAssigned { } /** Unassigned Editorless */ interface EditorlessUnassigned { } interface SearchIndexingNotification { /** new state of indexing for the site specified in ms_id */ indexState?: SearchIndexingNotificationStateWithLiterals; /** type of the document the notification is targeted for. Applies to all types if not provided */ documentType?: string | null; /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */ language?: string | null; /** * site for which notification is targeted * @minLength 2 */ msId?: string | null; } declare enum SearchIndexingNotificationState { /** default state */ Unknown = "Unknown", /** metasite does not require site search indexing */ Off = "Off", /** metasite requires site search indexing */ On = "On" } /** @enumType */ type SearchIndexingNotificationStateWithLiterals = SearchIndexingNotificationState | 'Unknown' | 'Off' | 'On'; /** Encapsulates all changes when site properties are updated */ interface SitePropertiesUpdated { /** ID of the Wix site that has been updated. */ metasiteId?: string; /** Update details. */ event?: SitePropertiesEvent; } /** The actual update event for a particular notification. */ interface SitePropertiesEvent { /** Version of the site's properties represented by this update. */ version?: number; /** Set of properties that were updated - corresponds to the fields in "properties". */ fields?: string[]; /** Updated properties. */ properties?: Properties; } interface Properties { /** Site categories. */ categories?: Categories; /** Site locale. */ locale?: Locale; /** * Site language. * * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */ language?: string | null; /** * Site currency used to bill customers. * * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */ paymentCurrency?: string | null; /** Site time zone in IANA time zone database format. For example, `America/New_York`. */ timeZone?: string | null; /** Email address. */ email?: string | null; /** Phone number. */ phone?: string | null; /** Fax number. */ fax?: string | null; /** Address. */ address?: Address; /** Site display name. */ siteDisplayName?: string | null; /** Business name. */ businessName?: string | null; /** Path to the site's logo in Wix Media (without Wix Media base URL). */ logo?: string | null; /** Site description. */ description?: string | null; /** * Business schedule. Regular and exceptional time periods when the business is open or the service is available. * * __Note:__ Not supported by Wix Bookings. */ businessSchedule?: BusinessSchedule; /** Supported languages of a site and the primary language. */ multilingual?: Multilingual; /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */ consentPolicy?: ConsentPolicy; /** * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`. * * Site business type. */ businessConfig?: string | null; /** External site URL that uses Wix as its headless business solution. */ externalSiteUrl?: string | null; /** Track clicks analytics. */ trackClicksAnalytics?: boolean; /** * Company ID issued to the business by local authorities. Appears on invoices and price quotes. * @maxLength 50 */ companyId?: string | null; } interface Categories { /** Primary site category. */ primary?: string; /** * Secondary site category. * @maxSize 50 */ secondary?: string[]; /** Business Term Id */ businessTermId?: string | null; } interface Locale { /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */ languageCode?: string; /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */ country?: string; } interface Address { /** Street name. */ street?: string; /** City name. */ city?: string; /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */ country?: string; /** State. */ state?: string; /** * Zip or postal code. * @maxLength 20 */ zip?: string; /** Extra information to be displayed in the address. */ hint?: AddressHint; /** Whether this address represents a physical location. */ isPhysical?: boolean; /** Google-formatted version of this address. */ googleFormattedAddress?: string; /** Street number. */ streetNumber?: string; /** Apartment number. */ apartmentNumber?: string; /** Geographic coordinates of location. */ coordinates?: GeoCoordinates; } /** * Extra information on displayed addresses. * This is used for display purposes. Used to add additional data about the address, such as "In the passage". * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string. */ interface AddressHint { /** Extra text displayed next to, or instead of, the actual address. */ text?: string; /** Where the extra text should be displayed. */ placement?: PlacementTypeWithLiterals; } /** Where the extra text should be displayed: before, after or instead of the actual address. */ declare enum PlacementType { BEFORE = "BEFORE", AFTER = "AFTER", REPLACE = "REPLACE" } /** @enumType */ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE'; /** Geocoordinates for a particular address. */ interface GeoCoordinates { /** Latitude of the location. Must be between -90 and 90. */ latitude?: number; /** Longitude of the location. Must be between -180 and 180. */ longitude?: number; } /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */ interface BusinessSchedule { /** * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. * @maxSize 100 */ periods?: TimePeriod[]; /** * Exceptions to the business's regular hours. The business can be open or closed during the exception. * @maxSize 100 */ specialHourPeriod?: SpecialHourPeriod[]; } /** Weekly recurring time periods when the business is regularly open or the service is available. */ interface TimePeriod { /** Day of the week the period starts on. */ openDay?: DayOfWeekWithLiterals; /** * 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 * midnight at the end of the specified day. */ openTime?: string; /** Day of the week the period ends on. */ closeDay?: DayOfWeekWithLiterals; /** * 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 * midnight at the end of the specified day. * * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`. */ closeTime?: string; } /** Enumerates the days of the week. */ declare enum DayOfWeek { MONDAY = "MONDAY", TUESDAY = "TUESDAY", WEDNESDAY = "WEDNESDAY", THURSDAY = "THURSDAY", FRIDAY = "FRIDAY", SATURDAY = "SATURDAY", SUNDAY = "SUNDAY" } /** @enumType */ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'; /** Exception to the business's regular hours. The business can be open or closed during the exception. */ interface SpecialHourPeriod { /** 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). */ startDate?: string; /** 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). */ endDate?: string; /** * Whether the business is closed (or the service is not available) during the exception. * * Default: `true`. */ isClosed?: boolean; /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */ comment?: string; } interface Multilingual { /** * Supported languages list. * @maxSize 200 */ supportedLanguages?: SupportedLanguage[]; /** Whether to redirect to user language. */ autoRedirect?: boolean; } interface SupportedLanguage { /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */ languageCode?: string; /** Locale. */ locale?: Locale; /** Whether the supported language is the primary language for the site. */ isPrimary?: boolean; /** Language icon. */ countryCode?: string; /** How the language will be resolved. For internal use. */ resolutionMethod?: ResolutionMethodWithLiterals; /** Whether the supported language is the primary language for site visitors. */ isVisitorPrimary?: boolean | null; } declare enum ResolutionMethod { QUERY_PARAM = "QUERY_PARAM", SUBDOMAIN = "SUBDOMAIN", SUBDIRECTORY = "SUBDIRECTORY" } /** @enumType */ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY'; interface ConsentPolicy { /** Whether the site uses cookies that are essential to site operation. Always `true`. */ essential?: boolean | null; /** Whether the site uses cookies that affect site performance and other functional measurements. */ functional?: boolean | null; /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */ analytics?: boolean | null; /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */ advertising?: boolean | null; /** CCPA compliance flag. */ dataToThirdParty?: boolean | null; } /** @docsIgnore */ type UpdateProgramApplicationErrors = { code?: 'WRONG_STATE'; description?: string; data?: WrongStateErrorDetails; } | { code?: 'WRONG_START_DATE'; description?: string; data?: WrongStartDateErrorDetails; } | { code?: 'WRONG_PARTICIPANTS_NUMBER'; description?: string; data?: WrongParticipantsNumberErrorDetails; } | { code?: 'DUPLICATED_SLUG'; description?: string; data?: DuplicatedSlugErrorDetails; } | { code?: 'TIMELINE_SWITCH_FORBIDDEN'; description?: string; data?: TimelineSwitchForbiddenErrorDetails; }; /** @docsIgnore */ type PublishProgramApplicationErrors = { code?: 'INVALID_START_DATE'; description?: string; data?: Record; }; /** @docsIgnore */ type EnableProgramFreemiumApplicationErrors = { code?: 'FREEMIUM_PROGRAM_STATE_NOT_SUPPORTED'; description?: string; data?: Record; } | { code?: 'FREEMIUM_REQUIRES_SELF_PACED_PROGRAM'; description?: string; data?: Record; } | { code?: 'FREEMIUM_REQUIRES_PAID_ACCESS'; description?: string; data?: Record; }; interface BaseEventMetadata { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Details related to the account */ accountInfo?: AccountInfo; } interface EventMetadata extends BaseEventMetadata { /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ _id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; accountInfo?: AccountInfoMetadata; } interface AccountInfoMetadata { /** ID of the Wix account associated with the event */ accountId: string; /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */ siteId?: string; /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */ parentAccountId?: string; } interface ProgramCreatedEnvelope { entity: Program; metadata: EventMetadata; } /** * Triggered when a program is created. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_created * @slug created * @documentationMaturity preview */ declare function onProgramCreated(handler: (event: ProgramCreatedEnvelope) => void | Promise): void; interface ProgramDeletedEnvelope { metadata: EventMetadata; } /** * Triggered when a program is deleted. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_deleted * @slug deleted * @documentationMaturity preview */ declare function onProgramDeleted(handler: (event: ProgramDeletedEnvelope) => void | Promise): void; interface ProgramArchivedEnvelope { data: ProgramArchived; metadata: EventMetadata; } /** * Triggered when a program is archived. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_program_archived * @slug program_archived * @documentationMaturity preview */ declare function onProgramArchived(handler: (event: ProgramArchivedEnvelope) => void | Promise): void; interface ProgramDuplicatedEnvelope { data: ProgramDuplicated; metadata: EventMetadata; } /** * Triggered when a program is duplicated. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_program_duplicated * @slug program_duplicated * @documentationMaturity preview */ declare function onProgramDuplicated(handler: (event: ProgramDuplicatedEnvelope) => void | Promise): void; interface ProgramEndedEnvelope { data: ProgramEnded; metadata: EventMetadata; } /** * Triggered when a program ends, either automatically or manually by the owner. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_program_ended * @slug program_ended * @documentationMaturity preview */ declare function onProgramEnded(handler: (event: ProgramEndedEnvelope) => void | Promise): void; interface ProgramPublishedEnvelope { data: ProgramPublished; metadata: EventMetadata; } /** * Triggered when a program is published. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_program_published * @slug program_published * @documentationMaturity preview */ declare function onProgramPublished(handler: (event: ProgramPublishedEnvelope) => void | Promise): void; interface ProgramUpdatedEnvelope { entity: Program; metadata: EventMetadata; /** @hidden */ modifiedFields: Record; } /** * Triggered when a program is updated. * @permissionScope Manage Online Programs * @permissionScopeId SCOPE.CHALLENGES.MANAGE * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @webhook * @eventType wix.online_programs.v3.program_updated * @slug updated * @documentationMaturity preview */ declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise): void; /** * Resolves an encoded program route to a connected Builder page. * @public * @documentationMaturity preview * @permissionId online_programs:v3:program:router:get_page * @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetPage */ declare function getPage(options?: GetPageOptions): Promise>; interface GetPageOptions { /** * The site's assigned router prefix, including the leading slash. * @maxLength 512 */ routerPrefix?: string; /** * Encoded path after the prefix. Literal slashes separate route segments. * @maxLength 4096 */ routerSuffix?: string; /** * Absolute site URL, including the site base path and requested route. * @format WEB_URL */ fullUrl?: string; /** * Maps router roles to site-specific installed pages. * @maxSize 20 */ pageRoles?: Record; /** Platform router configuration; it does not grant access to programs. */ config?: Record | null; /** Rendering information; it is not an authorization claim. */ requestInfo?: Record | null; /** Page variations supplied by the Viewer; they do not override program identity. */ roleVariations?: Record | null; /** * Editor page override supplied by the Viewer, subject to connected-role checks. * @maxLength 255 */ dynamicPageIdOverride?: string; } /** * Lists connected Builder routes for editor navigation, not crawler indexing. * @public * @documentationMaturity preview * @permissionId online_programs:v3:program:router:get_sitemap * @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetSitemap */ declare function getSitemap(options?: GetSitemapOptions): Promise; interface GetSitemapOptions { /** * The site's assigned router prefix, including the leading slash. * @maxLength 512 */ routerPrefix?: string; /** * Encoded path after the prefix. Literal slashes separate route segments. * @maxLength 4096 */ routerSuffix?: string; /** * Absolute site URL, including the site base path and requested route. * @format WEB_URL */ fullUrl?: string; /** * Maps router roles to site-specific installed pages. * @maxSize 20 */ pageRoles?: Record; /** Platform router configuration; it does not grant access to programs. */ config?: Record | null; /** Rendering information; it is not an authorization claim. */ requestInfo?: Record | null; /** Page variations supplied by the Viewer; they do not override program identity. */ roleVariations?: Record | null; /** * Editor page override supplied by the Viewer, subject to connected-role checks. * @maxLength 255 */ dynamicPageIdOverride?: string; } /** * Counts editor navigation entries using the same visibility policy as sitemap. * NOT-PRECEDENT: `/sitemapCount` is required by the App Router contract: * https://github.com/wix-private/editor-platform/blob/master/packages/platform-editor-sdk/docs/articles/routers.md#sitemap-count-request * @public * @documentationMaturity preview * @permissionId online_programs:v3:program:router:get_sitemap_count * @fqn wix.onlineprograms.programs.v3.ProgramsRouterService.GetSitemapCount */ declare function getSitemapCount(options?: GetSitemapCountOptions): Promise; interface GetSitemapCountOptions { /** * The site's assigned router prefix, including the leading slash. * @maxLength 512 */ routerPrefix?: string; /** * Encoded path after the prefix. Literal slashes separate route segments. * @maxLength 4096 */ routerSuffix?: string; /** * Absolute site URL, including the site base path and requested route. * @format WEB_URL */ fullUrl?: string; /** * Maps router roles to site-specific installed pages. * @maxSize 20 */ pageRoles?: Record; /** Platform router configuration; it does not grant access to programs. */ config?: Record | null; /** Rendering information; it is not an authorization claim. */ requestInfo?: Record | null; /** Page variations supplied by the Viewer; they do not override program identity. */ roleVariations?: Record | null; /** * Editor page override supplied by the Viewer, subject to connected-role checks. * @maxLength 255 */ dynamicPageIdOverride?: string; } /** * Creates a draft program. * * The service sets the program ID, revision, creation dates, owner, and initial * `DRAFT` status. Publish the program when it's ready to be visible * according to its access restrictions. * @param program - Program to create. Server-generated fields such as `id`, `revision`, status, dates, owner, and content summary are ignored on create. * @public * @requiredField program * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE * @applicableIdentity APP * @returns Created draft program. * @fqn wix.onlineprograms.programs.v3.ProgramsService.CreateProgram */ declare function createProgram(program: Program): Promise>; /** * Duplicates a program as a new draft. * * The duplicated program gets a new ID and owner, starts in `DRAFT` status, * keeps category assignments and translation content, resets the SEO slug to * the duplicated program ID, clears the connected social group, and doesn't * copy section or step references. * @param programId - ID of the program to duplicate. * @public * @requiredField programId * @permissionId ONLINE_PROGRAMS.PROGRAM_CREATE * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.DuplicateProgram */ declare function duplicateProgram(programId: string): Promise>; /** * Retrieves a program by ID. * * Visibility depends on caller identity and program access settings. Public * callers can retrieve published and ended non-secret programs. Site members * can retrieve secret programs only when they participate in them. Trusted apps * and services can retrieve management views. * @param programId - ID of the program to retrieve. * @public * @requiredField programId * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @applicableIdentity APP * @returns Requested program. * @fqn wix.onlineprograms.programs.v3.ProgramsService.GetProgram */ declare function getProgram(programId: string): Promise>; /** * Updates selected fields of a program. * * Each time the program is updated, `revision` increments by 1. The current * `revision` must be passed when updating the program. This ensures you're * working with the latest program and prevents unintended overwrites. * * Ended and archived programs can't be updated. Timeline changes are blocked * when the program has active participants. * @param _id - Program ID. * @public * @requiredField _id * @requiredField program * @requiredField program.revision * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE * @applicableIdentity APP * @returns Updated program. * @fqn wix.onlineprograms.programs.v3.ProgramsService.UpdateProgram */ declare function updateProgram(_id: string, program: NonNullablePaths): Promise & { __applicationErrorsType?: UpdateProgramApplicationErrors; }>; interface UpdateProgram { /** * Program ID. * @format GUID * @readonly */ _id?: string | null; /** * Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating a program. * @readonly */ revision?: string | null; /** * Date and time the program was created. * @readonly */ _createdDate?: Date | null; /** * Date and time the program was last updated. * @readonly */ _updatedDate?: Date | null; /** * Current program lifecycle status. * @readonly */ status?: StatusWithLiterals; /** * Date and time when `status` last changed. * @readonly */ statusUpdatedDate?: Date | null; /** * Category IDs assigned to the program. This field is read-only; use the Program Categories API to assign categories. * @readonly * @format GUID * @maxSize 10 */ categoryIds?: string[]; /** Public-facing program title, details, and media. */ description?: Description; /** Program timeline settings. Use this to configure self-paced or scheduled programs. */ timeline?: Timeline; /** Program access, participation, and progression rules. */ restrictions?: Restrictions; /** * Optional one-time payment price for joining the program. When creating or updating a program, * provide `price.value` only. `price.currency` is read-only and is populated from the site's * payment currency in Site Properties. */ price?: Money; /** SEO settings used for the program page. */ seo?: Seo; /** * Rewards assigned to participants when they reach configured milestones. * @maxSize 10 */ rewards?: Reward[]; /** * ID of the social group connected to the program, if one exists. * @format GUID */ socialGroupId?: string | null; /** Custom fields for apps that extend the Program entity. */ extendedFields?: ExtendedFields; /** Whether to send an invoice after a single-payment purchase. When false, the buyer receives a payment confirmation email instead. */ shouldSendInvoice?: boolean; /** Settings that control how video steps behave in this program. */ videoStepsSettings?: VideoStepsSettings; /** * Read-only counts of content entities in the program. * @readonly */ contentSummary?: ContentSummary; /** * ID of the site user who created the program. * @format GUID * @readonly */ ownerUserId?: string | null; /** * Freemium enablement. Absent settings mean Freemium is disabled. * This field cannot be set through generic create or update operations. * @internal * @readonly */ freemiumSettings?: FreemiumSettings; } /** * Deletes a program. * * Deleting a program permanently removes it from the program list, cancels its * scheduled end task, removes related member groups, and removes it from search. * @param programId - ID of the program to delete. * @public * @requiredField programId * @permissionId ONLINE_PROGRAMS.PROGRAM_DELETE * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.DeleteProgram */ declare function deleteProgram(programId: string): Promise; /** * Retrieves a list of up to 50 programs, given the provided paging, filtering, and sorting. * * Query Programs runs with these defaults, which you can override: * * - `createdDate` is sorted in `DESC` order. * - `paging.limit` is `50`. * - `paging.offset` is `0`. * * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language), [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging), and [Field Projection](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-field-projection). * * Results are visibility-filtered according to the caller identity. * @public * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms */ declare function queryPrograms(): ProgramsQueryBuilder; interface QueryCursorResult { cursors: Cursors; hasNext: () => boolean; hasPrev: () => boolean; length: number; pageSize: number; } interface ProgramsQueryResult extends QueryCursorResult { items: Program[]; query: ProgramsQueryBuilder; next: () => Promise; prev: () => Promise; } interface ProgramsQueryBuilder { /** @param propertyName - Property whose value is compared with `value`. * @param value - Value to compare against. */ eq: (propertyName: '_id' | 'status' | 'timeline.selfPaced' | 'seo.slug' | 'socialGroupId', value: any) => ProgramsQueryBuilder; /** @param propertyName - Property whose value is compared with `values`. * @param values - List of values to compare against. */ hasSome: (propertyName: string, value: any[]) => ProgramsQueryBuilder; /** @param propertyName - Property whose value is compared with `values`. * @param values - List of values to compare against. */ hasAll: (propertyName: string, value: any[]) => ProgramsQueryBuilder; in: (propertyName: '_id' | 'status' | 'restrictions.accessType' | 'socialGroupId', value: any) => ProgramsQueryBuilder; exists: (propertyName: 'price', value: boolean) => ProgramsQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */ ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'status' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder; /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */ descending: (...propertyNames: Array<'_id' | '_createdDate' | 'status' | 'statusUpdatedDate' | 'description.title' | 'seo.slug'>) => ProgramsQueryBuilder; /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */ limit: (limit: number) => ProgramsQueryBuilder; /** @param cursor - A pointer to specific record */ skipTo: (cursor: string) => ProgramsQueryBuilder; find: () => Promise; } /** * @hidden * @fqn wix.onlineprograms.programs.v3.ProgramsService.QueryPrograms * @requiredField query */ declare function typedQueryPrograms(query: ProgramQuery): Promise>; interface ProgramQuerySpec extends QuerySpec { paging: 'cursor'; wql: [ { fields: ['_id']; operators: ['$eq', '$in']; sort: 'BOTH'; }, { fields: ['status']; operators: ['$eq', '$in']; sort: 'BOTH'; }, { fields: ['categoryIds']; operators: ['$hasAll', '$hasSome', '$isEmpty']; sort: 'NONE'; }, { fields: ['seo.slug']; operators: ['$eq']; sort: 'BOTH'; }, { fields: ['_createdDate']; operators: []; sort: 'BOTH'; }, { fields: ['statusUpdatedDate']; operators: []; sort: 'BOTH'; }, { fields: ['socialGroupId']; operators: ['$eq', '$in']; sort: 'NONE'; }, { fields: ['timeline.selfPaced']; operators: ['$eq']; sort: 'NONE'; }, { fields: ['price']; operators: ['$exists']; sort: 'NONE'; }, { fields: ['restrictions.accessType']; operators: ['$in']; sort: 'NONE'; }, { fields: ['description.title']; operators: []; sort: 'BOTH'; } ]; } type CommonQueryWithEntityContext = Query; type ProgramQuery = { /** 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`. */ cursorPaging?: { /** Maximum number of items to return in the results. @max: 100 */ limit?: NonNullable['limit'] | null; /** Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. @maxLength: 16000 */ cursor?: NonNullable['cursor'] | null; }; /** Filter object. Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language). */ filter?: CommonQueryWithEntityContext['filter'] | null; /** Sort object. Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). @maxSize: 100 */ sort?: { /** Name of the field to sort by. @maxLength: 512 */ fieldName?: NonNullable[number]['fieldName']; /** Sort order. */ order?: NonNullable[number]['order']; /** When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. If multiple filters are provided, they are combined with AND operator. Example: Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } @internal: undefined, @maxSize: 10 */ selectItemsBy?: NonNullable[number]['selectItemsBy'] | null; }[]; }; declare const utils: { query: _wix_sdk_types.QueryHelpers; search: _wix_sdk_types.SearchHelpers; }; interface ProgramSearchSpec extends SearchSpec { searchable: ['description.title']; aggregatable: [ '_id', 'categoryIds', 'description.title', 'restrictions.accessType', 'status', 'timeline.selfPaced' ]; paging: 'cursor'; wql: [ { operators: '*'; fields: ['_id', 'description.title']; sort: 'BOTH'; }, { operators: ['$eq', '$in']; fields: ['status']; sort: 'BOTH'; }, { operators: []; fields: ['_createdDate']; sort: 'BOTH'; }, { operators: ['$eq']; fields: ['timeline.selfPaced']; sort: 'NONE'; }, { operators: ['$in']; fields: ['restrictions.accessType']; sort: 'NONE'; }, { operators: []; fields: ['_updatedDate']; sort: 'BOTH'; }, { operators: ['$hasAll', '$hasSome']; fields: ['categoryIds']; sort: 'NONE'; } ]; } type CommonSearchWithEntityContext = Search; type ProgramSearch = { /** Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). */ cursorPaging?: { /** Maximum number of items to return in the results. @max: 100 */ limit?: NonNullable['limit'] | null; /** Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. @maxLength: 16000 */ cursor?: NonNullable['cursor'] | null; }; /** Filter object. Learn more about [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language). */ filter?: CommonSearchWithEntityContext['filter'] | null; /** List of sort objects. Learn more about [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging). @maxSize: 10 */ sort?: { /** Name of the field to sort by. @maxLength: 512 */ fieldName?: NonNullable[number]['fieldName']; /** Sort order. */ order?: NonNullable[number]['order']; /** When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. If multiple filters are provided, they are combined with AND operator. Example: Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } @internal: undefined, @maxSize: 10 */ selectItemsBy?: NonNullable[number]['selectItemsBy'] | null; }[]; /** 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. @maxSize: 10 */ aggregations?: { /** Value aggregation. */ value?: NonNullable[number]['value']; /** Range aggregation. */ range?: NonNullable[number]['range']; /** Scalar aggregation. */ scalar?: NonNullable[number]['scalar']; /** Date histogram aggregation. */ dateHistogram?: NonNullable[number]['dateHistogram']; /** Nested aggregation. */ nested?: NonNullable[number]['nested']; /** User-defined name of aggregation, should be unique, will appear in aggregation results. @maxLength: 100 */ name?: NonNullable[number]['name'] | null; /** Type of aggregation, client must provide matching aggregation field below. */ type?: NonNullable[number]['type']; /** Field to aggregate by, use dot notation to specify json path. @maxLength: 200 */ fieldPath?: NonNullable[number]['fieldPath']; /** Deprecated. Use `nested` instead. @deprecated: Deprecated. Use `nested` instead., @replacedBy: kind.nested, @targetRemovalDate: 2024-03-30 */ groupBy?: NonNullable[number]['groupBy']; }[]; /** Free text to match in searchable fields. */ search?: { /** Defines how separate search terms in `expression` are combined. */ mode?: NonNullable['mode']; /** Search term or expression. @maxLength: 100 */ expression?: NonNullable['expression'] | null; /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. @maxLength: 200, @maxSize: 20 */ fields?: NonNullable['fields']; /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */ fuzzy?: NonNullable['fuzzy']; }; /** UTC offset or IANA time zone. Valid values are ISO 8601 UTC offsets, such as +02:00 or -06:00, and IANA time zone IDs, such as Europe/Rome. Affects all filters and aggregations returned values. You may override this behavior in a specific filter by providing timestamps including time zone. For example, `"2023-12-20T10:52:34.795Z"`. @maxLength: 50 */ timeZone?: CommonSearchWithEntityContext['timeZone'] | null; }; /** * Publishes a draft program. * * A scheduled program can't be published when its start date is in the past. * If the program has an end date, the service schedules an automatic transition * to `ENDED` using the site's timezone. * @param programId - ID of the draft program to publish. * @public * @requiredField programId * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.PublishProgram */ declare function publishProgram(programId: string): Promise & { __applicationErrorsType?: PublishProgramApplicationErrors; }>; /** * Ends a published program. * * Ending a program changes its status to `ENDED` and cancels any scheduled end * task. The operation succeeds only for currently published programs. * @param programId - ID of the published program to end. * @public * @requiredField programId * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.EndProgram */ declare function endProgram(programId: string): Promise>; /** * Archives a program. * * Archiving closes the program, removes it from normal public discovery, and * replaces its SEO slug with the program ID so the previous slug can be reused. * @param programId - ID of the program to archive. * @public * @requiredField programId * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.ArchiveProgram */ declare function archiveProgram(programId: string): Promise>; /** * Enables Freemium for a self-paced draft or published program that requires * payment according to Join Applications: a one-time price or an available * pricing plan. Pricing-plan availability uses the member-facing benefit lookup. * * Success confirms the persisted setting, not divider readiness. Repeated * requests for an eligible enabled program leave its revision unchanged. * @param programId - ID of the program to enable Freemium for. * @internal * @documentationMaturity preview * @requiredField programId * @permissionId online_programs:v3:program:enable_program_freemium * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.EnableProgramFreemium */ declare function enableProgramFreemium(programId: string): Promise & { __applicationErrorsType?: EnableProgramFreemiumApplicationErrors; }>; /** * Disables Freemium without checking pricing eligibility or waiting for divider * cleanup. Preview members are retained. Repeated requests for a disabled * program leave its settings and revision unchanged. * @param programId - ID of the program to disable Freemium for. * @internal * @documentationMaturity preview * @requiredField programId * @permissionId online_programs:v3:program:disable_program_freemium * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.DisableProgramFreemium */ declare function disableProgramFreemium(programId: string): Promise>; /** * Updates multiple programs in a single synchronous request. * * Each item includes its own program data and revision. Set `returnEntity` to * return updated programs in the response. * @param programs - Programs to update. Each item contains partial program data. * @public * @requiredField programs * @requiredField programs.program.revision * @permissionId ONLINE_PROGRAMS.PROGRAM_UPDATE * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.BulkUpdatePrograms */ declare function bulkUpdatePrograms(programs: NonNullablePaths[], options?: BulkUpdateProgramsOptions): Promise>; interface BulkUpdateProgramsOptions { /** Whether to return updated programs in the response. */ returnEntity?: boolean; } /** * Counts programs that match a filter. * * Results use the same visibility rules as `QueryPrograms`. * @public * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.CountPrograms */ declare function countPrograms(options?: CountProgramsOptions): Promise>; interface CountProgramsOptions { /** WQL filter for the programs to count. */ filter?: Record | null; } /** * Lists sample programs used as templates for creating new programs. * @public * @permissionId ONLINE_PROGRAMS.PROGRAM_READ * @applicableIdentity APP * @fqn wix.onlineprograms.programs.v3.ProgramsService.ListSamplePrograms */ declare function listSamplePrograms(): Promise>; export { DeleteStatus as $, type ArchiveProgramResponse as A, type BulkUpdateProgramsOptions as B, type CountProgramsOptions as C, type DuplicateProgramResponse as D, type EndProgramResponse as E, Enum as F, type GetPageOptions as G, BulkActionType as H, SortOrder as I, SortType as J, SortDirection as K, type ListSampleProgramsResponse as L, type MaskedProgram as M, MissingValues as N, ScalarType as O, type Program as P, NestedAggregationType as Q, Interval as R, type SearchProgramsResponse as S, Trigger as T, type UpdateProgram as U, AggregationType as V, WebhookIdentityType as W, Mode as X, State as Y, SiteCreatedContext as Z, Namespace as _, type GetPageResponse as a, type Pages as a$, SearchIndexingNotificationState as a0, PlacementType as a1, DayOfWeek as a2, ResolutionMethod as a3, type Description as a4, type DescriptionMediaOneOf as a5, type FocalPoint as a6, type VideoResolution as a7, type Timeline as a8, type Restrictions as a9, type DomainEventBodyOneOf as aA, type EntityCreatedEvent as aB, type RestoreInfo as aC, type EntityUpdatedEvent as aD, type EntityDeletedEvent as aE, type ActionEvent as aF, type MessageEnvelope as aG, type IdentificationData as aH, type IdentificationDataIdOneOf as aI, type AccountInfo as aJ, type UpdateDocumentsEvent as aK, type UpdateDocumentsEventOperationOneOf as aL, type DocumentUpdateOperation as aM, type IndexDocument as aN, type DocumentPayload as aO, type DocumentImage as aP, type DeleteByIdsOperation as aQ, type DeleteByFilterOperation as aR, type UpdateByFilterOperation as aS, type UpdateExistingOperation as aT, type InvalidateCache as aU, type InvalidateCacheGetByOneOf as aV, type App as aW, type Page as aX, type URI as aY, type File as aZ, type CustomTag as a_, type Money as aa, type Seo as ab, type SeoSchema as ac, type Keyword as ad, type Tag as ae, type Settings as af, type Reward as ag, type Certificate as ah, type ExtendedFields as ai, type VideoStepsSettings as aj, type ContentSummary as ak, type FreemiumSettings as al, type ProgramPublished as am, type ProgramEnded as an, type ProgramArchived as ao, type ProgramDuplicated as ap, type ProgramFreemiumEnabled as aq, type ProgramFreemiumDisabled as ar, type GetPageRequest as as, type ProgramRouterPageRole as at, type ProgramRouterPageResult as au, type ProgramRouterData as av, type ProgramRouterDataSelectionOneOf as aw, type GetSitemapRequest as ax, type GetSitemapCountRequest as ay, type DomainEvent as az, type GetSitemapOptions as b, type NestedAggregationResultsResultOneOf as b$, type URIs as b0, type ReindexMessage as b1, type ReindexMessageActionOneOf as b2, type Upsert as b3, type Delete as b4, type Schema as b5, type CreateProgramRequest as b6, type CreateProgramResponse as b7, type BulkCreateProgramsMigrationRequest as b8, type ProgramMigration as b9, type CursorPaging as bA, type QueryProgramsResponse as bB, type PagingMetadataV2 as bC, type Cursors as bD, type SearchProgramsRequest as bE, type CursorSearch as bF, type CursorSearchPagingMethodOneOf as bG, type Aggregation as bH, type AggregationKindOneOf as bI, type RangeBucket as bJ, type IncludeMissingValuesOptions as bK, type ValueAggregation as bL, type ValueAggregationOptionsOneOf as bM, type RangeAggregation as bN, type ScalarAggregation as bO, type DateHistogramAggregation as bP, type NestedAggregationItem as bQ, type NestedAggregationItemKindOneOf as bR, type NestedAggregation as bS, type GroupByAggregation as bT, type GroupByAggregationKindOneOf as bU, type SearchDetails as bV, type CursorPagingMetadata as bW, type AggregationData as bX, type ValueAggregationResult as bY, type RangeAggregationResult as bZ, type NestedAggregationResults as b_, type BulkCreateProgramsMigrationResponse as ba, type BulkProgramResult as bb, type ItemMetadata as bc, type ApplicationError as bd, type BulkActionMetadata as be, type DeleteAllProgramsMigrationRequest as bf, type DeleteAllProgramsMigrationResponse as bg, type RestoreProgramFromTrashRequest as bh, type RestoreProgramFromTrashResponse as bi, type DuplicateProgramRequest as bj, type GetProgramRequest as bk, type GetProgramResponse as bl, type UpdateProgramRequest as bm, type UpdateProgramResponse as bn, type WrongStateErrorDetails as bo, type WrongStartDateErrorDetails as bp, type WrongParticipantsNumberErrorDetails as bq, type DuplicatedSlugErrorDetails as br, type TimelineSwitchForbiddenErrorDetails as bs, type DeleteProgramRequest as bt, type DeleteProgramResponse as bu, type QueryProgramsRequest as bv, type QueryV2 as bw, type QueryV2PagingMethodOneOf as bx, type Sorting as by, type Paging as bz, type GetSitemapResponse as c, type SearchIndexingNotification as c$, type ValueResults as c0, type RangeResults as c1, type AggregationResultsScalarResult as c2, type NestedValueAggregationResult as c3, type ValueResult as c4, type RangeResult as c5, type ScalarResult as c6, type NestedResultValue as c7, type NestedResultValueResultOneOf as c8, type Results as c9, type DeleteContext as cA, type SiteUndeleted as cB, type SitePublished as cC, type SiteUnpublished as cD, type SiteMarkedAsTemplate as cE, type SiteMarkedAsWixSite as cF, type ServiceProvisioned as cG, type ServiceRemoved as cH, type SiteRenamed as cI, type SiteHardDeleted as cJ, type NamespaceChanged as cK, type StudioAssigned as cL, type StudioUnassigned as cM, type SiteUrlChanged as cN, type SitePurgedExternally as cO, type OdeditorAssigned as cP, type OdeditorUnassigned as cQ, type PicassoAssigned as cR, type PicassoUnassigned as cS, type WixelAssigned as cT, type WixelUnassigned as cU, type StudioTwoAssigned as cV, type StudioTwoUnassigned as cW, type UserDomainMediaEnabled as cX, type UserDomainMediaDisabled as cY, type EditorlessAssigned as cZ, type EditorlessUnassigned as c_, type DateHistogramResult as ca, type GroupByValueResults as cb, type DateHistogramResults as cc, type NestedResults as cd, type AggregationResults as ce, type AggregationResultsResultOneOf as cf, type PublishProgramRequest as cg, type EndProgramRequest as ch, type ArchiveProgramRequest as ci, type EnableProgramFreemiumRequest as cj, type DisableProgramFreemiumRequest as ck, type BulkUpdateProgramsRequest as cl, type BulkUpdateProgramResult as cm, type CountProgramsRequest as cn, type ListSampleProgramsRequest as co, type LabeledProgram as cp, type Empty as cq, type ResolveProgramSlugRequest as cr, type ResolveProgramSlugResponse as cs, type MissingMetasiteIdErrorDetails as ct, type MetaSiteSpecialEvent as cu, type MetaSiteSpecialEventPayloadOneOf as cv, type Asset as cw, type SiteCreated as cx, type SiteTransferred as cy, type SiteDeleted as cz, type GetSitemapCountOptions as d, publishProgram as d$, type SitePropertiesUpdated as d0, type SitePropertiesEvent as d1, type Properties as d2, type Categories as d3, type Locale as d4, type Address as d5, type AddressHint as d6, type GeoCoordinates as d7, type BusinessSchedule as d8, type TimePeriod as d9, type ModeWithLiterals as dA, type StateWithLiterals as dB, type SiteCreatedContextWithLiterals as dC, type NamespaceWithLiterals as dD, type DeleteStatusWithLiterals as dE, type SearchIndexingNotificationStateWithLiterals as dF, type PlacementTypeWithLiterals as dG, type DayOfWeekWithLiterals as dH, type ResolutionMethodWithLiterals as dI, type CommonQueryWithEntityContext as dJ, type CommonSearchWithEntityContext as dK, onProgramCreated as dL, onProgramDeleted as dM, onProgramArchived as dN, onProgramDuplicated as dO, onProgramEnded as dP, onProgramPublished as dQ, onProgramUpdated as dR, getPage as dS, getSitemap as dT, getSitemapCount as dU, createProgram as dV, duplicateProgram as dW, getProgram as dX, updateProgram as dY, deleteProgram as dZ, queryPrograms as d_, type SpecialHourPeriod as da, type Multilingual as db, type SupportedLanguage as dc, type ConsentPolicy as dd, type BaseEventMetadata as de, type EventMetadata as df, type AccountInfoMetadata as dg, type ProgramsQueryResult as dh, type ProgramQuerySpec as di, type ProgramSearchSpec as dj, utils as dk, type StatusWithLiterals as dl, type AccessTypeWithLiterals as dm, type TriggerWithLiterals as dn, type WebhookIdentityTypeWithLiterals as dp, type EnumWithLiterals as dq, type BulkActionTypeWithLiterals as dr, type SortOrderWithLiterals as ds, type SortTypeWithLiterals as dt, type SortDirectionWithLiterals as du, type MissingValuesWithLiterals as dv, type ScalarTypeWithLiterals as dw, type NestedAggregationTypeWithLiterals as dx, type IntervalWithLiterals as dy, type AggregationTypeWithLiterals as dz, type GetSitemapCountResponse as e, endProgram as e0, archiveProgram as e1, enableProgramFreemium as e2, disableProgramFreemium as e3, bulkUpdatePrograms as e4, countPrograms as e5, listSamplePrograms as e6, type UpdateProgramApplicationErrors as f, type ProgramSearch as g, type PublishProgramResponse as h, type PublishProgramApplicationErrors as i, type EnableProgramFreemiumResponse as j, type EnableProgramFreemiumApplicationErrors as k, type DisableProgramFreemiumResponse as l, type BulkUpdateProgramsResponse as m, type CountProgramsResponse as n, type ProgramCreatedEnvelope as o, type ProgramDeletedEnvelope as p, type ProgramArchivedEnvelope as q, type ProgramDuplicatedEnvelope as r, type ProgramEndedEnvelope as s, type ProgramPublishedEnvelope as t, type ProgramUpdatedEnvelope as u, type ProgramsQueryBuilder as v, type ProgramQuery as w, typedQueryPrograms as x, Status as y, AccessType as z };