Adding 'List Articles' action

Author: GTFalcao

components/trengo/actions/list-articles/list-articles.mjs

@@ -0,0 +1,65 @@
+import utils from "../../common/utils.mjs";
+import app from "../../trengo.app.mjs";
+
+export default {
+  type: "action",
+  key: "trengo-list-articles",
+  version: "0.0.1",
+  name: "List Articles",
+  description: "List articles from a help center according to the specified criteria. [See the docs](https://developers.trengo.com/reference/list-all-articles)",
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+    localeCode: {
+      type: "string",
+      label: "Locale Code",
+      description: "The article's locale code",
+      optional: true,
+      default: "en",
+    },
+    filter: {
+      type: "string",
+      label: "Filter",
+      description: "The article's filter. You can choose one of the available options, specify `untranslated_<language_code>` for other language codes, or leave empty for all articles",
+      optional: true,
+      options: [
+        "draft",
+        "published",
+        "untranslated_en",
+      ],
+    },
+    term: {
+      type: "string",
+      label: "Search Term",
+      description: "The article's search term (if not specified, all articles will be returned)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const articles = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getArticles,
+      resourceFnArgs: {
+        helpCenterId: this.helpCenterId,
+        params: {
+          localeCode: this.localeCode,
+          filter: this.filter,
+          term: this.term,
+        },
+      },
+    });
+    for await (const item of resourcesStream) {
+      articles.push(item);
+    }
+    const length = articles.length;
+    $.export("$summary", `Successfully retrieved ${length} article${length === 1
+      ? ""
+      : "s"}`);
+    return articles;
+  },
+};

components/trengo/trengo.app.mjs

@@ -146,6 +146,22 @@ export default {
       description: "Search term to find a contact. If not given, all contacts will be returned.",
       optional: true,
     },
+    helpCenterId: {
+      type: "integer",
+      label: "Help Center ID",
+      description: "Select a help center or provide an ID",
+      async options({ page = 0 }) {
+        const response = await this.getHelpCenters({
+          params: {
+            page: page + 1,
+          },
+        });
+        return response.data.map((helpCenter) => ({
+          label: helpCenter.name || helpCenter.slug,
+          value: helpCenter.id,
+        }));
+      },
+    },
   },
   methods: {
     _getUrl(path) {
@@ -241,5 +257,19 @@ export default {
         ...args,
       });
     },
+    async getHelpCenters(args = {}) {
+      return this._makeRequest({
+        path: "/help_center",
+        ...args,
+      });
+    },
+    async getArticles({
+      helpCenterId, ...args
+    } = {}) {
+      return this._makeRequest({
+        path: `/help_center/${helpCenterId}/articles`,
+        ...args,
+      });
+    },
   },
 };