@verdocs/js-sdk 1.0.8 → 1.0.12

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)

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

@@ -0,0 +1,76 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IHistory
+
+# Interface: IHistory
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IHistory
+
+## Table of contents
+
+### Properties
+
+- [created_at](Documents.Documents-1.IHistory.md#created_at)
+- [envelope_id](Documents.Documents-1.IHistory.md#envelope_id)
+- [event](Documents.Documents-1.IHistory.md#event)
+- [event_detail](Documents.Documents-1.IHistory.md#event_detail)
+- [id](Documents.Documents-1.IHistory.md#id)
+- [role_name](Documents.Documents-1.IHistory.md#role_name)
+
+## Properties
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:112](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L112)
+
+___
+
+### envelope\_id
+
+• **envelope\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:113](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L113)
+
+___
+
+### event
+
+• **event**: [`IHistoryEvent`](../modules/Documents.Documents-1.md#ihistoryevent)
+
+#### Defined in
+
+[Documents/Documents.ts:114](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L114)
+
+___
+
+### event\_detail
+
+• **event\_detail**: [`IEventDetail`](../modules/Documents.Documents-1.md#ieventdetail)
+
+#### Defined in
+
+[Documents/Documents.ts:115](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L115)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:116](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L116)
+
+___
+
+### role\_name
+
+• **role\_name**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:117](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L117)

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

@@ -0,0 +1,208 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Documents](../modules/Documents.Documents-1.md) / IRecipient
+
+# Interface: IRecipient
+
+[Documents](../modules/Documents.md).[Documents](../modules/Documents.Documents-1.md).IRecipient
+
+## Table of contents
+
+### Properties
+
+- [agreed](Documents.Documents-1.IRecipient.md#agreed)
+- [claimed](Documents.Documents-1.IRecipient.md#claimed)
+- [created_at](Documents.Documents-1.IRecipient.md#created_at)
+- [delegated_to](Documents.Documents-1.IRecipient.md#delegated_to)
+- [delegator](Documents.Documents-1.IRecipient.md#delegator)
+- [email](Documents.Documents-1.IRecipient.md#email)
+- [envelope_id](Documents.Documents-1.IRecipient.md#envelope_id)
+- [full_name](Documents.Documents-1.IRecipient.md#full_name)
+- [in_app_access_key](Documents.Documents-1.IRecipient.md#in_app_access_key)
+- [key_used_to_conclude](Documents.Documents-1.IRecipient.md#key_used_to_conclude)
+- [message](Documents.Documents-1.IRecipient.md#message)
+- [phone](Documents.Documents-1.IRecipient.md#phone)
+- [profile_id](Documents.Documents-1.IRecipient.md#profile_id)
+- [role_name](Documents.Documents-1.IRecipient.md#role_name)
+- [sequence](Documents.Documents-1.IRecipient.md#sequence)
+- [status](Documents.Documents-1.IRecipient.md#status)
+- [type](Documents.Documents-1.IRecipient.md#type)
+- [updated_at](Documents.Documents-1.IRecipient.md#updated_at)
+
+## Properties
+
+### agreed
+
+• **agreed**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:54](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L54)
+
+___
+
+### claimed
+
+• **claimed**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:55](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L55)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:56](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L56)
+
+___
+
+### delegated\_to
+
+• **delegated\_to**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Documents.ts:57](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L57)
+
+___
+
+### delegator
+
+• **delegator**: `boolean`
+
+#### Defined in
+
+[Documents/Documents.ts:58](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L58)
+
+___
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:59](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L59)
+
+___
+
+### envelope\_id
+
+• **envelope\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:60](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L60)
+
+___
+
+### full\_name
+
+• **full\_name**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:61](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L61)
+
+___
+
+### in\_app\_access\_key
+
+• **in\_app\_access\_key**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:62](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L62)
+
+___
+
+### key\_used\_to\_conclude
+
+• **key\_used\_to\_conclude**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:63](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L63)
+
+___
+
+### message
+
+• **message**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Documents.ts:64](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L64)
+
+___
+
+### phone
+
+• **phone**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:65](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L65)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:66](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L66)
+
+___
+
+### role\_name
+
+• **role\_name**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:67](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L67)
+
+___
+
+### sequence
+
+• **sequence**: `number`
+
+#### Defined in
+
+[Documents/Documents.ts:68](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L68)
+
+___
+
+### status
+
+• **status**: [`IRecipientStatus`](../modules/Documents.Documents-1.md#irecipientstatus)
+
+#### Defined in
+
+[Documents/Documents.ts:69](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L69)
+
+___
+
+### type
+
+• **type**: [`IRecipientType`](../modules/Documents.Documents-1.md#irecipienttype)
+
+#### Defined in
+
+[Documents/Documents.ts:70](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L70)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[Documents/Documents.ts:71](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L71)

package/docs/interfaces/Documents.Types.ITemplateSummaryEntry.md

@@ -0,0 +1,186 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Types](../modules/Documents.Types.md) / ITemplateSummaryEntry
+
+# Interface: ITemplateSummaryEntry
+
+[Documents](../modules/Documents.md).[Types](../modules/Documents.Types.md).ITemplateSummaryEntry
+
+## Table of contents
+
+### Properties
+
+- [counter](Documents.Types.ITemplateSummaryEntry.md#counter)
+- [created_at](Documents.Types.ITemplateSummaryEntry.md#created_at)
+- [description](Documents.Types.ITemplateSummaryEntry.md#description)
+- [document_name](Documents.Types.ITemplateSummaryEntry.md#document_name)
+- [id](Documents.Types.ITemplateSummaryEntry.md#id)
+- [is_personal](Documents.Types.ITemplateSummaryEntry.md#is_personal)
+- [is_public](Documents.Types.ITemplateSummaryEntry.md#is_public)
+- [is_starred](Documents.Types.ITemplateSummaryEntry.md#is_starred)
+- [last_used_at](Documents.Types.ITemplateSummaryEntry.md#last_used_at)
+- [name](Documents.Types.ITemplateSummaryEntry.md#name)
+- [organization_id](Documents.Types.ITemplateSummaryEntry.md#organization_id)
+- [profile_id](Documents.Types.ITemplateSummaryEntry.md#profile_id)
+- [sender](Documents.Types.ITemplateSummaryEntry.md#sender)
+- [star_counter](Documents.Types.ITemplateSummaryEntry.md#star_counter)
+- [tag_name](Documents.Types.ITemplateSummaryEntry.md#tag_name)
+- [updated_at](Documents.Types.ITemplateSummaryEntry.md#updated_at)
+
+## Properties
+
+### counter
+
+• **counter**: `number`
+
+#### Defined in
+
+[Documents/Types.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L5)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:7](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L7)
+
+___
+
+### description
+
+• **description**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Types.ts:6](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L6)
+
+___
+
+### document\_name
+
+• **document\_name**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Types.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L14)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:2](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L2)
+
+___
+
+### is\_personal
+
+• **is\_personal**: `boolean`
+
+#### Defined in
+
+[Documents/Types.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L9)
+
+___
+
+### is\_public
+
+• **is\_public**: `boolean`
+
+#### Defined in
+
+[Documents/Types.ts:10](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L10)
+
+___
+
+### is\_starred
+
+• **is\_starred**: `boolean`
+
+#### Defined in
+
+[Documents/Types.ts:17](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L17)
+
+___
+
+### last\_used\_at
+
+• **last\_used\_at**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Types.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L13)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L3)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:12](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L12)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:11](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L11)
+
+___
+
+### sender
+
+• **sender**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L4)
+
+___
+
+### star\_counter
+
+• **star\_counter**: `number`
+
+#### Defined in
+
+[Documents/Types.ts:15](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L15)
+
+___
+
+### tag\_name
+
+• **tag\_name**: ``null`` \| `string`
+
+#### Defined in
+
+[Documents/Types.ts:16](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L16)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[Documents/Types.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L8)

package/docs/interfaces/Documents.Types.ITemplatesSummary.md

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](../modules/Documents.md) / [Types](../modules/Documents.Types.md) / ITemplatesSummary
+
+# Interface: ITemplatesSummary
+
+[Documents](../modules/Documents.md).[Types](../modules/Documents.Types.md).ITemplatesSummary
+
+## Table of contents
+
+### Properties
+
+- [page](Documents.Types.ITemplatesSummary.md#page)
+- [result](Documents.Types.ITemplatesSummary.md#result)
+- [total](Documents.Types.ITemplatesSummary.md#total)
+
+## Properties
+
+### page
+
+• **page**: `number`
+
+#### Defined in
+
+[Documents/Types.ts:21](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L21)
+
+___
+
+### result
+
+• **result**: [`ITemplateSummaryEntry`](Documents.Types.ITemplateSummaryEntry.md)[]
+
+#### Defined in
+
+[Documents/Types.ts:23](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L23)
+
+___
+
+### total
+
+• **total**: `number`
+
+#### Defined in
+
+[Documents/Types.ts:22](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Types.ts#L22)