@verdocs/js-sdk 6.1.1 → 6.2.0-beta.11

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
@@ -161,8 +161,6 @@ interface ISigningSession {
161
161
  // @deprecated
162
162
  ["https://verdocs.com/session_type"]: "signing";
163
163
  // @deprecated
164
- ["https://verdocs.com/key_type"]: TAccessKeyType;
165
- // @deprecated
166
164
  ["https://verdocs.com/envelope_id"]: string;
167
165
  // @deprecated
168
166
  ["https://verdocs.com/role_name"]: string;
@@ -421,6 +419,8 @@ interface IWebhookEvents {
421
419
  template_updated: boolean;
422
420
  template_deleted: boolean;
423
421
  template_used: boolean;
422
+ recipient_submitted: boolean;
423
+ recipient_updated: boolean;
424
424
  recipient_delegated: boolean;
425
425
  kba_event: boolean;
426
426
  entitlement_used: boolean;
@@ -993,7 +993,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
993
993
  // Modification events have a string description
994
994
  type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
995
995
  type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
996
- type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_delegated" | "kba_event" | "entitlement_used";
996
+ type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used";
997
997
  type TTemplateVisibility = "private" | "shared" | "public";
998
998
  type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
999
999
  /**
@@ -1383,38 +1383,12 @@ interface IInPersonLinkResponse {
1383
1383
  */
1384
1384
  recipient: IRecipient;
1385
1385
  }
1386
- interface IUpdateRecipientSubmitParams {
1387
- action: "submit";
1388
- }
1389
- interface IUpdateRecipientDeclineParams {
1390
- action: "decline";
1391
- }
1392
- interface IUpdateRecipientClaimEnvelope {
1393
- action: "owner_update";
1394
- first_name: string;
1395
- last_name: string;
1396
- email: string;
1397
- }
1398
1386
  interface IUpdateRecipientStatus {
1399
1387
  first_name?: string;
1400
1388
  last_name?: string;
1401
1389
  agreed?: boolean;
1402
1390
  action?: "prepare" | "update";
1403
1391
  }
1404
- interface IUpdateRecipientAgreedParams {
1405
- action: "update";
1406
- agreed: boolean;
1407
- disclosures?: string;
1408
- }
1409
- interface IUpdateRecipientNameParams {
1410
- action: "update";
1411
- first_name: string;
1412
- last_name: string;
1413
- }
1414
- interface IUpdateRecipientPrepareParams {
1415
- action: "prepare";
1416
- recipients: IRecipient[];
1417
- }
1418
1392
  interface ICreateEnvelopeReminderRequest {
1419
1393
  setup_time: number;
1420
1394
  interval_time: number;
@@ -1621,6 +1595,11 @@ interface IAuthenticateRecipientViaKBARequest {
1621
1595
  responses?: IKBAResponse[];
1622
1596
  }
1623
1597
  type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest | IAuthenticateRecipientViaEmailRequest | IAuthenticateRecipientViaSMSRequest | IAuthenticateRecipientViaKBARequest;
1598
+ /**
1599
+ * These disclosures will be used if no overrides are supplied by the caller. Overrides must
1600
+ * be applied at the Organization level before creating an envelope.
1601
+ */
1602
+ declare const DEFAULT_DISCLOSURES = "\n<ul>\n <li>\n Agree to use electronic records and signatures, and confirm you have read the\n <a href=\"https://verdocs.com/en/electronic-record-signature-disclosure/\" target=\"_blank\">\n Electronic Record and Signatures Disclosure</a>.</li>\n <li>\n Agree to Verdocs'\n <a href=\"https://verdocs.com/en/eula\" target=\"_blank\">\n End User License Agreement</a>\n and confirm you have read Verdocs'\n <a href=\"https://verdocs.com/en/privacy-policy/\" target=\"_blank\">\n Privacy Policy</a>.\n </li>\n</ul>";
1624
1603
  /**
1625
1604
  * Create an envelope
1626
1605
  *
@@ -1689,11 +1668,11 @@ declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Pr
1689
1668
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
1690
1669
  * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
1691
1670
  */
1692
- declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<IEnvelopeDocument>;
1671
+ declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<IEnvelopeDocument>;
1693
1672
  /**
1694
1673
  * Download a document directly.
1695
1674
  */
1696
- declare const downloadDocument: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<any>;
1675
+ declare const downloadEnvelopeDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<any>;
1697
1676
  /**
1698
1677
  * Get an envelope document's metadata, or the document itself. If no "type" parameter is specified,
1699
1678
  * the document metadata is returned. If "type" is set to "file", the document binary content is
@@ -1707,12 +1686,12 @@ declare const downloadDocument: (endpoint: VerdocsEndpoint, _envelopeId: string,
1707
1686
  * @apiQuery string(enum:'file'|'download'|'preview') type? Download the file directly, generate a download link, or generate a preview link.
1708
1687
  * @apiSuccess string . The generated link.
1709
1688
  */
1710
- declare const getDocumentDownloadLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
1689
+ declare const getEnvelopeDocumentDownloadLink: (endpoint: VerdocsEndpoint, documentId: string) => Promise<string>;
1711
1690
  /**
1712
1691
  * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
1713
1692
  * be accessed immediately and never shared. Content-Disposition will be set to "inline".
1714
1693
  */
1715
- declare const getDocumentPreviewLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
1694
+ declare const getEnvelopeDocumentPreviewLink: (endpoint: VerdocsEndpoint, documentId: string) => Promise<string>;
1716
1695
  /**
1717
1696
  * Cancel an Envelope.
1718
1697
  *
@@ -1730,7 +1709,7 @@ declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) =>
1730
1709
  *
1731
1710
  * @deprecated Use getDocumentPreviewLink/getDocumentDownloadLink/downloadDocument instead.
1732
1711
  */
1733
- declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<any>;
1712
+ declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, documentId: string) => Promise<any>;
1734
1713
  /**
1735
1714
  * Update an envelope. Currently, only reminder settings may be changed.
1736
1715
  *
@@ -1745,66 +1724,25 @@ declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, pa
1745
1724
  * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
1746
1725
  *
1747
1726
  * @group Envelopes
1748
- * @api PUT /envelopes/:envelope_id/fields/:field_name Update Envelope Field
1727
+ * @api PUT /v2/envelopes/:envelope_id/fields/:field_name Update Envelope Field
1749
1728
  * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
1729
+ * @apiParam string role_name The role to submit. Be sure to URL-encode the value.
1750
1730
  * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
1751
- * @apiBody IEnvelopeFieldSettings . Set of properties to update. Leave undefined any properties that should not be changed.
1752
- * @apiSuccess IEnvelope . A copy of the newly-updated field.
1731
+ * @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.
1732
+ * @apiBody value . Value to set.
1733
+ * @apiSuccess IEnvelopeField . A copy of the newly-updated field.
1753
1734
  */
1754
- declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, value: any) => Promise<IEnvelopeFieldSettings>;
1735
+ declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string, value: string, prepared: boolean) => Promise<IEnvelopeField>;
1755
1736
  /**
1756
- * Apply a signature to a signature field. Signature fields are ID-driven. Call `createSignature()`
1757
- * first to create a signature for a Recipient, then call `updateEnvelopeFieldSignature()` to
1758
- * attach it to a field.
1759
- *
1760
- * @group Envelopes
1761
- * @api PUT /envelopes/:envelope_id/fields/:field_name/signature/:signature_id Update Envelope
1762
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
1763
- * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
1764
- * @apiParam string(format: 'uuid') signature_id The ID of the signature to attach.
1765
- * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
1737
+ * Upload an attachment to an attachment field.
1766
1738
  */
1767
- declare const updateEnvelopeFieldSignature: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, signatureId: string) => Promise<IEnvelopeFieldSettings>;
1768
- /**
1769
- * Apply an initial to an initials field. Initial fields are ID-driven. Call `createInitial()`
1770
- * first to create an initial block for a Recipient, then call `supdateEnvelopeFieldInitials()` to
1771
- * attach it to a field.
1772
- *
1773
- * @group Envelopes
1774
- * @api PUT /envelopes/:envelope_id/fields/:field_name/initial/:initial_id Update Envelope
1775
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
1776
- * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
1777
- * @apiParam string(format: 'uuid') initial_id The ID of the initial block to attach.
1778
- * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
1779
- */
1780
- declare const updateEnvelopeFieldInitials: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, initialId: string) => Promise<IEnvelopeFieldSettings>;
1781
- /**
1782
- * Upload an attachment to an attachment field
1783
- *
1784
- * @group Envelopes
1785
- * @api PUT /envelopes/:envelope_id/fields/:field_name Upload or Delete Attachment
1786
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
1787
- * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
1788
- * @apiBody string document The file to attach. Must contain standard File object fields. If omitted, the attachment will be deleted instead.
1789
- * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
1790
- */
1791
- declare const uploadEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IEnvelopeFieldSettings>;
1739
+ declare const uploadEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IEnvelopeFieldSettings>;
1792
1740
  /**
1793
1741
  * Delete an attachment. Note that this is not a DELETE endpoint because the field itself is not
1794
1742
  * being deleted. Instead, it is a similar operation to uploading a new attachment, but the
1795
1743
  * omission of the attachment signals the server to delete the current entry.
1796
1744
  */
1797
- declare const deleteEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<IEnvelopeFieldSettings>;
1798
- /**
1799
- * Get the attached file for an attachment field (if any).
1800
- *
1801
- * @group Envelopes
1802
- * @api GET /envelopes/:envelope_id/fields/:field_name/document Download attachment in binary format
1803
- * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
1804
- * @apiParam string field_name The name of the field from which to download the attachment.
1805
- * @apiSuccess string . The file binary data.
1806
- */
1807
- declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<any>;
1745
+ declare const deleteEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fieldName: string) => Promise<IEnvelopeFieldSettings>;
1808
1746
  /**
1809
1747
  * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
1810
1748
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
@@ -1869,10 +1807,18 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
1869
1807
  envelopes: IEnvelope[];
1870
1808
  }>;
1871
1809
  /**
1872
- * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
1873
- * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
1874
- * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
1875
- * to be "stamped" by the user.
1810
+ * Generate a ZIP file containing all data for the specified envelopes. The caller must be the
1811
+ * owner of each envelope. The returned ZIP file contains a folder for each envelope.
1812
+ */
1813
+ declare const getEnvelopesZip: (endpoint: VerdocsEndpoint, envelope_ids: string[]) => Promise<import("axios").AxiosResponse<any, any, {}>>;
1814
+ declare const isFieldFilled: (field: IEnvelopeField, allRecipientFields: IEnvelopeField[]) => boolean | "" | null;
1815
+ // TODO: Only allow !required to bypass validation if the field is empty.
1816
+ declare const isFieldValid: (field: IEnvelopeField, allRecipientFields: IEnvelopeField[]) => boolean | "" | null;
1817
+ /**
1818
+ * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to
1819
+ * "adopt" an initials block to be used for all initials fields in the document. Thus, this is typically called
1820
+ * one time to create and store an initials block. Thereafter, the ID of the initials block may be re-used for each
1821
+ * initials field to be "stamped" by the user.
1876
1822
  *
1877
1823
  * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
1878
1824
  * typically only ever have one, tied to that session. But authenticated users can create more than
@@ -1978,45 +1924,37 @@ interface IKbaChallengeResponse {
1978
1924
  */
1979
1925
  declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, responses: IKbaChallengeResponse[]) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
1980
1926
  /**
1981
- * Update a recipient's status.
1927
+ * Agree to electronic signing dislosures.
1982
1928
  *
1983
1929
  * @group Recipients
1984
- * @api PUT /envelopes/:envelope_id/recipients/:role_name Update Recipient Status
1930
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/agree Agree to e-Signing Disclosures
1985
1931
  * @apiParam string(format:uuid) envelope_id The envelope to operate on.
1986
- * @apiParam string role_name The role to adjust.
1987
- * @apiBody string(enum:'submit'|'decline'|'owner_update'|'update'|'prepare') action The action to take. Adjusts the status, and may also perform other operations.
1988
- * @apiBody string first_name? Ignored unless action is 'owner_update' or 'update'. The new owner's or recipient's first name.
1989
- * @apiBody string last_name? Ignored unless action is 'owner_update' or 'update'. The new owner's or recipient's last name.
1990
- * @apiBody string email? Ignored unless action is 'owner_update'. The new owner's email address.
1991
- * @apiBody boolean agreed? Ignored unless action is 'update'. Set to true to accept the e-signing disclosures.
1992
- * @apiBody array(items:IRecipient) recipients? Ignored unless action is 'prepare'. A list of recipients and their fields to set defaults for.
1932
+ * @apiParam string role_name The role to operate on.
1993
1933
  * @apiSuccess IRecipient . The updated Recipient.
1994
1934
  */
1995
- declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
1996
- /**
1997
- * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
1998
- */
1999
- declare const envelopeRecipientSubmit: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
2000
- /**
2001
- * Decline to complete an envelope (signing will not terminated).
2002
- */
2003
- declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
2004
- /**
2005
- * Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
2006
- */
2007
- declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, email: string, first_name: string, last_name: string) => Promise<IRecipient>;
2008
- /**
2009
- * Agree to electronic signing disclosures.
2010
- */
2011
1935
  declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, disclosures?: string) => Promise<IRecipient>;
2012
1936
  /**
2013
- * Change a recipient's name.
1937
+ * Decline electronic signing dislosures. Note that if any recipient declines, the entire envelope
1938
+ * becomes non-viable and later recipients may no longer act. The creator will receive a notification
1939
+ * when this occurs.
1940
+ *
1941
+ * @group Recipients
1942
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/decline Decline e-Signing Disclosures
1943
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
1944
+ * @apiParam string role_name The role to adjust.
1945
+ * @apiSuccess IRecipient . The updated Recipient.
2014
1946
  */
2015
- declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, first_name: string, last_name: string) => Promise<IRecipient>;
1947
+ declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
2016
1948
  /**
2017
- * Change a recipient's name.
1949
+ * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
1950
+ *
1951
+ * @group Recipients
1952
+ * @api POST /envelopes/:envelope_id/recipients/:role_name/submit Submit envelope
1953
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
1954
+ * @apiParam string role_name The role to submit.
1955
+ * @apiSuccess IRecipient . The updated Recipient.
2018
1956
  */
2019
- declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
1957
+ declare const envelopeRecipientSubmit: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
2020
1958
  /**
2021
1959
  * Begin a signing session for an Envelope. This path requires an invite code, and should generally
2022
1960
  * be called with a NON-default Endpoint to avoid conflicting with any active user session the user
@@ -2206,10 +2144,10 @@ declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) =
2206
2144
  declare const userCanSignNow: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean | undefined;
2207
2145
  declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
2208
2146
  /**
2209
- * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
2210
- * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
2211
- * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
2212
- * to be "stamped" by the user.
2147
+ * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to
2148
+ * "adopt" a signature block to be used for all signature fields in the document. Thus, this is typically called one
2149
+ * time to create and store a signature block. Thereafter, the ID of the signature block may be re-used for each
2150
+ * signature field to be "stamped" by the user.
2213
2151
  *
2214
2152
  * Note: Both "guest" signers and authenticated users can create initials blocks. Guest signers
2215
2153
  * typically only ever have one, tied to that session. But authenticated users can create more than
@@ -2221,33 +2159,6 @@ declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
2221
2159
  * @apiSuccess ISignature . The newly-created signature block.
2222
2160
  */
2223
2161
  declare const createSignature: (endpoint: VerdocsEndpoint, name: string, signature: Blob) => Promise<ISignature>;
2224
- /**
2225
- * Get the available signatures for a user.
2226
- *
2227
- * @group Signatures and Initials
2228
- * @api GET /signatures Create Signature Block
2229
- *
2230
- * @apiSuccess array(items:ISignature) . A list of signatures previously stored for the user.
2231
- */
2232
- declare const getSignatures: (endpoint: VerdocsEndpoint) => Promise<ISignature[]>;
2233
- /**
2234
- * Get a user's signature by ID.
2235
- *
2236
- * @group Signatures and Initials
2237
- * @api GET /signatures/:id Delete Signature Block
2238
- * @apiParam string(format: 'uuid') id The ID of the signature to delete.
2239
- * @apiSuccess ISignature . The signature metadata requested.
2240
- */
2241
- declare const getSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
2242
- /**
2243
- * Delete a user's signature.
2244
- *
2245
- * @group Signatures and Initials
2246
- * @api DELETE /signatures/:id Delete Signature Block
2247
- * @apiParam string(format: 'uuid') id The ID of the signature to delete.
2248
- * @apiSuccess string . OK
2249
- */
2250
- declare const deleteSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
2251
2162
  interface ICreateApiKeyRequest {
2252
2163
  name: string;
2253
2164
  profile_id: string;
@@ -3354,58 +3265,6 @@ declare const updateTemplateRole: (endpoint: VerdocsEndpoint, template_id: strin
3354
3265
  * @apiSuccess string . Success
3355
3266
  */
3356
3267
  declare const deleteTemplateRole: (endpoint: VerdocsEndpoint, template_id: string, name: string) => Promise<any>;
3357
- interface ITemplateTag {
3358
- tag_name: string;
3359
- template_id: string;
3360
- }
3361
- interface ITag {
3362
- name: string;
3363
- featured?: boolean;
3364
- organization_id?: string;
3365
- created_at?: string;
3366
- }
3367
- interface IStar {
3368
- template_id: string;
3369
- profile_id: string;
3370
- }
3371
- interface ITemplateSearchResult {
3372
- page: number;
3373
- row: number;
3374
- total: number;
3375
- result: ITemplate[];
3376
- }
3377
- /**
3378
- * Get the template stars for a template.
3379
- */
3380
- declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IStar[]>;
3381
- /**
3382
- * Toggle the template star for a template.
3383
- */
3384
- declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
3385
- /**
3386
- * Apply a tag to a template.
3387
- */
3388
- declare const addTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, params: ITag) => Promise<ITemplateTag>;
3389
- /**
3390
- * Get all tags for a template.
3391
- */
3392
- declare const getTemplateTags: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateTag[]>;
3393
- /**
3394
- * Remove a tag from a template.
3395
- */
3396
- declare const deleteTemplateTag: (endpoint: VerdocsEndpoint, templateId: string, tagName: string) => Promise<any>;
3397
- /**
3398
- * Create an Organization-wide tag.
3399
- */
3400
- declare const createTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
3401
- /**
3402
- * Get an Organization-wide tag.
3403
- */
3404
- declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>;
3405
- /**
3406
- * Get all tags available for use by an Organization.
3407
- */
3408
- declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;
3409
3268
  type ITemplateSortBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
3410
3269
  type TTemplateVisibilityFilter = "private_shared" | "private" | "shared" | "public";
3411
3270
  interface IGetTemplatesParams {
@@ -3648,62 +3507,82 @@ declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, pa
3648
3507
  */
3649
3508
  declare const deleteTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<string>;
3650
3509
  /**
3651
- * Get all the Template Documents associated to a particular Template.
3652
- *
3653
- * ```typescript
3654
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
3655
- *
3656
- * await TemplateDocument.geTemplateDocuments((VerdocsEndpoint.getDefault(), templateId);
3657
- * ```
3658
- *
3659
- * @group Template Documents
3660
- * @api GET /v2/templates/:template_id/documents List the documents assigned to a template
3661
- * @apiSuccess array(items: ITemplateDocument) . Template documents
3662
- */
3663
- declare const getTemplateDocuments: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateDocument[]>;
3664
- /**
3665
- * Get a specific Document.
3510
+ * Toggle the template star for a template.
3666
3511
  *
3667
3512
  * ```typescript
3668
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
3513
+ * import {toggleTemplateStar} from '@verdocs/js-sdk/Templates';
3669
3514
  *
3670
- * await TemplateDocument.geTemplateDocument((VerdocsEndpoint.getDefault(), templateId,documentId);
3515
+ * await toggleTemplateStar((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
3671
3516
  * ```
3672
3517
  *
3673
- * @group Template Documents
3674
- * @api GET /v2/templates/:template_id/documents/:document_id Get an individual template document
3675
- * @apiSuccess ITemplateDocument . Template document
3518
+ * @group Templates
3519
+ * @api POST /v2/templates/:template_id/star Star or unstar a template (toggle state)
3520
+ * @apiSuccess ITemplate . Success
3676
3521
  */
3677
- declare const getTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<ITemplateDocument>;
3522
+ declare const toggleTemplateStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
3678
3523
  /**
3679
3524
  * Create a Document for a particular Template.
3680
3525
  *
3681
3526
  * ```typescript
3682
3527
  * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
3683
3528
  *
3684
- * await TemplateDocument.createDocument((VerdocsEndpoint.getDefault(), templateID, params);
3529
+ * await TemplateDocument.createDocument(VerdocsEndpoint.getDefault(), templateID, params);
3685
3530
  * ```
3686
3531
  *
3687
3532
  * @group Template Documents
3688
3533
  * @api POST /v2/templates/:template_id/documents Attach a document to a template
3689
3534
  * @apiBody string(format:binary) file Document file to attach. The file name will automatically be used as the document name.
3535
+ * @apiBody string(format:uuid) template_id Template ID to attach the document to
3690
3536
  * @apiSuccess ITemplateDocument . Template document
3691
3537
  */
3692
- declare const createTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplateDocument>;
3538
+ declare const createTemplateDocument: (endpoint: VerdocsEndpoint, template_id: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplateDocument>;
3693
3539
  /**
3694
3540
  * Delete a specific Document.
3695
3541
  *
3696
3542
  * ```typescript
3697
- * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
3543
+ * import {deleteTemplateDocument} from '@verdocs/js-sdk/Templates';
3698
3544
  *
3699
- * await TemplateDocument.deleteDocument((VerdocsEndpoint.getDefault(), templateID, documentID);
3545
+ * await deleteTemplateDocument(VerdocsEndpoint.getDefault(), documentID);
3700
3546
  * ```
3701
3547
  *
3702
3548
  * @group Template Documents
3703
- * @api DELETE /v2/templates/:temlate_id/documents/:document_id Delete a template document
3549
+ * @api DELETE /v2/template-documents/:document_id Delete a template document
3704
3550
  * @apiSuccess string . Success
3705
3551
  */
3706
- declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, templateId: string, documentId: string) => Promise<any>;
3552
+ declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplate>;
3553
+ /**
3554
+ * Get all metadata for a template document. Note that when called by non-creators (e.g. Org Collaborators)
3555
+ * this will return only the **metadata** the caller is allowed to view.
3556
+ *
3557
+ * @group Template Documents
3558
+ * @api GET /v2/envelope-documents/:id Get envelope document
3559
+ * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
3560
+ * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
3561
+ */
3562
+ declare const getTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplateDocument>;
3563
+ /**
3564
+ * Download a document directly.
3565
+ */
3566
+ declare const downloadTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<any>;
3567
+ /**
3568
+ * Get an envelope document's metadata, or the document itself. If no "type" parameter is specified,
3569
+ * the document metadata is returned. If "type" is set to "file", the document binary content is
3570
+ * returned with Content-Type set to the MIME type of the file. If "type" is set to "download", a
3571
+ * string download link will be returned. If "type" is set to "preview" a string preview link will
3572
+ * be returned. This link expires quickly, so it should be accessed immediately and never shared.
3573
+ *
3574
+ * @group Template Documents
3575
+ * @api GET /v2/envelope-documents/:document_id Preview, Download, or Link to a Document
3576
+ * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
3577
+ * @apiQuery string(enum:'file'|'download'|'preview') type? Download the file directly, generate a download link, or generate a preview link.
3578
+ * @apiSuccess string . The generated link.
3579
+ */
3580
+ declare const getTemplateDocumentDownloadLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
3581
+ /**
3582
+ * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
3583
+ * be accessed immediately and never shared. Content-Disposition will be set to "inline".
3584
+ */
3585
+ declare const getTemplateDocumentPreviewLink: (endpoint: VerdocsEndpoint, _envelopeId: string, documentId: string) => Promise<string>;
3707
3586
  /**
3708
3587
  * Get (binary download) a file attached to a Template. It is important to use this method
3709
3588
  * rather than a direct A HREF or similar link to set the authorization headers for the
@@ -3723,21 +3602,38 @@ declare const getTemplateDocumentThumbnail: (endpoint: VerdocsEndpoint, template
3723
3602
  * original asset may be obtained by calling `getTemplateDocumentFile()` or similar.
3724
3603
  */
3725
3604
  declare const getTemplateDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "tagged") => Promise<string>;
3605
+ interface ITemplateTag {
3606
+ tag_name: string;
3607
+ template_id: string;
3608
+ }
3609
+ interface ITag {
3610
+ name: string;
3611
+ featured?: boolean;
3612
+ organization_id?: string;
3613
+ created_at?: string;
3614
+ }
3615
+ interface IStar {
3616
+ template_id: string;
3617
+ profile_id: string;
3618
+ }
3619
+ interface ITemplateSearchResult {
3620
+ page: number;
3621
+ row: number;
3622
+ total: number;
3623
+ result: ITemplate[];
3624
+ }
3726
3625
  interface IValidator {
3727
3626
  name: string;
3728
3627
  regex: string;
3729
3628
  }
3629
+ declare const isValidInput: (value: string, validator: string) => boolean;
3730
3630
  /**
3731
- * Get all defined validators
3732
- *
3733
- * ```typescript
3734
- * import {Documents} from '@verdocs/js-sdk/Templates';
3735
- *
3736
- * await Documents.getDocuments(templateID);
3737
- * ```
3631
+ * Get a list of available validators for field inputs. Note that validators always check strings,
3632
+ * because that is all a user can enter in an HTML input field. Numeric-format validators should
3633
+ * perform any necessary conversions internally. Validators never throw - they just return a boolean.
3634
+ * indicating whether the value is valid.
3738
3635
  */
3739
- declare const getValidators: (endpoint: VerdocsEndpoint) => Promise<IValidator[]>;
3740
- declare const getValidator: (endpoint: VerdocsEndpoint, validatorName: string) => Promise<IValidator>;
3636
+ declare const getValidators: () => string[];
3741
3637
  declare const isValidEmail: (email: string | undefined) => boolean;
3742
3638
  declare const isValidPhone: (phone: string | undefined) => boolean;
3743
3639
  declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
@@ -3856,4 +3752,4 @@ declare const decodeJWTBody: (token: string) => any;
3856
3752
  * the presence of the `document_id` field, which will only be present for signing sessions.
3857
3753
  */
3858
3754
  declare const decodeAccessTokenBody: (token: string) => TSession;
3859
- export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipientStatus, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, verifySigner, delegateRecipient, updateRecipient, remindRecipient, resetRecipient, isEnvelopeOwner, isEnvelopeRecipient, canAccessEnvelope, userIsEnvelopeOwner, userIsEnvelopeRecipient, useCanAccessEnvelope, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipientFromTemplate, ICreateEnvelopeRecipientDirectly, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, IUpdateRecipientParams, ICreateEnvelopeDocumentFromData, ICreateEnvelopeDocumentFromUri, ICreateEnvelopeDocumentFromFile, ICreateEnvelopeFieldFromTemplate, ICreateEnvelopeFieldDirectly, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, IAuthenticateRecipientViaPasscodeRequest, IAuthenticateRecipientViaEmailRequest, IAuthenticateRecipientViaSMSRequest, IKBAResponse, IAuthenticateRecipientViaKBARequest, TAuthenticateRecipientRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
3755
+ export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, getEnvelopesZip, isFieldFilled, isFieldValid, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, startSigningSession, getInPersonLink, verifySigner, delegateRecipient, updateRecipient, remindRecipient, resetRecipient, isEnvelopeOwner, isEnvelopeRecipient, canAccessEnvelope, userIsEnvelopeOwner, userIsEnvelopeRecipient, useCanAccessEnvelope, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipientFromTemplate, ICreateEnvelopeRecipientDirectly, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientStatus, ICreateEnvelopeReminderRequest, IUpdateRecipientParams, ICreateEnvelopeDocumentFromData, ICreateEnvelopeDocumentFromUri, ICreateEnvelopeDocumentFromFile, ICreateEnvelopeFieldFromTemplate, ICreateEnvelopeFieldDirectly, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, IAuthenticateRecipientViaPasscodeRequest, IAuthenticateRecipientViaEmailRequest, IAuthenticateRecipientViaSMSRequest, IKBAResponse, IAuthenticateRecipientViaKBARequest, TAuthenticateRecipientRequest, DEFAULT_DISCLOSURES, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, ITemplateSortBy, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, toggleTemplateStar, createTemplateDocument, deleteTemplateDocument, getTemplateDocument, downloadTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentPreviewLink, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, isValidInput, getValidators, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };