@verdocs/js-sdk 6.3.1 → 6.3.3

package/dist/index.d.mts

@@ -534,6 +534,10 @@ interface IEnvelope {
     expires_at?: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
+    /** If true, the attachments have been signed with the Verdocs AATL signing certificate. */
+    signed: boolean;
+    /** If true, the envelope certificate has been generated and signed. */
+    certified: boolean;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
      * internal systems/applications.
@@ -2124,7 +2128,7 @@ declare const resetRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, ro
  * sender to determine how to reply.
  *
  * @group Recipients
- * @api POST /envelopes/:envelope_id/recipients/:role_name/ask-sender Ask Sender a Question
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/ask-question Ask Sender a Question
  * @apiParam string(format:uuid) envelope_id The envelope to operate on.
  * @apiParam string role_name The role name to update.
  * @apiBody string question The question to ask.
@@ -2982,6 +2986,10 @@ declare const getOrganizationUsage: (endpoint: VerdocsEndpoint, organizationId:
  * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
  * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
  * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string terms_use_url? URL of a Terms of Use page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string privacy_policy_url? URL of a Privacy Policy page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string powered_by_label? "Powered-by..." label, shown in bottom-left of signing experience. Hidden if not set.
+ * @apiBody string powered_by_url? URL for the Powered By label to show when clicked. Rendered as a static label if not set.
  * @apiSuccess IAuthenticateResponse . Authentication credentials for user in the new organization. The user will be made an Owner automatically.
  */
 declare const createOrganization: (endpoint: VerdocsEndpoint, params: {
@@ -3008,6 +3016,10 @@ declare const createOrganization: (endpoint: VerdocsEndpoint, params: {
  * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
  * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
  * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string terms_use_url? URL of a Terms of Use page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string privacy_policy_url? URL of a Privacy Policy page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string powered_by_label? "Powered-by..." label, shown in bottom-left of signing experience. Hidden if not set.
+ * @apiBody string powered_by_url? URL for the Powered By label to show when clicked. Rendered as a static label if not set.
  * @apiSuccess IOrganization . The details for the updated organization
  */
 declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: string, params: Partial<IOrganization>) => Promise<IOrganization>;

package/dist/index.d.ts

@@ -534,6 +534,10 @@ interface IEnvelope {
     expires_at?: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
+    /** If true, the attachments have been signed with the Verdocs AATL signing certificate. */
+    signed: boolean;
+    /** If true, the envelope certificate has been generated and signed. */
+    certified: boolean;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
      * internal systems/applications.
@@ -2124,7 +2128,7 @@ declare const resetRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, ro
  * sender to determine how to reply.
  *
  * @group Recipients
- * @api POST /envelopes/:envelope_id/recipients/:role_name/ask-sender Ask Sender a Question
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/ask-question Ask Sender a Question
  * @apiParam string(format:uuid) envelope_id The envelope to operate on.
  * @apiParam string role_name The role name to update.
  * @apiBody string question The question to ask.
@@ -2982,6 +2986,10 @@ declare const getOrganizationUsage: (endpoint: VerdocsEndpoint, organizationId:
  * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
  * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
  * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string terms_use_url? URL of a Terms of Use page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string privacy_policy_url? URL of a Privacy Policy page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string powered_by_label? "Powered-by..." label, shown in bottom-left of signing experience. Hidden if not set.
+ * @apiBody string powered_by_url? URL for the Powered By label to show when clicked. Rendered as a static label if not set.
  * @apiSuccess IAuthenticateResponse . Authentication credentials for user in the new organization. The user will be made an Owner automatically.
  */
 declare const createOrganization: (endpoint: VerdocsEndpoint, params: {
@@ -3008,6 +3016,10 @@ declare const createOrganization: (endpoint: VerdocsEndpoint, params: {
  * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
  * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
  * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string terms_use_url? URL of a Terms of Use page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string privacy_policy_url? URL of a Privacy Policy page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string powered_by_label? "Powered-by..." label, shown in bottom-left of signing experience. Hidden if not set.
+ * @apiBody string powered_by_url? URL for the Powered By label to show when clicked. Rendered as a static label if not set.
  * @apiSuccess IOrganization . The details for the updated organization
  */
 declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: string, params: Partial<IOrganization>) => Promise<IOrganization>;

package/dist/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var axios = require('axios');
+var axiosRetry = require('axios-retry');
 
 const FIELD_TYPES = [
     'textbox',
@@ -1255,6 +1256,8 @@ class VerdocsEndpoint {
         this.clientID = options?.clientID ?? this.clientID;
         this.persist = options?.persist ?? this.persist;
         this.api = axios.create({ baseURL: this.baseURL, timeout: this.timeout });
+        // Enable the module but not for any requests, only a few get this
+        axiosRetry(this.api, { retries: 0 });
     }
     setDefault() {
         globalThis$1[ENDPOINT_KEY] = this;
@@ -1625,7 +1628,10 @@ const getEnvelopeDocument = async (endpoint, documentId) => endpoint.api //
  * Download a document directly.
  */
 const downloadEnvelopeDocument = async (endpoint, documentId) => endpoint.api //
-    .get(`/v2/envelope-documents/${documentId}?type=file`, { responseType: 'blob' })
+    .get(`/v2/envelope-documents/${documentId}?type=file`, {
+    responseType: 'blob',
+    'axios-retry': { retries: 5, retryDelay: axiosRetry.linearDelay(3000) },
+})
     .then((r) => r.data);
 /**
  * Get an envelope document's metadata, or the document itself. If no "type" parameter is specified,
@@ -1641,14 +1647,18 @@ const downloadEnvelopeDocument = async (endpoint, documentId) => endpoint.api //
  * @apiSuccess string . The generated link.
  */
 const getEnvelopeDocumentDownloadLink = async (endpoint, documentId) => endpoint.api //
-    .get(`/v2/envelope-documents/${documentId}?type=download`)
+    .get(`/v2/envelope-documents/${documentId}?type=download`, {
+    'axios-retry': { retries: 5, retryDelay: axiosRetry.linearDelay(3000) },
+})
     .then((r) => r.data);
 /**
  * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
  * be accessed immediately and never shared. Content-Disposition will be set to "inline".
  */
 const getEnvelopeDocumentPreviewLink = async (endpoint, documentId) => endpoint.api //
-    .get(`/v2/envelope-documents/${documentId}?type=preview`)
+    .get(`/v2/envelope-documents/${documentId}?type=preview`, {
+    'axios-retry': { retries: 5, retryDelay: axiosRetry.linearDelay(3000) },
+})
     .then((r) => r.data);
 /**
  * Cancel an Envelope.
@@ -2864,7 +2874,7 @@ const resetRecipient = (endpoint, envelopeId, roleName) => endpoint.api //
  * sender to determine how to reply.
  *
  * @group Recipients
- * @api POST /envelopes/:envelope_id/recipients/:role_name/ask-sender Ask Sender a Question
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/ask-question Ask Sender a Question
  * @apiParam string(format:uuid) envelope_id The envelope to operate on.
  * @apiParam string role_name The role name to update.
  * @apiBody string question The question to ask.
@@ -3526,6 +3536,10 @@ const getOrganizationUsage = (endpoint, organizationId, params) => endpoint.api
  * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
  * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
  * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string terms_use_url? URL of a Terms of Use page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string privacy_policy_url? URL of a Privacy Policy page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string powered_by_label? "Powered-by..." label, shown in bottom-left of signing experience. Hidden if not set.
+ * @apiBody string powered_by_url? URL for the Powered By label to show when clicked. Rendered as a static label if not set.
  * @apiSuccess IAuthenticateResponse . Authentication credentials for user in the new organization. The user will be made an Owner automatically.
  */
 const createOrganization = (endpoint, params) => endpoint.api //
@@ -3549,6 +3563,10 @@ const createOrganization = (endpoint, params) => endpoint.api //
  * @apiBody string thumbnail_url? URL of a small-format (square is recommended) PNG logo
  * @apiBody string primary_color? URL of a small-format (square is recommended) PNG logo
  * @apiBody string secondary_color? URL of a small-format (square is recommended) PNG logo
+ * @apiBody string terms_use_url? URL of a Terms of Use page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string privacy_policy_url? URL of a Privacy Policy page, shown in bottom-right of signing experience. Hidden if not set.
+ * @apiBody string powered_by_label? "Powered-by..." label, shown in bottom-left of signing experience. Hidden if not set.
+ * @apiBody string powered_by_url? URL for the Powered By label to show when clicked. Rendered as a static label if not set.
  * @apiSuccess IOrganization . The details for the updated organization
  */
 const updateOrganization = (endpoint, organizationId, params) => endpoint.api //