Add conversations.member support

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.2.1.0 (2025-09-15)
+* [#151](https://github.com/MercuryTechnologies/slack-web/151)
+  Implement `conversations.member` API method.
+
 # 2.2.0.0 (2025-03-21)
 * [#145](https://github.com/MercuryTechnologies/slack-web/pull/145)
   Implement `conversations.info` API method.

slack-web.cabal

@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: slack-web
-version: 2.2.0.0
+version: 2.2.1.0
 
 build-type: Simple
 

src/Web/Slack/Conversation.hs

@@ -44,6 +44,10 @@ module Web.Slack.Conversation (
   JoinRsp (..),
   conversationsJoin,
   conversationsJoin_,
+  MembersReq (..),
+  MembersRsp (..),
+  conversationsMembers,
+  conversationsMembers_,
 ) where
 
 import Data.Aeson
@@ -475,6 +479,33 @@ data InfoRsp = InfoRsp
 
 $(deriveJSON (jsonOpts "infoRsp") ''InfoRsp)
 
+-- | @conversations.members@ request: retrieve a conversation's members.
+--
+-- <https://api.slack.com/methods/conversations.members>
+--
+-- @since 2.2.1.0
+data MembersReq = MembersReq
+  { membersReqChannel :: ConversationId
+  }
+  deriving stock (Eq, Show, Generic)
+
+$(deriveFromJSON (jsonOpts "membersReq") ''MembersReq)
+
+instance ToForm MembersReq where
+  toForm = genericToForm (formOpts "membersReq")
+
+-- | @conversation.members@ response
+--
+-- <https://api.slack.com/methods/conversations.members>
+--
+-- @since 2.2.1.0
+data MembersRsp = MembersRsp
+  { membersRspMembers :: [UserId]
+  }
+  deriving stock (Eq, Show, Generic)
+
+$(deriveFromJSON (jsonOpts "membersRsp") ''MembersRsp)
+
 -- | FIXME(jadel): move the rest of the Conversations API into here since the old "shoving all the API in one spot" is soft deprecated.
 -- @since 2.2.0.0
 type Api =
@@ -486,6 +517,10 @@ type Api =
       :> AuthProtect "token"
       :> ReqBody '[FormUrlEncoded] JoinReq
       :> Post '[JSON] (ResponseJSON JoinRsp)
+    :<|> "conversations.members"
+      :> AuthProtect "token"
+      :> ReqBody '[FormUrlEncoded] MembersReq
+      :> Post '[JSON] (ResponseJSON MembersRsp)
 
 -- | Joins a conversation.
 --
@@ -552,12 +587,15 @@ $(deriveFromJSON (jsonOpts "joinRsp") ''JoinRsp)
 -- | @since 2.2.0.0
 conversationsJoin_ :: AuthenticatedRequest (AuthProtect "token") -> JoinReq -> ClientM (ResponseJSON JoinRsp)
 
+-- | @since 2.2.1.0
+conversationsMembers_ :: AuthenticatedRequest (AuthProtect "token") -> MembersReq -> ClientM (ResponseJSON MembersRsp)
+
 -- | @since 2.2.0.0
 conversationsInfo_ ::
   AuthenticatedRequest (AuthProtect "token") ->
   InfoReq ->
   ClientM (ResponseJSON InfoRsp)
-conversationsInfo_ :<|> conversationsJoin_ = client (Proxy @Api)
+conversationsInfo_ :<|> conversationsJoin_ :<|> conversationsMembers_ = client (Proxy @Api)
 
 -- | Retrieve a conversation's metadata.
 --
@@ -584,3 +622,12 @@ conversationsJoin ::
 conversationsJoin slackConfig req = do
   let authR = mkSlackAuthenticateReq slackConfig
   run (conversationsJoin_ authR req) . slackConfigManager $ slackConfig
+
+-- | @since 2.2.1.0
+conversationsMembers ::
+  SlackConfig ->
+  MembersReq ->
+  IO (Response MembersRsp)
+conversationsMembers slackConfig req = do
+  let authR = mkSlackAuthenticateReq slackConfig
+  run (conversationsMembers_ authR req) . slackConfigManager $ slackConfig

tests/Web/Slack/ConversationSpec.hs

@@ -116,6 +116,7 @@ spec = describe "ToJSON and FromJSON for Conversation" $ do
     mapM_ (oneGoldenTestDecode @Conversation) ["shared_channel"]
     mapM_ (oneGoldenTestDecode @InfoRsp) ["general"]
     mapM_ (oneGoldenTestDecode @JoinRsp) ["test"]
+    mapM_ (oneGoldenTestDecode @MembersRsp) ["test"]
 
   it "errors accurately if no variant matches" $ do
     let badData =

tests/golden/MembersRsp/test.golden

@@ -0,0 +1,11 @@
+MembersRsp
+    { membersRspMembers =
+        [ UserId
+            { unUserId = "U023BECGF" }
+        , UserId
+            { unUserId = "U061F7AUR" }
+        , UserId
+            { unUserId = "W012A3CDE" }
+        ]
+    }
+

tests/golden/MembersRsp/test.json

@@ -0,0 +1,11 @@
+{
+    "ok": true,
+    "members": [
+        "U023BECGF",
+        "U061F7AUR",
+        "W012A3CDE"
+    ],
+    "response_metadata": {
+        "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ=="
+    }
+}