@verdocs/js-sdk 4.2.84 → 4.2.86
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +29 -57
- package/dist/index.d.ts +29 -57
- package/dist/index.js +0 -60
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -53
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +3 -2
- package/package.json +3 -2
package/dist/index.d.mts
CHANGED
|
@@ -461,9 +461,12 @@ interface IEnvelope {
|
|
|
461
461
|
profile_id: string;
|
|
462
462
|
template_id: string | null;
|
|
463
463
|
organization_id: string;
|
|
464
|
-
reminder_id: string | null;
|
|
465
464
|
name: string;
|
|
466
465
|
no_contact?: boolean;
|
|
466
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
467
|
+
initial_reminder: number;
|
|
468
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
469
|
+
followup_reminders: number;
|
|
467
470
|
created_at: string;
|
|
468
471
|
updated_at: string;
|
|
469
472
|
canceled_at: string;
|
|
@@ -478,7 +481,6 @@ interface IEnvelope {
|
|
|
478
481
|
profile?: IProfile;
|
|
479
482
|
template?: ITemplate | null;
|
|
480
483
|
organization?: IOrganization;
|
|
481
|
-
reminder?: IReminder | null;
|
|
482
484
|
access_keys?: TAccessKey[];
|
|
483
485
|
fields?: IEnvelopeField[];
|
|
484
486
|
history_entries?: IEnvelopeHistory[];
|
|
@@ -669,16 +671,6 @@ interface IRecipient {
|
|
|
669
671
|
envelope?: IEnvelope;
|
|
670
672
|
profile?: IProfile;
|
|
671
673
|
}
|
|
672
|
-
interface IReminder {
|
|
673
|
-
id?: string;
|
|
674
|
-
is_on: boolean;
|
|
675
|
-
key: string;
|
|
676
|
-
setup_time: number;
|
|
677
|
-
interval_time: number;
|
|
678
|
-
created_at: string | null;
|
|
679
|
-
last_time: number | null;
|
|
680
|
-
next_time: number | null;
|
|
681
|
-
}
|
|
682
674
|
/**
|
|
683
675
|
* A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
|
|
684
676
|
* "Known" roles will have their email address supplied in the template which will get copied to envelopes created from
|
|
@@ -742,10 +734,6 @@ interface ITemplate {
|
|
|
742
734
|
* Organization the template lives in.
|
|
743
735
|
*/
|
|
744
736
|
organization_id: string;
|
|
745
|
-
/**
|
|
746
|
-
* If set, the template has reminders enabled.
|
|
747
|
-
*/
|
|
748
|
-
reminder_id: string | null;
|
|
749
737
|
/**
|
|
750
738
|
* Who may create new documents from the template.
|
|
751
739
|
*/
|
|
@@ -766,6 +754,10 @@ interface ITemplate {
|
|
|
766
754
|
* Number of times the template has been "starred".
|
|
767
755
|
*/
|
|
768
756
|
star_counter: number;
|
|
757
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
758
|
+
initial_reminder: number;
|
|
759
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
760
|
+
followup_reminders: number;
|
|
769
761
|
/**
|
|
770
762
|
* If true, the template is only visible to the creator. If false, the template will also be visible to the user's
|
|
771
763
|
* organization, if any.
|
|
@@ -782,7 +774,7 @@ interface ITemplate {
|
|
|
782
774
|
/**
|
|
783
775
|
* If set, the visibility level for the template.
|
|
784
776
|
*/
|
|
785
|
-
visibility?:
|
|
777
|
+
visibility?: TTemplateVisibility;
|
|
786
778
|
/**
|
|
787
779
|
* If true, the template is considered "sendable" (it has at least one signer, and every signer has at least one field.)
|
|
788
780
|
*/
|
|
@@ -808,7 +800,6 @@ interface ITemplate {
|
|
|
808
800
|
tags?: string[];
|
|
809
801
|
profile?: IProfile;
|
|
810
802
|
organization?: IOrganization;
|
|
811
|
-
reminder?: IReminder | null;
|
|
812
803
|
roles?: IRole[];
|
|
813
804
|
documents?: ITemplateDocument[];
|
|
814
805
|
fields?: ITemplateField[];
|
|
@@ -916,6 +907,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
|
|
|
916
907
|
type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
|
|
917
908
|
type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
|
|
918
909
|
type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used";
|
|
910
|
+
type TTemplateVisibility = "private" | "shared" | "public";
|
|
919
911
|
declare const FIELD_TYPES: TFieldType[];
|
|
920
912
|
declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
|
|
921
913
|
declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
|
|
@@ -1274,6 +1266,10 @@ interface ICreateEnvelopeFromTemplateRequest {
|
|
|
1274
1266
|
fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
|
|
1275
1267
|
environment?: string;
|
|
1276
1268
|
no_contact?: boolean;
|
|
1269
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
1270
|
+
initial_reminder: number;
|
|
1271
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
1272
|
+
followup_reminders: number;
|
|
1277
1273
|
}
|
|
1278
1274
|
interface ICreateEnvelopeDirectlyRequest {
|
|
1279
1275
|
name: string;
|
|
@@ -1284,6 +1280,10 @@ interface ICreateEnvelopeDirectlyRequest {
|
|
|
1284
1280
|
fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
|
|
1285
1281
|
environment?: string;
|
|
1286
1282
|
no_contact?: boolean;
|
|
1283
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
1284
|
+
initial_reminder: number;
|
|
1285
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
1286
|
+
followup_reminders: number;
|
|
1287
1287
|
}
|
|
1288
1288
|
type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelopeDirectlyRequest;
|
|
1289
1289
|
/**
|
|
@@ -1562,23 +1562,6 @@ declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, role
|
|
|
1562
1562
|
* Resend a recipient's invitation.
|
|
1563
1563
|
*/
|
|
1564
1564
|
declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;
|
|
1565
|
-
/**
|
|
1566
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
1567
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
1568
|
-
*/
|
|
1569
|
-
declare const createEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
|
|
1570
|
-
/**
|
|
1571
|
-
* Get the reminder configuration for an envelope.
|
|
1572
|
-
*/
|
|
1573
|
-
declare const getEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<IReminder>;
|
|
1574
|
-
/**
|
|
1575
|
-
* Update the reminder configuration for an envelope.
|
|
1576
|
-
*/
|
|
1577
|
-
declare const updateEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
|
|
1578
|
-
/**
|
|
1579
|
-
* Delete the reminder configuration for an envelope.
|
|
1580
|
-
*/
|
|
1581
|
-
declare const deleteEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<any>;
|
|
1582
1565
|
/**
|
|
1583
1566
|
* Check to see if the user owns the envelope.
|
|
1584
1567
|
*/
|
|
@@ -2345,27 +2328,6 @@ declare const getFieldsForRole: (template: ITemplate, role_name: string) => ITem
|
|
|
2345
2328
|
* have at least one signer, and every signer must have at least one field.
|
|
2346
2329
|
*/
|
|
2347
2330
|
declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
|
|
2348
|
-
interface ICreateTemplateReminderRequest {
|
|
2349
|
-
setup_time: number;
|
|
2350
|
-
interval_time: number;
|
|
2351
|
-
}
|
|
2352
|
-
/**
|
|
2353
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
2354
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
2355
|
-
*/
|
|
2356
|
-
declare const createTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
|
|
2357
|
-
/**
|
|
2358
|
-
* Get the reminder configuration for a template.
|
|
2359
|
-
*/
|
|
2360
|
-
declare const getTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
|
|
2361
|
-
/**
|
|
2362
|
-
* Update the reminder configuration for a template.
|
|
2363
|
-
*/
|
|
2364
|
-
declare const updateTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
|
|
2365
|
-
/**
|
|
2366
|
-
* Delete the reminder configuration for a template.
|
|
2367
|
-
*/
|
|
2368
|
-
declare const deleteTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;
|
|
2369
2331
|
/**
|
|
2370
2332
|
* Create a role.
|
|
2371
2333
|
*
|
|
@@ -2525,17 +2487,27 @@ interface IDocumentFromData {
|
|
|
2525
2487
|
interface ITemplateCreateParams {
|
|
2526
2488
|
/** Name for the template to create. */
|
|
2527
2489
|
name: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* If set, the visibility level for the template.
|
|
2492
|
+
*/
|
|
2493
|
+
visibility?: TTemplateVisibility;
|
|
2528
2494
|
/**
|
|
2529
2495
|
* Optional (defaults to true). Personal templates are only visible to the owner. Non-personal templates are shared
|
|
2530
2496
|
* within the user's organization.
|
|
2497
|
+
* @deprecated. See visibility.
|
|
2531
2498
|
*/
|
|
2532
2499
|
is_personal?: boolean;
|
|
2533
2500
|
/**
|
|
2534
2501
|
* Optional (defaults to false). Public templates may be found (via search) and viewed by anyone.
|
|
2502
|
+
* @deprecated. See visibility.
|
|
2535
2503
|
*/
|
|
2536
2504
|
is_public?: boolean;
|
|
2537
2505
|
/** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
|
|
2538
2506
|
sender?: TTemplateSenderType;
|
|
2507
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
2508
|
+
initial_reminder: number;
|
|
2509
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
2510
|
+
followup_reminders: number;
|
|
2539
2511
|
/** Optional description for the template to help identify it. */
|
|
2540
2512
|
description?: string;
|
|
2541
2513
|
/**
|
|
@@ -2794,4 +2766,4 @@ declare const decodeJWTBody: (token: string) => any;
|
|
|
2794
2766
|
* the presence of the `document_id` field, which will only be present for signing sessions.
|
|
2795
2767
|
*/
|
|
2796
2768
|
declare const decodeAccessTokenBody: (token: string) => TSession;
|
|
2797
|
-
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient,
|
|
2769
|
+
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, 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, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
|
package/dist/index.d.ts
CHANGED
|
@@ -461,9 +461,12 @@ interface IEnvelope {
|
|
|
461
461
|
profile_id: string;
|
|
462
462
|
template_id: string | null;
|
|
463
463
|
organization_id: string;
|
|
464
|
-
reminder_id: string | null;
|
|
465
464
|
name: string;
|
|
466
465
|
no_contact?: boolean;
|
|
466
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
467
|
+
initial_reminder: number;
|
|
468
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
469
|
+
followup_reminders: number;
|
|
467
470
|
created_at: string;
|
|
468
471
|
updated_at: string;
|
|
469
472
|
canceled_at: string;
|
|
@@ -478,7 +481,6 @@ interface IEnvelope {
|
|
|
478
481
|
profile?: IProfile;
|
|
479
482
|
template?: ITemplate | null;
|
|
480
483
|
organization?: IOrganization;
|
|
481
|
-
reminder?: IReminder | null;
|
|
482
484
|
access_keys?: TAccessKey[];
|
|
483
485
|
fields?: IEnvelopeField[];
|
|
484
486
|
history_entries?: IEnvelopeHistory[];
|
|
@@ -669,16 +671,6 @@ interface IRecipient {
|
|
|
669
671
|
envelope?: IEnvelope;
|
|
670
672
|
profile?: IProfile;
|
|
671
673
|
}
|
|
672
|
-
interface IReminder {
|
|
673
|
-
id?: string;
|
|
674
|
-
is_on: boolean;
|
|
675
|
-
key: string;
|
|
676
|
-
setup_time: number;
|
|
677
|
-
interval_time: number;
|
|
678
|
-
created_at: string | null;
|
|
679
|
-
last_time: number | null;
|
|
680
|
-
next_time: number | null;
|
|
681
|
-
}
|
|
682
674
|
/**
|
|
683
675
|
* A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
|
|
684
676
|
* "Known" roles will have their email address supplied in the template which will get copied to envelopes created from
|
|
@@ -742,10 +734,6 @@ interface ITemplate {
|
|
|
742
734
|
* Organization the template lives in.
|
|
743
735
|
*/
|
|
744
736
|
organization_id: string;
|
|
745
|
-
/**
|
|
746
|
-
* If set, the template has reminders enabled.
|
|
747
|
-
*/
|
|
748
|
-
reminder_id: string | null;
|
|
749
737
|
/**
|
|
750
738
|
* Who may create new documents from the template.
|
|
751
739
|
*/
|
|
@@ -766,6 +754,10 @@ interface ITemplate {
|
|
|
766
754
|
* Number of times the template has been "starred".
|
|
767
755
|
*/
|
|
768
756
|
star_counter: number;
|
|
757
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
758
|
+
initial_reminder: number;
|
|
759
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
760
|
+
followup_reminders: number;
|
|
769
761
|
/**
|
|
770
762
|
* If true, the template is only visible to the creator. If false, the template will also be visible to the user's
|
|
771
763
|
* organization, if any.
|
|
@@ -782,7 +774,7 @@ interface ITemplate {
|
|
|
782
774
|
/**
|
|
783
775
|
* If set, the visibility level for the template.
|
|
784
776
|
*/
|
|
785
|
-
visibility?:
|
|
777
|
+
visibility?: TTemplateVisibility;
|
|
786
778
|
/**
|
|
787
779
|
* If true, the template is considered "sendable" (it has at least one signer, and every signer has at least one field.)
|
|
788
780
|
*/
|
|
@@ -808,7 +800,6 @@ interface ITemplate {
|
|
|
808
800
|
tags?: string[];
|
|
809
801
|
profile?: IProfile;
|
|
810
802
|
organization?: IOrganization;
|
|
811
|
-
reminder?: IReminder | null;
|
|
812
803
|
roles?: IRole[];
|
|
813
804
|
documents?: ITemplateDocument[];
|
|
814
805
|
fields?: ITemplateField[];
|
|
@@ -916,6 +907,7 @@ type TEventDetail = "in_app" | "mail" | "signer" | "sms" | "reminder" | "prepare
|
|
|
916
907
|
type TEnvelopeUpdateResult = Omit<IEnvelope, "histories" | "recipients" | "certificate" | "document" | "fields" | "profile">;
|
|
917
908
|
type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "timestamp" | "date" | "dropdown" | "textarea" | "attachment" | "payment";
|
|
918
909
|
type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used";
|
|
910
|
+
type TTemplateVisibility = "private" | "shared" | "public";
|
|
919
911
|
declare const FIELD_TYPES: TFieldType[];
|
|
920
912
|
declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
|
|
921
913
|
declare const DEFAULT_FIELD_HEIGHTS: Record<TFieldType, number>;
|
|
@@ -1274,6 +1266,10 @@ interface ICreateEnvelopeFromTemplateRequest {
|
|
|
1274
1266
|
fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
|
|
1275
1267
|
environment?: string;
|
|
1276
1268
|
no_contact?: boolean;
|
|
1269
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
1270
|
+
initial_reminder: number;
|
|
1271
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
1272
|
+
followup_reminders: number;
|
|
1277
1273
|
}
|
|
1278
1274
|
interface ICreateEnvelopeDirectlyRequest {
|
|
1279
1275
|
name: string;
|
|
@@ -1284,6 +1280,10 @@ interface ICreateEnvelopeDirectlyRequest {
|
|
|
1284
1280
|
fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
|
|
1285
1281
|
environment?: string;
|
|
1286
1282
|
no_contact?: boolean;
|
|
1283
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
1284
|
+
initial_reminder: number;
|
|
1285
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
1286
|
+
followup_reminders: number;
|
|
1287
1287
|
}
|
|
1288
1288
|
type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelopeDirectlyRequest;
|
|
1289
1289
|
/**
|
|
@@ -1562,23 +1562,6 @@ declare const sendDelegate: (endpoint: VerdocsEndpoint, envelopeId: string, role
|
|
|
1562
1562
|
* Resend a recipient's invitation.
|
|
1563
1563
|
*/
|
|
1564
1564
|
declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<any>;
|
|
1565
|
-
/**
|
|
1566
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
1567
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
1568
|
-
*/
|
|
1569
|
-
declare const createEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
|
|
1570
|
-
/**
|
|
1571
|
-
* Get the reminder configuration for an envelope.
|
|
1572
|
-
*/
|
|
1573
|
-
declare const getEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<IReminder>;
|
|
1574
|
-
/**
|
|
1575
|
-
* Update the reminder configuration for an envelope.
|
|
1576
|
-
*/
|
|
1577
|
-
declare const updateEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string, params: ICreateEnvelopeReminderRequest) => Promise<IReminder>;
|
|
1578
|
-
/**
|
|
1579
|
-
* Delete the reminder configuration for an envelope.
|
|
1580
|
-
*/
|
|
1581
|
-
declare const deleteEnvelopeReminder: (endpoint: VerdocsEndpoint, envelopeId: string, reminderId: string) => Promise<any>;
|
|
1582
1565
|
/**
|
|
1583
1566
|
* Check to see if the user owns the envelope.
|
|
1584
1567
|
*/
|
|
@@ -2345,27 +2328,6 @@ declare const getFieldsForRole: (template: ITemplate, role_name: string) => ITem
|
|
|
2345
2328
|
* have at least one signer, and every signer must have at least one field.
|
|
2346
2329
|
*/
|
|
2347
2330
|
declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, template: ITemplate) => boolean | null | undefined;
|
|
2348
|
-
interface ICreateTemplateReminderRequest {
|
|
2349
|
-
setup_time: number;
|
|
2350
|
-
interval_time: number;
|
|
2351
|
-
}
|
|
2352
|
-
/**
|
|
2353
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
2354
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
2355
|
-
*/
|
|
2356
|
-
declare const createTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, params: ICreateTemplateReminderRequest) => Promise<ITemplate>;
|
|
2357
|
-
/**
|
|
2358
|
-
* Get the reminder configuration for a template.
|
|
2359
|
-
*/
|
|
2360
|
-
declare const getTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<IReminder>;
|
|
2361
|
-
/**
|
|
2362
|
-
* Update the reminder configuration for a template.
|
|
2363
|
-
*/
|
|
2364
|
-
declare const updateTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string, params: ICreateTemplateReminderRequest) => Promise<IReminder>;
|
|
2365
|
-
/**
|
|
2366
|
-
* Delete the reminder configuration for a template.
|
|
2367
|
-
*/
|
|
2368
|
-
declare const deleteTemplateReminder: (endpoint: VerdocsEndpoint, templateId: string, reminderId: string) => Promise<any>;
|
|
2369
2331
|
/**
|
|
2370
2332
|
* Create a role.
|
|
2371
2333
|
*
|
|
@@ -2525,17 +2487,27 @@ interface IDocumentFromData {
|
|
|
2525
2487
|
interface ITemplateCreateParams {
|
|
2526
2488
|
/** Name for the template to create. */
|
|
2527
2489
|
name: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* If set, the visibility level for the template.
|
|
2492
|
+
*/
|
|
2493
|
+
visibility?: TTemplateVisibility;
|
|
2528
2494
|
/**
|
|
2529
2495
|
* Optional (defaults to true). Personal templates are only visible to the owner. Non-personal templates are shared
|
|
2530
2496
|
* within the user's organization.
|
|
2497
|
+
* @deprecated. See visibility.
|
|
2531
2498
|
*/
|
|
2532
2499
|
is_personal?: boolean;
|
|
2533
2500
|
/**
|
|
2534
2501
|
* Optional (defaults to false). Public templates may be found (via search) and viewed by anyone.
|
|
2502
|
+
* @deprecated. See visibility.
|
|
2535
2503
|
*/
|
|
2536
2504
|
is_public?: boolean;
|
|
2537
2505
|
/** Optional (defaults to EVERYONE_AS_CREATOR). Who may create and send envelopes using this template. */
|
|
2538
2506
|
sender?: TTemplateSenderType;
|
|
2507
|
+
/** Delay (in seconds) before the first reminder is sent (min: 4hrs). Set to 0 or null to disable. */
|
|
2508
|
+
initial_reminder: number;
|
|
2509
|
+
/** Delay (in seconds) before subsequent remidners are sent (min: 12hrs). Set to 0 or null to disable. */
|
|
2510
|
+
followup_reminders: number;
|
|
2539
2511
|
/** Optional description for the template to help identify it. */
|
|
2540
2512
|
description?: string;
|
|
2541
2513
|
/**
|
|
@@ -2794,4 +2766,4 @@ declare const decodeJWTBody: (token: string) => any;
|
|
|
2794
2766
|
* the presence of the `document_id` field, which will only be present for signing sessions.
|
|
2795
2767
|
*/
|
|
2796
2768
|
declare const decodeAccessTokenBody: (token: string) => TSession;
|
|
2797
|
-
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient,
|
|
2769
|
+
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, 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, startSigningSession, getInPersonLink, sendDelegate, resendInvitation, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipient, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getOrganizationContacts, deleteOrganizationContact, createOrganizationContact, updateOrganizationContact, getGroups, getGroup, createGroup, updateGroup, deleteGroup, addGroupMember, deleteGroupMember, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganization, updateOrganization, updateOrganizationLogo, updateOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, IAcceptOrganizationInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, TTemplatePermissionCreatePublic, TTemplatePermissionCreateOrg, TTemplatePermissionCreatePersonal, TTemplatePermissionDelete, TTemplatePermissionVisibility, TTemplateMemberRead, TTemplateMemberWrite, TTemplateMemberDelete, TTemplateMemberVisibility, TTemplatePermission, TAccountPermissionOwnerAdd, TAccountPermissionOwnerRemove, TAccountPermissionAdminAdd, TAccountPermissionAdminRemove, TAccountPermissionMemberView, TAccountPermissionMemberAdd, TAccountPermissionMemberRemove, TAccountPermission, TOrgPermissionCreate, TOrgPermissionView, TOrgPermissionUpdate, TOrgPermissionDelete, TOrgPermissionTransfer, TOrgPermissionList, TOrgPermission, TEnvelopePermissionCreate, TEnvelopePermissionCancel, TEnvelopePermissionView, TEnvelopePermissionOrg, TEnvelopePermission, TPermission, TRole, RolePermissions, userHasPermissions, ISigningSession, IUserSession, IIdToken, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, createTemplateRole, updateTemplateRole, deleteTemplateRole, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, ITemplateSortBy, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateTag, ITag, IStar, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, resendVerification, verifyEmail, getMyUser, getNotifications, getProfiles, getCurrentProfile, switchProfile, updateProfile, deleteProfile, createProfile, updateProfilePhoto, ICreateProfileRequest, IUpdateProfileRequest, IAuthenticateResponse, IChangePasswordRequest, IChangePasswordResponse, IResetPasswordRequest, IResetPasswordResponse, IVerifyEmailRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, randomString, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
|
package/dist/index.js
CHANGED
|
@@ -1704,32 +1704,6 @@ const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
|
|
|
1704
1704
|
.put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
|
|
1705
1705
|
.then((r) => r.data);
|
|
1706
1706
|
|
|
1707
|
-
/**
|
|
1708
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
1709
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
1710
|
-
*/
|
|
1711
|
-
const createEnvelopeReminder = (endpoint, envelopeId, params) => endpoint.api //
|
|
1712
|
-
.post(`/envelopes/${envelopeId}/reminder/`, params)
|
|
1713
|
-
.then((r) => r.data);
|
|
1714
|
-
/**
|
|
1715
|
-
* Get the reminder configuration for an envelope.
|
|
1716
|
-
*/
|
|
1717
|
-
const getEnvelopeReminder = (endpoint, envelopeId, reminderId) => endpoint.api //
|
|
1718
|
-
.get(`/envelopes/${envelopeId}/reminder/${reminderId}`)
|
|
1719
|
-
.then((r) => r.data);
|
|
1720
|
-
/**
|
|
1721
|
-
* Update the reminder configuration for an envelope.
|
|
1722
|
-
*/
|
|
1723
|
-
const updateEnvelopeReminder = (endpoint, envelopeId, reminderId, params) => endpoint.api //
|
|
1724
|
-
.put(`/envelopes/${envelopeId}/reminder/${reminderId}`, params)
|
|
1725
|
-
.then((r) => r.data);
|
|
1726
|
-
/**
|
|
1727
|
-
* Delete the reminder configuration for an envelope.
|
|
1728
|
-
*/
|
|
1729
|
-
const deleteEnvelopeReminder = (endpoint, envelopeId, reminderId) => endpoint.api //
|
|
1730
|
-
.delete(`/envelopes/${envelopeId}/reminder/${reminderId}`)
|
|
1731
|
-
.then((r) => r.data);
|
|
1732
|
-
|
|
1733
1707
|
/**
|
|
1734
1708
|
* Various helpers to identify available operations for an envelope by a user.
|
|
1735
1709
|
*
|
|
@@ -2591,32 +2565,6 @@ const userCanPreviewTemplate = (profile, template) => {
|
|
|
2591
2565
|
return hasPermission && signers.length > 0 && signers.every((signer) => getFieldsForRole(template, signer.name).length > 0);
|
|
2592
2566
|
};
|
|
2593
2567
|
|
|
2594
|
-
/**
|
|
2595
|
-
* Enable automatic reminders. setup_time is the number of days after the envelope is sent that the first reminder
|
|
2596
|
-
* should be sent. interval_time is the number of days between reminders.
|
|
2597
|
-
*/
|
|
2598
|
-
const createTemplateReminder = (endpoint, templateId, params) => endpoint.api //
|
|
2599
|
-
.post(`/templates/${templateId}/reminder/`, params)
|
|
2600
|
-
.then((r) => r.data);
|
|
2601
|
-
/**
|
|
2602
|
-
* Get the reminder configuration for a template.
|
|
2603
|
-
*/
|
|
2604
|
-
const getTemplateReminder = (endpoint, templateId, reminderId) => endpoint.api //
|
|
2605
|
-
.get(`/templates/${templateId}/reminder/${reminderId}`)
|
|
2606
|
-
.then((r) => r.data);
|
|
2607
|
-
/**
|
|
2608
|
-
* Update the reminder configuration for a template.
|
|
2609
|
-
*/
|
|
2610
|
-
const updateTemplateReminder = (endpoint, templateId, reminderId, params) => endpoint.api //
|
|
2611
|
-
.put(`/templates/${templateId}/reminder/${reminderId}`, params)
|
|
2612
|
-
.then((r) => r.data);
|
|
2613
|
-
/**
|
|
2614
|
-
* Delete the reminder configuration for a template.
|
|
2615
|
-
*/
|
|
2616
|
-
const deleteTemplateReminder = (endpoint, templateId, reminderId) => endpoint.api //
|
|
2617
|
-
.delete(`/templates/${templateId}/reminder/${reminderId}`)
|
|
2618
|
-
.then((r) => r.data);
|
|
2619
|
-
|
|
2620
2568
|
/**
|
|
2621
2569
|
* A "role" is an individual participant in a signing flow, such as a signer or CC contact.
|
|
2622
2570
|
* A role is a placeholder that will eventually become a named recipient. For example, "Tenant 1"
|
|
@@ -2997,7 +2945,6 @@ exports.changePassword = changePassword;
|
|
|
2997
2945
|
exports.convertToE164 = convertToE164;
|
|
2998
2946
|
exports.createApiKey = createApiKey;
|
|
2999
2947
|
exports.createEnvelope = createEnvelope;
|
|
3000
|
-
exports.createEnvelopeReminder = createEnvelopeReminder;
|
|
3001
2948
|
exports.createField = createField;
|
|
3002
2949
|
exports.createGroup = createGroup;
|
|
3003
2950
|
exports.createInitials = createInitials;
|
|
@@ -3009,14 +2956,12 @@ exports.createTag = createTag;
|
|
|
3009
2956
|
exports.createTemplate = createTemplate;
|
|
3010
2957
|
exports.createTemplateDocument = createTemplateDocument;
|
|
3011
2958
|
exports.createTemplateFromSharepoint = createTemplateFromSharepoint;
|
|
3012
|
-
exports.createTemplateReminder = createTemplateReminder;
|
|
3013
2959
|
exports.createTemplateRole = createTemplateRole;
|
|
3014
2960
|
exports.declineOrganizationInvitation = declineOrganizationInvitation;
|
|
3015
2961
|
exports.decodeAccessTokenBody = decodeAccessTokenBody;
|
|
3016
2962
|
exports.decodeJWTBody = decodeJWTBody;
|
|
3017
2963
|
exports.deleteApiKey = deleteApiKey;
|
|
3018
2964
|
exports.deleteEnvelopeFieldAttachment = deleteEnvelopeFieldAttachment;
|
|
3019
|
-
exports.deleteEnvelopeReminder = deleteEnvelopeReminder;
|
|
3020
2965
|
exports.deleteField = deleteField;
|
|
3021
2966
|
exports.deleteGroup = deleteGroup;
|
|
3022
2967
|
exports.deleteGroupMember = deleteGroupMember;
|
|
@@ -3027,7 +2972,6 @@ exports.deleteProfile = deleteProfile;
|
|
|
3027
2972
|
exports.deleteSignature = deleteSignature;
|
|
3028
2973
|
exports.deleteTemplate = deleteTemplate;
|
|
3029
2974
|
exports.deleteTemplateDocument = deleteTemplateDocument;
|
|
3030
|
-
exports.deleteTemplateReminder = deleteTemplateReminder;
|
|
3031
2975
|
exports.deleteTemplateRole = deleteTemplateRole;
|
|
3032
2976
|
exports.deleteTemplateTag = deleteTemplateTag;
|
|
3033
2977
|
exports.downloadBlob = downloadBlob;
|
|
@@ -3054,7 +2998,6 @@ exports.getEnvelope = getEnvelope;
|
|
|
3054
2998
|
exports.getEnvelopeDocument = getEnvelopeDocument;
|
|
3055
2999
|
exports.getEnvelopeDocumentPageDisplayUri = getEnvelopeDocumentPageDisplayUri;
|
|
3056
3000
|
exports.getEnvelopeFile = getEnvelopeFile;
|
|
3057
|
-
exports.getEnvelopeReminder = getEnvelopeReminder;
|
|
3058
3001
|
exports.getEnvelopes = getEnvelopes;
|
|
3059
3002
|
exports.getFieldAttachment = getFieldAttachment;
|
|
3060
3003
|
exports.getFieldsForRole = getFieldsForRole;
|
|
@@ -3090,7 +3033,6 @@ exports.getTemplateDocumentFile = getTemplateDocumentFile;
|
|
|
3090
3033
|
exports.getTemplateDocumentPageDisplayUri = getTemplateDocumentPageDisplayUri;
|
|
3091
3034
|
exports.getTemplateDocumentThumbnail = getTemplateDocumentThumbnail;
|
|
3092
3035
|
exports.getTemplateDocuments = getTemplateDocuments;
|
|
3093
|
-
exports.getTemplateReminder = getTemplateReminder;
|
|
3094
3036
|
exports.getTemplateTags = getTemplateTags;
|
|
3095
3037
|
exports.getTemplates = getTemplates;
|
|
3096
3038
|
exports.getValidator = getValidator;
|
|
@@ -3133,7 +3075,6 @@ exports.updateApiKey = updateApiKey;
|
|
|
3133
3075
|
exports.updateEnvelopeField = updateEnvelopeField;
|
|
3134
3076
|
exports.updateEnvelopeFieldInitials = updateEnvelopeFieldInitials;
|
|
3135
3077
|
exports.updateEnvelopeFieldSignature = updateEnvelopeFieldSignature;
|
|
3136
|
-
exports.updateEnvelopeReminder = updateEnvelopeReminder;
|
|
3137
3078
|
exports.updateField = updateField;
|
|
3138
3079
|
exports.updateGroup = updateGroup;
|
|
3139
3080
|
exports.updateOrganization = updateOrganization;
|
|
@@ -3146,7 +3087,6 @@ exports.updateProfile = updateProfile;
|
|
|
3146
3087
|
exports.updateProfilePhoto = updateProfilePhoto;
|
|
3147
3088
|
exports.updateRecipient = updateRecipient;
|
|
3148
3089
|
exports.updateTemplate = updateTemplate;
|
|
3149
|
-
exports.updateTemplateReminder = updateTemplateReminder;
|
|
3150
3090
|
exports.updateTemplateRole = updateTemplateRole;
|
|
3151
3091
|
exports.uploadEnvelopeFieldAttachment = uploadEnvelopeFieldAttachment;
|
|
3152
3092
|
exports.userCanAct = userCanAct;
|