@verdocs/js-sdk 1.0.11 → 1.0.12

package/docs/modules/Users.Auth.md

@@ -0,0 +1,196 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](Users.md) / Auth
+
+# Namespace: Auth
+
+[Users](Users.md).Auth
+
+## Table of contents
+
+### Functions
+
+- [authenticateApp](Users.Auth.md#authenticateapp)
+- [authenticateUser](Users.Auth.md#authenticateuser)
+- [refreshTokens](Users.Auth.md#refreshtokens)
+- [updateEmail](Users.Auth.md#updateemail)
+- [updatePassword](Users.Auth.md#updatepassword)
+- [validateToken](Users.Auth.md#validatetoken)
+
+## Functions
+
+### authenticateApp
+
+▸ `Const` **authenticateApp**(`params`): `Promise`<[`IAuthenticateResponse`](../interfaces/Users.Types.IAuthenticateResponse.md)\>
+
+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 {Transport} from '@verdocs/js-sdk/HTTP';
+
+const {accessToken} = await Auth.authenticateApp({ client_id: 'CLIENTID', client_secret: 'SECRET' });
+Transport.setAuthToken(accessToken);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`IAuthenticateAppRequest`](../interfaces/Users.Types.IAuthenticateAppRequest.md) |
+
+#### Returns
+
+`Promise`<[`IAuthenticateResponse`](../interfaces/Users.Types.IAuthenticateResponse.md)\>
+
+#### Defined in
+
+[Users/Auth.ts:45](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L45)
+
+___
+
+### authenticateUser
+
+▸ `Const` **authenticateUser**(`params`): `Promise`<[`IAuthenticateResponse`](../interfaces/Users.Types.IAuthenticateResponse.md)\>
+
+Authenticate to Verdocs via user/password authentication
+
+```typescript
+import {Auth} from '@verdocs/js-sdk/Auth';
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+const {accessToken} = await Auth.authenticateUser({ username: 'test@test.com', password: 'PASSWORD' });
+Transport.setAuthToken(accessToken);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`IAuthenticateUserRequest`](../interfaces/Users.Types.IAuthenticateUserRequest.md) |
+
+#### Returns
+
+`Promise`<[`IAuthenticateResponse`](../interfaces/Users.Types.IAuthenticateResponse.md)\>
+
+#### Defined in
+
+[Users/Auth.ts:25](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L25)
+
+___
+
+### refreshTokens
+
+▸ `Const` **refreshTokens**(): `Promise`<[`IAuthenticateResponse`](../interfaces/Users.Types.IAuthenticateResponse.md)\>
+
+If called before the session expires, this will refresh the caller's session and tokens.
+
+```typescript
+import {Auth} from '@verdocs/js-sdk/Auth';
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+const {accessToken} = await Auth.refreshTokens();
+Transport.setAuthToken(accessToken);
+```
+
+#### Returns
+
+`Promise`<[`IAuthenticateResponse`](../interfaces/Users.Types.IAuthenticateResponse.md)\>
+
+#### Defined in
+
+[Users/Auth.ts:80](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L80)
+
+___
+
+### updateEmail
+
+▸ `Const` **updateEmail**(`params`): `Promise`<[`UpdateEmailResponse`](../interfaces/Users.Types.UpdateEmailResponse.md)\>
+
+Update the caller's email address.
+
+```typescript
+import {Auth} from '@verdocs/js-sdk/Auth';
+
+const {profiles} = await Auth.updateEmail({ email: newEmail });
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`UpdateEmailRequest`](../interfaces/Users.Types.UpdateEmailRequest.md) |
+
+#### Returns
+
+`Promise`<[`UpdateEmailResponse`](../interfaces/Users.Types.UpdateEmailResponse.md)\>
+
+#### Defined in
+
+[Users/Auth.ts:111](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L111)
+
+___
+
+### updatePassword
+
+▸ `Const` **updatePassword**(`params`): `Promise`<[`UpdatePasswordResponse`](../interfaces/Users.Types.UpdatePasswordResponse.md)\>
+
+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}`);
+}
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`UpdatePasswordRequest`](../interfaces/Users.Types.UpdatePasswordRequest.md) |
+
+#### Returns
+
+`Promise`<[`UpdatePasswordResponse`](../interfaces/Users.Types.UpdatePasswordResponse.md)\>
+
+#### Defined in
+
+[Users/Auth.ts:97](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L97)
+
+___
+
+### validateToken
+
+▸ `Const` **validateToken**(`params`): `Promise`<[`TokenValidationResponse`](../interfaces/Users.Types.TokenValidationResponse.md)\>
+
+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.');
+}
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`TokenValidationRequest`](../interfaces/Users.Types.TokenValidationRequest.md) |
+
+#### Returns
+
+`Promise`<[`TokenValidationResponse`](../interfaces/Users.Types.TokenValidationResponse.md)\>
+
+#### Defined in
+
+[Users/Auth.ts:64](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Auth.ts#L64)

package/docs/modules/Users.Billing.md

@@ -0,0 +1,5 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](Users.md) / Billing
+
+# Namespace: Billing
+
+[Users](Users.md).Billing

package/docs/modules/Users.Notifications.md

@@ -0,0 +1,25 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](Users.md) / Notifications
+
+# Namespace: Notifications
+
+[Users](Users.md).Notifications
+
+## Table of contents
+
+### Functions
+
+- [getNotifications](Users.Notifications.md#getnotifications)
+
+## Functions
+
+### getNotifications
+
+▸ `Const` **getNotifications**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Users/Notifications.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Notifications.ts#L3)

package/docs/modules/Users.Profiles.md

@@ -0,0 +1,286 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](Users.md) / Profiles
+
+# Namespace: Profiles
+
+[Users](Users.md).Profiles
+
+## Table of contents
+
+### Functions
+
+- [createProfile](Users.Profiles.md#createprofile)
+- [deleteProfile](Users.Profiles.md#deleteprofile)
+- [getPermissions](Users.Profiles.md#getpermissions)
+- [getProfile](Users.Profiles.md#getprofile)
+- [getProfileGroups](Users.Profiles.md#getprofilegroups)
+- [getProfilePermissions](Users.Profiles.md#getprofilepermissions)
+- [getProfiles](Users.Profiles.md#getprofiles)
+- [getRoles](Users.Profiles.md#getroles)
+- [switchProfile](Users.Profiles.md#switchprofile)
+- [updateProfile](Users.Profiles.md#updateprofile)
+
+## Functions
+
+### createProfile
+
+▸ `Const` **createProfile**(`params`): `Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)\>
+
+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' });
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`ICreateProfileRequest`](../interfaces/Users.Types.ICreateProfileRequest.md) |
+
+#### Returns
+
+`Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)\>
+
+#### Defined in
+
+[Users/Profiles.ts:63](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L63)
+
+___
+
+### deleteProfile
+
+▸ `Const` **deleteProfile**(`profileId`): `Promise`<`any`\>
+
+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');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Users/Profiles.ts:150](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L150)
+
+___
+
+### getPermissions
+
+▸ `Const` **getPermissions**(): `Promise`<[`IPermission`](../interfaces/Users.Types.IPermission.md)[]\>
+
+Get a list of system roles.
+
+```typescript
+import {Profiles} from '@verdocs/js-sdk/Users';
+
+const permissions = await Profiles.getPermissions();
+```
+
+#### Returns
+
+`Promise`<[`IPermission`](../interfaces/Users.Types.IPermission.md)[]\>
+
+#### Defined in
+
+[Users/Profiles.ts:49](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L49)
+
+___
+
+### getProfile
+
+▸ `Const` **getProfile**(`profileId`): `Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)\>
+
+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');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)\>
+
+#### Defined in
+
+[Users/Profiles.ts:78](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L78)
+
+___
+
+### getProfileGroups
+
+▸ `Const` **getProfileGroups**(`profileId`): `Promise`<[`IGroup`](../interfaces/Organizations.Types.IGroup.md)[]\>
+
+Get a profile's groups.
+
+```typescript
+import {Profiles} from '@verdocs/js-sdk/Users';
+
+const groups = await Profiles.getProfileGroups('PROFILEID');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<[`IGroup`](../interfaces/Organizations.Types.IGroup.md)[]\>
+
+#### Defined in
+
+[Users/Profiles.ts:106](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L106)
+
+___
+
+### getProfilePermissions
+
+▸ `Const` **getProfilePermissions**(`profileId`): `Promise`<[`IPermission`](../interfaces/Users.Types.IPermission.md)[]\>
+
+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');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<[`IPermission`](../interfaces/Users.Types.IPermission.md)[]\>
+
+#### Defined in
+
+[Users/Profiles.ts:92](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L92)
+
+___
+
+### getProfiles
+
+▸ `Const` **getProfiles**(): `Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)[]\>
+
+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()
+```
+
+#### Returns
+
+`Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)[]\>
+
+#### Defined in
+
+[Users/Profiles.ts:21](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L21)
+
+___
+
+### getRoles
+
+▸ `Const` **getRoles**(): `Promise`<[`IRole`](../interfaces/Users.Types.IRole.md)[]\>
+
+Get a list of system roles.
+
+```typescript
+import {Profiles} from '@verdocs/js-sdk/Users';
+
+const roles = await Profiles.getRoles();
+```
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/Users.Types.IRole.md)[]\>
+
+#### Defined in
+
+[Users/Profiles.ts:35](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L35)
+
+___
+
+### switchProfile
+
+▸ `Const` **switchProfile**(`profileId`): `Promise`<[`ISwitchProfileResponse`](../interfaces/Users.Types.ISwitchProfileResponse.md)\>
+
+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');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<[`ISwitchProfileResponse`](../interfaces/Users.Types.ISwitchProfileResponse.md)\>
+
+#### Defined in
+
+[Users/Profiles.ts:121](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L121)
+
+___
+
+### updateProfile
+
+▸ `Const` **updateProfile**(`profileId`, `params`): `Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)\>
+
+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');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `profileId` | `string` |
+| `params` | [`IUpdateProfileRequest`](../interfaces/Users.Types.IUpdateProfileRequest.md) |
+
+#### Returns
+
+`Promise`<[`IProfile`](../interfaces/Users.Types.IProfile.md)\>
+
+#### Defined in
+
+[Users/Profiles.ts:136](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Profiles.ts#L136)

package/docs/modules/Users.Types.md

@@ -0,0 +1,62 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](Users.md) / Types
+
+# Namespace: Types
+
+[Users](Users.md).Types
+
+## Table of contents
+
+### Interfaces
+
+- [IActiveSession](../interfaces/Users.Types.IActiveSession.md)
+- [IAuthenticateAppRequest](../interfaces/Users.Types.IAuthenticateAppRequest.md)
+- [IAuthenticateResponse](../interfaces/Users.Types.IAuthenticateResponse.md)
+- [IAuthenticateUserRequest](../interfaces/Users.Types.IAuthenticateUserRequest.md)
+- [ICreateProfileRequest](../interfaces/Users.Types.ICreateProfileRequest.md)
+- [IPermission](../interfaces/Users.Types.IPermission.md)
+- [IProfile](../interfaces/Users.Types.IProfile.md)
+- [IRole](../interfaces/Users.Types.IRole.md)
+- [ISwitchProfileResponse](../interfaces/Users.Types.ISwitchProfileResponse.md)
+- [IUpdateProfileRequest](../interfaces/Users.Types.IUpdateProfileRequest.md)
+- [TokenValidationRequest](../interfaces/Users.Types.TokenValidationRequest.md)
+- [TokenValidationResponse](../interfaces/Users.Types.TokenValidationResponse.md)
+- [UpdateEmailRequest](../interfaces/Users.Types.UpdateEmailRequest.md)
+- [UpdateEmailResponse](../interfaces/Users.Types.UpdateEmailResponse.md)
+- [UpdatePasswordRequest](../interfaces/Users.Types.UpdatePasswordRequest.md)
+- [UpdatePasswordResponse](../interfaces/Users.Types.UpdatePasswordResponse.md)
+
+### Type aliases
+
+- [TPermission](Users.Types.md#tpermission)
+- [TPlan](Users.Types.md#tplan)
+- [TRole](Users.Types.md#trole)
+
+## Type aliases
+
+### TPermission
+
+Ƭ **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"``
+
+#### Defined in
+
+[Users/Types.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L4)
+
+___
+
+### TPlan
+
+Ƭ **TPlan**: ``"env:essential"`` \| ``"org:standard"``
+
+#### Defined in
+
+[Users/Types.ts:30](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L30)
+
+___
+
+### TRole
+
+Ƭ **TRole**: ``"owner"`` \| ``"basic_user"`` \| ``"member"``
+
+#### Defined in
+
+[Users/Types.ts:32](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L32)

package/docs/modules/Users.md

@@ -0,0 +1,13 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Users
+
+# Namespace: Users
+
+## Table of contents
+
+### Namespaces
+
+- [Auth](Users.Auth.md)
+- [Billing](Users.Billing.md)
+- [Notifications](Users.Notifications.md)
+- [Profiles](Users.Profiles.md)
+- [Types](Users.Types.md)

package/docs/modules/Utils.DateTime.md

@@ -0,0 +1,31 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Utils](Utils.md) / DateTime
+
+# Namespace: DateTime
+
+[Utils](Utils.md).DateTime
+
+## Table of contents
+
+### Functions
+
+- [formatShortTimeAgo](Utils.DateTime.md#formatshorttimeago)
+
+## Functions
+
+### formatShortTimeAgo
+
+▸ `Const` **formatShortTimeAgo**(`val`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `val` | `any` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[Utils/DateTime.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Utils/DateTime.ts#L8)

package/docs/modules/Utils.md

@@ -0,0 +1,9 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Utils
+
+# Namespace: Utils
+
+## Table of contents
+
+### Namespaces
+
+- [DateTime](Utils.DateTime.md)

package/docs/modules/Validators.md

@@ -0,0 +1,48 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Validators
+
+# Namespace: Validators
+
+## Table of contents
+
+### Interfaces
+
+- [IValidator](../interfaces/Validators.IValidator.md)
+
+### Functions
+
+- [getValidator](Validators.md#getvalidator)
+- [getValidators](Validators.md#getvalidators)
+
+## Functions
+
+### getValidator
+
+▸ `Const` **getValidator**(`validatorName`): `Promise`<[`IValidator`](../interfaces/Validators.IValidator.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `validatorName` | `string` |
+
+#### Returns
+
+`Promise`<[`IValidator`](../interfaces/Validators.IValidator.md)\>
+
+#### Defined in
+
+[Validators.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L13)
+
+___
+
+### getValidators
+
+▸ `Const` **getValidators**(): `Promise`<[`IValidator`](../interfaces/Validators.IValidator.md)[]\>
+
+#### Returns
+
+`Promise`<[`IValidator`](../interfaces/Validators.IValidator.md)[]\>
+
+#### Defined in
+
+[Validators.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L8)