@verdocs/js-sdk 4.2.2 → 4.2.4

package/dist/index.d.ts

@@ -1371,77 +1371,63 @@ declare const getEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesP
  */
 declare const createInitials: (endpoint: VerdocsEndpoint, name: string, initials: Blob) => Promise<IInitial>;
 /**
- * KBA is not required at this time. Note that if there is a discrepancy between the `kba_required`
- * field here and that in the Recipient object, this object should be considered authoritative
- * (this can happen if the envelope sender updates the setting after the recipient has already
- * been invited).
+ * KBA is not required at this time.
  */
-interface IRecipientKbaStatusNotRequired {
+interface IRecipientKbaStepNone {
     envelope_id: string;
     role_name: string;
-    kba_required: false;
+    kba_step: "none";
 }
 /**
  * KBA has been completed and no further action is required.
  */
-interface IRecipientKbaStatusComplete {
+interface IRecipientKbaStepComplete {
     envelope_id: string;
     role_name: string;
-    kba_required: true;
-    kba_completed: true;
-    kba_method: string;
+    kba_step: "complete";
 }
 /**
  * A PIN code is required. Prompt the user to enter this PIN, and submit it via `submitKbaPin()`.
  */
-interface IRecipientKbaStatusPinRequired {
+interface IRecipientKbaStepPin {
     envelope_id: string;
     role_name: string;
-    kba_required: true;
-    kba_completed: false;
-    kba_method: "pin";
+    kba_step: "pin";
 }
 /**
  * A full identity verification is required. Prompt the user for their address and other (optional)
  * details and submit them via `submitKbaIdentity()`.
  */
-interface IRecipientKbaStatusIdentityRequired {
+interface IRecipientKbaStepIdentity {
     envelope_id: string;
     role_name: string;
-    kba_required: true;
-    kba_completed: false;
-    kba_method: "identity";
+    kba_step: "identity";
 }
 /**
- * Triggered by full identity verification if additional challenges are required. The recipient
- * should be shown the message and options, and submit a response via `submitKbaChallengeResponse()`.
- * Note that this response may be issued more than once if multiple challenges are required.
+ * If a positive identification was not possible, the user may be asked to answer 1 or more
+ * challenge questions via this response. They should be submitted via `submitKbaChallengeResponse()`.
  */
-interface IRecipientKbaChallengeRequired {
+interface IRecipientKbaStepChallenge {
     envelope_id: string;
     role_name: string;
-    kba_required: true;
-    kba_completed: false;
-    kba_method: "challenge";
-    challenges: {
+    kba_step: "challenge";
+    questions: {
         type: string;
         message: string;
-        options: string[];
+        options: (string | number)[];
     }[];
 }
 /**
  * Identity verification has failed. The user should be shown the message included. No further
  * signing operations may be performed.
  */
-interface IRecipientKbaStatusFailed {
+interface IRecipientKbaStepFailed {
     envelope_id: string;
     role_name: string;
-    kba_required: true;
-    kba_completed: false;
-    kba_method: "failed";
+    kba_step: "failed";
     message: string;
 }
-type TRecipientKbaStatus = IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed;
+type TRecipientKbaStep = IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed;
 /**
  * Get the current KBA status. Note that this may only be called by the recipient and requires a
  * valid signing session to proceed. Although the Recipient object itself contains indications of
@@ -1449,11 +1435,11 @@ type TRecipientKbaStatus = IRecipientKbaStatusNotRequired | IRecipientKbaStatusC
  * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
-declare const getKbaStatus: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+declare const getKbaStep: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
  * Submit a response to a KBA PIN challenge.
  */
-declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 interface IKbaIdentity {
     address1: string;
     address2?: string;
@@ -1467,11 +1453,18 @@ interface IKbaIdentity {
 /**
  * Submit an identity response to a KBA challenge.
  */
-declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
+interface IKbaChallengeResponse {
+    responses: {
+        type: string;
+        answer: string | number;
+    }[];
+}
 /**
- * Submit an identity response to a KBA challenge.
+ * Submit an identity response to a KBA challenge. Answers should be submitted in the same order as
+ * the challenges were listed in `IRecipientKbaStepChallenge.questions`.
  */
-declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: IKbaChallengeResponse) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
 /**
  * Update a recipient's status block
  */
@@ -2111,6 +2104,117 @@ declare const getWebhooks: (endpoint: VerdocsEndpoint) => Promise<IWebhook>;
  * ```
  */
 declare const setWebhooks: (endpoint: VerdocsEndpoint, params: ISetWebhookRequest) => Promise<IWebhook>;
+declare const canPerformTemplateAction: (profile: IProfile | null | undefined, action: TTemplateAction, template?: ITemplate) => {
+    canPerform: boolean;
+    message: string;
+};
+declare const hasRequiredPermissions: (profile: IProfile | null | undefined, permissions: TPermission[]) => boolean;
+/**
+ * Add a field to a template.
+ */
+declare const createField: (endpoint: VerdocsEndpoint, templateId: string, params: ITemplateField) => Promise<ITemplateField>;
+/**
+ * Update a template field.
+ */
+declare const updateField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string, params: Partial<ITemplateField>) => Promise<ITemplateField>;
+/**
+ * REmove a field from a template.
+ */
+declare const deleteField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string) => Promise<any>;
+/**
+ * Check to see if the user created the template.
+ */
+declare const userIsTemplateCreator: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+/**
+ * Check to see if a template is "shared" with the user.
+ */
+declare const userHasSharedTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+/**
+ * Check to see if the user can create a personal/private template.
+ */
+declare const userCanCreatePersonalTemplate: (profile: IProfile | null | undefined) => boolean;
+/**
+ * Check to see if the user can create an org-shared template.
+ */
+declare const userCanCreateOrgTemplate: (profile: IProfile | null | undefined) => boolean;
+/**
+ * Check to see if the user can create a public template.
+ */
+declare const userCanCreatePublicTemplate: (profile: IProfile | null | undefined) => boolean;
+/**
+ * Check to see if the user can read/view a template.
+ */
+declare const userCanReadTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+/**
+ * Check to see if the user can update a tempate.
+ */
+declare const userCanUpdateTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+declare const userCanMakeTemplatePrivate: (profile: IProfile | null | undefined, template: ITemplate) => boolean;
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+declare const userCanMakeTemplateShared: (profile: IProfile | null | undefined, template: ITemplate) => boolean;
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+declare const userCanMakeTemplatePublic: (profile: IProfile | null | undefined, template: ITemplate) => boolean;
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+declare const userCanChangeOrgVisibility: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+/**
+ * Check to see if the user can change whether a template is personal vs org-shared.
+ */
+declare const userCanDeleteTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean;
+/**
+ * Confirm whether the user can create an envelope using the specified template.
+ */
+declare const userCanSendTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+/**
+ * Confirm whether the user can create a new template.
+ */
+declare const userCanCreateTemplate: (profile: IProfile | null | undefined) => boolean;
+/**
+ * Check to see if the user can "build" the template (use the field builder). The user must have write access to the
+ * template, and the template must have at least one signer role.
+ */
+declare const userCanBuildTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+declare const getFieldsForRole: (template: ITemplate, role_name: string) => ITemplateField[];
+/**
+ * Check to see if the user can preview the template. The user must have read access to the template, the template must
+ * have at least one signer, and every signer must have at least one field.
+ */
+declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
+interface ICreateTemplateReminderRequest {
+    setup_time: number;
+    interval_time: number;
+}
+/**
+ * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
+ * should be sent. interval_time is the number of days between reminders.
+ */
+declare const createTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
+/**
+ * Get the reminder configuration for a template.
+ */
+declare const getTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
+/**
+ * Update the reminder configuration for a template.
+ */
+declare const updateTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
+/**
+ * Delete the reminder configuration for a template.
+ */
+declare const deleteTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;
+declare const createTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, params: IRole) => Promise<IRole>;
+declare const getTemplateRoles: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IRole[]>;
+declare const getTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<IRole>;
+declare const updateTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string, params: Partial<IRole>) => Promise<IRole>;
+declare const deleteTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<any>;
+declare const getTemplateRoleFields: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<ITemplateField[]>;
 /**
  * Given a `rgba(r,g,b,a)` string value, returns the hex equivalent, dropping the alpha channel.
  */
@@ -2217,31 +2321,6 @@ declare const decodeJWTBody: (token: string) => any;
  * the presence of the `document_id` field, which will only be present for signing sessions.
  */
 declare const decodeAccessTokenBody: (token: string) => TSession;
-/**
- * Some template search and list endpoints return only a partial set of fields for each entry via this structure.
- */
-interface ITemplateSummary {
-    id: string;
-    name: string;
-    description: string | null;
-    sender: TTemplateSenderType;
-    counter: number;
-    star_counter: number;
-    created_at: string;
-    updated_at: string;
-    last_used_at: string | null;
-    /**
-     * If true, the template is considered "sendable" (it has at least one signer, and every signer has at least one field.)
-     */
-    is_sendable: boolean;
-    is_personal: boolean;
-    is_public: boolean;
-    profile_id: string;
-    organization_id: string;
-    reminder_id: string;
-    tags: string[];
-    allowed_operations: TTemplateAction[];
-}
 interface ITemplateSearchParams {
     id?: string;
     name?: string;
@@ -2261,12 +2340,6 @@ interface ITemplateSearchParams {
     row?: number;
     page?: number;
 }
-interface ITemplateSummaries {
-    page: number;
-    count: number;
-    total: number;
-    records: ITemplateSummary[];
-}
 interface ITemplateTag {
     tag_name: string;
     template_id: string;
@@ -2281,128 +2354,12 @@ interface IStar {
     template_id: string;
     profile_id: string;
 }
-interface ITemplateOwnerInfo {
-    email: string;
-    name: string;
-    profile_id: string;
-}
 interface ITemplateSearchResult {
     page: number;
     row: number;
     total: number;
     result: ITemplate[];
 }
-declare const canPerformTemplateAction: (profile: IProfile | null | undefined, action: TTemplateAction, template?: ITemplate | ITemplateSummary) => {
-    canPerform: boolean;
-    message: string;
-};
-declare const hasRequiredPermissions: (profile: IProfile | null | undefined, permissions: TPermission[]) => boolean;
-/**
- * Add a field to a template.
- */
-declare const createField: (endpoint: VerdocsEndpoint, templateId: string, params: ITemplateField) => Promise<ITemplateField>;
-/**
- * Update a template field.
- */
-declare const updateField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string, params: Partial<ITemplateField>) => Promise<ITemplateField>;
-/**
- * REmove a field from a template.
- */
-declare const deleteField: (endpoint: VerdocsEndpoint, templateId: string, fieldName: string) => Promise<any>;
-/**
- * Check to see if the user created the template.
- */
-declare const userIsTemplateCreator: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean | null | undefined;
-/**
- * Check to see if a template is "shared" with the user.
- */
-declare const userHasSharedTemplate: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean | null | undefined;
-/**
- * Check to see if the user can create a personal/private template.
- */
-declare const userCanCreatePersonalTemplate: (profile: IProfile | null | undefined) => boolean;
-/**
- * Check to see if the user can create an org-shared template.
- */
-declare const userCanCreateOrgTemplate: (profile: IProfile | null | undefined) => boolean;
-/**
- * Check to see if the user can create a public template.
- */
-declare const userCanCreatePublicTemplate: (profile: IProfile | null | undefined) => boolean;
-/**
- * Check to see if the user can read/view a template.
- */
-declare const userCanReadTemplate: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean | null | undefined;
-/**
- * Check to see if the user can update a tempate.
- */
-declare const userCanUpdateTemplate: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean | null | undefined;
-/**
- * Check to see if the user can change whether a template is personal vs org-shared.
- */
-declare const userCanMakeTemplatePrivate: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean;
-/**
- * Check to see if the user can change whether a template is personal vs org-shared.
- */
-declare const userCanMakeTemplateShared: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean;
-/**
- * Check to see if the user can change whether a template is personal vs org-shared.
- */
-declare const userCanMakeTemplatePublic: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean;
-/**
- * Check to see if the user can change whether a template is personal vs org-shared.
- */
-declare const userCanChangeOrgVisibility: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean | null | undefined;
-/**
- * Check to see if the user can change whether a template is personal vs org-shared.
- */
-declare const userCanDeleteTemplate: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean;
-/**
- * Confirm whether the user can create an envelope using the specified template.
- */
-declare const userCanSendTemplate: (profile: IProfile | null | undefined, template: ITemplate | ITemplateSummary) => boolean | null | undefined;
-/**
- * Confirm whether the user can create a new template.
- */
-declare const userCanCreateTemplate: (profile: IProfile | null | undefined) => boolean;
-/**
- * Check to see if the user can "build" the template (use the field builder). The user must have write access to the
- * template, and the template must have at least one signer role.
- */
-declare const userCanBuildTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
-declare const getFieldsForRole: (template: ITemplate, role_name: string) => ITemplateField[];
-/**
- * Check to see if the user can preview the template. The user must have read access to the template, the template must
- * have at least one signer, and every signer must have at least one field.
- */
-declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
-interface ICreateTemplateReminderRequest {
-    setup_time: number;
-    interval_time: number;
-}
-/**
- * Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
- * should be sent. interval_time is the number of days between reminders.
- */
-declare const createTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
-/**
- * Get the reminder configuration for a template.
- */
-declare const getTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
-/**
- * Update the reminder configuration for a template.
- */
-declare const updateTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
-/**
- * Delete the reminder configuration for a template.
- */
-declare const deleteTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;
-declare const createTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, params: IRole) => Promise<IRole>;
-declare const getTemplateRoles: (endpoint: VerdocsEndpoint, templateId: string) => Promise<IRole[]>;
-declare const getTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<IRole>;
-declare const updateTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string, params: Partial<IRole>) => Promise<IRole>;
-declare const deleteTemplateRole: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<any>;
-declare const getTemplateRoleFields: (endpoint: VerdocsEndpoint, templateId: string, roleName: string) => Promise<ITemplateField[]>;
 /**
  * Get the template stars for a template.
  */
@@ -2410,7 +2367,7 @@ declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) => Promi
 /**
  * Toggle the template star for a template.
  */
-declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateSummary>;
+declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
 /**
  * Apply a tag to a template.
  */
@@ -2485,16 +2442,6 @@ declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesPa
  * ```
  */
 declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
-/**
- * Get owner information for a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const template = await Templates.getTemplateOwnerInfo((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
- * ```
- */
-declare const getTemplateOwnerInfo: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateOwnerInfo>;
 /**
  * Represents a document to be attached to a template via an externally-accessible URI. A copy of the document will be
  * downloaded from the specified URI. Note that the URI will be accessed without headers or other authorization methods
@@ -2549,16 +2496,6 @@ interface ITemplateCreateParams {
      */
     fields?: ITemplateField[];
 }
-/**
- * Create a template.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const newTemplate = await Templates.createTemplate((VerdocsEndpoint.getDefault(), {...});
- * ```
- */
-declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplate>;
 /**
  * Create a template.
  *
@@ -2568,7 +2505,7 @@ declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreat
  * const newTemplate = await Templates.createTemplatev2((VerdocsEndpoint.getDefault(), {...});
  * ```
  */
-declare const createTemplatev2: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplate>;
+declare const createTemplate: (endpoint: VerdocsEndpoint, params: ITemplateCreateParams, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<ITemplate>;
 interface ITemplateCreateFromSharepointParams {
     /** Name for the template to create. */
     name: string;
@@ -2646,22 +2583,6 @@ interface IGetTemplateSummaryParams {
     row?: number;
     page?: number;
 }
-/**
- * Get a summary of template data, typically used to populate admin panel dashboard pages.
- *
- * ```typescript
- * import {Templates} from '@verdocs/js-sdk/Templates';
- *
- * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
- * ```
- */
-declare const getTemplatesSummary: (endpoint: VerdocsEndpoint, params?: IGetTemplateSummaryParams) => Promise<ITemplateSummary>;
-/**
- * Wrapper for `getTemplate()` 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 throttledGetTemplate: (endpoint: VerdocsEndpoint, templateId: string) => ITemplate | Promise<ITemplate>;
 interface ITemplateListParams {
     status?: string[];
     q?: string;
@@ -2765,4 +2686,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, 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 };
+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, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, 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, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSearchParams, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, 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 };