@verdocs/js-sdk 3.0.18 → 3.0.20
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/Envelopes/Envelopes.js +1 -1
- package/Envelopes/Recipients.js +1 -1
- package/Envelopes/Types.d.ts +12 -9
- package/Search/Content.js +1 -1
- package/Search/Types.d.ts +1 -1
- package/Sessions/Types.d.ts +2 -2
- package/Templates/TemplateDocuments.js +1 -1
- package/Templates/Templates.js +1 -1
- package/Templates/Types.d.ts +3 -2
- package/Users/Notifications.js +1 -1
- package/Users/Types.d.ts +4 -4
- package/VerdocsEndpoint.d.ts +2 -2
- package/package.json +6 -6
package/Envelopes/Envelopes.js
CHANGED
|
@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
13
13
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
14
14
|
function step(op) {
|
|
15
15
|
if (f) throw new TypeError("Generator is already executing.");
|
|
16
|
-
while (_) try {
|
|
16
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
17
17
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
18
18
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
19
19
|
switch (op[0]) {
|
package/Envelopes/Recipients.js
CHANGED
|
@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
13
13
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
14
14
|
function step(op) {
|
|
15
15
|
if (f) throw new TypeError("Generator is already executing.");
|
|
16
|
-
while (_) try {
|
|
16
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
17
17
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
18
18
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
19
19
|
switch (op[0]) {
|
package/Envelopes/Types.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { IProfile } from '../Users/Types';
|
|
2
2
|
import { IPage } from '../Templates/Types';
|
|
3
|
-
export
|
|
3
|
+
export type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
|
|
4
4
|
export interface ISigningSessionRequest {
|
|
5
5
|
envelopeId: string;
|
|
6
6
|
roleId: string;
|
|
@@ -31,9 +31,9 @@ export interface IInPersonAccessKey {
|
|
|
31
31
|
first_used: string | null;
|
|
32
32
|
last_used: string | null;
|
|
33
33
|
}
|
|
34
|
-
export
|
|
35
|
-
export
|
|
36
|
-
export
|
|
34
|
+
export type TEnvelopeStatus = 'complete' | 'pending' | 'in progress' | 'declined' | 'canceled';
|
|
35
|
+
export type TRecipientStatus = 'invited' | 'opened' | 'signed' | 'submitted' | 'canceled' | 'pending' | 'declined';
|
|
36
|
+
export type TRecipientType = 'signer' | 'cc' | 'approver';
|
|
37
37
|
/**
|
|
38
38
|
* One entry in an envelope search result.
|
|
39
39
|
* NOTE: Many of the fields here are undefined unless "summary=true" is included in the search terms
|
|
@@ -118,13 +118,16 @@ export interface IRecipient {
|
|
|
118
118
|
fields?: IDocumentField[];
|
|
119
119
|
}
|
|
120
120
|
export interface IEnvelopeDocument {
|
|
121
|
-
created_at: string;
|
|
122
121
|
id: string;
|
|
122
|
+
envelope_id: string;
|
|
123
123
|
mime: string;
|
|
124
124
|
name: string;
|
|
125
125
|
page_numbers: number;
|
|
126
126
|
updated_at: string;
|
|
127
127
|
url: string;
|
|
128
|
+
processed: boolean;
|
|
129
|
+
type: 'attachment' | 'certificate';
|
|
130
|
+
created_at: string;
|
|
128
131
|
pages?: IPage[];
|
|
129
132
|
}
|
|
130
133
|
export interface IDocumentFieldOptions {
|
|
@@ -167,7 +170,7 @@ export interface IDocumentFieldSettings {
|
|
|
167
170
|
maximum_checked?: number;
|
|
168
171
|
[key: string]: any;
|
|
169
172
|
}
|
|
170
|
-
export
|
|
173
|
+
export type TDocumentFieldType = 'signature' | 'initial' | 'checkbox_group' | 'radio_button_group' | 'textbox' | 'timestamp' | 'date' | 'dropdown' | 'textarea' | 'attachment' | 'payment';
|
|
171
174
|
export interface IDocumentField {
|
|
172
175
|
/**
|
|
173
176
|
* The ID of the document the field is for. For historical reasons, this is called `envelope_id` because documents
|
|
@@ -222,7 +225,7 @@ export interface IEnvelope {
|
|
|
222
225
|
documents?: IEnvelopeDocument[] | null;
|
|
223
226
|
fields?: IDocumentField[];
|
|
224
227
|
}
|
|
225
|
-
export
|
|
228
|
+
export type TEnvelopeUpdateResult = Omit<IEnvelope, 'histories' | 'recipients' | 'certificate' | 'document' | 'fields' | 'profile'>;
|
|
226
229
|
export interface IActivityEntry {
|
|
227
230
|
id: string;
|
|
228
231
|
name: string;
|
|
@@ -259,8 +262,8 @@ export interface IDocumentSearchOptions {
|
|
|
259
262
|
envelope_status?: TEnvelopeStatus[];
|
|
260
263
|
recipient_status?: TEnvelopeStatus[];
|
|
261
264
|
}
|
|
262
|
-
export
|
|
263
|
-
export
|
|
265
|
+
export type THistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
|
|
266
|
+
export type TEventDetail = 'in_app' | 'mail' | 'signer' | '';
|
|
264
267
|
export interface ICreateEnvelopeRole {
|
|
265
268
|
/** The type of role to create. Most participants in standard flows will be "signer" recipients. */
|
|
266
269
|
type: TRecipientType;
|
package/Search/Content.js
CHANGED
|
@@ -20,7 +20,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
20
20
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
21
21
|
function step(op) {
|
|
22
22
|
if (f) throw new TypeError("Generator is already executing.");
|
|
23
|
-
while (_) try {
|
|
23
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
24
24
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
25
25
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
26
26
|
switch (op[0]) {
|
package/Search/Types.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { TTemplateSender } from '../Templates/Types';
|
|
2
2
|
import { TEnvelopeStatus } from '../Envelopes/Types';
|
|
3
|
-
export
|
|
3
|
+
export type TMimeType = 'application/pdf' | string;
|
|
4
4
|
/**
|
|
5
5
|
* An individual hit in a document search result. Note that this schema does not precisely match IDocument because fields
|
|
6
6
|
* are optimized for search performance.
|
package/Sessions/Types.d.ts
CHANGED
|
@@ -35,5 +35,5 @@ export interface IUserSession {
|
|
|
35
35
|
plans?: TPlan[];
|
|
36
36
|
[key: string]: any;
|
|
37
37
|
}
|
|
38
|
-
export
|
|
39
|
-
export
|
|
38
|
+
export type TSessionType = 'user' | 'signing';
|
|
39
|
+
export type TSession = IUserSession | ISigningSession | null;
|
|
@@ -18,7 +18,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
18
18
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
19
19
|
function step(op) {
|
|
20
20
|
if (f) throw new TypeError("Generator is already executing.");
|
|
21
|
-
while (_) try {
|
|
21
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
22
22
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
23
23
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
24
24
|
switch (op[0]) {
|
package/Templates/Templates.js
CHANGED
|
@@ -19,7 +19,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
19
19
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
20
20
|
function step(op) {
|
|
21
21
|
if (f) throw new TypeError("Generator is already executing.");
|
|
22
|
-
while (_) try {
|
|
22
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
23
23
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
24
24
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
25
25
|
switch (op[0]) {
|
package/Templates/Types.d.ts
CHANGED
|
@@ -115,7 +115,7 @@ export interface ITemplateSummaryEntry {
|
|
|
115
115
|
tag_name: string | null;
|
|
116
116
|
is_starred: boolean;
|
|
117
117
|
}
|
|
118
|
-
export
|
|
118
|
+
export type TTemplateSender = 'creator' | 'organization_member' | 'organization_member_as_creator' | 'everyone' | 'everyone_as_creator';
|
|
119
119
|
export declare enum TemplatePermissions {
|
|
120
120
|
TEMPLATE_CREATOR_CREATE_PUBLIC = "template:creator:create:public",
|
|
121
121
|
TEMPLATE_CREATOR_CREATE_ORG = "template:creator:create:org",
|
|
@@ -258,6 +258,7 @@ export interface ITemplateFieldSetting {
|
|
|
258
258
|
export interface IPage {
|
|
259
259
|
template_id: string;
|
|
260
260
|
document_id: string;
|
|
261
|
+
envelope_id: string;
|
|
261
262
|
/**
|
|
262
263
|
* Note: Page numbers are 1-based
|
|
263
264
|
*/
|
|
@@ -266,7 +267,7 @@ export interface IPage {
|
|
|
266
267
|
* @deprecated. New code should use `sequence`
|
|
267
268
|
*/
|
|
268
269
|
page_number: number;
|
|
269
|
-
thumbnail_url
|
|
270
|
+
thumbnail_url?: string;
|
|
270
271
|
/**
|
|
271
272
|
* The storage location for the page once rendered server-side. This can be used to determine whether a page has
|
|
272
273
|
* finished rendering, but cannot be accessed directly - client applications should use display_uri instead.
|
package/Users/Notifications.js
CHANGED
|
@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
13
13
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
14
14
|
function step(op) {
|
|
15
15
|
if (f) throw new TypeError("Generator is already executing.");
|
|
16
|
-
while (_) try {
|
|
16
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
17
17
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
18
18
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
19
19
|
switch (op[0]) {
|
package/Users/Types.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
import { IGroup, IOrganization } from '../Organizations/Types';
|
|
2
|
-
export
|
|
2
|
+
export type TRequestStatus = 'OK' | 'ERROR';
|
|
3
3
|
/**
|
|
4
4
|
* An operation within Verdocs the user may perform.
|
|
5
5
|
*/
|
|
6
|
-
export
|
|
6
|
+
export type TPermission = 'org:view' | 'member:view' | 'org:update' | 'member:add' | 'member:remove' | 'admin:add' | 'admin:remove' | 'org:delete' | 'org:transfer' | 'owner:add' | 'owner:remove' | 'template:creator:create:personal' | 'template:creator:visibility' | 'template:creator:create:org' | 'template:member:read' | 'template:member:write' | 'template:member:visibility' | 'template:creator:delete' | 'template:member:delete' | 'template:creator:create:public' | 'rform:access' | 'rcommon:access' | 'org:list' | 'org:create';
|
|
7
7
|
/**
|
|
8
8
|
* Plans provide access to Verdocs product features.
|
|
9
9
|
*/
|
|
10
|
-
export
|
|
10
|
+
export type TPlan = 'env:essential' | 'org:standard';
|
|
11
11
|
/**
|
|
12
12
|
* Roles provide access to groups of permissions.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export type TRole = 'owner' | 'basic_user' | 'member';
|
|
15
15
|
export interface IProfile {
|
|
16
16
|
/** The unique ID of the profile */
|
|
17
17
|
id: string;
|
package/VerdocsEndpoint.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
2
|
import { TSession, TSessionType } from './Sessions/Types';
|
|
3
|
-
export
|
|
4
|
-
export
|
|
3
|
+
export type TEnvironment = 'verdocs' | 'verdocs-stage';
|
|
4
|
+
export type TSessionChangedListener = (endpoint: VerdocsEndpoint, session: TSession) => void;
|
|
5
5
|
export interface VerdocsEndpointOptions {
|
|
6
6
|
baseURL?: string;
|
|
7
7
|
timeout?: number;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@verdocs/js-sdk",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.20",
|
|
4
4
|
"private": false,
|
|
5
5
|
"homepage": "https://github.com/Verdocs/js-sdk",
|
|
6
6
|
"description": "Verdocs JS SDK",
|
|
@@ -46,22 +46,22 @@
|
|
|
46
46
|
"access": "public"
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"axios": "^1.
|
|
49
|
+
"axios": "^1.3.0"
|
|
50
50
|
},
|
|
51
51
|
"peerDependencies": {
|
|
52
52
|
"typescript": "^4.7.3"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"@jest/globals": "^29.
|
|
56
|
-
"@types/jest": "^29.
|
|
55
|
+
"@jest/globals": "^29.4.1",
|
|
56
|
+
"@types/jest": "^29.4.0",
|
|
57
57
|
"axios-mock-adapter": "^1.21.2",
|
|
58
|
-
"jest": "^29.
|
|
58
|
+
"jest": "^29.4.1",
|
|
59
59
|
"prettier": "^2.8.3",
|
|
60
60
|
"ts-jest": "^29.0.5",
|
|
61
61
|
"tslint": "^6.1.3",
|
|
62
62
|
"tslint-config-prettier": "^1.18.0",
|
|
63
63
|
"typedoc": "^0.23.24",
|
|
64
64
|
"typedoc-plugin-markdown": "^3.14.0",
|
|
65
|
-
"typescript": "^4.
|
|
65
|
+
"typescript": "^4.9.5"
|
|
66
66
|
}
|
|
67
67
|
}
|