@verdocs/js-sdk 1.0.8 → 1.0.12

package/docs/interfaces/Users.Types.TokenValidationResponse.md

@@ -0,0 +1,36 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / TokenValidationResponse
+
+# Interface: TokenValidationResponse
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).TokenValidationResponse
+
+## Table of contents
+
+### Properties
+
+- [payload](Users.Types.TokenValidationResponse.md#payload)
+- [valid](Users.Types.TokenValidationResponse.md#valid)
+
+## Properties
+
+### payload
+
+• **payload**: `any`
+
+The decoded and validated body of the JWT
+
+#### Defined in
+
+[Users/Types.ts:135](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L135)
+
+___
+
+### valid
+
+• **valid**: `boolean`
+
+True if the token is valid
+
+#### Defined in
+
+[Users/Types.ts:133](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L133)

package/docs/interfaces/Users.Types.UpdateEmailRequest.md

@@ -0,0 +1,21 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / UpdateEmailRequest
+
+# Interface: UpdateEmailRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).UpdateEmailRequest
+
+## Table of contents
+
+### Properties
+
+- [email](Users.Types.UpdateEmailRequest.md#email)
+
+## Properties
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[Users/Types.ts:151](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L151)

package/docs/interfaces/Users.Types.UpdateEmailResponse.md

@@ -0,0 +1,21 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / UpdateEmailResponse
+
+# Interface: UpdateEmailResponse
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).UpdateEmailResponse
+
+## Table of contents
+
+### Properties
+
+- [profiles](Users.Types.UpdateEmailResponse.md#profiles)
+
+## Properties
+
+### profiles
+
+• **profiles**: [`IProfile`](Users.Types.IProfile.md)[]
+
+#### Defined in
+
+[Users/Types.ts:155](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L155)

package/docs/interfaces/Users.Types.UpdatePasswordRequest.md

@@ -0,0 +1,43 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / UpdatePasswordRequest
+
+# Interface: UpdatePasswordRequest
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).UpdatePasswordRequest
+
+## Table of contents
+
+### Properties
+
+- [email](Users.Types.UpdatePasswordRequest.md#email)
+- [newPassword](Users.Types.UpdatePasswordRequest.md#newpassword)
+- [oldPassword](Users.Types.UpdatePasswordRequest.md#oldpassword)
+
+## Properties
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[Users/Types.ts:139](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L139)
+
+___
+
+### newPassword
+
+• **newPassword**: `string`
+
+#### Defined in
+
+[Users/Types.ts:141](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L141)
+
+___
+
+### oldPassword
+
+• **oldPassword**: `string`
+
+#### Defined in
+
+[Users/Types.ts:140](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L140)

package/docs/interfaces/Users.Types.UpdatePasswordResponse.md

@@ -0,0 +1,34 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Users](../modules/Users.md) / [Types](../modules/Users.Types.md) / UpdatePasswordResponse
+
+# Interface: UpdatePasswordResponse
+
+[Users](../modules/Users.md).[Types](../modules/Users.Types.md).UpdatePasswordResponse
+
+## Table of contents
+
+### Properties
+
+- [message](Users.Types.UpdatePasswordResponse.md#message)
+- [status](Users.Types.UpdatePasswordResponse.md#status)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+Success or failure message
+
+#### Defined in
+
+[Users/Types.ts:147](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L147)
+
+___
+
+### status
+
+• **status**: [`TRequestStatus`](../modules/HTTP.Types.md#trequeststatus)
+
+#### Defined in
+
+[Users/Types.ts:145](https://github.com/Verdocs/js-sdk/blob/main/src/Users/Types.ts#L145)

package/docs/interfaces/Validators.IValidator.md

@@ -0,0 +1,32 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Validators](../modules/Validators.md) / IValidator
+
+# Interface: IValidator
+
+[Validators](../modules/Validators.md).IValidator
+
+## Table of contents
+
+### Properties
+
+- [name](Validators.IValidator.md#name)
+- [regex](Validators.IValidator.md#regex)
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[Validators.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L4)
+
+___
+
+### regex
+
+• **regex**: `string`
+
+#### Defined in
+
+[Validators.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Validators.ts#L5)

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

@@ -0,0 +1,137 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](Documents.md) / Documents
+
+# Namespace: Documents
+
+[Documents](Documents.md).Documents
+
+## Table of contents
+
+### Interfaces
+
+- [IActivityEntry](../interfaces/Documents.Documents-1.IActivityEntry.md)
+- [IDocument](../interfaces/Documents.Documents-1.IDocument.md)
+- [IDocumentSearchOptions](../interfaces/Documents.Documents-1.IDocumentSearchOptions.md)
+- [IDocumentsSearchResult](../interfaces/Documents.Documents-1.IDocumentsSearchResult.md)
+- [IDocumentsSearchResultEntry](../interfaces/Documents.Documents-1.IDocumentsSearchResultEntry.md)
+- [IDocumentsSummary](../interfaces/Documents.Documents-1.IDocumentsSummary.md)
+- [IHistory](../interfaces/Documents.Documents-1.IHistory.md)
+- [IRecipient](../interfaces/Documents.Documents-1.IRecipient.md)
+
+### Type aliases
+
+- [IDocumentStatus](Documents.Documents-1.md#idocumentstatus)
+- [IEventDetail](Documents.Documents-1.md#ieventdetail)
+- [IHistoryEvent](Documents.Documents-1.md#ihistoryevent)
+- [IRecipientStatus](Documents.Documents-1.md#irecipientstatus)
+- [IRecipientType](Documents.Documents-1.md#irecipienttype)
+
+### Functions
+
+- [getSummary](Documents.Documents-1.md#getsummary)
+- [search](Documents.Documents-1.md#search)
+
+## Type aliases
+
+### IDocumentStatus
+
+Ƭ **IDocumentStatus**: ``"complete"`` \| ``"pending"`` \| ``"progress"``
+
+#### Defined in
+
+[Documents/Documents.ts:3](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L3)
+
+___
+
+### IEventDetail
+
+Ƭ **IEventDetail**: ``"in_app"`` \| ``"mail"`` \| ``"signer"`` \| ``""``
+
+#### Defined in
+
+[Documents/Documents.ts:138](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L138)
+
+___
+
+### IHistoryEvent
+
+Ƭ **IHistoryEvent**: ``"recipient:invited"`` \| ``"recipient:opened"`` \| ``"recipient:agreed"`` \| ``"recipient:signed"`` \| ``"recipient:submitted"``
+
+#### Defined in
+
+[Documents/Documents.ts:131](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L131)
+
+___
+
+### IRecipientStatus
+
+Ƭ **IRecipientStatus**: ``"invited"`` \| ``"opened"`` \| ``"signed"`` \| ``"submitted"``
+
+#### Defined in
+
+[Documents/Documents.ts:5](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L5)
+
+___
+
+### IRecipientType
+
+Ƭ **IRecipientType**: ``"signer"`` \| ``"cc"``
+
+#### Defined in
+
+[Documents/Documents.ts:7](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L7)
+
+## Functions
+
+### getSummary
+
+▸ `Const` **getSummary**(`page`): `Promise`<[`IDocumentsSummary`](../interfaces/Documents.Documents-1.IDocumentsSummary.md)\>
+
+Get a summary of currently active documents.
+
+```typescript
+import {Documents} from '@verdocs/js-sdk/Documents';
+
+const {action_required, completed, waiting_on_others} = await Documents.getSummary();
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+
+#### Returns
+
+`Promise`<[`IDocumentsSummary`](../interfaces/Documents.Documents-1.IDocumentsSummary.md)\>
+
+#### Defined in
+
+[Documents/Documents.ts:149](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L149)
+
+___
+
+### search
+
+▸ `Const` **search**(`params`): `Promise`<[`IDocumentsSearchResult`](../interfaces/Documents.Documents-1.IDocumentsSearchResult.md)\>
+
+Search for documents matching various criteria.
+
+```typescript
+import {Documents} from '@verdocs/js-sdk/Documents';
+
+const {result, page, total} = await Documents.search({ ... });
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `any` |
+
+#### Returns
+
+`Promise`<[`IDocumentsSearchResult`](../interfaces/Documents.Documents-1.IDocumentsSearchResult.md)\>
+
+#### Defined in
+
+[Documents/Documents.ts:163](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Documents.ts#L163)

package/docs/modules/Documents.Stars.md

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

package/docs/modules/Documents.Templates.md

@@ -0,0 +1,61 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](Documents.md) / Templates
+
+# Namespace: Templates
+
+[Documents](Documents.md).Templates
+
+## Table of contents
+
+### Functions
+
+- [getSummary](Documents.Templates.md#getsummary)
+- [getTemplates](Documents.Templates.md#gettemplates)
+- [searchTemplates](Documents.Templates.md#searchtemplates)
+
+## Functions
+
+### getSummary
+
+▸ `Const` **getSummary**(`page`): `Promise`<[`ITemplatesSummary`](../interfaces/Documents.Types.ITemplatesSummary.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `page` | `number` |
+
+#### Returns
+
+`Promise`<[`ITemplatesSummary`](../interfaces/Documents.Types.ITemplatesSummary.md)\>
+
+#### Defined in
+
+[Documents/Templates.ts:14](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Templates.ts#L14)
+
+___
+
+### getTemplates
+
+▸ `Const` **getTemplates**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Documents/Templates.ts:4](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Templates.ts#L4)
+
+___
+
+### searchTemplates
+
+▸ `Const` **searchTemplates**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[Documents/Templates.ts:9](https://github.com/Verdocs/js-sdk/blob/main/src/Documents/Templates.ts#L9)

package/docs/modules/Documents.Types.md

@@ -0,0 +1,12 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [Documents](Documents.md) / Types
+
+# Namespace: Types
+
+[Documents](Documents.md).Types
+
+## Table of contents
+
+### Interfaces
+
+- [ITemplateSummaryEntry](../interfaces/Documents.Types.ITemplateSummaryEntry.md)
+- [ITemplatesSummary](../interfaces/Documents.Types.ITemplatesSummary.md)

package/docs/modules/Documents.md

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

package/docs/modules/HTTP.Transport.md

@@ -0,0 +1,150 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [HTTP](HTTP.md) / Transport
+
+# Namespace: Transport
+
+[HTTP](HTTP.md).Transport
+
+## Table of contents
+
+### Functions
+
+- [getEndpoint](HTTP.Transport.md#getendpoint)
+- [setAuthorization](HTTP.Transport.md#setauthorization)
+- [setBaseUrl](HTTP.Transport.md#setbaseurl)
+- [setClientID](HTTP.Transport.md#setclientid)
+- [setTimeout](HTTP.Transport.md#settimeout)
+
+## Functions
+
+### getEndpoint
+
+▸ `Const` **getEndpoint**(): `AxiosInstance`
+
+Helper to get the endpoint for direct access to HTTP functions.
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+console.log('Current timeout', Transport.getEndpoint().defaults.timeout);
+```
+
+#### Returns
+
+`AxiosInstance`
+
+#### Defined in
+
+[HTTP/Transport.ts:89](https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Transport.ts#L89)
+
+___
+
+### setAuthorization
+
+▸ `Const` **setAuthorization**(`accessToken`): `void`
+
+Set the auth token that will be used for Verdocs API calls.
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+Transport.setAuthorization(accessToken);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `accessToken` | ``null`` \| `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HTTP/Transport.ts:19](https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Transport.ts#L19)
+
+___
+
+### setBaseUrl
+
+▸ `Const` **setBaseUrl**(`baseUrl`): `void`
+
+Set the base URL for API calls. Typically this is https://api.verdocs.com/ and is the default. Change this only after consultation
+with Verdocs Developer Support.
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+Transport.setBaseUrl('https://api.verdiocs.com');
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `baseUrl` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HTTP/Transport.ts:57](https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Transport.ts#L57)
+
+___
+
+### setClientID
+
+▸ `Const` **setClientID**(`clientID`): `void`
+
+Set the Client ID for Verdocs API calls.
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+Transport.setClientID('1234);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `clientID` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HTTP/Transport.ts:40](https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Transport.ts#L40)
+
+___
+
+### setTimeout
+
+▸ `Const` **setTimeout**(`timeout`): `void`
+
+Set the timeout for API calls in milliseconds. 2000-4000ms is recommended for most purposes. 3000ms is the default.
+
+```typescript
+import {Transport} from '@verdocs/js-sdk/HTTP';
+
+Transport.setTimeout(3000);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `timeout` | `number` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[HTTP/Transport.ts:73](https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Transport.ts#L73)

package/docs/modules/HTTP.Types.md

@@ -0,0 +1,21 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / [HTTP](HTTP.md) / Types
+
+# Namespace: Types
+
+[HTTP](HTTP.md).Types
+
+## Table of contents
+
+### Type aliases
+
+- [TRequestStatus](HTTP.Types.md#trequeststatus)
+
+## Type aliases
+
+### TRequestStatus
+
+Ƭ **TRequestStatus**: ``"OK"`` \| ``"ERROR"``
+
+#### Defined in
+
+[HTTP/Types.ts:1](https://github.com/Verdocs/js-sdk/blob/main/src/HTTP/Types.ts#L1)

package/docs/modules/HTTP.md

@@ -0,0 +1,10 @@
+[@verdocs/js-sdk - v1.0.12](../README.md) / [Exports](../modules.md) / HTTP
+
+# Namespace: HTTP
+
+## Table of contents
+
+### Namespaces
+
+- [Transport](HTTP.Transport.md)
+- [Types](HTTP.Types.md)