@verdocs/js-sdk 4.0.3 → 4.0.4

package/dist/index.d.mts

@@ -636,37 +636,176 @@ interface IActivityEntry {
         type: TRecipientType;
     };
 }
-type TRequestStatus = "OK" | "ERROR";
-type TTemplateSenderType = "creator" | "organization_member" | "organization_member_as_creator" | "everyone" | "everyone_as_creator";
-type TTemplatePermission = "template:creator:create:public" | "template:creator:create:org" | "template:creator:create:personal" | "template:creator:delete" | "template:creator:visibility" | "template:member:read" | "template:member:write" | "template:member:delete" | "template:member:visibility";
-type TTemplateAction = "create_personal" | "create_org" | "create_public" | "read" | "write" | "delete" | "change_visibility_personal" | "change_visibility_org" | "change_visibility_public";
-type TAccountPermission = "owner:add" | "owner:remove" | "admin:add" | "admin:remove" | "member:view" | "member:add" | "member:remove";
-type TOrgPermission = "org:create" | "org:view" | "org:update" | "org:delete" | "org:transfer" | "org:list";
-type TApiKeyPermission = "personal" | "global_read" | "global_write";
-/**
- * Operation within Verdocs that users may perform.
- */
-type TPermission = TTemplatePermission | TOrgPermission | TAccountPermission;
-type TRecipientAction = "submit" | "decline" | "prepare" | "update";
-type TEnvelopeStatus = "complete" | "pending" | "in progress" | "declined" | "canceled";
-type TRecipientStatus = "invited" | "opened" | "signed" | "submitted" | "canceled" | "pending" | "declined";
-type TRecipientType = "signer" | "cc" | "approver";
 /**
- * Plans provide access to Verdocs product features.
- */
-type TPlan = "env:essential" | "org:standard";
-/**
- * Roles provide access to groups of permissions. Note that for historical reasons there is some overlap in the
- * use of the term "role". TRole refers to a user type. A "Role" (IRole) is a Template participant placeholder.
+ * One entry in an envelope search result.
+ * NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
  */
-type TRole = "contact" | "basic_user" | "member" | "admin" | "owner";
-type TSortTemplateBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
-type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
-type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
-type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
-// Modification events have a string description
-type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
-type TFieldType = "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
+interface IEnvelopesSearchResultEntry {
+    id: string;
+    canceled_at: string;
+    certificate_document_id: string;
+    created_at: string;
+    histories: IEnvelopeHistory[];
+    indexed_at: string;
+    name: string;
+    no_contact: boolean;
+    organization_id: string;
+    profile_id: string;
+    recipients: IRecipient[];
+    reminder_id: string | null;
+    status: TEnvelopeStatus;
+    /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
+    visibility: "private" | "shared";
+    next_recipient: {
+        claimed: boolean;
+        email: string;
+        name: string;
+        profile_id: string;
+        status: TRecipientStatus;
+        type: TRecipientType;
+    };
+    template_id: string;
+    total_count: number;
+    updated_at: string;
+}
+interface IEnvelopesSearchResult {
+    page: number;
+    total: number;
+    result: IEnvelopesSearchResultEntry[];
+}
+interface IEnvelopesSummary {
+    action_required: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    completed: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    waiting_others: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+}
+interface IDocumentSearchOptions {
+    rows?: number;
+    page?: number;
+    sort_by?: "updated_at" | "created_at";
+    ascending?: boolean;
+    is_owner?: boolean;
+    is_recipient?: boolean;
+    envelope_status?: TEnvelopeStatus[];
+    recipient_status?: TEnvelopeStatus[];
+}
+interface ICreateEnvelopeRole {
+    /** The type of role to create. Most participants in standard flows will be "signer" recipients. */
+    type: TRecipientType;
+    /**
+     * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
+     * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
+     */
+    name: string;
+    /** The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
+    full_name: string;
+    /** The email address of the recipient. One of `email` or `phone` must be provided. */
+    email?: string;
+    /**
+     * The phone number of the recipient. One of `email` or `phone` must be provided. If `phone` is included, the
+     * recipient will receive an SMS notification for the document.
+     */
+    phone?: string;
+    /**
+     *  The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients
+     *  are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel)
+     *  and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before
+     *  recipients at level "2" may act).
+     */
+    sequence: number;
+    /** Whether the recipient may delegate their tasks to others. Should be false for most standard workflows. */
+    delegator: boolean;
+    /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
+    message: string;
+}
+interface IEnvelopeSummary {
+    id: string;
+    profile_id: string;
+    organization_id: string | null;
+    name: string;
+    status: TEnvelopeStatus;
+    template_id: string;
+    created_at: string;
+    updated_at: string;
+    canceled_at: string;
+    envelope_document_id: string;
+    certificate_document_id: string | null;
+    reminder_id: string | null;
+    no_contact: boolean;
+    visibility: "private" | "shared";
+    documents: IEnvelopeDocument[];
+    recipients: IRecipient[];
+    fields: IEnvelopeField[];
+}
+interface IEnvelopeSummaries {
+    page: number;
+    count: number;
+    total: number;
+    records: IEnvelopeSummary[];
+}
+interface IInPersonLinkResponse {
+    link: string;
+    envelope_id: string;
+    profile_id: string;
+    role_name: string;
+    access_key: string;
+    expiration_date: string;
+    type: TAccessKey;
+}
+interface IUpdateRecipientSubmitParams {
+    action: "submit";
+}
+interface IUpdateRecipientDeclineParams {
+    action: "decline";
+}
+interface IUpdateRecipientClaimEnvelope {
+    action: "owner_update";
+    full_name: string;
+    email: string;
+}
+interface IUpdateRecipientStatus {
+    new_full_name?: string;
+    agreed?: boolean;
+    action?: "prepare" | "update";
+}
+interface IUpdateRecipientAgreedParams {
+    action: "update";
+    agreed: boolean;
+}
+interface IUpdateRecipientNameParams {
+    action: "update";
+    new_full_name: string;
+}
+interface IUpdateRecipientPrepareParams {
+    action: "prepare";
+    recipients: IRecipient[];
+}
+interface ICreateEnvelopeReminderRequest {
+    setup_time: number;
+    interval_time: number;
+}
+interface ICreateEnvelopeRequest {
+    template_id: string;
+    roles: ICreateEnvelopeRole[];
+    name: string;
+    environment?: string;
+    prepared_fields?: {
+        name: string;
+        value: string;
+    }[];
+}
+type TEnvelopePermission = "envelope:create" | "envelope:cancel" | "envelope:view";
 interface ISigningSessionRequest {
     envelopeId: string;
     roleId: string;
@@ -720,6 +859,10 @@ type TSession = IUserSession | ISigningSession | null;
  * An active authenticated session within Verdocs, either for signing or regular user-based operations.
  */
 type TActiveSession = IUserSession | ISigningSession;
+/**
+ * Confirm whether the user has all of the specified permissions.
+ */
+declare const userHasPermissions: (session: TSession, permissions: TPermission[]) => boolean;
 type TEnvironment = "verdocs" | "verdocs-stage";
 type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
 interface VerdocsEndpointOptions {
@@ -917,179 +1060,6 @@ declare class VerdocsEndpoint {
      */
     loadSession(): VerdocsEndpoint;
 }
-/**
- * One entry in an envelope search result.
- * NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
- */
-interface IEnvelopesSearchResultEntry {
-    id: string;
-    canceled_at: string;
-    certificate_document_id: string;
-    created_at: string;
-    histories: IEnvelopeHistory[];
-    indexed_at: string;
-    name: string;
-    no_contact: boolean;
-    organization_id: string;
-    profile_id: string;
-    recipients: IRecipient[];
-    reminder_id: string | null;
-    status: TEnvelopeStatus;
-    /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
-    visibility: "private" | "shared";
-    next_recipient: {
-        claimed: boolean;
-        email: string;
-        name: string;
-        profile_id: string;
-        status: TRecipientStatus;
-        type: TRecipientType;
-    };
-    template_id: string;
-    total_count: number;
-    updated_at: string;
-}
-interface IEnvelopesSearchResult {
-    page: number;
-    total: number;
-    result: IEnvelopesSearchResultEntry[];
-}
-interface IEnvelopesSummary {
-    action_required: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-    completed: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-    waiting_others: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-}
-interface IDocumentSearchOptions {
-    rows?: number;
-    page?: number;
-    sort_by?: "updated_at" | "created_at";
-    ascending?: boolean;
-    is_owner?: boolean;
-    is_recipient?: boolean;
-    envelope_status?: TEnvelopeStatus[];
-    recipient_status?: TEnvelopeStatus[];
-}
-interface ICreateEnvelopeRole {
-    /** The type of role to create. Most participants in standard flows will be "signer" recipients. */
-    type: TRecipientType;
-    /**
-     * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
-     * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
-     */
-    name: string;
-    /** The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
-    full_name: string;
-    /** The email address of the recipient. One of `email` or `phone` must be provided. */
-    email?: string;
-    /**
-     * The phone number of the recipient. One of `email` or `phone` must be provided. If `phone` is included, the
-     * recipient will receive an SMS notification for the document.
-     */
-    phone?: string;
-    /**
-     *  The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients
-     *  are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel)
-     *  and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before
-     *  recipients at level "2" may act).
-     */
-    sequence: number;
-    /** Whether the recipient may delegate their tasks to others. Should be false for most standard workflows. */
-    delegator: boolean;
-    /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
-    message: string;
-}
-interface IEnvelopeSummary {
-    id: string;
-    profile_id: string;
-    organization_id: string | null;
-    name: string;
-    status: TEnvelopeStatus;
-    template_id: string;
-    created_at: string;
-    updated_at: string;
-    canceled_at: string;
-    envelope_document_id: string;
-    certificate_document_id: string | null;
-    reminder_id: string | null;
-    no_contact: boolean;
-    visibility: "private" | "shared";
-    documents: IEnvelopeDocument[];
-    recipients: IRecipient[];
-    fields: IEnvelopeField[];
-}
-interface IEnvelopeSummaries {
-    page: number;
-    count: number;
-    total: number;
-    records: IEnvelopeSummary[];
-}
-interface IInPersonLinkResponse {
-    link: string;
-    envelope_id: string;
-    profile_id: string;
-    role_name: string;
-    access_key: string;
-    expiration_date: string;
-    type: TAccessKey;
-}
-interface IUpdateRecipientSubmitParams {
-    action: "submit";
-}
-interface IUpdateRecipientDeclineParams {
-    action: "decline";
-}
-interface IUpdateRecipientClaimEnvelope {
-    action: "owner_update";
-    full_name: string;
-    email: string;
-}
-interface IUpdateRecipientStatus {
-    new_full_name?: string;
-    agreed?: boolean;
-    action?: "prepare" | "update";
-}
-interface IUpdateRecipientAgreedParams {
-    action: "update";
-    agreed: boolean;
-}
-interface IUpdateRecipientNameParams {
-    action: "update";
-    new_full_name: string;
-}
-interface IUpdateRecipientPrepareParams {
-    action: "prepare";
-    recipients: IRecipient[];
-}
-interface ICreateEnvelopeReminderRequest {
-    setup_time: number;
-    interval_time: number;
-}
-interface ICreateEnvelopeRequest {
-    template_id: string;
-    roles: ICreateEnvelopeRole[];
-    name: string;
-    environment?: string;
-    prepared_fields?: {
-        name: string;
-        value: string;
-    }[];
-}
-/**
- * Confirm whether the user has all of the specified permissions.
- */
-declare const userHasPermissions: (session: TSession, permissions: TPermission[]) => boolean;
 /**
  * Create an envelope
  *
@@ -1459,6 +1429,37 @@ declare const getSignature: (endpoint: VerdocsEndpoint, signatureId: string) =>
  * Delete a user's signature.
  */
 declare const deleteSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
+type TRequestStatus = "OK" | "ERROR";
+type TTemplateSenderType = "creator" | "organization_member" | "organization_member_as_creator" | "everyone" | "everyone_as_creator";
+type TTemplatePermission = "template:creator:create:public" | "template:creator:create:org" | "template:creator:create:personal" | "template:creator:delete" | "template:creator:visibility" | "template:member:read" | "template:member:write" | "template:member:delete" | "template:member:visibility";
+type TTemplateAction = "create_personal" | "create_org" | "create_public" | "read" | "write" | "delete" | "change_visibility_personal" | "change_visibility_org" | "change_visibility_public";
+type TAccountPermission = "owner:add" | "owner:remove" | "admin:add" | "admin:remove" | "member:view" | "member:add" | "member:remove";
+type TOrgPermission = "org:create" | "org:view" | "org:update" | "org:delete" | "org:transfer" | "org:list";
+type TApiKeyPermission = "personal" | "global_read" | "global_write";
+/**
+ * Operation within Verdocs that users may perform.
+ */
+type TPermission = TTemplatePermission | TOrgPermission | TAccountPermission | TEnvelopePermission;
+type TRecipientAction = "submit" | "decline" | "prepare" | "update";
+type TEnvelopeStatus = "complete" | "pending" | "in progress" | "declined" | "canceled";
+type TRecipientStatus = "invited" | "opened" | "signed" | "submitted" | "canceled" | "pending" | "declined";
+type TRecipientType = "signer" | "cc" | "approver";
+/**
+ * Plans provide access to Verdocs product features.
+ */
+type TPlan = "env:essential" | "org:standard";
+/**
+ * Roles provide access to groups of permissions. Note that for historical reasons there is some overlap in the
+ * use of the term "role". TRole refers to a user type. A "Role" (IRole) is a Template participant placeholder.
+ */
+type TRole = "contact" | "basic_user" | "member" | "admin" | "owner";
+type TSortTemplateBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
+type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
+type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
+type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
+// Modification events have a string description
+type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
+type TFieldType = "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
 interface ICreateApiKeyRequest {
     name: string;
     permission: TApiKeyPermission;
@@ -2529,4 +2530,4 @@ interface ISignupSurvey {
 declare const recordSignupSurvey: (endpoint: VerdocsEndpoint, params: ISignupSurvey) => Promise<{
     status: "OK";
 }>;
-export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TPlan, 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, 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, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroupByName, getGroup, getGroupMembers, addGroupMembers, deleteGroupMembers, addGroupPermission, deleteGroupPermission, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, claimNewUser, getOrganizationMembers, deleteOrganizationMember, addOrganizationMemberRole, deleteOrganizationMemberRole, getOrganizationMemberPlans, getOrganizations, createOrganization, deleteOrganization, getOrganization, updateOrganization, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, 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, authenticateUser, authenticateApp, validateToken, refreshTokens, updatePassword, resetPassword, updateEmail, resendVerification, createUser, billingPlaceholder, getNotifications, getProfiles, getCurrentProfile, getRoles, getPermissions, createProfile, getProfile, getProfilePermissions, getProfileGroups, switchProfile, updateProfile, deleteProfile, createBusinessAccount, ISignupSurvey, recordSignupSurvey, ICreateProfileRequest, ISwitchProfileResponse, IUpdateProfileRequest, IAuthenticateUserRequest, IAuthenticateAppRequest, IAuthenticateResponse, TokenValidationRequest, TokenValidationResponse, IUpdatePasswordRequest, UpdatePasswordResponse, UpdateEmailRequest, UpdateEmailResponse, ICreateBusinessAccountRequest, ICreateUserRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TPlan, 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, 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, getGroupByName, getGroup, getGroupMembers, addGroupMembers, deleteGroupMembers, addGroupPermission, deleteGroupPermission, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, claimNewUser, getOrganizationMembers, deleteOrganizationMember, addOrganizationMemberRole, deleteOrganizationMemberRole, getOrganizationMemberPlans, getOrganizations, createOrganization, deleteOrganization, getOrganization, updateOrganization, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, 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, authenticateUser, authenticateApp, validateToken, refreshTokens, updatePassword, resetPassword, updateEmail, resendVerification, createUser, billingPlaceholder, getNotifications, getProfiles, getCurrentProfile, getRoles, getPermissions, createProfile, getProfile, getProfilePermissions, getProfileGroups, switchProfile, updateProfile, deleteProfile, createBusinessAccount, ISignupSurvey, recordSignupSurvey, ICreateProfileRequest, ISwitchProfileResponse, IUpdateProfileRequest, IAuthenticateUserRequest, IAuthenticateAppRequest, IAuthenticateResponse, TokenValidationRequest, TokenValidationResponse, IUpdatePasswordRequest, UpdatePasswordResponse, UpdateEmailRequest, UpdateEmailResponse, ICreateBusinessAccountRequest, ICreateUserRequest, 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

@@ -636,37 +636,176 @@ interface IActivityEntry {
         type: TRecipientType;
     };
 }
-type TRequestStatus = "OK" | "ERROR";
-type TTemplateSenderType = "creator" | "organization_member" | "organization_member_as_creator" | "everyone" | "everyone_as_creator";
-type TTemplatePermission = "template:creator:create:public" | "template:creator:create:org" | "template:creator:create:personal" | "template:creator:delete" | "template:creator:visibility" | "template:member:read" | "template:member:write" | "template:member:delete" | "template:member:visibility";
-type TTemplateAction = "create_personal" | "create_org" | "create_public" | "read" | "write" | "delete" | "change_visibility_personal" | "change_visibility_org" | "change_visibility_public";
-type TAccountPermission = "owner:add" | "owner:remove" | "admin:add" | "admin:remove" | "member:view" | "member:add" | "member:remove";
-type TOrgPermission = "org:create" | "org:view" | "org:update" | "org:delete" | "org:transfer" | "org:list";
-type TApiKeyPermission = "personal" | "global_read" | "global_write";
-/**
- * Operation within Verdocs that users may perform.
- */
-type TPermission = TTemplatePermission | TOrgPermission | TAccountPermission;
-type TRecipientAction = "submit" | "decline" | "prepare" | "update";
-type TEnvelopeStatus = "complete" | "pending" | "in progress" | "declined" | "canceled";
-type TRecipientStatus = "invited" | "opened" | "signed" | "submitted" | "canceled" | "pending" | "declined";
-type TRecipientType = "signer" | "cc" | "approver";
 /**
- * Plans provide access to Verdocs product features.
- */
-type TPlan = "env:essential" | "org:standard";
-/**
- * Roles provide access to groups of permissions. Note that for historical reasons there is some overlap in the
- * use of the term "role". TRole refers to a user type. A "Role" (IRole) is a Template participant placeholder.
+ * One entry in an envelope search result.
+ * NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
  */
-type TRole = "contact" | "basic_user" | "member" | "admin" | "owner";
-type TSortTemplateBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
-type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
-type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
-type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
-// Modification events have a string description
-type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
-type TFieldType = "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
+interface IEnvelopesSearchResultEntry {
+    id: string;
+    canceled_at: string;
+    certificate_document_id: string;
+    created_at: string;
+    histories: IEnvelopeHistory[];
+    indexed_at: string;
+    name: string;
+    no_contact: boolean;
+    organization_id: string;
+    profile_id: string;
+    recipients: IRecipient[];
+    reminder_id: string | null;
+    status: TEnvelopeStatus;
+    /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
+    visibility: "private" | "shared";
+    next_recipient: {
+        claimed: boolean;
+        email: string;
+        name: string;
+        profile_id: string;
+        status: TRecipientStatus;
+        type: TRecipientType;
+    };
+    template_id: string;
+    total_count: number;
+    updated_at: string;
+}
+interface IEnvelopesSearchResult {
+    page: number;
+    total: number;
+    result: IEnvelopesSearchResultEntry[];
+}
+interface IEnvelopesSummary {
+    action_required: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    completed: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+    waiting_others: {
+        page: number;
+        total: number;
+        result: IActivityEntry[];
+    };
+}
+interface IDocumentSearchOptions {
+    rows?: number;
+    page?: number;
+    sort_by?: "updated_at" | "created_at";
+    ascending?: boolean;
+    is_owner?: boolean;
+    is_recipient?: boolean;
+    envelope_status?: TEnvelopeStatus[];
+    recipient_status?: TEnvelopeStatus[];
+}
+interface ICreateEnvelopeRole {
+    /** The type of role to create. Most participants in standard flows will be "signer" recipients. */
+    type: TRecipientType;
+    /**
+     * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
+     * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
+     */
+    name: string;
+    /** The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
+    full_name: string;
+    /** The email address of the recipient. One of `email` or `phone` must be provided. */
+    email?: string;
+    /**
+     * The phone number of the recipient. One of `email` or `phone` must be provided. If `phone` is included, the
+     * recipient will receive an SMS notification for the document.
+     */
+    phone?: string;
+    /**
+     *  The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients
+     *  are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel)
+     *  and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before
+     *  recipients at level "2" may act).
+     */
+    sequence: number;
+    /** Whether the recipient may delegate their tasks to others. Should be false for most standard workflows. */
+    delegator: boolean;
+    /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
+    message: string;
+}
+interface IEnvelopeSummary {
+    id: string;
+    profile_id: string;
+    organization_id: string | null;
+    name: string;
+    status: TEnvelopeStatus;
+    template_id: string;
+    created_at: string;
+    updated_at: string;
+    canceled_at: string;
+    envelope_document_id: string;
+    certificate_document_id: string | null;
+    reminder_id: string | null;
+    no_contact: boolean;
+    visibility: "private" | "shared";
+    documents: IEnvelopeDocument[];
+    recipients: IRecipient[];
+    fields: IEnvelopeField[];
+}
+interface IEnvelopeSummaries {
+    page: number;
+    count: number;
+    total: number;
+    records: IEnvelopeSummary[];
+}
+interface IInPersonLinkResponse {
+    link: string;
+    envelope_id: string;
+    profile_id: string;
+    role_name: string;
+    access_key: string;
+    expiration_date: string;
+    type: TAccessKey;
+}
+interface IUpdateRecipientSubmitParams {
+    action: "submit";
+}
+interface IUpdateRecipientDeclineParams {
+    action: "decline";
+}
+interface IUpdateRecipientClaimEnvelope {
+    action: "owner_update";
+    full_name: string;
+    email: string;
+}
+interface IUpdateRecipientStatus {
+    new_full_name?: string;
+    agreed?: boolean;
+    action?: "prepare" | "update";
+}
+interface IUpdateRecipientAgreedParams {
+    action: "update";
+    agreed: boolean;
+}
+interface IUpdateRecipientNameParams {
+    action: "update";
+    new_full_name: string;
+}
+interface IUpdateRecipientPrepareParams {
+    action: "prepare";
+    recipients: IRecipient[];
+}
+interface ICreateEnvelopeReminderRequest {
+    setup_time: number;
+    interval_time: number;
+}
+interface ICreateEnvelopeRequest {
+    template_id: string;
+    roles: ICreateEnvelopeRole[];
+    name: string;
+    environment?: string;
+    prepared_fields?: {
+        name: string;
+        value: string;
+    }[];
+}
+type TEnvelopePermission = "envelope:create" | "envelope:cancel" | "envelope:view";
 interface ISigningSessionRequest {
     envelopeId: string;
     roleId: string;
@@ -720,6 +859,10 @@ type TSession = IUserSession | ISigningSession | null;
  * An active authenticated session within Verdocs, either for signing or regular user-based operations.
  */
 type TActiveSession = IUserSession | ISigningSession;
+/**
+ * Confirm whether the user has all of the specified permissions.
+ */
+declare const userHasPermissions: (session: TSession, permissions: TPermission[]) => boolean;
 type TEnvironment = "verdocs" | "verdocs-stage";
 type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
 interface VerdocsEndpointOptions {
@@ -917,179 +1060,6 @@ declare class VerdocsEndpoint {
      */
     loadSession(): VerdocsEndpoint;
 }
-/**
- * One entry in an envelope search result.
- * NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
- */
-interface IEnvelopesSearchResultEntry {
-    id: string;
-    canceled_at: string;
-    certificate_document_id: string;
-    created_at: string;
-    histories: IEnvelopeHistory[];
-    indexed_at: string;
-    name: string;
-    no_contact: boolean;
-    organization_id: string;
-    profile_id: string;
-    recipients: IRecipient[];
-    reminder_id: string | null;
-    status: TEnvelopeStatus;
-    /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
-    visibility: "private" | "shared";
-    next_recipient: {
-        claimed: boolean;
-        email: string;
-        name: string;
-        profile_id: string;
-        status: TRecipientStatus;
-        type: TRecipientType;
-    };
-    template_id: string;
-    total_count: number;
-    updated_at: string;
-}
-interface IEnvelopesSearchResult {
-    page: number;
-    total: number;
-    result: IEnvelopesSearchResultEntry[];
-}
-interface IEnvelopesSummary {
-    action_required: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-    completed: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-    waiting_others: {
-        page: number;
-        total: number;
-        result: IActivityEntry[];
-    };
-}
-interface IDocumentSearchOptions {
-    rows?: number;
-    page?: number;
-    sort_by?: "updated_at" | "created_at";
-    ascending?: boolean;
-    is_owner?: boolean;
-    is_recipient?: boolean;
-    envelope_status?: TEnvelopeStatus[];
-    recipient_status?: TEnvelopeStatus[];
-}
-interface ICreateEnvelopeRole {
-    /** The type of role to create. Most participants in standard flows will be "signer" recipients. */
-    type: TRecipientType;
-    /**
-     * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
-     * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
-     */
-    name: string;
-    /** The full name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
-    full_name: string;
-    /** The email address of the recipient. One of `email` or `phone` must be provided. */
-    email?: string;
-    /**
-     * The phone number of the recipient. One of `email` or `phone` must be provided. If `phone` is included, the
-     * recipient will receive an SMS notification for the document.
-     */
-    phone?: string;
-    /**
-     *  The 1-based sequence number for the recipient. This can be used to override the template's workflow. Recipients
-     *  are processed in parallel for each matching sequence number (e.g. all recipients at level "1" may act in parallel)
-     *  and in series between sequence numbers (e.g. all recipients at level "1" must complete their tasks before
-     *  recipients at level "2" may act).
-     */
-    sequence: number;
-    /** Whether the recipient may delegate their tasks to others. Should be false for most standard workflows. */
-    delegator: boolean;
-    /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
-    message: string;
-}
-interface IEnvelopeSummary {
-    id: string;
-    profile_id: string;
-    organization_id: string | null;
-    name: string;
-    status: TEnvelopeStatus;
-    template_id: string;
-    created_at: string;
-    updated_at: string;
-    canceled_at: string;
-    envelope_document_id: string;
-    certificate_document_id: string | null;
-    reminder_id: string | null;
-    no_contact: boolean;
-    visibility: "private" | "shared";
-    documents: IEnvelopeDocument[];
-    recipients: IRecipient[];
-    fields: IEnvelopeField[];
-}
-interface IEnvelopeSummaries {
-    page: number;
-    count: number;
-    total: number;
-    records: IEnvelopeSummary[];
-}
-interface IInPersonLinkResponse {
-    link: string;
-    envelope_id: string;
-    profile_id: string;
-    role_name: string;
-    access_key: string;
-    expiration_date: string;
-    type: TAccessKey;
-}
-interface IUpdateRecipientSubmitParams {
-    action: "submit";
-}
-interface IUpdateRecipientDeclineParams {
-    action: "decline";
-}
-interface IUpdateRecipientClaimEnvelope {
-    action: "owner_update";
-    full_name: string;
-    email: string;
-}
-interface IUpdateRecipientStatus {
-    new_full_name?: string;
-    agreed?: boolean;
-    action?: "prepare" | "update";
-}
-interface IUpdateRecipientAgreedParams {
-    action: "update";
-    agreed: boolean;
-}
-interface IUpdateRecipientNameParams {
-    action: "update";
-    new_full_name: string;
-}
-interface IUpdateRecipientPrepareParams {
-    action: "prepare";
-    recipients: IRecipient[];
-}
-interface ICreateEnvelopeReminderRequest {
-    setup_time: number;
-    interval_time: number;
-}
-interface ICreateEnvelopeRequest {
-    template_id: string;
-    roles: ICreateEnvelopeRole[];
-    name: string;
-    environment?: string;
-    prepared_fields?: {
-        name: string;
-        value: string;
-    }[];
-}
-/**
- * Confirm whether the user has all of the specified permissions.
- */
-declare const userHasPermissions: (session: TSession, permissions: TPermission[]) => boolean;
 /**
  * Create an envelope
  *
@@ -1459,6 +1429,37 @@ declare const getSignature: (endpoint: VerdocsEndpoint, signatureId: string) =>
  * Delete a user's signature.
  */
 declare const deleteSignature: (endpoint: VerdocsEndpoint, signatureId: string) => Promise<any>;
+type TRequestStatus = "OK" | "ERROR";
+type TTemplateSenderType = "creator" | "organization_member" | "organization_member_as_creator" | "everyone" | "everyone_as_creator";
+type TTemplatePermission = "template:creator:create:public" | "template:creator:create:org" | "template:creator:create:personal" | "template:creator:delete" | "template:creator:visibility" | "template:member:read" | "template:member:write" | "template:member:delete" | "template:member:visibility";
+type TTemplateAction = "create_personal" | "create_org" | "create_public" | "read" | "write" | "delete" | "change_visibility_personal" | "change_visibility_org" | "change_visibility_public";
+type TAccountPermission = "owner:add" | "owner:remove" | "admin:add" | "admin:remove" | "member:view" | "member:add" | "member:remove";
+type TOrgPermission = "org:create" | "org:view" | "org:update" | "org:delete" | "org:transfer" | "org:list";
+type TApiKeyPermission = "personal" | "global_read" | "global_write";
+/**
+ * Operation within Verdocs that users may perform.
+ */
+type TPermission = TTemplatePermission | TOrgPermission | TAccountPermission | TEnvelopePermission;
+type TRecipientAction = "submit" | "decline" | "prepare" | "update";
+type TEnvelopeStatus = "complete" | "pending" | "in progress" | "declined" | "canceled";
+type TRecipientStatus = "invited" | "opened" | "signed" | "submitted" | "canceled" | "pending" | "declined";
+type TRecipientType = "signer" | "cc" | "approver";
+/**
+ * Plans provide access to Verdocs product features.
+ */
+type TPlan = "env:essential" | "org:standard";
+/**
+ * Roles provide access to groups of permissions. Note that for historical reasons there is some overlap in the
+ * use of the term "role". TRole refers to a user type. A "Role" (IRole) is a Template participant placeholder.
+ */
+type TRole = "contact" | "basic_user" | "member" | "admin" | "owner";
+type TSortTemplateBy = "created_at" | "updated_at" | "name" | "last_used_at" | "counter" | "star_counter";
+type TAccessKeyType = "email" | "in_app" | "in_person_link" | "sms";
+type THistoryEvent = "recipient:signed" | "recipient:opened" | "recipient:submitted" | "recipient:prepared" | "recipient:claimed" | "recipient:agreed" | "recipient:invited" | "recipient:delegated" | "recipient:updated_info" | "recipient:declined" | "invitation:resent" | "envelope:cc" | "created" | "completed" | "canceled" | "owner:updated_recipient_info" | "owner:canceled" | "owner:get_in_person_link";
+type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "preparer" | "manual" | "in_person_link" | "guest" | "email" | "" | string; // Modification events have a string description
+// Modification events have a string description
+type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
+type TFieldType = "signature" | "initial" | "checkbox_group" | "radio_button_group" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
 interface ICreateApiKeyRequest {
     name: string;
     permission: TApiKeyPermission;
@@ -2529,4 +2530,4 @@ interface ISignupSurvey {
 declare const recordSignupSurvey: (endpoint: VerdocsEndpoint, params: ISignupSurvey) => Promise<{
     status: "OK";
 }>;
-export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TPlan, 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, 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, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroupByName, getGroup, getGroupMembers, addGroupMembers, deleteGroupMembers, addGroupPermission, deleteGroupPermission, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, claimNewUser, getOrganizationMembers, deleteOrganizationMember, addOrganizationMemberRole, deleteOrganizationMemberRole, getOrganizationMemberPlans, getOrganizations, createOrganization, deleteOrganization, getOrganization, updateOrganization, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, 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, authenticateUser, authenticateApp, validateToken, refreshTokens, updatePassword, resetPassword, updateEmail, resendVerification, createUser, billingPlaceholder, getNotifications, getProfiles, getCurrentProfile, getRoles, getPermissions, createProfile, getProfile, getProfilePermissions, getProfileGroups, switchProfile, updateProfile, deleteProfile, createBusinessAccount, ISignupSurvey, recordSignupSurvey, ICreateProfileRequest, ISwitchProfileResponse, IUpdateProfileRequest, IAuthenticateUserRequest, IAuthenticateAppRequest, IAuthenticateResponse, TokenValidationRequest, TokenValidationResponse, IUpdatePasswordRequest, UpdatePasswordResponse, UpdateEmailRequest, UpdateEmailResponse, ICreateBusinessAccountRequest, ICreateUserRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TPlan, 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, 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, getGroupByName, getGroup, getGroupMembers, addGroupMembers, deleteGroupMembers, addGroupPermission, deleteGroupPermission, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, claimNewUser, getOrganizationMembers, deleteOrganizationMember, addOrganizationMemberRole, deleteOrganizationMemberRole, getOrganizationMemberPlans, getOrganizations, createOrganization, deleteOrganization, getOrganization, updateOrganization, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, 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, authenticateUser, authenticateApp, validateToken, refreshTokens, updatePassword, resetPassword, updateEmail, resendVerification, createUser, billingPlaceholder, getNotifications, getProfiles, getCurrentProfile, getRoles, getPermissions, createProfile, getProfile, getProfilePermissions, getProfileGroups, switchProfile, updateProfile, deleteProfile, createBusinessAccount, ISignupSurvey, recordSignupSurvey, ICreateProfileRequest, ISwitchProfileResponse, IUpdateProfileRequest, IAuthenticateUserRequest, IAuthenticateAppRequest, IAuthenticateResponse, TokenValidationRequest, TokenValidationResponse, IUpdatePasswordRequest, UpdatePasswordResponse, UpdateEmailRequest, UpdateEmailResponse, ICreateBusinessAccountRequest, ICreateUserRequest, 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS SDK providing types and API wrappers for the Verdocs platform for Node and Browser clients",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS SDK providing types and API wrappers for the Verdocs platform for Node and Browser clients",