tencentcloud-sdk-nodejs 4.0.767 → 4.0.769

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 (77) hide show
  1. package/CHANGELOG.md +244 -0
  2. package/SERVICE_CHANGELOG.md +270 -130
  3. package/package.json +1 -1
  4. package/products.md +23 -23
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_models.ts +3 -4
  7. package/src/services/cat/v20180409/cat_models.ts +2 -2
  8. package/src/services/cfw/v20190904/cfw_models.ts +7 -7
  9. package/src/services/cwp/v20180228/cwp_client.ts +1 -1
  10. package/src/services/cwp/v20180228/cwp_models.ts +17 -13
  11. package/src/services/dbbrain/v20191016/dbbrain_models.ts +1 -1
  12. package/src/services/dnspod/v20210323/dnspod_client.ts +9 -6
  13. package/src/services/ess/v20201111/ess_client.ts +54 -11
  14. package/src/services/ess/v20201111/ess_models.ts +103 -23
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +21 -22
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +43 -24
  17. package/src/services/ivld/v20210903/ivld_models.ts +3 -3
  18. package/src/services/oceanus/v20190422/oceanus_client.ts +14 -2
  19. package/src/services/oceanus/v20190422/oceanus_models.ts +71 -13
  20. package/src/services/omics/v20221128/omics_models.ts +21 -4
  21. package/src/services/scf/v20180416/scf_models.ts +6 -2
  22. package/src/services/ssm/v20190923/ssm_models.ts +2 -2
  23. package/src/services/tcss/v20201101/tcss_models.ts +29 -5
  24. package/src/services/teo/v20220901/teo_models.ts +5 -5
  25. package/src/services/tiw/v20190919/tiw_models.ts +101 -10
  26. package/src/services/trp/v20210515/trp_client.ts +1 -1
  27. package/src/services/trp/v20210515/trp_models.ts +17 -3
  28. package/src/services/tse/v20201207/tse_client.ts +76 -16
  29. package/src/services/tse/v20201207/tse_models.ts +237 -58
  30. package/src/services/tsf/v20180326/tsf_client.ts +1 -1
  31. package/src/services/tsf/v20180326/tsf_models.ts +25 -21
  32. package/src/services/vod/v20180717/vod_models.ts +6 -6
  33. package/src/services/wedata/v20210820/wedata_client.ts +55 -16
  34. package/src/services/wedata/v20210820/wedata_models.ts +552 -71
  35. package/tencentcloud/common/sdk_version.d.ts +1 -1
  36. package/tencentcloud/common/sdk_version.js +1 -1
  37. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +3 -4
  38. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +2 -2
  39. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +7 -7
  40. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1 -1
  41. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +17 -13
  42. package/tencentcloud/services/dbbrain/v20191016/dbbrain_models.d.ts +1 -1
  43. package/tencentcloud/services/dnspod/v20210323/dnspod_client.d.ts +3 -0
  44. package/tencentcloud/services/dnspod/v20210323/dnspod_client.js +3 -0
  45. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +47 -12
  46. package/tencentcloud/services/ess/v20201111/ess_client.js +48 -11
  47. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +101 -23
  48. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +20 -21
  49. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +20 -21
  50. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +42 -23
  51. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +3 -3
  52. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +5 -1
  53. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +6 -0
  54. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +68 -12
  55. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +21 -4
  56. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +6 -2
  57. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +2 -2
  58. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +29 -5
  59. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +5 -5
  60. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +101 -10
  61. package/tencentcloud/services/trp/v20210515/trp_client.d.ts +1 -1
  62. package/tencentcloud/services/trp/v20210515/trp_client.js +1 -1
  63. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +17 -3
  64. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +25 -5
  65. package/tencentcloud/services/tse/v20201207/tse_client.js +36 -6
  66. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +227 -58
  67. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +1 -1
  68. package/tencentcloud/services/tsf/v20180326/tsf_client.js +1 -1
  69. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +25 -21
  70. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +6 -6
  71. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +17 -5
  72. package/tencentcloud/services/wedata/v20210820/wedata_client.js +24 -6
  73. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +545 -73
  74. package/test/ess.v20201111.test.js +10 -0
  75. package/test/oceanus.v20190422.test.js +10 -0
  76. package/test/tse.v20201207.test.js +54 -4
  77. package/test/wedata.v20210820.test.js +34 -4
@@ -554,35 +554,32 @@ export interface CreateMultiFlowSignQRCodeResponse {
554
554
  */
555
555
  export interface FlowApproverUrlInfo {
556
556
  /**
557
- * 签署短链接。</br>
557
+ * 签署短链接。
558
558
  注意:
559
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
560
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
561
- 注意:此字段可能返回 null,表示取不到有效值。
559
+ 1. 该链接有效期为<b>30分钟</b>,同时需要注意保密,不要外泄给无关用户。
560
+ 2. 该链接不支持小程序嵌入,仅支持<b>移动端浏览器</b>打开。
561
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
562
562
  */
563
563
  SignUrl?: string
564
564
  /**
565
565
  * 签署人类型。
566
566
  - **1**: 个人
567
- 注意:此字段可能返回 null,表示取不到有效值。
568
567
  */
569
568
  ApproverType?: number
570
569
  /**
571
570
  * 签署人姓名。
572
- 注意:此字段可能返回 null,表示取不到有效值。
573
571
  */
574
572
  ApproverName?: string
575
573
  /**
576
574
  * 签署人手机号。
577
- 注意:此字段可能返回 null,表示取不到有效值。
578
575
  */
579
576
  ApproverMobile?: string
580
577
  /**
581
- * 签署长链接。</br>
578
+ * 签署长链接。
582
579
  注意:
583
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
584
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
585
- 注意:此字段可能返回 null,表示取不到有效值。
580
+ 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
581
+ 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
582
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
586
583
  */
587
584
  LongUrl?: string
588
585
  }
@@ -711,6 +708,52 @@ export interface DisableUserAutoSignResponse {
711
708
  RequestId?: string
712
709
  }
713
710
 
711
+ /**
712
+ * ModifyExtendedService请求参数结构体
713
+ */
714
+ export interface ModifyExtendedServiceRequest {
715
+ /**
716
+ * 执行本接口操作的员工信息。
717
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
718
+ */
719
+ Operator: UserInfo
720
+ /**
721
+ * 要管理的拓展服务类型。
722
+ <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
723
+ <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
724
+ <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
725
+ <li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>
726
+ <li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>
727
+ <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
728
+ <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
729
+ <li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>
730
+ <li>PAGING_SEAL:骑缝章</li>
731
+ <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>
732
+ */
733
+ ServiceType: string
734
+ /**
735
+ * 操作类型
736
+ <ul>
737
+ <li>OPEN : 开通</li>
738
+ <li>CLOSE : 关闭</li>
739
+ </ul>
740
+ */
741
+ Operate: string
742
+ /**
743
+ * 代理企业和员工的信息。
744
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
745
+ */
746
+ Agent?: Agent
747
+ /**
748
+ * 链接跳转类型,支持以下类型
749
+ <ul>
750
+ <li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
751
+ <li>APP : 第三方APP或小程序跳转电子签小程序</li>
752
+ </ul>
753
+ */
754
+ Endpoint?: string
755
+ }
756
+
714
757
  /**
715
758
  * CancelUserAutoSignEnableUrl返回参数结构体
716
759
  */
@@ -1176,7 +1219,9 @@ export interface CreateBatchSignUrlResponse {
1176
1219
  /**
1177
1220
  * 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
1178
1221
 
1179
- 注: `非小程序和APP集成使用`
1222
+ 注:
1223
+ 1. 非小程序和APP集成使用
1224
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1180
1225
  */
1181
1226
  SignUrl?: string
1182
1227
  /**
@@ -1186,7 +1231,9 @@ export interface CreateBatchSignUrlResponse {
1186
1231
  /**
1187
1232
  * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
1188
1233
 
1189
- 注: `小程序和APP集成使用`
1234
+ 注:
1235
+ 1. 小程序和APP集成使用
1236
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1190
1237
  */
1191
1238
  MiniAppPath?: string
1192
1239
  /**
@@ -2954,6 +3001,9 @@ export interface CreateSchemeUrlResponse {
2954
3001
  <ul><li>如果EndPoint是**APP**,得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
2955
3002
  <li>如果EndPoint是**HTTP**,得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`,点击后会跳转到腾讯电子签小程序进行签署</li>
2956
3003
  <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
3004
+
3005
+
3006
+ 注: <font color="red">生成的链路后面不能再增加参数</font>
2957
3007
  */
2958
3008
  SchemeUrl?: string
2959
3009
  /**
@@ -3705,11 +3755,17 @@ export interface ModifyIntegrationRoleResponse {
3705
3755
  export interface ExtendAuthInfo {
3706
3756
  /**
3707
3757
  * 扩展服务的类型,可能是以下值:
3708
- <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
3758
+ <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
3759
+ <li>BATCH_SIGN:批量签署</li>
3709
3760
  <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
3710
- <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
3761
+ <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
3762
+ <li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>
3763
+ <li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>
3764
+ <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
3765
+ <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
3766
+ <li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>
3711
3767
  <li>PAGING_SEAL:骑缝章</li>
3712
- <li>BATCH_SIGN:批量签署</li></ul>
3768
+ <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>
3713
3769
  */
3714
3770
  Type?: string
3715
3771
  /**
@@ -3718,8 +3774,10 @@ export interface ExtendAuthInfo {
3718
3774
  Name?: string
3719
3775
  /**
3720
3776
  * 扩展服务的开通状态:
3721
- ENABLE:开通
3722
- DISABLE:未开通
3777
+ <ul>
3778
+ <li>ENABLE : 已开通</li>
3779
+ <li>DISABLE : 未开通</li>
3780
+ </ul>
3723
3781
  */
3724
3782
  Status?: string
3725
3783
  /**
@@ -5919,6 +5977,24 @@ export interface CreateEmbedWebUrlResponse {
5919
5977
  RequestId?: string
5920
5978
  }
5921
5979
 
5980
+ /**
5981
+ * ModifyExtendedService返回参数结构体
5982
+ */
5983
+ export interface ModifyExtendedServiceResponse {
5984
+ /**
5985
+ * 操作跳转链接,有效期24小时
5986
+ 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
5987
+
5988
+ 当操作类型是 OPEN 且 扩展服务类型是 OPEN_SERVER_SIGN 或者 OVERSEA_SIGN 时返回操作链接,
5989
+ 返回的链接当前操作人(超管或法人)点击链接完成服务开通操作。
5990
+ */
5991
+ OperateUrl?: string
5992
+ /**
5993
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5994
+ */
5995
+ RequestId?: string
5996
+ }
5997
+
5922
5998
  /**
5923
5999
  * CreateSealPolicy请求参数结构体
5924
6000
  */
@@ -6374,13 +6450,17 @@ export interface DescribeExtendedServiceAuthInfosRequest {
6374
6450
  * 要查询的扩展服务类型。
6375
6451
  默认为空,即查询当前支持的所有扩展服务信息。
6376
6452
  若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
6377
- <ul><li>OPEN_SERVER_SIGN:企业静默签署</li>
6453
+ <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
6454
+ <li>BATCH_SIGN:批量签署</li>
6378
6455
  <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
6379
- <li>MOBILE_CHECK_APPROVER:使用手机号验证签署方身份</li>
6456
+ <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
6457
+ <li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>
6458
+ <li>HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名</li>
6459
+ <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
6460
+ <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
6461
+ <li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>
6380
6462
  <li>PAGING_SEAL:骑缝章</li>
6381
- <li>BATCH_SIGN:批量签署</li>
6382
- <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li></ul>
6383
-
6463
+ <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>
6384
6464
  */
6385
6465
  ExtendServiceType?: string
6386
6466
  /**
@@ -273,28 +273,21 @@ export class Client extends AbstractClient {
273
273
  }
274
274
 
275
275
  /**
276
- * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
276
+ * 管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
277
277
 
278
278
  跳转小程序的几种方式:主要是设置不同的EndPoint
279
279
  1. 通过链接Url直接跳转到小程序,不需要返回
280
280
  设置EndPoint为WEIXINAPP,得到链接打开即可。
281
281
 
282
282
  2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
283
- 跳转到小程序的实现,参考官方文档
284
- https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
285
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
283
+ 跳转到小程序的实现,参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
286
284
  设置EndPoint为APP,得到path。
287
285
 
288
- 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
289
- 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
290
- 全屏方式:
291
- (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
292
- 半屏方式:
293
- (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
294
- 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
286
+ 3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
287
+ 跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
295
288
  设置EndPoint为APP,得到path。
296
289
 
297
- 其中小程序的原始Id如下,或者查看小程序信息自助获取。
290
+ 4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
298
291
 
299
292
  | 小程序 | AppID | 原始ID |
300
293
  | ------------ | ------------ | ------------ |
@@ -461,14 +454,20 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
461
454
 
462
455
  /**
463
456
  * 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
464
- 1. 企业自动签
465
- 2. 企业与港澳台居民签署合同
466
- 3. 使用手机号验证签署方身份
467
- 4. 骑缝章
468
- 5. 拓宽签署方年龄限制
469
- 6. 下载企业合同/文件
470
-
471
- 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
457
+
458
+ 1. **企业自动签**
459
+ 2. **企业与港澳台居民签署合同**
460
+ 3. **使用手机号验证签署方身份**
461
+ 4. **骑缝章**
462
+ 5. **拓宽签署方年龄限制**
463
+ 6. **下载企业合同/文件**
464
+ 7. **隐藏合同经办人姓名**
465
+
466
+ 对应能力开通页面在子客控制台-企业中心-拓展服务,如下图所示:
467
+
468
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/931a1e02955ab36e5cc69a489af10352.jpg)
469
+
470
+ 注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
472
471
  */
473
472
  async DescribeExtendedServiceAuthInfo(
474
473
  req: DescribeExtendedServiceAuthInfoRequest,
@@ -815,8 +814,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
815
814
  | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
816
815
  | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
817
816
  | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
818
- |APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
819
- |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
817
+ |APP| <font color="red">贵方APP</font>跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
818
+ |APP| <font color="red">贵方小程序</font>跳转腾讯电子签小程序签署场景| 贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
820
819
  */
821
820
  async CreateSignUrls(
822
821
  req: CreateSignUrlsRequest,
@@ -678,18 +678,21 @@ export interface ModifyExtendedServiceRequest {
678
678
  * 扩展服务类型
679
679
  <ul>
680
680
  <li>AUTO_SIGN 企业自动签(自动签署)</li>
681
- <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
681
+ <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
682
682
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
683
683
  <li> PAGING_SEAL 骑缝章</li>
684
684
  <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
685
685
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
686
+ <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
686
687
  </ul>
687
688
  */
688
689
  ServiceType: string
689
690
  /**
690
- * 操作类型
691
- OPEN:开通
692
- CLOSE:关闭
691
+ * 操作类型
692
+ <ul>
693
+ <li>OPEN : 开通</li>
694
+ <li>CLOSE : 关闭</li>
695
+ </ul>
693
696
  */
694
697
  Operate: string
695
698
  /**
@@ -835,7 +838,9 @@ export interface ChannelCreateBatchSignUrlResponse {
835
838
  /**
836
839
  * 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
837
840
 
838
- 注: `非小程序和APP集成使用`
841
+ 注:
842
+ 1. 非小程序和APP集成使用
843
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
839
844
  */
840
845
  SignUrl?: string
841
846
  /**
@@ -845,7 +850,9 @@ export interface ChannelCreateBatchSignUrlResponse {
845
850
  /**
846
851
  * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
847
852
 
848
- 注: `小程序和APP集成使用`
853
+ 注:
854
+ 1. 小程序和APP集成使用
855
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
849
856
  */
850
857
  MiniAppPath?: string
851
858
  /**
@@ -1228,9 +1235,11 @@ export interface CreateConsoleLoginUrlResponse {
1228
1235
  /**
1229
1236
  * 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
1230
1237
  <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>
1238
+
1231
1239
  注:
1232
- `1.链接仅单次有效,每次登录需要需要重新创建新的链接`
1233
- `2.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`
1240
+ 1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
1241
+ 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
1242
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1234
1243
 
1235
1244
  */
1236
1245
  ConsoleUrl?: string
@@ -1747,10 +1756,12 @@ export interface DownloadFlowInfo {
1747
1756
  */
1748
1757
  export interface FlowApproverUrlInfo {
1749
1758
  /**
1750
- * 签署短链接。</br>
1759
+ * 签署短链接。
1760
+
1751
1761
  注意:
1752
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1753
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1762
+ 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1763
+ 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1764
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1754
1765
  */
1755
1766
  SignUrl?: string
1756
1767
  /**
@@ -1767,10 +1778,12 @@ export interface FlowApproverUrlInfo {
1767
1778
  */
1768
1779
  Mobile?: string
1769
1780
  /**
1770
- * 签署长链接。</br>
1781
+ * 签署长链接。
1782
+
1771
1783
  注意:
1772
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1773
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1784
+ 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1785
+ 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1786
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1774
1787
  注意:此字段可能返回 null,表示取不到有效值。
1775
1788
  */
1776
1789
  LongUrl?: string
@@ -2522,7 +2535,7 @@ export interface TemplateInfo {
2522
2535
  */
2523
2536
  Recipients?: Array<Recipient>
2524
2537
  /**
2525
- * 此模版中的签署控件列表
2538
+ * 此模板中的签署控件列表
2526
2539
  */
2527
2540
  SignComponents?: Array<Component>
2528
2541
  /**
@@ -3266,10 +3279,10 @@ export interface CreateConsoleLoginUrlRequest {
3266
3279
  MenuStatus?: string
3267
3280
  /**
3268
3281
  * 生成链接的类型:
3269
- <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
3282
+ <ul><li>**PC**:(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
3270
3283
  <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
3271
- <li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
3272
- <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
3284
+ <li>**SHORT_URL**:<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
3285
+ <li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
3273
3286
  */
3274
3287
  Endpoint?: string
3275
3288
  /**
@@ -3330,6 +3343,8 @@ export interface OrganizationInfo {
3330
3343
  export interface SignUrlInfo {
3331
3344
  /**
3332
3345
  * 签署链接,过期时间为90天
3346
+
3347
+ 注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
3333
3348
  注意:此字段可能返回 null,表示取不到有效值。
3334
3349
  */
3335
3350
  SignUrl?: string
@@ -3898,10 +3913,11 @@ export interface DescribeExtendedServiceAuthInfoRequest {
3898
3913
 
3899
3914
  此接口下面信息必填。
3900
3915
  <ul>
3901
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3902
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3903
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3916
+ <li>渠道应用标识: Agent.AppId</li>
3917
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3918
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3904
3919
  </ul>
3920
+ 第三方平台子客企业和员工必须已经经过实名认证
3905
3921
  */
3906
3922
  Agent: Agent
3907
3923
  }
@@ -5439,11 +5455,12 @@ export interface ExtentServiceAuthInfo {
5439
5455
  * 扩展服务类型
5440
5456
  <ul>
5441
5457
  <li>AUTO_SIGN 企业自动签(自动签署)</li>
5442
- <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
5458
+ <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
5443
5459
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
5444
5460
  <li> PAGING_SEAL 骑缝章</li>
5445
5461
  <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
5446
5462
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
5463
+ <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
5447
5464
  </ul>
5448
5465
  */
5449
5466
  Type?: string
@@ -6164,8 +6181,8 @@ export interface ModifyExtendedServiceResponse {
6164
6181
  * 操作跳转链接,有效期24小时
6165
6182
  若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
6166
6183
 
6167
- 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
6168
- 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
6184
+ 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
6185
+ 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作
6169
6186
  */
6170
6187
  OperateUrl?: string
6171
6188
  /**
@@ -7080,6 +7097,8 @@ export interface UsageDetail {
7080
7097
  export interface ChannelCreateBatchCancelFlowUrlResponse {
7081
7098
  /**
7082
7099
  * 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
7100
+
7101
+ 注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
7083
7102
  */
7084
7103
  BatchCancelFlowUrl?: string
7085
7104
  /**
@@ -1539,11 +1539,11 @@ export interface AppearIndexPair {
1539
1539
  /**
1540
1540
  * 出现信息,取值范围为[1,3]
1541
1541
  */
1542
- AppearIndex: number
1542
+ AppearIndex?: number
1543
1543
  /**
1544
- * AppearInfo中AppearIndex对应元素的第Index元素,从0开始技术
1544
+ * AppearInfo中AppearIndex对应元素的第Index元素,从0开始计数
1545
1545
  */
1546
- Index: number
1546
+ Index?: number
1547
1547
  }
1548
1548
 
1549
1549
  /**
@@ -24,6 +24,7 @@ import {
24
24
  DescribeJobSubmissionLogResponse,
25
25
  DeleteJobsRequest,
26
26
  ModifyWorkSpaceRequest,
27
+ ModifyJobResponse,
27
28
  CreateJobConfigResponse,
28
29
  CreateResourceConfigResponse,
29
30
  CreateJobConfigRequest,
@@ -62,9 +63,10 @@ import {
62
63
  StatementResult,
63
64
  DescribeTreeJobsRsp,
64
65
  DeleteResourcesResponse,
65
- ModifyJobResponse,
66
+ DeleteTableConfigResponse,
66
67
  SlotSharingGroupSpec,
67
68
  Tag,
69
+ GetMetaTableResponse,
68
70
  FetchSqlGatewayStatementResultResponse,
69
71
  JobGraphNode,
70
72
  CreateWorkSpaceRequest,
@@ -110,6 +112,7 @@ import {
110
112
  ClusterGroupSetItem,
111
113
  DescribeJobConfigsRequest,
112
114
  ModifyJobRequest,
115
+ GetMetaTableRequest,
113
116
  ResultData,
114
117
  DeleteResourceConfigsResponse,
115
118
  Cluster,
@@ -124,7 +127,6 @@ import {
124
127
  RunSqlGatewayStatementResponse,
125
128
  CreateJobRequest,
126
129
  JobInstanceForSubmissionLog,
127
- DeleteTableConfigResponse,
128
130
  DescribeFolderRequest,
129
131
  DeleteFoldersResponse,
130
132
  SubFolderInfo,
@@ -522,6 +524,16 @@ export class Client extends AbstractClient {
522
524
  return this.request("DescribeSystemResources", req, cb)
523
525
  }
524
526
 
527
+ /**
528
+ * 查询元数据表
529
+ */
530
+ async GetMetaTable(
531
+ req: GetMetaTableRequest,
532
+ cb?: (error: string, rep: GetMetaTableResponse) => void
533
+ ): Promise<GetMetaTableResponse> {
534
+ return this.request("GetMetaTable", req, cb)
535
+ }
536
+
525
537
  /**
526
538
  * 查询作业配置列表,一次最多查询100个
527
539
  */
@@ -200,6 +200,16 @@ export interface ModifyWorkSpaceRequest {
200
200
  Description?: string
201
201
  }
202
202
 
203
+ /**
204
+ * ModifyJob返回参数结构体
205
+ */
206
+ export interface ModifyJobResponse {
207
+ /**
208
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
209
+ */
210
+ RequestId?: string
211
+ }
212
+
203
213
  /**
204
214
  * CreateJobConfig返回参数结构体
205
215
  */
@@ -1217,9 +1227,9 @@ export interface DeleteResourcesResponse {
1217
1227
  }
1218
1228
 
1219
1229
  /**
1220
- * ModifyJob返回参数结构体
1230
+ * DeleteTableConfig返回参数结构体
1221
1231
  */
1222
- export interface ModifyJobResponse {
1232
+ export interface DeleteTableConfigResponse {
1223
1233
  /**
1224
1234
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1225
1235
  */
@@ -1268,6 +1278,42 @@ export interface Tag {
1268
1278
  TagValue?: string
1269
1279
  }
1270
1280
 
1281
+ /**
1282
+ * GetMetaTable返回参数结构体
1283
+ */
1284
+ export interface GetMetaTableResponse {
1285
+ /**
1286
+ * 元数据表唯一标识
1287
+ */
1288
+ SerialId?: string
1289
+ /**
1290
+ * Catalog名
1291
+ */
1292
+ Catalog?: string
1293
+ /**
1294
+ * Database名
1295
+ */
1296
+ Database?: string
1297
+ /**
1298
+ * Table名
1299
+ */
1300
+ Table?: string
1301
+ /**
1302
+ * 建表语句,使用 Base64 编码。
1303
+ 例如
1304
+ Q1JFQVRFIFRBQkxFIGRhdGFnZW5fc291cmNlX3RhYmxlICggCiAgICBpZCBJTlQsIAogICAgbmFtZSBTVFJJTkcgCikgV0lUSCAoCidjb25uZWN0b3InPSdkYXRhZ2VuJywKJ3Jvd3MtcGVyLXNlY29uZCcgPSAnMScKKTs=
1305
+ */
1306
+ DDL?: string
1307
+ /**
1308
+ * 场景时间
1309
+ */
1310
+ CreateTime?: string
1311
+ /**
1312
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1313
+ */
1314
+ RequestId?: string
1315
+ }
1316
+
1271
1317
  /**
1272
1318
  * FetchSqlGatewayStatementResult返回参数结构体
1273
1319
  */
@@ -1524,7 +1570,7 @@ export interface CreateFolderResponse {
1524
1570
  /**
1525
1571
  * 新建文件夹的唯一ID
1526
1572
  */
1527
- FolderId: string
1573
+ FolderId?: string
1528
1574
  /**
1529
1575
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1530
1576
  */
@@ -2482,6 +2528,28 @@ export interface ModifyJobRequest {
2482
2528
  WorkSpaceId?: string
2483
2529
  }
2484
2530
 
2531
+ /**
2532
+ * GetMetaTable请求参数结构体
2533
+ */
2534
+ export interface GetMetaTableRequest {
2535
+ /**
2536
+ * Catalog名
2537
+ */
2538
+ Catalog: string
2539
+ /**
2540
+ * Database名
2541
+ */
2542
+ Database: string
2543
+ /**
2544
+ * Table名
2545
+ */
2546
+ Table: string
2547
+ /**
2548
+ * 空间唯一标识
2549
+ */
2550
+ WorkSpaceId: string
2551
+ }
2552
+
2485
2553
  /**
2486
2554
  * Sql Gateway返回数据
2487
2555
  */
@@ -3247,16 +3315,6 @@ export interface JobInstanceForSubmissionLog {
3247
3315
  StartingMillis: number
3248
3316
  }
3249
3317
 
3250
- /**
3251
- * DeleteTableConfig返回参数结构体
3252
- */
3253
- export interface DeleteTableConfigResponse {
3254
- /**
3255
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3256
- */
3257
- RequestId?: string
3258
- }
3259
-
3260
3318
  /**
3261
3319
  * DescribeFolder请求参数结构体
3262
3320
  */