@verdocs/js-sdk 6.0.4 → 6.0.5

package/dist/index.d.mts

@@ -2071,21 +2071,7 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  * @apiSuccess ISignerTokenResponse . Updated signing session.
  */
 declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
-// TODO: Use "oneOf" to describe the unions of these two calls.
-/**
- * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
- * no_contact flag is set on the envelope (in which case the call will be ignored).
- *
- * @group Recipients
- * @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
- * @apiParam string(format:uuid) envelope_id The envelope to operate on.
- * @apiParam string role_name The role to operate on.
- * @apiBody string(enum:'resend') action The operation to perform (resend).
- * @apiSuccess string . Success message.
- */
-declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
+declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, message: string) => Promise<{
     status: "OK";
 }>;
 /**
@@ -2119,10 +2105,13 @@ declare const delegateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string,
     status: "OK";
 }>;
 /**
- * Update a recipient. NOTE: User interfaces should rate-limit this operation to
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
- * no_contact flag is set on the envelope (in which case the call will be ignored).
+ * Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
+ * Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
+ * abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
+ * case the call will be silently ignored).
+ *
+ * If the recipient's first_name, last_name, email, or message are updated, a new invitation will be sent
+ * to the recipient. This may also be used to trigger a reminder.
  *
  * @group Recipients
  * @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient

package/dist/index.d.ts

@@ -2071,21 +2071,7 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  * @apiSuccess ISignerTokenResponse . Updated signing session.
  */
 declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
-// TODO: Use "oneOf" to describe the unions of these two calls.
-/**
- * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
- * no_contact flag is set on the envelope (in which case the call will be ignored).
- *
- * @group Recipients
- * @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
- * @apiParam string(format:uuid) envelope_id The envelope to operate on.
- * @apiParam string role_name The role to operate on.
- * @apiBody string(enum:'resend') action The operation to perform (resend).
- * @apiSuccess string . Success message.
- */
-declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
+declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, message: string) => Promise<{
     status: "OK";
 }>;
 /**
@@ -2119,10 +2105,13 @@ declare const delegateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string,
     status: "OK";
 }>;
 /**
- * Update a recipient. NOTE: User interfaces should rate-limit this operation to
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
- * no_contact flag is set on the envelope (in which case the call will be ignored).
+ * Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
+ * Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
+ * abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
+ * case the call will be silently ignored).
+ *
+ * If the recipient's first_name, last_name, email, or message are updated, a new invitation will be sent
+ * to the recipient. This may also be used to trigger a reminder.
  *
  * @group Recipients
  * @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient

package/dist/index.js

@@ -1975,22 +1975,8 @@ const getInPersonLink = (endpoint, envelope_id, role_name) => endpoint.api //
 const verifySigner = (endpoint, params) => endpoint.api //
     .post(`/v2/sign/verify`, params)
     .then((r) => r.data);
-// TODO: Use "oneOf" to describe the unions of these two calls.
-/**
- * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
- * no_contact flag is set on the envelope (in which case the call will be ignored).
- *
- * @group Recipients
- * @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
- * @apiParam string(format:uuid) envelope_id The envelope to operate on.
- * @apiParam string role_name The role to operate on.
- * @apiBody string(enum:'resend') action The operation to perform (resend).
- * @apiSuccess string . Success message.
- */
-const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
-    .put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
+const resendInvitation = (endpoint, envelopeId, roleName, message) => endpoint.api //
+    .patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { message })
     .then((r) => r.data);
 /**
  * Delegate a recipient's signing responsibility. The envelope sender must enable this before the
@@ -2017,10 +2003,13 @@ const delegateRecipient = (endpoint, envelopeId, roleName, params) => endpoint.a
     .put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'delegate', ...params })
     .then((r) => r.data);
 /**
- * Update a recipient. NOTE: User interfaces should rate-limit this operation to
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
- * no_contact flag is set on the envelope (in which case the call will be ignored).
+ * Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
+ * Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
+ * abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
+ * case the call will be silently ignored).
+ *
+ * If the recipient's first_name, last_name, email, or message are updated, a new invitation will be sent
+ * to the recipient. This may also be used to trigger a reminder.
  *
  * @group Recipients
  * @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient