@verdocs/js-sdk 1.3.1 → 1.3.3

package/Templates/Tags.d.ts

@@ -1,7 +1,32 @@
-import { ITag, ITags } from './Types';
-export declare const addTemplateTag: (templateId: string, params: any) => Promise<ITag>;
-export declare const getTemplateTags: (templateId: string) => Promise<ITag[]>;
+/**
+ * A Tag is a user-specified label applied to a template. Tags help users organize and find Templates.
+ * recipients. Every Organization has a set of tags "owned" by that Organization and only visible inside it.
+ * Verdocs also provides a set of system-wide "featured" tags available to all Organizations.
+ *
+ * @module
+ */
+import { ITemplateTag, ITag } from './Types';
+/**
+ * Apply a tag to a template.
+ */
+export declare const addTemplateTag: (templateId: string, params: ITag) => Promise<ITemplateTag>;
+/**
+ * Get all tags for a template.
+ */
+export declare const getTemplateTags: (templateId: string) => Promise<ITemplateTag[]>;
+/**
+ * Remove a tag from a template.
+ */
 export declare const deleteTemplateTag: (templateId: string, tagName: string) => Promise<any>;
-export declare const createTag: (params: ITags) => Promise<ITags>;
-export declare const getTag: (tagName: string) => Promise<ITags>;
-export declare const getAllTags: (params: any) => Promise<ITags[]>;
+/**
+ * Create an Organization-wide tag.
+ */
+export declare const createTag: (name: string) => Promise<ITag>;
+/**
+ * Get an Organization-wide tag.
+ */
+export declare const getTag: (name: string) => Promise<ITag>;
+/**
+ * Get all tags available for use by an Organization.
+ */
+export declare const getAllTags: () => Promise<ITag[]>;

package/Templates/Tags.js

@@ -1,31 +1,56 @@
+/**
+ * A Tag is a user-specified label applied to a template. Tags help users organize and find Templates.
+ * recipients. Every Organization has a set of tags "owned" by that Organization and only visible inside it.
+ * Verdocs also provides a set of system-wide "featured" tags available to all Organizations.
+ *
+ * @module
+ */
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Apply a tag to a template.
+ */
 export var addTemplateTag = function (templateId, params) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/tags/"), params)
         .then(function (r) { return r.data; });
 };
+/**
+ * Get all tags for a template.
+ */
 export var getTemplateTags = function (templateId) {
     return getEndpoint()
         .api.get("/templates/".concat(templateId, "/tags/"))
         .then(function (r) { return r.data; });
 };
+/**
+ * Remove a tag from a template.
+ */
 export var deleteTemplateTag = function (templateId, tagName) {
     return getEndpoint()
         .api.post("/templates/".concat(templateId, "/tags/").concat(tagName))
         .then(function (r) { return r.data; });
 };
-export var createTag = function (params) {
+/**
+ * Create an Organization-wide tag.
+ */
+export var createTag = function (name) {
     return getEndpoint()
-        .api.post('/tags', params)
+        .api.post('/tags', { tag_name: name })
         .then(function (r) { return r.data; });
 };
-export var getTag = function (tagName) {
+/**
+ * Get an Organization-wide tag.
+ */
+export var getTag = function (name) {
     return getEndpoint()
-        .api.get("/tags/".concat(tagName))
+        .api.get("/tags/".concat(name))
         .then(function (r) { return r.data; });
 };
-export var getAllTags = function (params) {
+/**
+ * Get all tags available for use by an Organization.
+ */
+export var getAllTags = function () {
     return getEndpoint()
-        .api.get('/tags', params)
+        .api.get('/tags')
         .then(function (r) { return r.data; });
 };

package/Templates/TemplateDocuments.d.ts

@@ -0,0 +1,46 @@
+/**
+ * A TemplateDocument represents a PDF or other attachment in a Template.
+ *
+ * @module
+ */
+import { ITemplateDocument } from './Types';
+/**
+ * Get all the Template Documents associated to a particular Template.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.getDocuments(templateID);
+ * ```
+ */
+export declare const getTemplateDocuments: (templateId: string) => Promise<ITemplateDocument[]>;
+/**
+ * Create a Document for a particular Template.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.createDocument(templateID, params);
+ * ```
+ */
+export declare const createTemplateDocument: (templateId: string, params: any) => Promise<ITemplateDocument>;
+/**
+ * Get a specific Document.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.getDocument(templateID, documentID);
+ * ```
+ */
+export declare const getTemplateDocument: (templateId: string, documentId: string) => Promise<ITemplateDocument>;
+/**
+ * Delete a specific Document.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.deleteDocument(templateID, documentID);
+ * ```
+ */
+export declare const deleteTemplateDocument: (templateId: string, documentId: string) => Promise<any>;

package/Templates/TemplateDocuments.js

@@ -0,0 +1,62 @@
+/**
+ * A TemplateDocument represents a PDF or other attachment in a Template.
+ *
+ * @module
+ */
+import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Get all the Template Documents associated to a particular Template.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.getDocuments(templateID);
+ * ```
+ */
+export var getTemplateDocuments = function (templateId) {
+    return getEndpoint()
+        .api.get("/templates/".concat(templateId, "/documents/"))
+        .then(function (r) { return r.data; });
+};
+/**
+ * Create a Document for a particular Template.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.createDocument(templateID, params);
+ * ```
+ */
+export var createTemplateDocument = function (templateId, params) {
+    return getEndpoint()
+        .api.post("/templates/".concat(templateId, "/documents/"), params)
+        .then(function (r) { return r.data; });
+};
+/**
+ * Get a specific Document.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.getDocument(templateID, documentID);
+ * ```
+ */
+export var getTemplateDocument = function (templateId, documentId) {
+    return getEndpoint()
+        .api.get("/templates/".concat(templateId, "/documents/").concat(documentId))
+        .then(function (r) { return r.data; });
+};
+/**
+ * Delete a specific Document.
+ *
+ * ```typescript
+ * import {TemplateDocument} from '@verdocs/js-sdk/Templates';
+ *
+ * await TemplateDocument.deleteDocument(templateID, documentID);
+ * ```
+ */
+export var deleteTemplateDocument = function (templateId, documentId) {
+    return getEndpoint()
+        .api.delete("/templates/".concat(templateId, "/documents/").concat(documentId))
+        .then(function (r) { return r.data; });
+};

package/Templates/Templates.d.ts

@@ -1,13 +1,58 @@
+/**
+ * A Template defines how a Verdocs signing flow will be performed, including attachments, signing fields, and
+ * recipients.
+ *
+ * @module
+ */
 import { ITemplate, ITemplatesSearchResult, ITemplatesSummary } from './Types';
 export interface IGetTemplatesParams {
     is_starred?: boolean;
     is_creator?: boolean;
     is_organization?: boolean;
 }
+/**
+ * Get all templates accessible by the caller, with optional filters.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * await Templates.getTemplates();
+ * await Templates.getTemplates({ is_starred: true });
+ * await Templates.getTemplates({ is_creator: true });
+ * await Templates.getTemplates({ is_organization: true });
+ * ```
+ */
 export declare const getTemplates: (params?: IGetTemplatesParams) => Promise<any[]>;
+/**
+ * Get one template by its ID.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const template = await Templates.getTemplate('83da3d70-7857-4392-b876-c4592a304bc9');
+ * ```
+ */
 export declare const getTemplate: (templateId: string) => Promise<any>;
+/**
+ * Create a template.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const newTemplate = await Templates.createTemplate({...});
+ * ```
+ */
 export declare const createTemplate: (params: any) => Promise<ITemplate>;
-export declare const editTemplate: (templateId: string, params: any) => Promise<ITemplate>;
+/**
+ * Update a template.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const updatedTemplate = await Templates.updateTemplate('83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * ```
+ */
+export declare const updateTemplate: (templateId: string, params: any) => Promise<ITemplate>;
 /**
  * Search for templates matching various criteria.
  *
@@ -18,4 +63,13 @@ export declare const editTemplate: (templateId: string, params: any) => Promise<
  * ```
  */
 export declare const searchTemplates: (params: any) => Promise<ITemplatesSearchResult>;
+/**
+ * Get a summary of template data, typically used to populate admin panel dashboard pages.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const summary = await Templates.getSummary(0);
+ * ```
+ */
 export declare const getSummary: (page: number) => Promise<ITemplatesSummary>;

package/Templates/Templates.js

@@ -1,3 +1,9 @@
+/**
+ * A Template defines how a Verdocs signing flow will be performed, including attachments, signing fields, and
+ * recipients.
+ *
+ * @module
+ */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -35,22 +41,61 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Get all templates accessible by the caller, with optional filters.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * await Templates.getTemplates();
+ * await Templates.getTemplates({ is_starred: true });
+ * await Templates.getTemplates({ is_creator: true });
+ * await Templates.getTemplates({ is_organization: true });
+ * ```
+ */
 export var getTemplates = function (params) {
     return getEndpoint()
         .api.get('/templates/', { params: params })
         .then(function (r) { return r.data; });
 };
+/**
+ * Get one template by its ID.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const template = await Templates.getTemplate('83da3d70-7857-4392-b876-c4592a304bc9');
+ * ```
+ */
 export var getTemplate = function (templateId) {
     return getEndpoint()
         .api.get("/templates/".concat(templateId))
         .then(function (r) { return r.data; });
 };
+/**
+ * Create a template.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const newTemplate = await Templates.createTemplate({...});
+ * ```
+ */
 export var createTemplate = function (params) {
     return getEndpoint()
         .api.post('/templates/', params)
         .then(function (r) { return r.data; });
 };
-export var editTemplate = function (templateId, params) {
+/**
+ * Update a template.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const updatedTemplate = await Templates.updateTemplate('83da3d70-7857-4392-b876-c4592a304bc9', { name: 'New Name' });
+ * ```
+ */
+export var updateTemplate = function (templateId, params) {
     return getEndpoint()
         .api.put("/templates/".concat(templateId), params)
         .then(function (r) { return r.data; });
@@ -71,6 +116,15 @@ export var searchTemplates = function (params) { return __awaiter(void 0, void 0
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Get a summary of template data, typically used to populate admin panel dashboard pages.
+ *
+ * ```typescript
+ * import {Templates} from '@verdocs/js-sdk/Templates';
+ *
+ * const summary = await Templates.getSummary(0);
+ * ```
+ */
 export var getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, getEndpoint()

package/Templates/Types.d.ts

@@ -1,6 +1,6 @@
 import { IOrganization } from '../Organizations/Types';
 export interface ITemplate {
-    template_document?: ITemplateAsset;
+    template_document?: ITemplateDocument;
     pages?: IPage[];
     roles?: IRole[];
     counter?: number;
@@ -110,13 +110,14 @@ export interface ITemplatesSearchResult {
     total: number;
     result: ITemplate[];
 }
-export interface ITag {
+export interface ITemplateTag {
     tag_name: string;
     template_id: string;
 }
-export interface ITags {
+export interface ITag {
     name: string;
     featured?: boolean;
+    organization_id?: string;
     created_at?: string;
 }
 export interface IStar {
@@ -136,7 +137,7 @@ export interface IRole {
     phone?: string;
     rgba?: string;
 }
-export interface ITemplateAsset {
+export interface ITemplateDocument {
     url: string;
     name: string;
     page_numbers: number;
@@ -180,7 +181,7 @@ export interface IFieldSetting {
 export interface IPage {
     template_id: string;
     document_id: string;
-    template_document?: ITemplateAsset;
+    template_document?: ITemplateDocument;
     sequence: number;
     page_number: number;
     thumbnail_url: string;

package/Templates/Validators.d.ts

@@ -3,6 +3,15 @@ export interface IValidator {
     name: string;
     regex: string;
 }
+/**
+ * Get all defined validators
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Templates';
+ *
+ * await Documents.getDocuments(templateID);
+ * ```
+ */
 export declare const getValidators: () => Promise<IValidator[]>;
 export declare const getValidator: (validatorName: string) => Promise<IValidator>;
 export declare const isValidEmail: (value: string) => boolean;

package/Templates/Validators.js

@@ -1,5 +1,14 @@
 import { simpleE164Validator } from '../Utils/Locales';
 import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Get all defined validators
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Templates';
+ *
+ * await Documents.getDocuments(templateID);
+ * ```
+ */
 export var getValidators = function () {
     return getEndpoint()
         .api.get('/validators')
@@ -16,5 +25,5 @@ export var isValidPhone = function (value) { return simpleE164Validator(value);
 export var isValidRoleName = function (value, roles) { return roles.findIndex(function (role) { return role.name === value; }) !== -1; };
 var TagRegEx = /^[a-zA-Z0-9-]{0,32}$/;
 export var isValidTag = function (value, tags) {
-    return TagRegEx.test(value) || tags.findIndex(function (tag) { return tag.tag_name === value; }) !== -1;
+    return TagRegEx.test(value) || tags.findIndex(function (tag) { return tag.name === value; }) !== -1;
 };

package/Templates/index.d.ts

@@ -1,4 +1,3 @@
-export * as Documents from './Documents';
 export * as Fields from './Fields';
 export * as Pages from './Pages';
 export * as Reminders from './Reminders';
@@ -6,5 +5,6 @@ export * as Roles from './Roles';
 export * as Stars from './Stars';
 export * as Tags from './Tags';
 export * as Templates from './Templates';
+export * as TemplateDocuments from './TemplateDocuments';
 export * as Types from './Types';
 export * as Validators from './Validators';

package/Templates/index.js

@@ -1,4 +1,3 @@
-export * as Documents from './Documents';
 export * as Fields from './Fields';
 export * as Pages from './Pages';
 export * as Reminders from './Reminders';
@@ -6,5 +5,6 @@ export * as Roles from './Roles';
 export * as Stars from './Stars';
 export * as Tags from './Tags';
 export * as Templates from './Templates';
+export * as TemplateDocuments from './TemplateDocuments';
 export * as Types from './Types';
 export * as Validators from './Validators';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -59,8 +59,8 @@
     "ts-jest": "^28.0.5",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.23.5",
-    "typedoc-plugin-markdown": "^3.13.3",
+    "typedoc": "^0.23.9",
+    "typedoc-plugin-markdown": "^3.13.4",
     "typescript": "^4.7.4"
   }
 }

package/Templates/Documents.d.ts

@@ -1,41 +0,0 @@
-import { ITemplateAsset } from './Types';
-/**
- * Get all the Documents associated to a particular Template.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocuments(templateID);
- * ```
- */
-export declare const getDocuments: (templateId: string) => Promise<any>;
-/**
- * Create a Document for a particular Template.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.createDocument(templateID, params);
- * ```
- */
-export declare const createDocument: (templateId: string, params: any) => Promise<ITemplateAsset>;
-/**
- * Get a specific Document.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocument(templateID, documentID);
- * ```
- */
-export declare const getDocument: (templateId: string, documentId: string) => Promise<ITemplateAsset>;
-/**
- * Delete a specific Document.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.deleteDocument(templateID, documentID);
- * ```
- */
-export declare const deleteDocument: (templateId: string, documentId: string) => Promise<any>;

package/Templates/Documents.js

@@ -1,57 +0,0 @@
-import { getEndpoint } from '../HTTP/Transport';
-/**
- * Get all the Documents associated to a particular Template.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocuments(templateID);
- * ```
- */
-export var getDocuments = function (templateId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/documents/"))
-        .then(function (r) { return r.data; });
-};
-/**
- * Create a Document for a particular Template.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.createDocument(templateID, params);
- * ```
- */
-export var createDocument = function (templateId, params) {
-    return getEndpoint()
-        .api.post("/templates/".concat(templateId, "/documents/"), params)
-        .then(function (r) { return r.data; });
-};
-/**
- * Get a specific Document.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.getDocument(templateID, documentID);
- * ```
- */
-export var getDocument = function (templateId, documentId) {
-    return getEndpoint()
-        .api.get("/templates/".concat(templateId, "/documents/").concat(documentId))
-        .then(function (r) { return r.data; });
-};
-/**
- * Delete a specific Document.
- *
- * ```typescript
- * import {Documents} from '@verdocs/js-sdk/Templates';
- *
- * await Documents.deleteDocument(templateID, documentID);
- * ```
- */
-export var deleteDocument = function (templateId, documentId) {
-    return getEndpoint()
-        .api.delete("/templates/".concat(templateId, "/documents/").concat(documentId))
-        .then(function (r) { return r.data; });
-};