[ACTION] trengo - Helpcenter

Author: jcortes

components/trengo/actions/get-article/get-article.mjs

@@ -0,0 +1,41 @@
+import app from "../../trengo.app.mjs";
+
+export default {
+  key: "trengo-get-article",
+  name: "Get Article",
+  description: "Get a specific article. [See the documentation](https://developers.trengo.com/reference/get-an-article)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+    articleId: {
+      propDefinition: [
+        app,
+        "articleId",
+        ({ helpCenterId }) => ({
+          helpCenterId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getArticle({
+      $,
+      helpCenterId: this.helpCenterId,
+      articleId: this.articleId,
+    });
+    $.export("$summary", "Successfully retrieved article");
+    return response;
+  },
+};

components/trengo/actions/get-block/get-block.mjs

@@ -0,0 +1,41 @@
+import app from "../../trengo.app.mjs";
+
+export default {
+  key: "trengo-get-block",
+  name: "Get Block",
+  description: "Get a specific block. [See the documentation](https://developers.trengo.com/reference/get-a-block)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+    blockId: {
+      propDefinition: [
+        app,
+        "blockId",
+        ({ helpCenterId }) => ({
+          helpCenterId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getBlock({
+      $,
+      helpCenterId: this.helpCenterId,
+      blockId: this.blockId,
+    });
+    $.export("$summary", "Successfully retrieved block");
+    return response;
+  },
+};

components/trengo/actions/get-category/get-category.mjs

@@ -0,0 +1,41 @@
+import app from "../../trengo.app.mjs";
+
+export default {
+  key: "trengo-get-category",
+  name: "Get Category",
+  description: "Get a specific category. [See the documentation](https://developers.trengo.com/reference/get-a-category)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+    categoryId: {
+      propDefinition: [
+        app,
+        "categoryId",
+        ({ helpCenterId }) => ({
+          helpCenterId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getCategory({
+      $,
+      helpCenterId: this.helpCenterId,
+      categoryId: this.categoryId,
+    });
+    $.export("$summary", "Successfully retrieved category");
+    return response;
+  },
+};

components/trengo/actions/get-help-center/get-help-center.mjs

@@ -0,0 +1,31 @@
+import app from "../../trengo.app.mjs";
+
+export default {
+  key: "trengo-get-help-center",
+  name: "Get Help Center",
+  description: "Get a specific help center. [See the documentation](https://developers.trengo.com/reference/get-a-help-center)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.app.getHelpCenter({
+      $,
+      helpCenterId: this.helpCenterId,
+    });
+    $.export("$summary", "Successfully retrieved help center");
+    return response;
+  },
+};

components/trengo/actions/list-all-blocks/list-all-blocks.mjs

@@ -0,0 +1,50 @@
+import utils from "../../common/utils.mjs";
+import app from "../../trengo.app.mjs";
+
+export default {
+  key: "trengo-list-all-blocks",
+  name: "List All Blocks",
+  description: "List all blocks in a help center. [See the documentation](https://developers.trengo.com/reference/list-all-blocks)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "Maximum number of blocks to return (if not specified, all results will be returned)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const blocks = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.listBlocks,
+      resourceFnArgs: {
+        helpCenterId: this.helpCenterId,
+      },
+    });
+    for await (const item of resourcesStream) {
+      blocks.push(item);
+      if (this.maxResults && blocks.length >= this.maxResults) {
+        break;
+      }
+    }
+    const length = blocks.length;
+    $.export("$summary", `Successfully retrieved ${length} block${length === 1
+      ? ""
+      : "s"}`);
+    return blocks;
+  },
+};

components/trengo/actions/list-all-categories/list-all-categories.mjs

@@ -0,0 +1,50 @@
+import utils from "../../common/utils.mjs";
+import app from "../../trengo.app.mjs";
+
+export default {
+  key: "trengo-list-all-categories",
+  name: "List All Categories",
+  description: "List all categories in a help center. [See the documentation](https://developers.trengo.com/reference/list-all-categories)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    app,
+    helpCenterId: {
+      propDefinition: [
+        app,
+        "helpCenterId",
+      ],
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "Maximum number of categories to return (if not specified, all results will be returned)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const categories = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.listCategories,
+      resourceFnArgs: {
+        helpCenterId: this.helpCenterId,
+      },
+    });
+    for await (const item of resourcesStream) {
+      categories.push(item);
+      if (this.maxResults && categories.length >= this.maxResults) {
+        break;
+      }
+    }
+    const length = categories.length;
+    $.export("$summary", `Successfully retrieved ${length} categor${length === 1
+      ? "y"
+      : "ies"}`);
+    return categories;
+  },
+};

components/trengo/actions/list-help-centers/list-help-centers.mjs

@@ -0,0 +1,42 @@
+import utils from "../../common/utils.mjs";
+import app from "../../trengo.app.mjs";
+
+export default {
+  type: "action",
+  key: "trengo-list-help-centers",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  name: "List Help Centers",
+  description: "List all help centers. [See the documentation](https://developers.trengo.com/reference/list-all-help-centers)",
+  props: {
+    app,
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "Maximum number of help centers to return (if not specified, all results will be returned)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const helpCenters = [];
+    const resourcesStream = utils.getResourcesStream({
+      resourceFn: this.app.getHelpCenters,
+      resourceFnArgs: {},
+    });
+    for await (const item of resourcesStream) {
+      helpCenters.push(item);
+      if (this.maxResults && helpCenters.length >= this.maxResults) {
+        break;
+      }
+    }
+    const length = helpCenters.length;
+    $.export("$summary", `Successfully retrieved ${length} help center${length === 1
+      ? ""
+      : "s"}`);
+    return helpCenters;
+  },
+};