@wix/auto_sdk_papyrus_documents 1.0.0

package/build/internal/cjs/meta.d.ts

@@ -0,0 +1,1030 @@
+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.js';
+import '@wix/sdk-types';
+
+/** Document is the main entity of DocumentService. */
+interface Document {
+    /**
+     * Document ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Represents the time this Document was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Represents the time this Document was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Document render status.
+     * @readonly
+     */
+    renderStatus?: RenderStatusWithLiterals;
+    /**
+     * URL to download document. Returned only when Document is in `READY` state.
+     * @format WEB_URL
+     * @readonly
+     */
+    downloadUrl?: string | null;
+    /**
+     * Template ID. When this parameter used the document will be rendered with this template default settings
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     */
+    templateId?: string | null;
+    /**
+     * Unique per tenant external ID, for example order number. Used to retrieve Document later.
+     * @minLength 1
+     * @maxLength 100
+     * @immutable
+     */
+    externalId?: string | null;
+    /**
+     * Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings.
+     * @maxLength 100
+     * @immutable
+     */
+    templateSettingsExternalId?: string | null;
+    /**
+     * Template settings ID.
+     * @format GUID
+     * @immutable
+     */
+    templateSettingsId?: string | null;
+    /**
+     * The app slug of the template
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     */
+    appSlug?: string | null;
+    /**
+     * The type of the template.
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     */
+    templateType?: string | null;
+    /**
+     * Document content that is injected into template.
+     * @immutable
+     */
+    content?: DocumentContent;
+    /**
+     * Number of hours after which document will be eventually expired and its content erased.
+     * @min 1
+     * @max 43800
+     * @immutable
+     */
+    expiresInHours?: number;
+    /**
+     * Represents the time this document becomes expired.
+     * @readonly
+     */
+    expirationDate?: Date | null;
+    /**
+     * Document format. Defaults to `PDF`.
+     * @immutable
+     */
+    format?: FormatWithLiterals;
+    /**
+     * Whether the link to the uploaded document is public or private.
+     * For public document static URL will be returned.
+     * For private document temporary URL will be generated by DocumentService.DownloadDocument.
+     * @immutable
+     */
+    public?: boolean | null;
+    /**
+     * Optional filename (without extension) to be used for the downloadable document.
+     * @minLength 1
+     * @maxLength 50
+     */
+    fileName?: string | null;
+    /**
+     * Client defined content checksum. Can be used for content comparison.
+     * @minLength 1
+     * @maxLength 64
+     * @immutable
+     */
+    contentChecksum?: string | null;
+    /** Rendering notification config. */
+    renderDelayedEventConfig?: RenderDelayedEventConfig;
+    /**
+     * Size in bytes of a rendered document. Returned only when Document is in `READY` state.
+     * @readonly
+     */
+    sizeInBytes?: number | null;
+}
+declare enum RenderStatus {
+    UNKNOWN = "UNKNOWN",
+    /** Document was accepted and is waiting to be rendered. */
+    ACCEPTED = "ACCEPTED",
+    /** Rendering is in progress. */
+    RENDERING = "RENDERING",
+    /** Rendering finished successfully and document is ready to download. */
+    READY = "READY",
+    /** Rendering failed. */
+    FAILED = "FAILED",
+    /** Rendered document expired and is no longer available for download. */
+    EXPIRED = "EXPIRED"
+}
+/** @enumType */
+type RenderStatusWithLiterals = RenderStatus | 'UNKNOWN' | 'ACCEPTED' | 'RENDERING' | 'READY' | 'FAILED' | 'EXPIRED';
+interface DocumentContent {
+    /**
+     * Document pages. Each page is reference as $page.
+     * @minSize 1
+     * @maxSize 100
+     */
+    pages?: Record<string, any>[] | null;
+    /** Other document content referenced by $content variable */
+    content?: Record<string, any> | null;
+    /**
+     * ISO 639-1 language code of content (used in translations).
+     * @format LANGUAGE
+     */
+    language?: string;
+    /**
+     * e.g. en-US.
+     * @minLength 2
+     * @maxLength 35
+     */
+    locale?: string | null;
+}
+declare enum Format {
+    UNKNOWN = "UNKNOWN",
+    PDF = "PDF"
+}
+/** @enumType */
+type FormatWithLiterals = Format | 'UNKNOWN' | 'PDF';
+interface TemplateSettingsOverride {
+    /**
+     * Indices (0-based) of pages with template settings override.
+     * @max 99
+     */
+    pageIndices?: number[];
+    /**
+     * Template settings ID.
+     * @format GUID
+     */
+    templateSettingsId?: string | null;
+    /**
+     * Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings.
+     * @maxLength 100
+     */
+    templateSettingsExternalId?: string | null;
+    /**
+     * Template ID. When this parameter used the page will be rendered with this template default settings
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     */
+    templateId?: string | null;
+}
+interface PageSettings {
+    /**
+     * Indices (0-based) of pages with template settings override.
+     * @max 99
+     */
+    pageIndices?: number[];
+    /**
+     * Template settings ID.
+     * @format GUID
+     */
+    templateSettingsId?: string | null;
+    /**
+     * Unique per tenant template external ID, for example ticket definition ID. Used to lookup corresponding template & template settings.
+     * @maxLength 100
+     */
+    templateSettingsExternalId?: string | null;
+    /**
+     * Template ID. When this parameter used the page will be rendered with this template default settings
+     * @minLength 1
+     * @maxLength 20
+     * @immutable
+     */
+    templateId?: string | null;
+}
+declare enum WixMpClientVersion {
+    UNKNOWN = "UNKNOWN",
+    MP_V1 = "MP_V1",
+    MP_V2 = "MP_V2"
+}
+/** @enumType */
+type WixMpClientVersionWithLiterals = WixMpClientVersion | 'UNKNOWN' | 'MP_V1' | 'MP_V2';
+interface RenderDelayedEventConfig {
+    /**
+     * Controls DocumentRenderDelayed action event sending.
+     * Event will be sent after time_in_queue_minutes if document render status is ACCEPTED/RENDERING.
+     * @min 5
+     * @max 120
+     * @immutable
+     */
+    timeInQueueMinutes?: number;
+}
+interface DebugOptions {
+    /**
+     * Overrides statics for this document during the rendering
+     * @maxLength 60
+     * @immutable
+     */
+    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;
+    /**
+     * Overrides static versions for the statics config.
+     * @maxSize 10
+     */
+    staticOverrides?: Record<string, string>;
+}
+interface TemplateSettings {
+    /**
+     * Auto generated ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Wix app definition ID.
+     * @minLength 1
+     * @maxLength 20
+     */
+    appSlug?: string | null;
+    /**
+     * The type of the template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateType?: string | null;
+    /**
+     * The id of the template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateId?: string | null;
+    /**
+     * Template settings external ID. For example ticket definition ID.
+     * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
+     * @minLength 1
+     * @maxLength 100
+     */
+    externalId?: string | null;
+    /**
+     * Date settings were created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date settings were updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** @maxSize 10 */
+    settingGroups?: SettingsGroup[];
+    /** Paper size */
+    paperSize?: PaperSizeWithLiterals;
+    pageOverflow?: PageOverflowWithLiterals;
+}
+interface TextSetting {
+    /**
+     * Font family class name
+     * @maxLength 20
+     */
+    fontFamily?: string | null;
+    /**
+     * Font style class names
+     * @maxSize 10
+     * @maxLength 20
+     */
+    fontStyle?: string[];
+    /**
+     * Text alignment class name
+     * @maxLength 20
+     */
+    textAlignment?: string | null;
+    /**
+     * Text color hex code
+     * @minLength 7
+     * @maxLength 7
+     */
+    textColor?: string | null;
+    /**
+     * Font size
+     * @min 1
+     */
+    fontSize?: number | null;
+    /** Text content setting */
+    textContent?: TextContent[];
+}
+interface TextContent {
+    /**
+     * @minLength 3
+     * @maxLength 50
+     */
+    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;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    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;
+    /**
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
+     */
+    primaryColor?: string | null;
+    /**
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
+     */
+    secondaryColor?: string | null;
+    /** Size */
+    size?: number | null;
+}
+interface BackgroundSetting {
+    /**
+     * Color of the background hex code
+     * @minLength 7
+     * @maxLength 9
+     */
+    color?: string | null;
+    /** Wix media Image */
+    image?: Image;
+}
+interface SettingsGroup {
+    /**
+     * Id of the control group
+     * @minLength 5
+     * @maxLength 50
+     */
+    groupId?: string;
+    /**
+     * Display settings.
+     * @maxSize 20
+     */
+    display?: Record<string, boolean>;
+    /**
+     * Texts settings.
+     * @maxSize 20
+     */
+    texts?: Record<string, TextSetting>;
+    /**
+     * Images settings.
+     * @maxSize 10
+     */
+    images?: Record<string, ImageSetting>;
+    /**
+     * Select option settings.
+     * @maxSize 20
+     */
+    selects?: Record<string, SelectSetting>;
+    /**
+     * Backgrounds settings.
+     * @maxSize 20
+     */
+    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;
+}
+interface RenderDocumentByIdRequest {
+    /**
+     * Document ID.
+     * @format GUID
+     */
+    documentId?: string | null;
+    /** Output format, defaults to PDF. */
+    outputFormat?: RenderFormatWithLiterals;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+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 {
+    /**
+     * ID of the Document to delete
+     * @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 {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryDocumentResponse {
+    /** The retrieved Documents */
+    documents?: Document[];
+    /** Query results' metadata */
+    metadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface UpdateDocumentRequest {
+    /**
+     * Document ID.
+     * @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;
+}
+interface DocumentRenderFailed {
+    /** Document that failed to render */
+    document?: Document;
+}
+interface DownloadDocumentRequest {
+    /**
+     * ID of the Document to retrieve
+     * @format GUID
+     */
+    documentId: string;
+    /**
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
+     */
+    urlExpirationInSeconds?: number | null;
+    /**
+     * Whether the link downloads the file or opens the file in the browser.
+     * Default: `ATTACHMENT`
+     */
+    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 {
+    /**
+     * ID of the Document to retrieve
+     * @format GUID
+     */
+    documentId?: string | null;
+    /**
+     * ID of the Document to retrieve
+     * @minLength 1
+     * @maxLength 100
+     */
+    externalId?: string | null;
+    /**
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
+     */
+    fileToken?: string | null;
+    /**
+     * URL expiration time. Only relevant for private documents.
+     * @min 600
+     * @max 86400
+     */
+    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;
+}
+/** @oneof */
+interface 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;
+    /**
+     * Signed file token
+     * @minLength 1
+     * @maxLength 500
+     */
+    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;
+    /**
+     * Document ID.
+     * @format GUID
+     */
+    documentId?: string | null;
+    /** 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 MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** 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
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type DownloadDocumentApplicationErrors = {
+    code?: 'DOCUMENT_NOT_READY';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type DownloadDocumentSourceApplicationErrors = {
+    code?: 'DOCUMENT_NOT_READY';
+    description?: string;
+    data?: Record<string, any>;
+};
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __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;
+}, GetDocumentRequest$1, GetDocumentRequest, GetDocumentResponse$1, GetDocumentResponse>;
+declare function deleteDocument(): __PublicMethodMetaInfo<'DELETE', {
+    documentId: string;
+}, DeleteDocumentRequest$1, DeleteDocumentRequest, DeleteDocumentResponse$1, DeleteDocumentResponse>;
+declare function queryDocument(): __PublicMethodMetaInfo<'POST', {}, QueryDocumentRequest$1, QueryDocumentRequest, QueryDocumentResponse$1, QueryDocumentResponse>;
+declare function updateDocument(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, UpdateDocumentRequest$1, UpdateDocumentRequest, UpdateDocumentResponse$1, UpdateDocumentResponse>;
+declare function downloadDocument(): __PublicMethodMetaInfo<'GET', {
+    documentId: string;
+}, DownloadDocumentRequest$1, DownloadDocumentRequest, DownloadDocumentResponse$1, DownloadDocumentResponse>;
+declare function getDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetDownloadUrlRequest$1, GetDownloadUrlRequest, GetDownloadUrlResponse$1, GetDownloadUrlResponse>;
+declare function downloadDocumentSource(): __PublicMethodMetaInfo<'GET', {
+    documentId: string;
+}, DownloadDocumentSourceRequest$1, DownloadDocumentSourceRequest, DownloadDocumentSourceResponse$1, DownloadDocumentSourceResponse>;
+
+export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, 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 };