components/gorgias_oauth/actions/create-ticket-message/create-ticket-message.mjs (5)

162-162: Fix typo in success message.

The word "Successfully" is misspelled.

-    $.export("$summary", `Succesfully created ticket message with ID: ${response.id}`);
+    $.export("$summary", `Successfully created ticket message with ID: ${response.id}`);

---

83-83: Fix typo in sent datetime description.

The word "omitted" is misspelled.

-      description: "When the message was sent. If ommited, the message will be sent by Gorgias. E.g. `2025-01-27T19:38:52.028Z`",
+      description: "When the message was sent. If omitted, the message will be sent by Gorgias. E.g. `2025-01-27T19:38:52.028Z`",

---

95-103: Add JSDoc documentation for the createMessage method.

Consider adding JSDoc documentation to improve code maintainability.

+    /**
+     * Creates a message for a ticket in Gorgias
+     * @param {Object} params - The message parameters
+     * @param {string} params.ticketId - The ID of the ticket
+     * @param {Object} params.opts - Additional options for the request
+     * @returns {Promise<Object>} The created message
+     */
     createMessage({
       ticketId, ...opts
     }) {

---

117-121: Extract attachment validation to a separate method.

Consider moving the attachment validation logic to a separate method for better organization and reusability.

+  methods: {
+    validateAttachmentParams() {
+      if ((this.attachmentUrl && !this.attachmentName)
+        || (!this.attachmentUrl && this.attachmentName)
+      ) {
+        throw new ConfigurationError("Must enter both Attachment URL and Attachment File Name");
+      }
+    },
     // ... other methods ...
   },
   async run({ $ }) {
-    if ((this.attachmentUrl && !this.attachmentName)
-      || (!this.attachmentUrl && this.attachmentName)
-    ) {
-      throw new ConfigurationError("Must enter both Attachment URL and Attachment File Name");
-    }
+    this.validateAttachmentParams();

---

133-159: Optimize the request payload construction.

A few suggestions to improve the request payload:

1. Only include source.type when it's defined
2. Simplify the attachments array construction

       data: {
         channel: this.channel,
         source: {
-          type: this.sourceType,
+          ...(this.sourceType && { type: this.sourceType }),
           from: {
             address: this.fromAddress,
           },
           to: [
             {
               address: this.toAddress,
             },
           ],
         },
         body_html: this.message,
         via: this.via,
         subject: this.subject,
         from_agent: this.fromAgent,
         sent_datetime: this.sentDatetime,
-        attachments: this.attachmentUrl && [
-          {
-            url: this.attachmentUrl,
-            name: this.attachmentName,
-            content_type: contentType,
-            size,
-          },
-        ],
+        ...(this.attachmentUrl && {
+          attachments: [{
+            url: this.attachmentUrl,
+            name: this.attachmentName,
+            content_type: contentType,
+            size,
+          }],
+        }),
       },

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro