@verdocs/js-sdk 4.2.10 → 4.2.11

package/dist/index.mjs

@@ -2410,6 +2410,7 @@ const userCanSendTemplate = (profile, template) => {
         case 'organization_member':
         case 'organization_member_as_creator':
             return userIsTemplateCreator(profile, template) || template.organization_id === profile?.organization_id;
+        // 'everyone' | 'everyone_as_creator';
         default:
             return true;
     }
@@ -2461,29 +2462,55 @@ const deleteTemplateReminder = (endpoint, templateId, reminderId) => endpoint.ap
     .then((r) => r.data);
 
 /**
- * A "role" is an individual participant in a signing flow, such as a signer or CC contact. Roles are identified by
- * their names, which must be unique (e.g. 'Recipient 1'). Template fields are assigned to roles for signing operations,
- * so you may have 'Recipient 1 Signature 1' and so forth.
+ * A "role" is an individual participant in a signing flow, such as a signer or CC contact.
+ * A role is a placeholder that will eventually become a named recipient. For example, "Tenant 1"
+ * might be replaced with "John Smith" when the document is sent out for signature.
+ *
+ * Role names must be unique within a template, e.g. 'Recipient 1'. They may contain any [a-zA-Z0-9_- ]
+ * characters, although it is recommended to keep them simple and human-readable, and to avoid
+ * spaces (although they are allowed). If spaces are used in role names, be sure to URL-encode them
+ * when calling endpoints like `updateRole()` e.g. 'Recipient%201'.
+ *
+ * NOTE: Roles are always enumerated under Template objects, so there are no "list" or "get" endpoints
+ * for them. To get a template's latest role list, simply call `getTemplate()`.
  *
  * @module
  */
-const createTemplateRole = (endpoint, templateId, params) => endpoint.api //
-    .post(`/templates/${templateId}/roles`, params)
-    .then((r) => r.data);
-const getTemplateRoles = (endpoint, templateId) => endpoint.api //
-    .get(`/templates/${templateId}/roles`)
-    .then((r) => r.data);
-const getTemplateRole = (endpoint, templateId, roleName) => endpoint.api //
-    .get(`/templates/${templateId}/roles/${roleName}`)
-    .then((r) => r.data);
-const updateTemplateRole = (endpoint, templateId, roleName, params) => endpoint.api //
-    .put(`/templates/${templateId}/roles/${roleName}`, params)
+/**
+ * Create a role.
+ *
+ * ```typescript
+ * import {createTemplateRole} from '@verdocs/js-sdk';
+ *
+ * const role = await createTemplateRole(VerdocsEndpoint.getDefault(), template_id, params...);
+ * ```
+ */
+const createTemplateRole = (endpoint, template_id, params) => endpoint.api //
+    .post(`/v2/templates/${template_id}/roles`, params)
     .then((r) => r.data);
-const deleteTemplateRole = (endpoint, templateId, roleName) => endpoint.api //
-    .delete(`/templates/${templateId}/roles/${roleName}`)
+/**
+ * Update a role.
+ *
+ * ```typescript
+ * import {updateTemplateRole} from '@verdocs/js-sdk';
+ *
+ * const role = await updateTemplateRole(VerdocsEndpoint.getDefault(), template_id, name, params...);
+ * ```
+ */
+const updateTemplateRole = (endpoint, template_id, name, params) => endpoint.api //
+    .put(`/v2/templates/${template_id}/roles/${name}`, params)
     .then((r) => r.data);
-const getTemplateRoleFields = (endpoint, templateId, roleName) => endpoint.api //
-    .get(`/templates/${templateId}/roles/${roleName}/fields`)
+/**
+ * Delete a role.
+ *
+ * ```typescript
+ * import {deleteTemplateRole} from '@verdocs/js-sdk';
+ *
+ * const profiles = await deleteTemplateRole(VerdocsEndpoint.getDefault(), template_id, name);
+ * ```
+ */
+const deleteTemplateRole = (endpoint, template_id, name) => endpoint.api //
+    .delete(`/v2/templates/${template_id}/roles/${name}`)
     .then((r) => r.data);
 
 /**
@@ -2837,5 +2864,5 @@ const isValidRoleName = (value, roles) => roles.findIndex((role) => role.name ==
 const TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
 const isValidTag = (value, tags) => TagRegEx.test(value) || tags.findIndex((tag) => tag === value) !== -1;
 
-export { AtoB, Countries, RolePermissions, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateReminder, deleteTemplateRole, deleteTemplateTag, downloadBlob, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientChangeOwner, envelopeRecipientDecline, envelopeRecipientPrepare, envelopeRecipientSubmit, envelopeRecipientUpdateName, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getAllTags, getApiKeys, getCountryByCode, getCurrentProfile, getDocumentDownloadLink, getDocumentPreviewLink, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentPageDisplayUri, getEnvelopeFile, getEnvelopeRecipients, getEnvelopeReminder, getEnvelopes, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfile, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail };
+export { AtoB, Countries, RolePermissions, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganizationInvitation, deleteOrganizationMember, deleteProfile, deleteSignature, deleteTemplate, deleteTemplateDocument, deleteTemplateReminder, deleteTemplateRole, deleteTemplateTag, downloadBlob, envelopeIsActive, envelopeIsComplete, envelopeRecipientAgree, envelopeRecipientChangeOwner, envelopeRecipientDecline, envelopeRecipientPrepare, envelopeRecipientSubmit, envelopeRecipientUpdateName, fileToDataUrl, formatFullName, formatInitials, formatShortTimeAgo, fullNameToInitials, getAllTags, getApiKeys, getCountryByCode, getCurrentProfile, getDocumentDownloadLink, getDocumentPreviewLink, getEnvelope, getEnvelopeDocument, getEnvelopeDocumentPageDisplayUri, getEnvelopeFile, getEnvelopeRecipients, getEnvelopeReminder, getEnvelopes, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStep, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getPlusOneCountry, getProfile, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateReminder, getTemplateTags, getTemplates, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationLogo, updateOrganizationMember, updateOrganizationThumbnail, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, userCanAct, userCanBuildTemplate, userCanCancelEnvelope, userCanChangeOrgVisibility, userCanCreateOrgTemplate, userCanCreatePersonalTemplate, userCanCreatePublicTemplate, userCanCreateTemplate, userCanDeleteTemplate, userCanFinishEnvelope, userCanMakeTemplatePrivate, userCanMakeTemplatePublic, userCanMakeTemplateShared, userCanPreviewTemplate, userCanReadTemplate, userCanSendTemplate, userCanSignNow, userCanUpdateTemplate, userHasPermissions, userHasSharedTemplate, userIsEnvelopeOwner, userIsEnvelopeRecipient, userIsTemplateCreator, verifyEmail };
 //# sourceMappingURL=index.mjs.map