@wix/auto_sdk_quick-pages_pages 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,806 @@
+/** QuickPage Page */
+interface Page extends PageOriginOneOf {
+    /**
+     * The ID of a page from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    originPageId?: string;
+    /**
+     * The ID of a template from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string;
+    /**
+     * Page ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number. Incremented on every update.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Page was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Page was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Date and time the Page was published or scheduled to be published depending on the status.
+     * @readonly
+     */
+    publishedDate?: Date | null;
+    /**
+     * Date and time the Page was unpublished or scheduled to be unpublished depending on the status.
+     * @readonly
+     */
+    unpublishedDate?: Date | null;
+    /**
+     * Page display name.
+     * @minLength 5
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * The status of the Page.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /** An image specifically designated for display when the page URL is shared on social media platforms. */
+    socialPreviewImage?: string;
+    /** The small icon displayed in the browser tab, bookmarks, and potentially other areas. */
+    favicon?: string;
+    /**
+     * The title of the page, visible in the browser tab and used as the primary clickable link in search engine results.
+     * @maxLength 100
+     */
+    title?: string | null;
+    /**
+     * A brief summary of the page's content, often displayed below the title in search engine results.
+     * @maxLength 300
+     */
+    description?: string | null;
+    /** A flag to indicate whether search engines should be allowed to index this page and include it in their search results. */
+    searchEngineIndexingEnabled?: boolean;
+    /**
+     * The route information for the page.
+     * @readonly
+     */
+    pageRoute?: PageRoute;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+/** @oneof */
+interface PageOriginOneOf {
+    /**
+     * The ID of a page from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    originPageId?: string;
+    /**
+     * The ID of a template from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string;
+}
+declare enum Status {
+    /** Unknown status. */
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** The Page is draft. */
+    DRAFT = "DRAFT",
+    /** The Page is published. */
+    PUBLISHED = "PUBLISHED",
+    /** The Page is scheduled to be published. */
+    SCHEDULED = "SCHEDULED",
+    /** The Page is archived. */
+    ARCHIVED = "ARCHIVED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DRAFT' | 'PUBLISHED' | 'SCHEDULED' | 'ARCHIVED';
+interface PageRoute {
+    /**
+     * Page slug used in the URL.
+     * @minLength 3
+     * @maxLength 100
+     */
+    slug?: string;
+    /** The URL type for the page, determining how it's accessed (subdomain or path). */
+    urlType?: TypeWithLiterals;
+}
+declare enum Type {
+    /** Unknown URL type. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** The page is accessed via a subdomain. */
+    SUBDOMAIN = "SUBDOMAIN",
+    /** The page is accessed via a path. */
+    PATH = "PATH"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'SUBDOMAIN' | 'PATH';
+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<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+/** Page Published. */
+interface PagePublished {
+    /** Page. */
+    page?: Page;
+}
+/** Page Unpublished. */
+interface PageUnpublished {
+    /** Page. */
+    page?: Page;
+}
+/** Page Archived. */
+interface PageArchived {
+    /** Page. */
+    page?: Page;
+}
+/** Page Archived. */
+interface PageUnarchived {
+    /** Page. */
+    page?: Page;
+}
+/** Page Scheduled. */
+interface PageScheduled {
+    /** Page. */
+    page?: Page;
+}
+interface CreatePageRequest {
+    /** Page to be created. */
+    page: Page;
+}
+interface CreatePageResponse {
+    /** The created Page. */
+    page?: Page;
+}
+interface GetPageRequest {
+    /**
+     * ID of the Page to retrieve.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface GetPageResponse {
+    /** The requested Page. */
+    page?: Page;
+}
+interface UpdatePageRequest {
+    /** Page to be updated, may be partial. */
+    page: Page;
+}
+interface UpdatePageResponse {
+    /** Updated Page. */
+    page?: Page;
+}
+interface SetPageRouteRequest {
+    /**
+     * ID of the Page.
+     * @format GUID
+     */
+    pageId: string;
+    /** Route to add. */
+    pageRoute: PageRoute;
+}
+interface SetPageRouteResponse {
+}
+interface RemovePageRouteRequest {
+    /**
+     * ID of the Page.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface RemovePageRouteResponse {
+}
+interface PublishPageRequest {
+    /**
+     * ID of the Page to publish.
+     * @format GUID
+     */
+    pageId: string;
+    /** Date and time when the page should be unpublished. */
+    unpublishedDate?: Date | null;
+}
+interface PublishPageResponse {
+    /** Published Page. */
+    page?: Page;
+}
+interface UnpublishPageRequest {
+    /**
+     * ID of the Page to unpublish.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface UnpublishPageResponse {
+    /** Unpublished Page. */
+    page?: Page;
+}
+interface ArchivePageRequest {
+    /**
+     * ID of the Page to archive.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface ArchivePageResponse {
+    /** Archived Page. */
+    page?: Page;
+}
+interface UnarchivePageRequest {
+    /**
+     * ID of the Page to archive.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface UnarchivePageResponse {
+    /** Archived Page. */
+    page?: Page;
+}
+interface SchedulePageRequest {
+    /**
+     * ID of the Page to schedule.
+     * @format GUID
+     */
+    pageId: string;
+    /** Date and time when the page should be published. */
+    publishedDate?: Date | null;
+    /** Date and time when the page should be unpublished. */
+    unpublishedDate?: Date | null;
+}
+interface SchedulePageResponse {
+    /** Scheduled Page. */
+    page?: Page;
+}
+interface DeletePageRequest {
+    /**
+     * Id of the Page to delete.
+     * @format GUID
+     */
+    pageId: string;
+}
+interface DeletePageResponse {
+}
+interface QueryPagesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** 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 in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** 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;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+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 QueryPagesResponse {
+    /** List of Pages. */
+    pages?: Page[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    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;
+}
+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 BulkUpdatePageTagsRequest {
+    /**
+     * List of NileProtoTagsEntities that their tags will update.
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    pageIds: string[];
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePageTagsResponse {
+    /**
+     * Results
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdatePageTagsResult[];
+    /** Metadata regarding the bulk update operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    _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<string, any> | null;
+}
+interface BulkUpdatePageTagsResult {
+    /** Metadata regarding the specific single update operation */
+    itemMetadata?: ItemMetadata;
+}
+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 BulkUpdatePageTagsByFilterRequest {
+    /** Filter */
+    filter: Record<string, any> | null;
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePageTagsByFilterResponse {
+    /**
+     * Job ID
+     * @format GUID
+     */
+    jobId?: string;
+}
+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;
+}
+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';
+type BulkUpdatePageTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+type BulkUpdatePageTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface UpdatePage {
+    /**
+     * The ID of a page from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    originPageId?: string;
+    /**
+     * The ID of a template from which the page was created.
+     * @format GUID
+     * @immutable
+     */
+    templateId?: string;
+    /**
+     * Page ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Revision number. Incremented on every update.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the Page was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the Page was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Date and time the Page was published or scheduled to be published depending on the status.
+     * @readonly
+     */
+    publishedDate?: Date | null;
+    /**
+     * Date and time the Page was unpublished or scheduled to be unpublished depending on the status.
+     * @readonly
+     */
+    unpublishedDate?: Date | null;
+    /**
+     * Page display name.
+     * @minLength 5
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * The status of the Page.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /** An image specifically designated for display when the page URL is shared on social media platforms. */
+    socialPreviewImage?: string;
+    /** The small icon displayed in the browser tab, bookmarks, and potentially other areas. */
+    favicon?: string;
+    /**
+     * The title of the page, visible in the browser tab and used as the primary clickable link in search engine results.
+     * @maxLength 100
+     */
+    title?: string | null;
+    /**
+     * A brief summary of the page's content, often displayed below the title in search engine results.
+     * @maxLength 300
+     */
+    description?: string | null;
+    /** A flag to indicate whether search engines should be allowed to index this page and include it in their search results. */
+    searchEngineIndexingEnabled?: boolean;
+    /**
+     * The route information for the page.
+     * @readonly
+     */
+    pageRoute?: PageRoute;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+    /** Tags */
+    tags?: Tags;
+}
+interface PublishPageOptions {
+    /** Date and time when the page should be unpublished. */
+    unpublishedDate?: Date | null;
+}
+interface SchedulePageOptions {
+    /** Date and time when the page should be published. */
+    publishedDate?: Date | null;
+    /** Date and time when the page should be unpublished. */
+    unpublishedDate?: Date | null;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PagesQueryResult extends QueryCursorResult {
+    items: Page[];
+    query: PagesQueryBuilder;
+    next: () => Promise<PagesQueryResult>;
+    prev: () => Promise<PagesQueryResult>;
+}
+interface PagesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'status', value: any) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | 'status', value: any) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate', value: any) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate', value: any) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate', value: any) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate', value: any) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id', value: string) => PagesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | 'status', value: any[]) => PagesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'status', value: any) => PagesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | 'status', value: boolean) => PagesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'status'>) => PagesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'status'>) => PagesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => PagesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => PagesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<PagesQueryResult>;
+}
+interface BulkUpdatePageTagsOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+interface BulkUpdatePageTagsByFilterOptions {
+    /** List of Tags to assign */
+    assignTags?: Tags;
+    /** List of Tags to unAssign */
+    unassignTags?: Tags;
+}
+
+export { type ActionEvent, type ApplicationError, type ArchivePageRequest, type ArchivePageResponse, type BulkUpdatePageTagsApplicationErrors as B, type BulkActionMetadata, type BulkUpdatePageTagsByFilterOptions, type BulkUpdatePageTagsByFilterRequest, type BulkUpdatePageTagsByFilterResponse, type BulkUpdatePageTagsOptions, type BulkUpdatePageTagsRequest, type BulkUpdatePageTagsResponse, type BulkUpdatePageTagsResult, type CreatePageRequest, type CreatePageResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeletePageRequest, type DeletePageResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetPageRequest, type GetPageResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type Page, type PageArchived, type PageOriginOneOf, type PagePublished, type PageRoute, type PageScheduled, type PageUnarchived, type PageUnpublished, type PagesQueryBuilder, type PagesQueryResult, type PublishPageOptions, type PublishPageRequest, type PublishPageResponse, type QueryPagesRequest, type QueryPagesResponse, type RemovePageRouteRequest, type RemovePageRouteResponse, type RestoreInfo, type StatusWithLiterals as S, type SchedulePageOptions, type SchedulePageRequest, type SchedulePageResponse, type SetPageRouteRequest, type SetPageRouteResponse, SortOrder, type Sorting, Status, type TypeWithLiterals as T, type TagList, type Tags, Type, type UnarchivePageRequest, type UnarchivePageResponse, type UnpublishPageRequest, type UnpublishPageResponse, type UpdatePage, type UpdatePageRequest, type UpdatePageResponse, type WebhookIdentityTypeWithLiterals as W, WebhookIdentityType, type SortOrderWithLiterals as a, type BulkUpdatePageTagsByFilterApplicationErrors as b };