@verdocs/js-sdk 1.0.11 → 1.0.12

package/src/__tests__/Users/Profiles.spec.ts

@@ -0,0 +1,162 @@
+import mockAxios from 'jest-mock-axios';
+import {Profiles} from '../../Users';
+import {IPermission, IProfile, IRole} from '../../Users/Types';
+
+// TODO: Expand this test suite with more mock data and result checks
+
+const MockProfile = {
+  id: '1234',
+  user_id: '4567',
+  organization_id: '5678',
+  first_name: 'first',
+  last_name: 'last',
+  email: 'test@test.com',
+  phone: null,
+  current: true,
+  organization: {
+    id: '5678',
+    name: 'test org',
+    address: null,
+    phone: null,
+    business_name: null,
+    is_business: false,
+    address2: null,
+    contact_email: null,
+    timezone: null,
+    envelope_responsible: false,
+  },
+} as IProfile;
+
+afterEach(() => {
+  mockAxios.reset();
+});
+
+it('getProfiles should return a "current" profile', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  Profiles.getProfiles().then(thenFn).catch(catchFn);
+  expect(mockAxios.get).toBeCalledWith('/profiles');
+
+  mockAxios.mockResponse({data: [MockProfile]});
+  expect(thenFn).toBeCalledWith([MockProfile]);
+  expect(catchFn).not.toBeCalled();
+});
+
+it('getRoles should return a list of system roles', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  Profiles.getRoles().then(thenFn).catch(catchFn);
+  expect(mockAxios.get).toBeCalledWith('/roles');
+
+  const roles = [] as IRole[];
+  mockAxios.mockResponse({data: roles});
+  expect(thenFn).toBeCalledWith(roles);
+  expect(catchFn).not.toBeCalled();
+});
+
+it('getPermissions should return a list of system permissions', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  Profiles.getPermissions().then(thenFn).catch(catchFn);
+  expect(mockAxios.get).toBeCalledWith('/permissions');
+
+  const permissions = [] as IPermission[];
+  mockAxios.mockResponse({data: permissions});
+  expect(thenFn).toBeCalledWith(permissions);
+  expect(catchFn).not.toBeCalled();
+});
+
+it('createProfile should return the new profile', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profile = {first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL', organization_id: 'ORGID', user_id: 'TEST'};
+  Profiles.createProfile(profile).then(thenFn).catch(catchFn);
+  expect(mockAxios.post).toBeCalledWith('/profiles', profile);
+
+  mockAxios.mockResponse({data: profile});
+  expect(thenFn).toBeCalledWith(profile);
+  expect(catchFn).not.toBeCalled();
+});
+
+it('getProfile should return a profile', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profileId = 'TEST';
+  Profiles.getProfile(profileId).then(thenFn).catch(catchFn);
+  expect(mockAxios.get).toBeCalledWith(`/profiles/${profileId}`);
+
+  mockAxios.mockResponse({data: {id: profileId}});
+  expect(thenFn).toBeCalledWith({id: profileId});
+  expect(catchFn).not.toBeCalled();
+});
+
+it('getProfilePermissions should return a permissions array', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profileId = 'TEST';
+  Profiles.getProfilePermissions(profileId).then(thenFn).catch(catchFn);
+  expect(mockAxios.get).toBeCalledWith(`/profiles/${profileId}/permissions`);
+
+  mockAxios.mockResponse({data: []});
+  expect(thenFn).toBeCalledWith([]);
+  expect(catchFn).not.toBeCalled();
+});
+
+it('getProfileGroups should return a groups array', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profileId = 'TEST';
+  Profiles.getProfileGroups(profileId).then(thenFn).catch(catchFn);
+  expect(mockAxios.get).toBeCalledWith(`/profiles/${profileId}/groups`);
+
+  mockAxios.mockResponse({data: []});
+  expect(thenFn).toBeCalledWith([]);
+  expect(catchFn).not.toBeCalled();
+});
+
+it('switchProfile should return a new profile', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profileId = 'TEST';
+  Profiles.switchProfile(profileId).then(thenFn).catch(catchFn);
+  expect(mockAxios.post).toBeCalledWith(`/profiles/${profileId}/switch`);
+
+  mockAxios.mockResponse({data: {}});
+  expect(thenFn).toBeCalledWith({});
+  expect(catchFn).not.toBeCalled();
+});
+
+it('updateProfile should return a new profile', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profileId = 'TEST';
+  const params = {first_name: 'TEST'};
+  Profiles.updateProfile(profileId, params).then(thenFn).catch(catchFn);
+  expect(mockAxios.put).toBeCalledWith(`/profiles/${profileId}`, params);
+
+  mockAxios.mockResponse({data: {}});
+  expect(thenFn).toBeCalledWith({});
+  expect(catchFn).not.toBeCalled();
+});
+
+it('deleteProfile should return a new profile', () => {
+  const catchFn = jest.fn();
+  const thenFn = jest.fn();
+
+  const profileId = 'TEST';
+  Profiles.deleteProfile(profileId).then(thenFn).catch(catchFn);
+  expect(mockAxios.delete).toBeCalledWith(`/profiles/${profileId}`);
+
+  mockAxios.mockResponse();
+  expect(thenFn).toBeCalled();
+  expect(catchFn).not.toBeCalled();
+});

package/src/index.ts

@@ -0,0 +1,23 @@
+/**
+ * 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/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "esnext",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "**/__tests__/*"],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs",
+    "includeVersion": true,
+    "gitRevision": "main"
+  }
+}

package/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["tslint:recommended", "tslint-config-prettier"]
+}

package/Organizations/Invitations.js

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

package/Organizations/Members.js

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

package/Organizations/Organizations.js

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

package/Organizations/Webhooks.js

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

package/Signatures.js

@@ -1,7 +0,0 @@
-import { Endpoint } from './HTTP/Transport';
-export var createSignature = function (params) { return Endpoint.post('/signatures', params).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/Tags.js

@@ -1,4 +0,0 @@
-import { Endpoint } from './HTTP/Transport';
-export var createTag = function (params) { return Endpoint.post('/tags', params).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 (params) { return Endpoint.get('/tags', params).then(function (r) { return r.data; }); };

package/Templates/Fields.js

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

package/Templates/Pages.js

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

package/Templates/Reminders.js

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

package/Templates/Roles.js

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

package/Templates/Stars.js

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

package/Templates/Tags.js

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

package/Validators.js

@@ -1,5 +0,0 @@
-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/Whitelabel.js

@@ -1,3 +0,0 @@
-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; }); };