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

Develop

Author: Marat-Gumerov

.github/workflows/pythonapp.yml

@@ -20,8 +20,8 @@ jobs:
         python -m pip install -r tests/requirements.txt
     - name: Test with pytest
       env:
-        appSid: ${{secrets.appSid}}
-        appKey: ${{secrets.appKey}}
+        clientId: ${{secrets.appSid}}
+        clientSecret: ${{secrets.appKey}}
         apiBaseUrl: "https://api-qa.aspose.cloud"
       run: |
         python -m pytest --verbose --color=yes -m pipeline tests

.github/workflows/pythonpublish.yml

@@ -21,8 +21,8 @@ jobs:
         pip install -r tests/requirements.txt
     - name : Run Tests
       env:
-        appSid: ${{secrets.appSidProd}}
-        appKey: ${{secrets.appKeyProd}}
+        clientId: ${{secrets.appSidProd}}
+        clientSecret: ${{secrets.appKeyProd}}
         apiBaseUrl: "https://api.aspose.cloud"
       run: |
         python -m pytest -m pipeline tests

.gitignore

@@ -69,4 +69,5 @@ target/
 .idea/
 .vscode/
 .pytest_cache/
-.venv/
+.venv/
+.run/

README.md

@@ -22,16 +22,15 @@ Aspose.Email Cloud is a REST API for creating email applications that work with
 - Email configuration discovery.
 - Disposable email address detection.
 
-## New features in version 20.10
+## What's new in version 20.12
 
-Aspose.Email Cloud 20.10.0 comes with SDK improvements:
+Aspose.Email Cloud 20.12.0 comes with SDK breaking changes:
+- AppKey renamed to ClientSecret. 
+- AppSID renamed to ClientId.
 
-- Typescript, PHP, Java SDKs now have model builders to simplify their initialization.
-- All SDK methods now have code examples with parameters initialization.
-- Some models now have initialization examples for all SDKs.
-- SDK reference documentation with examples now available at url [docs.aspose.cloud/email/reference-api](https://docs.aspose.cloud/email/reference-api/) 
+Some [SDK reference documentation](https://docs.aspose.cloud/email/reference-api/) improvements were made.
 
-See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-10-release-notes/).
+See [Release notes](https://docs.aspose.cloud/email/aspose-email-cloud-20-12-release-notes/).
 
 ## How to use the SDK?
 The complete source code is available in the [GIT repository](https://github.com/aspose-email-cloud/aspose-email-cloud-python/tree/master/sdk/AsposeEmailCloudSdk).
@@ -40,7 +39,7 @@ Use [SDK tutorials](https://docs.aspose.cloud/email/sdk-tutorials/) and [SDK ref
 
 ### 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).
+To use this SDK, you need a Client id and a Client secret; they can be looked up at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) (it requires free registration in Aspose Cloud for this).
 
 ### Installation
 
@@ -58,9 +57,10 @@ from AsposeEmailCloudSdk import api #EmailApi class is here
 from AsposeEmailCloudSdk import models #REST API models are here
 
 #...
-app_sid = 'Your App SID'
-app_key = 'Your App Key'
-email_cloud = api.EmailCloud(app_key, app_sid)
+client_secret = 'Your Client secret'
+client_id = 'Your Client id'
+
+email_cloud = api.EmailCloud(client_secret, client_id)
 ```
 
 #### Business cards recognition API

sdk/AsposeEmailCloudSdk/api/api_base.py

@@ -84,8 +84,8 @@ def call_api():
     def _request_token(self):
         config = self.api_client.configuration
         request_url = "/connect/token"
-        form_params = [('grant_type', 'client_credentials'), ('client_id', config.api_key['app_sid']),
-                       ('client_secret', config.api_key['api_key'])]
+        form_params = [('grant_type', 'client_credentials'), ('client_id', config.api_key['client_id']),
+                       ('client_secret', config.api_key['client_secret'])]
 
         header_params = {'Accept': 'application/json', 'Content-Type': 'application/x-www-form-urlencoded'}
 

sdk/AsposeEmailCloudSdk/api/email_api.py

@@ -40,7 +40,7 @@ def __init__(self, api_client):
         super(EmailApi, self).__init__(api_client)
 
     def as_file(self, request: EmailAsFileRequest) -> str:
-        """Converts Email model to specified format and returns as file.             
+        """Converts Email model to a specified format and returns as a file.             
 
         :param request: Email model and format to convert.
         :type request: EmailAsFileRequest

sdk/AsposeEmailCloudSdk/api/email_cloud.py

@@ -35,24 +35,24 @@ class EmailCloud(object):
     Aspose.Email Cloud API.
     """
 
-    def __init__(self, app_key=None, app_sid=None, base_url=None,
+    def __init__(self, client_secret=None, client_id=None, base_url=None,
                  api_version=None, debug=False):
         """
         Initializes a new instance of the EmailCloud class.
 
-        :param app_key: The app key.
-        :type app_key: str
-        :param app_sid: The app sid.
-        :type app_sid: str
+        :param client_secret: The client secret.
+        :type client_secret: str
+        :param client_id: The client id.
+        :type client_id: str
         :param base_url: The base URL.
         :type base_url: str
         :param api_version: API version.
         :type api_version: str
         :param debug: If debug mode is enabled. False by default.
         :type debug: bool
         """
-        configuration = Configuration(app_key=app_key,
-                                      app_sid=app_sid,
+        configuration = Configuration(client_secret=client_secret,
+                                      client_id=client_id,
                                       base_url=base_url,
                                       api_version=api_version,
                                       debug=debug)
@@ -106,7 +106,7 @@ def email(self) -> EmailApi:
     @property
     def disposable_email(self) -> DisposableEmailApi:
         """
-        Check email address is disposable operations
+        Checks if an email is a disposable one
         """
         return self._disposable_email
 

sdk/AsposeEmailCloudSdk/configuration.py

@@ -43,7 +43,7 @@ class Configuration(object):
 
     default_api_version = 'v4.0'
 
-    def __init__(self, app_key=None, app_sid=None, base_url=None,
+    def __init__(self, client_secret=None, client_id=None, base_url=None,
                  api_version=None, debug=False):
         """Constructor"""
         # Base url
@@ -72,8 +72,8 @@ def __init__(self, app_key=None, app_sid=None, base_url=None,
 
         # Authentication Settings
         # dict to store API key(s)
-        self.api_key = {'api_key': app_key if app_key else "",
-                        'app_sid': app_sid if app_sid else ""}
+        self.api_key = {'client_secret': client_secret if client_secret else "",
+                        'client_id': client_id if client_id else ""}
         # dict to store API prefix (e.g. Bearer)
         self.api_key_prefix = {}
 
@@ -101,7 +101,7 @@ def __init__(self, app_key=None, app_sid=None, base_url=None,
         self.__debug = debug
 
         # On-premise switch
-        self.on_premise = not (app_key or app_sid) and base_url
+        self.on_premise = not (client_secret or client_id) and base_url
 
         # SSL/TLS verification
         # Set this to false to skip verifying SSL certificate when calling API

sdk/docs/AiBcrApi.md

@@ -84,7 +84,7 @@ result = models.ContactList(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiBcrParseRequest(
@@ -196,7 +196,7 @@ result = models.StorageFileLocationList(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiBcrParseStorageRequest(

sdk/docs/AiNameApi.md

@@ -57,7 +57,7 @@ result = models.AiNameWeightedVariants(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameCompleteRequest(
@@ -135,7 +135,7 @@ result = models.AiNameWeightedVariants(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameExpandRequest(
@@ -229,7 +229,7 @@ result = models.AiNameWeightedVariants(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameParsedRequest(
@@ -319,7 +319,7 @@ result = models.AiNameFormatted(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameFormatRequest(
@@ -404,7 +404,7 @@ result = models.AiNameFormatted(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameParsedRequest(
@@ -486,7 +486,7 @@ result =
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameGenderizeRequest(
@@ -566,7 +566,7 @@ result =
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameParsedRequest(
@@ -652,7 +652,7 @@ result = models.AiNameMatchResult(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameMatchRequest(
@@ -760,7 +760,7 @@ result = models.AiNameMatchResult(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameMatchParsedRequest(
@@ -881,7 +881,7 @@ result = models.AiNameComponentList(
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameParseRequest(
@@ -964,7 +964,7 @@ result =
     <summary>Method call example:</summary>
 
 ```python
-api = EmailCloud(app_key, app_sid)
+api = EmailCloud(client_secret, client_id)
 
 // Prepare parameters:
 request = models.AiNameParseEmailAddressRequest(