notarize-node-client
Version:
Node.js Client for Notarize.com Business API
338 lines (337 loc) • 17.3 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
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());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.TransactionApi = void 0;
var snakecase_keys_1 = __importDefault(require("snakecase-keys"));
var TransactionApi = /** @class */ (function () {
function TransactionApi(client, options) {
this.client = client;
}
/*
* Function to take the id of a Transaction created in 'draft' mode, and
* start the notarization workflow by taking it *out* of 'draft' mode.
*/
TransactionApi.prototype.retrieve = function (id) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var resp;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.client.fire('GET', "transactions/".concat(id))];
case 1:
resp = _b.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: 'The indicated transaction does not exist',
}];
}
return [2 /*return*/, { success: resp.response.ok, transaction: resp.payload }];
}
});
});
};
/*
* Function to create a new Notarization Transaction that will start
* the process of the notarization workflow at Notarize.com.
*/
TransactionApi.prototype.create = function (doc) {
var _a, _b;
return __awaiter(this, void 0, void 0, function () {
var body, resp;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
// convert any resource values that are Buffers to Base64 strings
if (doc.documents && doc.documents.length > 0) {
doc.documents = doc.documents.map(function (ds) {
if (Buffer.isBuffer(ds.resource)) {
ds.resource = ds.resource.toString('base64');
}
return ds;
});
}
body = (0, snakecase_keys_1.default)(doc);
return [4 /*yield*/, this.client.fire('POST', 'transactions', undefined, body)];
case 1:
resp = _c.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: (_b = resp === null || resp === void 0 ? void 0 : resp.payload) === null || _b === void 0 ? void 0 : _b.error,
}];
}
return [2 /*return*/, { success: resp.response.ok, transaction: resp.payload }];
}
});
});
};
/*
* Function to take the id of a Meeting Record, aka Notarization Record
* from the Transaction, and return it to the caller. This is one part
* of the Transaction - the Notarization Meeting Record.
*/
TransactionApi.prototype.list = function (limit, offset) {
return __awaiter(this, void 0, void 0, function () {
var params, resp;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
params = { limit: limit || 10, offset: offset || 0 };
return [4 /*yield*/, this.client.fire('GET', 'transactions', params)];
case 1:
resp = _a.sent();
return [2 /*return*/, {
success: resp.response.ok,
count: resp.payload.count,
transactions: resp.payload.data,
}];
}
});
});
};
/*
* Function to add a document to an existing transaction, referenced by
* it's transaction id. This can only be done as long as the transaction
* is in the 'draft' state.
*/
TransactionApi.prototype.addDocument = function (id, doc) {
var _a, _b;
return __awaiter(this, void 0, void 0, function () {
var body, resp;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
// convert a Buffer resource value to Base64 string
if (doc && Buffer.isBuffer(doc.resource)) {
doc.resource = doc.resource.toString('base64');
}
body = (0, snakecase_keys_1.default)(doc);
return [4 /*yield*/, this.client.fire('POST', "transactions/".concat(id, "/documents"), undefined, body)];
case 1:
resp = _c.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: (_b = resp === null || resp === void 0 ? void 0 : resp.payload) === null || _b === void 0 ? void 0 : _b.error,
}];
}
return [2 /*return*/, { success: resp.response.ok, document: resp.payload }];
}
});
});
};
/*
* Function to update the Transaction indicated by the first argument with
* the optional values in the second - but *only* if the transaction is
* still in 'draft' status. If not, this will be an error.
*/
TransactionApi.prototype.update = function (id, doc) {
var _a, _b;
return __awaiter(this, void 0, void 0, function () {
var body, resp;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
body = (0, snakecase_keys_1.default)(doc);
return [4 /*yield*/, this.client.fire('PUT', "transactions/".concat(id), undefined, body)];
case 1:
resp = _c.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 422) {
return [2 /*return*/, {
success: resp.response.ok,
errors: (_b = resp === null || resp === void 0 ? void 0 : resp.payload) === null || _b === void 0 ? void 0 : _b.errors,
}];
}
return [2 /*return*/, { success: resp.response.ok, transaction: resp.payload }];
}
});
});
};
/*
* Function to take the id of a Transaction created in 'draft' mode, and
* start the notarization workflow by taking it *out* of 'draft' mode.
*/
TransactionApi.prototype.activate = function (id, suppressEmail) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var body, resp;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (suppressEmail !== null && suppressEmail !== undefined) {
body = (0, snakecase_keys_1.default)({ suppressEmail: suppressEmail });
}
return [4 /*yield*/, this.client.fire('POST', "transactions/".concat(id, "/notarization_ready"), undefined, body)];
case 1:
resp = _b.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: 'The indicated transaction does not exist',
}];
}
return [2 /*return*/, { success: resp.response.ok, transaction: resp.payload }];
}
});
});
};
/*
* Function to take the id of a Transaction at Notarize and delete it
* from their servers. This is a permanent act, and should be used with care.
*/
TransactionApi.prototype.delete = function (id) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var resp;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.client.fire('DELETE', "transactions/".concat(id))];
case 1:
resp = _b.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: 'The indicated transaction does not exist',
}];
}
return [2 /*return*/, __assign({ success: resp.response.ok }, resp.payload)];
}
});
});
};
/*
* Function to take the id of a Transaction and resend the email to the
* signer(s), just in case they deleted it, or lost it, and needed to
* have it again to proceed.
*/
TransactionApi.prototype.resendEmail = function (id, messageToSigner) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var body, resp;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (messageToSigner !== null && messageToSigner !== undefined) {
body = (0, snakecase_keys_1.default)({ messageToSigner: messageToSigner });
}
return [4 /*yield*/, this.client.fire('POST', "transactions/".concat(id, "/send_email"), undefined, body)];
case 1:
resp = _b.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: 'The indicated transaction does not exist',
}];
}
return [2 /*return*/, { success: resp.response.ok, transaction: resp.payload }];
}
});
});
};
/*
* Function to take the id of a Transaction and resend the email to the
* signer(s), just in case they deleted it, or lost it, and needed to
* have it again to proceed.
*/
TransactionApi.prototype.resendSms = function (id, phone) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var body, resp;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (phone !== null && phone !== undefined) {
body = (0, snakecase_keys_1.default)({ phone: phone });
}
return [4 /*yield*/, this.client.fire('POST', "transactions/".concat(id, "/send_sms"), undefined, body)];
case 1:
resp = _b.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: 'The indicated transaction does not exist',
}];
}
return [2 /*return*/, { success: resp.response.ok, transaction: resp.payload }];
}
});
});
};
/*
* Function to take the id of a Meeting Record, aka Notarization Record
* from the Transaction, and return it to the caller. This is one part
* of the Transaction - the Notarization Meeting Record.
*/
TransactionApi.prototype.retrieveMeetingRecord = function (id) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var resp;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, this.client.fire('GET', "notarization_records/".concat(id))];
case 1:
resp = _b.sent();
if (((_a = resp === null || resp === void 0 ? void 0 : resp.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
return [2 /*return*/, {
success: resp.response.ok,
error: 'The indicated transaction does not exist',
}];
}
return [2 /*return*/, { success: resp.response.ok, record: resp.payload }];
}
});
});
};
return TransactionApi;
}());
exports.TransactionApi = TransactionApi;