tencentcloud-sdk-nodejs 4.0.425 → 4.0.428

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 (50) hide show
  1. package/CHANGELOG.md +430 -0
  2. package/SERVICE_CHANGELOG.md +266 -168
  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/cat/v20180409/cat_models.ts +6 -0
  7. package/src/services/cdn/v20180606/cdn_models.ts +0 -1
  8. package/src/services/cfs/v20190719/cfs_models.ts +37 -37
  9. package/src/services/cfw/v20190904/cfw_client.ts +19 -55
  10. package/src/services/cfw/v20190904/cfw_models.ts +48 -189
  11. package/src/services/ckafka/v20190819/ckafka_models.ts +30 -0
  12. package/src/services/ess/v20201111/ess_client.ts +12 -0
  13. package/src/services/ess/v20201111/ess_models.ts +30 -0
  14. package/src/services/essbasic/v20210526/essbasic_client.ts +132 -119
  15. package/src/services/essbasic/v20210526/essbasic_models.ts +65 -1
  16. package/src/services/faceid/v20180301/faceid_models.ts +20 -5
  17. package/src/services/monitor/v20180724/monitor_models.ts +4 -4
  18. package/src/services/ocr/v20181119/ocr_models.ts +20 -0
  19. package/src/services/teo/v20220106/teo_client.ts +146 -33
  20. package/src/services/teo/v20220106/teo_models.ts +1110 -358
  21. package/src/services/tts/v20190823/tts_client.ts +1 -1
  22. package/src/services/vpc/v20170312/vpc_models.ts +2 -0
  23. package/tencentcloud/common/sdk_version.d.ts +1 -1
  24. package/tencentcloud/common/sdk_version.js +1 -1
  25. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +5 -0
  26. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +0 -1
  27. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +37 -37
  28. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +7 -19
  29. package/tencentcloud/services/cfw/v20190904/cfw_client.js +9 -27
  30. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +36 -158
  31. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +24 -0
  32. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -1
  33. package/tencentcloud/services/ess/v20201111/ess_client.js +6 -0
  34. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +26 -0
  35. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +58 -54
  36. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +81 -75
  37. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +56 -1
  38. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +17 -5
  39. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -4
  40. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +16 -0
  41. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +39 -7
  42. package/tencentcloud/services/teo/v20220106/teo_client.js +57 -9
  43. package/tencentcloud/services/teo/v20220106/teo_models.d.ts +967 -309
  44. package/tencentcloud/services/tts/v20190823/tts_client.d.ts +1 -1
  45. package/tencentcloud/services/tts/v20190823/tts_client.js +1 -1
  46. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +2 -0
  47. package/test/cfw.v20190904.test.js +6 -36
  48. package/test/ess.v20201111.test.js +10 -0
  49. package/test/essbasic.v20210526.test.js +52 -42
  50. package/test/teo.v20220106.test.js +86 -6
@@ -624,58 +624,49 @@ export interface DescribeAssociatedInstanceListResponse {
624
624
  RequestId?: string;
625
625
  }
626
626
  /**
627
- * DescribeResourceGroup返回参数结构体
628
- */
629
- export interface DescribeResourceGroupResponse {
630
- /**
631
- * 返回树形结构
632
- */
633
- Data: string;
634
- /**
635
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
636
- */
637
- RequestId?: string;
638
- }
639
- /**
640
- * DescribeNatRuleOverview返回参数结构体
627
+ * 企业安全组关联实例信息
641
628
  */
642
- export interface DescribeNatRuleOverviewResponse {
629
+ export interface AssociatedInstanceInfo {
643
630
  /**
644
631
  * 实例ID
632
+ 注意:此字段可能返回 null,表示取不到有效值。
645
633
  */
646
- InstanceId?: string;
634
+ InstanceId: string;
647
635
  /**
648
636
  * 实例名称
637
+ 注意:此字段可能返回 null,表示取不到有效值。
649
638
  */
650
- InstanceName?: string;
651
- /**
652
- * 弹性IP列表
653
- */
654
- EipList?: Array<string>;
639
+ InstanceName: string;
655
640
  /**
656
- * 端口转发规则数量
641
+ * 实例类型,3是cvm实例,4是clb实例,5是eni实例,6是云数据库
642
+ 注意:此字段可能返回 null,表示取不到有效值。
657
643
  */
658
- DnatNum?: number;
644
+ Type: number;
659
645
  /**
660
- * 访问控制规则总数
646
+ * 私有网络ID
647
+ 注意:此字段可能返回 null,表示取不到有效值。
661
648
  */
662
- TotalNum?: number;
649
+ VpcId: string;
663
650
  /**
664
- * 访问控制规则剩余配额
651
+ * 私有网络名称
652
+ 注意:此字段可能返回 null,表示取不到有效值。
665
653
  */
666
- RemainNum?: number;
654
+ VpcName: string;
667
655
  /**
668
- * 阻断规则条数
656
+ * 公网IP
657
+ 注意:此字段可能返回 null,表示取不到有效值。
669
658
  */
670
- BlockNum?: number;
659
+ PublicIp: string;
671
660
  /**
672
- * 启用规则条数
661
+ * 内网IP
662
+ 注意:此字段可能返回 null,表示取不到有效值。
673
663
  */
674
- EnableNum?: number;
664
+ Ip: string;
675
665
  /**
676
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
666
+ * 关联安全组数量
667
+ 注意:此字段可能返回 null,表示取不到有效值。
677
668
  */
678
- RequestId?: string;
669
+ SecurityGroupCount: number;
679
670
  }
680
671
  /**
681
672
  * RemoveAcRule返回参数结构体
@@ -1454,15 +1445,6 @@ export interface DescribeAddrTemplateListResponse {
1454
1445
  */
1455
1446
  RequestId?: string;
1456
1447
  }
1457
- /**
1458
- * RunSyncAsset请求参数结构体
1459
- */
1460
- export interface RunSyncAssetRequest {
1461
- /**
1462
- * 0: 互联网防火墙开关,1:vpc 防火墙开关
1463
- */
1464
- Type?: number;
1465
- }
1466
1448
  /**
1467
1449
  * DescribeTLogIpList请求参数结构体
1468
1450
  */
@@ -2295,24 +2277,6 @@ export interface ModifySequenceRulesResponse {
2295
2277
  */
2296
2278
  RequestId?: string;
2297
2279
  }
2298
- /**
2299
- * DeleteSecurityGroupAllRule返回参数结构体
2300
- */
2301
- export interface DeleteSecurityGroupAllRuleResponse {
2302
- /**
2303
- * 0: 操作成功,非0:操作失败
2304
- */
2305
- Status?: number;
2306
- /**
2307
- * 返回数据的json字符串
2308
- 注意:此字段可能返回 null,表示取不到有效值。
2309
- */
2310
- Info?: number;
2311
- /**
2312
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2313
- */
2314
- RequestId?: string;
2315
- }
2316
2280
  /**
2317
2281
  * DescribeResourceGroupNew返回参数结构体
2318
2282
  */
@@ -2517,19 +2481,6 @@ export interface ModifyNatFwSwitchResponse {
2517
2481
  */
2518
2482
  RequestId?: string;
2519
2483
  }
2520
- /**
2521
- * RunSyncAsset返回参数结构体
2522
- */
2523
- export interface RunSyncAssetResponse {
2524
- /**
2525
- * 0:同步成功,1:资产更新中,2:后台同步调用失败
2526
- */
2527
- Status?: number;
2528
- /**
2529
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2530
- */
2531
- RequestId?: string;
2532
- }
2533
2484
  /**
2534
2485
  * DescribeBlockByIpTimesList返回参数结构体
2535
2486
  */
@@ -2759,34 +2710,6 @@ export interface DescribeIPStatusListResponse {
2759
2710
  */
2760
2711
  RequestId?: string;
2761
2712
  }
2762
- /**
2763
- * DescribeNatRuleOverview请求参数结构体
2764
- */
2765
- export interface DescribeNatRuleOverviewRequest {
2766
- /**
2767
- * 方向,0:出站,1:入站 默认值:0
2768
- */
2769
- Direction?: number;
2770
- /**
2771
- * NAT地域 这个是必填项,填入相关的英文,'ap-beijing-fsi': '北京金融',
2772
- 'ap-beijing': '北京',
2773
- 'ap-changsha-ec': '长沙EC',
2774
- 'ap-chengdu': '成都',
2775
- 'ap-chongqing': '重庆',
2776
- 'ap-fuzhou-ec': '福州EC',
2777
- 'ap-guangzhou-open': '广州Open',
2778
- 'ap-guangzhou': '广州',
2779
- 'ap-hangzhou-ec': '杭州EC',
2780
- 'ap-jinan-ec': '济南EC',
2781
- 'ap-nanjing': '南京',
2782
- 'ap-shanghai-fsi': '上海金融',
2783
- 'ap-shanghai': '上海',
2784
- 'ap-shenzhen-fsi': '深圳金融',
2785
- 'ap-shenzhen': '深圳',
2786
- 'ap-wuhan-ec': '武汉EC'
2787
- */
2788
- Area?: string;
2789
- }
2790
2713
  /**
2791
2714
  * CreateDatabaseWhiteListRules请求参数结构体
2792
2715
  */
@@ -2796,19 +2719,6 @@ export interface CreateDatabaseWhiteListRulesRequest {
2796
2719
  */
2797
2720
  DatabaseWhiteListRuleData: Array<DatabaseWhiteListRuleData>;
2798
2721
  }
2799
- /**
2800
- * DescribeResourceGroup请求参数结构体
2801
- */
2802
- export interface DescribeResourceGroupRequest {
2803
- /**
2804
- * 查询类型 网络结构 vpc,业务识别- resource ,资源标签-tag
2805
- */
2806
- QueryType: string;
2807
- /**
2808
- * 资产组id 全部传0
2809
- */
2810
- GroupId?: string;
2811
- }
2812
2722
  /**
2813
2723
  * Nat实例卡片详细信息
2814
2724
  */
@@ -2886,17 +2796,17 @@ export interface NatFwEipsInfo {
2886
2796
  NatGatewayName: string;
2887
2797
  }
2888
2798
  /**
2889
- * DeleteSecurityGroupAllRule请求参数结构体
2799
+ * DescribeResourceGroup返回参数结构体
2890
2800
  */
2891
- export interface DeleteSecurityGroupAllRuleRequest {
2801
+ export interface DescribeResourceGroupResponse {
2892
2802
  /**
2893
- * 方向,0:出站,1:入站
2803
+ * 返回树形结构
2894
2804
  */
2895
- Direction: number;
2805
+ Data: string;
2896
2806
  /**
2897
- * 腾讯云地域的英文简写
2807
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2898
2808
  */
2899
- Area: string;
2809
+ RequestId?: string;
2900
2810
  }
2901
2811
  /**
2902
2812
  * DescribeTLogIpList返回参数结构体
@@ -3769,49 +3679,17 @@ export interface DnsVpcSwitch {
3769
3679
  Status: number;
3770
3680
  }
3771
3681
  /**
3772
- * 企业安全组关联实例信息
3682
+ * DescribeResourceGroup请求参数结构体
3773
3683
  */
3774
- export interface AssociatedInstanceInfo {
3775
- /**
3776
- * 实例ID
3777
- 注意:此字段可能返回 null,表示取不到有效值。
3778
- */
3779
- InstanceId: string;
3780
- /**
3781
- * 实例名称
3782
- 注意:此字段可能返回 null,表示取不到有效值。
3783
- */
3784
- InstanceName: string;
3785
- /**
3786
- * 实例类型,3是cvm实例,4是clb实例,5是eni实例,6是云数据库
3787
- 注意:此字段可能返回 null,表示取不到有效值。
3788
- */
3789
- Type: number;
3790
- /**
3791
- * 私有网络ID
3792
- 注意:此字段可能返回 null,表示取不到有效值。
3793
- */
3794
- VpcId: string;
3795
- /**
3796
- * 私有网络名称
3797
- 注意:此字段可能返回 null,表示取不到有效值。
3798
- */
3799
- VpcName: string;
3800
- /**
3801
- * 公网IP
3802
- 注意:此字段可能返回 null,表示取不到有效值。
3803
- */
3804
- PublicIp: string;
3684
+ export interface DescribeResourceGroupRequest {
3805
3685
  /**
3806
- * 内网IP
3807
- 注意:此字段可能返回 null,表示取不到有效值。
3686
+ * 查询类型 网络结构 vpc,业务识别- resource ,资源标签-tag
3808
3687
  */
3809
- Ip: string;
3688
+ QueryType: string;
3810
3689
  /**
3811
- * 关联安全组数量
3812
- 注意:此字段可能返回 null,表示取不到有效值。
3690
+ * 资产组id 全部传0
3813
3691
  */
3814
- SecurityGroupCount: number;
3692
+ GroupId?: string;
3815
3693
  }
3816
3694
  /**
3817
3695
  * CreateAcRules请求参数结构体
@@ -5383,6 +5383,26 @@ export interface PostgreSQLParam {
5383
5383
  * 复制存量信息(never增量, initial全量),默认为initial
5384
5384
  */
5385
5385
  SnapshotMode?: string;
5386
+ /**
5387
+ * 上游数据格式(JSON/Debezium), 当数据库同步模式为默认字段匹配时,必填
5388
+ */
5389
+ DataFormat?: string;
5390
+ /**
5391
+ * "INSERT" 表示使用 Insert 模式插入,"UPSERT" 表示使用 Upsert 模式插入
5392
+ */
5393
+ DataTargetInsertMode?: string;
5394
+ /**
5395
+ * 当 "DataInsertMode"="UPSERT" 时,传入当前 upsert 时依赖的主键
5396
+ */
5397
+ DataTargetPrimaryKeyField?: string;
5398
+ /**
5399
+ * 表与消息间的映射关系
5400
+ */
5401
+ DataTargetRecordMapping?: Array<RecordMapping>;
5402
+ /**
5403
+ * 是否抛弃解析失败的消息,默认为true
5404
+ */
5405
+ DropInvalidMessage?: boolean;
5386
5406
  }
5387
5407
  /**
5388
5408
  * 统一返回的TopicResponse
@@ -6138,6 +6158,10 @@ export interface MySQLParam {
6138
6158
  * 如果该值为true,且MySQL中"binlog_rows_query_log_events"配置项的值为"ON",则流入到topic的数据包含原SQL语句;若该值为false,流入到topic的数据不包含原SQL语句
6139
6159
  */
6140
6160
  IncludeQuery?: boolean;
6161
+ /**
6162
+ * 如果该值为 true,则消息中会携带消息结构体对应的schema,如果该值为false则不会携带
6163
+ */
6164
+ RecordWithSchema?: boolean;
6141
6165
  }
6142
6166
  /**
6143
6167
  * DescribeTopicSyncReplica请求参数结构体
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CancelMultiFlowSignQRCodeRequest, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
3
+ import { CancelMultiFlowSignQRCodeRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentResponse, StartFlowRequest, CancelFlowResponse, CreateDocumentRequest, CreateFlowRequest, CreateSchemeUrlRequest, DescribeThirdPartyAuthCodeRequest, GetTaskResultApiRequest, UploadFilesRequest, CancelFlowRequest, DescribeFlowBriefsResponse, CreateMultiFlowSignQRCodeResponse, UploadFilesResponse, DescribeThirdPartyAuthCodeResponse, CreateFlowByFilesResponse, DescribeFlowBriefsRequest, DescribeFileUrlsRequest, CreateFlowSignReviewResponse, DescribeFlowTemplatesResponse, CreateFlowEvidenceReportRequest, CreateBatchCancelFlowUrlResponse, StartFlowResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateConvertTaskApiRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeFlowTemplatesRequest, GetTaskResultApiResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -48,6 +48,10 @@ export declare class Client extends AbstractClient {
48
48
  * 通过AuthCode查询用户是否实名
49
49
  */
50
50
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
51
+ /**
52
+ * 创建出证报告,返回报告 URL
53
+ */
54
+ CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
51
55
  /**
52
56
  * 创建签署流程
53
57
  适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
@@ -82,6 +82,12 @@ class Client extends abstract_client_1.AbstractClient {
82
82
  async DescribeThirdPartyAuthCode(req, cb) {
83
83
  return this.request("DescribeThirdPartyAuthCode", req, cb);
84
84
  }
85
+ /**
86
+ * 创建出证报告,返回报告 URL
87
+ */
88
+ async CreateFlowEvidenceReport(req, cb) {
89
+ return this.request("CreateFlowEvidenceReport", req, cb);
90
+ }
85
91
  /**
86
92
  * 创建签署流程
87
93
  适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
@@ -28,6 +28,19 @@ export interface CancelMultiFlowSignQRCodeRequest {
28
28
  */
29
29
  Agent?: Agent;
30
30
  }
31
+ /**
32
+ * CreateFlowEvidenceReport返回参数结构体
33
+ */
34
+ export interface CreateFlowEvidenceReportResponse {
35
+ /**
36
+ * 出证报告 URL(有效期5分钟)
37
+ */
38
+ ReportUrl: string;
39
+ /**
40
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
41
+ */
42
+ RequestId?: string;
43
+ }
31
44
  /**
32
45
  * DescribeFileUrls返回参数结构体
33
46
  */
@@ -985,6 +998,19 @@ export interface DescribeFlowTemplatesResponse {
985
998
  */
986
999
  RequestId?: string;
987
1000
  }
1001
+ /**
1002
+ * CreateFlowEvidenceReport请求参数结构体
1003
+ */
1004
+ export interface CreateFlowEvidenceReportRequest {
1005
+ /**
1006
+ * 调用方用户信息,userId 必填
1007
+ */
1008
+ Operator: UserInfo;
1009
+ /**
1010
+ * 签署流程编号
1011
+ */
1012
+ FlowId: string;
1013
+ }
988
1014
  /**
989
1015
  * CreateBatchCancelFlowUrl返回参数结构体
990
1016
  */
@@ -1,26 +1,12 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, UploadFilesRequest, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, PrepareFlowsResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, OperateChannelTemplateRequest, UploadFilesRequest, GetDownloadFlowUrlResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateMultiFlowSignQRCodeResponse, DescribeTemplatesResponse, OperateChannelTemplateResponse, CreateSignUrlsResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportRequest, DescribeFlowDetailInfoRequest, ChannelGetTaskResultApiResponse, ChannelGetTaskResultApiRequest, GetDownloadFlowUrlRequest, CreateConsoleLoginUrlRequest, CreateFlowsByTemplatesResponse, ChannelCreateFlowSignReviewRequest, PrepareFlowsRequest, SyncProxyOrganizationOperatorsResponse, CreateSealByImageResponse, DescribeTemplatesRequest, SyncProxyOrganizationOperatorsRequest, CreateConsoleLoginUrlResponse, CreateFlowsByTemplatesRequest, SyncProxyOrganizationRequest, CreateSealByImageRequest, DescribeUsageResponse, ChannelCreateBatchCancelFlowUrlResponse, DescribeResourceUrlsByFlowsRequest, ChannelCancelMultiFlowSignQRCodeRequest, CreateChannelFlowEvidenceReportResponse, PrepareFlowsResponse, DescribeUsageRequest, ChannelCreateBatchCancelFlowUrlRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowByFilesResponse, UploadFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelCreateConvertTaskApiRequest, ChannelCancelMultiFlowSignQRCodeResponse, DescribeFlowDetailInfoResponse } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
7
7
  */
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
- /**
11
- * 此接口(UploadFiles)用于文件上传。
12
- 调用时需要设置Domain 为 file.ess.tencent.cn
13
- */
14
- UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
15
- /**
16
- * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
17
-
18
- */
19
- CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
20
- /**
21
- * 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
22
- */
23
- DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
24
10
  /**
25
11
  * 提交企业签署流程审批结果
26
12
 
@@ -28,22 +14,6 @@ export declare class Client extends AbstractClient {
28
14
  若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
29
15
  */
30
16
  ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
31
- /**
32
- * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
33
- */
34
- DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
35
- /**
36
- * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
37
- 1、同步标识=select时:
38
- 返回渠道侧模板库当前模板的属性.
39
- 2、同步标识=update或者delete时:
40
- 对渠道子客进行模板库中模板授权,修改操作
41
- */
42
- OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
43
- /**
44
- * 此接口(SyncProxyOrganizationOperators)用于同步渠道合作企业经办人列表
45
- */
46
- SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
47
17
  /**
48
18
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫签署流程二维码。
49
19
  适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。
@@ -53,16 +23,6 @@ export declare class Client extends AbstractClient {
53
23
  * 接口(ChannelCreateFlowByFiles)用于渠道版通过文件创建签署流程。此接口不可直接使用,需要运营申请
54
24
  */
55
25
  ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
56
- /**
57
- * 该接口 (PrepareFlows) 用于创建待发起文件
58
- 用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
59
- 目前该接口只支持B2C,不建议使用。
60
- */
61
- PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
62
- /**
63
- * 创建跳转小程序查看或签署的链接;自动签署的签署方不创建签署链接;
64
- */
65
- CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
66
26
  /**
67
27
  * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,需要运营申请
68
28
  */
@@ -71,6 +31,24 @@ export declare class Client extends AbstractClient {
71
31
  * 此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
72
32
  */
73
33
  ChannelCancelMultiFlowSignQRCode(req: ChannelCancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void): Promise<ChannelCancelMultiFlowSignQRCodeResponse>;
34
+ /**
35
+ * 渠道创建文件转换任务
36
+ */
37
+ ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
38
+ /**
39
+ * 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。
40
+ 注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
41
+ */
42
+ DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
43
+ /**
44
+ * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
45
+
46
+ */
47
+ CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
48
+ /**
49
+ * 创建跳转小程序查看或签署的链接;自动签署的签署方不创建签署链接;
50
+ */
51
+ CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
74
52
  /**
75
53
  * 此接口(CreateConsoleLoginUrl)用于创建电子签控制台登录链接。若企业未激活,调用同步企业信息、同步经办人信息
76
54
 
@@ -81,15 +59,6 @@ export declare class Client extends AbstractClient {
81
59
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销
82
60
  */
83
61
  ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse>;
84
- /**
85
- * 渠道创建文件转换任务
86
- */
87
- ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
88
- /**
89
- * 此接口(DescribeUsage)用于获取渠道所有合作企业流量消耗情况。
90
- 注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
91
- */
92
- DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
93
62
  /**
94
63
  * 渠道版查询转换任务状态
95
64
  */
@@ -98,14 +67,49 @@ export declare class Client extends AbstractClient {
98
67
  * 此接口(SyncProxyOrganization)用于同步渠道侧企业信息
99
68
  */
100
69
  SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
101
- /**
102
- * 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。
103
- */
104
- DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
105
70
  /**
106
71
  * 此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。
107
72
  当前接口限制最多合同(流程)50个.
108
73
 
109
74
  */
110
75
  GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
76
+ /**
77
+ * 该接口 (PrepareFlows) 用于创建待发起文件
78
+ 用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
79
+ 目前该接口只支持B2C,不建议使用。
80
+ */
81
+ PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
82
+ /**
83
+ * 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
84
+ */
85
+ DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
86
+ /**
87
+ * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
88
+ */
89
+ DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
90
+ /**
91
+ * 此接口(UploadFiles)用于文件上传。
92
+ 调用时需要设置Domain 为 file.ess.tencent.cn
93
+ */
94
+ UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
95
+ /**
96
+ * 创建出证报告,返回报告 URL
97
+ */
98
+ CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
99
+ /**
100
+ * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
101
+ 1、同步标识=select时:
102
+ 返回渠道侧模板库当前模板的属性.
103
+ 2、同步标识=update或者delete时:
104
+ 对渠道子客进行模板库中模板授权,修改操作
105
+ */
106
+ OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
107
+ /**
108
+ * 此接口(SyncProxyOrganizationOperators)用于同步渠道合作企业经办人列表
109
+ */
110
+ SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
111
+ /**
112
+ * 此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。
113
+ */
114
+ DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
111
115
  }