Merge pull request #11 from aspose-email-cloud/develop

Develop

Author: Marat-Gumerov

README.md

@@ -1,98 +1,74 @@
-# Aspose.Email Cloud SDK for Node.Js
+# Manage Emails in Cloud via Node.Js/Typescript REST SDK
 
 [![npm](https://img.shields.io/npm/v/@asposecloud/aspose-email-cloud)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) [![License](https://img.shields.io/github/license/aspose-email-cloud/aspose-email-cloud-node)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) [![node](https://img.shields.io/node/v/@asposecloud/aspose-email-cloud)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud)  [![types](https://img.shields.io/npm/types/@asposecloud/aspose-email-cloud)](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud) ![tests](https://github.com/aspose-email-cloud/aspose-email-cloud-node/workflows/tests/badge.svg)
 
-This repository contains Aspose.Email Cloud SDK for Node.Js source code. This SDK allows you to work with Aspose.Email Cloud REST APIs in your Node.Js applications quickly and easily, with zero initial cost.
+[Aspose.Email Cloud SDK for Node.Js/Typescript](https://products.aspose.cloud/email/nodejs) is a REST API SDK for creating email applications that work with standard email file formats such as Outlook MSG, EML, iCalendar files and VCard.
 
-[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")  
-[API Reference](https://apireference.aspose.cloud/email/)  
+This SDK allows you to work with Aspose.Email Cloud REST APIs in your Node.Js applications quickly and easily, with zero initial cost.
 
-# Key features
+[Aspose.Email Cloud home](https://products.aspose.cloud/email/family)
+[API Reference](https://apireference.aspose.cloud/email/)
+
+# Cloud Email Processing Features
 Aspose.Email Cloud is a REST API for creating email applications that work with standard email file formats. This SDK:
-- Lets developers manipulate different emails’ formats such as Outlook MSG, EML, VCard, and iCalendar files
-- Lets developers manipulate different emails' formats such as Outlook MSG, EML, VCard, and iCalendar files
+- Lets developers manipulate different emails' formats such as Outlook MSG, EML, VCard, and iCalendar files.
 - Supports AI functions:
-    - The Business card recognition
-    - The Name API for parsing and handling personal names
+    - The Business card recognition.
+    - The Name API for parsing and handling personal names.
 - Has a built-in email client. This client provides:
-    - Unified REST API for different email protocols: IMAP, POP3, SMTP, EWS, WebDav
-    - Virtual multi-account
-    - Message threads (POP3 accounts are also supported)
-- Email configuration discovery
-- Disposable email address detection
-
-## New features in version 20.7
-- New MAPI message files API with models:
-    - `MapiMessageDto` - represents the Microsoft Outlook message.
-    - `MapiCalendarDto` - represents the Microsoft Outlook calendar object.
-    - `MapiContactDto` - represents the Microsoft Outlook contact information. 
-- Improved Recurrence pattern support for CalendarDto.
-
-See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.7+Release+Notes)
+    - Unified REST API for different email protocols: IMAP, POP3, SMTP, EWS, WebDav.
+    - Virtual multi-account.
+    - Message threads (POP3 accounts are also supported).
+- Email configuration discovery.
+- Disposable email address detection.
+
+## New features in version 20.9
+
+Aspose.Email Cloud SDK 20.9.0 is based on a new v4.0 REST API.
+
+- All SDK functions are divided into groups (Email, Calendar, Contact, Client, Ai, Mapi, etc.).
+- Unified file API provided for supported file types (Save, Get, Convert, AsFile, FromFile, AsMapi/AsDto).
+- HierarchicalObject based API is removed.
+- All models are stored in one folder/namespace.
+- The request models are simplified.
+
+See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.9+Release+Notes).
+
 ## How to use the SDK?
-The complete source code is available in the GIT repository.
+The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-node/tree/master/src).
 
-Use [SDK tutorials](https://docs.aspose.cloud/display/emailcloud/SDK+Tutorials):
-- [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup) - installation, account setup, first API calls
-- [Business Cards Recognition API](https://docs.aspose.cloud/display/emailcloud/Business+Cards+Recognition+API) - convert captured business cards and name card images, into a vCard format
-- [Working with Name API](https://docs.aspose.cloud/display/emailcloud/Working+with+Name+API) - format, genderize, compare, parse, autocomplete names
-- [Email Message Files](https://docs.aspose.cloud/display/emailcloud/Email+Message+Files) - Convert EML to MSG and back, edit EML files, etc.
-- [Quick Start With iCalendar API](https://docs.aspose.cloud/display/emailcloud/Quick+Start+With+iCalendar+API) - Crate and edit iCalendar files
-- [Quick Start With VCard API](https://docs.aspose.cloud/display/emailcloud/Quick+Start+With+VCard+API) - Create and edit VCard files, business card recognition
-- [Quick Start With Email Client](https://docs.aspose.cloud/display/emailcloud/Quick+Start+With+Email+Client) - Setup builtin email client, search/fetch/send/move/delete messages
-- [Email Client Threads](https://docs.aspose.cloud/display/emailcloud/Email+Client+Threads) - Fetch/Move/Delete email message threads using builtin email client
-- [File converters](https://docs.aspose.cloud/display/emailcloud/Convert+Email%2C+Calendar+and+Contact+Files)
+Use [SDK tutorials](https://docs.aspose.cloud/display/emailcloud/SDK+Tutorials).
 
-SDK reference documentation is available in [this README](doc/README.md)
+SDK reference documentation is available in [this README](https://github.com/aspose-email-cloud/aspose-email-cloud-node/blob/master/doc/README.md).
 
 ### Prerequisites
 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).
 
 ### Installation
-You can use it directly in your project via the source code or get a [npm package](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud)
+You can use it directly in your project via the source code or get a [npm package](https://www.npmjs.com/package/@asposecloud/aspose-email-cloud).
 From the command line:
 
-	npm install @asposecloud/aspose-email-cloud --save
+    npm install @asposecloud/aspose-email-cloud --save
 
-See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup)
+See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup).
 
 ### Usage examples
-To use the API, you should create an EmailApi object:
+To use the API, you should create an EmailCloud object:
 ```typescript
 var appKey = "Your App Key";
 var appSid = "Your App SID";
-var api = new EmailApi(appSid, appKey);
+var api = new EmailCloud(appSid, appKey);
 ```
 
 #### Business cards recognition API
 
-Use `AiBcrParseModel` method to parse business card image to VCard DTO:
+Use `AiBcrApi.parse` method to parse business card image to VCard DTO:
 
 ```typescript
-var imageData = fs.readFileSync("/tmp/alex.png").toString('base64');
-var result = await api.aiBcrParseModel(new requests.AiBcrParseModelRequest(
-    new models.AiBcrBase64Rq(
-        undefined, [new models.AiBcrBase64Image(true, imageData)])));
-var contact = result.body.value[0];
+var imageData = fs.readFileSync("path/to/image/to/parse.png");
+var result = await api.ai.bcr.parse(new AiBcrParseRequest(
+    imageData, undefined, undefined, true));
+var contact = result.value[0];
 ```
 
-See more details [here](https://docs.aspose.cloud/display/emailcloud/Parse+Image+To+VCard+File) and [here](https://docs.aspose.cloud/display/emailcloud/Business+Cards+Recognition+API)
-
-# Licensing
-All Aspose.Email Cloud SDKs, helper scripts and templates are licensed under [MIT License](LICENSE).
-
-# Resources
-+ [**SDK reference documentation**](doc/README.md)
-+ [**Website**](https://www.aspose.cloud)
-+ [**Product Home**](https://products.aspose.cloud/Email/cloud)
-+ [**Documentation**](https://docs.aspose.cloud/display/Emailcloud/Home)
-+ [**API Reference**](https://apireference.aspose.cloud/email/)
-+ [**Free Support Forum**](https://forum.aspose.cloud/c/email)
-+ [**Paid Support Helpdesk**](https://helpdesk.aspose.cloud/)
-+ [**Blog**](https://blog.aspose.cloud/category/aspose-products/aspose-email-cloud/)
-+ [**Git repository: Aspose.Email Cloud SDK for .Net**](https://github.com/aspose-email-cloud/aspose-email-cloud-dotnet)
-+ [**Git repository: Aspose.Email Cloud SDK for Ruby**](https://github.com/aspose-email-cloud/aspose-email-cloud-ruby)
-+ [**Git repository: Aspose.Email Cloud SDK for Python**](https://github.com/aspose-email-cloud/aspose-email-cloud-python)
-+ [**Git repository: Aspose.Email Cloud SDK for PHP**](https://github.com/aspose-email-cloud/aspose-email-cloud-php)
-+ [**Git repository: Aspose.Email Cloud SDK for Typescript**](https://github.com/aspose-email-cloud/aspose-email-cloud-node)
-+ [**Git repository: Aspose.Email Cloud SDK for Java**](https://github.com/aspose-email-cloud/aspose-email-cloud-java)
+[Product Page](https://products.aspose.cloud/email/nodejs) | [Documentation](https://docs.aspose.cloud/display/Emailcloud/Home) | [Demo](https://products.aspose.app/email/family) | [API Reference](https://apireference.aspose.cloud/email/) | [Blog](https://blog.aspose.cloud/category/email/) | [Free support](https://forum.aspose.cloud/c/email) | [Free trial](https://dashboard.aspose.cloud/#/apps)

doc/AccountBaseRequest.md

@@ -0,0 +1,51 @@
+# AiBcrApi
+
+                    
+<a name="parse"></a>
+# **parse**
+```typescript
+public async parse(request: AiBcrParseRequest): Promise< ContactList >
+```
+
+Parse images to vCard document models             
+
+### Request Parameters
+```typescript
+new AiBcrParse(
+    file,
+    countries=countries,
+    languages=languages,
+    isSingle=isSingle)
+```
+
+Name | Type | Description | Notes
+---- | ---- | ----------- | -----
+ **file** | **byte[]**| File to parse |
+ **countries** | **string**| Comma-separated codes of countries. | [optional] [default to ]
+ **languages** | **string**| Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \&quot;it\&quot; or \&quot;ita\&quot; for Italian); it&#39;s \&quot;\&quot; by default.              | [optional] [default to ]
+ **isSingle** | **boolean**| Determines that image contains single VCard or more. | [optional] [default to true]
+
+### Return type
+
+Promise< [ContactList](ContactList.md) >
+
+[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to API README]](README.md)
+                    
+<a name="parseStorage"></a>
+# **parseStorage**
+```typescript
+public async parseStorage(request: model.AiBcrParseStorageRequest): Promise< StorageFileLocationList >
+```
+
+Parse images from storage to vCard files             
+
+### request Parameter
+
+See parameter model documentation at [AiBcrParseStorageRequest](AiBcrParseStorageRequest.md)
+
+### Return type
+
+Promise< [StorageFileLocationList](StorageFileLocationList.md) >
+
+[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to API README]](README.md)
+

doc/AddAttachmentRequest.md

@@ -0,0 +1,8 @@
+## Documentation for AiBcrApi
+
+All URIs are relative to *https://api.aspose.cloud/v4.0*
+
+Method | HTTP request | Description
+------ | ------------ | -----------
+[**parse**](AiBcrApi.md#parse) | **PUT** /email/AiBcr/parse | Parse images to vCard document models             
+[**parseStorage**](AiBcrApi.md#parseStorage) | **PUT** /email/AiBcr/parse-storage | Parse images from storage to vCard files             

doc/AiBcrApi.md

@@ -1,10 +1,9 @@
-
 # AiBcrImage
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**isSingle** | **boolean** | Determines that image contains single VCard or more. Ignored in current version. Multiple cards on image support will be added soon              | [default to undefined]
+**isSingle** | **boolean** | Determines that image contains single VCard or more.              | [default to undefined]
 
 
 

doc/AiBcrApi_list.md

@@ -1,10 +1,9 @@
-
 # AiBcrImageStorageFile
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | [**StorageFileLocation**](StorageFileLocation.md) | Image location              | [optional] [default to undefined]
+**file** | [**StorageFileLocation**](StorageFileLocation.md) | Image location              | [default to undefined]
 
  Parent class: [AiBcrImage](AiBcrImage.md)
 

doc/AiBcrImage.md

@@ -1,11 +1,10 @@
-
 # AiBcrOptions
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
-**countries** | **string** | Comma-separated codes of countries              | [optional] [default to undefined]
+**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]
+**countries** | **string** | Comma-separated codes of countries.              | [optional] [default to undefined]