[Components] smstools #14370

Sources
 - New Inbound Message

Actions
 - Add Contact
 - Add Contact Opt Out
 - Send SMS

Author: luancazarine

components/smstools/actions/add-contact-opt-out/add-contact-opt-out.mjs

@@ -1,27 +1,34 @@
+import { ConfigurationError } from "@pipedream/platform";
 import smstools from "../../smstools.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "smstools-add-contact-opt-out",
   name: "Add Contact to Opt-Out List",
   description: "Adds a selected contact to the opt-out list, stopping further communications. [See the documentation](https://www.smstools.com/en/sms-gateway-api/add_optout)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     smstools,
-    contact: {
+    contactNumber: {
       propDefinition: [
         smstools,
-        "contact",
+        "contactNumber",
       ],
     },
   },
   async run({ $ }) {
-    const response = await this.smstools.addOptOut({
-      contactid: this.contact,
-    });
+    try {
+      const response = await this.smstools.addOptOut({
+        $,
+        data: {
+          number: this.contactNumber,
+        },
+      });
 
-    $.export("$summary", `Successfully added contact with ID ${this.contact} to the opt-out list.`);
-    return response;
+      $.export("$summary", `Successfully added contact number ${this.contactNumber} to the opt-out list.`);
+      return response;
+    } catch (e) {
+      throw new ConfigurationError("The number is already opted-out or does not exist in the database.");
+    }
   },
 };

components/smstools/actions/add-contact/add-contact.mjs

@@ -1,21 +1,20 @@
+import { ConfigurationError } from "@pipedream/platform";
 import smstools from "../../smstools.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "smstools-add-contact",
   name: "Add Contact to Group",
   description: "Adds a new contact to an existing contact list. [See the documentation](https://www.smstools.com/en/sms-gateway-api/add_contact)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     smstools,
     phone: {
-      propDefinition: [
-        smstools,
-        "phone",
-      ],
+      type: "string",
+      label: "Phone Number",
+      description: "The phone number of the contact.",
     },
-    groupId: {
+    groupid: {
       propDefinition: [
         smstools,
         "groupId",
@@ -36,7 +35,7 @@ export default {
     birthday: {
       type: "string",
       label: "Birthday",
-      description: "Birthday of the contact.",
+      description: "Birthday of the contact. **Format: YYYY-MM-DD**.",
       optional: true,
     },
     extra1: {
@@ -95,24 +94,21 @@ export default {
     },
   },
   async run({ $ }) {
-    const response = await this.smstools.addContactToGroup({
-      phone: this.phone,
-      groupId: this.groupId,
-      firstname: this.firstName,
-      lastname: this.lastName,
-      birthday: this.birthday,
-      extra1: this.extra1,
-      extra2: this.extra2,
-      extra3: this.extra3,
-      extra4: this.extra4,
-      extra5: this.extra5,
-      extra6: this.extra6,
-      extra7: this.extra7,
-      extra8: this.extra8,
-      unsubscribed: this.unsubscribed,
-    });
+    try {
+      const {
+        smstools,
+        ...data
+      } = this;
+
+      const response = await smstools.addContact({
+        $,
+        data,
+      });
 
-    $.export("$summary", `Successfully added contact with phone number ${this.phone}`);
-    return response;
+      $.export("$summary", `Successfully added contact with ID: ${response.ID}`);
+      return response;
+    } catch (e) {
+      throw new ConfigurationError(e.response.data.errorMsg);
+    }
   },
 };

components/smstools/actions/send-sms/send-sms.mjs

@@ -1,5 +1,4 @@
 import smstools from "../../smstools.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "smstools-send-sms",
@@ -17,8 +16,10 @@ export default {
     to: {
       propDefinition: [
         smstools,
-        "to",
+        "contactNumber",
       ],
+      type: "string[]",
+      description: "The contact(s) to send the message to.",
     },
     sender: {
       propDefinition: [
@@ -27,24 +28,21 @@ export default {
       ],
     },
     date: {
-      propDefinition: [
-        smstools,
-        "date",
-      ],
+      type: "string",
+      label: "Scheduled Date",
+      description: "The date to send the message. **Format: yyyy-MM-dd HH:mm**. If not provided, the message will be sent as soon as possible.",
       optional: true,
     },
     reference: {
-      propDefinition: [
-        smstools,
-        "reference",
-      ],
+      type: "string",
+      label: "Reference",
+      description: "Reference for the message.",
       optional: true,
     },
     test: {
-      propDefinition: [
-        smstools,
-        "test",
-      ],
+      type: "boolean",
+      label: "Test",
+      description: "Test mode for the message.",
       optional: true,
     },
     subId: {
@@ -57,13 +55,16 @@ export default {
   },
   async run({ $ }) {
     const response = await this.smstools.sendMessage({
-      message: this.message,
-      to: this.to,
-      sender: this.sender,
-      date: this.date,
-      reference: this.reference,
-      test: this.test,
-      subId: this.subId,
+      $,
+      data: {
+        message: this.message,
+        to: this.to,
+        sender: this.sender,
+        date: this.date,
+        reference: this.reference,
+        test: this.test,
+        subId: this.subId,
+      },
     });
     $.export("$summary", `Message sent successfully with ID: ${response.messageid}`);
     return response;

components/smstools/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/smstools",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream SMSTools Components",
   "main": "smstools.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }