@verdocs/js-sdk 2.1.2 → 3.0.1

package/Envelopes/Envelopes.d.ts

@@ -0,0 +1,113 @@
+import { IEnvelope, IEnvelopesSummary, IRecipient, ISigningSession, TEnvelopeUpdateResult, IDocumentFieldSettings } from './Types';
+import { ICreateEnvelopeRole, IEnvelopesSearchResult, ISigningSessionRequest } from './Types';
+import { VerdocsEndpoint } from '../VerdocsEndpoint';
+export interface ICreateEnvelopeRequest {
+    template_id: string;
+    roles: ICreateEnvelopeRole[];
+    name: string;
+}
+/**
+ * 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 declare const createEnvelope: (endpoint: VerdocsEndpoint, request: ICreateEnvelopeRequest) => Promise<IEnvelope>;
+/**
+ * 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 declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<IEnvelopesSummary>;
+/**
+ * Search for envelopes matching various criteria.
+ *
+ * ```typescript
+ * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ *
+ * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
+ * ```
+ */
+export declare const searchEnvelopes: (endpoint: VerdocsEndpoint, params: any) => Promise<IEnvelopesSearchResult>;
+export interface ISigningSessionResult {
+    recipient: IRecipient;
+    session: ISigningSession;
+    signerToken: string;
+}
+/**
+ * Get a signing session for an Envelope.
+ */
+export declare const getSigningSession: (endpoint: VerdocsEndpoint, params: ISigningSessionRequest) => Promise<ISigningSessionResult>;
+/**
+ * Get the list of recipients for an Envelope.
+ */
+export declare const getEnvelopeRecipients: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IRecipient[]>;
+/**
+ * Get all metadata for an Envelope.
+ */
+export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IEnvelope>;
+/**
+ * Cancel an Envelope.
+ */
+export declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<TEnvelopeUpdateResult>;
+/**
+ * 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) => 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;
+/**
+ * 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 declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
+/**
+ * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ */
+export declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, value: any) => Promise<IDocumentFieldSettings>;
+/**
+ * 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 declare const updateEnvelopeFieldSignature: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, signatureId: string) => Promise<IDocumentFieldSettings>;

package/{Documents/Documents.js → Envelopes/Envelopes.js}

@@ -36,12 +36,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 import { decodeAccessTokenBody } from '../Utils/Token';
 /**
- * Create a document
+ * Create an envelope
  *
  * ```typescript
- * import {Documents, ICreateDocumentRole, ICreateDocumentRequest} from '@verdocs/js-sdk/Documents';
+ * import {Envelopes, ICreateEnvelopeRole, ICreateEnvelopeRequest} from '@verdocs/js-sdk/Envelopes';
  *
- * const role1: ICreateDocumentRole = {
+ * const role1: ICreateEnvelopeRole = {
  *   type: 'signer',
  *   name: 'Seller',
  *   full_name: 'Paige Turner',
@@ -52,7 +52,7 @@ import { decodeAccessTokenBody } from '../Utils/Token';
  *   message: '',
  * };
  *
- * const role2: ICreateDocumentRole = {
+ * const role2: ICreateEnvelopeRole = {
  *   type: 'signer',
  *   name: 'Buyer',
  *   full_name: 'Will Power',
@@ -63,56 +63,56 @@ import { decodeAccessTokenBody } from '../Utils/Token';
  *   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);
+ * 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 createDocument = function (endpoint, request) { return __awaiter(void 0, void 0, void 0, function () {
+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('/documents', request)
+                .post('/envelopes', request)
                 .then(function (r) { return r.data; })];
     });
 }); };
 /**
- * Get a summary of currently active documents.
+ * Get a summary of currently active envelopes.
  *
  * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Documents';
+ * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * const {action_required, completed, waiting_on_others} = await Documents.getSummary(VerdocsEndpoint.getDefault());
+ * 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('/documents/summary', { page: page })
+                .post('/envelopes/summary', { page: page })
                 .then(function (r) { return r.data; })];
     });
 }); };
 /**
- * Search for documents matching various criteria.
+ * Search for envelopes matching various criteria.
  *
  * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Documents';
+ * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * const {result, page, total} = await Documents.search(VerdocsEndpoint.getDefault(), { ... });
+ * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
  * ```
  */
-export var searchDocuments = function (endpoint, params) { return __awaiter(void 0, void 0, void 0, function () {
+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('/documents/search', params)
+                .post('/envelopes/search', params)
                 .then(function (r) { return r.data; })];
     });
 }); };
 /**
- * Get a signing session for a Document.
+ * 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) {
         return [2 /*return*/, endpoint.api //
-                .get("/documents/".concat(params.documentId, "/recipients/").concat(encodeURIComponent(params.roleId), "/invitation/").concat(params.inviteCode))
+                .get("/envelopes/".concat(params.envelopeId, "/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
@@ -124,32 +124,32 @@ export var getSigningSession = function (endpoint, params) { return __awaiter(vo
     });
 }); };
 /**
- * Get the list of recipients for a Document.
+ * Get the list of recipients for an Envelope.
  */
-export var getDocumentRecipients = function (endpoint, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+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("/documents/".concat(documentId, "/recipients"))
+                .get("/envelopes/".concat(envelopeId, "/recipients"))
                 .then(function (r) { return r.data; })];
     });
 }); };
 /**
- * Get all metadata for a Document.
+ * Get all metadata for an Envelope.
  */
-export var getDocument = function (endpoint, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+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("/documents/".concat(documentId))
+                .get("/envelopes/".concat(envelopeId))
                 .then(function (r) { return r.data; })];
     });
 }); };
 /**
- * Cancel a Document.
+ * Cancel an Envelope.
  */
-export var cancelDocument = function (endpoint, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+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("/documents/".concat(documentId), { action: 'cancel' })
+                .put("/envelopes/".concat(envelopeId), { action: 'cancel' })
                 .then(function (r) { return r.data; })];
     });
 }); };
@@ -160,7 +160,7 @@ export var recipientHasAction = function (recipient) { return !['submitted', 'ca
 /**
  * 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 (document) { return ((document === null || document === void 0 ? void 0 : document.recipients) || []).filter(recipientHasAction); };
+export var getRecipientsWithActions = function (envelope) { return ((envelope === null || envelope === void 0 ? void 0 : envelope.recipients) || []).filter(recipientHasAction); };
 /**
  * Returns true if the recipient can act.
  */
@@ -174,14 +174,14 @@ export var userCanAct = function (email, recipientsWithActions) {
     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
+ * 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 getDocumentFile = function (endpoint, documentId, envelopeDocumentId) { return __awaiter(void 0, void 0, void 0, function () {
+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("/documents/".concat(documentId, "/envelope_documents/").concat(envelopeDocumentId, "?file=true"), {
+                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?file=true"), {
                 responseType: 'arraybuffer',
             })
                 .then(function (r) { return Buffer.from(r.data, 'binary').toString('base64'); })];
@@ -190,10 +190,10 @@ export var getDocumentFile = function (endpoint, documentId, envelopeDocumentId)
 /**
  * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
  */
-export var updateDocumentField = function (endpoint, documentId, fieldName, value) { return __awaiter(void 0, void 0, void 0, function () {
+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("/documents/".concat(documentId, "/fields/").concat(fieldName), value)
+                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName), value)
                 .then(function (r) { return r.data; })];
     });
 }); };
@@ -201,10 +201,10 @@ export var updateDocumentField = function (endpoint, documentId, fieldName, valu
  * 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 updateDocumentFieldSignature = function (endpoint, documentId, fieldName, signatureId) { return __awaiter(void 0, void 0, void 0, function () {
+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("/documents/".concat(documentId, "/fields/").concat(fieldName, "/signature/").concat(signatureId))
+                .put("/envelopes/".concat(envelopeId, "/fields/").concat(fieldName, "/signature/").concat(signatureId))
                 .then(function (r) { return r.data; })];
     });
 }); };

package/{Documents → Envelopes}/Recipients.d.ts

@@ -1,6 +1,6 @@
 import { IInPersonAccessKey, TRecipientAction } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
-import { IDocument, IRecipient } from './Types';
+import { IEnvelope, IRecipient } from './Types';
 export interface IUpdateRecipientParams {
     new_full_name?: string;
     agreed?: boolean;
@@ -8,12 +8,12 @@ export interface IUpdateRecipientParams {
 /**
  * Update a recipient's status block
  */
-export declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, documentId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams) => Promise<IRecipient>;
+export declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams) => Promise<IRecipient>;
 export interface ISignerTokenResponse {
     recipient: IRecipient;
-    envelope: IDocument;
+    envelope: IEnvelope;
     signerToken: string;
     inPersonAccessKey: IInPersonAccessKey;
 }
-export declare const getSignerToken: (endpoint: VerdocsEndpoint, documentId: string, roleName: string) => Promise<ISignerTokenResponse>;
-export declare const getInPersonLink: (endpoint: VerdocsEndpoint, documentId: string, roleName: string) => Promise<ISignerTokenResponse>;
+export declare const getSignerToken: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<ISignerTokenResponse>;
+export declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<ISignerTokenResponse>;

package/{Documents → Envelopes}/Recipients.js

@@ -48,20 +48,20 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 /**
  * Update a recipient's status block
  */
-export var updateRecipientStatus = function (endpoint, documentId, roleName, action, params) { return __awaiter(void 0, void 0, void 0, function () {
+export var updateRecipientStatus = function (endpoint, envelopeId, 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 || {})))
+                .put("/envelopes/".concat(envelopeId, "/recipients/").concat(roleName), __assign({ role_name: roleName, action: action }, (params || {})))
                 .then(function (r) { return r.data; })];
     });
 }); };
-export var getSignerToken = function (endpoint, documentId, roleName) {
+export var getSignerToken = function (endpoint, envelopeId, roleName) {
     return endpoint.api //
-        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"))
+        .get("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"))
         .then(function (r) { return r.data; });
 };
-export var getInPersonLink = function (endpoint, documentId, roleName) {
+export var getInPersonLink = function (endpoint, envelopeId, roleName) {
     return endpoint.api //
-        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "?in_person_link=true"))
+        .get("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "?in_person_link=true"))
         .then(function (r) { return r.data; });
 };

package/{Documents → Envelopes}/Types.d.ts

@@ -1,36 +1,13 @@
 import { IProfile } from '../Users/Types';
 export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
-export interface ITemplateSummaryEntry {
-    id: string;
-    name: string;
-    sender: string;
-    counter: number;
-    description: string | null;
-    created_at: string;
-    updated_at: string;
-    is_personal: boolean;
-    is_public: boolean;
-    profile_id: string;
-    organization_id: string;
-    last_used_at: string | null;
-    document_name: string | null;
-    star_counter: number;
-    tag_name: string | null;
-    is_starred: boolean;
-}
-export interface ITemplatesSummary {
-    page: number;
-    total: number;
-    result: ITemplateSummaryEntry[];
-}
 export interface ISigningSessionRequest {
-    documentId: string;
+    envelopeId: string;
     roleId: string;
     inviteCode: string;
 }
 export interface ISigningSession {
     profile_id: string;
-    document_id: string;
+    envelope_id: string;
     role: string;
     email: string;
     access_key: {
@@ -54,15 +31,16 @@ export interface IInPersonAccessKey {
     first_used: string | null;
     last_used: string | null;
 }
-export declare type TDocumentStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
+export declare type TEnvelopeStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
 export declare type TRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted' | 'canceled' | 'pending' | 'declined';
 export declare type TRecipientType = 'signer' | 'cc' | 'approver';
-export interface IDocumentsSearchResultEntry {
+export interface IEnvelopesSearchResultEntry {
     id: string;
     canceled_at: string;
     certificate_document_id: string;
-    created_at: string;
+    /** @deprecated. New envelopes may have more than one document attached. */
     envelope_document_id: string;
+    created_at: string;
     histories: IHistory[];
     indexed_at: string;
     name: string;
@@ -71,7 +49,7 @@ export interface IDocumentsSearchResultEntry {
     profile_id: string;
     recipients: IRecipient[];
     reminder_id: string | null;
-    status: TDocumentStatus;
+    status: TEnvelopeStatus;
     next_recipient: {
         claimed: boolean;
         email: string;
@@ -84,12 +62,12 @@ export interface IDocumentsSearchResultEntry {
     total_count: number;
     updated_at: string;
 }
-export interface IDocumentsSearchResult {
+export interface IEnvelopesSearchResult {
     page: number;
     total: number;
-    result: IDocumentsSearchResultEntry[];
+    result: IEnvelopesSearchResultEntry[];
 }
-export interface IDocumentsSummary {
+export interface IEnvelopesSummary {
     action_required: {
         page: number;
         total: number;
@@ -121,13 +99,19 @@ export interface IRecipient {
     phone: string | null;
     profile_id: string;
     role_name: string;
+    /**
+     * The sequence number indicates the order in which recipients act. Note that it is the workflow "level" not the
+     * recipient's individual index in the list. There may be multiple recipients with the same sequence. Recipients
+     * with the same sequence number may act independently, in parallel to each other (co-signers), as long as all
+     * Recipients with an earlier sequence number have completed their tasks.
+     */
     sequence: number;
     status: TRecipientStatus;
     type: TRecipientType;
     updated_at: string;
     fields?: IDocumentField[];
 }
-export interface IDocumentAsset {
+export interface IEnvelopeDocument {
     created_at: string;
     id: string;
     mime: string;
@@ -137,11 +121,17 @@ export interface IDocumentAsset {
     url: string;
 }
 export interface IDocumentFieldOptions {
+    /** The unique ID of the field */
     id: string;
+    /** The X position of the field on the page. Self-placed fields will have an X value of 0. */
     x: number;
+    /** The Y position of the field on the page. Self-placed fields will have an X value of 0. */
     y: number;
+    /** For checkboxes, whether it is currently checked */
     checked?: boolean;
+    /** For radio buttons, whether it is currently selected */
     selected?: boolean;
+    /** The visible label for the field e.g. 'Not Applicable' */
     value: string;
 }
 export interface IDocumentFieldSettings {
@@ -151,55 +141,79 @@ export interface IDocumentFieldSettings {
     width?: number;
     height?: number;
     value?: number | string;
+    /** If the field has been filled in, this contains the current value */
     result?: any;
+    /** Text field settings */
     leading?: number;
     alignment?: number;
     upperCase?: boolean;
+    /** Dropdowns, checkboxes, radio groups */
     options?: IDocumentFieldOptions[];
+    /** Signatures and Initials, result will be "signed" */
     base64?: string;
     hash?: string;
     ip_address?: string;
     signature_id?: string;
     signed_at?: string;
+    /** Checkbox settings */
     minimum_checked?: number;
     maximum_checked?: number;
     [key: string]: any;
 }
 export declare type TDocumentFieldType = 'signature' | 'initial' | 'checkbox_group' | 'radio_button_group' | 'textbox' | 'timestamp' | 'date' | 'dropdown' | 'textarea' | 'attachment' | 'payment';
 export interface IDocumentField {
+    /**
+     * The ID of the document the field is for. For historical reasons, this is called `envelope_id` because documents
+     * were previously called envelopes.
+     */
     envelope_id: string;
+    /** The machine name of the field, e.g. `checkbox_groupP1-18` */
     name: string;
+    /** If set, the placeholder/label for the field. */
     label: string | null;
+    /** The 1-based page number the field is displayed on. "Self-placed" fields that the user must apply will be on page 0. */
     page: number;
+    /** The ID of the role in the recipients list, e.g. `Recipient 2` */
     recipient_role: string;
+    /** The type of the field */
     type: TDocumentFieldType;
+    /** If true, the field will be required */
     required: boolean;
     settings?: IDocumentFieldSettings;
     validator: string | null;
+    /** Not sent by the server. Used in the UI to identify prepared fields. */
     prepared?: boolean;
 }
-export interface IDocument {
+/**
+ * An Envelope is a workflow wrapper that shepherds one or more Documents through the various recipients in a signing
+ * process.
+ */
+export interface IEnvelope {
     id: string;
+    template_id: string;
+    name: string;
+    status: TEnvelopeStatus;
+    profile_id: string;
+    organization_id: string | null;
+    no_contact: boolean;
     created_at: string;
+    updated_at: string;
     canceled_at: string;
+    reminder_id: string | null;
+    /** @deprecated. New envelopes will support more than one document attachment so new code should no longer refer to this field. */
     envelope_document_id: string;
     certificate_document_id: string | null;
     histories: IHistory[];
     recipients: IRecipient[];
-    name: string;
-    no_contact: boolean;
-    profile_id: string;
-    reminder_id: string | null;
-    status: TDocumentStatus;
-    template_id: string;
-    updated_at: string;
-    organization_id: string | null;
-    certificate?: IDocumentAsset | null;
-    document?: IDocumentAsset | null;
-    fields?: IDocumentField[];
     profile?: IProfile | null;
+    certificate?: IEnvelopeDocument | null;
+    /** @deprecated. New code should use `documents[]`. */
+    document?: IEnvelopeDocument | null;
+    /** Documents attached to this envelope */
+    documents?: IEnvelopeDocument[] | null;
+    fields?: IDocumentField[];
 }
-export declare type TDocumentUpdateResult = Omit<IDocument, 'histories' | 'recipients' | 'certificate' | 'document' | 'fields' | 'profile'>;
+export declare type TEnvelopeUpdateResult = Omit<IEnvelope, 'histories' | 'recipients' | 'certificate' | 'document' | 'fields' | 'profile'>;
 export interface IActivityEntry {
     id: string;
     name: string;
@@ -207,7 +221,7 @@ export interface IActivityEntry {
     created_at: string;
     updated_at: string;
     profile_id: string;
-    status: TDocumentStatus;
+    status: TEnvelopeStatus;
     template_id: string;
     recipient: {
         claimed: boolean;
@@ -233,23 +247,37 @@ export interface IDocumentSearchOptions {
     ascending?: boolean;
     is_owner?: boolean;
     is_recipient?: boolean;
-    envelope_status: TDocumentStatus[];
-    recipient_status: TDocumentStatus[];
+    envelope_status?: TEnvelopeStatus[];
+    recipient_status?: TEnvelopeStatus[];
 }
 export declare type THistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
 export declare type TEventDetail = 'in_app' | 'mail' | 'signer' | '';
-export interface ICreateDocumentRole {
+export interface ICreateEnvelopeRole {
+    /** The type of role to create. Most participants in standard flows will be "signer" recipients. */
     type: TRecipientType;
+    /**
+     * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
+     * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
+     */
     name: string;
+    /** The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
     full_name: string;
+    /** The email address of the recipient. One of `email` or `phone` must be provided. */
     email?: string;
+    /**
+     * The phone number of the recipient. One of `email` or `phone` must be provided. If `phone` is included, the
+     * recipient will receive an SMS notification for the document.
+     */
     phone?: string;
+    /**
+     *  The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients
+     *  are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel)
+     *  and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before
+     *  recipients at level "2" may act).
+     */
     sequence: number;
+    /** Whether the recipient may delegate their tasks to others. Should be false for most standard workflows. */
     delegator: boolean;
+    /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
     message: string;
 }
-export interface ICreateDocumentRequest {
-    template_id: string;
-    roles: ICreateDocumentRole[];
-    name: string;
-}

package/{Documents → Envelopes}/index.d.ts

@@ -1,4 +1,4 @@
-export * as Documents from './Documents';
+export * as Envelopes from './Envelopes';
 export * as Recipients from './Recipients';
 export * as Signatures from './Signatures';
 export * as Initials from './Initials';

package/{Documents → Envelopes}/index.js

@@ -1,4 +1,4 @@
-export * as Documents from './Documents';
+export * as Envelopes from './Envelopes';
 export * as Recipients from './Recipients';
 export * as Signatures from './Signatures';
 export * as Initials from './Initials';

package/Organizations/Types.d.ts

@@ -11,9 +11,28 @@ export interface IOrganization {
     is_business: boolean;
     /** If the organization is a business, its name. Note that a business name can be different from an organization name. */
     business_name: string | null;
+    /** @deprecated. The organization primary contact email address. */
     contact_email: string | null;
+    /** @deprecated. The organization's primary time zone. */
     timezone: string | null;
+    /**
+     * If a Template published by the Organization is configured to be usable to create new Envelopes by users outside that
+     * Organization (`sender: 'everyone_as_creator'`), and that action would trigger a billing event, this field controls
+     * who is reponsible for that cost. If set to TRUE, the Organization that owns the template will be billed for its use.
+     * If set to FALSE, the requestor pays.
+     *
+     * This is deprecated in favor of a future per-template approach. Please contact support@verdocs.com to discuss your
+     * application requirements if you plan to use this functionality for an immediate integration.
+     *
+     * @deprecated
+     */
     envelope_responsible: boolean;
+    /** Web site URL */
+    url: string | null;
+    /** Creation date/time. */
+    created_at: string;
+    /** Last-update date/time. */
+    updated_at: string;
 }
 export interface ICreateApiKeyRequest {
     name: string;

package/Search/Content.d.ts

@@ -1,7 +1,7 @@
 /**
  * Verdocs provides a range of search functions to help find and retrieve content. This module provides generic functions intended
  * to locate items across all content types. More specific retrievals may be performed using the various "list" endpoints within
- * each collection (e.g. {@link Documents.Documents.searchDocuments} or {@link Templates.Templates.searchTemplates}).
+ * each collection (e.g. {@link Envelopes.Envelopes.searchEnvelopes} or {@link Templates.Templates.searchTemplates}).
  *
  * @module
  */

package/Search/Content.js

@@ -1,7 +1,7 @@
 /**
  * Verdocs provides a range of search functions to help find and retrieve content. This module provides generic functions intended
  * to locate items across all content types. More specific retrievals may be performed using the various "list" endpoints within
- * each collection (e.g. {@link Documents.Documents.searchDocuments} or {@link Templates.Templates.searchTemplates}).
+ * each collection (e.g. {@link Envelopes.Envelopes.searchEnvelopes} or {@link Templates.Templates.searchTemplates}).
  *
  * @module
  */

package/Search/Types.d.ts

@@ -1,19 +1,19 @@
 import { TTemplateSender } from '../Templates/Types';
-import { TDocumentStatus } from '../Documents/Types';
+import { TEnvelopeStatus } from '../Envelopes/Types';
 export declare type TMimeType = 'application/pdf' | string;
 /**
  * An individual hit in a document search result. Note that this schema does not precisely match IDocument because fields
  * are optimized for search performance.
  */
-export interface IDocumentHit {
-    type: 'document';
+export interface IEnvelopeHit {
+    type: 'envelope';
     id: string;
     template_id: string;
     name: string;
     profile_id: string;
     organization_id: string;
     organization_name: string;
-    status: TDocumentStatus;
+    status: TEnvelopeStatus;
     recipient_emails: string[];
     recipient_names: string[];
     updated_at: string;
@@ -93,7 +93,7 @@ export interface ISearchResultCollection<T> {
     search_time_ms: number;
 }
 export interface ISearchResult {
-    documents: ISearchResultCollection<IDocumentHit>;
+    documents: ISearchResultCollection<IEnvelopeHit>;
     myTemplates: ISearchResultCollection<ITemplateHit>;
     publicTemplates: ISearchResultCollection<ITemplateHit>;
     organizations: ISearchResultCollection<IOrganizationHit>;

package/Sessions/Types.d.ts

@@ -0,0 +1,39 @@
+import { IProfile, TPermission, TPlan, TRole } from '../Users/Types';
+export interface ISigningSessionRequest {
+    envelopeId: string;
+    roleId: string;
+    inviteCode: string;
+}
+/** A Signing Session connects a caller to a role within an envelope, and can be used only for calls related to signing that envelope. */
+export interface ISigningSession {
+    profile_id: string;
+    envelope_id: string;
+    role: string;
+    email: string;
+    access_key: {
+        id: string;
+        type: string;
+    };
+    iss: string;
+    aud: string;
+    exp: number;
+    iat: number;
+    [key: string]: any;
+}
+/** A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform. */
+export interface IUserSession {
+    sub: string;
+    email: string;
+    email_verified: boolean;
+    iat: number;
+    exp: number;
+    permissions: TPermission[];
+    roles: TRole[];
+    profile: IProfile;
+    profile_id: string;
+    organization_id: string;
+    plans?: TPlan[];
+    [key: string]: any;
+}
+export declare type TSessionType = 'user' | 'signing';
+export declare type TSession = IUserSession | ISigningSession | null;

package/Sessions/Types.js

@@ -0,0 +1 @@
+export {};

package/Sessions/index.d.ts

@@ -0,0 +1 @@
+export * as Types from './Types';

package/Sessions/index.js

@@ -0,0 +1 @@
+export * as Types from './Types';

package/Users/Types.d.ts

@@ -29,6 +29,8 @@ export interface IProfile {
     phone: string | null;
     /** If true, this is the caller's "currently selected" profile. All operations will performed "as" this profile. */
     current: boolean;
+    created_at: string;
+    updated_at: string;
     /** The organization */
     organization?: IOrganization;
     /** The permissions assigned to the profilel _NOTE: Only present in the "current" profile._ */
@@ -40,20 +42,6 @@ export interface IProfile {
     /** The plans assigned to the profilel _NOTE: Only present in the "current" profile._ */
     groups?: IGroup[];
 }
-export interface IActiveSession {
-    sub: string;
-    email: string;
-    email_verified: boolean;
-    iat: number;
-    exp: number;
-    permissions: TPermission[];
-    roles: TRole[];
-    profile: IProfile;
-    profile_id: string;
-    organization_id: string;
-    plans?: TPlan[];
-    [key: string]: any;
-}
 export interface IRole {
     /** Unique identifier for the role. */
     id: string;

package/Utils/Token.d.ts

@@ -1,5 +1,5 @@
-import { ISigningSession } from '../Documents/Types';
-import { IActiveSession } from '../Users/Types';
+import { ISigningSession } from '../Envelopes/Types';
+import { IUserSession } from '../Sessions/Types';
 /**
  * Simplified, Node/Browser-safe alternative to atob() for base64 decoding.
  * Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js
@@ -17,4 +17,4 @@ export declare const decodeJWTBody: (token: string) => any;
  * application should distinguish between the two based on the context of the authenticated session, or by
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
-export declare const decodeAccessTokenBody: (token: string) => IActiveSession | ISigningSession | null;
+export declare const decodeAccessTokenBody: (token: string) => IUserSession | ISigningSession | null;

package/VerdocsEndpoint.d.ts

@@ -1,10 +1,6 @@
 import { AxiosInstance } from 'axios';
-import { ISigningSession } from './Documents/Types';
-import { IActiveSession } from './Users/Types';
-import * as Documents from './Documents';
+import { TSession, TSessionType } from './Sessions/Types';
 export declare type TEnvironment = 'verdocs' | 'verdocs-stage';
-export declare type TSessionType = 'user' | 'signing';
-export declare type TSession = IActiveSession | ISigningSession | null;
 export declare type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
 export interface VerdocsEndpointOptions {
     baseURL?: string;
@@ -51,7 +47,6 @@ export declare class VerdocsEndpoint {
      */
     session: TSession;
     api: AxiosInstance;
-    Documents: typeof Documents;
     /**
      * Create a new VerdocsEndpoint to call Verdocs platform services.
      *

package/VerdocsEndpoint.js

@@ -1,7 +1,6 @@
 import axios from 'axios';
 import { decodeAccessTokenBody } from './Utils/Token';
 import globalThis from './Utils/globalThis';
-import * as Documents from './Documents';
 // @credit https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
 // Also see globalThis for comments about why we're doing this in the first place.
 var ENDPOINT_KEY = Symbol.for('verdocs-default-endpoint');
@@ -56,7 +55,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';

package/index.d.ts

@@ -1,8 +1,7 @@
 /**
  * Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:
  *
- * - Documents - An individual document to be signed. Documents are created from templates.
- * - HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
+ * - Envelopes - An individual document to be signed. Documents are created from templates.
  * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
  * - Search - Various methods used to retrieve lists of documents and templtes.
  * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
@@ -11,10 +10,11 @@
  *
  * @module
  */
-export * as Documents from './Documents';
-export * as Templates from './Templates';
+export * as Envelopes from './Envelopes';
 export * as Organizations from './Organizations';
 export * as Search from './Search';
+export * as Sessions from './Sessions';
+export * as Templates from './Templates';
 export * as Users from './Users';
 export * as Utils from './Utils';
 export * from './VerdocsEndpoint';

package/index.js

@@ -1,8 +1,7 @@
 /**
  * Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:
  *
- * - Documents - An individual document to be signed. Documents are created from templates.
- * - HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
+ * - Envelopes - An individual document to be signed. Documents are created from templates.
  * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
  * - Search - Various methods used to retrieve lists of documents and templtes.
  * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
@@ -11,10 +10,11 @@
  *
  * @module
  */
-export * as Documents from './Documents';
-export * as Templates from './Templates';
+export * as Envelopes from './Envelopes';
 export * as Organizations from './Organizations';
 export * as Search from './Search';
+export * as Sessions from './Sessions';
+export * as Templates from './Templates';
 export * as Users from './Users';
 export * as Utils from './Utils';
 export * from './VerdocsEndpoint';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "2.1.2",
+  "version": "3.0.1",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",

package/Documents/Documents.d.ts

@@ -1,109 +0,0 @@
-import { ICreateDocumentRequest, IDocumentsSearchResult, ISigningSessionRequest } from './Types';
-import { IDocument, IDocumentsSummary, IRecipient, ISigningSession } from './Types';
-import { TDocumentUpdateResult, IDocumentFieldSettings } from './Types';
-import { VerdocsEndpoint } from '../VerdocsEndpoint';
-/**
- * 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);
- * ```
- */
-export declare const createDocument: (endpoint: VerdocsEndpoint, request: ICreateDocumentRequest) => Promise<IDocument>;
-/**
- * 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());
- * ```
- */
-export declare const getSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<IDocumentsSummary>;
-/**
- * Search for documents matching various criteria.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Documents';
- *
- * const {result, page, total} = await Documents.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-export declare const searchDocuments: (endpoint: VerdocsEndpoint, params: any) => Promise<IDocumentsSearchResult>;
-export interface ISigningSessionResult {
-    recipient: IRecipient;
-    session: ISigningSession;
-    signerToken: string;
-}
-/**
- * Get a signing session for a Document.
- */
-export declare const getSigningSession: (endpoint: VerdocsEndpoint, params: ISigningSessionRequest) => Promise<ISigningSessionResult>;
-/**
- * Get the list of recipients for a Document.
- */
-export declare const getDocumentRecipients: (endpoint: VerdocsEndpoint, documentId: string) => Promise<IRecipient[]>;
-/**
- * Get all metadata for a Document.
- */
-export declare const getDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<IDocument>;
-/**
- * Cancel a Document.
- */
-export declare const cancelDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<TDocumentUpdateResult>;
-/**
- * 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: (document: IDocument) => 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;
-/**
- * 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.
- */
-export declare const getDocumentFile: (endpoint: VerdocsEndpoint, documentId: string, envelopeDocumentId: string) => Promise<string>;
-/**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
- */
-export declare const updateDocumentField: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, value: any) => Promise<IDocumentFieldSettings>;
-/**
- * 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 declare const updateDocumentFieldSignature: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, signatureId: string) => Promise<IDocumentFieldSettings>;