@verdocs/js-sdk 6.6.3 → 6.7.0

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import axios from 'axios';
 import axiosRetry from 'axios-retry';
+import axios from 'axios';
 
 const WEBHOOK_EVENTS = [
     'envelope_created',
@@ -2535,9 +2535,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}`)
@@ -3475,6 +3475,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.
  *
@@ -3779,5 +3885,5 @@ const rotateWebhookSecret = (endpoint) => endpoint.api //
     .put(`/v2/webhooks/rotate-secret`)
     .then((r) => r.data);
 
-export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_DISCLOSURES, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, askQuestion, authenticate, blobToBase64, canAccessEnvelope, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, collapseEntitlements, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createOrganization, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, delegateRecipient, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteOrganization, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, downloadBlob, downloadEnvelopeDocument, downloadTemplateDocument, duplicateTemplate, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getActiveEntitlements, getApiKeys, getCountryByCode, getCurrentProfile, getEntitlements, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPageDisplayUri, getEnvelopeDocumentPreviewLink, getEnvelopeFile, getEnvelopes, getEnvelopesZip, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotifications, getOrganization, getOrganizationChildren, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizationUsage, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getTemplate, getTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentPreviewLink, getTemplateDocumentThumbnail, getTemplates, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isEnvelopeOwner, isEnvelopeRecipient, isFieldFilled, isFieldValid, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidInput, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, remindRecipient, rescale, resendOrganizationInvitation, resendVerification, resetPassword, resetRecipient, rotateApiKey, rotateWebhookSecret, setWebhooks, sortDocuments, sortFields, sortRecipients, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleTemplateStar, updateApiKey, updateEnvelope, updateEnvelopeField, updateField, updateGroup, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, useCanAccessEnvelope, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail, verifySigner };
+export { ALL_PERMISSIONS, AtoB, Countries, DEFAULT_DISCLOSURES, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_WIDTHS, FIELD_TYPES, RolePermissions, VerdocsEndpoint, WEBHOOK_EVENTS, acceptOrganizationInvitation, addGroupMember, askQuestion, authenticate, blobToBase64, canAccessEnvelope, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, collapseEntitlements, convertToE164, createApiKey, createEnvelope, createField, createGroup, createInitials, createNotificationTemplate, createOrganization, createOrganizationContact, createOrganizationInvitation, createProfile, createSignature, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, delegateRecipient, deleteApiKey, deleteEnvelopeFieldAttachment, deleteField, deleteGroup, deleteGroupMember, deleteNotificationTemplate, deleteOrganization, deleteOrganizationContact, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteTemplate, deleteTemplateDocument, deleteTemplateRole, downloadBlob, downloadEnvelopeDocument, downloadTemplateDocument, duplicateTemplate, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientDecline, envelopeRecipientSubmit, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getActiveEntitlements, getApiKeys, getCountryByCode, getCurrentProfile, getEntitlements, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentDownloadLink, getEnvelopeDocumentPageDisplayUri, getEnvelopeDocumentPreviewLink, getEnvelopeFile, getEnvelopes, getEnvelopesZip, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getMyUser, getNextRecipient, getNotificationTemplate, getNotificationTemplates, getNotifications, getOrganization, getOrganizationChildren, getOrganizationContacts, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizationUsage, getPlusOneCountry, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getTemplate, getTemplateDocument, getTemplateDocumentDownloadLink, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentPreviewLink, getTemplateDocumentThumbnail, getTemplates, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isEnvelopeOwner, isEnvelopeRecipient, isFieldFilled, isFieldValid, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidInput, isValidPhone, isValidRoleName, isValidTag, nameToRGBA, randomString, recipientCanAct, recipientHasAction, refreshToken, remindRecipient, rescale, resendOrganizationInvitation, resendVerification, resetPassword, resetRecipient, rotateApiKey, rotateWebhookSecret, setWebhooks, sortDocuments, sortFields, sortRecipients, startSigningSession, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, toggleTemplateStar, updateApiKey, updateEnvelope, updateEnvelopeField, updateField, updateGroup, updateNotificationTemplate, updateOrganization, updateOrganizationContact, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateRole, uploadEnvelopeFieldAttachment, useCanAccessEnvelope, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail, verifySigner };
 //# sourceMappingURL=index.mjs.map