From cd5996217d75e81afeb23c0a07f27317fc417b1d Mon Sep 17 00:00:00 2001 From: tencentcloudapi Date: Thu, 2 Nov 2023 04:07:15 +0800 Subject: [PATCH] release 4.0.720 --- CHANGELOG.md | 108 ++++++ SERVICE_CHANGELOG.md | 177 +++++++++- package-lock.json | 4 +- package.json | 2 +- products.md | 14 +- src/common/sdk_version.ts | 2 +- src/services/btoe/index.ts | 4 +- src/services/dbbrain/index.ts | 4 +- src/services/drm/v20181115/drm_client.ts | 13 + src/services/drm/v20181115/drm_models.ts | 40 +++ src/services/dts/index.ts | 4 +- src/services/ess/v20201111/ess_client.ts | 45 ++- src/services/ess/v20201111/ess_models.ts | 73 +++- src/services/essbasic/index.ts | 4 +- .../essbasic/v20210526/essbasic_client.ts | 185 ++++++---- .../essbasic/v20210526/essbasic_models.ts | 328 +++++++++++++----- src/services/ims/index.ts | 4 +- src/services/iotvideo/index.ts | 4 +- src/services/sms/index.ts | 4 +- src/services/tdmq/v20200217/tdmq_client.ts | 33 +- src/services/tdmq/v20200217/tdmq_models.ts | 280 ++++++++++----- src/services/tem/index.ts | 4 +- src/services/teo/index.ts | 4 +- src/services/tms/index.ts | 4 +- src/services/tsw/index.ts | 4 +- src/services/vm/index.ts | 4 +- src/services/vpc/v20170312/vpc_models.ts | 14 +- tencentcloud/common/sdk_version.d.ts | 2 +- tencentcloud/common/sdk_version.js | 2 +- tencentcloud/services/btoe/index.d.ts | 8 +- tencentcloud/services/btoe/index.js | 4 +- tencentcloud/services/dbbrain/index.d.ts | 8 +- tencentcloud/services/dbbrain/index.js | 4 +- .../services/drm/v20181115/drm_client.d.ts | 7 +- .../services/drm/v20181115/drm_client.js | 7 + .../services/drm/v20181115/drm_models.d.ts | 38 ++ tencentcloud/services/dts/index.d.ts | 8 +- tencentcloud/services/dts/index.js | 4 +- .../services/ess/v20201111/ess_client.d.ts | 31 +- .../services/ess/v20201111/ess_client.js | 33 +- .../services/ess/v20201111/ess_models.d.ts | 71 +++- tencentcloud/services/essbasic/index.d.ts | 8 +- tencentcloud/services/essbasic/index.js | 4 +- .../essbasic/v20210526/essbasic_client.d.ts | 135 ++++--- .../essbasic/v20210526/essbasic_client.js | 145 ++++---- .../essbasic/v20210526/essbasic_models.d.ts | 326 ++++++++++++----- tencentcloud/services/ims/index.d.ts | 8 +- tencentcloud/services/ims/index.js | 4 +- tencentcloud/services/iotvideo/index.d.ts | 8 +- tencentcloud/services/iotvideo/index.js | 4 +- tencentcloud/services/sms/index.d.ts | 8 +- tencentcloud/services/sms/index.js | 4 +- .../services/tdmq/v20200217/tdmq_client.d.ts | 10 +- .../services/tdmq/v20200217/tdmq_client.js | 12 + .../services/tdmq/v20200217/tdmq_models.d.ts | 275 ++++++++++----- tencentcloud/services/tem/index.d.ts | 8 +- tencentcloud/services/tem/index.js | 4 +- tencentcloud/services/teo/index.d.ts | 8 +- tencentcloud/services/teo/index.js | 4 +- tencentcloud/services/tms/index.d.ts | 8 +- tencentcloud/services/tms/index.js | 4 +- tencentcloud/services/tsw/index.d.ts | 8 +- tencentcloud/services/tsw/index.js | 4 +- tencentcloud/services/vm/index.d.ts | 8 +- tencentcloud/services/vm/index.js | 4 +- .../services/vpc/v20170312/vpc_models.d.ts | 14 +- test/drm.v20181115.test.js | 10 + test/ess.v20201111.test.js | 14 +- test/essbasic.v20210526.test.js | 30 +- test/tdmq.v20200217.test.js | 20 ++ 70 files changed, 2001 insertions(+), 691 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02054a8d8..c19e1b721 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,111 @@ +# Release 4.0.720 + +## 数字版权管理(drm) 版本：2018-11-15 + +### 第 5 次发布 + +发布时间：2023-11-02 01:38:44 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeDRMLicense](https://cloud.tencent.com/document/api/1000/101057) + + + +## 腾讯电子签企业版(ess) 版本：2020-11-11 + +### 第 132 次发布 + +发布时间：2023-11-02 01:44:45 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [CreateBatchQuickSignUrl](https://cloud.tencent.com/document/api/1323/101058) + + + +## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 + +### 第 124 次发布 + +发布时间：2023-11-02 01:45:47 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [ChannelCreateBatchQuickSignUrl](https://cloud.tencent.com/document/api/1420/101059) + +修改接口： + +* [DescribeTemplates](https://cloud.tencent.com/document/api/1420/61521) + + * 新增入参：TemplateIds + + +修改数据结构： + +* [ApproverOption](https://cloud.tencent.com/document/api/1420/61525#ApproverOption) + + * 新增成员：NoRefuse + + + + +## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 + + + +## 消息队列 TDMQ(tdmq) 版本：2020-02-17 + +### 第 85 次发布 + +发布时间：2023-11-02 02:24:43 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeRocketMQConsumeStats](https://cloud.tencent.com/document/api/1179/101060) +* [VerifyRocketMQConsume](https://cloud.tencent.com/document/api/1179/101061) + +新增数据结构： + +* [ConsumerStats](https://cloud.tencent.com/document/api/1179/46089#ConsumerStats) + + + +## 私有网络(vpc) 版本：2017-03-12 + +### 第 178 次发布 + +发布时间：2023-11-02 02:40:08 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [BandwidthPackage](https://cloud.tencent.com/document/api/215/15824#BandwidthPackage) + + * 新增成员：Deadline + + + + # Release 4.0.719 ## 边缘安全加速平台(teo) 版本：2022-09-01 diff --git a/SERVICE_CHANGELOG.md b/SERVICE_CHANGELOG.md index a136ad39c..9202899fa 100644 --- a/SERVICE_CHANGELOG.md +++ b/SERVICE_CHANGELOG.md @@ -1,25 +1,108 @@ # 本版本更新包含以下内容： -## 边缘安全加速平台(teo) 版本：2022-09-01 +## 数字版权管理(drm) 版本：2018-11-15 -### 第 62 次发布 +### 第 5 次发布 -发布时间：2023-11-01 11:21:19 +发布时间：2023-11-02 01:38:44 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeDRMLicense](https://cloud.tencent.com/document/api/1000/101057) + + + +## 腾讯电子签企业版(ess) 版本：2020-11-11 + +### 第 132 次发布 + +发布时间：2023-11-02 01:44:45 本次发布包含了以下内容： 改善已有的文档。 +新增接口： + +* [CreateBatchQuickSignUrl](https://cloud.tencent.com/document/api/1323/101058) + + + +## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 + +### 第 124 次发布 + +发布时间：2023-11-02 01:45:47 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [ChannelCreateBatchQuickSignUrl](https://cloud.tencent.com/document/api/1420/101059) + +修改接口： + +* [DescribeTemplates](https://cloud.tencent.com/document/api/1420/61521) + + * 新增入参：TemplateIds + + 修改数据结构： -* [OriginGroup](https://cloud.tencent.com/document/api/1552/80721#OriginGroup) +* [ApproverOption](https://cloud.tencent.com/document/api/1420/61525#ApproverOption) - * 新增成员：HostHeader + * 新增成员：NoRefuse -## 边缘安全加速平台(teo) 版本：2022-01-06 +## 腾讯电子签（基础版）(essbasic) 版本：2020-12-22 + + + +## 消息队列 TDMQ(tdmq) 版本：2020-02-17 + +### 第 85 次发布 + +发布时间：2023-11-02 02:24:43 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [DescribeRocketMQConsumeStats](https://cloud.tencent.com/document/api/1179/101060) +* [VerifyRocketMQConsume](https://cloud.tencent.com/document/api/1179/101061) + +新增数据结构： + +* [ConsumerStats](https://cloud.tencent.com/document/api/1179/46089#ConsumerStats) + + + +## 私有网络(vpc) 版本：2017-03-12 + +### 第 178 次发布 + +发布时间：2023-11-02 02:40:08 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [BandwidthPackage](https://cloud.tencent.com/document/api/215/15824#BandwidthPackage) + + * 新增成员：Deadline + @@ -48696,6 +48779,18 @@ ## 数字版权管理(drm) 版本：2018-11-15 +### 第 5 次发布 + +发布时间：2023-11-02 01:38:44 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[DescribeDRMLicense](https://cloud.tencent.com/document/api/1000/101057)](https://cloud.tencent.com/document/api/#/#) + ### 第 4 次发布 发布时间：2020-01-09 17:18:24 @@ -55396,6 +55491,18 @@ ## 腾讯电子签企业版(ess) 版本：2020-11-11 +### 第 132 次发布 + +发布时间：2023-11-02 01:44:45 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[CreateBatchQuickSignUrl](https://cloud.tencent.com/document/api/1323/101058)](https://cloud.tencent.com/document/api/#/#) + ### 第 131 次发布 发布时间：2023-10-25 01:16:49 @@ -57965,6 +58072,32 @@ ## 腾讯电子签（基础版）(essbasic) 版本：2021-05-26 +### 第 124 次发布 + +发布时间：2023-11-02 01:45:47 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[ChannelCreateBatchQuickSignUrl](https://cloud.tencent.com/document/api/1420/101059)](https://cloud.tencent.com/document/api/#/#) + +修改接口： + +* [DescribeTemplates](https://cloud.tencent.com/document/api/1420/61521) + + * 新增入参：TemplateIds + + +修改数据结构： + +* [ApproverOption](https://cloud.tencent.com/document/api/1420/61525#ApproverOption) + + * 新增成员：NoRefuse + + ### 第 123 次发布 发布时间：2023-10-20 01:15:49 @@ -107481,6 +107614,23 @@ ## 消息队列 TDMQ(tdmq) 版本：2020-02-17 +### 第 85 次发布 + +发布时间：2023-11-02 02:24:43 + +本次发布包含了以下内容： + +改善已有的文档。 + +新增接口： + +* [[DescribeRocketMQConsumeStats](https://cloud.tencent.com/document/api/1179/101060)](https://cloud.tencent.com/document/api/#/#) +* [[VerifyRocketMQConsume](https://cloud.tencent.com/document/api/1179/101061)](https://cloud.tencent.com/document/api/#/#) + +新增数据结构： + +* [[ConsumerStats](https://cloud.tencent.com/document/api/1179/46089#ConsumerStats)](https://cloud.tencent.com/document/api/1179/46089#[ConsumerStats](https://cloud.tencent.com/document/api/1179/46089#ConsumerStats)) + ### 第 84 次发布 发布时间：2023-11-01 01:22:25 @@ -131913,6 +132063,21 @@ ## 私有网络(vpc) 版本：2017-03-12 +### 第 178 次发布 + +发布时间：2023-11-02 02:40:08 + +本次发布包含了以下内容： + +改善已有的文档。 + +修改数据结构： + +* [BandwidthPackage](https://cloud.tencent.com/document/api/215/15824#BandwidthPackage) + + * 新增成员：Deadline + + ### 第 177 次发布 发布时间：2023-10-31 02:45:47 diff --git a/package-lock.json b/package-lock.json index 7d1e884d3..c4cf81508 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "tencentcloud-sdk-nodejs", - "version": "4.0.719", + "version": "4.0.720", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "tencentcloud-sdk-nodejs", - "version": "4.0.719", + "version": "4.0.720", "license": "Apache-2.0", "dependencies": { "form-data": "^3.0.0", diff --git a/package.json b/package.json index a88380c62..99e357c9c 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "tencentcloud-sdk-nodejs", - "version": "4.0.719", + "version": "4.0.720", "description": "腾讯云 API NODEJS SDK", "main": "tencentcloud/index.js", "scripts": { diff --git a/products.md b/products.md index 33330711e..a19739709 100644 --- a/products.md +++ b/products.md @@ -82,7 +82,7 @@ | dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-10-27 01:38:16 | | dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-10-26 01:13:41 | | domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-10-20 01:14:01 | -| drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-08-17 02:59:36 | +| drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-11-02 01:38:44 | | ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-08-17 02:59:40 | | dsgc | [数据安全治理中心](https://cloud.tencent.com/document/product/1087) | 2023-10-17 01:15:42 | | dtf | [分布式事务](https://cloud.tencent.com/document/product/1224) | 2022-04-04 06:38:57 | @@ -95,8 +95,8 @@ | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 | | emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-10-16 01:15:50 | | es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-10-30 00:42:05 | -| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-10-31 01:49:17 | -| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2023-11-01 01:14:11 | +| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-11-02 01:44:45 | +| essbasic | [腾讯电子签（基础版）](https://cloud.tencent.com/document/product/1420) | 2023-11-02 01:45:47 | | facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-09-18 01:48:33 | | faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-10-20 01:16:02 | | fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 | @@ -141,7 +141,7 @@ | mmps | [小程序安全](https://cloud.tencent.com/document/product/1223) | 2023-05-18 01:39:20 | | mna | [多网聚合加速](https://cloud.tencent.com/document/product/1385) | 2023-10-18 02:23:34 | | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-09-15 02:08:53 | -| monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-10-30 01:00:00 | +| monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-11-02 02:02:38 | | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-10-25 01:21:31 | | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-11-01 01:18:18 | | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-10-17 01:22:38 | @@ -159,7 +159,7 @@ | privatedns | [私有域解析 Private DNS](https://cloud.tencent.com/document/product/1338) | 2023-10-13 01:22:04 | | pts | [云压测](https://cloud.tencent.com/document/product/1484) | 2023-08-24 01:24:59 | | rce | [全栈式风控引擎](https://cloud.tencent.com/document/product/1343) | 2023-10-31 02:15:24 | -| redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2023-10-30 01:08:20 | +| redis | [云数据库Redis](https://cloud.tencent.com/document/product/239) | 2023-11-02 02:10:56 | | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2023-10-13 01:22:28 | | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-08-17 04:33:51 | | rp | [注册保护](https://cloud.tencent.com/document/product/1191) | 2022-04-04 07:04:06 | @@ -197,7 +197,7 @@ | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-11-01 01:21:35 | | tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 | | tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2023-07-24 01:49:20 | -| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-11-01 01:22:25 | +| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-11-02 02:24:43 | | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-05-18 01:55:50 | | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-08-30 01:25:15 | | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-11-01 11:21:19 | @@ -228,7 +228,7 @@ | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-05-18 02:04:19 | | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 | | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-10-30 01:34:07 | -| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-11-01 01:25:39 | +| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-11-02 02:40:08 | | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 | | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-11-01 01:26:18 | | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 | diff --git a/src/common/sdk_version.ts b/src/common/sdk_version.ts index 8fe813380..fde6df404 100755 --- a/src/common/sdk_version.ts +++ b/src/common/sdk_version.ts @@ -1 +1 @@ -export const sdkVersion = "4.0.719" +export const sdkVersion = "4.0.720" diff --git a/src/services/btoe/index.ts b/src/services/btoe/index.ts index cbf73fe89..8575cb008 100644 --- a/src/services/btoe/index.ts +++ b/src/services/btoe/index.ts @@ -1,7 +1,7 @@ -import { v20210514 } from "./v20210514" import { v20210303 } from "./v20210303" +import { v20210514 } from "./v20210514" export const btoe = { - v20210514: v20210514, v20210303: v20210303, + v20210514: v20210514, } diff --git a/src/services/dbbrain/index.ts b/src/services/dbbrain/index.ts index c1976f062..dfffd5353 100644 --- a/src/services/dbbrain/index.ts +++ b/src/services/dbbrain/index.ts @@ -1,7 +1,7 @@ -import { v20210527 } from "./v20210527" import { v20191016 } from "./v20191016" +import { v20210527 } from "./v20210527" export const dbbrain = { - v20210527: v20210527, v20191016: v20191016, + v20210527: v20210527, } diff --git a/src/services/drm/v20181115/drm_client.ts b/src/services/drm/v20181115/drm_client.ts index 01aea4ae7..8ca41de7c 100644 --- a/src/services/drm/v20181115/drm_client.ts +++ b/src/services/drm/v20181115/drm_client.ts @@ -29,11 +29,13 @@ import { ModifyFairPlayPemResponse, DescribeFairPlayPemResponse, Key, + DescribeDRMLicenseResponse, PlaybackPolicy, AddFairPlayPemResponse, AddFairPlayPemRequest, DeleteFairPlayPemRequest, DescribeKeysResponse, + DescribeDRMLicenseRequest, DescribeAllKeysResponse, StartEncryptionRequest, ModifyFairPlayPemRequest, @@ -120,6 +122,17 @@ export class Client extends AbstractClient { return this.request("DescribeKeys", req, cb) } + /** + * 开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo + + */ + async DescribeDRMLicense( + req: DescribeDRMLicenseRequest, + cb?: (error: string, rep: DescribeDRMLicenseResponse) => void + ): Promise { + return this.request("DescribeDRMLicense", req, cb) + } + /** * 本接口用来查询指定DRM类型、ContentType的所有加密密钥 diff --git a/src/services/drm/v20181115/drm_models.ts b/src/services/drm/v20181115/drm_models.ts index c8d469835..14edd136c 100644 --- a/src/services/drm/v20181115/drm_models.ts +++ b/src/services/drm/v20181115/drm_models.ts @@ -245,6 +245,24 @@ export interface Key { InsertTimestamp: number } +/** + * DescribeDRMLicense返回参数结构体 + */ +export interface DescribeDRMLicenseResponse { + /** + * 内容ID。 + */ + ContentId: string + /** + * 加密密钥。 + */ + TXEncryptionToken: string + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string +} + /** * 播放控制参数 */ @@ -354,6 +372,28 @@ Fairplay方案无该值。 RequestId?: string } +/** + * DescribeDRMLicense请求参数结构体 + */ +export interface DescribeDRMLicenseRequest { + /** + * 使用的DRM方案类型，接口取值 NORMALAES 。 + */ + DrmType: string + /** + * 加密的track列表，接口取值 SD 。 + */ + Tracks: Array + /** + * 一个加密内容的唯一标识。 + */ + ContentId: string + /** + * 内容类型。接口取值 LiveVideo 。 + */ + ContentType: string +} + /** * DescribeAllKeys返回参数结构体 */ diff --git a/src/services/dts/index.ts b/src/services/dts/index.ts index 81700db88..cd2ea38aa 100644 --- a/src/services/dts/index.ts +++ b/src/services/dts/index.ts @@ -1,7 +1,7 @@ -import { v20180330 } from "./v20180330" import { v20211206 } from "./v20211206" +import { v20180330 } from "./v20180330" export const dts = { - v20180330: v20180330, v20211206: v20211206, + v20180330: v20180330, } diff --git a/src/services/ess/v20201111/ess_client.ts b/src/services/ess/v20201111/ess_client.ts index 3b831792d..431e71fa8 100644 --- a/src/services/ess/v20201111/ess_client.ts +++ b/src/services/ess/v20201111/ess_client.ts @@ -49,6 +49,7 @@ import { StartFlowResponse, SealInfo, StaffRole, + CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, @@ -212,6 +213,7 @@ import { CreateFlowResponse, DescribeUserAutoSignStatusRequest, FilledComponent, + CreateBatchQuickSignUrlRequest, FileUrl, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, @@ -229,20 +231,20 @@ export class Client extends AbstractClient { } /** - * 获取设置自动签印章小程序链接。 - -注意： -
  • 需要企业开通自动签后使用。
    • -
  • 仅支持已经开通了自动签的个人更换自动签印章。
    • -
  • 链接有效期默认7天，最多30天。
    • -
  • 该接口的链接适用于小程序端。
    • -
  • 该接口不会扣除您的合同套餐，暂不参与计费。
+ * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署
+`注意：`
+`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。`
+`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。`
+`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。`
+`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。`
+`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`
+跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置 */ - async CreateUserAutoSignSealUrl( - req: CreateUserAutoSignSealUrlRequest, - cb?: (error: string, rep: CreateUserAutoSignSealUrlResponse) => void - ): Promise { - return this.request("CreateUserAutoSignSealUrl", req, cb) + async CreateBatchQuickSignUrl( + req: CreateBatchQuickSignUrlRequest, + cb?: (error: string, rep: CreateBatchQuickSignUrlResponse) => void + ): Promise { + return this.request("CreateBatchQuickSignUrl", req, cb) } /** @@ -340,6 +342,23 @@ export class Client extends AbstractClient { return this.request("DescribeFileUrls", req, cb) } + /** + * 获取设置自动签印章小程序链接。 + +注意： +
  • 需要企业开通自动签后使用。
    • +
  • 仅支持已经开通了自动签的个人更换自动签印章。
    • +
  • 链接有效期默认7天，最多30天。
    • +
  • 该接口的链接适用于小程序端。
    • +
  • 该接口不会扣除您的合同套餐，暂不参与计费。
+ */ + async CreateUserAutoSignSealUrl( + req: CreateUserAutoSignSealUrlRequest, + cb?: (error: string, rep: CreateUserAutoSignSealUrlResponse) => void + ): Promise { + return this.request("CreateUserAutoSignSealUrl", req, cb) + } + /** * 获取个人用户自动签的开通链接。 diff --git a/src/services/ess/v20201111/ess_models.ts b/src/services/ess/v20201111/ess_models.ts index 887548f0e..35cf806f1 100644 --- a/src/services/ess/v20201111/ess_models.ts +++ b/src/services/ess/v20201111/ess_models.ts @@ -831,6 +831,20 @@ export interface StaffRole { RoleName?: string } +/** + * CreateBatchQuickSignUrl返回参数结构体 + */ +export interface CreateBatchQuickSignUrlResponse { + /** + * 签署人签署链接信息 + */ + FlowApproverUrlInfo?: FlowApproverUrlInfo + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string +} + /** * CreateIntegrationRole请求参数结构体 */ @@ -3447,7 +3461,7 @@ export interface FlowCreateApprover { 注:
  • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
    • -
  • 此字段不可传多个校验方式
+
  • 此字段可传多个校验方式
    • `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主` @@ -4680,7 +4694,9 @@ export interface ApproverInfo { */ ApproverRole?: number /** - * 自定义签署人角色名：收款人、开具人、见证人 + * 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 + +注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的` */ ApproverRoleName?: string /** @@ -4727,7 +4743,7 @@ export interface ApproverInfo { 注:
    • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
      • -
    • 此字段不可传多个校验方式
    +
  • 此字段可传多个校验方式
    • */ ApproverVerifyTypes?: Array /** @@ -6774,6 +6790,57 @@ export interface FilledComponent { ImageUrl?: string } +/** + * CreateBatchQuickSignUrl请求参数结构体 + */ +export interface CreateBatchQuickSignUrlRequest { + /** + * 批量签署的合同流程ID数组。 +注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。` + */ + FlowIds: Array + /** + * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 +注: +`1. ApproverType目前只支持个人类型的签署人。` +`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。` +`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。` + */ + FlowApproverInfo: FlowCreateApprover + /** + * 代理企业和员工的信息。 +在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。 + */ + Agent?: Agent + /** + * 执行本接口操作的员工信息。 +注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` + */ + Operator?: UserInfo + /** + * 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议) + */ + JumpUrl?: string + /** + * 指定批量签署合同的签名类型，可传递以下值： +
    • **0**：手写签名(默认)
      • +
    • **1**：OCR楷体
    +注： +
    • 默认情况下，签名类型为手写签名
      • +
    • 您可以传递多种值，表示可用多种签名类型。
    + */ + SignatureTypes?: Array + /** + * 指定批量签署合同的认证校验方式，可传递以下值： +
    • **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
      • +
    • **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
    +注： +
    • 默认情况下，认证校验方式为人脸认证
      • +
    • 您可以传递多种值，表示可用多种认证校验方式。
    + */ + ApproverSignTypes?: Array +} + /** * 下载文件的URL信息 */ diff --git a/src/services/essbasic/index.ts b/src/services/essbasic/index.ts index d201ea196..7b5b31ffc 100644 --- a/src/services/essbasic/index.ts +++ b/src/services/essbasic/index.ts @@ -1,7 +1,7 @@ -import { v20210526 } from "./v20210526" import { v20201222 } from "./v20201222" +import { v20210526 } from "./v20210526" export const essbasic = { - v20210526: v20210526, v20201222: v20201222, + v20210526: v20210526, } diff --git a/src/services/essbasic/v20210526/essbasic_client.ts b/src/services/essbasic/v20210526/essbasic_client.ts index 64d941f65..9cc97afbf 100644 --- a/src/services/essbasic/v20210526/essbasic_client.ts +++ b/src/services/essbasic/v20210526/essbasic_client.ts @@ -59,6 +59,7 @@ import { ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, + UploadFilesResponse, Agent, ChannelCreatePreparedPersonalEsignResponse, FlowApproverDetail, @@ -107,6 +108,7 @@ import { ChannelCreateUserAutoSignSealUrlResponse, ApproverComponentLimitType, ResourceUrlInfo, + ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, AuthorizedUser, @@ -137,7 +139,7 @@ import { FlowApproverItem, CreateSignUrlsResponse, ChannelDeleteRoleRequest, - UploadFilesResponse, + ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, ApproverRestriction, PrepareFlowsRequest, @@ -232,6 +234,42 @@ export class Client extends AbstractClient { return this.request("ChannelCreateFlowSignReview", req, cb) } + /** + * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。 + +跳转小程序的几种方式：主要是设置不同的EndPoint +1. 通过链接Url直接跳转到小程序，不需要返回 +设置EndPoint为WEIXINAPP，得到链接打开即可。 + +2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App +跳转到小程序的实现，参考官方文档 +https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html +其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 +设置EndPoint为APP，得到path。 + +4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 +跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） +全屏方式： +（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） +半屏方式： +（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） +其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 +设置EndPoint为APP，得到path。 + +其中小程序的原始Id如下，或者查看小程序信息自助获取。 + +| 小程序 | AppID | 原始ID | +| ------------ | ------------ | ------------ | +| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | +| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | + */ + async ModifyExtendedService( + req: ModifyExtendedServiceRequest, + cb?: (error: string, rep: ModifyExtendedServiceResponse) => void + ): Promise { + return this.request("ModifyExtendedService", req, cb) + } + /** * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。 @@ -383,44 +421,26 @@ export class Client extends AbstractClient { } /** - * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。 - -跳转小程序的几种方式：主要是设置不同的EndPoint -1. 通过链接Url直接跳转到小程序，不需要返回 -设置EndPoint为WEIXINAPP，得到链接打开即可。 - -2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App -跳转到小程序的实现，参考官方文档 -https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html -其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 -设置EndPoint为APP，得到path。 - -4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 -跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） -全屏方式： -（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） -半屏方式： -（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） -其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 -设置EndPoint为APP，得到path。 - -其中小程序的原始Id如下，或者查看小程序信息自助获取。 - -| 小程序 | AppID | 原始ID | -| ------------ | ------------ | ------------ | -| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | -| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | + * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 +相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355 */ - async ModifyExtendedService( - req: ModifyExtendedServiceRequest, - cb?: (error: string, rep: ModifyExtendedServiceResponse) => void - ): Promise { - return this.request("ModifyExtendedService", req, cb) + async ChannelDescribeRoles( + req: ChannelDescribeRolesRequest, + cb?: (error: string, rep: ChannelDescribeRolesResponse) => void + ): Promise { + return this.request("ChannelDescribeRoles", req, cb) } /** - * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。 - */ + * 此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。
    +前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。
    +适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 +适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同
    +转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。
    +注: +1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt` +2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果` + */ async ChannelCreateConvertTaskApi( req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void @@ -482,17 +502,20 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp } /** - * 此接口（ChannelCreateRole）用来创建企业自定义角色。 - -适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 - -适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 + * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署
    +`注意：`
    +`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。`
    +`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。`
    +`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。`
    +`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。`
    +`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`
    +跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置 */ - async ChannelCreateRole( - req: ChannelCreateRoleRequest, - cb?: (error: string, rep: ChannelCreateRoleResponse) => void - ): Promise { - return this.request("ChannelCreateRole", req, cb) + async ChannelCreateBatchQuickSignUrl( + req: ChannelCreateBatchQuickSignUrlRequest, + cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void + ): Promise { + return this.request("ChannelCreateBatchQuickSignUrl", req, cb) } /** @@ -607,6 +630,11 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos + +注意： + +>1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。 +>2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准 */ async DescribeTemplates( req: DescribeTemplatesRequest, @@ -739,8 +767,12 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 } /** - * 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。 -注意：大文件转换所需的时间可能会比较长。 + * 此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作
    +前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。
    + +适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。
    +注： +1. `大文件转换所需的时间可能会比较长` */ async ChannelGetTaskResultApi( req: ChannelGetTaskResultApiRequest, @@ -854,18 +886,16 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 } /** - * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： - -1. 合同中当前状态为“待签署”的签署人是催办的对象 -2. 每个合同只能催办一次 - -注意：该接口无法直接调用，请联系客户经理申请使用。 + * 该接口用于发起合同后，生成C端签署人的签署链接
    +注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    +注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    +注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    */ - async ChannelCreateFlowReminds( - req: ChannelCreateFlowRemindsRequest, - cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void - ): Promise { - return this.request("ChannelCreateFlowReminds", req, cb) + async ChannelCreateFlowSignUrl( + req: ChannelCreateFlowSignUrlRequest, + cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void + ): Promise { + return this.request("ChannelCreateFlowSignUrl", req, cb) } /** @@ -917,7 +947,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 /** * 该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。 -目前该接口只支持B2C，不建议使用，将会废弃。 +目前该接口只支持B2C，不建议使用，将会**废弃**。 */ async PrepareFlows( req: PrepareFlowsRequest, @@ -959,14 +989,17 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 } /** - * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 -相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355 + * 此接口（ChannelCreateRole）用来创建企业自定义角色。 + +适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 + +适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 */ - async ChannelDescribeRoles( - req: ChannelDescribeRolesRequest, - cb?: (error: string, rep: ChannelDescribeRolesResponse) => void - ): Promise { - return this.request("ChannelDescribeRoles", req, cb) + async ChannelCreateRole( + req: ChannelCreateRoleRequest, + cb?: (error: string, rep: ChannelCreateRoleResponse) => void + ): Promise { + return this.request("ChannelCreateRole", req, cb) } /** @@ -1033,16 +1066,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn"); } /** - * 该接口用于发起合同后，生成C端签署人的签署链接
    -注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    -注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    -注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    + * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： + +1. 合同中当前状态为“待签署”的签署人是催办的对象 +2. 每个合同只能催办一次 + +注意：该接口无法直接调用，请联系客户经理申请使用。 */ - async ChannelCreateFlowSignUrl( - req: ChannelCreateFlowSignUrlRequest, - cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void - ): Promise { - return this.request("ChannelCreateFlowSignUrl", req, cb) + async ChannelCreateFlowReminds( + req: ChannelCreateFlowRemindsRequest, + cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void + ): Promise { + return this.request("ChannelCreateFlowReminds", req, cb) } /** diff --git a/src/services/essbasic/v20210526/essbasic_models.ts b/src/services/essbasic/v20210526/essbasic_models.ts index be4ae4574..2bd609062 100644 --- a/src/services/essbasic/v20210526/essbasic_models.ts +++ b/src/services/essbasic/v20210526/essbasic_models.ts @@ -30,7 +30,7 @@ export interface SyncProxyOrganizationResponse { */ export interface ChannelCreateConvertTaskApiResponse { /** - * 任务id + * 接口返回的文件转换任务Id，可以调用接口查询转换任务状态获取转换任务的状态和转换后的文件资源Id。 */ TaskId?: string /** @@ -1277,19 +1277,41 @@ export interface ChannelCreateWebThemeConfigRequest { */ export interface ChannelCreateConvertTaskApiRequest { /** - * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + +此接口下面信息必填。 +
      +
    • 渠道应用标识: Agent.AppId
      • +
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
      • +
    • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
      • +
    +第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent /** - * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型 + * 需要进行转换的资源文件类型 +支持的文件类型如下： +
    • doc
      • +
    • docx
      • +
    • xls
      • +
    • xlsx
      • +
    • jpg
      • +
    • jpeg
      • +
    • png
      • +
    • bmp
      • +
    • txt
    */ ResourceType: string /** - * 资源名称，长度限制为256字符 + * 需要进行转换操作的文件资源名称，带资源后缀名。 + +注: `资源名称长度限制为256个字符` */ ResourceName: string /** - * 文件Id，通过UploadFiles获取 + * 需要进行转换操作的文件资源Id，通过UploadFiles接口获取文件资源Id。 + +注: `目前，此接口仅支持单个文件进行转换。` */ ResourceId: string /** @@ -1445,6 +1467,31 @@ MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverM Operator?: UserInfo } +/** + * UploadFiles返回参数结构体 + */ +export interface UploadFilesResponse { + /** + * 上传成功文件数量 +注: `如果一个文件上传失败, 则全部文件皆上传失败` + */ + TotalCount?: number + /** + * 文件资源ID数组，每个文件资源ID为32位字符串。 +建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。 +注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用` + */ + FileIds?: Array + /** + * 对应上传文件的下载链接，过期时间5分钟 + */ + FileUrls?: Array + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string +} + /** * 应用相关信息 */ @@ -1981,15 +2028,15 @@ false-否 */ export interface DescribeTemplatesResponse { /** - * 模板列表 + * 模板详情列表数据 */ Templates?: Array /** - * 查询到的总数 + * 查询到的模板总数 */ TotalCount?: number /** - * 每页多少条数据 + * 每页返回的数据条数 */ Limit?: number /** @@ -3253,15 +3300,19 @@ CreateFlowsByTemplates 接口不使用此字段。 */ export interface FlowInfo { /** - * 合同名字，最大长度200个字符 + * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */ FlowName: string /** - * 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年 + * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 +如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 +示例值：1604912664 */ Deadline: number /** - * 模板ID + * 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 + +可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。 */ TemplateId?: string /** @@ -3273,42 +3324,70 @@ export interface FlowInfo { */ FormFields?: Array /** - * 回调地址，最大长度1000个字符 + * 合同状态变动结的通知回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性，最大长度1000个字符。 + +腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。 +回调的相关说明可参考开发者中心的回调通知模块 */ CallbackUrl?: string /** - * 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符 + * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 */ FlowType?: string /** - * 合同描述，最大长度1000个字符 + * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。 */ FlowDescription?: string /** - * 第三方应用平台的业务信息，最大长度1000个字符。 + * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 + +在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 */ CustomerData?: string /** - * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 + * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： +
    • {合同名称}
      • +
    • {发起方企业}
      • +
    • {发起方姓名}
      • +
    • {签署方N企业}
      • +
    • {签署方N姓名}
    +其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 + +例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子 + +合同名称：租房合同 +发起方：腾讯公司(张三) +签署方：李四 + + */ CustomShowMap?: string /** - * 被抄送人的信息列表，抄送功能暂不开放 + * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 + +注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。` */ CcInfos?: Array /** - * 发起方企业的签署人进行签署操作是否需要企业内部审批。 -若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 - -注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。 + * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： +
    • **false**：（默认）不需要审批，直接签署。
      • +
    • **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    +企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 +
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
      • +
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    +注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同` */ NeedSignReview?: boolean /** - * 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知 + * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： +
    • **0** :合同发起时通知通知对方来查看合同（默认）
      • +
    • **1** : 签署完成后通知对方来查看合同
    */ CcNotifyType?: number /** - * 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN + * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： +
    • **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）
    +注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。` */ AutoSignScene?: string } @@ -3442,6 +3521,51 @@ export interface ResourceUrlInfo { Type?: string } +/** + * ChannelCreateBatchQuickSignUrl请求参数结构体 + */ +export interface ChannelCreateBatchQuickSignUrlRequest { + /** + * 批量签署的合同流程ID数组。 +注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。` + */ + FlowIds: Array + /** + * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 +注: +`1. ApproverType目前只支持个人类型的签署人。` +`2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。` +`3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。` + */ + FlowApproverInfo: FlowApproverInfo + /** + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + */ + Agent?: Agent + /** + * 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议) + */ + JumpUrl?: string + /** + * 指定批量签署合同的签名类型，可传递以下值： +
    • **0**：手写签名(默认)
      • +
    • **1**：OCR楷体
    +注： +
    • 默认情况下，签名类型为手写签名
      • +
    • 您可以传递多种值，表示可用多种签名类型。
    + */ + SignatureTypes?: Array + /** + * 指定批量签署合同的认证校验方式，可传递以下值： +
    • **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
      • +
    • **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
    +注： +
    • 默认情况下，认证校验方式为人脸认证
      • +
    • 您可以传递多种值，表示可用多种认证校验方式。
    + */ + ApproverSignTypes?: Array +} + /** * ChannelCreateBoundFlows请求参数结构体 */ @@ -3930,9 +4054,13 @@ export interface FlowApproverInfo { */ ApproverNeedSignReview?: boolean /** - * 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 -查看合同的认证方式 Flow层级的优先于approver层级的 -（当手写签名方式为OCR_ESIGN时，合同认证方式2无效，因为这种签名方式依赖实名认证） + * 指定个人签署方查看合同的校验方式,可以传值如下: +
    • **1** : （默认）人脸识别,人脸识别后才能合同内容
      • +
    • **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） +
    +注: +
    • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
      • +
    • 此字段可传多个校验方式
    */ ApproverVerifyTypes?: Array /** @@ -3967,7 +4095,9 @@ export interface FlowApproverInfo { */ AddSignComponentsLimits?: Array /** - * 自定义签署人角色名，如收款人、开具人、见证人等 + * 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 + +注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的` */ ApproverRoleName?: string } @@ -4011,11 +4141,19 @@ export interface ChannelCreateUserAutoSignEnableUrlResponse { */ export interface ChannelGetTaskResultApiRequest { /** - * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。 + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + +此接口下面信息必填。 +
      +
    • 渠道应用标识: Agent.AppId
      • +
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
      • +
    • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
      • +
    +第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent /** - * 任务Id，通过ChannelCreateConvertTaskApi接口获得 + * 转换任务Id，通过接口创建文件转换任务接口得到的转换任务id */ TaskId: string /** @@ -4465,24 +4603,13 @@ export interface ChannelDeleteRoleRequest { } /** - * UploadFiles返回参数结构体 + * ChannelCreateBatchQuickSignUrl返回参数结构体 */ -export interface UploadFilesResponse { - /** - * 上传成功文件数量 -注: `如果一个文件上传失败, 则全部文件皆上传失败` - */ - TotalCount?: number +export interface ChannelCreateBatchQuickSignUrlResponse { /** - * 文件资源ID数组，每个文件资源ID为32位字符串。 -建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。 -注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用` + * 签署人签署链接信息 */ - FileIds?: Array - /** - * 对应上传文件的下载链接，过期时间5分钟 - */ - FileUrls?: Array + FlowApproverUrlInfo?: FlowApproverUrlInfo /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ @@ -4790,6 +4917,10 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse { * 签署人个性化能力信息 */ export interface ApproverOption { + /** + * 是否可以拒签 默认false-可以拒签 true-不可以拒签 + */ + NoRefuse?: boolean /** * 是否隐藏一键签署 默认false-不隐藏true-隐藏 */ @@ -4905,26 +5036,26 @@ export interface ChannelGetTaskResultApiResponse { TaskId?: string /** * 任务状态，需要关注的状态 -0 :NeedTranform - 任务已提交 -4 :Processing - 文档转换中 -8 :TaskEnd - 任务处理完成 --2 :DownloadFailed - 下载失败 --6 :ProcessFailed - 转换失败 --13:ProcessTimeout - 转换文件超时 +
    • **0** :NeedTranform - 任务已提交
      • +
    • **4** :Processing - 文档转换中
      • +
    • **8** :TaskEnd - 任务处理完成
      • +
    • **-2** :DownloadFailed - 下载失败
      • +
    • **-6** :ProcessFailed - 转换失败
      • +
    • **-13**:ProcessTimeout - 转换文件超时
    */ TaskStatus?: number /** * 状态描述，需要关注的状态 -NeedTranform - 任务已提交 -Processing - 文档转换中 -TaskEnd - 任务处理完成 -DownloadFailed - 下载失败 -ProcessFailed - 转换失败 -ProcessTimeout - 转换文件超时 +
    • **NeedTranform** : 任务已提交
      • +
    • **Processing** : 文档转换中
      • +
    • **TaskEnd** : 任务处理完成
      • +
    • **DownloadFailed** : 下载失败
      • +
    • **ProcessFailed** : 转换失败
      • +
    • **ProcessTimeout** : 转换文件超时
    */ TaskMessage?: string /** - * 资源Id，也是FileId，用于文件发起使用 + * 资源Id，也是FileId，用于文件发起时使用 */ ResourceId?: string /** @@ -5340,55 +5471,90 @@ export interface ChannelCancelFlowRequest { */ export interface DescribeTemplatesRequest { /** - * 应用相关信息。 -此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。 + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + +此接口下面信息必填。 +
      +
    • 渠道应用标识: Agent.AppId
      • +
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
      • +
    • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
      • +
    +第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent /** - * 模板唯一标识，查询单个模板时使用 + * 合同模板ID，为32位字符串。 +建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 */ TemplateId?: string /** - * 查询内容： -0-模板列表及详情（默认）， -1-仅模板列表 + * 查询内容控制 + +
    • **0**：模板列表及详情（默认）
      • +
    • **1**：仅模板列表
    */ ContentType?: number /** - * 指定每页多少条数据，如果不传默认为20，单页最大100。 + * 合同模板ID数组，每一个合同模板ID为32位字符串。 +建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 + +```注意: +1. 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。 +2. 请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。 +3. 最多支持200个模板。 +4. 若传递此参数，分页参数(Limit,Offset)无效``` + + */ + TemplateIds?: Array + /** + * 指定每页返回的数据条数，和Offset参数配合使用。 + +注：`1.默认值为20，单页做大值为200。` */ Limit?: number /** - * 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。 + * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 + +注：`1.offset从0开始，即第一页为0。` +`2.默认从第一页返回。` */ Offset?: number /** - * 是否返回所有组件信息。 -默认false，只返回发起方控件； -true，返回所有签署方控件 + * 模糊搜索的模板名称，注意是模板名的连续部分，最大长度200 */ - QueryAllComponents?: boolean + TemplateName?: string /** - * 模糊搜索模板名称，最大长度200 + * 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。 */ - TemplateName?: string + ChannelTemplateId?: string + /** + * 是否返回所有控件信息。 + +
    • **false**：只返回发起方控件（默认）
      • +
    • **true**：返回所有签署方控件
    + */ + QueryAllComponents?: boolean /** - * 是否获取模板预览链接， -默认false-不获取 -true-获取 + * 是否获取模板预览链接。 + +
    • **false**：不获取（默认）
      • +
    • **true**：获取
    + +设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,有效期5分钟。 +可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。 +（此功能开放需要联系客户经理） */ WithPreviewUrl?: boolean /** * 是否获取模板的PDF文件链接。 -默认false-不获取 -true-获取 -请联系客户经理开白后使用。 + +
    • **false**：不获取（默认）
      • +
    • **true**：获取
    + +设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟。 +（此功能开放需要联系客户经理） */ WithPdfUrl?: boolean - /** - * 对应第三方应用平台企业的模板ID - */ - ChannelTemplateId?: string /** * 操作者的信息 * @deprecated diff --git a/src/services/ims/index.ts b/src/services/ims/index.ts index de85df2af..6149b35e9 100644 --- a/src/services/ims/index.ts +++ b/src/services/ims/index.ts @@ -1,7 +1,7 @@ -import { v20200713 } from "./v20200713" import { v20201229 } from "./v20201229" +import { v20200713 } from "./v20200713" export const ims = { - v20200713: v20200713, v20201229: v20201229, + v20200713: v20200713, } diff --git a/src/services/iotvideo/index.ts b/src/services/iotvideo/index.ts index ffb622685..bd5d7642a 100644 --- a/src/services/iotvideo/index.ts +++ b/src/services/iotvideo/index.ts @@ -1,9 +1,9 @@ +import { v20201215 } from "./v20201215" import { v20191126 } from "./v20191126" import { v20211125 } from "./v20211125" -import { v20201215 } from "./v20201215" export const iotvideo = { + v20201215: v20201215, v20191126: v20191126, v20211125: v20211125, - v20201215: v20201215, } diff --git a/src/services/sms/index.ts b/src/services/sms/index.ts index d67fb89d2..551a4bb94 100644 --- a/src/services/sms/index.ts +++ b/src/services/sms/index.ts @@ -1,7 +1,7 @@ -import { v20190711 } from "./v20190711" import { v20210111 } from "./v20210111" +import { v20190711 } from "./v20190711" export const sms = { - v20190711: v20190711, v20210111: v20210111, + v20190711: v20190711, } diff --git a/src/services/tdmq/v20200217/tdmq_client.ts b/src/services/tdmq/v20200217/tdmq_client.ts index bed165476..77ba6a87a 100644 --- a/src/services/tdmq/v20200217/tdmq_client.ts +++ b/src/services/tdmq/v20200217/tdmq_client.ts @@ -22,6 +22,7 @@ import { RabbitMQClusterAccessInfo, DescribeBindClustersResponse, DescribeRabbitMQVirtualHostResponse, + RabbitMQClusterWhiteListInfo, CmqDeadLetterPolicy, DescribeNamespaceBundlesOptRequest, DeleteRabbitMQUserRequest, @@ -60,7 +61,7 @@ import { DescribeBindVpcsResponse, RewindCmqQueueResponse, DescribeRocketMQSmoothMigrationTaskRequest, - DeleteClusterRequest, + ConsumerStats, CmqSubscription, DescribeRocketMQSourceClusterGroupListResponse, RocketMQMsgLog, @@ -71,7 +72,7 @@ import { RocketMQSmoothMigrationTaskItem, VpcInfo, ModifyRabbitMQUserRequest, - RabbitMQClusterWhiteListInfo, + DescribeRocketMQConsumeStatsResponse, DeleteCmqTopicResponse, CreateSubscriptionRequest, CreateRocketMQNamespaceRequest, @@ -154,6 +155,7 @@ import { ReceiveMessageResponse, DescribeEnvironmentRolesResponse, DescribeRocketMQPublicAccessPointResponse, + VerifyRocketMQConsumeResponse, DescribeRocketMQMsgTraceRequest, ModifyRocketMQGroupRequest, FilterSubscription, @@ -226,6 +228,7 @@ import { RabbitMQClusterInfo, CreateCmqTopicResponse, CmqDeadLetterSource, + ModifyRabbitMQVipInstanceResponse, ClearCmqSubscriptionFilterTagsResponse, CreateRabbitMQVipInstanceResponse, DescribeRabbitMQVipInstanceRequest, @@ -259,7 +262,7 @@ import { DescribeRabbitMQQueuesRequest, DeleteRocketMQNamespaceResponse, DescribePublishersResponse, - ModifyRabbitMQVipInstanceResponse, + DeleteClusterRequest, SendMsgRequest, ResetRocketMQConsumerOffSetRequest, DescribeCmqQueueDetailRequest, @@ -302,7 +305,7 @@ import { AMQPClusterConfig, Tag, CreateRocketMQNamespaceResponse, - RocketMQInstanceConfig, + DescribeRocketMQConsumeStatsRequest, SendBatchMessagesRequest, DeleteCmqTopicRequest, DescribeRabbitMQNodeListResponse, @@ -310,6 +313,7 @@ import { RocketMQTopicConfig, DescribeNodeHealthOptResponse, ModifyPublicNetworkAccessPointResponse, + RocketMQInstanceConfig, PublishCmqMsgRequest, UnbindCmqDeadLetterRequest, ModifyCmqQueueAttributeRequest, @@ -328,6 +332,7 @@ import { DescribeRabbitMQVipInstancesRequest, AMQPClusterDetail, DescribeClusterDetailResponse, + VerifyRocketMQConsumeRequest, SendBatchMessagesResponse, ImportRocketMQTopicsRequest, CreateEnvironmentRoleRequest, @@ -365,6 +370,16 @@ export class Client extends AbstractClient { return this.request("CreateCluster", req, cb) } + /** + * 获取消费详情列表 + */ + async DescribeRocketMQConsumeStats( + req: DescribeRocketMQConsumeStatsRequest, + cb?: (error: string, rep: DescribeRocketMQConsumeStatsResponse) => void + ): Promise { + return this.request("DescribeRocketMQConsumeStats", req, cb) + } + /** * 获取RocketMQ命名空间列表 */ @@ -1036,6 +1051,16 @@ export class Client extends AbstractClient { return this.request("DescribeRocketMQVipInstances", req, cb) } + /** + * Rocketmq消费验证 + */ + async VerifyRocketMQConsume( + req: VerifyRocketMQConsumeRequest, + cb?: (error: string, rep: VerifyRocketMQConsumeResponse) => void + ): Promise { + return this.request("VerifyRocketMQConsume", req, cb) + } + /** * 获取amqp集群列表 */ diff --git a/src/services/tdmq/v20200217/tdmq_models.ts b/src/services/tdmq/v20200217/tdmq_models.ts index 7c1f28ab7..c52d76fa4 100644 --- a/src/services/tdmq/v20200217/tdmq_models.ts +++ b/src/services/tdmq/v20200217/tdmq_models.ts @@ -129,6 +129,37 @@ export interface DescribeRabbitMQVirtualHostResponse { RequestId?: string } +/** + * RabbiteMQ集群白名单信息 + */ +export interface RabbitMQClusterWhiteListInfo { + /** + * 废弃 +注意：此字段可能返回 null，表示取不到有效值。 + */ + WhiteList: string + /** + * 公网管控台白名单 +注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicControlConsoleWhiteList: string + /** + * 公网数据流白名单 +注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicDataStreamWhiteList: string + /** + * 公网管控台白名单状态 +注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicControlConsoleWhiteListStatus?: string + /** + * 公网数据流白名单状态 +注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicDataStreamWhiteListStatus?: string +} + /** * cmq DeadLetterPolicy */ @@ -1082,13 +1113,49 @@ export interface DescribeRocketMQSmoothMigrationTaskRequest { } /** - * DeleteCluster请求参数结构体 + * 消费详情 */ -export interface DeleteClusterRequest { +export interface ConsumerStats { /** - * 集群Id，传入需要删除的集群Id。 + * 主题名 +注意：此字段可能返回 null，表示取不到有效值。 */ - ClusterId: string + TopicName?: string + /** + * 所属Broker +注意：此字段可能返回 null，表示取不到有效值。 + */ + BrokerName?: string + /** + * 队列编号 +注意：此字段可能返回 null，表示取不到有效值。 + */ + QueueId?: number + /** + * 消费者ID +注意：此字段可能返回 null，表示取不到有效值。 + */ + ConsumerClientId?: string + /** + * 消费位点 +注意：此字段可能返回 null，表示取不到有效值。 + */ + ConsumerOffset?: number + /** + * 服务端位点 +注意：此字段可能返回 null，表示取不到有效值。 + */ + BrokerOffset?: number + /** + * 消息堆积条数 +注意：此字段可能返回 null，表示取不到有效值。 + */ + DiffTotal?: number + /** + * 最近消费时间 +注意：此字段可能返回 null，表示取不到有效值。 + */ + LastTimestamp?: number } /** @@ -1444,34 +1511,17 @@ export interface ModifyRabbitMQUserRequest { } /** - * RabbiteMQ集群白名单信息 + * DescribeRocketMQConsumeStats返回参数结构体 */ -export interface RabbitMQClusterWhiteListInfo { +export interface DescribeRocketMQConsumeStatsResponse { /** - * 废弃 -注意：此字段可能返回 null，表示取不到有效值。 + * 消费详情列表 */ - WhiteList: string - /** - * 公网管控台白名单 -注意：此字段可能返回 null，表示取不到有效值。 - */ - PublicControlConsoleWhiteList: string - /** - * 公网数据流白名单 -注意：此字段可能返回 null，表示取不到有效值。 - */ - PublicDataStreamWhiteList: string - /** - * 公网管控台白名单状态 -注意：此字段可能返回 null，表示取不到有效值。 - */ - PublicControlConsoleWhiteListStatus?: string + ConsumerStatsList?: Array /** - * 公网数据流白名单状态 -注意：此字段可能返回 null，表示取不到有效值。 + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ - PublicDataStreamWhiteListStatus?: string + RequestId?: string } /** @@ -3667,6 +3717,16 @@ export interface DescribeRocketMQPublicAccessPointResponse { RequestId?: string } +/** + * VerifyRocketMQConsume返回参数结构体 + */ +export interface VerifyRocketMQConsumeResponse { + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string +} + /** * DescribeRocketMQMsgTrace请求参数结构体 */ @@ -5627,6 +5687,21 @@ export interface CmqDeadLetterSource { QueueName: string } +/** + * ModifyRabbitMQVipInstance返回参数结构体 + */ +export interface ModifyRabbitMQVipInstanceResponse { + /** + * 实例id +注意：此字段可能返回 null，表示取不到有效值。 + */ + InstanceId?: string + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string +} + /** * ClearCmqSubscriptionFilterTags返回参数结构体 */ @@ -6493,18 +6568,13 @@ export interface DescribePublishersResponse { } /** - * ModifyRabbitMQVipInstance返回参数结构体 + * DeleteCluster请求参数结构体 */ -export interface ModifyRabbitMQVipInstanceResponse { - /** - * 实例id -注意：此字段可能返回 null，表示取不到有效值。 - */ - InstanceId?: string +export interface DeleteClusterRequest { /** - * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + * 集群Id，传入需要删除的集群Id。 */ - RequestId?: string + ClusterId: string } /** @@ -7504,58 +7574,21 @@ export interface CreateRocketMQNamespaceResponse { } /** - * RocketMQ专享集群实例配置 + * DescribeRocketMQConsumeStats请求参数结构体 */ -export interface RocketMQInstanceConfig { - /** - * 单命名空间TPS上线 - */ - MaxTpsPerNamespace?: number - /** - * 最大命名空间数量 - */ - MaxNamespaceNum?: number - /** - * 已使用命名空间数量 - */ - UsedNamespaceNum?: number - /** - * 最大Topic数量 - */ - MaxTopicNum?: number - /** - * 已使用Topic数量 - */ - UsedTopicNum?: number - /** - * 最大Group数量 - */ - MaxGroupNum?: number - /** - * 已使用Group数量 - */ - UsedGroupNum?: number - /** - * 集群类型 - */ - ConfigDisplay?: string +export interface DescribeRocketMQConsumeStatsRequest { /** - * 集群节点数 - */ - NodeCount?: number - /** - * 节点分布情况 + * 实例ID */ - NodeDistribution?: Array + ClusterId: string /** - * topic分布情况 + * 命名空间 */ - TopicDistribution?: Array + NamespaceId: string /** - * 每个主题最大队列数 -注意：此字段可能返回 null，表示取不到有效值。 + * 消费组 */ - MaxQueuesPerTopic?: number + ConsumerGroup: string } /** @@ -7715,6 +7748,61 @@ export interface ModifyPublicNetworkAccessPointResponse { RequestId?: string } +/** + * RocketMQ专享集群实例配置 + */ +export interface RocketMQInstanceConfig { + /** + * 单命名空间TPS上线 + */ + MaxTpsPerNamespace?: number + /** + * 最大命名空间数量 + */ + MaxNamespaceNum?: number + /** + * 已使用命名空间数量 + */ + UsedNamespaceNum?: number + /** + * 最大Topic数量 + */ + MaxTopicNum?: number + /** + * 已使用Topic数量 + */ + UsedTopicNum?: number + /** + * 最大Group数量 + */ + MaxGroupNum?: number + /** + * 已使用Group数量 + */ + UsedGroupNum?: number + /** + * 集群类型 + */ + ConfigDisplay?: string + /** + * 集群节点数 + */ + NodeCount?: number + /** + * 节点分布情况 + */ + NodeDistribution?: Array + /** + * topic分布情况 + */ + TopicDistribution?: Array + /** + * 每个主题最大队列数 +注意：此字段可能返回 null，表示取不到有效值。 + */ + MaxQueuesPerTopic?: number +} + /** * PublishCmqMsg请求参数结构体 */ @@ -8230,6 +8318,36 @@ export interface DescribeClusterDetailResponse { RequestId?: string } +/** + * VerifyRocketMQConsume请求参数结构体 + */ +export interface VerifyRocketMQConsumeRequest { + /** + * 集群id + */ + ClusterId: string + /** + * 命名空间 + */ + NamespaceId: string + /** + * 消费组ID + */ + GroupId: string + /** + * 消息id + */ + MsgId: string + /** + * 客户端ID + */ + ClientId: string + /** + * topic名称 + */ + TopicName: string +} + /** * SendBatchMessages返回参数结构体 */ diff --git a/src/services/tem/index.ts b/src/services/tem/index.ts index b3ee2e949..c83cdb5b2 100644 --- a/src/services/tem/index.ts +++ b/src/services/tem/index.ts @@ -1,7 +1,7 @@ -import { v20210701 } from "./v20210701" import { v20201221 } from "./v20201221" +import { v20210701 } from "./v20210701" export const tem = { - v20210701: v20210701, v20201221: v20201221, + v20210701: v20210701, } diff --git a/src/services/teo/index.ts b/src/services/teo/index.ts index 325132b45..50a5dd8f9 100644 --- a/src/services/teo/index.ts +++ b/src/services/teo/index.ts @@ -1,7 +1,7 @@ -import { v20220106 } from "./v20220106" import { v20220901 } from "./v20220901" +import { v20220106 } from "./v20220106" export const teo = { - v20220106: v20220106, v20220901: v20220901, + v20220106: v20220106, } diff --git a/src/services/tms/index.ts b/src/services/tms/index.ts index 356ad4653..58d02407c 100644 --- a/src/services/tms/index.ts +++ b/src/services/tms/index.ts @@ -1,7 +1,7 @@ -import { v20200713 } from "./v20200713" import { v20201229 } from "./v20201229" +import { v20200713 } from "./v20200713" export const tms = { - v20200713: v20200713, v20201229: v20201229, + v20200713: v20200713, } diff --git a/src/services/tsw/index.ts b/src/services/tsw/index.ts index 344995843..3f8af55d7 100644 --- a/src/services/tsw/index.ts +++ b/src/services/tsw/index.ts @@ -1,7 +1,7 @@ -import { v20200924 } from "./v20200924" import { v20210412 } from "./v20210412" +import { v20200924 } from "./v20200924" export const tsw = { - v20200924: v20200924, v20210412: v20210412, + v20200924: v20200924, } diff --git a/src/services/vm/index.ts b/src/services/vm/index.ts index ec75e8097..bbd18ae55 100644 --- a/src/services/vm/index.ts +++ b/src/services/vm/index.ts @@ -1,9 +1,9 @@ import { v20201229 } from "./v20201229" -import { v20200709 } from "./v20200709" import { v20210922 } from "./v20210922" +import { v20200709 } from "./v20200709" export const vm = { v20201229: v20201229, - v20200709: v20200709, v20210922: v20210922, + v20200709: v20200709, } diff --git a/src/services/vpc/v20170312/vpc_models.ts b/src/services/vpc/v20170312/vpc_models.ts index 14ecd623c..47aaaa7ab 100644 --- a/src/services/vpc/v20170312/vpc_models.ts +++ b/src/services/vpc/v20170312/vpc_models.ts @@ -2121,11 +2121,11 @@ export interface DescribeBandwidthPackagesResponse { /** * 符合条件的带宽包数量 */ - TotalCount: number + TotalCount?: number /** * 描述带宽包详细信息 */ - BandwidthPackageSet: Array + BandwidthPackageSet?: Array /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ @@ -3928,7 +3928,7 @@ export interface DescribeBandwidthPackagesRequest {
  • bandwidth-package_id - String - 是否必填：否 - （过滤条件）按照带宽包的唯一标识ID过滤。
  • bandwidth-package-name - String - 是否必填：否 - （过滤条件）按照 带宽包名称过滤。不支持模糊过滤。
  • network-type - String - 是否必填：否 - （过滤条件）按照带宽包的类型过滤。类型包括'HIGH_QUALITY_BGP','BGP','SINGLEISP'和'ANYCAST'。
    • -
  • charge-type - String - 是否必填：否 - （过滤条件）按照带宽包的计费类型过滤。计费类型包括'TOP5_POSTPAID_BY_MONTH'和'PERCENT95_POSTPAID_BY_MONTH'。
    • +
  • charge-type - String - 是否必填：否 - （过滤条件）按照带宽包的计费类型过滤。计费类型包括:
  • 'TOP5_POSTPAID_BY_MONTH':按月后付费TOP5计费
  • 'PERCENT95_POSTPAID_BY_MONTH':按月后付费月95计费
  • 'ENHANCED95_POSTPAID_BY_MONTH':按月后付费增强型95计费
  • 'FIXED_PREPAID_BY_MONTH':包月预付费计费
  • ‘PEAK_BANDWIDTH_POSTPAID_BY_DAY’: 后付费日结按带宽计费
  • resource.resource-type - String - 是否必填：否 - （过滤条件）按照带宽包资源类型过滤。资源类型包括'Address'和'LoadBalance'
  • resource.resource-id - String - 是否必填：否 - （过滤条件）按照带宽包资源Id过滤。资源Id形如'eip-xxxx','lb-xxxx'
  • resource.address-ip - String - 是否必填：否 - （过滤条件）按照带宽包资源Ip过滤。
    • @@ -11549,7 +11549,8 @@ export interface BandwidthPackage { */ NetworkType?: string /** - * 带宽包计费类型，包括'TOP5_POSTPAID_BY_MONTH'和'PERCENT95_POSTPAID_BY_MONTH' + * 带宽包计费类型，包括:
  • 'TOP5_POSTPAID_BY_MONTH':按月后付费TOP5计费
  • 'PERCENT95_POSTPAID_BY_MONTH':按月后付费月95计费
  • 'ENHANCED95_POSTPAID_BY_MONTH':按月后付费增强型95计费
  • 'FIXED_PREPAID_BY_MONTH':包月预付费计费
  • ‘PEAK_BANDWIDTH_POSTPAID_BY_DAY’: 后付费日结按带宽计费
    • + */ ChargeType?: string /** @@ -11577,6 +11578,11 @@ export interface BandwidthPackage { 注意：此字段可能返回 null，表示取不到有效值。 */ Egress?: string + /** + * 带宽包到期时间，只有预付费会返回，按量计费返回为null +注意：此字段可能返回 null，表示取不到有效值。 + */ + Deadline?: string } /** diff --git a/tencentcloud/common/sdk_version.d.ts b/tencentcloud/common/sdk_version.d.ts index 49f829de0..e548d960f 100644 --- a/tencentcloud/common/sdk_version.d.ts +++ b/tencentcloud/common/sdk_version.d.ts @@ -1 +1 @@ -export declare const sdkVersion = "4.0.719"; +export declare const sdkVersion = "4.0.720"; diff --git a/tencentcloud/common/sdk_version.js b/tencentcloud/common/sdk_version.js index ea5bfe48e..928ec5c1f 100644 --- a/tencentcloud/common/sdk_version.js +++ b/tencentcloud/common/sdk_version.js @@ -1,4 +1,4 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.sdkVersion = void 0; -exports.sdkVersion = "4.0.719"; +exports.sdkVersion = "4.0.720"; diff --git a/tencentcloud/services/btoe/index.d.ts b/tencentcloud/services/btoe/index.d.ts index c506e5a5b..399e5ad14 100644 --- a/tencentcloud/services/btoe/index.d.ts +++ b/tencentcloud/services/btoe/index.d.ts @@ -1,10 +1,10 @@ export declare const btoe: { - v20210514: { - Client: typeof import("./v20210514/btoe_client").Client; - Models: typeof import("./v20210514/btoe_models"); - }; v20210303: { Client: typeof import("./v20210303/btoe_client").Client; Models: typeof import("./v20210303/btoe_models"); }; + v20210514: { + Client: typeof import("./v20210514/btoe_client").Client; + Models: typeof import("./v20210514/btoe_models"); + }; }; diff --git a/tencentcloud/services/btoe/index.js b/tencentcloud/services/btoe/index.js index 5ba67e562..6fd8fa5cf 100644 --- a/tencentcloud/services/btoe/index.js +++ b/tencentcloud/services/btoe/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.btoe = void 0; -const v20210514_1 = require("./v20210514"); const v20210303_1 = require("./v20210303"); +const v20210514_1 = require("./v20210514"); exports.btoe = { - v20210514: v20210514_1.v20210514, v20210303: v20210303_1.v20210303, + v20210514: v20210514_1.v20210514, }; diff --git a/tencentcloud/services/dbbrain/index.d.ts b/tencentcloud/services/dbbrain/index.d.ts index 34ec4e4c0..7612f9bb2 100644 --- a/tencentcloud/services/dbbrain/index.d.ts +++ b/tencentcloud/services/dbbrain/index.d.ts @@ -1,10 +1,10 @@ export declare const dbbrain: { - v20210527: { - Client: typeof import("./v20210527/dbbrain_client").Client; - Models: typeof import("./v20210527/dbbrain_models"); - }; v20191016: { Client: typeof import("./v20191016/dbbrain_client").Client; Models: typeof import("./v20191016/dbbrain_models"); }; + v20210527: { + Client: typeof import("./v20210527/dbbrain_client").Client; + Models: typeof import("./v20210527/dbbrain_models"); + }; }; diff --git a/tencentcloud/services/dbbrain/index.js b/tencentcloud/services/dbbrain/index.js index d3900f82e..09c64b390 100644 --- a/tencentcloud/services/dbbrain/index.js +++ b/tencentcloud/services/dbbrain/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.dbbrain = void 0; -const v20210527_1 = require("./v20210527"); const v20191016_1 = require("./v20191016"); +const v20210527_1 = require("./v20210527"); exports.dbbrain = { - v20210527: v20210527_1.v20210527, v20191016: v20191016_1.v20191016, + v20210527: v20210527_1.v20210527, }; diff --git a/tencentcloud/services/drm/v20181115/drm_client.d.ts b/tencentcloud/services/drm/v20181115/drm_client.d.ts index 51ccf1898..8a105d472 100644 --- a/tencentcloud/services/drm/v20181115/drm_client.d.ts +++ b/tencentcloud/services/drm/v20181115/drm_client.d.ts @@ -1,6 +1,6 @@ import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; -import { CreateLicenseResponse, CreateEncryptKeysResponse, CreateLicenseRequest, DescribeAllKeysRequest, CreateEncryptKeysRequest, ModifyFairPlayPemResponse, DescribeFairPlayPemResponse, AddFairPlayPemResponse, AddFairPlayPemRequest, DeleteFairPlayPemRequest, DescribeKeysResponse, DescribeAllKeysResponse, StartEncryptionRequest, ModifyFairPlayPemRequest, DeleteFairPlayPemResponse, StartEncryptionResponse, DescribeFairPlayPemRequest, DescribeKeysRequest } from "./drm_models"; +import { CreateLicenseResponse, CreateEncryptKeysResponse, CreateLicenseRequest, DescribeAllKeysRequest, CreateEncryptKeysRequest, ModifyFairPlayPemResponse, DescribeFairPlayPemResponse, DescribeDRMLicenseResponse, AddFairPlayPemResponse, AddFairPlayPemRequest, DeleteFairPlayPemRequest, DescribeKeysResponse, DescribeDRMLicenseRequest, DescribeAllKeysResponse, StartEncryptionRequest, ModifyFairPlayPemRequest, DeleteFairPlayPemResponse, StartEncryptionResponse, DescribeFairPlayPemRequest, DescribeKeysRequest } from "./drm_models"; /** * drm client * @class @@ -37,6 +37,11 @@ export declare class Client extends AbstractClient { */ DescribeKeys(req: DescribeKeysRequest, cb?: (error: string, rep: DescribeKeysResponse) => void): Promise; + /** + * 开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo + + */ + DescribeDRMLicense(req: DescribeDRMLicenseRequest, cb?: (error: string, rep: DescribeDRMLicenseResponse) => void): Promise; /** * 本接口用来查询指定DRM类型、ContentType的所有加密密钥 diff --git a/tencentcloud/services/drm/v20181115/drm_client.js b/tencentcloud/services/drm/v20181115/drm_client.js index 510f0f00c..c00285661 100644 --- a/tencentcloud/services/drm/v20181115/drm_client.js +++ b/tencentcloud/services/drm/v20181115/drm_client.js @@ -69,6 +69,13 @@ class Client extends abstract_client_1.AbstractClient { async DescribeKeys(req, cb) { return this.request("DescribeKeys", req, cb); } + /** + * 开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo + + */ + async DescribeDRMLicense(req, cb) { + return this.request("DescribeDRMLicense", req, cb); + } /** * 本接口用来查询指定DRM类型、ContentType的所有加密密钥 diff --git a/tencentcloud/services/drm/v20181115/drm_models.d.ts b/tencentcloud/services/drm/v20181115/drm_models.d.ts index d2a98ed6f..cdeeb0e0b 100644 --- a/tencentcloud/services/drm/v20181115/drm_models.d.ts +++ b/tencentcloud/services/drm/v20181115/drm_models.d.ts @@ -217,6 +217,23 @@ export interface Key { */ InsertTimestamp: number; } +/** + * DescribeDRMLicense返回参数结构体 + */ +export interface DescribeDRMLicenseResponse { + /** + * 内容ID。 + */ + ContentId: string; + /** + * 加密密钥。 + */ + TXEncryptionToken: string; + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string; +} /** * 播放控制参数 */ @@ -321,6 +338,27 @@ export interface DescribeKeysResponse { */ RequestId?: string; } +/** + * DescribeDRMLicense请求参数结构体 + */ +export interface DescribeDRMLicenseRequest { + /** + * 使用的DRM方案类型，接口取值 NORMALAES 。 + */ + DrmType: string; + /** + * 加密的track列表，接口取值 SD 。 + */ + Tracks: Array; + /** + * 一个加密内容的唯一标识。 + */ + ContentId: string; + /** + * 内容类型。接口取值 LiveVideo 。 + */ + ContentType: string; +} /** * DescribeAllKeys返回参数结构体 */ diff --git a/tencentcloud/services/dts/index.d.ts b/tencentcloud/services/dts/index.d.ts index f73b41bab..45f3d4d29 100644 --- a/tencentcloud/services/dts/index.d.ts +++ b/tencentcloud/services/dts/index.d.ts @@ -1,10 +1,10 @@ export declare const dts: { - v20180330: { - Client: typeof import("./v20180330/dts_client").Client; - Models: typeof import("./v20180330/dts_models"); - }; v20211206: { Client: typeof import("./v20211206/dts_client").Client; Models: typeof import("./v20211206/dts_models"); }; + v20180330: { + Client: typeof import("./v20180330/dts_client").Client; + Models: typeof import("./v20180330/dts_models"); + }; }; diff --git a/tencentcloud/services/dts/index.js b/tencentcloud/services/dts/index.js index 805784c20..57bc8d52b 100644 --- a/tencentcloud/services/dts/index.js +++ b/tencentcloud/services/dts/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.dts = void 0; -const v20180330_1 = require("./v20180330"); const v20211206_1 = require("./v20211206"); +const v20180330_1 = require("./v20180330"); exports.dts = { - v20180330: v20180330_1.v20180330, v20211206: v20211206_1.v20211206, + v20180330: v20180330_1.v20180330, }; diff --git a/tencentcloud/services/ess/v20201111/ess_client.d.ts b/tencentcloud/services/ess/v20201111/ess_client.d.ts index 9a6e09abc..0e3988937 100644 --- a/tencentcloud/services/ess/v20201111/ess_client.d.ts +++ b/tencentcloud/services/ess/v20201111/ess_client.d.ts @@ -1,6 +1,6 @@ import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; -import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models"; +import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models"; /** * ess client * @class @@ -8,16 +8,16 @@ import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegration export declare class Client extends AbstractClient { constructor(clientConfig: ClientConfig); /** - * 获取设置自动签印章小程序链接。 - -注意： -
    • 需要企业开通自动签后使用。
      • -
    • 仅支持已经开通了自动签的个人更换自动签印章。
      • -
    • 链接有效期默认7天，最多30天。
      • -
    • 该接口的链接适用于小程序端。
      • -
    • 该接口不会扣除您的合同套餐，暂不参与计费。
    + * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署
    +`注意：`
    +`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。`
    +`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。`
    +`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。`
    +`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。`
    +`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`
    +跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置 */ - CreateUserAutoSignSealUrl(req: CreateUserAutoSignSealUrlRequest, cb?: (error: string, rep: CreateUserAutoSignSealUrlResponse) => void): Promise; + CreateBatchQuickSignUrl(req: CreateBatchQuickSignUrlRequest, cb?: (error: string, rep: CreateBatchQuickSignUrlResponse) => void): Promise; /** * 此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。 @@ -71,6 +71,17 @@ export declare class Client extends AbstractClient { 适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。 */ DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise; + /** + * 获取设置自动签印章小程序链接。 + +注意： +
    • 需要企业开通自动签后使用。
      • +
    • 仅支持已经开通了自动签的个人更换自动签印章。
      • +
    • 链接有效期默认7天，最多30天。
      • +
    • 该接口的链接适用于小程序端。
      • +
    • 该接口不会扣除您的合同套餐，暂不参与计费。
    + */ + CreateUserAutoSignSealUrl(req: CreateUserAutoSignSealUrlRequest, cb?: (error: string, rep: CreateUserAutoSignSealUrlResponse) => void): Promise; /** * 获取个人用户自动签的开通链接。 diff --git a/tencentcloud/services/ess/v20201111/ess_client.js b/tencentcloud/services/ess/v20201111/ess_client.js index 5f454bc01..62703b0a7 100644 --- a/tencentcloud/services/ess/v20201111/ess_client.js +++ b/tencentcloud/services/ess/v20201111/ess_client.js @@ -28,17 +28,17 @@ class Client extends abstract_client_1.AbstractClient { super("ess.tencentcloudapi.com", "2020-11-11", clientConfig); } /** - * 获取设置自动签印章小程序链接。 - -注意： -
    • 需要企业开通自动签后使用。
      • -
    • 仅支持已经开通了自动签的个人更换自动签印章。
      • -
    • 链接有效期默认7天，最多30天。
      • -
    • 该接口的链接适用于小程序端。
      • -
    • 该接口不会扣除您的合同套餐，暂不参与计费。
    + * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署
    +`注意：`
    +`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。`
    +`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。`
    +`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。`
    +`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。`
    +`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`
    +跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置 */ - async CreateUserAutoSignSealUrl(req, cb) { - return this.request("CreateUserAutoSignSealUrl", req, cb); + async CreateBatchQuickSignUrl(req, cb) { + return this.request("CreateBatchQuickSignUrl", req, cb); } /** * 此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。 @@ -107,6 +107,19 @@ class Client extends abstract_client_1.AbstractClient { async DescribeFileUrls(req, cb) { return this.request("DescribeFileUrls", req, cb); } + /** + * 获取设置自动签印章小程序链接。 + +注意： +
    • 需要企业开通自动签后使用。
      • +
    • 仅支持已经开通了自动签的个人更换自动签印章。
      • +
    • 链接有效期默认7天，最多30天。
      • +
    • 该接口的链接适用于小程序端。
      • +
    • 该接口不会扣除您的合同套餐，暂不参与计费。
    + */ + async CreateUserAutoSignSealUrl(req, cb) { + return this.request("CreateUserAutoSignSealUrl", req, cb); + } /** * 获取个人用户自动签的开通链接。 diff --git a/tencentcloud/services/ess/v20201111/ess_models.d.ts b/tencentcloud/services/ess/v20201111/ess_models.d.ts index af8e5a04f..72f78cc73 100644 --- a/tencentcloud/services/ess/v20201111/ess_models.d.ts +++ b/tencentcloud/services/ess/v20201111/ess_models.d.ts @@ -783,6 +783,19 @@ export interface StaffRole { */ RoleName?: string; } +/** + * CreateBatchQuickSignUrl返回参数结构体 + */ +export interface CreateBatchQuickSignUrlResponse { + /** + * 签署人签署链接信息 + */ + FlowApproverUrlInfo?: FlowApproverUrlInfo; + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string; +} /** * CreateIntegrationRole请求参数结构体 */ @@ -3334,7 +3347,7 @@ export interface FlowCreateApprover { 注:
    • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
      • -
    • 此字段不可传多个校验方式
    +
  • 此字段可传多个校验方式
    • `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主` @@ -4531,7 +4544,9 @@ export interface ApproverInfo { */ ApproverRole?: number; /** - * 自定义签署人角色名：收款人、开具人、见证人 + * 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 + + 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的` */ ApproverRoleName?: string; /** @@ -4578,7 +4593,7 @@ export interface ApproverInfo { 注:
    • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
      • -
    • 此字段不可传多个校验方式
    +
  • 此字段可传多个校验方式
    • */ ApproverVerifyTypes?: Array; /** @@ -6563,6 +6578,56 @@ export interface FilledComponent { */ ImageUrl?: string; } +/** + * CreateBatchQuickSignUrl请求参数结构体 + */ +export interface CreateBatchQuickSignUrlRequest { + /** + * 批量签署的合同流程ID数组。 + 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。` + */ + FlowIds: Array; + /** + * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 + 注: + `1. ApproverType目前只支持个人类型的签署人。` + `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。` + `3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。` + */ + FlowApproverInfo: FlowCreateApprover; + /** + * 代理企业和员工的信息。 + 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId(子企业的组织ID)为必填项。 + */ + Agent?: Agent; + /** + * 执行本接口操作的员工信息。 + 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。` + */ + Operator?: UserInfo; + /** + * 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议) + */ + JumpUrl?: string; + /** + * 指定批量签署合同的签名类型，可传递以下值： +
    • **0**：手写签名(默认)
      • +
    • **1**：OCR楷体
    + 注： +
    • 默认情况下，签名类型为手写签名
      • +
    • 您可以传递多种值，表示可用多种签名类型。
    + */ + SignatureTypes?: Array; + /** + * 指定批量签署合同的认证校验方式，可传递以下值： +
    • **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
      • +
    • **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
    + 注： +
    • 默认情况下，认证校验方式为人脸认证
      • +
    • 您可以传递多种值，表示可用多种认证校验方式。
    + */ + ApproverSignTypes?: Array; +} /** * 下载文件的URL信息 */ diff --git a/tencentcloud/services/essbasic/index.d.ts b/tencentcloud/services/essbasic/index.d.ts index eae3a0569..40745d787 100644 --- a/tencentcloud/services/essbasic/index.d.ts +++ b/tencentcloud/services/essbasic/index.d.ts @@ -1,10 +1,10 @@ export declare const essbasic: { - v20210526: { - Client: typeof import("./v20210526/essbasic_client").Client; - Models: typeof import("./v20210526/essbasic_models"); - }; v20201222: { Client: typeof import("./v20201222/essbasic_client").Client; Models: typeof import("./v20201222/essbasic_models"); }; + v20210526: { + Client: typeof import("./v20210526/essbasic_client").Client; + Models: typeof import("./v20210526/essbasic_models"); + }; }; diff --git a/tencentcloud/services/essbasic/index.js b/tencentcloud/services/essbasic/index.js index 85aa81494..0dd9f0cfb 100644 --- a/tencentcloud/services/essbasic/index.js +++ b/tencentcloud/services/essbasic/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.essbasic = void 0; -const v20210526_1 = require("./v20210526"); const v20201222_1 = require("./v20201222"); +const v20210526_1 = require("./v20210526"); exports.essbasic = { - v20210526: v20210526_1.v20210526, v20201222: v20201222_1.v20201222, + v20210526: v20210526_1.v20210526, }; diff --git a/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts b/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts index f79faaf0b..a6a5aa52c 100644 --- a/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +++ b/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts @@ -1,6 +1,6 @@ import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; -import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateFlowApproversRequest, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models"; +import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateFlowApproversRequest, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models"; /** * essbasic client * @class @@ -19,6 +19,36 @@ export declare class Client extends AbstractClient { 发起审核：通过接口ChannelCreatePrepareFlow指定发起后需要审核，则可以通过调用此接口，指定operate=CreateReview，提交企业内部审批结果，可多次提交，当通过后，后续提交结果无效 */ ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise; + /** + * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。 + +跳转小程序的几种方式：主要是设置不同的EndPoint +1. 通过链接Url直接跳转到小程序，不需要返回 +设置EndPoint为WEIXINAPP，得到链接打开即可。 + +2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App +跳转到小程序的实现，参考官方文档 +https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html +其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 +设置EndPoint为APP，得到path。 + +4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 +跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） +全屏方式： +（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） +半屏方式： +（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） +其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 +设置EndPoint为APP，得到path。 + +其中小程序的原始Id如下，或者查看小程序信息自助获取。 + +| 小程序 | AppID | 原始ID | +| ------------ | ------------ | ------------ | +| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | +| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | + */ + ModifyExtendedService(req: ModifyExtendedServiceRequest, cb?: (error: string, rep: ModifyExtendedServiceResponse) => void): Promise; /** * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。 @@ -134,37 +164,19 @@ export declare class Client extends AbstractClient { */ DescribeExtendedServiceAuthInfo(req: DescribeExtendedServiceAuthInfoRequest, cb?: (error: string, rep: DescribeExtendedServiceAuthInfoResponse) => void): Promise; /** - * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。 - -跳转小程序的几种方式：主要是设置不同的EndPoint -1. 通过链接Url直接跳转到小程序，不需要返回 -设置EndPoint为WEIXINAPP，得到链接打开即可。 - -2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App -跳转到小程序的实现，参考官方文档 -https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html -其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 -设置EndPoint为APP，得到path。 - -4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 -跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） -全屏方式： -（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） -半屏方式： -（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） -其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 -设置EndPoint为APP，得到path。 - -其中小程序的原始Id如下，或者查看小程序信息自助获取。 - -| 小程序 | AppID | 原始ID | -| ------------ | ------------ | ------------ | -| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | -| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | + * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 +相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355 */ - ModifyExtendedService(req: ModifyExtendedServiceRequest, cb?: (error: string, rep: ModifyExtendedServiceResponse) => void): Promise; + ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise; /** - * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。 + * 此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。
    +前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。
    +适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 +适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同
    +转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。
    +注: +1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt` +2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果` */ ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise; /** @@ -197,13 +209,16 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp */ ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise; /** - * 此接口（ChannelCreateRole）用来创建企业自定义角色。 - -适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 - -适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 + * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署
    +`注意：`
    +`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。`
    +`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。`
    +`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。`
    +`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。`
    +`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`
    +跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置 */ - ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise; + ChannelCreateBatchQuickSignUrl(req: ChannelCreateBatchQuickSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchQuickSignUrlResponse) => void): Promise; /** * 接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。 如若在模板中配置了动态表格, 上传的附件必须为A4大小 @@ -292,6 +307,11 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos + +注意： + +>1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。 +>2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准 */ DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise; /** @@ -382,8 +402,12 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 */ ChannelDeleteRole(req: ChannelDeleteRoleRequest, cb?: (error: string, rep: ChannelDeleteRoleResponse) => void): Promise; /** - * 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。 -注意：大文件转换所需的时间可能会比较长。 + * 此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作
    +前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。
    + +适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。
    +注： +1. `大文件转换所需的时间可能会比较长` */ ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise; /** @@ -443,14 +467,12 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 */ ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise; /** - * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： - -1. 合同中当前状态为“待签署”的签署人是催办的对象 -2. 每个合同只能催办一次 - -注意：该接口无法直接调用，请联系客户经理申请使用。 + * 该接口用于发起合同后，生成C端签署人的签署链接
    +注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    +注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    +注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    */ - ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise; + ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise; /** * 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。 合同发起人必须在电子签已经进行实名。 @@ -482,7 +504,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 /** * 该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。 -目前该接口只支持B2C，不建议使用，将会废弃。 +目前该接口只支持B2C，不建议使用，将会**废弃**。 */ PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise; /** @@ -506,10 +528,13 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 */ ChannelCreateFlowApprovers(req: ChannelCreateFlowApproversRequest, cb?: (error: string, rep: ChannelCreateFlowApproversResponse) => void): Promise; /** - * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 -相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355 + * 此接口（ChannelCreateRole）用来创建企业自定义角色。 + +适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 + +适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 */ - ChannelDescribeRoles(req: ChannelDescribeRolesRequest, cb?: (error: string, rep: ChannelDescribeRolesResponse) => void): Promise; + ChannelCreateRole(req: ChannelCreateRoleRequest, cb?: (error: string, rep: ChannelCreateRoleResponse) => void): Promise; /** * 获取合同流程PDF的下载链接，可以下载签署中、签署完的此子企业创建的合同 @@ -550,12 +575,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn"); */ UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise; /** - * 该接口用于发起合同后，生成C端签署人的签署链接
    -注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    -注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    -注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    + * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： + +1. 合同中当前状态为“待签署”的签署人是催办的对象 +2. 每个合同只能催办一次 + +注意：该接口无法直接调用，请联系客户经理申请使用。 */ - ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise; + ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise; /** * 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称，企业营业执照，企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意： 1. 需要在子客企业激活前调用该接口，如果您的企业已经提交企业信息或者企业已经激活，同步的企业信息将不会生效。 diff --git a/tencentcloud/services/essbasic/v20210526/essbasic_client.js b/tencentcloud/services/essbasic/v20210526/essbasic_client.js index 7ccebf2a6..4f918bfe7 100644 --- a/tencentcloud/services/essbasic/v20210526/essbasic_client.js +++ b/tencentcloud/services/essbasic/v20210526/essbasic_client.js @@ -43,6 +43,38 @@ class Client extends abstract_client_1.AbstractClient { async ChannelCreateFlowSignReview(req, cb) { return this.request("ChannelCreateFlowSignReview", req, cb); } + /** + * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。 + +跳转小程序的几种方式：主要是设置不同的EndPoint +1. 通过链接Url直接跳转到小程序，不需要返回 +设置EndPoint为WEIXINAPP，得到链接打开即可。 + +2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App +跳转到小程序的实现，参考官方文档 +https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html +其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 +设置EndPoint为APP，得到path。 + +4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 +跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） +全屏方式： +（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） +半屏方式： +（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） +其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 +设置EndPoint为APP，得到path。 + +其中小程序的原始Id如下，或者查看小程序信息自助获取。 + +| 小程序 | AppID | 原始ID | +| ------------ | ------------ | ------------ | +| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | +| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | + */ + async ModifyExtendedService(req, cb) { + return this.request("ModifyExtendedService", req, cb); + } /** * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。 @@ -170,39 +202,21 @@ class Client extends abstract_client_1.AbstractClient { return this.request("DescribeExtendedServiceAuthInfo", req, cb); } /** - * 修改（操作）企业扩展服务 ，企业经办人需要是企业超管或者法人。 - -跳转小程序的几种方式：主要是设置不同的EndPoint -1. 通过链接Url直接跳转到小程序，不需要返回 -设置EndPoint为WEIXINAPP，得到链接打开即可。 - -2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App -跳转到小程序的实现，参考官方文档 -https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html -其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 -设置EndPoint为APP，得到path。 - -4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 -跳转到小程序的实现，参考官方文档（分为全屏、半屏两种方式） -全屏方式： -（https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html） -半屏方式： -（https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html） -其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。 -设置EndPoint为APP，得到path。 - -其中小程序的原始Id如下，或者查看小程序信息自助获取。 - -| 小程序 | AppID | 原始ID | -| ------------ | ------------ | ------------ | -| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 | -| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa | + * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 +相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355 */ - async ModifyExtendedService(req, cb) { - return this.request("ModifyExtendedService", req, cb); + async ChannelDescribeRoles(req, cb) { + return this.request("ChannelDescribeRoles", req, cb); } /** - * 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。 + * 此接口（ChannelCreateConvertTaskApi）用来将word、excel、html、图片、txt类型文件转换为PDF文件。
    +前提条件：源文件已经通过 文件上传接口完成上传，并得到了源文件的资源Id。
    +适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同 +适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同
    +转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过查询转换任务状态接口获取任务状态。
    +注: +1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt` +2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果` */ async ChannelCreateConvertTaskApi(req, cb) { return this.request("ChannelCreateConvertTaskApi", req, cb); @@ -245,14 +259,17 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp return this.request("ChannelCreateSealPolicy", req, cb); } /** - * 此接口（ChannelCreateRole）用来创建企业自定义角色。 - -适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 - -适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 + * 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署
    +`注意：`
    +`1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。`
    +`2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。`
    +`3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。`
    +`4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。`
    +`5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`
    +跳转到小程序的实现，参考微信官方文档(分为全屏、半屏两种方式)，如何配置也可以请参考: 跳转电子签小程序配置 */ - async ChannelCreateRole(req, cb) { - return this.request("ChannelCreateRole", req, cb); + async ChannelCreateBatchQuickSignUrl(req, cb) { + return this.request("ChannelCreateBatchQuickSignUrl", req, cb); } /** * 接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。 @@ -350,6 +367,11 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfos + +注意： + +>1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。 +>2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准 */ async DescribeTemplates(req, cb) { return this.request("DescribeTemplates", req, cb); @@ -454,8 +476,12 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 return this.request("ChannelDeleteRole", req, cb); } /** - * 查询转换任务的状态。转换任务Id通过发起转换任务接口（ChannelCreateConvertTaskApi）获取。 -注意：大文件转换所需的时间可能会比较长。 + * 此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作
    +前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。
    + +适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。
    +注： +1. `大文件转换所需的时间可能会比较长` */ async ChannelGetTaskResultApi(req, cb) { return this.request("ChannelGetTaskResultApi", req, cb); @@ -533,15 +559,13 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 return this.request("ChannelCreateWebThemeConfig", req, cb); } /** - * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： - -1. 合同中当前状态为“待签署”的签署人是催办的对象 -2. 每个合同只能催办一次 - -注意：该接口无法直接调用，请联系客户经理申请使用。 + * 该接口用于发起合同后，生成C端签署人的签署链接
    +注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    +注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    +注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    */ - async ChannelCreateFlowReminds(req, cb) { - return this.request("ChannelCreateFlowReminds", req, cb); + async ChannelCreateFlowSignUrl(req, cb) { + return this.request("ChannelCreateFlowSignUrl", req, cb); } /** * 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。 @@ -580,7 +604,7 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 /** * 该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。 -目前该接口只支持B2C，不建议使用，将会废弃。 +目前该接口只支持B2C，不建议使用，将会**废弃**。 */ async PrepareFlows(req, cb) { return this.request("PrepareFlows", req, cb); @@ -610,11 +634,14 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表 return this.request("ChannelCreateFlowApprovers", req, cb); } /** - * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。 -相关系统默认角色说明可参考文档：https://cloud.tencent.com/document/product/1323/61355 + * 此接口（ChannelCreateRole）用来创建企业自定义角色。 + +适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 + +适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。 */ - async ChannelDescribeRoles(req, cb) { - return this.request("ChannelDescribeRoles", req, cb); + async ChannelCreateRole(req, cb) { + return this.request("ChannelCreateRole", req, cb); } /** * 获取合同流程PDF的下载链接，可以下载签署中、签署完的此子企业创建的合同 @@ -664,13 +691,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn"); return this.request("UploadFiles", req, cb); } /** - * 该接口用于发起合同后，生成C端签署人的签署链接
    -注意：该接口目前签署人类型仅支持个人签署方（PERSON）
    -注意：该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
    -注意：该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
    + * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办： + +1. 合同中当前状态为“待签署”的签署人是催办的对象 +2. 每个合同只能催办一次 + +注意：该接口无法直接调用，请联系客户经理申请使用。 */ - async ChannelCreateFlowSignUrl(req, cb) { - return this.request("ChannelCreateFlowSignUrl", req, cb); + async ChannelCreateFlowReminds(req, cb) { + return this.request("ChannelCreateFlowReminds", req, cb); } /** * 此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称，企业营业执照，企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意： diff --git a/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts b/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts index b290c6c3e..5a3505a59 100644 --- a/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +++ b/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts @@ -12,7 +12,7 @@ export interface SyncProxyOrganizationResponse { */ export interface ChannelCreateConvertTaskApiResponse { /** - * 任务id + * 接口返回的文件转换任务Id，可以调用接口查询转换任务状态获取转换任务的状态和转换后的文件资源Id。 */ TaskId?: string; /** @@ -1221,19 +1221,41 @@ export interface ChannelCreateWebThemeConfigRequest { */ export interface ChannelCreateConvertTaskApiRequest { /** - * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。 + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + + 此接口下面信息必填。 +
      +
    • 渠道应用标识: Agent.AppId
      • +
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
      • +
    • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
      • +
    + 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** - * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型 + * 需要进行转换的资源文件类型 + 支持的文件类型如下： +
    • doc
      • +
    • docx
      • +
    • xls
      • +
    • xlsx
      • +
    • jpg
      • +
    • jpeg
      • +
    • png
      • +
    • bmp
      • +
    • txt
    */ ResourceType: string; /** - * 资源名称，长度限制为256字符 + * 需要进行转换操作的文件资源名称，带资源后缀名。 + + 注: `资源名称长度限制为256个字符` */ ResourceName: string; /** - * 文件Id，通过UploadFiles获取 + * 需要进行转换操作的文件资源Id，通过UploadFiles接口获取文件资源Id。 + + 注: `目前，此接口仅支持单个文件进行转换。` */ ResourceId: string; /** @@ -1387,6 +1409,30 @@ export interface ChannelCreateFlowByFilesRequest { */ Operator?: UserInfo; } +/** + * UploadFiles返回参数结构体 + */ +export interface UploadFilesResponse { + /** + * 上传成功文件数量 + 注: `如果一个文件上传失败, 则全部文件皆上传失败` + */ + TotalCount?: number; + /** + * 文件资源ID数组，每个文件资源ID为32位字符串。 + 建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。 + 注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用` + */ + FileIds?: Array; + /** + * 对应上传文件的下载链接，过期时间5分钟 + */ + FileUrls?: Array; + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string; +} /** * 应用相关信息 */ @@ -1907,15 +1953,15 @@ export interface Recipient { */ export interface DescribeTemplatesResponse { /** - * 模板列表 + * 模板详情列表数据 */ Templates?: Array; /** - * 查询到的总数 + * 查询到的模板总数 */ TotalCount?: number; /** - * 每页多少条数据 + * 每页返回的数据条数 */ Limit?: number; /** @@ -3154,15 +3200,19 @@ export interface FormField { */ export interface FlowInfo { /** - * 合同名字，最大长度200个字符 + * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 */ FlowName: string; /** - * 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年 + * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 + 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 + 示例值：1604912664 */ Deadline: number; /** - * 模板ID + * 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。 + + 可以通过生成子客登录链接登录企业控制台, 在**企业模板**中得到合同模板ID。 */ TemplateId?: string; /** @@ -3174,42 +3224,70 @@ export interface FlowInfo { */ FormFields?: Array; /** - * 回调地址，最大长度1000个字符 + * 合同状态变动结的通知回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性，最大长度1000个字符。 + + 腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。 + 回调的相关说明可参考开发者中心的回调通知模块 */ CallbackUrl?: string; /** - * 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符 + * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 */ FlowType?: string; /** - * 合同描述，最大长度1000个字符 + * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。 */ FlowDescription?: string; /** - * 第三方应用平台的业务信息，最大长度1000个字符。 + * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为1000长度。 + + 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。 */ CustomerData?: string; /** - * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 + * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： +
    • {合同名称}
      • +
    • {发起方企业}
      • +
    • {发起方姓名}
      • +
    • {签署方N企业}
      • +
    • {签署方N姓名}
    + 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 + + 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子 + + 合同名称：租房合同 + 发起方：腾讯公司(张三) + 签署方：李四 + + */ CustomShowMap?: string; /** - * 被抄送人的信息列表，抄送功能暂不开放 + * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 + + 注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。` */ CcInfos?: Array; /** - * 发起方企业的签署人进行签署操作是否需要企业内部审批。 - 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 - - 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。 + * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： +
    • **false**：（默认）不需要审批，直接签署。
      • +
    • **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。
    + 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 +
    • 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。
      • +
    • 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。
    + 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同` */ NeedSignReview?: boolean; /** - * 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知 + * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型： +
    • **0** :合同发起时通知通知对方来查看合同（默认）
      • +
    • **1** : 签署完成后通知对方来查看合同
    */ CcNotifyType?: number; /** - * 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN + * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： +
    • **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）
    + 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。` */ AutoSignScene?: string; } @@ -3336,6 +3414,50 @@ export interface ResourceUrlInfo { */ Type?: string; } +/** + * ChannelCreateBatchQuickSignUrl请求参数结构体 + */ +export interface ChannelCreateBatchQuickSignUrlRequest { + /** + * 批量签署的合同流程ID数组。 + 注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。` + */ + FlowIds: Array; + /** + * 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。 + 注: + `1. ApproverType目前只支持个人类型的签署人。` + `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。` + `3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。` + */ + FlowApproverInfo: FlowApproverInfo; + /** + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + */ + Agent?: Agent; + /** + * 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议) + */ + JumpUrl?: string; + /** + * 指定批量签署合同的签名类型，可传递以下值： +
    • **0**：手写签名(默认)
      • +
    • **1**：OCR楷体
    + 注： +
    • 默认情况下，签名类型为手写签名
      • +
    • 您可以传递多种值，表示可用多种签名类型。
    + */ + SignatureTypes?: Array; + /** + * 指定批量签署合同的认证校验方式，可传递以下值： +
    • **1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同
      • +
    • **3**：运营商三要素，需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
    + 注： +
    • 默认情况下，认证校验方式为人脸认证
      • +
    • 您可以传递多种值，表示可用多种认证校验方式。
    + */ + ApproverSignTypes?: Array; +} /** * ChannelCreateBoundFlows请求参数结构体 */ @@ -3815,9 +3937,13 @@ export interface FlowApproverInfo { */ ApproverNeedSignReview?: boolean; /** - * 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 - 查看合同的认证方式 Flow层级的优先于approver层级的 - （当手写签名方式为OCR_ESIGN时，合同认证方式2无效，因为这种签名方式依赖实名认证） + * 指定个人签署方查看合同的校验方式,可以传值如下: +
    • **1** : （默认）人脸识别,人脸识别后才能合同内容
      • +
    • **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） +
    + 注: +
    • 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
      • +
    • 此字段可传多个校验方式
    */ ApproverVerifyTypes?: Array; /** @@ -3852,7 +3978,9 @@ export interface FlowApproverInfo { */ AddSignComponentsLimits?: Array; /** - * 自定义签署人角色名，如收款人、开具人、见证人等 + * 可以自定义签署人角色名：收款人、开具人、见证人等，长度不能超过20，只能由中文、字母、数字和下划线组成。 + + 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的` */ ApproverRoleName?: string; } @@ -3894,11 +4022,19 @@ export interface ChannelCreateUserAutoSignEnableUrlResponse { */ export interface ChannelGetTaskResultApiRequest { /** - * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。 + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + + 此接口下面信息必填。 +
      +
    • 渠道应用标识: Agent.AppId
      • +
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
      • +
    • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
      • +
    + 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** - * 任务Id，通过ChannelCreateConvertTaskApi接口获得 + * 转换任务Id，通过接口创建文件转换任务接口得到的转换任务id */ TaskId: string; /** @@ -4329,24 +4465,13 @@ export interface ChannelDeleteRoleRequest { RoleIds: Array; } /** - * UploadFiles返回参数结构体 + * ChannelCreateBatchQuickSignUrl返回参数结构体 */ -export interface UploadFilesResponse { - /** - * 上传成功文件数量 - 注: `如果一个文件上传失败, 则全部文件皆上传失败` - */ - TotalCount?: number; - /** - * 文件资源ID数组，每个文件资源ID为32位字符串。 - 建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。 - 注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用` - */ - FileIds?: Array; +export interface ChannelCreateBatchQuickSignUrlResponse { /** - * 对应上传文件的下载链接，过期时间5分钟 + * 签署人签署链接信息 */ - FileUrls?: Array; + FlowApproverUrlInfo?: FlowApproverUrlInfo; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ @@ -4639,6 +4764,10 @@ export interface ChannelCreateMultiFlowSignQRCodeResponse { * 签署人个性化能力信息 */ export interface ApproverOption { + /** + * 是否可以拒签 默认false-可以拒签 true-不可以拒签 + */ + NoRefuse?: boolean; /** * 是否隐藏一键签署 默认false-不隐藏true-隐藏 */ @@ -4750,26 +4879,26 @@ export interface ChannelGetTaskResultApiResponse { TaskId?: string; /** * 任务状态，需要关注的状态 - 0 :NeedTranform - 任务已提交 - 4 :Processing - 文档转换中 - 8 :TaskEnd - 任务处理完成 - -2 :DownloadFailed - 下载失败 - -6 :ProcessFailed - 转换失败 - -13:ProcessTimeout - 转换文件超时 +
    • **0** :NeedTranform - 任务已提交
      • +
    • **4** :Processing - 文档转换中
      • +
    • **8** :TaskEnd - 任务处理完成
      • +
    • **-2** :DownloadFailed - 下载失败
      • +
    • **-6** :ProcessFailed - 转换失败
      • +
    • **-13**:ProcessTimeout - 转换文件超时
    */ TaskStatus?: number; /** * 状态描述，需要关注的状态 - NeedTranform - 任务已提交 - Processing - 文档转换中 - TaskEnd - 任务处理完成 - DownloadFailed - 下载失败 - ProcessFailed - 转换失败 - ProcessTimeout - 转换文件超时 +
    • **NeedTranform** : 任务已提交
      • +
    • **Processing** : 文档转换中
      • +
    • **TaskEnd** : 任务处理完成
      • +
    • **DownloadFailed** : 下载失败
      • +
    • **ProcessFailed** : 转换失败
      • +
    • **ProcessTimeout** : 转换文件超时
    */ TaskMessage?: string; /** - * 资源Id，也是FileId，用于文件发起使用 + * 资源Id，也是FileId，用于文件发起时使用 */ ResourceId?: string; /** @@ -5170,55 +5299,90 @@ export interface ChannelCancelFlowRequest { */ export interface DescribeTemplatesRequest { /** - * 应用相关信息。 - 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId必填。 + * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 + + 此接口下面信息必填。 +
      +
    • 渠道应用标识: Agent.AppId
      • +
    • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
      • +
    • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
      • +
    + 第三方平台子客企业和员工必须已经经过实名认证 */ Agent: Agent; /** - * 模板唯一标识，查询单个模板时使用 + * 合同模板ID，为32位字符串。 + 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 */ TemplateId?: string; /** - * 查询内容： - 0-模板列表及详情（默认）， - 1-仅模板列表 + * 查询内容控制 + +
    • **0**：模板列表及详情（默认）
      • +
    • **1**：仅模板列表
    */ ContentType?: number; /** - * 指定每页多少条数据，如果不传默认为20，单页最大100。 + * 合同模板ID数组，每一个合同模板ID为32位字符串。 + 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。 + + ```注意: + 1. 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。 + 2. 请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。 + 3. 最多支持200个模板。 + 4. 若传递此参数，分页参数(Limit,Offset)无效``` + + */ + TemplateIds?: Array; + /** + * 指定每页返回的数据条数，和Offset参数配合使用。 + + 注：`1.默认值为20，单页做大值为200。` */ Limit?: number; /** - * 查询结果分页返回，此处指定第几页，如果不传默从第一页返回。页码从0开始，即首页为0。 + * 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 + + 注：`1.offset从0开始，即第一页为0。` + `2.默认从第一页返回。` */ Offset?: number; /** - * 是否返回所有组件信息。 - 默认false，只返回发起方控件； - true，返回所有签署方控件 + * 模糊搜索的模板名称，注意是模板名的连续部分，最大长度200 */ - QueryAllComponents?: boolean; + TemplateName?: string; /** - * 模糊搜索模板名称，最大长度200 + * 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。 */ - TemplateName?: string; + ChannelTemplateId?: string; + /** + * 是否返回所有控件信息。 + +
    • **false**：只返回发起方控件（默认）
      • +
    • **true**：返回所有签署方控件
    + */ + QueryAllComponents?: boolean; /** - * 是否获取模板预览链接， - 默认false-不获取 - true-获取 + * 是否获取模板预览链接。 + +
    • **false**：不获取（默认）
      • +
    • **true**：获取
    + + 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,有效期5分钟。 + 可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。 + （此功能开放需要联系客户经理） */ WithPreviewUrl?: boolean; /** * 是否获取模板的PDF文件链接。 - 默认false-不获取 - true-获取 - 请联系客户经理开白后使用。 + +
    • **false**：不获取（默认）
      • +
    • **true**：获取
    + + 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟。 + （此功能开放需要联系客户经理） */ WithPdfUrl?: boolean; - /** - * 对应第三方应用平台企业的模板ID - */ - ChannelTemplateId?: string; /** * 操作者的信息 * @deprecated diff --git a/tencentcloud/services/ims/index.d.ts b/tencentcloud/services/ims/index.d.ts index 78cd32c06..f589aa252 100644 --- a/tencentcloud/services/ims/index.d.ts +++ b/tencentcloud/services/ims/index.d.ts @@ -1,10 +1,10 @@ export declare const ims: { - v20200713: { - Client: typeof import("./v20200713/ims_client").Client; - Models: typeof import("./v20200713/ims_models"); - }; v20201229: { Client: typeof import("./v20201229/ims_client").Client; Models: typeof import("./v20201229/ims_models"); }; + v20200713: { + Client: typeof import("./v20200713/ims_client").Client; + Models: typeof import("./v20200713/ims_models"); + }; }; diff --git a/tencentcloud/services/ims/index.js b/tencentcloud/services/ims/index.js index b4b7c6344..c2d14c8c1 100644 --- a/tencentcloud/services/ims/index.js +++ b/tencentcloud/services/ims/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.ims = void 0; -const v20200713_1 = require("./v20200713"); const v20201229_1 = require("./v20201229"); +const v20200713_1 = require("./v20200713"); exports.ims = { - v20200713: v20200713_1.v20200713, v20201229: v20201229_1.v20201229, + v20200713: v20200713_1.v20200713, }; diff --git a/tencentcloud/services/iotvideo/index.d.ts b/tencentcloud/services/iotvideo/index.d.ts index 5d0ae69bc..d251110e6 100644 --- a/tencentcloud/services/iotvideo/index.d.ts +++ b/tencentcloud/services/iotvideo/index.d.ts @@ -1,4 +1,8 @@ export declare const iotvideo: { + v20201215: { + Client: typeof import("./v20201215/iotvideo_client").Client; + Models: typeof import("./v20201215/iotvideo_models"); + }; v20191126: { Client: typeof import("./v20191126/iotvideo_client").Client; Models: typeof import("./v20191126/iotvideo_models"); @@ -7,8 +11,4 @@ export declare const iotvideo: { Client: typeof import("./v20211125/iotvideo_client").Client; Models: typeof import("./v20211125/iotvideo_models"); }; - v20201215: { - Client: typeof import("./v20201215/iotvideo_client").Client; - Models: typeof import("./v20201215/iotvideo_models"); - }; }; diff --git a/tencentcloud/services/iotvideo/index.js b/tencentcloud/services/iotvideo/index.js index b42bd5ef7..323f17c0b 100644 --- a/tencentcloud/services/iotvideo/index.js +++ b/tencentcloud/services/iotvideo/index.js @@ -1,11 +1,11 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.iotvideo = void 0; +const v20201215_1 = require("./v20201215"); const v20191126_1 = require("./v20191126"); const v20211125_1 = require("./v20211125"); -const v20201215_1 = require("./v20201215"); exports.iotvideo = { + v20201215: v20201215_1.v20201215, v20191126: v20191126_1.v20191126, v20211125: v20211125_1.v20211125, - v20201215: v20201215_1.v20201215, }; diff --git a/tencentcloud/services/sms/index.d.ts b/tencentcloud/services/sms/index.d.ts index 4f2563a79..78be92db5 100644 --- a/tencentcloud/services/sms/index.d.ts +++ b/tencentcloud/services/sms/index.d.ts @@ -1,10 +1,10 @@ export declare const sms: { - v20190711: { - Client: typeof import("./v20190711/sms_client").Client; - Models: typeof import("./v20190711/sms_models"); - }; v20210111: { Client: typeof import("./v20210111/sms_client").Client; Models: typeof import("./v20210111/sms_models"); }; + v20190711: { + Client: typeof import("./v20190711/sms_client").Client; + Models: typeof import("./v20190711/sms_models"); + }; }; diff --git a/tencentcloud/services/sms/index.js b/tencentcloud/services/sms/index.js index 6ef01e562..01160d24b 100644 --- a/tencentcloud/services/sms/index.js +++ b/tencentcloud/services/sms/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.sms = void 0; -const v20190711_1 = require("./v20190711"); const v20210111_1 = require("./v20210111"); +const v20190711_1 = require("./v20190711"); exports.sms = { - v20190711: v20190711_1.v20190711, v20210111: v20210111_1.v20210111, + v20190711: v20190711_1.v20190711, }; diff --git a/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts b/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts index 3b5f99fdf..64abaee5d 100644 --- a/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +++ b/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts @@ -1,6 +1,6 @@ import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; -import { DescribeRolesResponse, DescribeBindClustersResponse, DescribeRabbitMQVirtualHostResponse, DescribeNamespaceBundlesOptRequest, DeleteRabbitMQUserRequest, DescribeSubscriptionsRequest, DescribeRocketMQGroupsRequest, CreateRocketMQGroupRequest, ModifyRabbitMQVirtualHostRequest, ModifyEnvironmentAttributesRequest, DeleteClusterResponse, ModifyCmqSubscriptionAttributeResponse, CreateCmqTopicRequest, ModifyRabbitMQVipInstanceRequest, ImportRocketMQTopicsResponse, DescribeRocketMQMigratingTopicListRequest, ResetRocketMQConsumerOffSetResponse, ModifyRocketMQInstanceSpecRequest, ModifyRoleResponse, DescribeRocketMQTopicMsgsResponse, SendRocketMQMessageRequest, DescribeRocketMQMsgTraceResponse, DescribeRocketMQPublicAccessPointRequest, SendMessagesRequest, DescribeCmqQueuesResponse, CreateRabbitMQVipInstanceRequest, DescribeAllTenantsResponse, CreateRabbitMQVirtualHostResponse, DescribeRabbitMQNodeListRequest, DescribeNamespaceBundlesOptResponse, ReceiveMessageRequest, DescribeBindVpcsResponse, RewindCmqQueueResponse, DescribeRocketMQSmoothMigrationTaskRequest, DeleteClusterRequest, DescribeRocketMQSourceClusterGroupListResponse, SetRocketMQPublicAccessPointResponse, DeleteRocketMQGroupRequest, ModifyRabbitMQUserRequest, DeleteCmqTopicResponse, CreateSubscriptionRequest, CreateRocketMQNamespaceRequest, DescribeCmqTopicDetailResponse, ModifyRabbitMQVirtualHostResponse, SetRocketMQPublicAccessPointRequest, CreateEnvironmentResponse, CreateSubscriptionResponse, ModifyEnvironmentRoleRequest, DescribeRabbitMQQueuesResponse, SendMsgResponse, ModifyCmqTopicAttributeResponse, DescribeCmqSubscriptionDetailRequest, DescribePublisherSummaryResponse, DescribeEnvironmentsRequest, DescribeRocketMQNamespacesRequest, DescribeRocketMQTopicsRequest, ModifyRocketMQClusterResponse, DescribeCmqQueueDetailResponse, CreateEnvironmentRequest, ClearCmqQueueRequest, ModifyEnvironmentAttributesResponse, DescribeRocketMQSubscriptionsResponse, DescribeClustersRequest, DescribeRocketMQClusterResponse, DeleteRocketMQVipInstanceResponse, DescribeCmqSubscriptionDetailResponse, RewindCmqQueueRequest, DescribeRabbitMQUserResponse, DescribeRocketMQMsgResponse, ModifyClusterRequest, DescribeEnvironmentAttributesRequest, ModifyRocketMQClusterRequest, CreateRocketMQVipInstanceResponse, AcknowledgeMessageRequest, ImportRocketMQConsumerGroupsRequest, DescribeRocketMQVipInstanceDetailResponse, PublishCmqMsgResponse, DescribePublishersRequest, CreateRocketMQClusterRequest, CreateRabbitMQUserResponse, AcknowledgeMessageResponse, DeleteEnvironmentRolesResponse, DescribeClusterDetailRequest, ModifyRoleRequest, DeleteCmqQueueResponse, DescribeRocketMQClusterRequest, DeleteRocketMQTopicResponse, SendRocketMQMessageResponse, ModifyCmqTopicAttributeRequest, DescribeRabbitMQVipInstancesResponse, DeleteRolesRequest, ModifyRocketMQTopicResponse, CreateCmqSubscribeResponse, DescribeSubscriptionsResponse, DescribeRocketMQConsumerConnectionsResponse, DeleteRocketMQVipInstanceRequest, DescribeRocketMQMsgRequest, SendMessagesResponse, DescribeRocketMQNamespacesResponse, CreateTopicRequest, DescribeTopicsRequest, DeleteEnvironmentsResponse, DescribeRabbitMQQueueDetailResponse, ModifyAMQPClusterRequest, ReceiveMessageResponse, DescribeEnvironmentRolesResponse, DescribeRocketMQPublicAccessPointResponse, DescribeRocketMQMsgTraceRequest, ModifyRocketMQGroupRequest, DescribeCmqTopicsResponse, DescribeCmqTopicDetailRequest, DescribeRocketMQMigratingTopicListResponse, UnbindCmqDeadLetterResponse, ModifyRocketMQNamespaceResponse, DescribePulsarProInstancesRequest, DeleteEnvironmentsRequest, DescribeRocketMQClustersRequest, ModifyClusterResponse, DescribeBindVpcsRequest, DescribeClustersResponse, ClearCmqSubscriptionFilterTagsRequest, SendCmqMsgResponse, CreateRocketMQGroupResponse, ModifyRocketMQNamespaceRequest, DescribeEnvironmentRolesRequest, DescribeRocketMQClustersResponse, DeleteRolesResponse, DescribeRocketMQSourceClusterTopicListRequest, ModifyRocketMQTopicRequest, DescribeRabbitMQUserRequest, DescribeRocketMQTopicsResponse, DeleteRocketMQGroupResponse, CreateCmqQueueResponse, DescribeRocketMQGroupsResponse, ResetMsgSubOffsetByTimestampResponse, CreateClusterResponse, DescribeRocketMQSmoothMigrationTaskListRequest, DescribeCmqDeadLetterSourceQueuesRequest, DeleteRocketMQNamespaceRequest, DescribeRolesRequest, DescribeRocketMQSmoothMigrationTaskListResponse, CreateClusterRequest, DescribeRocketMQSourceClusterTopicListResponse, DescribeRabbitMQVirtualHostListRequest, DescribeAMQPClustersRequest, ModifyCmqQueueAttributeResponse, CreateTopicResponse, DescribeCmqQueuesRequest, DescribeEnvironmentsResponse, DescribeRabbitMQVipInstanceResponse, ModifyCmqSubscriptionAttributeRequest, ModifyTopicResponse, ModifyRocketMQInstanceSpecResponse, DeleteTopicsResponse, DescribeRocketMQVipInstancesRequest, DescribeRocketMQVipInstanceDetailRequest, CreateRocketMQVipInstanceRequest, DeleteRocketMQClusterResponse, CreateCmqTopicResponse, ClearCmqSubscriptionFilterTagsResponse, CreateRabbitMQVipInstanceResponse, DescribeRabbitMQVipInstanceRequest, DescribeCmqTopicsRequest, DescribeRocketMQSubscriptionsRequest, DeleteTopicsRequest, ModifyTopicRequest, ResetMsgSubOffsetByTimestampRequest, CreateEnvironmentRoleResponse, CreateCmqSubscribeRequest, DeleteCmqSubscribeRequest, DescribeAMQPClustersResponse, DescribeCmqDeadLetterSourceQueuesResponse, DeleteSubscriptionsResponse, DeleteRocketMQTopicRequest, CreateRocketMQClusterResponse, ModifyPublicNetworkAccessPointRequest, DescribeRabbitMQQueuesRequest, DeleteRocketMQNamespaceResponse, DescribePublishersResponse, ModifyRabbitMQVipInstanceResponse, SendMsgRequest, ResetRocketMQConsumerOffSetRequest, DescribeCmqQueueDetailRequest, DescribeRocketMQSourceClusterGroupListRequest, DeleteRabbitMQVirtualHostRequest, CreateRocketMQTopicRequest, CreateRoleResponse, DeleteRocketMQClusterRequest, DescribePulsarProInstancesResponse, DeleteEnvironmentRolesRequest, ClearCmqQueueResponse, ModifyRabbitMQUserResponse, DescribeNodeHealthOptRequest, DescribeRocketMQSmoothMigrationTaskResponse, DeleteRabbitMQVirtualHostResponse, CreateRocketMQTopicResponse, CreateRabbitMQVirtualHostRequest, CreateCmqQueueRequest, ModifyEnvironmentRoleResponse, DescribeRabbitMQQueueDetailRequest, DeleteCmqQueueRequest, DeleteRabbitMQUserResponse, DescribeRabbitMQVirtualHostListResponse, DescribeBindClustersRequest, DescribePulsarProInstanceDetailRequest, CreateRabbitMQUserRequest, DescribeRocketMQConsumerConnectionsRequest, CreateRoleRequest, DescribeRocketMQTopicMsgsRequest, ImportRocketMQConsumerGroupsResponse, DescribeEnvironmentAttributesResponse, ModifyAMQPClusterResponse, DescribeTopicsResponse, CreateRocketMQNamespaceResponse, SendBatchMessagesRequest, DeleteCmqTopicRequest, DescribeRabbitMQNodeListResponse, DescribePulsarProInstanceDetailResponse, DescribeNodeHealthOptResponse, ModifyPublicNetworkAccessPointResponse, PublishCmqMsgRequest, UnbindCmqDeadLetterRequest, ModifyCmqQueueAttributeRequest, DeleteCmqSubscribeResponse, DeleteRabbitMQVipInstanceRequest, DescribePublisherSummaryRequest, DeleteSubscriptionsRequest, SendCmqMsgRequest, ModifyRocketMQGroupResponse, DescribeRocketMQVipInstancesResponse, DescribeRabbitMQVipInstancesRequest, DescribeClusterDetailResponse, SendBatchMessagesResponse, ImportRocketMQTopicsRequest, CreateEnvironmentRoleRequest, DeleteRabbitMQVipInstanceResponse, DescribeAllTenantsRequest, DescribeRabbitMQVirtualHostRequest } from "./tdmq_models"; +import { DescribeRolesResponse, DescribeBindClustersResponse, DescribeRabbitMQVirtualHostResponse, DescribeNamespaceBundlesOptRequest, DeleteRabbitMQUserRequest, DescribeSubscriptionsRequest, DescribeRocketMQGroupsRequest, CreateRocketMQGroupRequest, ModifyRabbitMQVirtualHostRequest, ModifyEnvironmentAttributesRequest, DeleteClusterResponse, ModifyCmqSubscriptionAttributeResponse, CreateCmqTopicRequest, ModifyRabbitMQVipInstanceRequest, ImportRocketMQTopicsResponse, DescribeRocketMQMigratingTopicListRequest, ResetRocketMQConsumerOffSetResponse, ModifyRocketMQInstanceSpecRequest, ModifyRoleResponse, DescribeRocketMQTopicMsgsResponse, SendRocketMQMessageRequest, DescribeRocketMQMsgTraceResponse, DescribeRocketMQPublicAccessPointRequest, SendMessagesRequest, DescribeCmqQueuesResponse, CreateRabbitMQVipInstanceRequest, DescribeAllTenantsResponse, CreateRabbitMQVirtualHostResponse, DescribeRabbitMQNodeListRequest, DescribeNamespaceBundlesOptResponse, ReceiveMessageRequest, DescribeBindVpcsResponse, RewindCmqQueueResponse, DescribeRocketMQSmoothMigrationTaskRequest, DescribeRocketMQSourceClusterGroupListResponse, SetRocketMQPublicAccessPointResponse, DeleteRocketMQGroupRequest, ModifyRabbitMQUserRequest, DescribeRocketMQConsumeStatsResponse, DeleteCmqTopicResponse, CreateSubscriptionRequest, CreateRocketMQNamespaceRequest, DescribeCmqTopicDetailResponse, ModifyRabbitMQVirtualHostResponse, SetRocketMQPublicAccessPointRequest, CreateEnvironmentResponse, CreateSubscriptionResponse, ModifyEnvironmentRoleRequest, DescribeRabbitMQQueuesResponse, SendMsgResponse, ModifyCmqTopicAttributeResponse, DescribeCmqSubscriptionDetailRequest, DescribePublisherSummaryResponse, DescribeEnvironmentsRequest, DescribeRocketMQNamespacesRequest, DescribeRocketMQTopicsRequest, ModifyRocketMQClusterResponse, DescribeCmqQueueDetailResponse, CreateEnvironmentRequest, ClearCmqQueueRequest, ModifyEnvironmentAttributesResponse, DescribeRocketMQSubscriptionsResponse, DescribeClustersRequest, DescribeRocketMQClusterResponse, DeleteRocketMQVipInstanceResponse, DescribeCmqSubscriptionDetailResponse, RewindCmqQueueRequest, DescribeRabbitMQUserResponse, DescribeRocketMQMsgResponse, ModifyClusterRequest, DescribeEnvironmentAttributesRequest, ModifyRocketMQClusterRequest, CreateRocketMQVipInstanceResponse, AcknowledgeMessageRequest, ImportRocketMQConsumerGroupsRequest, DescribeRocketMQVipInstanceDetailResponse, PublishCmqMsgResponse, DescribePublishersRequest, CreateRocketMQClusterRequest, CreateRabbitMQUserResponse, AcknowledgeMessageResponse, DeleteEnvironmentRolesResponse, DescribeClusterDetailRequest, ModifyRoleRequest, DeleteCmqQueueResponse, DescribeRocketMQClusterRequest, DeleteRocketMQTopicResponse, SendRocketMQMessageResponse, ModifyCmqTopicAttributeRequest, DescribeRabbitMQVipInstancesResponse, DeleteRolesRequest, ModifyRocketMQTopicResponse, CreateCmqSubscribeResponse, DescribeSubscriptionsResponse, DescribeRocketMQConsumerConnectionsResponse, DeleteRocketMQVipInstanceRequest, DescribeRocketMQMsgRequest, SendMessagesResponse, DescribeRocketMQNamespacesResponse, CreateTopicRequest, DescribeTopicsRequest, DeleteEnvironmentsResponse, DescribeRabbitMQQueueDetailResponse, ModifyAMQPClusterRequest, ReceiveMessageResponse, DescribeEnvironmentRolesResponse, DescribeRocketMQPublicAccessPointResponse, VerifyRocketMQConsumeResponse, DescribeRocketMQMsgTraceRequest, ModifyRocketMQGroupRequest, DescribeCmqTopicsResponse, DescribeCmqTopicDetailRequest, DescribeRocketMQMigratingTopicListResponse, UnbindCmqDeadLetterResponse, ModifyRocketMQNamespaceResponse, DescribePulsarProInstancesRequest, DeleteEnvironmentsRequest, DescribeRocketMQClustersRequest, ModifyClusterResponse, DescribeBindVpcsRequest, DescribeClustersResponse, ClearCmqSubscriptionFilterTagsRequest, SendCmqMsgResponse, CreateRocketMQGroupResponse, ModifyRocketMQNamespaceRequest, DescribeEnvironmentRolesRequest, DescribeRocketMQClustersResponse, DeleteRolesResponse, DescribeRocketMQSourceClusterTopicListRequest, ModifyRocketMQTopicRequest, DescribeRabbitMQUserRequest, DescribeRocketMQTopicsResponse, DeleteRocketMQGroupResponse, CreateCmqQueueResponse, DescribeRocketMQGroupsResponse, ResetMsgSubOffsetByTimestampResponse, CreateClusterResponse, DescribeRocketMQSmoothMigrationTaskListRequest, DescribeCmqDeadLetterSourceQueuesRequest, DeleteRocketMQNamespaceRequest, DescribeRolesRequest, DescribeRocketMQSmoothMigrationTaskListResponse, CreateClusterRequest, DescribeRocketMQSourceClusterTopicListResponse, DescribeRabbitMQVirtualHostListRequest, DescribeAMQPClustersRequest, ModifyCmqQueueAttributeResponse, CreateTopicResponse, DescribeCmqQueuesRequest, DescribeEnvironmentsResponse, DescribeRabbitMQVipInstanceResponse, ModifyCmqSubscriptionAttributeRequest, ModifyTopicResponse, ModifyRocketMQInstanceSpecResponse, DeleteTopicsResponse, DescribeRocketMQVipInstancesRequest, DescribeRocketMQVipInstanceDetailRequest, CreateRocketMQVipInstanceRequest, DeleteRocketMQClusterResponse, CreateCmqTopicResponse, ModifyRabbitMQVipInstanceResponse, ClearCmqSubscriptionFilterTagsResponse, CreateRabbitMQVipInstanceResponse, DescribeRabbitMQVipInstanceRequest, DescribeCmqTopicsRequest, DescribeRocketMQSubscriptionsRequest, DeleteTopicsRequest, ModifyTopicRequest, ResetMsgSubOffsetByTimestampRequest, CreateEnvironmentRoleResponse, CreateCmqSubscribeRequest, DeleteCmqSubscribeRequest, DescribeAMQPClustersResponse, DescribeCmqDeadLetterSourceQueuesResponse, DeleteSubscriptionsResponse, DeleteRocketMQTopicRequest, CreateRocketMQClusterResponse, ModifyPublicNetworkAccessPointRequest, DescribeRabbitMQQueuesRequest, DeleteRocketMQNamespaceResponse, DescribePublishersResponse, DeleteClusterRequest, SendMsgRequest, ResetRocketMQConsumerOffSetRequest, DescribeCmqQueueDetailRequest, DescribeRocketMQSourceClusterGroupListRequest, DeleteRabbitMQVirtualHostRequest, CreateRocketMQTopicRequest, CreateRoleResponse, DeleteRocketMQClusterRequest, DescribePulsarProInstancesResponse, DeleteEnvironmentRolesRequest, ClearCmqQueueResponse, ModifyRabbitMQUserResponse, DescribeNodeHealthOptRequest, DescribeRocketMQSmoothMigrationTaskResponse, DeleteRabbitMQVirtualHostResponse, CreateRocketMQTopicResponse, CreateRabbitMQVirtualHostRequest, CreateCmqQueueRequest, ModifyEnvironmentRoleResponse, DescribeRabbitMQQueueDetailRequest, DeleteCmqQueueRequest, DeleteRabbitMQUserResponse, DescribeRabbitMQVirtualHostListResponse, DescribeBindClustersRequest, DescribePulsarProInstanceDetailRequest, CreateRabbitMQUserRequest, DescribeRocketMQConsumerConnectionsRequest, CreateRoleRequest, DescribeRocketMQTopicMsgsRequest, ImportRocketMQConsumerGroupsResponse, DescribeEnvironmentAttributesResponse, ModifyAMQPClusterResponse, DescribeTopicsResponse, CreateRocketMQNamespaceResponse, DescribeRocketMQConsumeStatsRequest, SendBatchMessagesRequest, DeleteCmqTopicRequest, DescribeRabbitMQNodeListResponse, DescribePulsarProInstanceDetailResponse, DescribeNodeHealthOptResponse, ModifyPublicNetworkAccessPointResponse, PublishCmqMsgRequest, UnbindCmqDeadLetterRequest, ModifyCmqQueueAttributeRequest, DeleteCmqSubscribeResponse, DeleteRabbitMQVipInstanceRequest, DescribePublisherSummaryRequest, DeleteSubscriptionsRequest, SendCmqMsgRequest, ModifyRocketMQGroupResponse, DescribeRocketMQVipInstancesResponse, DescribeRabbitMQVipInstancesRequest, DescribeClusterDetailResponse, VerifyRocketMQConsumeRequest, SendBatchMessagesResponse, ImportRocketMQTopicsRequest, CreateEnvironmentRoleRequest, DeleteRabbitMQVipInstanceResponse, DescribeAllTenantsRequest, DescribeRabbitMQVirtualHostRequest } from "./tdmq_models"; /** * tdmq client * @class @@ -15,6 +15,10 @@ export declare class Client extends AbstractClient { * 创建用户的集群 */ CreateCluster(req: CreateClusterRequest, cb?: (error: string, rep: CreateClusterResponse) => void): Promise; + /** + * 获取消费详情列表 + */ + DescribeRocketMQConsumeStats(req: DescribeRocketMQConsumeStatsRequest, cb?: (error: string, rep: DescribeRocketMQConsumeStatsResponse) => void): Promise; /** * 获取RocketMQ命名空间列表 */ @@ -284,6 +288,10 @@ export declare class Client extends AbstractClient { * 查询用户已购的RocketMQ专享实例列表 */ DescribeRocketMQVipInstances(req: DescribeRocketMQVipInstancesRequest, cb?: (error: string, rep: DescribeRocketMQVipInstancesResponse) => void): Promise; + /** + * Rocketmq消费验证 + */ + VerifyRocketMQConsume(req: VerifyRocketMQConsumeRequest, cb?: (error: string, rep: VerifyRocketMQConsumeResponse) => void): Promise; /** * 获取amqp集群列表 */ diff --git a/tencentcloud/services/tdmq/v20200217/tdmq_client.js b/tencentcloud/services/tdmq/v20200217/tdmq_client.js index a476ec848..3d7a0e3a5 100644 --- a/tencentcloud/services/tdmq/v20200217/tdmq_client.js +++ b/tencentcloud/services/tdmq/v20200217/tdmq_client.js @@ -39,6 +39,12 @@ class Client extends abstract_client_1.AbstractClient { async CreateCluster(req, cb) { return this.request("CreateCluster", req, cb); } + /** + * 获取消费详情列表 + */ + async DescribeRocketMQConsumeStats(req, cb) { + return this.request("DescribeRocketMQConsumeStats", req, cb); + } /** * 获取RocketMQ命名空间列表 */ @@ -442,6 +448,12 @@ class Client extends abstract_client_1.AbstractClient { async DescribeRocketMQVipInstances(req, cb) { return this.request("DescribeRocketMQVipInstances", req, cb); } + /** + * Rocketmq消费验证 + */ + async VerifyRocketMQConsume(req, cb) { + return this.request("VerifyRocketMQConsume", req, cb); + } /** * 获取amqp集群列表 */ diff --git a/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts b/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts index 3072d919b..55e7a40f4 100644 --- a/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +++ b/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts @@ -108,6 +108,36 @@ export interface DescribeRabbitMQVirtualHostResponse { */ RequestId?: string; } +/** + * RabbiteMQ集群白名单信息 + */ +export interface RabbitMQClusterWhiteListInfo { + /** + * 废弃 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + WhiteList: string; + /** + * 公网管控台白名单 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicControlConsoleWhiteList: string; + /** + * 公网数据流白名单 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicDataStreamWhiteList: string; + /** + * 公网管控台白名单状态 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicControlConsoleWhiteListStatus?: string; + /** + * 公网数据流白名单状态 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + PublicDataStreamWhiteListStatus?: string; +} /** * cmq DeadLetterPolicy */ @@ -1023,13 +1053,49 @@ export interface DescribeRocketMQSmoothMigrationTaskRequest { TaskId: string; } /** - * DeleteCluster请求参数结构体 + * 消费详情 */ -export interface DeleteClusterRequest { +export interface ConsumerStats { /** - * 集群Id，传入需要删除的集群Id。 + * 主题名 + 注意：此字段可能返回 null，表示取不到有效值。 */ - ClusterId: string; + TopicName?: string; + /** + * 所属Broker + 注意：此字段可能返回 null，表示取不到有效值。 + */ + BrokerName?: string; + /** + * 队列编号 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + QueueId?: number; + /** + * 消费者ID + 注意：此字段可能返回 null，表示取不到有效值。 + */ + ConsumerClientId?: string; + /** + * 消费位点 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + ConsumerOffset?: number; + /** + * 服务端位点 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + BrokerOffset?: number; + /** + * 消息堆积条数 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + DiffTotal?: number; + /** + * 最近消费时间 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + LastTimestamp?: number; } /** * cmq订阅返回参数 @@ -1374,34 +1440,17 @@ export interface ModifyRabbitMQUserRequest { MaxChannels?: number; } /** - * RabbiteMQ集群白名单信息 + * DescribeRocketMQConsumeStats返回参数结构体 */ -export interface RabbitMQClusterWhiteListInfo { +export interface DescribeRocketMQConsumeStatsResponse { /** - * 废弃 - 注意：此字段可能返回 null，表示取不到有效值。 + * 消费详情列表 */ - WhiteList: string; - /** - * 公网管控台白名单 - 注意：此字段可能返回 null，表示取不到有效值。 - */ - PublicControlConsoleWhiteList: string; - /** - * 公网数据流白名单 - 注意：此字段可能返回 null，表示取不到有效值。 - */ - PublicDataStreamWhiteList: string; - /** - * 公网管控台白名单状态 - 注意：此字段可能返回 null，表示取不到有效值。 - */ - PublicControlConsoleWhiteListStatus?: string; + ConsumerStatsList?: Array; /** - * 公网数据流白名单状态 - 注意：此字段可能返回 null，表示取不到有效值。 + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ - PublicDataStreamWhiteListStatus?: string; + RequestId?: string; } /** * DeleteCmqTopic返回参数结构体 @@ -3514,6 +3563,15 @@ export interface DescribeRocketMQPublicAccessPointResponse { */ RequestId?: string; } +/** + * VerifyRocketMQConsume返回参数结构体 + */ +export interface VerifyRocketMQConsumeResponse { + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string; +} /** * DescribeRocketMQMsgTrace请求参数结构体 */ @@ -5402,6 +5460,20 @@ export interface CmqDeadLetterSource { */ QueueName: string; } +/** + * ModifyRabbitMQVipInstance返回参数结构体 + */ +export interface ModifyRabbitMQVipInstanceResponse { + /** + * 实例id + 注意：此字段可能返回 null，表示取不到有效值。 + */ + InstanceId?: string; + /** + * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + */ + RequestId?: string; +} /** * ClearCmqSubscriptionFilterTags返回参数结构体 */ @@ -6235,18 +6307,13 @@ export interface DescribePublishersResponse { RequestId?: string; } /** - * ModifyRabbitMQVipInstance返回参数结构体 + * DeleteCluster请求参数结构体 */ -export interface ModifyRabbitMQVipInstanceResponse { - /** - * 实例id - 注意：此字段可能返回 null，表示取不到有效值。 - */ - InstanceId?: string; +export interface DeleteClusterRequest { /** - * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 + * 集群Id，传入需要删除的集群Id。 */ - RequestId?: string; + ClusterId: string; } /** * SendMsg请求参数结构体 @@ -7203,58 +7270,21 @@ export interface CreateRocketMQNamespaceResponse { RequestId?: string; } /** - * RocketMQ专享集群实例配置 + * DescribeRocketMQConsumeStats请求参数结构体 */ -export interface RocketMQInstanceConfig { - /** - * 单命名空间TPS上线 - */ - MaxTpsPerNamespace?: number; +export interface DescribeRocketMQConsumeStatsRequest { /** - * 最大命名空间数量 - */ - MaxNamespaceNum?: number; - /** - * 已使用命名空间数量 - */ - UsedNamespaceNum?: number; - /** - * 最大Topic数量 - */ - MaxTopicNum?: number; - /** - * 已使用Topic数量 - */ - UsedTopicNum?: number; - /** - * 最大Group数量 - */ - MaxGroupNum?: number; - /** - * 已使用Group数量 - */ - UsedGroupNum?: number; - /** - * 集群类型 - */ - ConfigDisplay?: string; - /** - * 集群节点数 - */ - NodeCount?: number; - /** - * 节点分布情况 + * 实例ID */ - NodeDistribution?: Array; + ClusterId: string; /** - * topic分布情况 + * 命名空间 */ - TopicDistribution?: Array; + NamespaceId: string; /** - * 每个主题最大队列数 - 注意：此字段可能返回 null，表示取不到有效值。 + * 消费组 */ - MaxQueuesPerTopic?: number; + ConsumerGroup: string; } /** * SendBatchMessages请求参数结构体 @@ -7406,6 +7436,60 @@ export interface ModifyPublicNetworkAccessPointResponse { */ RequestId?: string; } +/** + * RocketMQ专享集群实例配置 + */ +export interface RocketMQInstanceConfig { + /** + * 单命名空间TPS上线 + */ + MaxTpsPerNamespace?: number; + /** + * 最大命名空间数量 + */ + MaxNamespaceNum?: number; + /** + * 已使用命名空间数量 + */ + UsedNamespaceNum?: number; + /** + * 最大Topic数量 + */ + MaxTopicNum?: number; + /** + * 已使用Topic数量 + */ + UsedTopicNum?: number; + /** + * 最大Group数量 + */ + MaxGroupNum?: number; + /** + * 已使用Group数量 + */ + UsedGroupNum?: number; + /** + * 集群类型 + */ + ConfigDisplay?: string; + /** + * 集群节点数 + */ + NodeCount?: number; + /** + * 节点分布情况 + */ + NodeDistribution?: Array; + /** + * topic分布情况 + */ + TopicDistribution?: Array; + /** + * 每个主题最大队列数 + 注意：此字段可能返回 null，表示取不到有效值。 + */ + MaxQueuesPerTopic?: number; +} /** * PublishCmqMsg请求参数结构体 */ @@ -7903,6 +7987,35 @@ export interface DescribeClusterDetailResponse { */ RequestId?: string; } +/** + * VerifyRocketMQConsume请求参数结构体 + */ +export interface VerifyRocketMQConsumeRequest { + /** + * 集群id + */ + ClusterId: string; + /** + * 命名空间 + */ + NamespaceId: string; + /** + * 消费组ID + */ + GroupId: string; + /** + * 消息id + */ + MsgId: string; + /** + * 客户端ID + */ + ClientId: string; + /** + * topic名称 + */ + TopicName: string; +} /** * SendBatchMessages返回参数结构体 */ diff --git a/tencentcloud/services/tem/index.d.ts b/tencentcloud/services/tem/index.d.ts index 6f53742cc..a4c8c72f0 100644 --- a/tencentcloud/services/tem/index.d.ts +++ b/tencentcloud/services/tem/index.d.ts @@ -1,10 +1,10 @@ export declare const tem: { - v20210701: { - Client: typeof import("./v20210701/tem_client").Client; - Models: typeof import("./v20210701/tem_models"); - }; v20201221: { Client: typeof import("./v20201221/tem_client").Client; Models: typeof import("./v20201221/tem_models"); }; + v20210701: { + Client: typeof import("./v20210701/tem_client").Client; + Models: typeof import("./v20210701/tem_models"); + }; }; diff --git a/tencentcloud/services/tem/index.js b/tencentcloud/services/tem/index.js index dd1a4cbe0..283608098 100644 --- a/tencentcloud/services/tem/index.js +++ b/tencentcloud/services/tem/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.tem = void 0; -const v20210701_1 = require("./v20210701"); const v20201221_1 = require("./v20201221"); +const v20210701_1 = require("./v20210701"); exports.tem = { - v20210701: v20210701_1.v20210701, v20201221: v20201221_1.v20201221, + v20210701: v20210701_1.v20210701, }; diff --git a/tencentcloud/services/teo/index.d.ts b/tencentcloud/services/teo/index.d.ts index 88ebd7954..298d61a94 100644 --- a/tencentcloud/services/teo/index.d.ts +++ b/tencentcloud/services/teo/index.d.ts @@ -1,10 +1,10 @@ export declare const teo: { - v20220106: { - Client: typeof import("./v20220106/teo_client").Client; - Models: typeof import("./v20220106/teo_models"); - }; v20220901: { Client: typeof import("./v20220901/teo_client").Client; Models: typeof import("./v20220901/teo_models"); }; + v20220106: { + Client: typeof import("./v20220106/teo_client").Client; + Models: typeof import("./v20220106/teo_models"); + }; }; diff --git a/tencentcloud/services/teo/index.js b/tencentcloud/services/teo/index.js index a21e818ea..7700fbafa 100644 --- a/tencentcloud/services/teo/index.js +++ b/tencentcloud/services/teo/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.teo = void 0; -const v20220106_1 = require("./v20220106"); const v20220901_1 = require("./v20220901"); +const v20220106_1 = require("./v20220106"); exports.teo = { - v20220106: v20220106_1.v20220106, v20220901: v20220901_1.v20220901, + v20220106: v20220106_1.v20220106, }; diff --git a/tencentcloud/services/tms/index.d.ts b/tencentcloud/services/tms/index.d.ts index a59a4a15f..9013603d5 100644 --- a/tencentcloud/services/tms/index.d.ts +++ b/tencentcloud/services/tms/index.d.ts @@ -1,10 +1,10 @@ export declare const tms: { - v20200713: { - Client: typeof import("./v20200713/tms_client").Client; - Models: typeof import("./v20200713/tms_models"); - }; v20201229: { Client: typeof import("./v20201229/tms_client").Client; Models: typeof import("./v20201229/tms_models"); }; + v20200713: { + Client: typeof import("./v20200713/tms_client").Client; + Models: typeof import("./v20200713/tms_models"); + }; }; diff --git a/tencentcloud/services/tms/index.js b/tencentcloud/services/tms/index.js index 5e3753716..2f01851ad 100644 --- a/tencentcloud/services/tms/index.js +++ b/tencentcloud/services/tms/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.tms = void 0; -const v20200713_1 = require("./v20200713"); const v20201229_1 = require("./v20201229"); +const v20200713_1 = require("./v20200713"); exports.tms = { - v20200713: v20200713_1.v20200713, v20201229: v20201229_1.v20201229, + v20200713: v20200713_1.v20200713, }; diff --git a/tencentcloud/services/tsw/index.d.ts b/tencentcloud/services/tsw/index.d.ts index cca135717..b1fa267dd 100644 --- a/tencentcloud/services/tsw/index.d.ts +++ b/tencentcloud/services/tsw/index.d.ts @@ -1,10 +1,10 @@ export declare const tsw: { - v20200924: { - Client: typeof import("./v20200924/tsw_client").Client; - Models: typeof import("./v20200924/tsw_models"); - }; v20210412: { Client: typeof import("./v20210412/tsw_client").Client; Models: typeof import("./v20210412/tsw_models"); }; + v20200924: { + Client: typeof import("./v20200924/tsw_client").Client; + Models: typeof import("./v20200924/tsw_models"); + }; }; diff --git a/tencentcloud/services/tsw/index.js b/tencentcloud/services/tsw/index.js index 3118d885b..da72c4774 100644 --- a/tencentcloud/services/tsw/index.js +++ b/tencentcloud/services/tsw/index.js @@ -1,9 +1,9 @@ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.tsw = void 0; -const v20200924_1 = require("./v20200924"); const v20210412_1 = require("./v20210412"); +const v20200924_1 = require("./v20200924"); exports.tsw = { - v20200924: v20200924_1.v20200924, v20210412: v20210412_1.v20210412, + v20200924: v20200924_1.v20200924, }; diff --git a/tencentcloud/services/vm/index.d.ts b/tencentcloud/services/vm/index.d.ts index 81d4c6fc2..36610c9b8 100644 --- a/tencentcloud/services/vm/index.d.ts +++ b/tencentcloud/services/vm/index.d.ts @@ -3,12 +3,12 @@ export declare const vm: { Client: typeof import("./v20201229/vm_client").Client; Models: typeof import("./v20201229/vm_models"); }; - v20200709: { - Client: typeof import("./v20200709/vm_client").Client; - Models: typeof import("./v20200709/vm_models"); - }; v20210922: { Client: typeof import("./v20210922/vm_client").Client; Models: typeof import("./v20210922/vm_models"); }; + v20200709: { + Client: typeof import("./v20200709/vm_client").Client; + Models: typeof import("./v20200709/vm_models"); + }; }; diff --git a/tencentcloud/services/vm/index.js b/tencentcloud/services/vm/index.js index 52554067f..b4405e780 100644 --- a/tencentcloud/services/vm/index.js +++ b/tencentcloud/services/vm/index.js @@ -2,10 +2,10 @@ Object.defineProperty(exports, "__esModule", { value: true }); exports.vm = void 0; const v20201229_1 = require("./v20201229"); -const v20200709_1 = require("./v20200709"); const v20210922_1 = require("./v20210922"); +const v20200709_1 = require("./v20200709"); exports.vm = { v20201229: v20201229_1.v20201229, - v20200709: v20200709_1.v20200709, v20210922: v20210922_1.v20210922, + v20200709: v20200709_1.v20200709, }; diff --git a/tencentcloud/services/vpc/v20170312/vpc_models.d.ts b/tencentcloud/services/vpc/v20170312/vpc_models.d.ts index 65b7b864c..7c6690db1 100644 --- a/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +++ b/tencentcloud/services/vpc/v20170312/vpc_models.d.ts @@ -2004,11 +2004,11 @@ export interface DescribeBandwidthPackagesResponse { /** * 符合条件的带宽包数量 */ - TotalCount: number; + TotalCount?: number; /** * 描述带宽包详细信息 */ - BandwidthPackageSet: Array; + BandwidthPackageSet?: Array; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ @@ -3714,7 +3714,7 @@ export interface DescribeBandwidthPackagesRequest {
  • bandwidth-package_id - String - 是否必填：否 - （过滤条件）按照带宽包的唯一标识ID过滤。
  • bandwidth-package-name - String - 是否必填：否 - （过滤条件）按照 带宽包名称过滤。不支持模糊过滤。
  • network-type - String - 是否必填：否 - （过滤条件）按照带宽包的类型过滤。类型包括'HIGH_QUALITY_BGP','BGP','SINGLEISP'和'ANYCAST'。
    • -
  • charge-type - String - 是否必填：否 - （过滤条件）按照带宽包的计费类型过滤。计费类型包括'TOP5_POSTPAID_BY_MONTH'和'PERCENT95_POSTPAID_BY_MONTH'。
    • +
  • charge-type - String - 是否必填：否 - （过滤条件）按照带宽包的计费类型过滤。计费类型包括:
  • 'TOP5_POSTPAID_BY_MONTH':按月后付费TOP5计费
  • 'PERCENT95_POSTPAID_BY_MONTH':按月后付费月95计费
  • 'ENHANCED95_POSTPAID_BY_MONTH':按月后付费增强型95计费
  • 'FIXED_PREPAID_BY_MONTH':包月预付费计费
  • ‘PEAK_BANDWIDTH_POSTPAID_BY_DAY’: 后付费日结按带宽计费
  • resource.resource-type - String - 是否必填：否 - （过滤条件）按照带宽包资源类型过滤。资源类型包括'Address'和'LoadBalance'
  • resource.resource-id - String - 是否必填：否 - （过滤条件）按照带宽包资源Id过滤。资源Id形如'eip-xxxx','lb-xxxx'
  • resource.address-ip - String - 是否必填：否 - （过滤条件）按照带宽包资源Ip过滤。
    • @@ -10982,7 +10982,8 @@ export interface BandwidthPackage { */ NetworkType?: string; /** - * 带宽包计费类型，包括'TOP5_POSTPAID_BY_MONTH'和'PERCENT95_POSTPAID_BY_MONTH' + * 带宽包计费类型，包括:
  • 'TOP5_POSTPAID_BY_MONTH':按月后付费TOP5计费
  • 'PERCENT95_POSTPAID_BY_MONTH':按月后付费月95计费
  • 'ENHANCED95_POSTPAID_BY_MONTH':按月后付费增强型95计费
  • 'FIXED_PREPAID_BY_MONTH':包月预付费计费
  • ‘PEAK_BANDWIDTH_POSTPAID_BY_DAY’: 后付费日结按带宽计费
    • + */ ChargeType?: string; /** @@ -11010,6 +11011,11 @@ export interface BandwidthPackage { 注意：此字段可能返回 null，表示取不到有效值。 */ Egress?: string; + /** + * 带宽包到期时间，只有预付费会返回，按量计费返回为null + 注意：此字段可能返回 null，表示取不到有效值。 + */ + Deadline?: string; } /** * ModifyVpcAttribute请求参数结构体 diff --git a/test/drm.v20181115.test.js b/test/drm.v20181115.test.js index 1fa46fddd..d7b9d2559 100644 --- a/test/drm.v20181115.test.js +++ b/test/drm.v20181115.test.js @@ -78,6 +78,16 @@ it("drm.v20181115.DescribeKeys", async function () { } }) +it("drm.v20181115.DescribeDRMLicense", async function () { + try { + const data = await client.DescribeDRMLicense({}) + expect(data).to.be.ok + } catch(error) { + expect(error.requestId).to.be.ok + expect(error.code).to.be.ok + } +}) + it("drm.v20181115.DescribeAllKeys", async function () { try { const data = await client.DescribeAllKeys({}) diff --git a/test/ess.v20201111.test.js b/test/ess.v20201111.test.js index ff9f9ee20..50e0169f7 100644 --- a/test/ess.v20201111.test.js +++ b/test/ess.v20201111.test.js @@ -18,9 +18,9 @@ const client = new tencentcloud.ess.v20201111.Client({ }) describe("ess.v20201111.test.js", function () { -it("ess.v20201111.CreateUserAutoSignSealUrl", async function () { +it("ess.v20201111.CreateBatchQuickSignUrl", async function () { try { - const data = await client.CreateUserAutoSignSealUrl({}) + const data = await client.CreateBatchQuickSignUrl({}) expect(data).to.be.ok } catch(error) { expect(error.requestId).to.be.ok @@ -98,6 +98,16 @@ it("ess.v20201111.DescribeFileUrls", async function () { } }) +it("ess.v20201111.CreateUserAutoSignSealUrl", async function () { + try { + const data = await client.CreateUserAutoSignSealUrl({}) + expect(data).to.be.ok + } catch(error) { + expect(error.requestId).to.be.ok + expect(error.code).to.be.ok + } +}) + it("ess.v20201111.CreateUserAutoSignEnableUrl", async function () { try { const data = await client.CreateUserAutoSignEnableUrl({}) diff --git a/test/essbasic.v20210526.test.js b/test/essbasic.v20210526.test.js index 252cfd1f9..a6542fed9 100644 --- a/test/essbasic.v20210526.test.js +++ b/test/essbasic.v20210526.test.js @@ -38,6 +38,16 @@ it("essbasic.v20210526.ChannelCreateFlowSignReview", async function () { } }) +it("essbasic.v20210526.ModifyExtendedService", async function () { + try { + const data = await client.ModifyExtendedService({}) + expect(data).to.be.ok + } catch(error) { + expect(error.requestId).to.be.ok + expect(error.code).to.be.ok + } +}) + it("essbasic.v20210526.ChannelCreateMultiFlowSignQRCode", async function () { try { const data = await client.ChannelCreateMultiFlowSignQRCode({}) @@ -98,9 +108,9 @@ it("essbasic.v20210526.DescribeExtendedServiceAuthInfo", async function () { } }) -it("essbasic.v20210526.ModifyExtendedService", async function () { +it("essbasic.v20210526.ChannelDescribeRoles", async function () { try { - const data = await client.ModifyExtendedService({}) + const data = await client.ChannelDescribeRoles({}) expect(data).to.be.ok } catch(error) { expect(error.requestId).to.be.ok @@ -158,9 +168,9 @@ it("essbasic.v20210526.ChannelCreateSealPolicy", async function () { } }) -it("essbasic.v20210526.ChannelCreateRole", async function () { +it("essbasic.v20210526.ChannelCreateBatchQuickSignUrl", async function () { try { - const data = await client.ChannelCreateRole({}) + const data = await client.ChannelCreateBatchQuickSignUrl({}) expect(data).to.be.ok } catch(error) { expect(error.requestId).to.be.ok @@ -368,9 +378,9 @@ it("essbasic.v20210526.ChannelCreateWebThemeConfig", async function () { } }) -it("essbasic.v20210526.ChannelCreateFlowReminds", async function () { +it("essbasic.v20210526.ChannelCreateFlowSignUrl", async function () { try { - const data = await client.ChannelCreateFlowReminds({}) + const data = await client.ChannelCreateFlowSignUrl({}) expect(data).to.be.ok } catch(error) { expect(error.requestId).to.be.ok @@ -438,9 +448,9 @@ it("essbasic.v20210526.ChannelCreateFlowApprovers", async function () { } }) -it("essbasic.v20210526.ChannelDescribeRoles", async function () { +it("essbasic.v20210526.ChannelCreateRole", async function () { try { - const data = await client.ChannelDescribeRoles({}) + const data = await client.ChannelCreateRole({}) expect(data).to.be.ok } catch(error) { expect(error.requestId).to.be.ok @@ -488,9 +498,9 @@ it("essbasic.v20210526.UploadFiles", async function () { } }) -it("essbasic.v20210526.ChannelCreateFlowSignUrl", async function () { +it("essbasic.v20210526.ChannelCreateFlowReminds", async function () { try { - const data = await client.ChannelCreateFlowSignUrl({}) + const data = await client.ChannelCreateFlowReminds({}) expect(data).to.be.ok } catch(error) { expect(error.requestId).to.be.ok diff --git a/test/tdmq.v20200217.test.js b/test/tdmq.v20200217.test.js index 6fa23d25b..e29259f55 100644 --- a/test/tdmq.v20200217.test.js +++ b/test/tdmq.v20200217.test.js @@ -38,6 +38,16 @@ it("tdmq.v20200217.CreateCluster", async function () { } }) +it("tdmq.v20200217.DescribeRocketMQConsumeStats", async function () { + try { + const data = await client.DescribeRocketMQConsumeStats({}) + expect(data).to.be.ok + } catch(error) { + expect(error.requestId).to.be.ok + expect(error.code).to.be.ok + } +}) + it("tdmq.v20200217.DescribeRocketMQNamespaces", async function () { try { const data = await client.DescribeRocketMQNamespaces({}) @@ -708,6 +718,16 @@ it("tdmq.v20200217.DescribeRocketMQVipInstances", async function () { } }) +it("tdmq.v20200217.VerifyRocketMQConsume", async function () { + try { + const data = await client.VerifyRocketMQConsume({}) + expect(data).to.be.ok + } catch(error) { + expect(error.requestId).to.be.ok + expect(error.code).to.be.ok + } +}) + it("tdmq.v20200217.DescribeAMQPClusters", async function () { try { const data = await client.DescribeAMQPClusters({})