tencentcloud-sdk-nodejs 4.0.815 → 4.0.816

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +162 -0
  2. package/SERVICE_CHANGELOG.md +244 -17
  3. package/package.json +1 -1
  4. package/products.md +192 -192
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cfs/v20190719/cfs_models.ts +3 -4
  7. package/src/services/cls/v20201016/cls_models.ts +1 -1
  8. package/src/services/ess/v20201111/ess_client.ts +14 -1
  9. package/src/services/ess/v20201111/ess_models.ts +83 -18
  10. package/src/services/essbasic/v20210526/essbasic_client.ts +14 -1
  11. package/src/services/essbasic/v20210526/essbasic_models.ts +69 -7
  12. package/src/services/monitor/v20180724/monitor_client.ts +45 -8
  13. package/src/services/monitor/v20180724/monitor_models.ts +346 -228
  14. package/src/services/teo/v20220901/teo_models.ts +3 -2
  15. package/src/services/tke/v20180525/tke_models.ts +8 -3
  16. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  17. package/src/services/vpc/v20170312/vpc_models.ts +11 -11
  18. package/src/services/waf/v20180125/waf_client.ts +4 -4
  19. package/src/services/waf/v20180125/waf_models.ts +83 -30
  20. package/tencentcloud/common/sdk_version.d.ts +1 -1
  21. package/tencentcloud/common/sdk_version.js +1 -1
  22. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +3 -4
  23. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  24. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -1
  25. package/tencentcloud/services/ess/v20201111/ess_client.js +6 -0
  26. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +80 -18
  27. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -1
  28. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +6 -0
  29. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +66 -7
  30. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +13 -1
  31. package/tencentcloud/services/monitor/v20180724/monitor_client.js +18 -0
  32. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +338 -227
  33. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +3 -2
  34. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +8 -3
  35. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  36. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +11 -11
  37. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +4 -4
  38. package/tencentcloud/services/waf/v20180125/waf_client.js +4 -4
  39. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +83 -30
  40. package/test/ess.v20201111.test.js +10 -0
  41. package/test/essbasic.v20210526.test.js +10 -0
  42. package/test/monitor.v20180724.test.js +30 -0
@@ -461,7 +461,8 @@ export interface DescribeAliasDomainsRequest {
461
461
  Limit?: number
462
462
  /**
463
463
  * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:
464
- <li>target-name<br>   按照【<strong>目标域名名称</strong>】进行过滤。<br>   类型:String<br>   必选:否</li><li>alias-name<br>   按照【<strong>别称域名名称</strong>】进行过滤。<br>   类型:String<br>   必选:否</li>模糊查询时仅支持过滤字段名为alias-name。
464
+ <li>target-name:目标域名名称进行过滤;</li>
465
+ <li>alias-name:按照别称域名名称进行过滤。</li>模糊查询时仅支持过滤字段名为 alias-name。
465
466
  */
466
467
  Filters?: Array<AdvancedFilter>
467
468
  }
@@ -6973,7 +6974,7 @@ export interface DescribeHostsSettingRequest {
6973
6974
  Limit?: number
6974
6975
  /**
6975
6976
  * 过滤条件,Filters.Values的上限为20。详细的过滤条件如下:
6976
- <li>host<br>   按照【<strong>域名</strong>】进行过滤。<br>   类型:string<br>   必选:否</li>
6977
+ <li>host:按照域名进行过滤。</li>
6977
6978
  */
6978
6979
  Filters?: Array<Filter>
6979
6980
  }
@@ -1247,17 +1247,22 @@ export interface PodLimitsByType {
1247
1247
  * TKE共享网卡非固定IP模式可支持的Pod数量
1248
1248
  注意:此字段可能返回 null,表示取不到有效值。
1249
1249
  */
1250
- TKERouteENINonStaticIP: number
1250
+ TKERouteENINonStaticIP?: number
1251
1251
  /**
1252
1252
  * TKE共享网卡固定IP模式可支持的Pod数量
1253
1253
  注意:此字段可能返回 null,表示取不到有效值。
1254
1254
  */
1255
- TKERouteENIStaticIP: number
1255
+ TKERouteENIStaticIP?: number
1256
1256
  /**
1257
1257
  * TKE独立网卡模式可支持的Pod数量
1258
1258
  注意:此字段可能返回 null,表示取不到有效值。
1259
1259
  */
1260
- TKEDirectENI: number
1260
+ TKEDirectENI?: number
1261
+ /**
1262
+ * TKE中继网卡模式可支持的Pod数量
1263
+ 注意:此字段可能返回 null,表示取不到有效值。
1264
+ */
1265
+ TKESubENI?: number
1261
1266
  }
1262
1267
 
1263
1268
  /**
@@ -2124,7 +2124,7 @@ export interface TencentVod {
2124
2124
  */
2125
2125
  MediaType?: number
2126
2126
  /**
2127
- * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserId_u_分开。
2127
+ * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_分开。
2128
2128
  */
2129
2129
  UserDefineRecordId?: string
2130
2130
  }
@@ -3672,7 +3672,7 @@ export interface CreateTrafficPackagesResponse {
3672
3672
  /**
3673
3673
  * 创建的流量包ID列表。
3674
3674
  */
3675
- TrafficPackageSet: Array<string>
3675
+ TrafficPackageSet?: Array<string>
3676
3676
  /**
3677
3677
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3678
3678
  */
@@ -5213,45 +5213,45 @@ export interface TrafficPackage {
5213
5213
  /**
5214
5214
  * 流量包唯一ID
5215
5215
  */
5216
- TrafficPackageId: string
5216
+ TrafficPackageId?: string
5217
5217
  /**
5218
5218
  * 流量包名称
5219
5219
  注意:此字段可能返回 null,表示取不到有效值。
5220
5220
  */
5221
- TrafficPackageName: string
5221
+ TrafficPackageName?: string
5222
5222
  /**
5223
5223
  * 流量包总量,单位GB
5224
5224
  */
5225
- TotalAmount: number
5225
+ TotalAmount?: number
5226
5226
  /**
5227
5227
  * 流量包剩余量,单位GB
5228
5228
  */
5229
- RemainingAmount: number
5229
+ RemainingAmount?: number
5230
5230
  /**
5231
5231
  * 流量包状态,可能的值有: AVAILABLE-可用状态, EXPIRED-已过期, EXHAUSTED-已用完, REFUNDED-已退还, DELETED-已删除
5232
5232
  */
5233
- Status: string
5233
+ Status?: string
5234
5234
  /**
5235
5235
  * 流量包创建时间
5236
5236
  */
5237
- CreatedTime: string
5237
+ CreatedTime?: string
5238
5238
  /**
5239
5239
  * 流量包截止时间
5240
5240
  */
5241
- Deadline: string
5241
+ Deadline?: string
5242
5242
  /**
5243
5243
  * 已使用的流量,单位GB
5244
5244
  */
5245
- UsedAmount: number
5245
+ UsedAmount?: number
5246
5246
  /**
5247
5247
  * 流量包标签
5248
5248
  注意:此字段可能返回 null,表示取不到有效值。
5249
5249
  */
5250
- TagSet: Array<Tag>
5250
+ TagSet?: Array<Tag>
5251
5251
  /**
5252
5252
  * 区分闲时流量包与全时流量包
5253
5253
  */
5254
- DeductType: string
5254
+ DeductType?: string
5255
5255
  }
5256
5256
 
5257
5257
  /**
@@ -721,7 +721,7 @@ export class Client extends AbstractClient {
721
721
  }
722
722
 
723
723
  /**
724
- * Waf 斯巴达版本更新cc自动封堵状态
724
+ * 编辑SAAS型接入的紧急CC防护状态
725
725
  */
726
726
  async UpsertCCAutoStatus(
727
727
  req: UpsertCCAutoStatusRequest,
@@ -1062,7 +1062,7 @@ export class Client extends AbstractClient {
1062
1062
  }
1063
1063
 
1064
1064
  /**
1065
- * waf斯巴达-waf开关
1065
+ * 获取基础安全防护(WAF开关)状态
1066
1066
  */
1067
1067
  async ModifyProtectionStatus(
1068
1068
  req: ModifyProtectionStatusRequest,
@@ -1276,7 +1276,7 @@ export class Client extends AbstractClient {
1276
1276
  }
1277
1277
 
1278
1278
  /**
1279
- * Waf 多域名ip黑白名单查询
1279
+ * Waf 批量防护IP黑白名单查询
1280
1280
  */
1281
1281
  async DescribeBatchIpAccessControl(
1282
1282
  req: DescribeBatchIpAccessControlRequest,
@@ -1656,7 +1656,7 @@ export class Client extends AbstractClient {
1656
1656
  }
1657
1657
 
1658
1658
  /**
1659
- * Waf 斯巴达版本查询cc自动封堵状态
1659
+ * 获取SAAS型接入的紧急CC防护状态
1660
1660
  */
1661
1661
  async DescribeCCAutoStatus(
1662
1662
  req: DescribeCCAutoStatusRequest,
@@ -1955,7 +1955,11 @@ export interface ModifySpartaProtectionRequest {
1955
1955
  /**
1956
1956
  * 必填项。域名唯一ID
1957
1957
  */
1958
- DomainId?: string
1958
+ DomainId: string
1959
+ /**
1960
+ * 必填项。域名所属实例id
1961
+ */
1962
+ InstanceID: string
1959
1963
  /**
1960
1964
  * 必填项。证书类型。
1961
1965
  0:仅配置HTTP监听端口,没有证书
@@ -2050,10 +2054,6 @@ https:使用https协议回源
2050
2054
  1: 长连接
2051
2055
  */
2052
2056
  IsKeepAlive?: string
2053
- /**
2054
- * 必填项。域名所属实例id
2055
- */
2056
- InstanceID?: string
2057
2057
  /**
2058
2058
  * 必填项,待废弃。目前填0即可。anycast IP类型开关: 0 普通IP 1 Anycast IP
2059
2059
  */
@@ -2122,6 +2122,10 @@ https:使用https协议回源
2122
2122
  * 自定义回源Host。默认为空字符串,表示使用防护域名作为回源Host。
2123
2123
  */
2124
2124
  UpstreamHost?: string
2125
+ /**
2126
+ * 是否开启缓存 0-关闭 1-开启
2127
+ */
2128
+ ProxyBuffer?: number
2125
2129
  }
2126
2130
 
2127
2131
  /**
@@ -2641,7 +2645,7 @@ cdc-clb-waf:CDC环境下负载均衡型WAF实例
2641
2645
  "日本": "jp"
2642
2646
  "弗吉尼亚": "use"
2643
2647
  "北京": "bj"
2644
- "香港": "hk"
2648
+ "中国香港": "hk"
2645
2649
  "杭州": "hzec"
2646
2650
  "北京金融": "bjjr"
2647
2651
  "上海金融": "shjr"
@@ -2820,6 +2824,11 @@ public:公有云域名
2820
2824
  注意:此字段可能返回 null,表示取不到有效值。
2821
2825
  */
2822
2826
  SgID?: string
2827
+ /**
2828
+ * clbwaf接入状态
2829
+ 注意:此字段可能返回 null,表示取不到有效值。
2830
+ */
2831
+ AccessStatus?: number
2823
2832
  }
2824
2833
 
2825
2834
  /**
@@ -3792,7 +3801,7 @@ export interface DeleteIpAccessControlResponse {
3792
3801
  }
3793
3802
 
3794
3803
  /**
3795
- * 多域名黑白名单列表Ip
3804
+ * 批量多域名黑白名单列表Ip
3796
3805
  */
3797
3806
  export interface BatchIpAccessControlItem {
3798
3807
  /**
@@ -3828,6 +3837,16 @@ export interface BatchIpAccessControlItem {
3828
3837
  * 域名列表
3829
3838
  */
3830
3839
  Hosts?: Array<string>
3840
+ /**
3841
+ * 55101145
3842
+ 注意:此字段可能返回 null,表示取不到有效值。
3843
+ */
3844
+ RuleId?: number
3845
+ /**
3846
+ * IP列表
3847
+ 注意:此字段可能返回 null,表示取不到有效值。
3848
+ */
3849
+ IpList?: Array<string>
3831
3850
  }
3832
3851
 
3833
3852
  /**
@@ -4099,7 +4118,7 @@ export interface DescribeIpAccessControlRequest {
4099
4118
  */
4100
4119
  Sort?: string
4101
4120
  /**
4102
- * ip
4121
+ * IP
4103
4122
  */
4104
4123
  Ip?: string
4105
4124
  /**
@@ -4114,6 +4133,10 @@ export interface DescribeIpAccessControlRequest {
4114
4133
  * 最大有效时间的时间戳
4115
4134
  */
4116
4135
  ValidTimeStampMax?: string
4136
+ /**
4137
+ * 规则ID
4138
+ */
4139
+ RuleId?: number
4117
4140
  }
4118
4141
 
4119
4142
  /**
@@ -4819,6 +4842,11 @@ export interface DescribeIpAccessControlResponse {
4819
4842
  注意:此字段可能返回 null,表示取不到有效值。
4820
4843
  */
4821
4844
  Data?: IpAccessControlData
4845
+ /**
4846
+ * 已经使用的IP黑白名单的IP总数
4847
+ 注意:此字段可能返回 null,表示取不到有效值。
4848
+ */
4849
+ UsedTotal?: number
4822
4850
  /**
4823
4851
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4824
4852
  */
@@ -4930,6 +4958,16 @@ export interface IpAccessControlItem {
4930
4958
  注意:此字段可能返回 null,表示取不到有效值。
4931
4959
  */
4932
4960
  ValidStatus?: number
4961
+ /**
4962
+ * 55000001
4963
+ 注意:此字段可能返回 null,表示取不到有效值。
4964
+ */
4965
+ RuleId?: number
4966
+ /**
4967
+ * IP列表
4968
+ 注意:此字段可能返回 null,表示取不到有效值。
4969
+ */
4970
+ IpList?: Array<string>
4933
4971
  }
4934
4972
 
4935
4973
  /**
@@ -5555,6 +5593,11 @@ export interface DescribeAttackOverviewResponse {
5555
5593
  注意:此字段可能返回 null,表示取不到有效值。
5556
5594
  */
5557
5595
  LeakCount?: number
5596
+ /**
5597
+ * API风险事件周环比
5598
+ 注意:此字段可能返回 null,表示取不到有效值。
5599
+ */
5600
+ ApiRiskEventCircleCount?: number
5558
5601
  /**
5559
5602
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5560
5603
  */
@@ -6191,7 +6234,7 @@ export interface DescribeBatchIpAccessControlResponse {
6191
6234
  * 输出
6192
6235
  注意:此字段可能返回 null,表示取不到有效值。
6193
6236
  */
6194
- Data: BatchIpAccessControlData
6237
+ Data?: BatchIpAccessControlData
6195
6238
  /**
6196
6239
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6197
6240
  */
@@ -7937,6 +7980,11 @@ https:使用https协议回源
7937
7980
  注意:此字段可能返回 null,表示取不到有效值。
7938
7981
  */
7939
7982
  Level?: string
7983
+ /**
7984
+ * 是否开启缓存 0-关闭 1-开启
7985
+ 注意:此字段可能返回 null,表示取不到有效值。
7986
+ */
7987
+ ProxyBuffer?: number
7940
7988
  }
7941
7989
 
7942
7990
  /**
@@ -8035,6 +8083,25 @@ export interface AddSpartaProtectionRequest {
8035
8083
  2:加权轮询
8036
8084
  */
8037
8085
  LoadBalance: string
8086
+ /**
8087
+ * 服务端口列表配置。
8088
+ NginxServerId:新增域名时填'0'
8089
+ Port:监听端口号
8090
+ Protocol:端口协议
8091
+ UpstreamPort:与Port相同
8092
+ UpstreamProtocol:与Protocol相同
8093
+ */
8094
+ Ports: Array<PortItem>
8095
+ /**
8096
+ * 必填项,是否开启长连接。
8097
+ 0: 短连接
8098
+ 1: 长连接
8099
+ */
8100
+ IsKeepAlive: string
8101
+ /**
8102
+ * 必填项,域名所属实例id
8103
+ */
8104
+ InstanceID: string
8038
8105
  /**
8039
8106
  * CertType为1时,需要填充此参数,表示自有证书的证书链
8040
8107
  */
@@ -8093,15 +8160,6 @@ https:使用https协议回源
8093
8160
  1:开启
8094
8161
  */
8095
8162
  IsHttp2?: number
8096
- /**
8097
- * 服务端口列表配置。
8098
- NginxServerId:新增域名时填'0'
8099
- Port:监听端口号
8100
- Protocol:端口协议
8101
- UpstreamPort:与Port相同
8102
- UpstreamProtocol:与Protocol相同
8103
- */
8104
- Ports?: Array<PortItem>
8105
8163
  /**
8106
8164
  * 待废弃,可不填。WAF实例类型。
8107
8165
  sparta-waf:SAAS型WAF
@@ -8109,16 +8167,6 @@ clb-waf:负载均衡型WAF
8109
8167
  cdn-waf:CDN上的Web防护能力
8110
8168
  */
8111
8169
  Edition?: string
8112
- /**
8113
- * 必填项,是否开启长连接。
8114
- 0: 短连接
8115
- 1: 长连接
8116
- */
8117
- IsKeepAlive?: string
8118
- /**
8119
- * 必填项,域名所属实例id
8120
- */
8121
- InstanceID?: string
8122
8170
  /**
8123
8171
  * 待废弃,目前填0即可。anycast IP类型开关: 0 普通IP 1 Anycast IP
8124
8172
  */
@@ -8183,6 +8231,10 @@ cdn-waf:CDN上的Web防护能力
8183
8231
  * 自定义回源Host。默认为空字符串,表示使用防护域名作为回源Host。
8184
8232
  */
8185
8233
  UpstreamHost?: string
8234
+ /**
8235
+ * 是否开启缓存 0-关闭 1-开启
8236
+ */
8237
+ ProxyBuffer?: number
8186
8238
  }
8187
8239
 
8188
8240
  /**
@@ -8222,7 +8274,7 @@ export interface AttackLogInfo {
8222
8274
  */
8223
8275
  export interface DescribeCCAutoStatusResponse {
8224
8276
  /**
8225
- * 配置状态
8277
+ * 配置状态,0表示关闭,1表示开启
8226
8278
  */
8227
8279
  AutoCCSwitch?: number
8228
8280
  /**
@@ -8443,8 +8495,9 @@ export interface ModifyAccessPeriodRequest {
8443
8495
  Period: number
8444
8496
  /**
8445
8497
  * 日志主题,新版本不需要再传
8498
+ * @deprecated
8446
8499
  */
8447
- TopicId: string
8500
+ TopicId?: string
8448
8501
  }
8449
8502
 
8450
8503
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.815";
1
+ export declare const sdkVersion = "4.0.816";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.815";
4
+ exports.sdkVersion = "4.0.816";
@@ -1395,17 +1395,16 @@ export interface DescribeCfsFileSystemClientsRequest {
1395
1395
  }
1396
1396
  /**
1397
1397
  * 版本控制-协议详情
1398
-
1399
1398
  */
1400
1399
  export interface AvailableProtoStatus {
1401
1400
  /**
1402
1401
  * 售卖状态。可选值有 sale_out 售罄、saling可售、no_saling不可销售
1403
1402
  */
1404
- SaleStatus: string;
1403
+ SaleStatus?: string;
1405
1404
  /**
1406
- * 协议类型。可选值有 NFS、CIFS
1405
+ * 协议类型。可选值有 NFS、CIFS、TURBO
1407
1406
  */
1408
- Protocol: string;
1407
+ Protocol?: string;
1409
1408
  }
1410
1409
  /**
1411
1410
  * DescribeCfsFileSystems请求参数结构体
@@ -427,7 +427,7 @@ export interface SearchCosRechargeInfoRequest {
427
427
  */
428
428
  export interface KafkaRechargeInfo {
429
429
  /**
430
- * 主键ID
430
+ * Kafka数据订阅配置的ID
431
431
  注意:此字段可能返回 null,表示取不到有效值。
432
432
  */
433
433
  Id?: string;
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribePersonCertificateResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, ModifyExtendedServiceRequest, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowGroupSignReviewResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DescribeSignFaceVideoRequest, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ModifyFlowDeadlineResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, RenewAutoSignLicenseRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, ModifyExtendedServiceResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, DescribeSignFaceVideoResponse, VerifyPdfResponse, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, ModifyIntegrationRoleResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, RenewAutoSignLicenseResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { DescribePersonCertificateResponse, DescribeCancelFlowsTaskResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, ModifyExtendedServiceRequest, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowGroupSignReviewResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DescribeSignFaceVideoRequest, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ModifyFlowDeadlineResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, RenewAutoSignLicenseRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, CreateEmbedWebUrlResponse, ModifyExtendedServiceResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, DescribeSignFaceVideoResponse, VerifyPdfResponse, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, ModifyIntegrationRoleResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, RenewAutoSignLicenseResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -380,6 +380,10 @@ export declare class Client extends AbstractClient {
380
380
  2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模板创建发起合同</a><br>
381
381
  */
382
382
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
383
+ /**
384
+ * 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
385
+ */
386
+ DescribeCancelFlowsTask(req: DescribeCancelFlowsTaskRequest, cb?: (error: string, rep: DescribeCancelFlowsTaskResponse) => void): Promise<DescribeCancelFlowsTaskResponse>;
383
387
  /**
384
388
  * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
385
389
  解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
@@ -458,6 +458,12 @@ class Client extends abstract_client_1.AbstractClient {
458
458
  async CreateFlow(req, cb) {
459
459
  return this.request("CreateFlow", req, cb);
460
460
  }
461
+ /**
462
+ * 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
463
+ */
464
+ async DescribeCancelFlowsTask(req, cb) {
465
+ return this.request("DescribeCancelFlowsTask", req, cb);
466
+ }
461
467
  /**
462
468
  * 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
463
469
  解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
@@ -96,6 +96,34 @@ export interface BillUsageDetail {
96
96
  */
97
97
  Remark?: string;
98
98
  }
99
+ /**
100
+ * DescribeCancelFlowsTask返回参数结构体
101
+ */
102
+ export interface DescribeCancelFlowsTaskResponse {
103
+ /**
104
+ * 批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
105
+ */
106
+ TaskId?: string;
107
+ /**
108
+ * 任务状态,需要关注的状态
109
+ <ul><li>**PROCESSING** - 任务执行中</li>
110
+ <li>**END** - 任务处理完成</li>
111
+ <li>**TIMEOUT** 任务超时未处理完成,用户未在批量撤销链接有效期内操作</li></ul>
112
+ */
113
+ TaskStatus?: string;
114
+ /**
115
+ * 批量撤销成功的签署流程编号
116
+ */
117
+ SuccessFlowIds?: Array<string>;
118
+ /**
119
+ * 批量撤销失败的签署流程信息
120
+ */
121
+ FailureFlows?: Array<CancelFailureFlow>;
122
+ /**
123
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
124
+ */
125
+ RequestId?: string;
126
+ }
99
127
  /**
100
128
  * 意愿核身点头确认模式结果
101
129
  */
@@ -795,10 +823,9 @@ export interface CreateIntegrationEmployeesRequest {
795
823
  */
796
824
  Agent?: Agent;
797
825
  /**
798
- * 员工邀请方式可通过以下方式进行设置:
799
-
800
- **H5**:会生成H5的链接,点击链接进入H5的认证加入企业的逻辑。
801
- **SMS(默认)**:会通过短信或企业微信消息进行邀请。如果非企业微信场景,则是企业微信消息。其他场景则是短信通知,短信中包含链接,点击后进入微信小程序进行认证加入企业的逻辑。
826
+ * 员工邀请方式
827
+ 可通过以下途径进行设置:
828
+ <ul><li>**SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。</li></ul>
802
829
  */
803
830
  InvitationNotifyType?: string;
804
831
  /**
@@ -808,6 +835,10 @@ export interface CreateIntegrationEmployeesRequest {
808
835
 
809
836
  */
810
837
  JumpUrl?: string;
838
+ /**
839
+ * 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月</li></ul>注意:InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型(InvitationNotifyType)</td><td>Endpoint</td></tr><tr><td>SMS(默认)</td><td>不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递,会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL</td></tr></tbody></table>
840
+ */
841
+ Endpoint?: string;
811
842
  }
812
843
  /**
813
844
  * 创建合同个性化参数
@@ -1584,16 +1615,17 @@ export interface CreateFlowGroupByTemplatesResponse {
1584
1615
  RequestId?: string;
1585
1616
  }
1586
1617
  /**
1587
- * 视频认证结果
1618
+ * 撤销失败的流程信息
1588
1619
  */
1589
- export interface DetectInfoVideoData {
1620
+ export interface CancelFailureFlow {
1590
1621
  /**
1591
- * 活体视频的base64编码,mp4格式
1592
-
1593
- 注:`需进行base64解码获取活体视频文件`
1594
- 注意:此字段可能返回 null,表示取不到有效值。
1622
+ * 合同流程ID,为32位字符串。
1595
1623
  */
1596
- LiveNessVideo?: string;
1624
+ FlowId?: string;
1625
+ /**
1626
+ * 撤销失败原因
1627
+ */
1628
+ Reason?: string;
1597
1629
  }
1598
1630
  /**
1599
1631
  * 此结构体 (TemplateInfo) 用于描述模板的信息。
@@ -4252,6 +4284,18 @@ export interface CreateIntegrationRoleResponse {
4252
4284
  */
4253
4285
  RequestId?: string;
4254
4286
  }
4287
+ /**
4288
+ * 视频认证结果
4289
+ */
4290
+ export interface DetectInfoVideoData {
4291
+ /**
4292
+ * 活体视频的base64编码,mp4格式
4293
+
4294
+ 注:`需进行base64解码获取活体视频文件`
4295
+ 注意:此字段可能返回 null,表示取不到有效值。
4296
+ */
4297
+ LiveNessVideo?: string;
4298
+ }
4255
4299
  /**
4256
4300
  * DescribeFlowComponents请求参数结构体
4257
4301
  */
@@ -6127,6 +6171,25 @@ export interface ApproverOption {
6127
6171
  */
6128
6172
  FlowReadLimit?: string;
6129
6173
  }
6174
+ /**
6175
+ * DescribeCancelFlowsTask请求参数结构体
6176
+ */
6177
+ export interface DescribeCancelFlowsTaskRequest {
6178
+ /**
6179
+ * 执行本接口操作的员工信息。
6180
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
6181
+ */
6182
+ Operator: UserInfo;
6183
+ /**
6184
+ * 批量撤销任务编号,为32位字符串,通过接口[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)获得。
6185
+ */
6186
+ TaskId: string;
6187
+ /**
6188
+ * 代理企业和员工的信息。
6189
+ <br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6190
+ */
6191
+ Agent?: Agent;
6192
+ }
6130
6193
  /**
6131
6194
  * CreateEmbedWebUrl返回参数结构体
6132
6195
  */
@@ -6796,18 +6859,17 @@ export interface UpdateIntegrationEmployeesRequest {
6796
6859
  */
6797
6860
  Agent?: Agent;
6798
6861
  /**
6799
- * 员工邀请方式可通过以下方式进行设置:
6800
-
6801
- **H5**:会生成H5的链接,点击链接进入H5的认证加入企业的逻辑。
6802
- **SMS(默认)**:会通过短信或企业微信消息进行邀请。如果非企业微信场景,则是企业微信消息。其他场景则是短信通知,短信中包含链接,点击后进入微信小程序进行认证加入企业的逻辑。
6862
+ * 员工邀请方式可通过以下途径进行设置:<ul><li>**SMS(默认)**:邀请将通过短信或企业微信消息发送。若场景非企业微信,则采用企业微信消息;其他情境下则使用短信通知。短信内含链接,点击后将进入微信小程序进行认证并加入企业的流程。</li><li>**H5**:将生成H5链接,用户点击链接后可进入H5页面进行认证并加入企业的流程。</li><li>**NONE**:系统会根据Endpoint生成签署链接,业务方需获取链接并通知客户。</li></ul>
6803
6863
  */
6804
6864
  InvitationNotifyType?: string;
6805
6865
  /**
6806
- * 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。
6807
-
6808
- 注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
6866
+ * 回跳地址,为认证成功后页面进行回跳的URL,请确保回跳地址的可用性。注:`只有在员工邀请方式(InvitationNotifyType参数)为H5场景下才生效, 其他方式下设置无效。`
6809
6867
  */
6810
6868
  JumpUrl?: string;
6869
+ /**
6870
+ * 要跳转的链接类型<ul><li> **HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)</li><li>**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链</li><li>**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li><li>**H5**: 第三方移动端浏览器进行嵌入,不支持小程序嵌入,过期时间一个月</li></ul>注意:InvitationNotifyType 和 Endpoint 的关系图<table><tbody><tr><td>通知类型(InvitationNotifyType)</td><td>Endpoint</td></tr><tr><td>SMS(默认)</td><td>不需要传递,会将 Endpoint 默认设置为HTTP_SHORT_URL</td></tr><tr><td>H5</td><td>不需要传递,会将 Endpoint 默认设置为 H5</td></tr><tr><td>NONE</td><td>所有 Endpoint 都支持(HTTP_URL/HTTP_SHORT_URL/H5/APP)默认为HTTP_SHORT_URL</td></tr></tbody></table>
6871
+ */
6872
+ Endpoint?: string;
6811
6873
  }
6812
6874
  /**
6813
6875
  * DescribeFlowBriefs请求参数结构体