Address review

Author: verhovsky

components/servicenow/actions/create-case/create-case.mjs

@@ -3,7 +3,7 @@ import servicenow from "../../servicenow.app.mjs";
 export default {
   key: "servicenow-create-case",
   name: "Create Case",
-  description: "Creates a new case record in ServiceNow.",
+  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: {
@@ -81,9 +81,7 @@ export default {
       comment,
     } = this;
 
-    if (!description) {
-      throw new Error("Description is required.");
-    }
+    const channel = this.servicenow.buildChannel(channelName);
 
     const notes = this.servicenow.buildNotes({
       workNote,
@@ -97,14 +95,16 @@ export default {
 
     const response = await this.servicenow.createTroubleTicket({
       $,
-      ticketType: "Case",
-      name,
-      description,
-      severity,
-      status,
-      channelName,
-      notes,
-      relatedParties,
+      data: {
+        ticketType: "Case",
+        name,
+        description,
+        severity,
+        status,
+        channel,
+        notes,
+        relatedParties,
+      },
     });
 
     $.export("$summary", "Successfully created a case.");

components/servicenow/actions/create-incident/create-incident.mjs

@@ -3,7 +3,7 @@ import servicenow from "../../servicenow.app.mjs";
 export default {
   key: "servicenow-create-incident",
   name: "Create Incident",
-  description: "Creates a new incident record in ServiceNow.",
+  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: {
@@ -81,30 +81,30 @@ export default {
       comment,
     } = this;
 
-    if (!description) {
-      throw new Error("Description is required.");
-    }
-
-    const notes = this.servicenow.buildNotes({
-      workNote,
-      comment,
-    });
+    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({
       $,
-      ticketType: "Incident",
-      name,
-      description,
-      severity,
-      status,
-      channelName: contactMethod,
-      notes,
-      relatedParties,
+      data: {
+        ticketType: "Incident",
+        name,
+        description,
+        severity,
+        status,
+        channel,
+        notes,
+        relatedParties,
+      },
     });
 
     $.export("$summary", "Successfully created an incident.");

components/servicenow/servicenow.app.mjs

@@ -43,37 +43,37 @@ export default {
     channelName: {
       type: "string",
       label: "Channel Name",
-      description: "The channel that the ticket was created through.",
+      description: "The channel (`contact_type`) that the ticket was created through.",
       optional: true,
     },
     contactMethod: {
       type: "string",
-      label: "Contact Name",
-      description: "Method of contact that the ticket was created through.",
+      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.",
+      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.",
+      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.",
+      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.",
+      description: "`Sys_id` of the user related to the incident.",
       optional: true,
     },
     workNote: {
@@ -148,29 +148,8 @@ export default {
       }));
     },
     async createTroubleTicket({
-      $ = this,
-      ticketType,
-      name,
-      description,
-      severity,
-      status,
-      channelName,
-      notes,
-      relatedParties,
-      extraFields,
+      $ = this, data,
     } = {}) {
-      const data = {
-        notes,
-        relatedParties,
-        ticketType,
-        ...extraFields,
-        name,
-        description,
-        severity,
-        status,
-        channel: this.buildChannel(channelName),
-      };
-
       return axios($, {
         method: "post",
         url: `${this.baseUrl()}/api/sn_ind_tsm_sdwan/ticket/troubleTicket`,