tencentcloud-sdk-nodejs-ess 4.0.1027 → 4.0.1029

package/README.md

@@ -1,21 +1,20 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。
-为方便 NODEJS 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 NODEJS 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
+欢迎使用腾讯云开发者工具套件（SDK），Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
+为方便 Node.js 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 Node.js 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
 
 # 依赖环境
 
-1. NODEJS 10.0.0 版本及以上
-2. 从腾讯云控制台 开通相应产品
-3. 获取 SecretID、SecretKey 以及调用地址（endpoint），endpoint 一般形式为\*.tencentcloudapi.com，如 CVM 的调用地址为 cvm.tencentcloudapi.com，具体参考各产品说明。
+1. Node.js 10.0.0 版本及以上。
+2. 注意：部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
 
 # 获取安装
 
-安装 NODEJS SDK 前，先获取安全凭证。在第一次使用云 API 之前，用户首先需要在腾讯云控制台上申请安全凭证，安全凭证包括 SecretID 和 SecretKey， SecretID 是用于标识 API 调用者的身份，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。
+使用 SDK 需要 API 密钥，可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请，API 密钥包括 SecretID 和 SecretKey，密钥须严格保管，避免泄露。
 
-## 通过 NPM 安装
+## 通过 npm 安装
 
-通过 NPM 获取安装是使用 NODEJS SDK 的推荐方法，NPM 是 NODEJS 的包管理工具。关于 NPM 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
+通过 npm 获取安装是使用 Node.js SDK 的推荐方法，关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
 
 ### 安装指定产品 SDK（推荐）
 
@@ -56,10 +55,12 @@ npm install tencentcloud-sdk-nodejs --save
 1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
 2. 解压源码包到您项目合适的位置，例如 `sdk/tencentcloud-sdk-nodejs`。
 3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
-4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入SDK，具体可参考示例。
+4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK，具体可参考示例。
 
 # 示例
 
+以云服务器产品查询可用区列表接口为例。
+
 ```js
 const tencentcloud = require("tencentcloud-sdk-nodejs")
 
@@ -102,7 +103,7 @@ client.DescribeZones().then(
 )
 ```
 
-在支持 typescript 项目中，采用如下方式调用
+在支持 TypeScript 项目中，采用如下方式调用
 
 ```js
 import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -112,10 +113,11 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 // ...
 ```
 
-实例化`Client` 的入参支持 `clientConfig` 数据结构和说明 详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
+实例化 `Client` 的入参支持 `clientConfig`，数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
 
 ## Common Client
-从 4.0.714 版本开始腾讯云 NODEJS SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
+
+从 4.0.714 版本开始，腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
 
 **注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
 
@@ -123,19 +125,19 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 
 ## 更多示例
 
-更丰富的使用 demo 请在 examples 目录中寻找。
+请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
 
 # 相关配置
 
 ## 代理
 
-如果是有代理的环境下，需要配置代理，请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
+如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
 
 # 凭证管理
 
 除显式传入凭证外，从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
 
-在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
+在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
 ```javascript
 // ...
 const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
@@ -147,20 +149,16 @@ new XxxClient({
 })
 ```
 
-# 旧版 SDK
-
-我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
-
 # 常见问题
-- webpack打包出错/浏览器报错
+- webpack 打包出错/浏览器报错
 
-  请**务必不要**将此SDK直接用于web前端(包括小程序等)，暴露密钥在这些环境非常不安全。
+  请**务必不要**将此 SDK 直接用于 Web 前端（包括小程序等），暴露密钥在这些环境非常不安全。
 
-  正确的做法是在自己的服务端引用此SDK，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
+  正确的做法是在自己的服务端引用此 SDK，并保存好密钥，做好请求鉴权，前端再调用服务端执行业务流程。
 
 - `The "original" argument must be of type Function.`
 
-  通常是因为nodejs版本低于 `v10` ，或处于非node环境，请再次确认执行环境。
+  通常是因为 Node.js 版本低于 `v10` ，或处于非 Node.js 环境，请再次确认执行环境。
 
 - 请求不通
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-ess",
-  "version": "4.0.1027",
+  "version": "4.0.1029",
   "description": "Tencent Cloud API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

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

@@ -23,6 +23,7 @@ import {
   BillUsageDetail,
   DescribeCancelFlowsTaskResponse,
   IntentionActionResult,
+  DescribeFileCounterSignResultRequest,
   CreateSealRequest,
   FlowGroupUrlInfo,
   CancelFlowResponse,
@@ -32,13 +33,14 @@ import {
   CreatePreparedPersonalEsignRequest,
   CreateLegalSealQrCodeResponse,
   DescribeIntegrationDepartmentsResponse,
+  CreateFileCounterSignRequest,
   FileInfo,
   DescribeOrganizationVerifyStatusResponse,
   DeleteExtendedServiceAuthInfosResponse,
   CreateDynamicFlowApproverRequest,
   CreateFlowApproversResponse,
   DescribeFileUrlsResponse,
-  CreateExtendedServiceAuthInfosRequest,
+  CreateFlowRemindsRequest,
   IntentionQuestionResult,
   CancelUserAutoSignEnableUrlRequest,
   AuthInfoDetail,
@@ -179,12 +181,13 @@ import {
   CreateDocumentRequest,
   RemindFlowRecords,
   CreatePreparedPersonalEsignResponse,
+  VerifyDigitFileResponse,
   DescribeOrganizationSealsResponse,
   CreateUserMobileChangeUrlRequest,
   RegistrationOrganizationInfo,
   CreateEmbedWebUrlRequest,
   DeleteIntegrationEmployeesRequest,
-  FailedUpdateStaffData,
+  DescribeUserAutoSignStatusRequest,
   GetTaskResultApiRequest,
   FlowGroupOptions,
   DescribeFlowBriefsResponse,
@@ -233,6 +236,7 @@ import {
   CreatePrepareFlowResponse,
   ModifyIntegrationDepartmentResponse,
   GetTaskResultApiResponse,
+  FailedUpdateStaffData,
   DescribeOrganizationVerifyStatusRequest,
   SubOrgBillSummary,
   DeleteStaffsResult,
@@ -240,7 +244,8 @@ import {
   DeleteIntegrationDepartmentRequest,
   CancelUserAutoSignEnableUrlResponse,
   ModifyApplicationCallbackInfoRequest,
-  DescribeUserAutoSignStatusRequest,
+  CreateFileCounterSignResponse,
+  VerifyDigitFileResult,
   StartFlowRequest,
   CreateSealResponse,
   CreatePrepareFlowRequest,
@@ -250,7 +255,7 @@ import {
   ModifyExtendedServiceResponse,
   CreateFlowGroupByTemplatesRequest,
   FlowGroupApproverInfo,
-  DescribeOrganizationSealsRequest,
+  DescribeFileCounterSignResultResponse,
   PermissionGroup,
   CancelFlowRequest,
   UploadFile,
@@ -259,7 +264,8 @@ import {
   DescribeExtendedServiceAuthInfosRequest,
   DescribeIntegrationRolesResponse,
   CreateBatchSignUrlRequest,
-  CreateFlowRemindsRequest,
+  CreateExtendedServiceAuthInfosRequest,
+  VerifyDigitFileRequest,
   UpdateIntegrationEmployeesRequest,
   FlowGroupApprovers,
   DescribeFlowBriefsRequest,
@@ -279,6 +285,7 @@ import {
   DescribeFlowTemplatesResponse,
   DescribeBatchOrganizationRegistrationUrlsResponse,
   UploadFilesRequest,
+  DescribeOrganizationSealsRequest,
   DescribePersonCertificateRequest,
   RelieveInfo,
   UserFlowType,
@@ -618,6 +625,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("CreateFlowGroupByTemplates", req, cb)
   }
 
+  /**
+   * 对加签后的文件进行数字签名验证，判断数字签名是否有效。
+   */
+  async VerifyDigitFile(
+    req: VerifyDigitFileRequest,
+    cb?: (error: string, rep: VerifyDigitFileResponse) => void
+  ): Promise<VerifyDigitFileResponse> {
+    return this.request("VerifyDigitFile", req, cb)
+  }
+
   /**
      * 创建一个用于他方自动签授权的链接（可选择他方授权或我方授权）。通过这个链接，合作方企业可以直接进入小程序，进行自动签授权操作。
 
@@ -2004,6 +2021,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("DescribeFlowEvidenceReport", req, cb)
   }
 
+  /**
+     * 文件CA加签任务结果查询接口，用于查询 CreateFileCounterSign接口 发起的异步加签任务。
+
+注意：`此接口为『数字文件CA加签服务』白名单功能，使用前请联系对接的客户经理沟通。`
+     */
+  async DescribeFileCounterSignResult(
+    req: DescribeFileCounterSignResultRequest,
+    cb?: (error: string, rep: DescribeFileCounterSignResultResponse) => void
+  ): Promise<DescribeFileCounterSignResultResponse> {
+    return this.request("DescribeFileCounterSignResult", req, cb)
+  }
+
   /**
      * 此接口（GetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
 前提条件：已调用 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换，并得到了返回的转换任务Id。<br />
@@ -2119,6 +2148,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     return this.request("DescribeThirdPartyAuthCode", req, cb)
   }
 
+  /**
+     * 此接口用于发起数字文件CA加签操作。可以使用同步或者异步模式进行。
+
+**注意： 1. 文件类型暂时仅支持PDF类型文件。2. 此接口为『数字文件CA加签服务』白名单功能，使用前请联系对接的客户经理沟通。**
+     */
+  async CreateFileCounterSign(
+    req: CreateFileCounterSignRequest,
+    cb?: (error: string, rep: CreateFileCounterSignResponse) => void
+  ): Promise<CreateFileCounterSignResponse> {
+    return this.request("CreateFileCounterSign", req, cb)
+  }
+
   /**
      * 查询企业印章列表。