tencentcloud-sdk-nodejs 4.0.819 → 4.0.820
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.
- package/CHANGELOG.md +204 -0
- package/SERVICE_CHANGELOG.md +307 -29
- package/package.json +1 -1
- package/products.md +10 -10
- package/src/common/sdk_version.ts +1 -1
- package/src/services/aiart/v20221229/aiart_client.ts +30 -0
- package/src/services/aiart/v20221229/aiart_models.ts +103 -0
- package/src/services/cdb/v20170320/cdb_client.ts +1 -0
- package/src/services/cdb/v20170320/cdb_models.ts +42 -11
- package/src/services/ckafka/v20190819/ckafka_client.ts +1 -1
- package/src/services/ckafka/v20190819/ckafka_models.ts +9 -9
- package/src/services/ess/v20201111/ess_client.ts +5 -2
- package/src/services/ess/v20201111/ess_models.ts +72 -12
- package/src/services/essbasic/v20210526/essbasic_client.ts +3 -0
- package/src/services/essbasic/v20210526/essbasic_models.ts +64 -4
- package/src/services/faceid/v20180301/faceid_client.ts +39 -15
- package/src/services/faceid/v20180301/faceid_models.ts +172 -94
- package/src/services/live/v20180801/live_models.ts +1 -1
- package/src/services/oceanus/v20190422/oceanus_models.ts +1 -1
- package/src/services/wedata/v20210820/wedata_models.ts +14 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/aiart/v20221229/aiart_client.d.ts +15 -1
- package/tencentcloud/services/aiart/v20221229/aiart_client.js +18 -0
- package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +99 -0
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +41 -11
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +1 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +1 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +9 -9
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +2 -2
- package/tencentcloud/services/ess/v20201111/ess_client.js +1 -1
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +69 -12
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +61 -4
- package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +13 -5
- package/tencentcloud/services/faceid/v20180301/faceid_client.js +18 -6
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +168 -94
- package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -1
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +1 -1
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +14 -1
- package/test/aiart.v20221229.test.js +20 -0
- package/test/faceid.v20180301.test.js +24 -4
|
@@ -1,12 +1,26 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { ImageToImageResponse, ImageToImageRequest, TextToImageRequest, TextToImageResponse } from "./aiart_models";
|
|
3
|
+
import { ImageToImageResponse, SubmitTextToImageProJobRequest, ImageToImageRequest, QueryTextToImageProJobResponse, QueryTextToImageProJobRequest, SubmitTextToImageProJobResponse, TextToImageRequest, TextToImageResponse } from "./aiart_models";
|
|
4
4
|
/**
|
|
5
5
|
* aiart client
|
|
6
6
|
* @class
|
|
7
7
|
*/
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
|
+
/**
|
|
11
|
+
* 文生图(高级版)接口基于高级版文生图大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
12
|
+
提交任务:输入文本等,提交一个文生图(高级版)异步任务,获得任务 ID。
|
|
13
|
+
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
14
|
+
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。文生图(高级版)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
15
|
+
*/
|
|
16
|
+
QueryTextToImageProJob(req: QueryTextToImageProJobRequest, cb?: (error: string, rep: QueryTextToImageProJobResponse) => void): Promise<QueryTextToImageProJobResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* 文生图(高级版)接口基于高级版文生图大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
19
|
+
提交任务:输入文本等,提交一个文生图(高级版)异步任务,获得任务 ID。
|
|
20
|
+
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
21
|
+
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。文生图(高级版)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
22
|
+
*/
|
|
23
|
+
SubmitTextToImageProJob(req: SubmitTextToImageProJobRequest, cb?: (error: string, rep: SubmitTextToImageProJobResponse) => void): Promise<SubmitTextToImageProJobResponse>;
|
|
10
24
|
/**
|
|
11
25
|
* 智能文生图接口将根据输入的描述文本,智能生成与之相关的结果图。
|
|
12
26
|
输入:256个字符以内的描述性文本,推荐使用中文。
|
|
@@ -27,6 +27,24 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
27
27
|
constructor(clientConfig) {
|
|
28
28
|
super("aiart.tencentcloudapi.com", "2022-12-29", clientConfig);
|
|
29
29
|
}
|
|
30
|
+
/**
|
|
31
|
+
* 文生图(高级版)接口基于高级版文生图大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
32
|
+
提交任务:输入文本等,提交一个文生图(高级版)异步任务,获得任务 ID。
|
|
33
|
+
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
34
|
+
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。文生图(高级版)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
35
|
+
*/
|
|
36
|
+
async QueryTextToImageProJob(req, cb) {
|
|
37
|
+
return this.request("QueryTextToImageProJob", req, cb);
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* 文生图(高级版)接口基于高级版文生图大模型,将根据输入的文本描述,智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
|
|
41
|
+
提交任务:输入文本等,提交一个文生图(高级版)异步任务,获得任务 ID。
|
|
42
|
+
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得生成图像结果。
|
|
43
|
+
并发任务数(并发)说明:并发任务数指能同时处理的任务数量。文生图(高级版)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。
|
|
44
|
+
*/
|
|
45
|
+
async SubmitTextToImageProJob(req, cb) {
|
|
46
|
+
return this.request("SubmitTextToImageProJob", req, cb);
|
|
47
|
+
}
|
|
30
48
|
/**
|
|
31
49
|
* 智能文生图接口将根据输入的描述文本,智能生成与之相关的结果图。
|
|
32
50
|
输入:256个字符以内的描述性文本,推荐使用中文。
|
|
@@ -13,6 +13,43 @@ export interface ImageToImageResponse {
|
|
|
13
13
|
*/
|
|
14
14
|
RequestId?: string;
|
|
15
15
|
}
|
|
16
|
+
/**
|
|
17
|
+
* SubmitTextToImageProJob请求参数结构体
|
|
18
|
+
*/
|
|
19
|
+
export interface SubmitTextToImageProJobRequest {
|
|
20
|
+
/**
|
|
21
|
+
* 文本描述。
|
|
22
|
+
算法将根据输入的文本智能生成与之相关的图像。
|
|
23
|
+
不能为空,推荐使用中文。最多可传100个 utf-8 字符。
|
|
24
|
+
*/
|
|
25
|
+
Prompt: string;
|
|
26
|
+
/**
|
|
27
|
+
* 绘画风格。
|
|
28
|
+
请在 [文生图(高级版)风格列表](https://cloud.tencent.com/document/product/1668/104567) 中选择期望的风格,传入风格编号。
|
|
29
|
+
不传默认不指定风格。
|
|
30
|
+
*/
|
|
31
|
+
Style?: string;
|
|
32
|
+
/**
|
|
33
|
+
* 生成图分辨率。
|
|
34
|
+
支持生成以下分辨率的图片:768:768(1:1)、768:1024(3:4)、1024:768(4:3)、1024:1024(1:1)、720:1280(9:16)、1280:720(16:9)、768:1280(3:5)、1280:768(5:3),不传默认使用1024:1024。
|
|
35
|
+
*/
|
|
36
|
+
Resolution?: string;
|
|
37
|
+
/**
|
|
38
|
+
* 为生成结果图添加显式水印标识的开关,默认为1。
|
|
39
|
+
1:添加。
|
|
40
|
+
0:不添加。
|
|
41
|
+
其他数值:默认按1处理。
|
|
42
|
+
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
|
|
43
|
+
*/
|
|
44
|
+
LogoAdd?: number;
|
|
45
|
+
/**
|
|
46
|
+
* 文生图引擎,默认使用engine1。
|
|
47
|
+
取值:
|
|
48
|
+
engine1
|
|
49
|
+
engine2
|
|
50
|
+
*/
|
|
51
|
+
Engine?: string;
|
|
52
|
+
}
|
|
16
53
|
/**
|
|
17
54
|
* logo参数
|
|
18
55
|
*/
|
|
@@ -116,6 +153,55 @@ export interface LogoRect {
|
|
|
116
153
|
*/
|
|
117
154
|
Height?: number;
|
|
118
155
|
}
|
|
156
|
+
/**
|
|
157
|
+
* QueryTextToImageProJob返回参数结构体
|
|
158
|
+
*/
|
|
159
|
+
export interface QueryTextToImageProJobResponse {
|
|
160
|
+
/**
|
|
161
|
+
* 当前任务状态码:
|
|
162
|
+
1:排队中、3:处理中、5:处理失败、7:处理完成。
|
|
163
|
+
|
|
164
|
+
*/
|
|
165
|
+
JobStatusCode?: string;
|
|
166
|
+
/**
|
|
167
|
+
* 当前任务状态:排队中、处理中、处理失败或者处理完成。
|
|
168
|
+
|
|
169
|
+
*/
|
|
170
|
+
JobStatusMsg?: string;
|
|
171
|
+
/**
|
|
172
|
+
* 任务处理失败错误码。
|
|
173
|
+
|
|
174
|
+
*/
|
|
175
|
+
JobErrorCode?: string;
|
|
176
|
+
/**
|
|
177
|
+
* 任务处理失败错误信息。
|
|
178
|
+
|
|
179
|
+
*/
|
|
180
|
+
JobErrorMsg?: string;
|
|
181
|
+
/**
|
|
182
|
+
* 生成图 URL 列表,有效期1小时,请及时保存。
|
|
183
|
+
|
|
184
|
+
*/
|
|
185
|
+
ResultImage?: Array<string>;
|
|
186
|
+
/**
|
|
187
|
+
* 结果 detail 数组,Success 代表成功。
|
|
188
|
+
|
|
189
|
+
*/
|
|
190
|
+
ResultDetails?: Array<string>;
|
|
191
|
+
/**
|
|
192
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
193
|
+
*/
|
|
194
|
+
RequestId?: string;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* QueryTextToImageProJob请求参数结构体
|
|
198
|
+
*/
|
|
199
|
+
export interface QueryTextToImageProJobRequest {
|
|
200
|
+
/**
|
|
201
|
+
* 任务 ID。
|
|
202
|
+
*/
|
|
203
|
+
JobId: string;
|
|
204
|
+
}
|
|
119
205
|
/**
|
|
120
206
|
* 返回结果配置
|
|
121
207
|
*/
|
|
@@ -129,6 +215,19 @@ export interface ResultConfig {
|
|
|
129
215
|
*/
|
|
130
216
|
Resolution?: string;
|
|
131
217
|
}
|
|
218
|
+
/**
|
|
219
|
+
* SubmitTextToImageProJob返回参数结构体
|
|
220
|
+
*/
|
|
221
|
+
export interface SubmitTextToImageProJobResponse {
|
|
222
|
+
/**
|
|
223
|
+
* 任务 ID。
|
|
224
|
+
*/
|
|
225
|
+
JobId?: string;
|
|
226
|
+
/**
|
|
227
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
228
|
+
*/
|
|
229
|
+
RequestId?: string;
|
|
230
|
+
}
|
|
132
231
|
/**
|
|
133
232
|
* TextToImage请求参数结构体
|
|
134
233
|
*/
|
|
@@ -5,19 +5,19 @@ export interface TaskDetail {
|
|
|
5
5
|
/**
|
|
6
6
|
* 错误码。
|
|
7
7
|
*/
|
|
8
|
-
Code
|
|
8
|
+
Code?: number;
|
|
9
9
|
/**
|
|
10
10
|
* 错误信息。
|
|
11
11
|
*/
|
|
12
|
-
Message
|
|
12
|
+
Message?: string;
|
|
13
13
|
/**
|
|
14
14
|
* 实例任务 ID。
|
|
15
15
|
*/
|
|
16
|
-
JobId
|
|
16
|
+
JobId?: number;
|
|
17
17
|
/**
|
|
18
18
|
* 实例任务进度。
|
|
19
19
|
*/
|
|
20
|
-
Progress
|
|
20
|
+
Progress?: number;
|
|
21
21
|
/**
|
|
22
22
|
* 实例任务状态,可能的值包括:
|
|
23
23
|
"UNDEFINED" - 未定义;
|
|
@@ -30,7 +30,7 @@ export interface TaskDetail {
|
|
|
30
30
|
"PAUSED" - 已暂停。
|
|
31
31
|
"WAITING" - 等待中(可撤销)
|
|
32
32
|
*/
|
|
33
|
-
TaskStatus
|
|
33
|
+
TaskStatus?: string;
|
|
34
34
|
/**
|
|
35
35
|
* 实例任务类型,可能的值包括:
|
|
36
36
|
"ROLLBACK" - 数据库回档;
|
|
@@ -46,24 +46,29 @@ export interface TaskDetail {
|
|
|
46
46
|
"DROP TABLES" - 删除云数据库库表;
|
|
47
47
|
"SWITCH DR TO MASTER" - 灾备实例提升为主。
|
|
48
48
|
*/
|
|
49
|
-
TaskType
|
|
49
|
+
TaskType?: string;
|
|
50
50
|
/**
|
|
51
51
|
* 实例任务开始时间。
|
|
52
52
|
*/
|
|
53
|
-
StartTime
|
|
53
|
+
StartTime?: string;
|
|
54
54
|
/**
|
|
55
55
|
* 实例任务结束时间。
|
|
56
56
|
*/
|
|
57
|
-
EndTime
|
|
57
|
+
EndTime?: string;
|
|
58
58
|
/**
|
|
59
59
|
* 任务关联的实例 ID。
|
|
60
60
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
61
61
|
*/
|
|
62
|
-
InstanceIds
|
|
62
|
+
InstanceIds?: Array<string>;
|
|
63
63
|
/**
|
|
64
64
|
* 异步任务的请求 ID。
|
|
65
65
|
*/
|
|
66
|
-
AsyncRequestId
|
|
66
|
+
AsyncRequestId?: string;
|
|
67
|
+
/**
|
|
68
|
+
* 任务的附加信息。
|
|
69
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
70
|
+
*/
|
|
71
|
+
TaskAttachInfo?: Array<TaskAttachInfo>;
|
|
67
72
|
}
|
|
68
73
|
/**
|
|
69
74
|
* 可用区售卖配置
|
|
@@ -3483,7 +3488,7 @@ export interface CreateCloneInstanceResponse {
|
|
|
3483
3488
|
/**
|
|
3484
3489
|
* 异步任务的请求ID,可使用此 ID 查询异步任务的执行结果。
|
|
3485
3490
|
*/
|
|
3486
|
-
AsyncRequestId
|
|
3491
|
+
AsyncRequestId?: string;
|
|
3487
3492
|
/**
|
|
3488
3493
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3489
3494
|
*/
|
|
@@ -6495,6 +6500,23 @@ export interface DescribeDatabasesResponse {
|
|
|
6495
6500
|
*/
|
|
6496
6501
|
RequestId?: string;
|
|
6497
6502
|
}
|
|
6503
|
+
/**
|
|
6504
|
+
* 任务列表中的部分任务支持特定的附加信息
|
|
6505
|
+
*/
|
|
6506
|
+
export interface TaskAttachInfo {
|
|
6507
|
+
/**
|
|
6508
|
+
* 升级任务:
|
|
6509
|
+
”FastUpgradeStatus“:表示升级类型。1-原地升级;0-普通升级。
|
|
6510
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6511
|
+
*/
|
|
6512
|
+
AttachKey?: string;
|
|
6513
|
+
/**
|
|
6514
|
+
* 升级任务:
|
|
6515
|
+
”FastUpgradeStatus“:表示升级类型。1-原地升级;0-普通升级。
|
|
6516
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6517
|
+
*/
|
|
6518
|
+
AttachValue?: string;
|
|
6519
|
+
}
|
|
6498
6520
|
/**
|
|
6499
6521
|
* DescribeRoGroups返回参数结构体
|
|
6500
6522
|
*/
|
|
@@ -8230,6 +8252,14 @@ export interface CreateCloneInstanceRequest {
|
|
|
8230
8252
|
* 项目ID,默认项目ID0
|
|
8231
8253
|
*/
|
|
8232
8254
|
ProjectId?: number;
|
|
8255
|
+
/**
|
|
8256
|
+
* 付费类型,PRE_PAID:包年包月,USED_PAID:按量计费。默认为按量计费
|
|
8257
|
+
*/
|
|
8258
|
+
PayType?: string;
|
|
8259
|
+
/**
|
|
8260
|
+
* 实例时长,PayType为PRE_PAID时必传,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
|
|
8261
|
+
*/
|
|
8262
|
+
Period?: number;
|
|
8233
8263
|
}
|
|
8234
8264
|
/**
|
|
8235
8265
|
* CloseCDBProxy请求参数结构体
|
|
@@ -184,7 +184,7 @@ export declare class Client extends AbstractClient {
|
|
|
184
184
|
*/
|
|
185
185
|
DescribeTopicFlowRanking(req: DescribeTopicFlowRankingRequest, cb?: (error: string, rep: DescribeTopicFlowRankingResponse) => void): Promise<DescribeTopicFlowRankingResponse>;
|
|
186
186
|
/**
|
|
187
|
-
*
|
|
187
|
+
* 修改ACL策略,目前只支持预设规则的是否应用到新增topic这一项的修改
|
|
188
188
|
*/
|
|
189
189
|
ModifyAclRule(req: ModifyAclRuleRequest, cb?: (error: string, rep: ModifyAclRuleResponse) => void): Promise<ModifyAclRuleResponse>;
|
|
190
190
|
/**
|
|
@@ -292,7 +292,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
292
292
|
return this.request("DescribeTopicFlowRanking", req, cb);
|
|
293
293
|
}
|
|
294
294
|
/**
|
|
295
|
-
*
|
|
295
|
+
* 修改ACL策略,目前只支持预设规则的是否应用到新增topic这一项的修改
|
|
296
296
|
*/
|
|
297
297
|
async ModifyAclRule(req, cb) {
|
|
298
298
|
return this.request("ModifyAclRule", req, cb);
|
|
@@ -1601,9 +1601,9 @@ export interface ModifyAclRuleRequest {
|
|
|
1601
1601
|
*/
|
|
1602
1602
|
RuleName: string;
|
|
1603
1603
|
/**
|
|
1604
|
-
*
|
|
1604
|
+
* 修改预设规则时传入,是否应用到新增的Topic
|
|
1605
1605
|
*/
|
|
1606
|
-
IsApplied
|
|
1606
|
+
IsApplied?: number;
|
|
1607
1607
|
}
|
|
1608
1608
|
/**
|
|
1609
1609
|
* 查询Datahub任务列表
|
|
@@ -2126,7 +2126,7 @@ export interface ModifyAclRuleResponse {
|
|
|
2126
2126
|
/**
|
|
2127
2127
|
* 规则的唯一表示Key
|
|
2128
2128
|
*/
|
|
2129
|
-
Result
|
|
2129
|
+
Result?: number;
|
|
2130
2130
|
/**
|
|
2131
2131
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2132
2132
|
*/
|
|
@@ -4438,7 +4438,7 @@ export interface GroupInfoResponse {
|
|
|
4438
4438
|
/**
|
|
4439
4439
|
* 错误码,正常为0
|
|
4440
4440
|
*/
|
|
4441
|
-
ErrorCode
|
|
4441
|
+
ErrorCode?: string;
|
|
4442
4442
|
/**
|
|
4443
4443
|
* group 状态描述(常见的为 Empty、Stable、Dead 三种状态):
|
|
4444
4444
|
Dead:消费分组不存在
|
|
@@ -4447,23 +4447,23 @@ export interface GroupInfoResponse {
|
|
|
4447
4447
|
CompletingRebalance:消费分组处于 rebalance 状态
|
|
4448
4448
|
Stable:消费分组中各个消费者已经加入,处于稳定状态
|
|
4449
4449
|
*/
|
|
4450
|
-
State
|
|
4450
|
+
State?: string;
|
|
4451
4451
|
/**
|
|
4452
4452
|
* 消费分组选择的协议类型正常的消费者一般为 consumer 但有些系统采用了自己的协议如 kafka-connect 用的就是 connect。只有标准的 consumer 协议,本接口才知道具体的分配方式的格式,才能解析到具体的 partition 的分配情况
|
|
4453
4453
|
*/
|
|
4454
|
-
ProtocolType
|
|
4454
|
+
ProtocolType?: string;
|
|
4455
4455
|
/**
|
|
4456
4456
|
* 消费者 partition 分配算法常见的有如下几种(Kafka 消费者 SDK 默认的选择项为 range):range、 roundrobin、 sticky
|
|
4457
4457
|
*/
|
|
4458
|
-
Protocol
|
|
4458
|
+
Protocol?: string;
|
|
4459
4459
|
/**
|
|
4460
4460
|
* 仅当 state 为 Stable 且 protocol_type 为 consumer 时, 该数组才包含信息
|
|
4461
4461
|
*/
|
|
4462
|
-
Members
|
|
4462
|
+
Members?: Array<GroupInfoMember>;
|
|
4463
4463
|
/**
|
|
4464
4464
|
* Kafka 消费分组
|
|
4465
4465
|
*/
|
|
4466
|
-
Group
|
|
4466
|
+
Group?: string;
|
|
4467
4467
|
}
|
|
4468
4468
|
/**
|
|
4469
4469
|
* DescribeAppInfo返回参数结构体
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { DescribePersonCertificateResponse, DescribeCancelFlowsTaskResponse, CreateSealRequest,
|
|
3
|
+
import { DescribePersonCertificateResponse, DescribeCancelFlowsTaskResponse, CreateSealRequest, CancelFlowResponse, DescribeExtendedServiceAuthDetailResponse, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, DeleteExtendedServiceAuthInfosResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, CreateExtendedServiceAuthInfosRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, ModifyExtendedServiceRequest, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateBatchQuickSignUrlResponse, CreateIntegrationRoleRequest, DeleteIntegrationRoleUsersResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowGroupSignReviewResponse, CreateBatchSignUrlResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, DescribeSignFaceVideoRequest, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, CreateOrganizationInfoChangeUrlResponse, DescribeExtendedServiceAuthDetailRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateUserAutoSignSealUrlResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ModifyFlowDeadlineResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, DescribeFlowBriefsResponse, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeFlowEvidenceReportRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, RenewAutoSignLicenseRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateExtendedServiceAuthInfosResponse, CreateWebThemeConfigRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, ModifyIntegrationDepartmentResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, CreateEmbedWebUrlResponse, ModifyExtendedServiceResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateBatchSignUrlRequest, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailResponse, CreateUserAutoSignEnableUrlResponse, DescribeSignFaceVideoResponse, VerifyPdfResponse, CreateFlowGroupSignReviewRequest, DescribeBillUsageDetailRequest, DescribeFlowTemplatesResponse, ModifyIntegrationRoleResponse, UploadFilesRequest, DescribePersonCertificateRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, VerifyPdfRequest, DescribeFlowInfoRequest, DeleteExtendedServiceAuthInfosRequest, DescribeIntegrationDepartmentsRequest, DescribeFlowInfoResponse, RenewAutoSignLicenseResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, CreateBatchQuickSignUrlRequest, CreateOrganizationInfoChangeUrlRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
|
|
4
4
|
/**
|
|
5
5
|
* ess client
|
|
6
6
|
* @class
|
|
@@ -41,7 +41,7 @@ export declare class Client extends AbstractClient {
|
|
|
41
41
|
注:
|
|
42
42
|
1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
|
|
43
43
|
|
|
44
|
-
2.<font color="red"
|
|
44
|
+
2.<font color="red">静默(自动)签署不支持非本企业合同签署方存在填写</font>功能
|
|
45
45
|
|
|
46
46
|
3.<font color="red">在发起签署流程之前,建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)</font>,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
|
|
47
47
|
*/
|
|
@@ -67,7 +67,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
67
67
|
注:
|
|
68
68
|
1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(过期,拒签,签署完成,解除完成等状态不会返还额度)
|
|
69
69
|
|
|
70
|
-
2.<font color="red"
|
|
70
|
+
2.<font color="red">静默(自动)签署不支持非本企业合同签署方存在填写</font>功能
|
|
71
71
|
|
|
72
72
|
3.<font color="red">在发起签署流程之前,建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)</font>,尤其是当模板中存在动态表格等复杂填写控件时,因为合成过程可能会耗费秒级别的时间。
|
|
73
73
|
*/
|
|
@@ -243,13 +243,13 @@ export interface CreateSealRequest {
|
|
|
243
243
|
TaxIdentifyCode?: string;
|
|
244
244
|
}
|
|
245
245
|
/**
|
|
246
|
-
*
|
|
246
|
+
* 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
|
247
247
|
*/
|
|
248
|
-
export interface
|
|
248
|
+
export interface FlowGroupUrlInfo {
|
|
249
249
|
/**
|
|
250
|
-
*
|
|
250
|
+
* 合同组子合同和签署方的信息,用于补充动态签署人。
|
|
251
251
|
*/
|
|
252
|
-
|
|
252
|
+
FlowGroupApproverInfos?: Array<FlowGroupApproverInfo>;
|
|
253
253
|
}
|
|
254
254
|
/**
|
|
255
255
|
* CancelFlow返回参数结构体
|
|
@@ -1683,6 +1683,10 @@ export interface CreateFlowGroupByTemplatesResponse {
|
|
|
1683
1683
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1684
1684
|
*/
|
|
1685
1685
|
FlowIds?: Array<string>;
|
|
1686
|
+
/**
|
|
1687
|
+
* 合同组签署人信息。
|
|
1688
|
+
*/
|
|
1689
|
+
Approvers?: Array<FlowGroupApprovers>;
|
|
1686
1690
|
/**
|
|
1687
1691
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1688
1692
|
*/
|
|
@@ -2152,6 +2156,10 @@ export interface CreateSchemeUrlRequest {
|
|
|
2152
2156
|
注:`生成动态签署人补充链接时必传。`
|
|
2153
2157
|
*/
|
|
2154
2158
|
RecipientId?: string;
|
|
2159
|
+
/**
|
|
2160
|
+
* 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
|
2161
|
+
*/
|
|
2162
|
+
FlowGroupUrlInfo?: FlowGroupUrlInfo;
|
|
2155
2163
|
}
|
|
2156
2164
|
/**
|
|
2157
2165
|
* DeleteIntegrationDepartment返回参数结构体
|
|
@@ -2749,6 +2757,10 @@ export interface FillApproverInfo {
|
|
|
2749
2757
|
注:`补充个人签署方时,若该用户已在电子签完成实名则可通过指定姓名和证件类型、证件号码完成补充。`
|
|
2750
2758
|
*/
|
|
2751
2759
|
ApproverIdCardNumber?: string;
|
|
2760
|
+
/**
|
|
2761
|
+
* 合同流程ID,补充合同组子合同动态签署人时必传。
|
|
2762
|
+
*/
|
|
2763
|
+
FlowId?: string;
|
|
2752
2764
|
}
|
|
2753
2765
|
/**
|
|
2754
2766
|
* 持有的电子印章信息
|
|
@@ -3921,12 +3933,6 @@ export interface CreateFlowApproversRequest {
|
|
|
3921
3933
|
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3922
3934
|
*/
|
|
3923
3935
|
Operator: UserInfo;
|
|
3924
|
-
/**
|
|
3925
|
-
* 合同流程ID,为32位字符串。
|
|
3926
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
3927
|
-
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
3928
|
-
*/
|
|
3929
|
-
FlowId: string;
|
|
3930
3936
|
/**
|
|
3931
3937
|
* 补充企业签署人信息。
|
|
3932
3938
|
|
|
@@ -3935,6 +3941,12 @@ export interface CreateFlowApproversRequest {
|
|
|
3935
3941
|
- 如果不指定,则使用姓名和手机号进行补充。
|
|
3936
3942
|
*/
|
|
3937
3943
|
Approvers: Array<FillApproverInfo>;
|
|
3944
|
+
/**
|
|
3945
|
+
* 合同流程ID,为32位字符串。
|
|
3946
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
3947
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
3948
|
+
*/
|
|
3949
|
+
FlowId?: string;
|
|
3938
3950
|
/**
|
|
3939
3951
|
* 签署人信息补充方式
|
|
3940
3952
|
|
|
@@ -3952,6 +3964,10 @@ export interface CreateFlowApproversRequest {
|
|
|
3952
3964
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3953
3965
|
*/
|
|
3954
3966
|
Agent?: Agent;
|
|
3967
|
+
/**
|
|
3968
|
+
* 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
|
|
3969
|
+
*/
|
|
3970
|
+
FlowGroupId?: string;
|
|
3955
3971
|
}
|
|
3956
3972
|
/**
|
|
3957
3973
|
* ModifyFlowDeadline返回参数结构体
|
|
@@ -4866,6 +4882,10 @@ export interface CreateFlowGroupByFilesResponse {
|
|
|
4866
4882
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4867
4883
|
*/
|
|
4868
4884
|
FlowIds?: Array<string>;
|
|
4885
|
+
/**
|
|
4886
|
+
* 合同组签署方信息。
|
|
4887
|
+
*/
|
|
4888
|
+
Approvers?: Array<FlowGroupApprovers>;
|
|
4869
4889
|
/**
|
|
4870
4890
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
4871
4891
|
*/
|
|
@@ -5366,12 +5386,12 @@ export interface ApproverInfo {
|
|
|
5366
5386
|
* 签署方经办人的姓名。
|
|
5367
5387
|
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
5368
5388
|
*/
|
|
5369
|
-
ApproverName
|
|
5389
|
+
ApproverName?: string;
|
|
5370
5390
|
/**
|
|
5371
5391
|
* 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
|
5372
5392
|
请确认手机号所有方为此合同签署方。
|
|
5373
5393
|
*/
|
|
5374
|
-
ApproverMobile
|
|
5394
|
+
ApproverMobile?: string;
|
|
5375
5395
|
/**
|
|
5376
5396
|
* 组织机构名称。
|
|
5377
5397
|
请确认该名称与企业营业执照中注册的名称一致。
|
|
@@ -5921,6 +5941,15 @@ export interface CreatePrepareFlowResponse {
|
|
|
5921
5941
|
*/
|
|
5922
5942
|
RequestId?: string;
|
|
5923
5943
|
}
|
|
5944
|
+
/**
|
|
5945
|
+
* ModifyIntegrationDepartment返回参数结构体
|
|
5946
|
+
*/
|
|
5947
|
+
export interface ModifyIntegrationDepartmentResponse {
|
|
5948
|
+
/**
|
|
5949
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
5950
|
+
*/
|
|
5951
|
+
RequestId?: string;
|
|
5952
|
+
}
|
|
5924
5953
|
/**
|
|
5925
5954
|
* GetTaskResultApi返回参数结构体
|
|
5926
5955
|
*/
|
|
@@ -6340,6 +6369,19 @@ export interface CreateSealPolicyRequest {
|
|
|
6340
6369
|
*/
|
|
6341
6370
|
Agent?: Agent;
|
|
6342
6371
|
}
|
|
6372
|
+
/**
|
|
6373
|
+
* 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
|
6374
|
+
*/
|
|
6375
|
+
export interface FlowGroupApproverInfo {
|
|
6376
|
+
/**
|
|
6377
|
+
* 合同流程ID。
|
|
6378
|
+
*/
|
|
6379
|
+
FlowId?: string;
|
|
6380
|
+
/**
|
|
6381
|
+
* 签署节点ID,用于生成动态签署人链接完成领取。注:`生成动态签署人补充链接时必传。`
|
|
6382
|
+
*/
|
|
6383
|
+
RecipientId?: string;
|
|
6384
|
+
}
|
|
6343
6385
|
/**
|
|
6344
6386
|
* DescribeOrganizationSeals请求参数结构体
|
|
6345
6387
|
*/
|
|
@@ -6953,6 +6995,21 @@ export interface UpdateIntegrationEmployeesRequest {
|
|
|
6953
6995
|
*/
|
|
6954
6996
|
Endpoint?: string;
|
|
6955
6997
|
}
|
|
6998
|
+
/**
|
|
6999
|
+
* 合同组签署方信息
|
|
7000
|
+
*/
|
|
7001
|
+
export interface FlowGroupApprovers {
|
|
7002
|
+
/**
|
|
7003
|
+
* 合同流程ID
|
|
7004
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7005
|
+
*/
|
|
7006
|
+
FlowId?: string;
|
|
7007
|
+
/**
|
|
7008
|
+
* 签署方信息,包含合同ID和角色ID用于定位RecipientId。
|
|
7009
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7010
|
+
*/
|
|
7011
|
+
Approvers?: Array<ApproverItem>;
|
|
7012
|
+
}
|
|
6956
7013
|
/**
|
|
6957
7014
|
* DescribeFlowBriefs请求参数结构体
|
|
6958
7015
|
*/
|