@verdocs/js-sdk 1.0.8 → 1.0.12

package/dist/Organizations/Organizations.js

@@ -0,0 +1,31 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var getOrganizations = function () {
+    return getEndpoint()
+        .get('/organizations')
+        .then(function (r) { return r.data; });
+};
+export var createOrganization = function () {
+    return getEndpoint()
+        .post('/organizations')
+        .then(function (r) { return r.data; });
+};
+export var validateOrganization = function () {
+    return getEndpoint()
+        .get('/organizations/is_valid')
+        .then(function (r) { return r.data; });
+};
+export var deleteOrganization = function (organizationId) {
+    return getEndpoint()
+        .delete("/organizations/" + organizationId)
+        .then(function (r) { return r.data; });
+};
+export var getOrganization = function (organizationId) {
+    return getEndpoint()
+        .get("/organizations/" + organizationId)
+        .then(function (r) { return r.data; });
+};
+export var updateOrganization = function (organizationId, params) {
+    return getEndpoint()
+        .patch("/organizations/" + organizationId, params)
+        .then(function (r) { return r.data; });
+};

package/dist/Organizations/Webhooks.js

@@ -0,0 +1,11 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var getWebhook = function (organizationId) {
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/webhook")
+        .then(function (r) { return r.data; });
+};
+export var updateWebhook = function (organizationId, params) {
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/webhook", params)
+        .then(function (r) { return r.data; });
+};

package/dist/README.md

@@ -0,0 +1,68 @@
+# Verdocs JS SDK
+
+> Verdocs SDK for Javascript / Typescript
+
+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.
+
+## Getting Started
+
+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';
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+const {accessToken} = await Auth.authenticateUser({username: 'MY_USERNAME', password: 'MY_PASSWORD'});
+Transport.setAuthToken(accessToken);
+```
+
+Once you are authenticated, you can use the rest of the controls and embeds within an app. For instance, to provide a simple PDF
+viewer for a document stored within Verdocs:
+
+## 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.
+
+## Contributing
+
+To avoid the presence of the `dist/` distribution directory appearing in package imports, when this project is built, this `README.md`
+and other support files are copied there. Be sure to run `npm version patch` from THIS directory, but the publish command from within
+the `dist` folder.
+
+## HTTP Transport
+
+The underlying transport uses `axios`, a cross-environment (NodeJS vs. Browser) HTTP transport layer. When this SDK is included in a
+project, a `Transport` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
+may be configured by importing it. Please see the [Axios Documentation](https://github.com/axios/axios) for more information on the
+options available. For example, to override the default API call timeout of 3s:
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/Auth/HTTP';
+
+Transport.setTimeout(5000);
+```
+
+## Contributing
+
+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/{Search → dist/Search}/Content.js

@@ -34,7 +34,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { Endpoint } from '../HTTP/Transport';
+import { getEndpoint } from '../HTTP/Transport';
 /**
  * Retrieve recent and saved searches. Note that result counts will be limited to a maximum of 20 entries for each
  * type but this may be expanded in the future. Client UI's should self-limit display counts as needed.
@@ -45,9 +45,13 @@ import { Endpoint } from '../HTTP/Transport';
  * const {recent, saved} = await Content.getSearchHistory();
  * ```
  */
-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 getSearchHistory = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .get('/search/history')
+                .then(function (r) { return r.data; })];
+    });
+}); };
 /**
  * Save a search. If a name is re-used, that saved search will be overwritten with the new parameters.
  *
@@ -57,9 +61,13 @@ export var getSearchHistory = function () { return __awaiter(void 0, void 0, voi
  * const entry = await Documents.saveSearch('W9 Forms', {q: 'w9', type: 'template});
  * ```
  */
-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', { name: name, params: params }).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*/, getEndpoint()
+                .post('/search/saved', { name: name, params: params })
+                .then(function (r) { return r.data; })];
+    });
+}); };
 /**
  * Search for documents matching various criteria.
  *
@@ -69,6 +77,10 @@ export var saveSearch = function (name, params) { return __awaiter(void 0, void
  * const {result, page, total} = await Documents.search({ ... });
  * ```
  */
-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; })];
-}); }); };
+export var searchContent = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .post('/search/content')
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/dist/Signatures.js

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

package/dist/Tags.js

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

package/{Templates → dist/Templates}/Documents.js

@@ -1,4 +1,4 @@
-import { Endpoint } from '../HTTP/Transport';
+import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get all the Documents associated to a particular Template.
  *
@@ -9,7 +9,9 @@ import { Endpoint } from '../HTTP/Transport';
  * ```
  */
 export var getDocuments = function (templateId) {
-    return Endpoint.get("/templates/" + templateId + "/documents/").then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/templates/" + templateId + "/documents/")
+        .then(function (r) { return r.data; });
 };
 /**
  * Create a Document for a particular Template.
@@ -21,7 +23,9 @@ export var getDocuments = function (templateId) {
  * ```
  */
 export var createDocument = function (templateId, params) {
-    return Endpoint.post("/templates/" + templateId + "/documents/", params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post("/templates/" + templateId + "/documents/", params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Get a specific Document.
@@ -33,7 +37,9 @@ export var createDocument = function (templateId, params) {
  * ```
  */
 export var getDocument = function (templateId, documentId) {
-    return Endpoint.get("/templates/" + templateId + "/documents/" + documentId).then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/templates/" + templateId + "/documents/" + documentId)
+        .then(function (r) { return r.data; });
 };
 /**
  * Delete a specific Document.
@@ -45,5 +51,7 @@ export var getDocument = function (templateId, documentId) {
  * ```
  */
 export var deleteDocument = function (templateId, documentId) {
-    return Endpoint.delete("/templates/" + templateId + "/documents/" + documentId).then(function (r) { return r.data; });
+    return getEndpoint()
+        .delete("/templates/" + templateId + "/documents/" + documentId)
+        .then(function (r) { return r.data; });
 };

package/dist/Templates/Fields.js

@@ -0,0 +1,16 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var createField = function (templateId, params) {
+    return getEndpoint()
+        .post("/templates/" + templateId + "/pages/", params)
+        .then(function (r) { return r.data; });
+};
+export var editField = function (templateId, fieldName, params) {
+    return getEndpoint()
+        .put("/templates/" + templateId + "/pages/" + fieldName, params)
+        .then(function (r) { return r.data; });
+};
+export var deleteField = function (templateId, fieldName) {
+    return getEndpoint()
+        .delete("/templates/" + templateId + "/pages/" + fieldName)
+        .then(function (r) { return r.data; });
+};

package/dist/Templates/Pages.js

@@ -0,0 +1,21 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var createPage = function (templateId, params) {
+    return getEndpoint()
+        .post("/templates/" + templateId + "/pages/", params)
+        .then(function (r) { return r.data; });
+};
+export var editPage = function (templateId, sequence) {
+    return getEndpoint()
+        .put("/templates/" + templateId + "/pages/" + sequence)
+        .then(function (r) { return r.data; });
+};
+export var getPage = function (templateId, sequence) {
+    return getEndpoint()
+        .get("/templates/" + templateId + "/pages/" + sequence)
+        .then(function (r) { return r.data; });
+};
+export var deletePage = function (templateId, sequence) {
+    return getEndpoint()
+        .delete("/templates/" + templateId + "/pages/" + sequence)
+        .then(function (r) { return r.data; });
+};

package/dist/Templates/Reminders.js

@@ -0,0 +1,21 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var createReminder = function (templateId, params) {
+    return getEndpoint()
+        .post("/templates/" + templateId + "/reminder/", params)
+        .then(function (r) { return r.data; });
+};
+export var getReminder = function (templateId, reminderId) {
+    return getEndpoint()
+        .get("/templates/" + templateId + "/reminder/" + reminderId)
+        .then(function (r) { return r.data; });
+};
+export var editReminder = function (templateId, reminderId) {
+    return getEndpoint()
+        .put("/templates/" + templateId + "/reminder/" + reminderId)
+        .then(function (r) { return r.data; });
+};
+export var deleteReminder = function (templateId, reminderId) {
+    return getEndpoint()
+        .delete("/templates/" + templateId + "/reminder/" + reminderId)
+        .then(function (r) { return r.data; });
+};

package/dist/Templates/Roles.js

@@ -0,0 +1,36 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var createRole = function (templateId, params) {
+    return getEndpoint()
+        .post("/templates/" + templateId + "/roles/", params)
+        .then(function (r) { return r.data; });
+};
+export var getRoles = function (templateId) {
+    return getEndpoint()
+        .get("/templates/" + templateId + "/roles/")
+        .then(function (r) { return r.data; });
+};
+export var getRole = function (templateId, roleName) {
+    return getEndpoint()
+        .get("/templates/" + templateId + "/roles/" + roleName)
+        .then(function (r) { return r.data; });
+};
+export var editRole = function (templateId, roleName, params) {
+    return getEndpoint()
+        .put("/templates/" + templateId + "/roles/" + roleName, params)
+        .then(function (r) { return r.data; });
+};
+export var deleteRole = function (templateId, roleName) {
+    return getEndpoint()
+        .delete("/templates/" + templateId + "/roles/" + roleName)
+        .then(function (r) { return r.data; });
+};
+export var getRoleFields = function (templateId, roleName) {
+    return getEndpoint()
+        .get("/templates/" + templateId + "/roles/" + roleName + "/fields")
+        .then(function (r) { return r.data; });
+};
+export var deleteSequence = function (templateId) {
+    return getEndpoint()
+        .delete("/templates/" + templateId + "/roles/")
+        .then(function (r) { return r.data; });
+};

package/dist/Templates/Stars.js

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

package/dist/Templates/Tags.js

@@ -0,0 +1,16 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var createTag = function (templateId, params) {
+    return getEndpoint()
+        .post("/templates/" + templateId + "/tags/", params)
+        .then(function (r) { return r.data; });
+};
+export var getTags = function (templateId) {
+    return getEndpoint()
+        .get("/templates/" + templateId + "/tags/")
+        .then(function (r) { return r.data; });
+};
+export var deleteTag = function (templateId, tagName) {
+    return getEndpoint()
+        .post("/templates/" + templateId + "/tags/" + tagName)
+        .then(function (r) { return r.data; });
+};

package/{Templates → dist/Templates}/Templates.js

@@ -34,12 +34,26 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         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 (params) { return Endpoint.post('/templates/', params).then(function (r) { return r.data; }); };
+import { getEndpoint } from '../HTTP/Transport';
+export var getTemplates = function () {
+    return getEndpoint()
+        .get('/templates/')
+        .then(function (r) { return r.data; });
+};
+export var getTemplate = function (templateId) {
+    return getEndpoint()
+        .get("/templates/" + templateId)
+        .then(function (r) { return r.data; });
+};
+export var createTemplate = function (params) {
+    return getEndpoint()
+        .post('/templates/', params)
+        .then(function (r) { return r.data; });
+};
 export var editTemplate = function (templateId, params) {
-    return Endpoint.put("/templates/" + templateId, params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .put("/templates/" + templateId, params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Search for templates matching various criteria.
@@ -50,9 +64,17 @@ export var editTemplate = function (templateId, params) {
  * const {result, page, total} = await Templates.search({ ... });
  * ```
  */
-export var searchTemplate = function (params) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, Endpoint.post('/templates/search', params).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; })];
-}); }); };
+export var searchTemplate = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .post('/templates/search', params)
+                .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*/, getEndpoint()
+                .post('/templates/summary', { page: page })
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/{Users → dist/Users}/Auth.d.ts

@@ -4,10 +4,10 @@ import { IAuthenticateAppRequest, IAuthenticateResponse, IAuthenticateUserReques
  *
  * ```typescript
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
  */
 export declare const authenticateUser: (params: IAuthenticateUserRequest) => Promise<IAuthenticateResponse>;
@@ -20,10 +20,10 @@ export declare const authenticateUser: (params: IAuthenticateUserRequest) => Pro
  *
  * ```typescript
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
  */
 export declare const authenticateApp: (params: IAuthenticateAppRequest) => Promise<IAuthenticateResponse>;
@@ -47,10 +47,10 @@ export declare const validateToken: (params: TokenValidationRequest) => Promise<
  *
  * ```typescript
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.refreshTokens();
- * Auth.Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
  */
 export declare const refreshTokens: () => Promise<IAuthenticateResponse>;

package/{Users → dist/Users}/Auth.js

@@ -1,17 +1,19 @@
-import { Endpoint } from '../HTTP/Transport';
+import { getEndpoint } from '../HTTP/Transport';
 /**
  * Authenticate to Verdocs via user/password authentication
  *
  * ```typescript
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
  */
 export var authenticateUser = function (params) {
-    return Endpoint.post('/authentication/login', params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post('/authentication/login', params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Authenticate to Verdocs via client ID / Secret authentication. **NOTE: This is only suitable for
@@ -22,14 +24,16 @@ export var authenticateUser = function (params) {
  *
  * ```typescript
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
- * Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
  */
 export var authenticateApp = function (params) {
-    return Endpoint.post('/authentication/login_client', {}, { headers: params }).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post('/authentication/login_client', {}, { headers: params })
+        .then(function (r) { return r.data; });
 };
 /**
  * Validate a token. Only Verdocs tokens will be accepted. Most applications can decode tokens locally,
@@ -46,20 +50,26 @@ export var authenticateApp = function (params) {
  * ```
  */
 export var validateToken = function (params) {
-    return Endpoint.post('/token/isValid', params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post('/token/isValid', params)
+        .then(function (r) { return r.data; });
 };
 /**
  * If called before the session expires, this will refresh the caller's session and tokens.
  *
  * ```typescript
  * import {Auth} from '@verdocs/js-sdk/Auth';
- * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
  *
  * const {accessToken} = await Auth.refreshTokens();
- * Auth.Endpoint.setAuthToken(accessToken);
+ * Transport.setAuthToken(accessToken);
  * ```
  */
-export var refreshTokens = function () { return Endpoint.get('/token').then(function (r) { return r.data; }); };
+export var refreshTokens = function () {
+    return getEndpoint()
+        .get('/token')
+        .then(function (r) { return r.data; });
+};
 /**
  * Update the caller's password. To help prevent CSRF attack vectors, the user's old password and email address are required.
  *
@@ -73,7 +83,9 @@ export var refreshTokens = function () { return Endpoint.get('/token').then(func
  * ```
  */
 export var updatePassword = function (params) {
-    return Endpoint.put('/user/update_password', params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .put('/user/update_password', params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Update the caller's email address.
@@ -85,5 +97,7 @@ export var updatePassword = function (params) {
  * ```
  */
 export var updateEmail = function (params) {
-    return Endpoint.put('/user/update_email', params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .put('/user/update_email', params)
+        .then(function (r) { return r.data; });
 };