@verdocs/js-sdk 4.1.5 → 4.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -2315,12 +2315,6 @@ declare const isValidEmail: (email: string | undefined) => boolean;
2315
2315
  declare const isValidPhone: (phone: string | undefined) => boolean;
2316
2316
  declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
2317
2317
  declare const isValidTag: (value: string, tags: string[]) => boolean;
2318
- interface ICreateProfileRequest {
2319
- first_name: string;
2320
- last_name: string;
2321
- email: string;
2322
- phone?: string;
2323
- }
2324
2318
  interface ISwitchProfileResponse {
2325
2319
  profile: IProfile;
2326
2320
  accessToken: string;
@@ -2402,11 +2396,10 @@ declare const authenticate: (endpoint: VerdocsEndpoint, params: TAuthenticationR
2402
2396
  * If called before the session expires, this will refresh the caller's session and tokens.
2403
2397
  *
2404
2398
  * ```typescript
2405
- * import {Auth} from '@verdocs/js-sdk/Auth';
2406
- * import {Transport} from '@verdocs/js-sdk/HTTP';
2399
+ * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
2407
2400
  *
2408
2401
  * const {accessToken} = await Auth.refreshTokens();
2409
- * Transport.setAuthToken(accessToken);
2402
+ * VerdocsEndpoint.setAuthToken(accessToken);
2410
2403
  * ```
2411
2404
  */
2412
2405
  declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) => Promise<IAuthenticateResponse>;
@@ -2414,7 +2407,7 @@ declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) =>
2414
2407
  * Update the caller's password when the old password is known (typically for logged-in users).
2415
2408
  *
2416
2409
  * ```typescript
2417
- * import {changePassword} from '@verdocs/js-sdk/Auth';
2410
+ * import {changePassword} from '@verdocs/js-sdk';
2418
2411
  *
2419
2412
  * const {status, message} = await changePassword({ email, oldPassword, newPassword });
2420
2413
  * if (status !== 'OK') {
@@ -2427,7 +2420,7 @@ declare const changePassword: (endpoint: VerdocsEndpoint, params: IUpdatePasswor
2427
2420
  * Request a password reset, when the old password is not known (typically in login forms).
2428
2421
  *
2429
2422
  * ```typescript
2430
- * import {resetPassword} from '@verdocs/js-sdk/Auth';
2423
+ * import {resetPassword} from '@verdocs/js-sdk';
2431
2424
  *
2432
2425
  * const {success} = await resetPassword({ email });
2433
2426
  * if (status !== 'OK') {
@@ -2448,9 +2441,23 @@ declare const resetPassword: (endpoint: VerdocsEndpoint, params: {
2448
2441
  * "anonymous" mode while verification is being performed.
2449
2442
  *
2450
2443
  * ```typescript
2451
- * import {Auth} from '@verdocs/js-sdk/Auth';
2444
+ * import {resendVerification} from '@verdocs/js-sdk';
2445
+ *
2446
+ * const result = await resendVerification();
2447
+ * ```
2448
+ */
2449
+ declare const verifyEmail: (endpoint: VerdocsEndpoint, email: string, code: string) => Promise<IAuthenticateResponse>;
2450
+ /**
2451
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
2452
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
2453
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
2454
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
2455
+ * "anonymous" mode while verification is being performed.
2456
+ *
2457
+ * ```typescript
2458
+ * import {resendVerification} from '@verdocs/js-sdk';
2452
2459
  *
2453
- * const result = await Auth.resendVerification();
2460
+ * const result = await resendVerification();
2454
2461
  * ```
2455
2462
  */
2456
2463
  declare const resendVerification: (endpoint: VerdocsEndpoint, accessToken?: string) => Promise<{
@@ -2461,9 +2468,9 @@ declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;
2461
2468
  * Get the user's available profiles. The current profile will be marked with `current: true`.
2462
2469
  *
2463
2470
  * ```typescript
2464
- * import {Profiles} from '@verdocs/js-sdk/Users';
2471
+ * import {getProfiles} from '@verdocs/js-sdk';
2465
2472
  *
2466
- * const profiles = await Profiles.getProfiles()
2473
+ * const profiles = await getProfiles();
2467
2474
  * ```
2468
2475
  */
2469
2476
  declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
@@ -2471,91 +2478,85 @@ declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
2471
2478
  * Get the user's available profiles. The current profile will be marked with `current: true`.
2472
2479
  *
2473
2480
  * ```typescript
2474
- * import {Profiles} from '@verdocs/js-sdk/Users';
2481
+ * import {getCurrentProfile} from '@verdocs/js-sdk';
2475
2482
  *
2476
- * const profiles = await Profiles.getCurrentProfile()
2483
+ * const profiles = await getCurrentProfile();
2477
2484
  * ```
2478
2485
  */
2479
2486
  declare const getCurrentProfile: (endpoint: VerdocsEndpoint) => Promise<IProfile | undefined>;
2480
- /**
2481
- * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
2482
- *
2483
- * ```typescript
2484
- * import {Profiles} from '@verdocs/js-sdk/Users';
2485
- *
2486
- * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
2487
- * ```
2488
- */
2489
- declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateProfileRequest) => Promise<IProfile>;
2490
2487
  /**
2491
2488
  * Get a profile. The caller must have admin access to the given profile.
2492
2489
  * TODO: Add a "public" profile endpoint for public pages
2493
2490
  *
2494
2491
  * ```typescript
2495
- * import {Profiles} from '@verdocs/js-sdk/Users';
2492
+ * import {getProfile} from '@verdocs/js-sdk';
2496
2493
  *
2497
- * const profile = await Profiles.getProfile('PROFILEID');
2494
+ * const profile = await getProfile('PROFILEID');
2498
2495
  * ```
2499
2496
  */
2500
2497
  declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IProfile>;
2501
2498
  /**
2502
- * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
2503
- * for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.
2499
+ * Switch the caller's "current" profile. The current profile is used for permissions checking
2500
+ * and profile_id field settings for most operations in Verdocs. It is important to select the
2501
+ * appropropriate profile before calling other API functions.
2504
2502
  *
2505
2503
  * ```typescript
2506
- * import {Profiles} from '@verdocs/js-sdk/Users';
2504
+ * import {switchProfile} from '@verdocs/js-sdk';
2507
2505
  *
2508
- * const newProfile = await Profiles.switchProfile('PROFILEID');
2506
+ * const newProfile = await switchProfile('PROFILEID');
2509
2507
  * ```
2510
2508
  */
2511
2509
  declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<ISwitchProfileResponse>;
2512
2510
  /**
2513
- * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
2514
- * "current" profile for the caller.
2511
+ * Update a profile. For future expansion, the profile ID to update is required, but currently
2512
+ * this must also be the "current" profile for the caller.
2515
2513
  *
2516
2514
  * ```typescript
2517
- * import {Profiles} from '@verdocs/js-sdk/Users';
2515
+ * import {updateProfile} from '@verdocs/js-sdk/Users';
2518
2516
  *
2519
- * const newProfile = await Profiles.updateProfile('PROFILEID');
2517
+ * const newProfile = await updateProfile('PROFILEID');
2520
2518
  * ```
2521
2519
  */
2522
2520
  declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
2523
2521
  /**
2524
- * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
2522
+ * Delete a profile. If the requested profile is the caller's curent profile, the next
2523
+ * available profile will be selected.
2525
2524
  *
2526
2525
  * ```typescript
2527
- * import {Profiles} from '@verdocs/js-sdk/Users';
2526
+ * import {deleteProfile} from '@verdocs/js-sdk';
2528
2527
  *
2529
- * await Profiles.deleteProfile('PROFILEID');
2528
+ * await deleteProfile('PROFILEID');
2530
2529
  * ```
2531
2530
  */
2532
- declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
2531
+ declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse | {
2532
+ status: "OK";
2533
+ message: "Your last profile has been deleted. You are now logged out.";
2534
+ }>;
2533
2535
  /**
2534
- * Create a user account and parent organization. This endpoint is for creating a new organization. Users joining an
2535
- * existing organization should be invited, and follow their invitation links/instructions to create their accounts.
2536
+ * Create a new user account. Note that there are two registration paths for creation:
2537
+ * - Get invited to an organization, by an admin or owner of that org.
2538
+ * - Created a new organization. The caller will become the first owner of the new org.
2539
+ *
2540
+ * This endpoint is for the second path, so an organization name is required. It is NOT
2541
+ * required to be unique because it is very common for businesses to have the same names,
2542
+ * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
2543
+ *
2544
+ * The new profile will automatically be set as the user's "current" profile, and new
2545
+ * session tokens will be returned to the caller. However, the caller's email may not yet
2546
+ * be verified. In that case, the caller will not yet be able to call other endpoints in
2547
+ * the Verdocs API. The caller will need to check their email for a verification code,
2548
+ * which should be submitted via the `verifyEmail` endpoint.
2536
2549
  *
2537
2550
  * ```typescript
2538
- * import {Profiles} from '@verdocs/js-sdk/Users';
2551
+ * import {createProfile} from '@verdocs/js-sdk';
2539
2552
  *
2540
- * const newAccount = await Profiles.createBusinessAccount({
2541
- * orgName: 'ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
2553
+ * const newSession = await createProfile({
2554
+ * orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
2542
2555
  * });
2543
2556
  * ```
2544
2557
  */
2545
- declare const createAccount: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
2558
+ declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
2546
2559
  profile: IProfile;
2547
2560
  organization: IOrganization;
2548
2561
  }>;
2549
- interface ISignupSurvey {
2550
- industry?: string;
2551
- size?: string;
2552
- source?: string;
2553
- referral?: string;
2554
- coupon?: string;
2555
- reason?: string;
2556
- hearabout?: string;
2557
- }
2558
- declare const recordSignupSurvey: (endpoint: VerdocsEndpoint, params: ISignupSurvey) => Promise<{
2559
- status: "OK";
2560
- }>;
2561
- 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 };
2562
+ 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, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, 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 };
package/dist/index.d.ts CHANGED
@@ -2315,12 +2315,6 @@ declare const isValidEmail: (email: string | undefined) => boolean;
2315
2315
  declare const isValidPhone: (phone: string | undefined) => boolean;
2316
2316
  declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
2317
2317
  declare const isValidTag: (value: string, tags: string[]) => boolean;
2318
- interface ICreateProfileRequest {
2319
- first_name: string;
2320
- last_name: string;
2321
- email: string;
2322
- phone?: string;
2323
- }
2324
2318
  interface ISwitchProfileResponse {
2325
2319
  profile: IProfile;
2326
2320
  accessToken: string;
@@ -2402,11 +2396,10 @@ declare const authenticate: (endpoint: VerdocsEndpoint, params: TAuthenticationR
2402
2396
  * If called before the session expires, this will refresh the caller's session and tokens.
2403
2397
  *
2404
2398
  * ```typescript
2405
- * import {Auth} from '@verdocs/js-sdk/Auth';
2406
- * import {Transport} from '@verdocs/js-sdk/HTTP';
2399
+ * import {Auth, VerdocsEndpoint} from '@verdocs/js-sdk';
2407
2400
  *
2408
2401
  * const {accessToken} = await Auth.refreshTokens();
2409
- * Transport.setAuthToken(accessToken);
2402
+ * VerdocsEndpoint.setAuthToken(accessToken);
2410
2403
  * ```
2411
2404
  */
2412
2405
  declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) => Promise<IAuthenticateResponse>;
@@ -2414,7 +2407,7 @@ declare const refreshToken: (endpoint: VerdocsEndpoint, refreshToken: string) =>
2414
2407
  * Update the caller's password when the old password is known (typically for logged-in users).
2415
2408
  *
2416
2409
  * ```typescript
2417
- * import {changePassword} from '@verdocs/js-sdk/Auth';
2410
+ * import {changePassword} from '@verdocs/js-sdk';
2418
2411
  *
2419
2412
  * const {status, message} = await changePassword({ email, oldPassword, newPassword });
2420
2413
  * if (status !== 'OK') {
@@ -2427,7 +2420,7 @@ declare const changePassword: (endpoint: VerdocsEndpoint, params: IUpdatePasswor
2427
2420
  * Request a password reset, when the old password is not known (typically in login forms).
2428
2421
  *
2429
2422
  * ```typescript
2430
- * import {resetPassword} from '@verdocs/js-sdk/Auth';
2423
+ * import {resetPassword} from '@verdocs/js-sdk';
2431
2424
  *
2432
2425
  * const {success} = await resetPassword({ email });
2433
2426
  * if (status !== 'OK') {
@@ -2448,9 +2441,23 @@ declare const resetPassword: (endpoint: VerdocsEndpoint, params: {
2448
2441
  * "anonymous" mode while verification is being performed.
2449
2442
  *
2450
2443
  * ```typescript
2451
- * import {Auth} from '@verdocs/js-sdk/Auth';
2444
+ * import {resendVerification} from '@verdocs/js-sdk';
2445
+ *
2446
+ * const result = await resendVerification();
2447
+ * ```
2448
+ */
2449
+ declare const verifyEmail: (endpoint: VerdocsEndpoint, email: string, code: string) => Promise<IAuthenticateResponse>;
2450
+ /**
2451
+ * Resend the email verification request. Note that to prevent certain forms of abuse, the email address is not
2452
+ * a parameter here. Instead, the caller must be authenticated as the (unverified) user. To simplify this process,
2453
+ * the access token to be used may be passed directly as a parameter here. This avoids the need to set it as the
2454
+ * active token on an endpoint, which may be inconvenient in workflows where it is preferable to keep the user in
2455
+ * "anonymous" mode while verification is being performed.
2456
+ *
2457
+ * ```typescript
2458
+ * import {resendVerification} from '@verdocs/js-sdk';
2452
2459
  *
2453
- * const result = await Auth.resendVerification();
2460
+ * const result = await resendVerification();
2454
2461
  * ```
2455
2462
  */
2456
2463
  declare const resendVerification: (endpoint: VerdocsEndpoint, accessToken?: string) => Promise<{
@@ -2461,9 +2468,9 @@ declare const getNotifications: (endpoint: VerdocsEndpoint) => Promise<any>;
2461
2468
  * Get the user's available profiles. The current profile will be marked with `current: true`.
2462
2469
  *
2463
2470
  * ```typescript
2464
- * import {Profiles} from '@verdocs/js-sdk/Users';
2471
+ * import {getProfiles} from '@verdocs/js-sdk';
2465
2472
  *
2466
- * const profiles = await Profiles.getProfiles()
2473
+ * const profiles = await getProfiles();
2467
2474
  * ```
2468
2475
  */
2469
2476
  declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
@@ -2471,91 +2478,85 @@ declare const getProfiles: (endpoint: VerdocsEndpoint) => Promise<IProfile[]>;
2471
2478
  * Get the user's available profiles. The current profile will be marked with `current: true`.
2472
2479
  *
2473
2480
  * ```typescript
2474
- * import {Profiles} from '@verdocs/js-sdk/Users';
2481
+ * import {getCurrentProfile} from '@verdocs/js-sdk';
2475
2482
  *
2476
- * const profiles = await Profiles.getCurrentProfile()
2483
+ * const profiles = await getCurrentProfile();
2477
2484
  * ```
2478
2485
  */
2479
2486
  declare const getCurrentProfile: (endpoint: VerdocsEndpoint) => Promise<IProfile | undefined>;
2480
- /**
2481
- * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
2482
- *
2483
- * ```typescript
2484
- * import {Profiles} from '@verdocs/js-sdk/Users';
2485
- *
2486
- * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
2487
- * ```
2488
- */
2489
- declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateProfileRequest) => Promise<IProfile>;
2490
2487
  /**
2491
2488
  * Get a profile. The caller must have admin access to the given profile.
2492
2489
  * TODO: Add a "public" profile endpoint for public pages
2493
2490
  *
2494
2491
  * ```typescript
2495
- * import {Profiles} from '@verdocs/js-sdk/Users';
2492
+ * import {getProfile} from '@verdocs/js-sdk';
2496
2493
  *
2497
- * const profile = await Profiles.getProfile('PROFILEID');
2494
+ * const profile = await getProfile('PROFILEID');
2498
2495
  * ```
2499
2496
  */
2500
2497
  declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IProfile>;
2501
2498
  /**
2502
- * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
2503
- * for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.
2499
+ * Switch the caller's "current" profile. The current profile is used for permissions checking
2500
+ * and profile_id field settings for most operations in Verdocs. It is important to select the
2501
+ * appropropriate profile before calling other API functions.
2504
2502
  *
2505
2503
  * ```typescript
2506
- * import {Profiles} from '@verdocs/js-sdk/Users';
2504
+ * import {switchProfile} from '@verdocs/js-sdk';
2507
2505
  *
2508
- * const newProfile = await Profiles.switchProfile('PROFILEID');
2506
+ * const newProfile = await switchProfile('PROFILEID');
2509
2507
  * ```
2510
2508
  */
2511
2509
  declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<ISwitchProfileResponse>;
2512
2510
  /**
2513
- * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
2514
- * "current" profile for the caller.
2511
+ * Update a profile. For future expansion, the profile ID to update is required, but currently
2512
+ * this must also be the "current" profile for the caller.
2515
2513
  *
2516
2514
  * ```typescript
2517
- * import {Profiles} from '@verdocs/js-sdk/Users';
2515
+ * import {updateProfile} from '@verdocs/js-sdk/Users';
2518
2516
  *
2519
- * const newProfile = await Profiles.updateProfile('PROFILEID');
2517
+ * const newProfile = await updateProfile('PROFILEID');
2520
2518
  * ```
2521
2519
  */
2522
2520
  declare const updateProfile: (endpoint: VerdocsEndpoint, profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
2523
2521
  /**
2524
- * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
2522
+ * Delete a profile. If the requested profile is the caller's curent profile, the next
2523
+ * available profile will be selected.
2525
2524
  *
2526
2525
  * ```typescript
2527
- * import {Profiles} from '@verdocs/js-sdk/Users';
2526
+ * import {deleteProfile} from '@verdocs/js-sdk';
2528
2527
  *
2529
- * await Profiles.deleteProfile('PROFILEID');
2528
+ * await deleteProfile('PROFILEID');
2530
2529
  * ```
2531
2530
  */
2532
- declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<any>;
2531
+ declare const deleteProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse | {
2532
+ status: "OK";
2533
+ message: "Your last profile has been deleted. You are now logged out.";
2534
+ }>;
2533
2535
  /**
2534
- * Create a user account and parent organization. This endpoint is for creating a new organization. Users joining an
2535
- * existing organization should be invited, and follow their invitation links/instructions to create their accounts.
2536
+ * Create a new user account. Note that there are two registration paths for creation:
2537
+ * - Get invited to an organization, by an admin or owner of that org.
2538
+ * - Created a new organization. The caller will become the first owner of the new org.
2539
+ *
2540
+ * This endpoint is for the second path, so an organization name is required. It is NOT
2541
+ * required to be unique because it is very common for businesses to have the same names,
2542
+ * without conflicting (e.g. "Delta" could be Delta Faucet or Delta Airlines).
2543
+ *
2544
+ * The new profile will automatically be set as the user's "current" profile, and new
2545
+ * session tokens will be returned to the caller. However, the caller's email may not yet
2546
+ * be verified. In that case, the caller will not yet be able to call other endpoints in
2547
+ * the Verdocs API. The caller will need to check their email for a verification code,
2548
+ * which should be submitted via the `verifyEmail` endpoint.
2536
2549
  *
2537
2550
  * ```typescript
2538
- * import {Profiles} from '@verdocs/js-sdk/Users';
2551
+ * import {createProfile} from '@verdocs/js-sdk';
2539
2552
  *
2540
- * const newAccount = await Profiles.createBusinessAccount({
2541
- * orgName: 'ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
2553
+ * const newSession = await createProfile({
2554
+ * orgName: 'NEW ORG', email: 'a@b.com', password: '12345678', firstName: 'FIRST', lastName: 'LAST'
2542
2555
  * });
2543
2556
  * ```
2544
2557
  */
2545
- declare const createAccount: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
2558
+ declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountRequest) => Promise<{
2546
2559
  profile: IProfile;
2547
2560
  organization: IOrganization;
2548
2561
  }>;
2549
- interface ISignupSurvey {
2550
- industry?: string;
2551
- size?: string;
2552
- source?: string;
2553
- referral?: string;
2554
- coupon?: string;
2555
- reason?: string;
2556
- hearabout?: string;
2557
- }
2558
- declare const recordSignupSurvey: (endpoint: VerdocsEndpoint, params: ISignupSurvey) => Promise<{
2559
- status: "OK";
2560
- }>;
2561
- 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 };
2562
+ 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, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, 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 };