tencentcloud-sdk-nodejs-essbasic 4.0.687 → 4.0.689

package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts

@@ -593,14 +593,15 @@ export interface ChannelCreatePrepareFlowResponse {
  */
 export interface WebThemeConfig {
     /**
-     * 页面底部是否显示电子签logo
-  <br/>true：允许在页面底部隐藏电子签logo
-  <br/>默认false，不允许允许在页面底部隐藏电子签logo
+     * 是否显示页面底部电子签logo，取值如下：
+  <ul><li> **true**：页面底部显示电子签logo</li>
+  <li> **false**：页面底部不显示电子签logo（默认）</li></ul>
      */
     DisplaySignBrandLogo?: boolean;
     /**
-     * 嵌入式主题颜色
-  <br/>支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
+     * 主题颜色：
+  支持十六进制颜色值以及RGB格式颜色值，例如：#D54941，rgb(213, 73, 65)
+  <br/>
      */
     WebEmbedThemeColor?: string;
 }
@@ -730,6 +731,27 @@ export interface CreateFlowOption {
      */
     CustomCreateFlowDescription?: string;
 }
+/**
+ * ChannelCreateRole请求参数结构体
+ */
+export interface ChannelCreateRoleRequest {
+    /**
+     * 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
+     */
+    Name: string;
+    /**
+     * 代理企业和员工的信息。
+     */
+    Agent: Agent;
+    /**
+     * 角色描述，最大长度为50个字符
+     */
+    Description?: string;
+    /**
+     * 权限树，权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
+     */
+    PermissionGroups?: Array<PermissionGroup>;
+}
 /**
  * 基础流程信息
  */
@@ -1253,6 +1275,11 @@ export interface ChannelRole {
   注意：此字段可能返回 null，表示取不到有效值。
      */
     RoleStatus?: number;
+    /**
+     * 权限树
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    PermissionGroups?: Array<PermissionGroup>;
 }
 /**
  * ChannelCreatePreparedPersonalEsign返回参数结构体
@@ -1461,10 +1488,6 @@ export interface ChannelDescribeRolesRequest {
      * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
      */
     Agent: Agent;
-    /**
-     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
-     */
-    Offset: number;
     /**
      * 指定每页多少条数据，单页最大200
      */
@@ -1473,8 +1496,13 @@ export interface ChannelDescribeRolesRequest {
      * 查询的关键字段:
   Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色
   Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
+  Key:"IsReturnPermissionGroup"，Values:["0"]:表示接口不返回角色对应的权限树字段，Values:["1"]表示接口返回角色对应的权限树字段
      */
     Filters?: Array<Filter>;
+    /**
+     * 查询结果分页返回，此处指定第几页，如果不传默认从第一页返回。页码从 0 开始，即首页为 0，最大2000
+     */
+    Offset?: number;
     /**
      * 操作人信息
      * @deprecated
@@ -1733,7 +1761,7 @@ export interface AutoSignConfig {
      */
     VerifyChannels?: Array<string>;
     /**
-     * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
+     * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
      */
     LicenseType?: number;
 }
@@ -1809,6 +1837,66 @@ export interface ChannelCancelUserAutoSignEnableUrlRequest {
      */
     UserInfo: UserThreeFactor;
 }
+/**
+ * 权限树节点权限
+ */
+export interface Permission {
+    /**
+     * 权限名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Name?: string;
+    /**
+     * 权限key
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Key?: string;
+    /**
+     * 权限类型 1前端，2后端
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Type?: number;
+    /**
+     * 是否隐藏
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Hide?: number;
+    /**
+     * 数据权限标签 1:表示根节点，2:表示叶子结点
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DataLabel?: number;
+    /**
+     * 数据权限独有，1:关联其他模块鉴权，2:表示关联自己模块鉴权
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DataType?: number;
+    /**
+     * 数据权限独有，表示数据范围，1：全公司，2:部门及下级部门，3:自己
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DataRange?: number;
+    /**
+     * 关联权限, 表示这个功能权限要受哪个数据权限管控
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DataTo?: string;
+    /**
+     * 父级权限key
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    ParentKey?: string;
+    /**
+     * 是否选中
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    IsChecked?: boolean;
+    /**
+     * 子权限集合
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Children?: Array<Permission>;
+}
 /**
  * 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
  */
@@ -3276,6 +3364,19 @@ export interface DescribeChannelFlowEvidenceReportRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * ChannelCreateRole返回参数结构体
+ */
+export interface ChannelCreateRoleResponse {
+    /**
+     * 角色id
+     */
+    RoleId?: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * SyncProxyOrganizationOperators返回参数结构体
  */
@@ -3396,6 +3497,19 @@ export interface ExtentServiceAuthInfo {
      */
     OperateOn?: number;
 }
+/**
+ * ChannelModifyRole返回参数结构体
+ */
+export interface ChannelModifyRoleResponse {
+    /**
+     * 角色id
+     */
+    RoleId?: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 此结构体 (Filter) 用于描述查询过滤条件。
  */
@@ -3456,6 +3570,19 @@ export interface CreateSignUrlsResponse {
      */
     RequestId?: string;
 }
+/**
+ * ChannelDeleteRole请求参数结构体
+ */
+export interface ChannelDeleteRoleRequest {
+    /**
+     * 代理企业和员工的信息。
+     */
+    Agent: Agent;
+    /**
+     * 角色id，最多20个
+     */
+    RoleIds: Array<string>;
+}
 /**
  * UploadFiles返回参数结构体
  */
@@ -3875,6 +4002,31 @@ export interface ChannelGetTaskResultApiResponse {
      */
     RequestId?: string;
 }
+/**
+ * 权限树中的权限组
+ */
+export interface PermissionGroup {
+    /**
+     * 权限组名称
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    GroupName?: string;
+    /**
+     * 权限组key
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    GroupKey?: string;
+    /**
+     * 是否隐藏分组，0否1是
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Hide?: number;
+    /**
+     * 权限集合
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Permissions?: Array<Permission>;
+}
 /**
  * ChannelCreateOrganizationModifyQrCode返回参数结构体
  */
@@ -3972,6 +4124,31 @@ export interface ChannelBatchCancelFlowsRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * ChannelModifyRole请求参数结构体
+ */
+export interface ChannelModifyRoleRequest {
+    /**
+     * 代理企业和员工的信息。
+     */
+    Agent: Agent;
+    /**
+     * 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
+     */
+    Name: string;
+    /**
+     * 角色Id，可通过接口 ChannelDescribeRoles 查询获取
+     */
+    RoleId: string;
+    /**
+     * 角色描述，最大长度为50个字符
+     */
+    Description?: string;
+    /**
+     * 权限树，权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
+     */
+    PermissionGroups?: Array<PermissionGroup>;
+}
 /**
  * ChannelUpdateSealStatus请求参数结构体
  */
@@ -4464,6 +4641,15 @@ export interface ChannelDescribeEmployeesResponse {
      */
     RequestId?: string;
 }
+/**
+ * ChannelDeleteRole返回参数结构体
+ */
+export interface ChannelDeleteRoleResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ChannelCreateReleaseFlow返回参数结构体
  */
@@ -4533,7 +4719,7 @@ export interface CreateSealByImageRequest {
   <li>PERSONNEL-人事专用章
   </li>
   <li>默认：OFFICIAL</li>
-  <ul>
+  </ul>
      */
     SealType?: string;
     /**
@@ -4573,7 +4759,7 @@ export interface ChannelDescribeUserAutoSignStatusResponse {
      */
     LicenseTo?: number;
     /**
-     * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次 1-不绑定，发起合同时将按标准合同套餐进行扣减
+     * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
      */
     LicenseType?: number;
     /**