@verdocs/js-sdk 4.1.0 → 4.1.1

package/dist/index.d.mts

@@ -281,6 +281,8 @@ interface IEnvelopeDocument {
     mime: string;
     created_at: string;
     updated_at: string;
+    // @deprecated. Use pages instead.
+    page_numbers: number;
     envelope?: IEnvelope | null;
     template_document?: ITemplateDocument | null;
     fields?: IEnvelopeField[];
@@ -561,6 +563,8 @@ interface ITemplate {
     roles?: IRole[];
     documents?: ITemplateDocument[];
     fields?: ITemplateField[];
+    // @deprecated. Use documents instead.
+    template_documents?: ITemplateDocument[];
 }
 /**
  * A file attached to the template for display/signing.
@@ -578,6 +582,8 @@ interface ITemplateDocument {
     }[];
     created_at: string | null;
     updated_at: string | null;
+    // @deprecated. Use pages instead.
+    page_numbers?: number;
     template?: ITemplate;
 }
 interface ITemplateField {
@@ -609,6 +615,8 @@ interface ITemplateField {
     placeholder: string | null;
     /** For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name. */
     group: string | null;
+    // @deprecated. Use settings instead.
+    setting?: ITemplateFieldSetting | null;
 }
 interface ITextFieldSetting {
     x: number;

package/dist/index.d.ts

@@ -281,6 +281,8 @@ interface IEnvelopeDocument {
     mime: string;
     created_at: string;
     updated_at: string;
+    // @deprecated. Use pages instead.
+    page_numbers: number;
     envelope?: IEnvelope | null;
     template_document?: ITemplateDocument | null;
     fields?: IEnvelopeField[];
@@ -561,6 +563,8 @@ interface ITemplate {
     roles?: IRole[];
     documents?: ITemplateDocument[];
     fields?: ITemplateField[];
+    // @deprecated. Use documents instead.
+    template_documents?: ITemplateDocument[];
 }
 /**
  * A file attached to the template for display/signing.
@@ -578,6 +582,8 @@ interface ITemplateDocument {
     }[];
     created_at: string | null;
     updated_at: string | null;
+    // @deprecated. Use pages instead.
+    page_numbers?: number;
     template?: ITemplate;
 }
 interface ITemplateField {
@@ -609,6 +615,8 @@ interface ITemplateField {
     placeholder: string | null;
     /** For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name. */
     group: string | null;
+    // @deprecated. Use settings instead.
+    setting?: ITemplateFieldSetting | null;
 }
 interface ITextFieldSetting {
     x: number;

package/dist/index.js

@@ -1219,7 +1219,19 @@ const getEnvelopeRecipients = async (endpoint, envelopeId) => endpoint.api //
  */
 const getEnvelope = async (endpoint, envelopeId) => endpoint.api //
     .get(`/envelopes/${envelopeId}`)
-    .then((r) => r.data);
+    .then((r) => {
+    const envelope = r.data;
+    // Post-process the envelope to upgrade to new data fields
+    envelope.documents?.forEach((document) => {
+        if (!document.order) {
+            document.order = 0;
+        }
+        if (document.page_numbers) {
+            document.pages = document.page_numbers;
+        }
+    });
+    return envelope;
+});
 /**
  * Get an Envelope Document
  */
@@ -2142,7 +2154,27 @@ const getTemplates = (endpoint, params) => endpoint.api //
  */
 const getTemplate = (endpoint, templateId) => endpoint.api //
     .get(`/templates/${templateId}`)
-    .then((r) => r.data);
+    .then((r) => {
+    const template = r.data;
+    // Post-process the template to upgrade to new data fields
+    if (!template.documents && template.template_documents) {
+        template.documents = template.template_documents;
+    }
+    template.documents?.forEach((document) => {
+        if (!document.order) {
+            document.order = 0;
+        }
+        if (document.page_numbers) {
+            document.pages = document.page_numbers;
+        }
+    });
+    template.fields?.forEach((field) => {
+        if (field.setting) {
+            field.settings = field.setting;
+        }
+    });
+    return template;
+});
 /**
  * Get owner information for a template.
  *