@verdocs/js-sdk 3.10.3 → 3.10.5

package/Envelopes/Envelopes.d.ts

@@ -1,4 +1,4 @@
-import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings, IEnvelopeSummaries } from './Types';
+import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings } from './Types';
 import { ICreateEnvelopeRole, IEnvelopesSearchResult, ISigningSessionRequest } from './Types';
 import { TEnvelopeUpdateResult, TEnvelopeStatus, TRecipientStatus } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
@@ -146,9 +146,14 @@ export declare const getEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string
 export declare const getEnvelopeDocument: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<IEnvelopeDocument>;
 /**
  * Get a pre-signed download link for an Envelope Document. This link expires quickly, so it should
- * be accessed immediately and never shared.
+ * be accessed immediately and never shared. Content-Disposition will be set to "download".
  */
-export declare const getEnvelopeDocumentLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
+export declare const getDocumentDownloadLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
+/**
+ * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
+ * be accessed immediately and never shared. Content-Disposition will be set to "inline".
+ */
+export declare const getDocumentPreviewLink: (endpoint: VerdocsEndpoint, envelopeId: string, documentId: string) => Promise<string>;
 /**
  * Cancel an Envelope.
  */
@@ -209,32 +214,23 @@ export interface ITimeRange {
     end: string;
 }
 export interface IListEnvelopesParams {
-    match?: string;
-    name?: string;
-    recipient_name?: string;
-    field_value?: string;
-    visibility?: 'private' | 'shared';
-    status?: ('pending' | 'in progress' | 'complete' | 'declined' | 'canceled')[];
-    recipient_status?: ('pending' | 'invited' | 'declined' | 'opened' | 'signed' | 'submitted' | 'canceled')[];
-    recipient_id?: string;
-    updated_at?: ITimeRange;
-    canceled_at?: ITimeRange;
+    status?: string[];
+    q?: string;
     created_at?: ITimeRange;
     is_owner?: boolean;
-    is_recipient?: boolean;
+    sort_by?: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status';
     template_id?: string;
-    sort?: 'name' | 'created_at' | 'updated_at' | 'canceled_at' | 'status';
-    direction?: 'asc' | 'desc';
-    page?: number;
+    ascending?: boolean;
     rows?: number;
+    page?: number;
 }
-/**
- * Lists all templates accessible by the caller, with optional filters.
+/**a
+ * Lists all envelopes accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Templates';
+ * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { name: 'test', sort: 'updated_at' });
+ * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created)at' });
  * ```
  */
-export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<IEnvelopeSummaries>;
+export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<IEnvelope[]>;

package/Envelopes/Envelopes.js

@@ -155,12 +155,23 @@ export var getEnvelopeDocument = function (endpoint, envelopeId, documentId) { r
 }); };
 /**
  * Get a pre-signed download link for an Envelope Document. This link expires quickly, so it should
- * be accessed immediately and never shared.
+ * be accessed immediately and never shared. Content-Disposition will be set to "download".
  */
-export var getEnvelopeDocumentLink = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+export var getDocumentDownloadLink = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, endpoint.api //
-                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?link=true"))
+                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?download=true"))
+                .then(function (r) { return r.data; })];
+    });
+}); };
+/**
+ * Get a pre-signed preview link for an Envelope Document. This link expires quickly, so it should
+ * be accessed immediately and never shared. Content-Disposition will be set to "inline".
+ */
+export var getDocumentPreviewLink = function (endpoint, envelopeId, documentId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, endpoint.api //
+                .get("/envelopes/".concat(envelopeId, "/envelope_documents/").concat(documentId, "?preview=true"))
                 .then(function (r) { return r.data; })];
     });
 }); };
@@ -316,17 +327,17 @@ export var throttledGetEnvelope = function (endpoint, envelopeId) {
         return envelope;
     });
 };
-/**
- * Lists all templates accessible by the caller, with optional filters.
+/**a
+ * Lists all envelopes accessible by the caller, with optional filters.
  *
  * ```typescript
- * import {Envelopes} from '@verdocs/js-sdk/Templates';
+ * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { name: 'test', sort: 'updated_at' });
+ * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created)at' });
  * ```
  */
 export var listEnvelopes = function (endpoint, params) {
     return endpoint.api //
-        .post('/envelopes/list', params, { baseURL: endpoint.getBaseURLv2() })
+        .post('/envelopes/list', params)
         .then(function (r) { return r.data; });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.10.3",
+  "version": "3.10.5",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",