@verdocs/js-sdk 4.1.5 → 4.1.7

package/dist/index.d.mts

@@ -384,6 +384,9 @@ interface IInitial {
     deleted_at: string | null;
     profile?: IProfile;
 }
+interface IKbaPINRequired {
+    type: "pin";
+}
 interface IRecipient {
     envelope_id: string;
     role_name: string;
@@ -417,10 +420,25 @@ interface IRecipient {
     last_attempt_at: string;
     /**
      * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template.
+     * created from this template. For privacy reasons, this field will only be visible to the creator
+     * of the envelope and the recipient referenced.
+     */
+    kba_method: "pin" | "identity" | null;
+    /**
+     * If KBA is set to "PIN" this will be set to the PIN code required. For security reasons, this
+     * field will only be visible to the creator of the envelope.
+     */
+    kba_pin?: string | null;
+    /**
+     * If KBA has been completed successfully, this will be set to true. For privacy reasons, this
+     * field will only be visible to the creator of the envelope and the recipient referenced.
      */
-    kba_method: string | null;
     kba_completed: boolean;
+    /**
+     * If KBA has been completed (or partially successfully, this will contain metadata related to
+     * the questions and answers from the process. For privacy reasons, this field will only be visible
+     * to the recipient referenced.
+     */
     kba_details: Record<string, any>;
     envelope?: IEnvelope;
     profile?: IProfile;
@@ -467,7 +485,7 @@ interface IRole {
      * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
      * created from this template.
      */
-    kba_method: string | null;
+    kba_method: "pin" | "identity" | null;
 }
 interface ISignature {
     id: string;
@@ -1346,6 +1364,105 @@ declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId:
  * to be "stamped" by the user.
  */
 declare const createInitials: (endpoint: VerdocsEndpoint, name: string, initials: Blob) => Promise<IInitial>;
+/**
+ * KBA is not required at this time. Note that if there is a discrepancy between the `kba_required`
+ * field here and that in the Recipient object, this object should be considered authoritative
+ * (this can happen if the envelope sender updates the setting after the recipient has already
+ * been invited).
+ */
+interface IRecipientKbaStatusNotRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: false;
+}
+/**
+ * KBA has been completed and no further action is required.
+ */
+interface IRecipientKbaStatusComplete {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: true;
+    kba_method: string;
+}
+/**
+ * A PIN code is required. Prompt the user to enter this PIN, and submit it via `submitKbaPin()`.
+ */
+interface IRecipientKbaStatusPinRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "pin";
+}
+/**
+ * A full identity verification is required. Prompt the user for their address and other (optional)
+ * details and submit them via `submitKbaIdentity()`.
+ */
+interface IRecipientKbaStatusIdentityRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "identity";
+}
+/**
+ * Triggered by full identity verification if additional challenges are required. The recipient
+ * should be shown the message and options, and submit a response via `submitKbaChallengeResponse()`.
+ * Note that this response may be issued more than once if multiple challenges are required.
+ */
+interface IRecipientKbaChallengeRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "challenge";
+    message: string;
+    options: string[];
+}
+/**
+ * Identity verification has failed. The user should be shown the message included. No further
+ * signing operations may be performed.
+ */
+interface IRecipientKbaStatusFailed {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "failed";
+    meesage: string;
+}
+type TRecipientKbaStatus = IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed;
+/**
+ * Get the current KBA status. Note that this may only be called by the recipient and requires a
+ * valid signing session to proceed. Although the Recipient object itself contains indications of
+ * whether KBA is required, it will not contain the current status of the process. If
+ * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
+ * should be called to determine the next KBA step required.
+ */
+declare const getKbaStatus: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+/**
+ * Submit a response to a KBA PIN challenge.
+ */
+declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+interface IKbaIdentity {
+    address1: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+    ssn?: string;
+    ssnLast4?: string;
+}
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
 /**
  * Update a recipient's status block
  */
@@ -1653,6 +1770,26 @@ declare const deleteOrganization: (endpoint: VerdocsEndpoint, organizationId: st
  * Update an organization.
  */
 declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: string, params: Partial<IOrganization>) => Promise<IOrganization>;
+/**
+ * Update the organization's logo. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadOrganizationLogo: (endpoint: VerdocsEndpoint, 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 of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadOrganizationThumbnail: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
 /**
  * Get the registered Webhooks for the caller's organization.
  */
@@ -2315,12 +2452,6 @@ 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 ICreateProfileRequest {
-    first_name: string;
-    last_name: string;
-    email: string;
-    phone?: string;
-}
 interface ISwitchProfileResponse {
     profile: IProfile;
     accessToken: string;
@@ -2402,11 +2533,10 @@ declare const authenticate: (endpoint: VerdocsEndpoint, params: TAuthenticationR
  * If called before the session expires, this will refresh the caller's session and tokens.
  *
  * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Transport} from '@verdocs/js-sdk/HTTP';
+ * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
  *
  * const {accessToken} = await Auth.refreshTokens();
- * Transport.setAuthToken(accessToken);
+ * VerdocsEndpoint.setAuthToken(accessToken);
  * ```
  */
 declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) => Promise<IAuthenticateResponse>;
@@ -2414,7 +2544,7 @@ declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) =>
  * Update the caller's password when the old password is known (typically for logged-in users).
  *
  * ```typescript
- * import {changePassword} from '@verdocs/js-sdk/Auth';
+ * import {changePassword} from '@verdocs/js-sdk';
  *
  * const {status, message} = await changePassword({ email, oldPassword, newPassword });
  * if (status !== 'OK') {
@@ -2427,7 +2557,7 @@ declare const changePassword: (endpoint: VerdocsEndpoint, params: IUpdatePasswor
  * Request a password reset, when the old password is not known (typically in login forms).
  *
  * ```typescript
- * import {resetPassword} from '@verdocs/js-sdk/Auth';
+ * import {resetPassword} from '@verdocs/js-sdk';
  *
  * const {success} = await resetPassword({ email });
  * if (status !== 'OK') {
@@ -2448,9 +2578,23 @@ declare const resetPassword: (endpoint: VerdocsEndpoint, params: {
  * "anonymous" mode while verification is being performed.
  *
  * ```typescript
- * import {Auth} from '@verdocs/js-sdk/Auth';
+ * import {resendVerification} from '@verdocs/js-sdk';
  *
- * const result = await Auth.resendVerification();
+ * 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<{
@@ -2461,9 +2605,9 @@ declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {getProfiles} from '@verdocs/js-sdk';
  *
- * const profiles = await Profiles.getProfiles()
+ * const profiles = await getProfiles();
  * ```
  */
 declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
@@ -2471,91 +2615,95 @@ declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {getCurrentProfile} from '@verdocs/js-sdk';
  *
- * const profiles = await Profiles.getCurrentProfile()
+ * const profiles = await getCurrentProfile();
  * ```
  */
 declare const getCurrentProfile: (endpoint: VerdocsEndpoint) => Promise<IProfile | undefined>;
-/**
- * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
- *
- * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
- *
- * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
- * ```
- */
-declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateProfileRequest) => Promise<IProfile>;
 /**
  * Get a profile. The caller must have admin access to the given profile.
  * TODO: Add a "public" profile endpoint for public pages
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {getProfile} from '@verdocs/js-sdk';
  *
- * const profile = await Profiles.getProfile('PROFILEID');
+ * const profile = await getProfile('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.
+ * 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 {Profiles} from '@verdocs/js-sdk/Users';
+ * import {switchProfile} from '@verdocs/js-sdk';
  *
- * const newProfile = await Profiles.switchProfile('PROFILEID');
+ * const newProfile = await switchProfile('PROFILEID');
  * ```
  */
 declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<ISwitchProfileResponse>;
 /**
- * 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.
+ * 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 {Profiles} from '@verdocs/js-sdk/Users';
+ * import {updateProfile} from '@verdocs/js-sdk/Users';
  *
- * const newProfile = await Profiles.updateProfile('PROFILEID');
+ * const newProfile = await updateProfile('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.
+ * Delete a profile. If the requested profile is the caller's curent profile, the next
+ * available profile will be selected.
  *
  * ```typescript
- * import {Profiles} from '@verdocs/js-sdk/Users';
+ * import {deleteProfile} from '@verdocs/js-sdk';
  *
- * await Profiles.deleteProfile('PROFILEID');
+ * await deleteProfile('PROFILEID');
  * ```
  */
-declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
+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 user account and parent organization. This endpoint is for creating a new organization. Users joining an
- * existing organization should be invited, and follow their invitation links/instructions to create their accounts.
+ * 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 {Profiles} from '@verdocs/js-sdk/Users';
+ * import {createProfile} from '@verdocs/js-sdk';
  *
- * const newAccount = await Profiles.createBusinessAccount({
- *   orgName: 'ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
+ * const newSession = await createProfile({
+ *   orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
  * });
  * ```
  */
-declare const createAccount: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
+declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
     profile: IProfile;
     organization: IOrganization;
 }>;
-interface ISignupSurvey {
-    industry?: string;
-    size?: string;
-    source?: string;
-    referral?: string;
-    coupon?: string;
-    reason?: string;
-    hearabout?: string;
-}
-declare const recordSignupSurvey: (endpoint: VerdocsEndpoint, params: ISignupSurvey) => Promise<{
-    status: "OK";
-}>;
-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, 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, 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, createOrganization, deleteOrganization, updateOrganization, 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, resendVerification, getNotifications, getProfiles, getCurrentProfile, createProfile, getProfile, switchProfile, updateProfile, deleteProfile, createAccount, ISignupSurvey, recordSignupSurvey, ICreateProfileRequest, ISwitchProfileResponse, 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 };
+/**
+ * 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(), file);
+ * ```
+ */
+declare const uploadProfilePhoto: (endpoint: VerdocsEndpoint, 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, createOrganization, deleteOrganization, 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, uploadProfilePhoto, ISwitchProfileResponse, 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 };