@springtree/eva-core/EVA.DocumentSigning.d.ts

The EVA core typings

declare module EVA.DocumentSigning {

  export interface CompleteSignDocumentTask {
    TaskID: number;
    Location?: string;
    Signatures: Signature[];
  }

  export interface Signature {
    Description: string;
    SignatureData: number[];
    SignatureHash: string;
    SignatureText: string;
  }

  /**
   * Get the signature for an Order
   */
  export interface GetOrderSignature {
    OrderID: number;
  }

  /**
   * Fetch the data to embed in the QrCode for the signing app
   */
  export interface GetSigningCodeForOrder {
    OrderID: number;
  }

  export interface GetSigningCodeForOrderResponse {
    Code: string;
    IsAlreadySigned: boolean;
    Error: EVA.Core.ServiceError;
  }

  /**
   * Fetch the data to display in the signing app. The provided hash is embedded in the Code.
   */
  export interface GetSigningDataForOrder {
    Hash: string;
  }

  export interface GetSigningDataForOrderResponse {
    OrderID: number;
    CustomerReference: string;
    CreationTime?: string;
    ShippingAddress: EVA.Core.AddressDto;
    CustomerName: string;
    CustomerPhonenumber: string;
    CustomerEmailAddress: string;
    ItemCount: number;
    TotalAmount?: number;
    TotalAmountInTax?: number;
    CurrencyID: string;
    IsAlreadySigned: boolean;
    Error: EVA.Core.ServiceError;
  }

  /**
   * Add a signature to an Order.
   * 
   * It is required to set an OrderID or an Hash.
   */
  export interface SignOrder {
    OrderID: number;
    Hash?: string;
    Signature: number[];
    MimeType: string;
  }

  export interface StartSignDocumentTask {
    TaskID: number;
    OrderLineID: number;
  }

  export interface StartSignDocumentResponse {
    WorkSet: StartSignDocumentWorkSet;
    Error: EVA.Core.ServiceError;
  }

  export interface StartSignDocumentWorkSet {
    DocumentID?: string;
    DocumentUrl: string;
    SignatureHashSalt: string;
    UserTaskID: number;
    Signatures: Signature[];
  }

}