@youzan-cloud/zan-saas-cli 0.0.0-stage → 0.1.0-beta.3

package/src/commands/native/member/growth-log/list/schema.json

@@ -0,0 +1,695 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "yzOpenId",
+      "createdAt",
+      "pageNo",
+      "pageSize"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/shopId"
+      },
+      "yzOpenId": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^[^\\s\\u0000-\\u001f\\u007f-\\u009f](?:[^\\u0000-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$",
+        "description": "trim 后的客户 yzOpenId，不是手机号、微信 openId 或员工 ID。"
+      },
+      "createdAt": {
+        "type": "object",
+        "required": [
+          "start",
+          "end"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "start": {
+            "$ref": "#/definitions/beijingSecond"
+          },
+          "end": {
+            "$ref": "#/definitions/beijingSecond"
+          }
+        },
+        "description": "显式两端的北京时间秒精度窗口，允许相等；起点不早于本次固定 now 前 360×24 小时，跨度不超过 90×24 小时，终点不晚于 now。"
+      },
+      "pageNo": {
+        "$ref": "#/definitions/pageNo"
+      },
+      "pageSize": {
+        "$ref": "#/definitions/pageSize"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入，不是直接传入 CLI 的 JSON。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "logs",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "logs": {
+            "type": "array",
+            "maxItems": 50,
+            "description": "当前请求页的成长值变更记录，保留源顺序和重复，不补造流水 ID 或余额。",
+            "items": {
+              "type": "object",
+              "required": [
+                "amount",
+                "eventType",
+                "createdAt"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "amount": {
+                  "$ref": "#/definitions/safeInteger",
+                  "description": "有符号成长值变动原值，不解释增减方向。"
+                },
+                "eventType": {
+                  "type": "integer",
+                  "minimum": -2147483648,
+                  "maximum": 2147483647,
+                  "description": "源事件码，未知合法整数原样保留；事件不证明客户实际等级变化。已知整数值：401=生日特权发放成长值；460=等级降级扣减成长值；800=交易发放成长值；801=管理员操作成长值发放；802=退款扣减成长值；803=领卡发放成长值；804=储值发放成长值；805=退卡扣减成长值；806=权益数据迁移发放成长值；808=会员卡续期发放成长值；810=客户导入发放成长值；811=微商城新会员等级初始化；812=交易金额成长值规则发放成长值；813=交易购次成长值规则发放成长值；814=交易退款扣减成长值；815=节日发放成长值；816=纪念日发放成长值；817=系统修正数据；818=开放平台操作加成长值；819=开放平台操作减成长值；820=完善信息发放成长值；821=绑定手机号；822=每日签到；823=任务中心完成任务；824=权益系统发放成长值；999=设置等级给成长值。"
+                },
+                "createdAt": {
+                  "type": "string",
+                  "format": "beijing-date-time-ms",
+                  "$comment": "upstream-time:seconds",
+                  "description": "源 Unix 秒转换后的北京时间，固定三位毫秒。"
+                },
+                "description": {
+                  "type": "string",
+                  "description": "源记录描述，缺省时省略，空串保留。"
+                },
+                "bizValue": {
+                  "type": "string",
+                  "description": "源成长值业务键，缺省时省略，空串保留；不保证唯一，不作为流水 ID 或订单号。"
+                }
+              }
+            }
+          },
+          "pagination": {
+            "type": "object",
+            "required": [
+              "pageNo",
+              "pageSize",
+              "hasMore"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "pageNo": {
+                "$ref": "#/definitions/pageNo",
+                "description": "上游页码，必须等于请求页码。"
+              },
+              "pageSize": {
+                "$ref": "#/definitions/pageSize",
+                "description": "上游容量，必须等于请求容量。"
+              },
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 2147483647,
+                "description": "匹配本次查询条件的总记录数，不是当前页返回条数；上游未提供可确认总数时省略。"
+              },
+              "hasMore": {
+                "type": ["boolean", "null"],
+                "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "requests"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "type": "object",
+        "required": [
+          "kdtId"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "kdtId": {
+            "$ref": "#/definitions/shopId"
+          }
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 2,
+        "maxItems": 2,
+        "description": "按顺序先核验店铺再查询成长流水。第二项 body.params 为 JSON 字符串，内容是固定账号类型 5、客户标识、分页和秒精度时间文本。",
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "enum": [
+                "youzan.shop.basic.get/3.0.0",
+                "youzan.crm.growth.search.userlog/1.0.0"
+              ]
+            },
+            "body": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "params": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              }
+            }
+          },
+          "allOf": [
+            {
+              "if": {
+                "properties": {
+                  "path": {
+                    "const": "youzan.shop.basic.get/3.0.0"
+                  }
+                }
+              },
+              "then": {
+                "properties": {
+                  "body": {
+                    "type": "object",
+                    "maxProperties": 0
+                  }
+                }
+              },
+              "else": {
+                "properties": {
+                  "body": {
+                    "type": "object",
+                    "required": [
+                      "params"
+                    ],
+                    "properties": {
+                      "params": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  "error": {
+    "type": "object",
+    "required": [
+      "success",
+      "code",
+      "message",
+      "details"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "success": {
+        "const": false
+      },
+      "code": {
+        "const": -10001
+      },
+      "message": {
+        "type": "string",
+        "minLength": 1
+      },
+      "details": {
+        "type": "object",
+        "required": [
+          "command",
+          "category",
+          "stage",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "command": {
+            "const": "member.growth-log.list"
+          },
+          "category": {
+            "enum": [
+              "validation",
+              "parameter",
+              "configuration",
+              "authentication",
+              "permission",
+              "scope_unresolved",
+              "http",
+              "business_rejected",
+              "transport",
+              "protocol",
+              "limit"
+            ]
+          },
+          "stage": {
+            "enum": [
+              "input",
+              "context",
+              "configuration",
+              "shop-binding",
+              "logs",
+              "logs-model",
+              "pagination",
+              "output"
+            ]
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/shopId"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string",
+            "minLength": 1
+          },
+          "httpStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "businessCode": {
+            "$ref": "#/definitions/diagnosticCode"
+          },
+          "gatewayCode": {
+            "$ref": "#/definitions/diagnosticCode"
+          },
+          "trace_id": {
+            "$ref": "#/definitions/trace"
+          },
+          "request_id": {
+            "$ref": "#/definitions/trace"
+          },
+          "errorVersion": {
+            "const": 2,
+            "description": "本命令采用错误诊断协议第二版。"
+          },
+          "issues": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "items": {
+              "$ref": "#/definitions/diagnosticIssue"
+            },
+            "description": "最多十六个已定位问题，不包含收到的原值。"
+          },
+          "issuesTruncated": {
+            "const": true,
+            "description": "问题超过返回上限，当前列表没有穷尽全部问题。"
+          },
+          "recovery": {
+            "$ref": "#/definitions/diagnosticRecovery",
+            "description": "受限的恢复说明，不会自动执行。"
+          },
+          "execution": {
+            "$ref": "#/definitions/diagnosticExecution",
+            "description": "整次调用的请求观察，独立于失败阶段的 requestState。"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "shopId": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "safeInteger": {
+      "type": "integer",
+      "minimum": -9007199254740991,
+      "maximum": 9007199254740991
+    },
+    "pageNo": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 2147483647
+    },
+    "pageSize": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50
+    },
+    "diagnosticCode": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/safeInteger"
+        },
+        {
+          "type": "string",
+          "pattern": "^-?\\d{1,12}$"
+        }
+      ]
+    },
+    "trace": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+    },
+    "beijingSecond": {
+      "type": "string",
+      "format": "beijing-date-time-ms",
+      "pattern": "\\.000$"
+    },
+    "diagnosticExpected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "type": {
+          "anyOf": [
+            {
+              "type": "string",
+              "description": "预期的 JSON 类型。"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "description": "预期的 JSON 类型。"
+              }
+            }
+          ],
+          "description": "同版模型允许的类型。"
+        },
+        "enum": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "契约声明的静态标量约束。"
+          },
+          "description": "同版模型允许的静态值。"
+        },
+        "const": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "契约声明的静态标量约束。"
+        },
+        "minimum": {
+          "type": "number",
+          "description": "包含的最小值。"
+        },
+        "maximum": {
+          "type": "number",
+          "description": "包含的最大值。"
+        },
+        "exclusiveMinimum": {
+          "type": "number",
+          "description": "不包含的最小值。"
+        },
+        "exclusiveMaximum": {
+          "type": "number",
+          "description": "不包含的最大值。"
+        },
+        "minLength": {
+          "type": "integer",
+          "description": "最少字符数。"
+        },
+        "maxLength": {
+          "type": "integer",
+          "description": "最多字符数。"
+        },
+        "minItems": {
+          "type": "integer",
+          "description": "最少元素数。"
+        },
+        "maxItems": {
+          "type": "integer",
+          "description": "最多元素数。"
+        },
+        "format": {
+          "type": "string",
+          "description": "同版模型声明的格式。"
+        },
+        "pattern": {
+          "type": "string",
+          "description": "同版模型声明的字符约束。"
+        },
+        "additionalProperties": {
+          "const": false,
+          "description": "对象拒绝契约以外的属性。"
+        },
+        "contains": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "const"
+          ],
+          "properties": {
+            "const": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "契约声明的静态标量约束。"
+            }
+          }
+        },
+        "items": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "enum"
+          ],
+          "properties": {
+            "enum": {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "契约声明的静态标量约束。"
+              },
+              "description": "元素允许的静态值。"
+            }
+          }
+        }
+      }
+    },
+    "diagnosticIssue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "source",
+        "reason"
+      ],
+      "properties": {
+        "source": {
+          "enum": [
+            "argv",
+            "input",
+            "context",
+            "output",
+            "preview"
+          ],
+          "description": "问题所属的参数、输入、上下文、结果或预览模型。"
+        },
+        "path": {
+          "type": "string",
+          "description": "对应模型中的 JSON Pointer；不含原始输入或动态字典键。"
+        },
+        "option": {
+          "type": "string",
+          "description": "可定位时给出的已注册 CLI 选项。"
+        },
+        "reason": {
+          "enum": [
+            "required",
+            "invalid_type",
+            "invalid_choice",
+            "out_of_range",
+            "invalid_format",
+            "conditional_required",
+            "constraint",
+            "unexpected_property",
+            "unknown_option",
+            "unknown_command",
+            "excess_arguments",
+            "missing_value"
+          ],
+          "description": "字段违反的约束类型，原始值不回显。"
+        },
+        "expected": {
+          "$ref": "#/definitions/diagnosticExpected",
+          "description": "同版契约的静态预期。"
+        },
+        "relatedPaths": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "关联字段的 JSON Pointer。"
+          },
+          "description": "触发条件约束的关联字段。"
+        }
+      }
+    },
+    "diagnosticRecovery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "action",
+        "automaticBusinessRetry"
+      ],
+      "properties": {
+        "action": {
+          "enum": [
+            "correct_input",
+            "complete_authentication",
+            "request_access_review",
+            "stop_and_inspect"
+          ],
+          "description": "依次表示修正本地输入、补认证、核对权限或停止核查；仅是说明，不执行操作或授予权限。"
+        },
+        "automaticBusinessRetry": {
+          "const": false,
+          "description": "不据此自动重放业务请求。"
+        }
+      }
+    },
+    "diagnosticExecution": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestState",
+        "coverage",
+        "observedAttempts"
+      ],
+      "properties": {
+        "requestState": {
+          "enum": [
+            "not_sent",
+            "sent",
+            "unknown"
+          ],
+          "description": "整次调用尚未发送、已有发送记录或无法排除未知请求；不代表业务完成。"
+        },
+        "coverage": {
+          "enum": [
+            "complete",
+            "partial"
+          ],
+          "description": "请求观察覆盖全部已接入路径，或存在未观测路径；部分覆盖不能声明零请求。"
+        },
+        "observedAttempts": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.crm.growth.search.userlog/1.0.0"
+  },
+  "success": {
+    "description": "同店核验、主请求严格成功、记录和分页模型均通过后返回有限视图。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为脱敏错误 JSON，退出码非零；不返回半页、不自动重试或翻页。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "created_at 按已核验的 Unix 秒解释，并转换为北京时间三位毫秒；不能按位数切换毫秒解释。",
+    "主请求 params 是 JSON 字符串，固定 user.account_type=5；不发送未声明的 kdt_id。",
+    "--dry-run 完成本地校验后零网络、零凭证读取，只展示两次请求计划。"
+  ]
+}