@pipedream/zendesk 0.3.4 → 0.4.0

package/LICENSE

@@ -1,7 +1,41 @@
-Copyright 2020 Pipedream, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

package/README.md

@@ -0,0 +1,19 @@
+# Overview
+
+Using the Zendesk API, you can build custom apps and integrations to automate
+processes and help your teams build better customer relationships.
+
+The API provides a range of methods to interact with your customer help desk,
+customer data, and customer communication tools. This enables you to create
+custom customer experiences that are tailored to your business needs.
+
+Some examples of what you can build using the Zendesk API include:
+
+- Create a custom customer feedback widget
+- Automate customer service processes
+- Identify customer trends and insights
+- Help manage customer data in real-time
+- Create a custom customer profile and segmentation tool
+- Trigger automated messages based on customer events
+- Integrate customer service processes with your company’s backend system
+- Create a custom customer self-service portal

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

@@ -0,0 +1,70 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-create-ticket",
+  name: "Create Ticket",
+  description: "Creates a ticket. [See the docs](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-ticket).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    ticketCommentBody: {
+      propDefinition: [
+        app,
+        "ticketCommentBody",
+      ],
+    },
+    ticketPriority: {
+      propDefinition: [
+        app,
+        "ticketPriority",
+      ],
+    },
+    ticketSubject: {
+      propDefinition: [
+        app,
+        "ticketSubject",
+      ],
+    },
+    ticketStatus: {
+      propDefinition: [
+        app,
+        "ticketStatus",
+      ],
+    },
+  },
+  methods: {
+    createTicket(args = {}) {
+      return this.app.create({
+        path: "/tickets",
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketCommentBody,
+      ticketPriority,
+      ticketSubject,
+      ticketStatus,
+    } = this;
+
+    const response = await this.createTicket({
+      step,
+      data: {
+        ticket: {
+          comment: {
+            body: ticketCommentBody,
+          },
+          priority: ticketPriority,
+          subject: ticketSubject,
+          status: ticketStatus,
+        },
+      },
+    });
+
+    step.export("$summary", `Successfully created ticket with ID ${response.ticket.id}`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,38 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-delete-ticket",
+  name: "Delete Ticket",
+  description: "Deletes a ticket. [See the docs](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+  },
+  methods: {
+    deleteTicket({
+      ticketId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/tickets/${ticketId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    await this.deleteTicket({
+      step,
+      ticketId: this.ticketId,
+    });
+
+    step.export("$summary", "Successfully deleted ticket");
+
+    return true;
+  },
+};

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

@@ -0,0 +1,80 @@
+import app from "../../zendesk.app.mjs";
+
+export default {
+  key: "zendesk-update-ticket",
+  name: "Update Ticket",
+  description: "Updates a ticket. [See the docs](https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#update-ticket).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    ticketId: {
+      propDefinition: [
+        app,
+        "ticketId",
+      ],
+    },
+    ticketCommentBody: {
+      propDefinition: [
+        app,
+        "ticketCommentBody",
+      ],
+    },
+    ticketPriority: {
+      propDefinition: [
+        app,
+        "ticketPriority",
+      ],
+    },
+    ticketSubject: {
+      propDefinition: [
+        app,
+        "ticketSubject",
+      ],
+    },
+    ticketStatus: {
+      propDefinition: [
+        app,
+        "ticketStatus",
+      ],
+    },
+  },
+  methods: {
+    updateTicket({
+      ticketId, ...args
+    } = {}) {
+      return this.app.update({
+        path: `/tickets/${ticketId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      ticketId,
+      ticketCommentBody,
+      ticketPriority,
+      ticketSubject,
+      ticketStatus,
+    } = this;
+
+    const response = await this.updateTicket({
+      step,
+      ticketId,
+      data: {
+        ticket: {
+          comment: {
+            body: ticketCommentBody,
+          },
+          priority: ticketPriority,
+          subject: ticketSubject,
+          status: ticketStatus,
+        },
+      },
+    });
+
+    step.export("$summary", `Successfully updated ticket with ID ${response.ticket.id}`);
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -6,11 +6,30 @@ const TRIGGER_ID = "triggerId";
 const PAGE_SIZE_PARAM = "page[size]";
 const PAGE_AFTER_PARAM = "page[after]";
 const SORT_BY_POSITION_ASC = "position";
+const SORT_BY_UPDATED_AT_DESC = "-updated_at";
 const X_ZENDESK_WEBHOOK_SIGNATURE_HEADER = "x-zendesk-webhook-signature";
 const X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER = "x-zendesk-webhook-signature-timestamp";
 const SIGNING_SECRET = "signingSecret";
 const SIGNING_SECRET_ALGORITHM = "sha256";
 const BASE_64 = "base64";
+const DEFAULT_LIMIT = 20;
+const DEFAULT_TIMEOUT = 10000;
+
+const TICKET_PRIORITY_OPTIONS = {
+  URGENT: "urgent",
+  HIGH: "high",
+  NORMAL: "normal",
+  LOW: "low",
+};
+
+const TICKET_STATUS_OPTIONS = {
+  NEW: "new",
+  OPEN: "open",
+  PENDING: "pending",
+  HOLD: "hold",
+  SOLVED: "solved",
+  CLOSED: "closed",
+};
 
 export default {
   SUBDOMAIN_PLACEHOLDER,
@@ -21,9 +40,14 @@ export default {
   PAGE_SIZE_PARAM,
   PAGE_AFTER_PARAM,
   SORT_BY_POSITION_ASC,
+  SORT_BY_UPDATED_AT_DESC,
   X_ZENDESK_WEBHOOK_SIGNATURE_HEADER,
   X_ZENDESK_WEBHOOK_SIGNATURE_TIMESTAMP_HEADER,
   SIGNING_SECRET,
   SIGNING_SECRET_ALGORITHM,
   BASE_64,
+  DEFAULT_LIMIT,
+  DEFAULT_TIMEOUT,
+  TICKET_PRIORITY_OPTIONS,
+  TICKET_STATUS_OPTIONS,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/zendesk",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "Pipedream Zendesk Components",
   "main": "zendesk.app.mjs",
   "keywords": [
@@ -9,7 +9,6 @@
   ],
   "homepage": "https://pipedream.com/apps/zendesk",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "license": "MIT",
   "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
   "publishConfig": {
     "access": "public"

package/sources/common/ticket.mjs

@@ -1,4 +1,4 @@
-import common from "./base.mjs";
+import common from "./webhook.mjs";
 
 export default {
   ...common,

package/sources/common/{base.mjs → webhook.mjs}

@@ -1,15 +1,15 @@
 import crypto from "crypto";
-import zendesk from "../../zendesk.app.mjs";
+import app from "../../zendesk.app.mjs";
 import constants from "../../common/constants.mjs";
 
 export default {
   props: {
-    zendesk,
+    app,
     db: "$.service.db",
     http: "$.interface.http",
     categoryId: {
       propDefinition: [
-        zendesk,
+        app,
         "categoryId",
       ],
     },
@@ -18,21 +18,21 @@ export default {
     async activate() {
       const { categoryId } = this;
 
-      const { webhook } = await this.zendesk.createWebhook({
+      const { webhook } = await this.createWebhook({
         data: this.setupWebhookData(),
       });
 
       const { id: webhookId } = webhook;
       this.setWebhookId(webhookId);
 
-      const { signing_secret: signingSecret } = await this.zendesk.showWebhookSigningSecret({
+      const { signing_secret: signingSecret } = await this.showWebhookSigningSecret({
         webhookId,
       });
 
       const { secret } = signingSecret;
       this.setSigningSecret(secret);
 
-      const { trigger } = await this.zendesk.createTrigger({
+      const { trigger } = await this.createTrigger({
         data: this.setupTriggerData({
           webhookId,
           categoryId,
@@ -44,16 +44,52 @@ export default {
     },
     async deactivate() {
       await Promise.all([
-        this.zendesk.deleteTrigger({
+        this.deleteTrigger({
           triggerId: this.getTriggerId(),
         }),
-        this.zendesk.deleteWebhook({
+        this.deleteWebhook({
           webhookId: this.getWebhookId(),
         }),
       ]);
     },
   },
   methods: {
+    createWebhook(args = {}) {
+      return this.app.create({
+        path: "/webhooks",
+        ...args,
+      });
+    },
+    deleteWebhook({
+      webhookId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/webhooks/${webhookId}`,
+        ...args,
+      });
+    },
+    createTrigger(args = {}) {
+      return this.app.create({
+        path: "/triggers",
+        ...args,
+      });
+    },
+    deleteTrigger({
+      triggerId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/triggers/${triggerId}`,
+        ...args,
+      });
+    },
+    showWebhookSigningSecret({
+      webhookId, ...args
+    } = {}) {
+      return this.app.makeRequest({
+        path: `/webhooks/${webhookId}/signing_secret`,
+        ...args,
+      });
+    },
     setWebhookId(webhookId) {
       this.db.set(constants.WEBHOOK_ID, webhookId);
     },

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.0.2",
+  version: "0.1.0",
   dedupe: "unique",
   methods: {
     ...common.methods,

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.0.2",
+  version: "0.1.0",
   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.0.2",
+  version: "0.1.0",
   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.0.2",
+  version: "0.1.0",
   dedupe: "unique",
   methods: {
     ...common.methods,

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

@@ -0,0 +1,30 @@
+import common from "../common/ticket.mjs";
+
+export default {
+  ...common,
+  name: "Ticket Updated (Instant)",
+  key: "zendesk-ticket-updated",
+  type: "source",
+  description: "Emit new event when a ticket has been updated",
+  version: "0.1.0",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getWebhookName() {
+      return "Ticket Updated Webhook";
+    },
+    getTriggerTitle() {
+      return "Ticket Updated Trigger";
+    },
+    getTriggerConditions() {
+      return {
+        all: [
+          {
+            field: "update_type",
+            value: "Change",
+          },
+        ],
+      };
+    },
+  },
+};

package/zendesk.app.mjs

@@ -18,7 +18,7 @@ export default {
         } =
           await this.listTriggerCategories({
             params: {
-              [constants.PAGE_SIZE_PARAM]: 20,
+              [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
               sort: constants.SORT_BY_POSITION_ASC,
               [constants.PAGE_AFTER_PARAM]: afterCursor,
             },
@@ -37,102 +37,119 @@ export default {
         };
       },
     },
+    ticketId: {
+      type: "string",
+      label: "Ticket ID",
+      description: "The ID of the ticket.",
+      async options({ prevContext }) {
+        const { afterCursor } = prevContext;
+
+        const {
+          tickets,
+          meta,
+        } =
+          await this.listTickets({
+            params: {
+              [constants.PAGE_SIZE_PARAM]: constants.DEFAULT_LIMIT,
+              sort: constants.SORT_BY_UPDATED_AT_DESC,
+              [constants.PAGE_AFTER_PARAM]: afterCursor,
+            },
+          });
+
+        return {
+          context: {
+            afterCursor: meta.after_cursor,
+          },
+          options: tickets.map(({
+            id, subject,
+          }) => ({
+            label: subject || `Ticket #${id}`,
+            value: id,
+          })),
+        };
+      },
+    },
+    ticketCommentBody: {
+      type: "string",
+      label: "Comment body",
+      description: "The body of the comment.",
+    },
+    ticketPriority: {
+      type: "string",
+      label: "Ticket Priority",
+      description: "The priority of the ticket.",
+      optional: true,
+      options: Object.values(constants.TICKET_PRIORITY_OPTIONS),
+    },
+    ticketSubject: {
+      type: "string",
+      label: "Ticket Subject",
+      description: "The subject of the ticket.",
+      optional: true,
+    },
+    ticketStatus: {
+      type: "string",
+      label: "Ticket Status",
+      description: "The status of the ticket.",
+      optional: true,
+      options: Object.values(constants.TICKET_STATUS_OPTIONS),
+    },
   },
   methods: {
-    getApiUrl({
-      path, subdomain,
-    }) {
+    getUrl(path) {
       const {
         SUBDOMAIN_PLACEHOLDER,
         BASE_URL,
         VERSION_PATH,
       } = constants;
-      return `${BASE_URL.replace(SUBDOMAIN_PLACEHOLDER, subdomain)}${VERSION_PATH}${path}`;
+      const baseUrl = BASE_URL.replace(SUBDOMAIN_PLACEHOLDER, this.$auth.subdomain);
+      return `${baseUrl}${VERSION_PATH}${path}`;
     },
-    async makeRequest(customConfig) {
-      const {
-        $,
-        url,
-        path,
-        ...configProps
-      } = customConfig;
-
-      const {
-        oauth_access_token: oauthAccessToken,
-        subdomain,
-      } = this.$auth;
-
-      const headers = {
-        ...configProps?.headers,
-        authorization: `Bearer ${oauthAccessToken}`,
+    getHeaders(headers) {
+      return {
+        authorization: `Bearer ${this.$auth.oauth_access_token}`,
+        ...headers,
       };
-
+    },
+    makeRequest({
+      step = this, url, path, headers, ...args
+    }) {
       const config = {
-        ...configProps,
-        headers,
-        url: url ?? this.getApiUrl({
-          subdomain,
-          path,
-        }),
-        timeout: 10000,
+        headers: this.getHeaders(headers),
+        url: url ?? this.getUrl(path),
+        timeout: constants.DEFAULT_TIMEOUT,
+        ...args,
       };
-
-      return axios($ ?? this, config);
+      return axios(step, config);
     },
-    async createTrigger({
-      $, data,
-    }) {
+    create(args = {}) {
       return this.makeRequest({
-        $,
         method: "post",
-        path: "/triggers",
-        data,
+        ...args,
       });
     },
-    async deleteTrigger({
-      $, triggerId,
-    }) {
+    update(args = {}) {
       return this.makeRequest({
-        $,
-        method: "delete",
-        path: `/triggers/${triggerId}`,
+        method: "put",
+        ...args,
       });
     },
-    async listTriggerCategories({
-      $, url, params,
-    }) {
-      return this.makeRequest({
-        $,
-        url,
-        path: "/trigger_categories",
-        params,
-      });
-    },
-    async createWebhook({
-      $, data,
-    }) {
+    delete(args = {}) {
       return this.makeRequest({
-        $,
-        method: "post",
-        path: "/webhooks",
-        data,
+        method: "delete",
+        ...args,
       });
     },
-    async deleteWebhook({
-      $, webhookId,
-    }) {
+    listTriggerCategories(args = {}) {
       return this.makeRequest({
-        $,
-        method: "delete",
-        path: `/webhooks/${webhookId}`,
+        path: "/trigger_categories",
+        ...args,
       });
     },
-    async showWebhookSigningSecret({
-      $, webhookId,
-    }) {
+    listTickets(args = {}) {
       return this.makeRequest({
-        $,
-        path: `/webhooks/${webhookId}/signing_secret`,
+        path: "/tickets",
+        ...args,
       });
     },
   },