pixelarraythirdparty 1.2.9__py3-none-any.whl → 1.3.2__py3-none-any.whl

pixelarraythirdparty/__init__.py

@@ -12,11 +12,15 @@ PixelArray 第三方微服务客户端
 - feedback: 客户反馈模块
 - project: 项目管理模块
 - support_chat: 在线客服（临时会话链接）
+- custom_events: 自定义事件（新建定义与上报）
+- project_dashboard: 项目看板（按 scope 查询 DNU/DAU/留存）
 """
 
 from .support_chat.support_chat import SupportChatManagerAsync
+from .custom_events.custom_events import CustomEventsManagerAsync
+from .project_dashboard.project_dashboard import ProjectDashboardManagerAsync
 
-__version__ = "1.2.9"
+__version__ = "1.3.2"
 __author__ = "Lu qi"
 __email__ = "qi.lu@pixelarrayai.com"
 
@@ -29,5 +33,9 @@ __all__ = [
     "feedback",
     "project",
     "support_chat",
+    "custom_events",
+    "project_dashboard",
     "SupportChatManagerAsync",
+    "CustomEventsManagerAsync",
+    "ProjectDashboardManagerAsync",
 ]

pixelarraythirdparty/custom_events/__init__.py

@@ -0,0 +1,3 @@
+from .custom_events import CustomEventsManagerAsync
+
+__all__ = ["CustomEventsManagerAsync"]

pixelarraythirdparty/custom_events/custom_events.py

@@ -0,0 +1,92 @@
+from pixelarraythirdparty.client import AsyncClient
+from typing import Any, Dict, List, Optional, Tuple
+
+
+class CustomEventsManagerAsync(AsyncClient):
+    """自定义事件：新建定义与上报（上报前须存在对应事件定义与字段 schema）。"""
+
+    async def create_custom_event_definition(
+        self,
+        project_name: str,
+        event_key: str,
+        display_name: str,
+        *,
+        description: Optional[str] = None,
+        category: str = "custom",
+        field_schema: Optional[List[Dict[str, Any]]] = None,
+        is_active: bool = True,
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            新建自定义事件定义（需 API Key；与 Portal「新建定义」一致，对应 POST /api/custom-events/definitions/create）
+        parameters:
+            project_name(str): 项目名称（与 projects.name 一致）
+            event_key(str): 事件键（1~64 字符）
+            display_name(str): 展示名
+            description(str, optional): 说明
+            category(str): 分类白名单，默认 custom
+            field_schema(list, optional): 字段定义列表，每项含 name、type(string|number|boolean)、required、description
+            is_active(bool): 是否启用，默认 True
+        return:
+            data(dict): 成功时为定义记录；失败时含 message 等
+            success(bool): 是否成功
+        """
+        body: Dict[str, Any] = {
+            "project_name": project_name,
+            "event_key": event_key,
+            "display_name": display_name,
+            "category": category,
+            "field_schema": field_schema or [],
+            "is_active": is_active,
+        }
+        if description is not None:
+            body["description"] = description
+        return await self._request(
+            "POST", "/api/custom-events/definitions/create", json=body
+        )
+
+    async def report_custom_event(
+        self,
+        project_name: str,
+        event_key: str,
+        payload: Dict[str, Any],
+        client_occurred_at: Optional[str] = None,
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            上报单条自定义事件日志（JSON 载荷须符合 Portal 中配置的 field_schema）
+        parameters:
+            project_name(str): 项目名称（与 projects.name 一致）
+            event_key(str): 事件键
+            payload(dict): JSON 对象，键与类型须与定义一致
+            client_occurred_at(str, optional): 客户端事件发生时间，ISO8601 字符串
+        return:
+            data(dict): 成功时为日志记录；失败时含 message 等
+            success(bool): 是否成功
+        """
+        data: Dict[str, Any] = {
+            "project_name": project_name,
+            "event_key": event_key,
+            "payload": payload,
+        }
+        if client_occurred_at is not None:
+            data["client_occurred_at"] = client_occurred_at
+        return await self._request("POST", "/api/custom-events/report", json=data)
+
+    async def report_custom_events_batch(
+        self,
+        project_name: str,
+        items: List[Dict[str, Any]],
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            批量上报自定义事件（同一 project_name；任一条校验失败则整批失败）
+        parameters:
+            project_name(str): 项目名称（与 projects.name 一致）
+            items(list): 每项为 dict，须含 event_key、payload；可选 client_occurred_at（字符串）
+        return:
+            data(dict): 成功时为日志列表；失败时含 message
+            success(bool): 是否成功
+        """
+        body = {"project_name": project_name, "items": items}
+        return await self._request("POST", "/api/custom-events/report/batch", json=body)

pixelarraythirdparty/project_dashboard/__init__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+from pixelarraythirdparty.project_dashboard.project_dashboard import (
+    ProjectDashboardManagerAsync,
+)
+
+__all__ = ["ProjectDashboardManagerAsync"]

pixelarraythirdparty/project_dashboard/project_dashboard.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+from typing import Any, Dict, Optional, Tuple
+
+from pixelarraythirdparty.client import AsyncClient
+
+
+def _resolve_dashboard_path(scope: str) -> Optional[str]:
+    s = (scope or "").strip()
+    if s.upper() == "DNU":
+        return "/api/project-dashboard/dashboard/dnu"
+    if s.upper() == "DAU":
+        return "/api/project-dashboard/dashboard/dau"
+    if s.upper() == "RETENTION" or s == "留存":
+        return "/api/project-dashboard/dashboard/retention"
+    return None
+
+
+class ProjectDashboardManagerAsync(AsyncClient):
+    """项目看板：按 scope 查询 DNU / DAU / 留存（与 Portal 同源接口，需 API Key）。"""
+
+    async def query_dashboard(
+        self,
+        project_name: str,
+        scope: str,
+        start_date: Optional[str] = None,
+        end_date: Optional[str] = None,
+    ) -> Tuple[Dict[str, Any], bool]:
+        """
+        description:
+            查询项目看板指标；scope 为 DNU、DAU、RETENTION 或中文「留存」。
+        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
+        return:
+            data(dict): 成功时为 DauData / DnuData / RetentionData 结构（见接口文档）
+            success(bool): 是否成功
+        """
+        path = _resolve_dashboard_path(scope)
+        if not path:
+            return (
+                {"message": "scope 无效，应为 DNU、DAU、RETENTION 或 留存"},
+                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
+        return await self._request("GET", path, params=params)

{pixelarraythirdparty-1.2.9.dist-info → pixelarraythirdparty-1.3.2.dist-info}/METADATA

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

{pixelarraythirdparty-1.2.9.dist-info → pixelarraythirdparty-1.3.2.dist-info}/RECORD

@@ -1,7 +1,9 @@
-pixelarraythirdparty/__init__.py,sha256=nh2-eWE-1U8t_Pq_DAqfNZpeNW6Dc_x0dC0P1vDGN0M,750
+pixelarraythirdparty/__init__.py,sha256=u4nKGTU7GeD4kMRPtf0w8_ok_HcgBDV0mpIVCZYGgKE,1139
 pixelarraythirdparty/client.py,sha256=hICdd1MSBrxtoo4BgXSdmKchLehbpJcQ486SO9_fmuI,4459
 pixelarraythirdparty/cron/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pixelarraythirdparty/cron/cron.py,sha256=Cm5J1XppXh1raqtlWwpkdcsztWpQZIGY7FOt1VH9Pz0,3152
+pixelarraythirdparty/custom_events/__init__.py,sha256=dwB0mRElWp--5KmDVT7ZhGZ5xZdrO_ZKybngfAHm0zw,92
+pixelarraythirdparty/custom_events/custom_events.py,sha256=3IygHeJ4pcw2JqKS-DO4ubzoZiEPFeOiLw7zx76m9k4,3843
 pixelarraythirdparty/feedback/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pixelarraythirdparty/feedback/feedback.py,sha256=bwR2qeors_G2zFoKkefsJrPrLzCxndoXGru-aVsiRSI,11596
 pixelarraythirdparty/order/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -10,14 +12,16 @@ pixelarraythirdparty/product/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NM
 pixelarraythirdparty/product/product.py,sha256=fELowDk073SAmNJ2iW14UjyePH5g1X5YDJMTkVysA3E,7509
 pixelarraythirdparty/project/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pixelarraythirdparty/project/project.py,sha256=lEeGvSH6yl-O9AmpNtRNtcu1y2FzHmVWeofbYPCZfa0,2461
+pixelarraythirdparty/project_dashboard/__init__.py,sha256=yeVhw4smnQ8-xN-BG3aZ7sbU4hYGQfAduLIEr_8nXQQ,175
+pixelarraythirdparty/project_dashboard/project_dashboard.py,sha256=3Y4-N0xVsE8-jH7-WhJTFhLJoJuvch0Ms8rH0ZzjXN8,1985
 pixelarraythirdparty/support_chat/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pixelarraythirdparty/support_chat/support_chat.py,sha256=M2YD4tWUKt1xRAEZy-znvxFnU8KIxKoHtYnVuUiE_kY,1128
 pixelarraythirdparty/unified_login/__init__.py,sha256=bWG_I7GMHilWZvnxjVJFmHgxioRdFFvpi95XJunl_fY,403
 pixelarraythirdparty/unified_login/unified_login.py,sha256=15fNyhm6HKgjPMO1RCqpxzlAzBAJuGZbRMr4gABh4MA,40575
 pixelarraythirdparty/user/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pixelarraythirdparty/user/user.py,sha256=G-dldmbuUQN1JPicuC2G4qvIY4Mq7pZIPh3lOyWpSqo,5773
-pixelarraythirdparty-1.2.9.dist-info/licenses/LICENSE,sha256=O-g1dUr0U50rSIvmWE9toiVkSgFpVt72_MHITbWvAqA,1067
-pixelarraythirdparty-1.2.9.dist-info/METADATA,sha256=SKKzeaqsB1E27ypF9y4ORxMTE5b1Pym1Yk8lWEdjvsY,993
-pixelarraythirdparty-1.2.9.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-pixelarraythirdparty-1.2.9.dist-info/top_level.txt,sha256=dzG2Ut8j7noUqj_0ZQjcIDAeHYCh_9WtlxjAxtoyufo,21
-pixelarraythirdparty-1.2.9.dist-info/RECORD,,
+pixelarraythirdparty-1.3.2.dist-info/licenses/LICENSE,sha256=O-g1dUr0U50rSIvmWE9toiVkSgFpVt72_MHITbWvAqA,1067
+pixelarraythirdparty-1.3.2.dist-info/METADATA,sha256=Ci2RXCHVCOWcQxjoNLP4mdTbYynMrV5VGpeguFBO5Z8,993
+pixelarraythirdparty-1.3.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pixelarraythirdparty-1.3.2.dist-info/top_level.txt,sha256=dzG2Ut8j7noUqj_0ZQjcIDAeHYCh_9WtlxjAxtoyufo,21
+pixelarraythirdparty-1.3.2.dist-info/RECORD,,