tencentcloud-sdk-nodejs 4.0.690 → 4.0.691

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 (57) hide show
  1. package/CHANGELOG.md +332 -0
  2. package/SERVICE_CHANGELOG.md +498 -109
  3. package/package.json +1 -1
  4. package/products.md +15 -15
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_client.ts +8 -4
  7. package/src/services/dlc/v20210125/dlc_models.ts +2 -2
  8. package/src/services/dsgc/v20190723/dsgc_models.ts +40 -0
  9. package/src/services/ess/v20201111/ess_client.ts +28 -11
  10. package/src/services/ess/v20201111/ess_models.ts +126 -15
  11. package/src/services/essbasic/v20210526/essbasic_client.ts +37 -19
  12. package/src/services/essbasic/v20210526/essbasic_models.ts +106 -0
  13. package/src/services/faceid/v20180301/faceid_models.ts +9 -12
  14. package/src/services/iai/v20200303/iai_models.ts +2 -2
  15. package/src/services/mps/v20190612/mps_client.ts +50 -12
  16. package/src/services/mps/v20190612/mps_models.ts +1191 -379
  17. package/src/services/organization/v20210331/organization_client.ts +31 -7
  18. package/src/services/organization/v20210331/organization_models.ts +128 -90
  19. package/src/services/privatedns/v20201028/privatedns_client.ts +25 -1
  20. package/src/services/privatedns/v20201028/privatedns_models.ts +88 -8
  21. package/src/services/tdmq/v20200217/tdmq_client.ts +39 -2
  22. package/src/services/tdmq/v20200217/tdmq_models.ts +243 -88
  23. package/src/services/tts/v20190823/tts_models.ts +8 -0
  24. package/src/services/waf/v20180125/waf_models.ts +53 -24
  25. package/tencentcloud/common/sdk_version.d.ts +1 -1
  26. package/tencentcloud/common/sdk_version.js +1 -1
  27. package/tencentcloud/services/antiddos/v20200309/antiddos_client.d.ts +6 -2
  28. package/tencentcloud/services/antiddos/v20200309/antiddos_client.js +6 -2
  29. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +2 -2
  30. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +40 -0
  31. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +16 -7
  32. package/tencentcloud/services/ess/v20201111/ess_client.js +18 -7
  33. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +124 -15
  34. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +22 -12
  35. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +25 -13
  36. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +104 -0
  37. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +9 -12
  38. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +2 -2
  39. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +15 -4
  40. package/tencentcloud/services/mps/v20190612/mps_client.js +14 -3
  41. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +1162 -377
  42. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +9 -1
  43. package/tencentcloud/services/organization/v20210331/organization_client.js +12 -0
  44. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +124 -90
  45. package/tencentcloud/services/privatedns/v20201028/privatedns_client.d.ts +9 -1
  46. package/tencentcloud/services/privatedns/v20201028/privatedns_client.js +12 -0
  47. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +84 -8
  48. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +13 -1
  49. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +18 -0
  50. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +236 -88
  51. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +8 -0
  52. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +53 -24
  53. package/test/ess.v20201111.test.js +12 -2
  54. package/test/essbasic.v20210526.test.js +14 -4
  55. package/test/organization.v20210331.test.js +20 -0
  56. package/test/privatedns.v20201028.test.js +20 -0
  57. package/test/tdmq.v20200217.test.js +30 -0
@@ -421,6 +421,10 @@ export interface AccessLogItems {
421
421
  * ModifyInstanceName请求参数结构体
422
422
  */
423
423
  export interface ModifyInstanceNameRequest {
424
+ /**
425
+ * 新名称
426
+ */
427
+ InstanceName: string
424
428
  /**
425
429
  * 实例id
426
430
  */
@@ -626,6 +630,11 @@ export interface LoadBalancerPackageNew {
626
630
  注意:此字段可能返回 null,表示取不到有效值。
627
631
  */
628
632
  LoadBalancerType: string
633
+ /**
634
+ * 负载均衡器的域名
635
+ 注意:此字段可能返回 null,表示取不到有效值。
636
+ */
637
+ LoadBalancerDomain?: string
629
638
  }
630
639
 
631
640
  /**
@@ -2326,7 +2335,7 @@ export interface HostRecord {
2326
2335
  */
2327
2336
  MainDomain: string
2328
2337
  /**
2329
- * waf模式,同saas waf保持一致
2338
+ * 规则引擎防护模式,0 观察模式,1拦截模式
2330
2339
  */
2331
2340
  Mode: number
2332
2341
  /**
@@ -2338,7 +2347,7 @@ export interface HostRecord {
2338
2347
  */
2339
2348
  State: number
2340
2349
  /**
2341
- * 使用的规则,同saas waf保持一致
2350
+ * 规则引擎和AI引擎防护模式联合状态,10规则引擎观察&&AI引擎关闭模式 11规则引擎观察&&AI引擎观察模式 12规则引擎观察&&AI引擎拦截模式 20规则引擎拦截&&AI引擎关闭模式 21规则引擎拦截&&AI引擎观察模式 22规则引擎拦截&&AI引擎拦截模式
2342
2351
  */
2343
2352
  Engine: number
2344
2353
  /**
@@ -2390,6 +2399,11 @@ export interface HostRecord {
2390
2399
  注意:此字段可能返回 null,表示取不到有效值。
2391
2400
  */
2392
2401
  EngineType?: number
2402
+ /**
2403
+ * 云类型:public:公有云;private:私有云;hybrid:混合云
2404
+ 注意:此字段可能返回 null,表示取不到有效值。
2405
+ */
2406
+ CloudType?: string
2393
2407
  }
2394
2408
 
2395
2409
  /**
@@ -2413,42 +2427,47 @@ export interface UserDomainInfo {
2413
2427
  /**
2414
2428
  * 用户id
2415
2429
  */
2416
- Appid: number
2430
+ Appid?: number
2417
2431
  /**
2418
2432
  * 域名
2419
2433
  */
2420
- Domain: string
2434
+ Domain?: string
2421
2435
  /**
2422
2436
  * 域名id
2423
2437
  */
2424
- DomainId: string
2438
+ DomainId?: string
2425
2439
  /**
2426
2440
  * 实例id
2427
2441
  */
2428
- InstanceId: string
2442
+ InstanceId?: string
2429
2443
  /**
2430
2444
  * 实例名
2431
2445
  */
2432
- InstanceName: string
2446
+ InstanceName?: string
2433
2447
  /**
2434
2448
  * waf类型
2435
2449
  */
2436
- Edition: string
2450
+ Edition?: string
2437
2451
  /**
2438
2452
  * 版本
2439
2453
  注意:此字段可能返回 null,表示取不到有效值。
2440
2454
  */
2441
- Level: string
2455
+ Level?: string
2442
2456
  /**
2443
2457
  * 指定域名访问日志字段的开关
2444
2458
  注意:此字段可能返回 null,表示取不到有效值。
2445
2459
  */
2446
- WriteConfig: string
2460
+ WriteConfig?: string
2447
2461
  /**
2448
2462
  * 指定域名是否写cls的开关 1:写 0:不写
2449
2463
  注意:此字段可能返回 null,表示取不到有效值。
2450
2464
  */
2451
- Cls: number
2465
+ Cls?: number
2466
+ /**
2467
+ * 标记是否是混合云接入。hybrid表示混合云接入域名
2468
+ 注意:此字段可能返回 null,表示取不到有效值。
2469
+ */
2470
+ CloudType?: string
2452
2471
  }
2453
2472
 
2454
2473
  /**
@@ -5814,7 +5833,7 @@ export interface ModifySpartaProtectionRequest {
5814
5833
  */
5815
5834
  IpHeaders?: Array<string>
5816
5835
  /**
5817
- * 0:关闭xff重置;1:开启xff重置
5836
+ * 0:关闭xff重置;1:开启xff重置,只有在IsCdn=0时可以开启
5818
5837
  */
5819
5838
  XFFReset?: number
5820
5839
  }
@@ -6379,55 +6398,60 @@ export interface ClbDomainsInfo {
6379
6398
  /**
6380
6399
  * 域名
6381
6400
  */
6382
- Domain: string
6401
+ Domain?: string
6383
6402
  /**
6384
6403
  * 域名id
6385
6404
  */
6386
- DomainId: string
6405
+ DomainId?: string
6387
6406
  /**
6388
6407
  * 实例id
6389
6408
  */
6390
- InstanceId: string
6409
+ InstanceId?: string
6391
6410
  /**
6392
6411
  * 实例名
6393
6412
  */
6394
- InstanceName: string
6413
+ InstanceName?: string
6395
6414
  /**
6396
6415
  * waf类型
6397
6416
  */
6398
- Edition: string
6417
+ Edition?: string
6399
6418
  /**
6400
6419
  * 是否是cdn
6401
6420
  */
6402
- IsCdn: number
6421
+ IsCdn?: number
6403
6422
  /**
6404
6423
  * 负载均衡算法
6405
6424
  */
6406
- LoadBalancerSet: Array<LoadBalancerPackageNew>
6425
+ LoadBalancerSet?: Array<LoadBalancerPackageNew>
6407
6426
  /**
6408
6427
  * 镜像模式
6409
6428
  */
6410
- FlowMode: number
6429
+ FlowMode?: number
6411
6430
  /**
6412
6431
  * 绑定clb状态
6413
6432
  注意:此字段可能返回 null,表示取不到有效值。
6414
6433
  */
6415
- State: number
6434
+ State?: number
6416
6435
  /**
6417
6436
  * 负载均衡类型,clb或者apisix
6418
6437
  注意:此字段可能返回 null,表示取不到有效值。
6419
6438
  */
6420
- AlbType: string
6439
+ AlbType?: string
6421
6440
  /**
6422
6441
  * IsCdn=3时,表示自定义header
6423
6442
  注意:此字段可能返回 null,表示取不到有效值。
6424
6443
  */
6425
- IpHeaders: Array<string>
6444
+ IpHeaders?: Array<string>
6426
6445
  /**
6427
6446
  * cdc类型会增加集群信息
6428
6447
  注意:此字段可能返回 null,表示取不到有效值。
6429
6448
  */
6430
- CdcClusters: string
6449
+ CdcClusters?: string
6450
+ /**
6451
+ * 云类型:public:公有云;private:私有云;hybrid:混合云
6452
+ 注意:此字段可能返回 null,表示取不到有效值。
6453
+ */
6454
+ CloudType?: string
6431
6455
  }
6432
6456
 
6433
6457
  /**
@@ -6766,6 +6790,11 @@ export interface LoadBalancer {
6766
6790
  注意:此字段可能返回 null,表示取不到有效值。
6767
6791
  */
6768
6792
  LoadBalancerType?: string
6793
+ /**
6794
+ * 负载均衡的域名
6795
+ 注意:此字段可能返回 null,表示取不到有效值。
6796
+ */
6797
+ LoadBalancerDomain?: string
6769
6798
  }
6770
6799
 
6771
6800
  /**
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.690";
1
+ export declare const sdkVersion = "4.0.691";
@@ -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.690";
4
+ exports.sdkVersion = "4.0.691";
@@ -44,7 +44,9 @@ export declare class Client extends AbstractClient {
44
44
  */
45
45
  DescribeCcBlackWhiteIpList(req: DescribeCcBlackWhiteIpListRequest, cb?: (error: string, rep: DescribeCcBlackWhiteIpListResponse) => void): Promise<DescribeCcBlackWhiteIpListResponse>;
46
46
  /**
47
- * 获取DDoS防护的IP黑白名单
47
+ * 接口变更
48
+
49
+ 获取DDoS防护的IP黑白名单
48
50
  */
49
51
  DescribeBlackWhiteIpList(req: DescribeBlackWhiteIpListRequest, cb?: (error: string, rep: DescribeBlackWhiteIpListResponse) => void): Promise<DescribeBlackWhiteIpListResponse>;
50
52
  /**
@@ -349,7 +351,9 @@ export declare class Client extends AbstractClient {
349
351
  */
350
352
  DeleteCcBlackWhiteIpList(req: DeleteCcBlackWhiteIpListRequest, cb?: (error: string, rep: DeleteCcBlackWhiteIpListResponse) => void): Promise<DeleteCcBlackWhiteIpListResponse>;
351
353
  /**
352
- * 获取防护阈值配置列表,包括DDoS的AI、等级、CC阈值开关等
354
+ * 接口变更
355
+
356
+ 获取防护阈值配置列表,包括DDoS的AI、等级、CC阈值开关等
353
357
  */
354
358
  DescribeListProtectThresholdConfig(req: DescribeListProtectThresholdConfigRequest, cb?: (error: string, rep: DescribeListProtectThresholdConfigResponse) => void): Promise<DescribeListProtectThresholdConfigResponse>;
355
359
  /**
@@ -82,7 +82,9 @@ class Client extends abstract_client_1.AbstractClient {
82
82
  return this.request("DescribeCcBlackWhiteIpList", req, cb);
83
83
  }
84
84
  /**
85
- * 获取DDoS防护的IP黑白名单
85
+ * 接口变更
86
+
87
+ 获取DDoS防护的IP黑白名单
86
88
  */
87
89
  async DescribeBlackWhiteIpList(req, cb) {
88
90
  return this.request("DescribeBlackWhiteIpList", req, cb);
@@ -539,7 +541,9 @@ class Client extends abstract_client_1.AbstractClient {
539
541
  return this.request("DeleteCcBlackWhiteIpList", req, cb);
540
542
  }
541
543
  /**
542
- * 获取防护阈值配置列表,包括DDoS的AI、等级、CC阈值开关等
544
+ * 接口变更
545
+
546
+ 获取防护阈值配置列表,包括DDoS的AI、等级、CC阈值开关等
543
547
  */
544
548
  async DescribeListProtectThresholdConfig(req, cb) {
545
549
  return this.request("DescribeListProtectThresholdConfig", req, cb);
@@ -5797,7 +5797,7 @@ export interface CreateSparkSessionBatchSQLRequest {
5797
5797
  */
5798
5798
  DataEngineName: string;
5799
5799
  /**
5800
- * 运行sql
5800
+ * 运行sql,需要base64编码。
5801
5801
  */
5802
5802
  ExecuteSQL: string;
5803
5803
  /**
@@ -5835,7 +5835,7 @@ export interface CreateSparkSessionBatchSQLRequest {
5835
5835
  */
5836
5836
  Arguments?: Array<KVPair>;
5837
5837
  /**
5838
- * 是否继承集群的资源类配置:0:自定义(默认),1:继承集群;
5838
+ * 是否继承集群的资源类配置:0:不继承(默认),1:继承集群;
5839
5839
  */
5840
5840
  IsInherit?: number;
5841
5841
  }
@@ -523,6 +523,11 @@ export interface AssessmentTemplate {
523
523
  注意:此字段可能返回 null,表示取不到有效值。
524
524
  */
525
525
  IsASMTemplate?: boolean;
526
+ /**
527
+ * 合规组id
528
+ 注意:此字段可能返回 null,表示取不到有效值。
529
+ */
530
+ IdentifyComplianceId?: number;
526
531
  }
527
532
  /**
528
533
  * ModifyDSPATaskResult请求参数结构体
@@ -3528,6 +3533,16 @@ export interface RiskItemInfo {
3528
3533
  注意:此字段可能返回 null,表示取不到有效值。
3529
3534
  */
3530
3535
  RiskSide?: string;
3536
+ /**
3537
+ * API安全风险链接
3538
+ 注意:此字段可能返回 null,表示取不到有效值。
3539
+ */
3540
+ APIRiskLinkURL?: string;
3541
+ /**
3542
+ * 备注
3543
+ 注意:此字段可能返回 null,表示取不到有效值。
3544
+ */
3545
+ Remark?: string;
3531
3546
  }
3532
3547
  /**
3533
3548
  * DescribeDSPAAssessmentRiskProcessHistory返回参数结构体
@@ -4552,6 +4567,11 @@ export interface AssessmentRisk {
4552
4567
  注意:此字段可能返回 null,表示取不到有效值。
4553
4568
  */
4554
4569
  RiskSide?: string;
4570
+ /**
4571
+ * 数据源类型
4572
+ 注意:此字段可能返回 null,表示取不到有效值。
4573
+ */
4574
+ DataSourceType?: string;
4555
4575
  }
4556
4576
  /**
4557
4577
  * 关系型数据库资产详情
@@ -5115,6 +5135,12 @@ export interface AssessmentTask {
5115
5135
  * 评估任务Id
5116
5136
  */
5117
5137
  TaskId: string;
5138
+ /**
5139
+ * 评估任务的自增ID
5140
+
5141
+ 注意:此字段可能返回 null,表示取不到有效值。
5142
+ */
5143
+ TaskUid: number;
5118
5144
  /**
5119
5145
  * 评估任务名称
5120
5146
  */
@@ -5181,6 +5207,16 @@ export interface AssessmentTask {
5181
5207
  * 评估任务失败信息
5182
5208
  */
5183
5209
  ErrorInfo: string;
5210
+ /**
5211
+ * 模版主键id
5212
+ 注意:此字段可能返回 null,表示取不到有效值。
5213
+ */
5214
+ TemplateUid: number;
5215
+ /**
5216
+ * 进度百分比
5217
+ 注意:此字段可能返回 null,表示取不到有效值。
5218
+ */
5219
+ ProgressPercent: number;
5184
5220
  }
5185
5221
  /**
5186
5222
  * DescribeClassificationInfo请求参数结构体
@@ -5796,6 +5832,10 @@ export interface DescribeDSPAAssessmentLatestRiskListRequest {
5796
5832
  * 风险面筛选
5797
5833
  */
5798
5834
  RiskSide?: Array<string>;
5835
+ /**
5836
+ * ASC 正序,DESC倒叙
5837
+ */
5838
+ TimeSort?: string;
5799
5839
  }
5800
5840
  /**
5801
5841
  * DescribeDSPADiscoveryTaskResult返回参数结构体
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -134,10 +134,9 @@ export declare class Client extends AbstractClient {
134
134
  */
135
135
  DeleteIntegrationRoleUsers(req: DeleteIntegrationRoleUsersRequest, cb?: (error: string, rep: DeleteIntegrationRoleUsersResponse) => void): Promise<DeleteIntegrationRoleUsersResponse>;
136
136
  /**
137
- * 提交企业签署流程审批结果
138
- 适用场景:
139
- 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。
140
- 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
137
+ * 提交签署流程审批结果的适用场景包括:
138
+ 1. 在使用模板(CreateFlow)或文件(CreateFlowByFiles)创建签署流程时,若指定了参数NeedSignReview为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
139
+ 2. 若签署流程状态正常,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
141
140
  */
142
141
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
143
142
  /**
@@ -345,9 +344,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
345
344
  */
346
345
  ModifyIntegrationRole(req: ModifyIntegrationRoleRequest, cb?: (error: string, rep: ModifyIntegrationRoleResponse) => void): Promise<ModifyIntegrationRoleResponse>;
347
346
  /**
348
- * 对企业员工进行印章授权
347
+ * 通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。
348
+ 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
349
+
350
+ 注:
351
+ - 参与人点击链接后需短信验证码才能查看合同内容。
352
+ - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。
353
+ - 个人批量签署,签名区`仅支持手写签名`。
349
354
  */
350
- CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
355
+ CreateBatchSignUrl(req: CreateBatchSignUrlRequest, cb?: (error: string, rep: CreateBatchSignUrlResponse) => void): Promise<CreateBatchSignUrlResponse>;
351
356
  /**
352
357
  * 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
353
358
  附注:
@@ -452,6 +457,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
452
457
  适用场景:子企业在加入集团后,主企业可能通过此接口获取到所有的子企业列表,方便进行展示和统计
453
458
  */
454
459
  DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
460
+ /**
461
+ * 对企业员工进行印章授权
462
+ */
463
+ CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
455
464
  /**
456
465
  * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
457
466
  */
@@ -192,10 +192,9 @@ class Client extends abstract_client_1.AbstractClient {
192
192
  return this.request("DeleteIntegrationRoleUsers", req, cb);
193
193
  }
194
194
  /**
195
- * 提交企业签署流程审批结果
196
- 适用场景:
197
- 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。
198
- 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
195
+ * 提交签署流程审批结果的适用场景包括:
196
+ 1. 在使用模板(CreateFlow)或文件(CreateFlowByFiles)创建签署流程时,若指定了参数NeedSignReview为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
197
+ 2. 若签署流程状态正常,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
199
198
  */
200
199
  async CreateFlowSignReview(req, cb) {
201
200
  return this.request("CreateFlowSignReview", req, cb);
@@ -453,10 +452,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
453
452
  return this.request("ModifyIntegrationRole", req, cb);
454
453
  }
455
454
  /**
456
- * 对企业员工进行印章授权
455
+ * 通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。
456
+ 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
457
+
458
+ 注:
459
+ - 参与人点击链接后需短信验证码才能查看合同内容。
460
+ - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。
461
+ - 个人批量签署,签名区`仅支持手写签名`。
457
462
  */
458
- async CreateSealPolicy(req, cb) {
459
- return this.request("CreateSealPolicy", req, cb);
463
+ async CreateBatchSignUrl(req, cb) {
464
+ return this.request("CreateBatchSignUrl", req, cb);
460
465
  }
461
466
  /**
462
467
  * 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
@@ -588,6 +593,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
588
593
  async DescribeOrganizationGroupOrganizations(req, cb) {
589
594
  return this.request("DescribeOrganizationGroupOrganizations", req, cb);
590
595
  }
596
+ /**
597
+ * 对企业员工进行印章授权
598
+ */
599
+ async CreateSealPolicy(req, cb) {
600
+ return this.request("CreateSealPolicy", req, cb);
601
+ }
591
602
  /**
592
603
  * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
593
604
  */
@@ -760,6 +760,31 @@ export interface DeleteIntegrationEmployeesResponse {
760
760
  */
761
761
  RequestId?: string;
762
762
  }
763
+ /**
764
+ * CreateBatchSignUrl返回参数结构体
765
+ */
766
+ export interface CreateBatchSignUrlResponse {
767
+ /**
768
+ * 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
769
+
770
+ 注: `非小程序和APP集成使用`
771
+ */
772
+ SignUrl?: string;
773
+ /**
774
+ * 链接过期时间以 Unix 时间戳格式表示,默认生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
775
+ */
776
+ ExpiredTime?: number;
777
+ /**
778
+ * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
779
+
780
+ 注: `小程序和APP集成使用`
781
+ */
782
+ MiniAppPath?: string;
783
+ /**
784
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
785
+ */
786
+ RequestId?: string;
787
+ }
763
788
  /**
764
789
  * CreateFlowReminds返回参数结构体
765
790
  */
@@ -2174,22 +2199,27 @@ export interface CreateConvertTaskApiResponse {
2174
2199
  */
2175
2200
  export interface CreateFlowSignReviewRequest {
2176
2201
  /**
2177
- * 调用方用户信息,userId 必填
2202
+ * 执行本接口操作的员工信息。
2203
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2178
2204
  */
2179
2205
  Operator: UserInfo;
2180
2206
  /**
2181
- * 签署流程编号
2207
+ * 合同流程ID,为32位字符串。
2208
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2209
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2182
2210
  */
2183
2211
  FlowId: string;
2184
2212
  /**
2185
- * 企业内部审核结果
2186
- PASS: 通过
2187
- REJECT: 拒绝
2213
+ * 企业审核结果
2214
+ <ul><li>PASS: 通过</li>
2215
+ <li>REJECT: 拒绝</li></ul>
2188
2216
  */
2189
2217
  ReviewType: string;
2190
2218
  /**
2191
- * 审核原因
2192
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
2219
+ * 审核结果原因,
2220
+ 字符串长度不超过200
2221
+ 当ReviewType 是拒绝(REJECT) 时此字段必填。
2222
+
2193
2223
  */
2194
2224
  ReviewMessage?: string;
2195
2225
  /**
@@ -2197,19 +2227,18 @@ export interface CreateFlowSignReviewRequest {
2197
2227
  */
2198
2228
  Agent?: Agent;
2199
2229
  /**
2200
- * 审核签署节点使用 非必填 如果填写则审核该签署节点。给个人审核时必填。
2230
+ * 审核签署节点人标识,
2231
+ 用来标识审核的签署方。
2232
+ 如果签署审核节点是个人, 此参数必填。
2201
2233
  */
2202
2234
  RecipientId?: string;
2203
2235
  /**
2204
- * 操作类型:(接口通过该字段区分操作类型)
2205
-
2206
- SignReview:签署审核
2207
- CreateReview:发起审核
2236
+ * 操作类型:(接口通过该字段区分不同的操作类型)
2208
2237
 
2209
- 默认:SignReview;SignReview:签署审核
2238
+ <ul><li>SignReview: 签署审核(默认)</li>
2239
+ <li>CreateReview: 创建审核</li></ul>
2210
2240
 
2211
- 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
2212
- 若发起个人审核,则指定该字段为:SignReview
2241
+ 如果审核节点是个人,则操作类型只能为SignReview
2213
2242
  */
2214
2243
  OperateType?: string;
2215
2244
  }
@@ -5365,6 +5394,86 @@ export interface DescribeIntegrationRolesResponse {
5365
5394
  */
5366
5395
  RequestId?: string;
5367
5396
  }
5397
+ /**
5398
+ * CreateBatchSignUrl请求参数结构体
5399
+ */
5400
+ export interface CreateBatchSignUrlRequest {
5401
+ /**
5402
+ * 执行本接口操作的员工信息。
5403
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5404
+ */
5405
+ Operator: UserInfo;
5406
+ /**
5407
+ * 签署方经办人的姓名。
5408
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
5409
+
5410
+ 注:`请确保和合同中填入的一致`
5411
+ */
5412
+ Name: string;
5413
+ /**
5414
+ * 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
5415
+ 请确认手机号所有方为此业务通知方。
5416
+
5417
+ 注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
5418
+ */
5419
+ Mobile: string;
5420
+ /**
5421
+ * 代理企业和员工的信息。
5422
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5423
+ */
5424
+ Agent?: Agent;
5425
+ /**
5426
+ * 证件类型,支持以下类型
5427
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
5428
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5429
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
5430
+
5431
+ 注:`请确保和合同中填入的一致`
5432
+ */
5433
+ IdCardType?: string;
5434
+ /**
5435
+ * 证件号码,应符合以下规则
5436
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
5437
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
5438
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5439
+
5440
+ 注:`请确保和合同中填入的一致`
5441
+ */
5442
+ IdCardNumber?: string;
5443
+ /**
5444
+ * 通知用户方式:
5445
+ <ul>
5446
+ <li>**NONE** : 不通知(默认)</li>
5447
+ <li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
5448
+ </ul>
5449
+ */
5450
+ NotifyType?: string;
5451
+ /**
5452
+ * 本次需要批量签署的合同流程ID列表。
5453
+ 可以不传, 如不传则是发给对方的所有待签署合同流程。
5454
+
5455
+ */
5456
+ FlowIds?: Array<string>;
5457
+ /**
5458
+ * 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。
5459
+
5460
+ 注:
5461
+ <ul>
5462
+ <li>请确认该名称与企业营业执照中注册的名称一致。</li>
5463
+ <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
5464
+ <li>请确保此企业已完成腾讯电子签企业认证。</li>
5465
+ </ul>
5466
+ */
5467
+ OrganizationName?: string;
5468
+ /**
5469
+ * 是否直接跳转至合同内容页面进行签署
5470
+ <ul>
5471
+ <li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
5472
+ <li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
5473
+ </ul>
5474
+ */
5475
+ JumpToDetail?: boolean;
5476
+ }
5368
5477
  /**
5369
5478
  * CreateFlowReminds请求参数结构体
5370
5479
  */