Skip to content

Commit b33a642

Browse files
Marat-GumerovMarat-Gumerov
committed
SDK reference documentation added
1 parent 4d38776 commit b33a642

File tree

80 files changed

+3277
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+3277
-0
lines changed

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Aspose.Email Cloud is a REST API for creating email applications that work with
1515

1616
## How to use the SDK?
1717
The complete source code is available in the GIT repository.
18+
Use reference documentation, available [here](doc/README.md).
1819

1920
### Prerequisites
2021
To use this SDK, you need an App SID and an App Key; they can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (it requires free registration in Aspose Cloud for this).
@@ -175,6 +176,7 @@ console.log(surname.value); // 'Cane'
175176
All Aspose.Email Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
176177

177178
# Resources
179+
+ [**SDK reference documentation**](doc/README.md)
178180
+ [**Website**](https://www.aspose.cloud)
179181
+ [**Product Home**](https://products.aspose.cloud/Email/cloud)
180182
+ [**Documentation**](https://docs.aspose.cloud/display/Emailcloud/Home)

‎doc/AccountBaseRequest.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
# AccountBaseRequest
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**firstAccount** | **string** | First account storage file name for receiving emails (or universal one) | [default to undefined]
8+
**secondAccount** | **string** | Second account storage file name for sending emails (ignored if first is universal) | [optional] [default to undefined]
9+
**storageFolder** | [**StorageFolderLocation**](StorageFolderLocation.md) | Storage folder location of account files | [optional] [default to undefined]
10+
11+
12+
13+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AddAttachmentRequest.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
# AddAttachmentRequest
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**documentFolder** | [**StorageFolderLocation**](StorageFolderLocation.md) | Storage folder location of document | [optional] [default to undefined]
8+
**attachmentFolder** | [**StorageFolderLocation**](StorageFolderLocation.md) | Storage folder location of an attachment | [optional] [default to undefined]
9+
10+
11+
12+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrBase64Image.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AiBcrBase64Image
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**base64Data** | **string** | Image data in base64 | [optional] [default to undefined]
8+
9+
Parent class: [AiBcrImage](AiBcrImage.md)
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrBase64Rq.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AiBcrBase64Rq
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**images** | [**Array<AiBcrBase64Image>**](AiBcrBase64Image.md) | Images to recognize | [optional] [default to undefined]
8+
9+
Parent class: [AiBcrRq](AiBcrRq.md)
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrImage.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AiBcrImage
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**isSingle** | **boolean** | Determines that image contains single VCard or more | [default to undefined]
8+
9+
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrImageStorageFile.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AiBcrImageStorageFile
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**file** | [**StorageFileLocation**](StorageFileLocation.md) | Image location | [optional] [default to undefined]
8+
9+
Parent class: [AiBcrImage](AiBcrImage.md)
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrOcrData.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# AiBcrOcrData
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **string** | Image identifier | [optional] [default to undefined]
8+
**image** | **string** | Image with possible pre-processing in Base64 | [optional] [default to undefined]
9+
**details** | **{ [key: string]: string; }** | Additional details from OCR engine | [optional] [default to undefined]
10+
**data** | [**Array<AiBcrOcrDataPart>**](AiBcrOcrDataPart.md) | OCR results | [optional] [default to undefined]
11+
12+
13+
14+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrOcrDataPart.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
# AiBcrOcrDataPart
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**x** | **number** | X position of text block | [default to undefined]
8+
**y** | **number** | Y position of text block | [default to undefined]
9+
**width** | **number** | Width of text block | [default to undefined]
10+
**height** | **number** | Height of text block | [default to undefined]
11+
**text** | **string** | Recognized text | [optional] [default to undefined]
12+
**details** | **{ [key: string]: string; }** | Additional recognition result details | [optional] [default to undefined]
13+
14+
15+
16+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrOptions.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
# AiBcrOptions
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**languages** | **string** | Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default | [optional] [default to undefined]
8+
**countries** | **string** | Comma-separated codes of countries | [optional] [default to undefined]
9+
10+
11+
12+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

0 commit comments

Comments
 (0)