tencentcloud-sdk-nodejs 4.0.899 → 4.0.901

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 (78) hide show
  1. package/CHANGELOG.md +174 -0
  2. package/SERVICE_CHANGELOG.md +239 -25
  3. package/package.json +1 -1
  4. package/products.md +24 -24
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/billing/v20180709/billing_client.ts +5 -2
  7. package/src/services/ccc/v20200210/ccc_models.ts +7 -2
  8. package/src/services/cdb/v20170320/cdb_models.ts +2 -1
  9. package/src/services/ckafka/v20190819/ckafka_client.ts +13 -1
  10. package/src/services/ckafka/v20190819/ckafka_models.ts +72 -8
  11. package/src/services/clb/v20180317/clb_client.ts +1 -0
  12. package/src/services/cloudapp/v20220530/cloudapp_models.ts +3 -66
  13. package/src/services/cvm/v20170312/cvm_client.ts +26 -2
  14. package/src/services/cvm/v20170312/cvm_models.ts +70 -18
  15. package/src/services/cynosdb/v20190107/cynosdb_client.ts +40 -15
  16. package/src/services/cynosdb/v20190107/cynosdb_models.ts +266 -168
  17. package/src/services/es/v20180416/es_models.ts +16 -0
  18. package/src/services/ess/v20201111/ess_client.ts +36 -20
  19. package/src/services/ess/v20201111/ess_models.ts +9 -16
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +45 -30
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +13 -13
  22. package/src/services/faceid/v20180301/faceid_models.ts +5 -2
  23. package/src/services/hunyuan/v20230901/hunyuan_client.ts +5 -3
  24. package/src/services/hunyuan/v20230901/hunyuan_models.ts +87 -44
  25. package/src/services/lighthouse/v20200324/lighthouse_models.ts +2 -2
  26. package/src/services/live/v20180801/live_client.ts +1 -1
  27. package/src/services/mna/v20210119/mna_client.ts +74 -1
  28. package/src/services/mna/v20210119/mna_models.ts +244 -25
  29. package/src/services/oceanus/v20190422/oceanus_models.ts +10 -0
  30. package/src/services/tke/v20180525/tke_models.ts +4 -4
  31. package/src/services/trtc/v20190722/trtc_client.ts +2 -3
  32. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  33. package/src/services/vpc/v20170312/vpc_models.ts +9 -9
  34. package/tencentcloud/common/sdk_version.d.ts +1 -1
  35. package/tencentcloud/common/sdk_version.js +1 -1
  36. package/tencentcloud/services/billing/v20180709/billing_client.d.ts +3 -0
  37. package/tencentcloud/services/billing/v20180709/billing_client.js +3 -0
  38. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +7 -2
  39. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +2 -1
  40. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +5 -1
  41. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +6 -0
  42. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +70 -8
  43. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +1 -0
  44. package/tencentcloud/services/clb/v20180317/clb_client.js +1 -0
  45. package/tencentcloud/services/cloudapp/v20220530/cloudapp_models.d.ts +3 -66
  46. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +9 -1
  47. package/tencentcloud/services/cvm/v20170312/cvm_client.js +12 -0
  48. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +66 -18
  49. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +13 -5
  50. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +18 -6
  51. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +261 -168
  52. package/tencentcloud/services/es/v20180416/es_models.d.ts +16 -0
  53. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +36 -20
  54. package/tencentcloud/services/ess/v20201111/ess_client.js +36 -20
  55. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +9 -16
  56. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +45 -30
  57. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +45 -30
  58. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +13 -13
  59. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +5 -2
  60. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +1 -1
  61. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +1 -1
  62. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +83 -42
  63. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +2 -2
  64. package/tencentcloud/services/live/v20180801/live_client.d.ts +1 -1
  65. package/tencentcloud/services/live/v20180801/live_client.js +1 -1
  66. package/tencentcloud/services/mna/v20210119/mna_client.d.ts +25 -1
  67. package/tencentcloud/services/mna/v20210119/mna_client.js +36 -0
  68. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +231 -25
  69. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +10 -0
  70. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +4 -4
  71. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +2 -3
  72. package/tencentcloud/services/trtc/v20190722/trtc_client.js +2 -3
  73. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  74. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +9 -9
  75. package/test/ckafka.v20190819.test.js +10 -0
  76. package/test/cvm.v20170312.test.js +20 -0
  77. package/test/cynosdb.v20190107.test.js +24 -4
  78. package/test/mna.v20210119.test.js +60 -0
@@ -385,14 +385,18 @@ export class Client extends AbstractClient {
385
385
  }
386
386
 
387
387
  /**
388
- * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
388
+ * 本接口(CreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
389
389
  1. 创建印章
390
390
  2. 创建模板
391
391
  3. 修改模板
392
392
  4. 预览模板
393
393
  5. 预览合同流程
394
394
 
395
- 用户可以通过这些链接快速将其集成到自己的系统中。
395
+ 预览模板的嵌入页面长相如下:
396
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
397
+
398
+ 预览合同流程的嵌入页面长相如下:
399
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
396
400
  */
397
401
  async CreateEmbedWebUrl(
398
402
  req: CreateEmbedWebUrlRequest,
@@ -1202,17 +1206,20 @@ export class Client extends AbstractClient {
1202
1206
  }
1203
1207
 
1204
1208
  /**
1205
- * 在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
1206
- 1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
1207
- 2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
1209
+ * 在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:
1210
+ 1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
1211
+ 2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。
1212
+
1213
+ 此接口存在以下限制:
1214
+ 1. 执行操作的员工须为<font color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
1215
+ 2. 延长整个签署流程时,<font color="red">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
1216
+ 3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。
1217
+ 4. 延长签署方截止时间时,<font color="red">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
1218
+ 5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
1219
+ 6. <font color="red">不支持操作合同组合同</font>。
1208
1220
 
1209
- 此接口有如下限制条件:
1210
- 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
1211
- 2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。
1212
- 3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
1213
- 4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
1214
- 5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
1215
- 6. 不支持操作合同组合同。
1221
+ 合同(流程)层面 截止时间控制台展示的位置:
1222
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/265b130136bf6e8f01f5880438467dfb.png)
1216
1223
  */
1217
1224
  async ModifyFlowDeadline(
1218
1225
  req: ModifyFlowDeadlineRequest,
@@ -1635,9 +1642,12 @@ p.s.
1635
1642
  }
1636
1643
 
1637
1644
  /**
1638
- * 创建发起流程web页面
1639
- <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
1640
- <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
1645
+ * 创建发起流程Web页面,通过该接口可以获取发起流程的可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。在页面上完成签署控件等信息的编辑与确认后,可快速发起流程。
1646
+
1647
+ <br/>注意:调用接口后,<font color="red">流程不会立即发起,需在嵌入页面上点击【发起合同】按钮来发起流程</font>。
1648
+
1649
+ 嵌入页面长相如下:
1650
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
1641
1651
  */
1642
1652
  async CreatePrepareFlow(
1643
1653
  req: CreatePrepareFlowRequest,
@@ -1775,11 +1785,17 @@ p.s.
1775
1785
 
1776
1786
  /**
1777
1787
  * 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
1778
- 附注:
1779
- - 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。
1780
- - 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
1781
- - 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。
1782
- - 支持待签署、待填写状态的合同生成签署链接。
1788
+
1789
+ 注:
1790
+ <ul>
1791
+ <li>员工必须需作为批量签署合同的签署方,或者是或签合同的候选人之一。</li>
1792
+ <li><b>本方企业签署链接</b>:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。</li>
1793
+ <li><b>他方企业签署链接</b>:传RecipientIds,且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。(<b>如果签署人没有加入对方企业则会引导加入;如果对方企业还没有注册认证,会引导企业注册和认证</b>)</li>
1794
+ <li>只支持待签署、待填写状态的合同生成签署链接。</li>
1795
+ </ul>
1796
+
1797
+ 签署的嵌入页面长相如下:
1798
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
1783
1799
  */
1784
1800
  async CreateOrganizationBatchSignUrl(
1785
1801
  req: CreateOrganizationBatchSignUrlRequest,
@@ -4882,7 +4882,7 @@ export interface FlowCreateApprover {
4882
4882
  * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
4883
4883
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
4884
4884
  <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
4885
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
4885
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>
4886
4886
  注:
4887
4887
  <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
4888
4888
  <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
@@ -5497,7 +5497,7 @@ p.s. 如果上传授权书 ,需遵循以下条件
5497
5497
  export interface CreateEmbedWebUrlRequest {
5498
5498
  /**
5499
5499
  * 执行本接口操作的员工信息。
5500
- <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
5500
+ <br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5501
5501
  */
5502
5502
  Operator: UserInfo
5503
5503
  /**
@@ -5535,17 +5535,7 @@ export interface CreateEmbedWebUrlRequest {
5535
5535
  */
5536
5536
  Option?: EmbedUrlOption
5537
5537
  /**
5538
- * 用户自定义参数
5539
- <ul>
5540
- <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li>
5541
- <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li>
5542
- <li>支持的格式:json字符串的BASE64编码字符串</li>
5543
- <li>示例:<ul>
5544
- <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li>
5545
- <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li>
5546
- </ul>
5547
- </li>
5548
- </ul>
5538
+ * <ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li> <li>支持的格式:json字符串的BASE64编码字符串</li> <li>示例:<ul> <li>json字符串:{"ComeFrom":"xxx"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li> <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li> </ul> </li> </ul>
5549
5539
  */
5550
5540
  UserData?: string
5551
5541
  }
@@ -6394,7 +6384,7 @@ export interface ApproverInfo {
6394
6384
  * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
6395
6385
  <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
6396
6386
  <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
6397
- <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
6387
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>
6398
6388
 
6399
6389
  默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
6400
6390
 
@@ -6896,8 +6886,11 @@ export interface CreateOrganizationBatchSignUrlRequest {
6896
6886
  * 员工在腾讯电子签平台的独特身份标识,为32位字符串。
6897
6887
  您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的UserId(在页面中显示为用户ID)。
6898
6888
  UserId必须是传入合同(FlowId)中的签署人。
6899
- - 1. 若UserId为空,Name和Mobile 必须提供。
6900
- - 2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。
6889
+
6890
+ <ul>
6891
+ <li>1. 若UserId为空,Name和Mobile 必须提供。</li>
6892
+ <li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>
6893
+ </ul>
6901
6894
  */
6902
6895
  UserId?: string
6903
6896
  /**
@@ -435,11 +435,12 @@ export class Client extends AbstractClient {
435
435
  }
436
436
 
437
437
  /**
438
- * 此接口用于获取企业批量认证异步任务的状态及结果。
438
+ * 此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>获取到任务ID,然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。
439
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
439
440
 
440
- 前提条件:已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口,并得到了任务Id。
441
441
 
442
- 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间
442
+ 注:
443
+ `异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定,正常情况下 3~5 秒即可完成,但也可能需要更长的时间`
443
444
  */
444
445
  async DescribeBatchOrganizationRegistrationUrls(
445
446
  req: DescribeBatchOrganizationRegistrationUrlsRequest,
@@ -565,17 +566,20 @@ export class Client extends AbstractClient {
565
566
  }
566
567
 
567
568
  /**
568
- * 在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
569
- 1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
570
- 2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
569
+ * 在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:
570
+ 1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
571
+ 2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。
572
+
573
+ 此接口存在以下限制:
574
+ 1. 执行操作的员工须为<font color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
575
+ 2. 延长整个签署流程时,<font color="red">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
576
+ 3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。
577
+ 4. 延长签署方截止时间时,<font color="red">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
578
+ 5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
579
+ 6. <font color="red">不支持操作合同组合同</font>。
571
580
 
572
- 此接口有如下限制条件:
573
- 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
574
- 2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。
575
- 3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
576
- 4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
577
- 5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
578
- 6. 不支持操作合同组合同。
581
+ 合同(流程)层面截止时间子企业控制台展示的位置:
582
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/f0f88c0eb49a926da9a86e5a6e9efa8b.png)
579
583
  */
580
584
  async ModifyFlowDeadline(
581
585
  req: ModifyFlowDeadlineRequest,
@@ -611,6 +615,9 @@ export class Client extends AbstractClient {
611
615
  - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
612
616
  - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
613
617
  - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
618
+
619
+ 签署的嵌入页面长相如下:
620
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
614
621
  */
615
622
  async ChannelCreateOrganizationBatchSignUrl(
616
623
  req: ChannelCreateOrganizationBatchSignUrlRequest,
@@ -830,16 +837,20 @@ export class Client extends AbstractClient {
830
837
  }
831
838
 
832
839
  /**
833
- * 本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接
834
- 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
840
+ * 该接口用于批量创建企业认证链接, 可以支持PC浏览器,H5和小程序三种途径。
841
+ 此接口为异步提交任务接口,需要与[查询子企业批量认证链接](https://qcloudimg.tencent-cloud.cn/raw/1d3737991b2a3be78002bd78a47d6917.png)配合使用,整体流程如下图。
842
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
843
+
844
+
845
+
846
+ **注意**
847
+
848
+ 1. 单次最多创建10个子企业。
849
+ 2. 一天内,同一家企业最多创建8000个子企业。
850
+ 3. 同一批创建的子客户不能重复,包括企业名称、企业统一信用代码和子客户经办人openId。
851
+ 4. 跳转到小程序的实现,请参考微信官方文档(分为<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>。
835
852
 
836
- 批量创建链接有以下限制:
837
- 1. 单次最多创建10个子客。
838
- 2. 一天同一家企业最多创建8000个子客。
839
- 3. 同一批创建的子客不能重复 其中包括 企业名称,企业统一信用代码,子客经办人openId。
840
- 4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
841
853
 
842
- 注: 1. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<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>
843
854
 
844
855
  **腾讯电子签小程序的AppID 和 原始Id如下:**
845
856
 
@@ -914,7 +925,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
914
925
  <tr>
915
926
  <td>企业已激活</td>
916
927
  <td>员工未认证</td>
917
- <td>进入员认证并加入企业流程</td>
928
+ <td>进入员工认证并加入企业流程</td>
918
929
  </tr>
919
930
  <tr>
920
931
  <td>企业已激活</td>
@@ -1085,7 +1096,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1085
1096
  - 参与人点击链接后需短信验证码才能查看合同内容。
1086
1097
  - 个人用户批量签署,需要传Name,Mobile,IdCardNumber(IdCardType) 参数。
1087
1098
  - saas企业员工用户批量签署,在传递了姓名等基本信息参数的情况下,还需要传OrganizationName(参与方所在企业名称)参数生成签署链接,<font color="red">请确保此企业已完成腾讯电子签企业认证</font>。
1088
- - 子客企业员工用户批签签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。
1099
+ - 子客企业员工用户批量签署,需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证,且OpenId对应员工此子客下已经实名</font>。Name,Mobile, IdCard等信息此时可以不传,系统会查询此OpenId实名信息自动补充。
1089
1100
  - 生成批量签署链接时,合同目标参与方状态需为<font color="red">待签署</font>状态。
1090
1101
  - 个人批量签署进行的合同的签名区, 全部变成<font color="red">手写签名</font>(不管合同里边设置的签名限制)来进行。
1091
1102
  */
@@ -1779,14 +1790,18 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
1779
1790
  }
1780
1791
 
1781
1792
  /**
1782
- * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
1793
+ * 本接口(ChannelCreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:
1794
+ 1. 创建印章
1795
+ 2. 创建模板
1796
+ 3. 修改模板
1797
+ 4. 预览模板
1798
+ 5. 预览合同流程
1799
+
1800
+ 预览模板的嵌入页面长相如下:
1801
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
1783
1802
 
1784
- 本接口下面功能的签署页面链接的生成
1785
- - 创建印章
1786
- - 创建模板
1787
- - 修改模板
1788
- - 预览模板
1789
- - 预览合同流程
1803
+ 预览合同流程的嵌入页面长相如下:
1804
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
1790
1805
  */
1791
1806
  async ChannelCreateEmbedWebUrl(
1792
1807
  req: ChannelCreateEmbedWebUrlRequest,
@@ -2347,7 +2347,7 @@ export interface DescribeBatchOrganizationRegistrationUrlsRequest {
2347
2347
  */
2348
2348
  Agent: Agent
2349
2349
  /**
2350
- * 通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id
2350
+ * 通过接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>调用得到的任务ID。
2351
2351
  */
2352
2352
  TaskId: string
2353
2353
  }
@@ -2789,16 +2789,17 @@ export interface StaffRole {
2789
2789
  */
2790
2790
  export interface CreateBatchOrganizationRegistrationTasksResponse {
2791
2791
  /**
2792
- * 生成注册链接的任务Id
2793
- 根据这个id, 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接,进入认证流程
2794
- 若存在其中任意一条链接错误,则返回具体的错误描述, 不会返回TaskId
2792
+ * 生成注册链接的任务ID,后序根据这个任务ID 调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls" target="_blank">查询子企业批量认证链接</a>获取生成的链接,发给对应的客户使用。
2793
+
2794
+ 注:`如果有错误,则不会返回任务ID`
2795
2795
  */
2796
2796
  TaskId?: string
2797
2797
  /**
2798
- * 批量生成企业认证链接的详细错误信息,
2799
- 顺序与输入参数保持一致。
2800
- 若企业认证均成功生成,则不返回错误信息;
2801
- 若存在任何错误,则返回具体的错误描述。
2798
+ * 批量生成企业认证链接的详细错误信息,顺序与输入参数子企业列表顺序一致。
2799
+ <ul>
2800
+ <li>如果所有企业认证链接都成功生成,将不返回错误信息</li>
2801
+ <li>如果存在任何错误,将返回具体的错误描述。(没有错误的企业返回空字符串)</li>
2802
+ </ul>
2802
2803
  */
2803
2804
  ErrorMessages?: Array<string>
2804
2805
  /**
@@ -5068,7 +5069,7 @@ export interface FlowApproverInfo {
5068
5069
  * 签署人签署合同时的认证方式
5069
5070
  <ul><li> **1** :人脸认证</li>
5070
5071
  <li> **2** :签署密码</li>
5071
- <li> **3** :运营商三要素</li></ul>
5072
+ <li> **3** :运营商三要素(如果是港澳台客户,建议不要选择这个)</li></ul>
5072
5073
 
5073
5074
  默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
5074
5075
 
@@ -5843,8 +5844,7 @@ export interface CreateBatchOrganizationRegistrationTasksRequest {
5843
5844
  */
5844
5845
  Agent: Agent
5845
5846
  /**
5846
- * 当前应用下子客的组织机构注册信息。
5847
- 一次最多支持10条认证流
5847
+ * 当前应用下子企业的组织机构注册信息。最多支持查询10子企业。
5848
5848
  */
5849
5849
  RegistrationOrganizations: Array<RegistrationOrganizationInfo>
5850
5850
  /**
@@ -5855,7 +5855,7 @@ export interface CreateBatchOrganizationRegistrationTasksRequest {
5855
5855
  <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li>
5856
5856
  <li>**H5**:第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li>
5857
5857
  <li>**SHORT_H5**:第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面</li></ul>
5858
- 示例值:PC
5858
+
5859
5859
 
5860
5860
  */
5861
5861
  Endpoint?: string
@@ -7591,7 +7591,7 @@ export interface CreateFlowsByTemplatesRequest {
7591
7591
  */
7592
7592
  export interface DescribeBatchOrganizationRegistrationUrlsResponse {
7593
7593
  /**
7594
- * 企业批量注册链接信息
7594
+ * 子企业注册认证的的链接列表
7595
7595
  */
7596
7596
  OrganizationAuthUrls?: Array<OrganizationAuthUrl>
7597
7597
  /**
@@ -74,12 +74,13 @@ export interface CheckIdNameDateResponse {
74
74
  -5: 身份信息无效
75
75
  -6: 证件库服务异常
76
76
  -7: 证件库中无此身份证记录
77
+ -8: 认证次数超过当日限制,请次日重试
77
78
  */
78
- Result: string
79
+ Result?: string
79
80
  /**
80
81
  * 业务结果描述。
81
82
  */
82
- Description: string
83
+ Description?: string
83
84
  /**
84
85
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
85
86
  */
@@ -1533,6 +1534,7 @@ export interface PhoneVerificationResponse {
1533
1534
  -8: 姓名校验不通过
1534
1535
  -9: 没有记录
1535
1536
  -11: 验证中心服务繁忙
1537
+ -12: 认证次数超过当日限制,请次日重试
1536
1538
  */
1537
1539
  Result?: string
1538
1540
  /**
@@ -2560,6 +2562,7 @@ export interface CheckPhoneAndNameResponse {
2560
2562
  -3:引擎服务异常
2561
2563
  -4:姓名校验不通过
2562
2564
  -5:手机号码不合法
2565
+ -6: 认证次数超过当日限制,请次日重试
2563
2566
  */
2564
2567
  Result?: string
2565
2568
  /**
@@ -26,19 +26,21 @@ import {
26
26
  Usage,
27
27
  QueryHunyuanImageJobRequest,
28
28
  Tool,
29
+ SearchResult,
29
30
  Choice,
30
31
  GetTokenCountResponse,
31
32
  EmbeddingData,
32
33
  ToolFunction,
33
34
  TextToImageLiteResponse,
35
+ ToolCall,
34
36
  ToolCallFunction,
35
- TextToImageLiteRequest,
36
37
  Delta,
37
- ToolCall,
38
+ TextToImageLiteRequest,
38
39
  SubmitHunyuanImageJobResponse,
39
40
  QueryHunyuanImageJobResponse,
40
41
  GetEmbeddingResponse,
41
42
  ErrorMsg,
43
+ SearchInfo,
42
44
  GetTokenCountRequest,
43
45
  Message,
44
46
  ChatCompletionsResponse,
@@ -117,7 +119,7 @@ export class Client extends AbstractClient {
117
119
  }
118
120
 
119
121
  /**
120
- * 腾讯混元 Embedding 接口,可以将文本转化为高质量的向量数据。
122
+ * 腾讯混元 Embedding 接口,可以将文本转化为高质量的向量数据。向量维度为1024维。
121
123
  */
122
124
  async GetEmbedding(
123
125
  req: GetEmbeddingRequest,
@@ -101,6 +101,10 @@ export interface ChatCompletionsRequest {
101
101
  * 强制模型调用指定的工具,当参数ToolChoice为custom时,此参数为必填
102
102
  */
103
103
  CustomTool?: Tool
104
+ /**
105
+ * 默认是false,在值为true且命中搜索时,接口会返回SearchInfo
106
+ */
107
+ SearchInfo?: boolean
104
108
  }
105
109
 
106
110
  /**
@@ -152,7 +156,9 @@ export interface Content {
152
156
  */
153
157
  export interface SubmitHunyuanImageJobRequest {
154
158
  /**
155
- * 文本描述。 算法将根据输入的文本智能生成与之相关的图像。 不能为空,推荐使用中文。最多可传100个 utf-8 字符。
159
+ * 文本描述。
160
+ 算法将根据输入的文本智能生成与之相关的图像。
161
+ 不能为空,推荐使用中文。最多可传1024个 utf-8 字符。
156
162
  */
157
163
  Prompt: string
158
164
  /**
@@ -225,6 +231,27 @@ export interface Tool {
225
231
  Function: ToolFunction
226
232
  }
227
233
 
234
+ /**
235
+ * 搜索引文信息
236
+ */
237
+ export interface SearchResult {
238
+ /**
239
+ * 搜索引文序号
240
+ 注意:此字段可能返回 null,表示取不到有效值。
241
+ */
242
+ Index?: string
243
+ /**
244
+ * 搜索引文标题
245
+ 注意:此字段可能返回 null,表示取不到有效值。
246
+ */
247
+ Title?: string
248
+ /**
249
+ * 搜索引文链接
250
+ 注意:此字段可能返回 null,表示取不到有效值。
251
+ */
252
+ Url?: string
253
+ }
254
+
228
255
  /**
229
256
  * 返回的回复, 支持多个
230
257
  */
@@ -312,7 +339,9 @@ export interface ToolFunction {
312
339
  */
313
340
  export interface TextToImageLiteResponse {
314
341
  /**
315
- * 根据入参 RspImgType 填入不同,返回不同的内容。如果传入 base64 则返回生成图 Base64 编码。如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
342
+ * 根据入参 RspImgType 填入不同,返回不同的内容。
343
+ 如果传入 base64 则返回生成图 Base64 编码。
344
+ 如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
316
345
  */
317
346
  ResultImage?: string
318
347
  /**
@@ -321,6 +350,24 @@ export interface TextToImageLiteResponse {
321
350
  RequestId?: string
322
351
  }
323
352
 
353
+ /**
354
+ * 模型生成的工具调用
355
+ */
356
+ export interface ToolCall {
357
+ /**
358
+ * 工具调用id
359
+ */
360
+ Id: string
361
+ /**
362
+ * 工具调用类型,当前只支持function
363
+ */
364
+ Type: string
365
+ /**
366
+ * 具体的function调用
367
+ */
368
+ Function: ToolCallFunction
369
+ }
370
+
324
371
  /**
325
372
  * 具体的function调用
326
373
  */
@@ -335,6 +382,28 @@ export interface ToolCallFunction {
335
382
  Arguments: string
336
383
  }
337
384
 
385
+ /**
386
+ * 返回的内容(流式返回)
387
+ */
388
+ export interface Delta {
389
+ /**
390
+ * 角色名称。
391
+ */
392
+ Role?: string
393
+ /**
394
+ * 内容详情。
395
+ */
396
+ Content?: string
397
+ /**
398
+ * 模型生成的工具调用,仅 hunyuan-functioncall 模型支持
399
+ 说明:
400
+ 对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。
401
+
402
+ 注意:此字段可能返回 null,表示取不到有效值。
403
+ */
404
+ ToolCalls?: Array<ToolCall>
405
+ }
406
+
338
407
  /**
339
408
  * TextToImageLite请求参数结构体
340
409
  */
@@ -353,8 +422,7 @@ export interface TextToImageLiteRequest {
353
422
  NegativePrompt?: string
354
423
  /**
355
424
  * 绘画风格。
356
- 请在 [智能文生图风格列表](https://cloud.tencent.com/document/product/1668/86249) 中选择期望的风格,传入风格编号。
357
- 推荐使用且只使用一种风格。不传默认使用201(日系动漫风格)。
425
+ 请在 [文生图轻量版风格列表](https://cloud.tencent.com/document/product/1729/108992) 中选择期望的风格,传入风格编号。不传默认使用201(日系动漫风格)。
358
426
  */
359
427
  Style?: string
360
428
  /**
@@ -376,46 +444,6 @@ export interface TextToImageLiteRequest {
376
444
  RspImgType?: string
377
445
  }
378
446
 
379
- /**
380
- * 返回的内容(流式返回)
381
- */
382
- export interface Delta {
383
- /**
384
- * 角色名称。
385
- */
386
- Role?: string
387
- /**
388
- * 内容详情。
389
- */
390
- Content?: string
391
- /**
392
- * 模型生成的工具调用,仅 hunyuan-functioncall 模型支持
393
- 说明:
394
- 对于每一次的输出值应该以Id为标识对Type、Name、Arguments字段进行合并。
395
-
396
- 注意:此字段可能返回 null,表示取不到有效值。
397
- */
398
- ToolCalls?: Array<ToolCall>
399
- }
400
-
401
- /**
402
- * 模型生成的工具调用
403
- */
404
- export interface ToolCall {
405
- /**
406
- * 工具调用id
407
- */
408
- Id: string
409
- /**
410
- * 工具调用类型,当前只支持function
411
- */
412
- Type: string
413
- /**
414
- * 具体的function调用
415
- */
416
- Function: ToolCallFunction
417
- }
418
-
419
447
  /**
420
448
  * SubmitHunyuanImageJob返回参数结构体
421
449
  */
@@ -509,6 +537,17 @@ export interface ErrorMsg {
509
537
  Code?: number
510
538
  }
511
539
 
540
+ /**
541
+ * 搜索结果信息
542
+ */
543
+ export interface SearchInfo {
544
+ /**
545
+ * 搜索引文信息
546
+ 注意:此字段可能返回 null,表示取不到有效值。
547
+ */
548
+ SearchResults?: Array<SearchResult>
549
+ }
550
+
512
551
  /**
513
552
  * GetTokenCount请求参数结构体
514
553
  */
@@ -583,6 +622,10 @@ export interface ChatCompletionsResponse {
583
622
  * 多轮会话风险审核,值为1时,表明存在信息安全风险,建议终止客户多轮会话。
584
623
  */
585
624
  ModerationLevel?: string
625
+ /**
626
+ * 搜索结果信息
627
+ */
628
+ SearchInfo?: SearchInfo
586
629
  /**
587
630
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口,当请求成功时,RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
588
631
  */
@@ -823,11 +823,11 @@ export interface DescribeRegionsResponse {
823
823
  /**
824
824
  * 地域数量。
825
825
  */
826
- TotalCount: number
826
+ TotalCount?: number
827
827
  /**
828
828
  * 地域信息列表。
829
829
  */
830
- RegionSet: Array<RegionInfo>
830
+ RegionSet?: Array<RegionInfo>
831
831
  /**
832
832
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
833
833
  */
@@ -1985,7 +1985,7 @@ DomainName+AppName+StreamName+TemplateId唯一标识单个转码规则,如需
1985
1985
  /**
1986
1986
  * 创建一个在指定时间启动、结束的录制任务,并使用指定录制模板ID对应的配置进行录制。
1987
1987
  - 使用前提
1988
- 1. 录制文件存放于点播平台,所以用户如需使用录制功能,需首先自行开通点播服务。
1988
+ 1. 录制文件存放于点播平台或对象存储内,所以用户如需使用录制功能,需首先自行开通点播服务或对象存储服务。
1989
1989
  2. 录制文件存放后相关费用(含存储以及下行播放流量)按照点播平台计费方式收取,具体请参考[对应文档](https://cloud.tencent.com/document/product/266/2837)。
1990
1990
  - 注意事项
1991
1991
  1. 断流会结束当前录制并生成录制文件。在结束时间到达之前任务仍然有效,期间只要正常推流都会正常录制,与是否多次推、断流无关。