@verdocs/js-sdk 3.10.29 → 4.0.0

package/Envelopes/Envelopes.js

@@ -1,339 +0,0 @@
-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 };
-    }
-};
-import { decodeAccessTokenBody } from '../Utils/Token';
-/**
- * Create an envelope
- *
- * ```typescript
- * import {Envelopes, ICreateEnvelopeRole, ICreateEnvelopeRequest} from '@verdocs/js-sdk/Envelopes';
- *
- * const role1: ICreateEnvelopeRole = {
- *   type: 'signer',
- *   name: 'Seller',
- *   full_name: 'Paige Turner',
- *   email: 'paige.turner@nomail.com',
- *   phone: '',
- *   sequence: 1,
- *   delegator: false,
- *   message: '',
- * };
- *
- * const role2: ICreateEnvelopeRole = {
- *   type: 'signer',
- *   name: 'Buyer',
- *   full_name: 'Will Power',
- *   email: 'will.power@nomail.com',
- *   phone: '',
- *   sequence: 2,
- *   delegator: false,
- *   message: '',
- * };
- *
- * const request: ICreateEnvelopeRequest = {template_id: 'd2338742-f3a1-465b-8592-806587413cc1', name: 'Bill of Sale', roles: [role1, role2]};
- * const {id, recipients} = await Envelopes.createEnvelope(VerdocsEndpoint.getDefault(), request);
- * ```
- */
-export var createEnvelope = function (endpoint, request) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/envelopes', request)
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a summary of currently active envelopes.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {action_required, completed, waiting_on_others} = await Envelopes.getSummary(VerdocsEndpoint.getDefault());
- * ```
- */
-export var getSummary = function (endpoint, page) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/envelopes/summary', { page: page })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Search for envelopes matching various criteria.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-export var searchEnvelopes = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .post('/envelopes/search', params)
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a signing session for an Envelope.
- */
-export var getSigningSession = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        window.console.log('[JS_SDK] getSigningSession', params, endpoint.api);
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(params.envelopeId, "/recipients/").concat(encodeURIComponent(params.roleId), "/invitation/").concat(params.inviteCode))
-                .then(function (r) {
-                var _a;
-                // 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(signerToken);
-                return { recipient: r.data, session: session, signerToken: signerToken };
-            })];
-    });
-}); };
-/**
- * Get the list of recipients for an Envelope.
- */
-export var getEnvelopeRecipients = function (endpoint, envelopeId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/recipients"))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get all metadata for an Envelope.
- */
-export var getEnvelope = function (endpoint, envelopeId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get an Envelope Document
- */
-export var getEnvelopeDocument = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a pre-signed download link for an Envelope Document. This link expires quickly, so it should
- * be accessed immediately and never shared. Content-Disposition will be set to "download".
- */
-export var getDocumentDownloadLink = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?download=true"))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
- * be accessed immediately and never shared. Content-Disposition will be set to "inline".
- */
-export var getDocumentPreviewLink = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?preview=true"))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Cancel an Envelope.
- */
-export var cancelEnvelope = function (endpoint, envelopeId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId), { action: 'cancel' })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get (binary download) a file attached to an Envelope. It is important to use this method
- * rather than a direct A HREF or similar link to set the authorization headers for the
- * request.
- */
-export var getEnvelopeFile = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?file=true"), { responseType: 'blob' })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
- */
-export var updateEnvelopeField = function (endpoint, envelopeId, fieldName, value) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId, "/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.
- */
-export var updateEnvelopeFieldSignature = function (endpoint, envelopeId, fieldName, signatureId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/signature/").concat(signatureId))
-                .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.
- */
-export var updateEnvelopeFieldInitials = function (endpoint, envelopeId, fieldName, initialId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/initial/").concat(initialId))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Upload an attachment.
- */
-export var uploadEnvelopeFieldAttachment = function (endpoint, envelopeId, fieldName, file, onUploadProgress) { return __awaiter(void 0, void 0, void 0, function () {
-    var formData;
-    return __generator(this, function (_a) {
-        formData = new FormData();
-        formData.append('document', file, file.name);
-        return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName), formData, {
-                timeout: 120000,
-                onUploadProgress: function (event) {
-                    var total = event.total || 1;
-                    var loaded = event.loaded || 0;
-                    onUploadProgress === null || onUploadProgress === void 0 ? void 0 : onUploadProgress(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
-                },
-            })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Delete an attachment.
- */
-export var deleteEnvelopeFieldAttachment = function (endpoint, envelopeId, fieldName, file, onUploadProgress) { return __awaiter(void 0, void 0, void 0, function () {
-    var formData;
-    return __generator(this, function (_a) {
-        formData = new FormData();
-        // Omitting file is the trigger here
-        return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName), formData, {
-                timeout: 120000,
-                onUploadProgress: function (event) {
-                    var total = event.total || 1;
-                    var loaded = event.loaded || 0;
-                    onUploadProgress === null || onUploadProgress === void 0 ? void 0 : onUploadProgress(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
-                },
-            })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get the attached file for an attachment field (if any)
- */
-export var getFieldAttachment = function (endpoint, envelopeId, fieldName) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/document"), { responseType: 'blob' })
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get all of the envelopes that were sent using a given template.
- * NOTE: This endpoint will be retired soon. Its response is not paginated and it is typically used only to retrieve
- * "submitted data" for a template. A new endpoint will be introduced to provide this function more directly.
- * @deprecated
- */
-export var getEnvelopesByTemplateId = function (endpoint, templateId) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        return [2 /*return*/, endpoint.api //
-                .get("/envelopes?template_id=".concat(templateId))
-                .then(function (r) { return r.data; })];
-    });
-}); };
-/**
- * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
- * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
- * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
- */
-export var getEnvelopeDocumentPageDisplayUri = function (endpoint, envelopeId, documentId, page, type) {
-    if (type === void 0) { type = 'original'; }
-    return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, endpoint.api
-                    .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "/pages/").concat(page, "/image?type=").concat(type), { timeout: 20000 })
-                    .then(function (r) { return r.data; })];
-        });
-    });
-};
-var cachedEnvelopes = {};
-/**
- * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-export var throttledGetEnvelope = function (endpoint, envelopeId) {
-    if (cachedEnvelopes[envelopeId] && cachedEnvelopes[envelopeId].loaded + 2000 < new Date().getTime()) {
-        return cachedEnvelopes[envelopeId].envelope;
-    }
-    return getEnvelope(endpoint, envelopeId).then(function (envelope) {
-        cachedEnvelopes[envelopeId] = { loaded: new Date().getTime(), envelope: envelope };
-        return envelope;
-    });
-};
-/**a
- * Lists all envelopes accessible by the caller, with optional filters.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
- * ```
- */
-export var listEnvelopes = function (endpoint, params) {
-    return endpoint.api //
-        .post('/envelopes/list', params)
-        .then(function (r) { return r.data; });
-};

package/Envelopes/Initials.d.ts

@@ -1,15 +0,0 @@
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export interface IInitials {
-    id?: string;
-    profile_id: string;
-    url: string;
-    created_at?: string;
-    updated_at?: string;
-}
-/**
- * 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.
- */
-export declare const createInitials: (endpoint: VerdocsEndpoint, name: string, initials: Blob) => Promise<IInitials>;

package/Envelopes/Initials.js

@@ -1,13 +0,0 @@
-/**
- * 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.
- */
-export 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; });
-};

package/Envelopes/Permissions.d.ts

@@ -1,52 +0,0 @@
-/**
- * Various helpers to identify available operations for an envelope by a user.
- *
- * @module
- */
-import { IEnvelope, IEnvelopeSummary, IRecipient } from './Types';
-import { TSession } from '../Sessions/Types';
-/**
- * Check to see if the user owns the envelope.
- */
-export declare const userIsEnvelopeOwner: (session: TSession, envelope: IEnvelope | IEnvelopeSummary) => boolean;
-/**
- * Check to see if the user owns the envelope.
- */
-export declare const userIsEnvelopeRecipient: (session: TSession, envelope: IEnvelope | IEnvelopeSummary) => boolean;
-/**
- * Check to see if the envelope has pending actions.
- */
-export declare const envelopeIsActive: (envelope: IEnvelope | IEnvelopeSummary) => boolean;
-/**
- * Check to see if the envelope has been completed.
- */
-export declare const envelopeIsComplete: (envelope: IEnvelope | IEnvelopeSummary) => boolean;
-/**
- * Check to see if the user owns the envelope.
- */
-export declare const userCanCancelEnvelope: (session: TSession, envelope: IEnvelope | IEnvelopeSummary) => boolean;
-/**
- * Check to see if the user owns the envelope.
- */
-export declare const userCanFinishEnvelope: (session: TSession, envelope: IEnvelope | IEnvelopeSummary) => boolean;
-/**
- * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
- */
-export declare const recipientHasAction: (recipient: IRecipient) => boolean;
-/**
- * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
- */
-export declare const getRecipientsWithActions: (envelope: IEnvelope | IEnvelopeSummary) => IRecipient[];
-/**
- * Returns true if the recipient can act.
- */
-export declare const recipientCanAct: (recipient: IRecipient, recipientsWithActions: IRecipient[]) => boolean;
-/**
- * Returns true if the user can act.
- */
-export declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) => boolean | undefined;
-/**
- * Returns true if the user can act.
- */
-export declare const userCanSignNow: (session: TSession, envelope: IEnvelope | IEnvelopeSummary) => boolean | undefined;
-export declare const getNextRecipient: (envelope: IEnvelope | IEnvelopeSummary) => IRecipient;

package/Envelopes/Permissions.js

@@ -1,84 +0,0 @@
-/**
- * Various helpers to identify available operations for an envelope by a user.
- *
- * @module
- */
-import { EnvelopeStates } from './Types';
-/**
- * Check to see if the user owns the envelope.
- */
-export var userIsEnvelopeOwner = function (session, envelope) {
-    return envelope.profile_id === (session === null || session === void 0 ? void 0 : session.profile_id);
-};
-/**
- * Check to see if the user owns the envelope.
- */
-export var userIsEnvelopeRecipient = function (session, envelope) {
-    return envelope.profile_id === (session === null || session === void 0 ? void 0 : session.profile_id);
-};
-/**
- * Check to see if the envelope has pending actions.
- */
-export var envelopeIsActive = function (envelope) {
-    return envelope.status !== EnvelopeStates.COMPLETE && envelope.status !== EnvelopeStates.DECLINED && envelope.status !== EnvelopeStates.CANCELED;
-};
-/**
- * Check to see if the envelope has been completed.
- */
-export var envelopeIsComplete = function (envelope) { return envelope.status !== EnvelopeStates.COMPLETE; };
-/**
- * Check to see if the user owns the envelope.
- */
-export var userCanCancelEnvelope = function (session, envelope) {
-    return userIsEnvelopeOwner(session, envelope) &&
-        envelope.status !== EnvelopeStates.COMPLETE &&
-        envelope.status !== EnvelopeStates.DECLINED &&
-        envelope.status !== EnvelopeStates.CANCELED;
-};
-/**
- * Check to see if the user owns the envelope.
- */
-export var userCanFinishEnvelope = function (session, envelope) {
-    return userIsEnvelopeOwner(session, envelope) &&
-        envelope.status !== EnvelopeStates.COMPLETE &&
-        envelope.status !== EnvelopeStates.DECLINED &&
-        envelope.status !== EnvelopeStates.CANCELED;
-};
-/**
- * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
- */
-export 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).
- */
-export var getRecipientsWithActions = function (envelope) { return ((envelope === null || envelope === void 0 ? void 0 : envelope.recipients) || []).filter(recipientHasAction); };
-/**
- * Returns true if the recipient can act.
- */
-export 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.
- */
-export 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);
-};
-/**
- * Returns true if the user can act.
- */
-export var userCanSignNow = function (session, envelope) {
-    if (!session) {
-        return false;
-    }
-    var recipientsWithActions = getRecipientsWithActions(envelope);
-    var myRecipient = recipientsWithActions.find(function (r) { return r.profile_id === (session === null || session === void 0 ? void 0 : session.profile_id) || r.email === (session === null || session === void 0 ? void 0 : session.email); });
-    return (myRecipient &&
-        envelopeIsActive(envelope) &&
-        userIsEnvelopeRecipient(session, envelope) &&
-        recipientCanAct(myRecipient, recipientsWithActions));
-};
-export var getNextRecipient = function (envelope) {
-    var recipientsWithActions = getRecipientsWithActions(envelope);
-    return recipientsWithActions === null || recipientsWithActions === void 0 ? void 0 : recipientsWithActions[0];
-};

package/Envelopes/Recipients.d.ts

@@ -1,89 +0,0 @@
-import { IEnvelope, IRecipient, IInPersonAccessKey, TAccessKey } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export interface IUpdateRecipientSubmitParams {
-    action: 'submit';
-}
-export interface IUpdateRecipientDeclineParams {
-    action: 'decline';
-}
-export interface IUpdateRecipientClaimEnvelope {
-    action: 'owner_update';
-    full_name: string;
-    email: string;
-}
-export interface IUpdateRecipientStatus {
-    new_full_name?: string;
-    agreed?: boolean;
-    action?: 'prepare' | 'update';
-}
-export interface IUpdateRecipientAgreedParams {
-    action: 'update';
-    agreed: boolean;
-}
-export interface IUpdateRecipientNameParams {
-    action: 'update';
-    new_full_name: string;
-}
-export interface IUpdateRecipientPrepareParams {
-    action: 'prepare';
-    recipients: IRecipient[];
-}
-/**
- * Update a recipient's status block
- */
-export declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
-/**
- * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
- */
-export declare const envelopeRecipientSubmit: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
-/**
- * Decline to complete an envelope (signing will not terminated).
- */
-export declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
-/**
- * Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
- */
-export declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, email: string, fullName: string) => Promise<IRecipient>;
-/**
- * Agree to electronic signing.
- */
-export declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, agreed: boolean) => Promise<IRecipient>;
-/**
- * Change a recipient's name.
- */
-export declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fullName: string) => Promise<IRecipient>;
-/**
- * Change a recipient's name.
- */
-export declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
-export interface ISignerTokenResponse {
-    recipient: IRecipient;
-    envelope: IEnvelope;
-    signerToken: string;
-    inPersonAccessKey: IInPersonAccessKey;
-}
-/**
- * Get a signing token.
- */
-export declare const getSignerToken: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<ISignerTokenResponse>;
-export interface IInPersonLinkResponse {
-    link: string;
-    envelope_id: string;
-    profile_id: string;
-    role_name: string;
-    access_key: string;
-    expiration_date: string;
-    type: TAccessKey;
-}
-/**
- * Get an in-person signing link.
- */
-export declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IInPersonLinkResponse>;
-/**
- * Send a delegation request.
- */
-export declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IEnvelope>;
-/**
- * Resend a recipient's invitation.
- */
-export declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;