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

Develop

Author: Marat-Gumerov

.github/workflows/npmpublish.yml

@@ -19,8 +19,8 @@ jobs:
         npm run compile
     - run: npm run test-pipeline
       env:
-        appSid: ${{secrets.appSidProd}}
-        appKey: ${{secrets.appKeyProd}}
+        clientId: ${{secrets.appSidProd}}
+        clientSecret: ${{secrets.appKeyProd}}
         apiBaseUrl: "https://api.aspose.cloud"
     - run: npm publish
       env:

.github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
           npm run compile
       - name: Test
         env:
-          appSid: ${{secrets.appSid}}
-          appKey: ${{secrets.appKey}}
+          clientId: ${{secrets.appSid}}
+          clientSecret: ${{secrets.appKey}}
           apiBaseUrl: "https://api-qa.aspose.cloud"
         run: npm run test-pipeline

.gitignore

@@ -3,4 +3,5 @@ package-lock.json
 dist
 .vscode
 .idea
-.nyc_output
+.nyc_output
+.run/

README.md

@@ -23,16 +23,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-node/tree/master/src).
@@ -53,9 +52,10 @@ See more details about SDK installation in this tutorial: [SDK setup](https://do
 ### Usage examples
 To use the API, you should create an EmailCloud object:
 ```typescript
-var appKey = "Your App Key";
-var appSid = "Your App SID";
-var api = new EmailCloud(appSid, appKey);
+let clientSecret = "Your Client secret";
+let clientId = "Your Client id";
+
+let api = new EmailCloud(clientSecret, clientId);
 ```
 
 #### Business cards recognition API

doc/AiBcrApi.md

@@ -96,7 +96,7 @@ let result = Models.contactList()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiBcrParseRequest()
@@ -227,7 +227,7 @@ let result = Models.storageFileLocationList()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.aiBcrParseStorageRequest()

doc/AiNameApi.md

@@ -63,7 +63,7 @@ let result = Models.aiNameWeightedVariants()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameCompleteRequest()
@@ -152,7 +152,7 @@ let result = Models.aiNameWeightedVariants()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameExpandRequest()
@@ -261,7 +261,7 @@ let result = Models.aiNameWeightedVariants()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.aiNameParsedRequest()
@@ -364,7 +364,7 @@ let result = Models.aiNameFormatted()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameFormatRequest()
@@ -460,7 +460,7 @@ let result = Models.aiNameFormatted()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.aiNameParsedRequest()
@@ -552,7 +552,7 @@ let result = ;
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameGenderizeRequest()
@@ -641,7 +641,7 @@ let result = ;
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.aiNameParsedRequest()
@@ -738,7 +738,7 @@ let result = Models.aiNameMatchResult()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameMatchRequest()
@@ -863,7 +863,7 @@ let result = Models.aiNameMatchResult()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.aiNameMatchParsedRequest()
@@ -1004,7 +1004,7 @@ let result = Models.aiNameComponentList()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameParseRequest()
@@ -1097,7 +1097,7 @@ let result = ;
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.AiNameParseEmailAddressRequest()

doc/CalendarApi.md

@@ -96,7 +96,7 @@ let result = Models.alternateView()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.calendarAsAlternateRequest()
@@ -219,7 +219,7 @@ Return type: Promise< Buffer >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.calendarAsFileRequest()
@@ -359,7 +359,7 @@ let result = Models.mapiCalendarDto()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let calendarDto = Models.calendarDto()
@@ -472,7 +472,7 @@ Return type: Promise< Buffer >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.CalendarConvertRequest()
@@ -560,7 +560,7 @@ let result = Models.calendarDto()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.CalendarFromFileRequest()
@@ -673,7 +673,7 @@ let result = Models.calendarDto()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.CalendarGetRequest()
@@ -789,7 +789,7 @@ let result = Models.alternateView()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.CalendarGetAsAlternateRequest()
@@ -875,7 +875,7 @@ Return type: Promise< Buffer >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.CalendarGetAsFileRequest()
@@ -978,7 +978,7 @@ let result = Models.calendarStorageList()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.CalendarGetListRequest()
@@ -1093,7 +1093,7 @@ Return type: Promise< any >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.calendarSaveRequest()

doc/ClientAccountApi.md

@@ -66,7 +66,7 @@ let result = Models.emailClientAccount()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.ClientAccountGetRequest()
@@ -182,7 +182,7 @@ let result = Models.emailClientMultiAccount()
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.ClientAccountGetMultiRequest()
@@ -287,7 +287,7 @@ Return type: Promise< any >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.clientAccountSaveRequest()
@@ -392,7 +392,7 @@ Return type: Promise< any >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.clientAccountSaveMultiRequest()

doc/ClientFolderApi.md

@@ -45,7 +45,7 @@ Return type: Promise< any >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.clientFolderCreateRequest()
@@ -108,7 +108,7 @@ Return type: Promise< any >
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.clientFolderDeleteRequest()
@@ -182,7 +182,7 @@ let result = ;
     <summary>Method call example:</summary>
 
 ```typescript
-const api = new EmailCloud(app_key, app_sid);
+const api = new EmailCloud(clientSecret, clientId);
 
 // Prepare parameters:
 let request = Models.ClientFolderGetListRequest()