@cognigy/rest-api-client 0.9.1 → 0.12.0

package/build/shared/charts/descriptors/connectionNodes/smtp/sendEmail.js

@@ -1,27 +1,146 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEND_EMAIL = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const errors_1 = require("../../../../errors");
 const smtpConnection_1 = require("./smtpConnection");
+const serviceConnection_1 = require("./serviceConnection");
 exports.SEND_EMAIL = createNodeDescriptor_1.createNodeDescriptor({
     type: "sendEmail",
-    defaultLabel: "Send Email",
+    defaultLabel: "Send SMTP Email",
     summary: "Sends an email via SMTP",
     fields: [
+        {
+            key: "smtpType",
+            type: "select",
+            label: "Email Service",
+            description: "Select an Email Service to use or 'Other SMTP Service' for custom settings.",
+            params: {
+                options: [
+                    { label: "126", value: "126" },
+                    { label: "163", value: "163" },
+                    { label: "1und1", value: "1und1" },
+                    { label: "AOL", value: "AOL" },
+                    { label: "DebugMail", value: "DebugMail" },
+                    { label: "DynectEmail", value: "DynectEmail" },
+                    { label: "FastMail", value: "FastMail" },
+                    { label: "GandiMail", value: "GandiMail" },
+                    { label: "Gmail", value: "Gmail" },
+                    { label: "Godaddy", value: "Godaddy" },
+                    { label: "GodaddyAsia", value: "GodaddyAsia" },
+                    { label: "GodaddyEurope", value: "GodaddyEurope" },
+                    { label: "hot.ee", value: "hot.ee" },
+                    { label: "Hotmail", value: "Hotmail" },
+                    { label: "iCloud", value: "iCloud" },
+                    { label: "mail.ee", value: "mail.ee" },
+                    { label: "Mail.ru", value: "Mail.ru" },
+                    { label: "Maildev", value: "Maildev" },
+                    { label: "Mailgun", value: "Mailgun" },
+                    { label: "Mailjet", value: "Mailjet" },
+                    { label: "Mailosaur", value: "Mailosaur" },
+                    { label: "Mandrill", value: "Mandrill" },
+                    { label: "Naver", value: "Naver" },
+                    { label: "OpenMailBox", value: "OpenMailBox" },
+                    { label: "Office365", value: "Outlook365" },
+                    { label: "Postmark", value: "Postmark" },
+                    { label: "QQ", value: "QQ" },
+                    { label: "QQex", value: "QQex" },
+                    { label: "SendCloud", value: "SendCloud" },
+                    { label: "SendGrid", value: "SendGrid" },
+                    { label: "SendinBlue", value: "SendinBlue" },
+                    { label: "SendPulse", value: "SendPulse" },
+                    { label: "SES", value: "SES" },
+                    { label: "SES-US-EAST-1", value: "SES-US-EAST-1" },
+                    { label: "SES-US-WEST-2", value: "SES-US-WEST-2" },
+                    { label: "SES-EU-WEST-1", value: "SES-EU-WEST-1" },
+                    { label: "Sparkpost", value: "Sparkpost" },
+                    { label: "Yahoo", value: "Yahoo" },
+                    { label: "Yandex", value: "Yandex" },
+                    { label: "Zoho", value: "Zoho" },
+                    { label: "qiye.aliyun", value: "qiye.aliyun" },
+                    { label: "Other SMTP Service", value: "otherSmtp" },
+                ]
+            }
+        },
         {
             key: "connection",
             type: "connection",
-            label: "SMTP Connection",
+            label: "SMTP Settings",
             params: {
-                required: true,
+                required: false,
                 connectionType: smtpConnection_1.SMTP_CONNECTION.type
+            },
+            condition: {
+                or: [
+                    {
+                        "key": "smtpType",
+                        "value": "otherSmtp"
+                    },
+                    {
+                        "key": "smtpType",
+                        "value": ""
+                    },
+                    {
+                        "key": "smtpType",
+                        "value": null
+                    }
+                ]
+            }
+        },
+        {
+            key: "serviceConnection",
+            type: "connection",
+            label: "Service Credentials",
+            params: {
+                required: false,
+                connectionType: serviceConnection_1.EMAIL_SERVICE_CONNECTION.type
+            },
+            condition: {
+                and: [
+                    {
+                        "key": "smtpType",
+                        "value": "otherSmtp",
+                        "negate": true
+                    },
+                    {
+                        "key": "smtpType",
+                        "value": null,
+                        "negate": true
+                    }
+                ]
+            }
+        },
+        {
+            key: "serviceWarning",
+            type: "description",
+            label: " ",
+            params: {
+                text: "Some EMail services require additional configuration. Please refer to the documentation."
+            },
+            condition: {
+                "key": "smtpType",
+                "value": "otherSmtp",
+                "negate": true
+            }
+        },
+        {
+            key: "googleWarning",
+            type: "description",
+            label: " ",
+            params: {
+                text: "When using GMail, we recommend setting a 'FROM' Email address. See the 'Advanced' section for more."
+            },
+            condition: {
+                "key": "smtpType",
+                "value": "Gmail"
             }
         },
         {
             key: "recipient",
             type: "cognigyText",
-            label: "Recipient Email Address",
+            label: "Recipient TO Email Addresses",
+            description: "Comma-separated list of email addresses to send the email to",
             params: {
                 required: true
             }
@@ -29,37 +148,298 @@ exports.SEND_EMAIL = createNodeDescriptor_1.createNodeDescriptor({
         {
             key: "from",
             type: "cognigyText",
-            label: "From Email Address"
+            label: "Custom FROM Email Address",
+            description: "The Email Address to send the email from (defaults to username in credentials Connection)"
         },
         {
             key: "subject",
             type: "cognigyText",
-            label: "Email Subject"
+            label: "Email Subject",
+            params: {
+                required: true
+            }
         },
         {
             key: "message",
             type: "cognigyText",
             label: "Email Content",
-            defaultValue: `
-			
-`,
+            defaultValue: "\n",
             params: {
-                multiline: true
+                multiline: true,
+                richText: true
             }
         },
+        {
+            key: "cc",
+            type: "cognigyText",
+            label: "CC Email Addresses"
+        },
+        {
+            key: "bcc",
+            type: "cognigyText",
+            label: "BCC"
+        },
         {
             key: "replyTo",
             type: "cognigyText",
             label: "Reply To Address"
         },
+        {
+            key: "defineText",
+            type: "toggle",
+            label: "Define custom text EMail Content",
+            description: "If activated, allows to define a custom text version of the email",
+            defaultValue: false
+        },
+        {
+            key: "text",
+            type: "cognigyText",
+            label: "Text version of the EMail Content",
+            condition: {
+                key: "defineText",
+                value: true
+            },
+            params: {
+                multiline: true
+            }
+        },
         {
             key: "async",
             type: "toggle",
             label: "Execute Request asynchronous",
             description: "Continue Flow execution before the result comes back",
             defaultValue: false
+        },
+        {
+            key: "attachmentType",
+            type: "select",
+            label: "EMail Attachment",
+            defaultValue: "none",
+            params: {
+                options: [
+                    { label: "No Attachment", value: "none" },
+                    { label: "From Text Content", value: "text" },
+                    { label: "From URL", value: "url" },
+                    { label: "From Base64 String", value: "base64" },
+                    { label: "From Custom Content Type", value: "custom" },
+                    { label: "From Pregenerated MIME Node", value: "raw" },
+                ]
+            }
+        },
+        {
+            key: "priority",
+            type: "select",
+            label: "EMail Priority",
+            defaultValue: "normal",
+            params: {
+                options: [
+                    { label: "high", value: "high" },
+                    { label: "normal", value: "normal" },
+                    { label: "low", value: "low" }
+                ]
+            }
+        },
+        {
+            key: "attachmentFilename",
+            type: "cognigyText",
+            label: "Filename",
+            defaultValue: "file.txt",
+            description: "The filename to use for the attachment",
+            condition: {
+                and: [
+                    {
+                        key: "attachmentType",
+                        value: "none",
+                        negate: true
+                    },
+                    {
+                        key: "attachmentType",
+                        value: "raw",
+                        negate: true
+                    },
+                    {
+                        key: "attachmentType",
+                        value: null,
+                        negate: true
+                    }
+                ]
+            }
+        },
+        {
+            key: "attachmentContentType",
+            type: "cognigyText",
+            label: "Content Type",
+            defaultValue: "text/plain",
+            condition: {
+                key: "attachmentType",
+                value: "custom"
+            }
+        },
+        {
+            key: "attachmentEncodingType",
+            type: "cognigyText",
+            label: "Encoding",
+            defaultValue: "base64",
+            condition: {
+                key: "attachmentType",
+                value: "base64"
+            }
+        },
+        {
+            key: "attachmentContent",
+            type: "cognigyText",
+            label: "Content",
+            params: {
+                multiline: true
+            },
+            condition: {
+                or: [
+                    {
+                        "key": "attachmentType",
+                        "value": "text"
+                    },
+                    {
+                        "key": "attachmentType",
+                        "value": "base64"
+                    },
+                    {
+                        "key": "attachmentType",
+                        "value": "custom"
+                    },
+                ]
+            }
+        },
+        {
+            key: "attachmentURL",
+            type: "cognigyText",
+            label: "URL / Data URI",
+            description: "The URL to retrieve the attachment from. Data URIs are allowed.",
+            condition: {
+                key: "attachmentType",
+                value: "url"
+            }
+        },
+        {
+            key: "attachmentRaw",
+            type: "cognigyText",
+            label: "Raw Content",
+            defaultValue: `Content-Type: text/plain
+Content-Disposition: attachment;
+
+Hello world!`,
+            params: {
+                multiline: true
+            },
+            condition: {
+                key: "attachmentType",
+                value: "raw"
+            }
+        },
+        {
+            key: "storeLocation",
+            type: "select",
+            label: "Store Location of SMTP Request result",
+            description: "Where to store the result of the SMTP Request",
+            params: {
+                options: [
+                    {
+                        label: "Don't store result",
+                        value: "none"
+                    },
+                    {
+                        label: "Input",
+                        value: "input"
+                    },
+                    {
+                        label: "Context",
+                        value: "context"
+                    }
+                ],
+            },
+            defaultValue: "none"
+        },
+        {
+            key: "inputKey",
+            type: "cognigyText",
+            label: "Input Key to store Result",
+            defaultValue: "email",
+            condition: {
+                key: "storeLocation",
+                value: "input",
+            }
+        },
+        {
+            key: "contextKey",
+            type: "cognigyText",
+            label: "Context Key to store Result",
+            defaultValue: "email",
+            condition: {
+                key: "storeLocation",
+                value: "context",
+            }
+        },
+        {
+            key: "stopOnError",
+            type: "toggle",
+            label: "Stop On Error",
+            defaultValue: false
         }
     ],
+    sections: [
+        {
+            "key": "advanced",
+            "label": "Advanced",
+            "defaultCollapsed": true,
+            "fields": [
+                "from",
+                "cc",
+                "bcc",
+                "replyTo",
+                "defineText",
+                "text",
+                "priority",
+                "async"
+            ]
+        },
+        {
+            "key": "attachments",
+            "label": "Attachments",
+            "defaultCollapsed": true,
+            "fields": [
+                "attachmentType",
+                "attachmentFilename",
+                "attachmentContentType",
+                "attachmentEncodingType",
+                "attachmentContent",
+                "attachmentURL",
+                "attachmentRaw"
+            ]
+        },
+        {
+            key: "resultStorage",
+            label: "Result Storage & Error Handling",
+            defaultCollapsed: true,
+            fields: [
+                "storeLocation",
+                "inputKey",
+                "contextKey",
+                "stopOnError"
+            ]
+        },
+    ],
+    form: [
+        { key: "smtpType", type: "field" },
+        { key: "serviceWarning", type: "field" },
+        { key: "googleWarning", type: "field" },
+        { key: "connection", type: "field" },
+        { key: "serviceConnection", type: "field" },
+        { key: "recipient", type: "field" },
+        { key: "subject", type: "field" },
+        { key: "message", type: "field" },
+        { key: "attachments", type: "section" },
+        { key: "resultStorage", type: "section" },
+        { key: "advanced", type: "section" }
+    ],
     preview: {
         key: "recipient",
         type: "text"
@@ -67,14 +447,50 @@ exports.SEND_EMAIL = createNodeDescriptor_1.createNodeDescriptor({
     tags: ["data", "service", "mail", "email", "message"],
     function: async ({ cognigy, config, nodeId, childConfigs }) => {
         const { api } = cognigy;
-        const { connection, recipient } = config;
-        if (!connection) {
-            throw new errors_1.InvalidArgumentError("A connection has to be selected");
+        const { connection, serviceConnection, recipient, subject, message, storeLocation, inputKey, contextKey, stopOnError } = config;
+        if (!connection && !serviceConnection) {
+            throw new errors_1.InvalidArgumentError("A Connection has to be selected");
         }
         if (!recipient) {
-            throw new errors_1.InvalidArgumentError("A recipient has to be specified");
+            throw new errors_1.InvalidArgumentError("A Recipient has to be specified");
+        }
+        if (!message) {
+            throw new errors_1.InvalidArgumentError("A Message has to be specified");
+        }
+        if (storeLocation === "context" && !contextKey) {
+            throw new errors_1.InvalidArgumentError("A context key has to be specified");
+        }
+        if (storeLocation === "input" && !inputKey) {
+            throw new errors_1.InvalidArgumentError("An input key has to be specified");
+        }
+        try {
+            const result = await api.sendEmail({ cognigy, config, nodeId, childConfigs });
+            switch (storeLocation) {
+                case "context":
+                    api.deleteContext(contextKey);
+                    api.addToContext(contextKey, { result }, "simple");
+                    break;
+                case "input":
+                    api.addToInput(inputKey, { result });
+                    break;
+            }
+        }
+        catch (err) {
+            if (stopOnError) {
+                throw err;
+            }
+            const resultObject = {
+                error: err.message
+            };
+            switch (storeLocation) {
+                case "context":
+                    api.addToContext(contextKey, resultObject, "simple");
+                    break;
+                case "input":
+                    api.addToInput(inputKey, resultObject);
+                    break;
+            }
         }
-        await api.sendEmail({ cognigy, config, nodeId, childConfigs });
     }
 });
 //# sourceMappingURL=sendEmail.js.map

package/build/shared/charts/descriptors/connectionNodes/smtp/serviceConnection.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EMAIL_SERVICE_CONNECTION = void 0;
+exports.EMAIL_SERVICE_CONNECTION = {
+    type: "EmailService",
+    label: "A Connection to an Email Service",
+    fields: [
+        { fieldName: "username" },
+        { fieldName: "password" },
+    ]
+};
+//# sourceMappingURL=serviceConnection.js.map

package/build/shared/charts/descriptors/connectionNodes/smtp/smtpConnection.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMTP_CONNECTION = void 0;
 exports.SMTP_CONNECTION = {
     type: "SMTP",
-    label: "A Connection to a Microsoft SMTP Server",
+    label: "A Connection to an SMTP Server",
     fields: [
         { fieldName: "host" },
         { fieldName: "port" },

package/build/shared/charts/descriptors/connectionNodes/sql/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cognigySQLModule = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const runQuery_1 = require("./runQuery");

package/build/shared/charts/descriptors/connectionNodes/sql/runQuery.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQL_RUN_QUERY = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const errors_1 = require("../../../../errors");

package/build/shared/charts/descriptors/connectionNodes/sql/runStoredProcedure.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQL_RUN_STORED_PROCEDURE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const errors_1 = require("../../../../errors");

package/build/shared/charts/descriptors/connectionNodes/sql/runTransaction.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQL_RUN_TRANSACTION = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../../createNodeDescriptor");
 const errors_1 = require("../../../../errors");

package/build/shared/charts/descriptors/connectionNodes/sql/sqlConnection.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQL_CONNECTION = void 0;
 exports.SQL_CONNECTION = {
     type: "mssql",
     label: "A Connection to a Microsoft SQL Server",

package/build/shared/charts/descriptors/data/addToContext.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADD_TO_CONTEXT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/data/code.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CODE = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/data/copyDataToContext.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.COPY_DATA_TO_CONTEXT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/data/copySlotsToContext.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.COPY_SLOTS_TO_CONTEXT = void 0;
 /* Custom modules */
 const createNodeDescriptor_1 = require("../../createNodeDescriptor");
 /**

package/build/shared/charts/descriptors/data/index.js

@@ -1,15 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOG = exports.CODE = exports.RESET_CONTEXT = exports.REMOVE_FROM_CONTEXT = exports.COPY_SLOTS_TO_CONTEXT = exports.COPY_DATA_TO_CONTEXT = exports.ADD_TO_CONTEXT = void 0;
 var addToContext_1 = require("./addToContext");
-exports.ADD_TO_CONTEXT = addToContext_1.ADD_TO_CONTEXT;
+Object.defineProperty(exports, "ADD_TO_CONTEXT", { enumerable: true, get: function () { return addToContext_1.ADD_TO_CONTEXT; } });
 var copyDataToContext_1 = require("./copyDataToContext");
-exports.COPY_DATA_TO_CONTEXT = copyDataToContext_1.COPY_DATA_TO_CONTEXT;
+Object.defineProperty(exports, "COPY_DATA_TO_CONTEXT", { enumerable: true, get: function () { return copyDataToContext_1.COPY_DATA_TO_CONTEXT; } });
 var copySlotsToContext_1 = require("./copySlotsToContext");
-exports.COPY_SLOTS_TO_CONTEXT = copySlotsToContext_1.COPY_SLOTS_TO_CONTEXT;
+Object.defineProperty(exports, "COPY_SLOTS_TO_CONTEXT", { enumerable: true, get: function () { return copySlotsToContext_1.COPY_SLOTS_TO_CONTEXT; } });
 var removeFromContext_1 = require("./removeFromContext");
-exports.REMOVE_FROM_CONTEXT = removeFromContext_1.REMOVE_FROM_CONTEXT;
+Object.defineProperty(exports, "REMOVE_FROM_CONTEXT", { enumerable: true, get: function () { return removeFromContext_1.REMOVE_FROM_CONTEXT; } });
 var resetContext_1 = require("./resetContext");
-exports.RESET_CONTEXT = resetContext_1.RESET_CONTEXT;
+Object.defineProperty(exports, "RESET_CONTEXT", { enumerable: true, get: function () { return resetContext_1.RESET_CONTEXT; } });
 var code_1 = require("./code");
-exports.CODE = code_1.CODE;
+Object.defineProperty(exports, "CODE", { enumerable: true, get: function () { return code_1.CODE; } });
+var log_1 = require("./log");
+Object.defineProperty(exports, "LOG", { enumerable: true, get: function () { return log_1.LOG; } });
 //# sourceMappingURL=index.js.map