tencentcloud-sdk-nodejs 4.0.434 → 4.0.435

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.
Files changed (51) hide show
  1. package/CHANGELOG.md +256 -0
  2. package/SERVICE_CHANGELOG.md +379 -38
  3. package/package.json +1 -1
  4. package/products.md +12 -12
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/as/v20180419/as_client.ts +3 -1
  7. package/src/services/as/v20180419/as_models.ts +16 -6
  8. package/src/services/asr/v20190614/asr_models.ts +11 -8
  9. package/src/services/cynosdb/v20190107/cynosdb_models.ts +1 -1
  10. package/src/services/es/v20180416/es_models.ts +11 -0
  11. package/src/services/ess/v20201111/ess_client.ts +43 -11
  12. package/src/services/ess/v20201111/ess_models.ts +289 -57
  13. package/src/services/faceid/v20180301/faceid_models.ts +5 -0
  14. package/src/services/live/v20180801/live_client.ts +1 -1
  15. package/src/services/monitor/v20180724/monitor_models.ts +12 -0
  16. package/src/services/trp/v20210515/trp_models.ts +5 -0
  17. package/src/services/vm/index.ts +2 -0
  18. package/src/services/vm/v20210922/index.ts +6 -0
  19. package/src/services/vm/v20210922/vm_client.ts +100 -0
  20. package/src/services/vm/v20210922/vm_models.ts +1023 -0
  21. package/src/services/vod/v20180717/vod_models.ts +9 -0
  22. package/src/services/waf/v20180125/waf_client.ts +2 -1
  23. package/src/services/waf/v20180125/waf_models.ts +133 -91
  24. package/tencentcloud/common/sdk_version.d.ts +1 -1
  25. package/tencentcloud/common/sdk_version.js +1 -1
  26. package/tencentcloud/services/as/v20180419/as_client.d.ts +3 -1
  27. package/tencentcloud/services/as/v20180419/as_client.js +3 -1
  28. package/tencentcloud/services/as/v20180419/as_models.d.ts +14 -6
  29. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +10 -8
  30. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +1 -1
  31. package/tencentcloud/services/es/v20180416/es_models.d.ts +9 -0
  32. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +19 -6
  33. package/tencentcloud/services/ess/v20201111/ess_client.js +23 -6
  34. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +244 -49
  35. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +4 -0
  36. package/tencentcloud/services/live/v20180801/live_client.d.ts +1 -1
  37. package/tencentcloud/services/live/v20180801/live_client.js +1 -1
  38. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +10 -0
  39. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +4 -0
  40. package/tencentcloud/services/vm/index.d.ts +4 -0
  41. package/tencentcloud/services/vm/index.js +2 -0
  42. package/tencentcloud/services/vm/v20210922/index.d.ts +6 -0
  43. package/tencentcloud/services/vm/v20210922/index.js +9 -0
  44. package/tencentcloud/services/vm/v20210922/vm_client.d.ts +28 -0
  45. package/tencentcloud/services/vm/v20210922/vm_client.js +57 -0
  46. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +866 -0
  47. package/tencentcloud/services/vm/v20210922/vm_models.js +18 -0
  48. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +8 -0
  49. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +110 -75
  50. package/test/ess.v20201111.test.js +22 -2
  51. package/test/vm.v20210922.test.js +61 -0
@@ -3838,6 +3838,15 @@ export interface ProductInstance {
3838
3838
  <li>Denied:不可退款。</li>
3839
3839
  */
3840
3840
  RefundStatus: string
3841
+
3842
+ /**
3843
+ * 自动续费状态,取值有:
3844
+ <li>Never:不自动续费。</li>
3845
+ <li>Expire:到期自动续费。</li>
3846
+ <li>ExpireOrUseOut:到期或用完自动续费。</li>
3847
+ <li>NotSupport:不支持。</li>
3848
+ */
3849
+ RenewStatus: string
3841
3850
  }
3842
3851
 
3843
3852
  /**
@@ -76,13 +76,14 @@ import {
76
76
  ModifyCustomRuleStatusRequest,
77
77
  DeleteDownloadRecordResponse,
78
78
  ModifyAccessPeriodRequest,
79
- InstanceInfo,
79
+ BotQPS,
80
80
  ModifyWafAutoDenyRulesResponse,
81
81
  DescribeInstancesRequest,
82
82
  CdcRegion,
83
83
  AccessValueInfo,
84
84
  DeleteIpAccessControlResponse,
85
85
  AccessLogInfo,
86
+ InstanceInfo,
86
87
  AccessKeyValueInfo,
87
88
  AddCustomRuleRequest,
88
89
  FraudPkg,
@@ -1292,115 +1292,33 @@ export interface ModifyAccessPeriodRequest {
1292
1292
  }
1293
1293
 
1294
1294
  /**
1295
- * 一个实例的详细信息
1295
+ * bot的qps详情
1296
1296
  */
1297
- export interface InstanceInfo {
1298
- /**
1299
- * id
1300
- */
1301
- InstanceId: string
1302
-
1303
- /**
1304
- * name
1305
- */
1306
- InstanceName: string
1307
-
1297
+ export interface BotQPS {
1308
1298
  /**
1309
1299
  * 资源id
1310
1300
  */
1311
1301
  ResourceIds: string
1312
1302
 
1313
1303
  /**
1314
- * 地域
1315
- */
1316
- Region: string
1317
-
1318
- /**
1319
- * 付费模式
1320
- */
1321
- PayMode: number
1322
-
1323
- /**
1324
- * 自动续费
1325
- */
1326
- RenewFlag: number
1327
-
1328
- /**
1329
- * 弹性计费
1330
- */
1331
- Mode: number
1332
-
1333
- /**
1334
- * 套餐版本
1335
- */
1336
- Level: number
1337
-
1338
- /**
1339
- * 过期时间
1304
+ * 有效时间
1340
1305
  */
1341
1306
  ValidTime: string
1342
1307
 
1343
1308
  /**
1344
- * 开始时间
1345
- */
1346
- BeginTime: string
1347
-
1348
- /**
1349
- * 已用
1350
- */
1351
- DomainCount: number
1352
-
1353
- /**
1354
- * 上限
1355
- */
1356
- SubDomainLimit: number
1357
-
1358
- /**
1359
- * 已用
1309
+ * 资源数量
1360
1310
  */
1361
- MainDomainCount: number
1362
-
1363
- /**
1364
- * 上限
1365
- */
1366
- MainDomainLimit: number
1367
-
1368
- /**
1369
- * 峰值
1370
- */
1371
- MaxQPS: number
1372
-
1373
- /**
1374
- * qps套餐
1375
- */
1376
- QPS: QPSPackageNew
1377
-
1378
- /**
1379
- * 域名套餐
1380
- */
1381
- DomainPkg: DomainPackageNew
1311
+ Count: number
1382
1312
 
1383
1313
  /**
1384
- * 用户appid
1314
+ * 资源所在地区
1385
1315
  */
1386
- AppId: number
1316
+ Region: string
1387
1317
 
1388
1318
  /**
1389
- * clb或saas
1319
+ * 使用qps的最大值
1390
1320
  */
1391
- Edition: string
1392
-
1393
- /**
1394
- * 业务安全包
1395
- 注意:此字段可能返回 null,表示取不到有效值。
1396
- */
1397
- FraudPkg?: FraudPkg
1398
-
1399
- /**
1400
- * Bot资源包
1401
- 注意:此字段可能返回 null,表示取不到有效值。
1402
- */
1403
- BotPkg?: BotPkg
1321
+ MaxBotQPS: number
1404
1322
  }
1405
1323
 
1406
1324
  /**
@@ -1560,6 +1478,124 @@ export interface AccessLogInfo {
1560
1478
  LogJson: string
1561
1479
  }
1562
1480
 
1481
+ /**
1482
+ * 一个实例的详细信息
1483
+ */
1484
+ export interface InstanceInfo {
1485
+ /**
1486
+ * id
1487
+ */
1488
+ InstanceId: string
1489
+
1490
+ /**
1491
+ * name
1492
+ */
1493
+ InstanceName: string
1494
+
1495
+ /**
1496
+ * 资源id
1497
+ */
1498
+ ResourceIds: string
1499
+
1500
+ /**
1501
+ * 地域
1502
+ */
1503
+ Region: string
1504
+
1505
+ /**
1506
+ * 付费模式
1507
+ */
1508
+ PayMode: number
1509
+
1510
+ /**
1511
+ * 自动续费
1512
+ */
1513
+ RenewFlag: number
1514
+
1515
+ /**
1516
+ * 弹性计费
1517
+ */
1518
+ Mode: number
1519
+
1520
+ /**
1521
+ * 套餐版本
1522
+ */
1523
+ Level: number
1524
+
1525
+ /**
1526
+ * 过期时间
1527
+ */
1528
+ ValidTime: string
1529
+
1530
+ /**
1531
+ * 开始时间
1532
+ */
1533
+ BeginTime: string
1534
+
1535
+ /**
1536
+ * 已用
1537
+ */
1538
+ DomainCount: number
1539
+
1540
+ /**
1541
+ * 上限
1542
+ */
1543
+ SubDomainLimit: number
1544
+
1545
+ /**
1546
+ * 已用
1547
+ */
1548
+ MainDomainCount: number
1549
+
1550
+ /**
1551
+ * 上限
1552
+ */
1553
+ MainDomainLimit: number
1554
+
1555
+ /**
1556
+ * 峰值
1557
+ */
1558
+ MaxQPS: number
1559
+
1560
+ /**
1561
+ * qps套餐
1562
+ */
1563
+ QPS: QPSPackageNew
1564
+
1565
+ /**
1566
+ * 域名套餐
1567
+ */
1568
+ DomainPkg: DomainPackageNew
1569
+
1570
+ /**
1571
+ * 用户appid
1572
+ */
1573
+ AppId: number
1574
+
1575
+ /**
1576
+ * clb或saas
1577
+ */
1578
+ Edition: string
1579
+
1580
+ /**
1581
+ * 业务安全包
1582
+ 注意:此字段可能返回 null,表示取不到有效值。
1583
+ */
1584
+ FraudPkg?: FraudPkg
1585
+
1586
+ /**
1587
+ * Bot资源包
1588
+ 注意:此字段可能返回 null,表示取不到有效值。
1589
+ */
1590
+ BotPkg?: BotPkg
1591
+
1592
+ /**
1593
+ * bot的qps详情
1594
+ 注意:此字段可能返回 null,表示取不到有效值。
1595
+ */
1596
+ BotQPS?: BotQPS
1597
+ }
1598
+
1563
1599
  /**
1564
1600
  * 用于 DescribeAccessIndex 的出参
1565
1601
  */
@@ -2479,6 +2515,12 @@ export interface BotPkg {
2479
2515
  注意:此字段可能返回 null,表示取不到有效值。
2480
2516
  */
2481
2517
  UsedNum?: number
2518
+
2519
+ /**
2520
+ * 子产品code
2521
+ 注意:此字段可能返回 null,表示取不到有效值。
2522
+ */
2523
+ Type?: string
2482
2524
  }
2483
2525
 
2484
2526
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.434";
1
+ export declare const sdkVersion = "4.0.435";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.434";
4
+ exports.sdkVersion = "4.0.435";
@@ -222,7 +222,9 @@ export declare class Client extends AbstractClient {
222
222
  /**
223
223
  * 本接口(CreateLifecycleHook)用于创建生命周期挂钩。
224
224
 
225
- * 您可以为生命周期挂钩配置消息通知,弹性伸缩会通知您的CMQ消息队列,通知内容形如:
225
+ * 您可以为生命周期挂钩配置消息通知或执行自动化助手命令。
226
+
227
+ 如果您配置了通知消息,弹性伸缩会通知您的TDMQ消息队列,通知内容形如:
226
228
 
227
229
  ```
228
230
  {
@@ -308,7 +308,9 @@ class Client extends abstract_client_1.AbstractClient {
308
308
  /**
309
309
  * 本接口(CreateLifecycleHook)用于创建生命周期挂钩。
310
310
 
311
- * 您可以为生命周期挂钩配置消息通知,弹性伸缩会通知您的CMQ消息队列,通知内容形如:
311
+ * 您可以为生命周期挂钩配置消息通知或执行自动化助手命令。
312
+
313
+ 如果您配置了通知消息,弹性伸缩会通知您的TDMQ消息队列,通知内容形如:
312
314
 
313
315
  ```
314
316
  {
@@ -1347,17 +1347,21 @@ export interface UpgradeLifecycleHookRequest {
1347
1347
  */
1348
1348
  HeartbeatTimeout?: number;
1349
1349
  /**
1350
- * 弹性伸缩向通知目标发送的附加信息,默认值为空字符串""
1350
+ * 弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串""
1351
1351
  */
1352
1352
  NotificationMetadata?: string;
1353
1353
  /**
1354
- * 通知目标
1354
+ * 通知目标。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
1355
1355
  */
1356
1356
  NotificationTarget?: NotificationTarget;
1357
1357
  /**
1358
1358
  * 进行生命周期挂钩的场景类型,取值范围包括NORMAL 和 EXTENSION。说明:设置为EXTENSION值,在AttachInstances、DetachInstances、RemoveInstaces接口时会触发生命周期挂钩操作,值为NORMAL则不会在这些接口中触发生命周期挂钩。
1359
1359
  */
1360
1360
  LifecycleTransitionType?: string;
1361
+ /**
1362
+ * 远程命令执行对象。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
1363
+ */
1364
+ LifecycleCommand?: LifecycleCommand;
1361
1365
  }
1362
1366
  /**
1363
1367
  * DetachLoadBalancers返回参数结构体
@@ -2297,11 +2301,11 @@ export interface CreateLifecycleHookRequest {
2297
2301
  */
2298
2302
  HeartbeatTimeout?: number;
2299
2303
  /**
2300
- * 弹性伸缩向通知目标发送的附加信息,默认值为空字符串""。最大长度不能超过1024个字节。
2304
+ * 弹性伸缩向通知目标发送的附加信息,配置通知时使用,默认值为空字符串""。最大长度不能超过1024个字节。
2301
2305
  */
2302
2306
  NotificationMetadata?: string;
2303
2307
  /**
2304
- * 通知目标
2308
+ * 通知目标。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
2305
2309
  */
2306
2310
  NotificationTarget?: NotificationTarget;
2307
2311
  /**
@@ -2309,7 +2313,7 @@ export interface CreateLifecycleHookRequest {
2309
2313
  */
2310
2314
  LifecycleTransitionType?: string;
2311
2315
  /**
2312
- * 远程命令执行对象。NotificationTarget和CommandInfo参数互斥,二者不可同时指定。
2316
+ * 远程命令执行对象。NotificationTarget和LifecycleCommand参数互斥,二者不可同时指定。
2313
2317
  */
2314
2318
  LifecycleCommand?: LifecycleCommand;
2315
2319
  }
@@ -2402,6 +2406,10 @@ export interface ModifyLifecycleHookRequest {
2402
2406
  * 通知目标信息。
2403
2407
  */
2404
2408
  NotificationTarget?: NotificationTarget;
2409
+ /**
2410
+ * 远程命令执行对象。
2411
+ */
2412
+ LifecycleCommand?: LifecycleCommand;
2405
2413
  }
2406
2414
  /**
2407
2415
  * CompleteLifecycleAction返回参数结构体
@@ -2716,7 +2724,7 @@ export interface LifecycleActionResultInfo {
2716
2724
  */
2717
2725
  InvokeCommandResult: string;
2718
2726
  /**
2719
- * 通知的结果,表示通知CMQ/TCMQ是否成功。<br>
2727
+ * 通知的结果,表示通知CMQ/TDMQ是否成功。<br>
2720
2728
  <li>SUCCESSFUL 通知成功</li>
2721
2729
  <li>FAILED 通知失败</li>
2722
2730
  <li>NONE</li>
@@ -171,7 +171,7 @@ export interface DescribeTaskStatusResponse {
171
171
  */
172
172
  export interface SentenceRecognitionRequest {
173
173
  /**
174
- * 腾讯云项目 ID,可填 0,总长度不超过 1024 字节。
174
+ * 腾讯云项目 ID,废弃参数,默认填写0即可。
175
175
  */
176
176
  ProjectId: number;
177
177
  /**
@@ -189,7 +189,6 @@ export interface SentenceRecognitionRequest {
189
189
  • 16k_ca:16k 粤语;
190
190
  • 16k_ja:16k 日语;
191
191
  • 16k_zh_medical:16k 医疗;
192
- • 16k_zh_dialect:多方言,支持23种方言。
193
192
  */
194
193
  EngSerViceType: string;
195
194
  /**
@@ -201,7 +200,7 @@ export interface SentenceRecognitionRequest {
201
200
  */
202
201
  VoiceFormat: string;
203
202
  /**
204
- * 用户端对此任务的唯一标识,用户自助生成,用于用户查找识别结果。
203
+ * 用户端对此任务的唯一标识。废弃参数,忽略即可。
205
204
  */
206
205
  UsrAudioKey: string;
207
206
  /**
@@ -217,9 +216,9 @@ export interface SentenceRecognitionRequest {
217
216
  */
218
217
  DataLen?: number;
219
218
  /**
220
- * 热词id。用于调用对应的热词表,如果在调用语音识别服务时,不进行单独的热词id设置,自动生效默认热词;如果进行了单独的热词id设置,那么将生效单独设置的热词id
219
+ * 是否显示词级别时间戳。0:不显示;1:显示,不包含标点时间戳,2:显示,包含标点时间戳。默认值为 0
221
220
  */
222
- HotwordId?: string;
221
+ WordInfo?: number;
223
222
  /**
224
223
  * 是否过滤脏词(目前支持中文普通话引擎)。0:不过滤脏词;1:过滤脏词;2:将脏词替换为 * 。默认值为 0。
225
224
  */
@@ -237,9 +236,13 @@ export interface SentenceRecognitionRequest {
237
236
  */
238
237
  ConvertNumMode?: number;
239
238
  /**
240
- * 是否显示词级别时间戳。0:不显示;1:显示,不包含标点时间戳,2:显示,包含标点时间戳。默认值为 0
239
+ * 热词id。用于调用对应的热词表,如果在调用语音识别服务时,不进行单独的热词id设置,自动生效默认热词;如果进行了单独的热词id设置,那么将生效单独设置的热词id
241
240
  */
242
- WordInfo?: number;
241
+ HotwordId?: string;
242
+ /**
243
+ * 自学习模型 id。如设置了该参数,将生效对应的自学习模型。
244
+ */
245
+ CustomizationId?: string;
243
246
  }
244
247
  /**
245
248
  * CloseAsyncRecognitionTask返回参数结构体
@@ -381,7 +384,6 @@ export interface CreateRecTaskRequest {
381
384
  • 16k_en_edu 英文教育;
382
385
  • 16k_zh_medical 医疗;
383
386
  • 16k_th 泰语;
384
- • 16k_zh_dialect:多方言,支持23种方言。
385
387
  */
386
388
  EngineModelType: string;
387
389
  /**
@@ -1968,7 +1968,7 @@ export interface InquirePriceCreateRequest {
1968
1968
  */
1969
1969
  Zone: string;
1970
1970
  /**
1971
- * 购买商品数量
1971
+ * 购买计算节点个数
1972
1972
  */
1973
1973
  GoodsNum: number;
1974
1974
  /**
@@ -1665,6 +1665,10 @@ export interface CreateInstanceRequest {
1665
1665
  * 可维护时间段
1666
1666
  */
1667
1667
  OperationDuration?: OperationDuration;
1668
+ /**
1669
+ * 是否开启存算分离
1670
+ */
1671
+ EnableHybridStorage?: boolean;
1668
1672
  }
1669
1673
  /**
1670
1674
  * CreateLogstashInstance请求参数结构体
@@ -2111,6 +2115,11 @@ RENEW_FLAG_DEFAULT:不自动续费
2111
2115
  注意:此字段可能返回 null,表示取不到有效值。
2112
2116
  */
2113
2117
  AutoIndexEnabled: boolean;
2118
+ /**
2119
+ * 是否支持存储计算分离
2120
+ 注意:此字段可能返回 null,表示取不到有效值。
2121
+ */
2122
+ EnableHybridStorage: boolean;
2114
2123
  }
2115
2124
  /**
2116
2125
  * DeleteIndex返回参数结构体
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
3
+ import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, CreateFlowApproversResponse, DescribeFlowInfoRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, UploadFilesRequest, StartFlowResponse, GetTaskResultApiRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, DescribeFlowInfoResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse, CreateFlowApproversRequest } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -12,6 +12,11 @@ export declare class Client extends AbstractClient {
12
12
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
13
13
  */
14
14
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
15
+ /**
16
+ * 查询合同详情
17
+ 适用场景:可用于主动查询某个合同详情信息。
18
+ */
19
+ DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
15
20
  /**
16
21
  * 此接口用于发起流程
17
22
  适用场景:见创建签署流程接口。
@@ -58,6 +63,13 @@ export declare class Client extends AbstractClient {
58
63
  注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
59
64
  */
60
65
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
66
+ /**
67
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
68
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
69
+ 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
70
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
71
+ */
72
+ CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
61
73
  /**
62
74
  * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
63
75
  */
@@ -101,12 +113,13 @@ export declare class Client extends AbstractClient {
101
113
  */
102
114
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
103
115
  /**
104
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
105
- 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
106
- 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
107
- 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
116
+ * 补充签署流程本企业签署人信息
117
+ 适用场景:在通过模版或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
118
+ 同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
119
+
120
+ 注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
108
121
  */
109
- CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
122
+ CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
110
123
  /**
111
124
  * 此接口(UploadFiles)用于文件上传。
112
125
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
@@ -34,6 +34,13 @@ class Client extends abstract_client_1.AbstractClient {
34
34
  async DescribeFileUrls(req, cb) {
35
35
  return this.request("DescribeFileUrls", req, cb);
36
36
  }
37
+ /**
38
+ * 查询合同详情
39
+ 适用场景:可用于主动查询某个合同详情信息。
40
+ */
41
+ async DescribeFlowInfo(req, cb) {
42
+ return this.request("DescribeFlowInfo", req, cb);
43
+ }
37
44
  /**
38
45
  * 此接口用于发起流程
39
46
  适用场景:见创建签署流程接口。
@@ -96,6 +103,15 @@ class Client extends abstract_client_1.AbstractClient {
96
103
  async CreateFlow(req, cb) {
97
104
  return this.request("CreateFlow", req, cb);
98
105
  }
106
+ /**
107
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
108
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
109
+ 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
110
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
111
+ */
112
+ async CreateFlowByFiles(req, cb) {
113
+ return this.request("CreateFlowByFiles", req, cb);
114
+ }
99
115
  /**
100
116
  * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
101
117
  */
@@ -153,13 +169,14 @@ class Client extends abstract_client_1.AbstractClient {
153
169
  return this.request("DescribeFlowBriefs", req, cb);
154
170
  }
155
171
  /**
156
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
157
- 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
158
- 适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
159
- 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
172
+ * 补充签署流程本企业签署人信息
173
+ 适用场景:在通过模版或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
174
+ 同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
175
+
176
+ 注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
160
177
  */
161
- async CreateFlowByFiles(req, cb) {
162
- return this.request("CreateFlowByFiles", req, cb);
178
+ async CreateFlowApprovers(req, cb) {
179
+ return this.request("CreateFlowApprovers", req, cb);
163
180
  }
164
181
  /**
165
182
  * 此接口(UploadFiles)用于文件上传。