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

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

@@ -0,0 +1,845 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+      "kdtId",
+      "form",
+      "stage",
+      "pageNo",
+      "pageSize"
+    ],
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/positiveInteger"
+      },
+      "form": {
+        "enum": [
+          "card",
+          "code"
+        ],
+        "description": "card 优惠卡券；code 优惠码，分别分页。"
+      },
+      "keyword": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^[^\\u0000-\\u001f\\u007f-\\u009f]+$",
+        "description": "活动名称关键词，首尾去空白；不承诺精确匹配。"
+      },
+      "stage": {
+        "type": "integer",
+        "minimum": 0,
+        "maximum": 4,
+        "description": "0 全部；1 未开始；2 进行中；3 已结束；4 未结束，含未开始与进行中。"
+      },
+      "displayType": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 7,
+        "description": "1 满减券；2 折扣券；3 随机金额券；4 商品兑换券；5 社区团购券；6 通用码；7 一卡一码。不猜组合限制。"
+      },
+      "pageNo": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 500,
+        "description": "指定页码，不自动翻页。"
+      },
+      "pageSize": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 20,
+        "description": "单页容量。"
+      },
+      "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，省略时不补值。"
+          }
+        },
+        "description": "--created-at \"START..END\" 解析后的活动创建时间窗口；可省略一端，两端齐备时开始须早于结束。毫秒精度，不承诺端点包含性。"
+      }
+    },
+    "description": "CLI 解析参数并补全上下文后的业务输入，不是直接接收的 JSON；调用签名和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+      "data"
+    ],
+    "properties": {
+      "data": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "activities",
+          "pagination"
+        ],
+        "properties": {
+          "activities": {
+            "type": "array",
+            "maxItems": 20,
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "activityId",
+                "ownerKdtId",
+                "title",
+                "activityType",
+                "status"
+              ],
+              "properties": {
+                "activityId": {
+                  "$ref": "#/definitions/positiveInteger",
+                  "description": "券发行活动 ID，不是客户持券 ID。"
+                },
+                "ownerKdtId": {
+                  "$ref": "#/definitions/positiveInteger",
+                  "description": "活动归属店铺，必须等于本次目标。"
+                },
+                "title": {
+                  "type": "string",
+                  "minLength": 1,
+                  "description": "活动名称。"
+                },
+                "activityType": {
+                  "type": "integer",
+                  "minimum": -9007199254740991,
+                  "maximum": 9007199254740991,
+                  "description": "7 优惠券；9 共享码；10 唯一码；11 社区团购券。未知整数保留，不推断可由其他命令完整读取。"
+                },
+                "status": {
+                  "type": "integer",
+                  "minimum": -9007199254740991,
+                  "maximum": 9007199254740991,
+                  "description": "0 有效；1 已失效或审核失败，无法区分原因；2 审核中。未知整数保留，不当正常。"
+                },
+                "alias": {
+                  "type": "string",
+                  "description": "活动别名，实际空串保留。"
+                },
+                "isDeleted": {
+                  "type": "boolean",
+                  "description": "true 已删除；false 未删除，与活动状态独立。"
+                },
+                "offerText": {
+                  "type": "string",
+                  "description": "优惠原文，不解析金额或执行其中内容。"
+                },
+                "budget": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [],
+                  "properties": {
+                    "takenQty": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "maximum": 9007199254740991,
+                      "description": "领取数量，不是去重客户数。"
+                    },
+                    "usedQty": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "maximum": 9007199254740991,
+                      "description": "核销数量。"
+                    },
+                    "sendTotalQty": {
+                      "type": "integer",
+                      "minimum": -9007199254740991,
+                      "maximum": 9007199254740991,
+                      "description": "发放总预算；不推断负数或0的额外含义。"
+                    },
+                    "useTotalQty": {
+                      "type": "integer",
+                      "minimum": -9007199254740991,
+                      "maximum": 9007199254740991,
+                      "description": "核销总预算。"
+                    },
+                    "sendStockQty": {
+                      "type": "integer",
+                      "minimum": -9007199254740991,
+                      "maximum": 9007199254740991,
+                      "description": "发放剩余预算。"
+                    },
+                    "useStockQty": {
+                      "type": "integer",
+                      "minimum": -9007199254740991,
+                      "maximum": 9007199254740991,
+                      "description": "核销剩余预算。"
+                    }
+                  },
+                  "description": "固定摘要中的预算；源对象省略则省略，不补0；实际空对象保留，不推导库存恒等式。"
+                }
+              }
+            },
+            "description": "本次单页活动摘要，保留顺序；不是客户持券或订单可用证明。"
+          },
+          "pagination": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "pageNo",
+              "pageSize",
+              "returnedCount",
+              "hasMore",
+              "nextPageNo"
+            ],
+            "properties": {
+              "pageNo": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 500,
+                "description": "本次查询页码，与请求保持一致；空集合仍保留请求值。"
+              },
+              "pageSize": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 20,
+                "description": "本次查询容量，与请求保持一致；空集合仍保留请求值。"
+              },
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "匹配本次查询条件的总记录数，不是当前页返回条数；上游未提供可确认总数时省略。"
+              },
+              "returnedCount": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 20,
+                "description": "本页活动数量，不超过容量和报告总量。"
+              },
+              "hasMore": {
+                "type": ["boolean", "null"],
+                "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+              },
+              "nextPageNo": {
+                "anyOf": [
+                  {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 500
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "已确认且未超过页码上限的下一页；无法确认或到达上限时为 null。"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+      "scope",
+      "prerequisites",
+      "requests"
+    ],
+    "properties": {
+      "scope": {
+        "$ref": "#/definitions/scope"
+      },
+      "prerequisites": {
+        "type": "array",
+        "items": {
+          "enum": [
+            "context",
+            "token-shop-binding"
+          ]
+        },
+        "minItems": 2,
+        "maxItems": 2
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 2,
+        "maxItems": 2,
+        "items": [
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "method",
+              "api",
+              "body"
+            ],
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "api": {
+                "const": "youzan.shop.basic.get/3.0.0"
+              },
+              "body": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [],
+                "properties": {}
+              }
+            }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "method",
+              "api",
+              "body"
+            ],
+            "properties": {
+              "method": {
+                "const": "POST"
+              },
+              "api": {
+                "const": "youzan.ump.voucheractivity.manage.info.search/1.0.1"
+              },
+              "body": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "activity_type_group",
+                  "time_line_status",
+                  "page_no",
+                  "page_size"
+                ],
+                "properties": {
+                  "activity_type_group": {
+                    "enum": [
+                      1,
+                      2
+                    ]
+                  },
+                  "time_line_status": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "maximum": 4
+                  },
+                  "page_no": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 500
+                  },
+                  "page_size": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 20
+                  },
+                  "title_keyword": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "activity_display_type": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 7
+                  },
+                  "create_begin_time": {
+                    "type": "integer",
+                    "minimum": -9007199254740991,
+                    "maximum": 9007199254740991
+                  },
+                  "create_end_time": {
+                    "type": "integer",
+                    "minimum": -9007199254740991,
+                    "maximum": 9007199254740991
+                  }
+                }
+              }
+            }
+          }
+        ],
+        "additionalItems": false
+      }
+    }
+  },
+  "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",
+        "additionalProperties": false,
+        "required": [
+          "category",
+          "stage",
+          "command",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "properties": {
+          "category": {
+            "enum": [
+              "parameter",
+              "validation",
+              "configuration",
+              "permission",
+              "authentication",
+              "scope_unresolved",
+              "transport",
+              "http",
+              "protocol",
+              "business_rejected",
+              "not_found"
+            ]
+          },
+          "stage": {
+            "enum": [
+              "input",
+              "configuration",
+              "shop-binding",
+              "query",
+              "response"
+            ]
+          },
+          "command": {
+            "const": "coupon.activity.list"
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/positiveInteger"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string"
+          },
+          "httpStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "businessCode": {
+            "$ref": "#/definitions/diagnosticCode"
+          },
+          "gatewayCode": {
+            "$ref": "#/definitions/diagnosticCode"
+          },
+          "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。"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "positiveInteger": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "scope": {
+      "type": "object",
+      "required": [
+        "kdtId"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kdtId": {
+          "$ref": "#/definitions/positiveInteger"
+        }
+      }
+    },
+    "diagnosticCode": {
+      "oneOf": [
+        {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "string",
+          "pattern": "^-?\\d{1,12}$"
+        }
+      ]
+    },
+    "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": {
+    "activities": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": true,
+      "description": "固定活动摘要及已返回的预算计数，可选字段缺失保持省略。"
+    },
+    "pagination": {
+      "base": true,
+      "upstreamPath": "$",
+      "required": true,
+      "description": "根分页信息，与请求一致；空页不表示全集为空。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.ump.voucheractivity.manage.info.search/1.0.1"
+  },
+  "success": {
+    "description": "同归属店铺的本页活动摘要及分页满足契约后整体成功；空列表与失败严格区分。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为一份脱敏错误 JSON，退出码非零；不返回部分成功，不自动重试、切换身份或目标。按 error 模型及安全下一步处理。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "必填 form，card 与 code 分开查询；不提供 include，不补查详情。",
+    "凭证店铺与活动归属必须等于目标；有效四字段上下文仅提供本地准入，店铺核验不证明员工 OAuth。不支持总部代查其他归属店铺。",
+    "每次一次核验加一次主查询，最多两个请求，无自动重试、切店、重定向或翻页。",
+    "默认第1页、容量10，最大500页、容量20。保持原范围按 nextPageNo 继续；第500页仍有后续时停止并说明窗口耗尽，收窄条件是新查询，不承诺无重无漏。",
+    "可选字段缺失保持省略，明确 null 或错型失败；保留0、false、空字符串与实际空对象。不以预算推导不限量或额外库存等式。",
+    "活动状态不证明已经开始、客户资格或订单可用；未知整数保留不当正常。",
+    "缺少上下文仅可显式店铺本地预览；预览不读凭证、不联网，只表示构造计划。",
+    "区间省略边界不会补零或当前时间；不接受旧开始/结束参数或裸时间等值。"
+  ]
+}