@verdocs/js-sdk 4.2.48 → 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 +14 -9
- package/dist/index.d.ts +14 -9
- package/dist/index.js +8 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +8 -6
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +1 -1
- package/package.json +1 -1
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,
|
|
@@ -1483,7 +1488,7 @@ declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_i
|
|
|
1483
1488
|
/**
|
|
1484
1489
|
* Update a recipient's status block
|
|
1485
1490
|
*/
|
|
1486
|
-
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>;
|
|
1487
1492
|
/**
|
|
1488
1493
|
* Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
|
|
1489
1494
|
*/
|
|
@@ -1495,7 +1500,7 @@ declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId:
|
|
|
1495
1500
|
/**
|
|
1496
1501
|
* Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
|
|
1497
1502
|
*/
|
|
1498
|
-
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>;
|
|
1499
1504
|
/**
|
|
1500
1505
|
* Agree to electronic signing.
|
|
1501
1506
|
*/
|
|
@@ -1503,7 +1508,7 @@ declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: st
|
|
|
1503
1508
|
/**
|
|
1504
1509
|
* Change a recipient's name.
|
|
1505
1510
|
*/
|
|
1506
|
-
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>;
|
|
1507
1512
|
/**
|
|
1508
1513
|
* Change a recipient's name.
|
|
1509
1514
|
*/
|
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,
|
|
@@ -1483,7 +1488,7 @@ declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelope_i
|
|
|
1483
1488
|
/**
|
|
1484
1489
|
* Update a recipient's status block
|
|
1485
1490
|
*/
|
|
1486
|
-
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>;
|
|
1487
1492
|
/**
|
|
1488
1493
|
* Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
|
|
1489
1494
|
*/
|
|
@@ -1495,7 +1500,7 @@ declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId:
|
|
|
1495
1500
|
/**
|
|
1496
1501
|
* Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
|
|
1497
1502
|
*/
|
|
1498
|
-
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>;
|
|
1499
1504
|
/**
|
|
1500
1505
|
* Agree to electronic signing.
|
|
1501
1506
|
*/
|
|
@@ -1503,7 +1508,7 @@ declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: st
|
|
|
1503
1508
|
/**
|
|
1504
1509
|
* Change a recipient's name.
|
|
1505
1510
|
*/
|
|
1506
|
-
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>;
|
|
1507
1512
|
/**
|
|
1508
1513
|
* Change a recipient's name.
|
|
1509
1514
|
*/
|
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,
|
|
@@ -1559,8 +1561,8 @@ const submitKbaChallengeResponse = (endpoint, envelope_id, role_name, response)
|
|
|
1559
1561
|
/**
|
|
1560
1562
|
* Update a recipient's status block
|
|
1561
1563
|
*/
|
|
1562
|
-
const updateRecipient = async (endpoint,
|
|
1563
|
-
.put(`/envelopes/${
|
|
1564
|
+
const updateRecipient = async (endpoint, envelope_id, role_name, params) => endpoint.api //
|
|
1565
|
+
.put(`/envelopes/${envelope_id}/recipients/${role_name}`, params)
|
|
1564
1566
|
.then((r) => r.data);
|
|
1565
1567
|
/**
|
|
1566
1568
|
* Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
|
|
@@ -1573,7 +1575,7 @@ const envelopeRecipientDecline = (endpoint, envelopeId, roleName) => updateRecip
|
|
|
1573
1575
|
/**
|
|
1574
1576
|
* Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
|
|
1575
1577
|
*/
|
|
1576
|
-
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 });
|
|
1577
1579
|
/**
|
|
1578
1580
|
* Agree to electronic signing.
|
|
1579
1581
|
*/
|
|
@@ -1581,7 +1583,7 @@ const envelopeRecipientAgree = (endpoint, envelopeId, roleName, agreed) => updat
|
|
|
1581
1583
|
/**
|
|
1582
1584
|
* Change a recipient's name.
|
|
1583
1585
|
*/
|
|
1584
|
-
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 });
|
|
1585
1587
|
/**
|
|
1586
1588
|
* Change a recipient's name.
|
|
1587
1589
|
*/
|