@verdocs/js-sdk 6.0.4 → 6.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.mjs CHANGED
@@ -1973,22 +1973,8 @@ const getInPersonLink = (endpoint, envelope_id, role_name) => endpoint.api //
1973
1973
  const verifySigner = (endpoint, params) => endpoint.api //
1974
1974
  .post(`/v2/sign/verify`, params)
1975
1975
  .then((r) => r.data);
1976
- // TODO: Use "oneOf" to describe the unions of these two calls.
1977
- /**
1978
- * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
1979
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
1980
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
1981
- * no_contact flag is set on the envelope (in which case the call will be ignored).
1982
- *
1983
- * @group Recipients
1984
- * @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
1985
- * @apiParam string(format:uuid) envelope_id The envelope to operate on.
1986
- * @apiParam string role_name The role to operate on.
1987
- * @apiBody string(enum:'resend') action The operation to perform (resend).
1988
- * @apiSuccess string . Success message.
1989
- */
1990
- const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
1991
- .put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
1976
+ const resendInvitation = (endpoint, envelopeId, roleName, message) => endpoint.api //
1977
+ .patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { message })
1992
1978
  .then((r) => r.data);
1993
1979
  /**
1994
1980
  * Delegate a recipient's signing responsibility. The envelope sender must enable this before the
@@ -2015,10 +2001,13 @@ const delegateRecipient = (endpoint, envelopeId, roleName, params) => endpoint.a
2015
2001
  .put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'delegate', ...params })
2016
2002
  .then((r) => r.data);
2017
2003
  /**
2018
- * Update a recipient. NOTE: User interfaces should rate-limit this operation to
2019
- * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
2020
- * the calling application to prevent abuse. This endpoint will return a 200 OK even if the
2021
- * no_contact flag is set on the envelope (in which case the call will be ignored).
2004
+ * Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
2005
+ * Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
2006
+ * abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
2007
+ * case the call will be silently ignored).
2008
+ *
2009
+ * If the recipient's first_name, last_name, email, or message are updated, a new invitation will be sent
2010
+ * to the recipient. This may also be used to trigger a reminder.
2022
2011
  *
2023
2012
  * @group Recipients
2024
2013
  * @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient