tencentcloud-sdk-nodejs 4.0.789 → 4.0.791

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 (96) hide show
  1. package/CHANGELOG.md +804 -0
  2. package/README.md +6 -0
  3. package/SERVICE_CHANGELOG.md +1231 -240
  4. package/examples/cls/v20201016/cls.proto +34 -0
  5. package/examples/cls/v20201016/upload_log.js +69 -0
  6. package/package.json +1 -1
  7. package/products.md +23 -23
  8. package/src/common/abstract_client.ts +32 -0
  9. package/src/common/http/http_connection.ts +5 -2
  10. package/src/common/sdk_version.ts +1 -1
  11. package/src/common/sign.ts +8 -4
  12. package/src/services/apigateway/v20180808/apigateway_models.ts +9 -4
  13. package/src/services/as/v20180419/as_models.ts +38 -38
  14. package/src/services/bi/v20220105/bi_client.ts +1 -0
  15. package/src/services/bi/v20220105/bi_models.ts +226 -16
  16. package/src/services/cdb/v20170320/cdb_client.ts +18 -6
  17. package/src/services/cdb/v20170320/cdb_models.ts +15 -0
  18. package/src/services/cls/v20201016/cls_client.ts +70 -21
  19. package/src/services/cls/v20201016/cls_models.ts +360 -145
  20. package/src/services/csip/v20221121/csip_client.ts +1 -0
  21. package/src/services/csip/v20221121/csip_models.ts +26 -0
  22. package/src/services/cwp/v20180228/cwp_client.ts +4 -2
  23. package/src/services/emr/v20190103/emr_models.ts +7 -7
  24. package/src/services/ess/v20201111/ess_client.ts +22 -4
  25. package/src/services/ess/v20201111/ess_models.ts +19 -10
  26. package/src/services/essbasic/v20210526/essbasic_client.ts +11 -9
  27. package/src/services/essbasic/v20210526/essbasic_models.ts +8 -0
  28. package/src/services/iotcloud/v20210408/iotcloud_client.ts +12 -0
  29. package/src/services/iotcloud/v20210408/iotcloud_models.ts +43 -3
  30. package/src/services/iotvideo/v20211125/iotvideo_models.ts +8 -0
  31. package/src/services/lcic/v20220817/lcic_models.ts +8 -0
  32. package/src/services/mna/v20210119/mna_models.ts +3 -3
  33. package/src/services/rum/v20210622/rum_client.ts +0 -12
  34. package/src/services/rum/v20210622/rum_models.ts +2 -109
  35. package/src/services/ssl/v20191205/ssl_models.ts +2 -3
  36. package/src/services/teo/v20220901/teo_client.ts +20 -15
  37. package/src/services/teo/v20220901/teo_models.ts +8 -4
  38. package/src/services/tmt/v20180321/tmt_models.ts +2 -2
  39. package/src/services/trro/v20220325/trro_models.ts +13 -0
  40. package/src/services/tse/v20201207/tse_client.ts +2 -1
  41. package/src/services/tse/v20201207/tse_models.ts +45 -15
  42. package/src/services/wedata/v20210820/wedata_client.ts +2802 -5338
  43. package/src/services/wedata/v20210820/wedata_models.ts +14500 -29440
  44. package/src/services/weilingwith/v20230427/weilingwith_models.ts +20 -2
  45. package/tencentcloud/common/abstract_client.d.ts +4 -0
  46. package/tencentcloud/common/abstract_client.js +22 -0
  47. package/tencentcloud/common/http/http_connection.js +6 -2
  48. package/tencentcloud/common/sdk_version.d.ts +1 -1
  49. package/tencentcloud/common/sdk_version.js +1 -1
  50. package/tencentcloud/common/sign.d.ts +2 -1
  51. package/tencentcloud/common/sign.js +6 -4
  52. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +9 -4
  53. package/tencentcloud/services/as/v20180419/as_models.d.ts +38 -38
  54. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +225 -16
  55. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +7 -3
  56. package/tencentcloud/services/cdb/v20170320/cdb_client.js +9 -3
  57. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +13 -0
  58. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +23 -7
  59. package/tencentcloud/services/cls/v20201016/cls_client.js +33 -9
  60. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +351 -145
  61. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +25 -0
  62. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +3 -1
  63. package/tencentcloud/services/cwp/v20180228/cwp_client.js +3 -1
  64. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +7 -7
  65. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +22 -4
  66. package/tencentcloud/services/ess/v20201111/ess_client.js +22 -4
  67. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -10
  68. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -9
  69. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -9
  70. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +8 -0
  71. package/tencentcloud/services/iotcloud/v20210408/iotcloud_client.d.ts +5 -1
  72. package/tencentcloud/services/iotcloud/v20210408/iotcloud_client.js +6 -0
  73. package/tencentcloud/services/iotcloud/v20210408/iotcloud_models.d.ts +41 -3
  74. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +8 -0
  75. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +8 -0
  76. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +3 -3
  77. package/tencentcloud/services/rum/v20210622/rum_client.d.ts +1 -5
  78. package/tencentcloud/services/rum/v20210622/rum_client.js +0 -6
  79. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +2 -107
  80. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +2 -3
  81. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +15 -10
  82. package/tencentcloud/services/teo/v20220901/teo_client.js +15 -10
  83. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +8 -4
  84. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +2 -2
  85. package/tencentcloud/services/trro/v20220325/trro_models.d.ts +13 -0
  86. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +1 -1
  87. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +44 -15
  88. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +675 -1483
  89. package/tencentcloud/services/wedata/v20210820/wedata_client.js +1027 -2237
  90. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14275 -28693
  91. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +20 -2
  92. package/test/cdb.v20170320.test.js +12 -2
  93. package/test/cls.v20201016.test.js +52 -12
  94. package/test/iotcloud.v20210408.test.js +10 -0
  95. package/test/rum.v20210622.test.js +0 -10
  96. package/test/wedata.v20210820.test.js +636 -2646
@@ -310,9 +310,16 @@ export class Client extends AbstractClient {
310
310
  /**
311
311
  * 用于撤销合同流程<br/>
312
312
  适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
313
+ - **可撤回合同状态**:未全部签署完成
314
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
313
315
 
314
316
  注:
315
- `如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,`签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
317
+ 1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
318
+
319
+ 2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
320
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
321
+
322
+ 3. <font color='red'>撤销合同会返还合同额度</font>
316
323
  */
317
324
  async CancelFlow(
318
325
  req: CancelFlowRequest,
@@ -484,9 +491,20 @@ export class Client extends AbstractClient {
484
491
  }
485
492
 
486
493
  /**
487
- * 注:此接口将会废弃,请使用撤销单个签署流程(CancelFlow)接口。
488
- 指定需要批量撤回的签署流程Id,获取批量撤销链接。
489
- 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。
494
+ * 指定需要批量撤回的签署流程Id,以获取批量撤销链接。
495
+ 客户需指定要撤回的签署流程Id,最多可指定100个,超过100则不处理。
496
+ 接口调用成功后,将返回批量撤回合同的链接。通过点击链接,可跳转至电子签小程序完成批量撤回操作。
497
+
498
+ - **可撤回合同状态**:未全部签署完成
499
+ - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
500
+
501
+ 注:
502
+ 1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
503
+
504
+ 2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
505
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1f9f07fea6a70766cd286e0d58682ee2.png)
506
+
507
+ 3. <font color='red'>撤销合同会返还合同额度</font>
490
508
  */
491
509
  async CreateBatchCancelFlowUrl(
492
510
  req: CreateBatchCancelFlowUrlRequest,
@@ -1964,7 +1964,10 @@ export interface CreateSchemeUrlRequest {
1964
1964
  /**
1965
1965
  * 签署完成后是否自动回跳
1966
1966
  <ul><li>**false**:否, 签署完成不会自动跳转回来(默认)</li><li>**true**:是, 签署完成会自动跳转回来</li></ul>
1967
- 注: ` 该参数只针对"APP" 类型的签署链接有效`
1967
+
1968
+ 注:
1969
+ 1. 该参数<font color="red">只针对APP</font> 类型的签署链接有效
1970
+ 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
1968
1971
  */
1969
1972
  AutoJumpBack?: boolean
1970
1973
  /**
@@ -3639,20 +3642,24 @@ style String 为字体风格设置 风格支持: font : 目前支持 黑体、
3639
3642
  export interface FormField {
3640
3643
  /**
3641
3644
  * 控件填充vaule,ComponentType和传入值类型对应关系:
3642
- TEXT - 文本内容
3643
- MULTI_LINE_TEXT - 文本内容
3644
- CHECK_BOX - true/false
3645
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
3646
- SELECTOR - 选项值
3647
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
3645
+ TEXT 文本内容
3646
+ MULTI_LINE_TEXT :文本内容
3647
+ CHECK_BOX true/false
3648
+ FILL_IMAGE、ATTACHMENT 附件的FileId,需要通过UploadFiles接口上传获取
3649
+ SELECTOR 选项值
3650
+ DYNAMIC_TABLE :传入json格式的表格内容,具体见数据结构[点击查看](https://qian.tencent.com/developers/company/dynamic_table)
3648
3651
  */
3649
3652
  ComponentValue: string
3650
3653
  /**
3651
3654
  * 控件id,和ComponentName选择一项传入即可
3655
+
3656
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件ID的方式</a>
3652
3657
  */
3653
3658
  ComponentId?: string
3654
3659
  /**
3655
3660
  * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
3661
+
3662
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件名字的方式</a>
3656
3663
  */
3657
3664
  ComponentName?: string
3658
3665
  }
@@ -6225,11 +6232,13 @@ export interface CancelFlowRequest {
6225
6232
  /**
6226
6233
  * 合同流程ID, 为32位字符串。
6227
6234
 
6228
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)
6235
+ 可登录腾讯电子签控制台,[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
6229
6236
  */
6230
6237
  FlowId: string
6231
6238
  /**
6232
- * 撤销此合同流程的原因,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
6239
+ * 撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
6240
+
6241
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
6233
6242
  */
6234
6243
  CancelMessage: string
6235
6244
  /**
@@ -7235,7 +7244,7 @@ export interface CreateBatchCancelFlowUrlRequest {
7235
7244
  Operator: UserInfo
7236
7245
  /**
7237
7246
  * 需要执行撤回的流程(合同)的编号列表,最多100个.
7238
- <br>列表中的流程(合同)编号不要重复.
7247
+ 列表中的流程(合同)编号不要重复.
7239
7248
  */
7240
7249
  FlowIds: Array<string>
7241
7250
  /**
@@ -574,7 +574,7 @@ export class Client extends AbstractClient {
574
574
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
575
575
 
576
576
  注:
577
- - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
577
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
578
578
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
579
579
  */
580
580
  async ChannelCancelFlow(
@@ -680,13 +680,15 @@ export class Client extends AbstractClient {
680
680
  </table>
681
681
 
682
682
  **注**:
683
- `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
683
+ 1. 发起合同时候, 作为<font color="red">发起方的第三方子企业A员工的企业和员工必须经过实名</font>, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名
684
684
 
685
- `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
685
+ 2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明
686
686
 
687
- `3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)`
687
+ 3. <font color="red">调用接口发起合同成功就会扣减合同的额度</font>, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度)
688
688
 
689
- `4. 静默(自动)签署不支持合同签署方存在填写功能`
689
+ 4. <font color="red">静默(自动)签署不支持合同签署方存在填写</font>
690
+
691
+ 5. <font color="red">在下一步创建签署链接前,建议等待DocumentFill </font> <a href="https://qian.tencent.com/developers/partner/callback_types_file_resources">PDF合成完成的回调</a>或者睡眠几秒,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
690
692
  */
691
693
  async CreateFlowsByTemplates(
692
694
  req: CreateFlowsByTemplatesRequest,
@@ -958,7 +960,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
958
960
  }
959
961
 
960
962
  /**
961
- * 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
963
+ * 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
962
964
 
963
965
  适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
964
966
 
@@ -1185,7 +1187,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1185
1187
  - **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
1186
1188
 
1187
1189
  注:
1188
- - 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
1190
+ - 有对应合同撤销权限的人: <font color='red'>**合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人**</font>
1189
1191
  - 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
1190
1192
  */
1191
1193
  async ChannelBatchCancelFlows(
@@ -1529,9 +1531,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1529
1531
  /**
1530
1532
  * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
1531
1533
 
1532
- - **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
1534
+ - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
1533
1535
 
1534
- - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
1536
+ - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
1535
1537
 
1536
1538
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
1537
1539
 
@@ -304,6 +304,10 @@ export interface Component {
304
304
  <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
305
305
  <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
306
306
 
307
+ <font color="red">签署印章旋转功能,当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>,可以通过以下参数设置签署图片的旋转角度:
308
+ <ul><li> <b>Rotate</b>:旋转角度,支持范围:-360:360,为正整数时,为顺时针旋转;为负整数时,为逆时针旋转。</li>
309
+ <li> <b>RotateRelation</b>:旋转关联控件,用于指定关联旋转的控件。例如:让印章控件和签署日期控件按照印章控件为中心旋转(此时,设置印章控件的RotateRelation为日期控件的ComponentId,设置日期签署控件的RotateRelation为印章控件的ComponentId)。</li></ul>
310
+ <b>参数样例</b>:`{"Rotate":-30,"RotateRelation":"Component_Id1"}`
307
311
 
308
312
  <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
309
313
  <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
@@ -1711,11 +1715,15 @@ export interface FormField {
1711
1715
  /**
1712
1716
  * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
1713
1717
  CreateFlowsByTemplates 接口不使用此字段。
1718
+
1719
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
1714
1720
  注意:此字段可能返回 null,表示取不到有效值。
1715
1721
  */
1716
1722
  ComponentId?: string
1717
1723
  /**
1718
1724
  * 控件的名字,跟ComponentId二选一,不能全为空
1725
+
1726
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
1719
1727
  注意:此字段可能返回 null,表示取不到有效值。
1720
1728
  */
1721
1729
  ComponentName?: string
@@ -40,6 +40,7 @@ import {
40
40
  DeviceLabel,
41
41
  DescribeProductTasksRequest,
42
42
  UpdateProductPrivateCAResponse,
43
+ UpdateOtaTaskStatusRequest,
43
44
  UpdateDeviceShadowRequest,
44
45
  DescribeGatewayBindDevicesResponse,
45
46
  ProductResourceInfo,
@@ -52,6 +53,7 @@ import {
52
53
  EnableTopicRuleResponse,
53
54
  DescribePushResourceTaskStatisticsResponse,
54
55
  UpdateDeviceLogLevelRequest,
56
+ UpdateOtaTaskStatusResponse,
55
57
  PublishRRPCMessageRequest,
56
58
  ProductProperties,
57
59
  DeviceUpdateStatus,
@@ -528,6 +530,16 @@ export class Client extends AbstractClient {
528
530
  return this.request("UpdateDevicesEnableState", req, cb)
529
531
  }
530
532
 
533
+ /**
534
+ * 本接口(UpdateOtaTask)当固件升级大任务处于没有在全部成功的状态时,可修改为取消状态,取消部分或全部设备的升级;或其它允许的可修改的状态
535
+ */
536
+ async UpdateOtaTaskStatus(
537
+ req: UpdateOtaTaskStatusRequest,
538
+ cb?: (error: string, rep: UpdateOtaTaskStatusResponse) => void
539
+ ): Promise<UpdateOtaTaskStatusResponse> {
540
+ return this.request("UpdateOtaTaskStatus", req, cb)
541
+ }
542
+
531
543
  /**
532
544
  * 本接口(ListFirmwares)用于获取固件列表
533
545
  */
@@ -452,6 +452,24 @@ export interface UpdateProductPrivateCAResponse {
452
452
  RequestId?: string
453
453
  }
454
454
 
455
+ /**
456
+ * UpdateOtaTaskStatus请求参数结构体
457
+ */
458
+ export interface UpdateOtaTaskStatusRequest {
459
+ /**
460
+ * 产品ID
461
+ */
462
+ ProductId: string
463
+ /**
464
+ * 固件升级任务ID
465
+ */
466
+ TaskId: number
467
+ /**
468
+ * 固件任务取消状态
469
+ */
470
+ Status: number
471
+ }
472
+
455
473
  /**
456
474
  * UpdateDeviceShadow请求参数结构体
457
475
  */
@@ -676,6 +694,16 @@ export interface UpdateDeviceLogLevelRequest {
676
694
  LogLevel: number
677
695
  }
678
696
 
697
+ /**
698
+ * UpdateOtaTaskStatus返回参数结构体
699
+ */
700
+ export interface UpdateOtaTaskStatusResponse {
701
+ /**
702
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
703
+ */
704
+ RequestId?: string
705
+ }
706
+
679
707
  /**
680
708
  * PublishRRPCMessage请求参数结构体
681
709
  */
@@ -857,7 +885,7 @@ export interface BatchUpdateFirmwareResponse {
857
885
  /**
858
886
  * 任务ID
859
887
  */
860
- TaskId: number
888
+ TaskId?: number
861
889
  /**
862
890
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
863
891
  */
@@ -960,6 +988,10 @@ export interface EditFirmwareRequest {
960
988
  * 固件描述
961
989
  */
962
990
  FirmwareDescription?: string
991
+ /**
992
+ * 固件用户自定义配置信息
993
+ */
994
+ FirmwareUserDefined?: string
963
995
  }
964
996
 
965
997
  /**
@@ -1099,11 +1131,11 @@ export interface ListFirmwaresResponse {
1099
1131
  /**
1100
1132
  * 固件总数
1101
1133
  */
1102
- TotalCount: number
1134
+ TotalCount?: number
1103
1135
  /**
1104
1136
  * 固件列表
1105
1137
  */
1106
- Firmwares: Array<FirmwareInfo>
1138
+ Firmwares?: Array<FirmwareInfo>
1107
1139
  /**
1108
1140
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1109
1141
  */
@@ -2919,6 +2951,10 @@ export interface BatchUpdateFirmwareRequest {
2919
2951
  * 固件升级任务,默认超时时间。 最小取值60秒,最大为3600秒
2920
2952
  */
2921
2953
  TimeoutInterval?: number
2954
+ /**
2955
+ * 固件升级任务类型,默认静态升级值为空或1,动态升级值为7。
2956
+ */
2957
+ Type?: number
2922
2958
  }
2923
2959
 
2924
2960
  /**
@@ -3245,6 +3281,10 @@ export interface UploadFirmwareRequest {
3245
3281
  * 固件描述
3246
3282
  */
3247
3283
  FirmwareDescription?: string
3284
+ /**
3285
+ * 固件用户自定义配置信息
3286
+ */
3287
+ FirmwareUserDefined?: string
3248
3288
  }
3249
3289
 
3250
3290
  /**
@@ -336,6 +336,10 @@ export interface DescribeDevicePackagesRequest {
336
336
  * 分页拉取偏移
337
337
  */
338
338
  Offset: number
339
+ /**
340
+ * 通道id
341
+ */
342
+ ChannelId?: number
339
343
  }
340
344
 
341
345
  /**
@@ -1065,6 +1069,10 @@ export interface PackageInfo {
1065
1069
  注意:此字段可能返回 null,表示取不到有效值。
1066
1070
  */
1067
1071
  OrderId?: string
1072
+ /**
1073
+ * 通道id
1074
+ */
1075
+ ChannelId?: number
1068
1076
  }
1069
1077
 
1070
1078
  /**
@@ -826,6 +826,10 @@ export interface DescribeRoomRequest {
826
826
  * 房间Id。
827
827
  */
828
828
  RoomId: number
829
+ /**
830
+ * 请求RTMP推流链接,0:否,1:是,默认为0。
831
+ */
832
+ RTMPStreamingURL?: number
829
833
  }
830
834
 
831
835
  /**
@@ -2137,6 +2141,10 @@ video 纯视频
2137
2141
  * 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
2138
2142
  */
2139
2143
  RecordBackground?: string
2144
+ /**
2145
+ * RTMP推流链接
2146
+ */
2147
+ RTMPStreamingURL?: string
2140
2148
  /**
2141
2149
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2142
2150
  */
@@ -392,13 +392,13 @@ export interface SrcAddressInfo {
392
392
  */
393
393
  export interface NetDetails {
394
394
  /**
395
- * 流量值(bit
395
+ * 流量值(byte
396
396
  */
397
- Current: number
397
+ Current?: number
398
398
  /**
399
399
  * 时间点,单位:s
400
400
  */
401
- Time: string
401
+ Time?: string
402
402
  }
403
403
 
404
404
  /**
@@ -85,7 +85,6 @@ import {
85
85
  DescribeDataCustomUrlResponse,
86
86
  RumAreaInfo,
87
87
  DescribeDataSetUrlStatisticsRequest,
88
- DescribeDataPerformanceProjectResponse,
89
88
  ResumeInstanceResponse,
90
89
  DescribeDataStaticProjectResponse,
91
90
  CreateStarProjectRequest,
@@ -123,7 +122,6 @@ import {
123
122
  DescribeProjectsResponse,
124
123
  ModifyProjectResponse,
125
124
  DescribeDataReportCountResponse,
126
- DescribeDataPerformanceProjectRequest,
127
125
  DescribeRumLogExportResponse,
128
126
  DescribeRumLogExportsRequest,
129
127
  ModifyProjectRequest,
@@ -290,16 +288,6 @@ export class Client extends AbstractClient {
290
288
  return this.request("ResumeInstance", req, cb)
291
289
  }
292
290
 
293
- /**
294
- * 获取PerformanceProject信息
295
- */
296
- async DescribeDataPerformanceProject(
297
- req: DescribeDataPerformanceProjectRequest,
298
- cb?: (error: string, rep: DescribeDataPerformanceProjectResponse) => void
299
- ): Promise<DescribeDataPerformanceProjectResponse> {
300
- return this.request("DescribeDataPerformanceProject", req, cb)
301
- }
302
-
303
291
  /**
304
292
  * 获取首页错误信息
305
293
  */
@@ -1373,7 +1373,8 @@ export interface DescribeDataPvUrlStatisticsRequest {
1373
1373
  */
1374
1374
  GroupByType?: number
1375
1375
  /**
1376
- * 无需关注,是否查询zhiyan
1376
+ * 1: 查询智研
1377
+ 0: 走旧逻辑,已下线,勿使用
1377
1378
  */
1378
1379
  IsNewData?: number
1379
1380
  }
@@ -1846,20 +1847,6 @@ export interface DescribeDataSetUrlStatisticsRequest {
1846
1847
  PackageType?: string
1847
1848
  }
1848
1849
 
1849
- /**
1850
- * DescribeDataPerformanceProject返回参数结构体
1851
- */
1852
- export interface DescribeDataPerformanceProjectResponse {
1853
- /**
1854
- * 返回值
1855
- */
1856
- Result: string
1857
- /**
1858
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1859
- */
1860
- RequestId?: string
1861
- }
1862
-
1863
1850
  /**
1864
1851
  * ResumeInstance返回参数结构体
1865
1852
  */
@@ -2904,100 +2891,6 @@ export interface DescribeDataReportCountResponse {
2904
2891
  RequestId?: string
2905
2892
  }
2906
2893
 
2907
- /**
2908
- * DescribeDataPerformanceProject请求参数结构体
2909
- */
2910
- export interface DescribeDataPerformanceProjectRequest {
2911
- /**
2912
- * 开始时间
2913
- */
2914
- StartTime: number
2915
- /**
2916
- * allcount:性能视图,falls:页面加载瀑布图,samp:首屏时间,day:14天数据,nettype:网络/平台视图,performance:页面性能TOP视图,condition:条件列表,area:请求速度分布,version/platform/isp/region/device/browser/ext1/ext2/ext3/ret/status/from/url/env/:ISP视图/地区视图/浏览器视图等
2917
- */
2918
- Type: string
2919
- /**
2920
- * 结束时间
2921
- */
2922
- EndTime: number
2923
- /**
2924
- * 项目ID
2925
- */
2926
- ID: number
2927
- /**
2928
- * 自定义2
2929
- */
2930
- ExtSecond?: string
2931
- /**
2932
- * 浏览器引擎
2933
- */
2934
- Engine?: string
2935
- /**
2936
- * 运营商
2937
- */
2938
- Isp?: string
2939
- /**
2940
- * 来源页面
2941
- */
2942
- From?: string
2943
- /**
2944
- * 日志等级
2945
- */
2946
- Level?: string
2947
- /**
2948
- * 品牌
2949
- */
2950
- Brand?: string
2951
- /**
2952
- * 地区
2953
- */
2954
- Area?: string
2955
- /**
2956
- * 版本
2957
- */
2958
- VersionNum?: string
2959
- /**
2960
- * 平台
2961
- */
2962
- Platform?: string
2963
- /**
2964
- * 自定义3
2965
- */
2966
- ExtThird?: string
2967
- /**
2968
- * 自定义1
2969
- */
2970
- ExtFirst?: string
2971
- /**
2972
- * 网络类型
2973
- */
2974
- NetType?: string
2975
- /**
2976
- * 机型
2977
- */
2978
- Device?: string
2979
- /**
2980
- * 是否海外
2981
- */
2982
- IsAbroad?: string
2983
- /**
2984
- * 操作系统
2985
- */
2986
- Os?: string
2987
- /**
2988
- * 浏览器
2989
- */
2990
- Browser?: string
2991
- /**
2992
- * 耗时计算
2993
- */
2994
- CostType?: string
2995
- /**
2996
- * 环境
2997
- */
2998
- Env?: string
2999
- }
3000
-
3001
2894
  /**
3002
2895
  * DescribeRumLogExport返回参数结构体
3003
2896
  */
@@ -425,8 +425,7 @@ export interface Certificates {
425
425
  From?: string
426
426
  /**
427
427
  * 证书套餐类型:
428
- null = 用户上传证书(没有套餐类型),
429
- 1 = GeoTrust DV SSL CA - G3, 2 = TrustAsia TLS RSA CA, 3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书。
428
+ 2 = TrustAsia TLS RSA CA,3 = SecureSite 增强型企业版(EV Pro), 4 = SecureSite 增强型(EV), 5 = SecureSite 企业型专业版(OV Pro), 6 = SecureSite 企业型(OV), 7 = SecureSite 企业型(OV)通配符, 8 = Geotrust 增强型(EV), 9 = Geotrust 企业型(OV), 10 = Geotrust 企业型(OV)通配符, 11 = TrustAsia 域名型多域名 SSL 证书, 12 = TrustAsia 域名型(DV)通配符, 13 = TrustAsia 企业型通配符(OV)SSL 证书(D3), 14 = TrustAsia 企业型(OV)SSL 证书(D3), 15 = TrustAsia 企业型多域名 (OV)SSL 证书(D3), 16 = TrustAsia 增强型 (EV)SSL 证书(D3), 17 = TrustAsia 增强型多域名(EV)SSL 证书(D3), 18 = GlobalSign 企业型(OV)SSL 证书, 19 = GlobalSign 企业型通配符 (OV)SSL 证书, 20 = GlobalSign 增强型 (EV)SSL 证书, 21 = TrustAsia 企业型通配符多域名(OV)SSL 证书(D3), 22 = GlobalSign 企业型多域名(OV)SSL 证书, 23 = GlobalSign 企业型通配符多域名(OV)SSL 证书, 24 = GlobalSign 增强型多域名(EV)SSL 证书,25 = Wotrus 域名型证书,26 = Wotrus 域名型多域名证书,27 = Wotrus 域名型通配符证书,28 = Wotrus 企业型证书,29 = Wotrus 企业型多域名证书,30 = Wotrus 企业型通配符证书,31 = Wotrus 增强型证书,32 = Wotrus 增强型多域名证书,33 = Wotrus 国密域名型证书,34 = Wotrus 国密域名型多域名证书,35 = Wotrus 国密域名型通配符证书,37 = Wotrus 国密企业型证书,38 = Wotrus 国密企业型多域名证书,39 = Wotrus 国密企业型通配符证书,40 = Wotrus 国密增强型证书,41 = Wotrus 国密增强型多域名证书,42 = TrustAsia 域名型通配符多域名证书,43 = DNSPod-企业型(OV)SSL证书,44 = DNSPod-企业型(OV)通配符SSL证书,45 = DNSPod-企业型(OV)多域名SSL证书, 46 = DNSPod-增强型(EV)SSL证书,47 = DNSPod-增强型(EV)多域名SSL证书,48 = DNSPod-域名型(DV)SSL证书,49 = DNSPod-域名型(DV)通配符SSL证书,50 = DNSPod-域名型(DV)多域名SSL证书,51 = DNSPod(国密)-企业型(OV)SSL证书,52 = DNSPod(国密)-企业型(OV)通配符SSL证书,53 = DNSPod(国密)-企业型(OV)多域名SSL证书,54 = DNSPod(国密)-域名型(DV)SSL证书,55 = DNSPod(国密)-域名型(DV)通配符SSL证书, 56 = DNSPod(国密)-域名型(DV)多域名SSL证书,57 = SecureSite 企业型专业版多域名(OV Pro),58 = SecureSite 企业型多域名(OV),59 = SecureSite 增强型专业版多域名(EV Pro),60 = SecureSite 增强型多域名(EV),61 = Geotrust 增强型多域名(EV)
430
429
  注意:此字段可能返回 null,表示取不到有效值。
431
430
  */
432
431
  PackageType?: string
@@ -2845,7 +2844,7 @@ export interface DescribeCertificatesRequest {
2845
2844
  */
2846
2845
  Offset?: number
2847
2846
  /**
2848
- * 每页数量,默认20。最大1000
2847
+ * 每页数量,默认10。最大1000
2849
2848
  */
2850
2849
  Limit?: number
2851
2850
  /**