tencentcloud-sdk-nodejs 4.0.374 → 4.0.377

package/tencentcloud/services/dlc/v20210125/dlc_client.js

@@ -159,6 +159,12 @@ class Client extends abstract_client_1.AbstractClient {
     async DeleteUsersFromWorkGroup(req, cb) {
         return this.request("DeleteUsersFromWorkGroup", req, cb);
     }
+    /**
+     * 上报元数据心跳
+     */
+    async ReportHeartbeatMetaData(req, cb) {
+        return this.request("ReportHeartbeatMetaData", req, cb);
+    }
     /**
      * 创建工作组
      */

package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts

@@ -140,10 +140,47 @@ export interface CreateStoreLocationResponse {
       */
     RequestId?: string;
 }
+/**
+ * ReportHeartbeatMetaData请求参数结构体
+ */
+export interface ReportHeartbeatMetaDataRequest {
+    /**
+      * 数据源名称
+      */
+    DatasourceConnectionName?: string;
+    /**
+      * 锁ID
+      */
+    LockId?: number;
+    /**
+      * 事务ID
+      */
+    TxnId?: number;
+}
 /**
  * DescribeDMSDatabase返回参数结构体
  */
 export interface DescribeDMSDatabaseResponse {
+    /**
+      * 数据库名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Name: string;
+    /**
+      * schema名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    SchemaName: string;
+    /**
+      * 存储地址
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Location: string;
+    /**
+      * 数据对象
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Asset: Asset;
     /**
       * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
       */
@@ -152,7 +189,20 @@ export interface DescribeDMSDatabaseResponse {
 /**
  * DropDMSDatabase请求参数结构体
  */
-export declare type DropDMSDatabaseRequest = null;
+export interface DropDMSDatabaseRequest {
+    /**
+      * 数据库名称
+      */
+    Name: string;
+    /**
+      * 是否删除数据
+      */
+    DeleteData?: boolean;
+    /**
+      * 是否级联删除
+      */
+    Cascade?: boolean;
+}
 /**
  * CreateScript返回参数结构体
  */
@@ -872,7 +922,68 @@ export interface CheckLockMetaDataRequest {
 /**
  * 元数据基本对象
  */
-export declare type Asset = null;
+export interface Asset {
+    /**
+      * 主键
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Id?: number;
+    /**
+      * 名称
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Name?: string;
+    /**
+      * 对象GUID值
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Guid?: string;
+    /**
+      * 数据目录
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+    Catalog?: string;
+    /**
+      * 描述信息
+      */
+    Description?: string;
+    /**
+      * 对象owner
+      */
+    Owner?: string;
+    /**
+      * 对象owner账户
+      */
+    OwnerAccount?: string;
+    /**
+      * 权限
+      */
+    PermValues?: Array<KVPair>;
+    /**
+      * 附加属性
+      */
+    Params?: Array<KVPair>;
+    /**
+      * 附加业务属性
+      */
+    BizParams?: Array<KVPair>;
+    /**
+      * 数据版本
+      */
+    DataVersion?: number;
+    /**
+      * 创建时间
+      */
+    CreateTime?: string;
+    /**
+      * 修改时间
+      */
+    ModifiedTime?: string;
+    /**
+      * 数据源主键
+      */
+    DatasourceId?: number;
+}
 /**
  * CreateDatabase返回参数结构体
  */
@@ -1199,6 +1310,10 @@ export interface DescribeDMSPartitionsRequest {
       * 页面数量
       */
     Limit?: number;
+    /**
+      * 表达式
+      */
+    Expression?: string;
 }
 /**
  * DescribeSparkAppJobs请求参数结构体
@@ -1518,6 +1633,15 @@ export interface CreateExportTaskRequest {
       */
     OutputType?: string;
 }
+/**
+ * ReportHeartbeatMetaData返回参数结构体
+ */
+export interface ReportHeartbeatMetaDataResponse {
+    /**
+      * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+      */
+    RequestId?: string;
+}
 /**
  * CreateDMSTable请求参数结构体
  */
@@ -2189,6 +2313,10 @@ export interface AlterDMSTableRequest {
       * 分区
       */
     Partitions?: Array<DMSPartition>;
+    /**
+      * 当前表名
+      */
+    Name?: string;
 }
 /**
  * CreateImportTask返回参数结构体
@@ -2832,7 +2960,20 @@ export interface UnbindWorkGroupsFromUserRequest {
 /**
  * DescribeDMSDatabase请求参数结构体
  */
-export declare type DescribeDMSDatabaseRequest = null;
+export interface DescribeDMSDatabaseRequest {
+    /**
+      * 数据库名称
+      */
+    Name?: string;
+    /**
+      * schema名称
+      */
+    SchemaName?: string;
+    /**
+      * 匹配规则
+      */
+    Pattern?: string;
+}
 /**
  * DescribeTable请求参数结构体
  */
@@ -3494,7 +3635,24 @@ export interface CheckLockMetaDataResponse {
 /**
  * AlterDMSDatabase请求参数结构体
  */
-export declare type AlterDMSDatabaseRequest = null;
+export interface AlterDMSDatabaseRequest {
+    /**
+      * 当前名称
+      */
+    CurrentName?: string;
+    /**
+      * schema名称
+      */
+    SchemaName?: string;
+    /**
+      * 路径
+      */
+    Location?: string;
+    /**
+      * 基础对象
+      */
+    Asset?: Asset;
+}
 /**
  *  SQL查询任务
  */
@@ -3560,6 +3718,18 @@ export interface AttachUserPolicyResponse {
  * CreateDMSDatabase请求参数结构体
  */
 export interface CreateDMSDatabaseRequest {
+    /**
+      * 基础元数据对象
+      */
+    Asset?: Asset;
+    /**
+      * Schema目录
+      */
+    SchemaName?: string;
+    /**
+      * Db存储路径
+      */
+    Location?: string;
     /**
       * 数据库名称
       */

package/tencentcloud/services/es/v20180416/es_models.d.ts

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

package/tencentcloud/services/ess/v20201111/ess_client.d.ts

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

package/tencentcloud/services/ess/v20201111/ess_client.js

@@ -29,12 +29,15 @@ class Client extends abstract_client_1.AbstractClient {
     }
     /**
      * 此接口用于发起流程
+适用场景：见创建签署流程接口。
+注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
      */
     async StartFlow(req, cb) {
         return this.request("StartFlow", req, cb);
     }
     /**
      * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
      */
     async CreateMultiFlowSignQRCode(req, cb) {
@@ -42,18 +45,22 @@ class Client extends abstract_client_1.AbstractClient {
     }
     /**
      * 用于撤销签署流程
+适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
+注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
      */
     async CancelFlow(req, cb) {
         return this.request("CancelFlow", req, cb);
     }
     /**
      * 创建电子文档
+适用场景：见创建签署流程接口。注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
      */
     async CreateDocument(req, cb) {
         return this.request("CreateDocument", req, cb);
     }
     /**
      * 查询文件下载URL
+适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
      */
     async DescribeFileUrls(req, cb) {
         return this.request("DescribeFileUrls", req, cb);
@@ -66,6 +73,8 @@ class Client extends abstract_client_1.AbstractClient {
     }
     /**
      * 创建签署流程
+适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
+注：改接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
      */
     async CreateFlow(req, cb) {
         return this.request("CreateFlow", req, cb);
@@ -79,6 +88,11 @@ class Client extends abstract_client_1.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>两种方式）
 
 
@@ -89,24 +103,30 @@ class Client extends abstract_client_1.AbstractClient {
     }
     /**
      * 二期接口-查询模板
+适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
      */
     async DescribeFlowTemplates(req, cb) {
         return this.request("DescribeFlowTemplates", req, cb);
     }
     /**
      * 查询流程摘要
+适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
      */
     async DescribeFlowBriefs(req, cb) {
         return this.request("DescribeFlowBriefs", req, cb);
     }
     /**
-     * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建签署流程。
+     * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
+适用场景1：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
+适用场景2：可通过改接口传入制式合同文件，同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件，建议使用模板功能生成模板ID进行合同流程的生成。
+注意事项：该接口需要依赖“多文件上传”接口生成pdf资源编号（FileIds）进行使用。
      */
     async CreateFlowByFiles(req, cb) {
         return this.request("CreateFlowByFiles", req, cb);
     }
     /**
      * 此接口（UploadFiles）用于文件上传。
+适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
 调用时需要设置Domain 为 file.ess.tencent.cn，设置Version为2020-12-22
      */
     async UploadFiles(req, cb) {

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -338,20 +338,17 @@ 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个文件
       */
@@ -361,14 +358,14 @@ export interface UploadFilesRequest {
       */
     FileUrls?: string;
     /**
-      * 是否将pdf灰色矩阵置白
+      * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
 true--是，处理置白
 false--否，不处理
       */
     CoverRect?: boolean;
     /**
-      * 特殊文件类型需要指定文件类型：
-HTML-- .html文件
+      * 文件类型， 默认通过文件内容解析得到文件类型，客户可以显示的说明上传文件的类型。
+如：PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
       */
     FileType?: string;
     /**

package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts

@@ -350,17 +350,45 @@ 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"：个人；
       */
-    JumpUrl?: string;
+    GenerateType?: string;
+    /**
+      * 非渠道合作企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
+      */
+    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;
     /**
       * 操作者的信息
       */