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
@@ -102,6 +102,15 @@ export interface ModifyInstancesProjectRequest {
102
102
  */
103
103
  ProjectId: number;
104
104
  }
105
+ /**
106
+ * ConfigureChcDeployVpc返回参数结构体
107
+ */
108
+ export interface ConfigureChcDeployVpcResponse {
109
+ /**
110
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
111
+ */
112
+ RequestId?: string;
113
+ }
105
114
  /**
106
115
  * ResetInstancesType返回参数结构体
107
116
  */
@@ -226,6 +235,10 @@ export interface InquiryPriceResetInstancesInternetMaxBandwidthResponse {
226
235
  */
227
236
  RequestId?: string;
228
237
  }
238
+ /**
239
+ * DescribeZones请求参数结构体
240
+ */
241
+ export declare type DescribeZonesRequest = null;
229
242
  /**
230
243
  * 描述了按带宽计费的相关信息
231
244
  */
@@ -982,6 +995,15 @@ Windows 实例密码必须12\~30位,不能以“/”开头且不包括用户
982
995
  */
983
996
  ForceStop?: boolean;
984
997
  }
998
+ /**
999
+ * RemoveChcAssistVpc返回参数结构体
1000
+ */
1001
+ export interface RemoveChcAssistVpcResponse {
1002
+ /**
1003
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1004
+ */
1005
+ RequestId?: string;
1006
+ }
985
1007
  /**
986
1008
  * 描述了网络计费
987
1009
  */
@@ -1321,9 +1343,47 @@ export interface RenewHostsRequest {
1321
1343
  HostChargePrepaid: ChargePrepaid;
1322
1344
  }
1323
1345
  /**
1324
- * DescribeZones请求参数结构体
1346
+ * CreateDisasterRecoverGroup返回参数结构体
1325
1347
  */
1326
- export declare type DescribeZonesRequest = null;
1348
+ export interface CreateDisasterRecoverGroupResponse {
1349
+ /**
1350
+ * 分散置放群组ID列表。
1351
+ */
1352
+ DisasterRecoverGroupId: string;
1353
+ /**
1354
+ * 分散置放群组类型,取值范围:<br><li>HOST:物理机<br><li>SW:交换机<br><li>RACK:机架
1355
+ */
1356
+ Type: string;
1357
+ /**
1358
+ * 分散置放群组名称,长度1-60个字符,支持中、英文。
1359
+ */
1360
+ Name: string;
1361
+ /**
1362
+ * 置放群组内可容纳的云服务器数量。
1363
+ */
1364
+ CvmQuotaTotal: number;
1365
+ /**
1366
+ * 置放群组内已有的云服务器数量。
1367
+ */
1368
+ CurrentNum: number;
1369
+ /**
1370
+ * 置放群组创建时间。
1371
+ */
1372
+ CreateTime: string;
1373
+ /**
1374
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1375
+ */
1376
+ RequestId?: string;
1377
+ }
1378
+ /**
1379
+ * RemoveChcAssistVpc请求参数结构体
1380
+ */
1381
+ export interface RemoveChcAssistVpcRequest {
1382
+ /**
1383
+ * CHC物理服务器Id。
1384
+ */
1385
+ ChcIds: Array<string>;
1386
+ }
1327
1387
  /**
1328
1388
  * StartInstances请求参数结构体
1329
1389
  */
@@ -1513,6 +1573,23 @@ export interface ResetInstancesInternetMaxBandwidthResponse {
1513
1573
  */
1514
1574
  RequestId?: string;
1515
1575
  }
1576
+ /**
1577
+ * ConfigureChcDeployVpc请求参数结构体
1578
+ */
1579
+ export interface ConfigureChcDeployVpcRequest {
1580
+ /**
1581
+ * CHC物理服务器的实例Id。
1582
+ */
1583
+ ChcIds: Array<string>;
1584
+ /**
1585
+ * 部署网络信息。
1586
+ */
1587
+ DeployVirtualPrivateCloud: VirtualPrivateCloud;
1588
+ /**
1589
+ * 部署网络的安全组列表。
1590
+ */
1591
+ DeploySecurityGroupIds?: Array<string>;
1592
+ }
1516
1593
  /**
1517
1594
  * DescribeInstanceFamilyConfigs返回参数结构体
1518
1595
  */
@@ -1918,17 +1995,17 @@ export interface PrePaidQuota {
1918
1995
  Zone: string;
1919
1996
  }
1920
1997
  /**
1921
- * DescribeInstancesModification返回参数结构体
1998
+ * DescribeReservedInstancesOfferings返回参数结构体
1922
1999
  */
1923
- export interface DescribeInstancesModificationResponse {
2000
+ export interface DescribeReservedInstancesOfferingsResponse {
1924
2001
  /**
1925
- * 实例调整的机型配置的数量。
2002
+ * 符合条件的预留实例计费数量。
1926
2003
  */
1927
- TotalCount: number;
2004
+ TotalCount?: number;
1928
2005
  /**
1929
- * 实例支持调整的机型配置列表。
2006
+ * 符合条件的预留实例计费列表。
1930
2007
  */
1931
- InstanceTypeConfigStatusSet: Array<InstanceTypeConfigStatus>;
2008
+ ReservedInstancesOfferingsSet?: Array<ReservedInstancesOffering>;
1932
2009
  /**
1933
2010
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1934
2011
  */
@@ -2986,6 +3063,15 @@ export interface InstanceFamilyConfig {
2986
3063
  */
2987
3064
  InstanceFamily: string;
2988
3065
  }
3066
+ /**
3067
+ * RemoveChcDeployVpc返回参数结构体
3068
+ */
3069
+ export interface RemoveChcDeployVpcResponse {
3070
+ /**
3071
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3072
+ */
3073
+ RequestId?: string;
3074
+ }
2989
3075
  /**
2990
3076
  * AssociateSecurityGroups返回参数结构体
2991
3077
  */
@@ -3049,6 +3135,31 @@ export interface SpotMarketOptions {
3049
3135
  */
3050
3136
  SpotInstanceType?: string;
3051
3137
  }
3138
+ /**
3139
+ * ConfigureChcAssistVpc请求参数结构体
3140
+ */
3141
+ export interface ConfigureChcAssistVpcRequest {
3142
+ /**
3143
+ * CHC物理服务器的实例Id。
3144
+ */
3145
+ ChcIds: Array<string>;
3146
+ /**
3147
+ * 带外网络信息。
3148
+ */
3149
+ BmcVirtualPrivateCloud: VirtualPrivateCloud;
3150
+ /**
3151
+ * 带外网络的安全组列表
3152
+ */
3153
+ BmcSecurityGroupIds?: Array<string>;
3154
+ /**
3155
+ * 部署网络信息。
3156
+ */
3157
+ DeployVirtualPrivateCloud?: VirtualPrivateCloud;
3158
+ /**
3159
+ * 部署网络的安全组列表
3160
+ */
3161
+ DeploySecurityGroupIds?: Array<string>;
3162
+ }
3052
3163
  /**
3053
3164
  * DescribeImportImageOs请求参数结构体
3054
3165
  */
@@ -3418,6 +3529,15 @@ export interface ModifyHostsAttributeResponse {
3418
3529
  */
3419
3530
  RequestId?: string;
3420
3531
  }
3532
+ /**
3533
+ * ModifyChcAttribute返回参数结构体
3534
+ */
3535
+ export interface ModifyChcAttributeResponse {
3536
+ /**
3537
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3538
+ */
3539
+ RequestId?: string;
3540
+ }
3421
3541
  /**
3422
3542
  * DescribeDisasterRecoverGroupQuota请求参数结构体
3423
3543
  */
@@ -3859,6 +3979,15 @@ export interface ExportImagesResponse {
3859
3979
  */
3860
3980
  RequestId?: string;
3861
3981
  }
3982
+ /**
3983
+ * RemoveChcDeployVpc请求参数结构体
3984
+ */
3985
+ export interface RemoveChcDeployVpcRequest {
3986
+ /**
3987
+ * CHC物理服务器Id。
3988
+ */
3989
+ ChcIds: Array<string>;
3990
+ }
3862
3991
  /**
3863
3992
  * InquiryPriceRunInstances返回参数结构体
3864
3993
  */
@@ -3877,7 +4006,7 @@ export interface InquiryPriceRunInstancesResponse {
3877
4006
  */
3878
4007
  export interface TagSpecification {
3879
4008
  /**
3880
- * 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”
4009
+ * 标签绑定的资源类型,云服务器为“instance”,专用宿主机为“host”,镜像为“image”,密钥为“keypair
3881
4010
  */
3882
4011
  ResourceType: string;
3883
4012
  /**
@@ -3924,6 +4053,35 @@ export interface DescribeAccountQuotaRequest {
3924
4053
  */
3925
4054
  Filters?: Array<Filter>;
3926
4055
  }
4056
+ /**
4057
+ * ModifyChcAttribute请求参数结构体
4058
+ */
4059
+ export interface ModifyChcAttributeRequest {
4060
+ /**
4061
+ * CHC物理服务器ID。
4062
+ */
4063
+ ChcIds: Array<string>;
4064
+ /**
4065
+ * CHC物理服务器名称
4066
+ */
4067
+ InstanceName?: string;
4068
+ /**
4069
+ * 服务器类型
4070
+ */
4071
+ DeviceType?: string;
4072
+ /**
4073
+ * 合法字符为字母,数字, 横线和下划线
4074
+ */
4075
+ BmcUser?: string;
4076
+ /**
4077
+ * 密码8-16位字符, 允许数字,字母, 和特殊字符()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
4078
+ */
4079
+ Password?: string;
4080
+ /**
4081
+ * bmc网络的安全组列表
4082
+ */
4083
+ BmcSecurityGroupIds?: Array<string>;
4084
+ }
3927
4085
  /**
3928
4086
  * ModifyInstancesRenewFlag返回参数结构体
3929
4087
  */
@@ -4120,6 +4278,24 @@ export interface ReservedInstancePriceItem {
4120
4278
  */
4121
4279
  ProductDescription: string;
4122
4280
  }
4281
+ /**
4282
+ * ConfigureChcAssistVpc返回参数结构体
4283
+ */
4284
+ export interface ConfigureChcAssistVpcResponse {
4285
+ /**
4286
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4287
+ */
4288
+ RequestId?: string;
4289
+ }
4290
+ /**
4291
+ * RebootInstances返回参数结构体
4292
+ */
4293
+ export interface RebootInstancesResponse {
4294
+ /**
4295
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4296
+ */
4297
+ RequestId?: string;
4298
+ }
4123
4299
  /**
4124
4300
  * DescribeChcHosts请求参数结构体
4125
4301
  */
@@ -4152,48 +4328,6 @@ export interface DescribeChcHostsRequest {
4152
4328
  */
4153
4329
  Limit?: number;
4154
4330
  }
4155
- /**
4156
- * RebootInstances返回参数结构体
4157
- */
4158
- export interface RebootInstancesResponse {
4159
- /**
4160
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4161
- */
4162
- RequestId?: string;
4163
- }
4164
- /**
4165
- * CreateDisasterRecoverGroup返回参数结构体
4166
- */
4167
- export interface CreateDisasterRecoverGroupResponse {
4168
- /**
4169
- * 分散置放群组ID列表。
4170
- */
4171
- DisasterRecoverGroupId: string;
4172
- /**
4173
- * 分散置放群组类型,取值范围:<br><li>HOST:物理机<br><li>SW:交换机<br><li>RACK:机架
4174
- */
4175
- Type: string;
4176
- /**
4177
- * 分散置放群组名称,长度1-60个字符,支持中、英文。
4178
- */
4179
- Name: string;
4180
- /**
4181
- * 置放群组内可容纳的云服务器数量。
4182
- */
4183
- CvmQuotaTotal: number;
4184
- /**
4185
- * 置放群组内已有的云服务器数量。
4186
- */
4187
- CurrentNum: number;
4188
- /**
4189
- * 置放群组创建时间。
4190
- */
4191
- CreateTime: string;
4192
- /**
4193
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4194
- */
4195
- RequestId?: string;
4196
- }
4197
4331
  /**
4198
4332
  * ModifyInstanceDiskType请求参数结构体
4199
4333
  */
@@ -4632,17 +4766,17 @@ export interface KeyPair {
4632
4766
  Tags?: Array<Tag>;
4633
4767
  }
4634
4768
  /**
4635
- * DescribeReservedInstancesOfferings返回参数结构体
4769
+ * DescribeInstancesModification返回参数结构体
4636
4770
  */
4637
- export interface DescribeReservedInstancesOfferingsResponse {
4771
+ export interface DescribeInstancesModificationResponse {
4638
4772
  /**
4639
- * 符合条件的预留实例计费数量。
4773
+ * 实例调整的机型配置的数量。
4640
4774
  */
4641
- TotalCount?: number;
4775
+ TotalCount: number;
4642
4776
  /**
4643
- * 符合条件的预留实例计费列表。
4777
+ * 实例支持调整的机型配置列表。
4644
4778
  */
4645
- ReservedInstancesOfferingsSet?: Array<ReservedInstancesOffering>;
4779
+ InstanceTypeConfigStatusSet: Array<InstanceTypeConfigStatus>;
4646
4780
  /**
4647
4781
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4648
4782
  */
@@ -431,6 +431,14 @@ export interface CreateAccountRequest {
431
431
  建议该参数值大于10。当ReadOnly选择1、2时该参数生效。
432
432
  */
433
433
  DelayThresh?: number;
434
+ /**
435
+ * 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
436
+ */
437
+ SlaveConst?: number;
438
+ /**
439
+ * 用户最大连接数限制参数。不传或者传0表示为不限制,对应max_user_connections参数,目前10.1内核版本不支持设置。
440
+ */
441
+ MaxUserConnections?: number;
434
442
  }
435
443
  /**
436
444
  * DescribeDBParameters返回参数结构体
@@ -3032,6 +3040,10 @@ export interface DBAccount {
3032
3040
  建议该参数值大于10。当ReadOnly选择1、2时该参数生效。
3033
3041
  */
3034
3042
  DelayThresh: number;
3043
+ /**
3044
+ * 针对只读账号,设置策略是否固定备机,0:不固定备机,即备机不满足条件与客户端不断开连接,Proxy选择其他可用备机,1:备机不满足条件断开连接,确保一个连接固定备机。
3045
+ */
3046
+ SlaveConst: number;
3035
3047
  }
3036
3048
  /**
3037
3049
  * DescribeDatabaseTable返回参数结构体
@@ -2215,6 +2215,10 @@ export interface AlterDMSTableRequest {
2215
2215
  * 分区
2216
2216
  */
2217
2217
  Partitions?: Array<DMSPartition>;
2218
+ /**
2219
+ * 当前表名
2220
+ */
2221
+ Name?: string;
2218
2222
  }
2219
2223
  /**
2220
2224
  * CreateImportTask返回参数结构体
@@ -124,6 +124,16 @@ export interface NodeInfo {
124
124
  * 节点磁盘是否加密 0: 不加密,1: 加密;默认不加密
125
125
  */
126
126
  DiskEncrypt?: number;
127
+ /**
128
+ * cpu数目
129
+ 注意:此字段可能返回 null,表示取不到有效值。
130
+ */
131
+ CpuNum?: number;
132
+ /**
133
+ * 内存大小,单位GB
134
+ 注意:此字段可能返回 null,表示取不到有效值。
135
+ */
136
+ MemSize?: number;
127
137
  }
128
138
  /**
129
139
  * UpgradeInstance返回参数结构体
@@ -9,23 +9,30 @@ export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
11
  * 此接口用于发起流程
12
+ 适用场景:见创建签署流程接口。
13
+ 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
12
14
  */
13
15
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
14
16
  /**
15
17
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
18
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
16
19
  适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
17
20
  */
18
21
  CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
19
22
  /**
20
23
  * 用于撤销签署流程
24
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
25
+ 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
21
26
  */
22
27
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
23
28
  /**
24
29
  * 创建电子文档
30
+ 适用场景:见创建签署流程接口。 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
25
31
  */
26
32
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
27
33
  /**
28
34
  * 查询文件下载URL
35
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
29
36
  */
30
37
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
31
38
  /**
@@ -34,6 +41,8 @@ export declare class Client extends AbstractClient {
34
41
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
35
42
  /**
36
43
  * 创建签署流程
44
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
45
+ 注:改接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
37
46
  */
38
47
  CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
39
48
  /**
@@ -43,6 +52,11 @@ export declare class Client extends AbstractClient {
43
52
  /**
44
53
  * 获取小程序跳转链接
45
54
 
55
+ 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
56
+
57
+ 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
58
+
59
+
46
60
  跳转到小程序的实现,参考官方文档(分为<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>两种方式)
47
61
 
48
62
 
@@ -51,18 +65,24 @@ export declare class Client extends AbstractClient {
51
65
  CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
52
66
  /**
53
67
  * 二期接口-查询模板
68
+ 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
54
69
  */
55
70
  DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
56
71
  /**
57
72
  * 查询流程摘要
73
+ 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
58
74
  */
59
75
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
60
76
  /**
61
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建签署流程。
77
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
78
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
79
+ 适用场景2:可通过改接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
80
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
62
81
  */
63
82
  CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
64
83
  /**
65
84
  * 此接口(UploadFiles)用于文件上传。
85
+ 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
66
86
  调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
67
87
  */
68
88
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
@@ -29,12 +29,15 @@ class Client extends abstract_client_1.AbstractClient {
29
29
  }
30
30
  /**
31
31
  * 此接口用于发起流程
32
+ 适用场景:见创建签署流程接口。
33
+ 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
32
34
  */
33
35
  async StartFlow(req, cb) {
34
36
  return this.request("StartFlow", req, cb);
35
37
  }
36
38
  /**
37
39
  * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
40
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
38
41
  适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
39
42
  */
40
43
  async CreateMultiFlowSignQRCode(req, cb) {
@@ -42,18 +45,22 @@ class Client extends abstract_client_1.AbstractClient {
42
45
  }
43
46
  /**
44
47
  * 用于撤销签署流程
48
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
49
+ 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
45
50
  */
46
51
  async CancelFlow(req, cb) {
47
52
  return this.request("CancelFlow", req, cb);
48
53
  }
49
54
  /**
50
55
  * 创建电子文档
56
+ 适用场景:见创建签署流程接口。 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
51
57
  */
52
58
  async CreateDocument(req, cb) {
53
59
  return this.request("CreateDocument", req, cb);
54
60
  }
55
61
  /**
56
62
  * 查询文件下载URL
63
+ 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
57
64
  */
58
65
  async DescribeFileUrls(req, cb) {
59
66
  return this.request("DescribeFileUrls", req, cb);
@@ -66,6 +73,8 @@ class Client extends abstract_client_1.AbstractClient {
66
73
  }
67
74
  /**
68
75
  * 创建签署流程
76
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
77
+ 注:改接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
69
78
  */
70
79
  async CreateFlow(req, cb) {
71
80
  return this.request("CreateFlow", req, cb);
@@ -79,6 +88,11 @@ class Client extends abstract_client_1.AbstractClient {
79
88
  /**
80
89
  * 获取小程序跳转链接
81
90
 
91
+ 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
92
+
93
+ 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
94
+
95
+
82
96
  跳转到小程序的实现,参考官方文档(分为<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>两种方式)
83
97
 
84
98
 
@@ -89,24 +103,30 @@ class Client extends abstract_client_1.AbstractClient {
89
103
  }
90
104
  /**
91
105
  * 二期接口-查询模板
106
+ 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
92
107
  */
93
108
  async DescribeFlowTemplates(req, cb) {
94
109
  return this.request("DescribeFlowTemplates", req, cb);
95
110
  }
96
111
  /**
97
112
  * 查询流程摘要
113
+ 适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
98
114
  */
99
115
  async DescribeFlowBriefs(req, cb) {
100
116
  return this.request("DescribeFlowBriefs", req, cb);
101
117
  }
102
118
  /**
103
- * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建签署流程。
119
+ * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
120
+ 适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
121
+ 适用场景2:可通过改接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
122
+ 注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
104
123
  */
105
124
  async CreateFlowByFiles(req, cb) {
106
125
  return this.request("CreateFlowByFiles", req, cb);
107
126
  }
108
127
  /**
109
128
  * 此接口(UploadFiles)用于文件上传。
129
+ 适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
110
130
  调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
111
131
  */
112
132
  async UploadFiles(req, cb) {
@@ -338,20 +338,17 @@ export interface SignQrCode {
338
338
  * UploadFiles请求参数结构体
339
339
  */
340
340
  export interface UploadFilesRequest {
341
- /**
342
- * 调用方信息
343
- */
344
- Caller: Caller;
345
341
  /**
346
342
  * 文件对应业务类型,用于区分文件存储路径:
347
343
  1. TEMPLATE - 模板; 文件类型:.pdf/.html
348
344
  2. DOCUMENT - 签署过程及签署后的合同文档 文件类型:.pdf/.html
349
- 3. FLOW - 签署过程 文件类型:.pdf/.html
350
- 4. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
351
- 5. BUSINESSLICENSE - 营业执照 文件类型:.jpg/.jpeg/.png
352
- 6. IDCARD - 身份证 文件类型:.jpg/.jpeg/.png
345
+ 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
353
346
  */
354
347
  BusinessType: string;
348
+ /**
349
+ * 调用方信息
350
+ */
351
+ Caller?: Caller;
355
352
  /**
356
353
  * 上传文件内容数组,最多支持20个文件
357
354
  */
@@ -361,14 +358,14 @@ export interface UploadFilesRequest {
361
358
  */
362
359
  FileUrls?: string;
363
360
  /**
364
- * 是否将pdf灰色矩阵置白
361
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
365
362
  true--是,处理置白
366
363
  false--否,不处理
367
364
  */
368
365
  CoverRect?: boolean;
369
366
  /**
370
- * 特殊文件类型需要指定文件类型:
371
- HTML-- .html文件
367
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
368
+ 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
372
369
  */
373
370
  FileType?: string;
374
371
  /**