@verdocs/js-sdk 3.10.5 → 3.10.7

package/Envelopes/Envelopes.d.ts

@@ -230,7 +230,12 @@ export interface IListEnvelopesParams {
  * ```typescript
  * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created)at' });
+ * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
  * ```
  */
-export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<IEnvelope[]>;
+export declare const listEnvelopes: (endpoint: VerdocsEndpoint, params?: IListEnvelopesParams) => Promise<{
+    total: number;
+    rows: number;
+    page: number;
+    envelopes: IEnvelope[];
+}>;

package/Envelopes/Envelopes.js

@@ -333,7 +333,7 @@ export var throttledGetEnvelope = function (endpoint, envelopeId) {
  * ```typescript
  * import {Envelopes} from '@verdocs/js-sdk/Envelopes';
  *
- * await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created)at' });
+ * const {totals, envelopes} = await Envelopes.listEnvelopes((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' });
  * ```
  */
 export var listEnvelopes = function (endpoint, params) {

package/Templates/Templates.d.ts

@@ -4,7 +4,7 @@
  *
  * @module
  */
-import { IRole, ITemplate, ITemplateField, ITemplateOwnerInfo, ITemplateSummaries, ITemplateSummary, TTemplateSender } from './Types';
+import { IRole, ITemplate, ITemplateField, ITemplateOwnerInfo, ITemplateSummary, TTemplateSender } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 export interface IGetTemplatesParams {
     is_starred?: boolean;
@@ -24,15 +24,6 @@ export interface IGetTemplatesParams {
  * ```
  */
 export declare const getTemplates: (endpoint: VerdocsEndpoint, params?: IGetTemplatesParams) => Promise<ITemplate[]>;
-export interface IListTemplatesParams {
-    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.
  *
@@ -42,7 +33,6 @@ export interface IListTemplatesParams {
  * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
  * ```
  */
-export declare const listTemplates: (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) => Promise<ITemplateSummaries>;
 /**
  * Get one template by its ID.
  *
@@ -151,7 +141,7 @@ export interface ITimePeriod {
     start_time: string;
     end_time: string;
 }
-declare enum SortOptions {
+export declare enum SortOptions {
     CREATED_AT = "created_at",
     UPDATED_AT = "updated_at",
     NAME = "name",
@@ -233,4 +223,28 @@ export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTempla
  * to avoid unnecessary repeat server calls.
  */
 export declare const throttledGetTemplate: (endpoint: VerdocsEndpoint, templateId: string) => ITemplate | Promise<ITemplate>;
-export {};
+export interface ITemplateListParams {
+    status?: string[];
+    q?: string;
+    created_at?: ITimePeriod;
+    is_personal?: boolean;
+    is_public?: boolean;
+    sort_by?: SortOptions;
+    ascending?: boolean;
+    rows?: number;
+    page?: number;
+}
+/**
+ * List templates.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
+ */
+export declare const listTemplates: (endpoint: VerdocsEndpoint, params?: ITemplateListParams) => Promise<{
+    total: number;
+    rows: number;
+    page: number;
+    templates: ITemplate[];
+}>;

package/Templates/Templates.js

@@ -57,6 +57,15 @@ export var getTemplates = function (endpoint, params) {
         .post('/templates', { params: params })
         .then(function (r) { return r.data; });
 };
+// export interface IListTemplatesParams {
+//   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.
  *
@@ -66,11 +75,10 @@ export var getTemplates = function (endpoint, params) {
  * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
  * ```
  */
-export var listTemplates = function (endpoint, params) {
-    return endpoint.api //
-        .post('/templates/list', params, { baseURL: endpoint.getBaseURLv2() })
-        .then(function (r) { return r.data; });
-};
+// export const listTemplates = (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) =>
+//   endpoint.api //
+//     .post<ITemplateSummaries>('/templates/list', params, {baseURL: endpoint.getBaseURLv2()})
+//     .then((r) => r.data);
 /**
  * Get one template by its ID.
  *
@@ -173,7 +181,7 @@ export var deleteTemplate = function (endpoint, templateId) {
         .delete("/templates/".concat(templateId))
         .then(function (r) { return r.data; });
 };
-var SortOptions;
+export var SortOptions;
 (function (SortOptions) {
     SortOptions["CREATED_AT"] = "created_at";
     SortOptions["UPDATED_AT"] = "updated_at";
@@ -232,3 +240,21 @@ export var throttledGetTemplate = function (endpoint, templateId) {
         return template;
     });
 };
+/**
+ * List templates.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const {totals, templates} = await Templates.listTemplates((VerdocsEndpoint.getDefault(), { q: 'test', sort: 'created_at' }); * ```
+ */
+export var listTemplates = function (endpoint, params) {
+    if (params === void 0) { params = {}; }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, endpoint.api //
+                    .post('/templates/list', params)
+                    .then(function (r) { return r.data; })];
+        });
+    });
+};

package/package.json

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