@verdocs/js-sdk 3.10.4 → 3.10.6
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 +16 -20
- package/Envelopes/Envelopes.js +5 -5
- package/Templates/Templates.d.ts +1 -2
- package/Templates/Templates.js +1 -1
- package/package.json +1 -1
package/Envelopes/Envelopes.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings
|
|
1
|
+
import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings } from './Types';
|
|
2
2
|
import { ICreateEnvelopeRole, IEnvelopesSearchResult, ISigningSessionRequest } from './Types';
|
|
3
3
|
import { TEnvelopeUpdateResult, TEnvelopeStatus, TRecipientStatus } from './Types';
|
|
4
4
|
import { VerdocsEndpoint } from '../VerdocsEndpoint';
|
|
@@ -214,32 +214,28 @@ export interface ITimeRange {
|
|
|
214
214
|
end: string;
|
|
215
215
|
}
|
|
216
216
|
export interface IListEnvelopesParams {
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
recipient_name?: string;
|
|
220
|
-
field_value?: string;
|
|
221
|
-
visibility?: 'private' | 'shared';
|
|
222
|
-
status?: ('pending' | 'in progress' | 'complete' | 'declined' | 'canceled')[];
|
|
223
|
-
recipient_status?: ('pending' | 'invited' | 'declined' | 'opened' | 'signed' | 'submitted' | 'canceled')[];
|
|
224
|
-
recipient_id?: string;
|
|
225
|
-
updated_at?: ITimeRange;
|
|
226
|
-
canceled_at?: ITimeRange;
|
|
217
|
+
status?: string[];
|
|
218
|
+
q?: string;
|
|
227
219
|
created_at?: ITimeRange;
|
|
228
220
|
is_owner?: boolean;
|
|
229
|
-
|
|
221
|
+
sort_by?: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status';
|
|
230
222
|
template_id?: string;
|
|
231
|
-
|
|
232
|
-
direction?: 'asc' | 'desc';
|
|
233
|
-
page?: number;
|
|
223
|
+
ascending?: boolean;
|
|
234
224
|
rows?: number;
|
|
225
|
+
page?: number;
|
|
235
226
|
}
|
|
236
|
-
/**
|
|
237
|
-
* Lists all
|
|
227
|
+
/**a
|
|
228
|
+
* Lists all envelopes accessible by the caller, with optional filters.
|
|
238
229
|
*
|
|
239
230
|
* ```typescript
|
|
240
|
-
* import {Envelopes} from '@verdocs/js-sdk/
|
|
231
|
+
* import {Envelopes} from '@verdocs/js-sdk/Envelopes';
|
|
241
232
|
*
|
|
242
|
-
* await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), {
|
|
233
|
+
* await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created)at' });
|
|
243
234
|
* ```
|
|
244
235
|
*/
|
|
245
|
-
export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<
|
|
236
|
+
export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<{
|
|
237
|
+
total: number;
|
|
238
|
+
rows: number;
|
|
239
|
+
page: number;
|
|
240
|
+
envelopes: IEnvelope[];
|
|
241
|
+
}>;
|
package/Envelopes/Envelopes.js
CHANGED
|
@@ -327,17 +327,17 @@ export var throttledGetEnvelope = function (endpoint, envelopeId) {
|
|
|
327
327
|
return envelope;
|
|
328
328
|
});
|
|
329
329
|
};
|
|
330
|
-
/**
|
|
331
|
-
* Lists all
|
|
330
|
+
/**a
|
|
331
|
+
* Lists all envelopes accessible by the caller, with optional filters.
|
|
332
332
|
*
|
|
333
333
|
* ```typescript
|
|
334
|
-
* import {Envelopes} from '@verdocs/js-sdk/
|
|
334
|
+
* import {Envelopes} from '@verdocs/js-sdk/Envelopes';
|
|
335
335
|
*
|
|
336
|
-
* await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), {
|
|
336
|
+
* await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created)at' });
|
|
337
337
|
* ```
|
|
338
338
|
*/
|
|
339
339
|
export var listEnvelopes = function (endpoint, params) {
|
|
340
340
|
return endpoint.api //
|
|
341
|
-
.post('/envelopes/list', params
|
|
341
|
+
.post('/envelopes/list', params)
|
|
342
342
|
.then(function (r) { return r.data; });
|
|
343
343
|
};
|
package/Templates/Templates.d.ts
CHANGED
|
@@ -151,7 +151,7 @@ export interface ITimePeriod {
|
|
|
151
151
|
start_time: string;
|
|
152
152
|
end_time: string;
|
|
153
153
|
}
|
|
154
|
-
declare enum SortOptions {
|
|
154
|
+
export declare enum SortOptions {
|
|
155
155
|
CREATED_AT = "created_at",
|
|
156
156
|
UPDATED_AT = "updated_at",
|
|
157
157
|
NAME = "name",
|
|
@@ -233,4 +233,3 @@ export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTempla
|
|
|
233
233
|
* to avoid unnecessary repeat server calls.
|
|
234
234
|
*/
|
|
235
235
|
export declare const throttledGetTemplate: (endpoint: VerdocsEndpoint, templateId: string) => ITemplate | Promise<ITemplate>;
|
|
236
|
-
export {};
|
package/Templates/Templates.js
CHANGED
|
@@ -173,7 +173,7 @@ export var deleteTemplate = function (endpoint, templateId) {
|
|
|
173
173
|
.delete("/templates/".concat(templateId))
|
|
174
174
|
.then(function (r) { return r.data; });
|
|
175
175
|
};
|
|
176
|
-
var SortOptions;
|
|
176
|
+
export var SortOptions;
|
|
177
177
|
(function (SortOptions) {
|
|
178
178
|
SortOptions["CREATED_AT"] = "created_at";
|
|
179
179
|
SortOptions["UPDATED_AT"] = "updated_at";
|