@verdocs/js-sdk 5.3.3 → 5.3.4

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.d.mts CHANGED
@@ -1636,7 +1636,7 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
1636
1636
  * @group Envelopes
1637
1637
  * @api POST /v2/envelopes Create Envelope
1638
1638
  * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
1639
- * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
1639
+ * @apiBody array(items:ICreateEnvelopeRecipientDirectly) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
1640
1640
  * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
1641
1641
  * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
1642
1642
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
@@ -2041,6 +2041,7 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
2041
2041
  * @apiSuccess ISignerTokenResponse . Updated signing session.
2042
2042
  */
2043
2043
  declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
2044
+ // TODO: Use "oneOf" to describe the unions of these two calls.
2044
2045
  /**
2045
2046
  * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
2046
2047
  * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
package/dist/index.d.ts CHANGED
@@ -1636,7 +1636,7 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
1636
1636
  * @group Envelopes
1637
1637
  * @api POST /v2/envelopes Create Envelope
1638
1638
  * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
1639
- * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
1639
+ * @apiBody array(items:ICreateEnvelopeRecipientDirectly) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
1640
1640
  * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
1641
1641
  * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
1642
1642
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
@@ -2041,6 +2041,7 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
2041
2041
  * @apiSuccess ISignerTokenResponse . Updated signing session.
2042
2042
  */
2043
2043
  declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
2044
+ // TODO: Use "oneOf" to describe the unions of these two calls.
2044
2045
  /**
2045
2046
  * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
2046
2047
  * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
package/dist/index.js CHANGED
@@ -1575,7 +1575,7 @@ class VerdocsEndpoint {
1575
1575
  * @group Envelopes
1576
1576
  * @api POST /v2/envelopes Create Envelope
1577
1577
  * @apiBody string(format:uuid) template_id If using a template, the ID of the template to copy
1578
- * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
1578
+ * @apiBody array(items:ICreateEnvelopeRecipientDirectly) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
1579
1579
  * @apiBody array(items:IEnvelopeDocument) documents? If not using a template, a list of documents to include in the envelope.
1580
1580
  * @apiBody array(items:IEnvelopeField) fields? If not using a template, a list of fields to include in the envelope.
1581
1581
  * @apiBody string name? Override the name of the envelope (defaults to the template name).
@@ -1961,6 +1961,7 @@ const getInPersonLink = (endpoint, envelope_id, role_name) => endpoint.api //
1961
1961
  const verifySigner = (endpoint, params) => endpoint.api //
1962
1962
  .post(`/v2/sign/verify`, params)
1963
1963
  .then((r) => r.data);
1964
+ // TODO: Use "oneOf" to describe the unions of these two calls.
1964
1965
  /**
1965
1966
  * Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
1966
1967
  * avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting