@verdocs/js-sdk 3.10.4 → 3.10.5
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 +11 -20
- package/Envelopes/Envelopes.js +5 -5
- 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,23 @@ 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<IEnvelope[]>;
|
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
|
};
|