@pipedream/zendesk 0.10.1 → 0.11.0

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

@@ -5,7 +5,7 @@ export default {
   name: "Add Ticket Tags",
   description: "Add tags to a ticket (appends to existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#add-tags).",
   type: "action",
-  version: "0.0.6",
+  version: "0.0.7",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-ticket/create-ticket.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Create Ticket",
   description: "Creates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
   type: "action",
-  version: "0.1.10",
+  version: "0.1.11",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/delete-ticket/delete-ticket.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Delete Ticket",
   description: "Deletes a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
   type: "action",
-  version: "0.1.10",
+  version: "0.1.11",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/get-article/get-article.mjs

@@ -0,0 +1,43 @@
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-get-article",
+  name: "Get Article",
+  description: "Retrieves an article by its ID. [See the documentation](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#show-article).",
+  type: "action",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    zendesk,
+    locale: {
+      propDefinition: [
+        zendesk,
+        "locale",
+      ],
+      optional: true,
+    },
+    articleId: {
+      propDefinition: [
+        zendesk,
+        "articleId",
+        ({ locale }) => ({
+          locale,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const article = await this.zendesk.getArticle({
+      $,
+      locale: this.locale,
+      articleId: this.articleId,
+    });
+
+    $.export("$summary", `Successfully retrieved article ${this.articleId}`);
+    return article;
+  },
+};

package/actions/get-macro/get-macro.mjs

@@ -0,0 +1,32 @@
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-get-macro",
+  name: "Get Macro",
+  description: "Retrieves a macro by its ID. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro).",
+  type: "action",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    zendesk,
+    macroId: {
+      propDefinition: [
+        zendesk,
+        "macroId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const macro = await this.zendesk.getMacro({
+      $,
+      macroId: this.macroId,
+    });
+
+    $.export("$summary", `Successfully retrieved macro with ID ${this.macroId}`);
+    return macro;
+  },
+};

package/actions/get-ticket-info/get-ticket-info.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Get Ticket Info",
   description: "Retrieves information about a specific ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#show-ticket).",
   type: "action",
-  version: "0.0.8",
+  version: "0.0.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/get-user-info/get-user-info.mjs

@@ -4,7 +4,7 @@ export default {
   key: "zendesk-get-user-info",
   name: "Get User Info",
   description: "Retrieves information about a specific user. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/users/users/#show-user).",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-active-macros/list-active-macros.mjs

@@ -0,0 +1,77 @@
+import constants from "../../common/constants.mjs";
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-list-active-macros",
+  name: "List Active Macros",
+  description: "Lists all active shared and personal macros available to the current user. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-active-macros).",
+  type: "action",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    zendesk,
+    access: {
+      type: "string",
+      label: "Access",
+      description: "Filter macros by access. The \"agents\" value returns all personal macros for the account's agents and is only available to admins.",
+      options: constants.ACCESS_OPTIONS,
+      optional: true,
+    },
+    categoryId: {
+      propDefinition: [
+        zendesk,
+        "macroCategory",
+      ],
+      optional: true,
+    },
+    groupId: {
+      propDefinition: [
+        zendesk,
+        "groupId",
+      ],
+      optional: true,
+    },
+    include: {
+      type: "string",
+      label: "Include",
+      description: "Additional fields to include in the response",
+      options: constants.INCLUDE_OPTIONS,
+      optional: true,
+    },
+    sortBy: {
+      type: "string",
+      label: "Sort By",
+      description: "The field to sort the results by",
+      options: constants.SORT_BY_OPTIONS,
+      optional: true,
+    },
+    sortOrder: {
+      propDefinition: [
+        zendesk,
+        "sortOrder",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { macros } = await this.zendesk.listActiveMacros({
+      $,
+      params: {
+        access: this.access,
+        category: this.categoryId,
+        group_id: this.groupId,
+        include: this.include,
+        sort_by: this.sortBy,
+        sort_order: this.sortOrder,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved ${macros.length} macro${macros.length === 1
+      ? ""
+      : "s"}`);
+    return macros;
+  },
+};

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

@@ -0,0 +1,105 @@
+import { ConfigurationError } from "@pipedream/platform";
+import zendesk from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-list-articles",
+  name: "List Articles",
+  description: "Retrieves a list of articles. [See the documentation](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles).",
+  type: "action",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    zendesk,
+    locale: {
+      propDefinition: [
+        zendesk,
+        "locale",
+      ],
+      optional: true,
+    },
+    categoryId: {
+      propDefinition: [
+        zendesk,
+        "articleCategoryId",
+        ({ locale }) => ({
+          locale,
+        }),
+      ],
+      optional: true,
+    },
+    sectionId: {
+      propDefinition: [
+        zendesk,
+        "sectionId",
+        ({
+          locale, categoryId,
+        }) => ({
+          locale,
+          categoryId,
+        }),
+      ],
+      optional: true,
+    },
+    userId: {
+      propDefinition: [
+        zendesk,
+        "userId",
+      ],
+      optional: true,
+      reloadProps: true,
+    },
+    limit: {
+      propDefinition: [
+        zendesk,
+        "limit",
+      ],
+      description: "Maximum number of articles to return",
+    },
+  },
+  async additionalProps(props) {
+    props.locale.hidden = false;
+    props.categoryId.hidden = false;
+    props.sectionId.hidden = false;
+    if (this.userId) {
+      props.locale.hidden = true;
+      props.categoryId.hidden = true;
+      props.sectionId.hidden = true;
+    }
+    return {};
+  },
+  async run({ $ }) {
+    if ((this.categoryId && this.userId) || (this.sectionId && this.userId)) {
+      throw new ConfigurationError("Providing a User ID, you cannot provide a Category ID or Section ID.");
+    }
+
+    const results = this.zendesk.paginate({
+      fn: this.zendesk.listArticles,
+      args: {
+        $,
+        categoryId: this.categoryId,
+        sectionId: this.sectionId,
+        userId: this.userId,
+        locale: this.userId
+          ? null
+          : this.locale,
+      },
+      resourceKey: "articles",
+      max: this.limit,
+    });
+
+    const articles = [];
+    for await (const article of results) {
+      articles.push(article);
+    }
+
+    $.export("$summary", `Successfully retrieved ${articles.length} article${articles.length === 1
+      ? ""
+      : "s"}`);
+
+    return articles;
+  },
+};

package/actions/list-locales/list-locales.mjs

@@ -4,7 +4,7 @@ export default {
   key: "zendesk-list-locales",
   name: "List Locales",
   description: "Retrieves all locales. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/).",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-macros/list-macros.mjs

@@ -4,7 +4,7 @@ export default {
   key: "zendesk-list-macros",
   name: "List Macros",
   description: "Retrieves all macros. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macros).",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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

@@ -4,7 +4,7 @@ export default {
   key: "zendesk-list-ticket-comments",
   name: "List Ticket Comments",
   description: "Retrieves all comments for a specific ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#list-comments).",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/list-tickets/list-tickets.mjs

@@ -5,7 +5,7 @@ export default {
   name: "List Tickets",
   description: "Retrieves a list of tickets. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#list-tickets).",
   type: "action",
-  version: "0.0.8",
+  version: "0.0.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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

@@ -5,7 +5,7 @@ export default {
   name: "Remove Ticket Tags",
   description: "Remove specific tags from a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#remove-tags).",
   type: "action",
-  version: "0.0.6",
+  version: "0.0.7",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/search-tickets/search-tickets.mjs

@@ -5,7 +5,7 @@ export default {
   name: "Search Tickets",
   description: "Searches for tickets using Zendesk's search API. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#search-tickets).",
   type: "action",
-  version: "0.0.9",
+  version: "0.0.10",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/set-custom-ticket-fields/set-custom-ticket-fields.mjs

@@ -1,13 +1,13 @@
-import app from "../../zendesk.app.mjs";
-import { parseObject } from "../../common/utils.mjs";
 import { ConfigurationError } from "@pipedream/platform";
+import { parseObject } from "../../common/utils.mjs";
+import app from "../../zendesk.app.mjs";
 
 export default {
   key: "zendesk-set-custom-ticket-fields",
   name: "Set Custom Ticket Fields",
   description: "Sets one or more custom field values on a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
   type: "action",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

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

@@ -5,7 +5,7 @@ export default {
   name: "Set Ticket Tags",
   description: "Set tags on a ticket (replaces all existing tags). [See the documentation](https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/#set-tags).",
   type: "action",
-  version: "0.0.6",
+  version: "0.0.7",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

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

@@ -5,7 +5,7 @@ export default {
   name: "Update Ticket",
   description: "Updates a ticket. [See the documentation](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
   type: "action",
-  version: "0.2.3",
+  version: "0.2.4",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/common/constants.mjs

@@ -235,6 +235,44 @@ const SORT_BY_OPTIONS = [
   "updated_at",
 ];
 
+const ACCESS_OPTIONS = [
+  "personal",
+  "agents",
+  "shared",
+  "account",
+];
+
+const INCLUDE_OPTIONS = [
+  {
+    label: "The app installation that requires each macro, if present",
+    value: "app_installation",
+  },
+  {
+    label: "The macro categories",
+    value: "categories",
+  },
+  {
+    label: "The permissions for each macro",
+    value: "permissions",
+  },
+  {
+    label: "The number of times each macro has been used in the past hour",
+    value: "usage_1h",
+  },
+  {
+    label: "The number of times each macro has been used in the past day",
+    value: "usage_24h",
+  },
+  {
+    label: "The number of times each macro has been used in the past week",
+    value: "usage_7d",
+  },
+  {
+    label: "The number of times each macro has been used in the past thirty days",
+    value: "usage_30d",
+  },
+];
+
 export default {
   SUBDOMAIN_PLACEHOLDER,
   BASE_URL,
@@ -256,4 +294,6 @@ export default {
   TICKET_STATUS_OPTIONS,
   TICKET_FIELD_OPTIONS,
   SORT_BY_OPTIONS,
+  ACCESS_OPTIONS,
+  INCLUDE_OPTIONS,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/zendesk",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "Pipedream Zendesk Components",
   "main": "zendesk.app.mjs",
   "keywords": [
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.1.0",
+    "@pipedream/platform": "^3.1.1",
     "path": "^0.12.7"
   }
 }

package/sources/locale-updated/locale-updated.mjs

@@ -6,7 +6,7 @@ export default {
   name: "Locale Updated",
   type: "source",
   description: "Emit new event when a locale has been updated",
-  version: "0.0.4",
+  version: "0.0.5",
   dedupe: "unique",
   async run() {
     const lastTs = this._getLastTs();

package/sources/new-ticket/new-ticket.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-new-ticket",
   type: "source",
   description: "Emit new event when a ticket is created",
-  version: "0.2.9",
+  version: "0.2.10",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/new-ticket-comment-added/new-ticket-comment-added.mjs

@@ -7,7 +7,7 @@ export default {
   key: "zendesk-new-ticket-comment-added",
   type: "source",
   description: "Emit new event when a ticket comment has been added",
-  version: "0.1.1",
+  version: "0.1.2",
   dedupe: "unique",
   props: {
     app,

package/sources/ticket-added-to-view/ticket-added-to-view.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zendesk-ticket-added-to-view",
   name: "New Ticket Added to View (Instant)",
   description: "Emit new event when a ticket is added to the specified view",
-  version: "0.0.9",
+  version: "0.0.10",
   type: "source",
   dedupe: "unique",
   props: {

package/sources/ticket-closed/ticket-closed.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-closed",
   type: "source",
   description: "Emit new event when a ticket has changed to closed status",
-  version: "0.2.9",
+  version: "0.2.10",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/ticket-pended/ticket-pended.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-pended",
   type: "source",
   description: "Emit new event when a ticket has changed to pending status",
-  version: "0.2.9",
+  version: "0.2.10",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/ticket-solved/ticket-solved.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-solved",
   type: "source",
   description: "Emit new event when a ticket has changed to solved status",
-  version: "0.2.9",
+  version: "0.2.10",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/sources/ticket-updated/ticket-updated.mjs

@@ -6,7 +6,7 @@ export default {
   key: "zendesk-ticket-updated",
   type: "source",
   description: "Emit new event when a ticket has been updated",
-  version: "0.2.9",
+  version: "0.2.10",
   dedupe: "unique",
   methods: {
     ...common.methods,

package/zendesk.app.mjs

@@ -1,7 +1,8 @@
-import { axios } from "@pipedream/platform";
-import constants from "./common/constants.mjs";
-import { getFileStreamAndMetadata } from "@pipedream/platform";
+import {
+  axios, getFileStreamAndMetadata,
+} from "@pipedream/platform";
 import path from "path";
+import constants from "./common/constants.mjs";
 
 export default {
   type: "app",
@@ -194,6 +195,134 @@ export default {
         return fields;
       },
     },
+    locale: {
+      type: "string",
+      label: "Locale",
+      description: "The locale of the article",
+      async options() {
+        const { locales } = await this.listLocales();
+        return locales.map((locale) => locale.locale);
+      },
+    },
+    articleCategoryId: {
+      type: "string",
+      label: "Article Category ID",
+      description: "The ID of the article category",
+      async options({
+        locale, prevContext,
+      }) {
+        const { afterCursor } = prevContext;
+        const {
+          categories, meta,
+        } = await this.listArticleCategories({
+          locale,
+          params: {
+            [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+            [constants.PAGE_AFTER_PARAM]: afterCursor,
+          },
+        });
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: categories.map(({
+            id: value, name: label,
+          }) => ({
+            value,
+            label,
+          })),
+        };
+      },
+    },
+    sectionId: {
+      type: "string",
+      label: "Section ID",
+      description: "The ID of the section",
+      async options({
+        locale, categoryId, prevContext,
+      }) {
+        const { afterCursor } = prevContext;
+        const {
+          sections, meta,
+        } = await this.listSections({
+          locale,
+          categoryId,
+          params: {
+            [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+            [constants.PAGE_AFTER_PARAM]: afterCursor,
+          },
+        });
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: sections.map(({
+            id: value, name: label,
+          }) => ({
+            value,
+            label,
+          })),
+        };
+      },
+    },
+    articleId: {
+      type: "string",
+      label: "Article ID",
+      description: "The ID of the article. You can use the List Articles action to get the ID of the article.",
+      async options({
+        locale, prevContext,
+      }) {
+        const { afterCursor } = prevContext;
+        const {
+          articles, meta,
+        } = await this.listArticles({
+          locale,
+          params: {
+            [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+            [constants.PAGE_AFTER_PARAM]: afterCursor,
+          },
+        });
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: articles.map(({
+            id: value, name: label,
+          }) => ({
+            value,
+            label,
+          })),
+        };
+      },
+    },
+    macroId: {
+      type: "string",
+      label: "Macro ID",
+      description: "The ID of the macro",
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+        const {
+          macros, meta,
+        } = await this.listMacros({
+          params: {
+            [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+            [constants.PAGE_AFTER_PARAM]: afterCursor,
+          },
+        });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: macros.map(({
+            id: value, title: label,
+          }) => ({
+            value,
+            label,
+          })),
+        };
+      },
+    },
     ticketCommentBody: {
       type: "string",
       label: "Comment body",
@@ -336,13 +465,12 @@ export default {
     makeRequest({
       step = this, url, path, headers, customSubdomain, ...args
     }) {
-      const config = {
+      return axios(step, {
         headers: this.getHeaders(headers),
         url: url ?? this.getUrl(path, customSubdomain),
         timeout: constants.DEFAULT_TIMEOUT,
         ...args,
-      };
-      return axios(step, config);
+      });
     },
     getTicketInfo({
       ticketId, ...args
@@ -530,6 +658,12 @@ export default {
         ...args,
       });
     },
+    listActiveMacros(args = {}) {
+      return this.makeRequest({
+        path: "/macros/active",
+        ...args,
+      });
+    },
     listMacroCategories(args = {}) {
       return this.makeRequest({
         path: "/macros/categories",
@@ -542,6 +676,78 @@ export default {
         ...args,
       });
     },
+    prepareLocalePath({
+      locale = null, path,
+    }) {
+      return `/help_center${locale
+        ? `/${locale}`
+        : ""}${path}`;
+    },
+    listArticleCategories({
+      locale, ...args
+    } = {}) {
+      return this.makeRequest({
+        path: this.prepareLocalePath({
+          locale,
+          path: "/categories",
+        }),
+        ...args,
+      });
+    },
+    listSections({
+      locale, categoryId, ...args
+    } = {}) {
+      return this.makeRequest({
+        path: this.prepareLocalePath({
+          locale,
+          path: `/${categoryId
+            ? `/categories/${categoryId}`
+            : ""}/sections`,
+        }),
+        ...args,
+      });
+    },
+    listArticles({
+      locale, categoryId, sectionId, userId, ...args
+    } = {}) {
+      let path = "";
+      if (categoryId) {
+        path = `/categories/${categoryId}`;
+      }
+      if (sectionId) {
+        path = `/sections/${sectionId}`;
+      }
+      if (userId) {
+        path = `/users/${userId}`;
+      }
+
+      return this.makeRequest({
+        path: this.prepareLocalePath({
+          locale,
+          path: `${path}/articles`,
+        }),
+        ...args,
+      });
+    },
+    getArticle({
+      articleId, locale, ...args
+    } = {}) {
+      return this.makeRequest({
+        path: this.prepareLocalePath({
+          locale,
+          path: `/articles/${articleId}`,
+        }),
+        ...args,
+      });
+    },
+    getMacro({
+      macroId, ...args
+    }) {
+      return this.makeRequest({
+        path: `/macros/${macroId}`,
+        ...args,
+      });
+    },
     async *paginate({
       fn, args, resourceKey, max,
     }) {