@verdocs/js-sdk 2.0.14 → 2.0.15
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/Documents/Documents.d.ts +3 -4
- package/Documents/Types.d.ts +20 -3
- package/Templates/Types.d.ts +3 -10
- package/package.json +1 -1
package/Documents/Documents.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { IDocument, IDocumentsSearchResult, IDocumentsSummary, IRecipient, ISigningSession, ISigningSessionRequest } from './Types';
|
|
2
|
+
import { TDocumentUpdateResult, IDocumentFieldSettings } from './Types';
|
|
2
3
|
import { VerdocsEndpoint } from '../VerdocsEndpoint';
|
|
3
|
-
import { IFieldSetting } from '../Templates/Types';
|
|
4
|
-
import { TDocumentUpdateResult } from './Types';
|
|
5
4
|
/**
|
|
6
5
|
* Get a summary of currently active documents.
|
|
7
6
|
*
|
|
@@ -66,9 +65,9 @@ export declare const getDocumentFile: (endpoint: VerdocsEndpoint, documentId: st
|
|
|
66
65
|
/**
|
|
67
66
|
* Update a Document field. Typically called during the signing process as a Recipient fills in fields.
|
|
68
67
|
*/
|
|
69
|
-
export declare const updateDocumentField: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, value: any) => Promise<
|
|
68
|
+
export declare const updateDocumentField: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, value: any) => Promise<IDocumentFieldSettings>;
|
|
70
69
|
/**
|
|
71
70
|
* Update a Document signature field. Signature fields are ID-driven. Call `Document.createSignature()` first to create a
|
|
72
71
|
* signature for a Recipient, then call `Documents.updateDocumentFieldSignature()` to attach it to a field.
|
|
73
72
|
*/
|
|
74
|
-
export declare const updateDocumentFieldSignature: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, signatureId: string) => Promise<
|
|
73
|
+
export declare const updateDocumentFieldSignature: (endpoint: VerdocsEndpoint, documentId: string, fieldName: string, signatureId: string) => Promise<IDocumentFieldSettings>;
|
package/Documents/Types.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { IFieldSetting } from '../Templates/Types';
|
|
2
1
|
import { IProfile } from '../Users/Types';
|
|
3
2
|
export declare type TRecipientAction = 'submit' | 'decline' | 'prepare' | 'update';
|
|
4
3
|
export interface ITemplateSummaryEntry {
|
|
@@ -136,6 +135,25 @@ export interface IDocumentAsset {
|
|
|
136
135
|
updated_at: string;
|
|
137
136
|
url: string;
|
|
138
137
|
}
|
|
138
|
+
export interface IDocumentFieldSettings {
|
|
139
|
+
type?: string;
|
|
140
|
+
x: number;
|
|
141
|
+
y: number;
|
|
142
|
+
width?: number;
|
|
143
|
+
height?: number;
|
|
144
|
+
value?: number | string;
|
|
145
|
+
result?: any;
|
|
146
|
+
leading?: number;
|
|
147
|
+
alignment?: number;
|
|
148
|
+
upperCase?: boolean;
|
|
149
|
+
options?: any[];
|
|
150
|
+
base64?: string;
|
|
151
|
+
hash?: string;
|
|
152
|
+
ip_address?: string;
|
|
153
|
+
signature_id?: string;
|
|
154
|
+
signed_at?: string;
|
|
155
|
+
[key: string]: any;
|
|
156
|
+
}
|
|
139
157
|
export interface IDocumentField {
|
|
140
158
|
envelope_id: string;
|
|
141
159
|
label: string | null;
|
|
@@ -144,8 +162,7 @@ export interface IDocumentField {
|
|
|
144
162
|
recipient_role: string;
|
|
145
163
|
type: string;
|
|
146
164
|
required: boolean;
|
|
147
|
-
settings?:
|
|
148
|
-
setting?: IFieldSetting;
|
|
165
|
+
settings?: IDocumentFieldSettings;
|
|
149
166
|
validator: string | null;
|
|
150
167
|
prepared?: boolean;
|
|
151
168
|
}
|
package/Templates/Types.d.ts
CHANGED
|
@@ -154,28 +154,21 @@ export interface ITemplateField {
|
|
|
154
154
|
template_id: string;
|
|
155
155
|
type: string;
|
|
156
156
|
required: boolean;
|
|
157
|
-
setting
|
|
157
|
+
setting: ITemplateFieldSetting;
|
|
158
158
|
page_sequence: number;
|
|
159
159
|
validator?: string;
|
|
160
160
|
label?: string;
|
|
161
161
|
}
|
|
162
|
-
export interface
|
|
162
|
+
export interface ITemplateFieldSetting {
|
|
163
163
|
x: number;
|
|
164
164
|
y: number;
|
|
165
|
+
result?: string;
|
|
165
166
|
width?: number;
|
|
166
167
|
height?: number;
|
|
167
|
-
result?: any;
|
|
168
|
-
type?: string;
|
|
169
|
-
value?: string;
|
|
170
168
|
leading?: number;
|
|
171
169
|
alignment?: number;
|
|
172
170
|
upperCase?: boolean;
|
|
173
171
|
options?: any[];
|
|
174
|
-
base64?: string;
|
|
175
|
-
hash?: string;
|
|
176
|
-
ip_address?: string;
|
|
177
|
-
signature_id?: string;
|
|
178
|
-
signed_at?: string;
|
|
179
172
|
[key: string]: any;
|
|
180
173
|
}
|
|
181
174
|
export interface IPage {
|