tencentcloud-sdk-nodejs-essbasic 4.0.653 → 4.0.654

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-essbasic",
3
- "version": "4.0.653",
3
+ "version": "4.0.654",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -14,10 +14,10 @@
14
14
  | apcas | [汽车精准获客服务](https://cloud.tencent.com/document/product/1244) | 2022-04-04 06:05:36 |
15
15
  | ape | [正版图库直通车](https://cloud.tencent.com/document/product/1181) | 2022-04-04 06:05:40 |
16
16
  | api | [云 API](https://cloud.tencent.com/document/product/1278) | 2023-01-05 01:02:52 |
17
- | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-07-27 01:06:01 |
17
+ | apigateway | [API 网关](https://cloud.tencent.com/document/product/628) | 2023-08-01 01:01:56 |
18
18
  | apm | [应用性能监控](https://cloud.tencent.com/document/product/1463) | 2023-07-18 01:07:24 |
19
19
  | as | [弹性伸缩](https://cloud.tencent.com/document/product/377) | 2023-07-19 01:07:14 |
20
- | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-07-26 01:04:04 |
20
+ | asr | [语音识别](https://cloud.tencent.com/document/product/1093) | 2023-08-01 01:03:12 |
21
21
  | asw | [应用与服务编排工作流](https://cloud.tencent.com/document/product/1272) | 2023-05-18 01:04:02 |
22
22
  | ba | [网站备案](https://cloud.tencent.com/document/product/243) | 2023-05-18 01:04:06 |
23
23
  | batch | [批量计算](https://cloud.tencent.com/document/product/599) | 2023-07-19 01:07:48 |
@@ -55,11 +55,11 @@
55
55
  | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
56
56
  | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
57
57
  | ckafka | [消息队列 CKafka](https://cloud.tencent.com/document/product/597) | 2023-07-31 01:13:15 |
58
- | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-07-31 01:13:45 |
58
+ | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-08-01 01:09:50 |
59
59
  | cloudaudit | [云审计](https://cloud.tencent.com/document/product/629) | 2023-05-18 01:13:28 |
60
60
  | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2023-05-18 01:13:36 |
61
61
  | cloudstudio | [Cloud Studio(云端 IDE)](https://cloud.tencent.com/document/product/1039) | 2023-07-24 01:17:40 |
62
- | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2023-07-31 01:14:37 |
62
+ | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2023-08-01 01:11:03 |
63
63
  | cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2023-07-26 01:11:19 |
64
64
  | cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2023-05-18 01:14:51 |
65
65
  | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2023-07-11 01:11:56 |
@@ -70,7 +70,7 @@
70
70
  | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-07-27 01:10:40 |
71
71
  | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-07-28 01:18:37 |
72
72
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
73
- | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2023-07-27 01:11:21 |
73
+ | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2023-08-01 01:15:19 |
74
74
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2023-07-07 01:21:45 |
75
75
  | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 |
76
76
  | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 |
@@ -78,8 +78,8 @@
78
78
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-05-18 01:21:33 |
79
79
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-05-18 01:21:37 |
80
80
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-06-28 01:18:44 |
81
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-07-21 01:20:29 |
82
- | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-07-28 01:23:03 |
81
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-08-01 01:17:48 |
82
+ | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-08-01 01:18:18 |
83
83
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-07-24 01:25:15 |
84
84
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-05-18 01:23:31 |
85
85
  | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-05-18 01:23:36 |
@@ -91,12 +91,12 @@
91
91
  | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-07-11 01:20:38 |
92
92
  | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
93
93
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-05-18 01:25:58 |
94
- | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-07-25 10:56:12 |
94
+ | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-08-01 01:21:59 |
95
95
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-07-12 01:24:00 |
96
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-07-31 01:23:57 |
97
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-07-28 17:50:48 |
96
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-08-01 01:22:32 |
97
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-08-01 01:24:13 |
98
98
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-07-27 01:13:31 |
99
- | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-07-25 10:59:09 |
99
+ | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-08-01 01:24:47 |
100
100
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-07-14 14:55:45 |
101
101
  | ft | [人像变换](https://cloud.tencent.com/document/product/1202) | 2023-05-18 01:28:35 |
102
102
  | gaap | [全球应用加速](https://cloud.tencent.com/document/product/608) | 2023-07-28 01:27:13 |
@@ -127,7 +127,7 @@
127
127
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-05-18 01:35:58 |
128
128
  | lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2023-07-31 01:30:04 |
129
129
  | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-07-25 11:04:43 |
130
- | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-07-28 01:33:15 |
130
+ | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-08-01 01:30:51 |
131
131
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
132
132
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
133
133
  | mall | [商场客留大数据](https://cloud.tencent.com/document/product/1707) | 2023-07-17 10:16:02 |
@@ -136,17 +136,17 @@
136
136
  | memcached | [云数据库Memcached](https://cloud.tencent.com/document/product/241) | 2023-05-26 01:41:20 |
137
137
  | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-07-08 06:11:32 |
138
138
  | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2023-05-18 01:39:20 |
139
- | mna | [移动网络加速](https://cloud.tencent.com/document/product/1385) | 2023-05-25 01:46:28 |
139
+ | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-08-01 01:32:11 |
140
140
  | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-07-06 01:31:55 |
141
141
  | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-07-19 01:32:20 |
142
- | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-07-20 01:35:35 |
142
+ | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-08-01 01:33:24 |
143
143
  | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-05-18 01:42:01 |
144
- | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-07-27 01:16:41 |
144
+ | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-08-01 01:34:16 |
145
145
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2023-05-18 01:42:21 |
146
146
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
147
147
  | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-07-31 01:34:03 |
148
148
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
149
- | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-07-17 01:29:44 |
149
+ | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-08-01 01:34:42 |
150
150
  | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-07-31 01:34:27 |
151
151
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-07-20 01:37:20 |
152
152
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-07-27 01:17:15 |
@@ -194,7 +194,7 @@
194
194
  | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-07-28 01:47:50 |
195
195
  | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 |
196
196
  | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2023-07-24 01:49:20 |
197
- | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-07-26 01:38:18 |
197
+ | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-08-01 01:43:47 |
198
198
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-05-18 01:55:50 |
199
199
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-05-22 02:01:01 |
200
200
  | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-07-31 01:43:23 |
@@ -219,12 +219,12 @@
219
219
  | tse | [微服务引擎 TSE](https://cloud.tencent.com/document/product/1364) | 2023-07-19 01:46:53 |
220
220
  | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2023-07-28 01:55:23 |
221
221
  | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2023-05-18 02:04:00 |
222
- | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2023-07-28 01:56:27 |
222
+ | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2023-08-01 01:49:43 |
223
223
  | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2023-05-18 02:04:06 |
224
224
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-05-18 02:04:19 |
225
225
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-05-18 02:04:23 |
226
226
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-07-26 01:43:57 |
227
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-07-28 01:57:59 |
227
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-08-01 01:51:10 |
228
228
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
229
229
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-07-31 01:50:43 |
230
230
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
@@ -339,8 +339,18 @@ export class Client extends TencentCloudCommon.AbstractClient {
339
339
  }
340
340
 
341
341
  /**
342
- * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
343
- */
342
+ * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
343
+
344
+ > **适用场景**
345
+ >
346
+ > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
347
+ > 一个模板通常会包含以下结构信息
348
+ >- 模板基本信息
349
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
350
+ >- 填写控件 Components
351
+ >- 签署控件 SignComponents
352
+ >- 生成模板的文件基础信息 FileInfos
353
+ */
344
354
  async DescribeTemplates(
345
355
  req: DescribeTemplatesRequest,
346
356
  cb?: (error: string, rep: DescribeTemplatesResponse) => void
@@ -436,8 +446,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
436
446
  }
437
447
 
438
448
  /**
439
- * 通过发起转换任务接口(ChannelCreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
440
- */
449
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
450
+ 注意:大文件转换所需的时间可能会比较长。
451
+ */
441
452
  async ChannelGetTaskResultApi(
442
453
  req: ChannelGetTaskResultApiRequest,
443
454
  cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void
@@ -71,8 +71,7 @@ CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;
71
71
 
72
72
  注:
73
73
  当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
74
- 例:
75
- 当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
74
+ 例:当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
76
75
  如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
77
76
 
78
77
  创建控件时,此值为空
@@ -104,15 +103,16 @@ SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
104
103
  */
105
104
  ComponentType?: string
106
105
  /**
107
- * 控件简称,不能超过30个字符
106
+ * 控件简称,不超过30个字符
108
107
  */
109
108
  ComponentName?: string
110
109
  /**
111
- * 定义控件是否为必填项,默认为false
110
+ * 控件是否为必填项,
111
+ 默认为false-非必填
112
112
  */
113
113
  ComponentRequired?: boolean
114
114
  /**
115
- * 控件关联的签署方id
115
+ * 控件关联的参与方ID,对应Recipient结构体中的RecipientId
116
116
  */
117
117
  ComponentRecipientId?: string
118
118
  /**
@@ -273,11 +273,11 @@ SIGN_PAGING_SEAL - 可以指定印章ID
273
273
  */
274
274
  ComponentDateFontSize?: number
275
275
  /**
276
- * 控件所属文档的Id, 模块相关接口为空值
276
+ * 控件所属文档的Id, 模板相关接口为空值
277
277
  */
278
278
  DocumentId?: string
279
279
  /**
280
- * 控件描述,不能超过30个字符
280
+ * 控件描述,不超过30个字符
281
281
  */
282
282
  ComponentDescription?: string
283
283
  /**
@@ -294,20 +294,31 @@ SIGN_PAGING_SEAL - 可以指定印章ID
294
294
  */
295
295
  ChannelComponentId?: string
296
296
  /**
297
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
297
+ * 指定关键字排序规则,
298
+ Positive-正序,
299
+ Reverse-倒序。
300
+ 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
298
301
  传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
299
302
  */
300
303
  KeywordOrder?: string
301
304
  /**
302
- * 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
305
+ * 指定关键字页码。
306
+ 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
303
307
  */
304
308
  KeywordPage?: number
305
309
  /**
306
- * 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
310
+ * 关键字位置模式,
311
+ Middle-居中,
312
+ Below-正下方,
313
+ Right-正右方,
314
+ LowerRight-右上角,
315
+ UpperRight-右下角。
316
+ 示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
307
317
  */
308
318
  RelativeLocation?: string
309
319
  /**
310
- * 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
320
+ * 关键字索引,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
321
+ 示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
311
322
  */
312
323
  KeywordIndexes?: Array<number>
313
324
  /**
@@ -610,12 +621,17 @@ export interface OperateChannelTemplateResponse {
610
621
  */
611
622
  TemplateId?: string
612
623
  /**
613
- * 描述模板可见性更改的结果,和参数中Available无关,全部成功-"all-success",部分成功-"part-success", 全部失败-"fail"失败的会在FailMessageList中展示。
624
+ * 描述模板可见性更改的结果,和参数中Available无关。
625
+ 全部成功-"all-success",
626
+ 部分成功-"part-success",
627
+ 全部失败-"fail",失败的会在FailMessageList中展示。
614
628
  注意:此字段可能返回 null,表示取不到有效值。
615
629
  */
616
630
  OperateResult?: string
617
631
  /**
618
- * 模板可见性, 全部可见-"all", 部分可见-"part"
632
+ * 模板可见性,
633
+ 全部可见-"all",
634
+ 部分可见-"part"
619
635
  注意:此字段可能返回 null,表示取不到有效值。
620
636
  */
621
637
  AuthTag?: string
@@ -1463,36 +1479,44 @@ export interface PrepareFlowsResponse {
1463
1479
 
1464
1480
  /**
1465
1481
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
1482
+
1483
+ > **模板组成**
1484
+ >
1485
+ > 一个模板通常会包含以下结构信息
1486
+ >- 模板基本信息
1487
+ >- 签署参与方 Recipients,在模板发起合同时用于指定参与方
1488
+ >- 填写控件 Components
1489
+ >- 签署控件 SignComponents
1466
1490
  */
1467
1491
  export interface TemplateInfo {
1468
1492
  /**
1469
- * 模板ID
1493
+ * 模板ID,模板的唯一标识
1470
1494
  */
1471
- TemplateId: string
1495
+ TemplateId?: string
1472
1496
  /**
1473
- * 模板名字
1497
+ * 模板名
1474
1498
  */
1475
- TemplateName: string
1499
+ TemplateName?: string
1476
1500
  /**
1477
1501
  * 模板描述信息
1478
1502
  */
1479
- Description: string
1503
+ Description?: string
1480
1504
  /**
1481
- * 模板的填充控件信息结构
1505
+ * 模板的填充控件列表
1482
1506
  */
1483
- Components: Array<Component>
1507
+ Components?: Array<Component>
1484
1508
  /**
1485
- * 模板中的流程参与人信息
1509
+ * 模板中的签署参与方列表
1486
1510
  */
1487
- Recipients: Array<Recipient>
1511
+ Recipients?: Array<Recipient>
1488
1512
  /**
1489
- * 模板中的签署控件信息结构
1513
+ * 模板中的签署控件列表
1490
1514
  */
1491
- SignComponents: Array<Component>
1515
+ SignComponents?: Array<Component>
1492
1516
  /**
1493
1517
  * 模板类型:1-静默签;3-普通模板
1494
1518
  */
1495
- TemplateType: number
1519
+ TemplateType?: number
1496
1520
  /**
1497
1521
  * 是否是发起人 ,已弃用
1498
1522
  * @deprecated
@@ -1501,42 +1525,50 @@ export interface TemplateInfo {
1501
1525
  /**
1502
1526
  * 模板的创建者信息,电子签系统用户ID
1503
1527
  */
1504
- Creator: string
1528
+ Creator?: string
1505
1529
  /**
1506
- * 模板创建的时间戳,单位秒
1530
+ * 模板创建的时间戳,格式为Unix标准时间戳(秒)
1507
1531
  */
1508
- CreatedOn: number
1532
+ CreatedOn?: number
1509
1533
  /**
1510
- * 模板的H5预览链接,可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。请求参数WithPreviewUrl=true时返回,有效期5分钟。
1534
+ * 模板的H5预览链接,有效期5分钟。
1535
+ 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
1536
+ (此功能开放需要联系客户经理)
1511
1537
  注意:此字段可能返回 null,表示取不到有效值。
1512
1538
  */
1513
- PreviewUrl: string
1539
+ PreviewUrl?: string
1514
1540
  /**
1515
- * 第三方应用集成-模板PDF文件链接。请求参数WithPdfUrl=true时返回(此功能开放需要联系客户经理),有效期5分钟。
1541
+ * 第三方应用集成-模板PDF文件链接,有效期5分钟。
1542
+ 请求参数WithPdfUrl=true时返回
1543
+ (此功能开放需要联系客户经理)。
1516
1544
  注意:此字段可能返回 null,表示取不到有效值。
1517
1545
  */
1518
- PdfUrl: string
1546
+ PdfUrl?: string
1519
1547
  /**
1520
- * 关联的第三方应用平台企业模板ID
1548
+ * 本模板关联的第三方应用平台企业模板ID
1521
1549
  */
1522
- ChannelTemplateId: string
1550
+ ChannelTemplateId?: string
1523
1551
  /**
1524
- * 关联的三方应用平台平台企业模板名称
1552
+ * 本模板关联的三方应用平台平台企业模板名称
1525
1553
  注意:此字段可能返回 null,表示取不到有效值。
1526
1554
  */
1527
- ChannelTemplateName: string
1555
+ ChannelTemplateName?: string
1528
1556
  /**
1529
- * 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
1557
+ * 0-需要子客企业手动领取平台企业的模板(默认);
1558
+ 1-平台自动设置子客模板
1530
1559
  注意:此字段可能返回 null,表示取不到有效值。
1531
1560
  */
1532
- ChannelAutoSave: number
1561
+ ChannelAutoSave?: number
1533
1562
  /**
1534
- * 模板版本,全数字字符。默认为空,初始版本为yyyyMMdd001。
1563
+ * 模板版本,全数字字符。
1564
+ 默认为空,初始版本为yyyyMMdd001。
1535
1565
  注意:此字段可能返回 null,表示取不到有效值。
1536
1566
  */
1537
- TemplateVersion: string
1567
+ TemplateVersion?: string
1538
1568
  /**
1539
- * 模板可用状态,取值:1启用(默认),2停用
1569
+ * 模板可用状态:
1570
+ 1启用(默认)
1571
+ 2停用
1540
1572
  注意:此字段可能返回 null,表示取不到有效值。
1541
1573
  */
1542
1574
  Available?: number
@@ -1584,35 +1616,42 @@ export interface Agent {
1584
1616
  }
1585
1617
 
1586
1618
  /**
1587
- * 签署参与者信息
1619
+ * 流程中参与方的信息结构
1588
1620
  */
1589
1621
  export interface Recipient {
1590
1622
  /**
1591
- * 签署人唯一标识,在通过模板发起合同的时候对应签署方Id
1623
+ * 签署人唯一标识,在通过模板发起合同的时候对应签署方ID
1592
1624
  */
1593
1625
  RecipientId?: string
1594
1626
  /**
1595
- * 参与者类型。默认为空。ENTERPRISE-企业;INDIVIDUAL-个人;PROMOTER-发起方
1627
+ * 参与者类型,默认为空。
1628
+ ENTERPRISE-企业;
1629
+ INDIVIDUAL-个人;
1630
+ PROMOTER-发起方
1596
1631
  */
1597
1632
  RecipientType?: string
1598
1633
  /**
1599
- * 描述
1634
+ * 描述信息
1600
1635
  */
1601
1636
  Description?: string
1602
1637
  /**
1603
- * 签署方备注角色名
1638
+ * 角色名称
1604
1639
  */
1605
1640
  RoleName?: string
1606
1641
  /**
1607
- * 是否需要校验,true-是,false-否
1642
+ * 是否需要校验,
1643
+ true-是,
1644
+ false-否
1608
1645
  */
1609
1646
  RequireValidation?: boolean
1610
1647
  /**
1611
- * 是否必须填写,true-是,false-否
1648
+ * 是否必须填写,
1649
+ true-是,
1650
+ false-否
1612
1651
  */
1613
1652
  RequireSign?: boolean
1614
1653
  /**
1615
- * 签署类型
1654
+ * 内部字段,签署类型
1616
1655
  */
1617
1656
  SignType?: number
1618
1657
  /**
@@ -1620,7 +1659,9 @@ export interface Recipient {
1620
1659
  */
1621
1660
  RoutingOrder?: number
1622
1661
  /**
1623
- * 是否是发起方
1662
+ * 是否是发起方,
1663
+ true-是
1664
+ false-否
1624
1665
  */
1625
1666
  IsPromoter?: boolean
1626
1667
  }
@@ -1630,19 +1671,19 @@ export interface Recipient {
1630
1671
  */
1631
1672
  export interface DescribeTemplatesResponse {
1632
1673
  /**
1633
- * 模板详情
1674
+ * 模板列表
1634
1675
  */
1635
1676
  Templates?: Array<TemplateInfo>
1636
1677
  /**
1637
- * 查询总数
1678
+ * 查询到的总数
1638
1679
  */
1639
1680
  TotalCount?: number
1640
1681
  /**
1641
- * 查询数量
1682
+ * 每页多少条数据
1642
1683
  */
1643
1684
  Limit?: number
1644
1685
  /**
1645
- * 查询起始偏移
1686
+ * 查询结果分页返回,此处指定第几页。页码从0开始,即首页为0。
1646
1687
  */
1647
1688
  Offset?: number
1648
1689
  /**
@@ -3752,7 +3793,8 @@ export interface ChannelCancelFlowRequest {
3752
3793
  */
3753
3794
  export interface DescribeTemplatesRequest {
3754
3795
  /**
3755
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
3796
+ * 应用相关信息。
3797
+ 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。
3756
3798
  */
3757
3799
  Agent: Agent
3758
3800
  /**
@@ -3760,19 +3802,23 @@ export interface DescribeTemplatesRequest {
3760
3802
  */
3761
3803
  TemplateId?: string
3762
3804
  /**
3763
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
3805
+ * 查询内容:
3806
+ 0-模板列表及详情(默认),
3807
+ 1-仅模板列表
3764
3808
  */
3765
3809
  ContentType?: number
3766
3810
  /**
3767
- * 查询个数,默认20,最大100;在查询列表的时候有效
3811
+ * 指定每页多少条数据,如果不传默认为20,单页最大100
3768
3812
  */
3769
3813
  Limit?: number
3770
3814
  /**
3771
- * 查询偏移位置,默认0;在查询列表的时候有效
3815
+ * 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
3772
3816
  */
3773
3817
  Offset?: number
3774
3818
  /**
3775
- * 是否返回所有组件信息。默认false,只返回发起方控件;true,返回所有签署方控件
3819
+ * 是否返回所有组件信息。
3820
+ 默认false,只返回发起方控件;
3821
+ true,返回所有签署方控件
3776
3822
  */
3777
3823
  QueryAllComponents?: boolean
3778
3824
  /**
@@ -3780,11 +3826,16 @@ export interface DescribeTemplatesRequest {
3780
3826
  */
3781
3827
  TemplateName?: string
3782
3828
  /**
3783
- * 是否获取模板预览链接
3829
+ * 是否获取模板预览链接,
3830
+ 默认false-不获取
3831
+ true-获取
3784
3832
  */
3785
3833
  WithPreviewUrl?: boolean
3786
3834
  /**
3787
- * 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
3835
+ * 是否获取模板的PDF文件链接。
3836
+ 默认false-不获取
3837
+ true-获取
3838
+ 请联系客户经理开白后使用。
3788
3839
  */
3789
3840
  WithPdfUrl?: boolean
3790
3841
  /**
@@ -4013,11 +4064,15 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
4013
4064
  */
4014
4065
  export interface OperateChannelTemplateRequest {
4015
4066
  /**
4016
- * 应用相关信息。 此接口Agent.AppId必填。
4067
+ * 应用相关信息。
4068
+ 此接口Agent.AppId必填。
4017
4069
  */
4018
4070
  Agent: Agent
4019
4071
  /**
4020
- * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
4072
+ * 操作类型,
4073
+ 查询:"SELECT",
4074
+ 删除:"DELETE",
4075
+ 更新:"UPDATE"
4021
4076
  */
4022
4077
  OperateType: string
4023
4078
  /**
@@ -4025,23 +4080,29 @@ export interface OperateChannelTemplateRequest {
4025
4080
  */
4026
4081
  TemplateId: string
4027
4082
  /**
4028
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
4083
+ * 合作企业方第三方机构唯一标识数据.
4084
+ 支持多个, 用","进行分隔
4029
4085
  */
4030
4086
  ProxyOrganizationOpenIds?: string
4031
4087
  /**
4032
- * 模板可见性, 全部可见-"all", 部分可见-"part"
4088
+ * 模板可见性,
4089
+ 全部可见-"all",
4090
+ 部分可见-"part"
4033
4091
  */
4034
4092
  AuthTag?: string
4093
+ /**
4094
+ * 当OperateType=UPADATE时,可以通过设置此字段对模板启停用状态进行操作。
4095
+ 若此字段值为0,则不会修改模板Available,
4096
+ 1为启用模板,
4097
+ 2为停用模板。
4098
+ 启用后模板可以正常领取。停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败,会直接返回错误。
4099
+ */
4100
+ Available?: number
4035
4101
  /**
4036
4102
  * 暂未开放
4037
4103
  * @deprecated
4038
4104
  */
4039
4105
  Operator?: UserInfo
4040
- /**
4041
- * 当OperateType=UPADATE时,可以通过设置此字段对模板启停用状态进行操作。若此字段值为0,则不会修改模板Available,1为启用模板,2为停用模板。
4042
- 启用后模板可以正常领取。停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。如果Available更新失败,会直接返回错误。
4043
- */
4044
- Available?: number
4045
4106
  }
4046
4107
 
4047
4108
  /**
@@ -85,8 +85,18 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
85
85
  */
86
86
  ChannelDeleteRoleUsers(req: ChannelDeleteRoleUsersRequest, cb?: (error: string, rep: ChannelDeleteRoleUsersResponse) => void): Promise<ChannelDeleteRoleUsersResponse>;
87
87
  /**
88
- * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
89
- */
88
+ * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
89
+
90
+ > **适用场景**
91
+ >
92
+ > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
93
+ > 一个模板通常会包含以下结构信息
94
+ >- 模板基本信息
95
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
96
+ >- 填写控件 Components
97
+ >- 签署控件 SignComponents
98
+ >- 生成模板的文件基础信息 FileInfos
99
+ */
90
100
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
91
101
  /**
92
102
  * 创建跳转小程序查看或签署的链接。
@@ -146,8 +156,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
146
156
  */
147
157
  ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
148
158
  /**
149
- * 通过发起转换任务接口(ChannelCreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
150
- */
159
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
160
+ 注意:大文件转换所需的时间可能会比较长。
161
+ */
151
162
  ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
152
163
  /**
153
164
  * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
@@ -136,8 +136,18 @@ class Client extends TencentCloudCommon.AbstractClient {
136
136
  return this.request("ChannelDeleteRoleUsers", req, cb);
137
137
  }
138
138
  /**
139
- * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
140
- */
139
+ * 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
140
+
141
+ > **适用场景**
142
+ >
143
+ > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
144
+ > 一个模板通常会包含以下结构信息
145
+ >- 模板基本信息
146
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
147
+ >- 填写控件 Components
148
+ >- 签署控件 SignComponents
149
+ >- 生成模板的文件基础信息 FileInfos
150
+ */
141
151
  async DescribeTemplates(req, cb) {
142
152
  return this.request("DescribeTemplates", req, cb);
143
153
  }
@@ -209,8 +219,9 @@ class Client extends TencentCloudCommon.AbstractClient {
209
219
  return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
210
220
  }
211
221
  /**
212
- * 通过发起转换任务接口(ChannelCreateConvertTaskApi)返回的任务Id查询转换任务状态,通过本接口确认转换任务是否完成。大文件转换所需的时间可能会比较长。
213
- */
222
+ * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
223
+ 注意:大文件转换所需的时间可能会比较长。
224
+ */
214
225
  async ChannelGetTaskResultApi(req, cb) {
215
226
  return this.request("ChannelGetTaskResultApi", req, cb);
216
227
  }