@wix/papyrus 1.0.0

package/type-bundles/index.bundle.d.ts

@@ -0,0 +1,932 @@
+/** Document is the main entity of DocumentService. */
+interface Document {
+    /**
+     * Document ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Represents the time this Document was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Document was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Document render status.
+     * @readonly
+     */
+    renderStatus?: RenderStatus;
+    /**
+     * URL to download document. Returned only when Document is in `READY` state.
+     * @readonly
+     */
+    downloadUrl?: string | null;
+    /** Template ID. When this parameter used the document will be rendered with this template default settings */
+    templateId?: string | null;
+    /** Unique per tenant external ID, for example order number. Used to retrieve Document later. */
+    externalId?: string | null;
+    /** Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings. */
+    templateSettingsExternalId?: string | null;
+    /** Template settings ID. */
+    templateSettingsId?: string | null;
+    /** The app slug of the template */
+    appSlug?: string | null;
+    /** The type of the template. */
+    templateType?: string | null;
+    /** Document content that is injected into template. */
+    content?: DocumentContent;
+    /** Number of hours after which document will be eventually expired and its content erased. */
+    expiresInHours?: number;
+    /**
+     * Represents the time this document becomes expired.
+     * @readonly
+     */
+    expirationDate?: Date;
+    /** Document format. Defaults to `PDF`. */
+    format?: Format;
+    /**
+     * Whether the link to the uploaded document is public or private.
+     * For public document static URL will be returned.
+     * For private document temporary URL will be generated by DocumentService.DownloadDocument.
+     */
+    public?: boolean | null;
+    /** Optional filename (without extension) to be used for the downloadable document. */
+    fileName?: string | null;
+    /** Client defined content checksum. Can be used for content comparison. */
+    contentChecksum?: string | null;
+    /** Rendering notification config. */
+    renderDelayedEventConfig?: RenderDelayedEventConfig;
+}
+declare enum RenderStatus {
+    UNKNOWN = "UNKNOWN",
+    /** Document was accepted and is waiting to be rendered. */
+    ACCEPTED = "ACCEPTED",
+    /** Rendering is in progress. */
+    RENDERING = "RENDERING",
+    /** Rendering finished successfully and document is ready to download. */
+    READY = "READY",
+    /** Rendering failed. */
+    FAILED = "FAILED",
+    /** Rendered document expired and is no longer available for download. */
+    EXPIRED = "EXPIRED"
+}
+interface DocumentContent {
+    /** Document pages. Each page is reference as $page. */
+    pages?: Record<string, any>[] | null;
+    /** Other document content referenced by $content variable */
+    content?: Record<string, any> | null;
+    /** ISO 639-1 language code of content (used in translations). */
+    language?: string;
+    /** IETF BCP 47 language tag (e.g. en-US). */
+    locale?: string | null;
+}
+declare enum Format {
+    UNKNOWN = "UNKNOWN",
+    PDF = "PDF"
+}
+interface TemplateSettingsOverride {
+    /** Indices (0-based) of pages with template settings override. */
+    pageIndices?: number[];
+    /** Template settings ID. */
+    templateSettingsId?: string | null;
+    /** Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings. */
+    templateSettingsExternalId?: string | null;
+    /** Template ID. When this parameter used the page will be rendered with this template default settings */
+    templateId?: string | null;
+}
+interface PageSettings {
+    /** Indices (0-based) of pages with template settings override. */
+    pageIndices?: number[];
+    /** Template settings ID. */
+    templateSettingsId?: string | null;
+    /** Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings. */
+    templateSettingsExternalId?: string | null;
+    /** Template ID. When this parameter used the page will be rendered with this template default settings */
+    templateId?: string | null;
+}
+declare enum WixMpClientVersion {
+    UNKNOWN = "UNKNOWN",
+    MP_V1 = "MP_V1",
+    MP_V2 = "MP_V2"
+}
+interface RenderDelayedEventConfig {
+    /**
+     * Controls DocumentRenderDelayed action event sending.
+     * Event will be sent after time_in_queue_minutes if document render status is ACCEPTED/RENDERING.
+     */
+    timeInQueueMinutes?: number;
+}
+interface GetDownloadPageRequest {
+    file: string | null;
+}
+interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+interface RenderDocumentRequestV2 {
+    /** Template settings. */
+    templateSettings?: TemplateSettings;
+    /** Document content. */
+    content?: DocumentContent;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormat;
+    /** Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/" */
+    versionOverride?: string | null;
+}
+interface TemplateSettings {
+    /**
+     * Auto generated ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Wix app definition ID. */
+    appSlug?: string | null;
+    /** The type of the template. */
+    templateType?: string | null;
+    /** The id of the template. */
+    templateId?: string | null;
+    /**
+     * Template settings external ID. For example ticket definition ID.
+     * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
+     */
+    externalId?: string | null;
+    /**
+     * Date settings were created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date settings were updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    settingGroups?: SettingsGroup[];
+    /** Paper size */
+    paperSize?: PaperSize;
+}
+interface TextSetting {
+    /** Font family class name */
+    fontFamily?: string | null;
+    /** Font style class names */
+    fontStyle?: string[];
+    /** Text alignment class name */
+    textAlignment?: string | null;
+    /** Text color hex code */
+    textColor?: string | null;
+    /** Font size */
+    fontSize?: number | null;
+    /** Text content setting */
+    textContent?: TextContent[];
+}
+interface TextContent {
+    _id?: string;
+    value?: string | null;
+    visible?: boolean;
+}
+interface ImageSetting {
+    /** Wix media Image */
+    image?: string;
+    /** Image resizing mode */
+    resize?: ResizeOption;
+}
+declare enum ResizeOption {
+    /** Automatically resizes full image to fit image field */
+    FIT = "FIT",
+    /** Enables user to manually crop image to fit image field */
+    CROP = "CROP"
+}
+interface SelectSetting {
+    /** Selected value */
+    value?: string | null;
+    /** Color hex code */
+    primaryColor?: string | null;
+    /** Color hex code */
+    secondaryColor?: string | null;
+    /** Size */
+    size?: number | null;
+}
+interface BackgroundSetting {
+    /** Color of the background hex code */
+    color?: string | null;
+    /** Wix media Image */
+    image?: string;
+}
+interface SettingsGroup {
+    /** Id of the control group */
+    groupId?: string;
+    /** Display settings. */
+    display?: Record<string, boolean>;
+    /** Texts settings. */
+    texts?: Record<string, TextSetting>;
+    /** Images settings. */
+    images?: Record<string, ImageSetting>;
+    /** Select option settings. */
+    selects?: Record<string, SelectSetting>;
+    /** Backgrounds settings. */
+    backgrounds?: Record<string, BackgroundSetting>;
+}
+declare enum PaperSize {
+    A4_PORTRAIT = "A4_PORTRAIT",
+    A4_LANDSCAPE = "A4_LANDSCAPE"
+}
+declare enum RenderFormat {
+    /** content-type: application/pdf */
+    PDF = "PDF",
+    /** content-type: text/html */
+    HTML = "HTML"
+}
+interface RenderDocumentByIdRequest {
+    /** Document ID. */
+    documentId?: string | null;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormat;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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;
+    /**
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+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 Empty {
+}
+interface DocumentRenderDelayed {
+    /** Document that is being rendered. */
+    document?: Document;
+}
+interface CreateDocumentRequest {
+    /** Document to be created */
+    document?: Document;
+}
+interface CreateDocumentResponse {
+    /** The created Document */
+    document?: Document;
+}
+interface GetDocumentRequest {
+    /** ID of the Document to retrieve */
+    documentId: string;
+    fields?: RequestedFields[];
+}
+declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** Include `documentContent` in the response. */
+    DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
+}
+interface GetDocumentResponse {
+    /** The retrieved Document */
+    document?: Document;
+}
+interface DeleteDocumentRequest {
+    /** ID of the Document to delete */
+    documentId: string;
+}
+interface DeleteDocumentResponse {
+    /** Deleted document. */
+    document?: Document;
+}
+interface QueryDocumentRequest {
+    /** WQL expression */
+    query: QueryV2;
+    fields?: RequestedFields[];
+}
+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 the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    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. */
+    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. */
+    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. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+interface QueryDocumentResponse {
+    /** The retrieved Documents */
+    documents?: Document[];
+    /** Query results' metadata */
+    metadata?: 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;
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface UpdateDocumentRequest {
+    /**
+     * Document ID.
+     * @readonly
+     */
+    _id: string | null;
+    /** Document render status. */
+    renderStatus?: RenderStatus;
+    /** Rendered document file. */
+    file?: DocumentFile;
+    /** Rendered document source HTML file. */
+    sourceFile?: DocumentFile;
+}
+interface DocumentFile {
+    /** File ID. */
+    fileId?: string | null;
+    /** File URL. Defined only for public documents. */
+    staticUrl?: string | null;
+    /** File path. */
+    filePath?: string | null;
+}
+interface UpdateDocumentResponse {
+    /** The created Document */
+    document?: Document;
+}
+interface DocumentRendered {
+    /** Rendered document */
+    document?: Document;
+}
+interface DocumentRenderFailed {
+    /** Document that failed to render */
+    document?: Document;
+}
+interface DownloadDocumentRequest {
+    /** ID of the Document to retrieve */
+    documentId: string;
+    /** URL expiration time. Only relevant for private documents. */
+    urlExpirationInSeconds?: number | null;
+}
+interface DownloadDocumentResponse {
+    /** Download URL. */
+    downloadUrl?: string;
+    /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
+    expirationDate?: Date;
+}
+interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
+    /** ID of the Document to retrieve */
+    documentId?: string | null;
+    /** ID of the Document to retrieve */
+    externalId?: string | null;
+    /** Signed file token */
+    fileToken?: string | null;
+    /** URL expiration time. Only relevant for private documents. */
+    urlExpirationInSeconds?: number | null;
+}
+/** @oneof */
+interface GetDownloadUrlRequestDocumentOneOf {
+    /** ID of the Document to retrieve */
+    documentId?: string | null;
+    /** ID of the Document to retrieve */
+    externalId?: string | null;
+    /** Signed file token */
+    fileToken?: string | null;
+}
+interface GetDownloadUrlResponse {
+    /** Download URL. */
+    downloadUrl?: string | null;
+    /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
+    expirationDate?: Date;
+    /** Document ID. */
+    documentId?: string | null;
+    /** Document render status. */
+    renderStatus?: RenderStatus;
+    /** Download URL. */
+    downloadPageUrl?: string | null;
+}
+interface DownloadDocumentSourceRequest {
+    /** ID of the Document to retrieve */
+    documentId: string;
+}
+interface DownloadDocumentSourceResponse {
+    /** Download URL. Expires after 10 minutes. */
+    downloadUrl?: string;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    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. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface HeadersEntryNonNullableFields {
+    key: string;
+    value: string;
+}
+interface RawHttpResponseNonNullableFields {
+    body: Uint8Array;
+    headers: HeadersEntryNonNullableFields[];
+}
+interface DocumentContentNonNullableFields {
+    language: string;
+}
+interface TemplateSettingsOverrideNonNullableFields {
+    pageIndices: number[];
+}
+interface PageSettingsNonNullableFields {
+    pageIndices: number[];
+}
+interface RenderDelayedEventConfigNonNullableFields {
+    timeInQueueMinutes: number;
+}
+interface DocumentNonNullableFields {
+    renderStatus: RenderStatus;
+    content?: DocumentContentNonNullableFields;
+    expiresInHours: number;
+    format: Format;
+    templateSettings: TemplateSettingsOverrideNonNullableFields[];
+    pageSettings: PageSettingsNonNullableFields[];
+    wixMpClientVersion: WixMpClientVersion;
+    renderDelayedEventConfig?: RenderDelayedEventConfigNonNullableFields;
+}
+interface CreateDocumentResponseNonNullableFields {
+    document?: DocumentNonNullableFields;
+}
+interface GetDocumentResponseNonNullableFields {
+    document?: DocumentNonNullableFields;
+}
+interface DeleteDocumentResponseNonNullableFields {
+    document?: DocumentNonNullableFields;
+}
+interface QueryDocumentResponseNonNullableFields {
+    documents: DocumentNonNullableFields[];
+}
+interface UpdateDocumentResponseNonNullableFields {
+    document?: DocumentNonNullableFields;
+}
+interface DownloadDocumentResponseNonNullableFields {
+    downloadUrl: string;
+}
+interface GetDownloadUrlResponseNonNullableFields {
+    renderStatus: RenderStatus;
+}
+interface DownloadDocumentSourceResponseNonNullableFields {
+    downloadUrl: string;
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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;
+    /**
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface DocumentRenderDelayedEnvelope {
+    data: DocumentRenderDelayed;
+    metadata: EventMetadata;
+}
+interface DocumentCreatedEnvelope {
+    entity: Document;
+    metadata: EventMetadata;
+}
+interface DocumentDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface DocumentUpdatedEnvelope {
+    entity: Document;
+    metadata: EventMetadata;
+}
+interface DocumentRenderedEnvelope {
+    data: DocumentRendered;
+    metadata: EventMetadata;
+}
+interface DocumentRenderFailedEnvelope {
+    data: DocumentRenderFailed;
+    metadata: EventMetadata;
+}
+interface CreateDocumentOptions {
+    /** Document to be created */
+    document?: Document;
+}
+interface GetDocumentOptions {
+    fields?: RequestedFields[];
+}
+interface QueryDocumentOptions {
+    fields?: RequestedFields[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface DocumentsQueryResult extends QueryCursorResult {
+    items: Document[];
+    query: DocumentsQueryBuilder;
+    next: () => Promise<DocumentsQueryResult>;
+    prev: () => Promise<DocumentsQueryResult>;
+}
+interface DocumentsQueryBuilder {
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => DocumentsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => DocumentsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<DocumentsQueryResult>;
+}
+interface UpdateDocumentOptions {
+    /** Document render status. */
+    renderStatus?: RenderStatus;
+    /** Rendered document file. */
+    file?: DocumentFile;
+    /** Rendered document source HTML file. */
+    sourceFile?: DocumentFile;
+}
+interface DownloadDocumentOptions {
+    /** URL expiration time. Only relevant for private documents. */
+    urlExpirationInSeconds?: number | null;
+}
+interface GetDownloadUrlOptions extends GetDownloadUrlRequestDocumentOneOf {
+    /** ID of the Document to retrieve */
+    documentId?: string | null;
+    /** ID of the Document to retrieve */
+    externalId?: string | null;
+    /** Signed file token */
+    fileToken?: string | null;
+    /** URL expiration time. Only relevant for private documents. */
+    urlExpirationInSeconds?: number | null;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const getDownloadPage: ReturnType<typeof createRESTModule<typeof publicGetDownloadPage>>;
+declare const createDocument: ReturnType<typeof createRESTModule<typeof publicCreateDocument>>;
+declare const getDocument: ReturnType<typeof createRESTModule<typeof publicGetDocument>>;
+declare const deleteDocument: ReturnType<typeof createRESTModule<typeof publicDeleteDocument>>;
+declare const queryDocument: ReturnType<typeof createRESTModule<typeof publicQueryDocument>>;
+declare const updateDocument: ReturnType<typeof createRESTModule<typeof publicUpdateDocument>>;
+declare const downloadDocument: ReturnType<typeof createRESTModule<typeof publicDownloadDocument>>;
+declare const getDownloadUrl: ReturnType<typeof createRESTModule<typeof publicGetDownloadUrl>>;
+declare const downloadDocumentSource: ReturnType<typeof createRESTModule<typeof publicDownloadDocumentSource>>;
+declare const onDocumentRenderDelayed: ReturnType<typeof createEventModule<typeof publicOnDocumentRenderDelayed>>;
+declare const onDocumentCreated: ReturnType<typeof createEventModule<typeof publicOnDocumentCreated>>;
+declare const onDocumentDeleted: ReturnType<typeof createEventModule<typeof publicOnDocumentDeleted>>;
+declare const onDocumentUpdated: ReturnType<typeof createEventModule<typeof publicOnDocumentUpdated>>;
+declare const onDocumentRendered: ReturnType<typeof createEventModule<typeof publicOnDocumentRendered>>;
+declare const onDocumentRenderFailed: ReturnType<typeof createEventModule<typeof publicOnDocumentRenderFailed>>;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_BackgroundSetting = BackgroundSetting;
+type index_d_BaseEventMetadata = BaseEventMetadata;
+type index_d_CreateDocumentOptions = CreateDocumentOptions;
+type index_d_CreateDocumentRequest = CreateDocumentRequest;
+type index_d_CreateDocumentResponse = CreateDocumentResponse;
+type index_d_CreateDocumentResponseNonNullableFields = CreateDocumentResponseNonNullableFields;
+type index_d_CursorPaging = CursorPaging;
+type index_d_Cursors = Cursors;
+type index_d_DeleteDocumentRequest = DeleteDocumentRequest;
+type index_d_DeleteDocumentResponse = DeleteDocumentResponse;
+type index_d_DeleteDocumentResponseNonNullableFields = DeleteDocumentResponseNonNullableFields;
+type index_d_Document = Document;
+type index_d_DocumentContent = DocumentContent;
+type index_d_DocumentCreatedEnvelope = DocumentCreatedEnvelope;
+type index_d_DocumentDeletedEnvelope = DocumentDeletedEnvelope;
+type index_d_DocumentFile = DocumentFile;
+type index_d_DocumentNonNullableFields = DocumentNonNullableFields;
+type index_d_DocumentRenderDelayed = DocumentRenderDelayed;
+type index_d_DocumentRenderDelayedEnvelope = DocumentRenderDelayedEnvelope;
+type index_d_DocumentRenderFailed = DocumentRenderFailed;
+type index_d_DocumentRenderFailedEnvelope = DocumentRenderFailedEnvelope;
+type index_d_DocumentRendered = DocumentRendered;
+type index_d_DocumentRenderedEnvelope = DocumentRenderedEnvelope;
+type index_d_DocumentUpdatedEnvelope = DocumentUpdatedEnvelope;
+type index_d_DocumentsQueryBuilder = DocumentsQueryBuilder;
+type index_d_DocumentsQueryResult = DocumentsQueryResult;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_DownloadDocumentOptions = DownloadDocumentOptions;
+type index_d_DownloadDocumentRequest = DownloadDocumentRequest;
+type index_d_DownloadDocumentResponse = DownloadDocumentResponse;
+type index_d_DownloadDocumentResponseNonNullableFields = DownloadDocumentResponseNonNullableFields;
+type index_d_DownloadDocumentSourceRequest = DownloadDocumentSourceRequest;
+type index_d_DownloadDocumentSourceResponse = DownloadDocumentSourceResponse;
+type index_d_DownloadDocumentSourceResponseNonNullableFields = DownloadDocumentSourceResponseNonNullableFields;
+type index_d_Empty = Empty;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_EventMetadata = EventMetadata;
+type index_d_Format = Format;
+declare const index_d_Format: typeof Format;
+type index_d_GetDocumentOptions = GetDocumentOptions;
+type index_d_GetDocumentRequest = GetDocumentRequest;
+type index_d_GetDocumentResponse = GetDocumentResponse;
+type index_d_GetDocumentResponseNonNullableFields = GetDocumentResponseNonNullableFields;
+type index_d_GetDownloadPageRequest = GetDownloadPageRequest;
+type index_d_GetDownloadUrlOptions = GetDownloadUrlOptions;
+type index_d_GetDownloadUrlRequest = GetDownloadUrlRequest;
+type index_d_GetDownloadUrlRequestDocumentOneOf = GetDownloadUrlRequestDocumentOneOf;
+type index_d_GetDownloadUrlResponse = GetDownloadUrlResponse;
+type index_d_GetDownloadUrlResponseNonNullableFields = GetDownloadUrlResponseNonNullableFields;
+type index_d_HeadersEntry = HeadersEntry;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_ImageSetting = ImageSetting;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_PageSettings = PageSettings;
+type index_d_Paging = Paging;
+type index_d_PagingMetadataV2 = PagingMetadataV2;
+type index_d_PaperSize = PaperSize;
+declare const index_d_PaperSize: typeof PaperSize;
+type index_d_QueryDocumentOptions = QueryDocumentOptions;
+type index_d_QueryDocumentRequest = QueryDocumentRequest;
+type index_d_QueryDocumentResponse = QueryDocumentResponse;
+type index_d_QueryDocumentResponseNonNullableFields = QueryDocumentResponseNonNullableFields;
+type index_d_QueryV2 = QueryV2;
+type index_d_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
+type index_d_RawHttpResponse = RawHttpResponse;
+type index_d_RawHttpResponseNonNullableFields = RawHttpResponseNonNullableFields;
+type index_d_RenderDelayedEventConfig = RenderDelayedEventConfig;
+type index_d_RenderDocumentByIdRequest = RenderDocumentByIdRequest;
+type index_d_RenderDocumentRequestV2 = RenderDocumentRequestV2;
+type index_d_RenderFormat = RenderFormat;
+declare const index_d_RenderFormat: typeof RenderFormat;
+type index_d_RenderStatus = RenderStatus;
+declare const index_d_RenderStatus: typeof RenderStatus;
+type index_d_RequestedFields = RequestedFields;
+declare const index_d_RequestedFields: typeof RequestedFields;
+type index_d_ResizeOption = ResizeOption;
+declare const index_d_ResizeOption: typeof ResizeOption;
+type index_d_RestoreInfo = RestoreInfo;
+type index_d_SelectSetting = SelectSetting;
+type index_d_SettingsGroup = SettingsGroup;
+type index_d_SortOrder = SortOrder;
+declare const index_d_SortOrder: typeof SortOrder;
+type index_d_Sorting = Sorting;
+type index_d_TemplateSettings = TemplateSettings;
+type index_d_TemplateSettingsOverride = TemplateSettingsOverride;
+type index_d_TextContent = TextContent;
+type index_d_TextSetting = TextSetting;
+type index_d_UpdateDocumentOptions = UpdateDocumentOptions;
+type index_d_UpdateDocumentRequest = UpdateDocumentRequest;
+type index_d_UpdateDocumentResponse = UpdateDocumentResponse;
+type index_d_UpdateDocumentResponseNonNullableFields = UpdateDocumentResponseNonNullableFields;
+type index_d_WebhookIdentityType = WebhookIdentityType;
+declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
+type index_d_WixMpClientVersion = WixMpClientVersion;
+declare const index_d_WixMpClientVersion: typeof WixMpClientVersion;
+declare const index_d_createDocument: typeof createDocument;
+declare const index_d_deleteDocument: typeof deleteDocument;
+declare const index_d_downloadDocument: typeof downloadDocument;
+declare const index_d_downloadDocumentSource: typeof downloadDocumentSource;
+declare const index_d_getDocument: typeof getDocument;
+declare const index_d_getDownloadPage: typeof getDownloadPage;
+declare const index_d_getDownloadUrl: typeof getDownloadUrl;
+declare const index_d_onDocumentCreated: typeof onDocumentCreated;
+declare const index_d_onDocumentDeleted: typeof onDocumentDeleted;
+declare const index_d_onDocumentRenderDelayed: typeof onDocumentRenderDelayed;
+declare const index_d_onDocumentRenderFailed: typeof onDocumentRenderFailed;
+declare const index_d_onDocumentRendered: typeof onDocumentRendered;
+declare const index_d_onDocumentUpdated: typeof onDocumentUpdated;
+declare const index_d_queryDocument: typeof queryDocument;
+declare const index_d_updateDocument: typeof updateDocument;
+declare namespace index_d {
+  export { type index_d_ActionEvent as ActionEvent, type index_d_BackgroundSetting as BackgroundSetting, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CreateDocumentOptions as CreateDocumentOptions, type index_d_CreateDocumentRequest as CreateDocumentRequest, type index_d_CreateDocumentResponse as CreateDocumentResponse, type index_d_CreateDocumentResponseNonNullableFields as CreateDocumentResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_DeleteDocumentRequest as DeleteDocumentRequest, type index_d_DeleteDocumentResponse as DeleteDocumentResponse, type index_d_DeleteDocumentResponseNonNullableFields as DeleteDocumentResponseNonNullableFields, type index_d_Document as Document, type index_d_DocumentContent as DocumentContent, type index_d_DocumentCreatedEnvelope as DocumentCreatedEnvelope, type index_d_DocumentDeletedEnvelope as DocumentDeletedEnvelope, type index_d_DocumentFile as DocumentFile, type index_d_DocumentNonNullableFields as DocumentNonNullableFields, type index_d_DocumentRenderDelayed as DocumentRenderDelayed, type index_d_DocumentRenderDelayedEnvelope as DocumentRenderDelayedEnvelope, type index_d_DocumentRenderFailed as DocumentRenderFailed, type index_d_DocumentRenderFailedEnvelope as DocumentRenderFailedEnvelope, type index_d_DocumentRendered as DocumentRendered, type index_d_DocumentRenderedEnvelope as DocumentRenderedEnvelope, type index_d_DocumentUpdatedEnvelope as DocumentUpdatedEnvelope, type index_d_DocumentsQueryBuilder as DocumentsQueryBuilder, type index_d_DocumentsQueryResult as DocumentsQueryResult, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_DownloadDocumentOptions as DownloadDocumentOptions, type index_d_DownloadDocumentRequest as DownloadDocumentRequest, type index_d_DownloadDocumentResponse as DownloadDocumentResponse, type index_d_DownloadDocumentResponseNonNullableFields as DownloadDocumentResponseNonNullableFields, type index_d_DownloadDocumentSourceRequest as DownloadDocumentSourceRequest, type index_d_DownloadDocumentSourceResponse as DownloadDocumentSourceResponse, type index_d_DownloadDocumentSourceResponseNonNullableFields as DownloadDocumentSourceResponseNonNullableFields, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, index_d_Format as Format, type index_d_GetDocumentOptions as GetDocumentOptions, type index_d_GetDocumentRequest as GetDocumentRequest, type index_d_GetDocumentResponse as GetDocumentResponse, type index_d_GetDocumentResponseNonNullableFields as GetDocumentResponseNonNullableFields, type index_d_GetDownloadPageRequest as GetDownloadPageRequest, type index_d_GetDownloadUrlOptions as GetDownloadUrlOptions, type index_d_GetDownloadUrlRequest as GetDownloadUrlRequest, type index_d_GetDownloadUrlRequestDocumentOneOf as GetDownloadUrlRequestDocumentOneOf, type index_d_GetDownloadUrlResponse as GetDownloadUrlResponse, type index_d_GetDownloadUrlResponseNonNullableFields as GetDownloadUrlResponseNonNullableFields, type index_d_HeadersEntry as HeadersEntry, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ImageSetting as ImageSetting, type index_d_MessageEnvelope as MessageEnvelope, type index_d_PageSettings as PageSettings, type index_d_Paging as Paging, type index_d_PagingMetadataV2 as PagingMetadataV2, index_d_PaperSize as PaperSize, type index_d_QueryDocumentOptions as QueryDocumentOptions, type index_d_QueryDocumentRequest as QueryDocumentRequest, type index_d_QueryDocumentResponse as QueryDocumentResponse, type index_d_QueryDocumentResponseNonNullableFields as QueryDocumentResponseNonNullableFields, type index_d_QueryV2 as QueryV2, type index_d_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type index_d_RawHttpResponse as RawHttpResponse, type index_d_RawHttpResponseNonNullableFields as RawHttpResponseNonNullableFields, type index_d_RenderDelayedEventConfig as RenderDelayedEventConfig, type index_d_RenderDocumentByIdRequest as RenderDocumentByIdRequest, type index_d_RenderDocumentRequestV2 as RenderDocumentRequestV2, index_d_RenderFormat as RenderFormat, index_d_RenderStatus as RenderStatus, index_d_RequestedFields as RequestedFields, index_d_ResizeOption as ResizeOption, type index_d_RestoreInfo as RestoreInfo, type index_d_SelectSetting as SelectSetting, type index_d_SettingsGroup as SettingsGroup, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_TemplateSettings as TemplateSettings, type index_d_TemplateSettingsOverride as TemplateSettingsOverride, type index_d_TextContent as TextContent, type index_d_TextSetting as TextSetting, type index_d_UpdateDocumentOptions as UpdateDocumentOptions, type index_d_UpdateDocumentRequest as UpdateDocumentRequest, type index_d_UpdateDocumentResponse as UpdateDocumentResponse, type index_d_UpdateDocumentResponseNonNullableFields as UpdateDocumentResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, index_d_WixMpClientVersion as WixMpClientVersion, index_d_createDocument as createDocument, index_d_deleteDocument as deleteDocument, index_d_downloadDocument as downloadDocument, index_d_downloadDocumentSource as downloadDocumentSource, index_d_getDocument as getDocument, index_d_getDownloadPage as getDownloadPage, index_d_getDownloadUrl as getDownloadUrl, index_d_onDocumentCreated as onDocumentCreated, index_d_onDocumentDeleted as onDocumentDeleted, index_d_onDocumentRenderDelayed as onDocumentRenderDelayed, index_d_onDocumentRenderFailed as onDocumentRenderFailed, index_d_onDocumentRendered as onDocumentRendered, index_d_onDocumentUpdated as onDocumentUpdated, index_d_queryDocument as queryDocument, index_d_updateDocument as updateDocument };
+}
+
+export { index_d as documents };