tencentcloud-sdk-nodejs 4.0.818 → 4.0.820

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

@@ -265,13 +265,13 @@ export interface CreateSealRequest {
 }
 
 /**
- * ModifyIntegrationDepartment返回参数结构体
+ * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
  */
-export interface ModifyIntegrationDepartmentResponse {
+export interface FlowGroupUrlInfo {
   /**
-   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   * 合同组子合同和签署方的信息，用于补充动态签署人。
    */
-  RequestId?: string
+  FlowGroupApproverInfos?: Array<FlowGroupApproverInfo>
 }
 
 /**
@@ -953,6 +953,80 @@ export interface CreateFlowOption {
 
    */
   CustomCreateFlowDescription?: string
+  /**
+   *   禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
+
+   */
+  ForbidAddApprover?: string
+  /**
+   *   禁止设置设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
+
+   */
+  ForbidEditFlowProperties?: string
+  /**
+   * 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用，具体的控件类型如下
+<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
+<li>SIGN_SEAL : 企业印章</li>
+<li>SIGN_PAGING_SEAL : 骑缝章</li>
+<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
+<li>SIGN_APPROVE : 签批</li>
+<li>SIGN_OPINION : 签署意见</li>
+<li>BUSI-FULL-NAME  : 企业全称</li>
+<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
+<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
+<li>PERSONAL-NAME : 签署人姓名</li>
+<li>PERSONAL-MOBILE : 签署人手机号</li>
+<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
+<li>PERSONAL-IDCARD : 签署人证件号</li>
+<li>TEXT : 单行文本</li>
+<li>MULTI_LINE_TEXT : 多行文本</li>
+<li>CHECK_BOX : 勾选框</li>
+<li>SELECTOR : 选择器</li>
+<li>DIGIT : 数字</li>
+<li>DATE : 日期</li>
+<li>FILL_IMAGE : 图片</li>
+<li>ATTACHMENT : 附件</li>
+<li>EMAIL : 邮箱</li>
+<li>LOCATION : 地址</li>
+<li>EDUCATION : 学历</li>
+<li>GENDER : 性别</li>
+<li>DISTRICT : 省市区</li></ul>
+   */
+  HideComponentTypes?: Array<string>
+  /**
+   * 在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用，具体的控件类型如下
+<ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
+<li>SIGN_SEAL : 企业印章</li>
+<li>SIGN_PAGING_SEAL : 骑缝章</li>
+<li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
+<li>SIGN_APPROVE : 签批</li>
+<li>SIGN_OPINION : 签署意见</li>
+<li>BUSI-FULL-NAME  : 企业全称</li>
+<li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
+<li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
+<li>PERSONAL-NAME : 签署人姓名</li>
+<li>PERSONAL-MOBILE : 签署人手机号</li>
+<li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
+<li>PERSONAL-IDCARD : 签署人证件号</li>
+<li>TEXT : 单行文本</li>
+<li>MULTI_LINE_TEXT : 多行文本</li>
+<li>CHECK_BOX : 勾选框</li>
+<li>SELECTOR : 选择器</li>
+<li>DIGIT : 数字</li>
+<li>DATE : 日期</li>
+<li>FILL_IMAGE : 图片</li>
+<li>ATTACHMENT : 附件</li>
+<li>EMAIL : 邮箱</li>
+<li>LOCATION : 地址</li>
+<li>EDUCATION : 学历</li>
+<li>GENDER : 性别</li>
+<li>DISTRICT : 省市区</li></ul>
+   */
+  ShowComponentTypes?: Array<string>
+  /**
+   * 发起流程的可嵌入页面结果页配置
+   */
+  ResultPageConfig?: Array<CreateResultPageConfig>
 }
 
 /**
@@ -1683,6 +1757,10 @@ export interface CreateFlowGroupByTemplatesResponse {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowIds?: Array<string>
+  /**
+   * 合同组签署人信息。
+   */
+  Approvers?: Array<FlowGroupApprovers>
   /**
    * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
    */
@@ -2159,6 +2237,10 @@ export interface CreateSchemeUrlRequest {
 注：`生成动态签署人补充链接时必传。`
    */
   RecipientId?: string
+  /**
+   * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+   */
+  FlowGroupUrlInfo?: FlowGroupUrlInfo
 }
 
 /**
@@ -2775,6 +2857,10 @@ WEWORKAPP: 企业微信
 注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
    */
   ApproverIdCardNumber?: string
+  /**
+   * 合同流程ID，补充合同组子合同动态签署人时必传。
+   */
+  FlowId?: string
 }
 
 /**
@@ -3973,12 +4059,6 @@ export interface CreateFlowApproversRequest {
 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
-  /**
-   * 合同流程ID，为32位字符串。
-建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
-   */
-  FlowId: string
   /**
    * 补充企业签署人信息。
 
@@ -3987,6 +4067,12 @@ export interface CreateFlowApproversRequest {
 - 如果不指定，则使用姓名和手机号进行补充。
    */
   Approvers: Array<FillApproverInfo>
+  /**
+   * 合同流程ID，为32位字符串。
+建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+   */
+  FlowId?: string
   /**
    * 签署人信息补充方式
 
@@ -4004,6 +4090,10 @@ export interface CreateFlowApproversRequest {
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
+  /**
+   * 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
+   */
+  FlowGroupId?: string
 }
 
 /**
@@ -4944,6 +5034,10 @@ export interface CreateFlowGroupByFilesResponse {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowIds?: Array<string>
+  /**
+   * 合同组签署方信息。
+   */
+  Approvers?: Array<FlowGroupApprovers>
   /**
    * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
    */
@@ -5460,12 +5554,12 @@ export interface ApproverInfo {
    * 签署方经办人的姓名。
 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
    */
-  ApproverName: string
+  ApproverName?: string
   /**
    * 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
 请确认手机号所有方为此合同签署方。
    */
-  ApproverMobile: string
+  ApproverMobile?: string
   /**
    * 组织机构名称。
 请确认该名称与企业营业执照中注册的名称一致。
@@ -6033,6 +6127,16 @@ export interface CreatePrepareFlowResponse {
   RequestId?: string
 }
 
+/**
+ * ModifyIntegrationDepartment返回参数结构体
+ */
+export interface ModifyIntegrationDepartmentResponse {
+  /**
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * GetTaskResultApi返回参数结构体
  */
@@ -6350,6 +6454,10 @@ export interface ApproverOption {
 <li> **true** :不可以转他人处理</li></ul>
    */
   NoTransfer?: boolean
+  /**
+   * 允许编辑签署人信息（嵌入式使用） 默认true-可以编辑 false-不可以编辑
+   */
+  CanEditApprover?: boolean
   /**
    * 签署人信息补充类型，默认无需补充。
 
@@ -6461,6 +6569,20 @@ export interface CreateSealPolicyRequest {
   Agent?: Agent
 }
 
+/**
+ * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+ */
+export interface FlowGroupApproverInfo {
+  /**
+   * 合同流程ID。
+   */
+  FlowId?: string
+  /**
+   * 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
+   */
+  RecipientId?: string
+}
+
 /**
  * DescribeOrganizationSeals请求参数结构体
  */
@@ -7085,6 +7207,22 @@ export interface UpdateIntegrationEmployeesRequest {
   Endpoint?: string
 }
 
+/**
+ * 合同组签署方信息
+ */
+export interface FlowGroupApprovers {
+  /**
+   * 合同流程ID 
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FlowId?: string
+  /**
+   * 签署方信息，包含合同ID和角色ID用于定位RecipientId。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Approvers?: Array<ApproverItem>
+}
+
 /**
  * DescribeFlowBriefs请求参数结构体
  */
@@ -8147,3 +8285,23 @@ export interface IntentionQuestion {
    */
   Answers?: Array<string>
 }
+
+/**
+ * 发起流程的可嵌入页面操作结果页配置
+ */
+export interface CreateResultPageConfig {
+  /**
+   * <ul>
+  <li>0 : 发起审批成功页面（通过接口<a href="https://qian.tencent.com/developers/companyApis/embedPages/CreatePrepareFlow/" target="_blank">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true）</li>
+</ul>
+   */
+  Type: number
+  /**
+   * 结果页标题，不超过50字
+   */
+  Title: string
+  /**
+   * 结果页描述，不超过200字
+   */
+  Description?: string
+}

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

@@ -24,6 +24,7 @@ import {
   Component,
   ChannelDeleteSealPoliciesRequest,
   ChannelBatchCancelFlowsResponse,
+  FlowGroupUrlInfo,
   ChannelDescribeSignFaceVideoRequest,
   ChannelDisableUserAutoSignResponse,
   DescribeExtendedServiceAuthDetailResponse,
@@ -91,6 +92,7 @@ import {
   ChannelCreateOrganizationBatchSignUrlRequest,
   GetDownloadFlowUrlResponse,
   ChannelRole,
+  FlowGroupApproverInfo,
   Recipient,
   DescribeTemplatesResponse,
   AutoSignConfig,
@@ -205,6 +207,7 @@ import {
   ChannelBatchCancelFlowsRequest,
   CreateChannelOrganizationInfoChangeUrlRequest,
   ChannelModifyRoleRequest,
+  FlowGroupApprovers,
   ModifyFlowDeadlineRequest,
   ChannelUpdateSealStatusRequest,
   ChannelCreateFlowGroupByTemplatesRequest,

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

@@ -373,6 +373,16 @@ export interface ChannelBatchCancelFlowsResponse {
   RequestId?: string
 }
 
+/**
+ * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+ */
+export interface FlowGroupUrlInfo {
+  /**
+   * 合同组子合同和签署方的信息，用于补充动态签署人。
+   */
+  FlowGroupApproverInfos?: Array<FlowGroupApproverInfo>
+}
+
 /**
  * ChannelDescribeSignFaceVideo请求参数结构体
  */
@@ -499,6 +509,10 @@ export interface ChannelCreateFlowGroupByTemplatesResponse {
 如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
    */
   TaskInfos?: Array<TaskInfo>
+  /**
+   * 合同组签署方信息
+   */
+  Approvers?: Array<FlowGroupApprovers>
   /**
    * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
    */
@@ -2519,6 +2533,20 @@ export interface ChannelRole {
   PermissionGroups?: Array<PermissionGroup>
 }
 
+/**
+ * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+ */
+export interface FlowGroupApproverInfo {
+  /**
+   * 合同流程ID。
+   */
+  FlowId?: string
+  /**
+   * 签署节点ID，用于生成动态签署人链接完成领取。注：`生成动态签署人补充链接时必传。`
+   */
+  RecipientId?: string
+}
+
 /**
  * 流程中签署方和填写方(如果有填写控件存证时)的信息
  */
@@ -3466,6 +3494,10 @@ export interface FillApproverInfo {
 注：`补充个人签署方时，若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
    */
   ApproverIdCardNumber?: string
+  /**
+   * 合同流程ID，补充合同组子合同动态签署人时必传。
+   */
+  FlowId?: string
 }
 
 /**
@@ -4536,6 +4568,10 @@ export interface CreateSignUrlsRequest {
 注：`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`，
    */
   RecipientIds?: Array<string>
+  /**
+   * 合同组相关信息，指定合同组子合同和签署方的信息，用于补充动态签署人。
+   */
+  FlowGroupUrlInfo?: FlowGroupUrlInfo
 }
 
 /**
@@ -6064,6 +6100,10 @@ export interface ChannelCreateFlowGroupByFilesResponse {
 注意：此字段可能返回 null，表示取不到有效值。
    */
   FlowIds?: Array<string>
+  /**
+   * 合同组签署方信息。
+   */
+  Approvers?: Array<FlowGroupApprovers>
   /**
    * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
    */
@@ -6617,6 +6657,22 @@ export interface ChannelModifyRoleRequest {
   PermissionGroups?: Array<PermissionGroup>
 }
 
+/**
+ * 合同组签署方信息
+ */
+export interface FlowGroupApprovers {
+  /**
+   * 合同流程ID
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FlowId?: string
+  /**
+   * 签署方信息，包含合同ID和角色ID用于定位RecipientId。
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Approvers?: Array<ApproverItem>
+}
+
 /**
  * ModifyFlowDeadline请求参数结构体
  */
@@ -7826,10 +7882,6 @@ export interface ChannelCreateFlowApproversRequest {
 第三方平台子客企业和员工必须已经经过实名认证
    */
   Agent: Agent
-  /**
-   * 合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
-   */
-  FlowId: string
   /**
    * 补充企业签署人信息。
 
@@ -7838,6 +7890,10 @@ export interface ChannelCreateFlowApproversRequest {
 - 如果不指定，则使用姓名和手机号进行补充。
    */
   Approvers: Array<FillApproverInfo>
+  /**
+   * 合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+   */
+  FlowId?: string
   /**
    * 签署人信息补充方式
 
@@ -7848,6 +7904,10 @@ export interface ChannelCreateFlowApproversRequest {
    * 操作人信息
    */
   Operator?: UserInfo
+  /**
+   * 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
+   */
+  FlowGroupId?: string
 }
 
 /**

package/src/services/faceid/v20180301/faceid_client.ts

@@ -20,6 +20,7 @@ import { ClientConfig } from "../../../common/interface"
 import {
   AttackRiskDetail,
   ExtraInfo,
+  GetFaceidRiskInfoTokenResponse,
   CheckIdNameDateResponse,
   IdCardVerificationRequest,
   ImageRecognitionV2Response,
@@ -27,13 +28,13 @@ import {
   IntentionQuestionResult,
   RuleIdConfig,
   MobileStatusRequest,
-  GetActionSequenceResponse,
+  ParseNfcDataResponse,
   LivenessRecognitionRequest,
   CheckEidTokenStatusResponse,
   EidInfo,
   DetectAuthRequest,
   CheckEidTokenStatusRequest,
-  ParseNfcDataResponse,
+  GetFaceIdRiskInfoResponse,
   LivenessCompareResponse,
   BankCard2EVerificationResponse,
   MobileStatusResponse,
@@ -83,6 +84,7 @@ import {
   GetDetectInfoResponse,
   IdCardOCRVerificationResponse,
   IdCardVerificationResponse,
+  GetActionSequenceRequest,
   GetDetectInfoEnhancedRequest,
   LivenessRecognitionResponse,
   GetLiveCodeRequest,
@@ -93,6 +95,7 @@ import {
   CheckPhoneAndNameResponse,
   GetFaceIdTokenRequest,
   IntentionActionResult,
+  GetFaceidRiskInfoTokenRequest,
   BankCard2EVerificationRequest,
   ImageRecognitionV2Request,
   PhoneVerificationCTCCResponse,
@@ -101,7 +104,8 @@ import {
   PhoneVerificationCTCCRequest,
   ImageRecognitionRequest,
   BankCard4EVerificationRequest,
-  GetActionSequenceRequest,
+  GetActionSequenceResponse,
+  GetFaceIdRiskInfoRequest,
   GetLiveCodeResponse,
   GetDetectInfoRequest,
   DetectInfoIdCardData,
@@ -130,13 +134,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 使用动作活体检测模式前，需调用本接口获取动作顺序。
+   * 完成验证后，用FaceIdToken调用本接口获取设备风险相关信息，FaceIdToken生成后三天内（3\*24\*3,600秒）可多次拉取。
    */
-  async GetActionSequence(
-    req: GetActionSequenceRequest,
-    cb?: (error: string, rep: GetActionSequenceResponse) => void
-  ): Promise<GetActionSequenceResponse> {
-    return this.request("GetActionSequence", req, cb)
+  async GetFaceIdRiskInfo(
+    req: GetFaceIdRiskInfoRequest,
+    cb?: (error: string, rep: GetFaceIdRiskInfoResponse) => void
+  ): Promise<GetFaceIdRiskInfoResponse> {
+    return this.request("GetFaceIdRiskInfo", req, cb)
   }
 
   /**
@@ -189,6 +193,16 @@ export class Client extends AbstractClient {
     return this.request("EncryptedPhoneVerification", req, cb)
   }
 
+  /**
+   * 使用动作活体检测模式前，需调用本接口获取动作顺序。
+   */
+  async GetActionSequence(
+    req: GetActionSequenceRequest,
+    cb?: (error: string, rep: GetActionSequenceResponse) => void
+  ): Promise<GetActionSequenceResponse> {
+    return this.request("GetActionSequence", req, cb)
+  }
+
   /**
    * 完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3\*24\*3,600秒）可多次拉取。
    */
@@ -320,6 +334,16 @@ export class Client extends AbstractClient {
     return this.request("MobileStatus", req, cb)
   }
 
+  /**
+   * 本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。
+   */
+  async CheckIdNameDate(
+    req: CheckIdNameDateRequest,
+    cb?: (error: string, rep: CheckIdNameDateResponse) => void
+  ): Promise<CheckIdNameDateResponse> {
+    return this.request("CheckIdNameDate", req, cb)
+  }
+
   /**
    * 本接口用于校验中国移动手机号、姓名和身份证号的真实性和一致性。中国移动支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
    */
@@ -341,13 +365,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。
+   * 每次调用人脸核身SDK服务前，需先调用本接口获取SDKToken，用来串联核身流程，在验证完成后，用于获取风险结果信息，该Token仅能核身一次。
    */
-  async CheckIdNameDate(
-    req: CheckIdNameDateRequest,
-    cb?: (error: string, rep: CheckIdNameDateResponse) => void
-  ): Promise<CheckIdNameDateResponse> {
-    return this.request("CheckIdNameDate", req, cb)
+  async GetFaceidRiskInfoToken(
+    req: GetFaceidRiskInfoTokenRequest,
+    cb?: (error: string, rep: GetFaceidRiskInfoTokenResponse) => void
+  ): Promise<GetFaceidRiskInfoTokenResponse> {
+    return this.request("GetFaceidRiskInfoToken", req, cb)
   }
 
   /**