tencentcloud-sdk-nodejs 4.0.990 → 4.0.992

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 (34) hide show
  1. package/CHANGELOG.md +117 -0
  2. package/SERVICE_CHANGELOG.md +108 -25
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/clb/v20180317/clb_models.ts +1 -1
  7. package/src/services/ess/v20201111/ess_models.ts +4 -2
  8. package/src/services/essbasic/v20210526/essbasic_models.ts +32 -7
  9. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +8 -4
  10. package/src/services/lighthouse/v20200324/lighthouse_models.ts +31 -27
  11. package/src/services/lke/v20231130/lke_models.ts +2 -2
  12. package/src/services/memcached/v20190318/memcached_models.ts +0 -3
  13. package/src/services/monitor/v20180724/monitor_client.ts +24 -12
  14. package/src/services/monitor/v20180724/monitor_models.ts +97 -0
  15. package/src/services/mqtt/v20240516/mqtt_models.ts +17 -14
  16. package/src/services/vpc/v20170312/vpc_models.ts +13 -1
  17. package/src/services/wedata/v20210820/wedata_models.ts +5 -0
  18. package/tencentcloud/common/sdk_version.d.ts +1 -1
  19. package/tencentcloud/common/sdk_version.js +1 -1
  20. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +1 -1
  21. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +4 -2
  22. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +32 -7
  23. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +6 -2
  24. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +6 -2
  25. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +31 -27
  26. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +2 -2
  27. package/tencentcloud/services/memcached/v20190318/memcached_models.d.ts +0 -3
  28. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +9 -5
  29. package/tencentcloud/services/monitor/v20180724/monitor_client.js +12 -6
  30. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +95 -0
  31. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +17 -14
  32. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +13 -1
  33. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +5 -0
  34. package/test/monitor.v20180724.test.js +14 -4
@@ -631,15 +631,15 @@ export interface ResetInstanceBlueprint {
631
631
  /**
632
632
  * 镜像详细信息
633
633
  */
634
- BlueprintInfo: Blueprint
634
+ BlueprintInfo?: Blueprint
635
635
  /**
636
636
  * 实例镜像是否可重置为目标镜像
637
637
  */
638
- IsResettable: boolean
638
+ IsResettable?: boolean
639
639
  /**
640
640
  * 不可重置信息.当镜像可重置时为""
641
641
  */
642
- NonResettableMessage: string
642
+ NonResettableMessage?: string
643
643
  }
644
644
 
645
645
  /**
@@ -1605,6 +1605,9 @@ export interface FirewallTemplateApplyRecordDetail {
1605
1605
  Instance?: InstanceIdentifier
1606
1606
  /**
1607
1607
  * 防火墙模板应用状态。
1608
+
1609
+ - SUCCESS:成功
1610
+ - FAILED:失败
1608
1611
  */
1609
1612
  ApplyState?: string
1610
1613
  /**
@@ -1727,19 +1730,19 @@ export interface InstanceReturnable {
1727
1730
  /**
1728
1731
  * 实例 ID。
1729
1732
  */
1730
- InstanceId: string
1733
+ InstanceId?: string
1731
1734
  /**
1732
1735
  * 实例是否可退还。
1733
1736
  */
1734
- IsReturnable: boolean
1737
+ IsReturnable?: boolean
1735
1738
  /**
1736
1739
  * 实例退还失败错误码。
1737
1740
  */
1738
- ReturnFailCode: number
1741
+ ReturnFailCode?: number
1739
1742
  /**
1740
1743
  * 实例退还失败错误信息。
1741
1744
  */
1742
- ReturnFailMessage: string
1745
+ ReturnFailMessage?: string
1743
1746
  }
1744
1747
 
1745
1748
  /**
@@ -2180,15 +2183,15 @@ export interface SceneInfo {
2180
2183
  /**
2181
2184
  * 使用场景Id。
2182
2185
  */
2183
- SceneId: string
2186
+ SceneId?: string
2184
2187
  /**
2185
2188
  * 使用场景展示名称。
2186
2189
  */
2187
- DisplayName: string
2190
+ DisplayName?: string
2188
2191
  /**
2189
2192
  * 使用场景描述信息。
2190
2193
  */
2191
- Description: string
2194
+ Description?: string
2192
2195
  }
2193
2196
 
2194
2197
  /**
@@ -2805,7 +2808,7 @@ export interface CreateKeyPairResponse {
2805
2808
  /**
2806
2809
  * 密钥对信息。
2807
2810
  */
2808
- KeyPair: KeyPair
2811
+ KeyPair?: KeyPair
2809
2812
  /**
2810
2813
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2811
2814
  */
@@ -3834,23 +3837,23 @@ export interface Software {
3834
3837
  /**
3835
3838
  * 软件名称。
3836
3839
  */
3837
- Name: string
3840
+ Name?: string
3838
3841
  /**
3839
3842
  * 软件版本。
3840
3843
  */
3841
- Version: string
3844
+ Version?: string
3842
3845
  /**
3843
3846
  * 软件图片 URL。
3844
3847
  */
3845
- ImageUrl: string
3848
+ ImageUrl?: string
3846
3849
  /**
3847
3850
  * 软件安装目录。
3848
3851
  */
3849
- InstallDir: string
3852
+ InstallDir?: string
3850
3853
  /**
3851
3854
  * 软件详情列表。
3852
3855
  */
3853
- DetailSet: Array<SoftwareDetail>
3856
+ DetailSet?: Array<SoftwareDetail>
3854
3857
  }
3855
3858
 
3856
3859
  /**
@@ -4650,6 +4653,9 @@ export interface FirewallTemplateApplyRecord {
4650
4653
  TemplateRuleSet?: Array<FirewallTemplateRule>
4651
4654
  /**
4652
4655
  * 应用模板的执行状态。
4656
+
4657
+ - SUCCESS:成功
4658
+ - FAILED:失败
4653
4659
  */
4654
4660
  ApplyState?: string
4655
4661
  /**
@@ -4786,22 +4792,20 @@ export interface ModifyInstancesBundleResponse {
4786
4792
 
4787
4793
  /**
4788
4794
  * 描述通用资源配额信息。
4789
-
4790
-
4791
4795
  */
4792
4796
  export interface GeneralResourceQuota {
4793
4797
  /**
4794
4798
  * 资源名称。
4795
4799
  */
4796
- ResourceName: string
4800
+ ResourceName?: string
4797
4801
  /**
4798
4802
  * 资源当前可用数量。
4799
4803
  */
4800
- ResourceQuotaAvailable: number
4804
+ ResourceQuotaAvailable?: number
4801
4805
  /**
4802
4806
  * 资源总数量。
4803
4807
  */
4804
- ResourceQuotaTotal: number
4808
+ ResourceQuotaTotal?: number
4805
4809
  }
4806
4810
 
4807
4811
  /**
@@ -5164,15 +5168,15 @@ export interface Scene {
5164
5168
  /**
5165
5169
  * 使用场景Id
5166
5170
  */
5167
- SceneId: string
5171
+ SceneId?: string
5168
5172
  /**
5169
5173
  * 使用场景展示名称
5170
5174
  */
5171
- DisplayName: string
5175
+ DisplayName?: string
5172
5176
  /**
5173
5177
  * 使用场景描述
5174
5178
  */
5175
- Description: string
5179
+ Description?: string
5176
5180
  }
5177
5181
 
5178
5182
  /**
@@ -5293,15 +5297,15 @@ export interface BlueprintInstance {
5293
5297
  /**
5294
5298
  * 镜像信息。
5295
5299
  */
5296
- Blueprint: Blueprint
5300
+ Blueprint?: Blueprint
5297
5301
  /**
5298
5302
  * 软件列表。
5299
5303
  */
5300
- SoftwareSet: Array<Software>
5304
+ SoftwareSet?: Array<Software>
5301
5305
  /**
5302
5306
  * 实例 ID。
5303
5307
  */
5304
- InstanceId: string
5308
+ InstanceId?: string
5305
5309
  }
5306
5310
 
5307
5311
  /**
@@ -5928,11 +5928,11 @@ export interface DescribeTokenUsageRequest {
5928
5928
  */
5929
5929
  ModelName?: string
5930
5930
  /**
5931
- * 开始时间戳, 单位为秒
5931
+ * 开始时间戳, 单位为秒(默认值0)
5932
5932
  */
5933
5933
  StartTime?: string
5934
5934
  /**
5935
- * 结束时间戳, 单位为秒
5935
+ * 结束时间戳, 单位为秒(默认值0, 必须大于开始时间戳)
5936
5936
  */
5937
5937
  EndTime?: string
5938
5938
  /**
@@ -71,12 +71,10 @@ export interface DescribeInstancesRequest {
71
71
  export interface TagInfo {
72
72
  /**
73
73
  * 标签键
74
- 注意:此字段可能返回 null,表示取不到有效值。
75
74
  */
76
75
  TagKey: string
77
76
  /**
78
77
  * 标签值
79
- 注意:此字段可能返回 null,表示取不到有效值。
80
78
  */
81
79
  TagValue?: string
82
80
  }
@@ -129,7 +127,6 @@ export interface InstanceListInfo {
129
127
  CmemId?: number
130
128
  /**
131
129
  * 实例关联的标签信息
132
- 注意:此字段可能返回 null,表示取不到有效值。
133
130
  */
134
131
  Tags?: Array<TagInfo>
135
132
  /**
@@ -57,6 +57,7 @@ import {
57
57
  DescribePolicyConditionListResponse,
58
58
  PrometheusRuleSet,
59
59
  DescribeAllNamespacesResponse,
60
+ CreateAlarmShieldRequest,
60
61
  TerminatePrometheusInstancesRequest,
61
62
  InstallPluginsResponse,
62
63
  ProductSimple,
@@ -263,6 +264,7 @@ import {
263
264
  ModifyPrometheusConfigRequest,
264
265
  DescribeMonitorResourceInfoRequest,
265
266
  DescribeGrafanaEnvironmentsResponse,
267
+ CreateAlarmShieldResponse,
266
268
  DescribePolicyConditionListRequest,
267
269
  DeletePolicyGroupResponse,
268
270
  DeleteGrafanaInstanceRequest,
@@ -907,6 +909,16 @@ export class Client extends AbstractClient {
907
909
  return this.request("BindingPolicyTag", req, cb)
908
910
  }
909
911
 
912
+ /**
913
+ * 创建告警屏蔽规则
914
+ */
915
+ async CreateAlarmShield(
916
+ req: CreateAlarmShieldRequest,
917
+ cb?: (error: string, rep: CreateAlarmShieldResponse) => void
918
+ ): Promise<CreateAlarmShieldResponse> {
919
+ return this.request("CreateAlarmShield", req, cb)
920
+ }
921
+
910
922
  /**
911
923
  * 创建按量 Prometheus 实例,根据用量收费实例
912
924
  */
@@ -1670,13 +1682,13 @@ export class Client extends AbstractClient {
1670
1682
  }
1671
1683
 
1672
1684
  /**
1673
- * 列出 Prometheus CVM Agent
1685
+ * 获取基础策略告警组列表
1674
1686
  */
1675
- async DescribePrometheusAgents(
1676
- req: DescribePrometheusAgentsRequest,
1677
- cb?: (error: string, rep: DescribePrometheusAgentsResponse) => void
1678
- ): Promise<DescribePrometheusAgentsResponse> {
1679
- return this.request("DescribePrometheusAgents", req, cb)
1687
+ async DescribePolicyGroupList(
1688
+ req: DescribePolicyGroupListRequest,
1689
+ cb?: (error: string, rep: DescribePolicyGroupListResponse) => void
1690
+ ): Promise<DescribePolicyGroupListResponse> {
1691
+ return this.request("DescribePolicyGroupList", req, cb)
1680
1692
  }
1681
1693
 
1682
1694
  /**
@@ -1760,13 +1772,13 @@ export class Client extends AbstractClient {
1760
1772
  }
1761
1773
 
1762
1774
  /**
1763
- * 获取基础策略告警组列表
1775
+ * 列出 Prometheus CVM Agent
1764
1776
  */
1765
- async DescribePolicyGroupList(
1766
- req: DescribePolicyGroupListRequest,
1767
- cb?: (error: string, rep: DescribePolicyGroupListResponse) => void
1768
- ): Promise<DescribePolicyGroupListResponse> {
1769
- return this.request("DescribePolicyGroupList", req, cb)
1777
+ async DescribePrometheusAgents(
1778
+ req: DescribePrometheusAgentsRequest,
1779
+ cb?: (error: string, rep: DescribePrometheusAgentsResponse) => void
1780
+ ): Promise<DescribePrometheusAgentsResponse> {
1781
+ return this.request("DescribePrometheusAgents", req, cb)
1770
1782
  }
1771
1783
 
1772
1784
  /**
@@ -1076,6 +1076,89 @@ export interface DescribeAllNamespacesResponse {
1076
1076
  RequestId?: string
1077
1077
  }
1078
1078
 
1079
+ /**
1080
+ * CreateAlarmShield请求参数结构体
1081
+ */
1082
+ export interface CreateAlarmShieldRequest {
1083
+ /**
1084
+ * 模块名,这里填“monitor”
1085
+ */
1086
+ Module: string
1087
+ /**
1088
+ * 屏蔽策略名称
1089
+ */
1090
+ Name: string
1091
+ /**
1092
+ * 监控类型
1093
+ */
1094
+ MonitorType: string
1095
+ /**
1096
+ * 命名空间即策略类型
1097
+ */
1098
+ NameSpace: string
1099
+ /**
1100
+ * 屏蔽时间类型 FOREVER_SHIELD:永久屏蔽 PERIOD_SHIELD:绝对时间范围屏蔽 LOOP_SHIELD:相对时间范围屏蔽
1101
+ */
1102
+ ShieldTimeType: string
1103
+ /**
1104
+ * 屏蔽对象
1105
+ */
1106
+ ShieldObject?: Array<string>
1107
+ /**
1108
+ * 屏蔽指标 为空则为全部指标
1109
+ */
1110
+ ShieldMetric?: Array<string>
1111
+ /**
1112
+ * 开始时间 相对时间范围:36000 绝对时间范围:1648742400 缺省:0
1113
+ */
1114
+ StartTime?: number
1115
+ /**
1116
+ * 结束时间 相对时间范围:72000 绝对时间范围:1649088000 缺省:0
1117
+ */
1118
+ EndTime?: number
1119
+ /**
1120
+ * 循环开始日期 2022/04/01 缺省:0
1121
+ */
1122
+ LoopStartDate?: number
1123
+ /**
1124
+ * 循环结束日期 2022/04/05 缺省:0
1125
+ */
1126
+ LoopEndDate?: number
1127
+ /**
1128
+ * 需要屏蔽的策略ID
1129
+ */
1130
+ ShieldPolicyId?: string
1131
+ /**
1132
+ * 需要屏蔽的告警等级,取值范围Warn,Remind,Serious
1133
+ */
1134
+ ShieldAlarmLevel?: Array<string>
1135
+ /**
1136
+ * 屏蔽类型,为OBJNAME是老版本实例名屏蔽,为POLICY是新版本维度匹配
1137
+ */
1138
+ VersionTag?: string
1139
+ /**
1140
+ * 屏蔽规则的描述
1141
+ */
1142
+ Description?: string
1143
+ /**
1144
+ * 时区,东八区+8,西八区减8,以此类推
1145
+
1146
+ */
1147
+ TimeZone?: number
1148
+ /**
1149
+ * 屏蔽事件 为空则为全部指标
1150
+ */
1151
+ ShieldEvent?: Array<string>
1152
+ /**
1153
+ * 是否对指标屏蔽 1=是 0=否
1154
+ */
1155
+ ShieldMetricFlag?: number
1156
+ /**
1157
+ * 是否对事件屏蔽 1=是 0=否
1158
+ */
1159
+ ShieldEventFlag?: number
1160
+ }
1161
+
1079
1162
  /**
1080
1163
  * TerminatePrometheusInstances请求参数结构体
1081
1164
  */
@@ -5901,6 +5984,20 @@ export interface DescribeGrafanaEnvironmentsResponse {
5901
5984
  RequestId?: string
5902
5985
  }
5903
5986
 
5987
+ /**
5988
+ * CreateAlarmShield返回参数结构体
5989
+ */
5990
+ export interface CreateAlarmShieldResponse {
5991
+ /**
5992
+ * 屏蔽规则的Id
5993
+ */
5994
+ ShieldId?: string
5995
+ /**
5996
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5997
+ */
5998
+ RequestId?: string
5999
+ }
6000
+
5904
6001
  /**
5905
6002
  * DescribePolicyConditionList请求参数结构体
5906
6003
  */
@@ -397,11 +397,9 @@ export interface ActivateDeviceCertificateRequest {
397
397
  */
398
398
  export interface DescribeInstanceResponse {
399
399
  /**
400
- * 实例类型,
401
- EXPERIMENT 体验版
400
+ * 实例类型
402
401
  BASIC 基础版
403
402
  PRO 专业版
404
- PLATINUM 铂金版
405
403
  */
406
404
  InstanceType?: string
407
405
  /**
@@ -453,7 +451,9 @@ PLATINUM 铂金版
453
451
  */
454
452
  ClientNumLimit?: number
455
453
  /**
456
- * 客户端证书注册方式:JITP,API
454
+ * 客户端证书注册方式:
455
+ JITP:自动注册
456
+ API:通过API手动注册
457
457
  */
458
458
  DeviceCertificateProvisionType?: string
459
459
  /**
@@ -477,9 +477,7 @@ PLATINUM 铂金版
477
477
  */
478
478
  DestroyTime?: number
479
479
  /**
480
- * TLS,单向认证
481
- mTLS,双向认证
482
- BYOC;一机一证
480
+ * TLS,单向认证 mTLS,双向认证 BYOC;一机一证
483
481
  */
484
482
  X509Mode?: string
485
483
  /**
@@ -611,19 +609,19 @@ export interface DescribeDeviceCertificateResponse {
611
609
  */
612
610
  Status?: string
613
611
  /**
614
- * 证书序列号
612
+ * Ca证书序列号
615
613
  */
616
614
  CaSn?: string
617
615
  /**
618
- * 设备证书sn
616
+ * 设备证书序列号
619
617
  */
620
618
  DeviceCertificateSn?: string
621
619
  /**
622
- * 证书内容
620
+ * 设备证书内容
623
621
  */
624
622
  DeviceCertificate?: string
625
623
  /**
626
- * 设备证书cn
624
+ * 设备证书common name
627
625
  */
628
626
  DeviceCertificateCn?: string
629
627
  /**
@@ -777,7 +775,9 @@ export interface CreateJWKSAuthenticatorRequest {
777
775
  */
778
776
  Remark?: string
779
777
  /**
780
- * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
778
+ * 设备连接时传递jwt的key;
779
+ username-使用用户名字段传递;
780
+ password-使用密码字段传递
781
781
  */
782
782
  From?: string
783
783
  }
@@ -866,7 +866,10 @@ export interface DeleteAuthenticatorRequest {
866
866
  */
867
867
  InstanceId: string
868
868
  /**
869
- * 认证器类型
869
+ * 认证器类型:
870
+ JWT:JWT认证器
871
+ JWKS:JWKS认证器
872
+ BYOC:一端一证认证器
870
873
  */
871
874
  Type: string
872
875
  }
@@ -1074,7 +1077,7 @@ export interface DescribeAuthenticatorRequest {
1074
1077
  */
1075
1078
  InstanceId: string
1076
1079
  /**
1077
- * 认证器类型
1080
+ * 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
1078
1081
  */
1079
1082
  Type?: string
1080
1083
  }
@@ -851,7 +851,7 @@ export interface CreateSnapshotPoliciesResponse {
851
851
  /**
852
852
  * 快照策略。
853
853
  */
854
- SnapshotPolicies: Array<SnapshotPolicy>
854
+ SnapshotPolicies?: Array<SnapshotPolicy>
855
855
  /**
856
856
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
857
857
  */
@@ -10655,6 +10655,14 @@ AnycastEIP是否用于绑定负载均衡。
10655
10655
  * CDC唯一ID
10656
10656
  */
10657
10657
  DedicatedClusterId?: string
10658
+ /**
10659
+ * 是否使用独占资源池,默认值:True
10660
+ - True:表示使用独占资源池
10661
+ - False:表示使用共享资源池
10662
+
10663
+ 说明:如需使用独占资源池,请 提交工单(https://console.cloud.tencent.com/workorder/category) 咨询,具体费用请咨询商务经理。
10664
+ */
10665
+ IsDedicatedAddressPool?: boolean
10658
10666
  /**
10659
10667
  * 网络出口,当前仅支持精品BGP、静态单线,这2种IP 地址类型的指定出口传入,默认值:center_egress1,其它可选值:center_egress2、center_egress3
10660
10668
  */
@@ -12384,6 +12392,10 @@ export interface CreateSnapshotPoliciesRequest {
12384
12392
  * 快照策略详情。
12385
12393
  */
12386
12394
  SnapshotPolicies: Array<SnapshotPolicy>
12395
+ /**
12396
+ * 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。
12397
+ */
12398
+ Tags?: Array<Tag>
12387
12399
  }
12388
12400
 
12389
12401
  /**
@@ -21509,6 +21509,11 @@ export interface Pair {
21509
21509
  * 值
21510
21510
  */
21511
21511
  Value: string
21512
+ /**
21513
+ * 唯一标识
21514
+ 注意:此字段可能返回 null,表示取不到有效值。
21515
+ */
21516
+ Id?: string
21512
21517
  }
21513
21518
 
21514
21519
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.990";
1
+ export declare const sdkVersion = "4.0.992";
@@ -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.990";
4
+ exports.sdkVersion = "4.0.992";
@@ -165,7 +165,7 @@ export interface CreateLoadBalancerRequest {
165
165
  */
166
166
  LoadBalancerName?: string;
167
167
  /**
168
- * 负载均衡后端目标设备所属的网络 ID,如vpc-12345678,可以通过 [DescribeVpcEx](https://cloud.tencent.com/document/product/215/1372) 接口获取。 不填此参数则默认为DefaultVPC。创建内网负载均衡实例时,此参数必填。
168
+ * 负载均衡后端目标设备所属的网络 ID,如vpc-12345678,可以通过 [DescribeVpcs](https://cloud.tencent.com/document/product/215/15778) 接口获取。 不填此参数则默认为DefaultVPC。创建内网负载均衡实例时,此参数必填。
169
169
  */
170
170
  VpcId?: string;
171
171
  /**
@@ -2317,8 +2317,10 @@ export interface TemplateInfo {
2317
2317
  */
2318
2318
  CreatorId?: string;
2319
2319
  /**
2320
- * 模板的H5预览链接,有效期5分钟。
2321
- 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
2320
+ * 模板的 H5 预览链接,有效期为 5 分钟。
2321
+ 您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
2322
+
2323
+ 注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
2322
2324
  注意:此字段可能返回 null,表示取不到有效值。
2323
2325
  */
2324
2326
  PreviewUrl?: string;
@@ -993,19 +993,19 @@ export interface ChannelCreatePrepareFlowResponse {
993
993
  */
994
994
  export interface CreateBatchInitOrganizationUrlResponse {
995
995
  /**
996
- * 小程序路径
996
+ * 小程序路径,有效时间为7天
997
997
  */
998
998
  MiniAppPath?: string;
999
999
  /**
1000
- * 操作长链
1000
+ * 操作长链,有效时间为7天
1001
1001
  */
1002
1002
  OperateLongUrl?: string;
1003
1003
  /**
1004
- * 操作短链
1004
+ * 操作短链,有效时间为7天
1005
1005
  */
1006
1006
  OperateShortUrl?: string;
1007
1007
  /**
1008
- * 操作二维码
1008
+ * 操作二维码,有效时间为7天
1009
1009
  */
1010
1010
  QRCodeUrl?: string;
1011
1011
  /**
@@ -1985,6 +1985,18 @@ export interface ChannelCreateFlowByFilesRequest {
1985
1985
  * 在短信通知、填写、签署流程中,若标题、按钮、合同详情等地方存在“合同”字样时,可根据此配置指定文案,可选文案如下: <ul><li> <b>0</b> :合同(默认值)</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
1986
1986
  */
1987
1987
  FlowDisplayType?: number;
1988
+ /**
1989
+ * 是否为预览模式,取值如下: <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li> <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
1990
+ */
1991
+ NeedPreview?: boolean;
1992
+ /**
1993
+ * 预览模式下产生的预览链接类型
1994
+ <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
1995
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
1996
+ 注: `此参数在NeedPreview 为true时有效`
1997
+
1998
+ */
1999
+ PreviewType?: number;
1988
2000
  }
1989
2001
  /**
1990
2002
  * UploadFiles返回参数结构体
@@ -2579,18 +2591,29 @@ export interface TemplateInfo {
2579
2591
  Description?: string;
2580
2592
  /**
2581
2593
  * 模板的填充控件列表
2594
+
2595
+ [点击查看在模板中配置的填充控件的样子](https://qcloudimg.tencent-cloud.cn/raw/cb2f58529fca8d909258f9d45a56f7f4.png)
2582
2596
  */
2583
2597
  Components?: Array<Component>;
2584
2598
  /**
2585
2599
  * 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
2600
+
2601
+ [点击查看在模板中配置的签署参与方角色列表的样子](https://qcloudimg.tencent-cloud.cn/raw/e082bbcc0d923f8cb723d98382410aa2.png)
2602
+
2603
+
2586
2604
  */
2587
2605
  Recipients?: Array<Recipient>;
2588
2606
  /**
2589
2607
  * 此模板中的签署控件列表
2608
+
2609
+ [点击查看在模板中配置的签署控件的样子](https://qcloudimg.tencent-cloud.cn/raw/29bc6ed753a5a0fce4a3ab02e2c0d955.png)
2590
2610
  */
2591
2611
  SignComponents?: Array<Component>;
2592
2612
  /**
2593
- * 模板类型:1-静默签;3-普通模板
2613
+ * 模板类型可以分为以下两种:
2614
+
2615
+ <b>1</b>:带有<b>本企业自动签署</b>的模板,即签署过程无需签署人手动操作,系统自动完成签署。
2616
+ <b>3</b>:普通模板,即签署人需要手动进行签署操作。
2594
2617
  */
2595
2618
  TemplateType?: number;
2596
2619
  /**
@@ -2607,8 +2630,10 @@ export interface TemplateInfo {
2607
2630
  */
2608
2631
  CreatedOn?: number;
2609
2632
  /**
2610
- * 模板的H5预览链接,有效期5分钟。
2611
- 可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
2633
+ * 模板的 H5 预览链接,有效期为 5 分钟。
2634
+ 您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
2635
+
2636
+ 注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
2612
2637
  注意:此字段可能返回 null,表示取不到有效值。
2613
2638
  */
2614
2639
  PreviewUrl?: string;
@@ -340,7 +340,9 @@ export declare class Client extends AbstractClient {
340
340
  */
341
341
  InvokeCloudStorageAIServiceTask(req: InvokeCloudStorageAIServiceTaskRequest, cb?: (error: string, rep: InvokeCloudStorageAIServiceTaskResponse) => void): Promise<InvokeCloudStorageAIServiceTaskResponse>;
342
342
  /**
343
- * 查询TWeCall包列表
343
+ * 微信VOIP功能调整下线
344
+
345
+ 查询TWeCall包列表
344
346
  */
345
347
  GetTWeCallPkgList(req: GetTWeCallPkgListRequest, cb?: (error: string, rep: GetTWeCallPkgListResponse) => void): Promise<GetTWeCallPkgListResponse>;
346
348
  /**
@@ -364,7 +366,9 @@ export declare class Client extends AbstractClient {
364
366
  */
365
367
  SearchPositionSpace(req: SearchPositionSpaceRequest, cb?: (error: string, rep: SearchPositionSpaceResponse) => void): Promise<SearchPositionSpaceResponse>;
366
368
  /**
367
- * 分配License
369
+ * 微信VOIP功能调整下线
370
+
371
+ 分配License
368
372
  */
369
373
  AssignTWeCallLicense(req: AssignTWeCallLicenseRequest, cb?: (error: string, rep: AssignTWeCallLicenseResponse) => void): Promise<AssignTWeCallLicenseResponse>;
370
374
  /**