@pipedream/topdesk 0.0.1 → 0.2.0

package/actions/update-incident/update-incident.mjs

@@ -0,0 +1,442 @@
+import app from "../../topdesk.app.mjs";
+
+export default {
+  key: "topdesk-update-incident",
+  name: "Update Incident",
+  description: "Updates an existing incident. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/patchIncident)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    app,
+    incidentId: {
+      propDefinition: [
+        app,
+        "incidentId",
+      ],
+    },
+    callerLookupId: {
+      type: "string",
+      label: "Caller Lookup ID",
+      description: "Lookup value for filling in a registered caller's contact details (UUID). Can only be set by operators.",
+      optional: true,
+      propDefinition: [
+        app,
+        "personId",
+      ],
+    },
+    briefDescription: {
+      propDefinition: [
+        app,
+        "briefDescription",
+      ],
+    },
+    request: {
+      propDefinition: [
+        app,
+        "request",
+      ],
+    },
+    action: {
+      propDefinition: [
+        app,
+        "action",
+      ],
+    },
+    actionInvisibleForCaller: {
+      propDefinition: [
+        app,
+        "actionInvisibleForCaller",
+      ],
+    },
+    categoryId: {
+      propDefinition: [
+        app,
+        "categoryId",
+      ],
+    },
+    subcategoryId: {
+      propDefinition: [
+        app,
+        "subcategoryId",
+        ({ categoryId }) => ({
+          categoryId,
+        }),
+      ],
+    },
+    callTypeId: {
+      propDefinition: [
+        app,
+        "callTypeId",
+      ],
+    },
+    callDate: {
+      type: "string",
+      label: "Call Date",
+      description: "The date when this call was registered in ISO 8601 format (e.g., `2024-08-01T12:00:00.000+0200`). Can only be set by operators.",
+      optional: true,
+    },
+    entryTypeId: {
+      propDefinition: [
+        app,
+        "entryTypeId",
+      ],
+    },
+    externalNumber: {
+      propDefinition: [
+        app,
+        "externalNumber",
+      ],
+    },
+    objectName: {
+      propDefinition: [
+        app,
+        "objectName",
+      ],
+    },
+    locationId: {
+      propDefinition: [
+        app,
+        "locationId",
+      ],
+    },
+    branchId: {
+      propDefinition: [
+        app,
+        "branchId",
+      ],
+    },
+    impact: {
+      propDefinition: [
+        app,
+        "impactId",
+      ],
+    },
+    urgency: {
+      propDefinition: [
+        app,
+        "urgencyId",
+      ],
+    },
+    priority: {
+      propDefinition: [
+        app,
+        "priorityId",
+      ],
+    },
+    duration: {
+      propDefinition: [
+        app,
+        "durationId",
+      ],
+    },
+    targetDate: {
+      propDefinition: [
+        app,
+        "targetDate",
+      ],
+    },
+    slaId: {
+      propDefinition: [
+        app,
+        "slaId",
+      ],
+    },
+    onHold: {
+      propDefinition: [
+        app,
+        "onHold",
+      ],
+    },
+    operatorId: {
+      propDefinition: [
+        app,
+        "operatorId",
+      ],
+      label: "Operator",
+      description: "The operator assigned to the incident. Can only be set by operators.",
+      optional: true,
+    },
+    operatorGroupId: {
+      propDefinition: [
+        app,
+        "operatorGroupId",
+      ],
+    },
+    supplierId: {
+      propDefinition: [
+        app,
+        "supplierId",
+      ],
+    },
+    processingStatusId: {
+      propDefinition: [
+        app,
+        "processingStatusId",
+      ],
+    },
+    responded: {
+      propDefinition: [
+        app,
+        "responded",
+      ],
+    },
+    responseDate: {
+      propDefinition: [
+        app,
+        "responseDate",
+      ],
+    },
+    completed: {
+      propDefinition: [
+        app,
+        "completed",
+      ],
+    },
+    completedDate: {
+      propDefinition: [
+        app,
+        "completedDate",
+      ],
+    },
+    closed: {
+      propDefinition: [
+        app,
+        "closed",
+      ],
+    },
+    closedDate: {
+      propDefinition: [
+        app,
+        "closedDate",
+      ],
+    },
+    closureCodeId: {
+      propDefinition: [
+        app,
+        "closureCodeId",
+      ],
+    },
+    costs: {
+      type: "string",
+      label: "Costs",
+      description: "Costs as a decimal number. Can only be set by operators.",
+      optional: true,
+    },
+    feedbackMessage: {
+      type: "string",
+      label: "Feedback Message",
+      description: "Feedback message from the caller",
+      optional: true,
+    },
+    feedbackRating: {
+      type: "integer",
+      label: "Feedback Rating",
+      description: "Feedback rating (1-5). Can be set by persons.",
+      optional: true,
+      min: 1,
+      max: 5,
+    },
+    majorCall: {
+      propDefinition: [
+        app,
+        "majorCall",
+      ],
+    },
+    majorCallObject: {
+      type: "object",
+      label: "Major Call Object",
+      description: "Major call details as a JSON object. Can only be set by operators.",
+      optional: true,
+    },
+    publishToSsd: {
+      propDefinition: [
+        app,
+        "publishToSsd",
+      ],
+    },
+    optionalFields1: {
+      propDefinition: [
+        app,
+        "optionalFields1",
+      ],
+    },
+    optionalFields2: {
+      propDefinition: [
+        app,
+        "optionalFields2",
+      ],
+    },
+  },
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+    idempotentHint: false,
+  },
+  async run({ $ }) {
+    const {
+      app,
+      incidentId,
+      callerLookupId,
+      briefDescription,
+      request,
+      action,
+      actionInvisibleForCaller,
+      categoryId,
+      subcategoryId,
+      callTypeId,
+      callDate,
+      entryTypeId,
+      externalNumber,
+      objectName,
+      locationId,
+      branchId,
+      impact,
+      urgency,
+      priority,
+      duration,
+      targetDate,
+      slaId,
+      onHold,
+      operatorId,
+      operatorGroupId,
+      supplierId,
+      processingStatusId,
+      responded,
+      responseDate,
+      completed,
+      completedDate,
+      closed,
+      closedDate,
+      closureCodeId,
+      costs,
+      feedbackMessage,
+      feedbackRating,
+      majorCall,
+      majorCallObject,
+      publishToSsd,
+      optionalFields1,
+      optionalFields2,
+    } = this;
+
+    // Fields that take { id: value } structure
+    const idFields = [
+      {
+        value: callerLookupId,
+        key: "callerLookup",
+      },
+      {
+        value: categoryId,
+        key: "category",
+      },
+      {
+        value: subcategoryId,
+        key: "subcategory",
+      },
+      {
+        value: callTypeId,
+        key: "callType",
+      },
+      {
+        value: entryTypeId,
+        key: "entryType",
+      },
+      {
+        value: locationId,
+        key: "location",
+      },
+      {
+        value: branchId,
+        key: "branch",
+      },
+      {
+        value: impact,
+        key: "impact",
+      },
+      {
+        value: urgency,
+        key: "urgency",
+      },
+      {
+        value: priority,
+        key: "priority",
+      },
+      {
+        value: duration,
+        key: "duration",
+      },
+      {
+        value: slaId,
+        key: "sla",
+      },
+      {
+        value: operatorId,
+        key: "operator",
+      },
+      {
+        value: operatorGroupId,
+        key: "operatorGroup",
+      },
+      {
+        value: supplierId,
+        key: "supplier",
+      },
+      {
+        value: processingStatusId,
+        key: "processingStatus",
+      },
+      {
+        value: closureCodeId,
+        key: "closureCode",
+      },
+    ];
+
+    const response = await app.updateIncident({
+      $,
+      incidentId,
+      data: {
+        briefDescription,
+        request,
+        action,
+        actionInvisibleForCaller,
+        callDate,
+        externalNumber,
+        targetDate,
+        onHold,
+        responded,
+        responseDate,
+        completed,
+        completedDate,
+        closed,
+        closedDate,
+        costs,
+        feedbackMessage,
+        feedbackRating,
+        majorCall,
+        majorCallObject,
+        publishToSsd,
+        optionalFields1,
+        optionalFields2,
+        ...(objectName && {
+          object: {
+            name: objectName,
+          },
+        }),
+        ...idFields.reduce((acc, {
+          value, key,
+        }) => ({
+          ...acc,
+          ...value && {
+            [key]: {
+              id: value,
+            },
+          },
+        }), {}),
+      },
+    });
+
+    $.export("$summary", `Successfully updated incident with ID \`${response.id}\``);
+
+    return response;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/topdesk",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream TOPdesk Components",
   "main": "topdesk.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/sources/common/base-polling.mjs

@@ -0,0 +1,99 @@
+import topdesk from "../../topdesk.app.mjs";
+import {
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, ConfigurationError,
+} from "@pipedream/platform";
+
+export default {
+  props: {
+    topdesk,
+    db: "$.service.db",
+    timer: {
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    _getLastTs() {
+      return this.db.get("lastTs") || 0;
+    },
+    _setLastTs(lastTs) {
+      this.db.set("lastTs", lastTs);
+    },
+    _getPreviousValue() {
+      return this.db.get("previousValue");
+    },
+    _setPreviousValue(previousValue) {
+      this.db.set("previousValue", previousValue);
+    },
+    getArgs() {
+      return {};
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant() {
+      return true;
+    },
+    async getPaginatedResources(opts = {}) {
+      const results = this.topdesk.paginate(opts);
+      const items = [];
+      for await (const result of results) {
+        items.push(result);
+      }
+      return items;
+    },
+    async processEvents(max) {
+      const lastTs = this._getLastTs();
+      let maxTs = lastTs;
+
+      const resourceFn = this.getResourceFn();
+      const args = this.getArgs();
+      const tsField = this.getTsField();
+
+      const results = this.paginateResults()
+        ? await this.getPaginatedResources({
+          fn: resourceFn,
+          fnArgs: args,
+          maxResults: max,
+        })
+        : [
+          await resourceFn(args),
+        ];
+
+      if (!results.length) {
+        return;
+      }
+
+      for (const result of results.reverse()) {
+        const ts = Date.parse(result[tsField]);
+        if (ts >= lastTs) {
+          maxTs = Math.max(ts, maxTs);
+          if (this.isRelevant(result)) {
+            this.$emit(result, this.generateMeta(result));
+          }
+        }
+      }
+
+      this._setLastTs(maxTs);
+    },
+    getResourceFn() {
+      throw new ConfigurationError("getResourceFn must be implemented");
+    },
+    generateMeta() {
+      throw new ConfigurationError("generateMeta must be implemented");
+    },
+  },
+  hooks: {
+    async deploy() {
+      await this.processEvents(10);
+    },
+  },
+  async run() {
+    await this.processEvents();
+  },
+};

package/sources/incident-updated/incident-updated.mjs

@@ -0,0 +1,28 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-incident-updated",
+  name: "Incident Updated",
+  description: "Emit new event when an incident is updated. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.listIncidents;
+    },
+    paginateResults() {
+      return true;
+    },
+    generateMeta(incident) {
+      const ts = Date.parse(incident.modificationDate);
+      return {
+        id: `${incident.id}-${ts}`,
+        summary: `Incident Updated: ${incident.id}`,
+        ts,
+      };
+    },
+  },
+};

package/sources/new-incident-assignee/new-incident-assignee.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-assignee",
+  name: "New Incident Assignee",
+  description: "Emit new event when an incident is assigned to a new user. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents_id__id_)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.getIncident;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant(incident) {
+      const previousValue = this._getPreviousValue();
+      if (incident.operator?.id !== previousValue) {
+        this._setPreviousValue(incident.operator?.id);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident Assignee: ${incident.operator?.name || `ID: ${incident.operator?.id}`}`,
+        ts: Date.parse(incident.modificationDate),
+      };
+    },
+  },
+};

package/sources/new-incident-created/new-incident-created.mjs

@@ -0,0 +1,30 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-created",
+  name: "New Incident Created",
+  description: "Emit new event when a new incident is created. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.listIncidents;
+    },
+    getTsField() {
+      return "creationDate";
+    },
+    paginateResults() {
+      return true;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident: ${incident.id}`,
+        ts: Date.parse(incident.creationDate),
+      };
+    },
+  },
+};

package/sources/new-incident-group-assigned/new-incident-group-assigned.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base-polling.mjs";
+
+export default {
+  ...common,
+  key: "topdesk-new-incident-group-assigned",
+  name: "New Incident Group Assigned",
+  description: "Emit new event when an incident is assigned to a new group. [See the documentation](https://developers.topdesk.com/explorer/?page=incident#/incident/get_incidents_id__id_)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    incidentId: {
+      propDefinition: [
+        common.props.topdesk,
+        "incidentId",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceFn() {
+      return this.topdesk.getIncident;
+    },
+    getArgs() {
+      return {
+        incidentId: this.incidentId,
+      };
+    },
+    getTsField() {
+      return "modificationDate";
+    },
+    paginateResults() {
+      return false;
+    },
+    isRelevant(incident) {
+      const previousValue = this._getPreviousValue();
+      if (incident.caller.department?.id !== previousValue) {
+        this._setPreviousValue(incident.caller.department?.id);
+        return true;
+      }
+      return false;
+    },
+    generateMeta(incident) {
+      return {
+        id: incident.id,
+        summary: `New Incident Group Assigned: ${incident.caller.department?.name || `ID: ${incident.caller.department?.id}`}`,
+        ts: Date.parse(incident.modificationDate),
+      };
+    },
+  },
+};