tencentcloud-sdk-nodejs-ess 4.0.567 → 4.0.569

package/tencentcloud/services/ess/v20201111/ess_client.js

@@ -124,6 +124,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DisableUserAutoSign(req, cb) {
         return this.request("DisableUserAutoSign", req, cb);
     }
+    /**
+     * 解绑用户角色绑定关系
+     */
+    async DeleteIntegrationRoleUsers(req, cb) {
+        return this.request("DeleteIntegrationRoleUsers", req, cb);
+    }
     /**
        * 提交企业签署流程审批结果
   适用场景:
@@ -198,6 +204,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateFlowByFiles(req, cb) {
         return this.request("CreateFlowByFiles", req, cb);
     }
+    /**
+     * 查询集成版角色
+     */
+    async DescribeIntegrationRoles(req, cb) {
+        return this.request("DescribeIntegrationRoles", req, cb);
+    }
     /**
        * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
   适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
@@ -244,6 +256,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeFlowBriefs(req, cb) {
         return this.request("DescribeFlowBriefs", req, cb);
     }
+    /**
+     * 集成版绑定员工角色
+     */
+    async CreateIntegrationUserRoles(req, cb) {
+        return this.request("CreateIntegrationUserRoles", req, cb);
+    }
     /**
        * 此接口（UploadFiles）用于文件上传。
   适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
@@ -308,5 +326,11 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateIntegrationEmployees(req, cb) {
         return this.request("CreateIntegrationEmployees", req, cb);
     }
+    /**
+     * 更新集成版员工信息(姓名，手机号，邮件)，用户实名后无法更改姓名与手机号
+     */
+    async UpdateIntegrationEmployees(req, cb) {
+        return this.request("UpdateIntegrationEmployees", req, cb);
+    }
 }
 exports.Client = Client;

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -20,6 +20,23 @@ export interface DescribeFlowEvidenceReportRequest {
      */
     ReportId: string;
 }
+/**
+ * UpdateIntegrationEmployees返回参数结构体
+ */
+export interface UpdateIntegrationEmployeesResponse {
+    /**
+     * 更新成功的用户列表
+     */
+    SuccessEmployeeData?: Array<SuccessUpdateStaffData>;
+    /**
+     * 更新失败的用户列表
+     */
+    FailedEmployeeData?: Array<FailedUpdateStaffData>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 集成版员工部门信息
  */
@@ -258,6 +275,35 @@ export interface CreateIntegrationEmployeesRequest {
      */
     Agent?: Agent;
 }
+/**
+ * CreateConvertTaskApi请求参数结构体
+ */
+export interface CreateConvertTaskApiRequest {
+    /**
+     * 资源类型 取值范围doc,docx,html,xls,xlsx之一
+     */
+    ResourceType: string;
+    /**
+     * 资源名称，长度限制为256字符
+     */
+    ResourceName: string;
+    /**
+     * 资源Id，通过UploadFiles获取
+     */
+    ResourceId: string;
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator?: UserInfo;
+    /**
+     * 应用号信息
+     */
+    Agent?: Agent;
+    /**
+     * 暂未开放
+     */
+    Organization?: OrganizationInfo;
+}
 /**
  * CreateFlowEvidenceReport请求参数结构体
  */
@@ -325,33 +371,41 @@ export interface FlowApproverUrlInfo {
     ApproverType?: number;
 }
 /**
- * CreateConvertTaskApi请求参数结构体
+ * 授权用户
  */
-export interface CreateConvertTaskApiRequest {
-    /**
-     * 资源类型 取值范围doc,docx,html,xls,xlsx之一
-     */
-    ResourceType: string;
+export interface AuthorizedUser {
     /**
-     * 资源名称，长度限制为256字符
+     * 用户id
      */
-    ResourceName: string;
+    UserId: string;
+}
+/**
+ * DescribeIntegrationRoles请求参数结构体
+ */
+export interface DescribeIntegrationRolesRequest {
     /**
-     * 资源Id，通过UploadFiles获取
+     * 操作人信息
      */
-    ResourceId: string;
+    Operator: UserInfo;
     /**
-     * 调用方用户信息，userId 必填
+     * 返回最大数量，最大为200
      */
-    Operator?: UserInfo;
+    Limit: number;
     /**
-     * 应用号信息
+     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
      */
     Agent?: Agent;
     /**
-     * 暂未开放
+        * 查询的关键字段:
+  Key:"RoleType",Vales:["1"]查询系统角色，Values:["2]查询自定义角色
+  Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
+  Key:"IsGroupRole"，Values:["0"],查询非集团角色，Values:["1"]表示查询集团角色
+        */
+    Filters?: Array<Filter>;
+    /**
+     * 偏移量，默认为0，最大为2000
      */
-    Organization?: OrganizationInfo;
+    Offset?: number;
 }
 /**
  * CreateFlowReminds返回参数结构体
@@ -525,13 +579,13 @@ export interface DescribeFlowTemplatesRequest {
     /**
         * 这个参数跟下面的IsChannel参数配合使用。
   IsChannel=false时，ApplicationId参数不起任何作用。
-  IsChannel=true时，ApplicationId为空，查询所有渠道模板列表；ApplicationId不为空，查询指定渠道下的模板列表
-  ApplicationId为空，查询渠道模板列表
+  IsChannel=true时，ApplicationId为空，查询所有第三方应用集成平台企业模板列表；ApplicationId不为空，查询指定应用下的模板列表
+  ApplicationId为空，查询所有应用下的模板列表
         */
     ApplicationId?: string;
     /**
         * 默认为false，查询SaaS模板库列表；
-  为true，查询渠道模板库管理列表
+  为true，查询第三方应用集成平台企业模板库管理列表
         */
     IsChannel?: boolean;
     /**
@@ -563,6 +617,19 @@ export interface DescribeFlowEvidenceReportResponse {
      */
     RequestId?: string;
 }
+/**
+ * 应用回调信息
+ */
+export interface CallbackInfo {
+    /**
+     * 回调url
+     */
+    CallbackUrl: string;
+    /**
+     * 回调加密token
+     */
+    Token: string;
+}
 /**
  * 二期接口返回的模板的信息结构
  */
@@ -683,6 +750,19 @@ export interface DescribeIntegrationEmployeesRequest {
      */
     Offset?: number;
 }
+/**
+ * CreateIntegrationUserRoles返回参数结构体
+ */
+export interface CreateIntegrationUserRolesResponse {
+    /**
+     * 绑定角色失败列表信息
+     */
+    FailedCreateRoleData?: Array<FailedCreateRoleData>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateFlow请求参数结构体
  */
@@ -1103,6 +1183,23 @@ export interface UserThreeFactor {
      */
     IdCardNumber: string;
 }
+/**
+ * 一码多扫签署二维码对象
+ */
+export interface SignQrCode {
+    /**
+     * 二维码id
+     */
+    QrCodeId: string;
+    /**
+     * 二维码url
+     */
+    QrCodeUrl: string;
+    /**
+     * 二维码过期时间
+     */
+    ExpiredTime: number;
+}
 /**
  * CreateSealPolicy返回参数结构体
  */
@@ -1220,21 +1317,17 @@ export interface CreateFlowSignReviewRequest {
     Agent?: Agent;
 }
 /**
- * 创建员工的失败数据
+ * CreateSchemeUrl返回参数结构体
  */
-export interface FailedCreateStaffData {
-    /**
-     * 员工名
-     */
-    DisplayName: string;
+export interface CreateSchemeUrlResponse {
     /**
-     * 员工手机号
+     * 小程序链接地址
      */
-    Mobile: string;
+    SchemeUrl?: string;
     /**
-     * 失败原因
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    Reason: string;
+    RequestId?: string;
 }
 /**
  * CreateUserAutoSignEnableUrl返回参数结构体
@@ -1340,7 +1433,7 @@ export interface DescribeFileUrlsRequest {
  * 电子文档的控件填充信息。按照控件类型进行相应的填充。
 
 【数据表格传参说明】
-当模板的 ComponentType='DYNAMIC_TABLE'时（渠道版或集成版），FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
+当模板的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
 输入示例1：
 
 ```
@@ -1686,13 +1779,17 @@ export interface GroupOrganization {
     FlowEngineEnable?: boolean;
 }
 /**
- * 授权用户
+ * DeleteIntegrationRoleUsers返回参数结构体
  */
-export interface AuthorizedUser {
+export interface DeleteIntegrationRoleUsersResponse {
     /**
-     * 用户id
+     * 角色id
      */
-    UserId: string;
+    RoleId?: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * CreateDocument请求参数结构体
@@ -1801,21 +1898,29 @@ export interface DeleteIntegrationEmployeesRequest {
     Agent?: Agent;
 }
 /**
- * 一码多扫签署二维码对象
+ * 更新员工信息失败返回的数据信息
  */
-export interface SignQrCode {
+export interface FailedUpdateStaffData {
     /**
-     * 二维码id
+     * 用户传入的名称
      */
-    QrCodeId: string;
+    DisplayName?: string;
     /**
-     * 二维码url
+     * 用户传入的手机号
      */
-    QrCodeUrl: string;
+    Mobile?: string;
     /**
-     * 二维码过期时间
+     * 失败原因
      */
-    ExpiredTime: number;
+    Reason?: string;
+    /**
+     * 用户Id
+     */
+    UserId?: string;
+    /**
+     * 用户OpenId
+     */
+    OpenId?: string;
 }
 /**
  * GetTaskResultApi请求参数结构体
@@ -1864,6 +1969,27 @@ export interface CreateIntegrationEmployeesResponse {
      */
     RequestId?: string;
 }
+/**
+ * DeleteIntegrationRoleUsers请求参数结构体
+ */
+export interface DeleteIntegrationRoleUsersRequest {
+    /**
+     * 操作人
+     */
+    Operator: UserInfo;
+    /**
+     * 角色id
+     */
+    RoleId: string;
+    /**
+     * 用户信息
+     */
+    Users: Array<UserInfo>;
+    /**
+     * 代理信息
+     */
+    Agent?: Agent;
+}
 /**
  * CreateFlowSignUrl请求参数结构体
  */
@@ -1908,6 +2034,27 @@ export interface CreateReleaseFlowRequest {
         */
     ReleasedApprovers?: Array<ReleasedApprover>;
 }
+/**
+ * CreateIntegrationUserRoles请求参数结构体
+ */
+export interface CreateIntegrationUserRolesRequest {
+    /**
+     * 操作人信息
+     */
+    Operator: UserInfo;
+    /**
+     * 绑定角色的用户id列表
+     */
+    UserIds: Array<string>;
+    /**
+     * 绑定角色的角色id列表
+     */
+    RoleIds: Array<string>;
+    /**
+     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     */
+    Agent?: Agent;
+}
 /**
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
  */
@@ -1954,6 +2101,23 @@ export interface FlowDetailInfo {
      */
     FlowApproverInfos: Array<FlowApproverDetail>;
 }
+/**
+ * 更新员工信息成功返回的数据信息
+ */
+export interface SuccessUpdateStaffData {
+    /**
+     * 传入的用户名称
+     */
+    DisplayName?: string;
+    /**
+     * 传入的手机号
+     */
+    Mobile?: string;
+    /**
+     * 用户Id
+     */
+    UserId?: string;
+}
 /**
  * CreateFlowByFiles返回参数结构体
  */
@@ -2085,6 +2249,21 @@ export interface VerifyPdfRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * 绑定角色失败信息
+ */
+export interface FailedCreateRoleData {
+    /**
+        * 用户userId
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    UserId?: string;
+    /**
+        * 角色id列表
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    RoleIds?: Array<string>;
+}
 /**
  * 参与者信息
  */
@@ -2243,17 +2422,21 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
     RequestId?: string;
 }
 /**
- * CreateSchemeUrl返回参数结构体
+ * 创建员工的失败数据
  */
-export interface CreateSchemeUrlResponse {
+export interface FailedCreateStaffData {
     /**
-     * 小程序链接地址
+     * 员工名
      */
-    SchemeUrl?: string;
+    DisplayName: string;
     /**
-     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     * 员工手机号
      */
-    RequestId?: string;
+    Mobile: string;
+    /**
+     * 失败原因
+     */
+    Reason: string;
 }
 /**
  * 指定签署人限制项
@@ -2396,6 +2579,36 @@ export interface CreateFlowByFilesRequest {
      */
     CcNotifyType?: number;
 }
+/**
+ * 企业角色数据信息
+ */
+export interface IntegrateRole {
+    /**
+        * 角色id
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    RoleId?: string;
+    /**
+        * 角色名
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    RoleName?: string;
+    /**
+        * 角色类型：1-系统角色，2-自定义角色
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    RoleStatus?: number;
+    /**
+        * 是否是集团角色
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    IsGroupRole?: boolean;
+    /**
+        * 管辖的子企业列表
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    SubOrgIdList?: Array<string>;
+}
 /**
  * CreatePrepareFlow返回参数结构体
  */
@@ -2466,7 +2679,20 @@ export interface CancelMultiFlowSignQRCodeRequest {
 /**
  * ModifyApplicationCallbackInfo请求参数结构体
  */
-export declare type ModifyApplicationCallbackInfoRequest = null;
+export interface ModifyApplicationCallbackInfoRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
+    /**
+     * 操作类型：1-新增，2-删除
+     */
+    OperateType: number;
+    /**
+     * 回调信息
+     */
+    CallbackInfo: CallbackInfo;
+}
 /**
  * 主企业员工账号信息
  */
@@ -2863,7 +3089,7 @@ export interface Component {
      */
     ComponentDateFontSize?: number;
     /**
-     * 渠道版控件 id 标识
+     * 平台模板控件 id 标识
      */
     ChannelComponentId?: string;
     /**
@@ -2875,7 +3101,7 @@ export interface Component {
      */
     OffsetY?: number;
     /**
-     * //渠道子客控件来源。0-渠道指定；1-用户自定义
+     * //子客控件来源。0-平台指定；1-用户自定义
      */
     ChannelComponentSource?: number;
     /**
@@ -2896,6 +3122,31 @@ export interface Component {
      */
     KeywordIndexes?: Array<number>;
 }
+/**
+ * DescribeIntegrationRoles返回参数结构体
+ */
+export interface DescribeIntegrationRolesResponse {
+    /**
+     * 偏移量，默认为0，最大为2000
+     */
+    Offset?: number;
+    /**
+     * 返回最大数量，最大为200
+     */
+    Limit?: number;
+    /**
+     * 符合查询条件的总的角色数
+     */
+    TotalCount?: number;
+    /**
+     * 企业角色信息列表
+     */
+    IntegrateRoles?: Array<IntegrateRole>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateFlowReminds请求参数结构体
  */
@@ -2909,6 +3160,23 @@ export interface CreateFlowRemindsRequest {
      */
     FlowIds: Array<string>;
 }
+/**
+ * UpdateIntegrationEmployees请求参数结构体
+ */
+export interface UpdateIntegrationEmployeesRequest {
+    /**
+     * 操作人信息
+     */
+    Operator: UserInfo;
+    /**
+     * 代理信息
+     */
+    Agent: Agent;
+    /**
+     * 员工信息
+     */
+    Employees: Array<Staff>;
+}
 /**
  * DescribeFlowBriefs请求参数结构体
  */