tencentcloud-sdk-nodejs-ess 4.0.763 → 4.0.765

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.0.763",
3
+ "version": "4.0.765",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | afc | [定制建模](https://cloud.tencent.com/document/product/1029) | 2023-09-07 01:06:21 |
9
9
  | aiart | [AI 绘画](https://cloud.tencent.com/document/product/1668) | 2023-11-07 11:26:02 |
10
10
  | ame | [正版曲库直通车](https://cloud.tencent.com/document/product/1155) | 2023-08-17 01:06:14 |
11
- | ams | [音频内容安全](https://cloud.tencent.com/document/product/1219) | 2023-11-16 01:06:13 |
11
+ | ams | [音频内容安全](https://cloud.tencent.com/document/product/1219) | 2023-12-22 01:06:11 |
12
12
  | anicloud | [动效素材服务](https://cloud.tencent.com/document/product/1641) | 2023-05-18 01:01:53 |
13
13
  | antiddos | [T-Sec-DDoS防护(Anti-DDoS)](https://cloud.tencent.com/document/product/297) | 2023-12-13 01:06:45 |
14
14
  | apcas | [汽车精准获客服务](https://cloud.tencent.com/document/product/1244) | 2022-04-04 06:05:36 |
@@ -22,7 +22,7 @@
22
22
  | ba | [ICP备案](https://cloud.tencent.com/document/product/243) | 2023-10-13 01:07:08 |
23
23
  | batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2023-12-15 19:00:41 |
24
24
  | bda | [人体分析](https://cloud.tencent.com/document/product/1208) | 2023-10-11 01:10:01 |
25
- | bi | [商业智能分析 BI](https://cloud.tencent.com/document/product/590) | 2023-12-06 01:10:35 |
25
+ | bi | [商业智能分析 BI](https://cloud.tencent.com/document/product/590) | 2023-12-22 01:07:03 |
26
26
  | billing | [费用中心](https://cloud.tencent.com/document/product/555) | 2023-12-01 01:08:07 |
27
27
  | bizlive | [商业直播](https://cloud.tencent.com/document/product) | 2020-03-10 01:08:07 |
28
28
  | bm | [黑石物理服务器CPM](https://cloud.tencent.com/document/product/386) | 2023-10-18 01:14:30 |
@@ -39,13 +39,13 @@
39
39
  | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2023-12-05 01:14:32 |
40
40
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-12-04 00:03:32 |
41
41
  | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-11-01 01:07:57 |
42
- | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-11-16 01:09:13 |
43
- | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-12-13 01:17:04 |
42
+ | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-12-22 01:08:08 |
43
+ | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-12-22 01:08:53 |
44
44
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-12-05 01:17:51 |
45
45
  | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-10-27 01:17:34 |
46
46
  | cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2023-08-17 01:43:06 |
47
47
  | cdwch | [云数据仓库 ClickHouse](https://cloud.tencent.com/document/product/1299) | 2023-12-11 00:15:21 |
48
- | cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2023-12-20 01:16:54 |
48
+ | cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2023-12-25 00:04:35 |
49
49
  | cdwpg | [云数据仓库 PostgreSQL](https://cloud.tencent.com/document/product/878) | 2023-12-15 19:11:22 |
50
50
  | cfg | [混沌演练平台](https://cloud.tencent.com/document/product/1500) | 2023-11-24 01:09:00 |
51
51
  | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2023-11-10 01:10:02 |
@@ -69,7 +69,7 @@
69
69
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
70
70
  | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-12-19 01:25:03 |
71
71
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 |
72
- | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-12-13 01:28:37 |
72
+ | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-12-22 01:11:31 |
73
73
  | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-11-29 01:11:08 |
74
74
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
75
75
  | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2023-12-15 19:25:23 |
@@ -81,26 +81,26 @@
81
81
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-12-20 01:30:30 |
82
82
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-10-30 00:33:47 |
83
83
  | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-12-21 01:31:01 |
84
- | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-11-15 01:33:00 |
84
+ | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-12-22 01:14:13 |
85
85
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-12-15 01:10:52 |
86
86
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-11-10 01:14:28 |
87
87
  | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-08-17 02:59:40 |
88
88
  | dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2023-11-29 01:53:04 |
89
89
  | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 |
90
- | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2023-12-19 01:37:16 |
90
+ | dts | [数据传输服务](https://cloud.tencent.com/document/product/571) | 2023-12-22 01:14:53 |
91
91
  | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-12-15 19:35:27 |
92
92
  | ecc | [英文作文批改](https://cloud.tencent.com/document/product/1076) | 2023-09-13 01:42:58 |
93
93
  | ecdn | [全站加速网络](https://cloud.tencent.com/document/product/570) | 2023-08-17 03:03:04 |
94
94
  | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-12-20 01:36:00 |
95
95
  | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
96
96
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
97
- | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-12-19 01:39:39 |
97
+ | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-12-25 00:10:01 |
98
98
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-12-05 01:46:13 |
99
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-12-21 01:37:51 |
100
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-12-21 01:38:43 |
99
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-12-25 00:10:21 |
100
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-12-25 00:10:39 |
101
101
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-12-15 19:41:44 |
102
- | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-12-06 01:49:35 |
103
- | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
102
+ | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-12-22 01:16:17 |
103
+ | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-12-25 00:11:01 |
104
104
  | ft | [人像变换](https://cloud.tencent.com/document/product/1202) | 2023-08-17 03:12:58 |
105
105
  | gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2023-11-14 01:16:54 |
106
106
  | gme | [游戏多媒体引擎](https://cloud.tencent.com/document/product/607) | 2023-12-06 01:51:28 |
@@ -133,7 +133,7 @@
133
133
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2023-11-30 04:52:16 |
134
134
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-08-17 03:51:31 |
135
135
  | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2023-12-21 01:48:52 |
136
- | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-12-20 01:50:09 |
136
+ | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-12-22 01:18:51 |
137
137
  | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-12-19 01:53:39 |
138
138
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
139
139
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
@@ -156,20 +156,20 @@
156
156
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-12-20 01:57:04 |
157
157
  | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-12-21 01:56:34 |
158
158
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-12-13 02:14:02 |
159
- | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-11-08 02:00:11 |
159
+ | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-12-25 00:15:53 |
160
160
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2023-08-17 04:23:46 |
161
161
  | pds | [私域安全](https://cloud.tencent.com/document/product/1473) | 2023-05-18 01:44:14 |
162
162
  | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2023-11-14 01:22:46 |
163
163
  | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2023-12-12 02:16:16 |
164
164
  | pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2023-12-12 02:16:34 |
165
165
  | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2023-11-24 01:21:07 |
166
- | redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2023-12-19 02:03:27 |
166
+ | redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2023-12-22 01:21:35 |
167
167
  | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2023-10-13 01:22:28 |
168
- | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-08-17 04:33:51 |
168
+ | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-12-25 00:16:39 |
169
169
  | rp | [注册保护](https://cloud.tencent.com/document/product/1191) | 2022-04-04 07:04:06 |
170
170
  | rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2023-10-13 01:22:31 |
171
171
  | scf | [云函数](https://cloud.tencent.com/document/product/583) | 2023-11-30 05:41:26 |
172
- | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2023-11-07 02:07:25 |
172
+ | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2023-12-25 00:16:59 |
173
173
  | smh | [智能媒资托管](https://cloud.tencent.com/document/product/1339) | 2023-07-11 01:37:49 |
174
174
  | smop | [腾讯安心用户运营平台](https://cloud.tencent.com/document/product/1310) | 2023-05-18 01:47:59 |
175
175
  | smpn | [营销号码安全](https://cloud.tencent.com/document/product/1127) | 2023-08-17 04:38:34 |
@@ -183,7 +183,7 @@
183
183
  | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2023-12-12 02:23:51 |
184
184
  | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2023-10-27 02:11:56 |
185
185
  | taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2023-08-17 04:47:19 |
186
- | tag | [标签](https://cloud.tencent.com/document/product/651) | 2023-10-31 02:21:34 |
186
+ | tag | [标签](https://cloud.tencent.com/document/product/651) | 2023-12-22 01:22:58 |
187
187
  | tan | [碳引擎](https://cloud.tencent.com/document/product/1498) | 2023-05-18 01:50:16 |
188
188
  | tat | [自动化助手](https://cloud.tencent.com/document/product/1340) | 2023-12-20 02:06:26 |
189
189
  | tav | [文件检测](https://cloud.tencent.com/document/product) | 2019-11-28 22:10:04 |
@@ -221,7 +221,7 @@
221
221
  | tourism | [文旅客情大数据](https://cloud.tencent.com/document/product/1684) | 2023-08-10 01:43:37 |
222
222
  | trdp | [流量风险决策平台](https://cloud.tencent.com/document/product/1604) | 2023-05-18 02:01:19 |
223
223
  | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2023-12-01 01:26:49 |
224
- | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2023-10-26 14:46:10 |
224
+ | trp | [T-Sec-安心平台(RP)](https://cloud.tencent.com/document/product/1458) | 2023-12-21 10:26:13 |
225
225
  | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2023-07-18 01:53:24 |
226
226
  | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2023-12-15 20:34:23 |
227
227
  | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-12-20 02:20:03 |
@@ -229,14 +229,14 @@
229
229
  | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2023-05-18 02:04:00 |
230
230
  | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2023-11-27 00:22:20 |
231
231
  | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2023-08-17 05:50:27 |
232
- | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-11-15 02:36:58 |
232
+ | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-12-22 01:27:31 |
233
233
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
234
- | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-12-21 02:21:45 |
235
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-12-19 02:27:19 |
234
+ | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-12-25 00:22:13 |
235
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-12-22 01:28:06 |
236
236
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-11-27 00:23:42 |
237
237
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-12-20 02:27:15 |
238
238
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-11-15 02:42:49 |
239
- | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-12-20 02:28:42 |
239
+ | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-12-22 01:29:59 |
240
240
  | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2023-12-14 02:56:46 |
241
241
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
242
242
  | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2023-08-10 01:50:27 |
@@ -4176,6 +4176,8 @@ export interface CreateDocumentRequest {
4176
4176
  <ul>
4177
4177
  <li>支持自动签传递印章,可通过指定自动签控件id,指定印章id来完成</li>
4178
4178
  </ul>
4179
+ 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。
4180
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
4179
4181
  */
4180
4182
  FormFields?: Array<FormField>
4181
4183
  /**
@@ -4275,8 +4277,8 @@ export interface CreateEmbedWebUrlRequest {
4275
4277
  <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
4276
4278
  <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
4277
4279
  <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
4278
- <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
4279
- <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
4280
+ <li>PREVIEW_FLOW:生成预览合同的嵌入页面(支持移动端)</li>
4281
+ <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面(仅支持PC端)</li></ul>
4280
4282
  */
4281
4283
  EmbedType: string
4282
4284
  /**
@@ -6020,266 +6022,236 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
6020
6022
  */
6021
6023
  export interface Component {
6022
6024
  /**
6023
- * 如果是Component填写控件类型,则可选的字段为:
6024
- TEXT - 普通文本控件,输入文本字符串;
6025
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
6026
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
6027
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
6028
- DYNAMIC_TABLE - 动态表格控件;
6029
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;
6030
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
6031
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
6032
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
6033
-
6034
- 如果是SignComponent签署控件类型,则可选的字段为
6035
- SIGN_SEAL - 签署印章控件;
6036
- SIGN_DATE - 签署日期控件;
6037
- SIGN_SIGNATURE - 用户签名控件;
6038
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
6039
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
6040
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
6041
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
6042
-
6043
- 表单域的控件不能作为印章和签名控件
6025
+ * **如果是Component填写控件类型,则可选的字段为**:
6026
+
6027
+ <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
6028
+ <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
6029
+ <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
6030
+ <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
6031
+ <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
6032
+ <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
6033
+ <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
6034
+ <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
6035
+ <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
6036
+
6037
+ **如果是SignComponent签署控件类型,则可选的字段为**
6038
+
6039
+ <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
6040
+ <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6041
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6042
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>
6043
+ <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6044
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
6045
+ <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
6046
+ 注:` 表单域的控件不能作为印章和签名控件`
6044
6047
  */
6045
6048
  ComponentType: string
6046
6049
  /**
6047
- * 控件所属文件的序号(取值为:0-N)。
6048
- 目前单文件的情况下,值是0
6049
- */
6050
- FileIndex: number
6051
- /**
6052
- * 参数控件高度,单位pt
6050
+ * **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
6051
+
6053
6052
  */
6054
6053
  ComponentHeight: number
6055
6054
  /**
6056
- * 参数控件宽度,单位pt
6055
+ * **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
6056
+
6057
6057
  */
6058
6058
  ComponentWidth: number
6059
6059
  /**
6060
- * 参数控件所在页码,取值为:1-N
6060
+ * **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
6061
+
6062
+ 注:
6063
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
6064
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
6061
6065
  */
6062
6066
  ComponentPage: number
6063
6067
  /**
6064
- * 参数控件X位置,单位pt
6068
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
6065
6069
  */
6066
6070
  ComponentPosX: number
6067
6071
  /**
6068
- * 参数控件Y位置,单位pt
6072
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
6069
6073
  */
6070
6074
  ComponentPosY: number
6075
+ /**
6076
+ * <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
6077
+ */
6078
+ FileIndex: number
6079
+ /**
6080
+ * 控件生成的方式:
6081
+ <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
6082
+ <li> <b>FIELD</b> : 表单域</li>
6083
+ <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
6084
+ */
6085
+ GenerateMode?: string
6071
6086
  /**
6072
6087
  * 控件唯一ID。
6073
- 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
6088
+
6089
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
6090
+
6091
+ **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
6092
+
6093
+ 例:
6094
+
6095
+ - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
6096
+ - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
6097
+ - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
6098
+ - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
6099
+
6100
+
6101
+ 注:`控件ID可以在一个PDF中不可重复`
6102
+
6074
6103
  */
6075
6104
  ComponentId?: string
6076
6105
  /**
6077
- * 控件名。
6078
- 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
6106
+ * **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
6107
+
6108
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
6109
+
6110
+ 注:`控件名可以在一个PDF中可以重复`
6111
+
6079
6112
  */
6080
6113
  ComponentName?: string
6081
6114
  /**
6082
- * 是否必选,默认为false-非必选
6115
+ * 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
6116
+ <ul><li>false(默认):可以不填写</li>
6117
+ <li>true :必须填写此填写控件</li></ul>
6118
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
6083
6119
  */
6084
6120
  ComponentRequired?: boolean
6085
6121
  /**
6086
- * 控件关联的参与方ID,对应Recipient结构体中的RecipientId
6122
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
6087
6123
  */
6088
6124
  ComponentRecipientId?: string
6089
6125
  /**
6090
- * 扩展参数:
6091
- 为JSON格式。
6092
- 不同类型的控件会有部分非通用参数
6093
-
6094
- ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
6095
- 1 Font:目前只支持黑体、宋体
6096
- 2 FontSize: 范围12-72
6097
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
6098
- 4 FontColor:字符串类型,格式为RGB颜色数字
6099
- 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
6100
-
6101
- ComponentType为FILL_IMAGE时,支持以下参数:
6102
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
6103
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
6104
-
6105
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
6106
- {“ComponentTypeLimit”: [“xxx”]}
6107
- xxx可以为:
6108
- HANDWRITE 手写签名
6109
- OCR_ESIGN -- AI智能识别手写签名
6110
- ESIGN -- 个人印章类型
6111
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
6112
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
6113
-
6114
- ComponentType为SIGN_DATE时,支持以下参数:
6115
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
6116
- 2 FontSize: 数字类型,范围6-72,默认值为12
6117
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
6118
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
6119
- 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
6126
+ * **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
6127
+
6128
+ <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
6129
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体</li>
6130
+ <li> <b>FontSize</b>: 范围12 :72</li>
6131
+ <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
6132
+ <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>
6133
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
6134
+
6135
+ <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
6136
+ <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
6137
+ <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
6138
+
6139
+ <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
6140
+ <ul><li> <b>HANDWRITE</b> : 手写签名</li>
6141
+ <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
6142
+ <li> <b>ESIGN</b> : 个人印章类型</li>
6143
+ <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
6144
+ <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
6145
+ <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
6146
+ 印章的对应关系参考下图
6147
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
6148
+
6149
+ <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
6150
+ <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
6151
+ <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
6152
+ <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
6153
+ <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
6154
+ <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
6120
6155
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
6121
6156
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
6122
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
6157
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
6123
6158
 
6124
- ComponentType为SIGN_SEAL类型时,支持以下参数:
6125
- 1.PageRangesPageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
6126
- 参数样例: "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
6159
+ <font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
6160
+ <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
6161
+ <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
6127
6162
  */
6128
6163
  ComponentExtra?: string
6129
6164
  /**
6130
- * 是否是表单域类型,默认false-不是
6165
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**
6131
6166
  注意:此字段可能返回 null,表示取不到有效值。
6132
6167
  */
6133
6168
  IsFormType?: boolean
6134
6169
  /**
6135
6170
  * 控件填充vaule,ComponentType和传入值类型对应关系:
6136
- TEXT - 文本内容
6137
- MULTI_LINE_TEXT - 文本内容
6138
- CHECK_BOX - true/false
6139
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
6140
- SELECTOR - 选项值
6141
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
6142
- DATE - 默认是格式化为xxxx年xx月xx
6143
- SIGN_SEAL - 印章ID,于控制台查询获取
6144
- SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
6145
-
6146
- 控件值约束说明:
6147
- 企业全称控件:
6148
- 约束:企业名称中文字符中文括号
6149
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
6150
-
6151
- 统一社会信用代码控件:
6152
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
6153
-
6154
- 法人名称控件:
6155
- 约束:最大50个字符,2到25个汉字或者1到50个字母
6156
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
6157
-
6158
- 签署意见控件:
6159
- 约束:签署意见最大长度为50字符
6160
-
6161
- 签署人手机号控件:
6162
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
6163
-
6164
- 签署人身份证控件:
6165
- 约束:合法的身份证号码检查
6171
+ <ul><li> <b>TEXT</b> : 文本内容</li>
6172
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
6173
+ <li> <b>CHECK_BOX</b> : true/false</li>
6174
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
6175
+ <li> <b>SELECTOR</b> : 选项值</li>
6176
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
6177
+ <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
6178
+ <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>
6179
+ <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>
6166
6180
 
6167
- 控件名称:
6168
- 约束:控件名称最大长度为20字符
6169
6181
 
6170
- 单行文本控件:
6171
- 约束:只允许输入中文,英文,数字,中英文标点符号
6172
-
6173
- 多行文本控件:
6174
- 约束:只允许输入中文,英文,数字,中英文标点符号
6175
-
6176
- 勾选框控件:
6177
- 约束:选择填字符串true,不选填字符串false
6178
-
6179
- 选择器控件:
6180
- 约束:同单行文本控件约束,填写选择值中的字符串
6181
-
6182
- 数字控件:
6183
- 约束:请输入有效的数字(可带小数点)
6184
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
6185
-
6186
- 日期控件:
6187
- 约束:格式:yyyy年mm月dd日
6188
-
6189
- 附件控件:
6190
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
6191
-
6192
- 图片控件:
6193
- 约束:JPG或PNG图片,填写上传的图片资源ID
6194
-
6195
- 邮箱控件:
6196
- 约束:请输入有效的邮箱地址, w3c标准
6197
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
6198
- 参考:https://emailregex.com/
6199
-
6200
- 地址控件:
6201
- 同单行文本控件约束
6202
-
6203
- 省市区控件:
6204
- 同单行文本控件约束
6205
-
6206
- 性别控件:
6207
- 同单行文本控件约束,填写选择值中的字符串
6208
-
6209
- 学历控件:
6210
- 同单行文本控件约束,填写选择值中的字符串
6182
+ <b>控件值约束说明</b>:
6183
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
6184
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
6211
6185
  */
6212
6186
  ComponentValue?: string
6213
6187
  /**
6214
- * 控件生成的方式:
6215
- NORMAL - 普通控件
6216
- FIELD - 表单域
6217
- KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
6218
- */
6219
- GenerateMode?: string
6220
- /**
6221
- * 日期签署控件的字号,默认为 12
6222
- */
6223
- ComponentDateFontSize?: number
6224
- /**
6225
- * 第三方应用集成平台模板控件 ID 标识
6226
- */
6227
- ChannelComponentId?: string
6228
- /**
6229
- * 指定关键字时横坐标偏移量,单位pt
6188
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
6189
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
6230
6190
  注意:此字段可能返回 null,表示取不到有效值。
6231
6191
  */
6232
6192
  OffsetX?: number
6233
6193
  /**
6234
- * 指定关键字时纵坐标偏移量,单位pt
6194
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
6195
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
6235
6196
  注意:此字段可能返回 null,表示取不到有效值。
6236
6197
  */
6237
6198
  OffsetY?: number
6238
6199
  /**
6239
- * 第三方应用集成中子客企业控件来源。
6240
- 0-平台指定;
6241
- 1-用户自定义
6242
- */
6243
- ChannelComponentSource?: number
6244
- /**
6245
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。
6246
- 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
6247
- 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
6200
+ * **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
6201
+ <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
6202
+ <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
6203
+
6204
+ 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
6248
6205
  */
6249
6206
  KeywordOrder?: string
6250
6207
  /**
6251
- * 指定关键字页码。
6252
- 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
6208
+ * **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
6253
6209
  */
6254
6210
  KeywordPage?: number
6255
6211
  /**
6256
- * 关键字位置模式,
6257
- Middle-居中,
6258
- Below-正下方,
6259
- Right-正右方,
6260
- LowerRight-右上角,
6261
- UpperRight-右下角。
6212
+ * **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
6213
+ <ul><li> <b>Middle</b> :居中</li>
6214
+ <li> <b>Below</b> :正下方</li>
6215
+ <li> <b>Right</b> :正右方</li>
6216
+ <li> <b>LowerRight</b> :右上角</li>
6217
+ <li> <b>UpperRight</b> :右下角。</li></ul>
6262
6218
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
6263
6219
  */
6264
6220
  RelativeLocation?: string
6265
6221
  /**
6266
- * 关键字索引。
6267
- 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
6268
- 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
6222
+ * **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
6223
+
6224
+ 注意:关键字索引是从0开始计数的
6269
6225
  */
6270
6226
  KeywordIndexes?: Array<number | bigint>
6271
6227
  /**
6272
- * 是否锁定控件值不允许编辑(嵌入式发起使用)
6273
- <br/>默认false:不锁定控件值,允许在页面编辑控件值
6228
+ * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
6229
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
6230
+ <li>true:锁定控件值,在页面编辑控件值</li></ul>
6274
6231
  注意:此字段可能返回 null,表示取不到有效值。
6275
6232
  */
6276
6233
  LockComponentValue?: boolean
6277
6234
  /**
6278
- * 是否禁止移动和删除控件
6279
- <br/>默认false,不禁止移动和删除控件
6235
+ * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
6236
+ <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
6237
+ <li> <b>true</b> : 可以移动和删除控件</li></ul>
6280
6238
  注意:此字段可能返回 null,表示取不到有效值。
6281
6239
  */
6282
6240
  ForbidMoveAndDelete?: boolean
6241
+ /**
6242
+ * <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
6243
+ */
6244
+ ComponentDateFontSize?: number
6245
+ /**
6246
+ * <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
6247
+ */
6248
+ ChannelComponentId?: string
6249
+ /**
6250
+ * <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
6251
+ <ul><li> <b>0</b> :平台指定;</li>
6252
+ <li> <b>1</b> :用户自定义</li></ul>
6253
+ */
6254
+ ChannelComponentSource?: number
6283
6255
  }
6284
6256
 
6285
6257
  /**
@@ -7275,7 +7247,10 @@ export interface CreateBatchQuickSignUrlRequest {
7275
7247
  /**
7276
7248
  * 指定批量签署合同的签名类型,可传递以下值:
7277
7249
  <ul><li>**0**:手写签名(默认)</li>
7278
- <li>**1**:OCR楷体</li></ul>
7250
+ <li>**1**:OCR楷体</li>
7251
+ <li>**2**:姓名印章</li>
7252
+ <li>**3**:图片印章</li>
7253
+ <li>**4**:系统签名</li></ul>
7279
7254
  注:
7280
7255
  <ul><li>默认情况下,签名类型为手写签名</li>
7281
7256
  <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
@@ -4049,6 +4049,8 @@ export interface CreateDocumentRequest {
4049
4049
  <ul>
4050
4050
  <li>支持自动签传递印章,可通过指定自动签控件id,指定印章id来完成</li>
4051
4051
  </ul>
4052
+ 注:只有在控制台编辑模板时,<font color="red">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。
4053
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a54a76a58c454593d06d8e9883ecc9b3.png)
4052
4054
  */
4053
4055
  FormFields?: Array<FormField>;
4054
4056
  /**
@@ -4144,8 +4146,8 @@ export interface CreateEmbedWebUrlRequest {
4144
4146
  <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
4145
4147
  <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
4146
4148
  <li>EXTEND_SERVICE:生成拓展服务的嵌入页面</li>
4147
- <li>PREVIEW_FLOW:生成预览合同的嵌入页面</li>
4148
- <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面</li></ul>
4149
+ <li>PREVIEW_FLOW:生成预览合同的嵌入页面(支持移动端)</li>
4150
+ <li>PREVIEW_FLOW_DETAIL:生成查看合同详情的嵌入页面(仅支持PC端)</li></ul>
4149
4151
  */
4150
4152
  EmbedType: string;
4151
4153
  /**
@@ -5834,266 +5836,236 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
5834
5836
  */
5835
5837
  export interface Component {
5836
5838
  /**
5837
- * 如果是Component填写控件类型,则可选的字段为:
5838
- TEXT - 普通文本控件,输入文本字符串;
5839
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
5840
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
5841
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
5842
- DYNAMIC_TABLE - 动态表格控件;
5843
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;
5844
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
5845
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
5846
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
5847
-
5848
- 如果是SignComponent签署控件类型,则可选的字段为
5849
- SIGN_SEAL - 签署印章控件;
5850
- SIGN_DATE - 签署日期控件;
5851
- SIGN_SIGNATURE - 用户签名控件;
5852
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
5853
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
5854
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
5855
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
5856
-
5857
- 表单域的控件不能作为印章和签名控件
5839
+ * **如果是Component填写控件类型,则可选的字段为**:
5840
+
5841
+ <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
5842
+ <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
5843
+ <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
5844
+ <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
5845
+ <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
5846
+ <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
5847
+ <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
5848
+ <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
5849
+ <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
5850
+
5851
+ **如果是SignComponent签署控件类型,则可选的字段为**
5852
+
5853
+ <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
5854
+ <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
5855
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
5856
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>
5857
+ <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
5858
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
5859
+ <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
5860
+ 注:` 表单域的控件不能作为印章和签名控件`
5858
5861
  */
5859
5862
  ComponentType: string;
5860
5863
  /**
5861
- * 控件所属文件的序号(取值为:0-N)。
5862
- 目前单文件的情况下,值是0
5863
- */
5864
- FileIndex: number;
5865
- /**
5866
- * 参数控件高度,单位pt
5864
+ * **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
5865
+
5867
5866
  */
5868
5867
  ComponentHeight: number;
5869
5868
  /**
5870
- * 参数控件宽度,单位pt
5869
+ * **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
5870
+
5871
5871
  */
5872
5872
  ComponentWidth: number;
5873
5873
  /**
5874
- * 参数控件所在页码,取值为:1-N
5874
+ * **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
5875
+
5876
+ 注:
5877
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
5878
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
5875
5879
  */
5876
5880
  ComponentPage: number;
5877
5881
  /**
5878
- * 参数控件X位置,单位pt
5882
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
5879
5883
  */
5880
5884
  ComponentPosX: number;
5881
5885
  /**
5882
- * 参数控件Y位置,单位pt
5886
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
5883
5887
  */
5884
5888
  ComponentPosY: number;
5889
+ /**
5890
+ * <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
5891
+ */
5892
+ FileIndex: number;
5893
+ /**
5894
+ * 控件生成的方式:
5895
+ <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
5896
+ <li> <b>FIELD</b> : 表单域</li>
5897
+ <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
5898
+ */
5899
+ GenerateMode?: string;
5885
5900
  /**
5886
5901
  * 控件唯一ID。
5887
- 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
5902
+
5903
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
5904
+
5905
+ **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
5906
+
5907
+ 例:
5908
+
5909
+ - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
5910
+ - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
5911
+ - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
5912
+ - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
5913
+
5914
+
5915
+ 注:`控件ID可以在一个PDF中不可重复`
5916
+
5888
5917
  */
5889
5918
  ComponentId?: string;
5890
5919
  /**
5891
- * 控件名。
5892
- 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
5920
+ * **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
5921
+
5922
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
5923
+
5924
+ 注:`控件名可以在一个PDF中可以重复`
5925
+
5893
5926
  */
5894
5927
  ComponentName?: string;
5895
5928
  /**
5896
- * 是否必选,默认为false-非必选
5929
+ * 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
5930
+ <ul><li>false(默认):可以不填写</li>
5931
+ <li>true :必须填写此填写控件</li></ul>
5932
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
5897
5933
  */
5898
5934
  ComponentRequired?: boolean;
5899
5935
  /**
5900
- * 控件关联的参与方ID,对应Recipient结构体中的RecipientId
5936
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
5901
5937
  */
5902
5938
  ComponentRecipientId?: string;
5903
5939
  /**
5904
- * 扩展参数:
5905
- 为JSON格式。
5906
- 不同类型的控件会有部分非通用参数
5907
-
5908
- ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
5909
- 1 Font:目前只支持黑体、宋体
5910
- 2 FontSize: 范围12-72
5911
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
5912
- 4 FontColor:字符串类型,格式为RGB颜色数字
5913
- 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
5914
-
5915
- ComponentType为FILL_IMAGE时,支持以下参数:
5916
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
5917
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
5918
-
5919
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
5920
- {“ComponentTypeLimit”: [“xxx”]}
5921
- xxx可以为:
5922
- HANDWRITE 手写签名
5923
- OCR_ESIGN -- AI智能识别手写签名
5924
- ESIGN -- 个人印章类型
5925
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
5926
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
5927
-
5928
- ComponentType为SIGN_DATE时,支持以下参数:
5929
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
5930
- 2 FontSize: 数字类型,范围6-72,默认值为12
5931
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
5932
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
5933
- 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
5940
+ * **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
5941
+
5942
+ <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
5943
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体</li>
5944
+ <li> <b>FontSize</b>: 范围12 :72</li>
5945
+ <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
5946
+ <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>
5947
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
5948
+
5949
+ <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
5950
+ <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
5951
+ <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
5952
+
5953
+ <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
5954
+ <ul><li> <b>HANDWRITE</b> : 手写签名</li>
5955
+ <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
5956
+ <li> <b>ESIGN</b> : 个人印章类型</li>
5957
+ <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
5958
+ <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
5959
+ <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
5960
+ 印章的对应关系参考下图
5961
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
5962
+
5963
+ <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
5964
+ <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
5965
+ <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
5966
+ <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
5967
+ <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
5968
+ <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
5934
5969
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
5935
5970
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
5936
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
5971
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
5937
5972
 
5938
- ComponentType为SIGN_SEAL类型时,支持以下参数:
5939
- 1.PageRangesPageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
5940
- 参数样例: "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
5973
+ <font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
5974
+ <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
5975
+ <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
5941
5976
  */
5942
5977
  ComponentExtra?: string;
5943
5978
  /**
5944
- * 是否是表单域类型,默认false-不是
5979
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**
5945
5980
  注意:此字段可能返回 null,表示取不到有效值。
5946
5981
  */
5947
5982
  IsFormType?: boolean;
5948
5983
  /**
5949
5984
  * 控件填充vaule,ComponentType和传入值类型对应关系:
5950
- TEXT - 文本内容
5951
- MULTI_LINE_TEXT - 文本内容
5952
- CHECK_BOX - true/false
5953
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
5954
- SELECTOR - 选项值
5955
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
5956
- DATE - 默认是格式化为xxxx年xx月xx
5957
- SIGN_SEAL - 印章ID,于控制台查询获取
5958
- SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
5959
-
5960
- 控件值约束说明:
5961
- 企业全称控件:
5962
- 约束:企业名称中文字符中文括号
5963
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
5964
-
5965
- 统一社会信用代码控件:
5966
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
5967
-
5968
- 法人名称控件:
5969
- 约束:最大50个字符,2到25个汉字或者1到50个字母
5970
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
5971
-
5972
- 签署意见控件:
5973
- 约束:签署意见最大长度为50字符
5974
-
5975
- 签署人手机号控件:
5976
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
5977
-
5978
- 签署人身份证控件:
5979
- 约束:合法的身份证号码检查
5985
+ <ul><li> <b>TEXT</b> : 文本内容</li>
5986
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
5987
+ <li> <b>CHECK_BOX</b> : true/false</li>
5988
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
5989
+ <li> <b>SELECTOR</b> : 选项值</li>
5990
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
5991
+ <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
5992
+ <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>
5993
+ <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>
5980
5994
 
5981
- 控件名称:
5982
- 约束:控件名称最大长度为20字符
5983
5995
 
5984
- 单行文本控件:
5985
- 约束:只允许输入中文,英文,数字,中英文标点符号
5986
-
5987
- 多行文本控件:
5988
- 约束:只允许输入中文,英文,数字,中英文标点符号
5989
-
5990
- 勾选框控件:
5991
- 约束:选择填字符串true,不选填字符串false
5992
-
5993
- 选择器控件:
5994
- 约束:同单行文本控件约束,填写选择值中的字符串
5995
-
5996
- 数字控件:
5997
- 约束:请输入有效的数字(可带小数点)
5998
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
5999
-
6000
- 日期控件:
6001
- 约束:格式:yyyy年mm月dd日
6002
-
6003
- 附件控件:
6004
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
6005
-
6006
- 图片控件:
6007
- 约束:JPG或PNG图片,填写上传的图片资源ID
6008
-
6009
- 邮箱控件:
6010
- 约束:请输入有效的邮箱地址, w3c标准
6011
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
6012
- 参考:https://emailregex.com/
6013
-
6014
- 地址控件:
6015
- 同单行文本控件约束
6016
-
6017
- 省市区控件:
6018
- 同单行文本控件约束
6019
-
6020
- 性别控件:
6021
- 同单行文本控件约束,填写选择值中的字符串
6022
-
6023
- 学历控件:
6024
- 同单行文本控件约束,填写选择值中的字符串
5996
+ <b>控件值约束说明</b>:
5997
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
5998
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
6025
5999
  */
6026
6000
  ComponentValue?: string;
6027
6001
  /**
6028
- * 控件生成的方式:
6029
- NORMAL - 普通控件
6030
- FIELD - 表单域
6031
- KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
6032
- */
6033
- GenerateMode?: string;
6034
- /**
6035
- * 日期签署控件的字号,默认为 12
6036
- */
6037
- ComponentDateFontSize?: number;
6038
- /**
6039
- * 第三方应用集成平台模板控件 ID 标识
6040
- */
6041
- ChannelComponentId?: string;
6042
- /**
6043
- * 指定关键字时横坐标偏移量,单位pt
6002
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
6003
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
6044
6004
  注意:此字段可能返回 null,表示取不到有效值。
6045
6005
  */
6046
6006
  OffsetX?: number;
6047
6007
  /**
6048
- * 指定关键字时纵坐标偏移量,单位pt
6008
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
6009
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
6049
6010
  注意:此字段可能返回 null,表示取不到有效值。
6050
6011
  */
6051
6012
  OffsetY?: number;
6052
6013
  /**
6053
- * 第三方应用集成中子客企业控件来源。
6054
- 0-平台指定;
6055
- 1-用户自定义
6056
- */
6057
- ChannelComponentSource?: number;
6058
- /**
6059
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。
6060
- 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
6061
- 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
6014
+ * **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
6015
+ <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
6016
+ <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
6017
+
6018
+ 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
6062
6019
  */
6063
6020
  KeywordOrder?: string;
6064
6021
  /**
6065
- * 指定关键字页码。
6066
- 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
6022
+ * **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
6067
6023
  */
6068
6024
  KeywordPage?: number;
6069
6025
  /**
6070
- * 关键字位置模式,
6071
- Middle-居中,
6072
- Below-正下方,
6073
- Right-正右方,
6074
- LowerRight-右上角,
6075
- UpperRight-右下角。
6026
+ * **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
6027
+ <ul><li> <b>Middle</b> :居中</li>
6028
+ <li> <b>Below</b> :正下方</li>
6029
+ <li> <b>Right</b> :正右方</li>
6030
+ <li> <b>LowerRight</b> :右上角</li>
6031
+ <li> <b>UpperRight</b> :右下角。</li></ul>
6076
6032
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
6077
6033
  */
6078
6034
  RelativeLocation?: string;
6079
6035
  /**
6080
- * 关键字索引。
6081
- 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
6082
- 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
6036
+ * **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
6037
+
6038
+ 注意:关键字索引是从0开始计数的
6083
6039
  */
6084
6040
  KeywordIndexes?: Array<number | bigint>;
6085
6041
  /**
6086
- * 是否锁定控件值不允许编辑(嵌入式发起使用)
6087
- <br/>默认false:不锁定控件值,允许在页面编辑控件值
6042
+ * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
6043
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
6044
+ <li>true:锁定控件值,在页面编辑控件值</li></ul>
6088
6045
  注意:此字段可能返回 null,表示取不到有效值。
6089
6046
  */
6090
6047
  LockComponentValue?: boolean;
6091
6048
  /**
6092
- * 是否禁止移动和删除控件
6093
- <br/>默认false,不禁止移动和删除控件
6049
+ * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
6050
+ <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
6051
+ <li> <b>true</b> : 可以移动和删除控件</li></ul>
6094
6052
  注意:此字段可能返回 null,表示取不到有效值。
6095
6053
  */
6096
6054
  ForbidMoveAndDelete?: boolean;
6055
+ /**
6056
+ * <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
6057
+ */
6058
+ ComponentDateFontSize?: number;
6059
+ /**
6060
+ * <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
6061
+ */
6062
+ ChannelComponentId?: string;
6063
+ /**
6064
+ * <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
6065
+ <ul><li> <b>0</b> :平台指定;</li>
6066
+ <li> <b>1</b> :用户自定义</li></ul>
6067
+ */
6068
+ ChannelComponentSource?: number;
6097
6069
  }
6098
6070
  /**
6099
6071
  * 部门信息
@@ -7056,7 +7028,10 @@ export interface CreateBatchQuickSignUrlRequest {
7056
7028
  /**
7057
7029
  * 指定批量签署合同的签名类型,可传递以下值:
7058
7030
  <ul><li>**0**:手写签名(默认)</li>
7059
- <li>**1**:OCR楷体</li></ul>
7031
+ <li>**1**:OCR楷体</li>
7032
+ <li>**2**:姓名印章</li>
7033
+ <li>**3**:图片印章</li>
7034
+ <li>**4**:系统签名</li></ul>
7060
7035
  注:
7061
7036
  <ul><li>默认情况下,签名类型为手写签名</li>
7062
7037
  <li>您可以传递多种值,表示可用多种签名类型。</li></ul>