Skip to content

Commit 2c4c10f

Browse files
committed
README updated
1 parent 13009e7 commit 2c4c10f

File tree

4 files changed

+13
-15
lines changed

4 files changed

+13
-15
lines changed

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
This SDK allows you to work with Aspose.Email Cloud REST APIs in your Node.Js applications quickly and easily, with zero initial cost.
88

99
[Aspose.Email Cloud home](https://products.aspose.cloud/email/family)
10-
[API Reference](https://apireference.aspose.cloud/email/)
10+
11+
[Swagger UI](https://apireference.aspose.cloud/email/)
1112

1213
# Cloud Email Processing Features
1314
Aspose.Email Cloud is a REST API for creating email applications that work with standard email file formats. This SDK:
@@ -22,24 +23,18 @@ Aspose.Email Cloud is a REST API for creating email applications that work with
2223
- Email configuration discovery.
2324
- Disposable email address detection.
2425

25-
## New features in version 20.9
26+
## What's new in version 20.12
2627

27-
Aspose.Email Cloud SDK 20.9.0 is based on a new v4.0 REST API.
28+
Aspose.Email Cloud 20.12.0 comes with SDK breaking change:
2829

29-
- All SDK functions are divided into groups (Email, Calendar, Contact, Client, Ai, Mapi, etc.).
30-
- Unified file API provided for supported file types (Save, Get, Convert, AsFile, FromFile, AsMapi/AsDto).
31-
- HierarchicalObject based API is removed.
32-
- All models are stored in one folder/namespace.
33-
- The request models are simplified.
30+
AppKey renamed to ClientSecret, AppSID renamed to ClientId.
3431

35-
See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.9+Release+Notes).
32+
See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-12-release-notes/).
3633

3734
## How to use the SDK?
3835
The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-node/tree/master/src).
3936

40-
Use [SDK tutorials](https://docs.aspose.cloud/display/emailcloud/SDK+Tutorials).
41-
42-
SDK reference documentation is available in [this README](https://github.com/aspose-email-cloud/aspose-email-cloud-node/blob/master/doc/README.md).
37+
Use [SDK tutorials](https://docs.aspose.cloud/email/sdk-tutorials/) and [SDK reference documentation](https://docs.aspose.cloud/email/reference-api/).
4338

4439
### Prerequisites
4540
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).
@@ -50,7 +45,7 @@ From the command line:
5045

5146
npm install @asposecloud/aspose-email-cloud --save
5247

53-
See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup).
48+
See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/email/sdk-setup/).
5449

5550
### Usage examples
5651
To use the API, you should create an EmailCloud object:
@@ -71,4 +66,4 @@ var result = await api.ai.bcr.parse(new AiBcrParseRequest(
7166
var contact = result.value[0];
7267
```
7368

74-
[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)
69+
[Product Page](https://products.aspose.cloud/email/nodejs) | [Documentation](https://docs.aspose.cloud/email/) | [Demo](https://products.aspose.app/email/family) | [Swagger UI](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) | [SDK reference documentation](https://docs.aspose.cloud/email/reference-api)

doc/EmailConfigApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ See parameter model documentation at [EmailConfigDiscoverRequest](EmailConfigDis
2525

2626
```typescript
2727
let request = Models.EmailConfigDiscoverRequest()
28+
.address('address@gmail.com')
2829
.build();
2930
```
3031

@@ -102,6 +103,7 @@ const api = new EmailCloud(app_key, app_sid);
102103

103104
// Prepare parameters:
104105
let request = Models.EmailConfigDiscoverRequest()
106+
.address('address@gmail.com')
105107
.build();
106108

107109
// Call method:

doc/EmailConfigDiscoverRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ Name | Type | Description | Notes
1212
## Example
1313
```typescript
1414
let request = Models.EmailConfigDiscoverRequest()
15+
.address('address@gmail.com')
1516
.build();
1617
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@asposecloud/aspose-email-cloud",
3-
"version": "20.9.0",
3+
"version": "20.12.0",
44
"description": "Aspose.Email Cloud Node.js SDK",
55
"homepage": "https://products.aspose.cloud/email",
66
"author": {

0 commit comments

Comments
 (0)