@verdocs/js-sdk 2.0.11 → 2.0.12

package/Documents/Documents.d.ts

@@ -117,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;
@@ -195,7 +196,7 @@ export declare const getDocument: (endpoint: VerdocsEndpoint, documentId: string
 /**
  * Cancel a Document.
  */
-export declare const cancelDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<IDocument>;
+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).
  */

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/package.json

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