@verdocs/js-sdk 4.2.27 → 4.2.30

package/dist/index.d.mts

@@ -847,8 +847,6 @@ interface ITemplateField {
     placeholder: string | null;
     /** For fields that support grouping (radio buttons and check boxes) the value selected will be stored under this name. */
     group: string | null;
-    // @deprecated. Use settings instead.
-    setting?: ITemplateFieldSetting | null;
 }
 interface ITextFieldSetting {
     x: number;
@@ -2111,16 +2109,34 @@ declare const canPerformTemplateAction: (profile: IProfile | null | undefined, a
 declare const hasRequiredPermissions: (profile: IProfile | null | undefined, permissions: TPermission[]) => boolean;
 /**
  * Add a field to a template.
+ *
+ * ```typescript
+ * import {createField} from '@verdocs/js-sdk/Templates';
+ *
+ * await createField((VerdocsEndpoint.getDefault(), template_id, { ... });
+ * ```
  */
 declare const createField: (endpoint: VerdocsEndpoint, templateId: string, params: ITemplateField) => Promise<ITemplateField>;
 /**
  * Update a template field.
+ *
+ * ```typescript
+ * import {updateField} from '@verdocs/js-sdk/Templates';
+ *
+ * await updateField((VerdocsEndpoint.getDefault(), template_id, field_name, { ... });
+ * ```
  */
-declare const updateField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string, params: Partial<ITemplateField>) => Promise<ITemplateField>;
+declare const updateField: (endpoint: VerdocsEndpoint, templateId: string, name: string, params: Partial<ITemplateField>) => Promise<ITemplateField>;
 /**
- * REmove a field from a template.
+ * Remove a field from a template.
+ *
+ * ```typescript
+ * import {deleteField} from '@verdocs/js-sdk/Templates';
+ *
+ * await deleteField((VerdocsEndpoint.getDefault(), template_id, field_name);
+ * ```
  */
-declare const deleteField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string) => Promise<any>;
+declare const deleteField: (endpoint: VerdocsEndpoint, templateId: string, name: string) => Promise<any>;
 /**
  * Check to see if the user created the template.
  */
@@ -2239,131 +2255,6 @@ declare const updateTemplateRole: (endpoint: VerdocsEndpoint, template_id: strin
  * ```
  */
 declare const deleteTemplateRole: (endpoint: VerdocsEndpoint, template_id: string, name: string) => Promise<any>;
-/**
- * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
- */
-declare function getRGB(rgba: string): string;
-/**
- * Given a signer role index, return the color code for that signer.
- */
-declare function getRGBA(roleIndex: number): "rgba(255, 193, 7, 0.4)" | "rgba(134, 134, 134, 0.3)" | "rgba(156, 39, 176, .4)" | "rgba(33, 150, 243, .4)" | "rgba(220, 231, 117, 0.3)" | "rgba(121, 134, 203, 0.3)" | "rgba(77, 182, 172, 0.3)" | "rgba(255, 202, 165, 0.3)" | "rgba(2, 247, 190, 0.3)" | "rgba(255, 138, 101, 0.3)" | "rgba(82, 255, 79, 0.3)" | "rgba(229, 115, 155, 0.3)";
-/**
- * Given a role name, return a color code for it. This works by computing a hash code so the specific color returned
- * is not specified explicitly, but will be the same for every call with the same input value.
- */
-declare function nameToRGBA(str: string): string | undefined;
-/**
- * Helper function to obtain a color code given a role name given various possible inputs.
- */
-declare function getRoleColor(name: string, roles: TRole[], index?: number): string | undefined;
-interface IFileWithData {
-    lastModified: number;
-    size: number;
-    type: string;
-    name: string;
-    data: string;
-}
-interface ICountry {
-    code: string;
-    name: string;
-    value: string;
-}
-interface ITimePeriod {
-    start_time: string;
-    end_time: string;
-}
-declare const formatShortTimeAgo: (val: any) => string;
-declare function timePeriod(type: string): ITimePeriod | null;
-declare function getRTop(y: number, fieldHeight: number, iTextHeight: number, yRatio: number): number;
-declare function getRLeft(x: number, ratio: number): number;
-declare function getRValue(y: number, ratio: number): number;
-declare function blobToBase64(image: Blob): Promise<unknown>;
-declare function rescale(r: number, n: number): number;
-/**
- * Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that
- * includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"
- */
-declare const fileToDataUrl: (file: File) => Promise<IFileWithData>;
-/**
- * Trigger a download dialog to save a blob as a file on disk.
- */
-declare const downloadBlob: (blob: Blob, name?: string) => void;
-declare const Countries: ICountry[];
-declare function getCountryByCode(code: string): ICountry | null;
-declare function isFrenchGuiana(code: string): boolean;
-declare function isGuadeloupe(code: string): boolean;
-declare function isMartinique(code: string): boolean;
-declare function isMayotte(code: string): boolean;
-declare function getPlusOneCountry(code: string): ICountry | null;
-declare function isCanada(code: string): boolean;
-declare function isAmericanSamoa(code: string): boolean;
-declare function isDominicanRepublic(code: string): boolean;
-declare function isPuertoRico(code: string): boolean;
-// need to finish
-declare function getMatchingCountry(code: string, substrings: number): number;
-/**
- * Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful
- * in rendering operations when there is no source array to .map() across.
- */
-declare const integerSequence: (start: number, count: number) => number[];
-/**
- * Format a profile's full name
- */
-declare const formatFullName: (profile?: IProfile) => string;
-/**
- * Format a profile's initials
- */
-declare const formatInitials: (profile?: IProfile) => string;
-/**
- * Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".
- */
-declare const fullNameToInitials: (name: string) => string;
-/**
- * Capitalize the first letter of a string.
- */
-declare const capitalize: (str: string) => string;
-/**
- * Convert a phone-number-like string to E164 format.
- * @see https://46elks.com/kb/e164
- */
-declare const convertToE164: (input: string) => string;
-/**
- * Simplified, Node/Browser-safe alternative to atob() for base64 decoding.
- * Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js
- */
-declare const AtoB: (str: string) => string;
-/**
- * Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in
- * many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.
- */
-declare const decodeJWTBody: (token: string) => any;
-/**
- * Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g.
- * `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing
- * will be removed. Note that user and signing sessions have different access token formats. The calling
- * application should distinguish between the two based on the context of the authenticated session, or by
- * the presence of the `document_id` field, which will only be present for signing sessions.
- */
-declare const decodeAccessTokenBody: (token: string) => TSession;
-interface ITemplateSearchParams {
-    id?: string;
-    name?: string;
-    sender?: string;
-    description?: string;
-    profile_id?: string;
-    organization_id?: string;
-    updated_at?: ITimePeriod;
-    created_at?: ITimePeriod;
-    last_used_at?: ITimePeriod;
-    is_personal?: boolean;
-    is_public?: boolean;
-    tags?: string[];
-    document_name?: string;
-    sort_by?: TSortTemplateBy;
-    ascending?: boolean;
-    row?: number;
-    page?: number;
-}
 interface ITemplateTag {
     tag_name: string;
     template_id: string;
@@ -2416,53 +2307,50 @@ declare const getTag: (endpoint: VerdocsEndpoint, name: string) => Promise<ITag>
  * Get all tags available for use by an Organization.
  */
 declare const getAllTags: (endpoint: VerdocsEndpoint) => Promise<ITag[]>;
+type ITemplateSortBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
 interface IGetTemplatesParams {
+    /** List only those templates whose names, descriptions, etc contain this search term. */
+    q?: string;
+    /** List only those templates with at least one "star". */
     is_starred?: boolean;
+    /** List only those templates created by the caller. */
     is_creator?: boolean;
-    is_organization?: boolean;
+    /**
+     * List only personal templates. To list shared templates, set this to false and is_public to false.
+     * To list all templates, omit this field.
+     */
+    is_personal?: boolean;
+    /** List only public templates */
+    is_public?: boolean;
+    /** Sort order */
+    sort_by?: TSortTemplateBy;
+    /** Set to true or false to control the sort order. Omit this field to sort dates descending, names ascending. */
+    ascending?: boolean;
+    /** Number of rows to retrieve. Defaults to 10. */
+    rows?: number;
+    /** Page to retrieve (0-based). Defaults to 0. */
+    page?: number;
 }
 /**
  * Get all templates accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplates} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.getTemplates((VerdocsEndpoint.getDefault());
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
- * await Templates.getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
+ * await getTemplates((VerdocsEndpoint.getDefault());
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_starred: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_creator: true });
+ * await getTemplates((VerdocsEndpoint.getDefault(), { is_organization: true });
  * ```
  */
 declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<ITemplate[]>;
-// export interface IListTemplatesParams {
-//   name?: string;
-//   sharing?: 'all' | 'personal' | 'shared' | 'public';
-//   starred?: 'all' | 'starred' | 'unstarred';
-//   sort?: 'name' | 'created_at' | 'updated_at' | 'last_used_at' | 'counter' | 'star_counter';
-//   direction?: 'asc' | 'desc';
-//   page?: number;
-//   rows?: number;
-// }
-/**
- * Lists all templates accessible by the caller, with optional filters.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
- * ```
- */
-// export const listTemplates = (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) =>
-//   endpoint.api //
-//     .post<ITemplateSummaries>('/templates/list', params, {baseURL: endpoint.getBaseURLv2()})
-//     .then((r) => r.data);
 /**
  * Get one template by its ID.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {getTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * const template = await getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
@@ -2524,9 +2412,9 @@ interface ITemplateCreateParams {
  * Create a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplate((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplate>;
@@ -2548,9 +2436,9 @@ interface ITemplateCreateFromSharepointParams {
  * Create a template from a Sharepoint asset.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {createTemplateFromSharepoint} from '@verdocs/js-sdk/Templates';
  *
- * const newTemplate = await Templates.createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
+ * const newTemplate = await createTemplateFromSharepoint((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
 declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params: ITemplateCreateFromSharepointParams) => Promise<ITemplate>;
@@ -2558,9 +2446,9 @@ declare const createTemplateFromSharepoint: (endpoint: VerdocsEndpoint, params:
  * Update a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {updateTemplate} from '@verdocs/js-sdk/Templates';
  *
- * const updatedTemplate = await Templates.updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * const updatedTemplate = await updateTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
  * ```
  */
 declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, params: Partial<ITemplateCreateParams>) => Promise<ITemplate>;
@@ -2568,70 +2456,12 @@ declare const updateTemplate: (endpoint: VerdocsEndpoint, templateId: string, pa
  * Delete a template.
  *
  * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
+ * import {deleteTemplate} from '@verdocs/js-sdk/Templates';
  *
- * await Templates.deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
+ * await deleteTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
  * ```
  */
 declare const deleteTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<any>;
-/**
- * Search for templates matching various criteria.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-declare const searchTemplates: (endpoint: VerdocsEndpoint, params: ITemplateSearchParams) => Promise<ITemplateSearchResult>;
-interface ISearchTimeRange {
-    start_time: string;
-    end_time: string;
-}
-type IGetTemplateSummarySortBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
-interface IGetTemplateSummaryParams {
-    id?: string;
-    name?: string;
-    sender?: string;
-    profile_id?: string;
-    organization_id?: string;
-    description?: string;
-    created_at?: ISearchTimeRange;
-    updated_at?: ISearchTimeRange;
-    last_used_at?: ISearchTimeRange;
-    is_personal?: boolean;
-    is_public?: boolean;
-    is_starred?: boolean;
-    sort_by?: IGetTemplateSummarySortBy;
-    ascending?: boolean;
-    row?: number;
-    page?: number;
-}
-interface ITemplateListParams {
-    status?: string[];
-    q?: string;
-    created_at?: ITimePeriod;
-    is_personal?: boolean;
-    is_public?: boolean;
-    sort_by?: TSortTemplateBy;
-    ascending?: boolean;
-    rows?: number;
-    page?: number;
-}
-/**
- * List templates.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
- */
-declare const listTemplates: (endpoint: VerdocsEndpoint, params?: ITemplateListParams) => Promise<{
-    total: number;
-    rows: number;
-    page: number;
-    templates: ITemplate[];
-}>;
 /**
  * Get all the Template Documents associated to a particular Template.
  *
@@ -2710,4 +2540,105 @@ 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;
-export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_SETTINGS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSigningSession, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, 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, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, 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, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSearchParams, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, 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 };
+/**
+ * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
+ */
+declare function getRGB(rgba: string): string;
+/**
+ * Given a signer role index, return the color code for that signer.
+ */
+declare function getRGBA(roleIndex: number): "rgba(255, 193, 7, 0.4)" | "rgba(134, 134, 134, 0.3)" | "rgba(156, 39, 176, .4)" | "rgba(33, 150, 243, .4)" | "rgba(220, 231, 117, 0.3)" | "rgba(121, 134, 203, 0.3)" | "rgba(77, 182, 172, 0.3)" | "rgba(255, 202, 165, 0.3)" | "rgba(2, 247, 190, 0.3)" | "rgba(255, 138, 101, 0.3)" | "rgba(82, 255, 79, 0.3)" | "rgba(229, 115, 155, 0.3)";
+/**
+ * Given a role name, return a color code for it. This works by computing a hash code so the specific color returned
+ * is not specified explicitly, but will be the same for every call with the same input value.
+ */
+declare function nameToRGBA(str: string): string | undefined;
+/**
+ * Helper function to obtain a color code given a role name given various possible inputs.
+ */
+declare function getRoleColor(name: string, roles: TRole[], index?: number): string | undefined;
+declare const formatShortTimeAgo: (val: any) => string;
+declare function getRTop(y: number, fieldHeight: number, iTextHeight: number, yRatio: number): number;
+declare function getRLeft(x: number, ratio: number): number;
+declare function getRValue(y: number, ratio: number): number;
+declare function blobToBase64(image: Blob): Promise<unknown>;
+declare function rescale(r: number, n: number): number;
+interface IFileWithData {
+    lastModified: number;
+    size: number;
+    type: string;
+    name: string;
+    data: string;
+}
+interface ICountry {
+    code: string;
+    name: string;
+    value: string;
+}
+/**
+ * Given a File, extract the file's content as a base64 encoded data URL. The response will have a prefix that
+ * includes the MIME type of the file, e.g. "data:image/jpeg;base64,iVBORw0K......"
+ */
+declare const fileToDataUrl: (file: File) => Promise<IFileWithData>;
+/**
+ * Trigger a download dialog to save a blob as a file on disk.
+ */
+declare const downloadBlob: (blob: Blob, name?: string) => void;
+declare const Countries: ICountry[];
+declare function getCountryByCode(code: string): ICountry | null;
+declare function isFrenchGuiana(code: string): boolean;
+declare function isGuadeloupe(code: string): boolean;
+declare function isMartinique(code: string): boolean;
+declare function isMayotte(code: string): boolean;
+declare function getPlusOneCountry(code: string): ICountry | null;
+declare function isCanada(code: string): boolean;
+declare function isAmericanSamoa(code: string): boolean;
+declare function isDominicanRepublic(code: string): boolean;
+declare function isPuertoRico(code: string): boolean;
+// need to finish
+declare function getMatchingCountry(code: string, substrings: number): number;
+/**
+ * Create an array containing a sequence of integers, e.g. [START, START+1, START+2, ...] This is frequently useful
+ * in rendering operations when there is no source array to .map() across.
+ */
+declare const integerSequence: (start: number, count: number) => number[];
+/**
+ * Format a profile's full name
+ */
+declare const formatFullName: (profile?: IProfile) => string;
+/**
+ * Format a profile's initials
+ */
+declare const formatInitials: (profile?: IProfile) => string;
+/**
+ * Generate suggested initials for a full name, e.g. "John Doe" will yield "JD".
+ */
+declare const fullNameToInitials: (name: string) => string;
+/**
+ * Capitalize the first letter of a string.
+ */
+declare const capitalize: (str: string) => string;
+/**
+ * Convert a phone-number-like string to E164 format.
+ * @see https://46elks.com/kb/e164
+ */
+declare const convertToE164: (input: string) => string;
+/**
+ * Simplified, Node/Browser-safe alternative to atob() for base64 decoding.
+ * Modified from https://github.com/MaxArt2501/base64-js/blob/master/base64.js
+ */
+declare const AtoB: (str: string) => string;
+/**
+ * Decode the body of a JWT. This helper may allow front-end applications to avoid a dependency on `jsonwebtoken` in
+ * many cases. Note that this should only be used for true JWTs. Opaque tokens will cause this to throw.
+ */
+declare const decodeJWTBody: (token: string) => any;
+/**
+ * Decode the body of an Verdocs access token. Note that raw tokens contain namespaced fields, e.g.
+ * `https://verdocs.com/profile_id`. To make these tokens easier to use in front-end code, this name-spacing
+ * will be removed. Note that user and signing sessions have different access token formats. The calling
+ * application should distinguish between the two based on the context of the authenticated session, or by
+ * the presence of the `document_id` field, which will only be present for signing sessions.
+ */
+declare const decodeAccessTokenBody: (token: string) => TSession;
+export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, DEFAULT_FIELD_SETTINGS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSigningSession, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, 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, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, 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, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, 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 };