@verdocs/js-sdk 4.1.9 → 4.1.10

package/dist/index.mjs

@@ -1765,52 +1765,66 @@ const updateOrganizationMember = (endpoint, profileId, params) => endpoint.api /
 /**
  * An Organization is the top level object for ownership for Members, Documents, and Templates.
  *
+ * NOTE: There is no call specifically to create an organization. Every organization must have
+ * at least one "owner" type member. To create a new organization, call createProfile() with
+ * the desired new orgName to create. The caller will become the first owner of the new org, and
+ * can then invite new members to join as well.
+ *
+ * NOTE: There is no call to delete an organization. For safety, this is a manual process. Please
+ * contact support@verdocs.com if you wish to completely delete an organization and all its records.
+ *
  * @module
  */
 /**
  * Get a list of organizations the caller is a member of.
+ *
+ * ```typescript
+ * import {getOrganizations} from '@verdocs/js-sdk';
+ *
+ * const organizations = await getOrganizations(VerdocsEndpoint.getDefault());
+ * ```
  */
 const getOrganizations = (endpoint) => endpoint.api //
     .get('/v2/organizations')
     .then((r) => r.data);
 /**
  * Get an organization by ID.
+ *
+ * ```typescript
+ * import {getOrganization} from '@verdocs/js-sdk';
+ *
+ * const organizations = await getOrganization(VerdocsEndpoint.getDefault(), 'ORGID');
+ * ```
  */
 const getOrganization = (endpoint, organizationId) => endpoint.api //
     .get(`/v2/organizations/${organizationId}`)
     .then((r) => r.data);
 /**
- * Create an organization.
- */
-const createOrganization = (endpoint) => endpoint.api //
-    .post('/v2/organizations')
-    .then((r) => r.data);
-/**
- * Delete an organization.
- */
-const deleteOrganization = (endpoint, organizationId) => endpoint.api //
-    .delete(`/v2/organizations/${organizationId}`)
-    .then((r) => r.data);
-/**
- * Update an organization.
+ * Update an organization.  This can only be called by an admin or owner.
+ *
+ * ```typescript
+ * import {updateOrganization} from '@verdocs/js-sdk';
+ *
+ * const organizations = await updateOrganization(VerdocsEndpoint.getDefault(), organizationId, {name:'ORGNAME'});
+ * ```
  */
 const updateOrganization = (endpoint, organizationId, params) => endpoint.api //
     .patch(`/v2/organizations/${organizationId}`, params)
     .then((r) => r.data);
 /**
- * Update the organization's logo. This can only be called by an admin or owner of the organization.
+ * Update the organization's logo. This can only be called by an admin or owner.
  *
  * ```typescript
  * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
  *
- * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), file);
+ * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
  */
-const uploadOrganizationLogo = (endpoint, file, onUploadProgress) => {
+const uploadOrganizationLogo = (endpoint, organizationId, file, onUploadProgress) => {
     const formData = new FormData();
-    formData.append('document', file, file.name);
+    formData.append('logo', file, file.name);
     return endpoint.api //
-        .post(`/v2/organizations/logo`, formData, {
+        .patch(`/v2/organizations/${organizationId}`, formData, {
         timeout: 120000,
         onUploadProgress: (event) => {
             const total = event.total || 1;
@@ -1821,19 +1835,19 @@ const uploadOrganizationLogo = (endpoint, file, onUploadProgress) => {
         .then((r) => r.data);
 };
 /**
- * Update the organization's thumbnail. This can only be called by an admin or owner of the organization.
+ * Update the organization's thumbnail. This can only be called by an admin or owner.
  *
  * ```typescript
  * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
  *
- * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), file);
+ * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
  */
-const uploadOrganizationThumbnail = (endpoint, file, onUploadProgress) => {
+const uploadOrganizationThumbnail = (endpoint, organizationId, file, onUploadProgress) => {
     const formData = new FormData();
-    formData.append('document', file, file.name);
+    formData.append('thumbnail', file, file.name);
     return endpoint.api //
-        .post(`/v2/organizations/thumbnail`, formData, {
+        .patch(`/v2/organizations/${organizationId}`, formData, {
         timeout: 120000,
         onUploadProgress: (event) => {
             const total = event.total || 1;
@@ -2660,7 +2674,7 @@ const getProfiles = (endpoint) => endpoint.api //
  * ```typescript
  * import {getCurrentProfile} from '@verdocs/js-sdk';
  *
- * const profiles = await getCurrentProfile();
+ * const profiles = await getCurrentProfile(VerdocsEndpoint.getDefault());
  * ```
  */
 const getCurrentProfile = (endpoint) => endpoint.api //
@@ -2668,12 +2682,11 @@ const getCurrentProfile = (endpoint) => endpoint.api //
     .then((r) => (r.data || []).find((profile) => profile.current));
 /**
  * Get a profile. The caller must have admin access to the given profile.
- * TODO: Add a "public" profile endpoint for public pages
  *
  * ```typescript
  * import {getProfile} from '@verdocs/js-sdk';
  *
- * const profile = await getProfile('PROFILEID');
+ * const profile = await getProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
  */
 const getProfile = (endpoint, profileId) => endpoint.api //
@@ -2687,7 +2700,7 @@ const getProfile = (endpoint, profileId) => endpoint.api //
  * ```typescript
  * import {switchProfile} from '@verdocs/js-sdk';
  *
- * const newProfile = await switchProfile('PROFILEID');
+ * const newProfile = await switchProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
  */
 const switchProfile = (endpoint, profileId) => endpoint.api //
@@ -2700,7 +2713,7 @@ const switchProfile = (endpoint, profileId) => endpoint.api //
  * ```typescript
  * import {updateProfile} from '@verdocs/js-sdk/Users';
  *
- * const newProfile = await updateProfile('PROFILEID');
+ * const newProfile = await updateProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
  */
 const updateProfile = (endpoint, profileId, params) => endpoint.api //
@@ -2713,7 +2726,7 @@ const updateProfile = (endpoint, profileId, params) => endpoint.api //
  * ```typescript
  * import {deleteProfile} from '@verdocs/js-sdk';
  *
- * await deleteProfile('PROFILEID');
+ * await deleteProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
  * ```
  */
 const deleteProfile = (endpoint, profileId) => endpoint.api //
@@ -2737,7 +2750,7 @@ const deleteProfile = (endpoint, profileId) => endpoint.api //
  * ```typescript
  * import {createProfile} from '@verdocs/js-sdk';
  *
- * const newSession = await createProfile({
+ * const newSession = await createProfile(VerdocsEndpoint.getDefault(), {
  *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
  * });
  * ```
@@ -2769,5 +2782,5 @@ const updateProfilePhoto = (endpoint, profileId, file, onUploadProgress) => {
         .then((r) => r.data);
 };
 
-export { AtoB, Countries, VerdocsEndpoint, acceptOrganizationInvitation, addGroupMember, addTemplateTag, authenticate, blobToBase64, canPerformTemplateAction, cancelEnvelope, capitalize, changePassword, convertToE164, createApiKey, createEnvelope, createEnvelopeReminder, createField, createGroup, createInitials, createOrganization, createOrganizationInvitation, createProfile, createSignature, createTag, createTemplate, createTemplateDocument, createTemplateFromSharepoint, createTemplateReminder, createTemplateRole, createTemplatev2, declineOrganizationInvitation, decodeAccessTokenBody, decodeJWTBody, deleteApiKey, deleteEnvelopeFieldAttachment, deleteEnvelopeReminder, deleteField, deleteGroupMember, deleteOrganization, 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, getEnvelopesByTemplateId, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStatus, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizations, getPlusOneCountry, getProfile, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateOwnerInfo, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getTemplatesSummary, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listEnvelopes, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchEnvelopes, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, throttledGetEnvelope, throttledGetTemplate, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationMember, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, uploadOrganizationLogo, uploadOrganizationThumbnail, 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, 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, createTemplatev2, 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, getEnvelopesByTemplateId, getEnvelopesSummary, getFieldAttachment, getFieldsForRole, getGroup, getGroups, getInPersonLink, getKbaStatus, getMatchingCountry, getNextRecipient, getNotifications, getOrganization, getOrganizationInvitation, getOrganizationInvitations, getOrganizationMembers, getOrganizations, getPlusOneCountry, getProfile, getProfiles, getRGB, getRGBA, getRLeft, getRTop, getRValue, getRecipientsWithActions, getRoleColor, getSignature, getSignatures, getSignerToken, getSigningSession, getStars, getTag, getTemplate, getTemplateDocument, getTemplateDocumentFile, getTemplateDocumentPageDisplayUri, getTemplateDocumentThumbnail, getTemplateDocuments, getTemplateOwnerInfo, getTemplateReminder, getTemplateRole, getTemplateRoleFields, getTemplateRoles, getTemplateTags, getTemplates, getTemplatesSummary, getValidator, getValidators, getWebhooks, hasRequiredPermissions, integerSequence, isAmericanSamoa, isCanada, isDominicanRepublic, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, isPuertoRico, isValidEmail, isValidPhone, isValidRoleName, isValidTag, listEnvelopes, listTemplates, nameToRGBA, recipientCanAct, recipientHasAction, refreshToken, rescale, resendInvitation, resendOrganizationInvitation, resendVerification, resetPassword, rotateApiKey, searchEnvelopes, searchTemplates, sendDelegate, setWebhooks, submitKbaChallengeResponse, submitKbaIdentity, submitKbaPin, switchProfile, throttledGetEnvelope, throttledGetTemplate, timePeriod, toggleStar, updateApiKey, updateEnvelopeField, updateEnvelopeFieldInitials, updateEnvelopeFieldSignature, updateEnvelopeReminder, updateField, updateGroup, updateOrganization, updateOrganizationInvitation, updateOrganizationMember, updateProfile, updateProfilePhoto, updateRecipient, updateTemplate, updateTemplateReminder, updateTemplateRole, uploadEnvelopeFieldAttachment, uploadOrganizationLogo, uploadOrganizationThumbnail, 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