@verdocs/js-sdk 2.0.25 → 2.1.2

package/Templates/Pages.d.ts

@@ -17,6 +17,13 @@ export declare const editPage: (endpoint: VerdocsEndpoint, templateId: string, s
  * Get a page from a template.
  */
 export declare const getPage: (endpoint: VerdocsEndpoint, templateId: string, sequence: number, thumbnail?: boolean) => Promise<any>;
+export interface IPageImageResponse {
+    url: string;
+}
+/**
+ * Get a page image (PNG format) from a template.
+ */
+export declare const getPageImage: (endpoint: VerdocsEndpoint, templateId: string, sequence: number) => Promise<IPageImageResponse>;
 /**
  * Delete a page from a template
  */

package/Templates/Pages.js

@@ -23,6 +23,14 @@ export var getPage = function (endpoint, templateId, sequence, thumbnail) {
         .get("/templates/".concat(templateId, "/pages/").concat(sequence).concat(thumbnail ? '?thumbnail=true' : ''))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a page image (PNG format) from a template.
+ */
+export var getPageImage = function (endpoint, templateId, sequence) {
+    return endpoint.api //
+        .get("/templates/".concat(templateId, "/pages/").concat(sequence, "/image"))
+        .then(function (r) { return r.data; });
+};
 /**
  * Delete a page from a template
  */

package/Templates/Types.d.ts

@@ -1,26 +1,35 @@
 import { IOrganization } from '../Organizations/Types';
+/**
+ * A reusable template for creating signable instruments. Templates are used to create Envelopes which contain
+ * Documents to sign.
+ */
 export interface ITemplate {
-    template_document?: ITemplateDocument;
-    pages?: IPage[];
-    roles?: IRole[];
-    counter?: number;
-    star_counter?: number;
-    name: string;
     id: string;
-    profile_id?: string;
-    created_at?: string;
-    updated_at?: string;
-    last_used_at?: string;
+    name: string;
+    description?: string;
+    sender: TTemplateSender;
+    profile_id: string;
+    organization_id: string;
+    counter: number;
+    star_counter: number;
+    is_personal: boolean;
+    is_public: boolean;
+    created_at: string;
+    updated_at: string;
+    last_used_at: string;
     token?: string;
     reminder_id?: string;
     reminder?: IReminder;
-    organization_id?: string;
-    is_personal?: boolean;
-    is_public?: boolean;
-    sender?: TTemplateSender;
-    description?: string;
+    processed?: boolean;
     organization?: IOrganization;
+    roles?: IRole[];
+    pages?: IPage[];
+    template_document?: ITemplateDocument;
+    template_documents?: ITemplateDocument[];
 }
+/**
+ * Some template search and list endpoints return only a partial set of fields for each entry via this structure.
+ */
 export interface ITemplateSummaryEntry {
     id: string;
     name: string;
@@ -124,6 +133,9 @@ export interface IStar {
     template_id: string;
     profile_id: string;
 }
+/**
+ * An individual recipient, CC, or other party in a signing flow.
+ */
 export interface IRole {
     template_id: string;
     name: string;
@@ -137,6 +149,9 @@ export interface IRole {
     phone?: string;
     rgba?: string;
 }
+/**
+ * A file attached to the template for display/signing.
+ */
 export interface ITemplateDocument {
     url: string;
     name: string;
@@ -174,10 +189,12 @@ export interface ITemplateFieldSetting {
 export interface IPage {
     template_id: string;
     document_id: string;
-    template_document?: ITemplateDocument;
     sequence: number;
     page_number: number;
     thumbnail_url: string;
+    image_uri?: string | null;
+    display_uri?: string | null;
+    template_document?: ITemplateDocument;
     fields?: ITemplateField[];
 }
 export interface IReminder {

package/package.json

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