@verdocs/js-sdk 1.0.8 → 1.0.12

package/docs/modules/Organizations.ApiKeys.md

@@ -0,0 +1,169 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / ApiKeys
+
+# Namespace: ApiKeys
+
+[Organizations](Organizations.md).ApiKeys
+
+API keys are used to authenticate server-to-server calls. (API keys should **never** be used for client-to-server operations!)
+To generate a key, either use the Verdocs admin interface and make note of the client_id and client_secret generated, or call
+createKey as shown below. Then call [Users.Auth.authenticateApp](Users.Auth.md#authenticateapp) to obtain an access token using the provided ID and
+secret. Note that server-to-server authentication requests return shorter-lived tokens, so it is important to check the `exp`
+field and re-authenticate as needed for subsequent calls.
+
+API keys may be updated or rotated at any time. Regular rotation is recommended. Rotation will not expire or invalidate
+existing server-to-server sessions, so it may be done at any time without disrupting your application.
+
+## Table of contents
+
+### Functions
+
+- [createKey](Organizations.ApiKeys.md#createkey)
+- [deleteKey](Organizations.ApiKeys.md#deletekey)
+- [getKeys](Organizations.ApiKeys.md#getkeys)
+- [rotateKey](Organizations.ApiKeys.md#rotatekey)
+- [updateKey](Organizations.ApiKeys.md#updatekey)
+
+## Functions
+
+### createKey
+
+▸ `Const` **createKey**(`organizationId`, `params`): `Promise`<[`IApiKeyWithSecret`](../interfaces/Organizations.Types.IApiKeyWithSecret.md)\>
+
+Create an API key.
+
+```typescript
+import {ApiKeys} from '@verdocs/js-sdk/Organizations';
+
+await ApiKeys.createKey(ORGID, {name: NEWNAME});
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `params` | [`ICreateApiKeyRequest`](../interfaces/Organizations.Types.ICreateApiKeyRequest.md) |
+
+#### Returns
+
+`Promise`<[`IApiKeyWithSecret`](../interfaces/Organizations.Types.IApiKeyWithSecret.md)\>
+
+#### Defined in
+
+[Organizations/ApiKeys.ts:40](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/ApiKeys.ts#L40)
+
+___
+
+### deleteKey
+
+▸ `Const` **deleteKey**(`organizationId`, `clientId`): `Promise`<`any`\>
+
+Delete an API key.
+
+```typescript
+import {ApiKeys} from '@verdocs/js-sdk/Organizations';
+
+await ApiKeys.deleteKey(ORGID, CLIENTID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `clientId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/ApiKeys.ts:82](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/ApiKeys.ts#L82)
+
+___
+
+### getKeys
+
+▸ `Const` **getKeys**(`organizationId`): `Promise`<[`IApiKey`](../interfaces/Organizations.Types.IApiKey.md)[]\>
+
+Get a list of keys for a given organization. The caller must have admin access to the organization.
+
+```typescript
+import {ApiKeys} from '@verdocs/js-sdk/Organizations';
+
+const keys = await ApiKeys.getKeys(ORGID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<[`IApiKey`](../interfaces/Organizations.Types.IApiKey.md)[]\>
+
+#### Defined in
+
+[Organizations/ApiKeys.ts:26](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/ApiKeys.ts#L26)
+
+___
+
+### rotateKey
+
+▸ `Const` **rotateKey**(`organizationId`, `clientId`): `Promise`<[`IApiKeyWithSecret`](../interfaces/Organizations.Types.IApiKeyWithSecret.md)\>
+
+Rotate the secret for an API key. The caller must have admin access to the organization.
+
+```typescript
+import {ApiKeys} from '@verdocs/js-sdk/Organizations';
+
+const {client_secret: newSecret} = await ApiKeys.rotateKey(ORGID, CLIENTID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `clientId` | `string` |
+
+#### Returns
+
+`Promise`<[`IApiKeyWithSecret`](../interfaces/Organizations.Types.IApiKeyWithSecret.md)\>
+
+#### Defined in
+
+[Organizations/ApiKeys.ts:54](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/ApiKeys.ts#L54)
+
+___
+
+### updateKey
+
+▸ `Const` **updateKey**(`organizationId`, `clientId`, `params`): `Promise`<[`IApiKey`](../interfaces/Organizations.Types.IApiKey.md)\>
+
+Update an API key to change its assigned Profile ID or Name.
+
+```typescript
+import {ApiKeys} from '@verdocs/js-sdk/Organizations';
+
+await ApiKeys.updateKey(ORGID, CLIENTID, {name: NEWNAME});
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `clientId` | `string` |
+| `params` | [`IUpdateApiKeyRequest`](../interfaces/Organizations.Types.IUpdateApiKeyRequest.md) |
+
+#### Returns
+
+`Promise`<[`IApiKey`](../interfaces/Organizations.Types.IApiKey.md)\>
+
+#### Defined in
+
+[Organizations/ApiKeys.ts:68](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/ApiKeys.ts#L68)

package/docs/modules/Organizations.Groups.md

@@ -0,0 +1,190 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / Groups
+
+# Namespace: Groups
+
+[Organizations](Organizations.md).Groups
+
+Organizations may contain "Groups" of user profiles, called Members. Groups may have permissions assigned that
+apply to all Members, making it easy to configure role-based access control (RBAC) within an Organization. Note
+that permissions are **additive**. A user may be a member of more than one group, and may also have permissions
+assigned directly. In that case, the user will have the combined set of all permissions inherited from all
+sources.
+
+## Table of contents
+
+### Functions
+
+- [addMembers](Organizations.Groups.md#addmembers)
+- [addPermission](Organizations.Groups.md#addpermission)
+- [deleteMembers](Organizations.Groups.md#deletemembers)
+- [deletePermission](Organizations.Groups.md#deletepermission)
+- [getGroup](Organizations.Groups.md#getgroup)
+- [getGroups](Organizations.Groups.md#getgroups)
+- [getMembers](Organizations.Groups.md#getmembers)
+
+## Functions
+
+### addMembers
+
+▸ `Const` **addMembers**(`organizationId`, `groupId`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `groupId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Groups.ts:47](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L47)
+
+___
+
+### addPermission
+
+▸ `Const` **addPermission**(`organizationId`, `groupId`, `permissionId`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `groupId` | `string` |
+| `permissionId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Groups.ts:57](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L57)
+
+___
+
+### deleteMembers
+
+▸ `Const` **deleteMembers**(`organizationId`, `groupId`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `groupId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Groups.ts:52](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L52)
+
+___
+
+### deletePermission
+
+▸ `Const` **deletePermission**(`organizationId`, `groupId`, `permissionId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `groupId` | `string` |
+| `permissionId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Groups.ts:62](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L62)
+
+___
+
+### getGroup
+
+▸ `Const` **getGroup**(`organizationId`, `groupId`): `Promise`<[`IGroupDetail`](../interfaces/Organizations.Types.IGroupDetail.md)\>
+
+Get the details for a group.
+
+```typescript
+import {Groups} from '@verdocs/js-sdk/Organizations';
+
+const groups = await Groups.getGroups(ORGID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `groupId` | `string` |
+
+#### Returns
+
+`Promise`<[`IGroupDetail`](../interfaces/Organizations.Types.IGroupDetail.md)\>
+
+#### Defined in
+
+[Organizations/Groups.ts:37](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L37)
+
+___
+
+### getGroups
+
+▸ `Const` **getGroups**(`organizationId`): `Promise`<[`IGroup`](../interfaces/Organizations.Types.IGroup.md)[]\>
+
+Get a list of groups for a given organization. The caller must have admin access to the organization.
+
+```typescript
+import {Groups} from '@verdocs/js-sdk/Organizations';
+
+const groups = await Groups.getGroups(ORGID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<[`IGroup`](../interfaces/Organizations.Types.IGroup.md)[]\>
+
+#### Defined in
+
+[Organizations/Groups.ts:23](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L23)
+
+___
+
+### getMembers
+
+▸ `Const` **getMembers**(`organizationId`, `groupId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `groupId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Groups.ts:42](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Groups.ts#L42)

package/docs/modules/Organizations.Invitations.md

@@ -0,0 +1,166 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / Invitations
+
+# Namespace: Invitations
+
+[Organizations](Organizations.md).Invitations
+
+## Table of contents
+
+### Functions
+
+- [claimInvitation](Organizations.Invitations.md#claiminvitation)
+- [claimNewUser](Organizations.Invitations.md#claimnewuser)
+- [createInvitation](Organizations.Invitations.md#createinvitation)
+- [deleteInvitation](Organizations.Invitations.md#deleteinvitation)
+- [getInvitations](Organizations.Invitations.md#getinvitations)
+- [resendInvitation](Organizations.Invitations.md#resendinvitation)
+- [updateInvitation](Organizations.Invitations.md#updateinvitation)
+
+## Functions
+
+### claimInvitation
+
+▸ `Const` **claimInvitation**(`organizationId`, `email`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `email` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:28](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L28)
+
+___
+
+### claimNewUser
+
+▸ `Const` **claimNewUser**(`organizationId`, `email`, `token`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `email` | `string` |
+| `token` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:33](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L33)
+
+___
+
+### createInvitation
+
+▸ `Const` **createInvitation**(`organizationId`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L8)
+
+___
+
+### deleteInvitation
+
+▸ `Const` **deleteInvitation**(`organizationId`, `email`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `email` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L13)
+
+___
+
+### getInvitations
+
+▸ `Const` **getInvitations**(`organizationId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L3)
+
+___
+
+### resendInvitation
+
+▸ `Const` **resendInvitation**(`organizationId`, `email`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `email` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:23](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L23)
+
+___
+
+### updateInvitation
+
+▸ `Const` **updateInvitation**(`organizationId`, `email`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `email` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Invitations.ts:18](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Invitations.ts#L18)

package/docs/modules/Organizations.Members.md

@@ -0,0 +1,121 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / Members
+
+# Namespace: Members
+
+[Organizations](Organizations.md).Members
+
+## Table of contents
+
+### Functions
+
+- [addMemberRole](Organizations.Members.md#addmemberrole)
+- [deleteMember](Organizations.Members.md#deletemember)
+- [deleteMemberRole](Organizations.Members.md#deletememberrole)
+- [getMemberPlans](Organizations.Members.md#getmemberplans)
+- [getMembers](Organizations.Members.md#getmembers)
+
+## Functions
+
+### addMemberRole
+
+▸ `Const` **addMemberRole**(`organizationId`, `profileId`, `roleId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `profileId` | `string` |
+| `roleId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Members.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L13)
+
+___
+
+### deleteMember
+
+▸ `Const` **deleteMember**(`organizationId`, `profileId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Members.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L8)
+
+___
+
+### deleteMemberRole
+
+▸ `Const` **deleteMemberRole**(`organizationId`, `profileId`, `roleId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `profileId` | `string` |
+| `roleId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Members.ts:18](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L18)
+
+___
+
+### getMemberPlans
+
+▸ `Const` **getMemberPlans**(`organizationId`, `profileId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `profileId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Members.ts:23](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L23)
+
+___
+
+### getMembers
+
+▸ `Const` **getMembers**(`organizationId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Members.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Members.ts#L3)