tencentcloud-sdk-nodejs 4.0.873 → 4.0.875

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 (100) hide show
  1. package/CHANGELOG.md +524 -0
  2. package/SERVICE_CHANGELOG.md +735 -44
  3. package/package.json +1 -1
  4. package/products.md +32 -32
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_client.ts +8 -7
  7. package/src/services/asr/v20190614/asr_models.ts +10 -4
  8. package/src/services/billing/v20180709/billing_models.ts +2 -2
  9. package/src/services/ccc/v20200210/ccc_models.ts +1 -1
  10. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +10 -0
  11. package/src/services/cls/v20201016/cls_models.ts +4 -0
  12. package/src/services/cynosdb/v20190107/cynosdb_models.ts +3 -3
  13. package/src/services/dc/v20180410/dc_client.ts +1 -1
  14. package/src/services/dc/v20180410/dc_models.ts +86 -78
  15. package/src/services/domain/v20180808/domain_client.ts +2 -3
  16. package/src/services/domain/v20180808/domain_models.ts +8 -8
  17. package/src/services/dsgc/v20190723/dsgc_models.ts +5 -1
  18. package/src/services/dts/v20180330/dts_client.ts +4 -2
  19. package/src/services/emr/v20190103/emr_client.ts +20 -4
  20. package/src/services/emr/v20190103/emr_models.ts +274 -78
  21. package/src/services/es/v20180416/es_models.ts +5 -0
  22. package/src/services/ess/v20201111/ess_client.ts +3 -4
  23. package/src/services/ess/v20201111/ess_models.ts +19 -4
  24. package/src/services/essbasic/v20210526/essbasic_client.ts +7 -4
  25. package/src/services/essbasic/v20210526/essbasic_models.ts +51 -5
  26. package/src/services/hunyuan/v20230901/hunyuan_client.ts +20 -56
  27. package/src/services/hunyuan/v20230901/hunyuan_models.ts +46 -226
  28. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +4 -0
  29. package/src/services/monitor/v20180724/monitor_client.ts +10 -6
  30. package/src/services/monitor/v20180724/monitor_models.ts +14 -14
  31. package/src/services/mps/v20190612/mps_client.ts +7 -4
  32. package/src/services/mps/v20190612/mps_models.ts +129 -67
  33. package/src/services/mrs/v20200910/mrs_models.ts +142 -17
  34. package/src/services/ocr/v20181119/ocr_models.ts +1 -0
  35. package/src/services/organization/v20210331/organization_models.ts +13 -0
  36. package/src/services/rce/v20201103/rce_models.ts +21 -13
  37. package/src/services/redis/v20180412/redis_client.ts +1 -1
  38. package/src/services/redis/v20180412/redis_models.ts +27 -15
  39. package/src/services/tdmq/v20200217/tdmq_models.ts +8 -8
  40. package/src/services/tke/v20180525/tke_models.ts +16 -9
  41. package/src/services/tse/v20201207/tse_models.ts +2 -2
  42. package/src/services/waf/v20180125/waf_client.ts +24 -0
  43. package/src/services/waf/v20180125/waf_models.ts +51 -0
  44. package/src/services/wedata/v20210820/wedata_client.ts +2 -0
  45. package/src/services/wedata/v20210820/wedata_models.ts +56 -1
  46. package/tencentcloud/common/sdk_version.d.ts +1 -1
  47. package/tencentcloud/common/sdk_version.js +1 -1
  48. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +8 -7
  49. package/tencentcloud/services/asr/v20190614/asr_client.js +8 -7
  50. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +10 -4
  51. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +2 -2
  52. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +1 -1
  53. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +10 -0
  54. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +4 -0
  55. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +3 -3
  56. package/tencentcloud/services/dc/v20180410/dc_client.d.ts +1 -1
  57. package/tencentcloud/services/dc/v20180410/dc_client.js +1 -1
  58. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +86 -78
  59. package/tencentcloud/services/domain/v20180808/domain_client.d.ts +0 -1
  60. package/tencentcloud/services/domain/v20180808/domain_client.js +0 -1
  61. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +8 -8
  62. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +5 -1
  63. package/tencentcloud/services/dts/v20180330/dts_client.d.ts +3 -1
  64. package/tencentcloud/services/dts/v20180330/dts_client.js +3 -1
  65. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
  66. package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
  67. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +268 -78
  68. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -0
  69. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -4
  70. package/tencentcloud/services/ess/v20201111/ess_client.js +3 -4
  71. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -4
  72. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +6 -4
  73. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -4
  74. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +50 -5
  75. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +10 -30
  76. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +11 -35
  77. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +46 -222
  78. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +4 -0
  79. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +8 -4
  80. package/tencentcloud/services/monitor/v20180724/monitor_client.js +8 -4
  81. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +14 -14
  82. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
  83. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +125 -66
  84. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +142 -17
  85. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +1 -0
  86. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +13 -0
  87. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +21 -13
  88. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
  89. package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
  90. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +27 -15
  91. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +8 -8
  92. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +16 -9
  93. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
  94. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +9 -1
  95. package/tencentcloud/services/waf/v20180125/waf_client.js +12 -0
  96. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +47 -0
  97. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +54 -1
  98. package/test/emr.v20190103.test.js +10 -0
  99. package/test/hunyuan.v20230901.test.js +4 -24
  100. package/test/waf.v20180125.test.js +20 -0
@@ -200,6 +200,54 @@ export interface ScaleOutInstanceResponse {
200
200
  RequestId?: string
201
201
  }
202
202
 
203
+ /**
204
+ * DescribeClusterFlowStatusDetail返回参数结构体
205
+ */
206
+ export interface DescribeClusterFlowStatusDetailResponse {
207
+ /**
208
+ * 任务步骤详情
209
+ 注意:此字段可能返回 null,表示取不到有效值。
210
+ */
211
+ StageDetails?: Array<StageInfoDetail>
212
+ /**
213
+ * 任务参数
214
+ 注意:此字段可能返回 null,表示取不到有效值。
215
+ */
216
+ FlowDesc?: Array<FlowParamsDesc>
217
+ /**
218
+ * 任务名称
219
+ 注意:此字段可能返回 null,表示取不到有效值。
220
+ */
221
+ FlowName?: string
222
+ /**
223
+ * 总任务流程进度:
224
+ 例如:0.8
225
+ 注意:此字段可能返回 null,表示取不到有效值。
226
+ */
227
+ FlowTotalProgress?: number
228
+ /**
229
+ * 定义流程总状态:
230
+ 0:初始化,
231
+ 1:运行中,
232
+ 2:完成,
233
+ 3:完成(存在跳过步骤),
234
+ -1:失败,
235
+ -3:阻塞,
236
+ 注意:此字段可能返回 null,表示取不到有效值。
237
+ */
238
+ FlowTotalStatus?: number
239
+ /**
240
+ * 流程额外信息
241
+ NeedExtraDetail为true时返回
242
+ 注意:此字段可能返回 null,表示取不到有效值。
243
+ */
244
+ FlowExtraDetail?: Array<FlowExtraDetail>
245
+ /**
246
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
247
+ */
248
+ RequestId?: string
249
+ }
250
+
203
251
  /**
204
252
  * ModifyUserManagerPwd返回参数结构体
205
253
  */
@@ -1443,6 +1491,20 @@ export interface ModifyAutoScaleStrategyRequest {
1443
1491
  GroupId?: number
1444
1492
  }
1445
1493
 
1494
+ /**
1495
+ * 自定义配置参数
1496
+ */
1497
+ export interface Configuration {
1498
+ /**
1499
+ * 配置文件名,支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。
1500
+ */
1501
+ Classification: string
1502
+ /**
1503
+ * 配置参数通过KV的形式传入,部分文件支持自定义,可以通过特殊的键"content"传入所有内容。
1504
+ */
1505
+ Properties: string
1506
+ }
1507
+
1446
1508
  /**
1447
1509
  * 资源详情
1448
1510
  */
@@ -1984,17 +2046,41 @@ export interface VPCSettings {
1984
2046
  }
1985
2047
 
1986
2048
  /**
1987
- * 共用自建组件参数
2049
+ * DescribeHiveQueries请求参数结构体
1988
2050
  */
1989
- export interface CustomServiceDefine {
2051
+ export interface DescribeHiveQueriesRequest {
1990
2052
  /**
1991
- * 自定义参数key
2053
+ * 集群ID
1992
2054
  */
1993
- Name?: string
2055
+ InstanceId: string
1994
2056
  /**
1995
- * 自定义参数value
2057
+ * 起始时间秒
1996
2058
  */
1997
- Value?: string
2059
+ StartTime: number
2060
+ /**
2061
+ * 结束时间秒,EndTime-StartTime不得超过1天秒数86400
2062
+ */
2063
+ EndTime: number
2064
+ /**
2065
+ * 分页起始偏移,从0开始
2066
+ */
2067
+ Offset: number
2068
+ /**
2069
+ * 分页大小,合法范围[1,100]
2070
+ */
2071
+ Limit: number
2072
+ /**
2073
+ * 执行状态,ERROR等
2074
+ */
2075
+ State?: Array<string>
2076
+ /**
2077
+ * 结束时间大于的时间点
2078
+ */
2079
+ EndTimeGte?: number
2080
+ /**
2081
+ * 结束时间小于时间点
2082
+ */
2083
+ EndTimeLte?: number
1998
2084
  }
1999
2085
 
2000
2086
  /**
@@ -2291,6 +2377,22 @@ export interface JobResult {
2291
2377
  ApplicationId?: string
2292
2378
  }
2293
2379
 
2380
+ /**
2381
+ * FlowParam流程参数
2382
+ */
2383
+ export interface FlowParam {
2384
+ /**
2385
+ * 流程参数key
2386
+ TraceId:通过TraceId查询
2387
+ FlowId: 通过FlowId查询
2388
+ */
2389
+ FKey: string
2390
+ /**
2391
+ * 参数value
2392
+ */
2393
+ FValue: string
2394
+ }
2395
+
2294
2396
  /**
2295
2397
  * DescribeAutoScaleStrategies返回参数结构体
2296
2398
  */
@@ -2643,17 +2745,18 @@ export interface JobFlowResourceSpec {
2643
2745
  }
2644
2746
 
2645
2747
  /**
2646
- * 自定义配置参数
2748
+ * 任务参数描述
2647
2749
  */
2648
- export interface Configuration {
2750
+ export interface FlowParamsDesc {
2649
2751
  /**
2650
- * 配置文件名,支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。
2752
+ * 参数key
2651
2753
  */
2652
- Classification: string
2754
+ PKey: string
2653
2755
  /**
2654
- * 配置参数通过KV的形式传入,部分文件支持自定义,可以通过特殊的键"content"传入所有内容。
2756
+ * 参数value
2757
+ 注意:此字段可能返回 null,表示取不到有效值。
2655
2758
  */
2656
- Properties: string
2759
+ PValue: string
2657
2760
  }
2658
2761
 
2659
2762
  /**
@@ -2666,6 +2769,52 @@ export interface DescribeResourceScheduleRequest {
2666
2769
  InstanceId: string
2667
2770
  }
2668
2771
 
2772
+ /**
2773
+ * 资源描述
2774
+ */
2775
+ export interface AllNodeResourceSpec {
2776
+ /**
2777
+ * 描述Master节点资源
2778
+ 注意:此字段可能返回 null,表示取不到有效值。
2779
+ */
2780
+ MasterResourceSpec?: NodeResourceSpec
2781
+ /**
2782
+ * 描述Core节点资源
2783
+ 注意:此字段可能返回 null,表示取不到有效值。
2784
+ */
2785
+ CoreResourceSpec?: NodeResourceSpec
2786
+ /**
2787
+ * 描述Taskr节点资源
2788
+ 注意:此字段可能返回 null,表示取不到有效值。
2789
+ */
2790
+ TaskResourceSpec?: NodeResourceSpec
2791
+ /**
2792
+ * 描述Common节点资源
2793
+ 注意:此字段可能返回 null,表示取不到有效值。
2794
+ */
2795
+ CommonResourceSpec?: NodeResourceSpec
2796
+ /**
2797
+ * Master节点数量
2798
+ 注意:此字段可能返回 null,表示取不到有效值。
2799
+ */
2800
+ MasterCount?: number
2801
+ /**
2802
+ * Corer节点数量
2803
+ 注意:此字段可能返回 null,表示取不到有效值。
2804
+ */
2805
+ CoreCount?: number
2806
+ /**
2807
+ * Task节点数量
2808
+ 注意:此字段可能返回 null,表示取不到有效值。
2809
+ */
2810
+ TaskCount?: number
2811
+ /**
2812
+ * Common节点数量
2813
+ 注意:此字段可能返回 null,表示取不到有效值。
2814
+ */
2815
+ CommonCount?: number
2816
+ }
2817
+
2669
2818
  /**
2670
2819
  * 描述集群实例位置信息
2671
2820
  */
@@ -2833,49 +2982,22 @@ export interface PodParameter {
2833
2982
  }
2834
2983
 
2835
2984
  /**
2836
- * 资源描述
2985
+ * DescribeClusterFlowStatusDetail请求参数结构体
2837
2986
  */
2838
- export interface AllNodeResourceSpec {
2839
- /**
2840
- * 描述Master节点资源
2841
- 注意:此字段可能返回 null,表示取不到有效值。
2842
- */
2843
- MasterResourceSpec?: NodeResourceSpec
2844
- /**
2845
- * 描述Core节点资源
2846
- 注意:此字段可能返回 null,表示取不到有效值。
2847
- */
2848
- CoreResourceSpec?: NodeResourceSpec
2987
+ export interface DescribeClusterFlowStatusDetailRequest {
2849
2988
  /**
2850
- * 描述Taskr节点资源
2851
- 注意:此字段可能返回 null,表示取不到有效值。
2852
- */
2853
- TaskResourceSpec?: NodeResourceSpec
2854
- /**
2855
- * 描述Common节点资源
2856
- 注意:此字段可能返回 null,表示取不到有效值。
2989
+ * EMR实例ID
2857
2990
  */
2858
- CommonResourceSpec?: NodeResourceSpec
2859
- /**
2860
- * Master节点数量
2861
- 注意:此字段可能返回 null,表示取不到有效值。
2862
- */
2863
- MasterCount?: number
2864
- /**
2865
- * Corer节点数量
2866
- 注意:此字段可能返回 null,表示取不到有效值。
2867
- */
2868
- CoreCount?: number
2991
+ InstanceId: string
2869
2992
  /**
2870
- * Task节点数量
2871
- 注意:此字段可能返回 null,表示取不到有效值。
2993
+ * 流程相关参数
2872
2994
  */
2873
- TaskCount?: number
2995
+ FlowParam: FlowParam
2874
2996
  /**
2875
- * Common节点数量
2876
- 注意:此字段可能返回 null,表示取不到有效值。
2997
+ * 是否返回任务额外信息
2998
+ 默认: false
2877
2999
  */
2878
- CommonCount?: number
3000
+ NeedExtraDetail?: boolean
2879
3001
  }
2880
3002
 
2881
3003
  /**
@@ -3920,41 +4042,17 @@ export interface DescribeInsightListResponse {
3920
4042
  }
3921
4043
 
3922
4044
  /**
3923
- * DescribeHiveQueries请求参数结构体
4045
+ * 共用自建组件参数
3924
4046
  */
3925
- export interface DescribeHiveQueriesRequest {
3926
- /**
3927
- * 集群ID
3928
- */
3929
- InstanceId: string
3930
- /**
3931
- * 起始时间秒
3932
- */
3933
- StartTime: number
3934
- /**
3935
- * 结束时间秒,EndTime-StartTime不得超过1天秒数86400
3936
- */
3937
- EndTime: number
3938
- /**
3939
- * 分页起始偏移,从0开始
3940
- */
3941
- Offset: number
3942
- /**
3943
- * 分页大小,合法范围[1,100]
3944
- */
3945
- Limit: number
3946
- /**
3947
- * 执行状态,ERROR等
3948
- */
3949
- State?: Array<string>
4047
+ export interface CustomServiceDefine {
3950
4048
  /**
3951
- * 结束时间大于的时间点
4049
+ * 自定义参数key
3952
4050
  */
3953
- EndTimeGte?: number
4051
+ Name?: string
3954
4052
  /**
3955
- * 结束时间小于时间点
4053
+ * 自定义参数value
3956
4054
  */
3957
- EndTimeLte?: number
4055
+ Value?: string
3958
4056
  }
3959
4057
 
3960
4058
  /**
@@ -4997,6 +5095,22 @@ export interface DescribeUsersForUserManagerResponse {
4997
5095
  RequestId?: string
4998
5096
  }
4999
5097
 
5098
+ /**
5099
+ * 流程额外信息
5100
+ */
5101
+ export interface FlowExtraDetail {
5102
+ /**
5103
+ * 额外信息Title
5104
+ 注意:此字段可能返回 null,表示取不到有效值。
5105
+ */
5106
+ Title?: string
5107
+ /**
5108
+ * 额外信息
5109
+ 注意:此字段可能返回 null,表示取不到有效值。
5110
+ */
5111
+ Detail?: Array<FlowParamsDesc>
5112
+ }
5113
+
5000
5114
  /**
5001
5115
  * InquiryPriceRenewInstance请求参数结构体
5002
5116
  */
@@ -6131,6 +6245,83 @@ export interface TableSchemaItem {
6131
6245
  Title: string
6132
6246
  }
6133
6247
 
6248
+ /**
6249
+ * 任务步骤详情
6250
+ */
6251
+ export interface StageInfoDetail {
6252
+ /**
6253
+ * 步骤id
6254
+ */
6255
+ Stage?: string
6256
+ /**
6257
+ * 步骤名
6258
+ 注意:此字段可能返回 null,表示取不到有效值。
6259
+ */
6260
+ Name?: string
6261
+ /**
6262
+ * 是否展示
6263
+ */
6264
+ IsShow?: boolean
6265
+ /**
6266
+ * 是否子流程
6267
+ */
6268
+ IsSubFlow?: boolean
6269
+ /**
6270
+ * 子流程标签
6271
+ 注意:此字段可能返回 null,表示取不到有效值。
6272
+ */
6273
+ SubFlowFlag?: string
6274
+ /**
6275
+ * 步骤运行状态:0:未开始 1:进行中 2:已完成 3:部分完成 -1:失败
6276
+ */
6277
+ Status?: number
6278
+ /**
6279
+ * 步骤运行状态描述
6280
+ 注意:此字段可能返回 null,表示取不到有效值。
6281
+ */
6282
+ Desc?: string
6283
+ /**
6284
+ * 运行进度
6285
+ 注意:此字段可能返回 null,表示取不到有效值。
6286
+ */
6287
+ Progress?: number
6288
+ /**
6289
+ * 开始时间
6290
+ 注意:此字段可能返回 null,表示取不到有效值。
6291
+ */
6292
+ Starttime?: string
6293
+ /**
6294
+ * 结束时间
6295
+ 注意:此字段可能返回 null,表示取不到有效值。
6296
+ */
6297
+ Endtime?: string
6298
+ /**
6299
+ * 是否有详情信息
6300
+ 注意:此字段可能返回 null,表示取不到有效值。
6301
+ */
6302
+ HadWoodDetail?: boolean
6303
+ /**
6304
+ * Wood子流程Id
6305
+ 注意:此字段可能返回 null,表示取不到有效值。
6306
+ */
6307
+ WoodJobId?: number
6308
+ /**
6309
+ * 多语言版本Key
6310
+ 注意:此字段可能返回 null,表示取不到有效值。
6311
+ */
6312
+ LanguageKey?: string
6313
+ /**
6314
+ * 如果stage失败,失败原因
6315
+ 注意:此字段可能返回 null,表示取不到有效值。
6316
+ */
6317
+ FailedReason?: string
6318
+ /**
6319
+ * 步骤耗时
6320
+ 注意:此字段可能返回 null,表示取不到有效值。
6321
+ */
6322
+ TimeConsuming?: string
6323
+ }
6324
+
6134
6325
  /**
6135
6326
  * InquiryPriceScaleOutInstance返回参数结构体
6136
6327
  */
@@ -6588,6 +6779,11 @@ export interface NodeHardwareInfo {
6588
6779
  注意:此字段可能返回 null,表示取不到有效值。
6589
6780
  */
6590
6781
  ServicesStatus?: string
6782
+ /**
6783
+ * 备注
6784
+ 注意:此字段可能返回 null,表示取不到有效值。
6785
+ */
6786
+ Remark?: string
6591
6787
  }
6592
6788
 
6593
6789
  /**
@@ -1054,6 +1054,11 @@ export interface ServerlessSpace {
1054
1054
  注意:此字段可能返回 null,表示取不到有效值。
1055
1055
  */
1056
1056
  KibanaLanguage?: string
1057
+ /**
1058
+ * 0
1059
+ 注意:此字段可能返回 null,表示取不到有效值。
1060
+ */
1061
+ ClusterType?: number
1057
1062
  }
1058
1063
 
1059
1064
  /**
@@ -1269,11 +1269,10 @@ p.s.
1269
1269
  * 该接口用于发起合同后,生成用户的签署链接 <br/>
1270
1270
 
1271
1271
  **注意**
1272
- 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
1273
- 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
1274
- 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1272
+ 1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
1273
+ 2. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1275
1274
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1276
- 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1275
+ 3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1277
1276
  */
1278
1277
  async CreateFlowSignUrl(
1279
1278
  req: CreateFlowSignUrlRequest,
@@ -3026,7 +3026,15 @@ export interface ComponentLimit {
3026
3026
  /**
3027
3027
  * 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
3028
3028
 
3029
- 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
3029
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)或者以下印章类型
3030
+
3031
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
3032
+ <li> <b>CONTRACT</b> : 合同专用章</li>
3033
+ <li> <b>FINANCE</b> : 财务专用章</li>
3034
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
3035
+
3036
+ **注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业签署人只能限制类型.若同时指定了印章类型和印章Id,以印章Id为主,印章类型会被忽略`**
3037
+
3030
3038
 
3031
3039
  2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
3032
3040
 
@@ -6334,7 +6342,7 @@ export interface ApproverInfo {
6334
6342
  */
6335
6343
  ApproverNeedSignReview?: boolean
6336
6344
  /**
6337
- * [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
6345
+ * [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID或者印章类型)或签名方式。
6338
6346
 
6339
6347
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
6340
6348
  */
@@ -7638,7 +7646,7 @@ export interface Component {
7638
7646
  <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
7639
7647
  <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
7640
7648
 
7641
- <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
7649
+ <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式
7642
7650
  <ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
7643
7651
  <li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
7644
7652
  <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
@@ -7647,7 +7655,14 @@ export interface Component {
7647
7655
  <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
7648
7656
  <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
7649
7657
  印章的对应关系参考下图
7650
- ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
7658
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<br><br>
7659
+
7660
+ <font color="red">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>,可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型,支持指定以下印章类型
7661
+ <ul><li> <b>OFFICIAL</b> : 企业公章</li>
7662
+ <li> <b>CONTRACT</b> : 合同专用章</li>
7663
+ <li> <b>FINANCE</b> : 财务专用章</li>
7664
+ <li> <b>PERSONNEL</b> : 人事专用章</li></ul>
7665
+ <b>参考样例</b>:`{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>
7651
7666
 
7652
7667
  <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
7653
7668
  <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
@@ -225,6 +225,7 @@ import {
225
225
  UploadFilesRequest,
226
226
  DescribeChannelOrganizationsResponse,
227
227
  ChannelCreateOrganizationBatchSignUrlResponse,
228
+ EmbedUrlOption,
228
229
  UsageDetail,
229
230
  ChannelCreateBatchCancelFlowUrlResponse,
230
231
  OperateChannelTemplateRequest,
@@ -832,6 +833,9 @@ export class Client extends AbstractClient {
832
833
  HttpProfile httpProfile = new HttpProfile();
833
834
  httpProfile.setEndpoint("file.test.ess.tencent.cn");
834
835
  ```
836
+
837
+ <font color="red">相关视频指引</font> <br>
838
+ 1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a><br>
835
839
  */
836
840
  async UploadFiles(
837
841
  req: UploadFilesRequest,
@@ -1152,11 +1156,10 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1152
1156
  * 该接口用于发起合同后,生成用户的签署链接 <br/>
1153
1157
 
1154
1158
  **注意**
1155
- 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
1156
- 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
1157
- 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1159
+ 1. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
1160
+ 2. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
1158
1161
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
1159
- 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1162
+ 3. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
1160
1163
  */
1161
1164
  async ChannelCreateFlowSignUrl(
1162
1165
  req: ChannelCreateFlowSignUrlRequest,