tencentcloud-sdk-nodejs 4.0.375 → 4.0.376

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 (58) hide show
  1. package/CHANGELOG.md +340 -0
  2. package/SERVICE_CHANGELOG.md +521 -95
  3. package/package.json +1 -1
  4. package/products.md +15 -15
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cat/v20180409/cat_client.ts +1 -1
  7. package/src/services/cat/v20180409/cat_models.ts +17 -10
  8. package/src/services/cdb/v20170320/cdb_client.ts +21 -9
  9. package/src/services/cdb/v20170320/cdb_models.ts +95 -42
  10. package/src/services/ckafka/v20190819/ckafka_client.ts +1 -1
  11. package/src/services/ckafka/v20190819/ckafka_models.ts +17 -1
  12. package/src/services/cpdp/v20190820/cpdp_client.ts +80 -29
  13. package/src/services/cpdp/v20190820/cpdp_models.ts +325 -33
  14. package/src/services/cvm/v20170312/cvm_client.ts +721 -661
  15. package/src/services/cvm/v20170312/cvm_models.ts +220 -65
  16. package/src/services/dcdb/v20180411/dcdb_models.ts +15 -0
  17. package/src/services/dlc/v20210125/dlc_models.ts +5 -0
  18. package/src/services/es/v20180416/es_models.ts +12 -0
  19. package/src/services/ess/v20201111/ess_client.ts +36 -16
  20. package/src/services/ess/v20201111/ess_models.ts +9 -12
  21. package/src/services/ie/v20200304/ie_client.ts +5 -0
  22. package/src/services/ie/v20200304/ie_models.ts +260 -14
  23. package/src/services/mariadb/v20170312/mariadb_models.ts +15 -0
  24. package/src/services/tdcpg/v20211118/tdcpg_models.ts +42 -6
  25. package/src/services/teo/v20220106/teo_client.ts +7 -2
  26. package/src/services/teo/v20220106/teo_models.ts +236 -93
  27. package/src/services/vpc/v20170312/vpc_client.ts +1 -1
  28. package/tencentcloud/common/sdk_version.d.ts +1 -1
  29. package/tencentcloud/common/sdk_version.js +1 -1
  30. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +1 -1
  31. package/tencentcloud/services/cat/v20180409/cat_client.js +1 -1
  32. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +14 -7
  33. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +7 -3
  34. package/tencentcloud/services/cdb/v20170320/cdb_client.js +9 -3
  35. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +82 -34
  36. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +1 -1
  37. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +15 -1
  38. package/tencentcloud/services/cpdp/v20190820/cpdp_client.d.ts +26 -10
  39. package/tencentcloud/services/cpdp/v20190820/cpdp_client.js +37 -13
  40. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +278 -29
  41. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +335 -315
  42. package/tencentcloud/services/cvm/v20170312/cvm_client.js +430 -400
  43. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +191 -57
  44. package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +12 -0
  45. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +4 -0
  46. package/tencentcloud/services/es/v20180416/es_models.d.ts +10 -0
  47. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +21 -1
  48. package/tencentcloud/services/ess/v20201111/ess_client.js +21 -1
  49. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +8 -11
  50. package/tencentcloud/services/ie/v20200304/ie_models.d.ts +222 -13
  51. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +12 -0
  52. package/tencentcloud/services/tdcpg/v20211118/tdcpg_models.d.ts +35 -5
  53. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +205 -82
  54. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  55. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  56. package/test/cdb.v20170320.test.js +12 -2
  57. package/test/cpdp.v20190820.test.js +48 -8
  58. package/test/cvm.v20170312.test.js +206 -156
@@ -136,6 +136,16 @@ export interface ModifyInstancesProjectRequest {
136
136
  ProjectId: number
137
137
  }
138
138
 
139
+ /**
140
+ * ConfigureChcDeployVpc返回参数结构体
141
+ */
142
+ export interface ConfigureChcDeployVpcResponse {
143
+ /**
144
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
145
+ */
146
+ RequestId?: string
147
+ }
148
+
139
149
  /**
140
150
  * ResetInstancesType返回参数结构体
141
151
  */
@@ -281,6 +291,11 @@ export interface InquiryPriceResetInstancesInternetMaxBandwidthResponse {
281
291
  RequestId?: string
282
292
  }
283
293
 
294
+ /**
295
+ * DescribeZones请求参数结构体
296
+ */
297
+ export type DescribeZonesRequest = null
298
+
284
299
  /**
285
300
  * 描述了按带宽计费的相关信息
286
301
  */
@@ -1163,6 +1178,16 @@ Windows 实例密码必须12\~30位,不能以“/”开头且不包括用户
1163
1178
  ForceStop?: boolean
1164
1179
  }
1165
1180
 
1181
+ /**
1182
+ * RemoveChcAssistVpc返回参数结构体
1183
+ */
1184
+ export interface RemoveChcAssistVpcResponse {
1185
+ /**
1186
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1187
+ */
1188
+ RequestId?: string
1189
+ }
1190
+
1166
1191
  /**
1167
1192
  * 描述了网络计费
1168
1193
  */
@@ -1558,9 +1583,54 @@ export interface RenewHostsRequest {
1558
1583
  }
1559
1584
 
1560
1585
  /**
1561
- * DescribeZones请求参数结构体
1586
+ * CreateDisasterRecoverGroup返回参数结构体
1562
1587
  */
1563
- export type DescribeZonesRequest = null
1588
+ export interface CreateDisasterRecoverGroupResponse {
1589
+ /**
1590
+ * 分散置放群组ID列表。
1591
+ */
1592
+ DisasterRecoverGroupId: string
1593
+
1594
+ /**
1595
+ * 分散置放群组类型,取值范围:<br><li>HOST:物理机<br><li>SW:交换机<br><li>RACK:机架
1596
+ */
1597
+ Type: string
1598
+
1599
+ /**
1600
+ * 分散置放群组名称,长度1-60个字符,支持中、英文。
1601
+ */
1602
+ Name: string
1603
+
1604
+ /**
1605
+ * 置放群组内可容纳的云服务器数量。
1606
+ */
1607
+ CvmQuotaTotal: number
1608
+
1609
+ /**
1610
+ * 置放群组内已有的云服务器数量。
1611
+ */
1612
+ CurrentNum: number
1613
+
1614
+ /**
1615
+ * 置放群组创建时间。
1616
+ */
1617
+ CreateTime: string
1618
+
1619
+ /**
1620
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1621
+ */
1622
+ RequestId?: string
1623
+ }
1624
+
1625
+ /**
1626
+ * RemoveChcAssistVpc请求参数结构体
1627
+ */
1628
+ export interface RemoveChcAssistVpcRequest {
1629
+ /**
1630
+ * CHC物理服务器Id。
1631
+ */
1632
+ ChcIds: Array<string>
1633
+ }
1564
1634
 
1565
1635
  /**
1566
1636
  * StartInstances请求参数结构体
@@ -1782,6 +1852,26 @@ export interface ResetInstancesInternetMaxBandwidthResponse {
1782
1852
  RequestId?: string
1783
1853
  }
1784
1854
 
1855
+ /**
1856
+ * ConfigureChcDeployVpc请求参数结构体
1857
+ */
1858
+ export interface ConfigureChcDeployVpcRequest {
1859
+ /**
1860
+ * CHC物理服务器的实例Id。
1861
+ */
1862
+ ChcIds: Array<string>
1863
+
1864
+ /**
1865
+ * 部署网络信息。
1866
+ */
1867
+ DeployVirtualPrivateCloud: VirtualPrivateCloud
1868
+
1869
+ /**
1870
+ * 部署网络的安全组列表。
1871
+ */
1872
+ DeploySecurityGroupIds?: Array<string>
1873
+ }
1874
+
1785
1875
  /**
1786
1876
  * DescribeInstanceFamilyConfigs返回参数结构体
1787
1877
  */
@@ -2264,18 +2354,18 @@ export interface PrePaidQuota {
2264
2354
  }
2265
2355
 
2266
2356
  /**
2267
- * DescribeInstancesModification返回参数结构体
2357
+ * DescribeReservedInstancesOfferings返回参数结构体
2268
2358
  */
2269
- export interface DescribeInstancesModificationResponse {
2359
+ export interface DescribeReservedInstancesOfferingsResponse {
2270
2360
  /**
2271
- * 实例调整的机型配置的数量。
2361
+ * 符合条件的预留实例计费数量。
2272
2362
  */
2273
- TotalCount: number
2363
+ TotalCount?: number
2274
2364
 
2275
2365
  /**
2276
- * 实例支持调整的机型配置列表。
2366
+ * 符合条件的预留实例计费列表。
2277
2367
  */
2278
- InstanceTypeConfigStatusSet: Array<InstanceTypeConfigStatus>
2368
+ ReservedInstancesOfferingsSet?: Array<ReservedInstancesOffering>
2279
2369
 
2280
2370
  /**
2281
2371
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3540,6 +3630,16 @@ export interface InstanceFamilyConfig {
3540
3630
  InstanceFamily: string
3541
3631
  }
3542
3632
 
3633
+ /**
3634
+ * RemoveChcDeployVpc返回参数结构体
3635
+ */
3636
+ export interface RemoveChcDeployVpcResponse {
3637
+ /**
3638
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3639
+ */
3640
+ RequestId?: string
3641
+ }
3642
+
3543
3643
  /**
3544
3644
  * AssociateSecurityGroups返回参数结构体
3545
3645
  */
@@ -3615,6 +3715,36 @@ export interface SpotMarketOptions {
3615
3715
  SpotInstanceType?: string
3616
3716
  }
3617
3717
 
3718
+ /**
3719
+ * ConfigureChcAssistVpc请求参数结构体
3720
+ */
3721
+ export interface ConfigureChcAssistVpcRequest {
3722
+ /**
3723
+ * CHC物理服务器的实例Id。
3724
+ */
3725
+ ChcIds: Array<string>
3726
+
3727
+ /**
3728
+ * 带外网络信息。
3729
+ */
3730
+ BmcVirtualPrivateCloud: VirtualPrivateCloud
3731
+
3732
+ /**
3733
+ * 带外网络的安全组列表
3734
+ */
3735
+ BmcSecurityGroupIds?: Array<string>
3736
+
3737
+ /**
3738
+ * 部署网络信息。
3739
+ */
3740
+ DeployVirtualPrivateCloud?: VirtualPrivateCloud
3741
+
3742
+ /**
3743
+ * 部署网络的安全组列表
3744
+ */
3745
+ DeploySecurityGroupIds?: Array<string>
3746
+ }
3747
+
3618
3748
  /**
3619
3749
  * DescribeImportImageOs请求参数结构体
3620
3750
  */
@@ -4044,6 +4174,16 @@ export interface ModifyHostsAttributeResponse {
4044
4174
  RequestId?: string
4045
4175
  }
4046
4176
 
4177
+ /**
4178
+ * ModifyChcAttribute返回参数结构体
4179
+ */
4180
+ export interface ModifyChcAttributeResponse {
4181
+ /**
4182
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4183
+ */
4184
+ RequestId?: string
4185
+ }
4186
+
4047
4187
  /**
4048
4188
  * DescribeDisasterRecoverGroupQuota请求参数结构体
4049
4189
  */
@@ -4562,6 +4702,16 @@ export interface ExportImagesResponse {
4562
4702
  RequestId?: string
4563
4703
  }
4564
4704
 
4705
+ /**
4706
+ * RemoveChcDeployVpc请求参数结构体
4707
+ */
4708
+ export interface RemoveChcDeployVpcRequest {
4709
+ /**
4710
+ * CHC物理服务器Id。
4711
+ */
4712
+ ChcIds: Array<string>
4713
+ }
4714
+
4565
4715
  /**
4566
4716
  * InquiryPriceRunInstances返回参数结构体
4567
4717
  */
@@ -4582,7 +4732,7 @@ export interface InquiryPriceRunInstancesResponse {
4582
4732
  */
4583
4733
  export interface TagSpecification {
4584
4734
  /**
4585
- * 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”
4735
+ * 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”,密钥为“keypair
4586
4736
  */
4587
4737
  ResourceType: string
4588
4738
 
@@ -4635,6 +4785,41 @@ export interface DescribeAccountQuotaRequest {
4635
4785
  Filters?: Array<Filter>
4636
4786
  }
4637
4787
 
4788
+ /**
4789
+ * ModifyChcAttribute请求参数结构体
4790
+ */
4791
+ export interface ModifyChcAttributeRequest {
4792
+ /**
4793
+ * CHC物理服务器ID。
4794
+ */
4795
+ ChcIds: Array<string>
4796
+
4797
+ /**
4798
+ * CHC物理服务器名称
4799
+ */
4800
+ InstanceName?: string
4801
+
4802
+ /**
4803
+ * 服务器类型
4804
+ */
4805
+ DeviceType?: string
4806
+
4807
+ /**
4808
+ * 合法字符为字母,数字, 横线和下划线
4809
+ */
4810
+ BmcUser?: string
4811
+
4812
+ /**
4813
+ * 密码8-16位字符, 允许数字,字母, 和特殊字符()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
4814
+ */
4815
+ Password?: string
4816
+
4817
+ /**
4818
+ * bmc网络的安全组列表
4819
+ */
4820
+ BmcSecurityGroupIds?: Array<string>
4821
+ }
4822
+
4638
4823
  /**
4639
4824
  * ModifyInstancesRenewFlag返回参数结构体
4640
4825
  */
@@ -4865,6 +5050,26 @@ export interface ReservedInstancePriceItem {
4865
5050
  ProductDescription: string
4866
5051
  }
4867
5052
 
5053
+ /**
5054
+ * ConfigureChcAssistVpc返回参数结构体
5055
+ */
5056
+ export interface ConfigureChcAssistVpcResponse {
5057
+ /**
5058
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5059
+ */
5060
+ RequestId?: string
5061
+ }
5062
+
5063
+ /**
5064
+ * RebootInstances返回参数结构体
5065
+ */
5066
+ export interface RebootInstancesResponse {
5067
+ /**
5068
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5069
+ */
5070
+ RequestId?: string
5071
+ }
5072
+
4868
5073
  /**
4869
5074
  * DescribeChcHosts请求参数结构体
4870
5075
  */
@@ -4901,56 +5106,6 @@ export interface DescribeChcHostsRequest {
4901
5106
  Limit?: number
4902
5107
  }
4903
5108
 
4904
- /**
4905
- * RebootInstances返回参数结构体
4906
- */
4907
- export interface RebootInstancesResponse {
4908
- /**
4909
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4910
- */
4911
- RequestId?: string
4912
- }
4913
-
4914
- /**
4915
- * CreateDisasterRecoverGroup返回参数结构体
4916
- */
4917
- export interface CreateDisasterRecoverGroupResponse {
4918
- /**
4919
- * 分散置放群组ID列表。
4920
- */
4921
- DisasterRecoverGroupId: string
4922
-
4923
- /**
4924
- * 分散置放群组类型,取值范围:<br><li>HOST:物理机<br><li>SW:交换机<br><li>RACK:机架
4925
- */
4926
- Type: string
4927
-
4928
- /**
4929
- * 分散置放群组名称,长度1-60个字符,支持中、英文。
4930
- */
4931
- Name: string
4932
-
4933
- /**
4934
- * 置放群组内可容纳的云服务器数量。
4935
- */
4936
- CvmQuotaTotal: number
4937
-
4938
- /**
4939
- * 置放群组内已有的云服务器数量。
4940
- */
4941
- CurrentNum: number
4942
-
4943
- /**
4944
- * 置放群组创建时间。
4945
- */
4946
- CreateTime: string
4947
-
4948
- /**
4949
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4950
- */
4951
- RequestId?: string
4952
- }
4953
-
4954
5109
  /**
4955
5110
  * ModifyInstanceDiskType请求参数结构体
4956
5111
  */
@@ -5461,18 +5616,18 @@ export interface KeyPair {
5461
5616
  }
5462
5617
 
5463
5618
  /**
5464
- * DescribeReservedInstancesOfferings返回参数结构体
5619
+ * DescribeInstancesModification返回参数结构体
5465
5620
  */
5466
- export interface DescribeReservedInstancesOfferingsResponse {
5621
+ export interface DescribeInstancesModificationResponse {
5467
5622
  /**
5468
- * 符合条件的预留实例计费数量。
5623
+ * 实例调整的机型配置的数量。
5469
5624
  */
5470
- TotalCount?: number
5625
+ TotalCount: number
5471
5626
 
5472
5627
  /**
5473
- * 符合条件的预留实例计费列表。
5628
+ * 实例支持调整的机型配置列表。
5474
5629
  */
5475
- ReservedInstancesOfferingsSet?: Array<ReservedInstancesOffering>
5630
+ InstanceTypeConfigStatusSet: Array<InstanceTypeConfigStatus>
5476
5631
 
5477
5632
  /**
5478
5633
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -524,6 +524,16 @@ export interface CreateAccountRequest {
524
524
  建议该参数值大于10。当ReadOnly选择1、2时该参数生效。
525
525
  */
526
526
  DelayThresh?: number
527
+
528
+ /**
529
+ * 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
530
+ */
531
+ SlaveConst?: number
532
+
533
+ /**
534
+ * 用户最大连接数限制参数。不传或者传0表示为不限制,对应max_user_connections参数,目前10.1内核版本不支持设置。
535
+ */
536
+ MaxUserConnections?: number
527
537
  }
528
538
 
529
539
  /**
@@ -3626,6 +3636,11 @@ export interface DBAccount {
3626
3636
  建议该参数值大于10。当ReadOnly选择1、2时该参数生效。
3627
3637
  */
3628
3638
  DelayThresh: number
3639
+
3640
+ /**
3641
+ * 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
3642
+ */
3643
+ SlaveConst: number
3629
3644
  }
3630
3645
 
3631
3646
  /**
@@ -2648,6 +2648,11 @@ export interface AlterDMSTableRequest {
2648
2648
  * 分区
2649
2649
  */
2650
2650
  Partitions?: Array<DMSPartition>
2651
+
2652
+ /**
2653
+ * 当前表名
2654
+ */
2655
+ Name?: string
2651
2656
  }
2652
2657
 
2653
2658
  /**
@@ -163,6 +163,18 @@ export interface NodeInfo {
163
163
  * 节点磁盘是否加密 0: 不加密,1: 加密;默认不加密
164
164
  */
165
165
  DiskEncrypt?: number
166
+
167
+ /**
168
+ * cpu数目
169
+ 注意:此字段可能返回 null,表示取不到有效值。
170
+ */
171
+ CpuNum?: number
172
+
173
+ /**
174
+ * 内存大小,单位GB
175
+ 注意:此字段可能返回 null,表示取不到有效值。
176
+ */
177
+ MemSize?: number
166
178
  }
167
179
 
168
180
  /**
@@ -72,8 +72,10 @@ export class Client extends AbstractClient {
72
72
  }
73
73
 
74
74
  /**
75
- * 此接口用于发起流程
76
- */
75
+ * 此接口用于发起流程
76
+ 适用场景:见创建签署流程接口。
77
+ 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
78
+ */
77
79
  async StartFlow(
78
80
  req: StartFlowRequest,
79
81
  cb?: (error: string, rep: StartFlowResponse) => void
@@ -83,6 +85,7 @@ export class Client extends AbstractClient {
83
85
 
84
86
  /**
85
87
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
88
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
86
89
  适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
87
90
  */
88
91
  async CreateMultiFlowSignQRCode(
@@ -93,8 +96,10 @@ export class Client extends AbstractClient {
93
96
  }
94
97
 
95
98
  /**
96
- * 用于撤销签署流程
97
- */
99
+ * 用于撤销签署流程
100
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
101
+ 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
102
+ */
98
103
  async CancelFlow(
99
104
  req: CancelFlowRequest,
100
105
  cb?: (error: string, rep: CancelFlowResponse) => void
@@ -103,8 +108,9 @@ export class Client extends AbstractClient {
103
108
  }
104
109
 
105
110
  /**
106
- * 创建电子文档
107
- */
111
+ * 创建电子文档
112
+ 适用场景:见创建签署流程接口。 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
113
+ */
108
114
  async CreateDocument(
109
115
  req: CreateDocumentRequest,
110
116
  cb?: (error: string, rep: CreateDocumentResponse) => void
@@ -113,8 +119,9 @@ export class Client extends AbstractClient {
113
119
  }
114
120
 
115
121
  /**
116
- * 查询文件下载URL
117
- */
122
+ * 查询文件下载URL
123
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
124
+ */
118
125
  async DescribeFileUrls(
119
126
  req: DescribeFileUrlsRequest,
120
127
  cb?: (error: string, rep: DescribeFileUrlsResponse) => void
@@ -133,8 +140,10 @@ export class Client extends AbstractClient {
133
140
  }
134
141
 
135
142
  /**
136
- * 创建签署流程
137
- */
143
+ * 创建签署流程
144
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
145
+ 注:改接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
146
+ */
138
147
  async CreateFlow(
139
148
  req: CreateFlowRequest,
140
149
  cb?: (error: string, rep: CreateFlowResponse) => void
@@ -155,6 +164,11 @@ export class Client extends AbstractClient {
155
164
  /**
156
165
  * 获取小程序跳转链接
157
166
 
167
+ 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
168
+
169
+ 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
170
+
171
+
158
172
  跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式)
159
173
 
160
174
 
@@ -168,8 +182,9 @@ export class Client extends AbstractClient {
168
182
  }
169
183
 
170
184
  /**
171
- * 二期接口-查询模板
172
- */
185
+ * 二期接口-查询模板
186
+ 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
187
+ */
173
188
  async DescribeFlowTemplates(
174
189
  req: DescribeFlowTemplatesRequest,
175
190
  cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
@@ -178,8 +193,9 @@ export class Client extends AbstractClient {
178
193
  }
179
194
 
180
195
  /**
181
- * 查询流程摘要
182
- */
196
+ * 查询流程摘要
197
+ 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
198
+ */
183
199
  async DescribeFlowBriefs(
184
200
  req: DescribeFlowBriefsRequest,
185
201
  cb?: (error: string, rep: DescribeFlowBriefsResponse) => void
@@ -188,8 +204,11 @@ export class Client extends AbstractClient {
188
204
  }
189
205
 
190
206
  /**
191
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建签署流程。
192
- */
207
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
208
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
209
+ 适用场景2:可通过改接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
210
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
211
+ */
193
212
  async CreateFlowByFiles(
194
213
  req: CreateFlowByFilesRequest,
195
214
  cb?: (error: string, rep: CreateFlowByFilesResponse) => void
@@ -199,6 +218,7 @@ export class Client extends AbstractClient {
199
218
 
200
219
  /**
201
220
  * 此接口(UploadFiles)用于文件上传。
221
+ 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
202
222
  调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
203
223
  */
204
224
  async UploadFiles(
@@ -421,22 +421,19 @@ export interface SignQrCode {
421
421
  * UploadFiles请求参数结构体
422
422
  */
423
423
  export interface UploadFilesRequest {
424
- /**
425
- * 调用方信息
426
- */
427
- Caller: Caller
428
-
429
424
  /**
430
425
  * 文件对应业务类型,用于区分文件存储路径:
431
426
  1. TEMPLATE - 模板; 文件类型:.pdf/.html
432
427
  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
433
- 3. FLOW - 签署过程 文件类型:.pdf/.html
434
- 4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
435
- 5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
436
- 6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
428
+ 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
437
429
  */
438
430
  BusinessType: string
439
431
 
432
+ /**
433
+ * 调用方信息
434
+ */
435
+ Caller?: Caller
436
+
440
437
  /**
441
438
  * 上传文件内容数组,最多支持20个文件
442
439
  */
@@ -448,15 +445,15 @@ export interface UploadFilesRequest {
448
445
  FileUrls?: string
449
446
 
450
447
  /**
451
- * 是否将pdf灰色矩阵置白
448
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
452
449
  true--是,处理置白
453
450
  false--否,不处理
454
451
  */
455
452
  CoverRect?: boolean
456
453
 
457
454
  /**
458
- * 特殊文件类型需要指定文件类型:
459
- HTML-- .html文件
455
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
456
+ 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
460
457
  */
461
458
  FileType?: string
462
459
 
@@ -19,6 +19,7 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  VideoSuperResolution,
22
+ DynamicImageInfo,
22
23
  MediaJoiningTaskResult,
23
24
  Denoise,
24
25
  StripTaskResultItem,
@@ -65,6 +66,7 @@ import {
65
66
  ResultVideoInfo,
66
67
  PicMarkInfoItem,
67
68
  MediaJoiningInfo,
69
+ MediaCuttingWatermarkText,
68
70
  DescribeMediaQualityRestorationTaskRusultRequest,
69
71
  ColorEnhance,
70
72
  SegmentInfo,
@@ -104,6 +106,7 @@ import {
104
106
  TagTaskResult,
105
107
  AudioEnhance,
106
108
  CosInfo,
109
+ MediaCuttingWatermarkImage,
107
110
  MediaResultInfo,
108
111
  FrameTagResult,
109
112
  TextMarkInfoItem,
@@ -118,6 +121,7 @@ import {
118
121
  CoverEditingInfo,
119
122
  SubtitleItem,
120
123
  DescribeMediaProcessTaskResultRequest,
124
+ SpriteImageInfo,
121
125
  MediaProcessTaskResult,
122
126
  EditingTaskResult,
123
127
  MediaProcessInfo,
@@ -125,6 +129,7 @@ import {
125
129
  TagItem,
126
130
  DescribeMediaProcessTaskResultResponse,
127
131
  HighlightsTaskResultItemSegment,
132
+ MediaCuttingWatermark,
128
133
  } from "./ie_models"
129
134
 
130
135
  /**