@verdocs/js-sdk 6.6.2 → 6.6.3

package/dist/index.d.mts

@@ -508,7 +508,7 @@ type TAccessKey = IInPersonAccessKey | IInAppAccessKey | IEmailAccessKey | ISMSA
 interface IEnvelope {
     /** Unique identifier for the envelope (UUID) */
     id: string;
-    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. */
+    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. Also, 'complete' does NOT mean "fully signed in all aspects" (see "signed" for that). 'complete' means complete from a user's perspective: all required data has been submitted and workflow steps completed. */
     status: TEnvelopeStatus;
     /** ID of the envelope's creator. */
     profile_id: string;
@@ -540,7 +540,7 @@ 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. */
+    /** If true, the envelope is fully submitted, processed, certificate-generated, and all documents have been stamped and signed. */
     signed: boolean;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
@@ -581,6 +581,8 @@ interface IEnvelopeDocument {
     mime: string;
     /** File size (bytes) */
     size: number;
+    /** Whether the file has been signed. Note that document.signed is different from envelope.signed. Documents are signed first, then the certificate is created and signed, then the envelope is finally marked signed. */
+    signed: boolean;
     /** Collection of width/height dimensions for each page */
     page_sizes: {
         width: number;

package/dist/index.d.ts

@@ -508,7 +508,7 @@ type TAccessKey = IInPersonAccessKey | IInAppAccessKey | IEmailAccessKey | ISMSA
 interface IEnvelope {
     /** Unique identifier for the envelope (UUID) */
     id: string;
-    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. */
+    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. Also, 'complete' does NOT mean "fully signed in all aspects" (see "signed" for that). 'complete' means complete from a user's perspective: all required data has been submitted and workflow steps completed. */
     status: TEnvelopeStatus;
     /** ID of the envelope's creator. */
     profile_id: string;
@@ -540,7 +540,7 @@ 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. */
+    /** If true, the envelope is fully submitted, processed, certificate-generated, and all documents have been stamped and signed. */
     signed: boolean;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
@@ -581,6 +581,8 @@ interface IEnvelopeDocument {
     mime: string;
     /** File size (bytes) */
     size: number;
+    /** Whether the file has been signed. Note that document.signed is different from envelope.signed. Documents are signed first, then the certificate is created and signed, then the envelope is finally marked signed. */
+    signed: boolean;
     /** Collection of width/height dimensions for each page */
     page_sizes: {
         width: number;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "6.6.2",
+  "version": "6.6.3",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "6.6.2",
+  "version": "6.6.3",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",