tencentcloud-sdk-nodejs 4.1.63 → 4.1.65

package/es/services/lke/v20231130/lke_client.js

@@ -36,6 +36,9 @@ export class Client extends AbstractClient {
     async StopWorkflowRun(req, cb) {
         return this.request("StopWorkflowRun", req, cb);
     }
+    async ModifyAgent(req, cb) {
+        return this.request("ModifyAgent", req, cb);
+    }
     async CreateAttributeLabel(req, cb) {
         return this.request("CreateAttributeLabel", req, cb);
     }
@@ -87,8 +90,8 @@ export class Client extends AbstractClient {
     async DescribeSearchStatsGraph(req, cb) {
         return this.request("DescribeSearchStatsGraph", req, cb);
     }
-    async ListWorkflowRuns(req, cb) {
-        return this.request("ListWorkflowRuns", req, cb);
+    async DeleteDocCate(req, cb) {
+        return this.request("DeleteDocCate", req, cb);
     }
     async VerifyQA(req, cb) {
         return this.request("VerifyQA", req, cb);
@@ -147,8 +150,8 @@ export class Client extends AbstractClient {
     async DescribeNodeRun(req, cb) {
         return this.request("DescribeNodeRun", req, cb);
     }
-    async DeleteDocCate(req, cb) {
-        return this.request("DeleteDocCate", req, cb);
+    async ListWorkflowRuns(req, cb) {
+        return this.request("ListWorkflowRuns", req, cb);
     }
     async ListQACate(req, cb) {
         return this.request("ListQACate", req, cb);
@@ -165,6 +168,9 @@ export class Client extends AbstractClient {
     async ModifyDoc(req, cb) {
         return this.request("ModifyDoc", req, cb);
     }
+    async DeleteAgent(req, cb) {
+        return this.request("DeleteAgent", req, cb);
+    }
     async CreateQACate(req, cb) {
         return this.request("CreateQACate", req, cb);
     }
@@ -207,6 +213,9 @@ export class Client extends AbstractClient {
     async ExportQAList(req, cb) {
         return this.request("ExportQAList", req, cb);
     }
+    async CreateAgent(req, cb) {
+        return this.request("CreateAgent", req, cb);
+    }
     async UploadAttributeLabel(req, cb) {
         return this.request("UploadAttributeLabel", req, cb);
     }
@@ -285,6 +294,9 @@ export class Client extends AbstractClient {
     async DescribeWorkflowRun(req, cb) {
         return this.request("DescribeWorkflowRun", req, cb);
     }
+    async DescribeAppAgentList(req, cb) {
+        return this.request("DescribeAppAgentList", req, cb);
+    }
     async RetryDocAudit(req, cb) {
         return this.request("RetryDocAudit", req, cb);
     }

package/es/services/trocket/v20230308/trocket_client.js

@@ -99,6 +99,9 @@ export class Client extends AbstractClient {
     async DescribeMQTTMessage(req, cb) {
         return this.request("DescribeMQTTMessage", req, cb);
     }
+    async ChangeMigratingTopicToNextStage(req, cb) {
+        return this.request("ChangeMigratingTopicToNextStage", req, cb);
+    }
     async DescribeConsumerLag(req, cb) {
         return this.request("DescribeConsumerLag", req, cb);
     }
@@ -189,8 +192,8 @@ export class Client extends AbstractClient {
     async DescribeMigrationTaskList(req, cb) {
         return this.request("DescribeMigrationTaskList", req, cb);
     }
-    async ChangeMigratingTopicToNextStage(req, cb) {
-        return this.request("ChangeMigratingTopicToNextStage", req, cb);
+    async DescribeConsumerClientList(req, cb) {
+        return this.request("DescribeConsumerClientList", req, cb);
     }
     async DescribeMigratingTopicStats(req, cb) {
         return this.request("DescribeMigratingTopicStats", req, cb);

package/es/services/wedata/v20210820/wedata_client.js

@@ -423,6 +423,9 @@ export class Client extends AbstractClient {
     async DescribeDatabaseInfoList(req, cb) {
         return this.request("DescribeDatabaseInfoList", req, cb);
     }
+    async ModifyRuleTemplate(req, cb) {
+        return this.request("ModifyRuleTemplate", req, cb);
+    }
     async DescribeDependOpsTasks(req, cb) {
         return this.request("DescribeDependOpsTasks", req, cb);
     }
@@ -462,8 +465,8 @@ export class Client extends AbstractClient {
     async CreateRule(req, cb) {
         return this.request("CreateRule", req, cb);
     }
-    async ModifyRuleTemplate(req, cb) {
-        return this.request("ModifyRuleTemplate", req, cb);
+    async DescribeRuleGroupSubscription(req, cb) {
+        return this.request("DescribeRuleGroupSubscription", req, cb);
     }
     async DescribeEvent(req, cb) {
         return this.request("DescribeEvent", req, cb);
@@ -519,6 +522,9 @@ export class Client extends AbstractClient {
     async UploadContent(req, cb) {
         return this.request("UploadContent", req, cb);
     }
+    async DescribeDsTaskVersionList(req, cb) {
+        return this.request("DescribeDsTaskVersionList", req, cb);
+    }
     async DescribeCodeTemplateDetail(req, cb) {
         return this.request("DescribeCodeTemplateDetail", req, cb);
     }
@@ -627,8 +633,8 @@ export class Client extends AbstractClient {
     async RegisterDsEventListener(req, cb) {
         return this.request("RegisterDsEventListener", req, cb);
     }
-    async DescribeRuleGroupSubscription(req, cb) {
-        return this.request("DescribeRuleGroupSubscription", req, cb);
+    async DescribeDsTaskVersionInfo(req, cb) {
+        return this.request("DescribeDsTaskVersionInfo", req, cb);
     }
     async DeleteTaskDs(req, cb) {
         return this.request("DeleteTaskDs", req, cb);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs",
-  "version": "4.1.63",
+  "version": "4.1.65",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/common/abstract_client.d.ts

@@ -1,40 +1,124 @@
 import { ClientProfile, Credential, ClientConfig, HttpProfile, DynamicCredential } from "./interface";
+/**
+ * Callback function type for API responses
+ * @template TReuslt Type of the response data
+ */
 export declare type ResponseCallback<TReuslt = any> = (error: string, rep: TReuslt) => void;
+/**
+ * Options for HTTP requests
+ */
 export interface RequestOptions extends Partial<Pick<HttpProfile, "headers">> {
+    /**
+     * Whether the request is multipart
+     */
     multipart?: boolean;
     /**
-     * 中止请求信号
+     * Abort request signal
      */
     signal?: AbortSignal;
 }
 declare type ResponseData = any;
 /**
- * @inner
+ * Abstract base client for Tencent Cloud SDK
+ *
+ * This class provides common functionality for making API requests to Tencent Cloud services,
+ * including request signing, error handling, and response parsing.
  */
 export declare class AbstractClient {
+    /**
+     * SDK version string
+     */
     sdkVersion: string;
+    /**
+     * API request path (usually "/")
+     */
     path: string;
+    /**
+     * User's security credentials (SecretId, SecretKey, Token)
+     */
     credential: Credential | DynamicCredential;
+    /**
+     * The region of the service (e.g. "ap-shanghai")
+     */
     region: string;
+    /**
+     * The API version of the service (e.g. "2017-03-12")
+     */
     apiVersion: string;
+    /**
+     * The service endpoint URL (e.g. "cvm.tencentcloudapi.com")
+     */
     endpoint: string;
+    /**
+     * Optional configuration instance
+     */
     profile: ClientProfile;
     /**
-     * 实例化client对象
-     * @param {string} endpoint 接入点域名
-     * @param {string} version 产品版本
-     * @param {Credential} credential 认证信息实例
-     * @param {string} region 产品地域
-     * @param {ClientProfile} profile 可选配置实例
+     * Constructs a new AbstractClient instance
+     *
+     * @param {string} endpoint - The service endpoint URL (e.g. "cvm.tencentcloudapi.com")
+     * @param {string} version - The API version of the service (e.g. "2017-03-12")
+     * @param {ClientConfig} config - Configuration object containing:
+     * @param {Credential|DynamicCredential} config.credential - Credentials for authentication
+     * @param {string} [config.region] - The region of the service (e.g. "ap-shanghai")
+     * @param {ClientProfile} [config.profile={}] - Optional client configuration profile
+     *
+     * @throws {TencentCloudSDKHttpException} If invalid language is specified in profile
+     *
+     * @example
+     * const client = new AbstractClient(
+     *   "cvm.tencentcloudapi.com",
+     *   "2017-03-12",
+     *   {
+     *     credential: {
+     *       secretId: process.env.secretId,
+     *       secretKey: process.env.secretKey,
+     *     },
+     *     region: "ap-shanghai",
+     *     profile: {}
+     *   }
+     * );
      */
     constructor(endpoint: string, version: string, { credential, region, profile }: ClientConfig);
+    /**
+     * Get credential information
+     * @returns {Promise<Credential>} Promise that resolves with credential information
+     */
     getCredential(): Promise<Credential>;
     /**
-     * @inner
+     * Make an API request to Tencent Cloud service
+     *
+     * @param {string} action - The API action name to call
+     * @param {any} req - The request payload/parameters
+     * @param {ResponseCallback|RequestOptions} [options] - Either request options or callback function
+     * @param {ResponseCallback} [cb] - Optional callback function for async operation
+     * @returns {Promise<ResponseData>} Promise that resolves with the API response data
+     *
+     * @example
+     * // Using promise
+     * client.request('DescribeInstances', {Limit: 10})
+     *   .then(data => console.log(data))
+     *   .catch(err => console.error(err));
+     *
+     * // Using callback
+     * client.request('DescribeInstances', {Limit: 10}, (err, data) => {
+     *   if (err) console.error(err);
+     *   else console.log(data);
+     * });
+     *
+     * // With options
+     * client.request('DescribeInstances', {Limit: 10}, {signal: abortController.signal})
+     *   .then(data => console.log(data))
+     *   .catch(err => console.error(err));
      */
     request(action: string, req: any, options?: ResponseCallback | RequestOptions, cb?: ResponseCallback): Promise<ResponseData>;
     /**
-     * @inner
+     * Make a request with octet-stream content type
+     * @param {string} action API action name
+     * @param {any} req Request data
+     * @param {ResponseCallback|RequestOptions} [options] Request options or callback
+     * @param {ResponseCallback} [cb] Callback function
+     * @returns {Promise<any>} Promise that resolves with response data
      */
     requestOctetStream(action: string, req: any, options?: ResponseCallback | RequestOptions, cb?: ResponseCallback): Promise<any>;
     /**
@@ -45,17 +129,31 @@ export declare class AbstractClient {
      * @inner
      */
     private doRequestWithSign3;
+    /**
+     * Parse HTTP response
+     * @param {Response} res HTTP response object
+     * @returns {Promise<ResponseData>} Promise that resolves with parsed response data
+     * @throws {TencentCloudSDKHttpException} If response contains error
+     */
     private parseResponse;
     /**
-     * @inner
+     * Merge nested data into flat structure
+     * @param {any} data Input data
+     * @param {string} [prefix=""] Key prefix
+     * @returns {any} Flattened data object
      */
     private mergeData;
     /**
-     * @inner
+     * Format request data with required fields and signature
+     * @param {string} action API action name
+     * @param {RequestData} params Request parameters
+     * @returns {Promise<RequestData>} Promise that resolves with formatted request data
      */
     private formatRequestData;
     /**
-     * @inner
+     * Format string for signature calculation
+     * @param {RequestData} params Request parameters
+     * @returns {string} String to be signed
      */
     private formatSignString;
 }

package/tencentcloud/common/abstract_client.js

@@ -10,21 +10,42 @@ const tencent_cloud_sdk_exception_1 = tslib_1.__importDefault(require("./excepti
 const sse_response_model_1 = require("./sse_response_model");
 const uuid_1 = require("uuid");
 /**
- * @inner
+ * Abstract base client for Tencent Cloud SDK
+ *
+ * This class provides common functionality for making API requests to Tencent Cloud services,
+ * including request signing, error handling, and response parsing.
  */
 class AbstractClient {
     /**
-     * 实例化client对象
-     * @param {string} endpoint 接入点域名
-     * @param {string} version 产品版本
-     * @param {Credential} credential 认证信息实例
-     * @param {string} region 产品地域
-     * @param {ClientProfile} profile 可选配置实例
+     * Constructs a new AbstractClient instance
+     *
+     * @param {string} endpoint - The service endpoint URL (e.g. "cvm.tencentcloudapi.com")
+     * @param {string} version - The API version of the service (e.g. "2017-03-12")
+     * @param {ClientConfig} config - Configuration object containing:
+     * @param {Credential|DynamicCredential} config.credential - Credentials for authentication
+     * @param {string} [config.region] - The region of the service (e.g. "ap-shanghai")
+     * @param {ClientProfile} [config.profile={}] - Optional client configuration profile
+     *
+     * @throws {TencentCloudSDKHttpException} If invalid language is specified in profile
+     *
+     * @example
+     * const client = new AbstractClient(
+     *   "cvm.tencentcloudapi.com",
+     *   "2017-03-12",
+     *   {
+     *     credential: {
+     *       secretId: process.env.secretId,
+     *       secretKey: process.env.secretKey,
+     *     },
+     *     region: "ap-shanghai",
+     *     profile: {}
+     *   }
+     * );
      */
     constructor(endpoint, version, { credential, region, profile = {} }) {
         this.path = "/";
         /**
-         * 认证信息实例
+         * Credential instance
          */
         if (credential && "getCredential" in credential) {
             this.credential = credential;
@@ -37,14 +58,14 @@ class AbstractClient {
             }, credential);
         }
         /**
-         * 产品地域
+         * The region of the service
          */
         this.region = region || null;
         this.sdkVersion = "SDK_NODEJS_" + sdk_version_1.sdkVersion;
         this.apiVersion = version;
         this.endpoint = (profile && profile.httpProfile && profile.httpProfile.endpoint) || endpoint;
         /**
-         * 可选配置实例
+         * Optional configuration instance
          * @type {ClientProfile}
          */
         this.profile = {
@@ -61,6 +82,10 @@ class AbstractClient {
             throw new tencent_cloud_sdk_exception_1.default(`Language invalid, choices: ${interface_1.SUPPORT_LANGUAGE_LIST.join("|")}`);
         }
     }
+    /**
+     * Get credential information
+     * @returns {Promise<Credential>} Promise that resolves with credential information
+     */
     async getCredential() {
         if ("getCredential" in this.credential) {
             return await this.credential.getCredential();
@@ -68,7 +93,30 @@ class AbstractClient {
         return this.credential;
     }
     /**
-     * @inner
+     * Make an API request to Tencent Cloud service
+     *
+     * @param {string} action - The API action name to call
+     * @param {any} req - The request payload/parameters
+     * @param {ResponseCallback|RequestOptions} [options] - Either request options or callback function
+     * @param {ResponseCallback} [cb] - Optional callback function for async operation
+     * @returns {Promise<ResponseData>} Promise that resolves with the API response data
+     *
+     * @example
+     * // Using promise
+     * client.request('DescribeInstances', {Limit: 10})
+     *   .then(data => console.log(data))
+     *   .catch(err => console.error(err));
+     *
+     * // Using callback
+     * client.request('DescribeInstances', {Limit: 10}, (err, data) => {
+     *   if (err) console.error(err);
+     *   else console.log(data);
+     * });
+     *
+     * // With options
+     * client.request('DescribeInstances', {Limit: 10}, {signal: abortController.signal})
+     *   .then(data => console.log(data))
+     *   .catch(err => console.error(err));
      */
     async request(action, req, options, cb) {
         if (typeof options === "function") {
@@ -86,7 +134,12 @@ class AbstractClient {
         }
     }
     /**
-     * @inner
+     * Make a request with octet-stream content type
+     * @param {string} action API action name
+     * @param {any} req Request data
+     * @param {ResponseCallback|RequestOptions} [options] Request options or callback
+     * @param {ResponseCallback} [cb] Callback function
+     * @returns {Promise<any>} Promise that resolves with response data
      */
     async requestOctetStream(action, req, options, cb) {
         if (typeof options === "function") {
@@ -191,6 +244,12 @@ class AbstractClient {
         }
         return this.parseResponse(res);
     }
+    /**
+     * Parse HTTP response
+     * @param {Response} res HTTP response object
+     * @returns {Promise<ResponseData>} Promise that resolves with parsed response data
+     * @throws {TencentCloudSDKHttpException} If response contains error
+     */
     async parseResponse(res) {
         const traceId = res.headers.get("x-tc-traceid");
         if (res.status !== 200) {
@@ -216,7 +275,10 @@ class AbstractClient {
         }
     }
     /**
-     * @inner
+     * Merge nested data into flat structure
+     * @param {any} data Input data
+     * @param {string} [prefix=""] Key prefix
+     * @returns {any} Flattened data object
      */
     mergeData(data, prefix = "") {
         const ret = {};
@@ -234,7 +296,10 @@ class AbstractClient {
         return ret;
     }
     /**
-     * @inner
+     * Format request data with required fields and signature
+     * @param {string} action API action name
+     * @param {RequestData} params Request parameters
+     * @returns {Promise<RequestData>} Promise that resolves with formatted request data
      */
     async formatRequestData(action, params) {
         params.Action = action;
@@ -263,7 +328,9 @@ class AbstractClient {
         return params;
     }
     /**
-     * @inner
+     * Format string for signature calculation
+     * @param {RequestData} params Request parameters
+     * @returns {string} String to be signed
      */
     formatSignString(params) {
         let strParam = "";

package/tencentcloud/common/common_client.d.ts

@@ -1,3 +1,10 @@
 import { AbstractClient } from "./abstract_client";
+/**
+ * Common client class for Tencent Cloud SDK
+ *
+ * You only need to install the tencentcloud-sdk-nodejs-common package to Make an API request to any product
+ *
+ * @see {@link https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples/common} view exmaple
+ */
 export declare class CommonClient extends AbstractClient {
 }

package/tencentcloud/common/common_client.js

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonClient = void 0;
 const abstract_client_1 = require("./abstract_client");
+/**
+ * Common client class for Tencent Cloud SDK
+ *
+ * You only need to install the tencentcloud-sdk-nodejs-common package to Make an API request to any product
+ *
+ * @see {@link https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples/common} view exmaple
+ */
 class CommonClient extends abstract_client_1.AbstractClient {
 }
 exports.CommonClient = CommonClient;

package/tencentcloud/common/cvm_role_credential.d.ts

@@ -7,6 +7,12 @@ interface CvmRoleCredentialResult {
     Token: string;
     Code: string;
 }
+/**
+ * Tencent Cloud Credential via CVM role
+ *
+ * Automatically generates temporary credentials when binding a service role to instance.
+ * @see {@link https://cloud.tencent.com/document/product/598/85616} for more information.
+ */
 export default class CvmRoleCredential implements DynamicCredential {
     protected roleNameTask: Promise<string> | null;
     protected credentialTask: Promise<CvmRoleCredentialResult> | null;

package/tencentcloud/common/cvm_role_credential.js

@@ -5,7 +5,14 @@ const fetch_1 = tslib_1.__importDefault(require("./http/fetch"));
 const META_URL = "http://metadata.tencentyun.com/latest/meta-data/";
 const ROLE_URL = META_URL + "cam/security-credentials/";
 const EXPIRE_BUFFER = 30 * 1000;
+/**
+ * Tencent Cloud Credential via CVM role
+ *
+ * Automatically generates temporary credentials when binding a service role to instance.
+ * @see {@link https://cloud.tencent.com/document/product/598/85616} for more information.
+ */
 class CvmRoleCredential {
+    // Method to fetch the role name from the metadata server
     async getRoleName() {
         const response = await fetch_1.default(ROLE_URL, {});
         if (!response.ok) {
@@ -13,6 +20,7 @@ class CvmRoleCredential {
         }
         return await response.text();
     }
+    // Method to fetch credentials for a given role name
     async getRoleCredential(roleName) {
         const response = await fetch_1.default(ROLE_URL + roleName, {});
         if (!response.ok) {
@@ -24,6 +32,7 @@ class CvmRoleCredential {
         }
         return json;
     }
+    // Method to get the current credential, refreshing if expired
     async getCredential() {
         if (!this.roleNameTask) {
             this.roleNameTask = this.getRoleName();
@@ -33,7 +42,7 @@ class CvmRoleCredential {
             this.credentialTask = this.getRoleCredential(roleName);
         }
         const credential = await this.credentialTask;
-        // expired
+        // Check if the credential is expired
         if (credential.ExpiredTime * 1000 - EXPIRE_BUFFER <= Date.now()) {
             this.credentialTask = null;
             return this.getCredential();

package/tencentcloud/common/http/http_connection.js

@@ -34,8 +34,7 @@ class HttpConnection {
         return await fetch_1.default(url, config);
     }
     static async doRequestWithSign3({ method, url, data, service, action, region, version, secretId, secretKey, multipart = false, timeout = 60000, token, requestClient, language, headers = {}, agent, proxy, signal, }) {
-        // data 中可能带有 readStream，由于需要计算整个 body 的 hash，
-        // 所以这里把 readStream 转为 Buffer
+        // Convert readStream to Buffer to calculate the hash of the entire body
         // eslint-disable-next-line @typescript-eslint/no-use-before-define
         await convertReadStreamToBuffer(data);
         // eslint-disable-next-line @typescript-eslint/no-use-before-define