[ACTION] Freshdesk - Canned Responses

Author: jcortes

components/freshdesk/actions/get-canned-response/get-canned-response.mjs

@@ -0,0 +1,35 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-get-canned-response",
+  name: "Get Canned Response",
+  description: "View a Canned Response. [See the documentation](https://developers.freshdesk.com/api/#view_a_canned_response)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    freshdesk,
+    cannedResponseId: {
+      propDefinition: [
+        freshdesk,
+        "cannedResponseId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      freshdesk,
+      cannedResponseId,
+    } = this;
+    const response = await freshdesk.getCannedResponse({
+      $,
+      cannedResponseId,
+    });
+    response && $.export("$summary", `Successfully retrieved canned response: ${response.title}`);
+    return response;
+  },
+};

components/freshdesk/actions/get-folder-canned-responses/get-folder-canned-responses.mjs

@@ -0,0 +1,43 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-get-folder-canned-responses",
+  name: "Get Canned Responses in a Folder",
+  description: "View all the details of canned responses in a folder. [See the documentation](https://developers.freshdesk.com/api/#get_details_of_canned_responses_in_a_folder)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    freshdesk,
+    cannedResponseFolderId: {
+      propDefinition: [
+        freshdesk,
+        "cannedResponseFolderId",
+      ],
+    },
+    maxResults: {
+      propDefinition: [
+        freshdesk,
+        "maxResults",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      freshdesk, cannedResponseFolderId, maxResults,
+    } = this;
+    const responses = await freshdesk.getPaginatedResources({
+      fn: freshdesk.getFolderCannedResponses,
+      max: maxResults,
+      args: {
+        folderId: cannedResponseFolderId,
+      },
+    });
+    $.export("$summary", `Successfully retrieved ${responses.length} canned response(s) from folder`);
+    return responses;
+  },
+};

components/freshdesk/actions/list-all-folders/list-all-folders.mjs

@@ -0,0 +1,35 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-list-all-folders",
+  name: "List All Folders",
+  description: "View all the canned response folders. [See the documentation](https://developers.freshdesk.com/api/#list_all_canned_response_folders)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    freshdesk,
+    maxResults: {
+      propDefinition: [
+        freshdesk,
+        "maxResults",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      freshdesk, maxResults,
+    } = this;
+    const folders = await freshdesk.getPaginatedResources({
+      fn: freshdesk.listCannedResponseFolders,
+      max: maxResults,
+      args: {},
+    });
+    $.export("$summary", `Successfully retrieved ${folders.length} folder(s)`);
+    return folders;
+  },
+};

components/freshdesk/actions/list-folder-canned-responses/list-folder-canned-responses.mjs

@@ -0,0 +1,35 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-list-folder-canned-responses",
+  name: "List All Canned Responses in a Folder",
+  description: "View all canned responses in a folder. [See the documentation](https://developers.freshdesk.com/api/#list_all_canned_responses_in_a_folder)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    freshdesk,
+    cannedResponseFolderId: {
+      propDefinition: [
+        freshdesk,
+        "cannedResponseFolderId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      freshdesk, cannedResponseFolderId,
+    } = this;
+    const response = await freshdesk.listFolderCannedResponses({
+      $,
+      folderId: cannedResponseFolderId,
+    });
+    const responseCount = response?.canned_responses?.length || 0;
+    $.export("$summary", `Successfully retrieved folder with ${responseCount} canned response(s)`);
+    return response;
+  },
+};

components/freshdesk/freshdesk.app.mjs

@@ -281,6 +281,42 @@ export default {
         return threads.map(({ id }) => id);
       },
     },
+    cannedResponseId: {
+      type: "integer",
+      label: "Canned Response ID",
+      description: "The ID of a canned response",
+      async options({ page = 0 }) {
+        const responses = await this.listAllCannedResponses({
+          params: {
+            page: page + 1,
+          },
+        });
+        return responses.map(({
+          id, title,
+        }) => ({
+          label: title || id,
+          value: id,
+        }));
+      },
+    },
+    cannedResponseFolderId: {
+      type: "integer",
+      label: "Canned Response Folder ID",
+      description: "The ID of a canned response folder",
+      async options({ page = 0 }) {
+        const folders = await this.listCannedResponseFolders({
+          params: {
+            page: page + 1,
+          },
+        });
+        return folders.map(({
+          id, name,
+        }) => ({
+          label: name || id,
+          value: id,
+        }));
+      },
+    },
   },
   methods: {
     setLastDateChecked(db, value) {
@@ -731,5 +767,41 @@ export default {
         ...args,
       });
     },
+    getCannedResponse({
+      cannedResponseId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/canned_responses/${cannedResponseId}`,
+        ...args,
+      });
+    },
+    listAllCannedResponses(args) {
+      return this._makeRequest({
+        url: "/canned_responses",
+        ...args,
+      });
+    },
+    listCannedResponseFolders(args) {
+      return this._makeRequest({
+        url: "/canned_response_folders",
+        ...args,
+      });
+    },
+    listFolderCannedResponses({
+      folderId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/canned_response_folders/${folderId}`,
+        ...args,
+      });
+    },
+    getFolderCannedResponses({
+      folderId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/canned_response_folders/${folderId}/responses`,
+        ...args,
+      });
+    },
   },
 };

components/freshdesk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/freshdesk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Pipedream Freshdesk Components",
   "main": "freshdesk.app.mjs",
   "keywords": [