tencentcloud-sdk-nodejs-ess 4.0.566 → 4.0.568

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;
+}
 /**
  * 集成版员工部门信息
  */
@@ -34,48 +51,46 @@ export interface Department {
     DepartmentName: string;
 }
 /**
- * CreateSchemeUrl请求参数结构体
+ * CreatePreparedPersonalEsign请求参数结构体
  */
-export interface CreateSchemeUrlRequest {
+export interface CreatePreparedPersonalEsignRequest {
     /**
-     * 调用方用户信息，userId 必填
+     * 个人用户名称
      */
-    Operator: UserInfo;
+    UserName: string;
     /**
-     * 企业名称
+     * 身份证件号码
      */
-    OrganizationName?: string;
+    IdCardNumber: string;
     /**
-     * 姓名,最大长度50个字符
+     * 印章图片的base64
      */
-    Name?: string;
+    SealImage: string;
     /**
-     * 手机号，大陆手机号11位
+     * 印章名称
      */
-    Mobile?: string;
-    /**
-        * 链接类型
-  HTTP：跳转电子签小程序的http_url，
-  APP：第三方APP或小程序跳转电子签小程序的path。
-  默认为HTTP类型
-        */
-    EndPoint?: string;
+    SealName: string;
     /**
-     * 签署流程编号 (PathType=1时必传)
+     * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
      */
-    FlowId?: string;
+    Operator?: UserInfo;
     /**
-     * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
-     */
-    PathType?: number;
+        * 身份证件类型:
+  ID_CARD 身份证
+  PASSPORT 护照
+  HONGKONG_AND_MACAO 香港身份
+  FOREIGN_ID_CARD 国外身份
+  HONGKONG_MACAO_AND_TAIWAN 港台身份
+        */
+    IdCardType?: string;
     /**
-     * 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
+     * 手机号码
      */
-    AutoJumpBack?: boolean;
+    Mobile?: string;
     /**
-     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     * 是否需开通自动签
      */
-    Agent?: Agent;
+    EnableAutoSign?: boolean;
 }
 /**
  * 二期接口返回的模板中文件的信息结构
@@ -255,6 +270,39 @@ export interface CreateIntegrationEmployeesRequest {
      * 待创建员工的信息，Mobile和DisplayName必填
      */
     Employees: Array<Staff>;
+    /**
+     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     */
+    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请求参数结构体
@@ -323,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返回参数结构体
@@ -523,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;
     /**
@@ -681,6 +737,19 @@ export interface DescribeIntegrationEmployeesRequest {
      */
     Offset?: number;
 }
+/**
+ * CreateIntegrationUserRoles返回参数结构体
+ */
+export interface CreateIntegrationUserRolesResponse {
+    /**
+     * 绑定角色失败列表信息
+     */
+    FailedCreateRoleData?: Array<FailedCreateRoleData>;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateFlow请求参数结构体
  */
@@ -754,6 +823,50 @@ export interface CreateFlowRequest {
         */
     CcInfos?: Array<CcInfo>;
 }
+/**
+ * CreateSchemeUrl请求参数结构体
+ */
+export interface CreateSchemeUrlRequest {
+    /**
+     * 调用方用户信息，userId 必填
+     */
+    Operator: UserInfo;
+    /**
+     * 企业名称
+     */
+    OrganizationName?: string;
+    /**
+     * 姓名,最大长度50个字符
+     */
+    Name?: string;
+    /**
+     * 手机号，大陆手机号11位
+     */
+    Mobile?: string;
+    /**
+        * 链接类型
+  HTTP：跳转电子签小程序的http_url，
+  APP：第三方APP或小程序跳转电子签小程序的path。
+  默认为HTTP类型
+        */
+    EndPoint?: string;
+    /**
+     * 签署流程编号 (PathType=1时必传)
+     */
+    FlowId?: string;
+    /**
+     * 跳转页面 1: 小程序合同详情 2: 小程序合同列表页 0: 不传, 默认主页
+     */
+    PathType?: number;
+    /**
+     * 是否自动回跳 true：是， false：否。该参数只针对"APP" 类型的签署链接有效
+     */
+    AutoJumpBack?: boolean;
+    /**
+     * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+     */
+    Agent?: Agent;
+}
 /**
  * 自动签开启、签署相关配置
  */
@@ -1057,6 +1170,23 @@ export interface UserThreeFactor {
      */
     IdCardNumber: string;
 }
+/**
+ * 一码多扫签署二维码对象
+ */
+export interface SignQrCode {
+    /**
+     * 二维码id
+     */
+    QrCodeId: string;
+    /**
+     * 二维码url
+     */
+    QrCodeUrl: string;
+    /**
+     * 二维码过期时间
+     */
+    ExpiredTime: number;
+}
 /**
  * CreateSealPolicy返回参数结构体
  */
@@ -1174,21 +1304,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返回参数结构体
@@ -1294,7 +1420,7 @@ export interface DescribeFileUrlsRequest {
  * 电子文档的控件填充信息。按照控件类型进行相应的填充。
 
 【数据表格传参说明】
-当模板的 ComponentType='DYNAMIC_TABLE'时（渠道版或集成版），FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
+当模板的 ComponentType='DYNAMIC_TABLE'时，FormField.ComponentValue需要传递json格式的字符串参数，用于确定表头&填充数据表格（支持内容的单元格合并）
 输入示例1：
 
 ```
@@ -1491,7 +1617,7 @@ export interface Staff {
         */
     Email?: string;
     /**
-        * 用户在第三方平台id
+        * 用户在第三方平台id，如需在此接口提醒员工实名，该参数不传
   注意：此字段可能返回 null，表示取不到有效值。
         */
     OpenId?: string;
@@ -1523,6 +1649,14 @@ export interface Staff {
   注意：此字段可能返回 null，表示取不到有效值。
         */
     QuiteJob?: number;
+    /**
+     * 员工离职交接人用户id
+     */
+    ReceiveUserId?: string;
+    /**
+     * 员工离职交接人用户OpenId
+     */
+    ReceiveOpenId?: string;
 }
 /**
  * CreateFlowEvidenceReport返回参数结构体
@@ -1632,13 +1766,17 @@ export interface GroupOrganization {
     FlowEngineEnable?: boolean;
 }
 /**
- * 授权用户
+ * DeleteIntegrationRoleUsers返回参数结构体
  */
-export interface AuthorizedUser {
+export interface DeleteIntegrationRoleUsersResponse {
     /**
-     * 用户id
+     * 角色id
      */
-    UserId: string;
+    RoleId?: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
 }
 /**
  * CreateDocument请求参数结构体
@@ -1699,6 +1837,19 @@ export interface RemindFlowRecords {
      */
     RemindMessage: string;
 }
+/**
+ * CreatePreparedPersonalEsign返回参数结构体
+ */
+export interface CreatePreparedPersonalEsignResponse {
+    /**
+     * 导入生成的印章ID
+     */
+    SealId?: string;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeOrganizationSeals返回参数结构体
  */
@@ -1728,23 +1879,35 @@ export interface DeleteIntegrationEmployeesRequest {
      * 待移除员工的信息，userId和openId二选一，必填一个
      */
     Employees: Array<Staff>;
+    /**
+     * 代理信息
+     */
+    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请求参数结构体
@@ -1787,12 +1950,33 @@ export interface CreateIntegrationEmployeesResponse {
     /**
      * 创建员工的结果
      */
-    CreateEmployeeResult: CreateStaffResult;
+    CreateEmployeeResult?: CreateStaffResult;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
     RequestId?: string;
 }
+/**
+ * DeleteIntegrationRoleUsers请求参数结构体
+ */
+export interface DeleteIntegrationRoleUsersRequest {
+    /**
+     * 操作人
+     */
+    Operator: UserInfo;
+    /**
+     * 角色id
+     */
+    RoleId: string;
+    /**
+     * 用户信息
+     */
+    Users: Array<UserInfo>;
+    /**
+     * 代理信息
+     */
+    Agent?: Agent;
+}
 /**
  * CreateFlowSignUrl请求参数结构体
  */
@@ -1837,6 +2021,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)描述的是合同(流程)的详细信息
  */
@@ -1883,6 +2088,23 @@ export interface FlowDetailInfo {
      */
     FlowApproverInfos: Array<FlowApproverDetail>;
 }
+/**
+ * 更新员工信息成功返回的数据信息
+ */
+export interface SuccessUpdateStaffData {
+    /**
+     * 传入的用户名称
+     */
+    DisplayName?: string;
+    /**
+     * 传入的手机号
+     */
+    Mobile?: string;
+    /**
+     * 用户Id
+     */
+    UserId?: string;
+}
 /**
  * CreateFlowByFiles返回参数结构体
  */
@@ -1938,6 +2160,11 @@ export interface SuccessCreateStaffData {
      * 员工在电子签平台的id
      */
     UserId: string;
+    /**
+        * 提示，当创建已存在未实名用户时，改字段有值
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Note?: string;
 }
 /**
  * 签署参与者信息
@@ -2001,7 +2228,7 @@ export interface Recipient {
  */
 export interface VerifyPdfRequest {
     /**
-     * 合同Id，流程Id
+     * 流程ID
      */
     FlowId: string;
     /**
@@ -2009,6 +2236,21 @@ export interface VerifyPdfRequest {
      */
     Operator?: UserInfo;
 }
+/**
+ * 绑定角色失败信息
+ */
+export interface FailedCreateRoleData {
+    /**
+        * 用户userId
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    UserId?: string;
+    /**
+        * 角色id列表
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    RoleIds?: Array<string>;
+}
 /**
  * 参与者信息
  */
@@ -2167,17 +2409,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;
 }
 /**
  * 指定签署人限制项
@@ -2320,6 +2566,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返回参数结构体
  */
@@ -2618,7 +2894,7 @@ export interface Component {
   CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
   FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID；
   DYNAMIC_TABLE - 动态表格控件；
-  ATTACHMENT - 附件控件,ComponentValue 填写福建图片的资源 ID列表，以逗号分割；
+  ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割；
   SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容；
   DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串；
   DISTRICT - 省市区行政区划控件，ComponentValue填写省市区行政区划字符串内容；
@@ -2787,7 +3063,7 @@ export interface Component {
      */
     ComponentDateFontSize?: number;
     /**
-     * 渠道版控件 id 标识
+     * 平台模板控件 id 标识
      */
     ChannelComponentId?: string;
     /**
@@ -2799,7 +3075,7 @@ export interface Component {
      */
     OffsetY?: number;
     /**
-     * //渠道子客控件来源。0-渠道指定；1-用户自定义
+     * //子客控件来源。0-平台指定；1-用户自定义
      */
     ChannelComponentSource?: number;
     /**
@@ -2820,6 +3096,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请求参数结构体
  */
@@ -2833,6 +3134,23 @@ export interface CreateFlowRemindsRequest {
      */
     FlowIds: Array<string>;
 }
+/**
+ * UpdateIntegrationEmployees请求参数结构体
+ */
+export interface UpdateIntegrationEmployeesRequest {
+    /**
+     * 操作人信息
+     */
+    Operator: UserInfo;
+    /**
+     * 代理信息
+     */
+    Agent: Agent;
+    /**
+     * 员工信息
+     */
+    Employees: Array<Staff>;
+}
 /**
  * DescribeFlowBriefs请求参数结构体
  */
@@ -2857,7 +3175,7 @@ export interface DeleteIntegrationEmployeesResponse {
     /**
      * 员工删除数据
      */
-    DeleteEmployeeResult: DeleteStaffsResult;
+    DeleteEmployeeResult?: DeleteStaffsResult;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
@@ -2887,16 +3205,15 @@ export interface VerifyPdfResponse {
     /**
      * 验签结果，1-文件未被篡改，全部签名在腾讯电子签完成； 2-文件未被篡改，部分签名在腾讯电子签完成；3-文件被篡改；4-异常：文件内没有签名域；5-异常：文件签名格式错误
      */
-    VerifyResult: number;
+    VerifyResult?: number;
     /**
-        * 验签结果详情,内部状态1-验签成功，在电子签签署；2-验签成功，在其他平台签署；3-验签失败；4-pdf文件没有签名域
-  ；5-文件签名格式错误
-        */
-    PdfVerifyResults: Array<PdfVerifyResult>;
+     * 验签结果详情,内部状态1-验签成功，在电子签签署；2-验签成功，在其他平台签署；3-验签失败；4-pdf文件没有签名域；5-文件签名格式错误
+     */
+    PdfVerifyResults?: Array<PdfVerifyResult>;
     /**
      * 验签序列号
      */
-    VerifySerialNo: string;
+    VerifySerialNo?: string;
     /**
      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */