tencentcloud-sdk-nodejs 4.0.356 → 4.0.359

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 (132) hide show
  1. package/CHANGELOG.md +550 -0
  2. package/SERVICE_CHANGELOG.md +658 -589
  3. package/package.json +1 -1
  4. package/products.md +30 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/acp/index.ts +5 -0
  7. package/src/services/acp/v20220105/acp_client.ts +106 -0
  8. package/src/services/acp/v20220105/acp_models.ts +605 -0
  9. package/src/services/acp/v20220105/index.ts +6 -0
  10. package/src/services/ams/v20201229/ams_client.ts +2 -0
  11. package/src/services/ams/v20201229/ams_models.ts +54 -0
  12. package/src/services/asr/v20190614/asr_models.ts +2 -2
  13. package/src/services/bsca/v20210811/bsca_client.ts +12 -0
  14. package/src/services/bsca/v20210811/bsca_models.ts +25 -0
  15. package/src/services/cdn/v20180606/cdn_models.ts +13 -1
  16. package/src/services/cme/v20191029/cme_client.ts +2 -0
  17. package/src/services/cme/v20191029/cme_models.ts +47 -1
  18. package/src/services/cwp/v20180228/cwp_models.ts +51 -1
  19. package/src/services/ecm/v20190719/ecm_models.ts +10 -2
  20. package/src/services/emr/v20190103/emr_client.ts +6 -4
  21. package/src/services/emr/v20190103/emr_models.ts +7 -1
  22. package/src/services/ess/v20201111/ess_client.ts +27 -1
  23. package/src/services/ess/v20201111/ess_models.ts +161 -51
  24. package/src/services/essbasic/v20210526/essbasic_client.ts +45 -19
  25. package/src/services/essbasic/v20210526/essbasic_models.ts +127 -15
  26. package/src/services/index.ts +2 -0
  27. package/src/services/ivld/v20210903/ivld_client.ts +4 -2
  28. package/src/services/live/v20180801/live_client.ts +1 -1
  29. package/src/services/live/v20180801/live_models.ts +1 -1
  30. package/src/services/mmps/index.ts +5 -0
  31. package/src/services/mmps/v20200710/index.ts +6 -0
  32. package/src/services/mmps/v20200710/mmps_client.ts +167 -0
  33. package/src/services/mmps/v20200710/mmps_models.ts +846 -0
  34. package/src/services/ocr/v20181119/ocr_client.ts +38 -1
  35. package/src/services/ocr/v20181119/ocr_models.ts +329 -10
  36. package/src/services/organization/v20210331/organization_models.ts +21 -0
  37. package/src/services/partners/v20180321/partners_models.ts +1 -1
  38. package/src/services/ses/v20201002/ses_client.ts +1 -1
  39. package/src/services/ses/v20201002/ses_models.ts +2 -2
  40. package/src/services/ssl/v20191205/ssl_models.ts +19 -1
  41. package/src/services/tcr/v20190924/tcr_models.ts +15 -0
  42. package/src/services/tdmq/v20200217/tdmq_models.ts +4 -4
  43. package/src/services/tem/v20210701/tem_models.ts +7 -2
  44. package/src/services/tiia/v20190529/tiia_client.ts +17 -2
  45. package/src/services/tiia/v20190529/tiia_models.ts +74 -35
  46. package/src/services/tke/v20180525/tke_client.ts +1 -0
  47. package/src/services/tke/v20180525/tke_models.ts +20 -0
  48. package/src/services/trtc/v20190722/trtc_client.ts +2 -0
  49. package/src/services/trtc/v20190722/trtc_models.ts +104 -1
  50. package/src/services/tse/v20201207/tse_client.ts +31 -4
  51. package/src/services/tse/v20201207/tse_models.ts +310 -74
  52. package/src/services/vm/v20201229/vm_client.ts +2 -0
  53. package/src/services/vm/v20201229/vm_models.ts +54 -0
  54. package/src/services/vod/v20180717/vod_client.ts +1 -0
  55. package/src/services/vod/v20180717/vod_models.ts +21 -17
  56. package/src/services/vpc/v20170312/vpc_models.ts +16 -0
  57. package/tencentcloud/common/sdk_version.d.ts +1 -1
  58. package/tencentcloud/common/sdk_version.js +1 -1
  59. package/tencentcloud/services/acp/index.d.ts +6 -0
  60. package/tencentcloud/services/acp/index.js +7 -0
  61. package/tencentcloud/services/acp/v20220105/acp_client.d.ts +34 -0
  62. package/tencentcloud/services/acp/v20220105/acp_client.js +67 -0
  63. package/tencentcloud/services/acp/v20220105/acp_models.d.ts +491 -0
  64. package/tencentcloud/services/acp/v20220105/acp_models.js +18 -0
  65. package/tencentcloud/services/acp/v20220105/index.d.ts +6 -0
  66. package/tencentcloud/services/acp/v20220105/index.js +9 -0
  67. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +47 -0
  68. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +2 -2
  69. package/tencentcloud/services/bsca/v20210811/bsca_client.d.ts +5 -1
  70. package/tencentcloud/services/bsca/v20210811/bsca_client.js +6 -0
  71. package/tencentcloud/services/bsca/v20210811/bsca_models.d.ts +22 -0
  72. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +11 -1
  73. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +41 -1
  74. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +41 -1
  75. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +9 -2
  76. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +4 -2
  77. package/tencentcloud/services/emr/v20190103/emr_client.js +4 -2
  78. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +7 -1
  79. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +10 -1
  80. package/tencentcloud/services/ess/v20201111/ess_client.js +13 -0
  81. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +139 -46
  82. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -9
  83. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +23 -10
  84. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +109 -14
  85. package/tencentcloud/services/index.d.ts +2 -0
  86. package/tencentcloud/services/index.js +4 -0
  87. package/tencentcloud/services/ivld/v20210903/ivld_client.d.ts +4 -2
  88. package/tencentcloud/services/ivld/v20210903/ivld_client.js +4 -2
  89. package/tencentcloud/services/live/v20180801/live_client.d.ts +1 -1
  90. package/tencentcloud/services/live/v20180801/live_client.js +1 -1
  91. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -1
  92. package/tencentcloud/services/mmps/index.d.ts +6 -0
  93. package/tencentcloud/services/mmps/index.js +7 -0
  94. package/tencentcloud/services/mmps/v20200710/index.d.ts +6 -0
  95. package/tencentcloud/services/mmps/v20200710/index.js +9 -0
  96. package/tencentcloud/services/mmps/v20200710/mmps_client.d.ts +54 -0
  97. package/tencentcloud/services/mmps/v20200710/mmps_client.js +97 -0
  98. package/tencentcloud/services/mmps/v20200710/mmps_models.d.ts +695 -0
  99. package/tencentcloud/services/mmps/v20200710/mmps_models.js +18 -0
  100. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +13 -1
  101. package/tencentcloud/services/ocr/v20181119/ocr_client.js +18 -0
  102. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +275 -8
  103. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +17 -0
  104. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +1 -1
  105. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +1 -1
  106. package/tencentcloud/services/ses/v20201002/ses_client.js +1 -1
  107. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +2 -2
  108. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +17 -1
  109. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +12 -0
  110. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +4 -4
  111. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +6 -2
  112. package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +8 -1
  113. package/tencentcloud/services/tiia/v20190529/tiia_client.js +9 -0
  114. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +64 -29
  115. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +17 -0
  116. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +86 -1
  117. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +9 -1
  118. package/tencentcloud/services/tse/v20201207/tse_client.js +12 -0
  119. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +273 -67
  120. package/tencentcloud/services/vm/v20201229/vm_models.d.ts +47 -0
  121. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -0
  122. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -0
  123. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +19 -15
  124. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +13 -0
  125. package/test/acp.v20220105.test.js +81 -0
  126. package/test/bsca.v20210811.test.js +10 -0
  127. package/test/ess.v20201111.test.js +20 -0
  128. package/test/essbasic.v20210526.test.js +24 -4
  129. package/test/mmps.v20200710.test.js +131 -0
  130. package/test/ocr.v20181119.test.js +30 -0
  131. package/test/tiia.v20190529.test.js +10 -0
  132. package/test/tse.v20201207.test.js +20 -0
@@ -18,6 +18,7 @@
18
18
  import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
+ MatchKBPURLListResponse,
21
22
  DescribeKBComponentVulnerabilityRequest,
22
23
  ComponentVulnerabilityUnion,
23
24
  LicenseUnion,
@@ -28,6 +29,7 @@ import {
28
29
  Component,
29
30
  DescribeKBVulnerabilityResponse,
30
31
  DescribeKBLicenseResponse,
32
+ MatchKBPURLListRequest,
31
33
  VulnerabilityUnion,
32
34
  LicenseDetail,
33
35
  DescribeKBVulnerabilityRequest,
@@ -90,4 +92,14 @@ export class Client extends AbstractClient {
90
92
  ): Promise<DescribeKBVulnerabilityResponse> {
91
93
  return this.request("DescribeKBVulnerability", req, cb)
92
94
  }
95
+
96
+ /**
97
+ * 本接口(MatchKBPURLList)用于在知识库中匹配与特征对应的开源组件列表。
98
+ */
99
+ async MatchKBPURLList(
100
+ req: MatchKBPURLListRequest,
101
+ cb?: (error: string, rep: MatchKBPURLListResponse) => void
102
+ ): Promise<MatchKBPURLListResponse> {
103
+ return this.request("MatchKBPURLList", req, cb)
104
+ }
93
105
  }
@@ -15,6 +15,21 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
+ /**
19
+ * MatchKBPURLList返回参数结构体
20
+ */
21
+ export interface MatchKBPURLListResponse {
22
+ /**
23
+ * 组件列表。
24
+ */
25
+ PURLList: Array<PURL>
26
+
27
+ /**
28
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
29
+ */
30
+ RequestId?: string
31
+ }
32
+
18
33
  /**
19
34
  * DescribeKBComponentVulnerability请求参数结构体
20
35
  */
@@ -279,6 +294,16 @@ export interface DescribeKBLicenseResponse {
279
294
  RequestId?: string
280
295
  }
281
296
 
297
+ /**
298
+ * MatchKBPURLList请求参数结构体
299
+ */
300
+ export interface MatchKBPURLListRequest {
301
+ /**
302
+ * SHA1。
303
+ */
304
+ SHA1?: string
305
+ }
306
+
282
307
  /**
283
308
  * 描述漏洞的详细信息。
284
309
  */
@@ -3391,6 +3391,18 @@ disabled:未启用
3391
3391
  注意:此字段可能返回 null,表示取不到有效值。
3392
3392
  */
3393
3393
  ExtensionMode: number
3394
+
3395
+ /**
3396
+ * 流量包实际生效时间
3397
+ 注意:此字段可能返回 null,表示取不到有效值。
3398
+ */
3399
+ TrueEnableTime: string
3400
+
3401
+ /**
3402
+ * 流量包实际过期时间
3403
+ 注意:此字段可能返回 null,表示取不到有效值。
3404
+ */
3405
+ TrueExpireTime: string
3394
3406
  }
3395
3407
 
3396
3408
  /**
@@ -4709,7 +4721,7 @@ export interface WebSocket {
4709
4721
  Switch: string
4710
4722
 
4711
4723
  /**
4712
- * 设置超时时间,单位为秒,最大超时时间65秒。
4724
+ * 设置超时时间,单位为秒,最大超时时间300秒。
4713
4725
  注意:此字段可能返回 null,表示取不到有效值。
4714
4726
  */
4715
4727
  Timeout?: number
@@ -32,6 +32,7 @@ import {
32
32
  DescribeTeamsResponse,
33
33
  DescribeTaskDetailResponse,
34
34
  ExportVideoEditProjectRequest,
35
+ StreamConnectInputInterruptInfo,
35
36
  ClassInfo,
36
37
  ModifyProjectResponse,
37
38
  AudioTrackItem,
@@ -131,6 +132,7 @@ import {
131
132
  VideoExportCompletedEvent,
132
133
  ResourceInfo,
133
134
  MediaPreprocessOperation,
135
+ StreamConnectOutputInterruptInfo,
134
136
  JoinTeamInfo,
135
137
  DescribeResourceAuthorizationRequest,
136
138
  CreateClassResponse,
@@ -367,6 +367,18 @@ export interface ExportVideoEditProjectRequest {
367
367
  Operator?: string
368
368
  }
369
369
 
370
+ /**
371
+ * 云转推输入断流信息。
372
+ */
373
+ export interface StreamConnectInputInterruptInfo {
374
+ /**
375
+ * 云转推输入源标识,取值有:
376
+ <li>Main:主源;</li>
377
+ <li>Backup:备源。</li>
378
+ */
379
+ EndPoint: string
380
+ }
381
+
370
382
  /**
371
383
  * 分类信息
372
384
  */
@@ -2925,6 +2937,26 @@ export interface MediaPreprocessOperation {
2925
2937
  Args?: Array<string>
2926
2938
  }
2927
2939
 
2940
+ /**
2941
+ * 云转推输出断流信息
2942
+ */
2943
+ export interface StreamConnectOutputInterruptInfo {
2944
+ /**
2945
+ * 云转推输出标识。
2946
+ */
2947
+ Id: string
2948
+
2949
+ /**
2950
+ * 云转推输出名称。
2951
+ */
2952
+ Name: string
2953
+
2954
+ /**
2955
+ * 云转推输出地址。
2956
+ */
2957
+ Url: string
2958
+ }
2959
+
2928
2960
  /**
2929
2961
  * 加入的团队信息
2930
2962
  */
@@ -3948,9 +3980,23 @@ export interface ProjectStreamConnectStatusChangedEvent {
3948
3980
  /**
3949
3981
  * 项目状态,取值有:
3950
3982
  <li>Working:云转推推流开始;</li>
3951
- <li>Stopped:云转推推流结束。</li>
3983
+ <li>Stopped:云转推推流结束;</li>
3984
+ <li>InputInterrupted:云转推输入断流;</li>
3985
+ <li>OutputInterrupted:云转推输出断流。</li>
3952
3986
  */
3953
3987
  Status: string
3988
+
3989
+ /**
3990
+ * 云转推输入断流信息,仅当 Status 取值 InputInterrupted 时有效。
3991
+ 注意:此字段可能返回 null,表示取不到有效值。
3992
+ */
3993
+ InputInterruptInfo: StreamConnectInputInterruptInfo
3994
+
3995
+ /**
3996
+ * 云转推输出断流信息,仅当 Status 取值 OutputInterrupted 时有效。
3997
+ 注意:此字段可能返回 null,表示取不到有效值。
3998
+ */
3999
+ OutputInterruptInfo: StreamConnectOutputInterruptInfo
3954
4000
  }
3955
4001
 
3956
4002
  /**
@@ -2190,7 +2190,7 @@ export interface DescribeRiskDnsListRequest {
2190
2190
  Order?: string
2191
2191
 
2192
2192
  /**
2193
- * 排序字段:AccessCount-请求次数
2193
+ * 排序字段:AccessCount-请求次数。MergeTime-最近请求时间
2194
2194
  */
2195
2195
  By?: string
2196
2196
  }
@@ -3128,6 +3128,16 @@ export interface DescribeReverseShellEventsRequest {
3128
3128
  <li>Keywords - String - 是否必填:否 - 关键字(主机内网IP|进程名)</li>
3129
3129
  */
3130
3130
  Filters?: Array<Filter>
3131
+
3132
+ /**
3133
+ * 排序方式:根据请求次数排序:asc-升序/desc-降序
3134
+ */
3135
+ Order?: string
3136
+
3137
+ /**
3138
+ * 排序字段:CreateTime-发生时间
3139
+ */
3140
+ By?: string
3131
3141
  }
3132
3142
 
3133
3143
  /**
@@ -4329,6 +4339,16 @@ export interface DescribeBashEventsRequest {
4329
4339
  <li>Keywords - String - 是否必填:否 - 关键词(主机内网IP)</li>
4330
4340
  */
4331
4341
  Filters?: Array<Filter>
4342
+
4343
+ /**
4344
+ * 排序方式:根据请求次数排序:asc-升序/desc-降序
4345
+ */
4346
+ Order?: string
4347
+
4348
+ /**
4349
+ * 排序字段:CreateTime-发生时间。ModifyTime-处理时间
4350
+ */
4351
+ By?: string
4332
4352
  }
4333
4353
 
4334
4354
  /**
@@ -5910,6 +5930,16 @@ export interface DescribeBruteAttackListRequest {
5910
5930
  <li>Banned - String - 是否必填:否 - 阻断状态筛选,多个用","分割:0-未阻断(全局ZK开关关闭),82-未阻断(非专业版),83-未阻断(已加白名单),1-已阻断,2-未阻断-程序异常,3-未阻断-内网攻击暂不支持阻断,4-未阻断-安平暂不支持阻断</li>
5911
5931
  */
5912
5932
  Filters?: Array<Filter>
5933
+
5934
+ /**
5935
+ * 排序方式:根据请求次数排序:asc-升序/desc-降序
5936
+ */
5937
+ Order?: string
5938
+
5939
+ /**
5940
+ * 排序字段:CreateTime-首次攻击时间
5941
+ */
5942
+ By?: string
5913
5943
  }
5914
5944
 
5915
5945
  /**
@@ -9295,6 +9325,16 @@ export interface DescribePrivilegeEventsRequest {
9295
9325
  <li>Keywords - String - 是否必填:否 - 关键词(主机IP)</li>
9296
9326
  */
9297
9327
  Filters?: Array<Filter>
9328
+
9329
+ /**
9330
+ * 排序方式:根据请求次数排序:asc-升序/desc-降序
9331
+ */
9332
+ Order?: string
9333
+
9334
+ /**
9335
+ * 排序字段:CreateTime-发现时间
9336
+ */
9337
+ By?: string
9298
9338
  }
9299
9339
 
9300
9340
  /**
@@ -10027,6 +10067,16 @@ export interface DescribeHostLoginListRequest {
10027
10067
  <li>RiskLevel - int - 是否必填:否 - 状态筛选0:高危;1:可疑</li>
10028
10068
  */
10029
10069
  Filters?: Array<Filter>
10070
+
10071
+ /**
10072
+ * 排序方式:根据请求次数排序:asc-升序/desc-降序
10073
+ */
10074
+ Order?: string
10075
+
10076
+ /**
10077
+ * 排序字段:LoginTime-发生时间
10078
+ */
10079
+ By?: string
10030
10080
  }
10031
10081
 
10032
10082
  /**
@@ -3284,6 +3284,14 @@ export interface AssignIpv6AddressesRequest {
3284
3284
  * 自动分配IPv6地址个数,内网IP地址个数总和不能超过配数。与入参Ipv6Addresses合并计算配额。与Ipv6Addresses必填一个。
3285
3285
  */
3286
3286
  Ipv6AddressCount?: number
3287
+
3288
+ /**
3289
+ * ipv6运营商如下:
3290
+ CTCC:中国电信
3291
+ CUCC:中国联通
3292
+ CMCC:中国移动
3293
+ */
3294
+ Ipv6ISP?: string
3287
3295
  }
3288
3296
 
3289
3297
  /**
@@ -6292,7 +6300,7 @@ export interface ReleaseIpv6AddressesResponse {
6292
6300
  /**
6293
6301
  * 任务ID,可以通过DescribeTaskResult查询任务状态
6294
6302
  */
6295
- TaskId?: number
6303
+ TaskId: number
6296
6304
 
6297
6305
  /**
6298
6306
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -7127,7 +7135,7 @@ export interface AssignIpv6AddressesResponse {
7127
7135
  /**
7128
7136
  * 分配给弹性网卡的IPv6地址列表。
7129
7137
  */
7130
- Ipv6AddressSet?: Array<Ipv6Address>
7138
+ Ipv6AddressSet: Array<Ipv6Address>
7131
7139
 
7132
7140
  /**
7133
7141
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -149,8 +149,9 @@ export class Client extends AbstractClient {
149
149
  }
150
150
 
151
151
  /**
152
- * 批量导出用户。对于kerberos集群,如果需要kertab文件下载地址,可以将NeedKeytabInfo设置为true;注意SupportDownLoadKeyTab为true,但是DownLoadKeyTabUrl为空字符串,表示keytab文件在后台没有准备好(正在生成)
153
- */
152
+ * 该接口支持安装了OpenLdap组件的集群。
153
+ 批量导出用户。对于kerberos集群,如果需要kertab文件下载地址,可以将NeedKeytabInfo设置为true;注意SupportDownLoadKeyTab为true,但是DownLoadKeyTabUrl为空字符串,表示keytab文件在后台没有准备好(正在生成)。
154
+ */
154
155
  async DescribeUsersForUserManager(
155
156
  req: DescribeUsersForUserManagerRequest,
156
157
  cb?: (error: string, rep: DescribeUsersForUserManagerResponse) => void
@@ -239,8 +240,9 @@ export class Client extends AbstractClient {
239
240
  }
240
241
 
241
242
  /**
242
- * 新增用户列表(用户管理)
243
- */
243
+ * 该接口支持安装了OpenLdap组件的集群。
244
+ 新增用户列表(用户管理)。
245
+ */
244
246
  async AddUsersForUserManager(
245
247
  req: AddUsersForUserManagerRequest,
246
248
  cb?: (error: string, rep: AddUsersForUserManagerResponse) => void
@@ -279,7 +279,13 @@ export interface SubnetInfo {
279
279
  /**
280
280
  * 用户管理列表过滤器
281
281
  */
282
- export type UserManagerFilter = null
282
+ export interface UserManagerFilter {
283
+ /**
284
+ * 用户名
285
+ 注意:此字段可能返回 null,表示取不到有效值。
286
+ */
287
+ UserName?: string
288
+ }
283
289
 
284
290
  /**
285
291
  * 元数据库信息
@@ -19,6 +19,7 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  UploadFile,
22
+ CancelMultiFlowSignQRCodeRequest,
22
23
  DescribeFileUrlsResponse,
23
24
  TemplateInfo,
24
25
  CreateDocumentResponse,
@@ -29,10 +30,13 @@ import {
29
30
  CreateSchemeUrlRequest,
30
31
  FileUrl,
31
32
  DescribeThirdPartyAuthCodeRequest,
33
+ SignQrCode,
32
34
  UploadFilesRequest,
33
35
  CancelFlowRequest,
34
36
  DescribeFlowBriefsResponse,
35
37
  Component,
38
+ CreateMultiFlowSignQRCodeResponse,
39
+ FlowCreateApprover,
36
40
  UploadFilesResponse,
37
41
  DescribeThirdPartyAuthCodeResponse,
38
42
  CreateFlowByFilesResponse,
@@ -44,10 +48,11 @@ import {
44
48
  DescribeFlowTemplatesResponse,
45
49
  Filter,
46
50
  FileInfo,
47
- FlowCreateApprover,
51
+ CreateMultiFlowSignQRCodeRequest,
48
52
  StartFlowResponse,
49
53
  CreateSchemeUrlResponse,
50
54
  CreateFlowByFilesRequest,
55
+ CancelMultiFlowSignQRCodeResponse,
51
56
  CreateFlowResponse,
52
57
  Agent,
53
58
  FormField,
@@ -76,6 +81,17 @@ export class Client extends AbstractClient {
76
81
  return this.request("StartFlow", req, cb)
77
82
  }
78
83
 
84
+ /**
85
+ * 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
86
+ 适用的模版仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模版,且模版中发起方没有填写控件。
87
+ */
88
+ async CreateMultiFlowSignQRCode(
89
+ req: CreateMultiFlowSignQRCodeRequest,
90
+ cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
91
+ ): Promise<CreateMultiFlowSignQRCodeResponse> {
92
+ return this.request("CreateMultiFlowSignQRCode", req, cb)
93
+ }
94
+
79
95
  /**
80
96
  * 用于撤销流程
81
97
  */
@@ -126,6 +142,16 @@ export class Client extends AbstractClient {
126
142
  return this.request("CreateFlow", req, cb)
127
143
  }
128
144
 
145
+ /**
146
+ * 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
147
+ */
148
+ async CancelMultiFlowSignQRCode(
149
+ req: CancelMultiFlowSignQRCodeRequest,
150
+ cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void
151
+ ): Promise<CancelMultiFlowSignQRCodeResponse> {
152
+ return this.request("CancelMultiFlowSignQRCode", req, cb)
153
+ }
154
+
129
155
  /**
130
156
  * 获取小程序跳转链接
131
157
 
@@ -30,6 +30,26 @@ export interface UploadFile {
30
30
  FileName?: string
31
31
  }
32
32
 
33
+ /**
34
+ * CancelMultiFlowSignQRCode请求参数结构体
35
+ */
36
+ export interface CancelMultiFlowSignQRCodeRequest {
37
+ /**
38
+ * 用户信息
39
+ */
40
+ Operator: UserInfo
41
+
42
+ /**
43
+ * 二维码id
44
+ */
45
+ QrCodeId: string
46
+
47
+ /**
48
+ * 应用信息
49
+ */
50
+ Agent?: Agent
51
+ }
52
+
33
53
  /**
34
54
  * DescribeFileUrls返回参数结构体
35
55
  */
@@ -366,6 +386,26 @@ export interface DescribeThirdPartyAuthCodeRequest {
366
386
  AuthCode: string
367
387
  }
368
388
 
389
+ /**
390
+ * 一码多扫签署二维码对象
391
+ */
392
+ export interface SignQrCode {
393
+ /**
394
+ * 二维码id
395
+ */
396
+ QrCodeId: string
397
+
398
+ /**
399
+ * 二维码url
400
+ */
401
+ QrCodeUrl: string
402
+
403
+ /**
404
+ * 二维码过期时间
405
+ */
406
+ ExpiredTime: number
407
+ }
408
+
369
409
  /**
370
410
  * UploadFiles请求参数结构体
371
411
  */
@@ -567,6 +607,99 @@ KEYWORD 关键字,使用ComponentId指定关键字
567
607
  OffsetY?: number
568
608
  }
569
609
 
610
+ /**
611
+ * CreateMultiFlowSignQRCode返回参数结构体
612
+ */
613
+ export interface CreateMultiFlowSignQRCodeResponse {
614
+ /**
615
+ * 签署二维码对象
616
+ */
617
+ QrCode: SignQrCode
618
+
619
+ /**
620
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
621
+ */
622
+ RequestId?: string
623
+ }
624
+
625
+ /**
626
+ * 创建流程的签署方信息
627
+ */
628
+ export interface FlowCreateApprover {
629
+ /**
630
+ * 参与者类型:
631
+ 0:企业
632
+ 1:个人
633
+ 3:企业静默签署
634
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
635
+ */
636
+ ApproverType: number
637
+
638
+ /**
639
+ * 如果签署方为企业,需要填入企业全称
640
+ */
641
+ OrganizationName?: string
642
+
643
+ /**
644
+ * 是否需要签署
645
+ - `false`: 不需要签署
646
+ - `true`: 需要签署
647
+ */
648
+ Required?: boolean
649
+
650
+ /**
651
+ * 签署方经办人姓名
652
+ */
653
+ ApproverName?: string
654
+
655
+ /**
656
+ * 签署方经办人手机号码
657
+ */
658
+ ApproverMobile?: string
659
+
660
+ /**
661
+ * 签署方经办人证件号码
662
+ */
663
+ ApproverIdCardNumber?: string
664
+
665
+ /**
666
+ * 签署方经办人证件类型ID_CARD 身份证
667
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
668
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
669
+ */
670
+ ApproverIdCardType?: string
671
+
672
+ /**
673
+ * 签署方经办人在模板中的角色ID
674
+ */
675
+ RecipientId?: string
676
+
677
+ /**
678
+ * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
679
+ */
680
+ UserId?: string
681
+
682
+ /**
683
+ * 签署前置条件:是否需要阅读全文,默认为不需要
684
+ */
685
+ IsFullText?: boolean
686
+
687
+ /**
688
+ * 签署前置条件:阅读时长限制,默认为不需要
689
+ */
690
+ PreReadTime?: number
691
+
692
+ /**
693
+ * 是否发送短信,sms--短信通知,none--不通知,默认为sms
694
+ */
695
+ NotifyType?: string
696
+
697
+ /**
698
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
699
+ */
700
+ VerifyChannel?: Array<string>
701
+ }
702
+
570
703
  /**
571
704
  * UploadFiles返回参数结构体
572
705
  */
@@ -930,81 +1063,48 @@ export interface FileInfo {
930
1063
  }
931
1064
 
932
1065
  /**
933
- * 创建流程的签署方信息
1066
+ * CreateMultiFlowSignQRCode请求参数结构体
934
1067
  */
935
- export interface FlowCreateApprover {
936
- /**
937
- * 参与者类型:
938
- 0:企业
939
- 1:个人
940
- 3:企业静默签署
941
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。
942
- */
943
- ApproverType: number
944
-
945
- /**
946
- * 如果签署方为企业,需要填入企业全称
947
- */
948
- OrganizationName?: string
949
-
950
- /**
951
- * 是否需要签署
952
- - `false`: 不需要签署
953
- - `true`: 需要签署
954
- */
955
- Required?: boolean
956
-
957
- /**
958
- * 签署方经办人姓名
959
- */
960
- ApproverName?: string
961
-
1068
+ export interface CreateMultiFlowSignQRCodeRequest {
962
1069
  /**
963
- * 签署方经办人手机号码
1070
+ * 模版ID
964
1071
  */
965
- ApproverMobile?: string
1072
+ TemplateId: string
966
1073
 
967
1074
  /**
968
- * 签署方经办人证件号码
1075
+ * 用户信息
969
1076
  */
970
- ApproverIdCardNumber?: string
971
-
972
- /**
973
- * 签署方经办人证件类型ID_CARD 身份证
974
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
975
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
976
- */
977
- ApproverIdCardType?: string
1077
+ Operator: UserInfo
978
1078
 
979
1079
  /**
980
- * 签署方经办人在模板中的角色ID
1080
+ * 合同名称
981
1081
  */
982
- RecipientId?: string
1082
+ FlowName: string
983
1083
 
984
1084
  /**
985
- * 签署方经办人的用户ID,和签署方经办人姓名+手机号+证件必须有一个
1085
+ * 应用信息
986
1086
  */
987
- UserId?: string
1087
+ Agent?: Agent
988
1088
 
989
1089
  /**
990
- * 签署前置条件:是否需要阅读全文,默认为不需要
1090
+ * 合同有效天数 默认7天 最高设置不超过30天
991
1091
  */
992
- IsFullText?: boolean
1092
+ FlowEffectiveDay?: number
993
1093
 
994
1094
  /**
995
- * 签署前置条件:阅读时长限制,默认为不需要
1095
+ * 二维码有效天数 默认7天 最高设置不超过90天
996
1096
  */
997
- PreReadTime?: number
1097
+ QrEffectiveDay?: number
998
1098
 
999
1099
  /**
1000
- * 是否发送短信,sms--短信通知,none--不通知,默认为sms
1100
+ * 最大合同份数,默认5份 超过此上限 二维码自动失效
1001
1101
  */
1002
- NotifyType?: string
1102
+ MaxFlowNum?: number
1003
1103
 
1004
1104
  /**
1005
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
1105
+ * 回调地址
1006
1106
  */
1007
- VerifyChannel?: Array<string>
1107
+ CallbackUrl?: string
1008
1108
  }
1009
1109
 
1010
1110
  /**
@@ -1108,6 +1208,16 @@ MULTI_LINE_TEXT - 多行文本控件
1108
1208
  NeedPreview?: boolean
1109
1209
  }
1110
1210
 
1211
+ /**
1212
+ * CancelMultiFlowSignQRCode返回参数结构体
1213
+ */
1214
+ export interface CancelMultiFlowSignQRCodeResponse {
1215
+ /**
1216
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1217
+ */
1218
+ RequestId?: string
1219
+ }
1220
+
1111
1221
  /**
1112
1222
  * CreateFlow返回参数结构体
1113
1223
  */