Skip to content

Commit f6c7c11

Browse files
committed
Some documentation improvements
1 parent 92dbfe6 commit f6c7c11

File tree

4 files changed

+16
-17
lines changed

4 files changed

+16
-17
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Manage Emails in Cloud via Python REST SDK
2-
[![PYPI](https://img.shields.io/pypi/v/aspose-email-cloud)](https://pypi.org/project/aspose-email-cloud/) [![License](https://img.shields.io/github/license/aspose-email-cloud/aspose-email-cloud-python)](https://pypi.org/project/aspose-email-cloud/) ![tests](https://github.com/aspose-email-cloud/aspose-email-cloud-python/workflows/tests/badge.svg) [![Uptime Robot status](https://img.shields.io/uptimerobot/status/m785988686-40b0339ddd75355f594f59e3)](https://apireference.aspose.cloud/email/)
2+
[![PYPI](https://img.shields.io/pypi/v/aspose-email-cloud)](https://pypi.org/project/aspose-email-cloud/) [![License](https://img.shields.io/github/license/aspose-email-cloud/aspose-email-cloud-python)](https://pypi.org/project/aspose-email-cloud/) ![tests](https://github.com/aspose-email-cloud/aspose-email-cloud-python/workflows/tests/badge.svg)
33

44
[Aspose.Email Cloud SDK for Python](https://products.aspose.cloud/email/python) 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.
55

66
This SDK allows you to work with Aspose.Email Cloud REST APIs in your Python applications quickly and easily, with zero initial cost.
77

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

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

24-
## New features in version 20.10
25+
## What's new in version 20.12
2526

26-
Aspose.Email Cloud 20.10.0 comes with SDK improvements:
27+
Aspose.Email Cloud 20.12.0 comes with SDK breaking change:
2728

28-
- Typescript, PHP, Java SDKs now have model builders to simplify their initialization.
29-
- All SDK methods now have code examples with parameters initialization.
30-
- Some models now have initialization examples for all SDKs.
31-
- SDK reference documentation with examples now available at url [docs.aspose.cloud/email/reference-api](https://docs.aspose.cloud/email/reference-api/)
29+
AppKey renamed to ClientSecret, AppSID renamed to ClientId.
3230

33-
See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-10-release-notes/).
31+
See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-12-release-notes/).
3432

3533
## How to use the SDK?
3634
The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-python/tree/master/sdk/AsposeEmailCloudSdk).
3735

38-
Use [SDK tutorials](https://docs.aspose.cloud/email/sdk-tutorials/).
39-
40-
SDK reference documentation is available in [this README](https://github.com/aspose-email-cloud/aspose-email-cloud-python/blob/master/sdk/docs/README.md).
36+
Use [SDK tutorials](https://docs.aspose.cloud/email/sdk-tutorials/) and [SDK reference documentation](https://docs.aspose.cloud/email/reference-api/).
4137

4238
### Prerequisites
4339

@@ -73,4 +69,4 @@ contact = result.value[0]
7369
assert 'Parsed Display Name' in contact.display_name
7470
```
7571

76-
[Product Page](https://products.aspose.cloud/email/python) | [Documentation](https://docs.aspose.cloud/email/) | [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)
72+
[Product Page](https://products.aspose.cloud/email/python) | [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)

sdk/docs/EmailConfigApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ See parameter model documentation at [EmailConfigDiscoverRequest](EmailConfigDis
2424
<summary>Parameter initialization example:</summary>
2525

2626
```python
27-
request = models.EmailConfigDiscoverRequest()
27+
request = models.EmailConfigDiscoverRequest(
28+
address='address@gmail.com')
2829
```
2930

3031
</details>
@@ -91,7 +92,8 @@ result = models.EmailAccountConfigList(
9192
api = EmailCloud(app_key, app_sid)
9293

9394
// Prepare parameters:
94-
request = models.EmailConfigDiscoverRequest()
95+
request = models.EmailConfigDiscoverRequest(
96+
address='address@gmail.com')
9597

9698
// Call method:
9799
result = api.email_config.discover(request)

sdk/docs/EmailConfigDiscoverRequest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@ Name | Type | Description | Notes
1111

1212
## Example
1313
```python
14-
request = models.EmailConfigDiscoverRequest()
14+
request = models.EmailConfigDiscoverRequest(
15+
address='address@gmail.com')
1516
```

sdk/setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from setuptools import setup, find_packages # noqa: H301
99

1010
NAME = "aspose-email-cloud"
11-
VERSION = "20.10.0.123"
11+
VERSION = "20.12.0.0"
1212
# To install the library, run the following
1313
#
1414
# python setup.py install

0 commit comments

Comments
 (0)