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

package/src/commands/native/points/log/list/schema.json

@@ -0,0 +1,761 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "yzOpenId",
+      "type",
+      "pageNo",
+      "pageSize",
+      "createdAt"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/shopId"
+      },
+      "yzOpenId": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "\\S",
+        "description": "trim 后非空的客户 yzOpenId，不改大小写及内部字符。"
+      },
+      "type": {
+        "enum": [
+          "all",
+          "income",
+          "expense",
+          "frozen"
+        ]
+      },
+      "pageNo": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 2147483647
+      },
+      "pageSize": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 50
+      },
+      "createdAt": {
+        "type": "object",
+        "additionalProperties": false,
+        "minProperties": 1,
+        "properties": {
+          "start": {
+            "type": "string",
+            "format": "beijing-date-time-ms",
+            "description": "窗口起点，北京时间 YYYY-MM-DD HH:mm:ss.SSS，省略时不补值。"
+          },
+          "end": {
+            "type": "string",
+            "format": "beijing-date-time-ms",
+            "description": "窗口终点，北京时间 YYYY-MM-DD HH:mm:ss.SSS，省略时不补值。"
+          }
+        },
+        "required": [
+          "start",
+          "end"
+        ],
+        "description": "--created-at \"START..END\" 解析后的流水创建时间窗口；必须两端且开始<结束<=调用开始固定时刻，严格小于31天且开始不早于北京时间当前日历减12个月，月底截断。秒精度，非零毫秒拒绝；不承诺端点包含性。"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入；不是直接传入 CLI 的 JSON。原始选项、必填条件和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "logs",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "logs": {
+            "type": "array",
+            "maxItems": 50,
+            "items": {
+              "$ref": "#/definitions/log"
+            }
+          },
+          "pagination": {
+            "type": "object",
+            "required": [
+              "pageNo",
+              "pageSize",
+              "hasMore"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "pageNo": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 2147483647
+              },
+              "pageSize": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 50
+              },
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "匹配本次查询条件的总记录数，不是当前页返回条数；上游未提供可确认总数时省略。"
+              },
+              "hasMore": {
+                "type": ["boolean", "null"],
+                "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "method",
+      "path",
+      "body",
+      "scope",
+      "prerequisites"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "method": {
+        "const": "POST"
+      },
+      "path": {
+        "const": "youzan.crm.customer.points.changelog.search/4.0.2"
+      },
+      "body": {
+        "type": "object",
+        "required": [
+          "user",
+          "page",
+          "page_size",
+          "begin_time",
+          "end_time",
+          "type"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "user": {
+            "type": "object",
+            "required": [
+              "account_type",
+              "account_id"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "account_type": {
+                "const": 5
+              },
+              "account_id": {
+                "type": "string",
+                "minLength": 1
+              }
+            }
+          },
+          "page": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 2147483647
+          },
+          "page_size": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 50
+          },
+          "begin_time": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
+          },
+          "end_time": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"
+          },
+          "type": {
+            "enum": [
+              0,
+              1,
+              2,
+              3
+            ]
+          }
+        }
+      },
+      "scope": {
+        "type": "object",
+        "required": [
+          "kdtId"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "kdtId": {
+            "$ref": "#/definitions/shopId"
+          }
+        }
+      },
+      "prerequisites": {
+        "type": "array",
+        "minItems": 1,
+        "maxItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "const": "youzan.shop.basic.get/3.0.0"
+            },
+            "body": {
+              "type": "object",
+              "required": [],
+              "additionalProperties": false,
+              "properties": {}
+            }
+          }
+        }
+      }
+    }
+  },
+  "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": [
+          "category",
+          "stage",
+          "command",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "category": {
+            "type": "string",
+            "enum": [
+              "validation",
+              "configuration",
+              "parameter",
+              "permission",
+              "authentication",
+              "scope_unresolved",
+              "transport",
+              "http",
+              "protocol",
+              "business_rejected",
+              "budget_exceeded"
+            ]
+          },
+          "stage": {
+            "type": "string",
+            "enum": [
+              "validation",
+              "context",
+              "scope",
+              "input",
+              "configuration",
+              "shop-binding",
+              "transport",
+              "http",
+              "response",
+              "logs",
+              "logs-model",
+              "output-budget"
+            ]
+          },
+          "command": {
+            "const": "points.log.list"
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/shopId"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string"
+          },
+          "httpStatus": {
+            "type": "integer"
+          },
+          "businessCode": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              {
+                "type": "string",
+                "pattern": "^-?\\d{1,12}$"
+              }
+            ]
+          },
+          "gatewayCode": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              {
+                "type": "string",
+                "pattern": "^-?\\d{1,12}$"
+              }
+            ]
+          },
+          "trace_id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+          },
+          "request_id": {
+            "type": "string",
+            "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+          },
+          "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。"
+          }
+        }
+      }
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.crm.customer.points.changelog.search/4.0.2"
+  },
+  "definitions": {
+    "shopId": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991,
+      "description": "显式 --kdt-id 优先，否则取本次有效上下文 shopId。默认值是动态来源，不是授权证明；实际执行必须与同次凭证回读的店铺一致。"
+    },
+    "log": {
+      "type": "object",
+      "required": [
+        "amount",
+        "current",
+        "createdAt"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "amount": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "本次变化量，保留符号和0。"
+        },
+        "current": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "该次操作后的积分，不是查询时余额。"
+        },
+        "createdAt": {
+          "$ref": "#/definitions/outputTime",
+          "description": "变动发生时间，北京时间固定三位毫秒；0 或负时间值按实际日期表示，不推导业务状态。"
+        },
+        "expiredAt": {
+          "$ref": "#/definitions/outputTime",
+          "description": "积分过期时间，北京时间固定三位毫秒；0 或负时间值按实际日期表示，不推导业务状态。"
+        },
+        "description": {
+          "type": "string"
+        },
+        "bizValue": {
+          "type": "string"
+        }
+      }
+    },
+    "outputTime": {
+      "type": "string",
+      "pattern": "^(?!0000)\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01]) (?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}$",
+      "description": "北京时间（Asia/Shanghai）YYYY-MM-DD HH:mm:ss.SSS，固定三位毫秒，不附带+08:00；0 或负时间值按实际日期显示，无法表示为0001..9999年则协议失败。"
+    },
+    "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": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "notes": [
+    "只支持微商城单店；固定一个已知客户和北京时间窗口，每次查询一页，不提供全店查询、自动翻页或全量导出。",
+    "窗口满足开始早于结束且结束不晚于调用时刻，严格小于 31 天；开始不得早于北京时间当前日历减 12 个月，月底截断并保留时刻。",
+    "创建窗口使用 --created-at \"START..END\"，必须包含 .. 并显式两端；秒接口拒绝非零毫秒，全零毫秒可无损规范化，不承诺端点包含性。",
+    "type 为 all 全部、income 收入、expense 支出、frozen 冻结；客户 ID 是 yzOpenId，不是手机号或微信 openId。",
+    "默认第 1 页、每页 20 条，最多 50 条；hasMore 按总数判断，短页不代表结束。保持客户、窗口、type、pageSize，将 pageNo 加 1 继续；达到页码上限须停止。",
+    "保留变动量符号与 0，current 是该次操作后的积分而不是查询时余额；保留顺序，不排序、去重、补造流水 ID 或推算余额。",
+    "已选可选字段缺失省略；null、错型或不安全整数整体失败。已定义时间点输出为北京时间固定三位毫秒，0 或负秒的实际日期不被解释为业务状态。",
+    "紧凑 UTF-8 JSON 输出最多 5 MiB，pretty 使用同一预算，超额整体失败不截断；不是流式网络或内存硬上限。",
+    "最多一次店铺核验和一次流水请求，单步超时 10 秒，不重试或换店。dry-run 不读凭证、不联网，真实执行需有效上下文及同店凭证；应用测试不证明员工授权或跨店账本关系。",
+    "本日期输入版本尚未重新完成真实接口验收，旧版空页样本不能证明非空结果的时间、符号或时区转换已实测。",
+    "区间省略边界不会补零或当前时间；不接受旧开始/结束参数或裸时间等值。"
+  ],
+  "modules": {
+    "logs": {
+      "base": true,
+      "required": true,
+      "upstreamPath": "data.items",
+      "description": "单客户窗口内一页日志，必需集合，按源顺序投影有限字段。"
+    },
+    "pagination": {
+      "base": true,
+      "required": true,
+      "upstreamPath": "data.paginator",
+      "description": "四字段分页，页码/容量匹配输入，总数可省略，按页码、容量和总数判断是否还有下一页。"
+    }
+  },
+  "success": {
+    "description": "同凭证店铺与目标匹配，当前页流水、必需分页及全部已选字段满足模型和一致性校验后整体输出。"
+  },
+  "errors": {
+    "description": "失败时 stdout 为空，stderr 为安全错误 JSON；不自动重放、换身份或切店。",
+    "diagnosticsVersion": 2
+  }
+}