tencentcloud-sdk-nodejs-mqtt 4.0.991 → 4.0.1027

package/README.md

@@ -1,6 +1,6 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。目前已经支持 cvm、vpc、cbs 等产品，后续所有的云服务产品都会接入进来。新版 SDK 实现了统一化，具有各个语言版本的 SDK 使用方法相同，接口调用方式相同，统一的错误码和返回包格式这些优点。
+欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。
 为方便 NODEJS 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 NODEJS 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
 
 # 依赖环境
@@ -13,21 +13,50 @@
 
 安装 NODEJS SDK 前，先获取安全凭证。在第一次使用云 API 之前，用户首先需要在腾讯云控制台上申请安全凭证，安全凭证包括 SecretID 和 SecretKey， SecretID 是用于标识 API 调用者的身份，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。
 
-## 通过 Npm 安装
+## 通过 NPM 安装
 
-通过 npm 获取安装是使用 NODEJS SDK 的推荐方法，npm 是 NODEJS 的包管理工具。关于 npm 详细可参考[ npm 官网](https://www.npmjs.com/) 。
+通过 NPM 获取安装是使用 NODEJS SDK 的推荐方法，NPM 是 NODEJS 的包管理工具。关于 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，具体可参考示例。
 
 # 示例
 
@@ -120,14 +149,14 @@ new XxxClient({
 
 # 旧版 SDK
 
-我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[github 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
+我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
 
 # 常见问题
 - webpack打包出错/浏览器报错
 
-  请**务必不要**将此sdk直接用于web前端(包括小程序等)，暴露密钥在这些环境非常不安全。
+  请**务必不要**将此SDK直接用于web前端(包括小程序等)，暴露密钥在这些环境非常不安全。
 
-  正确的做法是在自己的服务端引用此sdk，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
+  正确的做法是在自己的服务端引用此SDK，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
 
 - `The "original" argument must be of type Function.`
 

package/package.json

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

package/src/services/mqtt/v20240516/mqtt_client.ts

@@ -17,64 +17,92 @@
  */
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
 import {
-  UpdateAuthorizationPolicyPriorityResponse,
+  DeleteUserRequest,
+  ModifyJWTAuthenticatorResponse,
   UpdateAuthorizationPolicyPriorityRequest,
-  AuthorizationPolicyItem,
-  DeviceCertificateItem,
-  CreateJWTAuthenticatorResponse,
-  DeleteAuthorizationPolicyRequest,
-  ModifyJWKSAuthenticatorResponse,
+  ActivateDeviceCertificateRequest,
+  CreateInstanceResponse,
+  DescribeAuthenticatorRequest,
+  ModifyJWTAuthenticatorRequest,
+  AuthorizationPolicyPriority,
+  ModifyInstanceRequest,
+  DeleteTopicRequest,
+  ModifyUserResponse,
+  DescribeDeviceCertificatesRequest,
+  DeleteAuthenticatorRequest,
+  PublicAccessRule,
+  VpcInfo,
+  DeleteAuthorizationPolicyResponse,
+  ModifyJWKSAuthenticatorRequest,
+  DeleteInstanceResponse,
   RegisterDeviceCertificateResponse,
-  ModifyJWTAuthenticatorResponse,
-  DescribeAuthorizationPoliciesRequest,
-  DescribeTopicListRequest,
-  DescribeInstanceListRequest,
-  ModifyAuthorizationPolicyResponse,
+  MQTTAuthenticatorItem,
+  Tag,
+  DescribeDeviceCertificateRequest,
+  MQTTInstanceItem,
+  DescribeInstanceListResponse,
+  ModifyInstanceResponse,
+  ModifyInsPublicEndpointResponse,
+  ModifyJWKSAuthenticatorResponse,
+  CreateInsPublicEndpointResponse,
+  CreateUserResponse,
   CreateAuthorizationPolicyRequest,
-  ActivateDeviceCertificateRequest,
-  DescribeInstanceResponse,
   DescribeAuthenticatorResponse,
   DeleteDeviceCertificateRequest,
-  CreateTopicResponse,
-  ModifyJWTAuthenticatorRequest,
-  DescribeDeviceCertificateResponse,
-  RevokedDeviceCertificateRequest,
-  AuthorizationPolicyPriority,
-  CreateAuthorizationPolicyResponse,
+  DescribeInsPublicEndpointsRequest,
+  DeleteUserResponse,
   DeleteDeviceCertificateResponse,
-  CreateJWTAuthenticatorRequest,
-  DeleteTopicRequest,
+  ModifyAuthorizationPolicyResponse,
   CreateJWKSAuthenticatorRequest,
-  ModifyTopicResponse,
   DescribeTopicResponse,
-  DescribeDeviceCertificatesRequest,
   CreateJWKSAuthenticatorResponse,
-  DeleteAuthenticatorRequest,
   DescribeAuthorizationPoliciesResponse,
-  RegisterDeviceCertificateRequest,
   CreateTopicRequest,
-  MQTTTopicItem,
+  TagFilter,
+  DescribeUserListResponse,
+  ModifyTopicResponse,
+  DeactivateDeviceCertificateResponse,
+  MQTTUserItem,
+  ActivateDeviceCertificateResponse,
+  DescribeTopicRequest,
+  UpdateAuthorizationPolicyPriorityResponse,
+  CreateTopicResponse,
+  DeleteInsPublicEndpointResponse,
+  MQTTEndpointItem,
+  DescribeTopicListRequest,
+  AuthorizationPolicyItem,
+  RevokedDeviceCertificateRequest,
+  CreateAuthorizationPolicyResponse,
+  CreateInstanceRequest,
+  CreateInsPublicEndpointRequest,
+  RegisterDeviceCertificateRequest,
   Filter,
-  DeleteAuthorizationPolicyResponse,
+  DeactivateDeviceCertificateRequest,
   DescribeDeviceCertificatesResponse,
-  ModifyJWKSAuthenticatorRequest,
   ModifyTopicRequest,
-  DescribeTopicListResponse,
-  DescribeAuthenticatorRequest,
-  MQTTInstanceItem,
+  CreateUserRequest,
+  DescribeInstanceResponse,
+  DeleteInstanceRequest,
+  DescribeInsPublicEndpointsResponse,
+  ModifyInsPublicEndpointRequest,
+  DeleteInsPublicEndpointRequest,
+  DescribeUserListRequest,
+  CreateJWTAuthenticatorResponse,
+  DeleteAuthorizationPolicyRequest,
+  DescribeAuthorizationPoliciesRequest,
   RevokedDeviceCertificateResponse,
+  DescribeDeviceCertificateResponse,
+  DescribeInstanceListRequest,
+  CreateJWTAuthenticatorRequest,
+  DeviceCertificateItem,
+  MQTTTopicItem,
+  ModifyAuthorizationPolicyRequest,
+  DescribeTopicListResponse,
   DeleteTopicResponse,
-  DeactivateDeviceCertificateResponse,
-  DescribeDeviceCertificateRequest,
-  DeactivateDeviceCertificateRequest,
   DescribeInstanceRequest,
-  MQTTAuthenticatorItem,
+  ModifyUserRequest,
   DeleteAuthenticatorResponse,
-  TagFilter,
-  ModifyAuthorizationPolicyRequest,
-  ActivateDeviceCertificateResponse,
-  DescribeInstanceListResponse,
-  DescribeTopicRequest,
+  IpRule,
 } from "./mqtt_models"
 
 /**
@@ -86,6 +114,26 @@ export class Client extends TencentCloudCommon.AbstractClient {
     super("mqtt.tencentcloudapi.com", "2024-05-16", clientConfig)
   }
 
+  /**
+   * 购买新的MQTT实例
+   */
+  async CreateInstance(
+    req: CreateInstanceRequest,
+    cb?: (error: string, rep: CreateInstanceResponse) => void
+  ): Promise<CreateInstanceResponse> {
+    return this.request("CreateInstance", req, cb)
+  }
+
+  /**
+   * 为MQTT实例创建公网接入点
+   */
+  async CreateInsPublicEndpoint(
+    req: CreateInsPublicEndpointRequest,
+    cb?: (error: string, rep: CreateInsPublicEndpointResponse) => void
+  ): Promise<CreateInsPublicEndpointResponse> {
+    return this.request("CreateInsPublicEndpoint", req, cb)
+  }
+
   /**
    * 修改主题属性
    */
@@ -136,6 +184,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DeleteDeviceCertificate", req, cb)
   }
 
+  /**
+   * 删除MQTT实例
+   */
+  async DeleteInstance(
+    req: DeleteInstanceRequest,
+    cb?: (error: string, rep: DeleteInstanceResponse) => void
+  ): Promise<DeleteInstanceResponse> {
+    return this.request("DeleteInstance", req, cb)
+  }
+
   /**
    * 修改MQTT JWKS 认证器
    */
@@ -166,6 +224,38 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DescribeDeviceCertificates", req, cb)
   }
 
+  /**
+   * 查询MQTT实例公网接入点
+   */
+  async DescribeInsPublicEndpoints(
+    req: DescribeInsPublicEndpointsRequest,
+    cb?: (error: string, rep: DescribeInsPublicEndpointsResponse) => void
+  ): Promise<DescribeInsPublicEndpointsResponse> {
+    return this.request("DescribeInsPublicEndpoints", req, cb)
+  }
+
+  /**
+     * 查询用户列表，Filter参数使用说明如下：
+
+1. Username，用户名称模糊搜索
+     */
+  async DescribeUserList(
+    req: DescribeUserListRequest,
+    cb?: (error: string, rep: DescribeUserListResponse) => void
+  ): Promise<DescribeUserListResponse> {
+    return this.request("DescribeUserList", req, cb)
+  }
+
+  /**
+   * 更新MQTT实例公网接入点
+   */
+  async ModifyInsPublicEndpoint(
+    req: ModifyInsPublicEndpointRequest,
+    cb?: (error: string, rep: ModifyInsPublicEndpointResponse) => void
+  ): Promise<ModifyInsPublicEndpointResponse> {
+    return this.request("ModifyInsPublicEndpoint", req, cb)
+  }
+
   /**
    * 注册设备证书
    */
@@ -206,6 +296,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DescribeAuthorizationPolicies", req, cb)
   }
 
+  /**
+   * 删除MQTT实例的公网接入点
+   */
+  async DeleteInsPublicEndpoint(
+    req: DeleteInsPublicEndpointRequest,
+    cb?: (error: string, rep: DeleteInsPublicEndpointResponse) => void
+  ): Promise<DeleteInsPublicEndpointResponse> {
+    return this.request("DeleteInsPublicEndpoint", req, cb)
+  }
+
   /**
    * 查询设备证书详情接口
    */
@@ -252,13 +352,16 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 删除MQTT主题
-   */
-  async DeleteTopic(
-    req: DeleteTopicRequest,
-    cb?: (error: string, rep: DeleteTopicResponse) => void
-  ): Promise<DeleteTopicResponse> {
-    return this.request("DeleteTopic", req, cb)
+     * 获取主题列表，Filter参数使用说明如下：
+
+1. TopicName，主题名称模糊搜索
+2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
+     */
+  async DescribeTopicList(
+    req: DescribeTopicListRequest,
+    cb?: (error: string, rep: DescribeTopicListResponse) => void
+  ): Promise<DescribeTopicListResponse> {
+    return this.request("DescribeTopicList", req, cb)
   }
 
   /**
@@ -271,6 +374,26 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("CreateJWKSAuthenticator", req, cb)
   }
 
+  /**
+   * 修改MQTT角色
+   */
+  async ModifyUser(
+    req: ModifyUserRequest,
+    cb?: (error: string, rep: ModifyUserResponse) => void
+  ): Promise<ModifyUserResponse> {
+    return this.request("ModifyUser", req, cb)
+  }
+
+  /**
+   * 删除MQTT访问用户
+   */
+  async DeleteUser(
+    req: DeleteUserRequest,
+    cb?: (error: string, rep: DeleteUserResponse) => void
+  ): Promise<DeleteUserResponse> {
+    return this.request("DeleteUser", req, cb)
+  }
+
   /**
    * 修改策略规则
    */
@@ -322,16 +445,23 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-     * 获取主题列表，Filter参数使用说明如下：
+   * 添加mqtt角色
+   */
+  async CreateUser(
+    req: CreateUserRequest,
+    cb?: (error: string, rep: CreateUserResponse) => void
+  ): Promise<CreateUserResponse> {
+    return this.request("CreateUser", req, cb)
+  }
 
-1. TopicName，主题名称模糊搜索
-2. TopicType，主题类型查询，支持多选，可选值：Normal,Order,Transaction,DelayScheduled
-     */
-  async DescribeTopicList(
-    req: DescribeTopicListRequest,
-    cb?: (error: string, rep: DescribeTopicListResponse) => void
-  ): Promise<DescribeTopicListResponse> {
-    return this.request("DescribeTopicList", req, cb)
+  /**
+   * 删除MQTT主题
+   */
+  async DeleteTopic(
+    req: DeleteTopicRequest,
+    cb?: (error: string, rep: DeleteTopicResponse) => void
+  ): Promise<DeleteTopicResponse> {
+    return this.request("DeleteTopic", req, cb)
   }
 
   /**
@@ -343,4 +473,14 @@ export class Client extends TencentCloudCommon.AbstractClient {
   ): Promise<CreateAuthorizationPolicyResponse> {
     return this.request("CreateAuthorizationPolicy", req, cb)
   }
+
+  /**
+   * 修改实例属性
+   */
+  async ModifyInstance(
+    req: ModifyInstanceRequest,
+    cb?: (error: string, rep: ModifyInstanceResponse) => void
+  ): Promise<ModifyInstanceResponse> {
+    return this.request("ModifyInstance", req, cb)
+  }
 }