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

package/src/commands/native/valuecard/card/get/schema.json

@@ -0,0 +1,683 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "cardNo",
+      "include"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/shopId"
+      },
+      "cardNo": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^[^\\s\\u0000-\\u001f\\u007f-\\u009f](?:[^\\u0000-\\u001f\\u007f-\\u009f]*[^\\s\\u0000-\\u001f\\u007f-\\u009f])?$",
+        "description": "去首尾空白的完整系统卡号，保留前导零及非数字字符；拒绝控制字符。"
+      },
+      "include": {
+        "$ref": "#/definitions/selection"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入；不是直接传入 CLI 的 JSON。原始选项、必填条件和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "card"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "card": {
+            "type": "object",
+            "required": [
+              "cardNo",
+              "cardType",
+              "cardStatus",
+              "balance"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "cardNo": {
+                "$ref": "#/definitions/text",
+                "description": "必须与输入系统卡号完全匹配。"
+              },
+              "cardType": {
+                "type": "string",
+                "enum": [
+                  "balance",
+                  "gift"
+                ],
+                "description": "balance 表示余额卡，gift 表示礼品卡。"
+              },
+              "cardStatus": {
+                "$ref": "#/definitions/text",
+                "description": "字符串状态：init 未激活；normal 正常；freeze C端冻结；cmpfrz 完全冻结；receding 退卡中；receded 已退卡；close 注销。未知非空状态原样保留，不据此判断某订单可支付。"
+              },
+              "balance": {
+                "type": "object",
+                "required": [
+                  "totalBalance",
+                  "principalBalance",
+                  "bonusBalance"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "totalBalance": {
+                    "$ref": "#/definitions/money",
+                    "description": "总余额，元两位字符串，必须等于本金加赠送金。"
+                  },
+                  "principalBalance": {
+                    "$ref": "#/definitions/money",
+                    "description": "本金余额，元两位字符串。"
+                  },
+                  "bonusBalance": {
+                    "$ref": "#/definitions/money",
+                    "description": "赠送金余额，元两位字符串。"
+                  }
+                }
+              },
+              "template": {
+                "type": "object",
+                "required": [
+                  "templateNo"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "templateNo": {
+                    "$ref": "#/definitions/text",
+                    "description": "模板号，仅选择 template 后必需。"
+                  },
+                  "templateName": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "description": "模板名称，保留省略、null 和空字符串。"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "prerequisites",
+      "requests",
+      "selection"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "$ref": "#/definitions/scope"
+      },
+      "selection": {
+        "$ref": "#/definitions/selection"
+      },
+      "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",
+              "additionalProperties": false
+            }
+          }
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 1,
+        "maxItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "const": "youzan.cardvoucher.valuecard.info.bycardno.query/3.0.0"
+            },
+            "body": {
+              "type": "object",
+              "required": [
+                "card_no"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "card_no": {
+                  "const": "<redacted>"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "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",
+              "not_found"
+            ]
+          },
+          "stage": {
+            "type": "string",
+            "minLength": 1
+          },
+          "command": {
+            "const": "valuecard.card.get"
+          },
+          "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/code"
+          },
+          "gatewayCode": {
+            "$ref": "#/definitions/code"
+          },
+          "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
+    },
+    "scope": {
+      "type": "object",
+      "required": [
+        "kdtId"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kdtId": {
+          "$ref": "#/definitions/shopId"
+        }
+      }
+    },
+    "selection": {
+      "type": "array",
+      "maxItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "const": "template"
+      }
+    },
+    "text": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "\\S"
+    },
+    "money": {
+      "type": "string",
+      "pattern": "^-?(?:0|[1-9][0-9]*)\\.[0-9]{2}$",
+      "description": "默认人民币（CNY），单位元、固定两位小数的十进制金额文本，不补零、不舍入、不换汇。"
+    },
+    "code": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "string",
+          "pattern": "^-?[0-9]{1,12}$"
+        }
+      ]
+    },
+    "trace": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9_-]{1,128}$"
+    },
+    "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": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "modules": {
+    "card": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": true,
+      "description": "一张已知系统卡号的余额卡或礼品卡，卡号匹配、状态和三个余额必需。"
+    },
+    "template": {
+      "base": false,
+      "upstreamPath": "data.template_no",
+      "required": true,
+      "description": "仅 include template 时投影，templateNo 必需，templateName 可选；不新增请求。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.cardvoucher.valuecard.info.bycardno.query/3.0.0"
+  },
+  "success": {
+    "description": "同凭证店铺与目标一致，唯一系统卡号精确匹配，卡状态、三个余额及所选模板关联满足模型后整体成功。"
+  },
+  "errors": {
+    "description": "仅明确业务码 118703049 映射 not_found；空或错型响应为 protocol，其他卡种为 scope_unresolved。错误不回显卡号、客户或自由消息，发送后断连 unknown。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "按完整系统卡号查询一张余额卡或礼品卡，不接受卡面号、兑换码、客户 ID 或模板号替代；保留前导零。",
+    "默认返回卡号、卡种、状态及总余额、本金余额、赠送金余额；金额为元两位字符串，总额必须等于本金加赠送金，不推算支付资格或客户总资产。",
+    "--include template 仅追加模板关联，不增加请求；模板号必需，模板名称可省略或为 null，未选择时不校验模板字段。",
+    "支持微商城或零售单店、连锁 D 总部、网店及合伙人、连锁 L 总部高级版；不承诺其他产品或跨机构授权。",
+    "不返回持有人、手机号、有效期、卡面号、介质、发卡机构、流水、冻结或可退款金额。",
+    "预览遮盖卡号，不读取凭证或联网；最多一次店铺核验和一次单卡读取，不自动重试、换店、换身份或改用客户列表。真实执行需有效四字段上下文及同店凭证，at 不证明员工授权。",
+    "本命令已定义金额的币种默认人民币（CNY）；字段、结果或明确父对象上下文声明其他币种时按该声明处理，不执行换汇。"
+  ]
+}