@verdocs/js-sdk 1.0.0

package/dist/Users/Auth.js

@@ -0,0 +1,89 @@
+import { Endpoint } 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';
+ *
+ * const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
+ * Endpoint.setAuthToken(accessToken);
+ * ```
+ */
+export var authenticateUser = function (params) {
+    return Endpoint.post('/authentication/login', params).then(function (r) { return r.data; });
+};
+/**
+ * Authenticate to Verdocs via client ID / Secret authentication. **NOTE: This is only suitable for
+ * NodeJS server-side applications. Never expose your Client Secret in a Web or Mobile app!** Also note
+ * that access tokens may be cached by server-side apps (and this is recommended) but do expire after 2
+ * hours. This expiration may change based on future security needs. Application developers are encouraged
+ * to check the `exp` expiration field in the response accessToken and renew tokens after they expire.
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk/Auth';
+ * import {Endpoint} from '@verdocs/js-sdk/HTTP';
+ *
+ * const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
+ * Endpoint.setAuthToken(accessToken);
+ * ```
+ */
+export var authenticateApp = function (params) {
+    return Endpoint.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,
+ * because tokens will be validated when API calls are made anyway. However, high-security applications
+ * may use this endpoint to check if a token has been revoked.
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk/Auth';
+ *
+ * const {valid} = await Auth.validateToken({ token });
+ * if (!valid) {
+ *   window.alert('Session invalid or expired. Please re-authenticate.');
+ * }
+ * ```
+ */
+export var validateToken = function (params) {
+    return Endpoint.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';
+ *
+ * const {accessToken} = await Auth.refreshTokens();
+ * Auth.Endpoint.setAuthToken(accessToken);
+ * ```
+ */
+export var refreshTokens = function () { return Endpoint.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.
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk/Auth';
+ *
+ * const {status, message} = await Auth.updatePassword({ email, oldPassword, newPassword });
+ * if (status !== 'OK') {
+ *   window.alert(`Password reset error: ${message}`);
+ * }
+ * ```
+ */
+export var updatePassword = function (params) {
+    return Endpoint.put('/user/update_password', params).then(function (r) { return r.data; });
+};
+/**
+ * Update the caller's email address.
+ *
+ * ```typescript
+ * import {Auth} from '@verdocs/js-sdk/Auth';
+ *
+ * const {profiles} = await Auth.updateEmail({ email: newEmail });
+ * ```
+ */
+export var updateEmail = function (params) {
+    return Endpoint.put('/user/update_email', params).then(function (r) { return r.data; });
+};

package/dist/Users/Billing.d.ts

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

package/dist/Users/Billing.js

@@ -0,0 +1,2 @@
+export {};
+// TODO

package/dist/Users/Notifications.d.ts

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

package/dist/Users/Notifications.js

@@ -0,0 +1,40 @@
+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 getNotifications = function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+    return [2 /*return*/, Endpoint.get('/notifications').then(function (r) { return r.data; })];
+}); }); };

package/dist/Users/Profiles.d.ts

@@ -0,0 +1,104 @@
+import { ICreateProfileRequest, IGroup, IPermission, IProfile, IRole, ISwitchProfileResponse, IUpdateProfileRequest } from './Types';
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profiles = await Profiles.getProfiles()
+ * ```
+ */
+export declare const getProfiles: () => Promise<IProfile[]>;
+/**
+ * Get a list of system roles.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const roles = await Profiles.getRoles();
+ * ```
+ */
+export declare const getRoles: () => Promise<IRole[]>;
+/**
+ * Get a list of system roles.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const permissions = await Profiles.getPermissions();
+ * ```
+ */
+export declare const getPermissions: () => Promise<IPermission[]>;
+/**
+ * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
+ * ```
+ */
+export declare const createProfile: (params: ICreateProfileRequest) => Promise<IProfile>;
+/**
+ * Get a profile. The caller must have admin access to the given profile.
+ * TODO: Add a "public" profile endpoint for public pages
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profile = await Profiles.getProfile('PROFILEID');
+ * ```
+ */
+export declare const getProfile: (profileId: string) => Promise<IProfile>;
+/**
+ * Get a profile's permissions. The caller must have admin access to the given profile.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const permissions = await Profiles.getProfilePermissions('PROFILEID');
+ * ```
+ */
+export declare const getProfilePermissions: (profileId: string) => Promise<IPermission[]>;
+/**
+ * Get a profile's groups.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const groups = await Profiles.getProfileGroups('PROFILEID');
+ * ```
+ */
+export declare const getProfileGroups: (profileId: string) => Promise<IGroup[]>;
+/**
+ * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
+ * for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.switchProfile('PROFILEID');
+ * ```
+ */
+export declare const switchProfile: (profileId: string) => Promise<ISwitchProfileResponse>;
+/**
+ * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
+ * "current" profile for the caller.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.updateProfile('PROFILEID');
+ * ```
+ */
+export declare const updateProfile: (profileId: string, params: IUpdateProfileRequest) => Promise<IProfile>;
+/**
+ * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * await Profiles.deleteProfile('PROFILEID');
+ * ```
+ */
+export declare const deleteProfile: (profileId: string) => Promise<any>;

package/dist/Users/Profiles.js

@@ -0,0 +1,114 @@
+import { Endpoint } from '../HTTP/Transport';
+/**
+ * Get the user's available profiles. The current profile will be marked with `current: true`.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profiles = await Profiles.getProfiles()
+ * ```
+ */
+export var getProfiles = function () { return Endpoint.get('/profiles').then(function (r) { return r.data; }); };
+/**
+ * Get a list of system roles.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const roles = await Profiles.getRoles();
+ * ```
+ */
+export var getRoles = function () { return Endpoint.get('/roles').then(function (r) { return r.data; }); };
+/**
+ * Get a list of system roles.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const permissions = await Profiles.getPermissions();
+ * ```
+ */
+export var getPermissions = function () { return Endpoint.get('/permissions').then(function (r) { return r.data; }); };
+/**
+ * Create a profile. If the caller does not have a "current" profile set, the new profile will be made current.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.createProfile({ first_name: 'FIRST', last_name: 'LAST', email: 'EMAIL' });
+ * ```
+ */
+export var createProfile = function (params) {
+    return Endpoint.post('/profiles', params).then(function (r) { return r.data; });
+};
+/**
+ * Get a profile. The caller must have admin access to the given profile.
+ * TODO: Add a "public" profile endpoint for public pages
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const profile = await Profiles.getProfile('PROFILEID');
+ * ```
+ */
+export var getProfile = function (profileId) { return Endpoint.get("/profiles/" + profileId).then(function (r) { return r.data; }); };
+/**
+ * Get a profile's permissions. The caller must have admin access to the given profile.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const permissions = await Profiles.getProfilePermissions('PROFILEID');
+ * ```
+ */
+export var getProfilePermissions = function (profileId) {
+    return Endpoint.get("/profiles/" + profileId + "/permissions").then(function (r) { return r.data; });
+};
+/**
+ * Get a profile's groups.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const groups = await Profiles.getProfileGroups('PROFILEID');
+ * ```
+ */
+export var getProfileGroups = function (profileId) {
+    return Endpoint.get("/profiles/" + profileId + "/groups").then(function (r) { return r.data; });
+};
+/**
+ * Switch the caller's "current" profile. The current profile is used for permissions checking and profile_id field settings
+ * for most operations in Verdocs. It is important to select the appropropriate profile before calling other API functions.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.switchProfile('PROFILEID');
+ * ```
+ */
+export var switchProfile = function (profileId) {
+    return Endpoint.post("/profiles/" + profileId + "/switch").then(function (r) { return r.data; });
+};
+/**
+ * Update a profile. For future expansion, the profile ID to update is required, but currently this must also be the
+ * "current" profile for the caller.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * const newProfile = await Profiles.updateProfile('PROFILEID');
+ * ```
+ */
+export var updateProfile = function (profileId, params) {
+    return Endpoint.put("/profiles/" + profileId, params).then(function (r) { return r.data; });
+};
+/**
+ * Delete a profile. If the requested profile is the caller's curent profile, the next available profile will be selected.
+ *
+ * ```typescript
+ * import {Profiles} from '@verdocs/js-sdk/Users';
+ *
+ * await Profiles.deleteProfile('PROFILEID');
+ * ```
+ */
+export var deleteProfile = function (profileId) { return Endpoint.delete("/profiles/" + profileId).then(function (r) { return r.data; }); };

package/dist/Users/Types.d.ts

@@ -0,0 +1,106 @@
+import { 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;
+    /**
+     * The Verdocs back-end currently uses Auth0 for authentication. This value is a unique ID assigned by Auth0 to the
+     * user. This is typically used to identify multiple profiles owned by a single user, but its implementation may
+     * change in the future and developers should not develop code based on this field at this time.
+     */
+    user_id: string;
+    /** The profile's organization ID, or a global "Realster" organization that all personal profiles are members of. */
+    organization_id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone: string | null;
+    /** If true, this is the caller's "currently selected" profile. All operations will performed "as" this profile. */
+    current: boolean;
+    /** The organization */
+    organization: IOrganization;
+    /** The permissions assigned to the profilel _NOTE: Only present in the "current" profile._ */
+    permissions?: TPermission[];
+    /** The roles assigned to the profilel _NOTE: Only present in the "current" profile._ */
+    roles?: TRole[];
+    /** The plans assigned to the profilel _NOTE: Only present in the "current" profile._ */
+    plans?: TPlan[];
+    /** The plans assigned to the profilel _NOTE: Only present in the "current" profile._ */
+    groups?: IGroup[];
+}
+export interface IRole {
+    /** Unique identifier for the role. */
+    id: string;
+    /** Display name for the role. */
+    name: string;
+}
+export interface IPermission {
+    /** Unique identifier for the permission. */
+    id: string;
+    /** Display name for the permission. */
+    name: string;
+}
+export interface ICreateProfileRequest {
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone?: string;
+}
+export interface ISwitchProfileResponse {
+    profile: IProfile;
+    idToken: string;
+    accessToken: string;
+    refreshToken: string;
+}
+export interface IUpdateProfileRequest {
+    first_name?: string;
+    last_name?: string;
+    phone?: string;
+}
+export interface IAuthenticateUserRequest {
+    username: string;
+    password: string;
+}
+export interface IAuthenticateAppRequest {
+    client_id: string;
+    client_secret: string;
+}
+export interface IAuthenticateResponse {
+    idToken: string;
+    accessToken: string;
+    refreshToken: string;
+}
+export interface TokenValidationRequest {
+    token: string;
+}
+export interface TokenValidationResponse {
+    /** True if the token is valid */
+    valid: boolean;
+    /** The decoded and validated body of the JWT */
+    payload: any;
+}
+export interface UpdatePasswordRequest {
+    email: string;
+    oldPassword: string;
+    newPassword: string;
+}
+export interface UpdatePasswordResponse {
+    status: TRequestStatus;
+    /** Success or failure message */
+    message: string;
+}
+export interface UpdateEmailRequest {
+    email: string;
+}
+export interface UpdateEmailResponse {
+    profiles: IProfile[];
+}