tencentcloud-sdk-nodejs 4.0.352 → 4.0.355

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

@@ -431,7 +431,7 @@ export interface DetachUserPolicyRequest {
  */
 export interface DescribeSparkAppTasksResponse {
   /**
-      * 任务列表
+      * 任务结果（该字段已废弃）
 注意：此字段可能返回 null，表示取不到有效值。
       */
   Tasks: TaskResponseInfo
@@ -441,6 +441,12 @@ export interface DescribeSparkAppTasksResponse {
    */
   TotalCount: number
 
+  /**
+      * 任务结果列表
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SparkAppTasks: Array<TaskResponseInfo>
+
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */

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

@@ -20,6 +20,7 @@ import { ClientConfig } from "../../../common/interface"
 import {
   UploadFile,
   DescribeFileUrlsResponse,
+  TemplateInfo,
   CreateDocumentResponse,
   StartFlowRequest,
   CancelFlowResponse,
@@ -36,16 +37,21 @@ import {
   DescribeThirdPartyAuthCodeResponse,
   CreateFlowByFilesResponse,
   DescribeFlowBriefsRequest,
+  Recipient,
   DescribeFileUrlsRequest,
   ApproverInfo,
   Caller,
-  StartFlowResponse,
+  DescribeFlowTemplatesResponse,
+  Filter,
+  FileInfo,
   FlowCreateApprover,
+  StartFlowResponse,
   CreateSchemeUrlResponse,
   CreateFlowByFilesRequest,
   CreateFlowResponse,
   Agent,
   FormField,
+  DescribeFlowTemplatesRequest,
   UserInfo,
   FlowBrief,
   CcInfo,
@@ -100,6 +106,16 @@ export class Client extends AbstractClient {
     return this.request("DescribeFileUrls", req, cb)
   }
 
+  /**
+   * 通过AuthCode查询用户是否实名
+   */
+  async DescribeThirdPartyAuthCode(
+    req: DescribeThirdPartyAuthCodeRequest,
+    cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void
+  ): Promise<DescribeThirdPartyAuthCodeResponse> {
+    return this.request("DescribeThirdPartyAuthCode", req, cb)
+  }
+
   /**
    * 创建签署流程
    */
@@ -111,8 +127,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 获取小程序跳转链接
-   */
+     * 获取小程序跳转链接
+
+跳转到小程序的实现，参考官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式）
+
+
+如您需要自主配置小程序跳转链接，请参考: <a href="https://tcloud-doc.isd.com/document/product/1323/74774">跳转小程序链接配置说明</a>
+     */
   async CreateSchemeUrl(
     req: CreateSchemeUrlRequest,
     cb?: (error: string, rep: CreateSchemeUrlResponse) => void
@@ -121,13 +142,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 通过AuthCode查询用户是否实名
+   * 二期接口-查询模板
    */
-  async DescribeThirdPartyAuthCode(
-    req: DescribeThirdPartyAuthCodeRequest,
-    cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void
-  ): Promise<DescribeThirdPartyAuthCodeResponse> {
-    return this.request("DescribeThirdPartyAuthCode", req, cb)
+  async DescribeFlowTemplates(
+    req: DescribeFlowTemplatesRequest,
+    cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
+  ): Promise<DescribeFlowTemplatesResponse> {
+    return this.request("DescribeFlowTemplates", req, cb)
   }
 
   /**

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

@@ -50,6 +50,81 @@ export interface DescribeFileUrlsResponse {
   RequestId?: string
 }
 
+/**
+ * 二期接口返回的模板的信息结构
+ */
+export interface TemplateInfo {
+  /**
+   * 模板ID
+   */
+  TemplateId?: string
+
+  /**
+   * 模板名字
+   */
+  TemplateName?: string
+
+  /**
+   * 模板描述信息
+   */
+  Description?: string
+
+  /**
+   * 模板关联的资源IDs
+   */
+  DocumentResourceIds?: Array<string>
+
+  /**
+   * 返回的文件信息结构
+   */
+  FileInfos?: Array<FileInfo>
+
+  /**
+   * 附件关联的资源ID是
+   */
+  AttachmentResourceIds?: Array<string>
+
+  /**
+   * 签署顺序
+   */
+  SignOrder?: Array<number>
+
+  /**
+   * 签署参与者的信息
+   */
+  Recipients?: Array<Recipient>
+
+  /**
+   * 模板信息结构
+   */
+  Components?: Array<Component>
+
+  /**
+   * 签署区模板信息结构
+   */
+  SignComponents?: Array<Component>
+
+  /**
+   * 模板状态(-1:不可用；0:草稿态；1:正式态)
+   */
+  Status?: number
+
+  /**
+   * 模板的创建人
+   */
+  Creator?: string
+
+  /**
+   * 模板创建的时间戳（精确到秒）
+   */
+  CreatedOn?: number
+
+  /**
+   * 发起人角色信息
+   */
+  Promoter?: Recipient
+}
+
 /**
  * CreateDocument返回参数结构体
  */
@@ -252,8 +327,11 @@ export interface CreateSchemeUrlRequest {
   OrganizationName?: string
 
   /**
-   * 链接类型 HTTP：跳转电子签小程序的http_url，APP：第三方APP或小程序跳转电子签小程序，默认为HTTP类型
-   */
+      * 链接类型
+HTTP：跳转电子签小程序的http_url，
+APP：第三方APP或小程序跳转电子签小程序的path。
+默认为HTTP类型
+      */
   EndPoint?: string
 
   /**
@@ -565,6 +643,76 @@ export interface DescribeFlowBriefsRequest {
   Agent?: Agent
 }
 
+/**
+ * 签署参与者信息
+ */
+export interface Recipient {
+  /**
+   * 签署参与者ID
+   */
+  RecipientId?: string
+
+  /**
+   * 参与者类型（ENTERPRISE/INDIVIDUAL）
+   */
+  RecipientType?: string
+
+  /**
+   * 描述信息
+   */
+  Description?: string
+
+  /**
+   * 角色名称
+   */
+  RoleName?: string
+
+  /**
+   * 是否需要验证，默认为false
+   */
+  RequireValidation?: boolean
+
+  /**
+   * 是否需要签署，默认为true
+   */
+  RequireSign?: boolean
+
+  /**
+   * 添加序列
+   */
+  RoutingOrder?: number
+
+  /**
+   * 是否需要发送，默认为true
+   */
+  RequireDelivery?: boolean
+
+  /**
+   * 邮箱地址
+   */
+  Email?: string
+
+  /**
+   * 电话号码
+   */
+  Mobile?: string
+
+  /**
+   * 关联的用户ID
+   */
+  UserId?: string
+
+  /**
+   * 发送方式（EMAIL/MOBILE）
+   */
+  DeliveryMethod?: string
+
+  /**
+   * 附属信息
+   */
+  RecipientExtra?: string
+}
+
 /**
  * DescribeFileUrls请求参数结构体
  */
@@ -722,13 +870,18 @@ export interface Caller {
 }
 
 /**
- * StartFlow返回参数结构体
+ * DescribeFlowTemplates返回参数结构体
  */
-export interface StartFlowResponse {
+export interface DescribeFlowTemplatesResponse {
   /**
-   * 返回描述，START-发起成功， REVIEW-提交审核成功，EXECUTING-已提交发起任务
+   * 模板详情列表
    */
-  Status: string
+  Templates: Array<TemplateInfo>
+
+  /**
+   * 查询到的总个数
+   */
+  TotalCount: number
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -736,6 +889,46 @@ export interface StartFlowResponse {
   RequestId?: string
 }
 
+/**
+ * 查询过滤条件
+ */
+export interface Filter {
+  /**
+   * 查询过滤条件的Key
+   */
+  Key: string
+
+  /**
+   * 查询过滤条件的Value列表
+   */
+  Values: Array<string>
+}
+
+/**
+ * 二期接口返回的模板中文件的信息结构
+ */
+export interface FileInfo {
+  /**
+   * 文件Id
+   */
+  FileId?: string
+
+  /**
+   * 文件名
+   */
+  FileName?: string
+
+  /**
+   * 文件大小，单位为Byte
+   */
+  FileSize?: number
+
+  /**
+   * 文件上传时间，10位时间戳（精确到秒）
+   */
+  CreatedOn?: number
+}
+
 /**
  * 创建流程的签署方信息
  */
@@ -814,6 +1007,21 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
   VerifyChannel?: Array<string>
 }
 
+/**
+ * StartFlow返回参数结构体
+ */
+export interface StartFlowResponse {
+  /**
+   * 返回描述，START-发起成功， REVIEW-提交审核成功，EXECUTING-已提交发起任务
+   */
+  Status: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CreateSchemeUrl返回参数结构体
  */
@@ -940,6 +1148,46 @@ export interface FormField {
   ComponentName?: string
 }
 
+/**
+ * DescribeFlowTemplates请求参数结构体
+ */
+export interface DescribeFlowTemplatesRequest {
+  /**
+   * 操作人信息
+   */
+  Operator: UserInfo
+
+  /**
+   * 查询偏移位置，默认0
+   */
+  Offset?: number
+
+  /**
+   * 查询个数，默认20，最大100
+   */
+  Limit?: number
+
+  /**
+   * 搜索条件，具体参考Filter结构体。本接口取值：template-id：按照【 **模板唯一标识** 】进行过滤
+   */
+  Filters?: Array<Filter>
+
+  /**
+   * 应用相关信息
+   */
+  Agent?: Agent
+
+  /**
+   * 暂未开放
+   */
+  GenerateSource?: number
+
+  /**
+   * 查询内容：0-模板列表及详情（默认），1-仅模板列表
+   */
+  ContentType?: number
+}
+
 /**
  * 用户信息
  */

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

@@ -330,6 +330,21 @@ export interface DescribeTemplatesResponse {
    */
   Templates: Array<TemplateInfo>
 
+  /**
+   * 查询总数
+   */
+  TotalCount: number
+
+  /**
+   * 查询数量
+   */
+  Limit: number
+
+  /**
+   * 查询起始偏移
+   */
+  Offset: number
+
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -870,6 +885,21 @@ export interface DescribeTemplatesRequest {
    * 模板唯一标识
    */
   TemplateId?: string
+
+  /**
+   * 查询内容：0-模版列表及详情（默认），1-仅模版列表
+   */
+  ContentType?: number
+
+  /**
+   * 查询个数，默认20，最大100
+   */
+  Limit?: number
+
+  /**
+   * 查询偏移位置，默认0
+   */
+  Offset?: number
 }
 
 /**

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

@@ -36,6 +36,7 @@ import {
   CheckIdCardInformationResponse,
   GetDetectInfoEnhancedResponse,
   PhoneVerificationRequest,
+  PhoneVerificationCMCCRequest,
   GetEidResultRequest,
   DetectAuthResponse,
   PhoneVerificationResponse,
@@ -47,6 +48,7 @@ import {
   MobileStatusRequest,
   DetectReflectLivenessAndCompareResponse,
   GetRealNameAuthTokenRequest,
+  ParseNfcDataResponse,
   CheckIdNameDateRequest,
   BankCard2EVerificationRequest,
   LivenessRecognitionRequest,
@@ -60,7 +62,7 @@ import {
   PhoneVerificationCTCCRequest,
   IdCardOCRVerificationResponse,
   ChargeDetail,
-  PhoneVerificationCMCCRequest,
+  ParseNfcDataRequest,
   LivenessResponse,
   CheckIdCardInformationRequest,
   DetectInfoText,
@@ -373,6 +375,16 @@ export class Client extends AbstractClient {
     return this.request("LivenessRecognition", req, cb)
   }
 
+  /**
+   * 解析SDK获取到的证件NFC数据，接口传入SDK返回的ReqId，返回证件信息（个别字段为特定证件类型特有）。SDK生成的ReqId五分钟内有效，重复查询仅收一次费。支持身份证类证件（二代身份证、港澳居住证、台湾居住证、外国人永居证）以及旅行类证件（港澳通行证、台湾通行证、台胞证、回乡证）的NFC识别及核验。
+   */
+  async ParseNfcData(
+    req: ParseNfcDataRequest,
+    cb?: (error: string, rep: ParseNfcDataResponse) => void
+  ): Promise<ParseNfcDataResponse> {
+    return this.request("ParseNfcData", req, cb)
+  }
+
   /**
    * 传入姓名和身份证号，校验两者的真实性和一致性。
    */

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

@@ -556,6 +556,31 @@ export interface PhoneVerificationRequest {
   Iv?: string
 }
 
+/**
+ * PhoneVerificationCMCC请求参数结构体
+ */
+export interface PhoneVerificationCMCCRequest {
+  /**
+   * 身份证号
+   */
+  IdCard: string
+
+  /**
+   * 姓名
+   */
+  Name: string
+
+  /**
+   * 手机号
+   */
+  Phone: string
+
+  /**
+   * 敏感数据加密信息。对传入信息（姓名、身份证号、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。
+   */
+  Encryption?: Encryption
+}
+
 /**
  * GetEidResult请求参数结构体
  */
@@ -875,6 +900,138 @@ export interface GetRealNameAuthTokenRequest {
   CallbackURL: string
 }
 
+/**
+ * ParseNfcData返回参数结构体
+ */
+export interface ParseNfcDataResponse {
+  /**
+      * 0为首次查询成功，-1为查询失败。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ResultCode: string
+
+  /**
+      * 身份证号
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdNum: string
+
+  /**
+      * 姓名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Name: string
+
+  /**
+      * 照片
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Picture: string
+
+  /**
+      * 出生日期
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  BirthDate: string
+
+  /**
+      * 有效期起始时间
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  BeginTime: string
+
+  /**
+      * 有效期结束时间
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  EndTime: string
+
+  /**
+      * 住址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Address: string
+
+  /**
+      * 民族
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Nation: string
+
+  /**
+      * 性别
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Sex: string
+
+  /**
+      * 身份证 01 中国护照 03 军官证 04 武警证 05 港澳通行证 06 台胞证 07 外国护照 08 士兵证 09 临时身份证 10 户口本 11 警官证 12 外国人永久居留证 13 港澳台居民居住证 14 回乡证 15 大陆居民来往台湾通行证 16 其他证件 99
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IdType: string
+
+  /**
+      * 英文姓名
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  EnName: string
+
+  /**
+      * 签发机关
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  SigningOrganization: string
+
+  /**
+      * 港澳台居民居住证，通行证号码
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  OtherIdNum: string
+
+  /**
+      * 旅行证件国籍
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Nationality: string
+
+  /**
+      * 旅行证件机读区第二行 29~42 位
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  PersonalNumber: string
+
+  /**
+      * 旅行证件类的核验结果。JSON格式如下：
+{"result_issuer ":"签发者证书合法性验证结果 ","result_pape r":"证件安全对象合法性验证 结果 ","result_data" :"防数据篡改验证结果 ","result_chip" :"防证书件芯片被复制验证结果"} 
+ 0:验证通过，1: 验证不通过，2: 未验证，3:部分通过，当4项核验结果都为0时，表示证件为真
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CheckMRTD: string
+
+  /**
+      * 身份证照片面合成图片
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ImageA: string
+
+  /**
+      * 身份证国徽面合成图片
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ImageB: string
+
+  /**
+      * 对result code的结果描述
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  ResultDescription: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * CheckIdNameDate请求参数结构体
  */
@@ -1314,28 +1471,13 @@ export interface ChargeDetail {
 }
 
 /**
- * PhoneVerificationCMCC请求参数结构体
+ * ParseNfcData请求参数结构体
  */
-export interface PhoneVerificationCMCCRequest {
+export interface ParseNfcDataRequest {
   /**
-   * 身份证号
+   * 前端SDK返回
    */
-  IdCard: string
-
-  /**
-   * 姓名
-   */
-  Name: string
-
-  /**
-   * 手机号
-   */
-  Phone: string
-
-  /**
-   * 敏感数据加密信息。对传入信息（姓名、身份证号、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。
-   */
-  Encryption?: Encryption
+  ReqId: string
 }
 
 /**