tencentcloud-sdk-nodejs 4.0.722 → 4.0.724

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 (69) hide show
  1. package/CHANGELOG.md +270 -0
  2. package/SERVICE_CHANGELOG.md +296 -49
  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/aiart/v20221229/aiart_models.ts +9 -5
  7. package/src/services/car/v20220110/car_client.ts +1 -1
  8. package/src/services/ccc/v20200210/ccc_models.ts +6 -2
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +1 -1
  10. package/src/services/clb/v20180317/clb_models.ts +4 -6
  11. package/src/services/cls/v20201016/cls_client.ts +15 -3
  12. package/src/services/cls/v20201016/cls_models.ts +54 -18
  13. package/src/services/ess/v20201111/ess_client.ts +23 -6
  14. package/src/services/ess/v20201111/ess_models.ts +345 -208
  15. package/src/services/essbasic/v20210526/essbasic_client.ts +45 -18
  16. package/src/services/essbasic/v20210526/essbasic_models.ts +140 -73
  17. package/src/services/lighthouse/v20200324/lighthouse_client.ts +29 -2
  18. package/src/services/lighthouse/v20200324/lighthouse_models.ts +98 -50
  19. package/src/services/mna/v20210119/mna_client.ts +15 -1
  20. package/src/services/mna/v20210119/mna_models.ts +90 -12
  21. package/src/services/ocr/v20181119/ocr_models.ts +43 -25
  22. package/src/services/ses/v20201002/ses_models.ts +5 -1
  23. package/src/services/tdmq/v20200217/tdmq_models.ts +41 -4
  24. package/src/services/teo/v20220901/teo_client.ts +46 -21
  25. package/src/services/teo/v20220901/teo_models.ts +91 -23
  26. package/src/services/tione/v20211111/tione_models.ts +1 -1
  27. package/src/services/waf/v20180125/waf_client.ts +20 -7
  28. package/src/services/waf/v20180125/waf_models.ts +118 -1
  29. package/src/services/wedata/v20210820/wedata_models.ts +14 -2
  30. package/tencentcloud/common/sdk_version.d.ts +1 -1
  31. package/tencentcloud/common/sdk_version.js +1 -1
  32. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +9 -5
  33. package/tencentcloud/services/car/v20220110/car_client.d.ts +1 -1
  34. package/tencentcloud/services/car/v20220110/car_client.js +1 -1
  35. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +6 -2
  36. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +1 -1
  37. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -6
  38. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +5 -1
  39. package/tencentcloud/services/cls/v20201016/cls_client.js +6 -0
  40. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +52 -18
  41. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +12 -4
  42. package/tencentcloud/services/ess/v20201111/ess_client.js +13 -3
  43. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +341 -207
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +43 -16
  45. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +43 -16
  46. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +140 -73
  47. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +12 -1
  48. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +15 -0
  49. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +94 -50
  50. package/tencentcloud/services/mna/v20210119/mna_client.d.ts +5 -1
  51. package/tencentcloud/services/mna/v20210119/mna_client.js +6 -0
  52. package/tencentcloud/services/mna/v20210119/mna_models.d.ts +86 -12
  53. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +43 -25
  54. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +6 -1
  55. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +41 -4
  56. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +16 -8
  57. package/tencentcloud/services/teo/v20220901/teo_client.js +22 -10
  58. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +86 -23
  59. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +1 -1
  60. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +8 -4
  61. package/tencentcloud/services/waf/v20180125/waf_client.js +9 -3
  62. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +115 -1
  63. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14 -2
  64. package/test/cls.v20201016.test.js +10 -0
  65. package/test/ess.v20201111.test.js +10 -0
  66. package/test/lighthouse.v20200324.test.js +20 -0
  67. package/test/mna.v20210119.test.js +10 -0
  68. package/test/teo.v20220901.test.js +26 -6
  69. package/test/waf.v20180125.test.js +12 -2
@@ -352,6 +352,8 @@ export interface ChannelDeleteSealPoliciesRequest {
352
352
  export interface ChannelBatchCancelFlowsResponse {
353
353
  /**
354
354
  * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
355
+
356
+ 注: `如果全部撤销成功, 此数组为空数组`
355
357
  */
356
358
  FailMessages?: Array<string>;
357
359
  /**
@@ -835,7 +837,7 @@ export interface ChannelCreateRoleRequest {
835
837
  */
836
838
  Description?: string;
837
839
  /**
838
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
840
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
839
841
  */
840
842
  PermissionGroups?: Array<PermissionGroup>;
841
843
  }
@@ -933,7 +935,7 @@ export interface ReleasedApprover {
933
935
  * 签署方经办人的证件类型,支持以下类型
934
936
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
935
937
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
936
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
938
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
937
939
  */
938
940
  IdCardType?: string;
939
941
  /**
@@ -1053,12 +1055,19 @@ export interface ChannelCreateUserRolesResponse {
1053
1055
  */
1054
1056
  export interface SyncProxyOrganizationRequest {
1055
1057
  /**
1056
- * 应用信息
1057
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1058
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1059
+
1060
+ 此接口下面信息必填。
1061
+ <ul>
1062
+ <li>渠道应用标识: Agent.AppId</li>
1063
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1064
+ </ul>
1065
+
1058
1066
  */
1059
1067
  Agent: Agent;
1060
1068
  /**
1061
- * 第三方平台子客企业名称,最大长度64个字符
1069
+ * 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
1070
+ 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
1062
1071
  */
1063
1072
  ProxyOrganizationName: string;
1064
1073
  /**
@@ -1070,7 +1079,7 @@ export interface SyncProxyOrganizationRequest {
1070
1079
  */
1071
1080
  UniformSocialCreditCode?: string;
1072
1081
  /**
1073
- * 第三方平台子客企业法人/负责人姓名
1082
+ * 第三方平台子客企业法定代表人的名字
1074
1083
  */
1075
1084
  ProxyLegalName?: string;
1076
1085
  /**
@@ -1079,13 +1088,22 @@ export interface SyncProxyOrganizationRequest {
1079
1088
  */
1080
1089
  Operator?: UserInfo;
1081
1090
  /**
1082
- * 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
1091
+ * 第三方平台子客企业法定代表人的证件类型,支持以下类型
1092
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
1093
+ 注: `现在仅支持ID_CARD居民身份证类型`
1083
1094
  */
1084
1095
  ProxyLegalIdCardType?: string;
1085
1096
  /**
1086
- * 第三方平台子客企业法人/负责人证件号
1097
+ * 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
1098
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1087
1099
  */
1088
1100
  ProxyLegalIdCardNumber?: string;
1101
+ /**
1102
+ * 第三方平台子客企业详细住所,最大长度500个字符
1103
+
1104
+ 注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
1105
+ */
1106
+ ProxyAddress?: string;
1089
1107
  }
1090
1108
  /**
1091
1109
  * ChannelCreatePrepareFlow请求参数结构体
@@ -1192,27 +1210,34 @@ export interface DownloadFlowInfo {
1192
1210
  FlowIdList: Array<string>;
1193
1211
  }
1194
1212
  /**
1195
- * 签署人签署链接信息
1213
+ * 签署人签署链接信息。
1196
1214
  */
1197
1215
  export interface FlowApproverUrlInfo {
1198
1216
  /**
1199
- * 签署短链接,不支持小程序嵌入,只支持移动端浏览器打开。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1217
+ * 签署短链接。</br>
1218
+ 注意:
1219
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1220
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1200
1221
  */
1201
- SignUrl: string;
1222
+ SignUrl?: string;
1202
1223
  /**
1203
- * 签署人类型 PERSON-个人
1224
+ * 签署人类型。
1225
+ - **PERSON**: 个人
1204
1226
  */
1205
- ApproverType: string;
1227
+ ApproverType?: string;
1206
1228
  /**
1207
- * 签署人姓名
1229
+ * 签署人姓名。
1208
1230
  */
1209
- Name: string;
1231
+ Name?: string;
1210
1232
  /**
1211
- * 签署人手机号
1233
+ * 签署人手机号。
1212
1234
  */
1213
- Mobile: string;
1235
+ Mobile?: string;
1214
1236
  /**
1215
- * 签署长链接,支持小程序嵌入。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1237
+ * 签署长链接。</br>
1238
+ 注意:
1239
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1240
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1216
1241
  注意:此字段可能返回 null,表示取不到有效值。
1217
1242
  */
1218
1243
  LongUrl?: string;
@@ -2062,12 +2087,18 @@ export interface StaffRole {
2062
2087
  export interface ChannelVerifyPdfRequest {
2063
2088
  /**
2064
2089
  * 合同流程ID,为32位字符串。
2065
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2066
2090
  */
2067
2091
  FlowId: string;
2068
2092
  /**
2069
- * 代理企业和员工的信息。
2070
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2093
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2094
+
2095
+ 此接口下面信息必填。
2096
+ <ul>
2097
+ <li>渠道应用标识: Agent.AppId</li>
2098
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2099
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2100
+ </ul>
2101
+ 第三方平台子客企业和员工必须已经经过实名认证
2071
2102
  */
2072
2103
  Agent?: Agent;
2073
2104
  /**
@@ -2081,14 +2112,15 @@ export interface ChannelVerifyPdfRequest {
2081
2112
  */
2082
2113
  export interface CreateChannelFlowEvidenceReportRequest {
2083
2114
  /**
2084
- * 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2115
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2085
2116
 
2086
2117
  此接口下面信息必填。
2087
2118
  <ul>
2088
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2089
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2090
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2119
+ <li>渠道应用标识: Agent.AppId</li>
2120
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2121
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2091
2122
  </ul>
2123
+ 第三方平台子客企业和员工必须已经经过实名认证
2092
2124
  */
2093
2125
  Agent: Agent;
2094
2126
  /**
@@ -2274,17 +2306,12 @@ export interface ChannelVerifyPdfResponse {
2274
2306
  <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
2275
2307
  <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
2276
2308
  <li>**3**:文件被篡改。</li>
2277
- <li>**4**:异常:文件内没有签名域。</li>
2309
+ <li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
2278
2310
  <li>**5**:异常:文件签名格式错误。</li></ul>
2279
2311
  */
2280
2312
  VerifyResult?: number;
2281
2313
  /**
2282
- * 验签结果详情,每个签名域对应的验签结果。状态值如下
2283
- <ul><li> **1** :验签成功,在电子签签署</li>
2284
- <li> **2** :验签成功,在其他平台签署</li>
2285
- <li> **3** :验签失败</li>
2286
- <li> **4** :pdf文件没有签名域</li>
2287
- <li> **5** :文件签名格式错误</li></ul>
2314
+ * 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
2288
2315
  */
2289
2316
  PdfVerifyResults?: Array<PdfVerifyResult>;
2290
2317
  /**
@@ -2640,65 +2667,82 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
2640
2667
  ExpiredTime?: number;
2641
2668
  }
2642
2669
  /**
2643
- * 合同文件验签单个结果结构体
2670
+ * 合同验签每个签署区的信息
2644
2671
  */
2645
2672
  export interface PdfVerifyResult {
2646
2673
  /**
2647
- * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
2674
+ * 验签结果详情,每个签名域对应的验签结果。状态值如下
2675
+ <ul><li> **1** :验签成功,在电子签签署</li>
2676
+ <li> **2** :验签成功,在其他平台签署</li>
2677
+ <li> **3** :验签失败</li>
2678
+ <li> **4** :pdf文件没有签名域</li>
2679
+ <li> **5** :文件签名格式错误</li></ul>
2648
2680
  */
2649
- VerifyResult: number;
2681
+ VerifyResult?: number;
2650
2682
  /**
2651
- * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
2683
+ * 签署平台
2684
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2685
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2652
2686
  */
2653
- SignPlatform: string;
2687
+ SignPlatform?: string;
2654
2688
  /**
2655
- * 签署人名称
2689
+ * 申请证书的主体的名字
2690
+
2691
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2692
+ **企业**: ESS@企业名称@平台生成的数字编码
2693
+ **个人**: ESS@个人姓名@证件号@平台生成的数字编码
2694
+
2695
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2656
2696
  */
2657
- SignerName: string;
2697
+ SignerName?: string;
2658
2698
  /**
2659
- * 签署时间戳,单位秒
2699
+ * 签署时间的Unix时间戳,单位毫秒
2660
2700
  */
2661
- SignTime: number;
2701
+ SignTime?: number;
2662
2702
  /**
2663
- * 签名算法
2703
+ * 证书签名算法, 如SHA1withRSA等算法
2664
2704
  */
2665
- SignAlgorithm: string;
2705
+ SignAlgorithm?: string;
2666
2706
  /**
2667
- * 签名证书序列号
2707
+ * CA供应商下发给用户的证书编号
2708
+
2709
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
2668
2710
  */
2669
- CertSn: string;
2711
+ CertSn?: string;
2670
2712
  /**
2671
- * 证书起始时间戳,单位秒
2713
+ * 证书起始时间的Unix时间戳,单位毫秒
2672
2714
  */
2673
- CertNotBefore: number;
2715
+ CertNotBefore?: number;
2674
2716
  /**
2675
- * 证书过期时间戳,单位秒
2717
+ * 证书过期时间的时间戳,单位毫秒
2676
2718
  */
2677
- CertNotAfter: number;
2719
+ CertNotAfter?: number;
2678
2720
  /**
2679
- * 签名类型
2721
+ * 签名类型, 保留字段, 现在全部为0
2722
+
2723
+
2680
2724
  */
2681
- SignType: number;
2725
+ SignType?: number;
2682
2726
  /**
2683
2727
  * 签名域横坐标,单位px
2684
2728
  */
2685
- ComponentPosX: number;
2729
+ ComponentPosX?: number;
2686
2730
  /**
2687
2731
  * 签名域纵坐标,单位px
2688
2732
  */
2689
- ComponentPosY: number;
2733
+ ComponentPosY?: number;
2690
2734
  /**
2691
2735
  * 签名域宽度,单位px
2692
2736
  */
2693
- ComponentWidth: number;
2737
+ ComponentWidth?: number;
2694
2738
  /**
2695
2739
  * 签名域高度,单位px
2696
2740
  */
2697
- ComponentHeight: number;
2741
+ ComponentHeight?: number;
2698
2742
  /**
2699
2743
  * 签名域所在页码,1~N
2700
2744
  */
2701
- ComponentPage: number;
2745
+ ComponentPage?: number;
2702
2746
  }
2703
2747
  /**
2704
2748
  * 用户的三要素:姓名,证件号,证件类型
@@ -3527,14 +3571,16 @@ export interface ChannelDescribeEmployeesRequest {
3527
3571
  /**
3528
3572
  * 查询的关键字段,支持Key-Values查询。可选键值如下:
3529
3573
  <ul>
3530
- <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
3531
- <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
3532
- <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3574
+ <li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
3575
+ <li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
3576
+ <li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
3533
3577
  </ul>
3578
+ 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
3534
3579
  */
3535
3580
  Filters?: Array<Filter>;
3536
3581
  /**
3537
- * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。
3582
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。
3583
+ 页码从 0 开始,即首页为 0,最大20000。
3538
3584
  */
3539
3585
  Offset?: number;
3540
3586
  /**
@@ -4262,11 +4308,19 @@ export interface CreateFlowsByTemplatesResponse {
4262
4308
  */
4263
4309
  export interface DescribeChannelFlowEvidenceReportRequest {
4264
4310
  /**
4265
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4311
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4312
+
4313
+ 此接口下面信息必填。
4314
+ <ul>
4315
+ <li>渠道应用标识: Agent.AppId</li>
4316
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4317
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4318
+ </ul>
4319
+ 第三方平台子客企业和员工必须已经经过实名认证
4266
4320
  */
4267
4321
  Agent: Agent;
4268
4322
  /**
4269
- * 出证报告编号
4323
+ * 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
4270
4324
  */
4271
4325
  ReportId: string;
4272
4326
  /**
@@ -4891,7 +4945,7 @@ export interface ProxyOrganizationOperator {
4891
4945
  * 签署方经办人的证件类型,支持以下类型
4892
4946
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
4893
4947
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4894
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
4948
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
4895
4949
 
4896
4950
  */
4897
4951
  IdCardType?: string;
@@ -5271,7 +5325,7 @@ export interface ChannelModifyRoleRequest {
5271
5325
  */
5272
5326
  Description?: string;
5273
5327
  /**
5274
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
5328
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
5275
5329
  */
5276
5330
  PermissionGroups?: Array<PermissionGroup>;
5277
5331
  }
@@ -5936,16 +5990,16 @@ export interface ChannelCreateReleaseFlowResponse {
5936
5990
  */
5937
5991
  export interface DescribeChannelFlowEvidenceReportResponse {
5938
5992
  /**
5939
- * 出证报告下载 URL
5993
+ * 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
5940
5994
  注意:此字段可能返回 null,表示取不到有效值。
5941
5995
  */
5942
5996
  ReportUrl?: string;
5943
5997
  /**
5944
- * 出征任务的执行状态,状态列表如下
5998
+ * 出证任务执行的状态, 状态含义如下:
5945
5999
 
5946
- - EvidenceStatusExecuting : 出征任务正在执行中
5947
- - EvidenceStatusSuccess : 出征任务执行成功
5948
- - EvidenceStatusFailed : 出征任务执行失败
6000
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
6001
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
6002
+ <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
5949
6003
  */
5950
6004
  Status?: string;
5951
6005
  /**
@@ -6072,15 +6126,28 @@ export interface ChannelUpdateSealStatusResponse {
6072
6126
  */
6073
6127
  export interface ChannelCreateFlowSignUrlRequest {
6074
6128
  /**
6075
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
6129
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6130
+
6131
+ 此接口下面信息必填。
6132
+ <ul>
6133
+ <li>渠道应用标识: Agent.AppId</li>
6134
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6135
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6136
+ </ul>
6137
+ 第三方平台子客企业和员工必须已经经过实名认证
6076
6138
  */
6077
6139
  Agent: Agent;
6078
6140
  /**
6079
- * 流程编号
6141
+ * 合同流程ID,为32位字符串。
6142
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
6143
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6080
6144
  */
6081
6145
  FlowId: string;
6082
6146
  /**
6083
- * 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
6147
+ * 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
6148
+ 注:
6149
+ `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
6150
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
6084
6151
  */
6085
6152
  FlowApproverInfos: Array<FlowApproverInfo>;
6086
6153
  /**
@@ -6094,7 +6161,7 @@ export interface ChannelCreateFlowSignUrlRequest {
6094
6161
  */
6095
6162
  Organization?: OrganizationInfo;
6096
6163
  /**
6097
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
6164
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
6098
6165
  */
6099
6166
  JumpUrl?: string;
6100
6167
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { RunDockerContainersRequest, DescribeDockerContainersRequest, AssociateInstancesKeyPairsResponse, DescribeInstancesTrafficPackagesRequest, DescribeDisksDeniedActionsRequest, InquirePriceCreateBlueprintRequest, DescribeDiskBackupsRequest, DescribeInstancesDeniedActionsRequest, DeleteKeyPairsResponse, DescribeFirewallTemplateRulesRequest, AttachCcnRequest, CreateInstancesRequest, DescribeZonesRequest, RebootInstancesResponse, DescribeBlueprintInstancesResponse, InquirePriceCreateDisksRequest, DetachCcnResponse, DescribeScenesResponse, InquirePriceRenewInstancesResponse, DeleteFirewallRulesResponse, ModifyInstancesAttributeRequest, DescribeDockerContainerDetailRequest, DescribeGeneralResourceQuotasRequest, RestartDockerContainersRequest, DeleteKeyPairsRequest, RerunDockerContainerResponse, DescribeBundlesResponse, DeleteFirewallTemplateRulesResponse, DescribeFirewallTemplatesRequest, ModifyInstancesBundleRequest, DeleteDiskBackupsRequest, InquirePriceRenewInstancesRequest, DescribeDiskConfigsRequest, DescribeFirewallTemplateQuotaResponse, DescribeRegionsResponse, DescribeFirewallTemplateApplyRecordsRequest, DescribeDiskBackupsResponse, AttachDisksRequest, ModifyDiskBackupsAttributeRequest, AttachCcnResponse, RebootInstancesRequest, ResetAttachCcnRequest, CreateDisksRequest, AssociateInstancesKeyPairsRequest, ImportKeyPairResponse, DescribeSnapshotsRequest, TerminateDisksResponse, DescribeInstancesTrafficPackagesResponse, DescribeDiskBackupsDeniedActionsRequest, DescribeFirewallRulesTemplateRequest, DescribeDockerContainerConfigurationRequest, ModifyBlueprintAttributeRequest, InquirePriceRenewDisksRequest, ModifyFirewallRulesResponse, DescribeBlueprintInstancesRequest, ApplyInstanceSnapshotResponse, DetachDisksRequest, ModifyFirewallRulesRequest, CreateBlueprintRequest, DeleteFirewallRulesRequest, RerunDockerContainerRequest, DescribeInstanceVncUrlRequest, ModifyFirewallRuleDescriptionRequest, TerminateInstancesResponse, DescribeInstancesDiskNumRequest, StopDockerContainersResponse, ApplyDiskBackupResponse, DescribeBlueprintsRequest, DescribeInstancesDeniedActionsResponse, RestartDockerContainersResponse, CreateFirewallTemplateRequest, RemoveDockerContainersRequest, RenewDisksRequest, ModifyDisksAttributeRequest, DescribeKeyPairsResponse, DescribeSnapshotsDeniedActionsResponse, DescribeScenesRequest, DeleteDiskBackupsResponse, DeleteSnapshotsRequest, ModifyDisksRenewFlagResponse, ModifySnapshotAttributeRequest, DeleteSnapshotsResponse, ReplaceFirewallTemplateRuleResponse, DescribeDisksResponse, StartInstancesRequest, DescribeBundleDiscountResponse, DescribeAllScenesRequest, ModifyDisksRenewFlagRequest, StartDockerContainersResponse, DisassociateInstancesKeyPairsRequest, DescribeFirewallTemplateQuotaRequest, ImportKeyPairRequest, DescribeDockerActivitiesRequest, DeleteBlueprintsResponse, ModifyInstancesLoginKeyPairAttributeRequest, IsolateInstancesRequest, DeleteFirewallTemplateResponse, CreateInstancesResponse, ModifyBlueprintAttributeResponse, ModifyFirewallTemplateRequest, StopDockerContainersRequest, DescribeModifyInstanceBundlesRequest, DescribeRegionsRequest, DescribeInstancesDiskNumResponse, InquirePriceCreateBlueprintResponse, ResetFirewallTemplateRulesRequest, ModifyFirewallTemplateResponse, DescribeInstancesReturnableRequest, DescribeBlueprintsResponse, DescribeKeyPairsRequest, DescribeCcnAttachedInstancesRequest, ApplyDiskBackupRequest, ResetInstancesPasswordResponse, StartInstancesResponse, DescribeDockerContainerConfigurationResponse, StopInstancesRequest, IsolateInstancesResponse, CreateKeyPairResponse, DescribeInstanceVncUrlResponse, DescribeDockerActivitiesResponse, DescribeFirewallTemplateRuleQuotaRequest, CreateFirewallTemplateResponse, DescribeCcnAttachedInstancesResponse, DescribeBundlesRequest, InquirePriceCreateInstancesResponse, DescribeAllScenesResponse, ModifyInstancesLoginKeyPairAttributeResponse, InquirePriceRenewDisksResponse, CreateDiskBackupResponse, DescribeSnapshotsDeniedActionsRequest, DescribeDiskDiscountResponse, CreateFirewallTemplateRulesResponse, ModifyDockerContainerRequest, RunDockerContainersResponse, CreateKeyPairRequest, StopInstancesResponse, ResetInstancesPasswordRequest, DescribeInstancesRequest, DescribeFirewallTemplateRuleQuotaResponse, DetachCcnRequest, RenameDockerContainerResponse, DescribeFirewallTemplateApplyRecordsResponse, DescribeSnapshotsResponse, ApplyFirewallTemplateRequest, ModifyFirewallRuleDescriptionResponse, DescribeDiskDiscountRequest, CreateDisksResponse, AttachDisksResponse, CreateDiskBackupRequest, CreateFirewallRulesRequest, DescribeFirewallRulesResponse, DescribeInstancesReturnableResponse, DeleteBlueprintsRequest, CreateFirewallRulesResponse, DescribeDisksRequest, DescribeInstancesResponse, DescribeZonesResponse, CreateBlueprintResponse, DescribeFirewallTemplatesResponse, DetachDisksResponse, DescribeResetInstanceBlueprintsRequest, RemoveDockerContainersResponse, ResetAttachCcnResponse, ModifyInstancesRenewFlagResponse, ApplyInstanceSnapshotRequest, DisassociateInstancesKeyPairsResponse, TerminateInstancesRequest, ApplyFirewallTemplateResponse, TerminateDisksRequest, RenewDisksResponse, ResetInstanceRequest, DescribeDiskConfigsResponse, CreateFirewallTemplateRulesRequest, ReplaceFirewallTemplateRuleRequest, DescribeDockerContainersResponse, ModifyDockerContainerResponse, DescribeDiskBackupsDeniedActionsResponse, DescribeInstanceLoginKeyPairAttributeRequest, DescribeDockerContainerDetailResponse, DescribeBundleDiscountRequest, DescribeFirewallTemplateRulesResponse, DescribeDisksReturnableResponse, ModifyDiskBackupsAttributeResponse, DeleteFirewallTemplateRequest, IsolateDisksRequest, CreateInstanceSnapshotResponse, ModifyInstancesBundleResponse, DescribeResetInstanceBlueprintsResponse, DescribeDisksReturnableRequest, ResetFirewallTemplateRulesResponse, ModifySnapshotAttributeResponse, DescribeGeneralResourceQuotasResponse, ModifyInstancesRenewFlagRequest, StartDockerContainersRequest, RenewInstancesRequest, DescribeFirewallRulesTemplateResponse, RenewInstancesResponse, RenameDockerContainerRequest, DescribeDisksDeniedActionsResponse, ResetInstanceResponse, IsolateDisksResponse, DescribeFirewallRulesRequest, InquirePriceCreateInstancesRequest, DescribeModifyInstanceBundlesResponse, ModifyDisksAttributeResponse, CreateInstanceSnapshotRequest, InquirePriceCreateDisksResponse, ModifyInstancesAttributeResponse, DescribeInstanceLoginKeyPairAttributeResponse, DeleteFirewallTemplateRulesRequest } from "./lighthouse_models";
3
+ import { RunDockerContainersRequest, DescribeDockerContainersRequest, AssociateInstancesKeyPairsResponse, DescribeInstancesTrafficPackagesRequest, DescribeDisksDeniedActionsRequest, InquirePriceCreateBlueprintRequest, DescribeDiskBackupsRequest, DescribeInstancesDeniedActionsRequest, DeleteKeyPairsResponse, DescribeFirewallTemplateRulesRequest, AttachCcnRequest, CreateInstancesRequest, DescribeZonesRequest, RebootInstancesResponse, DescribeBlueprintInstancesResponse, InquirePriceCreateDisksRequest, DetachCcnResponse, ShareBlueprintAcrossAccountsRequest, DescribeScenesResponse, InquirePriceRenewInstancesResponse, DeleteFirewallRulesResponse, ModifyInstancesAttributeRequest, DescribeDockerContainerDetailRequest, DescribeGeneralResourceQuotasRequest, RestartDockerContainersRequest, DeleteKeyPairsRequest, RerunDockerContainerResponse, DescribeBundlesResponse, DeleteFirewallTemplateRulesResponse, DescribeFirewallTemplatesRequest, ModifyInstancesBundleRequest, DeleteDiskBackupsRequest, InquirePriceRenewInstancesRequest, DescribeDiskConfigsRequest, DescribeFirewallTemplateQuotaResponse, DescribeRegionsResponse, DescribeFirewallTemplateApplyRecordsRequest, DescribeDiskBackupsResponse, AttachDisksRequest, ModifyDiskBackupsAttributeRequest, AttachCcnResponse, RebootInstancesRequest, ResetAttachCcnRequest, CreateDisksRequest, AssociateInstancesKeyPairsRequest, CancelShareBlueprintAcrossAccountsResponse, DescribeSnapshotsRequest, TerminateDisksResponse, DescribeInstancesTrafficPackagesResponse, DescribeDiskBackupsDeniedActionsRequest, DescribeFirewallRulesTemplateRequest, DescribeDockerContainerConfigurationRequest, ModifyBlueprintAttributeRequest, InquirePriceRenewDisksRequest, ShareBlueprintAcrossAccountsResponse, ModifyFirewallRulesResponse, DescribeBlueprintInstancesRequest, ApplyInstanceSnapshotResponse, DetachDisksRequest, ModifyFirewallRulesRequest, CreateBlueprintRequest, DeleteFirewallRulesRequest, RerunDockerContainerRequest, DescribeInstanceVncUrlRequest, ModifyFirewallRuleDescriptionRequest, TerminateInstancesResponse, DescribeInstancesDiskNumRequest, StopDockerContainersResponse, ApplyDiskBackupResponse, DescribeBlueprintsRequest, DescribeInstancesDeniedActionsResponse, RestartDockerContainersResponse, CreateFirewallTemplateRequest, RemoveDockerContainersRequest, RenewDisksRequest, ModifyDisksAttributeRequest, DescribeKeyPairsResponse, DescribeSnapshotsDeniedActionsResponse, DescribeScenesRequest, DeleteDiskBackupsResponse, DeleteSnapshotsRequest, ModifyDisksRenewFlagResponse, ModifySnapshotAttributeRequest, DeleteSnapshotsResponse, ReplaceFirewallTemplateRuleResponse, DescribeDisksResponse, StartInstancesRequest, DescribeBundleDiscountResponse, DescribeAllScenesRequest, ModifyDisksRenewFlagRequest, StartDockerContainersResponse, DisassociateInstancesKeyPairsRequest, DescribeFirewallTemplateQuotaRequest, ImportKeyPairRequest, DescribeDockerActivitiesRequest, ImportKeyPairResponse, DeleteBlueprintsResponse, ModifyInstancesLoginKeyPairAttributeRequest, IsolateInstancesRequest, DeleteFirewallTemplateResponse, CreateInstancesResponse, ModifyBlueprintAttributeResponse, ModifyFirewallTemplateRequest, StopDockerContainersRequest, DescribeModifyInstanceBundlesRequest, DescribeRegionsRequest, DescribeInstancesDiskNumResponse, InquirePriceCreateBlueprintResponse, ResetFirewallTemplateRulesRequest, ModifyFirewallTemplateResponse, DescribeInstancesReturnableRequest, DescribeBlueprintsResponse, DescribeKeyPairsRequest, DescribeCcnAttachedInstancesRequest, ApplyDiskBackupRequest, ResetInstancesPasswordResponse, StartInstancesResponse, DescribeDockerContainerConfigurationResponse, StopInstancesRequest, IsolateInstancesResponse, CreateKeyPairResponse, DescribeInstanceVncUrlResponse, DescribeDockerActivitiesResponse, DescribeFirewallTemplateRuleQuotaRequest, CreateFirewallTemplateResponse, DescribeCcnAttachedInstancesResponse, DescribeBundlesRequest, InquirePriceCreateInstancesResponse, DescribeAllScenesResponse, ModifyInstancesLoginKeyPairAttributeResponse, InquirePriceRenewDisksResponse, CreateDiskBackupResponse, DescribeSnapshotsDeniedActionsRequest, DescribeDiskDiscountResponse, CreateFirewallTemplateRulesResponse, ModifyDockerContainerRequest, RunDockerContainersResponse, CreateKeyPairRequest, StopInstancesResponse, ResetInstancesPasswordRequest, DescribeInstancesRequest, DescribeFirewallTemplateRuleQuotaResponse, DetachCcnRequest, RenameDockerContainerResponse, DescribeFirewallTemplateApplyRecordsResponse, DescribeSnapshotsResponse, ApplyFirewallTemplateRequest, ModifyFirewallRuleDescriptionResponse, DescribeDiskDiscountRequest, CreateDisksResponse, AttachDisksResponse, CreateDiskBackupRequest, CreateFirewallRulesRequest, DescribeFirewallRulesResponse, DescribeInstancesReturnableResponse, DeleteBlueprintsRequest, CreateFirewallRulesResponse, DescribeDisksRequest, DescribeInstancesResponse, DescribeZonesResponse, CreateBlueprintResponse, DescribeFirewallTemplatesResponse, DetachDisksResponse, DescribeResetInstanceBlueprintsRequest, RemoveDockerContainersResponse, ResetAttachCcnResponse, ModifyInstancesRenewFlagResponse, ApplyInstanceSnapshotRequest, DisassociateInstancesKeyPairsResponse, TerminateInstancesRequest, ApplyFirewallTemplateResponse, TerminateDisksRequest, RenewDisksResponse, ResetInstanceRequest, DescribeDiskConfigsResponse, CreateFirewallTemplateRulesRequest, ReplaceFirewallTemplateRuleRequest, DescribeDockerContainersResponse, ModifyDockerContainerResponse, DescribeDiskBackupsDeniedActionsResponse, DescribeInstanceLoginKeyPairAttributeRequest, DescribeDockerContainerDetailResponse, DescribeBundleDiscountRequest, DescribeFirewallTemplateRulesResponse, DescribeDisksReturnableResponse, ModifyDiskBackupsAttributeResponse, DeleteFirewallTemplateRequest, IsolateDisksRequest, CreateInstanceSnapshotResponse, ModifyInstancesBundleResponse, DescribeResetInstanceBlueprintsResponse, DescribeDisksReturnableRequest, ResetFirewallTemplateRulesResponse, ModifySnapshotAttributeResponse, DescribeGeneralResourceQuotasResponse, ModifyInstancesRenewFlagRequest, StartDockerContainersRequest, RenewInstancesRequest, DescribeFirewallRulesTemplateResponse, RenewInstancesResponse, RenameDockerContainerRequest, DescribeDisksDeniedActionsResponse, ResetInstanceResponse, IsolateDisksResponse, DescribeFirewallRulesRequest, InquirePriceCreateInstancesRequest, DescribeModifyInstanceBundlesResponse, ModifyDisksAttributeResponse, CreateInstanceSnapshotRequest, CancelShareBlueprintAcrossAccountsRequest, InquirePriceCreateDisksResponse, ModifyInstancesAttributeResponse, DescribeInstanceLoginKeyPairAttributeResponse, DeleteFirewallTemplateRulesRequest } from "./lighthouse_models";
4
4
  /**
5
5
  * lighthouse client
6
6
  * @class
@@ -15,6 +15,11 @@ export declare class Client extends AbstractClient {
15
15
  * 本接口 (DeleteBlueprints) 用于删除镜像。
16
16
  */
17
17
  DeleteBlueprints(req: DeleteBlueprintsRequest, cb?: (error: string, rep: DeleteBlueprintsResponse) => void): Promise<DeleteBlueprintsResponse>;
18
+ /**
19
+ * 本接口(CancelShareBlueprintAcrossAccounts)用于取消镜像跨账号共享。
20
+ 指定的镜像ID必须为自定义镜像,且指定账号ID必须已进行共享。
21
+ */
22
+ CancelShareBlueprintAcrossAccounts(req: CancelShareBlueprintAcrossAccountsRequest, cb?: (error: string, rep: CancelShareBlueprintAcrossAccountsResponse) => void): Promise<CancelShareBlueprintAcrossAccountsResponse>;
18
23
  /**
19
24
  * 本接口(CreateFirewallRules)用于在实例上添加防火墙规则。
20
25
 
@@ -275,6 +280,12 @@ export declare class Client extends AbstractClient {
275
280
  * 本接口(DescribeBundles)用于查询套餐信息。
276
281
  */
277
282
  DescribeBundles(req: DescribeBundlesRequest, cb?: (error: string, rep: DescribeBundlesResponse) => void): Promise<DescribeBundlesResponse>;
283
+ /**
284
+ * 本接口(ShareBlueprintAcrossAccounts)用于跨账号共享镜像。
285
+ 仅支持共享自定义镜像, 且用于共享的镜像状态必须为NORMAL。
286
+ 共享的账号必须为主账号。
287
+ */
288
+ ShareBlueprintAcrossAccounts(req: ShareBlueprintAcrossAccountsRequest, cb?: (error: string, rep: ShareBlueprintAcrossAccountsResponse) => void): Promise<ShareBlueprintAcrossAccountsResponse>;
278
289
  /**
279
290
  * 本接口(DescribeInstancesTrafficPackages)用于查询一个或多个实例的流量包详情。
280
291
  */
@@ -39,6 +39,13 @@ class Client extends abstract_client_1.AbstractClient {
39
39
  async DeleteBlueprints(req, cb) {
40
40
  return this.request("DeleteBlueprints", req, cb);
41
41
  }
42
+ /**
43
+ * 本接口(CancelShareBlueprintAcrossAccounts)用于取消镜像跨账号共享。
44
+ 指定的镜像ID必须为自定义镜像,且指定账号ID必须已进行共享。
45
+ */
46
+ async CancelShareBlueprintAcrossAccounts(req, cb) {
47
+ return this.request("CancelShareBlueprintAcrossAccounts", req, cb);
48
+ }
42
49
  /**
43
50
  * 本接口(CreateFirewallRules)用于在实例上添加防火墙规则。
44
51
 
@@ -405,6 +412,14 @@ class Client extends abstract_client_1.AbstractClient {
405
412
  async DescribeBundles(req, cb) {
406
413
  return this.request("DescribeBundles", req, cb);
407
414
  }
415
+ /**
416
+ * 本接口(ShareBlueprintAcrossAccounts)用于跨账号共享镜像。
417
+ 仅支持共享自定义镜像, 且用于共享的镜像状态必须为NORMAL。
418
+ 共享的账号必须为主账号。
419
+ */
420
+ async ShareBlueprintAcrossAccounts(req, cb) {
421
+ return this.request("ShareBlueprintAcrossAccounts", req, cb);
422
+ }
408
423
  /**
409
424
  * 本接口(DescribeInstancesTrafficPackages)用于查询一个或多个实例的流量包详情。
410
425
  */