tencentcloud-sdk-nodejs 4.0.936 → 4.0.937

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 (60) hide show
  1. package/CHANGELOG.md +331 -0
  2. package/SERVICE_CHANGELOG.md +485 -100
  3. package/package.json +1 -1
  4. package/products.md +19 -19
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apm/v20210622/apm_models.ts +9 -0
  7. package/src/services/cam/v20190116/cam_client.ts +25 -0
  8. package/src/services/cam/v20190116/cam_models.ts +101 -0
  9. package/src/services/cdb/v20170320/cdb_models.ts +6 -4
  10. package/src/services/dasb/v20191018/dasb_client.ts +20 -7
  11. package/src/services/dasb/v20191018/dasb_models.ts +222 -137
  12. package/src/services/dlc/v20210125/dlc_client.ts +5 -2
  13. package/src/services/dlc/v20210125/dlc_models.ts +200 -88
  14. package/src/services/dsgc/v20190723/dsgc_models.ts +6 -1
  15. package/src/services/emr/v20190103/emr_models.ts +1 -1
  16. package/src/services/ess/v20201111/ess_client.ts +1 -1
  17. package/src/services/ess/v20201111/ess_models.ts +30 -8
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +13 -1
  19. package/src/services/mps/v20190612/mps_models.ts +66 -3
  20. package/src/services/region/v20220627/region_models.ts +10 -11
  21. package/src/services/tat/v20201028/tat_models.ts +5 -0
  22. package/src/services/tcb/v20180608/tcb_models.ts +1 -1
  23. package/src/services/tdmq/v20200217/tdmq_models.ts +2 -2
  24. package/src/services/tmt/v20180321/tmt_models.ts +22 -22
  25. package/src/services/vdb/v20230616/vdb_client.ts +1 -1
  26. package/src/services/vdb/v20230616/vdb_models.ts +14 -1
  27. package/src/services/vod/v20180717/vod_models.ts +16 -4
  28. package/src/services/wedata/v20210820/wedata_client.ts +1 -1
  29. package/tencentcloud/common/sdk_version.d.ts +1 -1
  30. package/tencentcloud/common/sdk_version.js +1 -1
  31. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +9 -0
  32. package/tencentcloud/services/cam/v20190116/cam_client.d.ts +9 -1
  33. package/tencentcloud/services/cam/v20190116/cam_client.js +12 -0
  34. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +96 -0
  35. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +6 -4
  36. package/tencentcloud/services/dasb/v20191018/dasb_client.d.ts +5 -1
  37. package/tencentcloud/services/dasb/v20191018/dasb_client.js +6 -0
  38. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +219 -137
  39. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +2 -2
  40. package/tencentcloud/services/dlc/v20210125/dlc_client.js +1 -1
  41. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +197 -88
  42. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +6 -1
  43. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +1 -1
  44. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +1 -1
  45. package/tencentcloud/services/ess/v20201111/ess_client.js +1 -1
  46. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +30 -8
  47. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +13 -1
  48. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +66 -3
  49. package/tencentcloud/services/region/v20220627/region_models.d.ts +10 -11
  50. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +5 -0
  51. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +1 -1
  52. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +2 -2
  53. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +22 -22
  54. package/tencentcloud/services/vdb/v20230616/vdb_client.d.ts +1 -1
  55. package/tencentcloud/services/vdb/v20230616/vdb_models.d.ts +14 -1
  56. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +16 -4
  57. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -1
  58. package/tencentcloud/services/wedata/v20210820/wedata_client.js +1 -1
  59. package/test/cam.v20190116.test.js +20 -0
  60. package/test/dasb.v20191018.test.js +10 -0
@@ -42,31 +42,31 @@ export interface DescribeResultDownloadResponse {
42
42
  * 下载文件路径
43
43
  注意:此字段可能返回 null,表示取不到有效值。
44
44
  */
45
- Path: string
45
+ Path?: string
46
46
  /**
47
47
  * 任务状态 init | queue | format | compress | success| timeout | error
48
48
  */
49
- Status: string
49
+ Status?: string
50
50
  /**
51
51
  * 任务异常原因
52
52
  注意:此字段可能返回 null,表示取不到有效值。
53
53
  */
54
- Reason: string
54
+ Reason?: string
55
55
  /**
56
- * 临时AK
56
+ * 临时SecretId
57
57
  注意:此字段可能返回 null,表示取不到有效值。
58
58
  */
59
- SecretId: string
59
+ SecretId?: string
60
60
  /**
61
- * 临时SK
61
+ * 临时SecretKey
62
62
  注意:此字段可能返回 null,表示取不到有效值。
63
63
  */
64
- SecretKey: string
64
+ SecretKey?: string
65
65
  /**
66
66
  * 临时Token
67
67
  注意:此字段可能返回 null,表示取不到有效值。
68
68
  */
69
- Token: string
69
+ Token?: string
70
70
  /**
71
71
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
72
72
  */
@@ -437,27 +437,27 @@ export interface DescribeDataEngineEventsResponse {
437
437
  * 事件详细信息
438
438
  注意:此字段可能返回 null,表示取不到有效值。
439
439
  */
440
- Events: Array<HouseEventsInfo>
440
+ Events?: Array<HouseEventsInfo>
441
441
  /**
442
442
  * 分页号
443
443
  注意:此字段可能返回 null,表示取不到有效值。
444
444
  */
445
- Page: number
445
+ Page?: number
446
446
  /**
447
447
  * 分页大小
448
448
  注意:此字段可能返回 null,表示取不到有效值。
449
449
  */
450
- Size: number
450
+ Size?: number
451
451
  /**
452
452
  * 总页数
453
453
  注意:此字段可能返回 null,表示取不到有效值。
454
454
  */
455
- TotalPages: number
455
+ TotalPages?: number
456
456
  /**
457
457
  * 总条数
458
458
  注意:此字段可能返回 null,表示取不到有效值。
459
459
  */
460
- TotalCount: number
460
+ TotalCount?: number
461
461
  /**
462
462
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
463
463
  */
@@ -777,6 +777,79 @@ export interface BatchSqlTask {
777
777
  Message?: string
778
778
  }
779
779
 
780
+ /**
781
+ * CreateNotebookSession请求参数结构体
782
+ */
783
+ export interface CreateNotebookSessionRequest {
784
+ /**
785
+ * Session名称
786
+ */
787
+ Name: string
788
+ /**
789
+ * 类型,当前支持:spark、pyspark、sparkr、sql
790
+ */
791
+ Kind: string
792
+ /**
793
+ * DLC Spark作业引擎名称
794
+ */
795
+ DataEngineName: string
796
+ /**
797
+ * session文件地址,当前支持:cosn://和lakefs://两种路径
798
+ */
799
+ ProgramDependentFiles?: Array<string>
800
+ /**
801
+ * 依赖的jar程序地址,当前支持:cosn://和lakefs://两种路径
802
+ */
803
+ ProgramDependentJars?: Array<string>
804
+ /**
805
+ * 依赖的python程序地址,当前支持:cosn://和lakefs://两种路径
806
+ */
807
+ ProgramDependentPython?: Array<string>
808
+ /**
809
+ * 依赖的pyspark虚拟环境地址,当前支持:cosn://和lakefs://两种路径
810
+ */
811
+ ProgramArchives?: Array<string>
812
+ /**
813
+ * 指定的Driver规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu)
814
+ */
815
+ DriverSize?: string
816
+ /**
817
+ * 指定的Executor规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu)
818
+ */
819
+ ExecutorSize?: string
820
+ /**
821
+ * 指定的Executor数量,默认为1
822
+ */
823
+ ExecutorNumbers?: number
824
+ /**
825
+ * Session相关配置,当前支持:
826
+ 1. dlc.eni: 用户配置的eni网关信息,可以通过该字段设置;
827
+ 2. dlc.role.arn: 用户配置的roleArn鉴权策略配置信息,可以通过该字段设置;
828
+ 3. dlc.sql.set.config: 用户配置的集群配置信息,可以通过该字段设置;
829
+ */
830
+ Arguments?: Array<KVPair>
831
+ /**
832
+ * 代理用户,默认为root
833
+ */
834
+ ProxyUser?: string
835
+ /**
836
+ * 指定的Session超时时间,单位秒,默认3600秒
837
+ */
838
+ TimeoutInSecond?: number
839
+ /**
840
+ * 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于ExecutorNumbers
841
+ */
842
+ ExecutorMaxNumbers?: number
843
+ /**
844
+ * 指定spark版本名称,当前任务使用该spark镜像运行
845
+ */
846
+ SparkImage?: string
847
+ /**
848
+ * 是否继承集群的资源类配置:0:自定义(默认),1:继承集群;
849
+ */
850
+ IsInherit?: number
851
+ }
852
+
780
853
  /**
781
854
  * UpdateDataEngine请求参数结构体
782
855
  */
@@ -2242,7 +2315,7 @@ export interface CreateResultDownloadRequest {
2242
2315
  */
2243
2316
  Format: string
2244
2317
  /**
2245
- * 是否重新生成下载文件,仅当之前任务为 Timout | Error 时有效
2318
+ * 是否重新生成下载文件,仅当之前任务状态为 timeout | error 时有效
2246
2319
  */
2247
2320
  Force?: boolean
2248
2321
  }
@@ -2335,11 +2408,11 @@ export interface AddDMSPartitionsResponse {
2335
2408
  /**
2336
2409
  * 成功数量
2337
2410
  */
2338
- Total: number
2411
+ Total?: number
2339
2412
  /**
2340
2413
  * 分区值
2341
2414
  */
2342
- Partitions: Array<DMSPartition>
2415
+ Partitions?: Array<DMSPartition>
2343
2416
  /**
2344
2417
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2345
2418
  */
@@ -2870,7 +2943,7 @@ export interface DescribeUserTypeResponse {
2870
2943
  * 用户类型。ADMIN:管理员 COMMON:普通用户
2871
2944
  注意:此字段可能返回 null,表示取不到有效值。
2872
2945
  */
2873
- UserType: string
2946
+ UserType?: string
2874
2947
  /**
2875
2948
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2876
2949
  */
@@ -2922,76 +2995,19 @@ export interface DescribeDataEngineRequest {
2922
2995
  }
2923
2996
 
2924
2997
  /**
2925
- * CreateNotebookSession请求参数结构体
2998
+ * 数据脱敏用户组信息
2926
2999
  */
2927
- export interface CreateNotebookSessionRequest {
2928
- /**
2929
- * Session名称
2930
- */
2931
- Name: string
2932
- /**
2933
- * 类型,当前支持:spark、pyspark、sparkr、sql
2934
- */
2935
- Kind: string
2936
- /**
2937
- * DLC Spark作业引擎名称
2938
- */
2939
- DataEngineName: string
2940
- /**
2941
- * session文件地址,当前支持:cosn://和lakefs://两种路径
2942
- */
2943
- ProgramDependentFiles?: Array<string>
2944
- /**
2945
- * 依赖的jar程序地址,当前支持:cosn://和lakefs://两种路径
2946
- */
2947
- ProgramDependentJars?: Array<string>
2948
- /**
2949
- * 依赖的python程序地址,当前支持:cosn://和lakefs://两种路径
2950
- */
2951
- ProgramDependentPython?: Array<string>
2952
- /**
2953
- * 依赖的pyspark虚拟环境地址,当前支持:cosn://和lakefs://两种路径
2954
- */
2955
- ProgramArchives?: Array<string>
2956
- /**
2957
- * 指定的Driver规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu)
2958
- */
2959
- DriverSize?: string
2960
- /**
2961
- * 指定的Executor规格,当前支持:small(默认,1cu)、medium(2cu)、large(4cu)、xlarge(8cu)
2962
- */
2963
- ExecutorSize?: string
2964
- /**
2965
- * 指定的Executor数量,默认为1
2966
- */
2967
- ExecutorNumbers?: number
2968
- /**
2969
- * Session相关配置,当前支持:
2970
- 1. dlc.eni: 用户配置的eni网关信息,可以通过该字段设置;
2971
- 2. dlc.role.arn: 用户配置的roleArn鉴权策略配置信息,可以通过该字段设置;
2972
- 3. dlc.sql.set.config: 用户配置的集群配置信息,可以通过该字段设置;
2973
- */
2974
- Arguments?: Array<KVPair>
2975
- /**
2976
- * 代理用户,默认为root
2977
- */
2978
- ProxyUser?: string
2979
- /**
2980
- * 指定的Session超时时间,单位秒,默认3600秒
2981
- */
2982
- TimeoutInSecond?: number
3000
+ export interface GroupInfo {
2983
3001
  /**
2984
- * 指定的Executor数量(最大值),默认为1,当开启动态分配有效,若未开启,则该值等于ExecutorNumbers
2985
- */
2986
- ExecutorMaxNumbers?: number
2987
- /**
2988
- * 指定spark版本名称,当前任务使用该spark镜像运行
3002
+ * 用户组ID
3003
+ 注意:此字段可能返回 null,表示取不到有效值。
2989
3004
  */
2990
- SparkImage?: string
3005
+ WorkGroupId?: number
2991
3006
  /**
2992
- * 是否继承集群的资源类配置:0:自定义(默认),1:继承集群;
3007
+ * 策略类型
3008
+ 注意:此字段可能返回 null,表示取不到有效值。
2993
3009
  */
2994
- IsInherit?: number
3010
+ StrategyType?: string
2995
3011
  }
2996
3012
 
2997
3013
  /**
@@ -3627,11 +3643,11 @@ export interface DescribeDMSPartitionsResponse {
3627
3643
  /**
3628
3644
  * 分区信息
3629
3645
  */
3630
- Partitions: Array<DMSPartition>
3646
+ Partitions?: Array<DMSPartition>
3631
3647
  /**
3632
3648
  * 总数
3633
3649
  */
3634
- Total: number
3650
+ Total?: number
3635
3651
  /**
3636
3652
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3637
3653
  */
@@ -4631,6 +4647,11 @@ export interface DatasourceConnectionConfig {
4631
4647
  注意:此字段可能返回 null,表示取不到有效值。
4632
4648
  */
4633
4649
  TDSQLPostgreSql?: DataSourceInfo
4650
+ /**
4651
+ * Doris数据源连接的属性
4652
+ 注意:此字段可能返回 null,表示取不到有效值。
4653
+ */
4654
+ TCHouseD?: TCHouseD
4634
4655
  }
4635
4656
 
4636
4657
  /**
@@ -6052,6 +6073,11 @@ export interface ResourceInfo {
6052
6073
  注意:此字段可能返回 null,表示取不到有效值。
6053
6074
  */
6054
6075
  Status?: number
6076
+ /**
6077
+ * 标准引擎资源组信息
6078
+ 注意:此字段可能返回 null,表示取不到有效值。
6079
+ */
6080
+ ResourceGroupName?: string
6055
6081
  }
6056
6082
 
6057
6083
  /**
@@ -7396,6 +7422,52 @@ export interface DescribeSparkAppJobRequest {
7396
7422
  JobName?: string
7397
7423
  }
7398
7424
 
7425
+ /**
7426
+ * Doirs数据源详细信息
7427
+ */
7428
+ export interface TCHouseD {
7429
+ /**
7430
+ * 数据源实例的唯一ID
7431
+ 注意:此字段可能返回 null,表示取不到有效值。
7432
+ */
7433
+ InstanceId?: string
7434
+ /**
7435
+ * 数据源名称
7436
+ 注意:此字段可能返回 null,表示取不到有效值。
7437
+ */
7438
+ InstanceName?: string
7439
+ /**
7440
+ * 数据源的JDBC
7441
+ 注意:此字段可能返回 null,表示取不到有效值。
7442
+ */
7443
+ JdbcUrl?: string
7444
+ /**
7445
+ * 用于访问数据源的用户
7446
+ 注意:此字段可能返回 null,表示取不到有效值。
7447
+ */
7448
+ User?: string
7449
+ /**
7450
+ * 数据源访问密码,需要base64编码
7451
+ 注意:此字段可能返回 null,表示取不到有效值。
7452
+ */
7453
+ Password?: string
7454
+ /**
7455
+ * 数据源的VPC和子网信息
7456
+ 注意:此字段可能返回 null,表示取不到有效值。
7457
+ */
7458
+ Location?: DatasourceConnectionLocation
7459
+ /**
7460
+ * 默认数据库名
7461
+ 注意:此字段可能返回 null,表示取不到有效值。
7462
+ */
7463
+ DbName?: string
7464
+ /**
7465
+ * 访问信息
7466
+ 注意:此字段可能返回 null,表示取不到有效值。
7467
+ */
7468
+ AccessInfo?: string
7469
+ }
7470
+
7399
7471
  /**
7400
7472
  * CreateResultDownload返回参数结构体
7401
7473
  */
@@ -7403,7 +7475,7 @@ export interface CreateResultDownloadResponse {
7403
7475
  /**
7404
7476
  * 下载任务Id
7405
7477
  */
7406
- DownloadId: string
7478
+ DownloadId?: string
7407
7479
  /**
7408
7480
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7409
7481
  */
@@ -8283,6 +8355,42 @@ export interface DescribeEngineUsageInfoRequest {
8283
8355
  DataEngineId: string
8284
8356
  }
8285
8357
 
8358
+ /**
8359
+ * 数据脱敏策略信息
8360
+ */
8361
+ export interface DataMaskStrategyInfo {
8362
+ /**
8363
+ * 策略名称
8364
+ 注意:此字段可能返回 null,表示取不到有效值。
8365
+ */
8366
+ StrategyName?: string
8367
+ /**
8368
+ * MASK_SHOW_FIRST_4; MASK_SHOW_LAST_4;MASK_HASH; MASK_DATE_SHOW_YEAR; MASK_NULL; MASK_DEFAULT 等
8369
+ 注意:此字段可能返回 null,表示取不到有效值。
8370
+ */
8371
+ StrategyType?: string
8372
+ /**
8373
+ * 策略描述
8374
+ 注意:此字段可能返回 null,表示取不到有效值。
8375
+ */
8376
+ StrategyDesc?: string
8377
+ /**
8378
+ * 用户组策略列表
8379
+ 注意:此字段可能返回 null,表示取不到有效值。
8380
+ */
8381
+ Groups?: Array<GroupInfo>
8382
+ /**
8383
+ * 用户子账号uin列表,按;拼接
8384
+ 注意:此字段可能返回 null,表示取不到有效值。
8385
+ */
8386
+ Users?: string
8387
+ /**
8388
+ * 策略Id
8389
+ 注意:此字段可能返回 null,表示取不到有效值。
8390
+ */
8391
+ StrategyId?: string
8392
+ }
8393
+
8286
8394
  /**
8287
8395
  * RollbackDataEngineImage返回参数结构体
8288
8396
  */
@@ -9014,8 +9122,7 @@ export interface Column {
9014
9122
  */
9015
9123
  Name: string
9016
9124
  /**
9017
- * 列类型,支持如下类型定义:
9018
- string|tinyint|smallint|int|bigint|boolean|float|double|decimal|timestamp|date|binary|array<data_type>|map<primitive_type, data_type>|struct<col_name : data_type [COMMENT col_comment], ...>|uniontype<data_type, data_type, ...>。
9125
+ * string|tinyint|smallint|int|bigint|boolean|float|double|decimal|timestamp|date|binary|array|map|struct|uniontype
9019
9126
  */
9020
9127
  Type: string
9021
9128
  /**
@@ -9058,6 +9165,11 @@ string|tinyint|smallint|int|bigint|boolean|float|double|decimal|timestamp|date|b
9058
9165
  注意:此字段可能返回 null,表示取不到有效值。
9059
9166
  */
9060
9167
  IsPartition?: boolean
9168
+ /**
9169
+ * 数据脱敏策略信息
9170
+ 注意:此字段可能返回 null,表示取不到有效值。
9171
+ */
9172
+ DataMaskStrategyInfo?: DataMaskStrategyInfo
9061
9173
  }
9062
9174
 
9063
9175
  /**
@@ -9464,7 +9576,7 @@ export interface DescribeDataEngineResponse {
9464
9576
  /**
9465
9577
  * 数据引擎详细信息
9466
9578
  */
9467
- DataEngine: DataEngineInfo
9579
+ DataEngine?: DataEngineInfo
9468
9580
  /**
9469
9581
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
9470
9582
  */
@@ -2102,7 +2102,7 @@ export interface DescribeDSPAAssessmentTemplatesRequest {
2102
2102
  */
2103
2103
  Limit?: number
2104
2104
  /**
2105
- * 过滤项。支持模糊搜索:(TemplateId,TemplateName)支持过滤:Source:模板来源,system / userUseType:模板类型,auto,semi-auto,law等Status:模板启用状态,draft / launched
2105
+ * 过滤项。支持模糊搜索:(TemplateId,TemplateName)支持过滤:Source:模板来源,system / userUseType:模板类型,auto,semi-auto,law等Status:模板启用状态,draft / launched,ComplianceId:关联的分类分级模版id
2106
2106
  */
2107
2107
  Filters?: Array<DspaAssessmentFilter>
2108
2108
  }
@@ -4082,6 +4082,11 @@ export interface DbInfo {
4082
4082
  注意:此字段可能返回 null,表示取不到有效值。
4083
4083
  */
4084
4084
  ValidStatus?: string
4085
+ /**
4086
+ * 绑定的类型
4087
+ 注意:此字段可能返回 null,表示取不到有效值。
4088
+ */
4089
+ BindType?: string
4085
4090
  }
4086
4091
 
4087
4092
  /**
@@ -629,7 +629,7 @@ export interface DescribeServiceNodeInfosRequest {
629
629
  */
630
630
  HealthStateId?: string
631
631
  /**
632
- * 服务组件名称,都是大写比如YARN
632
+ * 服务组件名称,都是大写例如YARN
633
633
  */
634
634
  ServiceName?: string
635
635
  /**
@@ -1555,7 +1555,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1555
1555
  }
1556
1556
 
1557
1557
  /**
1558
- * 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
1558
+ * 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容,包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
1559
1559
  */
1560
1560
  async DescribeFlowComponents(
1561
1561
  req: DescribeFlowComponentsRequest,
@@ -1998,7 +1998,7 @@ export interface CreateFlowGroupByFilesRequest {
1998
1998
  */
1999
1999
  export interface DescribeFlowComponentsResponse {
2000
2000
  /**
2001
- * 合同流程关联的填写控件信息,按照参与方进行分类返回。
2001
+ * 合同流程关联的填写控件信息,包括填写控件的归属方以及是否填写等内容。
2002
2002
  注意:此字段可能返回 null,表示取不到有效值。
2003
2003
  */
2004
2004
  RecipientComponentInfos?: Array<RecipientComponentInfo>
@@ -2595,6 +2595,14 @@ export interface CreateFlowRequest {
2595
2595
  * @deprecated
2596
2596
  */
2597
2597
  CallbackUrl?: string
2598
+ /**
2599
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下:
2600
+ <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>
2601
+
2602
+ 效果如下:
2603
+ ![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
2604
+ */
2605
+ FlowDisplayType?: number
2598
2606
  }
2599
2607
 
2600
2608
  /**
@@ -4134,6 +4142,10 @@ export interface CreateFlowByFilesRequest {
4134
4142
  注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
4135
4143
  */
4136
4144
  NeedSignReview?: boolean
4145
+ /**
4146
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
4147
+ */
4148
+ FlowDisplayType?: number
4137
4149
  }
4138
4150
 
4139
4151
  /**
@@ -4219,6 +4231,10 @@ false:有序签
4219
4231
  示例值:E_PRESCRIPTION_AUTO_SIGN
4220
4232
  */
4221
4233
  AutoSignScene?: string
4234
+ /**
4235
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
4236
+ */
4237
+ FlowDisplayType?: number
4222
4238
  }
4223
4239
 
4224
4240
  /**
@@ -4241,15 +4257,18 @@ export interface CreateFlowSignUrlResponse {
4241
4257
  export interface RegisterInfo {
4242
4258
  /**
4243
4259
  * 法人姓名
4260
+ 注意:此字段可能返回 null,表示取不到有效值。
4244
4261
  */
4245
4262
  LegalName: string
4246
4263
  /**
4247
4264
  * 社会统一信用代码
4265
+ 注意:此字段可能返回 null,表示取不到有效值。
4248
4266
  * @deprecated
4249
4267
  */
4250
4268
  Uscc?: string
4251
4269
  /**
4252
4270
  * 社会统一信用代码
4271
+ 注意:此字段可能返回 null,表示取不到有效值。
4253
4272
  */
4254
4273
  UnifiedSocialCreditCode?: string
4255
4274
  }
@@ -5139,14 +5158,17 @@ export interface HasAuthOrganization {
5139
5158
  */
5140
5159
  export interface RecipientComponentInfo {
5141
5160
  /**
5142
- * 参与方Id
5161
+ * 签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方
5143
5162
  注意:此字段可能返回 null,表示取不到有效值。
5144
5163
  */
5145
5164
  RecipientId?: string
5146
5165
  /**
5147
5166
  * 参与方填写状态
5148
- <ul><li>0-未填写</li>
5149
- <li>1-已填写</li></ul>
5167
+ <ul>
5168
+ <li>**空值** : 此参与方没有填写控件</li>
5169
+ <li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>
5170
+ <li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
5171
+
5150
5172
  注意:此字段可能返回 null,表示取不到有效值。
5151
5173
  */
5152
5174
  RecipientFillStatus?: string
@@ -5158,7 +5180,7 @@ export interface RecipientComponentInfo {
5158
5180
  */
5159
5181
  IsPromoter?: boolean
5160
5182
  /**
5161
- * 填写控件列表
5183
+ * 改参与方填写控件信息列表
5162
5184
  注意:此字段可能返回 null,表示取不到有效值。
5163
5185
  */
5164
5186
  Components?: Array<FilledComponent>
@@ -5232,8 +5254,8 @@ export interface DescribeFlowComponentsRequest {
5232
5254
  Operator: UserInfo
5233
5255
  /**
5234
5256
  * 合同流程ID,为32位字符串。
5235
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
5236
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)
5257
+
5258
+ [点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
5237
5259
  */
5238
5260
  FlowId: string
5239
5261
  /**
@@ -5968,7 +5990,7 @@ export interface CreateFlowSignUrlRequest {
5968
5990
  * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
5969
5991
 
5970
5992
  注:
5971
- `1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
5993
+ `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
5972
5994
  `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
5973
5995
  */
5974
5996
  FlowApproverInfos?: Array<FlowCreateApprover>
@@ -1061,6 +1061,10 @@ export interface FlowFileInfo {
1061
1061
  * 本企业(发起方企业)是否需要签署审批
1062
1062
  */
1063
1063
  NeedSignReview?: boolean
1064
+ /**
1065
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
1066
+ */
1067
+ FlowDisplayType?: number
1064
1068
  }
1065
1069
 
1066
1070
  /**
@@ -1921,6 +1925,10 @@ MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverM
1921
1925
  * @deprecated
1922
1926
  */
1923
1927
  Operator?: UserInfo
1928
+ /**
1929
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
1930
+ */
1931
+ FlowDisplayType?: number
1924
1932
  }
1925
1933
 
1926
1934
  /**
@@ -4183,6 +4191,10 @@ export interface FlowInfo {
4183
4191
  注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
4184
4192
  */
4185
4193
  AutoSignScene?: string
4194
+ /**
4195
+ * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
4196
+ */
4197
+ FlowDisplayType?: number
4186
4198
  }
4187
4199
 
4188
4200
  /**
@@ -8278,7 +8290,7 @@ export interface ChannelCreateFlowSignUrlRequest {
8278
8290
  若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。
8279
8291
 
8280
8292
  注:
8281
- `1. 签署人只能有手写签名、时间类型、印章类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
8293
+ `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
8282
8294
  `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
8283
8295
  */
8284
8296
  FlowApproverInfos?: Array<FlowApproverInfo>