@wix/auto_sdk_papyrus_documents 1.0.2 → 1.0.3

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

@@ -235,328 +235,235 @@ 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;
+    _id?: string;
+    /** @maxLength 500 */
+    value?: string | null;
+    visible?: boolean;
 }
-declare enum ContentDisposition {
-    /** The link downloads the file. */
-    ATTACHMENT = "ATTACHMENT",
-    /** The link opens the file in the browser. */
-    INLINE = "INLINE"
+interface ImageSetting {
+    /** Wix media Image */
+    image?: string;
+    /** Image resizing mode */
+    resize?: ResizeOptionWithLiterals;
+}
+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;
 }
-/** @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;
+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 GetDownloadUrlRequest extends GetDownloadUrlRequestDocumentOneOf {
-    /**
-     * ID of the Document to retrieve
-     * @format GUID
-     */
-    documentId?: string | null;
+/** @enumType */
+type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
+interface SelectSetting {
+    /** Selected value */
+    value?: string | null;
     /**
-     * ID of the Document to retrieve
-     * @minLength 1
-     * @maxLength 100
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    externalId?: string | null;
+    primaryColor?: string | null;
     /**
-     * Signed file token
-     * @minLength 1
-     * @maxLength 500
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
      */
-    fileToken?: string | null;
+    secondaryColor?: string | null;
+    /** Size */
+    size?: number | null;
+}
+interface BackgroundSetting {
     /**
-     * URL expiration time. Only relevant for private documents.
-     * @min 600
-     * @max 86400
+     * Color of the background hex code
+     * @minLength 7
+     * @maxLength 9
      */
-    urlExpirationInSeconds?: number | null;
-    /** @maxLength 100 */
-    downloadButtonText?: string | null;
+    color?: string | null;
+    /** Wix media Image */
+    image?: string;
+}
+interface SettingsGroup {
     /**
-     * Whether the link downloads the file or opens the file in the browser.
-     * Default: `ATTACHMENT`
+     * Id of the control group
+     * @minLength 5
+     * @maxLength 50
      */
-    contentDisposition?: ContentDispositionWithLiterals;
-}
-/** @oneof */
-interface GetDownloadUrlRequestDocumentOneOf {
+    groupId?: string;
     /**
-     * ID of the Document to retrieve
-     * @format GUID
+     * Display settings.
+     * @maxSize 20
      */
-    documentId?: string | null;
+    display?: Record<string, boolean>;
     /**
-     * ID of the Document to retrieve
-     * @minLength 1
-     * @maxLength 100
+     * Texts settings.
+     * @maxSize 20
      */
-    externalId?: string | null;
+    texts?: Record<string, TextSetting>;
     /**
-     * Signed file token
-     * @minLength 1
-     * @maxLength 500
+     * Images settings.
+     * @maxSize 10
      */
-    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;
+    images?: Record<string, ImageSetting>;
     /**
-     * Document ID.
-     * @format GUID
+     * Select option settings.
+     * @maxSize 20
      */
-    documentId?: string | null;
-    /** Document render status. */
-    renderStatus?: RenderStatusWithLiterals;
-    /** Download URL. */
-    downloadPageUrl?: string | null;
+    selects?: Record<string, SelectSetting>;
     /**
-     * Client defined content checksum. Can be used for content comparison.
-     * @minLength 1
-     * @maxLength 64
+     * Backgrounds settings.
+     * @maxSize 20
      */
-    contentChecksum?: string | null;
+    backgrounds?: Record<string, BackgroundSetting>;
 }
-interface DownloadDocumentSourceRequest {
+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 {
     /**
-     * ID of the Document to retrieve
+     * Document ID.
      * @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;
+    documentId?: string | null;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormatWithLiterals;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -622,352 +529,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 {
     /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
+     * 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).
      */
-    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
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
      */
-    _createdDate?: Date | null;
+    fileToken?: string | null;
     /**
-     * Date settings were updated.
-     * @readonly
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
      */
-    _updatedDate?: Date | null;
-    /** @maxSize 10 */
-    settingGroups?: SettingsGroup[];
-    /** Paper size */
-    paperSize?: PaperSizeWithLiterals;
-    pageOverflow?: PageOverflowWithLiterals;
+    urlExpirationInSeconds?: number | null;
+    /** @maxLength 100 */
+    downloadButtonText?: string | null;
+    /**
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
+     */
+    contentDisposition?: ContentDispositionWithLiterals;
 }
-interface TextSetting {
+/** @oneof */
+interface GetDownloadUrlRequestDocumentOneOf {
     /**
-     * Font family class name
-     * @maxLength 20
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    fontFamily?: string | null;
+    documentId?: string | null;
     /**
-     * Font style class names
-     * @maxSize 10
-     * @maxLength 20
+     * ID of the Document to retrieve
+     * @minLength 1
+     * @maxLength 100
      */
-    fontStyle?: string[];
+    externalId?: string | null;
     /**
-     * Text alignment class name
-     * @maxLength 20
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
      */
-    textAlignment?: string | null;
+    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;
     /**
-     * Text color hex code
-     * @minLength 7
-     * @maxLength 7
+     * Document ID.
+     * @format GUID
      */
-    textColor?: string | null;
+    documentId?: string | null;
+    /** Document render status. */
+    renderStatus?: RenderStatusWithLiterals;
+    /** Download URL. */
+    downloadPageUrl?: string | null;
     /**
-     * Font size
-     * @min 1
+     * Client defined content checksum. Can be used for content comparison.
+     * @minLength 1
+     * @maxLength 64
      */
-    fontSize?: number | null;
-    /** Text content setting */
-    textContent?: TextContent[];
+    contentChecksum?: string | null;
 }
-interface TextContent {
+interface DownloadDocumentSourceRequest {
     /**
-     * @minLength 3
-     * @maxLength 50
+     * ID of the Document to retrieve
+     * @format GUID
      */
-    _id?: string;
-    /** @maxLength 500 */
-    value?: string | null;
-    visible?: boolean;
-}
-interface ImageSetting {
-    /** Wix media Image */
-    image?: string;
-    /** Image resizing mode */
-    resize?: ResizeOptionWithLiterals;
-}
-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;
+    documentId: string;
+    /**
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
+     */
+    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?: string;
-}
-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 = {
@@ -1211,6 +1211,22 @@ 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
@@ -1469,21 +1485,5 @@ 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 };