boldsign 1.0.1 → 1.0.2

package/docs/PrefillFieldRequest.md

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

package/docs/ProblemDetails.md

@@ -0,0 +1,15 @@
+# # ProblemDetails
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `type` | ```string``` |   |  |
+| `title` | ```string``` |   |  |
+| `status` | ```number``` |   |  |
+| `detail` | ```string``` |   |  |
+| `instance` | ```string``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/RecipientNotificationSettings.md

@@ -0,0 +1,22 @@
+# # RecipientNotificationSettings
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `signatureRequest` | ```boolean``` |   |  [default to true] |
+| `declined` | ```boolean``` |   |  [default to true] |
+| `revoked` | ```boolean``` |   |  [default to true] |
+| `signed` | ```boolean``` |   |  [default to true] |
+| `completed` | ```boolean``` |   |  [default to true] |
+| `expired` | ```boolean``` |   |  [default to true] |
+| `reassigned` | ```boolean``` |   |  [default to true] |
+| `deleted` | ```boolean``` |   |  [default to true] |
+| `reminders` | ```boolean``` |   |  [default to true] |
+| `editRecipient` | ```boolean``` |   |  [default to true] |
+| `editDocument` | ```boolean``` |   |  [default to true] |
+| `viewed` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/Rectangle.md

@@ -0,0 +1,14 @@
+# # Rectangle
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `x` | ```number``` |   |  [default to 0] |
+| `y` | ```number``` |   |  [default to 0] |
+| `width` | ```number``` |   |  [default to 1] |
+| `height` | ```number``` |   |  [default to 1] |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ReminderMessage.md

@@ -0,0 +1,13 @@
+# # ReminderMessage
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `message` | ```string``` |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+| `reminderPhoneNumbers` | [```Array<PhoneNumber>```](PhoneNumber.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/ReminderSettings.md

@@ -0,0 +1,13 @@
+# # ReminderSettings
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `enableAutoReminder` | ```boolean``` |   |  [default to false] |
+| `reminderDays` | ```number``` |   |  [default to 3] |
+| `reminderCount` | ```number``` |   |  [default to 3] |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/RemoveAuthentication.md

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

package/docs/RevokeDocument.md

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

package/docs/Role.md

@@ -0,0 +1,33 @@
+# # Role
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `roleIndex` | ```number``` |   |  |
+| `signerName` | ```string``` |   |  |
+| `signerOrder` | ```number``` |   |  |
+| `signerEmail` | ```string``` |   |  |
+| `hostEmail` | ```string``` |   |  |
+| `privateMessage` | ```string``` |   |  |
+| `authenticationCode` | ```string``` |   |  |
+| `enableEmailOTP` | ```boolean``` |   |  |
+| `authenticationType` | ```string``` |   |  |
+| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) |   |  |
+| `deliveryMode` | ```string``` |   |  |
+| `signerType` | ```string``` |   |  |
+| `signerRole` | ```string``` |   |  |
+| `allowFieldConfiguration` | ```boolean``` |   |  |
+| `formFields` | [```Array<FormField>```](FormField.md) |   |  |
+| `existingFormFields` | [```Array<ExistingFormField>```](ExistingFormField.md) |   |  |
+| `identityVerificationSettings` | [```IdentityVerificationSettings```](IdentityVerificationSettings.md) |   |  |
+| `language` | ```number``` |  &lt;p&gt;Description:&lt;/p&gt;&lt;ul&gt;&lt;li&gt;&lt;i&gt;0&lt;/i&gt; - None&lt;/li&gt;&lt;li&gt;&lt;i&gt;1&lt;/i&gt; - English&lt;/li&gt;&lt;li&gt;&lt;i&gt;2&lt;/i&gt; - Spanish&lt;/li&gt;&lt;li&gt;&lt;i&gt;3&lt;/i&gt; - German&lt;/li&gt;&lt;li&gt;&lt;i&gt;4&lt;/i&gt; - French&lt;/li&gt;&lt;li&gt;&lt;i&gt;5&lt;/i&gt; - Romanian&lt;/li&gt;&lt;li&gt;&lt;i&gt;6&lt;/i&gt; - Norwegian&lt;/li&gt;&lt;li&gt;&lt;i&gt;7&lt;/i&gt; - Bulgarian&lt;/li&gt;&lt;li&gt;&lt;i&gt;8&lt;/i&gt; - Italian&lt;/li&gt;&lt;li&gt;&lt;i&gt;9&lt;/i&gt; - Danish&lt;/li&gt;&lt;li&gt;&lt;i&gt;10&lt;/i&gt; - Polish&lt;/li&gt;&lt;li&gt;&lt;i&gt;11&lt;/i&gt; - Portuguese&lt;/li&gt;&lt;li&gt;&lt;i&gt;12&lt;/i&gt; - Czech&lt;/li&gt;&lt;li&gt;&lt;i&gt;13&lt;/i&gt; - Dutch&lt;/li&gt;&lt;li&gt;&lt;i&gt;14&lt;/i&gt; - Swedish&lt;/li&gt;&lt;li&gt;&lt;i&gt;15&lt;/i&gt; - Russian&lt;/li&gt;&lt;/ul&gt; |  |
+| `locale` | ```string``` |   |  |
+| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) |   |  |
+| `authenticationRetryCount` | ```number``` |   |  |
+| `enableQes` | ```boolean``` |   |  |
+| `authenticationSettings` | [```AuthenticationSettings```](AuthenticationSettings.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/Roles.md

@@ -0,0 +1,33 @@
+# # Roles
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `name` | ```string``` |   |  |
+| `index` | ```number``` |   |  |
+| `defaultSignerName` | ```string``` |   |  |
+| `defaultSignerEmail` | ```string``` |   |  |
+| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) |   |  |
+| `signerOrder` | ```number``` |   |  |
+| `signerType` | ```string``` |   |  |
+| `hostEmail` | ```string``` |   |  |
+| `hostName` | ```string``` |   |  |
+| `language` | ```number``` |  <p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul> |  |
+| `locale` | ```string``` |   |  |
+| `allowRoleEdit` | ```boolean``` |   |  |
+| `allowRoleDelete` | ```boolean``` |   |  |
+| `enableAccessCode` | ```boolean``` |   |  |
+| `enableEmailOTP` | ```boolean``` |   |  |
+| `imposeAuthentication` | ```string``` |   |  |
+| `deliveryMode` | ```string``` |   |  |
+| `allowFieldConfiguration` | ```boolean``` |   |  |
+| `formFields` | [```Array<TemplateFormFields>```](TemplateFormFields.md) |   |  |
+| `enableEditRecipients` | ```boolean``` |   |  |
+| `enableDeleteRecipients` | ```boolean``` |   |  |
+| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) |   |  |
+| `enableQes` | ```boolean``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/SendForSign.md

@@ -0,0 +1,45 @@
+# # SendForSign
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `files` | ```Array<RequestFile>``` |   |  |
+| `title` | ```string``` |   |  |
+| `message` | ```string``` |   |  |
+| `signers` | [```Array<DocumentSigner>```](DocumentSigner.md) |   |  |
+| `cc` | [```Array<DocumentCC>```](DocumentCC.md) |   |  |
+| `enableSigningOrder` | ```boolean``` |   |  [default to false] |
+| `expiryDays` | ```number``` |   |  |
+| `expiryDateType` | ```string``` |   |  |
+| `expiryValue` | ```number``` |   |  [default to 60] |
+| `reminderSettings` | [```ReminderSettings```](ReminderSettings.md) |   |  |
+| `enableEmbeddedSigning` | ```boolean``` |   |  [default to false] |
+| `disableEmails` | ```boolean``` |   |  [default to false] |
+| `disableSMS` | ```boolean``` |   |  [default to false] |
+| `brandId` | ```string``` |   |  |
+| `hideDocumentId` | ```boolean``` |   |  [default to false] |
+| `labels` | ```Array<string>``` |   |  |
+| `fileUrls` | ```Array<string>``` |   |  |
+| `sendLinkValidTill` | ```Date``` |   |  |
+| `useTextTags` | ```boolean``` |   |  [default to false] |
+| `textTagDefinitions` | [```Array<TextTagDefinition>```](TextTagDefinition.md) |   |  |
+| `enablePrintAndSign` | ```boolean``` |   |  [default to false] |
+| `enableReassign` | ```boolean``` |   |  [default to true] |
+| `disableExpiryAlert` | ```boolean``` |   |  |
+| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) |   |  |
+| `onBehalfOf` | ```string``` |   |  |
+| `autoDetectFields` | ```boolean``` |   |  [default to false] |
+| `documentDownloadOption` | ```string``` |   |  |
+| `isSandbox` | ```boolean``` |   |  |
+| `metaData` | ```{ [key: string]: string | null; }``` |   |  |
+| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) |   |  |
+| `formGroups` | [```Array<FormGroup>```](FormGroup.md) |   |  |
+| `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/SendForSignFromTemplateForm.md

@@ -0,0 +1,43 @@
+# # SendForSignFromTemplateForm
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `files` | ```Array<RequestFile>``` |   |  |
+| `fileUrls` | ```Array<string>``` |   |  |
+| `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/SenderIdentitiesApi.md

@@ -0,0 +1,209 @@
+# SenderIdentitiesApi
+
+All URIs are relative to https://api.boldsign.com.
+
+| Method | HTTP request | Description |
+| ------------- | ------------- | ------------- |
+| [**createSenderIdentities()**](SenderIdentitiesApi.md#createSenderIdentities) | **POST** /v1/senderIdentities/create | Creates sender identity. |
+| [**deleteSenderIdentities()**](SenderIdentitiesApi.md#deleteSenderIdentities) | **DELETE** /v1/senderIdentities/delete | Deletes sender identity. |
+| [**listSenderIdentities()**](SenderIdentitiesApi.md#listSenderIdentities) | **GET** /v1/senderIdentities/list | Lists sender identity. |
+| [**reRequestSenderIdentities()**](SenderIdentitiesApi.md#reRequestSenderIdentities) | **POST** /v1/senderIdentities/rerequest | Rerequests denied sender identity. |
+| [**resendInvitationSenderIdentities()**](SenderIdentitiesApi.md#resendInvitationSenderIdentities) | **POST** /v1/senderIdentities/resendInvitation | Resends sender identity invitation. |
+| [**updateSenderIdentities()**](SenderIdentitiesApi.md#updateSenderIdentities) | **POST** /v1/senderIdentities/update | Updates sender identity. |
+
+
+## `createSenderIdentities()`
+
+```typescript
+createSenderIdentities(createSenderIdentityRequest: CreateSenderIdentityRequest): SenderIdentityCreated
+```
+
+Creates sender identity.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **createSenderIdentityRequest** | [**CreateSenderIdentityRequest**](../docs/CreateSenderIdentityRequest.md)| The create sender identity request. | |
+
+### Return type
+
+[**SenderIdentityCreated**](../docs/SenderIdentityCreated.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)
+
+## `deleteSenderIdentities()`
+
+```typescript
+deleteSenderIdentities(email: string)
+```
+
+Deletes sender identity.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **email** | **string**| The email address. | |
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+## `listSenderIdentities()`
+
+```typescript
+listSenderIdentities(page: number, pageSize: number, search: string, brandIds: Array<string>): SenderIdentityList
+```
+
+Lists sender identity.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **page** | **number**| Page index specified in get sender identity request. | [default to 1] |
+| **pageSize** | **number**| Page size specified in get sender identity list request. | [optional] [default to 10] |
+| **search** | **string**| Users can be listed by the search key present in the sender identity like sender identity name and email address | [optional] |
+| **brandIds** | [**Array<string>**](../docs/string.md)| A list of brand IDs to filter associated with the sender identity. | [optional] |
+
+### Return type
+
+[**SenderIdentityList**](../docs/SenderIdentityList.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)
+
+## `reRequestSenderIdentities()`
+
+```typescript
+reRequestSenderIdentities(email: string)
+```
+
+Rerequests denied sender identity.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **email** | **string**| The email address. | |
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+## `resendInvitationSenderIdentities()`
+
+```typescript
+resendInvitationSenderIdentities(email: string)
+```
+
+Resends sender identity invitation.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **email** | **string**| The email address. | |
+
+### Return type
+
+void (empty response body)
+
+### 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)
+
+## `updateSenderIdentities()`
+
+```typescript
+updateSenderIdentities(email: string, editSenderIdentityRequest: EditSenderIdentityRequest)
+```
+
+Updates sender identity.
+
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **email** | **string**| The email address. | |
+| **editSenderIdentityRequest** | [**EditSenderIdentityRequest**](../docs/EditSenderIdentityRequest.md)| The create sender identity request. | |
+
+### Return type
+
+void (empty response body)
+
+### 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/SenderIdentityCreated.md

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

package/docs/SenderIdentityList.md

@@ -0,0 +1,12 @@
+# # SenderIdentityList
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `result` | [```Array<SenderIdentityViewModel>```](SenderIdentityViewModel.md) |   |  |
+| `pageDetails` | [```PageDetails```](PageDetails.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/SenderIdentityViewModel.md

@@ -0,0 +1,19 @@
+# # SenderIdentityViewModel
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `name` | ```string``` |   |  |
+| `email` | ```string``` |   |  |
+| `status` | ```string``` |   |  |
+| `createdBy` | ```string``` |   |  |
+| `approvedDate` | ```string``` |   |  |
+| `notificationSettings` | [```NotificationSettings```](NotificationSettings.md) |   |  |
+| `brandId` | ```string``` |   |  |
+| `redirectUrl` | ```string``` |   |  |
+| `metaData` | ```{ [key: string]: string | null; }``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/SignerAuthenticationSettings.md

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

package/docs/Size.md

@@ -0,0 +1,12 @@
+# # Size
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `width` | ```number``` |   |  [default to 0] |
+| `height` | ```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/TeamCreated.md

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

package/docs/TeamDocumentRecords.md

@@ -0,0 +1,12 @@
+# # TeamDocumentRecords
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `pageDetails` | [```PageDetails```](PageDetails.md) |   |  |
+| `result` | [```Array<Document>```](Document.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TeamListResponse.md

@@ -0,0 +1,12 @@
+# # TeamListResponse
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `pageDetails` | [```TeamPageDetails```](TeamPageDetails.md) |   |  |
+| `results` | [```Array<Teams>```](Teams.md) |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TeamPageDetails.md

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

package/docs/TeamResponse.md

@@ -0,0 +1,15 @@
+# # TeamResponse
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `teamId` | ```string``` |   |  |
+| `teamName` | ```string``` |   |  |
+| `users` | [```Array<TeamUsers>```](TeamUsers.md) |   |  |
+| `createdDate` | ```number``` |   |  |
+| `modifiedDate` | ```number``` |   |  |
+
+[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)

package/docs/TeamUpdateRequest.md

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