tencentcloud-sdk-nodejs-ess 4.0.431 → 4.0.432
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 +1 -1
- package/package.json +1 -1
- package/src/services/ess/index.ts +4 -7
- package/src/services/ess/v20201111/ess_client.ts +194 -144
- package/src/services/ess/v20201111/ess_models.ts +1221 -1276
- package/src/services/ess/v20201111/index.ts +3 -3
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +60 -60
- package/tencentcloud/services/ess/v20201111/ess_client.js +60 -60
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +659 -659
- package/tencentcloud/services/ess/v20201111/index.js +1 -1
package/CHANGELOG.md
CHANGED
package/package.json
CHANGED
|
@@ -17,62 +17,61 @@
|
|
|
17
17
|
*/
|
|
18
18
|
import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
|
|
19
19
|
import {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
20
|
+
UploadFile,
|
|
21
|
+
CancelMultiFlowSignQRCodeRequest,
|
|
22
|
+
CreateFlowEvidenceReportResponse,
|
|
23
|
+
DescribeFileUrlsResponse,
|
|
24
|
+
TemplateInfo,
|
|
25
|
+
CreateDocumentResponse,
|
|
26
|
+
StartFlowRequest,
|
|
27
|
+
CancelFlowResponse,
|
|
28
|
+
CreateDocumentRequest,
|
|
29
|
+
CreateFlowRequest,
|
|
30
|
+
CreateSchemeUrlRequest,
|
|
31
|
+
FileUrl,
|
|
32
|
+
DescribeThirdPartyAuthCodeRequest,
|
|
33
|
+
Filter,
|
|
34
|
+
SignQrCode,
|
|
35
|
+
GetTaskResultApiRequest,
|
|
36
|
+
UploadFilesRequest,
|
|
37
|
+
CancelFlowRequest,
|
|
38
|
+
DescribeFlowBriefsResponse,
|
|
39
|
+
Component,
|
|
40
|
+
CreateMultiFlowSignQRCodeResponse,
|
|
41
|
+
FlowCreateApprover,
|
|
42
|
+
UploadFilesResponse,
|
|
43
|
+
DescribeThirdPartyAuthCodeResponse,
|
|
44
|
+
CreateFlowByFilesResponse,
|
|
45
|
+
OrganizationInfo,
|
|
46
|
+
DescribeFlowBriefsRequest,
|
|
47
|
+
Recipient,
|
|
48
|
+
UserInfo,
|
|
49
|
+
SignUrl,
|
|
50
|
+
DescribeFileUrlsRequest,
|
|
51
|
+
ApproverInfo,
|
|
52
|
+
CreateFlowSignReviewResponse,
|
|
53
|
+
Caller,
|
|
54
|
+
DescribeFlowTemplatesResponse,
|
|
55
|
+
CreateFlowEvidenceReportRequest,
|
|
56
|
+
CreateBatchCancelFlowUrlResponse,
|
|
57
|
+
StartFlowResponse,
|
|
58
|
+
FileInfo,
|
|
59
|
+
CreateBatchCancelFlowUrlRequest,
|
|
60
|
+
CreateMultiFlowSignQRCodeRequest,
|
|
61
|
+
CreateConvertTaskApiResponse,
|
|
62
|
+
CreateFlowSignReviewRequest,
|
|
63
|
+
CreateConvertTaskApiRequest,
|
|
64
|
+
CreateSchemeUrlResponse,
|
|
65
|
+
CreateFlowByFilesRequest,
|
|
66
|
+
ApproverRestriction,
|
|
67
|
+
CancelMultiFlowSignQRCodeResponse,
|
|
68
|
+
CreateFlowResponse,
|
|
69
|
+
Agent,
|
|
70
|
+
FormField,
|
|
71
|
+
DescribeFlowTemplatesRequest,
|
|
72
|
+
GetTaskResultApiResponse,
|
|
73
|
+
FlowBrief,
|
|
74
|
+
CcInfo,
|
|
76
75
|
} from "./ess_models"
|
|
77
76
|
|
|
78
77
|
/**
|
|
@@ -80,97 +79,126 @@ import {
|
|
|
80
79
|
* @class
|
|
81
80
|
*/
|
|
82
81
|
export class Client extends TencentCloudCommon.AbstractClient {
|
|
82
|
+
constructor(clientConfig: TencentCloudCommon.ClientConfig) {
|
|
83
|
+
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig)
|
|
84
|
+
}
|
|
83
85
|
|
|
84
|
-
|
|
85
|
-
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
/**
|
|
86
|
+
/**
|
|
89
87
|
* 查询文件下载URL
|
|
90
88
|
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
91
89
|
*/
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
90
|
+
async DescribeFileUrls(
|
|
91
|
+
req: DescribeFileUrlsRequest,
|
|
92
|
+
cb?: (error: string, rep: DescribeFileUrlsResponse) => void
|
|
93
|
+
): Promise<DescribeFileUrlsResponse> {
|
|
94
|
+
return this.request("DescribeFileUrls", req, cb)
|
|
95
|
+
}
|
|
95
96
|
|
|
96
|
-
|
|
97
|
+
/**
|
|
97
98
|
* 此接口用于发起流程
|
|
98
99
|
适用场景:见创建签署流程接口。
|
|
99
100
|
注:该接口是“创建电子文档”接口的后置接口,用于激活包含完整合同信息(模板及内容信息)的流程。激活后的流程就是一份待签署的电子合同。
|
|
100
101
|
*/
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
102
|
+
async StartFlow(
|
|
103
|
+
req: StartFlowRequest,
|
|
104
|
+
cb?: (error: string, rep: StartFlowResponse) => void
|
|
105
|
+
): Promise<StartFlowResponse> {
|
|
106
|
+
return this.request("StartFlow", req, cb)
|
|
107
|
+
}
|
|
104
108
|
|
|
105
|
-
|
|
109
|
+
/**
|
|
106
110
|
* 提交企业签署流程审批结果
|
|
107
111
|
适用场景:
|
|
108
112
|
在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
|
|
109
113
|
若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
|
|
110
114
|
|
|
111
115
|
*/
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
116
|
+
async CreateFlowSignReview(
|
|
117
|
+
req: CreateFlowSignReviewRequest,
|
|
118
|
+
cb?: (error: string, rep: CreateFlowSignReviewResponse) => void
|
|
119
|
+
): Promise<CreateFlowSignReviewResponse> {
|
|
120
|
+
return this.request("CreateFlowSignReview", req, cb)
|
|
121
|
+
}
|
|
115
122
|
|
|
116
|
-
|
|
123
|
+
/**
|
|
117
124
|
* 用于撤销签署流程
|
|
118
125
|
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
119
126
|
注:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。
|
|
120
127
|
*/
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
128
|
+
async CancelFlow(
|
|
129
|
+
req: CancelFlowRequest,
|
|
130
|
+
cb?: (error: string, rep: CancelFlowResponse) => void
|
|
131
|
+
): Promise<CancelFlowResponse> {
|
|
132
|
+
return this.request("CancelFlow", req, cb)
|
|
133
|
+
}
|
|
124
134
|
|
|
125
|
-
|
|
135
|
+
/**
|
|
126
136
|
* 创建签署流程电子文档
|
|
127
137
|
适用场景:见创建签署流程接口。
|
|
128
138
|
注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
|
|
129
139
|
*/
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
140
|
+
async CreateDocument(
|
|
141
|
+
req: CreateDocumentRequest,
|
|
142
|
+
cb?: (error: string, rep: CreateDocumentResponse) => void
|
|
143
|
+
): Promise<CreateDocumentResponse> {
|
|
144
|
+
return this.request("CreateDocument", req, cb)
|
|
145
|
+
}
|
|
133
146
|
|
|
134
|
-
|
|
147
|
+
/**
|
|
135
148
|
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
136
149
|
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
137
150
|
适用的模板仅限于B2C(1、无序签署,2、顺序签署时B静默签署,3、顺序签署时B非首位签署)、单C的模板,且模板中发起方没有填写控件。
|
|
138
151
|
*/
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
152
|
+
async CreateMultiFlowSignQRCode(
|
|
153
|
+
req: CreateMultiFlowSignQRCodeRequest,
|
|
154
|
+
cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
|
|
155
|
+
): Promise<CreateMultiFlowSignQRCodeResponse> {
|
|
156
|
+
return this.request("CreateMultiFlowSignQRCode", req, cb)
|
|
157
|
+
}
|
|
142
158
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
159
|
+
/**
|
|
160
|
+
* 通过AuthCode查询用户是否实名
|
|
161
|
+
*/
|
|
162
|
+
async DescribeThirdPartyAuthCode(
|
|
163
|
+
req: DescribeThirdPartyAuthCodeRequest,
|
|
164
|
+
cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void
|
|
165
|
+
): Promise<DescribeThirdPartyAuthCodeResponse> {
|
|
166
|
+
return this.request("DescribeThirdPartyAuthCode", req, cb)
|
|
167
|
+
}
|
|
149
168
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
169
|
+
/**
|
|
170
|
+
* 创建出证报告,返回报告 URL
|
|
171
|
+
*/
|
|
172
|
+
async CreateFlowEvidenceReport(
|
|
173
|
+
req: CreateFlowEvidenceReportRequest,
|
|
174
|
+
cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void
|
|
175
|
+
): Promise<CreateFlowEvidenceReportResponse> {
|
|
176
|
+
return this.request("CreateFlowEvidenceReport", req, cb)
|
|
177
|
+
}
|
|
156
178
|
|
|
157
|
-
|
|
179
|
+
/**
|
|
158
180
|
* 创建签署流程
|
|
159
181
|
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
160
182
|
注:该接口是通过模板生成合同流程的前置接口,先创建一个不包含签署文件的流程。配合“创建电子文档”接口和“发起流程”接口使用。
|
|
161
183
|
*/
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
184
|
+
async CreateFlow(
|
|
185
|
+
req: CreateFlowRequest,
|
|
186
|
+
cb?: (error: string, rep: CreateFlowResponse) => void
|
|
187
|
+
): Promise<CreateFlowResponse> {
|
|
188
|
+
return this.request("CreateFlow", req, cb)
|
|
189
|
+
}
|
|
165
190
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
191
|
+
/**
|
|
192
|
+
* 此接口(CancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。
|
|
193
|
+
*/
|
|
194
|
+
async CancelMultiFlowSignQRCode(
|
|
195
|
+
req: CancelMultiFlowSignQRCodeRequest,
|
|
196
|
+
cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void
|
|
197
|
+
): Promise<CancelMultiFlowSignQRCodeResponse> {
|
|
198
|
+
return this.request("CancelMultiFlowSignQRCode", req, cb)
|
|
199
|
+
}
|
|
172
200
|
|
|
173
|
-
|
|
201
|
+
/**
|
|
174
202
|
* 获取小程序跳转链接
|
|
175
203
|
|
|
176
204
|
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
@@ -183,67 +211,89 @@ export class Client extends TencentCloudCommon.AbstractClient {
|
|
|
183
211
|
|
|
184
212
|
如您需要自主配置小程序跳转链接,请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
|
|
185
213
|
*/
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
214
|
+
async CreateSchemeUrl(
|
|
215
|
+
req: CreateSchemeUrlRequest,
|
|
216
|
+
cb?: (error: string, rep: CreateSchemeUrlResponse) => void
|
|
217
|
+
): Promise<CreateSchemeUrlResponse> {
|
|
218
|
+
return this.request("CreateSchemeUrl", req, cb)
|
|
219
|
+
}
|
|
189
220
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
221
|
+
/**
|
|
222
|
+
* 查询转换任务状态
|
|
223
|
+
*/
|
|
224
|
+
async GetTaskResultApi(
|
|
225
|
+
req: GetTaskResultApiRequest,
|
|
226
|
+
cb?: (error: string, rep: GetTaskResultApiResponse) => void
|
|
227
|
+
): Promise<GetTaskResultApiResponse> {
|
|
228
|
+
return this.request("GetTaskResultApi", req, cb)
|
|
229
|
+
}
|
|
196
230
|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
231
|
+
/**
|
|
232
|
+
* 创建文件转换任务
|
|
233
|
+
*/
|
|
234
|
+
async CreateConvertTaskApi(
|
|
235
|
+
req: CreateConvertTaskApiRequest,
|
|
236
|
+
cb?: (error: string, rep: CreateConvertTaskApiResponse) => void
|
|
237
|
+
): Promise<CreateConvertTaskApiResponse> {
|
|
238
|
+
return this.request("CreateConvertTaskApi", req, cb)
|
|
239
|
+
}
|
|
203
240
|
|
|
204
|
-
|
|
241
|
+
/**
|
|
205
242
|
* 二期接口-查询模板
|
|
206
243
|
适用场景:当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取自己主体下的模板列表,以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
|
|
207
244
|
*/
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
245
|
+
async DescribeFlowTemplates(
|
|
246
|
+
req: DescribeFlowTemplatesRequest,
|
|
247
|
+
cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
|
|
248
|
+
): Promise<DescribeFlowTemplatesResponse> {
|
|
249
|
+
return this.request("DescribeFlowTemplates", req, cb)
|
|
250
|
+
}
|
|
211
251
|
|
|
212
|
-
|
|
252
|
+
/**
|
|
213
253
|
* 电子签企业版:指定需要批量撤回的签署流程Id,获取批量撤销链接
|
|
214
254
|
客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回
|
|
215
255
|
*/
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
256
|
+
async CreateBatchCancelFlowUrl(
|
|
257
|
+
req: CreateBatchCancelFlowUrlRequest,
|
|
258
|
+
cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void
|
|
259
|
+
): Promise<CreateBatchCancelFlowUrlResponse> {
|
|
260
|
+
return this.request("CreateBatchCancelFlowUrl", req, cb)
|
|
261
|
+
}
|
|
219
262
|
|
|
220
|
-
|
|
263
|
+
/**
|
|
221
264
|
* 查询流程摘要
|
|
222
265
|
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
223
266
|
日调用量默认10W
|
|
224
267
|
*/
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
268
|
+
async DescribeFlowBriefs(
|
|
269
|
+
req: DescribeFlowBriefsRequest,
|
|
270
|
+
cb?: (error: string, rep: DescribeFlowBriefsResponse) => void
|
|
271
|
+
): Promise<DescribeFlowBriefsResponse> {
|
|
272
|
+
return this.request("DescribeFlowBriefs", req, cb)
|
|
273
|
+
}
|
|
228
274
|
|
|
229
|
-
|
|
275
|
+
/**
|
|
230
276
|
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
|
|
231
277
|
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
|
|
232
278
|
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
|
|
233
279
|
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。
|
|
234
280
|
*/
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
281
|
+
async CreateFlowByFiles(
|
|
282
|
+
req: CreateFlowByFilesRequest,
|
|
283
|
+
cb?: (error: string, rep: CreateFlowByFilesResponse) => void
|
|
284
|
+
): Promise<CreateFlowByFilesResponse> {
|
|
285
|
+
return this.request("CreateFlowByFiles", req, cb)
|
|
286
|
+
}
|
|
238
287
|
|
|
239
|
-
|
|
288
|
+
/**
|
|
240
289
|
* 此接口(UploadFiles)用于文件上传。
|
|
241
290
|
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
|
|
242
291
|
调用时需要设置Domain 为 file.ess.tencent.cn,设置Version为2020-12-22
|
|
243
292
|
*/
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
293
|
+
async UploadFiles(
|
|
294
|
+
req: UploadFilesRequest,
|
|
295
|
+
cb?: (error: string, rep: UploadFilesResponse) => void
|
|
296
|
+
): Promise<UploadFilesResponse> {
|
|
297
|
+
return this.request("UploadFiles", req, cb)
|
|
298
|
+
}
|
|
249
299
|
}
|