@verdocs/js-sdk 3.8.8 → 3.9.0

package/Envelopes/Envelopes.d.ts

@@ -1,4 +1,4 @@
-import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings } from './Types';
+import { IEnvelope, IEnvelopesSummary, IRecipient, IEnvelopeDocument, IEnvelopeFieldSettings, IEnvelopeSummaries } from './Types';
 import { ICreateEnvelopeRole, IEnvelopesSearchResult, ISigningSessionRequest } from './Types';
 import { TEnvelopeUpdateResult, TEnvelopeStatus, TRecipientStatus } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
@@ -199,3 +199,22 @@ export declare const getEnvelopeDocumentPageDisplayUri: (endpoint: VerdocsEndpoi
  * to avoid unnecessary repeat server calls.
  */
 export declare const throttledGetEnvelope: (endpoint: VerdocsEndpoint, envelopeId: string) => IEnvelope | Promise<IEnvelope>;
+export interface IListEnvelopesParams {
+    name?: string;
+    sharing?: 'all' | 'personal' | 'shared' | 'public';
+    starred?: 'all' | 'starred' | 'unstarred';
+    sort?: 'name' | 'created_at' | 'updated_at' | 'last_used_at' | 'counter' | 'star_counter';
+    direction?: 'asc' | 'desc';
+    page?: number;
+    rows?: number;
+}
+/**
+ * Lists all templates accessible by the caller, with optional filters.
+ *
+ * ```typescript
+ * import {Envelopes} from '@verdocs/js-sdk/Templates';
+ *
+ * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { name: 'test', sort: 'updated_at' });
+ * ```
+ */
+export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<IEnvelopeSummaries>;

package/Envelopes/Envelopes.js

@@ -305,3 +305,17 @@ export var throttledGetEnvelope = function (endpoint, envelopeId) {
         return envelope;
     });
 };
+/**
+ * Lists all templates accessible by the caller, with optional filters.
+ *
+ * ```typescript
+ * import {Envelopes} from '@verdocs/js-sdk/Templates';
+ *
+ * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { name: 'test', sort: 'updated_at' });
+ * ```
+ */
+export var listEnvelopes = function (endpoint, params) {
+    return endpoint.api //
+        .post('/envelopes/list', params, { baseURL: endpoint.getBaseURLv2() })
+        .then(function (r) { return r.data; });
+};

package/Envelopes/Types.d.ts

@@ -363,3 +363,28 @@ export interface ICreateEnvelopeRole {
     /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
     message: string;
 }
+export interface IEnvelopeSummary {
+    id: string;
+    profile_id: string;
+    organization_id: string | null;
+    name: string;
+    status: TEnvelopeStatus;
+    template_id: string;
+    created_at: string;
+    updated_at: string;
+    canceled_at: string;
+    envelope_document_id: string;
+    certificate_document_id: string | null;
+    reminder_id: string | null;
+    no_contact: boolean;
+    visibility: 'private' | 'shared';
+    documents: IEnvelopeDocument[];
+    recipients: IRecipient[];
+    fields: IEnvelopeField[];
+}
+export interface IEnvelopeSummaries {
+    page: number;
+    count: number;
+    total: number;
+    records: IEnvelopeSummary[];
+}

package/Templates/Templates.d.ts

@@ -29,6 +29,7 @@ export interface IListTemplatesParams {
     sharing?: 'all' | 'personal' | 'shared' | 'public';
     starred?: 'all' | 'starred' | 'unstarred';
     sort?: 'name' | 'created_at' | 'updated_at' | 'last_used_at' | 'counter' | 'star_counter';
+    direction?: 'asc' | 'desc';
     page?: number;
     rows?: number;
 }

package/Templates/Types.d.ts

@@ -182,7 +182,7 @@ export declare enum SortOptions {
 }
 export interface ITemplateSummaries {
     page: number;
-    rows: number;
+    count: number;
     total: number;
     records: ITemplateSummary[];
 }

package/package.json

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