@pipedream/freshdesk 0.3.0 → 0.4.0

package/actions/list-category-folders/list-category-folders.mjs

@@ -0,0 +1,28 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-list-category-folders",
+  name: "List Category Folders",
+  description: "List category folders in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#solution_folder_attributes)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    categoryId: {
+      propDefinition: [
+        freshdesk,
+        "categoryId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.listCategoryFolders({
+      $,
+      categoryId: this.categoryId,
+    });
+    $.export("$summary", `Successfully listed ${response.length} solution folder${response.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/list-folder-articles/list-folder-articles.mjs

@@ -0,0 +1,47 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-list-folder-articles",
+  name: "List Folder Articles",
+  description: "List folder articles in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#solution_article_attributes)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    categoryId: {
+      propDefinition: [
+        freshdesk,
+        "categoryId",
+      ],
+    },
+    folderId: {
+      propDefinition: [
+        freshdesk,
+        "folderId",
+        (c) => ({
+          categoryId: c.categoryId,
+        }),
+      ],
+    },
+    maxResults: {
+      propDefinition: [
+        freshdesk,
+        "maxResults",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const results = await this.freshdesk.getPaginatedResources({
+      fn: this.freshdesk.listFolderArticles,
+      args: {
+        $,
+        folderId: this.folderId,
+      },
+      max: this.maxResults,
+    });
+    $.export("$summary", `Successfully listed ${results.length} solution article${results.length === 1
+      ? ""
+      : "s"}`);
+    return results;
+  },
+};

package/actions/list-solution-categories/list-solution-categories.mjs

@@ -0,0 +1,21 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-list-solution-categories",
+  name: "List Solution Categories",
+  description: "List solution categories in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#solution_category_attributes)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.listSolutionCategories({
+      $,
+    });
+    $.export("$summary", `Successfully listed ${response.length} solution category${response.length === 1
+      ? ""
+      : "s"}`);
+    return response;
+  },
+};

package/actions/list-ticket-fields/list-ticket-fields.mjs

@@ -0,0 +1,32 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-list-ticket-fields",
+  name: "List Ticket Fields",
+  description: "List all ticket fields in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#list_all_ticket_fields)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    maxResults: {
+      propDefinition: [
+        freshdesk,
+        "maxResults",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const results = await this.freshdesk.getPaginatedResources({
+      fn: this.freshdesk.listTicketFields,
+      args: {
+        $,
+      },
+      max: this.maxResults,
+    });
+
+    $.export("$summary", `Successfully listed ${results.length} ticket field${results.length === 1
+      ? ""
+      : "s"}`);
+    return results;
+  },
+};

package/actions/remove-ticket-tags/remove-ticket-tags.mjs

@@ -6,7 +6,7 @@ export default {
   name: "Remove Ticket Tags",
   description: "Remove specific tags from a ticket. [See the documentation](https://developers.freshdesk.com/api/#update_ticket)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.3",
   props: {
     freshdesk,
     ticketId: {

package/actions/set-ticket-priority/set-ticket-priority.mjs

@@ -4,7 +4,7 @@ export default {
   key: "freshdesk-set-ticket-priority",
   name: "Set Ticket Priority",
   description: "Update the priority of a ticket in Freshdesk  [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
-  version: "0.0.2",
+  version: "0.0.4",
   type: "action",
   props: {
     freshdesk,

package/actions/set-ticket-status/set-ticket-status.mjs

@@ -4,7 +4,7 @@ export default {
   key: "freshdesk-set-ticket-status",
   name: "Set Ticket Status",
   description: "Update the status of a ticket in Freshdesk  [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
-  version: "0.0.2",
+  version: "0.0.4",
   type: "action",
   props: {
     freshdesk,

package/actions/set-ticket-tags/set-ticket-tags.mjs

@@ -6,7 +6,7 @@ export default {
   name: "Set Ticket Tags",
   description: "Set tags on a ticket (replaces all existing tags). [See the documentation](https://developers.freshdesk.com/api/#update_ticket)",
   type: "action",
-  version: "0.0.1",
+  version: "0.0.3",
   props: {
     freshdesk,
     ticketId: {

package/actions/update-agent/update-agent.mjs

@@ -0,0 +1,112 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "freshdesk-update-agent",
+  name: "Update Agent",
+  description: "Update an agent in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#update_agent)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    agentId: {
+      propDefinition: [
+        freshdesk,
+        "agentId",
+      ],
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "Email address of the Agent.",
+      optional: true,
+    },
+    ticketScope: {
+      type: "integer",
+      label: "Ticket Scope",
+      description: "Ticket permission of the agent. Current logged in agent can't update his/her ticket_scope",
+      options: constants.TICKET_SCOPE,
+      optional: true,
+    },
+    occasional: {
+      type: "boolean",
+      label: "Occasional",
+      description: "Set to true if this is an occasional agent (true => occasional, false => full-time)",
+      optional: true,
+    },
+    signature: {
+      type: "string",
+      label: "Signature",
+      description: "Signature of the agent in HTML format",
+      optional: true,
+    },
+    skillIds: {
+      propDefinition: [
+        freshdesk,
+        "skillIds",
+      ],
+    },
+    groupIds: {
+      propDefinition: [
+        freshdesk,
+        "groupId",
+      ],
+      type: "string[]",
+      label: "Group IDs",
+      description: "Array of group IDs",
+      optional: true,
+    },
+    roleIds: {
+      propDefinition: [
+        freshdesk,
+        "roleIds",
+      ],
+    },
+    agentType: {
+      type: "integer",
+      label: "Agent Type",
+      description: "Type of the agent",
+      options: constants.AGENT_TYPE,
+      optional: true,
+    },
+    language: {
+      type: "string",
+      label: "Language",
+      description: "	Language of the Agent. Default language is `en`",
+      optional: true,
+    },
+    timeZone: {
+      type: "string",
+      label: "Time Zone",
+      description: "Time zone of the agent. Default value is time zone of the domain.",
+      optional: true,
+    },
+    focusMode: {
+      type: "boolean",
+      label: "Focus Mode",
+      description: "Focus mode of the agent. Default value is `true`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.updateAgent({
+      $,
+      agentId: this.agentId,
+      data: {
+        email: this.email,
+        ticket_scope: this.ticketScope,
+        occasional: this.occasional,
+        signature: this.signature,
+        skill_ids: this.skillIds,
+        group_ids: this.groupIds,
+        role_ids: this.roleIds,
+        agent_type: this.agentType,
+        language: this.language,
+        time_zone: this.timeZone,
+        focus_mode: this.focusMode,
+      },
+    });
+    $.export("$summary", `Agent ${this.email} updated successfully`);
+    return response;
+  },
+};

package/actions/update-contact/update-contact.mjs

@@ -0,0 +1,64 @@
+import freshdesk from "../../freshdesk.app.mjs";
+
+export default {
+  key: "freshdesk-update-contact",
+  name: "Update Contact",
+  description: "Update a contact in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#update_contact)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    contactId: {
+      propDefinition: [
+        freshdesk,
+        "contactId",
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the contact.",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email Address",
+      description: "Primary email address of the contact",
+      optional: true,
+    },
+    otherEmails: {
+      type: "string[]",
+      label: "Additional Email Addresses",
+      description: "One or more additional email addresses for the contact",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone Number",
+      description: "Phone number of the contact",
+      optional: true,
+    },
+    companyId: {
+      propDefinition: [
+        freshdesk,
+        "companyId",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.updateContact({
+      $,
+      contactId: this.contactId,
+      data: {
+        name: this.name,
+        email: this.email,
+        other_emails: this.otherEmails,
+        phone: this.phone,
+        company_id: this.companyId,
+      },
+    });
+    $.export("$summary", `Contact successfully updated: ${response.name}`);
+    return response;
+  },
+};

package/actions/update-solution-article/update-solution-article.mjs

@@ -0,0 +1,84 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import constants from "../../common/constants.mjs";
+import { parseObject } from "../../common/utils.mjs";
+
+export default {
+  key: "freshdesk-update-solution-article",
+  name: "Update Solution Article",
+  description: "Update a solution article in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#solution_article_attributes)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    categoryId: {
+      propDefinition: [
+        freshdesk,
+        "categoryId",
+      ],
+    },
+    folderId: {
+      propDefinition: [
+        freshdesk,
+        "folderId",
+        (c) => ({
+          categoryId: c.categoryId,
+        }),
+      ],
+    },
+    articleId: {
+      propDefinition: [
+        freshdesk,
+        "articleId",
+        (c) => ({
+          folderId: c.folderId,
+        }),
+      ],
+    },
+    title: {
+      type: "string",
+      label: "Title",
+      description: "Title of the article",
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "Description of the article",
+      optional: true,
+    },
+    status: {
+      type: "integer",
+      label: "Status",
+      description: "Status of the article",
+      options: constants.ARTICLE_STATUS,
+      optional: true,
+    },
+    seoData: {
+      type: "object",
+      label: "SEO Data",
+      description: "Meta data for search engine optimization. Allows meta_title, meta_description and meta_keywords",
+      optional: true,
+    },
+    tags: {
+      type: "string[]",
+      label: "Tags",
+      description: "Tags for the article",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.updateArticle({
+      $,
+      articleId: this.articleId,
+      data: {
+        title: this.title,
+        description: this.description,
+        status: this.status,
+        seo_data: parseObject(this.seoData),
+        tags: this.tags,
+      },
+    });
+    $.export("$summary", `Successfully updated solution article ${this.title}`);
+    return response;
+  },
+};

package/actions/update-ticket/update-ticket.mjs

@@ -5,7 +5,7 @@ export default {
   key: "freshdesk-update-ticket",
   name: "Update a Ticket",
   description: "Update status, priority, subject, description, agent, group, etc.  [See the documentation](https://developers.freshdesk.com/api/#update_ticket).",
-  version: "0.0.2",
+  version: "0.0.4",
   type: "action",
   props: {
     freshdesk,
@@ -100,7 +100,7 @@ export default {
 
     const data = removeNullEntries(fields);
 
-    const ticketName = await freshdesk.getTicketName(ticketId);
+    const ticketName = await freshdesk.getTicketName(ticketId) || "Unknown Ticket";
 
     if (!Object.keys(data).length) {
       throw new Error("Please provide at least one field to update.");
@@ -119,4 +119,3 @@ export default {
     return response;
   },
 };
-

package/actions/update-ticket-field/update-ticket-field.mjs

@@ -0,0 +1,106 @@
+import freshdesk from "../../freshdesk.app.mjs";
+import { parseObject } from "../../common/utils.mjs";
+
+export default {
+  key: "freshdesk-update-ticket-field",
+  name: "Update Ticket Field",
+  description: "Update a ticket field in Freshdesk. [See the documentation](https://developers.freshdesk.com/api/#update_ticket_field)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    freshdesk,
+    ticketFieldId: {
+      propDefinition: [
+        freshdesk,
+        "ticketFieldId",
+      ],
+    },
+    label: {
+      type: "string",
+      label: "Label",
+      description: "Display the name of the Ticket Field",
+      optional: true,
+    },
+    labelForCustomers: {
+      type: "string",
+      label: "Label for Customers",
+      description: "The label for the field as seen by customers",
+      optional: true,
+    },
+    customersCanEdit: {
+      type: "boolean",
+      label: "Customers Can Edit",
+      description: "Whether customers can edit the field",
+      optional: true,
+    },
+    displayedToCustomers: {
+      type: "boolean",
+      label: "Displayed to Customers",
+      description: "Whether the field is displayed to customers",
+      optional: true,
+    },
+    position: {
+      type: "integer",
+      label: "Position",
+      description: "The position of the fieldPosition in which the ticket field is displayed in the form. If not given, it will be displayed on top",
+      optional: true,
+    },
+    requiredForClosure: {
+      type: "boolean",
+      label: "Required for Closure",
+      description: "Set to `true` if the field is mandatory for closing the ticket",
+      optional: true,
+    },
+    requiredForAgents: {
+      type: "boolean",
+      label: "Required for Agents",
+      description: "Set to `true` if the field is mandatory for agents",
+      optional: true,
+    },
+    requiredForCustomers: {
+      type: "boolean",
+      label: "Required for Customers",
+      description: "Set to `true` if the field is mandatory for customers",
+      optional: true,
+    },
+    choices: {
+      type: "string[]",
+      label: "Choices",
+      description: "Array of key, value pairs containing the value and position of dropdown choices. Example: `[{ \"value\": \"Refund\", \"position\": 1 }, { \"value\": \"FaultyProduct\", \"position\": 2 }]`",
+      optional: true,
+    },
+    dependentFields: {
+      type: "string[]",
+      label: "Dependent Fields",
+      description: "Applicable only for dependent fields, this contains details of nested fields Example: `[{ \"label\": \"District\", \"label_for_customers\": \"District\", \"level\": 2 }, { \"label\": \"Branch\", \"label_for_customers\": \"Branch\", \"level\": 3 }]`",
+      optional: true,
+    },
+    sectionMappings: {
+      type: "string[]",
+      label: "Section Mappings",
+      description: "Applicable only if the field is part of a section. This contains the details of a section (ID, position) for which it is been a part of. Example: `[{ \"position\": 3, \"section_id\": 1 }]`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.freshdesk.updateTicketField({
+      $,
+      ticketFieldId: this.ticketFieldId,
+      data: {
+        label: this.label,
+        label_for_customers: this.labelForCustomers,
+        customers_can_edit: this.customersCanEdit,
+        displayed_to_customers: this.displayedToCustomers,
+        position: this.position,
+        required_for_closure: this.requiredForClosure,
+        required_for_agents: this.requiredForAgents,
+        required_for_customers: this.requiredForCustomers,
+        choices: parseObject(this.choices),
+        dependent_fields: parseObject(this.dependentFields),
+        section_mappings: parseObject(this.sectionMappings),
+      },
+    });
+    $.export("$summary", `Successfully updated ticket field: ${response.label}`);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -37,4 +37,42 @@ export default {
       value: 4,
     },
   ],
+  TICKET_SCOPE: [
+    {
+      label: "Global Access",
+      value: 1,
+    },
+    {
+      label: "Group Access",
+      value: 2,
+    },
+    {
+      label: "Restricted Access",
+      value: 3,
+    },
+  ],
+  AGENT_TYPE: [
+    {
+      label: "Support Agent",
+      value: 1,
+    },
+    {
+      label: "Field Agent",
+      value: 2,
+    },
+    {
+      label: "Collaborator",
+      value: 3,
+    },
+  ],
+  ARTICLE_STATUS: [
+    {
+      label: "Draft",
+      value: 1,
+    },
+    {
+      label: "Published",
+      value: 2,
+    },
+  ],
 };

package/common/utils.mjs

@@ -22,6 +22,33 @@ const removeNullEntries = (obj) =>
       : acc;
   }, {});
 
+const parseObject = (obj) => {
+  if (!obj) {
+    return undefined;
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(parseObject);
+  }
+  if (typeof obj === "object") {
+    return Object.fromEntries(Object.entries(obj).map(([
+      key,
+      value,
+    ]) => [
+      key,
+      parseObject(value),
+    ]));
+  }
+  return obj;
+};
+
 export {
   removeNullEntries,
+  parseObject,
 };