@verdocs/js-sdk 4.2.86 → 4.2.87

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1380,7 +1380,7 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
1380
1380
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
1381
1381
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
1382
1382
  */
1383
- declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
1383
+ declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
1384
1384
  interface ITimeRange {
1385
1385
  start: string;
1386
1386
  end: string;
@@ -2505,9 +2505,9 @@ interface ITemplateCreateParams {
2505
2505
  /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
2506
2506
  sender?: TTemplateSenderType;
2507
2507
  /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
2508
- initial_reminder: number;
2508
+ initial_reminder?: number;
2509
2509
  /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
2510
- followup_reminders: number;
2510
+ followup_reminders?: number;
2511
2511
  /** Optional description for the template to help identify it. */
2512
2512
  description?: string;
2513
2513
  /**
@@ -2638,7 +2638,7 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
2638
2638
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
2639
2639
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
2640
2640
  */
2641
- declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;
2641
+ declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
2642
2642
  interface IValidator {
2643
2643
  name: string;
2644
2644
  regex: string;
package/dist/index.d.ts CHANGED
@@ -1380,7 +1380,7 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
1380
1380
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
1381
1381
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
1382
1382
  */
1383
- declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
1383
+ declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
1384
1384
  interface ITimeRange {
1385
1385
  start: string;
1386
1386
  end: string;
@@ -2505,9 +2505,9 @@ interface ITemplateCreateParams {
2505
2505
  /** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
2506
2506
  sender?: TTemplateSenderType;
2507
2507
  /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
2508
- initial_reminder: number;
2508
+ initial_reminder?: number;
2509
2509
  /** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
2510
- followup_reminders: number;
2510
+ followup_reminders?: number;
2511
2511
  /** Optional description for the template to help identify it. */
2512
2512
  description?: string;
2513
2513
  /**
@@ -2638,7 +2638,7 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
2638
2638
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
2639
2639
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
2640
2640
  */
2641
- declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, templateId: string, documentId: string, page: number) => Promise<string>;
2641
+ declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
2642
2642
  interface IValidator {
2643
2643
  name: string;
2644
2644
  regex: string;
package/dist/index.js CHANGED
@@ -1580,9 +1580,7 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
1580
1580
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
1581
1581
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
1582
1582
  */
1583
- const getEnvelopeDocumentPageDisplayUri = async (endpoint, envelopeId, documentId, page, type = 'original') => endpoint.api
1584
- .get(`/envelopes/${envelopeId}/envelope_documents/${documentId}/pages/${page}/image?type=${type}`, { timeout: 20000 })
1585
- .then((r) => r.data);
1583
+ 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);
1586
1584
  /**
1587
1585
  * Lists all envelopes accessible by the caller, with optional filters.
1588
1586
  *
@@ -2898,7 +2896,7 @@ const getTemplateDocumentThumbnail = async (endpoint, templateId, documentId) =>
2898
2896
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants. The
2899
2897
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
2900
2898
  */
2901
- const getTemplateDocumentPageDisplayUri = async (endpoint, templateId, documentId, page) => endpoint.api.get(`/templates/${templateId}/documents/${documentId}/pages/${page}/image`).then((r) => r.data);
2899
+ 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);
2902
2900
 
2903
2901
  /**
2904
2902
  * Get all defined validators