@verdocs/js-sdk 1.0.8 → 1.0.12

package/docs/interfaces/Organizations.Types.IApiKey.md

@@ -0,0 +1,60 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / IApiKey
+
+# Interface: IApiKey
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).IApiKey
+
+## Hierarchy
+
+- **`IApiKey`**
+
+  ↳ [`IApiKeyWithSecret`](Organizations.Types.IApiKeyWithSecret.md)
+
+## Table of contents
+
+### Properties
+
+- [client_id](Organizations.Types.IApiKey.md#client_id)
+- [name](Organizations.Types.IApiKey.md#name)
+- [organization_id](Organizations.Types.IApiKey.md#organization_id)
+- [profile_id](Organizations.Types.IApiKey.md#profile_id)
+
+## Properties
+
+### client\_id
+
+• **client\_id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:31](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L31)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:32](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L32)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:34](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L34)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:33](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L33)

package/docs/interfaces/Organizations.Types.IApiKeyWithSecret.md

@@ -0,0 +1,87 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / IApiKeyWithSecret
+
+# Interface: IApiKeyWithSecret
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).IApiKeyWithSecret
+
+## Hierarchy
+
+- [`IApiKey`](Organizations.Types.IApiKey.md)
+
+  ↳ **`IApiKeyWithSecret`**
+
+## Table of contents
+
+### Properties
+
+- [client_id](Organizations.Types.IApiKeyWithSecret.md#client_id)
+- [client_secret](Organizations.Types.IApiKeyWithSecret.md#client_secret)
+- [name](Organizations.Types.IApiKeyWithSecret.md#name)
+- [organization_id](Organizations.Types.IApiKeyWithSecret.md#organization_id)
+- [profile_id](Organizations.Types.IApiKeyWithSecret.md#profile_id)
+
+## Properties
+
+### client\_id
+
+• **client\_id**: `string`
+
+#### Overrides
+
+[IApiKey](Organizations.Types.IApiKey.md).[client_id](Organizations.Types.IApiKey.md#client_id)
+
+#### Defined in
+
+[Organizations/Types.ts:38](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L38)
+
+___
+
+### client\_secret
+
+• **client\_secret**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:39](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L39)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Overrides
+
+[IApiKey](Organizations.Types.IApiKey.md).[name](Organizations.Types.IApiKey.md#name)
+
+#### Defined in
+
+[Organizations/Types.ts:40](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L40)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Overrides
+
+[IApiKey](Organizations.Types.IApiKey.md).[organization_id](Organizations.Types.IApiKey.md#organization_id)
+
+#### Defined in
+
+[Organizations/Types.ts:42](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L42)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Overrides
+
+[IApiKey](Organizations.Types.IApiKey.md).[profile_id](Organizations.Types.IApiKey.md#profile_id)
+
+#### Defined in
+
+[Organizations/Types.ts:41](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L41)

package/docs/interfaces/Organizations.Types.ICreateApiKeyRequest.md

@@ -0,0 +1,32 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / ICreateApiKeyRequest
+
+# Interface: ICreateApiKeyRequest
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).ICreateApiKeyRequest
+
+## Table of contents
+
+### Properties
+
+- [name](Organizations.Types.ICreateApiKeyRequest.md#name)
+- [profile_id](Organizations.Types.ICreateApiKeyRequest.md#profile_id)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:21](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L21)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:22](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L22)

package/docs/interfaces/Organizations.Types.IGroup.md

@@ -0,0 +1,101 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / IGroup
+
+# Interface: IGroup
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).IGroup
+
+## Hierarchy
+
+- **`IGroup`**
+
+  ↳ [`IGroupDetail`](Organizations.Types.IGroupDetail.md)
+
+## Table of contents
+
+### Properties
+
+- [id](Organizations.Types.IGroup.md#id)
+- [name](Organizations.Types.IGroup.md#name)
+- [organization_id](Organizations.Types.IGroup.md#organization_id)
+- [parent_id](Organizations.Types.IGroup.md#parent_id)
+- [permissions](Organizations.Types.IGroup.md#permissions)
+- [profiles](Organizations.Types.IGroup.md#profiles)
+- [roles](Organizations.Types.IGroup.md#roles)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:46](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L46)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:47](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L47)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:48](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L48)
+
+___
+
+### parent\_id
+
+• **parent\_id**: ``null`` \| `string`
+
+For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null.
+
+#### Defined in
+
+[Organizations/Types.ts:50](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L50)
+
+___
+
+### permissions
+
+• `Optional` **permissions**: [`TPermission`](../modules/Users.Types.md#tpermission)[]
+
+Some operations will additionally return a list of permissions.
+
+#### Defined in
+
+[Organizations/Types.ts:52](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L52)
+
+___
+
+### profiles
+
+• `Optional` **profiles**: [`IProfile`](Users.Types.IProfile.md)[]
+
+Some operations will additionally return a list of profiles.
+
+#### Defined in
+
+[Organizations/Types.ts:56](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L56)
+
+___
+
+### roles
+
+• `Optional` **roles**: [`TRole`](../modules/Users.Types.md#trole)[]
+
+Some operations will additionally return a list of roles.
+
+#### Defined in
+
+[Organizations/Types.ts:54](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L54)

package/docs/interfaces/Organizations.Types.IGroupDetail.md

@@ -0,0 +1,129 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / IGroupDetail
+
+# Interface: IGroupDetail
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).IGroupDetail
+
+## Hierarchy
+
+- [`IGroup`](Organizations.Types.IGroup.md)
+
+  ↳ **`IGroupDetail`**
+
+## Table of contents
+
+### Properties
+
+- [id](Organizations.Types.IGroupDetail.md#id)
+- [name](Organizations.Types.IGroupDetail.md#name)
+- [organization_id](Organizations.Types.IGroupDetail.md#organization_id)
+- [parent_id](Organizations.Types.IGroupDetail.md#parent_id)
+- [permissions](Organizations.Types.IGroupDetail.md#permissions)
+- [profiles](Organizations.Types.IGroupDetail.md#profiles)
+- [roles](Organizations.Types.IGroupDetail.md#roles)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Inherited from
+
+[IGroup](Organizations.Types.IGroup.md).[id](Organizations.Types.IGroup.md#id)
+
+#### Defined in
+
+[Organizations/Types.ts:46](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L46)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[IGroup](Organizations.Types.IGroup.md).[name](Organizations.Types.IGroup.md#name)
+
+#### Defined in
+
+[Organizations/Types.ts:47](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L47)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Inherited from
+
+[IGroup](Organizations.Types.IGroup.md).[organization_id](Organizations.Types.IGroup.md#organization_id)
+
+#### Defined in
+
+[Organizations/Types.ts:48](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L48)
+
+___
+
+### parent\_id
+
+• **parent\_id**: ``null`` \| `string`
+
+For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null.
+
+#### Inherited from
+
+[IGroup](Organizations.Types.IGroup.md).[parent_id](Organizations.Types.IGroup.md#parent_id)
+
+#### Defined in
+
+[Organizations/Types.ts:50](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L50)
+
+___
+
+### permissions
+
+• **permissions**: [`TPermission`](../modules/Users.Types.md#tpermission)[]
+
+Some operations will additionally return a list of permissions.
+
+#### Overrides
+
+[IGroup](Organizations.Types.IGroup.md).[permissions](Organizations.Types.IGroup.md#permissions)
+
+#### Defined in
+
+[Organizations/Types.ts:60](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L60)
+
+___
+
+### profiles
+
+• **profiles**: [`IProfile`](Users.Types.IProfile.md)[]
+
+Some operations will additionally return a list of profiles.
+
+#### Overrides
+
+[IGroup](Organizations.Types.IGroup.md).[profiles](Organizations.Types.IGroup.md#profiles)
+
+#### Defined in
+
+[Organizations/Types.ts:62](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L62)
+
+___
+
+### roles
+
+• **roles**: [`TRole`](../modules/Users.Types.md#trole)[]
+
+Some operations will additionally return a list of roles.
+
+#### Overrides
+
+[IGroup](Organizations.Types.IGroup.md).[roles](Organizations.Types.IGroup.md#roles)
+
+#### Defined in
+
+[Organizations/Types.ts:61](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L61)

package/docs/interfaces/Organizations.Types.IOrganization.md

@@ -0,0 +1,128 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / IOrganization
+
+# Interface: IOrganization
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).IOrganization
+
+## Table of contents
+
+### Properties
+
+- [address](Organizations.Types.IOrganization.md#address)
+- [address2](Organizations.Types.IOrganization.md#address2)
+- [business_name](Organizations.Types.IOrganization.md#business_name)
+- [contact_email](Organizations.Types.IOrganization.md#contact_email)
+- [envelope_responsible](Organizations.Types.IOrganization.md#envelope_responsible)
+- [id](Organizations.Types.IOrganization.md#id)
+- [is_business](Organizations.Types.IOrganization.md#is_business)
+- [name](Organizations.Types.IOrganization.md#name)
+- [phone](Organizations.Types.IOrganization.md#phone)
+- [timezone](Organizations.Types.IOrganization.md#timezone)
+
+## Properties
+
+### address
+
+• **address**: ``null`` \| `string`
+
+#### Defined in
+
+[Organizations/Types.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L8)
+
+___
+
+### address2
+
+• **address2**: ``null`` \| `string`
+
+#### Defined in
+
+[Organizations/Types.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L14)
+
+___
+
+### business\_name
+
+• **business\_name**: ``null`` \| `string`
+
+If the organization is a business, its name. Note that a business name can be different from an organization name.
+
+#### Defined in
+
+[Organizations/Types.ts:11](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L11)
+
+___
+
+### contact\_email
+
+• **contact\_email**: ``null`` \| `string`
+
+#### Defined in
+
+[Organizations/Types.ts:15](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L15)
+
+___
+
+### envelope\_responsible
+
+• **envelope\_responsible**: `boolean`
+
+#### Defined in
+
+[Organizations/Types.ts:17](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L17)
+
+___
+
+### id
+
+• **id**: `string`
+
+The unique ID of the organization
+
+#### Defined in
+
+[Organizations/Types.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L5)
+
+___
+
+### is\_business
+
+• **is\_business**: `boolean`
+
+If true, the organization is a business
+
+#### Defined in
+
+[Organizations/Types.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L13)
+
+___
+
+### name
+
+• **name**: `string`
+
+The organization's name.
+
+#### Defined in
+
+[Organizations/Types.ts:7](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L7)
+
+___
+
+### phone
+
+• **phone**: ``null`` \| `string`
+
+#### Defined in
+
+[Organizations/Types.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L9)
+
+___
+
+### timezone
+
+• **timezone**: ``null`` \| `string`
+
+#### Defined in
+
+[Organizations/Types.ts:16](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L16)

package/docs/interfaces/Organizations.Types.IUpdateApiKeyRequest.md

@@ -0,0 +1,32 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](../modules/Organizations.md) / [Types](../modules/Organizations.Types.md) / IUpdateApiKeyRequest
+
+# Interface: IUpdateApiKeyRequest
+
+[Organizations](../modules/Organizations.md).[Types](../modules/Organizations.Types.md).IUpdateApiKeyRequest
+
+## Table of contents
+
+### Properties
+
+- [name](Organizations.Types.IUpdateApiKeyRequest.md#name)
+- [profile_id](Organizations.Types.IUpdateApiKeyRequest.md#profile_id)
+
+## Properties
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:26](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L26)
+
+___
+
+### profile\_id
+
+• `Optional` **profile\_id**: `string`
+
+#### Defined in
+
+[Organizations/Types.ts:27](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Types.ts#L27)

package/docs/interfaces/Signatures.ISignature.md

@@ -0,0 +1,65 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Signatures](../modules/Signatures.md) / ISignature
+
+# Interface: ISignature
+
+[Signatures](../modules/Signatures.md).ISignature
+
+## Table of contents
+
+### Properties
+
+- [created_at](Signatures.ISignature.md#created_at)
+- [id](Signatures.ISignature.md#id)
+- [profile_id](Signatures.ISignature.md#profile_id)
+- [updated_at](Signatures.ISignature.md#updated_at)
+- [url](Signatures.ISignature.md#url)
+
+## Properties
+
+### created\_at
+
+• `Optional` **created\_at**: `Date`
+
+#### Defined in
+
+[Signatures.ts:7](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L7)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+#### Defined in
+
+[Signatures.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L4)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Signatures.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L5)
+
+___
+
+### updated\_at
+
+• `Optional` **updated\_at**: `Date`
+
+#### Defined in
+
+[Signatures.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L8)
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+[Signatures.ts:6](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L6)

package/docs/interfaces/Tags.ITags.md

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Tags](../modules/Tags.md) / ITags
+
+# Interface: ITags
+
+[Tags](../modules/Tags.md).ITags
+
+## Table of contents
+
+### Properties
+
+- [created_at](Tags.ITags.md#created_at)
+- [featured](Tags.ITags.md#featured)
+- [name](Tags.ITags.md#name)
+
+## Properties
+
+### created\_at
+
+• `Optional` **created\_at**: `Date`
+
+#### Defined in
+
+[Tags.ts:6](https://github.com/Verdocs/js-sdk/blob/main/src/Tags.ts#L6)
+
+___
+
+### featured
+
+• `Optional` **featured**: `boolean`
+
+#### Defined in
+
+[Tags.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Tags.ts#L5)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Tags.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Tags.ts#L4)