Merge pull request #683 from 8x8/feature/send-sms-8x8

8x8 Send SMS Node

Author: alexteusz

extensions/8x8/README.md

@@ -146,4 +146,45 @@ The customer has the sole responsability to obtain and store to context for late
 More info on the enpoint [8x8 Contact Center Data Augmentation API](https://support.8x8.com/contact-center/8x8-contact-center/developers/8x8_Contact_Center_Data_Augmentation_API)
 
 ### Exit Points:
-No child nodes needed or configured for this. Failure will result in missed transmission and the error message logged in Logs.
+No child nodes needed or configured for this. Failure will result in missed transmission and the error message logged in Logs.
+
+## Node: Send SMS
+
+This node enables you to send outbound SMS messages to enhance customer engagement and deliver timely notifications. Configure it with your 8x8 Connect credentials, define message content, and specify recipient numbers for personalized communication.
+
+### Important requirement:
+
+This Extension needs a Connection to be defined and passed to the Nodes. The Connection must have the following keys:
+
+- API Key
+  - key: **apiKey**
+  - value: Your 8x8-Connect API Key
+- Subaccount Id
+  - key: **subAccountId**
+  - value Your Subaccount Id
+
+### Setup Steps:
+
+Configure the node connection with apiKey and subAccountId from your [8x8 Connect](https://connect.8x8.com/) account.
+
+This Flow Node sends an SMS message to a provided destination, while the result is stored in the `input` or `context` object:
+
+```json
+{
+    "umid": "158ebe36-14f6-4b51-8121-b099006d829a",
+    "clientMessageId": null,
+    "destination": "+6512345678",
+    "encoding": "GSM7",
+    "status": {
+        "code": "QUEUED",
+        "description": "SMS is accepted and queued for processing"
+    }
+}
+```
+
+Optional: Set up the Sender ID in the **Source** field.
+
+### Exit Points:
+The node will confirm successful message dispatch or failure, allowing for appropriate flow actions. 
+- SMS Success
+- SMS Error

extensions/8x8/package.json

@@ -1,6 +1,6 @@
 {
-	"name": "8x8-cognigy-extension",
-	"version": "5.0.0",
+	"name": "8x8",
+	"version": "5.1.0",
 	"description": "Integrates with 8x8",
 	"main": "build/module.js",
 	"scripts": {

extensions/8x8/src/connections/8x8ConnectionSMS.ts

@@ -0,0 +1,7 @@
+import { IConnectionSchema } from "@cognigy/extension-tools";
+
+export const smsConnection: IConnectionSchema = {
+  type: "sms8x8",
+  label: "8x8 SMS",
+  fields: [{ fieldName: "apiKey" }, { fieldName: "subAccountId" }],
+};

extensions/8x8/src/module.ts

@@ -1,25 +1,26 @@
-import { createExtension } from '@cognigy/extension-tools';
-import { simpleConnection } from './connections/8x8SimpleConnection';
-import { getCustomerNodes } from './nodes/customer';
-import { getScheduleNodes } from './nodes/schedule';
-import { getTestConditionOfQueueNode } from './nodes/testConditionOfQueue';
-import { getCaseNodes } from './nodes/case';
-import { getVoiceHandoverNode } from './nodes/voiceHandover';
-import { getDataAugmentationNode } from './nodes/dataAugmentation';
+import { createExtension } from "@cognigy/extension-tools";
+import { smsConnection } from "./connections/8x8ConnectionSMS";
+import { simpleConnection } from "./connections/8x8SimpleConnection";
+import { getSMSNodes } from "./nodes/SMS";
+import { getCaseNodes } from "./nodes/case";
+import { getCustomerNodes } from "./nodes/customer";
+import { getDataAugmentationNode } from "./nodes/dataAugmentation";
+import { getScheduleNodes } from "./nodes/schedule";
+import { getTestConditionOfQueueNode } from "./nodes/testConditionOfQueue";
+import { getVoiceHandoverNode } from "./nodes/voiceHandover";
 
 export default createExtension({
   nodes: [
+    ...getSMSNodes(),
     ...getCustomerNodes(),
     ...getScheduleNodes(),
     ...getTestConditionOfQueueNode(),
     ...getCaseNodes(),
     ...getVoiceHandoverNode(),
-    ...getDataAugmentationNode()
-  ],
-  connections: [
-    simpleConnection
+    ...getDataAugmentationNode(),
   ],
+  connections: [simpleConnection, smsConnection],
   options: {
-    label: '8x8'
-  }
+    label: "8x8",
+  },
 });

extensions/8x8/src/nodes/SMS/index.ts

@@ -0,0 +1,8 @@
+import type { INodeDescriptor } from "@cognigy/extension-tools";
+import { onErrorSMS, onSuccessSMS, sendSMSNode } from "./sendSMS";
+
+export const getSMSNodes = (): INodeDescriptor[] => [
+  sendSMSNode,
+  onSuccessSMS,
+  onErrorSMS,
+];