groupdocs-signature-cloud
Version:
GroupDocs.Signature Cloud SDK for Node.js
2,101 lines • 109 kB
JavaScript
"use strict";
/*
* The MIT License (MIT)
*
* Copyright (c) 2003-2023 Aspose Pty Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ImageAppearance = exports.FormFieldSignature = exports.FileVersion = exports.DigitalSignatureAppearance = exports.DigitalSignature = exports.DeleteSettings = exports.BarcodeSignature = exports.VerifyResult = exports.UpdateResult = exports.UpdateOptions = exports.TimeStamp = exports.StorageFile = exports.StorageExist = exports.StampLine = exports.SignatureFont = exports.SignatureAppearance = exports.Signature = exports.SignResult = exports.SearchResult = exports.SaveOptions = exports.QRCodesResult = exports.QRCodeType = exports.PreviewResult = exports.PreviewPage = exports.PdfDigitalSignature = exports.PagesSetup = exports.PageInfo = exports.Padding = exports.OptionsBase = exports.ObjectExist = exports.ModelError = exports.InfoResult = exports.FormatsResult = exports.Format = exports.FilesUploadResult = exports.FilesList = exports.FileVersions = exports.FileInfo = exports.ErrorDetails = exports.DiscUsage = exports.DigitalVBA = exports.DeleteResult = exports.DeleteOptions = exports.ConsumptionResult = exports.Color = exports.Brush = exports.BorderLine = exports.BaseSettings = exports.BarcodesResult = exports.BarcodeType = void 0;
exports.MoveFolderRequest = exports.GetFilesListRequest = exports.DeleteFolderRequest = exports.CreateFolderRequest = exports.CopyFolderRequest = exports.UploadFileRequest = exports.MoveFileRequest = exports.DownloadFileRequest = exports.DeleteFileRequest = exports.CopyFileRequest = exports.typeMap = exports.enumsMap = exports.VerifyQRCodeOptions = exports.VerifyBarcodeOptions = exports.SignStampOptions = exports.SignQRCodeOptions = exports.SignDigitalOptions = exports.SignBarcodeOptions = exports.VerifyTextOptions = exports.VerifyDigitalOptions = exports.TextFormFieldSignature = exports.SignTextOptions = exports.SignImageOptions = exports.SearchQRCodeOptions = exports.SearchDigitalOptions = exports.SearchBarcodeOptions = exports.RadioButtonFormFieldSignature = exports.DigitalFormFieldSignature = exports.ComboboxFormFieldSignature = exports.CheckboxFormFieldSignature = exports.VerifySettings = exports.VerifyOptions = exports.UpdateSettings = exports.TextureBrush = exports.TextSignature = exports.SolidBrush = exports.SignSettings = exports.SignOptions = exports.SearchSettings = exports.SearchOptions = exports.RadialGradientBrush = exports.QRCodeSignature = exports.PreviewSettings = exports.PdfTextStickerAppearance = exports.PdfTextAnnotationAppearance = exports.PdfDigitalSignatureAppearance = exports.MetadataSignature = exports.LinearGradientBrush = exports.InfoSettings = exports.ImageSignature = void 0;
exports.StorageExistsRequest = exports.ObjectExistsRequest = exports.GetFileVersionsRequest = exports.GetDiscUsageRequest = exports.VerifySignaturesRequest = exports.UpdateSignaturesRequest = exports.SearchSignaturesRequest = exports.DeleteSignaturesRequest = exports.CreateSignaturesRequest = exports.PreviewDocumentRequest = exports.GetInfoRequest = void 0;
/**
* Describes Barcode type
*/
class BarcodeType {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return BarcodeType.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.BarcodeType = BarcodeType;
/**
* Attribute type map
*/
BarcodeType.attributeTypeMap = [
{
name: "name",
baseName: "name",
type: "string",
}
];
/**
* Describes collection of supported Barcode types
*/
class BarcodesResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return BarcodesResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.BarcodesResult = BarcodesResult;
/**
* Attribute type map
*/
BarcodesResult.attributeTypeMap = [
{
name: "barcodeTypes",
baseName: "barcodeTypes",
type: "Array<BarcodeType>",
}
];
/**
* Defines base class for settings
*/
class BaseSettings {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return BaseSettings.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.BaseSettings = BaseSettings;
/**
* Attribute type map
*/
BaseSettings.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
}
];
/**
* Instance to keep Border line properties
*/
class BorderLine {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return BorderLine.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.BorderLine = BorderLine;
/**
* Attribute type map
*/
BorderLine.attributeTypeMap = [
{
name: "style",
baseName: "style",
type: "BorderLine.StyleEnum",
},
{
name: "transparency",
baseName: "transparency",
type: "number",
},
{
name: "weight",
baseName: "weight",
type: "number",
},
{
name: "color",
baseName: "color",
type: "Color",
},
{
name: "visible",
baseName: "visible",
type: "boolean",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (BorderLine) {
let StyleEnum;
(function (StyleEnum) {
StyleEnum[StyleEnum["Solid"] = 'Solid'] = "Solid";
StyleEnum[StyleEnum["ShortDash"] = 'ShortDash'] = "ShortDash";
StyleEnum[StyleEnum["ShortDot"] = 'ShortDot'] = "ShortDot";
StyleEnum[StyleEnum["ShortDashDot"] = 'ShortDashDot'] = "ShortDashDot";
StyleEnum[StyleEnum["ShortDashDotDot"] = 'ShortDashDotDot'] = "ShortDashDotDot";
StyleEnum[StyleEnum["Dot"] = 'Dot'] = "Dot";
StyleEnum[StyleEnum["Dash"] = 'Dash'] = "Dash";
StyleEnum[StyleEnum["LongDash"] = 'LongDash'] = "LongDash";
StyleEnum[StyleEnum["DashDot"] = 'DashDot'] = "DashDot";
StyleEnum[StyleEnum["LongDashDot"] = 'LongDashDot'] = "LongDashDot";
StyleEnum[StyleEnum["LongDashDotDot"] = 'LongDashDotDot'] = "LongDashDotDot";
StyleEnum[StyleEnum["RoundDot"] = 'RoundDot'] = "RoundDot";
StyleEnum[StyleEnum["SquareDot"] = 'SquareDot'] = "SquareDot";
StyleEnum[StyleEnum["DashDotDot"] = 'DashDotDot'] = "DashDotDot";
StyleEnum[StyleEnum["DashLongDash"] = 'DashLongDash'] = "DashLongDash";
StyleEnum[StyleEnum["DashLongDashDot"] = 'DashLongDashDot'] = "DashLongDashDot";
})(StyleEnum = BorderLine.StyleEnum || (BorderLine.StyleEnum = {}));
})(BorderLine || (exports.BorderLine = BorderLine = {}));
// tslint:enable:quotemark
/**
* Represents base class for various brushes
*/
class Brush {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return Brush.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.Brush = Brush;
/**
* Attribute type map
*/
Brush.attributeTypeMap = [
{
name: "brushType",
baseName: "brushType",
type: "string",
}
];
/**
* Keep color value
*/
class Color {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return Color.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.Color = Color;
/**
* Attribute type map
*/
Color.attributeTypeMap = [
{
name: "web",
baseName: "web",
type: "string",
}
];
/**
* Metered license consumption information
*/
class ConsumptionResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return ConsumptionResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.ConsumptionResult = ConsumptionResult;
/**
* Attribute type map
*/
ConsumptionResult.attributeTypeMap = [
{
name: "credit",
baseName: "credit",
type: "number",
},
{
name: "quantity",
baseName: "quantity",
type: "number",
}
];
/**
* Base container class for delete signature options
*/
class DeleteOptions {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return DeleteOptions.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.DeleteOptions = DeleteOptions;
/**
* Attribute type map
*/
DeleteOptions.attributeTypeMap = [
{
name: "signatureType",
baseName: "signatureType",
type: "DeleteOptions.SignatureTypeEnum",
},
{
name: "signatureId",
baseName: "signatureId",
type: "string",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (DeleteOptions) {
let SignatureTypeEnum;
(function (SignatureTypeEnum) {
SignatureTypeEnum[SignatureTypeEnum["None"] = 'None'] = "None";
SignatureTypeEnum[SignatureTypeEnum["Text"] = 'Text'] = "Text";
SignatureTypeEnum[SignatureTypeEnum["Image"] = 'Image'] = "Image";
SignatureTypeEnum[SignatureTypeEnum["Digital"] = 'Digital'] = "Digital";
SignatureTypeEnum[SignatureTypeEnum["Barcode"] = 'Barcode'] = "Barcode";
SignatureTypeEnum[SignatureTypeEnum["QRCode"] = 'QRCode'] = "QRCode";
SignatureTypeEnum[SignatureTypeEnum["Stamp"] = 'Stamp'] = "Stamp";
SignatureTypeEnum[SignatureTypeEnum["FormField"] = 'FormField'] = "FormField";
SignatureTypeEnum[SignatureTypeEnum["Metadata"] = 'Metadata'] = "Metadata";
})(SignatureTypeEnum = DeleteOptions.SignatureTypeEnum || (DeleteOptions.SignatureTypeEnum = {}));
})(DeleteOptions || (exports.DeleteOptions = DeleteOptions = {}));
// tslint:enable:quotemark
/**
* Delete result information
*/
class DeleteResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return DeleteResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.DeleteResult = DeleteResult;
/**
* Attribute type map
*/
DeleteResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "succeeded",
baseName: "succeeded",
type: "Array<Signature>",
},
{
name: "failed",
baseName: "failed",
type: "Array<Signature>",
}
];
class DigitalVBA {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return DigitalVBA.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.DigitalVBA = DigitalVBA;
/**
* Attribute type map
*/
DigitalVBA.attributeTypeMap = [
{
name: "password",
baseName: "password",
type: "string",
},
{
name: "certificateFilePath",
baseName: "certificateFilePath",
type: "string",
},
{
name: "signOnlyVBAProject",
baseName: "signOnlyVBAProject",
type: "boolean",
},
{
name: "comments",
baseName: "comments",
type: "string",
}
];
/**
* Class for disc space information.
*/
class DiscUsage {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return DiscUsage.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.DiscUsage = DiscUsage;
/**
* Attribute type map
*/
DiscUsage.attributeTypeMap = [
{
name: "usedSize",
baseName: "usedSize",
type: "number",
},
{
name: "totalSize",
baseName: "totalSize",
type: "number",
}
];
/**
* The error details
*/
class ErrorDetails {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return ErrorDetails.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.ErrorDetails = ErrorDetails;
/**
* Attribute type map
*/
ErrorDetails.attributeTypeMap = [
{
name: "requestId",
baseName: "requestId",
type: "string",
},
{
name: "date",
baseName: "date",
type: "Date",
}
];
/**
* File info
*/
class FileInfo {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return FileInfo.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.FileInfo = FileInfo;
/**
* Attribute type map
*/
FileInfo.attributeTypeMap = [
{
name: "filePath",
baseName: "filePath",
type: "string",
},
{
name: "storageName",
baseName: "storageName",
type: "string",
},
{
name: "versionId",
baseName: "versionId",
type: "string",
},
{
name: "password",
baseName: "password",
type: "string",
}
];
/**
* File versions FileVersion.
*/
class FileVersions {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return FileVersions.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.FileVersions = FileVersions;
/**
* Attribute type map
*/
FileVersions.attributeTypeMap = [
{
name: "value",
baseName: "value",
type: "Array<FileVersion>",
}
];
/**
* Files list
*/
class FilesList {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return FilesList.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.FilesList = FilesList;
/**
* Attribute type map
*/
FilesList.attributeTypeMap = [
{
name: "value",
baseName: "value",
type: "Array<StorageFile>",
}
];
/**
* File upload result
*/
class FilesUploadResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return FilesUploadResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.FilesUploadResult = FilesUploadResult;
/**
* Attribute type map
*/
FilesUploadResult.attributeTypeMap = [
{
name: "uploaded",
baseName: "uploaded",
type: "Array<string>",
},
{
name: "errors",
baseName: "errors",
type: "Array<Error>",
}
];
/**
* File format
*/
class Format {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return Format.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.Format = Format;
/**
* Attribute type map
*/
Format.attributeTypeMap = [
{
name: "extension",
baseName: "extension",
type: "string",
},
{
name: "fileFormat",
baseName: "fileFormat",
type: "string",
}
];
/**
* Describes list of supported file formats
*/
class FormatsResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return FormatsResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.FormatsResult = FormatsResult;
/**
* Attribute type map
*/
FormatsResult.attributeTypeMap = [
{
name: "formats",
baseName: "formats",
type: "Array<Format>",
}
];
/**
* Document info result
*/
class InfoResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return InfoResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.InfoResult = InfoResult;
/**
* Attribute type map
*/
InfoResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "extension",
baseName: "extension",
type: "string",
},
{
name: "fileFormat",
baseName: "fileFormat",
type: "string",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "pagesCount",
baseName: "pagesCount",
type: "number",
},
{
name: "dateCreated",
baseName: "dateCreated",
type: "Date",
},
{
name: "dateModified",
baseName: "dateModified",
type: "Date",
},
{
name: "widthForMaxHeight",
baseName: "widthForMaxHeight",
type: "number",
},
{
name: "maxPageHeight",
baseName: "maxPageHeight",
type: "number",
},
{
name: "pages",
baseName: "pages",
type: "Array<PageInfo>",
},
{
name: "signatures",
baseName: "signatures",
type: "Array<Signature>",
}
];
/**
* Error
*/
class ModelError {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return ModelError.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.ModelError = ModelError;
/**
* Attribute type map
*/
ModelError.attributeTypeMap = [
{
name: "code",
baseName: "code",
type: "string",
},
{
name: "message",
baseName: "message",
type: "string",
},
{
name: "description",
baseName: "description",
type: "string",
},
{
name: "innerError",
baseName: "innerError",
type: "ErrorDetails",
}
];
/**
* Object exists
*/
class ObjectExist {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return ObjectExist.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.ObjectExist = ObjectExist;
/**
* Attribute type map
*/
ObjectExist.attributeTypeMap = [
{
name: "exists",
baseName: "exists",
type: "boolean",
},
{
name: "isFolder",
baseName: "isFolder",
type: "boolean",
}
];
/**
* Base container class for all possible options data
*/
class OptionsBase {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return OptionsBase.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.OptionsBase = OptionsBase;
/**
* Attribute type map
*/
OptionsBase.attributeTypeMap = [
{
name: "signatureType",
baseName: "signatureType",
type: "OptionsBase.SignatureTypeEnum",
},
{
name: "page",
baseName: "page",
type: "number",
},
{
name: "allPages",
baseName: "allPages",
type: "boolean",
},
{
name: "pagesSetup",
baseName: "pagesSetup",
type: "PagesSetup",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (OptionsBase) {
let SignatureTypeEnum;
(function (SignatureTypeEnum) {
SignatureTypeEnum[SignatureTypeEnum["None"] = 'None'] = "None";
SignatureTypeEnum[SignatureTypeEnum["Text"] = 'Text'] = "Text";
SignatureTypeEnum[SignatureTypeEnum["Image"] = 'Image'] = "Image";
SignatureTypeEnum[SignatureTypeEnum["Digital"] = 'Digital'] = "Digital";
SignatureTypeEnum[SignatureTypeEnum["Barcode"] = 'Barcode'] = "Barcode";
SignatureTypeEnum[SignatureTypeEnum["QRCode"] = 'QRCode'] = "QRCode";
SignatureTypeEnum[SignatureTypeEnum["Stamp"] = 'Stamp'] = "Stamp";
SignatureTypeEnum[SignatureTypeEnum["FormField"] = 'FormField'] = "FormField";
SignatureTypeEnum[SignatureTypeEnum["Metadata"] = 'Metadata'] = "Metadata";
})(SignatureTypeEnum = OptionsBase.SignatureTypeEnum || (OptionsBase.SignatureTypeEnum = {}));
})(OptionsBase || (exports.OptionsBase = OptionsBase = {}));
// tslint:enable:quotemark
/**
* Represents padding or margin information associated with element
*/
class Padding {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return Padding.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.Padding = Padding;
/**
* Attribute type map
*/
Padding.attributeTypeMap = [
{
name: "all",
baseName: "all",
type: "number",
},
{
name: "left",
baseName: "left",
type: "number",
},
{
name: "top",
baseName: "top",
type: "number",
},
{
name: "right",
baseName: "right",
type: "number",
},
{
name: "bottom",
baseName: "bottom",
type: "number",
}
];
/**
* Page information
*/
class PageInfo {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return PageInfo.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.PageInfo = PageInfo;
/**
* Attribute type map
*/
PageInfo.attributeTypeMap = [
{
name: "number",
baseName: "number",
type: "number",
},
{
name: "name",
baseName: "name",
type: "string",
},
{
name: "width",
baseName: "width",
type: "number",
},
{
name: "height",
baseName: "height",
type: "number",
},
{
name: "angle",
baseName: "angle",
type: "number",
},
{
name: "visible",
baseName: "visible",
type: "boolean",
}
];
/**
* Describes special pages of document to process
*/
class PagesSetup {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return PagesSetup.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.PagesSetup = PagesSetup;
/**
* Attribute type map
*/
PagesSetup.attributeTypeMap = [
{
name: "firstPage",
baseName: "firstPage",
type: "boolean",
},
{
name: "lastPage",
baseName: "lastPage",
type: "boolean",
},
{
name: "oddPages",
baseName: "oddPages",
type: "boolean",
},
{
name: "evenPages",
baseName: "evenPages",
type: "boolean",
},
{
name: "pageNumbers",
baseName: "pageNumbers",
type: "Array<number>",
}
];
/**
* Contains pdf digital Signature properties
*/
class PdfDigitalSignature {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return PdfDigitalSignature.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.PdfDigitalSignature = PdfDigitalSignature;
/**
* Attribute type map
*/
PdfDigitalSignature.attributeTypeMap = [
{
name: "contactInfo",
baseName: "contactInfo",
type: "string",
},
{
name: "location",
baseName: "location",
type: "string",
},
{
name: "reason",
baseName: "reason",
type: "string",
},
{
name: "type",
baseName: "type",
type: "PdfDigitalSignature.TypeEnum",
},
{
name: "timeStamp",
baseName: "timeStamp",
type: "TimeStamp",
},
{
name: "showProperties",
baseName: "showProperties",
type: "boolean",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (PdfDigitalSignature) {
let TypeEnum;
(function (TypeEnum) {
TypeEnum[TypeEnum["Signature"] = 'Signature'] = "Signature";
TypeEnum[TypeEnum["Certificate"] = 'Certificate'] = "Certificate";
})(TypeEnum = PdfDigitalSignature.TypeEnum || (PdfDigitalSignature.TypeEnum = {}));
})(PdfDigitalSignature || (exports.PdfDigitalSignature = PdfDigitalSignature = {}));
// tslint:enable:quotemark
/**
* Document preview page
*/
class PreviewPage {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return PreviewPage.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.PreviewPage = PreviewPage;
/**
* Attribute type map
*/
PreviewPage.attributeTypeMap = [
{
name: "pageNumber",
baseName: "pageNumber",
type: "number",
},
{
name: "filePath",
baseName: "filePath",
type: "string",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "downloadUrl",
baseName: "downloadUrl",
type: "string",
}
];
/**
* Document preview result
*/
class PreviewResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return PreviewResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.PreviewResult = PreviewResult;
/**
* Attribute type map
*/
PreviewResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "pagesCount",
baseName: "pagesCount",
type: "number",
},
{
name: "pages",
baseName: "pages",
type: "Array<PreviewPage>",
}
];
/**
* Describes QR-code type
*/
class QRCodeType {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return QRCodeType.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.QRCodeType = QRCodeType;
/**
* Attribute type map
*/
QRCodeType.attributeTypeMap = [
{
name: "name",
baseName: "name",
type: "string",
}
];
/**
* Describes collection of supported QR-code types
*/
class QRCodesResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return QRCodesResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.QRCodesResult = QRCodesResult;
/**
* Attribute type map
*/
QRCodesResult.attributeTypeMap = [
{
name: "qRCodeTypes",
baseName: "qrCodeTypes",
type: "Array<QRCodeType>",
}
];
/**
* Base document save options class
*/
class SaveOptions {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return SaveOptions.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.SaveOptions = SaveOptions;
/**
* Attribute type map
*/
SaveOptions.attributeTypeMap = [
{
name: "overwriteExisting",
baseName: "overwriteExisting",
type: "boolean",
},
{
name: "outputFilePath",
baseName: "outputFilePath",
type: "string",
},
{
name: "saveFormat",
baseName: "saveFormat",
type: "string",
}
];
/**
* Search result information
*/
class SearchResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return SearchResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.SearchResult = SearchResult;
/**
* Attribute type map
*/
SearchResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "signatures",
baseName: "signatures",
type: "Array<Signature>",
}
];
/**
* Sign result information
*/
class SignResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return SignResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.SignResult = SignResult;
/**
* Attribute type map
*/
SignResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "downloadUrl",
baseName: "downloadUrl",
type: "string",
},
{
name: "succeeded",
baseName: "succeeded",
type: "Array<Signature>",
},
{
name: "failed",
baseName: "failed",
type: "Array<Signature>",
}
];
/**
* Describes base class for signatures
*/
class Signature {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return Signature.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.Signature = Signature;
/**
* Attribute type map
*/
Signature.attributeTypeMap = [
{
name: "signatureType",
baseName: "signatureType",
type: "Signature.SignatureTypeEnum",
},
{
name: "pageNumber",
baseName: "pageNumber",
type: "number",
},
{
name: "signatureId",
baseName: "signatureId",
type: "string",
},
{
name: "isSignature",
baseName: "isSignature",
type: "boolean",
},
{
name: "createdOn",
baseName: "createdOn",
type: "Date",
},
{
name: "modifiedOn",
baseName: "modifiedOn",
type: "Date",
},
{
name: "top",
baseName: "top",
type: "number",
},
{
name: "left",
baseName: "left",
type: "number",
},
{
name: "width",
baseName: "width",
type: "number",
},
{
name: "height",
baseName: "height",
type: "number",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (Signature) {
let SignatureTypeEnum;
(function (SignatureTypeEnum) {
SignatureTypeEnum[SignatureTypeEnum["None"] = 'None'] = "None";
SignatureTypeEnum[SignatureTypeEnum["Text"] = 'Text'] = "Text";
SignatureTypeEnum[SignatureTypeEnum["Image"] = 'Image'] = "Image";
SignatureTypeEnum[SignatureTypeEnum["Digital"] = 'Digital'] = "Digital";
SignatureTypeEnum[SignatureTypeEnum["Barcode"] = 'Barcode'] = "Barcode";
SignatureTypeEnum[SignatureTypeEnum["QRCode"] = 'QRCode'] = "QRCode";
SignatureTypeEnum[SignatureTypeEnum["Stamp"] = 'Stamp'] = "Stamp";
SignatureTypeEnum[SignatureTypeEnum["FormField"] = 'FormField'] = "FormField";
SignatureTypeEnum[SignatureTypeEnum["Metadata"] = 'Metadata'] = "Metadata";
})(SignatureTypeEnum = Signature.SignatureTypeEnum || (Signature.SignatureTypeEnum = {}));
})(Signature || (exports.Signature = Signature = {}));
// tslint:enable:quotemark
/**
* Appearance is a base class for keeping additional information for various options
*/
class SignatureAppearance {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return SignatureAppearance.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.SignatureAppearance = SignatureAppearance;
/**
* Attribute type map
*/
SignatureAppearance.attributeTypeMap = [
{
name: "appearanceType",
baseName: "appearanceType",
type: "SignatureAppearance.AppearanceTypeEnum",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (SignatureAppearance) {
let AppearanceTypeEnum;
(function (AppearanceTypeEnum) {
AppearanceTypeEnum[AppearanceTypeEnum["Undefined"] = 'Undefined'] = "Undefined";
AppearanceTypeEnum[AppearanceTypeEnum["PdfTextAnnotation"] = 'PdfTextAnnotation'] = "PdfTextAnnotation";
AppearanceTypeEnum[AppearanceTypeEnum["PdfTextSticker"] = 'PdfTextSticker'] = "PdfTextSticker";
AppearanceTypeEnum[AppearanceTypeEnum["Image"] = 'Image'] = "Image";
AppearanceTypeEnum[AppearanceTypeEnum["DigitalSignature"] = 'DigitalSignature'] = "DigitalSignature";
AppearanceTypeEnum[AppearanceTypeEnum["PdfDigitalSignature"] = 'PdfDigitalSignature'] = "PdfDigitalSignature";
})(AppearanceTypeEnum = SignatureAppearance.AppearanceTypeEnum || (SignatureAppearance.AppearanceTypeEnum = {}));
})(SignatureAppearance || (exports.SignatureAppearance = SignatureAppearance = {}));
// tslint:enable:quotemark
/**
* Create instance of SignatureFont class to specify Font properties
*/
class SignatureFont {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return SignatureFont.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.SignatureFont = SignatureFont;
/**
* Attribute type map
*/
SignatureFont.attributeTypeMap = [
{
name: "fontFamily",
baseName: "fontFamily",
type: "string",
},
{
name: "fontSize",
baseName: "fontSize",
type: "number",
},
{
name: "bold",
baseName: "bold",
type: "boolean",
},
{
name: "italic",
baseName: "italic",
type: "boolean",
},
{
name: "underline",
baseName: "underline",
type: "boolean",
}
];
/**
* Specify Stamp line properties
*/
class StampLine {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return StampLine.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.StampLine = StampLine;
/**
* Attribute type map
*/
StampLine.attributeTypeMap = [
{
name: "height",
baseName: "height",
type: "number",
},
{
name: "backgroundColor",
baseName: "backgroundColor",
type: "Color",
},
{
name: "text",
baseName: "text",
type: "string",
},
{
name: "font",
baseName: "font",
type: "SignatureFont",
},
{
name: "textColor",
baseName: "textColor",
type: "Color",
},
{
name: "textBottomIntent",
baseName: "textBottomIntent",
type: "number",
},
{
name: "textRepeatType",
baseName: "textRepeatType",
type: "StampLine.TextRepeatTypeEnum",
},
{
name: "outerBorder",
baseName: "outerBorder",
type: "BorderLine",
},
{
name: "innerBorder",
baseName: "innerBorder",
type: "BorderLine",
},
{
name: "visible",
baseName: "visible",
type: "boolean",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (StampLine) {
let TextRepeatTypeEnum;
(function (TextRepeatTypeEnum) {
TextRepeatTypeEnum[TextRepeatTypeEnum["None"] = 'None'] = "None";
TextRepeatTypeEnum[TextRepeatTypeEnum["FullTextRepeat"] = 'FullTextRepeat'] = "FullTextRepeat";
TextRepeatTypeEnum[TextRepeatTypeEnum["RepeatWithTruncation"] = 'RepeatWithTruncation'] = "RepeatWithTruncation";
})(TextRepeatTypeEnum = StampLine.TextRepeatTypeEnum || (StampLine.TextRepeatTypeEnum = {}));
})(StampLine || (exports.StampLine = StampLine = {}));
// tslint:enable:quotemark
/**
* Storage exists
*/
class StorageExist {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return StorageExist.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.StorageExist = StorageExist;
/**
* Attribute type map
*/
StorageExist.attributeTypeMap = [
{
name: "exists",
baseName: "exists",
type: "boolean",
}
];
/**
* File or folder information
*/
class StorageFile {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return StorageFile.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.StorageFile = StorageFile;
/**
* Attribute type map
*/
StorageFile.attributeTypeMap = [
{
name: "name",
baseName: "name",
type: "string",
},
{
name: "isFolder",
baseName: "isFolder",
type: "boolean",
},
{
name: "modifiedDate",
baseName: "modifiedDate",
type: "Date",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "path",
baseName: "path",
type: "string",
}
];
/**
* Represents data to get time stamp from third-party site.
*/
class TimeStamp {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return TimeStamp.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.TimeStamp = TimeStamp;
/**
* Attribute type map
*/
TimeStamp.attributeTypeMap = [
{
name: "url",
baseName: "url",
type: "string",
},
{
name: "user",
baseName: "user",
type: "string",
},
{
name: "password",
baseName: "password",
type: "string",
}
];
/**
* Base container class for update signature options
*/
class UpdateOptions {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return UpdateOptions.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.UpdateOptions = UpdateOptions;
/**
* Attribute type map
*/
UpdateOptions.attributeTypeMap = [
{
name: "signatureType",
baseName: "signatureType",
type: "UpdateOptions.SignatureTypeEnum",
},
{
name: "signatureId",
baseName: "signatureId",
type: "string",
},
{
name: "left",
baseName: "left",
type: "number",
},
{
name: "top",
baseName: "top",
type: "number",
},
{
name: "width",
baseName: "width",
type: "number",
},
{
name: "height",
baseName: "height",
type: "number",
},
{
name: "isSignature",
baseName: "isSignature",
type: "boolean",
},
{
name: "text",
baseName: "text",
type: "string",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (UpdateOptions) {
let SignatureTypeEnum;
(function (SignatureTypeEnum) {
SignatureTypeEnum[SignatureTypeEnum["None"] = 'None'] = "None";
SignatureTypeEnum[SignatureTypeEnum["Text"] = 'Text'] = "Text";
SignatureTypeEnum[SignatureTypeEnum["Image"] = 'Image'] = "Image";
SignatureTypeEnum[SignatureTypeEnum["Digital"] = 'Digital'] = "Digital";
SignatureTypeEnum[SignatureTypeEnum["Barcode"] = 'Barcode'] = "Barcode";
SignatureTypeEnum[SignatureTypeEnum["QRCode"] = 'QRCode'] = "QRCode";
SignatureTypeEnum[SignatureTypeEnum["Stamp"] = 'Stamp'] = "Stamp";
SignatureTypeEnum[SignatureTypeEnum["FormField"] = 'FormField'] = "FormField";
SignatureTypeEnum[SignatureTypeEnum["Metadata"] = 'Metadata'] = "Metadata";
})(SignatureTypeEnum = UpdateOptions.SignatureTypeEnum || (UpdateOptions.SignatureTypeEnum = {}));
})(UpdateOptions || (exports.UpdateOptions = UpdateOptions = {}));
// tslint:enable:quotemark
/**
* Update result information
*/
class UpdateResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return UpdateResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.UpdateResult = UpdateResult;
/**
* Attribute type map
*/
UpdateResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "succeeded",
baseName: "succeeded",
type: "Array<Signature>",
},
{
name: "failed",
baseName: "failed",
type: "Array<Signature>",
}
];
/**
* Verification result information
*/
class VerifyResult {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return VerifyResult.attributeTypeMap;
}
constructor(init) {
Object.assign(this, init);
}
}
exports.VerifyResult = VerifyResult;
/**
* Attribute type map
*/
VerifyResult.attributeTypeMap = [
{
name: "fileInfo",
baseName: "fileInfo",
type: "FileInfo",
},
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "isSuccess",
baseName: "isSuccess",
type: "boolean",
}
];
/**
* Contains Barcode signature properties
*/
class BarcodeSignature extends Signature {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(BarcodeSignature.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.BarcodeSignature = BarcodeSignature;
/**
* Attribute type map
*/
BarcodeSignature.attributeTypeMap = [
{
name: "barcodeType",
baseName: "barcodeType",
type: "string",
},
{
name: "text",
baseName: "text",
type: "string",
},
{
name: "format",
baseName: "format",
type: "string",
}
];
// tslint:enable:quotemark
/**
* Defines delete sign document settings
*/
class DeleteSettings extends BaseSettings {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(DeleteSettings.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.DeleteSettings = DeleteSettings;
/**
* Attribute type map
*/
DeleteSettings.attributeTypeMap = [
{
name: "options",
baseName: "options",
type: "Array<DeleteOptions>",
}
];
/**
* Contains digital Signature properties
*/
class DigitalSignature extends Signature {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(DigitalSignature.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.DigitalSignature = DigitalSignature;
/**
* Attribute type map
*/
DigitalSignature.attributeTypeMap = [
{
name: "comments",
baseName: "comments",
type: "string",
},
{
name: "isValid",
baseName: "isValid",
type: "boolean",
},
{
name: "signTime",
baseName: "signTime",
type: "Date",
},
{
name: "pdfDigitalSignature",
baseName: "pdfDigitalSignature",
type: "PdfDigitalSignature",
}
];
// tslint:enable:quotemark
/**
* Describes appearance of Signature Line for Digital Signature. One Signature Line could be applied for only one Digital Signature. Signature Line always is on the first page. This feature may be useful for .docx, .doc, .odt and .xlsx file formats.
*/
class DigitalSignatureAppearance extends SignatureAppearance {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(DigitalSignatureAppearance.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.DigitalSignatureAppearance = DigitalSignatureAppearance;
/**
* Attribute type map
*/
DigitalSignatureAppearance.attributeTypeMap = [
{
name: "email",
baseName: "email",
type: "string",
},
{
name: "signer",
baseName: "signer",
type: "string",
},
{
name: "title",
baseName: "title",
type: "string",
}
];
// tslint:enable:quotemark
/**
* File Version
*/
class FileVersion extends StorageFile {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(FileVersion.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.FileVersion = FileVersion;
/**
* Attribute type map
*/
FileVersion.attributeTypeMap = [
{
name: "versionId",
baseName: "versionId",
type: "string",
},
{
name: "isLatest",
baseName: "isLatest",
type: "boolean",
}
];
/**
* Contains Form field signature properties
*/
class FormFieldSignature extends Signature {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(FormFieldSignature.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.FormFieldSignature = FormFieldSignature;
/**
* Attribute type map
*/
FormFieldSignature.attributeTypeMap = [
{
name: "name",
baseName: "name",
type: "string",
},
{
name: "type",
baseName: "type",
type: "FormFieldSignature.TypeEnum",
}
];
// tslint:disable:quotemark
// tslint:disable-next-line:no-namespace
(function (FormFieldSignature) {
let TypeEnum;
(function (TypeEnum) {
TypeEnum[TypeEnum["Text"] = 'Text'] = "Text";
TypeEnum[TypeEnum["Checkbox"] = 'Checkbox'] = "Checkbox";
TypeEnum[TypeEnum["Combobox"] = 'Combobox'] = "Combobox";
TypeEnum[TypeEnum["DigitalSignature"] = 'DigitalSignature'] = "DigitalSignature";
TypeEnum[TypeEnum["Radio"] = 'Radio'] = "Radio";
TypeEnum[TypeEnum["None"] = 'None'] = "None";
})(TypeEnum = FormFieldSignature.TypeEnum || (FormFieldSignature.TypeEnum = {}));
})(FormFieldSignature || (exports.FormFieldSignature = FormFieldSignature = {}));
// tslint:enable:quotemark
/**
* Describes extended appearance features for Image Signature.
*/
class ImageAppearance extends SignatureAppearance {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(ImageAppearance.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.ImageAppearance = ImageAppearance;
/**
* Attribute type map
*/
ImageAppearance.attributeTypeMap = [
{
name: "brightness",
baseName: "brightness",
type: "number",
},
{
name: "contrast",
baseName: "contrast",
type: "number",
},
{
name: "gammaCorrection",
baseName: "gammaCorrection",
type: "number",
},
{
name: "grayscale",
baseName: "grayscale",
type: "boolean",
}
];
// tslint:enable:quotemark
/**
* Contains Image signature properties
*/
class ImageSignature extends Signature {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(ImageSignature.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.ImageSignature = ImageSignature;
/**
* Attribute type map
*/
ImageSignature.attributeTypeMap = [
{
name: "size",
baseName: "size",
type: "number",
},
{
name: "format",
baseName: "format",
type: "string",
}
];
// tslint:enable:quotemark
/**
* Defines document information request settings
*/
class InfoSettings extends BaseSettings {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(InfoSettings.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.InfoSettings = InfoSettings;
/**
* Attribute type map
*/
InfoSettings.attributeTypeMap = [
{
name: "showDeletedSignaturesInfo",
baseName: "showDeletedSignaturesInfo",
type: "boolean",
}
];
/**
* Represents linear gradient brush
*/
class LinearGradientBrush extends Brush {
/**
* Returns attribute type map
*/
static getAttributeTypeMap() {
return super.getAttributeTypeMap().concat(LinearGradientBrush.attributeTypeMap);
}
constructor(init) {
super(init);
Object.assign(this, init);
}
}
exports.Line