pixelarraythirdparty 1.3.4__tar.gz → 1.3.6__tar.gz

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraythirdparty
-Version: 1.3.4
+Version: 1.3.6
 Summary: PixelArray 第三方微服务客户端
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.6}/pixelarraythirdparty/__init__.py

@@ -16,11 +16,15 @@ PixelArray 第三方微服务客户端
 - project_dashboard: 项目看板（按 scope 查询 DNU/DAU/留存）
 """
 
-from .support_chat.support_chat import SupportChatManagerAsync
+from .feedback.feedback import FeedbackManagerAsync
+from .support_chat.support_chat import (
+    SupportChatManagerAsync,
+    build_staff_portal_session_url,
+)
 from .custom_events.custom_events import CustomEventsManagerAsync
 from .project_dashboard.project_dashboard import ProjectDashboardManagerAsync
 
-__version__ = "1.3.4"
+__version__ = "1.3.6"
 __author__ = "Lu qi"
 __email__ = "qi.lu@pixelarrayai.com"
 
@@ -35,7 +39,9 @@ __all__ = [
     "support_chat",
     "custom_events",
     "project_dashboard",
+    "FeedbackManagerAsync",
     "SupportChatManagerAsync",
+    "build_staff_portal_session_url",
     "CustomEventsManagerAsync",
     "ProjectDashboardManagerAsync",
 ]

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.6}/pixelarraythirdparty/custom_events/custom_events.py

@@ -62,6 +62,38 @@ class CustomEventsManagerAsync(AsyncClient):
             "POST", "/api/custom-events/definitions/create", json=body
         )
 
+    async def get_custom_event_common_field_schema(
+        self, project_name: str
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            查询项目自定义事件公共维度（GET /api/custom-events/common-field-schema）
+        """
+        return await self._request(
+            "GET",
+            "/api/custom-events/common-field-schema",
+            params={"project_name": project_name},
+        )
+
+    async def update_custom_event_common_field_schema(
+        self,
+        project_name: str,
+        field_schema: List[Dict[str, Any]],
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            更新项目公共维度；传空列表表示恢复服务端内置默认（POST /api/custom-events/common-field-schema/update）
+        parameters:
+            field_schema: 每项含 name、type、required、可选 nullable、description
+        """
+        body: Dict[str, Any] = {
+            "project_name": project_name,
+            "field_schema": field_schema or [],
+        }
+        return await self._request(
+            "POST", "/api/custom-events/common-field-schema/update", json=body
+        )
+
     async def report_custom_event(
         self,
         project_name: str,
@@ -71,7 +103,7 @@ class CustomEventsManagerAsync(AsyncClient):
     ) -> Tuple[Dict[str, Any], bool]:
         """
         description:
-            上报单条自定义事件日志（JSON 载荷须符合 Portal 中配置的 field_schema）
+            上报单条自定义事件日志（有效载荷 = 项目公共维度 ∪ 该事件 field_schema；未传的公共键由服务端补 null）
         parameters:
             project_name(str): 项目名称（与 projects.name 一致）
             event_key(str): 事件键

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.6}/pixelarraythirdparty/project_dashboard/project_dashboard.py

@@ -12,6 +12,8 @@ def _resolve_dashboard_path(scope: str) -> Optional[str]:
         return "/api/project-dashboard/dashboard/dau"
     if s.upper() == "RETENTION" or s == "留存":
         return "/api/project-dashboard/dashboard/retention"
+    if s.upper() == "TOTAL_USERS" or s == "总用户":
+        return "/api/project-dashboard/dashboard/total-users"
     return None
 
 
@@ -28,13 +30,13 @@ class ProjectDashboardManagerAsync(AsyncClient):
     ) -> Tuple[Dict[str, Any], bool]:
         """
         description:
-            查询项目看板指标；scope 为 DNU、DAU、RETENTION 或中文「留存」。
+            查询项目看板指标；scope 为 DNU、DAU、RETENTION、TOTAL_USERS 或中文「留存」「总用户」。
         parameters:
             project_name(str): 项目名称（与统一登录 project_name 一致）
             scope(str): DNU | DAU | RETENTION | 留存
             start_date(str, optional): 开始日期 YYYY-MM-DD；不传则服务端默认 T-7
             end_date(str, optional): 结束日期 YYYY-MM-DD；不传则服务端默认 T-0
-            retention_days(str, optional): 仅 scope 为留存时有效；逗号分隔天数，如 2,7,14,20；不传则服务端默认
+            retention_days(str): scope 为留存时必填；逗号分隔天数，如 1,7,14,20
         return:
             data(dict): 成功时为 DauData / DnuData / RetentionData 结构（见接口文档）
             success(bool): 是否成功
@@ -42,14 +44,23 @@ class ProjectDashboardManagerAsync(AsyncClient):
         path = _resolve_dashboard_path(scope)
         if not path:
             return (
-                {"message": "scope 无效，应为 DNU、DAU、RETENTION 或 留存"},
+                {"message": "scope 无效，应为 DNU、DAU、RETENTION、TOTAL_USERS 或 留存 / 总用户"},
+                False,
+            )
+        is_retention = "/retention" in path
+        is_total_users = "/total-users" in path
+        rd = (retention_days or "").strip()
+        if is_retention and not rd:
+            return (
+                {"message": "scope 为留存时须传入 retention_days（逗号分隔正整数，如 1,7,14）"},
                 False,
             )
         params: Dict[str, Any] = {"project_name": project_name}
-        if start_date:
-            params["start_date"] = start_date
-        if end_date:
-            params["end_date"] = end_date
-        if retention_days:
-            params["retention_days"] = retention_days
+        if not is_total_users:
+            if start_date:
+                params["start_date"] = start_date
+            if end_date:
+                params["end_date"] = end_date
+        if rd:
+            params["retention_days"] = rd
         return await self._request("GET", path, params=params)

pixelarraythirdparty-1.3.6/pixelarraythirdparty/support_chat/support_chat.py

@@ -0,0 +1,157 @@
+from typing import List, Optional
+
+from pixelarraythirdparty.client import AsyncClient
+
+
+def build_staff_portal_session_url(portal_base_url: str, session_id: int) -> str:
+    """
+    拼接带会话 ID 的 Portal 客服管理页 URL，便于运营在浏览器中打开指定会话。
+    portal_base_url 为 Portal 站点根地址（与工单 ticket_url 所用域名一致，不含末尾斜杠亦可）。
+    """
+    base = (portal_base_url or "").strip().rstrip("/")
+    return f"{base}/support-chat-management?session_id={session_id}"
+
+
+class SupportChatManagerAsync(AsyncClient):
+    async def create_support_chat_link(
+        self,
+        expires_in_hours: int = 24,
+    ):
+        """
+        description:
+            创建在线客服临时会话链接。其它服务调用此接口后，将返回的 chat_url 下发给用户，
+            用户打开链接即可与客服对话（无需登录）。链接有时效。
+        parameters:
+            expires_in_hours(int, optional): 链接有效小时数，默认 24，范围 1～720
+        return:
+            data(dict): 成功时包含
+                - chat_url(str): 客服聊天页完整 URL
+                - token(str): 会话 token
+                - session_id(int): 会话 ID
+                - expires_at(str): 过期时间
+            success(bool): 操作是否成功
+        """
+        payload = {"expires_in_hours": expires_in_hours}
+        data, success = await self._request(
+            "POST", "/api/support-chat/create-link", json=payload
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def list_support_chat_sessions(
+        self,
+        page: int = 1,
+        page_size: int = 20,
+    ):
+        """
+        客服端：分页查询会话列表（需 API Key）。返回每条含 unread_from_customer 等字段。
+        """
+        params = {"page": page, "page_size": page_size}
+        data, success = await self._request(
+            "GET", "/api/support-chat/sessions", params=params
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def get_support_chat_messages(
+        self,
+        session_id: int,
+        since_id: Optional[int] = None,
+    ):
+        """
+        客服端：拉取指定会话消息（轮询；需 API Key）。媒体消息含 media_url。
+        """
+        params: dict = {"session_id": session_id}
+        if since_id is not None:
+            params["since_id"] = since_id
+        data, success = await self._request(
+            "GET", "/api/support-chat/messages", params=params
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def send_support_message(
+        self,
+        session_id: int,
+        content: str = "",
+        content_type: str = "text",
+        oss_path: Optional[str] = None,
+        mime_type: Optional[str] = None,
+    ):
+        """
+        客服端：发送回复（文本或图片/视频，与 Portal 约定一致；需 API Key）。
+        """
+        payload = {
+            "session_id": session_id,
+            "content": content,
+            "content_type": content_type,
+        }
+        if oss_path is not None:
+            payload["oss_path"] = oss_path
+        if mime_type is not None:
+            payload["mime_type"] = mime_type
+        data, success = await self._request(
+            "POST", "/api/support-chat/send-message", json=payload
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def mark_support_session_read(self, session_id: int):
+        """客服端：将用户发来且未读的消息标记为已读。"""
+        payload = {"session_id": session_id}
+        data, success = await self._request(
+            "POST", "/api/support-chat/mark-read", json=payload
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def get_support_upload_presigned_url(
+        self,
+        session_id: int,
+        file_name: str,
+        file_type: str,
+        file_size: Optional[int] = None,
+        mime_type: Optional[str] = None,
+    ):
+        """客服端：获取 OSS 直传预签名（image | video）。"""
+        payload = {
+            "session_id": session_id,
+            "file_name": file_name,
+            "file_type": file_type,
+        }
+        if file_size is not None:
+            payload["file_size"] = file_size
+        if mime_type is not None:
+            payload["mime_type"] = mime_type
+        data, success = await self._request(
+            "POST", "/api/support-chat/upload/presigned-url", json=payload
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def delete_support_chat_session(self, session_id: int):
+        """客服端：删除单个会话及消息与对应临时 token。"""
+        data, success = await self._request(
+            "DELETE", f"/api/support-chat/sessions/{session_id}"
+        )
+        if not success:
+            return data, False
+        return data, True
+
+    async def batch_delete_support_chat_sessions(self, session_ids: List[int]):
+        """客服端：批量删除会话。"""
+        if not session_ids:
+            return {"message": "请提供要删除的会话 ID 列表"}, False
+        payload = {"session_ids": session_ids}
+        data, success = await self._request(
+            "POST", "/api/support-chat/sessions/batch-delete", json=payload
+        )
+        if not success:
+            return data, False
+        return data, True

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.6}/pixelarraythirdparty.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixelarraythirdparty
-Version: 1.3.4
+Version: 1.3.6
 Summary: PixelArray 第三方微服务客户端
 Author-email: Lu qi <qi.lu@pixelarrayai.com>
 License-Expression: MIT

{pixelarraythirdparty-1.3.4 → pixelarraythirdparty-1.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pixelarraythirdparty"
-version = "1.3.4"
+version = "1.3.6"
 authors = [
     {name = "Lu qi", email = "qi.lu@pixelarrayai.com"},
 ]

pixelarraythirdparty-1.3.4/pixelarraythirdparty/support_chat/support_chat.py

@@ -1,29 +0,0 @@
-from pixelarraythirdparty.client import AsyncClient
-
-
-class SupportChatManagerAsync(AsyncClient):
-    async def create_support_chat_link(
-        self,
-        expires_in_hours: int = 24,
-    ):
-        """
-        description:
-            创建在线客服临时会话链接。其它服务调用此接口后，将返回的 chat_url 下发给用户，
-            用户打开链接即可与客服对话（无需登录）。链接有时效。
-        parameters:
-            expires_in_hours(int, optional): 链接有效小时数，默认 24，范围 1～720
-        return:
-            data(dict): 成功时包含
-                - chat_url(str): 客服聊天页完整 URL
-                - token(str): 会话 token
-                - session_id(int): 会话 ID
-                - expires_at(str): 过期时间
-            success(bool): 操作是否成功
-        """
-        payload = {"expires_in_hours": expires_in_hours}
-        data, success = await self._request(
-            "POST", "/api/support-chat/create-link", json=payload
-        )
-        if not success:
-            return data, False
-        return data, True