@verdocs/js-sdk 3.7.7 → 3.8.0

package/Templates/Actions.d.ts

@@ -1,4 +1,4 @@
-import { ITemplate, ITemplateSummaryEntry } from './Types';
+import { ITemplate, ITemplateSummary } from './Types';
 import { TSession } from '../Sessions/Types';
 export declare enum TemplateSenderTypes {
     CREATOR = "creator",
@@ -19,7 +19,7 @@ export declare enum TemplatePermissions {
     TEMPLATE_MEMBER_VISIBILITY = "template:member:visibility"
 }
 export type TTemplateActions = 'create_personal' | 'create_org' | 'create_public' | 'read' | 'write' | 'delete' | 'change_visibility_personal' | 'change_visibility_org' | 'change_visibility_public';
-export declare const canPerformTemplateAction: (session: TSession, action: TTemplateActions, template?: ITemplate | ITemplateSummaryEntry) => {
+export declare const canPerformTemplateAction: (session: TSession, action: TTemplateActions, template?: ITemplate | ITemplateSummary) => {
     canPerform: boolean;
     message: string;
 };

package/Templates/Permissions.d.ts

@@ -3,16 +3,16 @@
  *
  * @module
  */
-import { ITemplate, ITemplateSummaryEntry } from './Types';
+import { ITemplate, ITemplateSummary } from './Types';
 import { TSession } from '../Sessions/Types';
 /**
  * Check to see if the user created the template.
  */
-export declare const userIsTemplateCreator: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean | null;
+export declare const userIsTemplateCreator: (session: TSession, template: ITemplate | ITemplateSummary) => boolean | null;
 /**
  * Check to see if a template is "shared" with the user.
  */
-export declare const userHasSharedTemplate: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean | null;
+export declare const userHasSharedTemplate: (session: TSession, template: ITemplate | ITemplateSummary) => boolean | null;
 /**
  * Check to see if the user can create a personal/private template.
  */
@@ -28,35 +28,35 @@ export declare const userCanCreatePublicTemplate: (session: TSession) => boolean
 /**
  * Check to see if the user can read/view a template.
  */
-export declare const userCanReadTemplate: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean | null;
+export declare const userCanReadTemplate: (session: TSession, template: ITemplate | ITemplateSummary) => boolean | null;
 /**
  * Check to see if the user can update a tempate.
  */
-export declare const userCanUpdateTemplate: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean | null;
+export declare const userCanUpdateTemplate: (session: TSession, template: ITemplate | ITemplateSummary) => boolean | null;
 /**
  * Check to see if the user can change whether a template is personal vs org-shared.
  */
-export declare const userCanMakeTemplatePrivate: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean;
+export declare const userCanMakeTemplatePrivate: (session: TSession, template: ITemplate | ITemplateSummary) => boolean;
 /**
  * Check to see if the user can change whether a template is personal vs org-shared.
  */
-export declare const userCanMakeTemplateShared: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean;
+export declare const userCanMakeTemplateShared: (session: TSession, template: ITemplate | ITemplateSummary) => boolean;
 /**
  * Check to see if the user can change whether a template is personal vs org-shared.
  */
-export declare const userCanMakeTemplatePublic: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean;
+export declare const userCanMakeTemplatePublic: (session: TSession, template: ITemplate | ITemplateSummary) => boolean;
 /**
  * Check to see if the user can change whether a template is personal vs org-shared.
  */
-export declare const userCanChangeOrgVisibility: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean | null;
+export declare const userCanChangeOrgVisibility: (session: TSession, template: ITemplate | ITemplateSummary) => boolean | null;
 /**
  * Check to see if the user can change whether a template is personal vs org-shared.
  */
-export declare const userCanDeleteTemplate: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean;
+export declare const userCanDeleteTemplate: (session: TSession, template: ITemplate | ITemplateSummary) => boolean;
 /**
  * Confirm whether the user can create an envelope using the specified template.
  */
-export declare const userCanSendTemplate: (session: TSession, template: ITemplate | ITemplateSummaryEntry) => boolean | null;
+export declare const userCanSendTemplate: (session: TSession, template: ITemplate | ITemplateSummary) => boolean | null;
 /**
  * Confirm whether the user can create a new template.
  */

package/Templates/Stars.d.ts

@@ -1,4 +1,4 @@
-import { IStar, ITemplateSummaryEntry } from './Types';
+import { IStar, ITemplateSummary } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 /**
  * Get the template stars for a template.
@@ -7,4 +7,4 @@ export declare const getStars: (endpoint: VerdocsEndpoint, templateId: string) =
 /**
  * Toggle the template star for a template.
  */
-export declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateSummaryEntry>;
+export declare const toggleStar: (endpoint: VerdocsEndpoint, templateId: string) => Promise<ITemplateSummary>;

package/Templates/Templates.d.ts

@@ -4,7 +4,7 @@
  *
  * @module
  */
-import { IRole, ITemplate, ITemplateField, ITemplateOwnerInfo, ITemplatesSearchResult, ITemplatesSummary, TTemplateSender } from './Types';
+import { IRole, ITemplate, ITemplateField, ITemplateOwnerInfo, ITemplateSummaries, ITemplateSummary, TTemplateSender } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
 export interface IGetTemplatesParams {
     is_starred?: boolean;
@@ -41,10 +41,7 @@ export interface IListTemplatesParams {
  * await Templates.listTemplates((VerdocsEndpoint.getDefault(), { sharing: 'personal', sort: 'last_used_at' });
  * ```
  */
-export declare const listTemplates: (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) => Promise<{
-    records: ITemplate[];
-    total: number;
-}>;
+export declare const listTemplates: (endpoint: VerdocsEndpoint, params?: IListTemplatesParams) => Promise<ITemplateSummaries>;
 /**
  * Get one template by its ID.
  *
@@ -158,7 +155,7 @@ export declare const deleteTemplate: (endpoint: VerdocsEndpoint, templateId: str
  * const {result, page, total} = await Templates.search((VerdocsEndpoint.getDefault(), { ... });
  * ```
  */
-export declare const searchTemplates: (endpoint: VerdocsEndpoint, params: any) => Promise<ITemplatesSearchResult>;
+export declare const searchTemplates: (endpoint: VerdocsEndpoint, params: any) => Promise<ITemplateSummaries>;
 export interface ISearchTimeRange {
     start_time: string;
     end_time: string;
@@ -191,7 +188,7 @@ export interface IGetTemplateSummaryParams {
  * const summary = await Templates.getSummary((VerdocsEndpoint.getDefault(), 0);
  * ```
  */
-export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTemplateSummaryParams) => Promise<ITemplatesSummary>;
+export declare const getSummary: (endpoint: VerdocsEndpoint, params?: IGetTemplateSummaryParams) => Promise<ITemplateSummary>;
 /**
  * Wrapper for `getTemplate()` that limits queries to one every 2 seconds per template ID.
  * This is intended for use in component hierarchies that all rely on the same template

package/Templates/Types.d.ts

@@ -107,14 +107,16 @@ export interface ITemplate {
 /**
  * Some template search and list endpoints return only a partial set of fields for each entry via this structure.
  */
-export interface ITemplateSummaryEntry {
+export interface ITemplateSummary {
     id: string;
     name: string;
+    description: string | null;
     sender: TTemplateSender;
     counter: number;
-    description: string | null;
+    star_counter: number;
     created_at: string;
     updated_at: string;
+    last_used_at: string | null;
     /**
      * If true, the template is considered "sendable" (it has at least one signer, and every signer has at least one field.)
      */
@@ -123,11 +125,9 @@ export interface ITemplateSummaryEntry {
     is_public: boolean;
     profile_id: string;
     organization_id: string;
-    last_used_at: string | null;
-    document_name: string | null;
-    star_counter: number;
-    tag_name: string | null;
-    is_starred: boolean;
+    reminder_id: string;
+    tags: string[];
+    allowed_operations: TemplateActions[];
 }
 export declare enum TemplateSenderTypes {
     CREATOR = "creator",
@@ -180,15 +180,11 @@ export declare enum SortOptions {
     COUNTER = "counter",
     STAR_COUNTER = "star_counter"
 }
-export interface ITemplatesSummary {
-    page: number;
-    total: number;
-    result: ITemplateSummaryEntry[];
-}
-export interface ITemplatesSearchResult {
+export interface ITemplateSummaries {
     page: number;
+    rows: number;
     total: number;
-    result: ITemplate[];
+    records: ITemplateSummary[];
 }
 export interface ITemplateTag {
     tag_name: string;

package/package.json

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