@pipedream/octopush_sms 0.0.1 → 0.1.0

package/actions/add-contact/add-contact.mjs

@@ -0,0 +1,57 @@
+import octopush from "../../octopush_sms.app.mjs";
+
+export default {
+  key: "octopush_sms-add-contact",
+  name: "Add Contact",
+  description: "Adds a new contact to a list in the Octopush SMS Gateway. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/add-a-contact/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    octopush,
+    phone: {
+      type: "string",
+      label: "Phone Number",
+      description: "Phone number of the contact",
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "First name of the contact",
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "Last name of the contact",
+    },
+    listName: {
+      type: "string",
+      label: "List Name",
+      description: "  Name of the list to which the contact should be added",
+      optional: true,
+    },
+    tag: {
+      type: "string",
+      label: "Tag Name",
+      description: "Name of the tag that will be attached to the contact",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.octopush.createContact({
+      $,
+      data: {
+        list_name: this.listName,
+        contacts: [
+          {
+            phone_number: this.phone,
+            first_name: this.firstName,
+            last_name: this.lastName,
+          },
+        ],
+        tag_name: this.tag,
+      },
+    });
+    $.export("$summary", "Successfully created contact.");
+    return response;
+  },
+};

package/actions/send-new-sms/send-new-sms.mjs

@@ -0,0 +1,97 @@
+import octopush from "../../octopush_sms.app.mjs";
+
+export default {
+  key: "octopush_sms-send-new-sms",
+  name: "Send New SMS",
+  description: "Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    octopush,
+    text: {
+      type: "string",
+      label: "Text",
+      description: "The message text (from 1 to 1224 characters).",
+    },
+    phone: {
+      type: "string",
+      label: "Phone Number",
+      description: "Phone number of the recipient",
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "First name of the recipient",
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "Last name of the recipient",
+    },
+    type: {
+      type: "string",
+      label: "Type",
+      description: "Campaign Type",
+      options: [
+        "sms_premium",
+        "sms_low_cost",
+      ],
+    },
+    sender: {
+      type: "string",
+      label: "Sender",
+      description: "Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)",
+      optional: true,
+    },
+    sendAt: {
+      type: "string",
+      label: "Send At",
+      description: "When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)",
+      optional: true,
+    },
+    purpose: {
+      type: "string",
+      label: "Purpose",
+      description: "Campaign purpose",
+      options: [
+        "alert",
+        "wholesale",
+      ],
+      optional: true,
+    },
+    withReplies: {
+      type: "boolean",
+      label: "With Replies",
+      description: "Set to `true` to get back recipient replies",
+      optional: true,
+    },
+    simulationMode: {
+      type: "boolean",
+      label: "Simulation Mode",
+      description: "If this value is `true`, your request will be simulated, and you will receive a fake result",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.octopush.sendSMS({
+      $,
+      data: {
+        text: this.text,
+        recipients: [
+          {
+            phone_number: this.phone,
+            first_name: this.firstName,
+            last_name: this.lastName,
+          },
+        ],
+        type: this.type,
+        send_at: this.sendAt,
+        purpose: this.purpose,
+        with_replies: this.withReplies,
+        simulation_mode: this.simulationMode,
+      },
+    });
+    $.export("$summary", "Successfully send new SMS.");
+    return response;
+  },
+};

package/octopush_sms.app.mjs

@@ -1,11 +1,44 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "octopush_sms",
   propDefinitions: {},
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.octopush.com/v1/public";
+    },
+    _headers() {
+      return {
+        "Content-Type": "application/json",
+        "api-login": `${this.$auth.api_login}`,
+        "api-key": `${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this,
+      path,
+      ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: this._headers(),
+        ...opts,
+      });
+    },
+    createContact(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/contact/create",
+        ...opts,
+      });
+    },
+    sendSMS(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/sms-campaign/send",
+        ...opts,
+      });
     },
   },
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/octopush_sms",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Octopush SMS Components",
   "main": "octopush_sms.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.6.0"
   }
 }