boldsign 1.0.1 → 1.0.2

package/docs/EmbeddedSendTemplateFormRequest.md

@@ -0,0 +1,53 @@
+# # EmbeddedSendTemplateFormRequest
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `files` | ```Array<RequestFile>``` |   |  |
+| `fileUrls` | ```Array<string>``` |   |  |
+| `redirectUrl` | ```string``` |   |  |
+| `showToolbar` | ```boolean``` |   |  |
+| `sendViewOption` | ```string``` |   |  |
+| `showSaveButton` | ```boolean``` |   |  |
+| `locale` | ```string``` |   |  |
+| `showSendButton` | ```boolean``` |   |  |
+| `showPreviewButton` | ```boolean``` |   |  |
+| `showNavigationButtons` | ```boolean``` |   |  |
+| `sendLinkValidTill` | ```Date``` |   |  |
+| `showTooltip` | ```boolean``` |   |  |
+| `documentId` | ```string``` |   |  |
+| `title` | ```string``` |   |  |
+| `message` | ```string``` |   |  |
+| `roles` | [```Array<Role>```](Role.md) |   |  |
+| `brandId` | ```string``` |   |  |
+| `labels` | ```Array<string>``` |   |  |
+| `disableEmails` | ```boolean``` |   |  |
+| `disableSMS` | ```boolean``` |   |  [default to false] |
+| `hideDocumentId` | ```boolean``` |   |  |
+| `reminderSettings` | [```ReminderSettings```](ReminderSettings.md) |   |  |
+| `cc` | [```Array<DocumentCC>```](DocumentCC.md) |   |  |
+| `expiryDays` | ```number``` |   |  |
+| `expiryDateType` | ```string``` |   |  |
+| `expiryValue` | ```number``` |   |  [default to 60] |
+| `enablePrintAndSign` | ```boolean``` |   |  |
+| `enableReassign` | ```boolean``` |   |  |
+| `enableSigningOrder` | ```boolean``` |   |  |
+| `disableExpiryAlert` | ```boolean``` |   |  |
+| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+| `isSandbox` | ```boolean``` |   |  |
+| `roleRemovalIndices` | ```Array<number>``` |   |  |
+| `documentDownloadOption` | ```string``` |   |  |
+| `metaData` | ```{ [key: string]: string | null; }``` |   |  |
+| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) |   |  |
+| `formGroups` | [```Array<FormGroup>```](FormGroup.md) |   |  |
+| `removeFormFields` | ```Array<string>``` |   |  |
+| `enableAuditTrailLocalization` | ```boolean``` |   |  |
+| `downloadFileName` | ```string``` |   |  |
+| `scheduledSendTime` | ```number``` |   |  |
+| `allowScheduledSend` | ```boolean``` |   |  [default to false] |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/EmbeddedSigningLink.md

@@ -0,0 +1,11 @@
+# # EmbeddedSigningLink
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `signLink` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/EmbeddedTemplateCreated.md

@@ -0,0 +1,12 @@
+# # EmbeddedTemplateCreated
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `templateId` | ```string``` |   |  |
+| `createUrl` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/EmbeddedTemplateEditRequest.md

@@ -0,0 +1,21 @@
+# # EmbeddedTemplateEditRequest
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `redirectUrl` | ```string``` |   |  |
+| `showToolbar` | ```boolean``` |   |  [default to false] |
+| `viewOption` | ```string``` |   |  [default to ViewOptionEnum.PreparePage] |
+| `showSaveButton` | ```boolean``` |   |  [default to true] |
+| `locale` | ```string``` |   |  [default to LocaleEnum.En] |
+| `showCreateButton` | ```boolean``` |   |  [default to true] |
+| `showPreviewButton` | ```boolean``` |   |  [default to true] |
+| `showNavigationButtons` | ```boolean``` |   |  [default to true] |
+| `linkValidTill` | ```Date``` |   |  |
+| `showTooltip` | ```boolean``` |   |  [default to false] |
+| `onBehalfOf` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/EmbeddedTemplateEdited.md

@@ -0,0 +1,11 @@
+# # EmbeddedTemplateEdited
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `editUrl` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/Error.md

@@ -0,0 +1,12 @@
+# # ModelError
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `code` | ```string``` |   |  |
+| `message` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ErrorResult.md

@@ -0,0 +1,11 @@
+# # ErrorResult
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `error` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ExistingFormField.md

@@ -0,0 +1,15 @@
+# # ExistingFormField
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `index` | ```number``` |   |  |
+| `name` | ```string``` |   |  |
+| `id` | ```string``` |   |  |
+| `value` | ```string``` |   |  |
+| `isReadOnly` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ExtendExpiry.md

@@ -0,0 +1,14 @@
+# # ExtendExpiry
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `newExpiryValue` | ```string``` |   |  |
+| `newExpiryDate` | ```string``` |   |  |
+| `warnPrior` | ```boolean``` |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/FileInfo.md

@@ -0,0 +1,14 @@
+# # FileInfo
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `fileName` | ```string``` |   |  |
+| `fileSize` | ```number``` |   |  |
+| `contentType` | ```string``` |   |  |
+| `extension` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/Font.md

@@ -0,0 +1,18 @@
+# # Font
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `name` | ```string``` |   |  |
+| `color` | ```string``` |   |  |
+| `size` | ```number``` |   |  |
+| `style` | ```string``` |   |  |
+| `lineHeight` | ```number``` |   |  |
+| `isBoldFont` | ```boolean``` |   |  |
+| `isItalicFont` | ```boolean``` |   |  |
+| `isUnderLineFont` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/FormField.md

@@ -0,0 +1,50 @@
+# # FormField
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `fieldType`<sup>*_required_</sup> | ```string``` |   |  |
+| `pageNumber`<sup>*_required_</sup> | ```number``` |   |  |
+| `bounds`<sup>*_required_</sup> | [```Rectangle```](Rectangle.md) |   |  |
+| `id` | ```string``` |   |  |
+| `name` | ```string``` |   |  |
+| `isRequired` | ```boolean``` |   |  |
+| `isReadOnly` | ```boolean``` |   |  |
+| `value` | ```string``` |   |  |
+| `fontSize` | ```number``` |   |  |
+| `font` | ```string``` |   |  |
+| `fontHexColor` | ```string``` |   |  |
+| `isBoldFont` | ```boolean``` |   |  |
+| `isItalicFont` | ```boolean``` |   |  |
+| `isUnderLineFont` | ```boolean``` |   |  |
+| `lineHeight` | ```number``` |   |  |
+| `characterLimit` | ```number``` |   |  |
+| `groupName` | ```string``` |   |  |
+| `label` | ```string``` |   |  |
+| `placeHolder` | ```string``` |   |  |
+| `validationType` | ```string``` |   |  |
+| `validationCustomRegex` | ```string``` |   |  |
+| `validationCustomRegexMessage` | ```string``` |   |  |
+| `dateFormat` | ```string``` |   |  |
+| `timeFormat` | ```string``` |   |  |
+| `imageInfo` | [```ImageInfo```](ImageInfo.md) |   |  |
+| `attachmentInfo` | [```AttachmentInfo```](AttachmentInfo.md) |   |  |
+| `editableDateFieldSettings` | [```EditableDateFieldSettings```](EditableDateFieldSettings.md) |   |  |
+| `hyperlinkText` | ```string``` |   |  |
+| `conditionalRules` | [```Array<ConditionalRule>```](ConditionalRule.md) |   |  |
+| `dataSyncTag` | ```string``` |   |  |
+| `dropdownOptions` | ```Array<string>``` |   |  |
+| `textAlign` | ```string``` |   |  |
+| `textDirection` | ```string``` |   |  |
+| `characterSpacing` | ```number``` |   |  |
+| `backgroundHexColor` | ```string``` |   |  |
+| `tabIndex` | ```number``` |   |  |
+| `formulaFieldSettings` | [```FormulaFieldSettings```](FormulaFieldSettings.md) |   |  |
+| `resizeOption` | ```string``` |   |  |
+| `allowEditFormField` | ```boolean``` |   |  |
+| `allowDeleteFormField` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/FormGroup.md

@@ -0,0 +1,15 @@
+# # FormGroup
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `groupNames`<sup>*_required_</sup> | ```Array<string>``` |   |  |
+| `groupValidation`<sup>*_required_</sup> | ```string``` |   |  |
+| `minimumCount` | ```number``` |   |  |
+| `maximumCount` | ```number``` |   |  |
+| `dataSyncTag` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/FormulaFieldSettings.md

@@ -0,0 +1,12 @@
+# # FormulaFieldSettings
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `formulaExpression` | ```string``` |   |  |
+| `decimalPrecision` | ```number``` |   |  [default to 0] |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/IdDocument.md

@@ -0,0 +1,21 @@
+# # IdDocument
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `type` | ```string``` |   |  |
+| `firstName` | ```string``` |   |  |
+| `lastName` | ```string``` |   |  |
+| `country` | ```string``` |   |  |
+| `documentNumber` | ```string``` |   |  |
+| `address` | [```Address```](Address.md) |   |  |
+| `dob` | [```ModelDate```](ModelDate.md) |   |  |
+| `issuedDate` | [```ModelDate```](ModelDate.md) |   |  |
+| `expirationDate` | [```ModelDate```](ModelDate.md) |   |  |
+| `documentFiles` | ```Array<string>``` |   |  |
+| `selfieFile` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/IdReport.md

@@ -0,0 +1,14 @@
+# # IdReport
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `verificationResult` | ```string``` |   |  |
+| `verifiedDate` | ```Date``` |   |  |
+| `error` | ```Error``` |   |  |
+| `document` | [```IdDocument```](IdDocument.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/IdVerification.md

@@ -0,0 +1,18 @@
+# # IdVerification
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `type` | ```string``` |   |  |
+| `maximumRetryCount` | ```number``` |   |  |
+| `status` | ```string``` |   |  |
+| `nameMatcher` | ```string``` |   |  |
+| `requireLiveCapture` | ```boolean``` |   |  |
+| `requireMatchingSelfie` | ```boolean``` |   |  |
+| `holdForPrefill` | ```boolean``` |   |  |
+| `prefillCompleted` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/IdentityVerificationApi.md

@@ -0,0 +1,109 @@
+# IdentityVerificationApi
+
+All URIs are relative to https://api.boldsign.com.
+
+| Method | HTTP request | Description |
+| ------------- | ------------- | ------------- |
+| [**createEmbeddedVerificationUrl()**](IdentityVerificationApi.md#createEmbeddedVerificationUrl) | **POST** /v1/identityVerification/createEmbeddedVerificationUrl | Generate a URL that embeds manual ID verification for the specified document signer into your application. |
+| [**image()**](IdentityVerificationApi.md#image) | **POST** /v1/identityVerification/image | Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID. |
+| [**report()**](IdentityVerificationApi.md#report) | **POST** /v1/identityVerification/report | Retrieve the ID verification report for the specified document signer. |
+
+
+## `createEmbeddedVerificationUrl()`
+
+```typescript
+createEmbeddedVerificationUrl(documentId: string, embeddedFileDetails: EmbeddedFileDetails): EmbeddedFileLink
+```
+
+Generate a URL that embeds manual ID verification for the specified document signer into your application.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **documentId** | **string**| The document id. | |
+| **embeddedFileDetails** | [**EmbeddedFileDetails**](../docs/EmbeddedFileDetails.md)| The embedded verification link request. | [optional] |
+
+### Return type
+
+[**EmbeddedFileLink**](../docs/EmbeddedFileLink.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `image()`
+
+```typescript
+image(documentId: string, downloadImageRequest: DownloadImageRequest): Buffer
+```
+
+Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **documentId** | **string**| The document id. | |
+| **downloadImageRequest** | [**DownloadImageRequest**](../docs/DownloadImageRequest.md)| The download image request. | |
+
+### Return type
+
+**Buffer**
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
+- **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)
+
+## `report()`
+
+```typescript
+report(documentId: string, verificationDataRequest: VerificationDataRequest): IdReport
+```
+
+Retrieve the ID verification report for the specified document signer.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **documentId** | **string**| The document id. | |
+| **verificationDataRequest** | [**VerificationDataRequest**](../docs/VerificationDataRequest.md)| The download image request. | |
+
+### Return type
+
+[**IdReport**](../docs/IdReport.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json`
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)

package/docs/IdentityVerificationSettings.md

@@ -0,0 +1,16 @@
+# # IdentityVerificationSettings
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `type` | ```string``` |   |  |
+| `maximumRetryCount` | ```number``` |   |  |
+| `requireLiveCapture` | ```boolean``` |   |  |
+| `requireMatchingSelfie` | ```boolean``` |   |  |
+| `nameMatcher` | ```string``` |   |  |
+| `holdForPrefill` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ImageInfo.md

@@ -0,0 +1,13 @@
+# # ImageInfo
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `title`<sup>*_required_</sup> | ```string``` |   |  |
+| `allowedFileExtensions`<sup>*_required_</sup> | ```string``` |   |  |
+| `description` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/MergeAndSendForSignForm.md

@@ -0,0 +1,46 @@
+# # MergeAndSendForSignForm
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `files` | ```Array<RequestFile>``` |   |  |
+| `fileUrls` | ```Array<string>``` |   |  |
+| `templateIds` | ```Array<string>``` |   |  |
+| `useTextTags` | ```boolean``` |   |  |
+| `textTagDefinitions` | [```Array<TextTagDefinition>```](TextTagDefinition.md) |   |  |
+| `documentId` | ```string``` |   |  |
+| `title` | ```string``` |   |  |
+| `message` | ```string``` |   |  |
+| `roles` | [```Array<Role>```](Role.md) |   |  |
+| `brandId` | ```string``` |   |  |
+| `labels` | ```Array<string>``` |   |  |
+| `disableEmails` | ```boolean``` |   |  |
+| `disableSMS` | ```boolean``` |   |  [default to false] |
+| `hideDocumentId` | ```boolean``` |   |  |
+| `reminderSettings` | [```ReminderSettings```](ReminderSettings.md) |   |  |
+| `cc` | [```Array<DocumentCC>```](DocumentCC.md) |   |  |
+| `expiryDays` | ```number``` |   |  |
+| `expiryDateType` | ```string``` |   |  |
+| `expiryValue` | ```number``` |   |  [default to 60] |
+| `enablePrintAndSign` | ```boolean``` |   |  |
+| `enableReassign` | ```boolean``` |   |  |
+| `enableSigningOrder` | ```boolean``` |   |  |
+| `disableExpiryAlert` | ```boolean``` |   |  |
+| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+| `isSandbox` | ```boolean``` |   |  |
+| `roleRemovalIndices` | ```Array<number>``` |   |  |
+| `documentDownloadOption` | ```string``` |   |  |
+| `metaData` | ```{ [key: string]: string | null; }``` |   |  |
+| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) |   |  |
+| `formGroups` | [```Array<FormGroup>```](FormGroup.md) |   |  |
+| `removeFormFields` | ```Array<string>``` |   |  |
+| `enableAuditTrailLocalization` | ```boolean``` |   |  |
+| `downloadFileName` | ```string``` |   |  |
+| `scheduledSendTime` | ```number``` |   |  |
+| `allowScheduledSend` | ```boolean``` |   |  [default to false] |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationSettings.md

@@ -0,0 +1,22 @@
+# # NotificationSettings
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `viewed` | ```boolean``` |   |  [default to true] |
+| `sent` | ```boolean``` |   |  [default to false] |
+| `deliveryFailed` | ```boolean``` |   |  [default to true] |
+| `declined` | ```boolean``` |   |  [default to true] |
+| `revoked` | ```boolean``` |   |  [default to true] |
+| `reassigned` | ```boolean``` |   |  [default to true] |
+| `completed` | ```boolean``` |   |  [default to true] |
+| `signed` | ```boolean``` |   |  [default to true] |
+| `expired` | ```boolean``` |   |  [default to true] |
+| `authenticationFailed` | ```boolean``` |   |  [default to true] |
+| `reminders` | ```boolean``` |   |  [default to true] |
+| `attachSignedDocument` | ```boolean``` |   |  [default to false] |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/PageDetails.md

@@ -0,0 +1,16 @@
+# # PageDetails
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `pageSize` | ```number``` |   |  |
+| `page` | ```number``` |   |  |
+| `totalRecordsCount` | ```number``` |   |  |
+| `totalPages` | ```number``` |   |  |
+| `sortedColumn` | ```string``` |   |  |
+| `sortDirection` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/PhoneNumber.md

@@ -0,0 +1,12 @@
+# # PhoneNumber
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `countryCode` | ```string``` |   |  |
+| `number` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/PlanApi.md

@@ -0,0 +1,38 @@
+# PlanApi
+
+All URIs are relative to https://api.boldsign.com.
+
+| Method | HTTP request | Description |
+| ------------- | ------------- | ------------- |
+| [**apiCreditsCount()**](PlanApi.md#apiCreditsCount) | **GET** /v1/plan/apiCreditsCount | Gets the Api credits details. |
+
+
+## `apiCreditsCount()`
+
+```typescript
+apiCreditsCount(): BillingViewModel
+```
+
+Gets the Api credits details.
+
+
+### Parameters
+
+|This endpoint does not need any parameter. |
+
+### Return type
+
+[**BillingViewModel**](../docs/BillingViewModel.md)
+
+### Authorization
+
+[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
+[[Back to Model list]](../README.md#models)
+[[Back to README]](../README.md)

package/docs/PrefillField.md

@@ -0,0 +1,12 @@
+# # PrefillField
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `id`<sup>*_required_</sup> | ```string``` |   |  |
+| `value`<sup>*_required_</sup> | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)