sino-bc-cli 1.8.1 → 1.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@
2
2
 
3
3
  数据来源:[sino-opti-hive 接口文档](https://o-test-sino-opti-hive.meetsocial.com/doc.html#/default/%E4%B8%9A%E5%8A%A1%E7%BA%BF%E6%9F%A5%E8%AF%A2/channelsUsingGET)
4
4
 
5
- 对外开放的只读查询接口,共 **5** 个,均不涉及数据变更。
5
+ 对外开放的只读查询接口,共 **2** 个(渠道、品类字典)。业务线列表与周策略已改绑内部接口,见 [biz-line-strategy.md](./biz-line-strategy.md) 的 `biz-line-list` / `biz-line-strategy-list`。
6
6
 
7
7
  > **网关地址**:`https://test-agent.beyondclick.com`(三环境同一地址,唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`),不要直连 sino-opti-hive 服务地址。
8
8
  >
@@ -12,9 +12,8 @@
12
12
  | --- | --- | --- | --- | --- |
13
13
  | 1 | `biz-line-open-channels` | 查询投放渠道列表 | GET | `/sino-opti-hive/biz-line-open/channels` |
14
14
  | 2 | `biz-line-open-placement-categories` | 查询投放品类字典树 | GET | `/sino-opti-hive/biz-line-open/placement-categories` |
15
- | 3 | `biz-line-open-list` | 查询业务线列表(不分页) | POST | `/sino-opti-hive/biz-line-open/list` |
16
- | 4 | `biz-line-open-strategies` | 查询业务线投放策略及表现 | POST | `/sino-opti-hive/biz-line-open/strategies` |
17
- | 5 | `biz-line-open-strategy-top` | 查询投放表现 Top 业务线 | POST | `/sino-opti-hive/biz-line-open/strategy-top` |
15
+
16
+ > `biz-line-open-list` / `biz-line-open-strategies` / `biz-line-open-strategy-top` 已不在现行 catalog。`+list` / `+strategies` 改打 `biz-line-list` / `biz-line-strategy-list`。`+top` 已下线。
18
17
 
19
18
  所有接口统一返回 `RestResponseVO` 包装:`success`、`code`、`message`、`result`、`traceId`。下文只描述 `result`。
20
19
 
@@ -204,11 +203,14 @@
204
203
  ## 命令调用
205
204
 
206
205
  ```bash
207
- # 默认生产环境 + 内置 API Key,交互选择接口
208
- sino-bc-cli /bc-api
209
-
210
- # 指定环境(test / pre / prod)
211
- sino-bc-cli /bc-api test
206
+ # 本组接口都有 Shortcut
207
+ sino-bc-cli biz-line +channels
208
+ sino-bc-cli biz-line +categories
209
+ sino-bc-cli biz-line +list --name <业务线名称>
210
+ sino-bc-cli biz-line +strategies --name <业务线名称>
211
+
212
+ # 切换环境(test / pre / prod)
213
+ sino-bc-cli /set-config env test
212
214
  ```
213
215
 
214
216
  详见 [README.md](./README.md)。
@@ -8,7 +8,7 @@
8
8
  >
9
9
  > **路由前缀**:经网关调用时所有路径需带 `/sino-opti-hive`,例如 `/sino-opti-hive/biz-line/list`。
10
10
  >
11
- > ⚠️ 标记为「写操作」的接口会变更线上数据,`/bc-api` 会按文档示例请求体直接发起调用,调用前请确认环境。
11
+ > ⚠️ 标记为「写操作」的接口会变更线上数据。CLI 会强制确认:不加 `--yes` 时交互式终端询问,非交互式环境以退出码 `10` 返回 `confirmation_required`;执行前可用 `--dry-run` 预览。文档中的「请求示例」只说明字段口径,不会被当作默认请求体发送。
12
12
 
13
13
  | # | name | 展示名 | 方法 | 路径(含前缀) |
14
14
  | --- | --- | --- | --- | --- |
@@ -305,11 +305,15 @@
305
305
  ## 命令调用
306
306
 
307
307
  ```bash
308
- # 默认生产环境 + 内置 API Key,交互选择接口
309
- sino-bc-cli /bc-api
308
+ # 写操作有 Shortcut:先预览,确认后追加 --yes
309
+ sino-bc-cli biz-line +status --id <业务线 ID> --status 3 --dry-run
310
+ sino-bc-cli biz-line +status --id <业务线 ID> --status 3 --yes
310
311
 
311
- # 指定环境(test / pre / prod)
312
- sino-bc-cli /bc-api test
312
+ # 其余接口按 name 点名调用
313
+ sino-bc-cli biz-line api biz-line-strategy-detail --data '{"bizLineId":123,"id":1}'
314
+
315
+ # 切换环境(test / pre / prod)
316
+ sino-bc-cli /set-config env test
313
317
  ```
314
318
 
315
319
  详见 [README.md](./README.md)。
@@ -0,0 +1,287 @@
1
+ [
2
+ {
3
+ "name": "biz-line-open-channels",
4
+ "displayName": "查询投放渠道列表",
5
+ "description": "无入参,返回 ChannelEnum 全量:code = 渠道 ID,name = 渠道名称",
6
+ "group": "业务线查询",
7
+ "method": "GET",
8
+ "path": "/sino-opti-hive/biz-line-open/channels",
9
+ "timeout": 20000,
10
+ "tag": "业务线查询",
11
+ "domain": "biz-line",
12
+ "shortcut": "+channels",
13
+ "risk": "read",
14
+ "summary": "查询投放渠道列表",
15
+ "docFile": "biz-line-query.md"
16
+ },
17
+ {
18
+ "name": "biz-line-open-placement-categories",
19
+ "displayName": "查询投放品类字典树",
20
+ "description": "无入参,一级节点 = 投放行业,二级节点 children = 投放品类",
21
+ "group": "业务线查询",
22
+ "method": "GET",
23
+ "path": "/sino-opti-hive/biz-line-open/placement-categories",
24
+ "timeout": 20000,
25
+ "tag": "业务线查询",
26
+ "domain": "biz-line",
27
+ "shortcut": "+categories",
28
+ "risk": "read",
29
+ "summary": "查询投放品类字典树",
30
+ "docFile": "biz-line-query.md"
31
+ },
32
+ {
33
+ "name": "biz-line-list",
34
+ "displayName": "业务线分页列表",
35
+ "description": "result 为分页对象:total = 总条数,result = 当前页 BizLineListVO 列表",
36
+ "group": "业务线策略",
37
+ "method": "POST",
38
+ "path": "/sino-opti-hive/biz-line/list",
39
+ "timeout": 20000,
40
+ "tag": "业务线策略",
41
+ "domain": "biz-line",
42
+ "shortcut": "+list",
43
+ "risk": "read",
44
+ "summary": "业务线分页列表",
45
+ "docFile": "biz-line-strategy.md"
46
+ },
47
+ {
48
+ "name": "biz-line-detail",
49
+ "displayName": "业务线详情",
50
+ "description": "按业务线 ID 查详情,result 为 BizLineDetailVO",
51
+ "group": "业务线策略",
52
+ "method": "POST",
53
+ "path": "/sino-opti-hive/biz-line/detail",
54
+ "timeout": 20000,
55
+ "tag": "业务线策略",
56
+ "domain": "biz-line",
57
+ "shortcut": "+detail",
58
+ "risk": "write",
59
+ "summary": "业务线详情",
60
+ "docFile": "biz-line-strategy.md"
61
+ },
62
+ {
63
+ "name": "biz-line-save",
64
+ "displayName": "新建业务线",
65
+ "description": "⚠️ 写操作:新建业务线,成功时 result 为新建业务线详情",
66
+ "group": "业务线策略",
67
+ "method": "POST",
68
+ "path": "/sino-opti-hive/biz-line/save",
69
+ "timeout": 20000,
70
+ "tag": "业务线策略",
71
+ "domain": "biz-line",
72
+ "shortcut": "+save",
73
+ "risk": "write",
74
+ "summary": "新建业务线",
75
+ "docFile": "biz-line-strategy.md"
76
+ },
77
+ {
78
+ "name": "biz-line-update",
79
+ "displayName": "编辑业务线",
80
+ "description": "⚠️ 写操作:按 ID 编辑业务线,成功时 result 为 Boolean",
81
+ "group": "业务线策略",
82
+ "method": "POST",
83
+ "path": "/sino-opti-hive/biz-line/update",
84
+ "timeout": 20000,
85
+ "tag": "业务线策略",
86
+ "domain": "biz-line",
87
+ "shortcut": "+update",
88
+ "risk": "write",
89
+ "summary": "编辑业务线",
90
+ "docFile": "biz-line-strategy.md"
91
+ },
92
+ {
93
+ "name": "biz-line-status-update",
94
+ "displayName": "切换业务线状态",
95
+ "description": "⚠️ 写操作:仅更新状态与操作人,status 取 1 进行中 / 2 已完成 / 3 已暂停",
96
+ "group": "业务线策略",
97
+ "method": "POST",
98
+ "path": "/sino-opti-hive/biz-line/status/update",
99
+ "timeout": 20000,
100
+ "tag": "业务线策略",
101
+ "domain": "biz-line",
102
+ "shortcut": "+status",
103
+ "risk": "write",
104
+ "summary": "切换业务线状态",
105
+ "docFile": "biz-line-strategy.md"
106
+ },
107
+ {
108
+ "name": "biz-line-del",
109
+ "displayName": "删除业务线",
110
+ "description": "⚠️ 写操作:按 ID 删除业务线,成功时 result 为 Boolean",
111
+ "group": "业务线策略",
112
+ "method": "POST",
113
+ "path": "/sino-opti-hive/biz-line/del",
114
+ "timeout": 20000,
115
+ "tag": "业务线策略",
116
+ "domain": "biz-line",
117
+ "shortcut": "+delete",
118
+ "risk": "write",
119
+ "summary": "删除业务线",
120
+ "docFile": "biz-line-strategy.md"
121
+ },
122
+ {
123
+ "name": "biz-line-list-export",
124
+ "displayName": "业务线列表导出",
125
+ "description": "导出筛选条件下所有业务线数据,result 为 Excel 文件访问 URL",
126
+ "group": "业务线策略",
127
+ "method": "POST",
128
+ "path": "/sino-opti-hive/biz-line/list/export",
129
+ "timeout": 20000,
130
+ "tag": "业务线策略",
131
+ "domain": "biz-line",
132
+ "shortcut": "+export",
133
+ "risk": "write",
134
+ "summary": "业务线列表导出",
135
+ "docFile": "biz-line-strategy.md"
136
+ },
137
+ {
138
+ "name": "biz-line-strategy-list",
139
+ "displayName": "全部策略分页",
140
+ "description": "按业务线分页查周策略,result 为 BizLineStrategyDetailVO 分页对象",
141
+ "group": "业务线策略",
142
+ "method": "POST",
143
+ "path": "/sino-opti-hive/biz-line/strategy/list",
144
+ "timeout": 20000,
145
+ "tag": "业务线策略",
146
+ "domain": "biz-line",
147
+ "shortcut": "+strategies",
148
+ "risk": "read",
149
+ "summary": "全部策略分页",
150
+ "docFile": "biz-line-strategy.md"
151
+ },
152
+ {
153
+ "name": "biz-line-strategy-detail",
154
+ "displayName": "策略详情(编辑返显)",
155
+ "description": "result 为 BizLineStrategyDetailVO,含标签展示文案与乐观锁版本号",
156
+ "group": "业务线策略",
157
+ "method": "POST",
158
+ "path": "/sino-opti-hive/biz-line/strategy/detail",
159
+ "timeout": 20000,
160
+ "tag": "业务线策略",
161
+ "domain": "biz-line",
162
+ "shortcut": "+strategy-detail",
163
+ "risk": "write",
164
+ "summary": "策略详情(编辑返显)",
165
+ "docFile": "biz-line-strategy.md"
166
+ },
167
+ {
168
+ "name": "biz-line-strategy-period-list",
169
+ "displayName": "策略周期列表",
170
+ "description": "按业务线返回全部策略周期,result 含 items 与 total",
171
+ "group": "业务线策略",
172
+ "method": "POST",
173
+ "path": "/sino-opti-hive/biz-line/strategy/period-list",
174
+ "timeout": 20000,
175
+ "tag": "业务线策略",
176
+ "domain": "biz-line",
177
+ "shortcut": "+period-list",
178
+ "risk": "write",
179
+ "summary": "策略周期列表",
180
+ "docFile": "biz-line-strategy.md"
181
+ },
182
+ {
183
+ "name": "biz-line-strategy-preview-info",
184
+ "displayName": "新建策略前置-上期摘要",
185
+ "description": "按目标周期取上期策略摘要,periodExist 标识目标周期是否已有数据",
186
+ "group": "业务线策略",
187
+ "method": "POST",
188
+ "path": "/sino-opti-hive/biz-line/strategy/preview-info",
189
+ "timeout": 20000,
190
+ "tag": "业务线策略",
191
+ "domain": "biz-line",
192
+ "shortcut": "+preview-info",
193
+ "risk": "write",
194
+ "summary": "新建策略前置-上期摘要",
195
+ "docFile": "biz-line-strategy.md"
196
+ },
197
+ {
198
+ "name": "biz-line-strategy-save",
199
+ "displayName": "新建策略",
200
+ "description": "⚠️ 写操作:新建业务线周策略,成功时 result 为 Boolean",
201
+ "group": "业务线策略",
202
+ "method": "POST",
203
+ "path": "/sino-opti-hive/biz-line/strategy/save",
204
+ "timeout": 20000,
205
+ "tag": "业务线策略",
206
+ "domain": "biz-line",
207
+ "shortcut": "+strategy-save",
208
+ "risk": "write",
209
+ "summary": "新建策略",
210
+ "docFile": "biz-line-strategy.md"
211
+ },
212
+ {
213
+ "name": "biz-line-strategy-update",
214
+ "displayName": "编辑策略",
215
+ "description": "⚠️ 写操作:按策略 ID 编辑,version 为乐观锁,overwrite=true 强制覆盖",
216
+ "group": "业务线策略",
217
+ "method": "POST",
218
+ "path": "/sino-opti-hive/biz-line/strategy/update",
219
+ "timeout": 20000,
220
+ "tag": "业务线策略",
221
+ "domain": "biz-line",
222
+ "shortcut": "+strategy-update",
223
+ "risk": "write",
224
+ "summary": "编辑策略",
225
+ "docFile": "biz-line-strategy.md"
226
+ },
227
+ {
228
+ "name": "biz-line-strategy-del",
229
+ "displayName": "删除策略",
230
+ "description": "⚠️ 写操作:按策略 ID 删除,成功时 result 为 Boolean",
231
+ "group": "业务线策略",
232
+ "method": "POST",
233
+ "path": "/sino-opti-hive/biz-line/strategy/del",
234
+ "timeout": 20000,
235
+ "tag": "业务线策略",
236
+ "domain": "biz-line",
237
+ "shortcut": "+strategy-delete",
238
+ "risk": "write",
239
+ "summary": "删除策略",
240
+ "docFile": "biz-line-strategy.md"
241
+ },
242
+ {
243
+ "name": "biz-line-strategy-compare",
244
+ "displayName": "策略对比",
245
+ "description": "对比两期策略,diffFields 给出存在差异的字段名列表",
246
+ "group": "业务线策略",
247
+ "method": "POST",
248
+ "path": "/sino-opti-hive/biz-line/strategy/compare",
249
+ "timeout": 20000,
250
+ "tag": "业务线策略",
251
+ "domain": "biz-line",
252
+ "shortcut": "+compare",
253
+ "risk": "write",
254
+ "summary": "策略对比",
255
+ "docFile": "biz-line-strategy.md"
256
+ },
257
+ {
258
+ "name": "biz-line-strategy-spend",
259
+ "displayName": "策略周期消耗汇总",
260
+ "description": "按策略 ID 汇总周期内关联项目消耗,result 含 totalSpend",
261
+ "group": "业务线策略",
262
+ "method": "POST",
263
+ "path": "/sino-opti-hive/biz-line/strategy/spend",
264
+ "timeout": 20000,
265
+ "tag": "业务线策略",
266
+ "domain": "biz-line",
267
+ "shortcut": "+spend",
268
+ "risk": "write",
269
+ "summary": "策略周期消耗汇总",
270
+ "docFile": "biz-line-strategy.md"
271
+ },
272
+ {
273
+ "name": "biz-line-strategy-exprot-all",
274
+ "displayName": "导出全部策略",
275
+ "description": "导出该业务线全部策略,result 为文件访问 URL(服务端路径拼写为 exprot-all)",
276
+ "group": "业务线策略",
277
+ "method": "POST",
278
+ "path": "/sino-opti-hive/biz-line/strategy/exprot-all",
279
+ "timeout": 20000,
280
+ "tag": "业务线策略",
281
+ "domain": "biz-line",
282
+ "shortcut": "+exprot-all",
283
+ "risk": "write",
284
+ "summary": "导出全部策略",
285
+ "docFile": "biz-line-strategy.md"
286
+ }
287
+ ]