@verdocs/js-sdk 4.2.47 → 4.2.49
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 +15 -14
- package/dist/index.d.ts +15 -14
- package/dist/index.js +10 -15
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +11 -15
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +2 -2
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -613,7 +613,7 @@ interface IRecipient {
|
|
|
613
613
|
status: TRecipientStatus;
|
|
614
614
|
email: string;
|
|
615
615
|
phone: string | null;
|
|
616
|
-
full_name
|
|
616
|
+
full_name?: string | null;
|
|
617
617
|
first_name: string;
|
|
618
618
|
last_name: string;
|
|
619
619
|
address: string;
|
|
@@ -1210,11 +1210,13 @@ interface IUpdateRecipientDeclineParams {
|
|
|
1210
1210
|
}
|
|
1211
1211
|
interface IUpdateRecipientClaimEnvelope {
|
|
1212
1212
|
action: "owner_update";
|
|
1213
|
-
|
|
1213
|
+
first_name: string;
|
|
1214
|
+
last_name: string;
|
|
1214
1215
|
email: string;
|
|
1215
1216
|
}
|
|
1216
1217
|
interface IUpdateRecipientStatus {
|
|
1217
|
-
|
|
1218
|
+
first_name?: string;
|
|
1219
|
+
last_name?: string;
|
|
1218
1220
|
agreed?: boolean;
|
|
1219
1221
|
action?: "prepare" | "update";
|
|
1220
1222
|
}
|
|
@@ -1224,7 +1226,8 @@ interface IUpdateRecipientAgreedParams {
|
|
|
1224
1226
|
}
|
|
1225
1227
|
interface IUpdateRecipientNameParams {
|
|
1226
1228
|
action: "update";
|
|
1227
|
-
|
|
1229
|
+
first_name: string;
|
|
1230
|
+
last_name: string;
|
|
1228
1231
|
}
|
|
1229
1232
|
interface IUpdateRecipientPrepareParams {
|
|
1230
1233
|
action: "prepare";
|
|
@@ -1263,7 +1266,8 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
|
|
|
1263
1266
|
* const role1: ICreateEnvelopeRole = {
|
|
1264
1267
|
* type: 'signer',
|
|
1265
1268
|
* name: 'Seller',
|
|
1266
|
-
*
|
|
1269
|
+
* first_name: 'Paige',
|
|
1270
|
+
* last_name: 'Turner',
|
|
1267
1271
|
* email: 'paige.turner@nomail.com',
|
|
1268
1272
|
* phone: '',
|
|
1269
1273
|
* sequence: 1,
|
|
@@ -1274,7 +1278,8 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
|
|
|
1274
1278
|
* const role2: ICreateEnvelopeRole = {
|
|
1275
1279
|
* type: 'signer',
|
|
1276
1280
|
* name: 'Buyer',
|
|
1277
|
-
*
|
|
1281
|
+
* first_name: 'Power',
|
|
1282
|
+
* last_name: 'Power',
|
|
1278
1283
|
* email: 'will.power@nomail.com',
|
|
1279
1284
|
* phone: '',
|
|
1280
1285
|
* sequence: 2,
|
|
@@ -1287,10 +1292,6 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
|
|
|
1287
1292
|
* ```
|
|
1288
1293
|
*/
|
|
1289
1294
|
declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;
|
|
1290
|
-
/**
|
|
1291
|
-
* Get the list of recipients for an Envelope.
|
|
1292
|
-
*/
|
|
1293
|
-
declare const getEnvelopeRecipients: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IRecipient[]>;
|
|
1294
1295
|
/**
|
|
1295
1296
|
* Get all metadata for an Envelope.
|
|
1296
1297
|
*/
|
|
@@ -1487,7 +1488,7 @@ declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_i
|
|
|
1487
1488
|
/**
|
|
1488
1489
|
* Update a recipient's status block
|
|
1489
1490
|
*/
|
|
1490
|
-
declare const updateRecipient: (endpoint: VerdocsEndpoint,
|
|
1491
|
+
declare const updateRecipient: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
|
|
1491
1492
|
/**
|
|
1492
1493
|
* Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
|
|
1493
1494
|
*/
|
|
@@ -1499,7 +1500,7 @@ declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId:
|
|
|
1499
1500
|
/**
|
|
1500
1501
|
* Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
|
|
1501
1502
|
*/
|
|
1502
|
-
declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint,
|
|
1503
|
+
declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, email: string, first_name: string, last_name: string) => Promise<IRecipient>;
|
|
1503
1504
|
/**
|
|
1504
1505
|
* Agree to electronic signing.
|
|
1505
1506
|
*/
|
|
@@ -1507,7 +1508,7 @@ declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: st
|
|
|
1507
1508
|
/**
|
|
1508
1509
|
* Change a recipient's name.
|
|
1509
1510
|
*/
|
|
1510
|
-
declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string,
|
|
1511
|
+
declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, first_name: string, last_name: string) => Promise<IRecipient>;
|
|
1511
1512
|
/**
|
|
1512
1513
|
* Change a recipient's name.
|
|
1513
1514
|
*/
|
|
@@ -2668,4 +2669,4 @@ declare const decodeJWTBody: (token: string) => any;
|
|
|
2668
2669
|
* the presence of the `document_id` field, which will only be present for signing sessions.
|
|
2669
2670
|
*/
|
|
2670
2671
|
declare const decodeAccessTokenBody: (token: string) => TSession;
|
|
2671
|
-
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, 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, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope,
|
|
2672
|
+
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, 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, IReminder, 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, ISignerTokenResponse, getSigningSession, 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, IDocumentSearchOptions, ICreateEnvelopeRecipient, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, 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, 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, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, 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, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
|
package/dist/index.d.ts
CHANGED
|
@@ -613,7 +613,7 @@ interface IRecipient {
|
|
|
613
613
|
status: TRecipientStatus;
|
|
614
614
|
email: string;
|
|
615
615
|
phone: string | null;
|
|
616
|
-
full_name
|
|
616
|
+
full_name?: string | null;
|
|
617
617
|
first_name: string;
|
|
618
618
|
last_name: string;
|
|
619
619
|
address: string;
|
|
@@ -1210,11 +1210,13 @@ interface IUpdateRecipientDeclineParams {
|
|
|
1210
1210
|
}
|
|
1211
1211
|
interface IUpdateRecipientClaimEnvelope {
|
|
1212
1212
|
action: "owner_update";
|
|
1213
|
-
|
|
1213
|
+
first_name: string;
|
|
1214
|
+
last_name: string;
|
|
1214
1215
|
email: string;
|
|
1215
1216
|
}
|
|
1216
1217
|
interface IUpdateRecipientStatus {
|
|
1217
|
-
|
|
1218
|
+
first_name?: string;
|
|
1219
|
+
last_name?: string;
|
|
1218
1220
|
agreed?: boolean;
|
|
1219
1221
|
action?: "prepare" | "update";
|
|
1220
1222
|
}
|
|
@@ -1224,7 +1226,8 @@ interface IUpdateRecipientAgreedParams {
|
|
|
1224
1226
|
}
|
|
1225
1227
|
interface IUpdateRecipientNameParams {
|
|
1226
1228
|
action: "update";
|
|
1227
|
-
|
|
1229
|
+
first_name: string;
|
|
1230
|
+
last_name: string;
|
|
1228
1231
|
}
|
|
1229
1232
|
interface IUpdateRecipientPrepareParams {
|
|
1230
1233
|
action: "prepare";
|
|
@@ -1263,7 +1266,8 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
|
|
|
1263
1266
|
* const role1: ICreateEnvelopeRole = {
|
|
1264
1267
|
* type: 'signer',
|
|
1265
1268
|
* name: 'Seller',
|
|
1266
|
-
*
|
|
1269
|
+
* first_name: 'Paige',
|
|
1270
|
+
* last_name: 'Turner',
|
|
1267
1271
|
* email: 'paige.turner@nomail.com',
|
|
1268
1272
|
* phone: '',
|
|
1269
1273
|
* sequence: 1,
|
|
@@ -1274,7 +1278,8 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
|
|
|
1274
1278
|
* const role2: ICreateEnvelopeRole = {
|
|
1275
1279
|
* type: 'signer',
|
|
1276
1280
|
* name: 'Buyer',
|
|
1277
|
-
*
|
|
1281
|
+
* first_name: 'Power',
|
|
1282
|
+
* last_name: 'Power',
|
|
1278
1283
|
* email: 'will.power@nomail.com',
|
|
1279
1284
|
* phone: '',
|
|
1280
1285
|
* sequence: 2,
|
|
@@ -1287,10 +1292,6 @@ type TCreateEnvelopeRequest = ICreateEnvelopeFromTemplateRequest | ICreateEnvelo
|
|
|
1287
1292
|
* ```
|
|
1288
1293
|
*/
|
|
1289
1294
|
declare const createEnvelope: (endpoint: VerdocsEndpoint, request: TCreateEnvelopeRequest) => Promise<IEnvelope>;
|
|
1290
|
-
/**
|
|
1291
|
-
* Get the list of recipients for an Envelope.
|
|
1292
|
-
*/
|
|
1293
|
-
declare const getEnvelopeRecipients: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IRecipient[]>;
|
|
1294
1295
|
/**
|
|
1295
1296
|
* Get all metadata for an Envelope.
|
|
1296
1297
|
*/
|
|
@@ -1487,7 +1488,7 @@ declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_i
|
|
|
1487
1488
|
/**
|
|
1488
1489
|
* Update a recipient's status block
|
|
1489
1490
|
*/
|
|
1490
|
-
declare const updateRecipient: (endpoint: VerdocsEndpoint,
|
|
1491
|
+
declare const updateRecipient: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
|
|
1491
1492
|
/**
|
|
1492
1493
|
* Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
|
|
1493
1494
|
*/
|
|
@@ -1499,7 +1500,7 @@ declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId:
|
|
|
1499
1500
|
/**
|
|
1500
1501
|
* Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
|
|
1501
1502
|
*/
|
|
1502
|
-
declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint,
|
|
1503
|
+
declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string, email: string, first_name: string, last_name: string) => Promise<IRecipient>;
|
|
1503
1504
|
/**
|
|
1504
1505
|
* Agree to electronic signing.
|
|
1505
1506
|
*/
|
|
@@ -1507,7 +1508,7 @@ declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: st
|
|
|
1507
1508
|
/**
|
|
1508
1509
|
* Change a recipient's name.
|
|
1509
1510
|
*/
|
|
1510
|
-
declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string,
|
|
1511
|
+
declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, first_name: string, last_name: string) => Promise<IRecipient>;
|
|
1511
1512
|
/**
|
|
1512
1513
|
* Change a recipient's name.
|
|
1513
1514
|
*/
|
|
@@ -2668,4 +2669,4 @@ declare const decodeJWTBody: (token: string) => any;
|
|
|
2668
2669
|
* the presence of the `document_id` field, which will only be present for signing sessions.
|
|
2669
2670
|
*/
|
|
2670
2671
|
declare const decodeAccessTokenBody: (token: string) => TSession;
|
|
2671
|
-
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, 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, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope,
|
|
2672
|
+
export { TRequestStatus, TTemplateSenderType, TTemplateAction, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TSortTemplateBy, TAccessKeyType, TApiKeyPermission, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, FIELD_TYPES, DEFAULT_FIELD_WIDTHS, DEFAULT_FIELD_HEIGHTS, 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, IReminder, 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, ISignerTokenResponse, getSigningSession, 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, IDocumentSearchOptions, ICreateEnvelopeRecipient, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeFromTemplateRequest, ICreateEnvelopeDirectlyRequest, TCreateEnvelopeRequest, 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, 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, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, 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, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry };
|
package/dist/index.js
CHANGED
|
@@ -1365,7 +1365,8 @@ class VerdocsEndpoint {
|
|
|
1365
1365
|
* const role1: ICreateEnvelopeRole = {
|
|
1366
1366
|
* type: 'signer',
|
|
1367
1367
|
* name: 'Seller',
|
|
1368
|
-
*
|
|
1368
|
+
* first_name: 'Paige',
|
|
1369
|
+
* last_name: 'Turner',
|
|
1369
1370
|
* email: 'paige.turner@nomail.com',
|
|
1370
1371
|
* phone: '',
|
|
1371
1372
|
* sequence: 1,
|
|
@@ -1376,7 +1377,8 @@ class VerdocsEndpoint {
|
|
|
1376
1377
|
* const role2: ICreateEnvelopeRole = {
|
|
1377
1378
|
* type: 'signer',
|
|
1378
1379
|
* name: 'Buyer',
|
|
1379
|
-
*
|
|
1380
|
+
* first_name: 'Power',
|
|
1381
|
+
* last_name: 'Power',
|
|
1380
1382
|
* email: 'will.power@nomail.com',
|
|
1381
1383
|
* phone: '',
|
|
1382
1384
|
* sequence: 2,
|
|
@@ -1389,13 +1391,7 @@ class VerdocsEndpoint {
|
|
|
1389
1391
|
* ```
|
|
1390
1392
|
*/
|
|
1391
1393
|
const createEnvelope = async (endpoint, request) => endpoint.api //
|
|
1392
|
-
.post('/envelopes', request)
|
|
1393
|
-
.then((r) => r.data);
|
|
1394
|
-
/**
|
|
1395
|
-
* Get the list of recipients for an Envelope.
|
|
1396
|
-
*/
|
|
1397
|
-
const getEnvelopeRecipients = async (endpoint, envelopeId) => endpoint.api //
|
|
1398
|
-
.get(`/envelopes/${envelopeId}/recipients`)
|
|
1394
|
+
.post('/v2/envelopes', request)
|
|
1399
1395
|
.then((r) => r.data);
|
|
1400
1396
|
/**
|
|
1401
1397
|
* Get all metadata for an Envelope.
|
|
@@ -1427,7 +1423,7 @@ const getDocumentPreviewLink = async (endpoint, envelopeId, documentId) => endpo
|
|
|
1427
1423
|
* Cancel an Envelope.
|
|
1428
1424
|
*/
|
|
1429
1425
|
const cancelEnvelope = async (endpoint, envelopeId) => endpoint.api //
|
|
1430
|
-
.put(`/envelopes/${envelopeId}`, { action: 'cancel' })
|
|
1426
|
+
.put(`/v2/envelopes/${envelopeId}`, { action: 'cancel' })
|
|
1431
1427
|
.then((r) => r.data);
|
|
1432
1428
|
/**
|
|
1433
1429
|
* Get (binary download) a file attached to an Envelope. It is important to use this method
|
|
@@ -1565,8 +1561,8 @@ const submitKbaChallengeResponse = (endpoint, envelope_id, role_name, response)
|
|
|
1565
1561
|
/**
|
|
1566
1562
|
* Update a recipient's status block
|
|
1567
1563
|
*/
|
|
1568
|
-
const updateRecipient = async (endpoint,
|
|
1569
|
-
.put(`/envelopes/${
|
|
1564
|
+
const updateRecipient = async (endpoint, envelope_id, role_name, params) => endpoint.api //
|
|
1565
|
+
.put(`/envelopes/${envelope_id}/recipients/${role_name}`, params)
|
|
1570
1566
|
.then((r) => r.data);
|
|
1571
1567
|
/**
|
|
1572
1568
|
* Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
|
|
@@ -1579,7 +1575,7 @@ const envelopeRecipientDecline = (endpoint, envelopeId, roleName) => updateRecip
|
|
|
1579
1575
|
/**
|
|
1580
1576
|
* Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
|
|
1581
1577
|
*/
|
|
1582
|
-
const envelopeRecipientChangeOwner = (endpoint,
|
|
1578
|
+
const envelopeRecipientChangeOwner = (endpoint, envelope_id, role_name, email, first_name, last_name) => updateRecipient(endpoint, envelope_id, role_name, { action: 'owner_update', email, first_name, last_name });
|
|
1583
1579
|
/**
|
|
1584
1580
|
* Agree to electronic signing.
|
|
1585
1581
|
*/
|
|
@@ -1587,7 +1583,7 @@ const envelopeRecipientAgree = (endpoint, envelopeId, roleName, agreed) => updat
|
|
|
1587
1583
|
/**
|
|
1588
1584
|
* Change a recipient's name.
|
|
1589
1585
|
*/
|
|
1590
|
-
const envelopeRecipientUpdateName = (endpoint, envelopeId, roleName,
|
|
1586
|
+
const envelopeRecipientUpdateName = (endpoint, envelopeId, roleName, first_name, last_name) => updateRecipient(endpoint, envelopeId, roleName, { action: 'update', first_name, last_name });
|
|
1591
1587
|
/**
|
|
1592
1588
|
* Change a recipient's name.
|
|
1593
1589
|
*/
|
|
@@ -2870,7 +2866,6 @@ exports.getEnvelope = getEnvelope;
|
|
|
2870
2866
|
exports.getEnvelopeDocument = getEnvelopeDocument;
|
|
2871
2867
|
exports.getEnvelopeDocumentPageDisplayUri = getEnvelopeDocumentPageDisplayUri;
|
|
2872
2868
|
exports.getEnvelopeFile = getEnvelopeFile;
|
|
2873
|
-
exports.getEnvelopeRecipients = getEnvelopeRecipients;
|
|
2874
2869
|
exports.getEnvelopeReminder = getEnvelopeReminder;
|
|
2875
2870
|
exports.getEnvelopes = getEnvelopes;
|
|
2876
2871
|
exports.getFieldAttachment = getFieldAttachment;
|