@manyos/smileconnect-api 1.61.0 → 1.62.0

package/docs/adapter.md

@@ -40,7 +40,13 @@ const adapterParams = {
         secret: env.SC_SECRET,
         ssoUrl: env.SC_SSO_URL,
         smileConnectUrl: env.SC_SMILECONNECT_URL
+    },
+    deepl: {
+        type: "Deepl",
+        authKey: env.DEEPL_KEY,
+        url: "https://api-free.deepl.com/v2/translate"
     }
+    
 };
 
 // noinspection JSAnnotator
@@ -566,3 +572,104 @@ The SMILEconnect Adapter can be used to do calls against SMILEconnect. It will a
 The SMILEconnect adapter is an open source project.
 
 [Visit the project homepage for details](https://github.com/manyosit/smileconnect-client)
+
+# Mail
+
+## Configuration values
+
+**host**: The SMTP Host
+
+**port**: The SMTP Port
+
+**secure**: Is secure communication use? True/False
+
+**auth.user**: User for SMTP Authentication
+**auth.pass**: Pass for SMTP Authentication
+
+## Functions
+
+### sendMail
+
+```javascript
+async sendMail(mailData)
+```
+
+Parameter (mailData):
+
+* from
+
+The address of the sender.
+
+* to
+
+The addresses of the receivers.
+
+* subject
+
+The subject of the mail.
+
+* text
+
+The plain text body.
+
+* html
+
+The html body.
+
+Full example:
+
+```javascript
+const mailData = {
+    from: '"Fred Foo 👻" <foo@example.com>', // sender address
+    to: "bar@example.com", // list of receivers
+    subject: "Hello ✔", // Subject line
+    text: "Hello world?", // plain text body
+    html: "<b>Hello world?</b>", // html body
+}
+```
+
+# DeepL
+
+Provides access to the Deepl translation API.
+
+## Configuration values
+
+**authKey**: Your Deepl API Key. e.g. d82js82jd-8a14-119d-f8e9-dk2:fx
+
+**url**: The url of the deepl endpoint. e.g. https://api-free.deepl.com/v2/translate
+
+## Functions
+
+### Translate
+
+```javascript
+async translate(targetLanguage, text)
+```
+Runs a query against the ldap Server.
+
+Parameter:
+
+* targetLanguage
+
+Defines the target language that will be used for translation. e.g. DE
+
+* text
+
+The text that should be translated. Either string or array of string.
+
+Full example:
+
+```javascript
+const text = 'Guten Morgen. Hoffe wir sehen uns bald wieder! Viele Grüße';
+const result = await adapter.deepl.translate('EN', text);
+```
+
+Returns an object with an array translated sentences. e.g.
+
+```javascript
+{
+    "translations": [
+        {"detected_source_language":"DE","text":"Good morning. Hope to see you soon! Many greetings, Robert"}
+    ]
+}
+```

package/docs/releases.md

@@ -1,7 +1,10 @@
 # Release Notes
 
 ## API
-### 1.61.0 - 17.11.22
+### 1.62.0 - 18.11.22
+Add Deepl Translation Adapter
+
+### 1.61.1 - 17.11.22
 Add HttpsProxyAgent to Scripts
 
 ### 1.60.0 - 27.09.22
@@ -179,7 +182,10 @@ e.g.
 */v1/incidents?impersonateUser=abc123
 
 ## Event Manager
-### 1.26.0 - 17.11.22
+### 1.29.0 - 18.11.22
+Add Deepl Translation Adapter
+
+### 1.28.1 - 17.11.22
 Add HttpsProxyAgent to Scripts
 
 ### 1.25.0 - 13.09.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.61.0",
+  "version": "1.62.0",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {
@@ -24,6 +24,7 @@
     "express-request-id": "^1.4.1",
     "express-validator": "^6.10.1",
     "fast-xml-parser": "^3.20.3",
+    "https-proxy-agent": "^5.0.1",
     "moment": "^2.29.1",
     "mongoose": "^5.12.5",
     "node-cache": "^4.2.1",