@verdocs/js-sdk 5.1.7 → 5.1.8

package/dist/index.d.mts

@@ -398,6 +398,7 @@ interface IWebhookEvents {
     envelope_completed: boolean;
     envelope_updated: boolean;
     envelope_canceled: boolean;
+    envelope_expired: boolean;
     template_created: boolean;
     template_updated: boolean;
     template_deleted: boolean;
@@ -967,7 +968,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" | "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 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" | "envelope:expired" | "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">;
@@ -1456,15 +1457,17 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope From Template
- * @apiBody string(format:uuid) template_id The ID of the template to copy
+ * @api POST /v2/envelopes Create Envelope
+ * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
  * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
+ * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
- * @apiBody array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
  * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
  * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
  * @apiSuccess IEnvelope . The newly-created envelope.
  */
 declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;

package/dist/index.d.ts

@@ -398,6 +398,7 @@ interface IWebhookEvents {
     envelope_completed: boolean;
     envelope_updated: boolean;
     envelope_canceled: boolean;
+    envelope_expired: boolean;
     template_created: boolean;
     template_updated: boolean;
     template_deleted: boolean;
@@ -967,7 +968,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" | "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 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" | "envelope:expired" | "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">;
@@ -1456,15 +1457,17 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope From Template
- * @apiBody string(format:uuid) template_id The ID of the template to copy
+ * @api POST /v2/envelopes Create Envelope
+ * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
  * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
+ * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
- * @apiBody array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
  * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
  * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
  * @apiSuccess IEnvelope . The newly-created envelope.
  */
 declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;

package/dist/index.js

@@ -1573,15 +1573,17 @@ class VerdocsEndpoint {
  * ```
  *
  * @group Envelopes
- * @api POST /v2/envelopes Create Envelope From Template
- * @apiBody string(format:uuid) template_id The ID of the template to copy
+ * @api POST /v2/envelopes Create Envelope
+ * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
  * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
+ * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
  * @apiBody string description? Override the description of the envelope (defaults to the template description).
- * @apiBody array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
  * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
  * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting.
  * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @apiBody string expires_at? If set, the envelope will automatically expire (be canceled) at this date and time. Expirations must be at least 1 day in the future.
  * @apiSuccess IEnvelope . The newly-created envelope.
  */
 const createEnvelope = async (endpoint, request) => endpoint.api //