tencentcloud-sdk-nodejs 4.0.742 → 4.0.744

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 (103) hide show
  1. package/CHANGELOG.md +472 -0
  2. package/SERVICE_CHANGELOG.md +508 -19
  3. package/package.json +1 -1
  4. package/products.md +31 -31
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/billing/v20180709/billing_models.ts +1 -1
  7. package/src/services/cam/v20190116/cam_models.ts +3 -2
  8. package/src/services/cat/v20180409/cat_client.ts +20 -7
  9. package/src/services/cat/v20180409/cat_models.ts +114 -30
  10. package/src/services/cfg/v20210820/cfg_models.ts +14 -0
  11. package/src/services/cls/v20201016/cls_client.ts +33 -19
  12. package/src/services/cls/v20201016/cls_models.ts +224 -94
  13. package/src/services/config/v20220802/config_client.ts +15 -2
  14. package/src/services/config/v20220802/config_models.ts +88 -33
  15. package/src/services/cwp/v20180228/cwp_client.ts +1 -1
  16. package/src/services/cwp/v20180228/cwp_models.ts +26 -18
  17. package/src/services/dts/v20211206/dts_models.ts +1 -1
  18. package/src/services/eb/v20210416/eb_client.ts +1 -0
  19. package/src/services/eb/v20210416/eb_models.ts +36 -1
  20. package/src/services/ess/v20201111/ess_models.ts +37 -29
  21. package/src/services/essbasic/v20210526/essbasic_client.ts +20 -7
  22. package/src/services/essbasic/v20210526/essbasic_models.ts +162 -72
  23. package/src/services/hunyuan/v20230901/hunyuan_client.ts +10 -4
  24. package/src/services/hunyuan/v20230901/hunyuan_models.ts +2 -2
  25. package/src/services/lighthouse/v20200324/lighthouse_models.ts +3 -3
  26. package/src/services/mna/v20210119/mna_models.ts +2 -2
  27. package/src/services/oceanus/v20190422/oceanus_client.ts +0 -2
  28. package/src/services/oceanus/v20190422/oceanus_models.ts +29 -19
  29. package/src/services/scf/v20180416/scf_client.ts +1 -0
  30. package/src/services/scf/v20180416/scf_models.ts +34 -2
  31. package/src/services/ssl/v20191205/ssl_models.ts +51 -6
  32. package/src/services/tcr/v20190924/tcr_client.ts +21 -63
  33. package/src/services/tcr/v20190924/tcr_models.ts +115 -243
  34. package/src/services/tdmq/v20200217/tdmq_client.ts +4 -2
  35. package/src/services/tdmq/v20200217/tdmq_models.ts +15 -15
  36. package/src/services/teo/v20220901/teo_client.ts +113 -38
  37. package/src/services/teo/v20220901/teo_models.ts +402 -73
  38. package/src/services/thpc/v20230321/thpc_models.ts +6 -6
  39. package/src/services/tione/v20211111/tione_client.ts +12 -0
  40. package/src/services/tione/v20211111/tione_models.ts +64 -0
  41. package/src/services/trtc/v20190722/trtc_client.ts +45 -7
  42. package/src/services/trtc/v20190722/trtc_models.ts +167 -9
  43. package/src/services/tts/v20190823/tts_models.ts +10 -10
  44. package/src/services/weilingwith/v20230427/weilingwith_client.ts +2 -2
  45. package/tencentcloud/common/sdk_version.d.ts +1 -1
  46. package/tencentcloud/common/sdk_version.js +1 -1
  47. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +1 -1
  48. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +3 -2
  49. package/tencentcloud/services/cat/v20180409/cat_client.d.ts +7 -3
  50. package/tencentcloud/services/cat/v20180409/cat_client.js +9 -3
  51. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +111 -30
  52. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +14 -0
  53. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +11 -7
  54. package/tencentcloud/services/cls/v20201016/cls_client.js +14 -8
  55. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +220 -94
  56. package/tencentcloud/services/config/v20220802/config_client.d.ts +5 -1
  57. package/tencentcloud/services/config/v20220802/config_client.js +6 -0
  58. package/tencentcloud/services/config/v20220802/config_models.d.ts +85 -33
  59. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1 -1
  60. package/tencentcloud/services/cwp/v20180228/cwp_client.js +1 -1
  61. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +26 -18
  62. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  63. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +35 -1
  64. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +37 -29
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +20 -7
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +20 -7
  67. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +162 -72
  68. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +6 -0
  69. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +6 -0
  70. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +2 -2
  71. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +3 -3
  72. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +2 -2
  73. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +0 -2
  74. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +0 -2
  75. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +29 -19
  76. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +33 -2
  77. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +51 -6
  78. package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +5 -23
  79. package/tencentcloud/services/tcr/v20190924/tcr_client.js +6 -30
  80. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +113 -235
  81. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +3 -1
  82. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +3 -1
  83. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +15 -15
  84. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +35 -11
  85. package/tencentcloud/services/teo/v20220901/teo_client.js +51 -15
  86. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +387 -73
  87. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +6 -6
  88. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
  89. package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
  90. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +62 -0
  91. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +15 -3
  92. package/tencentcloud/services/trtc/v20190722/trtc_client.js +21 -3
  93. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +159 -9
  94. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +10 -10
  95. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +2 -2
  96. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +2 -2
  97. package/test/cat.v20180409.test.js +12 -2
  98. package/test/cls.v20201016.test.js +14 -4
  99. package/test/config.v20220802.test.js +10 -0
  100. package/test/tcr.v20190924.test.js +4 -34
  101. package/test/teo.v20220901.test.js +70 -10
  102. package/test/tione.v20211111.test.js +10 -0
  103. package/test/trtc.v20190722.test.js +32 -2
@@ -380,7 +380,7 @@ export declare class Client extends AbstractClient {
380
380
  */
381
381
  DescribeWebHookReceiver(req: DescribeWebHookReceiverRequest, cb?: (error: string, rep: DescribeWebHookReceiverResponse) => void): Promise<DescribeWebHookReceiverResponse>;
382
382
  /**
383
- * 用于设置新增主机自动开通专业防护配置。
383
+ * 用于设置新增主机自动开通专业防护配置。
384
384
  */
385
385
  ModifyAutoOpenProVersionConfig(req: ModifyAutoOpenProVersionConfigRequest, cb?: (error: string, rep: ModifyAutoOpenProVersionConfigResponse) => void): Promise<ModifyAutoOpenProVersionConfigResponse>;
386
386
  /**
@@ -586,7 +586,7 @@ class Client extends abstract_client_1.AbstractClient {
586
586
  return this.request("DescribeWebHookReceiver", req, cb);
587
587
  }
588
588
  /**
589
- * 用于设置新增主机自动开通专业防护配置。
589
+ * 用于设置新增主机自动开通专业防护配置。
590
590
  */
591
591
  async ModifyAutoOpenProVersionConfig(req, cb) {
592
592
  return this.request("ModifyAutoOpenProVersionConfig", req, cb);
@@ -13270,6 +13270,10 @@ export interface ModifyAutoOpenProVersionConfigRequest {
13270
13270
  * 自动加购的订单是否自动续费,默认0 ,0关闭, 1开启
13271
13271
  */
13272
13272
  AutoRepurchaseRenewSwitch?: number;
13273
+ /**
13274
+ * 手动购买的订单是否自动续费,默认0, 0关闭 ,1 开启
13275
+ */
13276
+ RepurchaseRenewSwitch?: number;
13273
13277
  }
13274
13278
  /**
13275
13279
  * DescribeLogDeliveryKafkaOptions请求参数结构体
@@ -23895,75 +23899,79 @@ export interface DescribeLicenseGeneralResponse {
23895
23899
  /**
23896
23900
  * 总授权数 (包含隔离,过期等不可用状态)
23897
23901
  */
23898
- LicenseCnt: number;
23902
+ LicenseCnt?: number;
23899
23903
  /**
23900
23904
  * 可用授权数
23901
23905
  */
23902
- AvailableLicenseCnt: number;
23906
+ AvailableLicenseCnt?: number;
23903
23907
  /**
23904
23908
  * 可用专业版授权数(包含后付费).
23905
23909
  */
23906
- AvailableProVersionLicenseCnt: number;
23910
+ AvailableProVersionLicenseCnt?: number;
23907
23911
  /**
23908
23912
  * 可用旗舰版授权数
23909
23913
  */
23910
- AvailableFlagshipVersionLicenseCnt: number;
23914
+ AvailableFlagshipVersionLicenseCnt?: number;
23911
23915
  /**
23912
23916
  * 即将到期授权数 (15天内到期的)
23913
23917
  */
23914
- NearExpiryLicenseCnt: number;
23918
+ NearExpiryLicenseCnt?: number;
23915
23919
  /**
23916
23920
  * 已到期授权数(不包含已删除的记录)
23917
23921
  */
23918
- ExpireLicenseCnt: number;
23922
+ ExpireLicenseCnt?: number;
23919
23923
  /**
23920
23924
  * 自动升级开关状态,默认 false, true 开启, false 关闭
23921
23925
  */
23922
- AutoOpenStatus: boolean;
23926
+ AutoOpenStatus?: boolean;
23923
23927
  /**
23924
23928
  * PROVERSION_POSTPAY 专业版-后付费, PROVERSION_PREPAY 专业版-预付费, FLAGSHIP_PREPAY 旗舰版-预付费
23925
23929
  */
23926
- ProtectType: string;
23930
+ ProtectType?: string;
23927
23931
  /**
23928
23932
  * 历史是否开通过自动升级开关
23929
23933
  */
23930
- IsOpenStatusHistory: boolean;
23934
+ IsOpenStatusHistory?: boolean;
23931
23935
  /**
23932
23936
  * 已使用授权数
23933
23937
  */
23934
- UsedLicenseCnt: number;
23938
+ UsedLicenseCnt?: number;
23935
23939
  /**
23936
23940
  * 未到期授权数
23937
23941
  */
23938
- NotExpiredLicenseCnt: number;
23942
+ NotExpiredLicenseCnt?: number;
23939
23943
  /**
23940
23944
  * 旗舰版总授权数(有效订单)
23941
23945
  */
23942
- FlagshipVersionLicenseCnt: number;
23946
+ FlagshipVersionLicenseCnt?: number;
23943
23947
  /**
23944
23948
  * 专业版总授权数(有效订单)
23945
23949
  */
23946
- ProVersionLicenseCnt: number;
23950
+ ProVersionLicenseCnt?: number;
23947
23951
  /**
23948
23952
  * 普惠版总授权数(有效订单的授权数)
23949
23953
  */
23950
- CwpVersionLicenseCnt: number;
23954
+ CwpVersionLicenseCnt?: number;
23951
23955
  /**
23952
23956
  * 可用惠普版授权数
23953
23957
  */
23954
- AvailableLHLicenseCnt: number;
23958
+ AvailableLHLicenseCnt?: number;
23955
23959
  /**
23956
23960
  * 自动加购开关, true 开启, false 关闭
23957
23961
  */
23958
- AutoRepurchaseSwitch: boolean;
23962
+ AutoRepurchaseSwitch?: boolean;
23959
23963
  /**
23960
23964
  * 自动加购订单是否自动续费 ,true 开启, false 关闭
23961
23965
  */
23962
- AutoRepurchaseRenewSwitch: boolean;
23966
+ AutoRepurchaseRenewSwitch?: boolean;
23963
23967
  /**
23964
23968
  * 已销毁订单数
23965
23969
  */
23966
- DestroyOrderNum: number;
23970
+ DestroyOrderNum?: number;
23971
+ /**
23972
+ * 是否自动续费开关,true 开启,false 关闭
23973
+ */
23974
+ RepurchaseRenewSwitch?: boolean;
23967
23975
  /**
23968
23976
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
23969
23977
  */
@@ -948,7 +948,7 @@ export interface DBEndpointInfo {
948
948
  */
949
949
  DatabaseType: string;
950
950
  /**
951
- * 节点类型,为空或者"simple"表示普通节点、"cluster"表示集群节点;对于mongo业务,取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)
951
+ * 节点类型,为空或者simple表示普通节点、cluster表示集群节点;对于mongo业务,取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群);对于redis实例,为空或simple(单节点)、cluster(集群)、cluster-cache(cache集群)、cluster-proxy(代理集群)
952
952
  注意:此字段可能返回 null,表示取不到有效值。
953
953
  */
954
954
  NodeType: string;
@@ -423,7 +423,21 @@ export interface Extraction {
423
423
  /**
424
424
  * Data Transfer Service参数
425
425
  */
426
- export declare type DTSParams = null;
426
+ export interface DTSParams {
427
+ /**
428
+ * Consumer Group Name
429
+ */
430
+ ConsumerGroupName: string;
431
+ /**
432
+ * 账户名
433
+ */
434
+ Account: string;
435
+ /**
436
+ * 密码
437
+ 注意:此字段可能返回 null,表示取不到有效值。
438
+ */
439
+ Password: string;
440
+ }
427
441
  /**
428
442
  * CreateTarget返回参数结构体
429
443
  */
@@ -599,6 +613,11 @@ export interface ConnectionDescription {
599
613
  注意:此字段可能返回 null,表示取不到有效值。
600
614
  */
601
615
  DTSParams?: DTSParams;
616
+ /**
617
+ * tdmq参数
618
+ 注意:此字段可能返回 null,表示取不到有效值。
619
+ */
620
+ TDMQParams?: TDMQParams;
602
621
  }
603
622
  /**
604
623
  * Target信息
@@ -1208,6 +1227,21 @@ export interface UpdateEventBusResponse {
1208
1227
  */
1209
1228
  RequestId?: string;
1210
1229
  }
1230
+ /**
1231
+ * TDMQ参数详情
1232
+ */
1233
+ export interface TDMQParams {
1234
+ /**
1235
+ * 集群类型
1236
+ 注意:此字段可能返回 null,表示取不到有效值。
1237
+ */
1238
+ ClusterType?: string;
1239
+ /**
1240
+ * 集群支撑网接入点
1241
+ 注意:此字段可能返回 null,表示取不到有效值。
1242
+ */
1243
+ ClusterEndPoint?: string;
1244
+ }
1211
1245
  /**
1212
1246
  * GetEventBus返回参数结构体
1213
1247
  */
@@ -346,6 +346,13 @@ export interface CreatePreparedPersonalEsignRequest {
346
346
  * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
347
347
  */
348
348
  LicenseType?: number;
349
+ /**
350
+ * 自动签使用的场景值, 可以选择的场景值如下:
351
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
352
+
353
+ 注: `不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN`
354
+ */
355
+ SceneKey?: string;
349
356
  }
350
357
  /**
351
358
  * DescribeIntegrationDepartments返回参数结构体
@@ -391,7 +398,7 @@ export interface CreateFlowApproversResponse {
391
398
  export interface DescribeFileUrlsResponse {
392
399
  /**
393
400
  * 文件URL信息;
394
- 链接不是永久链接, 过期时间收UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
401
+ 链接不是永久链接, 过期时间受UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
395
402
  */
396
403
  FileUrls?: Array<FileUrl>;
397
404
  /**
@@ -596,6 +603,11 @@ export interface HasAuthUser {
596
603
  注意:此字段可能返回 null,表示取不到有效值。
597
604
  */
598
605
  BelongTo?: string;
606
+ /**
607
+ * 集团主企业id,当前企业为集团子企业时,该字段有值
608
+ 注意:此字段可能返回 null,表示取不到有效值。
609
+ */
610
+ MainOrganizationId?: string;
599
611
  }
600
612
  /**
601
613
  * DisableUserAutoSign返回参数结构体
@@ -1457,7 +1469,7 @@ export interface CreateDocumentResponse {
1457
1469
  * 合同流程的底层电子文档ID,为32位字符串。
1458
1470
 
1459
1471
  注:
1460
- 后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
1472
+ 后续需用同样的FlowId再次调用[发起签署流程](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow),合同才能进入签署环节
1461
1473
  */
1462
1474
  DocumentId?: string;
1463
1475
  /**
@@ -1667,7 +1679,7 @@ export interface CreateSchemeUrlRequest {
1667
1679
  Mobile?: string;
1668
1680
  /**
1669
1681
  * 证件类型,支持以下类型
1670
- <ul><li>ID_CARD : 居民身份证(默认值)</li>
1682
+ <ul><li>ID_CARD : 居民身份证</li>
1671
1683
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
1672
1684
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
1673
1685
  */
@@ -1790,7 +1802,7 @@ export interface AutoSignConfig {
1790
1802
  * 设置用户开通自动签时是否绑定个人自动签账号许可。
1791
1803
 
1792
1804
  <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
1793
- </ul>
1805
+ <li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
1794
1806
  */
1795
1807
  LicenseType?: number;
1796
1808
  }
@@ -2558,7 +2570,7 @@ export interface DisableUserAutoSignRequest {
2558
2570
  Operator: UserInfo;
2559
2571
  /**
2560
2572
  * 自动签使用的场景值, 可以选择的场景值如下:
2561
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
2573
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
2562
2574
  */
2563
2575
  SceneKey: string;
2564
2576
  /**
@@ -2746,7 +2758,7 @@ export interface CreateFlowByFilesRequest {
2746
2758
  */
2747
2759
  Approvers: Array<ApproverInfo>;
2748
2760
  /**
2749
- * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
2761
+ * 本合同流程需包含的PDF文件资源编号列表,通过[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获取PDF文件资源编号。
2750
2762
 
2751
2763
  注: `目前,此接口仅支持单个文件发起。`
2752
2764
  */
@@ -2788,7 +2800,7 @@ export interface CreateFlowByFilesRequest {
2788
2800
  NeedPreview?: boolean;
2789
2801
  /**
2790
2802
  * 预览模式下产生的预览链接类型
2791
- <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
2803
+ <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
2792
2804
  <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
2793
2805
  注: `此参数在NeedPreview 为true时有效`
2794
2806
 
@@ -2842,7 +2854,7 @@ export interface CreateFlowByFilesRequest {
2842
2854
  /**
2843
2855
  * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
2844
2856
 
2845
- 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
2857
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
2846
2858
  */
2847
2859
  UserData?: string;
2848
2860
  /**
@@ -3263,9 +3275,7 @@ export interface CreateUserAutoSignSealUrlRequest {
3263
3275
  Operator: UserInfo;
3264
3276
  /**
3265
3277
  * 自动签使用的场景值, 可以选择的场景值如下:
3266
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
3267
-
3268
- 注: `现在仅支持电子处方场景`
3278
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
3269
3279
  */
3270
3280
  SceneKey: string;
3271
3281
  /**
@@ -3512,7 +3522,7 @@ export interface FlowCreateApprover {
3512
3522
  */
3513
3523
  RegisterInfo?: RegisterInfo;
3514
3524
  /**
3515
- * 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
3525
+ * 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签、是否为动态补充签署人等功能开关。
3516
3526
  */
3517
3527
  ApproverOption?: ApproverOption;
3518
3528
  /**
@@ -3840,7 +3850,7 @@ export interface CreateDocumentRequest {
3840
3850
  Operator: UserInfo;
3841
3851
  /**
3842
3852
  * 合同流程ID,为32位字符串。
3843
- 此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
3853
+ 此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
3844
3854
  */
3845
3855
  FlowId: string;
3846
3856
  /**
@@ -3853,7 +3863,7 @@ export interface CreateDocumentRequest {
3853
3863
  */
3854
3864
  FileNames?: Array<string>;
3855
3865
  /**
3856
- * 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
3866
+ * 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
3857
3867
  */
3858
3868
  FormFields?: Array<FormField>;
3859
3869
  /**
@@ -3865,7 +3875,7 @@ export interface CreateDocumentRequest {
3865
3875
  NeedPreview?: boolean;
3866
3876
  /**
3867
3877
  * 预览模式下产生的预览链接类型
3868
- <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
3878
+ <ul><li> **0** :(默认) 文件流 ,点开后下载预览的合同PDF文件 </li>
3869
3879
  <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>
3870
3880
  注: `1.此参数在NeedPreview 为true时有效`
3871
3881
  `2.动态表格控件不支持H5链接方式预览`
@@ -4362,8 +4372,6 @@ export interface CreatePersonAuthCertificateImageRequest {
4362
4372
  /**
4363
4373
  * 证件类型,支持以下类型
4364
4374
  <ul><li> ID_CARD : 居民身份证 (默认值)</li>
4365
- <li> PASSPORT : 护照</li>
4366
- <li> FOREIGN_ID_CARD : 外国人永久居留身份证</li>
4367
4375
  <li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4368
4376
  <li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
4369
4377
  */
@@ -4380,6 +4388,13 @@ export interface CreatePersonAuthCertificateImageRequest {
4380
4388
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4381
4389
  */
4382
4390
  Agent?: Agent;
4391
+ /**
4392
+ * 自动签使用的场景值, 可以选择的场景值如下:
4393
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
4394
+
4395
+ 注: `不传默认为处方单场景,即E_PRESCRIPTION_AUTO_SIGN`
4396
+ */
4397
+ SceneKey?: string;
4383
4398
  }
4384
4399
  /**
4385
4400
  * CreateFlowByFiles返回参数结构体
@@ -4796,9 +4811,7 @@ export interface CreateUserAutoSignEnableUrlRequest {
4796
4811
  Operator: UserInfo;
4797
4812
  /**
4798
4813
  * 自动签使用的场景值, 可以选择的场景值如下:
4799
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4800
-
4801
- 注: `现在仅支持电子处方场景`
4814
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
4802
4815
  */
4803
4816
  SceneKey: string;
4804
4817
  /**
@@ -4814,7 +4827,7 @@ export interface CreateUserAutoSignEnableUrlRequest {
4814
4827
  /**
4815
4828
  * 是否通知开通方,通知类型:
4816
4829
  <ul><li>默认不设置为不通知开通方</li>
4817
- <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
4830
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
4818
4831
  */
4819
4832
  NotifyType?: string;
4820
4833
  /**
@@ -4880,9 +4893,7 @@ export interface CancelUserAutoSignEnableUrlRequest {
4880
4893
  Operator: UserInfo;
4881
4894
  /**
4882
4895
  * 自动签使用的场景值, 可以选择的场景值如下:
4883
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4884
-
4885
- 注: `现在仅支持电子处方场景`
4896
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
4886
4897
  */
4887
4898
  SceneKey: string;
4888
4899
  /**
@@ -6429,8 +6440,7 @@ export interface DescribePersonCertificateRequest {
6429
6440
  Agent?: Agent;
6430
6441
  /**
6431
6442
  * 证书使用场景,可以选择的场景值如下:
6432
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
6433
- 注: `现在仅支持电子处方场景`
6443
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
6434
6444
  */
6435
6445
  SceneKey?: string;
6436
6446
  }
@@ -6708,9 +6718,7 @@ export interface DescribeUserAutoSignStatusRequest {
6708
6718
  Operator: UserInfo;
6709
6719
  /**
6710
6720
  * 自动签使用的场景值, 可以选择的场景值如下:
6711
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
6712
-
6713
- 注: `现在仅支持电子处方场景`
6721
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
6714
6722
  */
6715
6723
  SceneKey: string;
6716
6724
  /**
@@ -408,11 +408,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
408
408
  */
409
409
  ChannelCreateOrganizationModifyQrCode(req: ChannelCreateOrganizationModifyQrCodeRequest, cb?: (error: string, rep: ChannelCreateOrganizationModifyQrCodeResponse) => void): Promise<ChannelCreateOrganizationModifyQrCodeResponse>;
410
410
  /**
411
- * 创建预发起合同
412
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
413
- 可指定合同信息不可更改,签署人信息不可更改
414
- 合同发起后,填写及签署流程与现有操作流程一致
415
- 注意:目前仅支持模板发起
411
+ * 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
412
+
413
+ 注意:
414
+ 1. **仅支持模板**发起
415
+ 2. 只支持PC浏览器操作使用
416
+
417
+ 嵌入的页面样式如下:
418
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
416
419
  */
417
420
  ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
418
421
  /**
@@ -761,6 +764,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
761
764
  <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
762
765
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
763
766
  </ul>
767
+
768
+
769
+ 注意:
770
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
771
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
764
772
  */
765
773
  CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
766
774
  /**
@@ -887,8 +895,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
887
895
  ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
888
896
  /**
889
897
  * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
890
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
891
- 进入web连接后与当前控制台操作保持一致
898
+
899
+ 本接口下面功能的签署页面链接的生成
900
+ - 创建印章
901
+ - 创建模板
902
+ - 修改模板
903
+ - 预览模板
904
+ - 预览合同流程
892
905
  */
893
906
  ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
894
907
  /**
@@ -476,11 +476,14 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
476
476
  return this.request("ChannelCreateOrganizationModifyQrCode", req, cb);
477
477
  }
478
478
  /**
479
- * 创建预发起合同
480
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
481
- 可指定合同信息不可更改,签署人信息不可更改
482
- 合同发起后,填写及签署流程与现有操作流程一致
483
- 注意:目前仅支持模板发起
479
+ * 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
480
+
481
+ 注意:
482
+ 1. **仅支持模板**发起
483
+ 2. 只支持PC浏览器操作使用
484
+
485
+ 嵌入的页面样式如下:
486
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
484
487
  */
485
488
  async ChannelCreatePrepareFlow(req, cb) {
486
489
  return this.request("ChannelCreatePrepareFlow", req, cb);
@@ -883,6 +886,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
883
886
  <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
884
887
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
885
888
  </ul>
889
+
890
+
891
+ 注意:
892
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
893
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
886
894
  */
887
895
  async CreateChannelOrganizationInfoChangeUrl(req, cb) {
888
896
  return this.request("CreateChannelOrganizationInfoChangeUrl", req, cb);
@@ -1023,8 +1031,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1023
1031
  }
1024
1032
  /**
1025
1033
  * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
1026
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
1027
- 进入web连接后与当前控制台操作保持一致
1034
+
1035
+ 本接口下面功能的签署页面链接的生成
1036
+ - 创建印章
1037
+ - 创建模板
1038
+ - 修改模板
1039
+ - 预览模板
1040
+ - 预览合同流程
1028
1041
  */
1029
1042
  async ChannelCreateEmbedWebUrl(req, cb) {
1030
1043
  return this.request("ChannelCreateEmbedWebUrl", req, cb);