@verdocs/js-sdk 6.6.2 → 6.7.0

package/dist/index.d.mts

@@ -236,6 +236,17 @@ interface INotification {
     time: string;
     profile?: IProfile;
 }
+interface INotificationTemplate {
+    id: string;
+    organization_id: string;
+    type: TNotificationType;
+    event_name: TEventName;
+    template_id?: string;
+    html_template?: string;
+    text_template?: string;
+    template?: ITemplate;
+    organization: IOrganization;
+}
 //////////////////////////////////////// IAM //////////////////////////////
 interface IApiKey {
     client_id: string;
@@ -508,7 +519,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 +551,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 +592,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;
@@ -1062,6 +1075,8 @@ type TUsageType = "envelope" | "envelope_canceled" | "envelope_completed" | "env
  * Methods for authenticating webhook requests.
  */
 type TWebhookAuthMethod = "none" | "hmac" | "client_credentials";
+type TNotificationType = "sms" | "email" | "app";
+type TEventName = "invitation:canceled" | "transaction:completed" | "envelope:failed" | "envelope:expired" | "envelope:declined" | "envelope:cc" | "recipient:reminder" | "transaction:requested" | "envelope:delegated" | "envelope:completed" | "transaction:canceled" | "user:invited" | "recipient:invited" | "envelope:canceled" | "transaction:sent" | "envelope:signed" | "email:verify" | "email:otp" | "password:reset" | "recipient:question";
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
 declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
@@ -2325,6 +2340,17 @@ interface ISetWebhookRequest {
     auth_method: TWebhookAuthMethod;
     events: Record<TWebhookEvent, boolean>;
 }
+interface ICreateNotificationTemplateRequest {
+    type: TNotificationType;
+    event_name: TEventName;
+    template_id?: string;
+    html_template?: string;
+    text_template?: string;
+}
+interface IUpdateNotificationTemplateRequest {
+    html_template?: string;
+    text_template?: string;
+}
 /**
  * Get a list of keys for a given organization. The caller must have admin access to the organization.
  *
@@ -3001,6 +3027,93 @@ declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: s
  * @apiSuccess IProfile . The updated profile for the member.
  */
 declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Partial<Pick<IProfile, "roles" | "first_name" | "last_name">>) => Promise<IProfile>;
+/**
+ * Get all notification templates for the caller's organization.
+ *
+ * ```typescript
+ * import {getNotificationTemplates} from '@verdocs/js-sdk';
+ *
+ * const templates = await getNotificationTemplates();
+ * ```
+ *
+ * @group Notifications
+ * @api GET /v2/notifications/templates Get notification templates
+ * @apiSuccess array(items: INotificationTemplate) . A list of notification templates for the caller's organization.
+ */
+declare const getNotificationTemplates: (endpoint: VerdocsEndpoint) => Promise<INotificationTemplate[]>;
+/**
+ * Get a single notification template by ID.
+ *
+ * ```typescript
+ * import {getNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const template = await getNotificationTemplate(TEMPLATEID);
+ * ```
+ *
+ * @group Notifications
+ * @api GET /v2/notifications/templates/:id Get notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiSuccess INotificationTemplate . The requested notification template.
+ */
+declare const getNotificationTemplate: (endpoint: VerdocsEndpoint, id: string) => Promise<INotificationTemplate>;
+/**
+ * Create a notification template. Only one template may exist per combination of type and
+ * event_name. At least one of `html_template` or `text_template` must be provided.
+ *
+ * ```typescript
+ * import {createNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const template = await createNotificationTemplate({
+ *   type: 'email',
+ *   event_name: 'recipient:invited',
+ *   html_template: '<p>You have been invited to sign a document.</p>',
+ * });
+ * ```
+ *
+ * @group Notifications
+ * @api POST /v2/notifications/templates Create notification template
+ * @apiBody string(enum:'sms'|'email'|'app') type The notification channel type.
+ * @apiBody string event_name The event that triggers this notification.
+ * @apiBody string template_id? Optional reference to an associated template.
+ * @apiBody string html_template? The HTML content for the notification. At least one of html_template or text_template is required.
+ * @apiBody string text_template? The plain-text content for the notification. At least one of html_template or text_template is required.
+ * @apiSuccess INotificationTemplate . The newly-created notification template.
+ */
+declare const createNotificationTemplate: (endpoint: VerdocsEndpoint, params: ICreateNotificationTemplateRequest) => Promise<INotificationTemplate>;
+/**
+ * Update a notification template. At least one of `html_template` or `text_template` must be provided.
+ *
+ * ```typescript
+ * import {updateNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const updated = await updateNotificationTemplate(TEMPLATEID, {
+ *   html_template: '<p>Updated content.</p>',
+ * });
+ * ```
+ *
+ * @group Notifications
+ * @api PATCH /v2/notifications/templates/:id Update notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiBody string html_template? The HTML content for the notification. At least one of html_template or text_template is required.
+ * @apiBody string text_template? The plain-text content for the notification. At least one of html_template or text_template is required.
+ * @apiSuccess INotificationTemplate . The updated notification template.
+ */
+declare const updateNotificationTemplate: (endpoint: VerdocsEndpoint, id: string, params: IUpdateNotificationTemplateRequest) => Promise<INotificationTemplate>;
+/**
+ * Delete a notification template.
+ *
+ * ```typescript
+ * import {deleteNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * await deleteNotificationTemplate(TEMPLATEID);
+ * ```
+ *
+ * @group Notification Templates
+ * @api DELETE /v2/notifications/templates/:id Delete notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiSuccess string . Success.
+ */
+declare const deleteNotificationTemplate: (endpoint: VerdocsEndpoint, id: string) => Promise<any>;
 /**
  * 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).
@@ -3738,9 +3851,9 @@ declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, documentId: st
  * this will return only the **metadata** the caller is allowed to view.
  *
  * @group Template Documents
- * @api GET /v2/envelope-documents/:id Get envelope document
+ * @api GET /v2/template-documents/:id Get envelope document
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
- * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
+ * @apiSuccess ITemplateDocument . The detailed metadata for the document requested
  */
 declare const getTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplateDocument>;
 /**
@@ -3930,4 +4043,4 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, WEBHOOK_EVENTS, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, TWebhookAuthMethod, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, 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, sortFields, sortDocuments, sortRecipients, 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, askQuestion, 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, rotateWebhookSecret, 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, 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 };
+export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, WEBHOOK_EVENTS, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, TWebhookAuthMethod, TNotificationType, TEventName, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, INotificationTemplate, 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, sortFields, sortDocuments, sortRecipients, 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, askQuestion, 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, getNotificationTemplates, getNotificationTemplate, createNotificationTemplate, updateNotificationTemplate, deleteNotificationTemplate, getOrganization, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, ICreateNotificationTemplateRequest, IUpdateNotificationTemplateRequest, getWebhooks, setWebhooks, rotateWebhookSecret, 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, 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 };

package/dist/index.d.ts

@@ -236,6 +236,17 @@ interface INotification {
     time: string;
     profile?: IProfile;
 }
+interface INotificationTemplate {
+    id: string;
+    organization_id: string;
+    type: TNotificationType;
+    event_name: TEventName;
+    template_id?: string;
+    html_template?: string;
+    text_template?: string;
+    template?: ITemplate;
+    organization: IOrganization;
+}
 //////////////////////////////////////// IAM //////////////////////////////
 interface IApiKey {
     client_id: string;
@@ -508,7 +519,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 +551,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 +592,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;
@@ -1062,6 +1075,8 @@ type TUsageType = "envelope" | "envelope_canceled" | "envelope_completed" | "env
  * Methods for authenticating webhook requests.
  */
 type TWebhookAuthMethod = "none" | "hmac" | "client_credentials";
+type TNotificationType = "sms" | "email" | "app";
+type TEventName = "invitation:canceled" | "transaction:completed" | "envelope:failed" | "envelope:expired" | "envelope:declined" | "envelope:cc" | "recipient:reminder" | "transaction:requested" | "envelope:delegated" | "envelope:completed" | "transaction:canceled" | "user:invited" | "recipient:invited" | "envelope:canceled" | "transaction:sent" | "envelope:signed" | "email:verify" | "email:otp" | "password:reset" | "recipient:question";
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
 declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
@@ -2325,6 +2340,17 @@ interface ISetWebhookRequest {
     auth_method: TWebhookAuthMethod;
     events: Record<TWebhookEvent, boolean>;
 }
+interface ICreateNotificationTemplateRequest {
+    type: TNotificationType;
+    event_name: TEventName;
+    template_id?: string;
+    html_template?: string;
+    text_template?: string;
+}
+interface IUpdateNotificationTemplateRequest {
+    html_template?: string;
+    text_template?: string;
+}
 /**
  * Get a list of keys for a given organization. The caller must have admin access to the organization.
  *
@@ -3001,6 +3027,93 @@ declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: s
  * @apiSuccess IProfile . The updated profile for the member.
  */
 declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Partial<Pick<IProfile, "roles" | "first_name" | "last_name">>) => Promise<IProfile>;
+/**
+ * Get all notification templates for the caller's organization.
+ *
+ * ```typescript
+ * import {getNotificationTemplates} from '@verdocs/js-sdk';
+ *
+ * const templates = await getNotificationTemplates();
+ * ```
+ *
+ * @group Notifications
+ * @api GET /v2/notifications/templates Get notification templates
+ * @apiSuccess array(items: INotificationTemplate) . A list of notification templates for the caller's organization.
+ */
+declare const getNotificationTemplates: (endpoint: VerdocsEndpoint) => Promise<INotificationTemplate[]>;
+/**
+ * Get a single notification template by ID.
+ *
+ * ```typescript
+ * import {getNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const template = await getNotificationTemplate(TEMPLATEID);
+ * ```
+ *
+ * @group Notifications
+ * @api GET /v2/notifications/templates/:id Get notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiSuccess INotificationTemplate . The requested notification template.
+ */
+declare const getNotificationTemplate: (endpoint: VerdocsEndpoint, id: string) => Promise<INotificationTemplate>;
+/**
+ * Create a notification template. Only one template may exist per combination of type and
+ * event_name. At least one of `html_template` or `text_template` must be provided.
+ *
+ * ```typescript
+ * import {createNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const template = await createNotificationTemplate({
+ *   type: 'email',
+ *   event_name: 'recipient:invited',
+ *   html_template: '<p>You have been invited to sign a document.</p>',
+ * });
+ * ```
+ *
+ * @group Notifications
+ * @api POST /v2/notifications/templates Create notification template
+ * @apiBody string(enum:'sms'|'email'|'app') type The notification channel type.
+ * @apiBody string event_name The event that triggers this notification.
+ * @apiBody string template_id? Optional reference to an associated template.
+ * @apiBody string html_template? The HTML content for the notification. At least one of html_template or text_template is required.
+ * @apiBody string text_template? The plain-text content for the notification. At least one of html_template or text_template is required.
+ * @apiSuccess INotificationTemplate . The newly-created notification template.
+ */
+declare const createNotificationTemplate: (endpoint: VerdocsEndpoint, params: ICreateNotificationTemplateRequest) => Promise<INotificationTemplate>;
+/**
+ * Update a notification template. At least one of `html_template` or `text_template` must be provided.
+ *
+ * ```typescript
+ * import {updateNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const updated = await updateNotificationTemplate(TEMPLATEID, {
+ *   html_template: '<p>Updated content.</p>',
+ * });
+ * ```
+ *
+ * @group Notifications
+ * @api PATCH /v2/notifications/templates/:id Update notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiBody string html_template? The HTML content for the notification. At least one of html_template or text_template is required.
+ * @apiBody string text_template? The plain-text content for the notification. At least one of html_template or text_template is required.
+ * @apiSuccess INotificationTemplate . The updated notification template.
+ */
+declare const updateNotificationTemplate: (endpoint: VerdocsEndpoint, id: string, params: IUpdateNotificationTemplateRequest) => Promise<INotificationTemplate>;
+/**
+ * Delete a notification template.
+ *
+ * ```typescript
+ * import {deleteNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * await deleteNotificationTemplate(TEMPLATEID);
+ * ```
+ *
+ * @group Notification Templates
+ * @api DELETE /v2/notifications/templates/:id Delete notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiSuccess string . Success.
+ */
+declare const deleteNotificationTemplate: (endpoint: VerdocsEndpoint, id: string) => Promise<any>;
 /**
  * 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).
@@ -3738,9 +3851,9 @@ declare const deleteTemplateDocument: (endpoint: VerdocsEndpoint, documentId: st
  * this will return only the **metadata** the caller is allowed to view.
  *
  * @group Template Documents
- * @api GET /v2/envelope-documents/:id Get envelope document
+ * @api GET /v2/template-documents/:id Get envelope document
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
- * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
+ * @apiSuccess ITemplateDocument . The detailed metadata for the document requested
  */
 declare const getTemplateDocument: (endpoint: VerdocsEndpoint, documentId: string) => Promise<ITemplateDocument>;
 /**
@@ -3930,4 +4043,4 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, WEBHOOK_EVENTS, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, TWebhookAuthMethod, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, 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, sortFields, sortDocuments, sortRecipients, 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, askQuestion, 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, rotateWebhookSecret, 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, 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 };
+export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, WEBHOOK_EVENTS, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, TWebhookAuthMethod, TNotificationType, TEventName, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, INotificationTemplate, 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, sortFields, sortDocuments, sortRecipients, 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, askQuestion, 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, getNotificationTemplates, getNotificationTemplate, createNotificationTemplate, updateNotificationTemplate, deleteNotificationTemplate, getOrganization, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, ICreateNotificationTemplateRequest, IUpdateNotificationTemplateRequest, getWebhooks, setWebhooks, rotateWebhookSecret, 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, 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 };

package/dist/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var axios = require('axios');
 var axiosRetry = require('axios-retry');
+var axios = require('axios');
 
 const WEBHOOK_EVENTS = [
     'envelope_created',
@@ -2537,9 +2537,9 @@ const deleteTemplateDocument = (endpoint, documentId) => endpoint.api //
  * this will return only the **metadata** the caller is allowed to view.
  *
  * @group Template Documents
- * @api GET /v2/envelope-documents/:id Get envelope document
+ * @api GET /v2/template-documents/:id Get envelope document
  * @apiParam string(format: 'uuid') document_id The ID of the document to retrieve.
- * @apiSuccess IEnvelopeDocument . The detailed metadata for the document requested
+ * @apiSuccess ITemplateDocument . The detailed metadata for the document requested
  */
 const getTemplateDocument = async (endpoint, documentId) => endpoint.api //
     .get(`/v2/template-documents/${documentId}`)
@@ -3477,6 +3477,112 @@ const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api /
     .patch(`/v2/organization-members/${profileId}`, params)
     .then((r) => r.data);
 
+/**
+ * Notification Templates allow organizations to customize the email and SMS notifications
+ * sent during signing workflows. Each template is tied to a specific event (e.g. recipient invited,
+ * envelope completed) and notification type (email, sms, etc). The caller must have admin access
+ * to the organization.
+ *
+ * @module
+ */
+/**
+ * Get all notification templates for the caller's organization.
+ *
+ * ```typescript
+ * import {getNotificationTemplates} from '@verdocs/js-sdk';
+ *
+ * const templates = await getNotificationTemplates();
+ * ```
+ *
+ * @group Notifications
+ * @api GET /v2/notifications/templates Get notification templates
+ * @apiSuccess array(items: INotificationTemplate) . A list of notification templates for the caller's organization.
+ */
+const getNotificationTemplates = (endpoint) => endpoint.api //
+    .get(`/v2/notifications/templates`)
+    .then((r) => r.data);
+/**
+ * Get a single notification template by ID.
+ *
+ * ```typescript
+ * import {getNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const template = await getNotificationTemplate(TEMPLATEID);
+ * ```
+ *
+ * @group Notifications
+ * @api GET /v2/notifications/templates/:id Get notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiSuccess INotificationTemplate . The requested notification template.
+ */
+const getNotificationTemplate = (endpoint, id) => endpoint.api //
+    .get(`/v2/notifications/templates/${id}`)
+    .then((r) => r.data);
+/**
+ * Create a notification template. Only one template may exist per combination of type and
+ * event_name. At least one of `html_template` or `text_template` must be provided.
+ *
+ * ```typescript
+ * import {createNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const template = await createNotificationTemplate({
+ *   type: 'email',
+ *   event_name: 'recipient:invited',
+ *   html_template: '<p>You have been invited to sign a document.</p>',
+ * });
+ * ```
+ *
+ * @group Notifications
+ * @api POST /v2/notifications/templates Create notification template
+ * @apiBody string(enum:'sms'|'email'|'app') type The notification channel type.
+ * @apiBody string event_name The event that triggers this notification.
+ * @apiBody string template_id? Optional reference to an associated template.
+ * @apiBody string html_template? The HTML content for the notification. At least one of html_template or text_template is required.
+ * @apiBody string text_template? The plain-text content for the notification. At least one of html_template or text_template is required.
+ * @apiSuccess INotificationTemplate . The newly-created notification template.
+ */
+const createNotificationTemplate = (endpoint, params) => endpoint.api //
+    .post(`/v2/notifications/templates`, params)
+    .then((r) => r.data);
+/**
+ * Update a notification template. At least one of `html_template` or `text_template` must be provided.
+ *
+ * ```typescript
+ * import {updateNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * const updated = await updateNotificationTemplate(TEMPLATEID, {
+ *   html_template: '<p>Updated content.</p>',
+ * });
+ * ```
+ *
+ * @group Notifications
+ * @api PATCH /v2/notifications/templates/:id Update notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiBody string html_template? The HTML content for the notification. At least one of html_template or text_template is required.
+ * @apiBody string text_template? The plain-text content for the notification. At least one of html_template or text_template is required.
+ * @apiSuccess INotificationTemplate . The updated notification template.
+ */
+const updateNotificationTemplate = (endpoint, id, params) => endpoint.api //
+    .patch(`/v2/notifications/templates/${id}`, params)
+    .then((r) => r.data);
+/**
+ * Delete a notification template.
+ *
+ * ```typescript
+ * import {deleteNotificationTemplate} from '@verdocs/js-sdk';
+ *
+ * await deleteNotificationTemplate(TEMPLATEID);
+ * ```
+ *
+ * @group Notification Templates
+ * @api DELETE /v2/notifications/templates/:id Delete notification template
+ * @apiParam string(format:uuid) id The notification template ID
+ * @apiSuccess string . Success.
+ */
+const deleteNotificationTemplate = (endpoint, id) => endpoint.api //
+    .delete(`/v2/notifications/templates/${id}`)
+    .then((r) => r.data);
+
 /**
  * An Organization is the top level object for ownership for Members, Documents, and Templates.
  *
@@ -3808,6 +3914,7 @@ exports.createEnvelope = createEnvelope;
 exports.createField = createField;
 exports.createGroup = createGroup;
 exports.createInitials = createInitials;
+exports.createNotificationTemplate = createNotificationTemplate;
 exports.createOrganization = createOrganization;
 exports.createOrganizationContact = createOrganizationContact;
 exports.createOrganizationInvitation = createOrganizationInvitation;
@@ -3826,6 +3933,7 @@ exports.deleteEnvelopeFieldAttachment = deleteEnvelopeFieldAttachment;
 exports.deleteField = deleteField;
 exports.deleteGroup = deleteGroup;
 exports.deleteGroupMember = deleteGroupMember;
+exports.deleteNotificationTemplate = deleteNotificationTemplate;
 exports.deleteOrganization = deleteOrganization;
 exports.deleteOrganizationContact = deleteOrganizationContact;
 exports.deleteOrganizationInvitation = deleteOrganizationInvitation;
@@ -3869,6 +3977,8 @@ exports.getKbaStep = getKbaStep;
 exports.getMatchingCountry = getMatchingCountry;
 exports.getMyUser = getMyUser;
 exports.getNextRecipient = getNextRecipient;
+exports.getNotificationTemplate = getNotificationTemplate;
+exports.getNotificationTemplates = getNotificationTemplates;
 exports.getNotifications = getNotifications;
 exports.getOrganization = getOrganization;
 exports.getOrganizationChildren = getOrganizationChildren;
@@ -3943,6 +4053,7 @@ exports.updateEnvelope = updateEnvelope;
 exports.updateEnvelopeField = updateEnvelopeField;
 exports.updateField = updateField;
 exports.updateGroup = updateGroup;
+exports.updateNotificationTemplate = updateNotificationTemplate;
 exports.updateOrganization = updateOrganization;
 exports.updateOrganizationContact = updateOrganizationContact;
 exports.updateOrganizationInvitation = updateOrganizationInvitation;