tencentcloud-sdk-nodejs-lowcode 4.0.781 → 4.0.1039

package/README.md

@@ -1,36 +1,66 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。目前已经支持 cvm、vpc、cbs 等产品，后续所有的云服务产品都会接入进来。新版 SDK 实现了统一化，具有各个语言版本的 SDK 使用方法相同，接口调用方式相同，统一的错误码和返回包格式这些优点。
-为方便 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/) 。
 
-1. 执行以下安装命令：
-   > npm install tencentcloud-sdk-nodejs --save
-2. 在您的代码中引用对应模块代码，可参考示例。
-3. 如上引用方式会将腾讯云所有产品sdk下载到本地，可以将tencentcloud-sdk-nodejs换成tencentcloud-sdk-nodejs-cvm/cbs/vpc等，即可引用特定产品的sdk，代码中可将require("tencentcloud-sdk-nodejs")改为require("tencentcloud-sdk-nodejs-cvm/cbs/vpc")，其余不变，可参考示例，可大大节省存储空间。
+### 安装指定产品 SDK（推荐）
+
+安装 CVM SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-cvm --save
+```
+
+安装 VPC SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-vpc --save
+```
+
+具体产品的缩写表请参考 [products.md](./products.md) 中的包名字段。
+
+安装指定产品 SDK 后，注意修改引入的包名：
+
+```diff
+- const tencentcloud = require("tencentcloud-sdk-nodejs")
++ const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
+
+- const CvmClient = tencentcloud.cvm.v20170312.Client
++ const CvmClient = cvm.v20170312.Client
+```
+
+### 安装全产品 SDK
+
+```
+npm install tencentcloud-sdk-nodejs --save
+```
+
+全产品 SDK 包含了所有云产品的调用代码，体积偏大，对体积敏感的场景，推荐安装指定产品 SDK。
 
 ## 通过源码包安装
 
-1. 前往 [Github 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
+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")
 
@@ -53,6 +83,9 @@ const client = new CvmClient({
     httpProfile: {
       reqMethod: "POST", // 请求方法
       reqTimeout: 30, // 请求超时时间，默认60s
+      headers: {
+        // 自定义 header
+      },
       // proxy: "http://127.0.0.1:8899" // http请求代理
     },
   },
@@ -70,7 +103,7 @@ client.DescribeZones().then(
 )
 ```
 
-在支持 typescript 项目中，采用如下方式调用
+在支持 TypeScript 项目中，采用如下方式调用
 
 ```js
 import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -80,23 +113,31 @@ 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 版本开始，腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
+
+**注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
+
+详细使用请参阅示例：[使用 Common Client 进行调用](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples/common)
 
 ## 更多示例
 
-更丰富的使用 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
@@ -108,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 环境，请再次确认执行环境。
 
 - 请求不通
 
@@ -139,3 +176,6 @@ new XxxClient({
   # MacOS
   http_proxy=http://代理地址:代理端口 node app.js
   ```
+
+- 整数类型值超出 JavaScript 最大安全整数
+  使用新的数据类型 `BigInt`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-lowcode",
-  "version": "4.0.781",
+  "version": "4.0.1039",
   "description": "Tencent Cloud API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {
@@ -22,7 +22,8 @@
   "author": "tencentcloudapi",
   "license": "Apache-2.0",
   "dependencies": {
-    "tencentcloud-sdk-nodejs-common": "^4.0.488"
+    "tencentcloud-sdk-nodejs-common": "^4.0.488",
+    "tslib": "1.13.0"
   },
   "directories": {
     "example": "examples",

package/src/services/lowcode/v20210108/lowcode_client.ts

@@ -17,13 +17,47 @@
  */
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
 import {
-  TicketAuthInfo,
-  DescribeDataSourceListRequest,
+  DescribeKnowledgeSetListRequest,
+  KnowledgeDocumentSetInfo,
+  DeleteKnowledgeDocumentSetRsp,
+  UploadKnowledgeDocumentSetRequest,
+  UpdateKnowledgeSetResponse,
+  SearchDocListRequest,
+  DescribeKnowledgeDocumentSetListResponse,
+  UploadKnowledgeDocumentSetRsp,
   DataSourceQueryOption,
-  DataSourceLinkApp,
+  PageQuery,
+  SearchDocListResponse,
+  DeleteKnowledgeSetResponse,
+  DocumentQuery,
+  UpdateKnowledgeSetRequest,
+  SearchDocInfo,
   DataSourceDetail,
-  DataSourceDetailItems,
+  KnowledgeSet,
+  KnowledgeSplitterPreprocess,
+  DescribeKnowledgeDocumentSetDetailRequest,
+  CreateKnowledgeSetResponse,
+  DeleteKnowledgeSetRequest,
+  RelationField,
+  DescribeKnowledgeDocumentSetListRequest,
+  DescribeDataSourceListRequest,
+  DeleteKnowledgeDocumentSetRequest,
+  QureyKnowledgeDocumentSet,
+  DescribeKnowledgeSetListResponse,
   DescribeDataSourceListResponse,
+  UploadKnowledgeDocumentSetResponse,
+  DeleteKnowledgeDocumentSetResponse,
+  TicketAuthInfo,
+  CreateKnowledgeSetRequest,
+  DescribeKnowledgeDocumentSetDetailRsp,
+  QureyKnowledgeDocumentSetInfo,
+  DescribeKnowledgeDocumentSetListRsp,
+  KnowledgeDocumentSet,
+  DescribeKnowledgeDocumentSetDetailResponse,
+  DataSourceLinkApp,
+  SearchDocRsp,
+  KnowledgeSetRsp,
+  DataSourceDetailItems,
 } from "./lowcode_models"
 
 /**
@@ -35,6 +69,46 @@ export class Client extends TencentCloudCommon.AbstractClient {
     super("lowcode.tencentcloudapi.com", "2021-01-08", clientConfig)
   }
 
+  /**
+   * 创建知识库
+   */
+  async CreateKnowledgeSet(
+    req: CreateKnowledgeSetRequest,
+    cb?: (error: string, rep: CreateKnowledgeSetResponse) => void
+  ): Promise<CreateKnowledgeSetResponse> {
+    return this.request("CreateKnowledgeSet", req, cb)
+  }
+
+  /**
+   * 更新知识库
+   */
+  async UpdateKnowledgeSet(
+    req: UpdateKnowledgeSetRequest,
+    cb?: (error: string, rep: UpdateKnowledgeSetResponse) => void
+  ): Promise<UpdateKnowledgeSetResponse> {
+    return this.request("UpdateKnowledgeSet", req, cb)
+  }
+
+  /**
+   * 知识库文档搜索接口
+   */
+  async SearchDocList(
+    req: SearchDocListRequest,
+    cb?: (error: string, rep: SearchDocListResponse) => void
+  ): Promise<SearchDocListResponse> {
+    return this.request("SearchDocList", req, cb)
+  }
+
+  /**
+   * 查询知识库
+   */
+  async DescribeKnowledgeSetList(
+    req: DescribeKnowledgeSetListRequest,
+    cb?: (error: string, rep: DescribeKnowledgeSetListResponse) => void
+  ): Promise<DescribeKnowledgeSetListResponse> {
+    return this.request("DescribeKnowledgeSetList", req, cb)
+  }
+
   /**
    * 获取数据源详情列表
    */
@@ -44,4 +118,54 @@ export class Client extends TencentCloudCommon.AbstractClient {
   ): Promise<DescribeDataSourceListResponse> {
     return this.request("DescribeDataSourceList", req, cb)
   }
+
+  /**
+   * 删除知识库下文档
+   */
+  async DeleteKnowledgeDocumentSet(
+    req: DeleteKnowledgeDocumentSetRequest,
+    cb?: (error: string, rep: DeleteKnowledgeDocumentSetResponse) => void
+  ): Promise<DeleteKnowledgeDocumentSetResponse> {
+    return this.request("DeleteKnowledgeDocumentSet", req, cb)
+  }
+
+  /**
+   * 获取知识库下文档详情
+   */
+  async DescribeKnowledgeDocumentSetDetail(
+    req: DescribeKnowledgeDocumentSetDetailRequest,
+    cb?: (error: string, rep: DescribeKnowledgeDocumentSetDetailResponse) => void
+  ): Promise<DescribeKnowledgeDocumentSetDetailResponse> {
+    return this.request("DescribeKnowledgeDocumentSetDetail", req, cb)
+  }
+
+  /**
+   * 更新知识库
+   */
+  async UploadKnowledgeDocumentSet(
+    req: UploadKnowledgeDocumentSetRequest,
+    cb?: (error: string, rep: UploadKnowledgeDocumentSetResponse) => void
+  ): Promise<UploadKnowledgeDocumentSetResponse> {
+    return this.request("UploadKnowledgeDocumentSet", req, cb)
+  }
+
+  /**
+   * 查询知识库下文件集合
+   */
+  async DescribeKnowledgeDocumentSetList(
+    req: DescribeKnowledgeDocumentSetListRequest,
+    cb?: (error: string, rep: DescribeKnowledgeDocumentSetListResponse) => void
+  ): Promise<DescribeKnowledgeDocumentSetListResponse> {
+    return this.request("DescribeKnowledgeDocumentSetList", req, cb)
+  }
+
+  /**
+   * 删除知识库
+   */
+  async DeleteKnowledgeSet(
+    req: DeleteKnowledgeSetRequest,
+    cb?: (error: string, rep: DeleteKnowledgeSetResponse) => void
+  ): Promise<DeleteKnowledgeSetResponse> {
+    return this.request("DeleteKnowledgeSet", req, cb)
+  }
 }