tencentcloud-sdk-nodejs 4.1.245 → 4.1.247
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.
- package/es/common/sdk_version.js +1 -1
- package/es/services/billing/v20180709/billing_client.js +3 -0
- package/es/services/cbs/v20170312/cbs_client.js +39 -0
- package/es/services/csip/v20221121/csip_client.js +46 -16
- package/es/services/iotexplorer/v20190423/iotexplorer_client.js +12 -6
- package/es/services/iss/v20230517/iss_client.js +148 -169
- package/es/services/mongodb/v20190725/mongodb_client.js +3 -0
- package/es/services/monitor/v20180724/monitor_client.js +23 -8
- package/es/services/tcr/v20190924/tcr_client.js +29 -2
- package/es/services/vod/v20180717/vod_client.js +3 -0
- package/es/services/waf/v20180125/waf_client.js +14 -8
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +2 -2
- package/tencentcloud/services/bh/v20230418/bh_models.d.ts +55 -19
- package/tencentcloud/services/billing/v20180709/billing_client.d.ts +5 -1
- package/tencentcloud/services/billing/v20180709/billing_client.js +6 -0
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +107 -24
- package/tencentcloud/services/cam/v20190116/cam_models.d.ts +5 -5
- package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +53 -1
- package/tencentcloud/services/cbs/v20170312/cbs_client.js +78 -0
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +287 -116
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +7 -7
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +100 -90
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +9 -5
- package/tencentcloud/services/csip/v20221121/csip_client.d.ts +57 -17
- package/tencentcloud/services/csip/v20221121/csip_client.js +84 -24
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +609 -219
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +47 -45
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +52 -51
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +18 -2
- package/tencentcloud/services/dataagent/v20250513/dataagent_models.d.ts +48 -24
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +1 -1
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +9 -9
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +4 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +53 -112
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +12 -29
- package/tencentcloud/services/ga2/v20250115/ga2_models.d.ts +80 -22
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +16 -8
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +22 -10
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +93 -37
- package/tencentcloud/services/iss/v20230517/iss_client.d.ts +169 -197
- package/tencentcloud/services/iss/v20230517/iss_client.js +265 -307
- package/tencentcloud/services/iss/v20230517/iss_models.d.ts +91 -725
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -1
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -0
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +45 -18
- package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +29 -9
- package/tencentcloud/services/monitor/v20180724/monitor_client.js +42 -12
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +422 -47
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +104 -31
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +8 -0
- package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +1 -1
- package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +17 -12
- package/tencentcloud/services/rum/v20210622/rum_models.d.ts +27 -23
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +8 -8
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +15 -15
- package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +39 -3
- package/tencentcloud/services/tcr/v20190924/tcr_client.js +57 -3
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +756 -218
- package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +4 -4
- package/tencentcloud/services/tcss/v20201101/tcss_client.js +3 -3
- package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +367 -201
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +39 -30
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_models.d.ts +41 -5
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +4 -4
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +23 -37
- package/tencentcloud/services/tke/v20180525/tke_client.d.ts +12 -4
- package/tencentcloud/services/tke/v20180525/tke_client.js +12 -4
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +4 -0
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_models.d.ts +4 -0
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +148 -73
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +5 -1
- package/tencentcloud/services/vod/v20180717/vod_client.js +6 -0
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +262 -173
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +17 -9
- package/tencentcloud/services/waf/v20180125/waf_client.js +24 -12
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +264 -55
|
@@ -83,23 +83,27 @@ export interface QuerySceneListResponse {
|
|
|
83
83
|
*/
|
|
84
84
|
export interface ModifyChunkRequest {
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
86
|
+
* <p>实例ID</p>
|
|
87
87
|
*/
|
|
88
88
|
InstanceId: string;
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* <p>文件ID</p>
|
|
91
91
|
*/
|
|
92
92
|
FileId: string;
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* <p>切片ID</p>
|
|
95
95
|
*/
|
|
96
96
|
ChunkId?: string;
|
|
97
97
|
/**
|
|
98
|
-
*
|
|
98
|
+
* <p>编辑后的文本</p>
|
|
99
99
|
*/
|
|
100
100
|
Content?: string;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* <p>分段概要</p>
|
|
103
|
+
*/
|
|
104
|
+
Summary?: string;
|
|
105
|
+
/**
|
|
106
|
+
* <p>知识库id</p>
|
|
103
107
|
*/
|
|
104
108
|
KnowledgeBaseId?: string;
|
|
105
109
|
}
|
|
@@ -234,11 +238,19 @@ export interface GetUserInstanceListResponse {
|
|
|
234
238
|
*/
|
|
235
239
|
export interface QueryChunkListResponse {
|
|
236
240
|
/**
|
|
237
|
-
*
|
|
241
|
+
* <p>总数</p>
|
|
238
242
|
*/
|
|
239
243
|
Total?: number;
|
|
240
244
|
/**
|
|
241
|
-
*
|
|
245
|
+
* <p>文档的自动分段数</p>
|
|
246
|
+
*/
|
|
247
|
+
AutoTotal?: number;
|
|
248
|
+
/**
|
|
249
|
+
* <p>文档的手动新建分段数</p>
|
|
250
|
+
*/
|
|
251
|
+
ManualTotal?: number;
|
|
252
|
+
/**
|
|
253
|
+
* <p>分片信息</p>
|
|
242
254
|
*/
|
|
243
255
|
Chunks?: Array<Chunk>;
|
|
244
256
|
/**
|
|
@@ -334,15 +346,15 @@ export interface UploadJob {
|
|
|
334
346
|
*/
|
|
335
347
|
export interface QueryChunkListRequest {
|
|
336
348
|
/**
|
|
337
|
-
*
|
|
349
|
+
* <p>表示第一页</p>
|
|
338
350
|
*/
|
|
339
351
|
Page?: number;
|
|
340
352
|
/**
|
|
341
|
-
*
|
|
353
|
+
* <p>默认一页展示 10 条</p>
|
|
342
354
|
*/
|
|
343
355
|
PageSize?: number;
|
|
344
356
|
/**
|
|
345
|
-
*
|
|
357
|
+
* <p>知识库id</p>
|
|
346
358
|
*/
|
|
347
359
|
KnowledgeBaseId?: string;
|
|
348
360
|
}
|
|
@@ -776,43 +788,43 @@ export interface Record {
|
|
|
776
788
|
*/
|
|
777
789
|
export interface ChatAIRequest {
|
|
778
790
|
/**
|
|
779
|
-
*
|
|
791
|
+
* <p>会话ID</p>
|
|
780
792
|
*/
|
|
781
793
|
SessionId?: string;
|
|
782
794
|
/**
|
|
783
|
-
*
|
|
795
|
+
* <p>实例ID</p>
|
|
784
796
|
*/
|
|
785
797
|
InstanceId?: string;
|
|
786
798
|
/**
|
|
787
|
-
*
|
|
799
|
+
* <p>问题内容</p>
|
|
788
800
|
*/
|
|
789
801
|
Question?: string;
|
|
790
802
|
/**
|
|
791
|
-
*
|
|
803
|
+
* <p>上下文</p>
|
|
792
804
|
*/
|
|
793
805
|
Context?: string;
|
|
794
806
|
/**
|
|
795
|
-
*
|
|
807
|
+
* <p>模型</p>
|
|
796
808
|
*/
|
|
797
809
|
Model?: string;
|
|
798
810
|
/**
|
|
799
|
-
*
|
|
811
|
+
* <p>是否深度思考</p>
|
|
800
812
|
*/
|
|
801
813
|
DeepThinking?: boolean;
|
|
802
814
|
/**
|
|
803
|
-
*
|
|
815
|
+
* <p>数据源id</p>
|
|
804
816
|
*/
|
|
805
817
|
DataSourceIds?: Array<string>;
|
|
806
818
|
/**
|
|
807
|
-
* agent
|
|
819
|
+
* <p>agent类型</p>
|
|
808
820
|
*/
|
|
809
821
|
AgentType?: string;
|
|
810
822
|
/**
|
|
811
|
-
*
|
|
823
|
+
* <p>需要重新生成答案的记录ID</p>
|
|
812
824
|
*/
|
|
813
825
|
OldRecordId?: string;
|
|
814
826
|
/**
|
|
815
|
-
*
|
|
827
|
+
* <p>知识库id列表</p>
|
|
816
828
|
*/
|
|
817
829
|
KnowledgeBaseIds?: Array<string>;
|
|
818
830
|
}
|
|
@@ -874,6 +886,10 @@ export interface FileInfo {
|
|
|
874
886
|
* <p>创建时间</p>
|
|
875
887
|
*/
|
|
876
888
|
CreateTime?: string;
|
|
889
|
+
/**
|
|
890
|
+
* <p>更新时间</p>
|
|
891
|
+
*/
|
|
892
|
+
UpdateTime?: string;
|
|
877
893
|
/**
|
|
878
894
|
* <p>分片策略</p>
|
|
879
895
|
*/
|
|
@@ -997,21 +1013,25 @@ export interface StepInfo {
|
|
|
997
1013
|
*/
|
|
998
1014
|
export interface Chunk {
|
|
999
1015
|
/**
|
|
1000
|
-
*
|
|
1016
|
+
* <p>切片ID</p>
|
|
1001
1017
|
*/
|
|
1002
1018
|
Id?: string;
|
|
1003
1019
|
/**
|
|
1004
|
-
*
|
|
1020
|
+
* <p>切片内容</p>
|
|
1005
1021
|
*/
|
|
1006
1022
|
Content?: string;
|
|
1007
1023
|
/**
|
|
1008
|
-
*
|
|
1024
|
+
* <p>切片的字数</p>
|
|
1009
1025
|
*/
|
|
1010
1026
|
Size?: number;
|
|
1011
1027
|
/**
|
|
1012
|
-
*
|
|
1028
|
+
* <p>切片概要</p>
|
|
1013
1029
|
*/
|
|
1014
1030
|
Summary?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* <p>分段类型</p><p>枚举值:</p><ul><li>0: 自动分段</li><li>1: 新建分段</li></ul>
|
|
1033
|
+
*/
|
|
1034
|
+
ChunkSource?: number;
|
|
1015
1035
|
}
|
|
1016
1036
|
/**
|
|
1017
1037
|
* UpdateScene返回参数结构体
|
|
@@ -1112,6 +1132,10 @@ export interface KnowledgeTaskConfig {
|
|
|
1112
1132
|
* <p>0:不开启图片理解,1:开启图片理解。默认1</p><p>取值范围:[1, 10000]</p><p>默认值:1</p>
|
|
1113
1133
|
*/
|
|
1114
1134
|
EnableImageUnderstanding?: number;
|
|
1135
|
+
/**
|
|
1136
|
+
* <p>是否开启表格结构化提取</p><p>枚举值:</p><ul><li>0: 不开启表格提取</li><li>1: 开启表格提取</li></ul><p>默认值:1</p>
|
|
1137
|
+
*/
|
|
1138
|
+
EnableExtractDb?: number;
|
|
1115
1139
|
}
|
|
1116
1140
|
/**
|
|
1117
1141
|
* UpdateScene请求参数结构体
|
|
@@ -2308,7 +2308,7 @@ export interface DescribeDBDiagEventsRequest {
|
|
|
2308
2308
|
*/
|
|
2309
2309
|
InstanceIds?: Array<string>;
|
|
2310
2310
|
/**
|
|
2311
|
-
* <p>服务产品类型,支持值包括:"mysql" - 云数据库 MySQL,"redis" - 云数据库 Redis,"mariadb"-数据库mariadb,"cynosdb"-数据库 TDSQL-C, "dcdb"-数据库TDSQL MySQL 默认为"mysql"。</p>
|
|
2311
|
+
* <p>服务产品类型,支持值包括:"mysql" - 云数据库 MySQL,"mongodb"- 云数据库MongoDB, "postgres"-云数据库postgres,云数据库"redis" - 云数据库 Redis,"mariadb"-数据库mariadb,"cynosdb"-数据库 TDSQL-C, "dcdb"-数据库TDSQL MySQL 默认为"mysql"。</p>
|
|
2312
2312
|
*/
|
|
2313
2313
|
Product?: string;
|
|
2314
2314
|
/**
|
|
@@ -1373,35 +1373,35 @@ export interface ContinueMigrateJobResponse {
|
|
|
1373
1373
|
*/
|
|
1374
1374
|
export interface CreateMigrationServiceRequest {
|
|
1375
1375
|
/**
|
|
1376
|
-
*
|
|
1376
|
+
* <p>源实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)tdsqlmysql,keewidb,tdstore</p><p>枚举值:</p><ul><li>mysql: MySQL数据库</li></ul>
|
|
1377
1377
|
*/
|
|
1378
1378
|
SrcDatabaseType: string;
|
|
1379
1379
|
/**
|
|
1380
|
-
*
|
|
1380
|
+
* <p>目标实例数据库类型,如mysql,redis,percona,mongodb,postgresql,sqlserver,mariadb,cynosdbmysql(表示TDSQL-C MySQL数据库)tdsqlmysql,keewidb,tdstore,tendis</p><p>枚举值:</p><ul><li>mysql: MySQL数据库</li></ul>
|
|
1381
1381
|
*/
|
|
1382
1382
|
DstDatabaseType: string;
|
|
1383
1383
|
/**
|
|
1384
|
-
*
|
|
1384
|
+
* <p>源实例地域,如:ap-guangzhou</p>
|
|
1385
1385
|
*/
|
|
1386
1386
|
SrcRegion: string;
|
|
1387
1387
|
/**
|
|
1388
|
-
*
|
|
1388
|
+
* <p>目标实例地域,如:ap-guangzhou。注意,目标地域必须和API请求地域保持一致。</p>
|
|
1389
1389
|
*/
|
|
1390
1390
|
DstRegion: string;
|
|
1391
1391
|
/**
|
|
1392
|
-
*
|
|
1392
|
+
* <p>实例规格,包括:small、medium、large、xlarge、2xlarge。当前未计费链路仅支持medium字段值。不同规格类型参考<a href="https://cloud.tencent.com/document/product/571/18736">计费概述</a></p>
|
|
1393
1393
|
*/
|
|
1394
1394
|
InstanceClass: string;
|
|
1395
1395
|
/**
|
|
1396
|
-
*
|
|
1396
|
+
* <p>购买数量,范围为[1,15],默认为1</p>
|
|
1397
1397
|
*/
|
|
1398
1398
|
Count?: number;
|
|
1399
1399
|
/**
|
|
1400
|
-
*
|
|
1400
|
+
* <p>迁移服务名称,最大长度128</p>
|
|
1401
1401
|
*/
|
|
1402
1402
|
JobName?: string;
|
|
1403
1403
|
/**
|
|
1404
|
-
*
|
|
1404
|
+
* <p>标签信息</p>
|
|
1405
1405
|
*/
|
|
1406
1406
|
Tags?: Array<TagItem>;
|
|
1407
1407
|
}
|
|
@@ -2581,7 +2581,7 @@ export interface ModifySubscribeObjectsResponse {
|
|
|
2581
2581
|
*/
|
|
2582
2582
|
export interface CreateMigrationServiceResponse {
|
|
2583
2583
|
/**
|
|
2584
|
-
*
|
|
2584
|
+
* <p>下单成功随机生成的迁移任务id列表,形如:dts-c1f6rs21</p>
|
|
2585
2585
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2586
2586
|
*/
|
|
2587
2587
|
JobIds?: Array<string>;
|
|
@@ -515,6 +515,10 @@ export interface ComputeResourceAdvanceParams {
|
|
|
515
515
|
* <p>节点组Id</p>
|
|
516
516
|
*/
|
|
517
517
|
TkeClusterNodePool?: string;
|
|
518
|
+
/**
|
|
519
|
+
* <p>加入节点池的模式</p><p>枚举值:</p><ul><li>Inherit: 从节点池继承配置</li><li>OnlyJoin: 仅加入节点池,不继承配置</li></ul><p>默认值:Inherit</p>
|
|
520
|
+
*/
|
|
521
|
+
NodePoolJoinMode?: string;
|
|
518
522
|
}
|
|
519
523
|
/**
|
|
520
524
|
* 服务的部署信息
|
|
@@ -465,42 +465,27 @@ export interface FlowApproverUrlInfo {
|
|
|
465
465
|
*/
|
|
466
466
|
export interface NeedReviewApproverInfo {
|
|
467
467
|
/**
|
|
468
|
-
*
|
|
469
|
-
<ul><li> ORGANIZATION 企业(含企业自动签)</li>
|
|
470
|
-
<li>PERSON 个人(含个人自动签)</li></ul>
|
|
468
|
+
* <p>签署方经办人的类型,支持以下类型</p><ul><li> ORGANIZATION 企业(含企业自动签)</li><li>PERSON 个人(含个人自动签)</li></ul>
|
|
471
469
|
*/
|
|
472
470
|
ApproverType: string;
|
|
473
471
|
/**
|
|
474
|
-
*
|
|
472
|
+
* <p>签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。</p>
|
|
475
473
|
*/
|
|
476
474
|
ApproverName: string;
|
|
477
475
|
/**
|
|
478
|
-
*
|
|
476
|
+
* <p>签署方经办人手机号码, 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。</p>
|
|
479
477
|
*/
|
|
480
478
|
ApproverMobile?: string;
|
|
481
479
|
/**
|
|
482
|
-
*
|
|
483
|
-
<ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li>
|
|
484
|
-
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
|
|
485
|
-
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li>
|
|
486
|
-
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
487
|
-
|
|
488
|
-
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
480
|
+
* <p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
489
481
|
*/
|
|
490
482
|
ApproverIdCardType?: string;
|
|
491
483
|
/**
|
|
492
|
-
*
|
|
493
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
494
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li>
|
|
495
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
484
|
+
* <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字。</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
496
485
|
*/
|
|
497
486
|
ApproverIdCardNumber?: string;
|
|
498
487
|
/**
|
|
499
|
-
*
|
|
500
|
-
请确认该名称与企业营业执照中注册的名称一致。
|
|
501
|
-
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
502
|
-
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
|
503
|
-
|
|
488
|
+
* <p>组织机构名称。<br>请确认该名称与企业营业执照中注册的名称一致。<br>如果名称中包含英文括号(),请使用中文括号()代替。<br>如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。</p>
|
|
504
489
|
*/
|
|
505
490
|
OrganizationName?: string;
|
|
506
491
|
}
|
|
@@ -2001,12 +1986,11 @@ export interface Staff {
|
|
|
2001
1986
|
*/
|
|
2002
1987
|
export interface DescribeFileUrlsResponse {
|
|
2003
1988
|
/**
|
|
2004
|
-
*
|
|
2005
|
-
链接不是永久链接, 过期时间受UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
|
|
1989
|
+
* <p>文件URL信息;<br>链接不是永久链接, 过期时间受UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。</p>
|
|
2006
1990
|
*/
|
|
2007
1991
|
FileUrls?: Array<FileUrl>;
|
|
2008
1992
|
/**
|
|
2009
|
-
* URL
|
|
1993
|
+
* <p>URL数量</p>
|
|
2010
1994
|
*/
|
|
2011
1995
|
TotalCount?: number;
|
|
2012
1996
|
/**
|
|
@@ -3715,56 +3699,49 @@ export interface CreateContractComparisonTaskResponse {
|
|
|
3715
3699
|
*/
|
|
3716
3700
|
export interface DescribeFileUrlsRequest {
|
|
3717
3701
|
/**
|
|
3718
|
-
*
|
|
3719
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3702
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
3720
3703
|
*/
|
|
3721
3704
|
Operator: UserInfo;
|
|
3722
3705
|
/**
|
|
3723
|
-
*
|
|
3706
|
+
* <p>文件对应的业务类型,目前支持:<ul><li><strong>FLOW</strong> : <font color="red">如需下载合同文件请选择此项</font></li><li><strong>TEMPLATE</strong> : 如需下载模板文件请选择此项</li><li><strong>DOCUMENT</strong>: 如需下载文档文件请选择此项</li><li><strong>SEAL</strong>: 如需下载印章图片请选择此项</li><li><strong>DIGITFILE</strong>: 如需下载加签文件请选择此项</li><li><strong>ARCHIVE</strong>: 如需下载合同归档文件请选择此项</li></ul></p><p>枚举值:</p><ul><li>FLOW: 如需下载合同文件请选择此项</li><li>TEMPLATE: 如需下载模板文件请选择此项</li><li>DOCUMENT: 如需下载文档文件请选择此项</li><li>SEAL: 如需下载印章图片请选择此项</li><li>DIGITFILE: 如需下载加签文件请选择此项</li><li>ARCHIVE: 如需下载合同归档文件请选择此项</li></ul>
|
|
3724
3707
|
*/
|
|
3725
3708
|
BusinessType: string;
|
|
3726
3709
|
/**
|
|
3727
|
-
*
|
|
3710
|
+
* <p>业务编号的数组,取值如下:<ul><li>流程编号</li><li>模板编号</li><li>文档编号</li><li>印章编号</li><li>加签文件编号</li><li>如需下载合同文件请传入FlowId,最大支持20个资源</li></ul></p>
|
|
3728
3711
|
*/
|
|
3729
3712
|
BusinessIds: Array<string>;
|
|
3730
3713
|
/**
|
|
3731
|
-
*
|
|
3714
|
+
* <p>下载后的文件命名,只有FileType为zip的时候生效</p>
|
|
3732
3715
|
*/
|
|
3733
3716
|
FileName?: string;
|
|
3734
3717
|
/**
|
|
3735
|
-
*
|
|
3736
|
-
<ul>
|
|
3737
|
-
<li>JPG</li>
|
|
3738
|
-
<li>PDF</li>
|
|
3739
|
-
<li>ZIP</li>
|
|
3740
|
-
</ul>
|
|
3718
|
+
* <p>要下载的文件类型,取值如下:</p><ul><li>JPG</li><li>PDF</li><li>ZIP</li></ul>
|
|
3741
3719
|
*/
|
|
3742
3720
|
FileType?: string;
|
|
3743
3721
|
/**
|
|
3744
|
-
*
|
|
3722
|
+
* <p>指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。</p>
|
|
3745
3723
|
*/
|
|
3746
3724
|
Offset?: number;
|
|
3747
3725
|
/**
|
|
3748
|
-
*
|
|
3726
|
+
* <p>指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。</p>
|
|
3749
3727
|
*/
|
|
3750
3728
|
Limit?: number;
|
|
3751
3729
|
/**
|
|
3752
|
-
*
|
|
3730
|
+
* <p>下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)</p>
|
|
3753
3731
|
*/
|
|
3754
3732
|
UrlTtl?: number;
|
|
3755
3733
|
/**
|
|
3756
|
-
*
|
|
3734
|
+
* <p>暂不开放</p>
|
|
3757
3735
|
* @deprecated
|
|
3758
3736
|
*/
|
|
3759
3737
|
CcToken?: string;
|
|
3760
3738
|
/**
|
|
3761
|
-
*
|
|
3739
|
+
* <p>暂不开放</p>
|
|
3762
3740
|
* @deprecated
|
|
3763
3741
|
*/
|
|
3764
3742
|
Scene?: string;
|
|
3765
3743
|
/**
|
|
3766
|
-
*
|
|
3767
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3744
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
3768
3745
|
*/
|
|
3769
3746
|
Agent?: Agent;
|
|
3770
3747
|
}
|
|
@@ -5044,31 +5021,31 @@ export interface ChecklistCategory {
|
|
|
5044
5021
|
*/
|
|
5045
5022
|
export interface HasAuthOrganization {
|
|
5046
5023
|
/**
|
|
5047
|
-
*
|
|
5024
|
+
* <p>授权企业id</p>
|
|
5048
5025
|
*/
|
|
5049
5026
|
OrganizationId?: string;
|
|
5050
5027
|
/**
|
|
5051
|
-
*
|
|
5028
|
+
* <p>授权企业名称</p>
|
|
5052
5029
|
*/
|
|
5053
5030
|
OrganizationName?: string;
|
|
5054
5031
|
/**
|
|
5055
|
-
*
|
|
5032
|
+
* <p>被授权企业id</p>
|
|
5056
5033
|
*/
|
|
5057
5034
|
AuthorizedOrganizationId?: string;
|
|
5058
5035
|
/**
|
|
5059
|
-
*
|
|
5036
|
+
* <p>被授权企业名称</p>
|
|
5060
5037
|
*/
|
|
5061
5038
|
AuthorizedOrganizationName?: string;
|
|
5062
5039
|
/**
|
|
5063
|
-
*
|
|
5040
|
+
* <p>授权模板id(仅当授权方式为模板授权时有值)</p>
|
|
5064
5041
|
*/
|
|
5065
5042
|
TemplateId?: string;
|
|
5066
5043
|
/**
|
|
5067
|
-
*
|
|
5044
|
+
* <p>授权模板名称(仅当授权方式为模板授权时有值)</p>
|
|
5068
5045
|
*/
|
|
5069
5046
|
TemplateName?: string;
|
|
5070
5047
|
/**
|
|
5071
|
-
*
|
|
5048
|
+
* <p>授权时间,格式为时间戳,单位s</p>
|
|
5072
5049
|
*/
|
|
5073
5050
|
AuthorizeTime?: number;
|
|
5074
5051
|
}
|
|
@@ -7146,7 +7123,7 @@ export interface ExtractionFieldResult {
|
|
|
7146
7123
|
*/
|
|
7147
7124
|
export interface DescribeExtendedServiceAuthDetailResponse {
|
|
7148
7125
|
/**
|
|
7149
|
-
*
|
|
7126
|
+
* <p>服务授权的信息列表,根据查询类型返回特定扩展服务的授权状况。</p>
|
|
7150
7127
|
*/
|
|
7151
7128
|
AuthInfoDetail?: AuthInfoDetail;
|
|
7152
7129
|
/**
|
|
@@ -7276,27 +7253,27 @@ export interface DescribeEnterpriseContractReviewChecklistsResponse {
|
|
|
7276
7253
|
*/
|
|
7277
7254
|
export interface AuthInfoDetail {
|
|
7278
7255
|
/**
|
|
7279
|
-
*
|
|
7256
|
+
* <p>扩展服务类型,和入参一致</p>
|
|
7280
7257
|
*/
|
|
7281
7258
|
Type?: string;
|
|
7282
7259
|
/**
|
|
7283
|
-
*
|
|
7260
|
+
* <p>扩展服务名称</p>
|
|
7284
7261
|
*/
|
|
7285
7262
|
Name?: string;
|
|
7286
7263
|
/**
|
|
7287
|
-
*
|
|
7264
|
+
* <p>授权员工列表</p>
|
|
7288
7265
|
*/
|
|
7289
7266
|
HasAuthUserList?: Array<HasAuthUser>;
|
|
7290
7267
|
/**
|
|
7291
|
-
*
|
|
7268
|
+
* <p>授权企业列表(企业自动签时,该字段有值)</p>
|
|
7292
7269
|
*/
|
|
7293
7270
|
HasAuthOrganizationList?: Array<HasAuthOrganization>;
|
|
7294
7271
|
/**
|
|
7295
|
-
*
|
|
7272
|
+
* <p>授权员工列表总数</p>
|
|
7296
7273
|
*/
|
|
7297
7274
|
AuthUserTotal?: number;
|
|
7298
7275
|
/**
|
|
7299
|
-
*
|
|
7276
|
+
* <p>授权企业列表总数</p>
|
|
7300
7277
|
*/
|
|
7301
7278
|
AuthOrganizationTotal?: number;
|
|
7302
7279
|
}
|
|
@@ -8436,32 +8413,29 @@ export interface DescribeIntegrationDepartmentsRequest {
|
|
|
8436
8413
|
*/
|
|
8437
8414
|
export interface DescribeExtendedServiceAuthDetailRequest {
|
|
8438
8415
|
/**
|
|
8439
|
-
*
|
|
8440
|
-
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
8416
|
+
* <p>执行本接口操作的员工信息。<br>注: <code>在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。</code></p>
|
|
8441
8417
|
*/
|
|
8442
8418
|
Operator: UserInfo;
|
|
8443
8419
|
/**
|
|
8444
|
-
*
|
|
8445
|
-
如下所示:
|
|
8446
|
-
<ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
|
|
8447
|
-
<li>BATCH_SIGN:批量签署</li>
|
|
8448
|
-
</ul>
|
|
8449
|
-
|
|
8420
|
+
* <p>要查询的扩展服务类型。<br>如下所示:</p><ul><li>OPEN_SERVER_SIGN:企业静默签署</li><li>BATCH_SIGN:批量签署</li></ul>
|
|
8450
8421
|
*/
|
|
8451
8422
|
ExtendServiceType?: string;
|
|
8452
8423
|
/**
|
|
8453
|
-
*
|
|
8454
|
-
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
8424
|
+
* <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
|
|
8455
8425
|
*/
|
|
8456
8426
|
Agent?: Agent;
|
|
8457
8427
|
/**
|
|
8458
|
-
*
|
|
8428
|
+
* <p>指定每页返回的数据条数,和Offset参数配合使用。 注:<code>1.默认值为20,单页做大值为200。</code></p>
|
|
8459
8429
|
*/
|
|
8460
8430
|
Limit?: number;
|
|
8461
8431
|
/**
|
|
8462
|
-
*
|
|
8432
|
+
* <p>查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:<code>1.offset从0开始,即第一页为0。</code> <code>2.默认从第一页返回。</code></p>
|
|
8463
8433
|
*/
|
|
8464
8434
|
Offset?: number;
|
|
8435
|
+
/**
|
|
8436
|
+
* <p>查询指定的合作方企业的授权信息,当ExtendServiceType=OPEN_SERVER_SIGN:企业静默签署时有效</p>
|
|
8437
|
+
*/
|
|
8438
|
+
PartnerOrganizationName?: string;
|
|
8465
8439
|
}
|
|
8466
8440
|
/**
|
|
8467
8441
|
* CreateOrganizationAuthFile请求参数结构体
|
|
@@ -8585,76 +8559,43 @@ export interface FlowRemarkItem {
|
|
|
8585
8559
|
*/
|
|
8586
8560
|
export interface FillApproverInfo {
|
|
8587
8561
|
/**
|
|
8588
|
-
*
|
|
8589
|
-
模板发起合同时,该参数为必填项。
|
|
8590
|
-
文件发起合同时,该参数无需传值。
|
|
8591
|
-
如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。
|
|
8562
|
+
* <p>签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。<br>模板发起合同时,该参数为必填项。<br>文件发起合同时,该参数无需传值。<br>如果开发者后序用合同模板发起合同,建议保存此值,在用合同模板发起合同中需此值绑定对应的签署经办人 。</p>
|
|
8592
8563
|
*/
|
|
8593
8564
|
RecipientId: string;
|
|
8594
8565
|
/**
|
|
8595
|
-
*
|
|
8596
|
-
WEWORKAPP: 企业微信
|
|
8597
|
-
<br/>仅【企微或签】时指定WEWORKAPP
|
|
8566
|
+
* <p>签署人来源<br>WEWORKAPP: 企业微信<br><br>仅【企微或签】时指定WEWORKAPP</p>
|
|
8598
8567
|
*/
|
|
8599
8568
|
ApproverSource?: string;
|
|
8600
8569
|
/**
|
|
8601
|
-
*
|
|
8602
|
-
<br/>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId
|
|
8570
|
+
* <p>企业微信UserId<br><br>当ApproverSource为WEWORKAPP的企微或签场景下,必须指企业自有应用获取企业微信的UserId</p>
|
|
8603
8571
|
*/
|
|
8604
8572
|
CustomUserId?: string;
|
|
8605
8573
|
/**
|
|
8606
|
-
*
|
|
8574
|
+
* <p>企业签署人的员工姓名。除企业微信应用场景(ApproverSource设置为WEWORKAPP)外,本字段为必填。</p>
|
|
8607
8575
|
*/
|
|
8608
8576
|
ApproverName?: string;
|
|
8609
8577
|
/**
|
|
8610
|
-
*
|
|
8611
|
-
<ul>
|
|
8612
|
-
<li>ApproverSource!=WEWORKAPP时,必传</li>
|
|
8613
|
-
</ul>
|
|
8578
|
+
* <p>补充企业签署人员工手机号</p><ul><li>ApproverSource!=WEWORKAPP时,必传</li></ul>
|
|
8614
8579
|
*/
|
|
8615
8580
|
ApproverMobile?: string;
|
|
8616
8581
|
/**
|
|
8617
|
-
*
|
|
8582
|
+
* <p>补充企业动态签署人时,需要指定对应企业名称</p>
|
|
8618
8583
|
*/
|
|
8619
8584
|
OrganizationName?: string;
|
|
8620
8585
|
/**
|
|
8621
|
-
*
|
|
8622
|
-
<ul><li>ID_CARD 中国大陆居民身份证</li>
|
|
8623
|
-
<li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li>
|
|
8624
|
-
<li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li>
|
|
8625
|
-
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
8626
|
-
|
|
8627
|
-
注: `1.其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
8628
|
-
`2.补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
|
|
8586
|
+
* <p>签署方经办人的证件类型,支持以下类型</p><ul><li>ID_CARD 中国大陆居民身份证</li><li>HONGKONG_AND_MACAO 中国港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul><p>注: 补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。</p>
|
|
8629
8587
|
*/
|
|
8630
8588
|
ApproverIdCardType?: string;
|
|
8631
8589
|
/**
|
|
8632
|
-
*
|
|
8633
|
-
<ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
8634
|
-
<li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字</li>
|
|
8635
|
-
<li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串</li></ul>
|
|
8636
|
-
|
|
8637
|
-
注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
|
|
8590
|
+
* <p>签署方经办人的证件号码,应符合以下规则</p><ul><li>中国大陆居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li><li>中国港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给中国香港居民,“M”字头签发给中国澳门居民;第2位至第11位为数字</li><li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串</li></ul><p>注:<code>补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。</code></p>
|
|
8638
8591
|
*/
|
|
8639
8592
|
ApproverIdCardNumber?: string;
|
|
8640
8593
|
/**
|
|
8641
|
-
*
|
|
8642
|
-
- 补充合同组子合同动态签署人时必传。
|
|
8643
|
-
- 补充普通合同时,请阅读:<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口</a>的接口使用说明
|
|
8594
|
+
* <p>合同流程ID</p><ul><li>补充合同组子合同动态签署人时必传。</li><li>补充普通合同时,请阅读:<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口</a>的接口使用说明</li></ul>
|
|
8644
8595
|
*/
|
|
8645
8596
|
FlowId?: string;
|
|
8646
8597
|
/**
|
|
8647
|
-
*
|
|
8648
|
-
<li>当FillApproverType =0,或签场景补充签署人时,指定是否发送或签领取短信</li>
|
|
8649
|
-
|
|
8650
|
-
<li>SMS:开启或签领取短信通知</li>
|
|
8651
|
-
|
|
8652
|
-
<li>NONE:关闭或签领取短信通知</li>
|
|
8653
|
-
|
|
8654
|
-
<li>当NotifyType=NONE时,可调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl" target="_blank" rel="noopener noreferrer">获取跳转至腾讯电子签小程序的签署链接</a>接口生成签署链接来完成或签领取</li>
|
|
8655
|
-
|
|
8656
|
-
|
|
8657
|
-
|
|
8598
|
+
* <p>通知类型:</p><li>当FillApproverType =0,或签场景补充签署人时,指定是否发送或签领取短信</li><li>SMS:开启或签领取短信通知</li><li>NONE:关闭或签领取短信通知</li><li>当NotifyType=NONE时,可调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateSchemeUrl" target="_blank" rel="noopener noreferrer">获取跳转至腾讯电子签小程序的签署链接</a>接口生成签署链接来完成或签领取</li>
|
|
8658
8599
|
*/
|
|
8659
8600
|
NotifyType?: string;
|
|
8660
8601
|
}
|
|
@@ -13038,7 +12979,7 @@ export interface ApproverInfo {
|
|
|
13038
12979
|
*/
|
|
13039
12980
|
SignComponents?: Array<Component>;
|
|
13040
12981
|
/**
|
|
13041
|
-
* <p>签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a
|
|
12982
|
+
* <p>签署方经办人的证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a><br><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li></p><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li><p>注: 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</p>
|
|
13042
12983
|
*/
|
|
13043
12984
|
ApproverIdCardType?: string;
|
|
13044
12985
|
/**
|