@verdocs/js-sdk 4.2.86 → 4.2.88

package/dist/index.d.mts

@@ -901,7 +901,7 @@ type TRecipientType = "signer" | "cc" | "approver";
 type TSortTemplateBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
 type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
 type TApiKeyPermission = "personal" | "global_read" | "global_write";
-type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
+type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:reminder" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
 type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
@@ -1380,7 +1380,7 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
-declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
+declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
 interface ITimeRange {
     start: string;
     end: string;
@@ -2505,9 +2505,9 @@ interface ITemplateCreateParams {
     /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
     sender?: TTemplateSenderType;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
-    initial_reminder: number;
+    initial_reminder?: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
-    followup_reminders: number;
+    followup_reminders?: number;
     /** Optional description for the template to help identify it. */
     description?: string;
     /**
@@ -2638,7 +2638,7 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
-declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;
+declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
 interface IValidator {
     name: string;
     regex: string;

package/dist/index.d.ts

@@ -901,7 +901,7 @@ type TRecipientType = "signer" | "cc" | "approver";
 type TSortTemplateBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
 type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
 type TApiKeyPermission = "personal" | "global_read" | "global_write";
-type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
+type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:reminder" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
 type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
@@ -1380,7 +1380,7 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
-declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
+declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
 interface ITimeRange {
     start: string;
     end: string;
@@ -2505,9 +2505,9 @@ interface ITemplateCreateParams {
     /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
     sender?: TTemplateSenderType;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
-    initial_reminder: number;
+    initial_reminder?: number;
     /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
-    followup_reminders: number;
+    followup_reminders?: number;
     /** Optional description for the template to help identify it. */
     description?: string;
     /**
@@ -2638,7 +2638,7 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
-declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;
+declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
 interface IValidator {
     name: string;
     regex: string;

package/dist/index.js

@@ -1069,6 +1069,7 @@ const updateProfilePhoto = (endpoint, profileId, file, onUploadProgress) => {
 // @credit https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
 // Also see globalThis for comments about why we're doing this in the first place.
 const ENDPOINT_KEY = Symbol.for('verdocs-default-endpoint');
+const BETA_ORIGINS = ['https://beta.verdocs.com', 'https://stage.verdocs.com', 'http://localhost:6006', 'http://localhost:5173'];
 const requestLogger = (r) => {
     // tslint:disable-next-line
     console.debug(`[JS-SDK] ${r.method.toUpperCase()} ${r.baseURL}${r.url}`, r.data ? JSON.stringify(r.data) : '');
@@ -1099,9 +1100,7 @@ class VerdocsEndpoint {
     environment = 'verdocs';
     sessionType = 'user';
     persist = true;
-    baseURL = (window.location.origin === 'https://beta.verdocs.com' || window.location.origin === 'https://stage.verdocs.com'
-        ? 'https://stage-api.verdocs.com'
-        : 'https://api.verdocs.com');
+    baseURL = BETA_ORIGINS.includes(window.location.origin) ? 'https://stage-api.verdocs.com' : 'https://api.verdocs.com';
     clientID = 'not-set';
     timeout = 60000;
     token = null;
@@ -1580,9 +1579,7 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
-const getEnvelopeDocumentPageDisplayUri = async (endpoint, envelopeId, documentId, page, type = 'original') => endpoint.api
-    .get(`/envelopes/${envelopeId}/envelope_documents/${documentId}/pages/${page}/image?type=${type}`, { timeout: 20000 })
-    .then((r) => r.data);
+const getEnvelopeDocumentPageDisplayUri = async (endpoint, documentId, page, variant = 'original') => endpoint.api.get(`/v2/envelope-documents/page-image/${documentId}/${variant}/${page}`, { timeout: 20000 }).then((r) => r.data);
 /**
  * Lists all envelopes accessible by the caller, with optional filters.
  *
@@ -2898,7 +2895,7 @@ const getTemplateDocumentThumbnail = async (endpoint, templateId, documentId) =>
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
  */
-const getTemplateDocumentPageDisplayUri = async (endpoint, templateId, documentId, page) => endpoint.api.get(`/templates/${templateId}/documents/${documentId}/pages/${page}/image`).then((r) => r.data);
+const getTemplateDocumentPageDisplayUri = async (endpoint, documentId, page, variant = 'original') => endpoint.api.get(`/v2/template-documents/page-image/${documentId}/${variant}/${page}`, { timeout: 20000 }).then((r) => r.data);
 
 /**
  * Get all defined validators