@verdocs/js-sdk 6.0.4 → 6.1.0
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 +26 -25
- package/dist/index.d.ts +26 -25
- package/dist/index.js +24 -24
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +23 -24
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1236,7 +1236,7 @@ interface IDocumentSearchOptions {
|
|
|
1236
1236
|
is_owner?: boolean;
|
|
1237
1237
|
is_recipient?: boolean;
|
|
1238
1238
|
envelope_status?: TEnvelopeStatus[];
|
|
1239
|
-
recipient_status?:
|
|
1239
|
+
recipient_status?: TRecipientStatus[];
|
|
1240
1240
|
}
|
|
1241
1241
|
interface ICreateEnvelopeRecipientFromTemplate {
|
|
1242
1242
|
/**
|
|
@@ -1420,6 +1420,8 @@ interface ICreateEnvelopeReminderRequest {
|
|
|
1420
1420
|
interval_time: number;
|
|
1421
1421
|
}
|
|
1422
1422
|
interface IUpdateRecipientParams {
|
|
1423
|
+
/** Trigger a reminder invite, or fully reset the recipient's status. */
|
|
1424
|
+
action?: "remind" | "reset";
|
|
1423
1425
|
/** The name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
|
|
1424
1426
|
first_name?: string;
|
|
1425
1427
|
last_name?: string;
|
|
@@ -2071,23 +2073,6 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
|
|
|
2071
2073
|
* @apiSuccess ISignerTokenResponse . Updated signing session.
|
|
2072
2074
|
*/
|
|
2073
2075
|
declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
|
|
2074
|
-
// TODO: Use "oneOf" to describe the unions of these two calls.
|
|
2075
|
-
/**
|
|
2076
|
-
* Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
|
|
2077
|
-
* avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
|
|
2078
|
-
* the calling application to prevent abuse. This endpoint will return a 200 OK even if the
|
|
2079
|
-
* no_contact flag is set on the envelope (in which case the call will be ignored).
|
|
2080
|
-
*
|
|
2081
|
-
* @group Recipients
|
|
2082
|
-
* @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
|
|
2083
|
-
* @apiParam string(format:uuid) envelope_id The envelope to operate on.
|
|
2084
|
-
* @apiParam string role_name The role to operate on.
|
|
2085
|
-
* @apiBody string(enum:'resend') action The operation to perform (resend).
|
|
2086
|
-
* @apiSuccess string . Success message.
|
|
2087
|
-
*/
|
|
2088
|
-
declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
|
|
2089
|
-
status: "OK";
|
|
2090
|
-
}>;
|
|
2091
2076
|
/**
|
|
2092
2077
|
* Delegate a recipient's signing responsibility. The envelope sender must enable this before the
|
|
2093
2078
|
* recipient calls this endpoint, and only the recipient may call it, or the call will be rejected.
|
|
@@ -2119,19 +2104,20 @@ declare const delegateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string,
|
|
|
2119
2104
|
status: "OK";
|
|
2120
2105
|
}>;
|
|
2121
2106
|
/**
|
|
2122
|
-
* Update a recipient. NOTE: User interfaces should rate-limit this operation to
|
|
2123
|
-
*
|
|
2124
|
-
*
|
|
2125
|
-
*
|
|
2107
|
+
* Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
|
|
2108
|
+
* Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
|
|
2109
|
+
* abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
|
|
2110
|
+
* case the call will be silently ignored).
|
|
2126
2111
|
*
|
|
2127
2112
|
* @group Recipients
|
|
2128
2113
|
* @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient
|
|
2129
2114
|
* @apiParam string(format:uuid) envelope_id The envelope to operate on.
|
|
2130
2115
|
* @apiParam string role_name The role name to update.
|
|
2116
|
+
* @apiBody string(enum:'remind'|'reset') action? Trigger a reminder, or fully reset the recipient
|
|
2131
2117
|
* @apiBody string first_name? Update the recipient's first name.
|
|
2132
2118
|
* @apiBody string last_name? Update the recipient's last name.
|
|
2133
|
-
* @apiBody string email? Update the recipient's email address.
|
|
2134
|
-
* @apiBody string message? Update the recipient's invite message.
|
|
2119
|
+
* @apiBody string email? Update the recipient's email address.
|
|
2120
|
+
* @apiBody string message? Update the recipient's invite message.
|
|
2135
2121
|
* @apiBody string phone? Update the recipient's phone number.
|
|
2136
2122
|
* @apiBody string passcode? If passcode authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed passcode-based auth.
|
|
2137
2123
|
* @apiBody string address? If KBA-based authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed KBA-based auth.
|
|
@@ -2143,6 +2129,21 @@ declare const delegateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string,
|
|
|
2143
2129
|
* @apiSuccess IRecipient . The updated Recipient.
|
|
2144
2130
|
*/
|
|
2145
2131
|
declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, params: IUpdateRecipientParams) => Promise<IRecipient>;
|
|
2132
|
+
/**
|
|
2133
|
+
* Send a reminder to a recipient. The recipient must still be an active member of the signing flow
|
|
2134
|
+
* (e.g. not declined, already submitted, etc.)
|
|
2135
|
+
*/
|
|
2136
|
+
declare const remindRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
|
|
2137
|
+
status: "OK";
|
|
2138
|
+
}>;
|
|
2139
|
+
/**
|
|
2140
|
+
* Fully reset a recipient. This allows the recipient to restart failed KBA flows, change
|
|
2141
|
+
* fields they may have filled in incorrectly while signing, etc. This cannot be used on a
|
|
2142
|
+
* canceled or completed envelope, but may be used to restart an envelope marked declined.
|
|
2143
|
+
*/
|
|
2144
|
+
declare const resetRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
|
|
2145
|
+
status: "OK";
|
|
2146
|
+
}>;
|
|
2146
2147
|
/**
|
|
2147
2148
|
* Check to see if the profile ID owns the envelope.
|
|
2148
2149
|
*/
|
|
@@ -3855,4 +3856,4 @@ declare const decodeJWTBody: (token: string) => any;
|
|
|
3855
3856
|
* the presence of the `document_id` field, which will only be present for signing sessions.
|
|
3856
3857
|
*/
|
|
3857
3858
|
declare const decodeAccessTokenBody: (token: string) => TSession;
|
|
3858
|
-
export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipientStatus, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, verifySigner,
|
|
3859
|
+
export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipientStatus, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, verifySigner, delegateRecipient, updateRecipient, remindRecipient, resetRecipient, isEnvelopeOwner, isEnvelopeRecipient, canAccessEnvelope, userIsEnvelopeOwner, userIsEnvelopeRecipient, useCanAccessEnvelope, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipientFromTemplate, ICreateEnvelopeRecipientDirectly, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, IUpdateRecipientParams, ICreateEnvelopeDocumentFromData, ICreateEnvelopeDocumentFromUri, ICreateEnvelopeDocumentFromFile, ICreateEnvelopeFieldFromTemplate, ICreateEnvelopeFieldDirectly, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, IAuthenticateRecipientViaPasscodeRequest, IAuthenticateRecipientViaEmailRequest, IAuthenticateRecipientViaSMSRequest, IKBAResponse, IAuthenticateRecipientViaKBARequest, TAuthenticateRecipientRequest, 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, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, 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, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, 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, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, 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
|
@@ -1236,7 +1236,7 @@ interface IDocumentSearchOptions {
|
|
|
1236
1236
|
is_owner?: boolean;
|
|
1237
1237
|
is_recipient?: boolean;
|
|
1238
1238
|
envelope_status?: TEnvelopeStatus[];
|
|
1239
|
-
recipient_status?:
|
|
1239
|
+
recipient_status?: TRecipientStatus[];
|
|
1240
1240
|
}
|
|
1241
1241
|
interface ICreateEnvelopeRecipientFromTemplate {
|
|
1242
1242
|
/**
|
|
@@ -1420,6 +1420,8 @@ interface ICreateEnvelopeReminderRequest {
|
|
|
1420
1420
|
interval_time: number;
|
|
1421
1421
|
}
|
|
1422
1422
|
interface IUpdateRecipientParams {
|
|
1423
|
+
/** Trigger a reminder invite, or fully reset the recipient's status. */
|
|
1424
|
+
action?: "remind" | "reset";
|
|
1423
1425
|
/** The name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
|
|
1424
1426
|
first_name?: string;
|
|
1425
1427
|
last_name?: string;
|
|
@@ -2071,23 +2073,6 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
|
|
|
2071
2073
|
* @apiSuccess ISignerTokenResponse . Updated signing session.
|
|
2072
2074
|
*/
|
|
2073
2075
|
declare const verifySigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<ISignerTokenResponse>;
|
|
2074
|
-
// TODO: Use "oneOf" to describe the unions of these two calls.
|
|
2075
|
-
/**
|
|
2076
|
-
* Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
|
|
2077
|
-
* avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
|
|
2078
|
-
* the calling application to prevent abuse. This endpoint will return a 200 OK even if the
|
|
2079
|
-
* no_contact flag is set on the envelope (in which case the call will be ignored).
|
|
2080
|
-
*
|
|
2081
|
-
* @group Recipients
|
|
2082
|
-
* @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
|
|
2083
|
-
* @apiParam string(format:uuid) envelope_id The envelope to operate on.
|
|
2084
|
-
* @apiParam string role_name The role to operate on.
|
|
2085
|
-
* @apiBody string(enum:'resend') action The operation to perform (resend).
|
|
2086
|
-
* @apiSuccess string . Success message.
|
|
2087
|
-
*/
|
|
2088
|
-
declare const resendInvitation: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
|
|
2089
|
-
status: "OK";
|
|
2090
|
-
}>;
|
|
2091
2076
|
/**
|
|
2092
2077
|
* Delegate a recipient's signing responsibility. The envelope sender must enable this before the
|
|
2093
2078
|
* recipient calls this endpoint, and only the recipient may call it, or the call will be rejected.
|
|
@@ -2119,19 +2104,20 @@ declare const delegateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string,
|
|
|
2119
2104
|
status: "OK";
|
|
2120
2105
|
}>;
|
|
2121
2106
|
/**
|
|
2122
|
-
* Update a recipient. NOTE: User interfaces should rate-limit this operation to
|
|
2123
|
-
*
|
|
2124
|
-
*
|
|
2125
|
-
*
|
|
2107
|
+
* Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
|
|
2108
|
+
* Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
|
|
2109
|
+
* abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
|
|
2110
|
+
* case the call will be silently ignored).
|
|
2126
2111
|
*
|
|
2127
2112
|
* @group Recipients
|
|
2128
2113
|
* @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient
|
|
2129
2114
|
* @apiParam string(format:uuid) envelope_id The envelope to operate on.
|
|
2130
2115
|
* @apiParam string role_name The role name to update.
|
|
2116
|
+
* @apiBody string(enum:'remind'|'reset') action? Trigger a reminder, or fully reset the recipient
|
|
2131
2117
|
* @apiBody string first_name? Update the recipient's first name.
|
|
2132
2118
|
* @apiBody string last_name? Update the recipient's last name.
|
|
2133
|
-
* @apiBody string email? Update the recipient's email address.
|
|
2134
|
-
* @apiBody string message? Update the recipient's invite message.
|
|
2119
|
+
* @apiBody string email? Update the recipient's email address.
|
|
2120
|
+
* @apiBody string message? Update the recipient's invite message.
|
|
2135
2121
|
* @apiBody string phone? Update the recipient's phone number.
|
|
2136
2122
|
* @apiBody string passcode? If passcode authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed passcode-based auth.
|
|
2137
2123
|
* @apiBody string address? If KBA-based authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed KBA-based auth.
|
|
@@ -2143,6 +2129,21 @@ declare const delegateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string,
|
|
|
2143
2129
|
* @apiSuccess IRecipient . The updated Recipient.
|
|
2144
2130
|
*/
|
|
2145
2131
|
declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, params: IUpdateRecipientParams) => Promise<IRecipient>;
|
|
2132
|
+
/**
|
|
2133
|
+
* Send a reminder to a recipient. The recipient must still be an active member of the signing flow
|
|
2134
|
+
* (e.g. not declined, already submitted, etc.)
|
|
2135
|
+
*/
|
|
2136
|
+
declare const remindRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
|
|
2137
|
+
status: "OK";
|
|
2138
|
+
}>;
|
|
2139
|
+
/**
|
|
2140
|
+
* Fully reset a recipient. This allows the recipient to restart failed KBA flows, change
|
|
2141
|
+
* fields they may have filled in incorrectly while signing, etc. This cannot be used on a
|
|
2142
|
+
* canceled or completed envelope, but may be used to restart an envelope marked declined.
|
|
2143
|
+
*/
|
|
2144
|
+
declare const resetRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<{
|
|
2145
|
+
status: "OK";
|
|
2146
|
+
}>;
|
|
2146
2147
|
/**
|
|
2147
2148
|
* Check to see if the profile ID owns the envelope.
|
|
2148
2149
|
*/
|
|
@@ -3855,4 +3856,4 @@ declare const decodeJWTBody: (token: string) => any;
|
|
|
3855
3856
|
* the presence of the `document_id` field, which will only be present for signing sessions.
|
|
3856
3857
|
*/
|
|
3857
3858
|
declare const decodeAccessTokenBody: (token: string) => TSession;
|
|
3858
|
-
export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipientStatus, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, verifySigner,
|
|
3859
|
+
export { TRequestStatus, TTemplateSender, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, TDeprecatedHistoryEvent, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, TWebhookEvent, TTemplateVisibility, TEntitlement, TRecipientAuthMethod, TRecipientAuthStep, TUsageType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, WEBHOOK_EVENTS, ALL_PERMISSIONS, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IEntitlement, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IUser, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IDropdownOption, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IKBAQuestion, IRecipient, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TOrganizationUsage, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelope, getEnvelopeDocument, downloadDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelope, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, ITimeRange, IListEnvelopesParams, getEnvelopes, createInitials, IRecipientKbaStepNone, IRecipientKbaStepComplete, IRecipientKbaStepPin, IRecipientKbaStepIdentity, IRecipientKbaStepChallenge, IRecipientKbaStepFailed, TRecipientKbaStep, getKbaStep, submitKbaPin, IKbaIdentity, submitKbaIdentity, IKbaChallengeResponse, submitKbaChallengeResponse, updateRecipientStatus, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, startSigningSession, getInPersonLink, verifySigner, delegateRecipient, updateRecipient, remindRecipient, resetRecipient, isEnvelopeOwner, isEnvelopeRecipient, canAccessEnvelope, userIsEnvelopeOwner, userIsEnvelopeRecipient, useCanAccessEnvelope, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResult, IDocumentSearchOptions, ICreateEnvelopeRecipientFromTemplate, ICreateEnvelopeRecipientDirectly, ISignerTokenResponse, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, IUpdateRecipientParams, ICreateEnvelopeDocumentFromData, ICreateEnvelopeDocumentFromUri, ICreateEnvelopeDocumentFromFile, ICreateEnvelopeFieldFromTemplate, ICreateEnvelopeFieldDirectly, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, IAuthenticateRecipientViaPasscodeRequest, IAuthenticateRecipientViaEmailRequest, IAuthenticateRecipientViaSMSRequest, IKBAResponse, IAuthenticateRecipientViaKBARequest, TAuthenticateRecipientRequest, 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, getOrganizationChildren, getOrganizationUsage, createOrganization, updateOrganization, deleteOrganization, updateOrganizationLogo, updateOrganizationThumbnail, getEntitlements, getActiveEntitlements, 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, TTemplateVisibilityFilter, IGetTemplatesParams, getTemplates, getTemplate, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, duplicateTemplate, 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, collapseEntitlements, getRTop, getRLeft, getRValue, blobToBase64, rescale, sortFields, 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
|
@@ -1975,23 +1975,6 @@ const getInPersonLink = (endpoint, envelope_id, role_name) => endpoint.api //
|
|
|
1975
1975
|
const verifySigner = (endpoint, params) => endpoint.api //
|
|
1976
1976
|
.post(`/v2/sign/verify`, params)
|
|
1977
1977
|
.then((r) => r.data);
|
|
1978
|
-
// TODO: Use "oneOf" to describe the unions of these two calls.
|
|
1979
|
-
/**
|
|
1980
|
-
* Resend a recipient's invitation. NOTE: User interfaces should rate-limit this operation to
|
|
1981
|
-
* avoid spamming recipients. Excessive use of this endpoint may result in Verdocs rate-limiting
|
|
1982
|
-
* the calling application to prevent abuse. This endpoint will return a 200 OK even if the
|
|
1983
|
-
* no_contact flag is set on the envelope (in which case the call will be ignored).
|
|
1984
|
-
*
|
|
1985
|
-
* @group Recipients
|
|
1986
|
-
* @api PUT /v2/envelopes/:envelope_id/recipients/:role_name Resend Invitation
|
|
1987
|
-
* @apiParam string(format:uuid) envelope_id The envelope to operate on.
|
|
1988
|
-
* @apiParam string role_name The role to operate on.
|
|
1989
|
-
* @apiBody string(enum:'resend') action The operation to perform (resend).
|
|
1990
|
-
* @apiSuccess string . Success message.
|
|
1991
|
-
*/
|
|
1992
|
-
const resendInvitation = (endpoint, envelopeId, roleName) => endpoint.api //
|
|
1993
|
-
.put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'resend' })
|
|
1994
|
-
.then((r) => r.data);
|
|
1995
1978
|
/**
|
|
1996
1979
|
* Delegate a recipient's signing responsibility. The envelope sender must enable this before the
|
|
1997
1980
|
* recipient calls this endpoint, and only the recipient may call it, or the call will be rejected.
|
|
@@ -2017,19 +2000,20 @@ const delegateRecipient = (endpoint, envelopeId, roleName, params) => endpoint.a
|
|
|
2017
2000
|
.put(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'delegate', ...params })
|
|
2018
2001
|
.then((r) => r.data);
|
|
2019
2002
|
/**
|
|
2020
|
-
* Update a recipient. NOTE: User interfaces should rate-limit this operation to
|
|
2021
|
-
*
|
|
2022
|
-
*
|
|
2023
|
-
*
|
|
2003
|
+
* Update a recipient. NOTE: User interfaces should rate-limit this operation to avoid spamming recipients.
|
|
2004
|
+
* Excessive use of this endpoint may result in Verdocs rate-limiting the calling application to prevent
|
|
2005
|
+
* abuse. This endpoint will return a 200 OK even if the no_contact flag is set on the envelope (in which
|
|
2006
|
+
* case the call will be silently ignored).
|
|
2024
2007
|
*
|
|
2025
2008
|
* @group Recipients
|
|
2026
2009
|
* @api PATCH /envelopes/:envelope_id/recipients/:role_name Update Recipient
|
|
2027
2010
|
* @apiParam string(format:uuid) envelope_id The envelope to operate on.
|
|
2028
2011
|
* @apiParam string role_name The role name to update.
|
|
2012
|
+
* @apiBody string(enum:'remind'|'reset') action? Trigger a reminder, or fully reset the recipient
|
|
2029
2013
|
* @apiBody string first_name? Update the recipient's first name.
|
|
2030
2014
|
* @apiBody string last_name? Update the recipient's last name.
|
|
2031
|
-
* @apiBody string email? Update the recipient's email address.
|
|
2032
|
-
* @apiBody string message? Update the recipient's invite message.
|
|
2015
|
+
* @apiBody string email? Update the recipient's email address.
|
|
2016
|
+
* @apiBody string message? Update the recipient's invite message.
|
|
2033
2017
|
* @apiBody string phone? Update the recipient's phone number.
|
|
2034
2018
|
* @apiBody string passcode? If passcode authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed passcode-based auth.
|
|
2035
2019
|
* @apiBody string address? If KBA-based authentication is used, the recipient's address to prefill. May only be changed if the recipient has not already completed KBA-based auth.
|
|
@@ -2043,6 +2027,21 @@ const delegateRecipient = (endpoint, envelopeId, roleName, params) => endpoint.a
|
|
|
2043
2027
|
const updateRecipient = (endpoint, envelopeId, roleName, params) => endpoint.api //
|
|
2044
2028
|
.patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, params)
|
|
2045
2029
|
.then((r) => r.data);
|
|
2030
|
+
/**
|
|
2031
|
+
* Send a reminder to a recipient. The recipient must still be an active member of the signing flow
|
|
2032
|
+
* (e.g. not declined, already submitted, etc.)
|
|
2033
|
+
*/
|
|
2034
|
+
const remindRecipient = (endpoint, envelopeId, roleName) => endpoint.api //
|
|
2035
|
+
.patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'remind' })
|
|
2036
|
+
.then((r) => r.data);
|
|
2037
|
+
/**
|
|
2038
|
+
* Fully reset a recipient. This allows the recipient to restart failed KBA flows, change
|
|
2039
|
+
* fields they may have filled in incorrectly while signing, etc. This cannot be used on a
|
|
2040
|
+
* canceled or completed envelope, but may be used to restart an envelope marked declined.
|
|
2041
|
+
*/
|
|
2042
|
+
const resetRecipient = (endpoint, envelopeId, roleName) => endpoint.api //
|
|
2043
|
+
.patch(`/v2/envelopes/${envelopeId}/recipients/${encodeURIComponent(roleName)}`, { action: 'reset' })
|
|
2044
|
+
.then((r) => r.data);
|
|
2046
2045
|
|
|
2047
2046
|
/**
|
|
2048
2047
|
* Various helpers to identify available operations for an envelope by a user.
|
|
@@ -3857,11 +3856,12 @@ exports.randomString = randomString;
|
|
|
3857
3856
|
exports.recipientCanAct = recipientCanAct;
|
|
3858
3857
|
exports.recipientHasAction = recipientHasAction;
|
|
3859
3858
|
exports.refreshToken = refreshToken;
|
|
3859
|
+
exports.remindRecipient = remindRecipient;
|
|
3860
3860
|
exports.rescale = rescale;
|
|
3861
|
-
exports.resendInvitation = resendInvitation;
|
|
3862
3861
|
exports.resendOrganizationInvitation = resendOrganizationInvitation;
|
|
3863
3862
|
exports.resendVerification = resendVerification;
|
|
3864
3863
|
exports.resetPassword = resetPassword;
|
|
3864
|
+
exports.resetRecipient = resetRecipient;
|
|
3865
3865
|
exports.rotateApiKey = rotateApiKey;
|
|
3866
3866
|
exports.setWebhooks = setWebhooks;
|
|
3867
3867
|
exports.sortFields = sortFields;
|