@verdocs/js-sdk 1.0.8 → 1.0.12

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

@@ -0,0 +1,219 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / ITemplate
+
+# Interface: ITemplate
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).ITemplate
+
+## Table of contents
+
+### Properties
+
+- [counter](Templates.Types.ITemplate.md#counter)
+- [created_at](Templates.Types.ITemplate.md#created_at)
+- [description](Templates.Types.ITemplate.md#description)
+- [id](Templates.Types.ITemplate.md#id)
+- [is_personal](Templates.Types.ITemplate.md#is_personal)
+- [is_public](Templates.Types.ITemplate.md#is_public)
+- [last_used_at](Templates.Types.ITemplate.md#last_used_at)
+- [name](Templates.Types.ITemplate.md#name)
+- [organization_id](Templates.Types.ITemplate.md#organization_id)
+- [pages](Templates.Types.ITemplate.md#pages)
+- [profile_id](Templates.Types.ITemplate.md#profile_id)
+- [reminder](Templates.Types.ITemplate.md#reminder)
+- [reminder_id](Templates.Types.ITemplate.md#reminder_id)
+- [roles](Templates.Types.ITemplate.md#roles)
+- [sender](Templates.Types.ITemplate.md#sender)
+- [star_counter](Templates.Types.ITemplate.md#star_counter)
+- [template_document](Templates.Types.ITemplate.md#template_document)
+- [token](Templates.Types.ITemplate.md#token)
+- [updated_at](Templates.Types.ITemplate.md#updated_at)
+
+## Properties
+
+### counter
+
+• `Optional` **counter**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L5)
+
+___
+
+### created\_at
+
+• `Optional` **created\_at**: `Date`
+
+#### Defined in
+
+[Templates/Types.ts:10](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L10)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:20](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L20)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L8)
+
+___
+
+### is\_personal
+
+• `Optional` **is\_personal**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:17](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L17)
+
+___
+
+### is\_public
+
+• `Optional` **is\_public**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:18](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L18)
+
+___
+
+### last\_used\_at
+
+• `Optional` **last\_used\_at**: `Date`
+
+#### Defined in
+
+[Templates/Types.ts:12](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L12)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:7](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L7)
+
+___
+
+### organization\_id
+
+• `Optional` **organization\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:16](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L16)
+
+___
+
+### pages
+
+• `Optional` **pages**: [`IPage`](Templates.Types.IPage.md)[]
+
+#### Defined in
+
+[Templates/Types.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L3)
+
+___
+
+### profile\_id
+
+• `Optional` **profile\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L9)
+
+___
+
+### reminder
+
+• `Optional` **reminder**: [`IReminder`](Templates.Types.IReminder.md)
+
+#### Defined in
+
+[Templates/Types.ts:15](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L15)
+
+___
+
+### reminder\_id
+
+• `Optional` **reminder\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L14)
+
+___
+
+### roles
+
+• `Optional` **roles**: [`IRole`](Templates.Types.IRole.md)[]
+
+#### Defined in
+
+[Templates/Types.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L4)
+
+___
+
+### sender
+
+• `Optional` **sender**: [`TemplateSenderTypes`](../enums/Templates.Types.TemplateSenderTypes.md)
+
+#### Defined in
+
+[Templates/Types.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L19)
+
+___
+
+### star\_counter
+
+• `Optional` **star\_counter**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:6](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L6)
+
+___
+
+### template\_document
+
+• `Optional` **template\_document**: [`IDocument`](Templates.Types.IDocument.md)
+
+#### Defined in
+
+[Templates/Types.ts:2](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L2)
+
+___
+
+### token
+
+• `Optional` **token**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L13)
+
+___
+
+### updated\_at
+
+• `Optional` **updated\_at**: `Date`
+
+#### Defined in
+
+[Templates/Types.ts:11](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L11)

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

@@ -0,0 +1,197 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / ITemplateSearchParams
+
+# Interface: ITemplateSearchParams
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).ITemplateSearchParams
+
+## Table of contents
+
+### Properties
+
+- [ascending](Templates.Types.ITemplateSearchParams.md#ascending)
+- [created_at](Templates.Types.ITemplateSearchParams.md#created_at)
+- [description](Templates.Types.ITemplateSearchParams.md#description)
+- [document_name](Templates.Types.ITemplateSearchParams.md#document_name)
+- [id](Templates.Types.ITemplateSearchParams.md#id)
+- [is_personal](Templates.Types.ITemplateSearchParams.md#is_personal)
+- [is_public](Templates.Types.ITemplateSearchParams.md#is_public)
+- [last_used_at](Templates.Types.ITemplateSearchParams.md#last_used_at)
+- [name](Templates.Types.ITemplateSearchParams.md#name)
+- [organization_id](Templates.Types.ITemplateSearchParams.md#organization_id)
+- [page](Templates.Types.ITemplateSearchParams.md#page)
+- [profile_id](Templates.Types.ITemplateSearchParams.md#profile_id)
+- [row](Templates.Types.ITemplateSearchParams.md#row)
+- [sender](Templates.Types.ITemplateSearchParams.md#sender)
+- [sort_by](Templates.Types.ITemplateSearchParams.md#sort_by)
+- [tags](Templates.Types.ITemplateSearchParams.md#tags)
+- [updated_at](Templates.Types.ITemplateSearchParams.md#updated_at)
+
+## Properties
+
+### ascending
+
+• `Optional` **ascending**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:92](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L92)
+
+___
+
+### created\_at
+
+• `Optional` **created\_at**: [`ITimePeriod`](Templates.Types.ITimePeriod.md)
+
+#### Defined in
+
+[Templates/Types.ts:85](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L85)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:81](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L81)
+
+___
+
+### document\_name
+
+• `Optional` **document\_name**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:90](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L90)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:78](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L78)
+
+___
+
+### is\_personal
+
+• `Optional` **is\_personal**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:87](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L87)
+
+___
+
+### is\_public
+
+• `Optional` **is\_public**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:88](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L88)
+
+___
+
+### last\_used\_at
+
+• `Optional` **last\_used\_at**: [`ITimePeriod`](Templates.Types.ITimePeriod.md)
+
+#### Defined in
+
+[Templates/Types.ts:86](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L86)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:79](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L79)
+
+___
+
+### organization\_id
+
+• `Optional` **organization\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:83](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L83)
+
+___
+
+### page
+
+• `Optional` **page**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:94](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L94)
+
+___
+
+### profile\_id
+
+• `Optional` **profile\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:82](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L82)
+
+___
+
+### row
+
+• `Optional` **row**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:93](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L93)
+
+___
+
+### sender
+
+• `Optional` **sender**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:80](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L80)
+
+___
+
+### sort\_by
+
+• `Optional` **sort\_by**: [`SortOptions`](../enums/Templates.Types.SortOptions.md)
+
+#### Defined in
+
+[Templates/Types.ts:91](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L91)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string`[]
+
+#### Defined in
+
+[Templates/Types.ts:89](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L89)
+
+___
+
+### updated\_at
+
+• `Optional` **updated\_at**: [`ITimePeriod`](Templates.Types.ITimePeriod.md)
+
+#### Defined in
+
+[Templates/Types.ts:84](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L84)

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

@@ -0,0 +1,186 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / ITemplateSummaryEntry
+
+# Interface: ITemplateSummaryEntry
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).ITemplateSummaryEntry
+
+## Table of contents
+
+### Properties
+
+- [counter](Templates.Types.ITemplateSummaryEntry.md#counter)
+- [created_at](Templates.Types.ITemplateSummaryEntry.md#created_at)
+- [description](Templates.Types.ITemplateSummaryEntry.md#description)
+- [document_name](Templates.Types.ITemplateSummaryEntry.md#document_name)
+- [id](Templates.Types.ITemplateSummaryEntry.md#id)
+- [is_personal](Templates.Types.ITemplateSummaryEntry.md#is_personal)
+- [is_public](Templates.Types.ITemplateSummaryEntry.md#is_public)
+- [is_starred](Templates.Types.ITemplateSummaryEntry.md#is_starred)
+- [last_used_at](Templates.Types.ITemplateSummaryEntry.md#last_used_at)
+- [name](Templates.Types.ITemplateSummaryEntry.md#name)
+- [organization_id](Templates.Types.ITemplateSummaryEntry.md#organization_id)
+- [profile_id](Templates.Types.ITemplateSummaryEntry.md#profile_id)
+- [sender](Templates.Types.ITemplateSummaryEntry.md#sender)
+- [star_counter](Templates.Types.ITemplateSummaryEntry.md#star_counter)
+- [tag_name](Templates.Types.ITemplateSummaryEntry.md#tag_name)
+- [updated_at](Templates.Types.ITemplateSummaryEntry.md#updated_at)
+
+## Properties
+
+### counter
+
+• **counter**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:27](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L27)
+
+___
+
+### created\_at
+
+• **created\_at**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:29](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L29)
+
+___
+
+### description
+
+• **description**: ``null`` \| `string`
+
+#### Defined in
+
+[Templates/Types.ts:28](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L28)
+
+___
+
+### document\_name
+
+• **document\_name**: ``null`` \| `string`
+
+#### Defined in
+
+[Templates/Types.ts:36](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L36)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:24](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L24)
+
+___
+
+### is\_personal
+
+• **is\_personal**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:31](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L31)
+
+___
+
+### is\_public
+
+• **is\_public**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:32](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L32)
+
+___
+
+### is\_starred
+
+• **is\_starred**: `boolean`
+
+#### Defined in
+
+[Templates/Types.ts:39](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L39)
+
+___
+
+### last\_used\_at
+
+• **last\_used\_at**: ``null`` \| `string`
+
+#### Defined in
+
+[Templates/Types.ts:35](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L35)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:25](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L25)
+
+___
+
+### organization\_id
+
+• **organization\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:34](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L34)
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:33](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L33)
+
+___
+
+### sender
+
+• **sender**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:26](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L26)
+
+___
+
+### star\_counter
+
+• **star\_counter**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:37](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L37)
+
+___
+
+### tag\_name
+
+• **tag\_name**: ``null`` \| `string`
+
+#### Defined in
+
+[Templates/Types.ts:38](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L38)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `string`
+
+#### Defined in
+
+[Templates/Types.ts:30](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L30)

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

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / ITemplatesSearchResult
+
+# Interface: ITemplatesSearchResult
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).ITemplatesSearchResult
+
+## Table of contents
+
+### Properties
+
+- [page](Templates.Types.ITemplatesSearchResult.md#page)
+- [result](Templates.Types.ITemplatesSearchResult.md#result)
+- [total](Templates.Types.ITemplatesSearchResult.md#total)
+
+## Properties
+
+### page
+
+• **page**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:118](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L118)
+
+___
+
+### result
+
+• **result**: [`ITemplate`](Templates.Types.ITemplate.md)[]
+
+#### Defined in
+
+[Templates/Types.ts:120](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L120)
+
+___
+
+### total
+
+• **total**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:119](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L119)

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

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](../modules/Templates.md) / [Types](../modules/Templates.Types.md) / ITemplatesSummary
+
+# Interface: ITemplatesSummary
+
+[Templates](../modules/Templates.md).[Types](../modules/Templates.Types.md).ITemplatesSummary
+
+## Table of contents
+
+### Properties
+
+- [page](Templates.Types.ITemplatesSummary.md#page)
+- [result](Templates.Types.ITemplatesSummary.md#result)
+- [total](Templates.Types.ITemplatesSummary.md#total)
+
+## Properties
+
+### page
+
+• **page**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:112](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L112)
+
+___
+
+### result
+
+• **result**: [`ITemplateSummaryEntry`](Templates.Types.ITemplateSummaryEntry.md)[]
+
+#### Defined in
+
+[Templates/Types.ts:114](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L114)
+
+___
+
+### total
+
+• **total**: `number`
+
+#### Defined in
+
+[Templates/Types.ts:113](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Types.ts#L113)