tencentcloud-sdk-nodejs 4.0.900 → 4.0.901

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 (52) hide show
  1. package/CHANGELOG.md +149 -0
  2. package/SERVICE_CHANGELOG.md +251 -8
  3. package/package.json +1 -1
  4. package/products.md +12 -12
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ccc/v20200210/ccc_models.ts +6 -1
  7. package/src/services/cdb/v20170320/cdb_models.ts +2 -1
  8. package/src/services/ckafka/v20190819/ckafka_client.ts +13 -1
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +72 -8
  10. package/src/services/cvm/v20170312/cvm_client.ts +26 -2
  11. package/src/services/cvm/v20170312/cvm_models.ts +70 -18
  12. package/src/services/cynosdb/v20190107/cynosdb_client.ts +40 -15
  13. package/src/services/cynosdb/v20190107/cynosdb_models.ts +266 -168
  14. package/src/services/es/v20180416/es_models.ts +16 -0
  15. package/src/services/ess/v20201111/ess_client.ts +36 -20
  16. package/src/services/ess/v20201111/ess_models.ts +9 -16
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +44 -29
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +13 -13
  19. package/src/services/hunyuan/v20230901/hunyuan_client.ts +4 -2
  20. package/src/services/hunyuan/v20230901/hunyuan_models.ts +84 -43
  21. package/src/services/mna/v20210119/mna_client.ts +74 -1
  22. package/src/services/mna/v20210119/mna_models.ts +244 -25
  23. package/src/services/vpc/v20170312/vpc_models.ts +9 -9
  24. package/tencentcloud/common/sdk_version.d.ts +1 -1
  25. package/tencentcloud/common/sdk_version.js +1 -1
  26. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +6 -1
  27. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +2 -1
  28. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  29. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  30. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +70 -8
  31. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +9 -1
  32. package/tencentcloud/services/cvm/v20170312/cvm_client.js +12 -0
  33. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +66 -18
  34. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +13 -5
  35. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +18 -6
  36. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +261 -168
  37. package/tencentcloud/services/es/v20180416/es_models.d.ts +16 -0
  38. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +36 -20
  39. package/tencentcloud/services/ess/v20201111/ess_client.js +36 -20
  40. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +9 -16
  41. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +44 -29
  42. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +44 -29
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +13 -13
  44. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +80 -41
  45. package/tencentcloud/services/mna/v20210119/mna_client.d.ts +25 -1
  46. package/tencentcloud/services/mna/v20210119/mna_client.js +36 -0
  47. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +231 -25
  48. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +9 -9
  49. package/test/ckafka.v20190819.test.js +10 -0
  50. package/test/cvm.v20170312.test.js +20 -0
  51. package/test/cynosdb.v20190107.test.js +24 -4
  52. package/test/mna.v20210119.test.js +60 -0
@@ -582,6 +582,20 @@ export interface StopCLSDeliveryRequest {
582
582
  CLSTopicIds: Array<string>
583
583
  }
584
584
 
585
+ /**
586
+ * ExportResourcePackageDeductDetails返回参数结构体
587
+ */
588
+ export interface ExportResourcePackageDeductDetailsResponse {
589
+ /**
590
+ * 文件详情
591
+ */
592
+ FileContent?: string
593
+ /**
594
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
595
+ */
596
+ RequestId?: string
597
+ }
598
+
585
599
  /**
586
600
  * DescribeClusters请求参数结构体
587
601
  */
@@ -1621,6 +1635,48 @@ export interface ModifyAccountPrivilegesRequest {
1621
1635
  TablePrivileges?: Array<TablePrivileges>
1622
1636
  }
1623
1637
 
1638
+ /**
1639
+ * ExportResourcePackageDeductDetails请求参数结构体
1640
+ */
1641
+ export interface ExportResourcePackageDeductDetailsRequest {
1642
+ /**
1643
+ * 需要导出的资源包ID
1644
+ */
1645
+ PackageId: string
1646
+ /**
1647
+ * 使用资源包容量的cynos集群ID
1648
+ */
1649
+ ClusterIds?: Array<string>
1650
+ /**
1651
+ * 排序字段,目前支持:createTime(资源包被抵扣时间),successDeductSpec(资源包抵扣量)
1652
+ */
1653
+ OrderBy?: string
1654
+ /**
1655
+ * 排序类型,支持ASC、DESC、asc、desc
1656
+ */
1657
+ OrderByType?: string
1658
+ /**
1659
+ * 开始时间
1660
+ */
1661
+ StartTime?: string
1662
+ /**
1663
+ * 结束时间
1664
+ */
1665
+ EndTime?: string
1666
+ /**
1667
+ * 单次最大导出数据行数,目前最大支持2000行
1668
+ */
1669
+ Limit?: string
1670
+ /**
1671
+ * 偏移量页数
1672
+ */
1673
+ Offset?: string
1674
+ /**
1675
+ * 导出数据格式,目前仅支持csv格式,留作扩展
1676
+ */
1677
+ FileType?: string
1678
+ }
1679
+
1624
1680
  /**
1625
1681
  * StartCLSDelivery返回参数结构体
1626
1682
  */
@@ -4596,17 +4652,17 @@ pause
4596
4652
  }
4597
4653
 
4598
4654
  /**
4599
- * 账号,包含accountName和host
4655
+ * 回档数据库及表
4600
4656
  */
4601
- export interface InputAccount {
4657
+ export interface RollbackTable {
4602
4658
  /**
4603
- * 账号
4659
+ * 数据库名称
4604
4660
  */
4605
- AccountName: string
4661
+ Database: string
4606
4662
  /**
4607
- * 主机,默认‘%’
4663
+ * 数据库表
4608
4664
  */
4609
- Host?: string
4665
+ Tables: Array<RollbackTableInfo>
4610
4666
  }
4611
4667
 
4612
4668
  /**
@@ -5111,6 +5167,172 @@ export interface DescribeClusterDatabasesRequest {
5111
5167
  Limit?: number
5112
5168
  }
5113
5169
 
5170
+ /**
5171
+ * 任务信息
5172
+ */
5173
+ export interface BizTaskInfo {
5174
+ /**
5175
+ * 任务id
5176
+ */
5177
+ ID?: number
5178
+ /**
5179
+ * 用户appid
5180
+ */
5181
+ AppId?: number
5182
+ /**
5183
+ * 集群id
5184
+ */
5185
+ ClusterId?: string
5186
+ /**
5187
+ * 地域
5188
+ 注意:此字段可能返回 null,表示取不到有效值。
5189
+ */
5190
+ Region?: string
5191
+ /**
5192
+ * 任务创建时间
5193
+ */
5194
+ CreateTime?: string
5195
+ /**
5196
+ * 延迟执行时间
5197
+ 注意:此字段可能返回 null,表示取不到有效值。
5198
+ */
5199
+ DelayTime?: string
5200
+ /**
5201
+ * 任务失败信息
5202
+ 注意:此字段可能返回 null,表示取不到有效值。
5203
+ */
5204
+ ErrMsg?: string
5205
+ /**
5206
+ * 异步任务流id
5207
+ */
5208
+ FlowId?: number
5209
+ /**
5210
+ * 任务输入信息
5211
+ */
5212
+ Input?: string
5213
+ /**
5214
+ * 实例组id
5215
+ * @deprecated
5216
+ */
5217
+ InstanceGrpId?: string
5218
+ /**
5219
+ * 实例组id
5220
+ */
5221
+ InstanceGroupId?: string
5222
+ /**
5223
+ * 实例id
5224
+ */
5225
+ InstanceId?: string
5226
+ /**
5227
+ * 任务操作对象id
5228
+ */
5229
+ ObjectId?: string
5230
+ /**
5231
+ * 任务操作对象类型
5232
+ */
5233
+ ObjectType?: string
5234
+ /**
5235
+ * 操作者uin
5236
+ */
5237
+ Operator?: string
5238
+ /**
5239
+ * 任务输出信息
5240
+ */
5241
+ Output?: string
5242
+ /**
5243
+ * 任务状态
5244
+ */
5245
+ Status?: string
5246
+ /**
5247
+ * 任务类型
5248
+ */
5249
+ TaskType?: string
5250
+ /**
5251
+ * 触发本任务的父任务ID
5252
+ */
5253
+ TriggerTaskId?: number
5254
+ /**
5255
+ * 更新时间
5256
+ */
5257
+ UpdateTime?: string
5258
+ /**
5259
+ * 任务开始时间
5260
+ */
5261
+ StartTime?: string
5262
+ /**
5263
+ * 任务结束时间
5264
+ */
5265
+ EndTime?: string
5266
+ /**
5267
+ * 集群名称
5268
+ */
5269
+ ClusterName?: string
5270
+ /**
5271
+ * 实例名称
5272
+ */
5273
+ InstanceName?: string
5274
+ /**
5275
+ * 任务进度
5276
+ */
5277
+ Process?: number
5278
+ /**
5279
+ * 修改参数任务信息
5280
+ 注意:此字段可能返回 null,表示取不到有效值。
5281
+ */
5282
+ ModifyParamsData?: Array<ModifyParamsData>
5283
+ /**
5284
+ * 创建集群任务信息
5285
+ 注意:此字段可能返回 null,表示取不到有效值。
5286
+ */
5287
+ CreateClustersData?: CreateClustersData
5288
+ /**
5289
+ * 集群回档任务信息
5290
+ 注意:此字段可能返回 null,表示取不到有效值。
5291
+ */
5292
+ RollbackData?: RollbackData
5293
+ /**
5294
+ * 实例变配任务信息
5295
+ 注意:此字段可能返回 null,表示取不到有效值。
5296
+ */
5297
+ ModifyInstanceData?: ModifyInstanceData
5298
+ /**
5299
+ * 手动备份任务信息
5300
+ 注意:此字段可能返回 null,表示取不到有效值。
5301
+ */
5302
+ ManualBackupData?: ManualBackupData
5303
+ /**
5304
+ * 修改内核版本任务信息
5305
+ 注意:此字段可能返回 null,表示取不到有效值。
5306
+ */
5307
+ ModifyDbVersionData?: ModifyDbVersionData
5308
+ /**
5309
+ * 集群可用区信息
5310
+ 注意:此字段可能返回 null,表示取不到有效值。
5311
+ */
5312
+ ClusterSlaveData?: ClusterSlaveData
5313
+ /**
5314
+ * 转换集群日志
5315
+ 注意:此字段可能返回 null,表示取不到有效值。
5316
+ */
5317
+ SwitchClusterLogBin?: SwitchClusterLogBin
5318
+ /**
5319
+ * 修改实例参数数据
5320
+ 注意:此字段可能返回 null,表示取不到有效值。
5321
+ */
5322
+ ModifyInstanceParamsData?: BizTaskModifyParamsData
5323
+ /**
5324
+ * 维护时间
5325
+ 注意:此字段可能返回 null,表示取不到有效值。
5326
+ */
5327
+ TaskMaintainInfo?: TaskMaintainInfo
5328
+ /**
5329
+ * 实例日志投递信息
5330
+
5331
+ 注意:此字段可能返回 null,表示取不到有效值。
5332
+ */
5333
+ InstanceCLSDeliveryInfos?: Array<InstanceCLSDeliveryInfo>
5334
+ }
5335
+
5114
5336
  /**
5115
5337
  * DescribeRollbackTimeRange请求参数结构体
5116
5338
  */
@@ -5548,6 +5770,16 @@ export interface Account {
5548
5770
  MaxUserConnections: number
5549
5771
  }
5550
5772
 
5773
+ /**
5774
+ * ModifyResourcePackagesDeductionPriority返回参数结构体
5775
+ */
5776
+ export interface ModifyResourcePackagesDeductionPriorityResponse {
5777
+ /**
5778
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5779
+ */
5780
+ RequestId?: string
5781
+ }
5782
+
5551
5783
  /**
5552
5784
  * CloseWan请求参数结构体
5553
5785
  */
@@ -6041,169 +6273,21 @@ export interface RollBackClusterRequest {
6041
6273
  }
6042
6274
 
6043
6275
  /**
6044
- * 任务信息
6276
+ * ModifyResourcePackagesDeductionPriority请求参数结构体
6045
6277
  */
6046
- export interface BizTaskInfo {
6047
- /**
6048
- * 任务id
6049
- */
6050
- ID?: number
6051
- /**
6052
- * 用户appid
6053
- */
6054
- AppId?: number
6055
- /**
6056
- * 集群id
6057
- */
6058
- ClusterId?: string
6278
+ export interface ModifyResourcePackagesDeductionPriorityRequest {
6059
6279
  /**
6060
- * 地域
6061
- 注意:此字段可能返回 null,表示取不到有效值。
6280
+ * 需要修改优先级的资源包类型,CCU:计算资源包,DISK:存储资源包
6062
6281
  */
6063
- Region?: string
6064
- /**
6065
- * 任务创建时间
6066
- */
6067
- CreateTime?: string
6068
- /**
6069
- * 延迟执行时间
6070
- 注意:此字段可能返回 null,表示取不到有效值。
6071
- */
6072
- DelayTime?: string
6073
- /**
6074
- * 任务失败信息
6075
- 注意:此字段可能返回 null,表示取不到有效值。
6076
- */
6077
- ErrMsg?: string
6078
- /**
6079
- * 异步任务流id
6080
- */
6081
- FlowId?: number
6082
- /**
6083
- * 任务输入信息
6084
- */
6085
- Input?: string
6086
- /**
6087
- * 实例组id
6088
- * @deprecated
6089
- */
6090
- InstanceGrpId?: string
6091
- /**
6092
- * 实例组id
6093
- */
6094
- InstanceGroupId?: string
6095
- /**
6096
- * 实例id
6097
- */
6098
- InstanceId?: string
6099
- /**
6100
- * 任务操作对象id
6101
- */
6102
- ObjectId?: string
6103
- /**
6104
- * 任务操作对象类型
6105
- */
6106
- ObjectType?: string
6107
- /**
6108
- * 操作者uin
6109
- */
6110
- Operator?: string
6111
- /**
6112
- * 任务输出信息
6113
- */
6114
- Output?: string
6115
- /**
6116
- * 任务状态
6117
- */
6118
- Status?: string
6119
- /**
6120
- * 任务类型
6121
- */
6122
- TaskType?: string
6123
- /**
6124
- * 触发本任务的父任务ID
6125
- */
6126
- TriggerTaskId?: number
6127
- /**
6128
- * 更新时间
6129
- */
6130
- UpdateTime?: string
6131
- /**
6132
- * 任务开始时间
6133
- */
6134
- StartTime?: string
6135
- /**
6136
- * 任务结束时间
6137
- */
6138
- EndTime?: string
6139
- /**
6140
- * 集群名称
6141
- */
6142
- ClusterName?: string
6143
- /**
6144
- * 实例名称
6145
- */
6146
- InstanceName?: string
6147
- /**
6148
- * 任务进度
6149
- */
6150
- Process?: number
6151
- /**
6152
- * 修改参数任务信息
6153
- 注意:此字段可能返回 null,表示取不到有效值。
6154
- */
6155
- ModifyParamsData?: Array<ModifyParamsData>
6156
- /**
6157
- * 创建集群任务信息
6158
- 注意:此字段可能返回 null,表示取不到有效值。
6159
- */
6160
- CreateClustersData?: CreateClustersData
6161
- /**
6162
- * 集群回档任务信息
6163
- 注意:此字段可能返回 null,表示取不到有效值。
6164
- */
6165
- RollbackData?: RollbackData
6166
- /**
6167
- * 实例变配任务信息
6168
- 注意:此字段可能返回 null,表示取不到有效值。
6169
- */
6170
- ModifyInstanceData?: ModifyInstanceData
6171
- /**
6172
- * 手动备份任务信息
6173
- 注意:此字段可能返回 null,表示取不到有效值。
6174
- */
6175
- ManualBackupData?: ManualBackupData
6176
- /**
6177
- * 修改内核版本任务信息
6178
- 注意:此字段可能返回 null,表示取不到有效值。
6179
- */
6180
- ModifyDbVersionData?: ModifyDbVersionData
6181
- /**
6182
- * 集群可用区信息
6183
- 注意:此字段可能返回 null,表示取不到有效值。
6184
- */
6185
- ClusterSlaveData?: ClusterSlaveData
6186
- /**
6187
- * 转换集群日志
6188
- 注意:此字段可能返回 null,表示取不到有效值。
6189
- */
6190
- SwitchClusterLogBin?: SwitchClusterLogBin
6282
+ PackageType: string
6191
6283
  /**
6192
- * 修改实例参数数据
6193
- 注意:此字段可能返回 null,表示取不到有效值。
6284
+ * 修改后的抵扣优先级对于哪个cynos资源生效
6194
6285
  */
6195
- ModifyInstanceParamsData?: BizTaskModifyParamsData
6286
+ ClusterId: string
6196
6287
  /**
6197
- * 维护时间
6198
- 注意:此字段可能返回 null,表示取不到有效值。
6288
+ * 资源包抵扣优先级
6199
6289
  */
6200
- TaskMaintainInfo?: TaskMaintainInfo
6201
- /**
6202
- * 实例日志投递信息
6203
-
6204
- 注意:此字段可能返回 null,表示取不到有效值。
6205
- */
6206
- InstanceCLSDeliveryInfos?: Array<InstanceCLSDeliveryInfo>
6290
+ DeductionPriorities: Array<PackagePriority>
6207
6291
  }
6208
6292
 
6209
6293
  /**
@@ -7952,17 +8036,17 @@ export interface ModifyResourcePackageClustersResponse {
7952
8036
  }
7953
8037
 
7954
8038
  /**
7955
- * 回档数据库及表
8039
+ * 账号,包含accountName和host
7956
8040
  */
7957
- export interface RollbackTable {
8041
+ export interface InputAccount {
7958
8042
  /**
7959
- * 数据库名称
8043
+ * 账号
7960
8044
  */
7961
- Database: string
8045
+ AccountName: string
7962
8046
  /**
7963
- * 数据库表
8047
+ * 主机,默认‘%’
7964
8048
  */
7965
- Tables: Array<RollbackTableInfo>
8049
+ Host?: string
7966
8050
  }
7967
8051
 
7968
8052
  /**
@@ -8367,6 +8451,20 @@ export interface DescribeAuditLogsResponse {
8367
8451
  RequestId?: string
8368
8452
  }
8369
8453
 
8454
+ /**
8455
+ * 资源包抵扣优先级
8456
+ */
8457
+ export interface PackagePriority {
8458
+ /**
8459
+ * 需要自定义抵扣优先级的资源包
8460
+ */
8461
+ PackageId?: string
8462
+ /**
8463
+ * 自定义的抵扣优先级
8464
+ */
8465
+ DeductionPriority?: number
8466
+ }
8467
+
8370
8468
  /**
8371
8469
  * ModifyAccountDescription返回参数结构体
8372
8470
  */
@@ -5002,6 +5002,14 @@ export interface RestartNodesRequest {
5002
5002
  * cvm延迟上架时间
5003
5003
  */
5004
5004
  CvmDelayOnlineTime?: number
5005
+ /**
5006
+ * 分片迁移并发数
5007
+ */
5008
+ ShardAllocationConcurrents?: number
5009
+ /**
5010
+ * 分片迁移并发速度
5011
+ */
5012
+ ShardAllocationBytes?: number
5005
5013
  }
5006
5014
 
5007
5015
  /**
@@ -5074,6 +5082,14 @@ export interface UpgradeInstanceRequest {
5074
5082
  * cvm延迟上架参数
5075
5083
  */
5076
5084
  CvmDelayOnlineTime?: number
5085
+ /**
5086
+ * 分片迁移并发数
5087
+ */
5088
+ ShardAllocationConcurrents?: number
5089
+ /**
5090
+ * 分片迁移并发速度
5091
+ */
5092
+ ShardAllocationBytes?: number
5077
5093
  }
5078
5094
 
5079
5095
  /**
@@ -385,14 +385,18 @@ export class Client extends AbstractClient {
385
385
  }
386
386
 
387
387
  /**
388
- * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
388
+ * 本接口(CreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
389
389
  1. 创建印章
390
390
  2. 创建模板
391
391
  3. 修改模板
392
392
  4. 预览模板
393
393
  5. 预览合同流程
394
394
 
395
- 用户可以通过这些链接快速将其集成到自己的系统中。
395
+ 预览模板的嵌入页面长相如下:
396
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
397
+
398
+ 预览合同流程的嵌入页面长相如下:
399
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
396
400
  */
397
401
  async CreateEmbedWebUrl(
398
402
  req: CreateEmbedWebUrlRequest,
@@ -1202,17 +1206,20 @@ export class Client extends AbstractClient {
1202
1206
  }
1203
1207
 
1204
1208
  /**
1205
- * 在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
1206
- 1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
1207
- 2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
1209
+ * 在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:
1210
+ 1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
1211
+ 2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。
1212
+
1213
+ 此接口存在以下限制:
1214
+ 1. 执行操作的员工须为<font color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
1215
+ 2. 延长整个签署流程时,<font color="red">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
1216
+ 3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。
1217
+ 4. 延长签署方截止时间时,<font color="red">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
1218
+ 5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
1219
+ 6. <font color="red">不支持操作合同组合同</font>。
1208
1220
 
1209
- 此接口有如下限制条件:
1210
- 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
1211
- 2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。
1212
- 3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
1213
- 4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
1214
- 5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
1215
- 6. 不支持操作合同组合同。
1221
+ 合同(流程)层面 截止时间控制台展示的位置:
1222
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/265b130136bf6e8f01f5880438467dfb.png)
1216
1223
  */
1217
1224
  async ModifyFlowDeadline(
1218
1225
  req: ModifyFlowDeadlineRequest,
@@ -1635,9 +1642,12 @@ p.s.
1635
1642
  }
1636
1643
 
1637
1644
  /**
1638
- * 创建发起流程web页面
1639
- <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
1640
- <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
1645
+ * 创建发起流程Web页面,通过该接口可以获取发起流程的可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。在页面上完成签署控件等信息的编辑与确认后,可快速发起流程。
1646
+
1647
+ <br/>注意:调用接口后,<font color="red">流程不会立即发起,需在嵌入页面上点击【发起合同】按钮来发起流程</font>。
1648
+
1649
+ 嵌入页面长相如下:
1650
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
1641
1651
  */
1642
1652
  async CreatePrepareFlow(
1643
1653
  req: CreatePrepareFlowRequest,
@@ -1775,11 +1785,17 @@ p.s.
1775
1785
 
1776
1786
  /**
1777
1787
  * 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
1778
- 附注:
1779
- - 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。
1780
- - 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
1781
- - 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。
1782
- - 支持待签署、待填写状态的合同生成签署链接。
1788
+
1789
+ 注:
1790
+ <ul>
1791
+ <li>员工必须需作为批量签署合同的签署方,或者是或签合同的候选人之一。</li>
1792
+ <li><b>本方企业签署链接</b>:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。</li>
1793
+ <li><b>他方企业签署链接</b>:传RecipientIds,且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。(<b>如果签署人没有加入对方企业则会引导加入;如果对方企业还没有注册认证,会引导企业注册和认证</b>)</li>
1794
+ <li>只支持待签署、待填写状态的合同生成签署链接。</li>
1795
+ </ul>
1796
+
1797
+ 签署的嵌入页面长相如下:
1798
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
1783
1799
  */
1784
1800
  async CreateOrganizationBatchSignUrl(
1785
1801
  req: CreateOrganizationBatchSignUrlRequest,
@@ -4882,7 +4882,7 @@ export interface FlowCreateApprover {
4882
4882
  * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
4883
4883
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
4884
4884
  <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
4885
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
4885
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>
4886
4886
  注:
4887
4887
  <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
4888
4888
  <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
@@ -5497,7 +5497,7 @@ p.s. 如果上传授权书 ,需遵循以下条件
5497
5497
  export interface CreateEmbedWebUrlRequest {
5498
5498
  /**
5499
5499
  * 执行本接口操作的员工信息。
5500
- <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5500
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5501
5501
  */
5502
5502
  Operator: UserInfo
5503
5503
  /**
@@ -5535,17 +5535,7 @@ export interface CreateEmbedWebUrlRequest {
5535
5535
  */
5536
5536
  Option?: EmbedUrlOption
5537
5537
  /**
5538
- * 用户自定义参数
5539
- <ul>
5540
- <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
5541
- <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li>
5542
- <li>支持的格式:json字符串的BASE64编码字符串</li>
5543
- <li>示例:<ul>
5544
- <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li>
5545
- <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li>
5546
- </ul>
5547
- </li>
5548
- </ul>
5538
+ * <ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li> <li>支持的格式:json字符串的BASE64编码字符串</li> <li>示例:<ul> <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li> <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li> </ul> </li> </ul>
5549
5539
  */
5550
5540
  UserData?: string
5551
5541
  }
@@ -6394,7 +6384,7 @@ export interface ApproverInfo {
6394
6384
  * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
6395
6385
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
6396
6386
  <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
6397
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
6387
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>
6398
6388
 
6399
6389
  默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
6400
6390
 
@@ -6896,8 +6886,11 @@ export interface CreateOrganizationBatchSignUrlRequest {
6896
6886
  * 员工在腾讯电子签平台的独特身份标识,为32位字符串。
6897
6887
  您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
6898
6888
  UserId必须是传入合同(FlowId)中的签署人。
6899
- - 1. 若UserId为空,Name和Mobile 必须提供。
6900
- - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
6889
+
6890
+ <ul>
6891
+ <li>1. 若UserId为空,Name和Mobile 必须提供。</li>
6892
+ <li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>
6893
+ </ul>
6901
6894
  */
6902
6895
  UserId?: string
6903
6896
  /**