@verdocs/js-sdk 5.0.6 → 5.0.8

package/dist/index.d.mts

@@ -537,6 +537,8 @@ interface IEnvelopeField {
     type: TFieldType;
     /** If true, the field will be required */
     required: boolean | null;
+    /** If true, the field will be not be editable by the participant(s). NOTE: Fields may not be both required and readonly. */
+    readonly: boolean | null;
     /** @deprecated. Use top-level fields instead. */
     settings: IEnvelopeFieldSettings | null;
     validator: string | null;
@@ -860,6 +862,8 @@ interface ITemplateField {
     document_id: string;
     type: TFieldType;
     required: boolean;
+    /** If true, the field will be not be editable by the participant(s). NOTE: Fields may not be both required and readonly. */
+    readonly: boolean | null;
     /** @deprecated. Use top-level fields instead. */
     settings: ITemplateFieldSetting | null;
     page: number;
@@ -926,7 +930,7 @@ type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
 type TApiKeyPermission = "personal" | "global_read" | "global_write";
 /** @deprecated. See envelope.created_at, .updated_at, and .canceled_at. */
 type TDeprecatedHistoryEvent = "envelope:created" | "envelope:completed";
-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" | "envelope:canceled" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
+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" | "recipient:kba_verified" | "recipient:kba_failed" | "recipient:id_verified" | "recipient:id_failed" | "recipient:pin_verified" | "recipient:pin_failed" | "invitation:resent" | "envelope:cc" | "envelope:canceled" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
 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">;

package/dist/index.d.ts

@@ -537,6 +537,8 @@ interface IEnvelopeField {
     type: TFieldType;
     /** If true, the field will be required */
     required: boolean | null;
+    /** If true, the field will be not be editable by the participant(s). NOTE: Fields may not be both required and readonly. */
+    readonly: boolean | null;
     /** @deprecated. Use top-level fields instead. */
     settings: IEnvelopeFieldSettings | null;
     validator: string | null;
@@ -860,6 +862,8 @@ interface ITemplateField {
     document_id: string;
     type: TFieldType;
     required: boolean;
+    /** If true, the field will be not be editable by the participant(s). NOTE: Fields may not be both required and readonly. */
+    readonly: boolean | null;
     /** @deprecated. Use top-level fields instead. */
     settings: ITemplateFieldSetting | null;
     page: number;
@@ -926,7 +930,7 @@ type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
 type TApiKeyPermission = "personal" | "global_read" | "global_write";
 /** @deprecated. See envelope.created_at, .updated_at, and .canceled_at. */
 type TDeprecatedHistoryEvent = "envelope:created" | "envelope:completed";
-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" | "envelope:canceled" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
+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" | "recipient:kba_verified" | "recipient:kba_failed" | "recipient:id_verified" | "recipient:id_failed" | "recipient:pin_verified" | "recipient:pin_failed" | "invitation:resent" | "envelope:cc" | "envelope:canceled" | "owner:updated_recipient_info" | "owner:get_in_person_link" | TDeprecatedHistoryEvent;
 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">;

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "5.0.6",
+  "version": "5.0.8",
   "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": "5.0.6",
+  "version": "5.0.8",
   "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",