tencentcloud-sdk-nodejs-ess 4.0.374 → 4.0.377

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 (9) hide show
  1. package/CHANGELOG.md +724 -0
  2. package/SERVICE_CHANGELOG.md +754 -29
  3. package/package.json +1 -1
  4. package/products.md +29 -29
  5. package/src/services/ess/v20201111/ess_client.ts +36 -16
  6. package/src/services/ess/v20201111/ess_models.ts +9 -12
  7. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +36 -16
  8. package/tencentcloud/services/ess/v20201111/ess_client.js +36 -16
  9. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +8 -11
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.0.374",
3
+ "version": "4.0.377",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -8,13 +8,13 @@
8
8
  | afc | [定制建模](https://cloud.tencent.com/document/product/1029) | 2022-05-23 06:01:56 |
9
9
  | ame | [正版曲库直通车](https://cloud.tencent.com/document/product/1155) | 2022-04-15 06:01:25 |
10
10
  | ams | [音频内容检测](https://cloud.tencent.com/document/product/1219) | 2022-06-23 06:06:13 |
11
- | antiddos | [DDoS 防护](https://cloud.tencent.com/document/product/1021) | 2022-07-01 06:05:20 |
11
+ | antiddos | [DDoS 防护](https://cloud.tencent.com/document/product/1021) | 2022-07-04 06:02:00 |
12
12
  | apcas | [汽车精准获客服务](https://cloud.tencent.com/document/product/1244) | 2022-04-04 06:05:36 |
13
13
  | ape | [正版图库直通车](https://cloud.tencent.com/document/product/1181) | 2022-04-04 06:05:40 |
14
14
  | api | [云 API](https://cloud.tencent.com/document/product/1278) | 2022-06-07 06:00:45 |
15
15
  | apigateway | [API网关](https://cloud.tencent.com/document/product/628) | 2022-06-14 06:05:10 |
16
16
  | apm | [应用性能观测](https://cloud.tencent.com/document/product/1463) | 2022-06-30 06:00:50 |
17
- | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2022-06-02 06:02:22 |
17
+ | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2022-07-04 06:02:30 |
18
18
  | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2022-06-23 06:06:50 |
19
19
  | asw | [应用与服务编排工作流](https://cloud.tencent.com/document/product/1272) | 2022-04-04 06:08:40 |
20
20
  | ba | [网站备案](https://cloud.tencent.com/document/product/243) | 2022-04-04 06:08:45 |
@@ -34,42 +34,42 @@
34
34
  | captcha | [验证码](https://cloud.tencent.com/document/product/1110) | 2022-04-12 06:07:13 |
35
35
  | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2022-04-27 06:05:49 |
36
36
  | casb | [云数据加密代理网关](https://cloud.tencent.com/document/product/1303) | 2022-04-04 06:11:55 |
37
- | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2022-06-30 06:01:55 |
38
- | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2022-05-31 06:05:45 |
37
+ | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2022-07-04 17:57:38 |
38
+ | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2022-07-06 06:07:59 |
39
39
  | ccc | [云呼叫中心](https://cloud.tencent.com/document/product/679) | 2022-07-01 06:06:59 |
40
- | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2022-06-27 06:05:09 |
40
+ | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2022-07-06 06:08:10 |
41
41
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2022-05-16 17:18:07 |
42
42
  | cdn | [内容分发网络](https://cloud.tencent.com/document/product/228) | 2022-06-30 06:02:27 |
43
43
  | cds | [数据安全审计](https://cloud.tencent.com/document/product/856) | 2022-04-04 06:17:07 |
44
44
  | cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2022-05-24 06:08:29 |
45
45
  | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2022-04-04 06:17:16 |
46
46
  | cfw | [云防火墙](https://cloud.tencent.com/document/product/1132) | 2022-05-31 06:06:47 |
47
- | chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2022-05-26 06:08:04 |
47
+ | chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2022-07-04 06:04:36 |
48
48
  | ciam | [账号风控平台](https://cloud.tencent.com/document/product/1441) | 2022-06-30 10:31:31 |
49
49
  | cii | [智能保险助手](https://cloud.tencent.com/document/product/1368) | 2022-06-27 06:06:02 |
50
50
  | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
51
51
  | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
52
- | ckafka | [消息队列 Ckafka](https://cloud.tencent.com/document/product/597) | 2022-05-31 06:07:03 |
53
- | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2022-06-29 06:04:25 |
52
+ | ckafka | [消息队列 Ckafka](https://cloud.tencent.com/document/product/597) | 2022-07-05 06:09:16 |
53
+ | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2022-07-06 06:09:16 |
54
54
  | cloudaudit | [云审计](https://cloud.tencent.com/document/product/629) | 2022-05-25 06:05:44 |
55
55
  | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2022-06-22 06:04:38 |
56
56
  | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2022-06-29 06:04:44 |
57
57
  | cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2022-06-24 06:09:00 |
58
58
  | cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2022-04-04 06:23:04 |
59
59
  | cms | [内容安全](https://cloud.tencent.com/document/product) | 2020-10-29 08:03:08 |
60
- | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2022-07-01 06:08:45 |
60
+ | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2022-07-05 06:10:03 |
61
61
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
62
- | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2022-06-29 06:05:30 |
63
- | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2022-07-01 06:09:29 |
62
+ | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2022-07-05 06:10:41 |
63
+ | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2022-07-06 06:10:33 |
64
64
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
65
- | cynosdb | [云原生数据库 TDSQL-C](https://cloud.tencent.com/document/product/1003) | 2022-06-15 06:07:21 |
65
+ | cynosdb | [云原生数据库 TDSQL-C](https://cloud.tencent.com/document/product/1003) | 2022-07-04 06:07:00 |
66
66
  | dasb | [堡垒机](https://cloud.tencent.com/document/product/1025) | 2022-06-01 20:56:43 |
67
67
  | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2022-04-04 06:33:41 |
68
68
  | dbbrain | [数据库智能管家 DBbrain](https://cloud.tencent.com/document/product/1130) | 2022-06-22 06:06:28 |
69
69
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2022-07-01 11:26:52 |
70
70
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2022-04-13 06:36:47 |
71
- | dcdb | [分布式数据库 TDSQL](https://cloud.tencent.com/document/product/557) | 2022-05-31 06:09:47 |
72
- | dlc | [数据湖计算](https://cloud.tencent.com/document/product/1342) | 2022-07-01 06:10:47 |
71
+ | dcdb | [分布式数据库 TDSQL](https://cloud.tencent.com/document/product/557) | 2022-07-05 06:12:03 |
72
+ | dlc | [数据湖计算](https://cloud.tencent.com/document/product/1342) | 2022-07-06 06:11:44 |
73
73
  | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2022-06-23 06:11:27 |
74
74
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2022-05-24 06:11:36 |
75
75
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2022-04-04 06:38:48 |
@@ -83,9 +83,9 @@
83
83
  | eiam | [数字身份管控平台（员工版）](https://cloud.tencent.com/document/product/1442) | 2022-05-13 06:11:29 |
84
84
  | eis | [企业集成服务](https://cloud.tencent.com/document/product/1270) | 2022-06-16 06:06:58 |
85
85
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2022-06-09 06:11:36 |
86
- | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2022-06-20 06:08:20 |
87
- | ess | [电子签服务](https://cloud.tencent.com/document/product/1323) | 2022-07-01 06:11:57 |
88
- | essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2022-06-30 16:47:49 |
86
+ | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2022-07-05 06:13:25 |
87
+ | ess | [电子签服务](https://cloud.tencent.com/document/product/1323) | 2022-07-05 06:13:29 |
88
+ | essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2022-07-05 17:07:31 |
89
89
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2022-06-15 06:09:10 |
90
90
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2022-06-02 06:08:18 |
91
91
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2022-04-04 06:43:06 |
@@ -100,7 +100,7 @@
100
100
  | iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2022-05-24 06:13:22 |
101
101
  | ic | [物联卡](https://cloud.tencent.com/document/product/636) | 2022-04-04 06:46:38 |
102
102
  | icr | [对话机器人](https://cloud.tencent.com/document/product/1268) | 2022-04-13 06:46:31 |
103
- | ie | [智能编辑](https://cloud.tencent.com/document/product/1186) | 2022-04-04 06:46:42 |
103
+ | ie | [智能编辑](https://cloud.tencent.com/document/product/1186) | 2022-07-06 06:13:46 |
104
104
  | iecp | [物联网边缘计算平台](https://cloud.tencent.com/document/product/1118) | 2022-04-12 06:15:04 |
105
105
  | iir | [智能识图](https://cloud.tencent.com/document/product/1217) | 2022-04-04 06:48:05 |
106
106
  | ims | [图片内容检测](https://cloud.tencent.com/document/product/1125) | 2022-05-26 06:12:53 |
@@ -116,7 +116,7 @@
116
116
  | live | [云直播](https://cloud.tencent.com/document/product/267) | 2022-06-22 06:10:05 |
117
117
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
118
118
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
119
- | mariadb | [云数据库 MariaDB](https://cloud.tencent.com/document/product/237) | 2022-06-15 06:11:30 |
119
+ | mariadb | [云数据库 MariaDB](https://cloud.tencent.com/document/product/237) | 2022-07-06 06:15:28 |
120
120
  | market | [云市场](https://cloud.tencent.com/document/product/306) | 2022-04-04 06:57:43 |
121
121
  | memcached | [云数据库 Memcached](https://cloud.tencent.com/document/product/241) | 2022-04-04 06:57:44 |
122
122
  | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-04-04 06:57:46 |
@@ -131,7 +131,7 @@
131
131
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
132
132
  | nlp | [自然语言处理](https://cloud.tencent.com/document/product/271) | 2022-04-13 07:00:13 |
133
133
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
134
- | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2022-06-15 06:12:20 |
134
+ | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2022-07-04 06:14:12 |
135
135
  | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2022-06-29 06:11:12 |
136
136
  | organization | [企业组织](https://cloud.tencent.com/document/product/850) | 2022-06-10 06:11:43 |
137
137
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2022-06-13 06:15:36 |
@@ -139,7 +139,7 @@
139
139
  | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2022-06-27 06:13:12 |
140
140
  | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2022-04-04 07:02:49 |
141
141
  | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2022-04-21 06:16:10 |
142
- | redis | [云数据库 Redis](https://cloud.tencent.com/document/product/239) | 2022-06-16 06:10:57 |
142
+ | redis | [云数据库 Redis](https://cloud.tencent.com/document/product/239) | 2022-07-06 06:16:58 |
143
143
  | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2022-04-04 07:04:04 |
144
144
  | rp | [注册保护](https://cloud.tencent.com/document/product/1191) | 2022-04-04 07:04:06 |
145
145
  | rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2022-04-04 07:04:08 |
@@ -166,17 +166,17 @@
166
166
  | tbp | [腾讯智能对话平台](https://cloud.tencent.com/document/product/1060) | 2022-04-04 07:09:07 |
167
167
  | tcaplusdb | [游戏数据库 TcaplusDB](https://cloud.tencent.com/document/product/596) | 2022-04-08 06:12:54 |
168
168
  | tcb | [云开发 CloudBase](https://cloud.tencent.com/document/product/876) | 2022-04-26 06:16:06 |
169
- | tcbr | [云托管 CloudBase Run](https://cloud.tencent.com/document/product/1243) | 2022-07-01 06:17:30 |
169
+ | tcbr | [云托管 CloudBase Run](https://cloud.tencent.com/document/product/1243) | 2022-07-05 06:21:12 |
170
170
  | tcex | [腾讯云释义](https://cloud.tencent.com/document/product/1266) | 2022-04-04 07:10:49 |
171
171
  | tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 |
172
172
  | tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2022-06-08 06:15:21 |
173
173
  | tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2022-06-13 06:17:36 |
174
- | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2022-06-21 06:13:45 |
175
- | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2022-04-04 07:15:36 |
174
+ | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2022-07-06 06:18:51 |
175
+ | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2022-07-05 06:21:49 |
176
176
  | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2022-04-04 07:15:50 |
177
- | tdmq | [分布式消息队列](https://cloud.tencent.com/document/product/1179) | 2022-06-29 06:13:55 |
177
+ | tdmq | [分布式消息队列](https://cloud.tencent.com/document/product/1179) | 2022-07-06 06:19:19 |
178
178
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2022-06-20 06:14:36 |
179
- | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2022-07-01 06:18:27 |
179
+ | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2022-07-05 06:22:14 |
180
180
  | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2022-06-02 06:15:03 |
181
181
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
182
182
  | tic | [腾讯云IaC平台](https://cloud.tencent.com/document/product/1213) | 2022-04-04 07:16:52 |
@@ -186,7 +186,7 @@
186
186
  | tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2022-06-15 06:15:49 |
187
187
  | tione | [腾讯云 TI 平台 TI-ONE](https://cloud.tencent.com/document/product/851) | 2022-06-07 22:05:59 |
188
188
  | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2022-05-17 06:17:19 |
189
- | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2022-07-01 06:19:07 |
189
+ | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2022-07-06 06:20:07 |
190
190
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
191
191
  | tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2022-04-04 07:18:11 |
192
192
  | tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2022-05-19 06:19:37 |
@@ -200,10 +200,10 @@
200
200
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2022-06-23 06:20:49 |
201
201
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2022-04-04 07:22:54 |
202
202
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2022-06-30 10:45:16 |
203
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2022-07-01 06:20:43 |
203
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2022-07-05 06:24:34 |
204
204
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2022-06-23 06:22:00 |
205
205
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2022-04-04 07:39:05 |
206
- | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2022-07-01 10:43:09 |
206
+ | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2022-07-04 06:20:00 |
207
207
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
208
208
  | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2022-06-29 15:15:26 |
209
209
  | youmall | [](https://cloud.tencent.com/document/product) | 2019-01-11 11:24:15 |
package/src/services/ess/v20201111/ess_client.ts CHANGED
@@ -71,8 +71,10 @@ export class Client extends TencentCloudCommon.AbstractClient {
71
71
  }
72
72
 
73
73
  /**
74
- * 此接口用于发起流程
75
- */
74
+ * 此接口用于发起流程
75
+ 适用场景：见创建签署流程接口。
76
+ 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
77
+ */
76
78
  async StartFlow(
77
79
  req: StartFlowRequest,
78
80
  cb?: (error: string, rep: StartFlowResponse) => void
@@ -82,6 +84,7 @@ export class Client extends TencentCloudCommon.AbstractClient {
82
84
 
83
85
  /**
84
86
  * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
87
+ 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
85
88
  适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
86
89
  */
87
90
  async CreateMultiFlowSignQRCode(
@@ -92,8 +95,10 @@ export class Client extends TencentCloudCommon.AbstractClient {
92
95
  }
93
96
 
94
97
  /**
95
- * 用于撤销签署流程
96
- */
98
+ * 用于撤销签署流程
99
+ 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
100
+ 注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
101
+ */
97
102
  async CancelFlow(
98
103
  req: CancelFlowRequest,
99
104
  cb?: (error: string, rep: CancelFlowResponse) => void
@@ -102,8 +107,9 @@ export class Client extends TencentCloudCommon.AbstractClient {
102
107
  }
103
108
 
104
109
  /**
105
- * 创建电子文档
106
- */
110
+ * 创建电子文档
111
+ 适用场景：见创建签署流程接口。 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
112
+ */
107
113
  async CreateDocument(
108
114
  req: CreateDocumentRequest,
109
115
  cb?: (error: string, rep: CreateDocumentResponse) => void
@@ -112,8 +118,9 @@ export class Client extends TencentCloudCommon.AbstractClient {
112
118
  }
113
119
 
114
120
  /**
115
- * 查询文件下载URL
116
- */
121
+ * 查询文件下载URL
122
+ 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
123
+ */
117
124
  async DescribeFileUrls(
118
125
  req: DescribeFileUrlsRequest,
119
126
  cb?: (error: string, rep: DescribeFileUrlsResponse) => void
@@ -132,8 +139,10 @@ export class Client extends TencentCloudCommon.AbstractClient {
132
139
  }
133
140
 
134
141
  /**
135
- * 创建签署流程
136
- */
142
+ * 创建签署流程
143
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
144
+ 注：改接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
145
+ */
137
146
  async CreateFlow(
138
147
  req: CreateFlowRequest,
139
148
  cb?: (error: string, rep: CreateFlowResponse) => void
@@ -154,6 +163,11 @@ export class Client extends TencentCloudCommon.AbstractClient {
154
163
  /**
155
164
  * 获取小程序跳转链接
156
165
 
166
+ 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
167
+
168
+ 注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
169
+
170
+
157
171
  跳转到小程序的实现，参考官方文档（分为<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>两种方式）
158
172
 
159
173
 
@@ -167,8 +181,9 @@ export class Client extends TencentCloudCommon.AbstractClient {
167
181
  }
168
182
 
169
183
  /**
170
- * 二期接口-查询模板
171
- */
184
+ * 二期接口-查询模板
185
+ 适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
186
+ */
172
187
  async DescribeFlowTemplates(
173
188
  req: DescribeFlowTemplatesRequest,
174
189
  cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
@@ -177,8 +192,9 @@ export class Client extends TencentCloudCommon.AbstractClient {
177
192
  }
178
193
 
179
194
  /**
180
- * 查询流程摘要
181
- */
195
+ * 查询流程摘要
196
+ 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
197
+ */
182
198
  async DescribeFlowBriefs(
183
199
  req: DescribeFlowBriefsRequest,
184
200
  cb?: (error: string, rep: DescribeFlowBriefsResponse) => void
@@ -187,8 +203,11 @@ export class Client extends TencentCloudCommon.AbstractClient {
187
203
  }
188
204
 
189
205
  /**
190
- * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建签署流程。
191
- */
206
+ * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
207
+ 适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
208
+ 适用场景2：可通过改接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
209
+ 注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
210
+ */
192
211
  async CreateFlowByFiles(
193
212
  req: CreateFlowByFilesRequest,
194
213
  cb?: (error: string, rep: CreateFlowByFilesResponse) => void
@@ -198,6 +217,7 @@ export class Client extends TencentCloudCommon.AbstractClient {
198
217
 
199
218
  /**
200
219
  * 此接口（UploadFiles）用于文件上传。
220
+ 适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
201
221
  调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
202
222
  */
203
223
  async UploadFiles(
package/src/services/ess/v20201111/ess_models.ts CHANGED
@@ -421,22 +421,19 @@ export interface SignQrCode {
421
421
  * UploadFiles请求参数结构体
422
422
  */
423
423
  export interface UploadFilesRequest {
424
- /**
425
- * 调用方信息
426
- */
427
- Caller: Caller
428
-
429
424
  /**
430
425
  * 文件对应业务类型，用于区分文件存储路径：
431
426
  1. TEMPLATE - 模板； 文件类型：.pdf/.html
432
427
  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型：.pdf/.html
433
- 3. FLOW - 签署过程 文件类型：.pdf/.html
434
- 4. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
435
- 5. BUSINESSLICENSE - 营业执照 文件类型：.jpg/.jpeg/.png
436
- 6. IDCARD - 身份证 文件类型：.jpg/.jpeg/.png
428
+ 3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
437
429
  */
438
430
  BusinessType: string
439
431
 
432
+ /**
433
+ * 调用方信息
434
+ */
435
+ Caller?: Caller
436
+
440
437
  /**
441
438
  * 上传文件内容数组，最多支持20个文件
442
439
  */
@@ -448,15 +445,15 @@ export interface UploadFilesRequest {
448
445
  FileUrls?: string
449
446
 
450
447
  /**
451
- * 是否将pdf灰色矩阵置白
448
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
452
449
  true--是，处理置白
453
450
  false--否，不处理
454
451
  */
455
452
  CoverRect?: boolean
456
453
 
457
454
  /**
458
- * 特殊文件类型需要指定文件类型：
459
- HTML-- .html文件
455
+ * 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
456
+ 如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
460
457
  */
461
458
  FileType?: string
462
459
 
package/tencentcloud/services/ess/v20201111/ess_client.d.ts CHANGED
@@ -7,33 +7,42 @@ import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocum
7
7
  export declare class Client extends TencentCloudCommon.AbstractClient {
8
8
  constructor(clientConfig: TencentCloudCommon.ClientConfig);
9
9
  /**
10
- * 此接口用于发起流程
11
- */
10
+ * 此接口用于发起流程
11
+ 适用场景：见创建签署流程接口。
12
+ 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
13
+ */
12
14
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
13
15
  /**
14
16
  * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
17
+ 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
15
18
  适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
16
19
  */
17
20
  CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
18
21
  /**
19
- * 用于撤销签署流程
20
- */
22
+ * 用于撤销签署流程
23
+ 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
24
+ 注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
25
+ */
21
26
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
22
27
  /**
23
- * 创建电子文档
24
- */
28
+ * 创建电子文档
29
+ 适用场景：见创建签署流程接口。 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
30
+ */
25
31
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
26
32
  /**
27
- * 查询文件下载URL
28
- */
33
+ * 查询文件下载URL
34
+ 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
35
+ */
29
36
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
30
37
  /**
31
38
  * 通过AuthCode查询用户是否实名
32
39
  */
33
40
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
34
41
  /**
35
- * 创建签署流程
36
- */
42
+ * 创建签署流程
43
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
44
+ 注：改接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
45
+ */
37
46
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
38
47
  /**
39
48
  * 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
@@ -42,6 +51,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
42
51
  /**
43
52
  * 获取小程序跳转链接
44
53
 
54
+ 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
55
+
56
+ 注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
57
+
58
+
45
59
  跳转到小程序的实现，参考官方文档（分为<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>两种方式）
46
60
 
47
61
 
@@ -49,19 +63,25 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
49
63
  */
50
64
  CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
51
65
  /**
52
- * 二期接口-查询模板
53
- */
66
+ * 二期接口-查询模板
67
+ 适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
68
+ */
54
69
  DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
55
70
  /**
56
- * 查询流程摘要
57
- */
71
+ * 查询流程摘要
72
+ 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
73
+ */
58
74
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
59
75
  /**
60
- * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建签署流程。
61
- */
76
+ * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
77
+ 适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
78
+ 适用场景2：可通过改接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
79
+ 注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
80
+ */
62
81
  CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
63
82
  /**
64
83
  * 此接口（UploadFiles）用于文件上传。
84
+ 适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
65
85
  调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
66
86
  */
67
87
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
package/tencentcloud/services/ess/v20201111/ess_client.js CHANGED
@@ -28,33 +28,40 @@ class Client extends TencentCloudCommon.AbstractClient {
28
28
  super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
29
29
  }
30
30
  /**
31
- * 此接口用于发起流程
32
- */
31
+ * 此接口用于发起流程
32
+ 适用场景：见创建签署流程接口。
33
+ 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
34
+ */
33
35
  async StartFlow(req, cb) {
34
36
  return this.request("StartFlow", req, cb);
35
37
  }
36
38
  /**
37
39
  * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
40
+ 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
38
41
  适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
39
42
  */
40
43
  async CreateMultiFlowSignQRCode(req, cb) {
41
44
  return this.request("CreateMultiFlowSignQRCode", req, cb);
42
45
  }
43
46
  /**
44
- * 用于撤销签署流程
45
- */
47
+ * 用于撤销签署流程
48
+ 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
49
+ 注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
50
+ */
46
51
  async CancelFlow(req, cb) {
47
52
  return this.request("CancelFlow", req, cb);
48
53
  }
49
54
  /**
50
- * 创建电子文档
51
- */
55
+ * 创建电子文档
56
+ 适用场景：见创建签署流程接口。 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
57
+ */
52
58
  async CreateDocument(req, cb) {
53
59
  return this.request("CreateDocument", req, cb);
54
60
  }
55
61
  /**
56
- * 查询文件下载URL
57
- */
62
+ * 查询文件下载URL
63
+ 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
64
+ */
58
65
  async DescribeFileUrls(req, cb) {
59
66
  return this.request("DescribeFileUrls", req, cb);
60
67
  }
@@ -65,8 +72,10 @@ class Client extends TencentCloudCommon.AbstractClient {
65
72
  return this.request("DescribeThirdPartyAuthCode", req, cb);
66
73
  }
67
74
  /**
68
- * 创建签署流程
69
- */
75
+ * 创建签署流程
76
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
77
+ 注：改接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
78
+ */
70
79
  async CreateFlow(req, cb) {
71
80
  return this.request("CreateFlow", req, cb);
72
81
  }
@@ -79,6 +88,11 @@ class Client extends TencentCloudCommon.AbstractClient {
79
88
  /**
80
89
  * 获取小程序跳转链接
81
90
 
91
+ 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
92
+
93
+ 注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
94
+
95
+
82
96
  跳转到小程序的实现，参考官方文档（分为<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>两种方式）
83
97
 
84
98
 
@@ -88,25 +102,31 @@ class Client extends TencentCloudCommon.AbstractClient {
88
102
  return this.request("CreateSchemeUrl", req, cb);
89
103
  }
90
104
  /**
91
- * 二期接口-查询模板
92
- */
105
+ * 二期接口-查询模板
106
+ 适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
107
+ */
93
108
  async DescribeFlowTemplates(req, cb) {
94
109
  return this.request("DescribeFlowTemplates", req, cb);
95
110
  }
96
111
  /**
97
- * 查询流程摘要
98
- */
112
+ * 查询流程摘要
113
+ 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
114
+ */
99
115
  async DescribeFlowBriefs(req, cb) {
100
116
  return this.request("DescribeFlowBriefs", req, cb);
101
117
  }
102
118
  /**
103
- * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建签署流程。
104
- */
119
+ * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
120
+ 适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
121
+ 适用场景2：可通过改接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
122
+ 注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
123
+ */
105
124
  async CreateFlowByFiles(req, cb) {
106
125
  return this.request("CreateFlowByFiles", req, cb);
107
126
  }
108
127
  /**
109
128
  * 此接口（UploadFiles）用于文件上传。
129
+ 适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
110
130
  调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
111
131
  */
112
132
  async UploadFiles(req, cb) {
package/tencentcloud/services/ess/v20201111/ess_models.d.ts CHANGED
@@ -338,20 +338,17 @@ export interface SignQrCode {
338
338
  * UploadFiles请求参数结构体
339
339
  */
340
340
  export interface UploadFilesRequest {
341
- /**
342
- * 调用方信息
343
- */
344
- Caller: Caller;
345
341
  /**
346
342
  * 文件对应业务类型，用于区分文件存储路径：
347
343
  1. TEMPLATE - 模板； 文件类型：.pdf/.html
348
344
  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型：.pdf/.html
349
- 3. FLOW - 签署过程 文件类型：.pdf/.html
350
- 4. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
351
- 5. BUSINESSLICENSE - 营业执照 文件类型：.jpg/.jpeg/.png
352
- 6. IDCARD - 身份证 文件类型：.jpg/.jpeg/.png
345
+ 3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
353
346
  */
354
347
  BusinessType: string;
348
+ /**
349
+ * 调用方信息
350
+ */
351
+ Caller?: Caller;
355
352
  /**
356
353
  * 上传文件内容数组，最多支持20个文件
357
354
  */
@@ -361,14 +358,14 @@ export interface UploadFilesRequest {
361
358
  */
362
359
  FileUrls?: string;
363
360
  /**
364
- * 是否将pdf灰色矩阵置白
361
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
365
362
  true--是，处理置白
366
363
  false--否，不处理
367
364
  */
368
365
  CoverRect?: boolean;
369
366
  /**
370
- * 特殊文件类型需要指定文件类型：
371
- HTML-- .html文件
367
+ * 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
368
+ 如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
372
369
  */
373
370
  FileType?: string;
374
371
  /**