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

package/src/commands/native/coupon/voucher/list/schema.json

@@ -0,0 +1,772 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "form",
+      "yzOpenId",
+      "status",
+      "pageNo",
+      "pageSize"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/positiveInteger"
+      },
+      "form": {
+        "type": "string",
+        "enum": [
+          "card",
+          "code"
+        ],
+        "description": "card 优惠卡券，默认普通优惠券类别范围，不承诺完整覆盖三方券、兑换券、买赠券或运费抵扣券；code 优惠码，仅为该分组默认返回范围，不承诺全部码活动。未知形态拒绝。"
+      },
+      "yzOpenId": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^(?!.*[\\u0000-\\u001f\\u007f-\\u009f])\\S(?:[\\s\\S]*\\S)?$",
+        "description": "客户有赞开放标识，trim 后非空，无控制字符，保持字符串。"
+      },
+      "status": {
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 4,
+        "description": "筛选0为所选形态及默认活动类别内的全部使用状态；1生效即未使用且未过期；2已使用；3未使用且已过期；4已失效即已使用或已过期，不是商家作废。默认0，不表示全部券类别。"
+      },
+      "pageNo": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 2147483647
+      },
+      "pageSize": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 200
+      }
+    },
+    "description": "CLI 参数解析与上下文补全后的规范化业务输入，不接受 JSON 直接调用；原始选项和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "vouchers",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "vouchers": {
+            "type": "array",
+            "maxItems": 200,
+            "items": {
+              "$ref": "#/definitions/voucher"
+            }
+          },
+          "pagination": {
+            "$ref": "#/definitions/pagination"
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "prerequisites",
+      "requests"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "type": "object",
+        "required": [
+          "kdtId"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "kdtId": {
+            "$ref": "#/definitions/positiveInteger"
+          }
+        }
+      },
+      "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.ump.voucher.query/3.0.0"
+            },
+            "body": {
+              "type": "object",
+              "required": [
+                "activity_type_group",
+                "yz_open_id",
+                "status",
+                "page_num",
+                "page_size"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "activity_type_group": {
+                  "type": "integer",
+                  "enum": [
+                    1,
+                    2
+                  ]
+                },
+                "yz_open_id": {
+                  "type": "string",
+                  "minLength": 1,
+                  "pattern": "^(?!.*[\\u0000-\\u001f\\u007f-\\u009f])\\S(?:[\\s\\S]*\\S)?$",
+                  "description": "客户有赞开放标识，trim 后非空，无控制字符，保持字符串。"
+                },
+                "status": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 4
+                },
+                "page_num": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 2147483647
+                },
+                "page_size": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 200
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "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",
+              "target_mismatch",
+              "ambiguous"
+            ]
+          },
+          "stage": {
+            "type": "string",
+            "minLength": 1
+          },
+          "command": {
+            "const": "coupon.voucher.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"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "gatewayCode": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "trace_id": {
+            "type": "string"
+          },
+          "request_id": {
+            "type": "string"
+          },
+          "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": {
+    "positiveInteger": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "shopId": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "voucher": {
+      "type": "object",
+      "required": [
+        "voucherId",
+        "form",
+        "ownerKdtId",
+        "activityId",
+        "yzOpenId",
+        "status",
+        "validity"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "voucherId": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "买家单张凭证ID，不是活动ID或客户ID。"
+        },
+        "form": {
+          "type": "string",
+          "enum": [
+            "card",
+            "code"
+          ],
+          "description": "card 优惠卡券；code 优惠码；未知或与请求不一致的凭证类型拒绝。"
+        },
+        "ownerKdtId": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "归属店铺，必须等于本次目标店铺。"
+        },
+        "activityId": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "券发行活动引用，不作为查询筛选。"
+        },
+        "yzOpenId": {
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^(?!.*[\\u0000-\\u001f\\u007f-\\u009f])\\S(?:[\\s\\S]*\\S)?$",
+          "description": "客户有赞开放标识，trim 后非空，无控制字符，保持字符串。"
+        },
+        "status": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "单券状态：1正常、2冻结、3已核销、4不可用、5已删除；未来安全整数保留，不按筛选status解释。"
+        },
+        "title": {
+          "type": "string",
+          "description": "源省略则省略，空串保留，null或错型失败。"
+        },
+        "description": {
+          "type": "string",
+          "description": "原文描述；源省略则省略，空串保留，null或错型失败。"
+        },
+        "validity": {
+          "type": "object",
+          "required": [
+            "startAt",
+            "endAt"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "startAt": {
+              "type": "string",
+              "format": "beijing-date-time-ms",
+              "description": "有效期开始；源为正安全毫秒整数，转换为北京时间 YYYY-MM-DD HH:mm:ss.SSS；无零值或永久哨兵。"
+            },
+            "endAt": {
+              "type": "string",
+              "format": "beijing-date-time-ms",
+              "description": "有效期结束，须不早于开始；源为正安全毫秒整数，转换为北京时间 YYYY-MM-DD HH:mm:ss.SSS；无零值或永久哨兵。"
+            }
+          }
+        },
+        "sentAt": {
+          "type": "string",
+          "format": "beijing-date-time-ms",
+          "description": "发放时间，源省略则省略，null或错型失败；源为正安全毫秒整数，转换为北京时间 YYYY-MM-DD HH:mm:ss.SSS；无零值或永久哨兵。"
+        }
+      }
+    },
+    "pagination": {
+      "type": "object",
+      "required": [
+        "pageNo",
+        "pageSize",
+        "returnedCount",
+        "hasMore",
+        "nextPageNo"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "pageNo": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 2147483647
+        },
+        "pageSize": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 200
+        },
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "匹配本次查询条件的总记录数，不是当前页返回条数；上游未提供可确认总数时省略。"
+        },
+        "returnedCount": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 200
+        },
+        "hasMore": {
+          "type": ["boolean", "null"],
+          "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+        },
+        "nextPageNo": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 2147483647
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "已确认且未超过页码上限的下一页；无法确认或到达上限时为 null。"
+        }
+      }
+    },
+    "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.ump.voucher.query/3.0.0"
+  },
+  "success": {
+    "description": "分页匹配请求，所有券的类型、客户、归属和固定字段完整后整页成功，不返回部分结果。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为脱敏错误JSON且非零退出。161201523映射not_found，161201012/161201545为business_rejected；HTTP403为permission，冲突成功信号或旧包装为protocol，身份不符为scope_unresolved。不重试、切店、过滤异常行或输出部分成功。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "固定同店凭证核验及一次主请求，最多两次应用请求；预览零请求，不读取凭证。无include、活动筛选、扫描或详情补查。",
+    "仅按默认活动类别查询。card 默认普通优惠券类别，不承诺完整覆盖三方券、兑换券、买赠券、运费抵扣券；code 不承诺所有码活动。total 与空页只描述该范围和当前筛选，不表示全部客户券资产。返回页码及容量须等于请求，total不得小于本页数量；有总量未到达的空页失败。",
+    "未选择面额、折扣、核销码、手机号、身份扩展、发放来源及订单；未知扩展不投影不校验。单券状态不转换成筛选状态，不根据时间推导资格。",
+    "仅支持凭证所属目标店铺，店铺核验不证明员工OAuth。支持微商城单店、零售单店、连锁D总部/网店/合伙人。"
+  ]
+}