boldsign/dist/model/embeddedDocumentRequest.d.ts

NodeJS client for boldsign

import { RequestFile } from './models';
import { DocumentCC } from './documentCC';
import { DocumentInfo } from './documentInfo';
import { DocumentSigner } from './documentSigner';
import { FormGroup } from './formGroup';
import { RecipientNotificationSettings } from './recipientNotificationSettings';
import { ReminderSettings } from './reminderSettings';
import { TextTagDefinition } from './textTagDefinition';
export declare class EmbeddedDocumentRequest {
    'redirectUrl'?: string | null;
    'showToolbar'?: boolean;
    'sendViewOption'?: EmbeddedDocumentRequest.SendViewOptionEnum;
    'showSaveButton'?: boolean;
    'locale'?: EmbeddedDocumentRequest.LocaleEnum;
    'showSendButton'?: boolean;
    'showPreviewButton'?: boolean;
    'showNavigationButtons'?: boolean;
    'showTooltip'?: boolean;
    'embeddedSendLinkValidTill'?: Date | null;
    'files'?: Array<RequestFile> | null;
    'title'?: string | null;
    'message'?: string | null;
    'signers'?: Array<DocumentSigner> | null;
    'cc'?: Array<DocumentCC> | null;
    'enableSigningOrder'?: boolean;
    'expiryDays'?: number;
    'expiryDateType'?: EmbeddedDocumentRequest.ExpiryDateTypeEnum;
    'expiryValue'?: number;
    'reminderSettings'?: ReminderSettings;
    'enableEmbeddedSigning'?: boolean;
    'disableEmails'?: boolean;
    'disableSMS'?: boolean;
    'brandId'?: string | null;
    'hideDocumentId'?: boolean | null;
    'labels'?: Array<string> | null;
    'fileUrls'?: Array<string> | null;
    'sendLinkValidTill'?: Date | null;
    'useTextTags'?: boolean;
    'textTagDefinitions'?: Array<TextTagDefinition> | null;
    'enablePrintAndSign'?: boolean;
    'enableReassign'?: boolean;
    'disableExpiryAlert'?: boolean | null;
    'documentInfo'?: Array<DocumentInfo> | null;
    'onBehalfOf'?: string | null;
    'autoDetectFields'?: boolean;
    'documentDownloadOption'?: EmbeddedDocumentRequest.DocumentDownloadOptionEnum;
    'isSandbox'?: boolean | null;
    'metaData'?: {
        [key: string]: string | null;
    } | null;
    'formGroups'?: Array<FormGroup> | null;
    'recipientNotificationSettings'?: RecipientNotificationSettings;
    'enableAuditTrailLocalization'?: boolean | null;
    'downloadFileName'?: string | null;
    'scheduledSendTime'?: number | null;
    'allowScheduledSend'?: boolean;
    'allowedSignatureTypes'?: Array<EmbeddedDocumentRequest.AllowedSignatureTypesEnum>;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export declare namespace EmbeddedDocumentRequest {
    enum SendViewOptionEnum {
        PreparePage,
        FillingPage
    }
    enum LocaleEnum {
        En,
        No,
        Fr,
        De,
        Es,
        Bg,
        Cs,
        Da,
        It,
        Nl,
        Pl,
        Pt,
        Ro,
        Ru,
        Sv,
        Default,
        Ja,
        Th,
        ZhCn,
        ZhTw,
        Ko
    }
    enum ExpiryDateTypeEnum {
        Days,
        Hours,
        SpecificDateTime
    }
    enum DocumentDownloadOptionEnum {
        Combined,
        Individually
    }
    enum AllowedSignatureTypesEnum {
        Text,
        Draw,
        Image
    }
}