Merging pull request #16555

* Added actions

* Improve action summary

* Added actions

---------

Co-authored-by: Leo Vu <[email protected]>

Author: lcaresia

components/z_api/actions/get-contacts/get-contacts.mjs

@@ -0,0 +1,35 @@
+import app from "../../z_api.app.mjs";
+
+export default {
+  key: "z_api-get-contacts",
+  name: "Get Contacts",
+  description: "Get a list of all your WhatsApp contacts. [See the documentation](https://developer.z-api.io/en/contacts/get-contacts)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    pageNum: {
+      propDefinition: [
+        app,
+        "pageNum",
+      ],
+    },
+    pageSize: {
+      propDefinition: [
+        app,
+        "pageSize",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getContacts({
+      $,
+      params: {
+        page: this.pageNum,
+        pageSize: this.pageSize,
+      },
+    });
+    $.export("$summary", `Successfully retrieved ${response.length} contacts`);
+    return response;
+  },
+};

components/z_api/actions/modify-chat/modify-chat.mjs

@@ -0,0 +1,44 @@
+import app from "../../z_api.app.mjs";
+
+export default {
+  key: "z_api-modify-chat",
+  name: "Modify Chat",
+  description: "Modify the specified chat. [See the documentation](https://developer.z-api.io/en/chats/delete-chat)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    pageNum: {
+      propDefinition: [
+        app,
+        "pageNum",
+      ],
+    },
+    chat: {
+      propDefinition: [
+        app,
+        "chat",
+        (c) => ({
+          pageNum: c.pageNum,
+        }),
+      ],
+    },
+    action: {
+      propDefinition: [
+        app,
+        "action",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.modifyChat({
+      $,
+      data: {
+        phone: this.chat,
+        action: this.action,
+      },
+    });
+    $.export("$summary", "Successfully modified chat with number: " + this.chat);
+    return response;
+  },
+};

components/z_api/actions/send-text/send-text.mjs

@@ -0,0 +1,35 @@
+import app from "../../z_api.app.mjs";
+
+export default {
+  key: "z_api-send-text",
+  name: "Send Text",
+  description: "Send a text to the specified phone. [See the documentation](https://developer.z-api.io/en/message/send-message-text)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    phone: {
+      propDefinition: [
+        app,
+        "phone",
+      ],
+    },
+    message: {
+      propDefinition: [
+        app,
+        "message",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.sendText({
+      $,
+      data: {
+        phone: this.phone,
+        message: this.message,
+      },
+    });
+    $.export("$summary", "Successfully sent text to" + this.phone);
+    return response;
+  },
+};

components/z_api/common/constants.mjs

@@ -0,0 +1,36 @@
+export default {
+  ACTION_OPTIONS: [
+    {
+      label: "Delete",
+      value: "delete",
+    },
+    {
+      label: "Clear",
+      value: "clear",
+    },
+    {
+      label: "Mute",
+      value: "mute",
+    },
+    {
+      label: "Unmute",
+      value: "unmute",
+    },
+    {
+      label: "Pin",
+      value: "pin",
+    },
+    {
+      label: "Unpin",
+      value: "unpin",
+    },
+    {
+      label: "Archive",
+      value: "archive",
+    },
+    {
+      label: "Unarchive",
+      value: "unarchive",
+    },
+  ],
+};

components/z_api/package.json

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

components/z_api/z_api.app.mjs

@@ -1,11 +1,105 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "z_api",
-  propDefinitions: {},
+  propDefinitions: {
+    phone: {
+      type: "string",
+      label: "Phone",
+      description: "Telephone number of the contact the message will be sent to, i.e.: `551199999999`",
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "The message to be sent",
+    },
+    action: {
+      type: "string",
+      label: "Action",
+      description: "The action to be performed on the chat",
+      options: constants.ACTION_OPTIONS,
+    },
+    pageNum: {
+      type: "string",
+      label: "Page",
+      description: "Used to paginate the results",
+    },
+    pageSize: {
+      type: "string",
+      label: "Page Size",
+      description: "The number of chats to be retrieved",
+    },
+    chat: {
+      type: "string",
+      label: "Chat",
+      description: "The chat to be modified",
+      async options({ pageNum }) {
+        const response = await this.getChats({
+          pageNum,
+        });
+        return response.map(({
+          name, phone,
+        }) => ({
+          label: name || phone,
+          value: phone,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `https://api.z-api.io/instances/${this.$auth.instance_id}/token/${this.$auth.token_id}`;
+    },
+    async _makeRequest(opts = {}) {
+      const {
+        $ = this,
+        path,
+        headers,
+        ...otherOpts
+      } = opts;
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        headers: {
+          "Client-Token": `${this.$auth.account_security_token}`,
+          ...headers,
+        },
+      });
+    },
+    async getContacts(args = {}) {
+      return this._makeRequest({
+        path: "/contacts",
+        ...args,
+      });
+    },
+    async sendText(args = {}) {
+      return this._makeRequest({
+        path: "/send-text",
+        method: "post",
+        ...args,
+      });
+    },
+    async modifyChat(args = {}) {
+      return this._makeRequest({
+        path: "/modify-chat",
+        method: "post",
+        ...args,
+      });
+    },
+    async getChats({
+      pageNum,
+      ...args
+    }) {
+      return this._makeRequest({
+        path: "/chats",
+        params: {
+          page: pageNum,
+          pageSize: 50,
+        },
+        ...args,
+      });
     },
   },
-};
+};