18952 action expand messaging functionality for dixa (#18975)

* Enhance Dixa component with new actions and version updates

- Added `getArticle` and `getArticleTranslations` actions to retrieve articles and their translations from Dixa.
- Updated version numbers for existing actions to 0.0.3.
- Incremented package version to 0.2.0 and updated dependency for `@pipedream/platform` to ^3.1.0.
- Updated source components' versions to 0.0.2 for consistency.

* pnpm update

* Enhance Dixa component with new messaging functionalities and version updates

- Added new actions: listMessages, listNotes, createNote, getConversation, claimConversation, and closeConversation to manage conversations effectively.
- Introduced new action files for claimConversation and closeConversation.
- Updated existing action versions for add-message, create-conversation, and set-custom-contact-attributes.
- Bumped package version to 0.3.0 for the Dixa component.

* pnpm update

* Add close conversation action for Dixa

- Introduced a new action `dixa-close-conversation` to mark conversations as closed by providing the conversation ID.
- Added props for `endUserId`, `conversationId`, and an optional `agentId` to facilitate the action.
- Included documentation link for reference.

* Update components/dixa/actions/claim-conversation/claim-conversation.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update components/dixa/actions/get-conversation/get-conversation.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update components/dixa/actions/list-messages/list-messages.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update components/dixa/actions/list-notes/list-notes.mjs

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: luancazarine

components/dixa/actions/add-message/add-message.mjs

@@ -4,7 +4,7 @@ export default {
   key: "dixa-add-message",
   name: "Add Message to Conversation",
   description: "Adds a message to an existing conversation. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/postConversationsConversationidMessages).",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

components/dixa/actions/claim-conversation/claim-conversation.mjs

@@ -0,0 +1,58 @@
+import dixa from "../../dixa.app.mjs";
+
+export default {
+  key: "dixa-claim-conversation",
+  name: "Claim Conversation",
+  description: "Claims a conversation for a given agent. To avoid taking over assigned conversations, set the force parameter to false. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/putConversationsConversationidClaim)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    dixa,
+    endUserId: {
+      propDefinition: [
+        dixa,
+        "endUserId",
+      ],
+    },
+    conversationId: {
+      propDefinition: [
+        dixa,
+        "conversationId",
+        ({ endUserId }) => ({
+          endUserId,
+        }),
+      ],
+    },
+    agentId: {
+      propDefinition: [
+        dixa,
+        "agentId",
+      ],
+      hidden: false,
+      description: "The ID of the agent who is claiming the conversation.",
+    },
+    force: {
+      type: "boolean",
+      label: "Force",
+      description: "Set as false to avoid taking over the conversation if it is already assigned to an agent.",
+      default: false,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.dixa.claimConversation({
+      $,
+      conversationId: this.conversationId,
+      data: {
+        agentId: this.agentId,
+        force: this.force,
+      },
+    });
+    $.export("$summary", `Successfully claimed conversation ${this.conversationId} for agent ${this.agentId}`);
+    return response;
+  },
+};

components/dixa/actions/close-conversation/close-conversation.mjs

@@ -0,0 +1,52 @@
+import dixa from "../../dixa.app.mjs";
+
+export default {
+  key: "dixa-close-conversation",
+  name: "Close Conversation",
+  description: "Mark a conversation as closed by providing its id. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/putConversationsConversationidClose)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    dixa,
+    endUserId: {
+      propDefinition: [
+        dixa,
+        "endUserId",
+      ],
+    },
+    conversationId: {
+      propDefinition: [
+        dixa,
+        "conversationId",
+        ({ endUserId }) => ({
+          endUserId,
+        }),
+      ],
+    },
+    agentId: {
+      propDefinition: [
+        dixa,
+        "agentId",
+      ],
+      hidden: false,
+      description: "An optional agent/admin to close the conversation.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.dixa.closeConversation({
+      $,
+      conversationId: this.conversationId,
+      data: {
+        agentId: this.agentId,
+      },
+    });
+    $.export("$summary", `Successfully closed conversation ${this.conversationId}`);
+    return response;
+  },
+};

components/dixa/actions/create-conversation/create-conversation.mjs

@@ -4,7 +4,7 @@ export default {
   key: "dixa-create-conversation",
   name: "Create Conversation",
   description: "Creates a new email or contact form-based conversation. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/postConversations).",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

components/dixa/actions/create-note/create-note.mjs

@@ -0,0 +1,48 @@
+import dixa from "../../dixa.app.mjs";
+
+export default {
+  key: "dixa-create-note",
+  name: "Create Note",
+  description: "Creates an internal note for a conversation. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/postConversationsConversationidNotes).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    dixa,
+    endUserId: {
+      propDefinition: [
+        dixa,
+        "endUserId",
+      ],
+    },
+    conversationId: {
+      propDefinition: [
+        dixa,
+        "conversationId",
+        ({ endUserId }) => ({
+          endUserId,
+        }),
+      ],
+    },
+    message: {
+      type: "string",
+      label: "Message",
+      description: "The message to create the note for.",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.dixa.createNote({
+      $,
+      conversationId: this.conversationId,
+      data: {
+        message: this.message,
+      },
+    });
+    $.export("$summary", `Successfully created note with ID ${response.data.id}`);
+    return response;
+  },
+};

components/dixa/actions/get-article-translations/get-article-translations.mjs

@@ -4,7 +4,7 @@ export default {
   key: "dixa-get-article-translations",
   name: "Get Article Translations",
   description: "Get the translations of an article from Dixa. [See the documentation](https://docs.dixa.io/openapi/dixa-api/beta/tag/Knowledge/#tag/Knowledge/operation/getKnowledgeArticlesArticleidTranslations)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

components/dixa/actions/get-article/get-article.mjs

@@ -4,7 +4,7 @@ export default {
   key: "dixa-get-article",
   name: "Get Article",
   description: "Get an article from Dixa. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Knowledge/#tag/Knowledge/operation/getKnowledgeArticlesArticleid)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

components/dixa/actions/get-conversation/get-conversation.mjs

@@ -0,0 +1,40 @@
+import dixa from "../../dixa.app.mjs";
+
+export default {
+  key: "dixa-get-conversation",
+  name: "Get Conversation",
+  description: "Gets a conversation. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/getConversationsConversationid)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    dixa,
+    endUserId: {
+      propDefinition: [
+        dixa,
+        "endUserId",
+      ],
+    },
+    conversationId: {
+      propDefinition: [
+        dixa,
+        "conversationId",
+        ({ endUserId }) => ({
+          endUserId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.dixa.getConversation({
+      $,
+      conversationId: this.conversationId,
+    });
+    $.export("$summary", `Successfully retrieved conversation ${this.conversationId}`);
+    return response;
+  },
+};

components/dixa/actions/list-messages/list-messages.mjs

@@ -0,0 +1,40 @@
+import dixa from "../../dixa.app.mjs";
+
+export default {
+  key: "dixa-list-messages",
+  name: "List Messages",
+  description: "Lists messages from a conversation. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/getConversationsConversationidMessages).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    dixa,
+    endUserId: {
+      propDefinition: [
+        dixa,
+        "endUserId",
+      ],
+    },
+    conversationId: {
+      propDefinition: [
+        dixa,
+        "conversationId",
+        ({ endUserId }) => ({
+          endUserId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.dixa.listMessages({
+      $,
+      conversationId: this.conversationId,
+    });
+    $.export("$summary", `Successfully retrieved ${response.data.length} message(s) from conversation ${this.conversationId}`);
+    return response;
+  },
+};

components/dixa/actions/list-notes/list-notes.mjs

@@ -0,0 +1,40 @@
+import dixa from "../../dixa.app.mjs";
+
+export default {
+  key: "dixa-list-notes",
+  name: "List Notes",
+  description: "Lists internal notes from a conversation. [See the documentation](https://docs.dixa.io/openapi/dixa-api/v1/tag/Conversations/#tag/Conversations/operation/getConversationsConversationidNotes).",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    dixa,
+    endUserId: {
+      propDefinition: [
+        dixa,
+        "endUserId",
+      ],
+    },
+    conversationId: {
+      propDefinition: [
+        dixa,
+        "conversationId",
+        ({ endUserId }) => ({
+          endUserId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.dixa.listNotes({
+      $,
+      conversationId: this.conversationId,
+    });
+    $.export("$summary", `Successfully retrieved ${response.data.length} note(s) from conversation ${this.conversationId}`);
+    return response;
+  },
+};