@verdocs/js-sdk 4.2.0 → 4.2.2

package/dist/index.d.ts

@@ -1,8 +1,131 @@
 import { AxiosInstance } from "axios";
-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 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 TEnvelopePermission = "envelope:create" | "envelope:cancel" | "envelope:view";
+/**
+ * Create public templates. Public templates are still owned and managed by the creator,
+ * but may be searched for and used to create envelopes by other users.
+ */
+type TTemplatePermissionCreatePublic = "template:creator:create:public";
+/**
+ * Create templates shared with other users of the same organization.
+ */
+type TTemplatePermissionCreateOrg = "template:creator:create:org";
+/**
+ * Create templates private to the creator.
+ */
+type TTemplatePermissionCreatePersonal = "template:creator:create:personal";
+/**
+ * Create templates private to the creator.
+ */
+type TTemplatePermissionDelete = "template:creator:delete";
+/**
+ * Alter the visiiblity settings on a template.
+ */
+type TTemplatePermissionVisibility = "template:creator:visibility";
+/**
+ * View templates shared by other members of the same organization. Those templates must also
+ * have `is_personal` set to false to be visible.
+ */
+type TTemplateMemberRead = "template:member:read";
+/**
+ * Edit templates shared by other members of the same organization. Those templates must also
+ * have `is_personal` set to false to be editable.
+ */
+type TTemplateMemberWrite = "template:member:write";
+/**
+ * Edit templates shared by other members of the same organization. Those templates must also
+ * have `is_personal` set to false to be editable.
+ */
+type TTemplateMemberDelete = "template:member:delete";
+/**
+ * Edit templates shared by other members of the same organization. Those templates must also
+ * have `is_personal` set to false to be editable.
+ */
+type TTemplateMemberVisibility = "template:member:visibility";
+type TTemplatePermission = TTemplatePermissionCreatePublic | TTemplatePermissionCreateOrg | TTemplatePermissionCreatePersonal | TTemplatePermissionDelete | TTemplatePermissionVisibility | TTemplateMemberRead | TTemplateMemberWrite | TTemplateMemberDelete | TTemplateMemberVisibility;
+/**
+ * Grant the "owner" role to other organization members.
+ */
+type TAccountPermissionOwnerAdd = "owner:add";
+/**
+ * Remove the "owner" role from other organization members.
+ */
+type TAccountPermissionOwnerRemove = "owner:remove";
+/**
+ * Grant the "admin" role to other organization members.
+ */
+type TAccountPermissionAdminAdd = "admin:add";
+/**
+ * Remove the "admin" role from other organization members.
+ */
+type TAccountPermissionAdminRemove = "admin:remove";
+/**
+ * View the members of an organization.
+ */
+type TAccountPermissionMemberView = "member:view";
+/**
+ * Grant the "member" role to other organization members.
+ */
+type TAccountPermissionMemberAdd = "member:add";
+/**
+ * Remove the "member" role from other organization members.
+ */
+type TAccountPermissionMemberRemove = "member:remove";
+type TAccountPermission = TAccountPermissionOwnerAdd | TAccountPermissionOwnerRemove | TAccountPermissionAdminAdd | TAccountPermissionAdminRemove | TAccountPermissionMemberAdd | TAccountPermissionMemberRemove | TAccountPermissionMemberView;
+/**
+ * Create a new organization.
+ * @deprecated This is a system-wide setting and organization owners cannot prevent their
+ * members from listing other organizations that they may have separate profiles in.
+ */
+type TOrgPermissionCreate = "org:create";
+/**
+ * View the organization.
+ */
+type TOrgPermissionView = "org:view";
+/**
+ * Update the organization.
+ */
+type TOrgPermissionUpdate = "org:update";
+/**
+ * Delete the organization.
+ */
+type TOrgPermissionDelete = "org:delete";
+/**
+ * Transfer ownership of the organization. This primarily allows the holder to remove his/her own
+ * Owner role or add new Owners even if the holder is not one themselves. This is primarily intended
+ * to be used for reseller scenarios.
+ */
+type TOrgPermissionTransfer = "org:transfer";
+/**
+ * List organizations.
+ * @deprecated This is a system-wide setting and organization owners cannot prevent their
+ * members from listing other organizations that they may have separate profiles in.
+ */
+type TOrgPermissionList = "org:list";
+type TOrgPermission = TOrgPermissionCreate | TOrgPermissionView | TOrgPermissionUpdate | TOrgPermissionDelete | TOrgPermissionTransfer | TOrgPermissionList;
+/**
+ * Create envelopes.
+ */
+type TEnvelopePermissionCreate = "envelope:create";
+/**
+ * Cancel envelopes. This is a default permission for most users, but it may be removed for
+ * highly regulated environments where envelope activities must be audited, and should not
+ * be canceled.
+ */
+type TEnvelopePermissionCancel = "envelope:cancel";
+/**
+ * View envelopes. This is a default permission for most users, but it may be removed for
+ * highly regulated environments where once sent, envelopes may only be viewed by specific
+ * users.
+ */
+type TEnvelopePermissionView = "envelope:view";
+/**
+ * View envelopes created by other members of the same organization. By default, only templates
+ * having sharing settings controlled by their creators. Envelopes are usually private to the
+ * callers who created them. In some organizations it may be useful to have users who can see
+ * "all activity" by all organization members. This is particularly useful when applied to API
+ * keys to develop applications that can access all data across the organization.
+ */
+type TEnvelopePermissionOrg = "envelope:org:view";
+type TEnvelopePermission = TEnvelopePermissionCreate | TEnvelopePermissionCancel | TEnvelopePermissionView | TEnvelopePermissionOrg;
 /**
  * Operation within Verdocs that users may perform.
  */
@@ -733,24 +856,6 @@ interface ITemplateFieldSetting {
     options?: any[];
     [key: string]: any;
 }
-interface IActivityEntry {
-    id: string;
-    name: string;
-    canceled_at: string;
-    created_at: string;
-    updated_at: string;
-    profile_id: string;
-    status: TEnvelopeStatus;
-    template_id: string;
-    recipient: {
-        claimed: boolean;
-        email: string;
-        name: string;
-        profile_id: string;
-        status: TRecipientStatus;
-        type: TRecipientType;
-    };
-}
 type TRequestStatus = "OK" | "ERROR";
 type TTemplateSenderType = "creator" | "organization_member" | "organization_member_as_creator" | "everyone" | "everyone_as_creator";
 type TTemplateAction = "create_personal" | "create_org" | "create_public" | "read" | "write" | "delete" | "change_visibility_personal" | "change_visibility_org" | "change_visibility_public";
@@ -992,58 +1097,26 @@ 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[];
+    result: IEnvelope[];
 }
 interface IEnvelopesSummary {
     action_required: {
         page: number;
         total: number;
-        result: IActivityEntry[];
+        result: IEnvelope[];
     };
     completed: {
         page: number;
         total: number;
-        result: IActivityEntry[];
+        result: IEnvelope[];
     };
     waiting_others: {
         page: number;
         total: number;
-        result: IActivityEntry[];
+        result: IEnvelope[];
     };
 }
 interface IDocumentSearchOptions {
@@ -1085,30 +1158,11 @@ interface ICreateEnvelopeRole {
     /** 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[];
+    records: IEnvelope[];
 }
 interface IInPersonLinkResponse {
     link: string;
@@ -1198,77 +1252,12 @@ declare const createEnvelope: (endpoint: VerdocsEndpoint, request: ICreateEnvelo
  * Get a summary of currently active envelopes.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ * import {getEnvelopesSummary} from '@verdocs/js-sdk/Envelopes';
  *
- * const {action_required, completed, waiting_on_others} = await Envelopes.getSummary(VerdocsEndpoint.getDefault());
+ * const {action_required, completed, waiting_on_others} = await getEnvelopesSummary(VerdocsEndpoint.getDefault());
  * ```
  */
 declare const getEnvelopesSummary: (endpoint: VerdocsEndpoint, page: number) => Promise<IEnvelopesSummary>;
-interface IEnvelopeSearchParams {
-    /** The envelope must have been created via the specified template ID. */
-    template_id?: string;
-    /** The envelope must match one of the specified statuses. */
-    envelope_status?: TEnvelopeStatus[];
-    /** At least one of the recipients must match one of the specified statuses. */
-    recipient_status?: TRecipientStatus[];
-    /** The envelope's name (inherited from the template) must match the specified string. */
-    envelope_name?: string;
-    /** At least one of the envelope's recipients must match the specified name. */
-    recipient_name?: string;
-    /** At least one of the envelope's recipients must match the specified email address. */
-    recipient_email?: string;
-    /** Match against envelope_name, recipient_name, or recipient_email all at once. */
-    name?: string;
-    /** At least one of the envelope's recipients must match the specified ID. */
-    recipient_id?: string;
-    /** The date-range in which the envelope was created. Values should be specified in ISO8601 "UTC" format. */
-    created_at?: {
-        start_time: string;
-        end_time: string;
-    };
-    /**
-     * The date-range in which the envelope was last updated. Values should be specified in ISO8601 "UTC" format.
-     * Note that any operations that alter the envelope are considered "updates", including status changes (cancellation),
-     * recipient actions (opening/signing), etc.
-     */
-    updated_at?: {
-        start_time: string;
-        end_time: string;
-    };
-    /** The date-range in which the envelope was canceled. Values should be specified in ISO8601 "UTC" format. */
-    canceled_at?: {
-        start_time: string;
-        end_time: string;
-    };
-    /** Perform a "contains" search where any of the attached documents' fields contains the specified value. */
-    text_field_value?: string;
-    /** Set to true to retrieve only summary records (IEnvelopeSummary). */
-    summary?: boolean;
-    /** Set to true to retrieve only those envelopes owned by the caller. */
-    is_owner?: boolean;
-    /** Set to true to retrieve only those envelopes in which the caller is one of the recipients. */
-    is_recipient?: boolean;
-    /** Whether the recipient has "claimed" the envelope. */
-    recipient_claimed?: boolean;
-    /** The maximum number of records to return. Should be used in place of `row`. */
-    limit?: number;
-    /** The page number to return. Page numbers are 0-based. */
-    page?: number;
-    /** The field to sort the results by. */
-    sort_by?: "created_at" | "updated_at" | "envelope_name" | "canceled_at" | "envelope_status";
-    /** Whether to sort in ascending (default) or descending order. */
-    ascending?: boolean;
-}
-/**
- * Search for envelopes matching various criteria.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-declare const searchEnvelopes: (endpoint: VerdocsEndpoint, params: IEnvelopeSearchParams) => Promise<IEnvelopesSearchResult>;
 interface ISigningSessionResult {
     recipient: IRecipient;
     session: ISigningSession;
@@ -1342,63 +1331,38 @@ declare const getFieldAttachment: (endpoint: VerdocsEndpoint, envelopeId: string
  * for DISPLAY ONLY, are not legally binding documents, and do not contain any encoded metadata from participants.
  */
 declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string, page: number, type?: "original" | "filled" | "certificate") => Promise<string>;
-/**
- * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-declare const throttledGetEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => IEnvelope | Promise<IEnvelope>;
 interface ITimeRange {
     start: string;
     end: string;
 }
-// /**
-//  * Lists all templates accessible by the caller, with optional filters.
-//  *
-//  * ```typescript
-//  * import {Envelopes} from '@verdocs/js-sdk/Templates';
-//  *
-//  * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { name: 'test', sort: 'updated_at' });
-//  * ```
-//  */
-// export const listEnvelopes = (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) =>
-//   endpoint.api //
-//     .post<IEnvelopeSummaries>('/envelopes/list', params, {baseURL: endpoint.getBaseURLv2()})
-//     .then((r) => r.data);
 interface IListEnvelopesParams {
-    view?: "inbox" | "sent" | "action" | "waiting" | "completed";
     q?: string;
-    status?: string[];
-    created_at?: ITimeRange;
-    is_owner?: boolean;
-    sort_by?: "name" | "created_at" | "updated_at" | "canceled_at" | "status";
+    view?: "inbox" | "sent" | "action" | "waiting" | "completed";
+    status?: ("complete" | "pending" | "in progress" | "declined" | "canceled")[];
+    include_org?: boolean;
     template_id?: string;
+    created_before?: string;
+    created_after?: string;
+    sort_by?: "name" | "created_at" | "updated_at" | "canceled_at" | "status";
     ascending?: boolean;
     rows?: number;
     page?: number;
 }
-/**a
+/**
  * Lists all envelopes accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ * import {getEnvelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
+ * const {count, envelopes} = await getEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test' });
  * ```
  */
-declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<{
-    total: number;
+declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<{
+    count: number;
     rows: number;
     page: number;
     envelopes: IEnvelope[];
 }>;
-/**
- * Get all of the envelopes that were sent using a given template.
- * NOTE: This endpoint will be retired soon. Its response is not paginated and it is typically used only to retrieve
- * "submitted data" for a template. A new endpoint will be introduced to provide this function more directly.
- * @deprecated
- */
-declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IEnvelope[]>;
 /**
  * Create an initials block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
  * an initials block to be used for all initials fields in the document. Thus, this is typically called one time to
@@ -1459,8 +1423,11 @@ interface IRecipientKbaChallengeRequired {
     kba_required: true;
     kba_completed: false;
     kba_method: "challenge";
-    message: string;
-    options: string[];
+    challenges: {
+        type: string;
+        message: string;
+        options: string[];
+    }[];
 }
 /**
  * Identity verification has failed. The user should be shown the message included. No further
@@ -1472,7 +1439,7 @@ interface IRecipientKbaStatusFailed {
     kba_required: true;
     kba_completed: false;
     kba_method: "failed";
-    meesage: string;
+    message: string;
 }
 type TRecipientKbaStatus = IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed;
 /**
@@ -1575,27 +1542,27 @@ declare const deleteEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: st
 /**
  * Check to see if the user owns the envelope.
  */
-declare const userIsEnvelopeOwner: (profile: IProfile | null | undefined, envelope: IEnvelope | IEnvelopeSummary) => boolean;
+declare const userIsEnvelopeOwner: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean;
 /**
  * Check to see if the user owns the envelope.
  */
-declare const userIsEnvelopeRecipient: (profile: IProfile | null | undefined, envelope: IEnvelope | IEnvelopeSummary) => boolean;
+declare const userIsEnvelopeRecipient: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean;
 /**
  * Check to see if the envelope has pending actions.
  */
-declare const envelopeIsActive: (envelope: IEnvelope | IEnvelopeSummary) => boolean;
+declare const envelopeIsActive: (envelope: IEnvelope) => boolean;
 /**
  * Check to see if the envelope has been completed.
  */
-declare const envelopeIsComplete: (envelope: IEnvelope | IEnvelopeSummary) => boolean;
+declare const envelopeIsComplete: (envelope: IEnvelope) => boolean;
 /**
  * Check to see if the user owns the envelope.
  */
-declare const userCanCancelEnvelope: (profile: IProfile | null | undefined, envelope: IEnvelope | IEnvelopeSummary) => boolean;
+declare const userCanCancelEnvelope: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean;
 /**
  * Check to see if the user owns the envelope.
  */
-declare const userCanFinishEnvelope: (profile: IProfile | null | undefined, envelope: IEnvelope | IEnvelopeSummary) => boolean;
+declare const userCanFinishEnvelope: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean;
 /**
  * Returns true if the recipient has a pending action. Note that this does not necessarily mean the recipient can act (yet).
  */
@@ -1603,7 +1570,7 @@ declare const recipientHasAction: (recipient: IRecipient) => boolean;
 /**
  * Returns the recipients who still have a pending action. Note that not all of these recipients may be able to act (yet).
  */
-declare const getRecipientsWithActions: (envelope: IEnvelope | IEnvelopeSummary) => IRecipient[];
+declare const getRecipientsWithActions: (envelope: IEnvelope) => IRecipient[];
 /**
  * Returns true if the recipient can act.
  */
@@ -1615,8 +1582,8 @@ declare const userCanAct: (email: string, recipientsWithActions: IRecipient[]) =
 /**
  * Returns true if the user can act.
  */
-declare const userCanSignNow: (profile: IProfile | null | undefined, envelope: IEnvelope | IEnvelopeSummary) => boolean | undefined;
-declare const getNextRecipient: (envelope: IEnvelope | IEnvelopeSummary) => IRecipient;
+declare const userCanSignNow: (profile: IProfile | null | undefined, envelope: IEnvelope) => boolean | undefined;
+declare const getNextRecipient: (envelope: IEnvelope) => IRecipient;
 /**
  * Create a signature block. In a typical signing workflow, the user is asked at the beginning of the process to "adopt"
  * a signature block to be used for all signature fields in the document. Thus, this is typically called one time to
@@ -2798,4 +2765,4 @@ declare const isValidEmail: (email: string | undefined) => boolean;
 declare const isValidPhone: (phone: string | undefined) => boolean;
 declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
 declare const isValidTag: (value: string, tags: string[]) => boolean;
-export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, IRecipientKbaStatusNotRequired, IRecipientKbaStatusComplete, IRecipientKbaStatusPinRequired, IRecipientKbaStatusIdentityRequired, IRecipientKbaChallengeRequired, IRecipientKbaStatusFailed, TRecipientKbaStatus, getKbaStatus, submitKbaPin, IKbaIdentity, submitKbaIdentity, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermission, TAccountPermission, TOrgPermission, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStatusNotRequired, IRecipientKbaStatusComplete, IRecipientKbaStatusPinRequired, IRecipientKbaStatusIdentityRequired, IRecipientKbaChallengeRequired, IRecipientKbaStatusFailed, TRecipientKbaStatus, getKbaStatus, submitKbaPin, IKbaIdentity, submitKbaIdentity, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };

package/dist/index.js

@@ -1414,26 +1414,14 @@ const createEnvelope = async (endpoint, request) => endpoint.api //
  * Get a summary of currently active envelopes.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ * import {getEnvelopesSummary} from '@verdocs/js-sdk/Envelopes';
  *
- * const {action_required, completed, waiting_on_others} = await Envelopes.getSummary(VerdocsEndpoint.getDefault());
+ * const {action_required, completed, waiting_on_others} = await getEnvelopesSummary(VerdocsEndpoint.getDefault());
  * ```
  */
 const getEnvelopesSummary = async (endpoint, page) => endpoint.api //
     .post('/envelopes/summary', { page })
     .then((r) => r.data);
-/**
- * Search for envelopes matching various criteria.
- *
- * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
- *
- * const {result, page, total} = await Envelopes.search(VerdocsEndpoint.getDefault(), { ... });
- * ```
- */
-const searchEnvelopes = async (endpoint, params) => endpoint.api //
-    .post('/envelopes/search', params)
-    .then((r) => r.data);
 /**
  * Get a signing session for an Envelope.
  */
@@ -1575,41 +1563,17 @@ const getFieldAttachment = async (endpoint, envelopeId, fieldName) => endpoint.a
 const getEnvelopeDocumentPageDisplayUri = async (endpoint, envelopeId, documentId, page, type = 'original') => endpoint.api
     .get(`/envelopes/${envelopeId}/envelope_documents/${documentId}/pages/${page}/image?type=${type}`, { timeout: 20000 })
     .then((r) => r.data);
-const cachedEnvelopes = {};
 /**
- * Wrapper for `getEnvelope()` that limits queries to one every 2 seconds per template ID.
- * This is intended for use in component hierarchies that all rely on the same template
- * to avoid unnecessary repeat server calls.
- */
-const throttledGetEnvelope = (endpoint, envelopeId) => {
-    if (cachedEnvelopes[envelopeId] && cachedEnvelopes[envelopeId].loaded + 2000 < new Date().getTime()) {
-        return cachedEnvelopes[envelopeId].envelope;
-    }
-    return getEnvelope(endpoint, envelopeId).then((envelope) => {
-        cachedEnvelopes[envelopeId] = { loaded: new Date().getTime(), envelope };
-        return envelope;
-    });
-};
-/**a
  * Lists all envelopes accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
+ * import {getEnvelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
+ * const {count, envelopes} = await getEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test' });
  * ```
  */
-const listEnvelopes = (endpoint, params) => endpoint.api //
-    .post('/envelopes/list', params)
-    .then((r) => r.data);
-/**
- * Get all of the envelopes that were sent using a given template.
- * NOTE: This endpoint will be retired soon. Its response is not paginated and it is typically used only to retrieve
- * "submitted data" for a template. A new endpoint will be introduced to provide this function more directly.
- * @deprecated
- */
-const getEnvelopesByTemplateId = async (endpoint, templateId) => endpoint.api //
-    .get(`/envelopes?template_id=${templateId}`)
+const getEnvelopes = (endpoint, params) => endpoint.api //
+    .get('/envelopes', { params })
     .then((r) => r.data);
 
 /**
@@ -3025,7 +2989,7 @@ exports.getEnvelopeDocumentPageDisplayUri = getEnvelopeDocumentPageDisplayUri;
 exports.getEnvelopeFile = getEnvelopeFile;
 exports.getEnvelopeRecipients = getEnvelopeRecipients;
 exports.getEnvelopeReminder = getEnvelopeReminder;
-exports.getEnvelopesByTemplateId = getEnvelopesByTemplateId;
+exports.getEnvelopes = getEnvelopes;
 exports.getEnvelopesSummary = getEnvelopesSummary;
 exports.getFieldAttachment = getFieldAttachment;
 exports.getFieldsForRole = getFieldsForRole;
@@ -3087,7 +3051,6 @@ exports.isValidEmail = isValidEmail;
 exports.isValidPhone = isValidPhone;
 exports.isValidRoleName = isValidRoleName;
 exports.isValidTag = isValidTag;
-exports.listEnvelopes = listEnvelopes;
 exports.listTemplates = listTemplates;
 exports.nameToRGBA = nameToRGBA;
 exports.recipientCanAct = recipientCanAct;
@@ -3099,7 +3062,6 @@ exports.resendOrganizationInvitation = resendOrganizationInvitation;
 exports.resendVerification = resendVerification;
 exports.resetPassword = resetPassword;
 exports.rotateApiKey = rotateApiKey;
-exports.searchEnvelopes = searchEnvelopes;
 exports.searchTemplates = searchTemplates;
 exports.sendDelegate = sendDelegate;
 exports.setWebhooks = setWebhooks;
@@ -3107,7 +3069,6 @@ exports.submitKbaChallengeResponse = submitKbaChallengeResponse;
 exports.submitKbaIdentity = submitKbaIdentity;
 exports.submitKbaPin = submitKbaPin;
 exports.switchProfile = switchProfile;
-exports.throttledGetEnvelope = throttledGetEnvelope;
 exports.throttledGetTemplate = throttledGetTemplate;
 exports.timePeriod = timePeriod;
 exports.toggleStar = toggleStar;