Add public_channel type support for admin.analytics.getFile API

Author: seratch

integration_tests/web/test_admin_analytics.py

@@ -27,13 +27,6 @@ def setUp(self):
     def tearDown(self):
         pass
 
-    def test_legacy(self):
-        client = self.legacy_client
-
-        response = client.admin_analytics_getFile(date="2020-10-20", type="member")
-        self.assertTrue(isinstance(response.data, bytes))
-        self.assertIsNotNone(response.data)
-
     def test_sync(self):
         client = self.sync_client
 
@@ -50,6 +43,24 @@ def test_sync_error(self):
             self.assertFalse(e.response["ok"])
             self.assertEqual("file_not_yet_available", e.response["error"])
 
+    def test_sync_public_channel(self):
+        client = self.sync_client
+
+        response = client.admin_analytics_getFile(
+            date="2020-10-20", type="public_channel"
+        )
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)
+
+    def test_sync_public_channel_medata_only(self):
+        client = self.sync_client
+
+        response = client.admin_analytics_getFile(
+            type="public_channel", metadata_only=True
+        )
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)
+
     @async_test
     async def test_async(self):
         client = self.async_client
@@ -69,3 +80,49 @@ async def test_async_error(self):
         except SlackApiError as e:
             self.assertFalse(e.response["ok"])
             self.assertEqual("file_not_yet_available", e.response["error"])
+
+    @async_test
+    async def test_async_public_channel(self):
+        client = self.async_client
+
+        response = await client.admin_analytics_getFile(
+            date="2020-10-20", type="public_channel"
+        )
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)
+
+    @async_test
+    async def test_async_public_channel_metadata_only(self):
+        client = self.async_client
+
+        response = await client.admin_analytics_getFile(
+            type="public_channel",
+            metadata_only=True,
+        )
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)
+
+    def test_legacy(self):
+        client = self.legacy_client
+
+        response = client.admin_analytics_getFile(date="2020-10-20", type="member")
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)
+
+    def test_legacy_public_channel(self):
+        client = self.legacy_client
+
+        response = client.admin_analytics_getFile(
+            date="2020-10-20", type="public_channel"
+        )
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)
+
+    def test_legacy_public_channel_metadata_only(self):
+        client = self.legacy_client
+
+        response = client.admin_analytics_getFile(
+            type="public_channel", metadata_only=True
+        )
+        self.assertTrue(isinstance(response.data, bytes))
+        self.assertIsNotNone(response.data)

slack_sdk/web/async_client.py

@@ -76,7 +76,12 @@ class AsyncWebClient(AsyncBaseClient):
     """
 
     async def admin_analytics_getFile(
-        self, *, date: str, type: str, **kwargs
+        self,
+        *,
+        type: str,
+        date: Optional[str] = None,
+        metadata_only: Optional[bool] = None,
+        **kwargs
     ) -> AsyncSlackResponse:
         """Retrieve analytics data for a given date, presented as a compressed JSON file
 
@@ -86,7 +91,11 @@ async def admin_analytics_getFile(
             type (str): The type of analytics to retrieve.
                 The options are currently limited to member.
         """
-        kwargs.update({"date": date, "type": type})
+        kwargs.update({"type": type})
+        if date is not None:
+            kwargs.update({"date": date})
+        if metadata_only is not None:
+            kwargs.update({"metadata_only": metadata_only})
         return await self.api_call("admin.analytics.getFile", params=kwargs)
 
     async def admin_apps_approve(

slack_sdk/web/client.py

@@ -67,7 +67,12 @@ class WebClient(BaseClient):
     """
 
     def admin_analytics_getFile(
-        self, *, date: str, type: str, **kwargs
+        self,
+        *,
+        type: str,
+        date: Optional[str] = None,
+        metadata_only: Optional[bool] = None,
+        **kwargs
     ) -> SlackResponse:
         """Retrieve analytics data for a given date, presented as a compressed JSON file
 
@@ -77,7 +82,11 @@ def admin_analytics_getFile(
             type (str): The type of analytics to retrieve.
                 The options are currently limited to member.
         """
-        kwargs.update({"date": date, "type": type})
+        kwargs.update({"type": type})
+        if date is not None:
+            kwargs.update({"date": date})
+        if metadata_only is not None:
+            kwargs.update({"metadata_only": metadata_only})
         return self.api_call("admin.analytics.getFile", params=kwargs)
 
     def admin_apps_approve(

slack_sdk/web/legacy_client.py

@@ -78,7 +78,12 @@ class LegacyWebClient(LegacyBaseClient):
     """
 
     def admin_analytics_getFile(
-        self, *, date: str, type: str, **kwargs
+        self,
+        *,
+        type: str,
+        date: Optional[str] = None,
+        metadata_only: Optional[bool] = None,
+        **kwargs
     ) -> Union[Future, SlackResponse]:
         """Retrieve analytics data for a given date, presented as a compressed JSON file
 
@@ -88,7 +93,11 @@ def admin_analytics_getFile(
             type (str): The type of analytics to retrieve.
                 The options are currently limited to member.
         """
-        kwargs.update({"date": date, "type": type})
+        kwargs.update({"type": type})
+        if date is not None:
+            kwargs.update({"date": date})
+        if metadata_only is not None:
+            kwargs.update({"metadata_only": metadata_only})
         return self.api_call("admin.analytics.getFile", params=kwargs)
 
     def admin_apps_approve(