@verdocs/js-sdk 3.1.3 → 3.1.4
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/Sessions/Types.d.ts +13 -2
- package/package.json +1 -1
package/Sessions/Types.d.ts
CHANGED
|
@@ -4,7 +4,9 @@ export interface ISigningSessionRequest {
|
|
|
4
4
|
roleId: string;
|
|
5
5
|
inviteCode: string;
|
|
6
6
|
}
|
|
7
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* A Signing Session connects a caller to a role within an envelope, and can be used only for calls related to signing that envelope.
|
|
9
|
+
*/
|
|
8
10
|
export interface ISigningSession {
|
|
9
11
|
profile_id: string;
|
|
10
12
|
envelope_id: string;
|
|
@@ -20,7 +22,9 @@ export interface ISigningSession {
|
|
|
20
22
|
iat: number;
|
|
21
23
|
[key: string]: any;
|
|
22
24
|
}
|
|
23
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* A User Session connects a caller to a Verdocs profile, and can be used for any operations that profile may perform.
|
|
27
|
+
*/
|
|
24
28
|
export interface IUserSession {
|
|
25
29
|
sub: string;
|
|
26
30
|
email: string;
|
|
@@ -35,5 +39,12 @@ export interface IUserSession {
|
|
|
35
39
|
plans?: TPlan[];
|
|
36
40
|
[key: string]: any;
|
|
37
41
|
}
|
|
42
|
+
/**
|
|
43
|
+
* Verdocs supports two types of authenticated sessions: User and Signing. Both behave similarly and have similar
|
|
44
|
+
* properties, but signing sessions only have access to a small set of signing-related functions.
|
|
45
|
+
*/
|
|
38
46
|
export type TSessionType = 'user' | 'signing';
|
|
47
|
+
/**
|
|
48
|
+
* An authenticated session within Verdocs, either for signing or regular user-based operations.
|
|
49
|
+
*/
|
|
39
50
|
export type TSession = IUserSession | ISigningSession | null;
|