tencentcloud-sdk-nodejs 4.0.489 → 4.0.490
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 +240 -0
- package/SERVICE_CHANGELOG.md +408 -72
- package/package.json +1 -1
- package/products.md +10 -9
- package/src/common/sdk_version.ts +1 -1
- package/src/services/asr/v20190614/asr_models.ts +31 -0
- package/src/services/cdwch/index.ts +5 -0
- package/src/services/cdwch/v20200915/cdwch_client.ts +118 -0
- package/src/services/cdwch/v20200915/cdwch_models.ts +314 -0
- package/src/services/cdwch/v20200915/index.ts +6 -0
- package/src/services/cfw/v20190904/cfw_client.ts +4 -4
- package/src/services/cfw/v20190904/cfw_models.ts +2 -2
- package/src/services/ess/v20201111/ess_client.ts +26 -0
- package/src/services/ess/v20201111/ess_models.ts +100 -1
- package/src/services/essbasic/v20210526/essbasic_client.ts +38 -12
- package/src/services/essbasic/v20210526/essbasic_models.ts +174 -82
- package/src/services/index.ts +1 -0
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +6 -0
- package/src/services/mongodb/v20190725/mongodb_models.ts +2 -2
- package/src/services/redis/v20180412/redis_client.ts +1 -1
- package/src/services/teo/v20220901/teo_models.ts +1 -1
- package/src/services/vod/v20180717/vod_client.ts +0 -6
- package/src/services/vod/v20180717/vod_models.ts +156 -5
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +26 -0
- package/tencentcloud/services/cdwch/index.d.ts +6 -0
- package/tencentcloud/services/cdwch/index.js +7 -0
- package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +38 -0
- package/tencentcloud/services/cdwch/v20200915/cdwch_client.js +73 -0
- package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +255 -0
- package/tencentcloud/services/cdwch/v20200915/cdwch_models.js +18 -0
- package/tencentcloud/services/cdwch/v20200915/index.d.ts +6 -0
- package/tencentcloud/services/cdwch/v20200915/index.js +9 -0
- package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +4 -4
- package/tencentcloud/services/cfw/v20190904/cfw_client.js +4 -4
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +2 -2
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +11 -1
- package/tencentcloud/services/ess/v20201111/ess_client.js +14 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +85 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +17 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +153 -74
- package/tencentcloud/services/index.d.ts +1 -0
- package/tencentcloud/services/index.js +2 -0
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +6 -0
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +2 -2
- package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
- package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +0 -6
- package/tencentcloud/services/vod/v20180717/vod_client.js +0 -6
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +126 -5
- package/test/cdwch.v20200915.test.js +91 -0
- package/test/ess.v20201111.test.js +20 -0
- package/test/essbasic.v20210526.test.js +22 -2
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DescribeInstanceShards请求参数结构体
|
|
3
|
+
*/
|
|
4
|
+
export interface DescribeInstanceShardsRequest {
|
|
5
|
+
/**
|
|
6
|
+
* 集群实例ID
|
|
7
|
+
*/
|
|
8
|
+
InstanceId: string;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* ModifyUserNewPrivilege请求参数结构体
|
|
12
|
+
*/
|
|
13
|
+
export declare type ModifyUserNewPrivilegeRequest = null;
|
|
14
|
+
/**
|
|
15
|
+
* CreateBackUpSchedule请求参数结构体
|
|
16
|
+
*/
|
|
17
|
+
export interface CreateBackUpScheduleRequest {
|
|
18
|
+
/**
|
|
19
|
+
* 编辑时需要传
|
|
20
|
+
*/
|
|
21
|
+
ScheduleId?: number;
|
|
22
|
+
/**
|
|
23
|
+
* 选择的星期 逗号分隔
|
|
24
|
+
*/
|
|
25
|
+
WeekDays?: string;
|
|
26
|
+
/**
|
|
27
|
+
* 执行小时
|
|
28
|
+
*/
|
|
29
|
+
ExecuteHour?: number;
|
|
30
|
+
/**
|
|
31
|
+
* 备份表列表
|
|
32
|
+
*/
|
|
33
|
+
BackUpTables?: Array<BackupTableContent>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* DescribeInstanceShards返回参数结构体
|
|
37
|
+
*/
|
|
38
|
+
export interface DescribeInstanceShardsResponse {
|
|
39
|
+
/**
|
|
40
|
+
* 实例shard信息
|
|
41
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
42
|
+
*/
|
|
43
|
+
InstanceShardsList: string;
|
|
44
|
+
/**
|
|
45
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
46
|
+
*/
|
|
47
|
+
RequestId?: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* OpenBackUp请求参数结构体
|
|
51
|
+
*/
|
|
52
|
+
export interface OpenBackUpRequest {
|
|
53
|
+
/**
|
|
54
|
+
* 集群id
|
|
55
|
+
*/
|
|
56
|
+
InstanceId: string;
|
|
57
|
+
/**
|
|
58
|
+
* OPEN 或者CLOSE
|
|
59
|
+
*/
|
|
60
|
+
OperationType: string;
|
|
61
|
+
/**
|
|
62
|
+
* 桶名字
|
|
63
|
+
*/
|
|
64
|
+
CosBucketName: string;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* ModifyClusterConfigs返回参数结构体
|
|
68
|
+
*/
|
|
69
|
+
export interface ModifyClusterConfigsResponse {
|
|
70
|
+
/**
|
|
71
|
+
* 流程相关信息
|
|
72
|
+
*/
|
|
73
|
+
FlowId: number;
|
|
74
|
+
/**
|
|
75
|
+
* 错误信息
|
|
76
|
+
*/
|
|
77
|
+
ErrorMsg: string;
|
|
78
|
+
/**
|
|
79
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
80
|
+
*/
|
|
81
|
+
RequestId?: string;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* 备份表信息
|
|
85
|
+
*/
|
|
86
|
+
export interface BackupTableContent {
|
|
87
|
+
/**
|
|
88
|
+
* 数据库
|
|
89
|
+
*/
|
|
90
|
+
Database: string;
|
|
91
|
+
/**
|
|
92
|
+
* 表
|
|
93
|
+
*/
|
|
94
|
+
Table: string;
|
|
95
|
+
/**
|
|
96
|
+
* 表总字节数
|
|
97
|
+
*/
|
|
98
|
+
TotalBytes: number;
|
|
99
|
+
/**
|
|
100
|
+
* 虚拟cluster
|
|
101
|
+
*/
|
|
102
|
+
VCluster?: string;
|
|
103
|
+
/**
|
|
104
|
+
* 表ip
|
|
105
|
+
*/
|
|
106
|
+
Ips?: string;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* OpenBackUp返回参数结构体
|
|
110
|
+
*/
|
|
111
|
+
export interface OpenBackUpResponse {
|
|
112
|
+
/**
|
|
113
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
114
|
+
*/
|
|
115
|
+
RequestId?: string;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* 配置文件修改信息
|
|
119
|
+
*/
|
|
120
|
+
export interface ConfigSubmitContext {
|
|
121
|
+
/**
|
|
122
|
+
* 配置文件名称
|
|
123
|
+
*/
|
|
124
|
+
FileName: string;
|
|
125
|
+
/**
|
|
126
|
+
* 配置文件旧内容,base64编码
|
|
127
|
+
*/
|
|
128
|
+
OldConfValue: string;
|
|
129
|
+
/**
|
|
130
|
+
* 配置文件新内容,base64编码
|
|
131
|
+
*/
|
|
132
|
+
NewConfValue: string;
|
|
133
|
+
/**
|
|
134
|
+
* 保存配置文件的路径
|
|
135
|
+
*/
|
|
136
|
+
FilePath?: string;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* ActionAlterCkUser返回参数结构体
|
|
140
|
+
*/
|
|
141
|
+
export interface ActionAlterCkUserResponse {
|
|
142
|
+
/**
|
|
143
|
+
* 错误信息
|
|
144
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
145
|
+
*/
|
|
146
|
+
ErrMsg: string;
|
|
147
|
+
/**
|
|
148
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
149
|
+
*/
|
|
150
|
+
RequestId?: string;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* DescribeCkSqlApis请求参数结构体
|
|
154
|
+
*/
|
|
155
|
+
export interface DescribeCkSqlApisRequest {
|
|
156
|
+
/**
|
|
157
|
+
* 实例id
|
|
158
|
+
*/
|
|
159
|
+
InstanceId: string;
|
|
160
|
+
/**
|
|
161
|
+
* api接口名称
|
|
162
|
+
*/
|
|
163
|
+
ApiType: string;
|
|
164
|
+
/**
|
|
165
|
+
* 集群名称
|
|
166
|
+
*/
|
|
167
|
+
Cluster?: string;
|
|
168
|
+
/**
|
|
169
|
+
* 用户名称
|
|
170
|
+
*/
|
|
171
|
+
UserName?: string;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* ActionAlterCkUser请求参数结构体
|
|
175
|
+
*/
|
|
176
|
+
export interface ActionAlterCkUserRequest {
|
|
177
|
+
/**
|
|
178
|
+
* 用户信息
|
|
179
|
+
*/
|
|
180
|
+
UserInfo: CkUserAlterInfo;
|
|
181
|
+
/**
|
|
182
|
+
* api接口类型
|
|
183
|
+
*/
|
|
184
|
+
ApiType: string;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* 新增或是修改ck用户
|
|
188
|
+
*/
|
|
189
|
+
export interface CkUserAlterInfo {
|
|
190
|
+
/**
|
|
191
|
+
* 集群实例id
|
|
192
|
+
*/
|
|
193
|
+
InstanceId: string;
|
|
194
|
+
/**
|
|
195
|
+
* 用户名
|
|
196
|
+
*/
|
|
197
|
+
UserName: string;
|
|
198
|
+
/**
|
|
199
|
+
* 密码
|
|
200
|
+
*/
|
|
201
|
+
PassWord: string;
|
|
202
|
+
/**
|
|
203
|
+
* 描述
|
|
204
|
+
*/
|
|
205
|
+
Describe?: string;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
* CreateBackUpSchedule返回参数结构体
|
|
209
|
+
*/
|
|
210
|
+
export interface CreateBackUpScheduleResponse {
|
|
211
|
+
/**
|
|
212
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
213
|
+
*/
|
|
214
|
+
RequestId?: string;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* ModifyClusterConfigs请求参数结构体
|
|
218
|
+
*/
|
|
219
|
+
export interface ModifyClusterConfigsRequest {
|
|
220
|
+
/**
|
|
221
|
+
* 集群ID,例如cdwch-xxxx
|
|
222
|
+
*/
|
|
223
|
+
InstanceId: string;
|
|
224
|
+
/**
|
|
225
|
+
* 配置文件修改信息
|
|
226
|
+
*/
|
|
227
|
+
ModifyConfContext: Array<ConfigSubmitContext>;
|
|
228
|
+
/**
|
|
229
|
+
* 修改原因
|
|
230
|
+
*/
|
|
231
|
+
Remark?: string;
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* DescribeCkSqlApis返回参数结构体
|
|
235
|
+
*/
|
|
236
|
+
export interface DescribeCkSqlApisResponse {
|
|
237
|
+
/**
|
|
238
|
+
* 返回的查询数据,大部分情况是list,也可能是bool
|
|
239
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
240
|
+
*/
|
|
241
|
+
ReturnData: string;
|
|
242
|
+
/**
|
|
243
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
244
|
+
*/
|
|
245
|
+
RequestId?: string;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* ModifyUserNewPrivilege返回参数结构体
|
|
249
|
+
*/
|
|
250
|
+
export interface ModifyUserNewPrivilegeResponse {
|
|
251
|
+
/**
|
|
252
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
253
|
+
*/
|
|
254
|
+
RequestId?: string;
|
|
255
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
|
|
4
|
+
*
|
|
5
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
* you may not use this file except in compliance with the License.
|
|
7
|
+
* You may obtain a copy of the License at
|
|
8
|
+
*
|
|
9
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
*
|
|
11
|
+
* Unless required by applicable law or agreed to in writing,
|
|
12
|
+
* software distributed under the License is distributed on an
|
|
13
|
+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
14
|
+
* KIND, either express or implied. See the License for the
|
|
15
|
+
* specific language governing permissions and limitations
|
|
16
|
+
* under the License.
|
|
17
|
+
*/
|
|
18
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.v20200915 = void 0;
|
|
4
|
+
const Models = require("./cdwch_models");
|
|
5
|
+
const cdwch_client_1 = require("./cdwch_client");
|
|
6
|
+
exports.v20200915 = {
|
|
7
|
+
Client: cdwch_client_1.Client,
|
|
8
|
+
Models: Models
|
|
9
|
+
};
|
|
@@ -147,10 +147,10 @@ export declare class Client extends AbstractClient {
|
|
|
147
147
|
*/
|
|
148
148
|
DescribeEnterpriseSecurityGroupRule(req: DescribeEnterpriseSecurityGroupRuleRequest, cb?: (error: string, rep: DescribeEnterpriseSecurityGroupRuleResponse) => void): Promise<DescribeEnterpriseSecurityGroupRuleResponse>;
|
|
149
149
|
/**
|
|
150
|
-
*
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
150
|
+
* 支持对封禁列表、放通列表如下操作:
|
|
151
|
+
批量增加封禁IP、放通IP/域名
|
|
152
|
+
批量删除封禁IP、放通IP/域名
|
|
153
|
+
批量修改封禁IP、放通IP/域名生效事件
|
|
154
154
|
*/
|
|
155
155
|
ModifyBlockIgnoreList(req: ModifyBlockIgnoreListRequest, cb?: (error: string, rep: ModifyBlockIgnoreListResponse) => void): Promise<ModifyBlockIgnoreListResponse>;
|
|
156
156
|
/**
|
|
@@ -235,10 +235,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
235
235
|
return this.request("DescribeEnterpriseSecurityGroupRule", req, cb);
|
|
236
236
|
}
|
|
237
237
|
/**
|
|
238
|
-
*
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
238
|
+
* 支持对封禁列表、放通列表如下操作:
|
|
239
|
+
批量增加封禁IP、放通IP/域名
|
|
240
|
+
批量删除封禁IP、放通IP/域名
|
|
241
|
+
批量修改封禁IP、放通IP/域名生效事件
|
|
242
242
|
*/
|
|
243
243
|
async ModifyBlockIgnoreList(req, cb) {
|
|
244
244
|
return this.request("ModifyBlockIgnoreList", req, cb);
|
|
@@ -778,7 +778,7 @@ export interface ModifyAssetScanRequest {
|
|
|
778
778
|
*/
|
|
779
779
|
export interface ModifyBlockIgnoreListRequest {
|
|
780
780
|
/**
|
|
781
|
-
* 1
|
|
781
|
+
* 1封禁列表 2 放通列表
|
|
782
782
|
*/
|
|
783
783
|
RuleType: number;
|
|
784
784
|
/**
|
|
@@ -794,7 +794,7 @@ export interface ModifyBlockIgnoreListRequest {
|
|
|
794
794
|
*/
|
|
795
795
|
StartTime?: string;
|
|
796
796
|
/**
|
|
797
|
-
* 时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add
|
|
797
|
+
* 时间格式:yyyy-MM-dd HH:mm:ss,IocAction 为edit或add时必填,必须大于当前时间且大于StartTime
|
|
798
798
|
*/
|
|
799
799
|
EndTime?: string;
|
|
800
800
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { CancelFlowResponse, CreateSchemeUrlRequest, CreateFlowApproversResponse, UploadFilesRequest, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DescribeFlowTemplatesRequest, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, CreateBatchCancelFlowUrlResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateSchemeUrlResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, StartFlowRequest, DeleteIntegrationEmployeesResponse, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeFlowBriefsRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
|
|
3
|
+
import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, UploadFilesRequest, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, CreateBatchCancelFlowUrlResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateSchemeUrlResponse, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, StartFlowRequest, CreatePrepareFlowRequest, DeleteIntegrationEmployeesResponse, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeFlowBriefsRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
|
|
4
4
|
/**
|
|
5
5
|
* ess client
|
|
6
6
|
* @class
|
|
@@ -54,6 +54,12 @@ export declare class Client extends AbstractClient {
|
|
|
54
54
|
|
|
55
55
|
*/
|
|
56
56
|
CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* 创建快速发起流程
|
|
59
|
+
适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
|
|
60
|
+
注:该接口文件的resourceId 是通过上传文件之后获取的。
|
|
61
|
+
*/
|
|
62
|
+
CreatePrepareFlow(req: CreatePrepareFlowRequest, cb?: (error: string, rep: CreatePrepareFlowResponse) => void): Promise<CreatePrepareFlowResponse>;
|
|
57
63
|
/**
|
|
58
64
|
* 创建签署流程电子文档
|
|
59
65
|
适用场景:见创建签署流程接口。
|
|
@@ -187,6 +193,10 @@ export declare class Client extends AbstractClient {
|
|
|
187
193
|
注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
|
|
188
194
|
*/
|
|
189
195
|
CreateFlow(req: CreateFlowRequest, cb?: (error: string, rep: CreateFlowResponse) => void): Promise<CreateFlowResponse>;
|
|
196
|
+
/**
|
|
197
|
+
* 查询出证报告,返回报告 URL。
|
|
198
|
+
*/
|
|
199
|
+
DescribeFlowEvidenceReport(req: DescribeFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeFlowEvidenceReportResponse) => void): Promise<DescribeFlowEvidenceReportResponse>;
|
|
190
200
|
/**
|
|
191
201
|
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
|
|
192
202
|
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
@@ -90,6 +90,14 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
90
90
|
async CreateFlowSignReview(req, cb) {
|
|
91
91
|
return this.request("CreateFlowSignReview", req, cb);
|
|
92
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* 创建快速发起流程
|
|
95
|
+
适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
|
|
96
|
+
注:该接口文件的resourceId 是通过上传文件之后获取的。
|
|
97
|
+
*/
|
|
98
|
+
async CreatePrepareFlow(req, cb) {
|
|
99
|
+
return this.request("CreatePrepareFlow", req, cb);
|
|
100
|
+
}
|
|
93
101
|
/**
|
|
94
102
|
* 创建签署流程电子文档
|
|
95
103
|
适用场景:见创建签署流程接口。
|
|
@@ -231,6 +239,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
231
239
|
async CreateFlow(req, cb) {
|
|
232
240
|
return this.request("CreateFlow", req, cb);
|
|
233
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* 查询出证报告,返回报告 URL。
|
|
244
|
+
*/
|
|
245
|
+
async DescribeFlowEvidenceReport(req, cb) {
|
|
246
|
+
return this.request("DescribeFlowEvidenceReport", req, cb);
|
|
247
|
+
}
|
|
234
248
|
/**
|
|
235
249
|
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
|
|
236
250
|
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
@@ -7,6 +7,19 @@ export interface CancelFlowResponse {
|
|
|
7
7
|
*/
|
|
8
8
|
RequestId?: string;
|
|
9
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* DescribeFlowEvidenceReport请求参数结构体
|
|
12
|
+
*/
|
|
13
|
+
export interface DescribeFlowEvidenceReportRequest {
|
|
14
|
+
/**
|
|
15
|
+
* 调用方用户信息,userId 必填
|
|
16
|
+
*/
|
|
17
|
+
Operator: UserInfo;
|
|
18
|
+
/**
|
|
19
|
+
* 出证报告编号
|
|
20
|
+
*/
|
|
21
|
+
ReportId: string;
|
|
22
|
+
}
|
|
10
23
|
/**
|
|
11
24
|
* 集成版员工部门信息
|
|
12
25
|
*/
|
|
@@ -280,7 +293,7 @@ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
|
280
293
|
*/
|
|
281
294
|
export interface CreateConvertTaskApiRequest {
|
|
282
295
|
/**
|
|
283
|
-
* 资源类型 取值范围doc,docx,html,
|
|
296
|
+
* 资源类型 取值范围doc,docx,html,xls,xlsx之一
|
|
284
297
|
*/
|
|
285
298
|
ResourceType: string;
|
|
286
299
|
/**
|
|
@@ -415,6 +428,26 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
415
428
|
*/
|
|
416
429
|
Agent?: Agent;
|
|
417
430
|
}
|
|
431
|
+
/**
|
|
432
|
+
* DescribeFlowEvidenceReport返回参数结构体
|
|
433
|
+
*/
|
|
434
|
+
export interface DescribeFlowEvidenceReportResponse {
|
|
435
|
+
/**
|
|
436
|
+
* 报告 URL
|
|
437
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
438
|
+
*/
|
|
439
|
+
ReportUrl: string;
|
|
440
|
+
/**
|
|
441
|
+
* 执行中:EvidenceStatusExecuting
|
|
442
|
+
成功:EvidenceStatusSuccess
|
|
443
|
+
失败:EvidenceStatusFailed
|
|
444
|
+
*/
|
|
445
|
+
Status: string;
|
|
446
|
+
/**
|
|
447
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
448
|
+
*/
|
|
449
|
+
RequestId?: string;
|
|
450
|
+
}
|
|
418
451
|
/**
|
|
419
452
|
* 二期接口返回的模板的信息结构
|
|
420
453
|
*/
|
|
@@ -1608,6 +1641,19 @@ export interface ApproverRestriction {
|
|
|
1608
1641
|
*/
|
|
1609
1642
|
IdCardNumber?: string;
|
|
1610
1643
|
}
|
|
1644
|
+
/**
|
|
1645
|
+
* CreatePrepareFlow返回参数结构体
|
|
1646
|
+
*/
|
|
1647
|
+
export interface CreatePrepareFlowResponse {
|
|
1648
|
+
/**
|
|
1649
|
+
* 快速发起预览链接
|
|
1650
|
+
*/
|
|
1651
|
+
Url: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1654
|
+
*/
|
|
1655
|
+
RequestId?: string;
|
|
1656
|
+
}
|
|
1611
1657
|
/**
|
|
1612
1658
|
* GetTaskResultApi返回参数结构体
|
|
1613
1659
|
*/
|
|
@@ -1683,6 +1729,44 @@ export interface StartFlowRequest {
|
|
|
1683
1729
|
*/
|
|
1684
1730
|
Agent?: Agent;
|
|
1685
1731
|
}
|
|
1732
|
+
/**
|
|
1733
|
+
* CreatePrepareFlow请求参数结构体
|
|
1734
|
+
*/
|
|
1735
|
+
export interface CreatePrepareFlowRequest {
|
|
1736
|
+
/**
|
|
1737
|
+
* 调用方用户信息,userId 必填
|
|
1738
|
+
*/
|
|
1739
|
+
Operator: UserInfo;
|
|
1740
|
+
/**
|
|
1741
|
+
* 资源Id,通过上传uploadfile接口获得
|
|
1742
|
+
*/
|
|
1743
|
+
ResourceId: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* 合同名称
|
|
1746
|
+
*/
|
|
1747
|
+
FlowName: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* 是否顺序签署(true:无序签,false:顺序签)
|
|
1750
|
+
*/
|
|
1751
|
+
Unordered?: boolean;
|
|
1752
|
+
/**
|
|
1753
|
+
* 签署流程的签署截止时间。
|
|
1754
|
+
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
1755
|
+
*/
|
|
1756
|
+
Deadline?: number;
|
|
1757
|
+
/**
|
|
1758
|
+
* 用户自定义合同类型
|
|
1759
|
+
*/
|
|
1760
|
+
UserFlowTypeId?: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* 签署流程参与者信息,最大限制50方
|
|
1763
|
+
*/
|
|
1764
|
+
Approvers?: Array<FlowCreateApprover>;
|
|
1765
|
+
/**
|
|
1766
|
+
* 打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
|
|
1767
|
+
*/
|
|
1768
|
+
IntelligentStatus?: string;
|
|
1769
|
+
}
|
|
1686
1770
|
/**
|
|
1687
1771
|
* 签署人个性化能力信息
|
|
1688
1772
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, CreateSealByImageRequest, PrepareFlowsRequest, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest,
|
|
3
|
+
import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelBatchCancelFlowsResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, UploadFilesRequest, DescribeResourceUrlsByFlowsRequest, CreateSealByImageResponse, OperateChannelTemplateResponse, CreateConsoleLoginUrlResponse, SyncProxyOrganizationRequest, CreateSealByImageRequest, PrepareFlowsRequest, ChannelCancelFlowResponse, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, ChannelCreateFlowGroupByFilesRequest, DescribeFlowDetailInfoResponse, PrepareFlowsResponse, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageResponse, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, DescribeResourceUrlsByFlowsResponse, SyncProxyOrganizationOperatorsRequest, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelGetTaskResultApiRequest, CreateFlowsByTemplatesResponse, SyncProxyOrganizationOperatorsResponse, DescribeUsageRequest, CreateSignUrlsResponse, UploadFilesResponse, ChannelCreateBatchCancelFlowUrlRequest, DescribeChannelFlowEvidenceReportRequest, ChannelCreateFlowByFilesResponse, ChannelCreateFlowSignReviewResponse, ChannelDescribeOrganizationSealsResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelCreateBoundFlowsResponse, ChannelGetTaskResultApiResponse, GetDownloadFlowUrlRequest, ChannelBatchCancelFlowsRequest, ChannelCancelFlowRequest, DescribeTemplatesRequest, CreateFlowsByTemplatesRequest, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, DescribeChannelFlowEvidenceReportResponse } from "./essbasic_models";
|
|
4
4
|
/**
|
|
5
5
|
* essbasic client
|
|
6
6
|
* @class
|
|
@@ -98,9 +98,10 @@ export declare class Client extends AbstractClient {
|
|
|
98
98
|
*/
|
|
99
99
|
ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse>;
|
|
100
100
|
/**
|
|
101
|
-
*
|
|
101
|
+
* 创建出证报告,返回报告 ID
|
|
102
|
+
|
|
102
103
|
*/
|
|
103
|
-
|
|
104
|
+
CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
|
|
104
105
|
/**
|
|
105
106
|
* 合同文件验签
|
|
106
107
|
*/
|
|
@@ -150,11 +151,20 @@ HttpProfile httpProfile = new HttpProfile();
|
|
|
150
151
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
151
152
|
*/
|
|
152
153
|
UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
|
|
154
|
+
/**
|
|
155
|
+
* 此接口(SyncProxyOrganization)用于同步渠道子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
|
|
156
|
+
*/
|
|
157
|
+
SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
|
|
153
158
|
/**
|
|
154
159
|
* 此接口(SyncProxyOrganizationOperators)用于同步渠道子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于渠道平台的,无法针对员工做新增/更新/离职等操作。
|
|
155
160
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
156
161
|
*/
|
|
157
162
|
SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
|
|
163
|
+
/**
|
|
164
|
+
* 查询出证报告,返回报告 URL。
|
|
165
|
+
|
|
166
|
+
*/
|
|
167
|
+
DescribeChannelFlowEvidenceReport(req: DescribeChannelFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeChannelFlowEvidenceReportResponse) => void): Promise<DescribeChannelFlowEvidenceReportResponse>;
|
|
158
168
|
/**
|
|
159
169
|
* 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。
|
|
160
170
|
1、OperateType=select时:
|
|
@@ -146,10 +146,11 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
146
146
|
return this.request("ChannelGetTaskResultApi", req, cb);
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
*
|
|
149
|
+
* 创建出证报告,返回报告 ID
|
|
150
|
+
|
|
150
151
|
*/
|
|
151
|
-
async
|
|
152
|
-
return this.request("
|
|
152
|
+
async CreateChannelFlowEvidenceReport(req, cb) {
|
|
153
|
+
return this.request("CreateChannelFlowEvidenceReport", req, cb);
|
|
153
154
|
}
|
|
154
155
|
/**
|
|
155
156
|
* 合同文件验签
|
|
@@ -218,6 +219,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
218
219
|
async UploadFiles(req, cb) {
|
|
219
220
|
return this.request("UploadFiles", req, cb);
|
|
220
221
|
}
|
|
222
|
+
/**
|
|
223
|
+
* 此接口(SyncProxyOrganization)用于同步渠道子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
|
|
224
|
+
*/
|
|
225
|
+
async SyncProxyOrganization(req, cb) {
|
|
226
|
+
return this.request("SyncProxyOrganization", req, cb);
|
|
227
|
+
}
|
|
221
228
|
/**
|
|
222
229
|
* 此接口(SyncProxyOrganizationOperators)用于同步渠道子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于渠道平台的,无法针对员工做新增/更新/离职等操作。
|
|
223
230
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
@@ -225,6 +232,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
225
232
|
async SyncProxyOrganizationOperators(req, cb) {
|
|
226
233
|
return this.request("SyncProxyOrganizationOperators", req, cb);
|
|
227
234
|
}
|
|
235
|
+
/**
|
|
236
|
+
* 查询出证报告,返回报告 URL。
|
|
237
|
+
|
|
238
|
+
*/
|
|
239
|
+
async DescribeChannelFlowEvidenceReport(req, cb) {
|
|
240
|
+
return this.request("DescribeChannelFlowEvidenceReport", req, cb);
|
|
241
|
+
}
|
|
228
242
|
/**
|
|
229
243
|
* 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。
|
|
230
244
|
1、OperateType=select时:
|