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

package/src/commands/native/benefit/customer-card/list/schema.json

@@ -0,0 +1,731 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "yzOpenId",
+      "status",
+      "pageNo"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/positiveInteger"
+      },
+      "yzOpenId": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^(?!.*[\\u0000-\\u001f\\u007f-\\u009f])\\S(?:[\\s\\S]*\\S)?$",
+        "description": "去除首尾空白后的完整客户 yzOpenId，拒绝控制字符，不转数字。"
+      },
+      "status": {
+        "enum": [
+          "available",
+          "all"
+        ],
+        "description": "available 查询可用范围；all 请求全部状态范围"
+      },
+      "pageNo": {
+        "$ref": "#/definitions/positiveInteger"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入；不是直接传入 CLI 的 JSON。原始选项、必填条件和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "customerCards",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "customerCards": {
+            "type": "array",
+            "items": {
+              "$ref": "#/definitions/customerCard"
+            }
+          },
+          "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.scrm.customer.card.list/4.0.0"
+            },
+            "body": {
+              "type": "object",
+              "required": [
+                "params"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "params": {
+                  "type": "object",
+                  "required": [
+                    "user",
+                    "page_no",
+                    "state"
+                  ],
+                  "additionalProperties": false,
+                  "properties": {
+                    "user": {
+                      "type": "object",
+                      "required": [
+                        "account_id",
+                        "account_type"
+                      ],
+                      "additionalProperties": false,
+                      "properties": {
+                        "account_id": {
+                          "type": "string",
+                          "minLength": 1
+                        },
+                        "account_type": {
+                          "const": 5
+                        }
+                      }
+                    },
+                    "page_no": {
+                      "$ref": "#/definitions/positiveInteger"
+                    },
+                    "state": {
+                      "type": "boolean"
+                    }
+                  },
+                  "description": "params 保持对象，由传输层统一 JSON 编码；不发送 kdt_id、page_size 或 client_id。"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "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": "benefit.customer-card.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
+    },
+    "customerCard": {
+      "type": "object",
+      "required": [
+        "cardNo",
+        "cardAlias",
+        "cardState",
+        "cardStartTime",
+        "cardEndTime"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "cardNo": {
+          "type": "string",
+          "minLength": 1,
+          "description": "实例完整卡号；保留前导零和超出安全整数的数字字符。"
+        },
+        "cardAlias": {
+          "type": "string",
+          "minLength": 1,
+          "description": "仅关联卡定义，不替代 cardNo。"
+        },
+        "cardState": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "源状态编码；0未激活、1使用中、2已退款、3已过期、4用户删除、5商家禁用、6管理员删除、7系统删除、8未生效；未知安全整数保留。"
+        },
+        "cardStartTime": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "beijing-date-time-ms"
+            },
+            {
+              "const": ""
+            }
+          ],
+          "$comment": "upstream-time:text:empty",
+          "description": "源有效期开始文本；北京时间 YYYY-MM-DD HH:mm:ss.SSS。业务哨兵原值保留：['']。"
+        },
+        "cardEndTime": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "beijing-date-time-ms"
+            },
+            {
+              "const": ""
+            }
+          ],
+          "$comment": "upstream-time:text:empty",
+          "description": "源有效期结束文本；北京时间 YYYY-MM-DD HH:mm:ss.SSS。业务哨兵原值保留：['']。"
+        }
+      }
+    },
+    "pagination": {
+      "type": "object",
+      "required": [
+        "pageNo",
+        "pageSize",
+        "returned",
+        "hasMore",
+        "nextPageNo",
+        "windowLimitReached"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "pageNo": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "本次结果对应的页码。"
+        },
+        "pageSize": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "服务端本次响应采用的每页容量。"
+        },
+        "returned": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "本次响应中 data.customerCards 的数组长度，不是匹配总数、累计条数或嵌套记录数。"
+        },
+        "hasMore": {
+          "type": ["boolean", "null"],
+          "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+        },
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "接口未提供可靠的匹配总数，当前命令省略 total；hasMore 为 null，不提供已确认的下一页。"
+        },
+        "nextPageNo": {
+          "type": [
+            "integer",
+            "null"
+          ],
+          "minimum": 1,
+          "maximum": 9007199254740991,
+          "description": "已确认且未超过页码上限的下一页；无法确认或到达上限时为 null。"
+        },
+        "windowLimitReached": {
+          "type": "boolean",
+          "description": "仍有后续但已到本入口页码上限时为 true；不能宣称已取完或继续请求下一页。"
+        }
+      },
+      "description": "本次查询范围的分页信号；total 不保证跨页快照。"
+    },
+    "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.scrm.customer.card.list/4.0.0"
+  },
+  "success": {
+    "description": "五个实例字段及分页完整，页码匹配且页内卡号唯一后成功。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为一份脱敏错误 JSON，退出码非零；不返回部分成功，不自动重试、切换身份或目标。按 error 模型及安全下一步处理。 错误诊断第二版保留字段问题、恢复说明和整次请求观察；本地输入修正不授权重放已发送请求。不自动初始化应用或重发。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "固定一个店铺和客户，每次读取一页持卡实例，默认第 1 页；页内卡号唯一，页容量由服务端决定，不支持 --page-size。",
+    "--status available 查询可用卡，all 查询返回范围内所有状态；all 不保证已删除历史完整或跨页快照。",
+    "只返回模型中的五个实例字段，不返回客户资料，不按日期推算状态；缺必需字段、null 或错型整体失败。",
+    "支持微商城单店、零售单店、连锁 D 总部、网店及合伙人。",
+    "本地 --dry-run 不读取凭证、不联网；预览只证明构造计划，不证明对象存在或权限有效。真实执行仍需有效上下文及目标范围授权，at 声明不替代服务端授权。",
+    "接口未提供可靠的匹配总数，当前命令省略 total；hasMore 为 null，不提供已确认的下一页。"
+  ]
+}