@verdocs/js-sdk 2.0.9 → 2.0.12

package/Documents/Documents.d.ts

@@ -8,9 +8,17 @@ export declare type TRecipientType = 'signer' | 'cc' | 'approver';
 export interface IDocumentsSearchResultEntry {
     id: string;
     canceled_at: string;
+    certificate_document_id: string;
     created_at: string;
+    envelope_document_id: string;
+    histories: IHistory[];
+    indexed_at: string;
     name: string;
+    no_contact: boolean;
+    organization_id: string;
     profile_id: string;
+    recipients: IRecipient[];
+    reminder_id: string | null;
     status: TDocumentStatus;
     next_recipient: {
         claimed: boolean;
@@ -109,6 +117,7 @@ export interface IDocument {
     fields?: IDocumentField[];
     profile?: IProfile;
 }
+export declare type TDocumentUpdateResult = Omit<IDocument, 'histories' | 'recipients' | 'certificate' | 'document' | 'fields' | 'profile'>;
 export interface IActivityEntry {
     id: string;
     name: string;
@@ -184,6 +193,26 @@ export declare const getDocumentRecipients: (endpoint: VerdocsEndpoint, document
  * 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.
  */

package/Documents/Documents.js

@@ -104,6 +104,36 @@ export var getDocument = function (endpoint, documentId) { return __awaiter(void
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Cancel a Document.
+ */
+export var cancelDocument = function (endpoint, documentId) { 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' })
+                .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).
+ */
+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 (document) { return ((document === null || document === void 0 ? void 0 : document.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);
+};
 /**
  * Get (binary download) a file attached to a Document.
  */

package/Documents/Recipients.d.ts

@@ -1,6 +1,6 @@
-import { IRecipient } from './Documents';
+import { IInPersonAccessKey, TRecipientAction } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
-export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
+import { IDocument, IRecipient } from './Documents';
 export interface IUpdateRecipientParams {
     new_full_name?: string;
     agreed?: boolean;
@@ -9,3 +9,10 @@ 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 interface ISignerTokenResponse {
+    recipient: IRecipient;
+    envelope: IDocument;
+    signerToken: string;
+    inPersonAccessKey: IInPersonAccessKey;
+}
+export declare const getSignerToken: (endpoint: VerdocsEndpoint, documentId: string, roleName: string) => Promise<import("axios").AxiosResponse<ISignerTokenResponse, any>>;

package/Documents/Recipients.js

@@ -55,3 +55,7 @@ export var updateRecipientStatus = function (endpoint, documentId, roleName, act
                 .then(function (r) { return r.data; })];
     });
 }); };
+export var getSignerToken = function (endpoint, documentId, roleName) {
+    return endpoint.api //
+        .get("/documents/".concat(documentId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"));
+};

package/Documents/Types.d.ts

@@ -1,3 +1,4 @@
+export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
 export interface ITemplateSummaryEntry {
     id: string;
     name: string;
@@ -41,3 +42,14 @@ export interface ISigningSession {
     iat: number;
     [key: string]: any;
 }
+export interface IInPersonAccessKey {
+    id: string;
+    created_at: string;
+    recipient_name: string;
+    envelope_id: string;
+    type: 'in_person_link';
+    key: string;
+    expiration_date: string | null;
+    first_used: string | null;
+    last_used: string | null;
+}

package/Organizations/Groups.d.ts

@@ -28,7 +28,7 @@ export declare const getGroups: (endpoint: VerdocsEndpoint, organizationId: stri
  * const groups = await Groups.getGroups(ORGID);
  * ```
  */
-export declare const getGroupByName: (endpoint: VerdocsEndpoint, organizationId: string, name?: string) => Promise<IGroup>;
+export declare const getGroupByName: (endpoint: VerdocsEndpoint, organizationId: string, name?: string) => Promise<IGroupDetail>;
 /**
  * Get the details for a group.
  *

package/Organizations/Types.d.ts

@@ -51,8 +51,25 @@ export interface IGroup {
     /** Some operations will additionally return a list of profiles. */
     profiles?: IProfile[];
 }
-export interface IGroupDetail extends IGroup {
-    permissions: TPermission[];
-    roles: TRole[];
+export interface IPermissionDetail {
+    id: string;
+    name: string;
+    client_id: string;
+}
+export interface IRoleDetail {
+    id: string;
+    name: string;
+    client_id: string;
+}
+export interface IGroupDetail {
+    id: string;
+    name: string;
+    organization_id: string;
+    permissions: IPermissionDetail[];
+    roles: IRoleDetail[];
     profiles: IProfile[];
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent: IGroup | null;
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent_id: string | null;
 }

package/package.json

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