tencentcloud-sdk-nodejs 4.0.981 → 4.0.983

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 (108) hide show
  1. package/CHANGELOG.md +823 -0
  2. package/SERVICE_CHANGELOG.md +1172 -145
  3. package/package.json +1 -1
  4. package/products.md +33 -33
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_client.ts +47 -22
  7. package/src/services/apigateway/v20180808/apigateway_models.ts +187 -81
  8. package/src/services/as/v20180419/as_models.ts +11 -6
  9. package/src/services/batch/v20170312/batch_models.ts +17 -34
  10. package/src/services/bi/v20220105/bi_client.ts +37 -9
  11. package/src/services/bi/v20220105/bi_models.ts +240 -47
  12. package/src/services/billing/v20180709/billing_models.ts +58 -37
  13. package/src/services/bpaas/v20181217/bpaas_models.ts +20 -20
  14. package/src/services/cam/v20190116/cam_models.ts +27 -27
  15. package/src/services/cbs/v20170312/cbs_models.ts +1 -1
  16. package/src/services/cdwch/v20200915/cdwch_models.ts +1 -1
  17. package/src/services/cloudhsm/v20191112/cloudhsm_models.ts +40 -120
  18. package/src/services/cls/v20201016/cls_client.ts +1 -1
  19. package/src/services/cls/v20201016/cls_models.ts +5 -2
  20. package/src/services/config/v20220802/config_client.ts +29 -3
  21. package/src/services/config/v20220802/config_models.ts +226 -41
  22. package/src/services/cvm/v20170312/cvm_models.ts +17 -34
  23. package/src/services/cwp/v20180228/cwp_models.ts +1 -1
  24. package/src/services/cynosdb/v20190107/cynosdb_models.ts +2 -2
  25. package/src/services/ess/v20201111/ess_models.ts +105 -1
  26. package/src/services/essbasic/v20210526/essbasic_models.ts +110 -1
  27. package/src/services/gwlb/v20240906/gwlb_models.ts +1 -1
  28. package/src/services/hunyuan/v20230901/hunyuan_models.ts +2 -2
  29. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +11 -4
  30. package/src/services/ivld/v20210903/ivld_client.ts +0 -1
  31. package/src/services/ivld/v20210903/ivld_models.ts +1 -1
  32. package/src/services/lcic/v20220817/lcic_client.ts +25 -1
  33. package/src/services/lcic/v20220817/lcic_models.ts +240 -104
  34. package/src/services/live/v20180801/live_client.ts +152 -53
  35. package/src/services/live/v20180801/live_models.ts +443 -110
  36. package/src/services/lke/v20231130/lke_client.ts +1 -1
  37. package/src/services/mps/v20190612/mps_models.ts +0 -1
  38. package/src/services/mrs/v20200910/mrs_models.ts +146 -1472
  39. package/src/services/ocr/v20181119/ocr_client.ts +869 -972
  40. package/src/services/ocr/v20181119/ocr_models.ts +77 -681
  41. package/src/services/organization/v20181225/organization_models.ts +20 -20
  42. package/src/services/organization/v20210331/organization_models.ts +42 -206
  43. package/src/services/teo/v20220901/teo_client.ts +40 -4
  44. package/src/services/teo/v20220901/teo_models.ts +147 -46
  45. package/src/services/trtc/v20190722/trtc_client.ts +32 -7
  46. package/src/services/trtc/v20190722/trtc_models.ts +106 -42
  47. package/tencentcloud/common/sdk_version.d.ts +1 -1
  48. package/tencentcloud/common/sdk_version.js +1 -1
  49. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +16 -8
  50. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +22 -10
  51. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +182 -81
  52. package/tencentcloud/services/as/v20180419/as_models.d.ts +11 -6
  53. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +17 -34
  54. package/tencentcloud/services/bi/v20220105/bi_client.d.ts +11 -3
  55. package/tencentcloud/services/bi/v20220105/bi_client.js +15 -3
  56. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +231 -46
  57. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +51 -30
  58. package/tencentcloud/services/bpaas/v20181217/bpaas_models.d.ts +20 -20
  59. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +27 -27
  60. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +1 -1
  61. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +1 -1
  62. package/tencentcloud/services/cloudhsm/v20191112/cloudhsm_models.d.ts +40 -120
  63. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  64. package/tencentcloud/services/cls/v20201016/cls_client.js +1 -1
  65. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +5 -2
  66. package/tencentcloud/services/config/v20220802/config_client.d.ts +9 -1
  67. package/tencentcloud/services/config/v20220802/config_client.js +12 -0
  68. package/tencentcloud/services/config/v20220802/config_models.d.ts +219 -40
  69. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +17 -34
  70. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +1 -1
  71. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +2 -2
  72. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +105 -1
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +110 -1
  74. package/tencentcloud/services/gwlb/v20240906/gwlb_models.d.ts +1 -1
  75. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +2 -2
  76. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +11 -4
  77. package/tencentcloud/services/ivld/v20210903/ivld_client.d.ts +0 -1
  78. package/tencentcloud/services/ivld/v20210903/ivld_client.js +0 -1
  79. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +1 -1
  80. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +9 -1
  81. package/tencentcloud/services/lcic/v20220817/lcic_client.js +12 -0
  82. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +236 -104
  83. package/tencentcloud/services/live/v20180801/live_client.d.ts +48 -15
  84. package/tencentcloud/services/live/v20180801/live_client.js +70 -21
  85. package/tencentcloud/services/live/v20180801/live_models.d.ts +424 -109
  86. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -1
  87. package/tencentcloud/services/lke/v20231130/lke_client.js +1 -1
  88. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +0 -1
  89. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +146 -1472
  90. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +529 -567
  91. package/tencentcloud/services/ocr/v20181119/ocr_client.js +682 -736
  92. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +86 -673
  93. package/tencentcloud/services/organization/v20181225/organization_models.d.ts +20 -20
  94. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +41 -205
  95. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +13 -1
  96. package/tencentcloud/services/teo/v20220901/teo_client.js +18 -0
  97. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +141 -46
  98. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +12 -3
  99. package/tencentcloud/services/trtc/v20190722/trtc_client.js +16 -3
  100. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +102 -42
  101. package/test/apigateway.v20180808.test.js +32 -12
  102. package/test/bi.v20220105.test.js +22 -2
  103. package/test/config.v20220802.test.js +20 -0
  104. package/test/lcic.v20220817.test.js +20 -0
  105. package/test/live.v20180801.test.js +94 -14
  106. package/test/ocr.v20181119.test.js +156 -236
  107. package/test/teo.v20220901.test.js +30 -0
  108. package/test/trtc.v20190722.test.js +22 -2
@@ -1,3 +1,99 @@
1
+ /**
2
+ * 资源列列表信息
3
+ */
4
+ export interface ResourceListInfo {
5
+ /**
6
+ * 资源类型
7
+ */
8
+ ResourceType: string;
9
+ /**
10
+ * 资源名称
11
+ */
12
+ ResourceName: string;
13
+ /**
14
+ * 资源ID
15
+ */
16
+ ResourceId: string;
17
+ /**
18
+ * 地域
19
+ 注意:此字段可能返回 null,表示取不到有效值。
20
+ */
21
+ ResourceRegion: string;
22
+ /**
23
+ * 资源状态
24
+ 注意:此字段可能返回 null,表示取不到有效值。
25
+ */
26
+ ResourceStatus: string;
27
+ /**
28
+ * 1 :已删除 2:未删除
29
+ 注意:此字段可能返回 null,表示取不到有效值。
30
+ */
31
+ ResourceDelete: number;
32
+ /**
33
+ * 资源创建时间
34
+ 注意:此字段可能返回 null,表示取不到有效值。
35
+ */
36
+ ResourceCreateTime: string;
37
+ /**
38
+ * 标签信息
39
+ 注意:此字段可能返回 null,表示取不到有效值。
40
+ */
41
+ Tags: Array<Tag>;
42
+ /**
43
+ * 可用区
44
+ 注意:此字段可能返回 null,表示取不到有效值。
45
+ */
46
+ ResourceZone: string;
47
+ /**
48
+ * 合规状态
49
+ 注意:此字段可能返回 null,表示取不到有效值。
50
+ */
51
+ ComplianceResult: string;
52
+ }
53
+ /**
54
+ * ListAggregateConfigRules请求参数结构体
55
+ */
56
+ export interface ListAggregateConfigRulesRequest {
57
+ /**
58
+ * 每页限制
59
+ */
60
+ Limit: number;
61
+ /**
62
+ * 偏移量
63
+ */
64
+ Offset: number;
65
+ /**
66
+ * 账号组ID
67
+ */
68
+ AccountGroupId: string;
69
+ /**
70
+ * 排序类型, 倒序:desc,顺序:asc
71
+ */
72
+ OrderType?: string;
73
+ /**
74
+ * 风险等级
75
+ 1:高风险。
76
+ 2:中风险。
77
+ 3:低风险。
78
+ */
79
+ RiskLevel?: Array<number | bigint>;
80
+ /**
81
+ * 规则状态
82
+ */
83
+ State?: string;
84
+ /**
85
+ * 评估结果
86
+ */
87
+ ComplianceResult?: Array<string>;
88
+ /**
89
+ * 规则名
90
+ */
91
+ RuleName?: string;
92
+ /**
93
+ * 规则所属账号ID
94
+ */
95
+ RuleOwnerId?: number;
96
+ }
1
97
  /**
2
98
  * 规则详情
3
99
  */
@@ -183,6 +279,77 @@ export interface ListConfigRulesResponse {
183
279
  */
184
280
  RequestId?: string;
185
281
  }
282
+ /**
283
+ * DescribeDiscoveredResource返回参数结构体
284
+ */
285
+ export interface DescribeDiscoveredResourceResponse {
286
+ /**
287
+ * 资源Id
288
+ 注意:此字段可能返回 null,表示取不到有效值。
289
+ */
290
+ ResourceId?: string;
291
+ /**
292
+ * 资源类型
293
+ 注意:此字段可能返回 null,表示取不到有效值。
294
+ */
295
+ ResourceType?: string;
296
+ /**
297
+ * 资源名
298
+ 注意:此字段可能返回 null,表示取不到有效值。
299
+ */
300
+ ResourceName?: string;
301
+ /**
302
+ * 资源地域
303
+ 注意:此字段可能返回 null,表示取不到有效值。
304
+ */
305
+ ResourceRegion?: string;
306
+ /**
307
+ * 资源可用区
308
+ 注意:此字段可能返回 null,表示取不到有效值。
309
+ */
310
+ ResourceZone?: string;
311
+ /**
312
+ * 资源配置
313
+ 注意:此字段可能返回 null,表示取不到有效值。
314
+ */
315
+ Configuration?: string;
316
+ /**
317
+ * 资源创建时间
318
+ 注意:此字段可能返回 null,表示取不到有效值。
319
+ */
320
+ ResourceCreateTime?: string;
321
+ /**
322
+ * 资源标签
323
+ 注意:此字段可能返回 null,表示取不到有效值。
324
+ */
325
+ Tags?: Array<Tag>;
326
+ /**
327
+ * 资源更新时间
328
+ 注意:此字段可能返回 null,表示取不到有效值。
329
+ */
330
+ UpdateTime?: string;
331
+ /**
332
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
333
+ */
334
+ RequestId?: string;
335
+ }
336
+ /**
337
+ * ListAggregateConfigRules返回参数结构体
338
+ */
339
+ export interface ListAggregateConfigRulesResponse {
340
+ /**
341
+ * 总数
342
+ */
343
+ Total?: number;
344
+ /**
345
+ * 详情
346
+ */
347
+ Items?: Array<ConfigRule>;
348
+ /**
349
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
350
+ */
351
+ RequestId?: string;
352
+ }
186
353
  /**
187
354
  * 规则入参
188
355
  */
@@ -307,74 +474,77 @@ export interface PutEvaluationsRequest {
307
474
  Evaluations: Array<Evaluation>;
308
475
  }
309
476
  /**
310
- * ListAggregateConfigRules请求参数结构体
477
+ * 资源列表筛选
311
478
  */
312
- export interface ListAggregateConfigRulesRequest {
479
+ export interface Filter {
313
480
  /**
314
- * 每页限制
481
+ * 查询字段名称 资源名称:resourceName 资源ID:resourceId 资源类型:resourceType 资源地域:resourceRegion 删除状态:resourceDelete 0未删除,1已删除 resourceRegionAndZone地域/可用区
315
482
  */
316
- Limit: number;
483
+ Name?: string;
317
484
  /**
318
- * 偏移量
319
- */
320
- Offset: number;
321
- /**
322
- * 账号组ID
485
+ * 查询字段值
323
486
  */
324
- AccountGroupId: string;
487
+ Values?: Array<string>;
488
+ }
489
+ /**
490
+ * DescribeDiscoveredResource请求参数结构体
491
+ */
492
+ export interface DescribeDiscoveredResourceRequest {
325
493
  /**
326
- * 排序类型, 倒序:desc,顺序:asc
494
+ * 资源ID
327
495
  */
328
- OrderType?: string;
496
+ ResourceId: string;
329
497
  /**
330
- * 风险等级
331
- 1:高风险。
332
- 2:中风险。
333
- 3:低风险。
498
+ * 资源类型
334
499
  */
335
- RiskLevel?: Array<number | bigint>;
500
+ ResourceType: string;
336
501
  /**
337
- * 规则状态
502
+ * 资源地域
338
503
  */
339
- State?: string;
504
+ ResourceRegion: string;
505
+ }
506
+ /**
507
+ * ListDiscoveredResources返回参数结构体
508
+ */
509
+ export interface ListDiscoveredResourcesResponse {
340
510
  /**
341
- * 评估结果
511
+ * 详情
342
512
  */
343
- ComplianceResult?: Array<string>;
513
+ Items: Array<ResourceListInfo>;
344
514
  /**
345
- * 规则名
515
+ * 下一页
516
+ 注意:此字段可能返回 null,表示取不到有效值。
346
517
  */
347
- RuleName?: string;
518
+ NextToken: string;
348
519
  /**
349
- * 规则所属账号ID
520
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
350
521
  */
351
- RuleOwnerId?: number;
522
+ RequestId?: string;
352
523
  }
353
524
  /**
354
- * ListAggregateConfigRules返回参数结构体
525
+ * ListDiscoveredResources请求参数结构体
355
526
  */
356
- export interface ListAggregateConfigRulesResponse {
527
+ export interface ListDiscoveredResourcesRequest {
357
528
  /**
358
- * 总数
529
+ * 每页显示数量
359
530
  */
360
- Total?: number;
531
+ MaxResults: number;
361
532
  /**
362
- * 详情
533
+ * resourceName:资源名 resourceId :资源ID
363
534
  */
364
- Items?: Array<ConfigRule>;
535
+ Filters?: Array<Filter>;
365
536
  /**
366
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
537
+ * 标签
367
538
  */
368
- RequestId?: string;
369
- }
370
- /**
371
- * PutEvaluations返回参数结构体
372
- */
373
- export interface PutEvaluationsResponse {
539
+ Tags?: Array<Tag>;
374
540
  /**
375
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
541
+ * 下一页token
376
542
  */
377
- RequestId?: string;
543
+ NextToken?: string;
544
+ /**
545
+ * 排序方式 asc、desc
546
+ */
547
+ OrderType?: string;
378
548
  }
379
549
  /**
380
550
  * 参数值
@@ -394,6 +564,15 @@ export interface InputParameter {
394
564
  */
395
565
  Value?: string;
396
566
  }
567
+ /**
568
+ * PutEvaluations返回参数结构体
569
+ */
570
+ export interface PutEvaluationsResponse {
571
+ /**
572
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
573
+ */
574
+ RequestId?: string;
575
+ }
397
576
  /**
398
577
  * 自定义规则评估结果
399
578
  */
@@ -733,6 +733,13 @@ export interface SystemDisk {
733
733
  注意:此字段可能返回 null,表示取不到有效值。
734
734
  */
735
735
  CdcId?: string;
736
+ /**
737
+ * 磁盘名称,长度不超过128 个字符。
738
+
739
+ 该参数正在邀测中,暂未开放使用。
740
+ 注意:此字段可能返回 null,表示取不到有效值。
741
+ */
742
+ DiskName?: string;
736
743
  }
737
744
  /**
738
745
  * ResetInstance请求参数结构体
@@ -2640,37 +2647,7 @@ export interface DataDisk {
2640
2647
  */
2641
2648
  DiskSize: number;
2642
2649
  /**
2643
- * 数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围:<br />
2644
- <li>
2645
- LOCAL_BASIC:本地硬盘<br />
2646
- <li>
2647
- LOCAL_SSD:本地SSD硬盘<br />
2648
- <li>
2649
- LOCAL_NVME:本地NVME硬盘,与InstanceType强相关,不支持指定<br />
2650
- <li>
2651
- LOCAL_PRO:本地HDD硬盘,与InstanceType强相关,不支持指定<br />
2652
- <li>
2653
- CLOUD_BASIC:普通云硬盘<br />
2654
- <li>
2655
- CLOUD_PREMIUM:高性能云硬盘<br />
2656
- <li>
2657
- CLOUD_SSD:SSD云硬盘<br />
2658
- <li>
2659
- CLOUD_HSSD:增强型SSD云硬盘<br />
2660
- <li>
2661
- CLOUD_TSSD:极速型SSD云硬盘<br />
2662
- <li>
2663
- CLOUD_BSSD:通用型SSD云硬盘<br /><br />默认取值:LOCAL_BASIC。<br /><br />该参数对`ResizeInstanceDisk`接口无效。
2664
- </li>
2665
- </li>
2666
- </li>
2667
- </li>
2668
- </li>
2669
- </li>
2670
- </li>
2671
- </li>
2672
- </li>
2673
- </li>
2650
+ * 数据盘类型。数据盘类型限制详见[存储概述](https://cloud.tencent.com/document/product/213/4952)。取值范围:<br /><li>LOCAL_BASIC:本地硬盘<br /> <li>LOCAL_SSD:本地SSD硬盘<br /><li>LOCAL_NVME:本地NVME硬盘,与InstanceType强相关,不支持指定<br /><li>LOCAL_PRO:本地HDD硬盘,与InstanceType强相关,不支持指定<br /><li>CLOUD_BASIC:普通云硬盘<br /><li> CLOUD_PREMIUM:高性能云硬盘<br /><li>CLOUD_SSD:SSD云硬盘<br /><li> CLOUD_HSSD:增强型SSD云硬盘<br /> <li>CLOUD_TSSD:极速型SSD云硬盘<br /><li>CLOUD_BSSD:通用型SSD云硬盘<br /><br />默认取值:LOCAL_BASIC。<br /><br />该参数对`ResizeInstanceDisk`接口无效。</li></li></li> </li> </li></li></li></li></li></li>
2674
2651
  */
2675
2652
  DiskType?: string;
2676
2653
  /**
@@ -2680,10 +2657,10 @@ export interface DataDisk {
2680
2657
  DiskId?: string;
2681
2658
  /**
2682
2659
  * 数据盘是否随子机销毁。取值范围:
2683
- <li>TRUE:子机销毁时,销毁数据盘,只支持按小时后付费云盘</li>
2660
+ <li>true:子机销毁时,销毁数据盘,只支持按小时后付费云盘</li>
2684
2661
  <li>
2685
- FALSE:子机销毁时,保留数据盘<br />
2686
- 默认取值:TRUE<br />
2662
+ false:子机销毁时,保留数据盘<br />
2663
+ 默认取值:true<br />
2687
2664
  该参数目前仅用于 `RunInstances` 接口。
2688
2665
  </li>
2689
2666
  注意:此字段可能返回 null,表示取不到有效值。
@@ -2729,6 +2706,12 @@ export interface DataDisk {
2729
2706
  注意:此字段可能返回 null,表示取不到有效值。
2730
2707
  */
2731
2708
  BurstPerformance?: boolean;
2709
+ /**
2710
+ * 磁盘名称,长度不超过128 个字符。
2711
+
2712
+ 该参数正在邀测中,暂未开放使用。
2713
+ */
2714
+ DiskName?: string;
2732
2715
  }
2733
2716
  /**
2734
2717
  * DescribeKeyPairs请求参数结构体
@@ -26162,7 +26162,7 @@ export interface DescribeBaselineListRequest {
26162
26162
  * 过滤条件。
26163
26163
  <li>StrategyId- Uint64 - 基线策略id</li>
26164
26164
  <li>Status - Uint64 - 处理状态1已通过 0未通过</li>
26165
- <li>Level - Uint64[] - 处理状态1已通过 0未通过</li>BaselineName
26165
+ <li>Level - Uint64[] - 威胁等级</li>
26166
26166
  <li>BaselineName - String - 基线名称</li>
26167
26167
  <li>Quuid- String - 主机quuid</li>
26168
26168
  <li>Uuid- String - 主机uuid</li>
@@ -9102,12 +9102,12 @@ export interface DescribeBinlogSaveDaysResponse {
9102
9102
  */
9103
9103
  export interface IsolateClusterResponse {
9104
9104
  /**
9105
- * 任务流ID
9105
+ * 任务流ID(后付费或者serverless资源返回,如果需要同步任务状态,请使用DescribeFlow接口)
9106
9106
  注意:此字段可能返回 null,表示取不到有效值。
9107
9107
  */
9108
9108
  FlowId?: number;
9109
9109
  /**
9110
- * 退款订单号
9110
+ * 退款订单号(预付费资源返回,如果需要同步订单状态,请使用计费产品的DescribeDealsByCond同步订单状态)
9111
9111
  注意:此字段可能返回 null,表示取不到有效值。
9112
9112
  */
9113
9113
  DealNames?: Array<string>;
@@ -7914,11 +7914,17 @@ export interface Component {
7914
7914
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
7915
7915
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
7916
7916
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
7917
+ <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
7918
+ <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
7919
+ <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
7917
7920
  <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
7918
7921
 
7919
7922
  * 个人方
7920
7923
  <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
7921
7924
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
7925
+ <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
7926
+ <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
7927
+ <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
7922
7928
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>
7923
7929
 
7924
7930
  注:` 表单域的控件不能作为印章和签名控件`
@@ -8062,13 +8068,111 @@ export interface Component {
8062
8068
  <b>参数样例</b>:` "{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"`
8063
8069
 
8064
8070
  <font color="red">签署印章透明度功能设置,</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时,可以通过以下参数设置签署印章的透明度:
8065
- <ul><li> <b>Opacity</b>:印章透明度,支持范围:0-1,0.7表示70%的透明度,1表示无透明度</li></ul>
8071
+ <ul><li> <b>Opacity</b>:印章透明度,支持范围:0.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>
8066
8072
  <b>参数样例</b>:`{"Opacity":0.7}`
8067
8073
 
8068
8074
  <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
8069
8075
  <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
8070
8076
  场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
8071
8077
  <b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
8078
+
8079
+ <font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:
8080
+ <ul>
8081
+ <li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>
8082
+ <b>参数样例</b>:<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
8083
+ <li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>
8084
+ ChildrenComponent结构体定义:
8085
+ <table border="1">
8086
+ <thead>
8087
+ <tr>
8088
+ <th>字段名称</th>
8089
+ <th>类型</th>
8090
+ <th>描述</th>
8091
+ </tr>
8092
+ </thead>
8093
+ <tbody>
8094
+ <tr>
8095
+ <td>ComponentType</td>
8096
+ <td>string</td>
8097
+ <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>
8098
+ </tr>
8099
+ <tr>
8100
+ <td>ComponentName</td>
8101
+ <td>string</td>
8102
+ <td>子控件名称</td>
8103
+ </tr>
8104
+ <tr>
8105
+ <td>Placeholder</td>
8106
+ <td>string</td>
8107
+ <td>子控件提示语</td>
8108
+ </tr>
8109
+ <tr>
8110
+ <td>ComponentOffsetX</td>
8111
+ <td>float</td>
8112
+ <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>
8113
+ </tr>
8114
+ <tr>
8115
+ <td>ComponentOffsetY</td>
8116
+ <td>float</td>
8117
+ <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>
8118
+ </tr>
8119
+ <tr>
8120
+ <td>ComponentWidth</td>
8121
+ <td>float</td>
8122
+ <td>控件宽</td>
8123
+ </tr>
8124
+ <tr>
8125
+ <td>ComponentHeight</td>
8126
+ <td>float</td>
8127
+ <td>控件高</td>
8128
+ </tr>
8129
+ <tr>
8130
+ <td>ComponentExtra</td>
8131
+ <td>string</td>
8132
+ <td>控件的附属信息,根据ComponentType设置</td>
8133
+ </tr>
8134
+ </tbody>
8135
+ </table>
8136
+ <b>参数样例</b>:
8137
+ ```json
8138
+ {
8139
+ "ChildrenComponents": [
8140
+ {
8141
+ "ComponentType": "SIGN_SIGNATURE",
8142
+ "ComponentName": "个人签名",
8143
+ "Placeholder": "请签名",
8144
+ "ComponentOffsetX": 10,
8145
+ "ComponentOffsetY": 30,
8146
+ "ComponentWidth": 119,
8147
+ "ComponentHeight": 43,
8148
+ "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"
8149
+ },
8150
+ {
8151
+ "ComponentType": "SIGN_SELECTOR",
8152
+ "ComponentName": "是否同意此协议",
8153
+ "Placeholder": "",
8154
+ "ComponentOffsetX": 50,
8155
+ "ComponentOffsetY": 130,
8156
+ "ComponentWidth": 120,
8157
+ "ComponentHeight": 43,
8158
+ "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"
8159
+ },
8160
+ {
8161
+ "ComponentType": "SIGN_MULTI_LINE_TEXT",
8162
+ "ComponentName": "批注附言",
8163
+ "Placeholder": "",
8164
+ "ComponentOffsetX": 150,
8165
+ "ComponentOffsetY": 300,
8166
+ "ComponentWidth": 200,
8167
+ "ComponentHeight": 86,
8168
+ "ComponentExtra": ""
8169
+ }
8170
+ ]
8171
+ }
8172
+ ```
8173
+ </ul>
8174
+
8175
+
8072
8176
  */
8073
8177
  ComponentExtra?: string;
8074
8178
  /**
@@ -90,12 +90,20 @@ export interface Component {
90
90
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
91
91
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
92
92
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
93
+ <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
94
+ <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
95
+ <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
93
96
  <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
94
97
 
98
+
95
99
  * 个人方
96
100
  <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
97
101
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
98
- <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li></ul>
102
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
103
+ <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
104
+ <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
105
+ <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
106
+ </ul>
99
107
 
100
108
  注:` 表单域的控件不能作为印章和签名控件`
101
109
  */
@@ -222,6 +230,107 @@ export interface Component {
222
230
  <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
223
231
  场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
224
232
  <b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
233
+
234
+
235
+ <font color="red">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>,支持以下参数:
236
+ <ul>
237
+ <li><b>Children:</b> 绝对定位模式下,用来指定此签批控件的组合子控件 </li>
238
+ <b>参数样例</b>:<br>`{"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}`
239
+ <li><b>ChildrenComponents:</b> 关键字定位模式下,用来指定此签批控件的组合子控件 </li>
240
+ ChildrenComponent结构体定义:
241
+ <table border="1">
242
+ <thead>
243
+ <tr>
244
+ <th>字段名称</th>
245
+ <th>类型</th>
246
+ <th>描述</th>
247
+ </tr>
248
+ </thead>
249
+ <tbody>
250
+ <tr>
251
+ <td>ComponentType</td>
252
+ <td>string</td>
253
+ <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td>
254
+ </tr>
255
+ <tr>
256
+ <td>ComponentName</td>
257
+ <td>string</td>
258
+ <td>子控件名称</td>
259
+ </tr>
260
+ <tr>
261
+ <td>Placeholder</td>
262
+ <td>string</td>
263
+ <td>子控件提示语</td>
264
+ </tr>
265
+ <tr>
266
+ <td>ComponentOffsetX</td>
267
+ <td>float</td>
268
+ <td>控件偏移位置X(相对于父控件(签批控件的ComponentX))</td>
269
+ </tr>
270
+ <tr>
271
+ <td>ComponentOffsetY</td>
272
+ <td>float</td>
273
+ <td>控件偏移位置Y 相对于父控件(签批控件的ComponentY))</td>
274
+ </tr>
275
+ <tr>
276
+ <td>ComponentWidth</td>
277
+ <td>float</td>
278
+ <td>控件宽</td>
279
+ </tr>
280
+ <tr>
281
+ <td>ComponentHeight</td>
282
+ <td>float</td>
283
+ <td>控件高</td>
284
+ </tr>
285
+ <tr>
286
+ <td>ComponentExtra</td>
287
+ <td>string</td>
288
+ <td>控件的附属信息,根据ComponentType设置</td>
289
+ </tr>
290
+ </tbody>
291
+ </table>
292
+ <b>参数样例</b>:
293
+ ```json
294
+ {
295
+ "ChildrenComponents": [
296
+ {
297
+ "ComponentType": "SIGN_SIGNATURE",
298
+ "ComponentName": "个人签名",
299
+ "Placeholder": "请签名",
300
+ "ComponentOffsetX": 10,
301
+ "ComponentOffsetY": 30,
302
+ "ComponentWidth": 119,
303
+ "ComponentHeight": 43,
304
+ "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"
305
+ },
306
+ {
307
+ "ComponentType": "SIGN_SELECTOR",
308
+ "ComponentName": "是否同意此协议",
309
+ "Placeholder": "",
310
+ "ComponentOffsetX": 50,
311
+ "ComponentOffsetY": 130,
312
+ "ComponentWidth": 120,
313
+ "ComponentHeight": 43,
314
+ "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"
315
+ },
316
+ {
317
+ "ComponentType": "SIGN_MULTI_LINE_TEXT",
318
+ "ComponentName": "批注附言",
319
+ "Placeholder": "",
320
+ "ComponentOffsetX": 150,
321
+ "ComponentOffsetY": 300,
322
+ "ComponentWidth": 200,
323
+ "ComponentHeight": 86,
324
+ "ComponentExtra": ""
325
+ }
326
+ ]
327
+ }
328
+ ```
329
+ </ul>
330
+
331
+
332
+
333
+
225
334
  */
226
335
  ComponentExtra?: string;
227
336
  /**