SDK version 20.9.0.137 generated

Author: Aspose-Email-Team

README.md

@@ -1,36 +1,39 @@
-# Aspose.Email Cloud SDK for Python
+# Aspose.Email Cloud SDK for Python
 [![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)
 
 This repository contains Aspose.Email Cloud SDK for Python source code. This SDK allows you to work with Aspose.Email Cloud REST APIs in your Python applications quickly and easily, with zero initial cost.
 
-[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")  
+[Aspose.Email Cloud home](https://products.aspose.cloud/email/family "Aspose.Email Cloud")
 [API Reference](https://apireference.aspose.cloud/email/)
 
 # Key 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
 - 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)
+- 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.
+## New features in version 20.9
 
-See [Release notes](https://docs.aspose.cloud/display/emailcloud/Aspose.Email+Cloud+20.7+Release+Notes)
+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.
 
 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
@@ -53,7 +56,7 @@ To use this SDK, you need an App SID and an App Key; they can be looked up at [A
 
 You can use it directly in your project via the source code or get a [PYPI Package](https://pypi.org/project/aspose-email-cloud/):
 
-    pip install aspose-email-cloud
+pip install aspose-email-cloud
 
 See more details about SDK installation in this tutorial: [SDK setup](https://docs.aspose.cloud/display/emailcloud/SDK+setup)
 
@@ -76,10 +79,10 @@ Use `AiBcrParseModel` method to parse business card image to VCard DTO:
 ```python
 image_data = None
 with open('/tmp/alex.png', 'rb') as f:
-    filedata = f.read()
-    image_data = str(base64.b64encode(filedata), 'utf-8')
+filedata = f.read()
+image_data = str(base64.b64encode(filedata), 'utf-8')
 result = email_api.ai_bcr_parse_model(requests.AiBcrParseModelRequest(
-    models.AiBcrBase64Rq(images=[models.AiBcrBase64Image(True, image_data)])))
+models.AiBcrBase64Rq(images=[models.AiBcrBase64Image(True, image_data)])))
 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)

sdk/AsposeEmailCloudSdk/api/cloud_storage_group.py

@@ -44,21 +44,21 @@ def __init__(self, api_client):
     @property
     def file(self) -> FileApi:
         """
-        
+        File operations controller
         """
         return self._file
 
     @property
     def folder(self) -> FolderApi:
         """
-        
+        Folder operations controller
         """
         return self._folder
 
     @property
     def storage(self) -> StorageApi:
         """
-        
+        Storage operations controller
         """
         return self._storage
 

sdk/AsposeEmailCloudSdk/api/file_api.py

@@ -40,7 +40,7 @@ def __init__(self, api_client):
         super(FileApi, self).__init__(api_client)
 
     def copy_file(self, request: CopyFileRequest):
-        """copy_file
+        """Copy file
 
 
         :param request: CopyFileRequest object with parameters
@@ -107,7 +107,7 @@ def copy_file(self, request: CopyFileRequest):
         return self._make_request(http_request_object, 'PUT', None)
 
     def delete_file(self, request: DeleteFileRequest):
-        """delete_file
+        """Delete file
 
 
         :param request: DeleteFileRequest object with parameters
@@ -159,7 +159,7 @@ def delete_file(self, request: DeleteFileRequest):
         return self._make_request(http_request_object, 'DELETE', None)
 
     def download_file(self, request: DownloadFileRequest) -> str:
-        """download_file
+        """Download file
 
 
         :param request: DownloadFileRequest object with parameters
@@ -211,7 +211,7 @@ def download_file(self, request: DownloadFileRequest) -> str:
         return self._make_request(http_request_object, 'GET', 'file')
 
     def move_file(self, request: MoveFileRequest):
-        """move_file
+        """Move file
 
 
         :param request: MoveFileRequest object with parameters
@@ -278,7 +278,7 @@ def move_file(self, request: MoveFileRequest):
         return self._make_request(http_request_object, 'PUT', None)
 
     def upload_file(self, request: UploadFileRequest) -> FilesUploadResult:
-        """upload_file
+        """Upload file
 
 
         :param request: UploadFileRequest object with parameters

sdk/AsposeEmailCloudSdk/api/folder_api.py

@@ -40,7 +40,7 @@ def __init__(self, api_client):
         super(FolderApi, self).__init__(api_client)
 
     def copy_folder(self, request: CopyFolderRequest):
-        """copy_folder
+        """Copy folder
 
 
         :param request: CopyFolderRequest object with parameters
@@ -101,7 +101,7 @@ def copy_folder(self, request: CopyFolderRequest):
         return self._make_request(http_request_object, 'PUT', None)
 
     def create_folder(self, request: CreateFolderRequest):
-        """create_folder
+        """Create the folder
 
 
         :param request: CreateFolderRequest object with parameters
@@ -147,7 +147,7 @@ def create_folder(self, request: CreateFolderRequest):
         return self._make_request(http_request_object, 'PUT', None)
 
     def delete_folder(self, request: DeleteFolderRequest):
-        """delete_folder
+        """Delete folder
 
 
         :param request: DeleteFolderRequest object with parameters
@@ -199,7 +199,7 @@ def delete_folder(self, request: DeleteFolderRequest):
         return self._make_request(http_request_object, 'DELETE', None)
 
     def get_files_list(self, request: GetFilesListRequest) -> FilesList:
-        """get_files_list
+        """Get all files and folders within a folder
 
 
         :param request: GetFilesListRequest object with parameters
@@ -245,7 +245,7 @@ def get_files_list(self, request: GetFilesListRequest) -> FilesList:
         return self._make_request(http_request_object, 'GET', 'FilesList')
 
     def move_folder(self, request: MoveFolderRequest):
-        """move_folder
+        """Move folder
 
 
         :param request: MoveFolderRequest object with parameters

sdk/AsposeEmailCloudSdk/api/storage_api.py

@@ -40,7 +40,7 @@ def __init__(self, api_client):
         super(StorageApi, self).__init__(api_client)
 
     def get_disc_usage(self, request: GetDiscUsageRequest) -> DiscUsage:
-        """get_disc_usage
+        """Get disc usage
 
 
         :param request: GetDiscUsageRequest object with parameters
@@ -81,7 +81,7 @@ def get_disc_usage(self, request: GetDiscUsageRequest) -> DiscUsage:
         return self._make_request(http_request_object, 'GET', 'DiscUsage')
 
     def get_file_versions(self, request: GetFileVersionsRequest) -> FileVersions:
-        """get_file_versions
+        """Get file versions
 
 
         :param request: GetFileVersionsRequest object with parameters
@@ -127,7 +127,7 @@ def get_file_versions(self, request: GetFileVersionsRequest) -> FileVersions:
         return self._make_request(http_request_object, 'GET', 'FileVersions')
 
     def object_exists(self, request: ObjectExistsRequest) -> ObjectExist:
-        """object_exists
+        """Check if file or folder exists
 
 
         :param request: ObjectExistsRequest object with parameters
@@ -179,7 +179,7 @@ def object_exists(self, request: ObjectExistsRequest) -> ObjectExist:
         return self._make_request(http_request_object, 'GET', 'ObjectExist')
 
     def exists(self, request: StorageExistsRequest) -> StorageExist:
-        """exists
+        """Check if storage exists
 
 
         :param request: StorageExistsRequest object with parameters

sdk/AsposeEmailCloudSdk/models/copy_file_request.py

@@ -32,15 +32,15 @@ class CopyFileRequest(object):
     Request model for copy_file operation.
     Initializes a new instance.
 
-    :param src_path: 
+    :param src_path: Source file path e.g. '/folder/file.ext'
     :type src_path: str
-    :param dest_path: 
+    :param dest_path: Destination file path
     :type dest_path: str
-    :param src_storage_name: 
+    :param src_storage_name: Source storage name
     :type src_storage_name: str
-    :param dest_storage_name: 
+    :param dest_storage_name: Destination storage name
     :type dest_storage_name: str
-    :param version_id: 
+    :param version_id: File version ID to copy
     :type version_id: str
     """
 
@@ -49,15 +49,15 @@ def __init__(self, src_path: str, dest_path: str, src_storage_name: str = None,
         Request model for copy_file operation.
         Initializes a new instance.
 
-        :param src_path: 
+        :param src_path: Source file path e.g. '/folder/file.ext'
         :type src_path: str
-        :param dest_path: 
+        :param dest_path: Destination file path
         :type dest_path: str
-        :param src_storage_name: 
+        :param src_storage_name: Source storage name
         :type src_storage_name: str
-        :param dest_storage_name: 
+        :param dest_storage_name: Destination storage name
         :type dest_storage_name: str
-        :param version_id: 
+        :param version_id: File version ID to copy
         :type version_id: str
         """
 

sdk/AsposeEmailCloudSdk/models/copy_folder_request.py

@@ -32,13 +32,13 @@ class CopyFolderRequest(object):
     Request model for copy_folder operation.
     Initializes a new instance.
 
-    :param src_path: 
+    :param src_path: Source folder path e.g. '/src'
     :type src_path: str
-    :param dest_path: 
+    :param dest_path: Destination folder path e.g. '/dst'
     :type dest_path: str
-    :param src_storage_name: 
+    :param src_storage_name: Source storage name
     :type src_storage_name: str
-    :param dest_storage_name: 
+    :param dest_storage_name: Destination storage name
     :type dest_storage_name: str
     """
 
@@ -47,13 +47,13 @@ def __init__(self, src_path: str, dest_path: str, src_storage_name: str = None,
         Request model for copy_folder operation.
         Initializes a new instance.
 
-        :param src_path: 
+        :param src_path: Source folder path e.g. '/src'
         :type src_path: str
-        :param dest_path: 
+        :param dest_path: Destination folder path e.g. '/dst'
         :type dest_path: str
-        :param src_storage_name: 
+        :param src_storage_name: Source storage name
         :type src_storage_name: str
-        :param dest_storage_name: 
+        :param dest_storage_name: Destination storage name
         :type dest_storage_name: str
         """
 

sdk/AsposeEmailCloudSdk/models/create_folder_request.py

@@ -32,9 +32,9 @@ class CreateFolderRequest(object):
     Request model for create_folder operation.
     Initializes a new instance.
 
-    :param path: 
+    :param path: Folder path to create e.g. 'folder_1/folder_2/'
     :type path: str
-    :param storage_name: 
+    :param storage_name: Storage name
     :type storage_name: str
     """
 
@@ -43,9 +43,9 @@ def __init__(self, path: str, storage_name: str = None):
         Request model for create_folder operation.
         Initializes a new instance.
 
-        :param path: 
+        :param path: Folder path to create e.g. 'folder_1/folder_2/'
         :type path: str
-        :param storage_name: 
+        :param storage_name: Storage name
         :type storage_name: str
         """
 

sdk/AsposeEmailCloudSdk/models/delete_file_request.py

@@ -32,11 +32,11 @@ class DeleteFileRequest(object):
     Request model for delete_file operation.
     Initializes a new instance.
 
-    :param path: 
+    :param path: File path e.g. '/folder/file.ext'
     :type path: str
-    :param storage_name: 
+    :param storage_name: Storage name
     :type storage_name: str
-    :param version_id: 
+    :param version_id: File version ID to delete
     :type version_id: str
     """
 
@@ -45,11 +45,11 @@ def __init__(self, path: str, storage_name: str = None, version_id: str = None):
         Request model for delete_file operation.
         Initializes a new instance.
 
-        :param path: 
+        :param path: File path e.g. '/folder/file.ext'
         :type path: str
-        :param storage_name: 
+        :param storage_name: Storage name
         :type storage_name: str
-        :param version_id: 
+        :param version_id: File version ID to delete
         :type version_id: str
         """
 

sdk/AsposeEmailCloudSdk/models/delete_folder_request.py

@@ -32,11 +32,11 @@ class DeleteFolderRequest(object):
     Request model for delete_folder operation.
     Initializes a new instance.
 
-    :param path: 
+    :param path: Folder path e.g. '/folder'
     :type path: str
-    :param storage_name: 
+    :param storage_name: Storage name
     :type storage_name: str
-    :param recursive: 
+    :param recursive: Enable to delete folders, subfolders and files
     :type recursive: bool
     """
 
@@ -45,11 +45,11 @@ def __init__(self, path: str, storage_name: str = None, recursive: bool = None):
         Request model for delete_folder operation.
         Initializes a new instance.
 
-        :param path: 
+        :param path: Folder path e.g. '/folder'
         :type path: str
-        :param storage_name: 
+        :param storage_name: Storage name
         :type storage_name: str
-        :param recursive: 
+        :param recursive: Enable to delete folders, subfolders and files
         :type recursive: bool
         """