@verdocs/js-sdk 1.0.8 → 1.0.12

package/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+.idea/
+dist/
+docs-html/

package/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,12 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="GrazieInspection" enabled="false" level="TYPO" enabled_by_default="false" />
+    <inspection_tool class="LanguageDetectionInspection" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">
+      <option name="processCode" value="true" />
+      <option name="processLiterals" value="true" />
+      <option name="processComments" value="true" />
+    </inspection_tool>
+  </profile>
+</component>

package/.idea/js-sdk.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/dist" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/misc.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" project-jdk-name="11" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/js-sdk.iml" filepath="$PROJECT_DIR$/.idea/js-sdk.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/.prettierrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  jsxBracketSameLine: true,
+  bracketSpacing: false,
+  jsxSingleQuote: false,
+  trailingComma: 'all',
+  printWidth: 120,
+  singleQuote: true,
+  useTabs: false,
+  tabWidth: 2,
+  semi: true,
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Verdocs, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -21,12 +21,15 @@ perform a simple authentication request:
 
 ```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: 'MY_USERNAME', password: 'MY_PASSWORD'});
-Endpoint.setAuthToken(accessToken);
+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:
@@ -49,14 +52,14 @@ 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, an `Endpoint` singleton Axios Instance will be created to support the API calls to Verdocs servers. This endpoint's operation
+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 {Endpoint} from '@verdocs/js-sdk/Auth/HTTP/Transport';
+import {Transport} from '@verdocs/js-sdk/Auth/HTTP';
 
-Endpoint.defaults.timeout = 5000;
+Transport.setTimeout(5000);
 ```
 
 ## Contributing

package/__mocks__/axios.ts

@@ -0,0 +1,3 @@
+import mockAxios from 'jest-mock-axios';
+
+export default mockAxios;

package/dist/.npmignore

@@ -0,0 +1,5 @@
+docs-md/
+docs-html/
+__mocks__/
+src/__tests__/
+.idea/

package/{Documents → dist/Documents}/Documents.d.ts

@@ -117,6 +117,15 @@ export interface IDocumentSearchOptions {
 }
 export declare type IHistoryEvent = 'recipient:invited' | 'recipient:opened' | 'recipient:agreed' | 'recipient:signed' | 'recipient:submitted';
 export declare type IEventDetail = 'in_app' | 'mail' | 'signer' | '';
+/**
+ * Get a summary of currently active documents.
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Documents';
+ *
+ * const {action_required, completed, waiting_on_others} = await Documents.getSummary();
+ * ```
+ */
 export declare const getSummary: (page: number) => Promise<IDocumentsSummary>;
 /**
  * Search for documents matching various criteria.

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

@@ -34,10 +34,23 @@ 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 getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, Endpoint.post('/documents/summary', { page: page }).then(function (r) { return r.data; })];
-}); }); };
+import { getEndpoint } from '../HTTP/Transport';
+/**
+ * Get a summary of currently active documents.
+ *
+ * ```typescript
+ * import {Documents} from '@verdocs/js-sdk/Documents';
+ *
+ * const {action_required, completed, waiting_on_others} = await Documents.getSummary();
+ * ```
+ */
+export var getSummary = function (page) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .post('/documents/summary', { page: page })
+                .then(function (r) { return r.data; })];
+    });
+}); };
 /**
  * Search for documents matching various criteria.
  *
@@ -47,6 +60,10 @@ export var getSummary = function (page) { return __awaiter(void 0, void 0, void
  * const {result, page, total} = await Documents.search({ ... });
  * ```
  */
-export var search = function (params) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, Endpoint.post('/documents/search', params).then(function (r) { return r.data; })];
-}); }); };
+export var search = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .post('/documents/search', params)
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/{Documents → dist/Documents}/Stars.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';
 export var toggleStar = function (templateId) { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, Endpoint.post("/templates/" + templateId + "/stars/toggle").then(function (r) { return r.data; })];
+    return [2 /*return*/, getEndpoint().post("/templates/" + templateId + "/stars/toggle").then(function (r) { return r.data; })];
 }); }); };

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

@@ -34,13 +34,25 @@ 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 __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*return*/, Endpoint.get('/templates').then(function (r) { return r.data; })];
-}); }); };
-export var searchTemplates = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
-    return [2 /*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; })];
-}); }); };
+import { getEndpoint } from '../HTTP/Transport';
+export var getTemplates = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .get('/templates')
+                .then(function (r) { return r.data; })];
+    });
+}); };
+export var searchTemplates = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, getEndpoint()
+                .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*/, getEndpoint()
+                .post('/templates/summary', { page: page })
+                .then(function (r) { return r.data; })];
+    });
+}); };

package/dist/HTTP/Transport.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Set the auth token that will be used for Verdocs API calls.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setAuthorization(accessToken);
+ * ```
+ */
+export declare const setAuthorization: (accessToken: string | null) => void;
+/**
+ * Set the Client ID for Verdocs API calls.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setClientID('1234);
+ * ```
+ */
+export declare const setClientID: (clientID: string) => void;
+/**
+ * Set the base URL for API calls. Typically this is https://api.verdocs.com/ and is the default. Change this only after consultation
+ * with Verdocs Developer Support.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setBaseUrl('https://api.verdiocs.com');
+ * ```
+ */
+export declare const setBaseUrl: (baseUrl: string) => void;
+/**
+ * Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setTimeout(3000);
+ * ```
+ */
+export declare const setTimeout: (timeout: number) => void;
+/**
+ * Helper to get the endpoint for direct access to HTTP functions.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+ * ```
+ */
+export declare const getEndpoint: () => import("axios").AxiosInstance;

package/dist/HTTP/Transport.js

@@ -0,0 +1,88 @@
+import axios from 'axios';
+var config = {
+    baseURL: 'https://api.verdocs.com/',
+    timeout: 3000,
+    headers: { 'X-Client-ID': 'NONE' },
+};
+var endpoint = axios.create(config);
+/**
+ * Set the auth token that will be used for Verdocs API calls.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setAuthorization(accessToken);
+ * ```
+ */
+export var setAuthorization = function (accessToken) {
+    if (accessToken) {
+        config.headers['Authorization'] = "Bearer " + accessToken;
+    }
+    else {
+        delete config.headers['Authorization'];
+    }
+    if (endpoint) {
+        endpoint = axios.create(config);
+    }
+};
+/**
+ * Set the Client ID for Verdocs API calls.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setClientID('1234);
+ * ```
+ */
+export var setClientID = function (clientID) {
+    config.headers['X-Client-ID'] = clientID;
+    if (endpoint) {
+        endpoint = axios.create(config);
+    }
+};
+/**
+ * Set the base URL for API calls. Typically this is https://api.verdocs.com/ and is the default. Change this only after consultation
+ * with Verdocs Developer Support.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setBaseUrl('https://api.verdiocs.com');
+ * ```
+ */
+export var setBaseUrl = function (baseUrl) {
+    config.baseURL = baseUrl;
+    if (endpoint) {
+        endpoint = axios.create(config);
+    }
+};
+/**
+ * Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * Transport.setTimeout(3000);
+ * ```
+ */
+export var setTimeout = function (timeout) {
+    config.timeout = timeout;
+    if (endpoint) {
+        endpoint = axios.create(config);
+    }
+};
+/**
+ * Helper to get the endpoint for direct access to HTTP functions.
+ *
+ * ```typescript
+ * import {Transport} from '@verdocs/js-sdk/HTTP';
+ *
+ * console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+ * ```
+ */
+export var getEndpoint = function () {
+    if (!endpoint) {
+        endpoint = axios.create(config);
+    }
+    return endpoint;
+};

package/{Organizations → dist/Organizations}/ApiKeys.js

@@ -10,7 +10,7 @@
  *
  * @module
  */
-import { Endpoint } from '../HTTP/Transport';
+import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get a list of keys for a given organization. The caller must have admin access to the organization.
  *
@@ -21,7 +21,9 @@ import { Endpoint } from '../HTTP/Transport';
  * ```
  */
 export var getKeys = function (organizationId) {
-    return Endpoint.get("/organizations/" + organizationId + "/api_key").then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/api_key")
+        .then(function (r) { return r.data; });
 };
 /**
  * Create an API key.
@@ -33,7 +35,9 @@ export var getKeys = function (organizationId) {
  * ```
  */
 export var createKey = function (organizationId, params) {
-    return Endpoint.post("/organizations/" + organizationId + "/api_key", params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/api_key", params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Rotate the secret for an API key. The caller must have admin access to the organization.
@@ -45,7 +49,9 @@ export var createKey = function (organizationId, params) {
  * ```
  */
 export var rotateKey = function (organizationId, clientId) {
-    return Endpoint.put("/organizations/" + organizationId + "/api_key/" + clientId + "/rotate").then(function (r) { return r.data; });
+    return getEndpoint()
+        .put("/organizations/" + organizationId + "/api_key/" + clientId + "/rotate")
+        .then(function (r) { return r.data; });
 };
 /**
  * Update an API key to change its assigned Profile ID or Name.
@@ -57,7 +63,9 @@ export var rotateKey = function (organizationId, clientId) {
  * ```
  */
 export var updateKey = function (organizationId, clientId, params) {
-    return Endpoint.patch("/organizations/" + organizationId + "/api_key/" + clientId, params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .patch("/organizations/" + organizationId + "/api_key/" + clientId, params)
+        .then(function (r) { return r.data; });
 };
 /**
  * Delete an API key.
@@ -69,5 +77,7 @@ export var updateKey = function (organizationId, clientId, params) {
  * ```
  */
 export var deleteKey = function (organizationId, clientId) {
-    return Endpoint.delete("/organizations/" + organizationId + "/api_key/" + clientId).then(function (r) { return r.data; });
+    return getEndpoint()
+        .delete("/organizations/" + organizationId + "/api_key/" + clientId)
+        .then(function (r) { return r.data; });
 };

package/{Organizations → dist/Organizations}/Groups.js

@@ -7,7 +7,7 @@
  *
  * @module
  */
-import { Endpoint } from '../HTTP/Transport';
+import { getEndpoint } from '../HTTP/Transport';
 /**
  * Get a list of groups for a given organization. The caller must have admin access to the organization.
  *
@@ -18,7 +18,9 @@ import { Endpoint } from '../HTTP/Transport';
  * ```
  */
 export var getGroups = function (organizationId) {
-    return Endpoint.get("/organizations/" + organizationId + "/groups").then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/groups")
+        .then(function (r) { return r.data; });
 };
 /**
  * Get the details for a group.
@@ -30,20 +32,32 @@ export var getGroups = function (organizationId) {
  * ```
  */
 export var getGroup = function (organizationId, groupId) {
-    return Endpoint.get("/organizations/" + organizationId + "/groups/" + groupId).then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/groups/" + groupId)
+        .then(function (r) { return r.data; });
 };
 export var getMembers = function (organizationId, groupId) {
-    return Endpoint.get("/organizations/" + organizationId + "/groups/" + groupId + "/members").then(function (r) { return r.data; });
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/groups/" + groupId + "/members")
+        .then(function (r) { return r.data; });
 };
 export var addMembers = function (organizationId, groupId, params) {
-    return Endpoint.post("/organizations/" + organizationId + "/groups/" + groupId + "/members", params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/groups/" + groupId + "/members", params)
+        .then(function (r) { return r.data; });
 };
 export var deleteMembers = function (organizationId, groupId, params) {
-    return Endpoint.put("/organizations/" + organizationId + "/groups/" + groupId + "/delete_members", params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .put("/organizations/" + organizationId + "/groups/" + groupId + "/delete_members", params)
+        .then(function (r) { return r.data; });
 };
 export var addPermission = function (organizationId, groupId, permissionId, params) {
-    return Endpoint.post("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId, params).then(function (r) { return r.data; });
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId, params)
+        .then(function (r) { return r.data; });
 };
 export var deletePermission = function (organizationId, groupId, permissionId) {
-    return Endpoint.delete("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId).then(function (r) { return r.data; });
+    return getEndpoint()
+        .delete("/organizations/" + organizationId + "/groups/" + groupId + "/permissions/" + permissionId)
+        .then(function (r) { return r.data; });
 };

package/dist/Organizations/Invitations.js

@@ -0,0 +1,36 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var getInvitations = function (organizationId) {
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/invitation")
+        .then(function (r) { return r.data; });
+};
+export var createInvitation = function (organizationId, params) {
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/invitation", params)
+        .then(function (r) { return r.data; });
+};
+export var deleteInvitation = function (organizationId, email) {
+    return getEndpoint()
+        .delete("/organizations/" + organizationId + "/invitation/" + email)
+        .then(function (r) { return r.data; });
+};
+export var updateInvitation = function (organizationId, email, params) {
+    return getEndpoint()
+        .patch("/organizations/" + organizationId + "/invitation/" + email, params)
+        .then(function (r) { return r.data; });
+};
+export var resendInvitation = function (organizationId, email) {
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/invitation/" + email + "/resend")
+        .then(function (r) { return r.data; });
+};
+export var claimInvitation = function (organizationId, email, params) {
+    return getEndpoint()
+        .put("/organizations/" + organizationId + "/invitation/" + email, params)
+        .then(function (r) { return r.data; });
+};
+export var claimNewUser = function (organizationId, email, token) {
+    return getEndpoint()
+        .put("/organizations/" + organizationId + "/invitation/" + email + "/token/" + token + "/new_user")
+        .then(function (r) { return r.data; });
+};

package/dist/Organizations/Members.js

@@ -0,0 +1,26 @@
+import { getEndpoint } from '../HTTP/Transport';
+export var getMembers = function (organizationId) {
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/profiles")
+        .then(function (r) { return r.data; });
+};
+export var deleteMember = function (organizationId, profileId) {
+    return getEndpoint()
+        .delete("/organizations/" + organizationId + "/profiles/" + profileId)
+        .then(function (r) { return r.data; });
+};
+export var addMemberRole = function (organizationId, profileId, roleId) {
+    return getEndpoint()
+        .post("/organizations/" + organizationId + "/profiles/" + profileId + "/roles/" + roleId)
+        .then(function (r) { return r.data; });
+};
+export var deleteMemberRole = function (organizationId, profileId, roleId) {
+    return getEndpoint()
+        .delete("/organizations/" + organizationId + "/profiles/" + profileId + "/roles/" + roleId)
+        .then(function (r) { return r.data; });
+};
+export var getMemberPlans = function (organizationId, profileId) {
+    return getEndpoint()
+        .get("/organizations/" + organizationId + "/profiles/" + profileId + "/plans")
+        .then(function (r) { return r.data; });
+};