tencentcloud-sdk-nodejs 4.0.652 → 4.0.653

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 (51) hide show
  1. package/CHANGELOG.md +200 -0
  2. package/SERVICE_CHANGELOG.md +233 -146
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdb/v20170320/cdb_models.ts +27 -27
  7. package/src/services/cdn/v20180606/cdn_models.ts +0 -1
  8. package/src/services/ckafka/v20190819/ckafka_models.ts +2 -2
  9. package/src/services/clb/v20180317/clb_models.ts +4 -6
  10. package/src/services/cls/v20201016/cls_models.ts +15 -15
  11. package/src/services/ess/v20201111/ess_client.ts +5 -4
  12. package/src/services/ess/v20201111/ess_models.ts +70 -30
  13. package/src/services/essbasic/v20210526/essbasic_client.ts +7 -1
  14. package/src/services/essbasic/v20210526/essbasic_models.ts +49 -33
  15. package/src/services/lcic/v20220817/lcic_models.ts +4 -0
  16. package/src/services/nlp/v20190408/nlp_models.ts +1 -1
  17. package/src/services/ocr/v20181119/ocr_client.ts +2 -34
  18. package/src/services/ocr/v20181119/ocr_models.ts +40 -209
  19. package/src/services/teo/v20220901/teo_models.ts +16 -16
  20. package/src/services/tione/v20211111/tione_client.ts +182 -22
  21. package/src/services/tione/v20211111/tione_models.ts +1203 -277
  22. package/src/services/waf/v20180125/waf_client.ts +13 -0
  23. package/src/services/waf/v20180125/waf_models.ts +58 -0
  24. package/tencentcloud/common/sdk_version.d.ts +1 -1
  25. package/tencentcloud/common/sdk_version.js +1 -1
  26. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +27 -27
  27. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +0 -1
  28. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +2 -2
  29. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -6
  30. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +15 -15
  31. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -4
  32. package/tencentcloud/services/ess/v20201111/ess_client.js +5 -4
  33. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +70 -30
  34. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +7 -1
  35. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -1
  36. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +49 -33
  37. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +4 -0
  38. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +1 -1
  39. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -15
  40. package/tencentcloud/services/ocr/v20181119/ocr_client.js +0 -18
  41. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +40 -203
  42. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +16 -16
  43. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +57 -5
  44. package/tencentcloud/services/tione/v20211111/tione_client.js +84 -6
  45. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +1135 -239
  46. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +5 -1
  47. package/tencentcloud/services/waf/v20180125/waf_client.js +6 -0
  48. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +55 -0
  49. package/test/ocr.v20181119.test.js +0 -20
  50. package/test/tione.v20211111.test.js +134 -4
  51. package/test/waf.v20180125.test.js +10 -0
@@ -524,7 +524,7 @@ export interface ReleasedApprover {
524
524
  */
525
525
  ApproverSignComponentType?: string;
526
526
  /**
527
- * 签署方自定义控件别名,最大长度20个字符
527
+ * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方, 依次类推. 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
528
528
  */
529
529
  ApproverSignRole?: string;
530
530
  }
@@ -880,14 +880,16 @@ export interface DescribeFlowComponentsResponse {
880
880
  */
881
881
  export interface DescribeFlowEvidenceReportResponse {
882
882
  /**
883
- * 报告 URL
883
+ * 出证报告PDF的下载 URL
884
884
  注意:此字段可能返回 null,表示取不到有效值。
885
885
  */
886
886
  ReportUrl?: string;
887
887
  /**
888
- * 执行中:EvidenceStatusExecuting
889
- 成功:EvidenceStatusSuccess
890
- 失败:EvidenceStatusFailed
888
+ * 出证任务执行的状态, 分布表示下面的含义
889
+
890
+ EvidenceStatusExecuting 出证任务在执行中
891
+ EvidenceStatusSuccess 出证任务执行成功
892
+ EvidenceStatusFailed 出征任务执行失败
891
893
  */
892
894
  Status?: string;
893
895
  /**
@@ -1218,7 +1220,10 @@ export interface CreateSchemeUrlRequest {
1218
1220
  */
1219
1221
  PathType?: number;
1220
1222
  /**
1221
- * 是否自动回跳 true:是, false:否。该参数只针对"APP" 类型的签署链接有效
1223
+ * 是否自动回跳
1224
+ true:是,
1225
+ false:否。
1226
+ 该参数只针对"APP" 类型的签署链接有效
1222
1227
  */
1223
1228
  AutoJumpBack?: boolean;
1224
1229
  /**
@@ -1253,23 +1258,40 @@ export interface AutoSignConfig {
1253
1258
  */
1254
1259
  UserInfo: UserThreeFactor;
1255
1260
  /**
1256
- * 接受自动签开启的回调地址。需要保证post返回200
1261
+ * 接受回调URL地址。支持http://或者https://协议
1262
+
1263
+ Post数据到此地址后后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
1257
1264
  */
1258
1265
  CallbackUrl: string;
1259
1266
  /**
1260
- * 是否回调证书信息,默认false-不需要
1267
+ * 是否回调证书信息
1268
+ false-不需要 (默认值)
1269
+ true-需要
1261
1270
  */
1262
1271
  CertInfoCallback?: boolean;
1263
1272
  /**
1264
- * 是否支持用户自定义签名印章,默认false-不需要
1273
+ * 是否支持用户自定义签名印章
1274
+ false-不需要(默认)
1275
+ true-需要
1265
1276
  */
1266
1277
  UserDefineSeal?: boolean;
1267
1278
  /**
1268
- * 是否需要回调的时候返回印章(签名) 图片的 base64,默认false-不需要
1279
+ * 是否需要回调的时候返回印章(签名) 图片的 base64
1280
+
1281
+ false-不需要(默认)
1282
+ true-需要(
1269
1283
  */
1270
1284
  SealImgCallback?: boolean;
1271
1285
  /**
1272
- * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1286
+ * 开通时候的验证方式, 分布为
1287
+
1288
+ WEIXINAPP : 微信人脸识别
1289
+ INSIGHT : 慧眼人脸认别
1290
+ TELECOM : 运营商三要素验证
1291
+
1292
+ 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
1293
+
1294
+ 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1273
1295
  */
1274
1296
  VerifyChannels?: Array<string>;
1275
1297
  }
@@ -1483,15 +1505,18 @@ export interface OrganizationInfo {
1483
1505
  */
1484
1506
  export interface DescribeUserAutoSignStatusResponse {
1485
1507
  /**
1486
- * 是否已开通自动签
1508
+ * 查询用户是否已开通自动签
1487
1509
  */
1488
1510
  IsOpen?: boolean;
1489
1511
  /**
1490
1512
  * 自动签许可生效时间。当且仅当已开通自动签时有值。
1513
+
1514
+ 值为unix时间戳,单位为秒。
1491
1515
  */
1492
1516
  LicenseFrom?: number;
1493
1517
  /**
1494
1518
  * 自动签许可到期时间。当且仅当已开通自动签时有值。
1519
+ 值为unix时间戳,单位为秒。
1495
1520
  */
1496
1521
  LicenseTo?: number;
1497
1522
  /**
@@ -1666,10 +1691,13 @@ export interface CreateBatchCancelFlowUrlResponse {
1666
1691
  BatchCancelFlowUrl?: string;
1667
1692
  /**
1668
1693
  * 签署流程撤回失败信息
1694
+ 数组里边的错误原因与传进来的FlowIds一一对应,如果是空字符串则标识没有出错
1669
1695
  */
1670
1696
  FailMessages?: Array<string>;
1671
1697
  /**
1672
1698
  * 签署连接过期时间字符串:年月日-时分秒
1699
+
1700
+ 例如:2023-07-28 17:25:59
1673
1701
  */
1674
1702
  UrlExpireOn?: string;
1675
1703
  /**
@@ -1846,7 +1874,7 @@ export interface CreateFlowSignReviewRequest {
1846
1874
  默认:SignReview;SignReview:签署审核
1847
1875
 
1848
1876
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
1849
- 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
1877
+ 若发起个人审核,则指定该字段为:SignReview
1850
1878
  */
1851
1879
  OperateType?: string;
1852
1880
  }
@@ -1905,7 +1933,7 @@ export interface CreateUserAutoSignEnableUrlResponse {
1905
1933
  */
1906
1934
  Path?: string;
1907
1935
  /**
1908
- * base64格式跳转二维码
1936
+ * base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
1909
1937
  */
1910
1938
  QrCode?: string;
1911
1939
  /**
@@ -2726,7 +2754,7 @@ export interface FailedUpdateStaffData {
2726
2754
  */
2727
2755
  export interface GetTaskResultApiRequest {
2728
2756
  /**
2729
- * 任务Id,通过CreateConvertTaskApi得到
2757
+ * 任务Id,通过接口CreateConvertTaskApi或CreateMergeFileTask得到的返回任务id
2730
2758
  */
2731
2759
  TaskId: string;
2732
2760
  /**
@@ -3382,15 +3410,20 @@ export interface CreateUserAutoSignEnableUrlRequest {
3382
3410
  */
3383
3411
  AutoSignConfig: AutoSignConfig;
3384
3412
  /**
3385
- * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
3413
+ * 链接类型,
3414
+ 空-默认小程序端链接
3415
+ H5SIGN-h5端链接
3386
3416
  */
3387
3417
  UrlType?: string;
3388
3418
  /**
3389
- * 通知类型,默认不填为不通知开通方,填写 SMS 为短信通知。
3419
+ * 通知类型
3420
+
3421
+ 默认不设置为不通知开通方,
3422
+ SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
3390
3423
  */
3391
3424
  NotifyType?: string;
3392
3425
  /**
3393
- * 若上方填写为 SMS,则此处为手机号
3426
+ * 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
3394
3427
  */
3395
3428
  NotifyAddress?: string;
3396
3429
  /**
@@ -3655,7 +3688,7 @@ export interface GetTaskResultApiResponse {
3655
3688
  */
3656
3689
  TaskMessage?: string;
3657
3690
  /**
3658
- * 资源Id,也是FileId,用于文件发起使用
3691
+ * 资源Id,也是FileId,用于文件发起时使用
3659
3692
  */
3660
3693
  ResourceId?: string;
3661
3694
  /**
@@ -4591,7 +4624,8 @@ export interface CreateBatchCancelFlowUrlRequest {
4591
4624
  */
4592
4625
  Operator: UserInfo;
4593
4626
  /**
4594
- * 需要执行撤回的签署流程id数组,最多100
4627
+ * 需要执行撤回的流程(合同)的编号列表,最多100个.
4628
+ 列表中的流程(合同)编号不要重复.
4595
4629
  */
4596
4630
  FlowIds: Array<string>;
4597
4631
  /**
@@ -4664,6 +4698,8 @@ export interface DescribeFlowInfoRequest {
4664
4698
  Operator?: UserInfo;
4665
4699
  /**
4666
4700
  * 需要查询的流程ID列表,限制最大100个
4701
+
4702
+ 如果查询合同组的信息,不要传此参数
4667
4703
  */
4668
4704
  FlowIds?: Array<string>;
4669
4705
  /**
@@ -4671,7 +4707,9 @@ export interface DescribeFlowInfoRequest {
4671
4707
  */
4672
4708
  Agent?: Agent;
4673
4709
  /**
4674
- * 合同组ID
4710
+ * 合同组ID, 如果传此参数会忽略FlowIds入参
4711
+ 所以如传此参数不要传FlowIds参数
4712
+
4675
4713
  */
4676
4714
  FlowGroupId?: string;
4677
4715
  }
@@ -4732,7 +4770,7 @@ export interface DescribeUserAutoSignStatusRequest {
4732
4770
  */
4733
4771
  SceneKey: string;
4734
4772
  /**
4735
- * 查询开启状态的用户信息
4773
+ * 要查询开启状态的用户信息
4736
4774
  */
4737
4775
  UserInfo: UserThreeFactor;
4738
4776
  /**
@@ -4796,20 +4834,20 @@ export interface FlowBrief {
4796
4834
  /**
4797
4835
  * 流程的编号ID
4798
4836
  */
4799
- FlowId: string;
4837
+ FlowId?: string;
4800
4838
  /**
4801
4839
  * 流程的名称
4802
4840
  */
4803
- FlowName: string;
4841
+ FlowName?: string;
4804
4842
  /**
4805
4843
  * 流程的描述信息
4806
4844
  注意:此字段可能返回 null,表示取不到有效值。
4807
4845
  */
4808
- FlowDescription: string;
4846
+ FlowDescription?: string;
4809
4847
  /**
4810
4848
  * 流程的类型
4811
4849
  */
4812
- FlowType: string;
4850
+ FlowType?: string;
4813
4851
  /**
4814
4852
  * 流程状态
4815
4853
  - 0 还没有发起
@@ -4826,17 +4864,19 @@ export interface FlowBrief {
4826
4864
  - 21 已解除
4827
4865
  注意:此字段可能返回 null,表示取不到有效值。
4828
4866
  */
4829
- FlowStatus: number;
4867
+ FlowStatus?: number;
4830
4868
  /**
4831
4869
  * 流程创建的时间戳,单位秒
4832
4870
  注意:此字段可能返回 null,表示取不到有效值。
4833
4871
  */
4834
- CreatedOn: number;
4872
+ CreatedOn?: number;
4835
4873
  /**
4836
- * 拒签或者取消的原因描述
4874
+ * 当合同被拒签或者取消后(当FlowStatus=3或者FlowStatus=6的时候)
4875
+ 此字段展示拒签或者取消的原因描述
4876
+
4837
4877
  注意:此字段可能返回 null,表示取不到有效值。
4838
4878
  */
4839
- FlowMessage: string;
4879
+ FlowMessage?: string;
4840
4880
  /**
4841
4881
  * 合同发起人userId
4842
4882
  注意:此字段可能返回 null,表示取不到有效值。
@@ -138,7 +138,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
138
138
  * 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
139
139
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
140
140
  接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
141
- 可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
141
+
142
+ 可以撤回:未全部签署完成
143
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
144
+
142
145
  注意:
143
146
  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
144
147
  */
@@ -189,6 +192,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
189
192
  * 指定需要批量撤销的签署流程Id,批量撤销合同
190
193
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
191
194
 
195
+ 可以撤回:未全部签署完成
196
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
197
+
192
198
  **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
193
199
 
194
200
  **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
@@ -198,7 +198,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
198
198
  * 指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows
199
199
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
200
200
  接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
201
- 可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。
201
+
202
+ 可以撤回:未全部签署完成
203
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
204
+
202
205
  注意:
203
206
  能撤回合同的只能是合同的发起人或者发起企业的超管、法人
204
207
  */
@@ -269,6 +272,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
269
272
  * 指定需要批量撤销的签署流程Id,批量撤销合同
270
273
  客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
271
274
 
275
+ 可以撤回:未全部签署完成
276
+ 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
277
+
272
278
  **满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。**
273
279
 
274
280
  **合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)**
@@ -416,7 +416,7 @@ export interface ChannelCreateFlowSignReviewRequest {
416
416
  注:接口通过该字段区分操作类型
417
417
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
418
418
  若想使用发起审核,请指定该字段为:CreateReview
419
- 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
419
+ 若发起个人审核,则指定该字段为:SignReview
420
420
  */
421
421
  OperateType?: string;
422
422
  }
@@ -443,7 +443,7 @@ export interface DescribeFlowDetailInfoRequest {
443
443
  Agent: Agent;
444
444
  /**
445
445
  * 合同(流程)编号数组,最多支持100个。
446
- (备注:该参数和合同组编号必须二选一)
446
+ (备注:该参数和合同组编号必须二选一, 如果填写FlowGroupId则忽略此FlowIds的入参)
447
447
  */
448
448
  FlowIds?: Array<string>;
449
449
  /**
@@ -691,6 +691,7 @@ export interface BaseFlowInfo {
691
691
  FlowName: string;
692
692
  /**
693
693
  * 合同流程类型
694
+ <br/>客户自定义,用于合同分类展示
694
695
  */
695
696
  FlowType: string;
696
697
  /**
@@ -703,6 +704,7 @@ export interface BaseFlowInfo {
703
704
  Deadline: number;
704
705
  /**
705
706
  * 是否顺序签署(true:无序签,false:顺序签)
707
+ <br/>默认false,有序签署合同
706
708
  */
707
709
  Unordered?: boolean;
708
710
  /**
@@ -714,7 +716,10 @@ export interface BaseFlowInfo {
714
716
  */
715
717
  FormFields?: Array<FormField>;
716
718
  /**
717
- * 本企业(发起方企业)是否需要签署审批,true:开启本企业签署审批。使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
719
+ * 本企业(发起方企业)是否需要签署审批
720
+ <br/>true:开启发起方签署审批
721
+ <br/>false:不开启发起方签署审批
722
+ <br/>开启后,使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
718
723
  */
719
724
  NeedSignReview?: boolean;
720
725
  /**
@@ -726,7 +731,10 @@ export interface BaseFlowInfo {
726
731
  */
727
732
  CcInfos?: Array<CcInfo>;
728
733
  /**
729
- * 是否需要发起前审核,当指定NeedCreateReview=true,则发起后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
734
+ * 是否需要开启发起方发起前审核
735
+ <br/>true:开启发起方发起前审核
736
+ <br/>false:不开启发起方发起前审核
737
+ <br/>当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
730
738
  */
731
739
  NeedCreateReview?: boolean;
732
740
  }
@@ -908,10 +916,6 @@ export interface ChannelCreatePrepareFlowRequest {
908
916
  * 合同流程基础信息
909
917
  */
910
918
  FlowInfo: BaseFlowInfo;
911
- /**
912
- * 合同签署人信息
913
- */
914
- FlowApproverList: Array<CommonFlowApprover>;
915
919
  /**
916
920
  * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
917
921
  */
@@ -920,6 +924,10 @@ export interface ChannelCreatePrepareFlowRequest {
920
924
  * 合同流程配置信息,用于配置发起合同时定制化
921
925
  */
922
926
  FlowOption?: CreateFlowOption;
927
+ /**
928
+ * 合同签署人信息
929
+ */
930
+ FlowApproverList?: Array<CommonFlowApprover>;
923
931
  /**
924
932
  * 通过flowid快速获得之前成功通过页面发起的合同生成链接
925
933
  */
@@ -3498,10 +3506,11 @@ export interface ChannelBatchCancelFlowsRequest {
3498
3506
  CancelMessage?: string;
3499
3507
  /**
3500
3508
  * 撤销理由自定义格式;选项:
3501
- 0 默认格式
3502
- 1 只保留身份信息:展示为【发起方】
3503
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
3504
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
3509
+
3510
+ - 0 默认格式
3511
+ - 1 只保留身份信息:展示为【发起方】
3512
+ - 2 保留身份信息+企业名称:展示为【发起方xxx公司】
3513
+ - 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
3505
3514
  */
3506
3515
  CancelMessageFormat?: number;
3507
3516
  /**
@@ -3893,14 +3902,17 @@ export interface OperateChannelTemplateRequest {
3893
3902
  */
3894
3903
  export interface CreateChannelFlowEvidenceReportResponse {
3895
3904
  /**
3896
- * 出证报告 ID,用于查询出证报告接口DescribeChannelFlowEvidenceReport时用到
3905
+ * 出证报告 ID,可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
3906
+
3897
3907
  注意:此字段可能返回 null,表示取不到有效值。
3898
3908
  */
3899
3909
  ReportId?: string;
3900
3910
  /**
3901
- * 执行中:EvidenceStatusExecuting
3902
- 成功:EvidenceStatusSuccess
3903
- 失败:EvidenceStatusFailed
3911
+ * 出征任务的执行状态,状态列表如下
3912
+
3913
+ - EvidenceStatusExecuting : 出征任务正在执行中
3914
+ - EvidenceStatusSuccess : 出征任务执行成功
3915
+ - EvidenceStatusFailed : 出征任务执行失败
3904
3916
  */
3905
3917
  Status?: string;
3906
3918
  /**
@@ -3973,14 +3985,16 @@ export interface ChannelCreateReleaseFlowResponse {
3973
3985
  */
3974
3986
  export interface DescribeChannelFlowEvidenceReportResponse {
3975
3987
  /**
3976
- * 出证报告 URL
3988
+ * 出证报告下载 URL
3977
3989
  注意:此字段可能返回 null,表示取不到有效值。
3978
3990
  */
3979
3991
  ReportUrl?: string;
3980
3992
  /**
3981
- * 执行中:EvidenceStatusExecuting
3982
- 成功:EvidenceStatusSuccess
3983
- 失败:EvidenceStatusFailed
3993
+ * 出征任务的执行状态,状态列表如下
3994
+
3995
+ - EvidenceStatusExecuting : 出征任务正在执行中
3996
+ - EvidenceStatusSuccess : 出征任务执行成功
3997
+ - EvidenceStatusFailed : 出征任务执行失败
3984
3998
  */
3985
3999
  Status?: string;
3986
4000
  /**
@@ -4073,23 +4087,25 @@ export interface ChannelCreateEmbedWebUrlRequest {
4073
4087
  */
4074
4088
  Agent: Agent;
4075
4089
  /**
4076
- * WEB嵌入资源类型。
4077
- CREATE_SEAL: 创建印章
4078
- CREATE_TEMPLATE:创建模板
4079
- MODIFY_TEMPLATE:修改模板
4080
- PREVIEW_TEMPLATE:预览模板
4081
- PREVIEW_FLOW:预览合同文档
4082
- PREVIEW_FLOW_DETAIL:预览合同详情
4083
- PREVIEW_SEAL_LIST:预览印章列表
4084
- PREVIEW_SEAL_DETAIL:预览印章详情
4085
- EXTEND_SERVICE:扩展服务
4090
+ * 要生成WEB嵌入界面的类型, 可以选择的值如下:
4091
+
4092
+ - CREATE_SEAL: 生成创建印章的嵌入页面
4093
+ - CREATE_TEMPLATE:生成创建模板的嵌入页面
4094
+ - MODIFY_TEMPLATE:生成修改模板的嵌入页面
4095
+ - PREVIEW_TEMPLATE:生成预览模板的嵌入页面
4096
+ - PREVIEW_FLOW:生成预览合同文档的嵌入页面
4097
+ - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面
4098
+ - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
4099
+ - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
4100
+ - EXTEND_SERVICE:生成扩展服务的嵌入页面
4086
4101
  */
4087
4102
  EmbedType: string;
4088
4103
  /**
4089
4104
  * WEB嵌入的业务资源ID
4090
- EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时必填,取值为模板id
4091
- PREVIEW_FLOWPREVIEW_FLOW_DETAIL时必填,取值为合同id
4092
- PREVIEW_SEAL_DETAIL,必填,取值为印章id
4105
+
4106
+ - 当EmbedType取值MODIFY_TEMPLATEPREVIEW_TEMPLATE时需要填写模板id作为BusinessId
4107
+ - 当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
4108
+ - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
4093
4109
  */
4094
4110
  BusinessId?: string;
4095
4111
  /**
@@ -1757,6 +1757,10 @@ export interface DescribeRoomResponse {
1757
1757
  * 低代码互动课堂的SdkAppId。
1758
1758
  */
1759
1759
  SdkAppId?: number;
1760
+ /**
1761
+ * 观看类型。互动观看 (默认)
1762
+ */
1763
+ AudienceType?: number;
1760
1764
  /**
1761
1765
  * 分辨率。可以有如下取值:
1762
1766
  1 标清
@@ -1108,7 +1108,7 @@ export interface ComposeCoupletRequest {
1108
1108
  */
1109
1109
  export interface EvaluateSentenceSimilarityRequest {
1110
1110
  /**
1111
- * 待分析的句子对数组。句子对应不超过1对,仅支持中文文本,原句子与目标句子均应不超过64字符。
1111
+ * 待分析的句子对数组。句子对应不超过1对,仅支持中文文本,原句子与目标句子均应不超过500字符。
1112
1112
  */
1113
1113
  SentencePairList: Array<SentencePair>;
1114
1114
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { RecognizeOnlineTaxiItineraryOCRResponse, BankSlipOCRRequest, BusinessCardOCRResponse, HKIDCardOCRRequest, CarInvoiceOCRRequest, RecognizeTravelCardOCRRequest, TrainTicketOCRRequest, EstateCertOCRResponse, FlightInvoiceOCRRequest, RecognizePhilippinesDrivingLicenseOCRRequest, MLIDPassportOCRRequest, SmartStructuralOCRV2Request, TextDetectResponse, TollInvoiceOCRResponse, VerifyBizLicenseResponse, FinanBillSliceOCRResponse, DriverLicenseOCRResponse, WaybillOCRResponse, CreateAIFormTaskRequest, VerifyBizLicenseRequest, PermitOCRResponse, InvoiceGeneralOCRRequest, RideHailingTransportLicenseOCRRequest, HmtResidentPermitOCRResponse, EnterpriseLicenseOCRResponse, RecognizePhilippinesVoteIDOCRRequest, InstitutionOCRResponse, DriverLicenseOCRRequest, RecognizeTableOCRResponse, QrcodeOCRResponse, MainlandPermitOCRRequest, SmartStructuralOCRV2Response, EnterpriseLicenseOCRRequest, BankCardOCRRequest, VehicleRegCertOCRRequest, PropOwnerCertOCRResponse, TrainTicketOCRResponse, RecognizePhilippinesTinIDOCRResponse, ArithmeticOCRResponse, FormulaOCRResponse, SmartStructuralOCRRequest, GeneralHandwritingOCRRequest, BizLicenseOCRRequest, MixedInvoiceDetectResponse, RecognizePhilippinesVoteIDOCRResponse, GeneralAccurateOCRResponse, HmtResidentPermitOCRRequest, QrcodeOCRRequest, TaxiInvoiceOCRResponse, RecognizeGeneralInvoiceRequest, GeneralBasicOCRResponse, RecognizeThaiIDCardOCRResponse, RecognizeMedicalInvoiceOCRResponse, MixedInvoiceOCRResponse, ClassifyDetectOCRResponse, VatInvoiceVerifyNewRequest, VehicleLicenseOCRResponse, RecognizePhilippinesSssIDOCRRequest, IDCardOCRResponse, ClassifyDetectOCRRequest, DutyPaidProofOCRResponse, TollInvoiceOCRRequest, LicensePlateOCRResponse, HKIDCardOCRResponse, OrgCodeCertOCRResponse, PermitOCRRequest, InvoiceGeneralOCRResponse, VatInvoiceVerifyNewResponse, RecognizePhilippinesSssIDOCRResponse, TaxiInvoiceOCRRequest, PropOwnerCertOCRRequest, RecognizeContainerOCRRequest, EduPaperOCRRequest, VatRollInvoiceOCRResponse, VatInvoiceVerifyRequest, EduPaperOCRResponse, RecognizeThaiIDCardOCRRequest, TableOCRRequest, ImageEnhancementResponse, PassportOCRResponse, VerifyBasicBizLicenseResponse, TextDetectRequest, RecognizeTravelCardOCRResponse, LicensePlateOCRRequest, GeneralBasicOCRRequest, RecognizeIndonesiaIDCardOCRResponse, GeneralEfficientOCRRequest, RecognizePhilippinesUMIDOCRResponse, AdvertiseOCRRequest, RideHailingDriverLicenseOCRResponse, EnglishOCRRequest, VatInvoiceVerifyResponse, SmartStructuralOCRResponse, RecognizeIndonesiaIDCardOCRRequest, GeneralAccurateOCRRequest, OrgCodeCertOCRRequest, FlightInvoiceOCRResponse, InstitutionOCRRequest, RideHailingDriverLicenseOCRRequest, QueryBarCodeResponse, ArithmeticOCRRequest, VerifyOfdVatInvoiceOCRRequest, FinanBillSliceOCRRequest, MLIDPassportOCRResponse, VatRollInvoiceOCRRequest, VerifyEnterpriseFourFactorsRequest, RecognizeTableAccurateOCRRequest, SealOCRResponse, FinanBillOCRResponse, RecognizeHealthCodeOCRRequest, BankSlipOCRResponse, VinOCRResponse, GetTaskStateResponse, FormulaOCRRequest, PassportOCRRequest, DutyPaidProofOCRRequest, RecognizeHealthCodeOCRResponse, QueryBarCodeRequest, CreateAIFormTaskResponse, MixedInvoiceOCRRequest, ResidenceBookletOCRResponse, CarInvoiceOCRResponse, VehicleRegCertOCRResponse, GeneralFastOCRRequest, ShipInvoiceOCRResponse, RecognizeGeneralInvoiceResponse, GetTaskStateRequest, RecognizeMedicalInvoiceOCRRequest, InsuranceBillOCRResponse, GeneralEfficientOCRResponse, ShipInvoiceOCRRequest, SealOCRRequest, VerifyOfdVatInvoiceOCRResponse, RecognizeTableAccurateOCRResponse, ResidenceBookletOCRRequest, BusInvoiceOCRResponse, MainlandPermitOCRResponse, MLIDCardOCRRequest, EnglishOCRResponse, BusInvoiceOCRRequest, QuotaInvoiceOCRResponse, RideHailingTransportLicenseOCRResponse, RecognizeContainerOCRResponse, InsuranceBillOCRRequest, ImageEnhancementRequest, GeneralHandwritingOCRResponse, TableOCRResponse, AdvertiseOCRResponse, VehicleLicenseOCRRequest, RecognizeOnlineTaxiItineraryOCRRequest, IDCardOCRRequest, MixedInvoiceDetectRequest, WaybillOCRRequest, VinOCRRequest, VatInvoiceOCRRequest, RecognizePhilippinesUMIDOCRRequest, MLIDCardOCRResponse, RecognizePhilippinesTinIDOCRRequest, RecognizeTableOCRRequest, EstateCertOCRRequest, VerifyBasicBizLicenseRequest, BizLicenseOCRResponse, VatInvoiceOCRResponse, QuotaInvoiceOCRRequest, BankCardOCRResponse, BusinessCardOCRRequest, RecognizePhilippinesDrivingLicenseOCRResponse, FinanBillOCRRequest, VerifyEnterpriseFourFactorsResponse, GeneralFastOCRResponse } from "./ocr_models";
3
+ import { RecognizeOnlineTaxiItineraryOCRResponse, BankSlipOCRRequest, BusinessCardOCRResponse, HKIDCardOCRRequest, CarInvoiceOCRRequest, RecognizeTravelCardOCRRequest, TrainTicketOCRRequest, EstateCertOCRResponse, FlightInvoiceOCRRequest, RecognizePhilippinesDrivingLicenseOCRRequest, MLIDPassportOCRRequest, SmartStructuralOCRV2Request, TextDetectResponse, TollInvoiceOCRResponse, VerifyBizLicenseResponse, FinanBillSliceOCRResponse, DriverLicenseOCRResponse, WaybillOCRResponse, CreateAIFormTaskRequest, VerifyBizLicenseRequest, PermitOCRResponse, InvoiceGeneralOCRRequest, RideHailingTransportLicenseOCRRequest, HmtResidentPermitOCRResponse, EnterpriseLicenseOCRResponse, RecognizePhilippinesVoteIDOCRRequest, InstitutionOCRResponse, DriverLicenseOCRRequest, RecognizeTableOCRResponse, QrcodeOCRResponse, MainlandPermitOCRRequest, SmartStructuralOCRV2Response, EnterpriseLicenseOCRRequest, BankCardOCRRequest, VehicleRegCertOCRRequest, PropOwnerCertOCRResponse, TrainTicketOCRResponse, RecognizePhilippinesTinIDOCRResponse, ArithmeticOCRResponse, FormulaOCRResponse, SmartStructuralOCRRequest, GeneralHandwritingOCRRequest, BizLicenseOCRRequest, MixedInvoiceDetectResponse, RecognizePhilippinesVoteIDOCRResponse, GeneralAccurateOCRResponse, HmtResidentPermitOCRRequest, QrcodeOCRRequest, TaxiInvoiceOCRResponse, RecognizeGeneralInvoiceRequest, GeneralBasicOCRResponse, RecognizeThaiIDCardOCRResponse, RecognizeMedicalInvoiceOCRResponse, MixedInvoiceOCRResponse, ClassifyDetectOCRResponse, VatInvoiceVerifyNewRequest, VehicleLicenseOCRResponse, RecognizePhilippinesSssIDOCRRequest, IDCardOCRResponse, ClassifyDetectOCRRequest, DutyPaidProofOCRResponse, TollInvoiceOCRRequest, LicensePlateOCRResponse, HKIDCardOCRResponse, OrgCodeCertOCRResponse, PermitOCRRequest, InvoiceGeneralOCRResponse, VatInvoiceVerifyNewResponse, RecognizePhilippinesSssIDOCRResponse, TaxiInvoiceOCRRequest, PropOwnerCertOCRRequest, RecognizeContainerOCRRequest, EduPaperOCRRequest, VatRollInvoiceOCRResponse, VatInvoiceVerifyRequest, EduPaperOCRResponse, RecognizeThaiIDCardOCRRequest, TableOCRRequest, ImageEnhancementResponse, PassportOCRResponse, VerifyBasicBizLicenseResponse, TextDetectRequest, RecognizeTravelCardOCRResponse, LicensePlateOCRRequest, GeneralBasicOCRRequest, RecognizeIndonesiaIDCardOCRResponse, GeneralEfficientOCRRequest, RecognizePhilippinesUMIDOCRResponse, AdvertiseOCRRequest, RideHailingDriverLicenseOCRResponse, ImageEnhancementRequest, EnglishOCRRequest, VatInvoiceVerifyResponse, SmartStructuralOCRResponse, RecognizeIndonesiaIDCardOCRRequest, GeneralAccurateOCRRequest, OrgCodeCertOCRRequest, FlightInvoiceOCRResponse, InstitutionOCRRequest, RideHailingDriverLicenseOCRRequest, ArithmeticOCRRequest, VerifyOfdVatInvoiceOCRRequest, FinanBillSliceOCRRequest, MLIDPassportOCRResponse, VatRollInvoiceOCRRequest, RecognizeTableAccurateOCRRequest, SealOCRResponse, FinanBillOCRResponse, RecognizeHealthCodeOCRRequest, BankSlipOCRResponse, VinOCRResponse, GetTaskStateResponse, FormulaOCRRequest, PassportOCRRequest, DutyPaidProofOCRRequest, RecognizeHealthCodeOCRResponse, CreateAIFormTaskResponse, MixedInvoiceOCRRequest, ResidenceBookletOCRResponse, CarInvoiceOCRResponse, VehicleRegCertOCRResponse, GeneralFastOCRRequest, ShipInvoiceOCRResponse, RecognizeGeneralInvoiceResponse, GetTaskStateRequest, RecognizeMedicalInvoiceOCRRequest, InsuranceBillOCRResponse, GeneralEfficientOCRResponse, ShipInvoiceOCRRequest, SealOCRRequest, VerifyOfdVatInvoiceOCRResponse, RecognizeTableAccurateOCRResponse, ResidenceBookletOCRRequest, BusInvoiceOCRResponse, MainlandPermitOCRResponse, MLIDCardOCRRequest, EnglishOCRResponse, BusInvoiceOCRRequest, QuotaInvoiceOCRResponse, RideHailingTransportLicenseOCRResponse, RecognizeContainerOCRResponse, InsuranceBillOCRRequest, GeneralHandwritingOCRResponse, TableOCRResponse, AdvertiseOCRResponse, VehicleLicenseOCRRequest, RecognizeOnlineTaxiItineraryOCRRequest, IDCardOCRRequest, MixedInvoiceDetectRequest, WaybillOCRRequest, VinOCRRequest, VatInvoiceOCRRequest, RecognizePhilippinesUMIDOCRRequest, MLIDCardOCRResponse, RecognizePhilippinesTinIDOCRRequest, RecognizeTableOCRRequest, EstateCertOCRRequest, VerifyBasicBizLicenseRequest, BizLicenseOCRResponse, VatInvoiceOCRResponse, QuotaInvoiceOCRRequest, BankCardOCRResponse, BusinessCardOCRRequest, RecognizePhilippinesDrivingLicenseOCRResponse, FinanBillOCRRequest, GeneralFastOCRResponse } from "./ocr_models";
4
4
  /**
5
5
  * ocr client
6
6
  * @class
@@ -27,14 +27,6 @@ export declare class Client extends AbstractClient {
27
27
  默认接口请求频率限制:10次/秒。
28
28
  */
29
29
  ImageEnhancement(req: ImageEnhancementRequest, cb?: (error: string, rep: ImageEnhancementResponse) => void): Promise<ImageEnhancementResponse>;
30
- /**
31
- * 库源服务调整,该接口在2023年6月1日将正式下线。
32
-
33
- 本接口支持条形码备案信息查询,返回条形码查询结果的相关信息,包括产品名称、产品英文名称、品牌名称、规格型号、宽度、高度、深度、关键字、产品描述、厂家名称、厂家地址、企业社会信用代码13个字段信息。
34
-
35
- 产品优势:直联中国物品编码中心,查询结果更加准确、可靠。
36
- */
37
- QueryBarCode(req: QueryBarCodeRequest, cb?: (error: string, rep: QueryBarCodeResponse) => void): Promise<QueryBarCodeResponse>;
38
30
  /**
39
31
  * 本接口支持智能提取各类证照、票据、表单、合同等结构化场景的key:value字段信息,并支持提取表格信息的key:value组的结构化,灵活高效,适用于各类非标准材料的信息录入场景,点击[立即体验](https://cloud.tencent.com/product/smart-ocr)。
40
32
 
@@ -426,12 +418,6 @@ export declare class Client extends AbstractClient {
426
418
  默认接口请求频率限制:5次/秒。
427
419
  */
428
420
  FinanBillSliceOCR(req: FinanBillSliceOCRRequest, cb?: (error: string, rep: FinanBillSliceOCRResponse) => void): Promise<FinanBillSliceOCRResponse>;
429
- /**
430
- * 库源服务调整,该接口在2023年6月1日将正式下线。
431
-
432
- 此接口基于企业四要素授权“姓名、证件号码、企业标识、企业全称”,验证企业信息是否一致。
433
- */
434
- VerifyEnterpriseFourFactors(req: VerifyEnterpriseFourFactorsRequest, cb?: (error: string, rep: VerifyEnterpriseFourFactorsResponse) => void): Promise<VerifyEnterpriseFourFactorsResponse>;
435
421
  /**
436
422
  * 本接口支持识别公路汽车客票关键字段的识别,包括发票代码、发票号码、日期、票价、始发地、目的地、姓名、时间、发票消费类型、身份证号、省、市、开票日期、乘车地点、检票口、客票类型、车型、座位号、车次等。
437
423
 
@@ -53,16 +53,6 @@ class Client extends abstract_client_1.AbstractClient {
53
53
  async ImageEnhancement(req, cb) {
54
54
  return this.request("ImageEnhancement", req, cb);
55
55
  }
56
- /**
57
- * 库源服务调整,该接口在2023年6月1日将正式下线。
58
-
59
- 本接口支持条形码备案信息查询,返回条形码查询结果的相关信息,包括产品名称、产品英文名称、品牌名称、规格型号、宽度、高度、深度、关键字、产品描述、厂家名称、厂家地址、企业社会信用代码13个字段信息。
60
-
61
- 产品优势:直联中国物品编码中心,查询结果更加准确、可靠。
62
- */
63
- async QueryBarCode(req, cb) {
64
- return this.request("QueryBarCode", req, cb);
65
- }
66
56
  /**
67
57
  * 本接口支持智能提取各类证照、票据、表单、合同等结构化场景的key:value字段信息,并支持提取表格信息的key:value组的结构化,灵活高效,适用于各类非标准材料的信息录入场景,点击[立即体验](https://cloud.tencent.com/product/smart-ocr)。
68
58
 
@@ -532,14 +522,6 @@ class Client extends abstract_client_1.AbstractClient {
532
522
  async FinanBillSliceOCR(req, cb) {
533
523
  return this.request("FinanBillSliceOCR", req, cb);
534
524
  }
535
- /**
536
- * 库源服务调整,该接口在2023年6月1日将正式下线。
537
-
538
- 此接口基于企业四要素授权“姓名、证件号码、企业标识、企业全称”,验证企业信息是否一致。
539
- */
540
- async VerifyEnterpriseFourFactors(req, cb) {
541
- return this.request("VerifyEnterpriseFourFactors", req, cb);
542
- }
543
525
  /**
544
526
  * 本接口支持识别公路汽车客票关键字段的识别,包括发票代码、发票号码、日期、票价、始发地、目的地、姓名、时间、发票消费类型、身份证号、省、市、开票日期、乘车地点、检票口、客票类型、车型、座位号、车次等。
545
527