tencentcloud-sdk-nodejs-essbasic 4.0.687 → 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.
@@ -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
@@ -1803,7 +1832,7 @@ export interface AutoSignConfig {
1803
1832
  */
1804
1833
  VerifyChannels?: Array<string>
1805
1834
  /**
1806
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
1835
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
1807
1836
  */
1808
1837
  LicenseType?: number
1809
1838
  }
@@ -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
  */
@@ -4698,7 +4892,7 @@ export interface CreateSealByImageRequest {
4698
4892
  <li>PERSONNEL-人事专用章
4699
4893
  </li>
4700
4894
  <li>默认:OFFICIAL</li>
4701
- <ul>
4895
+ </ul>
4702
4896
  */
4703
4897
  SealType?: string
4704
4898
  /**
@@ -4739,7 +4933,7 @@ export interface ChannelDescribeUserAutoSignStatusResponse {
4739
4933
  */
4740
4934
  LicenseTo?: number
4741
4935
  /**
4742
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
4936
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
4743
4937
  */
4744
4938
  LicenseType?: number
4745
4939
  /**
@@ -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
  /**
@@ -62,6 +62,16 @@ class Client extends TencentCloudCommon.AbstractClient {
62
62
  async ChannelCreateMultiFlowSignQRCode(req, cb) {
63
63
  return this.request("ChannelCreateMultiFlowSignQRCode", req, cb);
64
64
  }
65
+ /**
66
+ * 此接口(ChannelModifyRole)用来更新企业自定义角色。
67
+
68
+ 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
69
+
70
+ 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
71
+ */
72
+ async ChannelModifyRole(req, cb) {
73
+ return this.request("ChannelModifyRole", req, cb);
74
+ }
65
75
  /**
66
76
  * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
67
77
  */
@@ -127,6 +137,16 @@ class Client extends TencentCloudCommon.AbstractClient {
127
137
  async ChannelCreateSealPolicy(req, cb) {
128
138
  return this.request("ChannelCreateSealPolicy", req, cb);
129
139
  }
140
+ /**
141
+ * 此接口(ChannelCreateRole)用来创建企业自定义角色。
142
+
143
+ 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
144
+
145
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。
146
+ */
147
+ async ChannelCreateRole(req, cb) {
148
+ return this.request("ChannelCreateRole", req, cb);
149
+ }
130
150
  /**
131
151
  * 企业方可以通过此接口关闭个人的自动签功能
132
152
  */
@@ -242,6 +262,14 @@ class Client extends TencentCloudCommon.AbstractClient {
242
262
  async ChannelCreateBatchCancelFlowUrl(req, cb) {
243
263
  return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
244
264
  }
265
+ /**
266
+ * 此接口(ChannelDeleteRole)用来删除企业自定义角色。
267
+
268
+ 注意:系统角色不可删除。
269
+ */
270
+ async ChannelDeleteRole(req, cb) {
271
+ return this.request("ChannelDeleteRole", req, cb);
272
+ }
245
273
  /**
246
274
  * 查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。
247
275
  注意:大文件转换所需的时间可能会比较长。
@@ -281,8 +309,9 @@ class Client extends TencentCloudCommon.AbstractClient {
281
309
  return this.request("ChannelVerifyPdf", req, cb);
282
310
  }
283
311
  /**
284
- * 生成页面主题配置
285
- */
312
+ * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
313
+ 创建配置对当前第三方应用全局生效,如果多次调用,会以最后一次的配置为准
314
+ */
286
315
  async ChannelCreateWebThemeConfig(req, cb) {
287
316
  return this.request("ChannelCreateWebThemeConfig", req, cb);
288
317
  }
@@ -343,7 +372,7 @@ class Client extends TencentCloudCommon.AbstractClient {
343
372
  return this.request("CreateFlowsByTemplates", req, cb);
344
373
  }
345
374
  /**
346
- * 查询角色列表,支持根据类型和状态过滤角色列表
375
+ * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
347
376
  */
348
377
  async ChannelDescribeRoles(req, cb) {
349
378
  return this.request("ChannelDescribeRoles", req, cb);