tencentcloud-sdk-nodejs 4.0.375 → 4.0.378

package/src/services/es/v20180416/es_models.ts

@@ -163,6 +163,18 @@ export interface NodeInfo {
    * 节点磁盘是否加密 0: 不加密，1: 加密；默认不加密
    */
   DiskEncrypt?: number
+
+  /**
+      * cpu数目
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  CpuNum?: number
+
+  /**
+      * 内存大小，单位GB
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MemSize?: number
 }
 
 /**

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

@@ -72,8 +72,10 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 此接口用于发起流程
-   */
+     * 此接口用于发起流程
+适用场景：见创建签署流程接口。
+注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
+     */
   async StartFlow(
     req: StartFlowRequest,
     cb?: (error: string, rep: StartFlowResponse) => void
@@ -83,6 +85,7 @@ export class Client extends AbstractClient {
 
   /**
      * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
      */
   async CreateMultiFlowSignQRCode(
@@ -93,8 +96,10 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 用于撤销签署流程
-   */
+     * 用于撤销签署流程
+适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
+注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
+     */
   async CancelFlow(
     req: CancelFlowRequest,
     cb?: (error: string, rep: CancelFlowResponse) => void
@@ -103,8 +108,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 创建电子文档
-   */
+     * 创建电子文档
+适用场景：见创建签署流程接口。注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
+     */
   async CreateDocument(
     req: CreateDocumentRequest,
     cb?: (error: string, rep: CreateDocumentResponse) => void
@@ -113,8 +119,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 查询文件下载URL
-   */
+     * 查询文件下载URL
+适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
+     */
   async DescribeFileUrls(
     req: DescribeFileUrlsRequest,
     cb?: (error: string, rep: DescribeFileUrlsResponse) => void
@@ -133,8 +140,10 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 创建签署流程
-   */
+     * 创建签署流程
+适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
+注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
+     */
   async CreateFlow(
     req: CreateFlowRequest,
     cb?: (error: string, rep: CreateFlowResponse) => void
@@ -155,6 +164,11 @@ export class Client extends AbstractClient {
   /**
      * 获取小程序跳转链接
 
+适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
+
+注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
+
+
 跳转到小程序的实现，参考官方文档（分为<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>两种方式）
 
 
@@ -168,8 +182,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 二期接口-查询模板
-   */
+     * 二期接口-查询模板
+适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
+     */
   async DescribeFlowTemplates(
     req: DescribeFlowTemplatesRequest,
     cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
@@ -178,8 +193,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 查询流程摘要
-   */
+     * 查询流程摘要
+适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
+     */
   async DescribeFlowBriefs(
     req: DescribeFlowBriefsRequest,
     cb?: (error: string, rep: DescribeFlowBriefsResponse) => void
@@ -188,8 +204,11 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建签署流程。
-   */
+     * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
+适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
+适用场景2：可通过改接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
+注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
+     */
   async CreateFlowByFiles(
     req: CreateFlowByFilesRequest,
     cb?: (error: string, rep: CreateFlowByFilesResponse) => void
@@ -199,6 +218,7 @@ export class Client extends AbstractClient {
 
   /**
      * 此接口（UploadFiles）用于文件上传。
+适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
 调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
      */
   async UploadFiles(

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

@@ -421,22 +421,19 @@ export interface SignQrCode {
  * UploadFiles请求参数结构体
  */
 export interface UploadFilesRequest {
-  /**
-   * 调用方信息
-   */
-  Caller: Caller
-
   /**
       * 文件对应业务类型，用于区分文件存储路径：
 1. TEMPLATE - 模板； 文件类型：.pdf/.html
 2. DOCUMENT - 签署过程及签署后的合同文档 文件类型：.pdf/.html
-3. FLOW - 签署过程 文件类型：.pdf/.html
-4. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
-5. BUSINESSLICENSE - 营业执照 文件类型：.jpg/.jpeg/.png
-6. IDCARD - 身份证 文件类型：.jpg/.jpeg/.png
+3. SEAL - 印章； 文件类型：.jpg/.jpeg/.png
       */
   BusinessType: string
 
+  /**
+   * 调用方信息
+   */
+  Caller?: Caller
+
   /**
    * 上传文件内容数组，最多支持20个文件
    */
@@ -448,15 +445,15 @@ export interface UploadFilesRequest {
   FileUrls?: string
 
   /**
-      * 是否将pdf灰色矩阵置白
+      * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
 true--是，处理置白
 false--否，不处理
       */
   CoverRect?: boolean
 
   /**
-      * 特殊文件类型需要指定文件类型：
-HTML-- .html文件
+      * 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
+如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
       */
   FileType?: string
 

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

@@ -164,7 +164,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 创建参与者签署短链
+   * 创建跳转小程序查看或签署的链接
    */
   async CreateSignUrls(
     req: CreateSignUrlsRequest,

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

@@ -434,20 +434,54 @@ export interface CreateSignUrlsRequest {
   FlowIds: Array<string>
 
   /**
-   * 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序。
+   * 签署链接类型：“WEIXINAPP”-直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；默认“WEIXINAPP”类型，即跳转至小程序；
    */
   Endpoint?: string
 
   /**
-   * 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
+      * 签署链接生成类型，默认是 "ALL"；
+"ALL"：全部签署方签署链接；
+"CHANNEL"：渠道合作企业；
+"NOT_CHANNEL"：非渠道合作企业；
+"PERSON"：个人；
+      */
+  GenerateType?: string
+
+  /**
+   * 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
    */
-  JumpUrl?: string
+  OrganizationName?: string
+
+  /**
+   * 参与人姓名，GenerateType为"PERSON"时必填
+   */
+  Name?: string
+
+  /**
+   * 参与人手机号，GenerateType为"PERSON"时必填
+   */
+  Mobile?: string
+
+  /**
+   * 渠道合作企业的企业Id，GenerateType为"CHANNEL"时必填
+   */
+  OrganizationOpenId?: string
+
+  /**
+   * 渠道合作企业参与人OpenId，GenerateType为"CHANNEL"时可用，指定到具体参与人
+   */
+  OpenId?: string
 
   /**
    * Endpoint为"APP" 类型的签署链接，可以设置此值；支持调用方小程序打开签署链接，在电子签小程序完成签署后自动回跳至调用方小程序
    */
   AutoJumpBack?: boolean
 
+  /**
+   * 签署完之后的H5页面的跳转链接，针对Endpoint为CHANNEL时有效，最大长度1000个字符。
+   */
+  JumpUrl?: string
+
   /**
    * 操作者的信息
    */
@@ -1203,9 +1237,15 @@ export interface UsageDetail {
   Date: string
 
   /**
-   * 消耗量
+   * 消耗数量
    */
   Usage: number
+
+  /**
+      * 撤回数量
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Cancel: number
 }
 
 /**
@@ -1444,7 +1484,7 @@ export interface ChannelCreateFlowByFilesResponse {
  */
 export interface UploadFilesResponse {
   /**
-   * 文件id数组
+   * 文件id数组，有效期一个小时
    */
   FileIds: Array<string>
 

package/src/services/ie/v20200304/ie_client.ts

@@ -19,6 +19,7 @@ import { AbstractClient } from "../../../common/abstract_client"
 import { ClientConfig } from "../../../common/interface"
 import {
   VideoSuperResolution,
+  DynamicImageInfo,
   MediaJoiningTaskResult,
   Denoise,
   StripTaskResultItem,
@@ -65,6 +66,7 @@ import {
   ResultVideoInfo,
   PicMarkInfoItem,
   MediaJoiningInfo,
+  MediaCuttingWatermarkText,
   DescribeMediaQualityRestorationTaskRusultRequest,
   ColorEnhance,
   SegmentInfo,
@@ -104,6 +106,7 @@ import {
   TagTaskResult,
   AudioEnhance,
   CosInfo,
+  MediaCuttingWatermarkImage,
   MediaResultInfo,
   FrameTagResult,
   TextMarkInfoItem,
@@ -118,6 +121,7 @@ import {
   CoverEditingInfo,
   SubtitleItem,
   DescribeMediaProcessTaskResultRequest,
+  SpriteImageInfo,
   MediaProcessTaskResult,
   EditingTaskResult,
   MediaProcessInfo,
@@ -125,6 +129,7 @@ import {
   TagItem,
   DescribeMediaProcessTaskResultResponse,
   HighlightsTaskResultItemSegment,
+  MediaCuttingWatermark,
 } from "./ie_models"
 
 /**