groupdocs-signature-cloud
Version:
GroupDocs.Signature Cloud SDK for Node.js
936 lines (935 loc) • 45.6 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.
*/
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.StorageApi = exports.SignApi = exports.PreviewApi = exports.LicenseApi = exports.InfoApi = exports.FolderApi = exports.FileApi = void 0;
const FormData = require("form-data");
const api_client_1 = require("./api_client");
const configuration_1 = require("./configuration");
const serializer_1 = require("./serializer");
__exportStar(require("./model"), exports);
__exportStar(require("./configuration"), exports);
/**
* GroupDocs.Signature Cloud API
*/
class FileApi {
/**
* Creates new instance of FileApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new FileApi(config);
}
/**
* Creates new instance of FileApi
* @param config API configuration.
*/
static fromConfig(config) {
return new FileApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Copy file
* @param requestObj contains request parameters
*/
copyFile(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling copyFile.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/file/copy/{srcPath}"
.replace("{" + "srcPath" + "}", String(requestObj.srcPath));
const queryParameters = {};
// verify required parameter 'requestObj.srcPath' is not null or undefined
if (requestObj.srcPath === null || requestObj.srcPath === undefined) {
throw new Error('Required parameter "requestObj.srcPath" was null or undefined when calling copyFile.');
}
// verify required parameter 'requestObj.destPath' is not null or undefined
if (requestObj.destPath === null || requestObj.destPath === undefined) {
throw new Error('Required parameter "requestObj.destPath" was null or undefined when calling copyFile.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destPath", requestObj.destPath);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "srcStorageName", requestObj.srcStorageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destStorageName", requestObj.destStorageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "versionId", requestObj.versionId);
const requestOptions = {
method: "PUT",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
/**
* Delete file
* @param requestObj contains request parameters
*/
deleteFile(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling deleteFile.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/file/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling deleteFile.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "versionId", requestObj.versionId);
const requestOptions = {
method: "DELETE",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
/**
* Download file
* @param requestObj contains request parameters
*/
downloadFile(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling downloadFile.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/file/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling downloadFile.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "versionId", requestObj.versionId);
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "arraybuffer",
responseEncoding: null,
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "Buffer");
return Promise.resolve(result);
});
}
/**
* Move file
* @param requestObj contains request parameters
*/
moveFile(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling moveFile.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/file/move/{srcPath}"
.replace("{" + "srcPath" + "}", String(requestObj.srcPath));
const queryParameters = {};
// verify required parameter 'requestObj.srcPath' is not null or undefined
if (requestObj.srcPath === null || requestObj.srcPath === undefined) {
throw new Error('Required parameter "requestObj.srcPath" was null or undefined when calling moveFile.');
}
// verify required parameter 'requestObj.destPath' is not null or undefined
if (requestObj.destPath === null || requestObj.destPath === undefined) {
throw new Error('Required parameter "requestObj.destPath" was null or undefined when calling moveFile.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destPath", requestObj.destPath);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "srcStorageName", requestObj.srcStorageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destStorageName", requestObj.destStorageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "versionId", requestObj.versionId);
const requestOptions = {
method: "PUT",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
/**
* Upload file
* @param requestObj contains request parameters
*/
uploadFile(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling uploadFile.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/file/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
const formParams = new FormData();
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling uploadFile.');
}
// verify required parameter 'requestObj.file' is not null or undefined
if (requestObj.file === null || requestObj.file === undefined) {
throw new Error('Required parameter "requestObj.file" was null or undefined when calling uploadFile.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
if (requestObj.file !== undefined) {
formParams.append("File", requestObj.file, { filename: "file.name" });
}
const requestOptions = {
method: "PUT",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: formParams,
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "FilesUploadResult");
return Promise.resolve(result);
});
}
}
exports.FileApi = FileApi;
/**
* GroupDocs.Signature Cloud API
*/
class FolderApi {
/**
* Creates new instance of FolderApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new FolderApi(config);
}
/**
* Creates new instance of FolderApi
* @param config API configuration.
*/
static fromConfig(config) {
return new FolderApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Copy folder
* @param requestObj contains request parameters
*/
copyFolder(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling copyFolder.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/folder/copy/{srcPath}"
.replace("{" + "srcPath" + "}", String(requestObj.srcPath));
const queryParameters = {};
// verify required parameter 'requestObj.srcPath' is not null or undefined
if (requestObj.srcPath === null || requestObj.srcPath === undefined) {
throw new Error('Required parameter "requestObj.srcPath" was null or undefined when calling copyFolder.');
}
// verify required parameter 'requestObj.destPath' is not null or undefined
if (requestObj.destPath === null || requestObj.destPath === undefined) {
throw new Error('Required parameter "requestObj.destPath" was null or undefined when calling copyFolder.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destPath", requestObj.destPath);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "srcStorageName", requestObj.srcStorageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destStorageName", requestObj.destStorageName);
const requestOptions = {
method: "PUT",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
/**
* Create the folder
* @param requestObj contains request parameters
*/
createFolder(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling createFolder.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/folder/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling createFolder.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
const requestOptions = {
method: "PUT",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
/**
* Delete folder
* @param requestObj contains request parameters
*/
deleteFolder(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling deleteFolder.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/folder/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling deleteFolder.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "recursive", requestObj.recursive);
const requestOptions = {
method: "DELETE",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
/**
* Get all files and folders within a folder
* @param requestObj contains request parameters
*/
getFilesList(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling getFilesList.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/folder/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling getFilesList.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "FilesList");
return Promise.resolve(result);
});
}
/**
* Move folder
* @param requestObj contains request parameters
*/
moveFolder(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling moveFolder.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/folder/move/{srcPath}"
.replace("{" + "srcPath" + "}", String(requestObj.srcPath));
const queryParameters = {};
// verify required parameter 'requestObj.srcPath' is not null or undefined
if (requestObj.srcPath === null || requestObj.srcPath === undefined) {
throw new Error('Required parameter "requestObj.srcPath" was null or undefined when calling moveFolder.');
}
// verify required parameter 'requestObj.destPath' is not null or undefined
if (requestObj.destPath === null || requestObj.destPath === undefined) {
throw new Error('Required parameter "requestObj.destPath" was null or undefined when calling moveFolder.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destPath", requestObj.destPath);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "srcStorageName", requestObj.srcStorageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "destStorageName", requestObj.destStorageName);
const requestOptions = {
method: "PUT",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
return Promise.resolve(response);
});
}
}
exports.FolderApi = FolderApi;
/**
* GroupDocs.Signature Cloud API
*/
class InfoApi {
/**
* Creates new instance of InfoApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new InfoApi(config);
}
/**
* Creates new instance of InfoApi
* @param config API configuration.
*/
static fromConfig(config) {
return new InfoApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Retrieves basic document info - path, extension, formats, size etc
* @param requestObj contains request parameters
*/
getInfo(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling getInfo.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/info";
const queryParameters = {};
// verify required parameter 'requestObj.infoSettings' is not null or undefined
if (requestObj.infoSettings === null || requestObj.infoSettings === undefined) {
throw new Error('Required parameter "requestObj.infoSettings" was null or undefined when calling getInfo.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.infoSettings, requestObj.infoSettings.constructor.name === "Object" ? "InfoSettings" : requestObj.infoSettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "InfoResult");
return Promise.resolve(result);
});
}
/**
* Retrieves supported Barcodes list
* @param requestObj contains request parameters
*/
getSupportedBarcodes() {
return __awaiter(this, void 0, void 0, function* () {
const localVarPath = this.configuration.getServerUrl() + "/signature/barcodes";
const queryParameters = {};
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "BarcodesResult");
return Promise.resolve(result);
});
}
/**
* Retrieves supported file formats list
* @param requestObj contains request parameters
*/
getSupportedFileFormats() {
return __awaiter(this, void 0, void 0, function* () {
const localVarPath = this.configuration.getServerUrl() + "/signature/formats";
const queryParameters = {};
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "FormatsResult");
return Promise.resolve(result);
});
}
/**
* Retrieves supported QR-codes list
* @param requestObj contains request parameters
*/
getSupportedQRCodes() {
return __awaiter(this, void 0, void 0, function* () {
const localVarPath = this.configuration.getServerUrl() + "/signature/qrcodes";
const queryParameters = {};
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "QRCodesResult");
return Promise.resolve(result);
});
}
}
exports.InfoApi = InfoApi;
/**
* GroupDocs.Signature Cloud API
*/
class LicenseApi {
/**
* Creates new instance of LicenseApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new LicenseApi(config);
}
/**
* Creates new instance of LicenseApi
* @param config API configuration.
*/
static fromConfig(config) {
return new LicenseApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Get license consumption
* @param requestObj contains request parameters
*/
getConsumptionCredit() {
return __awaiter(this, void 0, void 0, function* () {
const localVarPath = this.configuration.getServerUrl() + "/signature/consumption";
const queryParameters = {};
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "ConsumptionResult");
return Promise.resolve(result);
});
}
}
exports.LicenseApi = LicenseApi;
/**
* GroupDocs.Signature Cloud API
*/
class PreviewApi {
/**
* Creates new instance of PreviewApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new PreviewApi(config);
}
/**
* Creates new instance of PreviewApi
* @param config API configuration.
*/
static fromConfig(config) {
return new PreviewApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Creates document preview images
* @param requestObj contains request parameters
*/
previewDocument(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling previewDocument.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/preview";
const queryParameters = {};
// verify required parameter 'requestObj.previewSettings' is not null or undefined
if (requestObj.previewSettings === null || requestObj.previewSettings === undefined) {
throw new Error('Required parameter "requestObj.previewSettings" was null or undefined when calling previewDocument.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.previewSettings, requestObj.previewSettings.constructor.name === "Object" ? "PreviewSettings" : requestObj.previewSettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "PreviewResult");
return Promise.resolve(result);
});
}
}
exports.PreviewApi = PreviewApi;
/**
* GroupDocs.Signature Cloud API
*/
class SignApi {
/**
* Creates new instance of SignApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new SignApi(config);
}
/**
* Creates new instance of SignApi
* @param config API configuration.
*/
static fromConfig(config) {
return new SignApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Creates new signatures in the document and saves resultant document into 'Output' folder
* @param requestObj contains request parameters
*/
createSignatures(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling createSignatures.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/create";
const queryParameters = {};
// verify required parameter 'requestObj.signSettings' is not null or undefined
if (requestObj.signSettings === null || requestObj.signSettings === undefined) {
throw new Error('Required parameter "requestObj.signSettings" was null or undefined when calling createSignatures.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.signSettings, requestObj.signSettings.constructor.name === "Object" ? "SignSettings" : requestObj.signSettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "SignResult");
return Promise.resolve(result);
});
}
/**
* Deletes signatures in the document
* @param requestObj contains request parameters
*/
deleteSignatures(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling deleteSignatures.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/delete";
const queryParameters = {};
// verify required parameter 'requestObj.deleteSettings' is not null or undefined
if (requestObj.deleteSettings === null || requestObj.deleteSettings === undefined) {
throw new Error('Required parameter "requestObj.deleteSettings" was null or undefined when calling deleteSignatures.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.deleteSettings, requestObj.deleteSettings.constructor.name === "Object" ? "DeleteSettings" : requestObj.deleteSettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "DeleteResult");
return Promise.resolve(result);
});
}
/**
* Searches for signatures applied to the document
* @param requestObj contains request parameters
*/
searchSignatures(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling searchSignatures.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/search";
const queryParameters = {};
// verify required parameter 'requestObj.searchSettings' is not null or undefined
if (requestObj.searchSettings === null || requestObj.searchSettings === undefined) {
throw new Error('Required parameter "requestObj.searchSettings" was null or undefined when calling searchSignatures.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.searchSettings, requestObj.searchSettings.constructor.name === "Object" ? "SearchSettings" : requestObj.searchSettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "SearchResult");
return Promise.resolve(result);
});
}
/**
* Updates signatures in the document
* @param requestObj contains request parameters
*/
updateSignatures(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling updateSignatures.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/update";
const queryParameters = {};
// verify required parameter 'requestObj.updateSettings' is not null or undefined
if (requestObj.updateSettings === null || requestObj.updateSettings === undefined) {
throw new Error('Required parameter "requestObj.updateSettings" was null or undefined when calling updateSignatures.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.updateSettings, requestObj.updateSettings.constructor.name === "Object" ? "UpdateSettings" : requestObj.updateSettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "UpdateResult");
return Promise.resolve(result);
});
}
/**
* Verifies whether document contains signatures that meet the specified criteria
* @param requestObj contains request parameters
*/
verifySignatures(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling verifySignatures.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/verify";
const queryParameters = {};
// verify required parameter 'requestObj.verifySettings' is not null or undefined
if (requestObj.verifySettings === null || requestObj.verifySettings === undefined) {
throw new Error('Required parameter "requestObj.verifySettings" was null or undefined when calling verifySignatures.');
}
const requestOptions = {
method: "POST",
params: queryParameters,
url: localVarPath,
responseType: "json",
data: serializer_1.Serializer.serialize(requestObj.verifySettings, requestObj.verifySettings.constructor.name === "Object" ? "VerifySettings" : requestObj.verifySettings.constructor.name),
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "VerifyResult");
return Promise.resolve(result);
});
}
}
exports.SignApi = SignApi;
/**
* GroupDocs.Signature Cloud API
*/
class StorageApi {
/**
* Creates new instance of StorageApi
* @param appSid Application identifier (App SID).
* @param appKey Application private key (App Key).
*/
static fromKeys(appSid, appKey) {
const config = new configuration_1.Configuration(appSid, appKey);
return new StorageApi(config);
}
/**
* Creates new instance of StorageApi
* @param config API configuration.
*/
static fromConfig(config) {
return new StorageApi(config);
}
/**
* @param config Configuration.
*/
constructor(config) {
this.configuration = config;
}
/**
* Get disc usage
* @param requestObj contains request parameters
*/
getDiscUsage(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling getDiscUsage.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/disc";
const queryParameters = {};
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "DiscUsage");
return Promise.resolve(result);
});
}
/**
* Get file versions
* @param requestObj contains request parameters
*/
getFileVersions(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling getFileVersions.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/version/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling getFileVersions.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "FileVersions");
return Promise.resolve(result);
});
}
/**
* Check if file or folder exists
* @param requestObj contains request parameters
*/
objectExists(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling objectExists.');
}
let localVarPath = this.configuration.getServerUrl() + "/signature/storage/exist/{path}"
.replace("{" + "path" + "}", String(requestObj.path));
const queryParameters = {};
// verify required parameter 'requestObj.path' is not null or undefined
if (requestObj.path === null || requestObj.path === undefined) {
throw new Error('Required parameter "requestObj.path" was null or undefined when calling objectExists.');
}
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "storageName", requestObj.storageName);
localVarPath = (0, api_client_1.addQueryParameterToUrl)(localVarPath, queryParameters, "versionId", requestObj.versionId);
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "ObjectExist");
return Promise.resolve(result);
});
}
/**
* Check if storage exists
* @param requestObj contains request parameters
*/
storageExists(requestObj) {
return __awaiter(this, void 0, void 0, function* () {
if (requestObj === null || requestObj === undefined) {
throw new Error('Required parameter "requestObj" was null or undefined when calling storageExists.');
}
const localVarPath = this.configuration.getServerUrl() + "/signature/storage/{storageName}/exist"
.replace("{" + "storageName" + "}", String(requestObj.storageName));
const queryParameters = {};
// verify required parameter 'requestObj.storageName' is not null or undefined
if (requestObj.storageName === null || requestObj.storageName === undefined) {
throw new Error('Required parameter "requestObj.storageName" was null or undefined when calling storageExists.');
}
const requestOptions = {
method: "GET",
params: queryParameters,
url: localVarPath,
responseType: "json",
};
const response = yield (0, api_client_1.invokeApiMethod)(requestOptions, this.configuration);
const result = serializer_1.Serializer.deserialize(response.data, "StorageExist");
return Promise.resolve(result);
});
}
}
exports.StorageApi = StorageApi;