tencentcloud-sdk-nodejs 4.0.692 → 4.0.694

package/src/services/dlc/v20210125/dlc_models.ts

@@ -2010,29 +2010,24 @@ export interface ListTaskJobLogDetailRequest {
 }
 
 /**
- * 批量顺序执行任务集合
+ * SparkSQL批任务信息
  */
-export interface TasksInfo {
-  /**
-   * 任务类型，SQLTask：SQL查询任务。SparkSQLTask：Spark SQL查询任务
-   */
-  TaskType: string
-  /**
-   * 容错策略。Proceed：前面任务出错/取消后继续执行后面的任务。Terminate：前面的任务出错/取消之后终止后面任务的执行，后面的任务全部标记为已取消。
-   */
-  FailureTolerance: string
+export interface BatchSqlTask {
   /**
-   * base64加密后的SQL语句，用";"号分隔每个SQL语句，一次最多提交50个任务。严格按照前后顺序执行
+   * SQL子任务唯一标识
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  SQL: string
+  TaskId?: string
   /**
-   * 任务的配置信息，当前仅支持SparkSQLTask任务。
+   * 运行SQL
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  Config?: Array<KVPair>
+  ExecuteSQL?: string
   /**
-   * 任务的用户自定义参数信息
+   * 任务信息，成功则返回：Task Success!，失败则返回异常信息
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  Params?: Array<KVPair>
+  Message?: string
 }
 
 /**
@@ -2519,6 +2514,16 @@ export interface WorkGroupIdSetOfUserId {
   WorkGroupIds: Array<number | bigint>
 }
 
+/**
+ * DescribeSparkSessionBatchSQL请求参数结构体
+ */
+export interface DescribeSparkSessionBatchSQLRequest {
+  /**
+   * SparkSQL唯一标识
+   */
+  BatchId: string
+}
+
 /**
  * Kerberos详细信息
  */
@@ -4738,6 +4743,29 @@ export interface DeleteWorkGroupResponse {
   RequestId?: string
 }
 
+/**
+ * DescribeSparkSessionBatchSQL返回参数结构体
+ */
+export interface DescribeSparkSessionBatchSQLResponse {
+  /**
+   * 状态：0：运行中、1：成功、2：失败、3：取消、4：超时；
+   */
+  State?: number
+  /**
+   * SQL子任务列表，仅展示运行完成的子任务，若某个任务运行失败，后续其它子任务不返回
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Tasks?: Array<BatchSqlTask>
+  /**
+   * 非sql运行的异常事件信息，包含资源创建失败、调度异常，JOB超时等，正常运行下该Event值为空
+   */
+  Event?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * DropDMSTable返回参数结构体
  */
@@ -5125,6 +5153,32 @@ export interface DeleteUsersFromWorkGroupResponse {
   RequestId?: string
 }
 
+/**
+ * 批量顺序执行任务集合
+ */
+export interface TasksInfo {
+  /**
+   * 任务类型，SQLTask：SQL查询任务。SparkSQLTask：Spark SQL查询任务
+   */
+  TaskType: string
+  /**
+   * 容错策略。Proceed：前面任务出错/取消后继续执行后面的任务。Terminate：前面的任务出错/取消之后终止后面任务的执行，后面的任务全部标记为已取消。
+   */
+  FailureTolerance: string
+  /**
+   * base64加密后的SQL语句，用";"号分隔每个SQL语句，一次最多提交50个任务。严格按照前后顺序执行
+   */
+  SQL: string
+  /**
+   * 任务的配置信息，当前仅支持SparkSQLTask任务。
+   */
+  Config?: Array<KVPair>
+  /**
+   * 任务的用户自定义参数信息
+   */
+  Params?: Array<KVPair>
+}
+
 /**
  * CreateSparkSessionBatchSQL返回参数结构体
  */

package/src/services/ess/v20201111/ess_client.ts

@@ -18,6 +18,7 @@
 import { AbstractClient } from "../../../common/abstract_client"
 import { ClientConfig } from "../../../common/interface"
 import {
+  DescribePersonCertificateResponse,
   CreateSealRequest,
   ModifyIntegrationDepartmentResponse,
   CancelFlowResponse,
@@ -46,7 +47,7 @@ import {
   SealInfo,
   StaffRole,
   CreateIntegrationRoleRequest,
-  AuthorizedUser,
+  DeleteIntegrationRoleUsersResponse,
   CreateConvertTaskApiRequest,
   DeleteIntegrationEmployeesResponse,
   CreateBatchSignUrlResponse,
@@ -74,6 +75,7 @@ import {
   BindEmployeeUserIdWithClientOpenIdRequest,
   DescribeIntegrationDepartmentsRequest,
   Permission,
+  Staff,
   ComponentLimit,
   CreateIntegrationDepartmentResponse,
   DescribeFlowTemplatesRequest,
@@ -105,15 +107,16 @@ import {
   UserInfo,
   CreateFlowApproversRequest,
   ModifyIntegrationRoleResponse,
+  ExtendAuthInfo,
   FlowCreateApprover,
-  Staff,
+  ApproverComponentLimitType,
   RecipientComponentInfo,
   CreateFlowEvidenceReportResponse,
   CreateIntegrationRoleResponse,
   DescribeFlowComponentsRequest,
   CreateIntegrationDepartmentRequest,
   GroupOrganization,
-  DeleteIntegrationRoleUsersResponse,
+  AuthorizedUser,
   CreateDocumentRequest,
   RemindFlowRecords,
   CreatePreparedPersonalEsignResponse,
@@ -188,7 +191,7 @@ import {
   Caller,
   DescribeFlowTemplatesResponse,
   UploadFilesRequest,
-  ExtendAuthInfo,
+  DescribePersonCertificateRequest,
   RelieveInfo,
   EmbedUrlOption,
   CreateBatchCancelFlowUrlRequest,
@@ -216,7 +219,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100)
+     * 此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。
 
 适用场景：可用于主动查询某个合同详情信息。
      */
@@ -889,6 +892,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
     return this.request("DisableUserAutoSign", req, cb)
   }
 
+  /**
+   * 此接口（DescribePersonCertificate）用于查询个人数字证书信息。<br />注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`<br />`2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。`
+   */
+  async DescribePersonCertificate(
+    req: DescribePersonCertificateRequest,
+    cb?: (error: string, rep: DescribePersonCertificateResponse) => void
+  ): Promise<DescribePersonCertificateResponse> {
+    return this.request("DescribePersonCertificate", req, cb)
+  }
+
   /**
      * 通过AuthCode查询个人用户是否实名
 

package/src/services/ess/v20201111/ess_models.ts

@@ -15,6 +15,20 @@
  * under the License.
  */
 
+/**
+ * DescribePersonCertificate返回参数结构体
+ */
+export interface DescribePersonCertificateResponse {
+  /**
+   * 证书的Base64
+   */
+  Cert?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateSeal请求参数结构体
  */
@@ -747,13 +761,17 @@ export interface CreateIntegrationRoleRequest {
 }
 
 /**
- * 授权用户
+ * DeleteIntegrationRoleUsers返回参数结构体
  */
-export interface AuthorizedUser {
+export interface DeleteIntegrationRoleUsersResponse {
   /**
-   * 电子签系统中的用户id
+   * 角色id
    */
-  UserId: string
+  RoleId?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
 }
 
 /**
@@ -1749,6 +1767,86 @@ export interface Permission {
   Children?: Array<Permission>
 }
 
+/**
+ * 企业员工信息。
+ */
+export interface Staff {
+  /**
+   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+注：`创建和更新场景无需填写。`
+   */
+  UserId?: string
+  /**
+   * 显示的用户名/昵称。
+   */
+  DisplayName?: string
+  /**
+   * 用户手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
+   */
+  Mobile?: string
+  /**
+   * 用户邮箱。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Email?: string
+  /**
+   * 用户在第三方平台ID。
+注：`如需在此接口提醒员工实名，该参数不传。`
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OpenId?: string
+  /**
+   * 员工角色信息。
+注：`创建和更新场景无需填写。`
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Roles?: Array<StaffRole>
+  /**
+   * 员工部门信息。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Department?: Department
+  /**
+   * 员工是否实名。
+注：`创建和更新场景无需填写。`
+   */
+  Verified?: boolean
+  /**
+   * 员工创建时间戳，单位秒。
+注：`创建和更新场景无需填写。`
+   */
+  CreatedOn?: number
+  /**
+   * 员工实名时间戳，单位秒。
+注：`创建和更新场景无需填写。`
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  VerifiedOn?: number
+  /**
+   * 员工是否离职：
+<ul><li>**0**：未离职</li><li>**1**：离职</li></ul>
+注：`创建和更新场景无需填写。`
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  QuiteJob?: number
+  /**
+   * 员工离职交接人用户ID。
+注：`创建和更新场景无需填写。`
+   */
+  ReceiveUserId?: string
+  /**
+   * 员工离职交接人用户OpenId。
+注：`创建和更新场景无需填写。`
+   */
+  ReceiveOpenId?: string
+  /**
+   * 企业微信用户账号ID。
+注：`仅企微类型的企业创建员工接口支持该字段。`
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  WeworkOpenId?: string
+}
+
 /**
  * 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
  */
@@ -2906,6 +3004,46 @@ export interface ModifyIntegrationRoleResponse {
   RequestId?: string
 }
 
+/**
+ * 扩展服务开通和授权的详细信息
+ */
+export interface ExtendAuthInfo {
+  /**
+   * 扩展服务的类型，可能是以下值：
+<ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
+<li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+<li>PAGING_SEAL：骑缝章</li>
+<li>BATCH_SIGN：批量签署</li></ul>
+   */
+  Type?: string
+  /**
+   * 扩展服务的名称
+   */
+  Name?: string
+  /**
+   * 扩展服务的开通状态：
+ENABLE：开通
+DISABLE：未开通
+   */
+  Status?: string
+  /**
+   * 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OperatorUserId?: string
+  /**
+   * 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  OperateOn?: number
+  /**
+   * 该扩展服务若可以授权，此参数对应授权人员的列表
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  HasAuthUserList?: Array<HasAuthUser>
+}
+
 /**
  * 创建流程的签署方信息
  */
@@ -3102,83 +3240,25 @@ export interface FlowCreateApprover {
 }
 
 /**
- * 企业员工信息。
+ * 签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式
  */
-export interface Staff {
-  /**
-   * 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
-注：`创建和更新场景无需填写。`
-   */
-  UserId?: string
-  /**
-   * 显示的用户名/昵称。
-   */
-  DisplayName?: string
-  /**
-   * 用户手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
-   */
-  Mobile?: string
-  /**
-   * 用户邮箱。
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Email?: string
-  /**
-   * 用户在第三方平台ID。
-注：`如需在此接口提醒员工实名，该参数不传。`
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  OpenId?: string
-  /**
-   * 员工角色信息。
-注：`创建和更新场景无需填写。`
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Roles?: Array<StaffRole>
-  /**
-   * 员工部门信息。
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  Department?: Department
-  /**
-   * 员工是否实名。
-注：`创建和更新场景无需填写。`
-   */
-  Verified?: boolean
-  /**
-   * 员工创建时间戳，单位秒。
-注：`创建和更新场景无需填写。`
-   */
-  CreatedOn?: number
-  /**
-   * 员工实名时间戳，单位秒。
-注：`创建和更新场景无需填写。`
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  VerifiedOn?: number
-  /**
-   * 员工是否离职：
-<ul><li>**0**：未离职</li><li>**1**：离职</li></ul>
-注：`创建和更新场景无需填写。`
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  QuiteJob?: number
-  /**
-   * 员工离职交接人用户ID。
-注：`创建和更新场景无需填写。`
-   */
-  ReceiveUserId?: string
+export interface ApproverComponentLimitType {
   /**
-   * 员工离职交接人用户OpenId。
-注：`创建和更新场景无需填写。`
+   * 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
    */
-  ReceiveOpenId?: string
+  RecipientId: string
   /**
-   * 企业微信用户账号ID。
-注：`仅企微类型的企业创建员工接口支持该字段。`
-注意：此字段可能返回 null，表示取不到有效值。
+   * 签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式，可多选
+
+签名方式：
+<ul>
+<li>HANDWRITE-手写签名</li>
+<li>ESIGN-个人印章类型</li>
+<li>OCR_ESIGN-AI智能识别手写签名</li>
+<li>SYSTEM_ESIGN-系统签名</li>
+</ul>
    */
-  WeworkOpenId?: string
+  Values: Array<string>
 }
 
 /**
@@ -3390,17 +3470,13 @@ export interface GroupOrganization {
 }
 
 /**
- * DeleteIntegrationRoleUsers返回参数结构体
+ * 授权用户
  */
-export interface DeleteIntegrationRoleUsersResponse {
-  /**
-   * 角色id
-   */
-  RoleId?: string
+export interface AuthorizedUser {
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 电子签系统中的用户id
    */
-  RequestId?: string
+  UserId: string
 }
 
 /**
@@ -5793,7 +5869,7 @@ export interface DescribeFlowBriefsRequest {
 export interface CreateFlowGroupByTemplatesRequest {
   /**
    * 执行本接口操作的员工信息。
-注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
@@ -6008,43 +6084,32 @@ true--是，处理置白
 }
 
 /**
- * 扩展服务开通和授权的详细信息
+ * DescribePersonCertificate请求参数结构体
  */
-export interface ExtendAuthInfo {
-  /**
-   * 扩展服务的类型，可能是以下值：
-<ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
-<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
-<li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
-<li>PAGING_SEAL：骑缝章</li>
-<li>BATCH_SIGN：批量签署</li></ul>
-   */
-  Type?: string
+export interface DescribePersonCertificateRequest {
   /**
-   * 扩展服务的名称
-   */
-  Name?: string
-  /**
-   * 扩展服务的开通状态：
-ENABLE：开通
-DISABLE：未开通
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
-  Status?: string
+  Operator: UserInfo
   /**
-   * 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
-注意：此字段可能返回 null，表示取不到有效值。
+   * 个人用户的三要素信息：
+<ul><li>姓名</li>
+<li>证件号</li>
+<li>证件类型</li></ul>
    */
-  OperatorUserId?: string
+  UserInfo: UserThreeFactor
   /**
-   * 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
-注意：此字段可能返回 null，表示取不到有效值。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
-  OperateOn?: number
+  Agent?: Agent
   /**
-   * 该扩展服务若可以授权，此参数对应授权人员的列表
-注意：此字段可能返回 null，表示取不到有效值。
+   * 证书使用场景，可以选择的场景值如下:
+<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
+注: `现在仅支持电子处方场景`
    */
-  HasAuthUserList?: Array<HasAuthUser>
+  SceneKey?: string
 }
 
 /**
@@ -6179,6 +6244,10 @@ export interface CreateMultiFlowSignQRCodeRequest {
    * @deprecated
    */
   ApproverRestrictions?: ApproverRestriction
+  /**
+   * 指定签署方在使用个人印章签署控件（SIGN_SIGNATURE） 时可使用的签署方式：自由书写、正楷临摹、系统签名、个人印章。
+   */
+  ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>
 }
 
 /**
@@ -6190,9 +6259,8 @@ export interface DescribeFlowInfoRequest {
    */
   Operator?: UserInfo
   /**
-   * 需要查询的流程ID列表，限制最大100个
-
-如果查询合同组的信息,不要传此参数
+   * 需要查询的流程ID列表，最多可传入100个ID。
+如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
    */
   FlowIds?: Array<string>
   /**
@@ -6200,9 +6268,7 @@ export interface DescribeFlowInfoRequest {
    */
   Agent?: Agent
   /**
-   * 合同组ID, 如果传此参数会忽略FlowIds入参
- 所以如传此参数不要传FlowIds参数
-
+   * 需要查询的流程组ID，如果传入此参数，则会忽略 FlowIds 参数。该合同组由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
    */
   FlowGroupId?: string
 }
@@ -6212,15 +6278,16 @@ export interface DescribeFlowInfoRequest {
  */
 export interface DescribeFlowInfoResponse {
   /**
-   * 签署流程信息
+   * 合同流程的详细信息。
+如果查询的是合同组信息，则返回的是组内所有子合同流程的详细信息。
    */
   FlowDetailInfos?: Array<FlowDetailInfo>
   /**
-   * 合同组ID，为32位字符串
+   * 合同组ID，只有在查询合同组信息时才会返回。
    */
   FlowGroupId?: string
   /**
-   * 合同组名称
+   * 合同组名称，只有在查询合同组信息时才会返回。
    */
   FlowGroupName?: string
   /**

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -79,6 +79,7 @@ import {
   CreateChannelFlowEvidenceReportRequest,
   ChannelCancelUserAutoSignEnableUrlRequest,
   Permission,
+  Staff,
   ComponentLimit,
   ChannelVerifyPdfResponse,
   CreateConsoleLoginUrlRequest,
@@ -98,7 +99,7 @@ import {
   UserInfo,
   TaskInfo,
   ChannelCreateBoundFlowsResponse,
-  Staff,
+  ApproverComponentLimitType,
   ResourceUrlInfo,
   ChannelCreateBoundFlowsRequest,
   ChannelDescribeEmployeesRequest,