tencentcloud-sdk-nodejs-essbasic 4.0.688 → 4.0.689

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.688",
3
+ "version": "4.0.689",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -40,7 +40,7 @@
40
40
  | casb | [云访问安全代理](https://cloud.tencent.com/document/product/1303) | 2022-12-26 10:53:16 |
41
41
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-05-18 01:07:39 |
42
42
  | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-09-07 01:15:22 |
43
- | ccc | [云呼叫中心](https://cloud.tencent.com/document/product/679) | 2023-09-07 01:15:54 |
43
+ | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-09-15 01:15:34 |
44
44
  | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-09-14 01:15:30 |
45
45
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-09-12 01:18:51 |
46
46
  | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-09-12 01:19:13 |
@@ -67,10 +67,10 @@
67
67
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
68
68
  | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-09-12 01:32:51 |
69
69
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 |
70
- | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-09-14 01:29:46 |
70
+ | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-09-15 01:30:58 |
71
71
  | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-08-31 01:12:44 |
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-09-14 01:33:33 |
73
+ | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2023-09-15 01:35:18 |
74
74
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2023-08-17 02:45:26 |
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,7 +78,7 @@
78
78
  | dbdc | [云数据库独享集群](https://cloud.tencent.com/document/product/1322) | 2023-08-22 01:11:33 |
79
79
  | dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-08-17 02:50:46 |
80
80
  | dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-09-05 03:42:53 |
81
- | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-09-13 01:38:00 |
81
+ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-09-15 01:40:11 |
82
82
  | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-09-12 01:43:38 |
83
83
  | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-08-17 02:58:55 |
84
84
  | drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-08-17 02:59:36 |
@@ -93,9 +93,9 @@
93
93
  | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
94
94
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
95
95
  | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-08-17 03:08:06 |
96
- | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-09-14 01:45:31 |
97
- | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-09-14 01:46:23 |
98
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-09-14 01:47:20 |
96
+ | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-09-15 01:48:20 |
97
+ | ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-09-15 01:49:08 |
98
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-09-14 11:40:45 |
99
99
  | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-07-27 01:13:31 |
100
100
  | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-09-06 01:49:13 |
101
101
  | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
@@ -127,8 +127,8 @@
127
127
  | ivld | [媒体智能标签](https://cloud.tencent.com/document/product/1509) | 2023-05-18 01:35:21 |
128
128
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2023-07-19 01:29:34 |
129
129
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-08-17 03:51:31 |
130
- | lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2023-09-12 02:07:10 |
131
- | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-08-31 01:19:17 |
130
+ | lcic | [低代码互动课堂](https://cloud.tencent.com/document/product/1639) | 2023-09-15 02:03:32 |
131
+ | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-09-15 02:04:15 |
132
132
  | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-09-04 02:06:58 |
133
133
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
134
134
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
@@ -139,22 +139,22 @@
139
139
  | mgobe | [游戏联机对战引擎](https://cloud.tencent.com/document/product/1038) | 2022-07-08 06:11:32 |
140
140
  | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2023-05-18 01:39:20 |
141
141
  | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-08-30 01:19:09 |
142
- | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-08-25 01:55:53 |
143
- | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-09-13 02:04:57 |
142
+ | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-09-15 02:08:53 |
143
+ | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-09-15 02:09:24 |
144
144
  | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-09-04 02:12:09 |
145
145
  | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-09-13 02:09:08 |
146
146
  | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-08-30 01:19:55 |
147
147
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2023-08-17 04:18:22 |
148
148
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
149
- | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-14 02:08:26 |
149
+ | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2023-09-15 02:14:19 |
150
150
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
151
151
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2023-09-06 02:10:27 |
152
152
  | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2023-09-14 02:09:03 |
153
- | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-07-20 01:37:20 |
153
+ | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2023-09-15 02:16:07 |
154
154
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2023-08-24 01:24:31 |
155
155
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2023-08-17 04:23:46 |
156
156
  | pds | [私域安全](https://cloud.tencent.com/document/product/1473) | 2023-05-18 01:44:14 |
157
- | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2023-08-24 01:24:41 |
157
+ | postgres | [云数据库 PostgreSQL](https://cloud.tencent.com/document/product/409) | 2023-09-15 02:17:12 |
158
158
  | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2023-08-23 01:36:40 |
159
159
  | pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2023-08-24 01:24:59 |
160
160
  | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2023-08-17 04:29:35 |
@@ -172,8 +172,8 @@
172
172
  | soe | [智聆口语评测](https://cloud.tencent.com/document/product/884) | 2023-07-10 01:39:48 |
173
173
  | solar | [智汇零售](https://cloud.tencent.com/document/product) | 2020-03-19 08:01:59 |
174
174
  | sqlserver | [云数据库 SQL Server](https://cloud.tencent.com/document/product/238) | 2023-09-13 02:18:02 |
175
- | ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2023-09-12 02:29:07 |
176
- | ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2023-09-12 02:29:39 |
175
+ | ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2023-09-15 02:24:19 |
176
+ | ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2023-09-15 02:24:49 |
177
177
  | sslpod | [证书监控 SSLPod](https://cloud.tencent.com/document/product/1084) | 2023-08-17 04:46:28 |
178
178
  | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2023-08-17 04:46:36 |
179
179
  | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2023-08-17 04:47:11 |
@@ -226,10 +226,10 @@
226
226
  | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2023-08-17 05:50:27 |
227
227
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-05-18 02:04:19 |
228
228
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
229
- | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-09-14 02:39:15 |
230
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-09-12 02:59:25 |
229
+ | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-09-15 02:46:32 |
230
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-09-15 02:54:26 |
231
231
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
232
- | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-09-14 02:44:37 |
232
+ | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-09-15 02:58:03 |
233
233
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
234
234
  | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-08-31 01:29:16 |
235
235
  | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2023-09-12 09:30:48 |
@@ -40,6 +40,7 @@ import {
40
40
  OperateChannelTemplateResponse,
41
41
  FlowFileInfo,
42
42
  CreateFlowOption,
43
+ ChannelCreateRoleRequest,
43
44
  BaseFlowInfo,
44
45
  ReleasedApprover,
45
46
  CreateConsoleLoginUrlResponse,
@@ -75,6 +76,7 @@ import {
75
76
  ChannelVerifyPdfRequest,
76
77
  CreateChannelFlowEvidenceReportRequest,
77
78
  ChannelCancelUserAutoSignEnableUrlRequest,
79
+ Permission,
78
80
  ComponentLimit,
79
81
  ChannelVerifyPdfResponse,
80
82
  CreateConsoleLoginUrlRequest,
@@ -111,15 +113,18 @@ import {
111
113
  FlowDetailInfo,
112
114
  CreateFlowsByTemplatesResponse,
113
115
  DescribeChannelFlowEvidenceReportRequest,
116
+ ChannelCreateRoleResponse,
114
117
  SyncProxyOrganizationOperatorsResponse,
115
118
  FailedCreateRoleData,
116
119
  ChannelDescribeUserAutoSignStatusRequest,
117
120
  FlowResourceUrlInfo,
118
121
  UploadFile,
119
122
  ExtentServiceAuthInfo,
123
+ ChannelModifyRoleResponse,
120
124
  Filter,
121
125
  FilledComponent,
122
126
  CreateSignUrlsResponse,
127
+ ChannelDeleteRoleRequest,
123
128
  UploadFilesResponse,
124
129
  ChannelCreateBatchCancelFlowUrlRequest,
125
130
  ApproverRestriction,
@@ -140,12 +145,14 @@ import {
140
145
  ModifyExtendedServiceResponse,
141
146
  ChannelCreateUserRolesRequest,
142
147
  ChannelGetTaskResultApiResponse,
148
+ PermissionGroup,
143
149
  ChannelCreateOrganizationModifyQrCodeResponse,
144
150
  ChannelDeleteSealPoliciesResponse,
145
151
  ChannelCreateWebThemeConfigResponse,
146
152
  GetDownloadFlowUrlRequest,
147
153
  ChannelCreateEmbedWebUrlResponse,
148
154
  ChannelBatchCancelFlowsRequest,
155
+ ChannelModifyRoleRequest,
149
156
  ChannelUpdateSealStatusRequest,
150
157
  ChannelCreateFlowGroupByTemplatesRequest,
151
158
  SignUrl,
@@ -163,6 +170,7 @@ import {
163
170
  CreateChannelFlowEvidenceReportResponse,
164
171
  SyncFailReason,
165
172
  ChannelDescribeEmployeesResponse,
173
+ ChannelDeleteRoleResponse,
166
174
  ChannelCreateReleaseFlowResponse,
167
175
  DescribeChannelFlowEvidenceReportResponse,
168
176
  CreateSealByImageRequest,
@@ -231,6 +239,20 @@ export class Client extends TencentCloudCommon.AbstractClient {
231
239
  return this.request("ChannelCreateMultiFlowSignQRCode", req, cb)
232
240
  }
233
241
 
242
+ /**
243
+ * 此接口(ChannelModifyRole)用来更新企业自定义角色。
244
+
245
+ 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
246
+
247
+ 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
248
+ */
249
+ async ChannelModifyRole(
250
+ req: ChannelModifyRoleRequest,
251
+ cb?: (error: string, rep: ChannelModifyRoleResponse) => void
252
+ ): Promise<ChannelModifyRoleResponse> {
253
+ return this.request("ChannelModifyRole", req, cb)
254
+ }
255
+
234
256
  /**
235
257
  * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
236
258
  */
@@ -336,6 +358,20 @@ export class Client extends TencentCloudCommon.AbstractClient {
336
358
  return this.request("ChannelCreateSealPolicy", req, cb)
337
359
  }
338
360
 
361
+ /**
362
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
363
+
364
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
365
+
366
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
367
+ */
368
+ async ChannelCreateRole(
369
+ req: ChannelCreateRoleRequest,
370
+ cb?: (error: string, rep: ChannelCreateRoleResponse) => void
371
+ ): Promise<ChannelCreateRoleResponse> {
372
+ return this.request("ChannelCreateRole", req, cb)
373
+ }
374
+
339
375
  /**
340
376
  * 企业方可以通过此接口关闭个人的自动签功能
341
377
  */
@@ -487,6 +523,18 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
487
523
  return this.request("ChannelCreateBatchCancelFlowUrl", req, cb)
488
524
  }
489
525
 
526
+ /**
527
+ * 此接口(ChannelDeleteRole)用来删除企业自定义角色。
528
+
529
+ 注意:系统角色不可删除。
530
+ */
531
+ async ChannelDeleteRole(
532
+ req: ChannelDeleteRoleRequest,
533
+ cb?: (error: string, rep: ChannelDeleteRoleResponse) => void
534
+ ): Promise<ChannelDeleteRoleResponse> {
535
+ return this.request("ChannelDeleteRole", req, cb)
536
+ }
537
+
490
538
  /**
491
539
  * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
492
540
  注意:大文件转换所需的时间可能会比较长。
@@ -550,8 +598,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
550
598
  }
551
599
 
552
600
  /**
553
- * 生成页面主题配置
554
- */
601
+ * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
602
+ 创建配置对当前第三方应用全局生效,如果多次调用,会以最后一次的配置为准
603
+ */
555
604
  async ChannelCreateWebThemeConfig(
556
605
  req: ChannelCreateWebThemeConfigRequest,
557
606
  cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void
@@ -640,7 +689,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
640
689
  }
641
690
 
642
691
  /**
643
- * 查询角色列表,支持根据类型和状态过滤角色列表
692
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
644
693
  */
645
694
  async ChannelDescribeRoles(
646
695
  req: ChannelDescribeRolesRequest,
@@ -629,14 +629,15 @@ export interface ChannelCreatePrepareFlowResponse {
629
629
  */
630
630
  export interface WebThemeConfig {
631
631
  /**
632
- * 页面底部是否显示电子签logo
633
- <br/>true:允许在页面底部隐藏电子签logo
634
- <br/>默认false,不允许允许在页面底部隐藏电子签logo
632
+ * 是否显示页面底部电子签logo,取值如下:
633
+ <ul><li> **true**:页面底部显示电子签logo</li>
634
+ <li> **false**:页面底部不显示电子签logo(默认)</li></ul>
635
635
  */
636
636
  DisplaySignBrandLogo?: boolean
637
637
  /**
638
- * 嵌入式主题颜色
639
- <br/>支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
638
+ * 主题颜色:
639
+ 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
640
+ <br/>
640
641
  */
641
642
  WebEmbedThemeColor?: string
642
643
  }
@@ -770,6 +771,28 @@ export interface CreateFlowOption {
770
771
  CustomCreateFlowDescription?: string
771
772
  }
772
773
 
774
+ /**
775
+ * ChannelCreateRole请求参数结构体
776
+ */
777
+ export interface ChannelCreateRoleRequest {
778
+ /**
779
+ * 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
780
+ */
781
+ Name: string
782
+ /**
783
+ * 代理企业和员工的信息。
784
+ */
785
+ Agent: Agent
786
+ /**
787
+ * 角色描述,最大长度为50个字符
788
+ */
789
+ Description?: string
790
+ /**
791
+ * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
792
+ */
793
+ PermissionGroups?: Array<PermissionGroup>
794
+ }
795
+
773
796
  /**
774
797
  * 基础流程信息
775
798
  */
@@ -1308,6 +1331,11 @@ export interface ChannelRole {
1308
1331
  注意:此字段可能返回 null,表示取不到有效值。
1309
1332
  */
1310
1333
  RoleStatus?: number
1334
+ /**
1335
+ * 权限树
1336
+ 注意:此字段可能返回 null,表示取不到有效值。
1337
+ */
1338
+ PermissionGroups?: Array<PermissionGroup>
1311
1339
  }
1312
1340
 
1313
1341
  /**
@@ -1524,10 +1552,6 @@ export interface ChannelDescribeRolesRequest {
1524
1552
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1525
1553
  */
1526
1554
  Agent: Agent
1527
- /**
1528
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
1529
- */
1530
- Offset: number
1531
1555
  /**
1532
1556
  * 指定每页多少条数据,单页最大200
1533
1557
  */
@@ -1536,8 +1560,13 @@ export interface ChannelDescribeRolesRequest {
1536
1560
  * 查询的关键字段:
1537
1561
  Key:"RoleType",Values:["1"]查询系统角色,Values:["2"]查询自定义角色
1538
1562
  Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
1563
+ Key:"IsReturnPermissionGroup",Values:["0"]:表示接口不返回角色对应的权限树字段,Values:["1"]表示接口返回角色对应的权限树字段
1539
1564
  */
1540
1565
  Filters?: Array<Filter>
1566
+ /**
1567
+ * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大2000
1568
+ */
1569
+ Offset?: number
1541
1570
  /**
1542
1571
  * 操作人信息
1543
1572
  * @deprecated
@@ -1884,6 +1913,67 @@ export interface ChannelCancelUserAutoSignEnableUrlRequest {
1884
1913
  UserInfo: UserThreeFactor
1885
1914
  }
1886
1915
 
1916
+ /**
1917
+ * 权限树节点权限
1918
+ */
1919
+ export interface Permission {
1920
+ /**
1921
+ * 权限名称
1922
+ 注意:此字段可能返回 null,表示取不到有效值。
1923
+ */
1924
+ Name?: string
1925
+ /**
1926
+ * 权限key
1927
+ 注意:此字段可能返回 null,表示取不到有效值。
1928
+ */
1929
+ Key?: string
1930
+ /**
1931
+ * 权限类型 1前端,2后端
1932
+ 注意:此字段可能返回 null,表示取不到有效值。
1933
+ */
1934
+ Type?: number
1935
+ /**
1936
+ * 是否隐藏
1937
+ 注意:此字段可能返回 null,表示取不到有效值。
1938
+ */
1939
+ Hide?: number
1940
+ /**
1941
+ * 数据权限标签 1:表示根节点,2:表示叶子结点
1942
+ 注意:此字段可能返回 null,表示取不到有效值。
1943
+ */
1944
+ DataLabel?: number
1945
+ /**
1946
+ * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
1947
+ 注意:此字段可能返回 null,表示取不到有效值。
1948
+ */
1949
+ DataType?: number
1950
+ /**
1951
+ * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
1952
+ 注意:此字段可能返回 null,表示取不到有效值。
1953
+ */
1954
+ DataRange?: number
1955
+ /**
1956
+ * 关联权限, 表示这个功能权限要受哪个数据权限管控
1957
+ 注意:此字段可能返回 null,表示取不到有效值。
1958
+ */
1959
+ DataTo?: string
1960
+ /**
1961
+ * 父级权限key
1962
+ 注意:此字段可能返回 null,表示取不到有效值。
1963
+ */
1964
+ ParentKey?: string
1965
+ /**
1966
+ * 是否选中
1967
+ 注意:此字段可能返回 null,表示取不到有效值。
1968
+ */
1969
+ IsChecked?: boolean
1970
+ /**
1971
+ * 子权限集合
1972
+ 注意:此字段可能返回 null,表示取不到有效值。
1973
+ */
1974
+ Children?: Array<Permission>
1975
+ }
1976
+
1887
1977
  /**
1888
1978
  * 签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
1889
1979
  */
@@ -3387,6 +3477,20 @@ export interface DescribeChannelFlowEvidenceReportRequest {
3387
3477
  Operator?: UserInfo
3388
3478
  }
3389
3479
 
3480
+ /**
3481
+ * ChannelCreateRole返回参数结构体
3482
+ */
3483
+ export interface ChannelCreateRoleResponse {
3484
+ /**
3485
+ * 角色id
3486
+ */
3487
+ RoleId?: string
3488
+ /**
3489
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3490
+ */
3491
+ RequestId?: string
3492
+ }
3493
+
3390
3494
  /**
3391
3495
  * SyncProxyOrganizationOperators返回参数结构体
3392
3496
  */
@@ -3513,6 +3617,20 @@ DISABLE 关闭
3513
3617
  OperateOn?: number
3514
3618
  }
3515
3619
 
3620
+ /**
3621
+ * ChannelModifyRole返回参数结构体
3622
+ */
3623
+ export interface ChannelModifyRoleResponse {
3624
+ /**
3625
+ * 角色id
3626
+ */
3627
+ RoleId?: string
3628
+ /**
3629
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3630
+ */
3631
+ RequestId?: string
3632
+ }
3633
+
3516
3634
  /**
3517
3635
  * 此结构体 (Filter) 用于描述查询过滤条件。
3518
3636
  */
@@ -3576,6 +3694,20 @@ export interface CreateSignUrlsResponse {
3576
3694
  RequestId?: string
3577
3695
  }
3578
3696
 
3697
+ /**
3698
+ * ChannelDeleteRole请求参数结构体
3699
+ */
3700
+ export interface ChannelDeleteRoleRequest {
3701
+ /**
3702
+ * 代理企业和员工的信息。
3703
+ */
3704
+ Agent: Agent
3705
+ /**
3706
+ * 角色id,最多20个
3707
+ */
3708
+ RoleIds: Array<string>
3709
+ }
3710
+
3579
3711
  /**
3580
3712
  * UploadFiles返回参数结构体
3581
3713
  */
@@ -4015,6 +4147,32 @@ ProcessTimeout - 转换文件超时
4015
4147
  RequestId?: string
4016
4148
  }
4017
4149
 
4150
+ /**
4151
+ * 权限树中的权限组
4152
+ */
4153
+ export interface PermissionGroup {
4154
+ /**
4155
+ * 权限组名称
4156
+ 注意:此字段可能返回 null,表示取不到有效值。
4157
+ */
4158
+ GroupName?: string
4159
+ /**
4160
+ * 权限组key
4161
+ 注意:此字段可能返回 null,表示取不到有效值。
4162
+ */
4163
+ GroupKey?: string
4164
+ /**
4165
+ * 是否隐藏分组,0否1是
4166
+ 注意:此字段可能返回 null,表示取不到有效值。
4167
+ */
4168
+ Hide?: number
4169
+ /**
4170
+ * 权限集合
4171
+ 注意:此字段可能返回 null,表示取不到有效值。
4172
+ */
4173
+ Permissions?: Array<Permission>
4174
+ }
4175
+
4018
4176
  /**
4019
4177
  * ChannelCreateOrganizationModifyQrCode返回参数结构体
4020
4178
  */
@@ -4118,6 +4276,32 @@ export interface ChannelBatchCancelFlowsRequest {
4118
4276
  Operator?: UserInfo
4119
4277
  }
4120
4278
 
4279
+ /**
4280
+ * ChannelModifyRole请求参数结构体
4281
+ */
4282
+ export interface ChannelModifyRoleRequest {
4283
+ /**
4284
+ * 代理企业和员工的信息。
4285
+ */
4286
+ Agent: Agent
4287
+ /**
4288
+ * 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
4289
+ */
4290
+ Name: string
4291
+ /**
4292
+ * 角色Id,可通过接口 ChannelDescribeRoles 查询获取
4293
+ */
4294
+ RoleId: string
4295
+ /**
4296
+ * 角色描述,最大长度为50个字符
4297
+ */
4298
+ Description?: string
4299
+ /**
4300
+ * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
4301
+ */
4302
+ PermissionGroups?: Array<PermissionGroup>
4303
+ }
4304
+
4121
4305
  /**
4122
4306
  * ChannelUpdateSealStatus请求参数结构体
4123
4307
  */
@@ -4627,6 +4811,16 @@ export interface ChannelDescribeEmployeesResponse {
4627
4811
  RequestId?: string
4628
4812
  }
4629
4813
 
4814
+ /**
4815
+ * ChannelDeleteRole返回参数结构体
4816
+ */
4817
+ export interface ChannelDeleteRoleResponse {
4818
+ /**
4819
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4820
+ */
4821
+ RequestId?: string
4822
+ }
4823
+
4630
4824
  /**
4631
4825
  * ChannelCreateReleaseFlow返回参数结构体
4632
4826
  */
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
2
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, ChannelCreateFlowSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
3
  /**
4
4
  * essbasic client
5
5
  * @class
@@ -35,6 +35,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
35
35
  用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
36
36
  */
37
37
  ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse>;
38
+ /**
39
+ * 此接口(ChannelModifyRole)用来更新企业自定义角色。
40
+
41
+ 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
42
+
43
+ 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
44
+ */
45
+ ChannelModifyRole(req: ChannelModifyRoleRequest, cb?: (error: string, rep: ChannelModifyRoleResponse) => void): Promise<ChannelModifyRoleResponse>;
38
46
  /**
39
47
  * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
40
48
  */
@@ -80,6 +88,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
80
88
  * 将指定印章授权给第三方平台子客企业下的某些员工
81
89
  */
82
90
  ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
91
+ /**
92
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
93
+
94
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
95
+
96
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
97
+ */
98
+ ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise<ChannelCreateRoleResponse>;
83
99
  /**
84
100
  * 企业方可以通过此接口关闭个人的自动签功能
85
101
  */
@@ -177,6 +193,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
177
193
  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
178
194
  */
179
195
  ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
196
+ /**
197
+ * 此接口(ChannelDeleteRole)用来删除企业自定义角色。
198
+
199
+ 注意:系统角色不可删除。
200
+ */
201
+ ChannelDeleteRole(req: ChannelDeleteRoleRequest, cb?: (error: string, rep: ChannelDeleteRoleResponse) => void): Promise<ChannelDeleteRoleResponse>;
180
202
  /**
181
203
  * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
182
204
  注意:大文件转换所需的时间可能会比较长。
@@ -204,8 +226,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
204
226
  */
205
227
  ChannelVerifyPdf(req: ChannelVerifyPdfRequest, cb?: (error: string, rep: ChannelVerifyPdfResponse) => void): Promise<ChannelVerifyPdfResponse>;
206
228
  /**
207
- * 生成页面主题配置
208
- */
229
+ * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
230
+ 创建配置对当前第三方应用全局生效,如果多次调用,会以最后一次的配置为准
231
+ */
209
232
  ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
210
233
  /**
211
234
  * 创建个人签署H5签署链接,请联系客户经理申请使用<br/>
@@ -252,7 +275,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
252
275
  */
253
276
  CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
254
277
  /**
255
- * 查询角色列表,支持根据类型和状态过滤角色列表
278
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
256
279
  */
257
280
  ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise<ChannelDescribeRolesResponse>;
258
281
  /**