tencentcloud-sdk-nodejs 4.0.667 → 4.0.669
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/CHANGELOG.md +339 -0
- package/SERVICE_CHANGELOG.md +329 -66
- package/package.json +1 -1
- package/products.md +24 -24
- package/src/common/sdk_version.ts +1 -1
- package/src/services/cam/v20190116/cam_models.ts +11 -11
- package/src/services/cdb/v20170320/cdb_client.ts +13 -30
- package/src/services/cdb/v20170320/cdb_models.ts +0 -54
- package/src/services/cdn/v20180606/cdn_models.ts +4 -0
- package/src/services/cls/v20201016/cls_client.ts +4 -2
- package/src/services/cls/v20201016/cls_models.ts +1 -1
- package/src/services/cwp/v20180228/cwp_models.ts +5 -3
- package/src/services/cynosdb/v20190107/cynosdb_client.ts +1 -1
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +17 -13
- package/src/services/dts/v20211206/dts_client.ts +30 -6
- package/src/services/dts/v20211206/dts_models.ts +80 -0
- package/src/services/ecm/v20190719/ecm_models.ts +4 -0
- package/src/services/ess/v20201111/ess_client.ts +2 -3
- package/src/services/ess/v20201111/ess_models.ts +135 -143
- package/src/services/essbasic/v20210526/essbasic_client.ts +16 -7
- package/src/services/essbasic/v20210526/essbasic_models.ts +108 -34
- package/src/services/iotvideo/v20211125/iotvideo_client.ts +24 -12
- package/src/services/iotvideo/v20211125/iotvideo_models.ts +42 -0
- package/src/services/lcic/v20220817/lcic_client.ts +15 -3
- package/src/services/lcic/v20220817/lcic_models.ts +32 -12
- package/src/services/mps/v20190612/mps_client.ts +1 -0
- package/src/services/mps/v20190612/mps_models.ts +45 -13
- package/src/services/nlp/v20190408/nlp_client.ts +15 -0
- package/src/services/nlp/v20190408/nlp_models.ts +117 -0
- package/src/services/ocr/v20181119/ocr_client.ts +1 -1
- package/src/services/privatedns/v20201028/privatedns_models.ts +5 -5
- package/src/services/tcb/v20180608/tcb_models.ts +19 -14
- package/src/services/tdmq/v20200217/tdmq_models.ts +1 -1
- package/src/services/tse/v20201207/tse_client.ts +152 -33
- package/src/services/tse/v20201207/tse_models.ts +792 -121
- package/src/services/tts/v20190823/tts_client.ts +0 -1
- package/src/services/vpc/v20170312/vpc_models.ts +5 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/cam/v20190116/cam_models.d.ts +11 -11
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -13
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -16
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +0 -51
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +4 -0
- package/tencentcloud/services/cls/v20201016/cls_client.d.ts +2 -0
- package/tencentcloud/services/cls/v20201016/cls_client.js +2 -0
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +5 -3
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +1 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +17 -13
- package/tencentcloud/services/dts/v20211206/dts_client.d.ts +11 -3
- package/tencentcloud/services/dts/v20211206/dts_client.js +15 -3
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +76 -0
- package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +4 -0
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +0 -1
- package/tencentcloud/services/ess/v20201111/ess_client.js +0 -1
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +135 -143
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +14 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -5
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +107 -34
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.d.ts +9 -5
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_client.js +12 -6
- package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +40 -0
- package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +5 -1
- package/tencentcloud/services/lcic/v20220817/lcic_client.js +6 -0
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +30 -12
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +44 -13
- package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +5 -1
- package/tencentcloud/services/nlp/v20190408/nlp_client.js +6 -0
- package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +112 -0
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
- package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +5 -5
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +19 -14
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +1 -1
- package/tencentcloud/services/tse/v20201207/tse_client.d.ts +45 -9
- package/tencentcloud/services/tse/v20201207/tse_client.js +66 -12
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +770 -128
- package/tencentcloud/services/tts/v20190823/tts_client.d.ts +0 -1
- package/tencentcloud/services/tts/v20190823/tts_client.js +0 -1
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +5 -1
- package/test/cdb.v20170320.test.js +4 -14
- package/test/dts.v20211206.test.js +22 -2
- package/test/iotvideo.v20211125.test.js +14 -4
- package/test/lcic.v20220817.test.js +10 -0
- package/test/nlp.v20190408.test.js +10 -0
- package/test/tse.v20201207.test.js +98 -8
|
@@ -35,6 +35,15 @@ export interface ModifyMigrationJobResponse {
|
|
|
35
35
|
*/
|
|
36
36
|
RequestId?: string;
|
|
37
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* ModifyMigrateRateLimit返回参数结构体
|
|
40
|
+
*/
|
|
41
|
+
export interface ModifyMigrateRateLimitResponse {
|
|
42
|
+
/**
|
|
43
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
44
|
+
*/
|
|
45
|
+
RequestId?: string;
|
|
46
|
+
}
|
|
38
47
|
/**
|
|
39
48
|
* ModifyMigrateJobSpec请求参数结构体
|
|
40
49
|
*/
|
|
@@ -87,6 +96,15 @@ export interface StepTip {
|
|
|
87
96
|
*/
|
|
88
97
|
SkipInfo?: string;
|
|
89
98
|
}
|
|
99
|
+
/**
|
|
100
|
+
* ModifySyncRateLimit返回参数结构体
|
|
101
|
+
*/
|
|
102
|
+
export interface ModifySyncRateLimitResponse {
|
|
103
|
+
/**
|
|
104
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
105
|
+
*/
|
|
106
|
+
RequestId?: string;
|
|
107
|
+
}
|
|
90
108
|
/**
|
|
91
109
|
* DestroyMigrateJob请求参数结构体
|
|
92
110
|
*/
|
|
@@ -228,6 +246,35 @@ export interface ContinueMigrateJobRequest {
|
|
|
228
246
|
*/
|
|
229
247
|
JobId: string;
|
|
230
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* ModifySyncRateLimit请求参数结构体
|
|
251
|
+
*/
|
|
252
|
+
export interface ModifySyncRateLimitRequest {
|
|
253
|
+
/**
|
|
254
|
+
* 迁移任务ID
|
|
255
|
+
*/
|
|
256
|
+
JobId: string;
|
|
257
|
+
/**
|
|
258
|
+
* 同步任务全量导出线程数、有效值为 1-16
|
|
259
|
+
*/
|
|
260
|
+
DumpThread?: number;
|
|
261
|
+
/**
|
|
262
|
+
* 同步任务全量导出的 Rps 限制、需要大于 0
|
|
263
|
+
*/
|
|
264
|
+
DumpRps?: number;
|
|
265
|
+
/**
|
|
266
|
+
* 同步任务全量导入线程数、有效值为 1-16
|
|
267
|
+
*/
|
|
268
|
+
LoadThread?: number;
|
|
269
|
+
/**
|
|
270
|
+
* 同步任务增量导入线程数、有效值为 1-128
|
|
271
|
+
*/
|
|
272
|
+
SinkerThread?: number;
|
|
273
|
+
/**
|
|
274
|
+
* 同步任务全量导入的Rps
|
|
275
|
+
*/
|
|
276
|
+
LoadRps?: number;
|
|
277
|
+
}
|
|
231
278
|
/**
|
|
232
279
|
* DescribeCheckSyncJobResult请求参数结构体
|
|
233
280
|
*/
|
|
@@ -2220,6 +2267,35 @@ export interface ResumeSyncJobRequest {
|
|
|
2220
2267
|
*/
|
|
2221
2268
|
JobId: string;
|
|
2222
2269
|
}
|
|
2270
|
+
/**
|
|
2271
|
+
* ModifyMigrateRateLimit请求参数结构体
|
|
2272
|
+
*/
|
|
2273
|
+
export interface ModifyMigrateRateLimitRequest {
|
|
2274
|
+
/**
|
|
2275
|
+
* 迁移任务ID
|
|
2276
|
+
*/
|
|
2277
|
+
JobId: string;
|
|
2278
|
+
/**
|
|
2279
|
+
* 迁移任务全量导出线程数、有效值为 1-16
|
|
2280
|
+
*/
|
|
2281
|
+
DumpThread?: number;
|
|
2282
|
+
/**
|
|
2283
|
+
* 迁移全量导出的 Rps 限制、需要大于 0
|
|
2284
|
+
*/
|
|
2285
|
+
DumpRps?: number;
|
|
2286
|
+
/**
|
|
2287
|
+
* 迁移任务全量导入线程数、有效值为 1-16
|
|
2288
|
+
*/
|
|
2289
|
+
LoadThread?: number;
|
|
2290
|
+
/**
|
|
2291
|
+
* 迁移任务增量导入线程数、有效值为 1-128
|
|
2292
|
+
*/
|
|
2293
|
+
SinkerThread?: number;
|
|
2294
|
+
/**
|
|
2295
|
+
* 全量导入Rps限制
|
|
2296
|
+
*/
|
|
2297
|
+
LoadRps?: number;
|
|
2298
|
+
}
|
|
2223
2299
|
/**
|
|
2224
2300
|
* 用于一致性校验的表配置
|
|
2225
2301
|
*/
|
|
@@ -7443,6 +7443,10 @@ export interface CreateVpcRequest {
|
|
|
7443
7443
|
* 描述信息
|
|
7444
7444
|
*/
|
|
7445
7445
|
Description?: string;
|
|
7446
|
+
/**
|
|
7447
|
+
* 网络运营商类型 取值范围:'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调
|
|
7448
|
+
*/
|
|
7449
|
+
ISPTypes?: Array<ISPTypeItem>;
|
|
7446
7450
|
}
|
|
7447
7451
|
/**
|
|
7448
7452
|
* DescribeSecurityGroupAssociationStatistics请求参数结构体
|
|
@@ -274,7 +274,6 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
274
274
|
CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
|
|
275
275
|
/**
|
|
276
276
|
* 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
|
|
277
|
-
注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
|
|
278
277
|
*/
|
|
279
278
|
DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
|
|
280
279
|
/**
|
|
@@ -388,7 +388,6 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
|
|
|
388
388
|
}
|
|
389
389
|
/**
|
|
390
390
|
* 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
|
|
391
|
-
注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
|
|
392
391
|
*/
|
|
393
392
|
async DescribeFlowComponents(req, cb) {
|
|
394
393
|
return this.request("DescribeFlowComponents", req, cb);
|
|
@@ -785,7 +785,7 @@ export interface CreateConvertTaskApiRequest {
|
|
|
785
785
|
*/
|
|
786
786
|
ResourceName: string;
|
|
787
787
|
/**
|
|
788
|
-
*
|
|
788
|
+
* 文件Id,通过UploadFiles获取
|
|
789
789
|
*/
|
|
790
790
|
ResourceId: string;
|
|
791
791
|
/**
|
|
@@ -1525,13 +1525,19 @@ export interface BindEmployeeUserIdWithClientOpenIdRequest {
|
|
|
1525
1525
|
*/
|
|
1526
1526
|
export interface DescribeIntegrationDepartmentsRequest {
|
|
1527
1527
|
/**
|
|
1528
|
-
*
|
|
1528
|
+
* 执行本接口操作的员工信息。
|
|
1529
|
+
注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
|
|
1529
1530
|
*/
|
|
1530
1531
|
Operator: UserInfo;
|
|
1531
1532
|
/**
|
|
1532
1533
|
* 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
|
|
1533
1534
|
*/
|
|
1534
1535
|
QueryType: number;
|
|
1536
|
+
/**
|
|
1537
|
+
* 代理企业和员工的信息。
|
|
1538
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
1539
|
+
*/
|
|
1540
|
+
Agent?: Agent;
|
|
1535
1541
|
/**
|
|
1536
1542
|
* 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
|
|
1537
1543
|
*/
|
|
@@ -2672,13 +2678,19 @@ export interface DescribeFlowComponentsRequest {
|
|
|
2672
2678
|
*/
|
|
2673
2679
|
export interface CreateIntegrationDepartmentRequest {
|
|
2674
2680
|
/**
|
|
2675
|
-
*
|
|
2681
|
+
* 执行本接口操作的员工信息。
|
|
2682
|
+
注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
|
|
2676
2683
|
*/
|
|
2677
2684
|
Operator: UserInfo;
|
|
2678
2685
|
/**
|
|
2679
2686
|
* 部门名称,不超过50个字符
|
|
2680
2687
|
*/
|
|
2681
2688
|
DeptName: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* 代理企业和员工的信息。
|
|
2691
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
2692
|
+
*/
|
|
2693
|
+
Agent?: Agent;
|
|
2682
2694
|
/**
|
|
2683
2695
|
* 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
|
|
2684
2696
|
*/
|
|
@@ -3112,24 +3124,28 @@ export interface DeleteIntegrationRoleUsersRequest {
|
|
|
3112
3124
|
*/
|
|
3113
3125
|
export interface CreateFlowByFilesRequest {
|
|
3114
3126
|
/**
|
|
3115
|
-
*
|
|
3116
|
-
使用此接口时,必须填写userId。
|
|
3117
|
-
在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
3127
|
+
* 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
3118
3128
|
支持填入集团子公司经办人 userId 代发合同。
|
|
3129
|
+
|
|
3130
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3119
3131
|
*/
|
|
3120
3132
|
Operator: UserInfo;
|
|
3121
3133
|
/**
|
|
3122
3134
|
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
3135
|
+
|
|
3123
3136
|
该名称还将用于合同签署完成后的下载文件名。
|
|
3124
3137
|
*/
|
|
3125
3138
|
FlowName: string;
|
|
3126
3139
|
/**
|
|
3127
3140
|
* 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
3141
|
+
|
|
3128
3142
|
如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
|
|
3129
3143
|
*/
|
|
3130
3144
|
Approvers: Array<ApproverInfo>;
|
|
3131
3145
|
/**
|
|
3132
|
-
* 本合同流程需包含的PDF
|
|
3146
|
+
* 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
|
|
3147
|
+
|
|
3148
|
+
注: `目前,此接口仅支持单个文件发起。`
|
|
3133
3149
|
*/
|
|
3134
3150
|
FileIds: Array<string>;
|
|
3135
3151
|
/**
|
|
@@ -3142,43 +3158,38 @@ export interface CreateFlowByFilesRequest {
|
|
|
3142
3158
|
FlowType?: string;
|
|
3143
3159
|
/**
|
|
3144
3160
|
* 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
|
|
3161
|
+
<ul><li> 单行文本控件 </li>
|
|
3162
|
+
<li> 多行文本控件 </li>
|
|
3163
|
+
<li> 勾选框控件 </li>
|
|
3164
|
+
<li> 数字控件 </li>
|
|
3165
|
+
<li> 图片控件 </li>
|
|
3166
|
+
<li> 动态表格等填写控件</li></ul>
|
|
3151
3167
|
*/
|
|
3152
3168
|
Components?: Array<Component>;
|
|
3153
3169
|
/**
|
|
3154
3170
|
* 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
|
3155
|
-
|
|
3171
|
+
|
|
3172
|
+
注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3156
3173
|
*/
|
|
3157
3174
|
CcInfos?: Array<CcInfo>;
|
|
3158
3175
|
/**
|
|
3159
3176
|
* 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
- 1:签署完成后通知
|
|
3177
|
+
<ul><li> **0**:合同发起时通知(默认值)</li>
|
|
3178
|
+
<li> **1**:签署完成后通知</li></ul>
|
|
3163
3179
|
*/
|
|
3164
3180
|
CcNotifyType?: number;
|
|
3165
3181
|
/**
|
|
3166
3182
|
* 是否为预览模式,取值如下:
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
|
|
3183
|
+
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
3184
|
+
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
3171
3185
|
*/
|
|
3172
3186
|
NeedPreview?: boolean;
|
|
3173
3187
|
/**
|
|
3174
|
-
*
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
- 1 :H5链接 ,点开后在浏览器中展示合同的样子
|
|
3188
|
+
* 预览模式下产生的预览链接类型
|
|
3189
|
+
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
3190
|
+
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
3191
|
+
注: `此参数在NeedPreview 为true时有效`
|
|
3180
3192
|
|
|
3181
|
-
注意: 此参数在NeedPreview 为true时有效
|
|
3182
3193
|
*/
|
|
3183
3194
|
PreviewType?: number;
|
|
3184
3195
|
/**
|
|
@@ -3188,71 +3199,60 @@ export interface CreateFlowByFilesRequest {
|
|
|
3188
3199
|
Deadline?: number;
|
|
3189
3200
|
/**
|
|
3190
3201
|
* 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
|
3202
|
+
|
|
3191
3203
|
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
3192
3204
|
*/
|
|
3193
3205
|
RemindedOn?: number;
|
|
3194
3206
|
/**
|
|
3195
|
-
*
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
- true:无序签署, 本合同多个参与人没有先后签署限制
|
|
3207
|
+
* 合同流程的签署顺序类型:
|
|
3208
|
+
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
3209
|
+
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
3199
3210
|
*/
|
|
3200
3211
|
Unordered?: boolean;
|
|
3201
3212
|
/**
|
|
3202
3213
|
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
- {签署方N姓名}
|
|
3209
|
-
|
|
3214
|
+
<ul><li>{合同名称} </li>
|
|
3215
|
+
<li>{发起方企业} </li>
|
|
3216
|
+
<li>{发起方姓名} </li>
|
|
3217
|
+
<li>{签署方N企业}</li>
|
|
3218
|
+
<li>{签署方N姓名}</li></ul>
|
|
3210
3219
|
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
3211
3220
|
|
|
3212
|
-
|
|
3213
|
-
合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
|
|
3221
|
+
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
3214
3222
|
|
|
3215
|
-
则小程序中列表页展示此合同为以下样子
|
|
3216
|
-
```
|
|
3217
3223
|
合同名称:租房合同
|
|
3218
3224
|
发起方:腾讯公司(张三)
|
|
3219
3225
|
签署方:李四
|
|
3220
|
-
|
|
3226
|
+
|
|
3227
|
+
|
|
3221
3228
|
*/
|
|
3222
3229
|
CustomShowMap?: string;
|
|
3223
3230
|
/**
|
|
3224
|
-
*
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
- false:(默认)不需要审批,直接签署。
|
|
3228
|
-
- true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
|
|
3229
|
-
|
|
3231
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
3232
|
+
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
3233
|
+
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
3230
3234
|
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3231
|
-
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
|
|
3235
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
3236
|
+
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
3237
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
3236
3238
|
*/
|
|
3237
3239
|
NeedSignReview?: boolean;
|
|
3238
3240
|
/**
|
|
3239
3241
|
* 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
+
|
|
3243
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
3242
3244
|
*/
|
|
3243
3245
|
UserData?: string;
|
|
3244
3246
|
/**
|
|
3245
3247
|
* 指定个人签署方查看合同的校验方式
|
|
3246
|
-
|
|
3247
|
-
|
|
3248
|
-
- MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
|
|
3248
|
+
<ul><li> **VerifyCheck** :(默认)人脸识别,人脸识别后才能合同内容 </li>
|
|
3249
|
+
<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
|
|
3249
3250
|
*/
|
|
3250
3251
|
ApproverVerifyType?: string;
|
|
3251
3252
|
/**
|
|
3252
3253
|
* 签署方签署控件(印章/签名等)的生成方式:
|
|
3253
|
-
|
|
3254
|
-
|
|
3255
|
-
- 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
|
|
3254
|
+
<ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
|
|
3255
|
+
<li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
|
|
3256
3256
|
*/
|
|
3257
3257
|
SignBeanTag?: number;
|
|
3258
3258
|
/**
|
|
@@ -3262,10 +3262,8 @@ export interface CreateFlowByFilesRequest {
|
|
|
3262
3262
|
Agent?: Agent;
|
|
3263
3263
|
/**
|
|
3264
3264
|
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
|
3265
|
-
|
|
3266
|
-
|
|
3267
|
-
|
|
3268
|
-
注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
|
|
3265
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
|
3266
|
+
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
3269
3267
|
*/
|
|
3270
3268
|
AutoSignScene?: string;
|
|
3271
3269
|
}
|
|
@@ -3581,12 +3579,12 @@ export interface FailedCreateRoleData {
|
|
|
3581
3579
|
export interface ApproverInfo {
|
|
3582
3580
|
/**
|
|
3583
3581
|
* 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
|
|
3584
|
-
0
|
|
3585
|
-
1
|
|
3586
|
-
3
|
|
3587
|
-
|
|
3588
|
-
7
|
|
3589
|
-
注:
|
|
3582
|
+
**0**:企业
|
|
3583
|
+
**1**:个人
|
|
3584
|
+
**3**:企业静默签署
|
|
3585
|
+
注:`类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。`
|
|
3586
|
+
**7**: 个人自动签署,适用于个人自动签场景。
|
|
3587
|
+
注: `个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3590
3588
|
*/
|
|
3591
3589
|
ApproverType: number;
|
|
3592
3590
|
/**
|
|
@@ -3596,57 +3594,54 @@ export interface ApproverInfo {
|
|
|
3596
3594
|
ApproverName: string;
|
|
3597
3595
|
/**
|
|
3598
3596
|
* 本企业的签署方经办人的员工UserId
|
|
3599
|
-
|
|
3600
3597
|
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
3601
3598
|
|
|
3602
|
-
注:
|
|
3599
|
+
注: `若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。`
|
|
3603
3600
|
*/
|
|
3604
3601
|
ApproverMobile: string;
|
|
3605
3602
|
/**
|
|
3606
3603
|
* 组织机构名称。
|
|
3607
3604
|
如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
|
|
3608
3605
|
|
|
3609
|
-
注:
|
|
3606
|
+
注: `请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。`
|
|
3610
3607
|
*/
|
|
3611
3608
|
OrganizationName?: string;
|
|
3612
3609
|
/**
|
|
3613
3610
|
* 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
|
|
3614
|
-
|
|
3615
|
-
|
|
3616
|
-
|
|
3611
|
+
<ul><li> 个人签名/印章</li>
|
|
3612
|
+
<li> 企业印章</li>
|
|
3613
|
+
<li> 骑缝章等签署控件</li></ul>
|
|
3617
3614
|
*/
|
|
3618
3615
|
SignComponents?: Array<Component>;
|
|
3619
3616
|
/**
|
|
3620
3617
|
* 签署方经办人的证件类型,支持以下类型
|
|
3621
|
-
|
|
3622
|
-
|
|
3623
|
-
|
|
3624
|
-
|
|
3618
|
+
<ul><li>ID_CARD 居民身份证 (默认值)</li>
|
|
3619
|
+
<li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
|
|
3620
|
+
<li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
|
|
3621
|
+
<li>OTHER_CARD_TYPE 其他证件</li></ul>
|
|
3625
3622
|
|
|
3626
|
-
注:
|
|
3623
|
+
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3627
3624
|
*/
|
|
3628
3625
|
ApproverIdCardType?: string;
|
|
3629
3626
|
/**
|
|
3630
3627
|
* 签署方经办人的证件号码,应符合以下规则
|
|
3631
|
-
|
|
3632
|
-
|
|
3633
|
-
|
|
3628
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
3629
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
3630
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
3634
3631
|
*/
|
|
3635
3632
|
ApproverIdCardNumber?: string;
|
|
3636
3633
|
/**
|
|
3637
3634
|
* 通知签署方经办人的方式, 有以下途径:
|
|
3638
|
-
|
|
3639
|
-
|
|
3640
|
-
- none: 不通知
|
|
3635
|
+
<ul><li> **sms** : (默认)短信</li>
|
|
3636
|
+
<li> **none** : 不通知</li></ul>
|
|
3641
3637
|
*/
|
|
3642
3638
|
NotifyType?: string;
|
|
3643
3639
|
/**
|
|
3644
|
-
* 收据场景设置签署人角色类型,
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
|
|
3640
|
+
* 收据场景设置签署人角色类型, 可以设置如下****类型****:
|
|
3641
|
+
<ul><li> **1** :收款人</li>
|
|
3642
|
+
<li> **2** :开具人</li>
|
|
3643
|
+
<li> **3** :见证人</li></ul>
|
|
3644
|
+
注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3650
3645
|
*/
|
|
3651
3646
|
ApproverRole?: number;
|
|
3652
3647
|
/**
|
|
@@ -3659,20 +3654,19 @@ export interface ApproverInfo {
|
|
|
3659
3654
|
* 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
|
|
3660
3655
|
|
|
3661
3656
|
若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
|
|
3665
|
-
- 合同页数大于等于6页,阅读时间为10秒。
|
|
3657
|
+
<ul><li>合同页数少于等于2页,阅读时间为3秒;</li>
|
|
3658
|
+
<li>合同页数为3到5页,阅读时间为5秒;</li>
|
|
3659
|
+
<li>合同页数大于等于6页,阅读时间为10秒。</li></ul>
|
|
3666
3660
|
*/
|
|
3667
3661
|
PreReadTime?: number;
|
|
3668
3662
|
/**
|
|
3669
3663
|
* 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
|
|
3670
3664
|
|
|
3671
|
-
|
|
3665
|
+
注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
|
|
3672
3666
|
*/
|
|
3673
3667
|
UserId?: string;
|
|
3674
3668
|
/**
|
|
3675
|
-
*
|
|
3669
|
+
* 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
|
3676
3670
|
*/
|
|
3677
3671
|
ApproverSource?: string;
|
|
3678
3672
|
/**
|
|
@@ -3689,43 +3683,32 @@ export interface ApproverInfo {
|
|
|
3689
3683
|
ApproverOption?: ApproverOption;
|
|
3690
3684
|
/**
|
|
3691
3685
|
* 指定个人签署方查看合同的校验方式,可以传值如下:
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
- 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
|
|
3695
|
-
|
|
3686
|
+
<ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
|
3687
|
+
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容</li></ul>
|
|
3696
3688
|
注:
|
|
3697
|
-
|
|
3698
|
-
|
|
3699
|
-
- 此字段不可传多个校验方式
|
|
3689
|
+
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
|
3690
|
+
<li>此字段不可传多个校验方式</li></ul>
|
|
3700
3691
|
*/
|
|
3701
3692
|
ApproverVerifyTypes?: Array<number>;
|
|
3702
3693
|
/**
|
|
3703
3694
|
* 您可以指定签署方签署合同的认证校验方式,可传递以下值:
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
|
|
3707
|
-
- 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
|
|
3708
|
-
|
|
3695
|
+
<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
|
|
3696
|
+
<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
|
|
3697
|
+
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
3709
3698
|
注:
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
- 您可以传递多种值,表示可用多种认证校验方式。
|
|
3713
|
-
|
|
3699
|
+
<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
|
|
3700
|
+
<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
3714
3701
|
*/
|
|
3715
3702
|
ApproverSignTypes?: Array<number>;
|
|
3716
3703
|
/**
|
|
3717
|
-
*
|
|
3718
|
-
|
|
3719
|
-
|
|
3720
|
-
- false:(默认)不需要审批,直接签署。
|
|
3721
|
-
- true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
|
|
3722
|
-
|
|
3704
|
+
* 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
3705
|
+
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
3706
|
+
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
3723
3707
|
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3708
|
+
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
3709
|
+
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
3724
3710
|
|
|
3725
|
-
|
|
3726
|
-
- 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
|
|
3727
|
-
|
|
3728
|
-
注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
|
|
3711
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
3729
3712
|
*/
|
|
3730
3713
|
ApproverNeedSignReview?: boolean;
|
|
3731
3714
|
}
|
|
@@ -3743,13 +3726,19 @@ export interface CreateFlowSignReviewResponse {
|
|
|
3743
3726
|
*/
|
|
3744
3727
|
export interface ModifyIntegrationDepartmentRequest {
|
|
3745
3728
|
/**
|
|
3746
|
-
*
|
|
3729
|
+
* 执行本接口操作的员工信息。
|
|
3730
|
+
注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
|
|
3747
3731
|
*/
|
|
3748
3732
|
Operator: UserInfo;
|
|
3749
3733
|
/**
|
|
3750
3734
|
* 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
|
|
3751
3735
|
*/
|
|
3752
3736
|
DeptId: string;
|
|
3737
|
+
/**
|
|
3738
|
+
* 代理企业和员工的信息。
|
|
3739
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3740
|
+
*/
|
|
3741
|
+
Agent?: Agent;
|
|
3753
3742
|
/**
|
|
3754
3743
|
* 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
|
|
3755
3744
|
*/
|
|
@@ -4121,13 +4110,19 @@ export interface CancelMultiFlowSignQRCodeRequest {
|
|
|
4121
4110
|
*/
|
|
4122
4111
|
export interface DeleteIntegrationDepartmentRequest {
|
|
4123
4112
|
/**
|
|
4124
|
-
*
|
|
4113
|
+
* 执行本接口操作的员工信息。
|
|
4114
|
+
注: `在调用此接口时,请确保指定的员工已获得组织架构管理权限,并具备接口传入的相应资源的数据权限。`
|
|
4125
4115
|
*/
|
|
4126
4116
|
Operator: UserInfo;
|
|
4127
4117
|
/**
|
|
4128
4118
|
* 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
|
|
4129
4119
|
*/
|
|
4130
4120
|
DeptId: string;
|
|
4121
|
+
/**
|
|
4122
|
+
* 代理企业和员工的信息。
|
|
4123
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
4124
|
+
*/
|
|
4125
|
+
Agent?: Agent;
|
|
4131
4126
|
/**
|
|
4132
4127
|
* 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
|
|
4133
4128
|
*/
|
|
@@ -4335,15 +4330,15 @@ export interface ApproverOption {
|
|
|
4335
4330
|
/**
|
|
4336
4331
|
* 签署方是否可以拒签
|
|
4337
4332
|
|
|
4338
|
-
|
|
4339
|
-
|
|
4333
|
+
<ul><li> **false** : ( 默认)可以拒签</li>
|
|
4334
|
+
<li> **true** :不可以拒签</li></ul>
|
|
4340
4335
|
*/
|
|
4341
4336
|
NoRefuse?: boolean;
|
|
4342
4337
|
/**
|
|
4343
4338
|
* 签署方是否可以转他人处理
|
|
4344
4339
|
|
|
4345
|
-
|
|
4346
|
-
|
|
4340
|
+
<ul><li> **false** : ( 默认)可以转他人处理</li>
|
|
4341
|
+
<li> **true** :不可以转他人处理</li></ul>
|
|
4347
4342
|
*/
|
|
4348
4343
|
NoTransfer?: boolean;
|
|
4349
4344
|
}
|
|
@@ -5472,23 +5467,20 @@ export interface CcInfo {
|
|
|
5472
5467
|
Name?: string;
|
|
5473
5468
|
/**
|
|
5474
5469
|
* 被抄送方类型, 可设置以下类型:
|
|
5475
|
-
|
|
5476
|
-
|
|
5477
|
-
- 1:企业员工抄送方
|
|
5470
|
+
<ul><li> **0** :个人抄送方</li>
|
|
5471
|
+
<li> **1** :企业员工抄送方</li></ul>
|
|
5478
5472
|
*/
|
|
5479
5473
|
CcType?: number;
|
|
5480
5474
|
/**
|
|
5481
5475
|
* 被抄送方权限, 可设置如下权限:
|
|
5482
|
-
|
|
5483
|
-
|
|
5484
|
-
- 1:可查看合同内容也可下载原文
|
|
5476
|
+
<ul><li> **0** :可查看合同内容</li>
|
|
5477
|
+
<li> **1** :可查看合同内容也可下载原文</li></ul>
|
|
5485
5478
|
*/
|
|
5486
5479
|
CcPermission?: number;
|
|
5487
5480
|
/**
|
|
5488
5481
|
* 通知签署方经办人的方式, 有以下途径:
|
|
5489
|
-
|
|
5490
|
-
|
|
5491
|
-
- none: 不通知
|
|
5482
|
+
<ul><li> **sms** : (默认)短信</li>
|
|
5483
|
+
<li> **none** : 不通知</li></ul>
|
|
5492
5484
|
*/
|
|
5493
5485
|
NotifyType?: string;
|
|
5494
5486
|
}
|