@verdocs/js-sdk 1.0.11 → 1.0.12

package/docs/enums/Templates.Types.TemplateSenderTypes.md

@@ -0,0 +1,65 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / TemplateSenderTypes
+
+# Enumeration: TemplateSenderTypes
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).TemplateSenderTypes
+
+## Table of contents
+
+### Enumeration members
+
+- [CREATOR](Templates.Types.TemplateSenderTypes.md#creator)
+- [EVERYONE](Templates.Types.TemplateSenderTypes.md#everyone)
+- [EVERYONE_AS_CREATOR](Templates.Types.TemplateSenderTypes.md#everyone_as_creator)
+- [ORGANIZATION_MEMBER](Templates.Types.TemplateSenderTypes.md#organization_member)
+- [ORGANIZATION_MEMBER_AS_CREATOR](Templates.Types.TemplateSenderTypes.md#organization_member_as_creator)
+
+## Enumeration members
+
+### CREATOR
+
+• **CREATOR** = `"creator"`
+
+#### Defined in
+
+[Templates/Types.ts:58](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L58)
+
+___
+
+### EVERYONE
+
+• **EVERYONE** = `"everyone"`
+
+#### Defined in
+
+[Templates/Types.ts:61](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L61)
+
+___
+
+### EVERYONE\_AS\_CREATOR
+
+• **EVERYONE\_AS\_CREATOR** = `"everyone_as_creator"`
+
+#### Defined in
+
+[Templates/Types.ts:62](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L62)
+
+___
+
+### ORGANIZATION\_MEMBER
+
+• **ORGANIZATION\_MEMBER** = `"organization_member"`
+
+#### Defined in
+
+[Templates/Types.ts:59](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L59)
+
+___
+
+### ORGANIZATION\_MEMBER\_AS\_CREATOR
+
+• **ORGANIZATION\_MEMBER\_AS\_CREATOR** = `"organization_member_as_creator"`
+
+#### Defined in
+
+[Templates/Types.ts:60](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L60)

package/docs/interfaces/Documents.Documents-1.IActivityEntry.md

@@ -0,0 +1,120 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IActivityEntry
+
+# Interface: IActivityEntry
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IActivityEntry
+
+## Table of contents
+
+### Properties
+
+- [canceled_at](Documents.Documents-1.IActivityEntry.md#canceled_at)
+- [created_at](Documents.Documents-1.IActivityEntry.md#created_at)
+- [id](Documents.Documents-1.IActivityEntry.md#id)
+- [name](Documents.Documents-1.IActivityEntry.md#name)
+- [profile_id](Documents.Documents-1.IActivityEntry.md#profile_id)
+- [recipient](Documents.Documents-1.IActivityEntry.md#recipient)
+- [status](Documents.Documents-1.IActivityEntry.md#status)
+- [template_id](Documents.Documents-1.IActivityEntry.md#template_id)
+- [updated_at](Documents.Documents-1.IActivityEntry.md#updated_at)
+
+## Properties
+
+### canceled\_at
+
+• **canceled\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:95](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L95)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:96](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L96)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:93](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L93)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:94](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L94)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:98](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L98)
+
+___
+
+### recipient
+
+• **recipient**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `claimed` | `boolean` |
+| `email` | `string` |
+| `name` | `string` |
+| `profile_id` | `string` |
+| `status` | [`IRecipientStatus`](../modules/Documents.Documents-1.md#irecipientstatus) |
+| `type` | [`IRecipientType`](../modules/Documents.Documents-1.md#irecipienttype) |
+
+#### Defined in
+
+[Documents/Documents.ts:101](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L101)
+
+___
+
+### status
+
+• **status**: [`IDocumentStatus`](../modules/Documents.Documents-1.md#idocumentstatus)
+
+#### Defined in
+
+[Documents/Documents.ts:99](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L99)
+
+___
+
+### template\_id
+
+• **template\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:100](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L100)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:97](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L97)

package/docs/interfaces/Documents.Documents-1.IDocument.md

@@ -0,0 +1,175 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IDocument
+
+# Interface: IDocument
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IDocument
+
+## Table of contents
+
+### Properties
+
+- [canceled_at](Documents.Documents-1.IDocument.md#canceled_at)
+- [certificate_document_id](Documents.Documents-1.IDocument.md#certificate_document_id)
+- [created_at](Documents.Documents-1.IDocument.md#created_at)
+- [envelope_document_id](Documents.Documents-1.IDocument.md#envelope_document_id)
+- [histories](Documents.Documents-1.IDocument.md#histories)
+- [id](Documents.Documents-1.IDocument.md#id)
+- [name](Documents.Documents-1.IDocument.md#name)
+- [no_contact](Documents.Documents-1.IDocument.md#no_contact)
+- [organization_id](Documents.Documents-1.IDocument.md#organization_id)
+- [profile_id](Documents.Documents-1.IDocument.md#profile_id)
+- [recipients](Documents.Documents-1.IDocument.md#recipients)
+- [reminder_id](Documents.Documents-1.IDocument.md#reminder_id)
+- [status](Documents.Documents-1.IDocument.md#status)
+- [template_id](Documents.Documents-1.IDocument.md#template_id)
+- [updated_at](Documents.Documents-1.IDocument.md#updated_at)
+
+## Properties
+
+### canceled\_at
+
+• **canceled\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:77](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L77)
+
+___
+
+### certificate\_document\_id
+
+• **certificate\_document\_id**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Documents.ts:79](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L79)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:76](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L76)
+
+___
+
+### envelope\_document\_id
+
+• **envelope\_document\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:78](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L78)
+
+___
+
+### histories
+
+• **histories**: [`IHistory`](Documents.Documents-1.IHistory.md)[]
+
+#### Defined in
+
+[Documents/Documents.ts:80](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L80)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:75](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L75)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:82](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L82)
+
+___
+
+### no\_contact
+
+• **no\_contact**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:83](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L83)
+
+___
+
+### organization\_id
+
+• **organization\_id**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Documents.ts:89](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L89)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:84](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L84)
+
+___
+
+### recipients
+
+• **recipients**: [`IRecipient`](Documents.Documents-1.IRecipient.md)[]
+
+#### Defined in
+
+[Documents/Documents.ts:81](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L81)
+
+___
+
+### reminder\_id
+
+• **reminder\_id**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Documents.ts:85](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L85)
+
+___
+
+### status
+
+• **status**: [`IDocumentStatus`](../modules/Documents.Documents-1.md#idocumentstatus)
+
+#### Defined in
+
+[Documents/Documents.ts:86](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L86)
+
+___
+
+### template\_id
+
+• **template\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:87](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L87)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:88](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L88)

package/docs/interfaces/Documents.Documents-1.IDocumentSearchOptions.md

@@ -0,0 +1,98 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IDocumentSearchOptions
+
+# Interface: IDocumentSearchOptions
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IDocumentSearchOptions
+
+## Table of contents
+
+### Properties
+
+- [ascending](Documents.Documents-1.IDocumentSearchOptions.md#ascending)
+- [envelope_status](Documents.Documents-1.IDocumentSearchOptions.md#envelope_status)
+- [is_owner](Documents.Documents-1.IDocumentSearchOptions.md#is_owner)
+- [is_recipient](Documents.Documents-1.IDocumentSearchOptions.md#is_recipient)
+- [page](Documents.Documents-1.IDocumentSearchOptions.md#page)
+- [recipient_status](Documents.Documents-1.IDocumentSearchOptions.md#recipient_status)
+- [rows](Documents.Documents-1.IDocumentSearchOptions.md#rows)
+- [sort_by](Documents.Documents-1.IDocumentSearchOptions.md#sort_by)
+
+## Properties
+
+### ascending
+
+• `Optional` **ascending**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:124](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L124)
+
+___
+
+### envelope\_status
+
+• **envelope\_status**: [`IDocumentStatus`](../modules/Documents.Documents-1.md#idocumentstatus)[]
+
+#### Defined in
+
+[Documents/Documents.ts:127](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L127)
+
+___
+
+### is\_owner
+
+• `Optional` **is\_owner**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:125](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L125)
+
+___
+
+### is\_recipient
+
+• `Optional` **is\_recipient**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:126](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L126)
+
+___
+
+### page
+
+• `Optional` **page**: `number`
+
+#### Defined in
+
+[Documents/Documents.ts:122](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L122)
+
+___
+
+### recipient\_status
+
+• **recipient\_status**: [`IDocumentStatus`](../modules/Documents.Documents-1.md#idocumentstatus)[]
+
+#### Defined in
+
+[Documents/Documents.ts:128](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L128)
+
+___
+
+### rows
+
+• `Optional` **rows**: `number`
+
+#### Defined in
+
+[Documents/Documents.ts:121](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L121)
+
+___
+
+### sort\_by
+
+• `Optional` **sort\_by**: ``"updated_at"`` \| ``"created_at"``
+
+#### Defined in
+
+[Documents/Documents.ts:123](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L123)

package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResult.md

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IDocumentsSearchResult
+
+# Interface: IDocumentsSearchResult
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IDocumentsSearchResult
+
+## Table of contents
+
+### Properties
+
+- [page](Documents.Documents-1.IDocumentsSearchResult.md#page)
+- [result](Documents.Documents-1.IDocumentsSearchResult.md#result)
+- [total](Documents.Documents-1.IDocumentsSearchResult.md#total)
+
+## Properties
+
+### page
+
+• **page**: `number`
+
+#### Defined in
+
+[Documents/Documents.ts:30](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L30)
+
+___
+
+### result
+
+• **result**: [`IDocumentsSearchResultEntry`](Documents.Documents-1.IDocumentsSearchResultEntry.md)[]
+
+#### Defined in
+
+[Documents/Documents.ts:32](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L32)
+
+___
+
+### total
+
+• **total**: `number`
+
+#### Defined in
+
+[Documents/Documents.ts:31](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L31)

package/docs/interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.md

@@ -0,0 +1,131 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IDocumentsSearchResultEntry
+
+# Interface: IDocumentsSearchResultEntry
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IDocumentsSearchResultEntry
+
+## Table of contents
+
+### Properties
+
+- [canceled_at](Documents.Documents-1.IDocumentsSearchResultEntry.md#canceled_at)
+- [created_at](Documents.Documents-1.IDocumentsSearchResultEntry.md#created_at)
+- [id](Documents.Documents-1.IDocumentsSearchResultEntry.md#id)
+- [name](Documents.Documents-1.IDocumentsSearchResultEntry.md#name)
+- [next_recipient](Documents.Documents-1.IDocumentsSearchResultEntry.md#next_recipient)
+- [profile_id](Documents.Documents-1.IDocumentsSearchResultEntry.md#profile_id)
+- [status](Documents.Documents-1.IDocumentsSearchResultEntry.md#status)
+- [template_id](Documents.Documents-1.IDocumentsSearchResultEntry.md#template_id)
+- [total_count](Documents.Documents-1.IDocumentsSearchResultEntry.md#total_count)
+- [updated_at](Documents.Documents-1.IDocumentsSearchResultEntry.md#updated_at)
+
+## Properties
+
+### canceled\_at
+
+• **canceled\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:11](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L11)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:12](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L12)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:10](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L10)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L13)
+
+___
+
+### next\_recipient
+
+• **next\_recipient**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `claimed` | `boolean` |
+| `email` | `string` |
+| `name` | `string` |
+| `profile_id` | `string` |
+| `status` | [`IRecipientStatus`](../modules/Documents.Documents-1.md#irecipientstatus) |
+| `type` | [`IRecipientType`](../modules/Documents.Documents-1.md#irecipienttype) |
+
+#### Defined in
+
+[Documents/Documents.ts:16](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L16)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L14)
+
+___
+
+### status
+
+• **status**: [`IDocumentStatus`](../modules/Documents.Documents-1.md#idocumentstatus)
+
+#### Defined in
+
+[Documents/Documents.ts:15](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L15)
+
+___
+
+### template\_id
+
+• **template\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:24](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L24)
+
+___
+
+### total\_count
+
+• **total\_count**: `number`
+
+#### Defined in
+
+[Documents/Documents.ts:25](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L25)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:26](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L26)

package/docs/interfaces/Documents.Documents-1.IDocumentsSummary.md

@@ -0,0 +1,67 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IDocumentsSummary
+
+# Interface: IDocumentsSummary
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IDocumentsSummary
+
+## Table of contents
+
+### Properties
+
+- [action_required](Documents.Documents-1.IDocumentsSummary.md#action_required)
+- [completed](Documents.Documents-1.IDocumentsSummary.md#completed)
+- [waiting_others](Documents.Documents-1.IDocumentsSummary.md#waiting_others)
+
+## Properties
+
+### action\_required
+
+• **action\_required**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+| `result` | [`IActivityEntry`](Documents.Documents-1.IActivityEntry.md)[] |
+| `total` | `number` |
+
+#### Defined in
+
+[Documents/Documents.ts:36](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L36)
+
+___
+
+### completed
+
+• **completed**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+| `result` | [`IActivityEntry`](Documents.Documents-1.IActivityEntry.md)[] |
+| `total` | `number` |
+
+#### Defined in
+
+[Documents/Documents.ts:41](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L41)
+
+___
+
+### waiting\_others
+
+• **waiting\_others**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+| `result` | [`IActivityEntry`](Documents.Documents-1.IActivityEntry.md)[] |
+| `total` | `number` |
+
+#### Defined in
+
+[Documents/Documents.ts:46](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L46)