@pipedream/servicenow 0.6.0 → 0.7.0

package/README.md

@@ -31,13 +31,14 @@ First, sign into your [ServiceNow Developer Portal](https://developer.servicenow
 ### Create the OAuth Validator app
 
 1. Copy the client ID and secret from the `Pipedream` app you created above.
-2. Name this app `Pipedream OAuth Validator` and add the previously copied client ID and secret. 
-3. Set the grant type to **Authorization Code** and the **Token URL** to `oauth_token.do`.
-4. Use the same **Redirect URL** as before.
+2. Go back to the **System OAuth > Application Registry > New** and select **Connect to an OAuth Provider (simplified)**
+3. Name this app `Pipedream OAuth Validator` and add the previously copied client ID and secret. 
+4. Set the grant type to **Authorization Code** and the **Token URL** to `oauth_token.do`.
+5. Use the same **Redirect URL** as before.
 
-5. Visit [Pipedream's account page](https://pipedream.com/accounts), and click **Click Here to Connect An App**. Search for **ServiceNow** and select it. Enter the client ID, client secret, and your instance name (e.g., `dev98042` from `https://dev98042.service-now.com/`).
+6. Visit [Pipedream's account page](https://pipedream.com/accounts), and click **Click Here to Connect An App**. Search for **ServiceNow** and select it. Enter the client ID, client secret, and your instance name (e.g., `dev98042` from `https://dev98042.service-now.com/`).
 
-6. Press **Connect**. A new window will prompt you to login to your ServiceNow instance, authorizing Pipedream's access to the ServiceNow REST API.
+7. Press **Connect**. A new window will prompt you to login to your ServiceNow instance, authorizing Pipedream's access to the ServiceNow REST API.
 
 ## ServiceNow Authorization Reference
 

package/actions/create-case/create-case.mjs

@@ -0,0 +1,114 @@
+import servicenow from "../../servicenow.app.mjs";
+
+export default {
+  key: "servicenow-create-case",
+  name: "Create Case",
+  description: "Creates a new case record in ServiceNow. [See the docs here](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/trouble-ticket-open-api.html#title_trouble-ticket-POST-ticket-tt).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    servicenow,
+    name: {
+      propDefinition: [
+        servicenow,
+        "name",
+      ],
+    },
+    description: {
+      propDefinition: [
+        servicenow,
+        "description",
+      ],
+    },
+    severity: {
+      propDefinition: [
+        servicenow,
+        "caseSeverity",
+      ],
+    },
+    status: {
+      propDefinition: [
+        servicenow,
+        "status",
+      ],
+    },
+    channelName: {
+      propDefinition: [
+        servicenow,
+        "channelName",
+      ],
+    },
+    accountId: {
+      propDefinition: [
+        servicenow,
+        "accountId",
+      ],
+    },
+    contactId: {
+      propDefinition: [
+        servicenow,
+        "contactId",
+      ],
+    },
+    workNote: {
+      propDefinition: [
+        servicenow,
+        "workNote",
+      ],
+    },
+    comment: {
+      propDefinition: [
+        servicenow,
+        "comment",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      description,
+      severity,
+      status,
+      channelName,
+      accountId,
+      contactId,
+      workNote,
+      comment,
+    } = this;
+
+    const channel = this.servicenow.buildChannel(channelName);
+
+    const notes = this.servicenow.buildNotes({
+      workNote,
+      comment,
+    });
+
+    const relatedParties = this.servicenow.buildRelatedParties({
+      customer: accountId,
+      customer_contact: contactId,
+    });
+
+    const response = await this.servicenow.createTroubleTicket({
+      $,
+      data: {
+        ticketType: "Case",
+        name,
+        description,
+        severity,
+        status,
+        channel,
+        notes,
+        relatedParties,
+      },
+    });
+
+    $.export("$summary", "Successfully created a case.");
+
+    return response;
+  },
+};

package/actions/create-incident/create-incident.mjs

@@ -0,0 +1,114 @@
+import servicenow from "../../servicenow.app.mjs";
+
+export default {
+  key: "servicenow-create-incident",
+  name: "Create Incident",
+  description: "Creates a new incident record in ServiceNow. [See the docs here](https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/concept/trouble-ticket-open-api.html#title_trouble-ticket-POST-ticket-tt).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    servicenow,
+    name: {
+      propDefinition: [
+        servicenow,
+        "name",
+      ],
+    },
+    description: {
+      propDefinition: [
+        servicenow,
+        "description",
+      ],
+    },
+    severity: {
+      propDefinition: [
+        servicenow,
+        "incidentSeverity",
+      ],
+    },
+    status: {
+      propDefinition: [
+        servicenow,
+        "status",
+      ],
+    },
+    contactMethod: {
+      propDefinition: [
+        servicenow,
+        "contactMethod",
+      ],
+    },
+    companyId: {
+      propDefinition: [
+        servicenow,
+        "companyId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        servicenow,
+        "userId",
+      ],
+    },
+    workNote: {
+      propDefinition: [
+        servicenow,
+        "workNote",
+      ],
+    },
+    comment: {
+      propDefinition: [
+        servicenow,
+        "comment",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      name,
+      description,
+      severity,
+      status,
+      contactMethod,
+      companyId,
+      userId,
+      workNote,
+      comment,
+    } = this;
+
+    const channel = this.servicenow.buildChannel(contactMethod);
+
+    const relatedParties = this.servicenow.buildRelatedParties({
+      customer: companyId,
+      customer_contact: userId,
+    });
+
+    const notes = this.servicenow.buildNotes({
+      workNote,
+      comment,
+    });
+
+    const response = await this.servicenow.createTroubleTicket({
+      $,
+      data: {
+        ticketType: "Incident",
+        name,
+        description,
+        severity,
+        status,
+        channel,
+        notes,
+        relatedParties,
+      },
+    });
+
+    $.export("$summary", "Successfully created an incident.");
+
+    return response;
+  },
+};

package/actions/create-table-record/create-table-record.mjs

@@ -5,7 +5,12 @@ export default {
   key: "servicenow-create-table-record",
   name: "Create Table Record",
   description: "Inserts one record in the specified table.",
-  version: "0.1.1",
+  version: "0.1.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     servicenow: {

package/actions/get-table-record-by-sysid/get-table-record-by-sysid.mjs

@@ -5,7 +5,12 @@ export default {
   key: "servicenow-get-table-record-by-sysid",
   name: "Get Table Record By SysId",
   description: "Retrieves the record identified by the specified sys_id from the specified table.",
-  version: "0.3.1",
+  version: "0.3.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     servicenow: {

package/actions/get-table-records/get-table-records.mjs

@@ -5,7 +5,12 @@ export default {
   key: "servicenow-get-table-records",
   name: "Get Table Records",
   description: "Retrieves multiple records for the specified table.",
-  version: "0.3.1",
+  version: "0.3.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
   type: "action",
   props: {
     servicenow: {

package/actions/update-table-record/update-table-record.mjs

@@ -5,7 +5,12 @@ export default {
   key: "servicenow-update-table-record",
   name: "Update Table Record",
   description: "Updates the specified record with the name-value pairs included in the request body.",
-  version: "0.1.1",
+  version: "0.1.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
     servicenow: {

package/common/constants.mjs

@@ -0,0 +1,31 @@
+const DEFAULT_SEVERITY_OPTIONS = [
+  {
+    label: "Critical",
+    value: "1",
+  },
+  {
+    label: "High",
+    value: "2",
+  },
+  {
+    label: "Moderate",
+    value: "3",
+  },
+  {
+    label: "Low",
+    value: "4",
+  },
+];
+
+const INCIDENT_SEVERITY_OPTIONS = [
+  ...DEFAULT_SEVERITY_OPTIONS,
+  {
+    label: "Planning",
+    value: "5",
+  },
+];
+
+export default {
+  DEFAULT_SEVERITY_OPTIONS,
+  INCIDENT_SEVERITY_OPTIONS,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/servicenow",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Pipedream servicenow Components",
   "main": "servicenow.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.0"
+    "@pipedream/platform": "^3.1.0"
   }
 }

package/servicenow.app.mjs

@@ -1,11 +1,161 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+const {
+  DEFAULT_SEVERITY_OPTIONS,
+  INCIDENT_SEVERITY_OPTIONS,
+} = constants;
+
 export default {
   type: "app",
   app: "servicenow",
-  propDefinitions: {},
+  propDefinitions: {
+    name: {
+      type: "string",
+      label: "Name",
+      description: "A short description of the ticket issue.",
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "A detailed description of the issue.",
+    },
+    caseSeverity: {
+      type: "string",
+      label: "Severity",
+      description: "The priority/severity of the case.",
+      options: DEFAULT_SEVERITY_OPTIONS,
+    },
+    incidentSeverity: {
+      type: "string",
+      label: "Severity",
+      description: "The priority/severity of the incident.",
+      options: INCIDENT_SEVERITY_OPTIONS,
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "The current status of the ticket.",
+      optional: true,
+      default: "New",
+    },
+    channelName: {
+      type: "string",
+      label: "Channel Name",
+      description: "The channel (`contact_type`) that the ticket was created through.",
+      optional: true,
+    },
+    contactMethod: {
+      type: "string",
+      label: "Contact Method",
+      description: "Name of the contact method (`contact_type`) that the ticket was created through.",
+      optional: true,
+    },
+    accountId: {
+      type: "string",
+      label: "Account ID",
+      description: "`Sys_id` of the account related to the case.",
+      optional: true,
+    },
+    contactId: {
+      type: "string",
+      label: "Contact ID",
+      description: "`Sys_id` of the contact related to the case.",
+      optional: true,
+    },
+    companyId: {
+      type: "string",
+      label: "Company ID",
+      description: "`Sys_id` of the company related to the incident.",
+      optional: true,
+    },
+    userId: {
+      type: "string",
+      label: "User ID",
+      description: "`Sys_id` of the user related to the incident.",
+      optional: true,
+    },
+    workNote: {
+      type: "string",
+      label: "Work Note",
+      description: "Internal work note for the ticket.",
+      optional: true,
+    },
+    comment: {
+      type: "string",
+      label: "Comment",
+      description: "Additional comment for the ticket.",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    baseUrl() {
+      const { instance_name: instanceName } = this.$auth;
+      return `https://${instanceName}.service-now.com`;
+    },
+    authHeaders() {
+      const { oauth_access_token: oauthAccessToken } = this.$auth;
+      return {
+        "Authorization": `Bearer ${oauthAccessToken}`,
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+      };
+    },
+    buildChannel(name) {
+      if (!name) {
+        return;
+      }
+      return {
+        name,
+      };
+    },
+    buildNotes({
+      workNote,
+      comment,
+    } = {}) {
+      const notes = [];
+      if (workNote) {
+        notes.push({
+          "text": workNote,
+          "@type": "work_notes",
+        });
+      }
+      if (comment) {
+        notes.push({
+          "text": comment,
+          "@type": "comments",
+        });
+      }
+      return notes.length
+        ? notes
+        : undefined;
+    },
+    buildRelatedParties(partyTypeToId = {}) {
+      const entries = Object.entries(partyTypeToId)
+        .filter(([
+          , id,
+        ]) => id);
+      if (!entries.length) {
+        return;
+      }
+      return entries.map(([
+        type,
+        id,
+      ]) => ({
+        id,
+        "@referredType": type,
+      }));
+    },
+    async createTroubleTicket({
+      $ = this, data,
+    } = {}) {
+      return axios($, {
+        method: "post",
+        url: `${this.baseUrl()}/api/sn_ind_tsm_sdwan/ticket/troubleTicket`,
+        headers: this.authHeaders(),
+        data,
+      });
     },
   },
 };