@verdocs/web-sdk 1.9.6 → 1.9.9

package/dist/components/VerdocsEndpoint.js

@@ -66,387 +66,6 @@ var decodeAccessTokenBody = function (token) {
     return decoded;
 };
 
-var __awaiter$1 = (undefined && undefined.__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$1 = (undefined && undefined.__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 (_) 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 };
-    }
-};
-/**
- * Create a document
- *
- * ```typescript
- * import {Documents, ICreateDocumentRole, ICreateDocumentRequest} from '@verdocs/js-sdk/Documents';
- *
- * const role1: ICreateDocumentRole = {
- *   type: 'signer',
- *   name: 'Seller',
- *   full_name: 'Paige Turner',
- *   email: 'paige.turner@nomail.com',
- *   phone: '',
- *   sequence: 1,
- *   delegator: false,
- *   message: '',
- * };
- *
- * const role2: ICreateDocumentRole = {
- *   type: 'signer',
- *   name: 'Buyer',
- *   full_name: 'Will Power',
- *   email: 'will.power@nomail.com',
- *   phone: '',
- *   sequence: 2,
- *   delegator: false,
- *   message: '',
- * };
- *
- * const request: ICreateDocumentRequest = {template_id: 'd2338742-f3a1-465b-8592-806587413cc1', name: 'Bill of Sale', roles: [role1, role2]};
- * const {id, recipients} = await Documents.createDocument(VerdocsEndpoint.getDefault(), request);
- * ```
- */
-var createDocument = function (endpoint, request) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/documents', request)
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a summary of currently active documents.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Documents';
- *
- * const {action_required, completed, waiting_on_others} = await Documents.getSummary(VerdocsEndpoint.getDefault());
- * ```
- */
-var getSummary = function (endpoint, page) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/documents/summary', { page: page })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Search for documents matching various criteria.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Documents';
- *
- * const {result, page, total} = await Documents.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-var searchDocuments = function (endpoint, params) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/documents/search', params)
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a signing session for a Document.
- */
-var getSigningSession = function (endpoint, params) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/documents/".concat(params.documentId, "/recipients/").concat(encodeURIComponent(params.roleId), "/invitation/").concat(params.inviteCode))
-                .then(function (r) {
-                var _a, _b;
-                // Avoiding a jsonwebtoken dependency here - we don't actually need the whole library
-                var signerToken = ((_a = r.headers) === null || _a === void 0 ? void 0 : _a.signer_token) || '';
-                var session = decodeAccessTokenBody(signerToken);
-                endpoint.setToken((_b = r.headers) === null || _b === void 0 ? void 0 : _b.signer_token);
-                return { recipient: r.data, session: session, signerToken: signerToken };
-            })];
-    });
-}); };
-/**
- * Get the list of recipients for a Document.
- */
-var getDocumentRecipients = function (endpoint, documentId) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/documents/".concat(documentId, "/recipients"))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get all metadata for a Document.
- */
-var getDocument = function (endpoint, documentId) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/documents/".concat(documentId))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Cancel a Document.
- */
-var cancelDocument = function (endpoint, documentId) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/documents/".concat(documentId), { action: 'cancel' })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
- */
-var recipientHasAction = function (recipient) { return !['submitted', 'canceled', 'declined'].includes(recipient.status); };
-/**
- * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
- */
-var getRecipientsWithActions = function (document) { return ((document === null || document === void 0 ? void 0 : document.recipients) || []).filter(recipientHasAction); };
-/**
- * Returns true if the recipient can act.
- */
-var recipientCanAct = function (recipient, recipientsWithActions) { var _a; return recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence); };
-/**
- * Returns true if the user can act.
- */
-var userCanAct = function (email, recipientsWithActions) {
-    var _a;
-    var recipient = recipientsWithActions.find(function (r) { return r.email === email; });
-    return recipient && recipient.sequence === ((_a = recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0]) === null || _a === void 0 ? void 0 : _a.sequence);
-};
-/**
- * Get (binary download) a file attached to a Document. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-var getDocumentFile = function (endpoint, documentId, envelopeDocumentId) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/documents/".concat(documentId, "/envelope_documents/").concat(envelopeDocumentId, "?file=true"), {
-                responseType: 'arraybuffer',
-            })
-                .then(function (r) { return Buffer.from(r.data, 'binary').toString('base64'); })];
-    });
-}); };
-/**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
- */
-var updateDocumentField = function (endpoint, documentId, fieldName, value) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/documents/".concat(documentId, "/fields/").concat(fieldName), value)
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
- * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
- */
-var updateDocumentFieldSignature = function (endpoint, documentId, fieldName, signatureId) { return __awaiter$1(void 0, void 0, void 0, function () {
-    return __generator$1(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/documents/".concat(documentId, "/fields/").concat(fieldName, "/signature/").concat(signatureId))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-
-const Documents$1 = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    createDocument: createDocument,
-    getSummary: getSummary,
-    searchDocuments: searchDocuments,
-    getSigningSession: getSigningSession,
-    getDocumentRecipients: getDocumentRecipients,
-    getDocument: getDocument,
-    cancelDocument: cancelDocument,
-    recipientHasAction: recipientHasAction,
-    getRecipientsWithActions: getRecipientsWithActions,
-    recipientCanAct: recipientCanAct,
-    userCanAct: userCanAct,
-    getDocumentFile: getDocumentFile,
-    updateDocumentField: updateDocumentField,
-    updateDocumentFieldSignature: updateDocumentFieldSignature
-});
-
-var __assign = (undefined && undefined.__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 = (undefined && undefined.__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 = (undefined && undefined.__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 (_) 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 };
-    }
-};
-/**
- * Update a recipient's status block
- */
-var updateRecipientStatus = function (endpoint, documentId, roleName, action, params) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/documents/".concat(documentId, "/recipients/").concat(roleName), __assign({ role_name: roleName, action: action }, (params || {})))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-var getSignerToken = function (endpoint, documentId, roleName) {
-    return endpoint.api //
-        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"))
-        .then(function (r) { return r.data; });
-};
-var getInPersonLink = function (endpoint, documentId, roleName) {
-    return endpoint.api //
-        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "?in_person_link=true"))
-        .then(function (r) { return r.data; });
-};
-
-const Recipients = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    updateRecipientStatus: updateRecipientStatus,
-    getSignerToken: getSignerToken,
-    getInPersonLink: getInPersonLink
-});
-
-/**
- * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
- * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
- * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
- * to be "stamped" by the user.
- */
-var createSignature = function (endpoint, name, signature) {
-    var data = new FormData();
-    data.append('signature', signature, name);
-    return endpoint.api //
-        .post("/signatures", data)
-        .then(function (r) { return r.data; });
-};
-/**
- * Get the availbable signatures for a user.
- */
-var getSignatures = function (endpoint) {
-    return endpoint.api //
-        .get('/signatures')
-        .then(function (r) { return r.data; });
-};
-/**
- * Get a user's signature by ID.
- */
-var getSignature = function (endpoint, signatureId) {
-    return endpoint.api //
-        .get("/signatures/".concat(signatureId))
-        .then(function (r) { return r.data; });
-};
-/**
- * Delete a user's signature.
- */
-var deleteSignature = function (endpoint, signatureId) {
-    return endpoint.api //
-        .delete("/signatures/".concat(signatureId))
-        .then(function (r) { return r.data; });
-};
-
-const Signatures = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    createSignature: createSignature,
-    getSignatures: getSignatures,
-    getSignature: getSignature,
-    deleteSignature: deleteSignature
-});
-
-/**
- * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
- * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
- * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
- * to be "stamped" by the user.
- */
-var createInitials = function (endpoint, name, initials) {
-    var data = new FormData();
-    data.append('initial', initials, name);
-    return endpoint.api //
-        .post("/initials", data)
-        .then(function (r) { return r.data; });
-};
-
-const Initials = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    createInitials: createInitials
-});
-
-const Types = /*#__PURE__*/Object.freeze({
-    __proto__: null
-});
-
-const Documents = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    Documents: Documents$1,
-    Recipients: Recipients,
-    Signatures: Signatures,
-    Initials: Initials,
-    Types: Types
-});
-
 var bind = function bind(fn, thisArg) {
   return function wrap() {
     var args = new Array(arguments.length);
@@ -2569,7 +2188,6 @@ var VerdocsEndpoint = /** @class */ (function () {
          * with Documents.
          */
         this.session = null;
-        this.Documents = Documents;
         this.baseURL = (options === null || options === void 0 ? void 0 : options.baseURL) || 'https://api.verdocs.com';
         this.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || 3000;
         this.environment = (options === null || options === void 0 ? void 0 : options.environment) || 'verdocs';
@@ -2809,6 +2427,6 @@ var VerdocsEndpoint = /** @class */ (function () {
     return VerdocsEndpoint;
 }());
 
-export { VerdocsEndpoint as V, getDocument as a, getDocumentFile as b, updateDocumentField as c, getSigningSession as g, updateRecipientStatus as u };
+export { VerdocsEndpoint as V, decodeAccessTokenBody as d };
 
 //# sourceMappingURL=VerdocsEndpoint.js.map