@verdocs/js-sdk 6.2.3 → 6.2.6

package/dist/index.mjs

@@ -1587,8 +1587,8 @@ class VerdocsEndpoint {
  * @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 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 (in milliseconds).
- * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting (in milliseconds).
+ * @apiBody integer(min: 0) initial_reminder? Override the template initial-reminder setting in ms.
+ * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting in ms.
  * @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.
  */
@@ -1676,14 +1676,22 @@ const getEnvelopeFile = async (endpoint, documentId) => endpoint.api //
  * @group Envelopes
  * @api PATCH /v2/envelopes/:id Update Envelope
  * @apiParam string(format: 'uuid') id The ID of the envelope to update.
- * @apiBody IEnvelope . Set of fields to update. Omit (leave undefined) any fields that should not be changed.
+ * @apiBody string name? New name for the envelope
+ * @apiBody string sender_name? New Sender Name for the envelope
+ * @apiBody string sender_email? New Sender Email for the envelope
+ * @apiBody integer(min: 0) initial_reminder? Change the initial-reminder setting (in ms).
+ * @apiBody integer(min: 0) followup_reminders? Change the followup-reminder setting (in ms).
+ * @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.
+ * @apiBody string(enum:'private'|'shared') visibility? Change the envelope's visibility setting
+ * @apiBody boolean no_contact? If set to true, no email or SMS messages will be sent to any recipients.
+ * @apiBody object data? Update the developer-supplied metadata attached to the envelope.
  * @apiSuccess IEnvelope . A copy of the newly-updated envelope.
  */
 const updateEnvelope = async (endpoint, envelopeId, params) => endpoint.api //
     .patch(`/v2/envelopes/${envelopeId}`, params)
     .then((r) => r.data);
 /**
- * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ * Update an Envelope field. Typically called during the signing process as a Recipient fills in fields.
  *
  * @group Envelopes
  * @api PUT /v2/envelopes/:envelope_id/fields/:field_name Update Envelope Field
@@ -1691,7 +1699,7 @@ const updateEnvelope = async (endpoint, envelopeId, params) => endpoint.api //
  * @apiParam string role_name The role to submit. Be sure to URL-encode the value.
  * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
  * @apiParam string value The value to set. For signature/initial fields, the UUID of the signature/initial block. For attachment fields, a file uploaded in a FORM-POST field named "document". For checkbox/radio buttons, a boolean. For all other fields, a string.
- * @apiBody value . Value to set.
+ * @apiBody string value Value to set.
  * @apiSuccess IEnvelopeField . A copy of the newly-updated field.
  */
 const updateEnvelopeField = async (endpoint, envelopeId, roleName, fieldName, value, prepared) => endpoint.api //
@@ -2396,8 +2404,8 @@ const createTemplateFromSharepoint = (endpoint, params) => {
  * @apiBody boolean is_personal? Deprecated. If true, the template is personal and can only be seen by the caller. (Use "visibility" for new calls.)
  * @apiBody boolean is_public? Deprecated. If true, the template is public and can be seen by anybody. (Use "visibility" for new calls.)
  * @apiBody TTemplateSender sender? Who may send envelopes using this template
- * @apiBody number initial_reminder? Delay (in milliseconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
- * @apiBody number followup_reminders? Delay (in milliseconds) before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
+ * @apiBody number initial_reminder? Delay in ms before the first reminder is sent (min: 4hrs). Set to 0 or null to disable.
+ * @apiBody number followup_reminders? Delay in ms before the subsequent reminders are sent (min: 12hrs). Set to 0 or null to disable.
  * @apiSuccess ITemplate . The updated template
  */
 const updateTemplate = (endpoint, templateId, params) => endpoint.api //