perk-pushplus-sdk 1.2.2__tar.gz → 1.2.3__tar.gz

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perk-pushplus-sdk
-Version: 1.2.2
+Version: 1.2.3
 Summary: pushplus(推送加) 官方接口的 Python SDK，覆盖消息发送接口与全部开放接口。
 Author: perk-net
 License: Apache-2.0
@@ -35,7 +35,7 @@ Requires-Dist: responses>=0.23; extra == "dev"
 [pushplus(推送加)](https://www.pushplus.plus) 官方接口的 Python SDK，覆盖 **消息接口** 与 **全部开放接口**。
 
 - **消息接口**（`/send`、`/batchSend`）：单渠道 + 多渠道发送，含 Builder API。
-- **开放接口**（`/api/open/...` 与 `/push/api/open/...`）：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、QQ 机器人、功能设置、预处理信息、图片服务、push 表单、push 文档、push 表格。
+- **开放接口**（`/api/open/...` 与 `/push/api/open/...`）：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、QQ 机器人、功能设置、预处理信息、图片服务、push 表单、push 文档、push 表格、消息规则。
 - **AccessKey 自动管理**：缓存 + 过期前自动刷新；`code=401` 自动刷新并重试一次。
 - **本地限流守卫**：命中 `code=900` 后按 token 短路同 token 后续发送，避免被服务端长期封禁。
 - **回调解析**：`message_complate`、`add_topic_user`、`add_friend` 三类回调统一解析。
@@ -188,6 +188,19 @@ client.setting.change_is_send(1)  # 启用发送
 # 预处理（会员）
 client.pre.test(...)
 
+# 消息规则（会员）
+from perk_pushplus import ForwardLogListQuery, ForwardRuleSaveRequest, ForwardVariable
+client.forward_rule.save_setting(1)  # 开启，未命中时仍按默认方式推送
+client.forward_rule.add(ForwardRuleSaveRequest(
+    ruleName="阿里云监控多渠道",
+    tokenId=-1,
+    sourceType=1,
+    titleTemplate="{{alertName}}",
+    variables=[ForwardVariable(varName="alertName", sourceType=3, extractType=1, extractKey="alertName")],
+))
+rules = client.forward_rule.list()
+logs = client.forward_log.list(ForwardLogListQuery.of(1, 20, match_result=1))
+
 # 图片服务（一行上传到 PushPlus 图床）
 r = client.image.upload_file("/tmp/logo.png")
 print(r.url)  # 可访问的图片地址

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/README.md

@@ -3,7 +3,7 @@
 [pushplus(推送加)](https://www.pushplus.plus) 官方接口的 Python SDK，覆盖 **消息接口** 与 **全部开放接口**。
 
 - **消息接口**（`/send`、`/batchSend`）：单渠道 + 多渠道发送，含 Builder API。
-- **开放接口**（`/api/open/...` 与 `/push/api/open/...`）：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、QQ 机器人、功能设置、预处理信息、图片服务、push 表单、push 文档、push 表格。
+- **开放接口**（`/api/open/...` 与 `/push/api/open/...`）：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、QQ 机器人、功能设置、预处理信息、图片服务、push 表单、push 文档、push 表格、消息规则。
 - **AccessKey 自动管理**：缓存 + 过期前自动刷新；`code=401` 自动刷新并重试一次。
 - **本地限流守卫**：命中 `code=900` 后按 token 短路同 token 后续发送，避免被服务端长期封禁。
 - **回调解析**：`message_complate`、`add_topic_user`、`add_friend` 三类回调统一解析。
@@ -156,6 +156,19 @@ client.setting.change_is_send(1)  # 启用发送
 # 预处理（会员）
 client.pre.test(...)
 
+# 消息规则（会员）
+from perk_pushplus import ForwardLogListQuery, ForwardRuleSaveRequest, ForwardVariable
+client.forward_rule.save_setting(1)  # 开启，未命中时仍按默认方式推送
+client.forward_rule.add(ForwardRuleSaveRequest(
+    ruleName="阿里云监控多渠道",
+    tokenId=-1,
+    sourceType=1,
+    titleTemplate="{{alertName}}",
+    variables=[ForwardVariable(varName="alertName", sourceType=3, extractType=1, extractKey="alertName")],
+))
+rules = client.forward_rule.list()
+logs = client.forward_log.list(ForwardLogListQuery.of(1, 20, match_result=1))
+
 # 图片服务（一行上传到 PushPlus 图床）
 r = client.image.upload_file("/tmp/logo.png")
 print(r.url)  # 可访问的图片地址

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "perk-pushplus-sdk"
-version = "1.2.2"
+version = "1.2.3"
 description = "pushplus(推送加) 官方接口的 Python SDK，覆盖消息发送接口与全部开放接口。"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.8"

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus/__init__.py

@@ -29,6 +29,13 @@ from .enums import (
     Channel,
     ErrorCode,
     FormStatus,
+    ForwardConditionOperator,
+    ForwardExtractType,
+    ForwardMatchResult,
+    ForwardMessageType,
+    ForwardMode,
+    ForwardSourceType,
+    ForwardVarSourceType,
     SendStatus,
     ShareLogin,
     SharePerm,
@@ -63,6 +70,19 @@ from .models import (
     FormSaveRequest,
     FormSettings,
     FormTheme,
+    ForwardCondition,
+    ForwardConditionItem,
+    ForwardLogDetail,
+    ForwardLogItem,
+    ForwardLogListQuery,
+    ForwardRuleDetail,
+    ForwardRuleItem,
+    ForwardRuleSaveRequest,
+    ForwardRuleSetting,
+    ForwardRuleTestRequest,
+    ForwardRuleTestResult,
+    ForwardTarget,
+    ForwardVariable,
     FriendItem,
     FriendQrCode,
     FriendBlacklistItem,
@@ -114,7 +134,7 @@ from .models import (
 )
 from .rate_limit import RateLimitGuard
 
-__version__ = "1.2.2"
+__version__ = "1.2.3"
 
 __all__ = [
     "__version__",
@@ -139,6 +159,13 @@ __all__ = [
     "FormStatus",
     "SharePerm",
     "ShareLogin",
+    "ForwardMode",
+    "ForwardSourceType",
+    "ForwardVarSourceType",
+    "ForwardExtractType",
+    "ForwardMatchResult",
+    "ForwardConditionOperator",
+    "ForwardMessageType",
     "ApiResponse",
     "PageQuery",
     "PageResult",
@@ -212,4 +239,17 @@ __all__ = [
     "DocContent",
     "ExcelVo",
     "ExcelContent",
+    "ForwardConditionItem",
+    "ForwardCondition",
+    "ForwardVariable",
+    "ForwardTarget",
+    "ForwardRuleItem",
+    "ForwardRuleDetail",
+    "ForwardRuleSaveRequest",
+    "ForwardRuleTestRequest",
+    "ForwardRuleTestResult",
+    "ForwardRuleSetting",
+    "ForwardLogListQuery",
+    "ForwardLogItem",
+    "ForwardLogDetail",
 ]

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus/api/__init__.py

@@ -8,6 +8,8 @@ from .image import ImageApi
 from .form import FormApi
 from .doc import DocApi
 from .excel import ExcelApi
+from .forward_log import ForwardLogApi
+from .forward_rule import ForwardRuleApi
 from .message import MessageApi
 from .message_token import MessageTokenApi
 from .open_message import OpenMessageApi
@@ -40,4 +42,6 @@ __all__ = [
     "FormApi",
     "DocApi",
     "ExcelApi",
+    "ForwardRuleApi",
+    "ForwardLogApi",
 ]

perk_pushplus_sdk-1.2.3/src/perk_pushplus/api/forward_log.py

@@ -0,0 +1,25 @@
+"""开放接口 - 消息规则触发记录（文档「十四. 消息规则接口」第 10、11 节）。"""
+from __future__ import annotations
+
+from typing import Optional
+
+from ..models import ForwardLogDetail, ForwardLogItem, ForwardLogListQuery, PageResult
+from .base import OpenAbstractApi
+
+
+class ForwardLogApi(OpenAbstractApi):
+    """消息规则触发记录。"""
+
+    def list(self, query: Optional[ForwardLogListQuery] = None) -> PageResult[ForwardLogItem]:
+        body = query if query is not None else ForwardLogListQuery()
+        result = self.execute_open(
+            "POST", "/api/open/forwardLog/list", body, PageResult[ForwardLogItem]
+        )
+        return result or PageResult(list=[])
+
+    def detail(self, log_id: int) -> ForwardLogDetail:
+        path = self.append_query("/api/open/forwardLog/detail", {"logId": int(log_id)})
+        return self.execute_open("GET", path, None, ForwardLogDetail)
+
+
+__all__ = ["ForwardLogApi"]

perk_pushplus_sdk-1.2.3/src/perk_pushplus/api/forward_rule.py

@@ -0,0 +1,69 @@
+"""开放接口 - 消息规则（文档「十四. 消息规则接口」）。需开通会员后才能开启。"""
+from __future__ import annotations
+
+from typing import Optional
+
+from ..models import (
+    ForwardRuleDetail,
+    ForwardRuleItem,
+    ForwardRuleSaveRequest,
+    ForwardRuleSetting,
+    ForwardRuleTestRequest,
+    ForwardRuleTestResult,
+    PageQuery,
+    PageResult,
+)
+from .base import OpenAbstractApi
+
+
+class ForwardRuleApi(OpenAbstractApi):
+    """消息规则（仅会员）。"""
+
+    def list(self, query: Optional[PageQuery] = None) -> PageResult[ForwardRuleItem]:
+        body = query if query is not None else PageQuery()
+        result = self.execute_open(
+            "POST", "/api/open/forwardRule/list", body, PageResult[ForwardRuleItem]
+        )
+        return result or PageResult(list=[])
+
+    def detail(self, rule_id: int) -> ForwardRuleDetail:
+        path = self.append_query("/api/open/forwardRule/detail", {"ruleId": int(rule_id)})
+        return self.execute_open("GET", path, None, ForwardRuleDetail)
+
+    def add(self, req: ForwardRuleSaveRequest) -> None:
+        self.execute_open("POST", "/api/open/forwardRule/add", req, None)
+
+    def edit(self, req: ForwardRuleSaveRequest) -> None:
+        """修改消息规则；会整体覆盖模板变量和发送目标。"""
+
+        self.execute_open("POST", "/api/open/forwardRule/edit", req, None)
+
+    def delete(self, rule_id: int) -> None:
+        path = self.append_query("/api/open/forwardRule/delete", {"ruleId": int(rule_id)})
+        self.execute_open("DELETE", path, None, None)
+
+    def change_status(self, rule_id: int, status: int) -> None:
+        """启用 / 停用消息规则：1 启用，0 停用。"""
+
+        path = self.append_query(
+            "/api/open/forwardRule/changeStatus",
+            {"ruleId": int(rule_id), "status": int(status)},
+        )
+        self.execute_open("GET", path, None, None)
+
+    def test(self, req: ForwardRuleTestRequest) -> ForwardRuleTestResult:
+        """用模拟请求测试规则，不会真正发送消息。"""
+
+        return self.execute_open("POST", "/api/open/forwardRule/test", req, ForwardRuleTestResult)
+
+    def get_setting(self) -> ForwardRuleSetting:
+        return self.execute_open("GET", "/api/open/forwardRule/setting", None, ForwardRuleSetting)
+
+    def save_setting(self, mode: int) -> None:
+        """设置总开关：0 关闭，1 开启且未命中仍推送，2 开启且未命中不推送。"""
+
+        path = self.append_query("/api/open/forwardRule/setting", {"mode": int(mode)})
+        self.execute_open("GET", path, None, None)
+
+
+__all__ = ["ForwardRuleApi"]

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus/client.py

@@ -24,6 +24,8 @@ from .api import (
     FormApi,
     DocApi,
     ExcelApi,
+    ForwardLogApi,
+    ForwardRuleApi,
 )
 from .config import PushPlusConfig
 from .exceptions import PushPlusError
@@ -84,6 +86,8 @@ class PushPlusClient:
         self.form = FormApi(config, self.http_requester, self.access_key_manager)
         self.doc = DocApi(config, self.http_requester, self.access_key_manager)
         self.excel = ExcelApi(config, self.http_requester, self.access_key_manager)
+        self.forward_rule = ForwardRuleApi(config, self.http_requester, self.access_key_manager)
+        self.forward_log = ForwardLogApi(config, self.http_requester, self.access_key_manager)
 
     @classmethod
     def of(cls, config: PushPlusConfig) -> "PushPlusClient":

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus/config.py

@@ -62,7 +62,7 @@ class PushPlusConfig:
     可显式设置 ``2 * 86400`` 等更长值来减少无用试探。
     """
 
-    user_agent: str = "perk-pushplus-python-sdk/1.2.1"
+    user_agent: str = "perk-pushplus-python-sdk/1.2.3"
     """HTTP User-Agent 头。"""
 
     extra_headers: dict = field(default_factory=dict)

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus/enums.py

@@ -257,6 +257,142 @@ class ShareLogin(_IntCodeEnum):
         return self.value
 
 
+class ForwardMode(_IntCodeEnum):
+    """消息规则总开关。0-关闭，1-开启且未命中仍推送，2-开启且未命中不推送。"""
+
+    OFF = 0
+    ON_FALLBACK = 1
+    ON_STRICT = 2
+
+    @property
+    def code(self) -> int:
+        return self.value
+
+    @property
+    def description(self) -> str:
+        return _FORWARD_MODE_DESCRIPTIONS[self]
+
+
+_FORWARD_MODE_DESCRIPTIONS = {
+    ForwardMode.OFF: "关闭（推送与原来一致）",
+    ForwardMode.ON_FALLBACK: "开启，未命中时仍按默认方式推送",
+    ForwardMode.ON_STRICT: "开启，未命中时不推送",
+}
+
+
+class ForwardSourceType(_IntCodeEnum):
+    """消息规则触发来源。0-全部，1-消息接口，2-邮件。"""
+
+    ALL = 0
+    API = 1
+    MAIL = 2
+
+    @property
+    def code(self) -> int:
+        return self.value
+
+    @property
+    def description(self) -> str:
+        return _FORWARD_SOURCE_TYPE_DESCRIPTIONS[self]
+
+
+_FORWARD_SOURCE_TYPE_DESCRIPTIONS = {
+    ForwardSourceType.ALL: "全部",
+    ForwardSourceType.API: "消息接口",
+    ForwardSourceType.MAIL: "邮件",
+}
+
+
+class ForwardVarSourceType(_IntCodeEnum):
+    """模板变量来源。1-请求头，2-Query参数，3-请求体，4-URL路径，5-主题（邮件）。"""
+
+    HEADER = 1
+    QUERY = 2
+    BODY = 3
+    PATH = 4
+    SUBJECT = 5
+
+    @property
+    def code(self) -> int:
+        return self.value
+
+
+class ForwardExtractType(_IntCodeEnum):
+    """模板变量提取方式。1-序列化数据，2-正则表达式，3-JSONPath，4-原始全文。"""
+
+    SERIALIZED = 1
+    REGEX = 2
+    JSON_PATH = 3
+    RAW = 4
+
+    @property
+    def code(self) -> int:
+        return self.value
+
+
+class ForwardMatchResult(_IntCodeEnum):
+    """触发记录匹配结果。0-条件不满足，1-已转发，2-频率限制，3-不在触发时间段，4-执行异常。"""
+
+    NOT_MATCHED = 0
+    FORWARDED = 1
+    RATE_LIMITED = 2
+    OUT_OF_TIME = 3
+    ERROR = 4
+
+    @property
+    def code(self) -> int:
+        return self.value
+
+    @property
+    def description(self) -> str:
+        return _FORWARD_MATCH_RESULT_DESCRIPTIONS[self]
+
+
+_FORWARD_MATCH_RESULT_DESCRIPTIONS = {
+    ForwardMatchResult.NOT_MATCHED: "条件不满足",
+    ForwardMatchResult.FORWARDED: "已转发",
+    ForwardMatchResult.RATE_LIMITED: "频率限制",
+    ForwardMatchResult.OUT_OF_TIME: "不在触发时间段",
+    ForwardMatchResult.ERROR: "执行异常",
+}
+
+
+class ForwardConditionOperator(_StrCodeEnum):
+    """图形化触发条件运算符。"""
+
+    EQ = "eq"
+    NE = "ne"
+    CONTAINS = "contains"
+    NOT_CONTAINS = "notContains"
+    STARTS_WITH = "startsWith"
+    ENDS_WITH = "endsWith"
+    REGEX = "regex"
+    GT = "gt"
+    GTE = "gte"
+    LT = "lt"
+    LTE = "lte"
+    IN = "in"
+    NOT_IN = "notIn"
+    EMPTY = "empty"
+    NOT_EMPTY = "notEmpty"
+
+    @property
+    def code(self) -> str:
+        return self.value
+
+
+class ForwardMessageType(_StrCodeEnum):
+    """消息规则发送目标的消息类型。也支持写成 ``{{变量名}}``。"""
+
+    ONE = "one"
+    TOPIC = "topic"
+    FRIEND = "friend"
+
+    @property
+    def code(self) -> str:
+        return self.value
+
+
 __all__ = [
     "Channel",
     "Template",
@@ -267,4 +403,11 @@ __all__ = [
     "FormStatus",
     "SharePerm",
     "ShareLogin",
+    "ForwardMode",
+    "ForwardSourceType",
+    "ForwardVarSourceType",
+    "ForwardExtractType",
+    "ForwardMatchResult",
+    "ForwardConditionOperator",
+    "ForwardMessageType",
 ]

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus/models/__init__.py

@@ -59,6 +59,21 @@ from .open_form import (
     FormTheme,
 )
 from .open_doc import DocContent, DocListItem, DocListQuery, DocVo, ExcelContent, ExcelVo
+from .open_forward import (
+    ForwardCondition,
+    ForwardConditionItem,
+    ForwardLogDetail,
+    ForwardLogItem,
+    ForwardLogListQuery,
+    ForwardRuleDetail,
+    ForwardRuleItem,
+    ForwardRuleSaveRequest,
+    ForwardRuleSetting,
+    ForwardRuleTestRequest,
+    ForwardRuleTestResult,
+    ForwardTarget,
+    ForwardVariable,
+)
 
 __all__ = [
     "ApiResponse",
@@ -136,4 +151,17 @@ __all__ = [
     "DocContent",
     "ExcelVo",
     "ExcelContent",
+    "ForwardConditionItem",
+    "ForwardCondition",
+    "ForwardVariable",
+    "ForwardTarget",
+    "ForwardRuleItem",
+    "ForwardRuleDetail",
+    "ForwardRuleSaveRequest",
+    "ForwardRuleTestRequest",
+    "ForwardRuleTestResult",
+    "ForwardRuleSetting",
+    "ForwardLogListQuery",
+    "ForwardLogItem",
+    "ForwardLogDetail",
 ]

perk_pushplus_sdk-1.2.3/src/perk_pushplus/models/open_forward.py

@@ -0,0 +1,247 @@
+"""开放接口 - 消息规则与触发记录模型。"""
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any, Dict, List, Optional
+
+
+@dataclass
+class ForwardConditionItem:
+    """图形化触发条件中的单条比较。"""
+
+    varName: Optional[str] = None
+    operator: Optional[str] = None
+    value: Optional[str] = None
+
+
+@dataclass
+class ForwardCondition:
+    """图形化触发条件。"""
+
+    logic: Optional[str] = None
+    items: Optional[List[ForwardConditionItem]] = None
+
+
+@dataclass
+class ForwardVariable:
+    """模板变量。"""
+
+    id: Optional[int] = None
+    ruleId: Optional[int] = None
+    varName: Optional[str] = None
+    sourceType: Optional[int] = None
+    """1-请求头，2-Query参数，3-请求体，4-URL路径，5-主题（邮件）。"""
+    extractType: Optional[int] = None
+    """1-序列化数据，2-正则表达式，3-JSONPath，4-原始全文。"""
+    extractKey: Optional[str] = None
+    defaultValue: Optional[str] = None
+    sort: Optional[int] = None
+
+
+@dataclass
+class ForwardTarget:
+    """发送目标。"""
+
+    id: Optional[int] = None
+    ruleId: Optional[int] = None
+    channel: Optional[str] = None
+    option: Optional[str] = None
+    messageType: Optional[str] = None
+    topic: Optional[str] = None
+    to: Optional[str] = None
+    sort: Optional[int] = None
+
+
+@dataclass
+class ForwardRuleItem:
+    """消息规则列表项。"""
+
+    id: Optional[int] = None
+    tokenId: Optional[int] = None
+    tokenName: Optional[str] = None
+    ruleName: Optional[str] = None
+    sourceType: Optional[int] = None
+    sourceTypeName: Optional[str] = None
+    status: Optional[int] = None
+    sort: Optional[int] = None
+    conditionExpr: Optional[str] = None
+    targetCount: Optional[int] = None
+    createTime: Optional[str] = None
+
+
+@dataclass
+class ForwardRuleDetail:
+    """消息规则详情。"""
+
+    id: Optional[int] = None
+    tokenId: Optional[int] = None
+    ruleName: Optional[str] = None
+    sourceType: Optional[int] = None
+    status: Optional[int] = None
+    sort: Optional[int] = None
+    conditionExpr: Optional[str] = None
+    condition: Optional[ForwardCondition] = None
+    titleTemplate: Optional[str] = None
+    contentTemplate: Optional[str] = None
+    template: Optional[str] = None
+    pre: Optional[str] = None
+    stopOnMatch: Optional[int] = None
+    limitPeriod: Optional[int] = None
+    limitCount: Optional[int] = None
+    activeStartTime: Optional[str] = None
+    activeEndTime: Optional[str] = None
+    activeWeekdays: Optional[str] = None
+    remark: Optional[str] = None
+    variables: Optional[List[ForwardVariable]] = None
+    targets: Optional[List[ForwardTarget]] = None
+    createTime: Optional[str] = None
+
+
+@dataclass
+class ForwardRuleSaveRequest:
+    """新增 / 修改消息规则（修改时 ``id`` 必填）。"""
+
+    ruleName: Optional[str] = None
+    id: Optional[int] = None
+    tokenId: Optional[int] = None
+    sourceType: Optional[int] = None
+    status: Optional[int] = None
+    sort: Optional[int] = None
+    condition: Optional[ForwardCondition] = None
+    conditionExpr: Optional[str] = None
+    titleTemplate: Optional[str] = None
+    contentTemplate: Optional[str] = None
+    template: Optional[str] = None
+    pre: Optional[str] = None
+    stopOnMatch: Optional[int] = None
+    limitPeriod: Optional[int] = None
+    limitCount: Optional[int] = None
+    activeStartTime: Optional[str] = None
+    activeEndTime: Optional[str] = None
+    activeWeekdays: Optional[str] = None
+    remark: Optional[str] = None
+    variables: Optional[List[ForwardVariable]] = None
+    targets: Optional[List[ForwardTarget]] = None
+
+
+@dataclass
+class ForwardRuleTestRequest:
+    """测试消息规则请求。不会真正发送消息。"""
+
+    sourceType: Optional[int] = None
+    contentType: Optional[str] = None
+    headers: Optional[Dict[str, Any]] = None
+    query: Optional[Dict[str, Any]] = None
+    body: Optional[str] = None
+    title: Optional[str] = None
+    mailFrom: Optional[str] = None
+    mailTo: Optional[str] = None
+    mailCc: Optional[str] = None
+    condition: Optional[ForwardCondition] = None
+    conditionExpr: Optional[str] = None
+    titleTemplate: Optional[str] = None
+    contentTemplate: Optional[str] = None
+    template: Optional[str] = None
+    pre: Optional[str] = None
+    variables: Optional[List[ForwardVariable]] = None
+
+
+@dataclass
+class ForwardRuleTestResult:
+    """测试消息规则结果。"""
+
+    variables: Optional[Dict[str, Any]] = None
+    matched: Optional[bool] = None
+    conditionExpr: Optional[str] = None
+    errorMessage: Optional[str] = None
+    title: Optional[str] = None
+    content: Optional[str] = None
+    template: Optional[str] = None
+
+
+@dataclass
+class ForwardRuleSetting:
+    """消息规则总开关。"""
+
+    mode: Optional[int] = None
+    """0-关闭，1-开启且未命中仍推送，2-开启且未命中不推送。"""
+
+
+@dataclass
+class ForwardLogListQuery:
+    """触发记录分页查询。官方结构是 ``{current, pageSize, params:{ruleId, matchResult}}``。"""
+
+    current: Optional[int] = None
+    pageSize: Optional[int] = None
+    params: Optional[Dict[str, Any]] = None
+
+    @classmethod
+    def of(
+        cls,
+        current: Optional[int] = 1,
+        page_size: Optional[int] = 20,
+        rule_id: Optional[int] = None,
+        match_result: Optional[int] = None,
+    ) -> "ForwardLogListQuery":
+        params: Dict[str, Any] = {}
+        if rule_id is not None:
+            params["ruleId"] = rule_id
+        if match_result is not None:
+            params["matchResult"] = match_result
+        return cls(current=current, pageSize=page_size, params=params or None)
+
+
+@dataclass
+class ForwardLogItem:
+    """触发记录列表项。"""
+
+    id: Optional[int] = None
+    ruleId: Optional[int] = None
+    ruleName: Optional[str] = None
+    sourceType: Optional[int] = None
+    sourceTypeName: Optional[str] = None
+    requestIp: Optional[str] = None
+    matchResult: Optional[int] = None
+    matchResultName: Optional[str] = None
+    shortCodes: Optional[str] = None
+    errorMessage: Optional[str] = None
+    createTime: Optional[str] = None
+
+
+@dataclass
+class ForwardLogDetail:
+    """触发记录详情。"""
+
+    id: Optional[int] = None
+    ruleId: Optional[int] = None
+    ruleName: Optional[str] = None
+    sourceType: Optional[int] = None
+    sourceTypeName: Optional[str] = None
+    requestIp: Optional[str] = None
+    requestMethod: Optional[str] = None
+    requestHeaders: Optional[str] = None
+    requestQuery: Optional[str] = None
+    requestBody: Optional[str] = None
+    variables: Optional[str] = None
+    matchResult: Optional[int] = None
+    matchResultName: Optional[str] = None
+    shortCodes: Optional[str] = None
+    errorMessage: Optional[str] = None
+    createTime: Optional[str] = None
+
+
+__all__ = [
+    "ForwardConditionItem",
+    "ForwardCondition",
+    "ForwardVariable",
+    "ForwardTarget",
+    "ForwardRuleItem",
+    "ForwardRuleDetail",
+    "ForwardRuleSaveRequest",
+    "ForwardRuleTestRequest",
+    "ForwardRuleTestResult",
+    "ForwardRuleSetting",
+    "ForwardLogListQuery",
+    "ForwardLogItem",
+    "ForwardLogDetail",
+]

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perk-pushplus-sdk
-Version: 1.2.2
+Version: 1.2.3
 Summary: pushplus(推送加) 官方接口的 Python SDK，覆盖消息发送接口与全部开放接口。
 Author: perk-net
 License: Apache-2.0
@@ -35,7 +35,7 @@ Requires-Dist: responses>=0.23; extra == "dev"
 [pushplus(推送加)](https://www.pushplus.plus) 官方接口的 Python SDK，覆盖 **消息接口** 与 **全部开放接口**。
 
 - **消息接口**（`/send`、`/batchSend`）：单渠道 + 多渠道发送，含 Builder API。
-- **开放接口**（`/api/open/...` 与 `/push/api/open/...`）：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、QQ 机器人、功能设置、预处理信息、图片服务、push 表单、push 文档、push 表格。
+- **开放接口**（`/api/open/...` 与 `/push/api/open/...`）：用户、消息、消息 token、群组、群组用户、好友、webhook、渠道、ClawBot、QQ 机器人、功能设置、预处理信息、图片服务、push 表单、push 文档、push 表格、消息规则。
 - **AccessKey 自动管理**：缓存 + 过期前自动刷新；`code=401` 自动刷新并重试一次。
 - **本地限流守卫**：命中 `code=900` 后按 token 短路同 token 后续发送，避免被服务端长期封禁。
 - **回调解析**：`message_complate`、`add_topic_user`、`add_friend` 三类回调统一解析。
@@ -188,6 +188,19 @@ client.setting.change_is_send(1)  # 启用发送
 # 预处理（会员）
 client.pre.test(...)
 
+# 消息规则（会员）
+from perk_pushplus import ForwardLogListQuery, ForwardRuleSaveRequest, ForwardVariable
+client.forward_rule.save_setting(1)  # 开启，未命中时仍按默认方式推送
+client.forward_rule.add(ForwardRuleSaveRequest(
+    ruleName="阿里云监控多渠道",
+    tokenId=-1,
+    sourceType=1,
+    titleTemplate="{{alertName}}",
+    variables=[ForwardVariable(varName="alertName", sourceType=3, extractType=1, extractKey="alertName")],
+))
+rules = client.forward_rule.list()
+logs = client.forward_log.list(ForwardLogListQuery.of(1, 20, match_result=1))
+
 # 图片服务（一行上传到 PushPlus 图床）
 r = client.image.upload_file("/tmp/logo.png")
 print(r.url)  # 可访问的图片地址

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/src/perk_pushplus_sdk.egg-info/SOURCES.txt

@@ -19,6 +19,8 @@ src/perk_pushplus/api/clawbot.py
 src/perk_pushplus/api/doc.py
 src/perk_pushplus/api/excel.py
 src/perk_pushplus/api/form.py
+src/perk_pushplus/api/forward_log.py
+src/perk_pushplus/api/forward_rule.py
 src/perk_pushplus/api/friend.py
 src/perk_pushplus/api/image.py
 src/perk_pushplus/api/message.py
@@ -39,6 +41,7 @@ src/perk_pushplus/models/open_channel.py
 src/perk_pushplus/models/open_clawbot.py
 src/perk_pushplus/models/open_doc.py
 src/perk_pushplus/models/open_form.py
+src/perk_pushplus/models/open_forward.py
 src/perk_pushplus/models/open_friend.py
 src/perk_pushplus/models/open_image.py
 src/perk_pushplus/models/open_message.py

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/tests/test_enums_and_exceptions.py

@@ -5,6 +5,9 @@ from perk_pushplus import (
     CallbackEvent,
     Channel,
     ErrorCode,
+    ForwardConditionOperator,
+    ForwardMatchResult,
+    ForwardMode,
     PushPlusError,
     SendStatus,
     Template,
@@ -49,6 +52,13 @@ def test_error_code_rate_limited():
     assert ErrorCode.from_code(None) is ErrorCode.UNKNOWN
 
 
+def test_forward_mode_and_match_result():
+    assert ForwardMode.ON_FALLBACK.code == 1
+    assert ForwardMode.ON_STRICT.description == "开启，未命中时不推送"
+    assert ForwardMatchResult.FORWARDED.description == "已转发"
+    assert ForwardConditionOperator.NOT_CONTAINS.value == "notContains"
+
+
 def test_pushplus_error_exposes_metadata():
     exc = PushPlusError("rate", code=900)
     assert exc.code == 900

{perk_pushplus_sdk-1.2.2 → perk_pushplus_sdk-1.2.3}/tests/test_open_api.py

@@ -260,6 +260,70 @@ def test_friend_and_topic_user_blacklist():
     assert json.loads(topic_list[3])["params"]["topicId"] == 100
 
 
+def test_forward_rule_and_log():
+    req = ScriptedRequester()
+    req.push(
+        "/api/open/forwardRule/list",
+        200,
+        _ok({"pageNum": 1, "list": [{"id": 1, "ruleName": "阿里云监控多渠道", "sourceType": 1}]}),
+    )
+    req.push("/api/open/forwardRule/add", 200, _ok(None))
+    req.push(
+        "/api/open/forwardRule/test",
+        200,
+        _ok({"matched": True, "title": "ECS-内存使用率", "conditionExpr": "alertState == 'ALERT'"}),
+    )
+    req.push("/api/open/forwardRule/setting?mode=1", 200, _ok(None))
+    req.push("/api/open/forwardRule/setting", 200, _ok({"mode": 1}))
+    req.push(
+        "/api/open/forwardLog/list",
+        200,
+        _ok({"pageNum": 1, "list": [{"id": 9, "ruleId": 1, "matchResult": 1}]}),
+    )
+    req.push(
+        "/api/open/forwardLog/detail",
+        200,
+        _ok({"id": 9, "ruleId": 1, "requestBody": '{"alertState":"ALERT"}'}),
+    )
+    client = _build_client(req)
+
+    from perk_pushplus import (
+        ForwardLogListQuery,
+        ForwardRuleSaveRequest,
+        ForwardRuleTestRequest,
+        ForwardVariable,
+    )
+
+    page = client.forward_rule.list()
+    assert page.list[0].ruleName == "阿里云监控多渠道"
+    client.forward_rule.add(
+        ForwardRuleSaveRequest(
+            ruleName="阿里云监控多渠道",
+            tokenId=-1,
+            sourceType=1,
+            variables=[ForwardVariable(varName="alertState", sourceType=3, extractType=1, extractKey="alertState")],
+        )
+    )
+    tested = client.forward_rule.test(
+        ForwardRuleTestRequest(sourceType=1, body='{"alertState":"ALERT"}', conditionExpr="alertState == 'ALERT'")
+    )
+    assert tested.matched is True
+    client.forward_rule.save_setting(1)
+    setting = client.forward_rule.get_setting()
+    assert setting.mode == 1
+    logs = client.forward_log.list(ForwardLogListQuery.of(1, 20, rule_id=1, match_result=1))
+    assert logs.list[0].id == 9
+    detail = client.forward_log.detail(9)
+    assert "ALERT" in detail.requestBody
+
+    add_call = next(c for c in req.calls if "/api/open/forwardRule/add" in c[1])
+    assert json.loads(add_call[3])["tokenId"] == -1
+    assert any("setting?mode=1" in c[1] for c in req.calls)
+    log_list = next(c for c in req.calls if "/api/open/forwardLog/list" in c[1])
+    assert json.loads(log_list[3])["params"]["matchResult"] == 1
+    assert any("logId=9" in c[1] for c in req.calls)
+
+
 def test_form_list_uses_current_and_params():
     req = ScriptedRequester()
     req.push("/push/api/open/form/list", 200, _ok({"pageNum": 1, "pageSize": 20, "total": 0, "list": []}))