@verdocs/js-sdk 4.1.10 → 4.1.12

package/dist/index.d.mts

@@ -1636,6 +1636,8 @@ interface IUpdateApiKeyRequest {
 }
 interface ICreateInvitationRequest {
     email: string;
+    first_name: string;
+    last_name: string;
     role: TRole;
 }
 interface ISetWebhookRequest {
@@ -1727,18 +1729,297 @@ declare const deleteGroupMember: (endpoint: VerdocsEndpoint, groupId: string, pr
 declare const updateGroup: (endpoint: VerdocsEndpoint, groupId: string, params: {
     permissions: TPermission[];
 }) => Promise<any>;
+interface IUpdateProfileRequest {
+    first_name?: string;
+    last_name?: string;
+    // email?: string;
+    phone?: string;
+    permissions?: TPermission[];
+    roles?: TRole[];
+}
+interface IAuthenticateResponse {
+    access_token: string;
+    id_token: string;
+    refresh_token: string;
+    expires_in: number;
+    access_token_exp: number;
+    refresh_token_exp: number;
+}
+interface IUpdatePasswordRequest {
+    email: string;
+    oldPassword: string;
+    newPassword: string;
+}
+interface IUpdatePasswordResponse {
+    status: TRequestStatus;
+    /** Success or failure message */
+    message: string;
+}
+interface ICreateAccountRequest {
+    email: string;
+    password: string;
+    firstName: string;
+    lastName: string;
+    orgName: string;
+}
+interface IROPCRequest {
+    grant_type: "password";
+    username: string;
+    password: string;
+    client_id?: string;
+    scope?: string;
+}
+interface IClientCredentialsRequest {
+    grant_type: "client_credentials";
+    client_id: string;
+    client_secret: string;
+    scope?: string;
+}
+interface IRefreshTokenRequest {
+    grant_type: "refresh_token";
+    refresh_token: string;
+    client_id?: string;
+    scope?: string;
+}
+type TAuthenticationRequest = IROPCRequest | IClientCredentialsRequest | IRefreshTokenRequest;
+/**
+ * Authenticate to Verdocs.
+ *
+ * ```typescript
+ * import {authenticate, VerdocsEndpoint} from '@verdocs/js-sdk';
+ *
+ * // Client-side call, suitable for Web and mobile apps:
+ * const {access_token} = await Auth.authenticate({ username: 'test@test.com', password: 'PASSWORD', grant_type:'password' });
+ * VerdocsEndpoint.getDefault().setAuthToken(access_token);
+ *
+ * // Server-side call, suitable for server apps. NEVER EXPOSE client_secret IN FRONT-END CODE:
+ * const {access_token} = await Auth.authenticate({ client_id: '...', client_secret: '...', grant_type:'client_credentials' });
+ * VerdocsEndpoint.getDefault().setAuthToken(access_token);
+ * ```
+ */
+declare const authenticate: (endpoint: VerdocsEndpoint, params: TAuthenticationRequest) => Promise<IAuthenticateResponse>;
+/**
+ * If called before the session expires, this will refresh the caller's session and tokens.
+ *
+ * ```typescript
+ * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
+ *
+ * const {accessToken} = await Auth.refreshTokens();
+ * VerdocsEndpoint.setAuthToken(accessToken);
+ * ```
+ */
+declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) => Promise<IAuthenticateResponse>;
+/**
+ * Update the caller's password when the old password is known (typically for logged-in users).
+ *
+ * ```typescript
+ * import {changePassword} from '@verdocs/js-sdk';
+ *
+ * const {status, message} = await changePassword({ email, oldPassword, newPassword });
+ * if (status !== 'OK') {
+ *   window.alert(`Password reset error: ${message}`);
+ * }
+ * ```
+ */
+declare const changePassword: (endpoint: VerdocsEndpoint, params: IUpdatePasswordRequest) => Promise<IUpdatePasswordResponse>;
+/**
+ * Request a password reset, when the old password is not known (typically in login forms).
+ *
+ * ```typescript
+ * import {resetPassword} from '@verdocs/js-sdk';
+ *
+ * const {success} = await resetPassword({ email });
+ * if (status !== 'OK') {
+ *   window.alert(`Please check your email for instructions on how to reset your password.`);
+ * }
+ * ```
+ */
+declare const resetPassword: (endpoint: VerdocsEndpoint, params: {
+    email: string;
+}) => Promise<{
+    success: boolean;
+}>;
+/**
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
+ * "anonymous" mode while verification is being performed.
+ *
+ * ```typescript
+ * import {resendVerification} from '@verdocs/js-sdk';
+ *
+ * const result = await resendVerification();
+ * ```
+ */
+declare const verifyEmail: (endpoint: VerdocsEndpoint, email: string, code: string) => Promise<IAuthenticateResponse>;
+/**
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
+ * "anonymous" mode while verification is being performed.
+ *
+ * ```typescript
+ * import {resendVerification} from '@verdocs/js-sdk';
+ *
+ * const result = await resendVerification();
+ * ```
+ */
+declare const resendVerification: (endpoint: VerdocsEndpoint, accessToken?: string) => Promise<{
+    result: "done";
+}>;
+declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {getProfiles} from '@verdocs/js-sdk';
+ *
+ * const profiles = await getProfiles();
+ * ```
+ */
+declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {getCurrentProfile} from '@verdocs/js-sdk';
+ *
+ * const profiles = await getCurrentProfile(VerdocsEndpoint.getDefault());
+ * ```
+ */
+declare const getCurrentProfile: (endpoint: VerdocsEndpoint) => Promise<IProfile | undefined>;
+/**
+ * Get a profile. The caller must have admin access to the given profile.
+ *
+ * ```typescript
+ * import {getProfile} from '@verdocs/js-sdk';
+ *
+ * const profile = await getProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IProfile>;
+/**
+ * Switch the caller's "current" profile. The current profile is used for permissions checking
+ * and profile_id field settings for most operations in Verdocs. It is important to select the
+ * appropropriate profile before calling other API functions.
+ *
+ * ```typescript
+ * import {switchProfile} from '@verdocs/js-sdk';
+ *
+ * const newProfile = await switchProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse>;
+/**
+ * Update a profile. For future expansion, the profile ID to update is required, but currently
+ * this must also be the "current" profile for the caller.
+ *
+ * ```typescript
+ * import {updateProfile} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await updateProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
+/**
+ * Delete a profile. If the requested profile is the caller's curent profile, the next
+ * available profile will be selected.
+ *
+ * ```typescript
+ * import {deleteProfile} from '@verdocs/js-sdk';
+ *
+ * await deleteProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
+ * ```
+ */
+declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse | {
+    status: "OK";
+    message: "Your last profile has been deleted. You are now logged out.";
+}>;
+/**
+ * Create a new user account. Note that there are two registration paths for creation:
+ *   - Get invited to an organization, by an admin or owner of that org.
+ *   - Created a new organization. The caller will become the first owner of the new org.
+ *
+ * This endpoint is for the second path, so an organization name is required. It is NOT
+ * required to be unique because it is very common for businesses to have the same names,
+ * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
+ *
+ * The new profile will automatically be set as the user's "current" profile, and new
+ * session tokens will be returned to the caller. However, the caller's email may not yet
+ * be verified. In that case, the caller will not yet be able to call other endpoints in
+ * the Verdocs API. The caller will need to check their email for a verification code,
+ * which should be submitted via the `verifyEmail` endpoint.
+ *
+ * ```typescript
+ * import {createProfile} from '@verdocs/js-sdk';
+ *
+ * const newSession = await createProfile(VerdocsEndpoint.getDefault(), {
+ *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
+ * });
+ * ```
+ */
+declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
+    profile: IProfile;
+    organization: IOrganization;
+}>;
+/**
+ * Update the caller's profile photo. This can only be called for the user's "current" profile.
+ *
+ * ```typescript
+ * import {uploadProfilePhoto} from '@verdocs/js-sdk';
+ *
+ * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), profileId, file);
+ * ```
+ */
+declare const updateProfilePhoto: (endpoint: VerdocsEndpoint, profileId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
 /**
  * An invitation represents an opportunity for a Member to join an Organization.
  *
  * @module
  */
+/**
+ * Get a list of invitations pending for the caller's organization. The caller must be an admin or owner.
+ */
 declare const getOrganizationInvitations: (endpoint: VerdocsEndpoint) => Promise<IOrganizationInvitation[]>;
+/**
+ * Invite a new user to join the organization.
+ */
 declare const createOrganizationInvitation: (endpoint: VerdocsEndpoint, params: ICreateInvitationRequest) => Promise<IOrganizationInvitation>;
+/**
+ * Delete an invitation. Note that no cancellation message will be sent. Invitations are also one-time-use.
+ * If the invitee attempts to join after the invitation is deleted, accepted, or decline, they will be
+ * shown an error.
+ */
 declare const deleteOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string) => Promise<any>;
-declare const updateOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string, params: Partial<ICreateInvitationRequest>) => Promise<IOrganizationInvitation>;
+/**
+ * Update an invitation. Note that email may not be changed after the invite is sent. To change
+ * an invitee's email, delete the incorrect entry and create one with the correct value.
+ */
+declare const updateOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string, params: Pick<ICreateInvitationRequest, "role" | "first_name" | "last_name">) => Promise<IOrganizationInvitation>;
+/**
+ * Send a reminder to the invitee to join the organization.
+ */
 declare const resendOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string) => Promise<any>;
+/**
+ * Get an invitation's details. This is generally used as the first step of accepting the invite.
+ * A successful response will indicate that the invite token is still valid, and include some
+ * metadata for the organization to style the acceptance screen.
+ */
 declare const getOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string, token: string) => Promise<IOrganizationInvitation>;
-declare const acceptOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string, token: string) => Promise<IProfile>;
+/**
+ * Accept an invitation. This will automatically create an Auth0 user for the caller as well as a profile
+ * with the appropriate role as specified in the invite. The profile will be set as "current" for the caller,
+ * and session tokens will be returned to access the new profile. The profile's email_verified flag will
+ * also be set to true.
+ */
+declare const acceptOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string, token: string) => Promise<IAuthenticateResponse>;
+/**
+ * Decline an invitation. This will mark the status "declined," providing a visual indication to the
+ * organization's admins that the invite was declined, preventing further invites from being created
+ * to the same email address, and also preventing the invitee from receiving reminders to join.
+ */
 declare const declineOrganizationInvitation: (endpoint: VerdocsEndpoint, email: string, token: string) => Promise<{
     status: "OK";
 }>;
@@ -1747,21 +2028,22 @@ declare const declineOrganizationInvitation: (endpoint: VerdocsEndpoint, email:
  *
  * @module
  */
+/**
+ * Get a list of the members in the caller's organization.
+ */
 declare const getOrganizationMembers: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
+/**
+ * Delete a member from the caller's organization. Note that the caller must be an admin or owner,
+ * may not delete him/herself
+ */
 declare const deleteOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
-declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Pick<IProfile, "roles" | "permissions">) => Promise<any>;
 /**
- * Get a list of organizations the caller is a member of.
- *
- * ```typescript
- * import {getOrganizations} from '@verdocs/js-sdk';
- *
- * const organizations = await getOrganizations(VerdocsEndpoint.getDefault());
- * ```
+ * Update a member.
  */
-declare const getOrganizations: (endpoint: VerdocsEndpoint) => Promise<IOrganization[]>;
+declare const updateOrganizationMember: (endpoint: VerdocsEndpoint, profileId: string, params: Pick<IProfile, "roles" | "first_name" | "last_name">) => Promise<any>;
 /**
- * Get an organization by ID.
+ * 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).
  *
  * ```typescript
  * import {getOrganization} from '@verdocs/js-sdk';
@@ -1784,22 +2066,22 @@ declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: st
  * Update the organization's logo. This can only be called by an admin or owner.
  *
  * ```typescript
- * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ * import {updateOrganizationLogo} from '@verdocs/js-sdk';
  *
- * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), organizationId, file);
+ * await updateOrganizationLogo((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
  */
-declare const uploadOrganizationLogo: (endpoint: VerdocsEndpoint, organizationId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
+declare const updateOrganizationLogo: (endpoint: VerdocsEndpoint, organizationId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
 /**
  * Update the organization's thumbnail. This can only be called by an admin or owner.
  *
  * ```typescript
- * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ * import {updateOrganizationThumbnail} from '@verdocs/js-sdk';
  *
- * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), organizationId, file);
+ * await updateOrganizationThumbnail((VerdocsEndpoint.getDefault(), organizationId, file);
  * ```
  */
-declare const uploadOrganizationThumbnail: (endpoint: VerdocsEndpoint, organizationId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
+declare const updateOrganizationThumbnail: (endpoint: VerdocsEndpoint, organizationId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
 /**
  * Get the registered Webhooks for the caller's organization.
  */
@@ -2462,249 +2744,4 @@ declare const isValidEmail: (email: string | undefined) => boolean;
 declare const isValidPhone: (phone: string | undefined) => boolean;
 declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
 declare const isValidTag: (value: string, tags: string[]) => boolean;
-interface IUpdateProfileRequest {
-    first_name?: string;
-    last_name?: string;
-    // email?: string;
-    phone?: string;
-    permissions?: TPermission[];
-    roles?: TRole[];
-}
-interface IAuthenticateResponse {
-    access_token: string;
-    id_token: string;
-    refresh_token: string;
-    expires_in: number;
-    access_token_exp: number;
-    refresh_token_exp: number;
-}
-interface IUpdatePasswordRequest {
-    email: string;
-    oldPassword: string;
-    newPassword: string;
-}
-interface IUpdatePasswordResponse {
-    status: TRequestStatus;
-    /** Success or failure message */
-    message: string;
-}
-interface ICreateAccountRequest {
-    email: string;
-    password: string;
-    firstName: string;
-    lastName: string;
-    orgName: string;
-}
-interface IROPCRequest {
-    grant_type: "password";
-    username: string;
-    password: string;
-    client_id?: string;
-    scope?: string;
-}
-interface IClientCredentialsRequest {
-    grant_type: "client_credentials";
-    client_id: string;
-    client_secret: string;
-    scope?: string;
-}
-interface IRefreshTokenRequest {
-    grant_type: "refresh_token";
-    refresh_token: string;
-    client_id?: string;
-    scope?: string;
-}
-type TAuthenticationRequest = IROPCRequest | IClientCredentialsRequest | IRefreshTokenRequest;
-/**
- * Authenticate to Verdocs.
- *
- * ```typescript
- * import {authenticate, VerdocsEndpoint} from '@verdocs/js-sdk';
- *
- * // Client-side call, suitable for Web and mobile apps:
- * const {access_token} = await Auth.authenticate({ username: 'test@test.com', password: 'PASSWORD', grant_type:'password' });
- * VerdocsEndpoint.getDefault().setAuthToken(access_token);
- *
- * // Server-side call, suitable for server apps. NEVER EXPOSE client_secret IN FRONT-END CODE:
- * const {access_token} = await Auth.authenticate({ client_id: '...', client_secret: '...', grant_type:'client_credentials' });
- * VerdocsEndpoint.getDefault().setAuthToken(access_token);
- * ```
- */
-declare const authenticate: (endpoint: VerdocsEndpoint, params: TAuthenticationRequest) => Promise<IAuthenticateResponse>;
-/**
- * If called before the session expires, this will refresh the caller's session and tokens.
- *
- * ```typescript
- * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
- *
- * const {accessToken} = await Auth.refreshTokens();
- * VerdocsEndpoint.setAuthToken(accessToken);
- * ```
- */
-declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) => Promise<IAuthenticateResponse>;
-/**
- * Update the caller's password when the old password is known (typically for logged-in users).
- *
- * ```typescript
- * import {changePassword} from '@verdocs/js-sdk';
- *
- * const {status, message} = await changePassword({ email, oldPassword, newPassword });
- * if (status !== 'OK') {
- *   window.alert(`Password reset error: ${message}`);
- * }
- * ```
- */
-declare const changePassword: (endpoint: VerdocsEndpoint, params: IUpdatePasswordRequest) => Promise<IUpdatePasswordResponse>;
-/**
- * Request a password reset, when the old password is not known (typically in login forms).
- *
- * ```typescript
- * import {resetPassword} from '@verdocs/js-sdk';
- *
- * const {success} = await resetPassword({ email });
- * if (status !== 'OK') {
- *   window.alert(`Please check your email for instructions on how to reset your password.`);
- * }
- * ```
- */
-declare const resetPassword: (endpoint: VerdocsEndpoint, params: {
-    email: string;
-}) => Promise<{
-    success: boolean;
-}>;
-/**
- * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
- * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
- * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
- * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
- * "anonymous" mode while verification is being performed.
- *
- * ```typescript
- * import {resendVerification} from '@verdocs/js-sdk';
- *
- * const result = await resendVerification();
- * ```
- */
-declare const verifyEmail: (endpoint: VerdocsEndpoint, email: string, code: string) => Promise<IAuthenticateResponse>;
-/**
- * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
- * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
- * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
- * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
- * "anonymous" mode while verification is being performed.
- *
- * ```typescript
- * import {resendVerification} from '@verdocs/js-sdk';
- *
- * const result = await resendVerification();
- * ```
- */
-declare const resendVerification: (endpoint: VerdocsEndpoint, accessToken?: string) => Promise<{
-    result: "done";
-}>;
-declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;
-/**
- * Get the user's available profiles. The current profile will be marked with `current: true`.
- *
- * ```typescript
- * import {getProfiles} from '@verdocs/js-sdk';
- *
- * const profiles = await getProfiles();
- * ```
- */
-declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
-/**
- * Get the user's available profiles. The current profile will be marked with `current: true`.
- *
- * ```typescript
- * import {getCurrentProfile} from '@verdocs/js-sdk';
- *
- * const profiles = await getCurrentProfile(VerdocsEndpoint.getDefault());
- * ```
- */
-declare const getCurrentProfile: (endpoint: VerdocsEndpoint) => Promise<IProfile | undefined>;
-/**
- * Get a profile. The caller must have admin access to the given profile.
- *
- * ```typescript
- * import {getProfile} from '@verdocs/js-sdk';
- *
- * const profile = await getProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IProfile>;
-/**
- * Switch the caller's "current" profile. The current profile is used for permissions checking
- * and profile_id field settings for most operations in Verdocs. It is important to select the
- * appropropriate profile before calling other API functions.
- *
- * ```typescript
- * import {switchProfile} from '@verdocs/js-sdk';
- *
- * const newProfile = await switchProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse>;
-/**
- * Update a profile. For future expansion, the profile ID to update is required, but currently
- * this must also be the "current" profile for the caller.
- *
- * ```typescript
- * import {updateProfile} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await updateProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
-/**
- * Delete a profile. If the requested profile is the caller's curent profile, the next
- * available profile will be selected.
- *
- * ```typescript
- * import {deleteProfile} from '@verdocs/js-sdk';
- *
- * await deleteProfile(VerdocsEndpoint.getDefault(), 'PROFILEID');
- * ```
- */
-declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse | {
-    status: "OK";
-    message: "Your last profile has been deleted. You are now logged out.";
-}>;
-/**
- * Create a new user account. Note that there are two registration paths for creation:
- *   - Get invited to an organization, by an admin or owner of that org.
- *   - Created a new organization. The caller will become the first owner of the new org.
- *
- * This endpoint is for the second path, so an organization name is required. It is NOT
- * required to be unique because it is very common for businesses to have the same names,
- * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
- *
- * The new profile will automatically be set as the user's "current" profile, and new
- * session tokens will be returned to the caller. However, the caller's email may not yet
- * be verified. In that case, the caller will not yet be able to call other endpoints in
- * the Verdocs API. The caller will need to check their email for a verification code,
- * which should be submitted via the `verifyEmail` endpoint.
- *
- * ```typescript
- * import {createProfile} from '@verdocs/js-sdk';
- *
- * const newSession = await createProfile(VerdocsEndpoint.getDefault(), {
- *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
- * });
- * ```
- */
-declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
-    profile: IProfile;
-    organization: IOrganization;
-}>;
-/**
- * Update the caller's profile photo. This can only be called for the user's "current" profile.
- *
- * ```typescript
- * import {uploadProfilePhoto} from '@verdocs/js-sdk';
- *
- * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), profileId, file);
- * ```
- */
-declare const updateProfilePhoto: (endpoint: VerdocsEndpoint, profileId: string, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
-export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TRole, TSortTemplateBy, TAccessKeyType, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, IRecipientKbaStatusNotRequired, IRecipientKbaStatusComplete, IRecipientKbaStatusPinRequired, IRecipientKbaStatusIdentityRequired, IRecipientKbaChallengeRequired, IRecipientKbaStatusFailed, TRecipientKbaStatus, getKbaStatus, submitKbaPin, IKbaIdentity, submitKbaIdentity, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, TEnvelopePermission, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganizations, getOrganization, updateOrganization, uploadOrganizationLogo, uploadOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, 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, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, 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, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TRole, TSortTemplateBy, TAccessKeyType, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, IRecipientKbaStatusNotRequired, IRecipientKbaStatusComplete, IRecipientKbaStatusPinRequired, IRecipientKbaStatusIdentityRequired, IRecipientKbaChallengeRequired, IRecipientKbaStatusFailed, TRecipientKbaStatus, getKbaStatus, submitKbaPin, IKbaIdentity, submitKbaIdentity, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, TEnvelopePermission, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, 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, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, 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, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };