@verdocs/js-sdk 6.6.1 → 6.6.3

package/dist/index.d.mts

@@ -508,7 +508,7 @@ type TAccessKey = IInPersonAccessKey | IInAppAccessKey | IEmailAccessKey | ISMSA
 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. */
+    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. Also, 'complete' does NOT mean "fully signed in all aspects" (see "signed" for that). 'complete' means complete from a user's perspective: all required data has been submitted and workflow steps completed. */
     status: TEnvelopeStatus;
     /** ID of the envelope's creator. */
     profile_id: string;
@@ -540,7 +540,7 @@ interface IEnvelope {
     expires_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";
-    /** If true, the attachments have been signed with the Verdocs AATL signing certificate. */
+    /** If true, the envelope is fully submitted, processed, certificate-generated, and all documents have been stamped and signed. */
     signed: boolean;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
@@ -581,6 +581,8 @@ interface IEnvelopeDocument {
     mime: string;
     /** File size (bytes) */
     size: number;
+    /** Whether the file has been signed. Note that document.signed is different from envelope.signed. Documents are signed first, then the certificate is created and signed, then the envelope is finally marked signed. */
+    signed: boolean;
     /** Collection of width/height dimensions for each page */
     page_sizes: {
         width: number;
@@ -755,6 +757,7 @@ interface IRecipient {
     message: string | null;
     claimed: boolean;
     agreed: boolean;
+    name_locked: boolean;
     key_used_to_conclude?: string;
     environment?: string;
     created_at: string;
@@ -818,7 +821,10 @@ interface IRole {
      * arrange recipients to match related business processes so this field allows for that.
      */
     order: number;
+    // TODO: Most booleans should probably become non-nullable
     delegator: boolean | null;
+    /** If set, the recipient will not be allowed to change their legal name. */
+    name_locked: boolean;
 }
 interface ISignature {
     id: string;
@@ -1480,6 +1486,8 @@ interface IUpdateRecipientParams {
     dob?: string;
     /** If KBA-based authentication is used, the recipient's SSN-Last-4 to prefill. May only be changed if the recipient has not already completed KBA-based auth. */
     ssn_last_4?: string;
+    /** If set, the recipient will not be allowed to change their legal name. */
+    name_locked?: string;
 }
 interface ICreateEnvelopeDocumentFromData {
     /** The order in which the document should be displayed. */
@@ -1665,6 +1673,9 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * be applied at the Organization level before creating an envelope.
  */
 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>";
+// TODO: We need to re-review all of the models and input types/docs to be sure they match the latest
+//  API work.
+// INIT
 /**
  * Create an envelope
  *
@@ -2969,12 +2980,13 @@ declare const getOrganizationMembers: (endpoint: VerdocsEndpoint) => Promise<IPr
  * ```
  *
  * @group Organization Members
+ * @apiParam string(format:uuid) profile_id The Profile ID to remove.
  * @api DELETE /v2/organization-members/:profile_id Delete a member from the organization
  * @apiSuccess string . Success
  */
 declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
 /**
- * Update a member.
+ * Update an organization member.
  *
  * ```typescript
  * import {updateOrganizationMember} from '@verdocs/js-sdk';
@@ -2984,12 +2996,13 @@ declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: s
  *
  * @group Organization Members
  * @api PATCH /v2/organization-members/:profile_id Update an organization member.
- * @apiBody array(items:TRole) roles URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
- * @apiBody string first_name Set to true to enable Webhooks calls.
- * @apiBody string last_name Record<TWebhookEvent, boolean> map of events to enable/disable.
- * @apiSuccess array(items:IProfile) . List of caller's current organization's members
+ * @apiParam string(format:uuid) profile_id The Profile ID to update.
+ * @apiBody string first_name? First name for the member
+ * @apiBody string last_name? Last name for the member
+ * @apiBody array(items:TRole) roles? Roles (e.g. "member" or "admin") to assign to the user.
+ * @apiSuccess IProfile . The updated profile for the member.
  */
-declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Pick<IProfile, "roles" | "first_name" | "last_name">) => Promise<any>;
+declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Partial<Pick<IProfile, "roles" | "first_name" | "last_name">>) => Promise<IProfile>;
 /**
  * Get an organization by ID. Note that this endpoint will return only a subset of fields
  * if the caller is not a member of the organization (the public fields).
@@ -3164,7 +3177,8 @@ declare const getEntitlements: (endpoint: VerdocsEndpoint) => Promise<IEntitleme
  */
 declare const getActiveEntitlements: (endpoint: VerdocsEndpoint) => Promise<Partial<Record<TEntitlement, IEntitlement>>>;
 /**
- * Get the registered Webhook configuration for the caller's organization.
+ * Get the registered Webhook configuration for the caller's organization. Note that an organization
+ * may only have a single Webhook configuration.
  *
  * ```typescript
  * import {getWebhooks} from '@verdocs/js-sdk';
@@ -3193,6 +3207,11 @@ declare const getWebhooks: (endpoint: VerdocsEndpoint) => Promise<IWebhook>;
  * @apiDescription Note that Webhooks cannot currently be deleted, but may be easily disabled by setting `active` to `false` and/or setting the `url` to an empty string.
  * @apiBody string url URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
  * @apiBody boolean active Set to true to enable Webhooks calls.
+ * @apiBody string(enum:'none'|'hmac'|'client_credentials') auth_method? Enable HMAC or Client Credentials authentication for Webhooks calls.
+ * @apiBody string token_endpoint? Required if `auth_method` is set to `client_credentials`. Token endpoint to use for authenticating Webhooks calls.
+ * @apiBody string client_id? Required if `auth_method` is set to `client_credentials`. Client ID to use for authenticating Webhooks calls.
+ * @apiBody string client_secret? Required if `auth_method` is set to `client_credentials`. Client secret to use for authenticating Webhooks calls.
+ * @apiBody string scope? Optional scope to include in authentication calls if `auth_method` is set to `client_credentials`.
  * @apiBody object events Record<TWebhookEvent, boolean> map of events to enable/disable.
  * @apiSuccess IWebhook . The updated Webhooks config for the caller's organization.
  */

package/dist/index.d.ts

@@ -508,7 +508,7 @@ type TAccessKey = IInPersonAccessKey | IInAppAccessKey | IEmailAccessKey | ISMSA
 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. */
+    /** Current status of the envelope. Note that 'complete', 'declined', and 'canceled' are immutable/permanent end states. Also, 'complete' does NOT mean "fully signed in all aspects" (see "signed" for that). 'complete' means complete from a user's perspective: all required data has been submitted and workflow steps completed. */
     status: TEnvelopeStatus;
     /** ID of the envelope's creator. */
     profile_id: string;
@@ -540,7 +540,7 @@ interface IEnvelope {
     expires_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";
-    /** If true, the attachments have been signed with the Verdocs AATL signing certificate. */
+    /** If true, the envelope is fully submitted, processed, certificate-generated, and all documents have been stamped and signed. */
     signed: boolean;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
@@ -581,6 +581,8 @@ interface IEnvelopeDocument {
     mime: string;
     /** File size (bytes) */
     size: number;
+    /** Whether the file has been signed. Note that document.signed is different from envelope.signed. Documents are signed first, then the certificate is created and signed, then the envelope is finally marked signed. */
+    signed: boolean;
     /** Collection of width/height dimensions for each page */
     page_sizes: {
         width: number;
@@ -755,6 +757,7 @@ interface IRecipient {
     message: string | null;
     claimed: boolean;
     agreed: boolean;
+    name_locked: boolean;
     key_used_to_conclude?: string;
     environment?: string;
     created_at: string;
@@ -818,7 +821,10 @@ interface IRole {
      * arrange recipients to match related business processes so this field allows for that.
      */
     order: number;
+    // TODO: Most booleans should probably become non-nullable
     delegator: boolean | null;
+    /** If set, the recipient will not be allowed to change their legal name. */
+    name_locked: boolean;
 }
 interface ISignature {
     id: string;
@@ -1480,6 +1486,8 @@ interface IUpdateRecipientParams {
     dob?: string;
     /** If KBA-based authentication is used, the recipient's SSN-Last-4 to prefill. May only be changed if the recipient has not already completed KBA-based auth. */
     ssn_last_4?: string;
+    /** If set, the recipient will not be allowed to change their legal name. */
+    name_locked?: string;
 }
 interface ICreateEnvelopeDocumentFromData {
     /** The order in which the document should be displayed. */
@@ -1665,6 +1673,9 @@ type TAuthenticateRecipientRequest = IAuthenticateRecipientViaPasscodeRequest |
  * be applied at the Organization level before creating an envelope.
  */
 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>";
+// TODO: We need to re-review all of the models and input types/docs to be sure they match the latest
+//  API work.
+// INIT
 /**
  * Create an envelope
  *
@@ -2969,12 +2980,13 @@ declare const getOrganizationMembers: (endpoint: VerdocsEndpoint) => Promise<IPr
  * ```
  *
  * @group Organization Members
+ * @apiParam string(format:uuid) profile_id The Profile ID to remove.
  * @api DELETE /v2/organization-members/:profile_id Delete a member from the organization
  * @apiSuccess string . Success
  */
 declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
 /**
- * Update a member.
+ * Update an organization member.
  *
  * ```typescript
  * import {updateOrganizationMember} from '@verdocs/js-sdk';
@@ -2984,12 +2996,13 @@ declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: s
  *
  * @group Organization Members
  * @api PATCH /v2/organization-members/:profile_id Update an organization member.
- * @apiBody array(items:TRole) roles URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
- * @apiBody string first_name Set to true to enable Webhooks calls.
- * @apiBody string last_name Record<TWebhookEvent, boolean> map of events to enable/disable.
- * @apiSuccess array(items:IProfile) . List of caller's current organization's members
+ * @apiParam string(format:uuid) profile_id The Profile ID to update.
+ * @apiBody string first_name? First name for the member
+ * @apiBody string last_name? Last name for the member
+ * @apiBody array(items:TRole) roles? Roles (e.g. "member" or "admin") to assign to the user.
+ * @apiSuccess IProfile . The updated profile for the member.
  */
-declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Pick<IProfile, "roles" | "first_name" | "last_name">) => Promise<any>;
+declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Partial<Pick<IProfile, "roles" | "first_name" | "last_name">>) => Promise<IProfile>;
 /**
  * Get an organization by ID. Note that this endpoint will return only a subset of fields
  * if the caller is not a member of the organization (the public fields).
@@ -3164,7 +3177,8 @@ declare const getEntitlements: (endpoint: VerdocsEndpoint) => Promise<IEntitleme
  */
 declare const getActiveEntitlements: (endpoint: VerdocsEndpoint) => Promise<Partial<Record<TEntitlement, IEntitlement>>>;
 /**
- * Get the registered Webhook configuration for the caller's organization.
+ * Get the registered Webhook configuration for the caller's organization. Note that an organization
+ * may only have a single Webhook configuration.
  *
  * ```typescript
  * import {getWebhooks} from '@verdocs/js-sdk';
@@ -3193,6 +3207,11 @@ declare const getWebhooks: (endpoint: VerdocsEndpoint) => Promise<IWebhook>;
  * @apiDescription Note that Webhooks cannot currently be deleted, but may be easily disabled by setting `active` to `false` and/or setting the `url` to an empty string.
  * @apiBody string url URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
  * @apiBody boolean active Set to true to enable Webhooks calls.
+ * @apiBody string(enum:'none'|'hmac'|'client_credentials') auth_method? Enable HMAC or Client Credentials authentication for Webhooks calls.
+ * @apiBody string token_endpoint? Required if `auth_method` is set to `client_credentials`. Token endpoint to use for authenticating Webhooks calls.
+ * @apiBody string client_id? Required if `auth_method` is set to `client_credentials`. Client ID to use for authenticating Webhooks calls.
+ * @apiBody string client_secret? Required if `auth_method` is set to `client_credentials`. Client secret to use for authenticating Webhooks calls.
+ * @apiBody string scope? Optional scope to include in authentication calls if `auth_method` is set to `client_credentials`.
  * @apiBody object events Record<TWebhookEvent, boolean> map of events to enable/disable.
  * @apiSuccess IWebhook . The updated Webhooks config for the caller's organization.
  */

package/dist/index.js

@@ -1529,6 +1529,9 @@ class VerdocsEndpoint {
     }
 }
 
+// TODO: We need to re-review all of the models and input types/docs to be sure they match the latest
+//  API work.
+// INIT
 /**
  * Create an envelope
  *
@@ -3446,6 +3449,7 @@ const getOrganizationMembers = (endpoint) => endpoint.api //
  * ```
  *
  * @group Organization Members
+ * @apiParam string(format:uuid) profile_id The Profile ID to remove.
  * @api DELETE /v2/organization-members/:profile_id Delete a member from the organization
  * @apiSuccess string . Success
  */
@@ -3453,7 +3457,7 @@ const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
     .delete(`/v2/organization-members/${profileId}`)
     .then((r) => r.data);
 /**
- * Update a member.
+ * Update an organization member.
  *
  * ```typescript
  * import {updateOrganizationMember} from '@verdocs/js-sdk';
@@ -3463,10 +3467,11 @@ const deleteOrganizationMember = (endpoint, profileId) => endpoint.api //
  *
  * @group Organization Members
  * @api PATCH /v2/organization-members/:profile_id Update an organization member.
- * @apiBody array(items:TRole) roles URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
- * @apiBody string first_name Set to true to enable Webhooks calls.
- * @apiBody string last_name Record<TWebhookEvent, boolean> map of events to enable/disable.
- * @apiSuccess array(items:IProfile) . List of caller's current organization's members
+ * @apiParam string(format:uuid) profile_id The Profile ID to update.
+ * @apiBody string first_name? First name for the member
+ * @apiBody string last_name? Last name for the member
+ * @apiBody array(items:TRole) roles? Roles (e.g. "member" or "admin") to assign to the user.
+ * @apiSuccess IProfile . The updated profile for the member.
  */
 const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api //
     .patch(`/v2/organization-members/${profileId}`, params)
@@ -3701,7 +3706,8 @@ const getActiveEntitlements = async (endpoint) => {
  * @module
  */
 /**
- * Get the registered Webhook configuration for the caller's organization.
+ * Get the registered Webhook configuration for the caller's organization. Note that an organization
+ * may only have a single Webhook configuration.
  *
  * ```typescript
  * import {getWebhooks} from '@verdocs/js-sdk';
@@ -3732,6 +3738,11 @@ const getWebhooks = (endpoint) => endpoint.api //
  * @apiDescription Note that Webhooks cannot currently be deleted, but may be easily disabled by setting `active` to `false` and/or setting the `url` to an empty string.
  * @apiBody string url URL to send Webhook events to. An empty or invalid URL will disable Webhook calls.
  * @apiBody boolean active Set to true to enable Webhooks calls.
+ * @apiBody string(enum:'none'|'hmac'|'client_credentials') auth_method? Enable HMAC or Client Credentials authentication for Webhooks calls.
+ * @apiBody string token_endpoint? Required if `auth_method` is set to `client_credentials`. Token endpoint to use for authenticating Webhooks calls.
+ * @apiBody string client_id? Required if `auth_method` is set to `client_credentials`. Client ID to use for authenticating Webhooks calls.
+ * @apiBody string client_secret? Required if `auth_method` is set to `client_credentials`. Client secret to use for authenticating Webhooks calls.
+ * @apiBody string scope? Optional scope to include in authentication calls if `auth_method` is set to `client_credentials`.
  * @apiBody object events Record<TWebhookEvent, boolean> map of events to enable/disable.
  * @apiSuccess IWebhook . The updated Webhooks config for the caller's organization.
  */