@verdocs/js-sdk 1.0.8 → 1.0.12

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

@@ -0,0 +1,119 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / Organizations
+
+# Namespace: Organizations
+
+[Organizations](Organizations.md).Organizations
+
+## Table of contents
+
+### Functions
+
+- [createOrganization](Organizations.Organizations-1.md#createorganization)
+- [deleteOrganization](Organizations.Organizations-1.md#deleteorganization)
+- [getOrganization](Organizations.Organizations-1.md#getorganization)
+- [getOrganizations](Organizations.Organizations-1.md#getorganizations)
+- [updateOrganization](Organizations.Organizations-1.md#updateorganization)
+- [validateOrganization](Organizations.Organizations-1.md#validateorganization)
+
+## Functions
+
+### createOrganization
+
+▸ `Const` **createOrganization**(): `Promise`<[`IOrganization`](../interfaces/Organizations.Types.IOrganization.md)\>
+
+#### Returns
+
+`Promise`<[`IOrganization`](../interfaces/Organizations.Types.IOrganization.md)\>
+
+#### Defined in
+
+[Organizations/Organizations.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L9)
+
+___
+
+### deleteOrganization
+
+▸ `Const` **deleteOrganization**(`organizationId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Organizations.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L19)
+
+___
+
+### getOrganization
+
+▸ `Const` **getOrganization**(`organizationId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Organizations.ts:24](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L24)
+
+___
+
+### getOrganizations
+
+▸ `Const` **getOrganizations**(): `Promise`<[`IOrganization`](../interfaces/Organizations.Types.IOrganization.md)[]\>
+
+#### Returns
+
+`Promise`<[`IOrganization`](../interfaces/Organizations.Types.IOrganization.md)[]\>
+
+#### Defined in
+
+[Organizations/Organizations.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L4)
+
+___
+
+### updateOrganization
+
+▸ `Const` **updateOrganization**(`organizationId`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Organizations.ts:29](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L29)
+
+___
+
+### validateOrganization
+
+▸ `Const` **validateOrganization**(): `Promise`<[`IOrganization`](../interfaces/Organizations.Types.IOrganization.md)\>
+
+#### Returns
+
+`Promise`<[`IOrganization`](../interfaces/Organizations.Types.IOrganization.md)\>
+
+#### Defined in
+
+[Organizations/Organizations.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Organizations.ts#L14)

package/docs/modules/Organizations.Types.md

@@ -0,0 +1,17 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / Types
+
+# Namespace: Types
+
+[Organizations](Organizations.md).Types
+
+## Table of contents
+
+### Interfaces
+
+- [IApiKey](../interfaces/Organizations.Types.IApiKey.md)
+- [IApiKeyWithSecret](../interfaces/Organizations.Types.IApiKeyWithSecret.md)
+- [ICreateApiKeyRequest](../interfaces/Organizations.Types.ICreateApiKeyRequest.md)
+- [IGroup](../interfaces/Organizations.Types.IGroup.md)
+- [IGroupDetail](../interfaces/Organizations.Types.IGroupDetail.md)
+- [IOrganization](../interfaces/Organizations.Types.IOrganization.md)
+- [IUpdateApiKeyRequest](../interfaces/Organizations.Types.IUpdateApiKeyRequest.md)

package/docs/modules/Organizations.Webhooks.md

@@ -0,0 +1,53 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Organizations](Organizations.md) / Webhooks
+
+# Namespace: Webhooks
+
+[Organizations](Organizations.md).Webhooks
+
+## Table of contents
+
+### Functions
+
+- [getWebhook](Organizations.Webhooks.md#getwebhook)
+- [updateWebhook](Organizations.Webhooks.md#updatewebhook)
+
+## Functions
+
+### getWebhook
+
+▸ `Const` **getWebhook**(`organizationId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Webhooks.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Webhooks.ts#L3)
+
+___
+
+### updateWebhook
+
+▸ `Const` **updateWebhook**(`organizationId`, `params`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `organizationId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Organizations/Webhooks.ts:8](https://github.com/Verdocs/js-sdk/blob/main/src/Organizations/Webhooks.ts#L8)

package/docs/modules/Organizations.md

@@ -0,0 +1,20 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Organizations
+
+# Namespace: Organizations
+
+An Organization is a high-level container within Verdocs that groups together Templates, Documents, Profiles, Billing, and
+other settings. A User may be a member of more than one Organization. Each membership is tracked by a Profile representing
+that user's settings within that organization. It is important to select the correct Profile before performing operations
+against the Verdocs API, as this also sets the Organization that will be operated on, and the user's permissions within it.
+
+## Table of contents
+
+### Namespaces
+
+- [ApiKeys](Organizations.ApiKeys.md)
+- [Groups](Organizations.Groups.md)
+- [Invitations](Organizations.Invitations.md)
+- [Members](Organizations.Members.md)
+- [Organizations](Organizations.Organizations-1.md)
+- [Types](Organizations.Types.md)
+- [Webhooks](Organizations.Webhooks.md)

package/docs/modules/Signatures.md

@@ -0,0 +1,90 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Signatures
+
+# Namespace: Signatures
+
+## Table of contents
+
+### Interfaces
+
+- [ISignature](../interfaces/Signatures.ISignature.md)
+
+### Functions
+
+- [createSignature](Signatures.md#createsignature)
+- [deleteSignature](Signatures.md#deletesignature)
+- [getSignature](Signatures.md#getsignature)
+- [getSignatures](Signatures.md#getsignatures)
+
+## Functions
+
+### createSignature
+
+▸ `Const` **createSignature**(`params`): `Promise`<[`ISignature`](../interfaces/Signatures.ISignature.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ISignature`](../interfaces/Signatures.ISignature.md)\>
+
+#### Defined in
+
+[Signatures.ts:11](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L11)
+
+___
+
+### deleteSignature
+
+▸ `Const` **deleteSignature**(`signatureId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `signatureId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Signatures.ts:26](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L26)
+
+___
+
+### getSignature
+
+▸ `Const` **getSignature**(`signatureId`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `signatureId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Signatures.ts:21](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L21)
+
+___
+
+### getSignatures
+
+▸ `Const` **getSignatures**(): `Promise`<[`ISignature`](../interfaces/Signatures.ISignature.md)[]\>
+
+#### Returns
+
+`Promise`<[`ISignature`](../interfaces/Signatures.ISignature.md)[]\>
+
+#### Defined in
+
+[Signatures.ts:16](https://github.com/Verdocs/js-sdk/blob/main/src/Signatures.ts#L16)

package/docs/modules/Tags.md

@@ -0,0 +1,75 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / Tags
+
+# Namespace: Tags
+
+## Table of contents
+
+### Interfaces
+
+- [ITags](../interfaces/Tags.ITags.md)
+
+### Functions
+
+- [createTag](Tags.md#createtag)
+- [getTag](Tags.md#gettag)
+- [searchTag](Tags.md#searchtag)
+
+## Functions
+
+### createTag
+
+▸ `Const` **createTag**(`params`): `Promise`<[`ITags`](../interfaces/Tags.ITags.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`ITags`](../interfaces/Tags.ITags.md) |
+
+#### Returns
+
+`Promise`<[`ITags`](../interfaces/Tags.ITags.md)\>
+
+#### Defined in
+
+[Tags.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Tags.ts#L9)
+
+___
+
+### getTag
+
+▸ `Const` **getTag**(`tagName`): `Promise`<[`ITags`](../interfaces/Tags.ITags.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tagName` | `string` |
+
+#### Returns
+
+`Promise`<[`ITags`](../interfaces/Tags.ITags.md)\>
+
+#### Defined in
+
+[Tags.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Tags.ts#L14)
+
+___
+
+### searchTag
+
+▸ `Const` **searchTag**(`params`): `Promise`<[`ITags`](../interfaces/Tags.ITags.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`ITags`](../interfaces/Tags.ITags.md)[]\>
+
+#### Defined in
+
+[Tags.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/Tags.ts#L19)

package/docs/modules/Templates.Documents.md

@@ -0,0 +1,129 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Documents
+
+# Namespace: Documents
+
+[Templates](Templates.md).Documents
+
+## Table of contents
+
+### Functions
+
+- [createDocument](Templates.Documents.md#createdocument)
+- [deleteDocument](Templates.Documents.md#deletedocument)
+- [getDocument](Templates.Documents.md#getdocument)
+- [getDocuments](Templates.Documents.md#getdocuments)
+
+## Functions
+
+### createDocument
+
+▸ `Const` **createDocument**(`templateId`, `params`): `Promise`<[`IDocument`](../interfaces/Templates.Types.IDocument.md)\>
+
+Create a Document for a particular Template.
+
+```typescript
+import {Documents} from '@verdocs/js-sdk/Templates';
+
+await Documents.createDocument(templateID, params);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`IDocument`](../interfaces/Templates.Types.IDocument.md)\>
+
+#### Defined in
+
+[Templates/Documents.ts:27](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Documents.ts#L27)
+
+___
+
+### deleteDocument
+
+▸ `Const` **deleteDocument**(`templateId`, `documentId`): `Promise`<`any`\>
+
+Delete a specific Document.
+
+```typescript
+import {Documents} from '@verdocs/js-sdk/Templates';
+
+await Documents.deleteDocument(templateID, documentID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `documentId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Documents.ts:55](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Documents.ts#L55)
+
+___
+
+### getDocument
+
+▸ `Const` **getDocument**(`templateId`, `documentId`): `Promise`<[`IDocument`](../interfaces/Templates.Types.IDocument.md)\>
+
+Get a specific Document.
+
+```typescript
+import {Documents} from '@verdocs/js-sdk/Templates';
+
+await Documents.getDocument(templateID, documentID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `documentId` | `string` |
+
+#### Returns
+
+`Promise`<[`IDocument`](../interfaces/Templates.Types.IDocument.md)\>
+
+#### Defined in
+
+[Templates/Documents.ts:41](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Documents.ts#L41)
+
+___
+
+### getDocuments
+
+▸ `Const` **getDocuments**(`templateId`): `Promise`<`any`\>
+
+Get all the Documents associated to a particular Template.
+
+```typescript
+import {Documents} from '@verdocs/js-sdk/Templates';
+
+await Documents.getDocuments(templateID);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Documents.ts:13](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Documents.ts#L13)

package/docs/modules/Templates.Fields.md

@@ -0,0 +1,77 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Fields
+
+# Namespace: Fields
+
+[Templates](Templates.md).Fields
+
+## Table of contents
+
+### Functions
+
+- [createField](Templates.Fields.md#createfield)
+- [deleteField](Templates.Fields.md#deletefield)
+- [editField](Templates.Fields.md#editfield)
+
+## Functions
+
+### createField
+
+▸ `Const` **createField**(`templateId`, `params`): `Promise`<[`IField`](../interfaces/Templates.Types.IField.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | [`IField`](../interfaces/Templates.Types.IField.md) |
+
+#### Returns
+
+`Promise`<[`IField`](../interfaces/Templates.Types.IField.md)\>
+
+#### Defined in
+
+[Templates/Fields.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Fields.ts#L4)
+
+___
+
+### deleteField
+
+▸ `Const` **deleteField**(`templateId`, `fieldName`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `fieldName` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Fields.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Fields.ts#L14)
+
+___
+
+### editField
+
+▸ `Const` **editField**(`templateId`, `fieldName`, `params`): `Promise`<[`IField`](../interfaces/Templates.Types.IField.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `fieldName` | `string` |
+| `params` | [`IField`](../interfaces/Templates.Types.IField.md) |
+
+#### Returns
+
+`Promise`<[`IField`](../interfaces/Templates.Types.IField.md)\>
+
+#### Defined in
+
+[Templates/Fields.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Fields.ts#L9)

package/docs/modules/Templates.Pages.md

@@ -0,0 +1,98 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Templates](Templates.md) / Pages
+
+# Namespace: Pages
+
+[Templates](Templates.md).Pages
+
+## Table of contents
+
+### Functions
+
+- [createPage](Templates.Pages.md#createpage)
+- [deletePage](Templates.Pages.md#deletepage)
+- [editPage](Templates.Pages.md#editpage)
+- [getPage](Templates.Pages.md#getpage)
+
+## Functions
+
+### createPage
+
+▸ `Const` **createPage**(`templateId`, `params`): `Promise`<[`IPage`](../interfaces/Templates.Types.IPage.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `params` | [`IPage`](../interfaces/Templates.Types.IPage.md) |
+
+#### Returns
+
+`Promise`<[`IPage`](../interfaces/Templates.Types.IPage.md)\>
+
+#### Defined in
+
+[Templates/Pages.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Pages.ts#L4)
+
+___
+
+### deletePage
+
+▸ `Const` **deletePage**(`templateId`, `sequence`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `sequence` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Pages.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Pages.ts#L19)
+
+___
+
+### editPage
+
+▸ `Const` **editPage**(`templateId`, `sequence`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `sequence` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Pages.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Pages.ts#L9)
+
+___
+
+### getPage
+
+▸ `Const` **getPage**(`templateId`, `sequence`): `Promise`<`any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `templateId` | `string` |
+| `sequence` | `string` |
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Templates/Pages.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Templates/Pages.ts#L14)