@verdocs/js-sdk 3.1.10 → 3.2.1
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.d.ts
CHANGED
|
@@ -133,7 +133,7 @@ export declare const getEnvelopeRecipients: (endpoint: VerdocsEndpoint, envelope
|
|
|
133
133
|
/**
|
|
134
134
|
* Get all metadata for an Envelope.
|
|
135
135
|
*/
|
|
136
|
-
export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string
|
|
136
|
+
export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => Promise<IEnvelope>;
|
|
137
137
|
/**
|
|
138
138
|
* Get all metadata for an Envelope.
|
|
139
139
|
*/
|
package/Envelopes/Envelopes.js
CHANGED
|
@@ -136,10 +136,10 @@ export var getEnvelopeRecipients = function (endpoint, envelopeId) { return __aw
|
|
|
136
136
|
/**
|
|
137
137
|
* Get all metadata for an Envelope.
|
|
138
138
|
*/
|
|
139
|
-
export var getEnvelope = function (endpoint, envelopeId
|
|
139
|
+
export var getEnvelope = function (endpoint, envelopeId) { return __awaiter(void 0, void 0, void 0, function () {
|
|
140
140
|
return __generator(this, function (_a) {
|
|
141
141
|
return [2 /*return*/, endpoint.api //
|
|
142
|
-
.get("/envelopes/".concat(envelopeId)
|
|
142
|
+
.get("/envelopes/".concat(envelopeId))
|
|
143
143
|
.then(function (r) { return r.data; })];
|
|
144
144
|
});
|
|
145
145
|
}); };
|
|
@@ -277,7 +277,7 @@ export var throttledGetEnvelope = function (endpoint, envelopeId) {
|
|
|
277
277
|
if (cachedEnvelopes[envelopeId] && cachedEnvelopes[envelopeId].loaded + 2000 < new Date().getTime()) {
|
|
278
278
|
return cachedEnvelopes[envelopeId].envelope;
|
|
279
279
|
}
|
|
280
|
-
return getEnvelope(endpoint, envelopeId
|
|
280
|
+
return getEnvelope(endpoint, envelopeId).then(function (envelope) {
|
|
281
281
|
cachedEnvelopes[envelopeId] = { loaded: new Date().getTime(), envelope: envelope };
|
|
282
282
|
return envelope;
|
|
283
283
|
});
|
package/Envelopes/Types.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { IProfile } from '../Users/Types';
|
|
2
|
-
import { IPage } from '../Templates/Types';
|
|
3
2
|
export interface ISigningSessionRequest {
|
|
4
3
|
envelopeId: string;
|
|
5
4
|
roleId: string;
|
|
@@ -54,6 +53,7 @@ export type TRecipientType = `${RecipientTypes}`;
|
|
|
54
53
|
export interface IEnvelopesSearchResultEntry {
|
|
55
54
|
id: string;
|
|
56
55
|
canceled_at: string;
|
|
56
|
+
/** @deprecated. New envelopes may have more than one certificate attached. */
|
|
57
57
|
certificate_document_id: string;
|
|
58
58
|
/** @deprecated. New envelopes may have more than one document attached. */
|
|
59
59
|
envelope_document_id: string;
|
|
@@ -139,15 +139,13 @@ export interface IRecipient {
|
|
|
139
139
|
export interface IEnvelopeDocument {
|
|
140
140
|
id: string;
|
|
141
141
|
envelope_id: string;
|
|
142
|
-
mime: string;
|
|
143
142
|
name: string;
|
|
144
|
-
page_numbers: number;
|
|
145
|
-
updated_at: string;
|
|
146
143
|
url: string;
|
|
147
|
-
|
|
144
|
+
mime: string;
|
|
145
|
+
page_numbers: number;
|
|
148
146
|
type: 'attachment' | 'certificate';
|
|
149
147
|
created_at: string;
|
|
150
|
-
|
|
148
|
+
updated_at: string;
|
|
151
149
|
}
|
|
152
150
|
export interface IDocumentFieldOptions {
|
|
153
151
|
/** The unique ID of the field */
|
|
@@ -244,6 +242,7 @@ export interface IEnvelope {
|
|
|
244
242
|
reminder_id: string | null;
|
|
245
243
|
/** @deprecated. New envelopes will support more than one document attachment so new code should no longer refer to this field. */
|
|
246
244
|
envelope_document_id: string;
|
|
245
|
+
/** @deprecated. New envelopes may have more than one certificate attached. */
|
|
247
246
|
certificate_document_id: string | null;
|
|
248
247
|
/** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
|
|
249
248
|
visibility: 'private' | 'shared';
|
package/Templates/Templates.d.ts
CHANGED
|
@@ -33,7 +33,7 @@ export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemp
|
|
|
33
33
|
* const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
|
|
34
34
|
* ```
|
|
35
35
|
*/
|
|
36
|
-
export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string
|
|
36
|
+
export declare const getTemplate: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplate>;
|
|
37
37
|
/**
|
|
38
38
|
* Get owner information for a template.
|
|
39
39
|
*
|
package/Templates/Templates.js
CHANGED
|
@@ -66,9 +66,9 @@ export var getTemplates = function (endpoint, params) {
|
|
|
66
66
|
* const template = await Templates.getTemplate((VerdocsEndpoint.getDefault(), '83da3d70-7857-4392-b876-c4592a304bc9');
|
|
67
67
|
* ```
|
|
68
68
|
*/
|
|
69
|
-
export var getTemplate = function (endpoint, templateId
|
|
69
|
+
export var getTemplate = function (endpoint, templateId) {
|
|
70
70
|
return endpoint.api //
|
|
71
|
-
.get("/templates/".concat(templateId)
|
|
71
|
+
.get("/templates/".concat(templateId))
|
|
72
72
|
.then(function (r) { return r.data; });
|
|
73
73
|
};
|
|
74
74
|
/**
|
package/Templates/Types.d.ts
CHANGED
|
@@ -290,17 +290,16 @@ export interface IPage {
|
|
|
290
290
|
* @deprecated. New code should use `sequence`
|
|
291
291
|
*/
|
|
292
292
|
page_number: number;
|
|
293
|
-
thumbnail_url?: string;
|
|
294
293
|
/**
|
|
295
|
-
*
|
|
296
|
-
*
|
|
294
|
+
* @deprecated. Clients should not attempt to access images directly. Call `getTemplateDocumentPageDisplayUri()`
|
|
295
|
+
* instead.
|
|
297
296
|
*/
|
|
298
|
-
|
|
297
|
+
thumbnail_url?: string;
|
|
299
298
|
/**
|
|
300
|
-
*
|
|
301
|
-
*
|
|
299
|
+
* @deprecated. Clients should not attempt to access images directly. Call `getTemplateDocumentPageDisplayUri()`
|
|
300
|
+
* instead.
|
|
302
301
|
*/
|
|
303
|
-
|
|
302
|
+
image_uri?: string | null;
|
|
304
303
|
template_document?: ITemplateDocument;
|
|
305
304
|
fields?: ITemplateField[];
|
|
306
305
|
}
|