@wix/auto_sdk_papyrus_documents 1.0.11 → 1.0.13

package/build/es/meta.d.mts

@@ -1,4 +1,4 @@
-import { CreateDocumentRequest as CreateDocumentRequest$1, CreateDocumentResponse as CreateDocumentResponse$1, GetDocumentRequest as GetDocumentRequest$1, GetDocumentResponse as GetDocumentResponse$1, DeleteDocumentRequest as DeleteDocumentRequest$1, DeleteDocumentResponse as DeleteDocumentResponse$1, QueryDocumentRequest as QueryDocumentRequest$1, QueryDocumentResponse as QueryDocumentResponse$1, UpdateDocumentRequest as UpdateDocumentRequest$1, UpdateDocumentResponse as UpdateDocumentResponse$1, DownloadDocumentRequest as DownloadDocumentRequest$1, DownloadDocumentResponse as DownloadDocumentResponse$1, GetDownloadUrlRequest as GetDownloadUrlRequest$1, GetDownloadUrlResponse as GetDownloadUrlResponse$1, DownloadDocumentSourceRequest as DownloadDocumentSourceRequest$1, DownloadDocumentSourceResponse as DownloadDocumentSourceResponse$1, GetDownloadPageRequest as GetDownloadPageRequest$1, RawHttpResponse as RawHttpResponse$1, RedirectToDocumentRequest as RedirectToDocumentRequest$1 } from './index.typings.mjs';
+import { GetDownloadPageRequest as GetDownloadPageRequest$1, RawHttpResponse as RawHttpResponse$1, RedirectToDocumentRequest as RedirectToDocumentRequest$1, CreateDocumentRequest as CreateDocumentRequest$1, CreateDocumentResponse as CreateDocumentResponse$1, GetDocumentRequest as GetDocumentRequest$1, GetDocumentResponse as GetDocumentResponse$1, DeleteDocumentRequest as DeleteDocumentRequest$1, DeleteDocumentResponse as DeleteDocumentResponse$1, QueryDocumentRequest as QueryDocumentRequest$1, QueryDocumentResponse as QueryDocumentResponse$1, UpdateDocumentRequest as UpdateDocumentRequest$1, UpdateDocumentResponse as UpdateDocumentResponse$1, DownloadDocumentRequest as DownloadDocumentRequest$1, DownloadDocumentResponse as DownloadDocumentResponse$1, GetDownloadUrlRequest as GetDownloadUrlRequest$1, GetDownloadUrlResponse as GetDownloadUrlResponse$1, DownloadDocumentSourceRequest as DownloadDocumentSourceRequest$1, DownloadDocumentSourceResponse as DownloadDocumentSourceResponse$1 } from './index.typings.mjs';
 import '@wix/sdk-types';
 
 /** Document is the main entity of DocumentService. */
@@ -235,328 +235,258 @@ interface DebugOptions {
      */
     staticsVersionOverride?: string | null;
 }
-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 {
+interface RenderDocumentRequest {
+    /** Template settings. */
+    templateSettings?: TemplateSettings;
+    /** Document content. */
+    content?: DocumentContent;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormatWithLiterals;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
+     * @maxLength 100
      */
-    documentId: string;
-    /** @maxSize 1 */
-    fields?: RequestedFieldsWithLiterals[];
-}
-declare enum RequestedFields {
-    /** Include `documentContent` in the response. */
-    DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
-}
-/** @enumType */
-type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
-interface GetDocumentResponse {
-    /** The retrieved Document */
-    document?: Document;
-}
-interface DeleteDocumentRequest {
+    versionOverride?: string | null;
     /**
-     * ID of the Document to delete
-     * @format GUID
+     * Overrides static versions for the statics config.
+     * @maxSize 10
      */
-    documentId: string;
-}
-interface DeleteDocumentResponse {
-    /** Deleted document. */
-    document?: Document;
+    staticOverrides?: Record<string, string>;
 }
-interface DeleteDocumentByExternalIdRequest {
+interface TemplateSettings {
     /**
-     * External ID of the Document to delete
-     * @minLength 1
-     * @maxLength 100
+     * Auto generated ID.
+     * @format GUID
+     * @readonly
      */
-    externalId?: string;
-}
-interface DeleteDocumentByExternalIdResponse {
-    /** Deleted document. */
-    document?: Document;
-}
-interface QueryDocumentRequest {
-    /** WQL expression */
-    query: QueryV2;
-    /** @maxSize 1 */
-    fields?: RequestedFieldsWithLiterals[];
-}
-interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and offset 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;
+    id?: string | null;
     /**
-     * Filter object.
-     *
-     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     * Wix app definition ID.
+     * @minLength 1
+     * @maxLength 20
      */
-    filter?: Record<string, any> | null;
+    appSlug?: string | null;
     /**
-     * Sort object.
-     *
-     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * The type of the template.
+     * @minLength 1
+     * @maxLength 20
      */
-    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 offset 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 {
+    templateType?: string | null;
     /**
-     * Name of the field to sort by.
-     * @maxLength 512
+     * The id of the template.
+     * @minLength 1
+     * @maxLength 20
      */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
+    templateId?: string | null;
     /**
-     * Origin point for geo-distance sorting on a GEO field
-     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     * 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)
+     * @minLength 1
+     * @maxLength 100
      */
-    origin?: AddressLocation;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/** @enumType */
-type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
-}
-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 {
+    externalId?: string | null;
     /**
-     * Maximum number of items to return in the results.
-     * @max 100
+     * Date settings were created.
+     * @readonly
      */
-    limit?: number | null;
+    createdDate?: Date | 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
+     * Date settings were updated.
+     * @readonly
      */
-    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;
+    updatedDate?: Date | null;
+    /** @maxSize 10 */
+    settingGroups?: SettingsGroup[];
+    /** Paper size */
+    paperSize?: PaperSizeWithLiterals;
+    pageOverflow?: PageOverflowWithLiterals;
 }
-interface Cursors {
+interface TextSetting {
     /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
+     * Font family class name
+     * @maxLength 20
      */
-    next?: string | null;
+    fontFamily?: string | null;
     /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
+     * Font style class names
+     * @maxSize 10
+     * @maxLength 20
      */
-    prev?: string | null;
-}
-interface UpdateDocumentRequest {
+    fontStyle?: string[];
     /**
-     * Document ID.
-     * @format GUID
-     * @readonly
+     * Text alignment class name
+     * @maxLength 20
      */
-    id: string | null;
-    /** Document render status. */
-    renderStatus?: RenderStatusWithLiterals;
-    /** 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;
-    /** Size in bytes. */
-    sizeInBytes?: number | 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 {
+    textAlignment?: string | null;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Text color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    documentId: string;
+    textColor?: string | null;
     /**
-     * URL expiration time. Only relevant for private documents.
-     * @min 600
-     * @max 86400
+     * Font size
+     * @min 1
      */
-    urlExpirationInSeconds?: number | null;
+    fontSize?: number | null;
+    /** Text content setting */
+    textContent?: TextContent[];
+}
+interface TextContent {
     /**
-     * Whether the link downloads the file or opens the file in the browser.
-     * Default: `ATTACHMENT`
+     * @minLength 3
+     * @maxLength 50
      */
-    contentDisposition?: ContentDispositionWithLiterals;
-}
-declare enum ContentDisposition {
-    /** The link downloads the file. */
-    ATTACHMENT = "ATTACHMENT",
-    /** The link opens the file in the browser. */
-    INLINE = "INLINE"
+    id?: string;
+    /** @maxLength 500 */
+    value?: string | null;
+    visible?: boolean;
 }
-/** @enumType */
-type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
-interface DownloadDocumentResponse {
-    /** Download URL. */
-    downloadUrl?: string;
-    /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
-    expirationDate?: Date | null;
+interface ImageSetting {
+    /** Wix media Image */
+    image?: Image;
+    /** Image resizing mode */
+    resize?: ResizeOptionWithLiterals;
 }
-interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
+interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Original image height.
+     * @readonly
      */
-    documentId?: string | null;
+    height?: number;
     /**
-     * ID of the Document to retrieve
-     * @minLength 1
-     * @maxLength 100
+     * Original image width.
+     * @readonly
      */
-    externalId?: string | null;
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
     /**
-     * Signed file token
-     * @minLength 1
-     * @maxLength 500
+     * Image filename.
+     * @readonly
      */
-    fileToken?: string | null;
+    filename?: string | null;
+}
+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;
+}
+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"
+}
+/** @enumType */
+type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
+interface SelectSetting {
+    /** Selected value */
+    value?: string | null;
     /**
-     * URL expiration time. Only relevant for private documents.
-     * @min 600
-     * @max 86400
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    urlExpirationInSeconds?: number | null;
-    /** @maxLength 100 */
-    downloadButtonText?: string | null;
+    primaryColor?: string | null;
     /**
-     * Whether the link downloads the file or opens the file in the browser.
-     * Default: `ATTACHMENT`
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    contentDisposition?: ContentDispositionWithLiterals;
+    secondaryColor?: string | null;
+    /** Size */
+    size?: number | null;
 }
-/** @oneof */
-interface GetDownloadUrlRequestDocumentOneOf {
+interface BackgroundSetting {
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Color of the background hex code
+     * @minLength 7
+     * @maxLength 9
      */
-    documentId?: string | null;
+    color?: string | null;
+    /** Wix media Image */
+    image?: Image;
+}
+interface SettingsGroup {
     /**
-     * ID of the Document to retrieve
-     * @minLength 1
-     * @maxLength 100
+     * Id of the control group
+     * @minLength 5
+     * @maxLength 50
      */
-    externalId?: string | null;
+    groupId?: string;
     /**
-     * Signed file token
-     * @minLength 1
-     * @maxLength 500
+     * Display settings.
+     * @maxSize 20
      */
-    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 | null;
+    display?: Record<string, boolean>;
     /**
-     * Document ID.
-     * @format GUID
+     * Texts settings.
+     * @maxSize 20
      */
-    documentId?: string | null;
-    /** Document render status. */
-    renderStatus?: RenderStatusWithLiterals;
-    /** Download URL. */
-    downloadPageUrl?: string | null;
+    texts?: Record<string, TextSetting>;
     /**
-     * Client defined content checksum. Can be used for content comparison.
-     * @minLength 1
-     * @maxLength 64
+     * Images settings.
+     * @maxSize 10
      */
-    contentChecksum?: string | null;
-}
-interface DownloadDocumentSourceRequest {
+    images?: Record<string, ImageSetting>;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Select option settings.
+     * @maxSize 20
      */
-    documentId: string;
+    selects?: Record<string, SelectSetting>;
     /**
-     * Whether the link downloads the file or opens the file in the browser.
-     * Default: `ATTACHMENT`
+     * Backgrounds settings.
+     * @maxSize 20
      */
-    contentDisposition?: ContentDispositionWithLiterals;
+    backgrounds?: Record<string, BackgroundSetting>;
 }
-interface DownloadDocumentSourceResponse {
-    /** Download URL. Expires after 10 minutes. */
-    downloadUrl?: string;
+declare enum PaperSize {
+    A4_PORTRAIT = "A4_PORTRAIT",
+    A4_LANDSCAPE = "A4_LANDSCAPE"
+}
+/** @enumType */
+type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
+declare enum PageOverflow {
+    CONTENT_HIDDEN = "CONTENT_HIDDEN",
+    CONTENT_BREAK = "CONTENT_BREAK"
+}
+/** @enumType */
+type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
+declare enum RenderFormat {
+    /** content-type: application/pdf */
+    PDF = "PDF",
+    /** content-type: text/html */
+    HTML = "HTML"
+}
+/** @enumType */
+type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
+interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+interface RenderDocumentByIdRequest {
+    /**
+     * Document ID.
+     * @format GUID
+     */
+    documentId?: string | null;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormatWithLiterals;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -624,375 +554,445 @@ interface ActionEvent {
 }
 interface Empty {
 }
-interface MessageEnvelope {
+interface GetRendererInfoRequest {
+}
+interface GetRendererInfoResponse {
+    /** Renderer info */
+    info?: Record<string, string>;
+}
+interface GetCachedHtmlRequest {
     /**
-     * App instance ID.
-     * @format GUID
+     * Html Access Key.
+     * @maxLength 100
      */
-    instanceId?: string | null;
+    htmlAccessKey?: string;
     /**
-     * Event type.
-     * @maxLength 150
+     * Meta Site Id.
+     * @format GUID
      */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-    /** Details related to the account */
-    accountInfo?: AccountInfo;
+    metaSiteId?: string | null;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+interface GetDownloadPageRequest {
+    /** @maxLength 1000 */
+    file: string | null;
+}
+interface RedirectToDocumentRequest {
+    /** @maxLength 1000 */
+    file: string | null;
+}
+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 a site visitor that has not logged in to the site.
+     * ID of the Document to retrieve
      * @format GUID
      */
-    anonymousVisitorId?: string;
+    documentId: string;
+    /** @maxSize 1 */
+    fields?: RequestedFieldsWithLiterals[];
+}
+declare enum RequestedFields {
+    /** Include `documentContent` in the response. */
+    DOCUMENT_CONTENT = "DOCUMENT_CONTENT"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'DOCUMENT_CONTENT';
+interface GetDocumentResponse {
+    /** The retrieved Document */
+    document?: Document;
+}
+interface DeleteDocumentRequest {
     /**
-     * ID of a site visitor that has logged in to the site.
+     * ID of the Document to delete
      * @format GUID
      */
-    memberId?: string;
+    documentId: string;
+}
+interface DeleteDocumentResponse {
+    /** Deleted document. */
+    document?: Document;
+}
+interface DeleteDocumentByExternalIdRequest {
+    /**
+     * External ID of the Document to delete
+     * @minLength 1
+     * @maxLength 100
+     */
+    externalId?: string;
+}
+interface DeleteDocumentByExternalIdResponse {
+    /** Deleted document. */
+    document?: Document;
+}
+interface QueryDocumentRequest {
+    /** WQL expression */
+    query: QueryV2;
+    /** @maxSize 1 */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
-    wixUserId?: string;
+    filter?: Record<string, any> | null;
     /**
-     * ID of an app.
-     * @format GUID
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
+    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 IdentificationDataIdOneOf {
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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 {
     /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
+     * Name of the field to sort by.
+     * @maxLength 512
      */
-    anonymousVisitorId?: string;
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
      */
-    memberId?: string;
+    origin?: AddressLocation;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+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 {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * Maximum number of items to return in the results.
+     * @max 100
      */
-    wixUserId?: string;
+    limit?: number | null;
     /**
-     * ID of an app.
-     * @format GUID
+     * 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
      */
-    appId?: string;
+    cursor?: string | null;
 }
-declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
+interface QueryDocumentResponse {
+    /** The retrieved Documents */
+    documents?: Document[];
+    /** Query results' metadata */
+    metadata?: PagingMetadataV2;
 }
-/** @enumType */
-type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-interface AccountInfo {
+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 {
     /**
-     * ID of the Wix account associated with the event.
-     * @format GUID
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
      */
-    accountId?: string | null;
+    next?: string | null;
     /**
-     * ID of the parent Wix account. Only included when accountId belongs to a child account.
-     * @format GUID
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
      */
-    parentAccountId?: string | null;
+    prev?: string | null;
+}
+interface UpdateDocumentRequest {
     /**
-     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * Document ID.
      * @format GUID
+     * @readonly
      */
-    siteId?: string | null;
-}
-interface GetDownloadPageRequest {
-    /** @maxLength 1000 */
-    file: string | null;
+    id: string | null;
+    /** Document render status. */
+    renderStatus?: RenderStatusWithLiterals;
+    /** Rendered document file. */
+    file?: DocumentFile;
+    /** Rendered document source HTML file. */
+    sourceFile?: DocumentFile;
 }
-interface RawHttpResponse {
-    body?: Uint8Array;
-    statusCode?: number | null;
-    headers?: HeadersEntry[];
+interface DocumentFile {
+    /** File ID. */
+    fileId?: string | null;
+    /** File URL. Defined only for public documents. */
+    staticUrl?: string | null;
+    /** File path. */
+    filePath?: string | null;
+    /** Size in bytes. */
+    sizeInBytes?: number | null;
 }
-interface HeadersEntry {
-    key?: string;
-    value?: string;
+interface UpdateDocumentResponse {
+    /** The created Document */
+    document?: Document;
 }
-interface RedirectToDocumentRequest {
-    /** @maxLength 1000 */
-    file: string | null;
+interface DocumentRendered {
+    /** Rendered document */
+    document?: Document;
 }
-interface RenderDocumentRequest {
-    /** Template settings. */
-    templateSettings?: TemplateSettings;
-    /** Document content. */
-    content?: DocumentContent;
-    /** Output format, defaults to PDF. */
-    outputFormat?: RenderFormatWithLiterals;
-    /**
-     * Overrides papyrusTemplatesStaticsUrl: "//static.parastorage.com/services/papyrus-templates-statics/${version_override}/"
-     * @maxLength 100
-     */
-    versionOverride?: string | null;
-    /**
-     * Overrides static versions for the statics config.
-     * @maxSize 10
-     */
-    staticOverrides?: Record<string, string>;
+interface DocumentRenderFailed {
+    /** Document that failed to render */
+    document?: Document;
 }
-interface TemplateSettings {
+interface DownloadDocumentRequest {
     /**
-     * Auto generated ID.
+     * ID of the Document to retrieve
      * @format GUID
-     * @readonly
      */
-    id?: string | null;
+    documentId: string;
     /**
-     * Wix app definition ID.
-     * @minLength 1
-     * @maxLength 20
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
      */
-    appSlug?: string | null;
+    urlExpirationInSeconds?: number | null;
     /**
-     * The type of the template.
-     * @minLength 1
-     * @maxLength 20
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
      */
-    templateType?: string | null;
+    contentDisposition?: ContentDispositionWithLiterals;
+}
+declare enum ContentDisposition {
+    /** The link downloads the file. */
+    ATTACHMENT = "ATTACHMENT",
+    /** The link opens the file in the browser. */
+    INLINE = "INLINE"
+}
+/** @enumType */
+type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
+interface DownloadDocumentResponse {
+    /** Download URL. */
+    downloadUrl?: string;
+    /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
+    expirationDate?: Date | null;
+}
+interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
     /**
-     * The id of the template.
-     * @minLength 1
-     * @maxLength 20
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    templateId?: string | null;
+    documentId?: 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)
+     * ID of the Document to retrieve
      * @minLength 1
      * @maxLength 100
      */
     externalId?: string | null;
     /**
-     * Date settings were created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date settings were updated.
-     * @readonly
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
      */
-    updatedDate?: Date | null;
-    /** @maxSize 10 */
-    settingGroups?: SettingsGroup[];
-    /** Paper size */
-    paperSize?: PaperSizeWithLiterals;
-    pageOverflow?: PageOverflowWithLiterals;
-}
-interface TextSetting {
-    /**
-     * Font family class name
-     * @maxLength 20
+    fileToken?: string | null;
+    /**
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
      */
-    fontFamily?: string | null;
+    urlExpirationInSeconds?: number | null;
+    /** @maxLength 100 */
+    downloadButtonText?: string | null;
     /**
-     * Font style class names
-     * @maxSize 10
-     * @maxLength 20
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
      */
-    fontStyle?: string[];
+    contentDisposition?: ContentDispositionWithLiterals;
+}
+/** @oneof */
+interface GetDownloadUrlRequestDocumentOneOf {
     /**
-     * Text alignment class name
-     * @maxLength 20
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    textAlignment?: string | null;
+    documentId?: string | null;
     /**
-     * Text color hex code
-     * @minLength 7
-     * @maxLength 7
+     * ID of the Document to retrieve
+     * @minLength 1
+     * @maxLength 100
      */
-    textColor?: string | null;
+    externalId?: string | null;
     /**
-     * Font size
-     * @min 1
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
      */
-    fontSize?: number | null;
-    /** Text content setting */
-    textContent?: TextContent[];
+    fileToken?: string | null;
 }
-interface TextContent {
+interface GetDownloadUrlResponse {
+    /** Download URL. */
+    downloadUrl?: string | null;
+    /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
+    expirationDate?: Date | null;
     /**
-     * @minLength 3
-     * @maxLength 50
+     * Document ID.
+     * @format GUID
      */
-    id?: string;
-    /** @maxLength 500 */
-    value?: string | null;
-    visible?: boolean;
-}
-interface ImageSetting {
-    /** Wix media Image */
-    image?: Image;
-    /** Image resizing mode */
-    resize?: ResizeOptionWithLiterals;
-}
-interface Image {
-    /** WixMedia image ID. */
-    id?: string;
-    /** Image URL. */
-    url?: string;
+    documentId?: string | null;
+    /** Document render status. */
+    renderStatus?: RenderStatusWithLiterals;
+    /** Download URL. */
+    downloadPageUrl?: string | null;
     /**
-     * Original image height.
-     * @readonly
+     * Client defined content checksum. Can be used for content comparison.
+     * @minLength 1
+     * @maxLength 64
      */
-    height?: number;
+    contentChecksum?: string | null;
+}
+interface DownloadDocumentSourceRequest {
     /**
-     * Original image width.
-     * @readonly
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    width?: number;
-    /** Image alt text. */
-    altText?: string | null;
+    documentId: string;
     /**
-     * Image filename.
-     * @readonly
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
      */
-    filename?: string | null;
-}
-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;
+    contentDisposition?: ContentDispositionWithLiterals;
 }
-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 DownloadDocumentSourceResponse {
+    /** Download URL. Expires after 10 minutes. */
+    downloadUrl?: string;
 }
-/** @enumType */
-type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
-interface SelectSetting {
-    /** Selected value */
-    value?: string | null;
+interface MessageEnvelope {
     /**
-     * Color hex code
-     * @minLength 7
-     * @maxLength 7
+     * App instance ID.
+     * @format GUID
      */
-    primaryColor?: string | null;
+    instanceId?: string | null;
     /**
-     * Color hex code
-     * @minLength 7
-     * @maxLength 7
+     * Event type.
+     * @maxLength 150
      */
-    secondaryColor?: string | null;
-    /** Size */
-    size?: number | null;
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
 }
-interface BackgroundSetting {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
-     * Color of the background hex code
-     * @minLength 7
-     * @maxLength 9
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    color?: string | null;
-    /** Wix media Image */
-    image?: Image;
-}
-interface SettingsGroup {
+    anonymousVisitorId?: string;
     /**
-     * Id of the control group
-     * @minLength 5
-     * @maxLength 50
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    groupId?: string;
+    memberId?: string;
     /**
-     * Display settings.
-     * @maxSize 20
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    display?: Record<string, boolean>;
+    wixUserId?: string;
     /**
-     * Texts settings.
-     * @maxSize 20
+     * ID of an app.
+     * @format GUID
      */
-    texts?: Record<string, TextSetting>;
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
     /**
-     * Images settings.
-     * @maxSize 10
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    images?: Record<string, ImageSetting>;
+    anonymousVisitorId?: string;
     /**
-     * Select option settings.
-     * @maxSize 20
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    selects?: Record<string, SelectSetting>;
+    memberId?: string;
     /**
-     * Backgrounds settings.
-     * @maxSize 20
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    backgrounds?: Record<string, BackgroundSetting>;
-}
-declare enum PaperSize {
-    A4_PORTRAIT = "A4_PORTRAIT",
-    A4_LANDSCAPE = "A4_LANDSCAPE"
-}
-/** @enumType */
-type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
-declare enum PageOverflow {
-    CONTENT_HIDDEN = "CONTENT_HIDDEN",
-    CONTENT_BREAK = "CONTENT_BREAK"
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
 }
-/** @enumType */
-type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
-declare enum RenderFormat {
-    /** content-type: application/pdf */
-    PDF = "PDF",
-    /** content-type: text/html */
-    HTML = "HTML"
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
 }
 /** @enumType */
-type RenderFormatWithLiterals = RenderFormat | 'PDF' | 'HTML';
-interface RenderDocumentByIdRequest {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
     /**
-     * Document ID.
+     * ID of the Wix account associated with the event.
      * @format GUID
      */
-    documentId?: string | null;
-    /** Output format, defaults to PDF. */
-    outputFormat?: RenderFormatWithLiterals;
-}
-interface GetRendererInfoRequest {
-}
-interface GetRendererInfoResponse {
-    /** Renderer info */
-    info?: Record<string, string>;
-}
-interface GetCachedHtmlRequest {
+    accountId?: string | null;
     /**
-     * Html Access Key.
-     * @maxLength 100
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
      */
-    htmlAccessKey?: string;
+    parentAccountId?: string | null;
     /**
-     * Meta Site Id.
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
      * @format GUID
      */
-    metaSiteId?: string | null;
+    siteId?: string | null;
 }
 /** @docsIgnore */
 type DownloadDocumentApplicationErrors = {
@@ -1017,6 +1017,8 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
     __responseType: Q;
     __originalResponseType: R;
 };
+declare function getDownloadPage(): __PublicMethodMetaInfo<'GET', {}, GetDownloadPageRequest$1, GetDownloadPageRequest, RawHttpResponse$1, RawHttpResponse>;
+declare function redirectToDocument(): __PublicMethodMetaInfo<'GET', {}, RedirectToDocumentRequest$1, RedirectToDocumentRequest, RawHttpResponse$1, RawHttpResponse>;
 declare function createDocument(): __PublicMethodMetaInfo<'POST', {}, CreateDocumentRequest$1, CreateDocumentRequest, CreateDocumentResponse$1, CreateDocumentResponse>;
 declare function getDocument(): __PublicMethodMetaInfo<'GET', {
     documentId: string;
@@ -1035,7 +1037,5 @@ declare function getDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetDownload
 declare function downloadDocumentSource(): __PublicMethodMetaInfo<'GET', {
     documentId: string;
 }, DownloadDocumentSourceRequest$1, DownloadDocumentSourceRequest, DownloadDocumentSourceResponse$1, DownloadDocumentSourceResponse>;
-declare function getDownloadPage(): __PublicMethodMetaInfo<'GET', {}, GetDownloadPageRequest$1, GetDownloadPageRequest, RawHttpResponse$1, RawHttpResponse>;
-declare function redirectToDocument(): __PublicMethodMetaInfo<'GET', {}, RedirectToDocumentRequest$1, RedirectToDocumentRequest, RawHttpResponse$1, RawHttpResponse>;
 
 export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type BackgroundSetting as BackgroundSettingOriginal, ContentDisposition as ContentDispositionOriginal, type ContentDispositionWithLiterals as ContentDispositionWithLiteralsOriginal, type CreateDocumentRequest as CreateDocumentRequestOriginal, type CreateDocumentResponse as CreateDocumentResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DebugOptions as DebugOptionsOriginal, type DeleteDocumentByExternalIdRequest as DeleteDocumentByExternalIdRequestOriginal, type DeleteDocumentByExternalIdResponse as DeleteDocumentByExternalIdResponseOriginal, type DeleteDocumentRequest as DeleteDocumentRequestOriginal, type DeleteDocumentResponse as DeleteDocumentResponseOriginal, type DocumentContent as DocumentContentOriginal, type DocumentFile as DocumentFileOriginal, type Document as DocumentOriginal, type DocumentRenderDelayed as DocumentRenderDelayedOriginal, type DocumentRenderFailed as DocumentRenderFailedOriginal, type DocumentRendered as DocumentRenderedOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadDocumentApplicationErrors as DownloadDocumentApplicationErrorsOriginal, type DownloadDocumentRequest as DownloadDocumentRequestOriginal, type DownloadDocumentResponse as DownloadDocumentResponseOriginal, type DownloadDocumentSourceApplicationErrors as DownloadDocumentSourceApplicationErrorsOriginal, type DownloadDocumentSourceRequest as DownloadDocumentSourceRequestOriginal, type DownloadDocumentSourceResponse as DownloadDocumentSourceResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FocalPoint as FocalPointOriginal, Format as FormatOriginal, type FormatWithLiterals as FormatWithLiteralsOriginal, type GetCachedHtmlRequest as GetCachedHtmlRequestOriginal, type GetDocumentRequest as GetDocumentRequestOriginal, type GetDocumentResponse as GetDocumentResponseOriginal, type GetDownloadPageRequest as GetDownloadPageRequestOriginal, type GetDownloadUrlRequestDocumentOneOf as GetDownloadUrlRequestDocumentOneOfOriginal, type GetDownloadUrlRequest as GetDownloadUrlRequestOriginal, type GetDownloadUrlResponse as GetDownloadUrlResponseOriginal, type GetRendererInfoRequest as GetRendererInfoRequestOriginal, type GetRendererInfoResponse as GetRendererInfoResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImageSetting as ImageSettingOriginal, type MessageEnvelope as MessageEnvelopeOriginal, PageOverflow as PageOverflowOriginal, type PageOverflowWithLiterals as PageOverflowWithLiteralsOriginal, type PageSettings as PageSettingsOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, PaperSize as PaperSizeOriginal, type PaperSizeWithLiterals as PaperSizeWithLiteralsOriginal, type QueryDocumentRequest as QueryDocumentRequestOriginal, type QueryDocumentResponse as QueryDocumentResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RawHttpResponse as RawHttpResponseOriginal, type RedirectToDocumentRequest as RedirectToDocumentRequestOriginal, type RenderDelayedEventConfig as RenderDelayedEventConfigOriginal, type RenderDocumentByIdRequest as RenderDocumentByIdRequestOriginal, type RenderDocumentRequest as RenderDocumentRequestOriginal, RenderFormat as RenderFormatOriginal, type RenderFormatWithLiterals as RenderFormatWithLiteralsOriginal, RenderStatus as RenderStatusOriginal, type RenderStatusWithLiterals as RenderStatusWithLiteralsOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, ResizeOption as ResizeOptionOriginal, type ResizeOptionWithLiterals as ResizeOptionWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SelectSetting as SelectSettingOriginal, type SettingsGroup as SettingsGroupOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type TemplateSettings as TemplateSettingsOriginal, type TemplateSettingsOverride as TemplateSettingsOverrideOriginal, type TextContent as TextContentOriginal, type TextSetting as TextSettingOriginal, type UpdateDocumentRequest as UpdateDocumentRequestOriginal, type UpdateDocumentResponse as UpdateDocumentResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WixMpClientVersion as WixMpClientVersionOriginal, type WixMpClientVersionWithLiterals as WixMpClientVersionWithLiteralsOriginal, type __PublicMethodMetaInfo, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, queryDocument, redirectToDocument, updateDocument };