boldsign/dist/model/documentSignerDetails.d.ts

NodeJS client for boldsign

import { DocumentFormFields } from './documentFormFields';
import { IdVerificationDetails } from './idVerificationDetails';
import { PhoneNumber } from './phoneNumber';
import { RecipientNotificationSettings } from './recipientNotificationSettings';
import { SignerAuthenticationSettings } from './signerAuthenticationSettings';
export declare class DocumentSignerDetails {
    'id'?: string | null;
    'signerName'?: string | null;
    'signerRole'?: string | null;
    'signerEmail'?: string | null;
    'status'?: DocumentSignerDetails.StatusEnum;
    'enableAccessCode'?: boolean;
    'isAuthenticationFailed'?: boolean | null;
    'enableEmailOTP'?: boolean;
    'authenticationType'?: DocumentSignerDetails.AuthenticationTypeEnum;
    'isDeliveryFailed'?: boolean;
    'isViewed'?: boolean;
    'order'?: number;
    'signerType'?: DocumentSignerDetails.SignerTypeEnum;
    'hostEmail'?: string | null;
    'hostName'?: string | null;
    'isReassigned'?: boolean;
    'privateMessage'?: string | null;
    'allowFieldConfiguration'?: boolean;
    'formFields'?: Array<DocumentFormFields> | null;
    'language'?: DocumentSignerDetails.LanguageEnum;
    'locale'?: DocumentSignerDetails.LocaleEnum;
    'phoneNumber'?: PhoneNumber;
    'idVerification'?: IdVerificationDetails;
    'recipientNotificationSettings'?: RecipientNotificationSettings;
    'authenticationRetryCount'?: number | null;
    'enableQes'?: boolean | null;
    'deliveryMode'?: DocumentSignerDetails.DeliveryModeEnum;
    'authenticationSettings'?: SignerAuthenticationSettings;
    static discriminator: string | undefined;
    static attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
    }[];
}
export declare namespace DocumentSignerDetails {
    enum StatusEnum {
        None,
        NotCompleted,
        Completed,
        Declined,
        Revoked,
        Expired
    }
    enum AuthenticationTypeEnum {
        None,
        EmailOtp,
        AccessCode,
        Smsotp,
        IdVerification
    }
    enum SignerTypeEnum {
        Signer,
        Reviewer,
        InPersonSigner
    }
    enum LanguageEnum {
        NUMBER_0,
        NUMBER_1,
        NUMBER_2,
        NUMBER_3,
        NUMBER_4,
        NUMBER_5,
        NUMBER_6,
        NUMBER_7,
        NUMBER_8,
        NUMBER_9,
        NUMBER_10,
        NUMBER_11,
        NUMBER_12,
        NUMBER_13,
        NUMBER_14,
        NUMBER_15,
        NUMBER_16,
        NUMBER_17,
        NUMBER_18,
        NUMBER_19,
        NUMBER_20
    }
    enum LocaleEnum {
        En,
        No,
        Fr,
        De,
        Es,
        Bg,
        Cs,
        Da,
        It,
        Nl,
        Pl,
        Pt,
        Ro,
        Ru,
        Sv,
        Default,
        Ja,
        Th,
        ZhCn,
        ZhTw,
        Ko
    }
    enum DeliveryModeEnum {
        Email,
        Sms,
        EmailAndSms,
        WhatsApp
    }
}