@verdocs/js-sdk 1.0.8 → 1.0.12

package/docs/interfaces/Templates.Types.ITimePeriod.md

@@ -0,0 +1,32 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / ITimePeriod
+
+# Interface: ITimePeriod
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).ITimePeriod
+
+## Table of contents
+
+### Properties
+
+- [end_time](Templates.Types.ITimePeriod.md#end_time)
+- [start_time](Templates.Types.ITimePeriod.md#start_time)
+
+## Properties
+
+### end\_time
+
+• **end\_time**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:99](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L99)
+
+___
+
+### start\_time
+
+• **start\_time**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:98](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L98)

package/docs/interfaces/Users.Types.IActiveSession.md

@@ -0,0 +1,131 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IActiveSession
+
+# Interface: IActiveSession
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IActiveSession
+
+## Table of contents
+
+### Properties
+
+- [email](Users.Types.IActiveSession.md#email)
+- [email_verified](Users.Types.IActiveSession.md#email_verified)
+- [exp](Users.Types.IActiveSession.md#exp)
+- [iat](Users.Types.IActiveSession.md#iat)
+- [organization_id](Users.Types.IActiveSession.md#organization_id)
+- [permissions](Users.Types.IActiveSession.md#permissions)
+- [plans](Users.Types.IActiveSession.md#plans)
+- [profile](Users.Types.IActiveSession.md#profile)
+- [profile_id](Users.Types.IActiveSession.md#profile_id)
+- [roles](Users.Types.IActiveSession.md#roles)
+- [sub](Users.Types.IActiveSession.md#sub)
+
+## Properties
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[Users/Types.ts:65](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L65)
+
+___
+
+### email\_verified
+
+• **email\_verified**: `boolean`
+
+#### Defined in
+
+[Users/Types.ts:66](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L66)
+
+___
+
+### exp
+
+• **exp**: `number`
+
+#### Defined in
+
+[Users/Types.ts:68](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L68)
+
+___
+
+### iat
+
+• **iat**: `number`
+
+#### Defined in
+
+[Users/Types.ts:67](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L67)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Defined in
+
+[Users/Types.ts:73](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L73)
+
+___
+
+### permissions
+
+• **permissions**: [`IPermission`](Users.Types.IPermission.md)[]
+
+#### Defined in
+
+[Users/Types.ts:69](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L69)
+
+___
+
+### plans
+
+• `Optional` **plans**: [`TPlan`](../modules/Users.Types.md#tplan)[]
+
+#### Defined in
+
+[Users/Types.ts:74](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L74)
+
+___
+
+### profile
+
+• **profile**: [`IProfile`](Users.Types.IProfile.md)
+
+#### Defined in
+
+[Users/Types.ts:71](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L71)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Users/Types.ts:72](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L72)
+
+___
+
+### roles
+
+• **roles**: [`IRole`](Users.Types.IRole.md)[]
+
+#### Defined in
+
+[Users/Types.ts:70](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L70)
+
+___
+
+### sub
+
+• **sub**: `string`
+
+#### Defined in
+
+[Users/Types.ts:64](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L64)

package/docs/interfaces/Users.Types.IAuthenticateAppRequest.md

@@ -0,0 +1,32 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IAuthenticateAppRequest
+
+# Interface: IAuthenticateAppRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IAuthenticateAppRequest
+
+## Table of contents
+
+### Properties
+
+- [client_id](Users.Types.IAuthenticateAppRequest.md#client_id)
+- [client_secret](Users.Types.IAuthenticateAppRequest.md#client_secret)
+
+## Properties
+
+### client\_id
+
+• **client\_id**: `string`
+
+#### Defined in
+
+[Users/Types.ts:117](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L117)
+
+___
+
+### client\_secret
+
+• **client\_secret**: `string`
+
+#### Defined in
+
+[Users/Types.ts:118](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L118)

package/docs/interfaces/Users.Types.IAuthenticateResponse.md

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IAuthenticateResponse
+
+# Interface: IAuthenticateResponse
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IAuthenticateResponse
+
+## Table of contents
+
+### Properties
+
+- [accessToken](Users.Types.IAuthenticateResponse.md#accesstoken)
+- [idToken](Users.Types.IAuthenticateResponse.md#idtoken)
+- [refreshToken](Users.Types.IAuthenticateResponse.md#refreshtoken)
+
+## Properties
+
+### accessToken
+
+• **accessToken**: `string`
+
+#### Defined in
+
+[Users/Types.ts:123](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L123)
+
+___
+
+### idToken
+
+• **idToken**: `string`
+
+#### Defined in
+
+[Users/Types.ts:122](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L122)
+
+___
+
+### refreshToken
+
+• **refreshToken**: `string`
+
+#### Defined in
+
+[Users/Types.ts:124](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L124)

package/docs/interfaces/Users.Types.IAuthenticateUserRequest.md

@@ -0,0 +1,32 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IAuthenticateUserRequest
+
+# Interface: IAuthenticateUserRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IAuthenticateUserRequest
+
+## Table of contents
+
+### Properties
+
+- [password](Users.Types.IAuthenticateUserRequest.md#password)
+- [username](Users.Types.IAuthenticateUserRequest.md#username)
+
+## Properties
+
+### password
+
+• **password**: `string`
+
+#### Defined in
+
+[Users/Types.ts:113](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L113)
+
+___
+
+### username
+
+• **username**: `string`
+
+#### Defined in
+
+[Users/Types.ts:112](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L112)

package/docs/interfaces/Users.Types.ICreateProfileRequest.md

@@ -0,0 +1,54 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / ICreateProfileRequest
+
+# Interface: ICreateProfileRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).ICreateProfileRequest
+
+## Table of contents
+
+### Properties
+
+- [email](Users.Types.ICreateProfileRequest.md#email)
+- [first_name](Users.Types.ICreateProfileRequest.md#first_name)
+- [last_name](Users.Types.ICreateProfileRequest.md#last_name)
+- [phone](Users.Types.ICreateProfileRequest.md#phone)
+
+## Properties
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[Users/Types.ts:94](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L94)
+
+___
+
+### first\_name
+
+• **first\_name**: `string`
+
+#### Defined in
+
+[Users/Types.ts:92](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L92)
+
+___
+
+### last\_name
+
+• **last\_name**: `string`
+
+#### Defined in
+
+[Users/Types.ts:93](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L93)
+
+___
+
+### phone
+
+• `Optional` **phone**: `string`
+
+#### Defined in
+
+[Users/Types.ts:95](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L95)

package/docs/interfaces/Users.Types.IPermission.md

@@ -0,0 +1,36 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IPermission
+
+# Interface: IPermission
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IPermission
+
+## Table of contents
+
+### Properties
+
+- [id](Users.Types.IPermission.md#id)
+- [name](Users.Types.IPermission.md#name)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the permission.
+
+#### Defined in
+
+[Users/Types.ts:86](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L86)
+
+___
+
+### name
+
+• **name**: `string`
+
+Display name for the permission.
+
+#### Defined in
+
+[Users/Types.ts:88](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L88)

package/docs/interfaces/Users.Types.IProfile.md

@@ -0,0 +1,173 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IProfile
+
+# Interface: IProfile
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IProfile
+
+## Table of contents
+
+### Properties
+
+- [current](Users.Types.IProfile.md#current)
+- [email](Users.Types.IProfile.md#email)
+- [first_name](Users.Types.IProfile.md#first_name)
+- [groups](Users.Types.IProfile.md#groups)
+- [id](Users.Types.IProfile.md#id)
+- [last_name](Users.Types.IProfile.md#last_name)
+- [organization](Users.Types.IProfile.md#organization)
+- [organization_id](Users.Types.IProfile.md#organization_id)
+- [permissions](Users.Types.IProfile.md#permissions)
+- [phone](Users.Types.IProfile.md#phone)
+- [plans](Users.Types.IProfile.md#plans)
+- [roles](Users.Types.IProfile.md#roles)
+- [user_id](Users.Types.IProfile.md#user_id)
+
+## Properties
+
+### current
+
+• **current**: `boolean`
+
+If true, this is the caller's "currently selected" profile. All operations will performed "as" this profile.
+
+#### Defined in
+
+[Users/Types.ts:50](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L50)
+
+___
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[Users/Types.ts:47](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L47)
+
+___
+
+### first\_name
+
+• **first\_name**: `string`
+
+#### Defined in
+
+[Users/Types.ts:45](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L45)
+
+___
+
+### groups
+
+• `Optional` **groups**: [`IGroup`](Organizations.Types.IGroup.md)[]
+
+The plans assigned to the profilel _NOTE: Only present in the "current" profile._
+
+#### Defined in
+
+[Users/Types.ts:60](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L60)
+
+___
+
+### id
+
+• **id**: `string`
+
+The unique ID of the profile
+
+#### Defined in
+
+[Users/Types.ts:36](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L36)
+
+___
+
+### last\_name
+
+• **last\_name**: `string`
+
+#### Defined in
+
+[Users/Types.ts:46](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L46)
+
+___
+
+### organization
+
+• **organization**: [`IOrganization`](Organizations.Types.IOrganization.md)
+
+The organization
+
+#### Defined in
+
+[Users/Types.ts:52](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L52)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+The profile's organization ID, or a global "Realster" organization that all personal profiles are members of.
+
+#### Defined in
+
+[Users/Types.ts:44](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L44)
+
+___
+
+### permissions
+
+• `Optional` **permissions**: [`TPermission`](../modules/Users.Types.md#tpermission)[]
+
+The permissions assigned to the profilel _NOTE: Only present in the "current" profile._
+
+#### Defined in
+
+[Users/Types.ts:54](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L54)
+
+___
+
+### phone
+
+• **phone**: ``null`` \| `string`
+
+#### Defined in
+
+[Users/Types.ts:48](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L48)
+
+___
+
+### plans
+
+• `Optional` **plans**: [`TPlan`](../modules/Users.Types.md#tplan)[]
+
+The plans assigned to the profilel _NOTE: Only present in the "current" profile._
+
+#### Defined in
+
+[Users/Types.ts:58](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L58)
+
+___
+
+### roles
+
+• `Optional` **roles**: [`TRole`](../modules/Users.Types.md#trole)[]
+
+The roles assigned to the profilel _NOTE: Only present in the "current" profile._
+
+#### Defined in
+
+[Users/Types.ts:56](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L56)
+
+___
+
+### user\_id
+
+• **user\_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.
+
+#### Defined in
+
+[Users/Types.ts:42](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L42)

package/docs/interfaces/Users.Types.IRole.md

@@ -0,0 +1,36 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IRole
+
+# Interface: IRole
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IRole
+
+## Table of contents
+
+### Properties
+
+- [id](Users.Types.IRole.md#id)
+- [name](Users.Types.IRole.md#name)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+Unique identifier for the role.
+
+#### Defined in
+
+[Users/Types.ts:79](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L79)
+
+___
+
+### name
+
+• **name**: `string`
+
+Display name for the role.
+
+#### Defined in
+
+[Users/Types.ts:81](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L81)

package/docs/interfaces/Users.Types.ISwitchProfileResponse.md

@@ -0,0 +1,54 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / ISwitchProfileResponse
+
+# Interface: ISwitchProfileResponse
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).ISwitchProfileResponse
+
+## Table of contents
+
+### Properties
+
+- [accessToken](Users.Types.ISwitchProfileResponse.md#accesstoken)
+- [idToken](Users.Types.ISwitchProfileResponse.md#idtoken)
+- [profile](Users.Types.ISwitchProfileResponse.md#profile)
+- [refreshToken](Users.Types.ISwitchProfileResponse.md#refreshtoken)
+
+## Properties
+
+### accessToken
+
+• **accessToken**: `string`
+
+#### Defined in
+
+[Users/Types.ts:101](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L101)
+
+___
+
+### idToken
+
+• **idToken**: `string`
+
+#### Defined in
+
+[Users/Types.ts:100](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L100)
+
+___
+
+### profile
+
+• **profile**: [`IProfile`](Users.Types.IProfile.md)
+
+#### Defined in
+
+[Users/Types.ts:99](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L99)
+
+___
+
+### refreshToken
+
+• **refreshToken**: `string`
+
+#### Defined in
+
+[Users/Types.ts:102](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L102)

package/docs/interfaces/Users.Types.IUpdateProfileRequest.md

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / IUpdateProfileRequest
+
+# Interface: IUpdateProfileRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).IUpdateProfileRequest
+
+## Table of contents
+
+### Properties
+
+- [first_name](Users.Types.IUpdateProfileRequest.md#first_name)
+- [last_name](Users.Types.IUpdateProfileRequest.md#last_name)
+- [phone](Users.Types.IUpdateProfileRequest.md#phone)
+
+## Properties
+
+### first\_name
+
+• `Optional` **first\_name**: `string`
+
+#### Defined in
+
+[Users/Types.ts:106](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L106)
+
+___
+
+### last\_name
+
+• `Optional` **last\_name**: `string`
+
+#### Defined in
+
+[Users/Types.ts:107](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L107)
+
+___
+
+### phone
+
+• `Optional` **phone**: `string`
+
+#### Defined in
+
+[Users/Types.ts:108](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L108)

package/docs/interfaces/Users.Types.TokenValidationRequest.md

@@ -0,0 +1,21 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / TokenValidationRequest
+
+# Interface: TokenValidationRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).TokenValidationRequest
+
+## Table of contents
+
+### Properties
+
+- [token](Users.Types.TokenValidationRequest.md#token)
+
+## Properties
+
+### token
+
+• **token**: `string`
+
+#### Defined in
+
+[Users/Types.ts:128](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L128)