tencentcloud-sdk-nodejs 4.0.695 → 4.0.697

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 (134) hide show
  1. package/CHANGELOG.md +587 -0
  2. package/SERVICE_CHANGELOG.md +650 -56
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_models.ts +4 -1
  7. package/src/services/bi/v20220105/bi_client.ts +249 -3
  8. package/src/services/bi/v20220105/bi_models.ts +1981 -42
  9. package/src/services/billing/v20180709/billing_client.ts +57 -6
  10. package/src/services/billing/v20180709/billing_models.ts +646 -74
  11. package/src/services/bma/index.ts +2 -2
  12. package/src/services/btoe/index.ts +2 -2
  13. package/src/services/cfw/v20190904/cfw_models.ts +48 -17
  14. package/src/services/cii/index.ts +2 -2
  15. package/src/services/clb/v20180317/clb_models.ts +4 -4
  16. package/src/services/cloudstudio/index.ts +2 -2
  17. package/src/services/cls/v20201016/cls_models.ts +6 -1
  18. package/src/services/csip/v20221121/csip_client.ts +1 -1
  19. package/src/services/csip/v20221121/csip_models.ts +16 -2
  20. package/src/services/cvm/v20170312/cvm_models.ts +4 -4
  21. package/src/services/cwp/v20180228/cwp_models.ts +7 -2
  22. package/src/services/dbbrain/index.ts +2 -2
  23. package/src/services/dts/index.ts +2 -2
  24. package/src/services/emr/v20190103/emr_models.ts +5 -5
  25. package/src/services/ess/v20201111/ess_client.ts +24 -11
  26. package/src/services/ess/v20201111/ess_models.ts +148 -56
  27. package/src/services/essbasic/v20210526/essbasic_client.ts +31 -3
  28. package/src/services/essbasic/v20210526/essbasic_models.ts +91 -11
  29. package/src/services/iotvideo/index.ts +2 -2
  30. package/src/services/lcic/v20220817/lcic_client.ts +1 -1
  31. package/src/services/lcic/v20220817/lcic_models.ts +5 -5
  32. package/src/services/lighthouse/v20200324/lighthouse_models.ts +4 -1
  33. package/src/services/mongodb/index.ts +2 -2
  34. package/src/services/mps/v20190612/mps_models.ts +1 -1
  35. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  36. package/src/services/organization/index.ts +2 -2
  37. package/src/services/sms/index.ts +2 -2
  38. package/src/services/sms/v20210111/sms_client.ts +0 -8
  39. package/src/services/sms/v20210111/sms_models.ts +31 -29
  40. package/src/services/tat/v20201028/tat_models.ts +5 -3
  41. package/src/services/tbp/index.ts +2 -2
  42. package/src/services/teo/v20220901/teo_client.ts +33 -9
  43. package/src/services/teo/v20220901/teo_models.ts +244 -100
  44. package/src/services/thpc/index.ts +2 -2
  45. package/src/services/tmt/v20180321/tmt_client.ts +1 -1
  46. package/src/services/tmt/v20180321/tmt_models.ts +1 -1
  47. package/src/services/trocket/v20230308/trocket_client.ts +75 -24
  48. package/src/services/trocket/v20230308/trocket_models.ts +204 -25
  49. package/src/services/tse/v20201207/tse_models.ts +36 -6
  50. package/src/services/tsw/index.ts +2 -2
  51. package/src/services/vpc/v20170312/vpc_client.ts +1 -0
  52. package/src/services/vpc/v20170312/vpc_models.ts +88 -0
  53. package/src/services/waf/v20180125/waf_client.ts +2 -0
  54. package/src/services/waf/v20180125/waf_models.ts +294 -52
  55. package/src/services/yunsou/index.ts +2 -2
  56. package/tencentcloud/common/sdk_version.d.ts +1 -1
  57. package/tencentcloud/common/sdk_version.js +1 -1
  58. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +4 -1
  59. package/tencentcloud/services/bi/v20220105/bi_client.d.ts +77 -1
  60. package/tencentcloud/services/bi/v20220105/bi_client.js +114 -0
  61. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +1925 -42
  62. package/tencentcloud/services/billing/v20180709/billing_client.d.ts +20 -3
  63. package/tencentcloud/services/billing/v20180709/billing_client.js +27 -2
  64. package/tencentcloud/services/billing/v20180709/billing_models.d.ts +636 -74
  65. package/tencentcloud/services/bma/index.d.ts +4 -4
  66. package/tencentcloud/services/bma/index.js +2 -2
  67. package/tencentcloud/services/btoe/index.d.ts +4 -4
  68. package/tencentcloud/services/btoe/index.js +2 -2
  69. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +48 -17
  70. package/tencentcloud/services/cii/index.d.ts +4 -4
  71. package/tencentcloud/services/cii/index.js +2 -2
  72. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -4
  73. package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
  74. package/tencentcloud/services/cloudstudio/index.js +2 -2
  75. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +6 -1
  76. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +1 -1
  77. package/tencentcloud/services/csip/v20221121/csip_client.js +1 -1
  78. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +16 -2
  79. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +4 -4
  80. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +7 -2
  81. package/tencentcloud/services/dbbrain/index.d.ts +4 -4
  82. package/tencentcloud/services/dbbrain/index.js +2 -2
  83. package/tencentcloud/services/dts/index.d.ts +4 -4
  84. package/tencentcloud/services/dts/index.js +2 -2
  85. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +5 -5
  86. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +23 -11
  87. package/tencentcloud/services/ess/v20201111/ess_client.js +22 -10
  88. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +147 -56
  89. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +28 -2
  90. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +27 -1
  91. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +89 -11
  92. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  93. package/tencentcloud/services/iotvideo/index.js +2 -2
  94. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +1 -1
  95. package/tencentcloud/services/lcic/v20220817/lcic_client.js +1 -1
  96. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +5 -5
  97. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +4 -1
  98. package/tencentcloud/services/mongodb/index.d.ts +4 -4
  99. package/tencentcloud/services/mongodb/index.js +2 -2
  100. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +1 -1
  101. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  102. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  103. package/tencentcloud/services/organization/index.d.ts +4 -4
  104. package/tencentcloud/services/organization/index.js +2 -2
  105. package/tencentcloud/services/sms/index.d.ts +4 -4
  106. package/tencentcloud/services/sms/index.js +2 -2
  107. package/tencentcloud/services/sms/v20210111/sms_client.d.ts +0 -8
  108. package/tencentcloud/services/sms/v20210111/sms_client.js +0 -8
  109. package/tencentcloud/services/sms/v20210111/sms_models.d.ts +31 -29
  110. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +5 -3
  111. package/tencentcloud/services/tbp/index.d.ts +4 -4
  112. package/tencentcloud/services/tbp/index.js +2 -2
  113. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +18 -6
  114. package/tencentcloud/services/teo/v20220901/teo_client.js +19 -5
  115. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +237 -99
  116. package/tencentcloud/services/thpc/index.d.ts +4 -4
  117. package/tencentcloud/services/thpc/index.js +2 -2
  118. package/tencentcloud/services/tmt/v20180321/tmt_client.d.ts +1 -1
  119. package/tencentcloud/services/tmt/v20180321/tmt_client.js +1 -1
  120. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +1 -1
  121. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +29 -11
  122. package/tencentcloud/services/trocket/v20230308/trocket_client.js +39 -13
  123. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +195 -25
  124. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +36 -6
  125. package/tencentcloud/services/tsw/index.d.ts +4 -4
  126. package/tencentcloud/services/tsw/index.js +2 -2
  127. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +87 -0
  128. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +292 -52
  129. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  130. package/tencentcloud/services/yunsou/index.js +2 -2
  131. package/test/bi.v20220105.test.js +190 -0
  132. package/test/billing.v20180709.test.js +40 -0
  133. package/test/teo.v20220901.test.js +10 -0
  134. package/test/trocket.v20230308.test.js +46 -6
@@ -313,7 +313,7 @@ export interface CreateFlowApproversResponse {
313
313
  export interface DescribeFileUrlsResponse {
314
314
  /**
315
315
  * 文件URL信息;
316
- 链接不是永久链接,有效期5分钟后链接失效。
316
+ 链接不是永久链接, 过期时间收UrlTtl入参的影响, 默认有效期5分钟后, 到期后链接失效。
317
317
  */
318
318
  FileUrls?: Array<FileUrl>
319
319
  /**
@@ -1026,6 +1026,11 @@ export interface FlowApproverDetail {
1026
1026
  注意:此字段可能返回 null,表示取不到有效值。
1027
1027
  */
1028
1028
  SignId?: string
1029
+ /**
1030
+ * 自定义签署人角色
1031
+ 注意:此字段可能返回 null,表示取不到有效值。
1032
+ */
1033
+ ApproverRoleName?: string
1029
1034
  }
1030
1035
 
1031
1036
  /**
@@ -1122,6 +1127,38 @@ export interface CallbackInfo {
1122
1127
  CallbackToken?: string
1123
1128
  }
1124
1129
 
1130
+ /**
1131
+ * DeleteSealPolicies请求参数结构体
1132
+ */
1133
+ export interface DeleteSealPoliciesRequest {
1134
+ /**
1135
+ * 执行本接口操作的员工信息。
1136
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1137
+ */
1138
+ Operator: UserInfo
1139
+ /**
1140
+ * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
1141
+ */
1142
+ PolicyIds?: Array<string>
1143
+ /**
1144
+ * 电子印章ID,为32位字符串。
1145
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
1146
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
1147
+ 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
1148
+ */
1149
+ SealId?: string
1150
+ /**
1151
+ * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
1152
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
1153
+ */
1154
+ UserIds?: Array<string>
1155
+ /**
1156
+ * 代理企业和员工的信息。
1157
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1158
+ */
1159
+ Agent?: Agent
1160
+ }
1161
+
1125
1162
  /**
1126
1163
  * CreateFlowGroupByTemplates返回参数结构体
1127
1164
  */
@@ -1281,6 +1318,11 @@ export interface CreateDocumentResponse {
1281
1318
  注意:此字段可能返回 null,表示取不到有效值。
1282
1319
  */
1283
1320
  PreviewFileUrl?: string
1321
+ /**
1322
+ * 签署方信息,如角色ID、角色名称等
1323
+ 注意:此字段可能返回 null,表示取不到有效值。
1324
+ */
1325
+ Approvers?: Array<ApproverItem>
1284
1326
  /**
1285
1327
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1286
1328
  */
@@ -1523,6 +1565,10 @@ export interface CreateSchemeUrlRequest {
1523
1565
  注: `字段为数组, 可以传值隐藏多个按钮`
1524
1566
  */
1525
1567
  Hides?: Array<number | bigint>
1568
+ /**
1569
+ * 签署节点ID,用于生成动态签署人链接完成领取
1570
+ */
1571
+ RecipientId?: string
1526
1572
  }
1527
1573
 
1528
1574
  /**
@@ -2059,6 +2105,10 @@ WEWORKAPP: 企业微信
2059
2105
  * 补充企业签署人员工手机号
2060
2106
  */
2061
2107
  ApproverMobile?: string
2108
+ /**
2109
+ * 补充企业动态签署人时,需要指定对应企业名称
2110
+ */
2111
+ OrganizationName?: string
2062
2112
  }
2063
2113
 
2064
2114
  /**
@@ -2488,6 +2538,10 @@ export interface CreateSchemeUrlResponse {
2488
2538
  <li>如果EndPoint是**HTTP_SHORT_URL**,得到的链接类似于 `https://essurl.cn/2n**42Nd`,点击后会跳转到腾讯电子签小程序进行签署</li></ul>
2489
2539
  */
2490
2540
  SchemeUrl?: string
2541
+ /**
2542
+ * 二维码,在生成动态签署人跳转封面页链接时返回
2543
+ */
2544
+ SchemeQrcodeUrl?: string
2491
2545
  /**
2492
2546
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2493
2547
  */
@@ -2668,10 +2722,10 @@ export interface DescribeFileUrlsRequest {
2668
2722
  /**
2669
2723
  * 文件对应的业务类型,目前支持:
2670
2724
  <ul>
2671
- <li>FLOW 如需下载合同文件请选择此项</li>
2672
- <li>TEMPLATE 如需下载模板文件请选择此项</li>
2673
- <li>DOCUMENT 如需下载文档文件请选择此项</li>
2674
- <li>SEAL 如需下载印章图片请选择此项</li>
2725
+ <li>**FLOW ** : 如需下载合同文件请选择此项</li>
2726
+ <li>**TEMPLATE ** : 如需下载模板文件请选择此项</li>
2727
+ <li>**DOCUMENT **: 如需下载文档文件请选择此项</li>
2728
+ <li>**SEAL **: 如需下载印章图片请选择此项</li>
2675
2729
  </ul>
2676
2730
  */
2677
2731
  BusinessType: string
@@ -2988,6 +3042,13 @@ export interface CreateFlowApproversRequest {
2988
3042
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2989
3043
  */
2990
3044
  Agent?: Agent
3045
+ /**
3046
+ * 签署人信息补充方式
3047
+
3048
+ <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
3049
+ <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
3050
+ */
3051
+ FillApproverType?: number
2991
3052
  }
2992
3053
 
2993
3054
  /**
@@ -3682,15 +3743,18 @@ export interface FailedUpdateStaffData {
3682
3743
  */
3683
3744
  export interface GetTaskResultApiRequest {
3684
3745
  /**
3685
- * 任务Id,通过接口CreateConvertTaskApiCreateMergeFileTask得到的返回任务id
3746
+ * 转换任务Id,通过接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>或<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateMergeFileTask" target="_blank">创建多文件转换任务接口</a>
3747
+ 得到的转换任务id
3686
3748
  */
3687
3749
  TaskId: string
3688
3750
  /**
3689
- * 操作人信息,UserId必填
3751
+ * 执行本接口操作的员工信息。
3752
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3690
3753
  */
3691
3754
  Operator?: UserInfo
3692
3755
  /**
3693
- * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3756
+ * 代理企业和员工的信息。
3757
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3694
3758
  */
3695
3759
  Agent?: Agent
3696
3760
  /**
@@ -4198,6 +4262,11 @@ export interface CreateFlowByFilesResponse {
4198
4262
  注意:此字段可能返回 null,表示取不到有效值。
4199
4263
  */
4200
4264
  PreviewUrl?: string
4265
+ /**
4266
+ * 签署方信息,如角色ID、角色名称等
4267
+ 注意:此字段可能返回 null,表示取不到有效值。
4268
+ */
4269
+ Approvers?: Array<ApproverItem>
4201
4270
  /**
4202
4271
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4203
4272
  */
@@ -4209,7 +4278,8 @@ export interface CreateFlowByFilesResponse {
4209
4278
  */
4210
4279
  export interface UploadFilesResponse {
4211
4280
  /**
4212
- * 文件id数组
4281
+ * 文件资源ID数组,每个文件资源ID为32位字符串。
4282
+ 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
4213
4283
  */
4214
4284
  FileIds?: Array<string>
4215
4285
  /**
@@ -4424,6 +4494,10 @@ export interface ApproverInfo {
4424
4494
  注: `收据场景为白名单功能,使用前请联系对接的客户经理沟通。`
4425
4495
  */
4426
4496
  ApproverRole?: number
4497
+ /**
4498
+ * 自定义签署人角色名:收款人、开具人、见证人
4499
+ */
4500
+ ApproverRoleName?: string
4427
4501
  /**
4428
4502
  * 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
4429
4503
 
@@ -4761,35 +4835,24 @@ export interface CreateWebThemeConfigRequest {
4761
4835
  }
4762
4836
 
4763
4837
  /**
4764
- * DeleteSealPolicies请求参数结构体
4838
+ * 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
4765
4839
  */
4766
- export interface DeleteSealPoliciesRequest {
4767
- /**
4768
- * 执行本接口操作的员工信息。
4769
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4770
- */
4771
- Operator: UserInfo
4840
+ export interface ApproverItem {
4772
4841
  /**
4773
- * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
4774
- */
4775
- PolicyIds?: Array<string>
4776
- /**
4777
- * 电子印章ID,为32位字符串。
4778
- 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4779
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4780
- 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
4842
+ * 签署方唯一编号
4843
+ 注意:此字段可能返回 null,表示取不到有效值。
4781
4844
  */
4782
- SealId?: string
4845
+ SignId?: string
4783
4846
  /**
4784
- * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
4785
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4847
+ * 签署方角色编号
4848
+ 注意:此字段可能返回 null,表示取不到有效值。
4786
4849
  */
4787
- UserIds?: Array<string>
4850
+ RecipientId?: string
4788
4851
  /**
4789
- * 代理企业和员工的信息。
4790
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4852
+ * 签署方角色名称
4853
+ 注意:此字段可能返回 null,表示取不到有效值。
4791
4854
  */
4792
- Agent?: Agent
4855
+ ApproverRoleName?: string
4793
4856
  }
4794
4857
 
4795
4858
  /**
@@ -4894,22 +4957,22 @@ export interface GetTaskResultApiResponse {
4894
4957
  TaskId?: string
4895
4958
  /**
4896
4959
  * 任务状态,需要关注的状态
4897
- 0 :NeedTranform - 任务已提交
4898
- 4 :Processing - 文档转换中
4899
- 8 :TaskEnd - 任务处理完成
4900
- -2 :DownloadFailed - 下载失败
4901
- -6 :ProcessFailed - 转换失败
4902
- -13:ProcessTimeout - 转换文件超时
4960
+ <ul><li>**0** :NeedTranform - 任务已提交</li>
4961
+ <li>**4** :Processing - 文档转换中</li>
4962
+ <li>**8** :TaskEnd - 任务处理完成</li>
4963
+ <li>**-2** :DownloadFailed - 下载失败</li>
4964
+ <li>**-6** :ProcessFailed - 转换失败</li>
4965
+ <li>**-13**:ProcessTimeout - 转换文件超时</li></ul>
4903
4966
  */
4904
4967
  TaskStatus?: number
4905
4968
  /**
4906
4969
  * 状态描述,需要关注的状态
4907
- NeedTranform - 任务已提交
4908
- Processing - 文档转换中
4909
- TaskEnd - 任务处理完成
4910
- DownloadFailed - 下载失败
4911
- ProcessFailed - 转换失败
4912
- ProcessTimeout - 转换文件超时
4970
+ <ul><li> **NeedTranform** : 任务已提交</li>
4971
+ <li> **Processing** : 文档转换中</li>
4972
+ <li> **TaskEnd** : 任务处理完成</li>
4973
+ <li> **DownloadFailed** : 下载失败</li>
4974
+ <li> **ProcessFailed** : 转换失败</li>
4975
+ <li> **ProcessTimeout** : 转换文件超时</li></ul>
4913
4976
  */
4914
4977
  TaskMessage?: string
4915
4978
  /**
@@ -5192,6 +5255,13 @@ export interface ApproverOption {
5192
5255
  <li> **true** :不可以转他人处理</li></ul>
5193
5256
  */
5194
5257
  NoTransfer?: boolean
5258
+ /**
5259
+ * 签署人信息补充类型,默认无需补充。
5260
+
5261
+ <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)</li>
5262
+ </ul>
5263
+ */
5264
+ FillType?: number
5195
5265
  }
5196
5266
 
5197
5267
  /**
@@ -5347,11 +5417,12 @@ export interface CancelFlowRequest {
5347
5417
  Operator: UserInfo
5348
5418
  /**
5349
5419
  * 合同流程ID, 为32位字符串。
5350
- 建议开发者保存此流程ID方便后续其他操作。
5420
+
5421
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
5351
5422
  */
5352
5423
  FlowId: string
5353
5424
  /**
5354
- * 撤销此合同(流程)的原因,最长200个字。
5425
+ * 撤销此合同流程的原因,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
5355
5426
  */
5356
5427
  CancelMessage: string
5357
5428
  /**
@@ -6047,33 +6118,49 @@ export interface DescribeFlowTemplatesResponse {
6047
6118
  */
6048
6119
  export interface UploadFilesRequest {
6049
6120
  /**
6050
- * 文件对应业务类型
6051
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
6052
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
6053
- 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
6121
+ * 文件对应业务类型,可以选择的类型如下
6122
+ <ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
6123
+ <li> **DOCUMENT** : 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
6124
+ <li> **DOCUMENT** : 此文件用于合同图片控件的填充,文件类型支持.jpg/.png</li>
6125
+ <li> **SEAL** : 此文件用于印章的生成,文件类型支持.jpg/.jpeg/.png</li></ul>
6054
6126
  */
6055
6127
  BusinessType: string
6056
6128
  /**
6057
- * 调用方信息,其中OperatorId为必填字段,即用户的UserId
6129
+ * 执行本接口操作的员工信息。其中OperatorId为必填字段,即用户的UserId
6130
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6058
6131
  */
6059
6132
  Caller?: Caller
6060
6133
  /**
6061
- * 上传文件内容数组,最多支持20个文件
6134
+ * 上传文件内容数组,最多支持上传20个文件。
6062
6135
  */
6063
6136
  FileInfos?: Array<UploadFile>
6064
6137
  /**
6065
- * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
6066
- 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
6138
+ * 文件类型, 默认通过文件内容和文件后缀一起解析得到文件类型,调用接口时可以显示的指定上传文件的类型。
6139
+ 可支持的指定类型如下:
6140
+ <ul><li>pdf</li>
6141
+ <li>doc</li>
6142
+ <li>docx</li>
6143
+ <li>xls</li>
6144
+ <li>xlsx</li>
6145
+ <li>html</li>
6146
+ <li>jpg</li>
6147
+ <li>jpeg</li>
6148
+ <li>png</li></ul>
6149
+ 如:pdf 表示上传的文件 张三入职合同.pdf的文件类型是 pdf
6067
6150
  */
6068
6151
  FileType?: string
6069
6152
  /**
6070
- * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
6071
- true--是,处理置白
6072
- 默认为false--否,不处理
6153
+ * 此参数仅对上传的PDF文件有效。其主要作用是确定是否将PDF中的灰色矩阵置为白色。
6154
+ <ul><li>**true**:将灰色矩阵置为白色。</li>
6155
+ <li>**false**:无需处理,不会将灰色矩阵置为白色(默认)。</li></ul>
6156
+
6157
+ 注: `该参数仅在关键字定位时,需要去除关键字所在的灰框场景下使用。`
6073
6158
  */
6074
6159
  CoverRect?: boolean
6075
6160
  /**
6076
6161
  * 用户自定义ID数组,与上传文件一一对应
6162
+
6163
+ 注: `历史遗留问题,已经废弃,调用接口时不用赋值`
6077
6164
  */
6078
6165
  CustomIds?: Array<string>
6079
6166
  /**
@@ -6081,6 +6168,11 @@ true--是,处理置白
6081
6168
  * @deprecated
6082
6169
  */
6083
6170
  FileUrls?: string
6171
+ /**
6172
+ * 代理企业和员工的信息。
6173
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6174
+ */
6175
+ Agent?: Agent
6084
6176
  }
6085
6177
 
6086
6178
  /**
@@ -64,6 +64,7 @@ import {
64
64
  DescribeResourceUrlsByFlowsResponse,
65
65
  ChannelCreateFlowGroupByFilesRequest,
66
66
  ChannelCreateOrganizationModifyQrCodeRequest,
67
+ ChannelCreateFlowByFilesResponse,
67
68
  DescribeFlowDetailInfoResponse,
68
69
  RecipientComponentInfo,
69
70
  ChannelDescribeRolesRequest,
@@ -126,13 +127,14 @@ import {
126
127
  ChannelModifyRoleResponse,
127
128
  Filter,
128
129
  FilledComponent,
130
+ FlowApproverItem,
129
131
  CreateSignUrlsResponse,
130
132
  ChannelDeleteRoleRequest,
131
133
  UploadFilesResponse,
132
134
  ChannelCreateBatchCancelFlowUrlRequest,
133
135
  ApproverRestriction,
134
136
  PrepareFlowsRequest,
135
- ChannelCreateFlowByFilesResponse,
137
+ ApproverItem,
136
138
  ChannelCreateFlowSignReviewResponse,
137
139
  ChannelDisableUserAutoSignRequest,
138
140
  ChannelDescribeOrganizationSealsResponse,
@@ -298,8 +300,34 @@ export class Client extends AbstractClient {
298
300
  }
299
301
 
300
302
  /**
301
- * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人
302
- */
303
+ * 修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人。
304
+
305
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
306
+ 1. 通过链接Url直接跳转到小程序,不需要返回
307
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。
308
+
309
+ 2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
310
+ 跳转到小程序的实现,参考官方文档
311
+ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
312
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
313
+ 设置EndPoint为APP,得到path。
314
+
315
+ 4. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
316
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
317
+ 全屏方式:
318
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
319
+ 半屏方式:
320
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
321
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
322
+ 设置EndPoint为APP,得到path。
323
+
324
+ 其中小程序的原始Id如下,或者查看小程序信息自助获取。
325
+
326
+ | 小程序 | AppID | 原始ID |
327
+ | ------------ | ------------ | ------------ |
328
+ | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
329
+ | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
330
+ */
303
331
  async ModifyExtendedService(
304
332
  req: ModifyExtendedServiceRequest,
305
333
  cb?: (error: string, rep: ModifyExtendedServiceResponse) => void
@@ -552,6 +552,12 @@ OPEN:开通
552
552
  CLOSE:关闭
553
553
  */
554
554
  Operate: string
555
+ /**
556
+ * 链接跳转类型,支持以下类型
557
+ <ul><li>WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)</li>
558
+ <li>APP : 第三方APP或小程序跳转电子签小程序</li></ul>
559
+ */
560
+ Endpoint?: string
555
561
  }
556
562
 
557
563
  /**
@@ -1446,6 +1452,11 @@ export interface FlowApproverDetail {
1446
1452
  注意:此字段可能返回 null,表示取不到有效值。
1447
1453
  */
1448
1454
  ApproveType?: string
1455
+ /**
1456
+ * 自定义签署人角色
1457
+ 注意:此字段可能返回 null,表示取不到有效值。
1458
+ */
1459
+ ApproverRoleName?: string
1449
1460
  }
1450
1461
 
1451
1462
  /**
@@ -1511,6 +1522,26 @@ export interface ChannelCreateOrganizationModifyQrCodeRequest {
1511
1522
  Agent: Agent
1512
1523
  }
1513
1524
 
1525
+ /**
1526
+ * ChannelCreateFlowByFiles返回参数结构体
1527
+ */
1528
+ export interface ChannelCreateFlowByFilesResponse {
1529
+ /**
1530
+ * 合同签署流程ID
1531
+ 注意:此字段可能返回 null,表示取不到有效值。
1532
+ */
1533
+ FlowId?: string
1534
+ /**
1535
+ * 签署方信息,如角色ID、角色名称等
1536
+ 注意:此字段可能返回 null,表示取不到有效值。
1537
+ */
1538
+ Approvers?: Array<ApproverItem>
1539
+ /**
1540
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1541
+ */
1542
+ RequestId?: string
1543
+ }
1544
+
1514
1545
  /**
1515
1546
  * DescribeFlowDetailInfo返回参数结构体
1516
1547
  */
@@ -2291,6 +2322,11 @@ PERSON 自然人
2291
2322
  注意:此字段可能返回 null,表示取不到有效值。
2292
2323
  */
2293
2324
  FlowGroupId?: string
2325
+ /**
2326
+ * 二维码,在生成动态签署人跳转封面页链接时返回
2327
+ 注意:此字段可能返回 null,表示取不到有效值。
2328
+ */
2329
+ SignQrcodeUrl?: string
2294
2330
  }
2295
2331
 
2296
2332
  /**
@@ -3105,6 +3141,10 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
3105
3141
  - 3:签署成功页的查看详情按钮
3106
3142
  */
3107
3143
  Hides?: Array<number | bigint>
3144
+ /**
3145
+ * 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致
3146
+ */
3147
+ RecipientIds?: Array<string>
3108
3148
  }
3109
3149
 
3110
3150
  /**
@@ -3188,11 +3228,14 @@ export interface SignQrCode {
3188
3228
  * 创建签署流程签署人入参。
3189
3229
 
3190
3230
  其中签署方FlowApproverInfo需要传递的参数
3191
- 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
3192
- 1-个人:Name、Mobile必传
3193
- 2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
3194
- 3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
3195
- 4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
3231
+ 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
3232
+
3233
+ 其他身份标识
3234
+
3235
+ <ul><li>1-个人:Name、Mobile必传</li>
3236
+ <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
3237
+ <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
3238
+ <li>4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
3196
3239
 
3197
3240
  RecipientId参数:
3198
3241
  从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
@@ -3319,6 +3362,10 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3319
3362
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
3320
3363
  */
3321
3364
  AddSignComponentsLimits?: Array<ComponentLimit>
3365
+ /**
3366
+ * 自定义签署方角色名称
3367
+ */
3368
+ ApproverRoleName?: string
3322
3369
  }
3323
3370
 
3324
3371
  /**
@@ -3514,6 +3561,10 @@ export interface CreateFlowsByTemplatesResponse {
3514
3561
  如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
3515
3562
  */
3516
3563
  TaskInfos?: Array<TaskInfo>
3564
+ /**
3565
+ * 签署方信息,如角色ID、角色名称等
3566
+ */
3567
+ FlowApprovers?: Array<FlowApproverItem>
3517
3568
  /**
3518
3569
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3519
3570
  */
@@ -3738,6 +3789,22 @@ export interface FilledComponent {
3738
3789
  ImageUrl?: string
3739
3790
  }
3740
3791
 
3792
+ /**
3793
+ * 签署方信息,如角色ID、角色名称等
3794
+ */
3795
+ export interface FlowApproverItem {
3796
+ /**
3797
+ * 合同编号
3798
+ 注意:此字段可能返回 null,表示取不到有效值。
3799
+ */
3800
+ FlowId?: string
3801
+ /**
3802
+ * 签署方信息,如角色ID、角色名称等
3803
+ 注意:此字段可能返回 null,表示取不到有效值。
3804
+ */
3805
+ Approvers?: Array<ApproverItem>
3806
+ }
3807
+
3741
3808
  /**
3742
3809
  * CreateSignUrls返回参数结构体
3743
3810
  */
@@ -3857,18 +3924,24 @@ export interface PrepareFlowsRequest {
3857
3924
  }
3858
3925
 
3859
3926
  /**
3860
- * ChannelCreateFlowByFiles返回参数结构体
3927
+ * 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
3861
3928
  */
3862
- export interface ChannelCreateFlowByFilesResponse {
3929
+ export interface ApproverItem {
3863
3930
  /**
3864
- * 合同签署流程ID
3931
+ * 签署方唯一编号
3865
3932
  注意:此字段可能返回 null,表示取不到有效值。
3866
3933
  */
3867
- FlowId?: string
3934
+ SignId?: string
3868
3935
  /**
3869
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3936
+ * 签署方角色编号
3937
+ 注意:此字段可能返回 null,表示取不到有效值。
3870
3938
  */
3871
- RequestId?: string
3939
+ RecipientId?: string
3940
+ /**
3941
+ * 签署方角色名称
3942
+ 注意:此字段可能返回 null,表示取不到有效值。
3943
+ */
3944
+ ApproverRoleName?: string
3872
3945
  }
3873
3946
 
3874
3947
  /**
@@ -4081,6 +4154,13 @@ export interface ApproverOption {
4081
4154
  * 是否隐藏一键签署 默认false-不隐藏true-隐藏
4082
4155
  */
4083
4156
  HideOneKeySign?: boolean
4157
+ /**
4158
+ * 签署人信息补充类型,默认无需补充。
4159
+
4160
+ <ul><li> **1** : ( 动态签署人(可发起合同后再补充签署人信息)</li>
4161
+ </ul>
4162
+ */
4163
+ FillType?: number
4084
4164
  }
4085
4165
 
4086
4166
  /**
@@ -1,9 +1,9 @@
1
- import { v20201215 } from "./v20201215"
2
1
  import { v20191126 } from "./v20191126"
3
2
  import { v20211125 } from "./v20211125"
3
+ import { v20201215 } from "./v20201215"
4
4
 
5
5
  export const iotvideo = {
6
- v20201215: v20201215,
7
6
  v20191126: v20191126,
8
7
  v20211125: v20211125,
8
+ v20201215: v20201215,
9
9
  }
@@ -434,7 +434,7 @@ export class Client extends AbstractClient {
434
434
  }
435
435
 
436
436
  /**
437
- * 获取房间信息
437
+ * 获取房间配置信息
438
438
  */
439
439
  async DescribeRoom(
440
440
  req: DescribeRoomRequest,
@@ -43,7 +43,7 @@ export interface CreateRoomRequest {
43
43
  */
44
44
  Resolution: number
45
45
  /**
46
- * 最大连麦人数(不包括老师)。取值范围[0, 16]
46
+ * 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。取值范围[0,16],当取值为0时表示当前课堂/直播,不支持连麦互动。
47
47
  */
48
48
  MaxMicNumber: number
49
49
  /**
@@ -1978,7 +1978,7 @@ video 纯视频
1978
1978
  */
1979
1979
  VideoOrientation?: number
1980
1980
  /**
1981
- * 开启课后评分。 0:不开启(默认) 1:开启
1981
+ * 该房间是否开启了课后评分功能。0:未开启 1:开启
1982
1982
  */
1983
1983
  IsGradingRequiredPostClass?: number
1984
1984
  /**
@@ -2500,8 +2500,8 @@ export interface ModifyRoomRequest {
2500
2500
  */
2501
2501
  Resolution?: number
2502
2502
  /**
2503
- * 最大连麦人数(不包括老师)。取值范围[0, 17)
2504
- 直播开始后不允许修改。
2503
+ * 设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。
2504
+ 取值范围[0,16],当取值为0时表示当前课堂/直播,不支持连麦互动。
2505
2505
  */
2506
2506
  MaxMicNumber?: number
2507
2507
  /**
@@ -2559,7 +2559,7 @@ video 纯视频
2559
2559
  */
2560
2560
  IsGradingRequiredPostClass?: number
2561
2561
  /**
2562
- * 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
2562
+ * 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数、暂未开放)
2563
2563
  */
2564
2564
  RoomType?: number
2565
2565
  /**