tencentcloud-sdk-nodejs 4.0.893 → 4.0.895

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 (95) hide show
  1. package/CHANGELOG.md +332 -0
  2. package/SERVICE_CHANGELOG.md +354 -74
  3. package/package.json +1 -1
  4. package/products.md +27 -27
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_client.ts +34 -20
  7. package/src/services/aiart/v20221229/aiart_models.ts +85 -25
  8. package/src/services/asr/v20190614/asr_models.ts +4 -4
  9. package/src/services/clb/v20180317/clb_client.ts +13 -16
  10. package/src/services/cwp/v20180228/cwp_models.ts +37 -16
  11. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  12. package/src/services/ess/v20201111/ess_client.ts +16 -1
  13. package/src/services/ess/v20201111/ess_models.ts +65 -32
  14. package/src/services/essbasic/v20210526/essbasic_client.ts +37 -22
  15. package/src/services/essbasic/v20210526/essbasic_models.ts +32 -11
  16. package/src/services/gaap/v20180529/gaap_client.ts +12 -0
  17. package/src/services/gaap/v20180529/gaap_models.ts +15 -0
  18. package/src/services/lighthouse/v20200324/lighthouse_models.ts +25 -25
  19. package/src/services/lke/v20231130/lke_client.ts +13 -0
  20. package/src/services/lke/v20231130/lke_models.ts +86 -1
  21. package/src/services/mariadb/v20170312/mariadb_client.ts +12 -0
  22. package/src/services/mariadb/v20170312/mariadb_models.ts +44 -0
  23. package/src/services/mna/v20210119/mna_client.ts +162 -53
  24. package/src/services/mna/v20210119/mna_models.ts +1200 -841
  25. package/src/services/mongodb/v20190725/mongodb_models.ts +58 -51
  26. package/src/services/monitor/v20180724/monitor_models.ts +1 -1
  27. package/src/services/mps/v20190612/mps_models.ts +15 -5
  28. package/src/services/oceanus/v20190422/oceanus_models.ts +10 -0
  29. package/src/services/organization/v20210331/organization_client.ts +1 -1
  30. package/src/services/rum/v20210622/rum_models.ts +4 -0
  31. package/src/services/tdmq/v20200217/tdmq_client.ts +0 -1
  32. package/src/services/tdmq/v20200217/tdmq_models.ts +9 -9
  33. package/src/services/thpc/v20230321/thpc_models.ts +5 -1
  34. package/src/services/tke/v20180525/tke_models.ts +3 -3
  35. package/src/services/trtc/v20190722/trtc_client.ts +1 -1
  36. package/src/services/trtc/v20190722/trtc_models.ts +8 -4
  37. package/src/services/tsf/v20180326/tsf_client.ts +25 -1
  38. package/src/services/tsf/v20180326/tsf_models.ts +78 -6
  39. package/src/services/vpc/v20170312/vpc_models.ts +1 -1
  40. package/tencentcloud/common/sdk_version.d.ts +1 -1
  41. package/tencentcloud/common/sdk_version.js +1 -1
  42. package/tencentcloud/services/aiart/v20221229/aiart_client.d.ts +18 -12
  43. package/tencentcloud/services/aiart/v20221229/aiart_client.js +21 -13
  44. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +84 -26
  45. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +4 -4
  46. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +13 -16
  47. package/tencentcloud/services/clb/v20180317/clb_client.js +13 -16
  48. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +37 -16
  49. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  50. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +8 -1
  51. package/tencentcloud/services/ess/v20201111/ess_client.js +9 -0
  52. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +63 -32
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -19
  54. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +28 -19
  55. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +30 -11
  56. package/tencentcloud/services/gaap/v20180529/gaap_client.d.ts +5 -1
  57. package/tencentcloud/services/gaap/v20180529/gaap_client.js +6 -0
  58. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +13 -0
  59. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +25 -25
  60. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +5 -1
  61. package/tencentcloud/services/lke/v20231130/lke_client.js +6 -0
  62. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +83 -1
  63. package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +5 -1
  64. package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +6 -0
  65. package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +42 -0
  66. package/tencentcloud/services/mna/v20210119/mna_client.d.ts +39 -3
  67. package/tencentcloud/services/mna/v20210119/mna_client.js +57 -3
  68. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +1172 -832
  69. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +58 -51
  70. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +1 -1
  71. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +15 -5
  72. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +10 -0
  73. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +1 -1
  74. package/tencentcloud/services/organization/v20210331/organization_client.js +1 -1
  75. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +4 -0
  76. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +0 -1
  77. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +0 -1
  78. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +9 -9
  79. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +5 -1
  80. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +3 -3
  81. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +1 -1
  82. package/tencentcloud/services/trtc/v20190722/trtc_client.js +1 -1
  83. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +8 -4
  84. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +9 -1
  85. package/tencentcloud/services/tsf/v20180326/tsf_client.js +12 -0
  86. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +74 -6
  87. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +1 -1
  88. package/test/aiart.v20221229.test.js +14 -4
  89. package/test/ess.v20201111.test.js +10 -0
  90. package/test/essbasic.v20210526.test.js +12 -2
  91. package/test/gaap.v20180529.test.js +10 -0
  92. package/test/lke.v20231130.test.js +10 -0
  93. package/test/mariadb.v20170312.test.js +10 -0
  94. package/test/mna.v20210119.test.js +92 -2
  95. package/test/tsf.v20180326.test.js +20 -0
@@ -891,6 +891,7 @@ export interface ModifyExtendedServiceRequest {
891
891
  /**
892
892
  * 要管理的拓展服务类型。
893
893
  <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
894
+ <li>AUTO_SIGN_CAN_FILL_IN:本企业自动签合同支持签前内容补充</li>
894
895
  <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
895
896
  <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
896
897
  <li>MOBILE_CHECK_APPROVER:个人签署方仅校验手机号</li>
@@ -898,7 +899,8 @@ export interface ModifyExtendedServiceRequest {
898
899
  <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
899
900
  <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
900
901
  <li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>
901
- <li>PAGING_SEAL:骑缝章</li>
902
+ <li>ORGANIZATION_FLOW_EMAIL_NOTIFY:邮件通知签署方</li>
903
+ <li>FLOW_APPROVAL:合同审批强制开启</li>
902
904
  <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>
903
905
  */
904
906
  ServiceType: string
@@ -2050,35 +2052,17 @@ export interface DescribeSignFaceVideoRequest {
2050
2052
  }
2051
2053
 
2052
2054
  /**
2053
- * DeleteSealPolicies请求参数结构体
2055
+ * CreateEmployeeQualificationSealQrCode返回参数结构体
2054
2056
  */
2055
- export interface DeleteSealPoliciesRequest {
2056
- /**
2057
- * 执行本接口操作的员工信息。
2058
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2059
- */
2060
- Operator: UserInfo
2061
- /**
2062
- * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
2063
- */
2064
- PolicyIds?: Array<string>
2057
+ export interface CreateEmployeeQualificationSealQrCodeResponse {
2065
2058
  /**
2066
- * 电子印章ID,为32位字符串。
2067
- 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
2068
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
2069
- 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
2059
+ * 二维码图片的Base64 注: `此二维码的有效时间为7天,过期后需要重新生成新的二维码图片`
2070
2060
  */
2071
- SealId?: string
2072
- /**
2073
- * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2074
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2075
- */
2076
- UserIds?: Array<string>
2061
+ QrcodeBase64?: string
2077
2062
  /**
2078
- * 代理企业和员工的信息。
2079
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2063
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2080
2064
  */
2081
- Agent?: Agent
2065
+ RequestId?: string
2082
2066
  }
2083
2067
 
2084
2068
  /**
@@ -3396,6 +3380,24 @@ export interface IntentionActionResultDetail {
3396
3380
  Video?: string
3397
3381
  }
3398
3382
 
3383
+ /**
3384
+ * CreateEmployeeQualificationSealQrCode请求参数结构体
3385
+ */
3386
+ export interface CreateEmployeeQualificationSealQrCodeRequest {
3387
+ /**
3388
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3389
+ */
3390
+ Operator: UserInfo
3391
+ /**
3392
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3393
+ */
3394
+ Agent?: Agent
3395
+ /**
3396
+ * 提示信息,扫码后此信息会展示给扫描用户,用来提示用户授权操作的目的
3397
+ */
3398
+ HintText?: string
3399
+ }
3400
+
3399
3401
  /**
3400
3402
  * CreatePersonAuthCertificateImage返回参数结构体
3401
3403
  */
@@ -3684,6 +3686,38 @@ export interface SuccessDeleteStaffData {
3684
3686
  UserId: string
3685
3687
  }
3686
3688
 
3689
+ /**
3690
+ * DeleteSealPolicies请求参数结构体
3691
+ */
3692
+ export interface DeleteSealPoliciesRequest {
3693
+ /**
3694
+ * 执行本接口操作的员工信息。
3695
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3696
+ */
3697
+ Operator: UserInfo
3698
+ /**
3699
+ * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
3700
+ */
3701
+ PolicyIds?: Array<string>
3702
+ /**
3703
+ * 电子印章ID,为32位字符串。
3704
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
3705
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
3706
+ 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
3707
+ */
3708
+ SealId?: string
3709
+ /**
3710
+ * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3711
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3712
+ */
3713
+ UserIds?: Array<string>
3714
+ /**
3715
+ * 代理企业和员工的信息。
3716
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3717
+ */
3718
+ Agent?: Agent
3719
+ }
3720
+
3687
3721
  /**
3688
3722
  * CreateConvertTaskApi返回参数结构体
3689
3723
  */
@@ -3836,7 +3870,7 @@ export interface CreateFlowByFilesRequest {
3836
3870
  */
3837
3871
  Operator: UserInfo
3838
3872
  /**
3839
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3873
+ * 合同流程的名称(可自定义此名称),长度不能超过200个字符,只能由中文、字母、数字、中划线和下划线组成。
3840
3874
 
3841
3875
  该名称还将用于合同签署完成后的下载文件名。
3842
3876
  */
@@ -3870,6 +3904,7 @@ export interface CreateFlowByFilesRequest {
3870
3904
  <li> 勾选框控件 </li>
3871
3905
  <li> 数字控件 </li>
3872
3906
  <li> 图片控件 </li>
3907
+ <li> 水印控件 </li>
3873
3908
  <li> 动态表格等填写控件</li></ul>
3874
3909
  */
3875
3910
  Components?: Array<Component>
@@ -7480,11 +7515,7 @@ export interface DescribeOrganizationSealsRequest {
7480
7515
  */
7481
7516
  SealId?: string
7482
7517
  /**
7483
- * 印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。
7484
-
7485
- 目前支持以下几种:
7486
-
7487
- <ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>ORGANIZATION_SEAL</strong>:企业印章(通过图片上传创建);</li> <li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> </ul>
7518
+ * 印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:<ul> <li><strong>OFFICIAL</strong>:企业公章;</li> <li><strong>CONTRACT</strong>:合同专用章;</li> <li><strong>ORGANIZATION_SEAL</strong>:企业印章(通过图片上传创建);</li> <li><strong>LEGAL_PERSON_SEAL</strong>:法定代表人章。</li> <li><strong>EMPLOYEE_QUALIFICATION_SEAL</strong>:员工执业章。</li> </ul>
7488
7519
  */
7489
7520
  SealTypes?: Array<string>
7490
7521
  /**
@@ -7898,6 +7929,7 @@ export interface DescribeExtendedServiceAuthInfosRequest {
7898
7929
  默认为空,即查询当前支持的所有扩展服务信息。
7899
7930
  若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
7900
7931
  <ul><li>OPEN_SERVER_SIGN:企业自动签署</li>
7932
+ <li>AUTO_SIGN_CAN_FILL_IN:本企业自动签合同支持签前内容补充</li>
7901
7933
  <li>BATCH_SIGN:批量签署</li>
7902
7934
  <li>OVERSEA_SIGN:企业与港澳台居民签署合同</li>
7903
7935
  <li>AGE_LIMIT_EXPANSION:拓宽签署方年龄限制</li>
@@ -7906,7 +7938,8 @@ export interface DescribeExtendedServiceAuthInfosRequest {
7906
7938
  <li>ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型</li>
7907
7939
  <li>ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方</li>
7908
7940
  <li>HIDE_ONE_KEY_SIGN:个人签署方手动签字</li>
7909
- <li>PAGING_SEAL:骑缝章</li>
7941
+ <li>ORGANIZATION_FLOW_EMAIL_NOTIFY:邮件通知签署方</li>
7942
+ <li>FLOW_APPROVAL:合同审批强制开启</li>
7910
7943
  <li>ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导</li></ul>
7911
7944
  */
7912
7945
  ExtendServiceType?: string
@@ -33,6 +33,7 @@ import {
33
33
  CreateLegalSealQrCodeResponse,
34
34
  CommonApproverOption,
35
35
  DescribeCancelFlowsTaskResponse,
36
+ CreateEmployeeQualificationSealQrCodeResponse,
36
37
  ChannelCreateFlowGroupByTemplatesResponse,
37
38
  ChannelCreateFlowSignReviewRequest,
38
39
  AuthFailMessage,
@@ -117,6 +118,7 @@ import {
117
118
  CommonFlowApprover,
118
119
  FillApproverInfo,
119
120
  IntentionActionResultDetail,
121
+ CreateEmployeeQualificationSealQrCodeRequest,
120
122
  ChannelCreateUserAutoSignSealUrlRequest,
121
123
  PdfVerifyResult,
122
124
  UserThreeFactor,
@@ -880,30 +882,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
880
882
  }
881
883
 
882
884
  /**
883
- * 创建跳转小程序查看或签署的链接
884
-
885
- **腾讯电子签小程序的AppID 和 原始Id如下:**
885
+ * 该接口用于获取个人授权执业章给企业的二维码,需要个人用户通过微信扫码。扫描后将跳转到腾讯电子签小程序,进入到授权执业章的流程。个人用户授权成功后,企业印章管理员需对印章进行审核,审核通过后,即可使用个人授权的执业章进行盖章操作。
886
886
 
887
- | 小程序 | AppID | 原始ID |
888
- | ------------ | ------------ | ------------ |
889
- | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
890
- | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
891
-
892
- **主要使用场景EndPoint分类**
893
-
894
- |EndPoint| 场景| 说明和示例|
895
- | ---- | ---- | --- |
896
- | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
897
- | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
898
- | 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 |
899
- |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 |
900
- |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 |
887
+ **注意**
888
+ 1. 该二维码**有效期为7天**,过期后将失效,可重新创建。
901
889
  */
902
- async CreateSignUrls(
903
- req: CreateSignUrlsRequest,
904
- cb?: (error: string, rep: CreateSignUrlsResponse) => void
905
- ): Promise<CreateSignUrlsResponse> {
906
- return this.request("CreateSignUrls", req, cb)
890
+ async CreateEmployeeQualificationSealQrCode(
891
+ req: CreateEmployeeQualificationSealQrCodeRequest,
892
+ cb?: (error: string, rep: CreateEmployeeQualificationSealQrCodeResponse) => void
893
+ ): Promise<CreateEmployeeQualificationSealQrCodeResponse> {
894
+ return this.request("CreateEmployeeQualificationSealQrCode", req, cb)
907
895
  }
908
896
 
909
897
  /**
@@ -1289,6 +1277,33 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1289
1277
  return this.request("PrepareFlows", req, cb)
1290
1278
  }
1291
1279
 
1280
+ /**
1281
+ * 创建跳转小程序查看或签署的链接
1282
+
1283
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
1284
+
1285
+ | 小程序 | AppID | 原始ID |
1286
+ | ------------ | ------------ | ------------ |
1287
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
1288
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
1289
+
1290
+ **主要使用场景EndPoint分类**
1291
+
1292
+ |EndPoint| 场景| 说明和示例|
1293
+ | ---- | ---- | --- |
1294
+ | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
1295
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
1296
+ | 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 |
1297
+ |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 |
1298
+ |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 |
1299
+ */
1300
+ async CreateSignUrls(
1301
+ req: CreateSignUrlsRequest,
1302
+ cb?: (error: string, rep: CreateSignUrlsResponse) => void
1303
+ ): Promise<CreateSignUrlsResponse> {
1304
+ return this.request("CreateSignUrls", req, cb)
1305
+ }
1306
+
1292
1307
  /**
1293
1308
  * 此接口(GetDownloadFlowUrl)用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
1294
1309
  ![image](https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl.png)
@@ -517,6 +517,20 @@ export interface DescribeCancelFlowsTaskResponse {
517
517
  RequestId?: string
518
518
  }
519
519
 
520
+ /**
521
+ * CreateEmployeeQualificationSealQrCode返回参数结构体
522
+ */
523
+ export interface CreateEmployeeQualificationSealQrCodeResponse {
524
+ /**
525
+ * 二维码图片的Base64 注: `此二维码的有效时间为7天,过期后需要重新生成新的二维码图片`
526
+ */
527
+ QrcodeBase64?: string
528
+ /**
529
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
530
+ */
531
+ RequestId?: string
532
+ }
533
+
520
534
  /**
521
535
  * ChannelCreateFlowGroupByTemplates返回参数结构体
522
536
  */
@@ -3203,7 +3217,9 @@ export interface CreateConsoleLoginUrlRequest {
3203
3217
  Agent: Agent
3204
3218
  /**
3205
3219
  * 第三方平台子客的企业名称,请确认该企业名称与企业营业执照中注册的名称完全一致。
3206
- <font color="red">在测试环境联调的过程中,企业名称请使用以下名称
3220
+ <font color="red">
3221
+ 在测试环境联调的过程中,企业名称请统一加上“测试”二字,如:典子谦示例企业测试,否则将无法审核通过。
3222
+ 企业名称请使用以下名称, 以下名称可以不用走收录。
3207
3223
  **子客测试专用企业1 - 子客测试专用企业9**</font>
3208
3224
 
3209
3225
  注:
@@ -3612,6 +3628,20 @@ export interface IntentionActionResultDetail {
3612
3628
  Video?: string
3613
3629
  }
3614
3630
 
3631
+ /**
3632
+ * CreateEmployeeQualificationSealQrCode请求参数结构体
3633
+ */
3634
+ export interface CreateEmployeeQualificationSealQrCodeRequest {
3635
+ /**
3636
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。<ul><li>渠道应用标识: Agent.AppId</li><li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li><li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li></ul>第三方平台子客企业和员工必须已经经过实名认证
3637
+ */
3638
+ Agent: Agent
3639
+ /**
3640
+ * 提示信息,扫码后此信息会展示给扫描用户,用来提示用户授权操作的目的
3641
+ */
3642
+ HintText?: string
3643
+ }
3644
+
3615
3645
  /**
3616
3646
  * ChannelCreateUserAutoSignSealUrl请求参数结构体
3617
3647
  */
@@ -3874,15 +3904,7 @@ export interface ChannelDescribeOrganizationSealsRequest {
3874
3904
  */
3875
3905
  SealId?: string
3876
3906
  /**
3877
- * 电子印章类型 , 可选类型如下:
3878
- <ul><li>**OFFICIAL**: 公章</li>
3879
- <li>**CONTRACT**: 合同专用章;</li>
3880
- <li>**FINANCE**: 财务专用章;</li>
3881
- <li>**PERSONNEL**: 人事专用章</li>
3882
- <li>**INVOICE**: 发票专用章</li>
3883
- </ul>
3884
-
3885
- 注: `为空时查询所有类型的印章。`
3907
+ * 电子印章类型 , 可选类型如下: <ul><li>**OFFICIAL**: 公章</li><li>**CONTRACT**: 合同专用章;</li><li>**FINANCE**: 财务专用章;</li><li>**PERSONNEL**: 人事专用章</li><li>**INVOICE**: 发票专用章</li><<li>**EMPLOYEE_QUALIFICATION_SEAL**: 员工执业章</li></ul>注: `为空时查询所有类型的印章。`
3886
3908
  */
3887
3909
  SealTypes?: Array<string>
3888
3910
  /**
@@ -5597,7 +5619,6 @@ export interface ExtentServiceAuthInfo {
5597
5619
  <li>AUTO_SIGN 企业自动签(自动签署)</li>
5598
5620
  <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
5599
5621
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
5600
- <li> PAGING_SEAL 骑缝章</li>
5601
5622
  <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
5602
5623
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
5603
5624
  <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
@@ -94,6 +94,7 @@ import {
94
94
  CreateProxyGroupRequest,
95
95
  RuleInfo,
96
96
  RealServerStatus,
97
+ DescribeTaskStatusResponse,
97
98
  DescribeTCPListenersResponse,
98
99
  DescribeRulesRequest,
99
100
  DescribeCountryAreaMappingResponse,
@@ -197,6 +198,7 @@ import {
197
198
  NewRealServer,
198
199
  DescribeFirstLinkSessionResponse,
199
200
  DescribeHTTPListenersResponse,
201
+ DescribeTaskStatusRequest,
200
202
  HttpHeaderParam,
201
203
  DescribeRealServerStatisticsResponse,
202
204
  AccessRegionDomainConf,
@@ -1000,6 +1002,16 @@ export class Client extends AbstractClient {
1000
1002
  return this.request("DescribeFirstLinkSession", req, cb)
1001
1003
  }
1002
1004
 
1005
+ /**
1006
+ * 查询异步任务执行状态
1007
+ */
1008
+ async DescribeTaskStatus(
1009
+ req?: DescribeTaskStatusRequest,
1010
+ cb?: (error: string, rep: DescribeTaskStatusResponse) => void
1011
+ ): Promise<DescribeTaskStatusResponse> {
1012
+ return this.request("DescribeTaskStatus", req, cb)
1013
+ }
1014
+
1003
1015
  /**
1004
1016
  * 本接口(DeleteFirstLinkSession)用于删除接入段加速会话,删除加速会话后会停止加速。
1005
1017
  */
@@ -1560,6 +1560,16 @@ export interface RealServerStatus {
1560
1560
  GroupId: string
1561
1561
  }
1562
1562
 
1563
+ /**
1564
+ * DescribeTaskStatus返回参数结构体
1565
+ */
1566
+ export interface DescribeTaskStatusResponse {
1567
+ /**
1568
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1569
+ */
1570
+ RequestId?: string
1571
+ }
1572
+
1563
1573
  /**
1564
1574
  * DescribeTCPListeners返回参数结构体
1565
1575
  */
@@ -3997,6 +4007,11 @@ export interface DescribeHTTPListenersResponse {
3997
4007
  RequestId?: string
3998
4008
  }
3999
4009
 
4010
+ /**
4011
+ * DescribeTaskStatus请求参数结构体
4012
+ */
4013
+ export type DescribeTaskStatusRequest = null
4014
+
4000
4015
  /**
4001
4016
  * 描述HTTP的包头参数
4002
4017
  */
@@ -354,11 +354,11 @@ export interface DescribeBlueprintInstancesResponse {
354
354
  /**
355
355
  * 符合条件的镜像实例数量。
356
356
  */
357
- TotalCount: number
357
+ TotalCount?: number
358
358
  /**
359
359
  * 镜像实例列表信息。
360
360
  */
361
- BlueprintInstanceSet: Array<BlueprintInstance>
361
+ BlueprintInstanceSet?: Array<BlueprintInstance>
362
362
  /**
363
363
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
364
364
  */
@@ -1295,39 +1295,39 @@ export interface Disk {
1295
1295
  /**
1296
1296
  * 磁盘ID
1297
1297
  */
1298
- DiskId: string
1298
+ DiskId?: string
1299
1299
  /**
1300
1300
  * 实例ID
1301
1301
  */
1302
- InstanceId: string
1302
+ InstanceId?: string
1303
1303
  /**
1304
1304
  * 可用区
1305
1305
  */
1306
- Zone: string
1306
+ Zone?: string
1307
1307
  /**
1308
1308
  * 磁盘名称
1309
1309
  */
1310
- DiskName: string
1310
+ DiskName?: string
1311
1311
  /**
1312
1312
  * 磁盘类型
1313
1313
  */
1314
- DiskUsage: string
1314
+ DiskUsage?: string
1315
1315
  /**
1316
1316
  * 磁盘介质类型
1317
1317
  */
1318
- DiskType: string
1318
+ DiskType?: string
1319
1319
  /**
1320
1320
  * 磁盘付费类型
1321
1321
  */
1322
- DiskChargeType: string
1322
+ DiskChargeType?: string
1323
1323
  /**
1324
1324
  * 磁盘大小
1325
1325
  */
1326
- DiskSize: number
1326
+ DiskSize?: number
1327
1327
  /**
1328
1328
  * 续费标识
1329
1329
  */
1330
- RenewFlag: string
1330
+ RenewFlag?: string
1331
1331
  /**
1332
1332
  * 磁盘状态,取值范围:
1333
1333
  <li>PENDING:创建中。 </li>
@@ -1341,53 +1341,53 @@ export interface Disk {
1341
1341
  <li> DELETING:删除中。</li>
1342
1342
  <li> FREEZING:冻结中。</li>
1343
1343
  */
1344
- DiskState: string
1344
+ DiskState?: string
1345
1345
  /**
1346
1346
  * 磁盘挂载状态
1347
1347
  */
1348
- Attached: boolean
1348
+ Attached?: boolean
1349
1349
  /**
1350
1350
  * 是否随实例释放
1351
1351
  */
1352
- DeleteWithInstance: boolean
1352
+ DeleteWithInstance?: boolean
1353
1353
  /**
1354
1354
  * 上一次操作
1355
1355
  */
1356
- LatestOperation: string
1356
+ LatestOperation?: string
1357
1357
  /**
1358
1358
  * 上一次操作状态
1359
1359
  */
1360
- LatestOperationState: string
1360
+ LatestOperationState?: string
1361
1361
  /**
1362
1362
  * 上一次请求ID
1363
1363
  */
1364
- LatestOperationRequestId: string
1364
+ LatestOperationRequestId?: string
1365
1365
  /**
1366
1366
  * 创建时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
1367
1367
  格式为: YYYY-MM-DDThh:mm:ssZ。
1368
1368
  注意:此字段可能返回 null,表示取不到有效值。
1369
1369
  */
1370
- CreatedTime: string
1370
+ CreatedTime?: string
1371
1371
  /**
1372
1372
  * 到期时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
1373
1373
  格式为: YYYY-MM-DDThh:mm:ssZ。
1374
1374
  注意:此字段可能返回 null,表示取不到有效值。
1375
1375
  */
1376
- ExpiredTime: string
1376
+ ExpiredTime?: string
1377
1377
  /**
1378
1378
  * 隔离时间。按照 ISO8601 标准表示,并且使用 UTC 时间。
1379
1379
  格式为: YYYY-MM-DDThh:mm:ssZ。
1380
1380
  注意:此字段可能返回 null,表示取不到有效值。
1381
1381
  */
1382
- IsolatedTime: string
1382
+ IsolatedTime?: string
1383
1383
  /**
1384
1384
  * 云硬盘的已有备份点数量。
1385
1385
  */
1386
- DiskBackupCount: number
1386
+ DiskBackupCount?: number
1387
1387
  /**
1388
1388
  * 云硬盘的备份点配额数量。
1389
1389
  */
1390
- DiskBackupQuota: number
1390
+ DiskBackupQuota?: number
1391
1391
  }
1392
1392
 
1393
1393
  /**
@@ -1423,7 +1423,7 @@ export interface ZoneInfo {
1423
1423
  */
1424
1424
  export interface DescribeBlueprintInstancesRequest {
1425
1425
  /**
1426
- * 实例 ID 列表,当前最多支持 1 个。
1426
+ * 实例 ID 列表。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1207/47573)接口返回值中的InstanceId获取。 当前最多支持1个。
1427
1427
  */
1428
1428
  InstanceIds: Array<string>
1429
1429
  }
@@ -3839,11 +3839,11 @@ export interface DescribeInstancesReturnableResponse {
3839
3839
  /**
3840
3840
  * 符合条件的实例数量。
3841
3841
  */
3842
- TotalCount: number
3842
+ TotalCount?: number
3843
3843
  /**
3844
3844
  * 可退还实例详细信息列表。
3845
3845
  */
3846
- InstanceReturnableSet: Array<InstanceReturnable>
3846
+ InstanceReturnableSet?: Array<InstanceReturnable>
3847
3847
  /**
3848
3848
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3849
3849
  */
@@ -125,6 +125,7 @@ import {
125
125
  ListReleaseQAPreviewResponse,
126
126
  ModifyRejectedQuestionResponse,
127
127
  ListReleaseDocPreviewRequest,
128
+ DocSegment,
128
129
  DescribeUnsatisfiedReplyContextResponse,
129
130
  Message,
130
131
  ExportUnsatisfiedReplyResponse,
@@ -189,6 +190,7 @@ import {
189
190
  DeleteDocResponse,
190
191
  DocumentElement,
191
192
  BaseConfig,
193
+ DescribeSegmentsResponse,
192
194
  ClassifyConfig,
193
195
  UploadAttributeLabelRequest,
194
196
  ExportAttributeLabelRequest,
@@ -231,6 +233,7 @@ import {
231
233
  ListRejectedQuestionRequest,
232
234
  VerifyQAResponse,
233
235
  ReleaseConfigs,
236
+ DescribeSegmentsRequest,
234
237
  Filters,
235
238
  ModifyRejectedQuestionRequest,
236
239
  IgnoreUnsatisfiedReplyResponse,
@@ -943,6 +946,16 @@ export class Client extends AbstractClient {
943
946
  return this.request("GroupQA", req, cb)
944
947
  }
945
948
 
949
+ /**
950
+ * 获取片段详情
951
+ */
952
+ async DescribeSegments(
953
+ req: DescribeSegmentsRequest,
954
+ cb?: (error: string, rep: DescribeSegmentsResponse) => void
955
+ ): Promise<DescribeSegmentsResponse> {
956
+ return this.request("DescribeSegments", req, cb)
957
+ }
958
+
946
959
  /**
947
960
  * 获取拒答问题
948
961
  */