tencentcloud-sdk-nodejs 4.0.963 → 4.0.964

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 (78) hide show
  1. package/CHANGELOG.md +617 -0
  2. package/SERVICE_CHANGELOG.md +926 -779
  3. package/package.json +1 -1
  4. package/products.md +24 -24
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ccc/v20200210/ccc_models.ts +8 -8
  7. package/src/services/cfw/v20190904/cfw_client.ts +1 -16
  8. package/src/services/cfw/v20190904/cfw_models.ts +92 -181
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +4 -4
  10. package/src/services/csip/v20221121/csip_client.ts +1 -0
  11. package/src/services/csip/v20221121/csip_models.ts +85 -10
  12. package/src/services/cwp/v20180228/cwp_client.ts +4 -2
  13. package/src/services/cwp/v20180228/cwp_models.ts +467 -448
  14. package/src/services/cynosdb/v20190107/cynosdb_client.ts +6 -6
  15. package/src/services/cynosdb/v20190107/cynosdb_models.ts +9 -9
  16. package/src/services/dasb/v20191018/dasb_models.ts +21 -4
  17. package/src/services/ess/v20201111/ess_client.ts +18 -4
  18. package/src/services/ess/v20201111/ess_models.ts +0 -1
  19. package/src/services/essbasic/v20210526/essbasic_client.ts +46 -43
  20. package/src/services/essbasic/v20210526/essbasic_models.ts +2 -3
  21. package/src/services/ioa/v20220601/ioa_client.ts +35 -17
  22. package/src/services/ioa/v20220601/ioa_models.ts +583 -389
  23. package/src/services/ms/v20180408/ms_models.ts +5 -5
  24. package/src/services/ocr/v20181119/ocr_client.ts +1 -0
  25. package/src/services/ocr/v20181119/ocr_models.ts +5 -5
  26. package/src/services/smop/v20201203/smop_models.ts +17 -17
  27. package/src/services/ssm/v20190923/ssm_models.ts +31 -3
  28. package/src/services/tcss/v20201101/tcss_client.ts +2 -1
  29. package/src/services/tcss/v20201101/tcss_models.ts +896 -748
  30. package/src/services/tdmq/v20200217/tdmq_models.ts +3 -3
  31. package/src/services/tem/v20210701/tem_models.ts +104 -104
  32. package/src/services/trp/v20210515/trp_models.ts +34 -34
  33. package/src/services/tse/v20201207/tse_client.ts +279 -267
  34. package/src/services/tse/v20201207/tse_models.ts +4451 -4419
  35. package/src/services/vpc/v20170312/vpc_models.ts +12 -2
  36. package/tencentcloud/common/sdk_version.d.ts +1 -1
  37. package/tencentcloud/common/sdk_version.js +1 -1
  38. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +8 -8
  39. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +1 -7
  40. package/tencentcloud/services/cfw/v20190904/cfw_client.js +0 -8
  41. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +92 -178
  42. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +4 -4
  43. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +84 -10
  44. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +3 -1
  45. package/tencentcloud/services/cwp/v20180228/cwp_client.js +3 -1
  46. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +467 -448
  47. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +6 -6
  48. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -6
  49. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +9 -9
  50. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +21 -4
  51. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +18 -4
  52. package/tencentcloud/services/ess/v20201111/ess_client.js +18 -4
  53. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +0 -1
  54. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +46 -43
  55. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +46 -43
  56. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +2 -3
  57. package/tencentcloud/services/ioa/v20220601/ioa_client.d.ts +8 -3
  58. package/tencentcloud/services/ioa/v20220601/ioa_client.js +9 -2
  59. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +567 -380
  60. package/tencentcloud/services/ms/v20180408/ms_models.d.ts +5 -5
  61. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -0
  62. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -0
  63. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +5 -5
  64. package/tencentcloud/services/smop/v20201203/smop_models.d.ts +17 -17
  65. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +31 -3
  66. package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +1 -1
  67. package/tencentcloud/services/tcss/v20201101/tcss_client.js +1 -1
  68. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +895 -748
  69. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +3 -3
  70. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +104 -104
  71. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +34 -34
  72. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +5 -1
  73. package/tencentcloud/services/tse/v20201207/tse_client.js +6 -0
  74. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +4373 -4343
  75. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +12 -2
  76. package/test/cfw.v20190904.test.js +0 -10
  77. package/test/ioa.v20220601.test.js +10 -0
  78. package/test/tse.v20201207.test.js +10 -0
@@ -96,7 +96,7 @@ export declare class Client extends AbstractClient {
96
96
  */
97
97
  DescribeInstanceSpecs(req: DescribeInstanceSpecsRequest, cb?: (error: string, rep: DescribeInstanceSpecsResponse) => void): Promise<DescribeInstanceSpecsResponse>;
98
98
  /**
99
- * 此接口(DescribeBinlogDownloadUrl)用于查询Binlog的下载地址。
99
+ * 本接口(DescribeBinlogDownloadUrl)用于查询 Binlog 的下载地址。
100
100
  */
101
101
  DescribeBinlogDownloadUrl(req: DescribeBinlogDownloadUrlRequest, cb?: (error: string, rep: DescribeBinlogDownloadUrlResponse) => void): Promise<DescribeBinlogDownloadUrlResponse>;
102
102
  /**
@@ -120,7 +120,7 @@ export declare class Client extends AbstractClient {
120
120
  */
121
121
  DisassociateSecurityGroups(req: DisassociateSecurityGroupsRequest, cb?: (error: string, rep: DisassociateSecurityGroupsResponse) => void): Promise<DisassociateSecurityGroupsResponse>;
122
122
  /**
123
- * 此接口(ExportInstanceSlowQueries)用于导出实例慢日志。
123
+ * 本接口(ExportInstanceSlowQueries)用于导出实例慢日志。
124
124
  */
125
125
  ExportInstanceSlowQueries(req: ExportInstanceSlowQueriesRequest, cb?: (error: string, rep: ExportInstanceSlowQueriesResponse) => void): Promise<ExportInstanceSlowQueriesResponse>;
126
126
  /**
@@ -216,7 +216,7 @@ export declare class Client extends AbstractClient {
216
216
  */
217
217
  UpgradeProxy(req: UpgradeProxyRequest, cb?: (error: string, rep: UpgradeProxyResponse) => void): Promise<UpgradeProxyResponse>;
218
218
  /**
219
- * 查询集群列表
219
+ * 本接口(DescribeClusters)用于查询集群列表。
220
220
  */
221
221
  DescribeClusters(req: DescribeClustersRequest, cb?: (error: string, rep: DescribeClustersResponse) => void): Promise<DescribeClustersResponse>;
222
222
  /**
@@ -524,11 +524,11 @@ export declare class Client extends AbstractClient {
524
524
  */
525
525
  ModifyAuditService(req: ModifyAuditServiceRequest, cb?: (error: string, rep: ModifyAuditServiceResponse) => void): Promise<ModifyAuditServiceResponse>;
526
526
  /**
527
- * 本接口(DescribeZones)用于查询可售卖地域可用区信息。
527
+ * 本接口(DescribeZones)用于查询可售卖地域可用区信息。
528
528
  */
529
529
  DescribeZones(req: DescribeZonesRequest, cb?: (error: string, rep: DescribeZonesResponse) => void): Promise<DescribeZonesResponse>;
530
530
  /**
531
- * 此接口(DescribeBackupDownloadUrl)用于查询集群备份文件下载地址。
531
+ * 本接口(DescribeBackupDownloadUrl)用于查询集群备份文件下载地址。
532
532
  */
533
533
  DescribeBackupDownloadUrl(req: DescribeBackupDownloadUrlRequest, cb?: (error: string, rep: DescribeBackupDownloadUrlResponse) => void): Promise<DescribeBackupDownloadUrlResponse>;
534
534
  /**
@@ -572,7 +572,7 @@ export declare class Client extends AbstractClient {
572
572
  */
573
573
  UpgradeInstance(req: UpgradeInstanceRequest, cb?: (error: string, rep: UpgradeInstanceResponse) => void): Promise<UpgradeInstanceResponse>;
574
574
  /**
575
- * 此接口(DescribeBinlogs)用来查询集群Binlog日志列表。
575
+ * 本接口(DescribeBinlogs)用来查询集群 Binlog 日志列表。
576
576
  */
577
577
  DescribeBinlogs(req: DescribeBinlogsRequest, cb?: (error: string, rep: DescribeBinlogsResponse) => void): Promise<DescribeBinlogsResponse>;
578
578
  /**
@@ -160,7 +160,7 @@ class Client extends abstract_client_1.AbstractClient {
160
160
  return this.request("DescribeInstanceSpecs", req, cb);
161
161
  }
162
162
  /**
163
- * 此接口(DescribeBinlogDownloadUrl)用于查询Binlog的下载地址。
163
+ * 本接口(DescribeBinlogDownloadUrl)用于查询 Binlog 的下载地址。
164
164
  */
165
165
  async DescribeBinlogDownloadUrl(req, cb) {
166
166
  return this.request("DescribeBinlogDownloadUrl", req, cb);
@@ -196,7 +196,7 @@ class Client extends abstract_client_1.AbstractClient {
196
196
  return this.request("DisassociateSecurityGroups", req, cb);
197
197
  }
198
198
  /**
199
- * 此接口(ExportInstanceSlowQueries)用于导出实例慢日志。
199
+ * 本接口(ExportInstanceSlowQueries)用于导出实例慢日志。
200
200
  */
201
201
  async ExportInstanceSlowQueries(req, cb) {
202
202
  return this.request("ExportInstanceSlowQueries", req, cb);
@@ -340,7 +340,7 @@ class Client extends abstract_client_1.AbstractClient {
340
340
  return this.request("UpgradeProxy", req, cb);
341
341
  }
342
342
  /**
343
- * 查询集群列表
343
+ * 本接口(DescribeClusters)用于查询集群列表。
344
344
  */
345
345
  async DescribeClusters(req, cb) {
346
346
  return this.request("DescribeClusters", req, cb);
@@ -802,13 +802,13 @@ class Client extends abstract_client_1.AbstractClient {
802
802
  return this.request("ModifyAuditService", req, cb);
803
803
  }
804
804
  /**
805
- * 本接口(DescribeZones)用于查询可售卖地域可用区信息。
805
+ * 本接口(DescribeZones)用于查询可售卖地域可用区信息。
806
806
  */
807
807
  async DescribeZones(req, cb) {
808
808
  return this.request("DescribeZones", req, cb);
809
809
  }
810
810
  /**
811
- * 此接口(DescribeBackupDownloadUrl)用于查询集群备份文件下载地址。
811
+ * 本接口(DescribeBackupDownloadUrl)用于查询集群备份文件下载地址。
812
812
  */
813
813
  async DescribeBackupDownloadUrl(req, cb) {
814
814
  return this.request("DescribeBackupDownloadUrl", req, cb);
@@ -874,7 +874,7 @@ class Client extends abstract_client_1.AbstractClient {
874
874
  return this.request("UpgradeInstance", req, cb);
875
875
  }
876
876
  /**
877
- * 此接口(DescribeBinlogs)用来查询集群Binlog日志列表。
877
+ * 本接口(DescribeBinlogs)用来查询集群 Binlog 日志列表。
878
878
  */
879
879
  async DescribeBinlogs(req, cb) {
880
880
  return this.request("DescribeBinlogs", req, cb);
@@ -808,7 +808,7 @@ export interface DescribeBinlogDownloadUrlResponse {
808
808
  /**
809
809
  * 下载地址
810
810
  */
811
- DownloadUrl: string;
811
+ DownloadUrl?: string;
812
812
  /**
813
813
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
814
814
  */
@@ -2916,12 +2916,12 @@ export interface DescribeBinlogsResponse {
2916
2916
  /**
2917
2917
  * 记录总条数
2918
2918
  */
2919
- TotalCount: number;
2919
+ TotalCount?: number;
2920
2920
  /**
2921
2921
  * Binlog列表
2922
2922
  注意:此字段可能返回 null,表示取不到有效值。
2923
2923
  */
2924
- Binlogs: Array<BinlogItem>;
2924
+ Binlogs?: Array<BinlogItem>;
2925
2925
  /**
2926
2926
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2927
2927
  */
@@ -6536,23 +6536,23 @@ export interface BinlogItem {
6536
6536
  /**
6537
6537
  * Binlog文件名称
6538
6538
  */
6539
- FileName: string;
6539
+ FileName?: string;
6540
6540
  /**
6541
6541
  * 文件大小,单位:字节
6542
6542
  */
6543
- FileSize: number;
6543
+ FileSize?: number;
6544
6544
  /**
6545
6545
  * 事务最早时间
6546
6546
  */
6547
- StartTime: string;
6547
+ StartTime?: string;
6548
6548
  /**
6549
6549
  * 事务最晚时间
6550
6550
  */
6551
- FinishTime: string;
6551
+ FinishTime?: string;
6552
6552
  /**
6553
6553
  * Binlog文件ID
6554
6554
  */
6555
- BinlogId: number;
6555
+ BinlogId?: number;
6556
6556
  }
6557
6557
  /**
6558
6558
  * ModifyProxyDesc请求参数结构体
@@ -6849,7 +6849,7 @@ export interface DescribeBackupDownloadUrlResponse {
6849
6849
  /**
6850
6850
  * 备份下载地址
6851
6851
  */
6852
- DownloadUrl: string;
6852
+ DownloadUrl?: string;
6853
6853
  /**
6854
6854
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6855
6855
  */
@@ -832,6 +832,11 @@ export interface CmdTemplate {
832
832
  * 命令列表,命令之间用换行符("\n")分隔
833
833
  */
834
834
  CmdList?: string;
835
+ /**
836
+ * 命令模板类型 1-内置 2-自定义
837
+ 注意:此字段可能返回 null,表示取不到有效值。
838
+ */
839
+ Type?: number;
835
840
  }
836
841
  /**
837
842
  * 命令执行检索结果
@@ -1154,6 +1159,10 @@ export interface ModifyCmdTemplateRequest {
1154
1159
  0:否,1:是
1155
1160
  */
1156
1161
  Encoding?: number;
1162
+ /**
1163
+ * 命令模板类型 1-内置模板 2-自定义模板
1164
+ */
1165
+ Type?: number;
1157
1166
  }
1158
1167
  /**
1159
1168
  * ModifyUserGroup返回参数结构体
@@ -1455,11 +1464,11 @@ export interface DescribeAclsResponse {
1455
1464
  /**
1456
1465
  * 访问权限总数
1457
1466
  */
1458
- TotalCount: number;
1467
+ TotalCount?: number;
1459
1468
  /**
1460
1469
  * 访问权限列表
1461
1470
  */
1462
- AclSet: Array<Acl>;
1471
+ AclSet?: Array<Acl>;
1463
1472
  /**
1464
1473
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1465
1474
  */
@@ -2818,11 +2827,11 @@ export interface DescribeCmdTemplatesResponse {
2818
2827
  /**
2819
2828
  * 命令模板列表
2820
2829
  */
2821
- CmdTemplateSet: Array<CmdTemplate>;
2830
+ CmdTemplateSet?: Array<CmdTemplate>;
2822
2831
  /**
2823
2832
  * 总记录数
2824
2833
  */
2825
- TotalCount: number;
2834
+ TotalCount?: number;
2826
2835
  /**
2827
2836
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2828
2837
  */
@@ -3150,6 +3159,10 @@ export interface DescribeCmdTemplatesRequest {
3150
3159
  * 命令模板名,模糊查询,最大长度64字符
3151
3160
  */
3152
3161
  Name?: string;
3162
+ /**
3163
+ * 命令模板类型 1-内置模板 2-自定义模板
3164
+ */
3165
+ Type?: number;
3153
3166
  /**
3154
3167
  * 分页偏移位置,默认值为0
3155
3168
  */
@@ -3996,6 +4009,10 @@ export interface DescribeAclsRequest {
3996
4009
  * 部门ID,用于过滤属于某个部门的访问权限
3997
4010
  */
3998
4011
  DepartmentId?: string;
4012
+ /**
4013
+ * 过滤数组
4014
+ */
4015
+ Filters?: Array<Filter>;
3999
4016
  }
4000
4017
  /**
4001
4018
  * AddDeviceGroupMembers请求参数结构体
@@ -209,9 +209,23 @@ export declare class Client extends AbstractClient {
209
209
  /**
210
210
  * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
211
211
 
212
- 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
212
+ - 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。
213
+ - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
214
+ - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
213
215
 
214
- 注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
216
+ <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
217
+
218
+ ### 1. 适用场景
219
+
220
+ 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
221
+
222
+
223
+ ### 2. 合同额度的扣减与返还
224
+ - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
225
+ - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
226
+ - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
227
+
228
+ ### 3.合同组暂不支持抄送功能
215
229
  */
216
230
  CreateFlowGroupByTemplates(req: CreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: CreateFlowGroupByTemplatesResponse) => void): Promise<CreateFlowGroupByTemplatesResponse>;
217
231
  /**
@@ -619,6 +633,7 @@ export declare class Client extends AbstractClient {
619
633
  **注**:用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
620
634
 
621
635
  **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
636
+
622
637
  **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowBriefs)接口来主动检查合同的签署状态。请仅在确认合同状态为“签署完成”后,进行文件的下载操作。
623
638
  */
624
639
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
@@ -643,7 +658,6 @@ export declare class Client extends AbstractClient {
643
658
 
644
659
  - **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。
645
660
  - **OPEN_SERVER_SIGN(企业自动签)**
646
- - **OVERSEA_SIGN(企业与港澳台居民签署合同)**
647
661
 
648
662
  注意: `在调用此接口以管理企业扩展服务时,操作者(入参中的Operator)必须是企业的超级管理员(超管)或法人`
649
663
 
@@ -1043,7 +1057,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1043
1057
 
1044
1058
  6.如果同时未指定了<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,则传参错误。
1045
1059
 
1046
- 7. 新加入的签署方<font color="red">平台不会发送短信</font>进行签署。请您生成相应的链接,并将其发送给该签署方以便完成签署过程。
1060
+ 7.新加入的签署方<font color="red">平台不会发送短信</font>通知。请您生成相应的链接,并将该链接发送给签署方以便完成签署过程。
1047
1061
 
1048
1062
  **限制条件**:
1049
1063
 
@@ -253,9 +253,23 @@ class Client extends abstract_client_1.AbstractClient {
253
253
  /**
254
254
  * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
255
255
 
256
- 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
256
+ - 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。
257
+ - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
258
+ - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
257
259
 
258
- 注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
260
+ <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
261
+
262
+ ### 1. 适用场景
263
+
264
+ 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
265
+
266
+
267
+ ### 2. 合同额度的扣减与返还
268
+ - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
269
+ - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
270
+ - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
271
+
272
+ ### 3.合同组暂不支持抄送功能
259
273
  */
260
274
  async CreateFlowGroupByTemplates(req, cb) {
261
275
  return this.request("CreateFlowGroupByTemplates", req, cb);
@@ -741,6 +755,7 @@ class Client extends abstract_client_1.AbstractClient {
741
755
  **注**:用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
742
756
 
743
757
  **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
758
+
744
759
  **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowBriefs)接口来主动检查合同的签署状态。请仅在确认合同状态为“签署完成”后,进行文件的下载操作。
745
760
  */
746
761
  async DescribeFileUrls(req, cb) {
@@ -769,7 +784,6 @@ class Client extends abstract_client_1.AbstractClient {
769
784
 
770
785
  - **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。
771
786
  - **OPEN_SERVER_SIGN(企业自动签)**
772
- - **OVERSEA_SIGN(企业与港澳台居民签署合同)**
773
787
 
774
788
  注意: `在调用此接口以管理企业扩展服务时,操作者(入参中的Operator)必须是企业的超级管理员(超管)或法人`
775
789
 
@@ -1217,7 +1231,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1217
1231
 
1218
1232
  6.如果同时未指定了<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId和<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowApprovers/" target="_blank">补充签署人接口入参</a>中的FlowId,则传参错误。
1219
1233
 
1220
- 7. 新加入的签署方<font color="red">平台不会发送短信</font>进行签署。请您生成相应的链接,并将其发送给该签署方以便完成签署过程。
1234
+ 7.新加入的签署方<font color="red">平台不会发送短信</font>通知。请您生成相应的链接,并将该链接发送给签署方以便完成签署过程。
1221
1235
 
1222
1236
  **限制条件**:
1223
1237
 
@@ -7677,7 +7677,6 @@ export interface ModifyExtendedServiceResponse {
7677
7677
 
7678
7678
  <ul>
7679
7679
  <li><strong>OPEN_SERVER_SIGN</strong>(企业自动签署)</li>
7680
- <li><strong>OVERSEA_SIGN</strong>(企业与港澳台居民签署合同)</li>
7681
7680
  </ul></li></li>
7682
7681
  </ul>
7683
7682
  */
@@ -44,7 +44,6 @@ export declare class Client extends AbstractClient {
44
44
  - **需要法人或者超管签署开通协议的情形:** 当需要开通以下企业拓展服务时, 系统将返回一个操作链接。贵方需要主动联系并通知企业的超级管理员(超管)或法人。由他们点击该链接,完成服务的开通操作。
45
45
  - **AUTO_SIGN(企业自动签)**
46
46
  - **DOWNLOAD_FLOW(授权渠道下载合同)**
47
- - **OVERSEA_SIGN(企业与港澳台居民签署合同)**
48
47
 
49
48
  注意: `在调用此接口以管理企业扩展服务时,操作者( Agent.ProxyOperator.OpenId)必须是企业的超级管理员(超管)或法人`
50
49
 
@@ -862,6 +861,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
862
861
  用户创建合同或者提交签署动作后,后台需要1~3秒的时间就进行合同PDF合成或者签名,为了确保您下载的是签署完成的完整合同文件,我们建议采取下面两种方式的一种来<font color="red"><b>确保PDF已经合成完成,然后在调用本接口</b></font>。
863
862
 
864
863
  **第一种**:请确保您的系统配置了[接收合同完成通知的回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign)功能。一旦所有参与方签署完毕,我们的系统将自动向您提供的回调地址发送完成通知。
864
+
865
865
  **第二种**:通过调用我们的[获取合同信息](https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo)接口来主动检查合同的签署状态。请仅在确认合同状态为“全部签署完成”后,进行文件的下载操作。
866
866
 
867
867
  ### 2. 有两种开通下载权限的途径。
@@ -874,6 +874,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
874
874
  **第二种**: 渠道方企业在**企业应用管理**的配置界面打开需要配置的应用,点击**应用扩展服务**开通此功能,需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
875
875
  注:
876
876
  1. `请注意如果第三方应用的子客主动关闭了渠道端下载渠道子客合同功能开关,那么渠道方开通了此功能也无法下载子客的合同文件`
877
+
877
878
  ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
878
879
  */
879
880
  DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
@@ -944,16 +945,21 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
944
945
  /**
945
946
  * 接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。
946
947
 
947
- 合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。
948
+ - 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。
949
+ - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
950
+ - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
948
951
 
949
- 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
952
+ <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
950
953
 
951
- **注**:
952
- <ul>
953
- <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
954
- <li>合同组暂不支持抄送功能</li>
955
- </ul>
956
954
 
955
+
956
+ ### 1. 适用场景
957
+
958
+ 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
959
+
960
+ ### 2. 发起方要求和签署方实名要求
961
+ - **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。
962
+ - **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。
957
963
  **可以作为发起方和签署方的角色列表**
958
964
  <table>
959
965
  <thead>
@@ -970,41 +976,38 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
970
976
  <td>第三方子企业A员工</td>
971
977
  <td>第三方子企业A员工</td>
972
978
  </tr>
973
-
974
979
  <tr>
975
980
  <td>场景二</td>
976
981
  <td>第三方子企业A员工</td>
977
- <td>第三方子企业B(不指定经办人)</td>
978
- </tr>
979
-
980
- <tr>
981
- <td>场景三</td>
982
- <td>第三方子企业A员工</td>
983
982
  <td>第三方子企业B员工</td>
984
983
  </tr>
985
984
 
986
985
  <tr>
987
- <td>场景四</td>
986
+ <td>场景三</td>
988
987
  <td>第三方子企业A员工</td>
989
988
  <td>个人/自然人</td>
990
989
  </tr>
991
990
 
992
991
  <tr>
993
- <td>场景五</td>
992
+ <td>场景四</td>
994
993
  <td>第三方子企业A员工</td>
995
994
  <td>SaaS平台企业员工</td>
996
995
  </tr>
997
996
  </tbody>
998
997
  </table>
999
998
 
1000
- **注**:
1001
- `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
999
+ ### 3. 签署方参数差异
1000
+ - 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。
1002
1001
 
1003
- `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
1002
+ ### 4. 合同额度的扣减与返还
1003
+ - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
1004
+ - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
1005
+ - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
1004
1006
 
1005
- `3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
1007
+ ### 5. 静默(自动)签署的限制
1008
+ - 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color="red">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。
1006
1009
 
1007
- `4. 静默(自动)签署不支持合同签署方存在填写功能`
1010
+ ### 6.合同组暂不支持抄送功能
1008
1011
  */
1009
1012
  ChannelCreateFlowGroupByTemplates(req: ChannelCreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByTemplatesResponse) => void): Promise<ChannelCreateFlowGroupByTemplatesResponse>;
1010
1013
  /**
@@ -1131,19 +1134,21 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
1131
1134
  /**
1132
1135
  * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
1133
1136
 
1134
- 合同组是将多个合同签署流程组织在一起,多个合同同时创建,每个签署方得到一个签署链接,`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`,只能作为一个整体签署。
1137
+ - 该接口允许通过选择多个模板一次性创建多个合同,这些合同被组织在一个合同组中。
1138
+ - 每个签署方将收到一个签署链接,通过这个链接可以访问并签署合同组中的所有合同。
1139
+ - 合同组中的合同必须作为一个整体进行签署,不能将合同组拆分成单独的合同进行逐一签署。
1135
1140
 
1136
- 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
1141
+ <img src="https://qcloudimg.tencent-cloud.cn/raw/a63074a0293c9ff5bf6c0bb74c0d3b20.png" width="400" />
1137
1142
 
1138
1143
 
1139
1144
 
1140
- **注**:
1141
- <ul>
1142
- <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
1143
- <li>合同组暂不支持抄送功能</li>
1144
- <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。</li>
1145
- </ul>
1145
+ ### 1. 适用场景
1146
+
1147
+ 该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
1146
1148
 
1149
+ ### 2. 发起方要求和签署方实名要求
1150
+ - **发起方要求**:作为合同发起方的第三方子企业A的员工必须进行实名认证。
1151
+ - **签署方要求**:签署方可以是多种身份(如第三方子企业的员工、个人、SaaS平台企业员工),其中企业和员工可以不进行实名认证。
1147
1152
  **可以作为发起方和签署方的角色列表**
1148
1153
  <table>
1149
1154
  <thead>
@@ -1164,37 +1169,35 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
1164
1169
  <tr>
1165
1170
  <td>场景二</td>
1166
1171
  <td>第三方子企业A员工</td>
1167
- <td>第三方子企业B(不指定经办人)</td>
1168
- </tr>
1169
-
1170
- <tr>
1171
- <td>场景三</td>
1172
- <td>第三方子企业A员工</td>
1173
1172
  <td>第三方子企业B员工</td>
1174
1173
  </tr>
1175
1174
 
1176
1175
  <tr>
1177
- <td>场景四</td>
1176
+ <td>场景三</td>
1178
1177
  <td>第三方子企业A员工</td>
1179
1178
  <td>个人/自然人</td>
1180
1179
  </tr>
1181
1180
 
1182
1181
  <tr>
1183
- <td>场景五</td>
1182
+ <td>场景四</td>
1184
1183
  <td>第三方子企业A员工</td>
1185
1184
  <td>SaaS平台企业员工</td>
1186
1185
  </tr>
1187
1186
  </tbody>
1188
1187
  </table>
1189
1188
 
1190
- **注**:
1191
- `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
1189
+ ### 3. 签署方参数差异
1190
+ - 根据签署方的不同类型(第三方子企业的员工、个人、SaaS平台企业员工),传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 `FlowApproverInfo` 结构体说明。
1192
1191
 
1193
- `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
1192
+ ### 4. 合同额度的扣减与返还
1193
+ - **扣减时机**:合同一旦发起,相关的合同额度就会被扣减,合同组下面的每个合同都要扣减一个合同额度。
1194
+ - **返还条件**:只有在合同被撤销且没有任何签署方签署过,或者只有自动签署的情况下,合同额度才会被返还。
1195
+ - **不返还的情况**:如果合同已过期、被拒签、签署完成或已解除,合同额度将不会被返还。
1194
1196
 
1195
- `3. 合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
1197
+ ### 5. 静默(自动)签署的限制
1198
+ - 在使用静默(自动)签署功能时,合同签署方不能有填写控件。<font color="red">此接口静默签(企业自动签)能力为白名单功能</font>,使用前请联系对接的客户经理沟通。
1196
1199
 
1197
- `4. 静默(自动)签署不支持合同签署方存在填写功能`
1200
+ ### 6.合同组暂不支持抄送功能
1198
1201
  */
1199
1202
  ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
1200
1203
  /**