@verdocs/js-sdk 2.1.0 → 2.1.2
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/Templates/Types.d.ts +31 -15
- package/package.json +1 -1
package/Templates/Types.d.ts
CHANGED
|
@@ -1,26 +1,35 @@
|
|
|
1
1
|
import { IOrganization } from '../Organizations/Types';
|
|
2
|
+
/**
|
|
3
|
+
* A reusable template for creating signable instruments. Templates are used to create Envelopes which contain
|
|
4
|
+
* Documents to sign.
|
|
5
|
+
*/
|
|
2
6
|
export interface ITemplate {
|
|
3
|
-
template_document?: ITemplateDocument;
|
|
4
|
-
pages?: IPage[];
|
|
5
|
-
roles?: IRole[];
|
|
6
|
-
counter?: number;
|
|
7
|
-
star_counter?: number;
|
|
8
|
-
name: string;
|
|
9
7
|
id: string;
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
name: string;
|
|
9
|
+
description?: string;
|
|
10
|
+
sender: TTemplateSender;
|
|
11
|
+
profile_id: string;
|
|
12
|
+
organization_id: string;
|
|
13
|
+
counter: number;
|
|
14
|
+
star_counter: number;
|
|
15
|
+
is_personal: boolean;
|
|
16
|
+
is_public: boolean;
|
|
17
|
+
created_at: string;
|
|
18
|
+
updated_at: string;
|
|
19
|
+
last_used_at: string;
|
|
14
20
|
token?: string;
|
|
15
21
|
reminder_id?: string;
|
|
16
22
|
reminder?: IReminder;
|
|
17
|
-
|
|
18
|
-
is_personal?: boolean;
|
|
19
|
-
is_public?: boolean;
|
|
20
|
-
sender?: TTemplateSender;
|
|
21
|
-
description?: string;
|
|
23
|
+
processed?: boolean;
|
|
22
24
|
organization?: IOrganization;
|
|
25
|
+
roles?: IRole[];
|
|
26
|
+
pages?: IPage[];
|
|
27
|
+
template_document?: ITemplateDocument;
|
|
28
|
+
template_documents?: ITemplateDocument[];
|
|
23
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* Some template search and list endpoints return only a partial set of fields for each entry via this structure.
|
|
32
|
+
*/
|
|
24
33
|
export interface ITemplateSummaryEntry {
|
|
25
34
|
id: string;
|
|
26
35
|
name: string;
|
|
@@ -124,6 +133,9 @@ export interface IStar {
|
|
|
124
133
|
template_id: string;
|
|
125
134
|
profile_id: string;
|
|
126
135
|
}
|
|
136
|
+
/**
|
|
137
|
+
* An individual recipient, CC, or other party in a signing flow.
|
|
138
|
+
*/
|
|
127
139
|
export interface IRole {
|
|
128
140
|
template_id: string;
|
|
129
141
|
name: string;
|
|
@@ -137,6 +149,9 @@ export interface IRole {
|
|
|
137
149
|
phone?: string;
|
|
138
150
|
rgba?: string;
|
|
139
151
|
}
|
|
152
|
+
/**
|
|
153
|
+
* A file attached to the template for display/signing.
|
|
154
|
+
*/
|
|
140
155
|
export interface ITemplateDocument {
|
|
141
156
|
url: string;
|
|
142
157
|
name: string;
|
|
@@ -178,6 +193,7 @@ export interface IPage {
|
|
|
178
193
|
page_number: number;
|
|
179
194
|
thumbnail_url: string;
|
|
180
195
|
image_uri?: string | null;
|
|
196
|
+
display_uri?: string | null;
|
|
181
197
|
template_document?: ITemplateDocument;
|
|
182
198
|
fields?: ITemplateField[];
|
|
183
199
|
}
|