@verdocs/js-sdk 6.6.3 → 6.7.1

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;
@@ -412,23 +423,7 @@ interface IUser {
     created_at: string;
     updated_at: string;
 }
-// TODO: Combine this with TWebhookEvent in
-interface IWebhookEvents {
-    envelope_created: boolean;
-    envelope_completed: boolean;
-    envelope_updated: boolean;
-    envelope_canceled: boolean;
-    envelope_expired: boolean;
-    template_created: boolean;
-    template_updated: boolean;
-    template_deleted: boolean;
-    template_used: boolean;
-    recipient_submitted: boolean;
-    recipient_updated: boolean;
-    recipient_delegated: boolean;
-    kba_event: boolean;
-    entitlement_used: boolean;
-}
+type IWebhookEvents = Record<TWebhookEvent, boolean>;
 interface IWebhook {
     id: string;
     organization_id: string;
@@ -1031,7 +1026,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
 type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
-type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used";
+type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used" | "recipient_invited" | "recipient_reminded" | "recipient_auth_fail" | "recipient_disclosure_accepted" | "recipient_docs_downloaded" | "recipient_invite_failed";
 declare const WEBHOOK_EVENTS: readonly [
     "envelope_created",
     "envelope_completed",
@@ -1046,7 +1041,13 @@ declare const WEBHOOK_EVENTS: readonly [
     "recipient_updated",
     "recipient_delegated",
     "kba_event",
-    "entitlement_used"
+    "entitlement_used",
+    "recipient_invited",
+    "recipient_reminded",
+    "recipient_auth_fail",
+    "recipient_disclosure_accepted",
+    "recipient_docs_downloaded",
+    "recipient_invite_failed"
 ];
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
@@ -1064,6 +1065,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>;
@@ -2327,6 +2330,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.
  *
@@ -3003,6 +3017,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).
@@ -3740,9 +3841,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>;
 /**
@@ -3932,4 +4033,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;
@@ -412,23 +423,7 @@ interface IUser {
     created_at: string;
     updated_at: string;
 }
-// TODO: Combine this with TWebhookEvent in
-interface IWebhookEvents {
-    envelope_created: boolean;
-    envelope_completed: boolean;
-    envelope_updated: boolean;
-    envelope_canceled: boolean;
-    envelope_expired: boolean;
-    template_created: boolean;
-    template_updated: boolean;
-    template_deleted: boolean;
-    template_used: boolean;
-    recipient_submitted: boolean;
-    recipient_updated: boolean;
-    recipient_delegated: boolean;
-    kba_event: boolean;
-    entitlement_used: boolean;
-}
+type IWebhookEvents = Record<TWebhookEvent, boolean>;
 interface IWebhook {
     id: string;
     organization_id: string;
@@ -1031,7 +1026,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
 // Modification events have a string description
 type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
 type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
-type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used";
+type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "envelope_expired" | "template_created" | "template_updated" | "template_deleted" | "template_used" | "recipient_submitted" | "recipient_updated" | "recipient_delegated" | "kba_event" | "entitlement_used" | "recipient_invited" | "recipient_reminded" | "recipient_auth_fail" | "recipient_disclosure_accepted" | "recipient_docs_downloaded" | "recipient_invite_failed";
 declare const WEBHOOK_EVENTS: readonly [
     "envelope_created",
     "envelope_completed",
@@ -1046,7 +1041,13 @@ declare const WEBHOOK_EVENTS: readonly [
     "recipient_updated",
     "recipient_delegated",
     "kba_event",
-    "entitlement_used"
+    "entitlement_used",
+    "recipient_invited",
+    "recipient_reminded",
+    "recipient_auth_fail",
+    "recipient_disclosure_accepted",
+    "recipient_docs_downloaded",
+    "recipient_invite_failed"
 ];
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | "custom_disclaimer";
@@ -1064,6 +1065,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>;
@@ -2327,6 +2330,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.
  *
@@ -3003,6 +3017,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).
@@ -3740,9 +3841,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>;
 /**
@@ -3932,4 +4033,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',
@@ -18,6 +18,12 @@ const WEBHOOK_EVENTS = [
     'recipient_delegated',
     'kba_event',
     'entitlement_used',
+    'recipient_invited',
+    'recipient_reminded',
+    'recipient_auth_fail',
+    'recipient_disclosure_accepted',
+    'recipient_docs_downloaded',
+    'recipient_invite_failed',
 ];
 
 const FIELD_TYPES = [
@@ -2537,9 +2543,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 +3483,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 +3920,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 +3939,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 +3983,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 +4059,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;