@verdocs/js-sdk 1.0.1 → 1.0.5

package/README.md

@@ -2,15 +2,22 @@
 
 > Verdocs SDK for Javascript / Typescript
 
-This SDK provides convenience wrappers for both Browser-based and NodeJS applications with strong typing and documentation to help
-you get started quickly developing for the Verdocs platform.
+This SDK provides convenience wrappers for both Browser-based and NodeJS applications to call the Verdocs API, with strong typing and
+documentation to help you get started quickly developing for the Verdocs platform.
 
-## Usage
+## Getting Started
 
-We will shortly be adding code samples, tutorials, and guides. Until then, please refer to the
-[API Documentation](https://github.com/Verdocs/js-sdk/tree/main/doc-md). Note that this package is namespaced into packages that organize
-API calls into functional groups. A top-level `export *` is provided for simplicity, but to enable Tree Shaking to do its job, it is
-recommended that you only import the package required for a given task, e.g.:
+First add this module to your project:
+
+    npm install --save @verdocs/js-sdk
+
+or:
+
+    yarn add @verdocs/js-sdk
+
+This package is namespaced into packages that organize API calls into functional groups. A top-level `export *` is provided for simplicity,
+but to enable Tree Shaking to do its job, it is recommended that you only import the package required for a given task. For example, to
+perform a simple authentication request:
 
 ```typescript
 import {Auth} from '@verdocs/js-sdk/Auth';
@@ -20,6 +27,19 @@ const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', pass
 Endpoint.setAuthToken(accessToken);
 ```
 
+## Documentation
+
+Verdocs functions are organized into high-level modules that represent the main objects within the platform:
+
+- Documents - An individual document to be signed. Documents are created from templates.
+- HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
+- Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
+- Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
+- Users - All operations related to authentication and user-related operations.
+- Utils - General support functions used by the other modules and exported for convenience.
+
+Please see the [API Docs](https://github.com/Verdocs/js-sdk/tree/main/docs) for details on the functions provided by each module.
+
 ## HTTP Transport
 
 The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
@@ -35,5 +55,5 @@ Endpoint.defaults.timeout = 5000;
 
 ## Contributing
 
-Although we at Verdocs actively maintain this SDK, we welcome community contributions and suggestions! Please file a pull request
-with any change requests and we will review them as soon as possible.
+This repository is actively maintained and supported by [Verdocs](https://verdocs.com/). We welcome community contributions and
+suggestions! Please file a pull request with any change requests and we will review them as soon as possible.

package/dist/Documents/Documents.d.ts

@@ -77,6 +77,7 @@ export interface IDocument {
     status: IDocumentStatus;
     template_id: string;
     updated_at: string;
+    organization_id: string | null;
 }
 export interface IActivityEntry {
     id: string;

package/dist/Organizations/ApiKeys.d.ts

@@ -1,3 +1,15 @@
+/**
+ * API keys are used to authenticate server-to-server calls. (API keys should **never** be used for client-to-server operations!)
+ * To generate a key, either use the Verdocs admin interface and make note of the client_id and client_secret generated, or call
+ * createKey as shown below. Then call {@link Users.Auth.authenticateApp} to obtain an access token using the provided ID and
+ * secret. Note that server-to-server authentication requests return shorter-lived tokens, so it is important to check the `exp`
+ * field and re-authenticate as needed for subsequent calls.
+ *
+ * API keys may be updated or rotated at any time. Regular rotation is recommended. Rotation will not expire or invalidate
+ * existing server-to-server sessions, so it may be done at any time without disrupting your application.
+ *
+ * @module
+ */
 import { IApiKey, IApiKeyWithSecret, ICreateApiKeyRequest, IUpdateApiKeyRequest } from './Types';
 /**
  * Get a list of keys for a given organization. The caller must have admin access to the organization.

package/dist/Organizations/ApiKeys.js

@@ -1,3 +1,15 @@
+/**
+ * API keys are used to authenticate server-to-server calls. (API keys should **never** be used for client-to-server operations!)
+ * To generate a key, either use the Verdocs admin interface and make note of the client_id and client_secret generated, or call
+ * createKey as shown below. Then call {@link Users.Auth.authenticateApp} to obtain an access token using the provided ID and
+ * secret. Note that server-to-server authentication requests return shorter-lived tokens, so it is important to check the `exp`
+ * field and re-authenticate as needed for subsequent calls.
+ *
+ * API keys may be updated or rotated at any time. Regular rotation is recommended. Rotation will not expire or invalidate
+ * existing server-to-server sessions, so it may be done at any time without disrupting your application.
+ *
+ * @module
+ */
 import { Endpoint } from '../HTTP/Transport';
 /**
  * Get a list of keys for a given organization. The caller must have admin access to the organization.

package/dist/Organizations/Groups.d.ts

@@ -1,7 +1,35 @@
-export declare const getGroups: (organizationId: string) => Promise<any>;
-export declare const getGroup: (organizationId: string, groupId: string) => Promise<any>;
-export declare const getGroupMembers: (organizationId: string, groupId: string) => Promise<any>;
-export declare const addGroupMembers: (organizationId: string, groupId: string, params: any) => Promise<any>;
-export declare const deleteGroupMembers: (organizationId: string, groupId: string, params: any) => Promise<any>;
-export declare const addGroupPermission: (organizationId: string, groupId: string, permissionId: string, params: any) => Promise<any>;
-export declare const deleteGroupPermission: (organizationId: string, groupId: string, permissionId: string) => Promise<any>;
+/**
+ * Organizations may contain "Groups" of user profiles, called Members. Groups may have permissions assigned that
+ * apply to all Members, making it easy to configure role-based access control (RBAC) within an Organization. Note
+ * that permissions are **additive**. A user may be a member of more than one group, and may also have permissions
+ * assigned directly. In that case, the user will have the combined set of all permissions inherited from all
+ * sources.
+ *
+ * @module
+ */
+import { IGroup, IGroupDetail } from './Types';
+/**
+ * Get a list of groups for a given organization. The caller must have admin access to the organization.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
+export declare const getGroups: (organizationId: string) => Promise<IGroup[]>;
+/**
+ * Get the details for a group.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
+export declare const getGroup: (organizationId: string, groupId: string) => Promise<IGroupDetail>;
+export declare const getMembers: (organizationId: string, groupId: string) => Promise<any>;
+export declare const addMembers: (organizationId: string, groupId: string, params: any) => Promise<any>;
+export declare const deleteMembers: (organizationId: string, groupId: string, params: any) => Promise<any>;
+export declare const addPermission: (organizationId: string, groupId: string, permissionId: string, params: any) => Promise<any>;
+export declare const deletePermission: (organizationId: string, groupId: string, permissionId: string) => Promise<any>;

package/dist/Organizations/Groups.js

@@ -1,22 +1,49 @@
+/**
+ * Organizations may contain "Groups" of user profiles, called Members. Groups may have permissions assigned that
+ * apply to all Members, making it easy to configure role-based access control (RBAC) within an Organization. Note
+ * that permissions are **additive**. A user may be a member of more than one group, and may also have permissions
+ * assigned directly. In that case, the user will have the combined set of all permissions inherited from all
+ * sources.
+ *
+ * @module
+ */
 import { Endpoint } from '../HTTP/Transport';
+/**
+ * Get a list of groups for a given organization. The caller must have admin access to the organization.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
 export var getGroups = function (organizationId) {
     return Endpoint.get("/organizations/" + organizationId + "/groups").then(function (r) { return r.data; });
 };
+/**
+ * Get the details for a group.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
 export var getGroup = function (organizationId, groupId) {
     return Endpoint.get("/organizations/" + organizationId + "/groups/" + groupId).then(function (r) { return r.data; });
 };
-export var getGroupMembers = function (organizationId, groupId) {
+export var getMembers = function (organizationId, groupId) {
     return Endpoint.get("/organizations/" + organizationId + "/groups/" + groupId + "/members").then(function (r) { return r.data; });
 };
-export var addGroupMembers = function (organizationId, groupId, params) {
+export var addMembers = function (organizationId, groupId, params) {
     return Endpoint.post("/organizations/" + organizationId + "/groups/" + groupId + "/members", params).then(function (r) { return r.data; });
 };
-export var deleteGroupMembers = function (organizationId, groupId, params) {
+export var deleteMembers = function (organizationId, groupId, params) {
     return Endpoint.put("/organizations/" + organizationId + "/groups/" + groupId + "/delete_members", params).then(function (r) { return r.data; });
 };
-export var addGroupPermission = function (organizationId, groupId, permissionId, params) {
+export var addPermission = function (organizationId, groupId, permissionId, params) {
     return Endpoint.post("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId, params).then(function (r) { return r.data; });
 };
-export var deleteGroupPermission = function (organizationId, groupId, permissionId) {
+export var deletePermission = function (organizationId, groupId, permissionId) {
     return Endpoint.delete("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId).then(function (r) { return r.data; });
 };

package/dist/Organizations/Types.d.ts

@@ -1,3 +1,4 @@
+import { IProfile, TPermission, TRole } from '../Users/Types';
 export interface IOrganization {
     /** The unique ID of the organization */
     id: string;
@@ -35,3 +36,21 @@ export interface IApiKeyWithSecret extends IApiKey {
     profile_id: string;
     organization_id: string;
 }
+export interface IGroup {
+    id: string;
+    name: string;
+    organization_id: string;
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent_id: string | null;
+    /** Some operations will additionally return a list of permissions. */
+    permissions?: TPermission[];
+    /** Some operations will additionally return a list of roles. */
+    roles?: TRole[];
+    /** Some operations will additionally return a list of profiles. */
+    profiles?: IProfile[];
+}
+export interface IGroupDetail extends IGroup {
+    permissions: TPermission[];
+    roles: TRole[];
+    profiles: IProfile[];
+}

package/dist/Organizations/index.d.ts

@@ -1,3 +1,11 @@
+/**
+ * An Organization is a high-level container within Verdocs that groups together Templates, Documents, Profiles, Billing, and
+ * other settings. A User may be a member of more than one Organization. Each membership is tracked by a Profile representing
+ * that user's settings within that organization. It is important to select the correct Profile before performing operations
+ * against the Verdocs API, as this also sets the Organization that will be operated on, and the user's permissions within it.
+ *
+ * @module
+ */
 export * as ApiKeys from './ApiKeys';
 export * as Groups from './Groups';
 export * as Invitations from './Invitations';

package/dist/Organizations/index.js

@@ -1,3 +1,11 @@
+/**
+ * An Organization is a high-level container within Verdocs that groups together Templates, Documents, Profiles, Billing, and
+ * other settings. A User may be a member of more than one Organization. Each membership is tracked by a Profile representing
+ * that user's settings within that organization. It is important to select the correct Profile before performing operations
+ * against the Verdocs API, as this also sets the Organization that will be operated on, and the user's permissions within it.
+ *
+ * @module
+ */
 export * as ApiKeys from './ApiKeys';
 export * as Groups from './Groups';
 export * as Invitations from './Invitations';

package/dist/Search/Content.d.ts

@@ -0,0 +1,4 @@
+import { ISavedSearch, ISearchHistory, ISearchParams, ISearchResult } from './Types';
+export declare const getSearchHistory: () => Promise<ISearchHistory>;
+export declare const saveSearch: (name: string, params: ISearchParams) => Promise<ISavedSearch>;
+export declare const searchContent: (params: ISearchParams) => Promise<ISearchResult>;

package/dist/Search/Content.js

@@ -0,0 +1,57 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { Endpoint } from '../HTTP/Transport';
+export var getSearchHistory = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.get('/search/history').then(function (r) { return r.data; })];
+}); }); };
+export var saveSearch = function (name, params) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/search/saved', __assign(__assign({}, params), { name: name })).then(function (r) { return r.data; })];
+}); }); };
+export var searchContent = function (params) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/search/content').then(function (r) { return r.data; })];
+}); }); };

package/dist/Search/Types.d.ts

@@ -0,0 +1,68 @@
+import { IDocumentStatus } from '../Documents/Documents';
+export interface IDocumentFile {
+    id: string;
+    url: string;
+    name: string;
+    created_at: string;
+    updated_at: string;
+    page_numbers: number;
+    mime: string;
+}
+export interface IDocumentResult {
+    id: string;
+    name: string;
+    status: IDocumentStatus;
+    profile_id: string;
+    template_id: string;
+    organization_id: string;
+    created_at: string;
+    updated_at: string;
+    canceled_at: string | null;
+    no_contact: boolean;
+    instrument: IDocumentFile;
+    certificate: IDocumentFile | null;
+}
+export interface ITemplateResult {
+    id: string;
+    name: string;
+    status: IDocumentStatus;
+    profile_id: string;
+    template_id: string;
+    organization_id: string;
+    created_at: string;
+    updated_at: string;
+    canceled_at: string | null;
+    no_contact: boolean;
+    instrument: IDocumentFile;
+    certificate: IDocumentFile | null;
+}
+export interface ISearchParams {
+    page?: number;
+    limit?: number;
+}
+export interface IRecentSearch {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    profile_id: string;
+    organization_id: string;
+    params: ISearchParams;
+}
+export interface ISavedSearch {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    profile_id: string;
+    organization_id: string;
+    name: string;
+    params: ISearchParams;
+}
+export interface ISearchHistory {
+    recent: IRecentSearch[];
+    saved: ISavedSearch[];
+}
+export interface ISearchResult {
+    matches: number;
+    templates: any[];
+    documents: IDocumentResult[];
+}

package/dist/Search/Types.js

@@ -0,0 +1 @@
+export {};

package/dist/Search/index.d.ts

@@ -0,0 +1,2 @@
+export * as Content from './Content';
+export * as Types from './Types';

package/dist/Search/index.js

@@ -0,0 +1,2 @@
+export * as Content from './Content';
+export * as Types from './Types';

package/dist/Signatures.d.ts

@@ -0,0 +1,11 @@
+export interface ISignature {
+    id?: string;
+    profile_id: string;
+    url: string;
+    created_at?: Date;
+    updated_at?: Date;
+}
+export declare const createSignature: () => Promise<ISignature>;
+export declare const getSignatures: () => Promise<ISignature[]>;
+export declare const getSignature: (signatureId: string) => Promise<any>;
+export declare const deleteSignature: (signatureId: string) => Promise<any>;

package/dist/Signatures.js

@@ -0,0 +1,7 @@
+import { Endpoint } from './HTTP/Transport';
+export var createSignature = function () { return Endpoint.post('/signatures').then(function (r) { return r.data; }); };
+export var getSignatures = function () { return Endpoint.get('/signatures').then(function (r) { return r.data; }); };
+export var getSignature = function (signatureId) { return Endpoint.get("/signatures/" + signatureId).then(function (r) { return r.data; }); };
+export var deleteSignature = function (signatureId) {
+    return Endpoint.delete("/signatures/" + signatureId).then(function (r) { return r.data; });
+};

package/dist/Tags.d.ts

@@ -0,0 +1,8 @@
+export interface ITags {
+    name: string;
+    featured?: boolean;
+    created_at?: Date;
+}
+export declare const createTag: () => Promise<ITags>;
+export declare const getTag: (tagName: string) => Promise<ITags>;
+export declare const searchTag: () => Promise<ITags[]>;

package/dist/Tags.js

@@ -0,0 +1,4 @@
+import { Endpoint } from './HTTP/Transport';
+export var createTag = function () { return Endpoint.post('/tags').then(function (r) { return r.data; }); };
+export var getTag = function (tagName) { return Endpoint.get("/tags/" + tagName).then(function (r) { return r.data; }); };
+export var searchTag = function () { return Endpoint.get('/tags').then(function (r) { return r.data; }); };

package/dist/Templates/Documents.d.ts

@@ -0,0 +1,4 @@
+export declare const getTemplateDocuments: (templateId: string) => Promise<any>;
+export declare const createTemplateDocument: (templateId: string) => Promise<any>;
+export declare const getTemplateDocument: (templateId: string, documentId: string) => Promise<any>;
+export declare const deleteTemplateDocument: (templateId: string, documentId: string) => Promise<any>;

package/dist/Templates/Documents.js

@@ -0,0 +1,13 @@
+import { Endpoint } from '../HTTP/Transport';
+export var getTemplateDocuments = function (templateId) {
+    return Endpoint.get("/templates/" + templateId + "/documents/").then(function (r) { return r.data; });
+};
+export var createTemplateDocument = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/documents/").then(function (r) { return r.data; });
+};
+export var getTemplateDocument = function (templateId, documentId) {
+    return Endpoint.get("/templates/" + templateId + "/documents/" + documentId).then(function (r) { return r.data; });
+};
+export var deleteTemplateDocument = function (templateId, documentId) {
+    return Endpoint.delete("/templates/" + templateId + "/documents/" + documentId).then(function (r) { return r.data; });
+};

package/dist/Templates/Fields.d.ts

@@ -0,0 +1,3 @@
+export declare const createTemplateField: (templateId: string) => Promise<any>;
+export declare const editTemplateField: (templateId: string, fieldName: string) => Promise<any>;
+export declare const deleteTemplateField: (templateId: string, fieldName: string) => Promise<any>;

package/dist/Templates/Fields.js

@@ -0,0 +1,10 @@
+import { Endpoint } from '../HTTP/Transport';
+export var createTemplateField = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/pages/").then(function (r) { return r.data; });
+};
+export var editTemplateField = function (templateId, fieldName) {
+    return Endpoint.put("/templates/" + templateId + "/pages/" + fieldName).then(function (r) { return r.data; });
+};
+export var deleteTemplateField = function (templateId, fieldName) {
+    return Endpoint.delete("/templates/" + templateId + "/pages/" + fieldName).then(function (r) { return r.data; });
+};

package/dist/Templates/Pages.d.ts

@@ -0,0 +1,4 @@
+export declare const createTemplatePage: (templateId: string) => Promise<any>;
+export declare const editTemplatePage: (templateId: string, sequence: string) => Promise<any>;
+export declare const getTemplatePage: (templateId: string, sequence: string) => Promise<any>;
+export declare const deleteTemplatePage: (templateId: string, sequence: string) => Promise<any>;

package/dist/Templates/Pages.js

@@ -0,0 +1,13 @@
+import { Endpoint } from '../HTTP/Transport';
+export var createTemplatePage = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/pages/").then(function (r) { return r.data; });
+};
+export var editTemplatePage = function (templateId, sequence) {
+    return Endpoint.put("/templates/" + templateId + "/pages/" + sequence).then(function (r) { return r.data; });
+};
+export var getTemplatePage = function (templateId, sequence) {
+    return Endpoint.get("/templates/" + templateId + "/pages/" + sequence).then(function (r) { return r.data; });
+};
+export var deleteTemplatePage = function (templateId, sequence) {
+    return Endpoint.delete("/templates/" + templateId + "/pages/" + sequence).then(function (r) { return r.data; });
+};

package/dist/Templates/Reminders.d.ts

@@ -0,0 +1,4 @@
+export declare const createTemplateReminder: (templateId: string) => Promise<any>;
+export declare const getTemplateReminder: (templateId: string, reminderId: string) => Promise<any>;
+export declare const editTemplateReminder: (templateId: string, reminderId: string) => Promise<any>;
+export declare const deleteTemplateReminder: (templateId: string, reminderId: string) => Promise<any>;

package/dist/Templates/Reminders.js

@@ -0,0 +1,13 @@
+import { Endpoint } from '../HTTP/Transport';
+export var createTemplateReminder = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/reminder/").then(function (r) { return r.data; });
+};
+export var getTemplateReminder = function (templateId, reminderId) {
+    return Endpoint.get("/templates/" + templateId + "/reminder/" + reminderId).then(function (r) { return r.data; });
+};
+export var editTemplateReminder = function (templateId, reminderId) {
+    return Endpoint.put("/templates/" + templateId + "/reminder/" + reminderId).then(function (r) { return r.data; });
+};
+export var deleteTemplateReminder = function (templateId, reminderId) {
+    return Endpoint.delete("/templates/" + templateId + "/reminder/" + reminderId).then(function (r) { return r.data; });
+};

package/dist/Templates/Roles.d.ts

@@ -0,0 +1,6 @@
+export declare const createTemplateRole: (templateId: string) => Promise<any>;
+export declare const getTemplateRoles: (templateId: string) => Promise<any>;
+export declare const getTemplateRole: (templateId: string, roleName: string) => Promise<any>;
+export declare const editTemplateRole: (templateId: string, roleName: string) => Promise<any>;
+export declare const deleteTemplateRole: (templateId: string, roleName: string) => Promise<any>;
+export declare const deleteTemplateSequence: (templateId: string) => Promise<any>;

package/dist/Templates/Roles.js

@@ -0,0 +1,19 @@
+import { Endpoint } from '../HTTP/Transport';
+export var createTemplateRole = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/roles/").then(function (r) { return r.data; });
+};
+export var getTemplateRoles = function (templateId) {
+    return Endpoint.get("/templates/" + templateId + "/roles/").then(function (r) { return r.data; });
+};
+export var getTemplateRole = function (templateId, roleName) {
+    return Endpoint.get("/templates/" + templateId + "/roles/" + roleName).then(function (r) { return r.data; });
+};
+export var editTemplateRole = function (templateId, roleName) {
+    return Endpoint.put("/templates/" + templateId + "/roles/" + roleName).then(function (r) { return r.data; });
+};
+export var deleteTemplateRole = function (templateId, roleName) {
+    return Endpoint.delete("/templates/" + templateId + "/roles/" + roleName).then(function (r) { return r.data; });
+};
+export var deleteTemplateSequence = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/roles/").then(function (r) { return r.data; });
+};

package/dist/Templates/Stars.d.ts

@@ -0,0 +1,2 @@
+export declare const getTemplateStars: (templateId: string) => Promise<any>;
+export declare const toggleTemplateStar: (templateId: string) => Promise<any>;

package/dist/Templates/Stars.js

@@ -0,0 +1,7 @@
+import { Endpoint } from '../HTTP/Transport';
+export var getTemplateStars = function (templateId) {
+    return Endpoint.get("/templates/" + templateId + "/stars/").then(function (r) { return r.data; });
+};
+export var toggleTemplateStar = function (templateId) {
+    return Endpoint.get("/templates/" + templateId + "/stars/toggle").then(function (r) { return r.data; });
+};

package/dist/Templates/Tags.d.ts

@@ -0,0 +1,3 @@
+export declare const createTemplateTag: (templateId: string) => Promise<any>;
+export declare const getTemplateTags: (templateId: string) => Promise<any>;
+export declare const deleteTemplateTag: (templateId: string, tagName: string) => Promise<any>;

package/dist/Templates/Tags.js

@@ -0,0 +1,10 @@
+import { Endpoint } from '../HTTP/Transport';
+export var createTemplateTag = function (templateId) {
+    return Endpoint.post("/templates/" + templateId + "/tags/").then(function (r) { return r.data; });
+};
+export var getTemplateTags = function (templateId) {
+    return Endpoint.get("/templates/" + templateId + "/tags/").then(function (r) { return r.data; });
+};
+export var deleteTemplateTag = function (templateId, tagName) {
+    return Endpoint.post("/templates/" + templateId + "/tags/" + tagName).then(function (r) { return r.data; });
+};

package/dist/Templates/Templates.d.ts

@@ -0,0 +1,7 @@
+import { ITemplatesSummary } from './Types';
+export declare const getTemplates: () => Promise<any>;
+export declare const getTemplate: (templateId: string) => Promise<any>;
+export declare const createTemplate: () => Promise<any>;
+export declare const editTemplate: (templateId: string) => Promise<any>;
+export declare const searchTemplate: () => Promise<any>;
+export declare const getSummary: (page: number) => Promise<ITemplatesSummary>;

package/dist/Templates/Templates.js

@@ -0,0 +1,45 @@
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { Endpoint } from '../HTTP/Transport';
+export var getTemplates = function () { return Endpoint.get('/templates/').then(function (r) { return r.data; }); };
+export var getTemplate = function (templateId) { return Endpoint.get("/templates/" + templateId).then(function (r) { return r.data; }); };
+export var createTemplate = function () { return Endpoint.post('/templates/').then(function (r) { return r.data; }); };
+export var editTemplate = function (templateId) { return Endpoint.put("/templates/" + templateId).then(function (r) { return r.data; }); };
+export var searchTemplate = function () { return Endpoint.post('/templates/search').then(function (r) { return r.data; }); };
+export var getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.post('/templates/summary', { page: page }).then(function (r) { return r.data; })];
+}); }); };

package/dist/Templates/Types.d.ts

@@ -0,0 +1,23 @@
+export interface ITemplateSummaryEntry {
+    id: string;
+    name: string;
+    sender: string;
+    counter: number;
+    description: string | null;
+    created_at: string;
+    updated_at: string;
+    is_personal: boolean;
+    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;
+}
+export interface ITemplatesSummary {
+    page: number;
+    total: number;
+    result: ITemplateSummaryEntry[];
+}

package/dist/Templates/Types.js

@@ -0,0 +1 @@
+export {};

package/dist/Templates/index.d.ts

@@ -0,0 +1,9 @@
+export * as Documents from './Documents';
+export * as Fields from './Fields';
+export * as Pages from './Pages';
+export * as Reminders from './Reminders';
+export * as Roles from './Roles';
+export * as Stars from './Stars';
+export * as Tags from './Tags';
+export * as Templates from './Templates';
+export * as Types from './Types';

package/dist/Templates/index.js

@@ -0,0 +1,9 @@
+export * as Documents from './Documents';
+export * as Fields from './Fields';
+export * as Pages from './Pages';
+export * as Reminders from './Reminders';
+export * as Roles from './Roles';
+export * as Stars from './Stars';
+export * as Tags from './Tags';
+export * as Templates from './Templates';
+export * as Types from './Types';

package/dist/Users/Profiles.d.ts

@@ -1,4 +1,5 @@
-import { ICreateProfileRequest, IGroup, IPermission, IProfile, IRole, ISwitchProfileResponse, IUpdateProfileRequest } from './Types';
+import { ICreateProfileRequest, IPermission, IProfile, IRole, ISwitchProfileResponse, IUpdateProfileRequest } from './Types';
+import { IGroup } from '../Organizations/Types';
 /**
  * Get the user's available profiles. The current profile will be marked with `current: true`.
  *

package/dist/Users/Types.d.ts

@@ -1,14 +1,8 @@
-import { IOrganization } from '../Organizations/Types';
+import { IGroup, IOrganization } from '../Organizations/Types';
 import { TRequestStatus } from '../HTTP/Types';
 export declare type TPermission = 'org:view' | 'member:view' | 'org:update' | 'member:add' | 'member:remove' | 'admin:add' | 'admin:remove' | 'org:delete' | 'org:transfer' | 'owner:add' | 'owner:remove' | 'template:creator:create:personal' | 'template:creator:visibility' | 'template:creator:create:org' | 'template:member:read' | 'template:member:write' | 'template:member:visibility' | 'template:creator:delete' | 'template:member:delete' | 'template:creator:create:public' | 'rform:access' | 'rcommon:access' | 'org:list' | 'org:create';
 export declare type TPlan = 'env:essential' | 'org:standard';
 export declare type TRole = 'owner' | 'basic_user' | 'member';
-export interface IGroup {
-    id: string;
-    name: string;
-    organization_id: string;
-    parent_id: string | null;
-}
 export interface IProfile {
     /** The unique ID of the profile */
     id: string;

package/dist/Validators.d.ts

@@ -0,0 +1,6 @@
+export interface IValidator {
+    name: string;
+    regex: string;
+}
+export declare const getValidators: () => Promise<IValidator[]>;
+export declare const getValidator: (validatorName: string) => Promise<IValidator>;

package/dist/Validators.js

@@ -0,0 +1,5 @@
+import { Endpoint } from './HTTP/Transport';
+export var getValidators = function () { return Endpoint.get('/validators').then(function (r) { return r.data; }); };
+export var getValidator = function (validatorName) {
+    return Endpoint.get("/validators/" + validatorName).then(function (r) { return r.data; });
+};

package/dist/Whitelabel.d.ts

@@ -0,0 +1,2 @@
+export declare const createWhitelabel: () => Promise<any>;
+export declare const getWhitelabel: () => Promise<any>;

package/dist/Whitelabel.js

@@ -0,0 +1,3 @@
+import { Endpoint } from './HTTP/Transport';
+export var createWhitelabel = function () { return Endpoint.post('/whitelabel').then(function (r) { return r.data; }); };
+export var getWhitelabel = function () { return Endpoint.get('/whitelabel').then(function (r) { return r.data; }); };

package/dist/index.d.ts

@@ -1,5 +1,22 @@
+/**
+ * Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:
+ *
+ * - Documents - An individual document to be signed. Documents are created from templates.
+ * - HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
+ * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
+ * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
+ * - Users - All operations related to authentication and user-related operations.
+ * - Utils - General support functions used by the other modules and exported for convenience.
+ *
+ * @module
+ */
 export * as Documents from './Documents';
+export * as Templates from './Templates';
 export * as HTTP from './HTTP';
 export * as Organizations from './Organizations';
+export * as Signatures from './Signatures';
+export * as Tags from './Tags';
 export * as Users from './Users';
 export * as Utils from './Utils';
+export * as Validators from './Validators';
+export * as Whitelabel from './Whitelabel';

package/dist/index.js

@@ -1,5 +1,22 @@
+/**
+ * Verdocs functions are organized into high-level modules that represent the main objects within Verdocs:
+ *
+ * - Documents - An individual document to be signed. Documents are created from templates.
+ * - HTTP - General support functionality for Verdocs' REST endpoints. Typically not used directly.
+ * - Organizations - An Organization is a container for user profiles, templates, documents, billing, and other related objects.
+ * - Templates - A template for a document containing a PDF file, metadata for signature fields, and other information.
+ * - Users - All operations related to authentication and user-related operations.
+ * - Utils - General support functions used by the other modules and exported for convenience.
+ *
+ * @module
+ */
 export * as Documents from './Documents';
+export * as Templates from './Templates';
 export * as HTTP from './HTTP';
 export * as Organizations from './Organizations';
+export * as Signatures from './Signatures';
+export * as Tags from './Tags';
 export * as Users from './Users';
 export * as Utils from './Utils';
+export * as Validators from './Validators';
+export * as Whitelabel from './Whitelabel';

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.0.1",
+  "version": "1.0.5",
   "private": false,
+  "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
   "keywords": [
-    "Verdocs",
+    "pdf",
     "document",
     "signing",
-    "embed",
-    "pdf"
+    "Verdocs",
+    "embed"
   ],
   "author": "Verdocs, LLC",
   "license": "MIT",
@@ -17,6 +18,13 @@
   "files": [
     "dist/**/*"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Verdocs/js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Verdocs/js-sdk/issues"
+  },
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build",
@@ -29,7 +37,7 @@
     "lint": "tslint -p tsconfig.json",
     "docs-md": "typedoc && git add --all docs",
     "docs-html": "typedoc --plugin none --out docs-html",
-    "docs": "npm run docs-md && npm run docs-html"
+    "docs": "npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/"
   },
   "publishConfig": {
     "access": "public"
@@ -37,15 +45,18 @@
   "dependencies": {
     "axios": "^0.21.1"
   },
+  "peerDependencies": {
+    "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x"
+  },
   "devDependencies": {
     "@types/jest": "^27.0.1",
-    "jest": "^27.0.6",
+    "jest": "^27.2.1",
     "jest-mock-axios": "^4.4.0",
     "prettier": "^2.4.1",
     "ts-jest": "^27.0.3",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.22.3",
+    "typedoc": "^0.22.4",
     "typedoc-plugin-markdown": "^3.11.0",
     "typescript": "^4.3.5"
   }