@verdocs/js-sdk 3.0.1 → 3.0.2

package/Envelopes/Types.d.ts

@@ -1,4 +1,5 @@
 import { IProfile } from '../Users/Types';
+import { IPage } from '../Templates/Types';
 export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
 export interface ISigningSessionRequest {
     envelopeId: string;
@@ -34,6 +35,10 @@ export interface IInPersonAccessKey {
 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';
+/**
+ * One entry in an envelope search result.
+ * NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
+ */
 export interface IEnvelopesSearchResultEntry {
     id: string;
     canceled_at: string;
@@ -119,6 +124,7 @@ export interface IEnvelopeDocument {
     page_numbers: number;
     updated_at: string;
     url: string;
+    pages?: IPage[];
 }
 export interface IDocumentFieldOptions {
     /** The unique ID of the field */

package/Templates/Types.d.ts

@@ -162,6 +162,7 @@ export interface ITemplateDocument {
     template_id: string;
     mime: string;
     thumbnail_url: string;
+    pages?: IPage[];
 }
 export interface ITemplateField {
     name: string;
@@ -189,10 +190,20 @@ export interface ITemplateFieldSetting {
 export interface IPage {
     template_id: string;
     document_id: string;
+    /** Note: Page numbers are 1-based */
     sequence: number;
+    /** @deprecated. New code should use `sequence` */
     page_number: number;
     thumbnail_url: string;
+    /**
+     * The storage location for the page once rendered server-side. This can be used to determine whether a page has
+     * finished rendering, but cannot be accessed directly - client applications should use display_uri instead.
+     */
     image_uri?: string | null;
+    /**
+     * If the page was rendered server-side and the caller has access to view it, this will contain the signed URI
+     * to access it. Note that these URIs include short expirations and should never be cached.
+     */
     display_uri?: string | null;
     template_document?: ITemplateDocument;
     fields?: ITemplateField[];

package/package.json

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