tencentcloud-sdk-nodejs-essbasic 4.0.794 → 4.0.796

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.794",
3
+ "version": "4.0.796",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -48,7 +48,7 @@
48
48
  | cdwdoris | [腾讯云数据仓库 TCHouse-D](https://cloud.tencent.com/document/product/1387) | 2024-01-24 01:23:33 |
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) | 2024-01-19 01:08:39 |
51
- | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2024-01-23 01:11:18 |
51
+ | cfs | [文件存储](https://cloud.tencent.com/document/product/582) | 2024-02-21 01:09:59 |
52
52
  | cfw | [云防火墙](https://cloud.tencent.com/document/product/1132) | 2024-01-23 14:38:08 |
53
53
  | chdfs | [云 HDFS](https://cloud.tencent.com/document/product/1105) | 2023-08-17 01:47:49 |
54
54
  | ciam | [账号风控平台](https://cloud.tencent.com/document/product/1441) | 2023-07-06 01:13:25 |
@@ -72,7 +72,7 @@
72
72
  | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-02-04 11:05:24 |
73
73
  | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-02-02 01:09:36 |
74
74
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
75
- | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-02-02 01:10:38 |
75
+ | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-02-21 01:12:48 |
76
76
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2024-01-24 01:26:26 |
77
77
  | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 |
78
78
  | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 |
@@ -80,8 +80,8 @@
80
80
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-08-22 01:11:33 |
81
81
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2024-01-11 01:12:33 |
82
82
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-10-30 00:33:47 |
83
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2024-01-29 01:11:58 |
84
- | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2024-01-10 01:13:10 |
83
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2024-02-21 01:13:43 |
84
+ | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2024-02-21 01:14:01 |
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 |
@@ -91,15 +91,15 @@
91
91
  | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2024-01-17 01:14:14 |
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
- | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-12-20 01:36:00 |
94
+ | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2024-02-21 01:14:56 |
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) | 2024-02-02 01:13:14 |
97
+ | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2024-02-21 01:15:23 |
98
98
  | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2024-01-25 01:13:20 |
99
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-02-05 01:14:36 |
100
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-02-05 01:14:50 |
99
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2024-02-21 01:15:40 |
100
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2024-02-21 01:15:57 |
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) | 2024-01-12 01:15:37 |
102
+ | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2024-02-20 01:16:27 |
103
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 |
@@ -154,7 +154,7 @@
154
154
  | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-15 02:14:19 |
155
155
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
156
156
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2024-01-19 01:18:01 |
157
- | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-02-05 01:19:36 |
157
+ | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-02-21 01:20:39 |
158
158
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2024-01-05 01:21:57 |
159
159
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2024-01-17 01:19:45 |
160
160
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2024-01-23 01:25:29 |
@@ -162,7 +162,7 @@
162
162
  | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2024-01-24 01:33:35 |
163
163
  | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2024-01-19 01:18:43 |
164
164
  | pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2023-12-12 02:16:34 |
165
- | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2024-02-05 01:20:26 |
165
+ | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2024-02-19 10:35:18 |
166
166
  | redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2024-01-29 01:18:51 |
167
167
  | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2023-10-13 01:22:28 |
168
168
  | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-12-25 00:16:39 |
@@ -180,7 +180,7 @@
180
180
  | ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2023-11-15 02:18:28 |
181
181
  | ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-02-02 01:20:24 |
182
182
  | sslpod | [证书监控 SSLPod](https://cloud.tencent.com/document/product/1084) | 2023-08-17 04:46:28 |
183
- | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2023-12-28 01:23:11 |
183
+ | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2024-02-21 01:22:44 |
184
184
  | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2024-01-17 01:21:44 |
185
185
  | svp | [节省计划](https://cloud.tencent.com/document/product/1761) | 2024-01-26 16:30:56 |
186
186
  | taf | [流量反欺诈](https://cloud.tencent.com/document/product/1031) | 2024-02-05 01:21:52 |
@@ -198,7 +198,7 @@
198
198
  | tchd | [腾讯云健康看板](https://cloud.tencent.com/document/product/1688) | 2023-11-28 01:24:39 |
199
199
  | tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 |
200
200
  | tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2023-10-09 01:23:14 |
201
- | tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2023-12-12 02:27:39 |
201
+ | tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2024-02-19 10:37:21 |
202
202
  | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2024-02-02 01:21:42 |
203
203
  | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 |
204
204
  | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2024-01-23 01:28:41 |
@@ -206,7 +206,7 @@
206
206
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-11-15 02:26:59 |
207
207
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-12-20 02:13:36 |
208
208
  | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-01-30 01:24:01 |
209
- | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-11-27 00:20:12 |
209
+ | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2024-02-21 01:25:12 |
210
210
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
211
211
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
212
212
  | ticm | [智能鉴黄](https://cloud.tencent.com/document/product/864) | 2021-01-07 08:08:15 |
@@ -18,7 +18,6 @@
18
18
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
19
19
  import {
20
20
  SyncProxyOrganizationResponse,
21
- BillUsageDetail,
22
21
  ChannelCreateConvertTaskApiResponse,
23
22
  ChannelCreateFlowRemindsResponse,
24
23
  Component,
@@ -130,7 +129,6 @@ import {
130
129
  ChannelDeleteRoleUsersResponse,
131
130
  SyncProxyOrganizationOperatorsRequest,
132
131
  ChannelCreateFlowApproversResponse,
133
- DescribeBillUsageDetailResponse,
134
132
  DescribeUsageResponse,
135
133
  CreateSignUrlsRequest,
136
134
  RegistrationOrganizationInfo,
@@ -199,7 +197,7 @@ import {
199
197
  SignUrl,
200
198
  CreateFlowGroupSignReviewRequest,
201
199
  ChannelBillUsageDetail,
202
- DescribeBillUsageDetailRequest,
200
+ DescribeTemplatesRequest,
203
201
  RelieveInfo,
204
202
  ChannelCreateSealPolicyRequest,
205
203
  OccupiedSeal,
@@ -222,7 +220,6 @@ import {
222
220
  ChannelCreateFlowApproversRequest,
223
221
  ChannelUpdateSealStatusResponse,
224
222
  ChannelCreateFlowSignUrlRequest,
225
- DescribeTemplatesRequest,
226
223
  DescribeExtendedServiceAuthInfoResponse,
227
224
  ChannelCreateEmbedWebUrlRequest,
228
225
  CcInfo,
@@ -678,8 +675,8 @@ export class Client extends TencentCloudCommon.AbstractClient {
678
675
  </tbody>
679
676
  </table>
680
677
 
681
- ### 三. 填充模版中定义的填写控件
682
- 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
678
+ ### 三. 填充模板中定义的填写控件
679
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
683
680
 
684
681
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
685
682
  填充的传参示例如下
@@ -869,7 +866,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
869
866
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
870
867
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
871
868
 
872
- **主要使用场景可以更加EndPoint分类如下**
869
+ **主要使用场景EndPoint分类**
873
870
 
874
871
  |EndPoint| 场景| 说明和示例|
875
872
  | ---- | ---- | --- |
@@ -1562,11 +1559,12 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1562
1559
  }
1563
1560
 
1564
1561
  /**
1565
- * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
1562
+ * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。
1563
+ 子客Web控制台的组织架构管理,依赖于第三方应用平台的,无法在页面针对员工做新增/更新/离职等操作, 必须通过 API 来操作。
1566
1564
 
1567
- - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
1565
+ - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
1568
1566
 
1569
- - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
1567
+ - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
1570
1568
 
1571
1569
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
1572
1570
 
@@ -1636,18 +1634,6 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1636
1634
  return this.request("ChannelCreatePreparedPersonalEsign", req, cb)
1637
1635
  }
1638
1636
 
1639
- /**
1640
- * 废弃接口
1641
-
1642
- 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1643
- */
1644
- async DescribeBillUsageDetail(
1645
- req: DescribeBillUsageDetailRequest,
1646
- cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void
1647
- ): Promise<DescribeBillUsageDetailResponse> {
1648
- return this.request("DescribeBillUsageDetail", req, cb)
1649
- }
1650
-
1651
1637
  /**
1652
1638
  * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
1653
1639
 
@@ -25,98 +25,6 @@ export interface SyncProxyOrganizationResponse {
25
25
  RequestId?: string
26
26
  }
27
27
 
28
- /**
29
- * 用户计费使用情况详情
30
- */
31
- export interface BillUsageDetail {
32
- /**
33
- * 合同流程ID,为32位字符串。
34
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
35
- 注意:此字段可能返回 null,表示取不到有效值。
36
- */
37
- FlowId?: string
38
- /**
39
- * 合同经办人名称
40
- 如果有多个经办人用分号隔开。
41
- 注意:此字段可能返回 null,表示取不到有效值。
42
- */
43
- OperatorName?: string
44
- /**
45
- * 发起方组织机构名称
46
- 注意:此字段可能返回 null,表示取不到有效值。
47
- */
48
- CreateOrganizationName?: string
49
- /**
50
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
51
- 该名称还将用于合同签署完成后的下载文件名。
52
- 注意:此字段可能返回 null,表示取不到有效值。
53
- */
54
- FlowName?: string
55
- /**
56
- * 当前合同状态,如下是状态码对应的状态。
57
- 0-还没有发起
58
- 1-等待签署
59
- 2-部分签署
60
- 3-拒签
61
- 4-已签署
62
- 5-已过期
63
- 6-已撤销
64
- 7-还没有预发起
65
- 8-等待填写
66
- 9-部分填写
67
- 10-拒填
68
- 11-已解除
69
- 注意:此字段可能返回 null,表示取不到有效值。
70
- */
71
- Status?: number
72
- /**
73
- * 套餐类型
74
- 对应关系如下
75
- CloudEnterprise-企业版合同
76
- SingleSignature-单方签章
77
- CloudProve-签署报告
78
- CloudOnlineSign-腾讯会议在线签约
79
- ChannelWeCard-微工卡
80
- SignFlow-合同套餐
81
- SignFace-签署意愿(人脸识别)
82
- SignPassword-签署意愿(密码)
83
- SignSMS-签署意愿(短信)
84
- PersonalEssAuth-签署人实名(腾讯电子签认证)
85
- PersonalThirdAuth-签署人实名(信任第三方认证)
86
- OrgEssAuth-签署企业实名
87
- FlowNotify-短信通知
88
- AuthService-企业工商信息查询
89
- 注意:此字段可能返回 null,表示取不到有效值。
90
- */
91
- QuotaType?: string
92
- /**
93
- * 合同使用量
94
- 注意:此字段可能返回 null,表示取不到有效值。
95
- */
96
- UseCount?: number
97
- /**
98
- * 消耗的时间戳,格式为Unix标准时间戳(秒)。
99
- 注意:此字段可能返回 null,表示取不到有效值。
100
- */
101
- CostTime?: number
102
- /**
103
- * 消耗的套餐名称
104
- 注意:此字段可能返回 null,表示取不到有效值。
105
- */
106
- QuotaName?: string
107
- /**
108
- * 消耗类型
109
- 1.扣费 2.撤销返还
110
- 注意:此字段可能返回 null,表示取不到有效值。
111
- */
112
- CostType?: number
113
- /**
114
- * 备注
115
- 注意:此字段可能返回 null,表示取不到有效值。
116
- */
117
- Remark?: string
118
- }
119
-
120
28
  /**
121
29
  * ChannelCreateConvertTaskApi返回参数结构体
122
30
  */
@@ -1806,7 +1714,11 @@ export interface ChannelCreateWebThemeConfigRequest {
1806
1714
  Agent: Agent
1807
1715
  /**
1808
1716
  * 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
1809
- <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
1717
+ <ul>
1718
+ <li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
1719
+ <li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
1720
+ 目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
1721
+ </ul>
1810
1722
  */
1811
1723
  ThemeType: string
1812
1724
  /**
@@ -2302,7 +2214,7 @@ export interface ChannelCreateFlowByFilesResponse {
2302
2214
  * 合同流程ID,为32位字符串。
2303
2215
  建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2304
2216
 
2305
- [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2217
+ [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2306
2218
  注意:此字段可能返回 null,表示取不到有效值。
2307
2219
  */
2308
2220
  FlowId?: string
@@ -4488,24 +4400,6 @@ export interface ChannelCreateFlowApproversResponse {
4488
4400
  RequestId?: string
4489
4401
  }
4490
4402
 
4491
- /**
4492
- * DescribeBillUsageDetail返回参数结构体
4493
- */
4494
- export interface DescribeBillUsageDetailResponse {
4495
- /**
4496
- * 返回查询记录总数
4497
- */
4498
- Total?: number
4499
- /**
4500
- * 消耗记录详情
4501
- */
4502
- Details?: Array<BillUsageDetail>
4503
- /**
4504
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4505
- */
4506
- RequestId?: string
4507
- }
4508
-
4509
4403
  /**
4510
4404
  * DescribeUsage返回参数结构体
4511
4405
  */
@@ -4560,7 +4454,8 @@ export interface CreateSignUrlsRequest {
4560
4454
 
4561
4455
  **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
4562
4456
 
4563
- 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
4457
+ 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
4458
+
4564
4459
  */
4565
4460
  Endpoint?: string
4566
4461
  /**
@@ -6042,7 +5937,7 @@ export interface ChannelCreateReleaseFlowRequest {
6042
5937
  * 待解除的签署流程编号(即原签署流程的编号)。
6043
5938
 
6044
5939
 
6045
- [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
5940
+ [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
6046
5941
  */
6047
5942
  NeedRelievedFlowId: string
6048
5943
  /**
@@ -6887,48 +6782,103 @@ export interface ChannelBillUsageDetail {
6887
6782
  }
6888
6783
 
6889
6784
  /**
6890
- * DescribeBillUsageDetail请求参数结构体
6785
+ * DescribeTemplates请求参数结构体
6891
6786
  */
6892
- export interface DescribeBillUsageDetailRequest {
6787
+ export interface DescribeTemplatesRequest {
6893
6788
  /**
6894
6789
  * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6790
+
6791
+ 此接口下面信息必填。
6792
+ <ul>
6793
+ <li>渠道应用标识: Agent.AppId</li>
6794
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6795
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6796
+ </ul>
6797
+ 第三方平台子客企业和员工必须已经经过实名认证
6895
6798
  */
6896
6799
  Agent: Agent
6897
6800
  /**
6898
- * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6801
+ * 合同模板ID,为32位字符串。
6802
+
6803
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
6804
+
6805
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6899
6806
  */
6900
- StartTime: string
6807
+ TemplateId?: string
6901
6808
  /**
6902
- * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6809
+ * 查询模板的内容
6810
+
6811
+ <ul><li>**0**:(默认)模板列表及详情</li>
6812
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
6903
6813
  */
6904
- EndTime: string
6814
+ ContentType?: number
6905
6815
  /**
6906
- * 查询的套餐类型 (选填 )不传则查询所有套餐;
6907
- 对应关系如下
6908
- CloudEnterprise-企业版合同
6909
- SingleSignature-单方签章
6910
- CloudProve-签署报告
6911
- CloudOnlineSign-腾讯会议在线签约
6912
- ChannelWeCard-微工卡
6913
- SignFlow-合同套餐
6914
- SignFace-签署意愿(人脸识别)
6915
- SignPassword-签署意愿(密码)
6916
- SignSMS-签署意愿(短信)
6917
- PersonalEssAuth-签署人实名(腾讯电子签认证)
6918
- PersonalThirdAuth-签署人实名(信任第三方认证)
6919
- OrgEssAuth-签署企业实名
6920
- FlowNotify-短信通知
6921
- AuthService-企业工商信息查询
6816
+ * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
6817
+
6818
+ 注意:
6819
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
6820
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
6821
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
6822
+
6823
+
6824
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6825
+
6922
6826
  */
6923
- QuotaType?: string
6827
+ TemplateIds?: Array<string>
6924
6828
  /**
6925
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
6829
+ * 指定每页返回的数据条数,和Offset参数配合使用。
6830
+
6831
+ 注:`1.默认值为20,单页做大值为200。`
6832
+ */
6833
+ Limit?: number
6834
+ /**
6835
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
6836
+
6837
+ 注:`1.offset从0开始,即第一页为0。`
6838
+ `2.默认从第一页返回。`
6926
6839
  */
6927
6840
  Offset?: number
6928
6841
  /**
6929
- * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
6842
+ * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
6930
6843
  */
6931
- Limit?: number
6844
+ TemplateName?: string
6845
+ /**
6846
+ * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
6847
+ */
6848
+ ChannelTemplateId?: string
6849
+ /**
6850
+ * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
6851
+
6852
+ <ul><li>**false**:(默认)只返回发起方控件</li>
6853
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
6854
+ */
6855
+ QueryAllComponents?: boolean
6856
+ /**
6857
+ * 是否获取模板预览链接。
6858
+
6859
+ <ul><li>**false**:不获取(默认)</li>
6860
+ <li>**true**:获取</li></ul>
6861
+
6862
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
6863
+
6864
+ */
6865
+ WithPreviewUrl?: boolean
6866
+ /**
6867
+ * 是否获取模板的PDF文件链接。
6868
+
6869
+ <ul><li>**false**:不获取(默认)</li>
6870
+ <li>**true**:获取</li></ul>
6871
+
6872
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
6873
+
6874
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
6875
+ */
6876
+ WithPdfUrl?: boolean
6877
+ /**
6878
+ * 操作者的信息
6879
+ * @deprecated
6880
+ */
6881
+ Operator?: UserInfo
6932
6882
  }
6933
6883
 
6934
6884
  /**
@@ -7630,106 +7580,6 @@ export interface ChannelCreateFlowSignUrlRequest {
7630
7580
  UrlType?: number
7631
7581
  }
7632
7582
 
7633
- /**
7634
- * DescribeTemplates请求参数结构体
7635
- */
7636
- export interface DescribeTemplatesRequest {
7637
- /**
7638
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7639
-
7640
- 此接口下面信息必填。
7641
- <ul>
7642
- <li>渠道应用标识: Agent.AppId</li>
7643
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7644
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7645
- </ul>
7646
- 第三方平台子客企业和员工必须已经经过实名认证
7647
- */
7648
- Agent: Agent
7649
- /**
7650
- * 合同模板ID,为32位字符串。
7651
-
7652
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
7653
-
7654
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7655
- */
7656
- TemplateId?: string
7657
- /**
7658
- * 查询模板的内容
7659
-
7660
- <ul><li>**0**:(默认)模板列表及详情</li>
7661
- <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
7662
- */
7663
- ContentType?: number
7664
- /**
7665
- * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
7666
-
7667
- 注意:
7668
- 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
7669
- 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
7670
- 4. `若传递此参数,分页参数(Limit,Offset)无效`
7671
-
7672
-
7673
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7674
-
7675
- */
7676
- TemplateIds?: Array<string>
7677
- /**
7678
- * 指定每页返回的数据条数,和Offset参数配合使用。
7679
-
7680
- 注:`1.默认值为20,单页做大值为200。`
7681
- */
7682
- Limit?: number
7683
- /**
7684
- * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
7685
-
7686
- 注:`1.offset从0开始,即第一页为0。`
7687
- `2.默认从第一页返回。`
7688
- */
7689
- Offset?: number
7690
- /**
7691
- * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
7692
- */
7693
- TemplateName?: string
7694
- /**
7695
- * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
7696
- */
7697
- ChannelTemplateId?: string
7698
- /**
7699
- * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
7700
-
7701
- <ul><li>**false**:(默认)只返回发起方控件</li>
7702
- <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
7703
- */
7704
- QueryAllComponents?: boolean
7705
- /**
7706
- * 是否获取模板预览链接。
7707
-
7708
- <ul><li>**false**:不获取(默认)</li>
7709
- <li>**true**:获取</li></ul>
7710
-
7711
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
7712
-
7713
- */
7714
- WithPreviewUrl?: boolean
7715
- /**
7716
- * 是否获取模板的PDF文件链接。
7717
-
7718
- <ul><li>**false**:不获取(默认)</li>
7719
- <li>**true**:获取</li></ul>
7720
-
7721
- 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
7722
-
7723
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
7724
- */
7725
- WithPdfUrl?: boolean
7726
- /**
7727
- * 操作者的信息
7728
- * @deprecated
7729
- */
7730
- Operator?: UserInfo
7731
- }
7732
-
7733
7583
  /**
7734
7584
  * DescribeExtendedServiceAuthInfo返回参数结构体
7735
7585
  */
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ModifyFlowDeadlineResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeTemplatesRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
2
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, DescribeExtendedServiceAuthDetailResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, CreateFlowGroupSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, DescribeBatchOrganizationRegistrationUrlsRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, CreateBatchOrganizationRegistrationTasksResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeExtendedServiceAuthDetailRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, DescribeChannelSealPolicyWorkflowUrlRequest, CreatePartnerAutoSignAuthUrlResponse, ModifyFlowDeadlineResponse, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeUsageResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, DescribeChannelOrganizationsRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, CreateBatchOrganizationRegistrationTasksRequest, ChannelCreateBatchQuickSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ModifyFlowDeadlineRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, CreateFlowGroupSignReviewRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, DescribeBatchOrganizationRegistrationUrlsResponse, UploadFilesRequest, DescribeChannelOrganizationsResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, DescribeChannelSealPolicyWorkflowUrlResponse, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
3
  /**
4
4
  * essbasic client
5
5
  * @class
@@ -332,8 +332,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
332
332
  </tbody>
333
333
  </table>
334
334
 
335
- ### 三. 填充模版中定义的填写控件
336
- 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
335
+ ### 三. 填充模板中定义的填写控件
336
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
337
337
 
338
338
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
339
339
  填充的传参示例如下
@@ -481,7 +481,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
481
481
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
482
482
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
483
483
 
484
- **主要使用场景可以更加EndPoint分类如下**
484
+ **主要使用场景EndPoint分类**
485
485
 
486
486
  |EndPoint| 场景| 说明和示例|
487
487
  | ---- | ---- | --- |
@@ -970,11 +970,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
970
970
  */
971
971
  CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
972
972
  /**
973
- * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
973
+ * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。
974
+ 子客Web控制台的组织架构管理,依赖于第三方应用平台的,无法在页面针对员工做新增/更新/离职等操作, 必须通过 API 来操作。
974
975
 
975
- - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
976
+ - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
976
977
 
977
- - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
978
+ - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
978
979
 
979
980
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
980
981
 
@@ -1020,12 +1021,6 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1020
1021
  * 本接口(ChannelCreatePreparedPersonalEsign)用于创建导入个人印章(处方单场景专用,使用此接口请与客户经理确认)。
1021
1022
  */
1022
1023
  ChannelCreatePreparedPersonalEsign(req: ChannelCreatePreparedPersonalEsignRequest, cb?: (error: string, rep: ChannelCreatePreparedPersonalEsignResponse) => void): Promise<ChannelCreatePreparedPersonalEsignResponse>;
1023
- /**
1024
- * 废弃接口
1025
-
1026
- 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1027
- */
1028
- DescribeBillUsageDetail(req: DescribeBillUsageDetailRequest, cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void): Promise<DescribeBillUsageDetailResponse>;
1029
1024
  /**
1030
1025
  * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
1031
1026
 
@@ -391,8 +391,8 @@ class Client extends TencentCloudCommon.AbstractClient {
391
391
  </tbody>
392
392
  </table>
393
393
 
394
- ### 三. 填充模版中定义的填写控件
395
- 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
394
+ ### 三. 填充模板中定义的填写控件
395
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
396
396
 
397
397
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
398
398
  填充的传参示例如下
@@ -554,7 +554,7 @@ class Client extends TencentCloudCommon.AbstractClient {
554
554
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
555
555
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
556
556
 
557
- **主要使用场景可以更加EndPoint分类如下**
557
+ **主要使用场景EndPoint分类**
558
558
 
559
559
  |EndPoint| 场景| 说明和示例|
560
560
  | ---- | ---- | --- |
@@ -1111,11 +1111,12 @@ class Client extends TencentCloudCommon.AbstractClient {
1111
1111
  return this.request("CreateChannelOrganizationInfoChangeUrl", req, cb);
1112
1112
  }
1113
1113
  /**
1114
- * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
1114
+ * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。
1115
+ 子客Web控制台的组织架构管理,依赖于第三方应用平台的,无法在页面针对员工做新增/更新/离职等操作, 必须通过 API 来操作。
1115
1116
 
1116
- - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
1117
+ - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
1117
1118
 
1118
- - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
1119
+ - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
1119
1120
 
1120
1121
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
1121
1122
 
@@ -1169,14 +1170,6 @@ class Client extends TencentCloudCommon.AbstractClient {
1169
1170
  async ChannelCreatePreparedPersonalEsign(req, cb) {
1170
1171
  return this.request("ChannelCreatePreparedPersonalEsign", req, cb);
1171
1172
  }
1172
- /**
1173
- * 废弃接口
1174
-
1175
- 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1176
- */
1177
- async DescribeBillUsageDetail(req, cb) {
1178
- return this.request("DescribeBillUsageDetail", req, cb);
1179
- }
1180
1173
  /**
1181
1174
  * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
1182
1175
 
@@ -7,97 +7,6 @@ export interface SyncProxyOrganizationResponse {
7
7
  */
8
8
  RequestId?: string;
9
9
  }
10
- /**
11
- * 用户计费使用情况详情
12
- */
13
- export interface BillUsageDetail {
14
- /**
15
- * 合同流程ID,为32位字符串。
16
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
17
- 注意:此字段可能返回 null,表示取不到有效值。
18
- */
19
- FlowId?: string;
20
- /**
21
- * 合同经办人名称
22
- 如果有多个经办人用分号隔开。
23
- 注意:此字段可能返回 null,表示取不到有效值。
24
- */
25
- OperatorName?: string;
26
- /**
27
- * 发起方组织机构名称
28
- 注意:此字段可能返回 null,表示取不到有效值。
29
- */
30
- CreateOrganizationName?: string;
31
- /**
32
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
33
- 该名称还将用于合同签署完成后的下载文件名。
34
- 注意:此字段可能返回 null,表示取不到有效值。
35
- */
36
- FlowName?: string;
37
- /**
38
- * 当前合同状态,如下是状态码对应的状态。
39
- 0-还没有发起
40
- 1-等待签署
41
- 2-部分签署
42
- 3-拒签
43
- 4-已签署
44
- 5-已过期
45
- 6-已撤销
46
- 7-还没有预发起
47
- 8-等待填写
48
- 9-部分填写
49
- 10-拒填
50
- 11-已解除
51
- 注意:此字段可能返回 null,表示取不到有效值。
52
- */
53
- Status?: number;
54
- /**
55
- * 套餐类型
56
- 对应关系如下
57
- CloudEnterprise-企业版合同
58
- SingleSignature-单方签章
59
- CloudProve-签署报告
60
- CloudOnlineSign-腾讯会议在线签约
61
- ChannelWeCard-微工卡
62
- SignFlow-合同套餐
63
- SignFace-签署意愿(人脸识别)
64
- SignPassword-签署意愿(密码)
65
- SignSMS-签署意愿(短信)
66
- PersonalEssAuth-签署人实名(腾讯电子签认证)
67
- PersonalThirdAuth-签署人实名(信任第三方认证)
68
- OrgEssAuth-签署企业实名
69
- FlowNotify-短信通知
70
- AuthService-企业工商信息查询
71
- 注意:此字段可能返回 null,表示取不到有效值。
72
- */
73
- QuotaType?: string;
74
- /**
75
- * 合同使用量
76
- 注意:此字段可能返回 null,表示取不到有效值。
77
- */
78
- UseCount?: number;
79
- /**
80
- * 消耗的时间戳,格式为Unix标准时间戳(秒)。
81
- 注意:此字段可能返回 null,表示取不到有效值。
82
- */
83
- CostTime?: number;
84
- /**
85
- * 消耗的套餐名称
86
- 注意:此字段可能返回 null,表示取不到有效值。
87
- */
88
- QuotaName?: string;
89
- /**
90
- * 消耗类型
91
- 1.扣费 2.撤销返还
92
- 注意:此字段可能返回 null,表示取不到有效值。
93
- */
94
- CostType?: number;
95
- /**
96
- * 备注
97
- 注意:此字段可能返回 null,表示取不到有效值。
98
- */
99
- Remark?: string;
100
- }
101
10
  /**
102
11
  * ChannelCreateConvertTaskApi返回参数结构体
103
12
  */
@@ -1746,7 +1655,11 @@ export interface ChannelCreateWebThemeConfigRequest {
1746
1655
  Agent: Agent;
1747
1656
  /**
1748
1657
  * 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
1749
- <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
1658
+ <ul>
1659
+ <li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
1660
+ <li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
1661
+ 目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
1662
+ </ul>
1750
1663
  */
1751
1664
  ThemeType: string;
1752
1665
  /**
@@ -2230,7 +2143,7 @@ export interface ChannelCreateFlowByFilesResponse {
2230
2143
  * 合同流程ID,为32位字符串。
2231
2144
  建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2232
2145
 
2233
- [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2146
+ [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2234
2147
  注意:此字段可能返回 null,表示取不到有效值。
2235
2148
  */
2236
2149
  FlowId?: string;
@@ -4358,23 +4271,6 @@ export interface ChannelCreateFlowApproversResponse {
4358
4271
  */
4359
4272
  RequestId?: string;
4360
4273
  }
4361
- /**
4362
- * DescribeBillUsageDetail返回参数结构体
4363
- */
4364
- export interface DescribeBillUsageDetailResponse {
4365
- /**
4366
- * 返回查询记录总数
4367
- */
4368
- Total?: number;
4369
- /**
4370
- * 消耗记录详情
4371
- */
4372
- Details?: Array<BillUsageDetail>;
4373
- /**
4374
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4375
- */
4376
- RequestId?: string;
4377
- }
4378
4274
  /**
4379
4275
  * DescribeUsage返回参数结构体
4380
4276
  */
@@ -4428,7 +4324,8 @@ export interface CreateSignUrlsRequest {
4428
4324
 
4429
4325
  **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
4430
4326
 
4431
- 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
4327
+ 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
4328
+
4432
4329
  */
4433
4330
  Endpoint?: string;
4434
4331
  /**
@@ -5869,7 +5766,7 @@ export interface ChannelCreateReleaseFlowRequest {
5869
5766
  * 待解除的签署流程编号(即原签署流程的编号)。
5870
5767
 
5871
5768
 
5872
- [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
5769
+ [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
5873
5770
  */
5874
5771
  NeedRelievedFlowId: string;
5875
5772
  /**
@@ -6688,48 +6585,103 @@ export interface ChannelBillUsageDetail {
6688
6585
  Remark?: string;
6689
6586
  }
6690
6587
  /**
6691
- * DescribeBillUsageDetail请求参数结构体
6588
+ * DescribeTemplates请求参数结构体
6692
6589
  */
6693
- export interface DescribeBillUsageDetailRequest {
6590
+ export interface DescribeTemplatesRequest {
6694
6591
  /**
6695
6592
  * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6593
+
6594
+ 此接口下面信息必填。
6595
+ <ul>
6596
+ <li>渠道应用标识: Agent.AppId</li>
6597
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6598
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6599
+ </ul>
6600
+ 第三方平台子客企业和员工必须已经经过实名认证
6696
6601
  */
6697
6602
  Agent: Agent;
6698
6603
  /**
6699
- * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6604
+ * 合同模板ID,为32位字符串。
6605
+
6606
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
6607
+
6608
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6700
6609
  */
6701
- StartTime: string;
6610
+ TemplateId?: string;
6702
6611
  /**
6703
- * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6612
+ * 查询模板的内容
6613
+
6614
+ <ul><li>**0**:(默认)模板列表及详情</li>
6615
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
6704
6616
  */
6705
- EndTime: string;
6617
+ ContentType?: number;
6706
6618
  /**
6707
- * 查询的套餐类型 (选填 )不传则查询所有套餐;
6708
- 对应关系如下
6709
- CloudEnterprise-企业版合同
6710
- SingleSignature-单方签章
6711
- CloudProve-签署报告
6712
- CloudOnlineSign-腾讯会议在线签约
6713
- ChannelWeCard-微工卡
6714
- SignFlow-合同套餐
6715
- SignFace-签署意愿(人脸识别)
6716
- SignPassword-签署意愿(密码)
6717
- SignSMS-签署意愿(短信)
6718
- PersonalEssAuth-签署人实名(腾讯电子签认证)
6719
- PersonalThirdAuth-签署人实名(信任第三方认证)
6720
- OrgEssAuth-签署企业实名
6721
- FlowNotify-短信通知
6722
- AuthService-企业工商信息查询
6619
+ * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
6620
+
6621
+ 注意:
6622
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
6623
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
6624
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
6625
+
6626
+
6627
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6628
+
6723
6629
  */
6724
- QuotaType?: string;
6630
+ TemplateIds?: Array<string>;
6725
6631
  /**
6726
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
6632
+ * 指定每页返回的数据条数,和Offset参数配合使用。
6633
+
6634
+ 注:`1.默认值为20,单页做大值为200。`
6635
+ */
6636
+ Limit?: number;
6637
+ /**
6638
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
6639
+
6640
+ 注:`1.offset从0开始,即第一页为0。`
6641
+ `2.默认从第一页返回。`
6727
6642
  */
6728
6643
  Offset?: number;
6729
6644
  /**
6730
- * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
6645
+ * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
6731
6646
  */
6732
- Limit?: number;
6647
+ TemplateName?: string;
6648
+ /**
6649
+ * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
6650
+ */
6651
+ ChannelTemplateId?: string;
6652
+ /**
6653
+ * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
6654
+
6655
+ <ul><li>**false**:(默认)只返回发起方控件</li>
6656
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
6657
+ */
6658
+ QueryAllComponents?: boolean;
6659
+ /**
6660
+ * 是否获取模板预览链接。
6661
+
6662
+ <ul><li>**false**:不获取(默认)</li>
6663
+ <li>**true**:获取</li></ul>
6664
+
6665
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
6666
+
6667
+ */
6668
+ WithPreviewUrl?: boolean;
6669
+ /**
6670
+ * 是否获取模板的PDF文件链接。
6671
+
6672
+ <ul><li>**false**:不获取(默认)</li>
6673
+ <li>**true**:获取</li></ul>
6674
+
6675
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
6676
+
6677
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
6678
+ */
6679
+ WithPdfUrl?: boolean;
6680
+ /**
6681
+ * 操作者的信息
6682
+ * @deprecated
6683
+ */
6684
+ Operator?: UserInfo;
6733
6685
  }
6734
6686
  /**
6735
6687
  * 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
@@ -7408,105 +7360,6 @@ export interface ChannelCreateFlowSignUrlRequest {
7408
7360
  */
7409
7361
  UrlType?: number;
7410
7362
  }
7411
- /**
7412
- * DescribeTemplates请求参数结构体
7413
- */
7414
- export interface DescribeTemplatesRequest {
7415
- /**
7416
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7417
-
7418
- 此接口下面信息必填。
7419
- <ul>
7420
- <li>渠道应用标识: Agent.AppId</li>
7421
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7422
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7423
- </ul>
7424
- 第三方平台子客企业和员工必须已经经过实名认证
7425
- */
7426
- Agent: Agent;
7427
- /**
7428
- * 合同模板ID,为32位字符串。
7429
-
7430
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
7431
-
7432
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7433
- */
7434
- TemplateId?: string;
7435
- /**
7436
- * 查询模板的内容
7437
-
7438
- <ul><li>**0**:(默认)模板列表及详情</li>
7439
- <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
7440
- */
7441
- ContentType?: number;
7442
- /**
7443
- * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
7444
-
7445
- 注意:
7446
- 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
7447
- 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
7448
- 4. `若传递此参数,分页参数(Limit,Offset)无效`
7449
-
7450
-
7451
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7452
-
7453
- */
7454
- TemplateIds?: Array<string>;
7455
- /**
7456
- * 指定每页返回的数据条数,和Offset参数配合使用。
7457
-
7458
- 注:`1.默认值为20,单页做大值为200。`
7459
- */
7460
- Limit?: number;
7461
- /**
7462
- * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
7463
-
7464
- 注:`1.offset从0开始,即第一页为0。`
7465
- `2.默认从第一页返回。`
7466
- */
7467
- Offset?: number;
7468
- /**
7469
- * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
7470
- */
7471
- TemplateName?: string;
7472
- /**
7473
- * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
7474
- */
7475
- ChannelTemplateId?: string;
7476
- /**
7477
- * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
7478
-
7479
- <ul><li>**false**:(默认)只返回发起方控件</li>
7480
- <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
7481
- */
7482
- QueryAllComponents?: boolean;
7483
- /**
7484
- * 是否获取模板预览链接。
7485
-
7486
- <ul><li>**false**:不获取(默认)</li>
7487
- <li>**true**:获取</li></ul>
7488
-
7489
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
7490
-
7491
- */
7492
- WithPreviewUrl?: boolean;
7493
- /**
7494
- * 是否获取模板的PDF文件链接。
7495
-
7496
- <ul><li>**false**:不获取(默认)</li>
7497
- <li>**true**:获取</li></ul>
7498
-
7499
- 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
7500
-
7501
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
7502
- */
7503
- WithPdfUrl?: boolean;
7504
- /**
7505
- * 操作者的信息
7506
- * @deprecated
7507
- */
7508
- Operator?: UserInfo;
7509
- }
7510
7363
  /**
7511
7364
  * DescribeExtendedServiceAuthInfo返回参数结构体
7512
7365
  */