@verdocs/js-sdk 4.2.136 → 4.2.148

package/README.md

@@ -5,32 +5,10 @@
 This SDK provides convenience wrappers for both Browser-based and NodeJS applications to call the Verdocs API, with strong typing and
 documentation to help you get started quickly developing for the Verdocs platform.
 
-## Getting Started
+Please see the [Documentation](https://developers.verdocs.com/sdks/js-ts/overview) for installation
+and usage instructions.
 
-First add this module to your project:
-
-    npm install --save @verdocs/js-sdk
-
-or:
-
-    yarn add @verdocs/js-sdk
-
-This package is namespaced into packages that organize API calls into functional groups. A top-level `export *` is provided for simplicity,
-but to enable Tree Shaking to do its job, it is recommended that you only import the package required for a given task. For example, to
-perform a simple authentication request:
-
-```typescript
-import {Auth} from '@verdocs/js-sdk/Auth';
-import {Transport} from '@verdocs/js-sdk/HTTP';
-
-const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', password: 'MY_PASSWORD'});
-Transport.setAuthToken(accessToken);
-```
-
-Once you are authenticated, you can use the rest of the controls and embeds within an app. For instance, to provide a simple PDF
-viewer for a document stored within Verdocs:
-
-## Documentation
+## Structure
 
 Verdocs functions are organized into high-level modules that represent the main objects within the platform:
 
@@ -45,25 +23,6 @@ Please see the [API Docs](https://github.com/Verdocs/js-sdk/tree/main/docs) for
 
 ## Contributing
 
-To avoid the presence of the `dist/` distribution directory appearing in package imports, when this project is built, this `README.md`
-and other support files are copied there. Be sure to run `npm version patch` from THIS directory, but the publish command from within
-the `dist` folder.
-
-## HTTP Transport
-
-The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
-project, a `Transport` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
-may be configured by importing it. Please see the [Axios Documentation](https://github.com/axios/axios) for more information on the
-options available. For example, to override the default API call timeout of 3s:
-
-```typescript
-import {Transport} from '@verdocs/js-sdk/Auth/HTTP';
-
-Transport.setTimeout(5000);
-```
-
-## Contributing
-
 This repository is actively maintained and supported by [Verdocs](https://verdocs.com/). We welcome community contributions and
 suggestions! Please file a pull request with any change requests and we will review them as soon as possible.
 
@@ -72,4 +31,3 @@ suggestions! Please file a pull request with any change requests and we will rev
 Currently, we have placeholder tests for a number of functions but had to disable the test suite. See
 https://jestjs.io/docs/ecmascript-modules and https://github.com/facebook/jest/issues/10025 for more information. Since we manage our
 own transport endpoint, we can probably do this mocking ourselves and eliminate the dependency in the first place.
-

package/dist/README.md

@@ -5,32 +5,10 @@
 This SDK provides convenience wrappers for both Browser-based and NodeJS applications to call the Verdocs API, with strong typing and
 documentation to help you get started quickly developing for the Verdocs platform.
 
-## Getting Started
+Please see the [Documentation](https://developers.verdocs.com/sdks/js-ts/overview) for installation
+and usage instructions.
 
-First add this module to your project:
-
-    npm install --save @verdocs/js-sdk
-
-or:
-
-    yarn add @verdocs/js-sdk
-
-This package is namespaced into packages that organize API calls into functional groups. A top-level `export *` is provided for simplicity,
-but to enable Tree Shaking to do its job, it is recommended that you only import the package required for a given task. For example, to
-perform a simple authentication request:
-
-```typescript
-import {Auth} from '@verdocs/js-sdk/Auth';
-import {Transport} from '@verdocs/js-sdk/HTTP';
-
-const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', password: 'MY_PASSWORD'});
-Transport.setAuthToken(accessToken);
-```
-
-Once you are authenticated, you can use the rest of the controls and embeds within an app. For instance, to provide a simple PDF
-viewer for a document stored within Verdocs:
-
-## Documentation
+## Structure
 
 Verdocs functions are organized into high-level modules that represent the main objects within the platform:
 
@@ -45,25 +23,6 @@ Please see the [API Docs](https://github.com/Verdocs/js-sdk/tree/main/docs) for
 
 ## Contributing
 
-To avoid the presence of the `dist/` distribution directory appearing in package imports, when this project is built, this `README.md`
-and other support files are copied there. Be sure to run `npm version patch` from THIS directory, but the publish command from within
-the `dist` folder.
-
-## HTTP Transport
-
-The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
-project, a `Transport` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
-may be configured by importing it. Please see the [Axios Documentation](https://github.com/axios/axios) for more information on the
-options available. For example, to override the default API call timeout of 3s:
-
-```typescript
-import {Transport} from '@verdocs/js-sdk/Auth/HTTP';
-
-Transport.setTimeout(5000);
-```
-
-## Contributing
-
 This repository is actively maintained and supported by [Verdocs](https://verdocs.com/). We welcome community contributions and
 suggestions! Please file a pull request with any change requests and we will review them as soon as possible.
 
@@ -72,4 +31,3 @@ suggestions! Please file a pull request with any change requests and we will rev
 Currently, we have placeholder tests for a number of functions but had to disable the test suite. See
 https://jestjs.io/docs/ecmascript-modules and https://github.com/facebook/jest/issues/10025 for more information. Since we manage our
 own transport endpoint, we can probably do this mocking ourselves and eliminate the dependency in the first place.
-

package/dist/index.d.mts

@@ -458,12 +458,19 @@ type TAccessKey = IInPersonAccessKey | IInAppAccessKey | IEmailAccessKey | ISMSA
  * process.
  */
 interface IEnvelope {
+    /** Unique identifier for the envelope (UUID) */
     id: string;
+    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. */
     status: TEnvelopeStatus;
+    /** ID of the envelope's creator. */
     profile_id: string;
+    /** ID of the template from which the envelope was created. */
     template_id: string | null;
+    /** ID of the organization to which the envelope belongs. */
     organization_id: string;
+    /** Name of the envelope. By defaut, inherited from the envelope's template, but may be overridden when the envelope is created. */
     name: string;
+    /** If set to true, no email or SMS messages will be sent to any of the envelope's recipients. */
     no_contact?: boolean;
     /** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
     initial_reminder: number | null;
@@ -471,8 +478,11 @@ interface IEnvelope {
     followup_reminders: number | null;
     /** When the next reminder is scheduled to be sent. */
     next_reminder: string | null;
+    /** Date/time when the envelope was created. */
     created_at: string;
+    /** Date/time when the envelope was created. */
     updated_at: string;
+    /** Date/time when the envelope was canceled, or null. */
     canceled_at: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
@@ -1338,19 +1348,52 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
  * const request: ICreateEnvelopeRequest = {template_id: 'd2338742-f3a1-465b-8592-806587413cc1', name: 'Bill of Sale', roles: [role1, role2]};
  * const {id, recipients} = await Envelopes.createEnvelope(VerdocsEndpoint.getDefault(), request);
  * ```
+ *
+ * @group Envelopes
+ * @api POST /v2/envelopes Create Envelope
+ * @apiBody string(format:uuid) template_id The template to base the new Envelope from
+ * @apiBody array(items:ICreateEnvelopeRecipient) recipients A list of recipients to include in the workflow. Must specify one recipient to match each template Role.
+ * @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 array(items:IEnvelopeField) fields? Provide default values for fields in the envelope. Note that only "name", "role_name", and "default" should be set in this array.
+ * @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.
+ * @apiBody integer(min: 0) followup_reminders? Override the template initial-reminder setting.
+ * @apiSuccess IEnvelope . The newly-created envelope.
  */
 declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;
 /**
- * Get all metadata for an Envelope.
+ * Get all metadata for an envelope. Note that when called by non-creators (e.g. Recipients)
+ * this will return only the **metadata** the caller is allowed to view.
+ *
+ * @group Envelopes
+ * @api GET /v2/envelopes/:id Get Envelope Details
+ * @apiParam string(format: 'uuid') id The ID of the envelope to retrieve.
+ * @apiSuccess IEnvelope . The detailed metadata for the envelope requested
  */
 declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IEnvelope>;
 /**
- * Get an Envelope Document
+ * Get all metadata for an envelope document. Note that when called by non-creators (e.g. Recipients)
+ * this will return only the **metadata** the caller is allowed to view.
+ *
+ * @group Envelopes
+ * @api GET /envelopes/:id Get Envelope Details
+ * @apiParam string(format: 'uuid') id The ID of the document to retrieve.
+ * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
  */
 declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<IEnvelopeDocument>;
 /**
  * Get a pre-signed download link for an Envelope Document. This link expires quickly, so it should
  * be accessed immediately and never shared. Content-Disposition will be set to "download".
+ *
+ * @group Envelopes
+ * @api GET /envelopes/:envelope_id/envelope_documents/:document_id Preview, Download, or Link to a Document
+ * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
+ * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
+ * @apiQuery boolean download? Set to true to generate a download link (content-disposition: download).
+ * @apiQuery boolean preview? Set to true to generate a preview link (content-disposition: inline).
+ * @apiQuery boolean file? Set to true to return the raw binary BLOB data of the file rather than a link.
+ * @apiSuccess string . The generated link.
  */
 declare const getDocumentDownloadLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
 /**
@@ -1360,6 +1403,12 @@ declare const getDocumentDownloadLink: (endpoint: VerdocsEndpoint, envelopeId: s
 declare const getDocumentPreviewLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
 /**
  * Cancel an Envelope.
+ *
+ * @group Envelopes
+ * @api PUT /v2/envelopes/:id Cancel envelope
+ * @apiParam string(format: 'uuid') id The ID of the envelope to cancel.
+ * @apiBody string(enum: 'cancel') action The action to perform (currently only "cancel" is supported).
+ * @apiSuccess IEnvelope . The updated envelope.
  */
 declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<TEnvelopeUpdateResult>;
 /**
@@ -1370,38 +1419,89 @@ declare const cancelEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) =>
 declare const getEnvelopeFile: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<any>;
 /**
  * Update an envelope. Currently, only reminder settings may be changed.
+ *
+ * @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.
+ * @apiSuccess IEnvelope . A copy of the newly-updated envelope.
  */
 declare const updateEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string, params: Pick<IEnvelope, "initial_reminder" | "followup_reminders">) => Promise<IEnvelope>;
 /**
  * Update a Document field. Typically called during the signing process as a Recipient fills in fields.
+ *
+ * @group Envelopes
+ * @api PUT /envelopes/:envelope_id/fields/:field_name Update Envelope Field
+ * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
+ * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
+ * @apiBody IEnvelopeFieldSettings . Set of properties to update. Leave undefined any properties that should not be changed.
+ * @apiSuccess IEnvelope . A copy of the newly-updated field.
  */
 declare const updateEnvelopeField: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, value: any) => Promise<IEnvelopeFieldSettings>;
 /**
- * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
- * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
+ * Apply a signature to a signature field. Signature fields are ID-driven. Call `createSignature()`
+ * first to create a signature for a Recipient, then call `updateEnvelopeFieldSignature()` to
+ * attach it to a field.
+ *
+ * @group Envelopes
+ * @api PUT /envelopes/:envelope_id/fields/:field_name/signature/:signature_id Update Envelope
+ * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
+ * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
+ * @apiParam string(format: 'uuid') signature_id The ID of the signature to attach.
+ * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
  */
 declare const updateEnvelopeFieldSignature: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, signatureId: string) => Promise<IEnvelopeFieldSettings>;
 /**
- * Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
- * signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
+ * Apply an initial to an initials field. Initial fields are ID-driven. Call `createInitial()`
+ * first to create an initial block for a Recipient, then call `supdateEnvelopeFieldInitials()` to
+ * attach it to a field.
+ *
+ * @group Envelopes
+ * @api PUT /envelopes/:envelope_id/fields/:field_name/initial/:initial_id Update Envelope
+ * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
+ * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
+ * @apiParam string(format: 'uuid') initial_id The ID of the initial block to attach.
+ * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
  */
 declare const updateEnvelopeFieldInitials: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, initialId: string) => Promise<IEnvelopeFieldSettings>;
 /**
- * Upload an attachment.
+ * Upload an attachment to an attachment field
+ *
+ * @group Envelopes
+ * @api PUT /envelopes/:envelope_id/fields/:field_name Upload or Delete Attachment
+ * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to update.
+ * @apiParam string field_name The name of the field to update. Be sure to URL-encode the value.
+ * @apiBody string document The file to attach. Must contain standard File object fields. If omitted, the attachment will be deleted instead.
+ * @apiSuccess IEnvelopeFieldSettings . A copy of the newly-updated field.
  */
 declare const uploadEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IEnvelopeFieldSettings>;
 /**
- * Delete an attachment.
+ * Delete an attachment. Note that this is not a DELETE endpoint because the field itself is not
+ * being deleted. Instead, it is a similar operation to uploading a new attachment, but the
+ * omission of the attachment signals the server to delete the current entry.
  */
 declare const deleteEnvelopeFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<IEnvelopeFieldSettings>;
 /**
- * Get the attached file for an attachment field (if any)
+ * Get the attached file for an attachment field (if any).
+ *
+ * @group Envelopes
+ * @api GET /envelopes/:envelope_id/fields/:field_name/document Download attachment in binary format
+ * @apiParam string(format: 'uuid') envelope_id The ID of the envelope to retrieve.
+ * @apiParam string field_name The name of the field from which to download the attachment.
+ * @apiSuccess string . The file binary data.
  */
 declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string, fieldName: string) => Promise<any>;
 /**
  * Get a display URI for a given page in a file attached to an envelope document. These pages are rendered server-side
  * into PNG resources suitable for display in IMG tags although they may be used elsewhere. Note that these are intended
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
+ *
+ * @group Envelopes
+ * @api GET /v2/envelope-documnets/page-image/:document_id/:variant/:page Get Document Page Display URI
+ * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
+ * @apiParam string(enum: 'original'|'filled') variant The variant of the document to retrieve.
+ * @apiParam integer page The page number to retrieve
+ * @apiSuccess string . The page display URI. Note that this is a signed URL with a short expiration. It should be used immediately and never databased or cached.
  */
 declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, documentId: string, page: number, variant?: "original" | "filled" | "certificate") => Promise<string>;
 interface ITimeRange {
@@ -1429,6 +1529,24 @@ interface IListEnvelopesParams {
  *
  * const {count, envelopes} = await getEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test' });
  * ```
+ *
+ * @group Envelopes
+ * @api GET /v2/envelopes List Envelopes
+ * @apiQuery string q? Match envelopes whose name contains this string
+ * @apiQuery string(enum: 'inbox' | 'sent' | 'action' | 'waiting' | 'completed') view? Request pre-defined view. `inbox` returns envelopes where action is required by the caller. `sent` returns envelopes created by the caller. `action` returns envelopes where action is required by the caller. `waiting` returns envelopes where action is required by anyone. `completed` returns envelopes where all actions are complete.
+ * @apiQuery array(items: 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled') status? Match envelopes in one of the specified states.
+ * @apiQuery boolean(default: false) include_org? If true, include organizations-shared envelopes
+ * @apiQuery string(format: uuid) template_id? Match envelopes created from the specified template ID
+ * @apiQuery string(format: date-time) created_before? Match envelopes created before this date
+ * @apiQuery string(format: date-time) created_after? Match envelopes created after this date
+ * @apiQuery string(enum: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status') sort_by? Return results sorted by this criteria
+ * @apiQuery boolean ascending? Set true/false to override the sort direction. Note that the default depends on `sort_by`. Date-based sorts default to descending, while name and status default to ascending.
+ * @apiQuery integer(default: 20) rows? Limit the number of rows returned
+ * @apiQuery integer(default: 0) page? Specify which page of results to return
+ * @apiSuccess integer(format: int32) count The total number of records matching the query, helpful for pagination
+ * @apiSuccess integer(format: int32) rows The number of rows returned in this response page
+ * @apiSuccess integer(format: int32) page The page number of this response
+ * @apiSuccess array(items: IEnvelope) envelopes List of envelopes found
  */
 declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<{
     count: number;
@@ -1441,6 +1559,11 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
  * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
  * create and store an initials block. Thereafter, the ID of the initials block may be re-used for each initials field
  * to be "stamped" by the user.
+ *
+ * @group Signatures and Initials
+ * @api POST /initials Create Initial Block
+ * @apiBody string initial Blob containing initials image to store.
+ * @apiSuccess IInitial . The newly-created initial block.
  */
 declare const createInitials: (endpoint: VerdocsEndpoint, name: string, initials: Blob) => Promise<IInitial>;
 /**
@@ -1527,18 +1650,28 @@ interface IKbaIdentity {
  */
 declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, identity: IKbaIdentity) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 interface IKbaChallengeResponse {
-    responses: {
-        type: string;
-        answer: string | number;
-    }[];
+    type: string;
+    answer: string | number;
 }
 /**
  * Submit an identity response to a KBA challenge. Answers should be submitted in the same order as
  * the challenges were listed in `IRecipientKbaStepChallenge.questions`.
  */
-declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, response: IKbaChallengeResponse) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, responses: IKbaChallengeResponse[]) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
- * Update a recipient's status block
+ * Update a recipient's status.
+ *
+ * @group Recipients
+ * @api PUT /envelopes/:envelope_id/recipients/:role_name Update Recipient Status
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
+ * @apiParam string role_name The role to adjust.
+ * @apiBody string(enum:'submit'|'decline'|'owner_update'|'update'|'prepare') action The action to take. Adjusts the status, and may also perform other operations.
+ * @apiBody string first_name? Ignored unless action is 'owner_update' or 'update'. The new owner's or recipient's first name.
+ * @apiBody string last_name? Ignored unless action is 'owner_update' or 'update'. The new owner's or recipient's last name.
+ * @apiBody string email? Ignored unless action is 'owner_update'. The new owner's email address.
+ * @apiBody boolean agreed? Ignored unless action is 'update'. Set to true to accept the e-signing disclosures.
+ * @apiBody array(items:IRecipient) recipients? Ignored unless action is 'prepare'. A list of recipients and their fields to set defaults for.
+ * @apiSuccess IRecipient . The updated Recipient.
  */
 declare const updateRecipient: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
 /**
@@ -1567,14 +1700,32 @@ declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeI
 declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
 /**
  * Begin a signing session for an Envelope. This path requires an invite code, and should generally
- * be called with a NON-default endpoint to avoid conflicting with any active user session the user
+ * be called with a NON-default Endpoint to avoid conflicting with any active user session the user
  * may have. To initiate in-person signing by an authenticated user (e.g. self-signing), call
  * getInPersonLink() instead. The response from that call includes both a link for direct signing
  * via a Web browser as well as an in-person access_key. That access_key.key may be used here as well.
+ *
+ * @group Recipients
+ * @api POST /v2/sign/unauth/:envelope_id/:role_name/:key Start Signing Session
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
+ * @apiParam string role_name The role to request.
+ * @apiParam string key Access key generated by the envelope creator or email/SMS invite.
+ * @apiSuccess ISignerTokenResponse . Signing session token and envelope/recipient metadata.
  */
 declare const startSigningSession: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, key: string) => Promise<ISignerTokenResponse>;
 /**
- * Get an in-person signing link.
+ * Get an in-person signing link. Must be called by the owner/creator of the envelope. The response
+ * also includes the raw access key that may be used to directly initiate a signing session (see
+ * `startSigningSession`) as well as an access token representing a valid signing session for
+ * immediate use in embeds or other applications. Note that in-person signing is considered a
+ * lower-security operation than authenticated signing, and the final envelope certificate will
+ * reflect this.
+ *
+ * @group Recipients
+ * @api POST /v2/sign/in-person/:envelope_id/:role_name Get In-Person Signing Link
+ * @apiParam string(format:uuid) envelope_id The envelope to operate on.
+ * @apiParam string role_name The role to request.
+ * @apiSuccess IInPersonLinkResponse . Signing session token and envelope/recipient metadata.
  */
 declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string) => Promise<IInPersonLinkResponse>;
 /**
@@ -1582,7 +1733,17 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  */
 declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IEnvelope>;
 /**
- * Resend a recipient's invitation.
+ * 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.
+ * @apiSuccess string . Success message.
  */
 declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;
 /**
@@ -1635,18 +1796,39 @@ declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
  * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
  * create and store a signature block. Thereafter, the ID of the signature block may be re-used for each signature field
  * to be "stamped" by the user.
+ *
+ * @group Signatures and Initials
+ * @api POST /signatures Create Signature Block
+ *
+ * @apiBody string signature Blob containing signature image to store.
+ * @apiSuccess ISignature . The newly-created signature block.
  */
 declare const createSignature: (endpoint: VerdocsEndpoint, name: string, signature: Blob) => Promise<ISignature>;
 /**
- * Get the availbable signatures for a user.
+ * Get the available signatures for a user.
+ *
+ * @group Signatures and Initials
+ * @api GET /signatures Create Signature Block
+ *
+ * @apiSuccess array(items:ISignature) . A list of signatures previously stored for the user.
  */
 declare const getSignatures: (endpoint: VerdocsEndpoint) => Promise<ISignature[]>;
 /**
  * Get a user's signature by ID.
+ *
+ * @group Signatures and Initials
+ * @api GET /signatures/:id Delete Signature Block
+ * @apiParam string(format: 'uuid') id The ID of the signature to delete.
+ * @apiSuccess ISignature . The signature metadata requested.
  */
 declare const getSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
 /**
  * Delete a user's signature.
+ *
+ * @group Signatures and Initials
+ * @api DELETE /signatures/:id Delete Signature Block
+ * @apiParam string(format: 'uuid') id The ID of the signature to delete.
+ * @apiSuccess string . OK
  */
 declare const deleteSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
 interface ICreateApiKeyRequest {
@@ -1925,6 +2107,11 @@ type TAuthenticationRequest = IROPCRequest | IClientCredentialsRequest | IRefres
  * const {access_token} = await Auth.authenticate({ client_id: '...', client_secret: '...', grant_type:'client_credentials' });
  * VerdocsEndpoint.getDefault().setAuthToken(access_token);
  * ```
+ *
+ * @group Authentication
+ * @api POST /v2/oauth2/token Authenticate
+ * @apiBody string(format: 'uuid') id The ID of the envelope to retrieve.
+ * @apiSuccess IAuthenticateResponse . The detailed metadata for the envelope requested
  */
 declare const authenticate: (endpoint: VerdocsEndpoint, params: TAuthenticationRequest) => Promise<IAuthenticateResponse>;
 /**
@@ -2466,7 +2653,7 @@ interface IGetTemplatesParams {
     /** List only those templates created by the caller. */
     is_creator?: boolean;
     /** Visibility status of templates to include. private_shared is the default (private + shared) */
-    visibility: TTemplateVisibilityFilter;
+    visibility?: TTemplateVisibilityFilter;
     /** Sort order */
     sort_by?: TSortTemplateBy;
     /** Set to true or false to control the sort order. Omit this field to sort dates descending, names ascending. */
@@ -2487,6 +2674,21 @@ interface IGetTemplatesParams {
  * await getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
  * await getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
  * ```
+ *
+ * @group Templates
+ * @api GET /v2/templates Get Templates
+ * @apiQuery string q? Find templates whose names/descriptions contain the specified query string
+ * @apiQuery boolean is_starred? If true, returns only templates with at least one "star".
+ * @apiQuery boolean is_creator? If true, returns only templates that the caller created.
+ * @apiQuery string(enum: 'private_shared' | 'private' | 'shared' | 'public') visibility? Return only templates with the specified visibility.
+ * @apiQuery string(enum: 'created_at' | 'updated_at' | 'name' | 'last_used_at' | 'counter' | 'star_counter') sort_by? Return results sorted by this criteria
+ * @apiQuery boolean ascending? Set true/false to override the sort direction. Note that the default depends on `sort_by`. Date-based sorts default to descending, while name defaults to ascending.
+ * @apiQuery integer(default: 20) rows? Limit the number of rows returned
+ * @apiQuery integer(default: 0) page? Specify which page of results to return
+ * @apiSuccess integer(format: int32) count The total number of records matching the query, helpful for pagination
+ * @apiSuccess integer(format: int32) rows The number of rows returned in this response page
+ * @apiSuccess integer(format: int32) page The page number of this response
+ * @apiSuccess array(items: ITemplate) templates List of templates found
  */
 declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<{
     count: number;