tencentcloud-sdk-nodejs 4.0.452 → 4.0.454

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 (54) hide show
  1. package/CHANGELOG.md +216 -0
  2. package/SERVICE_CHANGELOG.md +229 -67
  3. package/package.json +1 -1
  4. package/products.md +13 -13
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/as/v20180419/as_models.ts +5 -5
  7. package/src/services/bsca/v20210811/bsca_models.ts +5 -0
  8. package/src/services/cdb/v20170320/cdb_models.ts +11 -1
  9. package/src/services/cloudstudio/v20210524/cloudstudio_models.ts +1 -1
  10. package/src/services/cls/v20201016/cls_client.ts +1 -1
  11. package/src/services/cls/v20201016/cls_models.ts +2 -2
  12. package/src/services/cpdp/v20190820/cpdp_client.ts +2 -2
  13. package/src/services/cpdp/v20190820/cpdp_models.ts +2 -2
  14. package/src/services/ess/v20201111/ess_client.ts +165 -120
  15. package/src/services/ess/v20201111/ess_models.ts +500 -175
  16. package/src/services/essbasic/v20210526/essbasic_client.ts +22 -6
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +225 -55
  18. package/src/services/teo/v20220901/teo_client.ts +6 -15
  19. package/src/services/teo/v20220901/teo_models.ts +294 -173
  20. package/src/services/tke/v20180525/tke_client.ts +2 -2
  21. package/src/services/tke/v20180525/tke_models.ts +1 -1
  22. package/src/services/vpc/v20170312/vpc_client.ts +12 -0
  23. package/src/services/vpc/v20170312/vpc_models.ts +31 -0
  24. package/tencentcloud/common/sdk_version.d.ts +1 -1
  25. package/tencentcloud/common/sdk_version.js +1 -1
  26. package/tencentcloud/services/as/v20180419/as_models.d.ts +5 -5
  27. package/tencentcloud/services/bsca/v20210811/bsca_models.d.ts +4 -0
  28. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +9 -1
  29. package/tencentcloud/services/cloudstudio/v20210524/cloudstudio_models.d.ts +1 -1
  30. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  31. package/tencentcloud/services/cls/v20201016/cls_client.js +1 -1
  32. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +2 -2
  33. package/tencentcloud/services/cpdp/v20190820/cpdp_client.d.ts +2 -2
  34. package/tencentcloud/services/cpdp/v20190820/cpdp_client.js +2 -2
  35. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +2 -2
  36. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +68 -56
  37. package/tencentcloud/services/ess/v20201111/ess_client.js +89 -71
  38. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +406 -128
  39. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -3
  40. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +8 -2
  41. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +192 -48
  42. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +1 -5
  43. package/tencentcloud/services/teo/v20220901/teo_client.js +0 -6
  44. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +250 -148
  45. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +2 -2
  46. package/tencentcloud/services/tke/v20180525/tke_client.js +2 -2
  47. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +1 -1
  48. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  49. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  50. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +27 -0
  51. package/test/ess.v20201111.test.js +64 -34
  52. package/test/essbasic.v20210526.test.js +10 -0
  53. package/test/teo.v20220901.test.js +0 -10
  54. package/test/vpc.v20170312.test.js +10 -0
@@ -1523,7 +1523,7 @@ export class Client extends AbstractClient {
1523
1523
  }
1524
1524
 
1525
1525
  /**
1526
- * 创建集群访问端口(独立集群开启内网/外网访问,托管集群支持开启内网访问)
1526
+ * 创建集群访问端口
1527
1527
  */
1528
1528
  async CreateClusterEndpoint(
1529
1529
  req: CreateClusterEndpointRequest,
@@ -1903,7 +1903,7 @@ export class Client extends AbstractClient {
1903
1903
  }
1904
1904
 
1905
1905
  /**
1906
- * 删除集群访问端口(独立集群开启内网/外网访问,托管集群支持开启内网访问)
1906
+ * 删除集群访问端口
1907
1907
  */
1908
1908
  async DeleteClusterEndpoint(
1909
1909
  req: DeleteClusterEndpointRequest,
@@ -5005,7 +5005,7 @@ export interface CreateClusterEndpointRequest {
5005
5005
  Domain?: string
5006
5006
 
5007
5007
  /**
5008
- * 使用的安全组,只有外网访问需要传递
5008
+ * 使用的安全组,只有外网访问需要传递(开启外网访问时必传)
5009
5009
  */
5010
5010
  SecurityGroup?: string
5011
5011
 
@@ -42,6 +42,7 @@ import {
42
42
  DisableCcnRoutesRequest,
43
43
  ModifyNatGatewayDestinationIpPortTranslationNatRuleResponse,
44
44
  ModifyIp6RuleResponse,
45
+ SetVpnGatewaysRenewFlagRequest,
45
46
  ModifyCcnRegionBandwidthLimitsTypeResponse,
46
47
  DescribeVpnGatewaysResponse,
47
48
  ModifyNetworkAclQuintupleEntriesRequest,
@@ -498,6 +499,7 @@ import {
498
499
  DisassociateDhcpIpWithAddressIpResponse,
499
500
  CreateVpcEndPointServiceResponse,
500
501
  ModifyNetworkAclAttributeRequest,
502
+ SetVpnGatewaysRenewFlagResponse,
501
503
  DeleteVpnGatewayResponse,
502
504
  DescribeHaVipsRequest,
503
505
  UnassignPrivateIpAddressesResponse,
@@ -1738,6 +1740,16 @@ export class Client extends AbstractClient {
1738
1740
  return this.request("RenewVpnGateway", req, cb)
1739
1741
  }
1740
1742
 
1743
+ /**
1744
+ * 设置VPNGW续费标记
1745
+ */
1746
+ async SetVpnGatewaysRenewFlag(
1747
+ req: SetVpnGatewaysRenewFlagRequest,
1748
+ cb?: (error: string, rep: SetVpnGatewaysRenewFlagResponse) => void
1749
+ ): Promise<SetVpnGatewaysRenewFlagResponse> {
1750
+ return this.request("SetVpnGatewaysRenewFlag", req, cb)
1751
+ }
1752
+
1741
1753
  /**
1742
1754
  * 本接口(DescribeDhcpIps)用于查询DhcpIp列表
1743
1755
  */
@@ -558,6 +558,27 @@ export interface ModifyIp6RuleResponse {
558
558
  RequestId?: string
559
559
  }
560
560
 
561
+ /**
562
+ * SetVpnGatewaysRenewFlag请求参数结构体
563
+ */
564
+ export interface SetVpnGatewaysRenewFlagRequest {
565
+ /**
566
+ * VPNGW字符型ID列表
567
+ */
568
+ VpnGatewayIds: Array<string>
569
+
570
+ /**
571
+ * 自动续费标记[0, 1, 2]
572
+ 0表示默认状态(初始状态), 1表示自动续费,2表示明确不自动续费
573
+ */
574
+ AutoRenewFlag: number
575
+
576
+ /**
577
+ * VPNGW类型['IPSEC', 'SSL']
578
+ */
579
+ Type?: string
580
+ }
581
+
561
582
  /**
562
583
  * ModifyCcnRegionBandwidthLimitsType返回参数结构体
563
584
  */
@@ -10766,6 +10787,16 @@ export interface ModifyNetworkAclAttributeRequest {
10766
10787
  NetworkAclName: string
10767
10788
  }
10768
10789
 
10790
+ /**
10791
+ * SetVpnGatewaysRenewFlag返回参数结构体
10792
+ */
10793
+ export interface SetVpnGatewaysRenewFlagResponse {
10794
+ /**
10795
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
10796
+ */
10797
+ RequestId?: string
10798
+ }
10799
+
10769
10800
  /**
10770
10801
  * DeleteVpnGateway返回参数结构体
10771
10802
  */
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.452";
1
+ export declare const sdkVersion = "4.0.454";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.452";
4
+ exports.sdkVersion = "4.0.454";
@@ -913,7 +913,7 @@ export interface DetachLoadBalancersRequest {
913
913
  */
914
914
  LoadBalancerIds?: Array<string>;
915
915
  /**
916
- * 应用型负载均衡器标识信息列表,列表长度上限为50,LoadBalancerIds 和 ForwardLoadBalancerIdentifications二者同时最多只能指定一个
916
+ * 应用型负载均衡器标识信息列表,列表长度上限为100,LoadBalancerIds 和 ForwardLoadBalancerIdentifications二者同时最多只能指定一个
917
917
  */
918
918
  ForwardLoadBalancerIdentifications?: Array<ForwardLoadBalancerIdentification>;
919
919
  }
@@ -954,7 +954,7 @@ export interface ModifyLoadBalancersRequest {
954
954
  */
955
955
  LoadBalancerIds?: Array<string>;
956
956
  /**
957
- * 应用型负载均衡器列表,目前长度上限为50,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
957
+ * 应用型负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
958
958
  */
959
959
  ForwardLoadBalancers?: Array<ForwardLoadBalancer>;
960
960
  /**
@@ -1740,7 +1740,7 @@ export interface CreateAutoScalingGroupRequest {
1740
1740
  */
1741
1741
  ProjectId?: number;
1742
1742
  /**
1743
- * 应用型负载均衡器列表,目前长度上限为50,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
1743
+ * 应用型负载均衡器列表,目前长度上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
1744
1744
  */
1745
1745
  ForwardLoadBalancers?: Array<ForwardLoadBalancer>;
1746
1746
  /**
@@ -2687,7 +2687,7 @@ export interface ModifyLoadBalancerTargetAttributesRequest {
2687
2687
  */
2688
2688
  AutoScalingGroupId: string;
2689
2689
  /**
2690
- * 需修改目标规则属性的应用型负载均衡器列表,列表长度上限为50
2690
+ * 需修改目标规则属性的应用型负载均衡器列表,列表长度上限为100
2691
2691
  */
2692
2692
  ForwardLoadBalancers: Array<ForwardLoadBalancer>;
2693
2693
  }
@@ -3010,7 +3010,7 @@ export interface AttachLoadBalancersRequest {
3010
3010
  */
3011
3011
  LoadBalancerIds?: Array<string>;
3012
3012
  /**
3013
- * 应用型负载均衡器列表,每个伸缩组绑定应用型负载均衡器数量上限为50,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
3013
+ * 应用型负载均衡器列表,每个伸缩组绑定应用型负载均衡器数量上限为100,LoadBalancerIds 和 ForwardLoadBalancers 二者同时最多只能指定一个
3014
3014
  */
3015
3015
  ForwardLoadBalancers?: Array<ForwardLoadBalancer>;
3016
3016
  }
@@ -6,6 +6,10 @@ export interface MatchKBPURLListResponse {
6
6
  * 组件列表。
7
7
  */
8
8
  PURLList: Array<PURL>;
9
+ /**
10
+ * 是否命中数据库。
11
+ */
12
+ Hit: boolean;
9
13
  /**
10
14
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
11
15
  */
@@ -520,6 +520,14 @@ export interface ModifyInstanceParamRequest {
520
520
  * 执行参数调整任务的方式,默认为 0。支持值包括:0 - 立刻执行,1 - 时间窗执行;当该值为 1 时,每次只能传一个实例(InstanceIds数量为1)
521
521
  */
522
522
  WaitSwitch?: number;
523
+ /**
524
+ * 参数是否同步到主实例下的只读实例。true 为不同步,false 为同步。默认为 false。
525
+ */
526
+ NotSyncRo?: boolean;
527
+ /**
528
+ * 参数是否同步到主实例下的灾备实例。true 为不同步,false 为同步。默认为 false。
529
+ */
530
+ NotSyncDr?: boolean;
523
531
  }
524
532
  /**
525
533
  * CreateParamTemplate请求参数结构体
@@ -7103,7 +7111,7 @@ export interface ModifyInstanceParamResponse {
7103
7111
  /**
7104
7112
  * 异步任务 ID,可用于查询任务进度。
7105
7113
  */
7106
- AsyncRequestId?: string;
7114
+ AsyncRequestId: string;
7107
7115
  /**
7108
7116
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7109
7117
  */
@@ -1072,7 +1072,7 @@ export interface RemoveWorkspaceResponse {
1072
1072
  RequestId?: string;
1073
1073
  }
1074
1074
  /**
1075
- * 云主机创建工作空间DTO
1075
+ * 云服务器创建工作空间 DTO
1076
1076
  */
1077
1077
  export interface AgentSpaceDTO {
1078
1078
  /**
@@ -145,7 +145,7 @@ export declare class Client extends AbstractClient {
145
145
  */
146
146
  DeleteAlarmNotice(req: DeleteAlarmNoticeRequest, cb?: (error: string, rep: DeleteAlarmNoticeResponse) => void): Promise<DeleteAlarmNoticeResponse>;
147
147
  /**
148
- * 本接口用于构建直方图
148
+ * 本接口用于构建日志数量直方图
149
149
  */
150
150
  DescribeLogHistogram(req: DescribeLogHistogramRequest, cb?: (error: string, rep: DescribeLogHistogramResponse) => void): Promise<DescribeLogHistogramResponse>;
151
151
  /**
@@ -233,7 +233,7 @@ class Client extends abstract_client_1.AbstractClient {
233
233
  return this.request("DeleteAlarmNotice", req, cb);
234
234
  }
235
235
  /**
236
- * 本接口用于构建直方图
236
+ * 本接口用于构建日志数量直方图
237
237
  */
238
238
  async DescribeLogHistogram(req, cb) {
239
239
  return this.request("DescribeLogHistogram", req, cb);
@@ -157,7 +157,7 @@ export interface DescribeLogHistogramRequest {
157
157
  */
158
158
  Query: string;
159
159
  /**
160
- * 时间间隔: 单位ms
160
+ * 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200
161
161
  */
162
162
  Interval?: number;
163
163
  }
@@ -1771,7 +1771,7 @@ export interface CreateTopicRequest {
1771
1771
  */
1772
1772
  StorageType?: string;
1773
1773
  /**
1774
- * 生命周期,单位天,可取值范围1~3600。取值为3640时代表永久保存
1774
+ * 生命周期,单位天,标准存储取值范围1~3600,低频存储取值范围7~3600天。取值为3640时代表永久保存
1775
1775
  */
1776
1776
  Period?: number;
1777
1777
  }
@@ -292,7 +292,7 @@ export declare class Client extends AbstractClient {
292
292
  */
293
293
  CreatePayMerchant(req: CreatePayMerchantRequest, cb?: (error: string, rep: CreatePayMerchantResponse) => void): Promise<CreatePayMerchantResponse>;
294
294
  /**
295
- * 云企付结算单查询结果
295
+ * 云企付-结算单查询结果
296
296
  */
297
297
  QueryOpenBankSettleOrder(req: QueryOpenBankSettleOrderRequest, cb?: (error: string, rep: QueryOpenBankSettleOrderResponse) => void): Promise<QueryOpenBankSettleOrderResponse>;
298
298
  /**
@@ -735,7 +735,7 @@ export declare class Client extends AbstractClient {
735
735
  */
736
736
  DistributeQueryReceiver(req: DistributeQueryReceiverRequest, cb?: (error: string, rep: DistributeQueryReceiverResponse) => void): Promise<DistributeQueryReceiverResponse>;
737
737
  /**
738
- * 云企付结算申请接口
738
+ * 云企付-结算申请接口
739
739
  */
740
740
  ApplyOpenBankSettleOrder(req: ApplyOpenBankSettleOrderRequest, cb?: (error: string, rep: ApplyOpenBankSettleOrderResponse) => void): Promise<ApplyOpenBankSettleOrderResponse>;
741
741
  /**
@@ -454,7 +454,7 @@ class Client extends abstract_client_1.AbstractClient {
454
454
  return this.request("CreatePayMerchant", req, cb);
455
455
  }
456
456
  /**
457
- * 云企付结算单查询结果
457
+ * 云企付-结算单查询结果
458
458
  */
459
459
  async QueryOpenBankSettleOrder(req, cb) {
460
460
  return this.request("QueryOpenBankSettleOrder", req, cb);
@@ -1113,7 +1113,7 @@ class Client extends abstract_client_1.AbstractClient {
1113
1113
  return this.request("DistributeQueryReceiver", req, cb);
1114
1114
  }
1115
1115
  /**
1116
- * 云企付结算申请接口
1116
+ * 云企付-结算申请接口
1117
1117
  */
1118
1118
  async ApplyOpenBankSettleOrder(req, cb) {
1119
1119
  return this.request("ApplyOpenBankSettleOrder", req, cb);
@@ -437,11 +437,11 @@ export interface QueryOpenBankPaymentOrderRequest {
437
437
  */
438
438
  ChannelMerchantId: string;
439
439
  /**
440
- * 外部商户订单号。与ChannelOrderId不能同时为空。
440
+ * 外部商户订单号。与ChannelOrderId不能同时为空。若传空串即表示忽略该参数。
441
441
  */
442
442
  OutOrderId: string;
443
443
  /**
444
- * 云平台订单号。与OutOrderId不能同时为空。
444
+ * 云平台订单号。与OutOrderId不能同时为空。若调用下单接口时,发生异常,无法取到ChannelOrderId,传空串即可
445
445
  */
446
446
  ChannelOrderId: string;
447
447
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, CreateFlowApproversResponse, DescribeFlowInfoRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, VerifyPdfRequest, VerifyPdfResponse, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, UploadFilesRequest, StartFlowResponse, GetTaskResultApiRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, DescribeFlowInfoResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse, CreateFlowApproversRequest } from "./ess_models";
3
+ import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, DeleteIntegrationEmployeesResponse, DeleteIntegrationEmployeesRequest, DescribeIntegrationEmployeesResponse, CreateFlowApproversResponse, DescribeFlowInfoRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, CreateIntegrationEmployeesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, VerifyPdfRequest, VerifyPdfResponse, CreateIntegrationEmployeesRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, UploadFilesRequest, DescribeFileUrlsRequest, StartFlowResponse, GetTaskResultApiRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, DescribeFlowInfoResponse, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse, CreateFlowApproversRequest } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -8,25 +8,44 @@ import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, Des
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
- * 验证合同文件
11
+ * 此接口用于发起流程
12
+ 适用场景:见创建签署流程接口。
13
+ 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
12
14
  */
13
- VerifyPdf(req: VerifyPdfRequest, cb?: (error: string, rep: VerifyPdfResponse) => void): Promise<VerifyPdfResponse>;
15
+ StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
16
+ /**
17
+ * 用于撤销签署流程
18
+ 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
19
+ 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
20
+ */
21
+ CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
22
+ /**
23
+ * 二期接口-查询模板
24
+ 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
25
+ */
26
+ DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
14
27
  /**
15
28
  * 查询文件下载URL
16
29
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
17
30
  */
18
31
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
19
32
  /**
20
- * 查询合同详情
21
- 适用场景:可用于主动查询某个合同详情信息。
33
+ * 验证合同文件
22
34
  */
23
- DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
35
+ VerifyPdf(req: VerifyPdfRequest, cb?: (error: string, rep: VerifyPdfResponse) => void): Promise<VerifyPdfResponse>;
24
36
  /**
25
- * 此接口用于发起流程
26
- 适用场景:见创建签署流程接口。
27
- 注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
37
+ * 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
38
+ 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
28
39
  */
29
- StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
40
+ CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
41
+ /**
42
+ * 补充签署流程本企业签署人信息
43
+ 适用场景:在通过模板或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
44
+ 同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
45
+
46
+ 注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
47
+ */
48
+ CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
30
49
  /**
31
50
  * 提交企业签署流程审批结果
32
51
  适用场景:
@@ -35,12 +54,6 @@ export declare class Client extends AbstractClient {
35
54
 
36
55
  */
37
56
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
38
- /**
39
- * 用于撤销签署流程
40
- 适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
41
- 注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
42
- */
43
- CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
44
57
  /**
45
58
  * 创建签署流程电子文档
46
59
  适用场景:见创建签署流程接口。
@@ -48,15 +61,10 @@ export declare class Client extends AbstractClient {
48
61
  */
49
62
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
50
63
  /**
51
- * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
52
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
53
- 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
54
- */
55
- CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
56
- /**
57
- * 通过AuthCode查询用户是否实名
64
+ * 查询合同详情
65
+ 适用场景:可用于主动查询某个合同详情信息。
58
66
  */
59
- DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
67
+ DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
60
68
  /**
61
69
  * 【描述】:创建出证报告,返回报告 URL
62
70
  【注意】:此接口需要通过添加白名单获取调用权限,请联系运营人员加白
@@ -76,59 +84,63 @@ export declare class Client extends AbstractClient {
76
84
  */
77
85
  CreateFlowByFiles(req: CreateFlowByFilesRequest, cb?: (error: string, rep: CreateFlowByFilesResponse) => void): Promise<CreateFlowByFilesResponse>;
78
86
  /**
79
- * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
80
- */
81
- CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
82
- /**
83
- * 获取小程序跳转链接
84
-
85
- 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
86
-
87
- 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
88
-
89
-
90
- 跳转到小程序的实现,参考官方文档(分为<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>两种方式)
91
-
92
-
93
- 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
87
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
88
+ 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
89
+ 适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
94
90
  */
95
- CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
91
+ CreateMultiFlowSignQRCode(req: CreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void): Promise<CreateMultiFlowSignQRCodeResponse>;
96
92
  /**
97
93
  * 查询转换任务状态
98
94
  */
99
95
  GetTaskResultApi(req: GetTaskResultApiRequest, cb?: (error: string, rep: GetTaskResultApiResponse) => void): Promise<GetTaskResultApiResponse>;
100
96
  /**
101
- * 创建文件转换任务
97
+ * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
102
98
  */
103
- CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
99
+ CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
104
100
  /**
105
- * 二期接口-查询模板
106
- 适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
101
+ * 查询员工信息,每次返回的数据量最大为20
107
102
  */
108
- DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
103
+ DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
109
104
  /**
110
- * 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
111
- 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
105
+ * 创建文件转换任务
112
106
  */
113
- CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
107
+ CreateConvertTaskApi(req: CreateConvertTaskApiRequest, cb?: (error: string, rep: CreateConvertTaskApiResponse) => void): Promise<CreateConvertTaskApiResponse>;
114
108
  /**
115
109
  * 查询流程摘要
116
110
  适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
117
111
  日调用量默认10W
118
112
  */
119
113
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
120
- /**
121
- * 补充签署流程本企业签署人信息
122
- 适用场景:在通过模板或者文件发起合同时,若未指定本企业签署人信息,则流程发起后,可以调用此接口补充签署人。
123
- 同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
124
-
125
- 注:目前暂时只支持补充来源于企业微信的员工作为候选签署人
126
- */
127
- CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
128
114
  /**
129
115
  * 此接口(UploadFiles)用于文件上传。
130
116
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
131
117
  调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
132
118
  */
133
119
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
120
+ /**
121
+ * 通过AuthCode查询用户是否实名
122
+ */
123
+ DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
124
+ /**
125
+ * 移除员工
126
+ */
127
+ DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
128
+ /**
129
+ * 获取小程序跳转链接
130
+
131
+ 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
132
+
133
+ 注:如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署。
134
+
135
+
136
+ 跳转到小程序的实现,参考官方文档(分为<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>两种方式)
137
+
138
+
139
+ 如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
140
+ */
141
+ CreateSchemeUrl(req: CreateSchemeUrlRequest, cb?: (error: string, rep: CreateSchemeUrlResponse) => void): Promise<CreateSchemeUrlResponse>;
142
+ /**
143
+ * 创建员工
144
+ */
145
+ CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
134
146
  }