@verdocs/js-sdk 1.0.8 → 1.0.12

package/docs/modules/Templates.Reminders.md

@@ -0,0 +1,98 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Reminders
+
+# Namespace: Reminders
+
+[Templates](Templates.md).Reminders
+
+## Table of contents
+
+### Functions
+
+- [createReminder](Templates.Reminders.md#createreminder)
+- [deleteReminder](Templates.Reminders.md#deletereminder)
+- [editReminder](Templates.Reminders.md#editreminder)
+- [getReminder](Templates.Reminders.md#getreminder)
+
+## Functions
+
+### createReminder
+
+▸ `Const` **createReminder**(`templateId`, `params`): `Promise`<[`ITemplate`](../interfaces/Templates.Types.ITemplate.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ITemplate`](../interfaces/Templates.Types.ITemplate.md)\>
+
+#### Defined in
+
+[Templates/Reminders.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Reminders.ts#L4)
+
+___
+
+### deleteReminder
+
+▸ `Const` **deleteReminder**(`templateId`, `reminderId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `reminderId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Reminders.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Reminders.ts#L19)
+
+___
+
+### editReminder
+
+▸ `Const` **editReminder**(`templateId`, `reminderId`): `Promise`<[`IReminder`](../interfaces/Templates.Types.IReminder.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `reminderId` | `string` |
+
+#### Returns
+
+`Promise`<[`IReminder`](../interfaces/Templates.Types.IReminder.md)\>
+
+#### Defined in
+
+[Templates/Reminders.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Reminders.ts#L14)
+
+___
+
+### getReminder
+
+▸ `Const` **getReminder**(`templateId`, `reminderId`): `Promise`<[`IReminder`](../interfaces/Templates.Types.IReminder.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `reminderId` | `string` |
+
+#### Returns
+
+`Promise`<[`IReminder`](../interfaces/Templates.Types.IReminder.md)\>
+
+#### Defined in
+
+[Templates/Reminders.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Reminders.ts#L9)

package/docs/modules/Templates.Roles.md

@@ -0,0 +1,163 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Roles
+
+# Namespace: Roles
+
+[Templates](Templates.md).Roles
+
+## Table of contents
+
+### Functions
+
+- [createRole](Templates.Roles.md#createrole)
+- [deleteRole](Templates.Roles.md#deleterole)
+- [deleteSequence](Templates.Roles.md#deletesequence)
+- [editRole](Templates.Roles.md#editrole)
+- [getRole](Templates.Roles.md#getrole)
+- [getRoleFields](Templates.Roles.md#getrolefields)
+- [getRoles](Templates.Roles.md#getroles)
+
+## Functions
+
+### createRole
+
+▸ `Const` **createRole**(`templateId`, `params`): `Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | [`IRole`](../interfaces/Templates.Types.IRole.md) |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)\>
+
+#### Defined in
+
+[Templates/Roles.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L4)
+
+___
+
+### deleteRole
+
+▸ `Const` **deleteRole**(`templateId`, `roleName`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `roleName` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Roles.ts:24](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L24)
+
+___
+
+### deleteSequence
+
+▸ `Const` **deleteSequence**(`templateId`): `Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)[]\>
+
+#### Defined in
+
+[Templates/Roles.ts:34](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L34)
+
+___
+
+### editRole
+
+▸ `Const` **editRole**(`templateId`, `roleName`, `params`): `Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `roleName` | `string` |
+| `params` | [`IRole`](../interfaces/Templates.Types.IRole.md) |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)\>
+
+#### Defined in
+
+[Templates/Roles.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L19)
+
+___
+
+### getRole
+
+▸ `Const` **getRole**(`templateId`, `roleName`): `Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `roleName` | `string` |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)\>
+
+#### Defined in
+
+[Templates/Roles.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L14)
+
+___
+
+### getRoleFields
+
+▸ `Const` **getRoleFields**(`templateId`, `roleName`): `Promise`<[`IField`](../interfaces/Templates.Types.IField.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `roleName` | `string` |
+
+#### Returns
+
+`Promise`<[`IField`](../interfaces/Templates.Types.IField.md)[]\>
+
+#### Defined in
+
+[Templates/Roles.ts:29](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L29)
+
+___
+
+### getRoles
+
+▸ `Const` **getRoles**(`templateId`): `Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<[`IRole`](../interfaces/Templates.Types.IRole.md)[]\>
+
+#### Defined in
+
+[Templates/Roles.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Roles.ts#L9)

package/docs/modules/Templates.Stars.md

@@ -0,0 +1,52 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Stars
+
+# Namespace: Stars
+
+[Templates](Templates.md).Stars
+
+## Table of contents
+
+### Functions
+
+- [getStars](Templates.Stars.md#getstars)
+- [toggleStar](Templates.Stars.md#togglestar)
+
+## Functions
+
+### getStars
+
+▸ `Const` **getStars**(`templateId`): `Promise`<[`IStar`](../interfaces/Templates.Types.IStar.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<[`IStar`](../interfaces/Templates.Types.IStar.md)[]\>
+
+#### Defined in
+
+[Templates/Stars.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Stars.ts#L4)
+
+___
+
+### toggleStar
+
+▸ `Const` **toggleStar**(`templateId`): `Promise`<[`ITemplatesSummary`](../interfaces/Templates.Types.ITemplatesSummary.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<[`ITemplatesSummary`](../interfaces/Templates.Types.ITemplatesSummary.md)\>
+
+#### Defined in
+
+[Templates/Stars.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Stars.ts#L9)

package/docs/modules/Templates.Tags.md

@@ -0,0 +1,75 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Tags
+
+# Namespace: Tags
+
+[Templates](Templates.md).Tags
+
+## Table of contents
+
+### Functions
+
+- [createTag](Templates.Tags.md#createtag)
+- [deleteTag](Templates.Tags.md#deletetag)
+- [getTags](Templates.Tags.md#gettags)
+
+## Functions
+
+### createTag
+
+▸ `Const` **createTag**(`templateId`, `params`): `Promise`<[`ITag`](../interfaces/Templates.Types.ITag.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ITag`](../interfaces/Templates.Types.ITag.md)\>
+
+#### Defined in
+
+[Templates/Tags.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Tags.ts#L4)
+
+___
+
+### deleteTag
+
+▸ `Const` **deleteTag**(`templateId`, `tagName`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `tagName` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Tags.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Tags.ts#L14)
+
+___
+
+### getTags
+
+▸ `Const` **getTags**(`templateId`): `Promise`<[`ITag`](../interfaces/Templates.Types.ITag.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<[`ITag`](../interfaces/Templates.Types.ITag.md)[]\>
+
+#### Defined in
+
+[Templates/Tags.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Tags.ts#L9)

package/docs/modules/Templates.Templates-1.md

@@ -0,0 +1,139 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Templates
+
+# Namespace: Templates
+
+[Templates](Templates.md).Templates
+
+## Table of contents
+
+### Functions
+
+- [createTemplate](Templates.Templates-1.md#createtemplate)
+- [editTemplate](Templates.Templates-1.md#edittemplate)
+- [getSummary](Templates.Templates-1.md#getsummary)
+- [getTemplate](Templates.Templates-1.md#gettemplate)
+- [getTemplates](Templates.Templates-1.md#gettemplates)
+- [searchTemplate](Templates.Templates-1.md#searchtemplate)
+
+## Functions
+
+### createTemplate
+
+▸ `Const` **createTemplate**(`params`): `Promise`<[`ITemplate`](../interfaces/Templates.Types.ITemplate.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ITemplate`](../interfaces/Templates.Types.ITemplate.md)\>
+
+#### Defined in
+
+[Templates/Templates.ts:15](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Templates.ts#L15)
+
+___
+
+### editTemplate
+
+▸ `Const` **editTemplate**(`templateId`, `params`): `Promise`<[`ITemplate`](../interfaces/Templates.Types.ITemplate.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ITemplate`](../interfaces/Templates.Types.ITemplate.md)\>
+
+#### Defined in
+
+[Templates/Templates.ts:20](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Templates.ts#L20)
+
+___
+
+### getSummary
+
+▸ `Const` **getSummary**(`page`): `Promise`<[`ITemplatesSummary`](../interfaces/Templates.Types.ITemplatesSummary.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+
+#### Returns
+
+`Promise`<[`ITemplatesSummary`](../interfaces/Templates.Types.ITemplatesSummary.md)\>
+
+#### Defined in
+
+[Templates/Templates.ts:39](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Templates.ts#L39)
+
+___
+
+### getTemplate
+
+▸ `Const` **getTemplate**(`templateId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Templates.ts:10](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Templates.ts#L10)
+
+___
+
+### getTemplates
+
+▸ `Const` **getTemplates**(): `Promise`<`any`[]\>
+
+#### Returns
+
+`Promise`<`any`[]\>
+
+#### Defined in
+
+[Templates/Templates.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Templates.ts#L5)
+
+___
+
+### searchTemplate
+
+▸ `Const` **searchTemplate**(`params`): `Promise`<[`ITemplatesSearchResult`](../interfaces/Templates.Types.ITemplatesSearchResult.md)\>
+
+Search for templates matching various criteria.
+
+```typescript
+import {Templates} from '@verdocs/js-sdk/Templates';
+
+const {result, page, total} = await Templates.search({ ... });
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ITemplatesSearchResult`](../interfaces/Templates.Types.ITemplatesSearchResult.md)\>
+
+#### Defined in
+
+[Templates/Templates.ts:34](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Templates.ts#L34)

package/docs/modules/Templates.Types.md

@@ -0,0 +1,31 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Types
+
+# Namespace: Types
+
+[Templates](Templates.md).Types
+
+## Table of contents
+
+### Enumerations
+
+- [SortOptions](../enums/Templates.Types.SortOptions.md)
+- [Template](../enums/Templates.Types.Template.md)
+- [TemplatePermissions](../enums/Templates.Types.TemplatePermissions.md)
+- [TemplateSenderTypes](../enums/Templates.Types.TemplateSenderTypes.md)
+
+### Interfaces
+
+- [IDocument](../interfaces/Templates.Types.IDocument.md)
+- [IField](../interfaces/Templates.Types.IField.md)
+- [IPage](../interfaces/Templates.Types.IPage.md)
+- [IReminder](../interfaces/Templates.Types.IReminder.md)
+- [IRole](../interfaces/Templates.Types.IRole.md)
+- [ISetting](../interfaces/Templates.Types.ISetting.md)
+- [IStar](../interfaces/Templates.Types.IStar.md)
+- [ITag](../interfaces/Templates.Types.ITag.md)
+- [ITemplate](../interfaces/Templates.Types.ITemplate.md)
+- [ITemplateSearchParams](../interfaces/Templates.Types.ITemplateSearchParams.md)
+- [ITemplateSummaryEntry](../interfaces/Templates.Types.ITemplateSummaryEntry.md)
+- [ITemplatesSearchResult](../interfaces/Templates.Types.ITemplatesSearchResult.md)
+- [ITemplatesSummary](../interfaces/Templates.Types.ITemplatesSummary.md)
+- [ITimePeriod](../interfaces/Templates.Types.ITimePeriod.md)

package/docs/modules/Templates.md

@@ -0,0 +1,17 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Templates
+
+# Namespace: Templates
+
+## Table of contents
+
+### Namespaces
+
+- [Documents](Templates.Documents.md)
+- [Fields](Templates.Fields.md)
+- [Pages](Templates.Pages.md)
+- [Reminders](Templates.Reminders.md)
+- [Roles](Templates.Roles.md)
+- [Stars](Templates.Stars.md)
+- [Tags](Templates.Tags.md)
+- [Templates](Templates.Templates-1.md)
+- [Types](Templates.Types.md)