@wix/auto_sdk_papyrus_documents 1.0.7 → 1.0.8

package/build/internal/cjs/index.typings.d.ts

@@ -267,235 +267,351 @@ interface DebugOptions {
      */
     staticsVersionOverride?: string | null;
 }
-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;
+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 {
     /**
-     * Overrides static versions for the statics config.
-     * @maxSize 10
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    staticOverrides?: Record<string, string>;
+    documentId: string;
+    /** @maxSize 1 */
+    fields?: RequestedFieldsWithLiterals[];
 }
-interface TemplateSettings {
+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 {
     /**
-     * Auto generated ID.
+     * ID of the Document to delete
      * @format GUID
-     * @readonly
      */
-    _id?: string | null;
+    documentId: string;
+}
+interface DeleteDocumentResponse {
+    /** Deleted document. */
+    document?: Document;
+}
+interface DeleteDocumentByExternalIdRequest {
     /**
-     * Wix app definition ID.
+     * External ID of the Document to delete
      * @minLength 1
-     * @maxLength 20
+     * @maxLength 100
      */
-    appSlug?: string | null;
+    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;
     /**
-     * The type of the template.
-     * @minLength 1
-     * @maxLength 20
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
-    templateType?: string | null;
+    filter?: Record<string, any> | null;
     /**
-     * The id of the template.
-     * @minLength 1
-     * @maxLength 20
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      */
-    templateId?: string | null;
+    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 {
     /**
-     * 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
+     * Name of the field to sort by.
+     * @maxLength 512
      */
-    externalId?: string | null;
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
     /**
-     * Date settings were created.
-     * @readonly
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
      */
-    _createdDate?: Date | null;
+    selectItemsBy?: Record<string, any>[] | null;
     /**
-     * Date settings were updated.
-     * @readonly
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
      */
-    _updatedDate?: Date | null;
-    /** @maxSize 10 */
-    settingGroups?: SettingsGroup[];
-    /** Paper size */
-    paperSize?: PaperSizeWithLiterals;
-    pageOverflow?: PageOverflowWithLiterals;
+    origin?: AddressLocation;
 }
-interface TextSetting {
+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 {
     /**
-     * Font family class name
-     * @maxLength 20
+     * Maximum number of items to return in the results.
+     * @max 100
      */
-    fontFamily?: string | null;
+    limit?: number | null;
     /**
-     * Font style class names
-     * @maxSize 10
-     * @maxLength 20
+     * 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
      */
-    fontStyle?: string[];
+    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;
     /**
-     * Text alignment class name
-     * @maxLength 20
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
      */
-    textAlignment?: string | null;
+    hasNext?: boolean | null;
+}
+interface Cursors {
     /**
-     * Text color hex code
-     * @minLength 7
-     * @maxLength 7
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
      */
-    textColor?: string | null;
+    next?: string | null;
     /**
-     * Font size
-     * @min 1
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
      */
-    fontSize?: number | null;
-    /** Text content setting */
-    textContent?: TextContent[];
+    prev?: string | null;
 }
-interface TextContent {
+interface UpdateDocumentRequest {
     /**
-     * @minLength 3
-     * @maxLength 50
+     * Document ID.
+     * @format GUID
+     * @readonly
      */
-    _id?: string;
-    /** @maxLength 500 */
-    value?: string | null;
-    visible?: boolean;
+    _id: string | null;
+    /** Document render status. */
+    renderStatus?: RenderStatusWithLiterals;
+    /** Rendered document file. */
+    file?: DocumentFile;
+    /** Rendered document source HTML file. */
+    sourceFile?: DocumentFile;
 }
-interface ImageSetting {
-    /** Wix media Image */
-    image?: string;
-    /** Image resizing mode */
-    resize?: ResizeOptionWithLiterals;
+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 FocalPoint {
-    /** X-coordinate of the focal point. */
-    x?: number;
-    /** Y-coordinate of the focal point. */
-    y?: number;
-    /** crop by height */
-    height?: number | null;
-    /** crop by width */
-    width?: number | null;
+interface UpdateDocumentResponse {
+    /** The created Document */
+    document?: Document;
 }
-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 DocumentRendered {
+    /** Rendered document */
+    document?: Document;
 }
-/** @enumType */
-type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
-interface SelectSetting {
-    /** Selected value */
-    value?: string | null;
+interface DocumentRenderFailed {
+    /** Document that failed to render */
+    document?: Document;
+}
+interface DownloadDocumentRequest {
     /**
-     * Color hex code
-     * @minLength 7
-     * @maxLength 7
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    primaryColor?: string | null;
+    documentId: string;
     /**
-     * Color hex code
-     * @minLength 7
-     * @maxLength 7
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
      */
-    secondaryColor?: string | null;
-    /** Size */
-    size?: number | null;
-}
-interface BackgroundSetting {
+    urlExpirationInSeconds?: number | null;
     /**
-     * Color of the background hex code
-     * @minLength 7
-     * @maxLength 9
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
      */
-    color?: string | null;
-    /** Wix media Image */
-    image?: string;
+    contentDisposition?: ContentDispositionWithLiterals;
 }
-interface SettingsGroup {
+declare enum ContentDisposition {
+    /** @internal */
+    UNKNOWN_CONTENT_DISPOSITION = "UNKNOWN_CONTENT_DISPOSITION",
+    /** 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 {
+    /**
+     * ID of the Document to retrieve
+     * @format GUID
+     */
+    documentId?: string | null;
+    /**
+     * ID of the Document to retrieve
+     * @minLength 1
+     * @maxLength 100
+     */
+    externalId?: string | null;
     /**
-     * Id of the control group
-     * @minLength 5
-     * @maxLength 50
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
      */
-    groupId?: string;
+    fileToken?: string | null;
     /**
-     * Display settings.
-     * @maxSize 20
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
      */
-    display?: Record<string, boolean>;
+    urlExpirationInSeconds?: number | null;
+    /** @maxLength 100 */
+    downloadButtonText?: string | null;
     /**
-     * Texts settings.
-     * @maxSize 20
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
      */
-    texts?: Record<string, TextSetting>;
+    contentDisposition?: ContentDispositionWithLiterals;
+}
+/** @oneof */
+interface GetDownloadUrlRequestDocumentOneOf {
     /**
-     * Images settings.
-     * @maxSize 10
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    images?: Record<string, ImageSetting>;
+    documentId?: string | null;
     /**
-     * Select option settings.
-     * @maxSize 20
+     * ID of the Document to retrieve
+     * @minLength 1
+     * @maxLength 100
      */
-    selects?: Record<string, SelectSetting>;
+    externalId?: string | null;
     /**
-     * Backgrounds settings.
-     * @maxSize 20
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
      */
-    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"
-}
-/** @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;
+    fileToken?: string | null;
 }
-interface RenderDocumentByIdRequest {
+interface GetDownloadUrlResponse {
+    /** Download URL. */
+    downloadUrl?: string | null;
+    /** URL expiration timestamp. Not provided for public documents because their links do not expire. */
+    expirationDate?: Date | null;
     /**
      * Document ID.
      * @format GUID
      */
     documentId?: string | null;
-    /** Output format, defaults to PDF. */
-    outputFormat?: RenderFormatWithLiterals;
+    /** Document render status. */
+    renderStatus?: RenderStatusWithLiterals;
+    /** Download URL. */
+    downloadPageUrl?: string | null;
+    /**
+     * Client defined content checksum. Can be used for content comparison.
+     * @minLength 1
+     * @maxLength 64
+     */
+    contentChecksum?: string | null;
+}
+interface DownloadDocumentSourceRequest {
+    /**
+     * ID of the Document to retrieve
+     * @format GUID
+     */
+    documentId: string;
+    /**
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
+     */
+    contentDisposition?: ContentDispositionWithLiterals;
+}
+interface DownloadDocumentSourceResponse {
+    /** Download URL. Expires after 10 minutes. */
+    downloadUrl?: string;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -561,468 +677,352 @@ interface ActionEvent {
 }
 interface Empty {
 }
-interface GetRendererInfoRequest {
-}
-interface GetRendererInfoResponse {
-    /** Renderer info */
-    info?: Record<string, string>;
-}
-interface GetCachedHtmlRequest {
-    /**
-     * Html Access Key.
-     * @maxLength 100
-     */
-    htmlAccessKey?: string;
-    /**
-     * Meta Site Id.
-     * @format GUID
-     */
-    metaSiteId?: string | null;
-}
-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 the Document to retrieve
-     * @format GUID
-     */
-    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 {
+interface MessageEnvelope {
     /**
-     * ID of the Document to delete
+     * App instance ID.
      * @format GUID
      */
-    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;
-    /**
-     * Filter object.
-     *
-     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object.
-     *
-     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
-     */
-    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 {
+    instanceId?: string | null;
     /**
-     * Name of the field to sort by.
-     * @maxLength 512
+     * Event type.
+     * @maxLength 150
      */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
-    /**
-     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
-     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
-     *
-     * If multiple filters are provided, they are combined with AND operator.
-     *
-     * Example:
-     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
-     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
-     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
-     * @internal
-     * @maxSize 10
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    selectItemsBy?: Record<string, any>[] | null;
+    anonymousVisitorId?: string;
     /**
-     * Origin point for geo-distance sorting on a GEO field
-     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    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 {
+    memberId?: string;
     /**
-     * Maximum number of items to return in the results.
-     * @max 100
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    limit?: number | null;
+    wixUserId?: string;
     /**
-     * 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
+     * ID of an app.
+     * @format GUID
      */
-    cursor?: string | null;
-}
-interface QueryDocumentResponse {
-    /** The retrieved Documents */
-    documents?: Document[];
-    /** Query results' metadata */
-    metadata?: PagingMetadataV2;
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
 }
-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;
+/** @oneof */
+interface IdentificationDataIdOneOf {
     /**
-     * Indicates if there are more results after the current page.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
-     * @internal
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    hasNext?: boolean | null;
-}
-interface Cursors {
+    anonymousVisitorId?: string;
     /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    next?: string | null;
+    memberId?: string;
     /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    prev?: string | null;
-}
-interface UpdateDocumentRequest {
+    wixUserId?: string;
     /**
-     * Document ID.
+     * ID of an app.
      * @format GUID
-     * @readonly
      */
-    _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;
+    appId?: string;
 }
-interface DocumentRenderFailed {
-    /** Document that failed to render */
-    document?: Document;
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
 }
-interface DownloadDocumentRequest {
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
     /**
-     * ID of the Document to retrieve
+     * ID of the Wix account associated with the event.
      * @format GUID
      */
-    documentId: string;
+    accountId?: string | null;
     /**
-     * URL expiration time. Only relevant for private documents.
-     * @min 600
-     * @max 86400
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
      */
-    urlExpirationInSeconds?: number | null;
+    parentAccountId?: string | null;
     /**
-     * Whether the link downloads the file or opens the file in the browser.
-     * Default: `ATTACHMENT`
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
      */
-    contentDisposition?: ContentDispositionWithLiterals;
+    siteId?: string | null;
 }
-declare enum ContentDisposition {
-    /** @internal */
-    UNKNOWN_CONTENT_DISPOSITION = "UNKNOWN_CONTENT_DISPOSITION",
-    /** The link downloads the file. */
-    ATTACHMENT = "ATTACHMENT",
-    /** The link opens the file in the browser. */
-    INLINE = "INLINE"
+interface GetDownloadPageRequest {
+    /** @maxLength 1000 */
+    file: string | null;
 }
-/** @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 RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
 }
-interface GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
+interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+interface RedirectToDocumentRequest {
+    /** @maxLength 1000 */
+    file: string | null;
+}
+interface RenderDocumentRequest {
+    /** Template settings. */
+    templateSettings?: TemplateSettings;
+    /** Document content. */
+    content?: DocumentContent;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormatWithLiterals;
     /**
-     * ID of the Document to retrieve
+     * 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 TemplateSettings {
+    /**
+     * Auto generated ID.
      * @format GUID
+     * @readonly
      */
-    documentId?: string | null;
+    _id?: string | null;
     /**
-     * ID of the Document to retrieve
+     * Wix app definition ID.
      * @minLength 1
-     * @maxLength 100
+     * @maxLength 20
      */
-    externalId?: string | null;
+    appSlug?: string | null;
     /**
-     * Signed file token
+     * The type of the template.
      * @minLength 1
-     * @maxLength 500
+     * @maxLength 20
      */
-    fileToken?: string | null;
+    templateType?: string | null;
     /**
-     * URL expiration time. Only relevant for private documents.
-     * @min 600
-     * @max 86400
+     * The id of the template.
+     * @minLength 1
+     * @maxLength 20
      */
-    urlExpirationInSeconds?: number | null;
-    /** @maxLength 100 */
-    downloadButtonText?: string | null;
+    templateId?: string | null;
     /**
-     * Whether the link downloads the file or opens the file in the browser.
-     * Default: `ATTACHMENT`
+     * 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
      */
-    contentDisposition?: ContentDispositionWithLiterals;
-}
-/** @oneof */
-interface GetDownloadUrlRequestDocumentOneOf {
+    externalId?: string | null;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Date settings were created.
+     * @readonly
      */
-    documentId?: string | null;
+    _createdDate?: Date | null;
+    /**
+     * Date settings were updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** @maxSize 10 */
+    settingGroups?: SettingsGroup[];
+    /** Paper size */
+    paperSize?: PaperSizeWithLiterals;
+    pageOverflow?: PageOverflowWithLiterals;
+}
+interface TextSetting {
     /**
-     * ID of the Document to retrieve
-     * @minLength 1
-     * @maxLength 100
+     * Font family class name
+     * @maxLength 20
      */
-    externalId?: string | null;
+    fontFamily?: string | null;
     /**
-     * Signed file token
-     * @minLength 1
-     * @maxLength 500
+     * Font style class names
+     * @maxSize 10
+     * @maxLength 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;
+    fontStyle?: string[];
     /**
-     * Document ID.
-     * @format GUID
+     * Text alignment class name
+     * @maxLength 20
      */
-    documentId?: string | null;
-    /** Document render status. */
-    renderStatus?: RenderStatusWithLiterals;
-    /** Download URL. */
-    downloadPageUrl?: string | null;
+    textAlignment?: string | null;
     /**
-     * Client defined content checksum. Can be used for content comparison.
-     * @minLength 1
-     * @maxLength 64
+     * Text color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    contentChecksum?: string | null;
-}
-interface DownloadDocumentSourceRequest {
+    textColor?: string | null;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Font size
+     * @min 1
      */
-    documentId: string;
+    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;
+    _id?: string;
+    /** @maxLength 500 */
+    value?: string | null;
+    visible?: boolean;
 }
-interface DownloadDocumentSourceResponse {
-    /** Download URL. Expires after 10 minutes. */
-    downloadUrl?: string;
+interface ImageSetting {
+    /** Wix media Image */
+    image?: string;
+    /** Image resizing mode */
+    resize?: ResizeOptionWithLiterals;
 }
-interface MessageEnvelope {
+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;
     /**
-     * App instance ID.
-     * @format GUID
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    instanceId?: string | null;
+    primaryColor?: string | null;
     /**
-     * Event type.
-     * @maxLength 150
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-    /** Details related to the account */
-    accountInfo?: AccountInfo;
+    secondaryColor?: string | null;
+    /** Size */
+    size?: number | null;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
+interface BackgroundSetting {
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * Color of the background hex code
+     * @minLength 7
+     * @maxLength 9
      */
-    memberId?: string;
+    color?: string | null;
+    /** Wix media Image */
+    image?: string;
+}
+interface SettingsGroup {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * Id of the control group
+     * @minLength 5
+     * @maxLength 50
      */
-    wixUserId?: string;
+    groupId?: string;
     /**
-     * ID of an app.
-     * @format GUID
+     * Display settings.
+     * @maxSize 20
      */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-interface IdentificationDataIdOneOf {
+    display?: Record<string, boolean>;
     /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
+     * Texts settings.
+     * @maxSize 20
      */
-    anonymousVisitorId?: string;
+    texts?: Record<string, TextSetting>;
     /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
+     * Images settings.
+     * @maxSize 10
      */
-    memberId?: string;
+    images?: Record<string, ImageSetting>;
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * Select option settings.
+     * @maxSize 20
      */
-    wixUserId?: string;
+    selects?: Record<string, SelectSetting>;
     /**
-     * ID of an app.
-     * @format GUID
+     * Backgrounds settings.
+     * @maxSize 20
      */
-    appId?: string;
+    backgrounds?: Record<string, BackgroundSetting>;
 }
-declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
+declare enum PaperSize {
+    A4_PORTRAIT = "A4_PORTRAIT",
+    A4_LANDSCAPE = "A4_LANDSCAPE"
 }
 /** @enumType */
-type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-interface AccountInfo {
+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 RenderDocumentByIdRequest {
     /**
-     * ID of the Wix account associated with the event.
+     * Document ID.
      * @format GUID
      */
-    accountId?: string | null;
+    documentId?: string | null;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormatWithLiterals;
+}
+interface GetRendererInfoRequest {
+}
+interface GetRendererInfoResponse {
+    /** Renderer info */
+    info?: Record<string, string>;
+}
+interface GetCachedHtmlRequest {
     /**
-     * ID of the parent Wix account. Only included when accountId belongs to a child account.
-     * @format GUID
+     * Html Access Key.
+     * @maxLength 100
      */
-    parentAccountId?: string | null;
+    htmlAccessKey?: string;
     /**
-     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * Meta Site Id.
      * @format GUID
      */
-    siteId?: string | null;
+    metaSiteId?: string | null;
 }
 /** @docsIgnore */
 type DownloadDocumentApplicationErrors = {
@@ -1266,22 +1266,6 @@ interface DocumentUpdatedEnvelope {
  * @slug updated
  */
 declare function onDocumentUpdated(handler: (event: DocumentUpdatedEnvelope) => void | Promise<void>): void;
-/**
- * Get Document.
- * @public
- * @requiredField file
- * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
- * @fqn wix.papyrus.v1.DownloadPageController.GetDownloadPage
- */
-declare function getDownloadPage(file: string | null): Promise<RawHttpResponse>;
-/**
- * Get Document.
- * @public
- * @requiredField file
- * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
- * @fqn wix.papyrus.v1.DownloadPageController.RedirectToDocument
- */
-declare function redirectToDocument(file: string | null): Promise<RawHttpResponse>;
 /**
  * Creates a new Document
  * @public
@@ -1554,5 +1538,21 @@ interface DownloadDocumentSourceOptions {
      */
     contentDisposition?: ContentDispositionWithLiterals;
 }
+/**
+ * Get Document.
+ * @public
+ * @requiredField file
+ * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
+ * @fqn wix.papyrus.v1.DownloadPageController.GetDownloadPage
+ */
+declare function getDownloadPage(file: string | null): Promise<RawHttpResponse>;
+/**
+ * Get Document.
+ * @public
+ * @requiredField file
+ * @permissionId PAPYRUS.DOWNLOAD_DOCUMENT
+ * @fqn wix.papyrus.v1.DownloadPageController.RedirectToDocument
+ */
+declare function redirectToDocument(file: string | null): Promise<RawHttpResponse>;
 
 export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type BackgroundSetting, type BaseEventMetadata, type CommonQueryWithEntityContext, ContentDisposition, type ContentDispositionWithLiterals, type CreateDocumentOptions, type CreateDocumentRequest, type CreateDocumentResponse, type CursorPaging, type Cursors, type DebugOptions, type DeleteDocumentByExternalIdRequest, type DeleteDocumentByExternalIdResponse, type DeleteDocumentRequest, type DeleteDocumentResponse, type Document, type DocumentContent, type DocumentCreatedEnvelope, type DocumentDeletedEnvelope, type DocumentFile, type DocumentQuery, type DocumentQuerySpec, type DocumentRenderDelayed, type DocumentRenderDelayedEnvelope, type DocumentRenderFailed, type DocumentRenderFailedEnvelope, type DocumentRendered, type DocumentRenderedEnvelope, type DocumentUpdatedEnvelope, type DocumentsQueryBuilder, type DocumentsQueryResult, type DomainEvent, type DomainEventBodyOneOf, type DownloadDocumentApplicationErrors, type DownloadDocumentOptions, type DownloadDocumentRequest, type DownloadDocumentResponse, type DownloadDocumentSourceApplicationErrors, type DownloadDocumentSourceOptions, type DownloadDocumentSourceRequest, type DownloadDocumentSourceResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FocalPoint, Format, type FormatWithLiterals, type GetCachedHtmlRequest, type GetDocumentOptions, type GetDocumentRequest, type GetDocumentResponse, type GetDownloadPageRequest, type GetDownloadUrlOptions, type GetDownloadUrlOptionsDocumentOneOf, type GetDownloadUrlRequest, type GetDownloadUrlRequestDocumentOneOf, type GetDownloadUrlResponse, type GetRendererInfoRequest, type GetRendererInfoResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ImageSetting, type MessageEnvelope, PageOverflow, type PageOverflowWithLiterals, type PageSettings, type Paging, type PagingMetadataV2, PaperSize, type PaperSizeWithLiterals, type QueryDocumentOptions, type QueryDocumentRequest, type QueryDocumentResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RawHttpResponse, type RedirectToDocumentRequest, type RenderDelayedEventConfig, type RenderDocumentByIdRequest, type RenderDocumentRequest, RenderFormat, type RenderFormatWithLiterals, RenderStatus, type RenderStatusWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, ResizeOption, type ResizeOptionWithLiterals, type RestoreInfo, type SelectSetting, type SettingsGroup, SortOrder, type SortOrderWithLiterals, type Sorting, type TemplateSettings, type TemplateSettingsOverride, type TextContent, type TextSetting, type UpdateDocumentOptions, type UpdateDocumentRequest, type UpdateDocumentResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WixMpClientVersion, type WixMpClientVersionWithLiterals, createDocument, deleteDocument, downloadDocument, downloadDocumentSource, getDocument, getDownloadPage, getDownloadUrl, onDocumentCreated, onDocumentDeleted, onDocumentRenderDelayed, onDocumentRenderFailed, onDocumentRendered, onDocumentUpdated, queryDocument, redirectToDocument, typedQueryDocument, updateDocument, utils };